From 2280e7889b9638ffb584f248d632eed2bf51a371 Mon Sep 17 00:00:00 2001
From: Sara Itani <sitani@microsoft.com>
Date: Sat, 4 Mar 2017 17:44:04 -0800
Subject: [PATCH] extract to tree analyzer interface

---
 src/PhpDocument.php  |  78 +++++++++------------------
 src/TreeAnalyzer.php | 125 +++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 149 insertions(+), 54 deletions(-)
 create mode 100644 src/TreeAnalyzer.php

diff --git a/src/PhpDocument.php b/src/PhpDocument.php
index 25f210d..f382b3d 100644
--- a/src/PhpDocument.php
+++ b/src/PhpDocument.php
@@ -96,11 +96,19 @@ class PhpDocument
      */
     private $diagnostics;
 
+    /**
+     * Microsoft\PhpParser\Parser instance
+     *
+     * @var Tolerant\Parser
+     */
+    private $tolerantParser;
+
     /**
      * @param string $uri The URI of the document
      * @param string $content The content of the document
      * @param Index $index The Index to register definitions and references to
      * @param Parser $parser The PHPParser instance
+     * @param Parser $tolerantParser The tolerant PHP Parser instance
      * @param DocBlockFactory $docBlockFactory The DocBlockFactory instance to parse docblocks
      * @param DefinitionResolverInterface $definitionResolver The DefinitionResolver to resolve definitions to symbols in the workspace
      */
@@ -163,64 +171,26 @@ class PhpDocument
         $this->definitions = null;
         $this->definitionNodes = null;
 
-        $errorHandler = new ErrorHandler\Collecting;
-        $stmts = $this->parser->parse($content, $errorHandler);
+        $treeAnalyzer = new TreeAnalyzer($this->parser, $content, $this->docBlockFactory, $this->definitionResolver, $this->uri);
 
-        $this->diagnostics = [];
-        foreach ($errorHandler->getErrors() as $error) {
-            $this->diagnostics[] = Diagnostic::fromError($error, $this->content, DiagnosticSeverity::ERROR, 'php');
+        $this->diagnostics = $treeAnalyzer->getDiagnostics();
+
+        $this->definitions = $treeAnalyzer->getDefinitions();
+
+        $this->definitionNodes = $treeAnalyzer->getDefinitionNodes();
+
+        $this->referenceNodes = $treeAnalyzer->getReferenceNodes();
+        
+        foreach ($this->definitions as $fqn => $definition) {
+            $this->index->setDefinition($fqn, $definition);
         }
 
-        // $stmts can be null in case of a fatal parsing error <- Interesting. When do fatal parsing errors occur?
-        if ($stmts) {
-            $traverser = new NodeTraverser;
-
-            // Resolve aliased names to FQNs
-            $traverser->addVisitor(new NameResolver($errorHandler));
-
-            // Add parentNode, previousSibling, nextSibling attributes
-            $traverser->addVisitor(new ReferencesAdder($this));
-
-            // Add column attributes to nodes
-            $traverser->addVisitor(new ColumnCalculator($content));
-
-            // Parse docblocks and add docBlock attributes to nodes
-            $docBlockParser = new DocBlockParser($this->docBlockFactory);
-            $traverser->addVisitor($docBlockParser);
-
-            $traverser->traverse($stmts);
-
-            // Report errors from parsing docblocks
-            foreach ($docBlockParser->errors as $error) {
-                $this->diagnostics[] = Diagnostic::fromError($error, $this->content, DiagnosticSeverity::WARNING, 'php');
-            }
-
-            $traverser = new NodeTraverser;
-
-            // Collect all definitions
-            $definitionCollector = new DefinitionCollector($this->definitionResolver);
-            $traverser->addVisitor($definitionCollector);
-
-            // Collect all references
-            $referencesCollector = new ReferencesCollector($this->definitionResolver);
-            $traverser->addVisitor($referencesCollector);
-
-            $traverser->traverse($stmts);
-
-            // Register this document on the project for all the symbols defined in it
-            $this->definitions = $definitionCollector->definitions;
-            $this->definitionNodes = $definitionCollector->nodes;
-            foreach ($definitionCollector->definitions as $fqn => $definition) {
-                $this->index->setDefinition($fqn, $definition);
-            }
-            // Register this document on the project for references
-            $this->referenceNodes = $referencesCollector->nodes;
-            foreach ($referencesCollector->nodes as $fqn => $nodes) {
-                $this->index->addReferenceUri($fqn, $this->uri);
-            }
-
-            $this->stmts = $stmts;
+        // Register this document on the project for references
+        foreach ($this->referenceNodes as $fqn => $nodes) {
+            $this->index->addReferenceUri($fqn, $this->uri);
         }
+        
+        $this->stmts = $treeAnalyzer->getStmts();
     }
 
     /**
diff --git a/src/TreeAnalyzer.php b/src/TreeAnalyzer.php
new file mode 100644
index 0000000..def47c6
--- /dev/null
+++ b/src/TreeAnalyzer.php
@@ -0,0 +1,125 @@
+<?php
+declare(strict_types = 1);
+
+namespace LanguageServer;
+
+use LanguageServer\Protocol\{Diagnostic, DiagnosticSeverity, Range, Position, TextEdit};
+use LanguageServer\NodeVisitor\{
+    NodeAtPositionFinder,
+    ReferencesAdder,
+    DocBlockParser,
+    DefinitionCollector,
+    ColumnCalculator,
+    ReferencesCollector
+};
+use LanguageServer\Index\Index;
+use PhpParser\{Error, ErrorHandler, Node, NodeTraverser, Parser};
+use PhpParser\NodeVisitor\NameResolver;
+use phpDocumentor\Reflection\DocBlockFactory;
+use Sabre\Uri;
+use Microsoft\PhpParser as Tolerant;
+
+class TreeAnalyzer {
+    private $parser;
+
+    private $stmts;
+
+    private $errorHandler;
+
+    private $diagnostics;
+
+    public function __construct(Parser $parser, $content, $docBlockFactory, $definitionResolver, $uri) {
+        $this->uri = $uri;
+        $this->parser = $parser;
+        $this->docBlockFactory = $docBlockFactory;
+        $this->definitionResolver = $definitionResolver;
+        $this->content = $content;
+        $errorHandler = new ErrorHandler\Collecting;
+        $stmts = $this->parser->parse($content, $errorHandler);
+
+        $this->diagnostics = [];
+        foreach ($errorHandler->getErrors() as $error) {
+            $this->diagnostics[] = Diagnostic::fromError($error, $this->content, DiagnosticSeverity::ERROR, 'php');
+        }
+
+        // $stmts can be null in case of a fatal parsing error <- Interesting. When do fatal parsing errors occur?
+        if ($stmts) {
+            $traverser = new NodeTraverser;
+
+            // Resolve aliased names to FQNs
+            $traverser->addVisitor(new NameResolver($errorHandler));
+
+            // Add parentNode, previousSibling, nextSibling attributes
+            $traverser->addVisitor(new ReferencesAdder($this));
+
+            // Add column attributes to nodes
+            $traverser->addVisitor(new ColumnCalculator($content));
+
+            // Parse docblocks and add docBlock attributes to nodes
+            $docBlockParser = new DocBlockParser($this->docBlockFactory);
+            $traverser->addVisitor($docBlockParser);
+
+            $traverser->traverse($stmts);
+
+            // Report errors from parsing docblocks
+            foreach ($docBlockParser->errors as $error) {
+                $this->diagnostics[] = Diagnostic::fromError($error, $this->content, DiagnosticSeverity::WARNING, 'php');
+            }
+
+            $traverser = new NodeTraverser;
+
+            // Collect all definitions
+            $definitionCollector = new DefinitionCollector($this->definitionResolver);
+            $traverser->addVisitor($definitionCollector);
+
+            // Collect all references
+            $referencesCollector = new ReferencesCollector($this->definitionResolver);
+            $traverser->addVisitor($referencesCollector);
+
+            $traverser->traverse($stmts);
+
+            // Register this document on the project for all the symbols defined in it
+            $this->definitions = $definitionCollector->definitions;
+            $this->definitionNodes = $definitionCollector->nodes;
+            foreach ($definitionCollector->definitions as $fqn => $definition) {
+                // $this->index->setDefinition($fqn, $definition);
+            }
+            // Register this document on the project for references
+            $this->referenceNodes = $referencesCollector->nodes;
+            foreach ($referencesCollector->nodes as $fqn => $nodes) {
+                // $this->index->addReferenceUri($fqn, $this->uri);
+            }
+
+            $this->stmts = $stmts;
+        }
+    }
+
+    public function getDiagnostics() {
+        return $this->diagnostics;
+    }
+
+    public function getDefinitions() {
+        return $this->definitions ?? [];
+    }
+
+    public function getDefinitionNodes() {
+        return $this->definitionNodes ?? [];
+    }
+
+    public function getReferenceNodes() {
+        return $this->referenceNodes ?? [];
+    }
+
+    public function getStmts() {
+        return $this->stmts;
+    }
+    /**
+     * Returns the URI of the document
+     *
+     * @return string
+     */
+    public function getUri(): string
+    {
+        return $this->uri;
+    }
+}