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 = obstack_finish(&obst);
116 obstack_grow0(&obst, desc, strlen(desc));
117 copied_desc = 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);
217 lc_opt_entry_t *lc_opt_find_grp(const lc_opt_entry_t *grp, const char *name, lc_opt_err_info_t *err);
218 lc_opt_entry_t *lc_opt_find_opt(const lc_opt_entry_t *grp, const char *name, lc_opt_err_info_t *err);
220 lc_opt_entry_t *lc_opt_get_grp(lc_opt_entry_t *parent, const char *name)
222 lc_opt_entry_t *ent = lc_opt_find_grp(parent, name, NULL);
225 ent = OALLOC(&obst, lc_opt_entry_t);
226 init_entry(ent, parent, name, "");
233 lc_opt_entry_t *lc_opt_add_opt(lc_opt_entry_t *parent,
234 const char *name, const char *desc,
235 lc_opt_type_t type, void *value, size_t length,
236 lc_opt_callback_t *cb, lc_opt_dump_t *dump,
237 lc_opt_dump_vals_t *dump_vals,
238 lc_opt_err_info_t *err)
240 lc_opt_entry_t *res = NULL;
243 lc_opt_entry_t *ent = lc_opt_find_opt(parent, name, NULL);
246 res = OALLOC(&obst, lc_opt_entry_t);
247 init_entry(res, parent, name, desc);
248 init_opt(res, type, value, length, cb, dump, dump_vals, err);
250 set_error(err, lc_opt_err_opt_already_there, name);
252 set_error(err, lc_opt_err_grp_expected, name);
258 static lc_opt_entry_t *lc_opt_find_ent(const struct list_head *head, const char *name,
259 int error_to_use, lc_opt_err_info_t *err)
261 lc_opt_entry_t *ent, *found = NULL;
262 int error = error_to_use;
263 unsigned hash = HASH_STR(name, strlen(name));
265 if(!list_empty(head)) {
266 list_for_each_entry(lc_opt_entry_t, ent, head, list) {
267 if(entry_matches(ent, hash, name)) {
268 error = lc_opt_err_none;
275 set_error(err, error, name);
279 lc_opt_entry_t *lc_opt_find_grp(const lc_opt_entry_t *grp, const char *name, lc_opt_err_info_t *err)
281 return grp ? lc_opt_find_ent(&lc_get_grp_special(grp)->grps,
282 name, lc_opt_err_grp_not_found, err) : NULL;
285 lc_opt_entry_t *lc_opt_find_opt(const lc_opt_entry_t *grp, const char *name, lc_opt_err_info_t *err)
287 return grp ? lc_opt_find_ent(&lc_get_grp_special(grp)->opts,
288 name, lc_opt_err_opt_not_found, err) : NULL;
291 static const lc_opt_entry_t *resolve_up_to_last(const lc_opt_entry_t *root,
292 const char * const *names, int pos, int n, lc_opt_err_info_t *err)
299 ent = lc_opt_find_grp(root, names[pos], err);
300 return ent ? resolve_up_to_last(ent, names, pos + 1, n, err) : NULL;
303 static const char *path_delim = "/.";
305 static lc_opt_entry_t *resolve_up_to_last_str_rec(lc_opt_entry_t *from,
307 const char **last_name)
310 lc_opt_entry_t *res = from;
311 size_t end = strcspn(path, path_delim);
313 if(path[end] != '\0') {
314 /* skip all delimiters */
315 size_t next = strspn(path + end, path_delim);
317 /* copy the part of the path into a buffer */
318 char *buf = malloc((end+1) * sizeof(buf[0]));
319 strncpy(buf, path, end);
322 /* resolve the group and free */
323 from = lc_opt_get_grp(from, buf);
326 res = resolve_up_to_last_str_rec(from, path + end + next, last_name);
329 else if(last_name != NULL) {
336 static lc_opt_entry_t *resolve_up_to_last_str(lc_opt_entry_t *root, const char *path, const char **last_name)
338 size_t next = strspn(path, path_delim);
340 /* if l != 0 we saw deliminators, so we resolve from the root */
342 root = lc_opt_root_grp();
344 return resolve_up_to_last_str_rec(root, path + next, last_name);
347 lc_opt_entry_t *lc_opt_resolve_grp(const lc_opt_entry_t *root,
348 const char * const *names, int n, lc_opt_err_info_t *err)
350 const lc_opt_entry_t *grp = resolve_up_to_last(root, names, 0, n - 1, err);
351 return lc_opt_find_grp(grp, names[n - 1], err);
354 lc_opt_entry_t *lc_opt_resolve_opt(const lc_opt_entry_t *root,
355 const char * const *names, int n, lc_opt_err_info_t *err)
357 const lc_opt_entry_t *grp = resolve_up_to_last(root, names, 0, n - 1, err);
358 return lc_opt_find_opt(grp, names[n - 1], err);
361 static char *strtolower(char *buf, size_t n, const char *str)
364 for(i = 0; i < n; ++i)
365 buf[i] = tolower(str[i]);
369 int lc_opt_std_cb(UNUSED(const char *name), lc_opt_type_t type, void *data, size_t length, ...)
375 va_start(args, length);
380 case lc_opt_type_bit:
381 integer = va_arg(args, int);
383 *((int *) data) |= length;
385 *((int *) data) &= ~length;
388 case lc_opt_type_negbit:
389 integer = va_arg(args, int);
391 *((int *) data) &= ~length;
393 *((int *) data) |= length;
396 case lc_opt_type_boolean:
397 *((int *) data) = va_arg(args, int);
400 case lc_opt_type_negboolean:
401 *((int *) data) = !va_arg(args, int);
404 case lc_opt_type_string:
405 strncpy(data, va_arg(args, const char *), length);
408 case lc_opt_type_int:
409 *((int *) data) = va_arg(args, int);
412 case lc_opt_type_double:
413 *((double *) data) = va_arg(args, double);
424 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))
430 case lc_opt_type_bit:
431 case lc_opt_type_negbit:
432 res = snprintf(buf, n, "%x", *((int *) data));
434 case lc_opt_type_boolean:
435 case lc_opt_type_negboolean:
436 res = snprintf(buf, n, "%s", *((int *) data) ? "true" : "false");
438 case lc_opt_type_string:
439 strncpy(buf, data, n);
442 case lc_opt_type_int:
443 res = snprintf(buf, n, "%d", *((int *) data));
445 case lc_opt_type_double:
446 res = snprintf(buf, n, "%g", *((double *) data));
462 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))
464 strncpy(buf, "true, false", n);
468 int lc_opt_occurs(lc_opt_entry_t *opt, const char *value, lc_opt_err_info_t *err)
470 static const struct {
485 int error = lc_opt_err_illegal_format;
486 lc_opt_special_t *s = lc_get_opt_special(opt);
491 } val_storage, *val = &val_storage;
494 set_error(err, lc_opt_err_opt_not_found, "");
499 set_error(err, lc_opt_err_no_callback, "");
506 case lc_opt_type_int:
507 if(sscanf(value, "%i", (int *) val)) {
508 error = lc_opt_err_unknown_value;
509 if (s->cb(opt->name, s->type, s->value, s->length, val->integer))
510 error = lc_opt_err_none;
514 case lc_opt_type_double:
515 if(sscanf(value, "%lf", (double *) val)) {
516 error = lc_opt_err_unknown_value;
517 if (s->cb(opt->name, s->type, s->value, s->length, val->dbl))
518 error = lc_opt_err_none;
522 case lc_opt_type_boolean:
523 case lc_opt_type_negboolean:
524 case lc_opt_type_bit:
525 case lc_opt_type_negbit:
526 strtolower(buf, sizeof(buf), value);
527 for(i = 0; i < LC_ARRSIZE(bool_strings); ++i) {
528 if(strcmp(buf, bool_strings[i].str) == 0) {
529 val->integer = bool_strings[i].val;
530 error = lc_opt_err_none;
535 if (error == lc_opt_err_none) {
536 error = lc_opt_err_unknown_value;
537 if (s->cb(opt->name, s->type, s->value, s->length, val->integer))
538 error = lc_opt_err_none;
543 case lc_opt_type_string:
544 case lc_opt_type_enum:
545 error = lc_opt_err_unknown_value;
546 if (s->cb(opt->name, s->type, s->value, s->length, value))
547 error = lc_opt_err_none;
551 set_error(err, error, value);
552 return error == lc_opt_err_none;
555 char *lc_opt_value_to_string(char *buf, size_t len, const lc_opt_entry_t *ent)
557 const lc_opt_special_t *s = lc_get_opt_special(ent);
559 s->dump(buf, len, ent->name, s->type, s->value, s->length);
561 strncpy(buf, "<n/a>", len);
566 char *lc_opt_values_to_string(char *buf, size_t len, const lc_opt_entry_t *ent)
568 const lc_opt_special_t *s = lc_get_opt_special(ent);
570 s->dump_vals(buf, len, ent->name, s->type, s->value, s->length);
575 static lc_opt_entry_t *resolve_up_to_last_str(lc_opt_entry_t *root, const char *path, const char **last_name);
577 int lc_opt_add_table(lc_opt_entry_t *root, const lc_opt_table_entry_t *table)
580 lc_opt_err_info_t err;
582 for(i = 0; table[i].name != NULL; ++i) {
584 const lc_opt_table_entry_t *tab = &table[i];
585 lc_opt_entry_t *grp = resolve_up_to_last_str(root, tab->name, &name);
587 lc_opt_add_opt(grp, name, tab->desc, tab->type, tab->value, tab->len, tab->cb, tab->dump, tab->dump_vals, &err);
588 if(err.error != lc_opt_err_none)
595 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)
599 if (!lc_opt_grp_is_root(ent)) {
601 lc_opt_print_grp_path_rec(buf, len, ent->parent, separator, stop_ent);
603 if (l > 0 && l < len-1) {
609 strncat(buf, ent->name, len);
612 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)
616 lc_opt_print_grp_path_rec(buf, len, ent, separator, stop_ent);
621 * dump the option tree.
622 * @param ent starting entity
623 * @param separator separator char
624 * @param stop_ent stop at this entity when dumping the name
625 * @param f output file
627 static void lc_opt_print_help_rec(lc_opt_entry_t *ent, char separator, lc_opt_entry_t *stop_ent, FILE *f)
629 lc_grp_special_t *s = lc_get_grp_special(ent);
635 if(!list_empty(&s->opts)) {
636 lc_opt_print_grp_path(grp_name, sizeof(grp_name), ent, separator, stop_ent);
639 fprintf(f, "%s:\n", grp_name);
641 list_for_each_entry(lc_opt_entry_t, e, &s->opts, list) {
644 lc_opt_value_to_string(value, sizeof(value), e);
645 lc_opt_values_to_string(values, sizeof(values), e);
646 fprintf(f, HELP_TEMPL_VALS "\n", e->name, lc_opt_get_type_name(e), e->desc, value, values);
650 list_for_each_entry(lc_opt_entry_t, e, &s->grps, list) {
651 lc_opt_print_help_rec(e, separator, stop_ent, f);
656 void lc_opt_print_help(lc_opt_entry_t *ent, FILE *f)
658 fprintf(f, HELP_TEMPL_VALS "\n", "option", "type", "description", "default", "possible options");
659 lc_opt_print_help_rec(ent, '.', NULL, f);
662 void lc_opt_print_help_for_entry(lc_opt_entry_t *ent, char separator, FILE *f)
664 fprintf(f, HELP_TEMPL_VALS "\n", "option", "type", "description", "default", "possible options");
665 lc_opt_print_help_rec(ent, separator, ent, f);
669 static void indent(FILE *f, int n)
672 for(i = 0; i < n; ++i)
676 static void lc_opt_print_tree_lc_opt_indent(lc_opt_entry_t *ent, FILE *f, int level)
679 lc_opt_special_t *s = lc_get_opt_special(ent);
682 fprintf(f, "%c%s(\"%s\"):%s = %s\n", s->is_set ? '+' : '-', ent->name,
683 ent->desc, lc_opt_get_type_name(ent), lc_opt_value_to_string(buf, sizeof(buf), ent));
686 static void lc_opt_print_tree_grp_indent(lc_opt_entry_t *ent, FILE *f, int level)
693 s = lc_get_grp_special(ent);
695 fprintf(f, "/%s\n", ent->name);
697 list_for_each_entry(lc_opt_entry_t, e, &s->grps, list) {
698 lc_opt_print_tree_grp_indent(e, f, level + 2);
701 list_for_each_entry(lc_opt_entry_t, e, &s->opts, list) {
702 lc_opt_print_tree_lc_opt_indent(e, f, level + 2);
707 void lc_opt_print_tree(lc_opt_entry_t *ent, FILE *f)
709 lc_opt_print_tree_grp_indent(ent, f, 0);
712 static int lc_opts_default_error_handler(const char *prefix, const lc_opt_err_info_t *err)
714 fprintf(stderr, "%s: %s; %s\n", prefix, err->msg, err->arg);
718 void lc_opt_from_file(const char *filename, FILE *f, lc_opt_error_handler_t *handler)
721 handler = lc_opts_default_error_handler;
723 lc_opt_init_parser(filename, handler);
727 int lc_opt_from_single_arg(const lc_opt_entry_t *root,
728 const char *opt_prefix,
729 const char *arg, lc_opt_error_handler_t *handler)
731 const lc_opt_entry_t *grp = root;
733 int n_prefix = opt_prefix ? strlen(opt_prefix) : 0;
737 lc_opt_err_info_t err;
738 char *end, *buf, *eqsign;
740 if(n >= n_prefix && strncmp(opt_prefix, arg, n_prefix) == 0) {
741 arg = arg + n_prefix;
744 * check, if the next character is a @.
745 * This means, that we want to read options
749 size_t n = strcspn(&arg[1], " \t\n");
750 char *fname = alloca(n + 1);
753 strncpy(fname, &arg[1], n);
754 if((f = fopen(fname, "rt")) != NULL) {
755 lc_opt_from_file(fname, f, handler);
757 set_error(&err, lc_opt_err_none, NULL);
761 set_error(&err, lc_opt_err_file_not_found, arg);
763 return !lc_opt_raise_error(&err, handler, "Unable to open file: %s", fname);
766 /* find the next delimiter (the -) and extract the string up to
768 end = strchr(arg, OPT_DELIM);
769 eqsign = strchr(arg, '=');
770 if (eqsign && eqsign < end)
774 * Copy the part of the option into the buffer and add the
777 buf = obstack_copy0(&obst, arg, end - arg);
779 /* Resolve the group inside the group */
780 grp = lc_opt_find_grp(grp, buf, &err);
781 error = lc_opt_raise_error(&err, handler, ERR_STRING, arg);
785 /* Find the next option part delimiter. */
787 end = strchr(arg, OPT_DELIM);
788 eqsign = strchr(arg, '=');
789 if (eqsign && eqsign < end)
791 obstack_free(&obst, buf);
798 * Now, we are at the last option part:
799 * --grp1-grp2-...-grpn-opt=value
800 * Check, for the = and evaluate the option string. If the = is
801 * missing, we should have a boolean option, but that is checked
804 end = strchr(arg, '=');
805 buf = obstack_copy0(&obst, arg, end ? end - arg : (int) strlen(arg));
806 opt = lc_opt_find_opt(grp, buf, &err);
807 error = lc_opt_raise_error(&err, handler, ERR_STRING, arg);
811 * Now evaluate the parameter of the option (the part after
812 * the =) if it was given.
814 arg = end ? end + 1 : "true";
816 /* Set the value of the option. */
817 lc_opt_occurs(opt, arg, &err);
818 ret = !lc_opt_raise_error(&err, handler, ERR_STRING, arg);
826 int lc_opt_from_argv(const lc_opt_entry_t *root,
827 const char *opt_prefix,
828 int argc, const char *argv[],
829 lc_opt_error_handler_t *handler)
835 handler = lc_opts_default_error_handler;
837 for(i = 0; i < argc; ++i) {
838 options_set |= lc_opt_from_single_arg(root, opt_prefix, argv[i], handler);
844 static int opt_arg_type(UNUSED(const lc_arg_occ_t *occ))
846 return lc_arg_type_ptr;
849 static int opt_arg_emit(lc_appendable_t *app, const lc_arg_occ_t *occ, const lc_arg_value_t *arg)
853 lc_opt_entry_t *opt = arg->v_ptr;
857 switch(occ->conversion) {
859 lc_opt_value_to_string(buf, sizeof(buf), opt);
862 s = lc_opt_get_type_name(opt);
875 res = lc_appendable_snadd(app, s, strlen(s));
880 static const lc_arg_handler_t lc_opt_arg_handler = {
886 /* lc_printf facility for options */
888 const lc_arg_env_t *lc_opt_get_arg_env(void)
890 static lc_arg_env_t *env = NULL;
893 env = lc_arg_new_env();
895 lc_arg_register(env, "opt:value", 'V', &lc_opt_arg_handler);
896 lc_arg_register(env, "opt:type", 'T', &lc_opt_arg_handler);
897 lc_arg_register(env, "opt:desc", 'D', &lc_opt_arg_handler);
898 lc_arg_register(env, "opt:name", 'O', &lc_opt_arg_handler);
904 void lc_opt_default_configs(const char *ini_name)
908 char local_ini_file[MAX_PATH];
909 char home_dir_ini_file[MAX_PATH];
912 strncpy(local_ini_file, ini_name, sizeof(local_ini_file));
913 strncat(local_ini_file, ".ini", sizeof(local_ini_file));
914 local_ini_file[sizeof(local_ini_file) - 1] = '\0';
919 /* ARG: need newer SDK to compile this */
920 SHGetFolderPath(NULL, CSIDL_LOCAL_APPDATA, NULL, 0, path);
921 strncat(path, "\\", sizeof(path));
923 strncpy(home_dir_ini_file, local_ini_file, sizeof(home_dir_ini_file));
924 home_dir_ini_file[sizeof(home_dir_ini_file) - 1] = '\0';
927 struct passwd *entry = getpwuid(getuid());
929 strcpy(path, entry->pw_dir);
930 strncat(path, "/", sizeof(path));
932 snprintf(home_dir_ini_file, sizeof(home_dir_ini_file), ".%src", ini_name);
933 home_dir_ini_file[sizeof(home_dir_ini_file) - 1] = '\0';
935 /* FIXME: some error occurred */
936 home_dir_ini_file[0] = '\0';
941 strncat(path, home_dir_ini_file, sizeof(path));
942 path[sizeof(path) - 1] = '\0';
944 /* Process ini file in user's home. */
945 f = fopen(path, "rt");
947 lc_opt_from_file(path, f, lc_opts_default_error_handler);
951 /* Process ini file in current directory. */
952 f = fopen(local_ini_file, "rt");
954 lc_opt_from_file(local_ini_file, f, lc_opts_default_error_handler);