Skip to content

Commit 56ce473

Browse files
staabmstaabm
committed
Implement TypeSpecifierComparisonContext
1 parent 9c4bee9 commit 56ce473

File tree

6 files changed

+220
-23
lines changed

6 files changed

+220
-23
lines changed

‎src/Analyser/TypeSpecifier.php‎

Lines changed: 63 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@
3838
use PHPStan\Type\Accessory\NonEmptyArrayType;
3939
use PHPStan\Type\ArrayType;
4040
use PHPStan\Type\BooleanType;
41+
use PHPStan\Type\ComparisonAwareTypeSpecifyingExtension;
4142
use PHPStan\Type\ConditionalTypeForParameter;
4243
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
4344
use PHPStan\Type\Constant\ConstantBooleanType;
@@ -2005,6 +2006,47 @@ private function getTypeSpecifyingExtensionsForType(array $extensions, string $c
20052006
return array_merge(...$extensionsForClass);
20062007
}
20072008

2009+
private function specifyWithComparisonAwareTypeSpecifyingExtensions(
2010+
Expr\BinaryOp $binaryOp,
2011+
Expr $callExpr,
2012+
Expr\CallLike $callLike,
2013+
Type $comparisonType,
2014+
Scope $scope,
2015+
TypeSpecifierContext $context,
2016+
?Expr $rootExpr,
2017+
): ?SpecifiedTypes
2018+
{
2019+
if ($callLike instanceof FuncCall && $callLike->name instanceof Name) {
2020+
if (!$this->reflectionProvider->hasFunction($callLike->name, $scope)) {
2021+
return null;
2022+
}
2023+
$functionReflection = $this->reflectionProvider->getFunction($callLike->name, $scope);
2024+
2025+
$comparisonContext = TypeSpecifierContext::createComparison(
2026+
new TypeSpecifierComparisonContext(
2027+
$binaryOp,
2028+
$callExpr,
2029+
$comparisonType,
2030+
$context,
2031+
$rootExpr,
2032+
),
2033+
);
2034+
foreach ($this->getFunctionTypeSpecifyingExtensions() as $extension) {
2035+
if (!$extension instanceof ComparisonAwareTypeSpecifyingExtension) {
2036+
continue;
2037+
}
2038+
2039+
if (!$extension->isFunctionSupported($functionReflection, $callLike, $comparisonContext)) {
2040+
continue;
2041+
}
2042+
2043+
return $extension->specifyTypes($functionReflection, $callLike, $scope, $comparisonContext);
2044+
}
2045+
}
2046+
2047+
return null;
2048+
}
2049+
20082050
public function resolveEqual(Expr\BinaryOp\Equal $expr, Scope $scope, TypeSpecifierContext $context, ?Expr $rootExpr): SpecifiedTypes
20092051
{
20102052
$expressions = $this->findTypeExpressionsFromBinaryOperation($scope, $expr);
@@ -2041,12 +2083,20 @@ public function resolveEqual(Expr\BinaryOp\Equal $expr, Scope $scope, TypeSpecif
20412083

20422084
if (
20432085
$context->true()
2044-
&& $exprNode instanceof FuncCall
2045-
&& $exprNode->name instanceof Name
2046-
&& $exprNode->name->toLowerString() === 'preg_match'
2047-
&& (new ConstantIntegerType(1))->isSuperTypeOf($constantType)->yes()
2086+
&& $exprNode instanceof Expr\CallLike
20482087
) {
2049-
return $this->specifyTypesInCondition($scope, new Expr\BinaryOp\Identical($expr->left, $expr->right), $context, $rootExpr);
2088+
$specifiedTypes = $this->specifyWithComparisonAwareTypeSpecifyingExtensions(
2089+
$expr,
2090+
$exprNode,
2091+
$exprNode,
2092+
$constantType,
2093+
$scope,
2094+
$context,
2095+
$rootExpr,
2096+
);
2097+
if ($specifiedTypes !== null) {
2098+
return $specifiedTypes;
2099+
}
20502100
}
20512101
}
20522102

@@ -2141,15 +2191,19 @@ public function resolveIdentical(Expr\BinaryOp\Identical $expr, Scope $scope, Ty
21412191
$context->true()
21422192
&& $unwrappedLeftExpr instanceof FuncCall
21432193
&& $unwrappedLeftExpr->name instanceof Name
2144-
&& $unwrappedLeftExpr->name->toLowerString() === 'preg_match'
2145-
&& (new ConstantIntegerType(1))->isSuperTypeOf($rightType)->yes()
21462194
) {
2147-
return $this->specifyTypesInCondition(
2148-
$scope,
2195+
$specifiedTypes = $this->specifyWithComparisonAwareTypeSpecifyingExtensions(
2196+
$expr,
21492197
$leftExpr,
2198+
$unwrappedLeftExpr,
2199+
$rightType,
2200+
$scope,
21502201
$context,
21512202
$rootExpr,
21522203
);
2204+
if ($specifiedTypes !== null) {
2205+
return $specifiedTypes;
2206+
}
21532207
}
21542208

21552209
if (

‎src/Analyser/TypeSpecifierComparisonContext.php‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Analyser;
4+
5+
use PhpParser\Node\Expr;
6+
use PhpParser\Node\Expr\BinaryOp;
7+
use PHPStan\Type\Type;
8+
9+
/** @api */
10+
final class TypeSpecifierComparisonContext
11+
{
12+
13+
public function __construct(
14+
private BinaryOp $binaryOp,
15+
private Expr $callExpr,
16+
private Type $comparisonType,
17+
private TypeSpecifierContext $context,
18+
private ?Expr $rootExpr,
19+
)
20+
{
21+
}
22+
23+
public function getBinaryOp(): BinaryOp
24+
{
25+
return $this->binaryOp;
26+
}
27+
28+
public function getCallExpr(): Expr
29+
{
30+
return $this->callExpr;
31+
}
32+
33+
public function getComparisonType(): Type
34+
{
35+
return $this->comparisonType;
36+
}
37+
38+
public function getTypeSpecifierContext(): TypeSpecifierContext
39+
{
40+
return $this->context;
41+
}
42+
43+
public function getRootExpr(): ?Expr
44+
{
45+
return $this->rootExpr;
46+
}
47+
48+
}

‎src/Analyser/TypeSpecifierContext.php‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,22 @@ class TypeSpecifierContext
1717
public const CONTEXT_FALSE = 0b0100;
1818
public const CONTEXT_FALSEY_BUT_NOT_FALSE = 0b1000;
1919
public const CONTEXT_FALSEY = self::CONTEXT_FALSE | self::CONTEXT_FALSEY_BUT_NOT_FALSE;
20-
public const CONTEXT_BITMASK = 0b1111;
20+
public const CONTEXT_COMPARISON = 0b10000;
21+
public const CONTEXT_BITMASK = 0b01111;
2122

2223
/** @var self[] */
2324
private static array $registry;
2425

25-
private function __construct(private ?int $value)
26+
private function __construct(
27+
private ?int $value,
28+
private ?TypeSpecifierComparisonContext $comparisonContext,
29+
)
2630
{
2731
}
2832

29-
private static function create(?int $value): self
33+
private static function create(?int $value, ?TypeSpecifierComparisonContext $comparisonContext = null): self
3034
{
31-
self::$registry[$value] ??= new self($value);
35+
self::$registry[$value] ??= new self($value, $comparisonContext);
3236
return self::$registry[$value];
3337
}
3438

@@ -52,6 +56,11 @@ public static function createFalsey(): self
5256
return self::create(self::CONTEXT_FALSEY);
5357
}
5458

59+
public static function createComparison(TypeSpecifierComparisonContext $comparisonContext): self
60+
{
61+
return self::create(self::CONTEXT_COMPARISON, $comparisonContext);
62+
}
63+
5564
public static function createNull(): self
5665
{
5766
return self::create(null);
@@ -90,4 +99,9 @@ public function null(): bool
9099
return $this->value === null;
91100
}
92101

102+
public function comparison(): ?TypeSpecifierComparisonContext
103+
{
104+
return $this->comparisonContext;
105+
}
106+
93107
}

‎src/Type/ComparisonAwareTypeSpecifyingExtension.php‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?php declare(strict_types = 1);
2+
3+
namespace PHPStan\Type;
4+
5+
/**
6+
* This is the marker interface *TypeSpecifyingExtension might implement to specify types for comparisons.
7+
*
8+
* Use it in your already registered type specifying extension.
9+
*
10+
* Learn more: https://phpstan.org/developing-extensions/type-specifying-extensions
11+
*
12+
* @api
13+
*
14+
*/
15+
interface ComparisonAwareTypeSpecifyingExtension
16+
{
17+
18+
}

‎src/Type/Php/PregMatchTypeSpecifyingExtension.php‎

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
namespace PHPStan\Type\Php;
44

5+
use PhpParser\Node\Expr\BinaryOp\Equal;
6+
use PhpParser\Node\Expr\BinaryOp\Identical;
57
use PhpParser\Node\Expr\FuncCall;
68
use PHPStan\Analyser\Scope;
79
use PHPStan\Analyser\SpecifiedTypes;
@@ -10,11 +12,13 @@
1012
use PHPStan\Analyser\TypeSpecifierContext;
1113
use PHPStan\Reflection\FunctionReflection;
1214
use PHPStan\TrinaryLogic;
15+
use PHPStan\Type\ComparisonAwareTypeSpecifyingExtension;
16+
use PHPStan\Type\Constant\ConstantIntegerType;
1317
use PHPStan\Type\FunctionTypeSpecifyingExtension;
1418
use function in_array;
1519
use function strtolower;
1620

17-
final class PregMatchTypeSpecifyingExtension implements FunctionTypeSpecifyingExtension, TypeSpecifierAwareExtension
21+
final class PregMatchTypeSpecifyingExtension implements FunctionTypeSpecifyingExtension, TypeSpecifierAwareExtension, ComparisonAwareTypeSpecifyingExtension
1822
{
1923

2024
private TypeSpecifier $typeSpecifier;
@@ -37,6 +41,25 @@ public function isFunctionSupported(FunctionReflection $functionReflection, Func
3741

3842
public function specifyTypes(FunctionReflection $functionReflection, FuncCall $node, Scope $scope, TypeSpecifierContext $context): SpecifiedTypes
3943
{
44+
$comparisonContext = $context->comparison();
45+
if ($comparisonContext !== null) {
46+
$binaryOp = $comparisonContext->getBinaryOp();
47+
if (
48+
($binaryOp instanceof Equal || $binaryOp instanceof Identical)
49+
&& $comparisonContext->getTypeSpecifierContext()->true()
50+
&& (new ConstantIntegerType(1))->isSuperTypeOf($comparisonContext->getComparisonType())->yes()
51+
) {
52+
return $this->typeSpecifier->specifyTypesInCondition(
53+
$scope,
54+
$comparisonContext->getCallExpr(),
55+
$comparisonContext->getTypeSpecifierContext(),
56+
$comparisonContext->getRootExpr(),
57+
);
58+
}
59+
60+
return new SpecifiedTypes();
61+
}
62+
4063
$args = $node->getArgs();
4164
$patternArg = $args[0] ?? null;
4265
$matchesArg = $args[2] ?? null;

‎tests/PHPStan/Analyser/TypeSpecifierContextTest.php‎

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,12 @@
22

33
namespace PHPStan\Analyser;
44

5+
use PhpParser\Node\Expr\BinaryOp\Equal;
6+
use PhpParser\Node\Expr\FuncCall;
7+
use PhpParser\Node\Scalar\String_;
58
use PHPStan\ShouldNotHappenException;
69
use PHPStan\Testing\PHPStanTestCase;
10+
use PHPStan\Type\NullType;
711

812
class TypeSpecifierContextTest extends PHPStanTestCase
913
{
@@ -13,23 +17,27 @@ public function dataContext(): array
1317
return [
1418
[
1519
TypeSpecifierContext::createTrue(),
16-
[true, true, false, false, false],
20+
[true, true, false, false, false, false],
1721
],
1822
[
1923
TypeSpecifierContext::createTruthy(),
20-
[true, true, false, false, false],
24+
[true, true, false, false, false, false],
2125
],
2226
[
2327
TypeSpecifierContext::createFalse(),
24-
[false, false, true, true, false],
28+
[false, false, true, true, false, false],
2529
],
2630
[
2731
TypeSpecifierContext::createFalsey(),
28-
[false, false, true, true, false],
32+
[false, false, true, true, false, false],
2933
],
3034
[
3135
TypeSpecifierContext::createNull(),
32-
[false, false, false, false, true],
36+
[false, false, false, false, true, false],
37+
],
38+
[
39+
$this->createComparisonContext(),
40+
[false, false, false, false, false, true],
3341
],
3442
];
3543
}
@@ -45,27 +53,40 @@ public function testContext(TypeSpecifierContext $context, array $results): void
4553
$this->assertSame($results[2], $context->false());
4654
$this->assertSame($results[3], $context->falsey());
4755
$this->assertSame($results[4], $context->null());
56+
57+
if ($results[5]) {
58+
$this->assertNotNull($context->comparison());
59+
} else {
60+
$this->assertNull($context->comparison());
61+
}
4862
}
4963

5064
public function dataNegate(): array
5165
{
5266
return [
5367
[
5468
TypeSpecifierContext::createTrue()->negate(),
55-
[false, true, true, true, false],
69+
[false, true, true, true, false, false],
5670
],
5771
[
5872
TypeSpecifierContext::createTruthy()->negate(),
59-
[false, false, true, true, false],
73+
[false, false, true, true, false, false],
6074
],
6175
[
6276
TypeSpecifierContext::createFalse()->negate(),
63-
[true, true, false, true, false],
77+
[true, true, false, true, false, false],
6478
],
6579
[
6680
TypeSpecifierContext::createFalsey()->negate(),
67-
[true, true, false, false, false],
81+
[true, true, false, false, false, false],
82+
],
83+
/*
84+
// XXX should a comparison context be negatable?
85+
[
86+
$this->createComparisonContext()->negate(),
87+
[false, false, false, false, false, true],
6888
],
89+
*/
6990
];
7091
}
7192

@@ -80,6 +101,12 @@ public function testNegate(TypeSpecifierContext $context, array $results): void
80101
$this->assertSame($results[2], $context->false());
81102
$this->assertSame($results[3], $context->falsey());
82103
$this->assertSame($results[4], $context->null());
104+
105+
if ($results[5]) {
106+
$this->assertNotNull($context->comparison());
107+
} else {
108+
$this->assertNull($context->comparison());
109+
}
83110
}
84111

85112
public function testNegateNull(): void
@@ -88,4 +115,17 @@ public function testNegateNull(): void
88115
TypeSpecifierContext::createNull()->negate();
89116
}
90117

118+
private function createComparisonContext(): TypeSpecifierContext
119+
{
120+
return TypeSpecifierContext::createComparison(
121+
new TypeSpecifierComparisonContext(
122+
new Equal(new String_('dummy'), new String_('dummy2')),
123+
new FuncCall('dummyFunc'),
124+
new NullType(),
125+
TypeSpecifierContext::createNull(),
126+
null,
127+
),
128+
);
129+
}
130+
91131
}

0 commit comments

Comments
 (0)