Global symbol search

README.md

@@ -26,3 +26,15 @@ to install dependencies.
 Run the tests with 
 
     vendor/bin/phpunit --bootstrap vendor/autoload.php tests
+
+## Command line arguments
+
+    --tcp host:port
+
+Causes the server to use a tcp connection for communicating with the language client instead of using STDIN/STDOUT.
+The server will try to connect to the specified address.
+
+Example:
+
+    php bin/php-language-server.php --tcp 127.0.0.1:12345
+

bin/php-language-server.php

@@ -1,5 +1,7 @@
 <?php
 
+ini_set('memory_limit', '-1');
+
 use LanguageServer\{LanguageServer, ProtocolStreamReader, ProtocolStreamWriter};
 use Sabre\Event\Loop;
 
@@ -10,6 +12,23 @@
     }
 }
 
-$server = new LanguageServer(new ProtocolStreamReader(STDIN), new ProtocolStreamWriter(STDOUT));
+if (count($argv) >= 3 && $argv[1] === '--tcp') {
+    $address = $argv[2];
+    $socket = stream_socket_client('tcp://' . $address, $errno, $errstr);
+    if ($socket === false) {
+        fwrite(STDERR, "Could not connect to language client. Error $errno\n");
+        fwrite(STDERR, "$errstr\n");
+        exit(1);
+    }
+    $inputStream = $outputStream = $socket;
+}
+else {
+    $inputStream = STDIN;
+    $outputStream = STDOUT;
+}
+
+stream_set_blocking($inputStream, false);
+
+$server = new LanguageServer(new ProtocolStreamReader($inputStream), new ProtocolStreamWriter($outputStream));
 
 Loop\run();

composer.json

@@ -26,15 +26,16 @@
         "php": ">=7.0",
         "nikic/php-parser": "^3.0.0beta1",
         "phpdocumentor/reflection-docblock": "^3.0",
-        "sabre/event": "^3.0",
+        "sabre/event": "^4.0",
         "felixfbecker/advanced-json-rpc": "^1.2"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "autoload": {
         "psr-4": {
             "LanguageServer\\": "src/"
-        }
+        },
+        "files" : ["src/utils.php"]
     },
     "autoload-dev": {
         "psr-4": {

fixtures/recursive/a.txt

@@ -0,0 +1 @@
+A

fixtures/recursive/search/b.txt

@@ -0,0 +1 @@
+B

fixtures/recursive/search/here/c.txt

@@ -0,0 +1 @@
+Peeakboo!

src/Client/Window.php

@@ -0,0 +1,60 @@
+<?php
+declare(strict_types = 1);
+
+namespace LanguageServer\Client;
+
+use AdvancedJsonRpc\Notification as NotificationBody;
+use PhpParser\{Error, Comment, Node, ParserFactory, NodeTraverser, Lexer};
+use PhpParser\NodeVisitor\NameResolver;
+use LanguageServer\ProtocolWriter;
+use LanguageServer\Protocol\{TextDocumentItem, TextDocumentIdentifier, VersionedTextDocumentIdentifier, Message};
+
+/**
+ * Provides method handlers for all window/* methods
+ */
+class Window
+{
+    /**
+     * @var ProtocolWriter
+     */
+    private $protocolWriter;
+
+    public function __construct(ProtocolWriter $protocolWriter)
+    {
+        $this->protocolWriter = $protocolWriter;
+    }
+
+    /**
+     * The show message notification is sent from a server to a client to ask the client to display a particular message in the user interface.
+     *
+     * @param int $type
+     * @param string $message
+     */
+    public function showMessage(int $type, string $message)
+    {
+        $this->protocolWriter->write(new Message(new NotificationBody(
+            'window/showMessage',
+            (object)[
+                'type' => $type,
+                'message' => $message
+            ]
+        )));
+    }
+
+    /**
+     * The log message notification is sent from the server to the client to ask the client to log a particular message.
+     *
+     * @param int $type
+     * @param string $message
+     */
+    public function logMessage(int $type, string $message)
+    {
+        $this->protocolWriter->write(new Message(new NotificationBody(
+            'window/logMessage',
+            (object)[
+                'type' => $type,
+                'message' => $message
+            ]
+        )));
+    }
+}

src/LanguageClient.php

@@ -4,6 +4,7 @@
 namespace LanguageServer;
 
 use LanguageServer\Client\TextDocument;
+use LanguageServer\Client\Window;
 
 class LanguageClient
 {
@@ -14,11 +15,19 @@ class LanguageClient
      */
     public $textDocument;
 
+    /**
+     * Handles window/* methods
+     *
+     * @var Client\Window
+     */
+    public $window;
+
     private $protocolWriter;
 
     public function __construct(ProtocolWriter $writer)
     {
         $this->protocolWriter = $writer;
         $this->textDocument = new TextDocument($writer);
+        $this->window = new Window($writer);
     }
 }

src/LanguageServer.php

@@ -3,9 +3,16 @@
 namespace LanguageServer;
 
 use LanguageServer\Server\TextDocument;
-use LanguageServer\Protocol\{ServerCapabilities, ClientCapabilities, TextDocumentSyncKind, Message};
-use LanguageServer\Protocol\InitializeResult;
+use LanguageServer\Protocol\{
+    ServerCapabilities,
+    ClientCapabilities,
+    TextDocumentSyncKind,
+    Message,
+    MessageType,
+    InitializeResult
+};
 use AdvancedJsonRpc\{Dispatcher, ResponseError, Response as ResponseBody, Request as RequestBody};
+use Sabre\Event\Loop;
 
 class LanguageServer extends \AdvancedJsonRpc\Dispatcher
 {
@@ -16,16 +23,24 @@ class LanguageServer extends \AdvancedJsonRpc\Dispatcher
      */
     public $textDocument;
 
+    /**
+     * Handles workspace/* method calls
+     *
+     * @var Server\Workspace
+     */
+    public $workspace;
+
     public $telemetry;
     public $window;
-    public $workspace;
     public $completionItem;
     public $codeLens;
 
     private $protocolReader;
     private $protocolWriter;
     private $client;
 
+    private $project;
+
     public function __construct(ProtocolReader $reader, ProtocolWriter $writer)
     {
         parent::__construct($this, '/');
@@ -56,24 +71,35 @@ public function __construct(ProtocolReader $reader, ProtocolWriter $writer)
         });
         $this->protocolWriter = $writer;
         $this->client = new LanguageClient($writer);
-        $this->textDocument = new Server\TextDocument($this->client);
+
+        $this->project = new Project($this->client);
+
+        $this->textDocument = new Server\TextDocument($this->project, $this->client);
+        $this->workspace = new Server\Workspace($this->project, $this->client);
     }
 
     /**
      * The initialize request is sent as the first request from the client to the server.
      *
-     * @param string $rootPath The rootPath of the workspace. Is null if no folder is open.
      * @param int $processId The process Id of the parent process that started the server.
      * @param ClientCapabilities $capabilities The capabilities provided by the client (editor)
+     * @param string|null $rootPath The rootPath of the workspace. Is null if no folder is open.
      * @return InitializeResult
      */
-    public function initialize(string $rootPath, int $processId, ClientCapabilities $capabilities): InitializeResult
+    public function initialize(int $processId, ClientCapabilities $capabilities, string $rootPath = null): InitializeResult
     {
+        // start building project index
+        if ($rootPath) {
+            $this->indexProject($rootPath);
+        }
+
         $serverCapabilities = new ServerCapabilities();
         // Ask the client to return always full documents (because we need to rebuild the AST from scratch)
         $serverCapabilities->textDocumentSync = TextDocumentSyncKind::FULL;
         // Support "Find all symbols"
         $serverCapabilities->documentSymbolProvider = true;
+        // Support "Find all symbols in workspace"
+        $serverCapabilities->workspaceSymbolProvider = true;
         // Support "Format Code"
         $serverCapabilities->documentFormattingProvider = true;
         return new InitializeResult($serverCapabilities);
@@ -100,4 +126,39 @@ public function exit()
     {
         exit(0);
     }
+
+    /**
+     * Parses workspace files, one at a time.
+     *
+     * @param string $rootPath The rootPath of the workspace.
+     * @return void
+     */
+    private function indexProject(string $rootPath)
+    {
+        $fileList = findFilesRecursive($rootPath, '/^.+\.php$/i');
+        $numTotalFiles = count($fileList);
+
+        $startTime = microtime(true);
+        $fileNum = 0;
+
+        $processFile = function() use (&$fileList, &$fileNum, &$processFile, $rootPath, $numTotalFiles, $startTime) {
+            if ($fileNum < $numTotalFiles) {
+                $file = $fileList[$fileNum];
+                $uri = pathToUri($file);
+                $fileNum++;
+                $shortName = substr($file, strlen($rootPath) + 1);
+                $this->client->window->logMessage(MessageType::INFO, "Parsing file $fileNum/$numTotalFiles: $shortName.");
+
+                $this->project->getDocument($uri)->updateContent(file_get_contents($file));
+
+                Loop\setTimeout($processFile, 0);
+            } else {
+                $duration = (int)(microtime(true) - $startTime);
+                $mem = (int)(memory_get_usage(true) / (1024 * 1024));
+                $this->client->window->logMessage(MessageType::INFO, "All PHP files parsed in $duration seconds. $mem MiB allocated.");
+            }
+        };
+
+        Loop\setTimeout($processFile, 0);
+    }
 }