Made game exiting and cleaning up more flexible. Provided so far unused exit-on-error...

diff --git a/src/main.c b/src/main.c
index 8c1ac5667dde5a1b33da92a8425888c4bbf36c72..f7007b7d477232601ef065c8f27af0373ed93a75 100644 (file)
--- a/src/main.c
+++ b/src/main.c
@@ -22,11 +22,12 @@
                           */
 #include "map_object_actions.h" /* for player_wait(), move_player() */
 #include "map.h" /* for struct Map, init_map() */
-#include "misc.h" /* for update_log(), toggle_window(), exit_game(),
-                   * find_passable_pos(), meta_keys(), save_game()
+#include "misc.h" /* for update_log(), toggle_window(), find_passable_pos(),
+                   * meta_keys(), save_game()
                    */
 #include "yx_uint16.h" /* for dir enum */
 #include "rrand.h" /* for rrand(), rrand_seed() */
+#include "rexit.h" /* for exit_game() */
 
 int main(int argc, char *argv[])
 {
@@ -53,6 +54,7 @@ int main(int argc, char *argv[])
 
     /* Initialize log, player, monster/item definitions and monsters/items. */
     world.log = calloc(1, sizeof(char));
+    set_cleanup_flag(CLEANUP_LOG);
     update_log (&world, " ");
     struct Player player;
     player.hitpoints = 5;
@@ -104,6 +106,7 @@ int main(int argc, char *argv[])
     rrand_seed(world.seed);
     struct Map map = init_map();
     world.map = ↦
+    set_cleanup_flag(CLEANUP_MAP);
     if (1 == world.turn)
     {
         player.pos = find_passable_pos(&map);
@@ -117,11 +120,13 @@ int main(int argc, char *argv[])
 
     /* Initialize window system and windows. */
     WINDOW * screen = initscr();
+    set_cleanup_flag(CLEANUP_NCURSES);
     noecho();
     curs_set(0);
     keypad(screen, TRUE);
     raw();
     init_keybindings(&world);
+    set_cleanup_flag(CLEANUP_KEYBINDINGS);
     struct WinMeta win_meta = init_win_meta(screen);
     struct Win win_keys = init_win(&win_meta, "Keys",
                                    0, 29, &world, draw_keys_win);
@@ -196,7 +201,7 @@ int main(int argc, char *argv[])
                                              &win_map, &win_info, &win_log);
                 if (1 == quit_called)
                 {
-                    exit_game(&world, &map);
+                    exit_game(&world);
                 }
             }
         }
@@ -255,7 +260,7 @@ int main(int argc, char *argv[])
                                              &win_map, &win_info, &win_log);
                 if (1 == quit_called)
                 {
-                    exit_game(&world, &map);
+                    exit_game(&world);
                 }
             }
         }

diff --git a/src/misc.c b/src/misc.c
index 6aeb8b45303a229b120593848a5a8ebd5c9c3241..0bb50a76fa4c7831ccfece4f41bab471c30b46ae 100644 (file)
--- a/src/misc.c
+++ b/src/misc.c
@@ -1,9 +1,8 @@
 /* misc.c */
 
 #include "misc.h"
-#include <stdlib.h> /* for exit(), EXIT_SUCCESS define, calloc(), free() */
+#include <stdlib.h> /* for calloc(), free() */
 #include <string.h> /* for strlen(), strcmp(), memcpy() */
-#include <ncurses.h> /* for endwin() */
 #include "windows.h" /* for suspend_win(), append_win(), reset_pad_offset(),
                       * resize_active_win(), cycle_active_win(),
                       * shift_active_win(), struct Win, struct WinMeta
@@ -22,23 +21,6 @@
 
 
 
-extern void exit_game(struct World * world, struct Map * map)
-{
-    endwin();
-    free(map->cells);
-    uint16_t key;
-    for (key = 0; key <= world->keyswindata->max; key++)
-    {
-        free(world->keybindings[key].name);
-    }
-    free(world->keybindings);
-    free(world->keyswindata);
-    free(world->log);
-    exit (EXIT_SUCCESS);
-}
-
-
-
 extern void textfile_sizes(FILE * file, uint16_t * linemax_p,
                            uint16_t * n_lines_p)
 {

diff --git a/src/misc.h b/src/misc.h
index 4d26f10baa25a26386c8a99936f71766c6e7ea4d..1c1a74903618348ed8c94bdfb0bfdacef2f68715 100644 (file)
--- a/src/misc.h
+++ b/src/misc.h
@@ -19,11 +19,6 @@ struct Map;
 
 
 
-/* Reset terminal (end ncurses), clean up memory and exit. */
-extern void exit_game(struct World * world, struct Map * map);
-
-
-
 /* Learn from "file" the largest line length (pointed to by "linemax_p") and
  * (pointed to by "n_lines_p" if it is not set to NULL) the number of lines.
  */

diff --git a/src/rexit.c b/src/rexit.c
new file mode 100644 (file)
index 0000000..f7bb3f2
--- /dev/null
+++ b/src/rexit.c
@@ -0,0 +1,67 @@
+/* rexit.c */
+
+#include "rexit.h"
+#include <stdlib.h> /* for exit(), free(), defines EXIT_SUCESS, EXIT_FAILURE */
+#include <stdio.h> /* for printf() */
+#include <ncurses.h> /* for endwin() */
+#include "main.h" /* for World struct */
+#include "map.h" /* for Map struct */
+#include "keybindings.h" /* for KeysWinData, KeyBinding structs */
+
+
+
+/* The clean-up routine and the flag resource by which it decides what to do. */
+static unsigned char cleanup_flags = 0x00;
+static void cleanup(struct World * world);
+
+
+
+static void cleanup(struct World * world)
+{
+    if (cleanup_flags & CLEANUP_NCURSES)
+    {
+        endwin();
+    }
+    if (cleanup_flags & CLEANUP_MAP)
+    {
+        free(world->map->cells);
+    }
+    if (cleanup_flags & CLEANUP_KEYBINDINGS)
+    {
+        uint16_t key;
+        for (key = 0; key <= world->keyswindata->max; key++)
+        {
+            free(world->keybindings[key].name);
+        }
+        free(world->keybindings);
+        free(world->keyswindata);
+    }
+    if (cleanup_flags & CLEANUP_LOG)
+    {
+        free(world->log);
+    }
+}
+
+
+
+extern void set_cleanup_flag(enum cleanup_flag flag)
+{
+    cleanup_flags = cleanup_flags | flag;
+}
+
+
+
+extern void exit_game(struct World * world)
+{
+    cleanup(world);
+    exit(EXIT_SUCCESS);
+}
+
+
+
+extern void exit_err(struct World * world, char * msg)
+{
+    cleanup(world);
+    printf(msg);
+    exit(EXIT_FAILURE);
+}

diff --git a/src/rexit.h b/src/rexit.h
new file mode 100644 (file)
index 0000000..8a5444f
--- /dev/null
+++ b/src/rexit.h
@@ -0,0 +1,39 @@
+/* rexit.h
+ *
+ * Routines to exit the game orderly or on error, with as much cleaning up as is
+ * possible in both cases.
+ */
+
+#ifndef REXIT_H
+#define REXIT_H
+
+
+
+struct World;
+struct Map;
+
+
+
+/* set_cleanup_flag() sets any of the flags defined in cleanup_flag to announce
+ * the resources that need cleaning up upon program exit. It is to be called at
+ * the earliest moment possible after resource creation / initialization.
+ */
+enum cleanup_flag
+{
+    CLEANUP_NCURSES     = 0x01,
+    CLEANUP_MAP         = 0x02,
+    CLEANUP_KEYBINDINGS = 0x04,
+    CLEANUP_LOG         = 0x08
+};
+extern void set_cleanup_flag(enum cleanup_flag flag);
+
+
+
+/* Exit orderly without message or on error with an error message ("msg").
+ */
+extern void exit_game(struct World * world);
+extern void exit_err(struct World * world, char * msg);
+
+
+
+#endif