oa::Cli

Cli class in the OA Core public surface.

ClC++ public headers

Public Methods

CmdCli * oa::Cli::addSubcommand(oa::StringView inName, oa::StringView inDescription)

void oa::Cli::Cli<type-parameter-0-0>(oa::StringView inName, oa::StringView inDescription)

TConfig & oa::Cli::getConfig()

const TConfig & oa::Cli::getConfig()

const oa::String & oa::Cli::getConfigPath()

oa::String oa::Cli::getSubcommand()

oa::I32 oa::Cli::getVerbose()

bool oa::Cli::gotSubcommand(oa::StringView inName)

bool oa::Cli::helpRequested()

bool oa::Cli::parse(int inArgc, char ** inArgv)

void oa::Cli::requireSubcommand(oa::I32 inMin = 0, oa::I32 inMax = 0)

void oa::Cli::setEpilog(oa::StringView inText)

void oa::Cli::setFallthrough(bool inEnable = true)

Constructor & Destructor Documentation

void oa::Cli::~Cli<type-parameter-0-0>()

No public source comment is attached to this declaration.

Returns

void

The declared return value.

Public Method Documentation

CmdCli * oa::Cli::addSubcommand(
	oa::StringView inName,
	oa::StringView inDescription
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

inDescription

oa::StringView

—

Returns

CmdCli *

The declared return value.

void oa::Cli::Cli<type-parameter-0-0>(
	oa::StringView inName,
	oa::StringView inDescription
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

inDescription

oa::StringView

—

Returns

void

The declared return value.

TConfig & oa::Cli::getConfig()

No public source comment is attached to this declaration.

Returns

TConfig &

The declared return value.

const TConfig & oa::Cli::getConfig()

No public source comment is attached to this declaration.

Returns

const TConfig &

The declared return value.

const oa::String & oa::Cli::getConfigPath()

No public source comment is attached to this declaration.

Returns

const oa::String &

The declared return value.

oa::String oa::Cli::getSubcommand()

No public source comment is attached to this declaration.

Returns

oa::String

The declared return value.

oa::I32 oa::Cli::getVerbose()

No public source comment is attached to this declaration.

Returns

oa::I32

The declared return value.

bool oa::Cli::gotSubcommand(
	oa::StringView inName
)

No public source comment is attached to this declaration.

Parameters

inName

oa::StringView

—

Returns

bool

The declared return value.

bool oa::Cli::helpRequested()

No public source comment is attached to this declaration.

Returns

bool

The declared return value.

bool oa::Cli::parse(
	int inArgc,
	char ** inArgv
)

No public source comment is attached to this declaration.

Parameters

inArgc

int

—

inArgv

char **

—

Returns

bool

The declared return value.

void oa::Cli::requireSubcommand(
	oa::I32 inMin = 0,
	oa::I32 inMax = 0
)

No public source comment is attached to this declaration.

Parameters

inMin

oa::I32

Default: 0

inMax

oa::I32

Default: 0

Returns

void

The declared return value.

void oa::Cli::setEpilog(
	oa::StringView inText
)

No public source comment is attached to this declaration.

Parameters

inText

oa::StringView

—

Returns

void

The declared return value.

void oa::Cli::setFallthrough(
	bool inEnable = true
)

No public source comment is attached to this declaration.

Parameters

inEnable

bool

Default: true

Returns

void

The declared return value.