1 /* src/client/interface_conf.c */
3 #define _POSIX_C_SOURCE 200809L /* getopt(), optarg, strdup() */
4 #include "interface_conf.h"
5 #include <ncurses.h> /* delwin() */
6 #include <stddef.h> /* NULL, size_t */
7 #include <stdint.h> /* UINT8_MAX, uint8_t, uint32_t */
8 #include <stdlib.h> /* EXIT_SUCCESS, atoi(), exit(), free() */
9 #include <stdio.h> /* FILE, sprintf() */
10 #include <string.h> /* strchr(), strcmp(), strdup(), strlen() */
11 #include <unistd.h> /* optarg, getopt() */
12 #include "../common/parse_file.h" /* token_from_line(),parsetset_singlechar() */
13 #include "../common/readwrite.h" /* atomic_write_start(), atomic_write_finish(),
14 * detect_atomic_leftover(), try_fwrite()
16 #include "../common/rexit.h" /* exit_err(), exit_trouble() */
17 #include "../common/try_malloc.h" /* try_malloc() */
18 #include "array_append.h" /* array_append() */
19 #include "cleanup.h" /* set_cleanup_flag() */
20 #include "command_db.h" /* get_command() */
21 #include "keybindings.h" /* KeyBinding, KeyBindingDB, get_command_to_keycode()*/
22 #include "map.h" /* map_center() */
23 #include "parse.h" /* EDIT_STARTED, parse_file(), parse_flagval(),
24 * parse_and_reduce_to_readyflag(), parse_id_uniq()
25 * parsetest_defcontext(), parse_unknown_arg(),
26 * parsetest_too_many_values(), parse_init_entry()
28 #include "wincontrol.h" /* toggle_window() */
29 #include "windows.h" /* Win, free_winDB(), make_v_screen_and_init_win_sizes() */
30 #include "world.h" /* global world */
34 /* Editing state flags set / checked in tokens_into_entries(). */
42 READY_WIN = NAME_SET | WIDTH_SET | HEIGHT_SET | BREAK_SET,
49 /* Used in load_interface_conf() to temporarily store designated values for
50 * world.winDB.order and world.winDB.active. If those were set right away
51 * without all windows having already been initialized, orderly exits on error
52 * would be impossible, for windows are cleaned out by working toggling them off
53 * piece by peice following these values in unload_interfac_conf().
55 static char * tmp_order;
56 static char tmp_active;
60 /* Write into "file" keybindings in "kbdb" in config file format. */
61 static void write_keybindings(FILE * file, struct KeyBindingDB * kbdb);
63 /* Write into file "val" interpreted as pointing either to string (type = 's'),
64 * int16 ('i') or char ('c'), prefixed with "prefix" and put into single quotes
67 static void write_def(FILE * file, char * prefix, uint8_t quotes, char * val,
70 /* Read in "token0" and "token1" as interface config definition lines, apply
71 * definitions to WinDB, KeyBindingsDBs and tmp_order/tmp_active. If argument is
72 * "KEY", get third token via token_from_line() for complete keybinding.
74 static void tokens_into_entries(char * token0, char * token1);
76 /* If "win" points to non-NULL Win struct, append to it to WinDB.wins array and
77 * add its ID to world.winDB.ids.
79 static void write_if_win(struct Win ** win);
81 /* Start block setting data for window "token1" id if "token0" == "str_win".*/
82 static uint8_t start_win(char * token0, char * token1, char * str_win,
83 uint8_t * win_flags, struct Win ** win);
85 /* Start block setting window order and focus if "token0" = "str_ord".
86 * "tmp_order" stores the designated world.winDB.order string (only later to
87 * be realized in load_interface_conf() when all windows have been initialized),
88 * as does "tmp_active" for the designated world.winDB.active char, defaulting
89 * to the first char in the window order string if not otherwise specified.
91 static uint8_t start_ord(char * token0, char * token1, char * str_ord,
94 /* Start block setting non-window-specific keybindings if "token0" == "str_kbd".
95 * "token1" must be "global", "wingeom" or "winkeys" to set KeyBindingDB to edit
96 * ("kbdb") to world.kb_global, world.kb_wingeom or world.kb_winkeys.
98 static uint8_t start_kbd(char * token0, char * token1, char * str_kbd,
99 uint8_t * kbd_flags, struct KeyBindingDB ** kbdb);
101 /* Helper to tokens_into_entries(), sets specific entry member data. "token0"
102 * and the state of flags determine what entry member to edit; "win" and "kbdb"
103 * are entries to write "token1" data into (as is the global "tmp_active"). If
104 * "token0" is "str_key", a keybinding is defined and "token2" is read/must not
105 * be NULL. In that case, the line read is checked against having a 4th token.
107 static uint8_t set_members(char * token0, char * token1, uint8_t * win_flags,
108 uint8_t * ord_flags,uint8_t kbd_flags,char * str_key,
109 struct Win * win, struct KeyBindingDB * kbdb);
111 /* Add keybinding defined in "token1" as keycode and "token2" as command to
112 * "kbdb" if "flags" are set to EDIT_STARTED.
114 static void set_keybindings(char * token1, uint8_t flags,
115 struct KeyBindingDB * kbdb);
119 static void write_keybindings(FILE * file, struct KeyBindingDB * kbdb)
121 char * f_name = "write_keybindings()";
125 for (i_kb = 0; i_kb < kbdb->n_of_kbs; i_kb++)
127 size_t size = strlen(tok0) + strlen(sep) + 3 + strlen(sep)
128 + strlen(kbdb->kbs[i_kb].command->dsc_short) + 1 + 1;
129 char * line = try_malloc(size, f_name);
130 int test = snprintf(line, size, "%s%s%d%s%s\n",
131 tok0, sep, kbdb->kbs[i_kb].keycode, sep,
132 kbdb->kbs[i_kb].command->dsc_short);
133 exit_trouble(test < 0, f_name, "snprintf()");
134 try_fwrite(line, sizeof(char), strlen(line), file, f_name);
141 static void write_def(FILE * file, char * prefix, uint8_t quotes, char * val,
144 char * f_name = "write_def()";
145 char * val_str = NULL;
146 int test_val_str = 1;
149 val_str = strdup(val);
153 size_t size_val_str = 6 + 1;
154 val_str = try_malloc(size_val_str, f_name);
155 test_val_str = snprintf(val_str, size_val_str, "%d", (int16_t) *val);
157 else if ('c' == type)
159 size_t size_val_str = 1 + 1;
160 val_str = try_malloc(size_val_str, f_name);
161 test_val_str = snprintf(val_str, size_val_str, "%c", * val);
163 exit_trouble(test_val_str < 0, f_name, "snprintf()");
164 char * quote = quotes ? "'": "";
166 size_t size = strlen(prefix) + strlen(val_str) + (2 * strlen(quote))
168 char * line = try_malloc(size, f_name);
169 int test = snprintf(line, size, "%s%s%s%s%s",
170 prefix, quote, val_str, quote, affix);
171 exit_trouble(test < 0, f_name, "snprintf()");
173 try_fwrite(line, sizeof(char), strlen(line), file, f_name);
179 static void tokens_into_entries(char * token0, char * token1)
181 char * str_win = "WINDOW";
182 char * str_ord = "WIN_ORDER";
183 char * str_kbd = "KEYBINDINGS";
184 char * str_key = "KEY";
185 static uint8_t win_flags = READY_WIN;
186 static uint8_t ord_flags = READY_ORD;
187 static uint8_t kbd_flags = READY_KBD;
188 static struct Win * win = NULL;
189 static struct KeyBindingDB * kbdb = NULL;
190 if (!token0 || !strcmp(token0, str_win) || !strcmp(token0, str_ord)
191 || !strcmp(token0, str_kbd))
193 parse_and_reduce_to_readyflag(&win_flags, READY_WIN);
194 parse_and_reduce_to_readyflag(&ord_flags, READY_ORD);
195 parse_and_reduce_to_readyflag(&kbd_flags, READY_KBD);
200 if (strcmp(token0, str_key))
202 parsetest_too_many_values();
204 if (!( start_win(token0, token1, str_win, &win_flags, &win)
205 || start_ord(token0, token1, str_ord, &ord_flags)
206 || start_kbd(token0, token1, str_kbd, &kbd_flags, &kbdb)
207 || set_members(token0, token1, &win_flags, &ord_flags, kbd_flags,
208 str_key, win, kbdb)))
217 static void write_if_win(struct Win ** win)
219 char * f_name = "write_if_win()";
222 (*win)->target_height_type = (0 >= (*win)->target_height);
223 (*win)->target_width_type = (0 >= (*win)->target_width);;
224 size_t old_ids_size = strlen(world.winDB.ids);
225 size_t new_size = old_ids_size + 1 + 1;
226 char * new_ids = try_malloc(new_size, f_name);
227 int test = snprintf(new_ids,new_size,"%s%c",world.winDB.ids,(*win)->id);
228 exit_trouble(test < 0, f_name, "snprintf()");
229 free(world.winDB.ids);
230 world.winDB.ids = new_ids;
231 array_append(old_ids_size, sizeof(struct Win), *win,
232 (void **) &world.winDB.wins);
240 static uint8_t start_win(char * token0, char * token1, char * str_win,
241 uint8_t * win_flags, struct Win ** win)
243 if (strcmp(token0, str_win))
247 *win = (struct Win *) parse_init_entry(win_flags, sizeof(struct Win));
248 parsetest_singlechar(token1);
249 parse_id_uniq(world.winDB.ids && (NULL!=strchr(world.winDB.ids,token1[0])));
250 (*win)->id = token1[0];
256 static uint8_t start_ord(char * token0, char * token1, char * str_ord,
259 if (strcmp(token0, str_ord))
263 *ord_flags = EDIT_STARTED;
265 for (; i < strlen(token1); i++)
267 err_line(!strchr(world.winDB.legal_ids, token1[i]), "Illegal ID(s).");
270 tmp_order = strdup(token1);
271 if (0 < strlen(tmp_order))
273 tmp_active = tmp_order[0];
280 static uint8_t start_kbd(char * token0, char * token1, char * str_kbd,
281 uint8_t * kbd_flags, struct KeyBindingDB ** kbdb)
283 if (strcmp(token0, str_kbd))
287 *kbd_flags = EDIT_STARTED;
288 if (!strcmp(token1, "global"))
290 *kbdb = &world.kb_global;
292 else if (!strcmp(token1, "wingeom"))
294 *kbdb = &world.kb_wingeom;
296 else if (!strcmp(token1, "winkeys"))
298 *kbdb = &world.kb_winkeys;
302 err_line(1, "Value must be 'global', 'wingeom' or 'winkeys'.");
309 static uint8_t set_members(char * token0, char * token1, uint8_t * win_flags,
310 uint8_t * ord_flags,uint8_t kbd_flags,char * str_key,
311 struct Win * win, struct KeyBindingDB * kbdb)
313 if ( parse_flagval(token0, token1, "NAME", win_flags,
314 NAME_SET, 's', (char *) &win->title)
315 || parse_flagval(token0, token1, "WIDTH", win_flags,
316 WIDTH_SET, 'i', (char *) &win->target_width)
317 || parse_flagval(token0, token1, "HEIGHT", win_flags,
318 HEIGHT_SET, 'i', (char *) &win->target_height));
319 else if (parse_flagval(token0, token1, "BREAK", win_flags,
320 BREAK_SET, '8', (char *) &win->linebreak))
322 err_line(2 < win->linebreak, "Value must be 0, 1 or 2.");
324 else if (parse_flagval(token0, token1, "WIN_FOCUS", ord_flags,
325 FOCUS_SET, 'c', &tmp_active))
327 char * err_null = "Value not empty as it should be.";
328 char * err_outside = "ID not found in WIN_ORDER ID series.";
329 err_line(!strlen(tmp_order) && tmp_active, err_null);
330 err_line(!strchr(tmp_order, tmp_active), err_outside);
332 else if (!strcmp(token0, str_key))
334 if (*win_flags & EDIT_STARTED)
336 set_keybindings(token1, *win_flags, &win->kb);
340 set_keybindings(token1, kbd_flags, kbdb);
352 static void set_keybindings(char * token1, uint8_t flags,
353 struct KeyBindingDB * kbdb)
355 char * token2 = token_from_line(NULL);
356 err_line(!token2, "No binding to key given.");
357 parsetest_too_many_values();
358 char * err_code = "Invalid keycode. Must be >= 0 and < 1000.";
359 parsetest_defcontext(flags);
360 char * err_many = "No more than 255 keybindings allowed in one section.";
361 err_line(UINT8_MAX == kbdb->n_of_kbs, err_many);
362 struct KeyBinding kb;
363 uint8_t test = strlen(token1);
364 err_line(!test, err_code);
366 for (i = 0; '\0' != token1[i]; i++)
368 test= i > 2 || '0' > token1[i] || '9' < token1[i];
369 err_line(test, err_code);
371 kb.keycode = atoi(token1);
372 char * err_uniq = "Binding to key already defined.";
373 err_line(NULL != get_command_to_keycode(kbdb, kb.keycode), err_uniq);
374 kb.command = get_command(token2);
375 err_line(!(kb.command), "No such command in command DB.");
376 array_append(kbdb->n_of_kbs, sizeof(struct KeyBinding), (void *) &kb,
383 extern void obey_argv(int argc, char * argv[])
386 while (-1 != (opt = getopt(argc, argv, "i:")))
390 world.path_interface = optarg;
401 extern void save_interface_conf()
404 FILE * file = atomic_write_start(world.path_interface, &path_tmp);
405 char * str_keybs = "\nKEYBINDINGS ";
406 write_def(file, str_keybs, 1, "global", 's');
407 write_keybindings(file, &world.kb_global);
408 write_def(file, str_keybs, 1, "wingeom", 's');
409 write_keybindings(file, &world.kb_wingeom);
410 write_def(file, str_keybs, 1, "winkeys", 's');
411 write_keybindings(file, &world.kb_winkeys);
412 write_def(file, "\nWIN_ORDER ", 1, world.winDB.order, 's');
413 if (world.winDB.active)
415 write_def(file, "WIN_FOCUS ", 1, &world.winDB.active, 'c');
418 for (i = 0; i < strlen(world.winDB.ids); i++)
420 write_def(file, "\nWINDOW ", 0, &world.winDB.ids[i], 'c');
421 struct Win * win = get_win_by_id(world.winDB.ids[i]);
422 write_def(file, "NAME ", 1, win->title, 's');
423 write_def(file, "BREAK ", 0, (char *) &win->linebreak, 'i');
424 write_def(file, "WIDTH ", 0, (char *) &win->target_width, 'i');
425 write_def(file, "HEIGHT ", 0, (char *) &win->target_height, 'i');
426 write_keybindings(file, &win->kb);
428 atomic_write_finish(file, world.path_interface, path_tmp);
433 extern void load_interface_conf()
435 char * f_name = "load_interface_conf()";
436 world.winDB.ids = try_malloc(1, f_name);
437 world.winDB.ids[0] = '\0';
438 world.winDB.wins = NULL;
439 tmp_order = try_malloc(1, f_name);
442 detect_atomic_leftover(world.path_interface);
443 parse_file(world.path_interface, tokens_into_entries);
444 char * err = "Not all expected windows defined in config file.";
445 exit_err(strlen(world.winDB.legal_ids) != strlen(world.winDB.ids), err);
446 make_v_screen_and_init_win_sizes();
447 world.winDB.order = try_malloc(1, f_name);
448 world.winDB.order[0] = '\0';
450 for (i = 0; i < strlen(tmp_order); toggle_window(tmp_order[i]), i++);
451 world.winDB.active = tmp_active;
453 set_cleanup_flag(CLEANUP_INTERFACE);
458 extern void unload_interface_conf()
460 free(world.kb_global.kbs);
461 world.kb_global.kbs = NULL;
462 world.kb_global.n_of_kbs = 0;
463 free(world.kb_wingeom.kbs);
464 world.kb_wingeom.kbs = NULL;
465 world.kb_wingeom.n_of_kbs = 0;
466 free(world.kb_winkeys.kbs);
467 world.kb_winkeys.kbs = NULL;
468 world.kb_winkeys.n_of_kbs = 0;
469 while ('\0' != world.winDB.active)
471 toggle_window(world.winDB.active);
474 delwin(world.winDB.v_screen);
479 extern void reload_interface_conf()
481 unload_interface_conf();
482 load_interface_conf();
484 world.winDB.v_screen_offset = 0;