Function cliParse

CLI/CLI.cpp:235–269

Parse options in optstring out of argc,argv. The optstring is a space separated list of options. The options need not start with '-'. To recognize just "-" or "--" just add it in. Return a map containing the options found; if option in optstring was followed by ':', map value will be the next argv argument, otherwise "true". Leave argc,argv pointing at the first argument after the options, ie, o

// Leave argc,argv pointing at the first argument after the options, ie, on return argc is the number of non-option arguments remaining in argv.
// This routine does not allow combining options, ie, -a -b != -ab
static map<string,string> cliParse(int &argc, char **&argv, ostream &os, const char *optstring)
{
	map<string,string> options;		// The result
	// Skip the command name.
	argc--, argv++;
	// Parse args.
	for ( ; argc > 0; argc--, argv++ ) {
		char *arg = argv[0];
		// The argv to match may not contain ':' to prevent the pathological case, for example, where optionlist contains "-a:" and command line arg is "-a:"
		if (strchr(arg,':')) { return options; }	// Can't parse this, too dangerous.
		const char *op = strstr(optstring,arg);
		if (op && (op == optstring || op[-1] == ' ')) {
			const char *ep = op + strlen(arg);
			if (*ep == ':') {
				// This valid option requires an argument.
				argc--, argv++;
				if (argc <= 0) { throw CLIParseError(format("expected argument after: %s",arg)); }
				options[arg] = string(argv[0]);
				continue;
			} else if (*ep == 0 || *ep == ' ') {
				// This valid option does not require an argument.
				options[arg] = string("true");
				continue;
			} else {
				// Partial match of something in optstring; drop through to treat it like any other argument.
			}
		} else {
			break;	// Return when we find the first non-option.
		}
		// An argument beginning with - and not in optstring is an unrecognized option and is an error.
		if (*arg == '-') { throw CLIParseError(format("unrecognized argument: %s",arg)); }
		return options;
	}
	return options;
}


/**@name Commands for the CLI. */