#include <gimbal_cmd_parser.h>

Inheritance diagram for GblCmdParser:

[legend]

Collaboration diagram for GblCmdParser:

[legend]

Data Fields
union {

GblCmdParserClass * pClass

GblObject base

};

GblStringRef *	pErrorMsg

GBL_RESULT	parseResult

uint8_t	allowExtraArgs: 1

uint8_t	allowUnknownOptions: 1

uint8_t	firstArgAsExecutable: 1

uint8_t	enableVersionOption: 1

uint8_t	enableHelpOption: 1

Data Fields inherited from GblObject
union {

GblObjectClass * pClass

GblBox base

};

Data Fields inherited from GblInstance
GblClass *	pClass

Related Symbols
(Note that these are not member symbols.)
Option Groups
Methods for managing GblCmdOptionGroup subobjects
GBL_RESULT	GblCmdParser_addOptionGroup (GblCmdParser pSelf, GblOptionGroup pGroup)

GBL_RESULT	GblCmdParser_setOptionGroups (GblCmdParser pSelf, GblOptionGroup *ppGroups)

GblOptionGroup *	GblCmdParser_optionGroup (const GblCmdParser *pSelf, size_t idx)

GblOptionGroup *	GblCmdParser_findOptionGroup (const GblCmdParser pSelf, const char pName)

size_t	GblCmdParser_optionGroupCount (const GblCmdParser *pSelf)

GBL_RESULT	GblCmdParser_setMainOptionGroup (GblCmdParser pSelf, GblOptionGroup pGroup)

GblOptionGroup *	GblCmdParser_mainOptionGroup (const GblCmdParser *pSelf)

Positional Arguments
Methods for managing positional arguments
GBL_RESULT	GblCmdParser_addPositionalArg (GblCmdParser pSelf, const char pName, const char *pDesc)

GBL_RESULT	GblCmdParser_setPositionalArgs (GblCmdParser pSelf, const GblCmdArg pArgs)

GBL_RESULT	GblCmdParser_clearPositionalArgs (GblCmdParser *pSelf)

size_t	GblCmdParser_positionalArgCount (const GblCmdParser *pSelf)

const GblCmdArg *	GblCmdParser_positionalArg (const GblCmdParser *pSelf, size_t index)

size_t	GblCmdParser_positionalArgValueCount (const GblCmdParser *pSelf)

const GblStringList *	GblCmdParser_positionalArgValues (const GblCmdParser *pSelf)

GBL_RESULT	GblCmdParser_positionalArgValue (const GblCmdParser pSelf, size_t index, GblType toType, void pData)

Related Symbols inherited from GblObject
GBL_RESULT	GblObject_property (const GblObject pSelf, const char pName,...)

GBL_RESULT	GblObject_propertyByQuark (const GblObject *pSelf, GblQuark name,...)

GBL_RESULT	GblObject_propertyVaList (const GblObject pSelf, const char pName, va_list *pList)

GBL_RESULT	GblObject_propertyVaByQuark (const GblObject pSelf, GblQuark name, va_list pList)

GBL_RESULT	GblObject_propertyVariant (const GblObject pSelf, const char pName, GblVariant *pValue)

GBL_RESULT	GblObject_propertyVariantByQuark (const GblObject pSelf, GblQuark name, GblVariant pValue)

GBL_RESULT	GblObject_properties (const GblObject *pSelf,...)

GBL_RESULT	GblObject_propertiesVa (const GblObject pSelf, va_list pList)

GBL_RESULT	GblObject_propertiesVariants (const GblObject pSelf, size_t count, const char pNames[], GblVariant *pValue)

GBL_RESULT	GblObject_setProperty (GblObject pSelf, const char pName,...)

GBL_RESULT	GblObject_setPropertyByQuark (GblObject *pSelf, GblQuark quark,...)

GBL_RESULT	GblObject_setPropertyVa (GblObject pSelf, const char pName, va_list *pList)

GBL_RESULT	GblObject_setPropertyVaListByQuark (GblObject pSelf, GblQuark name, va_list pList)

GBL_RESULT	GblObject_setPropertyVariant (GblObject pSelf, const char pName, GblVariant *pValue)

GBL_RESULT	GblObject_setPropertyVariantByQuark (GblObject pSelf, GblQuark name, GblVariant pValue)

GBL_RESULT	GblObject_setProperties (GblObject *pSelf,...)

GBL_RESULT	GblObject_setPropertiesVa (GblObject pSelf, va_list pList)

GBL_RESULT	GblObject_setPropertiesVariants (GblObject pSelf, size_t count, const char pNames[], GblVariant *pValue)

GBL_RESULT	GblObject_emitPropertyChange (const GblObject pSelf, const char pName)

GBL_RESULT	GblObject_emitPropertyChangeByQuark (const GblObject *pSelf, GblQuark name)

GblBool	GblObject_blockPropertyChange (GblObject *pSelf, GblBool blocked)

GblBool	GblObject_propertyChangeBlocked (const GblObject *pSelf)

GblBool	GblObject_isInstantiating (const GblObject *pSelf)

GblBool	GblObject_isConstructing (const GblObject *pSelf)

GblStringRef *	GblObject_name (const GblObject *pSelf)

void	GblObject_setName (GblObject pSelf, const char pName)

void	GblObject_setNameRef (GblObject pSelf, GblStringRef pRef)

GblObject *	GblObject_parent (const GblObject *pSelf)

void	GblObject_setParent (GblObject pSelf, GblObject pParent)

void	GblObject_addChild (GblObject pSelf, GblObject pChild)

GblBool	GblObject_removeChild (GblObject pSelf, GblObject pChild)

size_t	GblObject_depth (const GblObject *pSelf)

GblObject *	GblObject_childFirst (const GblObject *pSelf)

size_t	GblObject_childCount (const GblObject *pSelf)

size_t	GblObject_childIndex (const GblObject *pSelf)

GblObject *	GblObject_siblingNext (const GblObject *pSelf)

GblObject *	GblObject_siblingNextByType (const GblObject *pSelf, GblType type)

GblObject *	GblObject_siblingNextByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_siblingPrevious (const GblObject *pSelf)

GblObject *	GblObject_siblingPreviousByType (const GblObject *pSelf, GblType type)

GblObject *	GblObject_siblingPreviousByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findAncestorByType (const GblObject *pSelf, GblType ancestorType)

GblObject *	GblObject_findAncestorByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findAncestorByHeight (const GblObject *pSelf, size_t height)

GblObject *	GblObject_findBaseByDepth (const GblObject *pSelf, size_t depth)

GblObject *	GblObject_findChildByType (const GblObject *pSelf, GblType childType)

GblObject *	GblObject_findChildByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findChildByIndex (const GblObject *pSelf, size_t index)

GblObject *	GblObject_findSiblingByType (const GblObject *pSelf, GblType siblingType)

GblObject *	GblObject_findSiblingByName (const GblObject pSelf, const char pName)

GblObject *	GblObject_findSiblingByIndex (const GblObject *pSelf, size_t index)

GBL_RESULT	GblObject_sendEvent (GblObject pSelf, GblEvent pEvent)

GBL_RESULT	GblObject_notifyEvent (GblObject pSelf, GblEvent pEvent)

GBL_RESULT	GblObject_installEventFilter (GblObject pSelf, GblIEventReceiver pFilter)

GBL_RESULT	GblObject_uninstallEventFilter (GblObject pSelf, GblIEventReceiver pFilter)

size_t	GblObject_eventFilterCount (const GblObject *pSelf)

GblIEventReceiver *	GblObject_eventFilter (const GblObject *pSelf, size_t index)

Related Symbols inherited from GblInstance
#define	GBL_TYPEOF(self)

#define	GBL_PRIVATE(cType, self)

#define	GBL_PUBLIC(cType, selfPriv)

#define	GBL_TYPECHECK(cType, self)

#define	GBL_CAST(cType, self)

#define	GBL_AS(cType, self)

#define	GBL_CLASSOF(cType, self)

#define	GBL_CLASSOF_AS(cType, self)

#define	GBL_VCALL(cType, method, ...)

#define	GBL_VCALL_DEFAULT(cType, method, ...)

GblBool	GblInstance_check (const GblInstance *pSelf, GblType toType)

GblInstance *	GblInstance_cast (GblInstance *pSelf, GblType toType)

GblInstance *	GblInstance_as (GblInstance *pSelf, GblType toType)

void *	GblInstance_private (const GblInstance *pSelf, GblType base)

GblInstance *	GblInstance_public (const void *pPriv, GblType base)

GblType	GblInstance_typeOf (const GblInstance *pSelf)

size_t	GblInstance_size (const GblInstance *pSelf)

size_t	GblInstance_privateSize (const GblInstance *pSelf)

size_t	GblInstance_totalSize (const GblInstance *pSelf)

GblClass *	GblInstance_class (const GblInstance *pSelf)

GBL_RESULT	GblInstance_swizzleClass (GblInstance pSelf, GblClass pClass)

GBL_RESULT	GblInstance_sinkClass (GblInstance *pSelf)

GBL_RESULT	GblInstance_floatClass (GblInstance *pSelf)

Detailed Description

General-purpose command-line argument parser.

GblCmdParser is a configurable, modular, generalized parser for processing command-line arguments. A parser may contain a single "main" option group and a collection of secondary option groups. This modularity allows each library or framework within an application to add its own individual option group to the main command parser.

See also: GblOptionGroup

Definition at line 76 of file gimbal_cmd_parser.h.

Friends And Related Symbol Documentation

◆ GblCmdParser_addOptionGroup()

GBL_RESULT GblCmdParser_addOptionGroup	(	GblCmdParser *	pSelf,
		GblOptionGroup *	pGroup )

Adds the GblOptionGroup pGroup to the list of option groups handled by the GblCmdParser.

◆ GblCmdParser_setOptionGroups()

GBL_RESULT GblCmdParser_setOptionGroups	(	GblCmdParser *	pSelf,
		GblOptionGroup **	ppGroups )

Sets the internal array of option groups to the list of pointers given by the ppGroups array, NULL-terminated.

◆ GblCmdParser_optionGroup()

GblOptionGroup * GblCmdParser_optionGroup	(	const GblCmdParser *	pSelf,
		size_t	idx )

Returns a pointer to the GblOptionGroup at the given index.

◆ GblCmdParser_findOptionGroup()

GblOptionGroup * GblCmdParser_findOptionGroup	(	const GblCmdParser *	pSelf,
		const char *	pName )

Finds a GblOptionGroup from the internal list by its GblObject::name.

◆ GblCmdParser_optionGroupCount()

size_t GblCmdParser_optionGroupCount ( const GblCmdParser * pSelf )

Returns the number of option groups held within the internal list of them.

◆ GblCmdParser_setMainOptionGroup()

GBL_RESULT GblCmdParser_setMainOptionGroup	(	GblCmdParser *	pSelf,
		GblOptionGroup *	pGroup )

Sets the main option group for the parser to the one given by pGroup, returning the result.

◆ GblCmdParser_mainOptionGroup()

GblOptionGroup * GblCmdParser_mainOptionGroup ( const GblCmdParser * pSelf )

Returns the GblOptionGroup previously set as the main option group for the GblCmdParser.

◆ GblCmdParser_addPositionalArg()

GBL_RESULT GblCmdParser_addPositionalArg	(	GblCmdParser *	pSelf,
		const char *	pName,
		const char *	pDesc )

Dynamically creates a GblCmdArg struct from the given args and adds it to the internal list.

◆ GblCmdParser_setPositionalArgs()

GBL_RESULT GblCmdParser_setPositionalArgs	(	GblCmdParser *	pSelf,
		const GblCmdArg *	pArgs )

Sets the 0-terminated list of arguments pointed to by pArgs as the new positional argument list.

◆ GblCmdParser_clearPositionalArgs()

GBL_RESULT GblCmdParser_clearPositionalArgs ( GblCmdParser * pSelf )

Clears the currently held internal list of GblCmdArg structures, resetting its size to 0.

◆ GblCmdParser_positionalArgCount()

size_t GblCmdParser_positionalArgCount ( const GblCmdParser * pSelf )

Returns the size of the internally managed list of GblCmdArg structures represengin command-line arguments.

◆ GblCmdParser_positionalArg()

const GblCmdArg * GblCmdParser_positionalArg	(	const GblCmdParser *	pSelf,
		size_t	index )

Returns a pointer to the GblCmdArg structure in the internally maintained list at the given index.

◆ GblCmdParser_positionalArgValueCount()

size_t GblCmdParser_positionalArgValueCount ( const GblCmdParser * pSelf )

After parsing, this function returns the number of positional arguments extracted.

◆ GblCmdParser_positionalArgValues()

const GblStringList * GblCmdParser_positionalArgValues ( const GblCmdParser * pSelf )

After parsing, returns the GblStringList maintained internally, containing the extracted positional argument values.

◆ GblCmdParser_positionalArgValue()

GBL_RESULT GblCmdParser_positionalArgValue	(	const GblCmdParser *	pSelf,
		size_t	index,
		GblType	toType,
		void *	pData )

After parsing, this function converts the value of the argument at the given index to the desired toType, copying its value to pData, and returning the result.

Field Documentation

◆ pClass

GblCmdParserClass* GblCmdParser::pClass

Pointer to class/vtable structure.

Definition at line 76 of file gimbal_cmd_parser.h.

◆ base

GblObject GblCmdParser::base

Inherited base instance structure.

Definition at line 76 of file gimbal_cmd_parser.h.

◆ pErrorMsg

GblStringRef* GblCmdParser::pErrorMsg

Current, pending error message.

Definition at line 77 of file gimbal_cmd_parser.h.

◆ parseResult

GBL_RESULT GblCmdParser::parseResult

Result of last parse operation.

Definition at line 78 of file gimbal_cmd_parser.h.

◆ allowExtraArgs

uint8_t GblCmdParser::allowExtraArgs

Toggle for allowing extra positional arguments beyond the ones added.

Definition at line 79 of file gimbal_cmd_parser.h.

◆ allowUnknownOptions

uint8_t GblCmdParser::allowUnknownOptions

Toggle for allowing unknown options not handled by a GblCmdOptionGroup.

Definition at line 80 of file gimbal_cmd_parser.h.

◆ firstArgAsExecutable

uint8_t GblCmdParser::firstArgAsExecutable

Toggle for determining whether to treat the first argument as the executable name.

Definition at line 81 of file gimbal_cmd_parser.h.

◆ enableVersionOption

uint8_t GblCmdParser::enableVersionOption

Toggle for optionally enabling a version command-line option.

Definition at line 82 of file gimbal_cmd_parser.h.

◆ enableHelpOption

uint8_t GblCmdParser::enableHelpOption

Toggle for optionally enabling an autogenerated help option.

Definition at line 83 of file gimbal_cmd_parser.h.

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

gimbal_cmd_parser.h

Data Fields

Related Symbols

Detailed Description

Friends And Related Symbol Documentation

◆ GblCmdParser_addOptionGroup()

◆ GblCmdParser_setOptionGroups()

◆ GblCmdParser_optionGroup()

◆ GblCmdParser_findOptionGroup()

◆ GblCmdParser_optionGroupCount()

◆ GblCmdParser_setMainOptionGroup()

◆ GblCmdParser_mainOptionGroup()

◆ GblCmdParser_addPositionalArg()

◆ GblCmdParser_setPositionalArgs()

◆ GblCmdParser_clearPositionalArgs()

◆ GblCmdParser_positionalArgCount()

◆ GblCmdParser_positionalArg()

◆ GblCmdParser_positionalArgValueCount()

◆ GblCmdParser_positionalArgValues()

◆ GblCmdParser_positionalArgValue()

Field Documentation

◆ pClass

◆ base

◆ pErrorMsg

◆ parseResult

◆ allowExtraArgs

◆ allowUnknownOptions

◆ firstArgAsExecutable

◆ enableVersionOption

◆ enableHelpOption