instacheck.grammar — kanaka/instacheck 0.9.3

apply-grammar-update clj/s

(apply-grammar-update grammar utrek)

Takes a grammar and an map of grammar paths to grammar nodes (an update-trek). Replaces each update path in the grammar ith the new update node.

assoc-in-grammar clj/s

(assoc-in-grammar grammar path value)

Update a grammar node at the given path in grammar to a new value. Like assoc-in for grammars.

CHILD-EDGE clj/s

(CHILD-EDGE e)

children-of-node clj/s

(children-of-node grammar path)

Given a grammar and path node within that grammar return the paths of the children (:alt, :ord, and :cat nodes).

combine-strings clj/s

(combine-strings grammar)

Combine strings and spaces that immediately follow each other in a concatenation.

comment-trek clj/s

(comment-trek grammar & [comment-tx])

Return a trek with comment values (map of grammar paths to parsed comments) by reading edn maps from comments in the grammar. Note that this will return different paths than a normal trek because a comments can occur on any :alt/:ord nodes and since comments can occur in internal :alt/:ord nodes a comment trek will have these internal nodes (a regular trek will not).

Multiple comments with edn maps in the same node will be merged into a single map. If the optional comment-tx function is provided it will be applied to the merge maps values.

This requires a patched version of instaparse to retain the comments in the grammar on :comments keys.

get-ancestors clj/s

(get-ancestors grammar path pred)

Returns a vector of paths for which each p in the vector is a parent edge of path in grammar for which (pred p) is true. For example, to find the nearest parent :cat nodes of my-path: (get-ancestors g my-path #(= :cat (last %)))

get-ancestors* clj/s

(get-ancestors* grammar path pred avoid)

get-descendants clj/s

(get-descendants grammar path pred)

Return a set of paths for which each p in the set is a descendent of path for which (pred p) is true.

get-descendants* clj/s

(get-descendants* grammar path pred avoid)

get-in-grammar clj/s

(get-in-grammar grammar path)

Get the a grammar node for the given path in grammar. Nil is returned if the path does not exist in the grammar, the tag type along the path don't match, or the numeric parser index is out-of-bounds. Like get-in for grammars.

get-weighted-ancestors clj/s

(get-weighted-ancestors grammar path)

grammar->ebnf clj/s

(grammar->ebnf grammar)

Takes a grammar and returns the EBNF string equivalent of that grammar.

grammar->parser clj/s

(grammar->parser grammar & [start])

Takes a grammar and returns a instaparse parser. The start production must either be set on the grammar metadata (by parser->grammar) or must be explicitly provided.

LEAF-TAGS clj/s

load-grammar clj/s

(load-grammar ebnf)

Takes an EBNF grammar test string and returns an instacheck grammar (via parser->grammar).

load-parser clj/s

(load-parser ebnf)

Takes an EBNF grammar test string and returns an instacheck parser.

memoized-paths-to-leaf clj/s

NIL-EDGE clj/s

ntrek clj/s

(ntrek grammar)

Return a ntrek (node trek) of the grammar (map of paths to leaf nodes).

ntrek->grammar clj/s

(ntrek->grammar ntrek)

Take an ntrek (node trek) and convert it back into a grammar

parser->grammar clj/s

(parser->grammar parser)

Takes a instaparse parser and returns an instacheck grammar: the :grammar value from the parser with a metadata map containing the start rule (:start).

paths-to-leaf clj/s

(paths-to-leaf grammar leaf-val)

Given a grammar and a non-terminal keyword nt, return all paths within the grammar that have nt as a leaf node.

TERMINAL clj/s

(TERMINAL v)

TERMINAL-TAGS clj/s

trek clj/s

(trek grammar)

Return a trek (value trek) of the grammar (map of paths to node values).

trek->grammar clj/s

(trek->grammar trek)

Take a trek (value trek) and convert it back into a grammar

trek-grammar clj/s

(trek-grammar grammar tx)

Walk a grammar graph applying tx at each path/node

update-in-grammar clj/s

(update-in-grammar grammar [rule-kw & rest-path :as path] f & args)

Update a grammar node at the given path in the grammar by running (apply f node args) on the node and returning the update grammar. Like update-in for grammars.

walk-grammar clj/s

(walk-grammar grammar f)

Breadth-first walk a grammar transforming it by applying f at each path/node

walk-grammar* clj/s

(walk-grammar* node path f)

Internal: Breadth-first walk a grammar tree transforming it by applying f at each path/node

walk-grammar-rule clj/s

(walk-grammar-rule tree rule f)

Breadth-first walk a grammar rule transforming it by applying f at each path/node

WEIGHTED clj/s