I can never remember what that `TRUE' means in the game structure
[sgt/puzzles] / fifteen.c
index 9357d65..dc265be 100644 (file)
--- a/fifteen.c
+++ b/fifteen.c
@@ -6,20 +6,19 @@
 #include <stdlib.h>
 #include <string.h>
 #include <assert.h>
+#include <ctype.h>
 #include <math.h>
 
 #include "puzzles.h"
 
-const char *const game_name = "Fifteen";
-
 #define TILE_SIZE 48
 #define BORDER    (TILE_SIZE / 2)
 #define HIGHLIGHT_WIDTH (TILE_SIZE / 20)
 #define COORD(x)  ( (x) * TILE_SIZE + BORDER )
 #define FROMCOORD(x)  ( ((x) - BORDER + TILE_SIZE) / TILE_SIZE - 1 )
 
-#define ANIM_TIME 0.1F
-#define FLASH_FRAME 0.1F
+#define ANIM_TIME 0.13F
+#define FLASH_FRAME 0.13F
 
 #define X(state, i) ( (i) % (state)->w )
 #define Y(state, i) ( (i) / (state)->w )
@@ -42,9 +41,10 @@ struct game_state {
     int *tiles;
     int gap_pos;
     int completed;
+    int movecount;
 };
 
-game_params *default_params(void)
+static game_params *default_params(void)
 {
     game_params *ret = snew(game_params);
 
@@ -53,24 +53,92 @@ game_params *default_params(void)
     return ret;
 }
 
-int game_fetch_preset(int i, char **name, game_params **params)
+static int game_fetch_preset(int i, char **name, game_params **params)
 {
     return FALSE;
 }
 
-void free_params(game_params *params)
+static void free_params(game_params *params)
 {
     sfree(params);
 }
 
-game_params *dup_params(game_params *params)
+static game_params *dup_params(game_params *params)
 {
     game_params *ret = snew(game_params);
     *ret = *params;                   /* structure copy */
     return ret;
 }
 
-int perm_parity(int *perm, int n)
+static game_params *decode_params(char const *string)
+{
+    game_params *ret = default_params();
+
+    ret->w = ret->h = atoi(string);
+    while (*string && isdigit(*string)) string++;
+    if (*string == 'x') {
+        string++;
+        ret->h = atoi(string);
+    }
+
+    return ret;
+}
+
+static char *encode_params(game_params *params)
+{
+    char data[256];
+
+    sprintf(data, "%dx%d", params->w, params->h);
+
+    return dupstr(data);
+}
+
+static config_item *game_configure(game_params *params)
+{
+    config_item *ret;
+    char buf[80];
+
+    ret = snewn(3, config_item);
+
+    ret[0].name = "Width";
+    ret[0].type = C_STRING;
+    sprintf(buf, "%d", params->w);
+    ret[0].sval = dupstr(buf);
+    ret[0].ival = 0;
+
+    ret[1].name = "Height";
+    ret[1].type = C_STRING;
+    sprintf(buf, "%d", params->h);
+    ret[1].sval = dupstr(buf);
+    ret[1].ival = 0;
+
+    ret[2].name = NULL;
+    ret[2].type = C_END;
+    ret[2].sval = NULL;
+    ret[2].ival = 0;
+
+    return ret;
+}
+
+static game_params *custom_params(config_item *cfg)
+{
+    game_params *ret = snew(game_params);
+
+    ret->w = atoi(cfg[0].sval);
+    ret->h = atoi(cfg[1].sval);
+
+    return ret;
+}
+
+static char *validate_params(game_params *params)
+{
+    if (params->w < 2 && params->h < 2)
+       return "Width and height must both be at least two";
+
+    return NULL;
+}
+
+static int perm_parity(int *perm, int n)
 {
     int i, j, ret;
 
@@ -84,7 +152,7 @@ int perm_parity(int *perm, int n)
     return ret;
 }
 
-char *new_game_seed(game_params *params)
+static char *new_game_seed(game_params *params, random_state *rs)
 {
     int gap, n, i, x;
     int x1, x2, p1, p2, parity;
@@ -102,7 +170,7 @@ char *new_game_seed(game_params *params)
         used[i] = FALSE;
     }
 
-    gap = rand_upto(n);
+    gap = random_upto(rs, n);
     tiles[gap] = 0;
     used[0] = TRUE;
 
@@ -110,7 +178,7 @@ char *new_game_seed(game_params *params)
      * Place everything else except the last two tiles.
      */
     for (x = 0, i = n-1; i > 2; i--) {
-        int k = rand_upto(i);
+        int k = random_upto(rs, i);
         int j;
 
         for (j = 0; j < n; j++)
@@ -152,15 +220,16 @@ char *new_game_seed(game_params *params)
      * Determine the required parity of the overall permutation.
      * This is the XOR of:
      * 
-     *  - The chessboard parity ((x^y)&1) of the gap square. The
-     *    bottom right, and therefore also the top left, count as
-     *    even.
+     *         - The chessboard parity ((x^y)&1) of the gap square. The
+     *           bottom right counts as even.
      * 
      *  - The parity of n. (The target permutation is 1,...,n-1,0
      *    rather than 0,...,n-1; this is a cyclic permutation of
      *    the starting point and hence is odd iff n is even.)
      */
-    parity = (X(params, gap) ^ Y(params, gap) ^ (n+1)) & 1;
+    parity = ((X(params, gap) - (params->w-1)) ^
+             (Y(params, gap) - (params->h-1)) ^
+             (n+1)) & 1;
 
     /*
      * Try the last two tiles one way round. If that fails, swap
@@ -198,7 +267,58 @@ char *new_game_seed(game_params *params)
     return ret;
 }
 
-game_state *new_game(game_params *params, char *seed)
+static char *validate_seed(game_params *params, char *seed)
+{
+    char *p, *err;
+    int i, area;
+    int *used;
+
+    area = params->w * params->h;
+    p = seed;
+    err = NULL;
+
+    used = snewn(area, int);
+    for (i = 0; i < area; i++)
+       used[i] = FALSE;
+
+    for (i = 0; i < area; i++) {
+       char *q = p;
+       int n;
+
+       if (*p < '0' || *p > '9') {
+           err = "Not enough numbers in string";
+           goto leave;
+       }
+       while (*p >= '0' && *p <= '9')
+           p++;
+       if (i < area-1 && *p != ',') {
+           err = "Expected comma after number";
+           goto leave;
+       }
+       else if (i == area-1 && *p) {
+           err = "Excess junk at end of string";
+           goto leave;
+       }
+       n = atoi(q);
+       if (n < 0 || n >= area) {
+           err = "Number out of range";
+           goto leave;
+       }
+       if (used[n]) {
+           err = "Number used twice";
+           goto leave;
+       }
+       used[n] = TRUE;
+
+       if (*p) p++;                   /* eat comma */
+    }
+
+    leave:
+    sfree(used);
+    return err;
+}
+
+static game_state *new_game(game_params *params, char *seed)
 {
     game_state *state = snew(game_state);
     int i;
@@ -224,12 +344,12 @@ game_state *new_game(game_params *params, char *seed)
     assert(!*p);
     assert(state->tiles[state->gap_pos] == 0);
 
-    state->completed = FALSE;
+    state->completed = state->movecount = 0;
 
     return state;
 }
 
-game_state *dup_game(game_state *state)
+static game_state *dup_game(game_state *state)
 {
     game_state *ret = snew(game_state);
 
@@ -240,16 +360,27 @@ game_state *dup_game(game_state *state)
     memcpy(ret->tiles, state->tiles, state->w * state->h * sizeof(int));
     ret->gap_pos = state->gap_pos;
     ret->completed = state->completed;
+    ret->movecount = state->movecount;
 
     return ret;
 }
 
-void free_game(game_state *state)
+static void free_game(game_state *state)
 {
     sfree(state);
 }
 
-game_state *make_move(game_state *from, int x, int y, int button)
+static game_ui *new_ui(game_state *state)
+{
+    return NULL;
+}
+
+static void free_ui(game_ui *ui)
+{
+}
+
+static game_state *make_move(game_state *from, game_ui *ui,
+                            int x, int y, int button)
 {
     int gx, gy, dx, dy, ux, uy, up, p;
     game_state *ret;
@@ -297,16 +428,17 @@ game_state *make_move(game_state *from, int x, int y, int button)
     for (p = from->gap_pos; p != ret->gap_pos; p += up) {
         assert(p >= 0 && p < from->n);
         ret->tiles[p] = from->tiles[p + up];
+       ret->movecount++;
     }
 
     /*
      * See if the game has been completed.
      */
     if (!ret->completed) {
-        ret->completed = TRUE;
+        ret->completed = ret->movecount;
         for (p = 0; p < ret->n; p++)
             if (ret->tiles[p] != (p < ret->n-1 ? p+1 : 0))
-                ret->completed = FALSE;
+                ret->completed = 0;
     }
 
     return ret;
@@ -322,13 +454,13 @@ struct game_drawstate {
     int *tiles;
 };
 
-void game_size(game_params *params, int *x, int *y)
+static void game_size(game_params *params, int *x, int *y)
 {
     *x = TILE_SIZE * params->w + 2 * BORDER;
     *y = TILE_SIZE * params->h + 2 * BORDER;
 }
 
-float *game_colours(frontend *fe, game_state *state, int *ncolours)
+static float *game_colours(frontend *fe, game_state *state, int *ncolours)
 {
     float *ret = snewn(3 * NCOLOURS, float);
     int i;
@@ -359,7 +491,7 @@ float *game_colours(frontend *fe, game_state *state, int *ncolours)
     return ret;
 }
 
-game_drawstate *game_new_drawstate(game_state *state)
+static game_drawstate *game_new_drawstate(game_state *state)
 {
     struct game_drawstate *ds = snew(struct game_drawstate);
     int i;
@@ -375,7 +507,7 @@ game_drawstate *game_new_drawstate(game_state *state)
     return ds;
 }
 
-void game_free_drawstate(game_drawstate *ds)
+static void game_free_drawstate(game_drawstate *ds)
 {
     sfree(ds->tiles);
     sfree(ds);
@@ -417,8 +549,9 @@ static void draw_tile(frontend *fe, game_state *state, int x, int y,
     draw_update(fe, x, y, TILE_SIZE, TILE_SIZE);
 }
 
-void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
-                 game_state *state, float animtime, float flashtime)
+static void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
+                 game_state *state, int dir, game_ui *ui,
+                 float animtime, float flashtime)
 {
     int i, pass, bgcolour;
 
@@ -544,17 +677,76 @@ void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
         }
     }
     ds->bgcolour = bgcolour;
+
+    /*
+     * Update the status bar.
+     */
+    {
+       char statusbuf[256];
+
+        /*
+         * Don't show the new status until we're also showing the
+         * new _state_ - after the game animation is complete.
+         */
+        if (oldstate)
+            state = oldstate;
+
+       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)
+static float game_anim_length(game_state *oldstate,
+                             game_state *newstate, int dir)
 {
     return ANIM_TIME;
 }
 
-float game_flash_length(game_state *oldstate, game_state *newstate)
+static float game_flash_length(game_state *oldstate,
+                              game_state *newstate, int dir)
 {
     if (!oldstate->completed && newstate->completed)
         return 2 * FLASH_FRAME;
     else
         return 0.0F;
 }
+
+static int game_wants_statusbar(void)
+{
+    return TRUE;
+}
+
+#ifdef COMBINED
+#define thegame fifteen
+#endif
+
+const struct game thegame = {
+    "Fifteen", "games.fifteen",
+    default_params,
+    game_fetch_preset,
+    decode_params,
+    encode_params,
+    free_params,
+    dup_params,
+    TRUE, game_configure, custom_params,
+    validate_params,
+    new_game_seed,
+    validate_seed,
+    new_game,
+    dup_game,
+    free_game,
+    new_ui,
+    free_ui,
+    make_move,
+    game_size,
+    game_colours,
+    game_new_drawstate,
+    game_free_drawstate,
+    game_redraw,
+    game_anim_length,
+    game_flash_length,
+    game_wants_statusbar,
+};