Struct Settings

pub struct Settings { /* private fields */ }

Provides parser settings information.

It is the main entry point in the parser generation process. It is meant to be used from the project build.rs script. See tests crate build.rs script for examples of various configurations.

The first step is to create default Settings instance, do necessary configuration by calling methods in a builder (chain) style and, at the end, call the method to process the grammar, either by directly specifying the file or recursivelly processing the directory.

Most of these settings are also exposed through rcomp CLI tool so you can process grammar and generate parsers from the command line (or shell script) if you prefer.

You can read more in the Rustemo book

Example

rustemo_compiler::Settings::new().parser_algo(ParserAlgo::GLR).process_crate_dir()

Implementations

impl Settings

pub fn new() -> Self

Creates a default instance.

pub fn root_dir(self, root_dir: PathBuf) -> Self

Root dir used to calculate output file path from the input grammar path when the out_dir_root is not None. It can be overridden explicitly or when using process_dir call. It is an error if root_dir is None, our_dir_root is set and CARGO_MANIFEST_DIR env variable cannot be found.

pub fn out_dir_root(self, out_dir: PathBuf) -> Self

Sets output root for the generated parser. By default, the parser is generated in the source tree next to the grammar.

pub fn out_dir_actions_root(self, out_dir: PathBuf) -> Self

Output root for the generated actions when default builder is used. By default, actions are generated in the source tree next to the grammar.

pub fn in_source_tree(self) -> Self

Generate both parser and actions (for default builder) in the source tree, next to the grammar. By default, parser and actions are generated in out OUT_DIR.

pub fn actions_in_source_tree(self) -> Self

Generate actions in the source tree (if the default builder is used), next to the grammar. By default, actions are generated in out OUT_DIR.

pub fn exclude(self, exclude: Vec<String>) -> Self

Excludes path from processing. If path contains any of the string given in exclude vector it will be skipped.

pub fn prefer_shifts(self, prefer: bool) -> Self

When there are competing REDUCE and SHIFT operations, this settings will always favor SHIFT.

pub fn prefer_shifts_over_empty(self, prefer: bool) -> Self

When there are competing EMPTY reduction and SHIFT, this settings will always favor SHIFT.

pub fn table_type(self, table_type: TableType) -> Self

LR table type to construct.

pub fn parser_algo(self, parser_algo: ParserAlgo) -> Self

LR algorithm to use

pub fn lexer_type(self, lexer_type: LexerType) -> Self

Sets lexer type. Default lexer is used for string inputs and is based on regex/string matches from the grammar.

pub fn builder_type(self, builder_type: BuilderType) -> Self

Sets builder type. The default builder will deduce AST types and actions.

pub fn builder_loc_info(self, builder_loc_info: bool) -> Self

Should generated default AST builder types contain location/layout information This is only used if builder-type is default.

pub fn generator_table_type( self, generator_table_type: GeneratorTableType, ) -> Self

Sets generator table type. The default is nested static arrays.

pub fn input_type(self, input_type: String) -> Self

Sets the input type. Default is str

pub fn lexical_disamb_most_specific(self, most_specific: bool) -> Self

Lexical disambiguation using most specific match strategy.

pub fn lexical_disamb_longest_match(self, longest_match: bool) -> Self

Lexical disambiguation using longest match strategy.

pub fn lexical_disamb_grammar_order(self, grammar_order: bool) -> Self

Lexical disambiguation using grammar order.

pub fn fancy_regex(self, fancy_regex: bool) -> Self

Set whether or not we use fancy_regex instead of regex

pub fn print_table(self, print_table: bool) -> Self

pub fn partial_parse(self, partial_parse: bool) -> Self

If partial parse is allowed parsing can succeed even if the parser didn’t reach the end of the input. Use with care, especially with GLR parsing as it may lead to a large number of partial solutions.

pub fn skip_ws(self, skip_ws: bool) -> Self

Should whitespaces be skipped. true by default. Not used if Layout rule exists in the Grammar. Used only in the default lexer.

pub fn actions(self, actions: bool) -> Self

Should actions be generated. true by default. Used only if default builder is used.

pub fn notrace(self, notrace: bool) -> Self

Should trace log be printed. false by default. Does nothing for release builds as trace is only available in debug build. Can also be set by RUSTEMO_NOTRACE=1 env variable.

pub fn force(self, force: bool) -> Self

Should actions file be recreated if exist. Use with care.

pub fn dot(self, dot: bool) -> Self

If this is set a .dot file with automata visualization will be produced during compiling.

pub fn process_dir(&self) -> Result<()>

Recursively traverse the root dir and process each Rustemo grammar found. Used as the last call to the configured Settings value.

pub fn process_grammar(&self, grammar: &Path) -> Result<()>

Process the given grammar and generates the parser and actions (if default builder is used). Used as the last call to the configured Settings value.

Trait Implementations

impl Clone for Settings

fn clone(&self) -> Settings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.

impl Default for Settings

fn default() -> Self

Returns the “default value” for a type.