Merge pull request #500 from ratmice/grmtools_section_y_files

Add grmtools section to `.y` files

Author: ltratt

README.md

@@ -14,14 +14,12 @@ grammar and lexing definitions). First we need to create a file `build.rs` in
 the root of our project with the following content:
 
 ```rust
-use cfgrammar::yacc::YaccKind;
 use lrlex::CTLexerBuilder;
 
 fn main() {
     CTLexerBuilder::new()
         .lrpar_config(|ctp| {
-            ctp.yacckind(YaccKind::Grmtools)
-                .grammar_in_src_dir("calc.y")
+            ctp.grammar_in_src_dir("calc.y")
                 .unwrap()
         })
         .lexer_in_src_dir("calc.l")
@@ -48,6 +46,7 @@ lexer can be found in `src/calc.l`:
 and where the definitions for the parser can be found in `src/calc.y`:
 
 ```rust
+%grmtools{yacckind Grmtools}
 %start Expr
 %avoid_insert "INT"
 %%

doc/src/errorrecovery.md

@@ -49,6 +49,7 @@ make use of error recovery.
 A simple calculator grammar looks as follows:
 
 ```rust,noplaypen
+%grmtools{yacckind Grmtools}
 %start Expr
 %%
 Expr -> u64:
@@ -181,6 +182,7 @@ We thus change the grammar so that inserted integers prevent evaluation from
 occurring:
 
 ```rust,noplaypen
+%grmtools{yacckind Grmtools}
 %start Expr
 %%
 Expr -> Result<u64, ()>:
@@ -539,8 +541,7 @@ the first parsing error, with the `recoverer` method in `CTParserBuilder` or
 ```rust,noplaypen
 CTLexerBuilder::new()
     .lrpar_config(|ctp| {
-        ctp.yacckind(YaccKind::Grmtools)
-            .recoverer(lrpar::RecoveryKind::None)
+        ctp.recoverer(lrpar::RecoveryKind::None)
             .grammar_in_src_dir("calc.y")
             .unwrap()
     })

doc/src/manuallexer.md

@@ -38,13 +38,11 @@ Putting these together is then relatively easy. First a `build.rs` file for a
 hand-written lexer will look roughly as follows:
 
 ```rust
-use cfgrammar::yacc::YaccKind;
 use lrlex::{ct_token_map, DefaultLexerTypes};
 use lrpar::CTParserBuilder;
 
 fn main() {
     let ctp = CTParserBuilder::<DefaultLexerTypes<u8>>::new()
-        .yacckind(YaccKind::Grmtools)
         .grammar_in_src_dir("grammar.y")
         .unwrap()
         .build()

doc/src/quickstart.md

@@ -48,14 +48,12 @@ file inside the root of our project which can process the lexer and grammar.
 Our `build.rs` file thus looks as follows:
 
 ```rust,noplaypen
-use cfgrammar::yacc::YaccKind;
 use lrlex::CTLexerBuilder;
 
 fn main() {
     CTLexerBuilder::new()
         .lrpar_config(|ctp| {
-            ctp.yacckind(YaccKind::Grmtools)
-                .grammar_in_src_dir("calc.y")
+            ctp.grammar_in_src_dir("calc.y")
                 .unwrap()
         })
         .lexer_in_src_dir("calc.l")
@@ -103,6 +101,7 @@ is lexed, but no lexemes are created from it.
 
 Our initial version of calc.y looks as follows:
 ```rust,noplaypen
+%grmtools{yacckind Grmtools}
 %start Expr
 %%
 Expr -> Result<u64, ()>:

lrlex/examples/calc_manual_lex/build.rs

@@ -1,4 +1,3 @@
-use cfgrammar::yacc::YaccKind;
 use lrlex::{ct_token_map, DefaultLexerTypes};
 use lrpar::CTParserBuilder;
 
@@ -13,7 +12,6 @@ const TOKENS_MAP: &[(&str, &str)] = &[
 
 fn main() {
     let ctp = CTParserBuilder::<DefaultLexerTypes<u8>>::new()
-        .yacckind(YaccKind::Grmtools)
         .grammar_in_src_dir("calc.y")
         .unwrap()
         .build()

lrlex/examples/calc_manual_lex/src/calc.y

@@ -1,3 +1,4 @@
+%grmtools{yacckind Grmtools}
 %start Expr
 %avoid_insert "INT"
 %expect-unused Unmatched "UNMATCHED"

lrpar/examples/calc_actions/build.rs

@@ -1,5 +1,4 @@
 #![deny(rust_2018_idioms)]
-use cfgrammar::yacc::YaccKind;
 use lrlex::CTLexerBuilder;
 
 fn main() {
@@ -8,8 +7,7 @@ fn main() {
     CTLexerBuilder::new()
         .rust_edition(lrlex::RustEdition::Rust2021)
         .lrpar_config(|ctp| {
-            ctp.yacckind(YaccKind::Grmtools)
-                .rust_edition(lrpar::RustEdition::Rust2021)
+            ctp.rust_edition(lrpar::RustEdition::Rust2021)
                 .grammar_in_src_dir("calc.y")
                 .unwrap()
         })

lrpar/examples/calc_actions/src/calc.y

@@ -1,6 +1,4 @@
-%grmtools {
-  yacckind Grmtools
-}
+%grmtools {yacckind Grmtools}
 %start Expr
 %avoid_insert "INT"
 %%

lrpar/examples/calc_ast/build.rs

@@ -1,5 +1,4 @@
 #![deny(rust_2018_idioms)]
-use cfgrammar::yacc::YaccKind;
 use lrlex::CTLexerBuilder;
 
 fn main() {
@@ -8,8 +7,7 @@ fn main() {
     CTLexerBuilder::new()
         .rust_edition(lrlex::RustEdition::Rust2021)
         .lrpar_config(|ctp| {
-            ctp.yacckind(YaccKind::Grmtools)
-                .rust_edition(lrpar::RustEdition::Rust2021)
+            ctp.rust_edition(lrpar::RustEdition::Rust2021)
                 .grammar_in_src_dir("calc.y")
                 .unwrap()
         })

lrpar/examples/calc_ast/src/calc.y

@@ -1,3 +1,4 @@
+%grmtools {yacckind Grmtools}
 %start Expr
 %avoid_insert "INT"
 %expect-unused Unmatched "UNMATCHED"