use a BTreeMap for parser expectations

Instead of a `Vec`, to remove the many duplicates we can generate during parsing.
NomicFoundation · Aug 9, 2024 · fb34458 · fb34458
1 parent 30f3785
commit fb34458
Show file tree

Hide file tree

Showing 33 changed files with 218 additions and 328 deletions.
diff --git a/crates/codegen/runtime/cargo/src/runtime/language/generated/mod.rs b/crates/codegen/runtime/cargo/src/runtime/language/generated/mod.rs
diff --git a/crates/codegen/runtime/cargo/src/runtime/language/lexer/mod.rs b/crates/codegen/runtime/cargo/src/runtime/language/lexer/mod.rs
@@ -1,3 +1,5 @@
+use std::collections::BTreeSet;
+
 use crate::cst::{self, Edge};
 use crate::kinds::{IsLexicalContext, TerminalKind};
 use crate::language::parser_support::{ParserContext, ParserResult};
@@ -95,7 +97,7 @@ pub(crate) trait Lexer {
             .is_some_and(|t| t.accepted_as(kind))
         {
             input.set_position(start);
-            return ParserResult::no_match(vec![kind]);
+            return ParserResult::no_match(BTreeSet::from([kind]));
         }
         let end = input.position();
 
@@ -104,7 +106,7 @@ pub(crate) trait Lexer {
                 kind,
                 input.content(start.utf8..end.utf8),
             ))],
-            vec![],
+            BTreeSet::new(),
         )
     }
 
@@ -130,7 +132,7 @@ pub(crate) trait Lexer {
             .is_some_and(|t| t.accepted_as(kind))
         {
             input.set_position(restore);
-            return ParserResult::no_match(vec![kind]);
+            return ParserResult::no_match(BTreeSet::from([kind]));
         }
         let end = input.position();
         children.push(Edge::anonymous(cst::Node::terminal(
@@ -145,6 +147,6 @@ pub(crate) trait Lexer {
             input.set_position(restore);
         }
 
-        ParserResult::r#match(children, vec![])
+        ParserResult::r#match(children, BTreeSet::new())
     }
 }
diff --git a/crates/codegen/runtime/cargo/src/runtime/language/mod.rs.jinja2 b/crates/codegen/runtime/cargo/src/runtime/language/mod.rs.jinja2
@@ -8,6 +8,8 @@
     unused_imports
 )]
 
+use std::collections::BTreeSet;
+
 use semver::Version;
 #[cfg(feature = "__private_napi_interfaces")]
 use napi_derive::napi;

diff --git a/crates/codegen/runtime/cargo/src/runtime/language/parser_support/choice_helper.rs b/crates/codegen/runtime/cargo/src/runtime/language/parser_support/choice_helper.rs
@@ -1,3 +1,4 @@
+use std::collections::BTreeSet;
 use std::mem;
 use std::ops::ControlFlow;
 
@@ -24,7 +25,7 @@ pub struct ChoiceHelper {
 impl ChoiceHelper {
     pub fn new(input: &mut ParserContext<'_>) -> Self {
         Self {
-            result: ParserResult::no_match(vec![]),
+            result: ParserResult::no_match(BTreeSet::new()),
             start_position: input.mark(),
             recovered_errors: vec![],
             last_progress: input.position(),

diff --git a/crates/codegen/runtime/cargo/src/runtime/language/parser_support/parser_function.rs b/crates/codegen/runtime/cargo/src/runtime/language/parser_support/parser_function.rs
@@ -1,3 +1,4 @@
+use std::collections::BTreeSet;
 use std::rc::Rc;
 
 use metaslang_cst::TerminalKind as _;
@@ -92,7 +93,7 @@ where
 
                     ParserResult::SkippedUntil(SkippedUntil {
                         nodes, expected, ..
-                    }) => (nodes, vec![expected]),
+                    }) => (nodes, BTreeSet::from([expected])),
                 };
 
                 let topmost_node = match &nodes[..] {

diff --git a/crates/codegen/runtime/cargo/src/runtime/language/parser_support/parser_result.rs b/crates/codegen/runtime/cargo/src/runtime/language/parser_support/parser_result.rs
@@ -1,3 +1,4 @@
+use std::collections::BTreeSet;
 use std::ops::ControlFlow;
 
 use metaslang_cst::TerminalKind as _;
@@ -18,30 +19,33 @@ pub enum ParserResult {
 impl Default for ParserResult {
     fn default() -> Self {
         Self::NoMatch(NoMatch {
-            expected_terminals: vec![],
+            expected_terminals: BTreeSet::new(),
         })
     }
 }
 
 impl ParserResult {
-    pub fn r#match(nodes: Vec<cst::Edge>, expected_terminals: Vec<TerminalKind>) -> Self {
+    pub fn r#match(nodes: Vec<cst::Edge>, expected_terminals: BTreeSet<TerminalKind>) -> Self {
         ParserResult::Match(Match::new(nodes, expected_terminals))
     }
 
     pub fn pratt_operator_match(elements: Vec<PrattElement>) -> Self {
         ParserResult::PrattOperatorMatch(PrattOperatorMatch::new(elements))
     }
 
-    pub fn incomplete_match(nodes: Vec<cst::Edge>, expected_terminals: Vec<TerminalKind>) -> Self {
+    pub fn incomplete_match(
+        nodes: Vec<cst::Edge>,
+        expected_terminals: BTreeSet<TerminalKind>,
+    ) -> Self {
         ParserResult::IncompleteMatch(IncompleteMatch::new(nodes, expected_terminals))
     }
 
     /// Whenever a parser didn't run because it's disabled due to versioning. Shorthand for `no_match(vec![])`.
     pub fn disabled() -> Self {
-        Self::no_match(vec![])
+        Self::no_match(BTreeSet::new())
     }
 
-    pub fn no_match(expected_terminals: Vec<TerminalKind>) -> Self {
+    pub fn no_match(expected_terminals: BTreeSet<TerminalKind>) -> Self {
         ParserResult::NoMatch(NoMatch::new(expected_terminals))
     }
 
@@ -123,11 +127,11 @@ impl ParserResult {
 pub struct Match {
     pub nodes: Vec<cst::Edge>,
     /// Terminals that would have allowed for more progress. Collected for the purposes of error reporting.
-    pub expected_terminals: Vec<TerminalKind>,
+    pub expected_terminals: BTreeSet<TerminalKind>,
 }
 
 impl Match {
-    pub fn new(nodes: Vec<cst::Edge>, expected_terminals: Vec<TerminalKind>) -> Self {
+    pub fn new(nodes: Vec<cst::Edge>, expected_terminals: BTreeSet<TerminalKind>) -> Self {
         Self {
             nodes,
             expected_terminals,
@@ -197,11 +201,11 @@ impl PrattOperatorMatch {
 pub struct IncompleteMatch {
     pub nodes: Vec<cst::Edge>,
     /// Terminals that would have allowed for more progress. Collected for the purposes of error reporting.
-    pub expected_terminals: Vec<TerminalKind>,
+    pub expected_terminals: BTreeSet<TerminalKind>,
 }
 
 impl IncompleteMatch {
-    pub fn new(nodes: Vec<cst::Edge>, expected_terminals: Vec<TerminalKind>) -> Self {
+    pub fn new(nodes: Vec<cst::Edge>, expected_terminals: BTreeSet<TerminalKind>) -> Self {
         Self {
             nodes,
             expected_terminals,
@@ -239,11 +243,11 @@ impl IncompleteMatch {
 #[derive(PartialEq, Eq, Clone, Debug)]
 pub struct NoMatch {
     /// Terminals that would have allowed for more progress. Collected for the purposes of error reporting.
-    pub expected_terminals: Vec<TerminalKind>,
+    pub expected_terminals: BTreeSet<TerminalKind>,
 }
 
 impl NoMatch {
-    pub fn new(expected_terminals: Vec<TerminalKind>) -> Self {
+    pub fn new(expected_terminals: BTreeSet<TerminalKind>) -> Self {
         Self { expected_terminals }
     }
 }

diff --git a/crates/codegen/runtime/cargo/src/runtime/language/parser_support/precedence_helper.rs b/crates/codegen/runtime/cargo/src/runtime/language/parser_support/precedence_helper.rs
@@ -1,3 +1,5 @@
+use std::collections::BTreeSet;
+
 use crate::cst::{self, Edge};
 use crate::kinds::{EdgeLabel, NonterminalKind};
 use crate::language::parser_support::parser_result::PrattElement::{
@@ -237,7 +239,7 @@ impl PrecedenceHelper {
         // 3. Until we have a single expression.
 
         match <[_; 1]>::try_from(elements) {
-            Ok([Expression { nodes }]) => ParserResult::r#match(nodes, vec![]),
+            Ok([Expression { nodes }]) => ParserResult::r#match(nodes, BTreeSet::new()),
             Ok([head]) => unreachable!("Expected an expression: {:#?}", head),
             Err(elems) => unreachable!("Expected a single element: {:#?}", elems),
         }

diff --git a/crates/codegen/runtime/cargo/src/runtime/language/parser_support/recovery.rs b/crates/codegen/runtime/cargo/src/runtime/language/parser_support/recovery.rs
@@ -85,7 +85,7 @@ impl ParserResult {
         {
             nodes.extend(leading_trivia);
             if matches!(result_kind, ParseResultKind::Match) {
-                expected_terminals.push(expected);
+                expected_terminals.insert(expected);
             }
 
             let skipped = input.content(skipped_range.utf8());

diff --git a/crates/codegen/runtime/cargo/src/runtime/language/parser_support/separated_helper.rs b/crates/codegen/runtime/cargo/src/runtime/language/parser_support/separated_helper.rs
@@ -1,3 +1,5 @@
+use std::collections::BTreeSet;
+
 use crate::cst::{self, Edge};
 use crate::kinds::{EdgeLabel, IsLexicalContext, TerminalKind};
 use crate::language::lexer::Lexer;
@@ -41,7 +43,9 @@ impl SeparatedHelper {
                         // NOTE: We can't correctly attempt recovery until #600 lands, otherwise we'd risk misparses,
                         // as we need to stop at certain synchronizing terminals (and we can't reliably scan until
                         // a delimiter, as not every list is enclosed in a delimited group).
-                        Some(..) | None => return ParserResult::r#match(accum, vec![separator]),
+                        Some(..) | None => {
+                            return ParserResult::r#match(accum, BTreeSet::from([separator]))
+                        }
                     }
                 }
                 // Body was partially parsed, so try to recover by skipping terminals until we see a separator

diff --git a/crates/codegen/runtime/cargo/src/runtime/parse_error/mod.rs b/crates/codegen/runtime/cargo/src/runtime/parse_error/mod.rs
@@ -11,7 +11,7 @@ use crate::text_index::TextRange;
 #[derive(Debug, PartialEq, Eq, Clone)]
 pub struct ParseError {
     pub(crate) text_range: TextRange,
-    pub(crate) terminals_that_would_have_allowed_more_progress: Vec<TerminalKind>,
+    pub(crate) terminals_that_would_have_allowed_more_progress: BTreeSet<TerminalKind>,
 }
 
 impl ParseError {
@@ -29,7 +29,7 @@ impl ParseError {
 impl ParseError {
     pub(crate) fn new(
         text_range: TextRange,
-        terminals_that_would_have_allowed_more_progress: Vec<TerminalKind>,
+        terminals_that_would_have_allowed_more_progress: BTreeSet<TerminalKind>,
     ) -> Self {
         Self {
             text_range,
@@ -44,23 +44,24 @@ impl fmt::Display for ParseError {
             .terminals_that_would_have_allowed_more_progress
             .is_empty()
         {
-            write!(f, "Expected end of file.")
-        } else {
-            let deduped = self
-                .terminals_that_would_have_allowed_more_progress
-                .iter()
-                .collect::<BTreeSet<_>>();
+            return write!(f, "Expected end of file.");
+        }
+
+        let mut terminals = self.terminals_that_would_have_allowed_more_progress.iter();
 
-            write!(f, "Expected ")?;
+        let first = terminals
+            .next()
+            .expect("we just checked that it's not empty");
 
-            for kind in deduped.iter().take(deduped.len() - 1) {
-                write!(f, "{kind} or ")?;
-            }
-            let last = deduped.last().expect("we just checked that it's not empty");
-            write!(f, "{last}.")?;
+        write!(f, "Expected {first}")?;
 
-            Ok(())
+        for kind in terminals {
+            write!(f, " or {kind}")?;
         }
+
+        write!(f, ".")?;
+
+        Ok(())
     }
 }
 

diff --git a/crates/codegen/runtime/generator/src/parser/codegen/precedence_parser_definition.rs b/crates/codegen/runtime/generator/src/parser/codegen/precedence_parser_definition.rs
@@ -49,9 +49,9 @@ impl PrecedenceParserDefinitionCodegen for PrecedenceParserDefinitionRef {
                         [inner @ cst::Edge { node: cst::Node::Nonterminal(node), .. }] if node.kind == NonterminalKind::#op_nonterminal_name => {
                             ParserResult::r#match(vec![inner.clone()], r#match.expected_terminals.clone())
                         }
-                        _ => ParserResult::no_match(vec![]),
+                        _ => ParserResult::no_match(BTreeSet::new()),
                     }
-                    _ => ParserResult::no_match(vec![]),
+                    _ => ParserResult::no_match(BTreeSet::new()),
                 }
             };