CLI Class Reference

Inheritance diagram for CLI:

Static Public Member Functions
	DrawBorder (_.Library.List pLineList, _.Library.Integer pTextFormat)
	Draw a border around a list of strings. More...
_.Library.String	FormatName (_.Library.String pName)
	Format the given name such that all punctuation characters are remove and. More...
	ParseJsonToCommand (_.Library.DynamicObject pJson)
	Read JSON and construct a command matching the schema in the Commands XData blocks. More...

Static Public Attributes
	CommandsAccessorIncludeFilename = None
	Name of include file that will contain accessor macros for modifiers. More...
Static Public Attributes inherited from Commands
	CommandsAccessorIncludeFilename = None
	Name of include file that will contain accessor macros for modifiers. More...

Static Private Member Functions
	Help (pCommandInfo)
	Displays help for a given command.
_.Library.Status	ParseCommandInput (_.Library.String pCommandString, pCommandInfo)
	Parses a command, validating it based on the Commands XData block and structuring output as follows: More...
	__SetData (pTargetArray, pDataName, pDataValue, pCustomParam)
	Utility method for setting multiple subscripts based on . More...

Member Function Documentation

ParseCommandInput()

_.Library.Status ParseCommandInput ( _.Library.String  pCommandString,   pCommandInfo  )

staticprivate

Parses a command, validating it based on the Commands XData block and structuring output as follows:

pCommandInfo = "<command name>" pCommandInfo("modifiers","<modifier-name>") = "<modifier-value>" pCommandInfo("parameters","<parameter-name>") = "<parameter-value>" pCommandInfo("data","<data-name>") = "<data-value>"

DrawBorder()

DrawBorder ( _.Library.List  pLineList, _.Library.Integer  pTextFormat  )

static

Draw a border around a list of strings.

Optionally provide a text format for the strings.

@Argument pLineList List of strings to write.
@Argument pTextFormat Text format (e.g. $$$Red, $$$Bold, etc.).

FormatName()

_.Library.String FormatName ( _.Library.String  pName )

static

Format the given name such that all punctuation characters are remove and.

the name is in camelCase, with the first letter capitalized.
@Argument pName String to format.

ParseJsonToCommand()

ParseJsonToCommand ( _.Library.DynamicObject  pJson )

static

Read JSON and construct a command matching the schema in the Commands XData blocks.

that can be parsed using <method>ParseCommandInput</method>.
JSON format:
{ "command": "command name", "parameters": { ... }, "modifiers": { ... }, "custom_modifiers": { ... } } where each nested object contains key-value pairs.

__SetData()

__SetData (   pTargetArray,   pDataName,   pDataValue,   pCustomParam  )

staticprivate

Utility method for setting multiple subscripts based on .

-delimited pDataName

Member Data Documentation

CommandsAccessorIncludeFilename

CommandsAccessorIncludeFilename = None

static

Name of include file that will contain accessor macros for modifiers.

and parameters referenced in the "Commands" XData block.
If provided, an include file will be generated and included in the sub-class during compilation.
@API.Parameter @API.Overrideable