plomlompom.com Git - plomrogue/blob - src/rexit.h

   1 /* rexit.h
   2  *
   3  * Routines to exit the game orderly or on error, with as much cleaning up as is
   4  * possible in both cases.
   5  */
   6
   7 #ifndef REXIT_H
   8 #define REXIT_H
   9
  10
  11
  12 #include <stdint.h> /* for uint8_t */
  13 struct World;
  14
  15
  16
  17 /* set_cleanup_flag() sets any of the flags defined in cleanup_flag to announce
  18  * the resources that need cleaning up upon program exit. It is to be called at
  19  * the earliest moment possible after resource creation / initialization.
  20  */
  21 enum cleanup_flag
  22 {
  23     CLEANUP_NCURSES         = 0x0001,
  24     CLEANUP_MAP             = 0x0002,
  25     CLEANUP_KEYBINDINGS     = 0x0004,
  26     CLEANUP_LOG             = 0x0008,
  27     CLEANUP_COMMAND_DB      = 0x0010,
  28     CLEANUP_MAP_OBJECTS     = 0x0020,
  29     CLEANUP_MAP_OBJECT_DEFS = 0x0040,
  30     CLEANUP_WIN_META        = 0x0080,
  31     CLEANUP_WINCONFS        = 0x0100
  32 };
  33 extern void set_cleanup_flag(enum cleanup_flag flag);
  34
  35
  36
  37 /* Exit orderly, clean up. */
  38 extern void exit_game(struct World * world);
  39
  40
  41
  42 /* If "err" == 0, do nothing. Else, clean up and exit with an error message that
  43  * consists, first, of "msg" or (if "msg" is a NULL pointer) a generic "Details
  44  * unknown", secondly of "err" as the "internal error code", and thirdly of
  45  * errno if it is non-zero.
  46  */
  47 extern void exit_err(uint8_t err, struct World * world, char * msg);
  48
  49
  50
  51 #endif