Patch from James H to abstract out of Dominosa the code which
[sgt/puzzles] / solo.c
CommitLineData
1d8e8ad8 1/*
2 * solo.c: the number-placing puzzle most popularly known as `Sudoku'.
3 *
4 * TODO:
5 *
c8266e03 6 * - reports from users are that `Trivial'-mode puzzles are still
7 * rather hard compared to newspapers' easy ones, so some better
8 * low-end difficulty grading would be nice
9 * + it's possible that really easy puzzles always have
10 * _several_ things you can do, so don't make you hunt too
11 * hard for the one deduction you can currently make
12 * + it's also possible that easy puzzles require fewer
13 * cross-eliminations: perhaps there's a higher incidence of
14 * things you can deduce by looking only at (say) rows,
15 * rather than things you have to check both rows and columns
16 * for
17 * + but really, what I need to do is find some really easy
18 * puzzles and _play_ them, to see what's actually easy about
19 * them
20 * + while I'm revamping this area, filling in the _last_
21 * number in a nearly-full row or column should certainly be
22 * permitted even at the lowest difficulty level.
23 * + also Owen noticed that `Basic' grids requiring numeric
24 * elimination are actually very hard, so I wonder if a
25 * difficulty gradation between that and positional-
26 * elimination-only might be in order
27 * + but it's not good to have _too_ many difficulty levels, or
28 * it'll take too long to randomly generate a given level.
29 *
ef57b17d 30 * - it might still be nice to do some prioritisation on the
31 * removal of numbers from the grid
32 * + one possibility is to try to minimise the maximum number
33 * of filled squares in any block, which in particular ought
34 * to enforce never leaving a completely filled block in the
35 * puzzle as presented.
1d8e8ad8 36 *
37 * - alternative interface modes
38 * + sudoku.com's Windows program has a palette of possible
39 * entries; you select a palette entry first and then click
40 * on the square you want it to go in, thus enabling
41 * mouse-only play. Useful for PDAs! I don't think it's
42 * actually incompatible with the current highlight-then-type
43 * approach: you _either_ highlight a palette entry and then
44 * click, _or_ you highlight a square and then type. At most
45 * one thing is ever highlighted at a time, so there's no way
46 * to confuse the two.
c8266e03 47 * + then again, I don't actually like sudoku.com's interface;
48 * it's too much like a paint package whereas I prefer to
49 * think of Solo as a text editor.
50 * + another PDA-friendly possibility is a drag interface:
51 * _drag_ numbers from the palette into the grid squares.
52 * Thought experiments suggest I'd prefer that to the
53 * sudoku.com approach, but I haven't actually tried it.
1d8e8ad8 54 */
55
56/*
57 * Solo puzzles need to be square overall (since each row and each
58 * column must contain one of every digit), but they need not be
59 * subdivided the same way internally. I am going to adopt a
60 * convention whereby I _always_ refer to `r' as the number of rows
61 * of _big_ divisions, and `c' as the number of columns of _big_
62 * divisions. Thus, a 2c by 3r puzzle looks something like this:
63 *
64 * 4 5 1 | 2 6 3
65 * 6 3 2 | 5 4 1
66 * ------+------ (Of course, you can't subdivide it the other way
67 * 1 4 5 | 6 3 2 or you'll get clashes; observe that the 4 in the
68 * 3 2 6 | 4 1 5 top left would conflict with the 4 in the second
69 * ------+------ box down on the left-hand side.)
70 * 5 1 4 | 3 2 6
71 * 2 6 3 | 1 5 4
72 *
73 * The need for a strong naming convention should now be clear:
74 * each small box is two rows of digits by three columns, while the
75 * overall puzzle has three rows of small boxes by two columns. So
76 * I will (hopefully) consistently use `r' to denote the number of
77 * rows _of small boxes_ (here 3), which is also the number of
78 * columns of digits in each small box; and `c' vice versa (here
79 * 2).
80 *
81 * I'm also going to choose arbitrarily to list c first wherever
82 * possible: the above is a 2x3 puzzle, not a 3x2 one.
83 */
84
85#include <stdio.h>
86#include <stdlib.h>
87#include <string.h>
88#include <assert.h>
89#include <ctype.h>
90#include <math.h>
91
7c568a48 92#ifdef STANDALONE_SOLVER
93#include <stdarg.h>
ab362080 94int solver_show_working, solver_recurse_depth;
7c568a48 95#endif
96
1d8e8ad8 97#include "puzzles.h"
98
99/*
100 * To save space, I store digits internally as unsigned char. This
101 * imposes a hard limit of 255 on the order of the puzzle. Since
102 * even a 5x5 takes unacceptably long to generate, I don't see this
103 * as a serious limitation unless something _really_ impressive
104 * happens in computing technology; but here's a typedef anyway for
105 * general good practice.
106 */
107typedef unsigned char digit;
108#define ORDER_MAX 255
109
ad599e2b 110#define PREFERRED_TILE_SIZE 48
1e3e152d 111#define TILE_SIZE (ds->tilesize)
112#define BORDER (TILE_SIZE / 2)
682486d2 113#define GRIDEXTRA max((TILE_SIZE / 32),1)
1d8e8ad8 114
115#define FLASH_TIME 0.4F
116
154bf9b1 117enum { SYMM_NONE, SYMM_ROT2, SYMM_ROT4, SYMM_REF2, SYMM_REF2D, SYMM_REF4,
118 SYMM_REF4D, SYMM_REF8 };
ef57b17d 119
ad599e2b 120enum { DIFF_BLOCK,
121 DIFF_SIMPLE, DIFF_INTERSECT, DIFF_SET, DIFF_EXTREME, DIFF_RECURSIVE,
122 DIFF_AMBIGUOUS, DIFF_IMPOSSIBLE };
123
124enum { DIFF_KSINGLE, DIFF_KMINMAX, DIFF_KSUMS, DIFF_KINTERSECT };
7c568a48 125
1d8e8ad8 126enum {
127 COL_BACKGROUND,
fbd0fc79 128 COL_XDIAGONALS,
ef57b17d 129 COL_GRID,
130 COL_CLUE,
131 COL_USER,
132 COL_HIGHLIGHT,
7b14a9ec 133 COL_ERROR,
c8266e03 134 COL_PENCIL,
ad599e2b 135 COL_KILLER,
ef57b17d 136 NCOLOURS
1d8e8ad8 137};
138
ad599e2b 139/*
140 * To determine all possible ways to reach a given sum by adding two or
141 * three numbers from 1..9, each of which occurs exactly once in the sum,
142 * these arrays contain a list of bitmasks for each sum value, where if
143 * bit N is set, it means that N occurs in the sum. Each list is
144 * terminated by a zero if it is shorter than the size of the array.
145 */
146#define MAX_2SUMS 5
147#define MAX_3SUMS 8
148#define MAX_4SUMS 12
149unsigned int sum_bits2[18][MAX_2SUMS];
150unsigned int sum_bits3[25][MAX_3SUMS];
151unsigned int sum_bits4[31][MAX_4SUMS];
152
153static int find_sum_bits(unsigned int *array, int idx, int value_left,
154 int addends_left, int min_addend,
155 unsigned int bitmask_so_far)
156{
157 int i;
158 assert(addends_left >= 2);
159
160 for (i = min_addend; i < value_left; i++) {
161 unsigned int new_bitmask = bitmask_so_far | (1 << i);
162 assert(bitmask_so_far != new_bitmask);
163
164 if (addends_left == 2) {
165 int j = value_left - i;
166 if (j <= i)
167 break;
168 if (j > 9)
169 continue;
170 array[idx++] = new_bitmask | (1 << j);
171 } else
172 idx = find_sum_bits(array, idx, value_left - i,
173 addends_left - 1, i + 1,
174 new_bitmask);
175 }
176 return idx;
177}
178
179static void precompute_sum_bits(void)
180{
181 int i;
182 for (i = 3; i < 31; i++) {
183 int j;
184 if (i < 18) {
185 j = find_sum_bits(sum_bits2[i], 0, i, 2, 1, 0);
186 assert (j <= MAX_2SUMS);
187 if (j < MAX_2SUMS)
188 sum_bits2[i][j] = 0;
189 }
190 if (i < 25) {
191 j = find_sum_bits(sum_bits3[i], 0, i, 3, 1, 0);
192 assert (j <= MAX_3SUMS);
193 if (j < MAX_3SUMS)
194 sum_bits3[i][j] = 0;
195 }
196 j = find_sum_bits(sum_bits4[i], 0, i, 4, 1, 0);
197 assert (j <= MAX_4SUMS);
198 if (j < MAX_4SUMS)
199 sum_bits4[i][j] = 0;
200 }
201}
202
1d8e8ad8 203struct game_params {
fbd0fc79 204 /*
205 * For a square puzzle, `c' and `r' indicate the puzzle
206 * parameters as described above.
207 *
208 * A jigsaw-style puzzle is indicated by r==1, in which case c
209 * can be whatever it likes (there is no constraint on
210 * compositeness - a 7x7 jigsaw sudoku makes perfect sense).
211 */
ad599e2b 212 int c, r, symm, diff, kdiff;
fbd0fc79 213 int xtype; /* require all digits in X-diagonals */
ad599e2b 214 int killer;
1d8e8ad8 215};
216
fbd0fc79 217struct block_structure {
218 int refcount;
219
220 /*
221 * For text formatting, we do need c and r here.
222 */
ad599e2b 223 int c, r, area;
fbd0fc79 224
225 /*
226 * For any square index, whichblock[i] gives its block index.
ad599e2b 227 *
fbd0fc79 228 * For 0 <= b,i < cr, blocks[b][i] gives the index of the ith
ad599e2b 229 * square in block b. nr_squares[b] gives the number of squares
230 * in block b (also the number of valid elements in blocks[b]).
231 *
232 * blocks_data holds the data pointed to by blocks.
233 *
234 * nr_squares may be NULL for block structures where all blocks are
235 * the same size.
fbd0fc79 236 */
ad599e2b 237 int *whichblock, **blocks, *nr_squares, *blocks_data;
238 int nr_blocks, max_nr_squares;
fbd0fc79 239
240#ifdef STANDALONE_SOLVER
241 /*
242 * Textual descriptions of each block. For normal Sudoku these
243 * are of the form "(1,3)"; for jigsaw they are "starting at
244 * (5,7)". So the sensible usage in both cases is to say
245 * "elimination within block %s" with one of these strings.
246 *
247 * Only blocknames itself needs individually freeing; it's all
248 * one block.
249 */
250 char **blocknames;
251#endif
252};
253
254struct game_state {
255 /*
256 * For historical reasons, I use `cr' to denote the overall
257 * width/height of the puzzle. It was a natural notation when
258 * all puzzles were divided into blocks in a grid, but doesn't
259 * really make much sense given jigsaw puzzles. However, the
260 * obvious `n' is heavily used in the solver to describe the
261 * index of a number being placed, so `cr' will have to stay.
262 */
263 int cr;
264 struct block_structure *blocks;
ad599e2b 265 struct block_structure *kblocks; /* Blocks for killer puzzles. */
266 int xtype, killer;
267 digit *grid, *kgrid;
c8266e03 268 unsigned char *pencil; /* c*r*c*r elements */
1d8e8ad8 269 unsigned char *immutable; /* marks which digits are clues */
2ac6d24e 270 int completed, cheated;
1d8e8ad8 271};
272
273static game_params *default_params(void)
274{
275 game_params *ret = snew(game_params);
276
277 ret->c = ret->r = 3;
fbd0fc79 278 ret->xtype = FALSE;
ad599e2b 279 ret->killer = FALSE;
ef57b17d 280 ret->symm = SYMM_ROT2; /* a plausible default */
4f36adaa 281 ret->diff = DIFF_BLOCK; /* so is this */
ad599e2b 282 ret->kdiff = DIFF_KINTERSECT; /* so is this */
1d8e8ad8 283
284 return ret;
285}
286
1d8e8ad8 287static void free_params(game_params *params)
288{
289 sfree(params);
290}
291
292static game_params *dup_params(game_params *params)
293{
294 game_params *ret = snew(game_params);
295 *ret = *params; /* structure copy */
296 return ret;
297}
298
7c568a48 299static int game_fetch_preset(int i, char **name, game_params **params)
300{
301 static struct {
302 char *title;
303 game_params params;
304 } presets[] = {
ad599e2b 305 { "2x2 Trivial", { 2, 2, SYMM_ROT2, DIFF_BLOCK, DIFF_KMINMAX, FALSE, FALSE } },
306 { "2x3 Basic", { 2, 3, SYMM_ROT2, DIFF_SIMPLE, DIFF_KMINMAX, FALSE, FALSE } },
307 { "3x3 Trivial", { 3, 3, SYMM_ROT2, DIFF_BLOCK, DIFF_KMINMAX, FALSE, FALSE } },
308 { "3x3 Basic", { 3, 3, SYMM_ROT2, DIFF_SIMPLE, DIFF_KMINMAX, FALSE, FALSE } },
309 { "3x3 Basic X", { 3, 3, SYMM_ROT2, DIFF_SIMPLE, DIFF_KMINMAX, TRUE } },
310 { "3x3 Intermediate", { 3, 3, SYMM_ROT2, DIFF_INTERSECT, DIFF_KMINMAX, FALSE, FALSE } },
311 { "3x3 Advanced", { 3, 3, SYMM_ROT2, DIFF_SET, DIFF_KMINMAX, FALSE, FALSE } },
312 { "3x3 Advanced X", { 3, 3, SYMM_ROT2, DIFF_SET, DIFF_KMINMAX, TRUE } },
313 { "3x3 Extreme", { 3, 3, SYMM_ROT2, DIFF_EXTREME, DIFF_KMINMAX, FALSE, FALSE } },
314 { "3x3 Unreasonable", { 3, 3, SYMM_ROT2, DIFF_RECURSIVE, DIFF_KMINMAX, FALSE, FALSE } },
315 { "3x3 Killer", { 3, 3, SYMM_NONE, DIFF_BLOCK, DIFF_KINTERSECT, FALSE, TRUE } },
316 { "9 Jigsaw Basic", { 9, 1, SYMM_ROT2, DIFF_SIMPLE, DIFF_KMINMAX, FALSE, FALSE } },
317 { "9 Jigsaw Basic X", { 9, 1, SYMM_ROT2, DIFF_SIMPLE, DIFF_KMINMAX, TRUE } },
318 { "9 Jigsaw Advanced", { 9, 1, SYMM_ROT2, DIFF_SET, DIFF_KMINMAX, FALSE, FALSE } },
ab53eb64 319#ifndef SLOW_SYSTEM
ad599e2b 320 { "3x4 Basic", { 3, 4, SYMM_ROT2, DIFF_SIMPLE, DIFF_KMINMAX, FALSE, FALSE } },
321 { "4x4 Basic", { 4, 4, SYMM_ROT2, DIFF_SIMPLE, DIFF_KMINMAX, FALSE, FALSE } },
ab53eb64 322#endif
7c568a48 323 };
324
325 if (i < 0 || i >= lenof(presets))
326 return FALSE;
327
328 *name = dupstr(presets[i].title);
329 *params = dup_params(&presets[i].params);
330
331 return TRUE;
332}
333
1185e3c5 334static void decode_params(game_params *ret, char const *string)
1d8e8ad8 335{
fbd0fc79 336 int seen_r = FALSE;
337
1d8e8ad8 338 ret->c = ret->r = atoi(string);
fbd0fc79 339 ret->xtype = FALSE;
ad599e2b 340 ret->killer = FALSE;
1d8e8ad8 341 while (*string && isdigit((unsigned char)*string)) string++;
342 if (*string == 'x') {
343 string++;
344 ret->r = atoi(string);
fbd0fc79 345 seen_r = TRUE;
1d8e8ad8 346 while (*string && isdigit((unsigned char)*string)) string++;
347 }
7c568a48 348 while (*string) {
fbd0fc79 349 if (*string == 'j') {
350 string++;
351 if (seen_r)
352 ret->c *= ret->r;
353 ret->r = 1;
354 } else if (*string == 'x') {
355 string++;
356 ret->xtype = TRUE;
ad599e2b 357 } else if (*string == 'k') {
358 string++;
359 ret->killer = TRUE;
fbd0fc79 360 } else if (*string == 'r' || *string == 'm' || *string == 'a') {
154bf9b1 361 int sn, sc, sd;
7c568a48 362 sc = *string++;
28814d46 363 if (sc == 'm' && *string == 'd') {
154bf9b1 364 sd = TRUE;
365 string++;
366 } else {
367 sd = FALSE;
368 }
7c568a48 369 sn = atoi(string);
370 while (*string && isdigit((unsigned char)*string)) string++;
154bf9b1 371 if (sc == 'm' && sn == 8)
372 ret->symm = SYMM_REF8;
7c568a48 373 if (sc == 'm' && sn == 4)
154bf9b1 374 ret->symm = sd ? SYMM_REF4D : SYMM_REF4;
375 if (sc == 'm' && sn == 2)
376 ret->symm = sd ? SYMM_REF2D : SYMM_REF2;
7c568a48 377 if (sc == 'r' && sn == 4)
378 ret->symm = SYMM_ROT4;
379 if (sc == 'r' && sn == 2)
380 ret->symm = SYMM_ROT2;
381 if (sc == 'a')
382 ret->symm = SYMM_NONE;
383 } else if (*string == 'd') {
384 string++;
385 if (*string == 't') /* trivial */
386 string++, ret->diff = DIFF_BLOCK;
387 else if (*string == 'b') /* basic */
388 string++, ret->diff = DIFF_SIMPLE;
389 else if (*string == 'i') /* intermediate */
390 string++, ret->diff = DIFF_INTERSECT;
391 else if (*string == 'a') /* advanced */
392 string++, ret->diff = DIFF_SET;
13c4d60d 393 else if (*string == 'e') /* extreme */
44bf5f6f 394 string++, ret->diff = DIFF_EXTREME;
de60d8bd 395 else if (*string == 'u') /* unreasonable */
396 string++, ret->diff = DIFF_RECURSIVE;
7c568a48 397 } else
398 string++; /* eat unknown character */
ef57b17d 399 }
1d8e8ad8 400}
401
1185e3c5 402static char *encode_params(game_params *params, int full)
1d8e8ad8 403{
404 char str[80];
405
fbd0fc79 406 if (params->r > 1)
407 sprintf(str, "%dx%d", params->c, params->r);
408 else
409 sprintf(str, "%dj", params->c);
410 if (params->xtype)
411 strcat(str, "x");
ad599e2b 412 if (params->killer)
413 strcat(str, "k");
fbd0fc79 414
1185e3c5 415 if (full) {
416 switch (params->symm) {
154bf9b1 417 case SYMM_REF8: strcat(str, "m8"); break;
1185e3c5 418 case SYMM_REF4: strcat(str, "m4"); break;
154bf9b1 419 case SYMM_REF4D: strcat(str, "md4"); break;
420 case SYMM_REF2: strcat(str, "m2"); break;
421 case SYMM_REF2D: strcat(str, "md2"); break;
1185e3c5 422 case SYMM_ROT4: strcat(str, "r4"); break;
423 /* case SYMM_ROT2: strcat(str, "r2"); break; [default] */
424 case SYMM_NONE: strcat(str, "a"); break;
425 }
426 switch (params->diff) {
427 /* case DIFF_BLOCK: strcat(str, "dt"); break; [default] */
428 case DIFF_SIMPLE: strcat(str, "db"); break;
429 case DIFF_INTERSECT: strcat(str, "di"); break;
430 case DIFF_SET: strcat(str, "da"); break;
44bf5f6f 431 case DIFF_EXTREME: strcat(str, "de"); break;
1185e3c5 432 case DIFF_RECURSIVE: strcat(str, "du"); break;
433 }
434 }
1d8e8ad8 435 return dupstr(str);
436}
437
438static config_item *game_configure(game_params *params)
439{
440 config_item *ret;
441 char buf[80];
442
ad599e2b 443 ret = snewn(8, config_item);
1d8e8ad8 444
445 ret[0].name = "Columns of sub-blocks";
446 ret[0].type = C_STRING;
447 sprintf(buf, "%d", params->c);
448 ret[0].sval = dupstr(buf);
449 ret[0].ival = 0;
450
451 ret[1].name = "Rows of sub-blocks";
452 ret[1].type = C_STRING;
453 sprintf(buf, "%d", params->r);
454 ret[1].sval = dupstr(buf);
455 ret[1].ival = 0;
456
fbd0fc79 457 ret[2].name = "\"X\" (require every number in each main diagonal)";
458 ret[2].type = C_BOOLEAN;
459 ret[2].sval = NULL;
460 ret[2].ival = params->xtype;
461
81b09746 462 ret[3].name = "Jigsaw (irregularly shaped sub-blocks)";
463 ret[3].type = C_BOOLEAN;
464 ret[3].sval = NULL;
465 ret[3].ival = (params->r == 1);
466
ad599e2b 467 ret[4].name = "Killer (digit sums)";
468 ret[4].type = C_BOOLEAN;
469 ret[4].sval = NULL;
470 ret[4].ival = params->killer;
471
472 ret[5].name = "Symmetry";
473 ret[5].type = C_CHOICES;
474 ret[5].sval = ":None:2-way rotation:4-way rotation:2-way mirror:"
154bf9b1 475 "2-way diagonal mirror:4-way mirror:4-way diagonal mirror:"
476 "8-way mirror";
ad599e2b 477 ret[5].ival = params->symm;
ef57b17d 478
ad599e2b 479 ret[6].name = "Difficulty";
480 ret[6].type = C_CHOICES;
481 ret[6].sval = ":Trivial:Basic:Intermediate:Advanced:Extreme:Unreasonable";
482 ret[6].ival = params->diff;
1d8e8ad8 483
ad599e2b 484 ret[7].name = NULL;
485 ret[7].type = C_END;
486 ret[7].sval = NULL;
487 ret[7].ival = 0;
1d8e8ad8 488
489 return ret;
490}
491
492static game_params *custom_params(config_item *cfg)
493{
494 game_params *ret = snew(game_params);
495
c1f743c8 496 ret->c = atoi(cfg[0].sval);
497 ret->r = atoi(cfg[1].sval);
fbd0fc79 498 ret->xtype = cfg[2].ival;
81b09746 499 if (cfg[3].ival) {
500 ret->c *= ret->r;
501 ret->r = 1;
502 }
ad599e2b 503 ret->killer = cfg[4].ival;
504 ret->symm = cfg[5].ival;
505 ret->diff = cfg[6].ival;
506 ret->kdiff = DIFF_KINTERSECT;
1d8e8ad8 507
508 return ret;
509}
510
3ff276f2 511static char *validate_params(game_params *params, int full)
1d8e8ad8 512{
fbd0fc79 513 if (params->c < 2)
1d8e8ad8 514 return "Both dimensions must be at least 2";
515 if (params->c > ORDER_MAX || params->r > ORDER_MAX)
516 return "Dimensions greater than "STR(ORDER_MAX)" are not supported";
ad599e2b 517 if ((params->c * params->r) > 31)
518 return "Unable to support more than 31 distinct symbols in a puzzle";
519 if (params->killer && params->c * params->r > 9)
520 return "Killer puzzle dimensions must be smaller than 10.";
1d8e8ad8 521 return NULL;
522}
523
ad599e2b 524/*
525 * ----------------------------------------------------------------------
526 * Block structure functions.
527 */
528
529static struct block_structure *alloc_block_structure(int c, int r, int area,
530 int max_nr_squares,
531 int nr_blocks)
532{
533 int i;
534 struct block_structure *b = snew(struct block_structure);
535
536 b->refcount = 1;
537 b->nr_blocks = nr_blocks;
538 b->max_nr_squares = max_nr_squares;
539 b->c = c; b->r = r; b->area = area;
540 b->whichblock = snewn(area, int);
541 b->blocks_data = snewn(nr_blocks * max_nr_squares, int);
542 b->blocks = snewn(nr_blocks, int *);
543 b->nr_squares = snewn(nr_blocks, int);
544
545 for (i = 0; i < nr_blocks; i++)
546 b->blocks[i] = b->blocks_data + i*max_nr_squares;
547
548#ifdef STANDALONE_SOLVER
549 b->blocknames = (char **)smalloc(c*r*(sizeof(char *)+80));
550 for (i = 0; i < c * r; i++)
551 b->blocknames[i] = NULL;
552#endif
553 return b;
554}
555
556static void free_block_structure(struct block_structure *b)
557{
558 if (--b->refcount == 0) {
559 sfree(b->whichblock);
560 sfree(b->blocks);
561 sfree(b->blocks_data);
562#ifdef STANDALONE_SOLVER
563 sfree(b->blocknames);
564#endif
565 sfree(b->nr_squares);
566 sfree(b);
567 }
568}
569
570static struct block_structure *dup_block_structure(struct block_structure *b)
571{
572 struct block_structure *nb;
573 int i;
574
575 nb = alloc_block_structure(b->c, b->r, b->area, b->max_nr_squares,
576 b->nr_blocks);
577 memcpy(nb->nr_squares, b->nr_squares, b->nr_blocks * sizeof *b->nr_squares);
578 memcpy(nb->whichblock, b->whichblock, b->area * sizeof *b->whichblock);
579 memcpy(nb->blocks_data, b->blocks_data,
580 b->nr_blocks * b->max_nr_squares * sizeof *b->blocks_data);
581 for (i = 0; i < b->nr_blocks; i++)
582 nb->blocks[i] = nb->blocks_data + i*nb->max_nr_squares;
583
584#ifdef STANDALONE_SOLVER
585 nb->blocknames = (char **)smalloc(b->c * b->r *(sizeof(char *)+80));
586 memcpy(nb->blocknames, b->blocknames, b->c * b->r *(sizeof(char *)+80));
587 {
588 int i;
589 for (i = 0; i < b->c * b->r; i++)
590 if (b->blocknames[i] == NULL)
591 nb->blocknames[i] = NULL;
592 else
593 nb->blocknames[i] = ((char *)nb->blocknames) + (b->blocknames[i] - (char *)b->blocknames);
594 }
595#endif
596 return nb;
597}
598
599static void split_block(struct block_structure *b, int *squares, int nr_squares)
600{
601 int i, j;
602 int previous_block = b->whichblock[squares[0]];
603 int newblock = b->nr_blocks;
604
605 assert(b->max_nr_squares >= nr_squares);
606 assert(b->nr_squares[previous_block] > nr_squares);
607
608 b->nr_blocks++;
609 b->blocks_data = sresize(b->blocks_data,
610 b->nr_blocks * b->max_nr_squares, int);
611 b->nr_squares = sresize(b->nr_squares, b->nr_blocks, int);
612 sfree(b->blocks);
613 b->blocks = snewn(b->nr_blocks, int *);
614 for (i = 0; i < b->nr_blocks; i++)
615 b->blocks[i] = b->blocks_data + i*b->max_nr_squares;
616 for (i = 0; i < nr_squares; i++) {
617 assert(b->whichblock[squares[i]] == previous_block);
618 b->whichblock[squares[i]] = newblock;
619 b->blocks[newblock][i] = squares[i];
620 }
621 for (i = j = 0; i < b->nr_squares[previous_block]; i++) {
622 int k;
623 int sq = b->blocks[previous_block][i];
624 for (k = 0; k < nr_squares; k++)
625 if (squares[k] == sq)
626 break;
627 if (k == nr_squares)
628 b->blocks[previous_block][j++] = sq;
629 }
630 b->nr_squares[previous_block] -= nr_squares;
631 b->nr_squares[newblock] = nr_squares;
632}
633
634static void remove_from_block(struct block_structure *blocks, int b, int n)
635{
636 int i, j;
637 blocks->whichblock[n] = -1;
638 for (i = j = 0; i < blocks->nr_squares[b]; i++)
639 if (blocks->blocks[b][i] != n)
640 blocks->blocks[b][j++] = blocks->blocks[b][i];
641 assert(j+1 == i);
642 blocks->nr_squares[b]--;
643}
644
1d8e8ad8 645/* ----------------------------------------------------------------------
ab362080 646 * Solver.
647 *
13c4d60d 648 * This solver is used for two purposes:
ab362080 649 * + to check solubility of a grid as we gradually remove numbers
650 * from it
651 * + to solve an externally generated puzzle when the user selects
652 * `Solve'.
653 *
1d8e8ad8 654 * It supports a variety of specific modes of reasoning. By
655 * enabling or disabling subsets of these modes we can arrange a
656 * range of difficulty levels.
657 */
658
659/*
660 * Modes of reasoning currently supported:
661 *
662 * - Positional elimination: a number must go in a particular
663 * square because all the other empty squares in a given
664 * row/col/blk are ruled out.
665 *
ad599e2b 666 * - Killer minmax elimination: for killer-type puzzles, a number
667 * is impossible if choosing it would cause the sum in a killer
668 * region to be guaranteed to be too large or too small.
669 *
1d8e8ad8 670 * - Numeric elimination: a square must have a particular number
671 * in because all the other numbers that could go in it are
672 * ruled out.
673 *
7c568a48 674 * - Intersectional analysis: given two domains which overlap
1d8e8ad8 675 * (hence one must be a block, and the other can be a row or
676 * col), if the possible locations for a particular number in
677 * one of the domains can be narrowed down to the overlap, then
678 * that number can be ruled out everywhere but the overlap in
679 * the other domain too.
680 *
7c568a48 681 * - Set elimination: if there is a subset of the empty squares
682 * within a domain such that the union of the possible numbers
683 * in that subset has the same size as the subset itself, then
684 * those numbers can be ruled out everywhere else in the domain.
685 * (For example, if there are five empty squares and the
686 * possible numbers in each are 12, 23, 13, 134 and 1345, then
687 * the first three empty squares form such a subset: the numbers
688 * 1, 2 and 3 _must_ be in those three squares in some
689 * permutation, and hence we can deduce none of them can be in
690 * the fourth or fifth squares.)
691 * + You can also see this the other way round, concentrating
692 * on numbers rather than squares: if there is a subset of
693 * the unplaced numbers within a domain such that the union
694 * of all their possible positions has the same size as the
695 * subset itself, then all other numbers can be ruled out for
696 * those positions. However, it turns out that this is
697 * exactly equivalent to the first formulation at all times:
698 * there is a 1-1 correspondence between suitable subsets of
699 * the unplaced numbers and suitable subsets of the unfilled
700 * places, found by taking the _complement_ of the union of
701 * the numbers' possible positions (or the spaces' possible
702 * contents).
ab362080 703 *
fbd0fc79 704 * - Forcing chains (see comment for solver_forcing().)
13c4d60d 705 *
ab362080 706 * - Recursion. If all else fails, we pick one of the currently
707 * most constrained empty squares and take a random guess at its
708 * contents, then continue solving on that basis and see if we
709 * get any further.
1d8e8ad8 710 */
711
ab362080 712struct solver_usage {
fbd0fc79 713 int cr;
ad599e2b 714 struct block_structure *blocks, *kblocks, *extra_cages;
1d8e8ad8 715 /*
716 * We set up a cubic array, indexed by x, y and digit; each
717 * element of this array is TRUE or FALSE according to whether
718 * or not that digit _could_ in principle go in that position.
719 *
fbd0fc79 720 * The way to index this array is cube[(y*cr+x)*cr+n-1]; there
721 * are macros below to help with this.
1d8e8ad8 722 */
723 unsigned char *cube;
724 /*
725 * This is the grid in which we write down our final
4846f788 726 * deductions. y-coordinates in here are _not_ transformed.
1d8e8ad8 727 */
728 digit *grid;
729 /*
ad599e2b 730 * For killer-type puzzles, kclues holds the secondary clue for
731 * each cage. For derived cages, the clue is in extra_clues.
732 */
733 digit *kclues, *extra_clues;
734 /*
1d8e8ad8 735 * Now we keep track, at a slightly higher level, of what we
736 * have yet to work out, to prevent doing the same deduction
737 * many times.
738 */
739 /* row[y*cr+n-1] TRUE if digit n has been placed in row y */
740 unsigned char *row;
741 /* col[x*cr+n-1] TRUE if digit n has been placed in row x */
742 unsigned char *col;
fbd0fc79 743 /* blk[i*cr+n-1] TRUE if digit n has been placed in block i */
1d8e8ad8 744 unsigned char *blk;
fbd0fc79 745 /* diag[i*cr+n-1] TRUE if digit n has been placed in diagonal i */
746 unsigned char *diag; /* diag 0 is \, 1 is / */
ad599e2b 747
748 int *regions;
749 int nr_regions;
750 int **sq2region;
1d8e8ad8 751};
fbd0fc79 752#define cubepos2(xy,n) ((xy)*usage->cr+(n)-1)
753#define cubepos(x,y,n) cubepos2((y)*usage->cr+(x),n)
4846f788 754#define cube(x,y,n) (usage->cube[cubepos(x,y,n)])
fbd0fc79 755#define cube2(xy,n) (usage->cube[cubepos2(xy,n)])
756
757#define ondiag0(xy) ((xy) % (cr+1) == 0)
758#define ondiag1(xy) ((xy) % (cr-1) == 0 && (xy) > 0 && (xy) < cr*cr-1)
759#define diag0(i) ((i) * (cr+1))
760#define diag1(i) ((i+1) * (cr-1))
1d8e8ad8 761
762/*
763 * Function called when we are certain that a particular square has
4846f788 764 * a particular number in it. The y-coordinate passed in here is
765 * transformed.
1d8e8ad8 766 */
ab362080 767static void solver_place(struct solver_usage *usage, int x, int y, int n)
1d8e8ad8 768{
fbd0fc79 769 int cr = usage->cr;
770 int sqindex = y*cr+x;
771 int i, bi;
1d8e8ad8 772
773 assert(cube(x,y,n));
774
775 /*
776 * Rule out all other numbers in this square.
777 */
778 for (i = 1; i <= cr; i++)
779 if (i != n)
780 cube(x,y,i) = FALSE;
781
782 /*
783 * Rule out this number in all other positions in the row.
784 */
785 for (i = 0; i < cr; i++)
786 if (i != y)
787 cube(x,i,n) = FALSE;
788
789 /*
790 * Rule out this number in all other positions in the column.
791 */
792 for (i = 0; i < cr; i++)
793 if (i != x)
794 cube(i,y,n) = FALSE;
795
796 /*
797 * Rule out this number in all other positions in the block.
798 */
fbd0fc79 799 bi = usage->blocks->whichblock[sqindex];
800 for (i = 0; i < cr; i++) {
801 int bp = usage->blocks->blocks[bi][i];
802 if (bp != sqindex)
803 cube2(bp,n) = FALSE;
804 }
1d8e8ad8 805
806 /*
807 * Enter the number in the result grid.
808 */
fbd0fc79 809 usage->grid[sqindex] = n;
1d8e8ad8 810
811 /*
812 * Cross out this number from the list of numbers left to place
813 * in its row, its column and its block.
814 */
815 usage->row[y*cr+n-1] = usage->col[x*cr+n-1] =
fbd0fc79 816 usage->blk[bi*cr+n-1] = TRUE;
817
818 if (usage->diag) {
819 if (ondiag0(sqindex)) {
820 for (i = 0; i < cr; i++)
821 if (diag0(i) != sqindex)
822 cube2(diag0(i),n) = FALSE;
823 usage->diag[n-1] = TRUE;
824 }
825 if (ondiag1(sqindex)) {
826 for (i = 0; i < cr; i++)
827 if (diag1(i) != sqindex)
828 cube2(diag1(i),n) = FALSE;
829 usage->diag[cr+n-1] = TRUE;
830 }
831 }
1d8e8ad8 832}
833
fbd0fc79 834static int solver_elim(struct solver_usage *usage, int *indices
7c568a48 835#ifdef STANDALONE_SOLVER
836 , char *fmt, ...
837#endif
838 )
1d8e8ad8 839{
fbd0fc79 840 int cr = usage->cr;
4846f788 841 int fpos, m, i;
1d8e8ad8 842
843 /*
4846f788 844 * Count the number of set bits within this section of the
845 * cube.
1d8e8ad8 846 */
847 m = 0;
4846f788 848 fpos = -1;
849 for (i = 0; i < cr; i++)
fbd0fc79 850 if (usage->cube[indices[i]]) {
851 fpos = indices[i];
1d8e8ad8 852 m++;
853 }
854
855 if (m == 1) {
4846f788 856 int x, y, n;
857 assert(fpos >= 0);
1d8e8ad8 858
4846f788 859 n = 1 + fpos % cr;
fbd0fc79 860 x = fpos / cr;
861 y = x / cr;
862 x %= cr;
1d8e8ad8 863
fbd0fc79 864 if (!usage->grid[y*cr+x]) {
7c568a48 865#ifdef STANDALONE_SOLVER
866 if (solver_show_working) {
867 va_list ap;
fdb3b29a 868 printf("%*s", solver_recurse_depth*4, "");
7c568a48 869 va_start(ap, fmt);
870 vprintf(fmt, ap);
871 va_end(ap);
ab362080 872 printf(":\n%*s placing %d at (%d,%d)\n",
fbd0fc79 873 solver_recurse_depth*4, "", n, 1+x, 1+y);
7c568a48 874 }
875#endif
ab362080 876 solver_place(usage, x, y, n);
877 return +1;
3ddae0ff 878 }
ab362080 879 } else if (m == 0) {
880#ifdef STANDALONE_SOLVER
881 if (solver_show_working) {
ab362080 882 va_list ap;
fdb3b29a 883 printf("%*s", solver_recurse_depth*4, "");
ab362080 884 va_start(ap, fmt);
885 vprintf(fmt, ap);
886 va_end(ap);
887 printf(":\n%*s no possibilities available\n",
888 solver_recurse_depth*4, "");
889 }
890#endif
891 return -1;
1d8e8ad8 892 }
893
ab362080 894 return 0;
1d8e8ad8 895}
896
ab362080 897static int solver_intersect(struct solver_usage *usage,
fbd0fc79 898 int *indices1, int *indices2
7c568a48 899#ifdef STANDALONE_SOLVER
900 , char *fmt, ...
901#endif
902 )
903{
fbd0fc79 904 int cr = usage->cr;
905 int ret, i, j;
7c568a48 906
907 /*
908 * Loop over the first domain and see if there's any set bit
909 * not also in the second.
910 */
fbd0fc79 911 for (i = j = 0; i < cr; i++) {
912 int p = indices1[i];
913 while (j < cr && indices2[j] < p)
914 j++;
915 if (usage->cube[p]) {
916 if (j < cr && indices2[j] == p)
917 continue; /* both domains contain this index */
918 else
919 return 0; /* there is, so we can't deduce */
920 }
7c568a48 921 }
922
923 /*
924 * We have determined that all set bits in the first domain are
925 * within its overlap with the second. So loop over the second
926 * domain and remove all set bits that aren't also in that
ab362080 927 * overlap; return +1 iff we actually _did_ anything.
7c568a48 928 */
ab362080 929 ret = 0;
fbd0fc79 930 for (i = j = 0; i < cr; i++) {
931 int p = indices2[i];
932 while (j < cr && indices1[j] < p)
933 j++;
934 if (usage->cube[p] && (j >= cr || indices1[j] != p)) {
7c568a48 935#ifdef STANDALONE_SOLVER
936 if (solver_show_working) {
937 int px, py, pn;
938
939 if (!ret) {
940 va_list ap;
fdb3b29a 941 printf("%*s", solver_recurse_depth*4, "");
7c568a48 942 va_start(ap, fmt);
943 vprintf(fmt, ap);
944 va_end(ap);
945 printf(":\n");
946 }
947
948 pn = 1 + p % cr;
fbd0fc79 949 px = p / cr;
950 py = px / cr;
951 px %= cr;
7c568a48 952
ab362080 953 printf("%*s ruling out %d at (%d,%d)\n",
fbd0fc79 954 solver_recurse_depth*4, "", pn, 1+px, 1+py);
7c568a48 955 }
956#endif
ab362080 957 ret = +1; /* we did something */
7c568a48 958 usage->cube[p] = 0;
959 }
960 }
961
962 return ret;
963}
964
ab362080 965struct solver_scratch {
ab53eb64 966 unsigned char *grid, *rowidx, *colidx, *set;
44bf5f6f 967 int *neighbours, *bfsqueue;
fbd0fc79 968 int *indexlist, *indexlist2;
44bf5f6f 969#ifdef STANDALONE_SOLVER
970 int *bfsprev;
971#endif
ab53eb64 972};
973
ab362080 974static int solver_set(struct solver_usage *usage,
975 struct solver_scratch *scratch,
fbd0fc79 976 int *indices
7c568a48 977#ifdef STANDALONE_SOLVER
978 , char *fmt, ...
979#endif
980 )
981{
fbd0fc79 982 int cr = usage->cr;
7c568a48 983 int i, j, n, count;
ab53eb64 984 unsigned char *grid = scratch->grid;
985 unsigned char *rowidx = scratch->rowidx;
986 unsigned char *colidx = scratch->colidx;
987 unsigned char *set = scratch->set;
7c568a48 988
989 /*
990 * We are passed a cr-by-cr matrix of booleans. Our first job
991 * is to winnow it by finding any definite placements - i.e.
992 * any row with a solitary 1 - and discarding that row and the
993 * column containing the 1.
994 */
995 memset(rowidx, TRUE, cr);
996 memset(colidx, TRUE, cr);
997 for (i = 0; i < cr; i++) {
998 int count = 0, first = -1;
999 for (j = 0; j < cr; j++)
fbd0fc79 1000 if (usage->cube[indices[i*cr+j]])
7c568a48 1001 first = j, count++;
ab362080 1002
1003 /*
1004 * If count == 0, then there's a row with no 1s at all and
1005 * the puzzle is internally inconsistent. However, we ought
1006 * to have caught this already during the simpler reasoning
1007 * methods, so we can safely fail an assertion if we reach
1008 * this point here.
1009 */
1010 assert(count > 0);
7c568a48 1011 if (count == 1)
1012 rowidx[i] = colidx[first] = FALSE;
1013 }
1014
1015 /*
1016 * Convert each of rowidx/colidx from a list of 0s and 1s to a
1017 * list of the indices of the 1s.
1018 */
1019 for (i = j = 0; i < cr; i++)
1020 if (rowidx[i])
1021 rowidx[j++] = i;
1022 n = j;
1023 for (i = j = 0; i < cr; i++)
1024 if (colidx[i])
1025 colidx[j++] = i;
1026 assert(n == j);
1027
1028 /*
1029 * And create the smaller matrix.
1030 */
1031 for (i = 0; i < n; i++)
1032 for (j = 0; j < n; j++)
fbd0fc79 1033 grid[i*cr+j] = usage->cube[indices[rowidx[i]*cr+colidx[j]]];
7c568a48 1034
1035 /*
1036 * Having done that, we now have a matrix in which every row
1037 * has at least two 1s in. Now we search to see if we can find
1038 * a rectangle of zeroes (in the set-theoretic sense of
1039 * `rectangle', i.e. a subset of rows crossed with a subset of
1040 * columns) whose width and height add up to n.
1041 */
1042
1043 memset(set, 0, n);
1044 count = 0;
1045 while (1) {
1046 /*
1047 * We have a candidate set. If its size is <=1 or >=n-1
1048 * then we move on immediately.
1049 */
1050 if (count > 1 && count < n-1) {
1051 /*
1052 * The number of rows we need is n-count. See if we can
1053 * find that many rows which each have a zero in all
1054 * the positions listed in `set'.
1055 */
1056 int rows = 0;
1057 for (i = 0; i < n; i++) {
1058 int ok = TRUE;
1059 for (j = 0; j < n; j++)
1060 if (set[j] && grid[i*cr+j]) {
1061 ok = FALSE;
1062 break;
1063 }
1064 if (ok)
1065 rows++;
1066 }
1067
1068 /*
1069 * We expect never to be able to get _more_ than
1070 * n-count suitable rows: this would imply that (for
1071 * example) there are four numbers which between them
1072 * have at most three possible positions, and hence it
1073 * indicates a faulty deduction before this point or
1074 * even a bogus clue.
1075 */
ab362080 1076 if (rows > n - count) {
1077#ifdef STANDALONE_SOLVER
1078 if (solver_show_working) {
fdb3b29a 1079 va_list ap;
ab362080 1080 printf("%*s", solver_recurse_depth*4,
1081 "");
ab362080 1082 va_start(ap, fmt);
1083 vprintf(fmt, ap);
1084 va_end(ap);
1085 printf(":\n%*s contradiction reached\n",
1086 solver_recurse_depth*4, "");
1087 }
1088#endif
1089 return -1;
1090 }
1091
7c568a48 1092 if (rows >= n - count) {
1093 int progress = FALSE;
1094
1095 /*
1096 * We've got one! Now, for each row which _doesn't_
1097 * satisfy the criterion, eliminate all its set
1098 * bits in the positions _not_ listed in `set'.
ab362080 1099 * Return +1 (meaning progress has been made) if we
1100 * successfully eliminated anything at all.
7c568a48 1101 *
1102 * This involves referring back through
1103 * rowidx/colidx in order to work out which actual
1104 * positions in the cube to meddle with.
1105 */
1106 for (i = 0; i < n; i++) {
1107 int ok = TRUE;
1108 for (j = 0; j < n; j++)
1109 if (set[j] && grid[i*cr+j]) {
1110 ok = FALSE;
1111 break;
1112 }
1113 if (!ok) {
1114 for (j = 0; j < n; j++)
1115 if (!set[j] && grid[i*cr+j]) {
fbd0fc79 1116 int fpos = indices[rowidx[i]*cr+colidx[j]];
7c568a48 1117#ifdef STANDALONE_SOLVER
1118 if (solver_show_working) {
1119 int px, py, pn;
ab362080 1120
7c568a48 1121 if (!progress) {
fdb3b29a 1122 va_list ap;
ab362080 1123 printf("%*s", solver_recurse_depth*4,
1124 "");
7c568a48 1125 va_start(ap, fmt);
1126 vprintf(fmt, ap);
1127 va_end(ap);
1128 printf(":\n");
1129 }
1130
1131 pn = 1 + fpos % cr;
fbd0fc79 1132 px = fpos / cr;
1133 py = px / cr;
1134 px %= cr;
7c568a48 1135
ab362080 1136 printf("%*s ruling out %d at (%d,%d)\n",
1137 solver_recurse_depth*4, "",
fbd0fc79 1138 pn, 1+px, 1+py);
7c568a48 1139 }
1140#endif
1141 progress = TRUE;
1142 usage->cube[fpos] = FALSE;
1143 }
1144 }
1145 }
1146
1147 if (progress) {
ab362080 1148 return +1;
7c568a48 1149 }
1150 }
1151 }
1152
1153 /*
1154 * Binary increment: change the rightmost 0 to a 1, and
1155 * change all 1s to the right of it to 0s.
1156 */
1157 i = n;
1158 while (i > 0 && set[i-1])
1159 set[--i] = 0, count--;
1160 if (i > 0)
1161 set[--i] = 1, count++;
1162 else
1163 break; /* done */
1164 }
1165
ab362080 1166 return 0;
7c568a48 1167}
1168
13c4d60d 1169/*
44bf5f6f 1170 * Look for forcing chains. A forcing chain is a path of
1171 * pairwise-exclusive squares (i.e. each pair of adjacent squares
1172 * in the path are in the same row, column or block) with the
1173 * following properties:
1174 *
1175 * (a) Each square on the path has precisely two possible numbers.
1176 *
1177 * (b) Each pair of squares which are adjacent on the path share
fbd0fc79 1178 * at least one possible number in common.
44bf5f6f 1179 *
1180 * (c) Each square in the middle of the path shares _both_ of its
fbd0fc79 1181 * numbers with at least one of its neighbours (not the same
1182 * one with both neighbours).
44bf5f6f 1183 *
1184 * These together imply that at least one of the possible number
1185 * choices at one end of the path forces _all_ the rest of the
1186 * numbers along the path. In order to make real use of this, we
1187 * need further properties:
1188 *
fbd0fc79 1189 * (c) Ruling out some number N from the square at one end of the
1190 * path forces the square at the other end to take the same
1191 * number N.
44bf5f6f 1192 *
1193 * (d) The two end squares are both in line with some third
fbd0fc79 1194 * square.
44bf5f6f 1195 *
1196 * (e) That third square currently has N as a possibility.
1197 *
1198 * If we can find all of that lot, we can deduce that at least one
1199 * of the two ends of the forcing chain has number N, and that
1200 * therefore the mutually adjacent third square does not.
1201 *
1202 * To find forcing chains, we're going to start a bfs at each
1203 * suitable square, once for each of its two possible numbers.
1204 */
1205static int solver_forcing(struct solver_usage *usage,
1206 struct solver_scratch *scratch)
1207{
fbd0fc79 1208 int cr = usage->cr;
44bf5f6f 1209 int *bfsqueue = scratch->bfsqueue;
1210#ifdef STANDALONE_SOLVER
1211 int *bfsprev = scratch->bfsprev;
1212#endif
1213 unsigned char *number = scratch->grid;
1214 int *neighbours = scratch->neighbours;
1215 int x, y;
1216
1217 for (y = 0; y < cr; y++)
1218 for (x = 0; x < cr; x++) {
1219 int count, t, n;
1220
1221 /*
1222 * If this square doesn't have exactly two candidate
1223 * numbers, don't try it.
1224 *
1225 * In this loop we also sum the candidate numbers,
1226 * which is a nasty hack to allow us to quickly find
1227 * `the other one' (since we will shortly know there
1228 * are exactly two).
1229 */
1230 for (count = t = 0, n = 1; n <= cr; n++)
1231 if (cube(x, y, n))
1232 count++, t += n;
1233 if (count != 2)
1234 continue;
1235
1236 /*
1237 * Now attempt a bfs for each candidate.
1238 */
1239 for (n = 1; n <= cr; n++)
1240 if (cube(x, y, n)) {
1241 int orign, currn, head, tail;
1242
1243 /*
1244 * Begin a bfs.
1245 */
1246 orign = n;
1247
1248 memset(number, cr+1, cr*cr);
1249 head = tail = 0;
1250 bfsqueue[tail++] = y*cr+x;
1251#ifdef STANDALONE_SOLVER
1252 bfsprev[y*cr+x] = -1;
1253#endif
1254 number[y*cr+x] = t - n;
1255
1256 while (head < tail) {
fbd0fc79 1257 int xx, yy, nneighbours, xt, yt, i;
44bf5f6f 1258
1259 xx = bfsqueue[head++];
1260 yy = xx / cr;
1261 xx %= cr;
1262
1263 currn = number[yy*cr+xx];
1264
1265 /*
1266 * Find neighbours of yy,xx.
1267 */
1268 nneighbours = 0;
1269 for (yt = 0; yt < cr; yt++)
1270 neighbours[nneighbours++] = yt*cr+xx;
1271 for (xt = 0; xt < cr; xt++)
1272 neighbours[nneighbours++] = yy*cr+xt;
fbd0fc79 1273 xt = usage->blocks->whichblock[yy*cr+xx];
1274 for (yt = 0; yt < cr; yt++)
1275 neighbours[nneighbours++] = usage->blocks->blocks[xt][yt];
1276 if (usage->diag) {
1277 int sqindex = yy*cr+xx;
1278 if (ondiag0(sqindex)) {
1279 for (i = 0; i < cr; i++)
1280 neighbours[nneighbours++] = diag0(i);
1281 }
1282 if (ondiag1(sqindex)) {
1283 for (i = 0; i < cr; i++)
1284 neighbours[nneighbours++] = diag1(i);
1285 }
1286 }
44bf5f6f 1287
1288 /*
1289 * Try visiting each of those neighbours.
1290 */
1291 for (i = 0; i < nneighbours; i++) {
1292 int cc, tt, nn;
1293
1294 xt = neighbours[i] % cr;
1295 yt = neighbours[i] / cr;
1296
1297 /*
1298 * We need this square to not be
1299 * already visited, and to include
1300 * currn as a possible number.
1301 */
1302 if (number[yt*cr+xt] <= cr)
1303 continue;
1304 if (!cube(xt, yt, currn))
1305 continue;
1306
1307 /*
1308 * Don't visit _this_ square a second
1309 * time!
1310 */
1311 if (xt == xx && yt == yy)
1312 continue;
1313
1314 /*
1315 * To continue with the bfs, we need
1316 * this square to have exactly two
1317 * possible numbers.
1318 */
1319 for (cc = tt = 0, nn = 1; nn <= cr; nn++)
1320 if (cube(xt, yt, nn))
1321 cc++, tt += nn;
1322 if (cc == 2) {
1323 bfsqueue[tail++] = yt*cr+xt;
1324#ifdef STANDALONE_SOLVER
1325 bfsprev[yt*cr+xt] = yy*cr+xx;
1326#endif
1327 number[yt*cr+xt] = tt - currn;
1328 }
1329
1330 /*
1331 * One other possibility is that this
1332 * might be the square in which we can
1333 * make a real deduction: if it's
1334 * adjacent to x,y, and currn is equal
1335 * to the original number we ruled out.
1336 */
1337 if (currn == orign &&
1338 (xt == x || yt == y ||
fbd0fc79 1339 (usage->blocks->whichblock[yt*cr+xt] == usage->blocks->whichblock[y*cr+x]) ||
1340 (usage->diag && ((ondiag0(yt*cr+xt) && ondiag0(y*cr+x)) ||
1341 (ondiag1(yt*cr+xt) && ondiag1(y*cr+x)))))) {
44bf5f6f 1342#ifdef STANDALONE_SOLVER
1343 if (solver_show_working) {
1344 char *sep = "";
1345 int xl, yl;
1346 printf("%*sforcing chain, %d at ends of ",
1347 solver_recurse_depth*4, "", orign);
1348 xl = xx;
1349 yl = yy;
1350 while (1) {
1351 printf("%s(%d,%d)", sep, 1+xl,
fbd0fc79 1352 1+yl);
44bf5f6f 1353 xl = bfsprev[yl*cr+xl];
1354 if (xl < 0)
1355 break;
1356 yl = xl / cr;
1357 xl %= cr;
1358 sep = "-";
1359 }
1360 printf("\n%*s ruling out %d at (%d,%d)\n",
1361 solver_recurse_depth*4, "",
fbd0fc79 1362 orign, 1+xt, 1+yt);
44bf5f6f 1363 }
1364#endif
1365 cube(xt, yt, orign) = FALSE;
1366 return 1;
1367 }
1368 }
1369 }
1370 }
1371 }
1372
1373 return 0;
1374}
1375
ad599e2b 1376static int solver_killer_minmax(struct solver_usage *usage,
1377 struct block_structure *cages, digit *clues,
1378 int b
1379#ifdef STANDALONE_SOLVER
1380 , const char *extra
1381#endif
1382 )
1383{
1384 int cr = usage->cr;
1385 int i;
1386 int ret = 0;
1387 int nsquares = cages->nr_squares[b];
1388
1389 if (clues[b] == 0)
1390 return 0;
1391
1392 for (i = 0; i < nsquares; i++) {
1393 int n, x = cages->blocks[b][i];
1394
1395 for (n = 1; n <= cr; n++)
1396 if (cube2(x, n)) {
1397 int maxval = 0, minval = 0;
1398 int j;
1399 for (j = 0; j < nsquares; j++) {
1400 int m;
1401 int y = cages->blocks[b][j];
1402 if (i == j)
1403 continue;
1404 for (m = 1; m <= cr; m++)
1405 if (cube2(y, m)) {
1406 minval += m;
1407 break;
1408 }
1409 for (m = cr; m > 0; m--)
1410 if (cube2(y, m)) {
1411 maxval += m;
1412 break;
1413 }
1414 }
1415 if (maxval + n < clues[b]) {
1416 cube2(x, n) = FALSE;
1417 ret = 1;
1418#ifdef STANDALONE_SOLVER
1419 if (solver_show_working)
1420 printf("%*s ruling out %d at (%d,%d) as too low %s\n",
1421 solver_recurse_depth*4, "killer minmax analysis",
1422 n, 1 + x%cr, 1 + x/cr, extra);
1423#endif
1424 }
1425 if (minval + n > clues[b]) {
1426 cube2(x, n) = FALSE;
1427 ret = 1;
1428#ifdef STANDALONE_SOLVER
1429 if (solver_show_working)
1430 printf("%*s ruling out %d at (%d,%d) as too high %s\n",
1431 solver_recurse_depth*4, "killer minmax analysis",
1432 n, 1 + x%cr, 1 + x/cr, extra);
1433#endif
1434 }
1435 }
1436 }
1437 return ret;
1438}
1439
1440static int solver_killer_sums(struct solver_usage *usage, int b,
1441 struct block_structure *cages, int clue,
1442 int cage_is_region
1443#ifdef STANDALONE_SOLVER
1444 , const char *cage_type
1445#endif
1446 )
1447{
1448 int cr = usage->cr;
1449 int i, ret, max_sums;
1450 int nsquares = cages->nr_squares[b];
1451 unsigned int *sumbits, possible_addends;
1452
1453 if (clue == 0) {
1454 assert(nsquares == 0);
1455 return 0;
1456 }
1457 assert(nsquares > 0);
1458
1459 if (nsquares > 4)
1460 return 0;
1461
1462 if (!cage_is_region) {
1463 int known_row = -1, known_col = -1, known_block = -1;
1464 /*
1465 * Verify that the cage lies entirely within one region,
1466 * so that using the precomputed sums is valid.
1467 */
1468 for (i = 0; i < nsquares; i++) {
1469 int x = cages->blocks[b][i];
1470
1471 assert(usage->grid[x] == 0);
1472
1473 if (i == 0) {
1474 known_row = x/cr;
1475 known_col = x%cr;
1476 known_block = usage->blocks->whichblock[x];
1477 } else {
1478 if (known_row != x/cr)
1479 known_row = -1;
1480 if (known_col != x%cr)
1481 known_col = -1;
1482 if (known_block != usage->blocks->whichblock[x])
1483 known_block = -1;
1484 }
1485 }
1486 if (known_block == -1 && known_col == -1 && known_row == -1)
1487 return 0;
1488 }
1489 if (nsquares == 2) {
1490 if (clue < 3 || clue > 17)
1491 return -1;
1492
1493 sumbits = sum_bits2[clue];
1494 max_sums = MAX_2SUMS;
1495 } else if (nsquares == 3) {
1496 if (clue < 6 || clue > 24)
1497 return -1;
1498
1499 sumbits = sum_bits3[clue];
1500 max_sums = MAX_3SUMS;
1501 } else {
1502 if (clue < 10 || clue > 30)
1503 return -1;
1504
1505 sumbits = sum_bits4[clue];
1506 max_sums = MAX_4SUMS;
1507 }
1508 /*
1509 * For every possible way to get the sum, see if there is
1510 * one square in the cage that disallows all the required
1511 * addends. If we find one such square, this way to compute
1512 * the sum is impossible.
1513 */
1514 possible_addends = 0;
1515 for (i = 0; i < max_sums; i++) {
1516 int j;
1517 unsigned int bits = sumbits[i];
1518
1519 if (bits == 0)
1520 break;
1521
1522 for (j = 0; j < nsquares; j++) {
1523 int n;
1524 unsigned int square_bits = bits;
1525 int x = cages->blocks[b][j];
1526 for (n = 1; n <= cr; n++)
1527 if (!cube2(x, n))
1528 square_bits &= ~(1 << n);
1529 if (square_bits == 0) {
1530 break;
1531 }
1532 }
1533 if (j == nsquares)
1534 possible_addends |= bits;
1535 }
1536 /*
1537 * Now we know which addends can possibly be used to
1538 * compute the sum. Remove all other digits from the
1539 * set of possibilities.
1540 */
1541 if (possible_addends == 0)
1542 return -1;
1543
1544 ret = 0;
1545 for (i = 0; i < nsquares; i++) {
1546 int n;
1547 int x = cages->blocks[b][i];
1548 for (n = 1; n <= cr; n++) {
1549 if (!cube2(x, n))
1550 continue;
1551 if ((possible_addends & (1 << n)) == 0) {
1552 cube2(x, n) = FALSE;
1553 ret = 1;
1554#ifdef STANDALONE_SOLVER
1555 if (solver_show_working) {
1556 printf("%*s using %s\n",
1557 solver_recurse_depth*4, "killer sums analysis",
1558 cage_type);
1559 printf("%*s ruling out %d at (%d,%d) due to impossible %d-sum\n",
1560 solver_recurse_depth*4, "",
1561 n, 1 + x%cr, 1 + x/cr, nsquares);
1562 }
1563#endif
1564 }
1565 }
1566 }
1567 return ret;
1568}
1569
1570static int filter_whole_cages(struct solver_usage *usage, int *squares, int n,
1571 int *filtered_sum)
1572{
1573 int b, i, j, off;
1574 *filtered_sum = 0;
1575
1576 /* First, filter squares with a clue. */
1577 for (i = j = 0; i < n; i++)
1578 if (usage->grid[squares[i]])
1579 *filtered_sum += usage->grid[squares[i]];
1580 else
1581 squares[j++] = squares[i];
1582 n = j;
1583
1584 /*
1585 * Filter all cages that are covered entirely by the list of
1586 * squares.
1587 */
1588 off = 0;
1589 for (b = 0; b < usage->kblocks->nr_blocks && off < n; b++) {
1590 int b_squares = usage->kblocks->nr_squares[b];
1591 int matched = 0;
1592
1593 if (b_squares == 0)
1594 continue;
1595
1596 /*
1597 * Find all squares of block b that lie in our list,
1598 * and make them contiguous at off, which is the current position
1599 * in the output list.
1600 */
1601 for (i = 0; i < b_squares; i++) {
1602 for (j = off; j < n; j++)
1603 if (squares[j] == usage->kblocks->blocks[b][i]) {
1604 int t = squares[off + matched];
1605 squares[off + matched] = squares[j];
1606 squares[j] = t;
1607 matched++;
1608 break;
1609 }
1610 }
1611 /* If so, filter out all squares of b from the list. */
1612 if (matched != usage->kblocks->nr_squares[b]) {
1613 off += matched;
1614 continue;
1615 }
1616 memmove(squares + off, squares + off + matched,
1617 (n - off - matched) * sizeof *squares);
1618 n -= matched;
1619
1620 *filtered_sum += usage->kclues[b];
1621 }
1622 assert(off == n);
1623 return off;
1624}
1625
ab362080 1626static struct solver_scratch *solver_new_scratch(struct solver_usage *usage)
ab53eb64 1627{
ab362080 1628 struct solver_scratch *scratch = snew(struct solver_scratch);
ab53eb64 1629 int cr = usage->cr;
1630 scratch->grid = snewn(cr*cr, unsigned char);
1631 scratch->rowidx = snewn(cr, unsigned char);
1632 scratch->colidx = snewn(cr, unsigned char);
1633 scratch->set = snewn(cr, unsigned char);
fbd0fc79 1634 scratch->neighbours = snewn(5*cr, int);
44bf5f6f 1635 scratch->bfsqueue = snewn(cr*cr, int);
1636#ifdef STANDALONE_SOLVER
1637 scratch->bfsprev = snewn(cr*cr, int);
1638#endif
fbd0fc79 1639 scratch->indexlist = snewn(cr*cr, int); /* used for set elimination */
1640 scratch->indexlist2 = snewn(cr, int); /* only used for intersect() */
ab53eb64 1641 return scratch;
1642}
1643
ab362080 1644static void solver_free_scratch(struct solver_scratch *scratch)
ab53eb64 1645{
44bf5f6f 1646#ifdef STANDALONE_SOLVER
1647 sfree(scratch->bfsprev);
1648#endif
1649 sfree(scratch->bfsqueue);
1650 sfree(scratch->neighbours);
ab53eb64 1651 sfree(scratch->set);
1652 sfree(scratch->colidx);
1653 sfree(scratch->rowidx);
1654 sfree(scratch->grid);
fbd0fc79 1655 sfree(scratch->indexlist);
1656 sfree(scratch->indexlist2);
ab53eb64 1657 sfree(scratch);
1658}
1659
ad599e2b 1660/*
1661 * Used for passing information about difficulty levels between the solver
1662 * and its callers.
1663 */
1664struct difficulty {
1665 /* Maximum levels allowed. */
1666 int maxdiff, maxkdiff;
1667 /* Levels reached by the solver. */
1668 int diff, kdiff;
1669};
1670
1671static void solver(int cr, struct block_structure *blocks,
1672 struct block_structure *kblocks, int xtype,
1673 digit *grid, digit *kgrid, struct difficulty *dlev)
1d8e8ad8 1674{
ab362080 1675 struct solver_usage *usage;
1676 struct solver_scratch *scratch;
fbd0fc79 1677 int x, y, b, i, n, ret;
7c568a48 1678 int diff = DIFF_BLOCK;
ad599e2b 1679 int kdiff = DIFF_KSINGLE;
1d8e8ad8 1680
1681 /*
1682 * Set up a usage structure as a clean slate (everything
1683 * possible).
1684 */
ab362080 1685 usage = snew(struct solver_usage);
1d8e8ad8 1686 usage->cr = cr;
fbd0fc79 1687 usage->blocks = blocks;
ad599e2b 1688 if (kblocks) {
1689 usage->kblocks = dup_block_structure(kblocks);
1690 usage->extra_cages = alloc_block_structure (kblocks->c, kblocks->r,
1691 cr * cr, cr, cr * cr);
1692 usage->extra_clues = snewn(cr*cr, digit);
1693 } else {
1694 usage->kblocks = usage->extra_cages = NULL;
1695 usage->extra_clues = NULL;
1696 }
1d8e8ad8 1697 usage->cube = snewn(cr*cr*cr, unsigned char);
1698 usage->grid = grid; /* write straight back to the input */
ad599e2b 1699 if (kgrid) {
1700 int nclues = kblocks->nr_blocks;
1701 /*
1702 * Allow for expansion of the killer regions, the absolute
1703 * limit is obviously one region per square.
1704 */
1705 usage->kclues = snewn(cr*cr, digit);
1706 for (i = 0; i < nclues; i++) {
1707 for (n = 0; n < kblocks->nr_squares[i]; n++)
1708 if (kgrid[kblocks->blocks[i][n]] != 0)
1709 usage->kclues[i] = kgrid[kblocks->blocks[i][n]];
1710 assert(usage->kclues[i] > 0);
1711 }
1712 memset(usage->kclues + nclues, 0, cr*cr - nclues);
1713 } else {
1714 usage->kclues = NULL;
1715 }
1716
1d8e8ad8 1717 memset(usage->cube, TRUE, cr*cr*cr);
1718
1719 usage->row = snewn(cr * cr, unsigned char);
1720 usage->col = snewn(cr * cr, unsigned char);
1721 usage->blk = snewn(cr * cr, unsigned char);
1722 memset(usage->row, FALSE, cr * cr);
1723 memset(usage->col, FALSE, cr * cr);
1724 memset(usage->blk, FALSE, cr * cr);
1725
fbd0fc79 1726 if (xtype) {
1727 usage->diag = snewn(cr * 2, unsigned char);
1728 memset(usage->diag, FALSE, cr * 2);
1729 } else
1730 usage->diag = NULL;
1731
ad599e2b 1732 usage->nr_regions = cr * 3 + (xtype ? 2 : 0);
1733 usage->regions = snewn(cr * usage->nr_regions, int);
1734 usage->sq2region = snewn(cr * cr * 3, int *);
1735
1736 for (n = 0; n < cr; n++) {
1737 for (i = 0; i < cr; i++) {
1738 x = n*cr+i;
1739 y = i*cr+n;
1740 b = usage->blocks->blocks[n][i];
1741 usage->regions[cr*n*3 + i] = x;
1742 usage->regions[cr*n*3 + cr + i] = y;
1743 usage->regions[cr*n*3 + 2*cr + i] = b;
1744 usage->sq2region[x*3] = usage->regions + cr*n*3;
1745 usage->sq2region[y*3 + 1] = usage->regions + cr*n*3 + cr;
1746 usage->sq2region[b*3 + 2] = usage->regions + cr*n*3 + 2*cr;
1747 }
1748 }
1749
ab362080 1750 scratch = solver_new_scratch(usage);
ab53eb64 1751
1d8e8ad8 1752 /*
1753 * Place all the clue numbers we are given.
1754 */
1755 for (x = 0; x < cr; x++)
1756 for (y = 0; y < cr; y++)
1757 if (grid[y*cr+x])
fbd0fc79 1758 solver_place(usage, x, y, grid[y*cr+x]);
1d8e8ad8 1759
1760 /*
1761 * Now loop over the grid repeatedly trying all permitted modes
1762 * of reasoning. The loop terminates if we complete an
1763 * iteration without making any progress; we then return
1764 * failure or success depending on whether the grid is full or
1765 * not.
1766 */
1767 while (1) {
7c568a48 1768 /*
1769 * I'd like to write `continue;' inside each of the
1770 * following loops, so that the solver returns here after
1771 * making some progress. However, I can't specify that I
1772 * want to continue an outer loop rather than the innermost
1773 * one, so I'm apologetically resorting to a goto.
1774 */
3ddae0ff 1775 cont:
1776
1d8e8ad8 1777 /*
1778 * Blockwise positional elimination.
1779 */
fbd0fc79 1780 for (b = 0; b < cr; b++)
1781 for (n = 1; n <= cr; n++)
1782 if (!usage->blk[b*cr+n-1]) {
1783 for (i = 0; i < cr; i++)
1784 scratch->indexlist[i] = cubepos2(usage->blocks->blocks[b][i],n);
1785 ret = solver_elim(usage, scratch->indexlist
7c568a48 1786#ifdef STANDALONE_SOLVER
fbd0fc79 1787 , "positional elimination,"
1788 " %d in block %s", n,
1789 usage->blocks->blocknames[b]
7c568a48 1790#endif
fbd0fc79 1791 );
1792 if (ret < 0) {
1793 diff = DIFF_IMPOSSIBLE;
1794 goto got_result;
1795 } else if (ret > 0) {
1796 diff = max(diff, DIFF_BLOCK);
1797 goto cont;
1798 }
1799 }
1d8e8ad8 1800
ad599e2b 1801 if (usage->kclues != NULL) {
1802 int changed = FALSE;
1803
1804 /*
1805 * First, bring the kblocks into a more useful form: remove
1806 * all filled-in squares, and reduce the sum by their values.
1807 * Walk in reverse order, since otherwise remove_from_block
1808 * can move element past our loop counter.
1809 */
1810 for (b = 0; b < usage->kblocks->nr_blocks; b++)
1811 for (i = usage->kblocks->nr_squares[b] -1; i >= 0; i--) {
1812 int x = usage->kblocks->blocks[b][i];
1813 int t = usage->grid[x];
1814
1815 if (t == 0)
1816 continue;
1817 remove_from_block(usage->kblocks, b, x);
1818 if (t > usage->kclues[b]) {
1819 diff = DIFF_IMPOSSIBLE;
1820 goto got_result;
1821 }
1822 usage->kclues[b] -= t;
1823 /*
1824 * Since cages are regions, this tells us something
1825 * about the other squares in the cage.
1826 */
1827 for (n = 0; n < usage->kblocks->nr_squares[b]; n++) {
1828 cube2(usage->kblocks->blocks[b][n], t) = FALSE;
1829 }
1830 }
1831
1832 /*
1833 * The most trivial kind of solver for killer puzzles: fill
1834 * single-square cages.
1835 */
1836 for (b = 0; b < usage->kblocks->nr_blocks; b++) {
1837 int squares = usage->kblocks->nr_squares[b];
1838 if (squares == 1) {
1839 int v = usage->kclues[b];
1840 if (v < 1 || v > cr) {
1841 diff = DIFF_IMPOSSIBLE;
1842 goto got_result;
1843 }
1844 x = usage->kblocks->blocks[b][0] % cr;
1845 y = usage->kblocks->blocks[b][0] / cr;
1846 if (!cube(x, y, v)) {
1847 diff = DIFF_IMPOSSIBLE;
1848 goto got_result;
1849 }
1850 solver_place(usage, x, y, v);
1851
1852#ifdef STANDALONE_SOLVER
1853 if (solver_show_working) {
1854 printf("%*s placing %d at (%d,%d)\n",
1855 solver_recurse_depth*4, "killer single-square cage",
1856 v, 1 + x%cr, 1 + x/cr);
1857 }
1858#endif
1859 changed = TRUE;
1860 }
1861 }
1862
1863 if (changed) {
1864 kdiff = max(kdiff, DIFF_KSINGLE);
1865 goto cont;
1866 }
1867 }
1868 if (dlev->maxkdiff >= DIFF_KINTERSECT && usage->kclues != NULL) {
1869 int changed = FALSE;
1870 /*
1871 * Now, create the extra_cages information. Every full region
1872 * (row, column, or block) has the same sum total (45 for 3x3
1873 * puzzles. After we try to cover these regions with cages that
1874 * lie entirely within them, any squares that remain must bring
1875 * the total to this known value, and so they form additional
1876 * cages which aren't immediately evident in the displayed form
1877 * of the puzzle.
1878 */
1879 usage->extra_cages->nr_blocks = 0;
1880 for (i = 0; i < 3; i++) {
1881 for (n = 0; n < cr; n++) {
1882 int *region = usage->regions + cr*n*3 + i*cr;
1883 int sum = cr * (cr + 1) / 2;
1884 int nsquares = cr;
1885 int filtered;
1886 int n_extra = usage->extra_cages->nr_blocks;
1887 int *extra_list = usage->extra_cages->blocks[n_extra];
1888 memcpy(extra_list, region, cr * sizeof *extra_list);
1889
1890 nsquares = filter_whole_cages(usage, extra_list, nsquares, &filtered);
1891 sum -= filtered;
1892 if (nsquares == cr || nsquares == 0)
1893 continue;
1894 if (dlev->maxdiff >= DIFF_RECURSIVE) {
1895 if (sum <= 0) {
1896 dlev->diff = DIFF_IMPOSSIBLE;
1897 goto got_result;
1898 }
1899 }
1900 assert(sum > 0);
1901
1902 if (nsquares == 1) {
1903 if (sum > cr) {
1904 diff = DIFF_IMPOSSIBLE;
1905 goto got_result;
1906 }
1907 x = extra_list[0] % cr;
1908 y = extra_list[0] / cr;
1909 if (!cube(x, y, sum)) {
1910 diff = DIFF_IMPOSSIBLE;
1911 goto got_result;
1912 }
1913 solver_place(usage, x, y, sum);
1914 changed = TRUE;
1915#ifdef STANDALONE_SOLVER
1916 if (solver_show_working) {
1917 printf("%*s placing %d at (%d,%d)\n",
1918 solver_recurse_depth*4, "killer single-square deduced cage",
1919 sum, 1 + x, 1 + y);
1920 }
1921#endif
1922 }
1923
1924 b = usage->kblocks->whichblock[extra_list[0]];
1925 for (x = 1; x < nsquares; x++)
1926 if (usage->kblocks->whichblock[extra_list[x]] != b)
1927 break;
1928 if (x == nsquares) {
1929 assert(usage->kblocks->nr_squares[b] > nsquares);
1930 split_block(usage->kblocks, extra_list, nsquares);
1931 assert(usage->kblocks->nr_squares[usage->kblocks->nr_blocks - 1] == nsquares);
1932 usage->kclues[usage->kblocks->nr_blocks - 1] = sum;
1933 usage->kclues[b] -= sum;
1934 } else {
1935 usage->extra_cages->nr_squares[n_extra] = nsquares;
1936 usage->extra_cages->nr_blocks++;
1937 usage->extra_clues[n_extra] = sum;
1938 }
1939 }
1940 }
1941 if (changed) {
1942 kdiff = max(kdiff, DIFF_KINTERSECT);
1943 goto cont;
1944 }
1945 }
1946
1947 /*
1948 * Another simple killer-type elimination. For every square in a
1949 * cage, find the minimum and maximum possible sums of all the
1950 * other squares in the same cage, and rule out possibilities
1951 * for the given square based on whether they are guaranteed to
1952 * cause the sum to be either too high or too low.
1953 * This is a special case of trying all possible sums across a
1954 * region, which is a recursive algorithm. We should probably
1955 * implement it for a higher difficulty level.
1956 */
1957 if (dlev->maxkdiff >= DIFF_KMINMAX && usage->kclues != NULL) {
1958 int changed = FALSE;
1959 for (b = 0; b < usage->kblocks->nr_blocks; b++) {
1960 int ret = solver_killer_minmax(usage, usage->kblocks,
1961 usage->kclues, b
1962#ifdef STANDALONE_SOLVER
1963 , ""
1964#endif
1965 );
1966 if (ret < 0) {
1967 diff = DIFF_IMPOSSIBLE;
1968 goto got_result;
1969 } else if (ret > 0)
1970 changed = TRUE;
1971 }
1972 for (b = 0; b < usage->extra_cages->nr_blocks; b++) {
1973 int ret = solver_killer_minmax(usage, usage->extra_cages,
1974 usage->extra_clues, b
1975#ifdef STANDALONE_SOLVER
1976 , "using deduced cages"
1977#endif
1978 );
1979 if (ret < 0) {
1980 diff = DIFF_IMPOSSIBLE;
1981 goto got_result;
1982 } else if (ret > 0)
1983 changed = TRUE;
1984 }
1985 if (changed) {
1986 kdiff = max(kdiff, DIFF_KMINMAX);
1987 goto cont;
1988 }
1989 }
1990
1991 /*
1992 * Try to use knowledge of which numbers can be used to generate
1993 * a given sum.
1994 * This can only be used if a cage lies entirely within a region.
1995 */
1996 if (dlev->maxkdiff >= DIFF_KSUMS && usage->kclues != NULL) {
1997 int changed = FALSE;
1998
1999 for (b = 0; b < usage->kblocks->nr_blocks; b++) {
2000 int ret = solver_killer_sums(usage, b, usage->kblocks,
2001 usage->kclues[b], TRUE
2002#ifdef STANDALONE_SOLVER
2003 , "regular clues"
2004#endif
2005 );
2006 if (ret > 0) {
2007 changed = TRUE;
2008 kdiff = max(kdiff, DIFF_KSUMS);
2009 } else if (ret < 0) {
2010 diff = DIFF_IMPOSSIBLE;
2011 goto got_result;
2012 }
2013 }
2014
2015 for (b = 0; b < usage->extra_cages->nr_blocks; b++) {
2016 int ret = solver_killer_sums(usage, b, usage->extra_cages,
2017 usage->extra_clues[b], FALSE
2018#ifdef STANDALONE_SOLVER
2019 , "deduced clues"
2020#endif
2021 );
2022 if (ret > 0) {
2023 changed = TRUE;
2024 kdiff = max(kdiff, DIFF_KINTERSECT);
2025 } else if (ret < 0) {
2026 diff = DIFF_IMPOSSIBLE;
2027 goto got_result;
2028 }
2029 }
2030
2031 if (changed)
2032 goto cont;
2033 }
2034
2035 if (dlev->maxdiff <= DIFF_BLOCK)
ab362080 2036 break;
2037
1d8e8ad8 2038 /*
2039 * Row-wise positional elimination.
2040 */
2041 for (y = 0; y < cr; y++)
2042 for (n = 1; n <= cr; n++)
ab362080 2043 if (!usage->row[y*cr+n-1]) {
fbd0fc79 2044 for (x = 0; x < cr; x++)
2045 scratch->indexlist[x] = cubepos(x, y, n);
2046 ret = solver_elim(usage, scratch->indexlist
7c568a48 2047#ifdef STANDALONE_SOLVER
ab362080 2048 , "positional elimination,"
fbd0fc79 2049 " %d in row %d", n, 1+y
7c568a48 2050#endif
ab362080 2051 );
2052 if (ret < 0) {
2053 diff = DIFF_IMPOSSIBLE;
2054 goto got_result;
2055 } else if (ret > 0) {
2056 diff = max(diff, DIFF_SIMPLE);
2057 goto cont;
2058 }
7c568a48 2059 }
1d8e8ad8 2060 /*
2061 * Column-wise positional elimination.
2062 */
2063 for (x = 0; x < cr; x++)
2064 for (n = 1; n <= cr; n++)
ab362080 2065 if (!usage->col[x*cr+n-1]) {
fbd0fc79 2066 for (y = 0; y < cr; y++)
2067 scratch->indexlist[y] = cubepos(x, y, n);
2068 ret = solver_elim(usage, scratch->indexlist
7c568a48 2069#ifdef STANDALONE_SOLVER
ab362080 2070 , "positional elimination,"
2071 " %d in column %d", n, 1+x
7c568a48 2072#endif
ab362080 2073 );
2074 if (ret < 0) {
2075 diff = DIFF_IMPOSSIBLE;
2076 goto got_result;
2077 } else if (ret > 0) {
2078 diff = max(diff, DIFF_SIMPLE);
2079 goto cont;
2080 }
7c568a48 2081 }
1d8e8ad8 2082
2083 /*
fbd0fc79 2084 * X-diagonal positional elimination.
2085 */
2086 if (usage->diag) {
2087 for (n = 1; n <= cr; n++)
2088 if (!usage->diag[n-1]) {
2089 for (i = 0; i < cr; i++)
2090 scratch->indexlist[i] = cubepos2(diag0(i), n);
2091 ret = solver_elim(usage, scratch->indexlist
2092#ifdef STANDALONE_SOLVER
2093 , "positional elimination,"
2094 " %d in \\-diagonal", n
2095#endif
2096 );
2097 if (ret < 0) {
2098 diff = DIFF_IMPOSSIBLE;
2099 goto got_result;
2100 } else if (ret > 0) {
2101 diff = max(diff, DIFF_SIMPLE);
2102 goto cont;
2103 }
2104 }
2105 for (n = 1; n <= cr; n++)
2106 if (!usage->diag[cr+n-1]) {
2107 for (i = 0; i < cr; i++)
2108 scratch->indexlist[i] = cubepos2(diag1(i), n);
2109 ret = solver_elim(usage, scratch->indexlist
2110#ifdef STANDALONE_SOLVER
2111 , "positional elimination,"
2112 " %d in /-diagonal", n
2113#endif
2114 );
2115 if (ret < 0) {
2116 diff = DIFF_IMPOSSIBLE;
2117 goto got_result;
2118 } else if (ret > 0) {
2119 diff = max(diff, DIFF_SIMPLE);
2120 goto cont;
2121 }
2122 }
2123 }
2124
2125 /*
1d8e8ad8 2126 * Numeric elimination.
2127 */
2128 for (x = 0; x < cr; x++)
2129 for (y = 0; y < cr; y++)
fbd0fc79 2130 if (!usage->grid[y*cr+x]) {
2131 for (n = 1; n <= cr; n++)
2132 scratch->indexlist[n-1] = cubepos(x, y, n);
2133 ret = solver_elim(usage, scratch->indexlist
7c568a48 2134#ifdef STANDALONE_SOLVER
fbd0fc79 2135 , "numeric elimination at (%d,%d)",
2136 1+x, 1+y
7c568a48 2137#endif
ab362080 2138 );
2139 if (ret < 0) {
2140 diff = DIFF_IMPOSSIBLE;
2141 goto got_result;
2142 } else if (ret > 0) {
2143 diff = max(diff, DIFF_SIMPLE);
2144 goto cont;
2145 }
7c568a48 2146 }
2147
ad599e2b 2148 if (dlev->maxdiff <= DIFF_SIMPLE)
ab362080 2149 break;
2150
7c568a48 2151 /*
2152 * Intersectional analysis, rows vs blocks.
2153 */
2154 for (y = 0; y < cr; y++)
fbd0fc79 2155 for (b = 0; b < cr; b++)
2156 for (n = 1; n <= cr; n++) {
2157 if (usage->row[y*cr+n-1] ||
2158 usage->blk[b*cr+n-1])
2159 continue;
2160 for (i = 0; i < cr; i++) {
2161 scratch->indexlist[i] = cubepos(i, y, n);
2162 scratch->indexlist2[i] = cubepos2(usage->blocks->blocks[b][i], n);
2163 }
ab362080 2164 /*
2165 * solver_intersect() never returns -1.
2166 */
fbd0fc79 2167 if (solver_intersect(usage, scratch->indexlist,
2168 scratch->indexlist2
7c568a48 2169#ifdef STANDALONE_SOLVER
2170 , "intersectional analysis,"
fbd0fc79 2171 " %d in row %d vs block %s",
2172 n, 1+y, usage->blocks->blocknames[b]
7c568a48 2173#endif
2174 ) ||
fbd0fc79 2175 solver_intersect(usage, scratch->indexlist2,
2176 scratch->indexlist
7c568a48 2177#ifdef STANDALONE_SOLVER
2178 , "intersectional analysis,"
fbd0fc79 2179 " %d in block %s vs row %d",
2180 n, usage->blocks->blocknames[b], 1+y
7c568a48 2181#endif
fbd0fc79 2182 )) {
7c568a48 2183 diff = max(diff, DIFF_INTERSECT);
2184 goto cont;
2185 }
fbd0fc79 2186 }
7c568a48 2187
2188 /*
2189 * Intersectional analysis, columns vs blocks.
2190 */
2191 for (x = 0; x < cr; x++)
fbd0fc79 2192 for (b = 0; b < cr; b++)
2193 for (n = 1; n <= cr; n++) {
2194 if (usage->col[x*cr+n-1] ||
2195 usage->blk[b*cr+n-1])
2196 continue;
2197 for (i = 0; i < cr; i++) {
2198 scratch->indexlist[i] = cubepos(x, i, n);
2199 scratch->indexlist2[i] = cubepos2(usage->blocks->blocks[b][i], n);
2200 }
2201 if (solver_intersect(usage, scratch->indexlist,
2202 scratch->indexlist2
2203#ifdef STANDALONE_SOLVER
2204 , "intersectional analysis,"
2205 " %d in column %d vs block %s",
2206 n, 1+x, usage->blocks->blocknames[b]
2207#endif
2208 ) ||
2209 solver_intersect(usage, scratch->indexlist2,
2210 scratch->indexlist
2211#ifdef STANDALONE_SOLVER
2212 , "intersectional analysis,"
2213 " %d in block %s vs column %d",
2214 n, usage->blocks->blocknames[b], 1+x
2215#endif
2216 )) {
2217 diff = max(diff, DIFF_INTERSECT);
2218 goto cont;
2219 }
2220 }
2221
2222 if (usage->diag) {
2223 /*
2224 * Intersectional analysis, \-diagonal vs blocks.
2225 */
2226 for (b = 0; b < cr; b++)
2227 for (n = 1; n <= cr; n++) {
2228 if (usage->diag[n-1] ||
2229 usage->blk[b*cr+n-1])
2230 continue;
2231 for (i = 0; i < cr; i++) {
2232 scratch->indexlist[i] = cubepos2(diag0(i), n);
2233 scratch->indexlist2[i] = cubepos2(usage->blocks->blocks[b][i], n);
2234 }
2235 if (solver_intersect(usage, scratch->indexlist,
2236 scratch->indexlist2
2237#ifdef STANDALONE_SOLVER
2238 , "intersectional analysis,"
2239 " %d in \\-diagonal vs block %s",
2240 n, 1+x, usage->blocks->blocknames[b]
2241#endif
2242 ) ||
2243 solver_intersect(usage, scratch->indexlist2,
2244 scratch->indexlist
2245#ifdef STANDALONE_SOLVER
2246 , "intersectional analysis,"
2247 " %d in block %s vs \\-diagonal",
2248 n, usage->blocks->blocknames[b], 1+x
2249#endif
2250 )) {
2251 diff = max(diff, DIFF_INTERSECT);
2252 goto cont;
2253 }
2254 }
2255
2256 /*
2257 * Intersectional analysis, /-diagonal vs blocks.
2258 */
2259 for (b = 0; b < cr; b++)
2260 for (n = 1; n <= cr; n++) {
2261 if (usage->diag[cr+n-1] ||
2262 usage->blk[b*cr+n-1])
2263 continue;
2264 for (i = 0; i < cr; i++) {
2265 scratch->indexlist[i] = cubepos2(diag1(i), n);
2266 scratch->indexlist2[i] = cubepos2(usage->blocks->blocks[b][i], n);
2267 }
2268 if (solver_intersect(usage, scratch->indexlist,
2269 scratch->indexlist2
7c568a48 2270#ifdef STANDALONE_SOLVER
2271 , "intersectional analysis,"
fbd0fc79 2272 " %d in /-diagonal vs block %s",
2273 n, 1+x, usage->blocks->blocknames[b]
7c568a48 2274#endif
2275 ) ||
fbd0fc79 2276 solver_intersect(usage, scratch->indexlist2,
2277 scratch->indexlist
7c568a48 2278#ifdef STANDALONE_SOLVER
2279 , "intersectional analysis,"
fbd0fc79 2280 " %d in block %s vs /-diagonal",
2281 n, usage->blocks->blocknames[b], 1+x
7c568a48 2282#endif
fbd0fc79 2283 )) {
7c568a48 2284 diff = max(diff, DIFF_INTERSECT);
2285 goto cont;
2286 }
fbd0fc79 2287 }
2288 }
7c568a48 2289
ad599e2b 2290 if (dlev->maxdiff <= DIFF_INTERSECT)
ab362080 2291 break;
2292
7c568a48 2293 /*
2294 * Blockwise set elimination.
2295 */
fbd0fc79 2296 for (b = 0; b < cr; b++) {
2297 for (i = 0; i < cr; i++)
2298 for (n = 1; n <= cr; n++)
2299 scratch->indexlist[i*cr+n-1] = cubepos2(usage->blocks->blocks[b][i], n);
2300 ret = solver_set(usage, scratch, scratch->indexlist
7c568a48 2301#ifdef STANDALONE_SOLVER
fbd0fc79 2302 , "set elimination, block %s",
2303 usage->blocks->blocknames[b]
7c568a48 2304#endif
ab362080 2305 );
fbd0fc79 2306 if (ret < 0) {
2307 diff = DIFF_IMPOSSIBLE;
2308 goto got_result;
2309 } else if (ret > 0) {
2310 diff = max(diff, DIFF_SET);
2311 goto cont;
ab362080 2312 }
fbd0fc79 2313 }
7c568a48 2314
2315 /*
2316 * Row-wise set elimination.
2317 */
ab362080 2318 for (y = 0; y < cr; y++) {
fbd0fc79 2319 for (x = 0; x < cr; x++)
2320 for (n = 1; n <= cr; n++)
2321 scratch->indexlist[x*cr+n-1] = cubepos(x, y, n);
2322 ret = solver_set(usage, scratch, scratch->indexlist
7c568a48 2323#ifdef STANDALONE_SOLVER
fbd0fc79 2324 , "set elimination, row %d", 1+y
7c568a48 2325#endif
ab362080 2326 );
2327 if (ret < 0) {
2328 diff = DIFF_IMPOSSIBLE;
2329 goto got_result;
2330 } else if (ret > 0) {
2331 diff = max(diff, DIFF_SET);
2332 goto cont;
2333 }
2334 }
7c568a48 2335
2336 /*
2337 * Column-wise set elimination.
2338 */
ab362080 2339 for (x = 0; x < cr; x++) {
fbd0fc79 2340 for (y = 0; y < cr; y++)
2341 for (n = 1; n <= cr; n++)
2342 scratch->indexlist[y*cr+n-1] = cubepos(x, y, n);
2343 ret = solver_set(usage, scratch, scratch->indexlist
7c568a48 2344#ifdef STANDALONE_SOLVER
ab362080 2345 , "set elimination, column %d", 1+x
7c568a48 2346#endif
ab362080 2347 );
2348 if (ret < 0) {
2349 diff = DIFF_IMPOSSIBLE;
2350 goto got_result;
2351 } else if (ret > 0) {
2352 diff = max(diff, DIFF_SET);
2353 goto cont;
2354 }
2355 }
1d8e8ad8 2356
fbd0fc79 2357 if (usage->diag) {
2358 /*
2359 * \-diagonal set elimination.
2360 */
2361 for (i = 0; i < cr; i++)
2362 for (n = 1; n <= cr; n++)
2363 scratch->indexlist[i*cr+n-1] = cubepos2(diag0(i), n);
2364 ret = solver_set(usage, scratch, scratch->indexlist
2365#ifdef STANDALONE_SOLVER
2366 , "set elimination, \\-diagonal"
2367#endif
2368 );
2369 if (ret < 0) {
2370 diff = DIFF_IMPOSSIBLE;
2371 goto got_result;
2372 } else if (ret > 0) {
2373 diff = max(diff, DIFF_SET);
2374 goto cont;
2375 }
2376
2377 /*
2378 * /-diagonal set elimination.
2379 */
2380 for (i = 0; i < cr; i++)
2381 for (n = 1; n <= cr; n++)
2382 scratch->indexlist[i*cr+n-1] = cubepos2(diag1(i), n);
2383 ret = solver_set(usage, scratch, scratch->indexlist
2384#ifdef STANDALONE_SOLVER
2385 , "set elimination, \\-diagonal"
2386#endif
2387 );
2388 if (ret < 0) {
2389 diff = DIFF_IMPOSSIBLE;
2390 goto got_result;
2391 } else if (ret > 0) {
2392 diff = max(diff, DIFF_SET);
2393 goto cont;
2394 }
2395 }
2396
ad599e2b 2397 if (dlev->maxdiff <= DIFF_SET)
fbd0fc79 2398 break;
2399
1d8e8ad8 2400 /*
44bf5f6f 2401 * Row-vs-column set elimination on a single number.
2402 */
2403 for (n = 1; n <= cr; n++) {
fbd0fc79 2404 for (y = 0; y < cr; y++)
2405 for (x = 0; x < cr; x++)
2406 scratch->indexlist[y*cr+x] = cubepos(x, y, n);
2407 ret = solver_set(usage, scratch, scratch->indexlist
44bf5f6f 2408#ifdef STANDALONE_SOLVER
2409 , "positional set elimination, number %d", n
2410#endif
2411 );
2412 if (ret < 0) {
2413 diff = DIFF_IMPOSSIBLE;
2414 goto got_result;
2415 } else if (ret > 0) {
2416 diff = max(diff, DIFF_EXTREME);
2417 goto cont;
2418 }
2419 }
2420
44bf5f6f 2421 /*
2422 * Forcing chains.
2423 */
2424 if (solver_forcing(usage, scratch)) {
2425 diff = max(diff, DIFF_EXTREME);
2426 goto cont;
2427 }
2428
13c4d60d 2429 /*
1d8e8ad8 2430 * If we reach here, we have made no deductions in this
2431 * iteration, so the algorithm terminates.
2432 */
2433 break;
2434 }
2435
ab362080 2436 /*
2437 * Last chance: if we haven't fully solved the puzzle yet, try
2438 * recursing based on guesses for a particular square. We pick
2439 * one of the most constrained empty squares we can find, which
2440 * has the effect of pruning the search tree as much as
2441 * possible.
2442 */
ad599e2b 2443 if (dlev->maxdiff >= DIFF_RECURSIVE) {
947a07d6 2444 int best, bestcount;
ab362080 2445
2446 best = -1;
2447 bestcount = cr+1;
ab362080 2448
2449 for (y = 0; y < cr; y++)
2450 for (x = 0; x < cr; x++)
2451 if (!grid[y*cr+x]) {
2452 int count;
2453
2454 /*
2455 * An unfilled square. Count the number of
2456 * possible digits in it.
2457 */
2458 count = 0;
2459 for (n = 1; n <= cr; n++)
fbd0fc79 2460 if (cube(x,y,n))
ab362080 2461 count++;
2462
2463 /*
2464 * We should have found any impossibilities
2465 * already, so this can safely be an assert.
2466 */
2467 assert(count > 1);
2468
2469 if (count < bestcount) {
2470 bestcount = count;
947a07d6 2471 best = y*cr+x;
ab362080 2472 }
2473 }
2474
2475 if (best != -1) {
2476 int i, j;
2477 digit *list, *ingrid, *outgrid;
2478
2479 diff = DIFF_IMPOSSIBLE; /* no solution found yet */
2480
2481 /*
2482 * Attempt recursion.
2483 */
2484 y = best / cr;
2485 x = best % cr;
2486
2487 list = snewn(cr, digit);
2488 ingrid = snewn(cr * cr, digit);
2489 outgrid = snewn(cr * cr, digit);
2490 memcpy(ingrid, grid, cr * cr);
2491
2492 /* Make a list of the possible digits. */
2493 for (j = 0, n = 1; n <= cr; n++)
fbd0fc79 2494 if (cube(x,y,n))
ab362080 2495 list[j++] = n;
2496
2497#ifdef STANDALONE_SOLVER
2498 if (solver_show_working) {
2499 char *sep = "";
2500 printf("%*srecursing on (%d,%d) [",
49d4feb5 2501 solver_recurse_depth*4, "", x + 1, y + 1);
ab362080 2502 for (i = 0; i < j; i++) {
2503 printf("%s%d", sep, list[i]);
2504 sep = " or ";
2505 }
2506 printf("]\n");
2507 }
2508#endif
2509
ab362080 2510 /*
2511 * And step along the list, recursing back into the
2512 * main solver at every stage.
2513 */
2514 for (i = 0; i < j; i++) {
ab362080 2515 memcpy(outgrid, ingrid, cr * cr);
2516 outgrid[y*cr+x] = list[i];
2517
2518#ifdef STANDALONE_SOLVER
2519 if (solver_show_working)
2520 printf("%*sguessing %d at (%d,%d)\n",
49d4feb5 2521 solver_recurse_depth*4, "", list[i], x + 1, y + 1);
ab362080 2522 solver_recurse_depth++;
2523#endif
2524
ad599e2b 2525 solver(cr, blocks, kblocks, xtype, outgrid, kgrid, dlev);
ab362080 2526
2527#ifdef STANDALONE_SOLVER
2528 solver_recurse_depth--;
2529 if (solver_show_working) {
2530 printf("%*sretracting %d at (%d,%d)\n",
49d4feb5 2531 solver_recurse_depth*4, "", list[i], x + 1, y + 1);
ab362080 2532 }
2533#endif
2534
2535 /*
2536 * If we have our first solution, copy it into the
2537 * grid we will return.
2538 */
ad599e2b 2539 if (diff == DIFF_IMPOSSIBLE && dlev->diff != DIFF_IMPOSSIBLE)
ab362080 2540 memcpy(grid, outgrid, cr*cr);
2541
ad599e2b 2542 if (dlev->diff == DIFF_AMBIGUOUS)
ab362080 2543 diff = DIFF_AMBIGUOUS;
ad599e2b 2544 else if (dlev->diff == DIFF_IMPOSSIBLE)
ab362080 2545 /* do not change our return value */;
2546 else {
2547 /* the recursion turned up exactly one solution */
2548 if (diff == DIFF_IMPOSSIBLE)
2549 diff = DIFF_RECURSIVE;
2550 else
2551 diff = DIFF_AMBIGUOUS;
2552 }
2553
2554 /*
2555 * As soon as we've found more than one solution,
2556 * give up immediately.
2557 */
2558 if (diff == DIFF_AMBIGUOUS)
2559 break;
2560 }
2561
2562 sfree(outgrid);
2563 sfree(ingrid);
2564 sfree(list);
2565 }
2566
2567 } else {
2568 /*
2569 * We're forbidden to use recursion, so we just see whether
2570 * our grid is fully solved, and return DIFF_IMPOSSIBLE
2571 * otherwise.
2572 */
2573 for (y = 0; y < cr; y++)
2574 for (x = 0; x < cr; x++)
2575 if (!grid[y*cr+x])
2576 diff = DIFF_IMPOSSIBLE;
2577 }
2578
ad599e2b 2579 got_result:
2580 dlev->diff = diff;
2581 dlev->kdiff = kdiff;
ab362080 2582
2583#ifdef STANDALONE_SOLVER
2584 if (solver_show_working)
2585 printf("%*s%s found\n",
2586 solver_recurse_depth*4, "",
2587 diff == DIFF_IMPOSSIBLE ? "no solution" :
2588 diff == DIFF_AMBIGUOUS ? "multiple solutions" :
2589 "one solution");
2590#endif
ab53eb64 2591
1d8e8ad8 2592 sfree(usage->cube);
2593 sfree(usage->row);
2594 sfree(usage->col);
2595 sfree(usage->blk);
ad599e2b 2596 if (usage->kblocks) {
2597 free_block_structure(usage->kblocks);
2598 free_block_structure(usage->extra_cages);
2599 sfree(usage->extra_clues);
2600 }
1d8e8ad8 2601 sfree(usage);
2602
ab362080 2603 solver_free_scratch(scratch);
1d8e8ad8 2604}
2605
2606/* ----------------------------------------------------------------------
ab362080 2607 * End of solver code.
2608 */
2609
2610/* ----------------------------------------------------------------------
ad599e2b 2611 * Killer set generator.
2612 */
2613
2614/* ----------------------------------------------------------------------
2615 * Solo filled-grid generator.
ab362080 2616 *
2617 * This grid generator works by essentially trying to solve a grid
2618 * starting from no clues, and not worrying that there's more than
2619 * one possible solution. Unfortunately, it isn't computationally
2620 * feasible to do this by calling the above solver with an empty
2621 * grid, because that one needs to allocate a lot of scratch space
2622 * at every recursion level. Instead, I have a much simpler
2623 * algorithm which I shamelessly copied from a Python solver
2624 * written by Andrew Wilkinson (which is GPLed, but I've reused
2625 * only ideas and no code). It mostly just does the obvious
2626 * recursive thing: pick an empty square, put one of the possible
2627 * digits in it, recurse until all squares are filled, backtrack
2628 * and change some choices if necessary.
2629 *
2630 * The clever bit is that every time it chooses which square to
2631 * fill in next, it does so by counting the number of _possible_
2632 * numbers that can go in each square, and it prioritises so that
2633 * it picks a square with the _lowest_ number of possibilities. The
2634 * idea is that filling in lots of the obvious bits (particularly
2635 * any squares with only one possibility) will cut down on the list
2636 * of possibilities for other squares and hence reduce the enormous
2637 * search space as much as possible as early as possible.
ad599e2b 2638 *
2639 * The use of bit sets implies that we support puzzles up to a size of
2640 * 32x32 (less if anyone finds a 16-bit machine to compile this on).
ab362080 2641 */
2642
2643/*
2644 * Internal data structure used in gridgen to keep track of
2645 * progress.
2646 */
2647struct gridgen_coord { int x, y, r; };
2648struct gridgen_usage {
fbd0fc79 2649 int cr;
ad599e2b 2650 struct block_structure *blocks, *kblocks;
ab362080 2651 /* grid is a copy of the input grid, modified as we go along */
2652 digit *grid;
ad599e2b 2653 /*
2654 * Bitsets. In each of them, bit n is set if digit n has been placed
2655 * in the corresponding region. row, col and blk are used for all
2656 * puzzles. cge is used only for killer puzzles, and diag is used
2657 * only for x-type puzzles.
2658 * All of these have cr entries, except diag which only has 2,
2659 * and cge, which has as many entries as kblocks.
2660 */
2661 unsigned int *row, *col, *blk, *cge, *diag;
ab362080 2662 /* This lists all the empty spaces remaining in the grid. */
2663 struct gridgen_coord *spaces;
2664 int nspaces;
2665 /* If we need randomisation in the solve, this is our random state. */
2666 random_state *rs;
2667};
2668
ad599e2b 2669static void gridgen_place(struct gridgen_usage *usage, int x, int y, digit n)
47f2338e 2670{
ad599e2b 2671 unsigned int bit = 1 << n;
47f2338e 2672 int cr = usage->cr;
ad599e2b 2673 usage->row[y] |= bit;
2674 usage->col[x] |= bit;
2675 usage->blk[usage->blocks->whichblock[y*cr+x]] |= bit;
2676 if (usage->cge)
2677 usage->cge[usage->kblocks->whichblock[y*cr+x]] |= bit;
2678 if (usage->diag) {
2679 if (ondiag0(y*cr+x))
2680 usage->diag[0] |= bit;
2681 if (ondiag1(y*cr+x))
2682 usage->diag[1] |= bit;
2683 }
2684 usage->grid[y*cr+x] = n;
2685}
2686
2687static void gridgen_remove(struct gridgen_usage *usage, int x, int y, digit n)
2688{
2689 unsigned int mask = ~(1 << n);
2690 int cr = usage->cr;
2691 usage->row[y] &= mask;
2692 usage->col[x] &= mask;
2693 usage->blk[usage->blocks->whichblock[y*cr+x]] &= mask;
2694 if (usage->cge)
2695 usage->cge[usage->kblocks->whichblock[y*cr+x]] &= mask;
47f2338e 2696 if (usage->diag) {
2697 if (ondiag0(y*cr+x))
ad599e2b 2698 usage->diag[0] &= mask;
47f2338e 2699 if (ondiag1(y*cr+x))
ad599e2b 2700 usage->diag[1] &= mask;
47f2338e 2701 }
ad599e2b 2702 usage->grid[y*cr+x] = 0;
47f2338e 2703}
2704
ad599e2b 2705#define N_SINGLE 32
2706
ab362080 2707/*
2708 * The real recursive step in the generating function.
fbd0fc79 2709 *
2710 * Return values: 1 means solution found, 0 means no solution
2711 * found on this branch.
ab362080 2712 */
47f2338e 2713static int gridgen_real(struct gridgen_usage *usage, digit *grid, int *steps)
ab362080 2714{
fbd0fc79 2715 int cr = usage->cr;
ab362080 2716 int i, j, n, sx, sy, bestm, bestr, ret;
2717 int *digits;
ad599e2b 2718 unsigned int used;
ab362080 2719
2720 /*
2721 * Firstly, check for completion! If there are no spaces left
2722 * in the grid, we have a solution.
2723 */
47f2338e 2724 if (usage->nspaces == 0)
ab362080 2725 return TRUE;
47f2338e 2726
2727 /*
2728 * Next, abandon generation if we went over our steps limit.
2729 */
2730 if (*steps <= 0)
2731 return FALSE;
2732 (*steps)--;
ab362080 2733
2734 /*
2735 * Otherwise, there must be at least one space. Find the most
2736 * constrained space, using the `r' field as a tie-breaker.
2737 */
2738 bestm = cr+1; /* so that any space will beat it */
2739 bestr = 0;
ad599e2b 2740 used = ~0;
ab362080 2741 i = sx = sy = -1;
2742 for (j = 0; j < usage->nspaces; j++) {
2743 int x = usage->spaces[j].x, y = usage->spaces[j].y;
ad599e2b 2744 unsigned int used_xy;
ab362080 2745 int m;
2746
ad599e2b 2747 m = usage->blocks->whichblock[y*cr+x];
2748 used_xy = usage->row[y] | usage->col[x] | usage->blk[m];
2749 if (usage->cge != NULL)
2750 used_xy |= usage->cge[usage->kblocks->whichblock[y*cr+x]];
2751 if (usage->cge != NULL)
2752 used_xy |= usage->cge[usage->kblocks->whichblock[y*cr+x]];
2753 if (usage->diag != NULL) {
2754 if (ondiag0(y*cr+x))
2755 used_xy |= usage->diag[0];
2756 if (ondiag1(y*cr+x))
2757 used_xy |= usage->diag[1];
2758 }
2759
ab362080 2760 /*
2761 * Find the number of digits that could go in this space.
2762 */
2763 m = 0;
ad599e2b 2764 for (n = 1; n <= cr; n++) {
2765 unsigned int bit = 1 << n;
2766 if ((used_xy & bit) == 0)
ab362080 2767 m++;
ad599e2b 2768 }
ab362080 2769 if (m < bestm || (m == bestm && usage->spaces[j].r < bestr)) {
2770 bestm = m;
2771 bestr = usage->spaces[j].r;
2772 sx = x;
2773 sy = y;
2774 i = j;
ad599e2b 2775 used = used_xy;
ab362080 2776 }
2777 }
2778
2779 /*
2780 * Swap that square into the final place in the spaces array,
2781 * so that decrementing nspaces will remove it from the list.
2782 */
2783 if (i != usage->nspaces-1) {
2784 struct gridgen_coord t;
2785 t = usage->spaces[usage->nspaces-1];
2786 usage->spaces[usage->nspaces-1] = usage->spaces[i];
2787 usage->spaces[i] = t;
2788 }
2789
2790 /*
2791 * Now we've decided which square to start our recursion at,
2792 * simply go through all possible values, shuffling them
2793 * randomly first if necessary.
2794 */
2795 digits = snewn(bestm, int);
ad599e2b 2796
ab362080 2797 j = 0;
ad599e2b 2798 for (n = 1; n <= cr; n++) {
2799 unsigned int bit = 1 << n;
2800
2801 if ((used & bit) == 0)
2802 digits[j++] = n;
2803 }
ab362080 2804
947a07d6 2805 if (usage->rs)
2806 shuffle(digits, j, sizeof(*digits), usage->rs);
ab362080 2807
2808 /* And finally, go through the digit list and actually recurse. */
2809 ret = FALSE;
2810 for (i = 0; i < j; i++) {
2811 n = digits[i];
2812
2813 /* Update the usage structure to reflect the placing of this digit. */
ad599e2b 2814 gridgen_place(usage, sx, sy, n);
ab362080 2815 usage->nspaces--;
2816
2817 /* Call the solver recursively. Stop when we find a solution. */
47f2338e 2818 if (gridgen_real(usage, grid, steps)) {
ab362080 2819 ret = TRUE;
47f2338e 2820 break;
2821 }
ab362080 2822
2823 /* Revert the usage structure. */
ad599e2b 2824 gridgen_remove(usage, sx, sy, n);
ab362080 2825 usage->nspaces++;
ab362080 2826 }
2827
2828 sfree(digits);
2829 return ret;
2830}
2831
2832/*
fbd0fc79 2833 * Entry point to generator. You give it parameters and a starting
ab362080 2834 * grid, which is simply an array of cr*cr digits.
2835 */
ad599e2b 2836static int gridgen(int cr, struct block_structure *blocks,
2837 struct block_structure *kblocks, int xtype,
47f2338e 2838 digit *grid, random_state *rs, int maxsteps)
ab362080 2839{
2840 struct gridgen_usage *usage;
fbd0fc79 2841 int x, y, ret;
ab362080 2842
2843 /*
2844 * Clear the grid to start with.
2845 */
2846 memset(grid, 0, cr*cr);
2847
2848 /*
2849 * Create a gridgen_usage structure.
2850 */
2851 usage = snew(struct gridgen_usage);
2852
ab362080 2853 usage->cr = cr;
fbd0fc79 2854 usage->blocks = blocks;
ab362080 2855
47f2338e 2856 usage->grid = grid;
ab362080 2857
ad599e2b 2858 usage->row = snewn(cr, unsigned int);
2859 usage->col = snewn(cr, unsigned int);
2860 usage->blk = snewn(cr, unsigned int);
2861 if (kblocks != NULL) {
2862 usage->kblocks = kblocks;
2863 usage->cge = snewn(usage->kblocks->nr_blocks, unsigned int);
2864 memset(usage->cge, FALSE, kblocks->nr_blocks * sizeof *usage->cge);
2865 } else {
2866 usage->cge = NULL;
2867 }
2868
2869 memset(usage->row, 0, cr * sizeof *usage->row);
2870 memset(usage->col, 0, cr * sizeof *usage->col);
2871 memset(usage->blk, 0, cr * sizeof *usage->blk);
ab362080 2872
fbd0fc79 2873 if (xtype) {
ad599e2b 2874 usage->diag = snewn(2, unsigned int);
2875 memset(usage->diag, 0, 2 * sizeof *usage->diag);
fbd0fc79 2876 } else {
2877 usage->diag = NULL;
2878 }
2879
47f2338e 2880 /*
2881 * Begin by filling in the whole top row with randomly chosen
2882 * numbers. This cannot introduce any bias or restriction on
2883 * the available grids, since we already know those numbers
2884 * are all distinct so all we're doing is choosing their
2885 * labels.
2886 */
2887 for (x = 0; x < cr; x++)
2888 grid[x] = x+1;
2889 shuffle(grid, cr, sizeof(*grid), rs);
2890 for (x = 0; x < cr; x++)
ad599e2b 2891 gridgen_place(usage, x, 0, grid[x]);
47f2338e 2892
ab362080 2893 usage->spaces = snewn(cr * cr, struct gridgen_coord);
2894 usage->nspaces = 0;
2895
2896 usage->rs = rs;
2897
2898 /*
47f2338e 2899 * Initialise the list of grid spaces, taking care to leave
2900 * out the row I've already filled in above.
ab362080 2901 */
47f2338e 2902 for (y = 1; y < cr; y++) {
ab362080 2903 for (x = 0; x < cr; x++) {
2904 usage->spaces[usage->nspaces].x = x;
2905 usage->spaces[usage->nspaces].y = y;
2906 usage->spaces[usage->nspaces].r = random_bits(rs, 31);
2907 usage->nspaces++;
2908 }
2909 }
2910
2911 /*
2912 * Run the real generator function.
2913 */
47f2338e 2914 ret = gridgen_real(usage, grid, &maxsteps);
ab362080 2915
2916 /*
2917 * Clean up the usage structure now we have our answer.
2918 */
2919 sfree(usage->spaces);
ad599e2b 2920 sfree(usage->cge);
ab362080 2921 sfree(usage->blk);
2922 sfree(usage->col);
2923 sfree(usage->row);
ab362080 2924 sfree(usage);
fbd0fc79 2925
2926 return ret;
ab362080 2927}
2928
2929/* ----------------------------------------------------------------------
2930 * End of grid generator code.
1d8e8ad8 2931 */
2932
2933/*
2934 * Check whether a grid contains a valid complete puzzle.
2935 */
fbd0fc79 2936static int check_valid(int cr, struct block_structure *blocks, int xtype,
2937 digit *grid)
1d8e8ad8 2938{
1d8e8ad8 2939 unsigned char *used;
fbd0fc79 2940 int x, y, i, j, n;
1d8e8ad8 2941
2942 used = snewn(cr, unsigned char);
2943
2944 /*
2945 * Check that each row contains precisely one of everything.
2946 */
2947 for (y = 0; y < cr; y++) {
2948 memset(used, FALSE, cr);
2949 for (x = 0; x < cr; x++)
2950 if (grid[y*cr+x] > 0 && grid[y*cr+x] <= cr)
2951 used[grid[y*cr+x]-1] = TRUE;
2952 for (n = 0; n < cr; n++)
2953 if (!used[n]) {
2954 sfree(used);
2955 return FALSE;
2956 }
2957 }
2958
2959 /*
2960 * Check that each column contains precisely one of everything.
2961 */
2962 for (x = 0; x < cr; x++) {
2963 memset(used, FALSE, cr);
2964 for (y = 0; y < cr; y++)
2965 if (grid[y*cr+x] > 0 && grid[y*cr+x] <= cr)
2966 used[grid[y*cr+x]-1] = TRUE;
2967 for (n = 0; n < cr; n++)
2968 if (!used[n]) {
2969 sfree(used);
2970 return FALSE;
2971 }
2972 }
2973
2974 /*
2975 * Check that each block contains precisely one of everything.
2976 */
fbd0fc79 2977 for (i = 0; i < cr; i++) {
2978 memset(used, FALSE, cr);
2979 for (j = 0; j < cr; j++)
2980 if (grid[blocks->blocks[i][j]] > 0 &&
2981 grid[blocks->blocks[i][j]] <= cr)
2982 used[grid[blocks->blocks[i][j]]-1] = TRUE;
2983 for (n = 0; n < cr; n++)
2984 if (!used[n]) {
2985 sfree(used);
2986 return FALSE;
2987 }
1d8e8ad8 2988 }
2989
fbd0fc79 2990 /*
2991 * Check that each diagonal contains precisely one of everything.
2992 */
2993 if (xtype) {
2994 memset(used, FALSE, cr);
2995 for (i = 0; i < cr; i++)
2996 if (grid[diag0(i)] > 0 && grid[diag0(i)] <= cr)
2997 used[grid[diag0(i)]-1] = TRUE;
2998 for (n = 0; n < cr; n++)
2999 if (!used[n]) {
3000 sfree(used);
3001 return FALSE;
3002 }
3003 for (i = 0; i < cr; i++)
3004 if (grid[diag1(i)] > 0 && grid[diag1(i)] <= cr)
3005 used[grid[diag1(i)]-1] = TRUE;
3006 for (n = 0; n < cr; n++)
3007 if (!used[n]) {
3008 sfree(used);
3009 return FALSE;
3010 }
3011 }
3012
3013 sfree(used);
3014 return TRUE;
1d8e8ad8 3015}
3016
ef57b17d 3017static int symmetries(game_params *params, int x, int y, int *output, int s)
3018{
3019 int c = params->c, r = params->r, cr = c*r;
3020 int i = 0;
3021
154bf9b1 3022#define ADD(x,y) (*output++ = (x), *output++ = (y), i++)
3023
3024 ADD(x, y);
ef57b17d 3025
3026 switch (s) {
3027 case SYMM_NONE:
3028 break; /* just x,y is all we need */
ef57b17d 3029 case SYMM_ROT2:
154bf9b1 3030 ADD(cr - 1 - x, cr - 1 - y);
3031 break;
3032 case SYMM_ROT4:
3033 ADD(cr - 1 - y, x);
3034 ADD(y, cr - 1 - x);
3035 ADD(cr - 1 - x, cr - 1 - y);
3036 break;
3037 case SYMM_REF2:
3038 ADD(cr - 1 - x, y);
3039 break;
3040 case SYMM_REF2D:
3041 ADD(y, x);
3042 break;
3043 case SYMM_REF4:
3044 ADD(cr - 1 - x, y);
3045 ADD(x, cr - 1 - y);
3046 ADD(cr - 1 - x, cr - 1 - y);
3047 break;
3048 case SYMM_REF4D:
3049 ADD(y, x);
3050 ADD(cr - 1 - x, cr - 1 - y);
3051 ADD(cr - 1 - y, cr - 1 - x);
3052 break;
3053 case SYMM_REF8:
3054 ADD(cr - 1 - x, y);
3055 ADD(x, cr - 1 - y);
3056 ADD(cr - 1 - x, cr - 1 - y);
3057 ADD(y, x);
3058 ADD(y, cr - 1 - x);
3059 ADD(cr - 1 - y, x);
3060 ADD(cr - 1 - y, cr - 1 - x);
3061 break;
ef57b17d 3062 }
3063
154bf9b1 3064#undef ADD
3065
ef57b17d 3066 return i;
3067}
3068
c566778e 3069static char *encode_solve_move(int cr, digit *grid)
3070{
3071 int i, len;
3072 char *ret, *p, *sep;
3073
3074 /*
3075 * It's surprisingly easy to work out _exactly_ how long this
3076 * string needs to be. To decimal-encode all the numbers from 1
3077 * to n:
3078 *
3079 * - every number has a units digit; total is n.
3080 * - all numbers above 9 have a tens digit; total is max(n-9,0).
3081 * - all numbers above 99 have a hundreds digit; total is max(n-99,0).
3082 * - and so on.
3083 */
3084 len = 0;
3085 for (i = 1; i <= cr; i *= 10)
3086 len += max(cr - i + 1, 0);
3087 len += cr; /* don't forget the commas */
3088 len *= cr; /* there are cr rows of these */
3089
3090 /*
3091 * Now len is one bigger than the total size of the
3092 * comma-separated numbers (because we counted an
3093 * additional leading comma). We need to have a leading S
3094 * and a trailing NUL, so we're off by one in total.
3095 */
3096 len++;
3097
3098 ret = snewn(len, char);
3099 p = ret;
3100 *p++ = 'S';
3101 sep = "";
3102 for (i = 0; i < cr*cr; i++) {
3103 p += sprintf(p, "%s%d", sep, grid[i]);
3104 sep = ",";
3105 }
3106 *p++ = '\0';
3107 assert(p - ret == len);
3108
3109 return ret;
3110}
3220eba4 3111
ad599e2b 3112static void dsf_to_blocks(int *dsf, struct block_structure *blocks,
3113 int min_expected, int max_expected)
3114{
3115 int cr = blocks->c * blocks->r, area = cr * cr;
3116 int i, nb = 0;
3117
3118 for (i = 0; i < area; i++)
3119 blocks->whichblock[i] = -1;
3120 for (i = 0; i < area; i++) {
3121 int j = dsf_canonify(dsf, i);
3122 if (blocks->whichblock[j] < 0)
3123 blocks->whichblock[j] = nb++;
3124 blocks->whichblock[i] = blocks->whichblock[j];
3125 }
3126 assert(nb >= min_expected && nb <= max_expected);
3127 blocks->nr_blocks = nb;
3128}
3129
3130static void make_blocks_from_whichblock(struct block_structure *blocks)
3131{
3132 int i;
3133
3134 for (i = 0; i < blocks->nr_blocks; i++) {
3135 blocks->blocks[i][blocks->max_nr_squares-1] = 0;
3136 blocks->nr_squares[i] = 0;
3137 }
3138 for (i = 0; i < blocks->area; i++) {
3139 int b = blocks->whichblock[i];
3140 int j = blocks->blocks[b][blocks->max_nr_squares-1]++;
3141 assert(j < blocks->max_nr_squares);
3142 blocks->blocks[b][j] = i;
3143 blocks->nr_squares[b]++;
3144 }
3145}
3146
3147static char *encode_block_structure_desc(char *p, struct block_structure *blocks)
3148{
3149 int i, currrun = 0;
3150 int c = blocks->c, r = blocks->r, cr = c * r;
3151
3152 /*
3153 * Encode the block structure. We do this by encoding
3154 * the pattern of dividing lines: first we iterate
3155 * over the cr*(cr-1) internal vertical grid lines in
3156 * ordinary reading order, then over the cr*(cr-1)
3157 * internal horizontal ones in transposed reading
3158 * order.
3159 *
3160 * We encode the number of non-lines between the
3161 * lines; _ means zero (two adjacent divisions), a
3162 * means 1, ..., y means 25, and z means 25 non-lines
3163 * _and no following line_ (so that za means 26, zb 27
3164 * etc).
3165 */
3166 for (i = 0; i <= 2*cr*(cr-1); i++) {
3167 int x, y, p0, p1, edge;
3168
3169 if (i == 2*cr*(cr-1)) {
3170 edge = TRUE; /* terminating virtual edge */
3171 } else {
3172 if (i < cr*(cr-1)) {
3173 y = i/(cr-1);
3174 x = i%(cr-1);
3175 p0 = y*cr+x;
3176 p1 = y*cr+x+1;
3177 } else {
3178 x = i/(cr-1) - cr;
3179 y = i%(cr-1);
3180 p0 = y*cr+x;
3181 p1 = (y+1)*cr+x;
3182 }
3183 edge = (blocks->whichblock[p0] != blocks->whichblock[p1]);
3184 }
3185
3186 if (edge) {
3187 while (currrun > 25)
3188 *p++ = 'z', currrun -= 25;
3189 if (currrun)
3190 *p++ = 'a'-1 + currrun;
3191 else
3192 *p++ = '_';
3193 currrun = 0;
3194 } else
3195 currrun++;
3196 }
3197 return p;
3198}
3199
3200static char *encode_grid(char *desc, digit *grid, int area)
3201{
3202 int run, i;
3203 char *p = desc;
3204
3205 run = 0;
3206 for (i = 0; i <= area; i++) {
3207 int n = (i < area ? grid[i] : -1);
3208
3209 if (!n)
3210 run++;
3211 else {
3212 if (run) {
3213 while (run > 0) {
3214 int c = 'a' - 1 + run;
3215 if (run > 26)
3216 c = 'z';
3217 *p++ = c;
3218 run -= c - ('a' - 1);
3219 }
3220 } else {
3221 /*
3222 * If there's a number in the very top left or
3223 * bottom right, there's no point putting an
3224 * unnecessary _ before or after it.
3225 */
3226 if (p > desc && n > 0)
3227 *p++ = '_';
3228 }
3229 if (n > 0)
3230 p += sprintf(p, "%d", n);
3231 run = 0;
3232 }
3233 }
3234 return p;
3235}
3236
3237/*
3238 * Conservatively stimate the number of characters required for
3239 * encoding a grid of a certain area.
3240 */
3241static int grid_encode_space (int area)
3242{
3243 int t, count;
3244 for (count = 1, t = area; t > 26; t -= 26)
3245 count++;
3246 return count * area;
3247}
3248
3249/*
3250 * Conservatively stimate the number of characters required for
3251 * encoding a given blocks structure.
3252 */
3253static int blocks_encode_space(struct block_structure *blocks)
3254{
3255 int cr = blocks->c * blocks->r, area = cr * cr;
3256 return grid_encode_space(area);
3257}
3258
3259static char *encode_puzzle_desc(game_params *params, digit *grid,
3260 struct block_structure *blocks,
3261 digit *kgrid,
3262 struct block_structure *kblocks)
3263{
3264 int c = params->c, r = params->r, cr = c*r;
3265 int area = cr*cr;
3266 char *p, *desc;
3267 int space;
3268
3269 space = grid_encode_space(area) + 1;
3270 if (r == 1)
3271 space += blocks_encode_space(blocks) + 1;
3272 if (params->killer) {
3273 space += blocks_encode_space(kblocks) + 1;
3274 space += grid_encode_space(area) + 1;
3275 }
3276 desc = snewn(space, char);
3277 p = encode_grid(desc, grid, area);
3278
3279 if (r == 1) {
3280 *p++ = ',';
3281 p = encode_block_structure_desc(p, blocks);
3282 }
3283 if (params->killer) {
3284 *p++ = ',';
3285 p = encode_block_structure_desc(p, kblocks);
3286 *p++ = ',';
3287 p = encode_grid(p, kgrid, area);
3288 }
3289 assert(p - desc < space);
3290 *p++ = '\0';
3291 desc = sresize(desc, p - desc, char);
3292
3293 return desc;
3294}
3295
3296static void merge_blocks(struct block_structure *b, int n1, int n2)
3297{
3298 int i;
3299 /* Move data towards the lower block number. */
3300 if (n2 < n1) {
3301 int t = n2;
3302 n2 = n1;
3303 n1 = t;
3304 }
3305
3306 /* Merge n2 into n1, and move the last block into n2's position. */
3307 for (i = 0; i < b->nr_squares[n2]; i++)
3308 b->whichblock[b->blocks[n2][i]] = n1;
3309 memcpy(b->blocks[n1] + b->nr_squares[n1], b->blocks[n2],
3310 b->nr_squares[n2] * sizeof **b->blocks);
3311 b->nr_squares[n1] += b->nr_squares[n2];
3312
3313 n1 = b->nr_blocks - 1;
3314 if (n2 != n1) {
3315 memcpy(b->blocks[n2], b->blocks[n1],
3316 b->nr_squares[n1] * sizeof **b->blocks);
3317 for (i = 0; i < b->nr_squares[n1]; i++)
3318 b->whichblock[b->blocks[n1][i]] = n2;
3319 b->nr_squares[n2] = b->nr_squares[n1];
3320 }
3321 b->nr_blocks = n1;
3322}
3323
3324static void merge_some_cages(struct block_structure *b, int cr, int area,
3325 digit *grid, random_state *rs)
3326{
3327 do {
3328 /* Find two candidates for merging. */
3329 int i, n1, n2;
3330 int x = 1 + random_bits(rs, 20) % (cr - 2);
3331 int y = 1 + random_bits(rs, 20) % (cr - 2);
3332 int xy = y*cr + x;
3333 int off = random_bits(rs, 1) == 0 ? -1 : 1;
3334 int other = xy;
3335 unsigned int digits_found;
3336
3337 if (random_bits(rs, 1) == 0)
3338 other = xy + off;
3339 else
3340 other = xy + off * cr;
3341 n1 = b->whichblock[xy];
3342 n2 = b->whichblock[other];
3343 if (n1 == n2)
3344 continue;
3345
3346 assert(n1 >= 0 && n2 >= 0 && n1 < b->nr_blocks && n2 < b->nr_blocks);
3347
3348 if (b->nr_squares[n1] + b->nr_squares[n2] > b->max_nr_squares)
3349 continue;
3350
3351 /* Guarantee that the merged cage would still be a region. */
3352 digits_found = 0;
3353 for (i = 0; i < b->nr_squares[n1]; i++)
3354 digits_found |= 1 << grid[b->blocks[n1][i]];
3355 for (i = 0; i < b->nr_squares[n2]; i++)
3356 if (digits_found & (1 << grid[b->blocks[n2][i]]))
3357 break;
3358 if (i != b->nr_squares[n2])
3359 continue;
3360
3361 merge_blocks(b, n1, n2);
3362 break;
3363 } while (1);
3364}
3365
3366static void compute_kclues(struct block_structure *cages, digit *kclues,
3367 digit *grid, int area)
3368{
3369 int i;
3370 memset(kclues, 0, area * sizeof *kclues);
3371 for (i = 0; i < cages->nr_blocks; i++) {
3372 int j, sum = 0;
3373 for (j = 0; j < area; j++)
3374 if (cages->whichblock[j] == i)
3375 sum += grid[j];
3376 for (j = 0; j < area; j++)
3377 if (cages->whichblock[j] == i)
3378 break;
3379 assert (j != area);
3380 kclues[j] = sum;
3381 }
3382}
3383
3384static struct block_structure *gen_killer_cages(int cr, random_state *rs,
3385 int remove_singletons)
3386{
3387 int nr;
3388 int x, y, area = cr * cr;
3389 int n_singletons = 0;
3390 struct block_structure *b = alloc_block_structure (1, cr, area, cr, area);
3391
3392 for (x = 0; x < area; x++)
3393 b->whichblock[x] = -1;
3394 nr = 0;
3395 for (y = 0; y < cr; y++)
3396 for (x = 0; x < cr; x++) {
3397 int rnd;
3398 int xy = y*cr+x;
3399 if (b->whichblock[xy] != -1)
3400 continue;
3401 b->whichblock[xy] = nr;
3402
3403 rnd = random_bits(rs, 4);
3404 if (xy + 1 < area && (rnd >= 4 || (!remove_singletons && rnd >= 1))) {
3405 int xy2 = xy + 1;
3406 if (x + 1 == cr || b->whichblock[xy2] != -1 ||
3407 (xy + cr < area && random_bits(rs, 1) == 0))
3408 xy2 = xy + cr;
3409 if (xy2 >= area)
3410 n_singletons++;
3411 else
3412 b->whichblock[xy2] = nr;
3413 } else
3414 n_singletons++;
3415 nr++;
3416 }
3417
3418 b->nr_blocks = nr;
3419 make_blocks_from_whichblock(b);
3420
3421 for (x = y = 0; x < b->nr_blocks; x++)
3422 if (b->nr_squares[x] == 1)
3423 y++;
3424 assert(y == n_singletons);
3425
3426 if (n_singletons > 0 && remove_singletons) {
3427 int n;
3428 for (n = 0; n < b->nr_blocks;) {
3429 int xy, x, y, xy2, other;
3430 if (b->nr_squares[n] > 1) {
3431 n++;
3432 continue;
3433 }
3434 xy = b->blocks[n][0];
3435 x = xy % cr;
3436 y = xy / cr;
3437 if (xy + 1 == area)
3438 xy2 = xy - 1;
3439 else if (x + 1 < cr && (y + 1 == cr || random_bits(rs, 1) == 0))
3440 xy2 = xy + 1;
3441 else
3442 xy2 = xy + cr;
3443 other = b->whichblock[xy2];
3444
3445 if (b->nr_squares[other] == 1)
3446 n_singletons--;
3447 n_singletons--;
3448 merge_blocks(b, n, other);
3449 if (n < other)
3450 n++;
3451 }
3452 assert(n_singletons == 0);
3453 }
3454 return b;
3455}
3456
1185e3c5 3457static char *new_game_desc(game_params *params, random_state *rs,
c566778e 3458 char **aux, int interactive)
1d8e8ad8 3459{
3460 int c = params->c, r = params->r, cr = c*r;
3461 int area = cr*cr;
ad599e2b 3462 struct block_structure *blocks, *kblocks;
3463 digit *grid, *grid2, *kgrid;
1d8e8ad8 3464 struct xy { int x, y; } *locs;
3465 int nlocs;
1185e3c5 3466 char *desc;
ef57b17d 3467 int coords[16], ncoords;
1af60e1e 3468 int x, y, i, j;
ad599e2b 3469 struct difficulty dlev;
3470
3471 precompute_sum_bits();
1d8e8ad8 3472
3473 /*
7c568a48 3474 * Adjust the maximum difficulty level to be consistent with
3475 * the puzzle size: all 2x2 puzzles appear to be Trivial
3476 * (DIFF_BLOCK) so we cannot hold out for even a Basic
3477 * (DIFF_SIMPLE) one.
1d8e8ad8 3478 */
ad599e2b 3479 dlev.maxdiff = params->diff;
3480 dlev.maxkdiff = params->kdiff;
7c568a48 3481 if (c == 2 && r == 2)
ad599e2b 3482 dlev.maxdiff = DIFF_BLOCK;
1d8e8ad8 3483
7c568a48 3484 grid = snewn(area, digit);
ef57b17d 3485 locs = snewn(area, struct xy);
1d8e8ad8 3486 grid2 = snewn(area, digit);
1d8e8ad8 3487
ad599e2b 3488 blocks = alloc_block_structure (c, r, area, cr, cr);
3489
3490 if (params->killer) {
3491 kblocks = alloc_block_structure (c, r, area, cr, area);
3492 kgrid = snewn(area, digit);
3493 } else {
3494 kblocks = NULL;
3495 kgrid = NULL;
3496 }
3497
fbd0fc79 3498#ifdef STANDALONE_SOLVER
3499 assert(!"This should never happen, so we don't need to create blocknames");
3500#endif
3501
7c568a48 3502 /*
3503 * Loop until we get a grid of the required difficulty. This is
3504 * nasty, but it seems to be unpleasantly hard to generate
3505 * difficult grids otherwise.
3506 */
fbd0fc79 3507 while (1) {
7c568a48 3508 /*
fbd0fc79 3509 * Generate a random solved state, starting by
3510 * constructing the block structure.
7c568a48 3511 */
fbd0fc79 3512 if (r == 1) { /* jigsaw mode */
3513 int *dsf = divvy_rectangle(cr, cr, cr, rs);
fbd0fc79 3514
ad599e2b 3515 dsf_to_blocks (dsf, blocks, cr, cr);
fbd0fc79 3516
3517 sfree(dsf);
3518 } else { /* basic Sudoku mode */
3519 for (y = 0; y < cr; y++)
3520 for (x = 0; x < cr; x++)
3521 blocks->whichblock[y*cr+x] = (y/c) * c + (x/r);
3522 }
ad599e2b 3523 make_blocks_from_whichblock(blocks);
3524
3525 if (params->killer) {
3526 kblocks = gen_killer_cages(cr, rs, params->kdiff > DIFF_KSINGLE);
fbd0fc79 3527 }
3528
ad599e2b 3529 if (!gridgen(cr, blocks, kblocks, params->xtype, grid, rs, area*area))
47f2338e 3530 continue;
fbd0fc79 3531 assert(check_valid(cr, blocks, params->xtype, grid));
7c568a48 3532
3220eba4 3533 /*
c566778e 3534 * Save the solved grid in aux.
3220eba4 3535 */
3536 {
ab53eb64 3537 /*
3538 * We might already have written *aux the last time we
3539 * went round this loop, in which case we should free
c566778e 3540 * the old aux before overwriting it with the new one.
ab53eb64 3541 */
3542 if (*aux) {
ab53eb64 3543 sfree(*aux);
3544 }
c566778e 3545
3546 *aux = encode_solve_move(cr, grid);
3220eba4 3547 }
3548
ad599e2b 3549 /*
3550 * Now we have a solved grid. For normal puzzles, we start removing
3551 * things from it while preserving solubility. Killer puzzles are
3552 * different: we just pass the empty grid to the solver, and use
3553 * the puzzle if it comes back solved.
3554 */
3555
3556 if (params->killer) {
3557 struct block_structure *good_cages = NULL;
3558 struct block_structure *last_cages = NULL;
3559 int ntries = 0;
3560
3561 memcpy(grid2, grid, area);
3562
3563 for (;;) {
3564 compute_kclues(kblocks, kgrid, grid2, area);
3565
3566 memset(grid, 0, area * sizeof *grid);
3567 solver(cr, blocks, kblocks, params->xtype, grid, kgrid, &dlev);
3568 if (dlev.diff == dlev.maxdiff && dlev.kdiff == dlev.maxkdiff) {
3569 /*
3570 * We have one that matches our difficulty. Store it for
3571 * later, but keep going.
3572 */
3573 if (good_cages)
3574 free_block_structure(good_cages);
3575 ntries = 0;
3576 good_cages = dup_block_structure(kblocks);
3577 merge_some_cages(kblocks, cr, area, grid2, rs);
3578 } else if (dlev.diff > dlev.maxdiff || dlev.kdiff > dlev.maxkdiff) {
3579 /*
3580 * Give up after too many tries and either use the good one we
3581 * found, or generate a new grid.
3582 */
3583 if (++ntries > 50)
3584 break;
3585 /*
3586 * The difficulty level got too high. If we have a good
3587 * one, use it, otherwise go back to the last one that
3588 * was at a lower difficulty and restart the process from
3589 * there.
3590 */
3591 if (good_cages != NULL) {
3592 free_block_structure(kblocks);
3593 kblocks = dup_block_structure(good_cages);
3594 merge_some_cages(kblocks, cr, area, grid2, rs);
3595 } else {
3596 if (last_cages == NULL)
3597 break;
3598 free_block_structure(kblocks);
3599 kblocks = last_cages;
3600 last_cages = NULL;
3601 }
3602 } else {
3603 if (last_cages)
3604 free_block_structure(last_cages);
3605 last_cages = dup_block_structure(kblocks);
3606 merge_some_cages(kblocks, cr, area, grid2, rs);
3607 }
3608 }
3609 if (last_cages)
3610 free_block_structure(last_cages);
3611 if (good_cages != NULL) {
3612 free_block_structure(kblocks);
3613 kblocks = good_cages;
3614 compute_kclues(kblocks, kgrid, grid2, area);
3615 memset(grid, 0, area * sizeof *grid);
3616 break;
3617 }
3618 continue;
3619 }
7c568a48 3620
1af60e1e 3621 /*
3622 * Find the set of equivalence classes of squares permitted
3623 * by the selected symmetry. We do this by enumerating all
3624 * the grid squares which have no symmetric companion
3625 * sorting lower than themselves.
3626 */
3627 nlocs = 0;
3628 for (y = 0; y < cr; y++)
3629 for (x = 0; x < cr; x++) {
3630 int i = y*cr+x;
3631 int j;
7c568a48 3632
1af60e1e 3633 ncoords = symmetries(params, x, y, coords, params->symm);
3634 for (j = 0; j < ncoords; j++)
3635 if (coords[2*j+1]*cr+coords[2*j] < i)
3636 break;
3637 if (j == ncoords) {
154bf9b1 3638 locs[nlocs].x = x;
3639 locs[nlocs].y = y;
3640 nlocs++;
3641 }
3642 }
7c568a48 3643
1af60e1e 3644 /*
3645 * Now shuffle that list.
3646 */
3647 shuffle(locs, nlocs, sizeof(*locs), rs);
de60d8bd 3648
1af60e1e 3649 /*
3650 * Now loop over the shuffled list and, for each element,
3651 * see whether removing that element (and its reflections)
3652 * from the grid will still leave the grid soluble.
3653 */
3654 for (i = 0; i < nlocs; i++) {
1af60e1e 3655 x = locs[i].x;
3656 y = locs[i].y;
7c568a48 3657
1af60e1e 3658 memcpy(grid2, grid, area);
3659 ncoords = symmetries(params, x, y, coords, params->symm);
3660 for (j = 0; j < ncoords; j++)
3661 grid2[coords[2*j+1]*cr+coords[2*j]] = 0;
7c568a48 3662
ad599e2b 3663 solver(cr, blocks, kblocks, params->xtype, grid2, kgrid, &dlev);
3664 if (dlev.diff <= dlev.maxdiff &&
3665 (!params->killer || dlev.kdiff <= dlev.maxkdiff)) {
1af60e1e 3666 for (j = 0; j < ncoords; j++)
3667 grid[coords[2*j+1]*cr+coords[2*j]] = 0;
7c568a48 3668 }
3669 }
1d8e8ad8 3670
7c568a48 3671 memcpy(grid2, grid, area);
ad599e2b 3672
3673 solver(cr, blocks, kblocks, params->xtype, grid2, kgrid, &dlev);
3674 if (dlev.diff == dlev.maxdiff &&
3675 (!params->killer || dlev.kdiff == dlev.maxkdiff))
fbd0fc79 3676 break; /* found one! */
3677 }
1d8e8ad8 3678
1d8e8ad8 3679 sfree(grid2);
3680 sfree(locs);
3681
1d8e8ad8 3682 /*
3683 * Now we have the grid as it will be presented to the user.
1185e3c5 3684 * Encode it in a game desc.
1d8e8ad8 3685 */
ad599e2b 3686 desc = encode_puzzle_desc(params, grid, blocks, kgrid, kblocks);
3687
3688 sfree(grid);
3689
3690 return desc;
3691}
3692
3693static char *spec_to_grid(char *desc, digit *grid, int area)
3694{
3695 int i = 0;
3696 while (*desc && *desc != ',') {
3697 int n = *desc++;
3698 if (n >= 'a' && n <= 'z') {
3699 int run = n - 'a' + 1;
3700 assert(i + run <= area);
3701 while (run-- > 0)
3702 grid[i++] = 0;
3703 } else if (n == '_') {
3704 /* do nothing */;
3705 } else if (n > '0' && n <= '9') {
3706 assert(i < area);
3707 grid[i++] = atoi(desc-1);
3708 while (*desc >= '0' && *desc <= '9')
3709 desc++;
3710 } else {
3711 assert(!"We can't get here");
3712 }
3713 }
3714 assert(i == area);
3715 return desc;
3716}
3717
3718/*
3719 * Create a DSF from a spec found in *pdesc. Update this to point past the
3720 * end of the block spec, and return an error string or NULL if everything
3721 * is OK. The DSF is stored in *PDSF.
3722 */
3723static char *spec_to_dsf(char **pdesc, int **pdsf, int cr, int area)
3724{
3725 char *desc = *pdesc;
3726 int pos = 0;
3727 int *dsf;
3728
3729 *pdsf = dsf = snew_dsf(area);
3730
3731 while (*desc && *desc != ',') {
3732 int c, adv;
3733
3734 if (*desc == '_')
3735 c = 0;
3736 else if (*desc >= 'a' && *desc <= 'z')
3737 c = *desc - 'a' + 1;
3738 else {
3739 sfree(dsf);
3740 return "Invalid character in game description";
1d8e8ad8 3741 }
ad599e2b 3742 desc++;
fbd0fc79 3743
ad599e2b 3744 adv = (c != 25); /* 'z' is a special case */
fbd0fc79 3745
ad599e2b 3746 while (c-- > 0) {
3747 int p0, p1;
fbd0fc79 3748
3749 /*
ad599e2b 3750 * Non-edge; merge the two dsf classes on either
3751 * side of it.
fbd0fc79 3752 */
ad599e2b 3753 assert(pos < 2*cr*(cr-1));
3754 if (pos < cr*(cr-1)) {
3755 int y = pos/(cr-1);
3756 int x = pos%(cr-1);
3757 p0 = y*cr+x;
3758 p1 = y*cr+x+1;
3759 } else {
3760 int x = pos/(cr-1) - cr;
3761 int y = pos%(cr-1);
3762 p0 = y*cr+x;
3763 p1 = (y+1)*cr+x;
fbd0fc79 3764 }
ad599e2b 3765 dsf_merge(dsf, p0, p1);
fbd0fc79 3766
ad599e2b 3767 pos++;
3768 }
3769 if (adv)
3770 pos++;
1d8e8ad8 3771 }
ad599e2b 3772 *pdesc = desc;
1d8e8ad8 3773
ad599e2b 3774 /*
3775 * When desc is exhausted, we expect to have gone exactly
3776 * one space _past_ the end of the grid, due to the dummy
3777 * edge at the end.
3778 */
3779 if (pos != 2*cr*(cr-1)+1) {
3780 sfree(dsf);
3781 return "Not enough data in block structure specification";
3782 }
1d8e8ad8 3783
ad599e2b 3784 return NULL;
1d8e8ad8 3785}
3786
ad599e2b 3787static char *validate_grid_desc(char **pdesc, int range, int area)
1d8e8ad8 3788{
ad599e2b 3789 char *desc = *pdesc;
1d8e8ad8 3790 int squares = 0;
fbd0fc79 3791 while (*desc && *desc != ',') {
1185e3c5 3792 int n = *desc++;
1d8e8ad8 3793 if (n >= 'a' && n <= 'z') {
3794 squares += n - 'a' + 1;
3795 } else if (n == '_') {
3796 /* do nothing */;
3797 } else if (n > '0' && n <= '9') {
d0ed57cd 3798 int val = atoi(desc-1);
ad599e2b 3799 if (val < 1 || val > range)
d0ed57cd 3800 return "Out-of-range number in game description";
1d8e8ad8 3801 squares++;
1185e3c5 3802 while (*desc >= '0' && *desc <= '9')
3803 desc++;
1d8e8ad8 3804 } else
1185e3c5 3805 return "Invalid character in game description";
1d8e8ad8 3806 }
3807
3808 if (squares < area)
3809 return "Not enough data to fill grid";
3810
3811 if (squares > area)
3812 return "Too much data to fit in grid";
ad599e2b 3813 *pdesc = desc;
3814 return NULL;
3815}
1d8e8ad8 3816
ad599e2b 3817static char *validate_block_desc(char **pdesc, int cr, int area,
3818 int min_nr_blocks, int max_nr_blocks,
3819 int min_nr_squares, int max_nr_squares)
3820{
3821 char *err;
3822 int *dsf;
fbd0fc79 3823
ad599e2b 3824 err = spec_to_dsf(pdesc, &dsf, cr, area);
3825 if (err) {
3826 return err;
3827 }
fbd0fc79 3828
ad599e2b 3829 if (min_nr_squares == max_nr_squares) {
3830 assert(min_nr_blocks == max_nr_blocks);
3831 assert(min_nr_blocks * min_nr_squares == area);
3832 }
3833 /*
3834 * Now we've got our dsf. Verify that it matches
3835 * expectations.
3836 */
3837 {
3838 int *canons, *counts;
3839 int i, j, c, ncanons = 0;
fbd0fc79 3840
ad599e2b 3841 canons = snewn(max_nr_blocks, int);
3842 counts = snewn(max_nr_blocks, int);
fbd0fc79 3843
ad599e2b 3844 for (i = 0; i < area; i++) {
3845 j = dsf_canonify(dsf, i);
fbd0fc79 3846
ad599e2b 3847 for (c = 0; c < ncanons; c++)
3848 if (canons[c] == j) {
3849 counts[c]++;
3850 if (counts[c] > max_nr_squares) {
3851 sfree(dsf);
3852 sfree(canons);
3853 sfree(counts);
3854 return "A jigsaw block is too big";
3855 }
3856 break;
3857 }
fbd0fc79 3858
ad599e2b 3859 if (c == ncanons) {
3860 if (ncanons >= max_nr_blocks) {
fbd0fc79 3861 sfree(dsf);
ad599e2b 3862 sfree(canons);
3863 sfree(counts);
3864 return "Too many distinct jigsaw blocks";
fbd0fc79 3865 }
ad599e2b 3866 canons[ncanons] = j;
3867 counts[ncanons] = 1;
3868 ncanons++;
fbd0fc79 3869 }
fbd0fc79 3870 }
3871
ad599e2b 3872 if (ncanons < min_nr_blocks) {
fbd0fc79 3873 sfree(dsf);
ad599e2b 3874 sfree(canons);
3875 sfree(counts);
3876 return "Not enough distinct jigsaw blocks";
fbd0fc79 3877 }
ad599e2b 3878 for (c = 0; c < ncanons; c++) {
3879 if (counts[c] < min_nr_squares) {
3880 sfree(dsf);
3881 sfree(canons);
3882 sfree(counts);
3883 return "A jigsaw block is too small";
3884 }
3885 }
3886 sfree(canons);
3887 sfree(counts);
3888 }
fbd0fc79 3889
ad599e2b 3890 sfree(dsf);
3891 return NULL;
3892}
fbd0fc79 3893
ad599e2b 3894static char *validate_desc(game_params *params, char *desc)
3895{
3896 int cr = params->c * params->r, area = cr*cr;
3897 char *err;
fbd0fc79 3898
ad599e2b 3899 err = validate_grid_desc(&desc, cr, area);
3900 if (err)
3901 return err;
fbd0fc79 3902
ad599e2b 3903 if (params->r == 1) {
3904 /*
3905 * Now we expect a suffix giving the jigsaw block
3906 * structure. Parse it and validate that it divides the
3907 * grid into the right number of regions which are the
3908 * right size.
3909 */
3910 if (*desc != ',')
3911 return "Expected jigsaw block structure in game description";
3912 desc++;
3913 err = validate_block_desc(&desc, cr, area, cr, cr, cr, cr);
3914 if (err)
3915 return err;
fbd0fc79 3916
fbd0fc79 3917 }
ad599e2b 3918 if (params->killer) {
3919 if (*desc != ',')
3920 return "Expected killer block structure in game description";
3921 desc++;
3922 err = validate_block_desc(&desc, cr, area, cr, area, 2, cr);
3923 if (err)
3924 return err;
3925 if (*desc != ',')
3926 return "Expected killer clue grid in game description";
3927 desc++;
3928 err = validate_grid_desc(&desc, cr * area, area);
3929 if (err)
3930 return err;
3931 }
3932 if (*desc)
3933 return "Unexpected data at end of game description";
fbd0fc79 3934
1d8e8ad8 3935 return NULL;
3936}
3937
dafd6cf6 3938static game_state *new_game(midend *me, game_params *params, char *desc)
1d8e8ad8 3939{
3940 game_state *state = snew(game_state);
3941 int c = params->c, r = params->r, cr = c*r, area = cr * cr;
3942 int i;
3943
ad599e2b 3944 precompute_sum_bits();
3945
fbd0fc79 3946 state->cr = cr;
3947 state->xtype = params->xtype;
ad599e2b 3948 state->killer = params->killer;
1d8e8ad8 3949
3950 state->grid = snewn(area, digit);
c8266e03 3951 state->pencil = snewn(area * cr, unsigned char);
3952 memset(state->pencil, 0, area * cr);
1d8e8ad8 3953 state->immutable = snewn(area, unsigned char);
3954 memset(state->immutable, FALSE, area);
3955
ad599e2b 3956 state->blocks = alloc_block_structure (c, r, area, cr, cr);
fbd0fc79 3957
ad599e2b 3958 if (params->killer) {
3959 state->kblocks = alloc_block_structure (c, r, area, cr, area);
3960 state->kgrid = snewn(area, digit);
3961 } else {
3962 state->kblocks = NULL;
3963 state->kgrid = NULL;
3964 }
2ac6d24e 3965 state->completed = state->cheated = FALSE;
1d8e8ad8 3966
ad599e2b 3967 desc = spec_to_grid(desc, state->grid, area);
3968 for (i = 0; i < area; i++)
3969 if (state->grid[i] != 0)
1d8e8ad8 3970 state->immutable[i] = TRUE;
1d8e8ad8 3971
fbd0fc79 3972 if (r == 1) {
ad599e2b 3973 char *err;
fbd0fc79 3974 int *dsf;
fbd0fc79 3975 assert(*desc == ',');
fbd0fc79 3976 desc++;
ad599e2b 3977 err = spec_to_dsf(&desc, &dsf, cr, area);
3978 assert(err == NULL);
3979 dsf_to_blocks(dsf, state->blocks, cr, cr);
fbd0fc79 3980 sfree(dsf);
3981 } else {
3982 int x, y;
3983
fbd0fc79 3984 for (y = 0; y < cr; y++)
3985 for (x = 0; x < cr; x++)
3986 state->blocks->whichblock[y*cr+x] = (y/c) * c + (x/r);
3987 }
ad599e2b 3988 make_blocks_from_whichblock(state->blocks);
fbd0fc79 3989
ad599e2b 3990 if (params->killer) {
3991 char *err;
3992 int *dsf;
3993 assert(*desc == ',');
3994 desc++;
3995 err = spec_to_dsf(&desc, &dsf, cr, area);
3996 assert(err == NULL);
3997 dsf_to_blocks(dsf, state->kblocks, cr, area);
3998 sfree(dsf);
3999 make_blocks_from_whichblock(state->kblocks);
4000
4001 assert(*desc == ',');
4002 desc++;
4003 desc = spec_to_grid(desc, state->kgrid, area);
fbd0fc79 4004 }
ad599e2b 4005 assert(!*desc);
fbd0fc79 4006
4007#ifdef STANDALONE_SOLVER
4008 /*
4009 * Set up the block names for solver diagnostic output.
4010 */
4011 {
4012 char *p = (char *)(state->blocks->blocknames + cr);
4013
4014 if (r == 1) {
fbd0fc79 4015 for (i = 0; i < area; i++) {
4016 int j = state->blocks->whichblock[i];
4017 if (!state->blocks->blocknames[j]) {
4018 state->blocks->blocknames[j] = p;
4019 p += 1 + sprintf(p, "starting at (%d,%d)",
4020 1 + i%cr, 1 + i/cr);
4021 }
4022 }
4023 } else {
4024 int bx, by;
4025 for (by = 0; by < r; by++)
4026 for (bx = 0; bx < c; bx++) {
4027 state->blocks->blocknames[by*c+bx] = p;
4028 p += 1 + sprintf(p, "(%d,%d)", bx+1, by+1);
4029 }
4030 }
b63898fe 4031 assert(p - (char *)state->blocks->blocknames < (int)(cr*(sizeof(char *)+80)));
fbd0fc79 4032 for (i = 0; i < cr; i++)
4033 assert(state->blocks->blocknames[i]);
4034 }
4035#endif
4036
1d8e8ad8 4037 return state;
4038}
4039
4040static game_state *dup_game(game_state *state)
4041{
4042 game_state *ret = snew(game_state);
fbd0fc79 4043 int cr = state->cr, area = cr * cr;
1d8e8ad8 4044
fbd0fc79 4045 ret->cr = state->cr;
4046 ret->xtype = state->xtype;
ad599e2b 4047 ret->killer = state->killer;
fbd0fc79 4048
4049 ret->blocks = state->blocks;
4050 ret->blocks->refcount++;
1d8e8ad8 4051
ad599e2b 4052 ret->kblocks = state->kblocks;
4053 if (ret->kblocks)
4054 ret->kblocks->refcount++;
4055
1d8e8ad8 4056 ret->grid = snewn(area, digit);
4057 memcpy(ret->grid, state->grid, area);
4058
ad599e2b 4059 if (state->killer) {
4060 ret->kgrid = snewn(area, digit);
4061 memcpy(ret->kgrid, state->kgrid, area);
4062 } else
4063 ret->kgrid = NULL;
4064
c8266e03 4065 ret->pencil = snewn(area * cr, unsigned char);
4066 memcpy(ret->pencil, state->pencil, area * cr);
4067
1d8e8ad8 4068 ret->immutable = snewn(area, unsigned char);
4069 memcpy(ret->immutable, state->immutable, area);
4070
4071 ret->completed = state->completed;
2ac6d24e 4072 ret->cheated = state->cheated;
1d8e8ad8 4073
4074 return ret;
4075}
4076
4077static void free_game(game_state *state)
4078{
ad599e2b 4079 free_block_structure(state->blocks);
4080 if (state->kblocks)
4081 free_block_structure(state->kblocks);
4082
1d8e8ad8 4083 sfree(state->immutable);
c8266e03 4084 sfree(state->pencil);
1d8e8ad8 4085 sfree(state->grid);
4086 sfree(state);
4087}
4088
df11cd4e 4089static char *solve_game(game_state *state, game_state *currstate,
c566778e 4090 char *ai, char **error)
2ac6d24e 4091{
fbd0fc79 4092 int cr = state->cr;
c566778e 4093 char *ret;
df11cd4e 4094 digit *grid;
ad599e2b 4095 struct difficulty dlev;
2ac6d24e 4096
3220eba4 4097 /*
c566778e 4098 * If we already have the solution in ai, save ourselves some
4099 * time.
3220eba4 4100 */
c566778e 4101 if (ai)
4102 return dupstr(ai);
3220eba4 4103
c566778e 4104 grid = snewn(cr*cr, digit);
4105 memcpy(grid, state->grid, cr*cr);
ad599e2b 4106 dlev.maxdiff = DIFF_RECURSIVE;
4107 dlev.maxkdiff = DIFF_KINTERSECT;
4108 solver(cr, state->blocks, state->kblocks, state->xtype, grid,
4109 state->kgrid, &dlev);
ab362080 4110
4111 *error = NULL;
df11cd4e 4112
ad599e2b 4113 if (dlev.diff == DIFF_IMPOSSIBLE)
ab362080 4114 *error = "No solution exists for this puzzle";
ad599e2b 4115 else if (dlev.diff == DIFF_AMBIGUOUS)
ab362080 4116 *error = "Multiple solutions exist for this puzzle";
4117
4118 if (*error) {
c566778e 4119 sfree(grid);
c566778e 4120 return NULL;
df11cd4e 4121 }
4122
c566778e 4123 ret = encode_solve_move(cr, grid);
df11cd4e 4124
c566778e 4125 sfree(grid);
2ac6d24e 4126
4127 return ret;
4128}
4129
fbd0fc79 4130static char *grid_text_format(int cr, struct block_structure *blocks,
4131 int xtype, digit *grid)
9b4b03d3 4132{
fbd0fc79 4133 int vmod, hmod;
9b4b03d3 4134 int x, y;
fbd0fc79 4135 int totallen, linelen, nlines;
4136 char *ret, *p, ch;
9b4b03d3 4137
4138 /*
fbd0fc79 4139 * For non-jigsaw Sudoku, we format in the way we always have,
4140 * by having the digits unevenly spaced so that the dividing
4141 * lines can fit in:
4142 *
4143 * . . | . .
4144 * . . | . .
4145 * ----+----
4146 * . . | . .
4147 * . . | . .
4148 *
4149 * For jigsaw puzzles, however, we must leave space between
4150 * _all_ pairs of digits for an optional dividing line, so we
4151 * have to move to the rather ugly
4152 *
4153 * . . . .
4154 * ------+------
4155 * . . | . .
4156 * +---+
4157 * . . | . | .
4158 * ------+ |
4159 * . . . | .
4160 *
4161 * We deal with both cases using the same formatting code; we
4162 * simply invent a vmod value such that there's a vertical
4163 * dividing line before column i iff i is divisible by vmod
4164 * (so it's r in the first case and 1 in the second), and hmod
4165 * likewise for horizontal dividing lines.
9b4b03d3 4166 */
9b4b03d3 4167
fbd0fc79 4168 if (blocks->r != 1) {
4169 vmod = blocks->r;
4170 hmod = blocks->c;
4171 } else {
4172 vmod = hmod = 1;
4173 }
4174
4175 /*
4176 * Line length: we have cr digits, each with a space after it,
4177 * and (cr-1)/vmod dividing lines, each with a space after it.
4178 * The final space is replaced by a newline, but that doesn't
4179 * affect the length.
4180 */
4181 linelen = 2*(cr + (cr-1)/vmod);
4182
4183 /*
4184 * Number of lines: we have cr rows of digits, and (cr-1)/hmod
4185 * dividing rows.
4186 */
4187 nlines = cr + (cr-1)/hmod;
4188
4189 /*
4190 * Allocate the space.
4191 */
4192 totallen = linelen * nlines;
4193 ret = snewn(totallen+1, char); /* leave room for terminating NUL */
4194
4195 /*
4196 * Write the text.
4197 */
4198 p = ret;
9b4b03d3 4199 for (y = 0; y < cr; y++) {
fbd0fc79 4200 /*
4201 * Row of digits.
4202 */
4203 for (x = 0; x < cr; x++) {
4204 /*
4205 * Digit.
4206 */
4207 digit d = grid[y*cr+x];
4208
4209 if (d == 0) {
4210 /*
4211 * Empty space: we usually write a dot, but we'll
4212 * highlight spaces on the X-diagonals (in X mode)
4213 * by using underscores instead.
4214 */
4215 if (xtype && (ondiag0(y*cr+x) || ondiag1(y*cr+x)))
4216 ch = '_';
4217 else
4218 ch = '.';
4219 } else if (d <= 9) {
4220 ch = '0' + d;
4221 } else {
4222 ch = 'a' + d-10;
4223 }
4224
4225 *p++ = ch;
4226 if (x == cr-1) {
4227 *p++ = '\n';
4228 continue;
4229 }
4230 *p++ = ' ';
4231
4232 if ((x+1) % vmod)
4233 continue;
4234
4235 /*
4236 * Optional dividing line.
4237 */
4238 if (blocks->whichblock[y*cr+x] != blocks->whichblock[y*cr+x+1])
4239 ch = '|';
4240 else
4241 ch = ' ';
4242 *p++ = ch;
4243 *p++ = ' ';
4244 }
4245 if (y == cr-1 || (y+1) % hmod)
4246 continue;
4247
4248 /*
4249 * Dividing row.
4250 */
4251 for (x = 0; x < cr; x++) {
4252 int dwid;
4253 int tl, tr, bl, br;
4254
4255 /*
4256 * Division between two squares. This varies
4257 * complicatedly in length.
4258 */
4259 dwid = 2; /* digit and its following space */
4260 if (x == cr-1)
4261 dwid--; /* no following space at end of line */
4262 if (x > 0 && x % vmod == 0)
4263 dwid++; /* preceding space after a divider */
4264
4265 if (blocks->whichblock[y*cr+x] != blocks->whichblock[(y+1)*cr+x])
4266 ch = '-';
4267 else
4268 ch = ' ';
4269
4270 while (dwid-- > 0)
4271 *p++ = ch;
4272
4273 if (x == cr-1) {
4274 *p++ = '\n';
4275 break;
4276 }
4277
4278 if ((x+1) % vmod)
4279 continue;
4280
4281 /*
4282 * Corner square. This is:
4283 * - a space if all four surrounding squares are in
4284 * the same block
4285 * - a vertical line if the two left ones are in one
4286 * block and the two right in another
4287 * - a horizontal line if the two top ones are in one
4288 * block and the two bottom in another
4289 * - a plus sign in all other cases. (If we had a
4290 * richer character set available we could break
4291 * this case up further by doing fun things with
4292 * line-drawing T-pieces.)
4293 */
4294 tl = blocks->whichblock[y*cr+x];
4295 tr = blocks->whichblock[y*cr+x+1];
4296 bl = blocks->whichblock[(y+1)*cr+x];
4297 br = blocks->whichblock[(y+1)*cr+x+1];
4298
4299 if (tl == tr && tr == bl && bl == br)
4300 ch = ' ';
4301 else if (tl == bl && tr == br)
4302 ch = '|';
4303 else if (tl == tr && bl == br)
4304 ch = '-';
4305 else
4306 ch = '+';
4307
4308 *p++ = ch;
4309 }
9b4b03d3 4310 }
4311
fbd0fc79 4312 assert(p - ret == totallen);
9b4b03d3 4313 *p = '\0';
4314 return ret;
4315}
4316
fa3abef5 4317static int game_can_format_as_text_now(game_params *params)
4318{
ad599e2b 4319 /*
4320 * Formatting Killer puzzles as text is currently unsupported. I
4321 * can't think of any sensible way of doing it which doesn't
4322 * involve expanding the puzzle to such a large scale as to make
4323 * it unusable.
4324 */
4325 if (params->killer)
4326 return FALSE;
fa3abef5 4327 return TRUE;
4328}
4329
9b4b03d3 4330static char *game_text_format(game_state *state)
4331{
ad599e2b 4332 assert(!state->kblocks);
fbd0fc79 4333 return grid_text_format(state->cr, state->blocks, state->xtype,
4334 state->grid);
9b4b03d3 4335}
4336
1d8e8ad8 4337struct game_ui {
4338 /*
4339 * These are the coordinates of the currently highlighted
b63898fe 4340 * square on the grid, if hshow = 1.
1d8e8ad8 4341 */
4342 int hx, hy;
c8266e03 4343 /*
4344 * This indicates whether the current highlight is a
4345 * pencil-mark one or a real one.
4346 */
4347 int hpencil;
b63898fe 4348 /*
4349 * This indicates whether or not we're showing the highlight
4350 * (used to be hx = hy = -1); important so that when we're
4351 * using the cursor keys it doesn't keep coming back at a
4352 * fixed position. When hshow = 1, pressing a valid number
4353 * or letter key or Space will enter that number or letter in the grid.
4354 */
4355 int hshow;
4356 /*
4357 * This indicates whether we're using the highlight as a cursor;
4358 * it means that it doesn't vanish on a keypress, and that it is
4359 * allowed on immutable squares.
4360 */
4361 int hcursor;
1d8e8ad8 4362};
4363
4364static game_ui *new_ui(game_state *state)
4365{
4366 game_ui *ui = snew(game_ui);
4367
b63898fe 4368 ui->hx = ui->hy = 0;
4369 ui->hpencil = ui->hshow = ui->hcursor = 0;
1d8e8ad8 4370
4371 return ui;
4372}
4373
4374static void free_ui(game_ui *ui)
4375{
4376 sfree(ui);
4377}
4378
844f605f 4379static char *encode_ui(game_ui *ui)
ae8290c6 4380{
4381 return NULL;
4382}
4383
844f605f 4384static void decode_ui(game_ui *ui, char *encoding)
ae8290c6 4385{
4386}
4387
07dfb697 4388static void game_changed_state(game_ui *ui, game_state *oldstate,
4389 game_state *newstate)
4390{
fbd0fc79 4391 int cr = newstate->cr;
07dfb697 4392 /*
b63898fe 4393 * We prevent pencil-mode highlighting of a filled square, unless
4394 * we're using the cursor keys. So if the user has just filled in
4395 * a square which we had a pencil-mode highlight in (by Undo, or
4396 * by Redo, or by Solve), then we cancel the highlight.
07dfb697 4397 */
b63898fe 4398 if (ui->hshow && ui->hpencil && !ui->hcursor &&
07dfb697 4399 newstate->grid[ui->hy * cr + ui->hx] != 0) {
b63898fe 4400 ui->hshow = 0;
07dfb697 4401 }
4402}
4403
1e3e152d 4404struct game_drawstate {
4405 int started;
fbd0fc79 4406 int cr, xtype;
1e3e152d 4407 int tilesize;
4408 digit *grid;
4409 unsigned char *pencil;
4410 unsigned char *hl;
4411 /* This is scratch space used within a single call to game_redraw. */
4412 int *entered_items;
4413};
4414
df11cd4e 4415static char *interpret_move(game_state *state, game_ui *ui, game_drawstate *ds,
4416 int x, int y, int button)
1d8e8ad8 4417{
fbd0fc79 4418 int cr = state->cr;
1d8e8ad8 4419 int tx, ty;
df11cd4e 4420 char buf[80];
1d8e8ad8 4421
f0ee053c 4422 button &= ~MOD_MASK;
3c833d45 4423
ae812854 4424 tx = (x + TILE_SIZE - BORDER) / TILE_SIZE - 1;
4425 ty = (y + TILE_SIZE - BORDER) / TILE_SIZE - 1;
1d8e8ad8 4426
39d682c9 4427 if (tx >= 0 && tx < cr && ty >= 0 && ty < cr) {
4428 if (button == LEFT_BUTTON) {
df11cd4e 4429 if (state->immutable[ty*cr+tx]) {
b63898fe 4430 ui->hshow = 0;
4431 } else if (tx == ui->hx && ty == ui->hy &&
4432 ui->hshow && ui->hpencil == 0) {
4433 ui->hshow = 0;
39d682c9 4434 } else {
4435 ui->hx = tx;
4436 ui->hy = ty;
b63898fe 4437 ui->hshow = 1;
39d682c9 4438 ui->hpencil = 0;
4439 }
b63898fe 4440 ui->hcursor = 0;
df11cd4e 4441 return ""; /* UI activity occurred */
39d682c9 4442 }
4443 if (button == RIGHT_BUTTON) {
4444 /*
4445 * Pencil-mode highlighting for non filled squares.
4446 */
df11cd4e 4447 if (state->grid[ty*cr+tx] == 0) {
b63898fe 4448 if (tx == ui->hx && ty == ui->hy &&
4449 ui->hshow && ui->hpencil) {
4450 ui->hshow = 0;
39d682c9 4451 } else {
4452 ui->hpencil = 1;
4453 ui->hx = tx;
4454 ui->hy = ty;
b63898fe 4455 ui->hshow = 1;
39d682c9 4456 }
4457 } else {
b63898fe 4458 ui->hshow = 0;
39d682c9 4459 }
b63898fe 4460 ui->hcursor = 0;
df11cd4e 4461 return ""; /* UI activity occurred */
39d682c9 4462 }
1d8e8ad8 4463 }
b63898fe 4464 if (IS_CURSOR_MOVE(button)) {
4465 move_cursor(button, &ui->hx, &ui->hy, cr, cr, 0);
4466 ui->hshow = ui->hcursor = 1;
4467 return "";
4468 }
4469 if (ui->hshow &&
4470 (button == CURSOR_SELECT)) {
4471 ui->hpencil = 1 - ui->hpencil;
4472 ui->hcursor = 1;
4473 return "";
4474 }
1d8e8ad8 4475
b63898fe 4476 if (ui->hshow &&
4477 ((button >= '0' && button <= '9' && button - '0' <= cr) ||
1d8e8ad8 4478 (button >= 'a' && button <= 'z' && button - 'a' + 10 <= cr) ||
4479 (button >= 'A' && button <= 'Z' && button - 'A' + 10 <= cr) ||
b63898fe 4480 button == CURSOR_SELECT2 || button == '\010' || button == '\177')) {
1d8e8ad8 4481 int n = button - '0';
4482 if (button >= 'A' && button <= 'Z')
4483 n = button - 'A' + 10;
4484 if (button >= 'a' && button <= 'z')
4485 n = button - 'a' + 10;
b63898fe 4486 if (button == CURSOR_SELECT2 || button == '\010' || button == '\177')
1d8e8ad8 4487 n = 0;
4488
39d682c9 4489 /*
b63898fe 4490 * Can't overwrite this square. This can only happen here
4491 * if we're using the cursor keys.
39d682c9 4492 */
df11cd4e 4493 if (state->immutable[ui->hy*cr+ui->hx])
39d682c9 4494 return NULL;
1d8e8ad8 4495
c8266e03 4496 /*
b63898fe 4497 * Can't make pencil marks in a filled square. Again, this
4498 * can only become highlighted if we're using cursor keys.
c8266e03 4499 */
df11cd4e 4500 if (ui->hpencil && state->grid[ui->hy*cr+ui->hx])
c8266e03 4501 return NULL;
4502
df11cd4e 4503 sprintf(buf, "%c%d,%d,%d",
871bf294 4504 (char)(ui->hpencil && n > 0 ? 'P' : 'R'), ui->hx, ui->hy, n);
df11cd4e 4505
b63898fe 4506 if (!ui->hcursor) ui->hshow = 0;
df11cd4e 4507
4508 return dupstr(buf);
4509 }
4510
4511 return NULL;
4512}
4513
4514static game_state *execute_move(game_state *from, char *move)
4515{
fbd0fc79 4516 int cr = from->cr;
df11cd4e 4517 game_state *ret;
4518 int x, y, n;
4519
4520 if (move[0] == 'S') {
4521 char *p;
4522
1d8e8ad8 4523 ret = dup_game(from);
df11cd4e 4524 ret->completed = ret->cheated = TRUE;
4525
4526 p = move+1;
4527 for (n = 0; n < cr*cr; n++) {
4528 ret->grid[n] = atoi(p);
4529
4530 if (!*p || ret->grid[n] < 1 || ret->grid[n] > cr) {
4531 free_game(ret);
4532 return NULL;
4533 }
4534
4535 while (*p && isdigit((unsigned char)*p)) p++;
4536 if (*p == ',') p++;
4537 }
4538
4539 return ret;
4540 } else if ((move[0] == 'P' || move[0] == 'R') &&
4541 sscanf(move+1, "%d,%d,%d", &x, &y, &n) == 3 &&
4542 x >= 0 && x < cr && y >= 0 && y < cr && n >= 0 && n <= cr) {
4543
4544 ret = dup_game(from);
4545 if (move[0] == 'P' && n > 0) {
4546 int index = (y*cr+x) * cr + (n-1);
c8266e03 4547 ret->pencil[index] = !ret->pencil[index];
4548 } else {
df11cd4e 4549 ret->grid[y*cr+x] = n;
4550 memset(ret->pencil + (y*cr+x)*cr, 0, cr);
1d8e8ad8 4551
c8266e03 4552 /*
4553 * We've made a real change to the grid. Check to see
4554 * if the game has been completed.
4555 */
fbd0fc79 4556 if (!ret->completed && check_valid(cr, ret->blocks, ret->xtype,
4557 ret->grid)) {
c8266e03 4558 ret->completed = TRUE;
4559 }
4560 }
df11cd4e 4561 return ret;
4562 } else
4563 return NULL; /* couldn't parse move string */
1d8e8ad8 4564}
4565
4566/* ----------------------------------------------------------------------
4567 * Drawing routines.
4568 */
4569
1e3e152d 4570#define SIZE(cr) ((cr) * TILE_SIZE + 2*BORDER + 1)
871bf294 4571#define GETTILESIZE(cr, w) ( (double)(w-1) / (double)(cr+1) )
1d8e8ad8 4572
1f3ee4ee 4573static void game_compute_size(game_params *params, int tilesize,
4574 int *x, int *y)
1d8e8ad8 4575{
1f3ee4ee 4576 /* Ick: fake up `ds->tilesize' for macro expansion purposes */
4577 struct { int tilesize; } ads, *ds = &ads;
4578 ads.tilesize = tilesize;
1e3e152d 4579
1f3ee4ee 4580 *x = SIZE(params->c * params->r);
4581 *y = SIZE(params->c * params->r);
4582}
1d8e8ad8 4583
dafd6cf6 4584static void game_set_size(drawing *dr, game_drawstate *ds,
4585 game_params *params, int tilesize)
1f3ee4ee 4586{
4587 ds->tilesize = tilesize;
1d8e8ad8 4588}
4589
8266f3fc 4590static float *game_colours(frontend *fe, int *ncolours)
1d8e8ad8 4591{
4592 float *ret = snewn(3 * NCOLOURS, float);
4593
4594 frontend_default_colour(fe, &ret[COL_BACKGROUND * 3]);
4595
fbd0fc79 4596 ret[COL_XDIAGONALS * 3 + 0] = 0.9F * ret[COL_BACKGROUND * 3 + 0];
4597 ret[COL_XDIAGONALS * 3 + 1] = 0.9F * ret[COL_BACKGROUND * 3 + 1];
4598 ret[COL_XDIAGONALS * 3 + 2] = 0.9F * ret[COL_BACKGROUND * 3 + 2];
4599
1d8e8ad8 4600 ret[COL_GRID * 3 + 0] = 0.0F;
4601 ret[COL_GRID * 3 + 1] = 0.0F;
4602 ret[COL_GRID * 3 + 2] = 0.0F;
4603
4604 ret[COL_CLUE * 3 + 0] = 0.0F;
4605 ret[COL_CLUE * 3 + 1] = 0.0F;
4606 ret[COL_CLUE * 3 + 2] = 0.0F;
4607
4608 ret[COL_USER * 3 + 0] = 0.0F;
4609 ret[COL_USER * 3 + 1] = 0.6F * ret[COL_BACKGROUND * 3 + 1];
4610 ret[COL_USER * 3 + 2] = 0.0F;
4611
fbd0fc79 4612 ret[COL_HIGHLIGHT * 3 + 0] = 0.78F * ret[COL_BACKGROUND * 3 + 0];
4613 ret[COL_HIGHLIGHT * 3 + 1] = 0.78F * ret[COL_BACKGROUND * 3 + 1];
4614 ret[COL_HIGHLIGHT * 3 + 2] = 0.78F * ret[COL_BACKGROUND * 3 + 2];
1d8e8ad8 4615
7b14a9ec 4616 ret[COL_ERROR * 3 + 0] = 1.0F;
4617 ret[COL_ERROR * 3 + 1] = 0.0F;
4618 ret[COL_ERROR * 3 + 2] = 0.0F;
4619
c8266e03 4620 ret[COL_PENCIL * 3 + 0] = 0.5F * ret[COL_BACKGROUND * 3 + 0];
4621 ret[COL_PENCIL * 3 + 1] = 0.5F * ret[COL_BACKGROUND * 3 + 1];
4622 ret[COL_PENCIL * 3 + 2] = ret[COL_BACKGROUND * 3 + 2];
4623
ad599e2b 4624 ret[COL_KILLER * 3 + 0] = 0.5F * ret[COL_BACKGROUND * 3 + 0];
4625 ret[COL_KILLER * 3 + 1] = 0.5F * ret[COL_BACKGROUND * 3 + 1];
4626 ret[COL_KILLER * 3 + 2] = 0.1F * ret[COL_BACKGROUND * 3 + 2];
4627
1d8e8ad8 4628 *ncolours = NCOLOURS;
4629 return ret;
4630}
4631
dafd6cf6 4632static game_drawstate *game_new_drawstate(drawing *dr, game_state *state)
1d8e8ad8 4633{
4634 struct game_drawstate *ds = snew(struct game_drawstate);
fbd0fc79 4635 int cr = state->cr;
1d8e8ad8 4636
4637 ds->started = FALSE;
1d8e8ad8 4638 ds->cr = cr;
fbd0fc79 4639 ds->xtype = state->xtype;
1d8e8ad8 4640 ds->grid = snewn(cr*cr, digit);
fbd0fc79 4641 memset(ds->grid, cr+2, cr*cr);
c8266e03 4642 ds->pencil = snewn(cr*cr*cr, digit);
4643 memset(ds->pencil, 0, cr*cr*cr);
1d8e8ad8 4644 ds->hl = snewn(cr*cr, unsigned char);
4645 memset(ds->hl, 0, cr*cr);
b71dd7fc 4646 ds->entered_items = snewn(cr*cr, int);
1e3e152d 4647 ds->tilesize = 0; /* not decided yet */
1d8e8ad8 4648 return ds;
4649}
4650
dafd6cf6 4651static void game_free_drawstate(drawing *dr, game_drawstate *ds)
1d8e8ad8 4652{
4653 sfree(ds->hl);
c8266e03 4654 sfree(ds->pencil);
1d8e8ad8 4655 sfree(ds->grid);
b71dd7fc 4656 sfree(ds->entered_items);
1d8e8ad8 4657 sfree(ds);
4658}
4659
dafd6cf6 4660static void draw_number(drawing *dr, game_drawstate *ds, game_state *state,
1d8e8ad8 4661 int x, int y, int hl)
4662{
fbd0fc79 4663 int cr = state->cr;
ad599e2b 4664 int tx, ty, tw, th;
1d8e8ad8 4665 int cx, cy, cw, ch;
ad599e2b 4666 int col_killer = (hl & 32 ? COL_ERROR : COL_KILLER);
4667 char str[20];
1d8e8ad8 4668
c8266e03 4669 if (ds->grid[y*cr+x] == state->grid[y*cr+x] &&
4670 ds->hl[y*cr+x] == hl &&
4671 !memcmp(ds->pencil+(y*cr+x)*cr, state->pencil+(y*cr+x)*cr, cr))
1d8e8ad8 4672 return; /* no change required */
4673
fbd0fc79 4674 tx = BORDER + x * TILE_SIZE + 1 + GRIDEXTRA;
4675 ty = BORDER + y * TILE_SIZE + 1 + GRIDEXTRA;
1d8e8ad8 4676
4677 cx = tx;
4678 cy = ty;
ad599e2b 4679 cw = tw = TILE_SIZE-1-2*GRIDEXTRA;
4680 ch = th = TILE_SIZE-1-2*GRIDEXTRA;
fbd0fc79 4681
4682 if (x > 0 && state->blocks->whichblock[y*cr+x] == state->blocks->whichblock[y*cr+x-1])
4683 cx -= GRIDEXTRA, cw += GRIDEXTRA;
4684 if (x+1 < cr && state->blocks->whichblock[y*cr+x] == state->blocks->whichblock[y*cr+x+1])
4685 cw += GRIDEXTRA;
4686 if (y > 0 && state->blocks->whichblock[y*cr+x] == state->blocks->whichblock[(y-1)*cr+x])
4687 cy -= GRIDEXTRA, ch += GRIDEXTRA;
4688 if (y+1 < cr && state->blocks->whichblock[y*cr+x] == state->blocks->whichblock[(y+1)*cr+x])
4689 ch += GRIDEXTRA;
1d8e8ad8 4690
dafd6cf6 4691 clip(dr, cx, cy, cw, ch);
1d8e8ad8 4692
c8266e03 4693 /* background needs erasing */
fbd0fc79 4694 draw_rect(dr, cx, cy, cw, ch,
4695 ((hl & 15) == 1 ? COL_HIGHLIGHT :
4696 (ds->xtype && (ondiag0(y*cr+x) || ondiag1(y*cr+x))) ? COL_XDIAGONALS :
4697 COL_BACKGROUND));
4698
4699 /*
4700 * Draw the corners of thick lines in corner-adjacent squares,
4701 * which jut into this square by one pixel.
4702 */
4703 if (x > 0 && y > 0 && state->blocks->whichblock[y*cr+x] != state->blocks->whichblock[(y-1)*cr+x-1])
4704 draw_rect(dr, tx-GRIDEXTRA, ty-GRIDEXTRA, GRIDEXTRA, GRIDEXTRA, COL_GRID);
4705 if (x+1 < cr && y > 0 && state->blocks->whichblock[y*cr+x] != state->blocks->whichblock[(y-1)*cr+x+1])
4706 draw_rect(dr, tx+TILE_SIZE-1-2*GRIDEXTRA, ty-GRIDEXTRA, GRIDEXTRA, GRIDEXTRA, COL_GRID);
4707 if (x > 0 && y+1 < cr && state->blocks->whichblock[y*cr+x] != state->blocks->whichblock[(y+1)*cr+x-1])
4708 draw_rect(dr, tx-GRIDEXTRA, ty+TILE_SIZE-1-2*GRIDEXTRA, GRIDEXTRA, GRIDEXTRA, COL_GRID);
4709 if (x+1 < cr && y+1 < cr && state->blocks->whichblock[y*cr+x] != state->blocks->whichblock[(y+1)*cr+x+1])
4710 draw_rect(dr, tx+TILE_SIZE-1-2*GRIDEXTRA, ty+TILE_SIZE-1-2*GRIDEXTRA, GRIDEXTRA, GRIDEXTRA, COL_GRID);
c8266e03 4711
4712 /* pencil-mode highlight */
7b14a9ec 4713 if ((hl & 15) == 2) {
c8266e03 4714 int coords[6];
4715 coords[0] = cx;
4716 coords[1] = cy;
4717 coords[2] = cx+cw/2;
4718 coords[3] = cy;
4719 coords[4] = cx;
4720 coords[5] = cy+ch/2;
dafd6cf6 4721 draw_polygon(dr, coords, 3, COL_HIGHLIGHT, COL_HIGHLIGHT);
c8266e03 4722 }
1d8e8ad8 4723
ad599e2b 4724 if (state->kblocks) {
4725 int t = GRIDEXTRA * 3;
d3cc1ab0 4726 int kcx, kcy, kcw, kch;
4727 int kl, kt, kr, kb;
ad599e2b 4728 int has_left = 0, has_right = 0, has_top = 0, has_bottom = 0;
4729
4730 /*
d3cc1ab0 4731 * In non-jigsaw mode, the Killer cages are placed at a
4732 * fixed offset from the outer edge of the cell dividing
4733 * lines, so that they look right whether those lines are
4734 * thick or thin. In jigsaw mode, however, doing this will
4735 * sometimes cause the cage outlines in adjacent squares to
4736 * fail to match up with each other, so we must offset a
4737 * fixed amount from the _centre_ of the cell dividing
4738 * lines.
4739 */
4740 if (state->blocks->r == 1) {
4741 kcx = tx;
4742 kcy = ty;
4743 kcw = tw;
4744 kch = th;
4745 } else {
4746 kcx = cx;
4747 kcy = cy;
4748 kcw = cw;
4749 kch = ch;
4750 }
4751 kl = kcx - 1;
4752 kt = kcy - 1;
4753 kr = kcx + kcw;
4754 kb = kcy + kch;
4755
4756 /*
ad599e2b 4757 * First, draw the lines dividing this area from neighbouring
4758 * different areas.
4759 */
4760 if (x == 0 || state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[y*cr+x-1])
4761 has_left = 1, kl += t;
4762 if (x+1 >= cr || state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[y*cr+x+1])
4763 has_right = 1, kr -= t;
4764 if (y == 0 || state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[(y-1)*cr+x])
4765 has_top = 1, kt += t;
4766 if (y+1 >= cr || state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[(y+1)*cr+x])
4767 has_bottom = 1, kb -= t;
4768 if (has_top)
4769 draw_line(dr, kl, kt, kr, kt, col_killer);
4770 if (has_bottom)
4771 draw_line(dr, kl, kb, kr, kb, col_killer);
4772 if (has_left)
4773 draw_line(dr, kl, kt, kl, kb, col_killer);
4774 if (has_right)
4775 draw_line(dr, kr, kt, kr, kb, col_killer);
4776 /*
4777 * Now, take care of the corners (just as for the normal borders).
4778 * We only need a corner if there wasn't a full edge.
4779 */
4780 if (x > 0 && y > 0 && !has_left && !has_top
4781 && state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[(y-1)*cr+x-1])
4782 {
4783 draw_line(dr, kl, kt + t, kl + t, kt + t, col_killer);
4784 draw_line(dr, kl + t, kt, kl + t, kt + t, col_killer);
4785 }
4786 if (x+1 < cr && y > 0 && !has_right && !has_top
4787 && state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[(y-1)*cr+x+1])
4788 {
d3cc1ab0 4789 draw_line(dr, kcx + kcw - t, kt + t, kcx + kcw, kt + t, col_killer);
4790 draw_line(dr, kcx + kcw - t, kt, kcx + kcw - t, kt + t, col_killer);
ad599e2b 4791 }
4792 if (x > 0 && y+1 < cr && !has_left && !has_bottom
4793 && state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[(y+1)*cr+x-1])
4794 {
d3cc1ab0 4795 draw_line(dr, kl, kcy + kch - t, kl + t, kcy + kch - t, col_killer);
4796 draw_line(dr, kl + t, kcy + kch - t, kl + t, kcy + kch, col_killer);
ad599e2b 4797 }
4798 if (x+1 < cr && y+1 < cr && !has_right && !has_bottom
4799 && state->kblocks->whichblock[y*cr+x] != state->kblocks->whichblock[(y+1)*cr+x+1])
4800 {
d3cc1ab0 4801 draw_line(dr, kcx + kcw - t, kcy + kch - t, kcx + kcw - t, kcy + kch, col_killer);
4802 draw_line(dr, kcx + kcw - t, kcy + kch - t, kcx + kcw, kcy + kch - t, col_killer);
ad599e2b 4803 }
4804
4805 }
4806
4807 if (state->killer && state->kgrid[y*cr+x]) {
4808 sprintf (str, "%d", state->kgrid[y*cr+x]);
4809 draw_text(dr, tx + GRIDEXTRA * 4, ty + GRIDEXTRA * 4 + TILE_SIZE/4,
4810 FONT_VARIABLE, TILE_SIZE/4, ALIGN_VNORMAL | ALIGN_HLEFT,
4811 col_killer, str);
4812 }
4813
1d8e8ad8 4814 /* new number needs drawing? */
4815 if (state->grid[y*cr+x]) {
4816 str[1] = '\0';
4817 str[0] = state->grid[y*cr+x] + '0';
4818 if (str[0] > '9')
4819 str[0] += 'a' - ('9'+1);
dafd6cf6 4820 draw_text(dr, tx + TILE_SIZE/2, ty + TILE_SIZE/2,
1d8e8ad8 4821 FONT_VARIABLE, TILE_SIZE/2, ALIGN_VCENTRE | ALIGN_HCENTRE,
7b14a9ec 4822 state->immutable[y*cr+x] ? COL_CLUE : (hl & 16) ? COL_ERROR : COL_USER, str);
c8266e03 4823 } else {
edf63745 4824 int i, j, npencil;
ad599e2b 4825 int pl, pr, pt, pb;
4826 float bestsize;
4827 int pw, ph, minph, pbest, fontsize;
edf63745 4828
ad599e2b 4829 /* Count the pencil marks required. */
edf63745 4830 for (i = npencil = 0; i < cr; i++)
4831 if (state->pencil[(y*cr+x)*cr+i])
4832 npencil++;
ad599e2b 4833 if (npencil) {
edf63745 4834
ad599e2b 4835 minph = 2;
4836
4837 /*
4838 * Determine the bounding rectangle within which we're going
4839 * to put the pencil marks.
4840 */
4841 /* Start with the whole square */
4842 pl = tx + GRIDEXTRA;
4843 pr = pl + TILE_SIZE - GRIDEXTRA;
4844 pt = ty + GRIDEXTRA;
4845 pb = pt + TILE_SIZE - GRIDEXTRA;
4846 if (state->killer) {
4847 /*
4848 * Make space for the Killer cages. We do this
4849 * unconditionally, for uniformity between squares,
4850 * rather than making it depend on whether a Killer
4851 * cage edge is actually present on any given side.
4852 */
4853 pl += GRIDEXTRA * 3;
4854 pr -= GRIDEXTRA * 3;
4855 pt += GRIDEXTRA * 3;
4856 pb -= GRIDEXTRA * 3;
4857 if (state->kgrid[y*cr+x] != 0) {
4858 /* Make further space for the Killer number. */
4859 pt += TILE_SIZE/4;
4860 /* minph--; */
4861 }
4862 }
4863
4864 /*
4865 * We arrange our pencil marks in a grid layout, with
4866 * the number of rows and columns adjusted to allow the
4867 * maximum font size.
4868 *
4869 * So now we work out what the grid size ought to be.
4870 */
4871 bestsize = 0.0;
4872 pbest = 0;
4873 /* Minimum */
4874 for (pw = 3; pw < max(npencil,4); pw++) {
4875 float fw, fh, fs;
4876
4877 ph = (npencil + pw - 1) / pw;
4878 ph = max(ph, minph);
4879 fw = (pr - pl) / (float)pw;
4880 fh = (pb - pt) / (float)ph;
4881 fs = min(fw, fh);
4882 if (fs > bestsize) {
4883 bestsize = fs;
4884 pbest = pw;
4885 }
4886 }
4887 assert(pbest > 0);
4888 pw = pbest;
4889 ph = (npencil + pw - 1) / pw;
4890 ph = max(ph, minph);
4891
4892 /*
4893 * Now we've got our grid dimensions, work out the pixel
4894 * size of a grid element, and round it to the nearest
4895 * pixel. (We don't want rounding errors to make the
4896 * grid look uneven at low pixel sizes.)
4897 */
4898 fontsize = min((pr - pl) / pw, (pb - pt) / ph);
4899
4900 /*
4901 * Centre the resulting figure in the square.
4902 */
4903 pl = tx + (TILE_SIZE - fontsize * pw) / 2;
4904 pt = ty + (TILE_SIZE - fontsize * ph) / 2;
4905
4906 /*
4907 * And move it down a bit if it's collided with the
4908 * Killer cage number.
4909 */
4910 if (state->killer && state->kgrid[y*cr+x] != 0) {
4911 pt = max(pt, ty + GRIDEXTRA * 3 + TILE_SIZE/4);
4912 }
4913
4914 /*
4915 * Now actually draw the pencil marks.
4916 */
4917 for (i = j = 0; i < cr; i++)
4918 if (state->pencil[(y*cr+x)*cr+i]) {
4919 int dx = j % pw, dy = j / pw;
4920
4921 str[1] = '\0';
4922 str[0] = i + '1';
4923 if (str[0] > '9')
4924 str[0] += 'a' - ('9'+1);
4925 draw_text(dr, pl + fontsize * (2*dx+1) / 2,
4926 pt + fontsize * (2*dy+1) / 2,
4927 FONT_VARIABLE, fontsize,
4928 ALIGN_VCENTRE | ALIGN_HCENTRE, COL_PENCIL, str);
4929 j++;
4930 }
4931 }
1d8e8ad8 4932 }
4933
dafd6cf6 4934 unclip(dr);
1d8e8ad8 4935
dafd6cf6 4936 draw_update(dr, cx, cy, cw, ch);
1d8e8ad8 4937
4938 ds->grid[y*cr+x] = state->grid[y*cr+x];
c8266e03 4939 memcpy(ds->pencil+(y*cr+x)*cr, state->pencil+(y*cr+x)*cr, cr);
1d8e8ad8 4940 ds->hl[y*cr+x] = hl;
4941}
4942
dafd6cf6 4943static void game_redraw(drawing *dr, game_drawstate *ds, game_state *oldstate,
1d8e8ad8 4944 game_state *state, int dir, game_ui *ui,
4945 float animtime, float flashtime)
4946{
fbd0fc79 4947 int cr = state->cr;
1d8e8ad8 4948 int x, y;
4949
4950 if (!ds->started) {
4951 /*
4952 * The initial contents of the window are not guaranteed
4953 * and can vary with front ends. To be on the safe side,
4954 * all games should start by drawing a big
4955 * background-colour rectangle covering the whole window.
4956 */
dafd6cf6 4957 draw_rect(dr, 0, 0, SIZE(cr), SIZE(cr), COL_BACKGROUND);
1d8e8ad8 4958
4959 /*
fbd0fc79 4960 * Draw the grid. We draw it as a big thick rectangle of
4961 * COL_GRID initially; individual calls to draw_number()
4962 * will poke the right-shaped holes in it.
1d8e8ad8 4963 */
fbd0fc79 4964 draw_rect(dr, BORDER-GRIDEXTRA, BORDER-GRIDEXTRA,
4965 cr*TILE_SIZE+1+2*GRIDEXTRA, cr*TILE_SIZE+1+2*GRIDEXTRA,
4966 COL_GRID);
1d8e8ad8 4967 }
4968
4969 /*
7b14a9ec 4970 * This array is used to keep track of rows, columns and boxes
4971 * which contain a number more than once.
4972 */
4973 for (x = 0; x < cr * cr; x++)
b71dd7fc 4974 ds->entered_items[x] = 0;
7b14a9ec 4975 for (x = 0; x < cr; x++)
4976 for (y = 0; y < cr; y++) {
4977 digit d = state->grid[y*cr+x];
4978 if (d) {
fbd0fc79 4979 int box = state->blocks->whichblock[y*cr+x];
4980 ds->entered_items[x*cr+d-1] |= ((ds->entered_items[x*cr+d-1] & 1) << 1) | 1;
b71dd7fc 4981 ds->entered_items[y*cr+d-1] |= ((ds->entered_items[y*cr+d-1] & 4) << 1) | 4;
4982 ds->entered_items[box*cr+d-1] |= ((ds->entered_items[box*cr+d-1] & 16) << 1) | 16;
fbd0fc79 4983 if (ds->xtype) {
4984 if (ondiag0(y*cr+x))
4985 ds->entered_items[d-1] |= ((ds->entered_items[d-1] & 64) << 1) | 64;
4986 if (ondiag1(y*cr+x))
4987 ds->entered_items[cr+d-1] |= ((ds->entered_items[cr+d-1] & 64) << 1) | 64;
4988 }
7b14a9ec 4989 }
4990 }
4991
4992 /*
1d8e8ad8 4993 * Draw any numbers which need redrawing.
4994 */
4995 for (x = 0; x < cr; x++) {
4996 for (y = 0; y < cr; y++) {
c8266e03 4997 int highlight = 0;
7b14a9ec 4998 digit d = state->grid[y*cr+x];
4999
c8266e03 5000 if (flashtime > 0 &&
5001 (flashtime <= FLASH_TIME/3 ||
5002 flashtime >= FLASH_TIME*2/3))
5003 highlight = 1;
7b14a9ec 5004
5005 /* Highlight active input areas. */
b63898fe 5006 if (x == ui->hx && y == ui->hy && ui->hshow)
c8266e03 5007 highlight = ui->hpencil ? 2 : 1;
7b14a9ec 5008
5009 /* Mark obvious errors (ie, numbers which occur more than once
5010 * in a single row, column, or box). */
5d744557 5011 if (d && ((ds->entered_items[x*cr+d-1] & 2) ||
5012 (ds->entered_items[y*cr+d-1] & 8) ||
fbd0fc79 5013 (ds->entered_items[state->blocks->whichblock[y*cr+x]*cr+d-1] & 32) ||
5014 (ds->xtype && ((ondiag0(y*cr+x) && (ds->entered_items[d-1] & 128)) ||
5015 (ondiag1(y*cr+x) && (ds->entered_items[cr+d-1] & 128))))))
7b14a9ec 5016 highlight |= 16;
5017
ad599e2b 5018 if (d && state->kblocks) {
5019 int i, b = state->kblocks->whichblock[y*cr+x];
5020 int n_squares = state->kblocks->nr_squares[b];
5021 int sum = 0, clue = 0;
5022 for (i = 0; i < n_squares; i++) {
5023 int xy = state->kblocks->blocks[b][i];
5024 if (state->grid[xy] == 0)
5025 break;
5026
5027 sum += state->grid[xy];
5028 if (state->kgrid[xy]) {
5029 assert(clue == 0);
5030 clue = state->kgrid[xy];
5031 }
5032 }
5033
5034 if (i == n_squares) {
5035 assert(clue != 0);
5036 if (sum != clue)
5037 highlight |= 32;
5038 }
5039 }
5040
dafd6cf6 5041 draw_number(dr, ds, state, x, y, highlight);
1d8e8ad8 5042 }
5043 }
5044
5045 /*
5046 * Update the _entire_ grid if necessary.
5047 */
5048 if (!ds->started) {
dafd6cf6 5049 draw_update(dr, 0, 0, SIZE(cr), SIZE(cr));
1d8e8ad8 5050 ds->started = TRUE;
5051 }
5052}
5053
5054static float game_anim_length(game_state *oldstate, game_state *newstate,
e3f21163 5055 int dir, game_ui *ui)
1d8e8ad8 5056{
5057 return 0.0F;
5058}
5059
5060static float game_flash_length(game_state *oldstate, game_state *newstate,
e3f21163 5061 int dir, game_ui *ui)
1d8e8ad8 5062{
2ac6d24e 5063 if (!oldstate->completed && newstate->completed &&
5064 !oldstate->cheated && !newstate->cheated)
1d8e8ad8 5065 return FLASH_TIME;
5066 return 0.0F;
5067}
5068
4d08de49 5069static int game_timing_state(game_state *state, game_ui *ui)
48dcdd62 5070{
ad599e2b 5071 if (state->completed)
5072 return FALSE;
48dcdd62 5073 return TRUE;
5074}
5075
dafd6cf6 5076static void game_print_size(game_params *params, float *x, float *y)
5077{
5078 int pw, ph;
5079
5080 /*
5081 * I'll use 9mm squares by default. They should be quite big
5082 * for this game, because players will want to jot down no end
5083 * of pencil marks in the squares.
5084 */
5085 game_compute_size(params, 900, &pw, &ph);
b63898fe 5086 *x = pw / 100.0F;
5087 *y = ph / 100.0F;
dafd6cf6 5088}
5089
ad599e2b 5090/*
5091 * Subfunction to draw the thick lines between cells. In order to do
5092 * this using the line-drawing rather than rectangle-drawing API (so
5093 * as to get line thicknesses to scale correctly) and yet have
5094 * correctly mitred joins between lines, we must do this by tracing
5095 * the boundary of each sub-block and drawing it in one go as a
5096 * single polygon.
5097 *
5098 * This subfunction is also reused with thinner dotted lines to
5099 * outline the Killer cages, this time offsetting the outline toward
5100 * the interior of the affected squares.
5101 */
5102static void outline_block_structure(drawing *dr, game_drawstate *ds,
5103 game_state *state,
5104 struct block_structure *blocks,
5105 int ink, int inset)
5106{
5107 int cr = state->cr;
5108 int *coords;
5109 int bi, i, n;
5110 int x, y, dx, dy, sx, sy, sdx, sdy;
5111
5112 /*
5113 * Maximum perimeter of a k-omino is 2k+2. (Proof: start
5114 * with k unconnected squares, with total perimeter 4k.
5115 * Now repeatedly join two disconnected components
5116 * together into a larger one; every time you do so you
5117 * remove at least two unit edges, and you require k-1 of
5118 * these operations to create a single connected piece, so
5119 * you must have at most 4k-2(k-1) = 2k+2 unit edges left
5120 * afterwards.)
5121 */
5122 coords = snewn(4*cr+4, int); /* 2k+2 points, 2 coords per point */
5123
5124 /*
5125 * Iterate over all the blocks.
5126 */
5127 for (bi = 0; bi < blocks->nr_blocks; bi++) {
5128 if (blocks->nr_squares[bi] == 0)
5129 continue;
5130
5131 /*
5132 * For each block, find a starting square within it
5133 * which has a boundary at the left.
5134 */
5135 for (i = 0; i < cr; i++) {
5136 int j = blocks->blocks[bi][i];
5137 if (j % cr == 0 || blocks->whichblock[j-1] != bi)
5138 break;
5139 }
5140 assert(i < cr); /* every block must have _some_ leftmost square */
5141 x = blocks->blocks[bi][i] % cr;
5142 y = blocks->blocks[bi][i] / cr;
5143 dx = -1;
5144 dy = 0;
5145
5146 /*
5147 * Now begin tracing round the perimeter. At all
5148 * times, (x,y) describes some square within the
5149 * block, and (x+dx,y+dy) is some adjacent square
5150 * outside it; so the edge between those two squares
5151 * is always an edge of the block.
5152 */
5153 sx = x, sy = y, sdx = dx, sdy = dy; /* save starting position */
5154 n = 0;
5155 do {
5156 int cx, cy, tx, ty, nin;
5157
5158 /*
5159 * Advance to the next edge, by looking at the two
5160 * squares beyond it. If they're both outside the block,
5161 * we turn right (by leaving x,y the same and rotating
5162 * dx,dy clockwise); if they're both inside, we turn
5163 * left (by rotating dx,dy anticlockwise and contriving
5164 * to leave x+dx,y+dy unchanged); if one of each, we go
5165 * straight on (and may enforce by assertion that
5166 * they're one of each the _right_ way round).
5167 */
5168 nin = 0;
5169 tx = x - dy + dx;
5170 ty = y + dx + dy;
5171 nin += (tx >= 0 && tx < cr && ty >= 0 && ty < cr &&
5172 blocks->whichblock[ty*cr+tx] == bi);
5173 tx = x - dy;
5174 ty = y + dx;
5175 nin += (tx >= 0 && tx < cr && ty >= 0 && ty < cr &&
5176 blocks->whichblock[ty*cr+tx] == bi);
5177 if (nin == 0) {
5178 /*
5179 * Turn right.
5180 */
5181 int tmp;
5182 tmp = dx;
5183 dx = -dy;
5184 dy = tmp;
5185 } else if (nin == 2) {
5186 /*
5187 * Turn left.
5188 */
5189 int tmp;
5190
5191 x += dx;
5192 y += dy;
5193
5194 tmp = dx;
5195 dx = dy;
5196 dy = -tmp;
5197
5198 x -= dx;
5199 y -= dy;
5200 } else {
5201 /*
5202 * Go straight on.
5203 */
5204 x -= dy;
5205 y += dx;
5206 }
5207
5208 /*
5209 * Now enforce by assertion that we ended up
5210 * somewhere sensible.
5211 */
5212 assert(x >= 0 && x < cr && y >= 0 && y < cr &&
5213 blocks->whichblock[y*cr+x] == bi);
5214 assert(x+dx < 0 || x+dx >= cr || y+dy < 0 || y+dy >= cr ||
5215 blocks->whichblock[(y+dy)*cr+(x+dx)] != bi);
5216
5217 /*
5218 * Record the point we just went past at one end of the
5219 * edge. To do this, we translate (x,y) down and right
5220 * by half a unit (so they're describing a point in the
5221 * _centre_ of the square) and then translate back again
5222 * in a manner rotated by dy and dx.
5223 */
5224 assert(n < 2*cr+2);
5225 cx = ((2*x+1) + dy + dx) / 2;
5226 cy = ((2*y+1) - dx + dy) / 2;
5227 coords[2*n+0] = BORDER + cx * TILE_SIZE;
5228 coords[2*n+1] = BORDER + cy * TILE_SIZE;
5229 coords[2*n+0] -= dx * inset;
5230 coords[2*n+1] -= dy * inset;
5231 if (nin == 0) {
5232 /*
5233 * We turned right, so inset this corner back along
5234 * the edge towards the centre of the square.
5235 */
5236 coords[2*n+0] -= dy * inset;
5237 coords[2*n+1] += dx * inset;
5238 } else if (nin == 2) {
5239 /*
5240 * We turned left, so inset this corner further
5241 * _out_ along the edge into the next square.
5242 */
5243 coords[2*n+0] += dy * inset;
5244 coords[2*n+1] -= dx * inset;
5245 }
5246 n++;
5247
5248 } while (x != sx || y != sy || dx != sdx || dy != sdy);
5249
5250 /*
5251 * That's our polygon; now draw it.
5252 */
5253 draw_polygon(dr, coords, n, -1, ink);
5254 }
5255
5256 sfree(coords);
5257}
5258
dafd6cf6 5259static void game_print(drawing *dr, game_state *state, int tilesize)
5260{
fbd0fc79 5261 int cr = state->cr;
dafd6cf6 5262 int ink = print_mono_colour(dr, 0);
5263 int x, y;
5264
5265 /* Ick: fake up `ds->tilesize' for macro expansion purposes */
5266 game_drawstate ads, *ds = &ads;
4413ef0f 5267 game_set_size(dr, ds, NULL, tilesize);
dafd6cf6 5268
5269 /*
5270 * Border.
5271 */
5272 print_line_width(dr, 3 * TILE_SIZE / 40);
5273 draw_rect_outline(dr, BORDER, BORDER, cr*TILE_SIZE, cr*TILE_SIZE, ink);
5274
5275 /*
fbd0fc79 5276 * Highlight X-diagonal squares.
5277 */
5278 if (state->xtype) {
5279 int i;
60aa1c74 5280 int xhighlight = print_grey_colour(dr, 0.90F);
fbd0fc79 5281
5282 for (i = 0; i < cr; i++)
5283 draw_rect(dr, BORDER + i*TILE_SIZE, BORDER + i*TILE_SIZE,
5284 TILE_SIZE, TILE_SIZE, xhighlight);
5285 for (i = 0; i < cr; i++)
5286 if (i*2 != cr-1) /* avoid redoing centre square, just for fun */
5287 draw_rect(dr, BORDER + i*TILE_SIZE,
5288 BORDER + (cr-1-i)*TILE_SIZE,
5289 TILE_SIZE, TILE_SIZE, xhighlight);
5290 }
5291
5292 /*
5293 * Main grid.
dafd6cf6 5294 */
5295 for (x = 1; x < cr; x++) {
fbd0fc79 5296 print_line_width(dr, TILE_SIZE / 40);
dafd6cf6 5297 draw_line(dr, BORDER+x*TILE_SIZE, BORDER,
5298 BORDER+x*TILE_SIZE, BORDER+cr*TILE_SIZE, ink);
5299 }
5300 for (y = 1; y < cr; y++) {
fbd0fc79 5301 print_line_width(dr, TILE_SIZE / 40);
dafd6cf6 5302 draw_line(dr, BORDER, BORDER+y*TILE_SIZE,
5303 BORDER+cr*TILE_SIZE, BORDER+y*TILE_SIZE, ink);
5304 }
5305
5306 /*
ad599e2b 5307 * Thick lines between cells.
fbd0fc79 5308 */
ad599e2b 5309 print_line_width(dr, 3 * TILE_SIZE / 40);
5310 outline_block_structure(dr, ds, state, state->blocks, ink, 0);
fbd0fc79 5311
ad599e2b 5312 /*
5313 * Killer cages and their totals.
5314 */
5315 if (state->kblocks) {
5316 print_line_width(dr, TILE_SIZE / 40);
5317 print_line_dotted(dr, TRUE);
5318 outline_block_structure(dr, ds, state, state->kblocks, ink,
5319 5 * TILE_SIZE / 40);
5320 print_line_dotted(dr, FALSE);
5321 for (y = 0; y < cr; y++)
5322 for (x = 0; x < cr; x++)
5323 if (state->kgrid[y*cr+x]) {
5324 char str[20];
5325 sprintf(str, "%d", state->kgrid[y*cr+x]);
5326 draw_text(dr,
5327 BORDER+x*TILE_SIZE + 7*TILE_SIZE/40,
5328 BORDER+y*TILE_SIZE + 16*TILE_SIZE/40,
5329 FONT_VARIABLE, TILE_SIZE/4,
5330 ALIGN_VNORMAL | ALIGN_HLEFT,
5331 ink, str);
fbd0fc79 5332 }
fbd0fc79 5333 }
5334
5335 /*
ad599e2b 5336 * Standard (non-Killer) clue numbers.
dafd6cf6 5337 */
5338 for (y = 0; y < cr; y++)
5339 for (x = 0; x < cr; x++)
5340 if (state->grid[y*cr+x]) {
5341 char str[2];
5342 str[1] = '\0';
5343 str[0] = state->grid[y*cr+x] + '0';
5344 if (str[0] > '9')
5345 str[0] += 'a' - ('9'+1);
5346 draw_text(dr, BORDER + x*TILE_SIZE + TILE_SIZE/2,
5347 BORDER + y*TILE_SIZE + TILE_SIZE/2,
5348 FONT_VARIABLE, TILE_SIZE/2,
5349 ALIGN_VCENTRE | ALIGN_HCENTRE, ink, str);
5350 }
5351}
5352
1d8e8ad8 5353#ifdef COMBINED
5354#define thegame solo
5355#endif
5356
5357const struct game thegame = {
750037d7 5358 "Solo", "games.solo", "solo",
1d8e8ad8 5359 default_params,
5360 game_fetch_preset,
5361 decode_params,
5362 encode_params,
5363 free_params,
5364 dup_params,
1d228b10 5365 TRUE, game_configure, custom_params,
1d8e8ad8 5366 validate_params,
1185e3c5 5367 new_game_desc,
1185e3c5 5368 validate_desc,
1d8e8ad8 5369 new_game,
5370 dup_game,
5371 free_game,
2ac6d24e 5372 TRUE, solve_game,
fa3abef5 5373 TRUE, game_can_format_as_text_now, game_text_format,
1d8e8ad8 5374 new_ui,
5375 free_ui,
ae8290c6 5376 encode_ui,
5377 decode_ui,
07dfb697 5378 game_changed_state,
df11cd4e 5379 interpret_move,
5380 execute_move,
1f3ee4ee 5381 PREFERRED_TILE_SIZE, game_compute_size, game_set_size,
1d8e8ad8 5382 game_colours,
5383 game_new_drawstate,
5384 game_free_drawstate,
5385 game_redraw,
5386 game_anim_length,
5387 game_flash_length,
dafd6cf6 5388 TRUE, FALSE, game_print_size, game_print,
ac9f41c4 5389 FALSE, /* wants_statusbar */
48dcdd62 5390 FALSE, game_timing_state,
cb0c7d4a 5391 REQUIRE_RBUTTON | REQUIRE_NUMPAD, /* flags */
1d8e8ad8 5392};
3ddae0ff 5393
5394#ifdef STANDALONE_SOLVER
5395
3ddae0ff 5396int main(int argc, char **argv)
5397{
5398 game_params *p;
5399 game_state *s;
1185e3c5 5400 char *id = NULL, *desc, *err;
7c568a48 5401 int grade = FALSE;
ad599e2b 5402 struct difficulty dlev;
3ddae0ff 5403
5404 while (--argc > 0) {
5405 char *p = *++argv;
ab362080 5406 if (!strcmp(p, "-v")) {
7c568a48 5407 solver_show_working = TRUE;
7c568a48 5408 } else if (!strcmp(p, "-g")) {
5409 grade = TRUE;
3ddae0ff 5410 } else if (*p == '-') {
8317499a 5411 fprintf(stderr, "%s: unrecognised option `%s'\n", argv[0], p);
3ddae0ff 5412 return 1;
5413 } else {
5414 id = p;
5415 }
5416 }
5417
5418 if (!id) {
ab362080 5419 fprintf(stderr, "usage: %s [-g | -v] <game_id>\n", argv[0]);
3ddae0ff 5420 return 1;
5421 }
5422
1185e3c5 5423 desc = strchr(id, ':');
5424 if (!desc) {
3ddae0ff 5425 fprintf(stderr, "%s: game id expects a colon in it\n", argv[0]);
5426 return 1;
5427 }
1185e3c5 5428 *desc++ = '\0';
3ddae0ff 5429
1733f4ca 5430 p = default_params();
5431 decode_params(p, id);
1185e3c5 5432 err = validate_desc(p, desc);
3ddae0ff 5433 if (err) {
5434 fprintf(stderr, "%s: %s\n", argv[0], err);
5435 return 1;
5436 }
39d682c9 5437 s = new_game(NULL, p, desc);
3ddae0ff 5438
ad599e2b 5439 dlev.maxdiff = DIFF_RECURSIVE;
5440 dlev.maxkdiff = DIFF_KINTERSECT;
5441 solver(s->cr, s->blocks, s->kblocks, s->xtype, s->grid, s->kgrid, &dlev);
ab362080 5442 if (grade) {
5443 printf("Difficulty rating: %s\n",
ad599e2b 5444 dlev.diff==DIFF_BLOCK ? "Trivial (blockwise positional elimination only)":
5445 dlev.diff==DIFF_SIMPLE ? "Basic (row/column/number elimination required)":
5446 dlev.diff==DIFF_INTERSECT ? "Intermediate (intersectional analysis required)":
5447 dlev.diff==DIFF_SET ? "Advanced (set elimination required)":
5448 dlev.diff==DIFF_EXTREME ? "Extreme (complex non-recursive techniques required)":
5449 dlev.diff==DIFF_RECURSIVE ? "Unreasonable (guesswork and backtracking required)":
5450 dlev.diff==DIFF_AMBIGUOUS ? "Ambiguous (multiple solutions exist)":
5451 dlev.diff==DIFF_IMPOSSIBLE ? "Impossible (no solution exists)":
ab362080 5452 "INTERNAL ERROR: unrecognised difficulty code");
ad599e2b 5453 if (p->killer)
5454 printf("Killer diffculty: %s\n",
5455 dlev.kdiff==DIFF_KSINGLE ? "Trivial (single square cages only)":
5456 dlev.kdiff==DIFF_KMINMAX ? "Simple (maximum sum analysis required)":
5457 dlev.kdiff==DIFF_KSUMS ? "Intermediate (sum possibilities)":
5458 dlev.kdiff==DIFF_KINTERSECT ? "Advanced (sum region intersections)":
5459 "INTERNAL ERROR: unrecognised difficulty code");
3ddae0ff 5460 } else {
fbd0fc79 5461 printf("%s\n", grid_text_format(s->cr, s->blocks, s->xtype, s->grid));
3ddae0ff 5462 }
5463
3ddae0ff 5464 return 0;
5465}
5466
5467#endif
b63898fe 5468
5469/* vim: set shiftwidth=4 tabstop=8: */