Struct parol::parser::parol_grammar::ParolGrammar

pub struct ParolGrammar {
    pub item_stack: Vec<ParolGrammarItem>,
    pub title: Option<String>,
    pub comment: Option<String>,
    pub start_symbol: String,
    pub scanner_configurations: Vec<ScannerConfig>,
    /* private fields */
}

Data structure used to build up a parol::GrammarConfig during parsing.

Fields

item_stack: Vec<ParolGrammarItem>

The parsed items are pushed onto the item_stack.

title: Option<String>

The optional title of the grammar

comment: Option<String>

The optional comment of the grammar

start_symbol: String

The mandatory start symbol of the grammar

scanner_configurations: Vec<ScannerConfig>

All parsed scanner configurations

Implementations

impl ParolGrammar

pub fn new() -> Self

Constructs a new item

Trait Implementations

impl Clone for ParolGrammar

fn clone(&self) -> ParolGrammar

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParolGrammar

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

Formats the value using the given formatter.

impl Default for ParolGrammar

fn default() -> Self

Returns the “default value” for a type.

impl Default for &ParolGrammar

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ParolGrammar

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

Deserialize this value from the given Serde deserializer.

impl Display for ParolGrammar

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

Formats the value using the given formatter.

impl ParolGrammarTrait for ParolGrammar

fn init(&mut self, file_name: &Path)

Information provided by parser

fn start_declaration(
    &mut self,
    _end_of_input: &ParseTreeStackEntry<'_>,
    _identifier: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 2:

StartDeclaration: “%start” Identifier;

fn declarations_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 4:

Declarations: ;

fn declaration_0(
    &mut self,
    _percent_title_0: &ParseTreeStackEntry<'_>,
    _string: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 5:

Declaration: “%title” String;

fn declaration_1(
    &mut self,
    _percent_comment_0: &ParseTreeStackEntry<'_>,
    _string: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 6:

Declaration: “%comment” String;

fn scanner_directives_0(
    &mut self,
    _percent_line_underscore_comment_0: &ParseTreeStackEntry<'_>,
    _string: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 8:

Declaration: “%line_comment” String;

fn scanner_directives_1(
    &mut self,
    _percent_block_underscore_comment: &ParseTreeStackEntry<'_>,
    _string: &ParseTreeStackEntry<'_>,
    _string0: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 9:

ScannerDirectives: “%block_comment” String String;

fn scanner_directives_2(
    &mut self,
    _percent_auto_underscore_newline_underscore_off: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 10:

ScannerDirectives: “%auto_newline_off”;

fn scanner_directives_3(
    &mut self,
    _percent_auto_underscore_ws_underscore_off: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 11:

ScannerDirectives: “%auto_ws_off”;

fn production(
    &mut self,
    _identifier: &ParseTreeStackEntry<'_>,
    _colon: &ParseTreeStackEntry<'_>,
    _alternations: &ParseTreeStackEntry<'_>,
    _semicolon: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 17:

Production: Identifier “:” Alternations “;”;

fn alternations(
    &mut self,
    _alternation: &ParseTreeStackEntry<'_>,
    _alternations_list: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 18:

Alternations: Alternation AlternationsList;

fn alternations_list_0(
    &mut self,
    _or: &ParseTreeStackEntry<'_>,
    _alternation: &ParseTreeStackEntry<'_>,
    _alternations_list: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 19:

AlternationsList: “|” Alternation AlternationsList;

fn alternations_list_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 20:

AlternationsList: ;

fn alternation_list_0(
    &mut self,
    _factor: &ParseTreeStackEntry<'_>,
    _alternation_list: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 22:

AlternationList: Factor AlternationList;

fn alternation_list_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 23:

AlternationList: ;

fn symbol_0(
    &mut self,
    _identifier: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 28:

Symbol: Identifier;

fn token_with_states(
    &mut self,
    _l_t: &ParseTreeStackEntry<'_>,
    _state_list: &ParseTreeStackEntry<'_>,
    _g_t: &ParseTreeStackEntry<'_>,
    _string: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 33:

TokenWithStates: “<” StateList “>” String;

fn group(
    &mut self,
    l_paren: &ParseTreeStackEntry<'_>,
    _alternations: &ParseTreeStackEntry<'_>,
    r_paren: &ParseTreeStackEntry<'_>,
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 34:

Group: “(” Alternations “)”;

fn optional(
    &mut self,
    l_bracket: &ParseTreeStackEntry<'_>,
    _alternations: &ParseTreeStackEntry<'_>,
    r_bracket: &ParseTreeStackEntry<'_>,
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 35:

Optional: “[” Alternations “]”;

fn repeat(
    &mut self,
    l_brace: &ParseTreeStackEntry<'_>,
    _alternations: &ParseTreeStackEntry<'_>,
    r_brace: &ParseTreeStackEntry<'_>,
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 36:

Repeat: “{” Alternations “}”;

fn identifier(
    &mut self,
    identifier: &ParseTreeStackEntry<'_>,
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 37:

Identifier: “[a-zA-Z_]\w*”;

fn string(
    &mut self,
    string: &ParseTreeStackEntry<'_>,
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 38:

String: “\u{0022}(¹|\.)*?\u{0022}”;

---

1.  ↩

fn scanner_state(
    &mut self,
    _percent_scanner: &ParseTreeStackEntry<'_>,
    _identifier: &ParseTreeStackEntry<'_>,
    _l_brace: &ParseTreeStackEntry<'_>,
    _scanner_state_list: &ParseTreeStackEntry<'_>,
    _r_brace: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 39:

ScannerState: “%scanner” Identifier “{” ScannerStateList “}”;

fn state_list(
    &mut self,
    identifier: &ParseTreeStackEntry<'_>,
    _state_list_list: &ParseTreeStackEntry<'_>,
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 42:

StateList: Identifier StateListList;

fn state_list_rest_0(
    &mut self,
    _comma: &ParseTreeStackEntry<'_>,
    identifier: &ParseTreeStackEntry<'_>,
    _state_list_rest: &ParseTreeStackEntry<'_>,
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 43:

StateListRest: “,” Identifier StateListRest;

fn state_list_rest_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 44:

StateListRest: ;

fn scanner_switch_0(
    &mut self,
    _percent_sc: &ParseTreeStackEntry<'_>,
    _l_paren: &ParseTreeStackEntry<'_>,
    _scanner_name_opt: &ParseTreeStackEntry<'_>,
    _r_paren: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 45:

ScannerSwitch: “%sc” “(” ScannerNameOpt “)”;

fn scanner_switch_1(
    &mut self,
    _percent_push: &ParseTreeStackEntry<'_>,
    _l_paren: &ParseTreeStackEntry<'_>,
    _identifier: &ParseTreeStackEntry<'_>,
    _r_paren: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 46:

ScannerSwitch: “%push” “(” Identifier “)”;

fn scanner_switch_2(
    &mut self,
    _percent_pop: &ParseTreeStackEntry<'_>,
    _l_paren: &ParseTreeStackEntry<'_>,
    _r_paren: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 47:

ScannerSwitch: “%pop” “(” “)”;

fn scanner_name_opt_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 49:

ScannerNameOpt: ;

fn parol(
    &mut self,
    _prolog: &ParseTreeStackEntry<'_>,
    _grammar_definition: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 0:

fn prolog(
    &mut self,
    _start_declaration: &ParseTreeStackEntry<'_>,
    _declarations: &ParseTreeStackEntry<'_>,
    _scanner_states: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 1:

fn declarations_0(
    &mut self,
    _declaration: &ParseTreeStackEntry<'_>,
    _declarations: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 3:

fn declaration_2(
    &mut self,
    _scanner_directives: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 7:

fn scanner_states_0(
    &mut self,
    _scanner_state: &ParseTreeStackEntry<'_>,
    _scanner_states: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 12:

fn scanner_states_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 13:

fn grammar_definition(
    &mut self,
    _percent_percent: &ParseTreeStackEntry<'_>,
    _production: &ParseTreeStackEntry<'_>,
    _grammar_definition_list: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 14:

fn grammar_definition_list_0(
    &mut self,
    _production: &ParseTreeStackEntry<'_>,
    _grammar_definition_list: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 15:

fn grammar_definition_list_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 16:

fn alternation(
    &mut self,
    _alternation_list: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 21:

fn factor_0(
    &mut self,
    _group: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 24:

fn factor_1(
    &mut self,
    _repeat: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 25:

fn factor_2(
    &mut self,
    _optional: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 26:

fn factor_3(
    &mut self,
    _symbol: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 27:

fn symbol_1(
    &mut self,
    _simple_token: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 29:

fn symbol_2(
    &mut self,
    _token_with_states: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 30:

fn symbol_3(
    &mut self,
    _scanner_switch: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 31:

fn simple_token(
    &mut self,
    _string: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 32:

fn scanner_state_list_0(
    &mut self,
    _scanner_directives: &ParseTreeStackEntry<'_>,
    _scanner_state_list: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 40:

fn scanner_state_list_1(
    &mut self,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 41:

fn scanner_name_opt_0(
    &mut self,
    _identifier: &ParseTreeStackEntry<'_>,
    _parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

Semantic action for production 48:

impl Serialize for ParolGrammar

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 UserActionsTrait<'_> for ParolGrammar

fn init(&mut self, _file_name: &Path)

Initialize the user with additional information. This function is called by the parser before parsing starts. It is used to transport necessary data from parser to user.

fn call_semantic_action_for_production_number(
    &mut self,
    prod_num: usize,
    children: &[ParseTreeStackEntry<'_>],
    parse_tree: &Tree<ParseTreeType<'_>>
) -> Result<()>

This function is implemented automatically for the user’s item ParolGrammar.