Skip to content

Commit 525aced

Browse files
TysonAndreTysonAndre
committed
Fix handling of HaltCompilerStatement
Make it easier to calculate `__COMPILER_HALT_OFFSET__`. Related to #381 Address other edge cases
1 parent a35ec03 commit 525aced

14 files changed

+186
-78
lines changed

‎src/Node/Statement/HaltCompilerStatement.php‎

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,17 +20,27 @@ class HaltCompilerStatement extends Expression {
2020
/** @var Token */
2121
public $closeParen;
2222

23-
/** @var Token */
24-
public $semicolon;
23+
/** @var Token (there is an implicit ')' before php close tags (`?>`)) */
24+
public $semicolonOrCloseTag;
2525

26-
/** @var Token */
26+
/** @var Token|null TokenKind::InlineHtml data unless there are no bytes (This is optional if there is nothing after the semicolon) */
2727
public $data;
2828

2929
const CHILD_NAMES = [
3030
'haltCompilerKeyword',
3131
'openParen',
3232
'closeParen',
33-
'semicolon',
33+
'semicolonOrCloseTag',
3434
'data',
3535
];
36+
37+
/**
38+
* @return int
39+
*/
40+
public function getHaltCompilerOffset()
41+
{
42+
// This accounts for the fact that PHP close tags may include a single newline,
43+
// and that $this->data may be null.
44+
return $this->semicolonOrCloseTag->getEndPosition();
45+
}
3646
}

‎src/Parser.php‎

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2864,8 +2864,20 @@ private function parseHaltCompilerStatement($parentNode) {
28642864
$unsetStatement->haltCompilerKeyword = $this->eat1(TokenKind::HaltCompilerKeyword);
28652865
$unsetStatement->openParen = $this->eat1(TokenKind::OpenParenToken);
28662866
$unsetStatement->closeParen = $this->eat1(TokenKind::CloseParenToken);
2867-
$unsetStatement->semicolon = $this->eatSemicolonOrAbortStatement();
2868-
$unsetStatement->data = $this->eatOptional1(TokenKind::InlineHtml);
2867+
// There is an implicit ';' before the closing php tag.
2868+
$unsetStatement->semicolonOrCloseTag = $this->eat(TokenKind::SemicolonToken, TokenKind::ScriptSectionEndTag);
2869+
// token_get_all() will return up to 3 tokens after __halt_compiler regardless of whether they're the right ones.
2870+
// For invalid php snippets, combine the remaining tokens into InlineHtml
2871+
$remainingTokens = [];
2872+
while ($this->token->kind !== TokenKind::EndOfFileToken) {
2873+
$remainingTokens[] = $this->token;
2874+
$this->advanceToken();
2875+
}
2876+
if ($remainingTokens) {
2877+
$firstToken = $remainingTokens[0];
2878+
$lastToken = end($remainingTokens);
2879+
$unsetStatement->data = new Token(TokenKind::InlineHtml, $firstToken->fullStart, $firstToken->start, $lastToken->fullStart + $lastToken->length - $firstToken->fullStart);
2880+
}
28692881
return $unsetStatement;
28702882
}
28712883

‎src/Token.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class Token implements \JsonSerializable {
1818
public $fullStart;
1919
/** @var int */
2020
public $start;
21-
/** @var int */
21+
/** @var int the length is equal to $this->getEndPosition() - $this->fullStart. */
2222
public $length;
2323

2424
/**

‎tests/cases/parser/haltCompiler1.php.tree‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
"kind": "CloseParenToken",
2626
"textLength": 1
2727
},
28-
"semicolon": {
28+
"semicolonOrCloseTag": {
2929
"kind": "SemicolonToken",
3030
"textLength": 1
3131
},

‎tests/cases/parser/haltCompiler4.php.diag‎

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,29 +16,5 @@
1616
"message": "';' expected.",
1717
"start": 32,
1818
"length": 0
19-
},
20-
{
21-
"kind": 0,
22-
"message": "Unexpected '::'",
23-
"start": 32,
24-
"length": 2
25-
},
26-
{
27-
"kind": 0,
28-
"message": "')' expected.",
29-
"start": 38,
30-
"length": 0
31-
},
32-
{
33-
"kind": 0,
34-
"message": "';' expected.",
35-
"start": 38,
36-
"length": 0
37-
},
38-
{
39-
"kind": 0,
40-
"message": "Unexpected 'InlineHtml'",
41-
"start": 38,
42-
"length": 3
4319
}
4420
]

‎tests/cases/parser/haltCompiler4.php.tree‎

Lines changed: 4 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -27,58 +27,16 @@
2727
"kind": "CloseParenToken",
2828
"textLength": 0
2929
},
30-
"semicolon": {
30+
"semicolonOrCloseTag": {
3131
"error": "MissingToken",
3232
"kind": "SemicolonToken",
3333
"textLength": 0
3434
},
35-
"data": null
36-
}
37-
},
38-
{
39-
"error": "SkippedToken",
40-
"kind": "ColonColonToken",
41-
"textLength": 2
42-
},
43-
{
44-
"ExpressionStatement": {
45-
"expression": {
46-
"CallExpression": {
47-
"callableExpression": {
48-
"QualifiedName": {
49-
"globalSpecifier": null,
50-
"relativeSpecifier": null,
51-
"nameParts": [
52-
{
53-
"kind": "Name",
54-
"textLength": 3
55-
}
56-
]
57-
}
58-
},
59-
"openParen": {
60-
"kind": "OpenParenToken",
61-
"textLength": 1
62-
},
63-
"argumentExpressionList": null,
64-
"closeParen": {
65-
"error": "MissingToken",
66-
"kind": "CloseParenToken",
67-
"textLength": 0
68-
}
69-
}
70-
},
71-
"semicolon": {
72-
"error": "MissingToken",
73-
"kind": "SemicolonToken",
74-
"textLength": 0
35+
"data": {
36+
"kind": "InlineHtml",
37+
"textLength": 9
7538
}
7639
}
77-
},
78-
{
79-
"error": "SkippedToken",
80-
"kind": "InlineHtml",
81-
"textLength": 3
8240
}
8341
],
8442
"endOfFileToken": {

‎tests/cases/parser/haltCompiler5.php.diag‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[]

‎tests/cases/parser/haltCompiler5.php.tree‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"SourceFileNode": {
3+
"statementList": [
4+
{
5+
"InlineHtml": {
6+
"scriptSectionEndTag": null,
7+
"text": null,
8+
"scriptSectionStartTag": {
9+
"kind": "ScriptSectionStartTag",
10+
"textLength": 6
11+
}
12+
}
13+
},
14+
{
15+
"HaltCompilerStatement": {
16+
"haltCompilerKeyword": {
17+
"kind": "HaltCompilerKeyword",
18+
"textLength": 15
19+
},
20+
"openParen": {
21+
"kind": "OpenParenToken",
22+
"textLength": 1
23+
},
24+
"closeParen": {
25+
"kind": "CloseParenToken",
26+
"textLength": 1
27+
},
28+
"semicolon": null,
29+
"data": null
30+
}
31+
},
32+
{
33+
"InlineHtml": {
34+
"scriptSectionEndTag": {
35+
"kind": "ScriptSectionEndTag",
36+
"textLength": 3
37+
},
38+
"text": null,
39+
"scriptSectionStartTag": null
40+
}
41+
}
42+
],
43+
"endOfFileToken": {
44+
"kind": "EndOfFileToken",
45+
"textLength": 0
46+
}
47+
}
48+
}

‎tests/cases/parser/haltCompiler6.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<?php /* has implicit ';' and no trailing newline byte */ __halt_compiler() ?>

‎tests/cases/parser/haltCompiler6.php.diag‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
[]

0 commit comments

Comments
 (0)