home · contact · privacy
4c6ddb00dbf4da8f9dec44da1bc9432ab5017871
[plomrogue] / 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_LOG             = 0x0004,
26     CLEANUP_COMMAND_DB      = 0x0008,
27     CLEANUP_MAP_OBJECTS     = 0x0010,
28     CLEANUP_MAP_OBJECT_DEFS = 0x0020,
29     CLEANUP_WIN_META        = 0x0040,
30     CLEANUP_INTERFACE_CONF  = 0x0080
31 };
32 extern void set_cleanup_flag(enum cleanup_flag flag);
33
34
35
36 /* Exit orderly, clean up. */
37 extern void exit_game(struct World * world);
38
39
40
41 /* If "err" == 0, do nothing. Else, clean up and exit with an error message that
42  * consists, first, of "msg" or (if "msg" is a NULL pointer) a generic "Details
43  * unknown", secondly of "err" as the "internal error code", and thirdly of
44  * errno if it is non-zero.
45  */
46 extern void exit_err(uint8_t err, struct World * world, char * msg);
47
48
49
50 #endif