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