icedream
/
php-language-server
1
0
Fork 0
Code Releases Activity

Merge branch 'master' into feature/autocomplete-speedup

pull/451/head
Felix Becker 2017-11-18 17:00:17 -08:00 committed by GitHub
parent fcdf791c2c 80ef8ff503
commit 3bda390c3d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
27 changed files with 283 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.travis.yml
View File

@ -23,7 +23,7 @@ install:
- composer install --prefer-dist --no-interaction
script:
- vendor/bin/phpcs -n
- vendor/bin/phpunit --coverage-clover=coverage.xml
- vendor/bin/phpunit --coverage-clover=coverage.xml --colors=always
- bash <(curl -s https://codecov.io/bash)
jobs:

18
.vscode/launch.json vendored
View File

@ -1,6 +1,14 @@
{
"version": "0.2.0",
"configurations": [
{
"name": "PHPUnit",
"type": "php",
"request": "launch",
"program": "${workspaceRoot}/vendor/phpunit/phpunit/phpunit",
// "args": ["--filter", "testDefinitionForSelfKeyword"],
"cwd": "${workspaceRoot}"
},
{
"name": "Listen for XDebug",
"type": "php",
@ -14,16 +22,6 @@
"program": "${file}",
"cwd": "${fileDirname}",
"port": 9000
},
{
"name": "PHPUnit",
"type": "php",
"request": "launch",
"program": "${workspaceRoot}/vendor/phpunit/phpunit/phpunit",
"cwd": "${workspaceRoot}",
"args": [
// "--filter", "CompletionTest"
]
}
]
}

1
fixtures/completion/html_no_completion.php Normal file
View File

@ -0,0 +1 @@
<

23
src/CompletionProvider.php
View File

@ -10,7 +10,9 @@ use LanguageServer\Protocol\{
Position,
CompletionList,
CompletionItem,
CompletionItemKind
CompletionItemKind,
CompletionContext,
CompletionTriggerKind
};
use Microsoft\PhpParser;
use Microsoft\PhpParser\Node;
@ -122,9 +124,10 @@ class CompletionProvider
*
* @param PhpDocument $doc The opened document
* @param Position $pos The cursor position
* @param CompletionContext $context The completion context
* @return CompletionList
*/
public function provideCompletion(PhpDocument $doc, Position $pos): CompletionList
public function provideCompletion(PhpDocument $doc, Position $pos, CompletionContext $context = null): CompletionList
{
// This can be made much more performant if the tree follows specific invariants.
$node = $doc->getNodeAtPosition($pos);
@ -152,7 +155,21 @@ class CompletionProvider
// Inspect the type of expression under the cursor
if ($node === null || $node instanceof Node\Statement\InlineHtml || $pos == new Position(0, 0)) {
$content = $doc->getContent();
$offset = $pos->toOffset($content);
if (
$node === null
|| (
$node instanceof Node\Statement\InlineHtml
&& (
$context === null
// Make sure to not suggest on the > trigger character in HTML
|| $context->triggerKind === CompletionTriggerKind::INVOKED
|| $context->triggerCharacter === '<'
)
)
|| $pos == new Position(0, 0)
) {
// HTML, beginning of file
// Inside HTML and at the beginning of the file, propose <?php

28
src/DefinitionResolver.php
View File

@ -264,13 +264,38 @@ class DefinitionResolver
// Other references are references to a global symbol that have an FQN
// Find out the FQN
$fqn = $this->resolveReferenceNodeToFqn($node);
if ($fqn === null) {
if (!$fqn) {
return null;
}
if ($fqn === 'self' || $fqn === 'static') {
// Resolve self and static keywords to the containing class
// (This is not 100% correct for static but better than nothing)
$classNode = $node->getFirstAncestor(Node\Statement\ClassDeclaration::class);
if (!$classNode) {
return;
}
$fqn = (string)$classNode->getNamespacedName();
if (!$fqn) {
return;
}
} else if ($fqn === 'parent') {
// Resolve parent keyword to the base class FQN
$classNode = $node->getFirstAncestor(Node\Statement\ClassDeclaration::class);
if (!$classNode || !$classNode->classBaseClause || !$classNode->classBaseClause->baseClass) {
return;
}
$fqn = (string)$classNode->classBaseClause->baseClass->getResolvedName();
if (!$fqn) {
return;
}
}
// If the node is a function or constant, it could be namespaced, but PHP falls back to global
// http://php.net/manual/en/language.namespaces.fallback.php
// TODO - verify that this is not a method
$globalFallback = ParserHelpers\isConstantFetch($node) || $parent instanceof Node\Expression\CallExpression;
// Return the Definition object from the index index
return $this->index->getDefinition($fqn, $globalFallback);
}
@ -278,6 +303,7 @@ class DefinitionResolver
/**
* Given any node, returns the FQN of the symbol that is referenced
* Returns null if the FQN could not be resolved or the reference node references a variable
* May also return "static", "self" or "parent"
*
* @param Node $node
* @return string|null

30
src/Protocol/CompletionContext.php Normal file
View File

@ -0,0 +1,30 @@
<?php
namespace LanguageServer\Protocol;
/**
* Contains additional information about the context in which a completion request is triggered.
*/
class CompletionContext
{
/**
* How the completion was triggered.
*
* @var int
*/
public $triggerKind;
/**
* The trigger character (a single character) that has trigger code complete.
* Is null if `triggerKind !== CompletionTriggerKind::TRIGGER_CHARACTER`
*
* @var string|null
*/
public $triggerCharacter;
public function __construct(int $triggerKind, string $triggerCharacter = null)
{
$this->triggerKind = $triggerKind;
$this->triggerCharacter = $triggerCharacter;
}
}

16
src/Protocol/CompletionTriggerKind.php Normal file
View File

@ -0,0 +1,16 @@
<?php
namespace LanguageServer\Protocol;
class CompletionTriggerKind
{
/**
* Completion was triggered by invoking it manuall or using API.
*/
const INVOKED = 1;
/**
* Completion was triggered by a trigger character.
*/
const TRIGGER_CHARACTER = 2;
}

10
src/Server/TextDocument.php
View File

@ -20,7 +20,8 @@ use LanguageServer\Protocol\{
SymbolLocationInformation,
TextDocumentIdentifier,
TextDocumentItem,
VersionedTextDocumentIdentifier
VersionedTextDocumentIdentifier,
CompletionContext
};
use Microsoft\PhpParser;
use Microsoft\PhpParser\Node;
@ -334,13 +335,14 @@ class TextDocument
*
* @param TextDocumentIdentifier The text document
* @param Position $position The position
* @param CompletionContext|null $context The completion context
* @return Promise <CompletionItem[]|CompletionList>
*/
public function completion(TextDocumentIdentifier $textDocument, Position $position): Promise
public function completion(TextDocumentIdentifier $textDocument, Position $position, CompletionContext $context = null): Promise
{
return coroutine(function () use ($textDocument, $position) {
return coroutine(function () use ($textDocument, $position, $context) {
$document = yield $this->documentLoader->getOrLoad($textDocument->uri);
return $this->completionProvider->provideCompletion($document, $position);
return $this->completionProvider->provideCompletion($document, $position, $context);
});
}

38
src/TreeAnalyzer.php
View File

@ -140,8 +140,9 @@ class TreeAnalyzer
$this->definitionNodes[$fqn] = $node;
$this->definitions[$fqn] = $this->definitionResolver->createDefinitionFromNode($node, $fqn);
} else {
$parent = $node->parent;
if (!(
if (
(
// $node->parent instanceof Node\Expression\ScopedPropertyAccessExpression ||
($node instanceof Node\Expression\ScopedPropertyAccessExpression ||
@ -150,10 +151,39 @@ class TreeAnalyzer
$node->parent instanceof Node\Expression\CallExpression ||
$node->memberName instanceof PhpParser\Token
))
|| ($parent instanceof Node\Statement\NamespaceDefinition && $parent->name !== null && $parent->name->getStart() === $node->getStart()))
|| ($parent instanceof Node\Statement\NamespaceDefinition && $parent->name !== null && $parent->name->getStart() === $node->getStart())
) {
return;
}
$fqn = $this->definitionResolver->resolveReferenceNodeToFqn($node);
if ($fqn !== null) {
if (!$fqn) {
return;
}
if ($fqn === 'self' || $fqn === 'static') {
// Resolve self and static keywords to the containing class
// (This is not 100% correct for static but better than nothing)
$classNode = $node->getFirstAncestor(Node\Statement\ClassDeclaration::class);
if (!$classNode) {
return;
}
$fqn = (string)$classNode->getNamespacedName();
if (!$fqn) {
return;
}
} else if ($fqn === 'parent') {
// Resolve parent keyword to the base class FQN
$classNode = $node->getFirstAncestor(Node\Statement\ClassDeclaration::class);
if (!$classNode || !$classNode->classBaseClause || !$classNode->classBaseClause->baseClass) {
return;
}
$fqn = (string)$classNode->classBaseClause->baseClass->getResolvedName();
if (!$fqn) {
return;
}
}
$this->addReference($fqn, $node);
if (
@ -187,8 +217,6 @@ class TreeAnalyzer
}
}
}
}
}
/**
* @return Diagnostic[]

36
tests/Server/ServerTestCase.php
View File

@ -122,15 +122,16 @@ abstract class ServerTestCase extends TestCase
0 => new Location($referencesUri, new Range(new Position(29, 5), new Position(29, 15)))
],
'TestNamespace\\TestClass' => [
0 => new Location($symbolsUri , new Range(new Position(99, 25), new Position(99, 34))), // class ChildClass extends TestClass {}
1 => new Location($referencesUri, new Range(new Position( 4, 11), new Position( 4, 20))), // $obj = new TestClass();
2 => new Location($referencesUri, new Range(new Position( 7, 0), new Position( 7, 9))), // TestClass::staticTestMethod();
3 => new Location($referencesUri, new Range(new Position( 8, 5), new Position( 8, 14))), // echo TestClass::$staticTestProperty;
4 => new Location($referencesUri, new Range(new Position( 9, 5), new Position( 9, 14))), // TestClass::TEST_CLASS_CONST;
5 => new Location($referencesUri, new Range(new Position(21, 18), new Position(21, 27))), // function whatever(TestClass $param)
6 => new Location($referencesUri, new Range(new Position(21, 37), new Position(21, 46))), // function whatever(TestClass $param): TestClass
7 => new Location($referencesUri, new Range(new Position(39, 0), new Position(39, 9))), // TestClass::$staticTestProperty[123]->testProperty;
8 => new Location($useUri, new Range(new Position( 4, 4), new Position( 4, 27))), // use TestNamespace\TestClass;
0 => new Location($symbolsUri, new Range(new Position(48, 13), new Position(48, 17))), // echo self::TEST_CLASS_CONST;
1 => new Location($symbolsUri , new Range(new Position(99, 25), new Position(99, 34))), // class ChildClass extends TestClass {}
2 => new Location($referencesUri, new Range(new Position( 4, 11), new Position( 4, 20))), // $obj = new TestClass();
3 => new Location($referencesUri, new Range(new Position( 7, 0), new Position( 7, 9))), // TestClass::staticTestMethod();
4 => new Location($referencesUri, new Range(new Position( 8, 5), new Position( 8, 14))), // echo TestClass::$staticTestProperty;
5 => new Location($referencesUri, new Range(new Position( 9, 5), new Position( 9, 14))), // TestClass::TEST_CLASS_CONST;
6 => new Location($referencesUri, new Range(new Position(21, 18), new Position(21, 27))), // function whatever(TestClass $param)
7 => new Location($referencesUri, new Range(new Position(21, 37), new Position(21, 46))), // function whatever(TestClass $param): TestClass
8 => new Location($referencesUri, new Range(new Position(39, 0), new Position(39, 9))), // TestClass::$staticTestProperty[123]->testProperty;
9 => new Location($useUri, new Range(new Position( 4, 4), new Position( 4, 27))), // use TestNamespace\TestClass;
],
'TestNamespace\\TestChild' => [
0 => new Location($referencesUri, new Range(new Position(42, 5), new Position(42, 25))), // echo $child->testProperty;
@ -176,14 +177,15 @@ abstract class ServerTestCase extends TestCase
1 => new Location($globalReferencesUri, new Range(new Position(29, 5), new Position(29, 15)))
],
'TestClass' => [
0 => new Location($globalSymbolsUri, new Range(new Position(99, 25), new Position(99, 34))), // class ChildClass extends TestClass {}
1 => new Location($globalReferencesUri, new Range(new Position( 4, 11), new Position( 4, 20))), // $obj = new TestClass();
2 => new Location($globalReferencesUri, new Range(new Position( 7, 0), new Position( 7, 9))), // TestClass::staticTestMethod();
3 => new Location($globalReferencesUri, new Range(new Position( 8, 5), new Position( 8, 14))), // echo TestClass::$staticTestProperty;
4 => new Location($globalReferencesUri, new Range(new Position( 9, 5), new Position( 9, 14))), // TestClass::TEST_CLASS_CONST;
5 => new Location($globalReferencesUri, new Range(new Position(21, 18), new Position(21, 27))), // function whatever(TestClass $param)
6 => new Location($globalReferencesUri, new Range(new Position(21, 37), new Position(21, 46))), // function whatever(TestClass $param): TestClass
7 => new Location($globalReferencesUri, new Range(new Position(39, 0), new Position(39, 9))), // TestClass::$staticTestProperty[123]->testProperty;
0 => new Location($globalSymbolsUri, new Range(new Position(48, 13), new Position(48, 17))), // echo self::TEST_CLASS_CONST;
1 => new Location($globalSymbolsUri, new Range(new Position(99, 25), new Position(99, 34))), // class ChildClass extends TestClass {}
2 => new Location($globalReferencesUri, new Range(new Position( 4, 11), new Position( 4, 20))), // $obj = new TestClass();
3 => new Location($globalReferencesUri, new Range(new Position( 7, 0), new Position( 7, 9))), // TestClass::staticTestMethod();
4 => new Location($globalReferencesUri, new Range(new Position( 8, 5), new Position( 8, 14))), // echo TestClass::$staticTestProperty;
5 => new Location($globalReferencesUri, new Range(new Position( 9, 5), new Position( 9, 14))), // TestClass::TEST_CLASS_CONST;
6 => new Location($globalReferencesUri, new Range(new Position(21, 18), new Position(21, 27))), // function whatever(TestClass $param)
7 => new Location($globalReferencesUri, new Range(new Position(21, 37), new Position(21, 46))), // function whatever(TestClass $param): TestClass
8 => new Location($globalReferencesUri, new Range(new Position(39, 0), new Position(39, 9))), // TestClass::$staticTestProperty[123]->testProperty;
],
'TestChild' => [
0 => new Location($globalReferencesUri, new Range(new Position(42, 5), new Position(42, 25))), // echo $child->testProperty;

39
tests/Server/TextDocument/CompletionTest.php
View File

@ -17,7 +17,9 @@ use LanguageServer\Protocol\{
Position,
CompletionList,
CompletionItem,
CompletionItemKind
CompletionItemKind,
CompletionContext,
CompletionTriggerKind
};
use function LanguageServer\pathToUri;
@ -464,6 +466,41 @@ class CompletionTest extends TestCase
], true), $items);
}
public function testHtmlPrefixShouldNotTriggerCompletion()
{
$completionUri = pathToUri(__DIR__ . '/../../../fixtures/completion/html_no_completion.php');
$this->loader->open($completionUri, file_get_contents($completionUri));
$items = $this->textDocument->completion(
new TextDocumentIdentifier($completionUri),
new Position(0, 1),
new CompletionContext(CompletionTriggerKind::TRIGGER_CHARACTER, '>')
)->wait();
$this->assertEquals(new CompletionList([], true), $items);
}
public function testHtmlPrefixShouldTriggerCompletionIfManuallyInvoked()
{
$completionUri = pathToUri(__DIR__ . '/../../../fixtures/completion/html_no_completion.php');
$this->loader->open($completionUri, file_get_contents($completionUri));
$items = $this->textDocument->completion(
new TextDocumentIdentifier($completionUri),
new Position(0, 1),
new CompletionContext(CompletionTriggerKind::INVOKED)
)->wait();
$this->assertEquals(new CompletionList([
new CompletionItem(
'<?php',
CompletionItemKind::KEYWORD,
null,
null,
null,
null,
null,
new TextEdit(new Range(new Position(0, 1), new Position(0, 1)), '?php')
)
], true), $items);
}
public function testNamespace()
{
$completionUri = pathToUri(__DIR__ . '/../../../fixtures/completion/namespace.php');

24
tests/Server/TextDocument/Definition/GlobalTest.php
View File

@ -29,11 +29,23 @@ class GlobalTest extends ServerTestCase
$this->assertEquals([], $result);
}
public function testDefinitionForSelfKeyword()
{
// echo self::TEST_CLASS_CONST;
// Get definition for self
$reference = $this->getReferenceLocations('TestClass')[0];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start
)->wait();
$this->assertEquals($this->getDefinitionLocation('TestClass'), $result);
}
public function testDefinitionForClassLike()
{
// $obj = new TestClass();
// Get definition for TestClass
$reference = $this->getReferenceLocations('TestClass')[0];
$reference = $this->getReferenceLocations('TestClass')[1];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start
@ -45,7 +57,7 @@ class GlobalTest extends ServerTestCase
{
// TestClass::staticTestMethod();
// Get definition for TestClass
$reference = $this->getReferenceLocations('TestClass')[1];
$reference = $this->getReferenceLocations('TestClass')[2];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start
@ -57,7 +69,7 @@ class GlobalTest extends ServerTestCase
{
// echo TestClass::$staticTestProperty;
// Get definition for TestClass
$reference = $this->getReferenceLocations('TestClass')[2];
$reference = $this->getReferenceLocations('TestClass')[3];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start
@ -69,7 +81,7 @@ class GlobalTest extends ServerTestCase
{
// TestClass::TEST_CLASS_CONST;
// Get definition for TestClass
$reference = $this->getReferenceLocations('TestClass')[3];
$reference = $this->getReferenceLocations('TestClass')[4];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start
@ -213,7 +225,7 @@ class GlobalTest extends ServerTestCase
{
// function whatever(TestClass $param) {
// Get definition for TestClass
$reference = $this->getReferenceLocations('TestClass')[4];
$reference = $this->getReferenceLocations('TestClass')[5];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start
@ -225,7 +237,7 @@ class GlobalTest extends ServerTestCase
{
// function whatever(TestClass $param): TestClass {
// Get definition for TestClass
$reference = $this->getReferenceLocations('TestClass')[5];
$reference = $this->getReferenceLocations('TestClass')[6];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start

4
tests/Server/TextDocument/Definition/NamespacedTest.php
View File

@ -34,7 +34,7 @@ class NamespacedTest extends GlobalTest
{
// use TestNamespace\TestClass;
// Get definition for TestClass
$reference = $this->getReferenceLocations('TestClass')[6];
$reference = $this->getReferenceLocations('TestClass')[7];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start
@ -46,7 +46,7 @@ class NamespacedTest extends GlobalTest
{
// use TestNamespace\{TestTrait, TestInterface};
// Get definition for TestInterface
$reference = $this->getReferenceLocations('TestClass')[0];
$reference = $this->getReferenceLocations('TestClass')[1];
$result = $this->textDocument->definition(
new TextDocumentIdentifier($reference->uri),
$reference->range->start

2
tests/Server/TextDocument/HoverTest.php
View File

@ -15,7 +15,7 @@ class HoverTest extends ServerTestCase
{
// $obj = new TestClass();
// Get hover for TestClass
$reference = $this->getReferenceLocations('TestClass')[0];
$reference = $this->getReferenceLocations('TestClass')[1];
$result = $this->textDocument->hover(
new TextDocumentIdentifier($reference->uri),
$reference->range->start

2
tests/Server/TextDocument/References/GlobalTest.php
View File

@ -151,7 +151,7 @@ class GlobalTest extends ServerTestCase
{
// $obj = new TestClass();
// Get references for TestClass
$reference = $this->getReferenceLocations('TestClass')[0];
$reference = $this->getReferenceLocations('TestClass')[1];
$result = $this->textDocument->references(
new ReferenceContext,
new TextDocumentIdentifier($reference->uri),

5
tests/Validation/cases/WithReturnTypehints.php.expected.json
View File

@ -3,7 +3,7 @@
"Fixtures\\Prophecy\\EmptyClass": [
"./WithReturnTypehints.php"
],
"self": [
"Fixtures\\Prophecy\\WithReturnTypehints": [
"./WithReturnTypehints.php"
],
"Fixtures\\Prophecy\\__CLASS__": [
@ -11,9 +11,6 @@
],
"__CLASS__": [
"./WithReturnTypehints.php"
],
"parent": [
"./WithReturnTypehints.php"
]
},
"definitions": {

6
tests/Validation/cases/nameToken.php.expected.json
View File

@ -1,5 +1,9 @@
{
"references": [],
"references": {
"A": [
"./nameToken.php"
]
},
"definitions": {
"A": {
"fqn": "A",

3
tests/Validation/cases/parent1.php.expected.json
View File

@ -2,9 +2,6 @@
"references": {
"MyNamespace\\B": [
"./parent1.php"
],
"parent": [
"./parent1.php"
]
},
"definitions": {

3
tests/Validation/cases/parent3.php.expected.json
View File

@ -5,9 +5,6 @@
],
"MyNamespace\\B->b()": [
"./parent3.php"
],
"parent": [
"./parent3.php"
]
},
"definitions": {

2
tests/Validation/cases/self1.php.expected.json
View File

@ -6,7 +6,7 @@
"MyNamespace\\A::b()": [
"./self1.php"
],
"self": [
"MyNamespace\\A": [
"./self1.php"
]
},

2
tests/Validation/cases/self2.php.expected.json
View File

@ -6,7 +6,7 @@
"MyNamespace\\A::b()": [
"./self2.php"
],
"self": [
"MyNamespace\\A": [
"./self2.php"
]
},

2
tests/Validation/cases/self3.php.expected.json
View File

@ -6,7 +6,7 @@
"MyNamespace\\A->b()": [
"./self3.php"
],
"self": [
"MyNamespace\\A": [
"./self3.php"
]
},

2
tests/Validation/cases/self4.php.expected.json
View File

@ -1,6 +1,6 @@
{
"references": {
"self": [
"MyNamespace\\A": [
"./self4.php"
],
"MyNamespace\\A->addTestFile()": [

2
tests/Validation/cases/static1.php.expected.json
View File

@ -6,7 +6,7 @@
"MyNamespace\\A::b()": [
"./static1.php"
],
"static": [
"MyNamespace\\A": [
"./static1.php"
]
},

2
tests/Validation/cases/static2.php.expected.json
View File

@ -6,7 +6,7 @@
"MyNamespace\\A::b()": [
"./static2.php"
],
"static": [
"MyNamespace\\A": [
"./static2.php"
]
},

4
tests/Validation/cases/static3.php.expected.json
View File

@ -3,10 +3,10 @@
"MyNamespace\\B": [
"./static3.php"
],
"MyNamespace\\b()": [
"static->b()": [
"./static3.php"
],
"b()": [
"MyNamespace\\A": [
"./static3.php"
]
},

3
tests/Validation/cases/static4.php.expected.json
View File

@ -2,6 +2,9 @@
"references": {
"MyNamespace\\B": [
"./static4.php"
],
"MyNamespace\\A": [
"./static4.php"
]
},
"definitions": {