home · contact · privacy
More consistent code styling whitespace rules.
[plomrogue] / src / misc.h
1 /* misc.h
2  *
3  * Miscellaneous routines that have not yet found a proper parent module. Having
4  * LOTS of stuff in here is a sure sign that better modularization is in order.
5  */
6
7 #ifndef MISC_H
8 #define MISC_H
9
10 #include <stdlib.h>    /* for size_t */
11 #include <stdint.h>    /* for uint16_t */
12 #include "yx_uint16.h" /* for yx_uint16 coordinates */
13 struct Map;
14
15
16
17 /* Returns message: "Trouble in ".parent." with ".child."." (try_*() helper) */
18 extern char * trouble_msg(char * parent, char * child);
19
20 /* Wrappers to malloc(), calloc() from function called "f" calling exit_err()
21  * with trouble_msg() error message if necessary.
22  */
23 extern void * try_malloc(size_t size, char * f);
24 extern void * try_calloc(size_t nmemb, size_t size, char * f);
25
26 /* Check if tempfile "path" exists, and if so, exit with explanation that. */
27 extern void check_tempfile(char * path);
28
29 /* If one and only one of files at "p1", "p2" exists, fail with explanation. */
30 extern void check_files_xor(char * p1, char * p2);
31
32 /* Save / load / unload (free) / reload interface configuration data. */
33 extern void save_interface_conf();
34 extern void load_interface_conf();
35 extern void unload_interface_conf();
36 extern void reload_interface_conf();
37
38 /* Update game log by appending "text", or by appending a "." if "text" is the
39  * same as the last one passed.
40  */
41 extern void update_log(char * text);
42
43 /* Return the offset necessary to center a map of "mapsize" on position "pos" in
44  * a frame of "framesize.
45  */
46 extern uint16_t center_offset(uint16_t pos,
47                               uint16_t mapsize, uint16_t framesize);
48
49 /* Record last player "action" in game record file "record, increment the game
50  * turn and trigger enemy movement.
51  */
52 extern void turn_over(char action);
53
54 /* Save or load current game data to / from file "savefile". */
55 extern void save_game();
56 extern void load_game();
57
58 /* Return a random position on the map "map" that is passable (as determined by
59  * is_passable().
60  */
61 extern struct yx_uint16 find_passable_pos(struct Map * map);
62
63 /* Navigate (as far as possible) up (dir=='u') or (else) down in player's
64  * inventory selection.
65  */
66 extern void nav_inventory(char dir);
67
68
69
70 #endif