Skip to content

Commit bd288db

Browse files
jrfnljrfnl
authored
Merge pull request #1012 from PHPCSStandards/phpcs-4.0/feature/tokenizer-createtokenmap-stabilize-parenthesis-keys
Tokenizer::createTokenMap(): stabilize code for parenthesis owners
2 parents 55f1a75 + da0d224 commit bd288db

File tree

3 files changed

+483
-16
lines changed

3 files changed

+483
-16
lines changed

‎src/Tokenizers/Tokenizer.php‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -628,35 +628,43 @@ private function createTokenMap()
628628
$curlyOpeners = [];
629629
$this->numTokens = count($this->tokens);
630630

631-
$openers = [];
632-
$openOwner = null;
631+
$openers = [];
633632

634633
for ($i = 0; $i < $this->numTokens; $i++) {
635634
/*
636635
Parenthesis mapping.
637636
*/
638637

639638
if (isset(Tokens::$parenthesisOpeners[$this->tokens[$i]['code']]) === true) {
640-
$this->tokens[$i]['parenthesis_opener'] = null;
641-
$this->tokens[$i]['parenthesis_closer'] = null;
642-
$this->tokens[$i]['parenthesis_owner'] = $i;
643-
$openOwner = $i;
639+
// Find the next non-empty token.
640+
$find = Tokens::$emptyTokens;
641+
if ($this->tokens[$i]['code'] === T_FUNCTION) {
642+
$find[T_STRING] = T_STRING;
643+
$find[T_BITWISE_AND] = T_BITWISE_AND;
644+
}
644645

645-
if (PHP_CODESNIFFER_VERBOSITY > 1) {
646-
StatusWriter::write("=> Found parenthesis owner at $i", (count($openers) + 1));
646+
for ($j = ($i + 1); isset($this->tokens[$j], $find[$this->tokens[$j]['code']]) === true; $j++);
647+
if ($j < $this->numTokens && $this->tokens[$j]['code'] === T_OPEN_PARENTHESIS) {
648+
$openers[] = $j;
649+
$this->tokens[$i]['parenthesis_opener'] = $j;
650+
$this->tokens[$i]['parenthesis_closer'] = null;
651+
$this->tokens[$i]['parenthesis_owner'] = $i;
652+
653+
$this->tokens[$j]['parenthesis_opener'] = $j;
654+
$this->tokens[$j]['parenthesis_owner'] = $i;
655+
656+
if (PHP_CODESNIFFER_VERBOSITY > 1) {
657+
StatusWriter::write("=> Found parenthesis owner at $i", (count($openers) + 1));
658+
StatusWriter::write("=> Found parenthesis opener at $j for $i", count($openers));
659+
}
660+
661+
$i = $j;
647662
}
648663
} else if ($this->tokens[$i]['code'] === T_OPEN_PARENTHESIS) {
649664
$openers[] = $i;
650665
$this->tokens[$i]['parenthesis_opener'] = $i;
651-
if ($openOwner !== null) {
652-
if (PHP_CODESNIFFER_VERBOSITY > 1) {
653-
StatusWriter::write("=> Found parenthesis opener at $i for $openOwner", count($openers));
654-
}
655666

656-
$this->tokens[$openOwner]['parenthesis_opener'] = $i;
657-
$this->tokens[$i]['parenthesis_owner'] = $openOwner;
658-
$openOwner = null;
659-
} else if (PHP_CODESNIFFER_VERBOSITY > 1) {
667+
if (PHP_CODESNIFFER_VERBOSITY > 1) {
660668
StatusWriter::write("=> Found unowned parenthesis opener at $i", count($openers));
661669
}
662670
} else if ($this->tokens[$i]['code'] === T_CLOSE_PARENTHESIS) {

‎tests/Core/Tokenizers/Tokenizer/CreateTokenMapParenthesesTest.inc‎

Lines changed: 146 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,146 @@
1+
<?php
2+
3+
/* testDeclareParenthesesOwner */
4+
declare(strict_types=1/* testDeclareParenthesesCloser */);
5+
6+
/* testIfParenthesesOwner */
7+
if ($a /* testIfParenthesesCloser */) {
8+
/* testElseIfParenthesesOwner */
9+
} elseif ($b /* testElseIfParenthesesCloser */) {
10+
}
11+
12+
/* testForParenthesesOwner */
13+
for ($a = 1; $a < $b; $a++ /* testForParenthesesCloser */) {}
14+
15+
/* testForeachParenthesesOwnerPlain */
16+
foreach ($array as $k => $v /* testForeachParenthesesCloserPlain */) {}
17+
18+
/* testForeachParenthesesOwnerWithNestedArray */
19+
foreach /*comment*/ (
20+
/* testArrayParenthesesOwner */
21+
array('a', 'b'/* testArrayParenthesesCloser */ ) as $k => $v
22+
/* testForeachParenthesesCloserWithNestedArray */
23+
) {}
24+
25+
/* testForeachParenthesesOwnerWithNestedList */
26+
foreach (
27+
/* testListParenthesesOwner */
28+
$array as list($a, $b/* testListParenthesesCloser */)
29+
/* testForeachParenthesesCloserWithNestedList */
30+
) {}
31+
32+
/* testSwitchParenthesesOwner */
33+
switch ($foo/* testSwitchParenthesesCloser */) {
34+
case '1';
35+
break;
36+
}
37+
38+
/* testWhileParenthesesOwner */
39+
while( $bar /* testWhileParenthesesCloser */) {}
40+
41+
do {
42+
something();
43+
/* testDoWhileParenthesesOwner */
44+
} while (true/* testDoWhileParenthesesCloser */);
45+
46+
try {
47+
/* testCatchParenthesesOwner */
48+
} catch (MyException | OtherException $e /* testCatchParenthesesCloser */) {
49+
}
50+
51+
/* testMatchParenthesesOwner */
52+
$m = match ($baz/* testMatchParenthesesCloser */) {
53+
default => 10,
54+
};
55+
56+
/* testFunctionParenthesesOwner */
57+
function name($a, $b/* testFunctionParenthesesCloser */) {}
58+
59+
/* testFunctionParenthesesOwnerReturnByRef */
60+
function &returnByRef ($a, $b/* testFunctionParenthesesCloserReturnByRef */) {}
61+
62+
class ReservedKeyword {
63+
/* testFunctionParenthesesOwnerKeywordName */
64+
public function match($a, $b/* testFunctionParenthesesCloserKeywordName */) {}
65+
}
66+
67+
/* testClosureParenthesesOwner */
68+
$cl = function($a, $b/* testClosureParenthesesCloser */) {};
69+
70+
/* testAnonClassParenthesesOwner */
71+
$anon = new class($a, $b/* testAnonClassParenthesesCloser */) {};
72+
73+
/* testAnonClassNoParentheses */
74+
$anon = new class {
75+
const FOO = 1;
76+
};
77+
78+
// This snippet belongs with the testAnonClassNoParentheses case. Making sure these parentheses are not set for the anon class.
79+
$a = ($b + 10);
80+
81+
/* testArbitraryParenthesesOpener */
82+
$a = ($b + $c/* testArbitraryParenthesesCloser */);
83+
84+
/* testFunctionCallParenthesesOpener */
85+
do_something($b + $c, $d, false /* testFunctionCallParenthesesCloser */);
86+
87+
/* testIssetParenthesesOpener */
88+
$set = isset($b, $c/* testIssetParenthesesCloser */);
89+
90+
/* testEmptyParenthesesOpener */
91+
$empty = empty($b /* testEmptyParenthesesCloser */);
92+
93+
/* testUnsetParenthesesOpener */
94+
unset ($b, $c /* testUnsetParenthesesCloser */);
95+
96+
/* testEvalParenthesesOpener */
97+
$eval = eval("\$str = \"$str\";"/* testEvalParenthesesCloser */);
98+
99+
/* testExitParenthesesOpener */
100+
exit ( 101 /* testExitParenthesesCloser */);
101+
102+
/* testDieParenthesesOpener */
103+
die ('oopsie' /* testDieParenthesesCloser */);
104+
105+
106+
/*
107+
* All together now, let's make things a little more interesting....
108+
*/
109+
110+
/* testNestedOuterIfParenthesesOwner */
111+
if (
112+
/* testNestedFunctionCallAParenthesesOpener */
113+
array_map(
114+
/* testNestedClosureParenthesesOwner */
115+
function ($a, $b /* testNestedClosureParenthesesCloser */) /* testNestedClosureUseParenthesesOpener */
116+
use (&$c /* testNestedClosureUseParenthesesCloser */)
117+
{
118+
/* testNestedForeachParenthesesOwner */
119+
foreach (
120+
/* testNestedFunctionCallBParenthesesOpener */
121+
array_keys(
122+
/* testNestedFunctionCallCParenthesesOpener */
123+
function_call(
124+
/* testNestedArrayAParenthesesOwner */
125+
array(10, 20/* testNestedArrayAParenthesesCloser */)
126+
/* testNestedFunctionCallCParenthesesCloser */
127+
)
128+
/* testNestedFunctionCallBParenthesesCloser */
129+
)
130+
as
131+
$v
132+
/* testNestedForeachParenthesesCloser */
133+
) {}
134+
},
135+
/* testNestedArrayBParenthesesOwner */
136+
array(
137+
/* testNestedListParenthesesOwner */
138+
'keyA' => list($a, $b/* testNestedListParenthesesCloser */) = $array,
139+
/* testNestedAnonClassParenthesesOwner */
140+
'keyB' => new class($foo/* testNestedAnonClassParenthesesCloser */) {},
141+
/* testNestedArrayBParenthesesCloser */
142+
)
143+
/* testNestedFunctionCallAParenthesesCloser */
144+
)
145+
/* testNestedOuterIfParenthesesCloser */
146+
) {}

0 commit comments

Comments
 (0)