Skip to content

Fix mis-identification of 'readonly' keyword #3773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

Fix mis-identification of 'readonly' keyword #3773

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6385006
Fix mis-identification of 'readonly' keyword
fredden Mar 3, 2023
f324e5c
Ensure disjunctive normal form types are handled
fredden Jun 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 31 additions & 39 deletions src/Tokenizers/PHP.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,6 +566,17 @@ protected function tokenize($string)
$lastNotEmptyToken = ($newStackPtr - 1);
}

// Get the next non-empty token.
$nextNonEmptyToken = null;
for ($i = ($stackPtr + 1); $i < $numTokens; $i++) {
if (is_array($tokens[$i]) === false
|| isset(Util\Tokens::$emptyTokens[$tokens[$i][0]]) === false
) {
$nextNonEmptyToken = $i;
break;
}
}

/*
If we are using \r\n newline characters, the \r and \n are sometimes
split over two tokens. This normally occurs after comments. We need
Expand Down Expand Up @@ -602,14 +613,17 @@ protected function tokenize($string)
}

/*
Tokenize context sensitive keyword as string when it should be string.
Tokenize context-sensitive keyword as string when it should be string.
*/

if ($tokenIsArray === true
&& isset(Util\Tokens::$contextSensitiveKeywords[$token[0]]) === true
&& (isset($this->tstringContexts[$finalTokens[$lastNotEmptyToken]['code']]) === true
|| $finalTokens[$lastNotEmptyToken]['content'] === '&')
|| $finalTokens[$lastNotEmptyToken]['content'] === '&'
|| (isset($nextNonEmptyToken) === true && $tokens[$nextNonEmptyToken] === '('))
) {
$preserveKeyword = true;

if (isset($this->tstringContexts[$finalTokens[$lastNotEmptyToken]['code']]) === true) {
$preserveKeyword = false;

Expand Down Expand Up @@ -649,8 +663,6 @@ protected function tokenize($string)
}//end if

if ($finalTokens[$lastNotEmptyToken]['content'] === '&') {
$preserveKeyword = true;

for ($i = ($lastNotEmptyToken - 1); $i >= 0; $i--) {
if (isset(Util\Tokens::$emptyTokens[$finalTokens[$i]['code']]) === true) {
continue;
Expand All @@ -664,6 +676,13 @@ protected function tokenize($string)
}
}

if (isset($nextNonEmptyToken) === true
&& $tokens[$nextNonEmptyToken] === '('
&& $token[0] === T_READONLY
) {
$preserveKeyword = false;
}

if ($preserveKeyword === false) {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = Util\Tokens::tokenName($token[0]);
Expand Down Expand Up @@ -1012,18 +1031,9 @@ protected function tokenize($string)
&& $token[0] === T_STRING
&& strtolower($token[1]) === 'enum'
) {
// Get the next non-empty token.
for ($i = ($stackPtr + 1); $i < $numTokens; $i++) {
if (is_array($tokens[$i]) === false
|| isset(Util\Tokens::$emptyTokens[$tokens[$i][0]]) === false
) {
break;
}
}

if (isset($tokens[$i]) === true
&& is_array($tokens[$i]) === true
&& $tokens[$i][0] === T_STRING
if (isset($tokens[$nextNonEmptyToken]) === true
&& is_array($tokens[$nextNonEmptyToken]) === true
&& $tokens[$nextNonEmptyToken][0] === T_STRING
) {
// Modify $tokens directly so we can use it later when converting enum "case".
$tokens[$stackPtr][0] = T_ENUM;
Expand Down Expand Up @@ -1230,18 +1240,9 @@ protected function tokenize($string)
&& ($token[0] === T_STRING
|| preg_match('`^[a-zA-Z_\x80-\xff]`', $token[1]) === 1)
) {
// Get the next non-empty token.
for ($i = ($stackPtr + 1); $i < $numTokens; $i++) {
if (is_array($tokens[$i]) === false
|| isset(Util\Tokens::$emptyTokens[$tokens[$i][0]]) === false
) {
break;
}
}

if (isset($tokens[$i]) === true
&& is_array($tokens[$i]) === false
&& $tokens[$i] === ':'
if (isset($tokens[$nextNonEmptyToken]) === true
&& is_array($tokens[$nextNonEmptyToken]) === false
&& $tokens[$nextNonEmptyToken] === ':'
) {
// Get the previous non-empty token.
for ($j = ($stackPtr - 1); $j > 0; $j--) {
Expand Down Expand Up @@ -1287,17 +1288,8 @@ protected function tokenize($string)
&& strtolower($token[1]) === 'readonly'
&& isset($this->tstringContexts[$finalTokens[$lastNotEmptyToken]['code']]) === false
) {
// Get the next non-whitespace token.
for ($i = ($stackPtr + 1); $i < $numTokens; $i++) {
if (is_array($tokens[$i]) === false
|| $tokens[$i][0] !== T_WHITESPACE
) {
break;
}
}

if (isset($tokens[$i]) === false
|| $tokens[$i] !== '('
if (isset($tokens[$nextNonEmptyToken]) === false
|| $tokens[$nextNonEmptyToken] !== '('
) {
$finalTokens[$newStackPtr] = [
'code' => T_READONLY,
Expand Down
8 changes: 4 additions & 4 deletions tests/Core/Tokenizer/BackfillReadonlyTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,10 +147,6 @@ public function dataReadonly()
'/* testReadonlyPropertyInAnonymousClass */',
'readonly',
],
[
'/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */',
'readonly',
],
[
'/* testParseErrorLiveCoding */',
'readonly',
Expand Down Expand Up @@ -224,6 +220,10 @@ public function dataNotReadonly()
'/* testReadonlyAsFunctionCall */',
'readonly',
],
[
'/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */',
'readonly',
],
[
'/* testClassConstantFetchWithReadonlyAsConstantName */',
'READONLY',
Expand Down