Struct parol::generators::grammar_config::GrammarConfig

pub struct GrammarConfig {
    pub cfg: Cfg,
    pub title: Option<String>,
    pub comment: Option<String>,
    pub scanner_configurations: Vec<ScannerConfig>,
    pub lookahead_size: usize,
}

Configuration information for a context free grammar. Currently containing comment tokens and maximum lookahead size. Can later be amended with further information and even pragmas that control the generation of lexers and parsers. Examples for amendments: * Ignore case, generate a case-insensitive lexer * Parse whitespace instead of skipping them by default * Prologue and epilogue for generated parser output

Newly added feature is to optionally switch automatic handling off newlines off.

Fields

cfg: Cfg

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

title: Option<String>

Title of the grammar

comment: Option<String>

Optional comment

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_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 add_scanner(self, scanner_config: ScannerConfig) -> Self

Adds a scanner configuration

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

Sets the lookahead size

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

Sets the cfg member

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 uses as scanner_state_resolver argument on 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() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GrammarConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for GrammarConfig

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

Formats the value using the given formatter.

impl Ord for GrammarConfig

fn cmp(&self, other: &GrammarConfig) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<GrammarConfig> for GrammarConfig

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<GrammarConfig> for GrammarConfig

fn partial_cmp(&self, other: &GrammarConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for GrammarConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<ParolGrammar> for GrammarConfig

type Error = Report

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for GrammarConfig

impl StructuralEq for GrammarConfig

impl StructuralPartialEq for GrammarConfig