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 game_state *solve_game(game_state *state, game_state *currstate,
 550                               game_aux_info *aux, char **error)
 551 {
 552     game_state *ret = dup_game(state);
 553     int i;
 554
 555     /*
 556      * Simply replace the grid with a solved one. For this game,
 557      * this isn't a useful operation for actually telling the user
 558      * what they should have done, but it is useful for
 559      * conveniently being able to get hold of a clean state from
 560      * which to practise manoeuvres.
 561      */
 562     qsort(ret->grid, ret->w*ret->h, sizeof(int), compare_int);
 563     for (i = 0; i < ret->w*ret->h; i++)
 564         ret->grid[i] &= ~3;
 565     ret->used_solve = ret->just_used_solve = TRUE;
 566     ret->completed = ret->movecount = 1;
 567
 568     return ret;
 569 }
 570
 571 static char *game_text_format(game_state *state)
 572 {
 573     char *ret, *p, buf[80];
 574     int i, x, y, col, o, maxlen;
 575
 576     /*
 577      * First work out how many characters we need to display each
 578      * number. We're pretty flexible on grid contents here, so we
 579      * have to scan the entire grid.
 580      */
 581     col = 0;
 582     for (i = 0; i < state->w * state->h; i++) {
 583         x = sprintf(buf, "%d", state->grid[i] / 4);
 584         if (col < x) col = x;
 585     }
 586     o = (state->orientable ? 1 : 0);
 587
 588     /*
 589      * Now we know the exact total size of the grid we're going to
 590      * produce: it's got h rows, each containing w lots of col+o,
 591      * w-1 spaces and a trailing newline.
 592      */
 593     maxlen = state->h * state->w * (col+o+1);
 594
 595     ret = snewn(maxlen+1, char);
 596     p = ret;
 597
 598     for (y = 0; y < state->h; y++) {
 599         for (x = 0; x < state->w; x++) {
 600             int v = state->grid[state->w*y+x];
 601             sprintf(buf, "%*d", col, v/4);
 602             memcpy(p, buf, col);
 603             p += col;
 604             if (o)
 605                 *p++ = "^<v>"[v & 3];
 606             if (x+1 == state->w)
 607                 *p++ = '\n';
 608             else
 609                 *p++ = ' ';
 610         }
 611     }
 612
 613     assert(p - ret == maxlen);
 614     *p = '\0';
 615     return ret;
 616 }
 617
 618 static game_ui *new_ui(game_state *state)
 619 {
 620     return NULL;
 621 }
 622
 623 static void free_ui(game_ui *ui)
 624 {
 625 }
 626
 627 static void game_changed_state(game_ui *ui, game_state *oldstate,
 628                                game_state *newstate)
 629 {
 630 }
 631
 632 struct game_drawstate {
 633     int started;
 634     int w, h, bgcolour;
 635     int *grid;
 636     int tilesize;
 637 };
 638
 639 static game_state *make_move(game_state *from, game_ui *ui, game_drawstate *ds,
 640                              int x, int y, int button)
 641 {
 642     int w = from->w, h = from->h, n = from->n, wh = w*h;
 643     game_state *ret;
 644     int dir;
 645
 646     button = button & (~MOD_MASK | MOD_NUM_KEYPAD);
 647
 648     if (button == LEFT_BUTTON || button == RIGHT_BUTTON) {
 649         /*
 650          * Determine the coordinates of the click. We offset by n-1
 651          * half-blocks so that the user must click at the centre of
 652          * a rotation region rather than at the corner.
 653          */
 654         x -= (n-1) * TILE_SIZE / 2;
 655         y -= (n-1) * TILE_SIZE / 2;
 656         x = FROMCOORD(x);
 657         y = FROMCOORD(y);
 658         dir = (button == LEFT_BUTTON ? 1 : -1);
 659         if (x < 0 || x > w-n || y < 0 || y > h-n)
 660             return NULL;
 661     } else if (button == 'a' || button == 'A' || button==MOD_NUM_KEYPAD+'7') {
 662         x = y = 0;
 663         dir = (button == 'A' ? -1 : +1);
 664     } else if (button == 'b' || button == 'B' || button==MOD_NUM_KEYPAD+'9') {
 665         x = w-n;
 666         y = 0;
 667         dir = (button == 'B' ? -1 : +1);
 668     } else if (button == 'c' || button == 'C' || button==MOD_NUM_KEYPAD+'1') {
 669         x = 0;
 670         y = h-n;
 671         dir = (button == 'C' ? -1 : +1);
 672     } else if (button == 'd' || button == 'D' || button==MOD_NUM_KEYPAD+'3') {
 673         x = w-n;
 674         y = h-n;
 675         dir = (button == 'D' ? -1 : +1);
 676     } else if (button==MOD_NUM_KEYPAD+'8' && (w-n) % 2 == 0) {
 677         x = (w-n) / 2;
 678         y = 0;
 679         dir = +1;
 680     } else if (button==MOD_NUM_KEYPAD+'2' && (w-n) % 2 == 0) {
 681         x = (w-n) / 2;
 682         y = h-n;
 683         dir = +1;
 684     } else if (button==MOD_NUM_KEYPAD+'4' && (h-n) % 2 == 0) {
 685         x = 0;
 686         y = (h-n) / 2;
 687         dir = +1;
 688     } else if (button==MOD_NUM_KEYPAD+'6' && (h-n) % 2 == 0) {
 689         x = w-n;
 690         y = (h-n) / 2;
 691         dir = +1;
 692     } else if (button==MOD_NUM_KEYPAD+'5' && (w-n) % 2 == 0 && (h-n) % 2 == 0){
 693         x = (w-n) / 2;
 694         y = (h-n) / 2;
 695         dir = +1;
 696     } else {
 697         return NULL;                   /* no move to be made */
 698     }
 699
 700     /*
 701      * This is a valid move. Make it.
 702      */
 703     ret = dup_game(from);
 704     ret->just_used_solve = FALSE;  /* zero this in a hurry */
 705     ret->movecount++;
 706     do_rotate(ret->grid, w, h, n, ret->orientable, x, y, dir);
 707     ret->lastx = x;
 708     ret->lasty = y;
 709     ret->lastr = dir;
 710
 711     /*
 712      * See if the game has been completed. To do this we simply
 713      * test that the grid contents are in increasing order.
 714      */
 715     if (!ret->completed && grid_complete(ret->grid, wh, ret->orientable))
 716         ret->completed = ret->movecount;
 717     return ret;
 718 }
 719
 720 /* ----------------------------------------------------------------------
 721  * Drawing routines.
 722  */
 723
 724 static void game_size(game_params *params, game_drawstate *ds,
 725                       int *x, int *y, int expand)
 726 {
 727     int tsx, tsy, ts;
 728     /*
 729      * Each window dimension equals the tile size times one more
 730      * than the grid dimension (the border is half the width of the
 731      * tiles).
 732      */
 733     tsx = *x / (params->w + 1);
 734     tsy = *y / (params->h + 1);
 735     ts = min(tsx, tsy);
 736     if (expand)
 737         ds->tilesize = ts;
 738     else
 739         ds->tilesize = min(ts, PREFERRED_TILE_SIZE);
 740
 741     *x = TILE_SIZE * params->w + 2 * BORDER;
 742     *y = TILE_SIZE * params->h + 2 * BORDER;
 743 }
 744
 745 static float *game_colours(frontend *fe, game_state *state, int *ncolours)
 746 {
 747     float *ret = snewn(3 * NCOLOURS, float);
 748     int i;
 749     float max;
 750
 751     frontend_default_colour(fe, &ret[COL_BACKGROUND * 3]);
 752
 753     /*
 754      * Drop the background colour so that the highlight is
 755      * noticeably brighter than it while still being under 1.
 756      */
 757     max = ret[COL_BACKGROUND*3];
 758     for (i = 1; i < 3; i++)
 759         if (ret[COL_BACKGROUND*3+i] > max)
 760             max = ret[COL_BACKGROUND*3+i];
 761     if (max * 1.2F > 1.0F) {
 762         for (i = 0; i < 3; i++)
 763             ret[COL_BACKGROUND*3+i] /= (max * 1.2F);
 764     }
 765
 766     for (i = 0; i < 3; i++) {
 767         ret[COL_HIGHLIGHT * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 1.2F;
 768         ret[COL_HIGHLIGHT_GENTLE * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 1.1F;
 769         ret[COL_LOWLIGHT * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 0.8F;
 770         ret[COL_LOWLIGHT_GENTLE * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 0.9F;
 771         ret[COL_TEXT * 3 + i] = 0.0;
 772     }
 773
 774     *ncolours = NCOLOURS;
 775     return ret;
 776 }
 777
 778 static game_drawstate *game_new_drawstate(game_state *state)
 779 {
 780     struct game_drawstate *ds = snew(struct game_drawstate);
 781     int i;
 782
 783     ds->started = FALSE;
 784     ds->w = state->w;
 785     ds->h = state->h;
 786     ds->bgcolour = COL_BACKGROUND;
 787     ds->grid = snewn(ds->w*ds->h, int);
 788     ds->tilesize = 0;                  /* haven't decided yet */
 789     for (i = 0; i < ds->w*ds->h; i++)
 790         ds->grid[i] = -1;
 791
 792     return ds;
 793 }
 794
 795 static void game_free_drawstate(game_drawstate *ds)
 796 {
 797     sfree(ds->grid);
 798     sfree(ds);
 799 }
 800
 801 struct rotation {
 802     int cx, cy, cw, ch;                /* clip region */
 803     int ox, oy;                        /* rotation origin */
 804     float c, s;                        /* cos and sin of rotation angle */
 805     int lc, rc, tc, bc;                /* colours of tile edges */
 806 };
 807
 808 static void rotate(int *xy, struct rotation *rot)
 809 {
 810     if (rot) {
 811         float xf = xy[0] - rot->ox, yf = xy[1] - rot->oy;
 812         float xf2, yf2;
 813
 814         xf2 = rot->c * xf + rot->s * yf;
 815         yf2 = - rot->s * xf + rot->c * yf;
 816
 817         xy[0] = xf2 + rot->ox + 0.5;   /* round to nearest */
 818         xy[1] = yf2 + rot->oy + 0.5;   /* round to nearest */
 819     }
 820 }
 821
 822 static void draw_tile(frontend *fe, game_drawstate *ds, game_state *state,
 823                       int x, int y, int tile, int flash_colour,
 824                       struct rotation *rot)
 825 {
 826     int coords[8];
 827     char str[40];
 828
 829     /*
 830      * If we've been passed a rotation region but we're drawing a
 831      * tile which is outside it, we must draw it normally. This can
 832      * occur if we're cleaning up after a completion flash while a
 833      * new move is also being made.
 834      */
 835     if (rot && (x < rot->cx || y < rot->cy ||
 836                 x >= rot->cx+rot->cw || y >= rot->cy+rot->ch))
 837         rot = NULL;
 838
 839     if (rot)
 840         clip(fe, rot->cx, rot->cy, rot->cw, rot->ch);
 841
 842     /*
 843      * We must draw each side of the tile's highlight separately,
 844      * because in some cases (during rotation) they will all need
 845      * to be different colours.
 846      */
 847
 848     /* The centre point is common to all sides. */
 849     coords[4] = x + TILE_SIZE / 2;
 850     coords[5] = y + TILE_SIZE / 2;
 851     rotate(coords+4, rot);
 852
 853     /* Right side. */
 854     coords[0] = x + TILE_SIZE - 1;
 855     coords[1] = y + TILE_SIZE - 1;
 856     rotate(coords+0, rot);
 857     coords[2] = x + TILE_SIZE - 1;
 858     coords[3] = y;
 859     rotate(coords+2, rot);
 860     draw_polygon(fe, coords, 3, TRUE, rot ? rot->rc : COL_LOWLIGHT);
 861     draw_polygon(fe, coords, 3, FALSE, rot ? rot->rc : COL_LOWLIGHT);
 862
 863     /* Bottom side. */
 864     coords[2] = x;
 865     coords[3] = y + TILE_SIZE - 1;
 866     rotate(coords+2, rot);
 867     draw_polygon(fe, coords, 3, TRUE, rot ? rot->bc : COL_LOWLIGHT);
 868     draw_polygon(fe, coords, 3, FALSE, rot ? rot->bc : COL_LOWLIGHT);
 869
 870     /* Left side. */
 871     coords[0] = x;
 872     coords[1] = y;
 873     rotate(coords+0, rot);
 874     draw_polygon(fe, coords, 3, TRUE, rot ? rot->lc : COL_HIGHLIGHT);
 875     draw_polygon(fe, coords, 3, FALSE, rot ? rot->lc : COL_HIGHLIGHT);
 876
 877     /* Top side. */
 878     coords[2] = x + TILE_SIZE - 1;
 879     coords[3] = y;
 880     rotate(coords+2, rot);
 881     draw_polygon(fe, coords, 3, TRUE, rot ? rot->tc : COL_HIGHLIGHT);
 882     draw_polygon(fe, coords, 3, FALSE, rot ? rot->tc : COL_HIGHLIGHT);
 883
 884     /*
 885      * Now the main blank area in the centre of the tile.
 886      */
 887     if (rot) {
 888         coords[0] = x + HIGHLIGHT_WIDTH;
 889         coords[1] = y + HIGHLIGHT_WIDTH;
 890         rotate(coords+0, rot);
 891         coords[2] = x + HIGHLIGHT_WIDTH;
 892         coords[3] = y + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 893         rotate(coords+2, rot);
 894         coords[4] = x + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 895         coords[5] = y + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 896         rotate(coords+4, rot);
 897         coords[6] = x + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 898         coords[7] = y + HIGHLIGHT_WIDTH;
 899         rotate(coords+6, rot);
 900         draw_polygon(fe, coords, 4, TRUE, flash_colour);
 901         draw_polygon(fe, coords, 4, FALSE, flash_colour);
 902     } else {
 903         draw_rect(fe, x + HIGHLIGHT_WIDTH, y + HIGHLIGHT_WIDTH,
 904                   TILE_SIZE - 2*HIGHLIGHT_WIDTH, TILE_SIZE - 2*HIGHLIGHT_WIDTH,
 905                   flash_colour);
 906     }
 907
 908     /*
 909      * Next, the triangles for orientation.
 910      */
 911     if (state->orientable) {
 912         int xdx, xdy, ydx, ydy;
 913         int cx, cy, displ, displ2;
 914         switch (tile & 3) {
 915           case 0:
 916             xdx = 1, xdy = 0;
 917             ydx = 0, ydy = 1;
 918             break;
 919           case 1:
 920             xdx = 0, xdy = -1;
 921             ydx = 1, ydy = 0;
 922             break;
 923           case 2:
 924             xdx = -1, xdy = 0;
 925             ydx = 0, ydy = -1;
 926             break;
 927           default /* case 3 */:
 928             xdx = 0, xdy = 1;
 929             ydx = -1, ydy = 0;
 930             break;
 931         }
 932
 933         cx = x + TILE_SIZE / 2;
 934         cy = y + TILE_SIZE / 2;
 935         displ = TILE_SIZE / 2 - HIGHLIGHT_WIDTH - 2;
 936         displ2 = TILE_SIZE / 3 - HIGHLIGHT_WIDTH;
 937
 938         coords[0] = cx - displ * xdx + displ2 * ydx;
 939         coords[1] = cy - displ * xdy + displ2 * ydy;
 940         rotate(coords+0, rot);
 941         coords[2] = cx + displ * xdx + displ2 * ydx;
 942         coords[3] = cy + displ * xdy + displ2 * ydy;
 943         rotate(coords+2, rot);
 944         coords[4] = cx - displ * ydx;
 945         coords[5] = cy - displ * ydy;
 946         rotate(coords+4, rot);
 947         draw_polygon(fe, coords, 3, TRUE, COL_LOWLIGHT_GENTLE);
 948         draw_polygon(fe, coords, 3, FALSE, COL_LOWLIGHT_GENTLE);
 949     }
 950
 951     coords[0] = x + TILE_SIZE/2;
 952     coords[1] = y + TILE_SIZE/2;
 953     rotate(coords+0, rot);
 954     sprintf(str, "%d", tile / 4);
 955     draw_text(fe, coords[0], coords[1],
 956               FONT_VARIABLE, TILE_SIZE/3, ALIGN_VCENTRE | ALIGN_HCENTRE,
 957               COL_TEXT, str);
 958
 959     if (rot)
 960         unclip(fe);
 961
 962     draw_update(fe, x, y, TILE_SIZE, TILE_SIZE);
 963 }
 964
 965 static int highlight_colour(float angle)
 966 {
 967     int colours[32] = {
 968         COL_LOWLIGHT,
 969         COL_LOWLIGHT_GENTLE,
 970         COL_LOWLIGHT_GENTLE,
 971         COL_LOWLIGHT_GENTLE,
 972         COL_HIGHLIGHT_GENTLE,
 973         COL_HIGHLIGHT_GENTLE,
 974         COL_HIGHLIGHT_GENTLE,
 975         COL_HIGHLIGHT,
 976         COL_HIGHLIGHT,
 977         COL_HIGHLIGHT,
 978         COL_HIGHLIGHT,
 979         COL_HIGHLIGHT,
 980         COL_HIGHLIGHT,
 981         COL_HIGHLIGHT,
 982         COL_HIGHLIGHT,
 983         COL_HIGHLIGHT,
 984         COL_HIGHLIGHT,
 985         COL_HIGHLIGHT_GENTLE,
 986         COL_HIGHLIGHT_GENTLE,
 987         COL_HIGHLIGHT_GENTLE,
 988         COL_LOWLIGHT_GENTLE,
 989         COL_LOWLIGHT_GENTLE,
 990         COL_LOWLIGHT_GENTLE,
 991         COL_LOWLIGHT,
 992         COL_LOWLIGHT,
 993         COL_LOWLIGHT,
 994         COL_LOWLIGHT,
 995         COL_LOWLIGHT,
 996         COL_LOWLIGHT,
 997         COL_LOWLIGHT,
 998         COL_LOWLIGHT,
 999         COL_LOWLIGHT,
1000     };
1001
1002     return colours[(int)((angle + 2*PI) / (PI/16)) & 31];
1003 }
1004
1005 static float game_anim_length(game_state *oldstate, game_state *newstate,
1006                               int dir, game_ui *ui)
1007 {
1008     if ((dir > 0 && newstate->just_used_solve) ||
1009         (dir < 0 && oldstate->just_used_solve))
1010         return 0.0F;
1011     else
1012         return ANIM_PER_RADIUS_UNIT * sqrt(newstate->n-1);
1013 }
1014
1015 static float game_flash_length(game_state *oldstate, game_state *newstate,
1016                                int dir, game_ui *ui)
1017 {
1018     if (!oldstate->completed && newstate->completed &&
1019         !oldstate->used_solve && !newstate->used_solve)
1020         return 2 * FLASH_FRAME;
1021     else
1022         return 0.0F;
1023 }
1024
1025 static void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
1026                         game_state *state, int dir, game_ui *ui,
1027                         float animtime, float flashtime)
1028 {
1029     int i, bgcolour;
1030     struct rotation srot, *rot;
1031     int lastx = -1, lasty = -1, lastr = -1;
1032
1033     if (flashtime > 0) {
1034         int frame = (int)(flashtime / FLASH_FRAME);
1035         bgcolour = (frame % 2 ? COL_LOWLIGHT : COL_HIGHLIGHT);
1036     } else
1037         bgcolour = COL_BACKGROUND;
1038
1039     if (!ds->started) {
1040         int coords[10];
1041
1042         draw_rect(fe, 0, 0,
1043                   TILE_SIZE * state->w + 2 * BORDER,
1044                   TILE_SIZE * state->h + 2 * BORDER, COL_BACKGROUND);
1045         draw_update(fe, 0, 0,
1046                     TILE_SIZE * state->w + 2 * BORDER,
1047                     TILE_SIZE * state->h + 2 * BORDER);
1048
1049         /*
1050          * Recessed area containing the whole puzzle.
1051          */
1052         coords[0] = COORD(state->w) + HIGHLIGHT_WIDTH - 1;
1053         coords[1] = COORD(state->h) + HIGHLIGHT_WIDTH - 1;
1054         coords[2] = COORD(state->w) + HIGHLIGHT_WIDTH - 1;
1055         coords[3] = COORD(0) - HIGHLIGHT_WIDTH;
1056         coords[4] = coords[2] - TILE_SIZE;
1057         coords[5] = coords[3] + TILE_SIZE;
1058         coords[8] = COORD(0) - HIGHLIGHT_WIDTH;
1059         coords[9] = COORD(state->h) + HIGHLIGHT_WIDTH - 1;
1060         coords[6] = coords[8] + TILE_SIZE;
1061         coords[7] = coords[9] - TILE_SIZE;
1062         draw_polygon(fe, coords, 5, TRUE, COL_HIGHLIGHT);
1063         draw_polygon(fe, coords, 5, FALSE, COL_HIGHLIGHT);
1064
1065         coords[1] = COORD(0) - HIGHLIGHT_WIDTH;
1066         coords[0] = COORD(0) - HIGHLIGHT_WIDTH;
1067         draw_polygon(fe, coords, 5, TRUE, COL_LOWLIGHT);
1068         draw_polygon(fe, coords, 5, FALSE, COL_LOWLIGHT);
1069
1070         ds->started = TRUE;
1071     }
1072
1073     /*
1074      * If we're drawing any rotated tiles, sort out the rotation
1075      * parameters, and also zap the rotation region to the
1076      * background colour before doing anything else.
1077      */
1078     if (oldstate) {
1079         float angle;
1080         float anim_max = game_anim_length(oldstate, state, dir, ui);
1081
1082         if (dir > 0) {
1083             lastx = state->lastx;
1084             lasty = state->lasty;
1085             lastr = state->lastr;
1086         } else {
1087             lastx = oldstate->lastx;
1088             lasty = oldstate->lasty;
1089             lastr = -oldstate->lastr;
1090         }
1091
1092         rot = &srot;
1093         rot->cx = COORD(lastx);
1094         rot->cy = COORD(lasty);
1095         rot->cw = rot->ch = TILE_SIZE * state->n;
1096         rot->ox = rot->cx + rot->cw/2;
1097         rot->oy = rot->cy + rot->ch/2;
1098         angle = (-PI/2 * lastr) * (1.0 - animtime / anim_max);
1099         rot->c = cos(angle);
1100         rot->s = sin(angle);
1101
1102         /*
1103          * Sort out the colours of the various sides of the tile.
1104          */
1105         rot->lc = highlight_colour(PI + angle);
1106         rot->rc = highlight_colour(angle);
1107         rot->tc = highlight_colour(PI/2 + angle);
1108         rot->bc = highlight_colour(-PI/2 + angle);
1109
1110         draw_rect(fe, rot->cx, rot->cy, rot->cw, rot->ch, bgcolour);
1111     } else
1112         rot = NULL;
1113
1114     /*
1115      * Now draw each tile.
1116      */
1117     for (i = 0; i < state->w * state->h; i++) {
1118         int t;
1119         int tx = i % state->w, ty = i / state->w;
1120
1121         /*
1122          * Figure out what should be displayed at this location.
1123          * Usually it will be state->grid[i], unless we're in the
1124          * middle of animating an actual rotation and this cell is
1125          * within the rotation region, in which case we set -1
1126          * (always display).
1127          */
1128         if (oldstate && lastx >= 0 && lasty >= 0 &&
1129             tx >= lastx && tx < lastx + state->n &&
1130             ty >= lasty && ty < lasty + state->n)
1131             t = -1;
1132         else
1133             t = state->grid[i];
1134
1135         if (ds->bgcolour != bgcolour ||   /* always redraw when flashing */
1136             ds->grid[i] != t || ds->grid[i] == -1 || t == -1) {
1137             int x = COORD(tx), y = COORD(ty);
1138
1139             draw_tile(fe, ds, state, x, y, state->grid[i], bgcolour, rot);
1140             ds->grid[i] = t;
1141         }
1142     }
1143     ds->bgcolour = bgcolour;
1144
1145     /*
1146      * Update the status bar.
1147      */
1148     {
1149         char statusbuf[256];
1150
1151         /*
1152          * Don't show the new status until we're also showing the
1153          * new _state_ - after the game animation is complete.
1154          */
1155         if (oldstate)
1156             state = oldstate;
1157
1158         if (state->used_solve)
1159             sprintf(statusbuf, "Moves since auto-solve: %d",
1160                     state->movecount - state->completed);
1161         else {
1162             sprintf(statusbuf, "%sMoves: %d",
1163                     (state->completed ? "COMPLETED! " : ""),
1164                     (state->completed ? state->completed : state->movecount));
1165             if (state->movetarget)
1166                 sprintf(statusbuf+strlen(statusbuf), " (target %d)",
1167                         state->movetarget);
1168         }
1169
1170         status_bar(fe, statusbuf);
1171     }
1172 }
1173
1174 static int game_wants_statusbar(void)
1175 {
1176     return TRUE;
1177 }
1178
1179 static int game_timing_state(game_state *state)
1180 {
1181     return TRUE;
1182 }
1183
1184 #ifdef COMBINED
1185 #define thegame twiddle
1186 #endif
1187
1188 const struct game thegame = {
1189     "Twiddle", "games.twiddle",
1190     default_params,
1191     game_fetch_preset,
1192     decode_params,
1193     encode_params,
1194     free_params,
1195     dup_params,
1196     TRUE, game_configure, custom_params,
1197     validate_params,
1198     new_game_desc,
1199     game_free_aux_info,
1200     validate_desc,
1201     new_game,
1202     dup_game,
1203     free_game,
1204     TRUE, solve_game,
1205     TRUE, game_text_format,
1206     new_ui,
1207     free_ui,
1208     game_changed_state,
1209     make_move,
1210     game_size,
1211     game_colours,
1212     game_new_drawstate,
1213     game_free_drawstate,
1214     game_redraw,
1215     game_anim_length,
1216     game_flash_length,
1217     game_wants_statusbar,
1218     FALSE, game_timing_state,
1219     0,                                 /* mouse_priorities */
1220 };