1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-17 03:47:04 +01:00
psalm/src/Psalm/Internal/Analyzer/CanAlias.php

160 lines
5.4 KiB
PHP
Raw Normal View History

2017-01-07 20:35:07 +01:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer;
2017-01-07 20:35:07 +01:00
use PhpParser;
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
use Psalm\Aliases;
2017-03-11 01:36:17 +01:00
use Psalm\CodeLocation;
2019-06-06 04:13:33 +02:00
use Psalm\Internal\FileManipulation\FileManipulationBuffer;
use function implode;
use function strtolower;
2017-01-07 20:35:07 +01:00
trait CanAlias
{
/**
* @var array<lowercase-string, string>
2017-01-07 20:35:07 +01:00
*/
private $aliased_classes = [];
2017-01-07 20:35:07 +01:00
2017-03-11 01:36:17 +01:00
/**
* @var array<lowercase-string, CodeLocation>
2017-03-11 01:36:17 +01:00
*/
private $aliased_class_locations = [];
2017-01-07 20:35:07 +01:00
/**
* @var array<lowercase-string, string>
2017-01-07 20:35:07 +01:00
*/
private $aliased_classes_flipped = [];
2017-01-07 20:35:07 +01:00
2019-06-06 04:13:33 +02:00
/**
* @var array<lowercase-string, string>
2019-06-06 04:13:33 +02:00
*/
private $aliased_classes_flipped_replaceable = [];
2017-01-07 20:35:07 +01:00
/**
* @var array<lowercase-string, non-empty-string>
2017-01-07 20:35:07 +01:00
*/
private $aliased_functions = [];
2017-01-07 20:35:07 +01:00
/**
* @var array<string, string>
*/
private $aliased_constants = [];
2017-01-07 20:35:07 +01:00
public function visitUse(PhpParser\Node\Stmt\Use_ $stmt): void
2017-01-07 20:35:07 +01:00
{
2019-06-06 04:13:33 +02:00
$codebase = $this->getCodebase();
2017-01-07 20:35:07 +01:00
foreach ($stmt->uses as $use) {
$use_path = implode('\\', $use->name->parts);
$use_alias = $use->alias ? $use->alias->name : $use->name->getLast();
2017-01-07 20:35:07 +01:00
switch ($use->type !== PhpParser\Node\Stmt\Use_::TYPE_UNKNOWN ? $use->type : $stmt->type) {
case PhpParser\Node\Stmt\Use_::TYPE_FUNCTION:
$this->aliased_functions[strtolower($use_alias)] = $use_path;
2017-01-07 20:35:07 +01:00
break;
case PhpParser\Node\Stmt\Use_::TYPE_CONSTANT:
$this->aliased_constants[$use_alias] = $use_path;
2017-01-07 20:35:07 +01:00
break;
case PhpParser\Node\Stmt\Use_::TYPE_NORMAL:
$codebase->analyzer->addOffsetReference(
$this->getFilePath(),
(int) $use->getAttribute('startFilePos'),
(int) $use->getAttribute('endFilePos'),
$use_path
);
2019-06-06 04:13:33 +02:00
if ($codebase->collect_locations) {
2017-02-28 00:24:20 +01:00
// register the path
$codebase->use_referencing_locations[strtolower($use_path)][] =
2017-02-28 00:24:20 +01:00
new \Psalm\CodeLocation($this, $use);
2017-03-11 01:36:17 +01:00
$codebase->use_referencing_files[$this->getFilePath()][strtolower($use_path)] = true;
2017-02-28 00:24:20 +01:00
}
2019-06-06 04:13:33 +02:00
if ($codebase->alter_code) {
if (isset($codebase->class_transforms[strtolower($use_path)])) {
$new_fq_class_name = $codebase->class_transforms[strtolower($use_path)];
$file_manipulations = [];
$file_manipulations[] = new \Psalm\FileManipulation(
(int) $use->getAttribute('startFilePos'),
(int) $use->getAttribute('endFilePos') + 1,
2019-06-07 00:46:40 +02:00
$new_fq_class_name . ($use->alias ? ' as ' . $use_alias : '')
2019-06-06 04:13:33 +02:00
);
FileManipulationBuffer::add($this->getFilePath(), $file_manipulations);
}
$this->aliased_classes_flipped_replaceable[strtolower($use_path)] = $use_alias;
}
$this->aliased_classes[strtolower($use_alias)] = $use_path;
$this->aliased_class_locations[strtolower($use_alias)] = new CodeLocation($this, $stmt);
$this->aliased_classes_flipped[strtolower($use_path)] = $use_alias;
2017-01-07 20:35:07 +01:00
break;
}
}
}
public function visitGroupUse(PhpParser\Node\Stmt\GroupUse $stmt): void
2017-01-07 20:35:07 +01:00
{
$use_prefix = implode('\\', $stmt->prefix->parts);
2019-06-06 04:13:33 +02:00
$codebase = $this->getCodebase();
2017-01-07 20:35:07 +01:00
foreach ($stmt->uses as $use) {
$use_path = $use_prefix . '\\' . implode('\\', $use->name->parts);
$use_alias = $use->alias ? $use->alias->name : $use->name->getLast();
2017-01-07 20:35:07 +01:00
switch ($use->type !== PhpParser\Node\Stmt\Use_::TYPE_UNKNOWN ? $use->type : $stmt->type) {
case PhpParser\Node\Stmt\Use_::TYPE_FUNCTION:
$this->aliased_functions[strtolower($use_alias)] = $use_path;
2017-01-07 20:35:07 +01:00
break;
case PhpParser\Node\Stmt\Use_::TYPE_CONSTANT:
$this->aliased_constants[$use_alias] = $use_path;
2017-01-07 20:35:07 +01:00
break;
case PhpParser\Node\Stmt\Use_::TYPE_NORMAL:
2019-06-06 04:13:33 +02:00
if ($codebase->collect_locations) {
2017-02-28 00:24:20 +01:00
// register the path
$codebase->use_referencing_locations[strtolower($use_path)][] =
2017-02-28 00:24:20 +01:00
new \Psalm\CodeLocation($this, $use);
}
$this->aliased_classes[strtolower($use_alias)] = $use_path;
$this->aliased_classes_flipped[strtolower($use_path)] = $use_alias;
2017-01-07 20:35:07 +01:00
break;
}
}
}
/**
* @return array<lowercase-string, string>
2017-01-07 20:35:07 +01:00
*/
public function getAliasedClassesFlipped(): array
2017-01-07 20:35:07 +01:00
{
return $this->aliased_classes_flipped;
}
2019-06-06 04:13:33 +02:00
/**
* @return array<string, string>
*/
public function getAliasedClassesFlippedReplaceable(): array
2019-06-06 04:13:33 +02:00
{
return $this->aliased_classes_flipped_replaceable;
}
public function getAliases(): Aliases
2017-01-07 20:35:07 +01:00
{
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
return new Aliases(
$this->getNamespace(),
$this->aliased_classes,
$this->aliased_functions,
$this->aliased_constants
);
2017-01-07 20:35:07 +01:00
}
}