Skip to content

RegexArrayShapeMatcher - infer constant string types in alternations #3369

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

Merged
merged 3 commits into from
Aug 28, 2024
Merged

RegexArrayShapeMatcher - infer constant string types in alternations #3369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
156c34d
RegexArrayShapeMatcher - infer constant string types in alternations
staabm Aug 28, 2024
4e85d3f
Update bug-11311-php72.php
staabm Aug 28, 2024
043e0f1
more tests
staabm Aug 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions src/Type/Regex/RegexExpressionHelper.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use function array_key_exists;
use function ltrim;
use function strrpos;
use function substr;

Expand Down Expand Up @@ -147,6 +148,8 @@ public function getPatternDelimiters(Concat $concat, Scope $scope): array

private function getPatternDelimiter(string $regex): ?string
{
$regex = ltrim($regex);

if ($regex === '') {
return null;
}
Expand Down
21 changes: 20 additions & 1 deletion src/Type/Regex/RegexGroupParser.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use function array_merge;
use function count;
use function in_array;
use function is_int;
Expand Down Expand Up @@ -432,7 +433,7 @@ private function walkGroupAst(
$isNonEmpty = TrinaryLogic::createYes();
}
}
} elseif (!in_array($ast->getId(), ['#capturing', '#namedcapturing'], true)) {
} elseif (!in_array($ast->getId(), ['#capturing', '#namedcapturing', '#alternation'], true)) {
$onlyLiterals = null;
}

Expand All @@ -447,6 +448,7 @@ private function walkGroupAst(
$isNumeric = TrinaryLogic::createNo();
}

$alternativeLiterals = [];
foreach ($children as $child) {
$this->walkGroupAst(
$child,
Expand All @@ -459,7 +461,24 @@ private function walkGroupAst(
$inClass,
$patternModifiers,
);

if ($ast->getId() !== '#alternation') {
continue;
}

if ($onlyLiterals !== null && $alternativeLiterals !== null) {
$alternativeLiterals = array_merge($alternativeLiterals, $onlyLiterals);
$onlyLiterals = [];
} else {
$alternativeLiterals = null;
}
}

if ($alternativeLiterals === null || $alternativeLiterals === []) {
return;
}

$onlyLiterals = $alternativeLiterals;
}

private function isMaybeEmptyNode(TreeNode $node, string $patternModifiers, bool &$isNonFalsy): bool
Expand Down
4 changes: 2 additions & 2 deletions tests/PHPStan/Analyser/nsrt/bug-11311-php72.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ function doUnmatchedAsNull(string $s): void {
// see https://3v4l.org/VeDob#veol
function unmatchedAsNullWithOptionalGroup(string $s): void {
if (preg_match('/Price: (£|€)?\d+/', $s, $matches, PREG_UNMATCHED_AS_NULL)) {
assertType("array{0: string, 1?: non-empty-string}", $matches);
assertType("array{0: string, 1?: '£'|'€'}", $matches);
} else {
assertType('array{}', $matches);
}
assertType("array{}|array{0: string, 1?: non-empty-string}", $matches);
assertType("array{}|array{0: string, 1?: '£'|'€'}", $matches);
}
4 changes: 2 additions & 2 deletions tests/PHPStan/Analyser/nsrt/bug-11311.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ function doUnmatchedAsNull(string $s): void {
function unmatchedAsNullWithOptionalGroup(string $s): void {
if (preg_match('/Price: (£|€)?\d+/', $s, $matches, PREG_UNMATCHED_AS_NULL)) {
// with PREG_UNMATCHED_AS_NULL the offset 1 will always exist. It is correct that it's nullable because it's optional though
assertType('array{string, non-empty-string|null}', $matches);
assertType("array{string, '£'|'€'|null}", $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{string, non-empty-string|null}', $matches);
assertType("array{}|array{string, '£'|'€'|null}", $matches);
}

function bug11331a(string $url):void {
Expand Down
36 changes: 24 additions & 12 deletions tests/PHPStan/Analyser/nsrt/preg_match_shapes.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ function doMatch(string $s): void {
assertType('array{}|array{string}', $matches);

if (preg_match('/Price: (£|€)\d+/', $s, $matches)) {
assertType('array{string, non-empty-string}', $matches);
assertType("array{string, '£'|'€'}", $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{string, non-empty-string}', $matches);
assertType("array{}|array{string, '£'|'€'}", $matches);

if (preg_match('/Price: (£|€)(\d+)/i', $s, $matches)) {
assertType('array{string, non-empty-string, numeric-string}', $matches);
Expand Down Expand Up @@ -54,9 +54,9 @@ function doMatch(string $s): void {
assertType("array{}|array{0: string, 1: 'a', 2: string, 3: 'c', name?: non-empty-string, 4?: non-empty-string}", $matches);

if (preg_match('/(a|b)|(?:c)/', $s, $matches)) {
assertType('array{0: string, 1?: non-empty-string}', $matches);
assertType("array{0: string, 1?: 'a'|'b'}", $matches);
}
assertType('array{}|array{0: string, 1?: non-empty-string}', $matches);
assertType("array{}|array{0: string, 1?: 'a'|'b'}", $matches);

if (preg_match('/(foo)(bar)(baz)+/', $s, $matches)) {
assertType("array{string, 'foo', 'bar', non-falsy-string}", $matches);
Expand Down Expand Up @@ -356,30 +356,30 @@ function bug11291(string $s): void {
function bug11323a(string $s): void
{
if (preg_match('/Price: (?P<currency>£|€)\d+/', $s, $matches)) {
assertType('array{0: string, currency: non-empty-string, 1: non-empty-string}', $matches);
assertType("array{0: string, currency: '£'|'€', 1: '£'|'€'}", $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{0: string, currency: non-empty-string, 1: non-empty-string}', $matches);
assertType("array{}|array{0: string, currency: '£'|'€', 1: '£'|'€'}", $matches);
}

function bug11323b(string $s): void
{
if (preg_match('/Price: (?<currency>£|€)\d+/', $s, $matches)) {
assertType('array{0: string, currency: non-empty-string, 1: non-empty-string}', $matches);
assertType("array{0: string, currency: '£'|'€', 1: '£'|'€'}", $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{0: string, currency: non-empty-string, 1: non-empty-string}', $matches);
assertType("array{}|array{0: string, currency: '£'|'€', 1: '£'|'€'}", $matches);
}

function unmatchedAsNullWithMandatoryGroup(string $s): void {
if (preg_match('/Price: (?<currency>£|€)\d+/', $s, $matches, PREG_UNMATCHED_AS_NULL)) {
assertType('array{0: string, currency: non-empty-string, 1: non-empty-string}', $matches);
assertType("array{0: string, currency: '£'|'€', 1: '£'|'€'}", $matches);
} else {
assertType('array{}', $matches);
}
assertType('array{}|array{0: string, currency: non-empty-string, 1: non-empty-string}', $matches);
assertType("array{}|array{0: string, currency: '£'|'€', 1: '£'|'€'}", $matches);
}

function (string $s): void {
Expand Down Expand Up @@ -608,17 +608,29 @@ function (string $s): void {
};

function (string $s): void {
if (preg_match('/Price: (a|0)/', $s, $matches)) {
if (preg_match('/Price: (a|bc?)/', $s, $matches)) {
assertType("array{string, non-empty-string}", $matches);
}
};

function (string $s): void {
if (preg_match('/Price: (aa|0)/', $s, $matches)) {
if (preg_match('/Price: (a|\d)/', $s, $matches)) {
assertType("array{string, non-empty-string}", $matches);
}
};

function (string $s): void {
if (preg_match('/Price: (a|0)/', $s, $matches)) {
assertType("array{string, '0'|'a'}", $matches);
}
};

function (string $s): void {
if (preg_match('/Price: (aa|0)/', $s, $matches)) {
assertType("array{string, '0'|'aa'}", $matches);
}
};

function (string $s): void {
if (preg_match('/( \d+ )/x', $s, $matches)) {
assertType('array{string, numeric-string}', $matches);
Expand Down
Loading