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