home · contact · privacy
Ensure not more WinConfs are read or saved than world.winconf_ids can stomach.
[plomrogue] / src / wincontrol.c
index 296c4a9dd8d5112cc18fb2e96592683643a3910d..6ce1f324f6801ed7e3d61bab73b5d7d410145684 100644 (file)
 /* Return string "prefix" + "id"; malloc()'s string, remember to call free()! */
 static char * string_prefixed_id(char * prefix, char id);
 
-/* Initializes Winconf: .view/.height_type/.width_type to 0, .id to "id". */
-static void create_winconf(char id, struct WinConf * wcp);
-
 /* Initialize Winconf of "id" from appropriate config file.*/
-static void init_winconf_from_file(char id);
+static void init_winconf_from_file(char id, struct WinConf * winconf);
 
 /* Wrapper around init_win() called with values from Winconf of "id". */
 static void init_win_from_winconf(char id);
@@ -72,53 +69,37 @@ static char * string_prefixed_id(char * prefix, char id)
 
 
 
-static void create_winconf(char id, struct WinConf * wcp)
-{
-    wcp->id = id;
-    wcp->view = 0;
-    wcp->height_type = 0;
-    wcp->width_type = 0;
-    wcp->kb.edit = 0;
-    wcp->kb.select = 0;
-}
-
-
-
-static void init_winconf_from_file(char id)
+static void init_winconf_from_file(char id, struct WinConf * winconf)
 {
+    /* Assign WinConf id to filename path, error message context, winconf->id.*/
     char * tmp = "init_winconf_from_file() on window id '_'";
     char * context = try_malloc(strlen(tmp) + 1, "init_winconf_from_file()");
     memcpy(context, tmp, strlen(tmp) + 1);
     context[strlen(tmp) - 2] = id;
-
     char * path = string_prefixed_id("config/windows/Win_", id);
+    winconf->id = id;
+
+    /* Prepare reading in file line by line into "line" array. */
     FILE * file = try_fopen(path, "r", context);
     free(path);
     uint16_t linemax = get_linemax(file, context);
     char line[linemax + 1];
 
-    struct WinConf * winconf = get_winconf_by_id(id);
+    /* Read/determine winconf->title, ->draw, ->height(_type),->width(_type). */
     try_fgets(line, linemax + 1, file, context);
     winconf->title = try_malloc(strlen(line), context);
     memcpy(winconf->title, line, strlen(line) - 1); /* Eliminate newline char */
     winconf->title[strlen(line) - 1] = '\0';        /* char at end of string. */
-
     try_fgets(line, linemax + 1, file, context);
     winconf->draw = line[0];
-
     try_fgets(line, linemax + 1, file, context);
     winconf->height = atoi(line);
-    if (0 >= winconf->height)
-    {
-        winconf->height_type = 1;
-    }
+    winconf->height_type = (0 >= winconf->height);
     try_fgets(line, linemax + 1, file, context);
     winconf->width = atoi(line);
-    if (0 >= winconf->width)
-    {
-        winconf->width_type = 1;
-    }
+    winconf->width_type = (0 >= winconf->width);
 
+    /* Read in window-specific keybindings (winconf->kb). */
     char command[linemax + 1];
     char * cmdptr;
     struct KeyBinding ** loc_last_ptr = &winconf->kb.kbs;
@@ -140,6 +121,10 @@ static void init_winconf_from_file(char id)
         loc_last_ptr = & kb_p->next;
     }
 
+    /* Init remaining values to zero and cleaning up. */
+    winconf->view = 0;
+    winconf->kb.edit = 0;
+    winconf->kb.select = 0;
     try_fclose(file, context);
     free(context);
 }
@@ -338,14 +323,16 @@ extern void init_winconfs()
 {
     char * f_name = "init_winconfs()";
 
+    /* Fill world.winconf_ids with config/windows/Win_* filenames' end chars. */
+    uint8_t max_wins = 255;         /* Maximum number of window ids to store. */
     DIR * dp = opendir("config/windows");
     exit_trouble(NULL == dp, f_name, "opendir()");
     struct dirent * fn;
     errno = 0;
-    char * winconf_ids = try_malloc(256, f_name);
+    char * winconf_ids = try_malloc(max_wins + 1, f_name);
     uint8_t i = 0;
     char id;
-    while (NULL != (fn = readdir(dp)))
+    while (NULL != (fn = readdir(dp)) && i < max_wins)
     {
         if (5 == strlen(fn->d_name) && fn->d_name == strstr(fn->d_name, "Win_"))
         {
@@ -361,19 +348,13 @@ extern void init_winconfs()
     memcpy(world.winconf_ids, winconf_ids, strlen(winconf_ids) + 1);
     free(winconf_ids);
 
-    struct WinConf * winconfs;
-    winconfs = try_malloc(strlen(world.winconf_ids) * sizeof(struct WinConf),
-                          f_name);
+    /* Initialize world.winconfs from Win_* files named in world.winconf_ids. */
+    size_t size = strlen(world.winconf_ids) * sizeof(struct WinConf);
+    world.winconfs = try_malloc(size, f_name);
     i = 0;
     while (0 != (id = get_next_winconf_id()))
     {
-        create_winconf(id, &winconfs[i]);
-        i++;
-    }
-    world.winconfs = winconfs;
-    while (0 != (id = get_next_winconf_id()))
-    {
-        init_winconf_from_file(id);
+        init_winconf_from_file(id, &world.winconfs[i]);
         i++;
     }
 }
@@ -408,27 +389,25 @@ extern void sorted_wintoggle_and_activate()
 {
     char * f_name = "sorted_wintoggle_and_activate()";
 
+    /* Read from file order of windows to be toggled + active win selection. */
     char * path = "config/windows/toggle_order_and_active";
     FILE * file = try_fopen(path, "r", f_name);
     uint16_t linemax = get_linemax(file, f_name);
-
     char win_order[linemax + 1];
     try_fgets(win_order, linemax + 1, file, f_name);
-
-    uint8_t a = 0;
+    uint8_t a;
     exit_trouble(read_uint8(file, &a), f_name, "read_uint8()");
-
     try_fclose(file, f_name);
 
+    /* Toggle windows and set active window selection. */
     uint8_t i = 0;
-    for (; i < linemax - 1; i++)
+    for (; i < strlen(win_order) - 1; i++)
     {
         if (NULL == strchr(world.winconf_ids, win_order[i]))
         {
             continue;
         }
         toggle_window(win_order[i]);
-
         if (a == (uint8_t) win_order[i])
         {
             world.wmeta->active = get_win_by_id(win_order[i]);
@@ -442,20 +421,22 @@ extern void save_win_configs()
 {
     char * f_name = "save_win_configs()";
 
+    /* Save individual world.winconfs to their proper files. */
+    uint8_t max_wins = 255; /* So many winconf ids fit into world.winconf_ids.*/
     char id;
     while (0 != (id = get_next_winconf_id()))
     {
         save_win_config(id);
     }
 
+    /* Save order of windows to toggle on start / which to select as active. */
     char * path     = "config/windows/toggle_order_and_active";
     char * path_tmp = "config/windows/toggle_order_and_active_tmp";
     FILE * file = try_fopen(path_tmp, "w", f_name);
-
-    char line[6];
+    char line[max_wins + 2];
     struct Win * w_p = world.wmeta->chain_start;
     uint8_t i = 0;
-    while (0 != w_p)
+    while (0 != w_p && i < max_wins)
     {
         struct WinConf * wc = get_winconf_by_win(w_p);
         line[i] = wc->id;
@@ -463,13 +444,13 @@ extern void save_win_configs()
         i++;
     }
     line[i] = '\n';
+    line[i + 1] = '\0';
     try_fwrite(line, sizeof(char), strlen(line), file, f_name);
     if (0 != world.wmeta->active)
     {
         struct WinConf * wc = get_winconf_by_win(world.wmeta->active);
         write_uint8(wc->id, file);
     }
-
     try_fclose_unlink_rename(file, path_tmp, path, f_name);
 }