This command line option exposes absolute paths. If the user provides a relative path, it will be concatenated with the current working directory. More...

#include <CommandLineOptions.h>

Inheritance diagram for xiiCommandLineOptionPath:

[legend]

Public Member Functions
	xiiCommandLineOptionPath (xiiStringView sSortingGroup, xiiStringView sArgument, xiiStringView sLongDesc, xiiStringView sDefaultValue, bool bCaseSensitive=false)

xiiString	GetOptionValue (LogMode logMode, const xiiCommandLineUtils *pUtils=xiiCommandLineUtils::GetGlobalInstance()) const
	Returns the value of this option. Either what was specified on the command line, or the default value.

void	SetDefaultValue (xiiStringView sValue)
	Modifies the default value.

xiiStringView	GetDefaultValue () const
	Returns the default value.

virtual xiiStringView	GetType () override
	Returns "Path".

Public Member Functions inherited from xiiCommandLineOptionDoc
	xiiCommandLineOptionDoc (xiiStringView sSortingGroup, xiiStringView sArgument, xiiStringView sParamShortDesc, xiiStringView sLongDesc, xiiStringView sDefaultValue, bool bCaseSensitive=false)

virtual void	GetOptions (xiiStringBuilder &ref_sOut) const override
	Writes all the supported options (e.g. '-arg') to 'out'. If more than one option is allowed, they should be separated with semicolons or pipes.

virtual void	GetParamShortDesc (xiiStringBuilder &ref_sOut) const override
	Returns a very short description of the option (type). For example "<int>" or "<enum>".

virtual void	GetParamDefaultValueDesc (xiiStringBuilder &ref_sOut) const override
	Returns a very short string for the options default value. For example "0" or "auto".

virtual void	GetLongDesc (xiiStringBuilder &ref_sOut) const override
	Returns a proper description of the option.

bool	IsOptionSpecified (xiiStringBuilder out_pWhich=nullptr, const xiiCommandLineUtils pUtils=xiiCommandLineUtils::GetGlobalInstance()) const
	Checks whether any of the option variants is set on the command line, and returns which one. For example '-h' or '-help'.

Public Member Functions inherited from xiiCommandLineOption
	xiiCommandLineOption (xiiStringView sSortingGroup)

virtual void	GetSortingGroup (xiiStringBuilder &ref_sOut) const
	Writes the sorting group name to 'out'.

void	GetSplitOptions (xiiStringBuilder &out_sAll, xiiDynamicArray< xiiStringView > &ref_splitOptions) const
	Returns the supported option names (e.g. '-arg') as split strings.

Protected Attributes
xiiStringView	m_sDefaultValue

Protected Attributes inherited from xiiCommandLineOptionDoc
xiiStringView	m_sArgument

xiiStringView	m_sParamShortDesc

xiiStringView	m_sParamDefaultValue

xiiStringView	m_sLongDesc

bool	m_bCaseSensitive = false

bool	m_bLoggedOnce = false

Protected Attributes inherited from xiiCommandLineOption
xiiStringView	m_sSortingGroup

Protected Attributes inherited from xiiEnumerable< xiiCommandLineOption >
xiiEnumerable *	m_pNextInstance

Additional Inherited Members
Public Types inherited from xiiCommandLineOption
enum class	LogAvailableModes { Always , IfHelpRequested }

enum class	LogMode { Never , FirstTime , FirstTimeIfSpecified , Always , AlwaysIfSpecified }
	Describes whether the value of an option (and whether something went wrong), should be printed to xiiLog. More...

Static Public Member Functions inherited from xiiCommandLineOption
static bool	IsHelpRequested (const xiiCommandLineUtils *pUtils=xiiCommandLineUtils::GetGlobalInstance())
	Checks whether a command line was passed that requests help output.

static xiiResult	RequireOptions (xiiStringView sRequiredOptions, xiiString pMissingOption=nullptr, const xiiCommandLineUtils pUtils=xiiCommandLineUtils::GetGlobalInstance())
	Checks whether all required options are passed to the command line.

static bool	LogAvailableOptions (LogAvailableModes mode, xiiStringView sGroupFilter={}, const xiiCommandLineUtils *pUtils=xiiCommandLineUtils::GetGlobalInstance())
	Prints all available options to the xiiLog.

static bool	LogAvailableOptionsToBuffer (xiiStringBuilder &out_sBuffer, LogAvailableModes mode, xiiStringView sGroupFilter={}, const xiiCommandLineUtils *pUtils=xiiCommandLineUtils::GetGlobalInstance())
	Same as LogAvailableOptions() but captures the output from xiiLog and returns it in a xiiStringBuilder.

Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI *	GetStaticRTTI ()

Protected Member Functions inherited from xiiCommandLineOptionDoc
bool	ShouldLog (LogMode mode, bool bWasSpecified) const

void	LogOption (xiiStringView sOption, xiiStringView sValue, bool bWasSpecified) const

Detailed Description

This command line option exposes absolute paths. If the user provides a relative path, it will be concatenated with the current working directory.

Member Function Documentation

◆ GetType()

virtual xiiStringView xiiCommandLineOptionPath::GetType ( )

inlineoverridevirtual

Returns "Path".

Reimplemented from xiiCommandLineOptionDoc.

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

/home/runner/work/XII/XII/Source/Engine/Foundation/Utilities/CommandLineOptions.h
/home/runner/work/XII/XII/Source/Engine/Foundation/Utilities/Implementation/CommandLineOptions.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetType()