Struct parol::generators::grammar_config::GrammarConfig

pub struct GrammarConfig {
    pub non_terminals: Vec<String>,
    pub cfg: Cfg,
    pub grammar_type: GrammarType,
    pub title: Option<String>,
    pub comment: Option<String>,
    pub user_type_defs: Vec<(String, String)>,
    pub scanner_configurations: Vec<ScannerConfig>,
    pub lookahead_size: usize,
}

Configuration information for a context free grammar. Currently containing the CFG itself along with accompanying information as title and comment of the grammar, user type aliases, maximum lookahead size and a list of scanner configurations. Can later be amended with further information or pragmas that control lexer/parser generation.

Fields

non_terminals: Vec<String>

The non-terminals of the original context free grammar from the user’s grammar description before any checks and transformation has been conducted.

cfg: Cfg

The actual context free grammar. It should be checked and left-factored here. For this task use the crate::generators::grammar_trans::check_and_transform_grammar function to prepare the grammar.

grammar_type: GrammarType

The type of the grammar

title: Option<String>

Title of the grammar

comment: Option<String>

Optional comment

user_type_defs: Vec<(String, String)>

User type definitions

scanner_configurations: Vec<ScannerConfig>

At least one scanner configurations

lookahead_size: usize

The maximum lookahead size, used for lexer generation

Implementations

impl GrammarConfig

pub fn new(cfg: Cfg, lookahead_size: usize) -> Self

Creates a new item

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

Sets the non-terminals

pub fn with_title(self, title: Option<String>) -> Self

Sets an optional title

pub fn with_comment(self, comment: Option<String>) -> Self

Sets an optional comment

pub fn with_grammar_type(self, grammar_type: GrammarType) -> Self

Sets the grammar type

pub fn add_scanner(self, scanner_config: ScannerConfig) -> Self

Adds a scanner configuration

pub fn add_user_type_def(self, alias: String, type_name: String) -> Self

Adds a user type definition

pub fn update_lookahead_size(&mut self, k: usize)

Sets the lookahead size

pub fn update_cfg(&mut self, cfg: Cfg)

Updates the cfg member after the grammar has been checked and transformed

pub fn generate_augmented_terminals(&self) -> Vec<String>

Generates the augmented tokens vector in the format needed by the lexer generator.

pub fn get_scanner_state_resolver(&self) -> Box<dyn Fn(&[usize]) -> String>

Generates a function that can be used as scanner_state_resolver argument on Pr::format

pub fn dummy_scanner_state_resolver() -> Box<dyn Fn(&[usize]) -> String>

Generates a dummy scanner_state_resolver function that can be used in Pr::format

pub fn get_user_type_resolver(&self) -> Box<dyn Fn(&str) -> Option<String>>

Generates a function that can be used as user_type_resolver argument on Pr::format

pub fn dummy_user_type_resolver() -> Box<dyn Fn(&str) -> Option<String>>

Generates a dummy user_type_resolver function that can be used in Pr::format

Trait Implementations

impl Clone for GrammarConfig

fn clone(&self) -> GrammarConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GrammarConfig

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

Formats the value using the given formatter.

impl Default for &GrammarConfig

fn default() -> Self

Returns the “default value” for a type.

impl Default for GrammarConfig

fn default() -> GrammarConfig

Returns the “default value” for a type.

impl Display for GrammarConfig

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

Formats the value using the given formatter.

impl TryFrom<ParolGrammar<'_>> for GrammarConfig

type Error = Error

The type returned in the event of a conversion error.

fn try_from(grammar: ParolGrammar<'_>) -> Result<Self>

Performs the conversion.