X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Fmisc.h;h=568c56d432c5d9d572fb37c4f22f2025a86ac825;hb=0568c1c0f6735509f2a1afea31ecb5dc28f26bf4;hp=68db82265e26ca15fe9c959190deff60372d6a7f;hpb=0f12557b88c73f8629ffafc38dc59ab5bd15e687;p=plomrogue

diff --git a/src/misc.h b/src/misc.h
index 68db822..568c56d 100644
--- a/src/misc.h
+++ b/src/misc.h
@@ -1,25 +1,66 @@
+/* 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 "yx_uint16.h"
-#include <stdio.h>
 
+
+#include <stdint.h>    /* for uint8_t, uint16_t */
+#include <stdio.h>     /* for FILE typedef */
+#include "yx_uint16.h" /* for yx_uint16 coordinates */
 struct World;
-struct WinMeta;
-struct Win;
 struct Map;
 
-extern void textfile_sizes (FILE *, uint16_t *, uint16_t *);
-extern uint16_t rrand(char, uint32_t);
-extern void update_log (struct World *, char *);
-extern 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 struct yx_uint16 find_passable_pos (struct Map *);
-extern unsigned char meta_keys(int, struct World *, struct WinMeta *, struct Win *, struct Win *, struct Win *, struct Win *);
+
+
+/* Learn from "file" the largest line length (pointed to by "linemax_p"; length
+ * includes newline chars) and (pointed to by "n_lines_p" if it is not set to
+ * NULL) the number of lines (= number of newline chars).
+ *
+ * Returns 0 on success, 1 on error of fseek() (called to return to initial file
+ * reading position).
+ */
+extern uint8_t 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);
+
+
+
+/* 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);
+
+
 
 #endif