2 libcore: library for basic data structures and algorithms.
3 Copyright (C) 2005 IPD Goos, Universit"at Karlsruhe, Germany
5 This library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
10 This library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public
16 License along with this library; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
34 /* Includes to determine user's home directory */
38 #include <sys/types.h>
43 /* maximum length of a path. */
49 #include "lc_common_t.h"
50 #include "lc_opts_t.h"
51 #include "lc_opts_enum.h"
52 #include "lc_parser_t.h"
54 #include "lc_printf.h"
57 #define ERR_STRING "In argument \"%s\": "
61 #define HELP_TEMPL "%-15s %-10s %-45s"
62 #define HELP_TEMPL_VALS HELP_TEMPL " [%s] (%s)"
64 static struct obstack obst;
66 static void set_name(lc_opt_entry_t *ent, const char *name)
69 ent->hash = HASH_STR(name, strlen(name));
72 #define entry_matches(ent,hash_val,str) \
73 ((ent)->hash == hash_val && strcmp((ent)->name, (str)) == 0)
75 #define entries_equal(e1,e2) entry_matches(e1, (e2)->hash, (e2)->name)
77 static lc_opt_err_info_t *set_error(lc_opt_err_info_t *err, int error, const char *arg)
88 int lc_opt_raise_error(const lc_opt_err_info_t *err, lc_opt_error_handler_t *handler,
95 if (err && lc_opt_is_error(err)) {
99 vsnprintf(buf, sizeof(buf), fmt, args);
108 static lc_opt_entry_t *init_entry(lc_opt_entry_t *ent, lc_opt_entry_t *parent,
109 const char *name, const char *desc)
111 const char *copied_name;
112 const char *copied_desc;
114 obstack_grow0(&obst, name, strlen(name));
115 copied_name = (char*)obstack_finish(&obst);
116 obstack_grow0(&obst, desc, strlen(desc));
117 copied_desc = (char*)obstack_finish(&obst);
119 memset(ent, 0, sizeof(*ent));
120 set_name(ent, copied_name);
121 ent->desc = copied_desc;
122 ent->parent = parent;
126 static lc_opt_entry_t *init_grp(lc_opt_entry_t *ent, lc_opt_err_info_t *err)
129 INIT_LIST_HEAD(&ent->v.grp.grps);
130 INIT_LIST_HEAD(&ent->v.grp.opts);
132 set_error(err, lc_opt_err_none, "");
134 if (ent->parent->is_grp)
135 list_add_tail(&ent->list, &lc_get_grp_special(ent->parent)->grps);
137 set_error(err, lc_opt_err_grp_expected, ent->parent->name);
143 static lc_opt_entry_t *init_opt(lc_opt_entry_t *ent,
145 void *val, size_t length,
146 lc_opt_callback_t *cb,
148 lc_opt_dump_vals_t *dump_vals,
149 lc_opt_err_info_t *err)
151 lc_opt_special_t *s = lc_get_opt_special(ent);
154 set_error(err, lc_opt_err_none, "");
155 list_add_tail(&ent->list, &lc_get_grp_special(ent->parent)->opts);
161 s->dump_vals = dump_vals;
168 lc_opt_entry_t *lc_opt_root_grp(void)
170 static lc_opt_entry_t root_group;
171 static int inited = 0;
177 init_entry(&root_group, NULL, "root", "The root node");
178 init_grp(&root_group, NULL);
184 int lc_opt_grp_is_root(const lc_opt_entry_t *ent)
186 return ent->parent == NULL;
189 static const char *get_type_name(lc_opt_type_t type)
193 #define XXX(t) case lc_opt_type_ ## t: res = #t; break
201 case lc_opt_type_negbit: res = "bit"; break;
202 case lc_opt_type_negboolean: res = "boolean"; break;
211 const char *lc_opt_get_type_name(const lc_opt_entry_t *ent)
213 return get_type_name(lc_get_opt_special(ent)->type);
216 lc_opt_entry_t *lc_opt_get_grp(lc_opt_entry_t *parent, const char *name)
218 lc_opt_entry_t *ent = lc_opt_find_grp(parent, name, NULL);
221 ent = OALLOC(&obst, lc_opt_entry_t);
222 init_entry(ent, parent, name, "");
229 lc_opt_entry_t *lc_opt_add_opt(lc_opt_entry_t *parent,
230 const char *name, const char *desc,
231 lc_opt_type_t type, void *value, size_t length,
232 lc_opt_callback_t *cb, lc_opt_dump_t *dump,
233 lc_opt_dump_vals_t *dump_vals,
234 lc_opt_err_info_t *err)
236 lc_opt_entry_t *res = NULL;
238 if (parent->is_grp) {
239 lc_opt_entry_t *ent = lc_opt_find_opt(parent, name, NULL);
242 res = OALLOC(&obst, lc_opt_entry_t);
243 init_entry(res, parent, name, desc);
244 init_opt(res, type, value, length, cb, dump, dump_vals, err);
246 set_error(err, lc_opt_err_opt_already_there, name);
248 set_error(err, lc_opt_err_grp_expected, name);
254 static lc_opt_entry_t *lc_opt_find_ent(const struct list_head *head, const char *name,
255 int error_to_use, lc_opt_err_info_t *err)
257 lc_opt_entry_t *ent, *found = NULL;
258 int error = error_to_use;
259 unsigned hash = HASH_STR(name, strlen(name));
261 if (!list_empty(head)) {
262 list_for_each_entry(lc_opt_entry_t, ent, head, list) {
263 if (entry_matches(ent, hash, name)) {
264 error = lc_opt_err_none;
271 set_error(err, error, name);
275 lc_opt_entry_t *lc_opt_find_grp(const lc_opt_entry_t *grp, const char *name, lc_opt_err_info_t *err)
277 return grp ? lc_opt_find_ent(&lc_get_grp_special(grp)->grps,
278 name, lc_opt_err_grp_not_found, err) : NULL;
281 lc_opt_entry_t *lc_opt_find_opt(const lc_opt_entry_t *grp, const char *name, lc_opt_err_info_t *err)
283 return grp ? lc_opt_find_ent(&lc_get_grp_special(grp)->opts,
284 name, lc_opt_err_opt_not_found, err) : NULL;
287 static const lc_opt_entry_t *resolve_up_to_last(const lc_opt_entry_t *root,
288 const char * const *names, int pos, int n, lc_opt_err_info_t *err)
295 ent = lc_opt_find_grp(root, names[pos], err);
296 return ent ? resolve_up_to_last(ent, names, pos + 1, n, err) : NULL;
299 static const char *path_delim = "/.";
301 static lc_opt_entry_t *resolve_up_to_last_str_rec(lc_opt_entry_t *from,
303 const char **last_name)
306 lc_opt_entry_t *res = from;
307 size_t end = strcspn(path, path_delim);
309 if (path[end] != '\0') {
310 /* skip all delimiters */
311 size_t next = strspn(path + end, path_delim);
313 /* copy the part of the path into a buffer */
314 char *buf = (char*)malloc((end+1) * sizeof(buf[0]));
315 strncpy(buf, path, end);
318 /* resolve the group and free */
319 from = lc_opt_get_grp(from, buf);
322 res = resolve_up_to_last_str_rec(from, path + end + next, last_name);
325 else if (last_name != NULL) {
332 static lc_opt_entry_t *resolve_up_to_last_str(lc_opt_entry_t *root, const char *path, const char **last_name)
334 size_t next = strspn(path, path_delim);
336 /* if l != 0 we saw deliminators, so we resolve from the root */
338 root = lc_opt_root_grp();
340 return resolve_up_to_last_str_rec(root, path + next, last_name);
343 lc_opt_entry_t *lc_opt_resolve_grp(const lc_opt_entry_t *root,
344 const char * const *names, int n, lc_opt_err_info_t *err)
346 const lc_opt_entry_t *grp = resolve_up_to_last(root, names, 0, n - 1, err);
347 return lc_opt_find_grp(grp, names[n - 1], err);
350 lc_opt_entry_t *lc_opt_resolve_opt(const lc_opt_entry_t *root,
351 const char * const *names, int n, lc_opt_err_info_t *err)
353 const lc_opt_entry_t *grp = resolve_up_to_last(root, names, 0, n - 1, err);
354 return lc_opt_find_opt(grp, names[n - 1], err);
357 static char *strtolower(char *buf, size_t n, const char *str)
360 for (i = 0; i < n; ++i)
361 buf[i] = tolower(str[i]);
365 int lc_opt_std_cb(UNUSED(const char *name), lc_opt_type_t type, void *data, size_t length, ...)
371 va_start(args, length);
376 case lc_opt_type_bit:
377 integer = va_arg(args, int);
379 *((int *) data) |= length;
381 *((int *) data) &= ~length;
384 case lc_opt_type_negbit:
385 integer = va_arg(args, int);
387 *((int *) data) &= ~length;
389 *((int *) data) |= length;
392 case lc_opt_type_boolean:
393 *((int *) data) = va_arg(args, int);
396 case lc_opt_type_negboolean:
397 *((int *) data) = !va_arg(args, int);
400 case lc_opt_type_string:
401 strncpy((char*)data, va_arg(args, const char *), length);
404 case lc_opt_type_int:
405 *((int *) data) = va_arg(args, int);
408 case lc_opt_type_double:
409 *((double *) data) = va_arg(args, double);
420 int lc_opt_std_dump(char *buf, size_t n, UNUSED(const char *name), lc_opt_type_t type, void *data, UNUSED(size_t length))
426 case lc_opt_type_bit:
427 case lc_opt_type_negbit:
428 res = snprintf(buf, n, "%x", *((unsigned *) data));
430 case lc_opt_type_boolean:
431 case lc_opt_type_negboolean:
432 res = snprintf(buf, n, "%s", *((int *) data) ? "true" : "false");
434 case lc_opt_type_string:
435 strncpy(buf, (const char*)data, n);
438 case lc_opt_type_int:
439 res = snprintf(buf, n, "%d", *((int *) data));
441 case lc_opt_type_double:
442 res = snprintf(buf, n, "%g", *((double *) data));
458 int lc_opt_bool_dump_vals(char *buf, size_t n, UNUSED(const char *name), UNUSED(lc_opt_type_t type), UNUSED(void *data), UNUSED(size_t length))
460 strncpy(buf, "true, false", n);
464 int lc_opt_occurs(lc_opt_entry_t *opt, const char *value, lc_opt_err_info_t *err)
466 static const struct {
481 int error = lc_opt_err_illegal_format;
482 lc_opt_special_t *s = lc_get_opt_special(opt);
487 } val_storage, *val = &val_storage;
490 set_error(err, lc_opt_err_opt_not_found, "");
495 set_error(err, lc_opt_err_no_callback, "");
502 case lc_opt_type_int:
503 if (sscanf(value, "%i", (int *) val)) {
504 error = lc_opt_err_unknown_value;
505 if (s->cb(opt->name, s->type, s->value, s->length, val->integer))
506 error = lc_opt_err_none;
510 case lc_opt_type_double:
511 if (sscanf(value, "%lf", (double *) val)) {
512 error = lc_opt_err_unknown_value;
513 if (s->cb(opt->name, s->type, s->value, s->length, val->dbl))
514 error = lc_opt_err_none;
518 case lc_opt_type_boolean:
519 case lc_opt_type_negboolean:
520 case lc_opt_type_bit:
521 case lc_opt_type_negbit:
522 strtolower(buf, sizeof(buf), value);
523 for (i = 0; i < LC_ARRSIZE(bool_strings); ++i) {
524 if (strcmp(buf, bool_strings[i].str) == 0) {
525 val->integer = bool_strings[i].val;
526 error = lc_opt_err_none;
531 if (error == lc_opt_err_none) {
532 error = lc_opt_err_unknown_value;
533 if (s->cb(opt->name, s->type, s->value, s->length, val->integer))
534 error = lc_opt_err_none;
539 case lc_opt_type_string:
540 case lc_opt_type_enum:
541 error = lc_opt_err_unknown_value;
542 if (s->cb(opt->name, s->type, s->value, s->length, value))
543 error = lc_opt_err_none;
545 case lc_opt_type_invalid:
549 set_error(err, error, value);
550 return error == lc_opt_err_none;
553 char *lc_opt_value_to_string(char *buf, size_t len, const lc_opt_entry_t *ent)
555 const lc_opt_special_t *s = lc_get_opt_special(ent);
557 s->dump(buf, len, ent->name, s->type, s->value, s->length);
559 strncpy(buf, "<n/a>", len);
564 static char *lc_opt_values_to_string(char *buf, size_t len, const lc_opt_entry_t *ent)
566 const lc_opt_special_t *s = lc_get_opt_special(ent);
568 s->dump_vals(buf, len, ent->name, s->type, s->value, s->length);
573 int lc_opt_add_table(lc_opt_entry_t *root, const lc_opt_table_entry_t *table)
576 lc_opt_err_info_t err;
578 for (i = 0; table[i].name != NULL; ++i) {
580 const lc_opt_table_entry_t *tab = &table[i];
581 lc_opt_entry_t *grp = resolve_up_to_last_str(root, tab->name, &name);
583 lc_opt_add_opt(grp, name, tab->desc, tab->type, tab->value, tab->len, tab->cb, tab->dump, tab->dump_vals, &err);
584 if (err.error != lc_opt_err_none)
591 static void lc_opt_print_grp_path_rec(char *buf, size_t len, const lc_opt_entry_t *ent, char separator, lc_opt_entry_t *stop_ent)
595 if (!lc_opt_grp_is_root(ent)) {
597 lc_opt_print_grp_path_rec(buf, len, ent->parent, separator, stop_ent);
599 if (l > 0 && l < len-1) {
605 strncat(buf, ent->name, len-1);
608 static char *lc_opt_print_grp_path(char *buf, size_t len, const lc_opt_entry_t *ent, char separator, lc_opt_entry_t *stop_ent)
612 lc_opt_print_grp_path_rec(buf, len, ent, separator, stop_ent);
617 * dump the option tree.
618 * @param ent starting entity
619 * @param separator separator char
620 * @param stop_ent stop at this entity when dumping the name
621 * @param f output file
623 static void lc_opt_print_help_rec(lc_opt_entry_t *ent, char separator, lc_opt_entry_t *stop_ent, FILE *f)
625 lc_grp_special_t *s = lc_get_grp_special(ent);
631 if (!list_empty(&s->opts)) {
632 lc_opt_print_grp_path(grp_name, sizeof(grp_name), ent, separator, stop_ent);
635 fprintf(f, "%s:\n", grp_name);
637 list_for_each_entry(lc_opt_entry_t, e, &s->opts, list) {
640 lc_opt_value_to_string(value, sizeof(value), e);
641 lc_opt_values_to_string(values, sizeof(values), e);
642 fprintf(f, HELP_TEMPL_VALS "\n", e->name, lc_opt_get_type_name(e), e->desc, value, values);
646 list_for_each_entry(lc_opt_entry_t, e, &s->grps, list) {
647 lc_opt_print_help_rec(e, separator, stop_ent, f);
652 void lc_opt_print_help(lc_opt_entry_t *ent, FILE *f)
654 fprintf(f, HELP_TEMPL_VALS "\n", "option", "type", "description", "default", "possible options");
655 lc_opt_print_help_rec(ent, '.', NULL, f);
658 void lc_opt_print_help_for_entry(lc_opt_entry_t *ent, char separator, FILE *f)
660 fprintf(f, HELP_TEMPL_VALS "\n", "option", "type", "description", "default", "possible options");
661 lc_opt_print_help_rec(ent, separator, ent, f);
665 static void indent(FILE *f, int n)
668 for (i = 0; i < n; ++i)
672 static void lc_opt_print_tree_lc_opt_indent(lc_opt_entry_t *ent, FILE *f, int level)
675 lc_opt_special_t *s = lc_get_opt_special(ent);
678 fprintf(f, "%c%s(\"%s\"):%s = %s\n", s->is_set ? '+' : '-', ent->name,
679 ent->desc, lc_opt_get_type_name(ent), lc_opt_value_to_string(buf, sizeof(buf), ent));
682 static void lc_opt_print_tree_grp_indent(lc_opt_entry_t *ent, FILE *f, int level)
689 s = lc_get_grp_special(ent);
691 fprintf(f, "/%s\n", ent->name);
693 list_for_each_entry(lc_opt_entry_t, e, &s->grps, list) {
694 lc_opt_print_tree_grp_indent(e, f, level + 2);
697 list_for_each_entry(lc_opt_entry_t, e, &s->opts, list) {
698 lc_opt_print_tree_lc_opt_indent(e, f, level + 2);
703 void lc_opt_print_tree(lc_opt_entry_t *ent, FILE *f)
705 lc_opt_print_tree_grp_indent(ent, f, 0);
708 static int lc_opts_default_error_handler(const char *prefix, const lc_opt_err_info_t *err)
710 fprintf(stderr, "%s: %s; %s\n", prefix, err->msg, err->arg);
714 void lc_opt_from_file(const char *filename, FILE *f, lc_opt_error_handler_t *handler)
717 handler = lc_opts_default_error_handler;
719 lc_opt_init_parser(filename, handler);
723 int lc_opt_from_single_arg(const lc_opt_entry_t *root,
724 const char *opt_prefix,
725 const char *arg, lc_opt_error_handler_t *handler)
727 const lc_opt_entry_t *grp = root;
728 size_t n = strlen(arg);
729 size_t n_prefix = opt_prefix ? strlen(opt_prefix) : 0;
733 lc_opt_err_info_t err;
734 const char *end, *eqsign;
736 if (n >= n_prefix && strncmp(opt_prefix, arg, n_prefix) == 0) {
737 arg = arg + n_prefix;
740 * check, if the next character is a @.
741 * This means, that we want to read options
745 size_t n = strcspn(&arg[1], " \t\n");
746 char *fname = (char*)alloca(n + 1);
749 strncpy(fname, &arg[1], n);
750 if ((f = fopen(fname, "rt")) != NULL) {
751 lc_opt_from_file(fname, f, handler);
753 set_error(&err, lc_opt_err_none, NULL);
757 set_error(&err, lc_opt_err_file_not_found, arg);
759 return !lc_opt_raise_error(&err, handler, "Unable to open file: %s", fname);
762 /* find the next delimiter (the -) and extract the string up to
764 end = strchr(arg, OPT_DELIM);
765 eqsign = strchr(arg, '=');
766 if (eqsign && eqsign < end)
768 while (end != NULL) {
770 * Copy the part of the option into the buffer and add the
773 char *buf = (char*)obstack_copy0(&obst, arg, end - arg);
775 /* Resolve the group inside the group */
776 grp = lc_opt_find_grp(grp, buf, &err);
777 error = lc_opt_raise_error(&err, handler, ERR_STRING, arg);
781 /* Find the next option part delimiter. */
783 end = strchr(arg, OPT_DELIM);
784 eqsign = strchr(arg, '=');
785 if (eqsign && eqsign < end)
787 obstack_free(&obst, buf);
795 * Now, we are at the last option part:
796 * --grp1-grp2-...-grpn-opt=value
797 * Check, for the = and evaluate the option string. If the = is
798 * missing, we should have a boolean option, but that is checked
801 end = strchr(arg, '=');
802 buf = (char*)obstack_copy0(&obst, arg, end ? end - arg : (int) strlen(arg));
803 opt = lc_opt_find_opt(grp, buf, &err);
804 error = lc_opt_raise_error(&err, handler, ERR_STRING, arg);
808 * Now evaluate the parameter of the option (the part after
809 * the =) if it was given.
811 arg = end ? end + 1 : "true";
813 /* Set the value of the option. */
814 lc_opt_occurs(opt, arg, &err);
815 ret = !lc_opt_raise_error(&err, handler, ERR_STRING, arg);
823 int lc_opt_from_argv(const lc_opt_entry_t *root,
824 const char *opt_prefix,
825 int argc, const char *argv[],
826 lc_opt_error_handler_t *handler)
832 handler = lc_opts_default_error_handler;
834 for (i = 0; i < argc; ++i) {
835 options_set |= lc_opt_from_single_arg(root, opt_prefix, argv[i], handler);
841 static int opt_arg_type(UNUSED(const lc_arg_occ_t *occ))
843 return lc_arg_type_ptr;
846 static int opt_arg_emit(lc_appendable_t *app, const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
850 lc_opt_entry_t *opt = (lc_opt_entry_t*)arg->v_ptr;
854 switch (occ->conversion) {
856 lc_opt_value_to_string(buf, sizeof(buf), opt);
859 s = lc_opt_get_type_name(opt);
872 res = lc_appendable_snadd(app, s, strlen(s));
877 static const lc_arg_handler_t lc_opt_arg_handler = {
883 /* lc_printf facility for options */
885 const lc_arg_env_t *lc_opt_get_arg_env(void)
887 static lc_arg_env_t *env = NULL;
890 env = lc_arg_new_env();
892 lc_arg_register(env, "opt:value", 'V', &lc_opt_arg_handler);
893 lc_arg_register(env, "opt:type", 'T', &lc_opt_arg_handler);
894 lc_arg_register(env, "opt:desc", 'D', &lc_opt_arg_handler);
895 lc_arg_register(env, "opt:name", 'O', &lc_opt_arg_handler);
901 void lc_opt_default_configs(const char *ini_name)
905 char local_ini_file[MAX_PATH];
906 char home_dir_ini_file[MAX_PATH];
909 strncpy(local_ini_file, ini_name, sizeof(local_ini_file));
910 strncat(local_ini_file, ".ini", sizeof(local_ini_file)-1);
911 local_ini_file[sizeof(local_ini_file) - 1] = '\0';
916 /* ARG: need newer SDK to compile this */
917 SHGetFolderPath(NULL, CSIDL_LOCAL_APPDATA, NULL, 0, path);
918 strncat(path, "\\", sizeof(path)-1);
920 strncpy(home_dir_ini_file, local_ini_file, sizeof(home_dir_ini_file));
921 home_dir_ini_file[sizeof(home_dir_ini_file) - 1] = '\0';
924 struct passwd *entry = getpwuid(getuid());
926 strcpy(path, entry->pw_dir);
927 strncat(path, "/", sizeof(path)-1);
929 snprintf(home_dir_ini_file, sizeof(home_dir_ini_file), ".%src", ini_name);
930 home_dir_ini_file[sizeof(home_dir_ini_file) - 1] = '\0';
932 /* FIXME: some error occurred */
933 home_dir_ini_file[0] = '\0';
938 strncat(path, home_dir_ini_file, sizeof(path)-1);
939 path[sizeof(path) - 1] = '\0';
941 /* Process ini file in user's home. */
942 f = fopen(path, "rt");
944 lc_opt_from_file(path, f, lc_opts_default_error_handler);
948 /* Process ini file in current directory. */
949 f = fopen(local_ini_file, "rt");
951 lc_opt_from_file(local_ini_file, f, lc_opts_default_error_handler);