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