X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fmisc.h;h=eb2d0cd661386c6f0f1e27a6c9d791b71f9bb511;hb=951248dddace9f7cadcf30700a3c3e6ad7ae2888;hp=742374c175ab37811f9b41343cc43dda3ded460f;hpb=d951e2631a19500f1bb8c29f9e029a9d9fb29ae7;p=plomrogue

diff --git a/src/misc.h b/src/misc.h
index 742374c..eb2d0cd 100644
--- a/src/misc.h
+++ b/src/misc.h
@@ -1,20 +1,90 @@
+/* misc.h
+ *
+ * Miscellaneous routines that have not yet found a proper parent module. Having
+ * LOTS of stuff in here is a sure sign that better modularization is in order.
+ */
+
 #ifndef MISC_H
 #define MISC_H
 
-#include <stdint.h>
 
+
+#include <stdint.h>    /* for uint8_t, uint16_t, uint32_t */
+#include <stdio.h>     /* for FILE typedef */
+#include "yx_uint16.h" /* for yx_uint16 coordinates */
 struct World;
 struct WinMeta;
 struct Win;
+struct Map;
+
+
+
+/* Learn from "file" the largest line length (pointed to by "linemax_p") and
+ * (pointed to by "n_lines_p" if it is not set to NULL) the number of lines.
+ */
+extern void textfile_sizes(FILE * file, uint16_t * linemax_p,
+                           uint16_t * n_lines_p);
+
+
+
+/* Update game log by appending "text", or by appending a "." if "text" is the
+ * same as the last one passed.
+ */
+extern void update_log(struct World * world, char * text);
+
+
+
+/* Return the offset necessary to center "map" on position "pos" in a frame of
+ * "framesize.
+ */
+extern uint16_t center_offset(uint16_t pos, uint16_t mapsize,
+                              uint16_t framesize);
+
+
+
+/* Record last player "action" in game record file "record, increment the game
+ * turn and trigger enemy movement.
+ */
+extern void turn_over(struct World * world, char action);
+
+
+
+/* Save current game data to file "savefile". */
+extern void save_game(struct World * world);
+
+
+
+/* Toggle display of a window "win".
+ *
+ * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
+ */
+extern uint8_t toggle_window(struct WinMeta * win_meta, struct Win * win);
+
+
+
+/* Try to scroll virtual screen left ("dir" = "-") or right ("dir" = "+"),
+ * subject to the limitations provided by the window manager via
+ * reset_pad_offset().
+ */
+extern void scroll_pad(struct WinMeta * win_meta, char dir);
+
+
+
+/* Try to grow or shrink the active window horizontally ("change" = "*"/"_") or
+ * vertically ("change = "+"/"-") by one cell size, subject to the limitations
+ * provided by the window manager via resize_active_win().
+ *
+ * Return 0 on success, 1 on (ncurses pad/window memory allocation) error.
+ */
+extern uint8_t growshrink_active_window(struct WinMeta * win_meta, char change);
+
+
+
+/* Return a random position on the map "map" that is passable (as determined by
+ * is_passable().
+ */
+extern struct yx_uint16 find_passable_pos(struct Map * map);
+
 
-extern uint16_t rrand(char, uint32_t);
-extern void update_log (struct World *, char *);
-uint16_t center_offset (uint16_t, uint16_t, uint16_t);
-extern void turn_over (struct World *, char);
-extern void save_game(struct World *);
-extern void toggle_window (struct WinMeta *, struct Win *);
-extern void scroll_pad (struct WinMeta *, char);
-extern void growshrink_active_window (struct WinMeta *, char);
-extern unsigned char meta_keys(int, struct World *, struct WinMeta *, struct Win *, struct Win *, struct Win *, struct Win *);
 
 #endif