include/antlr3string.h(3)

✨ include/antlr3string.h — the string interface, bestie edition ✨

okay so this is a page from the ANTLR3C manual, and it's about <antlr3string.h> — the simple string interface. no cap, it's lowkey iconic. 🎀

---

💖 NAME 💖

include/antlr3string.h — Simple string interface allows indiscriminate allocation of strings such that they can be allocated all over the place and released in one chunk via a string factory — saves lots of hassle in remembering what strings were allocated where.

fr fr, that's the whole vibe: allocate wherever, free everything in one go. main character energy for your memory management. 💅

---

🌸 SYNOPSIS 🌸

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

🦋 Data Structures 🦋

• struct ANTLR3_STRING_FACTORY_struct — Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes.
• struct ANTLR3_STRING_struct — Base string class tracks the allocations and provides simple string tracking functions.

🎀 Typedefs 🎀

• typedef struct ANTLR3_STRING_struct ANTLR3_STRING — Base string class tracks the allocations and provides simple string tracking functions.
• typedef struct ANTLR3_STRING_FACTORY_struct ANTLR3_STRING_FACTORY — Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes.

---

🌈 Detailed Description 🌈

Simple string interface allows indiscriminate allocation of strings such that they can be allocated all over the place and released in one chunk via a string factory — saves lots of hassle in remembering what strings were allocated where.

like. the way that you don't have to keep a little mental list of every single string you ever made?? obsessed. you just yeet them all into the factory and it holds them for you. ✨🫶

---

💜 Typedef Documentation 💜

🍓 typedef struct ANTLR3_STRING_struct ANTLR3_STRING 🍓

Base string class tracks the allocations and provides simple string tracking functions. Mostly you can work directly on the string for things that don't reallocate it, like strchr() etc. Perhaps someone will want to provide implementations for UTF8 and so on.

ngl that "perhaps someone will want to provide implementations for UTF8 and so on" is giving open invitation. 👀 if that someone is you, slay.

🧚 typedef struct ANTLR3_STRING_FACTORY_struct ANTLR3_STRING_FACTORY 🧚

Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes.

she makes them, she tracks them, she does not lose them. a queen. 👑

---

⭐ Author ⭐

Generated automatically by Doxygen for ANTLR3C from the source code.

---

and that's the whole page bestie!! Version 3.3.1, dated Tue Jul 29 2025 00:00:00 — mwah, go forth and allocate indiscriminately 💖🎀🦋