AeonGames::OptionHandler Class Reference

Command-line option handler. More...

#include <aeongames/Utilities.hpp>

Collaboration diagram for AeonGames::OptionHandler:

Public Member Functions
DLL	OptionHandler (const char aShortOption, const char *aLongOption, void(*aHandler)(const char *, void *), void *aUserData=nullptr)
	Construct an OptionHandler.
DLL const char	GetShortOption () const
	Get the short option character.
DLL const char *	GetLongOption () const
	Get the long option string.
DLL void *	GetUserData () const
	Get the user data pointer.
DLL void	operator() (const char *aArgument, void *aUserData) const
	Invoke the handler callback.

Detailed Description

Command-line option handler.

Definition at line 156 of file Utilities.hpp.

Constructor & Destructor Documentation

OptionHandler()

AeonGames::OptionHandler::OptionHandler	(	const char	aShortOption,
		const char *	aLongOption,
		void(*	aHandler )(const char *, void *),
		void *	aUserData = nullptr )

Construct an OptionHandler.

Parameters

aShortOption	Single-character short option.
aLongOption	Long option string.
aHandler	Callback invoked when the option is matched.
aUserData	Optional user data passed to the handler.

Definition at line 44 of file Utilities.cpp.

Member Function Documentation

GetLongOption()

const char * AeonGames::OptionHandler::GetLongOption

(

)

const

Get the long option string.

Returns

Pointer to the long option.

Definition at line 54 of file Utilities.cpp.

GetShortOption()

const char AeonGames::OptionHandler::GetShortOption

(

)

const

Get the short option character.

Returns

The short option.

Definition at line 50 of file Utilities.cpp.

GetUserData()

void * AeonGames::OptionHandler::GetUserData

(

)

const

Get the user data pointer.

Returns

The user data.

Definition at line 58 of file Utilities.cpp.

operator()()

void AeonGames::OptionHandler::operator()	(	const char *	aArgument,
		void *	aUserData ) const

Invoke the handler callback.

Parameters

aArgument	The option argument string.
aUserData	User data passed to the handler.

Definition at line 62 of file Utilities.cpp.

---

The documentation for this class was generated from the following files:

• include/aeongames/Utilities.hpp
• engine/core/Utilities.cpp