Section 3: library functions
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 FieldsANTLR3_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 an exception…
ANTLR3_EXCEPTION_struct – Base structure for an ANTLR3 exception tracker. Synopsis#include <antlr3exception.h> Data FieldsANTLR3_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 decision number…
ANTLR3_BASE_TREE_ADAPTOR_struct – Synopsis#include <antlr3basetreeadaptor.h> Data Fieldsvoid(* addChild )(struct ANTLR3_BASE_TREE_ADAPTOR_struct *adaptor, void *t, void *child) void(* addChildToken )(struct ANTLR3_BASE_TREE_ADAPTOR_struct *adaptor, void *t, pANTLR3_COMMON_TOKEN child) void *(* becomeRoot )(struct ANTLR3_BASE_TREE_ADAPTOR_struct *adaptor, void *newRoot, void *oldRoot) void *(* becomeRootToken )(struct ANTLR3_BASE_TREE_ADAPTOR_struct *adaptor, void *newRoot, void *oldRoot) void *(* create )(struct ANTLR3_BASE_TREE_ADAPTOR_struct *adaptor, pANTLR3_COMMON_TOKEN payload) pANTLR3_COMMON_TOKEN(* createToken )(struct ANTLR3_BASE_TREE_ADAPTOR_struct…
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 FieldsANTLR3_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 specific to…
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 FieldsANTLR3_UINT32 channel The virtual channel that this token exists in. ANTLR3_INT32 charPosition The character position in the line that this token…
ANTLR3_BASE_RECOGNIZER_struct – Base tracking context structure for all types of recognizers. Synopsis#include <antlr3baserecognizer.h> Data FieldsANTLR3_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 a hook…
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 FieldsANTLR3_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 specific to…
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 FieldsANTLR3_UINT32 channel The virtual channel that this token exists in. ANTLR3_INT32 charPosition The character position in the line that this token…
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 Fieldsconst ANTLR3_INT32 *const accept const ANTLR3_INT32 decisionNumber Decision number that a particular…
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 Fieldsconst ANTLR3_INT32 *const accept const ANTLR3_INT32 decisionNumber Decision number that a particular…
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 Fieldsconst ANTLR3_INT32 *const accept const ANTLR3_INT32 decisionNumber Decision number that a particular…
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 Typedefstypedef ANTLR3_UINT16 UTF16 typedef ANTLR3_UINT32 UTF32 typedef ANTLR3_UINT8 UTF8 Enumerationsenum ConversionFlags { strictConversion = 0, lenientConversion } enum ConversionResult { conversionOK, sourceExhausted, targetExhausted, sourceIllegal } FunctionsConversionResult ConvertUTF16toUTF32 (const UTF16 **sourceStart, const UTF16 *sourceEnd, UTF32 **targetStart, UTF32…
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 Typedefstypedef ANTLR3_UINT16 UTF16 typedef ANTLR3_UINT32 UTF32 typedef ANTLR3_UINT8 UTF8 Enumerationsenum ConversionFlags { strictConversion = 0, lenientConversion } enum ConversionResult { conversionOK, sourceExhausted, targetExhausted, sourceIllegal } FunctionsConversionResult ConvertUTF16toUTF32 (const UTF16 **sourceStart, const UTF16 *sourceEnd, UTF32 **targetStart, UTF32…
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 Fieldsvoid(* 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 used to detect…
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’ Functionsstatic 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 enumeration. pANTLR3_HASH_ENUM…
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’ Functionsstatic 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 enumeration. pANTLR3_HASH_ENUM…
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> Functionsstatic 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 by ANTLRWorks…
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 FieldsANTLR3_COMMON_TOKEN eofToken A special pre-allocated token, which signifies End Of Tokens. pANTLR3_STRING fileName When the token…
src/antlr3tokenstream.c – Default implementation of CommonTokenStream. Synopsis#include <antlr3tokenstream.h> Functionsstatic 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 (pANTLR3_INT_STREAM is)…
src/antlr3tokenstream.c – Default implementation of CommonTokenStream. Synopsis#include <antlr3tokenstream.h> Functionsstatic 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 (pANTLR3_INT_STREAM is)…