ANTLR3_COMMON_...E_STREAM_struct(3)

📦 version 3.4, in fedora 43

🦋 ANTLR3_COMMON_TREE_NODE_STREAM_struct 🦋

from the ANTLR3C manual, section 3 — bestie, we're doing struct internals today and honestly? it's giving ✨backstage tour✨

✨ NAME ✨

ANTLR3_COMMON_TREE_NODE_STREAM_struct — that's the whole name, that's it, that's the girl 💅

🌸 SYNOPSIS 🌸

okay so first things first, you gotta pull in the header, no cap:

#include <antlr3commontreenodestream.h>

🎀 Data Fields 🎀

bestie. there are a lot of fields here. like, a lot a lot. we're going through every single one, don't panic, I got you 🫶

  • ANTLR3_MARKER absoluteNodeIndex — so like... which node did we just consume? that one. this tracks it 💖
  • pANTLR3_BASE_TREE_ADAPTOR adaptor — a pointer to the tree adaptor interface, aka the thing that manipulates and builds the tree 🌳
  • void(* addLookahead )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, pANTLR3_BASE_TREE node) — a function pointer field. the page gives us the signature and literally nothing else, so I'm not gonna make stuff up 🙈
  • void(* addNavigationNode )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_UINT32 ttype) — another function pointer, another mysterious no-blurb moment 💀 signature's all we got
  • ANTLR3_INT32 currentChildIndex — which child are we currently visiting? this one knows 👀
  • pANTLR3_BASE_TREE currentNode — which node are we currently visiting? same energy, different field ✨
  • ANTLR3_COMMON_TREE DOWN — a dummy tree node that says "we're descending into a child tree" 🦋
  • ANTLR3_COMMON_TREE EOF_NODE — a dummy tree node that marks the termination point of the tree. it's giving end of the line 🛑
  • void(* fill )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_INT32 k) — function pointer, no description in the source, moving on 🧚
  • void(* free )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, again with zero blurb. iconic behavior honestly 💅
  • ANTLR3_UINT32(* getLookaheadSize )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description given 🙈
  • pANTLR3_BASE_TREE(* handleRootnode )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, signature only, no notes 💀
  • ANTLR3_BOOLEAN(* hasNext )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, and the page is staying silent about it 🤐
  • ANTLR3_BOOLEAN(* hasUniqueNavigationNodes )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description here either 🌸
  • ANTLR3_UINT32 head — lookAhead[head] is the first symbol of lookahead, LT(1). periodt 💖
  • ANTLR3_COMMON_TREE INVALID_NODE — a dummy node that gets returned if we need to signal an invalid node for any reason. the "something went wrong" girlie 😭
  • ANTLR3_BOOLEAN isRewriter — tells you whether this node stream was derived from a prior node stream — like, for a rewriting tree parser for instance 🔁
  • pANTLR3_BASE_TREE * lookAhead — the buffer tree node stream, there for use with LT(i) ✨
  • ANTLR3_UINT32 lookAheadLength — how many elements are available in the lookahead buffer at any given moment 🔢
  • pANTLR3_VECTOR markers — calls to mark() can be nested, so we gotta keep a whole stack of them. stack of markers, lowkey iconic 📚
  • pANTLR3_BASE_TREE(* newDownNode )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no blurb, we move 🧚
  • pANTLR3_BASE_TREE(* newUpNode )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, again no description 💅
  • pANTLR3_BASE_TREE(* next )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, signature only 🙈
  • pANTLR3_VECTOR nodes — the complete mapping from stream index to tree node. the whole map, no cap 🗺️
  • pANTLR3_STACK nodeStack — as we walk down the nodes we have to track parent nodes, so we know where to go back to after walking the last child of a node 🫶
  • ANTLR3_INT32 p — the current index into the nodes vector, for the tree we're currently parsing and possibly rewriting 👑
  • ANTLR3_INT32(* pop )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description given 🌸
  • pANTLR3_BASE_TREE previousNode — which node did we last visit? the one before this one, bestie 💭
  • void(* push )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_INT32 index) — function pointer, page says nothing else about it 🤐
  • void(* reset )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no blurb 💀
  • pANTLR3_BASE_TREE root — which tree are we navigating? that tree. the main character of the whole operation 🌳✨
  • pANTLR3_STRING_FACTORY stringFactory — a string factory for anything that wants to make strings — like a tree representation, or some copy of the text, etc. etc. 🎀
  • void * super — any interface that implements this interface (aka is a super structure containing this structure) can stash a pointer to itself right here in the super pointer. and just so you know: the common tree node stream does not use it 🙈
  • ANTLR3_UINT32 tail — new lookahead goes in at lookahead[tail] 🦋
  • pANTLR3_TREE_NODE_STREAM tnstream — a pointer to the tree node stream interface 🌈
  • ANTLR3_BOOLEAN uniqueNavigationNodes — if this is set to ANTLR3_TRUE, then the navigation nodes UP and DOWN get duplicated rather than reused inside the tree. copy, don't reuse, periodt 💅
  • ANTLR3_COMMON_TREE UP — a dummy tree node that says "we're descending up to a parent tree" ⬆️
  • pANTLR3_BASE_TREE(* visitChild )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_UINT32 child) — function pointer, no description provided 🙈
  • void(* walkBackToMostRecentNodeWithUnvisitedChildren )(struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, signature only, no notes 💀
⚠️ heads up bestie — this is only part 1 of the page. more is coming, don't go anywhere 🫶

✨ Field Documentation ✨

Okay bestie, here's the full tea on every single field in this struct. No skips. 💅

  • ANTLR3_MARKER ANTLR3_COMMON_TREE_NODE_STREAM_struct::absoluteNodeIndex — bestie, this is literally the node index we just consumed. It's i=0..n-1 for n node trees. IntStream.next is hence 1 + this value. Size will be same. 💅
  • pANTLR3_BASE_TREE_ADAPTOR ANTLR3_COMMON_TREE_NODE_STREAM_struct::adaptor — a pointer to the tree adaptor interface that manipulates/builds the tree. 🌳
    • Referenced by antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), fillBuffer(), and getTreeAdaptor().
  • void(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::addLookahead) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, pANTLR3_BASE_TREE node) — a function pointer, no extra deets in the source. 🤷‍♀️
  • void(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::addNavigationNode) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_UINT32 ttype) — function pointer, no description, but it's referenced by some real ones. ✨
    • Referenced by antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), and fillBuffer().
  • ANTLR3_INT32 ANTLR3_COMMON_TREE_NODE_STREAM_struct::currentChildIndex — which child are we currently visiting? If -1 we have not visited this node yet; next consume() request will set currentIndex to 0. 🧐
  • pANTLR3_BASE_TREE ANTLR3_COMMON_TREE_NODE_STREAM_struct::currentNode — which node are we currently visiting? 👀
  • ANTLR3_COMMON_TREE ANTLR3_COMMON_TREE_NODE_STREAM_struct::DOWN — dummy tree node that indicates a descent into a child tree. Initialized by a call to create a new interface. 🌳
    • Referenced by addNavigationNode(), antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • ANTLR3_COMMON_TREE ANTLR3_COMMON_TREE_NODE_STREAM_struct::EOF_NODE — dummy tree node that indicates the termination point of the tree. Initialized by a call to create a new interface. 🛑
    • Referenced by _LT(), antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), and getMissingSymbol().
  • void(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::fill) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_INT32 k) — function pointer, no description. 💅
  • void(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::free) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description but it's referenced. 🗑️
    • Referenced by antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • ANTLR3_UINT32(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::getLookaheadSize) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. 👀
    • Referenced by antlr3CommonTreeNodeStreamNewStream().
  • pANTLR3_BASE_TREE(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::handleRootnode) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. 🌱
  • ANTLR3_BOOLEAN(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::hasNext) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. ✅
  • ANTLR3_BOOLEAN(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::hasUniqueNavigationNodes) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. ✨
    • Referenced by addNavigationNode(), antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • ANTLR3_UINT32 ANTLR3_COMMON_TREE_NODE_STREAM_struct::head — lookAhead[head] is the first symbol of lookahead, LT(1). 🔍
    • Referenced by getLookaheadSize().
  • ANTLR3_COMMON_TREE ANTLR3_COMMON_TREE_NODE_STREAM_struct::INVALID_NODE — dummy node that is returned if we need to indicate an invalid node for any reason. 🚫
    • Referenced by _LT(), antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), and LB().
  • ANTLR3_BOOLEAN ANTLR3_COMMON_TREE_NODE_STREAM_struct::isRewriter — indicates whether this node stream was derived from a prior node stream to be used by a rewriting tree parser for instance. If this flag is set to ANTLR3_TRUE, then when this stream is closed it will not free the root tree as this tree always belongs to the origniating node stream. 🧬
    • Referenced by antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNewStream(), and reset().
  • pANTLR3_BASE_TREE* ANTLR3_COMMON_TREE_NODE_STREAM_struct::lookAhead — buffer tree node stream for use with LT(i). This list grows to fit new lookahead depths, but consume() wraps like a circular buffer. 🔄
  • ANTLR3_UINT32 ANTLR3_COMMON_TREE_NODE_STREAM_struct::lookAheadLength — number of elements available in the lookahead buffer at any point in time. This is the current size of the array. 📏
    • Referenced by getLookaheadSize().
  • pANTLR3_VECTOR ANTLR3_COMMON_TREE_NODE_STREAM_struct::markers — calls to mark() may be nested so we have to track a stack of them. The marker is an index into this stack. Index 0 is the first marker. This is a List<TreeWalkState> 📚
    • Referenced by antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • pANTLR3_BASE_TREE(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::newDownNode) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. ⬇️
    • Referenced by addNavigationNode(), antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • pANTLR3_BASE_TREE(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::newUpNode) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. ⬆️
    • Referenced by addNavigationNode(), antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • pANTLR3_BASE_TREE(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::next) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. ➡️
  • pANTLR3_VECTOR ANTLR3_COMMON_TREE_NODE_STREAM_struct::nodes — the complete mapping from stream index to tree node. This buffer includes pointers to DOWN, UP, and EOF nodes. It is built upon ctor invocation. The elements are type Object as we don't what the trees look like. 🤔 Load upon first need of the buffer so we can set token types of interest for reverseIndexing. Slows us down a wee bit to do all of the if p==-1 testing everywhere though, though in C you won't really be able to measure this. 😅 Must be freed when the tree node stream is torn down. 🧹
    • Referenced by _LT(), addNavigationNode(), antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), fillBuffer(), get(), LB(), and size().
  • pANTLR3_STACK ANTLR3_COMMON_TREE_NODE_STREAM_struct::nodeStack — as we walk down the nodes, we must track parent nodes so we know where to go after walking the last child of a node. When visiting a child, push current node and current index (current index is first stored in the tree node structure to avoid two stacks. 📚
    • Referenced by antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), pop(), push(), and reset().
  • ANTLR3_INT32 ANTLR3_COMMON_TREE_NODE_STREAM_struct::p — the current index into the nodes vector of the current tree we are parsing and possibly rewriting. 📍
    • Referenced by _LT(), antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), consume(), fillBufferRoot(), get(), LB(), mark(), push(), reset(), seek(), size(), and tindex().
  • ANTLR3_INT32(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::pop) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. 🎈
    • Referenced by antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • pANTLR3_BASE_TREE ANTLR3_COMMON_TREE_NODE_STREAM_struct::previousNode — which node did we last visit? Used for LT(-1) 🔙
  • void(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::push) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_INT32 index) — function pointer, no description. 📥
    • Referenced by antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • void(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::reset) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. 🔄
    • Referenced by antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), and setTreeNodeStream().
  • pANTLR3_BASE_TREE ANTLR3_COMMON_TREE_NODE_STREAM_struct::root — which tree are we navigating ? 🌳
    • Referenced by antlr3CommonTreeNodeStreamNewStream(), antlr3CommonTreeNodeStreamNewTree(), fillBufferRoot(), getTreeSource(), and toString().
  • pANTLR3_STRING_FACTORY ANTLR3_COMMON_TREE_NODE_STREAM_struct::stringFactory — string factory for use by anything that wishes to create strings such as a tree representation or some copy of the text etc. 🏭
    • Referenced by antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), toStringSS(), and toStringWork().
  • void* ANTLR3_COMMON_TREE_NODE_STREAM_struct::super — any interface that implements this interface (is a super structure containing this structure), may store the pointer to itself here in the super pointer, which is not used by the common tree node stream. 🦸
    • Referenced by antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • ANTLR3_UINT32 ANTLR3_COMMON_TREE_NODE_STREAM_struct::tail — add new lookahead at lookahead[tail]. tail wraps around at the end of the lookahead buffer so tail could be less than head. 🔁
    • Referenced by getLookaheadSize().
  • pANTLR3_TREE_NODE_STREAM ANTLR3_COMMON_TREE_NODE_STREAM_struct::tnstream — pointer to the tree node stream interface. 🌲
    • Referenced by alreadyParsedRule(), antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), antlr3RecognitionExceptionNew(), consumeUntil(), consumeUntilSet(), displayRecognitionError(), mark(), match(), matchAny(), memoize(), pop(), push(), recover(), recoverFromMismatchedElement(), recoverFromMismatchedSet(), recoverFromMismatchedToken(), reset(), and synpred().
  • ANTLR3_BOOLEAN ANTLR3_COMMON_TREE_NODE_STREAM_struct::uniqueNavigationNodes — if set to ANTLR3_TRUE then the navigation nodes UP, DOWN are duplicated rather than reused within the tree. 🔁
    • Referenced by antlr3CommonTreeNodeStreamNew(), antlr3CommonTreeNodeStreamNewStream(), hasUniqueNavigationNodes(), and setUniqueNavigationNodes().
  • ANTLR3_COMMON_TREE ANTLR3_COMMON_TREE_NODE_STREAM_struct::UP — dummy tree node that indicates a descent up to a parent tree. Initialized by a call to create a new interface. ⬆️
    • Referenced by addNavigationNode(), antlr3CommonTreeNodeStreamFree(), antlr3CommonTreeNodeStreamNew(), and antlr3CommonTreeNodeStreamNewStream().
  • pANTLR3_BASE_TREE(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::visitChild) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns, ANTLR3_UINT32 child) — function pointer, no description. 👶
  • void(* ANTLR3_COMMON_TREE_NODE_STREAM_struct::walkBackToMostRecentNodeWithUnvisitedChildren) (struct ANTLR3_COMMON_TREE_NODE_STREAM_struct *ctns) — function pointer, no description. 🚶‍♀️

👑 Author 👑

Generated automatically by Doxygen for ANTLR3C from the source code. 💖

Version 3.3.1, Tue Jul 29 2025 — that's the footer, bestie! 💖 Stay iconic! ✨

📦 where this page comes from