Commit c1a22ed6 authored by Igor Dejanovic's avatar Igor Dejanovic

README update

parent db0d2295
...@@ -36,9 +36,9 @@ be used. ...@@ -36,9 +36,9 @@ be used.
Quick start Quick start
----------- -----------
1. First write a grammar. There are several ways to do that: 1. Write a grammar. There are several ways to do that:
a) The canonical grammar format uses Python statements and expressions. Each rule is specified as Python function which should return a data structure that defines the rule. For example a grammar for simple calculator can be written as:: a) The canonical grammar format uses Python statements and expressions. Each rule is specified as Python function which should return a data structure that defines the rule. For example a grammar for simple calculator can be written as::
from arpeggio import Optional, ZeroOrMore, OneOrMore, EOF from arpeggio import Optional, ZeroOrMore, OneOrMore, EOF
from arpeggio import RegExMatch as _ from arpeggio import RegExMatch as _
...@@ -53,7 +53,7 @@ Quick start ...@@ -53,7 +53,7 @@ Quick start
The python lists in the data structure represent ordered choices while the tuples represent sequences from the PEG. The python lists in the data structure represent ordered choices while the tuples represent sequences from the PEG.
For terminal matches use plain strings or regular expressions. For terminal matches use plain strings or regular expressions.
b) The same grammar could also be written using traditional textual PEG syntax like this:: b) The same grammar could also be written using traditional textual PEG syntax like this::
number <- r'\d*\.\d*|\d+'; // this is a comment number <- r'\d*\.\d*|\d+'; // this is a comment
factor <- ("+" / "-")? factor <- ("+" / "-")?
...@@ -62,7 +62,7 @@ Quick start ...@@ -62,7 +62,7 @@ Quick start
expression <- term (("+" / "-") term)*; expression <- term (("+" / "-") term)*;
calc <- expression+ EOF; calc <- expression+ EOF;
c) Or similar syntax but a little bit more readable like this:: c) Or similar syntax but a little bit more readable like this::
number = r'\d*\.\d*|\d+' # this is a comment number = r'\d*\.\d*|\d+' # this is a comment
factor = ("+" / "-")? factor = ("+" / "-")?
...@@ -71,7 +71,7 @@ Quick start ...@@ -71,7 +71,7 @@ Quick start
expression = term (("+" / "-") term)* expression = term (("+" / "-") term)*
calc = expression+ EOF calc = expression+ EOF
The second and third options are implemented using canonical first form. Feel free to implement your own grammar syntax if you don't like these (see modules :code:`arpeggio.peg` and :code:`arpeggio.cleanpeg`). The second and third options are implemented using canonical first form. Feel free to implement your own grammar syntax if you don't like these (see modules :code:`arpeggio.peg` and :code:`arpeggio.cleanpeg`).
2. Instantiate a parser. Parser works as grammar interpreter. There is no code generation:: 2. Instantiate a parser. Parser works as grammar interpreter. There is no code generation::
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment