Merge pull request microsoft#382 from TysonAndre/halt-compiler-support

Support `__halt_compiler` statement

Author: roblourens

.travis.yml

@@ -19,8 +19,6 @@ matrix:
     - php: 7.2
       env: STATIC_ANALYSIS=true
   fast_finish: true
-  allow_failures:
-    - env: VALIDATION=true
 
 cache:
   directories:

src/Node/Statement/HaltCompilerStatement.php

@@ -0,0 +1,36 @@
+<?php
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+namespace Microsoft\PhpParser\Node\Statement;
+
+use Microsoft\PhpParser\Node\Expression;
+use Microsoft\PhpParser\Token;
+
+class HaltCompilerStatement extends Expression {
+
+    /** @var Token */
+    public $haltCompilerKeyword;
+
+    /** @var Token */
+    public $openParen;
+
+    /** @var Token */
+    public $closeParen;
+
+    /** @var Token */
+    public $semicolon;
+
+    /** @var Token */
+    public $data;
+
+    const CHILD_NAMES = [
+        'haltCompilerKeyword',
+        'openParen',
+        'closeParen',
+        'semicolon',
+        'data',
+    ];
+}

src/Parser.php

@@ -97,6 +97,7 @@
     ForStatement,
     FunctionDeclaration,
     GotoStatement,
+    HaltCompilerStatement,
     IfStatementNode,
     InlineHtml,
     InterfaceDeclaration,
@@ -615,6 +616,15 @@ private function parseStatementFn() {
 
                 case TokenKind::UnsetKeyword:
                     return $this->parseUnsetStatement($parentNode);
+
+                case TokenKind::HaltCompilerKeyword:
+                    if ($parentNode instanceof SourceFileNode) {
+                        return $this->parseHaltCompilerStatement($parentNode);
+                    }
+                    // __halt_compiler is a fatal compile error anywhere other than the top level.
+                    // It won't be seen elsewhere in other programs - warn about the token being unexpected.
+                    $this->advanceToken();
+                    return new SkippedToken($token);
             }
 
             $expressionStatement = new ExpressionStatement();
@@ -1141,6 +1151,9 @@ private function isStatementStart(Token $token) {
 
             // attributes
             case TokenKind::AttributeToken:
+
+            // __halt_compiler
+            case TokenKind::HaltCompilerKeyword:
                 return true;
 
             default:
@@ -2844,6 +2857,18 @@ private function parseUnsetStatement($parentNode) {
         return $unsetStatement;
     }
 
+    private function parseHaltCompilerStatement($parentNode) {
+        $unsetStatement = new HaltCompilerStatement();
+        $unsetStatement->parent = $parentNode;
+
+        $unsetStatement->haltCompilerKeyword = $this->eat1(TokenKind::HaltCompilerKeyword);
+        $unsetStatement->openParen = $this->eat1(TokenKind::OpenParenToken);
+        $unsetStatement->closeParen = $this->eat1(TokenKind::CloseParenToken);
+        $unsetStatement->semicolon = $this->eatSemicolonOrAbortStatement();
+        $unsetStatement->data = $this->eatOptional1(TokenKind::InlineHtml);
+        return $unsetStatement;
+    }
+
     private function parseArrayCreationExpression($parentNode) {
         $arrayExpression = new ArrayCreationExpression();
         $arrayExpression->parent = $parentNode;

src/PhpTokenizer.php

@@ -228,7 +228,6 @@ protected static function tokenGetAll(string $content, $parseContext): array
         T_DIR => TokenKind::Name,
         T_FILE => TokenKind::Name,
         T_FUNC_C => TokenKind::Name,
-        T_HALT_COMPILER => TokenKind::Name,
         T_METHOD_C => TokenKind::Name,
         T_NS_C => TokenKind::Name,
         T_TRAIT_C => TokenKind::Name,
@@ -274,6 +273,7 @@ protected static function tokenGetAll(string $content, $parseContext): array
         T_FUNCTION => TokenKind::FunctionKeyword,
         T_GLOBAL => TokenKind::GlobalKeyword,
         T_GOTO => TokenKind::GotoKeyword,
+        T_HALT_COMPILER => TokenKind::HaltCompilerKeyword,
         T_IF => TokenKind::IfKeyword,
         T_IMPLEMENTS => TokenKind::ImplementsKeyword,
         T_INCLUDE => TokenKind::IncludeKeyword,

src/TokenKind.php

@@ -91,6 +91,7 @@ class TokenKind {
     const IterableKeyword = self::IterableReservedWord;
     const EnumKeyword = 171;
     const ReadonlyKeyword = 172;
+    const HaltCompilerKeyword = 173;
 
     const OpenBracketToken = 201;
     const CloseBracketToken = 202;

tests/cases/parser/haltCompiler1.php

@@ -0,0 +1,2 @@
+<?php
+__halt_compiler();

tests/cases/parser/haltCompiler1.php.diag

@@ -0,0 +1 @@
+[]

tests/cases/parser/haltCompiler1.php.tree

@@ -0,0 +1,44 @@
+{
+    "SourceFileNode": {
+        "statementList": [
+            {
+                "InlineHtml": {
+                    "scriptSectionEndTag": null,
+                    "text": null,
+                    "scriptSectionStartTag": {
+                        "kind": "ScriptSectionStartTag",
+                        "textLength": 6
+                    }
+                }
+            },
+            {
+                "HaltCompilerStatement": {
+                    "haltCompilerKeyword": {
+                        "kind": "HaltCompilerKeyword",
+                        "textLength": 15
+                    },
+                    "openParen": {
+                        "kind": "OpenParenToken",
+                        "textLength": 1
+                    },
+                    "closeParen": {
+                        "kind": "CloseParenToken",
+                        "textLength": 1
+                    },
+                    "semicolon": {
+                        "kind": "SemicolonToken",
+                        "textLength": 1
+                    },
+                    "data": {
+                        "kind": "InlineHtml",
+                        "textLength": 1
+                    }
+                }
+            }
+        ],
+        "endOfFileToken": {
+            "kind": "EndOfFileToken",
+            "textLength": 0
+        }
+    }
+}

tests/cases/parser/haltCompiler2.php

@@ -0,0 +1,4 @@
+<?php
+if (true) {
+    __halt_compiler();
+}

tests/cases/parser/haltCompiler2.php.diag

@@ -0,0 +1,26 @@
+[
+    {
+        "kind": 0,
+        "message": "Unexpected 'HaltCompilerKeyword'",
+        "start": 22,
+        "length": 15
+    },
+    {
+        "kind": 0,
+        "message": "'Expression' expected.",
+        "start": 38,
+        "length": 0
+    },
+    {
+        "kind": 0,
+        "message": "Unexpected 'InlineHtml'",
+        "start": 40,
+        "length": 3
+    },
+    {
+        "kind": 0,
+        "message": "'}' expected.",
+        "start": 43,
+        "length": 0
+    }
+]