chiark / gitweb /
Assorted char * -> const char * API changes.
[sgt-puzzles.git] / loopy.c
1 /*
2  * loopy.c:
3  *
4  * An implementation of the Nikoli game 'Loop the loop'.
5  * (c) Mike Pinna, 2005, 2006
6  * Substantially rewritten to allowing for more general types of grid.
7  * (c) Lambros Lambrou 2008
8  *
9  * vim: set shiftwidth=4 :set textwidth=80:
10  */
11
12 /*
13  * Possible future solver enhancements:
14  * 
15  *  - There's an interesting deductive technique which makes use
16  *    of topology rather than just graph theory. Each _face_ in
17  *    the grid is either inside or outside the loop; you can tell
18  *    that two faces are on the same side of the loop if they're
19  *    separated by a LINE_NO (or, more generally, by a path
20  *    crossing no LINE_UNKNOWNs and an even number of LINE_YESes),
21  *    and on the opposite side of the loop if they're separated by
22  *    a LINE_YES (or an odd number of LINE_YESes and no
23  *    LINE_UNKNOWNs). Oh, and any face separated from the outside
24  *    of the grid by a LINE_YES or a LINE_NO is on the inside or
25  *    outside respectively. So if you can track this for all
26  *    faces, you figure out the state of the line between a pair
27  *    once their relative insideness is known.
28  *     + The way I envisage this working is simply to keep an edsf
29  *       of all _faces_, which indicates whether they're on
30  *       opposite sides of the loop from one another. We also
31  *       include a special entry in the edsf for the infinite
32  *       exterior "face".
33  *     + So, the simple way to do this is to just go through the
34  *       edges: every time we see an edge in a state other than
35  *       LINE_UNKNOWN which separates two faces that aren't in the
36  *       same edsf class, we can rectify that by merging the
37  *       classes. Then, conversely, an edge in LINE_UNKNOWN state
38  *       which separates two faces that _are_ in the same edsf
39  *       class can immediately have its state determined.
40  *     + But you can go one better, if you're prepared to loop
41  *       over all _pairs_ of edges. Suppose we have edges A and B,
42  *       which respectively separate faces A1,A2 and B1,B2.
43  *       Suppose that A,B are in the same edge-edsf class and that
44  *       A1,B1 (wlog) are in the same face-edsf class; then we can
45  *       immediately place A2,B2 into the same face-edsf class (as
46  *       each other, not as A1 and A2) one way round or the other.
47  *       And conversely again, if A1,B1 are in the same face-edsf
48  *       class and so are A2,B2, then we can put A,B into the same
49  *       face-edsf class.
50  *        * Of course, this deduction requires a quadratic-time
51  *          loop over all pairs of edges in the grid, so it should
52  *          be reserved until there's nothing easier left to be
53  *          done.
54  * 
55  *  - The generalised grid support has made me (SGT) notice a
56  *    possible extension to the loop-avoidance code. When you have
57  *    a path of connected edges such that no other edges at all
58  *    are incident on any vertex in the middle of the path - or,
59  *    alternatively, such that any such edges are already known to
60  *    be LINE_NO - then you know those edges are either all
61  *    LINE_YES or all LINE_NO. Hence you can mentally merge the
62  *    entire path into a single long curly edge for the purposes
63  *    of loop avoidance, and look directly at whether or not the
64  *    extreme endpoints of the path are connected by some other
65  *    route. I find this coming up fairly often when I play on the
66  *    octagonal grid setting, so it might be worth implementing in
67  *    the solver.
68  *
69  *  - (Just a speed optimisation.)  Consider some todo list queue where every
70  *    time we modify something we mark it for consideration by other bits of
71  *    the solver, to save iteration over things that have already been done.
72  */
73
74 #include <stdio.h>
75 #include <stdlib.h>
76 #include <stddef.h>
77 #include <string.h>
78 #include <assert.h>
79 #include <ctype.h>
80 #include <math.h>
81
82 #include "puzzles.h"
83 #include "tree234.h"
84 #include "grid.h"
85 #include "loopgen.h"
86
87 /* Debugging options */
88
89 /*
90 #define DEBUG_CACHES
91 #define SHOW_WORKING
92 #define DEBUG_DLINES
93 */
94
95 /* ----------------------------------------------------------------------
96  * Struct, enum and function declarations
97  */
98
99 enum {
100     COL_BACKGROUND,
101     COL_FOREGROUND,
102     COL_LINEUNKNOWN,
103     COL_HIGHLIGHT,
104     COL_MISTAKE,
105     COL_SATISFIED,
106     COL_FAINT,
107     NCOLOURS
108 };
109
110 struct game_state {
111     grid *game_grid; /* ref-counted (internally) */
112
113     /* Put -1 in a face that doesn't get a clue */
114     signed char *clues;
115
116     /* Array of line states, to store whether each line is
117      * YES, NO or UNKNOWN */
118     char *lines;
119
120     unsigned char *line_errors;
121     int exactly_one_loop;
122
123     int solved;
124     int cheated;
125
126     /* Used in game_text_format(), so that it knows what type of
127      * grid it's trying to render as ASCII text. */
128     int grid_type;
129 };
130
131 enum solver_status {
132     SOLVER_SOLVED,    /* This is the only solution the solver could find */
133     SOLVER_MISTAKE,   /* This is definitely not a solution */
134     SOLVER_AMBIGUOUS, /* This _might_ be an ambiguous solution */
135     SOLVER_INCOMPLETE /* This may be a partial solution */
136 };
137
138 /* ------ Solver state ------ */
139 typedef struct solver_state {
140     game_state *state;
141     enum solver_status solver_status;
142     /* NB looplen is the number of dots that are joined together at a point, ie a
143      * looplen of 1 means there are no lines to a particular dot */
144     int *looplen;
145
146     /* Difficulty level of solver.  Used by solver functions that want to
147      * vary their behaviour depending on the requested difficulty level. */
148     int diff;
149
150     /* caches */
151     char *dot_yes_count;
152     char *dot_no_count;
153     char *face_yes_count;
154     char *face_no_count;
155     char *dot_solved, *face_solved;
156     int *dotdsf;
157
158     /* Information for Normal level deductions:
159      * For each dline, store a bitmask for whether we know:
160      * (bit 0) at least one is YES
161      * (bit 1) at most one is YES */
162     char *dlines;
163
164     /* Hard level information */
165     int *linedsf;
166 } solver_state;
167
168 /*
169  * Difficulty levels. I do some macro ickery here to ensure that my
170  * enum and the various forms of my name list always match up.
171  */
172
173 #define DIFFLIST(A) \
174     A(EASY,Easy,e) \
175     A(NORMAL,Normal,n) \
176     A(TRICKY,Tricky,t) \
177     A(HARD,Hard,h)
178 #define ENUM(upper,title,lower) DIFF_ ## upper,
179 #define TITLE(upper,title,lower) #title,
180 #define ENCODE(upper,title,lower) #lower
181 #define CONFIG(upper,title,lower) ":" #title
182 enum { DIFFLIST(ENUM) DIFF_MAX };
183 static char const *const diffnames[] = { DIFFLIST(TITLE) };
184 static char const diffchars[] = DIFFLIST(ENCODE);
185 #define DIFFCONFIG DIFFLIST(CONFIG)
186
187 /*
188  * Solver routines, sorted roughly in order of computational cost.
189  * The solver will run the faster deductions first, and slower deductions are
190  * only invoked when the faster deductions are unable to make progress.
191  * Each function is associated with a difficulty level, so that the generated
192  * puzzles are solvable by applying only the functions with the chosen
193  * difficulty level or lower.
194  */
195 #define SOLVERLIST(A) \
196     A(trivial_deductions, DIFF_EASY) \
197     A(dline_deductions, DIFF_NORMAL) \
198     A(linedsf_deductions, DIFF_HARD) \
199     A(loop_deductions, DIFF_EASY)
200 #define SOLVER_FN_DECL(fn,diff) static int fn(solver_state *);
201 #define SOLVER_FN(fn,diff) &fn,
202 #define SOLVER_DIFF(fn,diff) diff,
203 SOLVERLIST(SOLVER_FN_DECL)
204 static int (*(solver_fns[]))(solver_state *) = { SOLVERLIST(SOLVER_FN) };
205 static int const solver_diffs[] = { SOLVERLIST(SOLVER_DIFF) };
206 static const int NUM_SOLVERS = sizeof(solver_diffs)/sizeof(*solver_diffs);
207
208 struct game_params {
209     int w, h;
210     int diff;
211     int type;
212 };
213
214 /* line_drawstate is the same as line_state, but with the extra ERROR
215  * possibility.  The drawing code copies line_state to line_drawstate,
216  * except in the case that the line is an error. */
217 enum line_state { LINE_YES, LINE_UNKNOWN, LINE_NO };
218 enum line_drawstate { DS_LINE_YES, DS_LINE_UNKNOWN,
219                       DS_LINE_NO, DS_LINE_ERROR };
220
221 #define OPP(line_state) \
222     (2 - line_state)
223
224
225 struct game_drawstate {
226     int started;
227     int tilesize;
228     int flashing;
229     int *textx, *texty;
230     char *lines;
231     char *clue_error;
232     char *clue_satisfied;
233 };
234
235 static const char *validate_desc(const game_params *params, const char *desc);
236 static int dot_order(const game_state* state, int i, char line_type);
237 static int face_order(const game_state* state, int i, char line_type);
238 static solver_state *solve_game_rec(const solver_state *sstate);
239
240 #ifdef DEBUG_CACHES
241 static void check_caches(const solver_state* sstate);
242 #else
243 #define check_caches(s)
244 #endif
245
246 /*
247  * Grid type config options available in Loopy.
248  *
249  * Annoyingly, we have to use an enum here which doesn't match up
250  * exactly to the grid-type enum in grid.h. Values in params->types
251  * are given by names such as LOOPY_GRID_SQUARE, which shouldn't be
252  * confused with GRID_SQUARE which is the value you pass to grid_new()
253  * and friends. So beware!
254  *
255  * (This is partly for historical reasons - Loopy's version of the
256  * enum is encoded in game parameter strings, so we keep it for
257  * backwards compatibility. But also, we need to store additional data
258  * here alongside each enum value, such as names for the presets menu,
259  * which isn't stored in grid.h; so we have to have our own list macro
260  * here anyway, and C doesn't make it easy to enforce that that lines
261  * up exactly with grid.h.)
262  *
263  * Do not add values to this list _except_ at the end, or old game ids
264  * will stop working!
265  */
266 #define GRIDLIST(A)                                             \
267     A("Squares",SQUARE,3,3)                                     \
268     A("Triangular",TRIANGULAR,3,3)                              \
269     A("Honeycomb",HONEYCOMB,3,3)                                \
270     A("Snub-Square",SNUBSQUARE,3,3)                             \
271     A("Cairo",CAIRO,3,4)                                        \
272     A("Great-Hexagonal",GREATHEXAGONAL,3,3)                     \
273     A("Octagonal",OCTAGONAL,3,3)                                \
274     A("Kites",KITE,3,3)                                         \
275     A("Floret",FLORET,1,2)                                      \
276     A("Dodecagonal",DODECAGONAL,2,2)                            \
277     A("Great-Dodecagonal",GREATDODECAGONAL,2,2)                 \
278     A("Penrose (kite/dart)",PENROSE_P2,3,3)                     \
279     A("Penrose (rhombs)",PENROSE_P3,3,3)                        \
280     A("Great-Great-Dodecagonal",GREATGREATDODECAGONAL,2,2)      \
281     /* end of list */
282
283 #define GRID_NAME(title,type,amin,omin) title,
284 #define GRID_CONFIG(title,type,amin,omin) ":" title
285 #define GRID_LOOPYTYPE(title,type,amin,omin) LOOPY_GRID_ ## type,
286 #define GRID_GRIDTYPE(title,type,amin,omin) GRID_ ## type,
287 #define GRID_SIZES(title,type,amin,omin) \
288     {amin, omin, \
289      "Width and height for this grid type must both be at least " #amin, \
290      "At least one of width and height for this grid type must be at least " #omin,},
291 enum { GRIDLIST(GRID_LOOPYTYPE) LOOPY_GRID_DUMMY_TERMINATOR };
292 static char const *const gridnames[] = { GRIDLIST(GRID_NAME) };
293 #define GRID_CONFIGS GRIDLIST(GRID_CONFIG)
294 static grid_type grid_types[] = { GRIDLIST(GRID_GRIDTYPE) };
295 #define NUM_GRID_TYPES (sizeof(grid_types) / sizeof(grid_types[0]))
296 static const struct {
297     int amin, omin;
298     char *aerr, *oerr;
299 } grid_size_limits[] = { GRIDLIST(GRID_SIZES) };
300
301 /* Generates a (dynamically allocated) new grid, according to the
302  * type and size requested in params.  Does nothing if the grid is already
303  * generated. */
304 static grid *loopy_generate_grid(const game_params *params,
305                                  const char *grid_desc)
306 {
307     return grid_new(grid_types[params->type], params->w, params->h, grid_desc);
308 }
309
310 /* ----------------------------------------------------------------------
311  * Preprocessor magic
312  */
313
314 /* General constants */
315 #define PREFERRED_TILE_SIZE 32
316 #define BORDER(tilesize) ((tilesize) / 2)
317 #define FLASH_TIME 0.5F
318
319 #define BIT_SET(field, bit) ((field) & (1<<(bit)))
320
321 #define SET_BIT(field, bit)  (BIT_SET(field, bit) ? FALSE : \
322                               ((field) |= (1<<(bit)), TRUE))
323
324 #define CLEAR_BIT(field, bit) (BIT_SET(field, bit) ? \
325                                ((field) &= ~(1<<(bit)), TRUE) : FALSE)
326
327 #define CLUE2CHAR(c) \
328     ((c < 0) ? ' ' : c < 10 ? c + '0' : c - 10 + 'A')
329
330 /* ----------------------------------------------------------------------
331  * General struct manipulation and other straightforward code
332  */
333
334 static game_state *dup_game(const game_state *state)
335 {
336     game_state *ret = snew(game_state);
337
338     ret->game_grid = state->game_grid;
339     ret->game_grid->refcount++;
340
341     ret->solved = state->solved;
342     ret->cheated = state->cheated;
343
344     ret->clues = snewn(state->game_grid->num_faces, signed char);
345     memcpy(ret->clues, state->clues, state->game_grid->num_faces);
346
347     ret->lines = snewn(state->game_grid->num_edges, char);
348     memcpy(ret->lines, state->lines, state->game_grid->num_edges);
349
350     ret->line_errors = snewn(state->game_grid->num_edges, unsigned char);
351     memcpy(ret->line_errors, state->line_errors, state->game_grid->num_edges);
352     ret->exactly_one_loop = state->exactly_one_loop;
353
354     ret->grid_type = state->grid_type;
355     return ret;
356 }
357
358 static void free_game(game_state *state)
359 {
360     if (state) {
361         grid_free(state->game_grid);
362         sfree(state->clues);
363         sfree(state->lines);
364         sfree(state->line_errors);
365         sfree(state);
366     }
367 }
368
369 static solver_state *new_solver_state(const game_state *state, int diff) {
370     int i;
371     int num_dots = state->game_grid->num_dots;
372     int num_faces = state->game_grid->num_faces;
373     int num_edges = state->game_grid->num_edges;
374     solver_state *ret = snew(solver_state);
375
376     ret->state = dup_game(state);
377
378     ret->solver_status = SOLVER_INCOMPLETE;
379     ret->diff = diff;
380
381     ret->dotdsf = snew_dsf(num_dots);
382     ret->looplen = snewn(num_dots, int);
383
384     for (i = 0; i < num_dots; i++) {
385         ret->looplen[i] = 1;
386     }
387
388     ret->dot_solved = snewn(num_dots, char);
389     ret->face_solved = snewn(num_faces, char);
390     memset(ret->dot_solved, FALSE, num_dots);
391     memset(ret->face_solved, FALSE, num_faces);
392
393     ret->dot_yes_count = snewn(num_dots, char);
394     memset(ret->dot_yes_count, 0, num_dots);
395     ret->dot_no_count = snewn(num_dots, char);
396     memset(ret->dot_no_count, 0, num_dots);
397     ret->face_yes_count = snewn(num_faces, char);
398     memset(ret->face_yes_count, 0, num_faces);
399     ret->face_no_count = snewn(num_faces, char);
400     memset(ret->face_no_count, 0, num_faces);
401
402     if (diff < DIFF_NORMAL) {
403         ret->dlines = NULL;
404     } else {
405         ret->dlines = snewn(2*num_edges, char);
406         memset(ret->dlines, 0, 2*num_edges);
407     }
408
409     if (diff < DIFF_HARD) {
410         ret->linedsf = NULL;
411     } else {
412         ret->linedsf = snew_dsf(state->game_grid->num_edges);
413     }
414
415     return ret;
416 }
417
418 static void free_solver_state(solver_state *sstate) {
419     if (sstate) {
420         free_game(sstate->state);
421         sfree(sstate->dotdsf);
422         sfree(sstate->looplen);
423         sfree(sstate->dot_solved);
424         sfree(sstate->face_solved);
425         sfree(sstate->dot_yes_count);
426         sfree(sstate->dot_no_count);
427         sfree(sstate->face_yes_count);
428         sfree(sstate->face_no_count);
429
430         /* OK, because sfree(NULL) is a no-op */
431         sfree(sstate->dlines);
432         sfree(sstate->linedsf);
433
434         sfree(sstate);
435     }
436 }
437
438 static solver_state *dup_solver_state(const solver_state *sstate) {
439     game_state *state = sstate->state;
440     int num_dots = state->game_grid->num_dots;
441     int num_faces = state->game_grid->num_faces;
442     int num_edges = state->game_grid->num_edges;
443     solver_state *ret = snew(solver_state);
444
445     ret->state = state = dup_game(sstate->state);
446
447     ret->solver_status = sstate->solver_status;
448     ret->diff = sstate->diff;
449
450     ret->dotdsf = snewn(num_dots, int);
451     ret->looplen = snewn(num_dots, int);
452     memcpy(ret->dotdsf, sstate->dotdsf,
453            num_dots * sizeof(int));
454     memcpy(ret->looplen, sstate->looplen,
455            num_dots * sizeof(int));
456
457     ret->dot_solved = snewn(num_dots, char);
458     ret->face_solved = snewn(num_faces, char);
459     memcpy(ret->dot_solved, sstate->dot_solved, num_dots);
460     memcpy(ret->face_solved, sstate->face_solved, num_faces);
461
462     ret->dot_yes_count = snewn(num_dots, char);
463     memcpy(ret->dot_yes_count, sstate->dot_yes_count, num_dots);
464     ret->dot_no_count = snewn(num_dots, char);
465     memcpy(ret->dot_no_count, sstate->dot_no_count, num_dots);
466
467     ret->face_yes_count = snewn(num_faces, char);
468     memcpy(ret->face_yes_count, sstate->face_yes_count, num_faces);
469     ret->face_no_count = snewn(num_faces, char);
470     memcpy(ret->face_no_count, sstate->face_no_count, num_faces);
471
472     if (sstate->dlines) {
473         ret->dlines = snewn(2*num_edges, char);
474         memcpy(ret->dlines, sstate->dlines,
475                2*num_edges);
476     } else {
477         ret->dlines = NULL;
478     }
479
480     if (sstate->linedsf) {
481         ret->linedsf = snewn(num_edges, int);
482         memcpy(ret->linedsf, sstate->linedsf,
483                num_edges * sizeof(int));
484     } else {
485         ret->linedsf = NULL;
486     }
487
488     return ret;
489 }
490
491 static game_params *default_params(void)
492 {
493     game_params *ret = snew(game_params);
494
495 #ifdef SLOW_SYSTEM
496     ret->h = 7;
497     ret->w = 7;
498 #else
499     ret->h = 10;
500     ret->w = 10;
501 #endif
502     ret->diff = DIFF_EASY;
503     ret->type = 0;
504
505     return ret;
506 }
507
508 static game_params *dup_params(const game_params *params)
509 {
510     game_params *ret = snew(game_params);
511
512     *ret = *params;                       /* structure copy */
513     return ret;
514 }
515
516 static const game_params loopy_presets_top[] = {
517 #ifdef SMALL_SCREEN
518     {  7,  7, DIFF_EASY,   LOOPY_GRID_SQUARE },
519     {  7,  7, DIFF_NORMAL, LOOPY_GRID_SQUARE },
520     {  7,  7, DIFF_HARD,   LOOPY_GRID_SQUARE },
521     {  7,  7, DIFF_HARD,   LOOPY_GRID_TRIANGULAR },
522     {  5,  5, DIFF_HARD,   LOOPY_GRID_SNUBSQUARE },
523     {  7,  7, DIFF_HARD,   LOOPY_GRID_CAIRO },
524     {  5,  5, DIFF_HARD,   LOOPY_GRID_KITE },
525     {  6,  6, DIFF_HARD,   LOOPY_GRID_PENROSE_P2 },
526     {  6,  6, DIFF_HARD,   LOOPY_GRID_PENROSE_P3 },
527 #else
528     {  7,  7, DIFF_EASY,   LOOPY_GRID_SQUARE },
529     { 10, 10, DIFF_EASY,   LOOPY_GRID_SQUARE },
530     {  7,  7, DIFF_NORMAL, LOOPY_GRID_SQUARE },
531     { 10, 10, DIFF_NORMAL, LOOPY_GRID_SQUARE },
532     {  7,  7, DIFF_HARD,   LOOPY_GRID_SQUARE },
533     { 10, 10, DIFF_HARD,   LOOPY_GRID_SQUARE },
534     { 12, 10, DIFF_HARD,   LOOPY_GRID_TRIANGULAR },
535     {  7,  7, DIFF_HARD,   LOOPY_GRID_SNUBSQUARE },
536     {  9,  9, DIFF_HARD,   LOOPY_GRID_CAIRO },
537     {  5,  5, DIFF_HARD,   LOOPY_GRID_KITE },
538     { 10, 10, DIFF_HARD,   LOOPY_GRID_PENROSE_P2 },
539     { 10, 10, DIFF_HARD,   LOOPY_GRID_PENROSE_P3 },
540 #endif
541 };
542
543 static const game_params loopy_presets_more[] = {
544 #ifdef SMALL_SCREEN
545     {  7,  7, DIFF_HARD,   LOOPY_GRID_HONEYCOMB },
546     {  5,  4, DIFF_HARD,   LOOPY_GRID_GREATHEXAGONAL },
547     {  5,  5, DIFF_HARD,   LOOPY_GRID_OCTAGONAL },
548     {  3,  3, DIFF_HARD,   LOOPY_GRID_FLORET },
549     {  3,  3, DIFF_HARD,   LOOPY_GRID_DODECAGONAL },
550     {  3,  3, DIFF_HARD,   LOOPY_GRID_GREATDODECAGONAL },
551     {  3,  2, DIFF_HARD,   LOOPY_GRID_GREATGREATDODECAGONAL },
552 #else
553     { 10, 10, DIFF_HARD,   LOOPY_GRID_HONEYCOMB },
554     {  5,  4, DIFF_HARD,   LOOPY_GRID_GREATHEXAGONAL },
555     {  7,  7, DIFF_HARD,   LOOPY_GRID_OCTAGONAL },
556     {  5,  5, DIFF_HARD,   LOOPY_GRID_FLORET },
557     {  5,  4, DIFF_HARD,   LOOPY_GRID_DODECAGONAL },
558     {  5,  4, DIFF_HARD,   LOOPY_GRID_GREATDODECAGONAL },
559     {  5,  3, DIFF_HARD,   LOOPY_GRID_GREATGREATDODECAGONAL },
560 #endif
561 };
562
563 static void preset_menu_add_preset_with_title(struct preset_menu *menu,
564                                               const game_params *params)
565 {
566     char buf[80];
567     game_params *dup_params;
568
569     sprintf(buf, "%dx%d %s - %s", params->h, params->w,
570             gridnames[params->type], diffnames[params->diff]);
571
572     dup_params = snew(game_params);
573     *dup_params = *params;
574
575     preset_menu_add_preset(menu, dupstr(buf), dup_params);
576 }
577
578 static struct preset_menu *game_preset_menu(void)
579 {
580     struct preset_menu *top, *more;
581     int i;
582
583     top = preset_menu_new();
584     for (i = 0; i < lenof(loopy_presets_top); i++)
585         preset_menu_add_preset_with_title(top, &loopy_presets_top[i]);
586
587     more = preset_menu_add_submenu(top, dupstr("More..."));
588     for (i = 0; i < lenof(loopy_presets_more); i++)
589         preset_menu_add_preset_with_title(more, &loopy_presets_more[i]);
590
591     return top;
592 }
593
594 static void free_params(game_params *params)
595 {
596     sfree(params);
597 }
598
599 static void decode_params(game_params *params, char const *string)
600 {
601     params->h = params->w = atoi(string);
602     params->diff = DIFF_EASY;
603     while (*string && isdigit((unsigned char)*string)) string++;
604     if (*string == 'x') {
605         string++;
606         params->h = atoi(string);
607         while (*string && isdigit((unsigned char)*string)) string++;
608     }
609     if (*string == 't') {
610         string++;
611         params->type = atoi(string);
612         while (*string && isdigit((unsigned char)*string)) string++;
613     }
614     if (*string == 'd') {
615         int i;
616         string++;
617         for (i = 0; i < DIFF_MAX; i++)
618             if (*string == diffchars[i])
619                 params->diff = i;
620         if (*string) string++;
621     }
622 }
623
624 static char *encode_params(const game_params *params, int full)
625 {
626     char str[80];
627     sprintf(str, "%dx%dt%d", params->w, params->h, params->type);
628     if (full)
629         sprintf(str + strlen(str), "d%c", diffchars[params->diff]);
630     return dupstr(str);
631 }
632
633 static config_item *game_configure(const game_params *params)
634 {
635     config_item *ret;
636     char buf[80];
637
638     ret = snewn(5, config_item);
639
640     ret[0].name = "Width";
641     ret[0].type = C_STRING;
642     sprintf(buf, "%d", params->w);
643     ret[0].u.string.sval = dupstr(buf);
644
645     ret[1].name = "Height";
646     ret[1].type = C_STRING;
647     sprintf(buf, "%d", params->h);
648     ret[1].u.string.sval = dupstr(buf);
649
650     ret[2].name = "Grid type";
651     ret[2].type = C_CHOICES;
652     ret[2].u.choices.choicenames = GRID_CONFIGS;
653     ret[2].u.choices.selected = params->type;
654
655     ret[3].name = "Difficulty";
656     ret[3].type = C_CHOICES;
657     ret[3].u.choices.choicenames = DIFFCONFIG;
658     ret[3].u.choices.selected = params->diff;
659
660     ret[4].name = NULL;
661     ret[4].type = C_END;
662
663     return ret;
664 }
665
666 static game_params *custom_params(const config_item *cfg)
667 {
668     game_params *ret = snew(game_params);
669
670     ret->w = atoi(cfg[0].u.string.sval);
671     ret->h = atoi(cfg[1].u.string.sval);
672     ret->type = cfg[2].u.choices.selected;
673     ret->diff = cfg[3].u.choices.selected;
674
675     return ret;
676 }
677
678 static const char *validate_params(const game_params *params, int full)
679 {
680     if (params->type < 0 || params->type >= NUM_GRID_TYPES)
681         return "Illegal grid type";
682     if (params->w < grid_size_limits[params->type].amin ||
683         params->h < grid_size_limits[params->type].amin)
684         return grid_size_limits[params->type].aerr;
685     if (params->w < grid_size_limits[params->type].omin &&
686         params->h < grid_size_limits[params->type].omin)
687         return grid_size_limits[params->type].oerr;
688
689     /*
690      * This shouldn't be able to happen at all, since decode_params
691      * and custom_params will never generate anything that isn't
692      * within range.
693      */
694     assert(params->diff < DIFF_MAX);
695
696     return NULL;
697 }
698
699 /* Returns a newly allocated string describing the current puzzle */
700 static char *state_to_text(const game_state *state)
701 {
702     grid *g = state->game_grid;
703     char *retval;
704     int num_faces = g->num_faces;
705     char *description = snewn(num_faces + 1, char);
706     char *dp = description;
707     int empty_count = 0;
708     int i;
709
710     for (i = 0; i < num_faces; i++) {
711         if (state->clues[i] < 0) {
712             if (empty_count > 25) {
713                 dp += sprintf(dp, "%c", (int)(empty_count + 'a' - 1));
714                 empty_count = 0;
715             }
716             empty_count++;
717         } else {
718             if (empty_count) {
719                 dp += sprintf(dp, "%c", (int)(empty_count + 'a' - 1));
720                 empty_count = 0;
721             }
722             dp += sprintf(dp, "%c", (int)CLUE2CHAR(state->clues[i]));
723         }
724     }
725
726     if (empty_count)
727         dp += sprintf(dp, "%c", (int)(empty_count + 'a' - 1));
728
729     retval = dupstr(description);
730     sfree(description);
731
732     return retval;
733 }
734
735 #define GRID_DESC_SEP '_'
736
737 /* Splits up a (optional) grid_desc from the game desc. Returns the
738  * grid_desc (which needs freeing) and updates the desc pointer to
739  * start of real desc, or returns NULL if no desc. */
740 static char *extract_grid_desc(const char **desc)
741 {
742     char *sep = strchr(*desc, GRID_DESC_SEP), *gd;
743     int gd_len;
744
745     if (!sep) return NULL;
746
747     gd_len = sep - (*desc);
748     gd = snewn(gd_len+1, char);
749     memcpy(gd, *desc, gd_len);
750     gd[gd_len] = '\0';
751
752     *desc = sep+1;
753
754     return gd;
755 }
756
757 /* We require that the params pass the test in validate_params and that the
758  * description fills the entire game area */
759 static const char *validate_desc(const game_params *params, const char *desc)
760 {
761     int count = 0;
762     grid *g;
763     char *grid_desc, *ret;
764
765     /* It's pretty inefficient to do this just for validation. All we need to
766      * know is the precise number of faces. */
767     grid_desc = extract_grid_desc(&desc);
768     ret = grid_validate_desc(grid_types[params->type], params->w, params->h, grid_desc);
769     if (ret) return ret;
770
771     g = loopy_generate_grid(params, grid_desc);
772     if (grid_desc) sfree(grid_desc);
773
774     for (; *desc; ++desc) {
775         if ((*desc >= '0' && *desc <= '9') || (*desc >= 'A' && *desc <= 'Z')) {
776             count++;
777             continue;
778         }
779         if (*desc >= 'a') {
780             count += *desc - 'a' + 1;
781             continue;
782         }
783         return "Unknown character in description";
784     }
785
786     if (count < g->num_faces)
787         return "Description too short for board size";
788     if (count > g->num_faces)
789         return "Description too long for board size";
790
791     grid_free(g);
792
793     return NULL;
794 }
795
796 /* Sums the lengths of the numbers in range [0,n) */
797 /* See equivalent function in solo.c for justification of this. */
798 static int len_0_to_n(int n)
799 {
800     int len = 1; /* Counting 0 as a bit of a special case */
801     int i;
802
803     for (i = 1; i < n; i *= 10) {
804         len += max(n - i, 0);
805     }
806
807     return len;
808 }
809
810 static char *encode_solve_move(const game_state *state)
811 {
812     int len;
813     char *ret, *p;
814     int i;
815     int num_edges = state->game_grid->num_edges;
816
817     /* This is going to return a string representing the moves needed to set
818      * every line in a grid to be the same as the ones in 'state'.  The exact
819      * length of this string is predictable. */
820
821     len = 1;  /* Count the 'S' prefix */
822     /* Numbers in all lines */
823     len += len_0_to_n(num_edges);
824     /* For each line we also have a letter */
825     len += num_edges;
826
827     ret = snewn(len + 1, char);
828     p = ret;
829
830     p += sprintf(p, "S");
831
832     for (i = 0; i < num_edges; i++) {
833         switch (state->lines[i]) {
834           case LINE_YES:
835             p += sprintf(p, "%dy", i);
836             break;
837           case LINE_NO:
838             p += sprintf(p, "%dn", i);
839             break;
840         }
841     }
842
843     /* No point in doing sums like that if they're going to be wrong */
844     assert(strlen(ret) <= (size_t)len);
845     return ret;
846 }
847
848 static game_ui *new_ui(const game_state *state)
849 {
850     return NULL;
851 }
852
853 static void free_ui(game_ui *ui)
854 {
855 }
856
857 static char *encode_ui(const game_ui *ui)
858 {
859     return NULL;
860 }
861
862 static void decode_ui(game_ui *ui, const char *encoding)
863 {
864 }
865
866 static void game_changed_state(game_ui *ui, const game_state *oldstate,
867                                const game_state *newstate)
868 {
869 }
870
871 static void game_compute_size(const game_params *params, int tilesize,
872                               int *x, int *y)
873 {
874     int grid_width, grid_height, rendered_width, rendered_height;
875     int g_tilesize;
876
877     grid_compute_size(grid_types[params->type], params->w, params->h,
878                       &g_tilesize, &grid_width, &grid_height);
879
880     /* multiply first to minimise rounding error on integer division */
881     rendered_width = grid_width * tilesize / g_tilesize;
882     rendered_height = grid_height * tilesize / g_tilesize;
883     *x = rendered_width + 2 * BORDER(tilesize) + 1;
884     *y = rendered_height + 2 * BORDER(tilesize) + 1;
885 }
886
887 static void game_set_size(drawing *dr, game_drawstate *ds,
888                           const game_params *params, int tilesize)
889 {
890     ds->tilesize = tilesize;
891 }
892
893 static float *game_colours(frontend *fe, int *ncolours)
894 {
895     float *ret = snewn(3 * NCOLOURS, float);
896
897     frontend_default_colour(fe, &ret[COL_BACKGROUND * 3]);
898
899     ret[COL_FOREGROUND * 3 + 0] = 0.0F;
900     ret[COL_FOREGROUND * 3 + 1] = 0.0F;
901     ret[COL_FOREGROUND * 3 + 2] = 0.0F;
902
903     /*
904      * We want COL_LINEUNKNOWN to be a yellow which is a bit darker
905      * than the background. (I previously set it to 0.8,0.8,0, but
906      * found that this went badly with the 0.8,0.8,0.8 favoured as a
907      * background by the Java frontend.)
908      */
909     ret[COL_LINEUNKNOWN * 3 + 0] = ret[COL_BACKGROUND * 3 + 0] * 0.9F;
910     ret[COL_LINEUNKNOWN * 3 + 1] = ret[COL_BACKGROUND * 3 + 1] * 0.9F;
911     ret[COL_LINEUNKNOWN * 3 + 2] = 0.0F;
912
913     ret[COL_HIGHLIGHT * 3 + 0] = 1.0F;
914     ret[COL_HIGHLIGHT * 3 + 1] = 1.0F;
915     ret[COL_HIGHLIGHT * 3 + 2] = 1.0F;
916
917     ret[COL_MISTAKE * 3 + 0] = 1.0F;
918     ret[COL_MISTAKE * 3 + 1] = 0.0F;
919     ret[COL_MISTAKE * 3 + 2] = 0.0F;
920
921     ret[COL_SATISFIED * 3 + 0] = 0.0F;
922     ret[COL_SATISFIED * 3 + 1] = 0.0F;
923     ret[COL_SATISFIED * 3 + 2] = 0.0F;
924
925     /* We want the faint lines to be a bit darker than the background.
926      * Except if the background is pretty dark already; then it ought to be a
927      * bit lighter.  Oy vey.
928      */
929     ret[COL_FAINT * 3 + 0] = ret[COL_BACKGROUND * 3 + 0] * 0.9F;
930     ret[COL_FAINT * 3 + 1] = ret[COL_BACKGROUND * 3 + 1] * 0.9F;
931     ret[COL_FAINT * 3 + 2] = ret[COL_BACKGROUND * 3 + 2] * 0.9F;
932
933     *ncolours = NCOLOURS;
934     return ret;
935 }
936
937 static game_drawstate *game_new_drawstate(drawing *dr, const game_state *state)
938 {
939     struct game_drawstate *ds = snew(struct game_drawstate);
940     int num_faces = state->game_grid->num_faces;
941     int num_edges = state->game_grid->num_edges;
942     int i;
943
944     ds->tilesize = 0;
945     ds->started = 0;
946     ds->lines = snewn(num_edges, char);
947     ds->clue_error = snewn(num_faces, char);
948     ds->clue_satisfied = snewn(num_faces, char);
949     ds->textx = snewn(num_faces, int);
950     ds->texty = snewn(num_faces, int);
951     ds->flashing = 0;
952
953     memset(ds->lines, LINE_UNKNOWN, num_edges);
954     memset(ds->clue_error, 0, num_faces);
955     memset(ds->clue_satisfied, 0, num_faces);
956     for (i = 0; i < num_faces; i++)
957         ds->textx[i] = ds->texty[i] = -1;
958
959     return ds;
960 }
961
962 static void game_free_drawstate(drawing *dr, game_drawstate *ds)
963 {
964     sfree(ds->textx);
965     sfree(ds->texty);
966     sfree(ds->clue_error);
967     sfree(ds->clue_satisfied);
968     sfree(ds->lines);
969     sfree(ds);
970 }
971
972 static int game_timing_state(const game_state *state, game_ui *ui)
973 {
974     return TRUE;
975 }
976
977 static float game_anim_length(const game_state *oldstate,
978                               const game_state *newstate, int dir, game_ui *ui)
979 {
980     return 0.0F;
981 }
982
983 static int game_can_format_as_text_now(const game_params *params)
984 {
985     if (params->type != 0)
986         return FALSE;
987     return TRUE;
988 }
989
990 static char *game_text_format(const game_state *state)
991 {
992     int w, h, W, H;
993     int x, y, i;
994     int cell_size;
995     char *ret;
996     grid *g = state->game_grid;
997     grid_face *f;
998
999     assert(state->grid_type == 0);
1000
1001     /* Work out the basic size unit */
1002     f = g->faces; /* first face */
1003     assert(f->order == 4);
1004     /* The dots are ordered clockwise, so the two opposite
1005      * corners are guaranteed to span the square */
1006     cell_size = abs(f->dots[0]->x - f->dots[2]->x);
1007
1008     w = (g->highest_x - g->lowest_x) / cell_size;
1009     h = (g->highest_y - g->lowest_y) / cell_size;
1010
1011     /* Create a blank "canvas" to "draw" on */
1012     W = 2 * w + 2;
1013     H = 2 * h + 1;
1014     ret = snewn(W * H + 1, char);
1015     for (y = 0; y < H; y++) {
1016         for (x = 0; x < W-1; x++) {
1017             ret[y*W + x] = ' ';
1018         }
1019         ret[y*W + W-1] = '\n';
1020     }
1021     ret[H*W] = '\0';
1022
1023     /* Fill in edge info */
1024     for (i = 0; i < g->num_edges; i++) {
1025         grid_edge *e = g->edges + i;
1026         /* Cell coordinates, from (0,0) to (w-1,h-1) */
1027         int x1 = (e->dot1->x - g->lowest_x) / cell_size;
1028         int x2 = (e->dot2->x - g->lowest_x) / cell_size;
1029         int y1 = (e->dot1->y - g->lowest_y) / cell_size;
1030         int y2 = (e->dot2->y - g->lowest_y) / cell_size;
1031         /* Midpoint, in canvas coordinates (canvas coordinates are just twice
1032          * cell coordinates) */
1033         x = x1 + x2;
1034         y = y1 + y2;
1035         switch (state->lines[i]) {
1036           case LINE_YES:
1037             ret[y*W + x] = (y1 == y2) ? '-' : '|';
1038             break;
1039           case LINE_NO:
1040             ret[y*W + x] = 'x';
1041             break;
1042           case LINE_UNKNOWN:
1043             break; /* already a space */
1044           default:
1045             assert(!"Illegal line state");
1046         }
1047     }
1048
1049     /* Fill in clues */
1050     for (i = 0; i < g->num_faces; i++) {
1051         int x1, x2, y1, y2;
1052
1053         f = g->faces + i;
1054         assert(f->order == 4);
1055         /* Cell coordinates, from (0,0) to (w-1,h-1) */
1056         x1 = (f->dots[0]->x - g->lowest_x) / cell_size;
1057         x2 = (f->dots[2]->x - g->lowest_x) / cell_size;
1058         y1 = (f->dots[0]->y - g->lowest_y) / cell_size;
1059         y2 = (f->dots[2]->y - g->lowest_y) / cell_size;
1060         /* Midpoint, in canvas coordinates */
1061         x = x1 + x2;
1062         y = y1 + y2;
1063         ret[y*W + x] = CLUE2CHAR(state->clues[i]);
1064     }
1065     return ret;
1066 }
1067
1068 /* ----------------------------------------------------------------------
1069  * Debug code
1070  */
1071
1072 #ifdef DEBUG_CACHES
1073 static void check_caches(const solver_state* sstate)
1074 {
1075     int i;
1076     const game_state *state = sstate->state;
1077     const grid *g = state->game_grid;
1078
1079     for (i = 0; i < g->num_dots; i++) {
1080         assert(dot_order(state, i, LINE_YES) == sstate->dot_yes_count[i]);
1081         assert(dot_order(state, i, LINE_NO) == sstate->dot_no_count[i]);
1082     }
1083
1084     for (i = 0; i < g->num_faces; i++) {
1085         assert(face_order(state, i, LINE_YES) == sstate->face_yes_count[i]);
1086         assert(face_order(state, i, LINE_NO) == sstate->face_no_count[i]);
1087     }
1088 }
1089
1090 #if 0
1091 #define check_caches(s) \
1092     do { \
1093         fprintf(stderr, "check_caches at line %d\n", __LINE__); \
1094         check_caches(s); \
1095     } while (0)
1096 #endif
1097 #endif /* DEBUG_CACHES */
1098
1099 /* ----------------------------------------------------------------------
1100  * Solver utility functions
1101  */
1102
1103 /* Sets the line (with index i) to the new state 'line_new', and updates
1104  * the cached counts of any affected faces and dots.
1105  * Returns TRUE if this actually changed the line's state. */
1106 static int solver_set_line(solver_state *sstate, int i,
1107                            enum line_state line_new
1108 #ifdef SHOW_WORKING
1109                            , const char *reason
1110 #endif
1111                            )
1112 {
1113     game_state *state = sstate->state;
1114     grid *g;
1115     grid_edge *e;
1116
1117     assert(line_new != LINE_UNKNOWN);
1118
1119     check_caches(sstate);
1120
1121     if (state->lines[i] == line_new) {
1122         return FALSE; /* nothing changed */
1123     }
1124     state->lines[i] = line_new;
1125
1126 #ifdef SHOW_WORKING
1127     fprintf(stderr, "solver: set line [%d] to %s (%s)\n",
1128             i, line_new == LINE_YES ? "YES" : "NO",
1129             reason);
1130 #endif
1131
1132     g = state->game_grid;
1133     e = g->edges + i;
1134
1135     /* Update the cache for both dots and both faces affected by this. */
1136     if (line_new == LINE_YES) {
1137         sstate->dot_yes_count[e->dot1 - g->dots]++;
1138         sstate->dot_yes_count[e->dot2 - g->dots]++;
1139         if (e->face1) {
1140             sstate->face_yes_count[e->face1 - g->faces]++;
1141         }
1142         if (e->face2) {
1143             sstate->face_yes_count[e->face2 - g->faces]++;
1144         }
1145     } else {
1146         sstate->dot_no_count[e->dot1 - g->dots]++;
1147         sstate->dot_no_count[e->dot2 - g->dots]++;
1148         if (e->face1) {
1149             sstate->face_no_count[e->face1 - g->faces]++;
1150         }
1151         if (e->face2) {
1152             sstate->face_no_count[e->face2 - g->faces]++;
1153         }
1154     }
1155
1156     check_caches(sstate);
1157     return TRUE;
1158 }
1159
1160 #ifdef SHOW_WORKING
1161 #define solver_set_line(a, b, c) \
1162     solver_set_line(a, b, c, __FUNCTION__)
1163 #endif
1164
1165 /*
1166  * Merge two dots due to the existence of an edge between them.
1167  * Updates the dsf tracking equivalence classes, and keeps track of
1168  * the length of path each dot is currently a part of.
1169  * Returns TRUE if the dots were already linked, ie if they are part of a
1170  * closed loop, and false otherwise.
1171  */
1172 static int merge_dots(solver_state *sstate, int edge_index)
1173 {
1174     int i, j, len;
1175     grid *g = sstate->state->game_grid;
1176     grid_edge *e = g->edges + edge_index;
1177
1178     i = e->dot1 - g->dots;
1179     j = e->dot2 - g->dots;
1180
1181     i = dsf_canonify(sstate->dotdsf, i);
1182     j = dsf_canonify(sstate->dotdsf, j);
1183
1184     if (i == j) {
1185         return TRUE;
1186     } else {
1187         len = sstate->looplen[i] + sstate->looplen[j];
1188         dsf_merge(sstate->dotdsf, i, j);
1189         i = dsf_canonify(sstate->dotdsf, i);
1190         sstate->looplen[i] = len;
1191         return FALSE;
1192     }
1193 }
1194
1195 /* Merge two lines because the solver has deduced that they must be either
1196  * identical or opposite.   Returns TRUE if this is new information, otherwise
1197  * FALSE. */
1198 static int merge_lines(solver_state *sstate, int i, int j, int inverse
1199 #ifdef SHOW_WORKING
1200                        , const char *reason
1201 #endif
1202                        )
1203 {
1204     int inv_tmp;
1205
1206     assert(i < sstate->state->game_grid->num_edges);
1207     assert(j < sstate->state->game_grid->num_edges);
1208
1209     i = edsf_canonify(sstate->linedsf, i, &inv_tmp);
1210     inverse ^= inv_tmp;
1211     j = edsf_canonify(sstate->linedsf, j, &inv_tmp);
1212     inverse ^= inv_tmp;
1213
1214     edsf_merge(sstate->linedsf, i, j, inverse);
1215
1216 #ifdef SHOW_WORKING
1217     if (i != j) {
1218         fprintf(stderr, "%s [%d] [%d] %s(%s)\n",
1219                 __FUNCTION__, i, j,
1220                 inverse ? "inverse " : "", reason);
1221     }
1222 #endif
1223     return (i != j);
1224 }
1225
1226 #ifdef SHOW_WORKING
1227 #define merge_lines(a, b, c, d) \
1228     merge_lines(a, b, c, d, __FUNCTION__)
1229 #endif
1230
1231 /* Count the number of lines of a particular type currently going into the
1232  * given dot. */
1233 static int dot_order(const game_state* state, int dot, char line_type)
1234 {
1235     int n = 0;
1236     grid *g = state->game_grid;
1237     grid_dot *d = g->dots + dot;
1238     int i;
1239
1240     for (i = 0; i < d->order; i++) {
1241         grid_edge *e = d->edges[i];
1242         if (state->lines[e - g->edges] == line_type)
1243             ++n;
1244     }
1245     return n;
1246 }
1247
1248 /* Count the number of lines of a particular type currently surrounding the
1249  * given face */
1250 static int face_order(const game_state* state, int face, char line_type)
1251 {
1252     int n = 0;
1253     grid *g = state->game_grid;
1254     grid_face *f = g->faces + face;
1255     int i;
1256
1257     for (i = 0; i < f->order; i++) {
1258         grid_edge *e = f->edges[i];
1259         if (state->lines[e - g->edges] == line_type)
1260             ++n;
1261     }
1262     return n;
1263 }
1264
1265 /* Set all lines bordering a dot of type old_type to type new_type
1266  * Return value tells caller whether this function actually did anything */
1267 static int dot_setall(solver_state *sstate, int dot,
1268                       char old_type, char new_type)
1269 {
1270     int retval = FALSE, r;
1271     game_state *state = sstate->state;
1272     grid *g;
1273     grid_dot *d;
1274     int i;
1275
1276     if (old_type == new_type)
1277         return FALSE;
1278
1279     g = state->game_grid;
1280     d = g->dots + dot;
1281
1282     for (i = 0; i < d->order; i++) {
1283         int line_index = d->edges[i] - g->edges;
1284         if (state->lines[line_index] == old_type) {
1285             r = solver_set_line(sstate, line_index, new_type);
1286             assert(r == TRUE);
1287             retval = TRUE;
1288         }
1289     }
1290     return retval;
1291 }
1292
1293 /* Set all lines bordering a face of type old_type to type new_type */
1294 static int face_setall(solver_state *sstate, int face,
1295                        char old_type, char new_type)
1296 {
1297     int retval = FALSE, r;
1298     game_state *state = sstate->state;
1299     grid *g;
1300     grid_face *f;
1301     int i;
1302
1303     if (old_type == new_type)
1304         return FALSE;
1305
1306     g = state->game_grid;
1307     f = g->faces + face;
1308
1309     for (i = 0; i < f->order; i++) {
1310         int line_index = f->edges[i] - g->edges;
1311         if (state->lines[line_index] == old_type) {
1312             r = solver_set_line(sstate, line_index, new_type);
1313             assert(r == TRUE);
1314             retval = TRUE;
1315         }
1316     }
1317     return retval;
1318 }
1319
1320 /* ----------------------------------------------------------------------
1321  * Loop generation and clue removal
1322  */
1323
1324 static void add_full_clues(game_state *state, random_state *rs)
1325 {
1326     signed char *clues = state->clues;
1327     grid *g = state->game_grid;
1328     char *board = snewn(g->num_faces, char);
1329     int i;
1330
1331     generate_loop(g, board, rs, NULL, NULL);
1332
1333     /* Fill out all the clues by initialising to 0, then iterating over
1334      * all edges and incrementing each clue as we find edges that border
1335      * between BLACK/WHITE faces.  While we're at it, we verify that the
1336      * algorithm does work, and there aren't any GREY faces still there. */
1337     memset(clues, 0, g->num_faces);
1338     for (i = 0; i < g->num_edges; i++) {
1339         grid_edge *e = g->edges + i;
1340         grid_face *f1 = e->face1;
1341         grid_face *f2 = e->face2;
1342         enum face_colour c1 = FACE_COLOUR(f1);
1343         enum face_colour c2 = FACE_COLOUR(f2);
1344         assert(c1 != FACE_GREY);
1345         assert(c2 != FACE_GREY);
1346         if (c1 != c2) {
1347             if (f1) clues[f1 - g->faces]++;
1348             if (f2) clues[f2 - g->faces]++;
1349         }
1350     }
1351     sfree(board);
1352 }
1353
1354
1355 static int game_has_unique_soln(const game_state *state, int diff)
1356 {
1357     int ret;
1358     solver_state *sstate_new;
1359     solver_state *sstate = new_solver_state((game_state *)state, diff);
1360
1361     sstate_new = solve_game_rec(sstate);
1362
1363     assert(sstate_new->solver_status != SOLVER_MISTAKE);
1364     ret = (sstate_new->solver_status == SOLVER_SOLVED);
1365
1366     free_solver_state(sstate_new);
1367     free_solver_state(sstate);
1368
1369     return ret;
1370 }
1371
1372
1373 /* Remove clues one at a time at random. */
1374 static game_state *remove_clues(game_state *state, random_state *rs,
1375                                 int diff)
1376 {
1377     int *face_list;
1378     int num_faces = state->game_grid->num_faces;
1379     game_state *ret = dup_game(state), *saved_ret;
1380     int n;
1381
1382     /* We need to remove some clues.  We'll do this by forming a list of all
1383      * available clues, shuffling it, then going along one at a
1384      * time clearing each clue in turn for which doing so doesn't render the
1385      * board unsolvable. */
1386     face_list = snewn(num_faces, int);
1387     for (n = 0; n < num_faces; ++n) {
1388         face_list[n] = n;
1389     }
1390
1391     shuffle(face_list, num_faces, sizeof(int), rs);
1392
1393     for (n = 0; n < num_faces; ++n) {
1394         saved_ret = dup_game(ret);
1395         ret->clues[face_list[n]] = -1;
1396
1397         if (game_has_unique_soln(ret, diff)) {
1398             free_game(saved_ret);
1399         } else {
1400             free_game(ret);
1401             ret = saved_ret;
1402         }
1403     }
1404     sfree(face_list);
1405
1406     return ret;
1407 }
1408
1409
1410 static char *new_game_desc(const game_params *params, random_state *rs,
1411                            char **aux, int interactive)
1412 {
1413     /* solution and description both use run-length encoding in obvious ways */
1414     char *retval, *game_desc, *grid_desc;
1415     grid *g;
1416     game_state *state = snew(game_state);
1417     game_state *state_new;
1418
1419     grid_desc = grid_new_desc(grid_types[params->type], params->w, params->h, rs);
1420     state->game_grid = g = loopy_generate_grid(params, grid_desc);
1421
1422     state->clues = snewn(g->num_faces, signed char);
1423     state->lines = snewn(g->num_edges, char);
1424     state->line_errors = snewn(g->num_edges, unsigned char);
1425     state->exactly_one_loop = FALSE;
1426
1427     state->grid_type = params->type;
1428
1429     newboard_please:
1430
1431     memset(state->lines, LINE_UNKNOWN, g->num_edges);
1432     memset(state->line_errors, 0, g->num_edges);
1433
1434     state->solved = state->cheated = FALSE;
1435
1436     /* Get a new random solvable board with all its clues filled in.  Yes, this
1437      * can loop for ever if the params are suitably unfavourable, but
1438      * preventing games smaller than 4x4 seems to stop this happening */
1439     do {
1440         add_full_clues(state, rs);
1441     } while (!game_has_unique_soln(state, params->diff));
1442
1443     state_new = remove_clues(state, rs, params->diff);
1444     free_game(state);
1445     state = state_new;
1446
1447
1448     if (params->diff > 0 && game_has_unique_soln(state, params->diff-1)) {
1449 #ifdef SHOW_WORKING
1450         fprintf(stderr, "Rejecting board, it is too easy\n");
1451 #endif
1452         goto newboard_please;
1453     }
1454
1455     game_desc = state_to_text(state);
1456
1457     free_game(state);
1458
1459     if (grid_desc) {
1460         retval = snewn(strlen(grid_desc) + 1 + strlen(game_desc) + 1, char);
1461         sprintf(retval, "%s%c%s", grid_desc, (int)GRID_DESC_SEP, game_desc);
1462         sfree(grid_desc);
1463         sfree(game_desc);
1464     } else {
1465         retval = game_desc;
1466     }
1467
1468     assert(!validate_desc(params, retval));
1469
1470     return retval;
1471 }
1472
1473 static game_state *new_game(midend *me, const game_params *params,
1474                             const char *desc)
1475 {
1476     int i;
1477     game_state *state = snew(game_state);
1478     int empties_to_make = 0;
1479     int n,n2;
1480     const char *dp;
1481     char *grid_desc;
1482     grid *g;
1483     int num_faces, num_edges;
1484
1485     grid_desc = extract_grid_desc(&desc);
1486     state->game_grid = g = loopy_generate_grid(params, grid_desc);
1487     if (grid_desc) sfree(grid_desc);
1488
1489     dp = desc;
1490
1491     num_faces = g->num_faces;
1492     num_edges = g->num_edges;
1493
1494     state->clues = snewn(num_faces, signed char);
1495     state->lines = snewn(num_edges, char);
1496     state->line_errors = snewn(num_edges, unsigned char);
1497     state->exactly_one_loop = FALSE;
1498
1499     state->solved = state->cheated = FALSE;
1500
1501     state->grid_type = params->type;
1502
1503     for (i = 0; i < num_faces; i++) {
1504         if (empties_to_make) {
1505             empties_to_make--;
1506             state->clues[i] = -1;
1507             continue;
1508         }
1509
1510         assert(*dp);
1511         n = *dp - '0';
1512         n2 = *dp - 'A' + 10;
1513         if (n >= 0 && n < 10) {
1514             state->clues[i] = n;
1515         } else if (n2 >= 10 && n2 < 36) {
1516             state->clues[i] = n2;
1517         } else {
1518             n = *dp - 'a' + 1;
1519             assert(n > 0);
1520             state->clues[i] = -1;
1521             empties_to_make = n - 1;
1522         }
1523         ++dp;
1524     }
1525
1526     memset(state->lines, LINE_UNKNOWN, num_edges);
1527     memset(state->line_errors, 0, num_edges);
1528     return state;
1529 }
1530
1531 /* Calculates the line_errors data, and checks if the current state is a
1532  * solution */
1533 static int check_completion(game_state *state)
1534 {
1535     grid *g = state->game_grid;
1536     int i, ret;
1537     int *dsf, *component_state;
1538     int nsilly, nloop, npath, largest_comp, largest_size, total_pathsize;
1539     enum { COMP_NONE, COMP_LOOP, COMP_PATH, COMP_SILLY, COMP_EMPTY };
1540
1541     memset(state->line_errors, 0, g->num_edges);
1542
1543     /*
1544      * Find loops in the grid, and determine whether the puzzle is
1545      * solved.
1546      *
1547      * Loopy is a bit more complicated than most puzzles that care
1548      * about loop detection. In most of them, loops are simply
1549      * _forbidden_; so the obviously right way to do
1550      * error-highlighting during play is to light up a graph edge red
1551      * iff it is part of a loop, which is exactly what the centralised
1552      * findloop.c makes easy.
1553      *
1554      * But Loopy is unusual in that you're _supposed_ to be making a
1555      * loop - and yet _some_ loops are not the right loop. So we need
1556      * to be more discriminating, by identifying loops one by one and
1557      * then thinking about which ones to highlight, and so findloop.c
1558      * isn't quite the right tool for the job in this case.
1559      *
1560      * Worse still, consider situations in which the grid contains a
1561      * loop and also some non-loop edges: there are some cases like
1562      * this in which the user's intuitive expectation would be to
1563      * highlight the loop (if you're only about half way through the
1564      * puzzle and have accidentally made a little loop in some corner
1565      * of the grid), and others in which they'd be more likely to
1566      * expect you to highlight the non-loop edges (if you've just
1567      * closed off a whole loop that you thought was the entire
1568      * solution, but forgot some disconnected edges in a corner
1569      * somewhere). So while it's easy enough to check whether the
1570      * solution is _right_, highlighting the wrong parts is a tricky
1571      * problem for this puzzle!
1572      *
1573      * I'd quite like, in some situations, to identify the largest
1574      * loop among the player's YES edges, and then light up everything
1575      * other than that. But finding the longest cycle in a graph is an
1576      * NP-complete problem (because, in particular, it must return a
1577      * Hamilton cycle if one exists).
1578      *
1579      * However, I think we can make the problem tractable by
1580      * exercising the Puzzles principle that it isn't absolutely
1581      * necessary to highlight _all_ errors: the key point is that by
1582      * the time the user has filled in the whole grid, they should
1583      * either have seen a completion flash, or have _some_ error
1584      * highlight showing them why the solution isn't right. So in
1585      * principle it would be *just about* good enough to highlight
1586      * just one error in the whole grid, if there was really no better
1587      * way. But we'd like to highlight as many errors as possible.
1588      *
1589      * In this case, I think the simple approach is to make use of the
1590      * fact that no vertex may have degree > 2, and that's really
1591      * simple to detect. So the plan goes like this:
1592      *
1593      *  - Form the dsf of connected components of the graph vertices.
1594      *
1595      *  - Highlight an error at any vertex with degree > 2. (It so
1596      *    happens that we do this by lighting up all the edges
1597      *    incident to that vertex, but that's an output detail.)
1598      *
1599      *  - Any component that contains such a vertex is now excluded
1600      *    from further consideration, because it already has a
1601      *    highlight.
1602      *
1603      *  - The remaining components have no vertex with degree > 2, and
1604      *    hence they all consist of either a simple loop, or a simple
1605      *    path with two endpoints.
1606      *
1607      *  - For these purposes, group together all the paths and imagine
1608      *    them to be a single component (because in most normal
1609      *    situations the player will gradually build up the solution
1610      *    _not_ all in one connected segment, but as lots of separate
1611      *    little path pieces that gradually connect to each other).
1612      *
1613      *  - After doing that, if there is exactly one (sensible)
1614      *    component - be it a collection of paths or a loop - then
1615      *    highlight no further edge errors. (The former case is normal
1616      *    during play, and the latter is a potentially solved puzzle.)
1617      *
1618      *  - Otherwise, find the largest of the sensible components,
1619      *    leave that one unhighlighted, and light the rest up in red.
1620      */
1621
1622     dsf = snew_dsf(g->num_dots);
1623
1624     /* Build the dsf. */
1625     for (i = 0; i < g->num_edges; i++) {
1626         if (state->lines[i] == LINE_YES) {
1627             grid_edge *e = g->edges + i;
1628             int d1 = e->dot1 - g->dots, d2 = e->dot2 - g->dots;
1629             dsf_merge(dsf, d1, d2);
1630         }
1631     }
1632
1633     /* Initialise a state variable for each connected component. */
1634     component_state = snewn(g->num_dots, int);
1635     for (i = 0; i < g->num_dots; i++) {
1636         if (dsf_canonify(dsf, i) == i)
1637             component_state[i] = COMP_LOOP;
1638         else
1639             component_state[i] = COMP_NONE;
1640     }
1641
1642     /* Check for dots with degree > 3. Here we also spot dots of
1643      * degree 1 in which the user has marked all the non-edges as
1644      * LINE_NO, because those are also clear vertex-level errors, so
1645      * we give them the same treatment of excluding their connected
1646      * component from the subsequent loop analysis. */
1647     for (i = 0; i < g->num_dots; i++) {
1648         int comp = dsf_canonify(dsf, i);
1649         int yes = dot_order(state, i, LINE_YES);
1650         int unknown = dot_order(state, i, LINE_UNKNOWN);
1651         if ((yes == 1 && unknown == 0) || (yes >= 3)) {
1652             /* violation, so mark all YES edges as errors */
1653             grid_dot *d = g->dots + i;
1654             int j;
1655             for (j = 0; j < d->order; j++) {
1656                 int e = d->edges[j] - g->edges;
1657                 if (state->lines[e] == LINE_YES)
1658                     state->line_errors[e] = TRUE;
1659             }
1660             /* And mark this component as not worthy of further
1661              * consideration. */
1662             component_state[comp] = COMP_SILLY;
1663
1664         } else if (yes == 0) {
1665             /* A completely isolated dot must also be excluded it from
1666              * the subsequent loop highlighting pass, but we tag it
1667              * with a different enum value to avoid it counting
1668              * towards the components that inhibit returning a win
1669              * status. */
1670             component_state[comp] = COMP_EMPTY;
1671         } else if (yes == 1) {
1672             /* A dot with degree 1 that didn't fall into the 'clearly
1673              * erroneous' case above indicates that this connected
1674              * component will be a path rather than a loop - unless
1675              * something worse elsewhere in the component has
1676              * classified it as silly. */
1677             if (component_state[comp] != COMP_SILLY)
1678                 component_state[comp] = COMP_PATH;
1679         }
1680     }
1681
1682     /* Count up the components. Also, find the largest sensible
1683      * component. (Tie-breaking condition is derived from the order of
1684      * vertices in the grid data structure, which is fairly arbitrary
1685      * but at least stays stable throughout the game.) */
1686     nsilly = nloop = npath = 0;
1687     total_pathsize = 0;
1688     largest_comp = largest_size = -1;
1689     for (i = 0; i < g->num_dots; i++) {
1690         if (component_state[i] == COMP_SILLY) {
1691             nsilly++;
1692         } else if (component_state[i] == COMP_PATH) {
1693             total_pathsize += dsf_size(dsf, i);
1694             npath = 1;
1695         } else if (component_state[i] == COMP_LOOP) {
1696             int this_size;
1697
1698             nloop++;
1699
1700             if ((this_size = dsf_size(dsf, i)) > largest_size) {
1701                 largest_comp = i;
1702                 largest_size = this_size;
1703             }
1704         }
1705     }
1706     if (largest_size < total_pathsize) {
1707         largest_comp = -1;             /* means the paths */
1708         largest_size = total_pathsize;
1709     }
1710
1711     if (nloop > 0 && nloop + npath > 1) {
1712         /*
1713          * If there are at least two sensible components including at
1714          * least one loop, highlight all edges in every sensible
1715          * component that is not the largest one.
1716          */
1717         for (i = 0; i < g->num_edges; i++) {
1718             if (state->lines[i] == LINE_YES) {
1719                 grid_edge *e = g->edges + i;
1720                 int d1 = e->dot1 - g->dots; /* either endpoint is good enough */
1721                 int comp = dsf_canonify(dsf, d1);
1722                 if ((component_state[comp] == COMP_PATH &&
1723                      -1 != largest_comp) ||
1724                     (component_state[comp] == COMP_LOOP &&
1725                      comp != largest_comp))
1726                     state->line_errors[i] = TRUE;
1727             }
1728         }
1729     }
1730
1731     if (nloop == 1 && npath == 0 && nsilly == 0) {
1732         /*
1733          * If there is exactly one component and it is a loop, then
1734          * the puzzle is potentially complete, so check the clues.
1735          */
1736         ret = TRUE;
1737
1738         for (i = 0; i < g->num_faces; i++) {
1739             int c = state->clues[i];
1740             if (c >= 0 && face_order(state, i, LINE_YES) != c) {
1741                 ret = FALSE;
1742                 break;
1743             }
1744         }
1745
1746         /*
1747          * Also, whether or not the puzzle is actually complete, set
1748          * the flag that says this game_state has exactly one loop and
1749          * nothing else, which will be used to vary the semantics of
1750          * clue highlighting at display time.
1751          */
1752         state->exactly_one_loop = TRUE;
1753     } else {
1754         ret = FALSE;
1755         state->exactly_one_loop = FALSE;
1756     }
1757
1758     sfree(component_state);
1759     sfree(dsf);
1760
1761     return ret;
1762 }
1763
1764 /* ----------------------------------------------------------------------
1765  * Solver logic
1766  *
1767  * Our solver modes operate as follows.  Each mode also uses the modes above it.
1768  *
1769  *   Easy Mode
1770  *   Just implement the rules of the game.
1771  *
1772  *   Normal and Tricky Modes
1773  *   For each (adjacent) pair of lines through each dot we store a bit for
1774  *   whether at least one of them is on and whether at most one is on.  (If we
1775  *   know both or neither is on that's already stored more directly.)
1776  *
1777  *   Advanced Mode
1778  *   Use edsf data structure to make equivalence classes of lines that are
1779  *   known identical to or opposite to one another.
1780  */
1781
1782
1783 /* DLines:
1784  * For general grids, we consider "dlines" to be pairs of lines joined
1785  * at a dot.  The lines must be adjacent around the dot, so we can think of
1786  * a dline as being a dot+face combination.  Or, a dot+edge combination where
1787  * the second edge is taken to be the next clockwise edge from the dot.
1788  * Original loopy code didn't have this extra restriction of the lines being
1789  * adjacent.  From my tests with square grids, this extra restriction seems to
1790  * take little, if anything, away from the quality of the puzzles.
1791  * A dline can be uniquely identified by an edge/dot combination, given that
1792  * a dline-pair always goes clockwise around its common dot.  The edge/dot
1793  * combination can be represented by an edge/bool combination - if bool is
1794  * TRUE, use edge->dot1 else use edge->dot2.  So the total number of dlines is
1795  * exactly twice the number of edges in the grid - although the dlines
1796  * spanning the infinite face are not all that useful to the solver.
1797  * Note that, by convention, a dline goes clockwise around its common dot,
1798  * which means the dline goes anti-clockwise around its common face.
1799  */
1800
1801 /* Helper functions for obtaining an index into an array of dlines, given
1802  * various information.  We assume the grid layout conventions about how
1803  * the various lists are interleaved - see grid_make_consistent() for
1804  * details. */
1805
1806 /* i points to the first edge of the dline pair, reading clockwise around
1807  * the dot. */
1808 static int dline_index_from_dot(grid *g, grid_dot *d, int i)
1809 {
1810     grid_edge *e = d->edges[i];
1811     int ret;
1812 #ifdef DEBUG_DLINES
1813     grid_edge *e2;
1814     int i2 = i+1;
1815     if (i2 == d->order) i2 = 0;
1816     e2 = d->edges[i2];
1817 #endif
1818     ret = 2 * (e - g->edges) + ((e->dot1 == d) ? 1 : 0);
1819 #ifdef DEBUG_DLINES
1820     printf("dline_index_from_dot: d=%d,i=%d, edges [%d,%d] - %d\n",
1821            (int)(d - g->dots), i, (int)(e - g->edges),
1822            (int)(e2 - g->edges), ret);
1823 #endif
1824     return ret;
1825 }
1826 /* i points to the second edge of the dline pair, reading clockwise around
1827  * the face.  That is, the edges of the dline, starting at edge{i}, read
1828  * anti-clockwise around the face.  By layout conventions, the common dot
1829  * of the dline will be f->dots[i] */
1830 static int dline_index_from_face(grid *g, grid_face *f, int i)
1831 {
1832     grid_edge *e = f->edges[i];
1833     grid_dot *d = f->dots[i];
1834     int ret;
1835 #ifdef DEBUG_DLINES
1836     grid_edge *e2;
1837     int i2 = i - 1;
1838     if (i2 < 0) i2 += f->order;
1839     e2 = f->edges[i2];
1840 #endif
1841     ret = 2 * (e - g->edges) + ((e->dot1 == d) ? 1 : 0);
1842 #ifdef DEBUG_DLINES
1843     printf("dline_index_from_face: f=%d,i=%d, edges [%d,%d] - %d\n",
1844            (int)(f - g->faces), i, (int)(e - g->edges),
1845            (int)(e2 - g->edges), ret);
1846 #endif
1847     return ret;
1848 }
1849 static int is_atleastone(const char *dline_array, int index)
1850 {
1851     return BIT_SET(dline_array[index], 0);
1852 }
1853 static int set_atleastone(char *dline_array, int index)
1854 {
1855     return SET_BIT(dline_array[index], 0);
1856 }
1857 static int is_atmostone(const char *dline_array, int index)
1858 {
1859     return BIT_SET(dline_array[index], 1);
1860 }
1861 static int set_atmostone(char *dline_array, int index)
1862 {
1863     return SET_BIT(dline_array[index], 1);
1864 }
1865
1866 static void array_setall(char *array, char from, char to, int len)
1867 {
1868     char *p = array, *p_old = p;
1869     int len_remaining = len;
1870
1871     while ((p = memchr(p, from, len_remaining))) {
1872         *p = to;
1873         len_remaining -= p - p_old;
1874         p_old = p;
1875     }
1876 }
1877
1878 /* Helper, called when doing dline dot deductions, in the case where we
1879  * have 4 UNKNOWNs, and two of them (adjacent) have *exactly* one YES between
1880  * them (because of dline atmostone/atleastone).
1881  * On entry, edge points to the first of these two UNKNOWNs.  This function
1882  * will find the opposite UNKNOWNS (if they are adjacent to one another)
1883  * and set their corresponding dline to atleastone.  (Setting atmostone
1884  * already happens in earlier dline deductions) */
1885 static int dline_set_opp_atleastone(solver_state *sstate,
1886                                     grid_dot *d, int edge)
1887 {
1888     game_state *state = sstate->state;
1889     grid *g = state->game_grid;
1890     int N = d->order;
1891     int opp, opp2;
1892     for (opp = 0; opp < N; opp++) {
1893         int opp_dline_index;
1894         if (opp == edge || opp == edge+1 || opp == edge-1)
1895             continue;
1896         if (opp == 0 && edge == N-1)
1897             continue;
1898         if (opp == N-1 && edge == 0)
1899             continue;
1900         opp2 = opp + 1;
1901         if (opp2 == N) opp2 = 0;
1902         /* Check if opp, opp2 point to LINE_UNKNOWNs */
1903         if (state->lines[d->edges[opp] - g->edges] != LINE_UNKNOWN)
1904             continue;
1905         if (state->lines[d->edges[opp2] - g->edges] != LINE_UNKNOWN)
1906             continue;
1907         /* Found opposite UNKNOWNS and they're next to each other */
1908         opp_dline_index = dline_index_from_dot(g, d, opp);
1909         return set_atleastone(sstate->dlines, opp_dline_index);
1910     }
1911     return FALSE;
1912 }
1913
1914
1915 /* Set pairs of lines around this face which are known to be identical, to
1916  * the given line_state */
1917 static int face_setall_identical(solver_state *sstate, int face_index,
1918                                  enum line_state line_new)
1919 {
1920     /* can[dir] contains the canonical line associated with the line in
1921      * direction dir from the square in question.  Similarly inv[dir] is
1922      * whether or not the line in question is inverse to its canonical
1923      * element. */
1924     int retval = FALSE;
1925     game_state *state = sstate->state;
1926     grid *g = state->game_grid;
1927     grid_face *f = g->faces + face_index;
1928     int N = f->order;
1929     int i, j;
1930     int can1, can2, inv1, inv2;
1931
1932     for (i = 0; i < N; i++) {
1933         int line1_index = f->edges[i] - g->edges;
1934         if (state->lines[line1_index] != LINE_UNKNOWN)
1935             continue;
1936         for (j = i + 1; j < N; j++) {
1937             int line2_index = f->edges[j] - g->edges;
1938             if (state->lines[line2_index] != LINE_UNKNOWN)
1939                 continue;
1940
1941             /* Found two UNKNOWNS */
1942             can1 = edsf_canonify(sstate->linedsf, line1_index, &inv1);
1943             can2 = edsf_canonify(sstate->linedsf, line2_index, &inv2);
1944             if (can1 == can2 && inv1 == inv2) {
1945                 solver_set_line(sstate, line1_index, line_new);
1946                 solver_set_line(sstate, line2_index, line_new);
1947             }
1948         }
1949     }
1950     return retval;
1951 }
1952
1953 /* Given a dot or face, and a count of LINE_UNKNOWNs, find them and
1954  * return the edge indices into e. */
1955 static void find_unknowns(game_state *state,
1956     grid_edge **edge_list, /* Edge list to search (from a face or a dot) */
1957     int expected_count, /* Number of UNKNOWNs (comes from solver's cache) */
1958     int *e /* Returned edge indices */)
1959 {
1960     int c = 0;
1961     grid *g = state->game_grid;
1962     while (c < expected_count) {
1963         int line_index = *edge_list - g->edges;
1964         if (state->lines[line_index] == LINE_UNKNOWN) {
1965             e[c] = line_index;
1966             c++;
1967         }
1968         ++edge_list;
1969     }
1970 }
1971
1972 /* If we have a list of edges, and we know whether the number of YESs should
1973  * be odd or even, and there are only a few UNKNOWNs, we can do some simple
1974  * linedsf deductions.  This can be used for both face and dot deductions.
1975  * Returns the difficulty level of the next solver that should be used,
1976  * or DIFF_MAX if no progress was made. */
1977 static int parity_deductions(solver_state *sstate,
1978     grid_edge **edge_list, /* Edge list (from a face or a dot) */
1979     int total_parity, /* Expected number of YESs modulo 2 (either 0 or 1) */
1980     int unknown_count)
1981 {
1982     game_state *state = sstate->state;
1983     int diff = DIFF_MAX;
1984     int *linedsf = sstate->linedsf;
1985
1986     if (unknown_count == 2) {
1987         /* Lines are known alike/opposite, depending on inv. */
1988         int e[2];
1989         find_unknowns(state, edge_list, 2, e);
1990         if (merge_lines(sstate, e[0], e[1], total_parity))
1991             diff = min(diff, DIFF_HARD);
1992     } else if (unknown_count == 3) {
1993         int e[3];
1994         int can[3]; /* canonical edges */
1995         int inv[3]; /* whether can[x] is inverse to e[x] */
1996         find_unknowns(state, edge_list, 3, e);
1997         can[0] = edsf_canonify(linedsf, e[0], inv);
1998         can[1] = edsf_canonify(linedsf, e[1], inv+1);
1999         can[2] = edsf_canonify(linedsf, e[2], inv+2);
2000         if (can[0] == can[1]) {
2001             if (solver_set_line(sstate, e[2], (total_parity^inv[0]^inv[1]) ?
2002                                 LINE_YES : LINE_NO))
2003                 diff = min(diff, DIFF_EASY);
2004         }
2005         if (can[0] == can[2]) {
2006             if (solver_set_line(sstate, e[1], (total_parity^inv[0]^inv[2]) ?
2007                                 LINE_YES : LINE_NO))
2008                 diff = min(diff, DIFF_EASY);
2009         }
2010         if (can[1] == can[2]) {
2011             if (solver_set_line(sstate, e[0], (total_parity^inv[1]^inv[2]) ?
2012                                 LINE_YES : LINE_NO))
2013                 diff = min(diff, DIFF_EASY);
2014         }
2015     } else if (unknown_count == 4) {
2016         int e[4];
2017         int can[4]; /* canonical edges */
2018         int inv[4]; /* whether can[x] is inverse to e[x] */
2019         find_unknowns(state, edge_list, 4, e);
2020         can[0] = edsf_canonify(linedsf, e[0], inv);
2021         can[1] = edsf_canonify(linedsf, e[1], inv+1);
2022         can[2] = edsf_canonify(linedsf, e[2], inv+2);
2023         can[3] = edsf_canonify(linedsf, e[3], inv+3);
2024         if (can[0] == can[1]) {
2025             if (merge_lines(sstate, e[2], e[3], total_parity^inv[0]^inv[1]))
2026                 diff = min(diff, DIFF_HARD);
2027         } else if (can[0] == can[2]) {
2028             if (merge_lines(sstate, e[1], e[3], total_parity^inv[0]^inv[2]))
2029                 diff = min(diff, DIFF_HARD);
2030         } else if (can[0] == can[3]) {
2031             if (merge_lines(sstate, e[1], e[2], total_parity^inv[0]^inv[3]))
2032                 diff = min(diff, DIFF_HARD);
2033         } else if (can[1] == can[2]) {
2034             if (merge_lines(sstate, e[0], e[3], total_parity^inv[1]^inv[2]))
2035                 diff = min(diff, DIFF_HARD);
2036         } else if (can[1] == can[3]) {
2037             if (merge_lines(sstate, e[0], e[2], total_parity^inv[1]^inv[3]))
2038                 diff = min(diff, DIFF_HARD);
2039         } else if (can[2] == can[3]) {
2040             if (merge_lines(sstate, e[0], e[1], total_parity^inv[2]^inv[3]))
2041                 diff = min(diff, DIFF_HARD);
2042         }
2043     }
2044     return diff;
2045 }
2046
2047
2048 /*
2049  * These are the main solver functions.
2050  *
2051  * Their return values are diff values corresponding to the lowest mode solver
2052  * that would notice the work that they have done.  For example if the normal
2053  * mode solver adds actual lines or crosses, it will return DIFF_EASY as the
2054  * easy mode solver might be able to make progress using that.  It doesn't make
2055  * sense for one of them to return a diff value higher than that of the
2056  * function itself.
2057  *
2058  * Each function returns the lowest value it can, as early as possible, in
2059  * order to try and pass as much work as possible back to the lower level
2060  * solvers which progress more quickly.
2061  */
2062
2063 /* PROPOSED NEW DESIGN:
2064  * We have a work queue consisting of 'events' notifying us that something has
2065  * happened that a particular solver mode might be interested in.  For example
2066  * the hard mode solver might do something that helps the normal mode solver at
2067  * dot [x,y] in which case it will enqueue an event recording this fact.  Then
2068  * we pull events off the work queue, and hand each in turn to the solver that
2069  * is interested in them.  If a solver reports that it failed we pass the same
2070  * event on to progressively more advanced solvers and the loop detector.  Once
2071  * we've exhausted an event, or it has helped us progress, we drop it and
2072  * continue to the next one.  The events are sorted first in order of solver
2073  * complexity (easy first) then order of insertion (oldest first).
2074  * Once we run out of events we loop over each permitted solver in turn
2075  * (easiest first) until either a deduction is made (and an event therefore
2076  * emerges) or no further deductions can be made (in which case we've failed).
2077  *
2078  * QUESTIONS:
2079  *    * How do we 'loop over' a solver when both dots and squares are concerned.
2080  *      Answer: first all squares then all dots.
2081  */
2082
2083 static int trivial_deductions(solver_state *sstate)
2084 {
2085     int i, current_yes, current_no;
2086     game_state *state = sstate->state;
2087     grid *g = state->game_grid;
2088     int diff = DIFF_MAX;
2089
2090     /* Per-face deductions */
2091     for (i = 0; i < g->num_faces; i++) {
2092         grid_face *f = g->faces + i;
2093
2094         if (sstate->face_solved[i])
2095             continue;
2096
2097         current_yes = sstate->face_yes_count[i];
2098         current_no  = sstate->face_no_count[i];
2099
2100         if (current_yes + current_no == f->order)  {
2101             sstate->face_solved[i] = TRUE;
2102             continue;
2103         }
2104
2105         if (state->clues[i] < 0)
2106             continue;
2107
2108         /*
2109          * This code checks whether the numeric clue on a face is so
2110          * large as to permit all its remaining LINE_UNKNOWNs to be
2111          * filled in as LINE_YES, or alternatively so small as to
2112          * permit them all to be filled in as LINE_NO.
2113          */
2114
2115         if (state->clues[i] < current_yes) {
2116             sstate->solver_status = SOLVER_MISTAKE;
2117             return DIFF_EASY;
2118         }
2119         if (state->clues[i] == current_yes) {
2120             if (face_setall(sstate, i, LINE_UNKNOWN, LINE_NO))
2121                 diff = min(diff, DIFF_EASY);
2122             sstate->face_solved[i] = TRUE;
2123             continue;
2124         }
2125
2126         if (f->order - state->clues[i] < current_no) {
2127             sstate->solver_status = SOLVER_MISTAKE;
2128             return DIFF_EASY;
2129         }
2130         if (f->order - state->clues[i] == current_no) {
2131             if (face_setall(sstate, i, LINE_UNKNOWN, LINE_YES))
2132                 diff = min(diff, DIFF_EASY);
2133             sstate->face_solved[i] = TRUE;
2134             continue;
2135         }
2136
2137         if (f->order - state->clues[i] == current_no + 1 &&
2138             f->order - current_yes - current_no > 2) {
2139             /*
2140              * One small refinement to the above: we also look for any
2141              * adjacent pair of LINE_UNKNOWNs around the face with
2142              * some LINE_YES incident on it from elsewhere. If we find
2143              * one, then we know that pair of LINE_UNKNOWNs can't
2144              * _both_ be LINE_YES, and hence that pushes us one line
2145              * closer to being able to determine all the rest.
2146              */
2147             int j, k, e1, e2, e, d;
2148
2149             for (j = 0; j < f->order; j++) {
2150                 e1 = f->edges[j] - g->edges;
2151                 e2 = f->edges[j+1 < f->order ? j+1 : 0] - g->edges;
2152
2153                 if (g->edges[e1].dot1 == g->edges[e2].dot1 ||
2154                     g->edges[e1].dot1 == g->edges[e2].dot2) {
2155                     d = g->edges[e1].dot1 - g->dots;
2156                 } else {
2157                     assert(g->edges[e1].dot2 == g->edges[e2].dot1 ||
2158                            g->edges[e1].dot2 == g->edges[e2].dot2);
2159                     d = g->edges[e1].dot2 - g->dots;
2160                 }
2161
2162                 if (state->lines[e1] == LINE_UNKNOWN &&
2163                     state->lines[e2] == LINE_UNKNOWN) {
2164                     for (k = 0; k < g->dots[d].order; k++) {
2165                         int e = g->dots[d].edges[k] - g->edges;
2166                         if (state->lines[e] == LINE_YES)
2167                             goto found;    /* multi-level break */
2168                     }
2169                 }
2170             }
2171             continue;
2172
2173           found:
2174             /*
2175              * If we get here, we've found such a pair of edges, and
2176              * they're e1 and e2.
2177              */
2178             for (j = 0; j < f->order; j++) {
2179                 e = f->edges[j] - g->edges;
2180                 if (state->lines[e] == LINE_UNKNOWN && e != e1 && e != e2) {
2181                     int r = solver_set_line(sstate, e, LINE_YES);
2182                     assert(r);
2183                     diff = min(diff, DIFF_EASY);
2184                 }
2185             }
2186         }
2187     }
2188
2189     check_caches(sstate);
2190
2191     /* Per-dot deductions */
2192     for (i = 0; i < g->num_dots; i++) {
2193         grid_dot *d = g->dots + i;
2194         int yes, no, unknown;
2195
2196         if (sstate->dot_solved[i])
2197             continue;
2198
2199         yes = sstate->dot_yes_count[i];
2200         no = sstate->dot_no_count[i];
2201         unknown = d->order - yes - no;
2202
2203         if (yes == 0) {
2204             if (unknown == 0) {
2205                 sstate->dot_solved[i] = TRUE;
2206             } else if (unknown == 1) {
2207                 dot_setall(sstate, i, LINE_UNKNOWN, LINE_NO);
2208                 diff = min(diff, DIFF_EASY);
2209                 sstate->dot_solved[i] = TRUE;
2210             }
2211         } else if (yes == 1) {
2212             if (unknown == 0) {
2213                 sstate->solver_status = SOLVER_MISTAKE;
2214                 return DIFF_EASY;
2215             } else if (unknown == 1) {
2216                 dot_setall(sstate, i, LINE_UNKNOWN, LINE_YES);
2217                 diff = min(diff, DIFF_EASY);
2218             }
2219         } else if (yes == 2) {
2220             if (unknown > 0) {
2221                 dot_setall(sstate, i, LINE_UNKNOWN, LINE_NO);
2222                 diff = min(diff, DIFF_EASY);
2223             }
2224             sstate->dot_solved[i] = TRUE;
2225         } else {
2226             sstate->solver_status = SOLVER_MISTAKE;
2227             return DIFF_EASY;
2228         }
2229     }
2230
2231     check_caches(sstate);
2232
2233     return diff;
2234 }
2235
2236 static int dline_deductions(solver_state *sstate)
2237 {
2238     game_state *state = sstate->state;
2239     grid *g = state->game_grid;
2240     char *dlines = sstate->dlines;
2241     int i;
2242     int diff = DIFF_MAX;
2243
2244     /* ------ Face deductions ------ */
2245
2246     /* Given a set of dline atmostone/atleastone constraints, need to figure
2247      * out if we can deduce any further info.  For more general faces than
2248      * squares, this turns out to be a tricky problem.
2249      * The approach taken here is to define (per face) NxN matrices:
2250      * "maxs" and "mins".
2251      * The entries maxs(j,k) and mins(j,k) define the upper and lower limits
2252      * for the possible number of edges that are YES between positions j and k
2253      * going clockwise around the face.  Can think of j and k as marking dots
2254      * around the face (recall the labelling scheme: edge0 joins dot0 to dot1,
2255      * edge1 joins dot1 to dot2 etc).
2256      * Trivially, mins(j,j) = maxs(j,j) = 0, and we don't even bother storing
2257      * these.  mins(j,j+1) and maxs(j,j+1) are determined by whether edge{j}
2258      * is YES, NO or UNKNOWN.  mins(j,j+2) and maxs(j,j+2) are related to
2259      * the dline atmostone/atleastone status for edges j and j+1.
2260      *
2261      * Then we calculate the remaining entries recursively.  We definitely
2262      * know that
2263      * mins(j,k) >= { mins(j,u) + mins(u,k) } for any u between j and k.
2264      * This is because any valid placement of YESs between j and k must give
2265      * a valid placement between j and u, and also between u and k.
2266      * I believe it's sufficient to use just the two values of u:
2267      * j+1 and j+2.  Seems to work well in practice - the bounds we compute
2268      * are rigorous, even if they might not be best-possible.
2269      *
2270      * Once we have maxs and mins calculated, we can make inferences about
2271      * each dline{j,j+1} by looking at the possible complementary edge-counts
2272      * mins(j+2,j) and maxs(j+2,j) and comparing these with the face clue.
2273      * As well as dlines, we can make similar inferences about single edges.
2274      * For example, consider a pentagon with clue 3, and we know at most one
2275      * of (edge0, edge1) is YES, and at most one of (edge2, edge3) is YES.
2276      * We could then deduce edge4 is YES, because maxs(0,4) would be 2, so
2277      * that final edge would have to be YES to make the count up to 3.
2278      */
2279
2280     /* Much quicker to allocate arrays on the stack than the heap, so
2281      * define the largest possible face size, and base our array allocations
2282      * on that.  We check this with an assertion, in case someone decides to
2283      * make a grid which has larger faces than this.  Note, this algorithm
2284      * could get quite expensive if there are many large faces. */
2285 #define MAX_FACE_SIZE 12
2286
2287     for (i = 0; i < g->num_faces; i++) {
2288         int maxs[MAX_FACE_SIZE][MAX_FACE_SIZE];
2289         int mins[MAX_FACE_SIZE][MAX_FACE_SIZE];
2290         grid_face *f = g->faces + i;
2291         int N = f->order;
2292         int j,m;
2293         int clue = state->clues[i];
2294         assert(N <= MAX_FACE_SIZE);
2295         if (sstate->face_solved[i])
2296             continue;
2297         if (clue < 0) continue;
2298
2299         /* Calculate the (j,j+1) entries */
2300         for (j = 0; j < N; j++) {
2301             int edge_index = f->edges[j] - g->edges;
2302             int dline_index;
2303             enum line_state line1 = state->lines[edge_index];
2304             enum line_state line2;
2305             int tmp;
2306             int k = j + 1;
2307             if (k >= N) k = 0;
2308             maxs[j][k] = (line1 == LINE_NO) ? 0 : 1;
2309             mins[j][k] = (line1 == LINE_YES) ? 1 : 0;
2310             /* Calculate the (j,j+2) entries */
2311             dline_index = dline_index_from_face(g, f, k);
2312             edge_index = f->edges[k] - g->edges;
2313             line2 = state->lines[edge_index];
2314             k++;
2315             if (k >= N) k = 0;
2316
2317             /* max */
2318             tmp = 2;
2319             if (line1 == LINE_NO) tmp--;
2320             if (line2 == LINE_NO) tmp--;
2321             if (tmp == 2 && is_atmostone(dlines, dline_index))
2322                 tmp = 1;
2323             maxs[j][k] = tmp;
2324
2325             /* min */
2326             tmp = 0;
2327             if (line1 == LINE_YES) tmp++;
2328             if (line2 == LINE_YES) tmp++;
2329             if (tmp == 0 && is_atleastone(dlines, dline_index))
2330                 tmp = 1;
2331             mins[j][k] = tmp;
2332         }
2333
2334         /* Calculate the (j,j+m) entries for m between 3 and N-1 */
2335         for (m = 3; m < N; m++) {
2336             for (j = 0; j < N; j++) {
2337                 int k = j + m;
2338                 int u = j + 1;
2339                 int v = j + 2;
2340                 int tmp;
2341                 if (k >= N) k -= N;
2342                 if (u >= N) u -= N;
2343                 if (v >= N) v -= N;
2344                 maxs[j][k] = maxs[j][u] + maxs[u][k];
2345                 mins[j][k] = mins[j][u] + mins[u][k];
2346                 tmp = maxs[j][v] + maxs[v][k];
2347                 maxs[j][k] = min(maxs[j][k], tmp);
2348                 tmp = mins[j][v] + mins[v][k];
2349                 mins[j][k] = max(mins[j][k], tmp);
2350             }
2351         }
2352
2353         /* See if we can make any deductions */
2354         for (j = 0; j < N; j++) {
2355             int k;
2356             grid_edge *e = f->edges[j];
2357             int line_index = e - g->edges;
2358             int dline_index;
2359
2360             if (state->lines[line_index] != LINE_UNKNOWN)
2361                 continue;
2362             k = j + 1;
2363             if (k >= N) k = 0;
2364
2365             /* minimum YESs in the complement of this edge */
2366             if (mins[k][j] > clue) {
2367                 sstate->solver_status = SOLVER_MISTAKE;
2368                 return DIFF_EASY;
2369             }
2370             if (mins[k][j] == clue) {
2371                 /* setting this edge to YES would make at least
2372                  * (clue+1) edges - contradiction */
2373                 solver_set_line(sstate, line_index, LINE_NO);
2374                 diff = min(diff, DIFF_EASY);
2375             }
2376             if (maxs[k][j] < clue - 1) {
2377                 sstate->solver_status = SOLVER_MISTAKE;
2378                 return DIFF_EASY;
2379             }
2380             if (maxs[k][j] == clue - 1) {
2381                 /* Only way to satisfy the clue is to set edge{j} as YES */
2382                 solver_set_line(sstate, line_index, LINE_YES);
2383                 diff = min(diff, DIFF_EASY);
2384             }
2385
2386             /* More advanced deduction that allows propagation along diagonal
2387              * chains of faces connected by dots, for example, 3-2-...-2-3
2388              * in square grids. */
2389             if (sstate->diff >= DIFF_TRICKY) {
2390                 /* Now see if we can make dline deduction for edges{j,j+1} */
2391                 e = f->edges[k];
2392                 if (state->lines[e - g->edges] != LINE_UNKNOWN)
2393                     /* Only worth doing this for an UNKNOWN,UNKNOWN pair.
2394                      * Dlines where one of the edges is known, are handled in the
2395                      * dot-deductions */
2396                     continue;
2397     
2398                 dline_index = dline_index_from_face(g, f, k);
2399                 k++;
2400                 if (k >= N) k = 0;
2401     
2402                 /* minimum YESs in the complement of this dline */
2403                 if (mins[k][j] > clue - 2) {
2404                     /* Adding 2 YESs would break the clue */
2405                     if (set_atmostone(dlines, dline_index))
2406                         diff = min(diff, DIFF_NORMAL);
2407                 }
2408                 /* maximum YESs in the complement of this dline */
2409                 if (maxs[k][j] < clue) {
2410                     /* Adding 2 NOs would mean not enough YESs */
2411                     if (set_atleastone(dlines, dline_index))
2412                         diff = min(diff, DIFF_NORMAL);
2413                 }
2414             }
2415         }
2416     }
2417
2418     if (diff < DIFF_NORMAL)
2419         return diff;
2420
2421     /* ------ Dot deductions ------ */
2422
2423     for (i = 0; i < g->num_dots; i++) {
2424         grid_dot *d = g->dots + i;
2425         int N = d->order;
2426         int yes, no, unknown;
2427         int j;
2428         if (sstate->dot_solved[i])
2429             continue;
2430         yes = sstate->dot_yes_count[i];
2431         no = sstate->dot_no_count[i];
2432         unknown = N - yes - no;
2433
2434         for (j = 0; j < N; j++) {
2435             int k;
2436             int dline_index;
2437             int line1_index, line2_index;
2438             enum line_state line1, line2;
2439             k = j + 1;
2440             if (k >= N) k = 0;
2441             dline_index = dline_index_from_dot(g, d, j);
2442             line1_index = d->edges[j] - g->edges;
2443             line2_index = d->edges[k] - g->edges;
2444             line1 = state->lines[line1_index];
2445             line2 = state->lines[line2_index];
2446
2447             /* Infer dline state from line state */
2448             if (line1 == LINE_NO || line2 == LINE_NO) {
2449                 if (set_atmostone(dlines, dline_index))
2450                     diff = min(diff, DIFF_NORMAL);
2451             }
2452             if (line1 == LINE_YES || line2 == LINE_YES) {
2453                 if (set_atleastone(dlines, dline_index))
2454                     diff = min(diff, DIFF_NORMAL);
2455             }
2456             /* Infer line state from dline state */
2457             if (is_atmostone(dlines, dline_index)) {
2458                 if (line1 == LINE_YES && line2 == LINE_UNKNOWN) {
2459                     solver_set_line(sstate, line2_index, LINE_NO);
2460                     diff = min(diff, DIFF_EASY);
2461                 }
2462                 if (line2 == LINE_YES && line1 == LINE_UNKNOWN) {
2463                     solver_set_line(sstate, line1_index, LINE_NO);
2464                     diff = min(diff, DIFF_EASY);
2465                 }
2466             }
2467             if (is_atleastone(dlines, dline_index)) {
2468                 if (line1 == LINE_NO && line2 == LINE_UNKNOWN) {
2469                     solver_set_line(sstate, line2_index, LINE_YES);
2470                     diff = min(diff, DIFF_EASY);
2471                 }
2472                 if (line2 == LINE_NO && line1 == LINE_UNKNOWN) {
2473                     solver_set_line(sstate, line1_index, LINE_YES);
2474                     diff = min(diff, DIFF_EASY);
2475                 }
2476             }
2477             /* Deductions that depend on the numbers of lines.
2478              * Only bother if both lines are UNKNOWN, otherwise the
2479              * easy-mode solver (or deductions above) would have taken
2480              * care of it. */
2481             if (line1 != LINE_UNKNOWN || line2 != LINE_UNKNOWN)
2482                 continue;
2483
2484             if (yes == 0 && unknown == 2) {
2485                 /* Both these unknowns must be identical.  If we know
2486                  * atmostone or atleastone, we can make progress. */
2487                 if (is_atmostone(dlines, dline_index)) {
2488                     solver_set_line(sstate, line1_index, LINE_NO);
2489                     solver_set_line(sstate, line2_index, LINE_NO);
2490                     diff = min(diff, DIFF_EASY);
2491                 }
2492                 if (is_atleastone(dlines, dline_index)) {
2493                     solver_set_line(sstate, line1_index, LINE_YES);
2494                     solver_set_line(sstate, line2_index, LINE_YES);
2495                     diff = min(diff, DIFF_EASY);
2496                 }
2497             }
2498             if (yes == 1) {
2499                 if (set_atmostone(dlines, dline_index))
2500                     diff = min(diff, DIFF_NORMAL);
2501                 if (unknown == 2) {
2502                     if (set_atleastone(dlines, dline_index))
2503                         diff = min(diff, DIFF_NORMAL);
2504                 }
2505             }
2506
2507             /* More advanced deduction that allows propagation along diagonal
2508              * chains of faces connected by dots, for example: 3-2-...-2-3
2509              * in square grids. */
2510             if (sstate->diff >= DIFF_TRICKY) {
2511                 /* If we have atleastone set for this dline, infer
2512                  * atmostone for each "opposite" dline (that is, each
2513                  * dline without edges in common with this one).
2514                  * Again, this test is only worth doing if both these
2515                  * lines are UNKNOWN.  For if one of these lines were YES,
2516                  * the (yes == 1) test above would kick in instead. */
2517                 if (is_atleastone(dlines, dline_index)) {
2518                     int opp;
2519                     for (opp = 0; opp < N; opp++) {
2520                         int opp_dline_index;
2521                         if (opp == j || opp == j+1 || opp == j-1)
2522                             continue;
2523                         if (j == 0 && opp == N-1)
2524                             continue;
2525                         if (j == N-1 && opp == 0)
2526                             continue;
2527                         opp_dline_index = dline_index_from_dot(g, d, opp);
2528                         if (set_atmostone(dlines, opp_dline_index))
2529                             diff = min(diff, DIFF_NORMAL);
2530                     }
2531                     if (yes == 0 && is_atmostone(dlines, dline_index)) {
2532                         /* This dline has *exactly* one YES and there are no
2533                          * other YESs.  This allows more deductions. */
2534                         if (unknown == 3) {
2535                             /* Third unknown must be YES */
2536                             for (opp = 0; opp < N; opp++) {
2537                                 int opp_index;
2538                                 if (opp == j || opp == k)
2539                                     continue;
2540                                 opp_index = d->edges[opp] - g->edges;
2541                                 if (state->lines[opp_index] == LINE_UNKNOWN) {
2542                                     solver_set_line(sstate, opp_index,
2543                                                     LINE_YES);
2544                                     diff = min(diff, DIFF_EASY);
2545                                 }
2546                             }
2547                         } else if (unknown == 4) {
2548                             /* Exactly one of opposite UNKNOWNS is YES.  We've
2549                              * already set atmostone, so set atleastone as
2550                              * well.
2551                              */
2552                             if (dline_set_opp_atleastone(sstate, d, j))
2553                                 diff = min(diff, DIFF_NORMAL);
2554                         }
2555                     }
2556                 }
2557             }
2558         }
2559     }
2560     return diff;
2561 }
2562
2563 static int linedsf_deductions(solver_state *sstate)
2564 {
2565     game_state *state = sstate->state;
2566     grid *g = state->game_grid;
2567     char *dlines = sstate->dlines;
2568     int i;
2569     int diff = DIFF_MAX;
2570     int diff_tmp;
2571
2572     /* ------ Face deductions ------ */
2573
2574     /* A fully-general linedsf deduction seems overly complicated
2575      * (I suspect the problem is NP-complete, though in practice it might just
2576      * be doable because faces are limited in size).
2577      * For simplicity, we only consider *pairs* of LINE_UNKNOWNS that are
2578      * known to be identical.  If setting them both to YES (or NO) would break
2579      * the clue, set them to NO (or YES). */
2580
2581     for (i = 0; i < g->num_faces; i++) {
2582         int N, yes, no, unknown;
2583         int clue;
2584
2585         if (sstate->face_solved[i])
2586             continue;
2587         clue = state->clues[i];
2588         if (clue < 0)
2589             continue;
2590
2591         N = g->faces[i].order;
2592         yes = sstate->face_yes_count[i];
2593         if (yes + 1 == clue) {
2594             if (face_setall_identical(sstate, i, LINE_NO))
2595                 diff = min(diff, DIFF_EASY);
2596         }
2597         no = sstate->face_no_count[i];
2598         if (no + 1 == N - clue) {
2599             if (face_setall_identical(sstate, i, LINE_YES))
2600                 diff = min(diff, DIFF_EASY);
2601         }
2602
2603         /* Reload YES count, it might have changed */
2604         yes = sstate->face_yes_count[i];
2605         unknown = N - no - yes;
2606
2607         /* Deductions with small number of LINE_UNKNOWNs, based on overall
2608          * parity of lines. */
2609         diff_tmp = parity_deductions(sstate, g->faces[i].edges,
2610                                      (clue - yes) % 2, unknown);
2611         diff = min(diff, diff_tmp);
2612     }
2613
2614     /* ------ Dot deductions ------ */
2615     for (i = 0; i < g->num_dots; i++) {
2616         grid_dot *d = g->dots + i;
2617         int N = d->order;
2618         int j;
2619         int yes, no, unknown;
2620         /* Go through dlines, and do any dline<->linedsf deductions wherever
2621          * we find two UNKNOWNS. */
2622         for (j = 0; j < N; j++) {
2623             int dline_index = dline_index_from_dot(g, d, j);
2624             int line1_index;
2625             int line2_index;
2626             int can1, can2, inv1, inv2;
2627             int j2;
2628             line1_index = d->edges[j] - g->edges;
2629             if (state->lines[line1_index] != LINE_UNKNOWN)
2630                 continue;
2631             j2 = j + 1;
2632             if (j2 == N) j2 = 0;
2633             line2_index = d->edges[j2] - g->edges;
2634             if (state->lines[line2_index] != LINE_UNKNOWN)
2635                 continue;
2636             /* Infer dline flags from linedsf */
2637             can1 = edsf_canonify(sstate->linedsf, line1_index, &inv1);
2638             can2 = edsf_canonify(sstate->linedsf, line2_index, &inv2);
2639             if (can1 == can2 && inv1 != inv2) {
2640                 /* These are opposites, so set dline atmostone/atleastone */
2641                 if (set_atmostone(dlines, dline_index))
2642                     diff = min(diff, DIFF_NORMAL);
2643                 if (set_atleastone(dlines, dline_index))
2644                     diff = min(diff, DIFF_NORMAL);
2645                 continue;
2646             }
2647             /* Infer linedsf from dline flags */
2648             if (is_atmostone(dlines, dline_index)
2649                 && is_atleastone(dlines, dline_index)) {
2650                 if (merge_lines(sstate, line1_index, line2_index, 1))
2651                     diff = min(diff, DIFF_HARD);
2652             }
2653         }
2654
2655         /* Deductions with small number of LINE_UNKNOWNs, based on overall
2656          * parity of lines. */
2657         yes = sstate->dot_yes_count[i];
2658         no = sstate->dot_no_count[i];
2659         unknown = N - yes - no;
2660         diff_tmp = parity_deductions(sstate, d->edges,
2661                                      yes % 2, unknown);
2662         diff = min(diff, diff_tmp);
2663     }
2664
2665     /* ------ Edge dsf deductions ------ */
2666
2667     /* If the state of a line is known, deduce the state of its canonical line
2668      * too, and vice versa. */
2669     for (i = 0; i < g->num_edges; i++) {
2670         int can, inv;
2671         enum line_state s;
2672         can = edsf_canonify(sstate->linedsf, i, &inv);
2673         if (can == i)
2674             continue;
2675         s = sstate->state->lines[can];
2676         if (s != LINE_UNKNOWN) {
2677             if (solver_set_line(sstate, i, inv ? OPP(s) : s))
2678                 diff = min(diff, DIFF_EASY);
2679         } else {
2680             s = sstate->state->lines[i];
2681             if (s != LINE_UNKNOWN) {
2682                 if (solver_set_line(sstate, can, inv ? OPP(s) : s))
2683                     diff = min(diff, DIFF_EASY);
2684             }
2685         }
2686     }
2687
2688     return diff;
2689 }
2690
2691 static int loop_deductions(solver_state *sstate)
2692 {
2693     int edgecount = 0, clues = 0, satclues = 0, sm1clues = 0;
2694     game_state *state = sstate->state;
2695     grid *g = state->game_grid;
2696     int shortest_chainlen = g->num_dots;
2697     int loop_found = FALSE;
2698     int dots_connected;
2699     int progress = FALSE;
2700     int i;
2701
2702     /*
2703      * Go through the grid and update for all the new edges.
2704      * Since merge_dots() is idempotent, the simplest way to
2705      * do this is just to update for _all_ the edges.
2706      * Also, while we're here, we count the edges.
2707      */
2708     for (i = 0; i < g->num_edges; i++) {
2709         if (state->lines[i] == LINE_YES) {
2710             loop_found |= merge_dots(sstate, i);
2711             edgecount++;
2712         }
2713     }
2714
2715     /*
2716      * Count the clues, count the satisfied clues, and count the
2717      * satisfied-minus-one clues.
2718      */
2719     for (i = 0; i < g->num_faces; i++) {
2720         int c = state->clues[i];
2721         if (c >= 0) {
2722             int o = sstate->face_yes_count[i];
2723             if (o == c)
2724                 satclues++;
2725             else if (o == c-1)
2726                 sm1clues++;
2727             clues++;
2728         }
2729     }
2730
2731     for (i = 0; i < g->num_dots; ++i) {
2732         dots_connected =
2733             sstate->looplen[dsf_canonify(sstate->dotdsf, i)];
2734         if (dots_connected > 1)
2735             shortest_chainlen = min(shortest_chainlen, dots_connected);
2736     }
2737
2738     assert(sstate->solver_status == SOLVER_INCOMPLETE);
2739
2740     if (satclues == clues && shortest_chainlen == edgecount) {
2741         sstate->solver_status = SOLVER_SOLVED;
2742         /* This discovery clearly counts as progress, even if we haven't
2743          * just added any lines or anything */
2744         progress = TRUE;
2745         goto finished_loop_deductionsing;
2746     }
2747
2748     /*
2749      * Now go through looking for LINE_UNKNOWN edges which
2750      * connect two dots that are already in the same
2751      * equivalence class. If we find one, test to see if the
2752      * loop it would create is a solution.
2753      */
2754     for (i = 0; i < g->num_edges; i++) {
2755         grid_edge *e = g->edges + i;
2756         int d1 = e->dot1 - g->dots;
2757         int d2 = e->dot2 - g->dots;
2758         int eqclass, val;
2759         if (state->lines[i] != LINE_UNKNOWN)
2760             continue;
2761
2762         eqclass = dsf_canonify(sstate->dotdsf, d1);
2763         if (eqclass != dsf_canonify(sstate->dotdsf, d2))
2764             continue;
2765
2766         val = LINE_NO;  /* loop is bad until proven otherwise */
2767
2768         /*
2769          * This edge would form a loop. Next
2770          * question: how long would the loop be?
2771          * Would it equal the total number of edges
2772          * (plus the one we'd be adding if we added
2773          * it)?
2774          */
2775         if (sstate->looplen[eqclass] == edgecount + 1) {
2776             int sm1_nearby;
2777
2778             /*
2779              * This edge would form a loop which
2780              * took in all the edges in the entire
2781              * grid. So now we need to work out
2782              * whether it would be a valid solution
2783              * to the puzzle, which means we have to
2784              * check if it satisfies all the clues.
2785              * This means that every clue must be
2786              * either satisfied or satisfied-minus-
2787              * 1, and also that the number of
2788              * satisfied-minus-1 clues must be at
2789              * most two and they must lie on either
2790              * side of this edge.
2791              */
2792             sm1_nearby = 0;
2793             if (e->face1) {
2794                 int f = e->face1 - g->faces;
2795                 int c = state->clues[f];
2796                 if (c >= 0 && sstate->face_yes_count[f] == c - 1)
2797                     sm1_nearby++;
2798             }
2799             if (e->face2) {
2800                 int f = e->face2 - g->faces;
2801                 int c = state->clues[f];
2802                 if (c >= 0 && sstate->face_yes_count[f] == c - 1)
2803                     sm1_nearby++;
2804             }
2805             if (sm1clues == sm1_nearby &&
2806                 sm1clues + satclues == clues) {
2807                 val = LINE_YES;  /* loop is good! */
2808             }
2809         }
2810
2811         /*
2812          * Right. Now we know that adding this edge
2813          * would form a loop, and we know whether
2814          * that loop would be a viable solution or
2815          * not.
2816          *
2817          * If adding this edge produces a solution,
2818          * then we know we've found _a_ solution but
2819          * we don't know that it's _the_ solution -
2820          * if it were provably the solution then
2821          * we'd have deduced this edge some time ago
2822          * without the need to do loop detection. So
2823          * in this state we return SOLVER_AMBIGUOUS,
2824          * which has the effect that hitting Solve
2825          * on a user-provided puzzle will fill in a
2826          * solution but using the solver to
2827          * construct new puzzles won't consider this
2828          * a reasonable deduction for the user to
2829          * make.
2830          */
2831         progress = solver_set_line(sstate, i, val);
2832         assert(progress == TRUE);
2833         if (val == LINE_YES) {
2834             sstate->solver_status = SOLVER_AMBIGUOUS;
2835             goto finished_loop_deductionsing;
2836         }
2837     }
2838
2839     finished_loop_deductionsing:
2840     return progress ? DIFF_EASY : DIFF_MAX;
2841 }
2842
2843 /* This will return a dynamically allocated solver_state containing the (more)
2844  * solved grid */
2845 static solver_state *solve_game_rec(const solver_state *sstate_start)
2846 {
2847     solver_state *sstate;
2848
2849     /* Index of the solver we should call next. */
2850     int i = 0;
2851     
2852     /* As a speed-optimisation, we avoid re-running solvers that we know
2853      * won't make any progress.  This happens when a high-difficulty
2854      * solver makes a deduction that can only help other high-difficulty
2855      * solvers.
2856      * For example: if a new 'dline' flag is set by dline_deductions, the
2857      * trivial_deductions solver cannot do anything with this information.
2858      * If we've already run the trivial_deductions solver (because it's
2859      * earlier in the list), there's no point running it again.
2860      *
2861      * Therefore: if a solver is earlier in the list than "threshold_index",
2862      * we don't bother running it if it's difficulty level is less than
2863      * "threshold_diff".
2864      */
2865     int threshold_diff = 0;
2866     int threshold_index = 0;
2867     
2868     sstate = dup_solver_state(sstate_start);
2869
2870     check_caches(sstate);
2871
2872     while (i < NUM_SOLVERS) {
2873         if (sstate->solver_status == SOLVER_MISTAKE)
2874             return sstate;
2875         if (sstate->solver_status == SOLVER_SOLVED ||
2876             sstate->solver_status == SOLVER_AMBIGUOUS) {
2877             /* solver finished */
2878             break;
2879         }
2880
2881         if ((solver_diffs[i] >= threshold_diff || i >= threshold_index)
2882             && solver_diffs[i] <= sstate->diff) {
2883             /* current_solver is eligible, so use it */
2884             int next_diff = solver_fns[i](sstate);
2885             if (next_diff != DIFF_MAX) {
2886                 /* solver made progress, so use new thresholds and
2887                 * start again at top of list. */
2888                 threshold_diff = next_diff;
2889                 threshold_index = i;
2890                 i = 0;
2891                 continue;
2892             }
2893         }
2894         /* current_solver is ineligible, or failed to make progress, so
2895          * go to the next solver in the list */
2896         i++;
2897     }
2898
2899     if (sstate->solver_status == SOLVER_SOLVED ||
2900         sstate->solver_status == SOLVER_AMBIGUOUS) {
2901         /* s/LINE_UNKNOWN/LINE_NO/g */
2902         array_setall(sstate->state->lines, LINE_UNKNOWN, LINE_NO,
2903                      sstate->state->game_grid->num_edges);
2904         return sstate;
2905     }
2906
2907     return sstate;
2908 }
2909
2910 static char *solve_game(const game_state *state, const game_state *currstate,
2911                         const char *aux, const char **error)
2912 {
2913     char *soln = NULL;
2914     solver_state *sstate, *new_sstate;
2915
2916     sstate = new_solver_state(state, DIFF_MAX);
2917     new_sstate = solve_game_rec(sstate);
2918
2919     if (new_sstate->solver_status == SOLVER_SOLVED) {
2920         soln = encode_solve_move(new_sstate->state);
2921     } else if (new_sstate->solver_status == SOLVER_AMBIGUOUS) {
2922         soln = encode_solve_move(new_sstate->state);
2923         /**error = "Solver found ambiguous solutions"; */
2924     } else {
2925         soln = encode_solve_move(new_sstate->state);
2926         /**error = "Solver failed"; */
2927     }
2928
2929     free_solver_state(new_sstate);
2930     free_solver_state(sstate);
2931
2932     return soln;
2933 }
2934
2935 /* ----------------------------------------------------------------------
2936  * Drawing and mouse-handling
2937  */
2938
2939 static char *interpret_move(const game_state *state, game_ui *ui,
2940                             const game_drawstate *ds,
2941                             int x, int y, int button)
2942 {
2943     grid *g = state->game_grid;
2944     grid_edge *e;
2945     int i;
2946     char *movebuf;
2947     int movelen, movesize;
2948     char button_char = ' ';
2949     enum line_state old_state;
2950
2951     button &= ~MOD_MASK;
2952
2953     /* Convert mouse-click (x,y) to grid coordinates */
2954     x -= BORDER(ds->tilesize);
2955     y -= BORDER(ds->tilesize);
2956     x = x * g->tilesize / ds->tilesize;
2957     y = y * g->tilesize / ds->tilesize;
2958     x += g->lowest_x;
2959     y += g->lowest_y;
2960
2961     e = grid_nearest_edge(g, x, y);
2962     if (e == NULL)
2963         return NULL;
2964
2965     i = e - g->edges;
2966
2967     /* I think it's only possible to play this game with mouse clicks, sorry */
2968     /* Maybe will add mouse drag support some time */
2969     old_state = state->lines[i];
2970
2971     switch (button) {
2972       case LEFT_BUTTON:
2973         switch (old_state) {
2974           case LINE_UNKNOWN:
2975             button_char = 'y';
2976             break;
2977           case LINE_YES:
2978 #ifdef STYLUS_BASED
2979             button_char = 'n';
2980             break;
2981 #endif
2982           case LINE_NO:
2983             button_char = 'u';
2984             break;
2985         }
2986         break;
2987       case MIDDLE_BUTTON:
2988         button_char = 'u';
2989         break;
2990       case RIGHT_BUTTON:
2991         switch (old_state) {
2992           case LINE_UNKNOWN:
2993             button_char = 'n';
2994             break;
2995           case LINE_NO:
2996 #ifdef STYLUS_BASED
2997             button_char = 'y';
2998             break;
2999 #endif
3000           case LINE_YES:
3001             button_char = 'u';
3002             break;
3003         }
3004         break;
3005       default:
3006         return NULL;
3007     }
3008
3009     movelen = 0;
3010     movesize = 80;
3011     movebuf = snewn(movesize, char);
3012     movelen = sprintf(movebuf, "%d%c", i, (int)button_char);
3013     {
3014         static enum { OFF, FIXED, ADAPTIVE, DUNNO } autofollow = DUNNO;
3015         if (autofollow == DUNNO) {
3016             const char *env = getenv("LOOPY_AUTOFOLLOW");
3017             if (env && !strcmp(env, "off"))
3018                 autofollow = OFF;
3019             else if (env && !strcmp(env, "fixed"))
3020                 autofollow = FIXED;
3021             else if (env && !strcmp(env, "adaptive"))
3022                 autofollow = ADAPTIVE;
3023             else
3024                 autofollow = OFF;
3025         }
3026
3027         if (autofollow != OFF) {
3028             int dotid;
3029             for (dotid = 0; dotid < 2; dotid++) {
3030                 grid_dot *dot = (dotid == 0 ? e->dot1 : e->dot2);
3031                 grid_edge *e_this = e;
3032
3033                 while (1) {
3034                     int j, n_found;
3035                     grid_edge *e_next = NULL;
3036
3037                     for (j = n_found = 0; j < dot->order; j++) {
3038                         grid_edge *e_candidate = dot->edges[j];
3039                         int i_candidate = e_candidate - g->edges;
3040                         if (e_candidate != e_this &&
3041                             (autofollow == FIXED ||
3042                              state->lines[i] == LINE_NO ||
3043                              state->lines[i_candidate] != LINE_NO)) {
3044                             e_next = e_candidate;
3045                             n_found++;
3046                         }
3047                     }
3048
3049                     if (n_found != 1 ||
3050                         state->lines[e_next - g->edges] != state->lines[i])
3051                         break;
3052
3053                     if (e_next == e) {
3054                         /*
3055                          * Special case: we might have come all the
3056                          * way round a loop and found our way back to
3057                          * the same edge we started from. In that
3058                          * situation, we must terminate not only this
3059                          * while loop, but the 'for' outside it that
3060                          * was tracing in both directions from the
3061                          * starting edge, because if we let it trace
3062                          * in the second direction then we'll only
3063                          * find ourself traversing the same loop in
3064                          * the other order and generate an encoded
3065                          * move string that mentions the same set of
3066                          * edges twice.
3067                          */
3068                         goto autofollow_done;
3069                     }
3070
3071                     dot = (e_next->dot1 != dot ? e_next->dot1 : e_next->dot2);
3072                     if (movelen > movesize - 40) {
3073                         movesize = movesize * 5 / 4 + 128;
3074                         movebuf = sresize(movebuf, movesize, char);
3075                     }
3076                     e_this = e_next;
3077                     movelen += sprintf(movebuf+movelen, "%d%c",
3078                                        (int)(e_this - g->edges), button_char);
3079                 }
3080             }
3081           autofollow_done:;
3082         }
3083     }
3084
3085     return sresize(movebuf, movelen+1, char);
3086 }
3087
3088 static game_state *execute_move(const game_state *state, const char *move)
3089 {
3090     int i;
3091     game_state *newstate = dup_game(state);
3092
3093     if (move[0] == 'S') {
3094         move++;
3095         newstate->cheated = TRUE;
3096     }
3097
3098     while (*move) {
3099         i = atoi(move);
3100         if (i < 0 || i >= newstate->game_grid->num_edges)
3101             goto fail;
3102         move += strspn(move, "1234567890");
3103         switch (*(move++)) {
3104           case 'y':
3105             newstate->lines[i] = LINE_YES;
3106             break;
3107           case 'n':
3108             newstate->lines[i] = LINE_NO;
3109             break;
3110           case 'u':
3111             newstate->lines[i] = LINE_UNKNOWN;
3112             break;
3113           default:
3114             goto fail;
3115         }
3116     }
3117
3118     /*
3119      * Check for completion.
3120      */
3121     if (check_completion(newstate))
3122         newstate->solved = TRUE;
3123
3124     return newstate;
3125
3126     fail:
3127     free_game(newstate);
3128     return NULL;
3129 }
3130
3131 /* ----------------------------------------------------------------------
3132  * Drawing routines.
3133  */
3134
3135 /* Convert from grid coordinates to screen coordinates */
3136 static void grid_to_screen(const game_drawstate *ds, const grid *g,
3137                            int grid_x, int grid_y, int *x, int *y)
3138 {
3139     *x = grid_x - g->lowest_x;
3140     *y = grid_y - g->lowest_y;
3141     *x = *x * ds->tilesize / g->tilesize;
3142     *y = *y * ds->tilesize / g->tilesize;
3143     *x += BORDER(ds->tilesize);
3144     *y += BORDER(ds->tilesize);
3145 }
3146
3147 /* Returns (into x,y) position of centre of face for rendering the text clue.
3148  */
3149 static void face_text_pos(const game_drawstate *ds, const grid *g,
3150                           grid_face *f, int *xret, int *yret)
3151 {
3152     int faceindex = f - g->faces;
3153
3154     /*
3155      * Return the cached position for this face, if we've already
3156      * worked it out.
3157      */
3158     if (ds->textx[faceindex] >= 0) {
3159         *xret = ds->textx[faceindex];
3160         *yret = ds->texty[faceindex];
3161         return;
3162     }
3163
3164     /*
3165      * Otherwise, use the incentre computed by grid.c and convert it
3166      * to screen coordinates.
3167      */
3168     grid_find_incentre(f);
3169     grid_to_screen(ds, g, f->ix, f->iy,
3170                    &ds->textx[faceindex], &ds->texty[faceindex]);
3171
3172     *xret = ds->textx[faceindex];
3173     *yret = ds->texty[faceindex];
3174 }
3175
3176 static void face_text_bbox(game_drawstate *ds, grid *g, grid_face *f,
3177                            int *x, int *y, int *w, int *h)
3178 {
3179     int xx, yy;
3180     face_text_pos(ds, g, f, &xx, &yy);
3181
3182     /* There seems to be a certain amount of trial-and-error involved
3183      * in working out the correct bounding-box for the text. */
3184
3185     *x = xx - ds->tilesize/4 - 1;
3186     *y = yy - ds->tilesize/4 - 3;
3187     *w = ds->tilesize/2 + 2;
3188     *h = ds->tilesize/2 + 5;
3189 }
3190
3191 static void game_redraw_clue(drawing *dr, game_drawstate *ds,
3192                              const game_state *state, int i)
3193 {
3194     grid *g = state->game_grid;
3195     grid_face *f = g->faces + i;
3196     int x, y;
3197     char c[20];
3198
3199     sprintf(c, "%d", state->clues[i]);
3200
3201     face_text_pos(ds, g, f, &x, &y);
3202     draw_text(dr, x, y,
3203               FONT_VARIABLE, ds->tilesize/2,
3204               ALIGN_VCENTRE | ALIGN_HCENTRE,
3205               ds->clue_error[i] ? COL_MISTAKE :
3206               ds->clue_satisfied[i] ? COL_SATISFIED : COL_FOREGROUND, c);
3207 }
3208
3209 static void edge_bbox(game_drawstate *ds, grid *g, grid_edge *e,
3210                       int *x, int *y, int *w, int *h)
3211 {
3212     int x1 = e->dot1->x;
3213     int y1 = e->dot1->y;
3214     int x2 = e->dot2->x;
3215     int y2 = e->dot2->y;
3216     int xmin, xmax, ymin, ymax;
3217
3218     grid_to_screen(ds, g, x1, y1, &x1, &y1);
3219     grid_to_screen(ds, g, x2, y2, &x2, &y2);
3220     /* Allow extra margin for dots, and thickness of lines */
3221     xmin = min(x1, x2) - 2;
3222     xmax = max(x1, x2) + 2;
3223     ymin = min(y1, y2) - 2;
3224     ymax = max(y1, y2) + 2;
3225
3226     *x = xmin;
3227     *y = ymin;
3228     *w = xmax - xmin + 1;
3229     *h = ymax - ymin + 1;
3230 }
3231
3232 static void dot_bbox(game_drawstate *ds, grid *g, grid_dot *d,
3233                      int *x, int *y, int *w, int *h)
3234 {
3235     int x1, y1;
3236
3237     grid_to_screen(ds, g, d->x, d->y, &x1, &y1);
3238
3239     *x = x1 - 2;
3240     *y = y1 - 2;
3241     *w = 5;
3242     *h = 5;
3243 }
3244
3245 static const int loopy_line_redraw_phases[] = {
3246     COL_FAINT, COL_LINEUNKNOWN, COL_FOREGROUND, COL_HIGHLIGHT, COL_MISTAKE
3247 };
3248 #define NPHASES lenof(loopy_line_redraw_phases)
3249
3250 static void game_redraw_line(drawing *dr, game_drawstate *ds,
3251                              const game_state *state, int i, int phase)
3252 {
3253     grid *g = state->game_grid;
3254     grid_edge *e = g->edges + i;
3255     int x1, x2, y1, y2;
3256     int line_colour;
3257
3258     if (state->line_errors[i])
3259         line_colour = COL_MISTAKE;
3260     else if (state->lines[i] == LINE_UNKNOWN)
3261         line_colour = COL_LINEUNKNOWN;
3262     else if (state->lines[i] == LINE_NO)
3263         line_colour = COL_FAINT;
3264     else if (ds->flashing)
3265         line_colour = COL_HIGHLIGHT;
3266     else
3267         line_colour = COL_FOREGROUND;
3268     if (line_colour != loopy_line_redraw_phases[phase])
3269         return;
3270
3271     /* Convert from grid to screen coordinates */
3272     grid_to_screen(ds, g, e->dot1->x, e->dot1->y, &x1, &y1);
3273     grid_to_screen(ds, g, e->dot2->x, e->dot2->y, &x2, &y2);
3274
3275     if (line_colour == COL_FAINT) {
3276         static int draw_faint_lines = -1;
3277         if (draw_faint_lines < 0) {
3278             char *env = getenv("LOOPY_FAINT_LINES");
3279             draw_faint_lines = (!env || (env[0] == 'y' ||
3280                                          env[0] == 'Y'));
3281         }
3282         if (draw_faint_lines)
3283             draw_line(dr, x1, y1, x2, y2, line_colour);
3284     } else {
3285         draw_thick_line(dr, 3.0,
3286                         x1 + 0.5, y1 + 0.5,
3287                         x2 + 0.5, y2 + 0.5,
3288                         line_colour);
3289     }
3290 }
3291
3292 static void game_redraw_dot(drawing *dr, game_drawstate *ds,
3293                             const game_state *state, int i)
3294 {
3295     grid *g = state->game_grid;
3296     grid_dot *d = g->dots + i;
3297     int x, y;
3298
3299     grid_to_screen(ds, g, d->x, d->y, &x, &y);
3300     draw_circle(dr, x, y, 2, COL_FOREGROUND, COL_FOREGROUND);
3301 }
3302
3303 static int boxes_intersect(int x0, int y0, int w0, int h0,
3304                            int x1, int y1, int w1, int h1)
3305 {
3306     /*
3307      * Two intervals intersect iff neither is wholly on one side of
3308      * the other. Two boxes intersect iff their horizontal and
3309      * vertical intervals both intersect.
3310      */
3311     return (x0 < x1+w1 && x1 < x0+w0 && y0 < y1+h1 && y1 < y0+h0);
3312 }
3313
3314 static void game_redraw_in_rect(drawing *dr, game_drawstate *ds,
3315                                 const game_state *state,
3316                                 int x, int y, int w, int h)
3317 {
3318     grid *g = state->game_grid;
3319     int i, phase;
3320     int bx, by, bw, bh;
3321
3322     clip(dr, x, y, w, h);
3323     draw_rect(dr, x, y, w, h, COL_BACKGROUND);
3324
3325     for (i = 0; i < g->num_faces; i++) {
3326         if (state->clues[i] >= 0) {
3327             face_text_bbox(ds, g, &g->faces[i], &bx, &by, &bw, &bh);
3328             if (boxes_intersect(x, y, w, h, bx, by, bw, bh))
3329                 game_redraw_clue(dr, ds, state, i);
3330         }
3331     }
3332     for (phase = 0; phase < NPHASES; phase++) {
3333         for (i = 0; i < g->num_edges; i++) {
3334             edge_bbox(ds, g, &g->edges[i], &bx, &by, &bw, &bh);
3335             if (boxes_intersect(x, y, w, h, bx, by, bw, bh))
3336                 game_redraw_line(dr, ds, state, i, phase);
3337         }
3338     }
3339     for (i = 0; i < g->num_dots; i++) {
3340         dot_bbox(ds, g, &g->dots[i], &bx, &by, &bw, &bh);
3341         if (boxes_intersect(x, y, w, h, bx, by, bw, bh))
3342             game_redraw_dot(dr, ds, state, i);
3343     }
3344
3345     unclip(dr);
3346     draw_update(dr, x, y, w, h);
3347 }
3348
3349 static void game_redraw(drawing *dr, game_drawstate *ds,
3350                         const game_state *oldstate, const game_state *state,
3351                         int dir, const game_ui *ui,
3352                         float animtime, float flashtime)
3353 {
3354 #define REDRAW_OBJECTS_LIMIT 16         /* Somewhat arbitrary tradeoff */
3355
3356     grid *g = state->game_grid;
3357     int border = BORDER(ds->tilesize);
3358     int i;
3359     int flash_changed;
3360     int redraw_everything = FALSE;
3361
3362     int edges[REDRAW_OBJECTS_LIMIT], nedges = 0;
3363     int faces[REDRAW_OBJECTS_LIMIT], nfaces = 0;
3364
3365     /* Redrawing is somewhat involved.
3366      *
3367      * An update can theoretically affect an arbitrary number of edges
3368      * (consider, for example, completing or breaking a cycle which doesn't
3369      * satisfy all the clues -- we'll switch many edges between error and
3370      * normal states).  On the other hand, redrawing the whole grid takes a
3371      * while, making the game feel sluggish, and many updates are actually
3372      * quite well localized.
3373      *
3374      * This redraw algorithm attempts to cope with both situations gracefully
3375      * and correctly.  For localized changes, we set a clip rectangle, fill
3376      * it with background, and then redraw (a plausible but conservative
3377      * guess at) the objects which intersect the rectangle; if several
3378      * objects need redrawing, we'll do them individually.  However, if lots
3379      * of objects are affected, we'll just redraw everything.
3380      *
3381      * The reason for all of this is that it's just not safe to do the redraw
3382      * piecemeal.  If you try to draw an antialiased diagonal line over
3383      * itself, you get a slightly thicker antialiased diagonal line, which
3384      * looks rather ugly after a while.
3385      *
3386      * So, we take two passes over the grid.  The first attempts to work out
3387      * what needs doing, and the second actually does it.
3388      */
3389
3390     if (!ds->started) {
3391         redraw_everything = TRUE;
3392         /*
3393          * But we must still go through the upcoming loops, so that we
3394          * set up stuff in ds correctly for the initial redraw.
3395          */
3396     }
3397
3398     /* First, trundle through the faces. */
3399     for (i = 0; i < g->num_faces; i++) {
3400         grid_face *f = g->faces + i;
3401         int sides = f->order;
3402         int yes_order, no_order;
3403         int clue_mistake;
3404         int clue_satisfied;
3405         int n = state->clues[i];
3406         if (n < 0)
3407             continue;
3408
3409         yes_order = face_order(state, i, LINE_YES);
3410         if (state->exactly_one_loop) {
3411             /*
3412              * Special case: if the set of LINE_YES edges in the grid
3413              * consists of exactly one loop and nothing else, then we
3414              * switch to treating LINE_UNKNOWN the same as LINE_NO for
3415              * purposes of clue checking.
3416              *
3417              * This is because some people like to play Loopy without
3418              * using the right-click, i.e. never setting anything to
3419              * LINE_NO. Without this special case, if a person playing
3420              * in that style fills in what they think is a correct
3421              * solution loop but in fact it has an underfilled clue,
3422              * then we will display no victory flash and also no error
3423              * highlight explaining why not. With this special case,
3424              * we light up underfilled clues at the instant the loop
3425              * is closed. (Of course, *overfilled* clues are fine
3426              * either way.)
3427              *
3428              * (It might still be considered unfortunate that we can't
3429              * warn this style of player any earlier, if they make a
3430              * mistake very near the beginning which doesn't show up
3431              * until they close the last edge of the loop. One other
3432              * thing we _could_ do here is to treat any LINE_UNKNOWN
3433              * as LINE_NO if either of its endpoints has yes-degree 2,
3434              * reflecting the fact that setting that line to YES would
3435              * be an obvious error. But I don't think even that could
3436              * catch _all_ clue errors in a timely manner; I think
3437              * there are some that won't be displayed until the loop
3438              * is filled in, even so, and there's no way to avoid that
3439              * with complete reliability except to switch to being a
3440              * player who sets things to LINE_NO.)
3441              */
3442             no_order = sides - yes_order;
3443         } else {
3444             no_order = face_order(state, i, LINE_NO);
3445         }
3446
3447         clue_mistake = (yes_order > n || no_order > (sides-n));
3448         clue_satisfied = (yes_order == n && no_order == (sides-n));
3449
3450         if (clue_mistake != ds->clue_error[i] ||
3451             clue_satisfied != ds->clue_satisfied[i]) {
3452             ds->clue_error[i] = clue_mistake;
3453             ds->clue_satisfied[i] = clue_satisfied;
3454             if (nfaces == REDRAW_OBJECTS_LIMIT)
3455                 redraw_everything = TRUE;
3456             else
3457                 faces[nfaces++] = i;
3458         }
3459     }
3460
3461     /* Work out what the flash state needs to be. */
3462     if (flashtime > 0 &&
3463         (flashtime <= FLASH_TIME/3 ||
3464          flashtime >= FLASH_TIME*2/3)) {
3465         flash_changed = !ds->flashing;
3466         ds->flashing = TRUE;
3467     } else {
3468         flash_changed = ds->flashing;
3469         ds->flashing = FALSE;
3470     }
3471
3472     /* Now, trundle through the edges. */
3473     for (i = 0; i < g->num_edges; i++) {
3474         char new_ds =
3475             state->line_errors[i] ? DS_LINE_ERROR : state->lines[i];
3476         if (new_ds != ds->lines[i] ||
3477             (flash_changed && state->lines[i] == LINE_YES)) {
3478             ds->lines[i] = new_ds;
3479             if (nedges == REDRAW_OBJECTS_LIMIT)
3480                 redraw_everything = TRUE;
3481             else
3482                 edges[nedges++] = i;
3483         }
3484     }
3485
3486     /* Pass one is now done.  Now we do the actual drawing. */
3487     if (redraw_everything) {
3488         int grid_width = g->highest_x - g->lowest_x;
3489         int grid_height = g->highest_y - g->lowest_y;
3490         int w = grid_width * ds->tilesize / g->tilesize;
3491         int h = grid_height * ds->tilesize / g->tilesize;
3492
3493         game_redraw_in_rect(dr, ds, state,
3494                             0, 0, w + 2*border + 1, h + 2*border + 1);
3495     } else {
3496
3497         /* Right.  Now we roll up our sleeves. */
3498
3499         for (i = 0; i < nfaces; i++) {
3500             grid_face *f = g->faces + faces[i];
3501             int x, y, w, h;
3502
3503             face_text_bbox(ds, g, f, &x, &y, &w, &h);
3504             game_redraw_in_rect(dr, ds, state, x, y, w, h);
3505         }
3506
3507         for (i = 0; i < nedges; i++) {
3508             grid_edge *e = g->edges + edges[i];
3509             int x, y, w, h;
3510
3511             edge_bbox(ds, g, e, &x, &y, &w, &h);
3512             game_redraw_in_rect(dr, ds, state, x, y, w, h);
3513         }
3514     }
3515
3516     ds->started = TRUE;
3517 }
3518
3519 static float game_flash_length(const game_state *oldstate,
3520                                const game_state *newstate, int dir, game_ui *ui)
3521 {
3522     if (!oldstate->solved  &&  newstate->solved &&
3523         !oldstate->cheated && !newstate->cheated) {
3524         return FLASH_TIME;
3525     }
3526
3527     return 0.0F;
3528 }
3529
3530 static int game_status(const game_state *state)
3531 {
3532     return state->solved ? +1 : 0;
3533 }
3534
3535 static void game_print_size(const game_params *params, float *x, float *y)
3536 {
3537     int pw, ph;
3538
3539     /*
3540      * I'll use 7mm "squares" by default.
3541      */
3542     game_compute_size(params, 700, &pw, &ph);
3543     *x = pw / 100.0F;
3544     *y = ph / 100.0F;
3545 }
3546
3547 static void game_print(drawing *dr, const game_state *state, int tilesize)
3548 {
3549     int ink = print_mono_colour(dr, 0);
3550     int i;
3551     game_drawstate ads, *ds = &ads;
3552     grid *g = state->game_grid;
3553
3554     ds->tilesize = tilesize;
3555     ds->textx = snewn(g->num_faces, int);
3556     ds->texty = snewn(g->num_faces, int);
3557     for (i = 0; i < g->num_faces; i++)
3558         ds->textx[i] = ds->texty[i] = -1;
3559
3560     for (i = 0; i < g->num_dots; i++) {
3561         int x, y;
3562         grid_to_screen(ds, g, g->dots[i].x, g->dots[i].y, &x, &y);
3563         draw_circle(dr, x, y, ds->tilesize / 15, ink, ink);
3564     }
3565
3566     /*
3567      * Clues.
3568      */
3569     for (i = 0; i < g->num_faces; i++) {
3570         grid_face *f = g->faces + i;
3571         int clue = state->clues[i];
3572         if (clue >= 0) {
3573             char c[20];
3574             int x, y;
3575             sprintf(c, "%d", state->clues[i]);
3576             face_text_pos(ds, g, f, &x, &y);
3577             draw_text(dr, x, y,
3578                       FONT_VARIABLE, ds->tilesize / 2,
3579                       ALIGN_VCENTRE | ALIGN_HCENTRE, ink, c);
3580         }
3581     }
3582
3583     /*
3584      * Lines.
3585      */
3586     for (i = 0; i < g->num_edges; i++) {
3587         int thickness = (state->lines[i] == LINE_YES) ? 30 : 150;
3588         grid_edge *e = g->edges + i;
3589         int x1, y1, x2, y2;
3590         grid_to_screen(ds, g, e->dot1->x, e->dot1->y, &x1, &y1);
3591         grid_to_screen(ds, g, e->dot2->x, e->dot2->y, &x2, &y2);
3592         if (state->lines[i] == LINE_YES)
3593         {
3594             /* (dx, dy) points from (x1, y1) to (x2, y2).
3595              * The line is then "fattened" in a perpendicular
3596              * direction to create a thin rectangle. */
3597             double d = sqrt(SQ((double)x1 - x2) + SQ((double)y1 - y2));
3598             double dx = (x2 - x1) / d;
3599             double dy = (y2 - y1) / d;
3600             int points[8];
3601
3602             dx = (dx * ds->tilesize) / thickness;
3603             dy = (dy * ds->tilesize) / thickness;
3604             points[0] = x1 + (int)dy;
3605             points[1] = y1 - (int)dx;
3606             points[2] = x1 - (int)dy;
3607             points[3] = y1 + (int)dx;
3608             points[4] = x2 - (int)dy;
3609             points[5] = y2 + (int)dx;
3610             points[6] = x2 + (int)dy;
3611             points[7] = y2 - (int)dx;
3612             draw_polygon(dr, points, 4, ink, ink);
3613         }
3614         else
3615         {
3616             /* Draw a dotted line */
3617             int divisions = 6;
3618             int j;
3619             for (j = 1; j < divisions; j++) {
3620                 /* Weighted average */
3621                 int x = (x1 * (divisions -j) + x2 * j) / divisions;
3622                 int y = (y1 * (divisions -j) + y2 * j) / divisions;
3623                 draw_circle(dr, x, y, ds->tilesize / thickness, ink, ink);
3624             }
3625         }
3626     }
3627
3628     sfree(ds->textx);
3629     sfree(ds->texty);
3630 }
3631
3632 #ifdef COMBINED
3633 #define thegame loopy
3634 #endif
3635
3636 const struct game thegame = {
3637     "Loopy", "games.loopy", "loopy",
3638     default_params,
3639     NULL, game_preset_menu,
3640     decode_params,
3641     encode_params,
3642     free_params,
3643     dup_params,
3644     TRUE, game_configure, custom_params,
3645     validate_params,
3646     new_game_desc,
3647     validate_desc,
3648     new_game,
3649     dup_game,
3650     free_game,
3651     1, solve_game,
3652     TRUE, game_can_format_as_text_now, game_text_format,
3653     new_ui,
3654     free_ui,
3655     encode_ui,
3656     decode_ui,
3657     game_changed_state,
3658     interpret_move,
3659     execute_move,
3660     PREFERRED_TILE_SIZE, game_compute_size, game_set_size,
3661     game_colours,
3662     game_new_drawstate,
3663     game_free_drawstate,
3664     game_redraw,
3665     game_anim_length,
3666     game_flash_length,
3667     game_status,
3668     TRUE, FALSE, game_print_size, game_print,
3669     FALSE /* wants_statusbar */,
3670     FALSE, game_timing_state,
3671     0,                                       /* mouse_priorities */
3672 };
3673
3674 #ifdef STANDALONE_SOLVER
3675
3676 /*
3677  * Half-hearted standalone solver. It can't output the solution to
3678  * anything but a square puzzle, and it can't log the deductions
3679  * it makes either. But it can solve square puzzles, and more
3680  * importantly it can use its solver to grade the difficulty of
3681  * any puzzle you give it.
3682  */
3683
3684 #include <stdarg.h>
3685
3686 int main(int argc, char **argv)
3687 {
3688     game_params *p;
3689     game_state *s;
3690     char *id = NULL, *desc;
3691     const char *err;
3692     int grade = FALSE;
3693     int ret, diff;
3694 #if 0 /* verbose solver not supported here (yet) */
3695     int really_verbose = FALSE;
3696 #endif
3697
3698     while (--argc > 0) {
3699         char *p = *++argv;
3700 #if 0 /* verbose solver not supported here (yet) */
3701         if (!strcmp(p, "-v")) {
3702             really_verbose = TRUE;
3703         } else
3704 #endif
3705         if (!strcmp(p, "-g")) {
3706             grade = TRUE;
3707         } else if (*p == '-') {
3708             fprintf(stderr, "%s: unrecognised option `%s'\n", argv[0], p);
3709             return 1;
3710         } else {
3711             id = p;
3712         }
3713     }
3714
3715     if (!id) {
3716         fprintf(stderr, "usage: %s [-g | -v] <game_id>\n", argv[0]);
3717         return 1;
3718     }
3719
3720     desc = strchr(id, ':');
3721     if (!desc) {
3722         fprintf(stderr, "%s: game id expects a colon in it\n", argv[0]);
3723         return 1;
3724     }
3725     *desc++ = '\0';
3726
3727     p = default_params();
3728     decode_params(p, id);
3729     err = validate_desc(p, desc);
3730     if (err) {
3731         fprintf(stderr, "%s: %s\n", argv[0], err);
3732         return 1;
3733     }
3734     s = new_game(NULL, p, desc);
3735
3736     /*
3737      * When solving an Easy puzzle, we don't want to bother the
3738      * user with Hard-level deductions. For this reason, we grade
3739      * the puzzle internally before doing anything else.
3740      */
3741     ret = -1;                          /* placate optimiser */
3742     for (diff = 0; diff < DIFF_MAX; diff++) {
3743         solver_state *sstate_new;
3744         solver_state *sstate = new_solver_state((game_state *)s, diff);
3745
3746         sstate_new = solve_game_rec(sstate);
3747
3748         if (sstate_new->solver_status == SOLVER_MISTAKE)
3749             ret = 0;
3750         else if (sstate_new->solver_status == SOLVER_SOLVED)
3751             ret = 1;
3752         else
3753             ret = 2;
3754
3755         free_solver_state(sstate_new);
3756         free_solver_state(sstate);
3757
3758         if (ret < 2)
3759             break;
3760     }
3761
3762     if (diff == DIFF_MAX) {
3763         if (grade)
3764             printf("Difficulty rating: harder than Hard, or ambiguous\n");
3765         else
3766             printf("Unable to find a unique solution\n");
3767     } else {
3768         if (grade) {
3769             if (ret == 0)
3770                 printf("Difficulty rating: impossible (no solution exists)\n");
3771             else if (ret == 1)
3772                 printf("Difficulty rating: %s\n", diffnames[diff]);
3773         } else {
3774             solver_state *sstate_new;
3775             solver_state *sstate = new_solver_state((game_state *)s, diff);
3776
3777             /* If we supported a verbose solver, we'd set verbosity here */
3778
3779             sstate_new = solve_game_rec(sstate);
3780
3781             if (sstate_new->solver_status == SOLVER_MISTAKE)
3782                 printf("Puzzle is inconsistent\n");
3783             else {
3784                 assert(sstate_new->solver_status == SOLVER_SOLVED);
3785                 if (s->grid_type == 0) {
3786                     fputs(game_text_format(sstate_new->state), stdout);
3787                 } else {
3788                     printf("Unable to output non-square grids\n");
3789                 }
3790             }
3791
3792             free_solver_state(sstate_new);
3793             free_solver_state(sstate);
3794         }
3795     }
3796
3797     return 0;
3798 }
3799
3800 #endif
3801
3802 /* vim: set shiftwidth=4 tabstop=8: */