Skip to main content

OptimizationOptions

Struct OptimizationOptions 

Source
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

Source

pub fn new() -> Self

Starts an empty selection.

Source

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.

Source

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).

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OptimizationOptions

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for OptimizationOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for OptimizationOptions

Source§

impl PartialEq for OptimizationOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OptimizationOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<D> OwoColorize for D

Source§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
Source§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
Source§

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black
Source§

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black
Source§

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red
Source§

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red
Source§

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green
Source§

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green
Source§

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow
Source§

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow
Source§

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue
Source§

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue
Source§

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta
Source§

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta
Source§

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple
Source§

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple
Source§

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan
Source§

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan
Source§

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white
Source§

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white
Source§

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default
Source§

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default
Source§

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black
Source§

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black
Source§

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red
Source§

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red
Source§

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green
Source§

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green
Source§

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow
Source§

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow
Source§

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue
Source§

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue
Source§

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta
Source§

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta
Source§

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple
Source§

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple
Source§

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan
Source§

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan
Source§

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white
Source§

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white
Source§

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold
Source§

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim
Source§

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized
Source§

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined
Make the text blink
Make the text blink (but fast!)
Source§

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors
Source§

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text
Source§

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text
Source§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
Source§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
Source§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
Source§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self, ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
Source§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
Source§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
Source§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.