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