* UCW Library -- Parsing of command line options
*
* (c) 2013 Jan Moskyto Matejka <mq@ucw.cz>
+ * (c) 2014 Martin Mares <mj@ucw.cz>
*
* This software may be freely distributed and used according to the terms
* of the GNU Lesser General Public License.
#include <alloca.h>
#include <math.h>
-int opt_parsed_count = 0;
-int opt_conf_parsed_count = 0;
+/***
+ * Value flags defaults
+ * ~~~~~~~~~~~~~~~~~~~~
+ *
+ * OPT_NO_VALUE for OPT_BOOL, OPT_SWITCH and OPT_INC
+ * OPT_MAYBE_VALUE for OPT_STRING, OPT_UNS, OPT_INT
+ * Some of the value flags (OPT_NO_VALUE, OPT_MAYBE_VALUE, OPT_REQUIRED_VALUE)
+ * must be specified for OPT_CALL and OPT_USER.
+ ***/
+static uns opt_default_value_flags[] = {
+ [OPT_CL_BOOL] = OPT_NO_VALUE,
+ [OPT_CL_STATIC] = OPT_MAYBE_VALUE,
+ [OPT_CL_SWITCH] = OPT_NO_VALUE,
+ [OPT_CL_INC] = OPT_NO_VALUE,
+ [OPT_CL_CALL] = 0,
+ [OPT_CL_USER] = 0,
+ [OPT_CL_SECTION] = 0,
+ [OPT_CL_HELP] = 0
+};
+
+struct opt_precomputed {
+ struct opt_item * item;
+ const char * name;
+ short flags;
+ short count;
+};
+
+struct opt_context {
+ struct opt_precomputed * opts;
+ struct opt_precomputed ** shortopt;
+ struct opt_item ** hooks_before_arg;
+ struct opt_item ** hooks_before_value;
+ struct opt_item ** hooks_after_value;
+ short opt_count;
+ short hooks_before_arg_count;
+ short hooks_before_value_count;
+ short hooks_after_value_count;
+ int positional_max;
+ int positional_count;
+};
static void opt_failure(const char * mesg, ...) FORMAT_CHECK(printf,1,2) NONRET;
static void opt_failure(const char * mesg, ...) {
va_end(args); // FIXME: Does this make a sense after exit()?
}
-// FIXME: This could be an inline function, couldn't it?
-#define OPT_ADD_DEFAULT_ITEM_FLAGS(item, flags) \
- do { \
- if (item->letter >= 256) { \
- if (flags & OPT_VALUE_FLAGS) /* FIXME: Redundant condition */ \
- flags &= ~OPT_VALUE_FLAGS; \
- flags |= OPT_REQUIRED_VALUE; \
- } \
- if (!(flags & OPT_VALUE_FLAGS) && \
- (item->cls == OPT_CL_CALL || item->cls == OPT_CL_USER)) { \
- fprintf(stderr, "You MUST specify some of the value flags for the %c/%s item.\n", item->letter, item->name); \
- ASSERT(0); \
- } \
- else if (!(flags & OPT_VALUE_FLAGS)) /* FIXME: Streamline the conditions */ \
- flags |= opt_default_value_flags[item->cls]; \
- } while (0)
-// FIXME: Is this still useful? Isn't it better to use OPT_ADD_DEFAULT_ITEM_FLAGS during init?
-#define OPT_ITEM_FLAGS(item) ((item->flags & OPT_VALUE_FLAGS) ? item->flags : item->flags | opt_default_value_flags[item->cls])
-
-const struct opt_section * opt_section_root;
-
#define FOREACHLINE(text) for (const char * begin = (text), * end = (text); (*end) && (end = strchrnul(begin, '\n')); begin = end+1)
-void opt_help_internal(const struct opt_section * help) {
+static inline uns uns_min(uns x, uns y)
+{
+ return MIN(x, y);
+}
+
+void opt_help(const struct opt_section * help) {
int sections_cnt = 0;
int lines_cnt = 0;
uns eol = strchrnul(item->help, '\n') - item->help;
if (valoff > eol)
valoff = eol;
-#define VAL(it) ((OPT_ITEM_FLAGS(it) & OPT_REQUIRED_VALUE) ? stk_printf("=%.*s", valoff, item->help) : ((OPT_ITEM_FLAGS(it) & OPT_NO_VALUE) ? "" : stk_printf("(=%.*s)", valoff, item->help)))
+#define VAL(it) ((it->flags & OPT_REQUIRED_VALUE) ? stk_printf("=%.*s", valoff, item->help) : ((it->flags & OPT_NO_VALUE) ? "" : stk_printf("(=%.*s)", valoff, item->help)))
if (item->name) {
lines[line][1] = stk_printf("--%s%s", item->name, VAL(item));
if (linelengths[1] < (int) strlen(lines[line][1]))
#undef SPLITLINES
s = 0;
-#define FIELD(k) linelengths[k], MIN(strchrnul(lines[i][k], '\t')-lines[i][k],strchrnul(lines[i][k], '\n')-lines[i][k]), lines[i][k]
-#define LASTFIELD(k) MIN(strchrnul(lines[i][k], '\t')-lines[i][k],strchrnul(lines[i][k], '\n')-lines[i][k]), lines[i][k]
+#define FIELD(k) linelengths[k], uns_min(strchrnul(lines[i][k], '\t') - lines[i][k], strchrnul(lines[i][k], '\n') - lines[i][k]), lines[i][k]
+#define LASTFIELD(k) uns_min(strchrnul(lines[i][k], '\t') - lines[i][k], strchrnul(lines[i][k], '\n') - lines[i][k]), lines[i][k]
for (int i=0;i<line;i++) {
while (s < sections_cnt && sections[s].pos == i) {
- opt_help_internal(sections[s].sect);
+ opt_help(sections[s].sect);
s++;
}
if (lines[i][0] == NULL)
printf("%-*.*s %-*.*s %.*s\n", FIELD(0), FIELD(1), LASTFIELD(2));
}
while (s < sections_cnt && sections[s].pos == line) {
- opt_help_internal(sections[s].sect);
+ opt_help(sections[s].sect);
s++;
}
}
-static int opt_positional_max = 0;
-static int opt_positional_count = 0;
-
-struct opt_precomputed {
- struct opt_precomputed_option {
- struct opt_precomputed *pre;
- struct opt_item * item;
- const char * name;
- short flags;
- short count;
- } ** opts;
- struct opt_precomputed_option ** shortopt;
- struct opt_item ** hooks_before_arg;
- struct opt_item ** hooks_before_value;
- struct opt_item ** hooks_after_value;
- short opt_count;
- short hooks_before_arg_count;
- short hooks_before_value_count;
- short hooks_after_value_count;
-};
-
-static struct opt_precomputed_option * opt_find_item_shortopt(int chr, struct opt_precomputed * pre) {
- struct opt_precomputed_option * candidate = pre->shortopt[chr];
+static struct opt_precomputed * opt_find_item_shortopt(struct opt_context * oc, int chr) {
+ struct opt_precomputed * candidate = oc->shortopt[chr];
if (!candidate)
opt_failure("Invalid option -%c", chr);
if (candidate->count++ && (candidate->flags & OPT_SINGLE))
return candidate;
}
-static struct opt_precomputed_option * opt_find_item_longopt(char * str, struct opt_precomputed * pre) {
+static struct opt_precomputed * opt_find_item_longopt(struct opt_context * oc, char * str) {
uns len = strlen(str);
- struct opt_precomputed_option * candidate = NULL;
+ struct opt_precomputed * candidate = NULL;
- for (int i=0; i<pre->opt_count; i++) {
- if (!pre->opts[i]->name)
+ for (int i=0; i<oc->opt_count; i++) {
+ if (!oc->opts[i].name)
continue;
- if (!strncmp(pre->opts[i]->name, str, len)) {
- if (strlen(pre->opts[i]->name) == len) {
- if (pre->opts[i]->count++ && (pre->opts[i]->flags & OPT_SINGLE))
- opt_failure("Option %s appeared the second time.", pre->opts[i]->name);
+ if (!strncmp(oc->opts[i].name, str, len)) {
+ if (strlen(oc->opts[i].name) == len) {
+ if (oc->opts[i].count++ && (oc->opts[i].flags & OPT_SINGLE))
+ opt_failure("Option %s appeared the second time.", oc->opts[i].name);
- return pre->opts[i];
+ return &oc->opts[i];
}
if (candidate)
- opt_failure("Ambiguous prefix %s: Found matching %s and %s.", str, candidate->name, pre->opts[i]->name);
+ opt_failure("Ambiguous prefix %s: Found matching %s and %s.", str, candidate->name, oc->opts[i].name);
else
- candidate = pre->opts[i];
+ candidate = &oc->opts[i];
}
- if (!strncmp("no-", str, 3) && !strncmp(pre->opts[i]->name, str+3, len-3)) {
- if (strlen(pre->opts[i]->name) == len-3) {
- if (pre->opts[i]->count++ && (pre->opts[i]->flags & OPT_SINGLE))
- opt_failure("Option %s appeared the second time.", pre->opts[i]->name);
+ if (!strncmp("no-", str, 3) && !strncmp(oc->opts[i].name, str+3, len-3)) {
+ if (strlen(oc->opts[i].name) == len-3) {
+ if (oc->opts[i].count++ && (oc->opts[i].flags & OPT_SINGLE))
+ opt_failure("Option %s appeared the second time.", oc->opts[i].name);
- return pre->opts[i];
+ return &oc->opts[i];
}
if (candidate)
- opt_failure("Ambiguous prefix %s: Found matching %s and %s.", str, candidate->name, pre->opts[i]->name);
+ opt_failure("Ambiguous prefix %s: Found matching %s and %s.", str, candidate->name, oc->opts[i].name);
else
- candidate = pre->opts[i];
+ candidate = &oc->opts[i];
}
}
ptr = item->ptr; \
ptr; })
-#define OPT_NAME (longopt == 2 ? stk_printf("positional arg #%d", opt_positional_count) : (longopt == 1 ? stk_printf("--%s", opt->name) : stk_printf("-%c", item->letter)))
-static void opt_parse_value(struct opt_precomputed_option * opt, char * value, int longopt) {
+#define OPT_NAME (longopt == 2 ? stk_printf("positional arg #%d", oc->positional_count) : (longopt == 1 ? stk_printf("--%s", opt->name) : stk_printf("-%c", item->letter)))
+static void opt_parse_value(struct opt_context * oc, struct opt_precomputed * opt, char * value, int longopt) {
struct opt_item * item = opt->item;
- struct opt_precomputed * pre = opt->pre;
- for (int i=0;i<pre->hooks_before_value_count;i++)
- pre->hooks_before_value[i]->u.call(item, value, pre->hooks_before_value[i]->ptr);
+ for (int i=0;i<oc->hooks_before_value_count;i++)
+ oc->hooks_before_value[i]->u.call(item, value, oc->hooks_before_value[i]->ptr);
switch (item->cls) {
case OPT_CL_BOOL:
default:
ASSERT(0);
}
- opt_parsed_count++;
- for (int i=0;i<pre->hooks_after_value_count;i++)
- pre->hooks_after_value[i]->u.call(item, value, pre->hooks_after_value[i]->ptr);
+ for (int i=0;i<oc->hooks_after_value_count;i++)
+ oc->hooks_after_value[i]->u.call(item, value, oc->hooks_after_value[i]->ptr);
}
#undef OPT_NAME
-static int opt_longopt(char ** argv, int index, struct opt_precomputed * pre) {
+static int opt_longopt(struct opt_context * oc, char ** argv, int index) {
int eaten = 0;
char * name_in = argv[index] + 2; // skipping the -- on the beginning
uns pos = strchrnul(name_in, '=') - name_in;
- struct opt_precomputed_option * opt = opt_find_item_longopt(strndupa(name_in, pos), pre);
+ struct opt_precomputed * opt = opt_find_item_longopt(oc, strndupa(name_in, pos));
char * value = NULL;
if (opt->item->cls == OPT_CL_BOOL && !strncmp(name_in, "no-", 3) && !strncmp(name_in+3, opt->item->name, pos-3))
if (pos < strlen(name_in))
opt_failure("Argument --%s must not have any value.", opt->name);
}
- opt_parse_value(opt, value, 1);
+ opt_parse_value(oc, opt, value, 1);
return eaten;
}
-static int opt_shortopt(char ** argv, int index, struct opt_precomputed * pre) {
+static int opt_shortopt(struct opt_context * oc, char ** argv, int index) {
int chr = 0;
- struct opt_precomputed_option * opt;
- while (argv[index][++chr] && (opt = opt_find_item_shortopt(argv[index][chr], pre))) {
+ struct opt_precomputed * opt;
+ while (argv[index][++chr] && (opt = opt_find_item_shortopt(oc, argv[index][chr]))) {
if (opt->flags & OPT_NO_VALUE) {
- opt_parse_value(opt, NULL, 0);
+ opt_parse_value(oc, opt, NULL, 0);
}
else if (opt->flags & OPT_REQUIRED_VALUE) {
if (chr == 1 && argv[index][2]) {
- opt_parse_value(opt, argv[index] + 2, 0);
+ opt_parse_value(oc, opt, argv[index] + 2, 0);
return 0;
}
else if (argv[index][chr+1])
else if (!argv[index+1])
opt_failure("Option -%c must have a value but nothing supplied.", opt->item->letter);
else {
- opt_parse_value(opt, argv[index+1], 0);
+ opt_parse_value(oc, opt, argv[index+1], 0);
return 1;
}
}
else if (opt->flags & OPT_MAYBE_VALUE) {
if (chr == 1 && argv[index][2]) {
- opt_parse_value(opt, argv[index] + 2, 0);
+ opt_parse_value(oc, opt, argv[index] + 2, 0);
return 0;
}
else
- opt_parse_value(opt, NULL, 0);
+ opt_parse_value(oc, opt, NULL, 0);
}
else {
ASSERT(0);
return 0;
}
-static void opt_positional(char * value, struct opt_precomputed * pre) {
- opt_positional_count++;
- struct opt_precomputed_option * opt = opt_find_item_shortopt((opt_positional_count > opt_positional_max ? 256 : opt_positional_count + 256), pre);
+static void opt_positional(struct opt_context * oc, char * value) {
+ oc->positional_count++;
+ struct opt_precomputed * opt = opt_find_item_shortopt(oc, (oc->positional_count > oc->positional_max ? 256 : oc->positional_count + 256));
if (!opt) {
- ASSERT(opt_positional_count > opt_positional_max);
+ ASSERT(oc->positional_count > oc->positional_max);
opt_failure("Too many positional args.");
}
- opt_parse_value(opt, value, 2);
+ opt_parse_value(oc, opt, value, 2);
}
-#define OPT_TRAVERSE_SECTIONS \
- while (item->cls == OPT_CL_SECTION) { \
- if (stk->next) \
- stk = stk->next; \
- else { \
- struct opt_stack * new_stk = alloca(sizeof(*new_stk)); \
- new_stk->prev = stk; \
- stk->next = new_stk; \
- stk = new_stk; \
- } \
- stk->this = item; \
- item = item->u.section->opt; \
- } \
- if (item->cls == OPT_CL_END) { \
- if (!stk->prev) break; \
- item = stk->this; \
- stk = stk->prev; \
- continue; \
+static void opt_count_items(struct opt_context *oc, const struct opt_section *sec)
+{
+ for (const struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
+ if (item->cls == OPT_CL_SECTION)
+ opt_count_items(oc, item->u.section);
+ else if (item->cls == OPT_CL_HOOK) {
+ if (item->flags & OPT_HOOK_BEFORE_ARG)
+ oc->hooks_before_arg_count++;
+ else if (item->flags & OPT_HOOK_BEFORE_VALUE)
+ oc->hooks_before_value_count++;
+ else if (item->flags & OPT_HOOK_AFTER_VALUE)
+ oc->hooks_after_value_count++;
+ else
+ ASSERT(0);
+ } else if (item->letter || item->name) {
+ oc->opt_count++;
+ if (item->letter > OPT_POSITIONAL_TAIL)
+ oc->positional_max++;
}
-
-void opt_parse(const struct opt_section * options, char ** argv) {
- opt_section_root = options;
-
- struct opt_stack {
- struct opt_item * this;
- struct opt_stack * prev;
- struct opt_stack * next;
- } * stk = alloca(sizeof(*stk));
- stk->this = NULL;
- stk->prev = NULL;
- stk->next = NULL;
-
- struct opt_precomputed * pre = alloca(sizeof(*pre));
- memset(pre, 0, sizeof (*pre));
-
- int count = 0;
- int hooks = 0;
-
- for (struct opt_item * item = options->opt; ; item++) {
- OPT_TRAVERSE_SECTIONS;
- if (item->letter || item->name)
- count++;
- if (item->cls == OPT_CL_BOOL)
- count++;
- if (item->letter > 256)
- opt_positional_max++;
- if (item->cls == OPT_CL_HOOK)
- hooks++;
}
+}
- pre->opts = alloca(sizeof(*pre->opts) * count);
- pre->shortopt = alloca(sizeof(*pre->shortopt) * (opt_positional_max + 257));
- memset(pre->shortopt, 0, sizeof(*pre->shortopt) * (opt_positional_max + 257));
- pre->hooks_before_arg = alloca(sizeof (*pre->hooks_before_arg) * hooks);
- pre->hooks_before_value = alloca(sizeof (*pre->hooks_before_value) * hooks);
- pre->hooks_after_value = alloca(sizeof (*pre->hooks_after_value) * hooks);
+static void opt_add_default_flags(struct opt_precomputed *opt)
+{
+ struct opt_item *item = opt->item;
+ uns flags = opt->flags;
- pre->hooks_before_arg_count = 0;
- pre->hooks_before_value_count = 0;
- pre->hooks_after_value_count = 0;
+ if (item->letter >= 256) {
+ flags &= ~OPT_VALUE_FLAGS;
+ flags |= OPT_REQUIRED_VALUE;
+ }
+ if (!(flags & OPT_VALUE_FLAGS)) {
+ ASSERT(item->cls != OPT_CL_CALL && item->cls != OPT_CL_USER);
+ flags |= opt_default_value_flags[item->cls];
+ }
- pre->opt_count = 0;
+ opt->flags = flags;
+}
- for (struct opt_item * item = options->opt; ; item++) {
- OPT_TRAVERSE_SECTIONS;
- if (item->letter || item->name) {
- struct opt_precomputed_option * opt = xmalloc(sizeof(*opt));
- opt->pre = pre;
- opt->item = item;
- opt->flags = item->flags;
- opt->count = 0;
- opt->name = item->name;
- pre->opts[pre->opt_count++] = opt;
- if (item->letter)
- pre->shortopt[(int) item->letter] = opt;
- OPT_ADD_DEFAULT_ITEM_FLAGS(item, opt->flags);
- }
- if (item->cls == OPT_CL_HOOK) {
+static void opt_prepare_items(struct opt_context *oc, const struct opt_section *sec)
+{
+ for (struct opt_item *item = sec->opt; item->cls != OPT_CL_END; item++) {
+ if (item->cls == OPT_CL_SECTION)
+ opt_prepare_items(oc, item->u.section);
+ else if (item->cls == OPT_CL_HOOK) {
if (item->flags & OPT_HOOK_BEFORE_ARG)
- pre->hooks_before_arg[pre->hooks_before_arg_count++] = item;
+ oc->hooks_before_arg[oc->hooks_before_arg_count++] = item;
else if (item->flags & OPT_HOOK_BEFORE_VALUE)
- pre->hooks_before_value[pre->hooks_before_value_count++] = item;
+ oc->hooks_before_value[oc->hooks_before_value_count++] = item;
else if (item->flags & OPT_HOOK_AFTER_VALUE)
- pre->hooks_after_value[pre->hooks_after_value_count++] = item;
+ oc->hooks_after_value[oc->hooks_after_value_count++] = item;
else
ASSERT(0);
+ } else if (item->letter || item->name) {
+ struct opt_precomputed * opt = &oc->opts[oc->opt_count++];
+ opt->item = item;
+ opt->flags = item->flags;
+ opt->count = 0;
+ opt->name = item->name;
+ if (item->letter)
+ oc->shortopt[(int) item->letter] = opt;
+ opt_add_default_flags(opt);
}
}
+}
+
+void opt_parse(const struct opt_section * options, char ** argv) {
+ struct opt_context * oc = alloca(sizeof(*oc));
+ memset(oc, 0, sizeof (*oc));
+
+ opt_count_items(oc, options);
+ oc->opts = alloca(sizeof(*oc->opts) * oc->opt_count);
+ oc->shortopt = alloca(sizeof(*oc->shortopt) * (oc->positional_max + 257));
+ memset(oc->shortopt, 0, sizeof(*oc->shortopt) * (oc->positional_max + 257));
+ oc->hooks_before_arg = alloca(sizeof (*oc->hooks_before_arg) * oc->hooks_before_arg_count);
+ oc->hooks_before_value = alloca(sizeof (*oc->hooks_before_value) * oc->hooks_before_value_count);
+ oc->hooks_after_value = alloca(sizeof (*oc->hooks_after_value) * oc->hooks_after_value_count);
+
+ oc->opt_count = 0;
+ oc->hooks_before_arg_count = 0;
+ oc->hooks_before_value_count = 0;
+ oc->hooks_after_value_count = 0;
+ opt_prepare_items(oc, options);
int force_positional = 0;
for (int i=0;argv[i];i++) {
- for (int j=0;j<pre->hooks_before_arg_count;j++)
- pre->hooks_before_arg[j]->u.call(NULL, NULL, pre->hooks_before_arg[j]->ptr);
+ for (int j=0;j<oc->hooks_before_arg_count;j++)
+ oc->hooks_before_arg[j]->u.call(NULL, NULL, oc->hooks_before_arg[j]->ptr);
if (argv[i][0] != '-' || force_positional) {
- opt_positional(argv[i], pre);
+ opt_positional(oc, argv[i]);
}
else {
if (argv[i][1] == '-') {
if (argv[i][2] == '\0')
force_positional++;
else
- i += opt_longopt(argv, i, pre);
+ i += opt_longopt(oc, argv, i);
}
else if (argv[i][1])
- i += opt_shortopt(argv, i, pre);
+ i += opt_shortopt(oc, argv, i);
else
- opt_positional(argv[i], pre);
+ opt_positional(oc, argv[i]);
}
}
- for (int i=0;i<opt_positional_max+257;i++) {
- if (!pre->shortopt[i])
+ for (int i=0;i<oc->positional_max+257;i++) {
+ if (!oc->shortopt[i])
continue;
- if (!pre->shortopt[i]->count && (pre->shortopt[i]->flags & OPT_REQUIRED))
+ if (!oc->shortopt[i]->count && (oc->shortopt[i]->flags & OPT_REQUIRED))
if (i < 256)
- opt_failure("Required option -%c not found.\n", pre->shortopt[i]->item->letter);
+ if (oc->shortopt[i]->item->name)
+ opt_failure("Required option -%c/--%s not found.", oc->shortopt[i]->item->letter, oc->shortopt[i]->item->name);
+ else
+ opt_failure("Required option -%c not found.", oc->shortopt[i]->item->letter);
else
- opt_failure("Required positional argument #%d not found.\n", (i > 256) ? pre->shortopt[i]->item->letter-256 : opt_positional_max+1);
+ opt_failure("Required positional argument #%d not found.", (i > 256) ? oc->shortopt[i]->item->letter-256 : oc->positional_max+1);
}
- for (int i=0;i<pre->opt_count;i++) {
- if (!pre->opts[i])
- continue;
- if (!pre->opts[i]->count && (pre->opts[i]->flags & OPT_REQUIRED))
- opt_failure("Required option --%s not found.\n", pre->opts[i]->item->name);
+ for (int i=0;i<oc->opt_count;i++) {
+ if (!oc->opts[i].count && (oc->opts[i].flags & OPT_REQUIRED))
+ opt_failure("Required option --%s not found.", oc->opts[i].item->name);
}
}
break;
#endif
}
-
- opt_conf_parsed_count++;
}
void opt_conf_hook_internal(struct opt_item * opt, const char * value UNUSED, void * data UNUSED) {
projects / libucw.git / blobdiff