twiddle.c

   1 /*
   2  * twiddle.c: Puzzle involving rearranging a grid of squares by
   3  * rotating subsquares. Adapted and generalised from a
   4  * door-unlocking puzzle in Metroid Prime 2 (the one in the Main
   5  * Gyro Chamber).
   6  */
   7
   8 #include <stdio.h>
   9 #include <stdlib.h>
  10 #include <string.h>
  11 #include <assert.h>
  12 #include <ctype.h>
  13 #include <math.h>
  14
  15 #include "puzzles.h"
  16
  17 #define PREFERRED_TILE_SIZE 48
  18 #define TILE_SIZE (ds->tilesize)
  19 #define BORDER    (TILE_SIZE / 2)
  20 #define HIGHLIGHT_WIDTH (TILE_SIZE / 20)
  21 #define COORD(x)  ( (x) * TILE_SIZE + BORDER )
  22 #define FROMCOORD(x)  ( ((x) - BORDER + TILE_SIZE) / TILE_SIZE - 1 )
  23
  24 #define ANIM_PER_RADIUS_UNIT 0.13F
  25 #define FLASH_FRAME 0.13F
  26
  27 enum {
  28     COL_BACKGROUND,
  29     COL_TEXT,
  30     COL_HIGHLIGHT,
  31     COL_HIGHLIGHT_GENTLE,
  32     COL_LOWLIGHT,
  33     COL_LOWLIGHT_GENTLE,
  34     NCOLOURS
  35 };
  36
  37 struct game_params {
  38     int w, h, n;
  39     int rowsonly;
  40     int orientable;
  41     int movetarget;
  42 };
  43
  44 struct game_state {
  45     int w, h, n;
  46     int orientable;
  47     int *grid;
  48     int completed;
  49     int just_used_solve;               /* used to suppress undo animation */
  50     int used_solve;                    /* used to suppress completion flash */
  51     int movecount, movetarget;
  52     int lastx, lasty, lastr;           /* coordinates of last rotation */
  53 };
  54
  55 static game_params *default_params(void)
  56 {
  57     game_params *ret = snew(game_params);
  58
  59     ret->w = ret->h = 3;
  60     ret->n = 2;
  61     ret->rowsonly = ret->orientable = FALSE;
  62     ret->movetarget = 0;
  63
  64     return ret;
  65 }
  66
  67
  68 static void free_params(game_params *params)
  69 {
  70     sfree(params);
  71 }
  72
  73 static game_params *dup_params(game_params *params)
  74 {
  75     game_params *ret = snew(game_params);
  76     *ret = *params;                    /* structure copy */
  77     return ret;
  78 }
  79
  80 static int game_fetch_preset(int i, char **name, game_params **params)
  81 {
  82     static struct {
  83         char *title;
  84         game_params params;
  85     } presets[] = {
  86         { "3x3 rows only", { 3, 3, 2, TRUE, FALSE } },
  87         { "3x3 normal", { 3, 3, 2, FALSE, FALSE } },
  88         { "3x3 orientable", { 3, 3, 2, FALSE, TRUE } },
  89         { "4x4 normal", { 4, 4, 2, FALSE } },
  90         { "4x4 orientable", { 4, 4, 2, FALSE, TRUE } },
  91         { "4x4 radius 3", { 4, 4, 3, FALSE } },
  92         { "5x5 radius 3", { 5, 5, 3, FALSE } },
  93         { "6x6 radius 4", { 6, 6, 4, FALSE } },
  94     };
  95
  96     if (i < 0 || i >= lenof(presets))
  97         return FALSE;
  98
  99     *name = dupstr(presets[i].title);
 100     *params = dup_params(&presets[i].params);
 101
 102     return TRUE;
 103 }
 104
 105 static void decode_params(game_params *ret, char const *string)
 106 {
 107     ret->w = ret->h = atoi(string);
 108     ret->n = 2;
 109     ret->rowsonly = ret->orientable = FALSE;
 110     ret->movetarget = 0;
 111     while (*string && isdigit(*string)) string++;
 112     if (*string == 'x') {
 113         string++;
 114         ret->h = atoi(string);
 115         while (*string && isdigit(*string)) string++;
 116     }
 117     if (*string == 'n') {
 118         string++;
 119         ret->n = atoi(string);
 120         while (*string && isdigit(*string)) string++;
 121     }
 122     while (*string) {
 123         if (*string == 'r') {
 124             ret->rowsonly = TRUE;
 125         } else if (*string == 'o') {
 126             ret->orientable = TRUE;
 127         } else if (*string == 'm') {
 128             string++;
 129             ret->movetarget = atoi(string);
 130             while (string[1] && isdigit(string[1])) string++;
 131         }
 132         string++;
 133     }
 134 }
 135
 136 static char *encode_params(game_params *params, int full)
 137 {
 138     char buf[256];
 139     sprintf(buf, "%dx%dn%d%s%s", params->w, params->h, params->n,
 140             params->rowsonly ? "r" : "",
 141             params->orientable ? "o" : "");
 142     /* Shuffle limit is part of the limited parameters, because we have to
 143      * supply the target move count. */
 144     if (params->movetarget)
 145         sprintf(buf + strlen(buf), "m%d", params->movetarget);
 146     return dupstr(buf);
 147 }
 148
 149 static config_item *game_configure(game_params *params)
 150 {
 151     config_item *ret;
 152     char buf[80];
 153
 154     ret = snewn(7, config_item);
 155
 156     ret[0].name = "Width";
 157     ret[0].type = C_STRING;
 158     sprintf(buf, "%d", params->w);
 159     ret[0].sval = dupstr(buf);
 160     ret[0].ival = 0;
 161
 162     ret[1].name = "Height";
 163     ret[1].type = C_STRING;
 164     sprintf(buf, "%d", params->h);
 165     ret[1].sval = dupstr(buf);
 166     ret[1].ival = 0;
 167
 168     ret[2].name = "Rotation radius";
 169     ret[2].type = C_STRING;
 170     sprintf(buf, "%d", params->n);
 171     ret[2].sval = dupstr(buf);
 172     ret[2].ival = 0;
 173
 174     ret[3].name = "One number per row";
 175     ret[3].type = C_BOOLEAN;
 176     ret[3].sval = NULL;
 177     ret[3].ival = params->rowsonly;
 178
 179     ret[4].name = "Orientation matters";
 180     ret[4].type = C_BOOLEAN;
 181     ret[4].sval = NULL;
 182     ret[4].ival = params->orientable;
 183
 184     ret[5].name = "Number of shuffling moves";
 185     ret[5].type = C_STRING;
 186     sprintf(buf, "%d", params->movetarget);
 187     ret[5].sval = dupstr(buf);
 188     ret[5].ival = 0;
 189
 190     ret[6].name = NULL;
 191     ret[6].type = C_END;
 192     ret[6].sval = NULL;
 193     ret[6].ival = 0;
 194
 195     return ret;
 196 }
 197
 198 static game_params *custom_params(config_item *cfg)
 199 {
 200     game_params *ret = snew(game_params);
 201
 202     ret->w = atoi(cfg[0].sval);
 203     ret->h = atoi(cfg[1].sval);
 204     ret->n = atoi(cfg[2].sval);
 205     ret->rowsonly = cfg[3].ival;
 206     ret->orientable = cfg[4].ival;
 207     ret->movetarget = atoi(cfg[5].sval);
 208
 209     return ret;
 210 }
 211
 212 static char *validate_params(game_params *params)
 213 {
 214     if (params->n < 2)
 215         return "Rotation radius must be at least two";
 216     if (params->w < params->n)
 217         return "Width must be at least the rotation radius";
 218     if (params->h < params->n)
 219         return "Height must be at least the rotation radius";
 220     return NULL;
 221 }
 222
 223 /*
 224  * This function actually performs a rotation on a grid. The `x'
 225  * and `y' coordinates passed in are the coordinates of the _top
 226  * left corner_ of the rotated region. (Using the centre would have
 227  * involved half-integers and been annoyingly fiddly. Clicking in
 228  * the centre is good for a user interface, but too inconvenient to
 229  * use internally.)
 230  */
 231 static void do_rotate(int *grid, int w, int h, int n, int orientable,
 232                       int x, int y, int dir)
 233 {
 234     int i, j;
 235
 236     assert(x >= 0 && x+n <= w);
 237     assert(y >= 0 && y+n <= h);
 238     dir &= 3;
 239     if (dir == 0)
 240         return;                        /* nothing to do */
 241
 242     grid += y*w+x;                     /* translate region to top corner */
 243
 244     /*
 245      * If we were leaving the result of the rotation in a separate
 246      * grid, the simple thing to do would be to loop over each
 247      * square within the rotated region and assign it from its
 248      * source square. However, to do it in place without taking
 249      * O(n^2) memory, we need to be marginally more clever. What
 250      * I'm going to do is loop over about one _quarter_ of the
 251      * rotated region and permute each element within that quarter
 252      * with its rotational coset.
 253      *
 254      * The size of the region I need to loop over is (n+1)/2 by
 255      * n/2, which is an obvious exact quarter for even n and is a
 256      * rectangle for odd n. (For odd n, this technique leaves out
 257      * one element of the square, which is of course the central
 258      * one that never moves anyway.)
 259      */
 260     for (i = 0; i < (n+1)/2; i++) {
 261         for (j = 0; j < n/2; j++) {
 262             int k;
 263             int g[4];
 264             int p[4];
 265
 266             p[0] = j*w+i;
 267             p[1] = i*w+(n-j-1);
 268             p[2] = (n-j-1)*w+(n-i-1);
 269             p[3] = (n-i-1)*w+j;
 270
 271             for (k = 0; k < 4; k++)
 272                 g[k] = grid[p[k]];
 273
 274             for (k = 0; k < 4; k++) {
 275                 int v = g[(k+dir) & 3];
 276                 if (orientable)
 277                     v ^= ((v+dir) ^ v) & 3;  /* alter orientation */
 278                 grid[p[k]] = v;
 279             }
 280         }
 281     }
 282
 283     /*
 284      * Don't forget the orientation on the centre square, if n is
 285      * odd.
 286      */
 287     if (orientable && (n & 1)) {
 288         int v = grid[n/2*(w+1)];
 289         v ^= ((v+dir) ^ v) & 3;  /* alter orientation */
 290         grid[n/2*(w+1)] = v;
 291     }
 292 }
 293
 294 static int grid_complete(int *grid, int wh, int orientable)
 295 {
 296     int ok = TRUE;
 297     int i;
 298     for (i = 1; i < wh; i++)
 299         if (grid[i] < grid[i-1])
 300             ok = FALSE;
 301     if (orientable) {
 302         for (i = 0; i < wh; i++)
 303             if (grid[i] & 3)
 304                 ok = FALSE;
 305     }
 306     return ok;
 307 }
 308
 309 static char *new_game_desc(game_params *params, random_state *rs,
 310                            game_aux_info **aux, int interactive)
 311 {
 312     int *grid;
 313     int w = params->w, h = params->h, n = params->n, wh = w*h;
 314     int i;
 315     char *ret;
 316     int retlen;
 317     int total_moves;
 318
 319     /*
 320      * Set up a solved grid.
 321      */
 322     grid = snewn(wh, int);
 323     for (i = 0; i < wh; i++)
 324         grid[i] = ((params->rowsonly ? i/w : i) + 1) * 4;
 325
 326     /*
 327      * Shuffle it. This game is complex enough that I don't feel up
 328      * to analysing its full symmetry properties (particularly at
 329      * n=4 and above!), so I'm going to do it the pedestrian way
 330      * and simply shuffle the grid by making a long sequence of
 331      * randomly chosen moves.
 332      */
 333     total_moves = params->movetarget;
 334     if (!total_moves)
 335         /* Add a random move to avoid parity issues. */
 336         total_moves = w*h*n*n*2 + random_upto(rs, 2);
 337
 338     do {
 339         int *prevmoves;
 340         int rw, rh;                    /* w/h of rotation centre space */
 341
 342         rw = w - n + 1;
 343         rh = h - n + 1;
 344         prevmoves = snewn(rw * rh, int);
 345         for (i = 0; i < rw * rh; i++)
 346             prevmoves[i] = 0;
 347
 348         for (i = 0; i < total_moves; i++) {
 349             int x, y, r, oldtotal, newtotal, dx, dy;
 350
 351             do {
 352                 x = random_upto(rs, w - n + 1);
 353                 y = random_upto(rs, h - n + 1);
 354                 r = 2 * random_upto(rs, 2) - 1;
 355
 356                 /*
 357                  * See if any previous rotations has happened at
 358                  * this point which nothing has overlapped since.
 359                  * If so, ensure we haven't either undone a
 360                  * previous move or repeated one so many times that
 361                  * it turns into fewer moves in the inverse
 362                  * direction (i.e. three identical rotations).
 363                  */
 364                 oldtotal = prevmoves[y*rw+x];
 365                 newtotal = oldtotal + r;
 366
 367                 /*
 368                  * Special case here for w==h==n, in which case
 369                  * there is actually no way to _avoid_ all moves
 370                  * repeating or undoing previous ones.
 371                  */
 372             } while ((w != n || h != n) &&
 373                      (abs(newtotal) < abs(oldtotal) || abs(newtotal) > 2));
 374
 375             do_rotate(grid, w, h, n, params->orientable, x, y, r);
 376
 377             /*
 378              * Log the rotation we've just performed at this point,
 379              * for inversion detection in the next move.
 380              *
 381              * Also zero a section of the prevmoves array, because
 382              * any rotation area which _overlaps_ this one is now
 383              * entirely safe to perform further moves in.
 384              *
 385              * Two rotation areas overlap if their top left
 386              * coordinates differ by strictly less than n in both
 387              * directions
 388              */
 389             prevmoves[y*rw+x] += r;
 390             for (dy = -n+1; dy <= n-1; dy++) {
 391                 if (y + dy < 0 || y + dy >= rh)
 392                     continue;
 393                 for (dx = -n+1; dx <= n-1; dx++) {
 394                     if (x + dx < 0 || x + dx >= rw)
 395                         continue;
 396                     if (dx == 0 && dy == 0)
 397                         continue;
 398                     prevmoves[(y+dy)*rw+(x+dx)] = 0;
 399                 }
 400             }
 401         }
 402
 403         sfree(prevmoves);
 404
 405     } while (grid_complete(grid, wh, params->orientable));
 406
 407     /*
 408      * Now construct the game description, by describing the grid
 409      * as a simple sequence of integers. They're comma-separated,
 410      * unless the puzzle is orientable in which case they're
 411      * separated by orientation letters `u', `d', `l' and `r'.
 412      */
 413     ret = NULL;
 414     retlen = 0;
 415     for (i = 0; i < wh; i++) {
 416         char buf[80];
 417         int k;
 418
 419         k = sprintf(buf, "%d%c", grid[i] / 4,
 420                     (char)(params->orientable ? "uldr"[grid[i] & 3] : ','));
 421
 422         ret = sresize(ret, retlen + k + 1, char);
 423         strcpy(ret + retlen, buf);
 424         retlen += k;
 425     }
 426     if (!params->orientable)
 427         ret[retlen-1] = '\0';          /* delete last comma */
 428
 429     sfree(grid);
 430     return ret;
 431 }
 432
 433 static void game_free_aux_info(game_aux_info *aux)
 434 {
 435     assert(!"Shouldn't happen");
 436 }
 437
 438 static char *validate_desc(game_params *params, char *desc)
 439 {
 440     char *p, *err;
 441     int w = params->w, h = params->h, wh = w*h;
 442     int i;
 443
 444     p = desc;
 445     err = NULL;
 446
 447     for (i = 0; i < wh; i++) {
 448         if (*p < '0' || *p > '9')
 449             return "Not enough numbers in string";
 450         while (*p >= '0' && *p <= '9')
 451             p++;
 452         if (!params->orientable && i < wh-1) {
 453             if (*p != ',')
 454                 return "Expected comma after number";
 455         } else if (params->orientable && i < wh) {
 456             if (*p != 'l' && *p != 'r' && *p != 'u' && *p != 'd')
 457                 return "Expected orientation letter after number";
 458         } else if (i == wh-1 && *p) {
 459             return "Excess junk at end of string";
 460         }
 461
 462         if (*p) p++;                   /* eat comma */
 463     }
 464
 465     return NULL;
 466 }
 467
 468 static game_state *new_game(midend_data *me, game_params *params, char *desc)
 469 {
 470     game_state *state = snew(game_state);
 471     int w = params->w, h = params->h, n = params->n, wh = w*h;
 472     int i;
 473     char *p;
 474
 475     state->w = w;
 476     state->h = h;
 477     state->n = n;
 478     state->orientable = params->orientable;
 479     state->completed = 0;
 480     state->used_solve = state->just_used_solve = FALSE;
 481     state->movecount = 0;
 482     state->movetarget = params->movetarget;
 483     state->lastx = state->lasty = state->lastr = -1;
 484
 485     state->grid = snewn(wh, int);
 486
 487     p = desc;
 488
 489     for (i = 0; i < wh; i++) {
 490         state->grid[i] = 4 * atoi(p);
 491         while (*p >= '0' && *p <= '9')
 492             p++;
 493         if (*p) {
 494             if (params->orientable) {
 495                 switch (*p) {
 496                   case 'l': state->grid[i] |= 1; break;
 497                   case 'd': state->grid[i] |= 2; break;
 498                   case 'r': state->grid[i] |= 3; break;
 499                 }
 500             }
 501             p++;
 502         }
 503     }
 504
 505     return state;
 506 }
 507
 508 static game_state *dup_game(game_state *state)
 509 {
 510     game_state *ret = snew(game_state);
 511
 512     ret->w = state->w;
 513     ret->h = state->h;
 514     ret->n = state->n;
 515     ret->orientable = state->orientable;
 516     ret->completed = state->completed;
 517     ret->movecount = state->movecount;
 518     ret->movetarget = state->movetarget;
 519     ret->lastx = state->lastx;
 520     ret->lasty = state->lasty;
 521     ret->lastr = state->lastr;
 522     ret->used_solve = state->used_solve;
 523     ret->just_used_solve = state->just_used_solve;
 524
 525     ret->grid = snewn(ret->w * ret->h, int);
 526     memcpy(ret->grid, state->grid, ret->w * ret->h * sizeof(int));
 527
 528     return ret;
 529 }
 530
 531 static void free_game(game_state *state)
 532 {
 533     sfree(state->grid);
 534     sfree(state);
 535 }
 536
 537 static int compare_int(const void *av, const void *bv)
 538 {
 539     const int *a = (const int *)av;
 540     const int *b = (const int *)bv;
 541     if (*a < *b)
 542         return -1;
 543     else if (*a > *b)
 544         return +1;
 545     else
 546         return 0;
 547 }
 548
 549 static char *solve_game(game_state *state, game_state *currstate,
 550                         game_aux_info *aux, char **error)
 551 {
 552     return dupstr("S");
 553 }
 554
 555 static char *game_text_format(game_state *state)
 556 {
 557     char *ret, *p, buf[80];
 558     int i, x, y, col, o, maxlen;
 559
 560     /*
 561      * First work out how many characters we need to display each
 562      * number. We're pretty flexible on grid contents here, so we
 563      * have to scan the entire grid.
 564      */
 565     col = 0;
 566     for (i = 0; i < state->w * state->h; i++) {
 567         x = sprintf(buf, "%d", state->grid[i] / 4);
 568         if (col < x) col = x;
 569     }
 570     o = (state->orientable ? 1 : 0);
 571
 572     /*
 573      * Now we know the exact total size of the grid we're going to
 574      * produce: it's got h rows, each containing w lots of col+o,
 575      * w-1 spaces and a trailing newline.
 576      */
 577     maxlen = state->h * state->w * (col+o+1);
 578
 579     ret = snewn(maxlen+1, char);
 580     p = ret;
 581
 582     for (y = 0; y < state->h; y++) {
 583         for (x = 0; x < state->w; x++) {
 584             int v = state->grid[state->w*y+x];
 585             sprintf(buf, "%*d", col, v/4);
 586             memcpy(p, buf, col);
 587             p += col;
 588             if (o)
 589                 *p++ = "^<v>"[v & 3];
 590             if (x+1 == state->w)
 591                 *p++ = '\n';
 592             else
 593                 *p++ = ' ';
 594         }
 595     }
 596
 597     assert(p - ret == maxlen);
 598     *p = '\0';
 599     return ret;
 600 }
 601
 602 static game_ui *new_ui(game_state *state)
 603 {
 604     return NULL;
 605 }
 606
 607 static void free_ui(game_ui *ui)
 608 {
 609 }
 610
 611 static void game_changed_state(game_ui *ui, game_state *oldstate,
 612                                game_state *newstate)
 613 {
 614 }
 615
 616 struct game_drawstate {
 617     int started;
 618     int w, h, bgcolour;
 619     int *grid;
 620     int tilesize;
 621 };
 622
 623 static char *interpret_move(game_state *state, game_ui *ui, game_drawstate *ds,
 624                             int x, int y, int button)
 625 {
 626     int w = state->w, h = state->h, n = state->n /* , wh = w*h */;
 627     char buf[80];
 628     int dir;
 629
 630     button = button & (~MOD_MASK | MOD_NUM_KEYPAD);
 631
 632     if (button == LEFT_BUTTON || button == RIGHT_BUTTON) {
 633         /*
 634          * Determine the coordinates of the click. We offset by n-1
 635          * half-blocks so that the user must click at the centre of
 636          * a rotation region rather than at the corner.
 637          */
 638         x -= (n-1) * TILE_SIZE / 2;
 639         y -= (n-1) * TILE_SIZE / 2;
 640         x = FROMCOORD(x);
 641         y = FROMCOORD(y);
 642         dir = (button == LEFT_BUTTON ? 1 : -1);
 643         if (x < 0 || x > w-n || y < 0 || y > h-n)
 644             return NULL;
 645     } else if (button == 'a' || button == 'A' || button==MOD_NUM_KEYPAD+'7') {
 646         x = y = 0;
 647         dir = (button == 'A' ? -1 : +1);
 648     } else if (button == 'b' || button == 'B' || button==MOD_NUM_KEYPAD+'9') {
 649         x = w-n;
 650         y = 0;
 651         dir = (button == 'B' ? -1 : +1);
 652     } else if (button == 'c' || button == 'C' || button==MOD_NUM_KEYPAD+'1') {
 653         x = 0;
 654         y = h-n;
 655         dir = (button == 'C' ? -1 : +1);
 656     } else if (button == 'd' || button == 'D' || button==MOD_NUM_KEYPAD+'3') {
 657         x = w-n;
 658         y = h-n;
 659         dir = (button == 'D' ? -1 : +1);
 660     } else if (button==MOD_NUM_KEYPAD+'8' && (w-n) % 2 == 0) {
 661         x = (w-n) / 2;
 662         y = 0;
 663         dir = +1;
 664     } else if (button==MOD_NUM_KEYPAD+'2' && (w-n) % 2 == 0) {
 665         x = (w-n) / 2;
 666         y = h-n;
 667         dir = +1;
 668     } else if (button==MOD_NUM_KEYPAD+'4' && (h-n) % 2 == 0) {
 669         x = 0;
 670         y = (h-n) / 2;
 671         dir = +1;
 672     } else if (button==MOD_NUM_KEYPAD+'6' && (h-n) % 2 == 0) {
 673         x = w-n;
 674         y = (h-n) / 2;
 675         dir = +1;
 676     } else if (button==MOD_NUM_KEYPAD+'5' && (w-n) % 2 == 0 && (h-n) % 2 == 0){
 677         x = (w-n) / 2;
 678         y = (h-n) / 2;
 679         dir = +1;
 680     } else {
 681         return NULL;                   /* no move to be made */
 682     }
 683
 684     /*
 685      * If we reach here, we have a valid move.
 686      */
 687     sprintf(buf, "M%d,%d,%d", x, y, dir);
 688     return dupstr(buf);
 689 }
 690
 691 static game_state *execute_move(game_state *from, char *move)
 692 {
 693     game_state *ret;
 694     int w = from->w, h = from->h, n = from->n, wh = w*h;
 695     int x, y, dir;
 696
 697     if (!strcmp(move, "S")) {
 698         int i;
 699         ret = dup_game(from);
 700
 701         /*
 702          * Simply replace the grid with a solved one. For this game,
 703          * this isn't a useful operation for actually telling the user
 704          * what they should have done, but it is useful for
 705          * conveniently being able to get hold of a clean state from
 706          * which to practise manoeuvres.
 707          */
 708         qsort(ret->grid, ret->w*ret->h, sizeof(int), compare_int);
 709         for (i = 0; i < ret->w*ret->h; i++)
 710             ret->grid[i] &= ~3;
 711         ret->used_solve = ret->just_used_solve = TRUE;
 712         ret->completed = ret->movecount = 1;
 713
 714         return ret;
 715     }
 716
 717     if (move[0] != 'M' ||
 718         sscanf(move+1, "%d,%d,%d", &x, &y, &dir) != 3 ||
 719         x < 0 || y < 0 || x > from->w - n || y > from->h - n)
 720         return NULL;                   /* can't parse this move string */
 721
 722     ret = dup_game(from);
 723     ret->just_used_solve = FALSE;  /* zero this in a hurry */
 724     ret->movecount++;
 725     do_rotate(ret->grid, w, h, n, ret->orientable, x, y, dir);
 726     ret->lastx = x;
 727     ret->lasty = y;
 728     ret->lastr = dir;
 729
 730     /*
 731      * See if the game has been completed. To do this we simply
 732      * test that the grid contents are in increasing order.
 733      */
 734     if (!ret->completed && grid_complete(ret->grid, wh, ret->orientable))
 735         ret->completed = ret->movecount;
 736     return ret;
 737 }
 738
 739 /* ----------------------------------------------------------------------
 740  * Drawing routines.
 741  */
 742
 743 static void game_size(game_params *params, game_drawstate *ds,
 744                       int *x, int *y, int expand)
 745 {
 746     int tsx, tsy, ts;
 747     /*
 748      * Each window dimension equals the tile size times one more
 749      * than the grid dimension (the border is half the width of the
 750      * tiles).
 751      */
 752     tsx = *x / (params->w + 1);
 753     tsy = *y / (params->h + 1);
 754     ts = min(tsx, tsy);
 755     if (expand)
 756         ds->tilesize = ts;
 757     else
 758         ds->tilesize = min(ts, PREFERRED_TILE_SIZE);
 759
 760     *x = TILE_SIZE * params->w + 2 * BORDER;
 761     *y = TILE_SIZE * params->h + 2 * BORDER;
 762 }
 763
 764 static float *game_colours(frontend *fe, game_state *state, int *ncolours)
 765 {
 766     float *ret = snewn(3 * NCOLOURS, float);
 767     int i;
 768     float max;
 769
 770     frontend_default_colour(fe, &ret[COL_BACKGROUND * 3]);
 771
 772     /*
 773      * Drop the background colour so that the highlight is
 774      * noticeably brighter than it while still being under 1.
 775      */
 776     max = ret[COL_BACKGROUND*3];
 777     for (i = 1; i < 3; i++)
 778         if (ret[COL_BACKGROUND*3+i] > max)
 779             max = ret[COL_BACKGROUND*3+i];
 780     if (max * 1.2F > 1.0F) {
 781         for (i = 0; i < 3; i++)
 782             ret[COL_BACKGROUND*3+i] /= (max * 1.2F);
 783     }
 784
 785     for (i = 0; i < 3; i++) {
 786         ret[COL_HIGHLIGHT * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 1.2F;
 787         ret[COL_HIGHLIGHT_GENTLE * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 1.1F;
 788         ret[COL_LOWLIGHT * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 0.8F;
 789         ret[COL_LOWLIGHT_GENTLE * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 0.9F;
 790         ret[COL_TEXT * 3 + i] = 0.0;
 791     }
 792
 793     *ncolours = NCOLOURS;
 794     return ret;
 795 }
 796
 797 static game_drawstate *game_new_drawstate(game_state *state)
 798 {
 799     struct game_drawstate *ds = snew(struct game_drawstate);
 800     int i;
 801
 802     ds->started = FALSE;
 803     ds->w = state->w;
 804     ds->h = state->h;
 805     ds->bgcolour = COL_BACKGROUND;
 806     ds->grid = snewn(ds->w*ds->h, int);
 807     ds->tilesize = 0;                  /* haven't decided yet */
 808     for (i = 0; i < ds->w*ds->h; i++)
 809         ds->grid[i] = -1;
 810
 811     return ds;
 812 }
 813
 814 static void game_free_drawstate(game_drawstate *ds)
 815 {
 816     sfree(ds->grid);
 817     sfree(ds);
 818 }
 819
 820 struct rotation {
 821     int cx, cy, cw, ch;                /* clip region */
 822     int ox, oy;                        /* rotation origin */
 823     float c, s;                        /* cos and sin of rotation angle */
 824     int lc, rc, tc, bc;                /* colours of tile edges */
 825 };
 826
 827 static void rotate(int *xy, struct rotation *rot)
 828 {
 829     if (rot) {
 830         float xf = xy[0] - rot->ox, yf = xy[1] - rot->oy;
 831         float xf2, yf2;
 832
 833         xf2 = rot->c * xf + rot->s * yf;
 834         yf2 = - rot->s * xf + rot->c * yf;
 835
 836         xy[0] = xf2 + rot->ox + 0.5;   /* round to nearest */
 837         xy[1] = yf2 + rot->oy + 0.5;   /* round to nearest */
 838     }
 839 }
 840
 841 static void draw_tile(frontend *fe, game_drawstate *ds, game_state *state,
 842                       int x, int y, int tile, int flash_colour,
 843                       struct rotation *rot)
 844 {
 845     int coords[8];
 846     char str[40];
 847
 848     /*
 849      * If we've been passed a rotation region but we're drawing a
 850      * tile which is outside it, we must draw it normally. This can
 851      * occur if we're cleaning up after a completion flash while a
 852      * new move is also being made.
 853      */
 854     if (rot && (x < rot->cx || y < rot->cy ||
 855                 x >= rot->cx+rot->cw || y >= rot->cy+rot->ch))
 856         rot = NULL;
 857
 858     if (rot)
 859         clip(fe, rot->cx, rot->cy, rot->cw, rot->ch);
 860
 861     /*
 862      * We must draw each side of the tile's highlight separately,
 863      * because in some cases (during rotation) they will all need
 864      * to be different colours.
 865      */
 866
 867     /* The centre point is common to all sides. */
 868     coords[4] = x + TILE_SIZE / 2;
 869     coords[5] = y + TILE_SIZE / 2;
 870     rotate(coords+4, rot);
 871
 872     /* Right side. */
 873     coords[0] = x + TILE_SIZE - 1;
 874     coords[1] = y + TILE_SIZE - 1;
 875     rotate(coords+0, rot);
 876     coords[2] = x + TILE_SIZE - 1;
 877     coords[3] = y;
 878     rotate(coords+2, rot);
 879     draw_polygon(fe, coords, 3, TRUE, rot ? rot->rc : COL_LOWLIGHT);
 880     draw_polygon(fe, coords, 3, FALSE, rot ? rot->rc : COL_LOWLIGHT);
 881
 882     /* Bottom side. */
 883     coords[2] = x;
 884     coords[3] = y + TILE_SIZE - 1;
 885     rotate(coords+2, rot);
 886     draw_polygon(fe, coords, 3, TRUE, rot ? rot->bc : COL_LOWLIGHT);
 887     draw_polygon(fe, coords, 3, FALSE, rot ? rot->bc : COL_LOWLIGHT);
 888
 889     /* Left side. */
 890     coords[0] = x;
 891     coords[1] = y;
 892     rotate(coords+0, rot);
 893     draw_polygon(fe, coords, 3, TRUE, rot ? rot->lc : COL_HIGHLIGHT);
 894     draw_polygon(fe, coords, 3, FALSE, rot ? rot->lc : COL_HIGHLIGHT);
 895
 896     /* Top side. */
 897     coords[2] = x + TILE_SIZE - 1;
 898     coords[3] = y;
 899     rotate(coords+2, rot);
 900     draw_polygon(fe, coords, 3, TRUE, rot ? rot->tc : COL_HIGHLIGHT);
 901     draw_polygon(fe, coords, 3, FALSE, rot ? rot->tc : COL_HIGHLIGHT);
 902
 903     /*
 904      * Now the main blank area in the centre of the tile.
 905      */
 906     if (rot) {
 907         coords[0] = x + HIGHLIGHT_WIDTH;
 908         coords[1] = y + HIGHLIGHT_WIDTH;
 909         rotate(coords+0, rot);
 910         coords[2] = x + HIGHLIGHT_WIDTH;
 911         coords[3] = y + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 912         rotate(coords+2, rot);
 913         coords[4] = x + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 914         coords[5] = y + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 915         rotate(coords+4, rot);
 916         coords[6] = x + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 917         coords[7] = y + HIGHLIGHT_WIDTH;
 918         rotate(coords+6, rot);
 919         draw_polygon(fe, coords, 4, TRUE, flash_colour);
 920         draw_polygon(fe, coords, 4, FALSE, flash_colour);
 921     } else {
 922         draw_rect(fe, x + HIGHLIGHT_WIDTH, y + HIGHLIGHT_WIDTH,
 923                   TILE_SIZE - 2*HIGHLIGHT_WIDTH, TILE_SIZE - 2*HIGHLIGHT_WIDTH,
 924                   flash_colour);
 925     }
 926
 927     /*
 928      * Next, the triangles for orientation.
 929      */
 930     if (state->orientable) {
 931         int xdx, xdy, ydx, ydy;
 932         int cx, cy, displ, displ2;
 933         switch (tile & 3) {
 934           case 0:
 935             xdx = 1, xdy = 0;
 936             ydx = 0, ydy = 1;
 937             break;
 938           case 1:
 939             xdx = 0, xdy = -1;
 940             ydx = 1, ydy = 0;
 941             break;
 942           case 2:
 943             xdx = -1, xdy = 0;
 944             ydx = 0, ydy = -1;
 945             break;
 946           default /* case 3 */:
 947             xdx = 0, xdy = 1;
 948             ydx = -1, ydy = 0;
 949             break;
 950         }
 951
 952         cx = x + TILE_SIZE / 2;
 953         cy = y + TILE_SIZE / 2;
 954         displ = TILE_SIZE / 2 - HIGHLIGHT_WIDTH - 2;
 955         displ2 = TILE_SIZE / 3 - HIGHLIGHT_WIDTH;
 956
 957         coords[0] = cx - displ * xdx + displ2 * ydx;
 958         coords[1] = cy - displ * xdy + displ2 * ydy;
 959         rotate(coords+0, rot);
 960         coords[2] = cx + displ * xdx + displ2 * ydx;
 961         coords[3] = cy + displ * xdy + displ2 * ydy;
 962         rotate(coords+2, rot);
 963         coords[4] = cx - displ * ydx;
 964         coords[5] = cy - displ * ydy;
 965         rotate(coords+4, rot);
 966         draw_polygon(fe, coords, 3, TRUE, COL_LOWLIGHT_GENTLE);
 967         draw_polygon(fe, coords, 3, FALSE, COL_LOWLIGHT_GENTLE);
 968     }
 969
 970     coords[0] = x + TILE_SIZE/2;
 971     coords[1] = y + TILE_SIZE/2;
 972     rotate(coords+0, rot);
 973     sprintf(str, "%d", tile / 4);
 974     draw_text(fe, coords[0], coords[1],
 975               FONT_VARIABLE, TILE_SIZE/3, ALIGN_VCENTRE | ALIGN_HCENTRE,
 976               COL_TEXT, str);
 977
 978     if (rot)
 979         unclip(fe);
 980
 981     draw_update(fe, x, y, TILE_SIZE, TILE_SIZE);
 982 }
 983
 984 static int highlight_colour(float angle)
 985 {
 986     int colours[32] = {
 987         COL_LOWLIGHT,
 988         COL_LOWLIGHT_GENTLE,
 989         COL_LOWLIGHT_GENTLE,
 990         COL_LOWLIGHT_GENTLE,
 991         COL_HIGHLIGHT_GENTLE,
 992         COL_HIGHLIGHT_GENTLE,
 993         COL_HIGHLIGHT_GENTLE,
 994         COL_HIGHLIGHT,
 995         COL_HIGHLIGHT,
 996         COL_HIGHLIGHT,
 997         COL_HIGHLIGHT,
 998         COL_HIGHLIGHT,
 999         COL_HIGHLIGHT,
1000         COL_HIGHLIGHT,
1001         COL_HIGHLIGHT,
1002         COL_HIGHLIGHT,
1003         COL_HIGHLIGHT,
1004         COL_HIGHLIGHT_GENTLE,
1005         COL_HIGHLIGHT_GENTLE,
1006         COL_HIGHLIGHT_GENTLE,
1007         COL_LOWLIGHT_GENTLE,
1008         COL_LOWLIGHT_GENTLE,
1009         COL_LOWLIGHT_GENTLE,
1010         COL_LOWLIGHT,
1011         COL_LOWLIGHT,
1012         COL_LOWLIGHT,
1013         COL_LOWLIGHT,
1014         COL_LOWLIGHT,
1015         COL_LOWLIGHT,
1016         COL_LOWLIGHT,
1017         COL_LOWLIGHT,
1018         COL_LOWLIGHT,
1019     };
1020
1021     return colours[(int)((angle + 2*PI) / (PI/16)) & 31];
1022 }
1023
1024 static float game_anim_length(game_state *oldstate, game_state *newstate,
1025                               int dir, game_ui *ui)
1026 {
1027     if ((dir > 0 && newstate->just_used_solve) ||
1028         (dir < 0 && oldstate->just_used_solve))
1029         return 0.0F;
1030     else
1031         return ANIM_PER_RADIUS_UNIT * sqrt(newstate->n-1);
1032 }
1033
1034 static float game_flash_length(game_state *oldstate, game_state *newstate,
1035                                int dir, game_ui *ui)
1036 {
1037     if (!oldstate->completed && newstate->completed &&
1038         !oldstate->used_solve && !newstate->used_solve)
1039         return 2 * FLASH_FRAME;
1040     else
1041         return 0.0F;
1042 }
1043
1044 static void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
1045                         game_state *state, int dir, game_ui *ui,
1046                         float animtime, float flashtime)
1047 {
1048     int i, bgcolour;
1049     struct rotation srot, *rot;
1050     int lastx = -1, lasty = -1, lastr = -1;
1051
1052     if (flashtime > 0) {
1053         int frame = (int)(flashtime / FLASH_FRAME);
1054         bgcolour = (frame % 2 ? COL_LOWLIGHT : COL_HIGHLIGHT);
1055     } else
1056         bgcolour = COL_BACKGROUND;
1057
1058     if (!ds->started) {
1059         int coords[10];
1060
1061         draw_rect(fe, 0, 0,
1062                   TILE_SIZE * state->w + 2 * BORDER,
1063                   TILE_SIZE * state->h + 2 * BORDER, COL_BACKGROUND);
1064         draw_update(fe, 0, 0,
1065                     TILE_SIZE * state->w + 2 * BORDER,
1066                     TILE_SIZE * state->h + 2 * BORDER);
1067
1068         /*
1069          * Recessed area containing the whole puzzle.
1070          */
1071         coords[0] = COORD(state->w) + HIGHLIGHT_WIDTH - 1;
1072         coords[1] = COORD(state->h) + HIGHLIGHT_WIDTH - 1;
1073         coords[2] = COORD(state->w) + HIGHLIGHT_WIDTH - 1;
1074         coords[3] = COORD(0) - HIGHLIGHT_WIDTH;
1075         coords[4] = coords[2] - TILE_SIZE;
1076         coords[5] = coords[3] + TILE_SIZE;
1077         coords[8] = COORD(0) - HIGHLIGHT_WIDTH;
1078         coords[9] = COORD(state->h) + HIGHLIGHT_WIDTH - 1;
1079         coords[6] = coords[8] + TILE_SIZE;
1080         coords[7] = coords[9] - TILE_SIZE;
1081         draw_polygon(fe, coords, 5, TRUE, COL_HIGHLIGHT);
1082         draw_polygon(fe, coords, 5, FALSE, COL_HIGHLIGHT);
1083
1084         coords[1] = COORD(0) - HIGHLIGHT_WIDTH;
1085         coords[0] = COORD(0) - HIGHLIGHT_WIDTH;
1086         draw_polygon(fe, coords, 5, TRUE, COL_LOWLIGHT);
1087         draw_polygon(fe, coords, 5, FALSE, COL_LOWLIGHT);
1088
1089         ds->started = TRUE;
1090     }
1091
1092     /*
1093      * If we're drawing any rotated tiles, sort out the rotation
1094      * parameters, and also zap the rotation region to the
1095      * background colour before doing anything else.
1096      */
1097     if (oldstate) {
1098         float angle;
1099         float anim_max = game_anim_length(oldstate, state, dir, ui);
1100
1101         if (dir > 0) {
1102             lastx = state->lastx;
1103             lasty = state->lasty;
1104             lastr = state->lastr;
1105         } else {
1106             lastx = oldstate->lastx;
1107             lasty = oldstate->lasty;
1108             lastr = -oldstate->lastr;
1109         }
1110
1111         rot = &srot;
1112         rot->cx = COORD(lastx);
1113         rot->cy = COORD(lasty);
1114         rot->cw = rot->ch = TILE_SIZE * state->n;
1115         rot->ox = rot->cx + rot->cw/2;
1116         rot->oy = rot->cy + rot->ch/2;
1117         angle = (-PI/2 * lastr) * (1.0 - animtime / anim_max);
1118         rot->c = cos(angle);
1119         rot->s = sin(angle);
1120
1121         /*
1122          * Sort out the colours of the various sides of the tile.
1123          */
1124         rot->lc = highlight_colour(PI + angle);
1125         rot->rc = highlight_colour(angle);
1126         rot->tc = highlight_colour(PI/2 + angle);
1127         rot->bc = highlight_colour(-PI/2 + angle);
1128
1129         draw_rect(fe, rot->cx, rot->cy, rot->cw, rot->ch, bgcolour);
1130     } else
1131         rot = NULL;
1132
1133     /*
1134      * Now draw each tile.
1135      */
1136     for (i = 0; i < state->w * state->h; i++) {
1137         int t;
1138         int tx = i % state->w, ty = i / state->w;
1139
1140         /*
1141          * Figure out what should be displayed at this location.
1142          * Usually it will be state->grid[i], unless we're in the
1143          * middle of animating an actual rotation and this cell is
1144          * within the rotation region, in which case we set -1
1145          * (always display).
1146          */
1147         if (oldstate && lastx >= 0 && lasty >= 0 &&
1148             tx >= lastx && tx < lastx + state->n &&
1149             ty >= lasty && ty < lasty + state->n)
1150             t = -1;
1151         else
1152             t = state->grid[i];
1153
1154         if (ds->bgcolour != bgcolour ||   /* always redraw when flashing */
1155             ds->grid[i] != t || ds->grid[i] == -1 || t == -1) {
1156             int x = COORD(tx), y = COORD(ty);
1157
1158             draw_tile(fe, ds, state, x, y, state->grid[i], bgcolour, rot);
1159             ds->grid[i] = t;
1160         }
1161     }
1162     ds->bgcolour = bgcolour;
1163
1164     /*
1165      * Update the status bar.
1166      */
1167     {
1168         char statusbuf[256];
1169
1170         /*
1171          * Don't show the new status until we're also showing the
1172          * new _state_ - after the game animation is complete.
1173          */
1174         if (oldstate)
1175             state = oldstate;
1176
1177         if (state->used_solve)
1178             sprintf(statusbuf, "Moves since auto-solve: %d",
1179                     state->movecount - state->completed);
1180         else {
1181             sprintf(statusbuf, "%sMoves: %d",
1182                     (state->completed ? "COMPLETED! " : ""),
1183                     (state->completed ? state->completed : state->movecount));
1184             if (state->movetarget)
1185                 sprintf(statusbuf+strlen(statusbuf), " (target %d)",
1186                         state->movetarget);
1187         }
1188
1189         status_bar(fe, statusbuf);
1190     }
1191 }
1192
1193 static int game_wants_statusbar(void)
1194 {
1195     return TRUE;
1196 }
1197
1198 static int game_timing_state(game_state *state)
1199 {
1200     return TRUE;
1201 }
1202
1203 #ifdef COMBINED
1204 #define thegame twiddle
1205 #endif
1206
1207 const struct game thegame = {
1208     "Twiddle", "games.twiddle",
1209     default_params,
1210     game_fetch_preset,
1211     decode_params,
1212     encode_params,
1213     free_params,
1214     dup_params,
1215     TRUE, game_configure, custom_params,
1216     validate_params,
1217     new_game_desc,
1218     game_free_aux_info,
1219     validate_desc,
1220     new_game,
1221     dup_game,
1222     free_game,
1223     TRUE, solve_game,
1224     TRUE, game_text_format,
1225     new_ui,
1226     free_ui,
1227     game_changed_state,
1228     interpret_move,
1229     execute_move,
1230     game_size,
1231     game_colours,
1232     game_new_drawstate,
1233     game_free_drawstate,
1234     game_redraw,
1235     game_anim_length,
1236     game_flash_length,
1237     game_wants_statusbar,
1238     FALSE, game_timing_state,
1239     0,                                 /* mouse_priorities */
1240 };