mixinafPegger::Rules

afPegger::Rules

A collection of PEG rules, ready for use!

anyAlphaChar

Source

static Rule anyAlphaChar()

Matches any alphabetical character.

PEG notation:

[a-zA-Z]

anyAlphaNumChar

Source

static Rule anyAlphaNumChar()

Matches any alphabetical or numerical character.

PEG notation:

[a-zA-Z0-9]

anyChar

Source

static Rule anyChar()

Matches any character.

PEG notation:

"."

anyCharInRange

Source

static Rule anyCharInRange(Range charRange)

Matches any character in the given range.

Example PEG notation:

[C-N]

anyCharNot

Source

static Rule anyCharNot(Int char)

Matches any character except the given one.

Example PEG notation:

!"C" .

anyCharNotInRange

Source

static Rule anyCharNotInRange(Range charRange)

Matches any character not in the given range.

Example PEG notation:

![C-N] .

anyCharNotOf

Source

static Rule anyCharNotOf(Int[] chars)

Matches any character not in the given list.

Example PEG notation:

![ChukNoris] .

anyCharOf

Source

static Rule anyCharOf(Int[] chars)

Matches any character in the given list.

Example PEG notation:

[ChukNoris]

anyHexChar

Source

static Rule anyHexChar()

Matches any hexadecimal character.

PEG notation:

[a-fA-F0-9]

anyNonSpaceChar

Source

static Rule anyNonSpaceChar()

Matches any non whitespace character.

PEG notation:

![ \t\n\r\f]

anyNumChar

Source

static Rule anyNumChar()

Matches any numerical character.

PEG notation:

[0-9]

anySpaceChar

Source

static Rule anySpaceChar()

Matches any whitespace character.

PEG notation:

[ \t\n\r\f]

atLeast

Source

static Rule atLeast(Int n, Rule rule)

Processes the given rule repeatedly until it fails. Returns success if it succeeded at least n times.

Example PEG notation:

???

atMost

Source

static Rule atMost(Int n, Rule rule)

Processes the given rule repeatedly, but at most n times. Returns success always.

Example PEG notation:

???

between

Source

static Rule between(Range times, Rule rule)

Processes the given rule at most n times. Returns success if it succeeded at least n times.

Example PEG notation:

???

char

Source

static Rule char(Int char)

Matches the given character.

Example PEG notation:

"C"

firstOf

Source

static Rule firstOf(Rule[] rules := (Rule[])[,])

Processes the given rules in order until one succeeds. Returns success any succeeded.

Example PEG notation:

rule1 / rule2 / rule3 / ... / rule4

nTimes

Source

static Rule nTimes(Int times, Rule rule)

Processes the given rule n times. Returns success if the it always succeeded.

Example PEG notation:

rule rule rule ... rule

oneOrMore

Source

static Rule oneOrMore(Rule rule)

Processes the given rule repeatedly until it fails. Returns success if it succeeded at least once.

Example PEG notation:

(rule)+

onlyIf

Source

static Rule onlyIf(Rule rule)

Processes the given rule and return success if it succeeded. The rule is always rolled back so the characters may be subsequently re-read.

Example PEG notation:

&(rule)

onlyIfNot

Source

static Rule onlyIfNot(Rule rule)

Processes the given rule and return success if it failed. The rule is always rolled back so the characters may be subsequently re-read.

Example PEG notation:

!(rule)

optional

Source

static Rule optional(Rule rule)

Processes the given rule and returns success whether it passes or not.

Example PEG notation:

(rule)?

sequence

Source

static Rule sequence(Rule[] rules := (Rule[])[,])

Processes the given rules in order until. Returns success if they all succeeded.

Example PEG notation:

rule1 rule2 rule3 ... rule4

str

Source

static Rule str(Str string, Bool ignoreCase := true)

Matches the given string.

Example PEG notation:

"ChuckNorris"

strNot

Source

static Rule strNot(Str string, Bool ignoreCase := true)

Matches one or more characters up to (but not including) the given string.

Example PEG notation:

(!"ChuckNorris" .)+

todo

Source

static Rule todo(Bool pass := false)

A placeholder. Succeeds if pass is true.

zeroOrMore

Source

static Rule zeroOrMore(Rule rule)

Processes the given rule repeatedly until it fails.

Example PEG notation:

(rule)*