KETCube terminal shared functions

KETCube terminal shared functions (for local and remote context) More...

Functions
void	ketCube_terminal_printCmdList (ketCube_terminal_cmd_t *parent, ketCube_terminal_cmd_t *cmdList, ketCube_terminal_command_flags_t *contextFlags)
	Prints command list at index/level. More...
ketCube_terminal_cmdCheckResult_t	ketCube_terminal_checkCmdContext (ketCube_terminal_cmd_t *command, bool local)
	Check if we can run given command in given context. More...
bool	ketCube_terminal_checkCmdSubtreeContext (ketCube_terminal_command_flags_t *flags)
	Check if the command definition is valid in given subtree context. More...
void	ketCube_terminal_execute (ketCube_terminal_cmd_t *cmd, ketCube_terminal_command_flags_t activeFlags)

Detailed Description

KETCube terminal shared functions (for local and remote context)

Function Documentation

ketCube_terminal_checkCmdContext()

ketCube_terminal_cmdCheckResult_t ketCube_terminal_checkCmdContext	(	ketCube_terminal_cmd_t *	command,
		bool	local
	)

Check if we can run given command in given context.

Return values

TRUE	if success, else return FALSE

ketCube_terminal_checkCmdSubtreeContext()

bool ketCube_terminal_checkCmdSubtreeContext

(

ketCube_terminal_command_flags_t *

flags

)

Check if the command definition is valid in given subtree context.

This function returns TRUE, if the command is in a subtree context that is valid for given flags

Parameters

contextFlags

pointer to context flags

Return values

TRUE	if success, else return FALSE

ketCube_terminal_execute()

void ketCube_terminal_execute	(	ketCube_terminal_cmd_t *	cmd,
		ketCube_terminal_command_flags_t	activeFlags
	)

ketCube_terminal_printCmdList()

void ketCube_terminal_printCmdList	(	ketCube_terminal_cmd_t *	parent,
		ketCube_terminal_cmd_t *	cmdList,
		ketCube_terminal_command_flags_t *	contextFlags
	)

Prints command list at index/level.

Parameters

cmdIndex	index of the first command to print
level	level of commands to print
contextFlags	comamnd flag context