ANTLR3_PARSER_struct(3)

📦 version 3.4, in fedora 43

💖 ANTLR3_PARSER_struct — bestie's guide to the parser interface 💖

okay so. this is a page from the ANTLR3C manual, and we're talking about ANTLR3_PARSER_struct ✨ buckle up, it's giving struct energy and honestly? iconic.

✨ NAME ✨

ANTLR3_PARSER_struct — this is the main interface for an ANTLR3 parser. the whole main character. 👑

🌸 SYNOPSIS 🌸

#include <antlr3parser.h>

🦋 Data Fields 🦋

  • void(* free )(struct ANTLR3_PARSER_struct *parser) — a pointer to a function that knows how to free resources of an ANTLR3 parser. it's the cleanup crew 💅
  • pANTLR3_TOKEN_STREAM(* getTokenStream )(struct ANTLR3_PARSER_struct *parser) — a pointer to a function that returns the token stream for this parser.
  • pANTLR3_BASE_RECOGNIZER rec — a pointer to the base recognizer, where most of the parser functions actually live, because they are shared between parser and tree parser and this is the easier way than copying the interface all over the place.
  • void(* setDebugListener )(struct ANTLR3_PARSER_struct *parser, pANTLR3_DEBUG_EVENT_LISTENER dbg) — a pointer to a function that installs a debugger object (it also installs the debugging versions of the parser methods.
  • void(* setTokenStream )(struct ANTLR3_PARSER_struct *parser, pANTLR3_TOKEN_STREAM) — a pointer to a function that installs a token stream for the parser.
  • void * super — all superstructure implementers of this interface require a pointer to their selves, which they can reference using the super pointer here.
  • pANTLR3_TOKEN_STREAM tstream — a provider of a tokenstream interface, for the parser to consume tokens from.

🌈 Detailed Description 🌈

This is the main interface for an ANTLR3 parser. fr fr, that's the whole vibe check. ✨

🎀 Field Documentation 🎀

💜 void(* ANTLR3_PARSER_struct::free) (struct ANTLR3_PARSER_struct *parser)

Pointer to a function that knows how to free resources of an ANTLR3 parser. 🧹

Referenced by antlr3ParserNew().

💜 pANTLR3_TOKEN_STREAM(* ANTLR3_PARSER_struct::getTokenStream) (struct ANTLR3_PARSER_struct *parser)

A pointer to a function that returns the token stream for this parser.

Referenced by antlr3ParserNew().

💜 pANTLR3_BASE_RECOGNIZER ANTLR3_PARSER_struct::rec

A pointer to the base recognizer, where most of the parser functions actually live because they are shared between parser and tree parser and this is the easier way than copying the interface all over the place. Macros hide this for the generated code so it is easier on the eye (though not the debugger ;-). 💀 honestly the debugger is catching strays here.

Referenced by antlr3ParserNew(), freeParser(), setDebugListener(), and setTokenStream().

💜 void(* ANTLR3_PARSER_struct::setDebugListener) (struct ANTLR3_PARSER_struct *parser, pANTLR3_DEBUG_EVENT_LISTENER dbg)

A pointer to a function that installs a debugger object (it also installs the debugging versions of the parser methods. This means that a non debug parser incurs no overhead because of the debugging stuff. 🫶 lowkey a slay optimization ngl.

Referenced by antlr3ParserNew(), and antlr3ParserNewStreamDbg().

💜 void(* ANTLR3_PARSER_struct::setTokenStream) (struct ANTLR3_PARSER_struct *parser, pANTLR3_TOKEN_STREAM)

A pointer to a function that installs a token stream for the parser.

Referenced by antlr3ParserNew(), and antlr3ParserNewStream().

💜 void* ANTLR3_PARSER_struct::super

All superstructure implementers of this interface require a pointer to their selves, which they can reference using the super pointer here.

💜 pANTLR3_TOKEN_STREAM ANTLR3_PARSER_struct::tstream

A provider of a tokenstream interface, for the parser to consume tokens from.

Referenced by alreadyParsedRule(), antlr3RecognitionExceptionNew(), consumeUntil(), consumeUntilSet(), displayRecognitionError(), getTokenStream(), match(), matchAny(), memoize(), mismatch(), recover(), recoverFromMismatchedElement(), recoverFromMismatchedSet(), recoverFromMismatchedToken(), setDebugListener(), setTokenStream(), and synpred(). look at that list, it's booked and busy 💅🔥

🫶 Author 🫶

Generated automatically by Doxygen for ANTLR3C from the source code. not a human bestie, it's the machine 🤖✨

Version 3.3.1 · Tue Jul 29 2025 00:00:00 — that's the tea, the date, and the version, all in one cute lil sign-off. periodt. 🎀💖🦋 no cap, you now know ANTLR3_PARSER_struct better than you knew yourself this morning. go forth and parse, bestie 👑🌈⭐
📦 where this page comes from