Compare commits

..

259 Commits

Author SHA1 Message Date
47b254ea51 Release PHP-Parser 2.1.0 2016-04-19 15:41:41 +02:00
912c0bb9c9 Document that XDebug is super slow 2016-04-19 15:40:08 +02:00
9897fa8819 Update CHANGELOG 2016-04-19 15:32:57 +02:00
5a6e7dd452 Avoid superfluous newline when printing Nops 2016-04-19 15:10:51 +02:00
90eb1165d1 Switch Exit kind attribute to flag
To be consistent with everything else.
2016-04-19 14:51:05 +02:00
cf9b9e2afa Switch to 2.1-dev 2016-04-19 14:51:04 +02:00
e7869b9f14 Forbid invalid octals in PHP 7 mode 2016-04-18 13:59:18 +02:00
4c7ad7e194 Allow nop statements before namespace declaration 2016-04-16 21:39:49 +02:00
f8a40b3f24 Make autoloader more PSR-4 (#268) 2016-04-15 15:07:30 +02:00
82bb6627c9 Drop superfluous newlines before help text 2016-04-15 14:36:11 +02:00
d1dd9f5aec support -h and --help standard options 2016-04-15 14:34:28 +02:00
e7f0860d85 Tweaked a phpdoc description 2016-04-10 21:10:55 +09:00
954051f240 Run test_old using php -n
Xdebug is killing performance.
2016-04-10 21:09:02 +09:00
39f93f09f9 Add setReturnType() method to function/method builders
Also support scalar type hints in existing setTypeHint() method on params.
2016-04-09 18:41:38 +09:00
2d0c3b70f8 Fix .travis.yml 2016-04-07 07:39:20 +02:00
4252ffa43e Run test_old against php-src on travis 2016-04-07 06:39:29 +02:00
8cacc85913 "Fix" HHVM build 2016-04-07 12:27:08 +09:00
588e6a4d4c Add string kinds and doc string labels
Scalar\String_ and Scalar\Encapsed now have an additional "kind"
attribute, which may be one of:

 * String_::KIND_SINGLE_QUOTED
 * String_::KIND_DOUBLE_QUOTED
 * String_::KIND_NOWDOC
 * String_::KIND_HEREDOC

Additionally, if the string kind is one of the latter two, an
attribute "docLabel" is provided, which contains the doc string
label (STR in <<<STR) that was originally used.

The pretty printer will try to take the original kind of the string,
as well as the used doc string label into account.
2016-04-07 12:09:00 +09:00
fa6a17755a Add two files to test_old skip list
The parse after pretty printing differs here, because these tests
contain nop (;) statements, which the pretty printer does not
preserve.
2016-04-07 11:58:36 +09:00
52cb5ecec7 Fix comment reformatting for some cases
It did not correctly deal with non-standard comments containing
indented lines.
2016-04-07 11:47:40 +09:00
1565a2815d Add --verbose option to test_old/run.php 2016-04-05 19:19:20 +09:00
14de71898e Fix nop statement comment assignment
Keep around the start attributes on the lookahead token around in
a separate parser property.
2016-04-05 19:19:15 +09:00
5fa8493675 Make canonicalization less aggressive 2016-04-05 10:37:45 +09:00
b31a973fa7 Another fix for B"" handling
The lexer fix also need to account for uppercase B.
2016-04-04 22:07:50 +09:00
9ac3592190 Handle uppercase B"" prefix 2016-04-02 21:15:49 +09:00
35011d2e4d Deduplicate attribute assignment code a bit 2016-04-02 08:02:58 +09:00
60f01bdd86 Deprecate setters on Comment
No point in making it mutable
2016-04-02 07:55:28 +09:00
15a2388d75 Add start file offset to Comments 2016-04-02 07:54:01 +09:00
68b4c0388a Fix Serializer/XML test output indent
This causes a failure here, but not on another machine, not sure
why.
2016-04-02 07:27:01 +09:00
eb4bfe1366 Add sanity check for leaveNode() return value 2016-03-27 14:52:15 +02:00
e7ca4b7b04 Better Travis configuration
* Enable Travis cache for Composer
* Use `--prefer-dist` over `--prefer-source` to download less and
  make it faster
2016-03-15 17:39:37 +01:00
fc36239be5 Remove internal LNumber::parse() method
Combine it into ::fromString(), as they both do the same checks.
2016-03-10 13:01:42 +01:00
f493219c7d Move "kind" attribute handling out of lexer
Doesn't belong there and will cause issue with multiple assignments.
2016-03-10 12:55:15 +01:00
aa199120c7 Add kind attribute for arrays
To distinguish array() and [] syntax. The pretty printer respects
this attribute. The shortArraySyntax pretty printer option acts as
a default in case the attribute is not specified.
2016-03-09 21:31:54 +01:00
ae30f97af6 Add "kind" attribute to LNumbers
Kind specifies whether the number was formatted as decimal, octal,
binary or hex. The pretty printer reproduces the number kind (but
not necessarily the exact formatting).
2016-03-09 21:10:55 +01:00
47c342a3e4 Add "kind" attribute to Stmt\Exit_
Attribute specifies whether this is a "die" or an "exit" and the
pretty printer behaves accordingly.
2016-03-09 20:20:36 +01:00
7eac2cfd8b Introduce Nop statement to collect dangling comments
A Nop statement will be inserted into statement lists if there are
any trailing comments in the list (which would otherwise not be
associated with any node).

The pretty printer output currently still contains a superfluous
newline.
2016-03-09 19:48:36 +01:00
a0c216bf4b Add dumpComments option to NodeDumper
Adding this as an option to avoid breaking people's tests.

Some of the test results show pretty clearly that we are incorrectly
assigning the same comment multiple times for nested nodes (mentioned
in #36).
2016-03-09 19:48:36 +01:00
06d9ba42de Merge pull request #252 from stevemiketa/update-mode
Set bin/php-parse file mode to 0755
2016-03-03 20:52:13 +01:00
573c7c20c4 Update file mode 2016-03-03 13:06:54 -05:00
d5cbf79f2f Mark 1.x as unsupported 2016-02-28 21:01:06 +01:00
ce5be709d5 Release PHP-Parser 2.0.1 2016-02-28 20:48:28 +01:00
9829bf69cd Fix issue #251 2016-02-28 20:28:32 +01:00
c8282e6e76 Add badges 2016-02-20 21:53:08 +01:00
a73aa7eec1 Pretty printer test coverage
Our output for yield / yield from is currently not very nice, but
also not easy to change.
2016-02-20 21:49:21 +01:00
1fe8f09caa Fix __halt_compiler() pretty printing edge case
We can't strip the <?php at the end of a __halt_compiler() segment
in file mode.

Fixed by being a bit more explicit in prettyPrintFile() about what
we want to do...
2016-02-20 18:24:32 +01:00
47509cf927 Next try... 2016-02-20 17:20:16 +01:00
5b96a11a1f Fix .travis.yml 2016-02-20 17:18:19 +01:00
7faa1dcab9 Try setting up coveralls 2016-02-20 17:16:46 +01:00
65af37f7b0 Doc comment tweaks 2016-02-20 17:06:09 +01:00
d6361136e1 Update semi-reserved keyword list
Magic constant names have been added after the PHP 7 release.

We do not support and likely will not support __halt_compiler here
due to lexer limitations.
2016-02-09 13:30:39 +01:00
e05ef23743 Merge pull request #244 from pra85/doc
Typo fixes in documentation
2016-01-28 17:03:02 +01:00
73a9d494fb typo fixes 2016-01-28 19:31:28 +05:30
94f10d3c50 Merge branch '1.x' 2016-01-15 22:05:36 +01:00
c4bbc8e236 Support hashbang before namespace declaration
Fixes issue #243.
2016-01-15 22:03:42 +01:00
6dffb72ce0 Merge branch '1.x' 2016-01-15 22:02:35 +01:00
eb73441032 Support hashbang before namespace declaration
Fixes issue #243.
2016-01-15 22:01:51 +01:00
9a6a147369 Merge pull request #241 from jesseschalken/patch-1
Remove some unecessary @property doc comments
2015-12-29 14:38:17 +01:00
5c2cc50455 Remove some more unecessary @property doc comments 2015-12-29 23:15:00 +11:00
58eb1ea7c3 Remove some unecessary @property doc comments 2015-12-29 23:13:55 +11:00
719ca71d4a Distinguish declare(); and declare(){}
It makes semantic difference and the latter form is actually
forbidden for strict_types.

This sets Declare->stmts to null for the body-less case.
2015-12-07 12:12:00 +01:00
c542e5d86a Release PHP-Parser 2.0.0 2015-12-04 16:28:43 +01:00
a9074c7444 Introduce Scalar\EncapsedStringPart 2015-12-03 22:55:07 +01:00
b2f26d30ee Update README regarding PHP 7 compat 2015-11-21 22:30:40 +01:00
75cd4ab7a5 Use error_clear_last() on PHP 7
Instead of the ugly undefined variable hack
2015-11-21 22:27:56 +01:00
33602889c1 Release version 2.0.0 beta 1 2015-10-21 20:30:17 +02:00
98d28d7aa0 Drop test failing on HHVM
Can readd if Travis ever updates the HHVM version again, I
remember this being fixed ages ago.
2015-10-03 12:17:41 +02:00
e4b837e0c4 Split up pretty printer test in stmt/expr
The list was getting unweildly.

Also improve error message when parsing fails in pretty printer
test and extend some tests.
2015-10-02 11:16:12 +02:00
2b9c5a62cb Multiple init test for for loop 2015-10-02 11:03:33 +02:00
99e89743bd More PrettyPrinter tests 2015-10-02 11:03:32 +02:00
39a039fa42 Add option for short array syntax in pretty printer 2015-09-21 15:12:59 +08:00
fcf23101dd Fix autoloader path in php-parse
Need to go up another directory...
2015-09-21 14:57:31 +08:00
c8898df3dd Add php-parse as composer bin
Renaming from php-parse.php to just php-parse to follow the usual
conventions.

Not tested.
2015-09-21 14:39:19 +08:00
b2961915a6 Fix XML serialization test
I have no idea why this suddenly turned up *now*
2015-09-21 14:29:24 +08:00
6f3fd7834a Specify phpunit dev dependency in composer.json
And use it for the travis build.
2015-09-20 21:17:42 +08:00
f78af2c9c8 Release PHP-Parser 1.4.1 2015-09-19 22:15:08 +08:00
eecaf1e93b Merge branch '1.x'
Conflicts:
	grammar/rebuildParsers.php
	lib/PhpParser/Parser.php
2015-09-19 22:07:29 +08:00
950ada4cba Fix issue #227
Use \z instead of $.
2015-09-19 22:05:23 +08:00
0d4239ef56 Only advertize install via composer
Now that it's so small, move installation docs into readme.
2015-09-16 22:16:29 +09:00
e3a9356178 Use composer PSR-4 autoloader 2015-09-16 22:02:00 +09:00
5118e21c6e Add nightly to travis, use container based infra
Currently 7.0 and nightly are the same, but for the future...
2015-09-14 22:27:01 +09:00
40455b5c18 TravisCI - stop allowing to failture PHP7 2015-09-14 22:26:25 +09:00
fe6755ff4c Use more helpful code test names 2015-08-25 21:36:08 +02:00
f57d217e91 Update group use support
To conform with current PHP 7 implementation

* Allow use \Foo\{Bar};
* Disallow use Foo\{\Bar};
* Disallow missing trailing semicolon (that was a bug)
2015-08-20 16:42:49 +02:00
e0a75ededa Release PHP-Parser 2.0 Alpha 1 2015-07-14 21:13:42 +02:00
2496cd38ad Various docs fixes 2015-07-14 21:11:54 +02:00
965e53a164 Update changelog 2015-07-14 20:13:26 +02:00
dc85742034 Merge branch '1.x'
Conflicts:
	CHANGELOG.md
	composer.json
	test/PhpParser/ParserTest.php
2015-07-14 19:43:49 +02:00
196f177cfe Prepare PHP-Parser 1.4.0 release 2015-07-14 19:31:05 +02:00
b9afcdfd92 Revert "Make tests compatible with PHP 7"
This reverts commit 91295a0790.

This should no longer be necessary.

Conflicts:
	test/PhpParser/ParserTest.php
2015-07-14 19:21:57 +02:00
3bb874fcec Partial docs update 2015-07-14 19:19:32 +02:00
feb82eed33 Disable cloning in traverser by default 2015-07-14 17:39:56 +02:00
0ef15c111a Merge branch '1.x' 2015-07-14 17:08:28 +02:00
d341d94976 Add ClassLike::getMethod($name)
To allow getting individual method with a given name.
2015-07-14 17:07:45 +02:00
0265c28e6e Switch NameResolver resolve methods to be immutable
To make it theoretically possible to expose this as API.

Add slice() method to Name to allow this. Deprecate existing mutable
Name APIs.
2015-07-12 23:56:57 +02:00
5bd8cb84de Add dummy ParserFactory test
:/
2015-07-12 22:53:17 +02:00
ebeeae19a6 Merge branch '1.x' 2015-07-12 22:12:28 +02:00
5ede167835 Fix infinite recursion in Use builder __call 2015-07-12 22:11:43 +02:00
49324ea412 Drop default values from Scalar ctor params 2015-07-12 22:02:18 +02:00
21e51c8cf6 Add some tests for Multiple parser 2015-07-12 22:00:02 +02:00
e7a2abb03b Merge branch '1.x' 2015-07-11 22:33:19 +02:00
b862de1f5b Support properties in trait builder 2015-07-11 22:31:45 +02:00
8090531acd Fix pretty printing of const derefs for 5.x
(FOO)[0] is only supported on 7.x
2015-07-09 12:38:30 +02:00
49253c5dbb Fix test_old/run.php error message 2015-07-09 12:38:30 +02:00
c5ac17711d Merge branch '1.x' 2015-07-05 20:18:05 +02:00
1d62e9d8cc Fix implicit visibility for properties as well
Also switch to using PPP mask.
2015-07-05 20:17:52 +02:00
e3195c246f Fix public modifier check for ClassMethod node 2015-07-05 20:17:50 +02:00
2a3bc608dc Add broken test for implicit public nodes 2015-07-05 20:17:49 +02:00
90ab32f046 Merge branch '1.x' 2015-07-05 20:16:41 +02:00
7434a682e5 Fix implicit visibility for properties as well
Also switch to using PPP mask.
2015-07-05 20:16:21 +02:00
0fbb5f90a1 Fix public modifier check for ClassMethod node 2015-07-05 20:10:48 +02:00
5e6627c895 Add broken test for implicit public nodes 2015-07-05 20:10:47 +02:00
f872fa9b0b Merge branch '1.x' 2015-07-04 14:40:53 +02:00
d5668f536d Fix __HALT_COMPILER_OFFSET__ support on HHVM 2015-07-04 13:15:48 +02:00
a5db176903 Merge branch '1.x' 2015-07-02 18:09:38 +02:00
7fbbf83011 Added syntax highlighting in README 2015-07-02 18:09:12 +02:00
42e368e964 Fix returnType typehints
Fixes issues #207
2015-07-02 18:06:41 +02:00
9c9a8cddce Merge branch '1.x' 2015-06-20 12:34:36 +02:00
fd7ee2e083 Add missing regex anchor 2015-06-20 12:34:10 +02:00
179d32cfaf Simplify handleHaltCompiler() implementation
Nowadays we're already tracking the filePos, no need to
recompute it.
2015-06-20 12:33:33 +02:00
f2b7a31509 Rename ParserInterface to Parser
And drop the alias of Parser to Parser\Php5.
2015-06-20 11:47:25 +02:00
d8312a09a3 Split parsing tests into code tests and other stuff
And run the other stuff against Php5 and Php7 parsers.

Also move canonicalize() from CodeTestAbstract into a free-standing
function.
2015-06-20 11:44:29 +02:00
813c9f1545 Add basic ParserFactory 2015-06-20 11:28:58 +02:00
ef9a154d09 Add support for unicode escape sequences
Only parsed if the PHP 7 parser is used.
2015-06-13 20:51:02 +02:00
0da72fad00 Support scalar type declarations 2015-06-13 20:16:09 +02:00
71fa7c6674 Support UVS in pretty printer
Try to generate interoperable code where possible (but not
everything can be expressed in PHP 5).
2015-06-13 20:01:01 +02:00
f3f24e03ae Support running against PHP 7 testsuite 2015-06-13 19:09:24 +02:00
bc21514ecf Move token constants into separate class
As these are shared between Php5 and Php7 parsers they should be
in some common place, otherwise we'd have to always reference either
one or the other.
2015-06-13 18:39:55 +02:00
04e05907c3 Fix CRLF issue in Serializer\XML test
No idea why this suddenly turned up now.
2015-06-13 18:20:05 +02:00
61e060694d Implement generalized yield operator
And split tokens.y off, so I don't waste time debugging this again...
2015-06-13 18:11:40 +02:00
602b9807eb Import some UVS tests 2015-06-13 15:42:09 +02:00
f372a4c4ab Move modeline handling into CodeTestAbstract 2015-06-13 15:10:46 +02:00
d18dcc0c7f Implement UVS 2015-06-13 14:59:24 +02:00
74c57eef0e Test PHP 5 and PHP 7 parsers
At this point they should return the same result.
2015-06-13 13:56:45 +02:00
fdbddc4b8c Add Multiple parser 2015-06-13 13:38:24 +02:00
ca3b44bf60 Fork separate PHP 7 parser
Also add ParserInterface
2015-06-13 13:09:34 +02:00
dca46febc9 Implement semi-reserved identifiers 2015-06-13 12:47:13 +02:00
1a1bd1448d Support mixed group use declarations 2015-06-13 11:27:38 +02:00
9620f79cdc Add partial group use support
Supported via Stmt\GroupUse which has Name $prefix in addition to
the usual.

Still missing: Mixed group uses.
2015-06-12 23:05:28 +02:00
583b560f71 Drop {@inheritDoc}
Those are unnecessary and actually against the spec.
2015-06-12 20:37:43 +02:00
db3dafd64d Merge branch '1.x' 2015-06-05 18:57:04 +02:00
bb2c5303ae Add a FunctionLike interface to Methods, Functions and Closures.
The elements listed above share common elements like parameters, possible return types and bodies.
2015-06-05 18:56:25 +02:00
5038dcc251 Merge branch '1.x' 2015-05-03 19:12:09 +02:00
69c00ebbe4 Make help output help2man-friendly
These changes follow regular advices for CLI output and allow help2man
to produce a meaningful manpage out of it.
2015-05-03 19:11:04 +02:00
a0e7d5e0aa Set correct number of s/r conflicts 2015-05-02 22:51:38 +02:00
51ec2a25fe Move parser to Parser\Php5
Old name still exists.
2015-05-02 22:50:11 +02:00
5d1e3be7d4 Anonymize some callbacks 2015-05-02 22:35:15 +02:00
9d42e4a2e2 Drop short array simulation from .phpy syntax
Instead use real short array syntax.
2015-05-02 22:30:44 +02:00
cc75dd3612 Drop support for PHP 7 aliases 2015-05-02 22:21:12 +02:00
5f621c5adc Drop support for legacy aliases from v0.9 2015-05-02 22:19:25 +02:00
29b9015f51 Drop support for old Node format 2015-05-02 22:17:34 +02:00
e6619f5514 Drop 5.4 support from emulative lexer 2015-05-02 22:13:55 +02:00
6b4a17b3e0 Set version to 2.0-dev. Drop PHP 5.3 support 2015-05-02 22:08:03 +02:00
30abe062f2 Update documentation link 2015-05-02 22:03:33 +02:00
dff239267f Release PHP-Parser 1.3.0 2015-05-02 17:40:40 +02:00
8b64195cf2 Try .17G print if .16G is not enough
This should be enough for all cases, because: A double has 53 bits
of mantissa (including the implicit 1 bit), which is 53*ln(2)/ln(10)
= 15.95 decimal digits. However the leading decimal digit may encode
less than the usual 3.32 bits, which will push this over the edge to
requiring 17 decimal digits.
2015-05-02 11:48:55 +02:00
9caa51b3a5 Add some more tests 2015-05-01 20:18:04 +02:00
5513073a53 Drop Lexer::getPosition()
This was a leftover from the original column info implementation.
2015-05-01 20:18:01 +02:00
659d26c231 Update changelog, fix typos 2015-05-01 19:57:10 +02:00
648800f07f Increase float pretty printing precision
This removes the reliance on the "precision" ini setting.
Furthermore the default of precision=14 is not sufficient.
2015-05-01 19:15:33 +02:00
23bf4f0c13 Add some error documentation 2015-04-30 21:58:45 +02:00
57ac7e39bf Drop name magic from rebuildParser.php
Now using explicitly imported names, instead of magically
prepending Name\.

Also remove trailing whitespace from generated file.
2015-04-30 19:20:38 +02:00
272ab6c8d8 Add some recovery tests 2015-04-30 19:02:51 +02:00
0731b47655 Don't distinguish test-fail / test
With error recovery this is fluid. Using .test for everything.
2015-04-30 17:45:36 +02:00
3b7d8e8b5d Enable basic error recovery
Adding only a single recovery rule for now.

The API is now:
 * throwOnError parser option must be disabled.
 * List of Errors is available through $parser->getErrors(). This
   method is available either way.
 * If no recovery is possible $parser->parse() will return null.
   (Obviously only if throwOnError is disabled).
2015-04-30 17:41:57 +02:00
a35c2a2067 Add column info to EOF errors
EOF errors are now located one past the end of the file.
2015-04-27 15:37:41 +02:00
55b2ead967 Make special class name checks case insensitive 2015-04-26 23:13:27 +02:00
e1a0ec3724 Add support for anonymous classes
Has not landed upstream yet, but syntax is unlikely to change.
2015-04-26 23:04:31 +02:00
66896dbde6 Poison attribute initializations in parser
Those should error if they end up being used.
2015-04-26 22:32:18 +02:00
338bc1f8e7 Fix "print" pretty-printing
Precedence was previously ignored.
2015-04-26 11:56:04 +02:00
ab80054e97 Add support for "yield from" 2015-04-26 11:56:02 +02:00
a6d2cd69f8 Clarify attribute assignment code
* Don't assign to attribute stack on reduce - why was that there
in the first place?
* Assign attributes to the position in the stack where the first
token of the production is, instead of one position earlier.
* Add a comment to clarify why we also assign attributes on read,
instead of just on shift.
2015-04-26 11:56:01 +02:00
6996db1e3a Build node attributes inside semantic action methods
Minor performance improvement for parsing, also allows to access
attributes with higher granulity in the parser, though this is not
currently done.

* #n can now be used to access the stack position of a token. $n
  is the same as $this->semStack[#n]. (Post-translate $n will
  actually be the stack position.)
* $attributeStack is now $this->startAttributeStack and
  $endAttributes is now $this->endAttributes.
* Attributes for a node are now computed inside the individual
  reduction methods, instead of being passed as a parameter.
  Accessible through the attributes() macro.
2015-04-26 11:55:59 +02:00
e30c3ac01b Merge pull request #195 from GrahamCampbell/patch-1
Bump version to 1.3
2015-04-19 20:52:51 +02:00
a5477a4eaf Version bump 2015-04-19 17:57:38 +01:00
7a40498cb4 Regenerate parser
Also drop the error() parser macro.
2015-04-19 18:12:56 +02:00
65f1adbe65 Merge primary error recovery code
The grammar does not yet actually implement error recovery.
2015-04-19 18:11:05 +02:00
c8454271e1 Make column info 1-based 2015-04-18 21:20:45 +02:00
62f83a0dc2 Add column info for non-syntax errors where relatively precise
Should it also be added if only rough information is available? E.g.
spanning an entire class?
2015-04-18 13:27:58 +02:00
611fa5c7f1 Test parser position information (syntax errors) 2015-04-18 13:27:57 +02:00
4defbc2174 Make Error column info attribute based 2015-04-18 12:51:26 +02:00
33a39fae06 added column-numbers to syntax errors 2015-04-18 10:14:49 +02:00
e4eab9ec0c Simplify code
The new class couldn't already exist at that point - if it did, the
old name would have been aliased already and the autoloader wouldn't
trigger.
2015-04-03 22:30:30 +02:00
6aaa87f143 Fix PHP 7 alias registration
This fixes the case where the old name is used before the new one
is ever used, e.g. when manually constructing nodes, as opposed to
parsing them.

The previous approach would try to register the alias from OLD to
NEW. This would trigger autoloading on NEW and afterwards it would
register the alias from OLD to NEW. Afterwards the alias registration
which originally triggered the autoload would run, thus redeclaring
the class.

TL;DR aliases suck, closes #192.
2015-04-03 22:22:39 +02:00
08f97eb4ef Release PHP-Parser 1.2.2 2015-04-03 16:33:59 +02:00
8d18848fb0 Don't set unserialize_callback_func in Autoloader::register() as it has side effects even when the library is not used 2015-04-03 16:25:33 +02:00
805078e0a9 Add missing type hints 2015-03-28 18:14:24 +01:00
52dafafd10 Resolve param type hints earlier
For convenience of concurrent visitors that want to perform
enterNode actions based on Stmt\Function_ etc.

Fixes #188.
2015-03-25 20:57:39 +01:00
dba7524b37 Release PHP-Parser 1.2.1 2015-03-24 20:10:28 +01:00
617bf0aa41 Fix registering of PHP 7 aliases
The previous approach was causing issues, because "instanceof"
does not invoke the autoloader.
2015-03-24 20:04:50 +01:00
dce19b074b Strict type compliance
Were this library to be fully annotated with scalar types and
return types where possible and were strict types to be enabled
for all files, the test suite would now pass.
2015-03-24 11:19:17 +01:00
edbf162e4c Release PHP-Parser 1.2.0 2015-03-22 17:17:25 +01:00
b23c53df5f Update CHANGELOG 2015-03-22 16:03:59 +01:00
cea0c4a9d6 Don't register aliases on PHP 7 2015-03-22 16:03:57 +01:00
879e8dcd6d Merge pull request #186 from mnapoli/clone-nodes
Added a flag to NodeTraverser to avoid cloning nodes
2015-03-22 15:19:10 +01:00
729c7bde0c #184 Add a flag to NodeTraverser to avoid cloning nodes 2015-03-22 11:19:04 +13:00
8982315b4e Rename Cast\Object as well
As it will very likely be soft-reserved in PHP 7.

Old alias is still available, as usual.
2015-03-21 18:57:55 +01:00
0f556c16f5 Fix a few more Scalar\String_ occurances
Totally forgot that the parser uses macros...
2015-03-21 18:54:52 +01:00
7ec277e1e1 Replace another Scalar\String occurance
Also canonicalize NameResover tests to avoid those pesky CRLF
issues.
2015-03-21 18:47:20 +01:00
1a627872f0 Rename nodes for compat with PHP 7
The old names will still be available on PHP 5.x.
2015-03-20 21:49:38 +01:00
592836c4dc Add support for T_HASHBANG (HHVM) 2015-03-14 19:53:08 +01:00
68defc2c6a Merge pull request #183 from alprs/fix-autoloader
Ensure compatibility with multiple composer autoloaders
2015-03-14 09:07:35 +01:00
d225555830 Ensure compatibility with multiple autoloaders
Running a .phar or regular PHP executable that requires and includes its own
version of php-parser will cause a "cannot redeclare class" error if said
executable also includes the autoloader of the current working directory.
2015-03-13 23:54:32 +01:00
251e689283 Add support for spaceship operator (<=>) [PHP 7]
Added as Expr\BinaryOp\Spaceship.
2015-03-12 23:13:31 +01:00
01f4be6b4d Add support for null coalesce operator (??) [PHP 7]
Added as Expr\BinaryOp\Coalesce.
2015-03-12 22:45:56 +01:00
dc28449d81 Drop whitespace after ... varargs collection
Also drop an obsolete pretty printer test.
2015-03-12 22:19:34 +01:00
3ad0d4b310 Add support for return type declarations [PHP 7]
This adds an additional "returnType" subnode to Stmt\Function_,
Stmt\ClassMethod and Expr\Closure, as well as the corresponding
support in the name resolver and pretty printer.
2015-03-12 22:16:12 +01:00
4dbf067b4b Add a few more string interpolation tests
Originally wanted to simplify the pretty-printer output, but ...
edge cases everywhere :/
2015-03-11 20:01:26 +01:00
5567f0ab3b Add documentation TOC to readme 2015-03-10 21:32:21 +01:00
0c34706799 Add "use" builder 2015-03-10 16:05:55 +01:00
f9fc2fc9ee Add support for global namespace in NS builder
NULL argument can now be used to create a global namespace {} block.
2015-03-10 15:28:19 +01:00
a2d7e8977a Use real properties for storing subnodes
Instead of storing subnodes in a subNodes dictionary, they are
now stored as simple properties. This requires declarating the
properties, assigning them in the constructor, overriding
the getSubNodeNames() method and passing NULL to the first argument
of the NodeAbstract constructor.

[Deprecated: It's still possible to use the old mode of operation
for custom nodes by passing an array of subnodes to the constructor.]

The only behavior difference this should cause is that getSubNodeNames()
will always return the original subnode names and skip any additional
properties that were dynamically added. E.g. this means that the
"namespacedName" node added by the NameResolver visitor is not treated
as a subnode, but as a dynamic property instead.

This change improves performance and memory usage.
2015-03-09 08:54:20 +01:00
73cace360d Implicit public should not generate as explicit public 2015-03-08 20:21:01 +01:00
c96636d192 Revert "Create .gitattributes with basic export-ignores"
This reverts commit 0dd2b9a74c.

Not having tests available causes issues for downstream
distributors. See issue #178.
2015-03-08 19:38:13 +01:00
d56ff5a351 Fix lexer tests for HHVM
HHVM does not throw warnings from token_get_all()
for invalid chars and unterminated comments. This
is not really integral functionality, so I'm okay
to just skip it to get a passing HHVM build.
2015-02-26 19:19:40 +01:00
3028bc8081 And make it work on PHP 5 as well... 2015-02-26 16:40:21 +01:00
91295a0790 Make tests compatible with PHP 7
When parsing on PHP 7 we will no longer be able to deal with
code that contains invalid octal literals. Currently we'll fatal,
after engine exceptions land we'll throw an exception instead.
2015-02-26 16:26:29 +01:00
d600c60779 Add PHP 7 to travis build 2015-02-26 15:25:34 +01:00
e3bc5b564d Added php shebang 2015-02-24 21:43:12 +01:00
53eac36a3f Merge pull request #175 from staabm/patch-1
prevent a unnecessary concat
2015-02-13 18:03:18 +01:00
ce5c76d79b prevent a unnecessary concat
analog to b7ffdbbb92
2015-02-13 16:02:54 +01:00
b7ffdbbb92 Optimize node dumper
For very deeply nested node trees this extra concatenation makes a
huge difference...
2015-02-13 15:20:25 +01:00
8f1eacdab7 Increase recommended xdebug.max_nesting_level
Looks like 2000 is not quite enough for some cases...
2015-02-13 15:04:00 +01:00
1366e833a1 Move getMethods() to new ClassLike node
Class_, Interface_ and Trait_ extend the ClassLike node, which
provides the getMethods() method.
2015-01-31 22:59:38 +01:00
6930feac43 Add some tests for pretty printing expressions 2015-01-18 19:57:09 +01:00
54275ad181 Merge pull request #167 from GrahamCampbell/patch-1
Fixed branch alias
2015-01-18 12:54:05 +01:00
21ca7eaf1b Fixed branch alias 2015-01-18 11:46:36 +00:00
a86779198f Fix branch alias (maybe?) 2015-01-18 12:41:16 +01:00
ac05ef6f95 Release PHP-Parser 1.1 2015-01-18 12:29:59 +01:00
74251fca9f Update changelog 2015-01-18 00:11:19 +01:00
0a445c7656 Test lexer returning invalid token 2015-01-18 00:11:10 +01:00
a710f32a6a Make Node\Expr\BinOp an abstract class
Only the children should be used ...
2015-01-18 00:10:02 +01:00
9689763e20 Cover both DONT_TRAVERSE_CHILDREN cases 2015-01-18 00:10:01 +01:00
1a63a915f2 Merge pull request #163 from rmruano/gitattributes
Create .gitattributes with basic export-ignores
2015-01-11 22:34:05 +01:00
4071c4645d Add NodeTraverser::DONT_TRAVERSE_CHILDREN support 2015-01-11 22:13:58 +01:00
f56db26d8b Doc fixes 2015-01-11 21:39:02 +01:00
0dd2b9a74c Create .gitattributes with basic export-ignores 2015-01-09 21:19:19 +01:00
4cd2b95a23 Fix 5.3 build and some small cleanups 2014-12-19 18:54:56 +01:00
7ab88416ac Enforce Name|string for names in builders
While array (with name components) could technically be allowed (as
they are supported by the Name node itself), more likely than not
an array would due to incorrect usage of the API (e.g. array instead
of variadics).
2014-12-19 18:50:16 +01:00
ba625063e7 Support fully-qualified and ns-relative names in builders 2014-12-19 18:48:21 +01:00
b4b93ccb21 Add integration test for builders 2014-12-19 18:35:19 +01:00
01643e06d3 Add namespace builder 2014-12-19 18:19:33 +01:00
4387454fe0 Add trait builder (for completeness...) 2014-12-19 17:59:23 +01:00
55fdbc6dbc Extract common builder methods to abstract classes
Declaration for fns/classes in general and FunctionLike for
functions/methods in particular.
2014-12-19 17:47:51 +01:00
e69c9ee38c Fix attribute assigment test with crlf newlines 2014-12-19 17:28:22 +01:00
894c3f787d Add test for attribute assignment by parser
Weird that this wasn't tested yet...
2014-12-19 00:37:38 +01:00
a7797918b8 Update lexer docs for attribute options 2014-12-19 00:37:37 +01:00
46975107a7 Support token position attributes in lexer
Also change endFilePos semantics to refer to the last character that
is *included* in the token, rather than one past the last character.
This ensures that all end* attributes have the same semantics.
2014-12-19 00:37:36 +01:00
e0f3e8a492 Merge pull request #160 from jamiehannaford/patch-1
Fix apostrophe
2014-12-15 14:23:36 +01:00
158322e1e4 Fix apostrophe 2014-12-15 10:05:52 +00:00
2438848487 Add support for doc comments in builders 2014-12-13 13:44:40 +01:00
f5432a76b6 Add a a reference to PrettyPrinter to code generation doc
The `$prettyPrinter` variable was undefined in the doc.

Also, the PrettyPrinter was mentioned as `default`, but it's `Standard`, actually.
2014-12-13 13:06:36 +01:00
800d278369 Merge pull request #152 from Fullmetal5/master
Add line returns in php-parse help message
2014-11-27 21:30:29 +01:00
8507af6f4a Add missing require in tests
Test files aren't autoloaded, so this was order-dependent.
2014-11-27 21:01:56 +01:00
7c98ad6f9b Support file offsets in emulative lexer as well
Also run normal lexer tests against emulative lexer and fix a bug
in __halt_compiler() handling found as a result.
2014-11-27 20:57:38 +01:00
d774dbc1b7 Add optional startFilePos and endFilePos attributes
The lexer can now optionally add startFilePos and endFilePos
attributes, which are offsets in to the lexed code string.

The end offset currently points one past the last character of
the token - this is pending further discussion.

The attributes are not added by default and have to be enabled
using the new 'usedAttributes' lexer option:

	$lexer = new Lexer([
		'usedAttributes' => [
			'comments', 'startLine', 'endLine',
			'startFilePos', 'endFilePos'
		]
	]);
2014-11-27 20:38:29 +01:00
1a93cc3b9d Add line returns
Add line returns to the help message so that the terminal won't end up on the same line.
2014-11-25 19:03:35 -06:00
e26e63e9b0 Error on final or abstract properties 2014-11-13 20:25:52 +01:00
0f69f12b94 Use "public" visibility when not explicitly given
Fixes issue #143
2014-11-13 20:21:21 +01:00
320 changed files with 17624 additions and 6254 deletions

4
.gitignore vendored Normal file
View File

@ -0,0 +1,4 @@
vendor/
composer.lock
grammar/kmyacc.exe
grammar/y.output

View File

@ -1,13 +1,32 @@
language: php language: php
sudo: false
cache:
directories:
- $HOME/.composer/cache
php: php:
- 5.3
- 5.4 - 5.4
- 5.5 - 5.5
- 5.6 - 5.6
- 7.0
- nightly
- hhvm - hhvm
install:
- if [ $TRAVIS_PHP_VERSION = '5.6' ]; then composer require satooshi/php-coveralls '~1.0'; fi
- composer install --prefer-dist
matrix: matrix:
allow_failures: allow_failures:
- php: hhvm - php: nightly
fast_finish: true fast_finish: true
script:
- if [ $TRAVIS_PHP_VERSION = '5.6' ]; then vendor/bin/phpunit --coverage-clover build/logs/clover.xml; else vendor/bin/phpunit; fi
- if [ $TRAVIS_PHP_VERSION = '7.0' ]; then test_old/run-php-src.sh; fi
after_success:
if [ $TRAVIS_PHP_VERSION = '5.6' ]; then php vendor/bin/coveralls; fi

View File

@ -1,115 +1,138 @@
Version 1.0.3-dev Version 2.1.1-dev
----------------- -----------------
Nothing yet. Nothing yet.
Version 1.0.2 (04.11.2014) Version 2.1.0 (2016-04-19)
-------------------------- --------------------------
* The `NameResolver` visitor now also resolves names in trait adaptations (aliases and precedence declarations). ### Fixed
* Remove stray whitespace when pretty-printing trait adaptations that only change visibility. * Properly support `B""` strings (with uppercase `B`) in a number of places.
* Fixed reformatting of indented parts in a certain non-standard comment style.
Version 1.0.1 (14.10.2014) ### Added
* Added `dumpComments` option to node dumper, to enable dumping of comments associated with nodes.
* Added `Stmt\Nop` node, that is used to collect comments located at the end of a block or at the
end of a file (without a following node with which they could otherwise be associated).
* Added `kind` attribute to `Expr\Exit` to distinguish between `exit` and `die`.
* Added `kind` attribute to `Scalar\LNumber` to distinguish between decimal, binary, octal and
hexadecimal numbers.
* Added `kind` attribtue to `Expr\Array` to distinguish between `array()` and `[]`.
* Added `kind` attribute to `Scalar\String` and `Scalar\Encapsed` to distinguish between
single-quoted, double-quoted, heredoc and nowdoc string.
* Added `docLabel` attribute to `Scalar\String` and `Scalar\Encapsed`, if it is a heredoc or
nowdoc string.
* Added start file offset information to `Comment` nodes.
* Added `setReturnType()` method to function and method builders.
* Added `-h` and `--help` options to `php-parse` script.
### Changed
* Invalid octal literals now throw a parse error in PHP 7 mode.
* The pretty printer takes all the new attributes mentioned in the previous section into account.
* The protected `AbstractPrettyPrinter::pComments()` method no longer returns a trailing newline.
* The bundled autoloader supports library files being stored in a different directory than
`PhpParser` for easier downstream distribution.
### Deprecated
* The `Comment::setLine()` and `Comment::setText()` methods have been deprecated. Construct new
objects instead.
### Removed
* The internal (but public) method `Scalar\LNumber::parse()` has been removed. A non-internal
`LNumber::fromString()` method has been added instead.
Version 2.0.1 (2016-02-28)
-------------------------- --------------------------
* Disallow `new` expressions without a class name. Previously `new;` was accidentally considered to be valid code. ### Fixed
* Support T_ONUMBER token used by HHVM. * `declare() {}` and `declare();` are not semantically equivalent and will now result in different
ASTs. The format case will have an empty `stmts` array, while the latter will set `stmts` to
`null`.
* Magic constants are now supported as semi-reserved keywords.
* A shebang line like `#!/usr/bin/env php` is now allowed at the start of a namespaced file.
Previously this generated an exception.
* The `prettyPrintFile()` method will not strip a trailing `?>` from the raw data that follows a
`__halt_compiler()` statement.
* The `prettyPrintFile()` method will not strip an opening `<?php` if the file starts with a
comment followed by InlineHTML.
* Add ability to directly pass code to the `php-parse.php` script. Version 2.0.0 (2015-12-04)
* Prevent truncation of `var_dump()` output in the `php-parse.php` script if XDebug is used.
Version 1.0.0 (12.09.2014)
-------------------------- --------------------------
* [BC] Removed deprecated `Template` and `TemplateLoader` classes. ### Changed
* Fixed XML unserializer to properly work with new namespaced node names. * String parts of encapsed strings are now represented using `Scalar\EncapsStringPart` nodes.
Previously raw strings were used. This affects the `parts` child of `Scalar\Encaps` and
`Expr\ShellExec`. The change has been done to allow assignment of attributes to encapsed string
parts.
Version 1.0.0-beta2 (31.08.2014) Version 2.0.0-beta1 (2015-10-21)
-------------------------------- --------------------------------
* [PHP 5.6] Updated support for constant scalar expressions to comply with latest changes. This means that arrays ### Fixed
and array dimension fetches are now supported as well.
* [PHP 5.6] Direct array dereferencing of constants is supported now, i.e. both `FOO[0]` and `Foo::BAR[0]` are valid * Fixed issue with too many newlines being stripped at the end of heredoc/nowdoc strings in some
now. cases. (#227)
* Fixed handling of special class names (`self`, `parent` and `static`) in the name resolver to be case insensitive. ### Changed
Additionally the name resolver now enforces that special class names are only used as unqualified names, e.g. `\self`
is considered invalid.
* The case of references to the `static` class name is now preserved. Previously `static` was always lowercased, * Update group use support to be in line with recent PHP 7.0 builds.
regardless of the case used in the source code. * Renamed `php-parse.php` to `php-parse` and registered it as a composer bin.
* Use composer PSR-4 autoloader instead of custom autoloader.
* Specify phpunit as a dev dependency.
* The autoloader now only requires a file if it exists. This allows usages like ### Added
`class_exists('PhpParser\NotExistingClass')`.
* Added experimental `bin/php-parse.php` script, which is intended to help exploring and debugging the node tree. * Added `shortArraySyntax` option to pretty printer, to print all arrays using short syntax.
* Separated the parser implemention (in `lib/PhpParser/ParserAbstract.php`) and the generated data (in Version 2.0.0-alpha1 (2015-07-14)
`lib/PhpParser/Parser.php`). Furthermore the parser now uses meaningful variable names and contains comments ---------------------------------
explaining their usage.
Version 1.0.0-beta1 (27.03.2014) A more detailed description of backwards incompatible changes can be found in the
-------------------------------- [upgrading guide](UPGRADE-2.0.md).
* [BC] PHP-Parser now requires PHP 5.3 or newer to run. It is however still possible to *parse* PHP 5.2 source code, ### Removed
while running on a newer version.
* [BC] The library has been moved to use namespaces with the `PhpParser` vendor prefix. However, the old names using * Removed support for running on PHP 5.4. It is however still possible to parse PHP 5.2 and PHP 5.3
underscores are still available as aliases, as such most code should continue running on the new version without code while running on a newer version.
further changes. * Removed legacy class name aliases. This includes the old non-namespaced class names and the old
names for classes that were renamed for PHP 7 compatibility.
* Removed support for legacy node format. All nodes must have a `getSubNodeNames()` method now.
However, code performing dispatch operations on `Node::getType()` may be affected by some of the name changes. For ### Added
example a `+` node will now return type `Expr_BinaryOp_Plus` instead of `Expr_Plus`. In particular this may affect
custom pretty printers.
Due to conflicts with reserved keywords, some class names now end with an underscore, e.g. `PHPParser_Node_Stmt_Class` * Added support for remaining PHP 7 features that were not present in 1.x:
is now `PhpParser\Node\Stmt\Class_`. (But as usual, the old name is still available) * Group use declarations. These are represented using `Stmt\GroupUse` nodes. Furthermore a `type`
attribute was added to `Stmt\UseUse` to handle mixed group use declarations.
* Uniform variable syntax.
* Generalized yield operator.
* Scalar type declarations. These are presented using `'bool'`, `'int'`, `'float'` and `'string'`
as the type. The PHP 5 parser also accepts these, however they'll be `Name` instances there.
* Unicode escape sequences.
* Added `PhpParser\ParserFactory` class, which should be used to create parser instances.
* Added `Name::concat()` which concatenates two names.
* Added `Name->slice()` which takes a subslice of a name.
* [PHP 5.6] Added support for the power operator `**` (node `Expr\BinaryOp\Pow`) and the compound power assignment ### Changed
operator `**=` (node `Expr\AssignOp\Pow`).
* [PHP 5.6] Added support for variadic functions: `Param` nodes now have `variadic` as a boolean subnode. * `PhpParser\Parser` is now an interface, implemented by `Parser\Php5`, `Parser\Php7` and
`Parser\Multiple`. The `Multiple` parser will try multiple parsers, until one succeeds.
* [PHP 5.6] Added support for argument unpacking: `Arg` nodes now have `unpack` as a boolean subnode. * Token constants are now defined on `PhpParser\Parser\Tokens` rather than `PhpParser\Parser`.
* The `Name->set()`, `Name->append()`, `Name->prepend()` and `Name->setFirst()` methods are
* [PHP 5.6] Added support for aliasing of functions and constants. `Stmt\Use_` nodes now have an integral `type` deprecated in favor of `Name::concat()` and `Name->slice()`.
subnode, which is one of `Stmt\Use_::TYPE_NORMAL` (`use`), `Stmt\Use_::TYPE_FUNCTION` (`use function`) or * The `NodeTraverser` no longer clones nodes by default. The old behavior can be restored by
`Stmt\Use_::TYPE_CONSTANT` (`use const`). passing `true` to the constructor.
* The constructor for `Scalar` nodes no longer has a default value. E.g. `new LNumber()` should now
The `NameResolver` now also supports resolution of such aliases. be written as `new LNumber(0)`.
* [PHP 5.6] Added support for constant scalar expressions. This means that certain expressions are now allowed as the
initializer for constants, properties, parameters, static variables, etc.
* [BC] Improved pretty printing of empty statements lists, which are now printed as `{\n}` instead of `{\n \n}`.
This changes the behavior of the protected `PrettyPrinterAbstract::pStmts()` method, so custom pretty printing code
making use it of may need to be adjusted.
* Changed the order of some subnodes to be consistent with their order in the sour code. For example `Stmt\If->cond`
will now appear before `Stmt\If->stmts` etc.
* Added `Scalar\MagicConstant->getName()`, which returns the name of the magic constant (e.g. `__CLASS__`).
**The following changes are also included in 0.9.5**:
* [BC] Deprecated `PHPParser_Template` and `PHPParser_TemplateLoader`. This functionality does not belong in the main project
and - as far as I know - nobody is using it.
* Add `NodeTraverser::removeVisitor()` method, which removes a visitor from the node traverser. This also modifies the
corresponding `NodeTraverserInterface`.
* Fix alias resolution in `NameResolver`: Class names are now correctly handled as case-insensitive.
* The undefined variable error, which is used to the lexer to reset the error state, will no longer interfere with
custom error handlers.
--- ---
**This changelog only includes changes from the 1.0 series. For older changes see the [0.9 series changelog][1].** **This changelog only includes changes from the 2.0 series. For older changes see the
[1.x series changelog](https://github.com/nikic/PHP-Parser/blob/1.x/CHANGELOG.md) and the
[1]: https://github.com/nikic/PHP-Parser/blob/0.9/CHANGELOG.md [0.9 series changelog](https://github.com/nikic/PHP-Parser/blob/0.9/CHANGELOG.md).**

View File

@ -1,12 +1,14 @@
PHP Parser PHP Parser
========== ==========
This is a PHP 5.2 to PHP 5.6 parser written in PHP. It's purpose is to simplify static code analysis and [![Build Status](https://travis-ci.org/nikic/PHP-Parser.svg?branch=master)](https://travis-ci.org/nikic/PHP-Parser) [![Coverage Status](https://coveralls.io/repos/github/nikic/PHP-Parser/badge.svg?branch=master)](https://coveralls.io/github/nikic/PHP-Parser?branch=master)
This is a PHP 5.2 to PHP 7.0 parser written in PHP. Its purpose is to simplify static code analysis and
manipulation. manipulation.
[**Documentation for version 1.0.x**][doc_master] (stable; for running on PHP >= 5.3). [**Documentation for version 2.x**][doc_master] (stable; for running on PHP >= 5.4; for parsing PHP 5.2 to PHP 7.0).
[Documentation for version 0.9.x][doc_0_9] (unsupported; for running on PHP 5.2). [Documentation for version 1.x][doc_1_x] (unsupported; for running on PHP >= 5.3; for parsing PHP 5.2 to PHP 5.6).
In a Nutshell In a Nutshell
------------- -------------
@ -22,7 +24,7 @@ hello\world('foo', 'bar' . 'baz');
You'll get a syntax tree looking roughly like this: You'll get a syntax tree looking roughly like this:
``` ```php
array( array(
0: Stmt_Echo( 0: Stmt_Echo(
exprs: array( exprs: array(
@ -70,7 +72,25 @@ programming errors or security issues).
Additionally, you can convert a syntax tree back to PHP code. This allows you to do code preprocessing Additionally, you can convert a syntax tree back to PHP code. This allows you to do code preprocessing
(like automatedly porting code to older PHP versions). (like automatedly porting code to older PHP versions).
So, that's it, in a nutshell. You can find everything else in the [docs][doc_master]. Installation
------------
[doc_0_9]: https://github.com/nikic/PHP-Parser/tree/0.9/doc The preferred installation method is [composer](https://getcomposer.org):
php composer.phar require nikic/php-parser
Documentation
-------------
1. [Introduction](doc/0_Introduction.markdown)
2. [Usage of basic components](doc/2_Usage_of_basic_components.markdown)
3. [Other node tree representations](doc/3_Other_node_tree_representations.markdown)
4. [Code generation](doc/4_Code_generation.markdown)
Component documentation:
1. [Error](doc/component/Error.markdown)
2. [Lexer](doc/component/Lexer.markdown)
[doc_1_x]: https://github.com/nikic/PHP-Parser/tree/1.x/doc
[doc_master]: https://github.com/nikic/PHP-Parser/tree/master/doc [doc_master]: https://github.com/nikic/PHP-Parser/tree/master/doc

74
UPGRADE-2.0.md Normal file
View File

@ -0,0 +1,74 @@
Upgrading from PHP-Parser 1.x to 2.0
====================================
### PHP version requirements
PHP-Parser now requires PHP 5.4 or newer to run. It is however still possible to *parse* PHP 5.2 and
PHP 5.3 source code, while running on a newer version.
### Creating a parser instance
Parser instances should now be created through the `ParserFactory`. Old direct instantiation code
will not work, because the parser class was renamed.
Old:
```php
use PhpParser\Parser, PhpParser\Lexer;
$parser = new Parser(new Lexer\Emulative);
```
New:
```php
use PhpParser\ParserFactory;
$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
```
The first argument to `ParserFactory` determines how different PHP versions are handled. The
possible values are:
* `ParserFactory::PREFER_PHP7`: Try to parse code as PHP 7. If this fails, try to parse it as PHP 5.
* `ParserFactory::PREFER_PHP5`: Try to parse code as PHP 5. If this fails, try to parse it as PHP 7.
* `ParserFactory::ONLY_PHP7`: Parse code as PHP 7.
* `ParserFactory::ONLY_PHP5`: Parse code as PHP 5.
For most practical purposes the difference between `PREFER_PHP7` and `PREFER_PHP5` is mainly whether
a scalar type hint like `string` will be stored as `'string'` (PHP 7) or as `new Name('string')`
(PHP 5).
To use a custom lexer, pass it as the second argument to the `create()` method:
```php
use PhpParser\ParserFactory;
$lexer = new MyLexer;
$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7, $lexer);
```
### Rename of the `PhpParser\Parser` class
`PhpParser\Parser` is now an interface, which is implemented by `Parser\Php5`, `Parser\Php7` and
`Parser\Multiple`. Parser tokens are now defined in `Parser\Tokens`. If you use the `ParserFactory`
described above to create your parser instance, these changes should have no further impact on you.
### Removal of legacy aliases
All legacy aliases for classes have been removed. This includes the old non-namespaced `PHPParser_`
classes, as well as the classes that had to be renamed for PHP 7 support.
### Deprecations
The `set()`, `setFirst()`, `append()` and `prepend()` methods of the `Node\Name` class have been
deprecated. Instead `Name::concat()` and `Name->slice()` should be used.
### Miscellaneous
* The `NodeTraverser` no longer clones nodes by default. If you want to restore the old behavior,
pass `true` to the constructor.
* The legacy node format has been removed. If you use custom nodes, they are now expected to
implement a `getSubNodeNames()` method.
* The default value for `Scalar` node constructors was removed. This means that something like
`new LNumber()` should be replaced by `new LNumber(0)`.
* String parts of encapsed strings are now represented using `Scalar\EncapsStringPart` nodes, while
previously raw strings were used. This affects the `parts` child of `Scalar\Encaps` and
`Expr\ShellExec`.

79
bin/php-parse.php → bin/php-parse Normal file → Executable file
View File

@ -1,15 +1,21 @@
#!/usr/bin/env php
<?php <?php
require __DIR__ . '/../lib/bootstrap.php'; foreach ([__DIR__ . '/../../../autoload.php', __DIR__ . '/../vendor/autoload.php'] as $file) {
if (file_exists($file)) {
require $file;
break;
}
}
ini_set('xdebug.max_nesting_level', 2000); ini_set('xdebug.max_nesting_level', 3000);
// Disable XDebug var_dump() output truncation // Disable XDebug var_dump() output truncation
ini_set('xdebug.var_display_max_children', -1); ini_set('xdebug.var_display_max_children', -1);
ini_set('xdebug.var_display_max_data', -1); ini_set('xdebug.var_display_max_data', -1);
ini_set('xdebug.var_display_max_depth', -1); ini_set('xdebug.var_display_max_depth', -1);
list($operations, $files) = parseArgs($argv); list($operations, $files, $attributes) = parseArgs($argv);
/* Dump nodes by default */ /* Dump nodes by default */
if (empty($operations)) { if (empty($operations)) {
@ -20,8 +26,11 @@ if (empty($files)) {
showHelp("Must specify at least one file."); showHelp("Must specify at least one file.");
} }
$parser = new PhpParser\Parser(new PhpParser\Lexer\Emulative); $lexer = new PhpParser\Lexer\Emulative(array('usedAttributes' => array(
$dumper = new PhpParser\NodeDumper; 'startLine', 'endLine', 'startFilePos', 'endFilePos', 'comments'
)));
$parser = (new PhpParser\ParserFactory)->create(PhpParser\ParserFactory::PREFER_PHP7, $lexer);
$dumper = new PhpParser\NodeDumper(['dumpComments' => true]);
$prettyPrinter = new PhpParser\PrettyPrinter\Standard; $prettyPrinter = new PhpParser\PrettyPrinter\Standard;
$serializer = new PhpParser\Serializer\XML; $serializer = new PhpParser\Serializer\XML;
@ -44,7 +53,17 @@ foreach ($files as $file) {
try { try {
$stmts = $parser->parse($code); $stmts = $parser->parse($code);
} catch (PhpParser\Error $e) { } catch (PhpParser\Error $e) {
die("==> Parse Error: {$e->getMessage()}\n"); if ($attributes['with-column-info'] && $e->hasColumnInfo()) {
$startLine = $e->getStartLine();
$endLine = $e->getEndLine();
$startColumn = $e->getStartColumn($code);
$endColumn = $e->getEndColumn($code);
$message .= $e->getRawMessage() . " from $startLine:$startColumn to $endLine:$endColumn";
} else {
$message = $e->getMessage();
}
die($message . "\n");
} }
foreach ($operations as $operation) { foreach ($operations as $operation) {
@ -67,30 +86,31 @@ foreach ($files as $file) {
} }
} }
function showHelp($error) { function showHelp($error = '') {
die($error . "\n\n" . if ($error) {
<<<OUTPUT echo $error . "\n\n";
Usage: }
die(<<<OUTPUT
php php-parse.php [operations] file1.php [file2.php ...] Usage: php-parse [operations] file1.php [file2.php ...]
or: php-parse [operations] "<?php code"
The file arguments can also be replaced with a code string: Turn PHP source code into an abstract syntax tree.
php php-parse.php [operations] "<?php code"
Operations is a list of the following options (--dump by default): Operations is a list of the following options (--dump by default):
--dump -d Dump nodes using NodeDumper -d, --dump Dump nodes using NodeDumper
--pretty-print -p Pretty print file using PrettyPrinter\Standard -p, --pretty-print Pretty print file using PrettyPrinter\Standard
--serialize-xml Serialize nodes using Serializer\XML --serialize-xml Serialize nodes using Serializer\XML
--var-dump var_dump() nodes (for exact structure) --var-dump var_dump() nodes (for exact structure)
--resolve-names -N Resolve names using NodeVisitor\NameResolver -N, --resolve-names Resolve names using NodeVisitor\NameResolver
-c, --with-column-info Show column-numbers for errors (if available)
-h, --help Display this page
Example: Example:
php-parse -d -p -N -d file.php
php php-parse.php -d -p -N -d file.php
Dumps nodes, pretty prints them, then resolves names and dumps them again. Dumps nodes, pretty prints them, then resolves names and dumps them again.
OUTPUT OUTPUT
); );
} }
@ -98,6 +118,9 @@ OUTPUT
function parseArgs($args) { function parseArgs($args) {
$operations = array(); $operations = array();
$files = array(); $files = array();
$attributes = array(
'with-column-info' => false,
);
array_shift($args); array_shift($args);
$parseOptions = true; $parseOptions = true;
@ -126,6 +149,14 @@ function parseArgs($args) {
case '-N'; case '-N';
$operations[] = 'resolve-names'; $operations[] = 'resolve-names';
break; break;
case '--with-column-info':
case '-c';
$attributes['with-column-info'] = true;
break;
case '--help':
case '-h';
showHelp();
break;
case '--': case '--':
$parseOptions = false; $parseOptions = false;
break; break;
@ -138,5 +169,5 @@ function parseArgs($args) {
} }
} }
return array($operations, $files); return array($operations, $files, $attributes);
} }

View File

@ -10,15 +10,21 @@
} }
], ],
"require": { "require": {
"php": ">=5.3", "php": ">=5.4",
"ext-tokenizer": "*" "ext-tokenizer": "*"
}, },
"autoload": { "require-dev": {
"files": ["lib/bootstrap.php"] "phpunit/phpunit": "~4.0"
}, },
"autoload": {
"psr-4": {
"PhpParser\\": "lib/PhpParser"
}
},
"bin": ["bin/php-parse"],
"extra": { "extra": {
"branch-alias": { "branch-alias": {
"dev-master": "1.0-dev" "dev-master": "2.1-dev"
} }
} }
} }

View File

@ -1,7 +1,7 @@
Introduction Introduction
============ ============
This project is a PHP 5.2 to PHP 5.6 parser **written in PHP itself**. This project is a PHP 5.2 to PHP 7.0 parser **written in PHP itself**.
What is this for? What is this for?
----------------- -----------------
@ -18,7 +18,7 @@ For example an AST abstracts away the fact that in PHP variables can be written
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 questions 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 probably 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.
@ -26,13 +26,12 @@ programmatic PHP code analysis are incidentally PHP developers, not C developers
What can it parse? What can it parse?
------------------ ------------------
The parser uses a PHP 5.6 compliant grammar, which is backwards compatible with all PHP version from PHP 5.2 The parser supports parsing PHP 5.2-5.6 and PHP 7.
upwards (and maybe older).
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 new tokens from 5.3, 5.4, 5.5 and 5.6 is provided. version it runs on), additionally a wrapper for emulating new tokens from 5.5, 5.6 and 7.0 is
This allows to parse PHP 5.6 source code running on PHP 5.3, for example. This emulation is very hacky and not provided. This allows to parse PHP 7.0 source code running on PHP 5.4, for example. This emulation
perfect, but it should work well on any sane code. is somewhat hacky and not perfect, but it should work well on any sane code.
What output does it produce? What output does it produce?
---------------------------- ----------------------------

View File

@ -1,39 +0,0 @@
Installation
============
There are multiple ways to include the PHP parser into your project:
Installing via Composer
-----------------------
Create a `composer.json` file in your project root and use it to define your dependencies:
{
"require": {
"nikic/php-parser": "~1.0.2"
}
}
Then install Composer in your project (or [download the composer.phar][1] directly):
curl -s http://getcomposer.org/installer | php
And finally ask Composer to install the dependencies:
php composer.phar install
Installing as a Git Submodule
-----------------------------
Run the following command to install the parser into the `vendor/PHP-Parser` folder:
git submodule add git://github.com/nikic/PHP-Parser.git vendor/PHP-Parser
Installing from the Zip- or Tarball
-----------------------------------
Download the latest version from [the download page][2], unpack it and move the files somewhere into your project.
[1]: http://getcomposer.org/composer.phar
[2]: https://github.com/nikic/PHP-Parser/tags

View File

@ -6,55 +6,60 @@ This document explains how to use the parser, the pretty printer and the node tr
Bootstrapping Bootstrapping
------------- -------------
The library needs to register a class autoloader. You can either use the ''vendor/autoload.php'' file generated by To bootstrap the library, include the autoloader generated by composer:
Composer or by including the bundled `lib/bootstrap.php` file:
```php ```php
<?php
require 'path/to/PHP-Parser/lib/bootstrap.php';
// Or, if you're using Composer:
require 'path/to/vendor/autoload.php'; require 'path/to/vendor/autoload.php';
``` ```
Additionally you may want to set the `xdebug.max_nesting_level` ini option to a higher value: Additionally you may want to set the `xdebug.max_nesting_level` ini option to a higher value:
```php ```php
<?php ini_set('xdebug.max_nesting_level', 3000);
ini_set('xdebug.max_nesting_level', 2000);
``` ```
This ensures that there will be no errors when traversing highly nested node trees. This ensures that there will be no errors when traversing highly nested node trees. However, it is
preferable to disable XDebug completely, as it can easily make this library more than five times
slower.
Parsing Parsing
------- -------
In order to parse some source code you first have to create a `PhpParser\Parser` object, which In order to parse code, you first have to create a parser instance:
needs to be passed a `PhpParser\Lexer` instance:
```php ```php
<?php use PhpParser\ParserFactory;
$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
$parser = new PhpParser\Parser(new PhpParser\Lexer);
// or
$parser = new PhpParser\Parser(new PhpParser\Lexer\Emulative);
``` ```
Use of the emulative lexer is required if you want to parse PHP code from newer versions than the one The factory accepts a kind argument, that determines how different PHP versions are treated:
you're running on. For example it will allow you to parse PHP 5.6 code while running on PHP 5.3.
Kind | Behavior
-----|---------
`ParserFactory::PREFER_PHP7` | Try to parse code as PHP 7. If this fails, try to parse it as PHP 5.
`ParserFactory::PREFER_PHP5` | Try to parse code as PHP 5. If this fails, try to parse it as PHP 7.
`ParserFactory::ONLY_PHP7` | Parse code as PHP 7.
`ParserFactory::ONLY_PHP5` | Parse code as PHP 5.
Unless you have strong reason to use something else, `PREFER_PHP7` is a reasonable default.
The `create()` method optionally accepts a `Lexer` instance as the second argument. Some use cases
that require customized lexers 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 order to 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 be thrown: create a syntax tree. If a syntax error is encountered, an `PhpParser\Error` exception will be thrown:
```php ```php
<?php use PhpParser\Error;
$code = '<?php // some code'; use PhpParser\ParserFactory;
$parser = new PhpParser\Parser(new PhpParser\Lexer\Emulative); $code = '<?php // some code';
$parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
try { try {
$stmts = $parser->parse($code); $stmts = $parser->parse($code);
// $stmts is an array of statement nodes // $stmts is an array of statement nodes
} catch (PhpParser\Error $e) { } catch (Error $e) {
echo 'Parse Error: ', $e->getMessage(); echo 'Parse Error: ', $e->getMessage();
} }
``` ```
@ -102,7 +107,7 @@ with them easier they are grouped into three categories:
and thus can occur in other expressions. Examples of expressions are `$var` and thus can occur in other expressions. Examples of expressions are `$var`
(`PhpParser\Node\Expr\Variable`) and `func()` (`PhpParser\Node\Expr\FuncCall`). (`PhpParser\Node\Expr\Variable`) and `func()` (`PhpParser\Node\Expr\FuncCall`).
* `PhpParser\Node\Scalar`s are nodes representing scalar values, like `'string'` * `PhpParser\Node\Scalar`s are nodes representing scalar values, like `'string'`
(`PhpParser\Node\Scalar\String`), `0` (`PhpParser\Node\Scalar\LNumber`) or magic constants (`PhpParser\Node\Scalar\String_`), `0` (`PhpParser\Node\Scalar\LNumber`) or magic constants
like `__FILE__` (`PhpParser\Node\Scalar\MagicConst\File`). All `PhpParser\Node\Scalar`s extend like `__FILE__` (`PhpParser\Node\Scalar\MagicConst\File`). All `PhpParser\Node\Scalar`s extend
`PhpParser\Node\Expr`, as scalars are expressions, too. `PhpParser\Node\Expr`, as scalars are expressions, too.
* There are some nodes not in either of these groups, for example names (`PhpParser\Node\Name`) * There are some nodes not in either of these groups, for example names (`PhpParser\Node\Name`)
@ -137,11 +142,14 @@ information the formatting is done using a specified scheme. Currently there is
namely `PhpParser\PrettyPrinter\Standard`. namely `PhpParser\PrettyPrinter\Standard`.
```php ```php
<?php use PhpParser\Error;
use PhpParser\ParserFactory;
use PhpParser\PrettyPrinter;
$code = "<?php echo 'Hi ', hi\\getTarget();"; $code = "<?php echo 'Hi ', hi\\getTarget();";
$parser = new PhpParser\Parser(new PhpParser\Lexer); $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
$prettyPrinter = new PhpParser\PrettyPrinter\Standard; $prettyPrinter = new PrettyPrinter\Standard;
try { try {
// parse // parse
@ -158,7 +166,7 @@ try {
$code = $prettyPrinter->prettyPrint($stmts); $code = $prettyPrinter->prettyPrint($stmts);
echo $code; echo $code;
} catch (PhpParser\Error $e) { } catch (Error $e) {
echo 'Parse Error: ', $e->getMessage(); echo 'Parse Error: ', $e->getMessage();
} }
``` ```
@ -188,11 +196,13 @@ For this purpose the parser provides a component for traversing and visiting the
structure of a program using this `PhpParser\NodeTraverser` looks like this: structure of a program using this `PhpParser\NodeTraverser` looks like this:
```php ```php
<?php use PhpParser\NodeTraverser;
use PhpParser\ParserFactory;
use PhpParser\PrettyPrinter;
$parser = new PhpParser\Parser(new PhpParser\Lexer\Emulative); $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
$traverser = new PhpParser\NodeTraverser; $traverser = new NodeTraverser;
$prettyPrinter = new PhpParser\PrettyPrinter\Standard; $prettyPrinter = new PrettyPrinter\Standard;
// add your visitor // add your visitor
$traverser->addVisitor(new MyNodeVisitor); $traverser->addVisitor(new MyNodeVisitor);
@ -218,13 +228,13 @@ try {
The corresponding node visitor might look like this: The corresponding node visitor might look like this:
```php ```php
<?php
use PhpParser\Node; use PhpParser\Node;
use PhpParser\NodeVisitorAbstract;
class MyNodeVisitor extends PhpParser\NodeVisitorAbstract class MyNodeVisitor extends NodeVisitorAbstract
{ {
public function leaveNode(Node $node) { public function leaveNode(Node $node) {
if ($node instanceof Node\Scalar\String) { if ($node instanceof Node\Scalar\String_) {
$node->value = 'foo'; $node->value = 'foo';
} }
} }
@ -236,28 +246,34 @@ The above node visitor would change all string literals in the program to `'foo'
All visitors must implement the `PhpParser\NodeVisitor` interface, which defines the following four All visitors must implement the `PhpParser\NodeVisitor` interface, which defines the following four
methods: methods:
public function beforeTraverse(array $nodes); ```php
public function enterNode(PhpParser\Node $node); public function beforeTraverse(array $nodes);
public function leaveNode(PhpParser\Node $node); public function enterNode(\PhpParser\Node $node);
public function afterTraverse(array $nodes); public function leaveNode(\PhpParser\Node $node);
public function afterTraverse(array $nodes);
```
The `beforeTraverse` method is called once before the traversal begins and is passed the nodes the The `beforeTraverse()` method is called once before the traversal begins and is passed the nodes the
traverser was called with. This method can be used for resetting values before traversation or traverser was called with. This method can be used for resetting values before traversation or
preparing the tree for traversal. preparing the tree for traversal.
The `afterTraverse` method is similar to the `beforeTraverse` method, with the only difference that The `afterTraverse()` method is similar to the `beforeTraverse()` method, with the only difference that
it is called once after the traversal. it is called once after the traversal.
The `enterNode` and `leaveNode` methods are called on every node, the former when it is entered, The `enterNode()` and `leaveNode()` methods are called on every node, the former when it is entered,
i.e. before its subnodes are traversed, the latter when it is left. i.e. before its subnodes are traversed, the latter when it is left.
All four methods can either return the changed node or not return at all (i.e. `null`) in which All four methods can either return the changed node or not return at all (i.e. `null`) in which
case the current node is not changed. The `leaveNode` method can additionally return two special case the current node is not changed.
values:
If `false` is returned the current node will be removed from the parent array. If an array is returned The `enterNode()` method can additionally return the value `NodeTraverser::DONT_TRAVERSE_CHILDREN`,
it will be merged into the parent array at the offset of the current node. I.e. if in `array(A, B, C)` which instructs the traverser to skip all children of the current node.
the node `B` should be replaced with `array(X, Y, Z)` the result will be `array(A, X, Y, Z, C)`.
The `leaveNode()` method can additionally return the value `NodeTraverser::REMOVE_NODE`, in which
case the current node will be removed from the parent array. Furthermore it is possible to return
an array of nodes, which will be merged into the parent array at the offset of the current node.
I.e. if in `array(A, B, C)` the node `B` should be replaced with `array(X, Y, Z)` the result will
be `array(A, X, Y, Z, C)`.
Instead of manually implementing the `NodeVisitor` interface you can also extend the `NodeVisitorAbstract` Instead of manually implementing the `NodeVisitor` interface you can also extend the `NodeVisitorAbstract`
class, which will define empty default implementations for all the above methods. class, which will define empty default implementations for all the above methods.
@ -295,20 +311,24 @@ assume that no dynamic features are used.
We start off with the following base code: We start off with the following base code:
```php ```php
<?php use PhpParser\ParserFactory;
use PhpParser\PrettyPrinter;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\NameResolver;
$inDir = '/some/path'; $inDir = '/some/path';
$outDir = '/some/other/path'; $outDir = '/some/other/path';
$parser = new PhpParser\Parser(new PhpParser\Lexer\Emulative); $parser = (new ParserFactory)->create(ParserFactory::PREFER_PHP7);
$traverser = new PhpParser\NodeTraverser; $traverser = new NodeTraverser;
$prettyPrinter = new PhpParser\PrettyPrinter\Standard; $prettyPrinter = new PrettyPrinter\Standard;
$traverser->addVisitor(new PhpParser\NodeVisitor\NameResolver); // we will need resolved names $traverser->addVisitor(new NameResolver); // we will need resolved names
$traverser->addVisitor(new NodeVisitor\NamespaceConverter); // our own node visitor $traverser->addVisitor(new NamespaceConverter); // our own node visitor
// iterate over all .php files in the directory // iterate over all .php files in the directory
$files = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($inDir)); $files = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($inDir));
$files = new RegexIterator($files, '/\.php$/'); $files = new \RegexIterator($files, '/\.php$/');
foreach ($files as $file) { foreach ($files as $file) {
try { try {
@ -339,9 +359,9 @@ Now lets start with the main code, the `NodeVisitor\NamespaceConverter`. One thi
is convert `A\\B` style names to `A_B` style ones. is convert `A\\B` style names to `A_B` style ones.
```php ```php
<?php
use PhpParser\Node; use PhpParser\Node;
class NodeVisitor_NamespaceConverter extends PhpParser\NodeVisitorAbstract
class NamespaceConverter extends \PhpParser\NodeVisitorAbstract
{ {
public function leaveNode(Node $node) { public function leaveNode(Node $node) {
if ($node instanceof Node\Name) { if ($node instanceof Node\Name) {
@ -358,14 +378,14 @@ create a name with backslashes either write `$node->toString()` or `(string) $no
a new name from the string and return it. Returning a new node replaces the old node. a new name from the string and return it. Returning a new node replaces the old node.
Another thing we need to do is change the class/function/const declarations. Currently they contain Another thing we need to do is change the class/function/const declarations. Currently they contain
only the shortname (i.e. the last part of the name), but they need to contain the complete name inclduing only the shortname (i.e. the last part of the name), but they need to contain the complete name including
the namespace prefix: the namespace prefix:
```php ```php
<?php
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class NodeVisitor_NamespaceConverter extends PhpParser\NodeVisitorAbstract
class NodeVisitor_NamespaceConverter extends \PhpParser\NodeVisitorAbstract
{ {
public function leaveNode(Node $node) { public function leaveNode(Node $node) {
if ($node instanceof Node\Name) { if ($node instanceof Node\Name) {
@ -388,10 +408,10 @@ There is not much more to it than converting the namespaced name to string with
The last thing we need to do is remove the `namespace` and `use` statements: The last thing we need to do is remove the `namespace` and `use` statements:
```php ```php
<?php
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class NodeVisitor_NamespaceConverter extends PhpParser\NodeVisitorAbstract
class NodeVisitor_NamespaceConverter extends \PhpParser\NodeVisitorAbstract
{ {
public function leaveNode(Node $node) { public function leaveNode(Node $node) {
if ($node instanceof Node\Name) { if ($node instanceof Node\Name) {

View File

@ -17,7 +17,6 @@ Furthermore it is possible to dump nodes into a human readable format using the
`PhpParser\NodeDumper`. This can be used for debugging. `PhpParser\NodeDumper`. This can be used for debugging.
```php ```php
<?php
$code = <<<'CODE' $code = <<<'CODE'
<?php <?php
@ -28,7 +27,7 @@ function printLine($msg) {
printLine('Hello World!!!'); printLine('Hello World!!!');
CODE; CODE;
$parser = new PhpParser\Parser(new PhpParser\Lexer); $parser = (new PhpParser\ParserFactory)->create(PhpParser\ParserFactory::PREFER_PHP7);
$nodeDumper = new PhpParser\NodeDumper; $nodeDumper = new PhpParser\NodeDumper;
try { try {
@ -106,7 +105,7 @@ function printLine($msg) {
printLine('Hello World!!!'); printLine('Hello World!!!');
CODE; CODE;
$parser = new PhpParser\Parser(new PhpParser\Lexer); $parser = (new PhpParser\ParserFactory)->create(PhpParser\ParserFactory::PREFER_PHP7);
$serializer = new PhpParser\Serializer\XML; $serializer = new PhpParser\Serializer\XML;
try { try {

View File

@ -2,52 +2,80 @@ Code generation
=============== ===============
It is also possible to generate code using the parser, by first creating an Abstract Syntax Tree and then using the It is also possible to generate code using the parser, by first creating an Abstract Syntax Tree and then using the
pretty printer to convert it to PHP code. To simplify code generation, the project comes with a set of builders for pretty printer to convert it to PHP code. To simplify code generation, the project comes with builders which allow
classes, interfaces, methods, functions, parameters and properties. The builders allow creating node trees using a creating node trees using a fluid interface, instead of instantiating all nodes manually. Builders are available for
fluid interface, instead of instantiating all nodes manually. the following syntactic elements:
* namespaces and use statements
* classes, interfaces and traits
* methods, functions and parameters
* properties
Here is an example: Here is an example:
```php ```php
<?php use PhpParser\BuilderFactory;
$factory = new PhpParser\BuilderFactory; use PhpParser\PrettyPrinter;
$node = $factory->class('SomeClass') use PhpParser\Node;
->extend('SomeOtherClass')
->implement('A\Few', 'Interfaces')
->makeAbstract() // ->makeFinal()
->addStmt($factory->method('someMethod') $factory = new BuilderFactory;
$node = $factory->namespace('Name\Space')
->addStmt($factory->use('Some\Other\Thingy')->as('SomeOtherClass'))
->addStmt($factory->class('SomeClass')
->extend('SomeOtherClass')
->implement('A\Few', '\Interfaces')
->makeAbstract() // ->makeFinal() ->makeAbstract() // ->makeFinal()
->addParam($factory->param('someParam')->setTypeHint('SomeClass'))
)
->addStmt($factory->method('anotherMethod') ->addStmt($factory->method('someMethod')
->makeProtected() // ->makePublic() [default], ->makePrivate() ->makePublic()
->addParam($factory->param('someParam')->setDefault('test')) ->makeAbstract() // ->makeFinal()
// it is possible to add manually created nodes ->setReturnType('bool')
->addStmt(new PhpParser\Node\Expr\Print_(new PhpParser\Node\Expr\Variable('someParam'))) ->addParam($factory->param('someParam')->setTypeHint('SomeClass'))
) ->setDocComment('/**
* This method does something.
*
* @param SomeClass And takes a parameter
*/')
)
// properties will be correctly reordered above the methods ->addStmt($factory->method('anotherMethod')
->addStmt($factory->property('someProperty')->makeProtected()) ->makeProtected() // ->makePublic() [default], ->makePrivate()
->addStmt($factory->property('anotherProperty')->makePrivate()->setDefault(array(1, 2, 3))) ->addParam($factory->param('someParam')->setDefault('test'))
// it is possible to add manually created nodes
->addStmt(new Node\Expr\Print_(new Node\Expr\Variable('someParam')))
)
// properties will be correctly reordered above the methods
->addStmt($factory->property('someProperty')->makeProtected())
->addStmt($factory->property('anotherProperty')->makePrivate()->setDefault(array(1, 2, 3)))
)
->getNode() ->getNode()
; ;
$stmts = array($node); $stmts = array($node);
echo $prettyPrinter->prettyPrint($stmts); $prettyPrinter = new PrettyPrinter\Standard();
echo $prettyPrinter->prettyPrintFile($stmts);
``` ```
This will produce the following output with the default pretty printer: This will produce the following output with the standard pretty printer:
```php ```php
<?php <?php
abstract class SomeClass extends SomeOtherClass implements A\Few, Interfaces
namespace Name\Space;
use Some\Other\Thingy as SomeClass;
abstract class SomeClass extends SomeOtherClass implements A\Few, \Interfaces
{ {
protected $someProperty; protected $someProperty;
private $anotherProperty = array(1, 2, 3); private $anotherProperty = array(1, 2, 3);
abstract function someMethod(SomeClass $someParam); /**
* This method does something.
*
* @param SomeClass And takes a parameter
*/
public abstract function someMethod(SomeClass $someParam) : bool;
protected function anotherMethod($someParam = 'test') protected function anotherMethod($someParam = 'test')
{ {
print $someParam; print $someParam;

View File

@ -0,0 +1,77 @@
Error handling
==============
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.
How much location information is available depends on the origin of the error and how many lexer attributes have been
enabled. At a minimum the start line of the error is usually available.
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
$lexer = new PhpParser\Lexer(array(
'usedAttributes' => array('comments', 'startLine', 'endLine', 'startFilePos', 'endFilePos'),
));
$parser = (new PhpParser\ParserFactory)->create(PhpParser\ParserFactory::PREFER_PHP7, $lexer);
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
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:
```php
if ($e->hasColumnInfo()) {
echo $e->getRawMessage() . ' from ' . $e->getStartLine() . ':' . $e->getStartColumn($code)
. ' to ' . $e->getEndLine() . ':' . $e->getEndColumn($code);
} else {
echo $e->getMessage();
}
```
Both line numbers and column numbers are 1-based. EOF errors will be located at the position one past the end of the
file.
Error recovery
--------------
> **EXPERIMENTAL**
By default the parser will throw an exception upon encountering the first error during parsing. An alternative mode is
also supported, in which the parser will remember the error, but try to continue parsing the rest of the source code.
To enable this mode the `throwOnError` parser option needs to be disabled. Any errors that occurred during parsing can
then be retrieved using `$parser->getErrors()`. The `$parser->parse()` method will either return a partial syntax tree
or `null` if recovery fails.
A usage example:
```php
$parser = (new PhpParser\ParserFactory)->create(PhpParser\ParserFactory::PREFER_PHP7, null, array(
'throwOnError' => false,
));
$stmts = $parser->parse($code);
$errors = $parser->getErrors();
foreach ($errors as $error) {
// $error is an ordinary PhpParser\Error
}
if (null !== $stmts) {
// $stmts is a best-effort partial AST
}
```
The error recovery implementation is experimental -- it currently won't be able to recover from many types of errors.

View File

@ -5,83 +5,47 @@ The lexer is responsible for providing tokens to the parser. The project comes w
`PhpParser\Lexer\Emulative`. The latter is an extension of the former, which adds the ability to emulate tokens of `PhpParser\Lexer\Emulative`. The latter is an extension of the former, which adds the ability to emulate tokens of
newer PHP versions and thus allows parsing of new code on older versions. newer PHP versions and thus allows parsing of new code on older versions.
A lexer has to define the following public interface: This documentation discusses options available for the default lexers and explains how lexers can be extended.
void startLexing(string $code); Lexer options
string handleHaltCompiler(); -------------
int getNextToken(string &$value = null, array &$startAttributes = null, array &$endAttributes = null);
The `startLexing()` method is invoked with the source code that is to be lexed (including the opening tag) whenever the The two default lexers accept an `$options` array in the constructor. Currently only the `'usedAttributes'` option is
`parse()` method of the parser is called. It can be used to reset state or preprocess the source code or tokens. supported, which allows you to specify which attributes will be added to the AST nodes. The attributes can then be
accessed using `$node->getAttribute()`, `$node->setAttribute()`, `$node->hasAttribute()` and `$node->getAttributes()`
The `handleHaltCompiler()` method is called whenever a `T_HALT_COMPILER` token is encountered. It has to return the methods. A sample options array:
remaining string after the construct (not including `();`).
The `getNextToken()` method returns the ID of the next token (as defined by the `Parser::T_*` constants). 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.
By default the lexer creates the attributes `startLine`, `comments` (both part of `$startAttributes`) and `endLine`
(part of `$endAttributes`).
If you don't want all these attributes to be added (to reduce memory usage of the AST) you can simply remove them by
overriding the method:
```php ```php
<?php $lexer = new PhpParser\Lexer(array(
'usedAttributes' => array(
class LessAttributesLexer extends PhpParser\Lexer { 'comments', 'startLine', 'endLine'
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) { )
$tokenId = parent::getNextToken($value, $startAttributes, $endAttributes); ));
// only keep startLine attribute
unset($startAttributes['comments']);
unset($endAttributes['endLine']);
return $tokenId;
}
}
``` ```
Token offset lexer The attributes used in this example match the default behavior of the lexer. The following attributes are supported:
------------------
A useful application for custom attributes is the token offset lexer, which provides the start and end token for a node * `comments`: Array of `PhpParser\Comment` or `PhpParser\Comment\Doc` instances, representing all comments that occurred
as attributes: between the previous non-discarded token and the current one. Use of this attribute is required for the
`$node->getDocComment()` method to work. The attribute is also needed if you wish the pretty printer to retain
comments present in the original code.
* `startLine`: Line in which the node starts. This attribute is required for the `$node->getLine()` to work. It is also
required if syntax errors should contain line number information.
* `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.
```php ### Using token positions
<?php
class TokenOffsetLexer extends PhpParser\Lexer { The token offset information is useful if you wish to examine the exact formatting used for a node. For example the AST
public function getNextToken(&$value = null, &$startAttributes = null, &$endAttributes = null) { does not distinguish whether a property was declared using `public` or using `var`, but you can retrieve this
$tokenId = parent::getNextToken($value, $startAttributes, $endAttributes); information based on the token position:
$startAttributes['startOffset'] = $endAttributes['endOffset'] = $this->pos;
return $tokenId;
}
public function getTokens() {
return $this->tokens;
}
}
```
This information can now be used to examine the exact formatting used for a node. For example the AST does not
distinguish whether a property was declared using `public` or using `var`, but you can retrieve this information based
on the token offset:
```php ```php
function isDeclaredUsingVar(array $tokens, PhpParser\Node\Stmt\Property $prop) { function isDeclaredUsingVar(array $tokens, PhpParser\Node\Stmt\Property $prop) {
$i = $prop->getAttribute('startOffset'); $i = $prop->getAttribute('startTokenPos');
return $tokens[$i][0] === T_VAR; return $tokens[$i][0] === T_VAR;
} }
``` ```
@ -103,8 +67,12 @@ class MyNodeVisitor extends PhpParser\NodeVisitorAbstract {
} }
} }
$lexer = new TokenOffsetLexer(); $lexer = new PhpParser\Lexer(array(
$parser = new PhpParser\Parser($lexer); 'usedAttributes' => array(
'comments', 'startLine', 'endLine', 'startTokenPos', 'endTokenPos'
)
));
$parser = (new PhpParser\ParserFactory)->create(PhpParser\ParserFactory::PREFER_PHP7, $lexer);
$visitor = new MyNodeVisitor(); $visitor = new MyNodeVisitor();
$traverser = new PhpParser\NodeTraverser(); $traverser = new PhpParser\NodeTraverser();
@ -121,3 +89,61 @@ try {
The same approach can also be used to perform specific modifications in the code, without changing the formatting in 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). other places (which is the case when using the pretty printer).
Lexer extension
---------------
A lexer has to define the following public interface:
void startLexing(string $code);
array getTokens();
string handleHaltCompiler();
int getNextToken(string &$value = null, array &$startAttributes = null, array &$endAttributes = null);
The `startLexing()` method is invoked with the source code that is to be lexed (including the opening tag) whenever the
`parse()` method of the parser is called. It can be used to reset state or preprocess the source code or tokens.
The `getTokens()` method returns the current token array, in the usual `token_get_all()` format. 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 (as defined by the `Parser::T_*` constants). 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 original formatting of literals: The parser does not retain
information about the formatting of integers (like decimal vs. hexadecimal) or strings (like used quote type or used
escape sequences). 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 == Tokens::T_CONSTANT_ENCAPSED_STRING // non-interpolated string
|| $tokenId == Tokens::T_LNUMBER // integer
|| $tokenId == Tokens::T_DNUMBER // floating point number
) {
// could also use $startAttributes, doesn't really matter here
$endAttributes['originalValue'] = $value;
}
return $tokenId;
}
}
```

View File

@ -1,23 +1,23 @@
What do all those files mean? What do all those files mean?
============================= =============================
* `zend_language_parser.phpy`: PHP grammer written in a pseudo language * `php5.y`: PHP 5 grammar written in a pseudo language
* `analyze.php`: Analyzes the `.phpy`-grammer and outputs some info about it * `php7.y`: PHP 7 grammar written in a pseudo language
* `rebuildParser.php`: Preprocesses the `.phpy`-grammar and builds the parser using `kmyacc` * `tokens.y`: Tokens definition shared between PHP 5 and PHP 7 grammars
* `kmyacc.php.parser`: A `kmyacc` parser prototype file for PHP * `parser.template`: A `kmyacc` parser prototype file for PHP
* `tokens.template`: A `kmyacc` prototype file for the `Tokens` class
* `analyze.php`: Analyzes the grammer and outputs some info about it
* `rebuildParser.php`: Preprocesses the grammar and builds the parser using `kmyacc`
.phpy pseudo language .phpy pseudo language
===================== =====================
The `.phpy` file is a normal grammer in `kmyacc` (`yacc`) style, with some transformations The `.y` file is a normal grammer in `kmyacc` (`yacc`) style, with some transformations
applied to it: applied to it:
* Nodes are created using the syntax `Name[..., ...]`. This is transformed into * Nodes are created using the syntax `Name[..., ...]`. This is transformed into
`new Node\Name(..., ..., $attributes)` `new Name(..., ..., attributes())`
* `Name::abc` is transformed to `Node\Name::abc`
* Some function-like constructs are resolved (see `rebuildParser.php` for a list) * Some function-like constructs are resolved (see `rebuildParser.php` for a list)
* Associative arrays are written as `[key: value, ...]`, which is transformed to
`array('key' => value, ...)`
Building the parser Building the parser
=================== ===================
@ -25,5 +25,5 @@ Building the parser
In order to rebuild the parser, you need [moriyoshi's fork of kmyacc](https://github.com/moriyoshi/kmyacc-forked). In order to rebuild the parser, you need [moriyoshi's fork of kmyacc](https://github.com/moriyoshi/kmyacc-forked).
After you compiled/installed it, run the `rebuildParser.php` script. After you compiled/installed it, run the `rebuildParser.php` script.
By default only the `Parser.php` is built. If you want to additionally build `Parser/Debug.php` and `y.output` run the By default only the `Parser.php` is built. If you want to additionally emit debug symbols and create `y.output`, run the
script with `--debug`. If you want to retain the preprocessed grammar pass `--keep-tmp-grammar`. script with `--debug`. If you want to retain the preprocessed grammar pass `--keep-tmp-grammar`.

View File

@ -1,6 +1,6 @@
<?php <?php
const GRAMMAR_FILE = './zend_language_parser.phpy'; const GRAMMAR_FILE = './php5.y';
const LIB = '(?(DEFINE) const LIB = '(?(DEFINE)
(?<singleQuotedString>\'[^\\\\\']*+(?:\\\\.[^\\\\\']*+)*+\') (?<singleQuotedString>\'[^\\\\\']*+(?:\\\\.[^\\\\\']*+)*+\')

View File

@ -2,35 +2,39 @@
$meta # $meta #
#semval($) $this->semValue #semval($) $this->semValue
#semval($,%t) $this->semValue #semval($,%t) $this->semValue
#semval(%n) $this->semStack[$this->stackPos-(%l-%n)] #semval(%n) $this->stackPos-(%l-%n)
#semval(%n,%t) $this->semStack[$this->stackPos-(%l-%n)] #semval(%n,%t) $this->stackPos-(%l-%n)
#include;
namespace PhpParser; namespace PhpParser\Parser;
use PhpParser\Error;
use PhpParser\Node;
use PhpParser\Node\Expr;
use PhpParser\Node\Name;
use PhpParser\Node\Scalar;
use PhpParser\Node\Stmt;
#include;
/* This is an automatically GENERATED file, which should not be manually edited. /* This is an automatically GENERATED file, which should not be manually edited.
* Instead edit one of the following: * Instead edit one of the following:
* * the grammar file grammar/zend_language_parser.phpy * * the grammar files grammar/php5.y or grammar/php7.y
* * the skeleton file grammar/kymacc.php.parser * * the skeleton file grammar/parser.template
* * the preprocessing script grammar/rebuildParser.php * * the preprocessing script grammar/rebuildParsers.php
*/ */
class Parser extends ParserAbstract class #(-p) extends \PhpParser\ParserAbstract
{ {
protected $tokenToSymbolMapSize = #(YYMAXLEX); protected $tokenToSymbolMapSize = #(YYMAXLEX);
protected $actionTableSize = #(YYLAST); protected $actionTableSize = #(YYLAST);
protected $gotoTableSize = #(YYGLAST); protected $gotoTableSize = #(YYGLAST);
protected $invalidToken = #(YYBADCH); protected $invalidSymbol = #(YYBADCH);
protected $errorSymbol = #(YYINTERRTOK);
protected $defaultAction = #(YYDEFAULT); protected $defaultAction = #(YYDEFAULT);
protected $unexpectedTokenRule = #(YYUNEXPECTED); protected $unexpectedTokenRule = #(YYUNEXPECTED);
protected $YY2TBLSTATE = #(YY2TBLSTATE); protected $YY2TBLSTATE = #(YY2TBLSTATE);
protected $YYNLSTATES = #(YYNLSTATES); protected $YYNLSTATES = #(YYNLSTATES);
#tokenval
const %s = %n;
#endtokenval
protected $symbolToName = array( protected $symbolToName = array(
#listvar terminals #listvar terminals
); );
@ -86,7 +90,7 @@ class Parser extends ParserAbstract
#endif #endif
#reduce #reduce
protected function reduceRule%n($attributes) { protected function reduceRule%n() {
%b %b
} }
#noact #noact

View File

@ -1,113 +1,7 @@
%pure_parser %pure_parser
%expect 2 %expect 6
%left T_INCLUDE T_INCLUDE_ONCE T_EVAL T_REQUIRE T_REQUIRE_ONCE %tokens
%left ','
%left T_LOGICAL_OR
%left T_LOGICAL_XOR
%left T_LOGICAL_AND
%right T_PRINT
%right T_YIELD
%left '=' T_PLUS_EQUAL T_MINUS_EQUAL T_MUL_EQUAL T_DIV_EQUAL T_CONCAT_EQUAL T_MOD_EQUAL T_AND_EQUAL T_OR_EQUAL T_XOR_EQUAL T_SL_EQUAL T_SR_EQUAL T_POW_EQUAL
%left '?' ':'
%left T_BOOLEAN_OR
%left T_BOOLEAN_AND
%left '|'
%left '^'
%left '&'
%nonassoc T_IS_EQUAL T_IS_NOT_EQUAL T_IS_IDENTICAL T_IS_NOT_IDENTICAL
%nonassoc '<' T_IS_SMALLER_OR_EQUAL '>' T_IS_GREATER_OR_EQUAL
%left T_SL T_SR
%left '+' '-' '.'
%left '*' '/' '%'
%right '!'
%nonassoc T_INSTANCEOF
%right '~' T_INC T_DEC T_INT_CAST T_DOUBLE_CAST T_STRING_CAST T_ARRAY_CAST T_OBJECT_CAST T_BOOL_CAST T_UNSET_CAST '@'
%right T_POW
%right '['
%nonassoc T_NEW T_CLONE
%token T_EXIT
%token T_IF
%left T_ELSEIF
%left T_ELSE
%left T_ENDIF
%token T_LNUMBER
%token T_DNUMBER
%token T_STRING
%token T_STRING_VARNAME
%token T_VARIABLE
%token T_NUM_STRING
%token T_INLINE_HTML
%token T_CHARACTER
%token T_BAD_CHARACTER
%token T_ENCAPSED_AND_WHITESPACE
%token T_CONSTANT_ENCAPSED_STRING
%token T_ECHO
%token T_DO
%token T_WHILE
%token T_ENDWHILE
%token T_FOR
%token T_ENDFOR
%token T_FOREACH
%token T_ENDFOREACH
%token T_DECLARE
%token T_ENDDECLARE
%token T_AS
%token T_SWITCH
%token T_ENDSWITCH
%token T_CASE
%token T_DEFAULT
%token T_BREAK
%token T_CONTINUE
%token T_GOTO
%token T_FUNCTION
%token T_CONST
%token T_RETURN
%token T_TRY
%token T_CATCH
%token T_FINALLY
%token T_THROW
%token T_USE
%token T_INSTEADOF
%token T_GLOBAL
%right T_STATIC T_ABSTRACT T_FINAL T_PRIVATE T_PROTECTED T_PUBLIC
%token T_VAR
%token T_UNSET
%token T_ISSET
%token T_EMPTY
%token T_HALT_COMPILER
%token T_CLASS
%token T_TRAIT
%token T_INTERFACE
%token T_EXTENDS
%token T_IMPLEMENTS
%token T_OBJECT_OPERATOR
%token T_DOUBLE_ARROW
%token T_LIST
%token T_ARRAY
%token T_CALLABLE
%token T_CLASS_C
%token T_TRAIT_C
%token T_METHOD_C
%token T_FUNC_C
%token T_LINE
%token T_FILE
%token T_COMMENT
%token T_DOC_COMMENT
%token T_OPEN_TAG
%token T_OPEN_TAG_WITH_ECHO
%token T_CLOSE_TAG
%token T_WHITESPACE
%token T_START_HEREDOC
%token T_END_HEREDOC
%token T_DOLLAR_OPEN_CURLY_BRACES
%token T_CURLY_OPEN
%token T_PAAMAYIM_NEKUDOTAYIM
%token T_NAMESPACE
%token T_NS_C
%token T_DIR
%token T_NS_SEPARATOR
%token T_ELLIPSIS
%% %%
@ -115,11 +9,37 @@ start:
top_statement_list { $$ = $this->handleNamespaces($1); } top_statement_list { $$ = $this->handleNamespaces($1); }
; ;
top_statement_list: top_statement_list_ex:
top_statement_list top_statement { pushNormalizing($1, $2); } top_statement_list_ex top_statement { pushNormalizing($1, $2); }
| /* empty */ { init(); } | /* empty */ { init(); }
; ;
top_statement_list:
top_statement_list_ex
{ makeNop($nop, $this->lookaheadStartAttributes);
if ($nop !== null) { $1[] = $nop; } $$ = $1; }
;
reserved_non_modifiers:
T_INCLUDE | T_INCLUDE_ONCE | T_EVAL | T_REQUIRE | T_REQUIRE_ONCE | T_LOGICAL_OR | T_LOGICAL_XOR | T_LOGICAL_AND
| T_INSTANCEOF | T_NEW | T_CLONE | T_EXIT | T_IF | T_ELSEIF | T_ELSE | T_ENDIF | T_ECHO | T_DO | T_WHILE
| T_ENDWHILE | T_FOR | T_ENDFOR | T_FOREACH | T_ENDFOREACH | T_DECLARE | T_ENDDECLARE | T_AS | T_TRY | T_CATCH
| T_FINALLY | T_THROW | T_USE | T_INSTEADOF | T_GLOBAL | T_VAR | T_UNSET | T_ISSET | T_EMPTY | T_CONTINUE | T_GOTO
| T_FUNCTION | T_CONST | T_RETURN | T_PRINT | T_YIELD | T_LIST | T_SWITCH | T_ENDSWITCH | T_CASE | T_DEFAULT
| T_BREAK | T_ARRAY | T_CALLABLE | T_EXTENDS | T_IMPLEMENTS | T_NAMESPACE | T_TRAIT | T_INTERFACE | T_CLASS
| T_CLASS_C | T_TRAIT_C | T_FUNC_C | T_METHOD_C | T_LINE | T_FILE | T_DIR | T_NS_C | T_HALT_COMPILER
;
semi_reserved:
reserved_non_modifiers
| T_STATIC | T_ABSTRACT | T_FINAL | T_PRIVATE | T_PROTECTED | T_PUBLIC
;
identifier:
T_STRING { $$ = $1; }
| semi_reserved { $$ = $1; }
;
namespace_name_parts: namespace_name_parts:
T_STRING { init($1); } T_STRING { init($1); }
| namespace_name_parts T_NS_SEPARATOR T_STRING { push($1, $3); } | namespace_name_parts T_NS_SEPARATOR T_STRING { push($1, $3); }
@ -139,21 +59,57 @@ top_statement:
| T_NAMESPACE namespace_name '{' top_statement_list '}' { $$ = Stmt\Namespace_[$2, $4]; } | T_NAMESPACE namespace_name '{' top_statement_list '}' { $$ = Stmt\Namespace_[$2, $4]; }
| T_NAMESPACE '{' top_statement_list '}' { $$ = Stmt\Namespace_[null, $3]; } | T_NAMESPACE '{' top_statement_list '}' { $$ = Stmt\Namespace_[null, $3]; }
| T_USE use_declarations ';' { $$ = Stmt\Use_[$2, Stmt\Use_::TYPE_NORMAL]; } | T_USE use_declarations ';' { $$ = Stmt\Use_[$2, Stmt\Use_::TYPE_NORMAL]; }
| T_USE T_FUNCTION use_declarations ';' { $$ = Stmt\Use_[$3, Stmt\Use_::TYPE_FUNCTION]; } | T_USE use_type use_declarations ';' { $$ = Stmt\Use_[$3, $2]; }
| T_USE T_CONST use_declarations ';' { $$ = Stmt\Use_[$3, Stmt\Use_::TYPE_CONSTANT]; } | group_use_declaration ';' { $$ = $1; }
| T_CONST constant_declaration_list ';' { $$ = Stmt\Const_[$2]; } | T_CONST constant_declaration_list ';' { $$ = Stmt\Const_[$2]; }
; ;
use_type:
T_FUNCTION { $$ = Stmt\Use_::TYPE_FUNCTION; }
| T_CONST { $$ = Stmt\Use_::TYPE_CONSTANT; }
;
/* Using namespace_name_parts here to avoid s/r conflict on T_NS_SEPARATOR */
group_use_declaration:
T_USE use_type namespace_name_parts T_NS_SEPARATOR '{' unprefixed_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$3], $6, $2]; }
| T_USE use_type T_NS_SEPARATOR namespace_name_parts T_NS_SEPARATOR '{' unprefixed_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$4], $7, $2]; }
| T_USE namespace_name_parts T_NS_SEPARATOR '{' inline_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$2], $5, Stmt\Use_::TYPE_UNKNOWN]; }
| T_USE T_NS_SEPARATOR namespace_name_parts T_NS_SEPARATOR '{' inline_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$3], $6, Stmt\Use_::TYPE_UNKNOWN]; }
;
unprefixed_use_declarations:
unprefixed_use_declarations ',' unprefixed_use_declaration
{ push($1, $3); }
| unprefixed_use_declaration { init($1); }
;
use_declarations: use_declarations:
use_declarations ',' use_declaration { push($1, $3); } use_declarations ',' use_declaration { push($1, $3); }
| use_declaration { init($1); } | use_declaration { init($1); }
; ;
inline_use_declarations:
inline_use_declarations ',' inline_use_declaration { push($1, $3); }
| inline_use_declaration { init($1); }
;
unprefixed_use_declaration:
namespace_name { $$ = Stmt\UseUse[$1, null, Stmt\Use_::TYPE_UNKNOWN]; }
| namespace_name T_AS T_STRING { $$ = Stmt\UseUse[$1, $3, Stmt\Use_::TYPE_UNKNOWN]; }
;
use_declaration: use_declaration:
namespace_name { $$ = Stmt\UseUse[$1, null]; } unprefixed_use_declaration { $$ = $1; }
| namespace_name T_AS T_STRING { $$ = Stmt\UseUse[$1, $3]; } | T_NS_SEPARATOR unprefixed_use_declaration { $$ = $2; }
| T_NS_SEPARATOR namespace_name { $$ = Stmt\UseUse[$2, null]; } ;
| T_NS_SEPARATOR namespace_name T_AS T_STRING { $$ = Stmt\UseUse[$2, $4]; }
inline_use_declaration:
unprefixed_use_declaration { $$ = $1; $$->type = Stmt\Use_::TYPE_NORMAL; }
| use_type unprefixed_use_declaration { $$ = $2; $$->type = $1; }
; ;
constant_declaration_list: constant_declaration_list:
@ -162,31 +118,47 @@ constant_declaration_list:
; ;
constant_declaration: constant_declaration:
T_STRING '=' static_scalar { $$ = Const_[$1, $3]; } T_STRING '=' static_scalar { $$ = Node\Const_[$1, $3]; }
;
class_const_list:
class_const_list ',' class_const { push($1, $3); }
| class_const { init($1); }
;
class_const:
identifier '=' static_scalar { $$ = Node\Const_[$1, $3]; }
;
inner_statement_list_ex:
inner_statement_list_ex inner_statement { pushNormalizing($1, $2); }
| /* empty */ { init(); }
; ;
inner_statement_list: inner_statement_list:
inner_statement_list inner_statement { pushNormalizing($1, $2); } inner_statement_list_ex
| /* empty */ { init(); } { makeNop($nop, $this->lookaheadStartAttributes);
if ($nop !== null) { $1[] = $nop; } $$ = $1; }
; ;
inner_statement: inner_statement:
statement { $$ = $1; } statement { $$ = $1; }
| function_declaration_statement { $$ = $1; } | function_declaration_statement { $$ = $1; }
| class_declaration_statement { $$ = $1; } | class_declaration_statement { $$ = $1; }
| T_HALT_COMPILER { error('__HALT_COMPILER() can only be used from the outermost scope'); } | T_HALT_COMPILER
{ throw new Error('__HALT_COMPILER() can only be used from the outermost scope', attributes()); }
; ;
statement: non_empty_statement:
'{' inner_statement_list '}' { $$ = $2; } '{' inner_statement_list '}' { $$ = $2; }
| T_IF parentheses_expr statement elseif_list else_single | T_IF parentheses_expr statement elseif_list else_single
{ $$ = Stmt\If_[$2, [stmts: toArray($3), elseifs: $4, else: $5]]; } { $$ = Stmt\If_[$2, ['stmts' => toArray($3), 'elseifs' => $4, 'else' => $5]]; }
| T_IF parentheses_expr ':' inner_statement_list new_elseif_list new_else_single T_ENDIF ';' | T_IF parentheses_expr ':' inner_statement_list new_elseif_list new_else_single T_ENDIF ';'
{ $$ = Stmt\If_[$2, [stmts: $4, elseifs: $5, else: $6]]; } { $$ = Stmt\If_[$2, ['stmts' => $4, 'elseifs' => $5, 'else' => $6]]; }
| T_WHILE parentheses_expr while_statement { $$ = Stmt\While_[$2, $3]; } | T_WHILE parentheses_expr while_statement { $$ = Stmt\While_[$2, $3]; }
| T_DO statement T_WHILE parentheses_expr ';' { $$ = Stmt\Do_ [$4, toArray($2)]; } | T_DO statement T_WHILE parentheses_expr ';' { $$ = Stmt\Do_ [$4, toArray($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 parentheses_expr switch_case_list { $$ = Stmt\Switch_[$2, $3]; } | T_SWITCH parentheses_expr switch_case_list { $$ = Stmt\Switch_[$2, $3]; }
| T_BREAK ';' { $$ = Stmt\Break_[null]; } | T_BREAK ';' { $$ = Stmt\Break_[null]; }
| T_BREAK expr ';' { $$ = Stmt\Break_[$2]; } | T_BREAK expr ';' { $$ = Stmt\Break_[$2]; }
@ -202,16 +174,23 @@ statement:
| expr ';' { $$ = $1; } | expr ';' { $$ = $1; }
| T_UNSET '(' variables_list ')' ';' { $$ = Stmt\Unset_[$3]; } | T_UNSET '(' variables_list ')' ';' { $$ = 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]]; }
| T_FOREACH '(' expr T_AS variable T_DOUBLE_ARROW foreach_variable ')' foreach_statement | T_FOREACH '(' expr T_AS variable T_DOUBLE_ARROW foreach_variable ')' foreach_statement
{ $$ = Stmt\Foreach_[$3, $7[0], [keyVar: $5, byRef: $7[1], stmts: $9]]; } { $$ = Stmt\Foreach_[$3, $7[0], ['keyVar' => $5, 'byRef' => $7[1], 'stmts' => $9]]; }
| T_DECLARE '(' declare_list ')' declare_statement { $$ = Stmt\Declare_[$3, $5]; } | T_DECLARE '(' declare_list ')' declare_statement { $$ = Stmt\Declare_[$3, $5]; }
| ';' { $$ = array(); /* means: no statement */ }
| T_TRY '{' inner_statement_list '}' catches optional_finally | T_TRY '{' inner_statement_list '}' catches optional_finally
{ $$ = Stmt\TryCatch[$3, $5, $6]; } { $$ = Stmt\TryCatch[$3, $5, $6]; }
| T_THROW expr ';' { $$ = Stmt\Throw_[$2]; } | T_THROW expr ';' { $$ = Stmt\Throw_[$2]; }
| T_GOTO T_STRING ';' { $$ = Stmt\Goto_[$2]; } | T_GOTO T_STRING ';' { $$ = Stmt\Goto_[$2]; }
| T_STRING ':' { $$ = Stmt\Label[$1]; } | T_STRING ':' { $$ = Stmt\Label[$1]; }
| error { $$ = array(); /* means: no statement */ }
;
statement:
non_empty_statement { $$ = $1; }
| ';'
{ makeNop($$, $this->startAttributeStack[#1]);
if ($$ === null) $$ = array(); /* means: no statement */ }
; ;
catches: catches:
@ -245,15 +224,15 @@ optional_ellipsis:
; ;
function_declaration_statement: function_declaration_statement:
T_FUNCTION optional_ref T_STRING '(' parameter_list ')' '{' inner_statement_list '}' T_FUNCTION optional_ref T_STRING '(' parameter_list ')' optional_return_type '{' inner_statement_list '}'
{ $$ = Stmt\Function_[$3, [byRef: $2, params: $5, stmts: $8]]; } { $$ = Stmt\Function_[$3, ['byRef' => $2, 'params' => $5, 'returnType' => $7, 'stmts' => $9]]; }
; ;
class_declaration_statement: class_declaration_statement:
class_entry_type T_STRING extends_from implements_list '{' class_statement_list '}' class_entry_type T_STRING extends_from implements_list '{' class_statement_list '}'
{ $$ = Stmt\Class_[$2, [type: $1, extends: $3, implements: $4, stmts: $6]]; } { $$ = Stmt\Class_[$2, ['type' => $1, 'extends' => $3, 'implements' => $4, 'stmts' => $6]]; }
| T_INTERFACE T_STRING interface_extends_list '{' class_statement_list '}' | T_INTERFACE T_STRING interface_extends_list '{' class_statement_list '}'
{ $$ = Stmt\Interface_[$2, [extends: $3, stmts: $5]]; } { $$ = Stmt\Interface_[$2, ['extends' => $3, 'stmts' => $5]]; }
| T_TRAIT T_STRING '{' class_statement_list '}' | T_TRAIT T_STRING '{' class_statement_list '}'
{ $$ = Stmt\Trait_[$2, $4]; } { $$ = Stmt\Trait_[$2, $4]; }
; ;
@ -295,7 +274,8 @@ foreach_statement:
; ;
declare_statement: declare_statement:
statement { $$ = toArray($1); } non_empty_statement { $$ = toArray($1); }
| ';' { $$ = null; }
| ':' inner_statement_list T_ENDDECLARE ';' { $$ = $2; } | ':' inner_statement_list T_ENDDECLARE ';' { $$ = $2; }
; ;
@ -380,23 +360,32 @@ non_empty_parameter_list:
; ;
parameter: parameter:
optional_class_type optional_ref optional_ellipsis T_VARIABLE optional_param_type optional_ref optional_ellipsis T_VARIABLE
{ $$ = Param[parseVar($4), null, $1, $2, $3]; } { $$ = Node\Param[parseVar($4), null, $1, $2, $3]; }
| optional_class_type optional_ref optional_ellipsis T_VARIABLE '=' static_scalar | optional_param_type optional_ref optional_ellipsis T_VARIABLE '=' static_scalar
{ $$ = Param[parseVar($4), $6, $1, $2, $3]; } { $$ = Node\Param[parseVar($4), $6, $1, $2, $3]; }
; ;
optional_class_type: type:
/* empty */ { $$ = null; } name { $$ = $1; }
| name { $$ = $1; }
| T_ARRAY { $$ = 'array'; } | T_ARRAY { $$ = 'array'; }
| T_CALLABLE { $$ = 'callable'; } | T_CALLABLE { $$ = 'callable'; }
; ;
optional_param_type:
/* empty */ { $$ = null; }
| type { $$ = $1; }
;
optional_return_type:
/* empty */ { $$ = null; }
| ':' type { $$ = $2; }
;
argument_list: argument_list:
'(' ')' { $$ = array(); } '(' ')' { $$ = array(); }
| '(' non_empty_argument_list ')' { $$ = $2; } | '(' non_empty_argument_list ')' { $$ = $2; }
| '(' yield_expr ')' { $$ = array(Arg[$2, false, false]); } | '(' yield_expr ')' { $$ = array(Node\Arg[$2, false, false]); }
; ;
non_empty_argument_list: non_empty_argument_list:
@ -405,9 +394,9 @@ non_empty_argument_list:
; ;
argument: argument:
expr { $$ = Arg[$1, false, false]; } expr { $$ = Node\Arg[$1, false, false]; }
| '&' variable { $$ = Arg[$2, true, false]; } | '&' variable { $$ = Node\Arg[$2, true, false]; }
| T_ELLIPSIS expr { $$ = Arg[$2, false, true]; } | T_ELLIPSIS expr { $$ = Node\Arg[$2, false, true]; }
; ;
global_var_list: global_var_list:
@ -438,9 +427,9 @@ class_statement_list:
class_statement: class_statement:
variable_modifiers property_declaration_list ';' { $$ = Stmt\Property[$1, $2]; } variable_modifiers property_declaration_list ';' { $$ = Stmt\Property[$1, $2]; }
| T_CONST constant_declaration_list ';' { $$ = Stmt\ClassConst[$2]; } | T_CONST class_const_list ';' { $$ = Stmt\ClassConst[$2]; }
| method_modifiers T_FUNCTION optional_ref T_STRING '(' parameter_list ')' method_body | method_modifiers T_FUNCTION optional_ref identifier '(' parameter_list ')' optional_return_type method_body
{ $$ = Stmt\ClassMethod[$4, [type: $1, byRef: $3, params: $6, stmts: $8]]; } { $$ = Stmt\ClassMethod[$4, ['type' => $1, 'byRef' => $3, 'params' => $6, 'returnType' => $8, 'stmts' => $9]]; }
| T_USE name_list trait_adaptations { $$ = Stmt\TraitUse[$2, $3]; } | T_USE name_list trait_adaptations { $$ = Stmt\TraitUse[$2, $3]; }
; ;
@ -457,20 +446,22 @@ trait_adaptation_list:
trait_adaptation: trait_adaptation:
trait_method_reference_fully_qualified T_INSTEADOF name_list ';' trait_method_reference_fully_qualified T_INSTEADOF name_list ';'
{ $$ = Stmt\TraitUseAdaptation\Precedence[$1[0], $1[1], $3]; } { $$ = Stmt\TraitUseAdaptation\Precedence[$1[0], $1[1], $3]; }
| trait_method_reference T_AS member_modifier T_STRING ';' | trait_method_reference T_AS member_modifier identifier ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], $3, $4]; } { $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], $3, $4]; }
| trait_method_reference T_AS member_modifier ';' | trait_method_reference T_AS member_modifier ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], $3, null]; } { $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], $3, null]; }
| trait_method_reference T_AS T_STRING ';' | trait_method_reference T_AS T_STRING ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], null, $3]; } { $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], null, $3]; }
| trait_method_reference T_AS reserved_non_modifiers ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], null, $3]; }
; ;
trait_method_reference_fully_qualified: trait_method_reference_fully_qualified:
name T_PAAMAYIM_NEKUDOTAYIM T_STRING { $$ = array($1, $3); } name T_PAAMAYIM_NEKUDOTAYIM identifier { $$ = array($1, $3); }
; ;
trait_method_reference: trait_method_reference:
trait_method_reference_fully_qualified { $$ = $1; } trait_method_reference_fully_qualified { $$ = $1; }
| T_STRING { $$ = array(null, $1); } | identifier { $$ = array(null, $1); }
; ;
method_body: method_body:
@ -480,11 +471,11 @@ method_body:
variable_modifiers: variable_modifiers:
non_empty_member_modifiers { $$ = $1; } non_empty_member_modifiers { $$ = $1; }
| T_VAR { $$ = Stmt\Class_::MODIFIER_PUBLIC; } | T_VAR { $$ = 0; }
; ;
method_modifiers: method_modifiers:
/* empty */ { $$ = Stmt\Class_::MODIFIER_PUBLIC; } /* empty */ { $$ = 0; }
| non_empty_member_modifiers { $$ = $1; } | non_empty_member_modifiers { $$ = $1; }
; ;
@ -571,6 +562,7 @@ expr:
| expr T_IS_NOT_IDENTICAL expr { $$ = Expr\BinaryOp\NotIdentical [$1, $3]; } | expr T_IS_NOT_IDENTICAL expr { $$ = Expr\BinaryOp\NotIdentical [$1, $3]; }
| expr T_IS_EQUAL expr { $$ = Expr\BinaryOp\Equal [$1, $3]; } | expr T_IS_EQUAL expr { $$ = Expr\BinaryOp\Equal [$1, $3]; }
| expr T_IS_NOT_EQUAL expr { $$ = Expr\BinaryOp\NotEqual [$1, $3]; } | expr T_IS_NOT_EQUAL expr { $$ = Expr\BinaryOp\NotEqual [$1, $3]; }
| expr T_SPACESHIP expr { $$ = Expr\BinaryOp\Spaceship [$1, $3]; }
| expr '<' expr { $$ = Expr\BinaryOp\Smaller [$1, $3]; } | expr '<' expr { $$ = Expr\BinaryOp\Smaller [$1, $3]; }
| expr T_IS_SMALLER_OR_EQUAL expr { $$ = Expr\BinaryOp\SmallerOrEqual[$1, $3]; } | expr T_IS_SMALLER_OR_EQUAL expr { $$ = Expr\BinaryOp\SmallerOrEqual[$1, $3]; }
| expr '>' expr { $$ = Expr\BinaryOp\Greater [$1, $3]; } | expr '>' expr { $$ = Expr\BinaryOp\Greater [$1, $3]; }
@ -581,6 +573,7 @@ expr:
| '(' new_expr ')' { $$ = $2; } | '(' new_expr ')' { $$ = $2; }
| expr '?' expr ':' expr { $$ = Expr\Ternary[$1, $3, $5]; } | expr '?' expr ':' expr { $$ = Expr\Ternary[$1, $3, $5]; }
| expr '?' ':' expr { $$ = Expr\Ternary[$1, null, $4]; } | expr '?' ':' expr { $$ = Expr\Ternary[$1, null, $4]; }
| expr T_COALESCE expr { $$ = Expr\BinaryOp\Coalesce[$1, $3]; }
| T_ISSET '(' variables_list ')' { $$ = Expr\Isset_[$3]; } | T_ISSET '(' variables_list ')' { $$ = Expr\Isset_[$3]; }
| T_EMPTY '(' expr ')' { $$ = Expr\Empty_[$3]; } | T_EMPTY '(' expr ')' { $$ = Expr\Empty_[$3]; }
| T_INCLUDE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_INCLUDE]; } | T_INCLUDE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_INCLUDE]; }
@ -588,14 +581,17 @@ expr:
| T_EVAL parentheses_expr { $$ = Expr\Eval_[$2]; } | T_EVAL parentheses_expr { $$ = Expr\Eval_[$2]; }
| T_REQUIRE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE]; } | T_REQUIRE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE]; }
| T_REQUIRE_ONCE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE_ONCE]; } | T_REQUIRE_ONCE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE_ONCE]; }
| T_INT_CAST expr { $$ = Expr\Cast\Int [$2]; } | T_INT_CAST expr { $$ = Expr\Cast\Int_ [$2]; }
| T_DOUBLE_CAST expr { $$ = Expr\Cast\Double [$2]; } | T_DOUBLE_CAST expr { $$ = Expr\Cast\Double [$2]; }
| T_STRING_CAST expr { $$ = Expr\Cast\String [$2]; } | T_STRING_CAST expr { $$ = Expr\Cast\String_ [$2]; }
| T_ARRAY_CAST expr { $$ = Expr\Cast\Array_ [$2]; } | T_ARRAY_CAST expr { $$ = Expr\Cast\Array_ [$2]; }
| T_OBJECT_CAST expr { $$ = Expr\Cast\Object [$2]; } | T_OBJECT_CAST expr { $$ = Expr\Cast\Object_ [$2]; }
| T_BOOL_CAST expr { $$ = Expr\Cast\Bool [$2]; } | T_BOOL_CAST expr { $$ = Expr\Cast\Bool_ [$2]; }
| T_UNSET_CAST expr { $$ = Expr\Cast\Unset_ [$2]; } | T_UNSET_CAST expr { $$ = Expr\Cast\Unset_ [$2]; }
| T_EXIT exit_expr { $$ = Expr\Exit_ [$2]; } | T_EXIT exit_expr
{ $attrs = attributes();
$attrs['kind'] = strtolower($1) === 'exit' ? Expr\Exit_::KIND_EXIT : Expr\Exit_::KIND_DIE;
$$ = new Expr\Exit_($2, $attrs); }
| '@' expr { $$ = Expr\ErrorSuppress[$2]; } | '@' expr { $$ = Expr\ErrorSuppress[$2]; }
| scalar { $$ = $1; } | scalar { $$ = $1; }
| array_expr { $$ = $1; } | array_expr { $$ = $1; }
@ -603,10 +599,13 @@ expr:
| '`' 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]; }
| T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars '{' inner_statement_list '}' | T_YIELD_FROM expr { $$ = Expr\YieldFrom[$2]; }
{ $$ = Expr\Closure[[static: false, byRef: $2, params: $4, uses: $6, stmts: $8]]; } | T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars optional_return_type
| T_STATIC T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars '{' inner_statement_list '}' '{' inner_statement_list '}'
{ $$ = Expr\Closure[[static: true, byRef: $3, params: $5, uses: $7, stmts: $9]]; } { $$ = Expr\Closure[['static' => false, 'byRef' => $2, 'params' => $4, 'uses' => $6, 'returnType' => $7, 'stmts' => $9]]; }
| T_STATIC T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars optional_return_type
'{' inner_statement_list '}'
{ $$ = Expr\Closure[['static' => true, 'byRef' => $3, 'params' => $5, 'uses' => $7, 'returnType' => $8, 'stmts' => $10]]; }
; ;
parentheses_expr: parentheses_expr:
@ -620,21 +619,32 @@ yield_expr:
; ;
array_expr: array_expr:
T_ARRAY '(' array_pair_list ')' { $$ = Expr\Array_[$3]; } T_ARRAY '(' array_pair_list ')'
| '[' array_pair_list ']' { $$ = Expr\Array_[$2]; } { $attrs = attributes(); $attrs['kind'] = Expr\Array_::KIND_LONG;
$$ = new Expr\Array_($3, $attrs); }
| '[' array_pair_list ']'
{ $attrs = attributes(); $attrs['kind'] = Expr\Array_::KIND_SHORT;
$$ = new Expr\Array_($2, $attrs); }
; ;
scalar_dereference: scalar_dereference:
array_expr '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } array_expr '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| T_CONSTANT_ENCAPSED_STRING '[' dim_offset ']' | T_CONSTANT_ENCAPSED_STRING '[' dim_offset ']'
{ $$ = Expr\ArrayDimFetch[Scalar\String[Scalar\String::parse($1)], $3]; } { $attrs = attributes(); $attrs['kind'] = strKind($1);
$$ = Expr\ArrayDimFetch[new Scalar\String_(Scalar\String_::parse($1), $attrs), $3]; }
| constant '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } | constant '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| scalar_dereference '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; } | scalar_dereference '[' dim_offset ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
/* alternative array syntax missing intentionally */ /* alternative array syntax missing intentionally */
; ;
anonymous_class:
T_CLASS ctor_arguments extends_from implements_list '{' class_statement_list '}'
{ $$ = array(Stmt\Class_[null, ['type' => 0, 'extends' => $3, 'implements' => $4, 'stmts' => $6]], $2); }
new_expr: new_expr:
T_NEW class_name_reference ctor_arguments { $$ = Expr\New_[$2, $3]; } T_NEW class_name_reference ctor_arguments { $$ = Expr\New_[$2, $3]; }
| T_NEW anonymous_class
{ list($class, $ctorArgs) = $2; $$ = Expr\New_[$class, $ctorArgs]; }
; ;
lexical_vars: lexical_vars:
@ -653,7 +663,7 @@ lexical_var:
function_call: function_call:
name argument_list { $$ = Expr\FuncCall[$1, $2]; } name argument_list { $$ = Expr\FuncCall[$1, $2]; }
| class_name_or_var T_PAAMAYIM_NEKUDOTAYIM T_STRING argument_list | class_name_or_var T_PAAMAYIM_NEKUDOTAYIM identifier argument_list
{ $$ = Expr\StaticCall[$1, $3, $4]; } { $$ = Expr\StaticCall[$1, $3, $4]; }
| class_name_or_var T_PAAMAYIM_NEKUDOTAYIM '{' expr '}' argument_list | class_name_or_var T_PAAMAYIM_NEKUDOTAYIM '{' expr '}' argument_list
{ $$ = Expr\StaticCall[$1, $4, $6]; } { $$ = Expr\StaticCall[$1, $4, $6]; }
@ -721,8 +731,9 @@ exit_expr:
backticks_expr: backticks_expr:
/* empty */ { $$ = array(); } /* empty */ { $$ = array(); }
| T_ENCAPSED_AND_WHITESPACE { $$ = array(Scalar\String::parseEscapeSequences($1, '`')); } | T_ENCAPSED_AND_WHITESPACE
| encaps_list { parseEncapsed($1, '`'); $$ = $1; } { $$ = array(Scalar\EncapsedStringPart[Scalar\String_::parseEscapeSequences($1, '`', false)]); }
| encaps_list { parseEncapsed($1, '`', false); $$ = $1; }
; ;
ctor_arguments: ctor_arguments:
@ -731,9 +742,11 @@ ctor_arguments:
; ;
common_scalar: common_scalar:
T_LNUMBER { $$ = Scalar\LNumber[Scalar\LNumber::parse($1)]; } T_LNUMBER { $$ = Scalar\LNumber::fromString($1, attributes(), true); }
| T_DNUMBER { $$ = Scalar\DNumber[Scalar\DNumber::parse($1)]; } | T_DNUMBER { $$ = Scalar\DNumber[Scalar\DNumber::parse($1)]; }
| T_CONSTANT_ENCAPSED_STRING { $$ = Scalar\String[Scalar\String::parse($1)]; } | T_CONSTANT_ENCAPSED_STRING
{ $attrs = attributes(); $attrs['kind'] = strKind($1);
$$ = new Scalar\String_(Scalar\String_::parse($1, false), $attrs); }
| T_LINE { $$ = Scalar\MagicConst\Line[]; } | T_LINE { $$ = Scalar\MagicConst\Line[]; }
| T_FILE { $$ = Scalar\MagicConst\File[]; } | T_FILE { $$ = Scalar\MagicConst\File[]; }
| T_DIR { $$ = Scalar\MagicConst\Dir[]; } | T_DIR { $$ = Scalar\MagicConst\Dir[]; }
@ -743,14 +756,16 @@ common_scalar:
| T_FUNC_C { $$ = Scalar\MagicConst\Function_[]; } | T_FUNC_C { $$ = Scalar\MagicConst\Function_[]; }
| T_NS_C { $$ = Scalar\MagicConst\Namespace_[]; } | T_NS_C { $$ = Scalar\MagicConst\Namespace_[]; }
| T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE T_END_HEREDOC | T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE T_END_HEREDOC
{ $$ = Scalar\String[Scalar\String::parseDocString($1, $2)]; } { $attrs = attributes(); setDocStringAttrs($attrs, $1);
$$ = new Scalar\String_(Scalar\String_::parseDocString($1, $2, false), $attrs); }
| T_START_HEREDOC T_END_HEREDOC | T_START_HEREDOC T_END_HEREDOC
{ $$ = Scalar\String['']; } { $attrs = attributes(); setDocStringAttrs($attrs, $1);
$$ = new Scalar\String_('', $attrs); }
; ;
static_scalar: static_scalar:
common_scalar { $$ = $1; } common_scalar { $$ = $1; }
| class_name T_PAAMAYIM_NEKUDOTAYIM class_const_name { $$ = Expr\ClassConstFetch[$1, $3]; } | class_name T_PAAMAYIM_NEKUDOTAYIM identifier { $$ = Expr\ClassConstFetch[$1, $3]; }
| name { $$ = Expr\ConstFetch[$1]; } | name { $$ = Expr\ConstFetch[$1]; }
| T_ARRAY '(' static_array_pair_list ')' { $$ = Expr\Array_[$3]; } | T_ARRAY '(' static_array_pair_list ')' { $$ = Expr\Array_[$3]; }
| '[' static_array_pair_list ']' { $$ = Expr\Array_[$2]; } | '[' static_array_pair_list ']' { $$ = Expr\Array_[$2]; }
@ -795,7 +810,7 @@ static_operation:
constant: constant:
name { $$ = Expr\ConstFetch[$1]; } name { $$ = Expr\ConstFetch[$1]; }
| class_name_or_var T_PAAMAYIM_NEKUDOTAYIM class_const_name | class_name_or_var T_PAAMAYIM_NEKUDOTAYIM identifier
{ $$ = Expr\ClassConstFetch[$1, $3]; } { $$ = Expr\ClassConstFetch[$1, $3]; }
; ;
@ -803,14 +818,11 @@ scalar:
common_scalar { $$ = $1; } common_scalar { $$ = $1; }
| constant { $$ = $1; } | constant { $$ = $1; }
| '"' encaps_list '"' | '"' encaps_list '"'
{ parseEncapsed($2, '"'); $$ = Scalar\Encapsed[$2]; } { $attrs = attributes(); $attrs['kind'] = Scalar\String_::KIND_DOUBLE_QUOTED;
parseEncapsed($2, '"', true); $$ = new Scalar\Encapsed($2, $attrs); }
| T_START_HEREDOC encaps_list T_END_HEREDOC | T_START_HEREDOC encaps_list T_END_HEREDOC
{ parseEncapsedDoc($2); $$ = Scalar\Encapsed[$2]; } { $attrs = attributes(); setDocStringAttrs($attrs, $1);
; parseEncapsedDoc($2, true); $$ = new Scalar\Encapsed($2, $attrs); }
class_const_name:
T_STRING { $$ = $1; }
| T_CLASS { $$ = 'class'; }
; ;
static_array_pair_list: static_array_pair_list:
@ -938,9 +950,13 @@ array_pair:
encaps_list: encaps_list:
encaps_list encaps_var { push($1, $2); } encaps_list encaps_var { push($1, $2); }
| encaps_list T_ENCAPSED_AND_WHITESPACE { push($1, $2); } | encaps_list encaps_string_part { push($1, $2); }
| encaps_var { init($1); } | encaps_var { init($1); }
| T_ENCAPSED_AND_WHITESPACE encaps_var { init($1, $2); } | encaps_string_part encaps_var { init($1, $2); }
;
encaps_string_part:
T_ENCAPSED_AND_WHITESPACE { $$ = Scalar\EncapsedStringPart[$1]; }
; ;
encaps_var: encaps_var:
@ -955,8 +971,8 @@ encaps_var:
; ;
encaps_var_offset: encaps_var_offset:
T_STRING { $$ = Scalar\String[$1]; } T_STRING { $$ = Scalar\String_[$1]; }
| T_NUM_STRING { $$ = Scalar\String[$1]; } | T_NUM_STRING { $$ = Scalar\String_[$1]; }
| T_VARIABLE { $$ = Expr\Variable[parseVar($1)]; } | T_VARIABLE { $$ = Expr\Variable[parseVar($1)]; }
; ;

846
grammar/php7.y Normal file
View File

@ -0,0 +1,846 @@
%pure_parser
%expect 2
%tokens
%%
start:
top_statement_list { $$ = $this->handleNamespaces($1); }
;
top_statement_list_ex:
top_statement_list_ex top_statement { pushNormalizing($1, $2); }
| /* empty */ { init(); }
;
top_statement_list:
top_statement_list_ex
{ makeNop($nop, $this->lookaheadStartAttributes);
if ($nop !== null) { $1[] = $nop; } $$ = $1; }
;
reserved_non_modifiers:
T_INCLUDE | T_INCLUDE_ONCE | T_EVAL | T_REQUIRE | T_REQUIRE_ONCE | T_LOGICAL_OR | T_LOGICAL_XOR | T_LOGICAL_AND
| T_INSTANCEOF | T_NEW | T_CLONE | T_EXIT | T_IF | T_ELSEIF | T_ELSE | T_ENDIF | T_ECHO | T_DO | T_WHILE
| T_ENDWHILE | T_FOR | T_ENDFOR | T_FOREACH | T_ENDFOREACH | T_DECLARE | T_ENDDECLARE | T_AS | T_TRY | T_CATCH
| T_FINALLY | T_THROW | T_USE | T_INSTEADOF | T_GLOBAL | T_VAR | T_UNSET | T_ISSET | T_EMPTY | T_CONTINUE | T_GOTO
| T_FUNCTION | T_CONST | T_RETURN | T_PRINT | T_YIELD | T_LIST | T_SWITCH | T_ENDSWITCH | T_CASE | T_DEFAULT
| T_BREAK | T_ARRAY | T_CALLABLE | T_EXTENDS | T_IMPLEMENTS | T_NAMESPACE | T_TRAIT | T_INTERFACE | T_CLASS
| T_CLASS_C | T_TRAIT_C | T_FUNC_C | T_METHOD_C | T_LINE | T_FILE | T_DIR | T_NS_C | T_HALT_COMPILER
;
semi_reserved:
reserved_non_modifiers
| T_STATIC | T_ABSTRACT | T_FINAL | T_PRIVATE | T_PROTECTED | T_PUBLIC
;
identifier:
T_STRING { $$ = $1; }
| semi_reserved { $$ = $1; }
;
namespace_name_parts:
T_STRING { init($1); }
| namespace_name_parts T_NS_SEPARATOR T_STRING { push($1, $3); }
;
namespace_name:
namespace_name_parts { $$ = Name[$1]; }
;
top_statement:
statement { $$ = $1; }
| function_declaration_statement { $$ = $1; }
| class_declaration_statement { $$ = $1; }
| T_HALT_COMPILER
{ $$ = Stmt\HaltCompiler[$this->lexer->handleHaltCompiler()]; }
| T_NAMESPACE namespace_name ';' { $$ = Stmt\Namespace_[$2, null]; }
| T_NAMESPACE namespace_name '{' top_statement_list '}' { $$ = Stmt\Namespace_[$2, $4]; }
| T_NAMESPACE '{' top_statement_list '}' { $$ = Stmt\Namespace_[null, $3]; }
| T_USE use_declarations ';' { $$ = Stmt\Use_[$2, Stmt\Use_::TYPE_NORMAL]; }
| T_USE use_type use_declarations ';' { $$ = Stmt\Use_[$3, $2]; }
| group_use_declaration ';' { $$ = $1; }
| T_CONST constant_declaration_list ';' { $$ = Stmt\Const_[$2]; }
;
use_type:
T_FUNCTION { $$ = Stmt\Use_::TYPE_FUNCTION; }
| T_CONST { $$ = Stmt\Use_::TYPE_CONSTANT; }
;
/* Using namespace_name_parts here to avoid s/r conflict on T_NS_SEPARATOR */
group_use_declaration:
T_USE use_type namespace_name_parts T_NS_SEPARATOR '{' unprefixed_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$3], $6, $2]; }
| T_USE use_type T_NS_SEPARATOR namespace_name_parts T_NS_SEPARATOR '{' unprefixed_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$4], $7, $2]; }
| T_USE namespace_name_parts T_NS_SEPARATOR '{' inline_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$2], $5, Stmt\Use_::TYPE_UNKNOWN]; }
| T_USE T_NS_SEPARATOR namespace_name_parts T_NS_SEPARATOR '{' inline_use_declarations '}'
{ $$ = Stmt\GroupUse[Name[$3], $6, Stmt\Use_::TYPE_UNKNOWN]; }
;
unprefixed_use_declarations:
unprefixed_use_declarations ',' unprefixed_use_declaration
{ push($1, $3); }
| unprefixed_use_declaration { init($1); }
;
use_declarations:
use_declarations ',' use_declaration { push($1, $3); }
| use_declaration { init($1); }
;
inline_use_declarations:
inline_use_declarations ',' inline_use_declaration { push($1, $3); }
| inline_use_declaration { init($1); }
;
unprefixed_use_declaration:
namespace_name { $$ = Stmt\UseUse[$1, null, Stmt\Use_::TYPE_UNKNOWN]; }
| namespace_name T_AS T_STRING { $$ = Stmt\UseUse[$1, $3, Stmt\Use_::TYPE_UNKNOWN]; }
;
use_declaration:
unprefixed_use_declaration { $$ = $1; }
| T_NS_SEPARATOR unprefixed_use_declaration { $$ = $2; }
;
inline_use_declaration:
unprefixed_use_declaration { $$ = $1; $$->type = Stmt\Use_::TYPE_NORMAL; }
| use_type unprefixed_use_declaration { $$ = $2; $$->type = $1; }
;
constant_declaration_list:
constant_declaration_list ',' constant_declaration { push($1, $3); }
| constant_declaration { init($1); }
;
constant_declaration:
T_STRING '=' expr { $$ = Node\Const_[$1, $3]; }
;
class_const_list:
class_const_list ',' class_const { push($1, $3); }
| class_const { init($1); }
;
class_const:
identifier '=' expr { $$ = Node\Const_[$1, $3]; }
;
inner_statement_list_ex:
inner_statement_list_ex inner_statement { pushNormalizing($1, $2); }
| /* empty */ { init(); }
;
inner_statement_list:
inner_statement_list_ex
{ makeNop($nop, $this->lookaheadStartAttributes);
if ($nop !== null) { $1[] = $nop; } $$ = $1; }
;
inner_statement:
statement { $$ = $1; }
| function_declaration_statement { $$ = $1; }
| class_declaration_statement { $$ = $1; }
| T_HALT_COMPILER
{ throw new Error('__HALT_COMPILER() can only be used from the outermost scope', attributes()); }
;
non_empty_statement:
'{' inner_statement_list '}' { $$ = $2; }
| 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 ';'
{ $$ = Stmt\If_[$3, ['stmts' => $6, 'elseifs' => $7, 'else' => $8]]; }
| T_WHILE '(' expr ')' while_statement { $$ = Stmt\While_[$3, $5]; }
| T_DO statement T_WHILE '(' expr ')' ';' { $$ = Stmt\Do_ [$5, toArray($2)]; }
| T_FOR '(' for_expr ';' for_expr ';' for_expr ')' for_statement
{ $$ = Stmt\For_[['init' => $3, 'cond' => $5, 'loop' => $7, 'stmts' => $9]]; }
| T_SWITCH '(' expr ')' switch_case_list { $$ = Stmt\Switch_[$3, $5]; }
| T_BREAK optional_expr ';' { $$ = Stmt\Break_[$2]; }
| T_CONTINUE optional_expr ';' { $$ = Stmt\Continue_[$2]; }
| T_RETURN optional_expr ';' { $$ = Stmt\Return_[$2]; }
| T_GLOBAL global_var_list ';' { $$ = Stmt\Global_[$2]; }
| T_STATIC static_var_list ';' { $$ = Stmt\Static_[$2]; }
| T_ECHO expr_list ';' { $$ = Stmt\Echo_[$2]; }
| T_INLINE_HTML { $$ = Stmt\InlineHTML[$1]; }
| expr ';' { $$ = $1; }
| T_UNSET '(' variables_list ')' ';' { $$ = Stmt\Unset_[$3]; }
| T_FOREACH '(' expr T_AS foreach_variable ')' foreach_statement
{ $$ = Stmt\Foreach_[$3, $5[0], ['keyVar' => null, 'byRef' => $5[1], 'stmts' => $7]]; }
| T_FOREACH '(' expr T_AS variable T_DOUBLE_ARROW foreach_variable ')' foreach_statement
{ $$ = Stmt\Foreach_[$3, $7[0], ['keyVar' => $5, 'byRef' => $7[1], 'stmts' => $9]]; }
| T_DECLARE '(' declare_list ')' declare_statement { $$ = Stmt\Declare_[$3, $5]; }
| T_TRY '{' inner_statement_list '}' catches optional_finally
{ $$ = Stmt\TryCatch[$3, $5, $6]; }
| T_THROW expr ';' { $$ = Stmt\Throw_[$2]; }
| T_GOTO T_STRING ';' { $$ = Stmt\Goto_[$2]; }
| T_STRING ':' { $$ = Stmt\Label[$1]; }
| error { $$ = array(); /* means: no statement */ }
;
statement:
non_empty_statement { $$ = $1; }
| ';'
{ makeNop($$, $this->startAttributeStack[#1]);
if ($$ === null) $$ = array(); /* means: no statement */ }
;
catches:
/* empty */ { init(); }
| catches catch { push($1, $2); }
;
catch:
T_CATCH '(' name T_VARIABLE ')' '{' inner_statement_list '}'
{ $$ = Stmt\Catch_[$3, parseVar($4), $7]; }
;
optional_finally:
/* empty */ { $$ = null; }
| T_FINALLY '{' inner_statement_list '}' { $$ = $3; }
;
variables_list:
variable { init($1); }
| variables_list ',' variable { push($1, $3); }
;
optional_ref:
/* empty */ { $$ = false; }
| '&' { $$ = true; }
;
optional_ellipsis:
/* empty */ { $$ = false; }
| T_ELLIPSIS { $$ = true; }
;
function_declaration_statement:
T_FUNCTION optional_ref T_STRING '(' parameter_list ')' optional_return_type '{' inner_statement_list '}'
{ $$ = Stmt\Function_[$3, ['byRef' => $2, 'params' => $5, 'returnType' => $7, 'stmts' => $9]]; }
;
class_declaration_statement:
class_entry_type T_STRING extends_from implements_list '{' class_statement_list '}'
{ $$ = Stmt\Class_[$2, ['type' => $1, 'extends' => $3, 'implements' => $4, 'stmts' => $6]]; }
| T_INTERFACE T_STRING interface_extends_list '{' class_statement_list '}'
{ $$ = Stmt\Interface_[$2, ['extends' => $3, 'stmts' => $5]]; }
| T_TRAIT T_STRING '{' class_statement_list '}'
{ $$ = Stmt\Trait_[$2, $4]; }
;
class_entry_type:
T_CLASS { $$ = 0; }
| T_ABSTRACT T_CLASS { $$ = Stmt\Class_::MODIFIER_ABSTRACT; }
| T_FINAL T_CLASS { $$ = Stmt\Class_::MODIFIER_FINAL; }
;
extends_from:
/* empty */ { $$ = null; }
| T_EXTENDS name { $$ = $2; }
;
interface_extends_list:
/* empty */ { $$ = array(); }
| T_EXTENDS name_list { $$ = $2; }
;
implements_list:
/* empty */ { $$ = array(); }
| T_IMPLEMENTS name_list { $$ = $2; }
;
name_list:
name { init($1); }
| name_list ',' name { push($1, $3); }
;
for_statement:
statement { $$ = toArray($1); }
| ':' inner_statement_list T_ENDFOR ';' { $$ = $2; }
;
foreach_statement:
statement { $$ = toArray($1); }
| ':' inner_statement_list T_ENDFOREACH ';' { $$ = $2; }
;
declare_statement:
non_empty_statement { $$ = toArray($1); }
| ';' { $$ = null; }
| ':' inner_statement_list T_ENDDECLARE ';' { $$ = $2; }
;
declare_list:
declare_list_element { init($1); }
| declare_list ',' declare_list_element { push($1, $3); }
;
declare_list_element:
T_STRING '=' expr { $$ = Stmt\DeclareDeclare[$1, $3]; }
;
switch_case_list:
'{' case_list '}' { $$ = $2; }
| '{' ';' case_list '}' { $$ = $3; }
| ':' case_list T_ENDSWITCH ';' { $$ = $2; }
| ':' ';' case_list T_ENDSWITCH ';' { $$ = $3; }
;
case_list:
/* empty */ { init(); }
| case_list case { push($1, $2); }
;
case:
T_CASE expr case_separator inner_statement_list { $$ = Stmt\Case_[$2, $4]; }
| T_DEFAULT case_separator inner_statement_list { $$ = Stmt\Case_[null, $3]; }
;
case_separator:
':'
| ';'
;
while_statement:
statement { $$ = toArray($1); }
| ':' inner_statement_list T_ENDWHILE ';' { $$ = $2; }
;
elseif_list:
/* empty */ { init(); }
| elseif_list elseif { push($1, $2); }
;
elseif:
T_ELSEIF '(' expr ')' statement { $$ = Stmt\ElseIf_[$3, toArray($5)]; }
;
new_elseif_list:
/* empty */ { init(); }
| new_elseif_list new_elseif { push($1, $2); }
;
new_elseif:
T_ELSEIF '(' expr ')' ':' inner_statement_list { $$ = Stmt\ElseIf_[$3, $6]; }
;
else_single:
/* empty */ { $$ = null; }
| T_ELSE statement { $$ = Stmt\Else_[toArray($2)]; }
;
new_else_single:
/* empty */ { $$ = null; }
| T_ELSE ':' inner_statement_list { $$ = Stmt\Else_[$3]; }
;
foreach_variable:
variable { $$ = array($1, false); }
| '&' variable { $$ = array($2, true); }
| list_expr { $$ = array($1, false); }
;
parameter_list:
non_empty_parameter_list { $$ = $1; }
| /* empty */ { $$ = array(); }
;
non_empty_parameter_list:
parameter { init($1); }
| non_empty_parameter_list ',' parameter { push($1, $3); }
;
parameter:
optional_param_type optional_ref optional_ellipsis T_VARIABLE
{ $$ = Node\Param[parseVar($4), null, $1, $2, $3]; }
| optional_param_type optional_ref optional_ellipsis T_VARIABLE '=' expr
{ $$ = Node\Param[parseVar($4), $6, $1, $2, $3]; }
;
type:
name { $$ = $this->handleScalarTypes($1); }
| T_ARRAY { $$ = 'array'; }
| T_CALLABLE { $$ = 'callable'; }
;
optional_param_type:
/* empty */ { $$ = null; }
| type { $$ = $1; }
;
optional_return_type:
/* empty */ { $$ = null; }
| ':' type { $$ = $2; }
;
argument_list:
'(' ')' { $$ = array(); }
| '(' non_empty_argument_list ')' { $$ = $2; }
;
non_empty_argument_list:
argument { init($1); }
| non_empty_argument_list ',' argument { push($1, $3); }
;
argument:
expr { $$ = Node\Arg[$1, false, false]; }
| '&' variable { $$ = Node\Arg[$2, true, false]; }
| T_ELLIPSIS expr { $$ = Node\Arg[$2, false, true]; }
;
global_var_list:
global_var_list ',' global_var { push($1, $3); }
| global_var { init($1); }
;
global_var:
simple_variable { $$ = Expr\Variable[$1]; }
;
static_var_list:
static_var_list ',' static_var { push($1, $3); }
| static_var { init($1); }
;
static_var:
T_VARIABLE { $$ = Stmt\StaticVar[parseVar($1), null]; }
| T_VARIABLE '=' expr { $$ = Stmt\StaticVar[parseVar($1), $3]; }
;
class_statement_list:
class_statement_list class_statement { push($1, $2); }
| /* empty */ { init(); }
;
class_statement:
variable_modifiers property_declaration_list ';' { $$ = Stmt\Property[$1, $2]; }
| T_CONST class_const_list ';' { $$ = Stmt\ClassConst[$2]; }
| method_modifiers T_FUNCTION optional_ref identifier '(' parameter_list ')' optional_return_type method_body
{ $$ = Stmt\ClassMethod[$4, ['type' => $1, 'byRef' => $3, 'params' => $6, 'returnType' => $8, 'stmts' => $9]]; }
| T_USE name_list trait_adaptations { $$ = Stmt\TraitUse[$2, $3]; }
;
trait_adaptations:
';' { $$ = array(); }
| '{' trait_adaptation_list '}' { $$ = $2; }
;
trait_adaptation_list:
/* empty */ { init(); }
| trait_adaptation_list trait_adaptation { push($1, $2); }
;
trait_adaptation:
trait_method_reference_fully_qualified T_INSTEADOF name_list ';'
{ $$ = Stmt\TraitUseAdaptation\Precedence[$1[0], $1[1], $3]; }
| trait_method_reference T_AS member_modifier identifier ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], $3, $4]; }
| trait_method_reference T_AS member_modifier ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], $3, null]; }
| trait_method_reference T_AS T_STRING ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], null, $3]; }
| trait_method_reference T_AS reserved_non_modifiers ';'
{ $$ = Stmt\TraitUseAdaptation\Alias[$1[0], $1[1], null, $3]; }
;
trait_method_reference_fully_qualified:
name T_PAAMAYIM_NEKUDOTAYIM identifier { $$ = array($1, $3); }
;
trait_method_reference:
trait_method_reference_fully_qualified { $$ = $1; }
| identifier { $$ = array(null, $1); }
;
method_body:
';' /* abstract method */ { $$ = null; }
| '{' inner_statement_list '}' { $$ = $2; }
;
variable_modifiers:
non_empty_member_modifiers { $$ = $1; }
| T_VAR { $$ = 0; }
;
method_modifiers:
/* empty */ { $$ = 0; }
| non_empty_member_modifiers { $$ = $1; }
;
non_empty_member_modifiers:
member_modifier { $$ = $1; }
| non_empty_member_modifiers member_modifier { Stmt\Class_::verifyModifier($1, $2); $$ = $1 | $2; }
;
member_modifier:
T_PUBLIC { $$ = Stmt\Class_::MODIFIER_PUBLIC; }
| T_PROTECTED { $$ = Stmt\Class_::MODIFIER_PROTECTED; }
| T_PRIVATE { $$ = Stmt\Class_::MODIFIER_PRIVATE; }
| T_STATIC { $$ = Stmt\Class_::MODIFIER_STATIC; }
| T_ABSTRACT { $$ = Stmt\Class_::MODIFIER_ABSTRACT; }
| T_FINAL { $$ = Stmt\Class_::MODIFIER_FINAL; }
;
property_declaration_list:
property_declaration { init($1); }
| property_declaration_list ',' property_declaration { push($1, $3); }
;
property_declaration:
T_VARIABLE { $$ = Stmt\PropertyProperty[parseVar($1), null]; }
| T_VARIABLE '=' expr { $$ = Stmt\PropertyProperty[parseVar($1), $3]; }
;
expr_list:
expr_list ',' expr { push($1, $3); }
| expr { init($1); }
;
for_expr:
/* empty */ { $$ = array(); }
| expr_list { $$ = $1; }
;
expr:
variable { $$ = $1; }
| list_expr '=' expr { $$ = Expr\Assign[$1, $3]; }
| variable '=' expr { $$ = Expr\Assign[$1, $3]; }
| variable '=' '&' variable { $$ = Expr\AssignRef[$1, $4]; }
| variable '=' '&' new_expr { $$ = Expr\AssignRef[$1, $4]; }
| new_expr { $$ = $1; }
| T_CLONE expr { $$ = Expr\Clone_[$2]; }
| variable T_PLUS_EQUAL expr { $$ = Expr\AssignOp\Plus [$1, $3]; }
| variable T_MINUS_EQUAL expr { $$ = Expr\AssignOp\Minus [$1, $3]; }
| variable T_MUL_EQUAL expr { $$ = Expr\AssignOp\Mul [$1, $3]; }
| variable T_DIV_EQUAL expr { $$ = Expr\AssignOp\Div [$1, $3]; }
| variable T_CONCAT_EQUAL expr { $$ = Expr\AssignOp\Concat [$1, $3]; }
| variable T_MOD_EQUAL expr { $$ = Expr\AssignOp\Mod [$1, $3]; }
| variable T_AND_EQUAL expr { $$ = Expr\AssignOp\BitwiseAnd[$1, $3]; }
| variable T_OR_EQUAL expr { $$ = Expr\AssignOp\BitwiseOr [$1, $3]; }
| variable T_XOR_EQUAL expr { $$ = Expr\AssignOp\BitwiseXor[$1, $3]; }
| variable T_SL_EQUAL expr { $$ = Expr\AssignOp\ShiftLeft [$1, $3]; }
| variable T_SR_EQUAL expr { $$ = Expr\AssignOp\ShiftRight[$1, $3]; }
| variable T_POW_EQUAL expr { $$ = Expr\AssignOp\Pow [$1, $3]; }
| variable T_INC { $$ = Expr\PostInc[$1]; }
| T_INC variable { $$ = Expr\PreInc [$2]; }
| variable T_DEC { $$ = Expr\PostDec[$1]; }
| T_DEC variable { $$ = Expr\PreDec [$2]; }
| expr T_BOOLEAN_OR expr { $$ = Expr\BinaryOp\BooleanOr [$1, $3]; }
| expr T_BOOLEAN_AND expr { $$ = Expr\BinaryOp\BooleanAnd[$1, $3]; }
| expr T_LOGICAL_OR expr { $$ = Expr\BinaryOp\LogicalOr [$1, $3]; }
| expr T_LOGICAL_AND expr { $$ = Expr\BinaryOp\LogicalAnd[$1, $3]; }
| expr T_LOGICAL_XOR expr { $$ = Expr\BinaryOp\LogicalXor[$1, $3]; }
| expr '|' expr { $$ = Expr\BinaryOp\BitwiseOr [$1, $3]; }
| expr '&' expr { $$ = Expr\BinaryOp\BitwiseAnd[$1, $3]; }
| expr '^' expr { $$ = Expr\BinaryOp\BitwiseXor[$1, $3]; }
| expr '.' expr { $$ = Expr\BinaryOp\Concat [$1, $3]; }
| expr '+' expr { $$ = Expr\BinaryOp\Plus [$1, $3]; }
| expr '-' expr { $$ = Expr\BinaryOp\Minus [$1, $3]; }
| expr '*' expr { $$ = Expr\BinaryOp\Mul [$1, $3]; }
| expr '/' expr { $$ = Expr\BinaryOp\Div [$1, $3]; }
| expr '%' expr { $$ = Expr\BinaryOp\Mod [$1, $3]; }
| expr T_SL expr { $$ = Expr\BinaryOp\ShiftLeft [$1, $3]; }
| expr T_SR expr { $$ = Expr\BinaryOp\ShiftRight[$1, $3]; }
| expr T_POW expr { $$ = Expr\BinaryOp\Pow [$1, $3]; }
| '+' expr %prec T_INC { $$ = Expr\UnaryPlus [$2]; }
| '-' expr %prec T_INC { $$ = Expr\UnaryMinus[$2]; }
| '!' expr { $$ = Expr\BooleanNot[$2]; }
| '~' expr { $$ = Expr\BitwiseNot[$2]; }
| expr T_IS_IDENTICAL expr { $$ = Expr\BinaryOp\Identical [$1, $3]; }
| expr T_IS_NOT_IDENTICAL expr { $$ = Expr\BinaryOp\NotIdentical [$1, $3]; }
| expr T_IS_EQUAL expr { $$ = Expr\BinaryOp\Equal [$1, $3]; }
| expr T_IS_NOT_EQUAL expr { $$ = Expr\BinaryOp\NotEqual [$1, $3]; }
| expr T_SPACESHIP expr { $$ = Expr\BinaryOp\Spaceship [$1, $3]; }
| expr '<' expr { $$ = Expr\BinaryOp\Smaller [$1, $3]; }
| expr T_IS_SMALLER_OR_EQUAL expr { $$ = Expr\BinaryOp\SmallerOrEqual[$1, $3]; }
| expr '>' expr { $$ = Expr\BinaryOp\Greater [$1, $3]; }
| expr T_IS_GREATER_OR_EQUAL expr { $$ = Expr\BinaryOp\GreaterOrEqual[$1, $3]; }
| expr T_INSTANCEOF class_name_reference { $$ = Expr\Instanceof_[$1, $3]; }
| '(' expr ')' { $$ = $2; }
| expr '?' expr ':' expr { $$ = Expr\Ternary[$1, $3, $5]; }
| expr '?' ':' expr { $$ = Expr\Ternary[$1, null, $4]; }
| expr T_COALESCE expr { $$ = Expr\BinaryOp\Coalesce[$1, $3]; }
| T_ISSET '(' variables_list ')' { $$ = Expr\Isset_[$3]; }
| T_EMPTY '(' expr ')' { $$ = Expr\Empty_[$3]; }
| T_INCLUDE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_INCLUDE]; }
| T_INCLUDE_ONCE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_INCLUDE_ONCE]; }
| T_EVAL '(' expr ')' { $$ = Expr\Eval_[$3]; }
| T_REQUIRE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE]; }
| T_REQUIRE_ONCE expr { $$ = Expr\Include_[$2, Expr\Include_::TYPE_REQUIRE_ONCE]; }
| T_INT_CAST expr { $$ = Expr\Cast\Int_ [$2]; }
| T_DOUBLE_CAST expr { $$ = Expr\Cast\Double [$2]; }
| T_STRING_CAST expr { $$ = Expr\Cast\String_ [$2]; }
| T_ARRAY_CAST expr { $$ = Expr\Cast\Array_ [$2]; }
| T_OBJECT_CAST expr { $$ = Expr\Cast\Object_ [$2]; }
| T_BOOL_CAST expr { $$ = Expr\Cast\Bool_ [$2]; }
| T_UNSET_CAST expr { $$ = Expr\Cast\Unset_ [$2]; }
| T_EXIT exit_expr
{ $attrs = attributes();
$attrs['kind'] = strtolower($1) === 'exit' ? Expr\Exit_::KIND_EXIT : Expr\Exit_::KIND_DIE;
$$ = new Expr\Exit_($2, $attrs); }
| '@' expr { $$ = Expr\ErrorSuppress[$2]; }
| scalar { $$ = $1; }
| '`' backticks_expr '`' { $$ = Expr\ShellExec[$2]; }
| T_PRINT expr { $$ = Expr\Print_[$2]; }
| T_YIELD { $$ = Expr\Yield_[null, null]; }
| T_YIELD expr { $$ = Expr\Yield_[$2, null]; }
| T_YIELD expr T_DOUBLE_ARROW expr { $$ = Expr\Yield_[$4, $2]; }
| T_YIELD_FROM expr { $$ = Expr\YieldFrom[$2]; }
| T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars optional_return_type
'{' inner_statement_list '}'
{ $$ = Expr\Closure[['static' => false, 'byRef' => $2, 'params' => $4, 'uses' => $6, 'returnType' => $7, 'stmts' => $9]]; }
| T_STATIC T_FUNCTION optional_ref '(' parameter_list ')' lexical_vars optional_return_type
'{' inner_statement_list '}'
{ $$ = Expr\Closure[['static' => true, 'byRef' => $3, 'params' => $5, 'uses' => $7, 'returnType' => $8, 'stmts' => $10]]; }
;
anonymous_class:
T_CLASS ctor_arguments extends_from implements_list '{' class_statement_list '}'
{ $$ = array(Stmt\Class_[null, ['type' => 0, 'extends' => $3, 'implements' => $4, 'stmts' => $6]], $2); }
new_expr:
T_NEW class_name_reference ctor_arguments { $$ = Expr\New_[$2, $3]; }
| T_NEW anonymous_class
{ list($class, $ctorArgs) = $2; $$ = Expr\New_[$class, $ctorArgs]; }
;
lexical_vars:
/* empty */ { $$ = array(); }
| T_USE '(' lexical_var_list ')' { $$ = $3; }
;
lexical_var_list:
lexical_var { init($1); }
| lexical_var_list ',' lexical_var { push($1, $3); }
;
lexical_var:
optional_ref T_VARIABLE { $$ = Expr\ClosureUse[parseVar($2), $1]; }
;
function_call:
name argument_list { $$ = Expr\FuncCall[$1, $2]; }
| callable_expr argument_list { $$ = Expr\FuncCall[$1, $2]; }
| class_name_or_var T_PAAMAYIM_NEKUDOTAYIM member_name argument_list
{ $$ = Expr\StaticCall[$1, $3, $4]; }
;
class_name:
T_STATIC { $$ = Name[$1]; }
| name { $$ = $1; }
;
name:
namespace_name_parts { $$ = Name[$1]; }
| T_NS_SEPARATOR namespace_name_parts { $$ = Name\FullyQualified[$2]; }
| T_NAMESPACE T_NS_SEPARATOR namespace_name_parts { $$ = Name\Relative[$3]; }
;
class_name_reference:
class_name { $$ = $1; }
| new_variable { $$ = $1; }
;
class_name_or_var:
class_name { $$ = $1; }
| dereferencable { $$ = $1; }
;
exit_expr:
/* empty */ { $$ = null; }
| '(' optional_expr ')' { $$ = $2; }
;
backticks_expr:
/* empty */ { $$ = array(); }
| T_ENCAPSED_AND_WHITESPACE
{ $$ = array(Scalar\EncapsedStringPart[Scalar\String_::parseEscapeSequences($1, '`')]); }
| encaps_list { parseEncapsed($1, '`', true); $$ = $1; }
;
ctor_arguments:
/* empty */ { $$ = array(); }
| argument_list { $$ = $1; }
;
constant:
name { $$ = Expr\ConstFetch[$1]; }
| class_name_or_var T_PAAMAYIM_NEKUDOTAYIM identifier
{ $$ = Expr\ClassConstFetch[$1, $3]; }
;
dereferencable_scalar:
T_ARRAY '(' array_pair_list ')'
{ $attrs = attributes(); $attrs['kind'] = Expr\Array_::KIND_LONG;
$$ = new Expr\Array_($3, $attrs); }
| '[' array_pair_list ']'
{ $attrs = attributes(); $attrs['kind'] = Expr\Array_::KIND_SHORT;
$$ = new Expr\Array_($2, $attrs); }
| T_CONSTANT_ENCAPSED_STRING
{ $attrs = attributes(); $attrs['kind'] = strKind($1);
$$ = new Scalar\String_(Scalar\String_::parse($1), $attrs); }
;
scalar:
T_LNUMBER { $$ = Scalar\LNumber::fromString($1, attributes()); }
| T_DNUMBER { $$ = Scalar\DNumber[Scalar\DNumber::parse($1)]; }
| T_LINE { $$ = Scalar\MagicConst\Line[]; }
| T_FILE { $$ = Scalar\MagicConst\File[]; }
| T_DIR { $$ = Scalar\MagicConst\Dir[]; }
| T_CLASS_C { $$ = Scalar\MagicConst\Class_[]; }
| T_TRAIT_C { $$ = Scalar\MagicConst\Trait_[]; }
| T_METHOD_C { $$ = Scalar\MagicConst\Method[]; }
| T_FUNC_C { $$ = Scalar\MagicConst\Function_[]; }
| T_NS_C { $$ = Scalar\MagicConst\Namespace_[]; }
| dereferencable_scalar { $$ = $1; }
| constant { $$ = $1; }
| T_START_HEREDOC T_ENCAPSED_AND_WHITESPACE T_END_HEREDOC
{ $attrs = attributes(); setDocStringAttrs($attrs, $1);
$$ = new Scalar\String_(Scalar\String_::parseDocString($1, $2), $attrs); }
| T_START_HEREDOC T_END_HEREDOC
{ $attrs = attributes(); setDocStringAttrs($attrs, $1);
$$ = new Scalar\String_('', $attrs); }
| '"' encaps_list '"'
{ $attrs = attributes(); $attrs['kind'] = Scalar\String_::KIND_DOUBLE_QUOTED;
parseEncapsed($2, '"', true); $$ = new Scalar\Encapsed($2, $attrs); }
| T_START_HEREDOC encaps_list T_END_HEREDOC
{ $attrs = attributes(); setDocStringAttrs($attrs, $1);
parseEncapsedDoc($2, true); $$ = new Scalar\Encapsed($2, $attrs); }
;
optional_comma:
/* empty */
| ','
;
optional_expr:
/* empty */ { $$ = null; }
| expr { $$ = $1; }
;
dereferencable:
variable { $$ = $1; }
| '(' expr ')' { $$ = $2; }
| dereferencable_scalar { $$ = $1; }
;
callable_expr:
callable_variable { $$ = $1; }
| '(' expr ')' { $$ = $2; }
| dereferencable_scalar { $$ = $1; }
;
callable_variable:
simple_variable { $$ = Expr\Variable[$1]; }
| dereferencable '[' optional_expr ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| constant '[' optional_expr ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| dereferencable '{' expr '}' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| function_call { $$ = $1; }
| dereferencable T_OBJECT_OPERATOR property_name argument_list
{ $$ = Expr\MethodCall[$1, $3, $4]; }
;
variable:
callable_variable { $$ = $1; }
| static_member { $$ = $1; }
| dereferencable T_OBJECT_OPERATOR property_name { $$ = Expr\PropertyFetch[$1, $3]; }
;
simple_variable:
T_VARIABLE { $$ = parseVar($1); }
| '$' '{' expr '}' { $$ = $3; }
| '$' simple_variable { $$ = Expr\Variable[$2]; }
;
static_member:
class_name_or_var T_PAAMAYIM_NEKUDOTAYIM simple_variable
{ $$ = Expr\StaticPropertyFetch[$1, $3]; }
;
new_variable:
simple_variable { $$ = Expr\Variable[$1]; }
| new_variable '[' optional_expr ']' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| new_variable '{' expr '}' { $$ = Expr\ArrayDimFetch[$1, $3]; }
| new_variable T_OBJECT_OPERATOR property_name { $$ = Expr\PropertyFetch[$1, $3]; }
| class_name T_PAAMAYIM_NEKUDOTAYIM simple_variable { $$ = Expr\StaticPropertyFetch[$1, $3]; }
| new_variable T_PAAMAYIM_NEKUDOTAYIM simple_variable { $$ = Expr\StaticPropertyFetch[$1, $3]; }
;
member_name:
identifier { $$ = $1; }
| '{' expr '}' { $$ = $2; }
| simple_variable { $$ = Expr\Variable[$1]; }
;
property_name:
T_STRING { $$ = $1; }
| '{' expr '}' { $$ = $2; }
| simple_variable { $$ = Expr\Variable[$1]; }
;
list_expr:
T_LIST '(' list_expr_elements ')' { $$ = Expr\List_[$3]; }
;
list_expr_elements:
list_expr_elements ',' list_expr_element { push($1, $3); }
| list_expr_element { init($1); }
;
list_expr_element:
variable { $$ = $1; }
| list_expr { $$ = $1; }
| /* empty */ { $$ = null; }
;
array_pair_list:
/* empty */ { $$ = array(); }
| non_empty_array_pair_list optional_comma { $$ = $1; }
;
non_empty_array_pair_list:
non_empty_array_pair_list ',' array_pair { push($1, $3); }
| array_pair { init($1); }
;
array_pair:
expr T_DOUBLE_ARROW expr { $$ = Expr\ArrayItem[$3, $1, false]; }
| expr { $$ = Expr\ArrayItem[$1, null, false]; }
| expr T_DOUBLE_ARROW '&' variable { $$ = Expr\ArrayItem[$4, $1, true]; }
| '&' variable { $$ = Expr\ArrayItem[$2, null, true]; }
;
encaps_list:
encaps_list encaps_var { push($1, $2); }
| encaps_list encaps_string_part { push($1, $2); }
| encaps_var { init($1); }
| encaps_string_part encaps_var { init($1, $2); }
;
encaps_string_part:
T_ENCAPSED_AND_WHITESPACE { $$ = Scalar\EncapsedStringPart[$1]; }
;
encaps_var:
T_VARIABLE { $$ = Expr\Variable[parseVar($1)]; }
| T_VARIABLE '[' encaps_var_offset ']' { $$ = Expr\ArrayDimFetch[Expr\Variable[parseVar($1)], $3]; }
| T_VARIABLE T_OBJECT_OPERATOR T_STRING { $$ = Expr\PropertyFetch[Expr\Variable[parseVar($1)], $3]; }
| T_DOLLAR_OPEN_CURLY_BRACES expr '}' { $$ = Expr\Variable[$2]; }
| T_DOLLAR_OPEN_CURLY_BRACES T_STRING_VARNAME '}' { $$ = Expr\Variable[$2]; }
| T_DOLLAR_OPEN_CURLY_BRACES T_STRING_VARNAME '[' expr ']' '}'
{ $$ = Expr\ArrayDimFetch[Expr\Variable[$2], $4]; }
| T_CURLY_OPEN variable '}' { $$ = $2; }
;
encaps_var_offset:
T_STRING { $$ = Scalar\String_[$1]; }
| T_NUM_STRING { $$ = Scalar\String_[$1]; }
| T_VARIABLE { $$ = Expr\Variable[parseVar($1)]; }
;
%%

View File

@ -1,218 +0,0 @@
<?php
$grammarFile = __DIR__ . '/zend_language_parser.phpy';
$skeletonFile = __DIR__ . '/kmyacc.php.parser';
$tmpGrammarFile = __DIR__ . '/tmp_parser.phpy';
$tmpResultFile = __DIR__ . '/tmp_parser.php';
$parserResultFile = __DIR__ . '/../lib/PhpParser/Parser.php';
// check for kmyacc.exe binary in this directory, otherwise fall back to global name
$kmyacc = __DIR__ . '/kmyacc.exe';
if (!file_exists($kmyacc)) {
$kmyacc = 'kmyacc';
}
$options = array_flip($argv);
$optionDebug = isset($options['--debug']);
$optionKeepTmpGrammar = isset($options['--keep-tmp-grammar']);
///////////////////////////////
/// Utility regex constants ///
///////////////////////////////
const LIB = '(?(DEFINE)
(?<singleQuotedString>\'[^\\\\\']*+(?:\\\\.[^\\\\\']*+)*+\')
(?<doubleQuotedString>"[^\\\\"]*+(?:\\\\.[^\\\\"]*+)*+")
(?<string>(?&singleQuotedString)|(?&doubleQuotedString))
(?<comment>/\*[^*]*+(?:\*(?!/)[^*]*+)*+\*/)
(?<code>\{[^\'"/{}]*+(?:(?:(?&string)|(?&comment)|(?&code)|/)[^\'"/{}]*+)*+})
)';
const PARAMS = '\[(?<params>[^[\]]*+(?:\[(?&params)\][^[\]]*+)*+)\]';
const ARGS = '\((?<args>[^()]*+(?:\((?&args)\)[^()]*+)*+)\)';
///////////////////
/// Main script ///
///////////////////
echo 'Building temporary preproprocessed grammar file.', "\n";
$grammarCode = file_get_contents($grammarFile);
$grammarCode = resolveConstants($grammarCode);
$grammarCode = resolveNodes($grammarCode);
$grammarCode = resolveMacros($grammarCode);
$grammarCode = resolveArrays($grammarCode);
file_put_contents($tmpGrammarFile, $grammarCode);
$additionalArgs = $optionDebug ? '-t -v' : '';
echo "Building parser.\n";
$output = trim(shell_exec("$kmyacc $additionalArgs -l -m $skeletonFile $tmpGrammarFile 2>&1"));
echo "Output: \"$output\"\n";
moveFileWithDirCheck($tmpResultFile, $parserResultFile);
if (!$optionKeepTmpGrammar) {
unlink($tmpGrammarFile);
}
///////////////////////////////
/// Preprocessing functions ///
///////////////////////////////
function resolveConstants($code) {
return preg_replace('~[A-Z][a-zA-Z_\\\\]++::~', 'Node\\\\$0', $code);
}
function resolveNodes($code) {
return preg_replace_callback(
'~(?<name>[A-Z][a-zA-Z_\\\\]++)\s*' . PARAMS . '~',
function($matches) {
// recurse
$matches['params'] = resolveNodes($matches['params']);
$params = magicSplit(
'(?:' . PARAMS . '|' . ARGS . ')(*SKIP)(*FAIL)|,',
$matches['params']
);
$paramCode = '';
foreach ($params as $param) {
$paramCode .= $param . ', ';
}
return 'new Node\\' . $matches['name'] . '(' . $paramCode . '$attributes)';
},
$code
);
}
function resolveMacros($code) {
return preg_replace_callback(
'~\b(?<!::|->)(?!array\()(?<name>[a-z][A-Za-z]++)' . ARGS . '~',
function($matches) {
// recurse
$matches['args'] = resolveMacros($matches['args']);
$name = $matches['name'];
$args = magicSplit(
'(?:' . PARAMS . '|' . ARGS . ')(*SKIP)(*FAIL)|,',
$matches['args']
);
if ('error' == $name) {
assertArgs(1, $args, $name);
return 'throw new Error(' . $args[0] . ')';
}
if ('init' == $name) {
return '$$ = array(' . implode(', ', $args) . ')';
}
if ('push' == $name) {
assertArgs(2, $args, $name);
return $args[0] . '[] = ' . $args[1] . '; $$ = ' . $args[0];
}
if ('pushNormalizing' == $name) {
assertArgs(2, $args, $name);
return 'if (is_array(' . $args[1] . ')) { $$ = array_merge(' . $args[0] . ', ' . $args[1] . '); } else { ' . $args[0] . '[] = ' . $args[1] . '; $$ = ' . $args[0] . '; }';
}
if ('toArray' == $name) {
assertArgs(1, $args, $name);
return 'is_array(' . $args[0] . ') ? ' . $args[0] . ' : array(' . $args[0] . ')';
}
if ('parseVar' == $name) {
assertArgs(1, $args, $name);
return 'substr(' . $args[0] . ', 1)';
}
if ('parseEncapsed' == $name) {
assertArgs(2, $args, $name);
return 'foreach (' . $args[0] . ' as &$s) { if (is_string($s)) { $s = Node\Scalar\String::parseEscapeSequences($s, ' . $args[1] . '); } }';
}
if ('parseEncapsedDoc' == $name) {
assertArgs(1, $args, $name);
return 'foreach (' . $args[0] . ' as &$s) { if (is_string($s)) { $s = Node\Scalar\String::parseEscapeSequences($s, null); } } $s = preg_replace(\'~(\r\n|\n|\r)$~\', \'\', $s); if (\'\' === $s) array_pop(' . $args[0] . ');';
}
throw new Exception(sprintf('Unknown macro "%s"', $name));
},
$code
);
}
function assertArgs($num, $args, $name) {
if ($num != count($args)) {
die('Wrong argument count for ' . $name . '().');
}
}
function resolveArrays($code) {
return preg_replace_callback(
'~' . PARAMS . '~',
function ($matches) {
$elements = magicSplit(
'(?:' . PARAMS . '|' . ARGS . ')(*SKIP)(*FAIL)|,',
$matches['params']
);
// don't convert [] to array, it might have different meaning
if (empty($elements)) {
return $matches[0];
}
$elementCodes = array();
foreach ($elements as $element) {
// convert only arrays where all elements have keys
if (false === strpos($element, ':')) {
return $matches[0];
}
list($key, $value) = explode(':', $element, 2);
$elementCodes[] = "'" . $key . "' =>" . $value;
}
return 'array(' . implode(', ', $elementCodes) . ')';
},
$code
);
}
function moveFileWithDirCheck($fromPath, $toPath) {
$dir = dirname($toPath);
if (!is_dir($dir)) {
mkdir($dir, 0777, true);
}
rename($fromPath, $toPath);
}
//////////////////////////////
/// Regex helper functions ///
//////////////////////////////
function regex($regex) {
return '~' . LIB . '(?:' . str_replace('~', '\~', $regex) . ')~';
}
function magicSplit($regex, $string) {
$pieces = preg_split(regex('(?:(?&string)|(?&comment)|(?&code))(*SKIP)(*FAIL)|' . $regex), $string);
foreach ($pieces as &$piece) {
$piece = trim($piece);
}
return array_filter($pieces);
}

248
grammar/rebuildParsers.php Normal file
View File

@ -0,0 +1,248 @@
<?php
$grammarFileToName = [
__DIR__ . '/php5.y' => 'Php5',
__DIR__ . '/php7.y' => 'Php7',
];
$tokensFile = __DIR__ . '/tokens.y';
$tokensTemplate = __DIR__ . '/tokens.template';
$skeletonFile = __DIR__ . '/parser.template';
$tmpGrammarFile = __DIR__ . '/tmp_parser.phpy';
$tmpResultFile = __DIR__ . '/tmp_parser.php';
$resultDir = __DIR__ . '/../lib/PhpParser/Parser';
$tokensResultsFile = $resultDir . '/Tokens.php';
// check for kmyacc.exe binary in this directory, otherwise fall back to global name
$kmyacc = __DIR__ . '/kmyacc.exe';
if (!file_exists($kmyacc)) {
$kmyacc = 'kmyacc';
}
$options = array_flip($argv);
$optionDebug = isset($options['--debug']);
$optionKeepTmpGrammar = isset($options['--keep-tmp-grammar']);
///////////////////////////////
/// Utility regex constants ///
///////////////////////////////
const LIB = '(?(DEFINE)
(?<singleQuotedString>\'[^\\\\\']*+(?:\\\\.[^\\\\\']*+)*+\')
(?<doubleQuotedString>"[^\\\\"]*+(?:\\\\.[^\\\\"]*+)*+")
(?<string>(?&singleQuotedString)|(?&doubleQuotedString))
(?<comment>/\*[^*]*+(?:\*(?!/)[^*]*+)*+\*/)
(?<code>\{[^\'"/{}]*+(?:(?:(?&string)|(?&comment)|(?&code)|/)[^\'"/{}]*+)*+})
)';
const PARAMS = '\[(?<params>[^[\]]*+(?:\[(?&params)\][^[\]]*+)*+)\]';
const ARGS = '\((?<args>[^()]*+(?:\((?&args)\)[^()]*+)*+)\)';
///////////////////
/// Main script ///
///////////////////
$tokens = file_get_contents($tokensFile);
foreach ($grammarFileToName as $grammarFile => $name) {
echo "Building temporary $name grammar file.\n";
$grammarCode = file_get_contents($grammarFile);
$grammarCode = str_replace('%tokens', $tokens, $grammarCode);
$grammarCode = resolveNodes($grammarCode);
$grammarCode = resolveMacros($grammarCode);
$grammarCode = resolveStackAccess($grammarCode);
file_put_contents($tmpGrammarFile, $grammarCode);
$additionalArgs = $optionDebug ? '-t -v' : '';
echo "Building $name parser.\n";
$output = trim(shell_exec("$kmyacc $additionalArgs -l -m $skeletonFile -p $name $tmpGrammarFile 2>&1"));
echo "Output: \"$output\"\n";
$resultCode = file_get_contents($tmpResultFile);
$resultCode = removeTrailingWhitespace($resultCode);
ensureDirExists($resultDir);
file_put_contents("$resultDir/$name.php", $resultCode);
unlink($tmpResultFile);
echo "Building token definition.\n";
$output = trim(shell_exec("$kmyacc -l -m $tokensTemplate $tmpGrammarFile 2>&1"));
assert($output === '');
rename($tmpResultFile, $tokensResultsFile);
if (!$optionKeepTmpGrammar) {
unlink($tmpGrammarFile);
}
}
///////////////////////////////
/// Preprocessing functions ///
///////////////////////////////
function resolveNodes($code) {
return preg_replace_callback(
'~\b(?<name>[A-Z][a-zA-Z_\\\\]++)\s*' . PARAMS . '~',
function($matches) {
// recurse
$matches['params'] = resolveNodes($matches['params']);
$params = magicSplit(
'(?:' . PARAMS . '|' . ARGS . ')(*SKIP)(*FAIL)|,',
$matches['params']
);
$paramCode = '';
foreach ($params as $param) {
$paramCode .= $param . ', ';
}
return 'new ' . $matches['name'] . '(' . $paramCode . 'attributes())';
},
$code
);
}
function resolveMacros($code) {
return preg_replace_callback(
'~\b(?<!::|->)(?!array\()(?<name>[a-z][A-Za-z]++)' . ARGS . '~',
function($matches) {
// recurse
$matches['args'] = resolveMacros($matches['args']);
$name = $matches['name'];
$args = magicSplit(
'(?:' . PARAMS . '|' . ARGS . ')(*SKIP)(*FAIL)|,',
$matches['args']
);
if ('attributes' == $name) {
assertArgs(0, $args, $name);
return '$this->startAttributeStack[#1] + $this->endAttributes';
}
if ('init' == $name) {
return '$$ = array(' . implode(', ', $args) . ')';
}
if ('push' == $name) {
assertArgs(2, $args, $name);
return $args[0] . '[] = ' . $args[1] . '; $$ = ' . $args[0];
}
if ('pushNormalizing' == $name) {
assertArgs(2, $args, $name);
return 'if (is_array(' . $args[1] . ')) { $$ = array_merge(' . $args[0] . ', ' . $args[1] . '); }'
. ' else { ' . $args[0] . '[] = ' . $args[1] . '; $$ = ' . $args[0] . '; }';
}
if ('toArray' == $name) {
assertArgs(1, $args, $name);
return 'is_array(' . $args[0] . ') ? ' . $args[0] . ' : array(' . $args[0] . ')';
}
if ('parseVar' == $name) {
assertArgs(1, $args, $name);
return 'substr(' . $args[0] . ', 1)';
}
if ('parseEncapsed' == $name) {
assertArgs(3, $args, $name);
return 'foreach (' . $args[0] . ' as $s) { if ($s instanceof Node\Scalar\EncapsedStringPart) {'
. ' $s->value = Node\Scalar\String_::parseEscapeSequences($s->value, ' . $args[1] . ', ' . $args[2] . '); } }';
}
if ('parseEncapsedDoc' == $name) {
assertArgs(2, $args, $name);
return 'foreach (' . $args[0] . ' as $s) { if ($s instanceof Node\Scalar\EncapsedStringPart) {'
. ' $s->value = Node\Scalar\String_::parseEscapeSequences($s->value, null, ' . $args[1] . '); } }'
. ' $s->value = preg_replace(\'~(\r\n|\n|\r)\z~\', \'\', $s->value);'
. ' if (\'\' === $s->value) array_pop(' . $args[0] . ');';
}
if ('makeNop' == $name) {
assertArgs(2, $args, $name);
return '$startAttributes = ' . $args[1] . ';'
. ' if (isset($startAttributes[\'comments\']))'
. ' { ' . $args[0] . ' = new Stmt\Nop([\'comments\' => $startAttributes[\'comments\']]); }'
. ' else { ' . $args[0] . ' = null; }';
}
if ('strKind' == $name) {
assertArgs(1, $args, $name);
return '(' . $args[0] . '[0] === "\'" || (' . $args[0] . '[1] === "\'" && '
. '(' . $args[0] . '[0] === \'b\' || ' . $args[0] . '[0] === \'B\')) '
. '? Scalar\String_::KIND_SINGLE_QUOTED : Scalar\String_::KIND_DOUBLE_QUOTED)';
}
if ('setDocStringAttrs' == $name) {
assertArgs(2, $args, $name);
return $args[0] . '[\'kind\'] = strpos(' . $args[1] . ', "\'") === false '
. '? Scalar\String_::KIND_HEREDOC : Scalar\String_::KIND_NOWDOC; '
. 'preg_match(\'/\A[bB]?<<<[ \t]*[\\\'"]?([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)[\\\'"]?(?:\r\n|\n|\r)\z/\', ' . $args[1] . ', $matches); '
. $args[0] . '[\'docLabel\'] = $matches[1];';
}
return $matches[0];
},
$code
);
}
function assertArgs($num, $args, $name) {
if ($num != count($args)) {
die('Wrong argument count for ' . $name . '().');
}
}
function resolveStackAccess($code) {
$code = preg_replace('/\$\d+/', '$this->semStack[$0]', $code);
$code = preg_replace('/#(\d+)/', '$$1', $code);
return $code;
}
function removeTrailingWhitespace($code) {
$lines = explode("\n", $code);
$lines = array_map('rtrim', $lines);
return implode("\n", $lines);
}
function ensureDirExists($dir) {
if (!is_dir($dir)) {
mkdir($dir, 0777, true);
}
}
//////////////////////////////
/// Regex helper functions ///
//////////////////////////////
function regex($regex) {
return '~' . LIB . '(?:' . str_replace('~', '\~', $regex) . ')~';
}
function magicSplit($regex, $string) {
$pieces = preg_split(regex('(?:(?&string)|(?&comment)|(?&code))(*SKIP)(*FAIL)|' . $regex), $string);
foreach ($pieces as &$piece) {
$piece = trim($piece);
}
if ($pieces === ['']) {
return [];
}
return $pieces;
}

17
grammar/tokens.template Normal file
View File

@ -0,0 +1,17 @@
<?php
$meta #
#semval($) $this->semValue
#semval($,%t) $this->semValue
#semval(%n) $this->stackPos-(%l-%n)
#semval(%n,%t) $this->stackPos-(%l-%n)
namespace PhpParser\Parser;
#include;
/* GENERATED file based on grammar/tokens.y */
final class Tokens
{
#tokenval
const %s = %n;
#endtokenval
}

113
grammar/tokens.y Normal file
View File

@ -0,0 +1,113 @@
/* We currently rely on the token ID mapping to be the same between PHP 5 and PHP 7 - so the same lexer can be used for
* both. This is enforced by sharing this token file. */
%left T_INCLUDE T_INCLUDE_ONCE T_EVAL T_REQUIRE T_REQUIRE_ONCE
%left ','
%left T_LOGICAL_OR
%left T_LOGICAL_XOR
%left T_LOGICAL_AND
%right T_PRINT
%right T_YIELD
%right T_DOUBLE_ARROW
%right T_YIELD_FROM
%left '=' T_PLUS_EQUAL T_MINUS_EQUAL T_MUL_EQUAL T_DIV_EQUAL T_CONCAT_EQUAL T_MOD_EQUAL T_AND_EQUAL T_OR_EQUAL T_XOR_EQUAL T_SL_EQUAL T_SR_EQUAL T_POW_EQUAL
%left '?' ':'
%right T_COALESCE
%left T_BOOLEAN_OR
%left T_BOOLEAN_AND
%left '|'
%left '^'
%left '&'
%nonassoc T_IS_EQUAL T_IS_NOT_EQUAL T_IS_IDENTICAL T_IS_NOT_IDENTICAL T_SPACESHIP
%nonassoc '<' T_IS_SMALLER_OR_EQUAL '>' T_IS_GREATER_OR_EQUAL
%left T_SL T_SR
%left '+' '-' '.'
%left '*' '/' '%'
%right '!'
%nonassoc T_INSTANCEOF
%right '~' T_INC T_DEC T_INT_CAST T_DOUBLE_CAST T_STRING_CAST T_ARRAY_CAST T_OBJECT_CAST T_BOOL_CAST T_UNSET_CAST '@'
%right T_POW
%right '['
%nonassoc T_NEW T_CLONE
%token T_EXIT
%token T_IF
%left T_ELSEIF
%left T_ELSE
%left T_ENDIF
%token T_LNUMBER
%token T_DNUMBER
%token T_STRING
%token T_STRING_VARNAME
%token T_VARIABLE
%token T_NUM_STRING
%token T_INLINE_HTML
%token T_CHARACTER
%token T_BAD_CHARACTER
%token T_ENCAPSED_AND_WHITESPACE
%token T_CONSTANT_ENCAPSED_STRING
%token T_ECHO
%token T_DO
%token T_WHILE
%token T_ENDWHILE
%token T_FOR
%token T_ENDFOR
%token T_FOREACH
%token T_ENDFOREACH
%token T_DECLARE
%token T_ENDDECLARE
%token T_AS
%token T_SWITCH
%token T_ENDSWITCH
%token T_CASE
%token T_DEFAULT
%token T_BREAK
%token T_CONTINUE
%token T_GOTO
%token T_FUNCTION
%token T_CONST
%token T_RETURN
%token T_TRY
%token T_CATCH
%token T_FINALLY
%token T_THROW
%token T_USE
%token T_INSTEADOF
%token T_GLOBAL
%right T_STATIC T_ABSTRACT T_FINAL T_PRIVATE T_PROTECTED T_PUBLIC
%token T_VAR
%token T_UNSET
%token T_ISSET
%token T_EMPTY
%token T_HALT_COMPILER
%token T_CLASS
%token T_TRAIT
%token T_INTERFACE
%token T_EXTENDS
%token T_IMPLEMENTS
%token T_OBJECT_OPERATOR
%token T_DOUBLE_ARROW
%token T_LIST
%token T_ARRAY
%token T_CALLABLE
%token T_CLASS_C
%token T_TRAIT_C
%token T_METHOD_C
%token T_FUNC_C
%token T_LINE
%token T_FILE
%token T_COMMENT
%token T_DOC_COMMENT
%token T_OPEN_TAG
%token T_OPEN_TAG_WITH_ECHO
%token T_CLOSE_TAG
%token T_WHITESPACE
%token T_START_HEREDOC
%token T_END_HEREDOC
%token T_DOLLAR_OPEN_CURLY_BRACES
%token T_CURLY_OPEN
%token T_PAAMAYIM_NEKUDOTAYIM
%token T_NAMESPACE
%token T_NS_C
%token T_DIR
%token T_NS_SEPARATOR
%token T_ELLIPSIS

View File

@ -7,14 +7,21 @@ namespace PhpParser;
*/ */
class Autoloader class Autoloader
{ {
/** @var bool Whether the autoloader has been registered. */
private static $registered = false;
/** /**
* Registers PhpParser\Autoloader as an SPL autoloader. * Registers PhpParser\Autoloader as an SPL autoloader.
* *
* @param bool $prepend Whether to prepend the autoloader instead of appending * @param bool $prepend Whether to prepend the autoloader instead of appending
*/ */
static public function register($prepend = false) { static public function register($prepend = false) {
ini_set('unserialize_callback_func', 'spl_autoload_call'); if (self::$registered === true) {
return;
}
spl_autoload_register(array(__CLASS__, 'autoload'), true, $prepend); spl_autoload_register(array(__CLASS__, 'autoload'), true, $prepend);
self::$registered = true;
} }
/** /**
@ -24,207 +31,10 @@ class Autoloader
*/ */
static public function autoload($class) { static public function autoload($class) {
if (0 === strpos($class, 'PhpParser\\')) { if (0 === strpos($class, 'PhpParser\\')) {
$fileName = dirname(__DIR__) . '/' . strtr($class, '\\', '/') . '.php'; $fileName = __DIR__ . strtr(substr($class, 9), '\\', '/') . '.php';
if (file_exists($fileName)) { if (file_exists($fileName)) {
require $fileName; require $fileName;
} }
} else if (0 === strpos($class, 'PHPParser_')) {
if (isset(self::$oldToNewMap[$class])) {
self::registerLegacyAliases();
}
} }
} }
private static function registerLegacyAliases() {
foreach (self::$oldToNewMap as $old => $new) {
class_alias($new, $old);
}
}
private static $oldToNewMap = array(
'PHPParser_Builder' => 'PhpParser\Builder',
'PHPParser_BuilderAbstract' => 'PhpParser\BuilderAbstract',
'PHPParser_BuilderFactory' => 'PhpParser\BuilderFactory',
'PHPParser_Comment' => 'PhpParser\Comment',
'PHPParser_Comment_Doc' => 'PhpParser\Comment\Doc',
'PHPParser_Error' => 'PhpParser\Error',
'PHPParser_Lexer' => 'PhpParser\Lexer',
'PHPParser_Lexer_Emulative' => 'PhpParser\Lexer\Emulative',
'PHPParser_Node' => 'PhpParser\Node',
'PHPParser_NodeAbstract' => 'PhpParser\NodeAbstract',
'PHPParser_NodeDumper' => 'PhpParser\NodeDumper',
'PHPParser_NodeTraverser' => 'PhpParser\NodeTraverser',
'PHPParser_NodeTraverserInterface' => 'PhpParser\NodeTraverserInterface',
'PHPParser_NodeVisitor' => 'PhpParser\NodeVisitor',
'PHPParser_NodeVisitor_NameResolver' => 'PhpParser\NodeVisitor\NameResolver',
'PHPParser_NodeVisitorAbstract' => 'PhpParser\NodeVisitorAbstract',
'PHPParser_Parser' => 'PhpParser\Parser',
'PHPParser_PrettyPrinterAbstract' => 'PhpParser\PrettyPrinterAbstract',
'PHPParser_PrettyPrinter_Default' => 'PhpParser\PrettyPrinter\Standard',
'PHPParser_PrettyPrinter_Zend' => 'PhpParser\PrettyPrinter\Standard',
'PHPParser_Serializer' => 'PhpParser\Serializer',
'PHPParser_Serializer_XML' => 'PhpParser\Serializer\XML',
'PHPParser_Unserializer' => 'PhpParser\Unserializer',
'PHPParser_Unserializer_XML' => 'PhpParser\Unserializer\XML',
'PHPParser_Builder_Class' => 'PhpParser\Builder\Class_',
'PHPParser_Builder_Function' => 'PhpParser\Builder\Function_',
'PHPParser_Builder_Interface' => 'PhpParser\Builder\Interface_',
'PHPParser_Builder_Method' => 'PhpParser\Builder\Method',
'PHPParser_Builder_Param' => 'PhpParser\Builder\Param',
'PHPParser_Builder_Property' => 'PhpParser\Builder\Property',
'PHPParser_Node_Arg' => 'PhpParser\Node\Arg',
'PHPParser_Node_Const' => 'PhpParser\Node\Const_',
'PHPParser_Node_Expr' => 'PhpParser\Node\Expr',
'PHPParser_Node_Name' => 'PhpParser\Node\Name',
'PHPParser_Node_Name_FullyQualified' => 'PhpParser\Node\Name\FullyQualified',
'PHPParser_Node_Name_Relative' => 'PhpParser\Node\Name\Relative',
'PHPParser_Node_Param' => 'PhpParser\Node\Param',
'PHPParser_Node_Scalar' => 'PhpParser\Node\Scalar',
'PHPParser_Node_Stmt' => 'PhpParser\Node\Stmt',
'PHPParser_Node_Stmt_Break' => 'PhpParser\Node\Stmt\Break_',
'PHPParser_Node_Stmt_Case' => 'PhpParser\Node\Stmt\Case_',
'PHPParser_Node_Stmt_Catch' => 'PhpParser\Node\Stmt\Catch_',
'PHPParser_Node_Stmt_Class' => 'PhpParser\Node\Stmt\Class_',
'PHPParser_Node_Stmt_ClassConst' => 'PhpParser\Node\Stmt\ClassConst',
'PHPParser_Node_Stmt_ClassMethod' => 'PhpParser\Node\Stmt\ClassMethod',
'PHPParser_Node_Stmt_Const' => 'PhpParser\Node\Stmt\Const_',
'PHPParser_Node_Stmt_Continue' => 'PhpParser\Node\Stmt\Continue_',
'PHPParser_Node_Stmt_Declare' => 'PhpParser\Node\Stmt\Declare_',
'PHPParser_Node_Stmt_DeclareDeclare' => 'PhpParser\Node\Stmt\DeclareDeclare',
'PHPParser_Node_Stmt_Do' => 'PhpParser\Node\Stmt\Do_',
'PHPParser_Node_Stmt_Echo' => 'PhpParser\Node\Stmt\Echo_',
'PHPParser_Node_Stmt_Else' => 'PhpParser\Node\Stmt\Else_',
'PHPParser_Node_Stmt_ElseIf' => 'PhpParser\Node\Stmt\ElseIf_',
'PHPParser_Node_Stmt_For' => 'PhpParser\Node\Stmt\For_',
'PHPParser_Node_Stmt_Foreach' => 'PhpParser\Node\Stmt\Foreach_',
'PHPParser_Node_Stmt_Function' => 'PhpParser\Node\Stmt\Function_',
'PHPParser_Node_Stmt_Global' => 'PhpParser\Node\Stmt\Global_',
'PHPParser_Node_Stmt_Goto' => 'PhpParser\Node\Stmt\Goto_',
'PHPParser_Node_Stmt_HaltCompiler' => 'PhpParser\Node\Stmt\HaltCompiler',
'PHPParser_Node_Stmt_If' => 'PhpParser\Node\Stmt\If_',
'PHPParser_Node_Stmt_InlineHTML' => 'PhpParser\Node\Stmt\InlineHTML',
'PHPParser_Node_Stmt_Interface' => 'PhpParser\Node\Stmt\Interface_',
'PHPParser_Node_Stmt_Label' => 'PhpParser\Node\Stmt\Label',
'PHPParser_Node_Stmt_Namespace' => 'PhpParser\Node\Stmt\Namespace_',
'PHPParser_Node_Stmt_Property' => 'PhpParser\Node\Stmt\Property',
'PHPParser_Node_Stmt_PropertyProperty' => 'PhpParser\Node\Stmt\PropertyProperty',
'PHPParser_Node_Stmt_Return' => 'PhpParser\Node\Stmt\Return_',
'PHPParser_Node_Stmt_Static' => 'PhpParser\Node\Stmt\Static_',
'PHPParser_Node_Stmt_StaticVar' => 'PhpParser\Node\Stmt\StaticVar',
'PHPParser_Node_Stmt_Switch' => 'PhpParser\Node\Stmt\Switch_',
'PHPParser_Node_Stmt_Throw' => 'PhpParser\Node\Stmt\Throw_',
'PHPParser_Node_Stmt_Trait' => 'PhpParser\Node\Stmt\Trait_',
'PHPParser_Node_Stmt_TraitUse' => 'PhpParser\Node\Stmt\TraitUse',
'PHPParser_Node_Stmt_TraitUseAdaptation' => 'PhpParser\Node\Stmt\TraitUseAdaptation',
'PHPParser_Node_Stmt_TraitUseAdaptation_Alias' => 'PhpParser\Node\Stmt\TraitUseAdaptation\Alias',
'PHPParser_Node_Stmt_TraitUseAdaptation_Precedence' => 'PhpParser\Node\Stmt\TraitUseAdaptation\Precedence',
'PHPParser_Node_Stmt_TryCatch' => 'PhpParser\Node\Stmt\TryCatch',
'PHPParser_Node_Stmt_Unset' => 'PhpParser\Node\Stmt\Unset_',
'PHPParser_Node_Stmt_UseUse' => 'PhpParser\Node\Stmt\UseUse',
'PHPParser_Node_Stmt_Use' => 'PhpParser\Node\Stmt\Use_',
'PHPParser_Node_Stmt_While' => 'PhpParser\Node\Stmt\While_',
'PHPParser_Node_Expr_AssignBitwiseAnd' => 'PhpParser\Node\Expr\AssignOp\BitwiseAnd',
'PHPParser_Node_Expr_AssignBitwiseOr' => 'PhpParser\Node\Expr\AssignOp\BitwiseOr',
'PHPParser_Node_Expr_AssignBitwiseXor' => 'PhpParser\Node\Expr\AssignOp\BitwiseXor',
'PHPParser_Node_Expr_AssignConcat' => 'PhpParser\Node\Expr\AssignOp\Concat',
'PHPParser_Node_Expr_AssignDiv' => 'PhpParser\Node\Expr\AssignOp\Div',
'PHPParser_Node_Expr_AssignMinus' => 'PhpParser\Node\Expr\AssignOp\Minus',
'PHPParser_Node_Expr_AssignMod' => 'PhpParser\Node\Expr\AssignOp\Mod',
'PHPParser_Node_Expr_AssignMul' => 'PhpParser\Node\Expr\AssignOp\Mul',
'PHPParser_Node_Expr_AssignPlus' => 'PhpParser\Node\Expr\AssignOp\Plus',
'PHPParser_Node_Expr_AssignShiftLeft' => 'PhpParser\Node\Expr\AssignOp\ShiftLeft',
'PHPParser_Node_Expr_AssignShiftRight' => 'PhpParser\Node\Expr\AssignOp\ShiftRight',
'PHPParser_Node_Expr_Cast' => 'PhpParser\Node\Expr\Cast',
'PHPParser_Node_Expr_Cast_Array' => 'PhpParser\Node\Expr\Cast\Array_',
'PHPParser_Node_Expr_Cast_Bool' => 'PhpParser\Node\Expr\Cast\Bool',
'PHPParser_Node_Expr_Cast_Double' => 'PhpParser\Node\Expr\Cast\Double',
'PHPParser_Node_Expr_Cast_Int' => 'PhpParser\Node\Expr\Cast\Int',
'PHPParser_Node_Expr_Cast_Object' => 'PhpParser\Node\Expr\Cast\Object',
'PHPParser_Node_Expr_Cast_String' => 'PhpParser\Node\Expr\Cast\String',
'PHPParser_Node_Expr_Cast_Unset' => 'PhpParser\Node\Expr\Cast\Unset_',
'PHPParser_Node_Expr_BitwiseAnd' => 'PhpParser\Node\Expr\BinaryOp\BitwiseAnd',
'PHPParser_Node_Expr_BitwiseOr' => 'PhpParser\Node\Expr\BinaryOp\BitwiseOr',
'PHPParser_Node_Expr_BitwiseXor' => 'PhpParser\Node\Expr\BinaryOp\BitwiseXor',
'PHPParser_Node_Expr_BooleanAnd' => 'PhpParser\Node\Expr\BinaryOp\BooleanAnd',
'PHPParser_Node_Expr_BooleanOr' => 'PhpParser\Node\Expr\BinaryOp\BooleanOr',
'PHPParser_Node_Expr_Concat' => 'PhpParser\Node\Expr\BinaryOp\Concat',
'PHPParser_Node_Expr_Div' => 'PhpParser\Node\Expr\BinaryOp\Div',
'PHPParser_Node_Expr_Equal' => 'PhpParser\Node\Expr\BinaryOp\Equal',
'PHPParser_Node_Expr_Greater' => 'PhpParser\Node\Expr\BinaryOp\Greater',
'PHPParser_Node_Expr_GreaterOrEqual' => 'PhpParser\Node\Expr\BinaryOp\GreaterOrEqual',
'PHPParser_Node_Expr_Identical' => 'PhpParser\Node\Expr\BinaryOp\Identical',
'PHPParser_Node_Expr_LogicalAnd' => 'PhpParser\Node\Expr\BinaryOp\LogicalAnd',
'PHPParser_Node_Expr_LogicalOr' => 'PhpParser\Node\Expr\BinaryOp\LogicalOr',
'PHPParser_Node_Expr_LogicalXor' => 'PhpParser\Node\Expr\BinaryOp\LogicalXor',
'PHPParser_Node_Expr_Minus' => 'PhpParser\Node\Expr\BinaryOp\Minus',
'PHPParser_Node_Expr_Mod' => 'PhpParser\Node\Expr\BinaryOp\Mod',
'PHPParser_Node_Expr_Mul' => 'PhpParser\Node\Expr\BinaryOp\Mul',
'PHPParser_Node_Expr_NotEqual' => 'PhpParser\Node\Expr\BinaryOp\NotEqual',
'PHPParser_Node_Expr_NotIdentical' => 'PhpParser\Node\Expr\BinaryOp\NotIdentical',
'PHPParser_Node_Expr_Plus' => 'PhpParser\Node\Expr\BinaryOp\Plus',
'PHPParser_Node_Expr_ShiftLeft' => 'PhpParser\Node\Expr\BinaryOp\ShiftLeft',
'PHPParser_Node_Expr_ShiftRight' => 'PhpParser\Node\Expr\BinaryOp\ShiftRight',
'PHPParser_Node_Expr_Smaller' => 'PhpParser\Node\Expr\BinaryOp\Smaller',
'PHPParser_Node_Expr_SmallerOrEqual' => 'PhpParser\Node\Expr\BinaryOp\SmallerOrEqual',
'PHPParser_Node_Expr_Array' => 'PhpParser\Node\Expr\Array_',
'PHPParser_Node_Expr_ArrayDimFetch' => 'PhpParser\Node\Expr\ArrayDimFetch',
'PHPParser_Node_Expr_ArrayItem' => 'PhpParser\Node\Expr\ArrayItem',
'PHPParser_Node_Expr_Assign' => 'PhpParser\Node\Expr\Assign',
'PHPParser_Node_Expr_AssignRef' => 'PhpParser\Node\Expr\AssignRef',
'PHPParser_Node_Expr_BitwiseNot' => 'PhpParser\Node\Expr\BitwiseNot',
'PHPParser_Node_Expr_BooleanNot' => 'PhpParser\Node\Expr\BooleanNot',
'PHPParser_Node_Expr_ClassConstFetch' => 'PhpParser\Node\Expr\ClassConstFetch',
'PHPParser_Node_Expr_Clone' => 'PhpParser\Node\Expr\Clone_',
'PHPParser_Node_Expr_Closure' => 'PhpParser\Node\Expr\Closure',
'PHPParser_Node_Expr_ClosureUse' => 'PhpParser\Node\Expr\ClosureUse',
'PHPParser_Node_Expr_ConstFetch' => 'PhpParser\Node\Expr\ConstFetch',
'PHPParser_Node_Expr_Empty' => 'PhpParser\Node\Expr\Empty_',
'PHPParser_Node_Expr_ErrorSuppress' => 'PhpParser\Node\Expr\ErrorSuppress',
'PHPParser_Node_Expr_Eval' => 'PhpParser\Node\Expr\Eval_',
'PHPParser_Node_Expr_Exit' => 'PhpParser\Node\Expr\Exit_',
'PHPParser_Node_Expr_FuncCall' => 'PhpParser\Node\Expr\FuncCall',
'PHPParser_Node_Expr_Include' => 'PhpParser\Node\Expr\Include_',
'PHPParser_Node_Expr_Instanceof' => 'PhpParser\Node\Expr\Instanceof_',
'PHPParser_Node_Expr_Isset' => 'PhpParser\Node\Expr\Isset_',
'PHPParser_Node_Expr_List' => 'PhpParser\Node\Expr\List_',
'PHPParser_Node_Expr_MethodCall' => 'PhpParser\Node\Expr\MethodCall',
'PHPParser_Node_Expr_New' => 'PhpParser\Node\Expr\New_',
'PHPParser_Node_Expr_PostDec' => 'PhpParser\Node\Expr\PostDec',
'PHPParser_Node_Expr_PostInc' => 'PhpParser\Node\Expr\PostInc',
'PHPParser_Node_Expr_PreDec' => 'PhpParser\Node\Expr\PreDec',
'PHPParser_Node_Expr_PreInc' => 'PhpParser\Node\Expr\PreInc',
'PHPParser_Node_Expr_Print' => 'PhpParser\Node\Expr\Print_',
'PHPParser_Node_Expr_PropertyFetch' => 'PhpParser\Node\Expr\PropertyFetch',
'PHPParser_Node_Expr_ShellExec' => 'PhpParser\Node\Expr\ShellExec',
'PHPParser_Node_Expr_StaticCall' => 'PhpParser\Node\Expr\StaticCall',
'PHPParser_Node_Expr_StaticPropertyFetch' => 'PhpParser\Node\Expr\StaticPropertyFetch',
'PHPParser_Node_Expr_Ternary' => 'PhpParser\Node\Expr\Ternary',
'PHPParser_Node_Expr_UnaryMinus' => 'PhpParser\Node\Expr\UnaryMinus',
'PHPParser_Node_Expr_UnaryPlus' => 'PhpParser\Node\Expr\UnaryPlus',
'PHPParser_Node_Expr_Variable' => 'PhpParser\Node\Expr\Variable',
'PHPParser_Node_Expr_Yield' => 'PhpParser\Node\Expr\Yield_',
'PHPParser_Node_Scalar_ClassConst' => 'PhpParser\Node\Scalar\MagicConst\Class_',
'PHPParser_Node_Scalar_DirConst' => 'PhpParser\Node\Scalar\MagicConst\Dir',
'PHPParser_Node_Scalar_FileConst' => 'PhpParser\Node\Scalar\MagicConst\File',
'PHPParser_Node_Scalar_FuncConst' => 'PhpParser\Node\Scalar\MagicConst\Function_',
'PHPParser_Node_Scalar_LineConst' => 'PhpParser\Node\Scalar\MagicConst\Line',
'PHPParser_Node_Scalar_MethodConst' => 'PhpParser\Node\Scalar\MagicConst\Method',
'PHPParser_Node_Scalar_NSConst' => 'PhpParser\Node\Scalar\MagicConst\Namespace_',
'PHPParser_Node_Scalar_TraitConst' => 'PhpParser\Node\Scalar\MagicConst\Trait_',
'PHPParser_Node_Scalar_DNumber' => 'PhpParser\Node\Scalar\DNumber',
'PHPParser_Node_Scalar_Encapsed' => 'PhpParser\Node\Scalar\Encapsed',
'PHPParser_Node_Scalar_LNumber' => 'PhpParser\Node\Scalar\LNumber',
'PHPParser_Node_Scalar_String' => 'PhpParser\Node\Scalar\String',
);
} }
class_alias('PhpParser\Autoloader', 'PHPParser_Autoloader');

View File

@ -6,18 +6,18 @@ use PhpParser;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Class_ extends PhpParser\BuilderAbstract class Class_ extends Declaration
{ {
protected $name; protected $name;
protected $extends; protected $extends = null;
protected $implements; protected $implements = array();
protected $type; protected $type = 0;
protected $uses; protected $uses = array();
protected $constants; protected $constants = array();
protected $properties; protected $properties = array();
protected $methods; protected $methods = array();
/** /**
* Creates a class builder. * Creates a class builder.
@ -26,12 +26,6 @@ class Class_ extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->type = 0;
$this->extends = null;
$this->implements = array();
$this->uses = $this->constants = $this->properties = $this->methods = array();
} }
/** /**
@ -39,7 +33,7 @@ class Class_ extends PhpParser\BuilderAbstract
* *
* @param Name|string $class Name of class to extend * @param Name|string $class Name of class to extend
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function extend($class) { public function extend($class) {
$this->extends = $this->normalizeName($class); $this->extends = $this->normalizeName($class);
@ -50,10 +44,9 @@ class Class_ extends PhpParser\BuilderAbstract
/** /**
* Implements one or more interfaces. * Implements one or more interfaces.
* *
* @param Name|string $interface Name of interface to implement * @param Name|string ...$interfaces Names of interfaces to implement
* @param Name|string $... More interfaces to implement
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function implement() { public function implement() {
foreach (func_get_args() as $interface) { foreach (func_get_args() as $interface) {
@ -66,7 +59,7 @@ class Class_ extends PhpParser\BuilderAbstract
/** /**
* Makes the class abstract. * Makes the class abstract.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeAbstract() { public function makeAbstract() {
$this->setModifier(Stmt\Class_::MODIFIER_ABSTRACT); $this->setModifier(Stmt\Class_::MODIFIER_ABSTRACT);
@ -77,7 +70,7 @@ class Class_ extends PhpParser\BuilderAbstract
/** /**
* Makes the class final. * Makes the class final.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeFinal() { public function makeFinal() {
$this->setModifier(Stmt\Class_::MODIFIER_FINAL); $this->setModifier(Stmt\Class_::MODIFIER_FINAL);
@ -90,7 +83,7 @@ class Class_ extends PhpParser\BuilderAbstract
* *
* @param Stmt|PhpParser\Builder $stmt The statement to add * @param Stmt|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
$stmt = $this->normalizeNode($stmt); $stmt = $this->normalizeNode($stmt);
@ -112,21 +105,6 @@ class Class_ extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/** /**
* Returns the built class node. * Returns the built class node.
* *
@ -138,6 +116,6 @@ class Class_ extends PhpParser\BuilderAbstract
'extends' => $this->extends, 'extends' => $this->extends,
'implements' => $this->implements, 'implements' => $this->implements,
'stmts' => array_merge($this->uses, $this->constants, $this->properties, $this->methods), 'stmts' => array_merge($this->uses, $this->constants, $this->properties, $this->methods),
)); ), $this->attributes);
} }
} }

View File

@ -0,0 +1,44 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node;
use PhpParser\Node\Stmt;
abstract class Declaration extends PhpParser\BuilderAbstract
{
protected $attributes = array();
abstract public function addStmt($stmt);
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/**
* Sets doc comment for the declaration.
*
* @param PhpParser\Comment\Doc|string $docComment Doc comment to set
*
* @return $this The builder instance (for fluid interface)
*/
public function setDocComment($docComment) {
$this->attributes['comments'] = array(
$this->normalizeDocComment($docComment)
);
return $this;
}
}

View File

@ -0,0 +1,78 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node;
use PhpParser\Node\Stmt;
abstract class FunctionLike extends Declaration
{
protected $returnByRef = false;
protected $params = array();
protected $returnType = null;
/**
* Make the function return by reference.
*
* @return $this The builder instance (for fluid interface)
*/
public function makeReturnByRef() {
$this->returnByRef = true;
return $this;
}
/**
* Adds a parameter.
*
* @param Node\Param|Param $param The parameter to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addParam($param) {
$param = $this->normalizeNode($param);
if (!$param instanceof Node\Param) {
throw new \LogicException(sprintf('Expected parameter node, got "%s"', $param->getType()));
}
$this->params[] = $param;
return $this;
}
/**
* Adds multiple parameters.
*
* @param array $params The parameters to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addParams(array $params) {
foreach ($params as $param) {
$this->addParam($param);
}
return $this;
}
/**
* Sets the return type for PHP 7.
*
* @param string|Node\Name $type One of array, callable, string, int, float, bool,
* or a class/interface name.
*
* @return $this The builder instance (for fluid interface)
*/
public function setReturnType($type)
{
if (in_array($type, array('array', 'callable', 'string', 'int', 'float', 'bool'))) {
$this->returnType = $type;
} else {
$this->returnType = $this->normalizeName($type);
}
return $this;
}
}

View File

@ -6,13 +6,10 @@ use PhpParser;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Function_ extends PhpParser\BuilderAbstract class Function_ extends FunctionLike
{ {
protected $name; protected $name;
protected $stmts = array();
protected $returnByRef;
protected $params;
protected $stmts;
/** /**
* Creates a function builder. * Creates a function builder.
@ -21,55 +18,6 @@ class Function_ extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->returnByRef = false;
$this->params = array();
$this->stmts = array();
}
/**
* Make the function return by reference.
*
* @return self The builder instance (for fluid interface)
*/
public function makeReturnByRef() {
$this->returnByRef = true;
return $this;
}
/**
* Adds a parameter.
*
* @param Node\Param|Param $param The parameter to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParam($param) {
$param = $this->normalizeNode($param);
if (!$param instanceof Node\Param) {
throw new \LogicException(sprintf('Expected parameter node, got "%s"', $param->getType()));
}
$this->params[] = $param;
return $this;
}
/**
* Adds multiple parameters.
*
* @param array $params The parameters to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParams(array $params) {
foreach ($params as $param) {
$this->addParam($param);
}
return $this;
} }
/** /**
@ -77,7 +25,7 @@ class Function_ extends PhpParser\BuilderAbstract
* *
* @param Node|PhpParser\Builder $stmt The statement to add * @param Node|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
$this->stmts[] = $this->normalizeNode($stmt); $this->stmts[] = $this->normalizeNode($stmt);
@ -85,21 +33,6 @@ class Function_ extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/** /**
* Returns the built function node. * Returns the built function node.
* *
@ -107,9 +40,10 @@ class Function_ extends PhpParser\BuilderAbstract
*/ */
public function getNode() { public function getNode() {
return new Stmt\Function_($this->name, array( return new Stmt\Function_($this->name, array(
'byRef' => $this->returnByRef, 'byRef' => $this->returnByRef,
'params' => $this->params, 'params' => $this->params,
'stmts' => $this->stmts, 'returnType' => $this->returnType,
)); 'stmts' => $this->stmts,
), $this->attributes);
} }
} }

View File

@ -6,12 +6,12 @@ use PhpParser;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Interface_ extends PhpParser\BuilderAbstract class Interface_ extends Declaration
{ {
protected $name; protected $name;
protected $extends; protected $extends = array();
protected $constants; protected $constants = array();
protected $methods; protected $methods = array();
/** /**
* Creates an interface builder. * Creates an interface builder.
@ -20,17 +20,14 @@ class Interface_ extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->extends = array();
$this->constants = $this->methods = array();
} }
/** /**
* Extends one or more interfaces. * Extends one or more interfaces.
* *
* @param Name|string $interface Name of interface to extend * @param Name|string ...$interfaces Names of interfaces to extend
* @param Name|string $... More interfaces to extend
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function extend() { public function extend() {
foreach (func_get_args() as $interface) { foreach (func_get_args() as $interface) {
@ -45,7 +42,7 @@ class Interface_ extends PhpParser\BuilderAbstract
* *
* @param Stmt|PhpParser\Builder $stmt The statement to add * @param Stmt|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
$stmt = $this->normalizeNode($stmt); $stmt = $this->normalizeNode($stmt);
@ -70,22 +67,7 @@ class Interface_ extends PhpParser\BuilderAbstract
} }
/** /**
* Adds multiple statements. * Returns the built interface node.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/**
* Returns the built class node.
* *
* @return Stmt\Interface_ The built interface node * @return Stmt\Interface_ The built interface node
*/ */
@ -93,6 +75,6 @@ class Interface_ extends PhpParser\BuilderAbstract
return new Stmt\Interface_($this->name, array( return new Stmt\Interface_($this->name, array(
'extends' => $this->extends, 'extends' => $this->extends,
'stmts' => array_merge($this->constants, $this->methods), 'stmts' => array_merge($this->constants, $this->methods),
)); ), $this->attributes);
} }
} }

View File

@ -6,14 +6,11 @@ use PhpParser;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
class Method extends PhpParser\BuilderAbstract class Method extends FunctionLike
{ {
protected $name; protected $name;
protected $type = 0;
protected $type; protected $stmts = array();
protected $returnByRef;
protected $params;
protected $stmts;
/** /**
* Creates a method builder. * Creates a method builder.
@ -22,17 +19,12 @@ class Method extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->type = 0;
$this->returnByRef = false;
$this->params = array();
$this->stmts = array();
} }
/** /**
* Makes the method public. * Makes the method public.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePublic() { public function makePublic() {
$this->setModifier(Stmt\Class_::MODIFIER_PUBLIC); $this->setModifier(Stmt\Class_::MODIFIER_PUBLIC);
@ -43,7 +35,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method protected. * Makes the method protected.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeProtected() { public function makeProtected() {
$this->setModifier(Stmt\Class_::MODIFIER_PROTECTED); $this->setModifier(Stmt\Class_::MODIFIER_PROTECTED);
@ -54,7 +46,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method private. * Makes the method private.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePrivate() { public function makePrivate() {
$this->setModifier(Stmt\Class_::MODIFIER_PRIVATE); $this->setModifier(Stmt\Class_::MODIFIER_PRIVATE);
@ -65,7 +57,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method static. * Makes the method static.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeStatic() { public function makeStatic() {
$this->setModifier(Stmt\Class_::MODIFIER_STATIC); $this->setModifier(Stmt\Class_::MODIFIER_STATIC);
@ -76,7 +68,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method abstract. * Makes the method abstract.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeAbstract() { public function makeAbstract() {
if (!empty($this->stmts)) { if (!empty($this->stmts)) {
@ -92,7 +84,7 @@ class Method extends PhpParser\BuilderAbstract
/** /**
* Makes the method final. * Makes the method final.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeFinal() { public function makeFinal() {
$this->setModifier(Stmt\Class_::MODIFIER_FINAL); $this->setModifier(Stmt\Class_::MODIFIER_FINAL);
@ -100,57 +92,12 @@ class Method extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Make the method return by reference.
*
* @return self The builder instance (for fluid interface)
*/
public function makeReturnByRef() {
$this->returnByRef = true;
return $this;
}
/**
* Adds a parameter.
*
* @param Node\Param|Param $param The parameter to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParam($param) {
$param = $this->normalizeNode($param);
if (!$param instanceof Node\Param) {
throw new \LogicException(sprintf('Expected parameter node, got "%s"', $param->getType()));
}
$this->params[] = $param;
return $this;
}
/**
* Adds multiple parameters.
*
* @param array $params The parameters to add
*
* @return self The builder instance (for fluid interface)
*/
public function addParams(array $params) {
foreach ($params as $param) {
$this->addParam($param);
}
return $this;
}
/** /**
* Adds a statement. * Adds a statement.
* *
* @param Node|PhpParser\Builder $stmt The statement to add * @param Node|PhpParser\Builder $stmt The statement to add
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function addStmt($stmt) { public function addStmt($stmt) {
if (null === $this->stmts) { if (null === $this->stmts) {
@ -162,21 +109,6 @@ class Method extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return self The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/** /**
* Returns the built method node. * Returns the built method node.
* *
@ -184,10 +116,11 @@ class Method extends PhpParser\BuilderAbstract
*/ */
public function getNode() { public function getNode() {
return new Stmt\ClassMethod($this->name, array( return new Stmt\ClassMethod($this->name, array(
'type' => $this->type !== 0 ? $this->type : Stmt\Class_::MODIFIER_PUBLIC, 'type' => $this->type,
'byRef' => $this->returnByRef, 'byRef' => $this->returnByRef,
'params' => $this->params, 'params' => $this->params,
'stmts' => $this->stmts, 'returnType' => $this->returnType,
)); 'stmts' => $this->stmts,
), $this->attributes);
} }
} }

View File

@ -0,0 +1,59 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node;
use PhpParser\Node\Stmt;
class Namespace_ extends PhpParser\BuilderAbstract
{
private $name;
private $stmts = array();
/**
* Creates a namespace builder.
*
* @param Node\Name|string|null $name Name of the namespace
*/
public function __construct($name) {
$this->name = null !== $name ? $this->normalizeName($name) : null;
}
/**
* Adds a statement.
*
* @param Node|PhpParser\Builder $stmt The statement to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmt($stmt) {
$this->stmts[] = $this->normalizeNode($stmt);
return $this;
}
/**
* Adds multiple statements.
*
* @param array $stmts The statements to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmts(array $stmts) {
foreach ($stmts as $stmt) {
$this->addStmt($stmt);
}
return $this;
}
/**
* Returns the built node.
*
* @return Node The built node
*/
public function getNode() {
return new Stmt\Namespace_($this->name, $this->stmts);
}
}

View File

@ -9,9 +9,9 @@ class Param extends PhpParser\BuilderAbstract
{ {
protected $name; protected $name;
protected $default; protected $default = null;
protected $type; protected $type = null;
protected $byRef; protected $byRef = false;
/** /**
* Creates a parameter builder. * Creates a parameter builder.
@ -20,10 +20,6 @@ class Param extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->default = null;
$this->type = null;
$this->byRef = false;
} }
/** /**
@ -31,7 +27,7 @@ class Param extends PhpParser\BuilderAbstract
* *
* @param mixed $value Default value to use * @param mixed $value Default value to use
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function setDefault($value) { public function setDefault($value) {
$this->default = $this->normalizeValue($value); $this->default = $this->normalizeValue($value);
@ -44,10 +40,10 @@ class Param extends PhpParser\BuilderAbstract
* *
* @param string|Node\Name $type Type hint to use * @param string|Node\Name $type Type hint to use
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function setTypeHint($type) { public function setTypeHint($type) {
if ($type === 'array' || $type === 'callable') { if (in_array($type, array('array', 'callable', 'string', 'int', 'float', 'bool'))) {
$this->type = $type; $this->type = $type;
} else { } else {
$this->type = $this->normalizeName($type); $this->type = $this->normalizeName($type);
@ -59,7 +55,7 @@ class Param extends PhpParser\BuilderAbstract
/** /**
* Make the parameter accept the value by reference. * Make the parameter accept the value by reference.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeByRef() { public function makeByRef() {
$this->byRef = true; $this->byRef = true;

View File

@ -9,8 +9,9 @@ class Property extends PhpParser\BuilderAbstract
{ {
protected $name; protected $name;
protected $type; protected $type = 0;
protected $default; protected $default = null;
protected $attributes = array();
/** /**
* Creates a property builder. * Creates a property builder.
@ -19,15 +20,12 @@ class Property extends PhpParser\BuilderAbstract
*/ */
public function __construct($name) { public function __construct($name) {
$this->name = $name; $this->name = $name;
$this->type = 0;
$this->default = null;
} }
/** /**
* Makes the property public. * Makes the property public.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePublic() { public function makePublic() {
$this->setModifier(Stmt\Class_::MODIFIER_PUBLIC); $this->setModifier(Stmt\Class_::MODIFIER_PUBLIC);
@ -38,7 +36,7 @@ class Property extends PhpParser\BuilderAbstract
/** /**
* Makes the property protected. * Makes the property protected.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeProtected() { public function makeProtected() {
$this->setModifier(Stmt\Class_::MODIFIER_PROTECTED); $this->setModifier(Stmt\Class_::MODIFIER_PROTECTED);
@ -49,7 +47,7 @@ class Property extends PhpParser\BuilderAbstract
/** /**
* Makes the property private. * Makes the property private.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makePrivate() { public function makePrivate() {
$this->setModifier(Stmt\Class_::MODIFIER_PRIVATE); $this->setModifier(Stmt\Class_::MODIFIER_PRIVATE);
@ -60,7 +58,7 @@ class Property extends PhpParser\BuilderAbstract
/** /**
* Makes the property static. * Makes the property static.
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function makeStatic() { public function makeStatic() {
$this->setModifier(Stmt\Class_::MODIFIER_STATIC); $this->setModifier(Stmt\Class_::MODIFIER_STATIC);
@ -73,7 +71,7 @@ class Property extends PhpParser\BuilderAbstract
* *
* @param mixed $value Default value to use * @param mixed $value Default value to use
* *
* @return self The builder instance (for fluid interface) * @return $this The builder instance (for fluid interface)
*/ */
public function setDefault($value) { public function setDefault($value) {
$this->default = $this->normalizeValue($value); $this->default = $this->normalizeValue($value);
@ -81,6 +79,21 @@ class Property extends PhpParser\BuilderAbstract
return $this; return $this;
} }
/**
* Sets doc comment for the property.
*
* @param PhpParser\Comment\Doc|string $docComment Doc comment to set
*
* @return $this The builder instance (for fluid interface)
*/
public function setDocComment($docComment) {
$this->attributes = array(
'comments' => array($this->normalizeDocComment($docComment))
);
return $this;
}
/** /**
* Returns the built class node. * Returns the built class node.
* *
@ -91,7 +104,8 @@ class Property extends PhpParser\BuilderAbstract
$this->type !== 0 ? $this->type : Stmt\Class_::MODIFIER_PUBLIC, $this->type !== 0 ? $this->type : Stmt\Class_::MODIFIER_PUBLIC,
array( array(
new Stmt\PropertyProperty($this->name, $this->default) new Stmt\PropertyProperty($this->name, $this->default)
) ),
$this->attributes
); );
} }
} }

View File

@ -0,0 +1,55 @@
<?php
namespace PhpParser\Builder;
use PhpParser;
use PhpParser\Node\Name;
use PhpParser\Node\Stmt;
class Trait_ extends Declaration
{
protected $name;
protected $properties = array();
protected $methods = array();
/**
* Creates an interface builder.
*
* @param string $name Name of the interface
*/
public function __construct($name) {
$this->name = $name;
}
/**
* Adds a statement.
*
* @param Stmt|PhpParser\Builder $stmt The statement to add
*
* @return $this The builder instance (for fluid interface)
*/
public function addStmt($stmt) {
$stmt = $this->normalizeNode($stmt);
if ($stmt instanceof Stmt\Property) {
$this->properties[] = $stmt;
} else if ($stmt instanceof Stmt\ClassMethod) {
$this->methods[] = $stmt;
} else {
throw new \LogicException(sprintf('Unexpected node of type "%s"', $stmt->getType()));
}
return $this;
}
/**
* Returns the built trait node.
*
* @return Stmt\Trait_ The built interface node
*/
public function getNode() {
return new Stmt\Trait_(
$this->name, array_merge($this->properties, $this->methods), $this->attributes
);
}
}

View File

@ -0,0 +1,58 @@
<?php
namespace PhpParser\Builder;
use PhpParser\BuilderAbstract;
use PhpParser\Node;
use PhpParser\Node\Stmt;
/**
* @method $this as(string $alias) Sets alias for used name.
*/
class Use_ extends BuilderAbstract {
protected $name;
protected $type;
protected $alias = null;
/**
* Creates a name use (alias) builder.
*
* @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
*/
public function __construct($name, $type) {
$this->name = $this->normalizeName($name);
$this->type = $type;
}
/**
* Sets alias for used name.
*
* @param string $alias Alias to use (last component of full name by default)
*
* @return $this The builder instance (for fluid interface)
*/
protected function as_($alias) {
$this->alias = $alias;
return $this;
}
public function __call($name, $args) {
if (method_exists($this, $name . '_')) {
return call_user_func_array(array($this, $name . '_'), $args);
}
throw new \LogicException(sprintf('Method "%s" does not exist', $name));
}
/**
* Returns the built node.
*
* @return Node The built node
*/
public function getNode() {
$alias = null !== $this->alias ? $this->alias : $this->name->getLast();
return new Stmt\Use_(array(
new Stmt\UseUse($this->name, $alias)
), $this->type);
}
}

View File

@ -6,6 +6,7 @@ use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\Stmt; use PhpParser\Node\Stmt;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
use PhpParser\Comment;
abstract class BuilderAbstract implements Builder { abstract class BuilderAbstract implements Builder {
/** /**
@ -35,9 +36,21 @@ abstract class BuilderAbstract implements Builder {
protected function normalizeName($name) { protected function normalizeName($name) {
if ($name instanceof Name) { if ($name instanceof Name) {
return $name; return $name;
} else { } elseif (is_string($name)) {
return new Name($name); if (!$name) {
throw new \LogicException('Name cannot be empty');
}
if ($name[0] == '\\') {
return new Name\FullyQualified(substr($name, 1));
} elseif (0 === strpos($name, 'namespace\\')) {
return new Name\Relative(substr($name, strlen('namespace\\')));
} else {
return new Name($name);
}
} }
throw new \LogicException('Name must be a string or an instance of PhpParser\Node\Name');
} }
/** /**
@ -64,7 +77,7 @@ abstract class BuilderAbstract implements Builder {
} elseif (is_float($value)) { } elseif (is_float($value)) {
return new Scalar\DNumber($value); return new Scalar\DNumber($value);
} elseif (is_string($value)) { } elseif (is_string($value)) {
return new Scalar\String($value); return new Scalar\String_($value);
} elseif (is_array($value)) { } elseif (is_array($value)) {
$items = array(); $items = array();
$lastKey = -1; $lastKey = -1;
@ -89,6 +102,23 @@ abstract class BuilderAbstract implements Builder {
} }
} }
/**
* Normalizes a doc comment: Converts plain strings to PhpParser\Comment\Doc.
*
* @param Comment\Doc|string $docComment The doc comment to normalize
*
* @return Comment\Doc The normalized doc comment
*/
protected function normalizeDocComment($docComment) {
if ($docComment instanceof Comment\Doc) {
return $docComment;
} else if (is_string($docComment)) {
return new Comment\Doc($docComment);
} else {
throw new \LogicException('Doc comment must be a string or an instance of PhpParser\Comment\Doc');
}
}
/** /**
* Sets a modifier in the $this->type property. * Sets a modifier in the $this->type property.
* *

View File

@ -3,18 +3,32 @@
namespace PhpParser; namespace PhpParser;
use PhpParser\Builder; use PhpParser\Builder;
use PhpParser\Node\Stmt\Use_;
/** /**
* "class", "interface" and "function" are reserved keywords, so the methods are defined as _class(), * The following methods use reserved keywords, so their implementation is defined with an underscore and made available
* _interface() and _function() in the class and are made available as class(), interface() and function() * with the reserved name through __call() magic.
* through __call() magic.
* *
* @method Builder\Namespace_ namespace(string $name) Creates a namespace builder.
* @method Builder\Class_ class(string $name) Creates a class builder. * @method Builder\Class_ class(string $name) Creates a class builder.
* @method Builder\Function_ function(string $name) Creates a function builder
* @method Builder\Interface_ interface(string $name) Creates an interface builder. * @method Builder\Interface_ interface(string $name) Creates an interface builder.
* @method Builder\Trait_ trait(string $name) Creates a trait builder.
* @method Builder\Function_ function(string $name) Creates a function builder.
* @method Builder\Use_ use(string $name) Creates a namespace/class use builder.
*/ */
class BuilderFactory class BuilderFactory
{ {
/**
* Creates a namespace builder.
*
* @param null|string|Node\Name $name Name of the namespace
*
* @return Builder\Namespace_ The created namespace builder
*/
protected function _namespace($name) {
return new Builder\Namespace_($name);
}
/** /**
* Creates a class builder. * Creates a class builder.
* *
@ -27,7 +41,7 @@ class BuilderFactory
} }
/** /**
* Creates a interface builder. * Creates an interface builder.
* *
* @param string $name Name of the interface * @param string $name Name of the interface
* *
@ -37,6 +51,17 @@ class BuilderFactory
return new Builder\Interface_($name); return new Builder\Interface_($name);
} }
/**
* Creates a trait builder.
*
* @param string $name Name of the trait
*
* @return Builder\Trait_ The created trait builder
*/
protected function _trait($name) {
return new Builder\Trait_($name);
}
/** /**
* Creates a method builder. * Creates a method builder.
* *
@ -81,6 +106,17 @@ class BuilderFactory
return new Builder\Function_($name); return new Builder\Function_($name);
} }
/**
* Creates a namespace/class use builder.
*
* @param string|Node\Name Name to alias
*
* @return Builder\Use_ The create use builder
*/
protected function _use($name) {
return new Builder\Use_($name, Use_::TYPE_NORMAL);
}
public function __call($name, array $args) { public function __call($name, array $args) {
if (method_exists($this, '_' . $name)) { if (method_exists($this, '_' . $name)) {
return call_user_func_array(array($this, '_' . $name), $args); return call_user_func_array(array($this, '_' . $name), $args);

View File

@ -6,16 +6,19 @@ class Comment
{ {
protected $text; protected $text;
protected $line; protected $line;
protected $filePos;
/** /**
* 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 $line Line number the comment started on * @param int $startLine Line number the comment started on
* @param int $startFilePos File offset the comment started on
*/ */
public function __construct($text, $line = -1) { public function __construct($text, $startLine = -1, $startFilePos = -1) {
$this->text = $text; $this->text = $text;
$this->line = $line; $this->line = $startLine;
$this->filePos = $startFilePos;
} }
/** /**
@ -31,6 +34,8 @@ class Comment
* Sets the comment text. * Sets the comment text.
* *
* @param string $text The comment text (including comment delimiters like /*) * @param string $text The comment text (including comment delimiters like /*)
*
* @deprecated Construct a new comment instead
*/ */
public function setText($text) { public function setText($text) {
$this->text = $text; $this->text = $text;
@ -49,11 +54,22 @@ class Comment
* Sets the line number the comment started on. * Sets the line number the comment started on.
* *
* @param int $line Line number * @param int $line Line number
*
* @deprecated Construct a new comment instead
*/ */
public function setLine($line) { public function setLine($line) {
$this->line = $line; $this->line = $line;
} }
/**
* Gets the file offset the comment started on.
*
* @return int File offset
*/
public function getFilePos() {
return $this->filePos;
}
/** /**
* Gets the comment text. * Gets the comment text.
* *
@ -75,7 +91,8 @@ class Comment
*/ */
public function getReformattedText() { public function getReformattedText() {
$text = trim($this->text); $text = trim($this->text);
if (false === strpos($text, "\n")) { $newlinePos = strpos($text, "\n");
if (false === $newlinePos) {
// Single line comments don't need further processing // Single line comments don't need further processing
return $text; return $text;
} elseif (preg_match('((*BSR_ANYCRLF)(*ANYCRLF)^.*(?:\R\s+\*.*)+$)', $text)) { } elseif (preg_match('((*BSR_ANYCRLF)(*ANYCRLF)^.*(?:\R\s+\*.*)+$)', $text)) {
@ -105,15 +122,30 @@ class Comment
// //
// /* Some text. // /* Some text.
// Some more text. // Some more text.
// Indented text.
// Even more text. */ // Even more text. */
// //
// is handled by taking the length of the "/* " segment and leaving only that // is handled by removing the difference between the shortest whitespace prefix on all
// many space characters before the lines. Thus in the above example only three // lines and the length of the "/* " opening sequence.
// space characters are left at the start of every line. $prefixLen = $this->getShortestWhitespacePrefixLen(substr($text, $newlinePos + 1));
return preg_replace('(^\s*(?= {' . strlen($matches[0]) . '}(?!\s)))m', '', $text); $removeLen = $prefixLen - strlen($matches[0]);
return preg_replace('(^\s{' . $removeLen . '})m', '', $text);
} }
// No idea how to format this comment, so simply return as is // No idea how to format this comment, so simply return as is
return $text; return $text;
} }
private function getShortestWhitespacePrefixLen($str) {
$lines = explode("\n", $str);
$shortestPrefixLen = INF;
foreach ($lines as $line) {
preg_match('(^\s*)', $line, $matches);
$prefixLen = strlen($matches[0]);
if ($prefixLen < $shortestPrefixLen) {
$shortestPrefixLen = $prefixLen;
}
}
return $shortestPrefixLen;
}
} }

View File

@ -5,17 +5,22 @@ namespace PhpParser;
class Error extends \RuntimeException class Error extends \RuntimeException
{ {
protected $rawMessage; protected $rawMessage;
protected $rawLine; protected $attributes;
/** /**
* Creates an Exception signifying a parse error. * Creates an Exception signifying a parse error.
* *
* @param string $message Error message * @param string $message Error message
* @param int $line Error line in PHP file * @param array|int $attributes Attributes of node/token where error occurred
* (or start line of error -- deprecated)
*/ */
public function __construct($message, $line = -1) { public function __construct($message, $attributes = array()) {
$this->rawMessage = (string) $message; $this->rawMessage = (string) $message;
$this->rawLine = (int) $line; if (is_array($attributes)) {
$this->attributes = $attributes;
} else {
$this->attributes = array('startLine' => $attributes);
}
$this->updateMessage(); $this->updateMessage();
} }
@ -28,6 +33,34 @@ class Error extends \RuntimeException
return $this->rawMessage; return $this->rawMessage;
} }
/**
* Gets the line the error starts in.
*
* @return int Error start line
*/
public function getStartLine() {
return isset($this->attributes['startLine']) ? $this->attributes['startLine'] : -1;
}
/**
* Gets the line the error ends in.
*
* @return int Error end line
*/
public function getEndLine() {
return isset($this->attributes['endLine']) ? $this->attributes['endLine'] : -1;
}
/**
* Gets the attributes of the node/token the error occurred at.
*
* @return array
*/
public function getAttributes() {
return $this->attributes;
}
/** /**
* Sets the line of the PHP file the error occurred in. * Sets the line of the PHP file the error occurred in.
* *
@ -39,22 +72,65 @@ class Error extends \RuntimeException
} }
/** /**
* Gets the error line in the PHP file. * Sets the line the error starts in.
* *
* @return int Error line in the PHP file * @param int $line Error start line
*/ */
public function getRawLine() { public function setStartLine($line) {
return $this->rawLine; $this->attributes['startLine'] = (int) $line;
$this->updateMessage();
} }
/** /**
* Sets the line of the PHP file the error occurred in. * Returns whether the error has start and end column information.
* *
* @param int $line Error line in the PHP file * For column information enable the startFilePos and endFilePos in the lexer options.
*
* @return bool
*/ */
public function setRawLine($line) { public function hasColumnInfo() {
$this->rawLine = (int) $line; return isset($this->attributes['startFilePos']) && isset($this->attributes['endFilePos']);
$this->updateMessage(); }
/**
* Gets the start column (1-based) into the line where the error started.
*
* @param string $code Source code of the file
* @return int
*/
public function getStartColumn($code) {
if (!$this->hasColumnInfo()) {
throw new \RuntimeException('Error does not have column information');
}
return $this->toColumn($code, $this->attributes['startFilePos']);
}
/**
* Gets the end column (1-based) into the line where the error ended.
*
* @param string $code Source code of the file
* @return int
*/
public function getEndColumn($code) {
if (!$this->hasColumnInfo()) {
throw new \RuntimeException('Error does not have column information');
}
return $this->toColumn($code, $this->attributes['endFilePos']);
}
private function toColumn($code, $pos) {
if ($pos > strlen($code)) {
throw new \RuntimeException('Invalid position information');
}
$lineStartPos = strrpos($code, "\n", $pos - strlen($code));
if (false === $lineStartPos) {
$lineStartPos = -1;
}
return $pos - $lineStartPos;
} }
/** /**
@ -63,10 +139,20 @@ class Error extends \RuntimeException
protected function updateMessage() { protected function updateMessage() {
$this->message = $this->rawMessage; $this->message = $this->rawMessage;
if (-1 === $this->rawLine) { if (-1 === $this->getStartLine()) {
$this->message .= ' on unknown line'; $this->message .= ' on unknown line';
} else { } else {
$this->message .= ' on line ' . $this->rawLine; $this->message .= ' on line ' . $this->getStartLine();
} }
} }
/** @deprecated Use getStartLine() instead */
public function getRawLine() {
return $this->getStartLine();
}
/** @deprecated Use setStartLine() instead */
public function setRawLine($line) {
$this->setStartLine($line);
}
} }

View File

@ -2,26 +2,47 @@
namespace PhpParser; namespace PhpParser;
use PhpParser\Node\Scalar\LNumber;
use PhpParser\Parser\Tokens;
class Lexer class Lexer
{ {
protected $code; protected $code;
protected $tokens; protected $tokens;
protected $pos; protected $pos;
protected $line; protected $line;
protected $filePos;
protected $tokenMap; protected $tokenMap;
protected $dropTokens; protected $dropTokens;
protected $usedAttributes;
/** /**
* Creates a Lexer. * Creates a Lexer.
*
* @param array $options Options array. Currently only the 'usedAttributes' option is supported,
* which is an array of attributes to add to the AST nodes. Possible
* attributes are: 'comments', 'startLine', 'endLine', 'startTokenPos',
* 'endTokenPos', 'startFilePos', 'endFilePos'. The option defaults to the
* first three. For more info see getNextToken() docs.
*/ */
public function __construct() { public function __construct(array $options = array()) {
// map from internal tokens to PhpParser tokens // map from internal tokens to PhpParser tokens
$this->tokenMap = $this->createTokenMap(); $this->tokenMap = $this->createTokenMap();
// map of tokens to drop while lexing (the map is only used for isset lookup, // 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.) // that's why the value is simply set to 1; the value is never actually used.)
$this->dropTokens = array_fill_keys(array(T_WHITESPACE, T_OPEN_TAG), 1); $this->dropTokens = array_fill_keys(
array(T_WHITESPACE, T_OPEN_TAG, T_COMMENT, T_DOC_COMMENT), 1
);
// the usedAttributes member is a map of the used attribute names to a dummy
// value (here "true")
$options += array(
'usedAttributes' => array('comments', 'startLine', 'endLine'),
);
$this->usedAttributes = array_fill_keys($options['usedAttributes'], true);
} }
/** /**
@ -32,34 +53,44 @@ class Lexer
* @throws Error on lexing errors (unterminated comment or unexpected character) * @throws Error on lexing errors (unterminated comment or unexpected character)
*/ */
public function startLexing($code) { public function startLexing($code) {
$scream = ini_set('xdebug.scream', 0); $scream = ini_set('xdebug.scream', '0');
$this->resetErrors(); $this->resetErrors();
$this->tokens = @token_get_all($code); $this->tokens = @token_get_all($code);
$this->handleErrors(); $this->handleErrors();
ini_set('xdebug.scream', $scream); if (false !== $scream) {
ini_set('xdebug.scream', $scream);
}
$this->code = $code; // keep the code around for __halt_compiler() handling $this->code = $code; // keep the code around for __halt_compiler() handling
$this->pos = -1; $this->pos = -1;
$this->line = 1; $this->line = 1;
$this->filePos = 0;
} }
protected function resetErrors() { protected function resetErrors() {
// set error_get_last() to defined state by forcing an undefined variable error if (function_exists('error_clear_last')) {
set_error_handler(function() { return false; }, 0); error_clear_last();
@$undefinedVariable; } else {
restore_error_handler(); // set error_get_last() to defined state by forcing an undefined variable error
set_error_handler(function() { return false; }, 0);
@$undefinedVariable;
restore_error_handler();
}
} }
protected function handleErrors() { protected function handleErrors() {
$error = error_get_last(); $error = error_get_last();
if (null === $error) {
return;
}
if (preg_match( if (preg_match(
'~^Unterminated comment starting line ([0-9]+)$~', '~^Unterminated comment starting line ([0-9]+)$~',
$error['message'], $matches $error['message'], $matches
)) { )) {
throw new Error('Unterminated comment', $matches[1]); throw new Error('Unterminated comment', (int) $matches[1]);
} }
if (preg_match( if (preg_match(
@ -81,6 +112,19 @@ class Lexer
/** /**
* Fetches the next token. * 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 $value Variable to store token content in
* @param mixed $startAttributes Variable to store start attributes in * @param mixed $startAttributes Variable to store start attributes in
* @param mixed $endAttributes Variable to store end attributes in * @param mixed $endAttributes Variable to store end attributes in
@ -91,42 +135,83 @@ class Lexer
$startAttributes = array(); $startAttributes = array();
$endAttributes = array(); $endAttributes = array();
while (isset($this->tokens[++$this->pos])) { while (1) {
$token = $this->tokens[$this->pos]; if (isset($this->tokens[++$this->pos])) {
$token = $this->tokens[$this->pos];
if (is_string($token)) {
$startAttributes['startLine'] = $this->line;
$endAttributes['endLine'] = $this->line;
// bug in token_get_all
if ('b"' === $token) {
$value = 'b"';
return ord('"');
} else {
$value = $token;
return ord($token);
}
} else { } else {
$this->line += substr_count($token[1], "\n"); // EOF token with ID 0
$token = "\0";
if (T_COMMENT === $token[0]) {
$startAttributes['comments'][] = new Comment($token[1], $token[2]);
} elseif (T_DOC_COMMENT === $token[0]) {
$startAttributes['comments'][] = new Comment\Doc($token[1], $token[2]);
} elseif (!isset($this->dropTokens[$token[0]])) {
$value = $token[1];
$startAttributes['startLine'] = $token[2];
$endAttributes['endLine'] = $this->line;
return $this->tokenMap[$token[0]];
}
} }
if (isset($this->usedAttributes['startLine'])) {
$startAttributes['startLine'] = $this->line;
}
if (isset($this->usedAttributes['startTokenPos'])) {
$startAttributes['startTokenPos'] = $this->pos;
}
if (isset($this->usedAttributes['startFilePos'])) {
$startAttributes['startFilePos'] = $this->filePos;
}
if (\is_string($token)) {
$value = $token;
if (isset($token[1])) {
// bug in token_get_all
$this->filePos += 2;
$id = ord('"');
} else {
$this->filePos += 1;
$id = ord($token);
}
} elseif (!isset($this->dropTokens[$token[0]])) {
$value = $token[1];
$id = $this->tokenMap[$token[0]];
$this->line += substr_count($value, "\n");
$this->filePos += \strlen($value);
} else {
if (T_COMMENT === $token[0] || T_DOC_COMMENT === $token[0]) {
if (isset($this->usedAttributes['comments'])) {
$comment = T_DOC_COMMENT === $token[0]
? new Comment\Doc($token[1], $this->line, $this->filePos)
: new Comment($token[1], $this->line, $this->filePos);
$startAttributes['comments'][] = $comment;
}
}
$this->line += substr_count($token[1], "\n");
$this->filePos += \strlen($token[1]);
continue;
}
if (isset($this->usedAttributes['endLine'])) {
$endAttributes['endLine'] = $this->line;
}
if (isset($this->usedAttributes['endTokenPos'])) {
$endAttributes['endTokenPos'] = $this->pos;
}
if (isset($this->usedAttributes['endFilePos'])) {
$endAttributes['endFilePos'] = $this->filePos - 1;
}
return $id;
} }
$startAttributes['startLine'] = $this->line; throw new \RuntimeException('Reached end of lexer loop');
}
// 0 is the EOF token /**
return 0; * Returns the token array for current code.
*
* The token array is in the same format as provided by the
* token_get_all() function and does not discard tokens (i.e.
* whitespace and comments are included). The token position
* attributes are against this token array.
*
* @return array Array of tokens in token_get_all() format
*/
public function getTokens() {
return $this->tokens;
} }
/** /**
@ -135,23 +220,13 @@ class Lexer
* @return string Remaining text * @return string Remaining text
*/ */
public function handleHaltCompiler() { public function handleHaltCompiler() {
// get the length of the text before the T_HALT_COMPILER token
$textBefore = '';
for ($i = 0; $i <= $this->pos; ++$i) {
if (is_string($this->tokens[$i])) {
$textBefore .= $this->tokens[$i];
} else {
$textBefore .= $this->tokens[$i][1];
}
}
// text after T_HALT_COMPILER, still including (); // text after T_HALT_COMPILER, still including ();
$textAfter = substr($this->code, strlen($textBefore)); $textAfter = substr($this->code, $this->filePos);
// ensure that it is followed by (); // ensure that it is followed by ();
// this simplifies the situation, by not allowing any comments // this simplifies the situation, by not allowing any comments
// in between of the tokens. // in between of the tokens.
if (!preg_match('~\s*\(\s*\)\s*(?:;|\?>\r?\n?)~', $textAfter, $matches)) { if (!preg_match('~^\s*\(\s*\)\s*(?:;|\?>\r?\n?)~', $textAfter, $matches)) {
throw new Error('__HALT_COMPILER must be followed by "();"'); throw new Error('__HALT_COMPILER must be followed by "();"');
} }
@ -177,26 +252,33 @@ class Lexer
// 256 is the minimum possible token number, as everything below // 256 is the minimum possible token number, as everything below
// it is an ASCII value // it is an ASCII value
for ($i = 256; $i < 1000; ++$i) { for ($i = 256; $i < 1000; ++$i) {
// T_DOUBLE_COLON is equivalent to T_PAAMAYIM_NEKUDOTAYIM
if (T_DOUBLE_COLON === $i) { if (T_DOUBLE_COLON === $i) {
$tokenMap[$i] = Parser::T_PAAMAYIM_NEKUDOTAYIM; // T_DOUBLE_COLON is equivalent to T_PAAMAYIM_NEKUDOTAYIM
// T_OPEN_TAG_WITH_ECHO with dropped T_OPEN_TAG results in T_ECHO $tokenMap[$i] = Tokens::T_PAAMAYIM_NEKUDOTAYIM;
} elseif(T_OPEN_TAG_WITH_ECHO === $i) { } elseif(T_OPEN_TAG_WITH_ECHO === $i) {
$tokenMap[$i] = Parser::T_ECHO; // T_OPEN_TAG_WITH_ECHO with dropped T_OPEN_TAG results in T_ECHO
// T_CLOSE_TAG is equivalent to ';' $tokenMap[$i] = Tokens::T_ECHO;
} elseif(T_CLOSE_TAG === $i) { } elseif(T_CLOSE_TAG === $i) {
// T_CLOSE_TAG is equivalent to ';'
$tokenMap[$i] = ord(';'); $tokenMap[$i] = ord(';');
// and the others can be mapped directly } elseif ('UNKNOWN' !== $name = token_name($i)) {
} elseif ('UNKNOWN' !== ($name = token_name($i)) if ('T_HASHBANG' === $name) {
&& defined($name = 'PhpParser\Parser::' . $name) // HHVM uses a special token for #! hashbang lines
) { $tokenMap[$i] = Tokens::T_INLINE_HTML;
$tokenMap[$i] = constant($name); } else if (defined($name = 'PhpParser\Parser\Tokens::' . $name)) {
// Other tokens can be mapped directly
$tokenMap[$i] = constant($name);
}
} }
} }
// HHVM uses a special token for numbers that overflow to double // HHVM uses a special token for numbers that overflow to double
if (defined('T_ONUMBER')) { if (defined('T_ONUMBER')) {
$tokenMap[T_ONUMBER] = Parser::T_DNUMBER; $tokenMap[T_ONUMBER] = Tokens::T_DNUMBER;
}
// HHVM also has a separate token for the __COMPILER_HALT_OFFSET__ constant
if (defined('T_COMPILER_HALT_OFFSET')) {
$tokenMap[T_COMPILER_HALT_OFFSET] = Tokens::T_STRING;
} }
return $tokenMap; return $tokenMap;

View File

@ -2,7 +2,7 @@
namespace PhpParser\Lexer; namespace PhpParser\Lexer;
use PhpParser\Parser; use PhpParser\Parser\Tokens;
/** /**
* ATTENTION: This code is WRITE-ONLY. Do not try to read it. * ATTENTION: This code is WRITE-ONLY. Do not try to read it.
@ -12,27 +12,24 @@ class Emulative extends \PhpParser\Lexer
protected $newKeywords; protected $newKeywords;
protected $inObjectAccess; protected $inObjectAccess;
const T_ELLIPSIS = 1001; const T_ELLIPSIS = 1001;
const T_POW = 1002; const T_POW = 1002;
const T_POW_EQUAL = 1003; const T_POW_EQUAL = 1003;
const T_COALESCE = 1004;
const T_SPACESHIP = 1005;
const T_YIELD_FROM = 1006;
const PHP_7_0 = '7.0.0dev';
const PHP_5_6 = '5.6.0rc1'; const PHP_5_6 = '5.6.0rc1';
const PHP_5_5 = '5.5.0beta1'; const PHP_5_5 = '5.5.0beta1';
const PHP_5_4 = '5.4.0beta1';
public function __construct() { public function __construct(array $options = array()) {
parent::__construct(); parent::__construct($options);
$newKeywordsPerVersion = array( $newKeywordsPerVersion = array(
self::PHP_5_5 => array( self::PHP_5_5 => array(
'finally' => Parser::T_FINALLY, 'finally' => Tokens::T_FINALLY,
'yield' => Parser::T_YIELD, 'yield' => Tokens::T_YIELD,
),
self::PHP_5_4 => array(
'callable' => Parser::T_CALLABLE,
'insteadof' => Parser::T_INSTEADOF,
'trait' => Parser::T_TRAIT,
'__trait__' => Parser::T_TRAIT_C,
), ),
); );
@ -45,11 +42,19 @@ class Emulative extends \PhpParser\Lexer
$this->newKeywords += $newKeywords; $this->newKeywords += $newKeywords;
} }
if (version_compare(PHP_VERSION, self::PHP_5_6, '<')) { if (version_compare(PHP_VERSION, self::PHP_7_0, '>=')) {
$this->tokenMap[self::T_ELLIPSIS] = Parser::T_ELLIPSIS; return;
$this->tokenMap[self::T_POW] = Parser::T_POW;
$this->tokenMap[self::T_POW_EQUAL] = Parser::T_POW_EQUAL;
} }
$this->tokenMap[self::T_COALESCE] = Tokens::T_COALESCE;
$this->tokenMap[self::T_SPACESHIP] = Tokens::T_SPACESHIP;
$this->tokenMap[self::T_YIELD_FROM] = Tokens::T_YIELD_FROM;
if (version_compare(PHP_VERSION, self::PHP_5_6, '>=')) {
return;
}
$this->tokenMap[self::T_ELLIPSIS] = Tokens::T_ELLIPSIS;
$this->tokenMap[self::T_POW] = Tokens::T_POW;
$this->tokenMap[self::T_POW_EQUAL] = Tokens::T_POW_EQUAL;
} }
public function startLexing($code) { public function startLexing($code) {
@ -60,6 +65,10 @@ class Emulative extends \PhpParser\Lexer
if ($preprocessedCode !== $code) { if ($preprocessedCode !== $code) {
$this->postprocessTokens(); $this->postprocessTokens();
} }
// Set code property back to the original code, so __halt_compiler()
// handling and (start|end)FilePos attributes use the correct offsets
$this->code = $code;
} }
/* /*
@ -71,6 +80,17 @@ class Emulative extends \PhpParser\Lexer
* inside a string, i.e. a place where they don't have a special meaning). * inside a string, i.e. a place where they don't have a special meaning).
*/ */
protected function preprocessCode($code) { protected function preprocessCode($code) {
if (version_compare(PHP_VERSION, self::PHP_7_0, '>=')) {
return $code;
}
$code = str_replace('??', '~__EMU__COALESCE__~', $code);
$code = str_replace('<=>', '~__EMU__SPACESHIP__~', $code);
$code = preg_replace_callback('(yield[ \n\r\t]+from)', function($matches) {
// Encoding $0 in order to preserve exact whitespace
return '~__EMU__YIELDFROM__' . bin2hex($matches[0]) . '__~';
}, $code);
if (version_compare(PHP_VERSION, self::PHP_5_6, '>=')) { if (version_compare(PHP_VERSION, self::PHP_5_6, '>=')) {
return $code; return $code;
} }
@ -79,12 +99,7 @@ class Emulative extends \PhpParser\Lexer
$code = preg_replace('((?<!/)\*\*=)', '~__EMU__POWEQUAL__~', $code); $code = preg_replace('((?<!/)\*\*=)', '~__EMU__POWEQUAL__~', $code);
$code = preg_replace('((?<!/)\*\*(?!/))', '~__EMU__POW__~', $code); $code = preg_replace('((?<!/)\*\*(?!/))', '~__EMU__POW__~', $code);
if (version_compare(PHP_VERSION, self::PHP_5_4, '>=')) { return $code;
return $code;
}
// binary notation (0b010101101001...)
return preg_replace('(\b0b[01]+\b)', '~__EMU__BINARY__$0__~', $code);
} }
/* /*
@ -103,13 +118,7 @@ class Emulative extends \PhpParser\Lexer
&& T_STRING === $this->tokens[$i + 1][0] && T_STRING === $this->tokens[$i + 1][0]
&& preg_match('(^__EMU__([A-Z]++)__(?:([A-Za-z0-9]++)__)?$)', $this->tokens[$i + 1][1], $matches) && preg_match('(^__EMU__([A-Z]++)__(?:([A-Za-z0-9]++)__)?$)', $this->tokens[$i + 1][1], $matches)
) { ) {
if ('BINARY' === $matches[1]) { if ('ELLIPSIS' === $matches[1]) {
// the binary number can either be an integer or a double, so return a LNUMBER
// or DNUMBER respectively
$replace = array(
array(is_int(bindec($matches[2])) ? T_LNUMBER : T_DNUMBER, $matches[2], $this->tokens[$i + 1][2])
);
} else if ('ELLIPSIS' === $matches[1]) {
$replace = array( $replace = array(
array(self::T_ELLIPSIS, '...', $this->tokens[$i + 1][2]) array(self::T_ELLIPSIS, '...', $this->tokens[$i + 1][2])
); );
@ -121,9 +130,21 @@ class Emulative extends \PhpParser\Lexer
$replace = array( $replace = array(
array(self::T_POW_EQUAL, '**=', $this->tokens[$i + 1][2]) array(self::T_POW_EQUAL, '**=', $this->tokens[$i + 1][2])
); );
} else if ('COALESCE' === $matches[1]) {
$replace = array(
array(self::T_COALESCE, '??', $this->tokens[$i + 1][2])
);
} else if ('SPACESHIP' === $matches[1]) {
$replace = array(
array(self::T_SPACESHIP, '<=>', $this->tokens[$i + 1][2]),
);
} else if ('YIELDFROM' === $matches[1]) {
$content = hex2bin($matches[2]);
$replace = array(
array(self::T_YIELD_FROM, $content, $this->tokens[$i + 1][2] - substr_count($content, "\n"))
);
} else { } else {
// just ignore all other __EMU__ sequences throw new \RuntimeException('Invalid __EMU__ sequence');
continue;
} }
array_splice($this->tokens, $i, 3, $replace); array_splice($this->tokens, $i, 3, $replace);
@ -147,14 +168,18 @@ class Emulative extends \PhpParser\Lexer
* multichar tokens (like strings) to their original value. * multichar tokens (like strings) to their original value.
*/ */
public function restoreContentCallback(array $matches) { public function restoreContentCallback(array $matches) {
if ('BINARY' === $matches[1]) { if ('ELLIPSIS' === $matches[1]) {
return $matches[2];
} else if ('ELLIPSIS' === $matches[1]) {
return '...'; return '...';
} else if ('POW' === $matches[1]) { } else if ('POW' === $matches[1]) {
return '**'; return '**';
} else if ('POWEQUAL' === $matches[1]) { } else if ('POWEQUAL' === $matches[1]) {
return '**='; return '**=';
} else if ('COALESCE' === $matches[1]) {
return '??';
} else if ('SPACESHIP' === $matches[1]) {
return '<=>';
} else if ('YIELDFROM' === $matches[1]) {
return hex2bin($matches[2]);
} else { } else {
return $matches[0]; return $matches[0];
} }
@ -166,15 +191,13 @@ class Emulative extends \PhpParser\Lexer
// replace new keywords by their respective tokens. This is not done // replace new keywords by their respective tokens. This is not done
// if we currently are in an object access (e.g. in $obj->namespace // if we currently are in an object access (e.g. in $obj->namespace
// "namespace" stays a T_STRING tokens and isn't converted to T_NAMESPACE) // "namespace" stays a T_STRING tokens and isn't converted to T_NAMESPACE)
if (Parser::T_STRING === $token && !$this->inObjectAccess) { if (Tokens::T_STRING === $token && !$this->inObjectAccess) {
if (isset($this->newKeywords[strtolower($value)])) { if (isset($this->newKeywords[strtolower($value)])) {
return $this->newKeywords[strtolower($value)]; return $this->newKeywords[strtolower($value)];
} }
// keep track of whether we currently are in an object access (after ->)
} elseif (Parser::T_OBJECT_OPERATOR === $token) {
$this->inObjectAccess = true;
} else { } else {
$this->inObjectAccess = false; // keep track of whether we currently are in an object access (after ->)
$this->inObjectAccess = Tokens::T_OBJECT_OPERATOR === $token;
} }
return $token; return $token;

View File

@ -4,13 +4,15 @@ namespace PhpParser\Node;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property Expr $value Value to pass
* @property bool $byRef Whether to pass by ref
* @property bool $unpack Whether to unpack the argument
*/
class Arg extends NodeAbstract class Arg extends NodeAbstract
{ {
/** @var Expr Value to pass */
public $value;
/** @var bool Whether to pass by ref */
public $byRef;
/** @var bool Whether to unpack the argument */
public $unpack;
/** /**
* Constructs a function call argument node. * Constructs a function call argument node.
* *
@ -20,13 +22,13 @@ class Arg extends NodeAbstract
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $value, $byRef = false, $unpack = false, array $attributes = array()) { public function __construct(Expr $value, $byRef = false, $unpack = false, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->value = $value;
'value' => $value, $this->byRef = $byRef;
'byRef' => $byRef, $this->unpack = $unpack;
'unpack' => $unpack, }
),
$attributes public function getSubNodeNames() {
); return array('value', 'byRef', 'unpack');
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property string $name Name
* @property Expr $value Value
*/
class Const_ extends NodeAbstract class Const_ extends NodeAbstract
{ {
/** @var string Name */
public $name;
/** @var Expr Value */
public $value;
/** /**
* Constructs a const node for use in class const and const statements. * Constructs a const node for use in class const and const statements.
* *
@ -18,12 +19,12 @@ class Const_ extends NodeAbstract
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, Expr $value, array $attributes = array()) { public function __construct($name, Expr $value, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->name = $name;
'name' => $name, $this->value = $value;
'value' => $value, }
),
$attributes public function getSubNodeNames() {
); return array('name', 'value');
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
* @property null|Expr $dim Array index / dim
*/
class ArrayDimFetch extends Expr class ArrayDimFetch extends Expr
{ {
/** @var Expr Variable */
public $var;
/** @var null|Expr Array index / dim */
public $dim;
/** /**
* Constructs an array index fetch node. * Constructs an array index fetch node.
* *
@ -18,12 +19,12 @@ class ArrayDimFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $dim = null, array $attributes = array()) { public function __construct(Expr $var, Expr $dim = null, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var, $this->dim = $dim;
'dim' => $dim }
),
$attributes public function getSubnodeNames() {
); return array('var', 'dim');
} }
} }

View File

@ -4,13 +4,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $value Value
* @property null|Expr $key Key
* @property bool $byRef Whether to assign by reference
*/
class ArrayItem extends Expr class ArrayItem extends Expr
{ {
/** @var null|Expr Key */
public $key;
/** @var Expr Value */
public $value;
/** @var bool Whether to assign by reference */
public $byRef;
/** /**
* Constructs an array item node. * Constructs an array item node.
* *
@ -20,13 +22,13 @@ class ArrayItem extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $value, Expr $key = null, $byRef = false, array $attributes = array()) { public function __construct(Expr $value, Expr $key = null, $byRef = false, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->key = $key;
'key' => $key, $this->value = $value;
'value' => $value, $this->byRef = $byRef;
'byRef' => $byRef }
),
$attributes public function getSubNodeNames() {
); return array('key', 'value', 'byRef');
} }
} }

View File

@ -4,11 +4,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property ArrayItem[] $items Items
*/
class Array_ extends Expr class Array_ extends Expr
{ {
// For use in "kind" attribute
const KIND_LONG = 1; // array() syntax
const KIND_SHORT = 2; // [] syntax
/** @var ArrayItem[] Items */
public $items;
/** /**
* Constructs an array node. * Constructs an array node.
* *
@ -16,11 +20,11 @@ class Array_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $items = array(), array $attributes = array()) { public function __construct(array $items = array(), array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->items = $items;
'items' => $items }
),
$attributes public function getSubNodeNames() {
); return array('items');
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
* @property Expr $expr Expression
*/
class Assign extends Expr class Assign extends Expr
{ {
/** @var Expr Variable */
public $var;
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an assignment node. * Constructs an assignment node.
* *
@ -18,12 +19,12 @@ class Assign extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = array()) { public function __construct(Expr $var, Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var, $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('var', 'expr');
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
* @property Expr $expr Expression
*/
abstract class AssignOp extends Expr abstract class AssignOp extends Expr
{ {
/** @var Expr Variable */
public $var;
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a compound assignment operation node. * Constructs a compound assignment operation node.
* *
@ -18,12 +19,12 @@ abstract class AssignOp extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = array()) { public function __construct(Expr $var, Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var, $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('var', 'expr');
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable reference is assigned to
* @property Expr $expr Variable which is referenced
*/
class AssignRef extends Expr class AssignRef extends Expr
{ {
/** @var Expr Variable reference is assigned to */
public $var;
/** @var Expr Variable which is referenced */
public $expr;
/** /**
* Constructs an assignment node. * Constructs an assignment node.
* *
@ -18,12 +19,12 @@ class AssignRef extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, Expr $expr, array $attributes = array()) { public function __construct(Expr $var, Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var, $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('var', 'expr');
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/** abstract class BinaryOp extends Expr
* @property Expr $left The left hand side expression
* @property Expr $right The right hand side expression
*/
class BinaryOp extends Expr
{ {
/** @var Expr The left hand side expression */
public $left;
/** @var Expr The right hand side expression */
public $right;
/** /**
* Constructs a bitwise and node. * Constructs a bitwise and node.
* *
@ -18,12 +19,12 @@ class BinaryOp extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $left, Expr $right, array $attributes = array()) { public function __construct(Expr $left, Expr $right, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->left = $left;
'left' => $left, $this->right = $right;
'right' => $right }
),
$attributes public function getSubNodeNames() {
); return array('left', 'right');
} }
} }

View File

@ -0,0 +1,9 @@
<?php
namespace PhpParser\Node\Expr\BinaryOp;
use PhpParser\Node\Expr\BinaryOp;
class Coalesce extends BinaryOp
{
}

View File

@ -0,0 +1,9 @@
<?php
namespace PhpParser\Node\Expr\BinaryOp;
use PhpParser\Node\Expr\BinaryOp;
class Spaceship extends BinaryOp
{
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class BitwiseNot extends Expr class BitwiseNot extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a bitwise not node. * Constructs a bitwise not node.
* *
@ -16,11 +16,11 @@ class BitwiseNot extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class BooleanNot extends Expr class BooleanNot extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a boolean not node. * Constructs a boolean not node.
* *
@ -16,11 +16,11 @@ class BooleanNot extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
abstract class Cast extends Expr abstract class Cast extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a cast node. * Constructs a cast node.
* *
@ -16,11 +16,11 @@ abstract class Cast extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class Int extends Cast class Bool_ extends Cast
{ {
} }

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class Bool extends Cast class Int_ extends Cast
{ {
} }

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class Object extends Cast class Object_ extends Cast
{ {
} }

View File

@ -4,6 +4,6 @@ namespace PhpParser\Node\Expr\Cast;
use PhpParser\Node\Expr\Cast; use PhpParser\Node\Expr\Cast;
class String extends Cast class String_ extends Cast
{ {
} }

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Name|Expr $class Class name
* @property string $name Constant name
*/
class ClassConstFetch extends Expr class ClassConstFetch extends Expr
{ {
/** @var Name|Expr Class name */
public $class;
/** @var string Constant name */
public $name;
/** /**
* Constructs a class const fetch node. * Constructs a class const fetch node.
* *
@ -19,12 +20,12 @@ class ClassConstFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, $name, array $attributes = array()) { public function __construct($class, $name, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->class = $class;
'class' => $class, $this->name = $name;
'name' => $name }
),
$attributes public function getSubNodeNames() {
); return array('class', 'name');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Clone_ extends Expr class Clone_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a clone node. * Constructs a clone node.
* *
@ -16,11 +16,11 @@ class Clone_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,37 +4,62 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
use PhpParser\Node\FunctionLike;
/** class Closure extends Expr implements FunctionLike
* @property Node[] $stmts Statements
* @property Node\Param[] $params Parameters
* @property ClosureUse[] $uses use()s
* @property bool $byRef Whether to return by reference
* @property bool $static Whether the closure is static
*/
class Closure extends Expr
{ {
/** @var bool Whether the closure is static */
public $static;
/** @var bool Whether to return by reference */
public $byRef;
/** @var Node\Param[] Parameters */
public $params;
/** @var ClosureUse[] use()s */
public $uses;
/** @var null|string|Node\Name Return type */
public $returnType;
/** @var Node[] Statements */
public $stmts;
/** /**
* Constructs a lambda function node. * Constructs a lambda function node.
* *
* @param array $subNodes Array of the following optional subnodes: * @param array $subNodes Array of the following optional subnodes:
* 'static' => false : Whether the closure is static * 'static' => false : Whether the closure is static
* 'byRef' => false : Whether to return by reference * 'byRef' => false : Whether to return by reference
* 'params' => array(): Parameters * 'params' => array(): Parameters
* 'uses' => array(): use()s * 'uses' => array(): use()s
* 'stmts' => array(): Statements * 'returnType' => null : Return type
* 'stmts' => array(): Statements
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $subNodes = array(), array $attributes = array()) { public function __construct(array $subNodes = array(), array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->static = isset($subNodes['static']) ? $subNodes['static'] : false;
'static' => isset($subNodes['static']) ? $subNodes['static'] : false, $this->byRef = isset($subNodes['byRef']) ? $subNodes['byRef'] : false;
'byRef' => isset($subNodes['byRef']) ? $subNodes['byRef'] : false, $this->params = isset($subNodes['params']) ? $subNodes['params'] : array();
'params' => isset($subNodes['params']) ? $subNodes['params'] : array(), $this->uses = isset($subNodes['uses']) ? $subNodes['uses'] : array();
'uses' => isset($subNodes['uses']) ? $subNodes['uses'] : array(), $this->returnType = isset($subNodes['returnType']) ? $subNodes['returnType'] : null;
'stmts' => isset($subNodes['stmts']) ? $subNodes['stmts'] : array(), $this->stmts = isset($subNodes['stmts']) ? $subNodes['stmts'] : array();
), }
$attributes
); public function getSubNodeNames() {
return array('static', 'byRef', 'params', 'uses', 'returnType', 'stmts');
}
public function returnsByRef() {
return $this->byRef;
}
public function getParams() {
return $this->params;
}
public function getReturnType() {
return $this->returnType;
}
public function getStmts() {
return $this->stmts;
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property string $var Name of variable
* @property bool $byRef Whether to use by reference
*/
class ClosureUse extends Expr class ClosureUse extends Expr
{ {
/** @var string Name of variable */
public $var;
/** @var bool Whether to use by reference */
public $byRef;
/** /**
* Constructs a closure use node. * Constructs a closure use node.
* *
@ -18,12 +19,12 @@ class ClosureUse extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($var, $byRef = false, array $attributes = array()) { public function __construct($var, $byRef = false, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var, $this->byRef = $byRef;
'byRef' => $byRef }
),
$attributes public function getSubNodeNames() {
); return array('var', 'byRef');
} }
} }

View File

@ -5,11 +5,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Name $name Constant name
*/
class ConstFetch extends Expr class ConstFetch extends Expr
{ {
/** @var Name Constant name */
public $name;
/** /**
* Constructs a const fetch node. * Constructs a const fetch node.
* *
@ -17,11 +17,11 @@ class ConstFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Name $name, array $attributes = array()) { public function __construct(Name $name, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->name = $name;
'name' => $name }
),
$attributes public function getSubNodeNames() {
); return array('name');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Empty_ extends Expr class Empty_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an empty() node. * Constructs an empty() node.
* *
@ -16,11 +16,11 @@ class Empty_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class ErrorSuppress extends Expr class ErrorSuppress extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an error suppress node. * Constructs an error suppress node.
* *
@ -16,11 +16,11 @@ class ErrorSuppress extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Eval_ extends Expr class Eval_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an eval() node. * Constructs an eval() node.
* *
@ -16,11 +16,11 @@ class Eval_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,11 +4,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property null|Expr $expr Expression
*/
class Exit_ extends Expr class Exit_ extends Expr
{ {
/* For use in "kind" attribute */
const KIND_EXIT = 1;
const KIND_DIE = 2;
/** @var null|Expr Expression */
public $expr;
/** /**
* Constructs an exit() node. * Constructs an exit() node.
* *
@ -16,11 +20,11 @@ class Exit_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr = null, array $attributes = array()) { public function __construct(Expr $expr = null, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Node\Name|Expr $name Function name
* @property Node\Arg[] $args Arguments
*/
class FuncCall extends Expr class FuncCall extends Expr
{ {
/** @var Node\Name|Expr Function name */
public $name;
/** @var Node\Arg[] Arguments */
public $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
@ -19,12 +20,12 @@ class FuncCall extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, array $args = array(), array $attributes = array()) { public function __construct($name, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->name = $name;
'name' => $name, $this->args = $args;
'args' => $args }
),
$attributes public function getSubNodeNames() {
); return array('name', 'args');
} }
} }

View File

@ -4,10 +4,6 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
* @property int $type Type of include
*/
class Include_ extends Expr class Include_ extends Expr
{ {
const TYPE_INCLUDE = 1; const TYPE_INCLUDE = 1;
@ -15,6 +11,11 @@ class Include_ extends Expr
const TYPE_REQUIRE = 3; const TYPE_REQUIRE = 3;
const TYPE_REQUIRE_ONCE = 4; const TYPE_REQUIRE_ONCE = 4;
/** @var Expr Expression */
public $expr;
/** @var int Type of include */
public $type;
/** /**
* Constructs an include node. * Constructs an include node.
* *
@ -23,12 +24,12 @@ class Include_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, $type, array $attributes = array()) { public function __construct(Expr $expr, $type, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr, $this->type = $type;
'type' => $type }
),
$attributes public function getSubNodeNames() {
); return array('expr', 'type');
} }
} }

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
* @property Name|Expr $class Class name
*/
class Instanceof_ extends Expr class Instanceof_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** @var Name|Expr Class name */
public $class;
/** /**
* Constructs an instanceof check node. * Constructs an instanceof check node.
* *
@ -19,12 +20,12 @@ class Instanceof_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, $class, array $attributes = array()) { public function __construct(Expr $expr, $class, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr, $this->class = $class;
'class' => $class }
),
$attributes public function getSubNodeNames() {
); return array('expr', 'class');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr[] $vars Variables
*/
class Isset_ extends Expr class Isset_ extends Expr
{ {
/** @var Expr[] Variables */
public $vars;
/** /**
* Constructs an array node. * Constructs an array node.
* *
@ -16,11 +16,11 @@ class Isset_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $vars, array $attributes = array()) { public function __construct(array $vars, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->vars = $vars;
'vars' => $vars }
),
$attributes public function getSubNodeNames() {
); return array('vars');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr[] $vars List of variables to assign to
*/
class List_ extends Expr class List_ extends Expr
{ {
/** @var Expr[] List of variables to assign to */
public $vars;
/** /**
* Constructs a list() destructuring node. * Constructs a list() destructuring node.
* *
@ -16,11 +16,11 @@ class List_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $vars, array $attributes = array()) { public function __construct(array $vars, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->vars = $vars;
'vars' => $vars, }
),
$attributes public function getSubNodeNames() {
); return array('vars');
} }
} }

View File

@ -5,13 +5,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Arg; use PhpParser\Node\Arg;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable holding object
* @property string|Expr $name Method name
* @property Arg[] $args Arguments
*/
class MethodCall extends Expr class MethodCall extends Expr
{ {
/** @var Expr Variable holding object */
public $var;
/** @var string|Expr Method name */
public $name;
/** @var Arg[] Arguments */
public $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
@ -21,13 +23,13 @@ class MethodCall extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, $name, array $args = array(), array $attributes = array()) { public function __construct(Expr $var, $name, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var, $this->name = $name;
'name' => $name, $this->args = $args;
'args' => $args }
),
$attributes public function getSubNodeNames() {
); return array('var', 'name', 'args');
} }
} }

View File

@ -5,26 +5,27 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Node\Name|Expr $class Class name
* @property Node\Arg[] $args Arguments
*/
class New_ extends Expr class New_ extends Expr
{ {
/** @var Node\Name|Expr|Node\Stmt\Class_ Class name */
public $class;
/** @var Node\Arg[] Arguments */
public $args;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
* @param Node\Name|Expr $class Class name * @param Node\Name|Expr|Node\Stmt\Class_ $class Class name (or class node for anonymous classes)
* @param Node\Arg[] $args Arguments * @param Node\Arg[] $args Arguments
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, array $args = array(), array $attributes = array()) { public function __construct($class, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->class = $class;
'class' => $class, $this->args = $args;
'args' => $args }
),
$attributes public function getSubNodeNames() {
); return array('class', 'args');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PostDec extends Expr class PostDec extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a post decrement node. * Constructs a post decrement node.
* *
@ -16,11 +16,11 @@ class PostDec extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var }
),
$attributes public function getSubNodeNames() {
); return array('var');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PostInc extends Expr class PostInc extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a post increment node. * Constructs a post increment node.
* *
@ -16,11 +16,11 @@ class PostInc extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var }
),
$attributes public function getSubNodeNames() {
); return array('var');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PreDec extends Expr class PreDec extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a pre decrement node. * Constructs a pre decrement node.
* *
@ -16,11 +16,11 @@ class PreDec extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var }
),
$attributes public function getSubNodeNames() {
); return array('var');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable
*/
class PreInc extends Expr class PreInc extends Expr
{ {
/** @var Expr Variable */
public $var;
/** /**
* Constructs a pre increment node. * Constructs a pre increment node.
* *
@ -16,11 +16,11 @@ class PreInc extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, array $attributes = array()) { public function __construct(Expr $var, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var }
),
$attributes public function getSubNodeNames() {
); return array('var');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class Print_ extends Expr class Print_ extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs an print() node. * Constructs an print() node.
* *
@ -16,11 +16,11 @@ class Print_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $var Variable holding object
* @property string|Expr $name Property Name
*/
class PropertyFetch extends Expr class PropertyFetch extends Expr
{ {
/** @var Expr Variable holding object */
public $var;
/** @var string|Expr Property name */
public $name;
/** /**
* Constructs a function call node. * Constructs a function call node.
* *
@ -18,12 +19,12 @@ class PropertyFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $var, $name, array $attributes = array()) { public function __construct(Expr $var, $name, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->var = $var;
'var' => $var, $this->name = $name;
'name' => $name }
),
$attributes public function getSubNodeNames() {
); return array('var', 'name');
} }
} }

View File

@ -4,23 +4,23 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property array $parts Encapsed string array
*/
class ShellExec extends Expr class ShellExec extends Expr
{ {
/** @var array Encapsed string array */
public $parts;
/** /**
* Constructs a shell exec (backtick) node. * Constructs a shell exec (backtick) node.
* *
* @param array $parts Encapsed string array * @param array $parts Encapsed string array
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($parts, array $attributes = array()) { public function __construct(array $parts, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->parts = $parts;
'parts' => $parts }
),
$attributes public function getSubNodeNames() {
); return array('parts');
} }
} }

View File

@ -5,13 +5,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node; use PhpParser\Node;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Node\Name|Expr $class Class name
* @property string|Expr $name Method name
* @property Node\Arg[] $args Arguments
*/
class StaticCall extends Expr class StaticCall extends Expr
{ {
/** @var Node\Name|Expr Class name */
public $class;
/** @var string|Expr Method name */
public $name;
/** @var Node\Arg[] Arguments */
public $args;
/** /**
* Constructs a static method call node. * Constructs a static method call node.
* *
@ -21,13 +23,13 @@ class StaticCall extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, $name, array $args = array(), array $attributes = array()) { public function __construct($class, $name, array $args = array(), array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->class = $class;
'class' => $class, $this->name = $name;
'name' => $name, $this->args = $args;
'args' => $args }
),
$attributes public function getSubNodeNames() {
); return array('class', 'name', 'args');
} }
} }

View File

@ -5,12 +5,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Name; use PhpParser\Node\Name;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Name|Expr $class Class name
* @property string|Expr $name Property name
*/
class StaticPropertyFetch extends Expr class StaticPropertyFetch extends Expr
{ {
/** @var Name|Expr Class name */
public $class;
/** @var string|Expr Property name */
public $name;
/** /**
* Constructs a static property fetch node. * Constructs a static property fetch node.
* *
@ -19,12 +20,12 @@ class StaticPropertyFetch extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($class, $name, array $attributes = array()) { public function __construct($class, $name, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->class = $class;
'class' => $class, $this->name = $name;
'name' => $name }
),
$attributes public function getSubNodeNames() {
); return array('class', 'name');
} }
} }

View File

@ -4,13 +4,15 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $cond Condition
* @property null|Expr $if Expression for true
* @property Expr $else Expression for false
*/
class Ternary extends Expr class Ternary extends Expr
{ {
/** @var Expr Condition */
public $cond;
/** @var null|Expr Expression for true */
public $if;
/** @var Expr Expression for false */
public $else;
/** /**
* Constructs a ternary operator node. * Constructs a ternary operator node.
* *
@ -20,13 +22,13 @@ class Ternary extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $cond, $if, Expr $else, array $attributes = array()) { public function __construct(Expr $cond, $if, Expr $else, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->cond = $cond;
'cond' => $cond, $this->if = $if;
'if' => $if, $this->else = $else;
'else' => $else }
),
$attributes public function getSubNodeNames() {
); return array('cond', 'if', 'else');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class UnaryMinus extends Expr class UnaryMinus extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a unary minus node. * Constructs a unary minus node.
* *
@ -16,11 +16,11 @@ class UnaryMinus extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property Expr $expr Expression
*/
class UnaryPlus extends Expr class UnaryPlus extends Expr
{ {
/** @var Expr Expression */
public $expr;
/** /**
* Constructs a unary plus node. * Constructs a unary plus node.
* *
@ -16,11 +16,11 @@ class UnaryPlus extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $expr, array $attributes = array()) { public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->expr = $expr;
'expr' => $expr }
),
$attributes public function getSubNodeNames() {
); return array('expr');
} }
} }

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property string|Expr $name Name
*/
class Variable extends Expr class Variable extends Expr
{ {
/** @var string|Expr Name */
public $name;
/** /**
* Constructs a variable node. * Constructs a variable node.
* *
@ -16,11 +16,11 @@ class Variable extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, array $attributes = array()) { public function __construct($name, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->name = $name;
'name' => $name }
),
$attributes public function getSubNodeNames() {
); return array('name');
} }
} }

View File

@ -0,0 +1,26 @@
<?php
namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr;
class YieldFrom extends Expr
{
/** @var Expr Expression to yield from */
public $expr;
/**
* Constructs an "yield from" node.
*
* @param Expr $expr Expression
* @param array $attributes Additional attributes
*/
public function __construct(Expr $expr, array $attributes = array()) {
parent::__construct($attributes);
$this->expr = $expr;
}
public function getSubNodeNames() {
return array('expr');
}
}

View File

@ -4,12 +4,13 @@ namespace PhpParser\Node\Expr;
use PhpParser\Node\Expr; use PhpParser\Node\Expr;
/**
* @property null|Expr $value Value expression
* @property null|Expr $key Key expression
*/
class Yield_ extends Expr class Yield_ extends Expr
{ {
/** @var null|Expr Key expression */
public $key;
/** @var null|Expr Value expression */
public $value;
/** /**
* Constructs a yield expression node. * Constructs a yield expression node.
* *
@ -18,12 +19,12 @@ class Yield_ extends Expr
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(Expr $value = null, Expr $key = null, array $attributes = array()) { public function __construct(Expr $value = null, Expr $key = null, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->key = $key;
'key' => $key, $this->value = $value;
'value' => $value, }
),
$attributes public function getSubNodeNames() {
); return array('key', 'value');
} }
} }

View File

@ -0,0 +1,36 @@
<?php
namespace PhpParser\Node;
use PhpParser\Node;
interface FunctionLike extends Node
{
/**
* Whether to return by reference
*
* @return bool
*/
public function returnsByRef();
/**
* List of parameters
*
* @return Node\Param[]
*/
public function getParams();
/**
* Get the declared return type or null
*
* @return null|string|Node\Name
*/
public function getReturnType();
/**
* The function body
*
* @return Node\Stmt[]
*/
public function getStmts();
}

View File

@ -4,11 +4,11 @@ namespace PhpParser\Node;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property array $parts Parts of the name
*/
class Name extends NodeAbstract class Name extends NodeAbstract
{ {
/** @var string[] Parts of the name */
public $parts;
/** /**
* Constructs a name node. * Constructs a name node.
* *
@ -20,12 +20,12 @@ class Name extends NodeAbstract
$parts = explode('\\', $parts); $parts = explode('\\', $parts);
} }
parent::__construct( parent::__construct($attributes);
array( $this->parts = $parts;
'parts' => $parts, }
),
$attributes public function getSubNodeNames() {
); return array('parts');
} }
/** /**
@ -106,37 +106,45 @@ class Name extends NodeAbstract
/** /**
* Sets the whole name. * Sets the whole name.
* *
* @deprecated Create a new Name instead, or manually modify the $parts property
*
* @param string|array|self $name The name to set the whole name to * @param string|array|self $name The name to set the whole name to
*/ */
public function set($name) { public function set($name) {
$this->parts = $this->prepareName($name); $this->parts = self::prepareName($name);
} }
/** /**
* Prepends a name to this name. * Prepends a name to this name.
* *
* @deprecated Use Name::concat($name1, $name2) instead
*
* @param string|array|self $name Name to prepend * @param string|array|self $name Name to prepend
*/ */
public function prepend($name) { public function prepend($name) {
$this->parts = array_merge($this->prepareName($name), $this->parts); $this->parts = array_merge(self::prepareName($name), $this->parts);
} }
/** /**
* Appends a name to this name. * Appends a name to this name.
* *
* @deprecated Use Name::concat($name1, $name2) instead
*
* @param string|array|self $name Name to append * @param string|array|self $name Name to append
*/ */
public function append($name) { public function append($name) {
$this->parts = array_merge($this->parts, $this->prepareName($name)); $this->parts = array_merge($this->parts, self::prepareName($name));
} }
/** /**
* Sets the first part of the name. * Sets the first part of the name.
* *
* @deprecated Use concat($first, $name->slice(1)) instead
*
* @param string|array|self $name The name to set the first part to * @param string|array|self $name The name to set the first part to
*/ */
public function setFirst($name) { public function setFirst($name) {
array_splice($this->parts, 0, 1, $this->prepareName($name)); array_splice($this->parts, 0, 1, self::prepareName($name));
} }
/** /**
@ -145,7 +153,47 @@ class Name extends NodeAbstract
* @param string|array|self $name The name to set the last part to * @param string|array|self $name The name to set the last part to
*/ */
public function setLast($name) { public function setLast($name) {
array_splice($this->parts, -1, 1, $this->prepareName($name)); array_splice($this->parts, -1, 1, self::prepareName($name));
}
/**
* Gets a slice of a name (similar to array_slice).
*
* This method returns a new instance of the same type as the original and with the same
* attributes.
*
* If the slice is empty, a Name with an empty parts array is returned. While this is
* meaningless in itself, it works correctly in conjunction with concat().
*
* @param int $offset Offset to start the slice at
*
* @return static Sliced name
*/
public function slice($offset) {
// TODO negative offset and length
if ($offset < 0 || $offset > count($this->parts)) {
throw new \OutOfBoundsException(sprintf('Offset %d is out of bounds', $offset));
}
return new static(array_slice($this->parts, $offset), $this->attributes);
}
/**
* Concatenate two names, yielding a new Name instance.
*
* The type of the generated instance depends on which class this method is called on, for
* example Name\FullyQualified::concat() will yield a Name\FullyQualified instance.
*
* @param string|array|self $name1 The first name
* @param string|array|self $name2 The second name
* @param array $attributes Attributes to assign to concatenated name
*
* @return static Concatenated name
*/
public static function concat($name1, $name2, array $attributes = []) {
return new static(
array_merge(self::prepareName($name1), self::prepareName($name2)), $attributes
);
} }
/** /**
@ -156,7 +204,7 @@ class Name extends NodeAbstract
* *
* @return array Prepared name * @return array Prepared name
*/ */
protected function prepareName($name) { private static function prepareName($name) {
if (is_string($name)) { if (is_string($name)) {
return explode('\\', $name); return explode('\\', $name);
} elseif (is_array($name)) { } elseif (is_array($name)) {

View File

@ -5,15 +5,19 @@ namespace PhpParser\Node;
use PhpParser\Error; use PhpParser\Error;
use PhpParser\NodeAbstract; use PhpParser\NodeAbstract;
/**
* @property null|string|Name $type Typehint
* @property bool $byRef Whether is passed by reference
* @property bool $variadic Whether this is a variadic argument
* @property string $name Name
* @property null|Expr $default Default value
*/
class Param extends NodeAbstract class Param extends NodeAbstract
{ {
/** @var null|string|Name Typehint */
public $type;
/** @var bool Whether parameter is passed by reference */
public $byRef;
/** @var bool Whether this is a variadic argument */
public $variadic;
/** @var string Name */
public $name;
/** @var null|Expr Default value */
public $default;
/** /**
* Constructs a parameter node. * Constructs a parameter node.
* *
@ -24,20 +28,20 @@ class Param extends NodeAbstract
* @param bool $variadic Whether this is a variadic argument * @param bool $variadic Whether this is a variadic argument
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($name, $default = null, $type = null, $byRef = false, $variadic = false, array $attributes = array()) { public function __construct($name, Expr $default = null, $type = null, $byRef = false, $variadic = false, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->type = $type;
'type' => $type, $this->byRef = $byRef;
'byRef' => $byRef, $this->variadic = $variadic;
'variadic' => $variadic, $this->name = $name;
'name' => $name, $this->default = $default;
'default' => $default,
),
$attributes
);
if ($variadic && null !== $default) { if ($variadic && null !== $default) {
throw new Error('Variadic parameter cannot have a default value'); throw new Error('Variadic parameter cannot have a default value', $default->getAttributes());
} }
} }
public function getSubNodeNames() {
return array('type', 'byRef', 'variadic', 'name', 'default');
}
} }

View File

@ -4,24 +4,24 @@ namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
/**
* @property float $value Number value
*/
class DNumber extends Scalar class DNumber extends Scalar
{ {
/** @var float Number value */
public $value;
/** /**
* Constructs a float number scalar node. * Constructs a float number scalar node.
* *
* @param float $value Value of the number * @param float $value Value of the number
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($value = 0.0, array $attributes = array()) { public function __construct($value, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->value = $value;
'value' => $value }
),
$attributes public function getSubNodeNames() {
); return array('value');
} }
/** /**

View File

@ -4,23 +4,23 @@ namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
/**
* @property array $parts Encaps list
*/
class Encapsed extends Scalar class Encapsed extends Scalar
{ {
/** @var array Encaps list */
public $parts;
/** /**
* Constructs an encapsed string node. * Constructs an encapsed string node.
* *
* @param array $parts Encaps list * @param array $parts Encaps list
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $parts = array(), array $attributes = array()) { public function __construct(array $parts, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->parts = $parts;
'parts' => $parts }
),
$attributes public function getSubNodeNames() {
); return array('parts');
} }
} }

View File

@ -0,0 +1,26 @@
<?php
namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar;
class EncapsedStringPart extends Scalar
{
/** @var string String value */
public $value;
/**
* Constructs a node representing a string part of an encapsed string.
*
* @param string $value String value
* @param array $attributes Additional attributes
*/
public function __construct($value, array $attributes = array()) {
parent::__construct($attributes);
$this->value = $value;
}
public function getSubNodeNames() {
return array('value');
}
}

View File

@ -2,60 +2,66 @@
namespace PhpParser\Node\Scalar; namespace PhpParser\Node\Scalar;
use PhpParser\Error;
use PhpParser\Node\Scalar; use PhpParser\Node\Scalar;
/**
* @property int $value Number value
*/
class LNumber extends Scalar class LNumber extends Scalar
{ {
/* For use in "kind" attribute */
const KIND_BIN = 2;
const KIND_OCT = 8;
const KIND_DEC = 10;
const KIND_HEX = 16;
/** @var int Number value */
public $value;
/** /**
* Constructs an integer number scalar node. * Constructs an integer number scalar node.
* *
* @param int $value Value of the number * @param int $value Value of the number
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct($value = 0, array $attributes = array()) { public function __construct($value, array $attributes = array()) {
parent::__construct( parent::__construct($attributes);
array( $this->value = $value;
'value' => $value }
),
$attributes public function getSubNodeNames() {
); return array('value');
} }
/** /**
* @internal * Constructs an LNumber node from a string number literal.
* *
* Parses an LNUMBER token (dec, hex, oct and bin notations) like PHP would. * @param string $str String number literal (decimal, octal, hex or binary)
* @param array $attributes Additional attributes
* @param bool $allowInvalidOctal Whether to allow invalid octal numbers (PHP 5)
* *
* @param string $str A string number * @return LNumber The constructed LNumber, including kind attribute
*
* @return int The parsed number
*/ */
public static function parse($str) { public static function fromString($str, array $attributes = array(), $allowInvalidOctal = false) {
// handle plain 0 specially if ('0' !== $str[0] || '0' === $str) {
if ('0' === $str) { $attributes['kind'] = LNumber::KIND_DEC;
return 0; return new LNumber((int) $str, $attributes);
} }
// if first char is 0 (and number isn't 0) it's a special syntax if ('x' === $str[1] || 'X' === $str[1]) {
if ('0' === $str[0]) { $attributes['kind'] = LNumber::KIND_HEX;
// hex return new LNumber(hexdec($str), $attributes);
if ('x' === $str[1] || 'X' === $str[1]) {
return hexdec($str);
}
// bin
if ('b' === $str[1] || 'B' === $str[1]) {
return bindec($str);
}
// oct (intval instead of octdec to get proper cutting behavior with malformed numbers)
return intval($str, 8);
} }
// dec if ('b' === $str[1] || 'B' === $str[1]) {
return (int) $str; $attributes['kind'] = LNumber::KIND_BIN;
return new LNumber(bindec($str), $attributes);
}
if (!$allowInvalidOctal && strpbrk($str, '89')) {
throw new Error('Invalid numeric literal', $attributes);
}
// use intval instead of octdec to get proper cutting behavior with malformed numbers
$attributes['kind'] = LNumber::KIND_OCT;
return new LNumber(intval($str, 8), $attributes);
} }
} }

View File

@ -12,7 +12,11 @@ abstract class MagicConst extends Scalar
* @param array $attributes Additional attributes * @param array $attributes Additional attributes
*/ */
public function __construct(array $attributes = array()) { public function __construct(array $attributes = array()) {
parent::__construct(array(), $attributes); parent::__construct($attributes);
}
public function getSubNodeNames() {
return array();
} }
/** /**

View File

@ -1,119 +0,0 @@
<?php
namespace PhpParser\Node\Scalar;
use PhpParser\Node\Scalar;
/**
* @property string $value String value
*/
class String extends Scalar
{
protected static $replacements = array(
'\\' => '\\',
'$' => '$',
'n' => "\n",
'r' => "\r",
't' => "\t",
'f' => "\f",
'v' => "\v",
'e' => "\x1B",
);
/**
* Constructs a string scalar node.
*
* @param string $value Value of the string
* @param array $attributes Additional attributes
*/
public function __construct($value = '', array $attributes = array()) {
parent::__construct(
array(
'value' => $value
),
$attributes
);
}
/**
* @internal
*
* Parses a string token.
*
* @param string $str String token content
*
* @return string The parsed string
*/
public static function parse($str) {
$bLength = 0;
if ('b' === $str[0]) {
$bLength = 1;
}
if ('\'' === $str[$bLength]) {
return str_replace(
array('\\\\', '\\\''),
array( '\\', '\''),
substr($str, $bLength + 1, -1)
);
} else {
return self::parseEscapeSequences(substr($str, $bLength + 1, -1), '"');
}
}
/**
* @internal
*
* Parses escape sequences in strings (all string types apart from single quoted).
*
* @param string $str String without quotes
* @param null|string $quote Quote type
*
* @return string String with escape sequences parsed
*/
public static function parseEscapeSequences($str, $quote) {
if (null !== $quote) {
$str = str_replace('\\' . $quote, $quote, $str);
}
return preg_replace_callback(
'~\\\\([\\\\$nrtfve]|[xX][0-9a-fA-F]{1,2}|[0-7]{1,3})~',
array(__CLASS__, 'parseCallback'),
$str
);
}
private static function parseCallback($matches) {
$str = $matches[1];
if (isset(self::$replacements[$str])) {
return self::$replacements[$str];
} elseif ('x' === $str[0] || 'X' === $str[0]) {
return chr(hexdec($str));
} else {
return chr(octdec($str));
}
}
/**
* @internal
*
* Parses a constant doc string.
*
* @param string $startToken Doc string start token content (<<<SMTHG)
* @param string $str String token content
*
* @return string Parsed string
*/
public static function parseDocString($startToken, $str) {
// strip last newline (thanks tokenizer for sticking it into the string!)
$str = preg_replace('~(\r\n|\n|\r)$~', '', $str);
// nowdoc string
if (false !== strpos($startToken, '\'')) {
return $str;
}
return self::parseEscapeSequences($str, null);
}
}

View File

@ -0,0 +1,153 @@
<?php
namespace PhpParser\Node\Scalar;
use PhpParser\Error;
use PhpParser\Node\Scalar;
class String_ extends Scalar
{
/* For use in "kind" attribute */
const KIND_SINGLE_QUOTED = 1;
const KIND_DOUBLE_QUOTED = 2;
const KIND_HEREDOC = 3;
const KIND_NOWDOC = 4;
/** @var string String value */
public $value;
protected static $replacements = array(
'\\' => '\\',
'$' => '$',
'n' => "\n",
'r' => "\r",
't' => "\t",
'f' => "\f",
'v' => "\v",
'e' => "\x1B",
);
/**
* Constructs a string scalar node.
*
* @param string $value Value of the string
* @param array $attributes Additional attributes
*/
public function __construct($value, array $attributes = array()) {
parent::__construct($attributes);
$this->value = $value;
}
public function getSubNodeNames() {
return array('value');
}
/**
* @internal
*
* Parses a string token.
*
* @param string $str String token content
* @param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
*
* @return string The parsed string
*/
public static function parse($str, $parseUnicodeEscape = true) {
$bLength = 0;
if ('b' === $str[0] || 'B' === $str[0]) {
$bLength = 1;
}
if ('\'' === $str[$bLength]) {
return str_replace(
array('\\\\', '\\\''),
array( '\\', '\''),
substr($str, $bLength + 1, -1)
);
} else {
return self::parseEscapeSequences(
substr($str, $bLength + 1, -1), '"', $parseUnicodeEscape
);
}
}
/**
* @internal
*
* Parses escape sequences in strings (all string types apart from single quoted).
*
* @param string $str String without quotes
* @param null|string $quote Quote type
* @param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
*
* @return string String with escape sequences parsed
*/
public static function parseEscapeSequences($str, $quote, $parseUnicodeEscape = true) {
if (null !== $quote) {
$str = str_replace('\\' . $quote, $quote, $str);
}
$extra = '';
if ($parseUnicodeEscape) {
$extra = '|u\{([0-9a-fA-F]+)\}';
}
return preg_replace_callback(
'~\\\\([\\\\$nrtfve]|[xX][0-9a-fA-F]{1,2}|[0-7]{1,3}' . $extra . ')~',
function($matches) {
$str = $matches[1];
if (isset(self::$replacements[$str])) {
return self::$replacements[$str];
} elseif ('x' === $str[0] || 'X' === $str[0]) {
return chr(hexdec($str));
} elseif ('u' === $str[0]) {
return self::codePointToUtf8(hexdec($matches[2]));
} else {
return chr(octdec($str));
}
},
$str
);
}
private static function codePointToUtf8($num) {
if ($num <= 0x7F) {
return chr($num);
}
if ($num <= 0x7FF) {
return chr(($num>>6) + 0xC0) . chr(($num&0x3F) + 0x80);
}
if ($num <= 0xFFFF) {
return chr(($num>>12) + 0xE0) . chr((($num>>6)&0x3F) + 0x80) . chr(($num&0x3F) + 0x80);
}
if ($num <= 0x1FFFFF) {
return chr(($num>>18) + 0xF0) . chr((($num>>12)&0x3F) + 0x80)
. chr((($num>>6)&0x3F) + 0x80) . chr(($num&0x3F) + 0x80);
}
throw new Error('Invalid UTF-8 codepoint escape sequence: Codepoint too large');
}
/**
* @internal
*
* Parses a constant doc string.
*
* @param string $startToken Doc string start token content (<<<SMTHG)
* @param string $str String token content
* @param bool $parseUnicodeEscape Whether to parse PHP 7 \u escapes
*
* @return string Parsed string
*/
public static function parseDocString($startToken, $str, $parseUnicodeEscape = true) {
// strip last newline (thanks tokenizer for sticking it into the string!)
$str = preg_replace('~(\r\n|\n|\r)\z~', '', $str);
// nowdoc string
if (false !== strpos($startToken, '\'')) {
return $str;
}
return self::parseEscapeSequences($str, null, $parseUnicodeEscape);
}
}

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