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