Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Finding methods and properties for auto completion feature #10385

Merged
merged 11 commits into from
Nov 17, 2023
Merged

Finding methods and properties for auto completion feature #10385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
650b8fc
Tests of current behaviors in the auto-completion feature
issidorov Nov 17, 2023
6f19440
Fix text-labels with type of property
issidorov Nov 17, 2023
1cfc343
Ignore declared static properties with usage object gap
issidorov Nov 15, 2023
715f6f5
Ignore annotated magic properties with usage static gap
issidorov Nov 14, 2023
d533bb8
Ignore annotated magic static methods with usage object gap
issidorov Nov 15, 2023
75394c5
Find declared methods on parent classes and traits
issidorov Nov 14, 2023
ceba3d8
Find annotated magic static methods on parent class
issidorov Nov 14, 2023
0c4b8a3
Find annotated magic static methods on traits
issidorov Nov 14, 2023
8bb68e9
Find properties and methods annotated by mixin
issidorov Nov 16, 2023
e677523
Fixing a collisions on annotations with mixins
issidorov Nov 16, 2023
88c98ef
Fixing a crash if a method or property does not exist
issidorov Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
126 changes: 88 additions & 38 deletions src/Psalm/Codebase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
use Psalm\CodeLocation\Raw;
use Psalm\Exception\UnanalyzedFileException;
use Psalm\Exception\UnpopulatedClasslikeException;
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\Analyzer\FunctionLikeAnalyzer;
use Psalm\Internal\Analyzer\NamespaceAnalyzer;
use Psalm\Internal\Analyzer\ProjectAnalyzer;
Expand Down Expand Up @@ -69,7 +70,6 @@
use UnexpectedValueException;

use function array_combine;
use function array_merge;
use function array_pop;
use function array_reverse;
use function array_values;
Expand Down Expand Up @@ -1868,13 +1868,26 @@ public function getTypeContextAtPosition(string $file_path, Position $position):
}

/**
* @param list<int> $allow_visibilities
* @param list<string> $ignore_fq_class_names
* @return list<CompletionItem>
*/
public function getCompletionItemsForClassishThing(
string $type_string,
string $gap,
bool $snippets_supported = false
bool $snippets_supported = false,
array $allow_visibilities = null,
array $ignore_fq_class_names = []
): array {
if ($allow_visibilities === null) {
$allow_visibilities = [
ClassLikeAnalyzer::VISIBILITY_PUBLIC,
ClassLikeAnalyzer::VISIBILITY_PROTECTED,
ClassLikeAnalyzer::VISIBILITY_PRIVATE,
];
}
$allow_visibilities[] = null;

$completion_items = [];

$type = Type::parseString($type_string);
Expand All @@ -1884,12 +1897,25 @@ public function getCompletionItemsForClassishThing(
try {
$class_storage = $this->classlike_storage_provider->get($atomic_type->value);

$methods = array_merge(
$class_storage->methods,
$class_storage->pseudo_methods,
$class_storage->pseudo_static_methods,
);
foreach ($methods as $method_storage) {
$method_storages = [];
foreach ($class_storage->declaring_method_ids as $declaring_method_id) {
try {
$method_storages[] = $this->methods->getStorage($declaring_method_id);
} catch (UnexpectedValueException $e) {
error_log($e->getMessage());
}
}
if ($gap === '->') {
$method_storages += $class_storage->pseudo_methods;
}
if ($gap === '::') {
$method_storages += $class_storage->pseudo_static_methods;
}

foreach ($method_storages as $method_storage) {
if (!in_array($method_storage->visibility, $allow_visibilities)) {
continue;
}
if ($method_storage->is_static || $gap === '->') {
$completion_item = new CompletionItem(
$method_storage->cased_name,
Expand Down Expand Up @@ -1918,43 +1944,51 @@ public function getCompletionItemsForClassishThing(
}
}

$pseudo_property_types = [];
foreach ($class_storage->pseudo_property_get_types as $property_name => $type) {
$pseudo_property_types[$property_name] = new CompletionItem(
str_replace('$', '', $property_name),
CompletionItemKind::PROPERTY,
$type->__toString(),
null,
'1', //sort text
str_replace('$', '', $property_name),
($gap === '::' ? '$' : '') .
if ($gap === '->') {
$pseudo_property_types = [];
foreach ($class_storage->pseudo_property_get_types as $property_name => $type) {
$pseudo_property_types[$property_name] = new CompletionItem(
str_replace('$', '', $property_name),
);
}

foreach ($class_storage->pseudo_property_set_types as $property_name => $type) {
$pseudo_property_types[$property_name] = new CompletionItem(
str_replace('$', '', $property_name),
CompletionItemKind::PROPERTY,
$type->__toString(),
null,
'1',
str_replace('$', '', $property_name),
($gap === '::' ? '$' : '') .
CompletionItemKind::PROPERTY,
$type->__toString(),
null,
'1', //sort text
str_replace('$', '', $property_name),
);
str_replace('$', '', $property_name),
);
}

foreach ($class_storage->pseudo_property_set_types as $property_name => $type) {
$pseudo_property_types[$property_name] = new CompletionItem(
str_replace('$', '', $property_name),
CompletionItemKind::PROPERTY,
$type->__toString(),
null,
'1',
str_replace('$', '', $property_name),
str_replace('$', '', $property_name),
);
}

$completion_items = [...$completion_items, ...array_values($pseudo_property_types)];
}

$completion_items = [...$completion_items, ...array_values($pseudo_property_types)];

foreach ($class_storage->declaring_property_ids as $property_name => $declaring_class) {
$property_storage = $this->properties->getStorage(
$declaring_class . '::$' . $property_name,
);
try {
$property_storage = $this->properties->getStorage(
$declaring_class . '::$' . $property_name,
);
} catch (UnexpectedValueException $e) {
error_log($e->getMessage());
continue;
}

if ($property_storage->is_static || $gap === '->') {
if (!in_array($property_storage->visibility, $allow_visibilities)) {
continue;
}
if ($property_storage->is_static === ($gap === '::')) {
$completion_items[] = new CompletionItem(
'$' . $property_name,
$property_name,
CompletionItemKind::PROPERTY,
$property_storage->getInfo(),
$property_storage->description,
Expand All @@ -1976,6 +2010,22 @@ public function getCompletionItemsForClassishThing(
$const_name,
);
}

if ($gap === '->') {
foreach ($class_storage->namedMixins as $mixin) {
if (in_array($mixin->value, $ignore_fq_class_names)) {
continue;
}
$mixin_completion_items = $this->getCompletionItemsForClassishThing(
$mixin->value,
$gap,
$snippets_supported,
[ClassLikeAnalyzer::VISIBILITY_PUBLIC],
[$type_string, ...$ignore_fq_class_names],
);
$completion_items = [...$completion_items, ...$mixin_completion_items];
}
}
} catch (Exception $e) {
error_log($e->getMessage());
continue;
Expand Down
4 changes: 4 additions & 0 deletions src/Psalm/Internal/Codebase/Populator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -450,6 +450,8 @@ private function populateDataFromTrait(
$storage->pseudo_property_get_types += $trait_storage->pseudo_property_get_types;
$storage->pseudo_property_set_types += $trait_storage->pseudo_property_set_types;

$storage->pseudo_static_methods += $trait_storage->pseudo_static_methods;

$storage->pseudo_methods += $trait_storage->pseudo_methods;
$storage->declaring_pseudo_method_ids += $trait_storage->declaring_pseudo_method_ids;
}
Expand Down Expand Up @@ -560,6 +562,8 @@ private function populateDataFromParentClass(

$parent_storage->dependent_classlikes[strtolower($storage->name)] = true;

$storage->pseudo_static_methods += $parent_storage->pseudo_static_methods;

$storage->pseudo_methods += $parent_storage->pseudo_methods;
$storage->declaring_pseudo_method_ids += $parent_storage->declaring_pseudo_method_ids;
}
Expand Down