Rename 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.

Author: TysonAndre

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;
                 }
             }

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/Token.php

@@ -61,7 +61,7 @@ public function getStartPosition() {
     /**
      * @return int
      */
-    public function getFullStart() {
+    public function getFullStartPosition() {
         return $this->fullStart;
     }