Merge pull request #549 from ratmice/lrpar_section_parser_ctbuilder_take2

Lrpar section parser ctbuilder take2

Author: ltratt

cfgrammar/src/lib/header.rs

@@ -56,15 +56,17 @@ use bincode::{Decode, Encode};
 #[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
-#[doc(hidden)]
 pub mod header;
 mod idxnewtype;
+pub mod markmap;
 pub mod newlinecache;
 pub mod span;
+#[cfg(test)]
+pub mod test_utils;
 pub mod yacc;
 
 pub use newlinecache::NewlineCache;
-pub use span::{Span, Spanned};
+pub use span::{Location, Span, Spanned};
 
 /// A type specifically for rule indices.
 pub use crate::idxnewtype::{PIdx, RIdx, SIdx, TIdx};

cfgrammar/src/lib/markmap.rs

@@ -66,3 +66,12 @@ impl ToTokens for Span {
         tokens.append_all(quote! {::cfgrammar::Span::new(#start, #end)});
     }
 }
+
+/// A possibly inexact location which could either be a `Span`,
+/// a command-line option, or some other location described textually.
+#[derive(Clone, Debug, Eq, PartialEq)]
+pub enum Location {
+    Span(Span),
+    CommandLine,
+    Other(String),
+}

cfgrammar/src/lib/mod.rs

@@ -0,0 +1,25 @@
+#[allow(unused)]
+pub use crate::header::{Header, Value};
+pub use crate::markmap::{Entry, MergeBehavior};
+pub use crate::Location;
+#[macro_export]
+#[cfg(test)]
+macro_rules! header_for_yacckind {
+    ($yk:expr) => {{
+        let mut header = Header::new();
+        match header.entry("yacckind".to_string()) {
+            Entry::Occupied(_) => unreachable!("Header should be empty"),
+            Entry::Vacant(v) => {
+                let mut o = v.insert_entry((
+                    Location::Other("Testsuite".to_string()),
+                    Value::try_from($yk).unwrap(),
+                ));
+                o.mark_required();
+                o.set_merge_behavior(MergeBehavior::Ours);
+            }
+        };
+        header
+    }};
+}
+
+pub use header_for_yacckind;

cfgrammar/src/lib/span.rs

@@ -6,32 +6,34 @@ use std::{
 use indexmap::{IndexMap, IndexSet};
 
 use super::{
-    parser::YaccParser, Precedence, YaccGrammarError, YaccGrammarErrorKind, YaccGrammarWarning,
-    YaccGrammarWarningKind, YaccKind, YaccKindResolver,
+    parser::YaccParser, ParserError, Precedence, YaccGrammarError, YaccGrammarErrorKind,
+    YaccGrammarWarning, YaccGrammarWarningKind, YaccKind,
 };
 
-use crate::Span;
+use crate::{header::Header, Span};
 /// Contains a `GrammarAST` structure produced from a grammar source file.
 /// As well as any errors which occurred during the construction of the AST.
 pub struct ASTWithValidityInfo {
     yacc_kind: Option<YaccKind>,
     ast: GrammarAST,
-    errs: Vec<YaccGrammarError>,
+    errs: Vec<ParserError>,
 }
 
 impl ASTWithValidityInfo {
     /// Parses a source file into an AST, returning an ast and any errors that were
     /// encountered during the construction of it.  The `ASTWithValidityInfo` can be
     /// then unused to construct a `YaccGrammar`, which will either produce an
     /// `Ok(YaccGrammar)` or an `Err` which includes these errors.
-    pub fn new(yacc_kind_resolver: YaccKindResolver, s: &str) -> Self {
+    pub fn new(header: &mut Header, s: &str) -> Self {
         let mut errs = Vec::new();
         let (yacc_kind, ast) = {
-            let mut yp = YaccParser::new(yacc_kind_resolver, s.to_string());
+            let mut yp = YaccParser::new(header, s.to_string());
             yp.parse().map_err(|e| errs.extend(e)).ok();
             let (yacc_kind, mut ast) = yp.build();
             if yacc_kind.is_some() {
-                ast.complete_and_validate().map_err(|e| errs.push(e)).ok();
+                ast.complete_and_validate()
+                    .map_err(|e| errs.push(e.into()))
+                    .ok();
             }
             (yacc_kind, ast)
         };
@@ -62,7 +64,7 @@ impl ASTWithValidityInfo {
     }
 
     /// Returns all errors which were encountered during AST construction.
-    pub fn errors(&self) -> &[YaccGrammarError] {
+    pub fn errors(&self) -> &[ParserError] {
         self.errs.as_slice()
     }
 }

cfgrammar/src/lib/test_utils.rs

@@ -9,7 +9,8 @@ use crate::{RIdx, Symbol, TIdx};
 /// `Firsts` stores all the first sets for a given grammar. For example, given this code and
 /// grammar:
 /// ```text
-///   let grm = YaccGrammar::new(YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)), "
+///   let grm = YaccGrammar::new(&mut Header::new(), "
+///     %grmtools{yacckind: YaccKind::Original(YaccOriginalActionKind::GenericParseTree)}
 ///     S: A 'b';
 ///     A: 'a'
 ///      | ;").unwrap();
@@ -143,9 +144,10 @@ where
 #[cfg(test)]
 mod test {
     use super::{
-        super::{YaccGrammar, YaccKind, YaccKindResolver, YaccOriginalActionKind},
+        super::{YaccGrammar, YaccKind, YaccOriginalActionKind},
         YaccFirsts,
     };
+    use crate::test_utils::*;
     use num_traits::{AsPrimitive, PrimInt, Unsigned};
 
     fn has<StorageT: 'static + PrimInt + Unsigned>(
@@ -180,7 +182,7 @@ mod test {
     #[test]
     fn test_first() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
           %start C
           %token c d
@@ -202,7 +204,7 @@ mod test {
     #[test]
     fn test_first_no_subsequent_rules() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
           %start C
           %token c d
@@ -220,7 +222,7 @@ mod test {
     #[test]
     fn test_first_epsilon() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
           %start A
           %token a b c
@@ -241,7 +243,7 @@ mod test {
     #[test]
     fn test_last_epsilon() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
           %start A
           %token b c
@@ -261,7 +263,7 @@ mod test {
     #[test]
     fn test_first_no_multiples() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
           %start A
           %token b c
@@ -277,7 +279,7 @@ mod test {
 
     fn eco_grammar() -> YaccGrammar {
         YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
           %start S
           %token a b c d f
@@ -308,7 +310,7 @@ mod test {
     #[test]
     fn test_first_from_eco_bug() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
           %start E
           %token a b c d e f

cfgrammar/src/lib/yacc/ast.rs

@@ -9,7 +9,8 @@ use crate::{RIdx, Symbol, TIdx};
 /// `Follows` stores all the Follow sets for a given grammar. For example, given this code and
 /// grammar:
 /// ```text
-///   let grm = YaccGrammar::new(YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)), "
+///   let grm = YaccGrammar::new(&mut Header::new(), "
+///       %grmtools{yacckind: YaccKind::Original(YaccOriginalActionKind::GenericParseTree)}
 ///       S: A 'b';
 ///       A: 'a' | ;
 ///     ").unwrap();
@@ -115,9 +116,10 @@ where
 #[cfg(test)]
 mod test {
     use super::{
-        super::{YaccGrammar, YaccKind, YaccKindResolver, YaccOriginalActionKind},
+        super::{YaccGrammar, YaccKind, YaccOriginalActionKind},
         YaccFollows,
     };
+    use crate::test_utils::*;
     use num_traits::{AsPrimitive, PrimInt, Unsigned};
 
     fn has<StorageT: 'static + PrimInt + Unsigned>(
@@ -149,7 +151,7 @@ mod test {
     fn test_follow() {
         // Adapted from p2 of https://www.cs.uaf.edu/~cs331/notes/FirstFollow.pdf
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
                 %start E
                 %%
@@ -173,7 +175,7 @@ mod test {
     fn test_follow2() {
         // Adapted from https://www.l2f.inesc-id.pt/~david/w/pt/Top-Down_Parsing/Exercise_5:_Test_2010/07/01
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
                 %start A
                 %%
@@ -196,7 +198,7 @@ mod test {
     #[test]
     fn test_follow3() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
                 %start S
                 %%
@@ -213,7 +215,7 @@ mod test {
     #[test]
     fn test_follow_corchuelo() {
         let grm = YaccGrammar::new(
-            YaccKindResolver::Force(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
+            &mut header_for_yacckind!(YaccKind::Original(YaccOriginalActionKind::GenericParseTree)),
             "
                 %start E
                 %%