argsd 0.3.1

A command line argument and config file parser


To use this package, put the following dependency into your project's dependencies section:

dub.json
dub.sdl

args

alt text

A command line and config file parser for DLang

/** argsd arguments are structures as shown below.
Each argument that should be searched for needs to have $(D @Arg())
attached to it.
$(D @Arg()) takes three kinds of parameter.
1. A $(D string) which is used as the help message for that argument.
2. A $(D char) which is used as the character for the short argument
selector.
3. A $(D Optional) value to make the argument as optional or not (default
Optional.yes).
The order of the three parameter is not relevant.
Arguments can be nested, see the nested $(D NestedArgument) $(D struct) in
$(D MyAppArguments).
Arguments can be of all primitive types, arrays of primitive types and $(D
enum)s.

All arguments take the shape "name value". Equal sign syntax is not
supported.
Array values can be given as separate values of as comma separated values.

The name of the argument will be derived from the name of the member in
the struct. The names are case sensitive.
Arguments in nested structs have the name of the struct prefixed (compare
"--nested.someFloatValue).

Short names must be unique. If they are not unique an Exception will be
thrown. Short names are used by prefixing the character with a single "-".
The short name "-h" is reserved for requestion the help page.

Long names are unique by definition. Long names are prefixed with "--".
The long name "--help" is reserved for requestion the help page.

If $(D parseArgsWithConfigFile) is used two more long names are reserved,
"--config", and "--genConfig". Both take a $(D string) as argument.
"--config filename" will try to parse the file with name $(I filename) and 
assign the values in that file to the argument struct passed.

"--genConfig filename" can be used to create a config file with
the default values of the argument struct. The name of the config file is
again $(I filename).
*/


/** A enum used inside of NestedArguments */
enum NestedEnumArgument {
	one,
	two,
	many
}

/** A struct nested in MyAppArguments */
static struct NestedArguments {
	@Arg("Important Help Message") float someFloatValue;

	// D allows to assign default values to the arguments
	@Arg('z') NestedEnumArgument enumArg = NestedEnumArgument.two;
	@Arg() bool someBool;
}

/** The options to the created program. */
static struct MyAppArguments {
	@Arg(Optional.no) string inputFilename;
	@Arg('b') int[] testValues;

	/** All options inside of $(D nested) need to be prefixed with
	  "nested.".
	*/
	@Arg() NestedArguments nested;
}

import std.algorithm.comparison : equal;
import std.format : format;
import std.math : approxEqual;

/** It is good practice to have the arguments write-protected by default.
The following three declarations show a possible implementation.
In order to look up a argument the developer would use the $(D config())
function, returning him a write-protected version of the arguments.
In order to populate the arguments the writable version returned from
$(D configWriteable) is passed to $(D parseArgsWithConfigFile).
This, and the option definitions is usually placed in a separate file and
the visibility of $(D MyAppArguments arguments) is set to $(D private).
*/
MyAppArguments arguments;

ref MyAppArguments configWriteable() {
	return arguments;
}

ref const(MyAppArguments) config() {
	return arguments;
}

/** This $(D string[]) serves as an example of what would be passed to the
$(D main) function from the command line.
*/
string[] args = ["./executablename", 
	"--nested.someBool", 
	"--nested.someFloatValue", "12.34",
	"--testValues", "10",
	"-b", "11,12", 
	"--nested.enumArg", "many", 
	"--inputFilename", "nice.d"];

/** Populates the argument struct returned from configWriteable with the
values passed in $(D args).

$(D true) is returned if the help page is requested with either "-h" or
"--help".
$(D parseArgsWithConfigFile), and $(D parseArgs) will remove all used
strings from $(D args).
After the unused strings and the application name are left in $(D args).

Replacing $(D parseArgsWithConfigFile) with $(D parseArgs) will disable
the config file parsing option.
*/
bool helpWanted = parseArgsWithConfigFile(configWriteable(), args);

if(helpWanted) {
	/** If the help page is wanted by the user the $(D printArgsHelp)
	function can be used to print help page.
	*/
	printArgsHelp(config(), "A text explaining the program");
}

/** Here it is tested if the parsing of $(D args) was successful. */
assert(equal(config().testValues, [10,11,12]));
assert(config().nested.enumArg == NestedEnumArgument.many);
assert(approxEqual(config().nested.someFloatValue, 12.34));
assert(config().nested.someBool);
assert(config().inputFilename == "nice.d");
Authors:
burner
Dependencies:
stringbuffer
Versions:
0.3.1 2017-Oct-25
0.3.0 2017-Sep-13
0.2.0 2017-Aug-01
0.1.1 2017-Jul-06
0.1.0 2017-May-22
Show all 7 versions
Download Stats:
  • 0 downloads today

  • 1 downloads this week

  • 11 downloads this month

  • 90 downloads total