Skip to content

Commit e141cce

Browse files
ondrejmirtesondrejmirtes
committed
QuoteAwareConstExprStringNode becomes the new ConstExprStringNode
1 parent 2deb7fc commit e141cce

16 files changed

+150
-256
lines changed

‎phpstan-baseline.neon

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
parameters:
22
ignoreErrors:
33
-
4-
message: "#^Method PHPStan\\\\PhpDocParser\\\\Ast\\\\ConstExpr\\\\QuoteAwareConstExprStringNode\\:\\:escapeDoubleQuotedString\\(\\) should return string but returns string\\|null\\.$#"
4+
message: "#^Method PHPStan\\\\PhpDocParser\\\\Ast\\\\ConstExpr\\\\ConstExprStringNode\\:\\:escapeDoubleQuotedString\\(\\) should return string but returns string\\|null\\.$#"
55
count: 1
6-
path: src/Ast/ConstExpr/QuoteAwareConstExprStringNode.php
6+
path: src/Ast/ConstExpr/ConstExprStringNode.php
77

88
-
99
message: "#^Cannot use array destructuring on array\\<int, array\\<PHPStan\\\\PhpDocParser\\\\Ast\\\\Node\\>\\|int\\|string\\>\\|null\\.$#"

‎src/Ast/ConstExpr/ConstExprStringNode.php

+57-2
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,79 @@
33
namespace PHPStan\PhpDocParser\Ast\ConstExpr;
44

55
use PHPStan\PhpDocParser\Ast\NodeAttributes;
6+
use function addcslashes;
7+
use function assert;
8+
use function dechex;
9+
use function ord;
10+
use function preg_replace_callback;
11+
use function sprintf;
12+
use function str_pad;
13+
use function strlen;
14+
use const STR_PAD_LEFT;
615

716
class ConstExprStringNode implements ConstExprNode
817
{
918

19+
public const SINGLE_QUOTED = 1;
20+
public const DOUBLE_QUOTED = 2;
21+
1022
use NodeAttributes;
1123

1224
/** @var string */
1325
public $value;
1426

15-
public function __construct(string $value)
27+
/** @var self::SINGLE_QUOTED|self::DOUBLE_QUOTED */
28+
public $quoteType;
29+
30+
/**
31+
* @param self::SINGLE_QUOTED|self::DOUBLE_QUOTED $quoteType
32+
*/
33+
public function __construct(string $value, int $quoteType)
1634
{
1735
$this->value = $value;
36+
$this->quoteType = $quoteType;
1837
}
1938

2039

2140
public function __toString(): string
2241
{
23-
return $this->value;
42+
if ($this->quoteType === self::SINGLE_QUOTED) {
43+
// from https://github.com/nikic/PHP-Parser/blob/0ffddce52d816f72d0efc4d9b02e276d3309ef01/lib/PhpParser/PrettyPrinter/Standard.php#L1007
44+
return sprintf("'%s'", addcslashes($this->value, '\'\\'));
45+
}
46+
47+
// from https://github.com/nikic/PHP-Parser/blob/0ffddce52d816f72d0efc4d9b02e276d3309ef01/lib/PhpParser/PrettyPrinter/Standard.php#L1010-L1040
48+
return sprintf('"%s"', $this->escapeDoubleQuotedString());
49+
}
50+
51+
private function escapeDoubleQuotedString(): string
52+
{
53+
$quote = '"';
54+
$escaped = addcslashes($this->value, "\n\r\t\f\v$" . $quote . '\\');
55+
56+
// Escape control characters and non-UTF-8 characters.
57+
// Regex based on https://stackoverflow.com/a/11709412/385378.
58+
$regex = '/(
59+
[\x00-\x08\x0E-\x1F] # Control characters
60+
| [\xC0-\xC1] # Invalid UTF-8 Bytes
61+
| [\xF5-\xFF] # Invalid UTF-8 Bytes
62+
| \xE0(?=[\x80-\x9F]) # Overlong encoding of prior code point
63+
| \xF0(?=[\x80-\x8F]) # Overlong encoding of prior code point
64+
| [\xC2-\xDF](?![\x80-\xBF]) # Invalid UTF-8 Sequence Start
65+
| [\xE0-\xEF](?![\x80-\xBF]{2}) # Invalid UTF-8 Sequence Start
66+
| [\xF0-\xF4](?![\x80-\xBF]{3}) # Invalid UTF-8 Sequence Start
67+
| (?<=[\x00-\x7F\xF5-\xFF])[\x80-\xBF] # Invalid UTF-8 Sequence Middle
68+
| (?<![\xC2-\xDF]|[\xE0-\xEF]|[\xE0-\xEF][\x80-\xBF]|[\xF0-\xF4]|[\xF0-\xF4][\x80-\xBF]|[\xF0-\xF4][\x80-\xBF]{2})[\x80-\xBF] # Overlong Sequence
69+
| (?<=[\xE0-\xEF])[\x80-\xBF](?![\x80-\xBF]) # Short 3 byte sequence
70+
| (?<=[\xF0-\xF4])[\x80-\xBF](?![\x80-\xBF]{2}) # Short 4 byte sequence
71+
| (?<=[\xF0-\xF4][\x80-\xBF])[\x80-\xBF](?![\x80-\xBF]) # Short 4 byte sequence (2)
72+
)/x';
73+
return preg_replace_callback($regex, static function ($matches) {
74+
assert(strlen($matches[0]) === 1);
75+
$hex = dechex(ord($matches[0]));
76+
77+
return '\\x' . str_pad($hex, 2, '0', STR_PAD_LEFT);
78+
}, $escaped);
2479
}
2580

2681
}

‎src/Ast/ConstExpr/DoctrineConstExprStringNode.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ class DoctrineConstExprStringNode extends ConstExprStringNode
1818

1919
public function __construct(string $value)
2020
{
21-
parent::__construct($value);
21+
parent::__construct($value, self::DOUBLE_QUOTED);
2222
$this->value = $value;
2323
}
2424

‎src/Ast/ConstExpr/QuoteAwareConstExprStringNode.php

-78
This file was deleted.

‎src/Parser/ConstExprParser.php

+9-37
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,10 @@
66
use PHPStan\PhpDocParser\Lexer\Lexer;
77
use function str_replace;
88
use function strtolower;
9-
use function substr;
109

1110
class ConstExprParser
1211
{
1312

14-
/** @var bool */
15-
private $unescapeStrings;
16-
17-
/** @var bool */
18-
private $quoteAwareConstExprString;
19-
2013
/** @var bool */
2114
private $useLinesAttributes;
2215

@@ -30,13 +23,9 @@ class ConstExprParser
3023
* @param array{lines?: bool, indexes?: bool} $usedAttributes
3124
*/
3225
public function __construct(
33-
bool $unescapeStrings = false,
34-
bool $quoteAwareConstExprString = false,
3526
array $usedAttributes = []
3627
)
3728
{
38-
$this->unescapeStrings = $unescapeStrings;
39-
$this->quoteAwareConstExprString = $quoteAwareConstExprString;
4029
$this->useLinesAttributes = $usedAttributes['lines'] ?? false;
4130
$this->useIndexAttributes = $usedAttributes['indexes'] ?? false;
4231
$this->parseDoctrineStrings = false;
@@ -48,8 +37,6 @@ public function __construct(
4837
public function toDoctrine(): self
4938
{
5039
$self = new self(
51-
$this->unescapeStrings,
52-
$this->quoteAwareConstExprString,
5340
[
5441
'lines' => $this->useLinesAttributes,
5542
'indexes' => $this->useIndexAttributes,
@@ -59,7 +46,7 @@ public function toDoctrine(): self
5946
return $self;
6047
}
6148

62-
public function parse(TokenIterator $tokens, bool $trimStrings = false): Ast\ConstExpr\ConstExprNode
49+
public function parse(TokenIterator $tokens): Ast\ConstExpr\ConstExprNode
6350
{
6451
$startLine = $tokens->currentTokenLine();
6552
$startIndex = $tokens->currentTokenIndex();
@@ -122,34 +109,19 @@ public function parse(TokenIterator $tokens, bool $trimStrings = false): Ast\Con
122109
$startIndex
123110
);
124111
}
125-
$value = $tokens->currentTokenValue();
112+
113+
$value = StringUnescaper::unescapeString($tokens->currentTokenValue());
126114
$type = $tokens->currentTokenType();
127-
if ($trimStrings) {
128-
if ($this->unescapeStrings) {
129-
$value = StringUnescaper::unescapeString($value);
130-
} else {
131-
$value = substr($value, 1, -1);
132-
}
133-
}
134115
$tokens->next();
135116

136-
if ($this->quoteAwareConstExprString) {
137-
return $this->enrichWithAttributes(
138-
$tokens,
139-
new Ast\ConstExpr\QuoteAwareConstExprStringNode(
140-
$value,
141-
$type === Lexer::TOKEN_SINGLE_QUOTED_STRING
142-
? Ast\ConstExpr\QuoteAwareConstExprStringNode::SINGLE_QUOTED
143-
: Ast\ConstExpr\QuoteAwareConstExprStringNode::DOUBLE_QUOTED
144-
),
145-
$startLine,
146-
$startIndex
147-
);
148-
}
149-
150117
return $this->enrichWithAttributes(
151118
$tokens,
152-
new Ast\ConstExpr\ConstExprStringNode($value),
119+
new Ast\ConstExpr\ConstExprStringNode(
120+
$value,
121+
$type === Lexer::TOKEN_SINGLE_QUOTED_STRING
122+
? Ast\ConstExpr\ConstExprStringNode::SINGLE_QUOTED
123+
: Ast\ConstExpr\ConstExprStringNode::DOUBLE_QUOTED
124+
),
153125
$startLine,
154126
$startIndex
155127
);

‎src/Parser/PhpDocParser.php

+7-3
Original file line numberDiff line numberDiff line change
@@ -704,7 +704,7 @@ private function parseDoctrineArgumentValue(TokenIterator $tokens)
704704
$currentTokenLine = $tokens->currentTokenLine();
705705

706706
try {
707-
$constExpr = $this->doctrineConstantExprParser->parse($tokens, true);
707+
$constExpr = $this->doctrineConstantExprParser->parse($tokens);
708708
if ($constExpr instanceof Ast\ConstExpr\ConstExprArrayNode) {
709709
throw new ParserException(
710710
$currentTokenValue,
@@ -781,10 +781,14 @@ private function parseDoctrineArrayKey(TokenIterator $tokens)
781781
$tokens->next();
782782

783783
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_DOCTRINE_ANNOTATION_STRING)) {
784-
$key = new Ast\ConstExpr\DoctrineConstExprStringNode(Ast\ConstExpr\DoctrineConstExprStringNode::unescape($tokens->currentTokenValue()));
784+
$key = $this->doctrineConstantExprParser->parseDoctrineString($tokens->currentTokenValue(), $tokens);
785785

786786
$tokens->next();
787787

788+
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_SINGLE_QUOTED_STRING)) {
789+
$key = new Ast\ConstExpr\ConstExprStringNode(StringUnescaper::unescapeString($tokens->currentTokenValue()), Ast\ConstExpr\ConstExprStringNode::SINGLE_QUOTED);
790+
$tokens->next();
791+
788792
} elseif ($tokens->isCurrentTokenType(Lexer::TOKEN_DOUBLE_QUOTED_STRING)) {
789793
$value = $tokens->currentTokenValue();
790794
$tokens->next();
@@ -817,7 +821,7 @@ private function parseDoctrineArrayKey(TokenIterator $tokens)
817821
}
818822

819823
$tokens->rollback();
820-
$constExpr = $this->doctrineConstantExprParser->parse($tokens, true);
824+
$constExpr = $this->doctrineConstantExprParser->parse($tokens);
821825
if (!$constExpr instanceof Ast\ConstExpr\ConstFetchNode) {
822826
throw new ParserException(
823827
$tokens->currentTokenValue(),

0 commit comments

Comments
 (0)