home · contact · privacy
More consistent code styling whitespace rules.
[plomrogue] / src / yx_uint16.h
index 2a5b3ac4095c0d0ce7beadf8777a88cf5a79da2b..188e553e0014b820bf7e2e0dfa783913abb1bf27 100644 (file)
@@ -7,8 +7,6 @@
 #ifndef YX_UINT16_H
 #define YX_UINT16_H
 
-
-
 #include <stdint.h> /* for uint8_t, uint16_t */
 
 
@@ -20,19 +18,18 @@ struct yx_uint16
     uint16_t x;
 };
 
-/* Directions available for movement. */
-enum dir
-{
-    NORTH = 1,
-    EAST,
-    SOUTH,
-    WEST
-};
 
-/* Return 1 if two yx_uint16 coordinates 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 coordinate yx in direction dir. */
-extern struct yx_uint16 mv_yx_in_dir(enum dir d, struct yx_uint16 yx);
+/* 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 coordinate yx in direction "dir"
+ * (east: 'E', west: 'W', north: 'N', south: 'S').
+ *
+ * If an invalid dir "d" is passed, "yx" remains unchanged.
+ */
+extern struct yx_uint16 mv_yx_in_dir(char dir, struct yx_uint16 yx);
+
+
 
 #endif