Defines the tags used when applying a Rule.

Match a single Lexeme against a MultiZipper, and advance the MultiZipper past the match. For each match found, returns the MatchOutput tupled with the updated MultiZipper.

Match a list of several Lexemes against a MultiZipper. Arguments and output are the same as with match, though the outputs are given as a list of indices and graphemes rather than as a single index and grapheme.

matchMany without any previous match output.

Given a list of Lexemes specifying a replacement, generate all possible replacements and apply them to the given input.

Given a Rule and a MultiZipper, determines whether the exception of that rule (if any) applies starting at the current position of the MultiZipper; if it does, returns the index of the first element of each matching target.

Given a target and environment, determine if they rule matches. If so, for each match, set the appropriate RuleTags and return a tuple of (is, gs), where gs is a list of matched Graphemes, and is is a list of indices, one for each Category lexeme matched.

Given a Rule, determine if the rule matches at the current point; if so, apply the rule, adding appropriate tags.

Apply a Rule to a MultiZipper. The application will start at the beginning of the MultiZipper, and will be repeated as many times as possible. Returns all valid results.

Check that the MultiZipper contains only graphemes listed in the given CategoriesDecl, replacing all unlisted graphemes with U+FFFD.

Apply a Statement to a MultiZipper. This is a simple wrapper around applyRule and checkGraphemes.

Apply a single Rule to a word.

Note: duplicate outputs from this function are removed. To keep duplicates, use the lower-level internal function applyRule directly.

Apply a single Statement to a word.

Note: as with applyRuleStr, duplicate outputs from this function are removed. To keep duplicates, use the lower-level internal function applyStatement directly.

Apply a set of SoundChanges to a word.

A log item representing a single application of an action. (In practise this will usually be a Statement.) Specifies the action which was applied, as well as the ‘before’ and ‘after’ states.

Logs the evolution of a PWord as various actions are applied to it. The actions (usually Statements) are of type r.

Render a single PWordLog to rows of an HTML table. For instance, the example log given in the documentation for reportAsText would be converted to the following HTML:

"<tr><td>tara</td><td>&rarr;</td><td>tazha</td><td>(r / zh)</td></tr><tr><td></td><td>&rarr;</td><td>tazh</td><td>(V / / _ #)</td></tr>"

Which might be displayed in an HTML table as something like the following:

Render a single PWordLog to plain text. For instance, this log:

PWordLog
  { initialWord = ["t", "a", "r", "a"]
  , derivations =
    [ (["t", "a", "zh", "a"], "r / zh")
    , (["t", "a", "zh"], "V / / _ #")
    ]
  }

Would render as:

tara
  -> tazha  (r / zh)
  -> tazh   (V / / _ #)

Apply a single Statement to a word. Returns a LogItem for each possible result, or [] if the rule does not apply and the input is returned unmodified.

Apply SoundChanges to a word. For each possible result, returns a LogItem for each Statement which altered the input.

Apply SoundChanges to a word, returning an PWordLog for each possible result.

Apply SoundChanges to a word returning the final results, as well as a boolean value indicating whether the word should be highlighted in a UI due to changes from its initial value. (Note that this accounts for highlightChanges values.)