v0.1.0: Raise minimum php version, change some AST representations

Raise the minimum php version from 7.0 to 7.2.
Depend on phpunit 8 for local development

Unify method names for Node and Token to getFullStartPosition and getStartPosition
(Consistently end public API methods with Position).
Avoid the need for callers to check if an object is a Node/Token before
calling a method.

Convert UnsetIntrinsicExpression to UnsetStatement - it can only be used
as a statement.

Unify previously split up lists into a single list in some AST node
properties (initially done that way for backward compatibility)

Clean up unnecessary special case for throw
- This continues to be parsed as an ExpressionStatement with the same
  precedence

Rename throwStatement to throwExpression in test file names.

Author: TysonAndre

.travis.yml

@@ -1,13 +1,10 @@
 language: php
 
 php:
-  - 7.0
-  - 7.1
-  - 7.2
-  - 7.3
-  - 7.4
-  # Should be changed to 8.0 once travis officially provides that label.
-  - nightly
+  - '7.2'
+  - '7.3'
+  - '7.4'
+  - '8.0'
 
 env:
   - VALIDATION=false
@@ -30,12 +27,7 @@ cache:
 
 before_script:
   - if [[ $STATIC_ANALYSIS = true ]]; then composer require phpstan/phpstan --no-update; fi
-  - |
-    if php -r 'exit(PHP_MAJOR_VERSION < 8 ? 0 : 1);';
-      then composer install
-    else
-      composer install --ignore-platform-reqs
-    fi
+  - composer install
   - set -e # Stop on first error.
   - phpenv config-rm xdebug.ini || true
   - if find . -name "*.php" -path "./src/*" -path "./experiments/*" -path "./tools/*" -path "./syntax-visualizer/server/src/*" -exec php -l {} 2>&1 \; | grep "syntax error, unexpected"; then exit 1; fi

composer.json

@@ -6,7 +6,7 @@
         "php": ">=7.2"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.5.20"
+        "phpunit/phpunit": "^8.5.15"
     },
     "license": "MIT",
     "authors": [

docs/ApiDocumentation.md

@@ -10,15 +10,15 @@
 ```php
 public function getNodeKindName ( ) : string
 ```
-### Node::getStart
+### Node::getStartPosition
 Gets start position of Node, not including leading comments and whitespace.
 ```php
-public function getStart ( ) : int
+public function getStartPosition ( ) : int
 ```
-### Node::getFullStart
+### Node::getFullStartPosition
 Gets start position of Node, including leading comments and whitespace
 ```php
-public function getFullStart ( ) : int
+public function getFullStartPosition ( ) : int
 ```
 ### Node::getParent
 Gets parent of current node (returns null if has no parent)
@@ -198,11 +198,11 @@ public function getFullText ( string & $document ) : string
 ```php
 public function getStartPosition ( )
 ```
-### Token::getFullStart
+### Token::getFullStartPosition
 > TODO: add doc comment
 
 ```php
-public function getFullStart ( )
+public function getFullStartPosition ( )
 ```
 ### Token::getWidth
 > TODO: add doc comment

src/FilePositionMap.php

@@ -34,46 +34,19 @@ public function __construct(string $file_contents) {
         $this->lineForCurrentOffset = 1;
     }
 
-    /**
-     * @param Node $node the node to get the start line for.
-     * TODO deprecate and merge this and getTokenStartLine into getStartLine
-     * if https://github.com/Microsoft/tolerant-php-parser/issues/166 is fixed,
-     * (i.e. if there is a consistent way to get the start offset)
-     */
-    public function getNodeStartLine(Node $node) : int {
-        return $this->getLineNumberForOffset($node->getStart());
-    }
-
-    /**
-     * @param Token $token the token to get the start line for.
-     */
-    public function getTokenStartLine(Token $token) : int {
-        return $this->getLineNumberForOffset($token->start);
-    }
-
     /**
      * @param Node|Token $node
      */
     public function getStartLine($node) : int {
-        if ($node instanceof Token) {
-            $offset = $node->start;
-        } else {
-            $offset = $node->getStart();
-        }
-        return $this->getLineNumberForOffset($offset);
+        return $this->getLineNumberForOffset($node->getStartPosition());
     }
 
     /**
      * @param Node|Token $node
      * Similar to getStartLine but includes the column
      */
     public function getStartLineCharacterPositionForOffset($node) : LineCharacterPosition {
-        if ($node instanceof Token) {
-            $offset = $node->start;
-        } else {
-            $offset = $node->getStart();
-        }
-        return $this->getLineCharacterPositionForOffset($offset);
+        return $this->getLineCharacterPositionForOffset($node->getStartPosition());
     }
 
     /** @param Node|Token $node */

src/Node.php

@@ -31,10 +31,10 @@ public function getNodeKindName() : string {
      * @return int
      * @throws \Exception
      */
-    public function getStart() : int {
+    public function getStartPosition() : int {
         $child = $this->getChildNodesAndTokens()->current();
         if ($child instanceof Node) {
-            return $child->getStart();
+            return $child->getStartPosition();
         } elseif ($child instanceof Token) {
             return $child->start;
         }
@@ -46,7 +46,7 @@ public function getStart() : int {
      * @return int
      * @throws \Exception
      */
-    public function getFullStart() : int {
+    public function getFullStartPosition() : int {
         foreach($this::CHILD_NAMES as $name) {
 
             if (($child = $this->$name) !== null) {
@@ -59,7 +59,7 @@ public function getFullStart() : int {
                 }
 
                 if ($child instanceof Node) {
-                    return $child->getFullStart();
+                    return $child->getFullStartPosition();
                 }
 
                 if ($child instanceof Token) {
@@ -330,7 +330,7 @@ public function getChildNames() {
      * @return int
      */
     public function getWidth() : int {
-        $first = $this->getStart();
+        $first = $this->getStartPosition();
         $last = $this->getEndPosition();
 
         return $last - $first;
@@ -342,7 +342,7 @@ public function getWidth() : int {
      * @return int
      */
     public function getFullWidth() : int {
-        $first = $this->getFullStart();
+        $first = $this->getFullStartPosition();
         $last = $this->getEndPosition();
 
         return $last - $first;
@@ -353,7 +353,7 @@ public function getFullWidth() : int {
      * @return string
      */
     public function getText() : string {
-        $start = $this->getStart();
+        $start = $this->getStartPosition();
         $end = $this->getEndPosition();
 
         $fileContents = $this->getFileContents();
@@ -365,7 +365,7 @@ public function getText() : string {
      * @return string
      */
     public function getFullText() : string {
-        $start = $this->getFullStart();
+        $start = $this->getFullStartPosition();
         $end = $this->getEndPosition();
 
         $fileContents = $this->getFileContents();
@@ -463,7 +463,7 @@ public function getDescendantNodeAtPosition(int $pos) {
      * @return bool
      */
     private function containsPosition(int $pos): bool {
-        return $this->getStart() <= $pos && $pos <= $this->getEndPosition();
+        return $this->getStartPosition() <= $pos && $pos <= $this->getEndPosition();
     }
 
     /**
@@ -476,7 +476,7 @@ private function containsPosition(int $pos): bool {
     public function getDocCommentText() {
         $leadingTriviaText = $this->getLeadingCommentAndWhitespaceText();
         $leadingTriviaTokens = PhpTokenizer::getTokensArrayFromContent(
-            $leadingTriviaText, ParseContext::SourceElements, $this->getFullStart(), false
+            $leadingTriviaText, ParseContext::SourceElements, $this->getFullStartPosition(), false
         );
         for ($i = \count($leadingTriviaTokens) - 1; $i >= 0; $i--) {
             $token = $leadingTriviaTokens[$i];
@@ -509,13 +509,13 @@ public function getImportTablesForCurrentScope() {
             $topLevelNamespaceStatements = $namespaceDefinition->compoundStatementOrSemicolon instanceof Token
                 ? $namespaceDefinition->parent->statementList // we need to start from the namespace definition.
                 : $namespaceDefinition->compoundStatementOrSemicolon->statements;
-            $namespaceFullStart = $namespaceDefinition->getFullStart();
+            $namespaceFullStart = $namespaceDefinition->getFullStartPosition();
         } else {
             $topLevelNamespaceStatements = $this->getRoot()->statementList;
             $namespaceFullStart = 0;
         }
 
-        $nodeFullStart = $this->getFullStart();
+        $nodeFullStart = $this->getFullStartPosition();
 
         // TODO optimize performance
         // Currently we rebuild the import tables on every call (and therefore every name resolution operation)
@@ -535,10 +535,10 @@ public function getImportTablesForCurrentScope() {
         $contents = $this->getFileContents();
 
         foreach ($topLevelNamespaceStatements as $useDeclaration) {
-            if ($useDeclaration->getFullStart() <= $namespaceFullStart) {
+            if ($useDeclaration->getFullStartPosition() <= $namespaceFullStart) {
                 continue;
             }
-            if ($useDeclaration->getFullStart() > $nodeFullStart) {
+            if ($useDeclaration->getFullStartPosition() > $nodeFullStart) {
                 break;
             } elseif (!($useDeclaration instanceof NamespaceUseDeclaration)) {
                 continue;
@@ -609,11 +609,11 @@ public function getNamespaceDefinition() {
             throw new \Exception("Invalid tree - SourceFileNode must always exist at root of tree.");
         }
 
-        $fullStart = $this->getFullStart();
+        $fullStart = $this->getFullStartPosition();
         $lastNamespaceDefinition = null;
         if ($namespaceDefinition instanceof SourceFileNode) {
             foreach ($namespaceDefinition->getChildNodes() as $childNode) {
-                if ($childNode instanceof NamespaceDefinition && $childNode->getFullStart() < $fullStart) {
+                if ($childNode instanceof NamespaceDefinition && $childNode->getFullStartPosition() < $fullStart) {
                     $lastNamespaceDefinition = $childNode;
                 }
             }
@@ -662,7 +662,7 @@ public function getPreviousSibling() {
      * Add the alias and resolved name to the corresponding namespace, function, or const import table.
      * If the alias already exists, it will get replaced by the most recent using.
      *
-     * TODO - worth throwing an error here in stead?
+     * TODO - worth throwing an error here instead?
      */
     private function addToImportTable($alias, $functionOrConst, $namespaceNameParts, $contents, & $namespaceImportTable, & $functionImportTable, & $constImportTable):array
     {

src/Node/MissingMemberDeclaration.php

@@ -20,17 +20,13 @@ class MissingMemberDeclaration extends Node implements ModifiedTypeInterface {
     /** @var Token|null needed along with typeDeclaration for what looked like typed property declarations but was missing VariableName */
     public $questionToken;
 
-    /** @var QualifiedName|Token|null */
-    public $typeDeclaration;
-
     /** @var DelimitedList\QualifiedNameList|null */
-    public $otherTypeDeclarations;
+    public $typeDeclarationList;
 
     const CHILD_NAMES = [
         'attributes',
         'modifiers',
         'questionToken',
-        'typeDeclaration',
-        'otherTypeDeclarations',
+        'typeDeclarationList',
     ];
 }

src/Node/QualifiedName.php

@@ -81,7 +81,7 @@ public function isUnqualifiedName() : bool {
      */
     public function getResolvedName($namespaceDefinition = null) {
         // Name resolution not applicable to constructs that define symbol names or aliases.
-        if (($this->parent instanceof Node\Statement\NamespaceDefinition && $this->parent->name->getStart() === $this->getStart()) ||
+        if (($this->parent instanceof Node\Statement\NamespaceDefinition && $this->parent->name->getStartPosition() === $this->getStartPosition()) ||
             $this->parent instanceof Node\Statement\NamespaceUseDeclaration ||
             $this->parent instanceof Node\NamespaceUseClause ||
             $this->parent instanceof Node\NamespaceUseGroupClause ||

src/Node/Statement/BreakOrContinueStatement.php

@@ -60,12 +60,7 @@ public function getDiagnosticForNode() {
             }
         }
 
-        if ($breakoutLevel instanceof Token) {
-            $start = $breakoutLevel->getStartPosition();
-        }
-        else {
-            $start = $breakoutLevel->getStart();
-        }
+        $start = $breakoutLevel->getStartPosition();
         $end = $breakoutLevel->getEndPosition();
 
         return new Diagnostic(

src/Node/Expression/UnsetIntrinsicExpression.php renamed to src/Node/Statement/UnsetStatement.php

@@ -4,13 +4,13 @@
  *  Licensed under the MIT License. See License.txt in the project root for license information.
  *--------------------------------------------------------------------------------------------*/
 
-namespace Microsoft\PhpParser\Node\Expression;
+namespace Microsoft\PhpParser\Node\Statement;
 
 use Microsoft\PhpParser\Node\DelimitedList;
 use Microsoft\PhpParser\Node\Expression;
 use Microsoft\PhpParser\Token;
 
-class UnsetIntrinsicExpression extends Expression {
+class UnsetStatement extends Expression {
 
     /** @var Token */
     public $unsetKeyword;
@@ -24,10 +24,14 @@ class UnsetIntrinsicExpression extends Expression {
     /** @var Token */
     public $closeParen;
 
+    /** @var Token */
+    public $semicolon;
+
     const CHILD_NAMES = [
         'unsetKeyword',
         'openParen',
         'expressions',
-        'closeParen'
+        'closeParen',
+        'semicolon',
     ];
 }