Forward¶

[Source]

A forwarding parser is used to create mutually recursive parse rules. The forwarding parser can be used instead, and is updated when the real parse rule is created.

class ref Forward is
  Parser box

Implements¶

Parser box

Constructors¶

create¶

[Source]

new ref create()
: Forward ref^

Returns¶

Forward ref^

Public Functions¶

update¶

[Source]

Assign the real parser. Called via () sugar: fwd() = real_parser.

fun ref update(
  value: Parser box)
: None val

Parameters¶

value: Parser box

Returns¶

None val

parse¶

[Source]

fun box parse(
  source: Source val,
  offset: USize val,
  tree: Bool val,
  hidden: Parser box)
: (USize val , (AST val | Token val | NotPresent val | 
    Skipped val | Lex val | Parser box))

Parameters¶

source: Source val
offset: USize val
tree: Bool val
hidden: Parser box

Returns¶

(USize val , (AST val | Token val | NotPresent val | Skipped val | Lex val | Parser box))

complete¶

[Source]

True if a real parser has been assigned via update().

fun box complete()
: Bool val

Returns¶

Bool val

error_msg¶

[Source]

fun box error_msg()
: String val

Returns¶

String val

skip_hidden¶

[Source]

fun box skip_hidden(
  source: Source val,
  offset: USize val,
  hidden: Parser box)
: USize val

Parameters¶

source: Source val
offset: USize val
hidden: Parser box

Returns¶

USize val

result¶

[Source]

fun box result(
  source: Source val,
  offset: USize val,
  from: USize val,
  length: USize val,
  tree: Bool val,
  l: Label val = reference)
: (USize val , (AST val | Token val | NotPresent val | 
    Skipped val | Lex val | Parser box))

Parameters¶

source: Source val
offset: USize val
from: USize val
length: USize val
tree: Bool val
l: Label val = reference

Returns¶

(USize val , (AST val | Token val | NotPresent val | Skipped val | Lex val | Parser box))

mul¶

[Source]

fun box mul(
  that: Parser box)
: Sequence ref

Parameters¶

that: Parser box

Returns¶

Sequence ref

div¶

[Source]

fun box div(
  that: Parser box)
: Choice ref

Parameters¶

that: Parser box

Returns¶

Choice ref

neg¶

[Source]

fun box neg()
: Skip ref

Returns¶

Skip ref

opt¶

[Source]

fun box opt()
: Option ref

Returns¶

Option ref

many¶

[Source]

fun box many(
  sep: Parser box = reference)
: Many ref

Parameters¶

sep: Parser box = reference

Returns¶

Many ref

many1¶

[Source]

fun box many1(
  sep: Parser box = reference)
: Many ref

Parameters¶

sep: Parser box = reference

Returns¶

Many ref

op_not¶

[Source]

fun box op_not()
: Not ref

Returns¶

Not ref

op_and¶

[Source]

fun box op_and()
: Not ref

Returns¶

Not ref

hide¶

[Source]

fun box hide(
  that: Parser box)
: Hidden ref

Parameters¶

that: Parser box

Returns¶

Hidden ref

term¶

[Source]

fun box term(
  l: Label val = reference)
: Terminal ref

Parameters¶

l: Label val = reference

Returns¶

Terminal ref

eof¶

[Source]

fun box eof()
: EndOfFile ref

Returns¶

EndOfFile ref