php-parser/grammar/README.md

What do all those files mean?
=============================

 * `php5.y`:            PHP 5 grammer written in a pseudo language
 * `analyze.php`:       Analyzes the grammer and outputs some info about it
 * `rebuildParser.php`: Preprocesses the grammar and builds the parser using `kmyacc`
 * `kmyacc.php.parser`: A `kmyacc` parser prototype file for PHP

.phpy pseudo language
=====================

The `.y` file is a normal grammer 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 `rebuildParser.php` for a list)

Building the parser
===================

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.

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`.
Add README for grammar folder 2011-06-26 20:56:35 +02:00			`What do all those files mean?`
			`=============================`

Move parser to Parser\Php5 Old name still exists. 2015-05-02 22:50:11 +02:00			* `php5.y`: PHP 5 grammer written in a pseudo language
			* `analyze.php`: Analyzes the grammer and outputs some info about it
			* `rebuildParser.php`: Preprocesses the grammar and builds the parser using `kmyacc`
			* `kmyacc.php.parser`: A `kmyacc` parser prototype file for PHP
Add README for grammar folder 2011-06-26 20:56:35 +02:00
Merge preprocessor.php into rebuildParser.php. Don't distribute the temporary preprocessed grammar anymore 2011-08-04 12:46:48 +02:00			`.phpy pseudo language`
Use moriyoshi's fork of kmyacc, which fixes most of the issues of kmyacc with PHP 2011-08-14 14:52:24 +02:00			`=====================`
Add README for grammar folder 2011-06-26 20:56:35 +02:00
Move parser to Parser\Php5 Old name still exists. 2015-05-02 22:50:11 +02:00			The `.y` file is a normal grammer in `kmyacc` (`yacc`) style, with some transformations
Add README for grammar folder 2011-06-26 20:56:35 +02:00			`applied to it:`

[API] Make all constructors specialized For nodes that accept many optional arguments I chose to keep the $subNodes argument, but provide default values instead. 2011-10-28 19:06:24 +02:00			* Nodes are created using the syntax `Name[..., ...]`. This is transformed into
Add some error documentation 2015-04-30 21:58:45 +02:00			`new Name(..., ..., attributes())`
Use moriyoshi's fork of kmyacc, which fixes most of the issues of kmyacc with PHP 2011-08-14 14:52:24 +02:00			* Some function-like constructs are resolved (see `rebuildParser.php` for a list)

			`Building the parser`
			`===================`

			`In order to rebuild the parser, you need [moriyoshi's fork of kmyacc](https://github.com/moriyoshi/kmyacc-forked).`
Turn rebuildParser.php into a CLI script The paths are now more generic so it can be run from any directory, not just grammar/. 2012-10-19 19:11:47 +02:00			After you compiled/installed it, run the `rebuildParser.php` script.
Do not distribute debug parser anymore The debug parser (and the debug y.output) can be still built using rebuildParser.php?debug. 2011-11-27 13:22:29 +01:00
Add some error documentation 2015-04-30 21:58:45 +02:00			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`.