Section 3: library functions
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_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…
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…
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_COMMON_TREE_NODE_STREAM_struct – Synopsis#include <antlr3commontreenodestream.h> Data FieldsANTLR3_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 -1 we…
ANTLR3_HASH_ENUM_struct – Internal structure representing an enumeration of a table. Synopsis#include <antlr3collections.h> Data FieldsANTLR3_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 DescriptionInternal structure representing an enumeration of a table. This is returned by antlr3Enumeration() Allows the programmer to traverse the table in…
ANTLR3_VECTOR_struct – Synopsis#include <antlr3collections.h> Public Member Functionsvoid (ANTLR3_CDECL *free)(struct ANTLR3_VECTOR_struct *vector) Data FieldsANTLR3_UINT32(* add )(struct ANTLR3_VECTOR_struct *vector, void *element, void(ANTLR3_CDECL *freeptr)(void *)) void(* clear )(struct ANTLR3_VECTOR_struct *vector) ANTLR3_UINT32 count Number of entries currently in the list;. void(* del )(struct ANTLR3_VECTOR_struct *vector, ANTLR3_UINT32 entry) pANTLR3_VECTOR_ELEMENT elements Array of pointers to vector elements. ANTLR3_UINT32 elementsSize Total number…
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_INPUT_STREAM_struct – Master context structure for an ANTLR3 C runtime based input stream. Synopsis#include <antlr3input.h> Data Fieldsvoid *(* _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 The offset…
src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. Synopsis#include <antlr3string.h> Functionsstatic 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 that is…
src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. Synopsis#include <antlr3string.h> Functionsstatic 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 that is…
ANTLR3_STRING_struct – Base string class tracks the allocations and provides simple string tracking functions. Synopsis#include <antlr3string.h> Data FieldspANTLR3_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(* addi )(struct ANTLR3_STRING_struct…
ANTLR3_STRING_FACTORY_struct – Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes. Synopsis#include <antlr3string.h> Data Fieldsvoid(* close )(struct ANTLR3_STRING_FACTORY_struct *factory) Pointer to function that closes the factory. void(* destroy )(struct ANTLR3_STRING_FACTORY_struct *factory, pANTLR3_STRING string) Pointer to function that deletes the string altogether. ANTLR3_UINT32 index pANTLR3_STRING(* newPtr )(struct…
src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. Synopsis#include <antlr3string.h> Functionsstatic 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 that is…
src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. Synopsis#include <antlr3string.h> Functionsstatic 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 that is…
src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. Synopsis#include <antlr3string.h> Functionsstatic 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 that is…
src/antlr3string.c – Implementation of the ANTLR3 string and string factory classes. Synopsis#include <antlr3string.h> Functionsstatic 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 that is…
ANTLR3_COMMON_TREE_NODE_STREAM_struct – Synopsis#include <antlr3commontreenodestream.h> Data FieldsANTLR3_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 -1 we…
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_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…