Linux Manuals session 3

src/antlr3debughandlers.c – Provides the debugging functions invoked by a recognizer built using the debug generator mode of the antlr tool. Synopsis #include <antlr3.h> Functions static void ack (pANTLR3_DEBUG_EVENT_LISTENER delboy) static void addChild (pANTLR3_DEBUG_EVENT_LISTENER delboy, pANTLR3_BASE_TREE root, pANTLR3_BASE_TREE child) ANTLR3_API pANTLR3_DEBUG_EVENT_LISTENER antlr3DebugListenerNew () Create and initialize a new debug event listener that can be connected to…

ANTLR3_RECOGNIZER_SHARED_STATE_struct – All the data elements required to track the current state of any recognizer (lexer, parser, tree parser). Synopsis #include <antlr3recognizersharedstate.h> Data Fields ANTLR3_INT32 backtracking If 0, no backtracking is going on. ANTLR3_UINT32 channel The channel number for the current token. void * custom ANTLR3_BOOLEAN error If set to ANTLR3_TRUE then the recognizer has…

ANTLR3_BASE_RECOGNIZER_struct – Base tracking context structure for all types of recognizers. Synopsis #include <antlr3baserecognizer.h> Data Fields ANTLR3_BOOLEAN(* alreadyParsedRule )(struct ANTLR3_BASE_RECOGNIZER_struct *recognizer, ANTLR3_MARKER ruleIndex) Pointer to function that determines whether the rule has parsed input at the current index in the input stream. void(* beginBacktrack )(struct ANTLR3_BASE_RECOGNIZER_struct *recognizer, ANTLR3_UINT32 level) Pointer to a function that is…

ANTLR3_RECOGNIZER_SHARED_STATE_struct – All the data elements required to track the current state of any recognizer (lexer, parser, tree parser). Synopsis #include <antlr3recognizersharedstate.h> Data Fields ANTLR3_INT32 backtracking If 0, no backtracking is going on. ANTLR3_UINT32 channel The channel number for the current token. void * custom ANTLR3_BOOLEAN error If set to ANTLR3_TRUE then the recognizer has…

src/antlr3commontreeadaptor.c – This is the standard tree adaptor used by the C runtime unless the grammar source file says to use anything different. Synopsis #include <antlr3commontreeadaptor.h> Functions ANTLR3_API pANTLR3_BASE_TREE_ADAPTOR ANTLR3_TREE_ADAPTORDebugNew (pANTLR3_STRING_FACTORY strFactory, pANTLR3_DEBUG_EVENT_LISTENER debugger) Debugging version of the tree adaptor (not normally called as generated code calls setDebugEventListener instead which changes a normal token stream…

ANTLR3_RECOGNIZER_SHARED_STATE_struct – All the data elements required to track the current state of any recognizer (lexer, parser, tree parser). Synopsis #include <antlr3recognizersharedstate.h> Data Fields ANTLR3_INT32 backtracking If 0, no backtracking is going on. ANTLR3_UINT32 channel The channel number for the current token. void * custom ANTLR3_BOOLEAN error If set to ANTLR3_TRUE then the recognizer has…

ANTLR3_RECOGNIZER_SHARED_STATE_struct – All the data elements required to track the current state of any recognizer (lexer, parser, tree parser). Synopsis #include <antlr3recognizersharedstate.h> Data Fields ANTLR3_INT32 backtracking If 0, no backtracking is going on. ANTLR3_UINT32 channel The channel number for the current token. void * custom ANTLR3_BOOLEAN error If set to ANTLR3_TRUE then the recognizer has…

ANTLR3_BITSET_struct – Synopsis #include <antlr3bitset.h> Data Fields void(* add )(struct ANTLR3_BITSET_struct *bitset, ANTLR3_INT32 bit) ANTLR3_BITSET_LIST blist The actual bits themselves. pANTLR3_BITSET(* bor )(struct ANTLR3_BITSET_struct *bitset1, struct ANTLR3_BITSET_struct *bitset2) void(* borInPlace )(struct ANTLR3_BITSET_struct *bitset, struct ANTLR3_BITSET_struct *bitset2) pANTLR3_BITSET(* clone )(struct ANTLR3_BITSET_struct *inSet) ANTLR3_BOOLEAN(* equals )(struct ANTLR3_BITSET_struct *bitset1, struct ANTLR3_BITSET_struct *bitset2) void(* free )(struct ANTLR3_BITSET_struct *bitset) void(*…

ANTLR3_CYCLIC_DFA_struct – Definition of a cyclic dfa structure such that it can be initialized at compile time and have only a single runtime function that can deal with all cyclic dfa structures and show Java how it is done ;-). Synopsis #include <antlr3cyclicdfa.h> Data Fields const ANTLR3_INT32 *const accept const ANTLR3_INT32 decisionNumber Decision number that…

ANTLR3_TOKEN_SOURCE_struct – Definition of a token source, which has a pointer to a function that returns the next token (using a token factory if it is going to be efficient) and a pointer to an ANTLR3_INPUT_STREAM. Synopsis #include <antlr3tokenstream.h> Data Fields ANTLR3_COMMON_TOKEN eofToken A special pre-allocated token, which signifies End Of Tokens. pANTLR3_STRING fileName When…

ANTLR3_CYCLIC_DFA_struct – Definition of a cyclic dfa structure such that it can be initialized at compile time and have only a single runtime function that can deal with all cyclic dfa structures and show Java how it is done ;-). Synopsis #include <antlr3cyclicdfa.h> Data Fields const ANTLR3_INT32 *const accept const ANTLR3_INT32 decisionNumber Decision number that…

ANTLR3_HASH_ENUM_struct – Internal structure representing an enumeration of a table. Synopsis #include <antlr3collections.h> Data Fields ANTLR3_UINT32 bucket pANTLR3_HASH_ENTRY entry void(* free )(struct ANTLR3_HASH_ENUM_struct *table) int(* next )(struct ANTLR3_HASH_ENUM_struct *en, pANTLR3_HASH_KEY *key, void **data) pANTLR3_HASH_TABLE table Detailed Description Internal structure representing an enumeration of a table. This is returned by antlr3Enumeration() Allows the programmer to traverse…

ANTLR3_COMMON_TREE_NODE_STREAM_struct – Synopsis #include <antlr3commontreenodestream.h> Data Fields ANTLR3_MARKER absoluteNodeIndex What node index did we just consume? i=0..n-1 for n node trees. pANTLR3_BASE_TREE_ADAPTOR adaptor Pointer to tree adaptor interface that manipulates/builds the tree. void(* addLookahead )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, pANTLR3_BASE_TREE node) void(* addNavigationNode )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_UINT32 ttype) ANTLR3_INT32 currentChildIndex Which child are we currently visiting? If…

ANTLR3_INT_TRIE_struct – Structure that defines an ANTLR3_INT_TRIE. Synopsis #include <antlr3collections.h> Data Fields ANTLR3_BOOLEAN(* add )(struct ANTLR3_INT_TRIE_struct *trie, ANTLR3_INTKEY key, ANTLR3_UINT32 type, ANTLR3_INTKEY intVal, void *data, void(ANTLR3_CDECL *freeptr)(void *)) ANTLR3_BOOLEAN allowDups ANTLR3_UINT32 count pANTLR3_INT_TRIE_NODE current ANTLR3_BOOLEAN(* del )(struct ANTLR3_INT_TRIE_struct *trie, ANTLR3_INTKEY key) void(* free )(struct ANTLR3_INT_TRIE_struct *trie) pANTLR3_TRIE_ENTRY(* get )(struct ANTLR3_INT_TRIE_struct *trie, ANTLR3_INTKEY key) pANTLR3_INT_TRIE_NODE root…

ANTLR3_LEXER_struct – Synopsis #include <antlr3lexer.h> Data Fields void * ctx A generated lexer has an mTokens() function, which needs the context pointer of the generated lexer, not the base lexer interface this is stored here and initialized by the generated code (or manually if this is a manually built lexer. pANTLR3_COMMON_TOKEN(* emit )(struct ANTLR3_LEXER_struct *lexer)…

ANTLR3_TREE_PARSER_struct – Internal structure representing an element in a hash bucket. Synopsis #include <antlr3treeparser.h> Data Fields pANTLR3_COMMON_TREE_NODE_STREAM ctnstream Pointer to the common tree node stream for the parser. void(* free )(struct ANTLR3_TREE_PARSER_struct *parser) Pointer to a function that knows how to free resources of an ANTLR3 tree parser. pANTLR3_COMMON_TREE_NODE_STREAM(* getTreeNodeStream )(struct ANTLR3_TREE_PARSER_struct *parser) Return a…

ANTLR3_TREE_NODE_STREAM_struct – Synopsis #include <antlr3commontreenodestream.h> Data Fields pANTLR3_BASE_TREE(* _LT )(struct ANTLR3_TREE_NODE_STREAM_struct *tns, ANTLR3_INT32 k) Get tree node at current input pointer + i ahead where i=1 is next node. pANTLR3_COMMON_TREE_NODE_STREAM ctns Any interface that implements this interface (is a super structure containing this structure), may store the pointer to itself here in the super pointer,…

src/antlr3commontreeadaptor.c – This is the standard tree adaptor used by the C runtime unless the grammar source file says to use anything different. Synopsis #include <antlr3commontreeadaptor.h> Functions ANTLR3_API pANTLR3_BASE_TREE_ADAPTOR ANTLR3_TREE_ADAPTORDebugNew (pANTLR3_STRING_FACTORY strFactory, pANTLR3_DEBUG_EVENT_LISTENER debugger) Debugging version of the tree adaptor (not normally called as generated code calls setDebugEventListener instead which changes a normal token stream…

src/antlr3basetreeadaptor.c – Contains the base functions that all tree adaptors start with. Synopsis #include <antlr3basetreeadaptor.h> Functions static void addChild (pANTLR3_BASE_TREE_ADAPTOR adaptor, pANTLR3_BASE_TREE t, pANTLR3_BASE_TREE child) Add a child to the tree t. static void addChildToken (pANTLR3_BASE_TREE_ADAPTOR adaptor, pANTLR3_BASE_TREE t, pANTLR3_COMMON_TOKEN child) Use the adaptor implementation to add a child node with the supplied token. ANTLR3_API…

src/antlr3basetreeadaptor.c – Contains the base functions that all tree adaptors start with. Synopsis #include <antlr3basetreeadaptor.h> Functions static void addChild (pANTLR3_BASE_TREE_ADAPTOR adaptor, pANTLR3_BASE_TREE t, pANTLR3_BASE_TREE child) Add a child to the tree t. static void addChildToken (pANTLR3_BASE_TREE_ADAPTOR adaptor, pANTLR3_BASE_TREE t, pANTLR3_COMMON_TOKEN child) Use the adaptor implementation to add a child node with the supplied token. ANTLR3_API…