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 struct Map;
  15
  16
  17
  18 /* set_cleanup_flag() sets any of the flags defined in cleanup_flag to announce
  19  * the resources that need cleaning up upon program exit. It is to be called at
  20  * the earliest moment possible after resource creation / initialization.
  21  */
  22 enum cleanup_flag
  23 {
  24     CLEANUP_NCURSES     = 0x01,
  25     CLEANUP_MAP         = 0x02,
  26     CLEANUP_KEYBINDINGS = 0x04,
  27     CLEANUP_LOG         = 0x08,
  28     CLEANUP_COMMAND_DB  = 0x10
  29 };
  30 extern void set_cleanup_flag(enum cleanup_flag flag);
  31
  32
  33
  34 /* Exit orderly, clean up. */
  35 extern void exit_game(struct World * world);
  36
  37
  38
  39 /* If "err" == 0, do nothing. Else, clean up and exit with an error message that
  40  * consists, first, of "msg" or (if "msg" is a NULL pointer) a generic "Details
  41  * unknown", secondly of "err" as the "internal error code", and thirdly of
  42  * errno if it is non-zero.
  43  */
  44 extern void exit_err(uint8_t err, struct World * world, char * msg);
  45
  46
  47
  48 #endif