Citron > Parsing interface
The Parsing Interface
- Summary of the interface
- Detailed API documentation
Summary of the interface
The parser interface consists of these two methods which can be called on the parser class generated by Citron:
We call this method to pass a single token to the parser.
We should call this method multiple times to pass a sequence of tokens to the parser. Typically, a separate tokenization stage (see Lexer interface) would generate this sequence of tokens.
After passing all the tokens to the parser, we call this method to tell the parser that there are no more tokens to consume.
This method returns the parse result, i.e. the value returned by the the code block of the start rule of the grammar.
If we’re building a parse tree from the input, the parse result would typically be the completely built parse tree.
These methods are actually defined on the
which the Citron-generated parser class conforms to.
Tokenization is a separate step that needs to drive the parsing. As the
tokens are generated from the input string or data, the tokens should be
passed to the parser’s
consume(token:, code:) method.
Citron provides a simple rule-based lexer,
CitronLexer, that can
generate these tokens from an input string. The important methods it
We create the lexer with a list of lexing rules.
The lexer tokenizes
string, and calls the
onFoundblock when tokens matching the rules are found.
Error handling interface
consume(token:, code:) and
endParsing() are throwing
methods. They throw when an input token at a certain position is
inconsistent with the grammar, or when the input ends prematurely.
tokenize(string:, onFound:) throws on errors encountered during
For more advanced error handling capabilities, see Error capturing.
Detailed API documentation
A few examples of how Citron is used for parsing can be found in the “examples” folder in the project repository.