Skip to content
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

Jump to bottom

[String_] Add rawValue attribute #831

Merged
merged 6 commits into from May 15, 2022
Merged

[String_] Add rawValue attribute #831

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ff88c44
add raw value to String_ as 3rd arg
TomasVotruba May 9, 2022
deb7d79
add parse raw value string test
TomasVotruba May 9, 2022
2f90510
make use of attributes
TomasVotruba May 12, 2022
8c3d790
add String_::fromString() method by convention
TomasVotruba May 15, 2022
23b4147
move strKind() parser helper method to String_::fromString()
TomasVotruba May 15, 2022
502d182
pass attributes directly
TomasVotruba May 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions grammar/php5.y
View file
Open in desktop
Expand Up @@ -690,8 +690,8 @@ array_expr:
scalar_dereference:
array_expr '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| T_CONSTANT_ENCAPSED_STRING '[' dim_offset ']'
{ $attrs = attributes(); $attrs['kind'] = strKind($1);
$$ = Expr\ArrayDimFetch[new Scalar\String_(Scalar\String_::parse($1), $attrs), $3]; }
{ $attrs = attributes();
TomasVotruba marked this conversation as resolved.
Show resolved Hide resolved
$$ = Expr\ArrayDimFetch[Scalar\String_::fromString($1, $attrs), $3]; }
| constant '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| scalar_dereference '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
/* alternative array syntax missing intentionally */
Expand Down Expand Up @@ -795,8 +795,8 @@ common_scalar:
T_LNUMBER { $$ = $this->parseLNumber($1, attributes(), true); }
| T_DNUMBER { $$ = Scalar\DNumber::fromString($1, attributes()); }
| T_CONSTANT_ENCAPSED_STRING
{ $attrs = attributes(); $attrs['kind'] = strKind($1);
$$ = new Scalar\String_(Scalar\String_::parse($1, false), $attrs); }
{ $attrs = attributes();
$$ = Scalar\String_::fromString($1, $attrs, false); }
| T_LINE { $$ = Scalar\MagicConst\Line[]; }
| T_FILE { $$ = Scalar\MagicConst\File[]; }
| T_DIR { $$ = Scalar\MagicConst\Dir[]; }
Expand Down
4 changes: 2 additions & 2 deletions grammar/php7.y
View file
Open in desktop
Expand Up @@ -1015,8 +1015,8 @@ dereferencable_scalar:
$$ = new Expr\Array_($3, $attrs); }
| array_short_syntax { $$ = $1; }
| T_CONSTANT_ENCAPSED_STRING
{ $attrs = attributes(); $attrs['kind'] = strKind($1);
$$ = new Scalar\String_(Scalar\String_::parse($1), $attrs); }
{ $attrs = attributes();
$$ = Scalar\String_::fromString($1, $attrs); }
| '"' encaps_list '"'
{ $attrs = attributes(); $attrs['kind'] = Scalar\String_::KIND_DOUBLE_QUOTED;
parseEncapsed($2, '"', true); $$ = new Scalar\Encapsed($2, $attrs); }
Expand Down
8 changes: 0 additions & 8 deletions grammar/phpyLang.php
View file
Open in desktop
Expand Up @@ -128,14 +128,6 @@ function($matches) {
. ' else { ' . $args[0] . ' = null; }';
}

if ('strKind' === $name) {
assertArgs(1, $args, $name);

return '(' . $args[0] . '[0] === "\'" || (' . $args[0] . '[1] === "\'" && '
. '(' . $args[0] . '[0] === \'b\' || ' . $args[0] . '[0] === \'B\')) '
. '? Scalar\String_::KIND_SINGLE_QUOTED : Scalar\String_::KIND_DOUBLE_QUOTED)';
}

if ('prependLeadingComments' === $name) {
assertArgs(1, $args, $name);

Expand Down
16 changes: 16 additions & 0 deletions lib/PhpParser/Node/Scalar/String_.php
View file
Open in desktop
Expand Up @@ -42,6 +42,22 @@ public function getSubNodeNames() : array {
return ['value'];
}

/**
* @param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
*/
public static function fromString(string $str, array $attributes = [], bool $parseUnicodeEscape = true): self
{
$attributes['kind'] = ($str[0] === "'" || ($str[1] === "'" && ($str[0] === 'b' || $str[0] === 'B')))
? Scalar\String_::KIND_SINGLE_QUOTED
: Scalar\String_::KIND_DOUBLE_QUOTED;

$attributes['rawValue'] = $str;

$string = self::parse($str, $parseUnicodeEscape);

return new self($string, $attributes);
}

/**
* @internal
*
Expand Down
8 changes: 4 additions & 4 deletions lib/PhpParser/Parser/Php5.php
View file
Open in desktop
Expand Up @@ -2147,8 +2147,8 @@ protected function initReduceCallbacks() {
$this->semValue = new Expr\ArrayDimFetch($this->semStack[$stackPos-(4-1)], $this->semStack[$stackPos-(4-3)], $this->startAttributeStack[$stackPos-(4-1)] + $this->endAttributes);
},
392 => function ($stackPos) {
$attrs = $this->startAttributeStack[$stackPos-(4-1)] + $this->endAttributes; $attrs['kind'] = ($this->semStack[$stackPos-(4-1)][0] === "'" || ($this->semStack[$stackPos-(4-1)][1] === "'" && ($this->semStack[$stackPos-(4-1)][0] === 'b' || $this->semStack[$stackPos-(4-1)][0] === 'B')) ? Scalar\String_::KIND_SINGLE_QUOTED : Scalar\String_::KIND_DOUBLE_QUOTED);
$this->semValue = new Expr\ArrayDimFetch(new Scalar\String_(Scalar\String_::parse($this->semStack[$stackPos-(4-1)]), $attrs), $this->semStack[$stackPos-(4-3)], $this->startAttributeStack[$stackPos-(4-1)] + $this->endAttributes);
$attrs = $this->startAttributeStack[$stackPos-(4-1)] + $this->endAttributes;
$this->semValue = new Expr\ArrayDimFetch(Scalar\String_::fromString($this->semStack[$stackPos-(4-1)], $attrs), $this->semStack[$stackPos-(4-3)], $this->startAttributeStack[$stackPos-(4-1)] + $this->endAttributes);
},
393 => function ($stackPos) {
$this->semValue = new Expr\ArrayDimFetch($this->semStack[$stackPos-(4-1)], $this->semStack[$stackPos-(4-3)], $this->startAttributeStack[$stackPos-(4-1)] + $this->endAttributes);
Expand Down Expand Up @@ -2278,8 +2278,8 @@ protected function initReduceCallbacks() {
$this->semValue = Scalar\DNumber::fromString($this->semStack[$stackPos-(1-1)], $this->startAttributeStack[$stackPos-(1-1)] + $this->endAttributes);
},
435 => function ($stackPos) {
$attrs = $this->startAttributeStack[$stackPos-(1-1)] + $this->endAttributes; $attrs['kind'] = ($this->semStack[$stackPos-(1-1)][0] === "'" || ($this->semStack[$stackPos-(1-1)][1] === "'" && ($this->semStack[$stackPos-(1-1)][0] === 'b' || $this->semStack[$stackPos-(1-1)][0] === 'B')) ? Scalar\String_::KIND_SINGLE_QUOTED : Scalar\String_::KIND_DOUBLE_QUOTED);
$this->semValue = new Scalar\String_(Scalar\String_::parse($this->semStack[$stackPos-(1-1)], false), $attrs);
$attrs = $this->startAttributeStack[$stackPos-(1-1)] + $this->endAttributes;
$this->semValue = Scalar\String_::fromString($this->semStack[$stackPos-(1-1)], $attrs, false);
},
436 => function ($stackPos) {
$this->semValue = new Scalar\MagicConst\Line($this->startAttributeStack[$stackPos-(1-1)] + $this->endAttributes);
Expand Down
4 changes: 2 additions & 2 deletions lib/PhpParser/Parser/Php7.php
View file
Open in desktop
Expand Up @@ -2543,8 +2543,8 @@ protected function initReduceCallbacks() {
$this->semValue = $this->semStack[$stackPos-(1-1)];
},
512 => function ($stackPos) {
$attrs = $this->startAttributeStack[$stackPos-(1-1)] + $this->endAttributes; $attrs['kind'] = ($this->semStack[$stackPos-(1-1)][0] === "'" || ($this->semStack[$stackPos-(1-1)][1] === "'" && ($this->semStack[$stackPos-(1-1)][0] === 'b' || $this->semStack[$stackPos-(1-1)][0] === 'B')) ? Scalar\String_::KIND_SINGLE_QUOTED : Scalar\String_::KIND_DOUBLE_QUOTED);
$this->semValue = new Scalar\String_(Scalar\String_::parse($this->semStack[$stackPos-(1-1)]), $attrs);
$attrs = $this->startAttributeStack[$stackPos-(1-1)] + $this->endAttributes;
$this->semValue = Scalar\String_::fromString($this->semStack[$stackPos-(1-1)], $attrs);
},
513 => function ($stackPos) {
$attrs = $this->startAttributeStack[$stackPos-(3-1)] + $this->endAttributes; $attrs['kind'] = Scalar\String_::KIND_DOUBLE_QUOTED;
Expand Down
20 changes: 20 additions & 0 deletions test/PhpParser/Node/Scalar/StringTest.php
View file
Open in desktop
Expand Up @@ -2,8 +2,28 @@

namespace PhpParser\Node\Scalar;

use PhpParser\Node\Stmt\Echo_;
use PhpParser\ParserFactory;

class StringTest extends \PHPUnit\Framework\TestCase
{
public function testRawValue()
{
$parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
$nodes = $parser->parse('<?php echo "sequence \x41";');

$echo = $nodes[0];
$this->assertInstanceOf(Echo_::class, $echo);

/** @var Echo_ $echo */
$string = $echo->exprs[0];
$this->assertInstanceOf(String_::class, $string);

/** @var String_ $string */
$this->assertSame('sequence A', $string->value);
$this->assertSame('"sequence \\x41"', $string->getAttribute('rawValue'));
}

/**
* @dataProvider provideTestParseEscapeSequences
*/
Expand Down
6 changes: 4 additions & 2 deletions test/PhpParser/NodeAbstractTest.php
View file
Open in desktop
Expand Up @@ -297,7 +297,8 @@ function functionName(&$a = 0, $b = 1.0) {
"attributes": {
"startLine": 5,
"endLine": 5,
"kind": 1
"kind": 1,
"rawValue": "'Foo'"
}
}
],
Expand Down Expand Up @@ -452,7 +453,8 @@ function functionName(&$a = 0, $b = 1.0) {
"attributes": {
"startLine": 5,
"endLine": 5,
"kind": 1
"kind": 1,
"rawValue": "'Foo'"
},
"value": "Foo"
}
Expand Down