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> /* memset(), strchr(), strcmp(), strdup(), strlen() */
11 #include <unistd.h> /* optarg, getopt() */
12 #include "../common/parse_file.h" /* EDIT_STARTED, parse_file(), set_val(),
13 * token_from_line(), finalize_by_readyflag()
15 #include "../common/readwrite.h" /* try_fopen(), try_fclose_unlink_rename(),
18 #include "../common/rexit.h" /* exit_err(), exit_trouble() */
19 #include "../common/try_malloc.h" /* try_malloc() */
20 #include "array_append.h" /* array_append() */
21 #include "cleanup.h" /* set_cleanup_flag() */
22 #include "command_db.h" /* get_command() */
23 #include "keybindings.h" /* KeyBinding, KeyBindingDB, get_command_to_keycode() */
24 #include "map.h" /* map_center() */
25 #include "wincontrol.h" /* toggle_window() */
26 #include "windows.h" /* Win, free_winDB(), make_v_screen_and_init_win_sizes() */
27 #include "world.h" /* global world */
31 /* Editing state flags set / checked in tokens_into_entries(). */
39 READY_WIN = NAME_SET | WIDTH_SET | HEIGHT_SET | BREAK_SET,
46 /* Used in load_interface_conf() to temporarily store designated values for
47 * world.winDB.order and world.winDB.active. If those were set right away
48 * without all windows having already been initialized, orderly exits on error
49 * would be impossible, for windows are cleaned out by working toggling them off
50 * piece by peice following these values in unload_interfac_conf().
52 static char * tmp_order;
53 static char tmp_active;
57 /* Write into "file" keybindings in "kbdb" in config file format. */
58 static void write_keybindings(FILE * file, struct KeyBindingDB * kbdb);
60 /* Write into file "val" interpreted as pointing either to string (type = 's'),
61 * int16 ('i') or char ('c'), prefixed with "prefix" and put into single quotes
64 static void write_def(FILE * file, char * prefix, uint8_t quotes, char * val,
67 /* Read in "token0" and "token1" as interface config definition lines, apply
68 * definitions to WinDB, KeyBindingsDBs and tmp_order/tmp_active. If argument is
69 * "KEY", get third token via token_from_line() for complete keybinding.
71 static void tokens_into_entries(char * token0, char * token1);
73 /* If "win" points to non-NULL Win struct, append to it to WinDB.wins array and
74 * add its ID to world.winDB.ids.
76 static void write_if_win(struct Win ** win);
78 /* Start block setting data for window "token1" id if "token0" == "str_win".*/
79 static uint8_t start_win(char * token0, char * token1, char * str_win,
80 uint8_t * win_flags, struct Win ** win);
82 /* Start block setting window order and focus if "token0" = "str_ord".
83 * "tmp_order" stores the designated world.winDB.order string (only later to
84 * be realized in load_interface_conf() when all windows have been initialized),
85 * as does "tmp_active" for the designated world.winDB.active char, defaulting
86 * to the first char in the window order string if not otherwise specified.
88 static uint8_t start_ord(char * token0, char * token1, char * str_ord,
91 /* Start block setting non-window-specific keybindings if "token0" == "str_kbd".
92 * "token1" must be "global", "wingeom" or "winkeys" to set KeyBindingDB to edit
93 * ("kbdb") to world.kb_global, world.kb_wingeom or world.kb_winkeys.
95 static uint8_t start_kbd(char * token0, char * token1, char * str_kbd,
96 uint8_t * kbd_flags, struct KeyBindingDB ** kbdb);
98 /* Helper to tokens_into_entries(), sets specific entry member data. "token0"
99 * and the state of flags determine what entry member to edit; "win" and "kbdb"
100 * are entries to write "token1" data into (as is the global "tmp_active"). If
101 * "token0" is "KEY", a keybinding is defined and "token2" is read / must not be
102 * NULL. In that case, the line read is checked against having a 4th token.
104 static uint8_t set_members(char * token0, char * token1, char * token2,
105 uint8_t * win_flags, uint8_t * ord_flags,
107 struct Win * win, struct KeyBindingDB * kbdb);
109 /* Add keybinding defined in "token1" as keycode and "token2" as command to
110 * "kbdb" if "flags" are set to EDIT_STARTED.
112 static void set_keybindings(char * token1, char * token2, uint8_t flags,
113 struct KeyBindingDB * kbdb);
117 static void write_keybindings(FILE * file, struct KeyBindingDB * kbdb)
119 char * f_name = "write_keybindings()";
123 for (i_kb = 0; i_kb < kbdb->n_of_kbs; i_kb++)
125 size_t size = strlen(tok0) + strlen(sep) + 3 + strlen(sep)
126 + strlen(kbdb->kbs[i_kb].command->dsc_short) + 1 + 1;
127 char * line = try_malloc(size, f_name);
128 int test = snprintf(line, size, "%s%s%d%s%s\n",
129 tok0, sep, kbdb->kbs[i_kb].keycode, sep,
130 kbdb->kbs[i_kb].command->dsc_short);
131 exit_trouble(test < 0, f_name, "snprintf()");
132 try_fwrite(line, sizeof(char), strlen(line), file, f_name);
139 static void write_def(FILE * file, char * prefix, uint8_t quotes, char * val,
142 char * f_name = "write_def()";
144 int test_val_str = 1;
147 val_str = strdup(val);
151 size_t size_val_str = 6 + 1;
152 val_str = try_malloc(size_val_str, f_name);
153 test_val_str = snprintf(val_str, size_val_str, "%d", (int16_t) *val);
155 else if ('c' == type)
157 size_t size_val_str = 1 + 1;
158 val_str = try_malloc(size_val_str, f_name);
159 test_val_str = snprintf(val_str, size_val_str, "%c", * val);
161 exit_trouble(test_val_str < 0, f_name, "snprintf()");
162 char * quote = quotes ? "'": "";
164 size_t size = strlen(prefix) + strlen(val_str) + (2 * strlen(quote))
166 char * line = try_malloc(size, f_name);
167 int test = snprintf(line, size, "%s%s%s%s%s",
168 prefix, quote, val_str, quote, affix);
169 exit_trouble(test < 0, f_name, "snprintf()");
171 try_fwrite(line, sizeof(char), strlen(line), file, f_name);
177 static void tokens_into_entries(char * token0, char * token1)
179 char * str_win = "WINDOW";
180 char * str_ord = "WIN_ORDER";
181 char * str_kbd = "KEYBINDINGS";
182 static uint8_t win_flags = READY_WIN;
183 static uint8_t ord_flags = READY_ORD;
184 static uint8_t kbd_flags = READY_KBD;
185 static struct Win * win = NULL;
186 static struct KeyBindingDB * kbdb = NULL;
187 if (!token0 || !strcmp(token0, str_win) || !strcmp(token0, str_ord)
188 || !strcmp(token0, str_kbd))
190 finalize_by_readyflag(&win_flags, READY_WIN);
191 finalize_by_readyflag(&ord_flags, READY_ORD);
192 finalize_by_readyflag(&kbd_flags, READY_KBD);
199 char * token2 = token_from_line(NULL);
200 err_line(strcmp(token0, "KEY") && NULL != token2, "Too many values.");
201 if ( start_win(token0, token1, str_win, &win_flags, &win)
202 || start_ord(token0, token1, str_ord, &ord_flags)
203 || start_kbd(token0, token1, str_kbd, &kbd_flags, &kbdb)
204 || set_members(token0, token1, token2, &win_flags, &ord_flags,
205 kbd_flags, win, kbdb));
208 err_line(1, "Unknown argument.");
214 static void write_if_win(struct Win ** win)
216 char * f_name = "write_if_win()";
219 (*win)->target_height_type = (0 >= (*win)->target_height);
220 (*win)->target_width_type = (0 >= (*win)->target_width);;
221 size_t old_ids_size = strlen(world.winDB.ids);
222 size_t new_size = old_ids_size + 1 + 1;
223 char * new_ids = try_malloc(new_size, f_name);
224 int test = snprintf(new_ids,new_size,"%s%c",world.winDB.ids,(*win)->id);
225 exit_trouble(test < 0, f_name, "snprintf()");
226 free(world.winDB.ids);
227 world.winDB.ids = new_ids;
228 array_append(old_ids_size, sizeof(struct Win), *win,
229 (void **) &world.winDB.wins);
237 static uint8_t start_win(char * token0, char * token1, char * str_win,
238 uint8_t * win_flags, struct Win ** win)
240 if (strcmp(token0, str_win))
244 char * f_name = "start_win()";
245 char * err_uniq = "Declaration of ID already used.";
246 *win_flags = EDIT_STARTED;
247 *win = try_malloc(sizeof(struct Win), f_name);
248 memset(*win, 0, sizeof(struct Win));
249 err_line(1 != strlen(token1), "Value must be single ASCII character.");
250 err_line( world.winDB.ids
251 && (NULL != strchr(world.winDB.ids, token1[0])), err_uniq);
252 (*win)->id = token1[0];
258 static uint8_t start_ord(char * token0, char * token1, char * str_ord,
261 if (strcmp(token0, str_ord))
265 *ord_flags = EDIT_STARTED;
267 for (; i < strlen(token1); i++)
269 err_line(!strchr(world.winDB.legal_ids, token1[i]), "Illegal ID(s).");
272 tmp_order = strdup(token1);
273 if (0 < strlen(tmp_order))
275 tmp_active = tmp_order[0];
282 static uint8_t start_kbd(char * token0, char * token1, char * str_kbd,
283 uint8_t * kbd_flags, struct KeyBindingDB ** kbdb)
285 if (strcmp(token0, str_kbd))
289 *kbd_flags = EDIT_STARTED;
290 if (!strcmp(token1, "global"))
292 *kbdb = &world.kb_global;
294 else if (!strcmp(token1, "wingeom"))
296 *kbdb = &world.kb_wingeom;
298 else if (!strcmp(token1, "winkeys"))
300 *kbdb = &world.kb_winkeys;
304 err_line(1, "Value must be 'global', 'wingeom' or 'winkeys'.");
311 static uint8_t set_members(char * token0, char * token1, char * token2,
312 uint8_t * win_flags, uint8_t * ord_flags,
314 struct Win * win, struct KeyBindingDB * kbdb)
316 if ( set_val(token0, token1, "NAME", win_flags,
317 NAME_SET, 's', (char *) &win->title)
318 || set_val(token0, token1, "WIDTH", win_flags,
319 WIDTH_SET, 'i', (char *) &win->target_width)
320 || set_val(token0, token1, "HEIGHT", win_flags,
321 HEIGHT_SET, 'i', (char *) &win->target_height));
322 else if (set_val(token0, token1, "BREAK", win_flags,
323 BREAK_SET, '8', (char *) &win->linebreak))
325 err_line(2 < win->linebreak, "Value must be 0, 1 or 2.");
327 else if (set_val(token0, token1, "WIN_FOCUS", ord_flags,
328 FOCUS_SET, 'c', &tmp_active))
330 char * err_null = "Value not empty as it should be.";
331 char * err_outside = "ID not found in WIN_ORDER ID series.";
332 err_line(!strlen(tmp_order) && tmp_active, err_null);
333 err_line(!strchr(tmp_order, tmp_active), err_outside);
335 else if (!strcmp(token0, "KEY"))
337 err_line(NULL != token_from_line(NULL), "Too many values.");
338 if (* win_flags & EDIT_STARTED)
340 set_keybindings(token1, token2, * win_flags, &win->kb);
344 set_keybindings(token1, token2, kbd_flags, kbdb);
356 static void set_keybindings(char * token1, char * token2, uint8_t flags,
357 struct KeyBindingDB * kbdb)
359 char * err_out = "Outside appropriate definition's context.";
360 char * err_code = "Invalid keycode. Must be >= 0 and < 1000.";
361 err_line(!(flags & EDIT_STARTED), err_out);
362 err_line(!token2, "No binding to key given.");
363 char * err_many = "No more than 255 keybindings allowed in one section.";
364 err_line(UINT8_MAX == kbdb->n_of_kbs, err_many);
365 struct KeyBinding kb;
366 uint8_t test = strlen(token1);
367 err_line(!test, err_code);
369 for (i = 0; '\0' != token1[i]; i++)
371 test= i > 2 || '0' > token1[i] || '9' < token1[i];
372 err_line(test, err_code);
374 kb.keycode = atoi(token1);
375 char * err_uniq = "Binding to key already defined.";
376 err_line(NULL != get_command_to_keycode(kbdb, kb.keycode), err_uniq);
377 kb.command = get_command(token2);
378 err_line(!(kb.command), "No such command in command DB.");
379 array_append(kbdb->n_of_kbs, sizeof(struct KeyBinding), (void *) &kb,
386 extern void obey_argv(int argc, char * argv[])
389 while (-1 != (opt = getopt(argc, argv, "i:")))
393 world.path_interface = optarg;
404 extern void save_interface_conf()
406 char * f_name = "save_interface_conf()";
407 char * path = world.path_interface;
408 size_t size = strlen(path) + 4 + 1;
409 char * path_tmp = try_malloc(size, f_name);
410 int test = snprintf(path_tmp, size, "%s_tmp", path);
411 exit_trouble(test < 0, f_name, "snprintf()");
412 FILE * file = try_fopen(path_tmp, "w", f_name);
413 char * str_keybs = "\nKEYBINDINGS ";
414 write_def(file, str_keybs, 1, "global", 's');
415 write_keybindings(file, &world.kb_global);
416 write_def(file, str_keybs, 1, "wingeom", 's');
417 write_keybindings(file, &world.kb_wingeom);
418 write_def(file, str_keybs, 1, "winkeys", 's');
419 write_keybindings(file, &world.kb_winkeys);
420 write_def(file, "\nWIN_ORDER ", 1, world.winDB.order, 's');
421 if (world.winDB.active)
423 write_def(file, "WIN_FOCUS ", 1, &world.winDB.active, 'c');
426 for (i = 0; i < strlen(world.winDB.ids); i++)
428 write_def(file, "\nWINDOW ", 0, &world.winDB.ids[i], 'c');
429 struct Win * win = get_win_by_id(world.winDB.ids[i]);
430 write_def(file, "NAME ", 1, win->title, 's');
431 write_def(file, "BREAK ", 0, (char *) &win->linebreak, 'i');
432 write_def(file, "WIDTH ", 0, (char *) &win->target_width, 'i');
433 write_def(file, "HEIGHT ", 0, (char *) &win->target_height, 'i');
434 write_keybindings(file, &win->kb);
436 try_fclose_unlink_rename(file, path_tmp, path, f_name);
442 extern void load_interface_conf()
444 char * f_name = "load_interface_conf()";
445 world.winDB.ids = try_malloc(1, f_name);
446 world.winDB.ids[0] = '\0';
447 world.winDB.wins = NULL;
448 tmp_order = try_malloc(1, f_name);
451 parse_file(world.path_interface, tokens_into_entries);
452 char * err = "Not all expected windows defined in config file.";
453 exit_err(strlen(world.winDB.legal_ids) != strlen(world.winDB.ids), err);
454 make_v_screen_and_init_win_sizes();
455 world.winDB.order = try_malloc(1, f_name);
456 world.winDB.order[0] = '\0';
458 for (i = 0; i < strlen(tmp_order); toggle_window(tmp_order[i]), i++);
459 world.winDB.active = tmp_active;
461 set_cleanup_flag(CLEANUP_INTERFACE);
466 extern void unload_interface_conf()
468 free(world.kb_global.kbs);
469 world.kb_global.kbs = NULL;
470 world.kb_global.n_of_kbs = 0;
471 free(world.kb_wingeom.kbs);
472 world.kb_wingeom.kbs = NULL;
473 world.kb_wingeom.n_of_kbs = 0;
474 free(world.kb_winkeys.kbs);
475 world.kb_winkeys.kbs = NULL;
476 world.kb_winkeys.n_of_kbs = 0;
477 while ('\0' != world.winDB.active)
479 toggle_window(world.winDB.active);
482 delwin(world.winDB.v_screen);
487 extern void reload_interface_conf()
489 unload_interface_conf();
490 load_interface_conf();
492 world.winDB.v_screen_offset = 0;