summaryrefslogtreecommitdiff
path: root/vendor/nikic/php-parser/grammar/README.md
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2022-03-22 12:24:31 +0300
committerAndrew Dolgov <[email protected]>2022-03-22 12:24:31 +0300
commit1c4f7ab3b838b23afb2ee4dab14acbf75956e952 (patch)
tree0a19274107d717efe92d2c0376cd3105fead5a11 /vendor/nikic/php-parser/grammar/README.md
parent711662948768492e8d05b778a7d80eacaec368d2 (diff)
* add phpunit as a dev dependency
* add some basic tests for UrlHelper::rewrite_relative() * fix UrlHelper::rewrite_relative() to work better on non-absolute relative URL paths
Diffstat (limited to 'vendor/nikic/php-parser/grammar/README.md')
-rw-r--r--vendor/nikic/php-parser/grammar/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/vendor/nikic/php-parser/grammar/README.md b/vendor/nikic/php-parser/grammar/README.md
new file mode 100644
index 000000000..4bae11d82
--- /dev/null
+++ b/vendor/nikic/php-parser/grammar/README.md
@@ -0,0 +1,30 @@
+What do all those files mean?
+=============================
+
+ * `php5.y`: PHP 5 grammar written in a pseudo language
+ * `php7.y`: PHP 7 grammar written in a pseudo language
+ * `tokens.y`: Tokens definition shared between PHP 5 and PHP 7 grammars
+ * `parser.template`: A `kmyacc` parser prototype file for PHP
+ * `tokens.template`: A `kmyacc` prototype file for the `Tokens` class
+ * `rebuildParsers.php`: Preprocesses the grammar and builds the parser using `kmyacc`
+
+.phpy pseudo language
+=====================
+
+The `.y` file is a normal grammar in `kmyacc` (`yacc`) style, with some transformations
+applied to it:
+
+ * Nodes are created using the syntax `Name[..., ...]`. This is transformed into
+ `new Name(..., ..., attributes())`
+ * Some function-like constructs are resolved (see `rebuildParsers.php` for a list)
+
+Building the parser
+===================
+
+Run `php grammar/rebuildParsers.php` to rebuild the parsers. Additional options:
+
+ * The `KMYACC` environment variable can be used to specify an alternative `kmyacc` binary.
+ By default the `phpyacc` dev dependency will be used. To use the original `kmyacc`, you
+ need to compile [moriyoshi's fork](https://github.com/moriyoshi/kmyacc-forked).
+ * The `--debug` option enables emission of debug symbols and creates the `y.output` file.
+ * The `--keep-tmp-grammar` option preserves the preprocessed grammar file.