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