Section 3: library functions
ANTLR3_INT_TRIE_NODE_struct – Structure that defines an element/node in an ANTLR3_INT_TRIE. Synopsis #include <antlr3collections.h> Data Fields ANTLR3_UINT32 bitNum This is the left/right bit index for traversal along the nodes. pANTLR3_TRIE_ENTRY buckets This is the data bucket(s) that the key indexes, which may be NULL. ANTLR3_INTKEY key This is the actual key that the entry represents if…
src/antlr3bitset.c – Contains the C implementation of ANTLR3 bitsets as adapted from Terence Parr’s Java implementation. Synopsis #include <antlr3bitset.h> Functions static void antlr3BitsetAdd (pANTLR3_BITSET bitset, ANTLR3_INT32 bit) static pANTLR3_BITSET antlr3BitsetClone (pANTLR3_BITSET inSet) ANTLR3_API pANTLR3_BITSET antlr3BitsetCopy (pANTLR3_BITSET_LIST blist) static ANTLR3_BOOLEAN antlr3BitsetEquals (pANTLR3_BITSET bitset1, pANTLR3_BITSET bitset2) static void antlr3BitsetFree (pANTLR3_BITSET bitset) static ANTLR3_BOOLEAN antlr3BitsetIsNil (pANTLR3_BITSET bitset) ANTLR3_API…
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…
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/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…
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_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…
NAME ANTLR3_COMMON_TREE_ADAPTOR_struct – SYNOPSIS #include <antlr3commontreeadaptor.h> Data Fields pANTLR3_ARBORETUM arboretum Tree factory for producing new nodes as required without needing to track memory allocation per node. ANTLR3_TREE_ADAPTOR baseAdaptor Base interface implementation, embedded structure. void * super Any enclosing structure/class can use this pointer to point to its own interface. Field Documentation pANTLR3_ARBORETUM ANTLR3_COMMON_TREE_ADAPTOR_struct::arboretum Tree factory…
src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. Synopsis #include <antlr3string.h> Functions static pANTLR3_UINT8 addc16 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addc8 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addi16 (pANTLR3_STRING string, ANTLR3_INT32 i) static pANTLR3_UINT8 addi8 (pANTLR3_STRING string, ANTLR3_INT32 i) ANTLR3_API pANTLR3_STRING_FACTORY antlr3StringFactoryNew () ANTLR3_API pANTLR3_STRING_FACTORY antlr3UCS2StringFactoryNew () Create a string factory…
NAME src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. SYNOPSIS #include <antlr3string.h> Functions static pANTLR3_UINT8 addc16 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addc8 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addi16 (pANTLR3_STRING string, ANTLR3_INT32 i) static pANTLR3_UINT8 addi8 (pANTLR3_STRING string, ANTLR3_INT32 i) ANTLR3_API pANTLR3_STRING_FACTORY antlr3StringFactoryNew () ANTLR3_API pANTLR3_STRING_FACTORY antlr3UCS2StringFactoryNew () Create a string…
NAME src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. SYNOPSIS #include <antlr3string.h> Functions static pANTLR3_UINT8 addc16 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addc8 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addi16 (pANTLR3_STRING string, ANTLR3_INT32 i) static pANTLR3_UINT8 addi8 (pANTLR3_STRING string, ANTLR3_INT32 i) ANTLR3_API pANTLR3_STRING_FACTORY antlr3StringFactoryNew () ANTLR3_API pANTLR3_STRING_FACTORY antlr3UCS2StringFactoryNew () Create a string…
NAME src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. SYNOPSIS #include <antlr3string.h> Functions static pANTLR3_UINT8 addc16 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addc8 (pANTLR3_STRING string, ANTLR3_UINT32 c) static pANTLR3_UINT8 addi16 (pANTLR3_STRING string, ANTLR3_INT32 i) static pANTLR3_UINT8 addi8 (pANTLR3_STRING string, ANTLR3_INT32 i) ANTLR3_API pANTLR3_STRING_FACTORY antlr3StringFactoryNew () ANTLR3_API pANTLR3_STRING_FACTORY antlr3UCS2StringFactoryNew () Create a string…
NAME ANTLR3_STRING_struct – Base string class tracks the allocations and provides simple string tracking functions. SYNOPSIS #include <antlr3string.h> Data Fields pANTLR3_UINT8(* addc )(struct ANTLR3_STRING_struct *string, ANTLR3_UINT32 c) Pointer to function that adds a single character to the end of the string, in the encoding of the string – 8 bit, 16 bit, utf-8 etc. pANTLR3_UINT8(*…
NAME API Typedefs and Structs – These structures (and the typedefs that you use to reference them and their pointers) are the C equivalent of objects. Data Structures struct ANTLR3_INPUT_STREAM_struct Master context structure for an ANTLR3 C runtime based input stream. Modules ANTLR3_BASE_RECOGNIZER – Base Recognizer Class Definition This is the definition of the base…
NAME API Implementation functions – API implementation functions are the default implementation of each of the methods in a particular typedef structure. Modules pANTLR3_BASE_RECOGNIZER Base Recognizer Implementation The base recognizer interface is implemented by all higher level recognizers such as pANTLR3_PARSER and provides methods common to all recognizers. pANTLR3_RECOGNIZER_SHARED_STATE – Recognizer Shared State Implementation The…
NAME API Classes – The API classes are divided into the typdefs (and their underlying structs) that are the containers for each ‘object’ within the ANTLR3C runtime, and their implementations (the functions that are installed by default in to these structures when you create them. Modules API Typedefs and Structs These structures (and the typedefs…
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…
ANTLR3_HASH_TABLE_struct – Structure that tracks a hash table. Synopsis #include <antlr3collections.h> Data Fields int allowDups Indicates whether the table allows duplicate keys. pANTLR3_HASH_BUCKET buckets Points to the memory where the array of buckets starts. ANTLR3_UINT32 count How many elements currently exist in the table. void(* del )(struct ANTLR3_HASH_TABLE_struct *table, void *key) void(* delI )(struct ANTLR3_HASH_TABLE_struct…