Section 3: library functions
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…
NAME ANTLR3_COMMON_TOKEN_struct – The definition of an ANTLR3 common token structure, which all implementations of a token stream should provide, installing any further structures in the custom pointer element of this structure. SYNOPSIS #include <antlr3commontoken.h> Data Fields ANTLR3_UINT32 channel The virtual channel that this token exists in. ANTLR3_INT32 charPosition The character position in the line…
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_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…
NAME 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…
include/antlr3convertutf.h – Synopsis #include <antlr3defs.h> Defines #define UNI_MAX_BMP (UTF32)0x0000FFFF #define UNI_MAX_LEGAL_UTF32 (UTF32)0x0010FFFF #define UNI_MAX_UTF16 (UTF32)0x0010FFFF #define UNI_MAX_UTF32 (UTF32)0x7FFFFFFF #define UNI_REPLACEMENT_CHAR (UTF32)0x0000FFFD Typedefs typedef ANTLR3_UINT16 UTF16 typedef ANTLR3_UINT32 UTF32 typedef ANTLR3_UINT8 UTF8 Enumerations enum ConversionFlags { strictConversion = 0, lenientConversion } enum ConversionResult { conversionOK, sourceExhausted, targetExhausted, sourceIllegal } Functions ConversionResult ConvertUTF16toUTF32 (const UTF16 **sourceStart, const…
include/antlr3convertutf.h – Synopsis #include <antlr3defs.h> Defines #define UNI_MAX_BMP (UTF32)0x0000FFFF #define UNI_MAX_LEGAL_UTF32 (UTF32)0x0010FFFF #define UNI_MAX_UTF16 (UTF32)0x0010FFFF #define UNI_MAX_UTF32 (UTF32)0x7FFFFFFF #define UNI_REPLACEMENT_CHAR (UTF32)0x0000FFFD Typedefs typedef ANTLR3_UINT16 UTF16 typedef ANTLR3_UINT32 UTF32 typedef ANTLR3_UINT8 UTF8 Enumerations enum ConversionFlags { strictConversion = 0, lenientConversion } enum ConversionResult { conversionOK, sourceExhausted, targetExhausted, sourceIllegal } Functions ConversionResult ConvertUTF16toUTF32 (const UTF16 **sourceStart, const…
NAME ANTLR3_TOPO_struct – A topological sort system that given a set of dependencies of a node m on node n, can sort them in dependency order. SYNOPSIS #include <antlr3collections.h> Data Fields void(* addEdge )(struct ANTLR3_TOPO_struct *topo, ANTLR3_UINT32 edge, ANTLR3_UINT32 dependency) A method that adds an edge from one node to another. pANTLR3_UINT32 cycle A vector…
src/antlr3collections.c – Provides a number of useful functions that are roughly equivalent to java HashTable and List for the purposes of Antlr 3 C runtime. Synopsis #include <antlr3.h> #include ‘antlr3collections.h’ Functions static void addEdge (pANTLR3_TOPO topo, ANTLR3_UINT32 edge, ANTLR3_UINT32 dependency) static void antlr3EnumFree (pANTLR3_HASH_ENUM en) Frees up the memory structures that represent a hash table…
src/antlr3collections.c – Provides a number of useful functions that are roughly equivalent to java HashTable and List for the purposes of Antlr 3 C runtime. Synopsis #include <antlr3.h> #include ‘antlr3collections.h’ Functions static void addEdge (pANTLR3_TOPO topo, ANTLR3_UINT32 edge, ANTLR3_UINT32 dependency) static void antlr3EnumFree (pANTLR3_HASH_ENUM en) Frees up the memory structures that represent a hash table…
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_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…
src/antlr3tokenstream.c – Default implementation of CommonTokenStream. Synopsis #include <antlr3tokenstream.h> Functions static ANTLR3_UINT32 _LA (pANTLR3_INT_STREAM is, ANTLR3_INT32 i) ANTLR3_API pANTLR3_COMMON_TOKEN_STREAM antlr3CommonTokenDebugStreamSourceNew (ANTLR3_UINT32 hint, pANTLR3_TOKEN_SOURCE source, pANTLR3_DEBUG_EVENT_LISTENER debugger) ANTLR3_API pANTLR3_COMMON_TOKEN_STREAM antlr3CommonTokenStreamNew (ANTLR3_UINT32 hint) ANTLR3_API pANTLR3_COMMON_TOKEN_STREAM antlr3CommonTokenStreamSourceNew (ANTLR3_UINT32 hint, pANTLR3_TOKEN_SOURCE source) static void antlr3CTSFree (pANTLR3_COMMON_TOKEN_STREAM stream) static void antlr3TokenStreamFree (pANTLR3_TOKEN_STREAM stream) ANTLR3_API pANTLR3_TOKEN_STREAM antlr3TokenStreamNew () static void consume…
src/antlr3tokenstream.c – Default implementation of CommonTokenStream. Synopsis #include <antlr3tokenstream.h> Functions static ANTLR3_UINT32 _LA (pANTLR3_INT_STREAM is, ANTLR3_INT32 i) ANTLR3_API pANTLR3_COMMON_TOKEN_STREAM antlr3CommonTokenDebugStreamSourceNew (ANTLR3_UINT32 hint, pANTLR3_TOKEN_SOURCE source, pANTLR3_DEBUG_EVENT_LISTENER debugger) ANTLR3_API pANTLR3_COMMON_TOKEN_STREAM antlr3CommonTokenStreamNew (ANTLR3_UINT32 hint) ANTLR3_API pANTLR3_COMMON_TOKEN_STREAM antlr3CommonTokenStreamSourceNew (ANTLR3_UINT32 hint, pANTLR3_TOKEN_SOURCE source) static void antlr3CTSFree (pANTLR3_COMMON_TOKEN_STREAM stream) static void antlr3TokenStreamFree (pANTLR3_TOKEN_STREAM stream) ANTLR3_API pANTLR3_TOKEN_STREAM antlr3TokenStreamNew () static void consume…
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_INPUT_STREAM_struct – Master context structure for an ANTLR3 C runtime based input stream. Synopsis #include <antlr3input.h> Data Fields void *(* _LT )(struct ANTLR3_INPUT_STREAM_struct *input, ANTLR3_INT32 lt) Pointer to function to return input stream element at 1 based offset from nextChar. ANTLR3_UINT8 charByteSize Indicates the size, in 8 bit units, of a single character. ANTLR3_INT32 charPositionInLine…
NAME src/antlr3commontreenodestream.c – Defines the implementation of the common node stream the default tree node stream used by ANTLR. SYNOPSIS #include <antlr3commontreenodestream.h> Functions static ANTLR3_UINT32 _LA (pANTLR3_INT_STREAM is, ANTLR3_INT32 i) static pANTLR3_BASE_TREE _LT (pANTLR3_TREE_NODE_STREAM tns, ANTLR3_INT32 k) static void addNavigationNode (pANTLR3_COMMON_TREE_NODE_STREAM ctns, ANTLR3_UINT32 ttype) static void antlr3CommonTreeNodeStreamFree (pANTLR3_COMMON_TREE_NODE_STREAM ctns) Free up any resources that belong…
ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct – A generic list of elements tracked in an alternative to be used in a -> rewrite rule. Synopsis #include <antlr3rewritestreams.h> Data Fields void *(* _next )(struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct *stream) pANTLR3_BASE_TREE_ADAPTOR adaptor Pointer to the tree adaptor in use for this stream. void(* add )(struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct *stream, void *el, void(ANTLR3_CDECL *freePtr)(void *)) Add a new…
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/antlr3commontreenodestream.c – Defines the implementation of the common node stream the default tree node stream used by ANTLR. Synopsis #include <antlr3commontreenodestream.h> Functions static ANTLR3_UINT32 _LA (pANTLR3_INT_STREAM is, ANTLR3_INT32 i) static pANTLR3_BASE_TREE _LT (pANTLR3_TREE_NODE_STREAM tns, ANTLR3_INT32 k) static void addNavigationNode (pANTLR3_COMMON_TREE_NODE_STREAM ctns, ANTLR3_UINT32 ttype) static void antlr3CommonTreeNodeStreamFree (pANTLR3_COMMON_TREE_NODE_STREAM ctns) Free up any resources that belong to…