libGimbal 0.1.0
C17-Based Extended Standard Library and Cross-Language Runtime Framework
Loading...
Searching...
No Matches
GblOptionGroup Struct Reference

#include <gimbal_option_group.h>

Inheritance diagram for GblOptionGroup:
GblObject GblBox GblITableVariant GblInstance

Data Fields

union { 
 
   GblOptionGroupClass *   pClass 
 
   GblObject   base 
 
};  
 
GblOptionpOptions
 
size_t optionCount
 
GblStringRefpPrefix
 
GblVersion version
 
GblStringRefpSummary
 
GblStringRefpDescription
 
GblStringListpParsedArgs
 
GBL_RESULT parseResult
 
- Data Fields inherited from GblObject
union { 
 
   GblObjectClass *   pClass 
 
   GblBox   base 
 
};  
 
- Data Fields inherited from GblBox
union { 
 
   GblBoxClass *   pClass 
 
   GblInstance   base 
 
};  
 
struct { 
 
   GblArrayMap *   pFields 
 
   volatile uint16_t   refCounter 
 
   uint16_t   contextType: 1 
 
   uint16_t   constructedInPlace: 1 
 
   uint16_t   derivedFlags: 14 
 
private_ 
 
- Data Fields inherited from GblInstance
GblClasspClass
 

Additional Inherited Members

Detailed Description

Grouping of command-line options.

GblOptionGroup represents a collection of configurable command-line options, which may be parsed directly or added to a top-level GblCmdParser. Options are divided into groups so that each module within an application can manage its own options independently.

See also
GblCmdParser

Definition at line 122 of file gimbal_option_group.h.

Field Documentation

◆ pClass

GblOptionGroupClass* GblOptionGroup::pClass

Pointer to class/vtable structure.

Definition at line 122 of file gimbal_option_group.h.

◆ base

GblObject GblOptionGroup::base

Inherited base instance structure.

Definition at line 122 of file gimbal_option_group.h.

◆ pOptions

GblOption* GblOptionGroup::pOptions

Array of GblOption entries.

Definition at line 123 of file gimbal_option_group.h.

◆ optionCount

size_t GblOptionGroup::optionCount

Number of options within pOptions.

Definition at line 124 of file gimbal_option_group.h.

◆ pPrefix

GblStringRef* GblOptionGroup::pPrefix

Prefix for all options within this group.

Definition at line 125 of file gimbal_option_group.h.

◆ version

GblVersion GblOptionGroup::version

Version number for the module/unit represented by this group.

Definition at line 126 of file gimbal_option_group.h.

◆ pSummary

GblStringRef* GblOptionGroup::pSummary

Summary of the module/unit represented by the option group.

Definition at line 127 of file gimbal_option_group.h.

◆ pDescription

GblStringRef* GblOptionGroup::pDescription

Longer description of the module/unit represented by the option group.

Definition at line 128 of file gimbal_option_group.h.

◆ pParsedArgs

GblStringList* GblOptionGroup::pParsedArgs

List of all options/values which have been extracted and parsed.

Definition at line 129 of file gimbal_option_group.h.

◆ parseResult

GBL_RESULT GblOptionGroup::parseResult

Result of GblOptionGroup_parse()

Definition at line 130 of file gimbal_option_group.h.


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