src/config/opttypes.c

   1 /* Option variables types handlers */
   2
   3 #ifdef HAVE_CONFIG_H
   4 #include "config.h"
   5 #endif
   6
   7 #include <stdio.h>
   8 #include <string.h>
   9
  10 #include "elinks.h"
  11
  12 #include "bfu/dialog.h"
  13 #include "config/options.h"
  14 #include "config/opttypes.h"
  15 #include "intl/charsets.h"
  16 #include "intl/gettext/libintl.h"
  17 #include "util/color.h"
  18 #include "util/conv.h"
  19 #include "util/error.h"
  20 #include "util/memory.h"
  21 #include "util/string.h"
  22
  23
  24 /* Commandline handlers. */
  25
  26 /* TAKE CARE! Remember that your _rd handler can be used for commandline
  27  * parameters as well - probably, you don't want to be so syntactically
  28  * strict, and _ESPECIALLY_ you don't want to move any file pointers ahead,
  29  * since you will parse the commandline _TWO TIMES_! Remember! :-) */
  30 int commandline = 0;
  31
  32 static unsigned char *
  33 gen_cmd(struct option *o, unsigned char ***argv, int *argc)
  34 {
  35         unsigned char *str;
  36         int dummy_line = 0;
  37
  38         if (!*argc) return gettext("Parameter expected");
  39
  40         /* FIXME!! We will modify argv! (maybe) */
  41         commandline = 1;
  42         str = option_types[o->type].read(o, *argv, &dummy_line);
  43         commandline = 0;
  44         if (str) {
  45                 /* We ate parameter */
  46                 (*argv)++; (*argc)--;
  47                 if (option_types[o->type].set(o, str)) {
  48                         mem_free(str);
  49                         return NULL;
  50                 }
  51                 mem_free(str);
  52         }
  53
  54         return gettext("Read error");
  55 }
  56
  57 /* If 0 follows, disable option and eat 0. If 1 follows, enable option and
  58  * eat 1. If anything else follow, enable option and don't eat anything. */
  59 static unsigned char *
  60 bool_cmd(struct option *o, unsigned char ***argv, int *argc)
  61 {
  62         o->value.number = 1;
  63
  64         if (!*argc) return NULL;
  65
  66         /* Argument is empty or longer than 1 char.. */
  67         if (!(*argv)[0][0] || (*argv)[0][1]) return NULL;
  68
  69         switch ((*argv)[0][0]) {
  70                 case '0': o->value.number = 0; break;
  71                 case '1': o->value.number = 1; break;
  72                 default: return NULL;
  73         }
  74
  75         /* We ate parameter */
  76         (*argv)++; (*argc)--;
  77         return NULL;
  78 }
  79
  80 static unsigned char *
  81 exec_cmd(struct option *o, unsigned char ***argv, int *argc)
  82 {
  83         return o->value.command(o, argv, argc);
  84 }
  85
  86
  87 /* Wrappers for OPT_ALIAS. */
  88 /* Note that they can wrap only to config_options now.  I don't think it could be
  89  * a problem, but who knows.. however, changing that will be pretty tricky -
  90  * possibly changing ptr to structure containing target name and pointer to
  91  * options list? --pasky */
  92
  93 static unsigned char *
  94 redir_cmd(struct option *opt, unsigned char ***argv, int *argc)
  95 {
  96         struct option *real = get_opt_rec(config_options, opt->value.string);
  97         unsigned char * ret = NULL;
  98
  99         assertm(real != NULL, "%s aliased to unknown option %s!", opt->name, opt->value.string);
 100         if_assert_failed { return ret; }
 101
 102         if (option_types[real->type].cmdline) {
 103                 ret = option_types[real->type].cmdline(real, argv, argc);
 104                 if ((opt->flags & OPT_ALIAS_NEGATE) && real->type == OPT_BOOL) {
 105                         real->value.number = !real->value.number;
 106                 }
 107         }
 108
 109         return ret;
 110 }
 111
 112 static unsigned char *
 113 redir_rd(struct option *opt, unsigned char **file, int *line)
 114 {
 115         struct option *real = get_opt_rec(config_options, opt->value.string);
 116         unsigned char *ret = NULL;
 117
 118         assertm(real != NULL, "%s aliased to unknown option %s!", opt->name, opt->value.string);
 119         if_assert_failed { return ret; }
 120
 121         if (option_types[real->type].read) {
 122                 ret = option_types[real->type].read(real, file, line);
 123                 if (ret && (opt->flags & OPT_ALIAS_NEGATE) && real->type == OPT_BOOL) {
 124                         *(long *) ret = !*(long *) ret;
 125                 }
 126         }
 127
 128         return ret;
 129 }
 130
 131 static void
 132 redir_wr(struct option *opt, struct string *string)
 133 {
 134         struct option *real = get_opt_rec(config_options, opt->value.string);
 135
 136         assertm(real != NULL, "%s aliased to unknown option %s!", opt->name, opt->value.string);
 137         if_assert_failed { return; }
 138
 139         if (option_types[real->type].write)
 140                 option_types[real->type].write(real, string);
 141 }
 142
 143 static int
 144 redir_set(struct option *opt, unsigned char *str)
 145 {
 146         struct option *real = get_opt_rec(config_options, opt->value.string);
 147         int ret = 0;
 148
 149         assertm(real != NULL, "%s aliased to unknown option %s!", opt->name, opt->value.string);
 150         if_assert_failed { return ret; }
 151
 152         if (option_types[real->type].set) {
 153                 long negated;
 154
 155                 if ((opt->flags & OPT_ALIAS_NEGATE) && real->type == OPT_BOOL) {
 156                         negated = !*(long *) str;
 157                         str = (unsigned char *) &negated;
 158                 }
 159                 ret = option_types[real->type].set(real, str);
 160         }
 161
 162         return ret;
 163 }
 164
 165
 166
 167 /* Support functions for config file parsing. */
 168
 169 static void
 170 add_optstring_to_string(struct string *s, const unsigned char *q, int qlen)
 171 {
 172         if (!commandline) add_char_to_string(s, '"');
 173         add_quoted_to_string(s, q, qlen);
 174         if (!commandline) add_char_to_string(s, '"');
 175 }
 176
 177 /* Config file handlers. */
 178
 179 static unsigned char *
 180 num_rd(struct option *opt, unsigned char **file, int *line)
 181 {
 182         unsigned char *end = *file;
 183         long *value = mem_alloc(sizeof(*value));
 184
 185         if (!value) return NULL;
 186
 187         /* We don't want to move file if (commandline), but strtolx() second
 188          * parameter must not be NULL. */
 189         *value = strtolx(*file, &end);
 190         if (!commandline) *file = end;
 191
 192         /* Another trap for unwary - we need to check *end, not **file - reason
 193          * is left as an exercise to the reader. */
 194         if ((*end != 0 && (commandline || (!isspace(*end) && *end != '#')))
 195             || (*value < opt->min || *value > opt->max)) {
 196                 mem_free(value);
 197                 return NULL;
 198         }
 199
 200         return (unsigned char *) value;
 201 }
 202
 203 static int
 204 num_set(struct option *opt, unsigned char *str)
 205 {
 206         opt->value.number = *((long *) str);
 207         return 1;
 208 }
 209
 210 static void
 211 num_wr(struct option *option, struct string *string)
 212 {
 213         add_knum_to_string(string, option->value.number);
 214 }
 215
 216
 217 static int
 218 long_set(struct option *opt, unsigned char *str)
 219 {
 220         opt->value.big_number = *((long *) str);
 221         return 1;
 222 }
 223
 224 static void
 225 long_wr(struct option *option, struct string *string)
 226 {
 227         add_knum_to_string(string, option->value.big_number);
 228 }
 229
 230 static unsigned char *
 231 str_rd(struct option *opt, unsigned char **file, int *line)
 232 {
 233         unsigned char *str = *file;
 234         struct string str2;
 235
 236         if (!init_string(&str2)) return NULL;
 237
 238         /* We're getting used in some parser functions in conf.c as well, and
 239          * that's w/ opt == NULL; so don't rely on opt to point anywhere. */
 240         if (!commandline) {
 241                 if (!isquote(*str)) {
 242                         done_string(&str2);
 243                         return NULL;
 244                 }
 245                 str++;
 246         }
 247
 248         while (*str && (commandline || !isquote(*str))) {
 249                 if (*str == '\\') {
 250                         /* FIXME: This won't work on crlf systems. */
 251                         if (str[1] == '\n') { str[1] = ' '; str++; }
 252                         /* When there's quote char, we will just move on there,
 253                          * thus we will never test for it in while () condition
 254                          * and we will treat it just as '"', ignoring the
 255                          * backslash itself. */
 256                         else if (isquote(str[1])) str++;
 257                         /* \\ means \. */
 258                         else if (str[1] == '\\') str++;
 259                 }
 260
 261                 if (*str == '\n') (*line)++;
 262
 263                 add_char_to_string(&str2, *str);
 264                 str++;
 265         }
 266
 267         if (!commandline && !*str) {
 268                 done_string(&str2);
 269                 *file = str;
 270                 return NULL;
 271         }
 272
 273         str++; /* Skip the quote. */
 274         if (!commandline) *file = str;
 275
 276         if (opt && opt->max && str2.length >= opt->max) {
 277                 done_string(&str2);
 278                 return NULL;
 279         }
 280
 281         return str2.source;
 282 }
 283
 284 static int
 285 str_set(struct option *opt, unsigned char *str)
 286 {
 287         assert(opt->value.string);
 288
 289         safe_strncpy(opt->value.string, str, MAX_STR_LEN);
 290         return 1;
 291 }
 292
 293 static void
 294 str_wr(struct option *o, struct string *s)
 295 {
 296         int len = strlen(o->value.string);
 297
 298         int_upper_bound(&len, o->max - 1);
 299         add_optstring_to_string(s, o->value.string, len);
 300 }
 301
 302 static void
 303 str_dup(struct option *opt, struct option *template)
 304 {
 305         unsigned char *new = mem_alloc(MAX_STR_LEN);
 306
 307         if (new) safe_strncpy(new, template->value.string, MAX_STR_LEN);
 308         opt->value.string = new;
 309 }
 310
 311
 312 static int
 313 cp_set(struct option *opt, unsigned char *str)
 314 {
 315         int ret = get_cp_index(str);
 316
 317         if (ret < 0) return 0;
 318
 319         opt->value.number = ret;
 320         return 1;
 321 }
 322
 323 static void
 324 cp_wr(struct option *o, struct string *s)
 325 {
 326         unsigned char *mime_name = get_cp_config_name(o->value.number);
 327
 328         add_optstring_to_string(s, mime_name, strlen(mime_name));
 329 }
 330
 331
 332 static int
 333 lang_set(struct option *opt, unsigned char *str)
 334 {
 335 #ifdef CONFIG_NLS
 336         opt->value.number = name_to_language(str);
 337         set_language(opt->value.number);
 338 #endif
 339         return 1;
 340 }
 341
 342 static void
 343 lang_wr(struct option *o, struct string *s)
 344 {
 345         unsigned char *lang;
 346
 347 #ifdef CONFIG_NLS
 348         lang = language_to_name(current_language);
 349 #else
 350         lang = "System";
 351 #endif
 352
 353         add_optstring_to_string(s, lang, strlen(lang));
 354 }
 355
 356
 357 static int
 358 color_set(struct option *opt, unsigned char *str)
 359 {
 360         return !decode_color(str, strlen(str), &opt->value.color);
 361 }
 362
 363 static void
 364 color_wr(struct option *opt, struct string *str)
 365 {
 366         color_T color = opt->value.color;
 367         unsigned char hexcolor[8];
 368         const unsigned char *strcolor = get_color_string(color, hexcolor);
 369
 370         add_optstring_to_string(str, strcolor, strlen(strcolor));
 371 }
 372
 373 static void
 374 tree_dup(struct option *opt, struct option *template)
 375 {
 376         LIST_OF(struct option) *new = init_options_tree();
 377         LIST_OF(struct option) *tree = template->value.tree;
 378         struct option *option;
 379
 380         if (!new) return;
 381         opt->value.tree = new;
 382
 383         foreachback (option, *tree) {
 384                 struct option *new_opt = copy_option(option);
 385
 386                 if (!new_opt) continue;
 387                 object_nolock(new_opt, "option");
 388                 add_to_list_end(*new, new_opt);
 389                 new_opt->root = opt;
 390
 391                 if (!new_opt->box_item) continue;
 392
 393                 if (new_opt->name && !strcmp(new_opt->name, "_template_"))
 394                         new_opt->box_item->visible = get_opt_bool("config.show_template");
 395
 396                 if (opt->box_item) {
 397                         add_to_list(opt->box_item->child,
 398                                     new_opt->box_item);
 399                 }
 400         }
 401 }
 402
 403 const struct option_type_info option_types[] = {
 404         /* The OPT_ comments below are here to be found by grep.  */
 405
 406         /* OPT_BOOL */
 407         { N_("Boolean"),  bool_cmd,  num_rd,   num_wr,   NULL,     num_set,   N_("[0|1]") },
 408         /* OPT_INT */
 409         { N_("Integer"),  gen_cmd,   num_rd,   num_wr,   NULL,     num_set,   N_("<num>") },
 410         /* OPT_LONG */
 411         { N_("Longint"),  gen_cmd,   num_rd,   long_wr,  NULL,     long_set,  N_("<num>") },
 412         /* OPT_STRING */
 413         { N_("String"),   gen_cmd,   str_rd,   str_wr,   str_dup,  str_set,   N_("<str>") },
 414
 415         /* OPT_CODEPAGE */
 416         { N_("Codepage"), gen_cmd,   str_rd,   cp_wr,    NULL,     cp_set,    N_("<codepage>") },
 417         /* OPT_LANGUAGE */
 418         { N_("Language"), gen_cmd,   str_rd,   lang_wr,  NULL,     lang_set,  N_("<language>") },
 419         /* OPT_COLOR */
 420         { N_("Color"),    gen_cmd,   str_rd,   color_wr, NULL,     color_set, N_("<color|#rrggbb>") },
 421
 422         /* OPT_COMMAND */
 423         { N_("Special"),  exec_cmd,  NULL,     NULL,     NULL,     NULL,      "" },
 424
 425         /* OPT_ALIAS */
 426         { N_("Alias"),    redir_cmd, redir_rd, redir_wr, NULL,     redir_set, "" },
 427
 428         /* OPT_TREE */
 429         { N_("Folder"),   NULL,      NULL,     NULL,     tree_dup, NULL,      "" },
 430 };
 431
 432 unsigned char *
 433 get_option_type_name(enum option_type type)
 434 {
 435         assert(type >= 0 && type < sizeof(option_types)/sizeof(struct option_type_info));
 436         if_assert_failed return "";
 437
 438         return option_types[type].name;
 439 }