README.md

Simple Rustemo Tutorial

Rustemo is a parser generator written in Rust, where a parser is able to parse some input according to a predefined grammar. This tutorial serves as a quick start for Rustemo. We try to keep each part of the tutorial as simple as possible.

Quick Start

• Installation
• First Example
  • Parser Generation
  • A Project Template For Parsing
  • Parsing
  • Changing Parser Actions
• Workflow

Grammar

• Grammar File Format
• Comments
• Terminals
  • String Terminals
  • Regex Terminals
• Grammar Rules
  • Using Terminals In Expressions
  • Using Grammar Symbols In Expressions
  • Empty String
  • Or
  • Optional
  • One Or More
  • Zero Or More
  • Separators
• Disambiguation
  • Ambiguous Grammar
  • Disambiguation By Associativity
  • Disambiguation By Priority
• More About Priority
  • Operator Precedence
  • Terminal Priority
• Skipping Parts Of Input

Actions

• Names In The Action File
  • Default Names For Terminals
  • Default Names For Grammar Rules
• Default Actions
  • Default Actions For Terminals
  • Default Actions For Grammar Rules
• Custom Actions
  • Changing Actions
    • Changing Actions For Terminals
    • Changing Actions For Grammar Rules
  • Changing Types
    • Changing Types For Terminals
    • Changing Types For Grammar Rules
    • Using Vec As Types
  • Changing Names Of Enum Variants And Functions
  • Changing Names Of Struct Fields And Function Parameters
  • Combinations of Custom Actions

Rcomp

• List Of All Commands
• Action File Regeneration
• GLR Parser Generation

Misc.

• Turning Off Log Output
• Generating Parsers Automatically

See Also

• Rustemo - the parser generator.
• Rustemo Book - a detailed description of Rustemo.

Contributions

Pull requests for typos, incorrect information, or other ideas are welcome!

License

All code in the tutorial is provided under the MIT License.