Linux Manuals session 3

NAME 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…

NAME ANTLR3_VECTOR_struct – SYNOPSIS #include <antlr3collections.h> Public Member Functions void (ANTLR3_CDECL *free)(struct ANTLR3_VECTOR_struct *vector) Data Fields ANTLR3_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….

NAME 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…

NAME 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…

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…

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…

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(* addi…

NAME 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 Fields void(* 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…

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…

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…

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…

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…

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…

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_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…

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_BASE_TREE_ADAPTOR_struct – Synopsis #include <antlr3basetreeadaptor.h> Data Fields void(* 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…

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…

NAME 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…