Fixed bug that led to endless loop in nearest_enemy_dir().

[plomrogue] / src / misc.h

diff --git a/src/misc.h b/src/misc.h
index 5bccd401394cec7e86393eec2e4bbc7d122e2f7c..80bb1cd1bfa4057612726ac165a1fc92f07e8095 100644 (file)
--- a/src/misc.h
+++ b/src/misc.h
@@ -1,20 +1,61 @@
+/* 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>
-
-struct World;
-struct WinMeta;
-struct Win;
-
-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 unsigned char meta_keys(int, struct World *, struct WinMeta *, struct Win *, struct Win *, struct Win *, struct Win *);
+#include <stdlib.h>    /* for size_t */
+#include <stdint.h>    /* for uint16_t */
+#include "yx_uint16.h" /* for yx_uint16 coordinates */
+struct Map;
+
+
+
+/* Return 16-bit number pseudo-randomly generated via Linear Congruential
+ * Generator algorithm with some proven constants. Use instead of rand() to
+ * ensure portability of the same pseudo-randomness across systems.
+ */
+extern uint16_t rrand();
+
+/* Wrappers to malloc(), calloc() from function "f"; exit_trouble() on error. */
+extern void * try_malloc(size_t size, char * f);
+extern void * try_calloc(size_t nmemb, size_t size, char * f);
+
+/* If one and only one of files at "p1", "p2" exists, fail with explanation. */
+extern void check_files_xor(char * p1, char * p2);
+
+/* Check if tempfile "path" exists, and if so, exit with explanation that. */
+extern void check_tempfile(char * path);
+
+/* Save / load / unload (free) / reload interface configuration data. */
+extern void save_interface_conf();
+extern void load_interface_conf();
+extern void unload_interface_conf();
+extern void reload_interface_conf();
+
+/* Append "text" to game log, or a "." if "text" is the same as the last one. */
+extern void update_log(char * text);
+
+/* Return offset nto center map of "mapsize" on "position" in "framesize". */
+extern uint16_t center_offset(uint16_t position,
+                              uint16_t mapsize, uint16_t framesize);
+
+/* Record "action" in record file, do all movements until player's next turn. */
+extern void turn_over(char action);
+
+/* Save or load current game data to / from file "savefile". */
+extern void save_game();
+extern void load_game();
+
+/* Return random passable (as by is_passable()) position on "map". */
+extern struct yx_uint16 find_passable_pos(struct Map * map);
+
+/* Move world.inventory_sel up ("dir"="u") or down (else) as far as possible. */
+extern void nav_inventory(char dir);
+
+
 
 #endif