Change of policy on game_changed_state(). Originally, it was called
[sgt/puzzles] / net.c
diff --git a/net.c b/net.c
index 6143719..4fada1c 100644 (file)
--- a/net.c
+++ b/net.c
@@ -77,11 +77,6 @@ struct game_params {
     float barrier_probability;
 };
 
-struct game_aux_info {
-    int width, height;
-    unsigned char *tiles;
-};
-
 struct game_state {
     int width, height, wrapping, completed;
     int last_rotate_x, last_rotate_y, last_rotate_dir;
@@ -298,7 +293,7 @@ static game_params *custom_params(config_item *cfg)
     return ret;
 }
 
-static char *validate_params(game_params *params)
+static char *validate_params(game_params *params, int full)
 {
     if (params->width <= 0 || params->height <= 0)
        return "Width and height must both be greater than zero";
@@ -352,7 +347,7 @@ static char *validate_params(game_params *params)
      * is at least 2^(number of such rows), and in particular is at
      * least 2 since there must be at least one such row. []
      */
-    if (params->unique && params->wrapping &&
+    if (full && params->unique && params->wrapping &&
         (params->width == 2 || params->height == 2))
         return "No wrapping puzzle with a width or height of 2 can have"
         " a unique solution";
@@ -1139,7 +1134,7 @@ static void perturb(int w, int h, unsigned char *tiles, int wrapping,
 }
 
 static char *new_game_desc(game_params *params, random_state *rs,
-                          game_aux_info **aux, int interactive)
+                          char **aux, int interactive)
 {
     tree234 *possibilities, *barriertree;
     int w, h, x, y, cx, cy, nbarriers;
@@ -1401,16 +1396,16 @@ static char *new_game_desc(game_params *params, random_state *rs,
     }
 
     /*
-     * Save the unshuffled grid in an aux_info.
+     * Save the unshuffled grid in aux.
      */
     {
-       game_aux_info *solution;
+       char *solution;
+        int i;
 
-       solution = snew(game_aux_info);
-       solution->width = w;
-       solution->height = h;
-       solution->tiles = snewn(w * h, unsigned char);
-       memcpy(solution->tiles, tiles, w * h);
+       solution = snewn(w * h + 1, char);
+        for (i = 0; i < w * h; i++)
+            solution[i] = "0123456789abcdef"[tiles[i] & 0xF];
+        solution[w*h] = '\0';
 
        *aux = solution;
     }
@@ -1515,12 +1510,6 @@ static char *new_game_desc(game_params *params, random_state *rs,
     return desc;
 }
 
-static void game_free_aux_info(game_aux_info *aux)
-{
-    sfree(aux->tiles);
-    sfree(aux);
-}
-
 static char *validate_desc(game_params *params, char *desc)
 {
     int w = params->width, h = params->height;
@@ -1666,28 +1655,96 @@ static void free_game(game_state *state)
     sfree(state);
 }
 
-static game_state *solve_game(game_state *state, game_aux_info *aux,
-                             char **error)
+static char *solve_game(game_state *state, game_state *currstate,
+                       char *aux, char **error)
 {
-    game_state *ret;
+    unsigned char *tiles;
+    char *ret;
+    int retlen, retsize;
+    int i;
+
+    tiles = snewn(state->width * state->height, unsigned char);
 
     if (!aux) {
        /*
         * Run the internal solver on the provided grid. This might
         * not yield a complete solution.
         */
-       ret = dup_game(state);
-       net_solver(ret->width, ret->height, ret->tiles,
-                  ret->barriers, ret->wrapping);
+       memcpy(tiles, state->tiles, state->width * state->height);
+       net_solver(state->width, state->height, tiles,
+                  state->barriers, state->wrapping);
     } else {
-       assert(aux->width == state->width);
-       assert(aux->height == state->height);
-       ret = dup_game(state);
-       memcpy(ret->tiles, aux->tiles, ret->width * ret->height);
-       ret->used_solve = ret->just_used_solve = TRUE;
-       ret->completed = TRUE;
+        for (i = 0; i < state->width * state->height; i++) {
+            int c = aux[i];
+
+            if (c >= '0' && c <= '9')
+                tiles[i] = c - '0';
+            else if (c >= 'a' && c <= 'f')
+                tiles[i] = c - 'a' + 10;
+            else if (c >= 'A' && c <= 'F')
+                tiles[i] = c - 'A' + 10;
+        }
     }
 
+    /*
+     * Now construct a string which can be passed to execute_move()
+     * to transform the current grid into the solved one.
+     */
+    retsize = 256;
+    ret = snewn(retsize, char);
+    retlen = 0;
+    ret[retlen++] = 'S';
+
+    for (i = 0; i < state->width * state->height; i++) {
+       int from = currstate->tiles[i], to = tiles[i];
+       int ft = from & (R|L|U|D), tt = to & (R|L|U|D);
+       int x = i % state->width, y = i / state->width;
+       int chr = '\0';
+       char buf[80], *p = buf;
+
+       if (from == to)
+           continue;                  /* nothing needs doing at all */
+
+       /*
+        * To transform this tile into the desired tile: first
+        * unlock the tile if it's locked, then rotate it if
+        * necessary, then lock it if necessary.
+        */
+       if (from & LOCKED)
+           p += sprintf(p, ";L%d,%d", x, y);
+
+       if (tt == A(ft))
+           chr = 'A';
+       else if (tt == C(ft))
+           chr = 'C';
+       else if (tt == F(ft))
+           chr = 'F';
+       else {
+           assert(tt == ft);
+           chr = '\0';
+       }
+       if (chr)
+           p += sprintf(p, ";%c%d,%d", chr, x, y);
+
+       if (to & LOCKED)
+           p += sprintf(p, ";L%d,%d", x, y);
+
+       if (p > buf) {
+           if (retlen + (p - buf) >= retsize) {
+               retsize = retlen + (p - buf) + 512;
+               ret = sresize(ret, retsize, char);
+           }
+           memcpy(ret+retlen, buf, p - buf);
+           retlen += p - buf;
+       }
+    }
+
+    assert(retlen < retsize);
+    ret[retlen] = '\0';
+    ret = sresize(ret, retlen+1, char);
+
+    sfree(tiles);
+
     return ret;
 }
 
@@ -1787,6 +1844,23 @@ static void free_ui(game_ui *ui)
     sfree(ui);
 }
 
+static char *encode_ui(game_ui *ui)
+{
+    char buf[120];
+    /*
+     * We preserve the origin and centre-point coordinates over a
+     * serialise.
+     */
+    sprintf(buf, "O%d,%d;C%d,%d", ui->org_x, ui->org_y, ui->cx, ui->cy);
+    return dupstr(buf);
+}
+
+static void decode_ui(game_ui *ui, char *encoding)
+{
+    sscanf(encoding, "O%d,%d;C%d,%d",
+          &ui->org_x, &ui->org_y, &ui->cx, &ui->cy);
+}
+
 static void game_changed_state(game_ui *ui, game_state *oldstate,
                                game_state *newstate)
 {
@@ -1803,14 +1877,20 @@ struct game_drawstate {
 /* ----------------------------------------------------------------------
  * Process a move.
  */
-static game_state *make_move(game_state *state, game_ui *ui,
-                             game_drawstate *ds, int x, int y, int button) {
-    game_state *ret, *nullret;
-    int tx, ty, orig;
+static char *interpret_move(game_state *state, game_ui *ui,
+                           game_drawstate *ds, int x, int y, int button)
+{
+    char *nullret;
+    int tx = -1, ty = -1, dir = 0;
     int shift = button & MOD_SHFT, ctrl = button & MOD_CTRL;
+    enum {
+        NONE, ROTATE_LEFT, ROTATE_180, ROTATE_RIGHT, TOGGLE_LOCK, JUMBLE,
+        MOVE_ORIGIN, MOVE_SOURCE, MOVE_ORIGIN_AND_SOURCE, MOVE_CURSOR
+    } action;
 
     button &= ~MOD_MASK;
     nullret = NULL;
+    action = NONE;
 
     if (button == LEFT_BUTTON ||
        button == MIDDLE_BUTTON ||
@@ -1818,7 +1898,7 @@ static game_state *make_move(game_state *state, game_ui *ui,
 
        if (ui->cur_visible) {
            ui->cur_visible = FALSE;
-           nullret = state;
+           nullret = "";
        }
 
        /*
@@ -1838,9 +1918,11 @@ static game_state *make_move(game_state *state, game_ui *ui,
        if (x % TILE_SIZE >= TILE_SIZE - TILE_BORDER ||
            y % TILE_SIZE >= TILE_SIZE - TILE_BORDER)
            return nullret;
+
+        action = button == LEFT_BUTTON ? ROTATE_LEFT :
+                 button == RIGHT_BUTTON ? ROTATE_RIGHT : TOGGLE_LOCK;
     } else if (button == CURSOR_UP || button == CURSOR_DOWN ||
               button == CURSOR_RIGHT || button == CURSOR_LEFT) {
-        int dir;
         switch (button) {
           case CURSOR_UP:       dir = U; break;
           case CURSOR_DOWN:     dir = D; break;
@@ -1848,43 +1930,28 @@ static game_state *make_move(game_state *state, game_ui *ui,
           case CURSOR_RIGHT:    dir = R; break;
           default:              return nullret;
         }
-        if (shift) {
-            /*
-             * Move origin.
-             */
-            if (state->wrapping) {
-                OFFSET(ui->org_x, ui->org_y, ui->org_x, ui->org_y, dir, state);
-            } else return nullret; /* disallowed for non-wrapping grids */
-        }
-        if (ctrl) {
-            /*
-             * Change source tile.
-             */
-            OFFSET(ui->cx, ui->cy, ui->cx, ui->cy, dir, state);
-        }
-        if (!shift && !ctrl) {
-            /*
-             * Move keyboard cursor.
-             */
-            OFFSET(ui->cur_x, ui->cur_y, ui->cur_x, ui->cur_y, dir, state);
-            ui->cur_visible = TRUE;
-        }
-        return state;                 /* UI activity has occurred */
+        if (shift && ctrl) action = MOVE_ORIGIN_AND_SOURCE;
+        else if (shift)    action = MOVE_ORIGIN;
+        else if (ctrl)     action = MOVE_SOURCE;
+        else               action = MOVE_CURSOR;
     } else if (button == 'a' || button == 's' || button == 'd' ||
-              button == 'A' || button == 'S' || button == 'D') {
+              button == 'A' || button == 'S' || button == 'D' ||
+               button == 'f' || button == 'F' ||
+              button == CURSOR_SELECT) {
        tx = ui->cur_x;
        ty = ui->cur_y;
-       if (button == 'a' || button == 'A')
-           button = LEFT_BUTTON;
+       if (button == 'a' || button == 'A' || button == CURSOR_SELECT)
+           action = ROTATE_LEFT;
        else if (button == 's' || button == 'S')
-           button = MIDDLE_BUTTON;
+           action = TOGGLE_LOCK;
        else if (button == 'd' || button == 'D')
-           button = RIGHT_BUTTON;
+           action = ROTATE_RIGHT;
+        else if (button == 'f' || button == 'F')
+            action = ROTATE_180;
         ui->cur_visible = TRUE;
     } else if (button == 'j' || button == 'J') {
        /* XXX should we have some mouse control for this? */
-       button = 'J';   /* canonify */
-       tx = ty = -1;   /* shut gcc up :( */
+       action = JUMBLE;
     } else
        return nullret;
 
@@ -1898,15 +1965,13 @@ static game_state *make_move(game_state *state, game_ui *ui,
      * accident. If they change their mind, another middle click
      * unlocks it.)
      */
-    if (button == MIDDLE_BUTTON) {
-
-       ret = dup_game(state);
-       ret->just_used_solve = FALSE;
-       tile(ret, tx, ty) ^= LOCKED;
-       ret->last_rotate_dir = ret->last_rotate_x = ret->last_rotate_y = 0;
-       return ret;
-
-    } else if (button == LEFT_BUTTON || button == RIGHT_BUTTON) {
+    if (action == TOGGLE_LOCK) {
+       char buf[80];
+       sprintf(buf, "L%d,%d", tx, ty);
+       return dupstr(buf);
+    } else if (action == ROTATE_LEFT || action == ROTATE_RIGHT ||
+               action == ROTATE_180) {
+       char buf[80];
 
         /*
          * The left and right buttons have no effect if clicked on a
@@ -1919,49 +1984,129 @@ static game_state *make_move(game_state *state, game_ui *ui,
          * Otherwise, turn the tile one way or the other. Left button
          * turns anticlockwise; right button turns clockwise.
          */
-        ret = dup_game(state);
-       ret->just_used_solve = FALSE;
-        orig = tile(ret, tx, ty);
-        if (button == LEFT_BUTTON) {
-            tile(ret, tx, ty) = A(orig);
-            ret->last_rotate_dir = +1;
-        } else {
-            tile(ret, tx, ty) = C(orig);
-            ret->last_rotate_dir = -1;
-        }
-        ret->last_rotate_x = tx;
-        ret->last_rotate_y = ty;
-
-    } else if (button == 'J') {
-
+       sprintf(buf, "%c%d,%d", (int)(action == ROTATE_LEFT ? 'A' :
+                                      action == ROTATE_RIGHT ? 'C' : 'F'), tx, ty);
+       return dupstr(buf);
+    } else if (action == JUMBLE) {
         /*
          * Jumble all unlocked tiles to random orientations.
          */
-        int jx, jy;
-        ret = dup_game(state);
-       ret->just_used_solve = FALSE;
-        for (jy = 0; jy < ret->height; jy++) {
-            for (jx = 0; jx < ret->width; jx++) {
-                if (!(tile(ret, jx, jy) & LOCKED)) {
+
+        int jx, jy, maxlen;
+       char *ret, *p;
+
+       /*
+        * Maximum string length assumes no int can be converted to
+        * decimal and take more than 11 digits!
+        */
+       maxlen = state->width * state->height * 25 + 3;
+
+       ret = snewn(maxlen, char);
+       p = ret;
+       *p++ = 'J';
+
+        for (jy = 0; jy < state->height; jy++) {
+            for (jx = 0; jx < state->width; jx++) {
+                if (!(tile(state, jx, jy) & LOCKED)) {
                     int rot = random_upto(ui->rs, 4);
-                    orig = tile(ret, jx, jy);
-                    tile(ret, jx, jy) = ROT(orig, rot);
+                   if (rot) {
+                       p += sprintf(p, ";%c%d,%d", "AFC"[rot-1], jx, jy);
+                   }
                 }
             }
         }
-        ret->last_rotate_dir = 0; /* suppress animation */
-        ret->last_rotate_x = ret->last_rotate_y = 0;
+       *p++ = '\0';
+       assert(p - ret < maxlen);
+       ret = sresize(ret, p - ret, char);
 
+       return ret;
+    } else if (action == MOVE_ORIGIN || action == MOVE_SOURCE ||
+               action == MOVE_ORIGIN_AND_SOURCE || action == MOVE_CURSOR) {
+        assert(dir != 0);
+        if (action == MOVE_ORIGIN || action == MOVE_ORIGIN_AND_SOURCE) {
+            if (state->wrapping) {
+                 OFFSET(ui->org_x, ui->org_y, ui->org_x, ui->org_y, dir, state);
+            } else return nullret; /* disallowed for non-wrapping grids */
+        }
+        if (action == MOVE_SOURCE || action == MOVE_ORIGIN_AND_SOURCE) {
+            OFFSET(ui->cx, ui->cy, ui->cx, ui->cy, dir, state);
+        }
+        if (action == MOVE_CURSOR) {
+            OFFSET(ui->cur_x, ui->cur_y, ui->cur_x, ui->cur_y, dir, state);
+            ui->cur_visible = TRUE;
+        }
+        return "";
     } else {
-       ret = NULL;  /* placate optimisers which don't understand assert(0) */
-       assert(0);
+       return NULL;
+    }
+}
+
+static game_state *execute_move(game_state *from, char *move)
+{
+    game_state *ret;
+    int tx, ty, n, noanim, orig;
+
+    ret = dup_game(from);
+    ret->just_used_solve = FALSE;
+
+    if (move[0] == 'J' || move[0] == 'S') {
+       if (move[0] == 'S')
+           ret->just_used_solve = ret->used_solve = TRUE;
+
+       move++;
+       if (*move == ';')
+           move++;
+       noanim = TRUE;
+    } else
+       noanim = FALSE;
+
+    ret->last_rotate_dir = 0;         /* suppress animation */
+    ret->last_rotate_x = ret->last_rotate_y = 0;
+
+    while (*move) {
+       if ((move[0] == 'A' || move[0] == 'C' ||
+            move[0] == 'F' || move[0] == 'L') &&
+           sscanf(move+1, "%d,%d%n", &tx, &ty, &n) >= 2 &&
+           tx >= 0 && tx < from->width && ty >= 0 && ty < from->height) {
+           orig = tile(ret, tx, ty);
+           if (move[0] == 'A') {
+               tile(ret, tx, ty) = A(orig);
+               if (!noanim)
+                   ret->last_rotate_dir = +1;
+           } else if (move[0] == 'F') {
+               tile(ret, tx, ty) = F(orig);
+               if (!noanim)
+                    ret->last_rotate_dir = +2; /* + for sake of argument */
+           } else if (move[0] == 'C') {
+               tile(ret, tx, ty) = C(orig);
+               if (!noanim)
+                   ret->last_rotate_dir = -1;
+           } else {
+               assert(move[0] == 'L');
+               tile(ret, tx, ty) ^= LOCKED;
+           }
+
+           move += 1 + n;
+           if (*move == ';') move++;
+       } else {
+           free_game(ret);
+           return NULL;
+       }
+    }
+    if (!noanim) {
+       ret->last_rotate_x = tx;
+       ret->last_rotate_y = ty;
     }
 
     /*
      * Check whether the game has been completed.
+     * 
+     * For this purpose it doesn't matter where the source square
+     * is, because we can start from anywhere and correctly
+     * determine whether the game is completed.
      */
     {
-       unsigned char *active = compute_active(ret, ui->cx, ui->cy);
+       unsigned char *active = compute_active(ret, 0, 0);
        int x1, y1;
        int complete = TRUE;
 
@@ -1982,6 +2127,7 @@ static game_state *make_move(game_state *state, game_ui *ui,
     return ret;
 }
 
+
 /* ----------------------------------------------------------------------
  * Routines for drawing the game position on the screen.
  */
@@ -2007,25 +2153,17 @@ static void game_free_drawstate(game_drawstate *ds)
     sfree(ds);
 }
 
-static void game_size(game_params *params, game_drawstate *ds, int *x, int *y,
-                      int expand)
+static void game_compute_size(game_params *params, int tilesize,
+                             int *x, int *y)
 {
-    int tsx, tsy, ts;
-    /*
-     * Each window dimension equals the tile size times the grid
-     * dimension, plus TILE_BORDER, plus twice WINDOW_OFFSET.
-     */
-    tsx = (*x - 2*WINDOW_OFFSET - TILE_BORDER) / params->width;
-    tsy = (*y - 2*WINDOW_OFFSET - TILE_BORDER) / params->height;
-    ts = min(tsx, tsy);
-
-    if (expand)
-        ds->tilesize = ts;
-    else
-        ds->tilesize = min(ts, PREFERRED_TILE_SIZE);
+    *x = WINDOW_OFFSET * 2 + tilesize * params->width + TILE_BORDER;
+    *y = WINDOW_OFFSET * 2 + tilesize * params->height + TILE_BORDER;
+}
 
-    *x = WINDOW_OFFSET * 2 + TILE_SIZE * params->width + TILE_BORDER;
-    *y = WINDOW_OFFSET * 2 + TILE_SIZE * params->height + TILE_BORDER;
+static void game_set_size(game_drawstate *ds, game_params *params,
+                         int tilesize)
+{
+    ds->tilesize = tilesize;
 }
 
 static float *game_colours(frontend *fe, game_state *state, int *ncolours)
@@ -2266,8 +2404,7 @@ static void draw_tile(frontend *fe, game_state *state, game_drawstate *ds,
             points[i+1] = by+(int)(cy+ty);
         }
 
-        draw_polygon(fe, points, 4, TRUE, col);
-        draw_polygon(fe, points, 4, FALSE, COL_WIRE);
+        draw_polygon(fe, points, 4, col, COL_WIRE);
     }
 
     /*
@@ -2606,7 +2743,6 @@ const struct game thegame = {
     TRUE, game_configure, custom_params,
     validate_params,
     new_game_desc,
-    game_free_aux_info,
     validate_desc,
     new_game,
     dup_game,
@@ -2615,9 +2751,12 @@ const struct game thegame = {
     FALSE, game_text_format,
     new_ui,
     free_ui,
+    encode_ui,
+    decode_ui,
     game_changed_state,
-    make_move,
-    game_size,
+    interpret_move,
+    execute_move,
+    PREFERRED_TILE_SIZE, game_compute_size, game_set_size,
     game_colours,
     game_new_drawstate,
     game_free_drawstate,