ANTLR3_HASH_ENUM_struct(3)

πŸ“¦ version 3.4, in fedora 43

πŸ’– ANTLR3_HASH_ENUM_struct(3) πŸ’–

okay bestie, welcome to the ANTLR3C manual page for ANTLR3_HASH_ENUM_struct β€” yes the whole name is a mouthful, yes it's giving "I was auto-generated by Doxygen", but we're gonna make it make sense, i promise 🫢


✨ NAME ✨

ANTLR3_HASH_ENUM_struct β€” the internal structure that represents an enumeration of a table. that's it, that's the whole job description πŸ’…


🌸 SYNOPSIS 🌸

#include <antlr3collections.h>

πŸŽ€ Data Fields

  • ANTLR3_UINT32 bucket
  • pANTLR3_HASH_ENTRY entry
  • void(* free )(struct ANTLR3_HASH_ENUM_struct *table)
  • int(* next )(struct ANTLR3_HASH_ENUM_struct *en, pANTLR3_HASH_KEY *key, void **data)
  • pANTLR3_HASH_TABLE table

πŸ¦‹ Detailed Description πŸ¦‹

so like β€” this is the internal structure representing an enumeration of a table. internal! meaning it's the behind-the-scenes girlie, not the one on stage πŸ’œ

you get one of these handed to you by antlr3Enumeration(). and it lets you, the programmer, traverse the table in hash order without ever needing to know what's actually inside the actual table. no cap. you just vibe through it and the struct handles the walking ✨

⚠️ important caveat, bestie, listen up: it is up to you, the caller, to make sure the table structure does not change in the hash bucket that is currently being enumerated. because this structure? it literally just tracks the next pointers in the bucket series. nothing more. so if you go mutating stuff mid-walk, that's on you, and it will not be cute 😭

πŸ‘‘ Field Documentation πŸ‘‘

🌈 ANTLR3_UINT32 ANTLR3_HASH_ENUM_struct::bucket

Referenced by antlr3EnumNew(), antlr3EnumNext(), and antlr3EnumNextEntry(). iconic trio behavior, honestly πŸ’…

πŸ“ pANTLR3_HASH_ENTRY ANTLR3_HASH_ENUM_struct::entry

Referenced by antlr3EnumNew(), antlr3EnumNext(), and antlr3EnumNextEntry(). same besties, different field 🫢

🧚 void(* ANTLR3_HASH_ENUM_struct::free) (struct ANTLR3_HASH_ENUM_struct *table)

Referenced by antlr3BitsetList(), and antlr3EnumNew(). it's a function pointer, it's called free, you know what it does, we don't need to make it weird 🌸

⭐ int(* ANTLR3_HASH_ENUM_struct::next) (struct ANTLR3_HASH_ENUM_struct *en, pANTLR3_HASH_KEY *key, void **data)

Referenced by antlr3BitsetList(), and antlr3EnumNew(). three args, returns an int, and yes en, key and data are exactly spelled like that, don't come for me, i don't make the rules πŸ”₯

πŸ’œ pANTLR3_HASH_TABLE ANTLR3_HASH_ENUM_struct::table

Referenced by antlr3EnumNew(), antlr3EnumNext(), and antlr3EnumNextEntry(). the table in question. the main character of the whole situation, lowkey πŸ‘‘


🌸 Author 🌸

Generated automatically by Doxygen for ANTLR3C from the source code. so nobody wrote this, a robot did, and honestly? she ate πŸ€–πŸ’–


and that's the whole page bestie!! version 3.3.1, dated Tue Jul 29 2025 00:00:00, manual page ANTLR3_HASH_ENUM_struct(3) in the ANTLR3C section β€” go forth and enumerate responsibly, and remember: don't touch the bucket while you're walking it πŸŽ€βœ¨πŸ’…

πŸ“¦ where this page comes from