XGetOpt::Option< ShortOpt, LongOpt, Description, ArgReq, ArgumentPlaceholder > Struct Template Reference

Compile-time representation of a command-line option. More...

#include <xgetopt.h>

Static Public Attributes
static constexpr int	shortopt = ShortOpt
static constexpr auto	longopt = LongOpt
static constexpr auto	description = Description
static constexpr ArgumentRequirement	argRequirement = ArgReq
static constexpr auto	argumentPlaceholder = ArgumentPlaceholder

Detailed Description

template<int ShortOpt, Helpers::FixedString LongOpt, Helpers::FixedString Description, ArgumentRequirement ArgReq, Helpers::FixedString ArgumentPlaceholder = "arg">
struct XGetOpt::Option< ShortOpt, LongOpt, Description, ArgReq, ArgumentPlaceholder >

Compile-time representation of a command-line option.

Template Parameters

ShortOpt	The short option character (e.g., 'h' for -h, or a unique integer for long-only options)
LongOpt	The long option string (e.g., "help" for –help, or an empty string for short-only options)
Description	The description of the option for help string generation
ArgReq	The argument requirement (NoArgument, RequiredArgument, OptionalArgument)
ArgumentPlaceholder	The placeholder text for the argument in help strings (default: "arg")

Member Data Documentation

argRequirement

template<int ShortOpt, Helpers::FixedString LongOpt, Helpers::FixedString Description, ArgumentRequirement ArgReq, Helpers::FixedString ArgumentPlaceholder = "arg">

constexpr ArgumentRequirement XGetOpt::Option< ShortOpt, LongOpt, Description, ArgReq, ArgumentPlaceholder >::argRequirement = ArgReq

staticconstexpr

argumentPlaceholder

template<int ShortOpt, Helpers::FixedString LongOpt, Helpers::FixedString Description, ArgumentRequirement ArgReq, Helpers::FixedString ArgumentPlaceholder = "arg">

constexpr auto XGetOpt::Option< ShortOpt, LongOpt, Description, ArgReq, ArgumentPlaceholder >::argumentPlaceholder = ArgumentPlaceholder

staticconstexpr

description

template<int ShortOpt, Helpers::FixedString LongOpt, Helpers::FixedString Description, ArgumentRequirement ArgReq, Helpers::FixedString ArgumentPlaceholder = "arg">

constexpr auto XGetOpt::Option< ShortOpt, LongOpt, Description, ArgReq, ArgumentPlaceholder >::description = Description

staticconstexpr

longopt

template<int ShortOpt, Helpers::FixedString LongOpt, Helpers::FixedString Description, ArgumentRequirement ArgReq, Helpers::FixedString ArgumentPlaceholder = "arg">

constexpr auto XGetOpt::Option< ShortOpt, LongOpt, Description, ArgReq, ArgumentPlaceholder >::longopt = LongOpt

staticconstexpr

shortopt

template<int ShortOpt, Helpers::FixedString LongOpt, Helpers::FixedString Description, ArgumentRequirement ArgReq, Helpers::FixedString ArgumentPlaceholder = "arg">

constexpr int XGetOpt::Option< ShortOpt, LongOpt, Description, ArgReq, ArgumentPlaceholder >::shortopt = ShortOpt

staticconstexpr

---

The documentation for this struct was generated from the following file:

• src/include/xgetopt.h