gtk.c

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