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     COL_HIGHCURSOR, COL_LOWCURSOR,
  35     NCOLOURS
  36 };
  37
  38 struct game_params {
  39     int w, h, n;
  40     int rowsonly;
  41     int orientable;
  42     int movetarget;
  43 };
  44
  45 struct game_state {
  46     int w, h, n;
  47     int orientable;
  48     int *grid;
  49     int completed;
  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((unsigned char)*string)) string++;
 112     if (*string == 'x') {
 113         string++;
 114         ret->h = atoi(string);
 115         while (*string && isdigit((unsigned char)*string)) string++;
 116     }
 117     if (*string == 'n') {
 118         string++;
 119         ret->n = atoi(string);
 120         while (*string && isdigit((unsigned char)*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((unsigned char)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, int full)
 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                            char **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 char *validate_desc(game_params *params, char *desc)
 434 {
 435     char *p, *err;
 436     int w = params->w, h = params->h, wh = w*h;
 437     int i;
 438
 439     p = desc;
 440     err = NULL;
 441
 442     for (i = 0; i < wh; i++) {
 443         if (*p < '0' || *p > '9')
 444             return "Not enough numbers in string";
 445         while (*p >= '0' && *p <= '9')
 446             p++;
 447         if (!params->orientable && i < wh-1) {
 448             if (*p != ',')
 449                 return "Expected comma after number";
 450         } else if (params->orientable && i < wh) {
 451             if (*p != 'l' && *p != 'r' && *p != 'u' && *p != 'd')
 452                 return "Expected orientation letter after number";
 453         } else if (i == wh-1 && *p) {
 454             return "Excess junk at end of string";
 455         }
 456
 457         if (*p) p++;                   /* eat comma */
 458     }
 459
 460     return NULL;
 461 }
 462
 463 static game_state *new_game(midend *me, game_params *params, char *desc)
 464 {
 465     game_state *state = snew(game_state);
 466     int w = params->w, h = params->h, n = params->n, wh = w*h;
 467     int i;
 468     char *p;
 469
 470     state->w = w;
 471     state->h = h;
 472     state->n = n;
 473     state->orientable = params->orientable;
 474     state->completed = 0;
 475     state->used_solve = FALSE;
 476     state->movecount = 0;
 477     state->movetarget = params->movetarget;
 478     state->lastx = state->lasty = state->lastr = -1;
 479
 480     state->grid = snewn(wh, int);
 481
 482     p = desc;
 483
 484     for (i = 0; i < wh; i++) {
 485         state->grid[i] = 4 * atoi(p);
 486         while (*p >= '0' && *p <= '9')
 487             p++;
 488         if (*p) {
 489             if (params->orientable) {
 490                 switch (*p) {
 491                   case 'l': state->grid[i] |= 1; break;
 492                   case 'd': state->grid[i] |= 2; break;
 493                   case 'r': state->grid[i] |= 3; break;
 494                 }
 495             }
 496             p++;
 497         }
 498     }
 499
 500     return state;
 501 }
 502
 503 static game_state *dup_game(game_state *state)
 504 {
 505     game_state *ret = snew(game_state);
 506
 507     ret->w = state->w;
 508     ret->h = state->h;
 509     ret->n = state->n;
 510     ret->orientable = state->orientable;
 511     ret->completed = state->completed;
 512     ret->movecount = state->movecount;
 513     ret->movetarget = state->movetarget;
 514     ret->lastx = state->lastx;
 515     ret->lasty = state->lasty;
 516     ret->lastr = state->lastr;
 517     ret->used_solve = state->used_solve;
 518
 519     ret->grid = snewn(ret->w * ret->h, int);
 520     memcpy(ret->grid, state->grid, ret->w * ret->h * sizeof(int));
 521
 522     return ret;
 523 }
 524
 525 static void free_game(game_state *state)
 526 {
 527     sfree(state->grid);
 528     sfree(state);
 529 }
 530
 531 static int compare_int(const void *av, const void *bv)
 532 {
 533     const int *a = (const int *)av;
 534     const int *b = (const int *)bv;
 535     if (*a < *b)
 536         return -1;
 537     else if (*a > *b)
 538         return +1;
 539     else
 540         return 0;
 541 }
 542
 543 static char *solve_game(game_state *state, game_state *currstate,
 544                         char *aux, char **error)
 545 {
 546     return dupstr("S");
 547 }
 548
 549 static int game_can_format_as_text_now(game_params *params)
 550 {
 551     return TRUE;
 552 }
 553
 554 static char *game_text_format(game_state *state)
 555 {
 556     char *ret, *p, buf[80];
 557     int i, x, y, col, o, maxlen;
 558
 559     /*
 560      * First work out how many characters we need to display each
 561      * number. We're pretty flexible on grid contents here, so we
 562      * have to scan the entire grid.
 563      */
 564     col = 0;
 565     for (i = 0; i < state->w * state->h; i++) {
 566         x = sprintf(buf, "%d", state->grid[i] / 4);
 567         if (col < x) col = x;
 568     }
 569     o = (state->orientable ? 1 : 0);
 570
 571     /*
 572      * Now we know the exact total size of the grid we're going to
 573      * produce: it's got h rows, each containing w lots of col+o,
 574      * w-1 spaces and a trailing newline.
 575      */
 576     maxlen = state->h * state->w * (col+o+1);
 577
 578     ret = snewn(maxlen+1, char);
 579     p = ret;
 580
 581     for (y = 0; y < state->h; y++) {
 582         for (x = 0; x < state->w; x++) {
 583             int v = state->grid[state->w*y+x];
 584             sprintf(buf, "%*d", col, v/4);
 585             memcpy(p, buf, col);
 586             p += col;
 587             if (o)
 588                 *p++ = "^<v>"[v & 3];
 589             if (x+1 == state->w)
 590                 *p++ = '\n';
 591             else
 592                 *p++ = ' ';
 593         }
 594     }
 595
 596     assert(p - ret == maxlen);
 597     *p = '\0';
 598     return ret;
 599 }
 600
 601 struct game_ui {
 602     int cur_x, cur_y;
 603     int cur_visible;
 604 };
 605
 606 static game_ui *new_ui(game_state *state)
 607 {
 608     game_ui *ui = snew(game_ui);
 609
 610     ui->cur_x = 0;
 611     ui->cur_y = 0;
 612     ui->cur_visible = FALSE;
 613
 614     return ui;
 615 }
 616
 617 static void free_ui(game_ui *ui)
 618 {
 619     sfree(ui);
 620 }
 621
 622 static char *encode_ui(game_ui *ui)
 623 {
 624     return NULL;
 625 }
 626
 627 static void decode_ui(game_ui *ui, char *encoding)
 628 {
 629 }
 630
 631 static void game_changed_state(game_ui *ui, game_state *oldstate,
 632                                game_state *newstate)
 633 {
 634 }
 635
 636 struct game_drawstate {
 637     int started;
 638     int w, h, bgcolour;
 639     int *grid;
 640     int tilesize;
 641     int cur_x, cur_y;
 642 };
 643
 644 static char *interpret_move(game_state *state, game_ui *ui, game_drawstate *ds,
 645                             int x, int y, int button)
 646 {
 647     int w = state->w, h = state->h, n = state->n /* , wh = w*h */;
 648     char buf[80];
 649     int dir;
 650
 651     button = button & (~MOD_MASK | MOD_NUM_KEYPAD);
 652
 653     if (IS_CURSOR_MOVE(button)) {
 654         if (button == CURSOR_LEFT && ui->cur_x > 0)
 655             ui->cur_x--;
 656         if (button == CURSOR_RIGHT && (ui->cur_x+n) < (w))
 657             ui->cur_x++;
 658         if (button == CURSOR_UP && ui->cur_y > 0)
 659             ui->cur_y--;
 660         if (button == CURSOR_DOWN && (ui->cur_y+n) < (h))
 661             ui->cur_y++;
 662         ui->cur_visible = 1;
 663         return "";
 664     }
 665
 666     if (button == LEFT_BUTTON || button == RIGHT_BUTTON) {
 667         /*
 668          * Determine the coordinates of the click. We offset by n-1
 669          * half-blocks so that the user must click at the centre of
 670          * a rotation region rather than at the corner.
 671          */
 672         x -= (n-1) * TILE_SIZE / 2;
 673         y -= (n-1) * TILE_SIZE / 2;
 674         x = FROMCOORD(x);
 675         y = FROMCOORD(y);
 676         dir = (button == LEFT_BUTTON ? 1 : -1);
 677         if (x < 0 || x > w-n || y < 0 || y > h-n)
 678             return NULL;
 679         ui->cur_visible = 0;
 680     } else if (IS_CURSOR_SELECT(button)) {
 681         if (ui->cur_visible) {
 682             x = ui->cur_x;
 683             y = ui->cur_y;
 684             dir = (button == CURSOR_SELECT2) ? -1 : +1;
 685         } else {
 686             ui->cur_visible = 1;
 687             return "";
 688         }
 689     } else if (button == 'a' || button == 'A' || button==MOD_NUM_KEYPAD+'7') {
 690         x = y = 0;
 691         dir = (button == 'A' ? -1 : +1);
 692     } else if (button == 'b' || button == 'B' || button==MOD_NUM_KEYPAD+'9') {
 693         x = w-n;
 694         y = 0;
 695         dir = (button == 'B' ? -1 : +1);
 696     } else if (button == 'c' || button == 'C' || button==MOD_NUM_KEYPAD+'1') {
 697         x = 0;
 698         y = h-n;
 699         dir = (button == 'C' ? -1 : +1);
 700     } else if (button == 'd' || button == 'D' || button==MOD_NUM_KEYPAD+'3') {
 701         x = w-n;
 702         y = h-n;
 703         dir = (button == 'D' ? -1 : +1);
 704     } else if (button==MOD_NUM_KEYPAD+'8' && (w-n) % 2 == 0) {
 705         x = (w-n) / 2;
 706         y = 0;
 707         dir = +1;
 708     } else if (button==MOD_NUM_KEYPAD+'2' && (w-n) % 2 == 0) {
 709         x = (w-n) / 2;
 710         y = h-n;
 711         dir = +1;
 712     } else if (button==MOD_NUM_KEYPAD+'4' && (h-n) % 2 == 0) {
 713         x = 0;
 714         y = (h-n) / 2;
 715         dir = +1;
 716     } else if (button==MOD_NUM_KEYPAD+'6' && (h-n) % 2 == 0) {
 717         x = w-n;
 718         y = (h-n) / 2;
 719         dir = +1;
 720     } else if (button==MOD_NUM_KEYPAD+'5' && (w-n) % 2 == 0 && (h-n) % 2 == 0){
 721         x = (w-n) / 2;
 722         y = (h-n) / 2;
 723         dir = +1;
 724     } else {
 725         return NULL;                   /* no move to be made */
 726     }
 727
 728     /*
 729      * If we reach here, we have a valid move.
 730      */
 731     sprintf(buf, "M%d,%d,%d", x, y, dir);
 732     return dupstr(buf);
 733 }
 734
 735 static game_state *execute_move(game_state *from, char *move)
 736 {
 737     game_state *ret;
 738     int w = from->w, h = from->h, n = from->n, wh = w*h;
 739     int x, y, dir;
 740
 741     if (!strcmp(move, "S")) {
 742         int i;
 743         ret = dup_game(from);
 744
 745         /*
 746          * Simply replace the grid with a solved one. For this game,
 747          * this isn't a useful operation for actually telling the user
 748          * what they should have done, but it is useful for
 749          * conveniently being able to get hold of a clean state from
 750          * which to practise manoeuvres.
 751          */
 752         qsort(ret->grid, ret->w*ret->h, sizeof(int), compare_int);
 753         for (i = 0; i < ret->w*ret->h; i++)
 754             ret->grid[i] &= ~3;
 755         ret->used_solve = TRUE;
 756         ret->completed = ret->movecount = 1;
 757
 758         return ret;
 759     }
 760
 761     if (move[0] != 'M' ||
 762         sscanf(move+1, "%d,%d,%d", &x, &y, &dir) != 3 ||
 763         x < 0 || y < 0 || x > from->w - n || y > from->h - n)
 764         return NULL;                   /* can't parse this move string */
 765
 766     ret = dup_game(from);
 767     ret->movecount++;
 768     do_rotate(ret->grid, w, h, n, ret->orientable, x, y, dir);
 769     ret->lastx = x;
 770     ret->lasty = y;
 771     ret->lastr = dir;
 772
 773     /*
 774      * See if the game has been completed. To do this we simply
 775      * test that the grid contents are in increasing order.
 776      */
 777     if (!ret->completed && grid_complete(ret->grid, wh, ret->orientable))
 778         ret->completed = ret->movecount;
 779     return ret;
 780 }
 781
 782 /* ----------------------------------------------------------------------
 783  * Drawing routines.
 784  */
 785
 786 static void game_compute_size(game_params *params, int tilesize,
 787                               int *x, int *y)
 788 {
 789     /* Ick: fake up `ds->tilesize' for macro expansion purposes */
 790     struct { int tilesize; } ads, *ds = &ads;
 791     ads.tilesize = tilesize;
 792
 793     *x = TILE_SIZE * params->w + 2 * BORDER;
 794     *y = TILE_SIZE * params->h + 2 * BORDER;
 795 }
 796
 797 static void game_set_size(drawing *dr, game_drawstate *ds,
 798                           game_params *params, int tilesize)
 799 {
 800     ds->tilesize = tilesize;
 801 }
 802
 803 static float *game_colours(frontend *fe, int *ncolours)
 804 {
 805     float *ret = snewn(3 * NCOLOURS, float);
 806     int i;
 807
 808     game_mkhighlight(fe, ret, COL_BACKGROUND, COL_HIGHLIGHT, COL_LOWLIGHT);
 809
 810     /* cursor is light-background with a red tinge. */
 811     ret[COL_HIGHCURSOR * 3 + 0] = ret[COL_BACKGROUND * 3 + 0] * 1.0F;
 812     ret[COL_HIGHCURSOR * 3 + 1] = ret[COL_BACKGROUND * 3 + 1] * 0.5F;
 813     ret[COL_HIGHCURSOR * 3 + 2] = ret[COL_BACKGROUND * 3 + 2] * 0.5F;
 814
 815     for (i = 0; i < 3; i++) {
 816         ret[COL_HIGHLIGHT_GENTLE * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 1.1F;
 817         ret[COL_LOWLIGHT_GENTLE * 3 + i] = ret[COL_BACKGROUND * 3 + i] * 0.9F;
 818         ret[COL_TEXT * 3 + i] = 0.0;
 819         ret[COL_LOWCURSOR * 3 + i] = ret[COL_HIGHCURSOR * 3 + i] * 0.6F;
 820     }
 821
 822     *ncolours = NCOLOURS;
 823     return ret;
 824 }
 825
 826 static game_drawstate *game_new_drawstate(drawing *dr, game_state *state)
 827 {
 828     struct game_drawstate *ds = snew(struct game_drawstate);
 829     int i;
 830
 831     ds->started = FALSE;
 832     ds->w = state->w;
 833     ds->h = state->h;
 834     ds->bgcolour = COL_BACKGROUND;
 835     ds->grid = snewn(ds->w*ds->h, int);
 836     ds->tilesize = 0;                  /* haven't decided yet */
 837     for (i = 0; i < ds->w*ds->h; i++)
 838         ds->grid[i] = -1;
 839     ds->cur_x = ds->cur_y = -state->n;
 840
 841     return ds;
 842 }
 843
 844 static void game_free_drawstate(drawing *dr, game_drawstate *ds)
 845 {
 846     sfree(ds->grid);
 847     sfree(ds);
 848 }
 849
 850 struct rotation {
 851     int cx, cy, cw, ch;                /* clip region */
 852     int ox, oy;                        /* rotation origin */
 853     float c, s;                        /* cos and sin of rotation angle */
 854     int lc, rc, tc, bc;                /* colours of tile edges */
 855 };
 856
 857 static void rotate(int *xy, struct rotation *rot)
 858 {
 859     if (rot) {
 860         float xf = (float)xy[0] - rot->ox, yf = (float)xy[1] - rot->oy;
 861         float xf2, yf2;
 862
 863         xf2 = rot->c * xf + rot->s * yf;
 864         yf2 = - rot->s * xf + rot->c * yf;
 865
 866         xy[0] = (int)(xf2 + rot->ox + 0.5);   /* round to nearest */
 867         xy[1] = (int)(yf2 + rot->oy + 0.5);   /* round to nearest */
 868     }
 869 }
 870
 871 #define CUR_TOP         1
 872 #define CUR_RIGHT       2
 873 #define CUR_BOTTOM      4
 874 #define CUR_LEFT        8
 875
 876 static void draw_tile(drawing *dr, game_drawstate *ds, game_state *state,
 877                       int x, int y, int tile, int flash_colour,
 878                       struct rotation *rot, unsigned cedges)
 879 {
 880     int coords[8];
 881     char str[40];
 882
 883     /*
 884      * If we've been passed a rotation region but we're drawing a
 885      * tile which is outside it, we must draw it normally. This can
 886      * occur if we're cleaning up after a completion flash while a
 887      * new move is also being made.
 888      */
 889     if (rot && (x < rot->cx || y < rot->cy ||
 890                 x >= rot->cx+rot->cw || y >= rot->cy+rot->ch))
 891         rot = NULL;
 892
 893     if (rot)
 894         clip(dr, rot->cx, rot->cy, rot->cw, rot->ch);
 895
 896     /*
 897      * We must draw each side of the tile's highlight separately,
 898      * because in some cases (during rotation) they will all need
 899      * to be different colours.
 900      */
 901
 902     /* The centre point is common to all sides. */
 903     coords[4] = x + TILE_SIZE / 2;
 904     coords[5] = y + TILE_SIZE / 2;
 905     rotate(coords+4, rot);
 906
 907     /* Right side. */
 908     coords[0] = x + TILE_SIZE - 1;
 909     coords[1] = y + TILE_SIZE - 1;
 910     rotate(coords+0, rot);
 911     coords[2] = x + TILE_SIZE - 1;
 912     coords[3] = y;
 913     rotate(coords+2, rot);
 914     draw_polygon(dr, coords, 3, rot ? rot->rc : COL_LOWLIGHT,
 915                  rot ? rot->rc : (cedges & CUR_RIGHT) ? COL_LOWCURSOR : COL_LOWLIGHT);
 916
 917     /* Bottom side. */
 918     coords[2] = x;
 919     coords[3] = y + TILE_SIZE - 1;
 920     rotate(coords+2, rot);
 921     draw_polygon(dr, coords, 3, rot ? rot->bc : COL_LOWLIGHT,
 922                  rot ? rot->bc : (cedges & CUR_BOTTOM) ? COL_LOWCURSOR : COL_LOWLIGHT);
 923
 924     /* Left side. */
 925     coords[0] = x;
 926     coords[1] = y;
 927     rotate(coords+0, rot);
 928     draw_polygon(dr, coords, 3, rot ? rot->lc : COL_HIGHLIGHT,
 929                  rot ? rot->lc : (cedges & CUR_LEFT) ? COL_HIGHCURSOR : COL_HIGHLIGHT);
 930
 931     /* Top side. */
 932     coords[2] = x + TILE_SIZE - 1;
 933     coords[3] = y;
 934     rotate(coords+2, rot);
 935     draw_polygon(dr, coords, 3, rot ? rot->tc : COL_HIGHLIGHT,
 936                  rot ? rot->tc : (cedges & CUR_TOP) ? COL_HIGHCURSOR : COL_HIGHLIGHT);
 937
 938     /*
 939      * Now the main blank area in the centre of the tile.
 940      */
 941     if (rot) {
 942         coords[0] = x + HIGHLIGHT_WIDTH;
 943         coords[1] = y + HIGHLIGHT_WIDTH;
 944         rotate(coords+0, rot);
 945         coords[2] = x + HIGHLIGHT_WIDTH;
 946         coords[3] = y + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 947         rotate(coords+2, rot);
 948         coords[4] = x + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 949         coords[5] = y + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 950         rotate(coords+4, rot);
 951         coords[6] = x + TILE_SIZE - 1 - HIGHLIGHT_WIDTH;
 952         coords[7] = y + HIGHLIGHT_WIDTH;
 953         rotate(coords+6, rot);
 954         draw_polygon(dr, coords, 4, flash_colour, flash_colour);
 955     } else {
 956         draw_rect(dr, x + HIGHLIGHT_WIDTH, y + HIGHLIGHT_WIDTH,
 957                   TILE_SIZE - 2*HIGHLIGHT_WIDTH, TILE_SIZE - 2*HIGHLIGHT_WIDTH,
 958                   flash_colour);
 959     }
 960
 961     /*
 962      * Next, the triangles for orientation.
 963      */
 964     if (state->orientable) {
 965         int xdx, xdy, ydx, ydy;
 966         int cx, cy, displ, displ2;
 967         switch (tile & 3) {
 968           case 0:
 969             xdx = 1, xdy = 0;
 970             ydx = 0, ydy = 1;
 971             break;
 972           case 1:
 973             xdx = 0, xdy = -1;
 974             ydx = 1, ydy = 0;
 975             break;
 976           case 2:
 977             xdx = -1, xdy = 0;
 978             ydx = 0, ydy = -1;
 979             break;
 980           default /* case 3 */:
 981             xdx = 0, xdy = 1;
 982             ydx = -1, ydy = 0;
 983             break;
 984         }
 985
 986         cx = x + TILE_SIZE / 2;
 987         cy = y + TILE_SIZE / 2;
 988         displ = TILE_SIZE / 2 - HIGHLIGHT_WIDTH - 2;
 989         displ2 = TILE_SIZE / 3 - HIGHLIGHT_WIDTH;
 990
 991         coords[0] = cx - displ * xdx + displ2 * ydx;
 992         coords[1] = cy - displ * xdy + displ2 * ydy;
 993         rotate(coords+0, rot);
 994         coords[2] = cx + displ * xdx + displ2 * ydx;
 995         coords[3] = cy + displ * xdy + displ2 * ydy;
 996         rotate(coords+2, rot);
 997         coords[4] = cx - displ * ydx;
 998         coords[5] = cy - displ * ydy;
 999         rotate(coords+4, rot);
1000         draw_polygon(dr, coords, 3, COL_LOWLIGHT_GENTLE, COL_LOWLIGHT_GENTLE);
1001     }
1002
1003     coords[0] = x + TILE_SIZE/2;
1004     coords[1] = y + TILE_SIZE/2;
1005     rotate(coords+0, rot);
1006     sprintf(str, "%d", tile / 4);
1007     draw_text(dr, coords[0], coords[1],
1008               FONT_VARIABLE, TILE_SIZE/3, ALIGN_VCENTRE | ALIGN_HCENTRE,
1009               COL_TEXT, str);
1010
1011     if (rot)
1012         unclip(dr);
1013
1014     draw_update(dr, x, y, TILE_SIZE, TILE_SIZE);
1015 }
1016
1017 static int highlight_colour(float angle)
1018 {
1019     int colours[32] = {
1020         COL_LOWLIGHT,
1021         COL_LOWLIGHT_GENTLE,
1022         COL_LOWLIGHT_GENTLE,
1023         COL_LOWLIGHT_GENTLE,
1024         COL_HIGHLIGHT_GENTLE,
1025         COL_HIGHLIGHT_GENTLE,
1026         COL_HIGHLIGHT_GENTLE,
1027         COL_HIGHLIGHT,
1028         COL_HIGHLIGHT,
1029         COL_HIGHLIGHT,
1030         COL_HIGHLIGHT,
1031         COL_HIGHLIGHT,
1032         COL_HIGHLIGHT,
1033         COL_HIGHLIGHT,
1034         COL_HIGHLIGHT,
1035         COL_HIGHLIGHT,
1036         COL_HIGHLIGHT,
1037         COL_HIGHLIGHT_GENTLE,
1038         COL_HIGHLIGHT_GENTLE,
1039         COL_HIGHLIGHT_GENTLE,
1040         COL_LOWLIGHT_GENTLE,
1041         COL_LOWLIGHT_GENTLE,
1042         COL_LOWLIGHT_GENTLE,
1043         COL_LOWLIGHT,
1044         COL_LOWLIGHT,
1045         COL_LOWLIGHT,
1046         COL_LOWLIGHT,
1047         COL_LOWLIGHT,
1048         COL_LOWLIGHT,
1049         COL_LOWLIGHT,
1050         COL_LOWLIGHT,
1051         COL_LOWLIGHT,
1052     };
1053
1054     return colours[(int)((angle + 2*PI) / (PI/16)) & 31];
1055 }
1056
1057 static float game_anim_length(game_state *oldstate, game_state *newstate,
1058                               int dir, game_ui *ui)
1059 {
1060     return (float)(ANIM_PER_RADIUS_UNIT * sqrt(newstate->n-1));
1061 }
1062
1063 static float game_flash_length(game_state *oldstate, game_state *newstate,
1064                                int dir, game_ui *ui)
1065 {
1066     if (!oldstate->completed && newstate->completed &&
1067         !oldstate->used_solve && !newstate->used_solve)
1068         return 2 * FLASH_FRAME;
1069     else
1070         return 0.0F;
1071 }
1072
1073 static void game_redraw(drawing *dr, game_drawstate *ds, game_state *oldstate,
1074                         game_state *state, int dir, game_ui *ui,
1075                         float animtime, float flashtime)
1076 {
1077     int i, bgcolour;
1078     struct rotation srot, *rot;
1079     int lastx = -1, lasty = -1, lastr = -1;
1080     int cx, cy, cmoved = 0, n = state->n;
1081
1082     cx = ui->cur_visible ? ui->cur_x : -state->n;
1083     cy = ui->cur_visible ? ui->cur_y : -state->n;
1084     if (cx != ds->cur_x || cy != ds->cur_y)
1085         cmoved = 1;
1086
1087     if (flashtime > 0) {
1088         int frame = (int)(flashtime / FLASH_FRAME);
1089         bgcolour = (frame % 2 ? COL_LOWLIGHT : COL_HIGHLIGHT);
1090     } else
1091         bgcolour = COL_BACKGROUND;
1092
1093     if (!ds->started) {
1094         int coords[10];
1095
1096         draw_rect(dr, 0, 0,
1097                   TILE_SIZE * state->w + 2 * BORDER,
1098                   TILE_SIZE * state->h + 2 * BORDER, COL_BACKGROUND);
1099         draw_update(dr, 0, 0,
1100                     TILE_SIZE * state->w + 2 * BORDER,
1101                     TILE_SIZE * state->h + 2 * BORDER);
1102
1103         /*
1104          * Recessed area containing the whole puzzle.
1105          */
1106         coords[0] = COORD(state->w) + HIGHLIGHT_WIDTH - 1;
1107         coords[1] = COORD(state->h) + HIGHLIGHT_WIDTH - 1;
1108         coords[2] = COORD(state->w) + HIGHLIGHT_WIDTH - 1;
1109         coords[3] = COORD(0) - HIGHLIGHT_WIDTH;
1110         coords[4] = coords[2] - TILE_SIZE;
1111         coords[5] = coords[3] + TILE_SIZE;
1112         coords[8] = COORD(0) - HIGHLIGHT_WIDTH;
1113         coords[9] = COORD(state->h) + HIGHLIGHT_WIDTH - 1;
1114         coords[6] = coords[8] + TILE_SIZE;
1115         coords[7] = coords[9] - TILE_SIZE;
1116         draw_polygon(dr, coords, 5, COL_HIGHLIGHT, COL_HIGHLIGHT);
1117
1118         coords[1] = COORD(0) - HIGHLIGHT_WIDTH;
1119         coords[0] = COORD(0) - HIGHLIGHT_WIDTH;
1120         draw_polygon(dr, coords, 5, COL_LOWLIGHT, COL_LOWLIGHT);
1121
1122         ds->started = TRUE;
1123     }
1124
1125     /*
1126      * If we're drawing any rotated tiles, sort out the rotation
1127      * parameters, and also zap the rotation region to the
1128      * background colour before doing anything else.
1129      */
1130     if (oldstate) {
1131         float angle;
1132         float anim_max = game_anim_length(oldstate, state, dir, ui);
1133
1134         if (dir > 0) {
1135             lastx = state->lastx;
1136             lasty = state->lasty;
1137             lastr = state->lastr;
1138         } else {
1139             lastx = oldstate->lastx;
1140             lasty = oldstate->lasty;
1141             lastr = -oldstate->lastr;
1142         }
1143
1144         rot = &srot;
1145         rot->cx = COORD(lastx);
1146         rot->cy = COORD(lasty);
1147         rot->cw = rot->ch = TILE_SIZE * state->n;
1148         rot->ox = rot->cx + rot->cw/2;
1149         rot->oy = rot->cy + rot->ch/2;
1150         angle = (float)((-PI/2 * lastr) * (1.0 - animtime / anim_max));
1151         rot->c = (float)cos(angle);
1152         rot->s = (float)sin(angle);
1153
1154         /*
1155          * Sort out the colours of the various sides of the tile.
1156          */
1157         rot->lc = highlight_colour((float)PI + angle);
1158         rot->rc = highlight_colour(angle);
1159         rot->tc = highlight_colour((float)(PI/2.0) + angle);
1160         rot->bc = highlight_colour((float)(-PI/2.0) + angle);
1161
1162         draw_rect(dr, rot->cx, rot->cy, rot->cw, rot->ch, bgcolour);
1163     } else
1164         rot = NULL;
1165
1166     /*
1167      * Now draw each tile.
1168      */
1169     for (i = 0; i < state->w * state->h; i++) {
1170         int t, cc = 0;
1171         int tx = i % state->w, ty = i / state->w;
1172
1173         /*
1174          * Figure out what should be displayed at this location.
1175          * Usually it will be state->grid[i], unless we're in the
1176          * middle of animating an actual rotation and this cell is
1177          * within the rotation region, in which case we set -1
1178          * (always display).
1179          */
1180         if (oldstate && lastx >= 0 && lasty >= 0 &&
1181             tx >= lastx && tx < lastx + state->n &&
1182             ty >= lasty && ty < lasty + state->n)
1183             t = -1;
1184         else
1185             t = state->grid[i];
1186
1187         if (cmoved) {
1188             /* cursor has moved (or changed visibility)... */
1189             if (tx == cx || tx == cx+n-1 || ty == cy || ty == cy+n-1)
1190                 cc = 1; /* ...we're on new cursor, redraw */
1191             if (tx == ds->cur_x || tx == ds->cur_x+n-1 ||
1192                 ty == ds->cur_y || ty == ds->cur_y+n-1)
1193                 cc = 1; /* ...we were on old cursor, redraw */
1194         }
1195
1196         if (ds->bgcolour != bgcolour ||   /* always redraw when flashing */
1197             ds->grid[i] != t || ds->grid[i] == -1 || t == -1 || cc) {
1198             int x = COORD(tx), y = COORD(ty);
1199             unsigned cedges = 0;
1200
1201             if (tx == cx     && ty >= cy && ty <= cy+n-1) cedges |= CUR_LEFT;
1202             if (ty == cy     && tx >= cx && tx <= cx+n-1) cedges |= CUR_TOP;
1203             if (tx == cx+n-1 && ty >= cy && ty <= cy+n-1) cedges |= CUR_RIGHT;
1204             if (ty == cy+n-1 && tx >= cx && tx <= cx+n-1) cedges |= CUR_BOTTOM;
1205
1206             draw_tile(dr, ds, state, x, y, state->grid[i], bgcolour, rot, cedges);
1207             ds->grid[i] = t;
1208         }
1209     }
1210     ds->bgcolour = bgcolour;
1211     ds->cur_x = cx; ds->cur_y = cy;
1212
1213     /*
1214      * Update the status bar.
1215      */
1216     {
1217         char statusbuf[256];
1218
1219         /*
1220          * Don't show the new status until we're also showing the
1221          * new _state_ - after the game animation is complete.
1222          */
1223         if (oldstate)
1224             state = oldstate;
1225
1226         if (state->used_solve)
1227             sprintf(statusbuf, "Moves since auto-solve: %d",
1228                     state->movecount - state->completed);
1229         else {
1230             sprintf(statusbuf, "%sMoves: %d",
1231                     (state->completed ? "COMPLETED! " : ""),
1232                     (state->completed ? state->completed : state->movecount));
1233             if (state->movetarget)
1234                 sprintf(statusbuf+strlen(statusbuf), " (target %d)",
1235                         state->movetarget);
1236         }
1237
1238         status_bar(dr, statusbuf);
1239     }
1240 }
1241
1242 static int game_timing_state(game_state *state, game_ui *ui)
1243 {
1244     return TRUE;
1245 }
1246
1247 static void game_print_size(game_params *params, float *x, float *y)
1248 {
1249 }
1250
1251 static void game_print(drawing *dr, game_state *state, int tilesize)
1252 {
1253 }
1254
1255 #ifdef COMBINED
1256 #define thegame twiddle
1257 #endif
1258
1259 const struct game thegame = {
1260     "Twiddle", "games.twiddle", "twiddle",
1261     default_params,
1262     game_fetch_preset,
1263     decode_params,
1264     encode_params,
1265     free_params,
1266     dup_params,
1267     TRUE, game_configure, custom_params,
1268     validate_params,
1269     new_game_desc,
1270     validate_desc,
1271     new_game,
1272     dup_game,
1273     free_game,
1274     TRUE, solve_game,
1275     TRUE, game_can_format_as_text_now, game_text_format,
1276     new_ui,
1277     free_ui,
1278     encode_ui,
1279     decode_ui,
1280     game_changed_state,
1281     interpret_move,
1282     execute_move,
1283     PREFERRED_TILE_SIZE, game_compute_size, game_set_size,
1284     game_colours,
1285     game_new_drawstate,
1286     game_free_drawstate,
1287     game_redraw,
1288     game_anim_length,
1289     game_flash_length,
1290     FALSE, FALSE, game_print_size, game_print,
1291     TRUE,                              /* wants_statusbar */
1292     FALSE, game_timing_state,
1293     0,                                 /* flags */
1294 };
1295
1296 /* vim: set shiftwidth=4 tabstop=8: */