include/antlr3rewritestreams.h(3)

📦 version 3.4, in fedora 43

💖 include/antlr3rewritestreams.h — ANTLR3C manual page 💖

okay bestie, welcome to the ANTLR3C manual for include/antlr3rewritestreams.h, and yes it's giving header-file-core but I promise it's cute. 🦋

✨ NAME ✨

include/antlr3rewritestreams.h — the header that holds all the rewrite-rule stream lore, no cap 💅

🌸 SYNOPSIS 🌸

#include <antlr3defs.h>
#include <antlr3collections.h>
#include <antlr3commontreeadaptor.h>
#include <antlr3baserecognizer.h>

🎀 Data Structures 🎀

  • struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct — a generic list of elements tracked in an alternative to be used in a -> rewrite rule. literally the main character of this whole file. 👑

🧚 Typedefs 🧚

  • typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM — a generic list of elements tracked in an alternative to be used in a -> rewrite rule. 🫶
  • typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_NODE_STREAM — this is an implementation of a node stream, which is basically an element stream that deals with tree nodes only. 🌳
  • typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_SUBTREE_STREAM — this is an implementation of a subtree stream which is a set of trees modelled as an element stream. 🌲🌲
  • typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_TOKEN_STREAM — this is an implementation of a token stream, which is basically an element stream that deals with tokens only. 🎟️

💅 Typedef Documentation 💅

🦋 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM

A generic list of elements tracked in an alternative to be used in a -> rewrite rule. iconic behaviour honestly.

So here's the tea: in the C implementation, all tree oriented streams return a pointer to the same type: pANTLR3_BASE_TREE. Anything that has subclassed from this still passes this type, within which there is a super pointer, which points to it's own data and methods. Hence we do not need to implement this as the equivalent of an abstract class, but just fill in the appropriate interface as usual with this model. slay, polymorphism without the drama. ✨

⚠️ Once you start next()ing, do not try to add more elements. It will break the cursor tracking I believe. 😭 bestie do NOT do it, I'm begging.

See also

  • pANTLR3_REWRITE_RULE_NODE_STREAM
  • pANTLR3_REWRITE_RULE_ELEMENT_STREAM
  • pANTLR3_REWRITE_RULE_SUBTREE_STREAM

TODO: add mechanism to detect/puke on modification after reading from stream 🤮 (their words, not mine, and honestly? relatable)

🌈 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_NODE_STREAM

This is an implementation of a node stream, which is basically an element stream that deals with tree nodes only. nodes only, we stay focused. 🌳💖

🌸 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_SUBTREE_STREAM

This is an implementation of a subtree stream which is a set of trees modelled as an element stream. a whole forest living inside a stream, obsessed. 🌲✨

🎀 typedef struct ANTLR3_REWRITE_RULE_ELEMENT_STREAM_struct ANTLR3_REWRITE_RULE_TOKEN_STREAM

This is an implementation of a token stream, which is basically an element stream that deals with tokens only. tokens only, periodt. 🎟️👑

👑 Author 👑

Generated automatically by Doxygen for ANTLR3C from the source code. not a human hand in sight, it's giving robot-elegance fr fr. 🤖💜

okay that's the whole page bestie, you ate that reading session up 💅 this was Version 3.3.1, dated Tue Jul 29 2025, and it lives in the ANTLR3C docs as include/antlr3rewritestreams.h(3) — mwah, take care of her 🫶 🌈⭐💖

📦 where this page comes from