home · contact · privacy
Fixed bug that led to endless loop in nearest_enemy_dir().
[plomrogue] / src / wincontrol.c
index 7933d48ad5b16b705b2a774d08dfa49715e928ee..74bd4a202b5a96f73973e4f399985d5b37ec75ca 100644 (file)
@@ -4,26 +4,24 @@
 #include <stdlib.h> /* for free() */
 #include <string.h> /* for strlen(), strchr(), strstr() */
 #include <stdint.h> /* for uint8_t, uint16_t */
-#include <unistd.h> /* for access(), unlink() */
 #include "windows.h" /* for suspend_win(), append_win(), reset_pad_offset(),
-                      * resize_active_win(), init_win(), free_win(),
-                      * structs Win, WinMeta
+                      * resize_active_win(), init_win(), free_win(), struct Win
                       */
 #include "yx_uint16.h" /* for yx_uint16 struct */
 #include "main.h" /* for world global */
-#include "readwrite.h" /* for get_linemax(), try_fopen(), try_fclose(),
+#include "readwrite.h" /* for textfile_sizes(), try_fopen(), try_fclose(),
                         * try_fgets(), try_fclose_unlink_rename(), try_fwrite()
+                        * try_fgetc_noeof()
                         */
-#include "rexit.h" /* for exit_err() */
-#include "main.h" /* for world global */
-#include "draw_wins.h" /* for draw_win_map(), draw_win_info(), draw_win_og(),
+#include "rexit.h" /* for exit_err(), exit_trouble() */
+#include "draw_wins.h" /* for draw_win_map(), draw_win_info(), draw_win_log(),
                         * draw_win_available_keybindings(),
-                        * draw_win_keybindings_global(), draw_win_inventory(),
+                        * draw_win_inventory(), draw_win_keybindings_global(),
                         * draw_win_keybindings_winconf_geometry(),
                         * draw_win_keybindings_winconf_keybindings(),
                         * draw_winconf_geometry(), draw_winconf_keybindings()
                         */
-#include "misc.h" /* for try_malloc(), trouble_msg() */
+#include "misc.h" /* for try_malloc() */
 #include "dirent.h" /* for opendir(), closedir(), readdir() */
 #include "errno.h" /* for errno */
 #include "keybindings.h" /* for KeyBinding struct, free_keybindings() */
 /* Return string "prefix" + "id"; malloc()'s string, remember to call free()! */
 static char * string_prefixed_id(char * prefix, char id);
 
-
-
-/* Create Winconf, init ->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);
@@ -47,25 +40,21 @@ static void init_win_from_winconf(char id);
 /* Save title, draw function, size of window identified by "id" to conffile. */
 static void save_win_config(char id);
 
-/* Free data pointed to inside WinConf struct. */
+/* Free data pointed to inside individual WinConf struct of "id". */
 static void free_winconf_data(char id);
 
-
-
 /* Write geometry of a window to its WinConf, as positive or negative values
  * (dependent on state ofWinConf->height_type / WinConf->width_type).
  */
 static void set_winconf_geometry(char id);
 
-
-
 /* Get WinConf by "id"; get id of WinConf mothering "win". */
 static struct WinConf * get_winconf_by_id(char id);
 
 /* Get (Win->draw) function identified by "c"; NULL if c not mapped to one. */
 static void * get_drawfunc_by_char(char c);
 
-/* Iterate over bytes of world.winconf_ids array. Re-start after null byte. */
+/* Iterate over chars of world.winconf_ids array. Re-start after null byte. */
 static char get_next_winconf_id();
 
 
@@ -81,53 +70,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);
+    uint16_t linemax = textfile_sizes(file, NULL/*, 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;
@@ -149,6 +122,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);
 }
@@ -170,13 +147,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];
@@ -189,6 +168,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)
@@ -199,17 +179,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);
@@ -272,7 +252,7 @@ static void * get_drawfunc_by_char(char c)
     {
         return draw_win_inventory;
     }
-    if      ('i' == c)
+    else if ('i' == c)
     {
         return draw_win_info;
     }
@@ -312,11 +292,9 @@ static char get_next_winconf_id()
     if (0 == c)
     {
         i = 0;
+        return c;
     }
-    else
-    {
-        i++;
-    }
+    i++;
     return c;
 }
 
@@ -348,18 +326,17 @@ extern struct Win * get_win_by_id(char id)
 extern void init_winconfs()
 {
     char * f_name = "init_winconfs()";
-    char * err_o = "Trouble in init_winconfs() with opendir().";
-    char * err_r = "Trouble in init_winconfs() with readdir().";
-    char * err_c = "Trouble in init_winconfs() with closedir().";
 
+    /* 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_err(NULL == dp, err_o);
+    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_"))
         {
@@ -369,25 +346,19 @@ extern void init_winconfs()
         }
     }
     winconf_ids[i] = '\0';
-    exit_err(errno, err_r);
-    exit_err(closedir(dp), err_c);
+    exit_trouble(errno, f_name, "readdir()");
+    exit_trouble(closedir(dp), f_name, "closedir()");
     world.winconf_ids = try_malloc(strlen(winconf_ids) + 1, f_name);
     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++;
     }
 }
@@ -422,29 +393,24 @@ 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);
-
+    uint16_t linemax = textfile_sizes(file, NULL);
     char win_order[linemax + 1];
     try_fgets(win_order, linemax + 1, file, f_name);
-
-    uint8_t a = 0;
-    char * err = trouble_msg(f_name, "read_uint8()");
-    exit_err(read_uint8(file, &a), err);
-    free(err);
-
+    uint8_t a = try_fgetc_noeof(file, f_name);
     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]);
@@ -458,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;
@@ -479,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_fputc(wc->id, file, f_name);
     }
-
     try_fclose_unlink_rename(file, path_tmp, path, f_name);
 }
 
@@ -495,7 +463,7 @@ extern void toggle_window(char id)
 {
     struct Win * win = get_win_by_id(id);
     if (0 == win->prev && world.wmeta->chain_start != win)  /* Win struct is  */
-    {                                                       /* outside chain. */
+    {                                                       /* outside chain? */
         append_win(win);
     }
     else
@@ -512,57 +480,40 @@ extern void toggle_winconfig()
    struct WinConf * wcp = get_winconf_by_win(win);
     if      (0 == wcp->view)
     {
-        win->draw = draw_winconf_geometry;
-        wcp->view = 1;
-        wcp->center = win->center;
+        wcp->view     = 1;
+        win->draw     = draw_winconf_geometry;
+        wcp->center   = win->center;
         win->center.y = 0;
         win->center.x = 0;
     }
     else if (1 == wcp->view)
     {
-        win->draw = draw_winconf_keybindings;
-        wcp->view = 2;
+        wcp->view     = 2;
+        win->draw     = draw_winconf_keybindings;
         win->center.x = 0;
     }
     else
     {
-        win->draw = get_drawfunc_by_char(wcp->draw);
-        win->center = wcp->center;
-        wcp->view = 0;
+        wcp->view     = 0;
+        win->draw     = get_drawfunc_by_char(wcp->draw);
+        win->center   = wcp->center;
     }
 }
 
 
 
-extern void toggle_win_height_type()
+extern void toggle_win_size_type(char axis)
 {
     struct Win * win = world.wmeta->active;
     struct WinConf * wcp = get_winconf_by_win(win);
-    if (0 == wcp->height_type)
+    if ('y' == axis)
     {
-        wcp->height_type = 1;
-    }
-    else
-    {
-        wcp->height_type = 0;
-    }
-    set_winconf_geometry(wcp->id);
-}
-
-
-
-extern void toggle_win_width_type()
-{
-    struct Win * win = world.wmeta->active;
-    struct WinConf * wcp = get_winconf_by_win(win);
-    if (0 == wcp->width_type && win->framesize.x <= world.wmeta->padsize.x)
-    {
-        wcp->width_type = 1;
-    }
-    else
-    {
-        wcp->width_type = 0;
+        wcp->height_type = (0 == wcp->height_type);
+        set_winconf_geometry(wcp->id);
+        return;
     }
+    wcp->width_type = (   0 == wcp->width_type
+                       && win->framesize.x <= world.wmeta->padsize.x);
     set_winconf_geometry(wcp->id);
 }