BlamTool::Console Namespace Reference

Namespace containing functions for Tool's command-line input. More...

Functions
TOOL_LIB_API void	RegisterDefaultCommands ()
	Registers all default Tool commands. More...
TOOL_LIB_API int	ExecuteCommandLine (std::vector< std::string > args, std::string name_label)
	Parses and executes a given list of command-line arguments. More...
TOOL_LIB_API std::vector< ToolCommand * >	GetRegisteredCommands ()
	Retrieves the list of registered commands. More...
TOOL_LIB_API ToolCommand *	GetCommand (std::string name)
	Retrieves a command based on its name. More...

Detailed Description

Namespace containing functions for Tool's command-line input.

Function Documentation

ExecuteCommandLine()

int BlamTool::Console::ExecuteCommandLine	(	std::vector< std::string >	args,
		std::string	name_label
	)

Parses and executes a given list of command-line arguments.

Parameters

args	- The list of arguments provided to the application.
name_label	- The executable file name. Displayed in help guide.

Returns

The command execution result. Will return 0 if the command completed successfully. If an error occurred, this will usually return a negative number.

Here is the call graph for this function:

GetCommand()

ToolCommand * BlamTool::Console::GetCommand

(

std::string

name

)

Retrieves a command based on its name.

Parameters

name	- The name of the command.

Returns

Pointer to the command, or nullptr if no matching command was found.

Here is the caller graph for this function:

GetRegisteredCommands()

std::vector< ToolCommand * > BlamTool::Console::GetRegisteredCommands

(

)

Retrieves the list of registered commands.

Returns

The list of registered Tool commands.

Here is the caller graph for this function:

RegisterDefaultCommands()

void BlamTool::Console::RegisterDefaultCommands

(

)

Registers all default Tool commands.