pub struct OptimizationOptions { /* private fields */ }Expand description
Optimization selection for one generation run.
Grammar transforms rewrite the grammar model before ATN construction.
These transforms preserve recognition (that is, the generated parser
accepts the same language). However, they are NOT tree-preserving!
When enabled, the generated parse tree can differ from the .g4 grammar.
Static lexer DFA generation (Self::static_lexer_dfa) precomputes lexer
DFA tables after ATN construction and preserves both tokens and APIs.
Static parser DFA generation (Self::static_parser_dfa) precomputes
parser prediction tables after ATN construction and preserves both parse
trees and recognizer APIs.
Static-only DFA generation (Self::static_dfa_only) selects both static
DFA passes and removes every adaptive_predict fallback. As a result, the
generated parser can reject input that the grammar accepts. A part of the
grammar that the static tables cannot decide stops the generation.
Selected optimization passes write their reports to a manifest next to the
generated files. The manifest of ClickHouseParser.g4 is
clickhouseparser.optimizations.txt. For the static-parser-dfa pass, the
manifest lists each parser decision (decisionInventory) with the counts
that add up to the totals of the pass.
When Self::report_only is enabled, the generator compiles, analyzes,
and optimizes the input grammars without emitting recognizer files.
Implementations§
Source§impl OptimizationOptions
impl OptimizationOptions
Sourcepub fn entry_rule(&mut self, name: impl Into<String>) -> &mut Self
pub fn entry_rule(&mut self, name: impl Into<String>) -> &mut Self
Marks name as an explicit parser entry rule. Configured entry rules
are preserved by every transform and anchor the reachability analysis
behind Self::prune_unreachable_rules. Repeatable.
Sourcepub const fn prune_unreachable_rules(&mut self, enabled: bool) -> &mut Self
pub const fn prune_unreachable_rules(&mut self, enabled: bool) -> &mut Self
Deletes parser rules that are unreachable from the entry rules.
Default: false (unreachable rules only produce a warning).
Sourcepub const fn inline_trivial_rules(&mut self, enabled: bool) -> &mut Self
pub const fn inline_trivial_rules(&mut self, enabled: bool) -> &mut Self
Inlines trivial pure parser rules (token sets and single-use pure
sequences) into their call sites. Default: false.
Sourcepub const fn optimize_precedence_ladders(&mut self, enabled: bool) -> &mut Self
pub const fn optimize_precedence_ladders(&mut self, enabled: bool) -> &mut Self
Collapses precedence-ladder rule chains (a: b (op b)*; b: c ...)
into a single left-recursive rule. Default: false.
Sourcepub const fn static_lexer_dfa(&mut self, enabled: bool) -> &mut Self
pub const fn static_lexer_dfa(&mut self, enabled: bool) -> &mut Self
Precomputes static lexer DFA tables (--static-lexer-dfa, lexer scope
only). Default: false.
Sourcepub const fn static_parser_dfa(&mut self, enabled: bool) -> &mut Self
pub const fn static_parser_dfa(&mut self, enabled: bool) -> &mut Self
Precomputes static parser DFA tables (--static-parser-dfa, parser
scope only). Default: false.
Sourcepub const fn static_dfa_only(&mut self, enabled: bool) -> &mut Self
pub const fn static_dfa_only(&mut self, enabled: bool) -> &mut Self
Generates only fully static lexers and parsers (--static-dfa-only).
Default: false.
This option selects Self::static_lexer_dfa and
Self::static_parser_dfa. The generated recognizers never fall back
to the adaptive ATN simulation:
- If a lexer mode does not compile to a complete static table, the generation fails.
- If a parser decision has no static table, the generation fails.
- A partial parser table looks further than in the default mode.
- In a partial parser table, a state with an SLL conflict predicts the minimum conflicting alternative. A state where the lookahead budget stops predicts its minimum viable alternative. A predicated state reports a syntax error.
In report-only mode, these failures are error diagnostics and the reports are still rendered.
Sourcepub fn dump_dfas(&mut self, spec: impl Into<String>) -> &mut Self
pub fn dump_dfas(&mut self, spec: impl Into<String>) -> &mut Self
Renders the static parser DFA tables matching spec
(--dump-dfas <SPEC>) and implies Self::report_only.
Sourcepub const fn profile_decisions(&mut self, enabled: bool) -> &mut Self
pub const fn profile_decisions(&mut self, enabled: bool) -> &mut Self
Renders the time and the work that the static-parser-dfa pass spends
on each parser decision (--profile-decisions) and implies
Self::report_only. The times change from run to run.
Sourcepub const fn report_only(&mut self, enabled: bool) -> &mut Self
pub const fn report_only(&mut self, enabled: bool) -> &mut Self
Compiles, analyzes, and optimizes the input grammars without writing
output files (--report-only, --dry-run, -n). Default: false.
Sourcepub const fn strict(&mut self, enabled: bool) -> &mut Self
pub const fn strict(&mut self, enabled: bool) -> &mut Self
Reports an implicit token definition in a parser grammar (G4S030)
as an error instead of a warning (--strict). Default: false.
A parser grammar defines a token implicitly when it refers to a token
that its token vocabulary (tokenVocab) or the lexer rules of its
combined grammar do not define. The parser gets a token type for this
token, but the lexer never emits it. Usually, the reference is a
spelling error or a lexer rule that is missing.
The errors stop the generation. In report-only mode, the errors are diagnostics and the reports are still rendered.
Trait Implementations§
Source§impl Clone for OptimizationOptions
impl Clone for OptimizationOptions
Source§impl Debug for OptimizationOptions
impl Debug for OptimizationOptions
Source§impl Default for OptimizationOptions
impl Default for OptimizationOptions
impl Eq for OptimizationOptions
Source§impl PartialEq for OptimizationOptions
impl PartialEq for OptimizationOptions
impl StructuralPartialEq for OptimizationOptions
Auto Trait Implementations§
impl Forget for OptimizationOptions
impl Freeze for OptimizationOptions
impl Move for OptimizationOptions
impl RefUnwindSafe for OptimizationOptions
impl Send for OptimizationOptions
impl Sync for OptimizationOptions
impl Unpin for OptimizationOptions
impl UnsafeUnpin for OptimizationOptions
impl UnwindSafe for OptimizationOptions
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg or
a color-specific method, such as OwoColorize::green, Read moreSource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg or
a color-specific method, such as OwoColorize::on_yellow, Read more