home · contact · privacy
Some code-stylistic improvements to rexit library; also moved exit_trouble() into it.
[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 /* Return 16-bit number pseudo-randomly generated via Linear Congruential
18  * Generator algorithm with some proven constants. Use instead of rand() to
19  * ensure portability of the same pseudo-randomness across systems.
20  */
21 extern uint16_t rrand();
22
23 /* Wrappers to malloc(), calloc() from function called "f" calling exit_err()
24  * with trouble_msg() error message if necessary.
25  */
26 extern void * try_malloc(size_t size, char * f);
27 extern void * try_calloc(size_t nmemb, size_t size, char * f);
28
29 /* Check if tempfile "path" exists, and if so, exit with explanation that. */
30 extern void check_tempfile(char * path);
31
32 /* If one and only one of files at "p1", "p2" exists, fail with explanation. */
33 extern void check_files_xor(char * p1, char * p2);
34
35 /* Save / load / unload (free) / reload interface configuration data. */
36 extern void save_interface_conf();
37 extern void load_interface_conf();
38 extern void unload_interface_conf();
39 extern void reload_interface_conf();
40
41 /* Update game log by appending "text", or by appending a "." if "text" is the
42  * same as the last one passed.
43  */
44 extern void update_log(char * text);
45
46 /* Return the offset necessary to center a map of "mapsize" on position "pos" in
47  * a frame of "framesize.
48  */
49 extern uint16_t center_offset(uint16_t pos,
50                               uint16_t mapsize, uint16_t framesize);
51
52 /* Record last player "action" in game record file "record, increment the game
53  * turn and trigger enemy movement.
54  */
55 extern void turn_over(char action);
56
57 /* Save or load current game data to / from file "savefile". */
58 extern void save_game();
59 extern void load_game();
60
61 /* Return a random position on the map "map" that is passable (as determined by
62  * is_passable().
63  */
64 extern struct yx_uint16 find_passable_pos(struct Map * map);
65
66 /* Navigate (as far as possible) up (dir=='u') or (else) down in player's
67  * inventory selection.
68  */
69 extern void nav_inventory(char dir);
70
71
72
73 #endif