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