More code re-styling and documentation.

[plomrogue] / src / yx_uint16.h

diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index c1479c0054c1c035b03b437c190fed0253514f77..eb951a7fd895d959046d3e5078a1ddaed71e74ac 100644 (file)
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,6 +1,35 @@
-struct yx_uint16 {
-  uint16_t y;
-  uint16_t x; };
+/*  yx_uint16.h
+ *
+ *  Structs and routines for coordinates and movement in 2-dimensional space
+ *  (such as the ncurses screen and game maps).
+ */
 
-extern char yx_uint16_cmp (struct yx_uint16, struct yx_uint16);
+#ifndef YX_UINT16_H
+#define YX_UINT16_H
 
+#include <stdint.h>
+
+/* Coordinates for maps of max. 65536x65536 cells. */
+struct yx_uint16
+{
+    uint16_t y;
+    uint16_t x;
+};
+
+/* This encodes directions. */
+
+enum dir
+{
+    NORTH = 1,
+    EAST  = 2,
+    SOUTH = 3,
+    WEST  = 4
+};
+
+/* Return 1 if two yx_uint16 coordinates a and b are equal, else 0. */
+extern char yx_uint16_cmp(struct yx_uint16 a, struct yx_uint16 b);
+
+/* Return yx_uint16 coordinate one step from coordinate yx in direction dir. */
+extern struct yx_uint16 mv_yx_in_dir(enum dir d, struct yx_uint16 yx);
+
+#endif