mooncakes.io

marianoguerra/shrubbery/parser does not have a README file

Mode

pub(all) enum Mode {
  Top
  Text
} derive(Eq)

What to read.

The mode decides the shape of the answer, which is why it is a parameter rather than something inferred: Top always gives a multi, Text always gives a brackets.

Parsed

source

pub struct Parsed {
  root : @marianoguerra/shrubbery/ast.Node
Node
  diagnostics : Array[@marianoguerra/shrubbery/error.Diagnostic
Diagnostic]
}

A successful parse, and anything reported along the way.

diagnostics is non-empty only in recovery mode, where parsing continues past a failure so that a file with three mistakes reports three. Outside recovery, the first failure is raised instead.

Parsed::diagnostics

source

fn Parsed::diagnostics(self : Parsed) -> Array[@marianoguerra/shrubbery/error.Diagnostic
Diagnostic]

Parsed::root

source

fn Parsed::root(self : Parsed) -> @marianoguerra/shrubbery/ast.Node
Node

parse

source

fn parse(src : String, mode? : Mode, variant? : @marianoguerra/shrubbery/lexer.Variant
Variant, start_column? : @marianoguerra/shrubbery/column.Column
Column, recover? : Bool) -> Parsed raise @marianoguerra/shrubbery/error.ShrubberyError
ShrubberyError

Parse shrubbery notation.

start_column accounts for characters that logically precede the input, for an embedder splicing this into something larger; it affects indentation only, never the positions reported.

parse_tokens

source

fn parse_tokens(toks : Array[@marianoguerra/shrubbery/lexer.Token
Token], mode? : Mode, variant? : @marianoguerra/shrubbery/lexer.Variant
Variant, recover? : Bool) -> Parsed raise @marianoguerra/shrubbery/error.ShrubberyError
ShrubberyError