Support constants with define() (#347)

fixtures/completion/constant_with_namespace.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace HELLO {
+
+    /**
+     * Does something really cool!
+     */
+    function world() {
+
+    }
+
+    \HE
+}
+
+namespace {
+
+    /**
+     * Lorem ipsum dolor sit amet.
+     */
+    define('HELLO', true);
+
+    HELLO\world();
+}

fixtures/global_symbols.php

@@ -98,3 +98,10 @@ new class {
 };
 
 class ChildClass extends TestClass {}
+
+/**
+ * Lorem ipsum dolor sit amet, consectetur.
+ */
+define('TEST_DEFINE_CONSTANT', false);
+
+print TEST_DEFINE_CONSTANT ? 'true' : 'false';

src/DefinitionResolver.php

@@ -882,6 +882,11 @@ class DefinitionResolver
                 }
                 return (string)$class->namespacedName . '::' . $node->name;
             }
+        } else if ($node instanceof Node\Expr\FuncCall && $node->name instanceof Node\Name && strtolower((string)$node->name) === 'define') {
+            if (!isset($node->args[0]) || !($node->args[0]->value instanceof Node\Scalar\String_)) {
+                return null;
+            }
+            return (string)$node->args[0]->value->value;
         }
     }
 }

src/Index/Index.php

@@ -117,7 +117,7 @@ class Index implements ReadableIndex, \Serializable
      * Registers a definition
      *
      * @param string $fqn The fully qualified name of the symbol
-     * @param string $definition The Definition object
+     * @param Definition $definition The Definition object
      * @return void
      */
     public function setDefinition(string $fqn, Definition $definition)

src/Protocol/SymbolInformation.php

@@ -50,9 +50,19 @@ class SymbolInformation
     {
         $parent = $node->getAttribute('parentNode');
         $symbol = new self;
-        if ($node instanceof Node\Stmt\Class_) {
+
-            $symbol->kind = SymbolKind::CLASS_;
+        if (
-        } else if ($node instanceof Node\Stmt\Trait_) {
+            $node instanceof Node\Expr\FuncCall
+            && $node->name instanceof Node\Name
+            && strtolower((string)$node->name) === 'define'
+            && isset($node->args[0])
+            && $node->args[0]->value instanceof Node\Scalar\String_
+        ) {
+            // constants with define() like
+            // define('TEST_DEFINE_CONSTANT', false);
+            $symbol->kind = SymbolKind::CONSTANT;
+            $symbol->name = (string)$node->args[0]->value->value;
+        } else if ($node instanceof Node\Stmt\Class_ || $node instanceof Node\Stmt\Trait_) {
             $symbol->kind = SymbolKind::CLASS_;
         } else if ($node instanceof Node\Stmt\Interface_) {
             $symbol->kind = SymbolKind::INTERFACE;
@@ -80,6 +90,8 @@ class SymbolInformation
         } else {
             return null;
         }
+        
+        if (!isset($symbol->name)) {
             if ($node instanceof Node\Name) {
                 $symbol->name = (string)$node;
             } else if ($node instanceof Node\Expr\Assign || $node instanceof Node\Expr\AssignOp) {
@@ -91,6 +103,8 @@ class SymbolInformation
             } else {
                 return null;
             }
+        }
+
         $symbol->location = Location::fromNode($node);
         if ($fqn !== null) {
             $parts = preg_split('/(::|->|\\\\)/', $fqn);

tests/LanguageServerTest.php

@@ -57,7 +57,7 @@ class LanguageServerTest extends TestCase
             if ($msg->body->method === 'window/logMessage' && $promise->state === Promise::PENDING) {
                 if ($msg->body->params->type === MessageType::ERROR) {
                     $promise->reject(new Exception($msg->body->params->message));
-                } else if (strpos($msg->body->params->message, 'All 26 PHP files parsed') !== false) {
+                } else if (strpos($msg->body->params->message, 'All 27 PHP files parsed') !== false) {
                     $promise->fulfill();
                 }
             }
@@ -103,7 +103,7 @@ class LanguageServerTest extends TestCase
                     if ($promise->state === Promise::PENDING) {
                         $promise->reject(new Exception($msg->body->params->message));
                     }
-                } else if (strpos($msg->body->params->message, 'All 26 PHP files parsed') !== false) {
+                } else if (strpos($msg->body->params->message, 'All 27 PHP files parsed') !== false) {
                     $promise->fulfill();
                 }
             }

tests/Server/ServerTestCase.php

@@ -72,6 +72,7 @@ abstract class ServerTestCase extends TestCase
         $this->definitionLocations = [
 
             // Global
+            'TEST_DEFINE_CONSTANT'                   => new Location($globalSymbolsUri,    new Range(new Position(104, 0), new Position(104, 37))),
             'TEST_CONST'                             => new Location($globalSymbolsUri,    new Range(new Position( 9,  6), new Position( 9,  22))),
             'TestClass'                              => new Location($globalSymbolsUri,    new Range(new Position(20,  0), new Position(61,   1))),
             'ChildClass'                             => new Location($globalSymbolsUri,    new Range(new Position(99,  0), new Position(99,  37))),
@@ -163,6 +164,9 @@ abstract class ServerTestCase extends TestCase
             ],
 
             // Global
+            'TEST_DEFINE_CONSTANT' => [
+                0 => new Location($globalSymbolsUri,    new Range(new Position(106, 6), new Position(106, 26)))
+            ],
             'TEST_CONST' => [
                 0 => new Location($referencesUri,       new Range(new Position(29,  5), new Position(29, 15))),
                 1 => new Location($globalReferencesUri, new Range(new Position(29,  5), new Position(29, 15)))

tests/Server/TextDocument/HoverTest.php

@@ -156,6 +156,21 @@ class HoverTest extends ServerTestCase
         ], $reference->range), $result);
     }
 
+    public function testHoverForGlobalConstant()
+    {
+        // print TEST_DEFINE_CONSTANT ? 'true' : 'false';
+        // Get hover for TEST_DEFINE_CONSTANT
+        $reference = $this->getReferenceLocations('TEST_DEFINE_CONSTANT')[0];
+        $result = $this->textDocument->hover(
+            new TextDocumentIdentifier($reference->uri),
+            $reference->range->end
+        )->wait();
+        $this->assertEquals(new Hover([
+            new MarkedString('php', "<?php\n\\define('TEST_DEFINE_CONSTANT', \\false);"),
+            'Lorem ipsum dolor sit amet, consectetur.'
+        ], $reference->range), $result);
+    }
+
     public function testHoverForVariable()
     {
         // echo $var;

tests/Server/Workspace/SymbolTest.php

@@ -58,6 +58,7 @@ class SymbolTest extends ServerTestCase
             new SymbolInformation('TestInterface',          SymbolKind::INTERFACE,   $this->getDefinitionLocation('TestInterface'),                                ''),
             new SymbolInformation('test_function',          SymbolKind::FUNCTION,    $this->getDefinitionLocation('test_function()'),                              ''),
             new SymbolInformation('ChildClass',             SymbolKind::CLASS_,      $this->getDefinitionLocation('ChildClass'),                                   ''),
+            new SymbolInformation('TEST_DEFINE_CONSTANT',   SymbolKind::CONSTANT,    $this->getDefinitionLocation('TEST_DEFINE_CONSTANT'),                         ''),
             new SymbolInformation('whatever',               SymbolKind::FUNCTION,    $this->getDefinitionLocation('whatever()'),                                   ''),
 
             new SymbolInformation('SecondTestNamespace',    SymbolKind::NAMESPACE,   $this->getDefinitionLocation('SecondTestNamespace'),                          '')