.Interpretation()

An Interpretation represents one possible parsing of a string of characters in the context of a specific lexicon and grammar.

Constructor

Instances of ishml.Interpretation are not intended to be created by calling the object's constructor. Instead, they are generated through calls to ishml.Parser.analyze() or ishml.Rule.parse().

Properties

.gist Object

The gist contains the syntax tree resulting from parsing. Parsing breaks down text into a sequence of terms. Each of these terms may then be broken down into a sequence of one or more sub-terms, recursively. This process forms a syntax tree from the text. The structure of the gist follows the structure of the grammar rule used to create it. The nodes of the syntax tree are properties named after the sub-rules that define them. These properties may in turn have other properties defined on them all the way down the syntax tree to the terminal nodes of the tree. A terminal property contains the matching token for the sub-rule. In the case where a sub-rule defines the maximum number of tokens to match to be more than one, the value stored in the terminal property is an array of tokens.

.remainder String

The remainder is the string of characters, if any, that were not matched during parsing. Successful parsing will result in a remainder with a string length of zero.

.valid Boolean

Indicates whether an interpretation was found to be valid. Defaults to true.

See also parsing tutorial.