clj-antlr.common — clj-antlr 0.2.4

Common functions for building and using parsers.

antlr-input-stream clj

(antlr-input-stream s)

Constructs an ANTLRInputStream out of a String, Reader, or InputStream.

case-insensitive-input-stream clj

(case-insensitive-input-stream input)

Constructs an ANTLRInputStream out of a string. Presents all characters to the lexer as lowercase, but getText methods will return the original string. Adapted from https://gist.github.com/sharwell/9424666. Consumes memory proportional to the input string.

child clj

(child node i)

Get a specific child in a tree.

child-count clj

(child-count node)

How many children does a node have?

children clj

(children node)

Returns the children of a RuleNode.

error-listener clj

(error-listener)

A stateful error listener which accretes parse errors in a deref-able structure. Deref returns nil if there are no errors; else a sequence of heterogenous maps, depending on what debugging information is available.

fast-keyword clj

(fast-keyword s)

Like (keyword str), but faster.

fast-keyword-cache clj

A map of strings to keywords.

first-rule clj

(first-rule grammar)

The name of the first rule in a grammar.

input-stream clj

(input-stream s)

(input-stream s opts)

Constructs an inputstream. With no options, calls antlr-input-stream. With options:

:case-sensitive? true calls antlr-input-stream, false calls case-insensitive-input-stream

multi-hinted-let clj macro

(multi-hinted-let [name expr classes] & body)

A let expression which expands into multiple type-hinted bodies with runtime type dispatch provided by instanceof. Thanks to amalloy, as usual!

parent clj

(parent node)

The parent of a node.

parse-error clj

(parse-error errors tree)

Constructs a new ParseError exception with a list of errors.

parser-rule-name clj

(parser-rule-name parser index)

Given a parser and an integer rule index, returns the string name of that rule. Negative indexes map to nil.

recognition-exception->map clj

(recognition-exception->map e)

Converts a RecognitionException to a nice readable map.

rule-index clj

(rule-index grammar rule-name)

Given a grammar and the name of a rule, returns the integer index of that rule.

text clj

(text node)

The text of a node.

token-name clj

(token-name parser index)

Given a parser and a token index, returns the string name of that token. Negative indexes map to nil.

tokens clj

(tokens lexer)

A token stream taken from a lexer.

visit clj

(visit visitor node)

Visits a node with a visitor.