1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
<?php
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer;
use PhpCsFixer\Fixer\FixerInterface;
use PhpCsFixer\Tokenizer\Token;
/**
* @author Dariusz Rumiński <dariusz.ruminski@gmail.com>
* @author Graham Campbell <graham@alt-three.com>
* @author Odín del Río <odin.drp@gmail.com>
*
* @internal
*/
final class Utils
{
/**
* Calculate a bitmask for given constant names.
*
* @param string[] $options constant names
*
* @return int
*/
public static function calculateBitmask(array $options)
{
$bitmask = 0;
foreach ($options as $optionName) {
if (\defined($optionName)) {
$bitmask |= \constant($optionName);
}
}
return $bitmask;
}
/**
* Converts a camel cased string to an snake cased string.
*
* @param string $string
*
* @return string
*/
public static function camelCaseToUnderscore($string)
{
return Preg::replaceCallback(
'/(^|[a-z0-9])([A-Z])/',
static function (array $matches) {
return strtolower('' !== $matches[1] ? $matches[1].'_'.$matches[2] : $matches[2]);
},
$string
);
}
/**
* Compare two integers for equality.
*
* We'll return 0 if they're equal, 1 if the first is bigger than the
* second, and -1 if the second is bigger than the first.
*
* @param int $a
* @param int $b
*
* @return int
*/
public static function cmpInt($a, $b)
{
if ($a === $b) {
return 0;
}
return $a < $b ? -1 : 1;
}
/**
* Calculate the trailing whitespace.
*
* What we're doing here is grabbing everything after the final newline.
*
* @param Token $token
*
* @return string
*/
public static function calculateTrailingWhitespaceIndent(Token $token)
{
if (!$token->isWhitespace()) {
throw new \InvalidArgumentException(sprintf('The given token must be whitespace, got "%s".', $token->getName()));
}
$str = strrchr(
str_replace(["\r\n", "\r"], "\n", $token->getContent()),
"\n"
);
if (false === $str) {
return '';
}
return ltrim($str, "\n");
}
/**
* Perform stable sorting using provided comparison function.
*
* Stability is ensured by using Schwartzian transform.
*
* @param mixed[] $elements
* @param callable $getComparedValue a callable that takes a single element and returns the value to compare
* @param callable $compareValues a callable that compares two values
*
* @return mixed[]
*/
public static function stableSort(array $elements, callable $getComparedValue, callable $compareValues)
{
array_walk($elements, static function (&$element, $index) use ($getComparedValue) {
$element = [$element, $index, $getComparedValue($element)];
});
usort($elements, static function ($a, $b) use ($compareValues) {
$comparison = $compareValues($a[2], $b[2]);
if (0 !== $comparison) {
return $comparison;
}
return self::cmpInt($a[1], $b[1]);
});
return array_map(static function (array $item) {
return $item[0];
}, $elements);
}
/**
* Sort fixers by their priorities.
*
* @param FixerInterface[] $fixers
*
* @return FixerInterface[]
*/
public static function sortFixers(array $fixers)
{
// Schwartzian transform is used to improve the efficiency and avoid
// `usort(): Array was modified by the user comparison function` warning for mocked objects.
return self::stableSort(
$fixers,
static function (FixerInterface $fixer) {
return $fixer->getPriority();
},
static function ($a, $b) {
return self::cmpInt($b, $a);
}
);
}
/**
* Join names in natural language wrapped in backticks, e.g. `a`, `b` and `c`.
*
* @param string[] $names
*
* @throws \InvalidArgumentException
*
* @return string
*/
public static function naturalLanguageJoinWithBackticks(array $names)
{
if (empty($names)) {
throw new \InvalidArgumentException('Array of names cannot be empty');
}
$names = array_map(static function ($name) {
return sprintf('`%s`', $name);
}, $names);
$last = array_pop($names);
if ($names) {
return implode(', ', $names).' and '.$last;
}
return $last;
}
}