2 * fifteen.c: standard 15-puzzle.
14 #define PREFERRED_TILE_SIZE 48
15 #define TILE_SIZE (ds->tilesize)
16 #define BORDER (TILE_SIZE / 2)
17 #define HIGHLIGHT_WIDTH (TILE_SIZE / 20)
18 #define COORD(x) ( (x) * TILE_SIZE + BORDER )
19 #define FROMCOORD(x) ( ((x) - BORDER + TILE_SIZE) / TILE_SIZE - 1 )
21 #define ANIM_TIME 0.13F
22 #define FLASH_FRAME 0.13F
24 #define X(state, i) ( (i) % (state)->w )
25 #define Y(state, i) ( (i) / (state)->w )
26 #define C(state, x, y) ( (y) * (state)->w + (x) )
45 int used_solve
; /* used to suppress completion flash */
49 static game_params
*default_params(void)
51 game_params
*ret
= snew(game_params
);
58 static int game_fetch_preset(int i
, char **name
, game_params
**params
)
61 *params
= default_params();
62 *name
= dupstr("4x4");
68 static void free_params(game_params
*params
)
73 static game_params
*dup_params(game_params
*params
)
75 game_params
*ret
= snew(game_params
);
76 *ret
= *params
; /* structure copy */
80 static void decode_params(game_params
*ret
, char const *string
)
82 ret
->w
= ret
->h
= atoi(string
);
83 while (*string
&& isdigit((unsigned char)*string
)) string
++;
86 ret
->h
= atoi(string
);
90 static char *encode_params(game_params
*params
, int full
)
94 sprintf(data
, "%dx%d", params
->w
, params
->h
);
99 static config_item
*game_configure(game_params
*params
)
104 ret
= snewn(3, config_item
);
106 ret
[0].name
= "Width";
107 ret
[0].type
= C_STRING
;
108 sprintf(buf
, "%d", params
->w
);
109 ret
[0].sval
= dupstr(buf
);
112 ret
[1].name
= "Height";
113 ret
[1].type
= C_STRING
;
114 sprintf(buf
, "%d", params
->h
);
115 ret
[1].sval
= dupstr(buf
);
126 static game_params
*custom_params(config_item
*cfg
)
128 game_params
*ret
= snew(game_params
);
130 ret
->w
= atoi(cfg
[0].sval
);
131 ret
->h
= atoi(cfg
[1].sval
);
136 static char *validate_params(game_params
*params
, int full
)
138 if (params
->w
< 2 || params
->h
< 2)
139 return "Width and height must both be at least two";
144 static int perm_parity(int *perm
, int n
)
150 for (i
= 0; i
< n
-1; i
++)
151 for (j
= i
+1; j
< n
; j
++)
152 if (perm
[i
] > perm
[j
])
158 static char *new_game_desc(game_params
*params
, random_state
*rs
,
159 char **aux
, int interactive
)
162 int x1
, x2
, p1
, p2
, parity
;
167 n
= params
->w
* params
->h
;
169 tiles
= snewn(n
, int);
170 used
= snewn(n
, int);
172 for (i
= 0; i
< n
; i
++) {
177 gap
= random_upto(rs
, n
);
182 * Place everything else except the last two tiles.
184 for (x
= 0, i
= n
-1; i
> 2; i
--) {
185 int k
= random_upto(rs
, i
);
188 for (j
= 0; j
< n
; j
++)
189 if (!used
[j
] && (k
-- == 0))
192 assert(j
< n
&& !used
[j
]);
195 while (tiles
[x
] >= 0)
202 * Find the last two locations, and the last two pieces.
204 while (tiles
[x
] >= 0)
209 while (tiles
[x
] >= 0)
214 for (i
= 0; i
< n
; i
++)
218 for (i
= p1
+1; i
< n
; i
++)
224 * Determine the required parity of the overall permutation.
225 * This is the XOR of:
227 * - The chessboard parity ((x^y)&1) of the gap square. The
228 * bottom right counts as even.
230 * - The parity of n. (The target permutation is 1,...,n-1,0
231 * rather than 0,...,n-1; this is a cyclic permutation of
232 * the starting point and hence is odd iff n is even.)
234 parity
= ((X(params
, gap
) - (params
->w
-1)) ^
235 (Y(params
, gap
) - (params
->h
-1)) ^
239 * Try the last two tiles one way round. If that fails, swap
244 if (perm_parity(tiles
, n
) != parity
) {
247 assert(perm_parity(tiles
, n
) == parity
);
251 * Now construct the game description, by describing the tile
252 * array as a simple sequence of comma-separated integers.
256 for (i
= 0; i
< n
; i
++) {
260 k
= sprintf(buf
, "%d,", tiles
[i
]);
262 ret
= sresize(ret
, retlen
+ k
+ 1, char);
263 strcpy(ret
+ retlen
, buf
);
266 ret
[retlen
-1] = '\0'; /* delete last comma */
274 static char *validate_desc(game_params
*params
, char *desc
)
280 area
= params
->w
* params
->h
;
284 used
= snewn(area
, int);
285 for (i
= 0; i
< area
; i
++)
288 for (i
= 0; i
< area
; i
++) {
292 if (*p
< '0' || *p
> '9') {
293 err
= "Not enough numbers in string";
296 while (*p
>= '0' && *p
<= '9')
298 if (i
< area
-1 && *p
!= ',') {
299 err
= "Expected comma after number";
302 else if (i
== area
-1 && *p
) {
303 err
= "Excess junk at end of string";
307 if (n
< 0 || n
>= area
) {
308 err
= "Number out of range";
312 err
= "Number used twice";
317 if (*p
) p
++; /* eat comma */
325 static game_state
*new_game(midend
*me
, game_params
*params
, char *desc
)
327 game_state
*state
= snew(game_state
);
331 state
->w
= params
->w
;
332 state
->h
= params
->h
;
333 state
->n
= params
->w
* params
->h
;
334 state
->tiles
= snewn(state
->n
, int);
339 for (i
= 0; i
< state
->n
; i
++) {
341 state
->tiles
[i
] = atoi(p
);
342 if (state
->tiles
[i
] == 0)
344 while (*p
&& *p
!= ',')
346 if (*p
) p
++; /* eat comma */
349 assert(state
->tiles
[state
->gap_pos
] == 0);
351 state
->completed
= state
->movecount
= 0;
352 state
->used_solve
= FALSE
;
357 static game_state
*dup_game(game_state
*state
)
359 game_state
*ret
= snew(game_state
);
364 ret
->tiles
= snewn(state
->w
* state
->h
, int);
365 memcpy(ret
->tiles
, state
->tiles
, state
->w
* state
->h
* sizeof(int));
366 ret
->gap_pos
= state
->gap_pos
;
367 ret
->completed
= state
->completed
;
368 ret
->movecount
= state
->movecount
;
369 ret
->used_solve
= state
->used_solve
;
374 static void free_game(game_state
*state
)
380 static char *solve_game(game_state
*state
, game_state
*currstate
,
381 char *aux
, char **error
)
386 static char *game_text_format(game_state
*state
)
388 char *ret
, *p
, buf
[80];
389 int x
, y
, col
, maxlen
;
392 * First work out how many characters we need to display each
395 col
= sprintf(buf
, "%d", state
->n
-1);
398 * Now we know the exact total size of the grid we're going to
399 * produce: it's got h rows, each containing w lots of col, w-1
400 * spaces and a trailing newline.
402 maxlen
= state
->h
* state
->w
* (col
+1);
404 ret
= snewn(maxlen
+1, char);
407 for (y
= 0; y
< state
->h
; y
++) {
408 for (x
= 0; x
< state
->w
; x
++) {
409 int v
= state
->tiles
[state
->w
*y
+x
];
411 sprintf(buf
, "%*s", col
, "");
413 sprintf(buf
, "%*d", col
, v
);
423 assert(p
- ret
== maxlen
);
428 static game_ui
*new_ui(game_state
*state
)
433 static void free_ui(game_ui
*ui
)
437 static char *encode_ui(game_ui
*ui
)
442 static void decode_ui(game_ui
*ui
, char *encoding
)
446 static void game_changed_state(game_ui
*ui
, game_state
*oldstate
,
447 game_state
*newstate
)
451 struct game_drawstate
{
458 static char *interpret_move(game_state
*state
, game_ui
*ui
, game_drawstate
*ds
,
459 int x
, int y
, int button
)
466 gx
= X(state
, state
->gap_pos
);
467 gy
= Y(state
, state
->gap_pos
);
469 if (button
== CURSOR_RIGHT
&& gx
> 0)
470 dx
= gx
- 1, dy
= gy
;
471 else if (button
== CURSOR_LEFT
&& gx
< state
->w
-1)
472 dx
= gx
+ 1, dy
= gy
;
473 else if (button
== CURSOR_DOWN
&& gy
> 0)
474 dy
= gy
- 1, dx
= gx
;
475 else if (button
== CURSOR_UP
&& gy
< state
->h
-1)
476 dy
= gy
+ 1, dx
= gx
;
477 else if (button
== LEFT_BUTTON
) {
480 if (dx
< 0 || dx
>= state
->w
|| dy
< 0 || dy
>= state
->h
)
481 return NULL
; /* out of bounds */
483 * Any click location should be equal to the gap location
484 * in _precisely_ one coordinate.
486 if ((dx
== gx
&& dy
== gy
) || (dx
!= gx
&& dy
!= gy
))
489 return NULL
; /* no move */
491 sprintf(buf
, "M%d,%d", dx
, dy
);
495 static game_state
*execute_move(game_state
*from
, char *move
)
497 int gx
, gy
, dx
, dy
, ux
, uy
, up
, p
;
500 if (!strcmp(move
, "S")) {
503 ret
= dup_game(from
);
506 * Simply replace the grid with a solved one. For this game,
507 * this isn't a useful operation for actually telling the user
508 * what they should have done, but it is useful for
509 * conveniently being able to get hold of a clean state from
510 * which to practise manoeuvres.
512 for (i
= 0; i
< ret
->n
; i
++)
513 ret
->tiles
[i
] = (i
+1) % ret
->n
;
514 ret
->gap_pos
= ret
->n
-1;
515 ret
->used_solve
= TRUE
;
516 ret
->completed
= ret
->movecount
= 1;
521 gx
= X(from
, from
->gap_pos
);
522 gy
= Y(from
, from
->gap_pos
);
524 if (move
[0] != 'M' ||
525 sscanf(move
+1, "%d,%d", &dx
, &dy
) != 2 ||
526 (dx
== gx
&& dy
== gy
) || (dx
!= gx
&& dy
!= gy
) ||
527 dx
< 0 || dx
>= from
->w
|| dy
< 0 || dy
>= from
->h
)
531 * Find the unit displacement from the original gap
532 * position towards this one.
534 ux
= (dx
< gx ?
-1 : dx
> gx ?
+1 : 0);
535 uy
= (dy
< gy ?
-1 : dy
> gy ?
+1 : 0);
536 up
= C(from
, ux
, uy
);
538 ret
= dup_game(from
);
540 ret
->gap_pos
= C(from
, dx
, dy
);
541 assert(ret
->gap_pos
>= 0 && ret
->gap_pos
< ret
->n
);
543 ret
->tiles
[ret
->gap_pos
] = 0;
545 for (p
= from
->gap_pos
; p
!= ret
->gap_pos
; p
+= up
) {
546 assert(p
>= 0 && p
< from
->n
);
547 ret
->tiles
[p
] = from
->tiles
[p
+ up
];
552 * See if the game has been completed.
554 if (!ret
->completed
) {
555 ret
->completed
= ret
->movecount
;
556 for (p
= 0; p
< ret
->n
; p
++)
557 if (ret
->tiles
[p
] != (p
< ret
->n
-1 ? p
+1 : 0))
564 /* ----------------------------------------------------------------------
568 static void game_compute_size(game_params
*params
, int tilesize
,
571 /* Ick: fake up `ds->tilesize' for macro expansion purposes */
572 struct { int tilesize
; } ads
, *ds
= &ads
;
573 ads
.tilesize
= tilesize
;
575 *x
= TILE_SIZE
* params
->w
+ 2 * BORDER
;
576 *y
= TILE_SIZE
* params
->h
+ 2 * BORDER
;
579 static void game_set_size(drawing
*dr
, game_drawstate
*ds
,
580 game_params
*params
, int tilesize
)
582 ds
->tilesize
= tilesize
;
585 static float *game_colours(frontend
*fe
, int *ncolours
)
587 float *ret
= snewn(3 * NCOLOURS
, float);
590 game_mkhighlight(fe
, ret
, COL_BACKGROUND
, COL_HIGHLIGHT
, COL_LOWLIGHT
);
592 for (i
= 0; i
< 3; i
++)
593 ret
[COL_TEXT
* 3 + i
] = 0.0;
595 *ncolours
= NCOLOURS
;
599 static game_drawstate
*game_new_drawstate(drawing
*dr
, game_state
*state
)
601 struct game_drawstate
*ds
= snew(struct game_drawstate
);
607 ds
->bgcolour
= COL_BACKGROUND
;
608 ds
->tiles
= snewn(ds
->w
*ds
->h
, int);
609 ds
->tilesize
= 0; /* haven't decided yet */
610 for (i
= 0; i
< ds
->w
*ds
->h
; i
++)
616 static void game_free_drawstate(drawing
*dr
, game_drawstate
*ds
)
622 static void draw_tile(drawing
*dr
, game_drawstate
*ds
, game_state
*state
,
623 int x
, int y
, int tile
, int flash_colour
)
626 draw_rect(dr
, x
, y
, TILE_SIZE
, TILE_SIZE
,
632 coords
[0] = x
+ TILE_SIZE
- 1;
633 coords
[1] = y
+ TILE_SIZE
- 1;
634 coords
[2] = x
+ TILE_SIZE
- 1;
637 coords
[5] = y
+ TILE_SIZE
- 1;
638 draw_polygon(dr
, coords
, 3, COL_LOWLIGHT
, COL_LOWLIGHT
);
642 draw_polygon(dr
, coords
, 3, COL_HIGHLIGHT
, COL_HIGHLIGHT
);
644 draw_rect(dr
, x
+ HIGHLIGHT_WIDTH
, y
+ HIGHLIGHT_WIDTH
,
645 TILE_SIZE
- 2*HIGHLIGHT_WIDTH
, TILE_SIZE
- 2*HIGHLIGHT_WIDTH
,
648 sprintf(str
, "%d", tile
);
649 draw_text(dr
, x
+ TILE_SIZE
/2, y
+ TILE_SIZE
/2,
650 FONT_VARIABLE
, TILE_SIZE
/3, ALIGN_VCENTRE
| ALIGN_HCENTRE
,
653 draw_update(dr
, x
, y
, TILE_SIZE
, TILE_SIZE
);
656 static void game_redraw(drawing
*dr
, game_drawstate
*ds
, game_state
*oldstate
,
657 game_state
*state
, int dir
, game_ui
*ui
,
658 float animtime
, float flashtime
)
660 int i
, pass
, bgcolour
;
663 int frame
= (int)(flashtime
/ FLASH_FRAME
);
664 bgcolour
= (frame
% 2 ? COL_LOWLIGHT
: COL_HIGHLIGHT
);
666 bgcolour
= COL_BACKGROUND
;
672 TILE_SIZE
* state
->w
+ 2 * BORDER
,
673 TILE_SIZE
* state
->h
+ 2 * BORDER
, COL_BACKGROUND
);
674 draw_update(dr
, 0, 0,
675 TILE_SIZE
* state
->w
+ 2 * BORDER
,
676 TILE_SIZE
* state
->h
+ 2 * BORDER
);
679 * Recessed area containing the whole puzzle.
681 coords
[0] = COORD(state
->w
) + HIGHLIGHT_WIDTH
- 1;
682 coords
[1] = COORD(state
->h
) + HIGHLIGHT_WIDTH
- 1;
683 coords
[2] = COORD(state
->w
) + HIGHLIGHT_WIDTH
- 1;
684 coords
[3] = COORD(0) - HIGHLIGHT_WIDTH
;
685 coords
[4] = coords
[2] - TILE_SIZE
;
686 coords
[5] = coords
[3] + TILE_SIZE
;
687 coords
[8] = COORD(0) - HIGHLIGHT_WIDTH
;
688 coords
[9] = COORD(state
->h
) + HIGHLIGHT_WIDTH
- 1;
689 coords
[6] = coords
[8] + TILE_SIZE
;
690 coords
[7] = coords
[9] - TILE_SIZE
;
691 draw_polygon(dr
, coords
, 5, COL_HIGHLIGHT
, COL_HIGHLIGHT
);
693 coords
[1] = COORD(0) - HIGHLIGHT_WIDTH
;
694 coords
[0] = COORD(0) - HIGHLIGHT_WIDTH
;
695 draw_polygon(dr
, coords
, 5, COL_LOWLIGHT
, COL_LOWLIGHT
);
701 * Now draw each tile. We do this in two passes to make
704 for (pass
= 0; pass
< 2; pass
++) {
705 for (i
= 0; i
< state
->n
; i
++) {
708 * Figure out what should be displayed at this
709 * location. It's either a simple tile, or it's a
710 * transition between two tiles (in which case we say
711 * -1 because it must always be drawn).
714 if (oldstate
&& oldstate
->tiles
[i
] != state
->tiles
[i
])
721 if (ds
->bgcolour
!= bgcolour
|| /* always redraw when flashing */
722 ds
->tiles
[i
] != t
|| ds
->tiles
[i
] == -1 || t
== -1) {
726 * Figure out what to _actually_ draw, and where to
734 * On the first pass, just blank the tile.
737 x
= COORD(X(state
, i
));
738 y
= COORD(Y(state
, i
));
746 * Don't bother moving the gap; just don't
753 * Find the coordinates of this tile in the old and
756 x1
= COORD(X(state
, i
));
757 y1
= COORD(Y(state
, i
));
758 for (j
= 0; j
< oldstate
->n
; j
++)
759 if (oldstate
->tiles
[j
] == state
->tiles
[i
])
761 assert(j
< oldstate
->n
);
762 x0
= COORD(X(state
, j
));
763 y0
= COORD(Y(state
, j
));
765 c
= (animtime
/ ANIM_TIME
);
766 if (c
< 0.0F
) c
= 0.0F
;
767 if (c
> 1.0F
) c
= 1.0F
;
769 x
= x0
+ (int)(c
* (x1
- x0
));
770 y
= y0
+ (int)(c
* (y1
- y0
));
776 x
= COORD(X(state
, i
));
777 y
= COORD(Y(state
, i
));
780 draw_tile(dr
, ds
, state
, x
, y
, t
, bgcolour
);
785 ds
->bgcolour
= bgcolour
;
788 * Update the status bar.
794 * Don't show the new status until we're also showing the
795 * new _state_ - after the game animation is complete.
800 if (state
->used_solve
)
801 sprintf(statusbuf
, "Moves since auto-solve: %d",
802 state
->movecount
- state
->completed
);
804 sprintf(statusbuf
, "%sMoves: %d",
805 (state
->completed ?
"COMPLETED! " : ""),
806 (state
->completed ? state
->completed
: state
->movecount
));
808 status_bar(dr
, statusbuf
);
812 static float game_anim_length(game_state
*oldstate
,
813 game_state
*newstate
, int dir
, game_ui
*ui
)
818 static float game_flash_length(game_state
*oldstate
,
819 game_state
*newstate
, int dir
, game_ui
*ui
)
821 if (!oldstate
->completed
&& newstate
->completed
&&
822 !oldstate
->used_solve
&& !newstate
->used_solve
)
823 return 2 * FLASH_FRAME
;
828 static int game_timing_state(game_state
*state
, game_ui
*ui
)
833 static void game_print_size(game_params
*params
, float *x
, float *y
)
837 static void game_print(drawing
*dr
, game_state
*state
, int tilesize
)
842 #define thegame fifteen
845 const struct game thegame
= {
846 "Fifteen", "games.fifteen", "fifteen",
853 TRUE
, game_configure
, custom_params
,
861 TRUE
, game_text_format
,
869 PREFERRED_TILE_SIZE
, game_compute_size
, game_set_size
,
876 FALSE
, FALSE
, game_print_size
, game_print
,
877 TRUE
, /* wants_statusbar */
878 FALSE
, game_timing_state
,