Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
Antlr.Runtime.ANTLRInputStreamA character stream - an ICharStream - that loads and caches the contents of it's underlying System.IO.Stream fully during object construction
Antlr.Runtime.BaseRecognizerA generic recognizer that can handle recognizers generated from lexer, parser, and tree grammars. This is all the parsing support code essentially; most of it is error recovery stuff and backtracking
Antlr.Runtime.Collections.CollectionUtils
Antlr.Runtime.Collections.HashListAn Hashtable-backed dictionary that enumerates Keys and Values in insertion order
Antlr.Runtime.Collections.StackListStack abstraction that also supports the IList interface
Antlr.Runtime.CommonToken
Antlr.Runtime.IIntStream
Antlr.Runtime.IToken
Antlr.Runtime.ITokenStreamA stream of tokens accessing tokens from a TokenSource
Antlr.Runtime.Misc.ErrorManagerA minimal ANTLR3 error [message] manager with the ST bits
Antlr.Runtime.Misc.StatsStats routines needed by profiler etc..
Antlr.Runtime.RecognitionExceptionThe root of the ANTLR exception hierarchy
Antlr.Runtime.RuleReturnScopeRules can return start/stop info as well as possible trees and templates
Antlr.Runtime.Token
Antlr.Runtime.Tree.BaseTreeA generic tree implementation with no payload. You must subclass to actually have any user data. ANTLR v3 uses a list of children approach instead of the child-sibling approach in v2. A flat tree (a list) is an empty node whose children represent the list. An empty, but non-null node is called "nil"
Antlr.Runtime.Tree.CommonTreeA tree node that is wrapper for a Token object
Antlr.Runtime.Tree.CommonTreeAdaptorA TreeAdaptor that works with any Tree implementation. It provides really just factory methods; all the work is done by BaseTreeAdaptor. If you would like to have different tokens created than ClassicToken objects, you need to override this and then set the parser tree adaptor to use your subclass
Antlr.Runtime.Tree.CommonTreeNodeStreamA buffered stream of tree nodes. Nodes can be from a tree of ANY kind
Antlr.Runtime.Tree.ITreeWhat does a tree look like? ANTLR has a number of support classes such as CommonTreeNodeStream that work on these kinds of trees. You don't have to make your trees implement this interface, but if you do, you'll be able to use more support code
Antlr.Runtime.Tree.ITreeAdaptorHow to create and navigate trees. Rather than have a separate factory and adaptor, I've merged them. Makes sense to encapsulate
Antlr.Runtime.Tree.ITreeNodeStreamA stream of tree nodes, accessing nodes from a tree of some kind
Antlr.Runtime.Tree.ParseTreeA record of the rules used to Match a token sequence. The tokens end up as the leaves of this tree and rule nodes are the interior nodes. This really adds no functionality, it is just an alias for CommonTree that is more meaningful (specific) and holds a String to display for a node
Antlr.Runtime.Tree.TreeParserA parser for a stream of tree nodes. "tree grammars" result in a subclass of this. All the error reporting and recovery is shared with Parser via the BaseRecognizer superclass
Antlr.Runtime.Tree.TreeWizardBuild and navigate trees with this object. Must know about the names of tokens so you have to pass in a map or array of token names (from which this class can build the map). I.e., Token DECL means nothing unless the class can translate it to a token type
Antlr.Runtime.Tree.UnBufferedTreeNodeStreamA stream of tree nodes, accessing nodes from a tree of ANY kind
Antlr.Runtime.ANTLRFileStreamA character stream - an ICharStream - that loads and caches the contents of it's underlying file fully during object construction
Antlr.Runtime.ANTLRReaderStreamAn ANTLRStringStream that caches all the input from a TextReader. It behaves just like a plain ANTLRStringStream
Antlr.Runtime.ANTLRStringStreamA pretty quick ICharStream that uses a character array directly as it's underlying source
Antlr.Runtime.Tests.ANTLRxxxxStreamFixture
Antlr.Runtime.Tree.BaseTreeAdaptorA TreeAdaptor that works with any Tree implementation
Antlr.Runtime.BitSet
Antlr.Runtime.Debug.BlankDebugEventListenerA blank listener that does nothing; useful for real classes so they don't have to have lots of blank methods and are less sensitive to updates to debug interface
Antlr.Runtime.CharStreamState
Antlr.Runtime.ClassicTokenA Token object like we'd use in ANTLR 2.x; has an actual string created and associated with this object. These objects are needed for imaginary tree nodes that have payload objects. We need to create a Token object that has a string; the tree node will point at this token. CommonToken has indexes into a char stream and hence cannot be used to introduce new strings
Antlr.Runtime.CommonErrorNode
Antlr.Runtime.CommonTokenStreamThe most common stream of tokens is one where every token is buffered up and tokens are prefiltered for a certain channel (the parser will only see these tokens and cannot change the filter channel number during the parse)
Antlr.Runtime.Tree.CommonTreeNodeStream.CommonTreeNodeStreamEnumerator
Antlr.Runtime.Constants
Antlr.Runtime.Debug.DebugEventHubBroadcast debug events to multiple listeners
Antlr.Runtime.Debug.DebugEventRepeaterA simple event repeater (proxy) that delegates all functionality to the listener sent into the ctor
Antlr.Runtime.Debug.DebugEventSocketProxyA proxy debug event listener that forwards events over a socket to debugger (or any other listener) using a simple text-based protocol; one event per line
Antlr.Runtime.Debug.DebugParser
Antlr.Runtime.Debug.DebugTokenStream
Antlr.Runtime.Debug.DebugTreeAdaptorA TreeAdaptor proxy that fires debugging events to a DebugEventListener delegate and uses the TreeAdaptor delegate to do the actual work. All AST events are triggered by this adaptor; no code gen changes are needed in generated rules. Debugging events are triggered *after* invoking tree adaptor routines
Antlr.Runtime.Debug.DebugTreeNodeStreamDebug any tree node stream. The constructor accepts the stream and a debug listener. As node stream calls come in, debug events are triggered
Antlr.Runtime.Debug.DebugTreeParser
Antlr.Runtime.DFAA DFA implemented as a set of transition tables
Antlr.Utility.Tree.DOTTreeGeneratorA utility class to generate DOT diagrams (graphviz) from arbitrary trees. You can pass in your own templates and can pass in any kind of tree or use Tree interface method. I wanted this separator so that you don't have to include ST just to use the org.antlr.runtime.tree.* package. This is a set of non-static methods so you can subclass to override. For example, here is an invocation:
Antlr.Runtime.EarlyExitExceptionThe recognizer did not match anything for a (..)+ loop
Antlr.Runtime.FailedPredicateException
Antlr.Runtime.Collections.HashList.HashListEnumerator
Antlr.Runtime.Collections.HashList.KeyCollection
Antlr.Runtime.Collections.HashList.ValueCollection
Antlr.Runtime.ICharStreamA source of characters for an ANTLR lexer
Antlr.Runtime.Debug.IDebugEventListenerAll debugging events that a recognizer can trigger
Antlr.Runtime.ITokenSourceA source of tokens must provide a sequence of tokens via NextToken() and also must reveal it's source of characters; CommonToken's text is computed from a CharStream; it only store indices into the char stream
Antlr.Runtime.Tests.ITreeFixture
Antlr.Runtime.Tests.ITreeNodeStreamFixture
Antlr.Runtime.LexerA lexer is recognizer that draws input symbols from a character stream. lexer grammars result in a subclass of this object. A Lexer object uses simplified Match() and error recovery mechanisms in the interest of speed
Antlr.Runtime.MessagesA strongly-typed resource class, for looking up localized strings, etc
Antlr.Runtime.MismatchedNotSetException
Antlr.Runtime.MismatchedRangeException
Antlr.Runtime.MismatchedSetException
Antlr.Runtime.MismatchedTokenExceptionA mismatched char or Token or tree node
Antlr.Runtime.MismatchedTreeNodeException
Antlr.Runtime.MissingTokenExceptionWe were expecting a token but it's not found. The current token is actually what we wanted next. Used for tree node errors too
Antlr.Runtime.NoViableAltException
Antlr.Runtime.ParserA parser for TokenStreams. Parser grammars result in a subclass of this
Antlr.Runtime.ParserRuleReturnScopeRules that return more than a single value must return an object containing all the values. Besides the properties defined in RuleLabelScope.PredefinedRulePropertiesScope there may be user-defined return values. This class simply defines the minimum properties that are always defined and methods to access the others that might be available depending on output option such as template and tree
Antlr.Runtime.Debug.ParseTreeBuilderThis parser listener tracks rule entry/exit and token matches to build a simple parse tree using ParseTree nodes
Antlr.Runtime.Debug.ProfilerUsing the debug event interface, track what is happening in the parser and record statistics about the runtime
Antlr.Runtime.RecognizerSharedStateThe set of fields needed by an abstract recognizer to recognize input and recover from errors
Antlr.Runtime.Debug.RemoteDebugEventSocketListener
Antlr.Runtime.Debug.RemoteDebugEventSocketListener.ProxyToken
Antlr.Runtime.Debug.RemoteDebugEventSocketListener.ProxyTree
Antlr.Runtime.Tree.RewriteCardinalityExceptionBase class for all exceptions thrown during AST rewrite construction
Antlr.Runtime.Tree.RewriteEarlyExitExceptionNo elements within a (...)+ in a rewrite rule
Antlr.Runtime.Tree.RewriteEmptyStreamExceptionRef to ID or expr but no tokens in ID stream or subtrees in expr stream
Antlr.Runtime.Tests.RewriteRuleXxxxStreamFixture
Antlr.Runtime.Tests.TestDriver
Antlr.Runtime.Tests.TestFixtureBase
Antlr.Runtime.TokenRewriteStreamUseful for dumping out the input stream after doing some augmentation or other manipulations
Antlr.Runtime.TokenRewriteStream.DeleteOp
Antlr.Runtime.TokenRewriteStream.InsertBeforeOp
Antlr.Runtime.TokenRewriteStream.ReplaceOpI'm going to try replacing range from x..y with (y-x)+1 ReplaceOp instructions
Antlr.Runtime.TokenRewriteStream.RewriteOpComparer
Antlr.Runtime.TokenRewriteStream.RewriteOperation
Antlr.Runtime.Debug.TraceDebugEventListenerPrint out (most of) the events... Useful for debugging, testing..
Antlr.Runtime.Debug.TracerThe default tracer mimics the traceParser behavior of ANTLR 2.x. This listens for debugging events from the parser and implies that you cannot debug and trace at the same time
Antlr.Runtime.Tree.Tree
Antlr.Runtime.Tree.TreePatternLexer
Antlr.Runtime.Tree.TreePatternParser
Antlr.Runtime.Tree.TreeRuleReturnScopeThis is identical to the ParserRuleReturnScope except that the start property is a tree node and not a Token object when you are parsing trees. To be generic the tree node types have to be Object :(
Antlr.Runtime.Tree.TreeWizard.ContextVisitor
Antlr.Runtime.Tree.TreeWizard.InvokeVisitorOnPatternMatchContextVisitor
Antlr.Runtime.Tree.TreeWizard.PatternMatchingContextVisitor
Antlr.Runtime.Tree.TreeWizard.RecordAllElementsVisitor
Antlr.Runtime.Tree.TreeWizard.TreePatternWhen using label:TOKENNAME in a tree for parse(), we must track the label
Antlr.Runtime.Tree.TreeWizard.TreePatternTreeAdaptorThis adaptor creates TreePattern objects for use during scan()
Antlr.Runtime.Tree.TreeWizard.Visitor
Antlr.Runtime.Tree.TreeWizard.WildcardTreePattern
Antlr.Runtime.Tests.TreeWizardFixture
Antlr.Runtime.Tests.TreeWizardFixture.RecordAllElementsVisitor
Antlr.Runtime.Tests.TreeWizardFixture.Test1ContextVisitor
Antlr.Runtime.Tests.TreeWizardFixture.Test2ContextVisitor
Antlr.Runtime.Tree.UnBufferedTreeNodeStream.TreeWalkStateWhen walking ahead with cyclic DFA or for syntactic predicates, we need to record the state of the tree node stream. This class wraps up the current state of the UnBufferedTreeNodeStream. Calling Mark() will push another of these on the markers stack
Antlr.Runtime.UnwantedTokenExceptionAn extra token while parsing a TokenStream

Generated on Wed Oct 1 14:13:20 2008 for ANTLR API by  doxygen 1.5.5