gtk.c

   1 /*
   2  * gtk.c: GTK front end for my puzzle collection.
   3  */
   4
   5 #include <stdio.h>
   6 #include <assert.h>
   7 #include <stdlib.h>
   8 #include <time.h>
   9 #include <stdarg.h>
  10 #include <string.h>
  11 #include <errno.h>
  12 #include <math.h>
  13
  14 #include <sys/time.h>
  15 #include <sys/resource.h>
  16
  17 #include <gtk/gtk.h>
  18 #include <gdk/gdkkeysyms.h>
  19
  20 #include <gdk-pixbuf/gdk-pixbuf.h>
  21
  22 #include <gdk/gdkx.h>
  23 #include <X11/Xlib.h>
  24 #include <X11/Xutil.h>
  25 #include <X11/Xatom.h>
  26
  27 #include "puzzles.h"
  28
  29 #if GTK_CHECK_VERSION(2,0,0)
  30 # define USE_PANGO
  31 # ifdef PANGO_VERSION_CHECK
  32 #  if PANGO_VERSION_CHECK(1,8,0)
  33 #   define HAVE_SENSIBLE_ABSOLUTE_SIZE_FUNCTION
  34 #  endif
  35 # endif
  36 #endif
  37 #if !GTK_CHECK_VERSION(2,4,0)
  38 # define OLD_FILESEL
  39 #endif
  40 #if GTK_CHECK_VERSION(2,8,0)
  41 # define USE_CAIRO
  42 # if defined(GDK_DISABLE_DEPRECATED)
  43 #  define USE_CAIRO_WITHOUT_PIXMAP
  44 # endif
  45 #endif
  46
  47 /* #undef USE_CAIRO */
  48 /* #define NO_THICK_LINE */
  49 #ifdef DEBUGGING
  50 static FILE *debug_fp = NULL;
  51
  52 void dputs(char *buf)
  53 {
  54     if (!debug_fp) {
  55         debug_fp = fopen("debug.log", "w");
  56     }
  57
  58     fputs(buf, stderr);
  59
  60     if (debug_fp) {
  61         fputs(buf, debug_fp);
  62         fflush(debug_fp);
  63     }
  64 }
  65
  66 void debug_printf(char *fmt, ...)
  67 {
  68     char buf[4096];
  69     va_list ap;
  70
  71     va_start(ap, fmt);
  72     vsprintf(buf, fmt, ap);
  73     dputs(buf);
  74     va_end(ap);
  75 }
  76 #endif
  77
  78 /* ----------------------------------------------------------------------
  79  * Error reporting functions used elsewhere.
  80  */
  81
  82 void fatal(char *fmt, ...)
  83 {
  84     va_list ap;
  85
  86     fprintf(stderr, "fatal error: ");
  87
  88     va_start(ap, fmt);
  89     vfprintf(stderr, fmt, ap);
  90     va_end(ap);
  91
  92     fprintf(stderr, "\n");
  93     exit(1);
  94 }
  95
  96 /* ----------------------------------------------------------------------
  97  * GTK front end to puzzles.
  98  */
  99
 100 static void changed_preset(frontend *fe);
 101
 102 struct font {
 103 #ifdef USE_PANGO
 104     PangoFontDescription *desc;
 105 #else
 106     GdkFont *font;
 107 #endif
 108     int type;
 109     int size;
 110 };
 111
 112 /*
 113  * This structure holds all the data relevant to a single window.
 114  * In principle this would allow us to open multiple independent
 115  * puzzle windows, although I can't currently see any real point in
 116  * doing so. I'm just coding cleanly because there's no
 117  * particularly good reason not to.
 118  */
 119 struct frontend {
 120     GtkWidget *window;
 121     GtkAccelGroup *accelgroup;
 122     GtkWidget *area;
 123     GtkWidget *statusbar;
 124     GtkWidget *menubar;
 125     guint statusctx;
 126     int w, h;
 127     midend *me;
 128 #ifdef USE_CAIRO
 129     const float *colours;
 130     cairo_t *cr;
 131     cairo_surface_t *image;
 132 #ifndef USE_CAIRO_WITHOUT_PIXMAP
 133     GdkPixmap *pixmap;
 134 #endif
 135     GdkColor background;               /* for painting outside puzzle area */
 136 #else
 137     GdkPixmap *pixmap;
 138     GdkGC *gc;
 139     GdkColor *colours;
 140     GdkColormap *colmap;
 141     int backgroundindex;               /* which of colours[] is background */
 142 #endif
 143     int ncolours;
 144     int bbox_l, bbox_r, bbox_u, bbox_d;
 145     int timer_active, timer_id;
 146     struct timeval last_time;
 147     struct font *fonts;
 148     int nfonts, fontsize;
 149     config_item *cfg;
 150     int cfg_which, cfgret;
 151     GtkWidget *cfgbox;
 152     void *paste_data;
 153     int paste_data_len;
 154     int pw, ph;                        /* pixmap size (w, h are area size) */
 155     int ox, oy;                        /* offset of pixmap in drawing area */
 156 #ifdef OLD_FILESEL
 157     char *filesel_name;
 158 #endif
 159     int drawing_area_shrink_pending;
 160     GSList *preset_radio;
 161     int n_preset_menu_items;
 162     int preset_threaded;
 163     GtkWidget *preset_custom;
 164     GtkWidget *copy_menu_item;
 165     int menubar_is_local;
 166 };
 167
 168 struct blitter {
 169 #ifdef USE_CAIRO
 170     cairo_surface_t *image;
 171 #else
 172     GdkPixmap *pixmap;
 173 #endif
 174     int w, h, x, y;
 175 };
 176
 177 void get_random_seed(void **randseed, int *randseedsize)
 178 {
 179     struct timeval *tvp = snew(struct timeval);
 180     gettimeofday(tvp, NULL);
 181     *randseed = (void *)tvp;
 182     *randseedsize = sizeof(struct timeval);
 183 }
 184
 185 void frontend_default_colour(frontend *fe, float *output)
 186 {
 187     GdkColor col = gtk_widget_get_style(fe->window)->bg[GTK_STATE_NORMAL];
 188     output[0] = col.red / 65535.0;
 189     output[1] = col.green / 65535.0;
 190     output[2] = col.blue / 65535.0;
 191 }
 192
 193 void gtk_status_bar(void *handle, char *text)
 194 {
 195     frontend *fe = (frontend *)handle;
 196
 197     assert(fe->statusbar);
 198
 199     gtk_statusbar_pop(GTK_STATUSBAR(fe->statusbar), fe->statusctx);
 200     gtk_statusbar_push(GTK_STATUSBAR(fe->statusbar), fe->statusctx, text);
 201 }
 202
 203 /* ----------------------------------------------------------------------
 204  * Cairo drawing functions.
 205  */
 206
 207 #ifdef USE_CAIRO
 208
 209 static void setup_drawing(frontend *fe)
 210 {
 211     fe->cr = cairo_create(fe->image);
 212     cairo_set_antialias(fe->cr, CAIRO_ANTIALIAS_GRAY);
 213     cairo_set_line_width(fe->cr, 1.0);
 214     cairo_set_line_cap(fe->cr, CAIRO_LINE_CAP_SQUARE);
 215     cairo_set_line_join(fe->cr, CAIRO_LINE_JOIN_ROUND);
 216 }
 217
 218 static void teardown_drawing(frontend *fe)
 219 {
 220     cairo_destroy(fe->cr);
 221     fe->cr = NULL;
 222
 223 #ifndef USE_CAIRO_WITHOUT_PIXMAP
 224     {
 225         cairo_t *cr = gdk_cairo_create(fe->pixmap);
 226         cairo_set_source_surface(cr, fe->image, 0, 0);
 227         cairo_rectangle(cr,
 228                         fe->bbox_l - 1,
 229                         fe->bbox_u - 1,
 230                         fe->bbox_r - fe->bbox_l + 2,
 231                         fe->bbox_d - fe->bbox_u + 2);
 232         cairo_fill(cr);
 233         cairo_destroy(cr);
 234     }
 235 #endif
 236 }
 237
 238 static void snaffle_colours(frontend *fe)
 239 {
 240     fe->colours = midend_colours(fe->me, &fe->ncolours);
 241 }
 242
 243 static void set_colour(frontend *fe, int colour)
 244 {
 245     cairo_set_source_rgb(fe->cr,
 246                          fe->colours[3*colour + 0],
 247                          fe->colours[3*colour + 1],
 248                          fe->colours[3*colour + 2]);
 249 }
 250
 251 static void set_window_background(frontend *fe, int colour)
 252 {
 253     GdkColormap *colmap;
 254
 255     colmap = gdk_colormap_get_system();
 256     fe->background.red = fe->colours[3*colour + 0] * 65535;
 257     fe->background.green = fe->colours[3*colour + 1] * 65535;
 258     fe->background.blue = fe->colours[3*colour + 2] * 65535;
 259     if (!gdk_colormap_alloc_color(colmap, &fe->background, FALSE, FALSE)) {
 260         g_error("couldn't allocate background (#%02x%02x%02x)\n",
 261                 fe->background.red >> 8, fe->background.green >> 8,
 262                 fe->background.blue >> 8);
 263     }
 264     gdk_window_set_background(gtk_widget_get_window(fe->area),
 265                               &fe->background);
 266     gdk_window_set_background(gtk_widget_get_window(fe->window),
 267                               &fe->background);
 268 }
 269
 270 static PangoLayout *make_pango_layout(frontend *fe)
 271 {
 272     return (pango_cairo_create_layout(fe->cr));
 273 }
 274
 275 static void draw_pango_layout(frontend *fe, PangoLayout *layout,
 276                               int x, int y)
 277 {
 278     cairo_move_to(fe->cr, x, y);
 279     pango_cairo_show_layout(fe->cr, layout);
 280 }
 281
 282 static void save_screenshot_png(frontend *fe, const char *screenshot_file)
 283 {
 284     cairo_surface_write_to_png(fe->image, screenshot_file);
 285 }
 286
 287 static void do_clip(frontend *fe, int x, int y, int w, int h)
 288 {
 289     cairo_new_path(fe->cr);
 290     cairo_rectangle(fe->cr, x, y, w, h);
 291     cairo_clip(fe->cr);
 292 }
 293
 294 static void do_unclip(frontend *fe)
 295 {
 296     cairo_reset_clip(fe->cr);
 297 }
 298
 299 static void do_draw_rect(frontend *fe, int x, int y, int w, int h)
 300 {
 301     cairo_save(fe->cr);
 302     cairo_new_path(fe->cr);
 303     cairo_set_antialias(fe->cr, CAIRO_ANTIALIAS_NONE);
 304     cairo_rectangle(fe->cr, x, y, w, h);
 305     cairo_fill(fe->cr);
 306     cairo_restore(fe->cr);
 307 }
 308
 309 static void do_draw_line(frontend *fe, int x1, int y1, int x2, int y2)
 310 {
 311     cairo_new_path(fe->cr);
 312     cairo_move_to(fe->cr, x1 + 0.5, y1 + 0.5);
 313     cairo_line_to(fe->cr, x2 + 0.5, y2 + 0.5);
 314     cairo_stroke(fe->cr);
 315 }
 316
 317 static void do_draw_thick_line(frontend *fe, float thickness,
 318                                float x1, float y1, float x2, float y2)
 319 {
 320     cairo_save(fe->cr);
 321     cairo_set_line_width(fe->cr, thickness);
 322     cairo_new_path(fe->cr);
 323     cairo_move_to(fe->cr, x1, y1);
 324     cairo_line_to(fe->cr, x2, y2);
 325     cairo_stroke(fe->cr);
 326     cairo_restore(fe->cr);
 327 }
 328
 329 static void do_draw_poly(frontend *fe, int *coords, int npoints,
 330                          int fillcolour, int outlinecolour)
 331 {
 332     int i;
 333
 334     cairo_new_path(fe->cr);
 335     for (i = 0; i < npoints; i++)
 336         cairo_line_to(fe->cr, coords[i*2] + 0.5, coords[i*2 + 1] + 0.5);
 337     cairo_close_path(fe->cr);
 338     if (fillcolour >= 0) {
 339         set_colour(fe, fillcolour);
 340         cairo_fill_preserve(fe->cr);
 341     }
 342     assert(outlinecolour >= 0);
 343     set_colour(fe, outlinecolour);
 344     cairo_stroke(fe->cr);
 345 }
 346
 347 static void do_draw_circle(frontend *fe, int cx, int cy, int radius,
 348                            int fillcolour, int outlinecolour)
 349 {
 350     cairo_new_path(fe->cr);
 351     cairo_arc(fe->cr, cx + 0.5, cy + 0.5, radius, 0, 2*PI);
 352     cairo_close_path(fe->cr);           /* Just in case... */
 353     if (fillcolour >= 0) {
 354         set_colour(fe, fillcolour);
 355         cairo_fill_preserve(fe->cr);
 356     }
 357     assert(outlinecolour >= 0);
 358     set_colour(fe, outlinecolour);
 359     cairo_stroke(fe->cr);
 360 }
 361
 362 static void setup_blitter(blitter *bl, int w, int h)
 363 {
 364     bl->image = cairo_image_surface_create(CAIRO_FORMAT_RGB24, w, h);
 365 }
 366
 367 static void teardown_blitter(blitter *bl)
 368 {
 369     cairo_surface_destroy(bl->image);
 370 }
 371
 372 static void do_blitter_save(frontend *fe, blitter *bl, int x, int y)
 373 {
 374     cairo_t *cr = cairo_create(bl->image);
 375
 376     cairo_set_source_surface(cr, fe->image, -x, -y);
 377     cairo_paint(cr);
 378     cairo_destroy(cr);
 379 }
 380
 381 static void do_blitter_load(frontend *fe, blitter *bl, int x, int y)
 382 {
 383     cairo_set_source_surface(fe->cr, bl->image, x, y);
 384     cairo_paint(fe->cr);
 385 }
 386
 387 static void clear_backing_store(frontend *fe)
 388 {
 389     fe->image = NULL;
 390 }
 391
 392 static void wipe_and_destroy_cairo(frontend *fe, cairo_t *cr)
 393 {
 394     cairo_set_source_rgb(cr, fe->colours[0], fe->colours[1], fe->colours[2]);
 395     cairo_paint(cr);
 396     cairo_destroy(cr);
 397 }
 398
 399 static void setup_backing_store(frontend *fe)
 400 {
 401 #ifndef USE_CAIRO_WITHOUT_PIXMAP
 402     fe->pixmap = gdk_pixmap_new(gtk_widget_get_window(fe->area),
 403                                 fe->pw, fe->ph, -1);
 404 #endif
 405     fe->image = cairo_image_surface_create(CAIRO_FORMAT_RGB24,
 406                                            fe->pw, fe->ph);
 407
 408     wipe_and_destroy_cairo(fe, cairo_create(fe->image));
 409 #ifndef USE_CAIRO_WITHOUT_PIXMAP
 410     wipe_and_destroy_cairo(fe, gdk_cairo_create(fe->pixmap));
 411 #endif
 412     wipe_and_destroy_cairo(fe, gdk_cairo_create
 413                            (gtk_widget_get_window(fe->area)));
 414 }
 415
 416 static int backing_store_ok(frontend *fe)
 417 {
 418     return (!!fe->image);
 419 }
 420
 421 static void teardown_backing_store(frontend *fe)
 422 {
 423     cairo_surface_destroy(fe->image);
 424 #ifndef USE_CAIRO_WITHOUT_PIXMAP
 425     gdk_pixmap_unref(fe->pixmap);
 426 #endif
 427     fe->image = NULL;
 428 }
 429
 430 #endif
 431
 432 /* ----------------------------------------------------------------------
 433  * GDK drawing functions.
 434  */
 435
 436 #ifndef USE_CAIRO
 437
 438 static void setup_drawing(frontend *fe)
 439 {
 440     fe->gc = gdk_gc_new(fe->area->window);
 441 }
 442
 443 static void teardown_drawing(frontend *fe)
 444 {
 445     gdk_gc_unref(fe->gc);
 446     fe->gc = NULL;
 447 }
 448
 449 static void snaffle_colours(frontend *fe)
 450 {
 451     int i, ncolours;
 452     float *colours;
 453     gboolean *success;
 454
 455     fe->colmap = gdk_colormap_get_system();
 456     colours = midend_colours(fe->me, &ncolours);
 457     fe->ncolours = ncolours;
 458     fe->colours = snewn(ncolours, GdkColor);
 459     for (i = 0; i < ncolours; i++) {
 460         fe->colours[i].red = colours[i*3] * 0xFFFF;
 461         fe->colours[i].green = colours[i*3+1] * 0xFFFF;
 462         fe->colours[i].blue = colours[i*3+2] * 0xFFFF;
 463     }
 464     success = snewn(ncolours, gboolean);
 465     gdk_colormap_alloc_colors(fe->colmap, fe->colours, ncolours,
 466                               FALSE, FALSE, success);
 467     for (i = 0; i < ncolours; i++) {
 468         if (!success[i]) {
 469             g_error("couldn't allocate colour %d (#%02x%02x%02x)\n",
 470                     i, fe->colours[i].red >> 8,
 471                     fe->colours[i].green >> 8,
 472                     fe->colours[i].blue >> 8);
 473         }
 474     }
 475 }
 476
 477 static void set_window_background(frontend *fe, int colour)
 478 {
 479     fe->backgroundindex = colour;
 480     gdk_window_set_background(fe->area->window, &fe->colours[colour]);
 481     gdk_window_set_background(fe->window->window, &fe->colours[colour]);
 482 }
 483
 484 static void set_colour(frontend *fe, int colour)
 485 {
 486     gdk_gc_set_foreground(fe->gc, &fe->colours[colour]);
 487 }
 488
 489 #ifdef USE_PANGO
 490 static PangoLayout *make_pango_layout(frontend *fe)
 491 {
 492     return (pango_layout_new(gtk_widget_get_pango_context(fe->area)));
 493 }
 494
 495 static void draw_pango_layout(frontend *fe, PangoLayout *layout,
 496                               int x, int y)
 497 {
 498     gdk_draw_layout(fe->pixmap, fe->gc, x, y, layout);
 499 }
 500 #endif
 501
 502 static void save_screenshot_png(frontend *fe, const char *screenshot_file)
 503 {
 504     GdkPixbuf *pb;
 505     GError *gerror = NULL;
 506
 507     midend_redraw(fe->me);
 508
 509     pb = gdk_pixbuf_get_from_drawable(NULL, fe->pixmap,
 510                                       NULL, 0, 0, 0, 0, -1, -1);
 511     gdk_pixbuf_save(pb, screenshot_file, "png", &gerror, NULL);
 512 }
 513
 514 static void do_clip(frontend *fe, int x, int y, int w, int h)
 515 {
 516     GdkRectangle rect;
 517
 518     rect.x = x;
 519     rect.y = y;
 520     rect.width = w;
 521     rect.height = h;
 522     gdk_gc_set_clip_rectangle(fe->gc, &rect);
 523 }
 524
 525 static void do_unclip(frontend *fe)
 526 {
 527     GdkRectangle rect;
 528
 529     rect.x = 0;
 530     rect.y = 0;
 531     rect.width = fe->w;
 532     rect.height = fe->h;
 533     gdk_gc_set_clip_rectangle(fe->gc, &rect);
 534 }
 535
 536 static void do_draw_rect(frontend *fe, int x, int y, int w, int h)
 537 {
 538     gdk_draw_rectangle(fe->pixmap, fe->gc, 1, x, y, w, h);
 539 }
 540
 541 static void do_draw_line(frontend *fe, int x1, int y1, int x2, int y2)
 542 {
 543     gdk_draw_line(fe->pixmap, fe->gc, x1, y1, x2, y2);
 544 }
 545
 546 static void do_draw_thick_line(frontend *fe, float thickness,
 547                                float x1, float y1, float x2, float y2)
 548 {
 549     GdkGCValues save;
 550
 551     gdk_gc_get_values(fe->gc, &save);
 552     gdk_gc_set_line_attributes(fe->gc,
 553                                thickness,
 554                                GDK_LINE_SOLID,
 555                                GDK_CAP_BUTT,
 556                                GDK_JOIN_BEVEL);
 557     gdk_draw_line(fe->pixmap, fe->gc, x1, y1, x2, y2);
 558     gdk_gc_set_line_attributes(fe->gc,
 559                                save.line_width,
 560                                save.line_style,
 561                                save.cap_style,
 562                                save.join_style);
 563 }
 564
 565 static void do_draw_poly(frontend *fe, int *coords, int npoints,
 566                          int fillcolour, int outlinecolour)
 567 {
 568     GdkPoint *points = snewn(npoints, GdkPoint);
 569     int i;
 570
 571     for (i = 0; i < npoints; i++) {
 572         points[i].x = coords[i*2];
 573         points[i].y = coords[i*2+1];
 574     }
 575
 576     if (fillcolour >= 0) {
 577         set_colour(fe, fillcolour);
 578         gdk_draw_polygon(fe->pixmap, fe->gc, TRUE, points, npoints);
 579     }
 580     assert(outlinecolour >= 0);
 581     set_colour(fe, outlinecolour);
 582
 583     /*
 584      * In principle we ought to be able to use gdk_draw_polygon for
 585      * the outline as well. In fact, it turns out to interact badly
 586      * with a clipping region, for no terribly obvious reason, so I
 587      * draw the outline as a sequence of lines instead.
 588      */
 589     for (i = 0; i < npoints; i++)
 590         gdk_draw_line(fe->pixmap, fe->gc,
 591                       points[i].x, points[i].y,
 592                       points[(i+1)%npoints].x, points[(i+1)%npoints].y);
 593
 594     sfree(points);
 595 }
 596
 597 static void do_draw_circle(frontend *fe, int cx, int cy, int radius,
 598                            int fillcolour, int outlinecolour)
 599 {
 600     if (fillcolour >= 0) {
 601         set_colour(fe, fillcolour);
 602         gdk_draw_arc(fe->pixmap, fe->gc, TRUE,
 603                      cx - radius, cy - radius,
 604                      2 * radius, 2 * radius, 0, 360 * 64);
 605     }
 606
 607     assert(outlinecolour >= 0);
 608     set_colour(fe, outlinecolour);
 609     gdk_draw_arc(fe->pixmap, fe->gc, FALSE,
 610                  cx - radius, cy - radius,
 611                  2 * radius, 2 * radius, 0, 360 * 64);
 612 }
 613
 614 static void setup_blitter(blitter *bl, int w, int h)
 615 {
 616     /*
 617      * We can't create the pixmap right now, because fe->window
 618      * might not yet exist. So we just cache w and h and create it
 619      * during the firs call to blitter_save.
 620      */
 621     bl->pixmap = NULL;
 622 }
 623
 624 static void teardown_blitter(blitter *bl)
 625 {
 626     if (bl->pixmap)
 627         gdk_pixmap_unref(bl->pixmap);
 628 }
 629
 630 static void do_blitter_save(frontend *fe, blitter *bl, int x, int y)
 631 {
 632     if (!bl->pixmap)
 633         bl->pixmap = gdk_pixmap_new(fe->area->window, bl->w, bl->h, -1);
 634     gdk_draw_pixmap(bl->pixmap,
 635                     fe->area->style->fg_gc[GTK_WIDGET_STATE(fe->area)],
 636                     fe->pixmap,
 637                     x, y, 0, 0, bl->w, bl->h);
 638 }
 639
 640 static void do_blitter_load(frontend *fe, blitter *bl, int x, int y)
 641 {
 642     assert(bl->pixmap);
 643     gdk_draw_pixmap(fe->pixmap,
 644                     fe->area->style->fg_gc[GTK_WIDGET_STATE(fe->area)],
 645                     bl->pixmap,
 646                     0, 0, x, y, bl->w, bl->h);
 647 }
 648
 649 static void clear_backing_store(frontend *fe)
 650 {
 651     fe->pixmap = NULL;
 652 }
 653
 654 static void setup_backing_store(frontend *fe)
 655 {
 656     GdkGC *gc;
 657
 658     fe->pixmap = gdk_pixmap_new(fe->area->window, fe->pw, fe->ph, -1);
 659
 660     gc = gdk_gc_new(fe->area->window);
 661     gdk_gc_set_foreground(gc, &fe->colours[0]);
 662     gdk_draw_rectangle(fe->pixmap, gc, 1, 0, 0, fe->pw, fe->ph);
 663     gdk_draw_rectangle(fe->area->window, gc, 1, 0, 0, fe->w, fe->h);
 664     gdk_gc_unref(gc);
 665 }
 666
 667 static int backing_store_ok(frontend *fe)
 668 {
 669     return (!!fe->pixmap);
 670 }
 671
 672 static void teardown_backing_store(frontend *fe)
 673 {
 674     gdk_pixmap_unref(fe->pixmap);
 675     fe->pixmap = NULL;
 676 }
 677
 678 #endif
 679
 680 #ifndef USE_CAIRO_WITHOUT_PIXMAP
 681 static void repaint_rectangle(frontend *fe, GtkWidget *widget,
 682                               int x, int y, int w, int h)
 683 {
 684     GdkGC *gc = gdk_gc_new(gtk_widget_get_window(widget));
 685 #ifdef USE_CAIRO
 686     gdk_gc_set_foreground(gc, &fe->background);
 687 #else
 688     gdk_gc_set_foreground(gc, &fe->colours[fe->backgroundindex]);
 689 #endif
 690     if (x < fe->ox) {
 691         gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
 692                            TRUE, x, y, fe->ox - x, h);
 693         w -= (fe->ox - x);
 694         x = fe->ox;
 695     }
 696     if (y < fe->oy) {
 697         gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
 698                            TRUE, x, y, w, fe->oy - y);
 699         h -= (fe->oy - y);
 700         y = fe->oy;
 701     }
 702     if (w > fe->pw) {
 703         gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
 704                            TRUE, x + fe->pw, y, w - fe->pw, h);
 705         w = fe->pw;
 706     }
 707     if (h > fe->ph) {
 708         gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
 709                            TRUE, x, y + fe->ph, w, h - fe->ph);
 710         h = fe->ph;
 711     }
 712     gdk_draw_pixmap(gtk_widget_get_window(widget), gc, fe->pixmap,
 713                     x - fe->ox, y - fe->oy, x, y, w, h);
 714     gdk_gc_unref(gc);
 715 }
 716 #endif
 717
 718 /* ----------------------------------------------------------------------
 719  * Pango font functions.
 720  */
 721
 722 #ifdef USE_PANGO
 723
 724 static void add_font(frontend *fe, int index, int fonttype, int fontsize)
 725 {
 726     /*
 727      * Use Pango to find the closest match to the requested
 728      * font.
 729      */
 730     PangoFontDescription *fd;
 731
 732     fd = pango_font_description_new();
 733     /* `Monospace' and `Sans' are meta-families guaranteed to exist */
 734     pango_font_description_set_family(fd, fonttype == FONT_FIXED ?
 735                                       "Monospace" : "Sans");
 736     pango_font_description_set_weight(fd, PANGO_WEIGHT_BOLD);
 737     /*
 738      * I found some online Pango documentation which
 739      * described a function called
 740      * pango_font_description_set_absolute_size(), which is
 741      * _exactly_ what I want here. Unfortunately, none of
 742      * my local Pango installations have it (presumably
 743      * they're too old), so I'm going to have to hack round
 744      * it by figuring out the point size myself. This
 745      * limits me to X and probably also breaks in later
 746      * Pango installations, so ideally I should add another
 747      * CHECK_VERSION type ifdef and use set_absolute_size
 748      * where available. All very annoying.
 749      */
 750 #ifdef HAVE_SENSIBLE_ABSOLUTE_SIZE_FUNCTION
 751     pango_font_description_set_absolute_size(fd, PANGO_SCALE*fontsize);
 752 #else
 753     {
 754         Display *d = GDK_DISPLAY();
 755         int s = DefaultScreen(d);
 756         double resolution =
 757             (PANGO_SCALE * 72.27 / 25.4) *
 758             ((double) DisplayWidthMM(d, s) / DisplayWidth (d, s));
 759         pango_font_description_set_size(fd, resolution * fontsize);
 760     }
 761 #endif
 762     fe->fonts[index].desc = fd;
 763 }
 764
 765 static void align_and_draw_text(frontend *fe,
 766                                 int index, int align, int x, int y,
 767                                 const char *text)
 768 {
 769     PangoLayout *layout;
 770     PangoRectangle rect;
 771
 772     layout = make_pango_layout(fe);
 773
 774     /*
 775      * Create a layout.
 776      */
 777     pango_layout_set_font_description(layout, fe->fonts[index].desc);
 778     pango_layout_set_text(layout, text, strlen(text));
 779     pango_layout_get_pixel_extents(layout, NULL, &rect);
 780
 781     if (align & ALIGN_VCENTRE)
 782         rect.y -= rect.height / 2;
 783     else
 784         rect.y -= rect.height;
 785
 786     if (align & ALIGN_HCENTRE)
 787         rect.x -= rect.width / 2;
 788     else if (align & ALIGN_HRIGHT)
 789         rect.x -= rect.width;
 790
 791     draw_pango_layout(fe, layout, rect.x + x, rect.y + y);
 792
 793     g_object_unref(layout);
 794 }
 795
 796 #endif
 797
 798 /* ----------------------------------------------------------------------
 799  * Old-fashioned font functions.
 800  */
 801
 802 #ifndef USE_PANGO
 803
 804 static void add_font(int index, int fonttype, int fontsize)
 805 {
 806     /*
 807      * In GTK 1.2, I don't know of any plausible way to
 808      * pick a suitable font, so I'm just going to be
 809      * tedious.
 810      */
 811     fe->fonts[i].font = gdk_font_load(fonttype == FONT_FIXED ?
 812                                       "fixed" : "variable");
 813 }
 814
 815 static void align_and_draw_text(int index, int align, int x, int y,
 816                                 const char *text)
 817 {
 818     int lb, rb, wid, asc, desc;
 819
 820     /*
 821      * Measure vertical string extents with respect to the same
 822      * string always...
 823      */
 824     gdk_string_extents(fe->fonts[i].font,
 825                        "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
 826                        &lb, &rb, &wid, &asc, &desc);
 827     if (align & ALIGN_VCENTRE)
 828         y += asc - (asc+desc)/2;
 829     else
 830         y += asc;
 831
 832     /*
 833      * ... but horizontal extents with respect to the provided
 834      * string. This means that multiple pieces of text centred
 835      * on the same y-coordinate don't have different baselines.
 836      */
 837     gdk_string_extents(fe->fonts[i].font, text,
 838                        &lb, &rb, &wid, &asc, &desc);
 839
 840     if (align & ALIGN_HCENTRE)
 841         x -= wid / 2;
 842     else if (align & ALIGN_HRIGHT)
 843         x -= wid;
 844
 845     /*
 846      * Actually draw the text.
 847      */
 848     gdk_draw_string(fe->pixmap, fe->fonts[i].font, fe->gc, x, y, text);
 849 }
 850
 851 #endif
 852
 853 /* ----------------------------------------------------------------------
 854  * The exported drawing functions.
 855  */
 856
 857 void gtk_start_draw(void *handle)
 858 {
 859     frontend *fe = (frontend *)handle;
 860     fe->bbox_l = fe->w;
 861     fe->bbox_r = 0;
 862     fe->bbox_u = fe->h;
 863     fe->bbox_d = 0;
 864     setup_drawing(fe);
 865 }
 866
 867 void gtk_clip(void *handle, int x, int y, int w, int h)
 868 {
 869     frontend *fe = (frontend *)handle;
 870     do_clip(fe, x, y, w, h);
 871 }
 872
 873 void gtk_unclip(void *handle)
 874 {
 875     frontend *fe = (frontend *)handle;
 876     do_unclip(fe);
 877 }
 878
 879 void gtk_draw_text(void *handle, int x, int y, int fonttype, int fontsize,
 880                    int align, int colour, char *text)
 881 {
 882     frontend *fe = (frontend *)handle;
 883     int i;
 884
 885     /*
 886      * Find or create the font.
 887      */
 888     for (i = 0; i < fe->nfonts; i++)
 889         if (fe->fonts[i].type == fonttype && fe->fonts[i].size == fontsize)
 890             break;
 891
 892     if (i == fe->nfonts) {
 893         if (fe->fontsize <= fe->nfonts) {
 894             fe->fontsize = fe->nfonts + 10;
 895             fe->fonts = sresize(fe->fonts, fe->fontsize, struct font);
 896         }
 897
 898         fe->nfonts++;
 899
 900         fe->fonts[i].type = fonttype;
 901         fe->fonts[i].size = fontsize;
 902         add_font(fe, i, fonttype, fontsize);
 903     }
 904
 905     /*
 906      * Do the job.
 907      */
 908     set_colour(fe, colour);
 909     align_and_draw_text(fe, i, align, x, y, text);
 910 }
 911
 912 void gtk_draw_rect(void *handle, int x, int y, int w, int h, int colour)
 913 {
 914     frontend *fe = (frontend *)handle;
 915     set_colour(fe, colour);
 916     do_draw_rect(fe, x, y, w, h);
 917 }
 918
 919 void gtk_draw_line(void *handle, int x1, int y1, int x2, int y2, int colour)
 920 {
 921     frontend *fe = (frontend *)handle;
 922     set_colour(fe, colour);
 923     do_draw_line(fe, x1, y1, x2, y2);
 924 }
 925
 926 void gtk_draw_thick_line(void *handle, float thickness,
 927                          float x1, float y1, float x2, float y2, int colour)
 928 {
 929     frontend *fe = (frontend *)handle;
 930     set_colour(fe, colour);
 931     do_draw_thick_line(fe, thickness, x1, y1, x2, y2);
 932 }
 933
 934 void gtk_draw_poly(void *handle, int *coords, int npoints,
 935                    int fillcolour, int outlinecolour)
 936 {
 937     frontend *fe = (frontend *)handle;
 938     do_draw_poly(fe, coords, npoints, fillcolour, outlinecolour);
 939 }
 940
 941 void gtk_draw_circle(void *handle, int cx, int cy, int radius,
 942                      int fillcolour, int outlinecolour)
 943 {
 944     frontend *fe = (frontend *)handle;
 945     do_draw_circle(fe, cx, cy, radius, fillcolour, outlinecolour);
 946 }
 947
 948 blitter *gtk_blitter_new(void *handle, int w, int h)
 949 {
 950     blitter *bl = snew(blitter);
 951     setup_blitter(bl, w, h);
 952     bl->w = w;
 953     bl->h = h;
 954     return bl;
 955 }
 956
 957 void gtk_blitter_free(void *handle, blitter *bl)
 958 {
 959     teardown_blitter(bl);
 960     sfree(bl);
 961 }
 962
 963 void gtk_blitter_save(void *handle, blitter *bl, int x, int y)
 964 {
 965     frontend *fe = (frontend *)handle;
 966     do_blitter_save(fe, bl, x, y);
 967     bl->x = x;
 968     bl->y = y;
 969 }
 970
 971 void gtk_blitter_load(void *handle, blitter *bl, int x, int y)
 972 {
 973     frontend *fe = (frontend *)handle;
 974     if (x == BLITTER_FROMSAVED && y == BLITTER_FROMSAVED) {
 975         x = bl->x;
 976         y = bl->y;
 977     }
 978     do_blitter_load(fe, bl, x, y);
 979 }
 980
 981 void gtk_draw_update(void *handle, int x, int y, int w, int h)
 982 {
 983     frontend *fe = (frontend *)handle;
 984     if (fe->bbox_l > x  ) fe->bbox_l = x  ;
 985     if (fe->bbox_r < x+w) fe->bbox_r = x+w;
 986     if (fe->bbox_u > y  ) fe->bbox_u = y  ;
 987     if (fe->bbox_d < y+h) fe->bbox_d = y+h;
 988 }
 989
 990 void gtk_end_draw(void *handle)
 991 {
 992     frontend *fe = (frontend *)handle;
 993
 994     teardown_drawing(fe);
 995
 996     if (fe->bbox_l < fe->bbox_r && fe->bbox_u < fe->bbox_d) {
 997 #ifdef USE_CAIRO_WITHOUT_PIXMAP
 998         gtk_widget_queue_draw_area(fe->area,
 999                                    fe->bbox_l - 1 + fe->ox,
1000                                    fe->bbox_u - 1 + fe->oy,
1001                                    fe->bbox_r - fe->bbox_l + 2,
1002                                    fe->bbox_d - fe->bbox_u + 2);
1003 #else
1004         repaint_rectangle(fe, fe->area,
1005                           fe->bbox_l - 1 + fe->ox,
1006                           fe->bbox_u - 1 + fe->oy,
1007                           fe->bbox_r - fe->bbox_l + 2,
1008                           fe->bbox_d - fe->bbox_u + 2);
1009 #endif
1010     }
1011 }
1012
1013 #ifdef USE_PANGO
1014 char *gtk_text_fallback(void *handle, const char *const *strings, int nstrings)
1015 {
1016     /*
1017      * We assume Pango can cope with any UTF-8 likely to be emitted
1018      * by a puzzle.
1019      */
1020     return dupstr(strings[0]);
1021 }
1022 #endif
1023
1024 const struct drawing_api gtk_drawing = {
1025     gtk_draw_text,
1026     gtk_draw_rect,
1027     gtk_draw_line,
1028     gtk_draw_poly,
1029     gtk_draw_circle,
1030     gtk_draw_update,
1031     gtk_clip,
1032     gtk_unclip,
1033     gtk_start_draw,
1034     gtk_end_draw,
1035     gtk_status_bar,
1036     gtk_blitter_new,
1037     gtk_blitter_free,
1038     gtk_blitter_save,
1039     gtk_blitter_load,
1040     NULL, NULL, NULL, NULL, NULL, NULL, /* {begin,end}_{doc,page,puzzle} */
1041     NULL, NULL,                        /* line_width, line_dotted */
1042 #ifdef USE_PANGO
1043     gtk_text_fallback,
1044 #else
1045     NULL,
1046 #endif
1047 #ifdef NO_THICK_LINE
1048     NULL,
1049 #else
1050     gtk_draw_thick_line,
1051 #endif
1052 };
1053
1054 static void destroy(GtkWidget *widget, gpointer data)
1055 {
1056     frontend *fe = (frontend *)data;
1057     deactivate_timer(fe);
1058     midend_free(fe->me);
1059     gtk_main_quit();
1060 }
1061
1062 static gint key_event(GtkWidget *widget, GdkEventKey *event, gpointer data)
1063 {
1064     frontend *fe = (frontend *)data;
1065     int keyval;
1066     int shift = (event->state & GDK_SHIFT_MASK) ? MOD_SHFT : 0;
1067     int ctrl = (event->state & GDK_CONTROL_MASK) ? MOD_CTRL : 0;
1068
1069     if (!backing_store_ok(fe))
1070         return TRUE;
1071
1072 #if !GTK_CHECK_VERSION(2,0,0)
1073     /* Gtk 1.2 passes a key event to this function even if it's also
1074      * defined as an accelerator.
1075      * Gtk 2 doesn't do this, and this function appears not to exist there. */
1076     if (fe->accelgroup &&
1077         gtk_accel_group_get_entry(fe->accelgroup,
1078         event->keyval, event->state))
1079         return TRUE;
1080 #endif
1081
1082     /* Handle mnemonics. */
1083     if (gtk_window_activate_key(GTK_WINDOW(fe->window), event))
1084         return TRUE;
1085
1086     if (event->keyval == GDK_KEY_Up)
1087         keyval = shift | ctrl | CURSOR_UP;
1088     else if (event->keyval == GDK_KEY_KP_Up ||
1089              event->keyval == GDK_KEY_KP_8)
1090         keyval = MOD_NUM_KEYPAD | '8';
1091     else if (event->keyval == GDK_KEY_Down)
1092         keyval = shift | ctrl | CURSOR_DOWN;
1093     else if (event->keyval == GDK_KEY_KP_Down ||
1094              event->keyval == GDK_KEY_KP_2)
1095         keyval = MOD_NUM_KEYPAD | '2';
1096     else if (event->keyval == GDK_KEY_Left)
1097         keyval = shift | ctrl | CURSOR_LEFT;
1098     else if (event->keyval == GDK_KEY_KP_Left ||
1099              event->keyval == GDK_KEY_KP_4)
1100         keyval = MOD_NUM_KEYPAD | '4';
1101     else if (event->keyval == GDK_KEY_Right)
1102         keyval = shift | ctrl | CURSOR_RIGHT;
1103     else if (event->keyval == GDK_KEY_KP_Right ||
1104              event->keyval == GDK_KEY_KP_6)
1105         keyval = MOD_NUM_KEYPAD | '6';
1106     else if (event->keyval == GDK_KEY_KP_Home ||
1107              event->keyval == GDK_KEY_KP_7)
1108         keyval = MOD_NUM_KEYPAD | '7';
1109     else if (event->keyval == GDK_KEY_KP_End ||
1110              event->keyval == GDK_KEY_KP_1)
1111         keyval = MOD_NUM_KEYPAD | '1';
1112     else if (event->keyval == GDK_KEY_KP_Page_Up ||
1113              event->keyval == GDK_KEY_KP_9)
1114         keyval = MOD_NUM_KEYPAD | '9';
1115     else if (event->keyval == GDK_KEY_KP_Page_Down ||
1116              event->keyval == GDK_KEY_KP_3)
1117         keyval = MOD_NUM_KEYPAD | '3';
1118     else if (event->keyval == GDK_KEY_KP_Insert ||
1119              event->keyval == GDK_KEY_KP_0)
1120         keyval = MOD_NUM_KEYPAD | '0';
1121     else if (event->keyval == GDK_KEY_KP_Begin ||
1122              event->keyval == GDK_KEY_KP_5)
1123         keyval = MOD_NUM_KEYPAD | '5';
1124     else if (event->keyval == GDK_KEY_BackSpace ||
1125              event->keyval == GDK_KEY_Delete ||
1126              event->keyval == GDK_KEY_KP_Delete)
1127         keyval = '\177';
1128     else if (event->string[0] && !event->string[1])
1129         keyval = (unsigned char)event->string[0];
1130     else
1131         keyval = -1;
1132
1133     if (keyval >= 0 &&
1134         !midend_process_key(fe->me, 0, 0, keyval))
1135         gtk_widget_destroy(fe->window);
1136
1137     return TRUE;
1138 }
1139
1140 static gint button_event(GtkWidget *widget, GdkEventButton *event,
1141                          gpointer data)
1142 {
1143     frontend *fe = (frontend *)data;
1144     int button;
1145
1146     if (!backing_store_ok(fe))
1147         return TRUE;
1148
1149     if (event->type != GDK_BUTTON_PRESS && event->type != GDK_BUTTON_RELEASE)
1150         return TRUE;
1151
1152     if (event->button == 2 || (event->state & GDK_SHIFT_MASK))
1153         button = MIDDLE_BUTTON;
1154     else if (event->button == 3 || (event->state & GDK_MOD1_MASK))
1155         button = RIGHT_BUTTON;
1156     else if (event->button == 1)
1157         button = LEFT_BUTTON;
1158     else
1159         return FALSE;                  /* don't even know what button! */
1160
1161     if (event->type == GDK_BUTTON_RELEASE)
1162         button += LEFT_RELEASE - LEFT_BUTTON;
1163
1164     if (!midend_process_key(fe->me, event->x - fe->ox,
1165                             event->y - fe->oy, button))
1166         gtk_widget_destroy(fe->window);
1167
1168     return TRUE;
1169 }
1170
1171 static gint motion_event(GtkWidget *widget, GdkEventMotion *event,
1172                          gpointer data)
1173 {
1174     frontend *fe = (frontend *)data;
1175     int button;
1176
1177     if (!backing_store_ok(fe))
1178         return TRUE;
1179
1180     if (event->state & (GDK_BUTTON2_MASK | GDK_SHIFT_MASK))
1181         button = MIDDLE_DRAG;
1182     else if (event->state & GDK_BUTTON1_MASK)
1183         button = LEFT_DRAG;
1184     else if (event->state & GDK_BUTTON3_MASK)
1185         button = RIGHT_DRAG;
1186     else
1187         return FALSE;                  /* don't even know what button! */
1188
1189     if (!midend_process_key(fe->me, event->x - fe->ox,
1190                             event->y - fe->oy, button))
1191         gtk_widget_destroy(fe->window);
1192 #if GTK_CHECK_VERSION(2,12,0)
1193     gdk_event_request_motions(event);
1194 #else
1195     gdk_window_get_pointer(gtk_widget_get_window(widget), NULL, NULL, NULL);
1196 #endif
1197
1198     return TRUE;
1199 }
1200
1201 static gint expose_area(GtkWidget *widget, GdkEventExpose *event,
1202                         gpointer data)
1203 {
1204     frontend *fe = (frontend *)data;
1205
1206     if (backing_store_ok(fe)) {
1207 #ifdef USE_CAIRO_WITHOUT_PIXMAP
1208         cairo_t *cr = gdk_cairo_create(gtk_widget_get_window(widget));
1209         cairo_set_source_surface(cr, fe->image, fe->ox, fe->oy);
1210         cairo_rectangle(cr, event->area.x, event->area.y,
1211                         event->area.width, event->area.height);
1212         cairo_fill(cr);
1213         cairo_destroy(cr);
1214 #else
1215         repaint_rectangle(fe, widget,
1216                           event->area.x, event->area.y,
1217                           event->area.width, event->area.height);
1218 #endif
1219     }
1220     return TRUE;
1221 }
1222
1223 static gint map_window(GtkWidget *widget, GdkEvent *event,
1224                        gpointer data)
1225 {
1226     frontend *fe = (frontend *)data;
1227
1228     /*
1229      * Apparently we need to do this because otherwise the status
1230      * bar will fail to update immediately. Annoying, but there we
1231      * go.
1232      */
1233     gtk_widget_queue_draw(fe->window);
1234
1235     return TRUE;
1236 }
1237
1238 static gint configure_area(GtkWidget *widget,
1239                            GdkEventConfigure *event, gpointer data)
1240 {
1241     frontend *fe = (frontend *)data;
1242     int x, y;
1243
1244     x = event->width;
1245     y = event->height;
1246
1247     if (x != fe->w || y != fe->h || !backing_store_ok(fe)) {
1248         if (backing_store_ok(fe))
1249             teardown_backing_store(fe);
1250
1251         fe->w = x;
1252         fe->h = y;
1253         midend_size(fe->me, &x, &y, TRUE);
1254         fe->pw = x;
1255         fe->ph = y;
1256         fe->ox = (fe->w - fe->pw) / 2;
1257         fe->oy = (fe->h - fe->ph) / 2;
1258
1259         setup_backing_store(fe);
1260     }
1261
1262     midend_force_redraw(fe->me);
1263
1264     return TRUE;
1265 }
1266
1267 static gint timer_func(gpointer data)
1268 {
1269     frontend *fe = (frontend *)data;
1270
1271     if (fe->timer_active) {
1272         struct timeval now;
1273         float elapsed;
1274         gettimeofday(&now, NULL);
1275         elapsed = ((now.tv_usec - fe->last_time.tv_usec) * 0.000001F +
1276                    (now.tv_sec - fe->last_time.tv_sec));
1277         midend_timer(fe->me, elapsed);  /* may clear timer_active */
1278         fe->last_time = now;
1279     }
1280
1281     return fe->timer_active;
1282 }
1283
1284 void deactivate_timer(frontend *fe)
1285 {
1286     if (!fe)
1287         return;                        /* can happen due to --generate */
1288     if (fe->timer_active)
1289         gtk_timeout_remove(fe->timer_id);
1290     fe->timer_active = FALSE;
1291 }
1292
1293 void activate_timer(frontend *fe)
1294 {
1295     if (!fe)
1296         return;                        /* can happen due to --generate */
1297     if (!fe->timer_active) {
1298         fe->timer_id = gtk_timeout_add(20, timer_func, fe);
1299         gettimeofday(&fe->last_time, NULL);
1300     }
1301     fe->timer_active = TRUE;
1302 }
1303
1304 static void window_destroy(GtkWidget *widget, gpointer data)
1305 {
1306     gtk_main_quit();
1307 }
1308
1309 static void msgbox_button_clicked(GtkButton *button, gpointer data)
1310 {
1311     GtkWidget *window = GTK_WIDGET(data);
1312     int v, *ip;
1313
1314     ip = (int *)g_object_get_data(G_OBJECT(window), "user-data");
1315     v = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(button), "user-data"));
1316     *ip = v;
1317
1318     gtk_widget_destroy(GTK_WIDGET(data));
1319 }
1320
1321 static int win_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
1322 {
1323     GObject *cancelbutton = G_OBJECT(data);
1324
1325     /*
1326      * `Escape' effectively clicks the cancel button
1327      */
1328     if (event->keyval == GDK_KEY_Escape) {
1329         g_signal_emit_by_name(cancelbutton, "clicked");
1330         return TRUE;
1331     }
1332
1333     return FALSE;
1334 }
1335
1336 enum { MB_OK, MB_YESNO };
1337
1338 int message_box(GtkWidget *parent, char *title, char *msg, int centre,
1339                 int type)
1340 {
1341     GtkWidget *window, *hbox, *text, *button;
1342     char *titles;
1343     int i, def, cancel;
1344
1345     window = gtk_dialog_new();
1346     text = gtk_label_new(msg);
1347     gtk_misc_set_alignment(GTK_MISC(text), 0.0, 0.0);
1348     hbox = gtk_hbox_new(FALSE, 0);
1349     gtk_box_pack_start(GTK_BOX(hbox), text, FALSE, FALSE, 20);
1350     gtk_box_pack_start
1351         (GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(window))),
1352          hbox, FALSE, FALSE, 20);
1353     gtk_widget_show(text);
1354     gtk_widget_show(hbox);
1355     gtk_window_set_title(GTK_WINDOW(window), title);
1356     gtk_label_set_line_wrap(GTK_LABEL(text), TRUE);
1357
1358     if (type == MB_OK) {
1359         titles = GTK_STOCK_OK "\0";
1360         def = cancel = 0;
1361     } else {
1362         assert(type == MB_YESNO);
1363         titles = GTK_STOCK_NO "\0" GTK_STOCK_YES "\0";
1364         def = 1;
1365         cancel = 0;
1366     }
1367     i = 0;
1368
1369     while (*titles) {
1370         button = gtk_button_new_from_stock(titles);
1371         gtk_box_pack_end
1372             (GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(window))),
1373              button, FALSE, FALSE, 0);
1374         gtk_widget_show(button);
1375         if (i == def) {
1376             gtk_widget_set_can_default(button, TRUE);
1377             gtk_window_set_default(GTK_WINDOW(window), button);
1378         }
1379         if (i == cancel) {
1380             g_signal_connect(G_OBJECT(window), "key_press_event",
1381                              G_CALLBACK(win_key_press), button);
1382         }
1383         g_signal_connect(G_OBJECT(button), "clicked",
1384                          G_CALLBACK(msgbox_button_clicked), window);
1385         g_object_set_data(G_OBJECT(button), "user-data",
1386                           GINT_TO_POINTER(i));
1387         titles += strlen(titles)+1;
1388         i++;
1389     }
1390     g_object_set_data(G_OBJECT(window), "user-data", &i);
1391     g_signal_connect(G_OBJECT(window), "destroy",
1392                      G_CALLBACK(window_destroy), NULL);
1393     gtk_window_set_modal(GTK_WINDOW(window), TRUE);
1394     gtk_window_set_transient_for(GTK_WINDOW(window), GTK_WINDOW(parent));
1395     /* set_transient_window_pos(parent, window); */
1396     gtk_widget_show(window);
1397     i = -1;
1398     gtk_main();
1399     return (type == MB_YESNO ? i == 1 : TRUE);
1400 }
1401
1402 void error_box(GtkWidget *parent, char *msg)
1403 {
1404     message_box(parent, "Error", msg, FALSE, MB_OK);
1405 }
1406
1407 static void config_ok_button_clicked(GtkButton *button, gpointer data)
1408 {
1409     frontend *fe = (frontend *)data;
1410     char *err;
1411
1412     err = midend_set_config(fe->me, fe->cfg_which, fe->cfg);
1413
1414     if (err)
1415         error_box(fe->cfgbox, err);
1416     else {
1417         fe->cfgret = TRUE;
1418         gtk_widget_destroy(fe->cfgbox);
1419         changed_preset(fe);
1420     }
1421 }
1422
1423 static void config_cancel_button_clicked(GtkButton *button, gpointer data)
1424 {
1425     frontend *fe = (frontend *)data;
1426
1427     gtk_widget_destroy(fe->cfgbox);
1428 }
1429
1430 static int editbox_key(GtkWidget *widget, GdkEventKey *event, gpointer data)
1431 {
1432     /*
1433      * GtkEntry has a nasty habit of eating the Return key, which
1434      * is unhelpful since it doesn't actually _do_ anything with it
1435      * (it calls gtk_widget_activate, but our edit boxes never need
1436      * activating). So I catch Return before GtkEntry sees it, and
1437      * pass it straight on to the parent widget. Effect: hitting
1438      * Return in an edit box will now activate the default button
1439      * in the dialog just like it will everywhere else.
1440      */
1441     if (event->keyval == GDK_KEY_Return &&
1442         gtk_widget_get_parent(widget) != NULL) {
1443         gint return_val;
1444         g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
1445         g_signal_emit_by_name(G_OBJECT(gtk_widget_get_parent(widget)),
1446                               "key_press_event", event, &return_val);
1447         return return_val;
1448     }
1449     return FALSE;
1450 }
1451
1452 static void editbox_changed(GtkEditable *ed, gpointer data)
1453 {
1454     config_item *i = (config_item *)data;
1455
1456     sfree(i->sval);
1457     i->sval = dupstr(gtk_entry_get_text(GTK_ENTRY(ed)));
1458 }
1459
1460 static void button_toggled(GtkToggleButton *tb, gpointer data)
1461 {
1462     config_item *i = (config_item *)data;
1463
1464     i->ival = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(tb));
1465 }
1466
1467 static void droplist_sel(GtkComboBox *combo, gpointer data)
1468 {
1469     config_item *i = (config_item *)data;
1470
1471     i->ival = gtk_combo_box_get_active(combo);
1472 }
1473
1474 static int get_config(frontend *fe, int which)
1475 {
1476     GtkWidget *w, *table, *cancel;
1477     char *title;
1478     config_item *i;
1479     int y;
1480
1481     fe->cfg = midend_get_config(fe->me, which, &title);
1482     fe->cfg_which = which;
1483     fe->cfgret = FALSE;
1484
1485     fe->cfgbox = gtk_dialog_new();
1486     gtk_window_set_title(GTK_WINDOW(fe->cfgbox), title);
1487     sfree(title);
1488
1489     w = gtk_button_new_from_stock(GTK_STOCK_CANCEL);
1490     gtk_box_pack_end
1491         (GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(fe->cfgbox))),
1492          w, FALSE, FALSE, 0);
1493     gtk_widget_show(w);
1494     g_signal_connect(G_OBJECT(w), "clicked",
1495                      G_CALLBACK(config_cancel_button_clicked), fe);
1496     cancel = w;
1497
1498     w = gtk_button_new_from_stock(GTK_STOCK_OK);
1499     gtk_box_pack_end
1500         (GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(fe->cfgbox))),
1501          w, FALSE, FALSE, 0);
1502     gtk_widget_show(w);
1503     gtk_widget_set_can_default(w, TRUE);
1504     gtk_window_set_default(GTK_WINDOW(fe->cfgbox), w);
1505     g_signal_connect(G_OBJECT(w), "clicked",
1506                      G_CALLBACK(config_ok_button_clicked), fe);
1507
1508     table = gtk_table_new(1, 2, FALSE);
1509     y = 0;
1510     gtk_box_pack_start
1511         (GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(fe->cfgbox))),
1512          table, FALSE, FALSE, 0);
1513     gtk_widget_show(table);
1514
1515     for (i = fe->cfg; i->type != C_END; i++) {
1516         gtk_table_resize(GTK_TABLE(table), y+1, 2);
1517
1518         switch (i->type) {
1519           case C_STRING:
1520             /*
1521              * Edit box with a label beside it.
1522              */
1523
1524             w = gtk_label_new(i->name);
1525             gtk_misc_set_alignment(GTK_MISC(w), 0.0, 0.5);
1526             gtk_table_attach(GTK_TABLE(table), w, 0, 1, y, y+1,
1527                              GTK_SHRINK | GTK_FILL,
1528                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1529                              3, 3);
1530             gtk_widget_show(w);
1531
1532             w = gtk_entry_new();
1533             gtk_table_attach(GTK_TABLE(table), w, 1, 2, y, y+1,
1534                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1535                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1536                              3, 3);
1537             gtk_entry_set_text(GTK_ENTRY(w), i->sval);
1538             g_signal_connect(G_OBJECT(w), "changed",
1539                              G_CALLBACK(editbox_changed), i);
1540             g_signal_connect(G_OBJECT(w), "key_press_event",
1541                              G_CALLBACK(editbox_key), NULL);
1542             gtk_widget_show(w);
1543
1544             break;
1545
1546           case C_BOOLEAN:
1547             /*
1548              * Simple checkbox.
1549              */
1550             w = gtk_check_button_new_with_label(i->name);
1551             g_signal_connect(G_OBJECT(w), "toggled",
1552                              G_CALLBACK(button_toggled), i);
1553             gtk_table_attach(GTK_TABLE(table), w, 0, 2, y, y+1,
1554                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1555                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1556                              3, 3);
1557             gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(w), i->ival);
1558             gtk_widget_show(w);
1559             break;
1560
1561           case C_CHOICES:
1562             /*
1563              * Drop-down list (GtkComboBox).
1564              */
1565
1566             w = gtk_label_new(i->name);
1567             gtk_misc_set_alignment(GTK_MISC(w), 0.0, 0.5);
1568             gtk_table_attach(GTK_TABLE(table), w, 0, 1, y, y+1,
1569                              GTK_SHRINK | GTK_FILL,
1570                              GTK_EXPAND | GTK_SHRINK | GTK_FILL ,
1571                              3, 3);
1572             gtk_widget_show(w);
1573
1574             {
1575                 int c;
1576                 char *p, *q, *name;
1577                 GtkListStore *model;
1578                 GtkCellRenderer *cr;
1579                 GtkTreeIter iter;
1580
1581                 model = gtk_list_store_new(1, G_TYPE_STRING);
1582
1583                 c = *i->sval;
1584                 p = i->sval+1;
1585
1586                 while (*p) {
1587                     q = p;
1588                     while (*q && *q != c)
1589                         q++;
1590
1591                     name = snewn(q-p+1, char);
1592                     strncpy(name, p, q-p);
1593                     name[q-p] = '\0';
1594
1595                     if (*q) q++;       /* eat delimiter */
1596
1597                     gtk_list_store_append(model, &iter);
1598                     gtk_list_store_set(model, &iter, 0, name, -1);
1599
1600                     p = q;
1601                 }
1602
1603                 w = gtk_combo_box_new_with_model(GTK_TREE_MODEL(model));
1604
1605                 gtk_combo_box_set_active(GTK_COMBO_BOX(w), i->ival);
1606
1607                 cr = gtk_cell_renderer_text_new();
1608                 gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(w), cr, TRUE);
1609                 gtk_cell_layout_set_attributes(GTK_CELL_LAYOUT(w), cr,
1610                                                "text", 0, NULL);
1611
1612                 g_signal_connect(G_OBJECT(w), "changed",
1613                                  G_CALLBACK(droplist_sel), i);
1614             }
1615
1616             gtk_table_attach(GTK_TABLE(table), w, 1, 2, y, y+1,
1617                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1618                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1619                              3, 3);
1620             gtk_widget_show(w);
1621             break;
1622         }
1623
1624         y++;
1625     }
1626
1627     g_signal_connect(G_OBJECT(fe->cfgbox), "destroy",
1628                      G_CALLBACK(window_destroy), NULL);
1629     g_signal_connect(G_OBJECT(fe->cfgbox), "key_press_event",
1630                      G_CALLBACK(win_key_press), cancel);
1631     gtk_window_set_modal(GTK_WINDOW(fe->cfgbox), TRUE);
1632     gtk_window_set_transient_for(GTK_WINDOW(fe->cfgbox),
1633                                  GTK_WINDOW(fe->window));
1634     /* set_transient_window_pos(fe->window, fe->cfgbox); */
1635     gtk_widget_show(fe->cfgbox);
1636     gtk_main();
1637
1638     free_cfg(fe->cfg);
1639
1640     return fe->cfgret;
1641 }
1642
1643 static void menu_key_event(GtkMenuItem *menuitem, gpointer data)
1644 {
1645     frontend *fe = (frontend *)data;
1646     int key = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(menuitem),
1647                                                 "user-data"));
1648     if (!midend_process_key(fe->me, 0, 0, key))
1649         gtk_widget_destroy(fe->window);
1650 }
1651
1652 static void get_size(frontend *fe, int *px, int *py)
1653 {
1654     int x, y;
1655
1656     /*
1657      * Currently I don't want to make the GTK port scale large
1658      * puzzles to fit on the screen. This is because X does permit
1659      * extremely large windows and many window managers provide a
1660      * means of navigating round them, and the users I consulted
1661      * before deciding said that they'd rather have enormous puzzle
1662      * windows spanning multiple screen pages than have them
1663      * shrunk. I could change my mind later or introduce
1664      * configurability; this would be the place to do so, by
1665      * replacing the initial values of x and y with the screen
1666      * dimensions.
1667      */
1668     x = INT_MAX;
1669     y = INT_MAX;
1670     midend_size(fe->me, &x, &y, FALSE);
1671     *px = x;
1672     *py = y;
1673 }
1674
1675 #if !GTK_CHECK_VERSION(2,0,0)
1676 #define gtk_window_resize(win, x, y) \
1677         gdk_window_resize(GTK_WIDGET(win)->window, x, y)
1678 #endif
1679
1680 /*
1681  * Called when any other code in this file has changed the
1682  * selected game parameters.
1683  */
1684 static void changed_preset(frontend *fe)
1685 {
1686     int n = midend_which_preset(fe->me);
1687
1688     fe->preset_threaded = TRUE;
1689     if (n < 0 && fe->preset_custom) {
1690         gtk_check_menu_item_set_active(
1691             GTK_CHECK_MENU_ITEM(fe->preset_custom),
1692             TRUE);
1693     } else {
1694         GSList *gs = fe->preset_radio;
1695         int i = fe->n_preset_menu_items - 1 - n;
1696         if (fe->preset_custom)
1697             gs = gs->next;
1698         while (i && gs) {
1699             i--;
1700             gs = gs->next;
1701         }
1702         if (gs) {
1703             gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(gs->data),
1704                                            TRUE);
1705         } else for (gs = fe->preset_radio; gs; gs = gs->next) {
1706             gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(gs->data),
1707                                            FALSE);
1708         }
1709     }
1710     fe->preset_threaded = FALSE;
1711
1712     /*
1713      * Update the greying on the Copy menu option.
1714      */
1715     if (fe->copy_menu_item) {
1716         int enabled = midend_can_format_as_text_now(fe->me);
1717         gtk_widget_set_sensitive(fe->copy_menu_item, enabled);
1718     }
1719 }
1720
1721 static gboolean not_size_allocated_yet(GtkWidget *w)
1722 {
1723     /*
1724      * This function tests whether a widget has not yet taken up space
1725      * on the screen which it will occupy in future. (Therefore, it
1726      * returns true only if the widget does exist but does not have a
1727      * size allocation. A null widget is already taking up all the
1728      * space it ever will.)
1729      */
1730     if (!w)
1731         return FALSE;        /* nonexistent widgets aren't a problem */
1732
1733 #if GTK_CHECK_VERSION(2,18,0)  /* skip if no gtk_widget_get_allocation */
1734     {
1735         GtkAllocation a;
1736         gtk_widget_get_allocation(w, &a);
1737         if (a.height == 0 || a.width == 0)
1738             return TRUE;       /* widget exists but has no size yet */
1739     }
1740 #endif
1741
1742     return FALSE;
1743 }
1744
1745 static void try_shrink_drawing_area(frontend *fe)
1746 {
1747     if (fe->drawing_area_shrink_pending &&
1748         (!fe->menubar_is_local || !not_size_allocated_yet(fe->menubar)) &&
1749         !not_size_allocated_yet(fe->statusbar)) {
1750         /*
1751          * In order to permit the user to resize the window smaller as
1752          * well as bigger, we call this function after the window size
1753          * has ended up where we want it. This shouldn't shrink the
1754          * window immediately; it just arranges that the next time the
1755          * user tries to shrink it, they can.
1756          *
1757          * However, at puzzle creation time, we defer the first of
1758          * these operations until after the menu bar and status bar
1759          * are actually visible. On Ubuntu 12.04 I've found that these
1760          * can take a while to be displayed, and that it's a mistake
1761          * to reduce the drawing area's size allocation before they've
1762          * turned up or else the drawing area makes room for them by
1763          * shrinking to less than the size we intended.
1764          */
1765         gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), 1, 1);
1766         fe->drawing_area_shrink_pending = FALSE;
1767     }
1768 }
1769
1770 static gint configure_window(GtkWidget *widget,
1771                              GdkEventConfigure *event, gpointer data)
1772 {
1773     frontend *fe = (frontend *)data;
1774     /*
1775      * When the main puzzle window changes size, it might be because
1776      * the menu bar or status bar has turned up after starting off
1777      * absent, in which case we should have another go at enacting a
1778      * pending shrink of the drawing area.
1779      */
1780     try_shrink_drawing_area(fe);
1781     return FALSE;
1782 }
1783
1784 static void resize_fe(frontend *fe)
1785 {
1786     int x, y;
1787
1788     get_size(fe, &x, &y);
1789     fe->w = x;
1790     fe->h = y;
1791     fe->drawing_area_shrink_pending = FALSE;
1792     gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), x, y);
1793     {
1794         GtkRequisition req;
1795         gtk_widget_size_request(GTK_WIDGET(fe->window), &req);
1796         gtk_window_resize(GTK_WINDOW(fe->window), req.width, req.height);
1797     }
1798     fe->drawing_area_shrink_pending = TRUE;
1799     try_shrink_drawing_area(fe);
1800 }
1801
1802 static void menu_preset_event(GtkMenuItem *menuitem, gpointer data)
1803 {
1804     frontend *fe = (frontend *)data;
1805     game_params *params =
1806         (game_params *)g_object_get_data(G_OBJECT(menuitem), "user-data");
1807
1808     if (fe->preset_threaded ||
1809         (GTK_IS_CHECK_MENU_ITEM(menuitem) &&
1810          !gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(menuitem))))
1811         return;
1812     midend_set_params(fe->me, params);
1813     midend_new_game(fe->me);
1814     changed_preset(fe);
1815     resize_fe(fe);
1816 }
1817
1818 GdkAtom compound_text_atom, utf8_string_atom;
1819 int paste_initialised = FALSE;
1820
1821 static void set_selection(frontend *fe, GdkAtom selection)
1822 {
1823     if (!paste_initialised) {
1824         compound_text_atom = gdk_atom_intern("COMPOUND_TEXT", FALSE);
1825         utf8_string_atom = gdk_atom_intern("UTF8_STRING", FALSE);
1826         paste_initialised = TRUE;
1827     }
1828
1829     /*
1830      * For this simple application we can safely assume that the
1831      * data passed to this function is pure ASCII, which means we
1832      * can return precisely the same stuff for types STRING,
1833      * COMPOUND_TEXT or UTF8_STRING.
1834      */
1835
1836     if (gtk_selection_owner_set(fe->area, selection, CurrentTime)) {
1837         gtk_selection_clear_targets(fe->area, selection);
1838         gtk_selection_add_target(fe->area, selection,
1839                                  GDK_SELECTION_TYPE_STRING, 1);
1840         gtk_selection_add_target(fe->area, selection, compound_text_atom, 1);
1841         gtk_selection_add_target(fe->area, selection, utf8_string_atom, 1);
1842     }
1843 }
1844
1845 void write_clip(frontend *fe, char *data)
1846 {
1847     if (fe->paste_data)
1848         sfree(fe->paste_data);
1849
1850     fe->paste_data = data;
1851     fe->paste_data_len = strlen(data);
1852
1853     set_selection(fe, GDK_SELECTION_PRIMARY);
1854     set_selection(fe, GDK_SELECTION_CLIPBOARD);
1855 }
1856
1857 void selection_get(GtkWidget *widget, GtkSelectionData *seldata,
1858                    guint info, guint time_stamp, gpointer data)
1859 {
1860     frontend *fe = (frontend *)data;
1861     gtk_selection_data_set(seldata, gtk_selection_data_get_target(seldata), 8,
1862                            fe->paste_data, fe->paste_data_len);
1863 }
1864
1865 gint selection_clear(GtkWidget *widget, GdkEventSelection *seldata,
1866                      gpointer data)
1867 {
1868     frontend *fe = (frontend *)data;
1869
1870     if (fe->paste_data)
1871         sfree(fe->paste_data);
1872     fe->paste_data = NULL;
1873     fe->paste_data_len = 0;
1874     return TRUE;
1875 }
1876
1877 static void menu_copy_event(GtkMenuItem *menuitem, gpointer data)
1878 {
1879     frontend *fe = (frontend *)data;
1880     char *text;
1881
1882     text = midend_text_format(fe->me);
1883
1884     if (text) {
1885         write_clip(fe, text);
1886     } else {
1887         gdk_beep();
1888     }
1889 }
1890
1891 #ifdef OLD_FILESEL
1892
1893 static void filesel_ok(GtkButton *button, gpointer data)
1894 {
1895     frontend *fe = (frontend *)data;
1896
1897     gpointer filesel = g_object_get_data(G_OBJECT(button), "user-data");
1898
1899     const char *name =
1900         gtk_file_selection_get_filename(GTK_FILE_SELECTION(filesel));
1901
1902     fe->filesel_name = dupstr(name);
1903 }
1904
1905 static char *file_selector(frontend *fe, char *title, int save)
1906 {
1907     GtkWidget *filesel =
1908         gtk_file_selection_new(title);
1909
1910     fe->filesel_name = NULL;
1911
1912     gtk_window_set_modal(GTK_WINDOW(filesel), TRUE);
1913     g_object_set_data
1914         (G_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "user-data",
1915          (gpointer)filesel);
1916     g_signal_connect
1917         (G_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "clicked",
1918          G_CALLBACK(filesel_ok), fe);
1919     g_signal_connect_swapped
1920         (G_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "clicked",
1921          G_CALLBACK(gtk_widget_destroy), (gpointer)filesel);
1922     g_signal_connect_object
1923         (G_OBJECT(GTK_FILE_SELECTION(filesel)->cancel_button), "clicked",
1924          G_CALLBACK(gtk_widget_destroy), (gpointer)filesel);
1925     g_signal_connect(G_OBJECT(filesel), "destroy",
1926                      G_CALLBACK(window_destroy), NULL);
1927     gtk_widget_show(filesel);
1928     gtk_window_set_transient_for(GTK_WINDOW(filesel), GTK_WINDOW(fe->window));
1929     gtk_main();
1930
1931     return fe->filesel_name;
1932 }
1933
1934 #else
1935
1936 static char *file_selector(frontend *fe, char *title, int save)
1937 {
1938     char *filesel_name = NULL;
1939
1940     GtkWidget *filesel =
1941         gtk_file_chooser_dialog_new(title,
1942                                     GTK_WINDOW(fe->window),
1943                                     save ? GTK_FILE_CHOOSER_ACTION_SAVE :
1944                                     GTK_FILE_CHOOSER_ACTION_OPEN,
1945                                     GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1946                                     save ? GTK_STOCK_SAVE : GTK_STOCK_OPEN,
1947                                     GTK_RESPONSE_ACCEPT,
1948                                     NULL);
1949
1950     if (gtk_dialog_run(GTK_DIALOG(filesel)) == GTK_RESPONSE_ACCEPT) {
1951         const char *name = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(filesel));
1952         filesel_name = dupstr(name);
1953     }
1954
1955     gtk_widget_destroy(filesel);
1956
1957     return filesel_name;
1958 }
1959
1960 #endif
1961
1962 struct savefile_write_ctx {
1963     FILE *fp;
1964     int error;
1965 };
1966
1967 static void savefile_write(void *wctx, void *buf, int len)
1968 {
1969     struct savefile_write_ctx *ctx = (struct savefile_write_ctx *)wctx;
1970     if (fwrite(buf, 1, len, ctx->fp) < len)
1971         ctx->error = errno;
1972 }
1973
1974 static int savefile_read(void *wctx, void *buf, int len)
1975 {
1976     FILE *fp = (FILE *)wctx;
1977     int ret;
1978
1979     ret = fread(buf, 1, len, fp);
1980     return (ret == len);
1981 }
1982
1983 static void menu_save_event(GtkMenuItem *menuitem, gpointer data)
1984 {
1985     frontend *fe = (frontend *)data;
1986     char *name;
1987
1988     name = file_selector(fe, "Enter name of game file to save", TRUE);
1989
1990     if (name) {
1991         FILE *fp;
1992
1993         if ((fp = fopen(name, "r")) != NULL) {
1994             char buf[256 + FILENAME_MAX];
1995             fclose(fp);
1996             /* file exists */
1997
1998             sprintf(buf, "Are you sure you want to overwrite the"
1999                     " file \"%.*s\"?",
2000                     FILENAME_MAX, name);
2001             if (!message_box(fe->window, "Question", buf, TRUE, MB_YESNO))
2002                 return;
2003         }
2004
2005         fp = fopen(name, "w");
2006         sfree(name);
2007
2008         if (!fp) {
2009             error_box(fe->window, "Unable to open save file");
2010             return;
2011         }
2012
2013         {
2014             struct savefile_write_ctx ctx;
2015             ctx.fp = fp;
2016             ctx.error = 0;
2017             midend_serialise(fe->me, savefile_write, &ctx);
2018             fclose(fp);
2019             if (ctx.error) {
2020                 char boxmsg[512];
2021                 sprintf(boxmsg, "Error writing save file: %.400s",
2022                         strerror(errno));
2023                 error_box(fe->window, boxmsg);
2024                 return;
2025             }
2026         }
2027
2028     }
2029 }
2030
2031 static void menu_load_event(GtkMenuItem *menuitem, gpointer data)
2032 {
2033     frontend *fe = (frontend *)data;
2034     char *name, *err;
2035
2036     name = file_selector(fe, "Enter name of saved game file to load", FALSE);
2037
2038     if (name) {
2039         FILE *fp = fopen(name, "r");
2040         sfree(name);
2041
2042         if (!fp) {
2043             error_box(fe->window, "Unable to open saved game file");
2044             return;
2045         }
2046
2047         err = midend_deserialise(fe->me, savefile_read, fp);
2048
2049         fclose(fp);
2050
2051         if (err) {
2052             error_box(fe->window, err);
2053             return;
2054         }
2055
2056         changed_preset(fe);
2057         resize_fe(fe);
2058     }
2059 }
2060
2061 static void menu_solve_event(GtkMenuItem *menuitem, gpointer data)
2062 {
2063     frontend *fe = (frontend *)data;
2064     char *msg;
2065
2066     msg = midend_solve(fe->me);
2067
2068     if (msg)
2069         error_box(fe->window, msg);
2070 }
2071
2072 static void menu_restart_event(GtkMenuItem *menuitem, gpointer data)
2073 {
2074     frontend *fe = (frontend *)data;
2075
2076     midend_restart_game(fe->me);
2077 }
2078
2079 static void menu_config_event(GtkMenuItem *menuitem, gpointer data)
2080 {
2081     frontend *fe = (frontend *)data;
2082     int which = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(menuitem),
2083                                                   "user-data"));
2084
2085     if (fe->preset_threaded ||
2086         (GTK_IS_CHECK_MENU_ITEM(menuitem) &&
2087          !gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(menuitem))))
2088         return;
2089     changed_preset(fe);                 /* Put the old preset back! */
2090     if (!get_config(fe, which))
2091         return;
2092
2093     midend_new_game(fe->me);
2094     resize_fe(fe);
2095 }
2096
2097 static void menu_about_event(GtkMenuItem *menuitem, gpointer data)
2098 {
2099     frontend *fe = (frontend *)data;
2100     char titlebuf[256];
2101     char textbuf[1024];
2102
2103     sprintf(titlebuf, "About %.200s", thegame.name);
2104     sprintf(textbuf,
2105             "%.200s\n\n"
2106             "from Simon Tatham's Portable Puzzle Collection\n\n"
2107             "%.500s", thegame.name, ver);
2108
2109     message_box(fe->window, titlebuf, textbuf, TRUE, MB_OK);
2110 }
2111
2112 static GtkWidget *add_menu_item_with_key(frontend *fe, GtkContainer *cont,
2113                                          char *text, int key)
2114 {
2115     GtkWidget *menuitem = gtk_menu_item_new_with_label(text);
2116     int keyqual;
2117     gtk_container_add(cont, menuitem);
2118     g_object_set_data(G_OBJECT(menuitem), "user-data", GINT_TO_POINTER(key));
2119     g_signal_connect(G_OBJECT(menuitem), "activate",
2120                      G_CALLBACK(menu_key_event), fe);
2121     switch (key & ~0x1F) {
2122       case 0x00:
2123         key += 0x60;
2124         keyqual = GDK_CONTROL_MASK;
2125         break;
2126       case 0x40:
2127         key += 0x20;
2128         keyqual = GDK_SHIFT_MASK;
2129         break;
2130       default:
2131         keyqual = 0;
2132         break;
2133     }
2134     gtk_widget_add_accelerator(menuitem,
2135                                "activate", fe->accelgroup,
2136                                key, keyqual,
2137                                GTK_ACCEL_VISIBLE);
2138     gtk_widget_show(menuitem);
2139     return menuitem;
2140 }
2141
2142 static void add_menu_separator(GtkContainer *cont)
2143 {
2144     GtkWidget *menuitem = gtk_menu_item_new();
2145     gtk_container_add(cont, menuitem);
2146     gtk_widget_show(menuitem);
2147 }
2148
2149 enum { ARG_EITHER, ARG_SAVE, ARG_ID }; /* for argtype */
2150
2151 static frontend *new_window(char *arg, int argtype, char **error)
2152 {
2153     frontend *fe;
2154     GtkBox *vbox, *hbox;
2155     GtkWidget *menu, *menuitem;
2156     GList *iconlist;
2157     int x, y, n;
2158     char errbuf[1024];
2159     extern char *const *const xpm_icons[];
2160     extern const int n_xpm_icons;
2161
2162     fe = snew(frontend);
2163
2164     fe->timer_active = FALSE;
2165     fe->timer_id = -1;
2166
2167     fe->me = midend_new(fe, &thegame, &gtk_drawing, fe);
2168
2169     if (arg) {
2170         char *err;
2171         FILE *fp;
2172
2173         errbuf[0] = '\0';
2174
2175         switch (argtype) {
2176           case ARG_ID:
2177             err = midend_game_id(fe->me, arg);
2178             if (!err)
2179                 midend_new_game(fe->me);
2180             else
2181                 sprintf(errbuf, "Invalid game ID: %.800s", err);
2182             break;
2183           case ARG_SAVE:
2184             fp = fopen(arg, "r");
2185             if (!fp) {
2186                 sprintf(errbuf, "Error opening file: %.800s", strerror(errno));
2187             } else {
2188                 err = midend_deserialise(fe->me, savefile_read, fp);
2189                 if (err)
2190                     sprintf(errbuf, "Invalid save file: %.800s", err);
2191                 fclose(fp);
2192             }
2193             break;
2194           default /*case ARG_EITHER*/:
2195             /*
2196              * First try treating the argument as a game ID.
2197              */
2198             err = midend_game_id(fe->me, arg);
2199             if (!err) {
2200                 /*
2201                  * It's a valid game ID.
2202                  */
2203                 midend_new_game(fe->me);
2204             } else {
2205                 FILE *fp = fopen(arg, "r");
2206                 if (!fp) {
2207                     sprintf(errbuf, "Supplied argument is neither a game ID (%.400s)"
2208                             " nor a save file (%.400s)", err, strerror(errno));
2209                 } else {
2210                     err = midend_deserialise(fe->me, savefile_read, fp);
2211                     if (err)
2212                         sprintf(errbuf, "%.800s", err);
2213                     fclose(fp);
2214                 }
2215             }
2216             break;
2217         }
2218         if (*errbuf) {
2219             *error = dupstr(errbuf);
2220             midend_free(fe->me);
2221             sfree(fe);
2222             return NULL;
2223         }
2224
2225     } else {
2226         midend_new_game(fe->me);
2227     }
2228
2229     {
2230         /*
2231          * try_shrink_drawing_area() will do some fiddling with the
2232          * window size request (see comment in that function) after
2233          * all the bits and pieces such as the menu bar and status bar
2234          * have appeared in the puzzle window.
2235          *
2236          * However, on Unity systems, the menu bar _doesn't_ appear in
2237          * the puzzle window, because the Unity shell hijacks it into
2238          * the menu bar at the very top of the screen. We therefore
2239          * try to detect that situation here, so that we don't sit
2240          * here forever waiting for a menu bar.
2241          */
2242         const char prop[] = "gtk-shell-shows-menubar";
2243         GtkSettings *settings = gtk_settings_get_default();
2244         if (!g_object_class_find_property(G_OBJECT_GET_CLASS(settings),
2245                                           prop)) {
2246             fe->menubar_is_local = TRUE;
2247         } else {
2248             int unity_mode;
2249             g_object_get(gtk_settings_get_default(),
2250                          prop, &unity_mode,
2251                          (const gchar *)NULL);
2252             fe->menubar_is_local = !unity_mode;
2253         }
2254     }
2255
2256     fe->window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
2257     gtk_window_set_title(GTK_WINDOW(fe->window), thegame.name);
2258
2259     vbox = GTK_BOX(gtk_vbox_new(FALSE, 0));
2260     gtk_container_add(GTK_CONTAINER(fe->window), GTK_WIDGET(vbox));
2261     gtk_widget_show(GTK_WIDGET(vbox));
2262
2263     fe->accelgroup = gtk_accel_group_new();
2264     gtk_window_add_accel_group(GTK_WINDOW(fe->window), fe->accelgroup);
2265
2266     hbox = GTK_BOX(gtk_hbox_new(FALSE, 0));
2267     gtk_box_pack_start(vbox, GTK_WIDGET(hbox), FALSE, FALSE, 0);
2268     gtk_widget_show(GTK_WIDGET(hbox));
2269
2270     fe->menubar = gtk_menu_bar_new();
2271     gtk_box_pack_start(hbox, fe->menubar, TRUE, TRUE, 0);
2272     gtk_widget_show(fe->menubar);
2273
2274     menuitem = gtk_menu_item_new_with_mnemonic("_Game");
2275     gtk_container_add(GTK_CONTAINER(fe->menubar), menuitem);
2276     gtk_widget_show(menuitem);
2277
2278     menu = gtk_menu_new();
2279     gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), menu);
2280
2281     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "New", 'n');
2282
2283     menuitem = gtk_menu_item_new_with_label("Restart");
2284     gtk_container_add(GTK_CONTAINER(menu), menuitem);
2285     g_signal_connect(G_OBJECT(menuitem), "activate",
2286                      G_CALLBACK(menu_restart_event), fe);
2287     gtk_widget_show(menuitem);
2288
2289     menuitem = gtk_menu_item_new_with_label("Specific...");
2290     g_object_set_data(G_OBJECT(menuitem), "user-data",
2291                       GINT_TO_POINTER(CFG_DESC));
2292     gtk_container_add(GTK_CONTAINER(menu), menuitem);
2293     g_signal_connect(G_OBJECT(menuitem), "activate",
2294                      G_CALLBACK(menu_config_event), fe);
2295     gtk_widget_show(menuitem);
2296
2297     menuitem = gtk_menu_item_new_with_label("Random Seed...");
2298     g_object_set_data(G_OBJECT(menuitem), "user-data",
2299                       GINT_TO_POINTER(CFG_SEED));
2300     gtk_container_add(GTK_CONTAINER(menu), menuitem);
2301     g_signal_connect(G_OBJECT(menuitem), "activate",
2302                      G_CALLBACK(menu_config_event), fe);
2303     gtk_widget_show(menuitem);
2304
2305     fe->preset_radio = NULL;
2306     fe->preset_custom = NULL;
2307     fe->n_preset_menu_items = 0;
2308     fe->preset_threaded = FALSE;
2309     if ((n = midend_num_presets(fe->me)) > 0 || thegame.can_configure) {
2310         GtkWidget *submenu;
2311         int i;
2312
2313         menuitem = gtk_menu_item_new_with_mnemonic("_Type");
2314         gtk_container_add(GTK_CONTAINER(fe->menubar), menuitem);
2315         gtk_widget_show(menuitem);
2316
2317         submenu = gtk_menu_new();
2318         gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), submenu);
2319
2320         for (i = 0; i < n; i++) {
2321             char *name;
2322             game_params *params;
2323
2324             midend_fetch_preset(fe->me, i, &name, &params);
2325
2326             menuitem =
2327                 gtk_radio_menu_item_new_with_label(fe->preset_radio, name);
2328             fe->preset_radio =
2329                 gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(menuitem));
2330             fe->n_preset_menu_items++;
2331             gtk_container_add(GTK_CONTAINER(submenu), menuitem);
2332             g_object_set_data(G_OBJECT(menuitem), "user-data", params);
2333             g_signal_connect(G_OBJECT(menuitem), "activate",
2334                              G_CALLBACK(menu_preset_event), fe);
2335             gtk_widget_show(menuitem);
2336         }
2337
2338         if (thegame.can_configure) {
2339             menuitem = fe->preset_custom =
2340                 gtk_radio_menu_item_new_with_label(fe->preset_radio,
2341                                                    "Custom...");
2342             fe->preset_radio =
2343                 gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(menuitem));
2344             gtk_container_add(GTK_CONTAINER(submenu), menuitem);
2345             g_object_set_data(G_OBJECT(menuitem), "user-data",
2346                               GINT_TO_POINTER(CFG_SETTINGS));
2347             g_signal_connect(G_OBJECT(menuitem), "activate",
2348                              G_CALLBACK(menu_config_event), fe);
2349             gtk_widget_show(menuitem);
2350         }
2351
2352     }
2353
2354     add_menu_separator(GTK_CONTAINER(menu));
2355     menuitem = gtk_menu_item_new_with_label("Load...");
2356     gtk_container_add(GTK_CONTAINER(menu), menuitem);
2357     g_signal_connect(G_OBJECT(menuitem), "activate",
2358                      G_CALLBACK(menu_load_event), fe);
2359     gtk_widget_show(menuitem);
2360     menuitem = gtk_menu_item_new_with_label("Save...");
2361     gtk_container_add(GTK_CONTAINER(menu), menuitem);
2362     g_signal_connect(G_OBJECT(menuitem), "activate",
2363                      G_CALLBACK(menu_save_event), fe);
2364     gtk_widget_show(menuitem);
2365 #ifndef STYLUS_BASED
2366     add_menu_separator(GTK_CONTAINER(menu));
2367     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Undo", 'u');
2368     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Redo", 'r');
2369 #endif
2370     if (thegame.can_format_as_text_ever) {
2371         add_menu_separator(GTK_CONTAINER(menu));
2372         menuitem = gtk_menu_item_new_with_label("Copy");
2373         gtk_container_add(GTK_CONTAINER(menu), menuitem);
2374         g_signal_connect(G_OBJECT(menuitem), "activate",
2375                          G_CALLBACK(menu_copy_event), fe);
2376         gtk_widget_show(menuitem);
2377         fe->copy_menu_item = menuitem;
2378     } else {
2379         fe->copy_menu_item = NULL;
2380     }
2381     if (thegame.can_solve) {
2382         add_menu_separator(GTK_CONTAINER(menu));
2383         menuitem = gtk_menu_item_new_with_label("Solve");
2384         gtk_container_add(GTK_CONTAINER(menu), menuitem);
2385         g_signal_connect(G_OBJECT(menuitem), "activate",
2386                          G_CALLBACK(menu_solve_event), fe);
2387         gtk_widget_show(menuitem);
2388     }
2389     add_menu_separator(GTK_CONTAINER(menu));
2390     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Exit", 'q');
2391
2392     menuitem = gtk_menu_item_new_with_mnemonic("_Help");
2393     gtk_container_add(GTK_CONTAINER(fe->menubar), menuitem);
2394     gtk_widget_show(menuitem);
2395
2396     menu = gtk_menu_new();
2397     gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), menu);
2398
2399     menuitem = gtk_menu_item_new_with_label("About");
2400     gtk_container_add(GTK_CONTAINER(menu), menuitem);
2401     g_signal_connect(G_OBJECT(menuitem), "activate",
2402                      G_CALLBACK(menu_about_event), fe);
2403     gtk_widget_show(menuitem);
2404
2405 #ifdef STYLUS_BASED
2406     menuitem=gtk_button_new_with_mnemonic("_Redo");
2407     g_object_set_data(G_OBJECT(menuitem), "user-data",
2408                       GINT_TO_POINTER((int)('r')));
2409     g_signal_connect(G_OBJECT(menuitem), "clicked",
2410                      G_CALLBACK(menu_key_event), fe);
2411     gtk_box_pack_end(hbox, menuitem, FALSE, FALSE, 0);
2412     gtk_widget_show(menuitem);
2413
2414     menuitem=gtk_button_new_with_mnemonic("_Undo");
2415     g_object_set_data(G_OBJECT(menuitem), "user-data",
2416                       GINT_TO_POINTER((int)('u')));
2417     g_signal_connect(G_OBJECT(menuitem), "clicked",
2418                      G_CALLBACK(menu_key_event), fe);
2419     gtk_box_pack_end(hbox, menuitem, FALSE, FALSE, 0);
2420     gtk_widget_show(menuitem);
2421
2422     if (thegame.flags & REQUIRE_NUMPAD) {
2423         hbox = GTK_BOX(gtk_hbox_new(FALSE, 0));
2424         gtk_box_pack_start(vbox, GTK_WIDGET(hbox), FALSE, FALSE, 0);
2425         gtk_widget_show(GTK_WIDGET(hbox));
2426
2427         *((int*)errbuf)=0;
2428         errbuf[1]='\0';
2429         for(errbuf[0]='0';errbuf[0]<='9';errbuf[0]++) {
2430             menuitem=gtk_button_new_with_label(errbuf);
2431             g_object_set_data(G_OBJECT(menuitem), "user-data",
2432                               GINT_TO_POINTER((int)(errbuf[0])));
2433             g_signal_connect(G_OBJECT(menuitem), "clicked",
2434                              G_CALLBACK(menu_key_event), fe);
2435             gtk_box_pack_start(hbox, menuitem, TRUE, TRUE, 0);
2436             gtk_widget_show(menuitem);
2437         }
2438     }
2439 #endif /* STYLUS_BASED */
2440
2441     changed_preset(fe);
2442
2443     snaffle_colours(fe);
2444
2445     if (midend_wants_statusbar(fe->me)) {
2446         GtkWidget *viewport;
2447         GtkRequisition req;
2448
2449         viewport = gtk_viewport_new(NULL, NULL);
2450         gtk_viewport_set_shadow_type(GTK_VIEWPORT(viewport), GTK_SHADOW_NONE);
2451         fe->statusbar = gtk_statusbar_new();
2452         gtk_container_add(GTK_CONTAINER(viewport), fe->statusbar);
2453         gtk_widget_show(viewport);
2454         gtk_box_pack_end(vbox, viewport, FALSE, FALSE, 0);
2455         gtk_widget_show(fe->statusbar);
2456         fe->statusctx = gtk_statusbar_get_context_id
2457             (GTK_STATUSBAR(fe->statusbar), "game");
2458         gtk_statusbar_push(GTK_STATUSBAR(fe->statusbar), fe->statusctx,
2459                            "test");
2460         gtk_widget_size_request(fe->statusbar, &req);
2461 #if 0
2462         /* For GTK 2.0, should we be using gtk_widget_set_size_request? */
2463 #endif
2464         gtk_widget_set_usize(viewport, -1, req.height);
2465     } else
2466         fe->statusbar = NULL;
2467
2468     fe->area = gtk_drawing_area_new();
2469 #if GTK_CHECK_VERSION(2,0,0)
2470     gtk_widget_set_double_buffered(fe->area, FALSE);
2471 #endif
2472     get_size(fe, &x, &y);
2473     fe->drawing_area_shrink_pending = FALSE;
2474     gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), x, y);
2475     fe->w = x;
2476     fe->h = y;
2477
2478     gtk_box_pack_end(vbox, fe->area, TRUE, TRUE, 0);
2479
2480     clear_backing_store(fe);
2481     fe->fonts = NULL;
2482     fe->nfonts = fe->fontsize = 0;
2483
2484     fe->paste_data = NULL;
2485     fe->paste_data_len = 0;
2486
2487     g_signal_connect(G_OBJECT(fe->window), "destroy",
2488                      G_CALLBACK(destroy), fe);
2489     g_signal_connect(G_OBJECT(fe->window), "key_press_event",
2490                      G_CALLBACK(key_event), fe);
2491     g_signal_connect(G_OBJECT(fe->area), "button_press_event",
2492                      G_CALLBACK(button_event), fe);
2493     g_signal_connect(G_OBJECT(fe->area), "button_release_event",
2494                      G_CALLBACK(button_event), fe);
2495     g_signal_connect(G_OBJECT(fe->area), "motion_notify_event",
2496                      G_CALLBACK(motion_event), fe);
2497     g_signal_connect(G_OBJECT(fe->area), "selection_get",
2498                      G_CALLBACK(selection_get), fe);
2499     g_signal_connect(G_OBJECT(fe->area), "selection_clear_event",
2500                      G_CALLBACK(selection_clear), fe);
2501     g_signal_connect(G_OBJECT(fe->area), "expose_event",
2502                      G_CALLBACK(expose_area), fe);
2503     g_signal_connect(G_OBJECT(fe->window), "map_event",
2504                      G_CALLBACK(map_window), fe);
2505     g_signal_connect(G_OBJECT(fe->area), "configure_event",
2506                      G_CALLBACK(configure_area), fe);
2507     g_signal_connect(G_OBJECT(fe->window), "configure_event",
2508                      G_CALLBACK(configure_window), fe);
2509
2510     gtk_widget_add_events(GTK_WIDGET(fe->area),
2511                           GDK_BUTTON_PRESS_MASK |
2512                           GDK_BUTTON_RELEASE_MASK |
2513                           GDK_BUTTON_MOTION_MASK |
2514                           GDK_POINTER_MOTION_HINT_MASK);
2515
2516     if (n_xpm_icons) {
2517         gtk_window_set_icon(GTK_WINDOW(fe->window),
2518                             gdk_pixbuf_new_from_xpm_data
2519                             ((const gchar **)xpm_icons[0]));
2520
2521         iconlist = NULL;
2522         for (n = 0; n < n_xpm_icons; n++) {
2523             iconlist =
2524                 g_list_append(iconlist,
2525                               gdk_pixbuf_new_from_xpm_data((const gchar **)
2526                                                            xpm_icons[n]));
2527         }
2528         gtk_window_set_icon_list(GTK_WINDOW(fe->window), iconlist);
2529     }
2530
2531     gtk_widget_show(fe->area);
2532     gtk_widget_show(fe->window);
2533
2534     fe->drawing_area_shrink_pending = TRUE;
2535     try_shrink_drawing_area(fe);
2536     set_window_background(fe, 0);
2537
2538     return fe;
2539 }
2540
2541 char *fgetline(FILE *fp)
2542 {
2543     char *ret = snewn(512, char);
2544     int size = 512, len = 0;
2545     while (fgets(ret + len, size - len, fp)) {
2546         len += strlen(ret + len);
2547         if (ret[len-1] == '\n')
2548             break;                     /* got a newline, we're done */
2549         size = len + 512;
2550         ret = sresize(ret, size, char);
2551     }
2552     if (len == 0) {                    /* first fgets returned NULL */
2553         sfree(ret);
2554         return NULL;
2555     }
2556     ret[len] = '\0';
2557     return ret;
2558 }
2559
2560 int main(int argc, char **argv)
2561 {
2562     char *pname = argv[0];
2563     char *error;
2564     int ngenerate = 0, print = FALSE, px = 1, py = 1;
2565     int time_generation = FALSE, test_solve = FALSE, list_presets = FALSE;
2566     int soln = FALSE, colour = FALSE;
2567     float scale = 1.0F;
2568     float redo_proportion = 0.0F;
2569     char *savefile = NULL, *savesuffix = NULL;
2570     char *arg = NULL;
2571     int argtype = ARG_EITHER;
2572     char *screenshot_file = NULL;
2573     int doing_opts = TRUE;
2574     int ac = argc;
2575     char **av = argv;
2576     char errbuf[500];
2577
2578     /*
2579      * Command line parsing in this function is rather fiddly,
2580      * because GTK wants to have a go at argc/argv _first_ - and
2581      * yet we can't let it, because gtk_init() will bomb out if it
2582      * can't open an X display, whereas in fact we want to permit
2583      * our --generate and --print modes to run without an X
2584      * display.
2585      *
2586      * So what we do is:
2587      *  - we parse the command line ourselves, without modifying
2588      *    argc/argv
2589      *  - if we encounter an error which might plausibly be the
2590      *    result of a GTK command line (i.e. not detailed errors in
2591      *    particular options of ours) we store the error message
2592      *    and terminate parsing.
2593      *  - if we got enough out of the command line to know it
2594      *    specifies a non-X mode of operation, we either display
2595      *    the stored error and return failure, or if there is no
2596      *    stored error we do the non-X operation and return
2597      *    success.
2598      *  - otherwise, we go straight to gtk_init().
2599      */
2600
2601     errbuf[0] = '\0';
2602     while (--ac > 0) {
2603         char *p = *++av;
2604         if (doing_opts && !strcmp(p, "--version")) {
2605             printf("%s, from Simon Tatham's Portable Puzzle Collection\n%s\n",
2606                    thegame.name, ver);
2607             return 0;
2608         } else if (doing_opts && !strcmp(p, "--generate")) {
2609             if (--ac > 0) {
2610                 ngenerate = atoi(*++av);
2611                 if (!ngenerate) {
2612                     fprintf(stderr, "%s: '--generate' expected a number\n",
2613                             pname);
2614                     return 1;
2615                 }
2616             } else
2617                 ngenerate = 1;
2618         } else if (doing_opts && !strcmp(p, "--time-generation")) {
2619             time_generation = TRUE;
2620         } else if (doing_opts && !strcmp(p, "--test-solve")) {
2621             test_solve = TRUE;
2622         } else if (doing_opts && !strcmp(p, "--list-presets")) {
2623             list_presets = TRUE;
2624         } else if (doing_opts && !strcmp(p, "--save")) {
2625             if (--ac > 0) {
2626                 savefile = *++av;
2627             } else {
2628                 fprintf(stderr, "%s: '--save' expected a filename\n",
2629                         pname);
2630                 return 1;
2631             }
2632         } else if (doing_opts && (!strcmp(p, "--save-suffix") ||
2633                                   !strcmp(p, "--savesuffix"))) {
2634             if (--ac > 0) {
2635                 savesuffix = *++av;
2636             } else {
2637                 fprintf(stderr, "%s: '--save-suffix' expected a filename\n",
2638                         pname);
2639                 return 1;
2640             }
2641         } else if (doing_opts && !strcmp(p, "--print")) {
2642             if (!thegame.can_print) {
2643                 fprintf(stderr, "%s: this game does not support printing\n",
2644                         pname);
2645                 return 1;
2646             }
2647             print = TRUE;
2648             if (--ac > 0) {
2649                 char *dim = *++av;
2650                 if (sscanf(dim, "%dx%d", &px, &py) != 2) {
2651                     fprintf(stderr, "%s: unable to parse argument '%s' to "
2652                             "'--print'\n", pname, dim);
2653                     return 1;
2654                 }
2655             } else {
2656                 px = py = 1;
2657             }
2658         } else if (doing_opts && !strcmp(p, "--scale")) {
2659             if (--ac > 0) {
2660                 scale = atof(*++av);
2661             } else {
2662                 fprintf(stderr, "%s: no argument supplied to '--scale'\n",
2663                         pname);
2664                 return 1;
2665             }
2666         } else if (doing_opts && !strcmp(p, "--redo")) {
2667             /*
2668              * This is an internal option which I don't expect
2669              * users to have any particular use for. The effect of
2670              * --redo is that once the game has been loaded and
2671              * initialised, the next move in the redo chain is
2672              * replayed, and the game screen is redrawn part way
2673              * through the making of the move. This is only
2674              * meaningful if there _is_ a next move in the redo
2675              * chain, which means in turn that this option is only
2676              * useful if you're also passing a save file on the
2677              * command line.
2678              *
2679              * This option is used by the script which generates
2680              * the puzzle icons and website screenshots, and I
2681              * don't imagine it's useful for anything else.
2682              * (Unless, I suppose, users don't like my screenshots
2683              * and want to generate their own in the same way for
2684              * some repackaged version of the puzzles.)
2685              */
2686             if (--ac > 0) {
2687                 redo_proportion = atof(*++av);
2688             } else {
2689                 fprintf(stderr, "%s: no argument supplied to '--redo'\n",
2690                         pname);
2691                 return 1;
2692             }
2693         } else if (doing_opts && !strcmp(p, "--screenshot")) {
2694             /*
2695              * Another internal option for the icon building
2696              * script. This causes a screenshot of the central
2697              * drawing area (i.e. not including the menu bar or
2698              * status bar) to be saved to a PNG file once the
2699              * window has been drawn, and then the application
2700              * quits immediately.
2701              */
2702             if (--ac > 0) {
2703                 screenshot_file = *++av;
2704             } else {
2705                 fprintf(stderr, "%s: no argument supplied to '--screenshot'\n",
2706                         pname);
2707                 return 1;
2708             }
2709         } else if (doing_opts && (!strcmp(p, "--with-solutions") ||
2710                                   !strcmp(p, "--with-solution") ||
2711                                   !strcmp(p, "--with-solns") ||
2712                                   !strcmp(p, "--with-soln") ||
2713                                   !strcmp(p, "--solutions") ||
2714                                   !strcmp(p, "--solution") ||
2715                                   !strcmp(p, "--solns") ||
2716                                   !strcmp(p, "--soln"))) {
2717             soln = TRUE;
2718         } else if (doing_opts && !strcmp(p, "--colour")) {
2719             if (!thegame.can_print_in_colour) {
2720                 fprintf(stderr, "%s: this game does not support colour"
2721                         " printing\n", pname);
2722                 return 1;
2723             }
2724             colour = TRUE;
2725         } else if (doing_opts && !strcmp(p, "--load")) {
2726             argtype = ARG_SAVE;
2727         } else if (doing_opts && !strcmp(p, "--game")) {
2728             argtype = ARG_ID;
2729         } else if (doing_opts && !strcmp(p, "--")) {
2730             doing_opts = FALSE;
2731         } else if (!doing_opts || p[0] != '-') {
2732             if (arg) {
2733                 fprintf(stderr, "%s: more than one argument supplied\n",
2734                         pname);
2735                 return 1;
2736             }
2737             arg = p;
2738         } else {
2739             sprintf(errbuf, "%.100s: unrecognised option '%.100s'\n",
2740                     pname, p);
2741             break;
2742         }
2743     }
2744
2745     /*
2746      * Special standalone mode for generating puzzle IDs on the
2747      * command line. Useful for generating puzzles to be printed
2748      * out and solved offline (for puzzles where that even makes
2749      * sense - Solo, for example, is a lot more pencil-and-paper
2750      * friendly than Twiddle!)
2751      *
2752      * Usage:
2753      *
2754      *   <puzzle-name> --generate [<n> [<params>]]
2755      *
2756      * <n>, if present, is the number of puzzle IDs to generate.
2757      * <params>, if present, is the same type of parameter string
2758      * you would pass to the puzzle when running it in GUI mode,
2759      * including optional extras such as the expansion factor in
2760      * Rectangles and the difficulty level in Solo.
2761      *
2762      * If you specify <params>, you must also specify <n> (although
2763      * you may specify it to be 1). Sorry; that was the
2764      * simplest-to-parse command-line syntax I came up with.
2765      */
2766     if (ngenerate > 0 || print || savefile || savesuffix) {
2767         int i, n = 1;
2768         midend *me;
2769         char *id;
2770         document *doc = NULL;
2771
2772         /*
2773          * If we're in this branch, we should display any pending
2774          * error message from the command line, since GTK isn't going
2775          * to take another crack at making sense of it.
2776          */
2777         if (*errbuf) {
2778             fputs(errbuf, stderr);
2779             return 1;
2780         }
2781
2782         n = ngenerate;
2783
2784         me = midend_new(NULL, &thegame, NULL, NULL);
2785         i = 0;
2786
2787         if (savefile && !savesuffix)
2788             savesuffix = "";
2789         if (!savefile && savesuffix)
2790             savefile = "";
2791
2792         if (print)
2793             doc = document_new(px, py, scale);
2794
2795         /*
2796          * In this loop, we either generate a game ID or read one
2797          * from stdin depending on whether we're in generate mode;
2798          * then we either write it to stdout or print it, depending
2799          * on whether we're in print mode. Thus, this loop handles
2800          * generate-to-stdout, print-from-stdin and generate-and-
2801          * immediately-print modes.
2802          *
2803          * (It could also handle a copy-stdin-to-stdout mode,
2804          * although there's currently no combination of options
2805          * which will cause this loop to be activated in that mode.
2806          * It wouldn't be _entirely_ pointless, though, because
2807          * stdin could contain bare params strings or random-seed
2808          * IDs, and stdout would contain nothing but fully
2809          * generated descriptive game IDs.)
2810          */
2811         while (ngenerate == 0 || i < n) {
2812             char *pstr, *err, *seed;
2813             struct rusage before, after;
2814
2815             if (ngenerate == 0) {
2816                 pstr = fgetline(stdin);
2817                 if (!pstr)
2818                     break;
2819                 pstr[strcspn(pstr, "\r\n")] = '\0';
2820             } else {
2821                 if (arg) {
2822                     pstr = snewn(strlen(arg) + 40, char);
2823
2824                     strcpy(pstr, arg);
2825                     if (i > 0 && strchr(arg, '#'))
2826                         sprintf(pstr + strlen(pstr), "-%d", i);
2827                 } else
2828                     pstr = NULL;
2829             }
2830
2831             if (pstr) {
2832                 err = midend_game_id(me, pstr);
2833                 if (err) {
2834                     fprintf(stderr, "%s: error parsing '%s': %s\n",
2835                             pname, pstr, err);
2836                     return 1;
2837                 }
2838             }
2839
2840             if (time_generation)
2841                 getrusage(RUSAGE_SELF, &before);
2842
2843             midend_new_game(me);
2844
2845             seed = midend_get_random_seed(me);
2846
2847             if (time_generation) {
2848                 double elapsed;
2849
2850                 getrusage(RUSAGE_SELF, &after);
2851
2852                 elapsed = (after.ru_utime.tv_sec -
2853                            before.ru_utime.tv_sec);
2854                 elapsed += (after.ru_utime.tv_usec -
2855                             before.ru_utime.tv_usec) / 1000000.0;
2856
2857                 printf("%s %s: %.6f\n", thegame.name, seed, elapsed);
2858             }
2859
2860             if (test_solve && thegame.can_solve) {
2861                 /*
2862                  * Now destroy the aux_info in the midend, by means of
2863                  * re-entering the same game id, and then try to solve
2864                  * it.
2865                  */
2866                 char *game_id, *err;
2867
2868                 game_id = midend_get_game_id(me);
2869                 err = midend_game_id(me, game_id);
2870                 if (err) {
2871                     fprintf(stderr, "%s %s: game id re-entry error: %s\n",
2872                             thegame.name, seed, err);
2873                     return 1;
2874                 }
2875                 midend_new_game(me);
2876                 sfree(game_id);
2877
2878                 err = midend_solve(me);
2879                 /*
2880                  * If the solve operation returned the error "Solution
2881                  * not known for this puzzle", that's OK, because that
2882                  * just means it's a puzzle for which we don't have an
2883                  * algorithmic solver and hence can't solve it without
2884                  * the aux_info, e.g. Netslide. Any other error is a
2885                  * problem, though.
2886                  */
2887                 if (err && strcmp(err, "Solution not known for this puzzle")) {
2888                     fprintf(stderr, "%s %s: solve error: %s\n",
2889                             thegame.name, seed, err);
2890                     return 1;
2891                 }
2892             }
2893
2894             sfree(pstr);
2895             sfree(seed);
2896
2897             if (doc) {
2898                 err = midend_print_puzzle(me, doc, soln);
2899                 if (err) {
2900                     fprintf(stderr, "%s: error in printing: %s\n", pname, err);
2901                     return 1;
2902                 }
2903             }
2904             if (savefile) {
2905                 struct savefile_write_ctx ctx;
2906                 char *realname = snewn(40 + strlen(savefile) +
2907                                        strlen(savesuffix), char);
2908                 sprintf(realname, "%s%d%s", savefile, i, savesuffix);
2909
2910                 if (soln) {
2911                     char *err = midend_solve(me);
2912                     if (err) {
2913                         fprintf(stderr, "%s: unable to show solution: %s\n",
2914                                 realname, err);
2915                         return 1;
2916                     }
2917                 }
2918
2919                 ctx.fp = fopen(realname, "w");
2920                 if (!ctx.fp) {
2921                     fprintf(stderr, "%s: open: %s\n", realname,
2922                             strerror(errno));
2923                     return 1;
2924                 }
2925                 ctx.error = 0;
2926                 midend_serialise(me, savefile_write, &ctx);
2927                 if (ctx.error) {
2928                     fprintf(stderr, "%s: write: %s\n", realname,
2929                             strerror(ctx.error));
2930                     return 1;
2931                 }
2932                 if (fclose(ctx.fp)) {
2933                     fprintf(stderr, "%s: close: %s\n", realname,
2934                             strerror(errno));
2935                     return 1;
2936                 }
2937                 sfree(realname);
2938             }
2939             if (!doc && !savefile && !time_generation) {
2940                 id = midend_get_game_id(me);
2941                 puts(id);
2942                 sfree(id);
2943             }
2944
2945             i++;
2946         }
2947
2948         if (doc) {
2949             psdata *ps = ps_init(stdout, colour);
2950             document_print(doc, ps_drawing_api(ps));
2951             document_free(doc);
2952             ps_free(ps);
2953         }
2954
2955         midend_free(me);
2956
2957         return 0;
2958     } else if (list_presets) {
2959         /*
2960          * Another specialist mode which causes the puzzle to list the
2961          * game_params strings for all its preset configurations.
2962          */
2963         int i, npresets;
2964         midend *me;
2965
2966         me = midend_new(NULL, &thegame, NULL, NULL);
2967         npresets = midend_num_presets(me);
2968
2969         for (i = 0; i < npresets; i++) {
2970             game_params *params;
2971             char *name, *paramstr;
2972
2973             midend_fetch_preset(me, i, &name, &params);
2974             paramstr = thegame.encode_params(params, TRUE);
2975
2976             printf("%s %s\n", paramstr, name);
2977             sfree(paramstr);
2978         }
2979
2980         midend_free(me);
2981         return 0;
2982     } else {
2983         frontend *fe;
2984
2985         gtk_init(&argc, &argv);
2986
2987         fe = new_window(arg, argtype, &error);
2988
2989         if (!fe) {
2990             fprintf(stderr, "%s: %s\n", pname, error);
2991             return 1;
2992         }
2993
2994         if (screenshot_file) {
2995             /*
2996              * Some puzzles will not redraw their entire area if
2997              * given a partially completed animation, which means
2998              * we must redraw now and _then_ redraw again after
2999              * freezing the move timer.
3000              */
3001             midend_force_redraw(fe->me);
3002         }
3003
3004         if (redo_proportion) {
3005             /* Start a redo. */
3006             midend_process_key(fe->me, 0, 0, 'r');
3007             /* And freeze the timer at the specified position. */
3008             midend_freeze_timer(fe->me, redo_proportion);
3009         }
3010
3011         if (screenshot_file) {
3012             save_screenshot_png(fe, screenshot_file);
3013             exit(0);
3014         }
3015
3016         gtk_main();
3017     }
3018
3019     return 0;
3020 }