home · contact · privacy
Improved windows cleaning up: free win_meta, ncurses windows/pads.
[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 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         = 0x0001,
25     CLEANUP_MAP             = 0x0002,
26     CLEANUP_KEYBINDINGS     = 0x0004,
27     CLEANUP_LOG             = 0x0008,
28     CLEANUP_COMMAND_DB      = 0x0010,
29     CLEANUP_MAP_OBJECTS     = 0x0020,
30     CLEANUP_MAP_OBJECT_DEFS = 0x0040,
31     CLEANUP_WIN_INFO        = 0x0080,
32     CLEANUP_WIN_LOG         = 0x0100,
33     CLEANUP_WIN_MAP         = 0x0200,
34     CLEANUP_WIN_KEYS        = 0x0400,
35     CLEANUP_WIN_META        = 0x0800
36 };
37 extern void set_cleanup_flag(enum cleanup_flag flag);
38
39
40
41 /* Exit orderly, clean up. */
42 extern void exit_game(struct World * world);
43
44
45
46 /* If "err" == 0, do nothing. Else, clean up and exit with an error message that
47  * consists, first, of "msg" or (if "msg" is a NULL pointer) a generic "Details
48  * unknown", secondly of "err" as the "internal error code", and thirdly of
49  * errno if it is non-zero.
50  */
51 extern void exit_err(uint8_t err, struct World * world, char * msg);
52
53
54
55 #endif