Linux Manuals session 3

NAME include/antlr3.h – SYNOPSIS #include <antlr3defs.h> #include <antlr3errors.h> #include <antlr3exception.h> #include <antlr3encodings.h> #include <antlr3string.h> #include <antlr3input.h> #include <antlr3cyclicdfa.h> #include <antlr3intstream.h> #include <antlr3filestream.h> #include <antlr3collections.h> #include <antlr3recognizersharedstate.h> #include <antlr3baserecognizer.h> #include <antlr3commontoken.h> #include <antlr3tokenstream.h> #include <antlr3bitset.h> #include <antlr3lexer.h> #include <antlr3parser.h> #include <antlr3basetreeadaptor.h> #include <antlr3commontreeadaptor.h> #include <antlr3rewritestreams.h> #include <antlr3debugeventlistener.h> Author Generated automatically by Doxygen for ANTLR3C from the…

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…

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…

NAME ANTLR3_HASH_ENTRY_struct – Internal structure representing an element in a hash bucket. SYNOPSIS #include <antlr3collections.h> Public Member Functions void (ANTLR3_CDECL *free)(void *data) Pointer to routine that knows how to release the memory structure pointed at by data. Data Fields void * data Pointer to the data for this particular entry. ANTLR3_HASH_KEY keybase Key that created…

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

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…

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…

ANTLR3_ARBORETUM_struct – ANTLR3 Tree factory interface to create lots of trees efficiently rather than creating and freeing lots of little bits of memory. Synopsis #include <antlr3commontree.h> Data Fields void(* close )(struct ANTLR3_ARBORETUM_struct *factory) Pointer to a function the destroys the factory. pANTLR3_BASE_TREE(* newFromToken )(struct ANTLR3_ARBORETUM_struct *factory, pANTLR3_COMMON_TOKEN token) pANTLR3_BASE_TREE(* newFromTree )(struct ANTLR3_ARBORETUM_struct *factory, pANTLR3_COMMON_TREE tree)…

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

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…

ANTLR3_ARBORETUM_struct – ANTLR3 Tree factory interface to create lots of trees efficiently rather than creating and freeing lots of little bits of memory. Synopsis #include <antlr3commontree.h> Data Fields void(* close )(struct ANTLR3_ARBORETUM_struct *factory) Pointer to a function the destroys the factory. pANTLR3_BASE_TREE(* newFromToken )(struct ANTLR3_ARBORETUM_struct *factory, pANTLR3_COMMON_TOKEN token) pANTLR3_BASE_TREE(* newFromTree )(struct ANTLR3_ARBORETUM_struct *factory, pANTLR3_COMMON_TREE tree)…

NAME ANTLR3_BASE_TREE_struct – A generic tree implementation with no payload. SYNOPSIS #include <antlr3basetree.h> Data Fields void(* addChild )(struct ANTLR3_BASE_TREE_struct *tree, void *child) void(* addChildren )(struct ANTLR3_BASE_TREE_struct *tree, pANTLR3_LIST kids) pANTLR3_VECTOR children The list of all the children that belong to this node. void(* createChildrenList )(struct ANTLR3_BASE_TREE_struct *tree) void *(* deleteChild )(struct ANTLR3_BASE_TREE_struct *tree, ANTLR3_UINT32 i)…

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

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

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

NAME 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 Fields const ANTLR3_INT32 *const accept const ANTLR3_INT32 decisionNumber Decision number…