Added a help file, mostly thanks to Jacob.
[sgt/puzzles] / cube.c
diff --git a/cube.c b/cube.c
index 6fef4d1..72ac527 100644 (file)
--- a/cube.c
+++ b/cube.c
@@ -6,11 +6,14 @@
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
+#include <ctype.h>
 #include <math.h>
 
 #include "puzzles.h"
 
 const char *const game_name = "Cube";
+const char *const game_winhelp_topic = "games.cube";
+const int game_can_configure = TRUE;
 
 #define MAXVERTICES 20
 #define MAXFACES 20
@@ -159,7 +162,7 @@ enum {
 enum { LEFT, RIGHT, UP, DOWN, UP_LEFT, UP_RIGHT, DOWN_LEFT, DOWN_RIGHT };
 
 #define GRID_SCALE 48.0F
-#define ROLLTIME 0.1F
+#define ROLLTIME 0.13F
 
 #define SQ(x) ( (x) * (x) )
 
@@ -238,8 +241,8 @@ int game_fetch_preset(int i, char **name, game_params **params)
       case 1:
         str = "Tetrahedron";
         ret->solid = TETRAHEDRON;
-        ret->d1 = 2;
-        ret->d2 = 1;
+        ret->d1 = 1;
+        ret->d2 = 2;
         break;
       case 2:
         str = "Octahedron";
@@ -275,6 +278,37 @@ game_params *dup_params(game_params *params)
     return ret;
 }
 
+game_params *decode_params(char const *string)
+{
+    game_params *ret = default_params();
+
+    switch (*string) {
+      case 't': ret->solid = TETRAHEDRON; string++; break;
+      case 'c': ret->solid = CUBE;        string++; break;
+      case 'o': ret->solid = OCTAHEDRON;  string++; break;
+      case 'i': ret->solid = ICOSAHEDRON; string++; break;
+      default: break;
+    }
+    ret->d1 = ret->d2 = atoi(string);
+    while (*string && isdigit(*string)) string++;
+    if (*string == 'x') {
+        string++;
+        ret->d2 = atoi(string);
+    }
+
+    return ret;
+}
+
+char *encode_params(game_params *params)
+{
+    char data[256];
+
+    assert(params->solid >= 0 && params->solid < 4);
+    sprintf(data, "%c%dx%d", "tcoi"[params->solid], params->d1, params->d2);
+
+    return dupstr(data);
+}
+
 static void enum_grid_squares(game_params *params,
                               void (*callback)(void *, struct grid_square *),
                               void *ctx)
@@ -284,8 +318,8 @@ static void enum_grid_squares(game_params *params,
     if (solid->order == 4) {
         int x, y;
 
-        for (x = 0; x < params->d1; x++)
-            for (y = 0; y < params->d2; y++) {
+       for (y = 0; y < params->d2; y++)
+           for (x = 0; x < params->d1; x++) {
                 struct grid_square sq;
 
                 sq.x = (float)x;
@@ -324,12 +358,12 @@ static void enum_grid_squares(game_params *params,
         float theight = (float)(sqrt(3) / 2.0);
 
         for (row = 0; row < params->d1 + params->d2; row++) {
-            if (row < params->d1) {
+            if (row < params->d2) {
                 other = +1;
-                rowlen = row + params->d2;
+                rowlen = row + params->d1;
             } else {
                 other = -1;
-                rowlen = 2*params->d1 + params->d2 - row;
+                rowlen = 2*params->d2 + params->d1 - row;
             }
 
             /*
@@ -415,7 +449,7 @@ static void enum_grid_squares(game_params *params,
                 sq.flip = FALSE;
 
                 if (firstix < 0)
-                    firstix = ix;
+                    firstix = (ix - 1) & 3;
                 ix -= firstix;
                 sq.tetra_class = ((row+(ix&1)) & 2) ^ (ix & 3);
 
@@ -443,6 +477,99 @@ static int grid_area(int d1, int d2, int order)
         return d1*d1 + d2*d2 + 4*d1*d2;
 }
 
+config_item *game_configure(game_params *params)
+{
+    config_item *ret = snewn(4, config_item);
+    char buf[80];
+
+    ret[0].name = "Type of solid";
+    ret[0].type = C_CHOICES;
+    ret[0].sval = ":Tetrahedron:Cube:Octahedron:Icosahedron";
+    ret[0].ival = params->solid;
+
+    ret[1].name = "Width / top";
+    ret[1].type = C_STRING;
+    sprintf(buf, "%d", params->d1);
+    ret[1].sval = dupstr(buf);
+    ret[1].ival = 0;
+
+    ret[2].name = "Height / bottom";
+    ret[2].type = C_STRING;
+    sprintf(buf, "%d", params->d2);
+    ret[2].sval = dupstr(buf);
+    ret[2].ival = 0;
+
+    ret[3].name = NULL;
+    ret[3].type = C_END;
+    ret[3].sval = NULL;
+    ret[3].ival = 0;
+
+    return ret;
+}
+
+game_params *custom_params(config_item *cfg)
+{
+    game_params *ret = snew(game_params);
+
+    ret->solid = cfg[0].ival;
+    ret->d1 = atoi(cfg[1].sval);
+    ret->d2 = atoi(cfg[2].sval);
+
+    return ret;
+}
+
+static void count_grid_square_callback(void *ctx, struct grid_square *sq)
+{
+    int *classes = (int *)ctx;
+    int thisclass;
+
+    if (classes[4] == 4)
+       thisclass = sq->tetra_class;
+    else if (classes[4] == 2)
+       thisclass = sq->flip;
+    else
+       thisclass = 0;
+
+    classes[thisclass]++;
+}
+
+char *validate_params(game_params *params)
+{
+    int classes[5];
+    int i;
+
+    if (params->solid < 0 || params->solid >= lenof(solids))
+       return "Unrecognised solid type";
+
+    if (solids[params->solid]->order == 4) {
+       if (params->d1 <= 0 || params->d2 <= 0)
+           return "Both grid dimensions must be greater than zero";
+    } else {
+       if (params->d1 <= 0 && params->d2 <= 0)
+           return "At least one grid dimension must be greater than zero";
+    }
+
+    for (i = 0; i < 4; i++)
+       classes[i] = 0;
+    if (params->solid == TETRAHEDRON)
+       classes[4] = 4;
+    else if (params->solid == OCTAHEDRON)
+       classes[4] = 2;
+    else
+       classes[4] = 1;
+    enum_grid_squares(params, count_grid_square_callback, classes);
+
+    for (i = 0; i < classes[4]; i++)
+       if (classes[i] < solids[params->solid]->nfaces / classes[4])
+           return "Not enough grid space to place all blue faces";
+
+    if (grid_area(params->d1, params->d2, solids[params->solid]->order) <
+       solids[params->solid]->nfaces + 1)
+       return "Not enough space to place the solid on an empty square";
+
+    return NULL;
+}
+
 struct grid_data {
     int *gridptrs[4];
     int nsquares[4];
@@ -466,7 +593,7 @@ static void classify_grid_square_callback(void *ctx, struct grid_square *sq)
        data->squareindex++;
 }
 
-char *new_game_seed(game_params *params)
+char *new_game_seed(game_params *params, random_state *rs)
 {
     struct grid_data data;
     int i, j, k, m, area, facesperclass;
@@ -511,7 +638,7 @@ char *new_game_seed(game_params *params)
 
     for (i = 0; i < data.nclasses; i++) {
        for (j = 0; j < facesperclass; j++) {
-            int n = rand_upto(data.nsquares[i]);
+            int n = random_upto(rs, data.nsquares[i]);
 
            assert(!flags[data.gridptrs[i][n]]);
            flags[data.gridptrs[i][n]] = TRUE;
@@ -559,7 +686,7 @@ char *new_game_seed(game_params *params)
     /*
      * Choose a non-blue square for the polyhedron.
      */
-    sprintf(p, ":%d", rand_upto(m));
+    sprintf(p, ",%d", data.gridptrs[0][random_upto(rs, m)]);
 
     sfree(data.gridptrs[0]);
     sfree(flags);
@@ -715,6 +842,34 @@ static struct solid *transform_poly(const struct solid *solid, int flip,
     return ret;
 }
 
+char *validate_seed(game_params *params, char *seed)
+{
+    int area = grid_area(params->d1, params->d2, solids[params->solid]->order);
+    int i, j;
+
+    i = (area + 3) / 4;
+    for (j = 0; j < i; j++) {
+       int c = seed[j];
+       if (c >= '0' && c <= '9') continue;
+       if (c >= 'A' && c <= 'F') continue;
+       if (c >= 'a' && c <= 'f') continue;
+       return "Not enough hex digits at start of string";
+       /* NB if seed[j]=='\0' that will also be caught here, so we're safe */
+    }
+
+    if (seed[i] != ',')
+       return "Expected ',' after hex digits";
+
+    i++;
+    do {
+       if (seed[i] < '0' || seed[i] > '9')
+           return "Expected decimal integer after ','";
+       i++;
+    } while (seed[i]);
+
+    return NULL;
+}
+
 game_state *new_game(game_params *params, char *seed)
 {
     game_state *state = snew(game_state);
@@ -761,7 +916,7 @@ game_state *new_game(game_params *params, char *seed)
                j = 8;
        }
 
-       if (*p == ':')
+       if (*p == ',')
            p++;
 
        state->current = atoi(p);
@@ -788,7 +943,7 @@ game_state *new_game(game_params *params, char *seed)
 
     state->previous = state->current;
     state->angle = 0.0;
-    state->completed = FALSE;
+    state->completed = 0;
     state->movecount = 0;
 
     return state;
@@ -828,7 +983,16 @@ void free_game(game_state *state)
     sfree(state);
 }
 
-game_state *make_move(game_state *from, int x, int y, int button)
+game_ui *new_ui(game_state *state)
+{
+    return NULL;
+}
+
+void free_ui(game_ui *ui)
+{
+}
+
+game_state *make_move(game_state *from, game_ui *ui, int x, int y, int button)
 {
     int direction;
     int pkey[2], skey[2], dkey[2];
@@ -1046,6 +1210,8 @@ game_state *make_move(game_state *from, int x, int y, int button)
         ret->facecolours = newcolours;
     }
 
+    ret->movecount++;
+
     /*
      * And finally, swap the colour between the bottom face of the
      * polyhedron and the face we've just landed on.
@@ -1068,7 +1234,7 @@ game_state *make_move(game_state *from, int x, int y, int button)
             if (ret->facecolours[i])
                 j++;
         if (j == ret->solid->nfaces)
-            ret->completed = TRUE;
+            ret->completed = ret->movecount;
     }
 
     sfree(poly);
@@ -1097,7 +1263,6 @@ game_state *make_move(game_state *from, int x, int y, int button)
     ret->sgkey[1] = skey[1];
     ret->previous = from->current;
     ret->angle = angle;
-    ret->movecount++;
 
     return ret;
 }
@@ -1186,7 +1351,8 @@ void game_free_drawstate(game_drawstate *ds)
 }
 
 void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
-                 game_state *state, float animtime, float flashtime)
+                 game_state *state, game_ui *ui,
+                 float animtime, float flashtime)
 {
     int i, j;
     struct bbox bb = find_bbox(&state->params);
@@ -1293,8 +1459,8 @@ void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
         }
 
         for (j = 0; j < poly->order; j++) {
-            coords[j*2] = (int)(points[j*2] * GRID_SCALE) + ds->ox;
-            coords[j*2+1] = (int)(points[j*2+1] * GRID_SCALE) + ds->oy;
+            coords[j*2] = (int)floor(points[j*2] * GRID_SCALE) + ds->ox;
+            coords[j*2+1] = (int)floor(points[j*2+1] * GRID_SCALE) + ds->oy;
         }
 
         /*
@@ -1329,6 +1495,19 @@ void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
 
     draw_update(fe, 0, 0, (int)((bb.r-bb.l+2.0F) * GRID_SCALE),
                 (int)((bb.d-bb.u+2.0F) * GRID_SCALE));
+
+    /*
+     * Update the status bar.
+     */
+    {
+       char statusbuf[256];
+
+       sprintf(statusbuf, "%sMoves: %d",
+               (state->completed ? "COMPLETED! " : ""),
+               (state->completed ? state->completed : state->movecount));
+
+       status_bar(fe, statusbuf);
+    }
 }
 
 float game_anim_length(game_state *oldstate, game_state *newstate)
@@ -1340,3 +1519,8 @@ float game_flash_length(game_state *oldstate, game_state *newstate)
 {
     return 0.0F;
 }
+
+int game_wants_statusbar(void)
+{
+    return TRUE;
+}