home · contact · privacy
Moved meta_keys() into new library "control" to soon include all key-press processing.
[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
11
12 #include <stdint.h>    /* for uint8_t, uint16_t, uint32_t */
13 #include <stdio.h>     /* for FILE typedef */
14 #include "yx_uint16.h" /* for yx_uint16 coordinates */
15 struct World;
16 struct WinMeta;
17 struct Win;
18 struct Map;
19
20
21
22 /* Learn from "file" the largest line length (pointed to by "linemax_p") and
23  * (pointed to by "n_lines_p" if it is not set to NULL) the number of lines.
24  */
25 extern void textfile_sizes(FILE * file, uint16_t * linemax_p,
26                            uint16_t * n_lines_p);
27
28
29
30 /* Update game log by appending "text", or by appending a "." if "text" is the
31  * same as the last one passed.
32  */
33 extern void update_log(struct World * world, char * text);
34
35
36
37 /* Return the offset necessary to center "map" on position "pos" in a frame of
38  * "framesize.
39  */
40 extern uint16_t center_offset(uint16_t pos, uint16_t mapsize,
41                               uint16_t framesize);
42
43
44
45 /* Record last player "action" in game record file "record, increment the game
46  * turn and trigger enemy movement.
47  */
48 extern void turn_over(struct World * world, char action);
49
50
51
52 /* Save current game data to file "savefile". */
53 extern void save_game(struct World * world);
54
55
56
57 /* Toggle display of a window "win".
58  *
59  * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
60  */
61 extern uint8_t toggle_window(struct WinMeta * win_meta, struct Win * win);
62
63
64
65 /* Try to scroll virtual screen left ("dir" = "-") or right ("dir" = "+"),
66  * subject to the limitations provided by the window manager via
67  * reset_pad_offset().
68  */
69 extern void scroll_pad(struct WinMeta * win_meta, char dir);
70
71
72
73 /* Try to grow or shrink the active window horizontally ("change" = "*"/"_") or
74  * vertically ("change = "+"/"-") by one cell size, subject to the limitations
75  * provided by the window manager via resize_active_win().
76  *
77  * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
78  */
79 extern uint8_t growshrink_active_window(struct WinMeta * win_meta, char change);
80
81
82
83 /* Return a random position on the map "map" that is passable (as determined by
84  * is_passable().
85  */
86 extern struct yx_uint16 find_passable_pos(struct Map * map);
87
88
89
90 #endif