Linux Manuals session 3

src/antlr3convertutf.c – Synopsis #include ‘antlr3convertutf.h’ Defines #define false 0 #define true 1 #define UNI_SUR_HIGH_END (UTF32)0xDBFF #define UNI_SUR_HIGH_START (UTF32)0xD800 #define UNI_SUR_LOW_END (UTF32)0xDFFF #define UNI_SUR_LOW_START (UTF32)0xDC00 Functions ConversionResult ConvertUTF16toUTF32 (const UTF16 **sourceStart, const UTF16 *sourceEnd, UTF32 **targetStart, UTF32 *targetEnd, ConversionFlags flags) ConversionResult ConvertUTF16toUTF8 (const UTF16 **sourceStart, const UTF16 *sourceEnd, UTF8 **targetStart, UTF8 *targetEnd, ConversionFlags flags) ConversionResult ConvertUTF32toUTF16…

NAME ANTLR3_STACK_struct – Structure that represents a Stack collection. SYNOPSIS #include <antlr3collections.h> Data Fields void(* free )(struct ANTLR3_STACK_struct *stack) void *(* get )(struct ANTLR3_STACK_struct *stack, ANTLR3_INTKEY key) void *(* peek )(struct ANTLR3_STACK_struct *stack) void *(* pop )(struct ANTLR3_STACK_struct *stack) ANTLR3_BOOLEAN(* push )(struct ANTLR3_STACK_struct *stack, void *element, void(ANTLR3_CDECL *freeptr)(void *)) ANTLR3_UINT32(* size )(struct ANTLR3_STACK_struct *stack) void…

NAME ANTLR3_COMMON_TOKEN_STREAM_struct – Common token stream is an implementation of ANTLR_TOKEN_STREAM for the default parsers and recognizers. SYNOPSIS #include <antlr3tokenstream.h> Data Fields ANTLR3_UINT32 channel pANTLR3_LIST channelOverrides Override map of tokens. ANTLR3_BOOLEAN discardOffChannel If this flag is set to ANTLR3_TRUE, then tokens that the stream sees that are not in the channel that this stream is…

ANTLR3_DEBUG_EVENT_LISTENER_struct – The ANTLR3 debugging interface for communicating with ANLTR Works. Synopsis #include <antlr3debugeventlistener.h> Data Fields void(* ack )(pANTLR3_DEBUG_EVENT_LISTENER delboy) Retrieve acknowledge response from the debugger. pANTLR3_BASE_TREE_ADAPTOR adaptor Allows the debug event system to access the adapter in use by the recognizer, if this is a tree parser of some sort. void(* addChild )(pANTLR3_DEBUG_EVENT_LISTENER delboy,…

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_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_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_TOKEN_STREAM_struct – Definition of the ANTLR3 common token stream interface. Synopsis #include <antlr3tokenstream.h> Data Fields pANTLR3_COMMON_TOKEN(* _LT )(struct ANTLR3_TOKEN_STREAM_struct *tokenStream, ANTLR3_INT32 k) Get Token at current input pointer + i ahead where i=1 is next Token. pANTLR3_DEBUG_EVENT_LISTENER debugger Debugger interface, is this is a debugging token stream. void(* free )(struct ANTLR3_TOKEN_STREAM_struct *tokenStream) Function that knows…

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

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

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

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…

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…

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…

src/antlr3rewritestreams.c – Implementation of token/tree streams that are used by the tree re-write rules to manipulate the tokens and trees produced by rules that are subject to rewrite directives. Synopsis #include <antlr3rewritestreams.h> Functions static void * _next (pANTLR3_REWRITE_RULE_ELEMENT_STREAM stream) Do the work of getting the next element, making sure that it’s a tree node or…

src/antlr3rewritestreams.c – Implementation of token/tree streams that are used by the tree re-write rules to manipulate the tokens and trees produced by rules that are subject to rewrite directives. Synopsis #include <antlr3rewritestreams.h> Functions static void * _next (pANTLR3_REWRITE_RULE_ELEMENT_STREAM stream) Do the work of getting the next element, making sure that it’s a tree node or…