Compare commits

..

62 Commits

Author SHA1 Message Date
Nikita Popov
4a21235f7e Update documentation links in README 2024-01-07 18:17:35 +01:00
Nikita Popov
fba1d621c0 Release PHP-Parser 5.0.0 2024-01-07 18:14:20 +01:00
Nikita Popov
5cc5a67004 Upgrading guide tweaks 2024-01-07 18:11:19 +01:00
Nikita Popov
f603e19336 Avoid PHPUnit deprecation warnings 2024-01-07 17:46:24 +01:00
Ondrej Mirtes
1eeeb2d525 Fix parent class of PropertyItem and UseItem 2023-12-22 19:57:32 +01:00
Nikita Popov
255000ad49 Release PHP-Parser 5.0.0rc1 2023-12-20 22:32:29 +01:00
Nikita Popov
f7d484aa0e Fix handling of empty input
Fixes #967.
2023-12-20 21:51:46 +01:00
Nikita Popov
f82a6365a5 Add upgrading nodes for changes since beta1
Fixes #965.
Fixes #966.
2023-12-20 21:36:53 +01:00
Ondřej Mirtes
13a41f05a7 Fix typos in UPGRADE-5.0.md 2023-12-17 21:03:53 +01:00
Ondrej Mirtes
f66650073c Fix NameResolver for class constant native type 2023-11-28 20:10:53 +01:00
Nikita Popov
d0b35126e7 Update CHANGELOG 2023-11-12 17:06:58 +01:00
Nikita Popov
3640d18b87 Remove ParserFactory::create()
Don't try to keep backwards-compatibility with the old factory
style, which doesn't map cleanly onto supported options (we only
have ONLY_PHP7/PREFER_PHP7, which should probably create a Php8
parser in terms of how they are used, but this would no longer
match their names).

Instead, I have backported the new createForNewestSupportedVersion()
and createForHostVersion() methods to PHP-Parser 4.
2023-11-12 16:52:30 +01:00
Théo FIDRY
b54302f363 build: Exclude grammar from export git artifact
(cherry picked from commit 402b6cf345)
2023-11-12 13:04:04 +01:00
Nikita Popov
acfccd9d74 Run with updated php-cs-fixer 2023-11-01 18:50:25 +01:00
Sandro Gehri
eabae1f7fa Fix typo 2023-11-01 18:45:07 +01:00
xjaja
8d50e9d066 Don't drop class statements before error (#952)
When encountering a null statement (indicating that an error occurred),
retain the preceding statements. These were accidentally dropped
previously.

(cherry picked from commit 54103d8387)
2023-10-07 12:22:01 +02:00
Abdul Malik Ikhsan
481fec47f4 Improve performance of find() and findFirst() when passed $nodes is empty array 2023-10-07 12:11:47 +02:00
Nikita Popov
4e27a17cd8 Use visitor to assign comments
This fixes the long-standing issue where a comment would get assigned
to all nodes with the same starting position, instead of only the
outer-most one.

Fixes #253.
2023-09-28 21:45:08 +02:00
Nikita Popov
de84f76766 Avoid by-reference iteration in NodeTraverser
No need to create reference wrappers around every element in the
array.
2023-09-26 20:25:37 +02:00
Nikita Popov
b4183c2b09 Remove Stmt\Throw
This was a backwards-compatibility shim for Expr\Throw.
2023-09-25 18:37:07 +02:00
Nikita Popov
a1ccf57727 Introduce Stmt\Block
Stmt\Block will be created for { $a; } style blocks, unless these
occur directly inside some structure that is usually combined
with a block.

For example if ($a) { $b; } will continue to use the old
representation (plain array in in If_::$stmts), but a free-standing
{ $b; } will become a Stmt\Block.

Fixes #590.
2023-09-24 21:13:01 +02:00
Nikita Popov
f5adbb5e3f Add rawValue to InterpolatedStringPart and doc strings
For doc strings, the rawValue (on either the String_ or
InterpolatedStringPrts) does not include the leading indentation
(which is available as docIndentation) or the trailing newline on
the last part.
2023-09-24 12:55:38 +02:00
Nikita Popov
5edc190bda Add support for dumping additional attributes 2023-09-23 21:36:57 +02:00
Nikita Popov
80851163a6 Assemble NodeDumper result in property
Append to a property instead of returning strings. This is
significantly faster when dumping large ASTs.

This also fixes an inconsistency where the indentation level for
strings and comments was off-by-one.
2023-09-23 20:38:53 +02:00
Nikita Popov
8f175fe7c8 Pass --dry-run to php-cs-fixer
Apparently it only returns the correct exit code with the
--dry-run option.
2023-09-23 18:38:52 +02:00
Nikita Popov
d8e8065313 Don't parse unicode escapes for PHP < 7.0
We still had the option for this but were hardcoding it to true.
Make it conditional on the PHP version instead.
2023-09-23 17:35:51 +02:00
RainX
f4961b89ac Add missing phpdoc annotations in AST nodes (#946) 2023-09-18 21:16:54 +02:00
Nikita Popov
8b9488e1e6 Explicit test new ParserFactory methods 2023-09-17 20:42:25 +02:00
Nikita Popov
21fa9c98b3 Drop some @covers annotations 2023-09-17 20:28:02 +02:00
Nikita Popov
0b3c762939 Update docs table of contents 2023-09-17 20:26:35 +02:00
Nikita Popov
edee19a5d2 Release PHP-Parser 5.0.0 Beta 1 2023-09-17 20:19:48 +02:00
Nikita Popov
ea5ba26749 Add upgrading notes for lexer changes 2023-09-17 20:17:54 +02:00
Nikita Popov
ab51e9d35a Remove superfluous phpdoc tags
These just specify a type that is already specified as a real PHP
type.
2023-09-17 18:24:05 +02:00
Nikita Popov
1873020bf7 Deprecate Node::getLine() in favor of Node::getStartLine() 2023-09-17 16:32:10 +02:00
Nikita Popov
1b346f7935 Remove deprecated Comment methods 2023-09-17 16:30:28 +02:00
Nikita Popov
2d3dd4e23e Don't align phpdoc tags
I did this to start with, but then alignment kept being broken
during refactorings, and at some point I switched to not aligning,
and now we have a big mess.

Add a php-cs-fixer rule to consistently not align phpdoc tags.
2023-09-17 16:00:10 +02:00
Nikita Popov
3c52ea9b6d Document phpVersion effect on pretty printer 2023-09-17 15:52:10 +02:00
Nikita Popov
5a7753a930 Update changelog 2023-09-17 15:28:40 +02:00
Nikita Popov
c91c8633a4 Add PHP 8.3 to CI matrix 2023-09-17 11:59:43 +02:00
Nikita Popov
e395f042d2 Add php-cs-fixer CI job 2023-09-17 11:08:23 +02:00
Nikita Popov
21ead39056 Update docs after lexer changes 2023-09-17 09:07:58 +02:00
Nikita Popov
b11fca0310 Run integration test against PHP 8.3 2023-09-16 09:54:10 +02:00
Nikita Popov
06c7ab51b7 Drop Lexer::getTokens() method
This doesn't make a lot of sense now that Lexer::tokenize() returns
the tokens.

The tokens for the last parse should be fetched via
Parser::getTokens() instead.
2023-09-16 09:50:50 +02:00
Markus Staab
263fa80b81 Use more precise Use_::TYPE_* types (#945)
For better static analysis support in consuming projects.
2023-09-14 10:03:42 +02:00
Nikita Popov
5da5231fde Indent heredoc/nowdoc when targeting PHP >= 7.3 2023-08-27 22:02:31 +02:00
Nikita Popov
8d58380108 Default pretty printer to PHP 7.4 2023-08-27 21:26:47 +02:00
Nikita Popov
efe93a171b Update PHP versions in workflow 2023-08-17 21:40:48 +02:00
Nikita Popov
ea77807592 Add more property types
Some of these are not maximally accurate due to lack of union
types.
2023-08-17 21:36:07 +02:00
Nikita Popov
9a68468fda Update phpstan baseline 2023-08-16 21:38:27 +02:00
Nikita Popov
502b090900 Add property types
Types omitted in two places where we violate them currently:
Namespace_::$stmts can be null during parsing, and Enum_::$scalarType
can be a complex type for invalid programs.
2023-08-16 21:37:02 +02:00
Nikita Popov
3c0432b09d Remove emulation for unsupported PHP versions 2023-08-16 21:09:51 +02:00
Nikita Popov
ee3e7db3fc Raise minimum PHP version to PHP 7.4 2023-08-16 21:06:38 +02:00
Nikita Popov
ba851243f4 Replace startLexing() with tokenize()
For now Lexer::getTokens() still exists, but should probably be
removed.
2023-08-13 16:06:10 +02:00
Nikita Popov
d1d784a5c6 Fixup line numbers when applying emulator patches
This fixes the test failures on PHP 7.2.
2023-08-13 12:59:26 +02:00
Nikita Popov
62853b179c Fix PhpStan errors 2023-08-13 12:45:21 +02:00
Nikita Popov
4b497045e0 Move attribute handling into parser
The Lexer now only provides the tokens to the parser, while the
parser is responsible for determining which attributes are placed
on notes. This only needs to be done when the attributes are
actually needed, rather than for all tokens.

This removes the usedAttributes lexer option (and lexer options
entirely). The attributes are now enabled unconditionally. They
have less overhead now, and the need to explicitly enable them for
some use cases (e.g. formatting-preserving printing) doesn't seem
like a good tradeoff anymore.

There are some additional changes to the Lexer interface that
should be done after this, and the docs / upgrading guide haven't
been adjusted yet.
2023-08-13 10:40:21 +02:00
Nikita Popov
b20267c5ad Make use of default actions
For the default action $$ = $1, save the closure invocation.
2023-07-09 21:18:21 +02:00
Nikita Popov
748aab3365 Don't set start attributes for whitespace
These will get overwritten later anyway.
2023-07-09 15:47:37 +02:00
Nikita Popov
c48ee36f54 Allow passing visitors to NodeTraverser constructor 2023-07-09 15:34:31 +02:00
Nikita Popov
8b1371990c Minor documentation updates 2023-07-09 15:34:31 +02:00
Abdul Malik Ikhsan
eaa1d91b4e Early return false after VariadicPlaceholder check on CallLike::isFirstClassCallable() (#924)
VariadicPlaceholder can only occur as the first (and only) argument, so avoid a loop to check for it.
2023-06-25 18:38:11 +02:00
Danny van der Sluijs
3fb4b92f59 Update main.yml to use GitHub Actions V3
Updates the GitHub Actions from V2 to V3

(cherry picked from commit 1d0748ad35)
2023-06-24 17:59:49 +02:00
256 changed files with 5476 additions and 6198 deletions

1
.gitattributes vendored
View File

@@ -1,5 +1,6 @@
/.github export-ignore /.github export-ignore
/doc export-ignore /doc export-ignore
/grammar export-ignore
/test export-ignore /test export-ignore
/test_old export-ignore /test_old export-ignore
/tools export-ignore /tools export-ignore

View File

@@ -7,15 +7,15 @@ on:
jobs: jobs:
tests_coverage: tests_coverage:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
name: "PHP 7.1 Unit Tests (with coverage)" name: "PHP 7.4 Unit Tests (with coverage)"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: "actions/checkout@v2" uses: "actions/checkout@v3"
- name: "Install PHP" - name: "Install PHP"
uses: "shivammathur/setup-php@v2" uses: "shivammathur/setup-php@v2"
with: with:
coverage: "xdebug" coverage: "xdebug"
php-version: "7.1" php-version: "7.4"
tools: composer:v2 tools: composer:v2
- name: "Install dependencies" - name: "Install dependencies"
run: | run: |
@@ -34,15 +34,13 @@ jobs:
strategy: strategy:
matrix: matrix:
php-version: php-version:
- "7.2"
- "7.3"
- "7.4"
- "8.0" - "8.0"
- "8.1" - "8.1"
- "8.2" - "8.2"
- "8.3"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: "actions/checkout@v2" uses: "actions/checkout@v3"
- name: "Install PHP" - name: "Install PHP"
uses: "shivammathur/setup-php@v2" uses: "shivammathur/setup-php@v2"
with: with:
@@ -55,54 +53,67 @@ jobs:
run: "php vendor/bin/phpunit" run: "php vendor/bin/phpunit"
test_old_73_80: test_old_73_80:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
name: "PHP 7.3 Code on PHP 8.0 Integration Tests" name: "PHP 7.4 Code on PHP 8.2 Integration Tests"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: "actions/checkout@v2" uses: "actions/checkout@v3"
- name: "Install PHP" - name: "Install PHP"
uses: "shivammathur/setup-php@v2" uses: "shivammathur/setup-php@v2"
with: with:
coverage: "none" coverage: "none"
php-version: "8.0" php-version: "8.2"
tools: composer:v2 tools: composer:v2
- name: "Install PHP 8 dependencies" - name: "Install PHP 8 dependencies"
run: "composer update --no-progress --prefer-dist" run: "composer update --no-progress --prefer-dist"
- name: "Tests" - name: "Tests"
run: "test_old/run-php-src.sh 7.3.21" run: "test_old/run-php-src.sh 7.4.33"
test_old_80_70: test_old_80_70:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
name: "PHP 8.2 Code on PHP 7.1 Integration Tests" name: "PHP 8.3 Code on PHP 7.4 Integration Tests"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: "actions/checkout@v2" uses: "actions/checkout@v3"
- name: "Install PHP" - name: "Install PHP"
uses: "shivammathur/setup-php@v2" uses: "shivammathur/setup-php@v2"
with: with:
coverage: "none" coverage: "none"
php-version: "7.1" php-version: "7.4"
tools: composer:v2 tools: composer:v2
- name: "Install PHP 8 dependencies" - name: "Install PHP 8 dependencies"
run: "composer update --no-progress --prefer-dist" run: "composer update --no-progress --prefer-dist"
- name: "Tests" - name: "Tests"
run: "test_old/run-php-src.sh 8.2.3" run: "test_old/run-php-src.sh 8.3.0RC2"
phpstan: phpstan:
runs-on: "ubuntu-latest" runs-on: "ubuntu-latest"
name: "PHP ${{ matrix.php-version }} PHPStan" name: "PHPStan"
strategy:
matrix:
php-version:
- "8.2"
steps: steps:
- name: "Checkout" - name: "Checkout"
uses: "actions/checkout@v2" uses: "actions/checkout@v3"
- name: "Install PHP" - name: "Install PHP"
uses: "shivammathur/setup-php@v2" uses: "shivammathur/setup-php@v2"
with: with:
coverage: "none" coverage: "none"
php-version: "${{ matrix.php-version }}" php-version: "8.2"
tools: composer:v2 tools: composer:v2
- name: "Install dependencies" - name: "Install dependencies"
run: | run: |
cd tools && composer install cd tools && composer install
- name: "PHPStan" - name: "PHPStan"
run: "php tools/vendor/bin/phpstan" run: "php tools/vendor/bin/phpstan"
php-cs-fixer:
runs-on: "ubuntu-latest"
name: "PHP-CS-Fixer"
steps:
- name: "Checkout"
uses: "actions/checkout@v3"
- name: "Install PHP"
uses: "shivammathur/setup-php@v2"
with:
coverage: "none"
php-version: "8.2"
tools: composer:v2
- name: "Install dependencies"
run: |
cd tools && composer install
- name: "php-cs-fixer"
run: "php tools/vendor/bin/php-cs-fixer fix --dry-run"

View File

@@ -21,6 +21,11 @@ return $config->setRiskyAllowed(true)
'declare_strict_types' => true, 'declare_strict_types' => true,
// Keep argument formatting for now. // Keep argument formatting for now.
'method_argument_space' => ['on_multiline' => 'ignore'], 'method_argument_space' => ['on_multiline' => 'ignore'],
'phpdoc_align' => ['align' => 'left'],
'phpdoc_trim' => true,
'no_empty_phpdoc' => true,
'no_superfluous_phpdoc_tags' => ['allow_mixed' => true],
'no_extra_blank_lines' => true,
]) ])
->setFinder($finder) ->setFinder($finder)
; ;

View File

@@ -1,3 +1,79 @@
Version 5.0.0 (2024-01-07)
--------------------------
See UPGRADE-5.0 for detailed migration instructions.
### Fixed
* Fixed parent class of `PropertyItem` and `UseItem`.
Version 5.0.0-rc1 (2023-12-20)
------------------------------
See UPGRADE-5.0 for detailed migration instructions.
### Fixed
* Fixed parsing of empty files.
### Added
* Added support for printing additional attributes (like `kind`) in `NodeDumper`.
* Added `rawValue` attribute to `InterpolatedStringPart` and heredoc/nowdoc `String_`s, which
provides the original, unparsed value. It was previously only available for non-interpolated
single/double quoted strings.
* Added `Stmt\Block` to represent `{}` code blocks. Previously, such code blocks were flattened
into the parent statements array. `Stmt\Block` will not be created for structures that are
typically used with code blocks, for example `if ($x) { $y; }` will be represented as previously,
while `if ($x) { { $x; } }` will have an extra `Stmt\Block` wrapper.
### Changed
* Use visitor to assign comments. This fixes the long-standing issue where comments were assigned
to all nodes sharing a starting position. Now only the outer-most node will hold the comments.
* Don't parse unicode escape sequences when targeting PHP < 7.0.
* Improve NodeDumper performance for large dumps.
### Removed
* Removed `Stmt\Throw_` node, use `Expr\Throw_` inside `Stmt\Expression` instead.
* Removed `ParserFactory::create()`.
Version 5.0.0-beta1 (2023-09-17)
--------------------------------
See UPGRADE-5.0 for detailed migration instructions.
### Added
* Visitors can now be passed directly to the `NodeTraverser` constructor. A separate call to
`addVisitor()` is no longer required.
### Changed
* The minimum host PHP version is now PHP 7.4. It is still possible to parse code from older
versions. Property types have been added where possible.
* The `Lexer` no longer accepts options. `Lexer\Emulative` only accepts a `PhpVersion`. The
`startLexing()`, `getTokens()` and `handleHaltCompiler()` methods have been removed. Instead,
there is a single method `tokenize()` returning the tokens.
* The `Parser::getLexer()` method has been replaced by `Parser::getTokens()`.
* Attribute handling has been moved from the lexer to the parser, and is no longer configurable.
The comments, startLine, endLine, startTokenPos, endTokenPos, startFilePos, and endFilePos
attributes will always be added.
* The pretty printer now defaults to PHP 7.4 as the target version.
* The pretty printer now indents heredoc/nowdoc strings if the target version is >= 7.3
(flexible heredoc/nowdoc).
### Removed
* The deprecated `Comment::getLine()`, `Comment::getTokenPos()` and `Comment::getFilePos()` methods
have been removed. Use `Comment::getStartLine()`, `Comment::getStartTokenPos()` and
`Comment::getStartFilePos()` instead.
### Deprecated
* The `Node::getLine()` method has been deprecated. Use `Node::getStartLine()` instead.
Version 5.0.0-alpha3 (2023-06-24) Version 5.0.0-alpha3 (2023-06-24)
--------------------------------- ---------------------------------

10
Makefile Normal file
View File

@@ -0,0 +1,10 @@
.PHONY: phpstan php-cs-fixer
tools/vendor:
composer install -d tools
phpstan: tools/vendor
tools/vendor/bin/phpstan
php-cs-fixer: tools/vendor
tools/vendor/bin/php-cs-fixer fix

View File

@@ -6,11 +6,9 @@ PHP Parser
This is a PHP parser written in PHP. Its purpose is to simplify static code analysis and This is a PHP parser written in PHP. Its purpose is to simplify static code analysis and
manipulation. manipulation.
[Documentation for version 5.x][doc_master] (in development; for running on PHP >= 7.1; for parsing PHP 7.0 to PHP 8.2, with limited support for parsing PHP 5.x). [**Documentation for version 5.x**][doc_master] (current; for running on PHP >= 7.4; for parsing PHP 7.0 to PHP 8.3, with limited support for parsing PHP 5.x).
[**Documentation for version 4.x**][doc_4_x] (stable; for running on PHP >= 7.0; for parsing PHP 5.2 to PHP 8.2). [Documentation for version 4.x][doc_4_x] (supported; for running on PHP >= 7.0; for parsing PHP 5.2 to PHP 8.3).
[Documentation for version 3.x][doc_3_x] (unsupported; for running on PHP >= 5.5; for parsing PHP 5.2 to PHP 7.2).
Features Features
-------- --------
@@ -213,9 +211,8 @@ Component documentation:
* [AST builders](doc/component/AST_builders.markdown) * [AST builders](doc/component/AST_builders.markdown)
* Fluent builders for AST nodes * Fluent builders for AST nodes
* [Lexer](doc/component/Lexer.markdown) * [Lexer](doc/component/Lexer.markdown)
* Lexer options * Emulation
* Token and file positions for nodes * Tokens, positions and attributes
* Custom attributes
* [Error handling](doc/component/Error_handling.markdown) * [Error handling](doc/component/Error_handling.markdown)
* Column information for errors * Column information for errors
* Error recovery (parsing of syntactically incorrect code) * Error recovery (parsing of syntactically incorrect code)

View File

@@ -3,7 +3,7 @@ Upgrading from PHP-Parser 4.x to 5.0
### PHP version requirements ### PHP version requirements
PHP-Parser now requires PHP 7.1 or newer to run. It is however still possible to *parse* code for older versions, while running on a newer version. PHP-Parser now requires PHP 7.4 or newer to run. It is however still possible to *parse* code for older versions, while running on a newer version.
### PHP 5 parsing support ### PHP 5 parsing support
@@ -13,6 +13,7 @@ In particular, if an older `PhpVersion` is specified, then:
* For versions before PHP 7.0, `$foo =& new Bar()` assignments are allowed without error. * For versions before PHP 7.0, `$foo =& new Bar()` assignments are allowed without error.
* For versions before PHP 7.0, invalid octal literals `089` are allowed without error. * For versions before PHP 7.0, invalid octal literals `089` are allowed without error.
* For versions before PHP 7.0, unicode escape sequences `\u{123}` in strings are not parsed.
* Type hints are interpreted as a class `Name` or as a built-in `Identifier` depending on PHP * Type hints are interpreted as a class `Name` or as a built-in `Identifier` depending on PHP
version, for example `int` is treated as a class name on PHP 5.6 and as a built-in on PHP 7.0. version, for example `int` is treated as a class name on PHP 5.6 and as a built-in on PHP 7.0.
@@ -27,16 +28,17 @@ The following symbols are affected by this removal:
* The `PhpParser\Parser\Php5` class has been removed. * The `PhpParser\Parser\Php5` class has been removed.
* The `PhpParser\Parser\Multiple` class has been removed. While not strictly related to PHP 5 support, this functionality is no longer useful without it. * The `PhpParser\Parser\Multiple` class has been removed. While not strictly related to PHP 5 support, this functionality is no longer useful without it.
* The `PhpParser\ParserFactory::ONLY_PHP5` and `PREFER_PHP5` options have been removed. * The `PhpParser\ParserFactory::ONLY_PHP5` and `PREFER_PHP5` options have been removed.
* The `PhpParser\ParserFactory::PREFER_PHP7` option is now equivalent to `ONLY_PHP7`.
### Changes to the parser factory ### Changes to the parser factory
The `ParserFactory::create()` method is deprecated in favor of three new methods that provide more fine-grained control over the PHP version being targeted: The `ParserFactory::create()` method has been removed in favor of three new methods that provide more fine-grained control over the PHP version being targeted:
* `createForNewestSupportedVersion()`: Use this if you don't know the PHP version of the code you're parsing. It's better to assume a too new version than a too old one. * `createForNewestSupportedVersion()`: Use this if you don't know the PHP version of the code you're parsing. It's better to assume a too new version than a too old one.
* `createForHostVersion()`: Use this if you're parsing code for the PHP version you're running on. * `createForHostVersion()`: Use this if you're parsing code for the PHP version you're running on.
* `createForVersion()`: Use this if you know the PHP version of the code you want to parse. * `createForVersion()`: Use this if you know the PHP version of the code you want to parse.
The `createForNewestSupportedVersion()` and `creatForHostVersion()` are available since PHP-Parser 4.18.0, to allow libraries to support PHP-Parser 4 and 5 at the same time more easily.
In all cases, the PHP version is a fairly weak hint that is only used on a best-effort basis. The parser will usually accept code for newer versions if it does not have any backwards-compatibility implications. In all cases, the PHP version is a fairly weak hint that is only used on a best-effort basis. The parser will usually accept code for newer versions if it does not have any backwards-compatibility implications.
For example, if you specify version `"8.0"`, then `class ReadOnly {}` is treated as a valid class declaration, while using `public readonly int $prop` will lead to a parse error. However, `final public const X = Y;` will be accepted in both cases. For example, if you specify version `"8.0"`, then `class ReadOnly {}` is treated as a valid class declaration, while using `public readonly int $prop` will lead to a parse error. However, `final public const X = Y;` will be accepted in both cases.
@@ -45,7 +47,7 @@ For example, if you specify version `"8.0"`, then `class ReadOnly {}` is treated
use PhpParser\ParserFactory; use PhpParser\ParserFactory;
use PhpParser\PhpVersion; use PhpParser\PhpVersion;
$factory = new ParserFactory; $factory = new ParserFactory();
# Before # Before
$parser = $factory->create(ParserFactory::PREFER_PHP7); $parser = $factory->create(ParserFactory::PREFER_PHP7);
@@ -61,6 +63,35 @@ $parser = $factory->create(ParserFactory::ONLY_PHP5);
$parser = $factory->createForVersion(PhpVersion::fromString("5.6")); $parser = $factory->createForVersion(PhpVersion::fromString("5.6"));
``` ```
### Changes to the throw representation
Previously, `throw` statements like `throw $e;` were represented using the `Stmt\Throw_` class,
while uses inside other expressions (such as `$x ?? throw $e`) used the `Expr\Throw_` class.
Now, `throw $e;` is represented as a `Stmt\Expression` that contains an `Expr\Throw_`. The
`Stmt\Throw_` class has been removed.
```php
# Code
throw $e;
# Before
Stmt_Throw(
expr: Expr_Variable(
name: e
)
)
# After
Stmt_Expression(
expr: Expr_Throw(
expr: Expr_Variable(
name: e
)
)
)
```
### Changes to the array destructuring representation ### Changes to the array destructuring representation
Previously, the `list($x) = $y` destructuring syntax was represented using a `Node\Expr\List_` Previously, the `list($x) = $y` destructuring syntax was represented using a `Node\Expr\List_`
@@ -71,6 +102,49 @@ Now, destructuring is always represented using `Node\Expr\List_`. The `kind` att
`Node\Expr\List_::KIND_LIST` or `Node\Expr\List_::KIND_ARRAY` specifies which syntax was actually `Node\Expr\List_::KIND_LIST` or `Node\Expr\List_::KIND_ARRAY` specifies which syntax was actually
used. used.
```php
# Code
[$x] = $y;
# Before
Expr_Assign(
var: Expr_Array(
items: array(
0: Expr_ArrayItem(
key: null
value: Expr_Variable(
name: x
)
byRef: false
unpack: false
)
)
)
expr: Expr_Variable(
name: y
)
)
# After
Expr_Assign(
var: Expr_List(
items: array(
0: ArrayItem(
key: null
value: Expr_Variable(
name: x
)
byRef: false
unpack: false
)
)
)
expr: Expr_Variable(
name: y
)
)
```
### Changes to the name representation ### Changes to the name representation
Previously, `Name` nodes had a `parts` subnode, which stores an array of name parts, split by Previously, `Name` nodes had a `parts` subnode, which stores an array of name parts, split by
@@ -82,6 +156,123 @@ now represented by `Name(name: 'Foo\Bar')` instead.
It is possible to convert the name to the previous representation using `$name->getParts()`. The It is possible to convert the name to the previous representation using `$name->getParts()`. The
`Name` constructor continues to accept both the string and the array representation. `Name` constructor continues to accept both the string and the array representation.
The `Name::getParts()` method is available since PHP-Parser 4.16.0, to allow libraries to support
PHP-Parser 4 and 5 at the same time more easily.
### Changes to the block representation
Previously, code blocks `{ ... }` were always flattened into their parent statement list. For
example `while ($x) { $a; { $b; } $c; }` would produce the same node structure as
`if ($x) { $a; $b; $c; }`, namely a `Stmt\While_` node whose `stmts` subnode is an array of three
statements.
Now, the nested `{ $b; }` block is represented using an explicit `Stmt\Block` node. However, the
outer `{ $a; { $b; } $c; }` block is still represented using a simple array in the `stmts` subnode.
```php
# Code
while ($x) { $a; { $b; } $c; }
# Before
Stmt_While(
cond: Expr_Variable(
name: x
)
stmts: array(
0: Stmt_Expression(
expr: Expr_Variable(
name: a
)
)
1: Stmt_Expression(
expr: Expr_Variable(
name: b
)
)
2: Stmt_Expression(
expr: Expr_Variable(
name: c
)
)
)
)
# After
Stmt_While(
cond: Expr_Variable(
name: x
)
stmts: array(
0: Stmt_Expression(
expr: Expr_Variable(
name: a
)
)
1: Stmt_Block(
stmts: array(
0: Stmt_Expression(
expr: Expr_Variable(
name: b
)
)
)
)
2: Stmt_Expression(
expr: Expr_Variable(
name: c
)
)
)
)
```
### Changes to comment assignment
Previously, comments were assigned to all nodes starting at the same position. Now they will be
assigned to the outermost node only.
```php
# Code
// Comment
$a + $b;
# Before
Stmt_Expression(
expr: Expr_BinaryOp_Plus(
left: Expr_Variable(
name: a
comments: array(
0: // Comment
)
)
right: Expr_Variable(
name: b
)
comments: array(
0: // Comment
)
)
comments: array(
0: // Comment
)
)
# After
Stmt_Expression(
expr: Expr_BinaryOp_Plus(
left: Expr_Variable(
name: a
)
right: Expr_Variable(
name: b
)
)
comments: array(
0: // Comment
)
)
```
### Renamed nodes ### Renamed nodes
A number of AST nodes have been renamed or moved in the AST hierarchy: A number of AST nodes have been renamed or moved in the AST hierarchy:
@@ -104,7 +295,7 @@ The old class names have been retained as aliases for backwards compatibility. H
Modifier flags (as used by the `$flags` subnode of `Class_`, `ClassMethod`, `Property`, etc.) are now available as class constants on a separate `PhpParser\Modifiers` class, instead of being part of `PhpParser\Node\Stmt\Class_`, to make it clearer that these are used by many different nodes. The old constants are deprecated, but are still available. Modifier flags (as used by the `$flags` subnode of `Class_`, `ClassMethod`, `Property`, etc.) are now available as class constants on a separate `PhpParser\Modifiers` class, instead of being part of `PhpParser\Node\Stmt\Class_`, to make it clearer that these are used by many different nodes. The old constants are deprecated, but are still available.
``` ```php
PhpParser\Node\Stmt\Class_::MODIFIER_PUBLIC -> PhpParser\Modifiers::PUBLIC PhpParser\Node\Stmt\Class_::MODIFIER_PUBLIC -> PhpParser\Modifiers::PUBLIC
PhpParser\Node\Stmt\Class_::MODIFIER_PROTECTED -> PhpParser\Modifiers::PROTECTED PhpParser\Node\Stmt\Class_::MODIFIER_PROTECTED -> PhpParser\Modifiers::PROTECTED
PhpParser\Node\Stmt\Class_::MODIFIER_PRIVATE -> PhpParser\Modifiers::PRIVATE PhpParser\Node\Stmt\Class_::MODIFIER_PRIVATE -> PhpParser\Modifiers::PRIVATE
@@ -126,7 +317,7 @@ Node constructor arguments accepting types now longer accept plain strings. Eith
* The `$type` argument of `Node\NullableType`. * The `$type` argument of `Node\NullableType`.
* The `$type` argument of `Node\Param`. * The `$type` argument of `Node\Param`.
* The `$type` argument of `Node\Stmt\Property`. * The `$type` argument of `Node\Stmt\Property`.
* The `$type` argument of `Node\ClassConst` (new in PHP-Parser 5.0, listed for completeness only). * The `$type` argument of `Node\ClassConst`.
To follow the previous behavior, an `Identifier` should be passed, which indicates a built-in type. To follow the previous behavior, an `Identifier` should be passed, which indicates a built-in type.
@@ -198,12 +389,13 @@ else if ($x) {
} }
``` ```
The pretty printer now accepts a `phpVersion` option, which accepts a `PhpVersion` object and defaults to PHP 7.1. The pretty printer will make formatting choices to make the code valid for that version. It currently controls the following behavior: The pretty printer now accepts a `phpVersion` option, which accepts a `PhpVersion` object and defaults to PHP 7.4. The pretty printer will make formatting choices to make the code valid for that version. It currently controls the following behavior:
* For PHP >= 7.0 (default), short array syntax `[]` will be used by default. This does not affect nodes that specify an explicit array syntax using the `kind` attribute. * For PHP >= 7.0 (default), short array syntax `[]` will be used by default. This does not affect nodes that specify an explicit array syntax using the `kind` attribute.
* For PHP >= 7.0 (default), parentheses around `yield` expressions will only be printed when necessary. Previously, parentheses were always printed, even if `yield` was used as a statement. * For PHP >= 7.0 (default), parentheses around `yield` expressions will only be printed when necessary. Previously, parentheses were always printed, even if `yield` was used as a statement.
* For PHP >= 7.1 (default), the short array syntax `[]` will be used for destructuring by default (instead of `list()`). This does not affect nodes that specify and explicit syntax using the `kind` attribute. * For PHP >= 7.1 (default), the short array syntax `[]` will be used for destructuring by default (instead of `list()`). This does not affect nodes that specify an explicit syntax using the `kind` attribute.
* For PHP >= 7.3, a newline is no longer forced after heredoc/nowdoc strings, as the requirement for this has been removed with the introduction of flexible heredoc/nowdoc strings. * For PHP >= 7.3 (default), a newline is no longer forced after heredoc/nowdoc strings, as the requirement for this has been removed with the introduction of flexible heredoc/nowdoc strings.
* For PHP >= 7.3 (default), heredoc/nowdoc strings are now indented just like regular code. This was allowed with the introduction of flexible heredoc/nowdoc strings.
### Changes to precedence handling in the pretty printer ### Changes to precedence handling in the pretty printer
@@ -219,7 +411,7 @@ protected function p(
The `$precedence` is the precedence of the direct parent operator (if any), while `$lhsPrecedence` is that precedence of the nearest binary operator on whose left-hand-side the node occurs. For unary operators, only the `$lhsPrecedence` is relevant. The `$precedence` is the precedence of the direct parent operator (if any), while `$lhsPrecedence` is that precedence of the nearest binary operator on whose left-hand-side the node occurs. For unary operators, only the `$lhsPrecedence` is relevant.
Recursive calls in pretty-printer methods should generally continue calling `p()` without additional parameters. However, pretty-printer methods for operators that participate in precedence resolution need to be adjusted. For example, typical implementations for operators looks as follows now: Recursive calls in pretty-printer methods should generally continue calling `p()` without additional parameters. However, pretty-printer methods for operators that participate in precedence resolution need to be adjusted. For example, typical implementations for operators look as follows now:
```php ```php
protected function pExpr_BinaryOp_Plus( protected function pExpr_BinaryOp_Plus(
@@ -265,6 +457,17 @@ PhpParser\NodeTraverser::DONT_TRAVERSE_CURRENT_AND_CHILDREN -> PhpParser\NodeVis
PhpParser\NodeTraverser::STOP_TRAVERSAL -> PhpParser\NodeVisitor::STOP_TRAVERSAL PhpParser\NodeTraverser::STOP_TRAVERSAL -> PhpParser\NodeVisitor::STOP_TRAVERSAL
``` ```
Visitors can now also be passed directly to the `NodeTraverser` constructor:
```php
# Before (and still supported)
$traverser = new NodeTraverser();
$traverser->addVisitor(new NameResolver());
# After
$traverser = new NodeTraverser(new NameResolver());
```
### Changes to token representation ### Changes to token representation
Tokens are now internally represented using the `PhpParser\Token` class, which exposes the same base interface as Tokens are now internally represented using the `PhpParser\Token` class, which exposes the same base interface as
@@ -282,11 +485,50 @@ class Token {
} }
``` ```
The `Lexer::getTokens()` method will now return an array of `Token`s, rather than an array of arrays and strings. The token array is now an array of `Token`s, rather than an array of arrays and strings.
Additionally, the token array is now terminated by a sentinel token with ID 0. Additionally, the token array is now terminated by a sentinel token with ID 0.
### Changes to the lexer
The lexer API is reduced to a single `Lexer::tokenize()` method, which returns an array of tokens. The `startLexing()` and `getNextToken()` methods have been removed.
Responsibility for determining start and end attributes for nodes has been moved from the lexer to the parser. The lexer no longer accepts an options array. The `usedAttributes` option has been removed without replacement, and the parser will now unconditionally add the `comments`, `startLine`, `endLine`, `startFilePos`, `endFilePos`, `startTokenPos` and `endTokenPos` attributes.
There should no longer be a need to directly interact with the `Lexer` for end users, as the `ParserFactory` will create an appropriate instance, and no additional configuration of the lexer is necessary. To use formatting-preserving pretty printing, the setup boilerplate changes as follows:
```php
# Before
$lexer = new Lexer\Emulative([
'usedAttributes' => [
'comments',
'startLine', 'endLine',
'startTokenPos', 'endTokenPos',
],
]);
$parser = new Parser\Php7($lexer);
$oldStmts = $parser->parse($code);
$oldTokens = $lexer->getTokens();
$traverser = new NodeTraverser();
$traverser->addVisitor(new NodeVisitor\CloningVisitor());
$newStmts = $traverser->traverse($oldStmts);
# After
$parser = (new ParserFactory())->createForNewestSupportedVersion();
$oldStmts = $parser->parse($code);
$oldTokens = $lexer->getTokens();
$traverser = new NodeTraverser(new NodeVisitor\CloningVisitor());
$newStmts = $traverser->traverse($oldStmts);
```
### Miscellaneous changes ### Miscellaneous changes
* The deprecated `Builder\Param::setTypeHint()` method has been removed in favor of `Builder\Param::setType()`. * The deprecated `Builder\Param::setTypeHint()` method has been removed in favor of `Builder\Param::setType()`.
* The deprecated `Error` constructor taking a start line has been removed. Pass `['startLine' => $startLine]` attributes instead. * The deprecated `Error` constructor taking a start line has been removed. Pass `['startLine' => $startLine]` attributes instead.
* `Comment::getReformattedText()` now normalizes CRLF newlines to LF newlines. * The deprecated `Comment::getLine()`, `Comment::getTokenPos()` and `Comment::getFilePos()` methods have been removed. Use `Comment::getStartLine()`, `Comment::getStartTokenPos()` and `Comment::getStartFilePos()` instead.
* `Comment::getReformattedText()` now normalizes CRLF newlines to LF newlines.
* The `Node::getLine()` method has been deprecated. Use `Node::getStartLine()` instead.

View File

@@ -26,10 +26,7 @@ if (empty($files)) {
showHelp("Must specify at least one file."); showHelp("Must specify at least one file.");
} }
$lexerOptions = ['usedAttributes' => [ $parser = (new PhpParser\ParserFactory())->createForVersion($attributes['version']);
'startLine', 'endLine', 'startFilePos', 'endFilePos', 'comments'
]];
$parser = (new PhpParser\ParserFactory())->createForVersion($attributes['version'], $lexerOptions);
$dumper = new PhpParser\NodeDumper([ $dumper = new PhpParser\NodeDumper([
'dumpComments' => true, 'dumpComments' => true,
'dumpPositions' => $attributes['with-positions'], 'dumpPositions' => $attributes['with-positions'],

View File

@@ -13,7 +13,7 @@
} }
], ],
"require": { "require": {
"php": ">=7.1", "php": ">=7.4",
"ext-tokenizer": "*", "ext-tokenizer": "*",
"ext-json": "*", "ext-json": "*",
"ext-ctype": "*" "ext-ctype": "*"

View File

@@ -13,14 +13,14 @@ application dealing with code programmatically. A parser constructs an [Abstract
There are other ways of processing source code. One that PHP supports natively is using the There are other ways of processing source code. One that PHP supports natively is using the
token stream generated by [`token_get_all`][2]. The token stream is much more low level than token stream generated by [`token_get_all`][2]. The token stream is much more low level than
the AST and thus has different applications: It allows to also analyze the exact formatting of the AST and thus has different applications: It allows to also analyze the exact formatting of
a file. On the other hand the token stream is much harder to deal with for more complex analysis. a file. On the other hand, the token stream is much harder to deal with for more complex analysis.
For example, an AST abstracts away the fact that, in PHP, variables can be written as `$foo`, but also For example, an AST abstracts away the fact that, in PHP, variables can be written as `$foo`, but also
as `$$bar`, `${'foobar'}` or even `${!${''}=barfoo()}`. You don't have to worry about recognizing as `$$bar`, `${'foobar'}` or even `${!${''}=barfoo()}`. You don't have to worry about recognizing
all the different syntaxes from a stream of tokens. all the different syntaxes from a stream of tokens.
Another question is: Why would I want to have a PHP parser *written in PHP*? Well, PHP might not be Another question is: Why would I want to have a PHP parser *written in PHP*? Well, PHP might not be
a language especially suited for fast parsing, but processing the AST is much easier in PHP than it a language especially suited for fast parsing, but processing the AST is much easier in PHP than it
would be in other, faster languages like C. Furthermore the people most probably wanting to do would be in other, faster languages like C. Furthermore the people most likely wanting to do
programmatic PHP code analysis are incidentally PHP developers, not C developers. programmatic PHP code analysis are incidentally PHP developers, not C developers.
What can it parse? What can it parse?
@@ -43,7 +43,7 @@ following caveats:
As the parser is based on the tokens returned by `token_get_all` (which is only able to lex the PHP As the parser is based on the tokens returned by `token_get_all` (which is only able to lex the PHP
version it runs on), additionally a wrapper for emulating tokens from newer versions is provided. version it runs on), additionally a wrapper for emulating tokens from newer versions is provided.
This allows to parse PHP 8.0 source code running on PHP 7.1, for example. This emulation is not This allows to parse PHP 8.3 source code running on PHP 7.4, for example. This emulation is not
perfect, but works well in practice. perfect, but works well in practice.
Finally, it should be noted that the parser aims to accept all valid code, not reject all invalid Finally, it should be noted that the parser aims to accept all valid code, not reject all invalid
@@ -81,16 +81,16 @@ However, it does retain accurate position information, which can be used to insp
What else can it do? What else can it do?
-------------------- --------------------
Apart from the parser itself this package also bundles support for some other, related features: Apart from the parser itself, this package also bundles support for some other, related features:
* Support for pretty printing, which is the act of converting an AST into PHP code. Please note * Support for pretty printing, which is the act of converting an AST into PHP code. Please note
that "pretty printing" does not imply that the output is especially pretty. It's just how it's that "pretty printing" does not imply that the output is especially pretty. It's just how it's
called ;) called ;)
* Support for serializing and unserializing the node tree to JSON * Support for serializing and unserializing the node tree to JSON.
* Support for dumping the node tree in a human-readable form (see the section above for an * Support for dumping the node tree in a human-readable form (see the section above for an
example of how the output looks like) example of how the output looks like).
* Infrastructure for traversing and changing the AST (node traverser and node visitors) * Infrastructure for traversing and changing the AST (node traverser and node visitors).
* A node visitor for resolving namespaced names * A node visitor for resolving namespaced names.
[0]: http://en.wikipedia.org/wiki/Static_program_analysis [0]: http://en.wikipedia.org/wiki/Static_program_analysis
[1]: http://en.wikipedia.org/wiki/Abstract_syntax_tree [1]: http://en.wikipedia.org/wiki/Abstract_syntax_tree

View File

@@ -50,7 +50,7 @@ The `createXYZ()` methods optionally accept an array of lexer options. Some use
customized lexer options are discussed in the [lexer documentation](component/Lexer.markdown). customized lexer options are discussed in the [lexer documentation](component/Lexer.markdown).
Subsequently, you can pass PHP code (including the opening `<?php` tag) to the `parse()` method in Subsequently, you can pass PHP code (including the opening `<?php` tag) to the `parse()` method in
order to create a syntax tree. If a syntax error is encountered, an `PhpParser\Error` exception will order to create a syntax tree. If a syntax error is encountered, a `PhpParser\Error` exception will
be thrown by default: be thrown by default:
```php ```php
@@ -72,7 +72,7 @@ try {
$stmts = $parser->parse($code); $stmts = $parser->parse($code);
// $stmts is an array of statement nodes // $stmts is an array of statement nodes
} catch (Error $e) { } catch (Error $e) {
echo 'Parse Error: ', $e->getMessage(); echo 'Parse Error: ', $e->getMessage(), "\n";
} }
``` ```
@@ -206,11 +206,13 @@ without the `PhpParser\Node\` prefix and `\` replaced with `_`. It also does not
It is possible to associate custom metadata with a node using the `setAttribute()` method. This data It is possible to associate custom metadata with a node using the `setAttribute()` method. This data
can then be retrieved using `hasAttribute()`, `getAttribute()` and `getAttributes()`. can then be retrieved using `hasAttribute()`, `getAttribute()` and `getAttributes()`.
By default the lexer adds the `startLine`, `endLine` and `comments` attributes. `comments` is an array By default, the parser adds the `startLine`, `endLine`, `startTokenPos`, `endTokenPos`,
of `PhpParser\Comment[\Doc]` instances. `startFilePos`, `endFilePos` and `comments` attributes. `comments` is an array of
`PhpParser\Comment[\Doc]` instances.
The start line can also be accessed using `getStartLine()` (instead of `getAttribute('startLine')`). The pre-defined attributes can also be accessed using `getStartLine()` instead of
The last doc comment from the `comments` attribute can be obtained using `getDocComment()`. `getAttribute('startLine')`, and so on. The last doc comment from the `comments` attribute can be
obtained using `getDocComment()`.
Pretty printer Pretty printer
-------------- --------------
@@ -244,7 +246,7 @@ try {
echo $code; echo $code;
} catch (Error $e) { } catch (Error $e) {
echo 'Parse Error: ', $e->getMessage(); echo 'Parse Error: ', $e->getMessage(), "\n";
} }
``` ```
@@ -252,7 +254,7 @@ The above code will output:
echo 'Hello ', hi\getTarget(); echo 'Hello ', hi\getTarget();
As you can see the source code was first parsed using `PhpParser\Parser->parse()`, then changed and then As you can see, the source code was first parsed using `PhpParser\Parser->parse()`, then changed and then
again converted to code using `PhpParser\PrettyPrinter\Standard->prettyPrint()`. again converted to code using `PhpParser\PrettyPrinter\Standard->prettyPrint()`.
The `prettyPrint()` method pretty prints a statements array. It is also possible to pretty print only a The `prettyPrint()` method pretty prints a statements array. It is also possible to pretty print only a
@@ -393,7 +395,7 @@ declarations that contains the namespaced name instead of only the shortname tha
Example: Converting namespaced code to pseudo namespaces Example: Converting namespaced code to pseudo namespaces
-------------------------------------------------------- --------------------------------------------------------
A small example to understand the concept: We want to convert namespaced code to pseudo namespaces A small example to understand the concept: We want to convert namespaced code to pseudo namespaces,
so it works on 5.2, i.e. names like `A\\B` should be converted to `A_B`. Note that such conversions so it works on 5.2, i.e. names like `A\\B` should be converted to `A_B`. Note that such conversions
are fairly complicated if you take PHP's dynamic features into account, so our conversion will are fairly complicated if you take PHP's dynamic features into account, so our conversion will
assume that no dynamic features are used. assume that no dynamic features are used.
@@ -445,7 +447,7 @@ foreach ($files as $file) {
} }
``` ```
Now lets start with the main code, the `NodeVisitor\NamespaceConverter`. One thing it needs to do Now lets start with the main code, the `NamespaceConverter`. One thing it needs to do
is convert `A\\B` style names to `A_B` style ones. is convert `A\\B` style names to `A_B` style ones.
```php ```php

View File

@@ -27,9 +27,8 @@ Component documentation
* [AST builders](component/AST_builders.markdown) * [AST builders](component/AST_builders.markdown)
* Fluent builders for AST nodes * Fluent builders for AST nodes
* [Lexer](component/Lexer.markdown) * [Lexer](component/Lexer.markdown)
* Lexer options * Emulation
* Token and file positions for nodes * Tokens, positions and attributes
* Custom attributes
* [Error handling](component/Error_handling.markdown) * [Error handling](component/Error_handling.markdown)
* Column information for errors * Column information for errors
* Error recovery (parsing of syntactically incorrect code) * Error recovery (parsing of syntactically incorrect code)

View File

@@ -15,9 +15,10 @@ accessed through `getNode()`. Fluent builders are available for
the following syntactic elements: the following syntactic elements:
* namespaces and use statements * namespaces and use statements
* classes, interfaces and traits * classes, interfaces, traits and enums
* methods, functions and parameters * methods, functions and parameters
* properties * properties, class constants and enum cases
* trait uses and trait use adaptations
Here is an example: Here is an example:
@@ -95,13 +96,13 @@ abstract class SomeOtherClass extends SomeClass implements A\Few, \Interfaces
AnotherTrait::func insteadof SecondTrait; AnotherTrait::func insteadof SecondTrait;
} }
protected $someProperty; protected $someProperty;
private $anotherProperty = array(1, 2, 3); private $anotherProperty = [1, 2, 3];
/** /**
* This method does something. * This method does something.
* *
* @param SomeClass And takes a parameter * @param SomeClass And takes a parameter
*/ */
public abstract function someMethod(SomeClass $someParam): bool; abstract public function someMethod(SomeClass $someParam): bool;
protected function anotherMethod($someParam = 'test') protected function anotherMethod($someParam = 'test')
{ {
print $someParam; print $someParam;
@@ -133,6 +134,8 @@ nodes. The following methods are currently available:
* `propertyFetch($var, $name)`: Creates a property fetch node. Converts `$name` to an `Identifier` * `propertyFetch($var, $name)`: Creates a property fetch node. Converts `$name` to an `Identifier`
node. node.
* `concat(...$exprs)`: Create a tree of `BinaryOp\Concat` nodes for the given expressions. * `concat(...$exprs)`: Create a tree of `BinaryOp\Concat` nodes for the given expressions.
* `attribute($name, $args)`: Create a `Attribute` node. Converts `$name` to a `Name` node and
normalizes arguments.
These methods may be expanded on an as-needed basis. Please open an issue or PR if a common These methods may be expanded on an as-needed basis. Please open an issue or PR if a common
operation is missing. operation is missing.

View File

@@ -70,6 +70,7 @@ expressions, apart from the following:
* `Expr\ConstFetch` (only null/false/true are handled) * `Expr\ConstFetch` (only null/false/true are handled)
* `Expr\ClassConstFetch` * `Expr\ClassConstFetch`
* `Expr\New_` (since PHP 8.1) * `Expr\New_` (since PHP 8.1)
* `Expr\PropertyFetch` (since PHP 8.2)
Handling these expression types requires non-local information, such as which global constants are Handling these expression types requires non-local information, such as which global constants are
defined. By default, the evaluator will throw a `ConstExprEvaluationException` when it encounters defined. By default, the evaluator will throw a `ConstExprEvaluationException` when it encounters
@@ -84,7 +85,7 @@ specifying an evaluation fallback function:
use PhpParser\{ConstExprEvaluator, ConstExprEvaluationException}; use PhpParser\{ConstExprEvaluator, ConstExprEvaluationException};
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
$evalutator = new ConstExprEvaluator(function(Expr $expr) { $evaluator = new ConstExprEvaluator(function(Expr $expr) {
if ($expr instanceof Expr\ConstFetch) { if ($expr instanceof Expr\ConstFetch) {
return fetchConstantSomehow($expr); return fetchConstantSomehow($expr);
} }
@@ -97,7 +98,7 @@ $evalutator = new ConstExprEvaluator(function(Expr $expr) {
}); });
try { try {
$evalutator->evaluateSilently($someExpr); $evaluator->evaluateSilently($someExpr);
} catch (ConstExprEvaluationException $e) { } catch (ConstExprEvaluationException $e) {
// Handle exception // Handle exception
} }

View File

@@ -4,29 +4,12 @@ Error handling
Errors during parsing or analysis are represented using the `PhpParser\Error` exception class. In addition to an error Errors during parsing or analysis are represented using the `PhpParser\Error` exception class. In addition to an error
message, an error can also store additional information about the location the error occurred at. message, an error can also store additional information about the location the error occurred at.
How much location information is available depends on the origin of the error and how many lexer attributes have been How much location information is available depends on the origin of the error. At a minimum the start line of the error
enabled. At a minimum the start line of the error is usually available. is usually available.
Column information Column information
------------------ ------------------
In order to receive information about not only the line, but also the column span an error occurred at, the file
position attributes in the lexer need to be enabled:
```php
$lexerOptions = array(
'usedAttributes' => array('comments', 'startLine', 'endLine', 'startFilePos', 'endFilePos'),
);
$parser = (new PhpParser\ParserFactory())->createForHostVersion($lexerOptions);
try {
$stmts = $parser->parse($code);
// ...
} catch (PhpParser\Error $e) {
// ...
}
```
Before using column information, its availability needs to be checked with `$e->hasColumnInfo()`, as the precise Before using column information, its availability needs to be checked with `$e->hasColumnInfo()`, as the precise
location of an error cannot always be determined. The methods for retrieving column information also have to be passed location of an error cannot always be determined. The methods for retrieving column information also have to be passed
the source code of the parsed file. An example for printing an error: the source code of the parsed file. An example for printing an error:

View File

@@ -16,8 +16,7 @@ use PhpParser\ParserFactory;
$code = '...'; $code = '...';
$traverser = new NodeTraverser; $traverser = new NodeTraverser(new ParentConnectingVisitor);
$traverser->addVisitor(new ParentConnectingVisitor);
$parser = (new ParserFactory())->createForHostVersion(); $parser = (new ParserFactory())->createForHostVersion();
$ast = $parser->parse($code); $ast = $parser->parse($code);
@@ -39,8 +38,7 @@ use PhpParser\ParserFactory;
$code = '...'; $code = '...';
$traverser = new NodeTraverser; $traverser = new NodeTraverser(new NodeConnectingVisitor);
$traverser->addVisitor(new NodeConnectingVisitor);
$parser = (new ParserFactory())->createForHostVersion(); $parser = (new ParserFactory())->createForHostVersion();
$ast = $parser->parse($code); $ast = $parser->parse($code);

View File

@@ -35,65 +35,6 @@ This will result in the following output (which includes attributes):
[ [
{ {
"nodeType": "Stmt_Function", "nodeType": "Stmt_Function",
"byRef": false,
"name": {
"nodeType": "Identifier",
"name": "printLine",
"attributes": {
"startLine": 4,
"endLine": 4
}
},
"params": [
{
"nodeType": "Param",
"type": null,
"byRef": false,
"variadic": false,
"var": {
"nodeType": "Expr_Variable",
"name": "msg",
"attributes": {
"startLine": 4,
"endLine": 4
}
},
"default": null,
"attributes": {
"startLine": 4,
"endLine": 4
}
}
],
"returnType": null,
"stmts": [
{
"nodeType": "Stmt_Echo",
"exprs": [
{
"nodeType": "Expr_Variable",
"name": "msg",
"attributes": {
"startLine": 5,
"endLine": 5
}
},
{
"nodeType": "Scalar_String",
"value": "\n",
"attributes": {
"startLine": 5,
"endLine": 5,
"kind": 2
}
}
],
"attributes": {
"startLine": 5,
"endLine": 5
}
}
],
"attributes": { "attributes": {
"startLine": 4, "startLine": 4,
"comments": [ "comments": [
@@ -101,12 +42,79 @@ This will result in the following output (which includes attributes):
"nodeType": "Comment_Doc", "nodeType": "Comment_Doc",
"text": "\/** @param string $msg *\/", "text": "\/** @param string $msg *\/",
"line": 3, "line": 3,
"filePos": 9, "filePos": 7,
"tokenPos": 2 "tokenPos": 2,
"endLine": 3,
"endFilePos": 31,
"endTokenPos": 2
} }
], ],
"endLine": 6 "endLine": 6
} },
"byRef": false,
"name": {
"nodeType": "Identifier",
"attributes": {
"startLine": 4,
"endLine": 4
},
"name": "printLine"
},
"params": [
{
"nodeType": "Param",
"attributes": {
"startLine": 4,
"endLine": 4
},
"type": null,
"byRef": false,
"variadic": false,
"var": {
"nodeType": "Expr_Variable",
"attributes": {
"startLine": 4,
"endLine": 4
},
"name": "msg"
},
"default": null,
"flags": 0,
"attrGroups": []
}
],
"returnType": null,
"stmts": [
{
"nodeType": "Stmt_Echo",
"attributes": {
"startLine": 5,
"endLine": 5
},
"exprs": [
{
"nodeType": "Expr_Variable",
"attributes": {
"startLine": 5,
"endLine": 5
},
"name": "msg"
},
{
"nodeType": "Scalar_String",
"attributes": {
"startLine": 5,
"endLine": 5
"kind": 2,
"rawValue": "\"\\n\""
},
"value": "\n"
}
]
}
],
"attrGroups": [],
"namespacedName": null
} }
] ]
``` ```

View File

@@ -1,41 +1,79 @@
Lexer component documentation Lexer component documentation
============================= =============================
The lexer is responsible for providing tokens to the parser. The project comes with two lexers: `PhpParser\Lexer` and The lexer is responsible for providing tokens to the parser. Typical use of the library does not require direct
`PhpParser\Lexer\Emulative`. The latter is an extension of the former, which adds the ability to emulate tokens of interaction with the lexer, as an appropriate lexer is created by `PhpParser\ParserFactory`. The tokens produced
newer PHP versions and thus allows parsing of new code on older versions. by the lexer can then be retrieved using `PhpParser\Parser::getTokens()`.
This documentation discusses options available for the default lexers and explains how lexers can be extended. Emulation
---------
Lexer options While this library implements a custom parser, it relies on PHP's `ext/tokenizer` extension to perform lexing. However,
------------- this extension only supports lexing code for the PHP version you are running on, while this library also wants to support
parsing newer code. For that reason, the lexer performs additional "emulation" in three layers:
The two default lexers accept an `$options` array in the constructor. Currently only the `'usedAttributes'` option is First, PhpParser uses the `PhpToken` based representation introduced in PHP 8.0, rather than the array-based tokens from
supported, which allows you to specify which attributes will be added to the AST nodes. The attributes can then be previous versions. The `PhpParser\Token` class either extends `PhpToken` (on PHP 8.0) or a polyfill implementation. The
accessed using `$node->getAttribute()`, `$node->setAttribute()`, `$node->hasAttribute()` and `$node->getAttributes()` polyfill implementation will also perform two emulations that are required by the parser and cannot be disabled:
methods. A sample options array:
* Single-line comments use the PHP 8.0 representation that does not include a trailing newline. The newline will be
part of a following `T_WHITESPACE` token.
* Namespaced names use the PHP 8.0 representation using `T_NAME_FULLY_QUALIFIED`, `T_NAME_QUALIFIED` and
`T_NAME_RELATIVE` tokens, rather than the previous representation using a sequence of `T_STRING` and `T_NS_SEPARATOR`.
This means that certain code that is legal on older versions (namespaced names including whitespace, such as `A \ B`)
will not be accepted by the parser.
Second, the `PhpParser\Lexer` base class will convert `&` tokens into the PHP 8.1 representation of either
`T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG` or `T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG`. This is required by the parser
and cannot be disabled.
Finally, `PhpParser\Lexer\Emulative` performs other, optional emulations. This lexer is parameterized by `PhpVersion`
and will try to emulate `ext/tokenizer` output for that version. This is done using separate `TokenEmulator`s for each
emulated feature.
Emulation is usually used to support newer PHP versions, but there is also very limited support for reverse emulation to
older PHP versions, which can make keywords from newer versions non-reserved.
Tokens, positions and attributes
--------------------------------
The `Lexer::tokenize()` method returns an array of `PhpParser\Token`s. The most important parts of the interface can be
summarized as follows:
```php ```php
$lexer = new PhpParser\Lexer(array( class Token {
'usedAttributes' => array( /** @var int Token ID, either T_* or ord($char) for single-character tokens. */
'comments', 'startLine', 'endLine' public int $id;
) /** @var string The textual content of the token. */
)); public string $text;
/** @var int The 1-based starting line of the token (or -1 if unknown). */
public int $line;
/** @var int The 0-based starting position of the token (or -1 if unknown). */
public int $pos;
/** @param int|string|(int|string)[] $kind Token ID or text (or array of them) */
public function is($kind): bool;
}
``` ```
The attributes used in this example match the default behavior of the lexer. The following attributes are supported: Unlike PHP's own `PhpToken::tokenize()` output, the token array is terminated by a sentinel token with ID 0.
* `comments`: Array of `PhpParser\Comment` or `PhpParser\Comment\Doc` instances, representing all comments that occurred The lexer is normally invoked implicitly by the parser. In that case, the tokens for the last parse can be retrieved
between the previous non-discarded token and the current one. Use of this attribute is required for the using `Parser::getTokens()`.
`$node->getComments()` and `$node->getDocComment()` methods to work. The attribute is also needed if you wish the pretty
printer to retain comments present in the original code. Nodes in the AST produced by the parser always corresponds to some range of tokens. The parser adds a number of
* `startLine`: Line in which the node starts. This attribute is required for the `$node->getLine()` to work. It is also positioning attributes to allow mapping nodes back to lines, tokens or file offsets:
required if syntax errors should contain line number information.
* `endLine`: Line in which the node ends. Required for `$node->getEndLine()`. * `startLine`: Line in which the node starts. Used by `$node->getStartLine()`.
* `startTokenPos`: Offset into the token array of the first token in the node. Required for `$node->getStartTokenPos()`. * `endLine`: Line in which the node ends. Used by `$node->getEndLine()`.
* `endTokenPos`: Offset into the token array of the last token in the node. Required for `$node->getEndTokenPos()`. * `startTokenPos`: Offset into the token array of the first token in the node. Used by `$node->getStartTokenPos()`.
* `startFilePos`: Offset into the code string of the first character that is part of the node. Required for `$node->getStartFilePos()`. * `endTokenPos`: Offset into the token array of the last token in the node. Used by `$node->getEndTokenPos()`.
* `endFilePos`: Offset into the code string of the last character that is part of the node. Required for `$node->getEndFilePos()`. * `startFilePos`: Offset into the code string of the first character that is part of the node. Used by `$node->getStartFilePos()`.
* `endFilePos`: Offset into the code string of the last character that is part of the node. Used by `$node->getEndFilePos()`.
Note that `start`/`end` here are closed rather than half-open ranges. This means that a node consisting of a single
token will have `startTokenPos == endTokenPos` rather than `startTokenPos + 1 == endTokenPos`. This also means that a
zero-length node will have `startTokenPos -1 == endTokenPos`.
### Using token positions ### Using token positions
@@ -73,89 +111,16 @@ class MyNodeVisitor extends PhpParser\NodeVisitorAbstract {
} }
} }
$lexerOptions = array(
'usedAttributes' => array(
'comments', 'startLine', 'endLine', 'startTokenPos', 'endTokenPos'
)
);
$parser = (new PhpParser\ParserFactory())->createForHostVersion($lexerOptions); $parser = (new PhpParser\ParserFactory())->createForHostVersion($lexerOptions);
$visitor = new MyNodeVisitor(); $visitor = new MyNodeVisitor();
$traverser = new PhpParser\NodeTraverser(); $traverser = new PhpParser\NodeTraverser($visitor);
$traverser->addVisitor($visitor);
try { try {
$stmts = $parser->parse($code); $stmts = $parser->parse($code);
$visitor->setTokens($lexer->getTokens()); $visitor->setTokens($parser->getTokens());
$stmts = $traverser->traverse($stmts); $stmts = $traverser->traverse($stmts);
} catch (PhpParser\Error $e) { } catch (PhpParser\Error $e) {
echo 'Parse Error: ', $e->getMessage(); echo 'Parse Error: ', $e->getMessage();
} }
``` ```
The same approach can also be used to perform specific modifications in the code, without changing the formatting in
other places (which is the case when using the pretty printer).
Lexer extension
---------------
A lexer has to define the following public interface:
```php
function startLexing(string $code, ErrorHandler $errorHandler = null): void;
function getTokens(): array;
function handleHaltCompiler(): string;
function getNextToken(string &$value = null, array &$startAttributes = null, array &$endAttributes = null): int;
```
The `startLexing()` method is invoked whenever the `parse()` method of the parser is called and is passed the source
code that is to be lexed (including the opening tag). It can be used to reset state or preprocess the source code or tokens. The
passed `ErrorHandler` should be used to report lexing errors.
The `getTokens()` method returns the current array of `PhpParser\Token`s, which are compatible with the PHP 8 `PhpToken`
class. This method is not used by the parser (which uses `getNextToken()`), but is useful in combination with the token
position attributes.
The `handleHaltCompiler()` method is called whenever a `T_HALT_COMPILER` token is encountered. It has to return the
remaining string after the construct (not including `();`).
The `getNextToken()` method returns the ID of the next token (in the sense of `Token::$id`). If no more
tokens are available it must return `0`, which is the ID of the `EOF` token. Furthermore, the string content of the
token should be written into the by-reference `$value` parameter (which will then be available as `$n` in the parser).
### Attribute handling
The other two by-ref variables `$startAttributes` and `$endAttributes` define which attributes will eventually be
assigned to the generated nodes: The parser will take the `$startAttributes` from the first token which is part of the
node and the `$endAttributes` from the last token that is part of the node.
E.g. if the tokens `T_FUNCTION T_STRING ... '{' ... '}'` constitute a node, then the `$startAttributes` from the
`T_FUNCTION` token will be taken and the `$endAttributes` from the `'}'` token.
An application of custom attributes is storing the exact original formatting of literals: While the parser does retain
some information about the formatting of integers (like decimal vs. hexadecimal) or strings (like used quote type), it
does not preserve the exact original formatting (e.g. leading zeros for integers or escape sequences in strings). This
can be remedied by storing the original value in an attribute:
```php
use PhpParser\Lexer;
use PhpParser\Parser\Tokens;
class KeepOriginalValueLexer extends Lexer // or Lexer\Emulative
{
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) {
$tokenId = parent::getNextToken($value, $startAttributes, $endAttributes);
if ($tokenId == \T_CONSTANT_ENCAPSED_STRING // non-interpolated string
|| $tokenId == \T_ENCAPSED_AND_WHITESPACE // interpolated string
|| $tokenId == \T_LNUMBER // integer
|| $tokenId == \T_DNUMBER // floating point number
) {
// could also use $startAttributes, doesn't really matter here
$endAttributes['originalValue'] = $value;
}
return $tokenId;
}
}
```

View File

@@ -24,7 +24,7 @@ $stmts = $nodeTraverser->traverse($stmts);
In the default configuration, the name resolver will perform three actions: In the default configuration, the name resolver will perform three actions:
* Declarations of functions, classes, interfaces, traits and global constants will have a * Declarations of functions, classes, interfaces, traits, enums and global constants will have a
`namespacedName` property added, which contains the function/class/etc name including the `namespacedName` property added, which contains the function/class/etc name including the
namespace prefix. For historic reasons this is a **property** rather than an attribute. namespace prefix. For historic reasons this is a **property** rather than an attribute.
* Names will be replaced by fully qualified resolved names, which are instances of * Names will be replaced by fully qualified resolved names, which are instances of
@@ -32,7 +32,7 @@ In the default configuration, the name resolver will perform three actions:
* Unqualified function and constant names inside a namespace cannot be statically resolved. Inside * Unqualified function and constant names inside a namespace cannot be statically resolved. Inside
a namespace `Foo`, a call to `strlen()` may either refer to the namespaced `\Foo\strlen()`, or a namespace `Foo`, a call to `strlen()` may either refer to the namespaced `\Foo\strlen()`, or
the global `\strlen()`. Because PHP-Parser does not have the necessary context to decide this, the global `\strlen()`. Because PHP-Parser does not have the necessary context to decide this,
such names are left unresolved. Additionally a `namespacedName` **attribute** is added to the such names are left unresolved. Additionally, a `namespacedName` **attribute** is added to the
name node. name node.
The name resolver accepts an option array as the second argument, with the following default values: The name resolver accepts an option array as the second argument, with the following default values:
@@ -47,7 +47,7 @@ $nameResolver = new PhpParser\NodeVisitor\NameResolver(null, [
If the `preserveOriginalNames` option is enabled, then the resolved (fully qualified) name will have If the `preserveOriginalNames` option is enabled, then the resolved (fully qualified) name will have
an `originalName` attribute, which contains the unresolved name. an `originalName` attribute, which contains the unresolved name.
If the `replaceNodes` option is disabled, then names will no longer be resolved in-place. Instead a If the `replaceNodes` option is disabled, then names will no longer be resolved in-place. Instead, a
`resolvedName` attribute will be added to each name, which contains the resolved (fully qualified) `resolvedName` attribute will be added to each name, which contains the resolved (fully qualified)
name. Once again, if an unqualified function or constant name cannot be resolved, then the name. Once again, if an unqualified function or constant name cannot be resolved, then the
`resolvedName` attribute will not be present, and instead a `namespacedName` attribute is added. `resolvedName` attribute will not be present, and instead a `namespacedName` attribute is added.
@@ -75,7 +75,7 @@ class NameContext {
} }
``` ```
The `$type` parameters accept on of the `Stmt\Use_::TYPE_*` constants, which represent the three The `$type` parameters accept one of the `Stmt\Use_::TYPE_*` constants, which represent the three
basic symbol types in PHP (functions, constants and everything else). basic symbol types in PHP (functions, constants and everything else).
Next to name resolution, the `NameContext` also supports the reverse operation of finding a short Next to name resolution, the `NameContext` also supports the reverse operation of finding a short

View File

@@ -40,5 +40,5 @@ parse multiple files.
When possible, objects should be reused rather than being newly instantiated for every use. Some When possible, objects should be reused rather than being newly instantiated for every use. Some
objects have expensive initialization procedures, which will be unnecessarily repeated if the object objects have expensive initialization procedures, which will be unnecessarily repeated if the object
is not reused. (Currently two objects with particularly expensive setup are lexers and pretty is not reused. (Currently two objects with particularly expensive setup are parsers and pretty
printers, though the details might change between versions of this library.) printers, though the details might change between versions of this library.)

View File

@@ -31,17 +31,29 @@ expression.
Customizing the formatting Customizing the formatting
-------------------------- --------------------------
The pretty printer respects a number of `kind` attributes used by some notes (e.g., whether an The pretty printer respects a number of `kind` attributes used by some nodes (e.g., whether an
integer should be printed as decimal, hexadecimal, etc). Additionally, it supports three options: integer should be printed as decimal, hexadecimal, etc). Additionally, it supports three options:
* `phpVersion` (defaults to 7.1) allows opting into formatting that is not supported by older PHP * `phpVersion` (defaults to 7.4) allows opting into formatting that is not supported by older PHP
versions. versions.
* `newline` (defaults to `"\n"`) can be set to `"\r\n"` in order to produce Windows newlines. * `newline` (defaults to `"\n"`) can be set to `"\r\n"` in order to produce Windows newlines.
* `shortArraySyntax` determines the used array syntax if the `kind` attribute is not set. This is * `shortArraySyntax` determines the used array syntax if the `kind` attribute is not set. This is
a legacy option, and `phpVersion` should be used to control this behavior instead. a legacy option, and `phpVersion` should be used to control this behavior instead.
However, the default pretty printer does not provide any functionality for fine-grained The behaviors controlled by `phpVersion` (defaults to PHP 7.4) are:
customization of code formatting.
* For PHP >= 7.0, short array syntax `[]` will be used by default. This does not affect nodes that
specify an explicit array syntax using the `kind` attribute.
* For PHP >= 7.0, parentheses around `yield` expressions will only be printed when necessary.
* For PHP >= 7.1, the short array syntax `[]` will be used for destructuring by default (instead of
`list()`). This does not affect nodes that specify and explicit syntax using the `kind` attribute.
* For PHP >= 7.3, a newline is no longer forced after heredoc/nowdoc strings, as the requirement
for this has been removed with the introduction of flexible heredoc/nowdoc strings.
* For PHP >= 7.3, heredoc/nowdoc strings are indented just like regular code. This was allowed with
the introduction of flexible heredoc/nowdoc strings.
The default pretty printer does not provide functionality for fine-grained customization of code
formatting.
If you want to make minor changes to the formatting, the easiest way is to extend the pretty printer If you want to make minor changes to the formatting, the easiest way is to extend the pretty printer
and override the methods responsible for the node types you are interested in. and override the methods responsible for the node types you are interested in.
@@ -64,29 +76,19 @@ code which has been modified or newly inserted.
Use of the formatting-preservation functionality requires some additional preparatory steps: Use of the formatting-preservation functionality requires some additional preparatory steps:
```php ```php
use PhpParser\{Lexer, NodeTraverser, NodeVisitor, ParserFactory, PrettyPrinter}; use PhpParser\{NodeTraverser, NodeVisitor, ParserFactory, PrettyPrinter};
$lexerOptions = new [
'usedAttributes' => [
'comments',
'startLine', 'endLine',
'startTokenPos', 'endTokenPos',
],
];
$parser = (new ParserFactory())->createForHostVersion($lexerOptions);
$traverser = new NodeTraverser();
$traverser->addVisitor(new NodeVisitor\CloningVisitor());
$printer = new PrettyPrinter\Standard();
$parser = (new ParserFactory())->createForHostVersion();
$oldStmts = $parser->parse($code); $oldStmts = $parser->parse($code);
$oldTokens = $parser->getLexer()->getTokens(); $oldTokens = $parser->getTokens();
// Run CloningVisitor before making changes to the AST.
$traverser = new NodeTraverser(new NodeVisitor\CloningVisitor());
$newStmts = $traverser->traverse($oldStmts); $newStmts = $traverser->traverse($oldStmts);
// MODIFY $newStmts HERE // MODIFY $newStmts HERE
$printer = new PrettyPrinter\Standard();
$newCode = $printer->printFormatPreserving($newStmts, $oldStmts, $oldTokens); $newCode = $printer->printFormatPreserving($newStmts, $oldStmts, $oldTokens);
``` ```
@@ -95,5 +97,5 @@ If you make use of the name resolution functionality, you will likely want to di
the AST and causing spurious changes to the pretty printed code. For more information, see the the AST and causing spurious changes to the pretty printed code. For more information, see the
[name resolution documentation](Name_resolution.markdown). [name resolution documentation](Name_resolution.markdown).
The formatting-preservation works on a best-effort basis and may sometimes reformat more code tha The formatting-preservation works on a best-effort basis and may sometimes reformat more code than
necessary. If you encounter problems while using this functionality, please open an issue. necessary. If you encounter problems while using this functionality, please open an issue.

View File

@@ -21,6 +21,18 @@ $stmts = ...;
$modifiedStmts = $traverser->traverse($stmts); $modifiedStmts = $traverser->traverse($stmts);
``` ```
Visitors can be either passed to the `NodeTraverser` constructor, or added using `addVisitor()`:
```php
$traverser = new NodeTraverser($visitor1, $visitor2, $visitor3);
// Equivalent to:
$traverser = new NodeTraverser();
$traverser->addVisitor($visitor1);
$traverser->addVisitor($visitor2);
$traverser->addVisitor($visitor3);
```
Node visitors Node visitors
------------- -------------
@@ -47,20 +59,19 @@ For example, if we have the following excerpt of an AST
``` ```
Expr_FuncCall( Expr_FuncCall(
name: Name( name: Name(
parts: array( name: printLine
0: printLine )
) args: array(
) 0: Arg(
args: array( name: null
0: Arg( value: Scalar_String(
value: Scalar_String( value: Hello World!!!
value: Hello World!!! )
) byRef: false
byRef: false unpack: false
unpack: false )
) )
)
) )
``` ```
@@ -348,5 +359,6 @@ be accessed: From parents to children. However, it can often be convenient to op
reverse direction: When working on a node, you might want to check if the parent node satisfies a reverse direction: When working on a node, you might want to check if the parent node satisfies a
certain property. certain property.
PHP-Parser does not add parent (or sibling) references to nodes by itself, but you can easily PHP-Parser does not add parent (or sibling) references to nodes by default, but you can enable them
emulate this with a visitor. See the [FAQ](FAQ.markdown) for more information. using the `ParentConnectingVisitor` or `NodeConnectingVisitor`. See the [FAQ](FAQ.markdown) for
more information.

View File

@@ -28,68 +28,68 @@ class #(-p) extends \PhpParser\ParserAbstract
public const %s = %n; public const %s = %n;
#endtokenval #endtokenval
protected $tokenToSymbolMapSize = #(YYMAXLEX); protected int $tokenToSymbolMapSize = #(YYMAXLEX);
protected $actionTableSize = #(YYLAST); protected int $actionTableSize = #(YYLAST);
protected $gotoTableSize = #(YYGLAST); protected int $gotoTableSize = #(YYGLAST);
protected $invalidSymbol = #(YYBADCH); protected int $invalidSymbol = #(YYBADCH);
protected $errorSymbol = #(YYINTERRTOK); protected int $errorSymbol = #(YYINTERRTOK);
protected $defaultAction = #(YYDEFAULT); protected int $defaultAction = #(YYDEFAULT);
protected $unexpectedTokenRule = #(YYUNEXPECTED); protected int $unexpectedTokenRule = #(YYUNEXPECTED);
protected $YY2TBLSTATE = #(YY2TBLSTATE); protected int $YY2TBLSTATE = #(YY2TBLSTATE);
protected $numNonLeafStates = #(YYNLSTATES); protected int $numNonLeafStates = #(YYNLSTATES);
protected $symbolToName = array( protected array $symbolToName = array(
#listvar terminals #listvar terminals
); );
protected $tokenToSymbol = array( protected array $tokenToSymbol = array(
#listvar yytranslate #listvar yytranslate
); );
protected $action = array( protected array $action = array(
#listvar yyaction #listvar yyaction
); );
protected $actionCheck = array( protected array $actionCheck = array(
#listvar yycheck #listvar yycheck
); );
protected $actionBase = array( protected array $actionBase = array(
#listvar yybase #listvar yybase
); );
protected $actionDefault = array( protected array $actionDefault = array(
#listvar yydefault #listvar yydefault
); );
protected $goto = array( protected array $goto = array(
#listvar yygoto #listvar yygoto
); );
protected $gotoCheck = array( protected array $gotoCheck = array(
#listvar yygcheck #listvar yygcheck
); );
protected $gotoBase = array( protected array $gotoBase = array(
#listvar yygbase #listvar yygbase
); );
protected $gotoDefault = array( protected array $gotoDefault = array(
#listvar yygdefault #listvar yygdefault
); );
protected $ruleToNonTerminal = array( protected array $ruleToNonTerminal = array(
#listvar yylhs #listvar yylhs
); );
protected $ruleToLength = array( protected array $ruleToLength = array(
#listvar yylen #listvar yylen
); );
#if -t #if -t
protected $productions = array( protected array $productions = array(
#production-strings; #production-strings;
); );
#endif #endif
@@ -101,9 +101,7 @@ class #(-p) extends \PhpParser\ParserAbstract
%b %b
}, },
#noact #noact
%n => function ($stackPos) { %n => null,
$this->semValue = $this->semStack[$stackPos];
},
#endreduce #endreduce
]; ];
} }

View File

@@ -134,7 +134,7 @@ top_statement_list_ex:
top_statement_list: top_statement_list:
top_statement_list_ex top_statement_list_ex
{ makeZeroLengthNop($nop, $this->lookaheadStartAttributes); { makeZeroLengthNop($nop);
if ($nop !== null) { $1[] = $nop; } $$ = $1; } if ($nop !== null) { $1[] = $nop; } $$ = $1; }
; ;
@@ -185,7 +185,7 @@ namespace_name:
; ;
legacy_namespace_name: legacy_namespace_name:
namespace_name { $$ = $1; } namespace_name
| T_NAME_FULLY_QUALIFIED { $$ = Name[substr($1, 1)]; } | T_NAME_FULLY_QUALIFIED { $$ = Name[substr($1, 1)]; }
; ;
@@ -229,15 +229,15 @@ attributes:
optional_attributes: optional_attributes:
/* empty */ { $$ = []; } /* empty */ { $$ = []; }
| attributes { $$ = $1; } | attributes
; ;
top_statement: top_statement:
statement { $$ = $1; } statement
| function_declaration_statement { $$ = $1; } | function_declaration_statement
| class_declaration_statement { $$ = $1; } | class_declaration_statement
| T_HALT_COMPILER '(' ')' ';' | T_HALT_COMPILER '(' ')' ';'
{ $$ = Stmt\HaltCompiler[$this->lexer->handleHaltCompiler()]; } { $$ = Stmt\HaltCompiler[$this->handleHaltCompiler()]; }
| T_NAMESPACE namespace_declaration_name semi | T_NAMESPACE namespace_declaration_name semi
{ $$ = Stmt\Namespace_[$2, null]; { $$ = Stmt\Namespace_[$2, null];
$$->setAttribute('kind', Stmt\Namespace_::KIND_SEMICOLON); $$->setAttribute('kind', Stmt\Namespace_::KIND_SEMICOLON);
@@ -252,7 +252,7 @@ top_statement:
$this->checkNamespace($$); } $this->checkNamespace($$); }
| T_USE use_declarations semi { $$ = Stmt\Use_[$2, Stmt\Use_::TYPE_NORMAL]; } | T_USE use_declarations semi { $$ = Stmt\Use_[$2, Stmt\Use_::TYPE_NORMAL]; }
| T_USE use_type use_declarations semi { $$ = Stmt\Use_[$3, $2]; } | T_USE use_type use_declarations semi { $$ = Stmt\Use_[$3, $2]; }
| group_use_declaration semi { $$ = $1; } | group_use_declaration semi
| T_CONST constant_declaration_list semi { $$ = Stmt\Const_[$2]; } | T_CONST constant_declaration_list semi { $$ = Stmt\Const_[$2]; }
; ;
@@ -269,7 +269,7 @@ group_use_declaration:
; ;
unprefixed_use_declarations: unprefixed_use_declarations:
non_empty_unprefixed_use_declarations optional_comma { $$ = $1; } non_empty_unprefixed_use_declarations optional_comma
; ;
non_empty_unprefixed_use_declarations: non_empty_unprefixed_use_declarations:
@@ -279,7 +279,7 @@ non_empty_unprefixed_use_declarations:
; ;
use_declarations: use_declarations:
non_empty_use_declarations no_comma { $$ = $1; } non_empty_use_declarations no_comma
; ;
non_empty_use_declarations: non_empty_use_declarations:
@@ -288,7 +288,7 @@ non_empty_use_declarations:
; ;
inline_use_declarations: inline_use_declarations:
non_empty_inline_use_declarations optional_comma { $$ = $1; } non_empty_inline_use_declarations optional_comma
; ;
non_empty_inline_use_declarations: non_empty_inline_use_declarations:
@@ -317,7 +317,7 @@ inline_use_declaration:
; ;
constant_declaration_list: constant_declaration_list:
non_empty_constant_declaration_list no_comma { $$ = $1; } non_empty_constant_declaration_list no_comma
; ;
non_empty_constant_declaration_list: non_empty_constant_declaration_list:
@@ -331,7 +331,7 @@ constant_declaration:
; ;
class_const_list: class_const_list:
non_empty_class_const_list no_comma { $$ = $1; } non_empty_class_const_list no_comma
; ;
non_empty_class_const_list: non_empty_class_const_list:
@@ -353,34 +353,26 @@ inner_statement_list_ex:
inner_statement_list: inner_statement_list:
inner_statement_list_ex inner_statement_list_ex
{ makeZeroLengthNop($nop, $this->lookaheadStartAttributes); { makeZeroLengthNop($nop);
if ($nop !== null) { $1[] = $nop; } $$ = $1; } if ($nop !== null) { $1[] = $nop; } $$ = $1; }
; ;
inner_statement: inner_statement:
statement { $$ = $1; } statement
| function_declaration_statement { $$ = $1; } | function_declaration_statement
| class_declaration_statement { $$ = $1; } | class_declaration_statement
| T_HALT_COMPILER | T_HALT_COMPILER
{ throw new Error('__HALT_COMPILER() can only be used from the outermost scope', attributes()); } { throw new Error('__HALT_COMPILER() can only be used from the outermost scope', attributes()); }
; ;
non_empty_statement: non_empty_statement:
'{' inner_statement_list '}' '{' inner_statement_list '}' { $$ = Stmt\Block[$2]; }
{ | T_IF '(' expr ')' blocklike_statement elseif_list else_single
if ($2) { { $$ = Stmt\If_[$3, ['stmts' => $5, 'elseifs' => $6, 'else' => $7]]; }
$$ = $2; prependLeadingComments($$);
} else {
makeNop($$, $this->startAttributeStack[#1], $this->endAttributes);
if (null === $$) { $$ = array(); }
}
}
| T_IF '(' expr ')' statement elseif_list else_single
{ $$ = Stmt\If_[$3, ['stmts' => toArray($5), 'elseifs' => $6, 'else' => $7]]; }
| T_IF '(' expr ')' ':' inner_statement_list new_elseif_list new_else_single T_ENDIF ';' | T_IF '(' expr ')' ':' inner_statement_list new_elseif_list new_else_single T_ENDIF ';'
{ $$ = Stmt\If_[$3, ['stmts' => $6, 'elseifs' => $7, 'else' => $8]]; } { $$ = Stmt\If_[$3, ['stmts' => $6, 'elseifs' => $7, 'else' => $8]]; }
| T_WHILE '(' expr ')' while_statement { $$ = Stmt\While_[$3, $5]; } | T_WHILE '(' expr ')' while_statement { $$ = Stmt\While_[$3, $5]; }
| T_DO statement T_WHILE '(' expr ')' ';' { $$ = Stmt\Do_ [$5, toArray($2)]; } | T_DO blocklike_statement T_WHILE '(' expr ')' ';' { $$ = Stmt\Do_ [$5, $2]; }
| T_FOR '(' for_expr ';' for_expr ';' for_expr ')' for_statement | T_FOR '(' for_expr ';' for_expr ';' for_expr ')' for_statement
{ $$ = Stmt\For_[['init' => $3, 'cond' => $5, 'loop' => $7, 'stmts' => $9]]; } { $$ = Stmt\For_[['init' => $3, 'cond' => $5, 'loop' => $7, 'stmts' => $9]]; }
| T_SWITCH '(' expr ')' switch_case_list { $$ = Stmt\Switch_[$3, $5]; } | T_SWITCH '(' expr ')' switch_case_list { $$ = Stmt\Switch_[$3, $5]; }
@@ -390,17 +382,11 @@ non_empty_statement:
| T_GLOBAL global_var_list semi { $$ = Stmt\Global_[$2]; } | T_GLOBAL global_var_list semi { $$ = Stmt\Global_[$2]; }
| T_STATIC static_var_list semi { $$ = Stmt\Static_[$2]; } | T_STATIC static_var_list semi { $$ = Stmt\Static_[$2]; }
| T_ECHO expr_list_forbid_comma semi { $$ = Stmt\Echo_[$2]; } | T_ECHO expr_list_forbid_comma semi { $$ = Stmt\Echo_[$2]; }
| T_INLINE_HTML { $$ = Stmt\InlineHTML[$1]; } | T_INLINE_HTML {
| expr semi { $$ = Stmt\InlineHTML[$1];
$e = $1; $$->setAttribute('hasLeadingNewline', $this->inlineHtmlHasLeadingNewline(#1));
if ($e instanceof Expr\Throw_) {
// For backwards-compatibility reasons, convert throw in statement position into
// Stmt\Throw_ rather than Stmt\Expression(Expr\Throw_).
$$ = Stmt\Throw_[$e->expr];
} else {
$$ = Stmt\Expression[$e];
}
} }
| expr semi { $$ = Stmt\Expression[$1]; }
| T_UNSET '(' variables_list ')' semi { $$ = Stmt\Unset_[$3]; } | T_UNSET '(' variables_list ')' semi { $$ = Stmt\Unset_[$3]; }
| T_FOREACH '(' expr T_AS foreach_variable ')' foreach_statement | T_FOREACH '(' expr T_AS foreach_variable ')' foreach_statement
{ $$ = Stmt\Foreach_[$3, $5[0], ['keyVar' => null, 'byRef' => $5[1], 'stmts' => $7]]; } { $$ = Stmt\Foreach_[$3, $5[0], ['keyVar' => null, 'byRef' => $5[1], 'stmts' => $7]]; }
@@ -413,14 +399,16 @@ non_empty_statement:
{ $$ = Stmt\TryCatch[$3, $5, $6]; $this->checkTryCatch($$); } { $$ = Stmt\TryCatch[$3, $5, $6]; $this->checkTryCatch($$); }
| T_GOTO identifier_not_reserved semi { $$ = Stmt\Goto_[$2]; } | T_GOTO identifier_not_reserved semi { $$ = Stmt\Goto_[$2]; }
| identifier_not_reserved ':' { $$ = Stmt\Label[$1]; } | identifier_not_reserved ':' { $$ = Stmt\Label[$1]; }
| error { $$ = array(); /* means: no statement */ } | error { $$ = null; /* means: no statement */ }
; ;
statement: statement:
non_empty_statement { $$ = $1; } non_empty_statement
| ';' | ';' { makeNop($$); }
{ makeNop($$, $this->startAttributeStack[#1], $this->endAttributes); ;
if ($$ === null) $$ = array(); /* means: no statement */ }
blocklike_statement:
statement { toBlock($1); }
; ;
catches: catches:
@@ -444,7 +432,7 @@ optional_finally:
; ;
variables_list: variables_list:
non_empty_variables_list optional_comma { $$ = $1; } non_empty_variables_list optional_comma
; ;
non_empty_variables_list: non_empty_variables_list:
@@ -473,7 +461,7 @@ block_or_error:
; ;
identifier_maybe_readonly: identifier_maybe_readonly:
identifier_not_reserved { $$ = $1; } identifier_not_reserved
| T_READONLY { $$ = Node\Identifier[$1]; } | T_READONLY { $$ = Node\Identifier[$1]; }
; ;
@@ -512,11 +500,11 @@ enum_case_expr:
class_entry_type: class_entry_type:
T_CLASS { $$ = 0; } T_CLASS { $$ = 0; }
| class_modifiers T_CLASS { $$ = $1; } | class_modifiers T_CLASS
; ;
class_modifiers: class_modifiers:
class_modifier { $$ = $1; } class_modifier
| class_modifiers class_modifier { $this->checkClassModifier($1, $2, #2); $$ = $1 | $2; } | class_modifiers class_modifier { $this->checkClassModifier($1, $2, #2); $$ = $1 | $2; }
; ;
@@ -542,7 +530,7 @@ implements_list:
; ;
class_name_list: class_name_list:
non_empty_class_name_list no_comma { $$ = $1; } non_empty_class_name_list no_comma
; ;
non_empty_class_name_list: non_empty_class_name_list:
@@ -551,23 +539,23 @@ non_empty_class_name_list:
; ;
for_statement: for_statement:
statement { $$ = toArray($1); } blocklike_statement
| ':' inner_statement_list T_ENDFOR ';' { $$ = $2; } | ':' inner_statement_list T_ENDFOR ';' { $$ = $2; }
; ;
foreach_statement: foreach_statement:
statement { $$ = toArray($1); } blocklike_statement
| ':' inner_statement_list T_ENDFOREACH ';' { $$ = $2; } | ':' inner_statement_list T_ENDFOREACH ';' { $$ = $2; }
; ;
declare_statement: declare_statement:
non_empty_statement { $$ = toArray($1); } non_empty_statement { toBlock($1); }
| ';' { $$ = null; } | ';' { $$ = null; }
| ':' inner_statement_list T_ENDDECLARE ';' { $$ = $2; } | ':' inner_statement_list T_ENDDECLARE ';' { $$ = $2; }
; ;
declare_list: declare_list:
non_empty_declare_list no_comma { $$ = $1; } non_empty_declare_list no_comma
; ;
non_empty_declare_list: non_empty_declare_list:
@@ -607,7 +595,7 @@ match:
match_arm_list: match_arm_list:
/* empty */ { $$ = []; } /* empty */ { $$ = []; }
| non_empty_match_arm_list optional_comma { $$ = $1; } | non_empty_match_arm_list optional_comma
; ;
non_empty_match_arm_list: non_empty_match_arm_list:
@@ -621,7 +609,7 @@ match_arm:
; ;
while_statement: while_statement:
statement { $$ = toArray($1); } blocklike_statement { $$ = $1; }
| ':' inner_statement_list T_ENDWHILE ';' { $$ = $2; } | ':' inner_statement_list T_ENDWHILE ';' { $$ = $2; }
; ;
@@ -631,7 +619,7 @@ elseif_list:
; ;
elseif: elseif:
T_ELSEIF '(' expr ')' statement { $$ = Stmt\ElseIf_[$3, toArray($5)]; } T_ELSEIF '(' expr ')' blocklike_statement { $$ = Stmt\ElseIf_[$3, $5]; }
; ;
new_elseif_list: new_elseif_list:
@@ -646,7 +634,7 @@ new_elseif:
else_single: else_single:
/* empty */ { $$ = null; } /* empty */ { $$ = null; }
| T_ELSE statement { $$ = Stmt\Else_[toArray($2)]; } | T_ELSE blocklike_statement { $$ = Stmt\Else_[$2]; }
; ;
new_else_single: new_else_single:
@@ -664,7 +652,7 @@ foreach_variable:
; ;
parameter_list: parameter_list:
non_empty_parameter_list optional_comma { $$ = $1; } non_empty_parameter_list optional_comma
| /* empty */ { $$ = array(); } | /* empty */ { $$ = array(); }
; ;
@@ -701,14 +689,14 @@ parameter:
; ;
type_expr: type_expr:
type { $$ = $1; } type
| '?' type { $$ = Node\NullableType[$2]; } | '?' type { $$ = Node\NullableType[$2]; }
| union_type { $$ = Node\UnionType[$1]; } | union_type { $$ = Node\UnionType[$1]; }
| intersection_type { $$ = $1; } | intersection_type
; ;
type: type:
type_without_static { $$ = $1; } type_without_static
| T_STATIC { $$ = Node\Name['static']; } | T_STATIC { $$ = Node\Name['static']; }
; ;
@@ -719,8 +707,8 @@ type_without_static:
; ;
union_type_element: union_type_element:
type { $$ = $1; } type
| '(' intersection_type ')' { $$ = $2; } | '(' intersection_type ')' { $$ = $2; }
; ;
union_type: union_type:
@@ -729,7 +717,7 @@ union_type:
; ;
union_type_without_static_element: union_type_without_static_element:
type_without_static { $$ = $1; } type_without_static
| '(' intersection_type_without_static ')' { $$ = $2; } | '(' intersection_type_without_static ')' { $$ = $2; }
; ;
@@ -760,15 +748,15 @@ intersection_type_without_static:
; ;
type_expr_without_static: type_expr_without_static:
type_without_static { $$ = $1; } type_without_static
| '?' type_without_static { $$ = Node\NullableType[$2]; } | '?' type_without_static { $$ = Node\NullableType[$2]; }
| union_type_without_static { $$ = Node\UnionType[$1]; } | union_type_without_static { $$ = Node\UnionType[$1]; }
| intersection_type_without_static { $$ = $1; } | intersection_type_without_static
; ;
optional_type_without_static: optional_type_without_static:
/* empty */ { $$ = null; } /* empty */ { $$ = null; }
| type_expr_without_static { $$ = $1; } | type_expr_without_static
; ;
optional_return_type: optional_return_type:
@@ -801,7 +789,7 @@ argument:
; ;
global_var_list: global_var_list:
non_empty_global_var_list no_comma { $$ = $1; } non_empty_global_var_list no_comma
; ;
non_empty_global_var_list: non_empty_global_var_list:
@@ -810,11 +798,11 @@ non_empty_global_var_list:
; ;
global_var: global_var:
simple_variable { $$ = $1; } simple_variable
; ;
static_var_list: static_var_list:
non_empty_static_var_list no_comma { $$ = $1; } non_empty_static_var_list no_comma
; ;
non_empty_static_var_list: non_empty_static_var_list:
@@ -828,13 +816,13 @@ static_var:
; ;
class_statement_list_ex: class_statement_list_ex:
class_statement_list_ex class_statement { if ($2 !== null) { push($1, $2); } } class_statement_list_ex class_statement { if ($2 !== null) { push($1, $2); } else { $$ = $1; } }
| /* empty */ { init(); } | /* empty */ { init(); }
; ;
class_statement_list: class_statement_list:
class_statement_list_ex class_statement_list_ex
{ makeZeroLengthNop($nop, $this->lookaheadStartAttributes); { makeZeroLengthNop($nop);
if ($nop !== null) { $1[] = $nop; } $$ = $1; } if ($nop !== null) { $1[] = $nop; } $$ = $1; }
; ;
@@ -885,27 +873,27 @@ trait_method_reference_fully_qualified:
name T_PAAMAYIM_NEKUDOTAYIM identifier_maybe_reserved { $$ = array($1, $3); } name T_PAAMAYIM_NEKUDOTAYIM identifier_maybe_reserved { $$ = array($1, $3); }
; ;
trait_method_reference: trait_method_reference:
trait_method_reference_fully_qualified { $$ = $1; } trait_method_reference_fully_qualified
| identifier_maybe_reserved { $$ = array(null, $1); } | identifier_maybe_reserved { $$ = array(null, $1); }
; ;
method_body: method_body:
';' /* abstract method */ { $$ = null; } ';' /* abstract method */ { $$ = null; }
| block_or_error { $$ = $1; } | block_or_error
; ;
variable_modifiers: variable_modifiers:
non_empty_member_modifiers { $$ = $1; } non_empty_member_modifiers
| T_VAR { $$ = 0; } | T_VAR { $$ = 0; }
; ;
method_modifiers: method_modifiers:
/* empty */ { $$ = 0; } /* empty */ { $$ = 0; }
| non_empty_member_modifiers { $$ = $1; } | non_empty_member_modifiers
; ;
non_empty_member_modifiers: non_empty_member_modifiers:
member_modifier { $$ = $1; } member_modifier
| non_empty_member_modifiers member_modifier { $this->checkModifier($1, $2, #2); $$ = $1 | $2; } | non_empty_member_modifiers member_modifier { $this->checkModifier($1, $2, #2); $$ = $1 | $2; }
; ;
@@ -920,7 +908,7 @@ member_modifier:
; ;
property_declaration_list: property_declaration_list:
non_empty_property_declaration_list no_comma { $$ = $1; } non_empty_property_declaration_list no_comma
; ;
non_empty_property_declaration_list: non_empty_property_declaration_list:
@@ -939,11 +927,11 @@ property_declaration:
; ;
expr_list_forbid_comma: expr_list_forbid_comma:
non_empty_expr_list no_comma { $$ = $1; } non_empty_expr_list no_comma
; ;
expr_list_allow_comma: expr_list_allow_comma:
non_empty_expr_list optional_comma { $$ = $1; } non_empty_expr_list optional_comma
; ;
non_empty_expr_list: non_empty_expr_list:
@@ -953,11 +941,11 @@ non_empty_expr_list:
for_expr: for_expr:
/* empty */ { $$ = array(); } /* empty */ { $$ = array(); }
| expr_list_forbid_comma { $$ = $1; } | expr_list_forbid_comma
; ;
expr: expr:
variable { $$ = $1; } variable
| list_expr '=' expr { $$ = Expr\Assign[$1, $3]; } | list_expr '=' expr { $$ = Expr\Assign[$1, $3]; }
| array_short_syntax '=' expr | array_short_syntax '=' expr
{ $$ = Expr\Assign[$this->fixupArrayDestructuring($1), $3]; } { $$ = Expr\Assign[$this->fixupArrayDestructuring($1), $3]; }
@@ -969,8 +957,8 @@ expr:
$this->emitError(new Error('Cannot assign new by reference', attributes())); $this->emitError(new Error('Cannot assign new by reference', attributes()));
} }
} }
| new_expr { $$ = $1; } | new_expr
| match { $$ = $1; } | match
| T_CLONE expr { $$ = Expr\Clone_[$2]; } | T_CLONE expr { $$ = Expr\Clone_[$2]; }
| variable T_PLUS_EQUAL expr { $$ = Expr\AssignOp\Plus [$1, $3]; } | variable T_PLUS_EQUAL expr { $$ = Expr\AssignOp\Plus [$1, $3]; }
| variable T_MINUS_EQUAL expr { $$ = Expr\AssignOp\Minus [$1, $3]; } | variable T_MINUS_EQUAL expr { $$ = Expr\AssignOp\Minus [$1, $3]; }
@@ -1047,7 +1035,7 @@ expr:
$attrs['kind'] = strtolower($1) === 'exit' ? Expr\Exit_::KIND_EXIT : Expr\Exit_::KIND_DIE; $attrs['kind'] = strtolower($1) === 'exit' ? Expr\Exit_::KIND_EXIT : Expr\Exit_::KIND_DIE;
$$ = new Expr\Exit_($2, $attrs); } $$ = new Expr\Exit_($2, $attrs); }
| '@' expr { $$ = Expr\ErrorSuppress[$2]; } | '@' expr { $$ = Expr\ErrorSuppress[$2]; }
| scalar { $$ = $1; } | scalar
| '`' backticks_expr '`' { $$ = Expr\ShellExec[$2]; } | '`' backticks_expr '`' { $$ = Expr\ShellExec[$2]; }
| T_PRINT expr { $$ = Expr\Print_[$2]; } | T_PRINT expr { $$ = Expr\Print_[$2]; }
| T_YIELD { $$ = Expr\Yield_[null, null]; } | T_YIELD { $$ = Expr\Yield_[null, null]; }
@@ -1093,7 +1081,7 @@ lexical_vars:
; ;
lexical_var_list: lexical_var_list:
non_empty_lexical_var_list optional_comma { $$ = $1; } non_empty_lexical_var_list optional_comma
; ;
non_empty_lexical_var_list: non_empty_lexical_var_list:
@@ -1119,7 +1107,7 @@ function_call:
class_name: class_name:
T_STATIC { $$ = Name[$1]; } T_STATIC { $$ = Name[$1]; }
| name { $$ = $1; } | name
; ;
name: name:
@@ -1130,15 +1118,15 @@ name:
; ;
class_name_reference: class_name_reference:
class_name { $$ = $1; } class_name
| new_variable { $$ = $1; } | new_variable
| '(' expr ')' { $$ = $2; } | '(' expr ')' { $$ = $2; }
| error { $$ = Expr\Error[]; $this->errorState = 2; } | error { $$ = Expr\Error[]; $this->errorState = 2; }
; ;
class_name_or_var: class_name_or_var:
class_name { $$ = $1; } class_name
| fully_dereferencable { $$ = $1; } | fully_dereferencable
; ;
exit_expr: exit_expr:
@@ -1148,14 +1136,14 @@ exit_expr:
backticks_expr: backticks_expr:
/* empty */ { $$ = array(); } /* empty */ { $$ = array(); }
| T_ENCAPSED_AND_WHITESPACE | encaps_string_part
{ $$ = array(Node\InterpolatedStringPart[Scalar\String_::parseEscapeSequences($1, '`')]); } { $$ = array($1); parseEncapsed($$, '`', $this->phpVersion->supportsUnicodeEscapes()); }
| encaps_list { parseEncapsed($1, '`', true); $$ = $1; } | encaps_list { parseEncapsed($1, '`', $this->phpVersion->supportsUnicodeEscapes()); $$ = $1; }
; ;
ctor_arguments: ctor_arguments:
/* empty */ { $$ = array(); } /* empty */ { $$ = array(); }
| argument_list { $$ = $1; } | argument_list
; ;
constant: constant:
@@ -1193,19 +1181,20 @@ dereferencable_scalar:
$$ = new Expr\Array_($3, $attrs); $$ = new Expr\Array_($3, $attrs);
$this->createdArrays->attach($$); } $this->createdArrays->attach($$); }
| array_short_syntax { $$ = $1; $this->createdArrays->attach($$); } | array_short_syntax { $$ = $1; $this->createdArrays->attach($$); }
| T_CONSTANT_ENCAPSED_STRING { $$ = Scalar\String_::fromString($1, attributes()); } | T_CONSTANT_ENCAPSED_STRING
{ $$ = Scalar\String_::fromString($1, attributes(), $this->phpVersion->supportsUnicodeEscapes()); }
| '"' encaps_list '"' | '"' encaps_list '"'
{ $attrs = attributes(); $attrs['kind'] = Scalar\String_::KIND_DOUBLE_QUOTED; { $attrs = attributes(); $attrs['kind'] = Scalar\String_::KIND_DOUBLE_QUOTED;
parseEncapsed($2, '"', true); $$ = new Scalar\InterpolatedString($2, $attrs); } parseEncapsed($2, '"', $this->phpVersion->supportsUnicodeEscapes()); $$ = new Scalar\InterpolatedString($2, $attrs); }
; ;
scalar: scalar:
T_LNUMBER T_LNUMBER
{ $$ = $this->parseLNumber($1, attributes(), $this->phpVersion->allowsInvalidOctals()); } { $$ = $this->parseLNumber($1, attributes(), $this->phpVersion->allowsInvalidOctals()); }
| T_DNUMBER { $$ = Scalar\Float_::fromString($1, attributes()); } | T_DNUMBER { $$ = Scalar\Float_::fromString($1, attributes()); }
| dereferencable_scalar { $$ = $1; } | dereferencable_scalar
| constant { $$ = $1; } | constant
| class_constant { $$ = $1; } | class_constant
| T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE T_END_HEREDOC | T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE T_END_HEREDOC
{ $$ = $this->parseDocString($1, $2, $3, attributes(), stackAttributes(#3), true); } { $$ = $this->parseDocString($1, $2, $3, attributes(), stackAttributes(#3), true); }
| T_START_HEREDOC T_END_HEREDOC | T_START_HEREDOC T_END_HEREDOC
@@ -1216,32 +1205,32 @@ scalar:
optional_expr: optional_expr:
/* empty */ { $$ = null; } /* empty */ { $$ = null; }
| expr { $$ = $1; } | expr
; ;
fully_dereferencable: fully_dereferencable:
variable { $$ = $1; } variable
| '(' expr ')' { $$ = $2; } | '(' expr ')' { $$ = $2; }
| dereferencable_scalar { $$ = $1; } | dereferencable_scalar
| class_constant { $$ = $1; } | class_constant
; ;
array_object_dereferencable: array_object_dereferencable:
fully_dereferencable { $$ = $1; } fully_dereferencable
| constant { $$ = $1; } | constant
; ;
callable_expr: callable_expr:
callable_variable { $$ = $1; } callable_variable
| '(' expr ')' { $$ = $2; } | '(' expr ')' { $$ = $2; }
| dereferencable_scalar { $$ = $1; } | dereferencable_scalar
; ;
callable_variable: callable_variable:
simple_variable { $$ = $1; } simple_variable
| array_object_dereferencable '[' optional_expr ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } | array_object_dereferencable '[' optional_expr ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| array_object_dereferencable '{' expr '}' { $$ = Expr\ArrayDimFetch[$1, $3]; } | array_object_dereferencable '{' expr '}' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| function_call { $$ = $1; } | function_call
| array_object_dereferencable T_OBJECT_OPERATOR property_name argument_list | array_object_dereferencable T_OBJECT_OPERATOR property_name argument_list
{ $$ = Expr\MethodCall[$1, $3, $4]; } { $$ = Expr\MethodCall[$1, $3, $4]; }
| array_object_dereferencable T_NULLSAFE_OBJECT_OPERATOR property_name argument_list | array_object_dereferencable T_NULLSAFE_OBJECT_OPERATOR property_name argument_list
@@ -1250,12 +1239,12 @@ callable_variable:
optional_plain_variable: optional_plain_variable:
/* empty */ { $$ = null; } /* empty */ { $$ = null; }
| plain_variable { $$ = $1; } | plain_variable
; ;
variable: variable:
callable_variable { $$ = $1; } callable_variable
| static_member { $$ = $1; } | static_member
| array_object_dereferencable T_OBJECT_OPERATOR property_name | array_object_dereferencable T_OBJECT_OPERATOR property_name
{ $$ = Expr\PropertyFetch[$1, $3]; } { $$ = Expr\PropertyFetch[$1, $3]; }
| array_object_dereferencable T_NULLSAFE_OBJECT_OPERATOR property_name | array_object_dereferencable T_NULLSAFE_OBJECT_OPERATOR property_name
@@ -1263,7 +1252,7 @@ variable:
; ;
simple_variable: simple_variable:
plain_variable { $$ = $1; } plain_variable
| '$' '{' expr '}' { $$ = Expr\Variable[$3]; } | '$' '{' expr '}' { $$ = Expr\Variable[$3]; }
| '$' simple_variable { $$ = Expr\Variable[$2]; } | '$' simple_variable { $$ = Expr\Variable[$2]; }
| '$' error { $$ = Expr\Variable[Expr\Error[]]; $this->errorState = 2; } | '$' error { $$ = Expr\Variable[Expr\Error[]]; $this->errorState = 2; }
@@ -1280,7 +1269,7 @@ static_member:
; ;
new_variable: new_variable:
simple_variable { $$ = $1; } simple_variable
| new_variable '[' optional_expr ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } | new_variable '[' optional_expr ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| new_variable '{' expr '}' { $$ = Expr\ArrayDimFetch[$1, $3]; } | new_variable '{' expr '}' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| new_variable T_OBJECT_OPERATOR property_name { $$ = Expr\PropertyFetch[$1, $3]; } | new_variable T_OBJECT_OPERATOR property_name { $$ = Expr\PropertyFetch[$1, $3]; }
@@ -1292,15 +1281,15 @@ new_variable:
; ;
member_name: member_name:
identifier_maybe_reserved { $$ = $1; } identifier_maybe_reserved
| '{' expr '}' { $$ = $2; } | '{' expr '}' { $$ = $2; }
| simple_variable { $$ = $1; } | simple_variable
; ;
property_name: property_name:
identifier_not_reserved { $$ = $1; } identifier_not_reserved
| '{' expr '}' { $$ = $2; } | '{' expr '}' { $$ = $2; }
| simple_variable { $$ = $1; } | simple_variable
| error { $$ = Expr\Error[]; $this->errorState = 2; } | error { $$ = Expr\Error[]; $this->errorState = 2; }
; ;
@@ -1337,7 +1326,7 @@ array_pair:
| /* empty */ | /* empty */
{ /* Create an Error node now to remember the position. We'll later either report an error, { /* Create an Error node now to remember the position. We'll later either report an error,
or convert this into a null element, depending on whether this is a creation or destructuring context. */ or convert this into a null element, depending on whether this is a creation or destructuring context. */
$attrs = $this->createEmptyElemAttributes($this->lookaheadStartAttributes); $attrs = $this->createEmptyElemAttributes($this->tokenPos);
$$ = new Node\ArrayItem(new Expr\Error($attrs), null, false, $attrs); } $$ = new Node\ArrayItem(new Expr\Error($attrs), null, false, $attrs); }
; ;
@@ -1349,7 +1338,8 @@ encaps_list:
; ;
encaps_string_part: encaps_string_part:
T_ENCAPSED_AND_WHITESPACE { $$ = Node\InterpolatedStringPart[$1]; } T_ENCAPSED_AND_WHITESPACE
{ $attrs = attributes(); $attrs['rawValue'] = $1; $$ = new Node\InterpolatedStringPart($1, $attrs); }
; ;
encaps_str_varname: encaps_str_varname:
@@ -1357,7 +1347,7 @@ encaps_str_varname:
; ;
encaps_var: encaps_var:
plain_variable { $$ = $1; } plain_variable
| plain_variable '[' encaps_var_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } | plain_variable '[' encaps_var_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| plain_variable T_OBJECT_OPERATOR identifier_not_reserved | plain_variable T_OBJECT_OPERATOR identifier_not_reserved
{ $$ = Expr\PropertyFetch[$1, $3]; } { $$ = Expr\PropertyFetch[$1, $3]; }
@@ -1374,7 +1364,7 @@ encaps_var_offset:
T_STRING { $$ = Scalar\String_[$1]; } T_STRING { $$ = Scalar\String_[$1]; }
| T_NUM_STRING { $$ = $this->parseNumString($1, attributes()); } | T_NUM_STRING { $$ = $this->parseNumString($1, attributes()); }
| '-' T_NUM_STRING { $$ = $this->parseNumString('-' . $2, attributes()); } | '-' T_NUM_STRING { $$ = $this->parseNumString('-' . $2, attributes()); }
| plain_variable { $$ = $1; } | plain_variable
; ;
%% %%

View File

@@ -65,13 +65,13 @@ function resolveMacros($code) {
if ('attributes' === $name) { if ('attributes' === $name) {
assertArgs(0, $args, $name); assertArgs(0, $args, $name);
return '$this->startAttributeStack[#1] + $this->endAttributes'; return '$this->getAttributes($this->tokenStartStack[#1], $this->tokenEndStack[$stackPos])';
} }
if ('stackAttributes' === $name) { if ('stackAttributes' === $name) {
assertArgs(1, $args, $name); assertArgs(1, $args, $name);
return '$this->startAttributeStack[' . $args[0] . ']' return '$this->getAttributes($this->tokenStartStack[' . $args[0] . '], '
. ' + $this->endAttributeStack[' . $args[0] . ']'; . ' $this->tokenEndStack[' . $args[0] . '])';
} }
if ('init' === $name) { if ('init' === $name) {
@@ -87,14 +87,15 @@ function resolveMacros($code) {
if ('pushNormalizing' === $name) { if ('pushNormalizing' === $name) {
assertArgs(2, $args, $name); assertArgs(2, $args, $name);
return 'if (is_array(' . $args[1] . ')) { $$ = array_merge(' . $args[0] . ', ' . $args[1] . '); }' return 'if (' . $args[1] . ' !== null) { ' . $args[0] . '[] = ' . $args[1] . '; } $$ = ' . $args[0] . ';';
. ' else { ' . $args[0] . '[] = ' . $args[1] . '; $$ = ' . $args[0] . '; }';
} }
if ('toArray' == $name) { if ('toBlock' == $name) {
assertArgs(1, $args, $name); assertArgs(1, $args, $name);
return 'is_array(' . $args[0] . ') ? ' . $args[0] . ' : array(' . $args[0] . ')'; return 'if (' . $args[0] . ' instanceof Stmt\Block) { $$ = ' . $args[0] . '->stmts; } '
. 'else if (' . $args[0] . ' === null) { $$ = []; } '
. 'else { $$ = [' . $args[0] . ']; }';
} }
if ('parseVar' === $name) { if ('parseVar' === $name) {
@@ -111,30 +112,15 @@ function resolveMacros($code) {
} }
if ('makeNop' === $name) { if ('makeNop' === $name) {
assertArgs(3, $args, $name); assertArgs(1, $args, $name);
return '$startAttributes = ' . $args[1] . ';' return $args[0] . ' = $this->maybeCreateNop($this->tokenStartStack[#1], $this->tokenEndStack[$stackPos])';
. ' if (isset($startAttributes[\'comments\']))'
. ' { ' . $args[0] . ' = new Stmt\Nop($startAttributes + ' . $args[2] . '); }'
. ' else { ' . $args[0] . ' = null; }';
} }
if ('makeZeroLengthNop' == $name) { if ('makeZeroLengthNop' == $name) {
assertArgs(2, $args, $name);
return '$startAttributes = ' . $args[1] . ';'
. ' if (isset($startAttributes[\'comments\']))'
. ' { ' . $args[0] . ' = new Stmt\Nop($this->createCommentNopAttributes($startAttributes[\'comments\'])); }'
. ' else { ' . $args[0] . ' = null; }';
}
if ('prependLeadingComments' === $name) {
assertArgs(1, $args, $name); assertArgs(1, $args, $name);
return '$attrs = $this->startAttributeStack[#1]; $stmts = ' . $args[0] . '; ' return $args[0] . ' = $this->maybeCreateZeroLengthNop($this->tokenPos);';
. 'if (!empty($attrs[\'comments\'])) {'
. '$stmts[0]->setAttribute(\'comments\', '
. 'array_merge($attrs[\'comments\'], $stmts[0]->getAttribute(\'comments\', []))); }';
} }
return $matches[0]; return $matches[0];

View File

@@ -13,22 +13,21 @@ use PhpParser\Node\Identifier;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class ClassConst implements PhpParser\Builder { class ClassConst implements PhpParser\Builder {
/** @var int */ protected int $flags = 0;
protected $flags = 0;
/** @var array<string, mixed> */ /** @var array<string, mixed> */
protected $attributes = []; protected array $attributes = [];
/** @var list<Const_> */ /** @var list<Const_> */
protected $constants = []; protected array $constants = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** @var Identifier|Node\Name|Node\ComplexType */ /** @var Identifier|Node\Name|Node\ComplexType|null */
protected $type; protected ?Node $type = null;
/** /**
* Creates a class constant builder * Creates a class constant builder
* *
* @param string|Identifier $name Name * @param string|Identifier $name Name
* @param Node\Expr|bool|null|int|float|string|array $value Value * @param Node\Expr|bool|null|int|float|string|array $value Value
*/ */
public function __construct($name, $value) { public function __construct($name, $value) {
@@ -38,7 +37,7 @@ class ClassConst implements PhpParser\Builder {
/** /**
* Add another constant to const group * Add another constant to const group
* *
* @param string|Identifier $name Name * @param string|Identifier $name Name
* @param Node\Expr|bool|null|int|float|string|array $value Value * @param Node\Expr|bool|null|int|float|string|array $value Value
* *
* @return $this The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)

View File

@@ -10,26 +10,21 @@ use PhpParser\Node\Name;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Class_ extends Declaration { class Class_ extends Declaration {
/** @var string */ protected string $name;
protected $name; protected ?Name $extends = null;
/** @var Name|null */
protected $extends = null;
/** @var list<Name> */ /** @var list<Name> */
protected $implements = []; protected array $implements = [];
/** @var int */ protected int $flags = 0;
protected $flags = 0;
/** @var list<Stmt\TraitUse> */ /** @var list<Stmt\TraitUse> */
protected $uses = []; protected array $uses = [];
/** @var list<Stmt\ClassConst> */ /** @var list<Stmt\ClassConst> */
protected $constants = []; protected array $constants = [];
/** @var list<Stmt\Property> */ /** @var list<Stmt\Property> */
protected $properties = []; protected array $properties = [];
/** @var list<Stmt\ClassMethod> */ /** @var list<Stmt\ClassMethod> */
protected $methods = []; protected array $methods = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates a class builder. * Creates a class builder.

View File

@@ -7,7 +7,7 @@ use PhpParser\BuilderHelpers;
abstract class Declaration implements PhpParser\Builder { abstract class Declaration implements PhpParser\Builder {
/** @var array<string, mixed> */ /** @var array<string, mixed> */
protected $attributes = []; protected array $attributes = [];
/** /**
* Adds a statement. * Adds a statement.

View File

@@ -14,17 +14,17 @@ class EnumCase implements PhpParser\Builder {
/** @var Identifier|string */ /** @var Identifier|string */
protected $name; protected $name;
/** @var ?Node\Expr */ /** @var ?Node\Expr */
protected $value = null; protected ?Node\Expr $value = null;
/** @var array<string, mixed> */ /** @var array<string, mixed> */
protected $attributes = []; protected array $attributes = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates an enum case builder. * Creates an enum case builder.
* *
* @param string|Identifier $name Name * @param string|Identifier $name Name
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;

View File

@@ -10,22 +10,20 @@ use PhpParser\Node\Name;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Enum_ extends Declaration { class Enum_ extends Declaration {
/** @var string */ protected string $name;
protected $name; protected ?Identifier $scalarType = null;
/** @var Identifier|null */
protected $scalarType = null;
/** @var list<Name> */ /** @var list<Name> */
protected $implements = []; protected array $implements = [];
/** @var list<Stmt\TraitUse> */ /** @var list<Stmt\TraitUse> */
protected $uses = []; protected array $uses = [];
/** @var list<Stmt\EnumCase> */ /** @var list<Stmt\EnumCase> */
protected $enumCases = []; protected array $enumCases = [];
/** @var list<Stmt\ClassConst> */ /** @var list<Stmt\ClassConst> */
protected $constants = []; protected array $constants = [];
/** @var list<Stmt\ClassMethod> */ /** @var list<Stmt\ClassMethod> */
protected $methods = []; protected array $methods = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates an enum builder. * Creates an enum builder.

View File

@@ -6,13 +6,12 @@ use PhpParser\BuilderHelpers;
use PhpParser\Node; use PhpParser\Node;
abstract class FunctionLike extends Declaration { abstract class FunctionLike extends Declaration {
/** @var bool */ protected bool $returnByRef = false;
protected $returnByRef = false;
/** @var Node\Param[] */ /** @var Node\Param[] */
protected $params = []; protected array $params = [];
/** @var Node\Identifier|Node\Name|Node\ComplexType|null */ /** @var Node\Identifier|Node\Name|Node\ComplexType|null */
protected $returnType = null; protected ?Node $returnType = null;
/** /**
* Make the function return by reference. * Make the function return by reference.

View File

@@ -8,13 +8,12 @@ use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Function_ extends FunctionLike { class Function_ extends FunctionLike {
/** @var string */ protected string $name;
protected $name;
/** @var list<Stmt> */ /** @var list<Stmt> */
protected $stmts = []; protected array $stmts = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates a function builder. * Creates a function builder.

View File

@@ -9,16 +9,15 @@ use PhpParser\Node\Name;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Interface_ extends Declaration { class Interface_ extends Declaration {
/** @var string */ protected string $name;
protected $name;
/** @var list<Name> */ /** @var list<Name> */
protected $extends = []; protected array $extends = [];
/** @var list<Stmt\ClassConst> */ /** @var list<Stmt\ClassConst> */
protected $constants = []; protected array $constants = [];
/** @var list<Stmt\ClassMethod> */ /** @var list<Stmt\ClassMethod> */
protected $methods = []; protected array $methods = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates an interface builder. * Creates an interface builder.

View File

@@ -9,16 +9,15 @@ use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Method extends FunctionLike { class Method extends FunctionLike {
/** @var string */ protected string $name;
protected $name;
/** @var int */ protected int $flags = 0;
protected $flags = 0;
/** @var list<Stmt>|null */ /** @var list<Stmt>|null */
protected $stmts = []; protected ?array $stmts = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates a method builder. * Creates a method builder.

View File

@@ -8,10 +8,9 @@ use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Namespace_ extends Declaration { class Namespace_ extends Declaration {
/** @var Node\Name|null */ private ?Node\Name $name;
private $name;
/** @var Stmt[] */ /** @var Stmt[] */
private $stmts = []; private array $stmts = [];
/** /**
* Creates a namespace builder. * Creates a namespace builder.

View File

@@ -8,20 +8,15 @@ use PhpParser\Modifiers;
use PhpParser\Node; use PhpParser\Node;
class Param implements PhpParser\Builder { class Param implements PhpParser\Builder {
/** @var string */ protected string $name;
protected $name; protected ?Node\Expr $default = null;
/** @var Node\Expr|null */
protected $default = null;
/** @var Node\Identifier|Node\Name|Node\ComplexType|null */ /** @var Node\Identifier|Node\Name|Node\ComplexType|null */
protected $type = null; protected ?Node $type = null;
/** @var bool */ protected bool $byRef = false;
protected $byRef = false; protected int $flags = 0;
/** @var int */ protected bool $variadic = false;
protected $flags = 0;
/** @var bool */
protected $variadic = false;
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates a parameter builder. * Creates a parameter builder.

View File

@@ -12,18 +12,17 @@ use PhpParser\Node\Stmt;
use PhpParser\Node\ComplexType; use PhpParser\Node\ComplexType;
class Property implements PhpParser\Builder { class Property implements PhpParser\Builder {
/** @var string */ protected string $name;
protected $name;
/** @var int */ protected int $flags = 0;
protected $flags = 0;
/** @var Node\Expr|null */ protected ?Node\Expr $default = null;
protected $default = null;
/** @var array<string, mixed> */ /** @var array<string, mixed> */
protected $attributes = []; protected array $attributes = [];
/** @var null|Identifier|Name|ComplexType */ /** @var null|Identifier|Name|ComplexType */
protected $type; protected ?Node $type = null;
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates a property builder. * Creates a property builder.

View File

@@ -9,9 +9,9 @@ use PhpParser\Node\Stmt;
class TraitUse implements Builder { class TraitUse implements Builder {
/** @var Node\Name[] */ /** @var Node\Name[] */
protected $traits = []; protected array $traits = [];
/** @var Stmt\TraitUseAdaptation[] */ /** @var Stmt\TraitUseAdaptation[] */
protected $adaptations = []; protected array $adaptations = [];
/** /**
* Creates a trait use builder. * Creates a trait use builder.

View File

@@ -13,23 +13,18 @@ class TraitUseAdaptation implements Builder {
private const TYPE_ALIAS = 1; private const TYPE_ALIAS = 1;
private const TYPE_PRECEDENCE = 2; private const TYPE_PRECEDENCE = 2;
/** @var int Type of building adaptation */ protected int $type;
protected $type; protected ?Node\Name $trait;
/** @var Node\Name|null */ protected Node\Identifier $method;
protected $trait; protected ?int $modifier = null;
/** @var Node\Identifier */ protected ?Node\Identifier $alias = null;
protected $method;
/** @var int|null */
protected $modifier = null;
/** @var Node\Identifier|null */
protected $alias = null;
/** @var Node\Name[] */ /** @var Node\Name[] */
protected $insteadof = []; protected array $insteadof = [];
/** /**
* Creates a trait use adaptation builder. * Creates a trait use adaptation builder.
* *
* @param Node\Name|string|null $trait Name of adapted trait * @param Node\Name|string|null $trait Name of adapted trait
* @param Node\Identifier|string $method Name of adapted method * @param Node\Identifier|string $method Name of adapted method
*/ */
public function __construct($trait, $method) { public function __construct($trait, $method) {

View File

@@ -8,18 +8,17 @@ use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Trait_ extends Declaration { class Trait_ extends Declaration {
/** @var string */ protected string $name;
protected $name;
/** @var list<Stmt\TraitUse> */ /** @var list<Stmt\TraitUse> */
protected $uses = []; protected array $uses = [];
/** @var list<Stmt\ClassConst> */ /** @var list<Stmt\ClassConst> */
protected $constants = []; protected array $constants = [];
/** @var list<Stmt\Property> */ /** @var list<Stmt\Property> */
protected $properties = []; protected array $properties = [];
/** @var list<Stmt\ClassMethod> */ /** @var list<Stmt\ClassMethod> */
protected $methods = []; protected array $methods = [];
/** @var list<Node\AttributeGroup> */ /** @var list<Node\AttributeGroup> */
protected $attributeGroups = []; protected array $attributeGroups = [];
/** /**
* Creates an interface builder. * Creates an interface builder.

View File

@@ -8,18 +8,16 @@ use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Use_ implements Builder { class Use_ implements Builder {
/** @var Node\Name */ protected Node\Name $name;
protected $name; /** @var Stmt\Use_::TYPE_* */
/** @var int */ protected int $type;
protected $type; protected ?string $alias = null;
/** @var string|null */
protected $alias = null;
/** /**
* Creates a name use (alias) builder. * Creates a name use (alias) builder.
* *
* @param Node\Name|string $name Name of the entity (namespace, class, function, constant) to alias * @param Node\Name|string $name Name of the entity (namespace, class, function, constant) to alias
* @param int $type One of the Stmt\Use_::TYPE_* constants * @param Stmt\Use_::TYPE_* $type One of the Stmt\Use_::TYPE_* constants
*/ */
public function __construct($name, int $type) { public function __construct($name, int $type) {
$this->name = BuilderHelpers::normalizeName($name); $this->name = BuilderHelpers::normalizeName($name);

View File

@@ -15,9 +15,7 @@ class BuilderFactory {
* Creates an attribute node. * Creates an attribute node.
* *
* @param string|Name $name Name of the attribute * @param string|Name $name Name of the attribute
* @param array $args Attribute named arguments * @param array $args Attribute named arguments
*
* @return Node\Attribute
*/ */
public function attribute($name, array $args = []): Node\Attribute { public function attribute($name, array $args = []): Node\Attribute {
return new Node\Attribute( return new Node\Attribute(
@@ -95,7 +93,7 @@ class BuilderFactory {
/** /**
* Creates a trait use adaptation builder. * Creates a trait use adaptation builder.
* *
* @param Node\Name|string|null $trait Trait name * @param Node\Name|string|null $trait Trait name
* @param Node\Identifier|string $method Method name * @param Node\Identifier|string $method Method name
* *
* @return Builder\TraitUseAdaptation The created trait use adaptation builder * @return Builder\TraitUseAdaptation The created trait use adaptation builder
@@ -189,7 +187,7 @@ class BuilderFactory {
/** /**
* Creates a class constant builder. * Creates a class constant builder.
* *
* @param string|Identifier $name Name * @param string|Identifier $name Name
* @param Node\Expr|bool|null|int|float|string|array $value Value * @param Node\Expr|bool|null|int|float|string|array $value Value
* *
* @return Builder\ClassConst The created use const builder * @return Builder\ClassConst The created use const builder
@@ -201,7 +199,7 @@ class BuilderFactory {
/** /**
* Creates an enum case builder. * Creates an enum case builder.
* *
* @param string|Identifier $name Name * @param string|Identifier $name Name
* *
* @return Builder\EnumCase The created use const builder * @return Builder\EnumCase The created use const builder
*/ */
@@ -213,8 +211,6 @@ class BuilderFactory {
* Creates node a for a literal value. * Creates node a for a literal value.
* *
* @param Expr|bool|null|int|float|string|array $value $value * @param Expr|bool|null|int|float|string|array $value $value
*
* @return Expr
*/ */
public function val($value): Expr { public function val($value): Expr {
return BuilderHelpers::normalizeValue($value); return BuilderHelpers::normalizeValue($value);
@@ -224,8 +220,6 @@ class BuilderFactory {
* Creates variable node. * Creates variable node.
* *
* @param string|Expr $name Name * @param string|Expr $name Name
*
* @return Expr\Variable
*/ */
public function var($name): Expr\Variable { public function var($name): Expr\Variable {
if (!\is_string($name) && !$name instanceof Expr) { if (!\is_string($name) && !$name instanceof Expr) {
@@ -262,9 +256,7 @@ class BuilderFactory {
* Creates a function call node. * Creates a function call node.
* *
* @param string|Name|Expr $name Function name * @param string|Name|Expr $name Function name
* @param array $args Function arguments * @param array $args Function arguments
*
* @return Expr\FuncCall
*/ */
public function funcCall($name, array $args = []): Expr\FuncCall { public function funcCall($name, array $args = []): Expr\FuncCall {
return new Expr\FuncCall( return new Expr\FuncCall(
@@ -276,11 +268,9 @@ class BuilderFactory {
/** /**
* Creates a method call node. * Creates a method call node.
* *
* @param Expr $var Variable the method is called on * @param Expr $var Variable the method is called on
* @param string|Identifier|Expr $name Method name * @param string|Identifier|Expr $name Method name
* @param array $args Method arguments * @param array $args Method arguments
*
* @return Expr\MethodCall
*/ */
public function methodCall(Expr $var, $name, array $args = []): Expr\MethodCall { public function methodCall(Expr $var, $name, array $args = []): Expr\MethodCall {
return new Expr\MethodCall( return new Expr\MethodCall(
@@ -293,11 +283,9 @@ class BuilderFactory {
/** /**
* Creates a static method call node. * Creates a static method call node.
* *
* @param string|Name|Expr $class Class name * @param string|Name|Expr $class Class name
* @param string|Identifier|Expr $name Method name * @param string|Identifier|Expr $name Method name
* @param array $args Method arguments * @param array $args Method arguments
*
* @return Expr\StaticCall
*/ */
public function staticCall($class, $name, array $args = []): Expr\StaticCall { public function staticCall($class, $name, array $args = []): Expr\StaticCall {
return new Expr\StaticCall( return new Expr\StaticCall(
@@ -311,9 +299,7 @@ class BuilderFactory {
* Creates an object creation node. * Creates an object creation node.
* *
* @param string|Name|Expr $class Class name * @param string|Name|Expr $class Class name
* @param array $args Constructor arguments * @param array $args Constructor arguments
*
* @return Expr\New_
*/ */
public function new($class, array $args = []): Expr\New_ { public function new($class, array $args = []): Expr\New_ {
return new Expr\New_( return new Expr\New_(
@@ -326,8 +312,6 @@ class BuilderFactory {
* Creates a constant fetch node. * Creates a constant fetch node.
* *
* @param string|Name $name Constant name * @param string|Name $name Constant name
*
* @return Expr\ConstFetch
*/ */
public function constFetch($name): Expr\ConstFetch { public function constFetch($name): Expr\ConstFetch {
return new Expr\ConstFetch(BuilderHelpers::normalizeName($name)); return new Expr\ConstFetch(BuilderHelpers::normalizeName($name));
@@ -336,10 +320,8 @@ class BuilderFactory {
/** /**
* Creates a property fetch node. * Creates a property fetch node.
* *
* @param Expr $var Variable holding object * @param Expr $var Variable holding object
* @param string|Identifier|Expr $name Property name * @param string|Identifier|Expr $name Property name
*
* @return Expr\PropertyFetch
*/ */
public function propertyFetch(Expr $var, $name): Expr\PropertyFetch { public function propertyFetch(Expr $var, $name): Expr\PropertyFetch {
return new Expr\PropertyFetch($var, BuilderHelpers::normalizeIdentifierOrExpr($name)); return new Expr\PropertyFetch($var, BuilderHelpers::normalizeIdentifierOrExpr($name));
@@ -349,9 +331,7 @@ class BuilderFactory {
* Creates a class constant fetch node. * Creates a class constant fetch node.
* *
* @param string|Name|Expr $class Class name * @param string|Name|Expr $class Class name
* @param string|Identifier|Expr $name Constant name * @param string|Identifier|Expr $name Constant name
*
* @return Expr\ClassConstFetch
*/ */
public function classConstFetch($class, $name): Expr\ClassConstFetch { public function classConstFetch($class, $name): Expr\ClassConstFetch {
return new Expr\ClassConstFetch( return new Expr\ClassConstFetch(
@@ -364,8 +344,6 @@ class BuilderFactory {
* Creates nested Concat nodes from a list of expressions. * Creates nested Concat nodes from a list of expressions.
* *
* @param Expr|string ...$exprs Expressions or literal strings * @param Expr|string ...$exprs Expressions or literal strings
*
* @return Concat
*/ */
public function concat(...$exprs): Concat { public function concat(...$exprs): Concat {
$numExprs = count($exprs); $numExprs = count($exprs);
@@ -382,7 +360,6 @@ class BuilderFactory {
/** /**
* @param string|Expr $expr * @param string|Expr $expr
* @return Expr
*/ */
private function normalizeStringExpr($expr): Expr { private function normalizeStringExpr($expr): Expr {
if ($expr instanceof Expr) { if ($expr instanceof Expr) {

View File

@@ -313,7 +313,7 @@ final class BuilderHelpers {
* Adds a modifier and returns new modifier bitmask. * Adds a modifier and returns new modifier bitmask.
* *
* @param int $modifiers Existing modifiers * @param int $modifiers Existing modifiers
* @param int $modifier Modifier to set * @param int $modifier Modifier to set
* *
* @return int New modifiers * @return int New modifiers
*/ */

View File

@@ -3,28 +3,21 @@
namespace PhpParser; namespace PhpParser;
class Comment implements \JsonSerializable { class Comment implements \JsonSerializable {
/** @var string string */ protected string $text;
protected $text; protected int $startLine;
/** @var int */ protected int $startFilePos;
protected $startLine; protected int $startTokenPos;
/** @var int */ protected int $endLine;
protected $startFilePos; protected int $endFilePos;
/** @var int */ protected int $endTokenPos;
protected $startTokenPos;
/** @var int */
protected $endLine;
/** @var int */
protected $endFilePos;
/** @var int */
protected $endTokenPos;
/** /**
* Constructs a comment node. * Constructs a comment node.
* *
* @param string $text Comment text (including comment delimiters like /*) * @param string $text Comment text (including comment delimiters like /*)
* @param int $startLine Line number the comment started on * @param int $startLine Line number the comment started on
* @param int $startFilePos File offset the comment started on * @param int $startFilePos File offset the comment started on
* @param int $startTokenPos Token offset the comment started on * @param int $startTokenPos Token offset the comment started on
*/ */
public function __construct( public function __construct(
string $text, string $text,
@@ -103,39 +96,6 @@ class Comment implements \JsonSerializable {
return $this->endTokenPos; return $this->endTokenPos;
} }
/**
* Gets the line number the comment started on.
*
* @deprecated Use getStartLine() instead
*
* @return int Line number
*/
public function getLine(): int {
return $this->startLine;
}
/**
* Gets the file offset the comment started on.
*
* @deprecated Use getStartFilePos() instead
*
* @return int File offset
*/
public function getFilePos(): int {
return $this->startFilePos;
}
/**
* Gets the token offset the comment started on.
*
* @deprecated Use getStartTokenPos() instead
*
* @return int Token offset
*/
public function getTokenPos(): int {
return $this->startTokenPos;
}
/** /**
* Gets the comment text. * Gets the comment text.
* *
@@ -154,8 +114,6 @@ class Comment implements \JsonSerializable {
* on all subsequent lines. * on all subsequent lines.
* *
* Additionally, this normalizes CRLF newlines to LF newlines. * Additionally, this normalizes CRLF newlines to LF newlines.
*
* @return string
*/ */
public function getReformattedText(): string { public function getReformattedText(): string {
$text = str_replace("\r\n", "\n", $this->text); $text = str_replace("\r\n", "\n", $this->text);
@@ -229,8 +187,7 @@ class Comment implements \JsonSerializable {
} }
/** /**
* @return array * @return array{nodeType:string, text:mixed, line:mixed, filePos:mixed}
* @psalm-return array{nodeType:string, text:mixed, line:mixed, filePos:mixed}
*/ */
public function jsonSerialize(): array { public function jsonSerialize(): array {
// Technically not a node, but we make it look like one anyway // Technically not a node, but we make it look like one anyway

View File

@@ -3,10 +3,9 @@
namespace PhpParser; namespace PhpParser;
class Error extends \RuntimeException { class Error extends \RuntimeException {
/** @var string */ protected string $rawMessage;
protected $rawMessage;
/** @var array<string, mixed> */ /** @var array<string, mixed> */
protected $attributes; protected array $attributes;
/** /**
* Creates an Exception signifying a parse error. * Creates an Exception signifying a parse error.
@@ -90,8 +89,6 @@ class Error extends \RuntimeException {
* Returns whether the error has start and end column information. * Returns whether the error has start and end column information.
* *
* For column information enable the startFilePos and endFilePos in the lexer options. * For column information enable the startFilePos and endFilePos in the lexer options.
*
* @return bool
*/ */
public function hasColumnInfo(): bool { public function hasColumnInfo(): bool {
return isset($this->attributes['startFilePos'], $this->attributes['endFilePos']); return isset($this->attributes['startFilePos'], $this->attributes['endFilePos']);
@@ -101,7 +98,6 @@ class Error extends \RuntimeException {
* Gets the start column (1-based) into the line where the error started. * Gets the start column (1-based) into the line where the error started.
* *
* @param string $code Source code of the file * @param string $code Source code of the file
* @return int
*/ */
public function getStartColumn(string $code): int { public function getStartColumn(string $code): int {
if (!$this->hasColumnInfo()) { if (!$this->hasColumnInfo()) {
@@ -115,7 +111,6 @@ class Error extends \RuntimeException {
* Gets the end column (1-based) into the line where the error ended. * Gets the end column (1-based) into the line where the error ended.
* *
* @param string $code Source code of the file * @param string $code Source code of the file
* @return int
*/ */
public function getEndColumn(string $code): int { public function getEndColumn(string $code): int {
if (!$this->hasColumnInfo()) { if (!$this->hasColumnInfo()) {
@@ -144,7 +139,7 @@ class Error extends \RuntimeException {
* Converts a file offset into a column. * Converts a file offset into a column.
* *
* @param string $code Source code that $pos indexes into * @param string $code Source code that $pos indexes into
* @param int $pos 0-based position in $code * @param int $pos 0-based position in $code
* *
* @return int 1-based column (relative to start of line) * @return int 1-based column (relative to start of line)
*/ */

View File

@@ -12,7 +12,7 @@ use PhpParser\ErrorHandler;
*/ */
class Collecting implements ErrorHandler { class Collecting implements ErrorHandler {
/** @var Error[] Collected errors */ /** @var Error[] Collected errors */
private $errors = []; private array $errors = [];
public function handleError(Error $error): void { public function handleError(Error $error): void {
$this->errors[] = $error; $this->errors[] = $error;
@@ -29,8 +29,6 @@ class Collecting implements ErrorHandler {
/** /**
* Check whether there are any errors. * Check whether there are any errors.
*
* @return bool
*/ */
public function hasErrors(): bool { public function hasErrors(): bool {
return !empty($this->errors); return !empty($this->errors);

View File

@@ -12,7 +12,7 @@ class DiffElem {
public const TYPE_REPLACE = 3; public const TYPE_REPLACE = 3;
/** @var int One of the TYPE_* constants */ /** @var int One of the TYPE_* constants */
public $type; public int $type;
/** @var mixed Is null for add operations */ /** @var mixed Is null for add operations */
public $old; public $old;
/** @var mixed Is null for remove operations */ /** @var mixed Is null for remove operations */

View File

@@ -68,10 +68,10 @@ class Differ {
for ($d = 0; $d <= $max; $d++) { for ($d = 0; $d <= $max; $d++) {
$trace[] = $v; $trace[] = $v;
for ($k = -$d; $k <= $d; $k += 2) { for ($k = -$d; $k <= $d; $k += 2) {
if ($k === -$d || ($k !== $d && $v[$k-1] < $v[$k+1])) { if ($k === -$d || ($k !== $d && $v[$k - 1] < $v[$k + 1])) {
$x = $v[$k+1]; $x = $v[$k + 1];
} else { } else {
$x = $v[$k-1] + 1; $x = $v[$k - 1] + 1;
} }
$y = $x - $k; $y = $x - $k;
@@ -91,8 +91,6 @@ class Differ {
/** /**
* @param array<int, array<int, int>> $trace * @param array<int, array<int, int>> $trace
* @param int $x
* @param int $y
* @param T[] $old * @param T[] $old
* @param T[] $new * @param T[] $new
* @return DiffElem[] * @return DiffElem[]
@@ -103,7 +101,7 @@ class Differ {
$v = $trace[$d]; $v = $trace[$d];
$k = $x - $y; $k = $x - $y;
if ($k === -$d || ($k !== $d && $v[$k-1] < $v[$k+1])) { if ($k === -$d || ($k !== $d && $v[$k - 1] < $v[$k + 1])) {
$prevK = $k + 1; $prevK = $k + 1;
} else { } else {
$prevK = $k - 1; $prevK = $k - 1;
@@ -113,7 +111,7 @@ class Differ {
$prevY = $prevX - $prevK; $prevY = $prevX - $prevK;
while ($x > $prevX && $y > $prevY) { while ($x > $prevX && $y > $prevY) {
$result[] = new DiffElem(DiffElem::TYPE_KEEP, $old[$x-1], $new[$y-1]); $result[] = new DiffElem(DiffElem::TYPE_KEEP, $old[$x - 1], $new[$y - 1]);
$x--; $x--;
$y--; $y--;
} }
@@ -123,12 +121,12 @@ class Differ {
} }
while ($x > $prevX) { while ($x > $prevX) {
$result[] = new DiffElem(DiffElem::TYPE_REMOVE, $old[$x-1], null); $result[] = new DiffElem(DiffElem::TYPE_REMOVE, $old[$x - 1], null);
$x--; $x--;
} }
while ($y > $prevY) { while ($y > $prevY) {
$result[] = new DiffElem(DiffElem::TYPE_ADD, null, $new[$y-1]); $result[] = new DiffElem(DiffElem::TYPE_ADD, null, $new[$y - 1]);
$y--; $y--;
} }
} }

View File

@@ -17,17 +17,17 @@ use PhpParser\Node\Expr;
*/ */
class PrintableNewAnonClassNode extends Expr { class PrintableNewAnonClassNode extends Expr {
/** @var Node\AttributeGroup[] PHP attribute groups */ /** @var Node\AttributeGroup[] PHP attribute groups */
public $attrGroups; public array $attrGroups;
/** @var int Modifiers */ /** @var int Modifiers */
public $flags; public int $flags;
/** @var (Node\Arg|Node\VariadicPlaceholder)[] Arguments */ /** @var (Node\Arg|Node\VariadicPlaceholder)[] Arguments */
public $args; public array $args;
/** @var null|Node\Name Name of extended class */ /** @var null|Node\Name Name of extended class */
public $extends; public ?Node\Name $extends;
/** @var Node\Name[] Names of implemented interfaces */ /** @var Node\Name[] Names of implemented interfaces */
public $implements; public array $implements;
/** @var Node\Stmt[] Statements */ /** @var Node\Stmt[] Statements */
public $stmts; public array $stmts;
/** /**
* @param Node\AttributeGroup[] $attrGroups PHP attribute groups * @param Node\AttributeGroup[] $attrGroups PHP attribute groups

View File

@@ -17,13 +17,13 @@ if (\PHP_VERSION_ID >= 80000) {
*/ */
class TokenPolyfill { class TokenPolyfill {
/** @var int The ID of the token. Either a T_* constant of a character code < 256. */ /** @var int The ID of the token. Either a T_* constant of a character code < 256. */
public $id; public int $id;
/** @var string The textual content of the token. */ /** @var string The textual content of the token. */
public $text; public string $text;
/** @var int The 1-based starting line of the token (or -1 if unknown). */ /** @var int The 1-based starting line of the token (or -1 if unknown). */
public $line; public int $line;
/** @var int The 0-based starting position of the token (or -1 if unknown). */ /** @var int The 0-based starting position of the token (or -1 if unknown). */
public $pos; public int $pos;
/** @var array<int, bool> Tokens ignored by the PHP parser. */ /** @var array<int, bool> Tokens ignored by the PHP parser. */
private const IGNORABLE_TOKENS = [ private const IGNORABLE_TOKENS = [
@@ -33,8 +33,8 @@ class TokenPolyfill {
\T_OPEN_TAG => true, \T_OPEN_TAG => true,
]; ];
/** @var array<int, bool>|null Tokens that may be part of a T_NAME_* identifier. */ /** @var array<int, bool> Tokens that may be part of a T_NAME_* identifier. */
private static $identifierTokens; private static array $identifierTokens;
/** /**
* Create a Token with the given ID and text, as well optional line and position information. * Create a Token with the given ID and text, as well optional line and position information.
@@ -128,9 +128,6 @@ class TokenPolyfill {
$line = 1; $line = 1;
$pos = 0; $pos = 0;
$origTokens = \token_get_all($code, $flags); $origTokens = \token_get_all($code, $flags);
if (\PHP_VERSION_ID < 70400) {
$origTokens = self::fixupBadCharacters($code, $origTokens);
}
$numTokens = \count($origTokens); $numTokens = \count($origTokens);
for ($i = 0; $i < $numTokens; $i++) { for ($i = 0; $i < $numTokens; $i++) {
@@ -217,38 +214,6 @@ class TokenPolyfill {
return $tokens; return $tokens;
} }
/**
* Prior to PHP 7.4, token_get_all() simply dropped invalid characters from the token stream.
* Detect such cases and replace them with T_BAD_CHARACTER.
*/
private static function fixupBadCharacters(string $code, array $origTokens): array {
$newTokens = [];
$pos = 0;
foreach ($origTokens as $token) {
$text = \is_string($token) ? $token : $token[1];
$len = \strlen($text);
if (substr($code, $pos, $len) !== $text) {
$nextPos = strpos($code, $text, $pos);
for ($i = $pos; $i < $nextPos; $i++) {
// Don't bother including the line, we're not going to use it anyway.
$newTokens[] = [\T_BAD_CHARACTER, $code[$i]];
}
$pos = $nextPos;
}
$pos += $len;
$newTokens[] = $token;
}
// Handle trailing invalid characters.
$codeLen = \strlen($code);
if ($pos !== $codeLen) {
for ($i = $pos; $i < $codeLen; $i++) {
$newTokens[] = [\T_BAD_CHARACTER, $code[$i]];
}
}
return $newTokens;
}
/** Initialize private static state needed by tokenize(). */ /** Initialize private static state needed by tokenize(). */
private static function init(): void { private static function init(): void {
if (isset(self::$identifierTokens)) { if (isset(self::$identifierTokens)) {

View File

@@ -11,9 +11,9 @@ use PhpParser\Token;
*/ */
class TokenStream { class TokenStream {
/** @var Token[] Tokens (in PhpToken::tokenize() format) */ /** @var Token[] Tokens (in PhpToken::tokenize() format) */
private $tokens; private array $tokens;
/** @var int[] Map from position to indentation */ /** @var int[] Map from position to indentation */
private $indentMap; private array $indentMap;
/** /**
* Create token stream instance. * Create token stream instance.
@@ -29,9 +29,7 @@ class TokenStream {
* Whether the given position is immediately surrounded by parenthesis. * Whether the given position is immediately surrounded by parenthesis.
* *
* @param int $startPos Start position * @param int $startPos Start position
* @param int $endPos End position * @param int $endPos End position
*
* @return bool
*/ */
public function haveParens(int $startPos, int $endPos): bool { public function haveParens(int $startPos, int $endPos): bool {
return $this->haveTokenImmediatelyBefore($startPos, '(') return $this->haveTokenImmediatelyBefore($startPos, '(')
@@ -42,9 +40,7 @@ class TokenStream {
* Whether the given position is immediately surrounded by braces. * Whether the given position is immediately surrounded by braces.
* *
* @param int $startPos Start position * @param int $startPos Start position
* @param int $endPos End position * @param int $endPos End position
*
* @return bool
*/ */
public function haveBraces(int $startPos, int $endPos): bool { public function haveBraces(int $startPos, int $endPos): bool {
return ($this->haveTokenImmediatelyBefore($startPos, '{') return ($this->haveTokenImmediatelyBefore($startPos, '{')
@@ -57,7 +53,7 @@ class TokenStream {
* *
* During this check whitespace and comments are skipped. * During this check whitespace and comments are skipped.
* *
* @param int $pos Position before which the token should occur * @param int $pos Position before which the token should occur
* @param int|string $expectedTokenType Token to check for * @param int|string $expectedTokenType Token to check for
* *
* @return bool Whether the expected token was found * @return bool Whether the expected token was found
@@ -82,7 +78,7 @@ class TokenStream {
* *
* During this check whitespace and comments are skipped. * During this check whitespace and comments are skipped.
* *
* @param int $pos Position after which the token should occur * @param int $pos Position after which the token should occur
* @param int|string $expectedTokenType Token to check for * @param int|string $expectedTokenType Token to check for
* *
* @return bool Whether the expected token was found * @return bool Whether the expected token was found
@@ -199,12 +195,6 @@ class TokenStream {
return false; return false;
} }
public function haveBracesInRange(int $startPos, int $endPos): bool {
return $this->haveTokenInRange($startPos, $endPos, '{')
|| $this->haveTokenInRange($startPos, $endPos, T_CURLY_OPEN)
|| $this->haveTokenInRange($startPos, $endPos, '}');
}
public function haveTagInRange(int $startPos, int $endPos): bool { public function haveTagInRange(int $startPos, int $endPos): bool {
return $this->haveTokenInRange($startPos, $endPos, \T_OPEN_TAG) return $this->haveTokenInRange($startPos, $endPos, \T_OPEN_TAG)
|| $this->haveTokenInRange($startPos, $endPos, \T_CLOSE_TAG); || $this->haveTokenInRange($startPos, $endPos, \T_CLOSE_TAG);
@@ -224,8 +214,8 @@ class TokenStream {
/** /**
* Get the code corresponding to a token offset range, optionally adjusted for indentation. * Get the code corresponding to a token offset range, optionally adjusted for indentation.
* *
* @param int $from Token start position (inclusive) * @param int $from Token start position (inclusive)
* @param int $to Token end position (exclusive) * @param int $to Token end position (exclusive)
* @param int $indent By how much the code should be indented (can be negative as well) * @param int $indent By how much the code should be indented (can be negative as well)
* *
* @return string Code corresponding to token range, adjusted for indentation * @return string Code corresponding to token range, adjusted for indentation

View File

@@ -4,7 +4,7 @@ namespace PhpParser;
class JsonDecoder { class JsonDecoder {
/** @var \ReflectionClass<Node>[] Node type to reflection class map */ /** @var \ReflectionClass<Node>[] Node type to reflection class map */
private $reflectionClassCache; private array $reflectionClassCache;
/** @return mixed */ /** @return mixed */
public function decode(string $json) { public function decode(string $json) {

View File

@@ -5,91 +5,37 @@ namespace PhpParser;
require __DIR__ . '/compatibility_tokens.php'; require __DIR__ . '/compatibility_tokens.php';
class Lexer { class Lexer {
/** @var string Code being tokenized */
protected $code;
/** @var list<Token> List of tokens */
protected $tokens;
/** @var int Current position in the token array */
protected $pos;
/** @var bool Whether the preceding closing PHP tag has a trailing newline */
protected $prevCloseTagHasNewline;
/** @var array<int, int> Map of tokens that should be dropped (like T_WHITESPACE) */
protected $dropTokens;
/** @var bool Whether to use the startLine attribute */
private $attributeStartLineUsed;
/** @var bool Whether to use the endLine attribute */
private $attributeEndLineUsed;
/** @var bool Whether to use the startTokenPos attribute */
private $attributeStartTokenPosUsed;
/** @var bool Whether to use the endTokenPos attribute */
private $attributeEndTokenPosUsed;
/** @var bool Whether to use the startFilePos attribute */
private $attributeStartFilePosUsed;
/** @var bool Whether to use the endFilePos attribute */
private $attributeEndFilePosUsed;
/** @var bool Whether to use the comments attribute */
private $attributeCommentsUsed;
/** /**
* Creates a Lexer. * Tokenize the provided source code.
* *
* @param array{usedAttributes?: string[]} $options Options array. Currently only the * The token array is in the same format as provided by the PhpToken::tokenize() method in
* 'usedAttributes' option is supported, which is an array of attributes to add to the * PHP 8.0. The tokens are instances of PhpParser\Token, to abstract over a polyfill
* AST nodes. Possible attributes are: 'comments', 'startLine', 'endLine', 'startTokenPos', * implementation in earlier PHP version.
* 'endTokenPos', 'startFilePos', 'endFilePos'. The option defaults to the first three.
* For more info see getNextToken() docs.
*/
public function __construct(array $options = []) {
// map of tokens to drop while lexing (the map is only used for isset lookup,
// that's why the value is simply set to 1; the value is never actually used.)
$this->dropTokens = array_fill_keys(
[\T_WHITESPACE, \T_OPEN_TAG, \T_COMMENT, \T_DOC_COMMENT, \T_BAD_CHARACTER], 1
);
$defaultAttributes = ['comments', 'startLine', 'endLine'];
$usedAttributes = array_fill_keys($options['usedAttributes'] ?? $defaultAttributes, true);
// Create individual boolean properties to make these checks faster.
$this->attributeStartLineUsed = isset($usedAttributes['startLine']);
$this->attributeEndLineUsed = isset($usedAttributes['endLine']);
$this->attributeStartTokenPosUsed = isset($usedAttributes['startTokenPos']);
$this->attributeEndTokenPosUsed = isset($usedAttributes['endTokenPos']);
$this->attributeStartFilePosUsed = isset($usedAttributes['startFilePos']);
$this->attributeEndFilePosUsed = isset($usedAttributes['endFilePos']);
$this->attributeCommentsUsed = isset($usedAttributes['comments']);
}
/**
* Initializes the lexer for lexing the provided source code.
* *
* This function does not throw if lexing errors occur. Instead, errors may be retrieved using * The token array is terminated by a sentinel token with token ID 0.
* the getErrors() method. * The token array does not discard any tokens (i.e. whitespace and comments are included).
* The token position attributes are against this token array.
* *
* @param string $code The source code to lex * @param string $code The source code to tokenize.
* @param ErrorHandler|null $errorHandler Error handler to use for lexing errors. Defaults to * @param ErrorHandler|null $errorHandler Error handler to use for lexing errors. Defaults to
* ErrorHandler\Throwing * ErrorHandler\Throwing.
* @return Token[] Tokens
*/ */
public function startLexing(string $code, ?ErrorHandler $errorHandler = null): void { public function tokenize(string $code, ?ErrorHandler $errorHandler = null): array {
if (null === $errorHandler) { if (null === $errorHandler) {
$errorHandler = new ErrorHandler\Throwing(); $errorHandler = new ErrorHandler\Throwing();
} }
$this->code = $code; // keep the code around for __halt_compiler() handling
$this->pos = -1;
// If inline HTML occurs without preceding code, treat it as if it had a leading newline.
// This ensures proper composability, because having a newline is the "safe" assumption.
$this->prevCloseTagHasNewline = true;
$scream = ini_set('xdebug.scream', '0'); $scream = ini_set('xdebug.scream', '0');
$this->tokens = @Token::tokenize($code); $tokens = @Token::tokenize($code);
$this->postprocessTokens($errorHandler); $this->postprocessTokens($tokens, $errorHandler);
if (false !== $scream) { if (false !== $scream) {
ini_set('xdebug.scream', $scream); ini_set('xdebug.scream', $scream);
} }
return $tokens;
} }
private function handleInvalidCharacter(Token $token, ErrorHandler $errorHandler): void { private function handleInvalidCharacter(Token $token, ErrorHandler $errorHandler): void {
@@ -117,33 +63,36 @@ class Lexer {
&& substr($token->text, -2) !== '*/'; && substr($token->text, -2) !== '*/';
} }
protected function postprocessTokens(ErrorHandler $errorHandler): void { /**
* @param list<Token> $tokens
*/
protected function postprocessTokens(array &$tokens, ErrorHandler $errorHandler): void {
// This function reports errors (bad characters and unterminated comments) in the token // This function reports errors (bad characters and unterminated comments) in the token
// array, and performs certain canonicalizations: // array, and performs certain canonicalizations:
// * Use PHP 8.1 T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG and // * Use PHP 8.1 T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG and
// T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG tokens used to disambiguate intersection types. // T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG tokens used to disambiguate intersection types.
// * Add a sentinel token with ID 0. // * Add a sentinel token with ID 0.
$numTokens = \count($this->tokens); $numTokens = \count($tokens);
if ($numTokens === 0) { if ($numTokens === 0) {
// Empty input edge case: Just add the sentinel token. // Empty input edge case: Just add the sentinel token.
$this->tokens[] = new Token(0, "\0", 1, 0); $tokens[] = new Token(0, "\0", 1, 0);
return; return;
} }
for ($i = 0; $i < $numTokens; $i++) { for ($i = 0; $i < $numTokens; $i++) {
$token = $this->tokens[$i]; $token = $tokens[$i];
if ($token->id === \T_BAD_CHARACTER) { if ($token->id === \T_BAD_CHARACTER) {
$this->handleInvalidCharacter($token, $errorHandler); $this->handleInvalidCharacter($token, $errorHandler);
} }
if ($token->id === \ord('&')) { if ($token->id === \ord('&')) {
$next = $i + 1; $next = $i + 1;
while (isset($this->tokens[$next]) && $this->tokens[$next]->id === \T_WHITESPACE) { while (isset($tokens[$next]) && $tokens[$next]->id === \T_WHITESPACE) {
$next++; $next++;
} }
$followedByVarOrVarArg = isset($this->tokens[$next]) && $followedByVarOrVarArg = isset($tokens[$next]) &&
$this->tokens[$next]->is([\T_VARIABLE, \T_ELLIPSIS]); $tokens[$next]->is([\T_VARIABLE, \T_ELLIPSIS]);
$token->id = $followedByVarOrVarArg $token->id = $followedByVarOrVarArg
? \T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG ? \T_AMPERSAND_FOLLOWED_BY_VAR_OR_VARARG
: \T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG; : \T_AMPERSAND_NOT_FOLLOWED_BY_VAR_OR_VARARG;
@@ -151,7 +100,7 @@ class Lexer {
} }
// Check for unterminated comment // Check for unterminated comment
$lastToken = $this->tokens[$numTokens - 1]; $lastToken = $tokens[$numTokens - 1];
if ($this->isUnterminatedComment($lastToken)) { if ($this->isUnterminatedComment($lastToken)) {
$errorHandler->handleError(new Error('Unterminated comment', [ $errorHandler->handleError(new Error('Unterminated comment', [
'startLine' => $lastToken->line, 'startLine' => $lastToken->line,
@@ -162,115 +111,6 @@ class Lexer {
} }
// Add sentinel token. // Add sentinel token.
$this->tokens[] = new Token(0, "\0", $lastToken->getEndLine(), $lastToken->getEndPos()); $tokens[] = new Token(0, "\0", $lastToken->getEndLine(), $lastToken->getEndPos());
}
/**
* Fetches the next token.
*
* The available attributes are determined by the 'usedAttributes' option, which can
* be specified in the constructor. The following attributes are supported:
*
* * 'comments' => Array of PhpParser\Comment or PhpParser\Comment\Doc instances,
* representing all comments that occurred between the previous
* non-discarded token and the current one.
* * 'startLine' => Line in which the node starts.
* * 'endLine' => Line in which the node ends.
* * 'startTokenPos' => Offset into the token array of the first token in the node.
* * 'endTokenPos' => Offset into the token array of the last token in the node.
* * 'startFilePos' => Offset into the code string of the first character that is part of the node.
* * 'endFilePos' => Offset into the code string of the last character that is part of the node.
*
* @param mixed $value Variable to store token content in
* @param mixed $startAttributes Variable to store start attributes in
* @param mixed $endAttributes Variable to store end attributes in
*
* @return int Token id
*/
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null): int {
$startAttributes = [];
$endAttributes = [];
while (1) {
$token = $this->tokens[++$this->pos];
if ($this->attributeStartLineUsed) {
$startAttributes['startLine'] = $token->line;
}
if ($this->attributeStartTokenPosUsed) {
$startAttributes['startTokenPos'] = $this->pos;
}
if ($this->attributeStartFilePosUsed) {
$startAttributes['startFilePos'] = $token->pos;
}
$id = $token->id;
if (isset($this->dropTokens[$id])) {
if (\T_COMMENT === $id || \T_DOC_COMMENT === $id) {
if ($this->attributeCommentsUsed) {
$comment = \T_DOC_COMMENT === $id
? new Comment\Doc($token->text, $token->line, $token->pos, $this->pos,
$token->getEndLine(), $token->getEndPos() - 1, $this->pos)
: new Comment($token->text, $token->line, $token->pos, $this->pos,
$token->getEndLine(), $token->getEndPos() - 1, $this->pos);
$startAttributes['comments'][] = $comment;
}
}
continue;
}
$value = $token->text;
if (\T_CLOSE_TAG === $token->id) {
$this->prevCloseTagHasNewline = false !== strpos($value, "\n")
|| false !== strpos($value, "\r");
} elseif (\T_INLINE_HTML === $token->id) {
$startAttributes['hasLeadingNewline'] = $this->prevCloseTagHasNewline;
}
// Fetch the end line/pos from the next token (if available) instead of recomputing it.
$nextToken = $this->tokens[$this->pos + 1] ?? null;
if ($this->attributeEndLineUsed) {
$endAttributes['endLine'] = $nextToken ? $nextToken->line : $token->getEndLine();
}
if ($this->attributeEndTokenPosUsed) {
$endAttributes['endTokenPos'] = $this->pos;
}
if ($this->attributeEndFilePosUsed) {
$endAttributes['endFilePos'] = ($nextToken ? $nextToken->pos : $token->getEndPos()) - 1;
}
return $id;
}
}
/**
* Returns the token array for current code.
*
* The token array is in the same format as provided by the PhpToken::tokenize() method in
* PHP 8.0. The tokens are instances of PhpParser\Token, to abstract over a polyfill
* implementation in earlier PHP version.
*
* The token array is terminated by a sentinel token with token ID 0.
* The token array does not discard any tokens (i.e. whitespace and comments are included).
* The token position attributes are against this token array.
*
* @return Token[] Array of tokens
*/
public function getTokens(): array {
return $this->tokens;
}
/**
* Handles __halt_compiler() by returning the text after it.
*
* @return string Remaining text
*/
public function handleHaltCompiler(): string {
// Prevent the lexer from returning any further tokens.
$nextToken = $this->tokens[$this->pos + 1];
$this->pos = \count($this->tokens) - 2;
// Return text after __halt_compiler.
return $nextToken->id === \T_INLINE_HTML ? $nextToken->text : '';
} }
} }

View File

@@ -19,41 +19,28 @@ use PhpParser\Lexer\TokenEmulator\ReadonlyTokenEmulator;
use PhpParser\Lexer\TokenEmulator\ReverseEmulator; use PhpParser\Lexer\TokenEmulator\ReverseEmulator;
use PhpParser\Lexer\TokenEmulator\TokenEmulator; use PhpParser\Lexer\TokenEmulator\TokenEmulator;
use PhpParser\PhpVersion; use PhpParser\PhpVersion;
use PhpParser\Token;
class Emulative extends Lexer { class Emulative extends Lexer {
/** @var array{int, string, string}[] Patches used to reverse changes introduced in the code */ /** @var array{int, string, string}[] Patches used to reverse changes introduced in the code */
private $patches = []; private array $patches = [];
/** @var list<TokenEmulator> */ /** @var list<TokenEmulator> */
private $emulators = []; private array $emulators = [];
/** @var PhpVersion */ private PhpVersion $targetPhpVersion;
private $targetPhpVersion;
/** @var PhpVersion */ private PhpVersion $hostPhpVersion;
private $hostPhpVersion;
/** /**
* @param array{usedAttributes?: string[], phpVersion?: PhpVersion|string} $options Lexer options. * @param PhpVersion|null $phpVersion PHP version to emulate. Defaults to newest supported.
* In addition to the usual options, accepts a 'phpVersion' (PhpVersion object or string)
* that specifies the version to emulate. Defaults to newest supported.
*/ */
public function __construct(array $options = []) { public function __construct(?PhpVersion $phpVersion = null) {
$version = $options['phpVersion'] ?? PhpVersion::getNewestSupported(); $this->targetPhpVersion = $phpVersion ?? PhpVersion::getNewestSupported();
if (!$version instanceof PhpVersion) {
$version = PhpVersion::fromString($version);
}
$this->targetPhpVersion = $version;
$this->hostPhpVersion = PhpVersion::getHostVersion(); $this->hostPhpVersion = PhpVersion::getHostVersion();
unset($options['phpVersion']);
parent::__construct($options);
$emulators = [ $emulators = [
new FlexibleDocStringEmulator(),
new FnTokenEmulator(),
new MatchTokenEmulator(), new MatchTokenEmulator(),
new CoaleseEqualTokenEmulator(),
new NumericLiteralSeparatorEmulator(),
new NullsafeTokenEmulator(), new NullsafeTokenEmulator(),
new AttributeEmulator(), new AttributeEmulator(),
new EnumTokenEmulator(), new EnumTokenEmulator(),
@@ -74,15 +61,14 @@ class Emulative extends Lexer {
} }
} }
public function startLexing(string $code, ?ErrorHandler $errorHandler = null): void { public function tokenize(string $code, ?ErrorHandler $errorHandler = null): array {
$emulators = array_filter($this->emulators, function ($emulator) use ($code) { $emulators = array_filter($this->emulators, function ($emulator) use ($code) {
return $emulator->isEmulationNeeded($code); return $emulator->isEmulationNeeded($code);
}); });
if (empty($emulators)) { if (empty($emulators)) {
// Nothing to emulate, yay // Nothing to emulate, yay
parent::startLexing($code, $errorHandler); return parent::tokenize($code, $errorHandler);
return;
} }
if ($errorHandler === null) { if ($errorHandler === null) {
@@ -95,9 +81,9 @@ class Emulative extends Lexer {
} }
$collector = new ErrorHandler\Collecting(); $collector = new ErrorHandler\Collecting();
parent::startLexing($code, $collector); $tokens = parent::tokenize($code, $collector);
$this->sortPatches(); $this->sortPatches();
$this->fixupTokens(); $tokens = $this->fixupTokens($tokens);
$errors = $collector->getErrors(); $errors = $collector->getErrors();
if (!empty($errors)) { if (!empty($errors)) {
@@ -108,8 +94,10 @@ class Emulative extends Lexer {
} }
foreach ($emulators as $emulator) { foreach ($emulators as $emulator) {
$this->tokens = $emulator->emulate($code, $this->tokens); $tokens = $emulator->emulate($code, $tokens);
} }
return $tokens;
} }
private function isForwardEmulationNeeded(PhpVersion $emulatorPhpVersion): bool { private function isForwardEmulationNeeded(PhpVersion $emulatorPhpVersion): bool {
@@ -130,9 +118,13 @@ class Emulative extends Lexer {
}); });
} }
private function fixupTokens(): void { /**
* @param list<Token> $tokens
* @return list<Token>
*/
private function fixupTokens(array $tokens): array {
if (\count($this->patches) === 0) { if (\count($this->patches) === 0) {
return; return $tokens;
} }
// Load first patch // Load first patch
@@ -141,10 +133,12 @@ class Emulative extends Lexer {
// We use a manual loop over the tokens, because we modify the array on the fly // We use a manual loop over the tokens, because we modify the array on the fly
$posDelta = 0; $posDelta = 0;
for ($i = 0, $c = \count($this->tokens); $i < $c; $i++) { $lineDelta = 0;
$token = $this->tokens[$i]; for ($i = 0, $c = \count($tokens); $i < $c; $i++) {
$token = $tokens[$i];
$pos = $token->pos; $pos = $token->pos;
$token->pos += $posDelta; $token->pos += $posDelta;
$token->line += $lineDelta;
$localPosDelta = 0; $localPosDelta = 0;
$len = \strlen($token->text); $len = \strlen($token->text);
while ($patchPos >= $pos && $patchPos < $pos + $len) { while ($patchPos >= $pos && $patchPos < $pos + $len) {
@@ -152,7 +146,7 @@ class Emulative extends Lexer {
if ($patchType === 'remove') { if ($patchType === 'remove') {
if ($patchPos === $pos && $patchTextLen === $len) { if ($patchPos === $pos && $patchTextLen === $len) {
// Remove token entirely // Remove token entirely
array_splice($this->tokens, $i, 1, []); array_splice($tokens, $i, 1, []);
$i--; $i--;
$c--; $c--;
} else { } else {
@@ -162,12 +156,14 @@ class Emulative extends Lexer {
); );
$localPosDelta -= $patchTextLen; $localPosDelta -= $patchTextLen;
} }
$lineDelta -= \substr_count($patchText, "\n");
} elseif ($patchType === 'add') { } elseif ($patchType === 'add') {
// Insert into the token string // Insert into the token string
$token->text = substr_replace( $token->text = substr_replace(
$token->text, $patchText, $patchPos - $pos + $localPosDelta, 0 $token->text, $patchText, $patchPos - $pos + $localPosDelta, 0
); );
$localPosDelta += $patchTextLen; $localPosDelta += $patchTextLen;
$lineDelta += \substr_count($patchText, "\n");
} elseif ($patchType === 'replace') { } elseif ($patchType === 'replace') {
// Replace inside the token string // Replace inside the token string
$token->text = substr_replace( $token->text = substr_replace(
@@ -190,6 +186,7 @@ class Emulative extends Lexer {
$posDelta += $localPosDelta; $posDelta += $localPosDelta;
} }
return $tokens;
} }
/** /**

View File

@@ -1,40 +0,0 @@
<?php declare(strict_types=1);
namespace PhpParser\Lexer\TokenEmulator;
use PhpParser\PhpVersion;
use PhpParser\Token;
final class CoaleseEqualTokenEmulator extends TokenEmulator {
public function getPhpVersion(): PhpVersion {
return PhpVersion::fromComponents(7, 4);
}
public function isEmulationNeeded(string $code): bool {
return strpos($code, '??=') !== false;
}
public function emulate(string $code, array $tokens): array {
// We need to manually iterate and manage a count because we'll change
// the tokens array on the way
for ($i = 0, $c = count($tokens); $i < $c; ++$i) {
$token = $tokens[$i];
if (isset($tokens[$i + 1])) {
if ($token->id === T_COALESCE && $tokens[$i + 1]->text === '=') {
array_splice($tokens, $i, 2, [
new Token(\T_COALESCE_EQUAL, '??=', $token->line, $token->pos),
]);
$c--;
continue;
}
}
}
return $tokens;
}
public function reverseEmulate(string $code, array $tokens): array {
// ??= was not valid code previously, don't bother.
return $tokens;
}
}

View File

@@ -1,71 +0,0 @@
<?php declare(strict_types=1);
namespace PhpParser\Lexer\TokenEmulator;
use PhpParser\PhpVersion;
final class FlexibleDocStringEmulator extends TokenEmulator {
private const FLEXIBLE_DOC_STRING_REGEX = <<<'REGEX'
/<<<[ \t]*(['"]?)([a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*)\1\r?\n
(?:.*\r?\n)*?
(?<indentation>\h*)\2(?![a-zA-Z0-9_\x80-\xff])(?<separator>(?:;?[\r\n])?)/x
REGEX;
public function getPhpVersion(): PhpVersion {
return PhpVersion::fromComponents(7, 3);
}
public function isEmulationNeeded(string $code): bool {
return strpos($code, '<<<') !== false;
}
public function emulate(string $code, array $tokens): array {
// Handled by preprocessing + fixup.
return $tokens;
}
public function reverseEmulate(string $code, array $tokens): array {
// Not supported.
return $tokens;
}
public function preprocessCode(string $code, array &$patches): string {
if (!preg_match_all(self::FLEXIBLE_DOC_STRING_REGEX, $code, $matches, PREG_SET_ORDER|PREG_OFFSET_CAPTURE)) {
// No heredoc/nowdoc found
return $code;
}
// Keep track of how much we need to adjust string offsets due to the modifications we
// already made
$posDelta = 0;
foreach ($matches as $match) {
$indentation = $match['indentation'][0];
$indentationStart = $match['indentation'][1];
$separator = $match['separator'][0];
$separatorStart = $match['separator'][1];
if ($indentation === '' && $separator !== '') {
// Ordinary heredoc/nowdoc
continue;
}
if ($indentation !== '') {
// Remove indentation
$indentationLen = strlen($indentation);
$code = substr_replace($code, '', $indentationStart + $posDelta, $indentationLen);
$patches[] = [$indentationStart + $posDelta, 'add', $indentation];
$posDelta -= $indentationLen;
}
if ($separator === '') {
// Insert newline as separator
$code = substr_replace($code, "\n", $separatorStart + $posDelta, 0);
$patches[] = [$separatorStart + $posDelta, 'remove', "\n"];
$posDelta += 1;
}
}
return $code;
}
}

View File

@@ -1,19 +0,0 @@
<?php declare(strict_types=1);
namespace PhpParser\Lexer\TokenEmulator;
use PhpParser\PhpVersion;
final class FnTokenEmulator extends KeywordEmulator {
public function getPhpVersion(): PhpVersion {
return PhpVersion::fromComponents(7, 4);
}
public function getKeywordString(): string {
return 'fn';
}
public function getKeywordToken(): int {
return \T_FN;
}
}

View File

@@ -1,95 +0,0 @@
<?php declare(strict_types=1);
namespace PhpParser\Lexer\TokenEmulator;
use PhpParser\PhpVersion;
use PhpParser\Token;
final class NumericLiteralSeparatorEmulator extends TokenEmulator {
private const BIN = '(?:0b[01]+(?:_[01]+)*)';
private const HEX = '(?:0x[0-9a-f]+(?:_[0-9a-f]+)*)';
private const DEC = '(?:[0-9]+(?:_[0-9]+)*)';
private const SIMPLE_FLOAT = '(?:' . self::DEC . '\.' . self::DEC . '?|\.' . self::DEC . ')';
private const EXP = '(?:e[+-]?' . self::DEC . ')';
private const FLOAT = '(?:' . self::SIMPLE_FLOAT . self::EXP . '?|' . self::DEC . self::EXP . ')';
private const NUMBER = '~' . self::FLOAT . '|' . self::BIN . '|' . self::HEX . '|' . self::DEC . '~iA';
public function getPhpVersion(): PhpVersion {
return PhpVersion::fromComponents(7, 4);
}
public function isEmulationNeeded(string $code): bool {
return preg_match('~[0-9]_[0-9]~', $code)
|| preg_match('~0x[0-9a-f]+_[0-9a-f]~i', $code);
}
public function emulate(string $code, array $tokens): array {
// We need to manually iterate and manage a count because we'll change
// the tokens array on the way
for ($i = 0, $c = count($tokens); $i < $c; ++$i) {
$token = $tokens[$i];
$tokenLen = \strlen($token->text);
if ($token->id !== \T_LNUMBER && $token->id !== \T_DNUMBER) {
continue;
}
$res = preg_match(self::NUMBER, $code, $matches, 0, $token->pos);
assert($res, "No number at number token position");
$match = $matches[0];
$matchLen = \strlen($match);
if ($matchLen === $tokenLen) {
// Original token already holds the full number.
continue;
}
$tokenKind = $this->resolveIntegerOrFloatToken($match);
$newTokens = [new Token($tokenKind, $match, $token->line, $token->pos)];
$numTokens = 1;
$len = $tokenLen;
while ($matchLen > $len) {
$nextToken = $tokens[$i + $numTokens];
$nextTokenText = $nextToken->text;
$nextTokenLen = \strlen($nextTokenText);
$numTokens++;
if ($matchLen < $len + $nextTokenLen) {
// Split trailing characters into a partial token.
$partialText = substr($nextTokenText, $matchLen - $len);
$newTokens[] = new Token($nextToken->id, $partialText, $nextToken->line, $nextToken->pos);
break;
}
$len += $nextTokenLen;
}
array_splice($tokens, $i, $numTokens, $newTokens);
$c -= $numTokens - \count($newTokens);
}
return $tokens;
}
private function resolveIntegerOrFloatToken(string $str): int {
$str = str_replace('_', '', $str);
if (stripos($str, '0b') === 0) {
$num = bindec($str);
} elseif (stripos($str, '0x') === 0) {
$num = hexdec($str);
} elseif (stripos($str, '0') === 0 && ctype_digit($str)) {
$num = octdec($str);
} else {
$num = +$str;
}
return is_float($num) ? T_DNUMBER : T_LNUMBER;
}
public function reverseEmulate(string $code, array $tokens): array {
// Numeric separators were not legal code previously, don't bother.
return $tokens;
}
}

View File

@@ -9,7 +9,7 @@ use PhpParser\PhpVersion;
*/ */
final class ReverseEmulator extends TokenEmulator { final class ReverseEmulator extends TokenEmulator {
/** @var TokenEmulator Inner emulator */ /** @var TokenEmulator Inner emulator */
private $emulator; private TokenEmulator $emulator;
public function __construct(TokenEmulator $emulator) { public function __construct(TokenEmulator $emulator) {
$this->emulator = $emulator; $this->emulator = $emulator;

View File

@@ -8,16 +8,16 @@ use PhpParser\Node\Stmt;
class NameContext { class NameContext {
/** @var null|Name Current namespace */ /** @var null|Name Current namespace */
protected $namespace; protected ?Name $namespace;
/** @var Name[][] Map of format [aliasType => [aliasName => originalName]] */ /** @var Name[][] Map of format [aliasType => [aliasName => originalName]] */
protected $aliases = []; protected array $aliases = [];
/** @var Name[][] Same as $aliases but preserving original case */ /** @var Name[][] Same as $aliases but preserving original case */
protected $origAliases = []; protected array $origAliases = [];
/** @var ErrorHandler Error handler */ /** @var ErrorHandler Error handler */
protected $errorHandler; protected ErrorHandler $errorHandler;
/** /**
* Create a name context. * Create a name context.
@@ -47,9 +47,9 @@ class NameContext {
/** /**
* Add an alias / import. * Add an alias / import.
* *
* @param Name $name Original name * @param Name $name Original name
* @param string $aliasName Aliased name * @param string $aliasName Aliased name
* @param int $type One of Stmt\Use_::TYPE_* * @param Stmt\Use_::TYPE_* $type One of Stmt\Use_::TYPE_*
* @param array<string, mixed> $errorAttrs Attributes to use to report an error * @param array<string, mixed> $errorAttrs Attributes to use to report an error
*/ */
public function addAlias(Name $name, string $aliasName, int $type, array $errorAttrs = []): void { public function addAlias(Name $name, string $aliasName, int $type, array $errorAttrs = []): void {
@@ -94,7 +94,7 @@ class NameContext {
* Get resolved name. * Get resolved name.
* *
* @param Name $name Name to resolve * @param Name $name Name to resolve
* @param int $type One of Stmt\Use_::TYPE_{FUNCTION|CONSTANT} * @param Stmt\Use_::TYPE_* $type One of Stmt\Use_::TYPE_{FUNCTION|CONSTANT}
* *
* @return null|Name Resolved name, or null if static resolution is not possible * @return null|Name Resolved name, or null if static resolution is not possible
*/ */
@@ -149,7 +149,7 @@ class NameContext {
* Get possible ways of writing a fully qualified name (e.g., by making use of aliases). * Get possible ways of writing a fully qualified name (e.g., by making use of aliases).
* *
* @param string $name Fully-qualified name (without leading namespace separator) * @param string $name Fully-qualified name (without leading namespace separator)
* @param int $type One of Stmt\Use_::TYPE_* * @param Stmt\Use_::TYPE_* $type One of Stmt\Use_::TYPE_*
* *
* @return Name[] Possible representations of the name * @return Name[] Possible representations of the name
*/ */
@@ -205,7 +205,7 @@ class NameContext {
* Get shortest representation of this fully-qualified name. * Get shortest representation of this fully-qualified name.
* *
* @param string $name Fully-qualified name (without leading namespace separator) * @param string $name Fully-qualified name (without leading namespace separator)
* @param int $type One of Stmt\Use_::TYPE_* * @param Stmt\Use_::TYPE_* $type One of Stmt\Use_::TYPE_*
* *
* @return Name Shortest representation * @return Name Shortest representation
*/ */

View File

@@ -21,6 +21,8 @@ interface Node {
* Gets line the node started in (alias of getStartLine). * Gets line the node started in (alias of getStartLine).
* *
* @return int Start line (or -1 if not available) * @return int Start line (or -1 if not available)
*
* @deprecated Use getStartLine() instead
*/ */
public function getLine(): int; public function getLine(): int;
@@ -110,25 +112,19 @@ interface Node {
/** /**
* Sets an attribute on a node. * Sets an attribute on a node.
* *
* @param string $key * @param mixed $value
* @param mixed $value
*/ */
public function setAttribute(string $key, $value): void; public function setAttribute(string $key, $value): void;
/** /**
* Returns whether an attribute exists. * Returns whether an attribute exists.
*
* @param string $key
*
* @return bool
*/ */
public function hasAttribute(string $key): bool; public function hasAttribute(string $key): bool;
/** /**
* Returns the value of an attribute. * Returns the value of an attribute.
* *
* @param string $key * @param mixed $default
* @param mixed $default
* *
* @return mixed * @return mixed
*/ */

View File

@@ -6,20 +6,20 @@ use PhpParser\NodeAbstract;
class Arg extends NodeAbstract { class Arg extends NodeAbstract {
/** @var Identifier|null Parameter name (for named parameters) */ /** @var Identifier|null Parameter name (for named parameters) */
public $name; public ?Identifier $name;
/** @var Expr Value to pass */ /** @var Expr Value to pass */
public $value; public Expr $value;
/** @var bool Whether to pass by ref */ /** @var bool Whether to pass by ref */
public $byRef; public bool $byRef;
/** @var bool Whether to unpack the argument */ /** @var bool Whether to unpack the argument */
public $unpack; public bool $unpack;
/** /**
* Constructs a function call argument node. * Constructs a function call argument node.
* *
* @param Expr $value Value to pass * @param Expr $value Value to pass
* @param bool $byRef Whether to pass by ref * @param bool $byRef Whether to pass by ref
* @param bool $unpack Whether to unpack the argument * @param bool $unpack Whether to unpack the argument
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
* @param Identifier|null $name Parameter name (for named parameters) * @param Identifier|null $name Parameter name (for named parameters)
*/ */

View File

@@ -6,20 +6,20 @@ use PhpParser\NodeAbstract;
class ArrayItem extends NodeAbstract { class ArrayItem extends NodeAbstract {
/** @var null|Expr Key */ /** @var null|Expr Key */
public $key; public ?Expr $key;
/** @var Expr Value */ /** @var Expr Value */
public $value; public Expr $value;
/** @var bool Whether to assign by reference */ /** @var bool Whether to assign by reference */
public $byRef; public bool $byRef;
/** @var bool Whether to unpack the argument */ /** @var bool Whether to unpack the argument */
public $unpack; public bool $unpack;
/** /**
* Constructs an array item node. * Constructs an array item node.
* *
* @param Expr $value Value * @param Expr $value Value
* @param null|Expr $key Key * @param null|Expr $key Key
* @param bool $byRef Whether to assign by reference * @param bool $byRef Whether to assign by reference
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $value, ?Expr $key = null, bool $byRef = false, array $attributes = [], bool $unpack = false) { public function __construct(Expr $value, ?Expr $key = null, bool $byRef = false, array $attributes = [], bool $unpack = false) {

View File

@@ -7,13 +7,13 @@ use PhpParser\NodeAbstract;
class Attribute extends NodeAbstract { class Attribute extends NodeAbstract {
/** @var Name Attribute name */ /** @var Name Attribute name */
public $name; public Name $name;
/** @var list<Arg> Attribute arguments */ /** @var list<Arg> Attribute arguments */
public $args; public array $args;
/** /**
* @param Node\Name $name Attribute name * @param Node\Name $name Attribute name
* @param list<Arg> $args Attribute arguments * @param list<Arg> $args Attribute arguments
* @param array<string, mixed> $attributes Additional node attributes * @param array<string, mixed> $attributes Additional node attributes
*/ */

View File

@@ -6,7 +6,7 @@ use PhpParser\NodeAbstract;
class AttributeGroup extends NodeAbstract { class AttributeGroup extends NodeAbstract {
/** @var Attribute[] Attributes */ /** @var Attribute[] Attributes */
public $attrs; public array $attrs;
/** /**
* @param Attribute[] $attrs PHP attributes * @param Attribute[] $attrs PHP attributes

View File

@@ -6,15 +6,15 @@ use PhpParser\NodeAbstract;
class ClosureUse extends NodeAbstract { class ClosureUse extends NodeAbstract {
/** @var Expr\Variable Variable to use */ /** @var Expr\Variable Variable to use */
public $var; public Expr\Variable $var;
/** @var bool Whether to use by reference */ /** @var bool Whether to use by reference */
public $byRef; public bool $byRef;
/** /**
* Constructs a closure use node. * Constructs a closure use node.
* *
* @param Expr\Variable $var Variable to use * @param Expr\Variable $var Variable to use
* @param bool $byRef Whether to use by reference * @param bool $byRef Whether to use by reference
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr\Variable $var, bool $byRef = false, array $attributes = []) { public function __construct(Expr\Variable $var, bool $byRef = false, array $attributes = []) {

View File

@@ -6,18 +6,18 @@ use PhpParser\NodeAbstract;
class Const_ extends NodeAbstract { class Const_ extends NodeAbstract {
/** @var Identifier Name */ /** @var Identifier Name */
public $name; public Identifier $name;
/** @var Expr Value */ /** @var Expr Value */
public $value; public Expr $value;
/** @var Name|null Namespaced name (if using NameResolver) */ /** @var Name|null Namespaced name (if using NameResolver) */
public $namespacedName; public ?Name $namespacedName;
/** /**
* Constructs a const node for use in class const and const statements. * Constructs a const node for use in class const and const statements.
* *
* @param string|Identifier $name Name * @param string|Identifier $name Name
* @param Expr $value Value * @param Expr $value Value
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct($name, Expr $value, array $attributes = []) { public function __construct($name, Expr $value, array $attributes = []) {

View File

@@ -7,15 +7,15 @@ use PhpParser\NodeAbstract;
class DeclareItem extends NodeAbstract { class DeclareItem extends NodeAbstract {
/** @var Node\Identifier Key */ /** @var Node\Identifier Key */
public $key; public Identifier $key;
/** @var Node\Expr Value */ /** @var Node\Expr Value */
public $value; public Expr $value;
/** /**
* Constructs a declare key=>value pair node. * Constructs a declare key=>value pair node.
* *
* @param string|Node\Identifier $key Key * @param string|Node\Identifier $key Key
* @param Node\Expr $value Value * @param Node\Expr $value Value
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct($key, Node\Expr $value, array $attributes = []) { public function __construct($key, Node\Expr $value, array $attributes = []) {

View File

@@ -6,15 +6,15 @@ use PhpParser\Node\Expr;
class ArrayDimFetch extends Expr { class ArrayDimFetch extends Expr {
/** @var Expr Variable */ /** @var Expr Variable */
public $var; public Expr $var;
/** @var null|Expr Array index / dim */ /** @var null|Expr Array index / dim */
public $dim; public ?Expr $dim;
/** /**
* Constructs an array index fetch node. * Constructs an array index fetch node.
* *
* @param Expr $var Variable * @param Expr $var Variable
* @param null|Expr $dim Array index / dim * @param null|Expr $dim Array index / dim
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, ?Expr $dim = null, array $attributes = []) { public function __construct(Expr $var, ?Expr $dim = null, array $attributes = []) {

View File

@@ -11,12 +11,12 @@ class Array_ extends Expr {
public const KIND_SHORT = 2; // [] syntax public const KIND_SHORT = 2; // [] syntax
/** @var ArrayItem[] Items */ /** @var ArrayItem[] Items */
public $items; public array $items;
/** /**
* Constructs an array node. * Constructs an array node.
* *
* @param ArrayItem[] $items Items of the array * @param ArrayItem[] $items Items of the array
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(array $items = [], array $attributes = []) { public function __construct(array $items = [], array $attributes = []) {

View File

@@ -7,22 +7,22 @@ use PhpParser\Node\Expr;
use PhpParser\Node\FunctionLike; use PhpParser\Node\FunctionLike;
class ArrowFunction extends Expr implements FunctionLike { class ArrowFunction extends Expr implements FunctionLike {
/** @var bool */ /** @var bool Whether the closure is static */
public $static; public bool $static;
/** @var bool */ /** @var bool Whether to return by reference */
public $byRef; public bool $byRef;
/** @var Node\Param[] */ /** @var Node\Param[] */
public $params = []; public array $params = [];
/** @var null|Node\Identifier|Node\Name|Node\ComplexType */ /** @var null|Node\Identifier|Node\Name|Node\ComplexType */
public $returnType; public ?Node $returnType;
/** @var Expr */ /** @var Expr Expression body */
public $expr; public Expr $expr;
/** @var Node\AttributeGroup[] */ /** @var Node\AttributeGroup[] */
public $attrGroups; public array $attrGroups;
/** /**
* @param array{ * @param array{

View File

@@ -6,15 +6,15 @@ use PhpParser\Node\Expr;
class Assign extends Expr { class Assign extends Expr {
/** @var Expr Variable */ /** @var Expr Variable */
public $var; public Expr $var;
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs an assignment node. * Constructs an assignment node.
* *
* @param Expr $var Variable * @param Expr $var Variable
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = []) { public function __construct(Expr $var, Expr $expr, array $attributes = []) {

View File

@@ -6,15 +6,15 @@ use PhpParser\Node\Expr;
abstract class AssignOp extends Expr { abstract class AssignOp extends Expr {
/** @var Expr Variable */ /** @var Expr Variable */
public $var; public Expr $var;
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs a compound assignment operation node. * Constructs a compound assignment operation node.
* *
* @param Expr $var Variable * @param Expr $var Variable
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = []) { public function __construct(Expr $var, Expr $expr, array $attributes = []) {

View File

@@ -6,15 +6,15 @@ use PhpParser\Node\Expr;
class AssignRef extends Expr { class AssignRef extends Expr {
/** @var Expr Variable reference is assigned to */ /** @var Expr Variable reference is assigned to */
public $var; public Expr $var;
/** @var Expr Variable which is referenced */ /** @var Expr Variable which is referenced */
public $expr; public Expr $expr;
/** /**
* Constructs an assignment node. * Constructs an assignment node.
* *
* @param Expr $var Variable * @param Expr $var Variable
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = []) { public function __construct(Expr $var, Expr $expr, array $attributes = []) {

View File

@@ -6,15 +6,15 @@ use PhpParser\Node\Expr;
abstract class BinaryOp extends Expr { abstract class BinaryOp extends Expr {
/** @var Expr The left hand side expression */ /** @var Expr The left hand side expression */
public $left; public Expr $left;
/** @var Expr The right hand side expression */ /** @var Expr The right hand side expression */
public $right; public Expr $right;
/** /**
* Constructs a binary operator node. * Constructs a binary operator node.
* *
* @param Expr $left The left hand side expression * @param Expr $left The left hand side expression
* @param Expr $right The right hand side expression * @param Expr $right The right hand side expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $left, Expr $right, array $attributes = []) { public function __construct(Expr $left, Expr $right, array $attributes = []) {
@@ -32,8 +32,6 @@ abstract class BinaryOp extends Expr {
* *
* In the case there are multiple possible sigils for an operator, this method does not * In the case there are multiple possible sigils for an operator, this method does not
* necessarily return the one used in the parsed code. * necessarily return the one used in the parsed code.
*
* @return string
*/ */
abstract public function getOperatorSigil(): string; abstract public function getOperatorSigil(): string;
} }

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class BitwiseNot extends Expr { class BitwiseNot extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs a bitwise not node. * Constructs a bitwise not node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = []) { public function __construct(Expr $expr, array $attributes = []) {

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class BooleanNot extends Expr { class BooleanNot extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs a boolean not node. * Constructs a boolean not node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = []) { public function __construct(Expr $expr, array $attributes = []) {

View File

@@ -19,12 +19,8 @@ abstract class CallLike extends Expr {
* Returns whether this call expression is actually a first class callable. * Returns whether this call expression is actually a first class callable.
*/ */
public function isFirstClassCallable(): bool { public function isFirstClassCallable(): bool {
foreach ($this->getRawArgs() as $arg) { $rawArgs = $this->getRawArgs();
if ($arg instanceof VariadicPlaceholder) { return count($rawArgs) === 1 && current($rawArgs) instanceof VariadicPlaceholder;
return true;
}
}
return false;
} }
/** /**

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
abstract class Cast extends Expr { abstract class Cast extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs a cast node. * Constructs a cast node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = []) { public function __construct(Expr $expr, array $attributes = []) {

View File

@@ -2,15 +2,16 @@
namespace PhpParser\Node\Expr; namespace PhpParser\Node\Expr;
use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\Identifier; use PhpParser\Node\Identifier;
use PhpParser\Node\Name; use PhpParser\Node\Name;
class ClassConstFetch extends Expr { class ClassConstFetch extends Expr {
/** @var Name|Expr Class name */ /** @var Name|Expr Class name */
public $class; public Node $class;
/** @var Identifier|Expr|Error Constant name */ /** @var Identifier|Expr|Error Constant name */
public $name; public Node $name;
/** /**
* Constructs a class const fetch node. * Constructs a class const fetch node.
@@ -19,7 +20,7 @@ class ClassConstFetch extends Expr {
* @param string|Identifier|Expr|Error $name Constant name * @param string|Identifier|Expr|Error $name Constant name
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct($class, $name, array $attributes = []) { public function __construct(Node $class, $name, array $attributes = []) {
$this->attributes = $attributes; $this->attributes = $attributes;
$this->class = $class; $this->class = $class;
$this->name = \is_string($name) ? new Identifier($name) : $name; $this->name = \is_string($name) ? new Identifier($name) : $name;

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class Clone_ extends Expr { class Clone_ extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs a clone node. * Constructs a clone node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = []) { public function __construct(Expr $expr, array $attributes = []) {

View File

@@ -9,19 +9,19 @@ use PhpParser\Node\FunctionLike;
class Closure extends Expr implements FunctionLike { class Closure extends Expr implements FunctionLike {
/** @var bool Whether the closure is static */ /** @var bool Whether the closure is static */
public $static; public bool $static;
/** @var bool Whether to return by reference */ /** @var bool Whether to return by reference */
public $byRef; public bool $byRef;
/** @var Node\Param[] Parameters */ /** @var Node\Param[] Parameters */
public $params; public array $params;
/** @var ClosureUse[] use()s */ /** @var ClosureUse[] use()s */
public $uses; public array $uses;
/** @var null|Node\Identifier|Node\Name|Node\ComplexType Return type */ /** @var null|Node\Identifier|Node\Name|Node\ComplexType Return type */
public $returnType; public ?Node $returnType;
/** @var Node\Stmt[] Statements */ /** @var Node\Stmt[] Statements */
public $stmts; public array $stmts;
/** @var Node\AttributeGroup[] PHP attribute groups */ /** @var Node\AttributeGroup[] PHP attribute groups */
public $attrGroups; public array $attrGroups;
/** /**
* Constructs a lambda function node. * Constructs a lambda function node.

View File

@@ -7,12 +7,12 @@ use PhpParser\Node\Name;
class ConstFetch extends Expr { class ConstFetch extends Expr {
/** @var Name Constant name */ /** @var Name Constant name */
public $name; public Name $name;
/** /**
* Constructs a const fetch node. * Constructs a const fetch node.
* *
* @param Name $name Constant name * @param Name $name Constant name
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Name $name, array $attributes = []) { public function __construct(Name $name, array $attributes = []) {

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class Empty_ extends Expr { class Empty_ extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs an empty() node. * Constructs an empty() node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = []) { public function __construct(Expr $expr, array $attributes = []) {

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class ErrorSuppress extends Expr { class ErrorSuppress extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs an error suppress node. * Constructs an error suppress node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = []) { public function __construct(Expr $expr, array $attributes = []) {

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class Eval_ extends Expr { class Eval_ extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** /**
* Constructs an eval() node. * Constructs an eval() node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = []) { public function __construct(Expr $expr, array $attributes = []) {

View File

@@ -10,12 +10,12 @@ class Exit_ extends Expr {
public const KIND_DIE = 2; public const KIND_DIE = 2;
/** @var null|Expr Expression */ /** @var null|Expr Expression */
public $expr; public ?Expr $expr;
/** /**
* Constructs an exit() node. * Constructs an exit() node.
* *
* @param null|Expr $expr Expression * @param null|Expr $expr Expression
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(?Expr $expr = null, array $attributes = []) { public function __construct(?Expr $expr = null, array $attributes = []) {

View File

@@ -7,18 +7,18 @@ use PhpParser\Node\Expr;
class FuncCall extends CallLike { class FuncCall extends CallLike {
/** @var Node\Name|Expr Function name */ /** @var Node\Name|Expr Function name */
public $name; public Node $name;
/** @var array<Node\Arg|Node\VariadicPlaceholder> Arguments */ /** @var array<Node\Arg|Node\VariadicPlaceholder> Arguments */
public $args; public array $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
* @param Node\Name|Expr $name Function name * @param Node\Name|Expr $name Function name
* @param array<Node\Arg|Node\VariadicPlaceholder> $args Arguments * @param array<Node\Arg|Node\VariadicPlaceholder> $args Arguments
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct($name, array $args = [], array $attributes = []) { public function __construct(Node $name, array $args = [], array $attributes = []) {
$this->attributes = $attributes; $this->attributes = $attributes;
$this->name = $name; $this->name = $name;
$this->args = $args; $this->args = $args;

View File

@@ -11,15 +11,15 @@ class Include_ extends Expr {
public const TYPE_REQUIRE_ONCE = 4; public const TYPE_REQUIRE_ONCE = 4;
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** @var int Type of include */ /** @var int Type of include */
public $type; public int $type;
/** /**
* Constructs an include node. * Constructs an include node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param int $type Type of include * @param int $type Type of include
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, int $type, array $attributes = []) { public function __construct(Expr $expr, int $type, array $attributes = []) {

View File

@@ -2,23 +2,24 @@
namespace PhpParser\Node\Expr; namespace PhpParser\Node\Expr;
use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
class Instanceof_ extends Expr { class Instanceof_ extends Expr {
/** @var Expr Expression */ /** @var Expr Expression */
public $expr; public Expr $expr;
/** @var Name|Expr Class name */ /** @var Name|Expr Class name */
public $class; public Node $class;
/** /**
* Constructs an instanceof check node. * Constructs an instanceof check node.
* *
* @param Expr $expr Expression * @param Expr $expr Expression
* @param Name|Expr $class Class name * @param Name|Expr $class Class name
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $expr, $class, array $attributes = []) { public function __construct(Expr $expr, Node $class, array $attributes = []) {
$this->attributes = $attributes; $this->attributes = $attributes;
$this->expr = $expr; $this->expr = $expr;
$this->class = $class; $this->class = $class;

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class Isset_ extends Expr { class Isset_ extends Expr {
/** @var Expr[] Variables */ /** @var Expr[] Variables */
public $vars; public array $vars;
/** /**
* Constructs an array node. * Constructs an array node.
* *
* @param Expr[] $vars Variables * @param Expr[] $vars Variables
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(array $vars, array $attributes = []) { public function __construct(array $vars, array $attributes = []) {

View File

@@ -11,12 +11,12 @@ class List_ extends Expr {
public const KIND_ARRAY = 2; // [] syntax public const KIND_ARRAY = 2; // [] syntax
/** @var (ArrayItem|null)[] List of items to assign to */ /** @var (ArrayItem|null)[] List of items to assign to */
public $items; public array $items;
/** /**
* Constructs a list() destructuring node. * Constructs a list() destructuring node.
* *
* @param (ArrayItem|null)[] $items List of items to assign to * @param (ArrayItem|null)[] $items List of items to assign to
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(array $items, array $attributes = []) { public function __construct(array $items, array $attributes = []) {

View File

@@ -6,13 +6,15 @@ use PhpParser\Node;
use PhpParser\Node\MatchArm; use PhpParser\Node\MatchArm;
class Match_ extends Node\Expr { class Match_ extends Node\Expr {
/** @var Node\Expr */ /** @var Node\Expr Condition */
public $cond; public Node\Expr $cond;
/** @var MatchArm[] */ /** @var MatchArm[] */
public $arms; public array $arms;
/** /**
* @param Node\Expr $cond Condition
* @param MatchArm[] $arms * @param MatchArm[] $arms
* @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Node\Expr $cond, array $arms = [], array $attributes = []) { public function __construct(Node\Expr $cond, array $arms = [], array $attributes = []) {
$this->attributes = $attributes; $this->attributes = $attributes;

View File

@@ -2,6 +2,7 @@
namespace PhpParser\Node\Expr; namespace PhpParser\Node\Expr;
use PhpParser\Node;
use PhpParser\Node\Arg; use PhpParser\Node\Arg;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\Identifier; use PhpParser\Node\Identifier;
@@ -9,18 +10,18 @@ use PhpParser\Node\VariadicPlaceholder;
class MethodCall extends CallLike { class MethodCall extends CallLike {
/** @var Expr Variable holding object */ /** @var Expr Variable holding object */
public $var; public Expr $var;
/** @var Identifier|Expr Method name */ /** @var Identifier|Expr Method name */
public $name; public Node $name;
/** @var array<Arg|VariadicPlaceholder> Arguments */ /** @var array<Arg|VariadicPlaceholder> Arguments */
public $args; public array $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
* @param Expr $var Variable holding object * @param Expr $var Variable holding object
* @param string|Identifier|Expr $name Method name * @param string|Identifier|Expr $name Method name
* @param array<Arg|VariadicPlaceholder> $args Arguments * @param array<Arg|VariadicPlaceholder> $args Arguments
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, $name, array $args = [], array $attributes = []) { public function __construct(Expr $var, $name, array $args = [], array $attributes = []) {

View File

@@ -9,18 +9,18 @@ use PhpParser\Node\VariadicPlaceholder;
class New_ extends CallLike { class New_ extends CallLike {
/** @var Node\Name|Expr|Node\Stmt\Class_ Class name */ /** @var Node\Name|Expr|Node\Stmt\Class_ Class name */
public $class; public Node $class;
/** @var array<Arg|VariadicPlaceholder> Arguments */ /** @var array<Arg|VariadicPlaceholder> Arguments */
public $args; public array $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
* @param Node\Name|Expr|Node\Stmt\Class_ $class Class name (or class node for anonymous classes) * @param Node\Name|Expr|Node\Stmt\Class_ $class Class name (or class node for anonymous classes)
* @param array<Arg|VariadicPlaceholder> $args Arguments * @param array<Arg|VariadicPlaceholder> $args Arguments
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct($class, array $args = [], array $attributes = []) { public function __construct(Node $class, array $args = [], array $attributes = []) {
$this->attributes = $attributes; $this->attributes = $attributes;
$this->class = $class; $this->class = $class;
$this->args = $args; $this->args = $args;

View File

@@ -2,6 +2,7 @@
namespace PhpParser\Node\Expr; namespace PhpParser\Node\Expr;
use PhpParser\Node;
use PhpParser\Node\Arg; use PhpParser\Node\Arg;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\Identifier; use PhpParser\Node\Identifier;
@@ -9,18 +10,18 @@ use PhpParser\Node\VariadicPlaceholder;
class NullsafeMethodCall extends CallLike { class NullsafeMethodCall extends CallLike {
/** @var Expr Variable holding object */ /** @var Expr Variable holding object */
public $var; public Expr $var;
/** @var Identifier|Expr Method name */ /** @var Identifier|Expr Method name */
public $name; public Node $name;
/** @var array<Arg|VariadicPlaceholder> Arguments */ /** @var array<Arg|VariadicPlaceholder> Arguments */
public $args; public array $args;
/** /**
* Constructs a nullsafe method call node. * Constructs a nullsafe method call node.
* *
* @param Expr $var Variable holding object * @param Expr $var Variable holding object
* @param string|Identifier|Expr $name Method name * @param string|Identifier|Expr $name Method name
* @param array<Arg|VariadicPlaceholder> $args Arguments * @param array<Arg|VariadicPlaceholder> $args Arguments
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, $name, array $args = [], array $attributes = []) { public function __construct(Expr $var, $name, array $args = [], array $attributes = []) {

View File

@@ -2,20 +2,21 @@
namespace PhpParser\Node\Expr; namespace PhpParser\Node\Expr;
use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\Identifier; use PhpParser\Node\Identifier;
class NullsafePropertyFetch extends Expr { class NullsafePropertyFetch extends Expr {
/** @var Expr Variable holding object */ /** @var Expr Variable holding object */
public $var; public Expr $var;
/** @var Identifier|Expr Property name */ /** @var Identifier|Expr Property name */
public $name; public Node $name;
/** /**
* Constructs a nullsafe property fetch node. * Constructs a nullsafe property fetch node.
* *
* @param Expr $var Variable holding object * @param Expr $var Variable holding object
* @param string|Identifier|Expr $name Property name * @param string|Identifier|Expr $name Property name
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, $name, array $attributes = []) { public function __construct(Expr $var, $name, array $attributes = []) {

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class PostDec extends Expr { class PostDec extends Expr {
/** @var Expr Variable */ /** @var Expr Variable */
public $var; public Expr $var;
/** /**
* Constructs a post decrement node. * Constructs a post decrement node.
* *
* @param Expr $var Variable * @param Expr $var Variable
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = []) { public function __construct(Expr $var, array $attributes = []) {

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class PostInc extends Expr { class PostInc extends Expr {
/** @var Expr Variable */ /** @var Expr Variable */
public $var; public Expr $var;
/** /**
* Constructs a post increment node. * Constructs a post increment node.
* *
* @param Expr $var Variable * @param Expr $var Variable
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = []) { public function __construct(Expr $var, array $attributes = []) {

View File

@@ -6,12 +6,12 @@ use PhpParser\Node\Expr;
class PreDec extends Expr { class PreDec extends Expr {
/** @var Expr Variable */ /** @var Expr Variable */
public $var; public Expr $var;
/** /**
* Constructs a pre decrement node. * Constructs a pre decrement node.
* *
* @param Expr $var Variable * @param Expr $var Variable
* @param array<string, mixed> $attributes Additional attributes * @param array<string, mixed> $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = []) { public function __construct(Expr $var, array $attributes = []) {

Some files were not shown because too many files have changed in this diff Show More