1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-16 11:26:55 +01:00
psalm/src/Psalm/Checker/Statements/Block/LoopChecker.php

577 lines
23 KiB
PHP
Raw Normal View History

2017-11-30 07:07:20 +01:00
<?php
namespace Psalm\Checker\Statements\Block;
use PhpParser;
use Psalm\Checker\ScopeChecker;
use Psalm\Checker\Statements\ExpressionChecker;
use Psalm\Checker\StatementsChecker;
use Psalm\Clause;
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\IssueBuffer;
2017-12-03 00:28:18 +01:00
use Psalm\Scope\LoopScope;
2017-11-30 07:07:20 +01:00
use Psalm\Type;
2018-05-07 07:26:06 +02:00
use Psalm\Type\Algebra;
use Psalm\Type\Reconciler;
2017-11-30 07:07:20 +01:00
class LoopChecker
{
/**
* Checks an array of statements in a loop
*
* @param array<PhpParser\Node\Stmt> $stmts
* @param PhpParser\Node\Expr[] $pre_conditions
* @param PhpParser\Node\Expr[] $post_expressions
* @param Context loop_scope->loop_context
* @param Context $loop_scope->loop_parent_context
* @param bool $is_do
2017-11-30 07:07:20 +01:00
*
* @return false|null
*/
public static function analyze(
StatementsChecker $statements_checker,
array $stmts,
array $pre_conditions,
2018-01-29 23:18:03 +01:00
array $post_expressions,
LoopScope $loop_scope,
Context &$inner_context = null,
$is_do = false
2017-11-30 07:07:20 +01:00
) {
$traverser = new PhpParser\NodeTraverser;
2017-12-03 00:28:18 +01:00
$assignment_mapper = new \Psalm\Visitor\AssignmentMapVisitor($loop_scope->loop_context->self);
2017-11-30 07:07:20 +01:00
$traverser->addVisitor($assignment_mapper);
2018-01-29 23:18:03 +01:00
$traverser->traverse(array_merge($stmts, $post_expressions));
2017-11-30 07:07:20 +01:00
$assignment_map = $assignment_mapper->getAssignmentMap();
$assignment_depth = 0;
$asserted_var_ids = [];
2017-11-30 07:07:20 +01:00
$pre_condition_clauses = [];
$original_protected_var_ids = $loop_scope->loop_parent_context->protected_var_ids;
2017-11-30 07:07:20 +01:00
if ($pre_conditions) {
foreach ($pre_conditions as $pre_condition) {
$pre_condition_clauses = array_merge(
$pre_condition_clauses,
2018-05-07 07:26:06 +02:00
Algebra::getFormula(
2017-11-30 07:07:20 +01:00
$pre_condition,
2017-12-03 00:28:18 +01:00
$loop_scope->loop_context->self,
2017-11-30 07:07:20 +01:00
$statements_checker
)
);
}
} else {
$asserted_var_ids = Context::getNewOrUpdatedVarIds(
2017-12-03 00:28:18 +01:00
$loop_scope->loop_parent_context,
$loop_scope->loop_context
);
2017-11-30 07:07:20 +01:00
}
2017-12-03 00:28:18 +01:00
$final_actions = ScopeChecker::getFinalControlActions($stmts);
$has_break_statement = $final_actions === [ScopeChecker::ACTION_BREAK];
2017-11-30 07:07:20 +01:00
if ($assignment_map) {
$first_var_id = array_keys($assignment_map)[0];
$assignment_depth = self::getAssignmentMapDepth($first_var_id, $assignment_map);
}
2017-12-03 00:28:18 +01:00
$loop_scope->loop_context->parent_context = $loop_scope->loop_parent_context;
if ($assignment_depth === 0 || $has_break_statement) {
$inner_context = clone $loop_scope->loop_context;
$inner_context->loop_scope = $loop_scope;
2017-12-03 00:28:18 +01:00
$inner_context->parent_context = $loop_scope->loop_context;
2018-06-17 02:01:33 +02:00
$old_referenced_var_ids = $inner_context->referenced_var_ids;
$inner_context->referenced_var_ids = [];
2017-11-30 07:07:20 +01:00
if (!$is_do) {
foreach ($pre_conditions as $pre_condition) {
self::applyPreConditionToLoopContext(
$statements_checker,
$pre_condition,
$pre_condition_clauses,
$inner_context,
$loop_scope->loop_parent_context
);
}
2017-11-30 07:07:20 +01:00
}
$inner_context->protected_var_ids = $loop_scope->protected_var_ids;
$statements_checker->analyze($stmts, $inner_context);
2017-12-03 00:28:18 +01:00
self::updateLoopScopeContexts($loop_scope, $loop_scope->loop_parent_context);
2017-11-30 07:07:20 +01:00
2018-01-29 23:18:03 +01:00
foreach ($post_expressions as $post_expression) {
2017-12-03 00:28:18 +01:00
if (ExpressionChecker::analyze(
$statements_checker,
2018-01-29 23:18:03 +01:00
$post_expression,
2017-12-03 00:28:18 +01:00
$loop_scope->loop_context
) === false
) {
2017-11-30 07:07:20 +01:00
return false;
}
}
2017-12-03 00:28:18 +01:00
2018-06-17 02:01:33 +02:00
$new_referenced_var_ids = $inner_context->referenced_var_ids;
$inner_context->referenced_var_ids = $old_referenced_var_ids + $inner_context->referenced_var_ids;
2017-12-03 00:28:18 +01:00
$loop_scope->loop_parent_context->vars_possibly_in_scope = array_merge(
$inner_context->vars_possibly_in_scope,
$loop_scope->loop_parent_context->vars_possibly_in_scope
);
2017-11-30 07:07:20 +01:00
} else {
2017-12-03 00:28:18 +01:00
$pre_outer_context = clone $loop_scope->loop_parent_context;
2017-11-30 07:07:20 +01:00
$analyzer = $statements_checker->getFileChecker()->project_checker->codebase->analyzer;
$original_mixed_counts = $analyzer->getMixedCountsForFile($statements_checker->getFilePath());
2017-11-30 07:07:20 +01:00
IssueBuffer::startRecording();
if (!$is_do) {
foreach ($pre_conditions as $pre_condition) {
$asserted_var_ids = array_merge(
self::applyPreConditionToLoopContext(
$statements_checker,
$pre_condition,
$pre_condition_clauses,
$loop_scope->loop_context,
$loop_scope->loop_parent_context
),
$asserted_var_ids
);
}
2017-11-30 07:07:20 +01:00
}
2017-12-03 00:28:18 +01:00
// record all the vars that existed before we did the first pass through the loop
$pre_loop_context = clone $loop_scope->loop_context;
$inner_context = clone $loop_scope->loop_context;
$inner_context->parent_context = $loop_scope->loop_context;
$inner_context->loop_scope = $loop_scope;
2017-12-03 00:28:18 +01:00
2018-06-17 02:01:33 +02:00
$old_referenced_var_ids = $inner_context->referenced_var_ids;
$inner_context->referenced_var_ids = [];
$asserted_var_ids = array_unique($asserted_var_ids);
2017-12-03 00:28:18 +01:00
$inner_context->protected_var_ids = $loop_scope->protected_var_ids;
$statements_checker->analyze($stmts, $inner_context);
2017-12-03 00:28:18 +01:00
self::updateLoopScopeContexts($loop_scope, $pre_outer_context);
2017-11-30 07:07:20 +01:00
$inner_context->protected_var_ids = $original_protected_var_ids;
2018-01-29 23:18:03 +01:00
foreach ($post_expressions as $post_expression) {
if (ExpressionChecker::analyze($statements_checker, $post_expression, $inner_context) === false) {
2017-11-30 07:07:20 +01:00
return false;
}
}
2018-06-17 02:01:33 +02:00
/**
* @var array<string, bool>
*/
$new_referenced_var_ids = $inner_context->referenced_var_ids;
$inner_context->referenced_var_ids = $old_referenced_var_ids + $inner_context->referenced_var_ids;
2017-11-30 07:07:20 +01:00
$recorded_issues = IssueBuffer::clearRecordingLevel();
IssueBuffer::stopRecording();
for ($i = 0; $i < $assignment_depth; ++$i) {
$vars_to_remove = [];
$has_changes = false;
2017-12-03 00:28:18 +01:00
// reset the $inner_context to what it was before we started the analysis,
// but union the types with what's in the loop scope
foreach ($inner_context->vars_in_scope as $var_id => $type) {
if (in_array($var_id, $asserted_var_ids, true)) {
2017-11-30 07:07:20 +01:00
// set the vars to whatever the while/foreach loop expects them to be
2017-12-03 00:28:18 +01:00
if (!isset($pre_loop_context->vars_in_scope[$var_id])
|| !$type->equals($pre_loop_context->vars_in_scope[$var_id])
2017-12-03 00:28:18 +01:00
) {
2017-11-30 07:07:20 +01:00
$has_changes = true;
}
} elseif (isset($pre_outer_context->vars_in_scope[$var_id])) {
if (!$type->equals($pre_outer_context->vars_in_scope[$var_id])) {
2017-11-30 07:07:20 +01:00
$has_changes = true;
// widen the foreach context type with the initial context type
2017-12-03 00:28:18 +01:00
$inner_context->vars_in_scope[$var_id] = Type::combineUnionTypes(
$inner_context->vars_in_scope[$var_id],
$pre_outer_context->vars_in_scope[$var_id]
);
// if there's a change, invalidate related clauses
$pre_loop_context->removeVarFromConflictingClauses($var_id);
}
if (!$type->equals($loop_scope->loop_context->vars_in_scope[$var_id])) {
2017-12-03 00:28:18 +01:00
$has_changes = true;
// widen the foreach context type with the initial context type
$inner_context->vars_in_scope[$var_id] = Type::combineUnionTypes(
$inner_context->vars_in_scope[$var_id],
$loop_scope->loop_context->vars_in_scope[$var_id]
2017-11-30 07:07:20 +01:00
);
// if there's a change, invalidate related clauses
$pre_loop_context->removeVarFromConflictingClauses($var_id);
}
} else {
// give an opportunity to redeemed UndefinedVariable issues
if ($recorded_issues) {
$has_changes = true;
}
2017-11-30 07:07:20 +01:00
$vars_to_remove[] = $var_id;
}
}
2017-12-03 00:28:18 +01:00
$loop_scope->loop_parent_context->vars_possibly_in_scope = array_merge(
$inner_context->vars_possibly_in_scope,
$loop_scope->loop_parent_context->vars_possibly_in_scope
);
2017-11-30 07:07:20 +01:00
// if there are no changes to the types, no need to re-examine
if (!$has_changes) {
break;
}
if ($inner_context->collect_references) {
2018-06-17 02:01:33 +02:00
foreach ($loop_scope->possibly_unreferenced_vars as $var_id => $locations) {
if (isset($inner_context->unreferenced_vars[$var_id])) {
$inner_context->unreferenced_vars[$var_id] += $locations;
} else {
$inner_context->unreferenced_vars[$var_id] = $locations;
}
}
}
2017-11-30 07:07:20 +01:00
// remove vars that were defined in the foreach
foreach ($vars_to_remove as $var_id) {
2017-12-03 00:28:18 +01:00
unset($inner_context->vars_in_scope[$var_id]);
2017-11-30 07:07:20 +01:00
}
$analyzer->setMixedCountsForFile($statements_checker->getFilePath(), $original_mixed_counts);
2017-11-30 07:07:20 +01:00
IssueBuffer::startRecording();
foreach ($pre_conditions as $pre_condition) {
2017-12-03 00:28:18 +01:00
self::applyPreConditionToLoopContext(
2017-11-30 07:07:20 +01:00
$statements_checker,
$pre_condition,
$pre_condition_clauses,
2017-12-03 00:28:18 +01:00
$inner_context,
$loop_scope->loop_parent_context
);
2017-11-30 07:07:20 +01:00
}
foreach ($asserted_var_ids as $var_id) {
if (!isset($inner_context->vars_in_scope[$var_id])
|| $inner_context->vars_in_scope[$var_id]->getId()
!== $pre_loop_context->vars_in_scope[$var_id]->getId()
|| $inner_context->vars_in_scope[$var_id]->from_docblock
!== $pre_loop_context->vars_in_scope[$var_id]->from_docblock
) {
$inner_context->vars_in_scope[$var_id] = clone $pre_loop_context->vars_in_scope[$var_id];
}
}
$inner_context->clauses = $pre_loop_context->clauses;
$inner_context->protected_var_ids = $loop_scope->protected_var_ids;
$statements_checker->analyze($stmts, $inner_context);
2017-12-03 00:28:18 +01:00
self::updateLoopScopeContexts($loop_scope, $pre_outer_context);
2017-11-30 07:07:20 +01:00
$inner_context->protected_var_ids = $original_protected_var_ids;
2018-01-29 23:18:03 +01:00
foreach ($post_expressions as $post_expression) {
if (ExpressionChecker::analyze($statements_checker, $post_expression, $inner_context) === false) {
2017-11-30 07:07:20 +01:00
return false;
}
}
$recorded_issues = IssueBuffer::clearRecordingLevel();
IssueBuffer::stopRecording();
}
if ($recorded_issues) {
foreach ($recorded_issues as $recorded_issue) {
// if we're not in any loops then this will just result in the issue being emitted
IssueBuffer::bubbleUp($recorded_issue);
}
}
}
2017-12-03 00:28:18 +01:00
$does_sometimes_break = in_array(ScopeChecker::ACTION_BREAK, $loop_scope->final_actions, true);
$does_always_break = $loop_scope->final_actions === [ScopeChecker::ACTION_BREAK];
2017-11-30 07:07:20 +01:00
2017-12-03 00:28:18 +01:00
if ($does_sometimes_break) {
if ($loop_scope->possibly_redefined_loop_parent_vars !== null) {
foreach ($loop_scope->possibly_redefined_loop_parent_vars as $var => $type) {
$loop_scope->loop_parent_context->vars_in_scope[$var] = Type::combineUnionTypes(
$type,
$loop_scope->loop_parent_context->vars_in_scope[$var]
);
}
2017-11-30 07:07:20 +01:00
}
2017-12-03 00:28:18 +01:00
}
2017-11-30 07:07:20 +01:00
foreach ($loop_scope->loop_parent_context->vars_in_scope as $var_id => $type) {
if ($type->isMixed() || !isset($loop_scope->loop_context->vars_in_scope[$var_id])) {
continue;
}
if ($loop_scope->loop_context->vars_in_scope[$var_id]->getId() !== $type->getId()) {
$loop_scope->loop_parent_context->vars_in_scope[$var_id] = Type::combineUnionTypes(
$loop_scope->loop_parent_context->vars_in_scope[$var_id],
$loop_scope->loop_context->vars_in_scope[$var_id]
);
$loop_scope->loop_parent_context->removeVarFromConflictingClauses($var_id);
}
}
2017-12-03 00:28:18 +01:00
if (!$does_always_break) {
foreach ($loop_scope->loop_parent_context->vars_in_scope as $var_id => $type) {
if ($type->isMixed()) {
continue;
}
2017-11-30 07:07:20 +01:00
2017-12-03 00:28:18 +01:00
if (!isset($inner_context->vars_in_scope[$var_id])) {
unset($loop_scope->loop_parent_context->vars_in_scope[$var_id]);
continue;
}
if ($inner_context->vars_in_scope[$var_id]->isMixed()) {
$loop_scope->loop_parent_context->vars_in_scope[$var_id] =
$inner_context->vars_in_scope[$var_id];
$loop_scope->loop_parent_context->removeVarFromConflictingClauses($var_id);
continue;
}
2017-11-30 07:07:20 +01:00
if ($inner_context->vars_in_scope[$var_id]->getId() !== $type->getId()) {
2017-12-03 00:28:18 +01:00
$loop_scope->loop_parent_context->vars_in_scope[$var_id] = Type::combineUnionTypes(
$loop_scope->loop_parent_context->vars_in_scope[$var_id],
$inner_context->vars_in_scope[$var_id]
);
$loop_scope->loop_parent_context->removeVarFromConflictingClauses($var_id);
}
2017-11-30 07:07:20 +01:00
}
}
if ($pre_conditions && $pre_condition_clauses && !ScopeChecker::doesEverBreak($stmts)) {
// if the loop contains an assertion and there are no break statements, we can negate that assertion
// and apply it to the current context
2018-05-07 07:26:06 +02:00
$negated_pre_condition_types = Algebra::getTruthsFromFormula(
Algebra::negateFormula($pre_condition_clauses)
2017-11-30 07:07:20 +01:00
);
if ($negated_pre_condition_types) {
$changed_var_ids = [];
$vars_in_scope_reconciled = Reconciler::reconcileKeyedTypes(
2017-11-30 07:07:20 +01:00
$negated_pre_condition_types,
2017-12-03 00:28:18 +01:00
$inner_context->vars_in_scope,
2017-11-30 07:07:20 +01:00
$changed_var_ids,
[],
$statements_checker,
new CodeLocation($statements_checker->getSource(), $pre_conditions[0]),
$statements_checker->getSuppressedIssues()
);
foreach ($changed_var_ids as $var_id) {
if (isset($vars_in_scope_reconciled[$var_id])
&& isset($loop_scope->loop_parent_context->vars_in_scope[$var_id])
) {
2017-12-03 00:28:18 +01:00
$loop_scope->loop_parent_context->vars_in_scope[$var_id] = $vars_in_scope_reconciled[$var_id];
2017-11-30 07:07:20 +01:00
}
$loop_scope->loop_parent_context->removeVarFromConflictingClauses($var_id);
2017-12-03 00:28:18 +01:00
}
}
}
2017-12-04 05:50:51 +01:00
$loop_scope->loop_context->referenced_var_ids = array_merge(
$inner_context->referenced_var_ids,
$loop_scope->loop_context->referenced_var_ids
);
if ($inner_context->collect_references) {
2018-06-17 02:01:33 +02:00
foreach ($loop_scope->possibly_unreferenced_vars as $var_id => $locations) {
if (isset($inner_context->unreferenced_vars[$var_id])) {
$inner_context->unreferenced_vars[$var_id] += $locations;
} else {
$inner_context->unreferenced_vars[$var_id] = $locations;
}
}
foreach ($inner_context->unreferenced_vars as $var_id => $locations) {
if (!isset($new_referenced_var_ids[$var_id]) || $has_break_statement) {
if (!isset($loop_scope->loop_context->unreferenced_vars[$var_id])) {
$loop_scope->loop_context->unreferenced_vars[$var_id] = $locations;
} else {
$loop_scope->loop_context->unreferenced_vars[$var_id] += $locations;
}
} else {
$statements_checker->registerVariableUses($locations);
}
}
foreach ($loop_scope->unreferenced_vars as $var_id => $locations) {
if (!isset($loop_scope->loop_context->unreferenced_vars[$var_id])) {
2018-06-17 02:01:33 +02:00
$loop_scope->loop_context->unreferenced_vars[$var_id] = $locations;
} else {
$loop_scope->loop_context->unreferenced_vars[$var_id] += $locations;
}
}
}
2017-12-03 00:28:18 +01:00
}
/**
* @param LoopScope $loop_scope
* @param Context $pre_outer_context
*
* @return void
*/
private static function updateLoopScopeContexts(
LoopScope $loop_scope,
Context $pre_outer_context
) {
$updated_loop_vars = [];
if (!in_array(ScopeChecker::ACTION_CONTINUE, $loop_scope->final_actions, true)) {
$loop_scope->loop_context->vars_in_scope = $pre_outer_context->vars_in_scope;
} else {
if ($loop_scope->redefined_loop_vars !== null) {
foreach ($loop_scope->redefined_loop_vars as $var => $type) {
$loop_scope->loop_context->vars_in_scope[$var] = $type;
$updated_loop_vars[$var] = true;
}
}
if ($loop_scope->possibly_redefined_loop_vars) {
foreach ($loop_scope->possibly_redefined_loop_vars as $var => $type) {
if ($loop_scope->loop_context->hasVariable($var)
&& !isset($updated_loop_vars[$var])
) {
2017-12-03 00:28:18 +01:00
$loop_scope->loop_context->vars_in_scope[$var] = Type::combineUnionTypes(
$loop_scope->loop_context->vars_in_scope[$var],
$type
);
}
2017-11-30 07:07:20 +01:00
}
}
}
2017-12-03 00:28:18 +01:00
// merge vars possibly in scope at the end of each loop
$loop_scope->loop_context->vars_possibly_in_scope = array_merge(
$loop_scope->loop_context->vars_possibly_in_scope,
$loop_scope->vars_possibly_in_scope
);
2017-11-30 07:07:20 +01:00
}
/**
* @param PhpParser\Node\Expr $pre_condition
* @param array<int, Clause> $pre_condition_clauses
* @param Context $loop_context
* @param Context $outer_context
*
2017-12-03 00:28:18 +01:00
* @return string[]
2017-11-30 07:07:20 +01:00
*/
private static function applyPreConditionToLoopContext(
StatementsChecker $statements_checker,
PhpParser\Node\Expr $pre_condition,
array $pre_condition_clauses,
Context $loop_context,
Context $outer_context
) {
$pre_referenced_var_ids = $loop_context->referenced_var_ids;
$loop_context->referenced_var_ids = [];
$loop_context->inside_conditional = true;
2017-12-03 00:28:18 +01:00
2017-11-30 07:07:20 +01:00
if (ExpressionChecker::analyze($statements_checker, $pre_condition, $loop_context) === false) {
2017-12-03 00:28:18 +01:00
return [];
2017-11-30 07:07:20 +01:00
}
2017-12-03 00:28:18 +01:00
2017-11-30 07:07:20 +01:00
$loop_context->inside_conditional = false;
$new_referenced_var_ids = $loop_context->referenced_var_ids;
$loop_context->referenced_var_ids = array_merge($pre_referenced_var_ids, $new_referenced_var_ids);
$asserted_var_ids = Context::getNewOrUpdatedVarIds($outer_context, $loop_context);
2017-11-30 07:07:20 +01:00
2018-05-07 07:26:06 +02:00
$loop_context->clauses = Algebra::simplifyCNF(
2017-11-30 07:07:20 +01:00
array_merge($outer_context->clauses, $pre_condition_clauses)
);
2018-05-07 07:26:06 +02:00
$reconcilable_while_types = Algebra::getTruthsFromFormula($loop_context->clauses);
2017-11-30 07:07:20 +01:00
$changed_var_ids = [];
2017-11-30 07:07:20 +01:00
$pre_condition_vars_in_scope_reconciled = Reconciler::reconcileKeyedTypes(
$reconcilable_while_types,
$loop_context->vars_in_scope,
$changed_var_ids,
$new_referenced_var_ids,
$statements_checker,
new CodeLocation($statements_checker->getSource(), $pre_condition),
$statements_checker->getSuppressedIssues()
);
$loop_context->vars_in_scope = $pre_condition_vars_in_scope_reconciled;
2017-12-03 00:28:18 +01:00
foreach ($asserted_var_ids as $var_id) {
$loop_context->clauses = Context::filterClauses(
$var_id,
$loop_context->clauses,
null,
$statements_checker
);
}
return $asserted_var_ids;
2017-11-30 07:07:20 +01:00
}
/**
* @param string $first_var_id
* @param array<string, array<string, bool>> $assignment_map
*
* @return int
*/
private static function getAssignmentMapDepth($first_var_id, array $assignment_map)
{
$max_depth = 0;
$assignment_var_ids = $assignment_map[$first_var_id];
unset($assignment_map[$first_var_id]);
foreach ($assignment_var_ids as $assignment_var_id => $_) {
$depth = 1;
if (isset($assignment_map[$assignment_var_id])) {
$depth = 1 + self::getAssignmentMapDepth($assignment_var_id, $assignment_map);
}
if ($depth > $max_depth) {
$max_depth = $depth;
}
}
return $max_depth;
}
}