Small change of plans, moved stuff around

9 files changed, 118 insertions, 109 deletions

diff --git a/doc/CUBE_INTERNAL.md b/doc/CUBE_INTERNAL.md
new file mode 100644
index 0000000..fd3148a
--- /dev/null
+++ b/doc/CUBE_INTERNAL.md
@@ -0,0 +1,24 @@
+# Internal representation of the cube
+
+The plan (TODO) is to have multiple implementations: some that
+take advantage of advanced CPU instructions (SIMD) and a fallback
+"array" representation that works on any architecture.
+
+# Array representation (fallback)
+
+In this implementation of the cube.h interface, the cube is represented
+by two arrays of 8-bit unsigned integers, one for centers and one for
+corners.  The 4 leas-significant digits of each bit determine the piece,
+the other 4 are used for orientation or kept to 0.
+
+Edges:
+        xxxopppp (x = unused, o = orientation, p = piece)
+
+Corners:
+        xooxpppp (x = unused, o = orientation, p = piece)
+
+The two bits for CO are shifted to make it possible to perform mod 3
+operations (sum, inverse) using only addition and bitwise operators.
+See below for details.
+
+The third bit is needed because x+y+1 can exceed 4.
diff --git a/utils/FORMAT.txt b/doc/CUBE_TEXT.md
index 5bfb01e..b9234fc 100644
--- a/utils/FORMAT.txt
+++ b/doc/CUBE_TEXT.md
@@ -1,8 +1,10 @@
+# Textual representation of the cube
+
 The functions readcube() and writecube() use different formats to read
 and write a cube to text. Not all formats are supported for both input
 and output.
 
-# H48 - standard format for h48 (read, write)
+## H48 - standard format for h48 (read, write)
 
 Each edge is represented by two letters denoting the sides it belongs to
 and one number denoting its orientation (0 oriented, 1 mis-oriented).
@@ -25,7 +27,7 @@ The cube after the moves R'U'F looks like this:
 FL1 BR0 DB0 UR1 UF0 UB0 DL0 FR0 UL1 DF1 BL0 DR0
 UBL1 DBR1 UFR2 DFR2 DFL2 UBL2 UFL2 DBL0
 
-# SRC - representation of the object in C code for cube_array (write)
+## SRC - representation of the object in C code for cube_array (write)
 
 The exact format depends on the internal cube representation. It is
 guaranteed that, if OUT is the output in this format, the line
diff --git a/utils/TRANSFORMATIONS.txt b/doc/TRANSFORMATIONS.md
index 58446e8..58446e8 100644
--- a/utils/TRANSFORMATIONS.txt
+++ b/doc/TRANSFORMATIONS.md
diff --git a/src/constants.h b/src/constants.h
deleted file mode 100644
index 9e0a7a7..0000000
--- a/src/constants.h
+++ /dev/null
@@ -1,75 +0,0 @@
-/* Standard moves */
-#define U  0U
-#define U2 1U
-#define U3 2U
-#define D  3U
-#define D2 4U
-#define D3 5U
-#define R  6U
-#define R2 7U
-#define R3 8U
-#define L  9U
-#define L2 10U
-#define L3 11U
-#define F  12U
-#define F2 13U
-#define F3 14U
-#define B  15U
-#define B2 16U
-#define B3 17U
-
-/* Regular transformations (rotations) */
-#define UFr 0
-#define ULr 1
-#define UBr 2
-#define URr 3
-#define DFr 4
-#define DLr 5
-#define DBr 6
-#define DRr 7
-#define RUr 8
-#define RFr 9
-#define RDr 10
-#define RBr 11
-#define LUr 12
-#define LFr 13
-#define LDr 14
-#define LBr 15
-#define FUr 16
-#define FRr 17
-#define FDr 18
-#define FLr 19
-#define BUr 20
-#define BRr 21
-#define BDr 22
-#define BLr 23
-
-/* Mirrored transformations */
-#define UFm 24
-#define ULm 25
-#define UBm 26
-#define URm 27
-#define DFm 28
-#define DLm 29
-#define DBm 30
-#define DRm 31
-#define RUm 32
-#define RFm 33
-#define RDm 34
-#define RBm 35
-#define LUm 36
-#define LFm 37
-#define LDm 38
-#define LBm 39
-#define FUm 40
-#define FRm 41
-#define FDm 42
-#define FLm 43
-#define BUm 44
-#define BRm 45
-#define BDm 46
-#define BLm 47
-
-/* Errors */
-#define errormove 99U
-#define errortrans 99U
diff --git a/src/cube_array.c b/src/cube.c
index cbf59e4..f6e6a8f 100644
--- a/src/cube_array.c
+++ b/src/cube.c
@@ -1,22 +1,3 @@
-/*
-In this implementation of the cube.h interface, the cube is represented
-by two arrays of 8-bit unsigned integers, one for centers and one for
-corners.  The 4 leas-significant digits of each bit determine the piece,
-the other 4 are used for orientation or kept to 0.
-
-Edges:
-        xxxopppp (x = unused, o = orientation, p = piece)
-
-Corners:
-        xooxpppp (x = unused, o = orientation, p = piece)
-
-The two bits for CO are shifted to make it possible to perform mod 3
-operations (sum, inverse) using only addition and bitwise operators.
-See below for details.
-
-The third bit is needed because x+y+1 can exceed 4.
-*/
-
 #include <inttypes.h>
 #include <stdbool.h>
 #include <string.h>
@@ -25,7 +6,6 @@ The third bit is needed because x+y+1 can exceed 4.
 #include <stdio.h>
 #endif
 
-#include "constants.h"
 #include "cube.h"
 
 #define _c_ufr      0U
diff --git a/src/cube.h b/src/cube.h
index 67f04bf..cac6b01 100644
--- a/src/cube.h
+++ b/src/cube.h
@@ -1,14 +1,99 @@
+/* Constants *****************************************************************/
+
+/* Standard moves */
+#define U  0U
+#define U2 1U
+#define U3 2U
+#define D  3U
+#define D2 4U
+#define D3 5U
+#define R  6U
+#define R2 7U
+#define R3 8U
+#define L  9U
+#define L2 10U
+#define L3 11U
+#define F  12U
+#define F2 13U
+#define F3 14U
+#define B  15U
+#define B2 16U
+#define B3 17U
+
+/* Regular transformations (rotations) */
+#define UFr 0
+#define ULr 1
+#define UBr 2
+#define URr 3
+#define DFr 4
+#define DLr 5
+#define DBr 6
+#define DRr 7
+#define RUr 8
+#define RFr 9
+#define RDr 10
+#define RBr 11
+#define LUr 12
+#define LFr 13
+#define LDr 14
+#define LBr 15
+#define FUr 16
+#define FRr 17
+#define FDr 18
+#define FLr 19
+#define BUr 20
+#define BRr 21
+#define BDr 22
+#define BLr 23
+
+/* Mirrored transformations */
+#define UFm 24
+#define ULm 25
+#define UBm 26
+#define URm 27
+#define DFm 28
+#define DLm 29
+#define DBm 30
+#define DRm 31
+#define RUm 32
+#define RFm 33
+#define RDm 34
+#define RBm 35
+#define LUm 36
+#define LFm 37
+#define LDm 38
+#define LBm 39
+#define FUm 40
+#define FRm 41
+#define FDm 42
+#define FLm 43
+#define BUm 44
+#define BRm 45
+#define BDm 46
+#define BLm 47
+
+/* Errors */
+#define errormove 99U
+#define errortrans 99U
+
+/* Types *********************************************************************/
+
 /* TODO: ifdef for different implementations */
-#include "cube_array.h"
+/* See doc/CUBE_INTERNAL.md for a description of the cube format */
+typedef struct {
+        uint8_t c[8];
+        uint8_t e[12];
+} cube_t;
 
-/* For moves and transformations, see constants.h */
 typedef uint8_t move_t;
 typedef uint8_t trans_t;
 
 extern cube_t solvedcube;
 
+/* Functions *****************************************************************/
+
 /* Not all formats are supported for both read and write. */
-/* See utils/FORMAT.txt for details. */
+/* See doc/CUBE_TEXT.md for details. */
 typedef enum {H48, SRC} format_t;
 cube_t readcube(format_t, char *);
 void writecube(format_t, cube_t, char *);
@@ -28,5 +113,5 @@ cube_t move(cube_t, move_t);
 cube_t inverse(cube_t);
 cube_t compose(cube_t, cube_t);
 
-/* See utils/TRANSFORMATIONS.txt for how transformations are applied */
+/* See doc/TRANSFORMATIONS.md for how transformations are applied */
 cube_t transform(cube_t, trans_t);
diff --git a/src/cube_array.h b/src/cube_array.h
deleted file mode 100644
index 6d9603b..0000000
--- a/src/cube_array.h
+++ /dev/null
@@ -1,6 +0,0 @@
-/* Public properties specific to the array implementation */
-
-typedef struct {
-        uint8_t c[8];
-        uint8_t e[12];
-} cube_t;
diff --git a/test/05_transform/transform_tests.c b/test/05_transform/transform_tests.c
index c648662..1e49037 100644
--- a/test/05_transform/transform_tests.c
+++ b/test/05_transform/transform_tests.c
@@ -3,7 +3,6 @@
 #include <stdio.h>
 
 #include "../../src/cube.h"
-#include "../../src/constants.h"
 
 #define STRLENMAX 10000
 
diff --git a/test/test.sh b/test/test.sh
index 9eae127..00dd5ce 100755
--- a/test/test.sh
+++ b/test/test.sh
@@ -5,7 +5,7 @@ CC="cc -DDEBUG -std=c99 -pthread -pedantic -Wall -Wextra \
 if [ $(uname) != "OpenBSD" ]; then
         CC="$CC -fsanitize=address -fsanitize=undefined"
 fi
-SRC="src/cube_array.c"
+SRC="src/cube.c"
 TESTBIN="test/run"
 TESTOUT="test/last.out"
 TESTERR="test/last.err"