midend.c

   1 /*
   2  * midend.c: general middle fragment sitting between the
   3  * platform-specific front end and game-specific back end.
   4  * Maintains a move list, takes care of Undo and Redo commands, and
   5  * processes standard keystrokes for undo/redo/new/quit.
   6  */
   7
   8 #include <stdio.h>
   9 #include <string.h>
  10 #include <assert.h>
  11 #include <stdlib.h>
  12 #include <ctype.h>
  13
  14 #include "puzzles.h"
  15
  16 enum { DEF_PARAMS, DEF_SEED, DEF_DESC };   /* for midend_game_id_int */
  17
  18 enum { NEWGAME, MOVE, SOLVE, RESTART };/* for midend_state_entry.movetype */
  19
  20 #define special(type) ( (type) != MOVE )
  21
  22 struct midend_state_entry {
  23     game_state *state;
  24     char *movestr;
  25     int movetype;
  26 };
  27
  28 struct midend {
  29     frontend *frontend;
  30     random_state *random;
  31     const game *ourgame;
  32
  33     game_params **presets;
  34     char **preset_names, **preset_encodings;
  35     int npresets, presetsize;
  36
  37     /*
  38      * `desc' and `privdesc' deserve a comment.
  39      *
  40      * `desc' is the game description as presented to the user when
  41      * they ask for Game -> Specific. `privdesc', if non-NULL, is a
  42      * different game description used to reconstruct the initial
  43      * game_state when de-serialising. If privdesc is NULL, `desc'
  44      * is used for both.
  45      *
  46      * For almost all games, `privdesc' is NULL and never used. The
  47      * exception (as usual) is Mines: the initial game state has no
  48      * squares open at all, but after the first click `desc' is
  49      * rewritten to describe a game state with an initial click and
  50      * thus a bunch of squares open. If we used that desc to
  51      * serialise and deserialise, then the initial game state after
  52      * deserialisation would look unlike the initial game state
  53      * beforehand, and worse still execute_move() might fail on the
  54      * attempted first click. So `privdesc' is also used in this
  55      * case, to provide a game description describing the same
  56      * fixed mine layout _but_ no initial click. (These game IDs
  57      * may also be typed directly into Mines if you like.)
  58      */
  59     char *desc, *privdesc, *seedstr;
  60     char *aux_info;
  61     enum { GOT_SEED, GOT_DESC, GOT_NOTHING } genmode;
  62
  63     int nstates, statesize, statepos;
  64     struct midend_state_entry *states;
  65
  66     game_params *params, *curparams;
  67     game_drawstate *drawstate;
  68     game_ui *ui;
  69
  70     game_state *oldstate;
  71     float anim_time, anim_pos;
  72     float flash_time, flash_pos;
  73     int dir;
  74
  75     int timing;
  76     float elapsed;
  77     char *laststatus;
  78
  79     drawing *drawing;
  80
  81     int pressed_mouse_button;
  82
  83     int preferred_tilesize, tilesize, winwidth, winheight;
  84
  85     void (*game_desc_change_notify_function)(void *);
  86     void *game_desc_change_notify_ctx;
  87 };
  88
  89 #define ensure(me) do { \
  90     if ((me)->nstates >= (me)->statesize) { \
  91         (me)->statesize = (me)->nstates + 128; \
  92         (me)->states = sresize((me)->states, (me)->statesize, \
  93                                struct midend_state_entry); \
  94     } \
  95 } while (0)
  96
  97 midend *midend_new(frontend *fe, const game *ourgame,
  98                    const drawing_api *drapi, void *drhandle)
  99 {
 100     midend *me = snew(midend);
 101     void *randseed;
 102     int randseedsize;
 103
 104     get_random_seed(&randseed, &randseedsize);
 105
 106     me->frontend = fe;
 107     me->ourgame = ourgame;
 108     me->random = random_new(randseed, randseedsize);
 109     me->nstates = me->statesize = me->statepos = 0;
 110     me->states = NULL;
 111     me->params = ourgame->default_params();
 112     /*
 113      * Allow environment-based changing of the default settings by
 114      * defining a variable along the lines of `NET_DEFAULT=25x25w'
 115      * in which the value is an encoded parameter string.
 116      */
 117     {
 118         char buf[80], *e;
 119         int j, k;
 120         sprintf(buf, "%s_DEFAULT", me->ourgame->name);
 121         for (j = k = 0; buf[j]; j++)
 122             if (!isspace((unsigned char)buf[j]))
 123                 buf[k++] = toupper((unsigned char)buf[j]);
 124         buf[k] = '\0';
 125         if ((e = getenv(buf)) != NULL)
 126             me->ourgame->decode_params(me->params, e);
 127     }
 128     me->curparams = NULL;
 129     me->desc = me->privdesc = NULL;
 130     me->seedstr = NULL;
 131     me->aux_info = NULL;
 132     me->genmode = GOT_NOTHING;
 133     me->drawstate = NULL;
 134     me->oldstate = NULL;
 135     me->presets = NULL;
 136     me->preset_names = NULL;
 137     me->preset_encodings = NULL;
 138     me->npresets = me->presetsize = 0;
 139     me->anim_time = me->anim_pos = 0.0F;
 140     me->flash_time = me->flash_pos = 0.0F;
 141     me->dir = 0;
 142     me->ui = NULL;
 143     me->pressed_mouse_button = 0;
 144     me->laststatus = NULL;
 145     me->timing = FALSE;
 146     me->elapsed = 0.0F;
 147     me->tilesize = me->winwidth = me->winheight = 0;
 148     if (drapi)
 149         me->drawing = drawing_new(drapi, me, drhandle);
 150     else
 151         me->drawing = NULL;
 152
 153     me->preferred_tilesize = ourgame->preferred_tilesize;
 154     {
 155         /*
 156          * Allow an environment-based override for the default tile
 157          * size by defining a variable along the lines of
 158          * `NET_TILESIZE=15'.
 159          */
 160
 161         char buf[80], *e;
 162         int j, k, ts;
 163
 164         sprintf(buf, "%s_TILESIZE", me->ourgame->name);
 165         for (j = k = 0; buf[j]; j++)
 166             if (!isspace((unsigned char)buf[j]))
 167                 buf[k++] = toupper((unsigned char)buf[j]);
 168         buf[k] = '\0';
 169         if ((e = getenv(buf)) != NULL && sscanf(e, "%d", &ts) == 1 && ts > 0)
 170             me->preferred_tilesize = ts;
 171     }
 172
 173     sfree(randseed);
 174
 175     return me;
 176 }
 177
 178 const game *midend_which_game(midend *me)
 179 {
 180     return me->ourgame;
 181 }
 182
 183 static void midend_purge_states(midend *me)
 184 {
 185     while (me->nstates > me->statepos) {
 186         me->ourgame->free_game(me->states[--me->nstates].state);
 187         if (me->states[me->nstates].movestr)
 188             sfree(me->states[me->nstates].movestr);
 189     }
 190 }
 191
 192 static void midend_free_game(midend *me)
 193 {
 194     while (me->nstates > 0) {
 195         me->nstates--;
 196         me->ourgame->free_game(me->states[me->nstates].state);
 197         sfree(me->states[me->nstates].movestr);
 198     }
 199
 200     if (me->drawstate)
 201         me->ourgame->free_drawstate(me->drawing, me->drawstate);
 202 }
 203
 204 void midend_free(midend *me)
 205 {
 206     int i;
 207
 208     midend_free_game(me);
 209
 210     if (me->drawing)
 211         drawing_free(me->drawing);
 212     random_free(me->random);
 213     sfree(me->states);
 214     sfree(me->desc);
 215     sfree(me->privdesc);
 216     sfree(me->seedstr);
 217     sfree(me->aux_info);
 218     me->ourgame->free_params(me->params);
 219     if (me->npresets) {
 220         for (i = 0; i < me->npresets; i++) {
 221             sfree(me->presets[i]);
 222             sfree(me->preset_names[i]);
 223             sfree(me->preset_encodings[i]);
 224         }
 225         sfree(me->presets);
 226         sfree(me->preset_names);
 227         sfree(me->preset_encodings);
 228     }
 229     if (me->ui)
 230         me->ourgame->free_ui(me->ui);
 231     if (me->curparams)
 232         me->ourgame->free_params(me->curparams);
 233     sfree(me->laststatus);
 234     sfree(me);
 235 }
 236
 237 static void midend_size_new_drawstate(midend *me)
 238 {
 239     /*
 240      * Don't even bother, if we haven't worked out our tile size
 241      * anyway yet.
 242      */
 243     if (me->tilesize > 0) {
 244         me->ourgame->compute_size(me->params, me->tilesize,
 245                                   &me->winwidth, &me->winheight);
 246         me->ourgame->set_size(me->drawing, me->drawstate,
 247                               me->params, me->tilesize);
 248     }
 249 }
 250
 251 void midend_size(midend *me, int *x, int *y, int user_size)
 252 {
 253     int min, max;
 254     int rx, ry;
 255
 256     /*
 257      * We can't set the size on the same drawstate twice. So if
 258      * we've already sized one drawstate, we must throw it away and
 259      * create a new one.
 260      */
 261     if (me->drawstate && me->tilesize > 0) {
 262         me->ourgame->free_drawstate(me->drawing, me->drawstate);
 263         me->drawstate = me->ourgame->new_drawstate(me->drawing,
 264                                                    me->states[0].state);
 265     }
 266
 267     /*
 268      * Find the tile size that best fits within the given space. If
 269      * `user_size' is TRUE, we must actually find the _largest_ such
 270      * tile size, in order to get as close to the user's explicit
 271      * request as possible; otherwise, we bound above at the game's
 272      * preferred tile size, so that the game gets what it wants
 273      * provided that this doesn't break the constraint from the
 274      * front-end (which is likely to be a screen size or similar).
 275      */
 276     if (user_size) {
 277         max = 1;
 278         do {
 279             max *= 2;
 280             me->ourgame->compute_size(me->params, max, &rx, &ry);
 281         } while (rx <= *x && ry <= *y);
 282     } else
 283         max = me->preferred_tilesize + 1;
 284     min = 1;
 285
 286     /*
 287      * Now binary-search between min and max. We're looking for a
 288      * boundary rather than a value: the point at which tile sizes
 289      * stop fitting within the given dimensions. Thus, we stop when
 290      * max and min differ by exactly 1.
 291      */
 292     while (max - min > 1) {
 293         int mid = (max + min) / 2;
 294         me->ourgame->compute_size(me->params, mid, &rx, &ry);
 295         if (rx <= *x && ry <= *y)
 296             min = mid;
 297         else
 298             max = mid;
 299     }
 300
 301     /*
 302      * Now `min' is a valid size, and `max' isn't. So use `min'.
 303      */
 304
 305     me->tilesize = min;
 306     if (user_size)
 307         /* If the user requested a change in size, make it permanent. */
 308         me->preferred_tilesize = me->tilesize;
 309     midend_size_new_drawstate(me);
 310     *x = me->winwidth;
 311     *y = me->winheight;
 312 }
 313
 314 int midend_tilesize(midend *me) { return me->tilesize; }
 315
 316 void midend_set_params(midend *me, game_params *params)
 317 {
 318     me->ourgame->free_params(me->params);
 319     me->params = me->ourgame->dup_params(params);
 320 }
 321
 322 game_params *midend_get_params(midend *me)
 323 {
 324     return me->ourgame->dup_params(me->params);
 325 }
 326
 327 static void midend_set_timer(midend *me)
 328 {
 329     me->timing = (me->ourgame->is_timed &&
 330                   me->ourgame->timing_state(me->states[me->statepos-1].state,
 331                                             me->ui));
 332     if (me->timing || me->flash_time || me->anim_time)
 333         activate_timer(me->frontend);
 334     else
 335         deactivate_timer(me->frontend);
 336 }
 337
 338 void midend_force_redraw(midend *me)
 339 {
 340     if (me->drawstate)
 341         me->ourgame->free_drawstate(me->drawing, me->drawstate);
 342     me->drawstate = me->ourgame->new_drawstate(me->drawing,
 343                                                me->states[0].state);
 344     midend_size_new_drawstate(me);
 345     midend_redraw(me);
 346 }
 347
 348 void midend_new_game(midend *me)
 349 {
 350     midend_free_game(me);
 351
 352     assert(me->nstates == 0);
 353
 354     if (me->genmode == GOT_DESC) {
 355         me->genmode = GOT_NOTHING;
 356     } else {
 357         random_state *rs;
 358
 359         if (me->genmode == GOT_SEED) {
 360             me->genmode = GOT_NOTHING;
 361         } else {
 362             /*
 363              * Generate a new random seed. 15 digits comes to about
 364              * 48 bits, which should be more than enough.
 365              *
 366              * I'll avoid putting a leading zero on the number,
 367              * just in case it confuses anybody who thinks it's
 368              * processed as an integer rather than a string.
 369              */
 370             char newseed[16];
 371             int i;
 372             newseed[15] = '\0';
 373             newseed[0] = '1' + (char)random_upto(me->random, 9);
 374             for (i = 1; i < 15; i++)
 375                 newseed[i] = '0' + (char)random_upto(me->random, 10);
 376             sfree(me->seedstr);
 377             me->seedstr = dupstr(newseed);
 378
 379             if (me->curparams)
 380                 me->ourgame->free_params(me->curparams);
 381             me->curparams = me->ourgame->dup_params(me->params);
 382         }
 383
 384         sfree(me->desc);
 385         sfree(me->privdesc);
 386         sfree(me->aux_info);
 387         me->aux_info = NULL;
 388
 389         rs = random_new(me->seedstr, strlen(me->seedstr));
 390         /*
 391          * If this midend has been instantiated without providing a
 392          * drawing API, it is non-interactive. This means that it's
 393          * being used for bulk game generation, and hence we should
 394          * pass the non-interactive flag to new_desc.
 395          */
 396         me->desc = me->ourgame->new_desc(me->curparams, rs,
 397                                          &me->aux_info, (me->drawing != NULL));
 398         me->privdesc = NULL;
 399         random_free(rs);
 400     }
 401
 402     ensure(me);
 403
 404     /*
 405      * It might seem a bit odd that we're using me->params to
 406      * create the initial game state, rather than me->curparams
 407      * which is better tailored to this specific game and which we
 408      * always know.
 409      *
 410      * It's supposed to be an invariant in the midend that
 411      * me->params and me->curparams differ in no aspect that is
 412      * important after generation (i.e. after new_desc()). By
 413      * deliberately passing the _less_ specific of these two
 414      * parameter sets, we provoke play-time misbehaviour in the
 415      * case where a game has failed to encode a play-time parameter
 416      * in the non-full version of encode_params().
 417      */
 418     me->states[me->nstates].state =
 419         me->ourgame->new_game(me, me->params, me->desc);
 420
 421     /*
 422      * As part of our commitment to self-testing, test the aux
 423      * string to make sure nothing ghastly went wrong.
 424      */
 425     if (me->ourgame->can_solve && me->aux_info) {
 426         game_state *s;
 427         char *msg, *movestr;
 428
 429         msg = NULL;
 430         movestr = me->ourgame->solve(me->states[0].state,
 431                                      me->states[0].state,
 432                                      me->aux_info, &msg);
 433         assert(movestr && !msg);
 434         s = me->ourgame->execute_move(me->states[0].state, movestr);
 435         assert(s);
 436         me->ourgame->free_game(s);
 437         sfree(movestr);
 438     }
 439
 440     /*
 441      * Soak test, enabled by setting <gamename>_TESTSOLVE in the
 442      * environment. This causes an immediate attempt to re-solve the
 443      * game without benefit of aux_info. The effect is that (at least
 444      * on Unix) you can run 'FOO_TESTSOLVE=1 foo --generate 10000
 445      * <params>#12345' and it will generate a lot of game ids and
 446      * instantly pass each one back to the solver.
 447      *
 448      * (It's worth putting in an explicit seed in any such test, so
 449      * you can repeat it to diagnose a problem if one comes up!)
 450      */
 451     {
 452         char buf[80];
 453         int j, k;
 454         static int doing_test_solve = -1;
 455         if (doing_test_solve < 0) {
 456             sprintf(buf, "%s_TESTSOLVE", me->ourgame->name);
 457             for (j = k = 0; buf[j]; j++)
 458                 if (!isspace((unsigned char)buf[j]))
 459                     buf[k++] = toupper((unsigned char)buf[j]);
 460             buf[k] = '\0';
 461             if (getenv(buf)) {
 462                 /*
 463                  * Since this is used for correctness testing, it's
 464                  * helpful to have a visual acknowledgment that the
 465                  * user hasn't mistyped the environment variable name.
 466                  */
 467                 fprintf(stderr, "Running solver soak tests\n");
 468                 doing_test_solve = TRUE;
 469             } else {
 470                 doing_test_solve = FALSE;
 471             }
 472         }
 473         if (doing_test_solve) {
 474             game_state *s;
 475             char *msg, *movestr;
 476
 477             msg = NULL;
 478             movestr = me->ourgame->solve(me->states[0].state,
 479                                          me->states[0].state,
 480                                          NULL, &msg);
 481             assert(movestr && !msg);
 482             s = me->ourgame->execute_move(me->states[0].state, movestr);
 483             assert(s);
 484             me->ourgame->free_game(s);
 485             sfree(movestr);
 486         }
 487     }
 488
 489     me->states[me->nstates].movestr = NULL;
 490     me->states[me->nstates].movetype = NEWGAME;
 491     me->nstates++;
 492     me->statepos = 1;
 493     me->drawstate = me->ourgame->new_drawstate(me->drawing,
 494                                                me->states[0].state);
 495     midend_size_new_drawstate(me);
 496     me->elapsed = 0.0F;
 497     if (me->ui)
 498         me->ourgame->free_ui(me->ui);
 499     me->ui = me->ourgame->new_ui(me->states[0].state);
 500     midend_set_timer(me);
 501     me->pressed_mouse_button = 0;
 502 }
 503
 504 int midend_can_undo(midend *me)
 505 {
 506     return (me->statepos > 1);
 507 }
 508
 509 int midend_can_redo(midend *me)
 510 {
 511     return (me->statepos < me->nstates);
 512 }
 513
 514 static int midend_undo(midend *me)
 515 {
 516     if (me->statepos > 1) {
 517         if (me->ui)
 518             me->ourgame->changed_state(me->ui,
 519                                        me->states[me->statepos-1].state,
 520                                        me->states[me->statepos-2].state);
 521         me->statepos--;
 522         me->dir = -1;
 523         return 1;
 524     } else
 525         return 0;
 526 }
 527
 528 static int midend_redo(midend *me)
 529 {
 530     if (me->statepos < me->nstates) {
 531         if (me->ui)
 532             me->ourgame->changed_state(me->ui,
 533                                        me->states[me->statepos-1].state,
 534                                        me->states[me->statepos].state);
 535         me->statepos++;
 536         me->dir = +1;
 537         return 1;
 538     } else
 539         return 0;
 540 }
 541
 542 static void midend_finish_move(midend *me)
 543 {
 544     float flashtime;
 545
 546     /*
 547      * We do not flash if the later of the two states is special.
 548      * This covers both forward Solve moves and backward (undone)
 549      * Restart moves.
 550      */
 551     if ((me->oldstate || me->statepos > 1) &&
 552         ((me->dir > 0 && !special(me->states[me->statepos-1].movetype)) ||
 553          (me->dir < 0 && me->statepos < me->nstates &&
 554           !special(me->states[me->statepos].movetype)))) {
 555         flashtime = me->ourgame->flash_length(me->oldstate ? me->oldstate :
 556                                               me->states[me->statepos-2].state,
 557                                               me->states[me->statepos-1].state,
 558                                               me->oldstate ? me->dir : +1,
 559                                               me->ui);
 560         if (flashtime > 0) {
 561             me->flash_pos = 0.0F;
 562             me->flash_time = flashtime;
 563         }
 564     }
 565
 566     if (me->oldstate)
 567         me->ourgame->free_game(me->oldstate);
 568     me->oldstate = NULL;
 569     me->anim_pos = me->anim_time = 0;
 570     me->dir = 0;
 571
 572     midend_set_timer(me);
 573 }
 574
 575 void midend_stop_anim(midend *me)
 576 {
 577     if (me->oldstate || me->anim_time != 0) {
 578         midend_finish_move(me);
 579         midend_redraw(me);
 580     }
 581 }
 582
 583 void midend_restart_game(midend *me)
 584 {
 585     game_state *s;
 586
 587     midend_stop_anim(me);
 588
 589     assert(me->statepos >= 1);
 590     if (me->statepos == 1)
 591         return;                        /* no point doing anything at all! */
 592
 593     /*
 594      * During restart, we reconstruct the game from the (public)
 595      * game description rather than from states[0], because that
 596      * way Mines gets slightly more sensible behaviour (restart
 597      * goes to _after_ the first click so you don't have to
 598      * remember where you clicked).
 599      */
 600     s = me->ourgame->new_game(me, me->params, me->desc);
 601
 602     /*
 603      * Now enter the restarted state as the next move.
 604      */
 605     midend_stop_anim(me);
 606     midend_purge_states(me);
 607     ensure(me);
 608     me->states[me->nstates].state = s;
 609     me->states[me->nstates].movestr = dupstr(me->desc);
 610     me->states[me->nstates].movetype = RESTART;
 611     me->statepos = ++me->nstates;
 612     if (me->ui)
 613         me->ourgame->changed_state(me->ui,
 614                                    me->states[me->statepos-2].state,
 615                                    me->states[me->statepos-1].state);
 616     me->anim_time = 0.0;
 617     midend_finish_move(me);
 618     midend_redraw(me);
 619     midend_set_timer(me);
 620 }
 621
 622 static int midend_really_process_key(midend *me, int x, int y, int button)
 623 {
 624     game_state *oldstate =
 625         me->ourgame->dup_game(me->states[me->statepos - 1].state);
 626     int type = MOVE, gottype = FALSE, ret = 1;
 627     float anim_time;
 628     game_state *s;
 629     char *movestr;
 630
 631     movestr =
 632         me->ourgame->interpret_move(me->states[me->statepos-1].state,
 633                                     me->ui, me->drawstate, x, y, button);
 634
 635     if (!movestr) {
 636         if (button == 'n' || button == 'N' || button == '\x0E') {
 637             midend_stop_anim(me);
 638             midend_new_game(me);
 639             midend_redraw(me);
 640             goto done;                 /* never animate */
 641         } else if (button == 'u' || button == 'u' ||
 642                    button == '\x1A' || button == '\x1F') {
 643             midend_stop_anim(me);
 644             type = me->states[me->statepos-1].movetype;
 645             gottype = TRUE;
 646             if (!midend_undo(me))
 647                 goto done;
 648         } else if (button == 'r' || button == 'R' ||
 649                    button == '\x12' || button == '\x19') {
 650             midend_stop_anim(me);
 651             if (!midend_redo(me))
 652                 goto done;
 653         } else if (button == '\x13' && me->ourgame->can_solve) {
 654             if (midend_solve(me))
 655                 goto done;
 656         } else if (button == 'q' || button == 'Q' || button == '\x11') {
 657             ret = 0;
 658             goto done;
 659         } else
 660             goto done;
 661     } else {
 662         if (!*movestr)
 663             s = me->states[me->statepos-1].state;
 664         else {
 665             s = me->ourgame->execute_move(me->states[me->statepos-1].state,
 666                                           movestr);
 667             assert(s != NULL);
 668         }
 669
 670         if (s == me->states[me->statepos-1].state) {
 671             /*
 672              * make_move() is allowed to return its input state to
 673              * indicate that although no move has been made, the UI
 674              * state has been updated and a redraw is called for.
 675              */
 676             midend_redraw(me);
 677             midend_set_timer(me);
 678             goto done;
 679         } else if (s) {
 680             midend_stop_anim(me);
 681             midend_purge_states(me);
 682             ensure(me);
 683             assert(movestr != NULL);
 684             me->states[me->nstates].state = s;
 685             me->states[me->nstates].movestr = movestr;
 686             me->states[me->nstates].movetype = MOVE;
 687             me->statepos = ++me->nstates;
 688             me->dir = +1;
 689             if (me->ui)
 690                 me->ourgame->changed_state(me->ui,
 691                                            me->states[me->statepos-2].state,
 692                                            me->states[me->statepos-1].state);
 693         } else {
 694             goto done;
 695         }
 696     }
 697
 698     if (!gottype)
 699         type = me->states[me->statepos-1].movetype;
 700
 701     /*
 702      * See if this move requires an animation.
 703      */
 704     if (special(type) && !(type == SOLVE &&
 705                            (me->ourgame->flags & SOLVE_ANIMATES))) {
 706         anim_time = 0;
 707     } else {
 708         anim_time = me->ourgame->anim_length(oldstate,
 709                                              me->states[me->statepos-1].state,
 710                                              me->dir, me->ui);
 711     }
 712
 713     me->oldstate = oldstate; oldstate = NULL;
 714     if (anim_time > 0) {
 715         me->anim_time = anim_time;
 716     } else {
 717         me->anim_time = 0.0;
 718         midend_finish_move(me);
 719     }
 720     me->anim_pos = 0.0;
 721
 722     midend_redraw(me);
 723
 724     midend_set_timer(me);
 725
 726     done:
 727     if (oldstate) me->ourgame->free_game(oldstate);
 728     return ret;
 729 }
 730
 731 int midend_process_key(midend *me, int x, int y, int button)
 732 {
 733     int ret = 1;
 734
 735     /*
 736      * Harmonise mouse drag and release messages.
 737      *
 738      * Some front ends might accidentally switch from sending, say,
 739      * RIGHT_DRAG messages to sending LEFT_DRAG, half way through a
 740      * drag. (This can happen on the Mac, for example, since
 741      * RIGHT_DRAG is usually done using Command+drag, and if the
 742      * user accidentally releases Command half way through the drag
 743      * then there will be trouble.)
 744      *
 745      * It would be an O(number of front ends) annoyance to fix this
 746      * in the front ends, but an O(number of back ends) annoyance
 747      * to have each game capable of dealing with it. Therefore, we
 748      * fix it _here_ in the common midend code so that it only has
 749      * to be done once.
 750      *
 751      * The possible ways in which things can go screwy in the front
 752      * end are:
 753      *
 754      *  - in a system containing multiple physical buttons button
 755      *    presses can inadvertently overlap. We can see ABab (caps
 756      *    meaning button-down and lowercase meaning button-up) when
 757      *    the user had semantically intended AaBb.
 758      *
 759      *  - in a system where one button is simulated by means of a
 760      *    modifier key and another button, buttons can mutate
 761      *    between press and release (possibly during drag). So we
 762      *    can see Ab instead of Aa.
 763      *
 764      * Definite requirements are:
 765      *
 766      *  - button _presses_ must never be invented or destroyed. If
 767      *    the user presses two buttons in succession, the button
 768      *    presses must be transferred to the backend unchanged. So
 769      *    if we see AaBb , that's fine; if we see ABab (the button
 770      *    presses inadvertently overlapped) we must somehow
 771      *    `correct' it to AaBb.
 772      *
 773      *  - every mouse action must end up looking like a press, zero
 774      *    or more drags, then a release. This allows back ends to
 775      *    make the _assumption_ that incoming mouse data will be
 776      *    sane in this regard, and not worry about the details.
 777      *
 778      * So my policy will be:
 779      *
 780      *  - treat any button-up as a button-up for the currently
 781      *    pressed button, or ignore it if there is no currently
 782      *    pressed button.
 783      *
 784      *  - treat any drag as a drag for the currently pressed
 785      *    button, or ignore it if there is no currently pressed
 786      *    button.
 787      *
 788      *  - if we see a button-down while another button is currently
 789      *    pressed, invent a button-up for the first one and then
 790      *    pass the button-down through as before.
 791      *
 792      * 2005-05-31: An addendum to the above. Some games might want
 793      * a `priority order' among buttons, such that if one button is
 794      * pressed while another is down then a fixed one of the
 795      * buttons takes priority no matter what order they're pressed
 796      * in. Mines, in particular, wants to treat a left+right click
 797      * like a left click for the benefit of users of other
 798      * implementations. So the last of the above points is modified
 799      * in the presence of an (optional) button priority order.
 800      *
 801      * A further addition: we translate certain keyboard presses to
 802      * cursor key 'select' buttons, so that a) frontends don't have
 803      * to translate these themselves (like they do for CURSOR_UP etc),
 804      * and b) individual games don't have to hard-code button presses
 805      * of '\n' etc for keyboard-based cursors. The choice of buttons
 806      * here could eventually be controlled by a runtime configuration
 807      * option.
 808      */
 809     if (IS_MOUSE_DRAG(button) || IS_MOUSE_RELEASE(button)) {
 810         if (me->pressed_mouse_button) {
 811             if (IS_MOUSE_DRAG(button)) {
 812                 button = me->pressed_mouse_button +
 813                     (LEFT_DRAG - LEFT_BUTTON);
 814             } else {
 815                 button = me->pressed_mouse_button +
 816                     (LEFT_RELEASE - LEFT_BUTTON);
 817             }
 818         } else
 819             return ret;                /* ignore it */
 820     } else if (IS_MOUSE_DOWN(button) && me->pressed_mouse_button) {
 821         /*
 822          * If the new button has lower priority than the old one,
 823          * don't bother doing this.
 824          */
 825         if (me->ourgame->flags &
 826             BUTTON_BEATS(me->pressed_mouse_button, button))
 827             return ret;                /* just ignore it */
 828
 829         /*
 830          * Fabricate a button-up for the previously pressed button.
 831          */
 832         ret = ret && midend_really_process_key
 833             (me, x, y, (me->pressed_mouse_button +
 834                         (LEFT_RELEASE - LEFT_BUTTON)));
 835     }
 836
 837     /*
 838      * Translate keyboard presses to cursor selection.
 839      */
 840     if (button == '\n' || button == '\r')
 841       button = CURSOR_SELECT;
 842     if (button == ' ')
 843       button = CURSOR_SELECT2;
 844
 845     /*
 846      * Normalise both backspace characters (8 and 127) to \b. Easier
 847      * to do this once, here, than to require all front ends to
 848      * carefully generate the same one - now each front end can
 849      * generate whichever is easiest.
 850      */
 851     if (button == '\177')
 852         button = '\b';
 853
 854     /*
 855      * Now send on the event we originally received.
 856      */
 857     ret = ret && midend_really_process_key(me, x, y, button);
 858
 859     /*
 860      * And update the currently pressed button.
 861      */
 862     if (IS_MOUSE_RELEASE(button))
 863         me->pressed_mouse_button = 0;
 864     else if (IS_MOUSE_DOWN(button))
 865         me->pressed_mouse_button = button;
 866
 867     return ret;
 868 }
 869
 870 void midend_redraw(midend *me)
 871 {
 872     assert(me->drawing);
 873
 874     if (me->statepos > 0 && me->drawstate) {
 875         start_draw(me->drawing);
 876         if (me->oldstate && me->anim_time > 0 &&
 877             me->anim_pos < me->anim_time) {
 878             assert(me->dir != 0);
 879             me->ourgame->redraw(me->drawing, me->drawstate, me->oldstate,
 880                                 me->states[me->statepos-1].state, me->dir,
 881                                 me->ui, me->anim_pos, me->flash_pos);
 882         } else {
 883             me->ourgame->redraw(me->drawing, me->drawstate, NULL,
 884                                 me->states[me->statepos-1].state, +1 /*shrug*/,
 885                                 me->ui, 0.0, me->flash_pos);
 886         }
 887         end_draw(me->drawing);
 888     }
 889 }
 890
 891 /*
 892  * Nasty hacky function used to implement the --redo option in
 893  * gtk.c. Only used for generating the puzzles' icons.
 894  */
 895 void midend_freeze_timer(midend *me, float tprop)
 896 {
 897     me->anim_pos = me->anim_time * tprop;
 898     midend_redraw(me);
 899     deactivate_timer(me->frontend);
 900 }
 901
 902 void midend_timer(midend *me, float tplus)
 903 {
 904     int need_redraw = (me->anim_time > 0 || me->flash_time > 0);
 905
 906     me->anim_pos += tplus;
 907     if (me->anim_pos >= me->anim_time ||
 908         me->anim_time == 0 || !me->oldstate) {
 909         if (me->anim_time > 0)
 910             midend_finish_move(me);
 911     }
 912
 913     me->flash_pos += tplus;
 914     if (me->flash_pos >= me->flash_time || me->flash_time == 0) {
 915         me->flash_pos = me->flash_time = 0;
 916     }
 917
 918     if (need_redraw)
 919         midend_redraw(me);
 920
 921     if (me->timing) {
 922         float oldelapsed = me->elapsed;
 923         me->elapsed += tplus;
 924         if ((int)oldelapsed != (int)me->elapsed)
 925             status_bar(me->drawing, me->laststatus ? me->laststatus : "");
 926     }
 927
 928     midend_set_timer(me);
 929 }
 930
 931 float *midend_colours(midend *me, int *ncolours)
 932 {
 933     float *ret;
 934
 935     ret = me->ourgame->colours(me->frontend, ncolours);
 936
 937     {
 938         int i;
 939
 940         /*
 941          * Allow environment-based overrides for the standard
 942          * colours by defining variables along the lines of
 943          * `NET_COLOUR_4=6000c0'.
 944          */
 945
 946         for (i = 0; i < *ncolours; i++) {
 947             char buf[80], *e;
 948             unsigned int r, g, b;
 949             int j, k;
 950
 951             sprintf(buf, "%s_COLOUR_%d", me->ourgame->name, i);
 952             for (j = k = 0; buf[j]; j++)
 953                 if (!isspace((unsigned char)buf[j]))
 954                     buf[k++] = toupper((unsigned char)buf[j]);
 955             buf[k] = '\0';
 956             if ((e = getenv(buf)) != NULL &&
 957                 sscanf(e, "%2x%2x%2x", &r, &g, &b) == 3) {
 958                 ret[i*3 + 0] = r / 255.0F;
 959                 ret[i*3 + 1] = g / 255.0F;
 960                 ret[i*3 + 2] = b / 255.0F;
 961             }
 962         }
 963     }
 964
 965     return ret;
 966 }
 967
 968 int midend_num_presets(midend *me)
 969 {
 970     if (!me->npresets) {
 971         char *name;
 972         game_params *preset;
 973
 974         while (me->ourgame->fetch_preset(me->npresets, &name, &preset)) {
 975             if (me->presetsize <= me->npresets) {
 976                 me->presetsize = me->npresets + 10;
 977                 me->presets = sresize(me->presets, me->presetsize,
 978                                       game_params *);
 979                 me->preset_names = sresize(me->preset_names, me->presetsize,
 980                                            char *);
 981                 me->preset_encodings = sresize(me->preset_encodings,
 982                                                me->presetsize, char *);
 983             }
 984
 985             me->presets[me->npresets] = preset;
 986             me->preset_names[me->npresets] = name;
 987             me->preset_encodings[me->npresets] =
 988                 me->ourgame->encode_params(preset, TRUE);;
 989             me->npresets++;
 990         }
 991     }
 992
 993     {
 994         /*
 995          * Allow environment-based extensions to the preset list by
 996          * defining a variable along the lines of `SOLO_PRESETS=2x3
 997          * Advanced:2x3da'. Colon-separated list of items,
 998          * alternating between textual titles in the menu and
 999          * encoded parameter strings.
1000          */
1001         char buf[80], *e, *p;
1002         int j, k;
1003
1004         sprintf(buf, "%s_PRESETS", me->ourgame->name);
1005         for (j = k = 0; buf[j]; j++)
1006             if (!isspace((unsigned char)buf[j]))
1007                 buf[k++] = toupper((unsigned char)buf[j]);
1008         buf[k] = '\0';
1009
1010         if ((e = getenv(buf)) != NULL) {
1011             p = e = dupstr(e);
1012
1013             while (*p) {
1014                 char *name, *val;
1015                 game_params *preset;
1016
1017                 name = p;
1018                 while (*p && *p != ':') p++;
1019                 if (*p) *p++ = '\0';
1020                 val = p;
1021                 while (*p && *p != ':') p++;
1022                 if (*p) *p++ = '\0';
1023
1024                 preset = me->ourgame->default_params();
1025                 me->ourgame->decode_params(preset, val);
1026
1027                 if (me->ourgame->validate_params(preset, TRUE)) {
1028                     /* Drop this one from the list. */
1029                     me->ourgame->free_params(preset);
1030                     continue;
1031                 }
1032
1033                 if (me->presetsize <= me->npresets) {
1034                     me->presetsize = me->npresets + 10;
1035                     me->presets = sresize(me->presets, me->presetsize,
1036                                           game_params *);
1037                     me->preset_names = sresize(me->preset_names,
1038                                                me->presetsize, char *);
1039                     me->preset_encodings = sresize(me->preset_encodings,
1040                                                    me->presetsize, char *);
1041                 }
1042
1043                 me->presets[me->npresets] = preset;
1044                 me->preset_names[me->npresets] = dupstr(name);
1045                 me->preset_encodings[me->npresets] =
1046                     me->ourgame->encode_params(preset, TRUE);
1047                 me->npresets++;
1048             }
1049             sfree(e);
1050         }
1051     }
1052
1053     return me->npresets;
1054 }
1055
1056 void midend_fetch_preset(midend *me, int n,
1057                          char **name, game_params **params)
1058 {
1059     assert(n >= 0 && n < me->npresets);
1060     *name = me->preset_names[n];
1061     *params = me->presets[n];
1062 }
1063
1064 int midend_which_preset(midend *me)
1065 {
1066     char *encoding = me->ourgame->encode_params(me->params, TRUE);
1067     int i, ret;
1068
1069     ret = -1;
1070     for (i = 0; i < me->npresets; i++)
1071         if (!strcmp(encoding, me->preset_encodings[i])) {
1072             ret = i;
1073             break;
1074         }
1075
1076     sfree(encoding);
1077     return ret;
1078 }
1079
1080 int midend_wants_statusbar(midend *me)
1081 {
1082     return me->ourgame->wants_statusbar;
1083 }
1084
1085 void midend_request_desc_changes(midend *me, void (*notify)(void *), void *ctx)
1086 {
1087     me->game_desc_change_notify_function = notify;
1088     me->game_desc_change_notify_ctx = ctx;
1089 }
1090
1091 void midend_supersede_game_desc(midend *me, char *desc, char *privdesc)
1092 {
1093     sfree(me->desc);
1094     sfree(me->privdesc);
1095     me->desc = dupstr(desc);
1096     me->privdesc = privdesc ? dupstr(privdesc) : NULL;
1097     if (me->game_desc_change_notify_function)
1098         me->game_desc_change_notify_function(me->game_desc_change_notify_ctx);
1099 }
1100
1101 config_item *midend_get_config(midend *me, int which, char **wintitle)
1102 {
1103     char *titlebuf, *parstr, *rest;
1104     config_item *ret;
1105     char sep;
1106
1107     assert(wintitle);
1108     titlebuf = snewn(40 + strlen(me->ourgame->name), char);
1109
1110     switch (which) {
1111       case CFG_SETTINGS:
1112         sprintf(titlebuf, "%s configuration", me->ourgame->name);
1113         *wintitle = titlebuf;
1114         return me->ourgame->configure(me->params);
1115       case CFG_SEED:
1116       case CFG_DESC:
1117         if (!me->curparams) {
1118           sfree(titlebuf);
1119           return NULL;
1120         }
1121         sprintf(titlebuf, "%s %s selection", me->ourgame->name,
1122                 which == CFG_SEED ? "random" : "game");
1123         *wintitle = titlebuf;
1124
1125         ret = snewn(2, config_item);
1126
1127         ret[0].type = C_STRING;
1128         if (which == CFG_SEED)
1129             ret[0].name = "Game random seed";
1130         else
1131             ret[0].name = "Game ID";
1132         ret[0].ival = 0;
1133         /*
1134          * For CFG_DESC the text going in here will be a string
1135          * encoding of the restricted parameters, plus a colon,
1136          * plus the game description. For CFG_SEED it will be the
1137          * full parameters, plus a hash, plus the random seed data.
1138          * Either of these is a valid full game ID (although only
1139          * the former is likely to persist across many code
1140          * changes).
1141          */
1142         parstr = me->ourgame->encode_params(me->curparams, which == CFG_SEED);
1143         assert(parstr);
1144         if (which == CFG_DESC) {
1145             rest = me->desc ? me->desc : "";
1146             sep = ':';
1147         } else {
1148             rest = me->seedstr ? me->seedstr : "";
1149             sep = '#';
1150         }
1151         ret[0].sval = snewn(strlen(parstr) + strlen(rest) + 2, char);
1152         sprintf(ret[0].sval, "%s%c%s", parstr, sep, rest);
1153         sfree(parstr);
1154
1155         ret[1].type = C_END;
1156         ret[1].name = ret[1].sval = NULL;
1157         ret[1].ival = 0;
1158
1159         return ret;
1160     }
1161
1162     assert(!"We shouldn't be here");
1163     return NULL;
1164 }
1165
1166 static char *midend_game_id_int(midend *me, char *id, int defmode)
1167 {
1168     char *error, *par, *desc, *seed;
1169     game_params *newcurparams, *newparams, *oldparams1, *oldparams2;
1170     int free_params;
1171
1172     seed = strchr(id, '#');
1173     desc = strchr(id, ':');
1174
1175     if (desc && (!seed || desc < seed)) {
1176         /*
1177          * We have a colon separating parameters from game
1178          * description. So `par' now points to the parameters
1179          * string, and `desc' to the description string.
1180          */
1181         *desc++ = '\0';
1182         par = id;
1183         seed = NULL;
1184     } else if (seed && (!desc || seed < desc)) {
1185         /*
1186          * We have a hash separating parameters from random seed.
1187          * So `par' now points to the parameters string, and `seed'
1188          * to the seed string.
1189          */
1190         *seed++ = '\0';
1191         par = id;
1192         desc = NULL;
1193     } else {
1194         /*
1195          * We only have one string. Depending on `defmode', we take
1196          * it to be either parameters, seed or description.
1197          */
1198         if (defmode == DEF_SEED) {
1199             seed = id;
1200             par = desc = NULL;
1201         } else if (defmode == DEF_DESC) {
1202             desc = id;
1203             par = seed = NULL;
1204         } else {
1205             par = id;
1206             seed = desc = NULL;
1207         }
1208     }
1209
1210     /*
1211      * We must be reasonably careful here not to modify anything in
1212      * `me' until we have finished validating things. This function
1213      * must either return an error and do nothing to the midend, or
1214      * return success and do everything; nothing in between is
1215      * acceptable.
1216      */
1217     newcurparams = newparams = oldparams1 = oldparams2 = NULL;
1218
1219     if (par) {
1220         newcurparams = me->ourgame->dup_params(me->params);
1221         me->ourgame->decode_params(newcurparams, par);
1222         error = me->ourgame->validate_params(newcurparams, desc == NULL);
1223         if (error) {
1224             me->ourgame->free_params(newcurparams);
1225             return error;
1226         }
1227         oldparams1 = me->curparams;
1228
1229         /*
1230          * Now filter only the persistent parts of this state into
1231          * the long-term params structure, unless we've _only_
1232          * received a params string in which case the whole lot is
1233          * persistent.
1234          */
1235         oldparams2 = me->params;
1236         if (seed || desc) {
1237             char *tmpstr;
1238
1239             newparams = me->ourgame->dup_params(me->params);
1240
1241             tmpstr = me->ourgame->encode_params(newcurparams, FALSE);
1242             me->ourgame->decode_params(newparams, tmpstr);
1243
1244             sfree(tmpstr);
1245         } else {
1246             newparams = me->ourgame->dup_params(newcurparams);
1247         }
1248         free_params = TRUE;
1249     } else {
1250         newcurparams = me->curparams;
1251         newparams = me->params;
1252         free_params = FALSE;
1253     }
1254
1255     if (desc) {
1256         error = me->ourgame->validate_desc(newparams, desc);
1257         if (error) {
1258             if (free_params) {
1259                 if (newcurparams)
1260                     me->ourgame->free_params(newcurparams);
1261                 if (newparams)
1262                     me->ourgame->free_params(newparams);
1263             }
1264             return error;
1265         }
1266     }
1267
1268     /*
1269      * Now we've got past all possible error points. Update the
1270      * midend itself.
1271      */
1272     me->params = newparams;
1273     me->curparams = newcurparams;
1274     if (oldparams1)
1275         me->ourgame->free_params(oldparams1);
1276     if (oldparams2)
1277         me->ourgame->free_params(oldparams2);
1278
1279     sfree(me->desc);
1280     sfree(me->privdesc);
1281     me->desc = me->privdesc = NULL;
1282     sfree(me->seedstr);
1283     me->seedstr = NULL;
1284
1285     if (desc) {
1286         me->desc = dupstr(desc);
1287         me->genmode = GOT_DESC;
1288         sfree(me->aux_info);
1289         me->aux_info = NULL;
1290     }
1291
1292     if (seed) {
1293         me->seedstr = dupstr(seed);
1294         me->genmode = GOT_SEED;
1295     }
1296
1297     return NULL;
1298 }
1299
1300 char *midend_game_id(midend *me, char *id)
1301 {
1302     return midend_game_id_int(me, id, DEF_PARAMS);
1303 }
1304
1305 char *midend_get_game_id(midend *me)
1306 {
1307     char *parstr, *ret;
1308
1309     parstr = me->ourgame->encode_params(me->curparams, FALSE);
1310     assert(parstr);
1311     assert(me->desc);
1312     ret = snewn(strlen(parstr) + strlen(me->desc) + 2, char);
1313     sprintf(ret, "%s:%s", parstr, me->desc);
1314     sfree(parstr);
1315     return ret;
1316 }
1317
1318 char *midend_get_random_seed(midend *me)
1319 {
1320     char *parstr, *ret;
1321
1322     if (!me->seedstr)
1323         return NULL;
1324
1325     parstr = me->ourgame->encode_params(me->curparams, TRUE);
1326     assert(parstr);
1327     ret = snewn(strlen(parstr) + strlen(me->seedstr) + 2, char);
1328     sprintf(ret, "%s#%s", parstr, me->seedstr);
1329     sfree(parstr);
1330     return ret;
1331 }
1332
1333 char *midend_set_config(midend *me, int which, config_item *cfg)
1334 {
1335     char *error;
1336     game_params *params;
1337
1338     switch (which) {
1339       case CFG_SETTINGS:
1340         params = me->ourgame->custom_params(cfg);
1341         error = me->ourgame->validate_params(params, TRUE);
1342
1343         if (error) {
1344             me->ourgame->free_params(params);
1345             return error;
1346         }
1347
1348         me->ourgame->free_params(me->params);
1349         me->params = params;
1350         break;
1351
1352       case CFG_SEED:
1353       case CFG_DESC:
1354         error = midend_game_id_int(me, cfg[0].sval,
1355                                    (which == CFG_SEED ? DEF_SEED : DEF_DESC));
1356         if (error)
1357             return error;
1358         break;
1359     }
1360
1361     return NULL;
1362 }
1363
1364 int midend_can_format_as_text_now(midend *me)
1365 {
1366     if (me->ourgame->can_format_as_text_ever)
1367         return me->ourgame->can_format_as_text_now(me->params);
1368     else
1369         return FALSE;
1370 }
1371
1372 char *midend_text_format(midend *me)
1373 {
1374     if (me->ourgame->can_format_as_text_ever && me->statepos > 0 &&
1375         me->ourgame->can_format_as_text_now(me->params))
1376         return me->ourgame->text_format(me->states[me->statepos-1].state);
1377     else
1378         return NULL;
1379 }
1380
1381 char *midend_solve(midend *me)
1382 {
1383     game_state *s;
1384     char *msg, *movestr;
1385
1386     if (!me->ourgame->can_solve)
1387         return "This game does not support the Solve operation";
1388
1389     if (me->statepos < 1)
1390         return "No game set up to solve";   /* _shouldn't_ happen! */
1391
1392     msg = NULL;
1393     movestr = me->ourgame->solve(me->states[0].state,
1394                                  me->states[me->statepos-1].state,
1395                                  me->aux_info, &msg);
1396     if (!movestr) {
1397         if (!msg)
1398             msg = "Solve operation failed";   /* _shouldn't_ happen, but can */
1399         return msg;
1400     }
1401     s = me->ourgame->execute_move(me->states[me->statepos-1].state, movestr);
1402     assert(s);
1403
1404     /*
1405      * Now enter the solved state as the next move.
1406      */
1407     midend_stop_anim(me);
1408     midend_purge_states(me);
1409     ensure(me);
1410     me->states[me->nstates].state = s;
1411     me->states[me->nstates].movestr = movestr;
1412     me->states[me->nstates].movetype = SOLVE;
1413     me->statepos = ++me->nstates;
1414     if (me->ui)
1415         me->ourgame->changed_state(me->ui,
1416                                    me->states[me->statepos-2].state,
1417                                    me->states[me->statepos-1].state);
1418     me->dir = +1;
1419     if (me->ourgame->flags & SOLVE_ANIMATES) {
1420         me->oldstate = me->ourgame->dup_game(me->states[me->statepos-2].state);
1421         me->anim_time =
1422             me->ourgame->anim_length(me->states[me->statepos-2].state,
1423                                      me->states[me->statepos-1].state,
1424                                      +1, me->ui);
1425         me->anim_pos = 0.0;
1426     } else {
1427         me->anim_time = 0.0;
1428         midend_finish_move(me);
1429     }
1430     if (me->drawing)
1431         midend_redraw(me);
1432     midend_set_timer(me);
1433     return NULL;
1434 }
1435
1436 int midend_status(midend *me)
1437 {
1438     /*
1439      * We should probably never be called when the state stack has no
1440      * states on it at all - ideally, midends should never be left in
1441      * that state for long enough to get put down and forgotten about.
1442      * But if we are, I think we return _true_ - pedantically speaking
1443      * a midend in that state is 'vacuously solved', and more
1444      * practically, a user whose midend has been left in that state
1445      * probably _does_ want the 'new game' option to be prominent.
1446      */
1447     if (me->statepos == 0)
1448         return +1;
1449
1450     return me->ourgame->status(me->states[me->statepos-1].state);
1451 }
1452
1453 char *midend_rewrite_statusbar(midend *me, char *text)
1454 {
1455     /*
1456      * An important special case is that we are occasionally called
1457      * with our own laststatus, to update the timer.
1458      */
1459     if (me->laststatus != text) {
1460         sfree(me->laststatus);
1461         me->laststatus = dupstr(text);
1462     }
1463
1464     if (me->ourgame->is_timed) {
1465         char timebuf[100], *ret;
1466         int min, sec;
1467
1468         sec = (int)me->elapsed;
1469         min = sec / 60;
1470         sec %= 60;
1471         sprintf(timebuf, "[%d:%02d] ", min, sec);
1472
1473         ret = snewn(strlen(timebuf) + strlen(text) + 1, char);
1474         strcpy(ret, timebuf);
1475         strcat(ret, text);
1476         return ret;
1477
1478     } else {
1479         return dupstr(text);
1480     }
1481 }
1482
1483 #define SERIALISE_MAGIC "Simon Tatham's Portable Puzzle Collection"
1484 #define SERIALISE_VERSION "1"
1485
1486 void midend_serialise(midend *me,
1487                       void (*write)(void *ctx, void *buf, int len),
1488                       void *wctx)
1489 {
1490     int i;
1491
1492     /*
1493      * Each line of the save file contains three components. First
1494      * exactly 8 characters of header word indicating what type of
1495      * data is contained on the line; then a colon followed by a
1496      * decimal integer giving the length of the main string on the
1497      * line; then a colon followed by the string itself (exactly as
1498      * many bytes as previously specified, no matter what they
1499      * contain). Then a newline (of reasonably flexible form).
1500      */
1501 #define wr(h,s) do { \
1502     char hbuf[80]; \
1503     char *str = (s); \
1504     sprintf(hbuf, "%-8.8s:%d:", (h), (int)strlen(str)); \
1505     write(wctx, hbuf, strlen(hbuf)); \
1506     write(wctx, str, strlen(str)); \
1507     write(wctx, "\n", 1); \
1508 } while (0)
1509
1510     /*
1511      * Magic string identifying the file, and version number of the
1512      * file format.
1513      */
1514     wr("SAVEFILE", SERIALISE_MAGIC);
1515     wr("VERSION", SERIALISE_VERSION);
1516
1517     /*
1518      * The game name. (Copied locally to avoid const annoyance.)
1519      */
1520     {
1521         char *s = dupstr(me->ourgame->name);
1522         wr("GAME", s);
1523         sfree(s);
1524     }
1525
1526     /*
1527      * The current long-term parameters structure, in full.
1528      */
1529     if (me->params) {
1530         char *s = me->ourgame->encode_params(me->params, TRUE);
1531         wr("PARAMS", s);
1532         sfree(s);
1533     }
1534
1535     /*
1536      * The current short-term parameters structure, in full.
1537      */
1538     if (me->curparams) {
1539         char *s = me->ourgame->encode_params(me->curparams, TRUE);
1540         wr("CPARAMS", s);
1541         sfree(s);
1542     }
1543
1544     /*
1545      * The current game description, the privdesc, and the random seed.
1546      */
1547     if (me->seedstr)
1548         wr("SEED", me->seedstr);
1549     if (me->desc)
1550         wr("DESC", me->desc);
1551     if (me->privdesc)
1552         wr("PRIVDESC", me->privdesc);
1553
1554     /*
1555      * The game's aux_info. We obfuscate this to prevent spoilers
1556      * (people are likely to run `head' or similar on a saved game
1557      * file simply to find out what it is, and don't necessarily
1558      * want to be told the answer to the puzzle!)
1559      */
1560     if (me->aux_info) {
1561         unsigned char *s1;
1562         char *s2;
1563         int len;
1564
1565         len = strlen(me->aux_info);
1566         s1 = snewn(len, unsigned char);
1567         memcpy(s1, me->aux_info, len);
1568         obfuscate_bitmap(s1, len*8, FALSE);
1569         s2 = bin2hex(s1, len);
1570
1571         wr("AUXINFO", s2);
1572
1573         sfree(s2);
1574         sfree(s1);
1575     }
1576
1577     /*
1578      * Any required serialisation of the game_ui.
1579      */
1580     if (me->ui) {
1581         char *s = me->ourgame->encode_ui(me->ui);
1582         if (s) {
1583             wr("UI", s);
1584             sfree(s);
1585         }
1586     }
1587
1588     /*
1589      * The game time, if it's a timed game.
1590      */
1591     if (me->ourgame->is_timed) {
1592         char buf[80];
1593         sprintf(buf, "%g", me->elapsed);
1594         wr("TIME", buf);
1595     }
1596
1597     /*
1598      * The length of, and position in, the states list.
1599      */
1600     {
1601         char buf[80];
1602         sprintf(buf, "%d", me->nstates);
1603         wr("NSTATES", buf);
1604         sprintf(buf, "%d", me->statepos);
1605         wr("STATEPOS", buf);
1606     }
1607
1608     /*
1609      * For each state after the initial one (which we know is
1610      * constructed from either privdesc or desc), enough
1611      * information for execute_move() to reconstruct it from the
1612      * previous one.
1613      */
1614     for (i = 1; i < me->nstates; i++) {
1615         assert(me->states[i].movetype != NEWGAME);   /* only state 0 */
1616         switch (me->states[i].movetype) {
1617           case MOVE:
1618             wr("MOVE", me->states[i].movestr);
1619             break;
1620           case SOLVE:
1621             wr("SOLVE", me->states[i].movestr);
1622             break;
1623           case RESTART:
1624             wr("RESTART", me->states[i].movestr);
1625             break;
1626         }
1627     }
1628
1629 #undef wr
1630 }
1631
1632 /*
1633  * This function returns NULL on success, or an error message.
1634  */
1635 char *midend_deserialise(midend *me,
1636                          int (*read)(void *ctx, void *buf, int len),
1637                          void *rctx)
1638 {
1639     int nstates = 0, statepos = -1, gotstates = 0;
1640     int started = FALSE;
1641     int i;
1642
1643     char *val = NULL;
1644     /* Initially all errors give the same report */
1645     char *ret = "Data does not appear to be a saved game file";
1646
1647     /*
1648      * We construct all the new state in local variables while we
1649      * check its sanity. Only once we have finished reading the
1650      * serialised data and detected no errors at all do we start
1651      * modifying stuff in the midend passed in.
1652      */
1653     char *seed = NULL, *parstr = NULL, *desc = NULL, *privdesc = NULL;
1654     char *auxinfo = NULL, *uistr = NULL, *cparstr = NULL;
1655     float elapsed = 0.0F;
1656     game_params *params = NULL, *cparams = NULL;
1657     game_ui *ui = NULL;
1658     struct midend_state_entry *states = NULL;
1659
1660     /*
1661      * Loop round and round reading one key/value pair at a time
1662      * from the serialised stream, until we have enough game states
1663      * to finish.
1664      */
1665     while (nstates <= 0 || statepos < 0 || gotstates < nstates-1) {
1666         char key[9], c;
1667         int len;
1668
1669         do {
1670             if (!read(rctx, key, 1)) {
1671                 /* unexpected EOF */
1672                 goto cleanup;
1673             }
1674         } while (key[0] == '\r' || key[0] == '\n');
1675
1676         if (!read(rctx, key+1, 8)) {
1677             /* unexpected EOF */
1678             goto cleanup;
1679         }
1680
1681         if (key[8] != ':') {
1682             if (started)
1683                 ret = "Data was incorrectly formatted for a saved game file";
1684             goto cleanup;
1685         }
1686         len = strcspn(key, ": ");
1687         assert(len <= 8);
1688         key[len] = '\0';
1689
1690         len = 0;
1691         while (1) {
1692             if (!read(rctx, &c, 1)) {
1693                 /* unexpected EOF */
1694                 goto cleanup;
1695             }
1696
1697             if (c == ':') {
1698                 break;
1699             } else if (c >= '0' && c <= '9') {
1700                 len = (len * 10) + (c - '0');
1701             } else {
1702                 if (started)
1703                     ret = "Data was incorrectly formatted for a"
1704                     " saved game file";
1705                 goto cleanup;
1706             }
1707         }
1708
1709         val = snewn(len+1, char);
1710         if (!read(rctx, val, len)) {
1711             if (started)
1712             goto cleanup;
1713         }
1714         val[len] = '\0';
1715
1716         if (!started) {
1717             if (strcmp(key, "SAVEFILE") || strcmp(val, SERIALISE_MAGIC)) {
1718                 /* ret already has the right message in it */
1719                 goto cleanup;
1720             }
1721             /* Now most errors are this one, unless otherwise specified */
1722             ret = "Saved data ended unexpectedly";
1723             started = TRUE;
1724         } else {
1725             if (!strcmp(key, "VERSION")) {
1726                 if (strcmp(val, SERIALISE_VERSION)) {
1727                     ret = "Cannot handle this version of the saved game"
1728                         " file format";
1729                     goto cleanup;
1730                 }
1731             } else if (!strcmp(key, "GAME")) {
1732                 if (strcmp(val, me->ourgame->name)) {
1733                     ret = "Save file is from a different game";
1734                     goto cleanup;
1735                 }
1736             } else if (!strcmp(key, "PARAMS")) {
1737                 sfree(parstr);
1738                 parstr = val;
1739                 val = NULL;
1740             } else if (!strcmp(key, "CPARAMS")) {
1741                 sfree(cparstr);
1742                 cparstr = val;
1743                 val = NULL;
1744             } else if (!strcmp(key, "SEED")) {
1745                 sfree(seed);
1746                 seed = val;
1747                 val = NULL;
1748             } else if (!strcmp(key, "DESC")) {
1749                 sfree(desc);
1750                 desc = val;
1751                 val = NULL;
1752             } else if (!strcmp(key, "PRIVDESC")) {
1753                 sfree(privdesc);
1754                 privdesc = val;
1755                 val = NULL;
1756             } else if (!strcmp(key, "AUXINFO")) {
1757                 unsigned char *tmp;
1758                 int len = strlen(val) / 2;   /* length in bytes */
1759                 tmp = hex2bin(val, len);
1760                 obfuscate_bitmap(tmp, len*8, TRUE);
1761
1762                 sfree(auxinfo);
1763                 auxinfo = snewn(len + 1, char);
1764                 memcpy(auxinfo, tmp, len);
1765                 auxinfo[len] = '\0';
1766                 sfree(tmp);
1767             } else if (!strcmp(key, "UI")) {
1768                 sfree(uistr);
1769                 uistr = val;
1770                 val = NULL;
1771             } else if (!strcmp(key, "TIME")) {
1772                 elapsed = (float)atof(val);
1773             } else if (!strcmp(key, "NSTATES")) {
1774                 nstates = atoi(val);
1775                 if (nstates <= 0) {
1776                     ret = "Number of states in save file was negative";
1777                     goto cleanup;
1778                 }
1779                 if (states) {
1780                     ret = "Two state counts provided in save file";
1781                     goto cleanup;
1782                 }
1783                 states = snewn(nstates, struct midend_state_entry);
1784                 for (i = 0; i < nstates; i++) {
1785                     states[i].state = NULL;
1786                     states[i].movestr = NULL;
1787                     states[i].movetype = NEWGAME;
1788                 }
1789             } else if (!strcmp(key, "STATEPOS")) {
1790                 statepos = atoi(val);
1791             } else if (!strcmp(key, "MOVE")) {
1792                 gotstates++;
1793                 states[gotstates].movetype = MOVE;
1794                 states[gotstates].movestr = val;
1795                 val = NULL;
1796             } else if (!strcmp(key, "SOLVE")) {
1797                 gotstates++;
1798                 states[gotstates].movetype = SOLVE;
1799                 states[gotstates].movestr = val;
1800                 val = NULL;
1801             } else if (!strcmp(key, "RESTART")) {
1802                 gotstates++;
1803                 states[gotstates].movetype = RESTART;
1804                 states[gotstates].movestr = val;
1805                 val = NULL;
1806             }
1807         }
1808
1809         sfree(val);
1810         val = NULL;
1811     }
1812
1813     params = me->ourgame->default_params();
1814     me->ourgame->decode_params(params, parstr);
1815     if (me->ourgame->validate_params(params, TRUE)) {
1816         ret = "Long-term parameters in save file are invalid";
1817         goto cleanup;
1818     }
1819     cparams = me->ourgame->default_params();
1820     me->ourgame->decode_params(cparams, cparstr);
1821     if (me->ourgame->validate_params(cparams, FALSE)) {
1822         ret = "Short-term parameters in save file are invalid";
1823         goto cleanup;
1824     }
1825     if (seed && me->ourgame->validate_params(cparams, TRUE)) {
1826         /*
1827          * The seed's no use with this version, but we can perfectly
1828          * well use the rest of the data.
1829          */
1830         sfree(seed);
1831         seed = NULL;
1832     }
1833     if (!desc) {
1834         ret = "Game description in save file is missing";
1835         goto cleanup;
1836     } else if (me->ourgame->validate_desc(params, desc)) {
1837         ret = "Game description in save file is invalid";
1838         goto cleanup;
1839     }
1840     if (privdesc && me->ourgame->validate_desc(params, privdesc)) {
1841         ret = "Game private description in save file is invalid";
1842         goto cleanup;
1843     }
1844     if (statepos < 0 || statepos >= nstates) {
1845         ret = "Game position in save file is out of range";
1846     }
1847
1848     states[0].state = me->ourgame->new_game(me, params,
1849                                             privdesc ? privdesc : desc);
1850     for (i = 1; i < nstates; i++) {
1851         assert(states[i].movetype != NEWGAME);
1852         switch (states[i].movetype) {
1853           case MOVE:
1854           case SOLVE:
1855             states[i].state = me->ourgame->execute_move(states[i-1].state,
1856                                                         states[i].movestr);
1857             if (states[i].state == NULL) {
1858                 ret = "Save file contained an invalid move";
1859                 goto cleanup;
1860             }
1861             break;
1862           case RESTART:
1863             if (me->ourgame->validate_desc(params, states[i].movestr)) {
1864                 ret = "Save file contained an invalid restart move";
1865                 goto cleanup;
1866             }
1867             states[i].state = me->ourgame->new_game(me, params,
1868                                                     states[i].movestr);
1869             break;
1870         }
1871     }
1872
1873     ui = me->ourgame->new_ui(states[0].state);
1874     me->ourgame->decode_ui(ui, uistr);
1875
1876     /*
1877      * Now we've run out of possible error conditions, so we're
1878      * ready to start overwriting the real data in the current
1879      * midend. We'll do this by swapping things with the local
1880      * variables, so that the same cleanup code will free the old
1881      * stuff.
1882      */
1883     {
1884         char *tmp;
1885
1886         tmp = me->desc;
1887         me->desc = desc;
1888         desc = tmp;
1889
1890         tmp = me->privdesc;
1891         me->privdesc = privdesc;
1892         privdesc = tmp;
1893
1894         tmp = me->seedstr;
1895         me->seedstr = seed;
1896         seed = tmp;
1897
1898         tmp = me->aux_info;
1899         me->aux_info = auxinfo;
1900         auxinfo = tmp;
1901     }
1902
1903     me->genmode = GOT_NOTHING;
1904
1905     me->statesize = nstates;
1906     nstates = me->nstates;
1907     me->nstates = me->statesize;
1908     {
1909         struct midend_state_entry *tmp;
1910         tmp = me->states;
1911         me->states = states;
1912         states = tmp;
1913     }
1914     me->statepos = statepos;
1915
1916     {
1917         game_params *tmp;
1918
1919         tmp = me->params;
1920         me->params = params;
1921         params = tmp;
1922
1923         tmp = me->curparams;
1924         me->curparams = cparams;
1925         cparams = tmp;
1926     }
1927
1928     me->oldstate = NULL;
1929     me->anim_time = me->anim_pos = me->flash_time = me->flash_pos = 0.0F;
1930     me->dir = 0;
1931
1932     {
1933         game_ui *tmp;
1934
1935         tmp = me->ui;
1936         me->ui = ui;
1937         ui = tmp;
1938     }
1939
1940     me->elapsed = elapsed;
1941     me->pressed_mouse_button = 0;
1942
1943     midend_set_timer(me);
1944
1945     if (me->drawstate)
1946         me->ourgame->free_drawstate(me->drawing, me->drawstate);
1947     me->drawstate =
1948         me->ourgame->new_drawstate(me->drawing,
1949                                    me->states[me->statepos-1].state);
1950     midend_size_new_drawstate(me);
1951
1952     ret = NULL;                        /* success! */
1953
1954     cleanup:
1955     sfree(val);
1956     sfree(seed);
1957     sfree(parstr);
1958     sfree(cparstr);
1959     sfree(desc);
1960     sfree(privdesc);
1961     sfree(auxinfo);
1962     sfree(uistr);
1963     if (params)
1964         me->ourgame->free_params(params);
1965     if (cparams)
1966         me->ourgame->free_params(cparams);
1967     if (ui)
1968         me->ourgame->free_ui(ui);
1969     if (states) {
1970         int i;
1971
1972         for (i = 0; i < nstates; i++) {
1973             if (states[i].state)
1974                 me->ourgame->free_game(states[i].state);
1975             sfree(states[i].movestr);
1976         }
1977         sfree(states);
1978     }
1979
1980     return ret;
1981 }
1982
1983 /*
1984  * This function examines a saved game file just far enough to
1985  * determine which game type it contains. It returns NULL on success
1986  * and the game name string in 'name' (which will be dynamically
1987  * allocated and should be caller-freed), or an error message on
1988  * failure.
1989  */
1990 char *identify_game(char **name, int (*read)(void *ctx, void *buf, int len),
1991                     void *rctx)
1992 {
1993     int nstates = 0, statepos = -1, gotstates = 0;
1994     int started = FALSE;
1995
1996     char *val = NULL;
1997     /* Initially all errors give the same report */
1998     char *ret = "Data does not appear to be a saved game file";
1999
2000     *name = NULL;
2001
2002     /*
2003      * Loop round and round reading one key/value pair at a time from
2004      * the serialised stream, until we've found the game name.
2005      */
2006     while (nstates <= 0 || statepos < 0 || gotstates < nstates-1) {
2007         char key[9], c;
2008         int len;
2009
2010         do {
2011             if (!read(rctx, key, 1)) {
2012                 /* unexpected EOF */
2013                 goto cleanup;
2014             }
2015         } while (key[0] == '\r' || key[0] == '\n');
2016
2017         if (!read(rctx, key+1, 8)) {
2018             /* unexpected EOF */
2019             goto cleanup;
2020         }
2021
2022         if (key[8] != ':') {
2023             if (started)
2024                 ret = "Data was incorrectly formatted for a saved game file";
2025             goto cleanup;
2026         }
2027         len = strcspn(key, ": ");
2028         assert(len <= 8);
2029         key[len] = '\0';
2030
2031         len = 0;
2032         while (1) {
2033             if (!read(rctx, &c, 1)) {
2034                 /* unexpected EOF */
2035                 goto cleanup;
2036             }
2037
2038             if (c == ':') {
2039                 break;
2040             } else if (c >= '0' && c <= '9') {
2041                 len = (len * 10) + (c - '0');
2042             } else {
2043                 if (started)
2044                     ret = "Data was incorrectly formatted for a"
2045                     " saved game file";
2046                 goto cleanup;
2047             }
2048         }
2049
2050         val = snewn(len+1, char);
2051         if (!read(rctx, val, len)) {
2052             if (started)
2053             goto cleanup;
2054         }
2055         val[len] = '\0';
2056
2057         if (!started) {
2058             if (strcmp(key, "SAVEFILE") || strcmp(val, SERIALISE_MAGIC)) {
2059                 /* ret already has the right message in it */
2060                 goto cleanup;
2061             }
2062             /* Now most errors are this one, unless otherwise specified */
2063             ret = "Saved data ended unexpectedly";
2064             started = TRUE;
2065         } else {
2066             if (!strcmp(key, "VERSION")) {
2067                 if (strcmp(val, SERIALISE_VERSION)) {
2068                     ret = "Cannot handle this version of the saved game"
2069                         " file format";
2070                     goto cleanup;
2071                 }
2072             } else if (!strcmp(key, "GAME")) {
2073                 *name = dupstr(val);
2074                 ret = NULL;
2075                 goto cleanup;
2076             }
2077         }
2078
2079         sfree(val);
2080         val = NULL;
2081     }
2082
2083     cleanup:
2084     sfree(val);
2085     return ret;
2086 }
2087
2088 char *midend_print_puzzle(midend *me, document *doc, int with_soln)
2089 {
2090     game_state *soln = NULL;
2091
2092     if (me->statepos < 1)
2093         return "No game set up to print";/* _shouldn't_ happen! */
2094
2095     if (with_soln) {
2096         char *msg, *movestr;
2097
2098         if (!me->ourgame->can_solve)
2099             return "This game does not support the Solve operation";
2100
2101         msg = "Solve operation failed";/* game _should_ overwrite on error */
2102         movestr = me->ourgame->solve(me->states[0].state,
2103                                      me->states[me->statepos-1].state,
2104                                      me->aux_info, &msg);
2105         if (!movestr)
2106             return msg;
2107         soln = me->ourgame->execute_move(me->states[me->statepos-1].state,
2108                                          movestr);
2109         assert(soln);
2110
2111         sfree(movestr);
2112     } else
2113         soln = NULL;
2114
2115     /*
2116      * This call passes over ownership of the two game_states and
2117      * the game_params. Hence we duplicate the ones we want to
2118      * keep, and we don't have to bother freeing soln if it was
2119      * non-NULL.
2120      */
2121     document_add_puzzle(doc, me->ourgame,
2122                         me->ourgame->dup_params(me->curparams),
2123                         me->ourgame->dup_game(me->states[0].state), soln);
2124
2125     return NULL;
2126 }