Skip to main content

Config

Struct Config 

Source
pub struct Config { /* private fields */ }
Expand description

Generator configuration, primarily for use from a build.rs build script.

With the generator as a build dependency, no separate tool installation is needed and the generator version is pinned by Cargo.lock like any other dependency:

[dependencies]
dbt-antlr-runtime = "0.1"

[build-dependencies]
# default-features = false skips the `fancy` diagnostics rendering the
# command-line tool uses; it shrinks the build-dependency tree by ~40%.
dbt-antlr-codegen = { version = "0.1", default-features = false, features = ["generator"] }
// build.rs
dbt_antlr_codegen::Config::new("grammars/Expr.g4")
    .generate()
    .unwrap_or_else(|error| panic!("{error:?}"));

Generated files land in the output directory, which defaults to the OUT_DIR environment variable cargo sets for build scripts; pull them into the crate with include!:

ⓘ
mod expr {
    #![allow(clippy::all)]
    include!(concat!(env!("OUT_DIR"), "/exprparser.rs"));
}

generate prints cargo:rerun-if-changed directives for the configured grammars and library directories (including each root grammar’s own directory, which the loader searches for imported grammars), so the build script reruns exactly when grammar inputs change. It also prints each compiler diagnostic as a cargo:warning directive, so that cargo shows the warnings of the grammar (for example G4S030 for a token that the lexer never emits) in the build output. Call quiet to print only the errors.

Implementations§

Source§

impl Config

Source

pub fn new(grammar: impl Into<PathBuf>) -> Self

Starts a configuration generating from grammar.

Source

pub fn grammar(&mut self, grammar: impl Into<PathBuf>) -> &mut Self

Adds another root grammar to generate from.

Source

pub fn out_dir(&mut self, out_dir: impl Into<PathBuf>) -> &mut Self

Sets the output directory. Defaults to the OUT_DIR environment variable at generate time.

Source

pub fn lib_dir(&mut self, dir: impl Into<PathBuf>) -> &mut Self

Adds a grammar library search directory (the command line’s -lib): imported grammars and tokenVocab .tokens files are looked up here after the importing grammar’s own directory.

Source

pub const fn listener(&mut self, generate: bool) -> &mut Self

Toggles listener (+ base listener) generation. Default: true.

Source

pub const fn visitor(&mut self, generate: bool) -> &mut Self

Toggles visitor (+ base visitor) generation. Default: false.

Source

pub const fn cargo_directives(&mut self, print: bool) -> &mut Self

Toggles printing of cargo:rerun-if-changed directives. Default: true.

Source

pub const fn quiet(&mut self, enabled: bool) -> &mut Self

Stops generate from printing warning diagnostics as cargo:warning directives (--quiet, -q). Error diagnostics are still printed. Default: false.

This setting changes only what is printed: Generation::diagnostics still contains all the diagnostics. Pinned-release generation prints no cargo:warning directives, so this setting has no effect on it.

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. When the flag is off, the generated output is byte-identical to a run without it.

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), which never fall back to the adaptive ATN simulation. Default: false. See OptimizationOptions::static_dfa_only.

Source

pub fn dump_dfas(&mut self, spec: impl Into<String>) -> &mut Self

Renders the static parser DFA tables matching spec into Generation::reports (--dump-dfas <SPEC>, printed to stdout by the CLI). Implies report-only mode.

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 into Generation::reports (--profile-decisions, printed to stdout by the CLI). Implies report-only mode.

Source

pub const fn optimization(&mut self) -> &mut OptimizationOptions

Returns the optimization selection for in-place configuration. See OptimizationOptions for the available options. The convenience setters on Config delegate to it.

Source

pub fn entry_rule(&mut self, name: impl Into<String>) -> &mut Self

Marks name as an explicit parser entry rule (the command line’s --entry-rule). Repeatable.

Source

pub const fn prune_unreachable_rules(&mut self, enabled: bool) -> &mut Self

Deletes parser rules that are unreachable from the entry rules (the command line’s --prune-unreachable-rules). Default: false.

Source

pub const fn inline_trivial_rules(&mut self, enabled: bool) -> &mut Self

Inlines trivial pure parser rules into their call sites (the command line’s --inline-trivial-rules). Default: false.

Source

pub const fn optimize_precedence_ladders(&mut self, enabled: bool) -> &mut Self

Collapses precedence-ladder rule chains into left-recursive rules (--optimize-precedence-ladders). Default: false.

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. See OptimizationOptions::strict.

Source

pub fn pinned_release(&mut self, version: impl Into<String>) -> &mut Self

Switches generation to a pinned prebuilt dbt-antlr-codegen release binary (requires the download feature).

Instead of compiling and running the generator in-process, the release archive for the build host’s target triple is downloaded from the GitHub release dbt-antlr-codegen-v{version}, verified against a SHA-256 checksum, cached under the output directory, and invoked with the configured arguments. Use this in build environments where the generator’s dependency tree is too expensive to compile:

[build-dependencies]
dbt-antlr-codegen = { version = "0.1", default-features = false, features = ["download"] }

The pinned version is independent of this crate’s own version. Requires curl on PATH.

Source

pub fn pinned_release_sha256(&mut self, sha256: impl Into<String>) -> &mut Self

Pins the expected SHA-256 checksum of the release archive (requires the download feature and Config::pinned_release). When unset, the checksum is read from the .sha256 file published next to the archive.

Source

pub fn pinned_release_base_url( &mut self, base_url: impl Into<String>, ) -> &mut Self

Overrides the release download base URL (requires the download feature), for mirrors or GitHub Enterprise hosts. Defaults to the sdf-labs/dbt-antlr GitHub releases.

Source

pub fn generate(&self) -> Result<Vec<PathBuf>, EmitError>

Generates all configured grammars into the output directory, creating it when needed, and returns the paths written.

When cargo_directives is on, each diagnostic of the run is also printed as a cargo:warning directive. With quiet, only the error diagnostics are printed. Use generate_detailed to get the diagnostics instead.

§Errors

Returns EmitError::Config when no grammars are configured or no output directory is available, EmitError::Compile or EmitError::Template when a grammar fails to generate, and EmitError::Write when an output file cannot be written.

Source

pub fn generate_detailed(&self) -> Result<Generation, EmitError>

generate with the rest of the run output: compiler diagnostics (for example unreachable parser rules), transform notes (for example pruned: ... lines), and the reports of the report modes (dump_dfas, profile_decisions).

§Errors

See generate.

Trait Implementations§

Source§

impl Clone for Config

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 Config

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Forget for Config

§

impl Freeze for Config

§

impl Move for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnsafeUnpin for Config

§

impl UnwindSafe for Config

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