Minor code-stylistic revisions to yx_uint16 library.

[plomrogue] / src / yx_uint16.h

diff --git a/src/yx_uint16.h b/src/yx_uint16.h
index eb951a7fd895d959046d3e5078a1ddaed71e74ac..d055a6d4c7a3df45ba1b4de482532bb42156f633 100644 (file)
--- a/src/yx_uint16.h
+++ b/src/yx_uint16.h
@@ -1,13 +1,15 @@
-/*  yx_uint16.h
+/* yx_uint16.h
  *
- *  Structs and routines for coordinates and movement in 2-dimensional space
- *  (such as the ncurses screen and game maps).
+ * Structs and routines for coordinates and movement in 2-dimensional space
+ * (such as the ncurses screen and game maps).
  */
 
 #ifndef YX_UINT16_H
 #define YX_UINT16_H
 
-#include <stdint.h>
+#include <stdint.h> /* for uint8_t, uint16_t */
+
+
 
 /* Coordinates for maps of max. 65536x65536 cells. */
 struct yx_uint16
@@ -16,20 +18,16 @@ struct yx_uint16
     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 1 if two yx_uint16 coordinates at "a" and "b" are equal, else 0. */
+extern uint8_t yx_uint16_cmp(struct yx_uint16 * a, struct yx_uint16 * b);
+
+/* Return yx_uint16 coordinate one step from "yx" in direction "dir" (east: 'E',
+ * west: 'W', north: 'N', south: 'S'). An invalid dir leaves "yx" unchanged.
+ */
+extern struct yx_uint16 mv_yx_in_dir(char dir, struct yx_uint16 yx);
+
 
-/* 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