Eiffeldoc: COMMAND_LINE_ARGUMENT_CUSTOM_FACTORY

+

Point of view

All features

expanded class COMMAND_LINE_ARGUMENT_CUSTOM_FACTORY [D_]

Summary

A specialized factory for custom arguments.

Direct parents: Insert list: COMMAND_LINE_ARGUMENT_FACTORY

Overview

Features

Options

option_custom (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[D_]
option_customs (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[D_]]

Positional

positional_custom (name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[D_]
positional_customs (name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[D_]]

Options

option_string (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]
option_strings (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]
option_file (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]
option_directory (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]
option_integer (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]
option_integers (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]
option_boolean (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[BOOLEAN]
option_counter (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

Positional

positional_string (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]
positional_strings (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]
positional_file (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]
positional_directory (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]
positional_integer (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]
positional_integers (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]

no_parameters: COMMAND_LINE_ARGUMENT

useful to allow an empty command line.
remaining_parameters: COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

allows parameters to be set after a special "--" option

Option names validity

option_custom (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[D_]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void
decode /= Void

option_customs (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[D_]]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void
decode /= Void

positional_custom (name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[D_]

effective function

require

name /= Void
decode /= Void

positional_customs (name: ABSTRACT_STRING, usage: ABSTRACT_STRING, validate: FUNCTION[TUPLE 1[STRING], BOOLEAN], decode: FUNCTION[TUPLE[TUPLE 1[STRING], D_]]): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[D_]]

effective function

require

name /= Void
decode /= Void

option_string (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_strings (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_file (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_directory (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_integer (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_integers (short: ABSTRACT_STRING, long: ABSTRACT_STRING, name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void
name /= Void

option_boolean (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[BOOLEAN]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void

option_counter (short: ABSTRACT_STRING, long: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

effective function

require

short /= Void implies short_pattern.match(short.out)
long /= Void implies long_pattern.match(long.out)
short /= Void or else long /= Void

positional_string (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[FIXED_STRING]

effective function

require

name /= Void

positional_strings (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

effective function

require

name /= Void

positional_file (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[REGULAR_FILE]

effective function

require

name /= Void

positional_directory (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[DIRECTORY]

effective function

require

name /= Void

positional_integer (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[INTEGER_32]

effective function

require

name /= Void

positional_integers (name: ABSTRACT_STRING, usage: ABSTRACT_STRING): COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[INTEGER_32]]

effective function

require

name /= Void

no_parameters: COMMAND_LINE_ARGUMENT

once function

useful to allow an empty command line.

remaining_parameters: COMMAND_LINE_TYPED_ARGUMENT[TRAVERSABLE[FIXED_STRING]]

once function

allows parameters to be set after a special "--" option

short_pattern: REGULAR_EXPRESSION

once function

long_pattern: REGULAR_EXPRESSION

once function