2 * $Id: rc.c,v 1.45 2010/01/18 10:28:16 tom Exp $
4 * rc.c -- routines for processing the configuration file
6 * Copyright 2000-2008,2010 Thomas E. Dickey
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU Lesser General Public License, version 2.1
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this program; if not, write to
19 * Free Software Foundation, Inc.
20 * 51 Franklin St., Fifth Floor
21 * Boston, MA 02110, USA.
23 * An earlier version of this program lists as authors
24 * Savio Lam (lam836@cs.cuhk.hk)
32 #include <dlg_colors.h>
35 * For matching color names with color values
37 static const color_names_st color_names[] =
39 #ifdef HAVE_USE_DEFAULT_COLORS
42 {"BLACK", COLOR_BLACK},
44 {"GREEN", COLOR_GREEN},
45 {"YELLOW", COLOR_YELLOW},
47 {"MAGENTA", COLOR_MAGENTA},
49 {"WHITE", COLOR_WHITE},
51 #define COLOR_COUNT (sizeof(color_names) / sizeof(color_names[0]))
52 #endif /* HAVE_COLOR */
54 #define GLOBALRC "/etc/dialogrc"
55 #define DIALOGRC ".dialogrc"
62 /* Type of line in configuration file */
69 /* number of configuration variables */
70 #define VAR_COUNT (sizeof(vars) / sizeof(vars_st))
72 /* check if character is white space */
73 #define whitespace(c) (c == ' ' || c == TAB)
75 /* check if character is string quoting characters */
76 #define isquote(c) (c == '"' || c == '\'')
78 /* get last character of string */
79 #define lastch(str) str[strlen(str)-1]
82 * Configuration variables
85 const char *name; /* name of configuration variable as in DIALOGRC */
86 void *var; /* address of actual variable to change */
87 int type; /* type of value */
88 const char *comment; /* comment to put in "rc" file */
92 * This table should contain only references to dialog_state, since dialog_vars
93 * is reset specially in dialog.c before each widget.
95 static const vars_st vars[] =
98 &dialog_state.aspect_ratio,
100 "Set aspect-ration."},
103 &dialog_state.separate_str,
105 "Set separator (for multiple widgets output)."},
108 &dialog_state.tab_len,
110 "Set tab-length (for textbox tab-conversion)."},
113 &dialog_state.visit_items,
115 "Make tab-traversal for checklist, etc., include the list."},
119 &dialog_state.use_shadow,
121 "Shadow dialog boxes? This also turns on color."},
124 &dialog_state.use_colors,
126 "Turn color support ON or OFF"},
127 #endif /* HAVE_COLOR */
131 skip_whitespace(char *str, int n)
133 while (whitespace(str[n]) && str[n] != '\0')
139 skip_keyword(char *str, int n)
141 while (isalnum(UCH(str[n])) && str[n] != '\0')
147 find_vars(char *name)
152 for (i = 0; i < VAR_COUNT; i++) {
153 if (dlg_strcmp(vars[i].name, name) == 0) {
163 find_color(char *name)
167 int limit = dlg_color_count();
169 for (i = 0; i < limit; i++) {
170 if (dlg_strcmp(dlg_color_table[i].name, name) == 0) {
179 * Convert an attribute to a string representation like this:
181 * "(foreground,background,highlight)"
184 attr_to_str(char *str, int fg, int bg, int hl)
190 for (i = 0; fg != color_names[i].value; i++) ;
191 strcat(str, color_names[i].name);
195 for (i = 0; bg != color_names[i].value; i++) ;
196 strcat(str, color_names[i].name);
199 strcat(str, hl ? ",ON)" : ",OFF)");
205 * Extract the foreground, background and highlight values from an attribute
206 * represented as a string in this form:
208 * "(foreground,background,highlight)"
211 str_to_attr(char *str, int *fg, int *bg, int *hl)
213 int i = 0, get_fg = 1;
215 char tempstr[MAX_LEN + 1], *part;
217 if (str[0] != '(' || lastch(str) != ')')
218 return -1; /* invalid representation */
220 /* remove the parenthesis */
221 strcpy(tempstr, str + 1);
222 lastch(tempstr) = '\0';
224 /* get foreground and background */
227 /* skip white space before fg/bg string */
228 i = skip_whitespace(tempstr, i);
229 if (tempstr[i] == '\0')
230 return -1; /* invalid representation */
231 part = tempstr + i; /* set 'part' to start of fg/bg string */
233 /* find end of fg/bg string */
234 while (!whitespace(tempstr[i]) && tempstr[i] != ','
235 && tempstr[i] != '\0')
238 if (tempstr[i] == '\0')
239 return -1; /* invalid representation */
240 else if (whitespace(tempstr[i])) { /* not yet ',' */
243 /* skip white space before ',' */
244 i = skip_whitespace(tempstr, i);
245 if (tempstr[i] != ',')
246 return -1; /* invalid representation */
248 tempstr[i++] = '\0'; /* skip the ',' */
249 for (j = 0; j < COLOR_COUNT && dlg_strcmp(part, color_names[j].name);
251 if (j == COLOR_COUNT) /* invalid color name */
254 *fg = color_names[j].value;
255 get_fg = 0; /* next we have to get the background */
257 *bg = color_names[j].value;
260 } /* got foreground and background */
264 /* skip white space before highlight string */
265 i = skip_whitespace(tempstr, i);
266 if (tempstr[i] == '\0')
267 return -1; /* invalid representation */
268 part = tempstr + i; /* set 'part' to start of highlight string */
270 /* trim trailing white space from highlight string */
271 i = (int) strlen(part) - 1;
272 while (whitespace(part[i]) && i > 0)
276 if (!dlg_strcmp(part, "ON"))
278 else if (!dlg_strcmp(part, "OFF"))
281 return -1; /* invalid highlight value */
285 #endif /* HAVE_COLOR */
288 * Check if the line begins with a special keyword; if so, return true while
289 * pointing params to its parameters.
292 begins_with(char *line, const char *keyword, char **params)
294 int i = skip_whitespace(line, 0);
295 int j = skip_keyword(line, i);
297 if ((j - i) == (int) strlen(keyword)) {
300 if (!dlg_strcmp(keyword, line + i)) {
301 *params = line + skip_whitespace(line, j + 1);
311 * Parse a line in the configuration file
313 * Each line is of the form: "variable = value". On exit, 'var' will contain
314 * the variable name, and 'value' will contain the value string.
318 * LINE_EMPTY - line is blank or comment
319 * LINE_EQUALS - line contains "variable = value"
320 * LINE_ERROR - syntax error in line
323 parse_line(char *line, char **var, char **value)
327 /* ignore white space at beginning of line */
328 i = skip_whitespace(line, i);
330 if (line[i] == '\0') /* line is blank */
332 else if (line[i] == '#') /* line is comment */
334 else if (line[i] == '=') /* variable names cannot start with a '=' */
337 /* set 'var' to variable name */
338 *var = line + i++; /* skip to next character */
340 /* find end of variable name */
341 while (!whitespace(line[i]) && line[i] != '=' && line[i] != '\0')
344 if (line[i] == '\0') /* syntax error */
346 else if (line[i] == '=')
351 /* skip white space before '=' */
352 i = skip_whitespace(line, i);
354 if (line[i] != '=') /* syntax error */
357 i++; /* skip the '=' */
360 /* skip white space after '=' */
361 i = skip_whitespace(line, i);
366 *value = line + i; /* set 'value' to value string */
368 /* trim trailing white space from 'value' */
369 i = (int) strlen(*value) - 1;
370 while (whitespace((*value)[i]) && i > 0)
372 (*value)[i + 1] = '\0';
374 return LINE_EQUALS; /* no syntax error in line */
378 * Create the configuration file
381 dlg_create_rc(const char *filename)
386 if ((rc_file = fopen(filename, "wt")) == NULL)
387 dlg_exiterr("Error opening file for writing in dlg_create_rc().");
389 fprintf(rc_file, "#\n\
390 # Run-time configuration file for dialog\n\
392 # Automatically generated by \"dialog --create-rc <file>\"\n\
395 # Types of values:\n\
397 # Number - <number>\n\
398 # String - \"string\"\n\
399 # Boolean - <ON|OFF>\n"
402 # Attribute - (foreground,background,highlight?)\n"
406 /* Print an entry for each configuration variable */
407 for (i = 0; i < VAR_COUNT; i++) {
408 fprintf(rc_file, "\n# %s\n", vars[i].comment);
409 switch (vars[i].type) {
411 fprintf(rc_file, "%s = %d\n", vars[i].name,
412 *((int *) vars[i].var));
415 fprintf(rc_file, "%s = \"%s\"\n", vars[i].name,
416 (char *) vars[i].var);
419 fprintf(rc_file, "%s = %s\n", vars[i].name,
420 *((bool *) vars[i].var) ? "ON" : "OFF");
425 for (i = 0; i < (unsigned) dlg_color_count(); ++i) {
426 char buffer[MAX_LEN + 1];
428 fprintf(rc_file, "\n# %s\n", dlg_color_table[i].comment);
429 fprintf(rc_file, "%s = %s\n", dlg_color_table[i].name,
431 dlg_color_table[i].fg,
432 dlg_color_table[i].bg,
433 dlg_color_table[i].hilite));
435 #endif /* HAVE_COLOR */
437 dlg_dump_keys(rc_file);
440 (void) fclose(rc_file);
444 * Parse the configuration file and set up variables
452 char str[MAX_LEN + 1];
463 * At startup, dialog determines the settings to use as follows:
465 * a) if the environment variable $DIALOGRC is set, its value determines
466 * the name of the configuration file.
468 * b) if the file in (a) can't be found, use the file $HOME/.dialogrc
469 * as the configuration file.
471 * c) if the file in (b) can't be found, try using the GLOBALRC file.
472 * Usually this will be /etc/dialogrc.
474 * d) if the file in (c) cannot be found, use the compiled-in defaults.
478 if ((tempptr = getenv("DIALOGRC")) != NULL)
479 rc_file = fopen(tempptr, "rt");
481 if (rc_file == NULL) { /* step (a) failed? */
483 if ((tempptr = getenv("HOME")) != NULL
484 && strlen(tempptr) < MAX_LEN - (sizeof(DIALOGRC) + 3)) {
485 if (tempptr[0] == '\0' || lastch(tempptr) == '/')
486 sprintf(str, "%s%s", tempptr, DIALOGRC);
488 sprintf(str, "%s/%s", tempptr, DIALOGRC);
489 rc_file = fopen(str, "rt");
493 if (rc_file == NULL) { /* step (b) failed? */
495 strcpy(str, GLOBALRC);
496 if ((rc_file = fopen(str, "rt")) == NULL)
497 return 0; /* step (c) failed, use default values */
500 /* Scan each line and set variables */
501 while ((result == 0) && (fgets(str, MAX_LEN, rc_file) != NULL)) {
502 dlg_trace_msg("rc:%s\n", str);
503 if (*str == '\0' || lastch(str) != '\n') {
504 /* ignore rest of file if line too long */
505 fprintf(stderr, "\nParse error: line %d of configuration"
506 " file too long.\n", l);
507 result = -1; /* parse aborted */
512 if (begins_with(str, "bindkey", ¶ms)) {
513 dlg_parse_bindkey(params);
516 parse = parse_line(str, &var, &value); /* parse current line */
519 case LINE_EMPTY: /* ignore blank lines and comments */
522 /* search table for matching config variable name */
523 if ((i = find_vars(var)) >= 0) {
524 switch (vars[i].type) {
526 *((int *) vars[i].var) = atoi(value);
529 if (!isquote(value[0]) || !isquote(lastch(value))
530 || strlen(value) < 2) {
531 fprintf(stderr, "\nParse error: string value "
532 "expected at line %d of configuration "
534 result = -1; /* parse aborted */
536 /* remove the (") quotes */
538 lastch(value) = '\0';
539 strcpy((char *) vars[i].var, value);
543 if (!dlg_strcmp(value, "ON"))
544 *((bool *) vars[i].var) = TRUE;
545 else if (!dlg_strcmp(value, "OFF"))
546 *((bool *) vars[i].var) = FALSE;
548 fprintf(stderr, "\nParse error: boolean value "
549 "expected at line %d of configuration "
550 "file (found %s).\n", l, value);
551 result = -1; /* parse aborted */
556 } else if ((i = find_color(var)) >= 0) {
560 if (str_to_attr(value, &fg, &bg, &hl) == -1) {
561 fprintf(stderr, "\nParse error: attribute "
562 "value expected at line %d of configuration "
564 result = -1; /* parse aborted */
566 dlg_color_table[i].fg = fg;
567 dlg_color_table[i].bg = bg;
568 dlg_color_table[i].hilite = hl;
571 #endif /* HAVE_COLOR */
572 fprintf(stderr, "\nParse error: unknown variable "
573 "at line %d of configuration file:\n\t%s\n", l, var);
574 result = -1; /* parse aborted */
578 fprintf(stderr, "\nParse error: syntax error at line %d of "
579 "configuration file.\n", l);
580 result = -1; /* parse aborted */
586 (void) fclose(rc_file);