Skip to content
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

Jump to bottom

Fix mis-identification of 'readonly' keyword #3773

Closed
wants to merge 2 commits into from
Closed

Fix mis-identification of 'readonly' keyword #3773

Show file tree
Hide file tree
Changes from all commits
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
122 changes: 83 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 @@ -601,15 +612,22 @@ protected function tokenize($string)
echo PHP_EOL;
}

if (PHP_VERSION_ID < 802000 && $token[0] === T_STRING && strtolower($token[1]) === 'readonly') {
$token[0] = T_READONLY;
}

/*
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 +667,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 +680,61 @@ protected function tokenize($string)
}
}

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

for ($i = ($nextNonEmptyToken + 1); $i < $numTokens; $i++) {
if ($foundDNFCloseParen === false && $tokens[$i] === ')') {
$foundDNFCloseParen = true;
continue;
}

if ($foundDNFCloseParen === true && $foundDNFPipe === false && $tokens[$i] === '|') {
$foundDNFPipe = true;
continue;
}

$stopTokens = [
'{',
'}',
'=',
';',
'|',
':',
',',
'(',
')',
];
if (in_array($tokens[$i], $stopTokens, true) === true) {
// We have finished our search.
break;
}

if ($foundDNFPipe !== true) {
continue;
}

if (is_array($tokens[$i]) === false) {
continue;
}

if ($tokens[$i][0] === T_VARIABLE) {
$foundProperty = true;
break;
}
}//end for

if ($foundProperty === false) {
$preserveKeyword = false;
}
}//end if

if ($preserveKeyword === false) {
if (PHP_CODESNIFFER_VERBOSITY > 1) {
$type = Util\Tokens::tokenName($token[0]);
Expand Down Expand Up @@ -1012,18 +1083,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 +1292,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 +1340,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
57 changes: 57 additions & 0 deletions tests/Core/Tokenizer/BackfillReadonlyTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,63 @@ echo ClassName::READONLY;
/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */
$var = readonly /* comment */ ();

// These test cases are inspired by
// https://github.com/php/php-src/commit/08b75395838b4b42a41e3c70684fa6c6b113eee0
class Dnf
{
/* testDNFPropertyReadonlyPublicABC */
readonly public A|(B&C) $a;
/* testDNFPropertyReadonlyPublicBCA */
readonly public (B&C)|A $b;

/* testDNFPropertyReadonlyProtectedABC */
readonly protected A|(B&C) $c;
/* testDNFPropertyReadonlyProtectedBCA */
readonly protected (B&C)|A $d;

/* testDNFPropertyReadonlyPrivateABC */
readonly private A|(B&C) $e;
/* testDNFPropertyReadonlyPrivateBCA */
readonly private (B&C)|A $f;

/* testDNFPropertyReadonlyABC */
readonly A|(B&C) $g;
/* testDNFPropertyReadonlyBCA */
readonly (B&C)|A $h;

/* testDNFPropertyPublicReadonlyABC */
public readonly A|(B&C) $i;
/* testDNFPropertyPublicReadonlyBCA */
public readonly (B&C)|A $j;

/* testDNFPropertyProtectedReadonlyABC */
protected readonly A|(B&C) $k;
/* testDNFPropertyProtectedReadonlyBCA */
protected readonly (B&C)|A $l;

/* testDNFPropertyPrivateReadonlyABC */
private readonly A|(B&C) $m;
/* testDNFPropertyPrivateReadonlyBCA */
private readonly (B&C)|A $n;

/* testDNFPropertyPrivateReadonlyB_space_CA */
private readonly (B & C)|A $o;
/* testDNFPropertyPrivateReadonlyBC_space_A */
private readonly (B&C) | A $p;
/* testDNFPropertyPrivateReadonlyB_space_C_space_A */
private readonly (B & C) | A $q;

/* testDNFMethodAB */
public function readonly (A&B $param): void {}

public function __construct(
/* testDNFPropertyPromotionABC */
private readonly A|(B&C) $a1,
/* testDNFPropertyPromotionBCA */
private readonly (B&C)|A $b1,
) {}
}

/* testParseErrorLiveCoding */
// This must be the last test in the file.
readonly
82 changes: 81 additions & 1 deletion tests/Core/Tokenizer/BackfillReadonlyTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,79 @@ public function dataReadonly()
'readonly',
],
[
'/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */',
'/* testDNFPropertyReadonlyPublicABC */',
'readonly',
],
[
'/* testDNFPropertyReadonlyPublicBCA */',
'readonly',
],
[
'/* testDNFPropertyReadonlyProtectedABC */',
'readonly',
],
[
'/* testDNFPropertyReadonlyProtectedBCA */',
'readonly',
],
[
'/* testDNFPropertyReadonlyPrivateABC */',
'readonly',
],
[
'/* testDNFPropertyReadonlyPrivateBCA */',
'readonly',
],
[
'/* testDNFPropertyReadonlyABC */',
'readonly',
],
[
'/* testDNFPropertyReadonlyBCA */',
'readonly',
],
[
'/* testDNFPropertyPublicReadonlyABC */',
'readonly',
],
[
'/* testDNFPropertyPublicReadonlyBCA */',
'readonly',
],
[
'/* testDNFPropertyProtectedReadonlyABC */',
'readonly',
],
[
'/* testDNFPropertyProtectedReadonlyBCA */',
'readonly',
],
[
'/* testDNFPropertyPrivateReadonlyABC */',
'readonly',
],
[
'/* testDNFPropertyPrivateReadonlyBCA */',
'readonly',
],
[
'/* testDNFPropertyPrivateReadonlyB_space_CA */',
'readonly',
],
[
'/* testDNFPropertyPrivateReadonlyBC_space_A */',
'readonly',
],
[
'/* testDNFPropertyPrivateReadonlyB_space_C_space_A */',
'readonly',
],
[
'/* testDNFPropertyPromotionABC */',
'readonly',
],
[
'/* testDNFPropertyPromotionBCA */',
'readonly',
],
[
Expand Down Expand Up @@ -224,10 +296,18 @@ public function dataNotReadonly()
'/* testReadonlyAsFunctionCall */',
'readonly',
],
[
'/* testReadonlyUsedAsFunctionCallWithSpaceBetweenKeywordAndParens */',
'readonly',
],
[
'/* testClassConstantFetchWithReadonlyAsConstantName */',
'READONLY',
],
[
'/* testDNFMethodAB */',
'readonly',
],
];

}//end dataNotReadonly()
Expand Down