include/antlr3filestream.h(3)

📦 version 3.4, in fedora 43

💖 include/antlr3filestream.h 💖

okay bestie, welcome to the <pink>include/antlr3filestream.h</pink> page from the ANTLR3C manual — she's a header file, she's lowkey iconic, and she handles all your file-stream situations. sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

include/antlr3filestream.h — the header, the moment, the file-stream queen 👑

🌸 SYNOPSIS 🌸

#include <antlr3defs.h>

🎀 Functions 🎀

  • ANTLR3_API void antlr3Fclose (ANTLR3_FDSC fd) — closes an operating system file and frees up any handles and that whole situation, periodt.
  • ANTLR3_API ANTLR3_FDSC antlr3Fopen (pANTLR3_UINT8 filename, const char *mode) — opens an operating system file and hands you back the descriptor. no cap, it literally just uses the common open() and friends under the hood.
  • ANTLR3_API ANTLR3_UINT32 antlr3Fread (ANTLR3_FDSC fdsc, ANTLR3_UINT32 count, void *data)
  • ANTLR3_API ANTLR3_UINT32 antlr3Fsize (pANTLR3_UINT8 filename)
  • ANTLR3_API ANTLR3_UINT32 antlr3read8Bit (pANTLR3_INPUT_STREAM input, pANTLR3_UINT8 fileName)

🦋 Function Documentation 🦋

💜 ANTLR3_API void antlr3Fclose (ANTLR3_FDSC fd)

Closes an operating system file and frees up any handles and all the lil resources hanging around. it's giving cleanup era 🧹✨

Referenced by antlr3read8Bit().

💜 ANTLR3_API ANTLR3_FDSC antlr3Fopen (pANTLR3_UINT8 filename, const char *mode)

Opens an operating system file and returns you the descriptor. we're just vibing with the common open() and related functions here, bestie. later on we might find better ways of doing this on systems like Windows and OpenVMS, for instance — but the whole idea is to read the whole file in one go anyway, so honestly it may be irrelevant. 🙈

Referenced by antlr3read8Bit().

💜 ANTLR3_API ANTLR3_UINT32 antlr3Fread (ANTLR3_FDSC fdsc, ANTLR3_UINT32 count, void * data)

Referenced by antlr3read8Bit().

💜 ANTLR3_API ANTLR3_UINT32 antlr3Fsize (pANTLR3_UINT8 filename)

References _stat.

Referenced by antlr3read8Bit().

💜 ANTLR3_API ANTLR3_UINT32 antlr3read8Bit (pANTLR3_INPUT_STREAM input, pANTLR3_UINT8 fileName)

References ANTLR3_ERR_NOFILE, ANTLR3_ERR_NOMEM, ANTLR3_SUCCESS, ANTLR3_TRUE, antlr3Fclose(), antlr3Fopen(), antlr3Fread(), antlr3Fsize(), ANTLR3_INPUT_STREAM_struct::data, ANTLR3_INPUT_STREAM_struct::isAllocated, and ANTLR3_INPUT_STREAM_struct::sizeBuf.

Referenced by antlr3CreateFileStream().

👑 Author 👑

Generated automatically by Doxygen for ANTLR3C from the source code. (not a human author, just doxygen doing her lil thing, and honestly? she ate 💅)

that's the whole page bestie, every function, every reference, every crumb preserved — no cap. 💖

Version 3.3.1 · Tue Jul 29 2025 00:00 · from include/antlr3filestream.h(3) — mwah, thanks for reading, ily, go read a file or something 🫶✨🌈

📦 where this page comes from