Linux Manuals session 3

src/antlr3commontoken.c – Synopsis #include <antlr3.h> Functions ANTLR3_API pANTLR3_COMMON_TOKEN antlr3CommonTokenNew (ANTLR3_UINT32 ttype) ANTLR3_API void antlr3SetTokenAPI (pANTLR3_COMMON_TOKEN token) ANTLR3_API pANTLR3_TOKEN_FACTORY antlr3TokenFactoryNew (pANTLR3_INPUT_STREAM input) static void factoryClose (pANTLR3_TOKEN_FACTORY factory) static ANTLR3_UINT32 getChannel (pANTLR3_COMMON_TOKEN token) static ANTLR3_INT32 getCharPositionInLine (pANTLR3_COMMON_TOKEN token) static ANTLR3_UINT32 getLine (pANTLR3_COMMON_TOKEN token) static ANTLR3_MARKER getStartIndex (pANTLR3_COMMON_TOKEN token) static ANTLR3_MARKER getStopIndex (pANTLR3_COMMON_TOKEN token) static pANTLR3_STRING getText (pANTLR3_COMMON_TOKEN…

ANTLR3_COMMON_TREE_struct – Interface for an ANTLR3 common tree which is what gets passed around by the AST producing parser. Synopsis #include <antlr3commontree.h> Data Fields ANTLR3_BASE_TREE baseTree An encapsulated BASE TREE structure (NOT a pointer) that performs a lot of the dirty work of node management To this we add just a few functions that are…

ANTLR3_EXCEPTION_struct – Base structure for an ANTLR3 exception tracker. Synopsis #include <antlr3exception.h> Data Fields ANTLR3_UCHAR c The current character when an error occurred – for lexers. ANTLR3_INT32 charPositionInLine Character position in the line where the error occurred. void * custom Pointer for you, the programmer to add anything you like to an exception. ANTLR3_UINT32 decisionNum…

ANTLR3_EXCEPTION_struct – Base structure for an ANTLR3 exception tracker. Synopsis #include <antlr3exception.h> Data Fields ANTLR3_UCHAR c The current character when an error occurred – for lexers. ANTLR3_INT32 charPositionInLine Character position in the line where the error occurred. void * custom Pointer for you, the programmer to add anything you like to an exception. ANTLR3_UINT32 decisionNum…

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…

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…

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…