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
impl Config
Sourcepub fn new(grammar: impl Into<PathBuf>) -> Self
pub fn new(grammar: impl Into<PathBuf>) -> Self
Starts a configuration generating from grammar.
Sourcepub fn grammar(&mut self, grammar: impl Into<PathBuf>) -> &mut Self
pub fn grammar(&mut self, grammar: impl Into<PathBuf>) -> &mut Self
Adds another root grammar to generate from.
Sourcepub fn out_dir(&mut self, out_dir: impl Into<PathBuf>) -> &mut Self
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.
Sourcepub fn lib_dir(&mut self, dir: impl Into<PathBuf>) -> &mut Self
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.
Sourcepub const fn listener(&mut self, generate: bool) -> &mut Self
pub const fn listener(&mut self, generate: bool) -> &mut Self
Toggles listener (+ base listener) generation. Default: true.
Sourcepub const fn visitor(&mut self, generate: bool) -> &mut Self
pub const fn visitor(&mut self, generate: bool) -> &mut Self
Toggles visitor (+ base visitor) generation. Default: false.
Sourcepub const fn cargo_directives(&mut self, print: bool) -> &mut Self
pub const fn cargo_directives(&mut self, print: bool) -> &mut Self
Toggles printing of cargo:rerun-if-changed directives.
Default: true.
Sourcepub const fn quiet(&mut self, enabled: bool) -> &mut Self
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.
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.
When the flag is off, the generated output is byte-identical to a run
without it.
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),
which never fall back to the adaptive ATN simulation. Default: false.
See OptimizationOptions::static_dfa_only.
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 into
Generation::reports (--dump-dfas <SPEC>, printed to stdout by the
CLI). Implies report-only mode.
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 into Generation::reports
(--profile-decisions, printed to stdout by the CLI). Implies
report-only mode.
Sourcepub const fn optimization(&mut self) -> &mut OptimizationOptions
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.
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 (the command line’s
--entry-rule). 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 (the
command line’s --prune-unreachable-rules). Default: false.
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 into their call sites (the command
line’s --inline-trivial-rules). 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 into left-recursive rules
(--optimize-precedence-ladders). Default: false.
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.
See OptimizationOptions::strict.
Sourcepub fn pinned_release(&mut self, version: impl Into<String>) -> &mut Self
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.
Sourcepub fn pinned_release_sha256(&mut self, sha256: impl Into<String>) -> &mut Self
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.
Sourcepub fn pinned_release_base_url(
&mut self,
base_url: impl Into<String>,
) -> &mut Self
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.
Sourcepub fn generate(&self) -> Result<Vec<PathBuf>, EmitError>
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.
Sourcepub fn generate_detailed(&self) -> Result<Generation, EmitError>
pub fn generate_detailed(&self) -> Result<Generation, EmitError>
Trait Implementations§
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> 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,
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