Skip to content

Tokenizer/PHP: T_GOTO_LABEL no longer contains colon #1016

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

Merged
merged 1 commit into from
Apr 17, 2025
Merged

Tokenizer/PHP: T_GOTO_LABEL no longer contains colon #1016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion src/Standards/Squiz/Sniffs/PHP/DisallowMultipleAssignmentsSniff.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ public function process(File $phpcsFile, $stackPtr)

if ($tokens[$varToken]['code'] === T_VARIABLE
|| $tokens[$varToken]['code'] === T_OPEN_TAG
|| $tokens[$varToken]['code'] === T_GOTO_LABEL
|| $tokens[$varToken]['code'] === T_GOTO_COLON
|| $tokens[$varToken]['code'] === T_INLINE_THEN
|| $tokens[$varToken]['code'] === T_INLINE_ELSE
|| $tokens[$varToken]['code'] === T_SEMICOLON
Expand Down
81 changes: 52 additions & 29 deletions src/Tokenizers/PHP.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,7 @@ class PHP extends Tokenizer
T_FUNC_C => 12,
T_GLOBAL => 6,
T_GOTO => 4,
T_GOTO_COLON => 1,
T_HALT_COMPILER => 15,
T_IF => 2,
T_IMPLEMENTS => 10,
Expand Down Expand Up @@ -2199,45 +2200,67 @@ function return types. We want to keep the parenthesis map clean,

if ($tokenIsArray === true
&& $token[0] === T_STRING
&& isset($tokens[($stackPtr + 1)]) === true
&& $tokens[($stackPtr + 1)] === ':'
&& (is_array($tokens[($stackPtr - 1)]) === false
|| $tokens[($stackPtr - 1)][0] !== T_PAAMAYIM_NEKUDOTAYIM)
) {
$stopTokens = [
T_CASE => true,
T_SEMICOLON => true,
T_OPEN_TAG => true,
T_OPEN_CURLY_BRACKET => true,
T_INLINE_THEN => true,
T_ENUM => true,
];

for ($x = ($newStackPtr - 1); $x > 0; $x--) {
if (isset($stopTokens[$finalTokens[$x]['code']]) === true) {
break;
// Find next non-empty token.
for ($i = ($stackPtr + 1); $i < $numTokens; $i++) {
if (is_array($tokens[$i]) === true
&& isset(Tokens::$emptyTokens[$tokens[$i][0]]) === true
) {
continue;
}

break;
}

if ($finalTokens[$x]['code'] !== T_CASE
&& $finalTokens[$x]['code'] !== T_INLINE_THEN
&& $finalTokens[$x]['code'] !== T_ENUM
) {
$finalTokens[$newStackPtr] = [
'content' => $token[1].':',
'code' => T_GOTO_LABEL,
'type' => 'T_GOTO_LABEL',
if (isset($tokens[$i]) === true && $tokens[$i] === ':') {
// Okay, so we have a colon, now we need to make sure that this is not
// class constant access, a ternary, enum or switch case.
$stopTokens = [
T_CASE => true,
T_SEMICOLON => true,
T_OPEN_TAG => true,
T_OPEN_CURLY_BRACKET => true,
T_INLINE_THEN => true,
T_ENUM => true,
];

if (PHP_CODESNIFFER_VERBOSITY > 1) {
StatusWriter::write("* token $stackPtr changed from T_STRING to T_GOTO_LABEL", 2);
StatusWriter::write('* skipping T_COLON token '.($stackPtr + 1), 2);
for ($x = ($newStackPtr - 1); $x > 0; $x--) {
if (isset($stopTokens[$finalTokens[$x]['code']]) === true) {
break;
}
}

$newStackPtr++;
$stackPtr++;
continue;
}
if ($finalTokens[$x]['code'] !== T_CASE
&& $finalTokens[$x]['code'] !== T_INLINE_THEN
&& $finalTokens[$x]['code'] !== T_ENUM
) {
$finalTokens[$newStackPtr] = [
'content' => $token[1],
'code' => T_GOTO_LABEL,
'type' => 'T_GOTO_LABEL',
];

if (PHP_CODESNIFFER_VERBOSITY > 1) {
StatusWriter::write("* token $stackPtr changed from T_STRING to T_GOTO_LABEL", 2);
}

// Modify the original token stack for the colon as potential
// whitespace/comments between still needs to get the normal treatment.
$tokens[$i] = [
0 => T_GOTO_COLON,
1 => ':',
];

if (PHP_CODESNIFFER_VERBOSITY > 1) {
StatusWriter::write("* token $i changed from \":\" to T_GOTO_COLON in the original token stack", 2);
}

$newStackPtr++;
continue;
}//end if
}//end if
}//end if

/*
Expand Down
1 change: 1 addition & 0 deletions src/Util/Tokens.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
define('T_OPEN_SHORT_ARRAY', 'PHPCS_T_OPEN_SHORT_ARRAY');
define('T_CLOSE_SHORT_ARRAY', 'PHPCS_T_CLOSE_SHORT_ARRAY');
define('T_GOTO_LABEL', 'PHPCS_T_GOTO_LABEL');
define('T_GOTO_COLON', 'PHPCS_T_GOTO_COLON');
define('T_BINARY_CAST', 'PHPCS_T_BINARY_CAST');
define('T_OPEN_USE_GROUP', 'PHPCS_T_OPEN_USE_GROUP');
define('T_CLOSE_USE_GROUP', 'PHPCS_T_CLOSE_USE_GROUP');
Expand Down
4 changes: 2 additions & 2 deletions tests/Core/Tokenizers/PHP/GotoLabelTest.inc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ echo "i = $i";

<?php
/* testGotoDeclarationOutsideLoop */
end:
end /*comment*/ :
echo 'j hit 17';

switch($x){
Expand All @@ -31,7 +31,7 @@ switch($x){
goto def;
default:
/* testGotoDeclarationInSwitch */
def:
def :
print($x);
}

Expand Down
19 changes: 14 additions & 5 deletions tests/Core/Tokenizers/PHP/GotoLabelTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
namespace PHP_CodeSniffer\Tests\Core\Tokenizers\PHP;

use PHP_CodeSniffer\Tests\Core\Tokenizers\AbstractTokenizerTestCase;
use PHP_CodeSniffer\Util\Tokens;

/**
* Tests the tokenization of goto declarations and statements.
Expand Down Expand Up @@ -74,7 +75,8 @@ public static function dataGotoStatement()


/**
* Verify that the label in a goto declaration is tokenized as T_GOTO_LABEL.
* Verify that the label in a goto declaration is tokenized as T_GOTO_LABEL
* and that the next non-empty token is always T_GOTO_COLON.
*
* @param string $testMarker The comment prefacing the target token.
* @param string $testContent The token content to expect.
Expand All @@ -92,6 +94,13 @@ public function testGotoDeclaration($testMarker, $testContent)
$this->assertIsInt($label);
$this->assertSame($testContent, $tokens[$label]['content']);

$next = $this->phpcsFile->findNext(Tokens::$emptyTokens, ($label + 1), null, true);

$this->assertIsInt($next);
$this->assertSame(T_GOTO_COLON, $tokens[$next]['code']);
$this->assertSame('T_GOTO_COLON', $tokens[$next]['type']);
$this->assertSame(':', $tokens[$next]['content']);

}//end testGotoDeclaration()


Expand All @@ -107,19 +116,19 @@ public static function dataGotoDeclaration()
return [
'label in goto declaration - marker' => [
'testMarker' => '/* testGotoDeclaration */',
'testContent' => 'marker:',
'testContent' => 'marker',
],
'label in goto declaration - end' => [
'testMarker' => '/* testGotoDeclarationOutsideLoop */',
'testContent' => 'end:',
'testContent' => 'end',
],
'label in goto declaration - def' => [
'testMarker' => '/* testGotoDeclarationInSwitch */',
'testContent' => 'def:',
'testContent' => 'def',
],
'label in goto declaration - label' => [
'testMarker' => '/* testGotoDeclarationInFunction */',
'testContent' => 'label:',
'testContent' => 'label',
],
];

Expand Down