CommandSpec

[Source]

CommandSpec описывает спецификацию родительской или листовой команды. Каждая команда имеет следующие атрибуты:

• имя: простой строковый токен, идентифицирующий команду.
• описание: используется в сообщении синтаксиса.
• отображение опций: допустимые опции для данной команды.
• необязательная опция help + имя команды для парсинга help
• один из:
• отображение дочерних команд.
• массив аргументов.

class ref CommandSpec

Конструкторы

parent

[Source]

Создаёт спецификацию команды, которая может принимать опции и дочерние команды, но не аргументы.

new ref parent(
  name': String val,
  descr': String val = "",
  options': Array[OptionSpec val] box = call,
  commands': Array[CommandSpec ref] box = call)
: CommandSpec ref^ ?

Параметры

• name': Строка val
• descr': Строка val = ""
• options': Массив[OptionSpec val] box = call
• commands': Массив[CommandSpec ref] box = call

Возвращает

• CommandSpec ref^ ?

leaf

[Source]

Создаёт спецификацию команды, которая может принимать опции и аргументы, но не дочерние команды.

new ref leaf(
  name': String val,
  descr': String val = "",
  options': Array[OptionSpec val] box = call,
  args': Array[ArgSpec val] box = call)
: CommandSpec ref^ ?

Параметры

• name': Строка val
• descr': Строка val = ""
• options': Массив[OptionSpec val] box = call
• args': Массив[ArgSpec val] box = call

Возвращает

• CommandSpec ref^ ?

Общедоступные функции

add_command

[Source]

Добавляет дополнительную дочернюю команду к этой родительской команде.

fun ref add_command(
  cmd: CommandSpec box)
: None val ?

Параметры

• cmd: CommandSpec box

Возвращает

• None val ?

add_help

[Source]

Добавляет стандартную опцию help и, необязательно, команду к корневой команде.

fun ref add_help(
  hname: String val = "help",
  descr': String val = "")
: None val ?

Параметры

• hname: Строка val = "help"
• descr': Строка val = ""

Возвращает

• None val ?

name

[Source]

Возвращает имя этой команды.

fun box name()
: String val

Возвращает

• Строка val

descr

[Source]

Возвращает описание для этой команды.

fun box descr()
: String val

Возвращает

• Строка val

options

[Source]

Возвращает отображение по имени именованных опций данной команды.

fun box options()
: HashMap[String val, OptionSpec val, HashEq[String val] val] box

Возвращает

• HashMap[Строка val, OptionSpec val, HashEq[Строка val] val] box

commands

[Source]

Возвращает отображение по имени дочерних команд данной команды.

fun box commands()
: HashMap[String val, CommandSpec box, HashEq[String val] val] box

Возвращает

• HashMap[Строка val, CommandSpec box, HashEq[Строка val] val] box

args

[Source]

Возвращает массив позиционных аргументов данной команды.

fun box args()
: Array[ArgSpec val] box

Возвращает

• Массив[ArgSpec val] box

is_leaf

[Source]

fun box is_leaf()
: Bool val

Возвращает

• Булево val

is_parent

[Source]

fun box is_parent()
: Bool val

Возвращает

• Булево val

help_name

[Source]

Возвращает имя команды help, которое по умолчанию равно "help".

fun box help_name()
: String val

Возвращает

• Строка val

help_string

[Source]

Возвращает отформатированную строку справки для данной команды и всех её аргументов.

fun box help_string()
: String val

Возвращает

• Строка val