ARGPARSE.H(3)

✨ NAME ✨

include/Zycore/ArgParse.h — and bestie, this is the header that lives in Zycore's Library Functions Manual, which is the fancy way of saying "hey, this is a C header, here's everything it gives you" 💅

---

🎀 SYNOPSIS 🎀

Like, first things first — you gotta pull in the essentials:

#include <Zycore/Types.h>
#include <Zycore/Status.h>
#include <Zycore/Vector.h>
#include <Zycore/String.h>

🌸 Classes 🌸

• struct ZyanArgParseDefinition_
• struct ZyanArgParseConfig_
• struct ZyanArgParseArg_

🦋 Typedefs 🦋

• typedef struct ZyanArgParseDefinition_ ZyanArgParseDefinition
• typedef struct ZyanArgParseConfig_ ZyanArgParseConfig
• typedef struct ZyanArgParseArg_ ZyanArgParseArg

🌈 Functions 🌈

ZYCORE_EXPORT ZyanStatus ZyanArgParse (const ZyanArgParseConfig *cfg,
    ZyanVector *parsed, const char **error_token)
ZYCORE_EXPORT ZyanStatus ZyanArgParseEx (const ZyanArgParseConfig *cfg,
    ZyanVector *parsed, const char **error_token, ZyanAllocator
    *allocator)

---

💖 Detailed Description 💖

Okay so, what does this even do? It implements command-line argument parsing. That's it, that's the whole vibe. Your program gets args, and this header is the one making sense of them. Iconic behavior, truly. ✨

---

👑 Typedef Documentation 👑

💜 typedef struct ZyanArgParseArg_ ZyanArgParseArg

Information about a parsed argument. (Like, the tea on each arg after it's been chewed up by the parser 🍓)

💜 typedef struct ZyanArgParseConfig_ ZyanArgParseConfig

Configuration for argument parsing. (The settings that tell the parser how to do its lil job.)

💜 typedef struct ZyanArgParseDefinition_ ZyanArgParseDefinition

Definition of a single argument. (One arg's whole identity, fr.)

---

🔥 Function Documentation 🔥

⭐ ZYCORE_EXPORT ZyanStatus ZyanArgParse (const ZyanArgParseConfig * cfg, ZyanVector * parsed, const char ** error_token)

Parse arguments according to a ZyanArgParseConfig definition. That's the whole mission statement, bestie.

🌟 Parameters

• cfg — Argument parser config to use.
• parsed — Receives the parsed output. Vector of ZyanArgParseArg. Ownership is transferred to the user. Input is expected to be uninitialized. On error, the vector remains uninitialized.
• error_token — On error, if it makes sense, receives the argument fragment causing the error. Optional, may be ZYAN_NULL. The pointer borrows into the cfg struct and doesn't have to be freed by the user.

Not me stressing about the parsed vector lifecycle 😭 — it starts uninitialized, you own it once it comes back, and if things go sideways it stays uninitialized. No leaks, no drama. 🫶

✨ Returns

A ZyanStatus status determining whether the parsing succeeded.

---

⭐ ZYCORE_EXPORT ZyanStatus ZyanArgParseEx (const ZyanArgParseConfig * cfg, ZyanVector * parsed, const char ** error_token, ZyanAllocator * allocator)

Parse arguments according to a ZyanArgParseConfig definition.

This version allows specification of a custom memory allocator and thus supports no-libc. (Yes, no-libc. It's giving freestanding, it's giving embedded, it's giving main character energy in a bare-metal environment. 🔥)

🌟 Parameters

• cfg — Argument parser config to use.
• parsed — Receives the parsed output. Vector of ZyanArgParseArg. Ownership is transferred to the user. Input is expected to be uninitialized. On error, the vector remains uninitialized.
• error_token — On error, if it makes sense, receives the argument fragment causing the error. Optional, may be ZYAN_NULL. The pointer borrows into the cfg struct and doesn't have to be freed by the user.
• allocator — The ZyanAllocator to be used for allocating the output vector's data.

✨ Returns

A ZyanStatus status determining whether the parsing succeeded.

---

🌸 Author 🌸

Generated automatically by Doxygen for Zycore from the source code. (Doxygen said "I got this" and honestly? It ate. 💅)

---

And that's the whole page, bestie!! 🎀💖 This lil header belongs to Zycore, Version 1.5.2.0, and it's the include/Zy.../ArgParse.h(3) manual page — go forth and parse those arguments, you absolute legend 👑🌈⭐