Issue 178 - Declare Statement Directive List

src/Node/DelimitedList/DeclareDirectiveList.php

@@ -0,0 +1,12 @@
+<?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\DelimitedList;
+
+use Microsoft\PhpParser\Node\DelimitedList;
+
+class DeclareDirectiveList extends DelimitedList {
+}

src/Node/Statement/DeclareStatement.php

@@ -7,6 +7,7 @@
 namespace Microsoft\PhpParser\Node\Statement;
 
 use Microsoft\PhpParser\Node;
+use Microsoft\PhpParser\Node\DelimitedList;
 use Microsoft\PhpParser\Node\StatementNode;
 use Microsoft\PhpParser\Token;
 
@@ -17,6 +18,8 @@ class DeclareStatement extends StatementNode {
     public $openParen;
     /** @var Node */
     public $declareDirective;
+    /** @var DelimitedList\DeclareDirectiveList|null TODO: Merge with $declareDirective in a future backwards incompatible release. */
+    public $otherDeclareDirectives;
     /** @var Token */
     public $closeParen;
     /** @var Token|null */
@@ -32,6 +35,7 @@ class DeclareStatement extends StatementNode {
         'declareKeyword',
         'openParen',
         'declareDirective',
+        'otherDeclareDirectives',
         'closeParen',
         'colon',
         'statements',

src/Parser.php

@@ -2308,7 +2308,7 @@ private function parseDeclareStatement($parentNode) {
         $declareStatement->parent = $parentNode;
         $declareStatement->declareKeyword = $this->eat1(TokenKind::DeclareKeyword);
         $declareStatement->openParen = $this->eat1(TokenKind::OpenParenToken);
-        $declareStatement->declareDirective = $this->parseDeclareDirective($declareStatement);
+        $this->parseAndSetDeclareDirectiveList($declareStatement);
         $declareStatement->closeParen = $this->eat1(TokenKind::CloseParenToken);
 
         if ($this->checkToken(TokenKind::SemicolonToken)) {
@@ -2325,26 +2325,76 @@ private function parseDeclareStatement($parentNode) {
         return $declareStatement;
     }
 
-    private function parseDeclareDirective($parentNode) {
-        $declareDirective = new DeclareDirective();
+    /**
+     * @param DeclareStatement $parentNode
+     */
+    private function parseAndSetDeclareDirectiveList($parentNode) {
+        $declareDirectiveList = $this->parseDeclareDirectiveList($parentNode);
+
+        if (!$declareDirectiveList) {
+            $declareDirective = new DeclareDirective();
+            $declareDirective->parent = $parentNode;
+
+            $declareDirective->name = new MissingToken(TokenKind::Name, $this->token->fullStart);
+            $declareDirective->equals = new MissingToken(TokenKind::EqualsToken, $this->token->fullStart);
+            // TODO: This is matching the first token in $this::parseDeclareDirectiveFn.
+            //       Probably best to emit a more general "literal error".
+            $declareDirective->literal = new MissingToken(TokenKind::FloatingLiteralToken, $this->token->fullStart);
+
+            $parentNode->declareDirective = $declareDirective;
+            return;
+        }
+
+        $declareDirective = array_shift($declareDirectiveList->children);
+        $parentNode->declareDirective = $declareDirective;
         $declareDirective->parent = $parentNode;
-        $declareDirective->name = $this->eat1(TokenKind::Name);
-        $declareDirective->equals = $this->eat1(TokenKind::EqualsToken);
-        $declareDirective->literal =
-            $this->eat(
-                TokenKind::FloatingLiteralToken,
-                TokenKind::IntegerLiteralToken,
-                TokenKind::DecimalLiteralToken,
-                TokenKind::OctalLiteralToken,
-                TokenKind::HexadecimalLiteralToken,
-                TokenKind::BinaryLiteralToken,
-                TokenKind::InvalidOctalLiteralToken,
-                TokenKind::InvalidHexadecimalLiteral,
-                TokenKind::InvalidBinaryLiteral,
-                TokenKind::StringLiteralToken
-            ); // TODO simplify
-
-        return $declareDirective;
+
+        if ($declareDirectiveList->children) {
+            $parentNode->otherDeclareDirectives = $declareDirectiveList;
+        }
+    }
+
+    /**
+     * @param DeclareStatement $parentNode
+     * @return DelimitedList\DeclareDirectiveList|null
+     */
+    private function parseDeclareDirectiveList($parentNode) {
+        $declareDirectiveList = $this->parseDelimitedList(
+            DelimitedList\DeclareDirectiveList::class,
+            TokenKind::CommaToken,
+            function ($token) {
+                return $token->kind === TokenKind::Name;
+            },
+            $this->parseDeclareDirectiveFn(),
+            $parentNode,
+            false
+        );
+
+        return $declareDirectiveList;
+    }
+
+    private function parseDeclareDirectiveFn() {
+        return function ($parentNode) {
+            $declareDirective = new DeclareDirective();
+            $declareDirective->parent = $parentNode;
+            $declareDirective->name = $this->eat1(TokenKind::Name);
+            $declareDirective->equals = $this->eat1(TokenKind::EqualsToken);
+            $declareDirective->literal =
+                $this->eat(
+                    TokenKind::FloatingLiteralToken,
+                    TokenKind::IntegerLiteralToken,
+                    TokenKind::DecimalLiteralToken,
+                    TokenKind::OctalLiteralToken,
+                    TokenKind::HexadecimalLiteralToken,
+                    TokenKind::BinaryLiteralToken,
+                    TokenKind::InvalidOctalLiteralToken,
+                    TokenKind::InvalidHexadecimalLiteral,
+                    TokenKind::InvalidBinaryLiteral,
+                    TokenKind::StringLiteralToken
+                ); // TODO simplify
+
+            return $declareDirective;
+        };
     }
 
     private function parseSimpleVariable($parentNode) {

tests/ParserGrammarTest.php

@@ -4,7 +4,6 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-use Microsoft\PhpParser\Token;
 use Microsoft\PhpParser\DiagnosticsProvider;
 use PHPUnit\Framework\Test;
 use PHPUnit\Framework\TestCase;
@@ -123,7 +122,7 @@ public function testSpecOutputTreeClassificationAndLength($testCaseFile, $expect
     }
 
     public function outTreeProvider() {
-        $testCases = glob(__dir__ . "/cases/php-langspec/**/*.php");
+        $testCases = glob(__DIR__ . "/cases/php-langspec/**/*.php");
         $skipped = json_decode(file_get_contents(__DIR__ . "/skipped.json"));
 
         $testProviderArray = array();

tests/cases/parser/declareStatement1.php.tree

@@ -37,6 +37,7 @@
                             }
                         }
                     },
+                    "otherDeclareDirectives": null,
                     "closeParen": {
                         "kind": "CloseParenToken",
                         "textLength": 1

tests/cases/parser/declareStatement10.php.tree

@@ -37,6 +37,7 @@
                             }
                         }
                     },
+                    "otherDeclareDirectives": null,
                     "closeParen": {
                         "kind": "CloseParenToken",
                         "textLength": 1

tests/cases/parser/declareStatement11.php.tree

@@ -37,6 +37,7 @@
                             }
                         }
                     },
+                    "otherDeclareDirectives": null,
                     "closeParen": {
                         "kind": "CloseParenToken",
                         "textLength": 1

tests/cases/parser/declareStatement12.php.tree

@@ -40,6 +40,7 @@
                             }
                         }
                     },
+                    "otherDeclareDirectives": null,
                     "closeParen": {
                         "kind": "CloseParenToken",
                         "textLength": 1

tests/cases/parser/declareStatement13.php.tree

@@ -37,6 +37,7 @@
                             }
                         }
                     },
+                    "otherDeclareDirectives": null,
                     "closeParen": {
                         "kind": "CloseParenToken",
                         "textLength": 1

tests/cases/parser/declareStatement14.php

@@ -0,0 +1,3 @@
+<?php
+
+declare(strict_types=1, ticks=1);

tests/cases/parser/declareStatement14.php.diag

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

tests/cases/parser/declareStatement14.php.tree

@@ -0,0 +1,85 @@
+{
+    "SourceFileNode": {
+        "statementList": [
+            {
+                "InlineHtml": {
+                    "scriptSectionEndTag": null,
+                    "text": null,
+                    "scriptSectionStartTag": {
+                        "kind": "ScriptSectionStartTag",
+                        "textLength": 6
+                    }
+                }
+            },
+            {
+                "DeclareStatement": {
+                    "declareKeyword": {
+                        "kind": "DeclareKeyword",
+                        "textLength": 7
+                    },
+                    "openParen": {
+                        "kind": "OpenParenToken",
+                        "textLength": 1
+                    },
+                    "declareDirective": {
+                        "DeclareDirective": {
+                            "name": {
+                                "kind": "Name",
+                                "textLength": 12
+                            },
+                            "equals": {
+                                "kind": "EqualsToken",
+                                "textLength": 1
+                            },
+                            "literal": {
+                                "kind": "IntegerLiteralToken",
+                                "textLength": 1
+                            }
+                        }
+                    },
+                    "otherDeclareDirectives": {
+                        "DeclareDirectiveList": {
+                            "children": [
+                                {
+                                    "kind": "CommaToken",
+                                    "textLength": 1
+                                },
+                                {
+                                    "DeclareDirective": {
+                                        "name": {
+                                            "kind": "Name",
+                                            "textLength": 5
+                                        },
+                                        "equals": {
+                                            "kind": "EqualsToken",
+                                            "textLength": 1
+                                        },
+                                        "literal": {
+                                            "kind": "IntegerLiteralToken",
+                                            "textLength": 1
+                                        }
+                                    }
+                                }
+                            ]
+                        }
+                    },
+                    "closeParen": {
+                        "kind": "CloseParenToken",
+                        "textLength": 1
+                    },
+                    "colon": null,
+                    "statements": null,
+                    "enddeclareKeyword": null,
+                    "semicolon": {
+                        "kind": "SemicolonToken",
+                        "textLength": 1
+                    }
+                }
+            }
+        ],
+        "endOfFileToken": {
+            "kind": "EndOfFileToken",
+            "textLength": 0
+        }
+    }
+}

tests/cases/parser/declareStatement15.php

@@ -0,0 +1,3 @@
+<?php
+
+declare(strict_types=1, ticks /** */);

tests/cases/parser/declareStatement15.php.diag

@@ -0,0 +1,14 @@
+[
+    {
+        "kind": 0,
+        "message": "'=' expected.",
+        "start": 36,
+        "length": 0
+    },
+    {
+        "kind": 0,
+        "message": "'FloatingLiteralToken' expected.",
+        "start": 36,
+        "length": 0
+    }
+]