Small improvements in save_win_config() code and comments.

[plomrogue] / src / wincontrol.c

diff --git a/src/wincontrol.c b/src/wincontrol.c
index ee547ebe1305e9e87098cb882d1a26c87ac6d9c1..32a3ab195d943cc30f092c62a32a7a4c53d76e9a 100644 (file)
--- a/src/wincontrol.c
+++ b/src/wincontrol.c
@@ -146,13 +146,15 @@ static void save_win_config(char id)
 {
     char * f_name = "save_win_config()";
 
+    /* Prepare atomic file saving. */
     char * path_tmp = string_prefixed_id("config/windows/Win_tmp_", id);
     FILE * file = try_fopen(path_tmp, "w", f_name);
 
+    /* Save, line by line, ->title, ->draw, ->height and ->width. */
     struct WinConf * wc = get_winconf_by_id(id);
     uint8_t size = strlen(wc->title) + 2;
-    if (size < 7)
-    {
+    if (size < 7)  /* Ensure that at least 5 + 2 char fit into line so that   */
+    {              /* the digit representation of any uint16_t may be stored. */
         size = 7;
     }
     char line[size];
@@ -165,6 +167,7 @@ static void save_win_config(char id)
     sprintf(line, "%d\n", wc->width);
     try_fwrite(line, sizeof(char), strlen(line), file, f_name);
 
+    /* Save window-specific keybindings (->kb.kbs). */
     uint16_t linemax = 0;
     struct KeyBinding * kb_p = wc->kb.kbs;
     while (0 != kb_p)
@@ -175,17 +178,17 @@ static void save_win_config(char id)
         }
         kb_p = kb_p->next;
     }
-    linemax = linemax + 6;         /* + 6 = + 3 digits + whitespace + \n + \0 */
-
+    linemax = linemax + 6;          /* + 6: + 3 digits + whitespace + \n + \0 */
     char kb_line[linemax];
     kb_p = wc->kb.kbs;
     while (0 != kb_p)
     {
-        snprintf(kb_line, linemax, "%d %s\n", kb_p->key, kb_p->name);
+        sprintf(kb_line, "%d %s\n", kb_p->key, kb_p->name);
         try_fwrite(kb_line, sizeof(char), strlen(kb_line), file, f_name);
         kb_p = kb_p->next;
     }
 
+    /* Finish atomic file saving and clean up. */
     char * path = string_prefixed_id("config/windows/Win_", id);
     try_fclose_unlink_rename(file, path_tmp, path, f_name);
     free(path);
@@ -324,14 +327,15 @@ 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_"))
         {
@@ -420,20 +424,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;
@@ -441,13 +447,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);
 }