Optparse.hx

Command line argument parsing.

Summary

Optparse.hx	Command line argument parsing.
ReaderResult	Result of some reader function.
Variables
value	The value read by a reader function.
advance	How many parameters has been parsed by the reader function.
Types
Types
OptionReader	Prototype of a reader function.
OptionWriter	Prototype of a writer function.
OptparseException	Exception class thrown by Optparse
Functions
new	Constructor
toString	Converts the exception to a string.
Optparse	Command line argument parsing class.
new	Constructor.
addOption	Adds a new command line option to the parser.
parse	Parses the command line arguments according to the previously specified options by addOption.
getHelp	Generates option usage help from the previously specified help and help_arg paramteres in addOption.
Reader functions
readerNull	Null option reader.
readerString	String option reader.
readerInt	Integer option reader.
readerFloat	Float option reader.
readerKVArray	Key/value pair list option reader.
Writer functions
writerNull	Null option writer.
writerStore	Store option writer.
writerStoreTrue	True boolean value option writer.
writerStoreFalse	False boolean value option writer.
writerIncrement	Increment option writer.
writerAppend	Array append option writer.
makeWriterStoreConst	Constant option writer creator.

ReaderResult

Result of some reader function.

Summary

Variables
value	The value read by a reader function.
advance	How many parameters has been parsed by the reader function.

Variables

value

value: Dynamic

The value read by a reader function.

advance

advance: Int

How many parameters has been parsed by the reader function.

Types

Summary

Types
OptionReader	Prototype of a reader function.
OptionWriter	Prototype of a writer function.

Types

OptionReader

Prototype of a reader function.

Array<String> -> Int -> ReaderResult;

OptionWriter

Prototype of a writer function.

Dynamic -> String -> Dynamic -> Void

OptparseException

Exception class thrown by Optparse

Summary

Functions
new	Constructor
toString	Converts the exception to a string.

Functions

new

public function new( message: String,
arg: String,
arg_pos: Int )

Constructor

Parameters

message	the exception message.
arg	the argument where the exception occured.
arg_pos	the position of the argument in argument list.

toString

public function toString()

Converts the exception to a string.

Returns

The string representation of the exception.

Optparse

Command line argument parsing class.

Summary

new	Constructor.
addOption	Adds a new command line option to the parser.
parse	Parses the command line arguments according to the previously specified options by addOption.
getHelp	Generates option usage help from the previously specified help and help_arg paramteres in addOption.
Reader functions
readerNull	Null option reader.
readerString	String option reader.
readerInt	Integer option reader.
readerFloat	Float option reader.
readerKVArray	Key/value pair list option reader.
Writer functions
writerNull	Null option writer.
writerStore	Store option writer.
writerStoreTrue	True boolean value option writer.
writerStoreFalse	False boolean value option writer.
writerIncrement	Increment option writer.
writerAppend	Array append option writer.
makeWriterStoreConst	Constant option writer creator.

new

public function new()

Constructor.

addOption

public function addOption( short: String,
long: String,
field: String,
reader: OptionReader,
writer: OptionWriter,
?help: String,
?help_arg: String )

Adds a new command line option to the parser.

Parameters

short	the short version of the command line option. Can be null if no short version is required. (Example: “-h”)
long	the long version of the command line option. Can be null if no long version is required. (Example: “--help”)
field	the name of the field which will hold the parsed argument value
reader	the option reader function which will parse the command line option and it’s arguments (if there are any)
writer	the option writer function which will store the value parsed by the reader (or any other value if necessary)
help	the help text for the option. It will be included in the help message generated by getHelp. Can be omitted.
help_arg	the format description for the argument(s) of the command line option. Can be omitted.

parse

public function parse( options: Dynamic,
args: Array<String>,
start: Int = 0 ): Int

Parses the command line arguments according to the previously specified options by addOption.

Parameters

options	the object holding all the option fields
args	the array of command line arguments
start	the start index of parsing

Returns

The index of the command line argument which cannot be parsed.

getHelp

public function getHelp(): StringBuf

Generates option usage help from the previously specified help and help_arg paramteres in addOption.

Returns

The generated help as a String.

Reader functions

readerNull

public static function readerNull( args: Array<String>,
act: Int ): ReaderResult

Null option reader. Used for options without arguments.

Parameters

args	the array of command line arguments
act	the index of actually parsed argument

Returns

value	null
advance	1

readerString

public static function readerString( args: Array<String>,
act: Int ): ReaderResult

String option reader. Used for options with exactly one argument.

Parameters

args	the array of command line arguments
act	the index of actually parsed argument

Returns

value	the argument as a String
advance	2

readerInt

public static function readerInt( args: Array<String>,
act: Int ): ReaderResult

Integer option reader. Used for options with exactly one integer argument.

Parameters

args	the array of command line arguments
act	the index of actually parsed argument

Returns

value	the argument as an Int
advance	2

Throws

OptparseException if the argument is missing or cannot be converted to Int.

readerFloat

public static function readerFloat( args: Array<String>,
act: Int ): ReaderResult

Float option reader. Used for options with exactly one floating point argument.

Parameters

args	the array of command line arguments
act	the index of actually parsed argument

Returns

value	the argument as a Float
advance	2

Throws

OptparseException if the argument is missing or cannot be converted to Float.

readerKVArray

public static function readerKVArray( args: Array<String>,
act: Int ): ReaderResult

Key/value pair list option reader. Used for options with a list of key/value pairs argument. The key/value pairs are in the following format:

key[=value][:key[=value]...]

Values can be omitted along with equal sign.

Parameters

args	the array of command line arguments
act	the index of actually parsed argument

Returns

value	the argument as an Array<{key: String, value: String}>
advance	2 (the whole key/value list is one string without spaces)

Throws

OptparseException if the argument is missing or the one of the key/value pairs has an invalid format.

Writer functions

writerNull

public static function writerNull( options: Dynamic,
field: String,
value: Dynamic )

Null option writer. Used when the processed option doesn’t have any argument or when the previously parsed argument doesn’t need to be stored.

Parameters

options	the object holding all the option fields
field	the name of the field to store value in
value	the previously parsed value to be stored

writerStore

public static function writerStore( options: Dynamic,
field: String,
value: Dynamic )

Store option writer. Stores the previously parsed argument into the specified option field.

writerStoreTrue

public static function writerStoreTrue( options: Dynamic,
field: String,
value: Dynamic )

True boolean value option writer. Stores true into the specified field as a Bool.

Parameters

options	the object holding all the option fields
field	the name of the field to store value in
value	the previously parsed value to be stored

Field requirements

Has to be Bool type.

writerStoreFalse

public static function writerStoreFalse( options: Dynamic,
field: String,
value: Dynamic )

False boolean value option writer. Stores false into the specified field as a Bool.

Parameters

options	the object holding all the option fields
field	the name of the field to store value in
value	the previously parsed value to be stored

Field requirements

Has to be Bool type.

writerIncrement

public static function writerIncrement( options: Dynamic,
field: String,
value: Dynamic )

Increment option writer. Increments the specified field by one.

Parameters

options	the object holding all the option fields
field	the name of the field to store value in
value	the previously parsed value to be stored

Field requirements

Has to be Int or Float type.

writerAppend

public static function writerAppend( options: Dynamic,
field: String,
value: Dynamic )

Array append option writer. Appends the previously parsed argument to the specified array field.

Parameters

options	the object holding all the option fields
field	the name of the field to store value in
value	the previously parsed value to be stored

Field requirements

Has to be Array type.

makeWriterStoreConst

public static function makeWriterStoreConst(
user_const: Dynamic
): Dynamic -> String -> Dynamic -> Void

Constant option writer creator. Returns a writer function which stores the specified value into the option field.

Parameters

user_const

the value to be stored

Returns

The appropriate option writer function.