chiark / gitweb /
The other day I found it useful for a (silly) special purpose to
[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
13 #include <sys/time.h>
14
15 #include <gtk/gtk.h>
16 #include <gdk/gdkkeysyms.h>
17
18 #include <gdk-pixbuf/gdk-pixbuf.h>
19
20 #include <gdk/gdkx.h>
21 #include <X11/Xlib.h>
22 #include <X11/Xutil.h>
23 #include <X11/Xatom.h>
24
25 #include "puzzles.h"
26
27 #if GTK_CHECK_VERSION(2,0,0)
28 #define USE_PANGO
29 #endif
30
31 #ifdef DEBUGGING
32 static FILE *debug_fp = NULL;
33
34 void dputs(char *buf)
35 {
36     if (!debug_fp) {
37         debug_fp = fopen("debug.log", "w");
38     }
39
40     fputs(buf, stderr);
41
42     if (debug_fp) {
43         fputs(buf, debug_fp);
44         fflush(debug_fp);
45     }
46 }
47
48 void debug_printf(char *fmt, ...)
49 {
50     char buf[4096];
51     va_list ap;
52
53     va_start(ap, fmt);
54     vsprintf(buf, fmt, ap);
55     dputs(buf);
56     va_end(ap);
57 }
58 #endif
59
60 /* ----------------------------------------------------------------------
61  * Error reporting functions used elsewhere.
62  */
63
64 void fatal(char *fmt, ...)
65 {
66     va_list ap;
67
68     fprintf(stderr, "fatal error: ");
69
70     va_start(ap, fmt);
71     vfprintf(stderr, fmt, ap);
72     va_end(ap);
73
74     fprintf(stderr, "\n");
75     exit(1);
76 }
77
78 /* ----------------------------------------------------------------------
79  * GTK front end to puzzles.
80  */
81
82 static void changed_preset(frontend *fe);
83
84 struct font {
85 #ifdef USE_PANGO
86     PangoFontDescription *desc;
87 #else
88     GdkFont *font;
89 #endif
90     int type;
91     int size;
92 };
93
94 /*
95  * This structure holds all the data relevant to a single window.
96  * In principle this would allow us to open multiple independent
97  * puzzle windows, although I can't currently see any real point in
98  * doing so. I'm just coding cleanly because there's no
99  * particularly good reason not to.
100  */
101 struct frontend {
102     GtkWidget *window;
103     GtkAccelGroup *accelgroup;
104     GtkWidget *area;
105     GtkWidget *statusbar;
106     guint statusctx;
107     GdkPixmap *pixmap;
108     GdkColor *colours;
109     int ncolours;
110     GdkColormap *colmap;
111     int w, h;
112     midend *me;
113     GdkGC *gc;
114     int bbox_l, bbox_r, bbox_u, bbox_d;
115     int timer_active, timer_id;
116     struct timeval last_time;
117     struct font *fonts;
118     int nfonts, fontsize;
119     config_item *cfg;
120     int cfg_which, cfgret;
121     GtkWidget *cfgbox;
122     void *paste_data;
123     int paste_data_len;
124     int pw, ph;                        /* pixmap size (w, h are area size) */
125     int ox, oy;                        /* offset of pixmap in drawing area */
126     char *filesel_name;
127     int npresets;
128     GtkWidget **preset_bullets;
129     GtkWidget *preset_custom_bullet;
130     GtkWidget *copy_menu_item;
131 };
132
133 void get_random_seed(void **randseed, int *randseedsize)
134 {
135     struct timeval *tvp = snew(struct timeval);
136     gettimeofday(tvp, NULL);
137     *randseed = (void *)tvp;
138     *randseedsize = sizeof(struct timeval);
139 }
140
141 void frontend_default_colour(frontend *fe, float *output)
142 {
143     GdkColor col = fe->window->style->bg[GTK_STATE_NORMAL];
144     output[0] = col.red / 65535.0;
145     output[1] = col.green / 65535.0;
146     output[2] = col.blue / 65535.0;
147 }
148
149 void gtk_status_bar(void *handle, char *text)
150 {
151     frontend *fe = (frontend *)handle;
152
153     assert(fe->statusbar);
154
155     gtk_statusbar_pop(GTK_STATUSBAR(fe->statusbar), fe->statusctx);
156     gtk_statusbar_push(GTK_STATUSBAR(fe->statusbar), fe->statusctx, text);
157 }
158
159 void gtk_start_draw(void *handle)
160 {
161     frontend *fe = (frontend *)handle;
162     fe->gc = gdk_gc_new(fe->area->window);
163     fe->bbox_l = fe->w;
164     fe->bbox_r = 0;
165     fe->bbox_u = fe->h;
166     fe->bbox_d = 0;
167 }
168
169 void gtk_clip(void *handle, int x, int y, int w, int h)
170 {
171     frontend *fe = (frontend *)handle;
172     GdkRectangle rect;
173
174     rect.x = x;
175     rect.y = y;
176     rect.width = w;
177     rect.height = h;
178
179     gdk_gc_set_clip_rectangle(fe->gc, &rect);
180 }
181
182 void gtk_unclip(void *handle)
183 {
184     frontend *fe = (frontend *)handle;
185     GdkRectangle rect;
186
187     rect.x = 0;
188     rect.y = 0;
189     rect.width = fe->w;
190     rect.height = fe->h;
191
192     gdk_gc_set_clip_rectangle(fe->gc, &rect);
193 }
194
195 void gtk_draw_text(void *handle, int x, int y, int fonttype, int fontsize,
196                    int align, int colour, char *text)
197 {
198     frontend *fe = (frontend *)handle;
199     int i;
200
201     /*
202      * Find or create the font.
203      */
204     for (i = 0; i < fe->nfonts; i++)
205         if (fe->fonts[i].type == fonttype && fe->fonts[i].size == fontsize)
206             break;
207
208     if (i == fe->nfonts) {
209         if (fe->fontsize <= fe->nfonts) {
210             fe->fontsize = fe->nfonts + 10;
211             fe->fonts = sresize(fe->fonts, fe->fontsize, struct font);
212         }
213
214         fe->nfonts++;
215
216         fe->fonts[i].type = fonttype;
217         fe->fonts[i].size = fontsize;
218
219 #ifdef USE_PANGO
220         /*
221          * Use Pango to find the closest match to the requested
222          * font.
223          */
224         {
225             PangoFontDescription *fd;
226
227             fd = pango_font_description_new();
228             /* `Monospace' and `Sans' are meta-families guaranteed to exist */
229             pango_font_description_set_family(fd, fonttype == FONT_FIXED ?
230                                               "Monospace" : "Sans");
231             pango_font_description_set_weight(fd, PANGO_WEIGHT_BOLD);
232             /*
233              * I found some online Pango documentation which
234              * described a function called
235              * pango_font_description_set_absolute_size(), which is
236              * _exactly_ what I want here. Unfortunately, none of
237              * my local Pango installations have it (presumably
238              * they're too old), so I'm going to have to hack round
239              * it by figuring out the point size myself. This
240              * limits me to X and probably also breaks in later
241              * Pango installations, so ideally I should add another
242              * CHECK_VERSION type ifdef and use set_absolute_size
243              * where available. All very annoying.
244              */
245 #ifdef HAVE_SENSIBLE_ABSOLUTE_SIZE_FUNCTION
246             pango_font_description_set_absolute_size(fd, PANGO_SCALE*fontsize);
247 #else
248             {
249                 Display *d = GDK_DISPLAY();
250                 int s = DefaultScreen(d);
251                 double resolution =
252                     (PANGO_SCALE * 72.27 / 25.4) * 
253                     ((double) DisplayWidthMM(d, s) / DisplayWidth (d, s));
254                 pango_font_description_set_size(fd, resolution * fontsize);
255             }
256 #endif
257             fe->fonts[i].desc = fd;
258         }
259
260 #else
261         /*
262          * In GTK 1.2, I don't know of any plausible way to
263          * pick a suitable font, so I'm just going to be
264          * tedious.
265          */
266         fe->fonts[i].font = gdk_font_load(fonttype == FONT_FIXED ?
267                                           "fixed" : "variable");
268 #endif
269
270     }
271
272     /*
273      * Set the colour.
274      */
275     gdk_gc_set_foreground(fe->gc, &fe->colours[colour]);
276
277 #ifdef USE_PANGO
278
279     {
280         PangoLayout *layout;
281         PangoRectangle rect;
282
283         /*
284          * Create a layout.
285          */
286         layout = pango_layout_new(gtk_widget_get_pango_context(fe->area));
287         pango_layout_set_font_description(layout, fe->fonts[i].desc);
288         pango_layout_set_text(layout, text, strlen(text));
289         pango_layout_get_pixel_extents(layout, NULL, &rect);
290
291         if (align & ALIGN_VCENTRE)
292             rect.y -= rect.height / 2;
293         else
294             rect.y -= rect.height;
295
296         if (align & ALIGN_HCENTRE)
297             rect.x -= rect.width / 2;
298         else if (align & ALIGN_HRIGHT)
299             rect.x -= rect.width;
300
301         gdk_draw_layout(fe->pixmap, fe->gc, rect.x + x, rect.y + y, layout);
302
303         g_object_unref(layout);
304     }
305
306 #else
307     /*
308      * Find string dimensions and process alignment.
309      */
310     {
311         int lb, rb, wid, asc, desc;
312
313         /*
314          * Measure vertical string extents with respect to the same
315          * string always...
316          */
317         gdk_string_extents(fe->fonts[i].font,
318                            "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
319                            &lb, &rb, &wid, &asc, &desc);
320         if (align & ALIGN_VCENTRE)
321             y += asc - (asc+desc)/2;
322         else
323             y += asc;
324
325         /*
326          * ... but horizontal extents with respect to the provided
327          * string. This means that multiple pieces of text centred
328          * on the same y-coordinate don't have different baselines.
329          */
330         gdk_string_extents(fe->fonts[i].font, text,
331                            &lb, &rb, &wid, &asc, &desc);
332
333         if (align & ALIGN_HCENTRE)
334             x -= wid / 2;
335         else if (align & ALIGN_HRIGHT)
336             x -= wid;
337
338     }
339
340     /*
341      * Actually draw the text.
342      */
343     gdk_draw_string(fe->pixmap, fe->fonts[i].font, fe->gc, x, y, text);
344 #endif
345
346 }
347
348 void gtk_draw_rect(void *handle, int x, int y, int w, int h, int colour)
349 {
350     frontend *fe = (frontend *)handle;
351     gdk_gc_set_foreground(fe->gc, &fe->colours[colour]);
352     gdk_draw_rectangle(fe->pixmap, fe->gc, 1, x, y, w, h);
353 }
354
355 void gtk_draw_line(void *handle, int x1, int y1, int x2, int y2, int colour)
356 {
357     frontend *fe = (frontend *)handle;
358     gdk_gc_set_foreground(fe->gc, &fe->colours[colour]);
359     gdk_draw_line(fe->pixmap, fe->gc, x1, y1, x2, y2);
360 }
361
362 void gtk_draw_poly(void *handle, int *coords, int npoints,
363                    int fillcolour, int outlinecolour)
364 {
365     frontend *fe = (frontend *)handle;
366     GdkPoint *points = snewn(npoints, GdkPoint);
367     int i;
368
369     for (i = 0; i < npoints; i++) {
370         points[i].x = coords[i*2];
371         points[i].y = coords[i*2+1];
372     }
373
374     if (fillcolour >= 0) {
375         gdk_gc_set_foreground(fe->gc, &fe->colours[fillcolour]);
376         gdk_draw_polygon(fe->pixmap, fe->gc, TRUE, points, npoints);
377     }
378     assert(outlinecolour >= 0);
379     gdk_gc_set_foreground(fe->gc, &fe->colours[outlinecolour]);
380
381     /*
382      * In principle we ought to be able to use gdk_draw_polygon for
383      * the outline as well. In fact, it turns out to interact badly
384      * with a clipping region, for no terribly obvious reason, so I
385      * draw the outline as a sequence of lines instead.
386      */
387     for (i = 0; i < npoints; i++)
388         gdk_draw_line(fe->pixmap, fe->gc,
389                       points[i].x, points[i].y,
390                       points[(i+1)%npoints].x, points[(i+1)%npoints].y);
391
392     sfree(points);
393 }
394
395 void gtk_draw_circle(void *handle, int cx, int cy, int radius,
396                      int fillcolour, int outlinecolour)
397 {
398     frontend *fe = (frontend *)handle;
399     if (fillcolour >= 0) {
400         gdk_gc_set_foreground(fe->gc, &fe->colours[fillcolour]);
401         gdk_draw_arc(fe->pixmap, fe->gc, TRUE,
402                      cx - radius, cy - radius,
403                      2 * radius, 2 * radius, 0, 360 * 64);
404     }
405
406     assert(outlinecolour >= 0);
407     gdk_gc_set_foreground(fe->gc, &fe->colours[outlinecolour]);
408     gdk_draw_arc(fe->pixmap, fe->gc, FALSE,
409                  cx - radius, cy - radius,
410                  2 * radius, 2 * radius, 0, 360 * 64);
411 }
412
413 struct blitter {
414     GdkPixmap *pixmap;
415     int w, h, x, y;
416 };
417
418 blitter *gtk_blitter_new(void *handle, int w, int h)
419 {
420     /*
421      * We can't create the pixmap right now, because fe->window
422      * might not yet exist. So we just cache w and h and create it
423      * during the firs call to blitter_save.
424      */
425     blitter *bl = snew(blitter);
426     bl->pixmap = NULL;
427     bl->w = w;
428     bl->h = h;
429     return bl;
430 }
431
432 void gtk_blitter_free(void *handle, blitter *bl)
433 {
434     if (bl->pixmap)
435         gdk_pixmap_unref(bl->pixmap);
436     sfree(bl);
437 }
438
439 void gtk_blitter_save(void *handle, blitter *bl, int x, int y)
440 {
441     frontend *fe = (frontend *)handle;
442     if (!bl->pixmap)
443         bl->pixmap = gdk_pixmap_new(fe->area->window, bl->w, bl->h, -1);
444     bl->x = x;
445     bl->y = y;
446     gdk_draw_pixmap(bl->pixmap,
447                     fe->area->style->fg_gc[GTK_WIDGET_STATE(fe->area)],
448                     fe->pixmap,
449                     x, y, 0, 0, bl->w, bl->h);
450 }
451
452 void gtk_blitter_load(void *handle, blitter *bl, int x, int y)
453 {
454     frontend *fe = (frontend *)handle;
455     assert(bl->pixmap);
456     if (x == BLITTER_FROMSAVED && y == BLITTER_FROMSAVED) {
457         x = bl->x;
458         y = bl->y;
459     }
460     gdk_draw_pixmap(fe->pixmap,
461                     fe->area->style->fg_gc[GTK_WIDGET_STATE(fe->area)],
462                     bl->pixmap,
463                     0, 0, x, y, bl->w, bl->h);
464 }
465
466 void gtk_draw_update(void *handle, int x, int y, int w, int h)
467 {
468     frontend *fe = (frontend *)handle;
469     if (fe->bbox_l > x  ) fe->bbox_l = x  ;
470     if (fe->bbox_r < x+w) fe->bbox_r = x+w;
471     if (fe->bbox_u > y  ) fe->bbox_u = y  ;
472     if (fe->bbox_d < y+h) fe->bbox_d = y+h;
473 }
474
475 void gtk_end_draw(void *handle)
476 {
477     frontend *fe = (frontend *)handle;
478     gdk_gc_unref(fe->gc);
479     fe->gc = NULL;
480
481     if (fe->bbox_l < fe->bbox_r && fe->bbox_u < fe->bbox_d) {
482         gdk_draw_pixmap(fe->area->window,
483                         fe->area->style->fg_gc[GTK_WIDGET_STATE(fe->area)],
484                         fe->pixmap,
485                         fe->bbox_l, fe->bbox_u,
486                         fe->ox + fe->bbox_l, fe->oy + fe->bbox_u,
487                         fe->bbox_r - fe->bbox_l, fe->bbox_d - fe->bbox_u);
488     }
489 }
490
491 const struct drawing_api gtk_drawing = {
492     gtk_draw_text,
493     gtk_draw_rect,
494     gtk_draw_line,
495     gtk_draw_poly,
496     gtk_draw_circle,
497     gtk_draw_update,
498     gtk_clip,
499     gtk_unclip,
500     gtk_start_draw,
501     gtk_end_draw,
502     gtk_status_bar,
503     gtk_blitter_new,
504     gtk_blitter_free,
505     gtk_blitter_save,
506     gtk_blitter_load,
507     NULL, NULL, NULL, NULL, NULL, NULL, /* {begin,end}_{doc,page,puzzle} */
508     NULL,                              /* line_width */
509 };
510
511 static void destroy(GtkWidget *widget, gpointer data)
512 {
513     frontend *fe = (frontend *)data;
514     deactivate_timer(fe);
515     midend_free(fe->me);
516     gtk_main_quit();
517 }
518
519 static gint key_event(GtkWidget *widget, GdkEventKey *event, gpointer data)
520 {
521     frontend *fe = (frontend *)data;
522     int keyval;
523     int shift = (event->state & GDK_SHIFT_MASK) ? MOD_SHFT : 0;
524     int ctrl = (event->state & GDK_CONTROL_MASK) ? MOD_CTRL : 0;
525
526     if (!fe->pixmap)
527         return TRUE;
528
529 #if !GTK_CHECK_VERSION(2,0,0)
530     /* Gtk 1.2 passes a key event to this function even if it's also
531      * defined as an accelerator.
532      * Gtk 2 doesn't do this, and this function appears not to exist there. */
533     if (fe->accelgroup &&
534         gtk_accel_group_get_entry(fe->accelgroup,
535         event->keyval, event->state))
536         return TRUE;
537 #endif
538
539     if (event->keyval == GDK_Up)
540         keyval = shift | ctrl | CURSOR_UP;
541     else if (event->keyval == GDK_KP_Up || event->keyval == GDK_KP_8)
542         keyval = MOD_NUM_KEYPAD | '8';
543     else if (event->keyval == GDK_Down)
544         keyval = shift | ctrl | CURSOR_DOWN;
545     else if (event->keyval == GDK_KP_Down || event->keyval == GDK_KP_2)
546         keyval = MOD_NUM_KEYPAD | '2';
547     else if (event->keyval == GDK_Left)
548         keyval = shift | ctrl | CURSOR_LEFT;
549     else if (event->keyval == GDK_KP_Left || event->keyval == GDK_KP_4)
550         keyval = MOD_NUM_KEYPAD | '4';
551     else if (event->keyval == GDK_Right)
552         keyval = shift | ctrl | CURSOR_RIGHT;
553     else if (event->keyval == GDK_KP_Right || event->keyval == GDK_KP_6)
554         keyval = MOD_NUM_KEYPAD | '6';
555     else if (event->keyval == GDK_KP_Home || event->keyval == GDK_KP_7)
556         keyval = MOD_NUM_KEYPAD | '7';
557     else if (event->keyval == GDK_KP_End || event->keyval == GDK_KP_1)
558         keyval = MOD_NUM_KEYPAD | '1';
559     else if (event->keyval == GDK_KP_Page_Up || event->keyval == GDK_KP_9)
560         keyval = MOD_NUM_KEYPAD | '9';
561     else if (event->keyval == GDK_KP_Page_Down || event->keyval == GDK_KP_3)
562         keyval = MOD_NUM_KEYPAD | '3';
563     else if (event->keyval == GDK_KP_Insert || event->keyval == GDK_KP_0)
564         keyval = MOD_NUM_KEYPAD | '0';
565     else if (event->keyval == GDK_KP_Begin || event->keyval == GDK_KP_5)
566         keyval = MOD_NUM_KEYPAD | '5';
567     else if (event->keyval == GDK_BackSpace ||
568              event->keyval == GDK_Delete ||
569              event->keyval == GDK_KP_Delete)
570         keyval = '\177';
571     else if (event->string[0] && !event->string[1])
572         keyval = (unsigned char)event->string[0];
573     else
574         keyval = -1;
575
576     if (keyval >= 0 &&
577         !midend_process_key(fe->me, 0, 0, keyval))
578         gtk_widget_destroy(fe->window);
579
580     return TRUE;
581 }
582
583 static gint button_event(GtkWidget *widget, GdkEventButton *event,
584                          gpointer data)
585 {
586     frontend *fe = (frontend *)data;
587     int button;
588
589     if (!fe->pixmap)
590         return TRUE;
591
592     if (event->type != GDK_BUTTON_PRESS && event->type != GDK_BUTTON_RELEASE)
593         return TRUE;
594
595     if (event->button == 2 || (event->state & GDK_SHIFT_MASK))
596         button = MIDDLE_BUTTON;
597     else if (event->button == 3 || (event->state & GDK_MOD1_MASK))
598         button = RIGHT_BUTTON;
599     else if (event->button == 1)
600         button = LEFT_BUTTON;
601     else
602         return FALSE;                  /* don't even know what button! */
603
604     if (event->type == GDK_BUTTON_RELEASE)
605         button += LEFT_RELEASE - LEFT_BUTTON;
606
607     if (!midend_process_key(fe->me, event->x - fe->ox,
608                             event->y - fe->oy, button))
609         gtk_widget_destroy(fe->window);
610
611     return TRUE;
612 }
613
614 static gint motion_event(GtkWidget *widget, GdkEventMotion *event,
615                          gpointer data)
616 {
617     frontend *fe = (frontend *)data;
618     int button;
619
620     if (!fe->pixmap)
621         return TRUE;
622
623     if (event->state & (GDK_BUTTON2_MASK | GDK_SHIFT_MASK))
624         button = MIDDLE_DRAG;
625     else if (event->state & GDK_BUTTON1_MASK)
626         button = LEFT_DRAG;
627     else if (event->state & GDK_BUTTON3_MASK)
628         button = RIGHT_DRAG;
629     else
630         return FALSE;                  /* don't even know what button! */
631
632     if (!midend_process_key(fe->me, event->x - fe->ox,
633                             event->y - fe->oy, button))
634         gtk_widget_destroy(fe->window);
635
636     return TRUE;
637 }
638
639 static gint expose_area(GtkWidget *widget, GdkEventExpose *event,
640                         gpointer data)
641 {
642     frontend *fe = (frontend *)data;
643
644     if (fe->pixmap) {
645         gdk_draw_pixmap(widget->window,
646                         widget->style->fg_gc[GTK_WIDGET_STATE(widget)],
647                         fe->pixmap,
648                         event->area.x - fe->ox, event->area.y - fe->oy,
649                         event->area.x, event->area.y,
650                         event->area.width, event->area.height);
651     }
652     return TRUE;
653 }
654
655 static gint map_window(GtkWidget *widget, GdkEvent *event,
656                        gpointer data)
657 {
658     frontend *fe = (frontend *)data;
659
660     /*
661      * Apparently we need to do this because otherwise the status
662      * bar will fail to update immediately. Annoying, but there we
663      * go.
664      */
665     gtk_widget_queue_draw(fe->window);
666
667     return TRUE;
668 }
669
670 static gint configure_area(GtkWidget *widget,
671                            GdkEventConfigure *event, gpointer data)
672 {
673     frontend *fe = (frontend *)data;
674     GdkGC *gc;
675     int x, y;
676
677     if (fe->pixmap)
678         gdk_pixmap_unref(fe->pixmap);
679
680     x = fe->w = event->width;
681     y = fe->h = event->height;
682     midend_size(fe->me, &x, &y, TRUE);
683     fe->pw = x;
684     fe->ph = y;
685     fe->ox = (fe->w - fe->pw) / 2;
686     fe->oy = (fe->h - fe->ph) / 2;
687
688     fe->pixmap = gdk_pixmap_new(widget->window, fe->pw, fe->ph, -1);
689
690     gc = gdk_gc_new(fe->area->window);
691     gdk_gc_set_foreground(gc, &fe->colours[0]);
692     gdk_draw_rectangle(fe->pixmap, gc, 1, 0, 0, fe->pw, fe->ph);
693     gdk_draw_rectangle(widget->window, gc, 1, 0, 0,
694                        event->width, event->height);
695     gdk_gc_unref(gc);
696
697     midend_force_redraw(fe->me);
698
699     return TRUE;
700 }
701
702 static gint timer_func(gpointer data)
703 {
704     frontend *fe = (frontend *)data;
705
706     if (fe->timer_active) {
707         struct timeval now;
708         float elapsed;
709         gettimeofday(&now, NULL);
710         elapsed = ((now.tv_usec - fe->last_time.tv_usec) * 0.000001F +
711                    (now.tv_sec - fe->last_time.tv_sec));
712         midend_timer(fe->me, elapsed);  /* may clear timer_active */
713         fe->last_time = now;
714     }
715
716     return fe->timer_active;
717 }
718
719 void deactivate_timer(frontend *fe)
720 {
721     if (!fe)
722         return;                        /* can happen due to --generate */
723     if (fe->timer_active)
724         gtk_timeout_remove(fe->timer_id);
725     fe->timer_active = FALSE;
726 }
727
728 void activate_timer(frontend *fe)
729 {
730     if (!fe)
731         return;                        /* can happen due to --generate */
732     if (!fe->timer_active) {
733         fe->timer_id = gtk_timeout_add(20, timer_func, fe);
734         gettimeofday(&fe->last_time, NULL);
735     }
736     fe->timer_active = TRUE;
737 }
738
739 static void window_destroy(GtkWidget *widget, gpointer data)
740 {
741     gtk_main_quit();
742 }
743
744 static void msgbox_button_clicked(GtkButton *button, gpointer data)
745 {
746     GtkWidget *window = GTK_WIDGET(data);
747     int v, *ip;
748
749     ip = (int *)gtk_object_get_data(GTK_OBJECT(window), "user-data");
750     v = GPOINTER_TO_INT(gtk_object_get_data(GTK_OBJECT(button), "user-data"));
751     *ip = v;
752
753     gtk_widget_destroy(GTK_WIDGET(data));
754 }
755
756 static int win_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
757 {
758     GtkObject *cancelbutton = GTK_OBJECT(data);
759
760     /*
761      * `Escape' effectively clicks the cancel button
762      */
763     if (event->keyval == GDK_Escape) {
764         gtk_signal_emit_by_name(GTK_OBJECT(cancelbutton), "clicked");
765         return TRUE;
766     }
767
768     return FALSE;
769 }
770
771 enum { MB_OK, MB_YESNO };
772
773 int message_box(GtkWidget *parent, char *title, char *msg, int centre,
774                 int type)
775 {
776     GtkWidget *window, *hbox, *text, *button;
777     char *titles;
778     int i, def, cancel;
779
780     window = gtk_dialog_new();
781     text = gtk_label_new(msg);
782     gtk_misc_set_alignment(GTK_MISC(text), 0.0, 0.0);
783     hbox = gtk_hbox_new(FALSE, 0);
784     gtk_box_pack_start(GTK_BOX(hbox), text, FALSE, FALSE, 20);
785     gtk_box_pack_start(GTK_BOX(GTK_DIALOG(window)->vbox),
786                        hbox, FALSE, FALSE, 20);
787     gtk_widget_show(text);
788     gtk_widget_show(hbox);
789     gtk_window_set_title(GTK_WINDOW(window), title);
790     gtk_label_set_line_wrap(GTK_LABEL(text), TRUE);
791
792     if (type == MB_OK) {
793         titles = "OK\0";
794         def = cancel = 0;
795     } else {
796         assert(type == MB_YESNO);
797         titles = "Yes\0No\0";
798         def = 0;
799         cancel = 1;
800     }
801     i = 0;
802     
803     while (*titles) {
804         button = gtk_button_new_with_label(titles);
805         gtk_box_pack_end(GTK_BOX(GTK_DIALOG(window)->action_area),
806                          button, FALSE, FALSE, 0);
807         gtk_widget_show(button);
808         if (i == def) {
809             GTK_WIDGET_SET_FLAGS(button, GTK_CAN_DEFAULT);
810             gtk_window_set_default(GTK_WINDOW(window), button);
811         }
812         if (i == cancel) {
813             gtk_signal_connect(GTK_OBJECT(window), "key_press_event",
814                                GTK_SIGNAL_FUNC(win_key_press), button);
815         }
816         gtk_signal_connect(GTK_OBJECT(button), "clicked",
817                            GTK_SIGNAL_FUNC(msgbox_button_clicked), window);
818         gtk_object_set_data(GTK_OBJECT(button), "user-data",
819                             GINT_TO_POINTER(i));
820         titles += strlen(titles)+1;
821         i++;
822     }
823     gtk_object_set_data(GTK_OBJECT(window), "user-data",
824                         GINT_TO_POINTER(&i));
825     gtk_signal_connect(GTK_OBJECT(window), "destroy",
826                        GTK_SIGNAL_FUNC(window_destroy), NULL);
827     gtk_window_set_modal(GTK_WINDOW(window), TRUE);
828     gtk_window_set_transient_for(GTK_WINDOW(window), GTK_WINDOW(parent));
829     /* set_transient_window_pos(parent, window); */
830     gtk_widget_show(window);
831     i = -1;
832     gtk_main();
833     return (type == MB_YESNO ? i == 0 : TRUE);
834 }
835
836 void error_box(GtkWidget *parent, char *msg)
837 {
838     message_box(parent, "Error", msg, FALSE, MB_OK);
839 }
840
841 static void config_ok_button_clicked(GtkButton *button, gpointer data)
842 {
843     frontend *fe = (frontend *)data;
844     char *err;
845
846     err = midend_set_config(fe->me, fe->cfg_which, fe->cfg);
847
848     if (err)
849         error_box(fe->cfgbox, err);
850     else {
851         fe->cfgret = TRUE;
852         gtk_widget_destroy(fe->cfgbox);
853         changed_preset(fe);
854     }
855 }
856
857 static void config_cancel_button_clicked(GtkButton *button, gpointer data)
858 {
859     frontend *fe = (frontend *)data;
860
861     gtk_widget_destroy(fe->cfgbox);
862 }
863
864 static int editbox_key(GtkWidget *widget, GdkEventKey *event, gpointer data)
865 {
866     /*
867      * GtkEntry has a nasty habit of eating the Return key, which
868      * is unhelpful since it doesn't actually _do_ anything with it
869      * (it calls gtk_widget_activate, but our edit boxes never need
870      * activating). So I catch Return before GtkEntry sees it, and
871      * pass it straight on to the parent widget. Effect: hitting
872      * Return in an edit box will now activate the default button
873      * in the dialog just like it will everywhere else.
874      */
875     if (event->keyval == GDK_Return && widget->parent != NULL) {
876         gint return_val;
877         gtk_signal_emit_stop_by_name(GTK_OBJECT(widget), "key_press_event");
878         gtk_signal_emit_by_name(GTK_OBJECT(widget->parent), "key_press_event",
879                                 event, &return_val);
880         return return_val;
881     }
882     return FALSE;
883 }
884
885 static void editbox_changed(GtkEditable *ed, gpointer data)
886 {
887     config_item *i = (config_item *)data;
888
889     sfree(i->sval);
890     i->sval = dupstr(gtk_entry_get_text(GTK_ENTRY(ed)));
891 }
892
893 static void button_toggled(GtkToggleButton *tb, gpointer data)
894 {
895     config_item *i = (config_item *)data;
896
897     i->ival = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(tb));
898 }
899
900 static void droplist_sel(GtkMenuItem *item, gpointer data)
901 {
902     config_item *i = (config_item *)data;
903
904     i->ival = GPOINTER_TO_INT(gtk_object_get_data(GTK_OBJECT(item),
905                                                   "user-data"));
906 }
907
908 static int get_config(frontend *fe, int which)
909 {
910     GtkWidget *w, *table, *cancel;
911     char *title;
912     config_item *i;
913     int y;
914
915     fe->cfg = midend_get_config(fe->me, which, &title);
916     fe->cfg_which = which;
917     fe->cfgret = FALSE;
918
919     fe->cfgbox = gtk_dialog_new();
920     gtk_window_set_title(GTK_WINDOW(fe->cfgbox), title);
921     sfree(title);
922
923     w = gtk_button_new_with_label("OK");
924     gtk_box_pack_end(GTK_BOX(GTK_DIALOG(fe->cfgbox)->action_area),
925                      w, FALSE, FALSE, 0);
926     gtk_widget_show(w);
927     GTK_WIDGET_SET_FLAGS(w, GTK_CAN_DEFAULT);
928     gtk_window_set_default(GTK_WINDOW(fe->cfgbox), w);
929     gtk_signal_connect(GTK_OBJECT(w), "clicked",
930                        GTK_SIGNAL_FUNC(config_ok_button_clicked), fe);
931
932     w = gtk_button_new_with_label("Cancel");
933     gtk_box_pack_end(GTK_BOX(GTK_DIALOG(fe->cfgbox)->action_area),
934                      w, FALSE, FALSE, 0);
935     gtk_widget_show(w);
936     gtk_signal_connect(GTK_OBJECT(w), "clicked",
937                        GTK_SIGNAL_FUNC(config_cancel_button_clicked), fe);
938     cancel = w;
939
940     table = gtk_table_new(1, 2, FALSE);
941     y = 0;
942     gtk_box_pack_end(GTK_BOX(GTK_DIALOG(fe->cfgbox)->vbox),
943                      table, FALSE, FALSE, 0);
944     gtk_widget_show(table);
945
946     for (i = fe->cfg; i->type != C_END; i++) {
947         gtk_table_resize(GTK_TABLE(table), y+1, 2);
948
949         switch (i->type) {
950           case C_STRING:
951             /*
952              * Edit box with a label beside it.
953              */
954
955             w = gtk_label_new(i->name);
956             gtk_misc_set_alignment(GTK_MISC(w), 0.0, 0.5);
957             gtk_table_attach(GTK_TABLE(table), w, 0, 1, y, y+1,
958                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
959                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
960                              3, 3);
961             gtk_widget_show(w);
962
963             w = gtk_entry_new();
964             gtk_table_attach(GTK_TABLE(table), w, 1, 2, y, y+1,
965                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
966                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
967                              3, 3);
968             gtk_entry_set_text(GTK_ENTRY(w), i->sval);
969             gtk_signal_connect(GTK_OBJECT(w), "changed",
970                                GTK_SIGNAL_FUNC(editbox_changed), i);
971             gtk_signal_connect(GTK_OBJECT(w), "key_press_event",
972                                GTK_SIGNAL_FUNC(editbox_key), NULL);
973             gtk_widget_show(w);
974
975             break;
976
977           case C_BOOLEAN:
978             /*
979              * Simple checkbox.
980              */
981             w = gtk_check_button_new_with_label(i->name);
982             gtk_signal_connect(GTK_OBJECT(w), "toggled",
983                                GTK_SIGNAL_FUNC(button_toggled), i);
984             gtk_table_attach(GTK_TABLE(table), w, 0, 2, y, y+1,
985                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
986                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
987                              3, 3);
988             gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(w), i->ival);
989             gtk_widget_show(w);
990             break;
991
992           case C_CHOICES:
993             /*
994              * Drop-down list (GtkOptionMenu).
995              */
996
997             w = gtk_label_new(i->name);
998             gtk_misc_set_alignment(GTK_MISC(w), 0.0, 0.5);
999             gtk_table_attach(GTK_TABLE(table), w, 0, 1, y, y+1,
1000                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1001                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1002                              3, 3);
1003             gtk_widget_show(w);
1004
1005             w = gtk_option_menu_new();
1006             gtk_table_attach(GTK_TABLE(table), w, 1, 2, y, y+1,
1007                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1008                              GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1009                              3, 3);
1010             gtk_widget_show(w);
1011
1012             {
1013                 int c, val;
1014                 char *p, *q, *name;
1015                 GtkWidget *menuitem;
1016                 GtkWidget *menu = gtk_menu_new();
1017
1018                 gtk_option_menu_set_menu(GTK_OPTION_MENU(w), menu);
1019
1020                 c = *i->sval;
1021                 p = i->sval+1;
1022                 val = 0;
1023
1024                 while (*p) {
1025                     q = p;
1026                     while (*q && *q != c)
1027                         q++;
1028
1029                     name = snewn(q-p+1, char);
1030                     strncpy(name, p, q-p);
1031                     name[q-p] = '\0';
1032
1033                     if (*q) q++;       /* eat delimiter */
1034
1035                     menuitem = gtk_menu_item_new_with_label(name);
1036                     gtk_container_add(GTK_CONTAINER(menu), menuitem);
1037                     gtk_object_set_data(GTK_OBJECT(menuitem), "user-data",
1038                                         GINT_TO_POINTER(val));
1039                     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1040                                        GTK_SIGNAL_FUNC(droplist_sel), i);
1041                     gtk_widget_show(menuitem);
1042
1043                     val++;
1044
1045                     p = q;
1046                 }
1047
1048                 gtk_option_menu_set_history(GTK_OPTION_MENU(w), i->ival);
1049             }
1050
1051             break;
1052         }
1053
1054         y++;
1055     }
1056
1057     gtk_signal_connect(GTK_OBJECT(fe->cfgbox), "destroy",
1058                        GTK_SIGNAL_FUNC(window_destroy), NULL);
1059     gtk_signal_connect(GTK_OBJECT(fe->cfgbox), "key_press_event",
1060                        GTK_SIGNAL_FUNC(win_key_press), cancel);
1061     gtk_window_set_modal(GTK_WINDOW(fe->cfgbox), TRUE);
1062     gtk_window_set_transient_for(GTK_WINDOW(fe->cfgbox),
1063                                  GTK_WINDOW(fe->window));
1064     /* set_transient_window_pos(fe->window, fe->cfgbox); */
1065     gtk_widget_show(fe->cfgbox);
1066     gtk_main();
1067
1068     free_cfg(fe->cfg);
1069
1070     return fe->cfgret;
1071 }
1072
1073 static void menu_key_event(GtkMenuItem *menuitem, gpointer data)
1074 {
1075     frontend *fe = (frontend *)data;
1076     int key = GPOINTER_TO_INT(gtk_object_get_data(GTK_OBJECT(menuitem),
1077                                                   "user-data"));
1078     if (!midend_process_key(fe->me, 0, 0, key))
1079         gtk_widget_destroy(fe->window);
1080 }
1081
1082 static void get_size(frontend *fe, int *px, int *py)
1083 {
1084     int x, y;
1085
1086     /*
1087      * Currently I don't want to make the GTK port scale large
1088      * puzzles to fit on the screen. This is because X does permit
1089      * extremely large windows and many window managers provide a
1090      * means of navigating round them, and the users I consulted
1091      * before deciding said that they'd rather have enormous puzzle
1092      * windows spanning multiple screen pages than have them
1093      * shrunk. I could change my mind later or introduce
1094      * configurability; this would be the place to do so, by
1095      * replacing the initial values of x and y with the screen
1096      * dimensions.
1097      */
1098     x = INT_MAX;
1099     y = INT_MAX;
1100     midend_size(fe->me, &x, &y, FALSE);
1101     *px = x;
1102     *py = y;
1103 }
1104
1105 #if !GTK_CHECK_VERSION(2,0,0)
1106 #define gtk_window_resize(win, x, y) \
1107         gdk_window_resize(GTK_WIDGET(win)->window, x, y)
1108 #endif
1109
1110 static void update_menuitem_bullet(GtkWidget *label, int visible)
1111 {
1112     if (visible) {
1113         gtk_label_set_text(GTK_LABEL(label), "\xE2\x80\xA2");
1114     } else {
1115         gtk_label_set_text(GTK_LABEL(label), "");
1116     }
1117 }
1118
1119 /*
1120  * Called when any other code in this file has changed the
1121  * selected game parameters.
1122  */
1123 static void changed_preset(frontend *fe)
1124 {
1125     int n = midend_which_preset(fe->me);
1126     int i;
1127
1128     /*
1129      * Update the tick mark in the Type menu.
1130      */
1131     if (fe->preset_bullets) {
1132         for (i = 0; i < fe->npresets; i++)
1133             update_menuitem_bullet(fe->preset_bullets[i], n == i);
1134     }
1135     if (fe->preset_custom_bullet) {
1136         update_menuitem_bullet(fe->preset_custom_bullet, n < 0);
1137     }
1138
1139     /*
1140      * Update the greying on the Copy menu option.
1141      */
1142     if (fe->copy_menu_item) {
1143         int enabled = midend_can_format_as_text_now(fe->me);
1144         gtk_widget_set_sensitive(fe->copy_menu_item, enabled);
1145     }
1146 }
1147
1148 static void resize_fe(frontend *fe)
1149 {
1150     int x, y;
1151
1152     get_size(fe, &x, &y);
1153     fe->w = x;
1154     fe->h = y;
1155     gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), x, y);
1156     {
1157         GtkRequisition req;
1158         gtk_widget_size_request(GTK_WIDGET(fe->window), &req);
1159         gtk_window_resize(GTK_WINDOW(fe->window), req.width, req.height);
1160     }
1161     /*
1162      * Now that we've established the preferred size of the window,
1163      * reduce the drawing area's size request so the user can shrink
1164      * the window.
1165      */
1166     gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), 1, 1);
1167 }
1168
1169 static void menu_preset_event(GtkMenuItem *menuitem, gpointer data)
1170 {
1171     frontend *fe = (frontend *)data;
1172     game_params *params =
1173         (game_params *)gtk_object_get_data(GTK_OBJECT(menuitem), "user-data");
1174
1175     midend_set_params(fe->me, params);
1176     midend_new_game(fe->me);
1177     changed_preset(fe);
1178     resize_fe(fe);
1179 }
1180
1181 GdkAtom compound_text_atom, utf8_string_atom;
1182 int paste_initialised = FALSE;
1183
1184 void init_paste()
1185 {
1186     unsigned char empty[] = { 0 };
1187
1188     if (paste_initialised)
1189         return;
1190
1191     if (!compound_text_atom)
1192         compound_text_atom = gdk_atom_intern("COMPOUND_TEXT", FALSE);
1193     if (!utf8_string_atom)
1194         utf8_string_atom = gdk_atom_intern("UTF8_STRING", FALSE);
1195
1196     /*
1197      * Ensure that all the cut buffers exist - according to the
1198      * ICCCM, we must do this before we start using cut buffers.
1199      */
1200     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1201                     XA_CUT_BUFFER0, XA_STRING, 8, PropModeAppend, empty, 0);
1202     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1203                     XA_CUT_BUFFER1, XA_STRING, 8, PropModeAppend, empty, 0);
1204     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1205                     XA_CUT_BUFFER2, XA_STRING, 8, PropModeAppend, empty, 0);
1206     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1207                     XA_CUT_BUFFER3, XA_STRING, 8, PropModeAppend, empty, 0);
1208     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1209                     XA_CUT_BUFFER4, XA_STRING, 8, PropModeAppend, empty, 0);
1210     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1211                     XA_CUT_BUFFER5, XA_STRING, 8, PropModeAppend, empty, 0);
1212     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1213                     XA_CUT_BUFFER6, XA_STRING, 8, PropModeAppend, empty, 0);
1214     XChangeProperty(GDK_DISPLAY(), GDK_ROOT_WINDOW(),
1215                     XA_CUT_BUFFER7, XA_STRING, 8, PropModeAppend, empty, 0);
1216 }
1217
1218 /* Store data in a cut-buffer. */
1219 void store_cutbuffer(char *ptr, int len)
1220 {
1221     /* ICCCM says we must rotate the buffers before storing to buffer 0. */
1222     XRotateBuffers(GDK_DISPLAY(), 1);
1223     XStoreBytes(GDK_DISPLAY(), ptr, len);
1224 }
1225
1226 void write_clip(frontend *fe, char *data)
1227 {
1228     init_paste();
1229
1230     if (fe->paste_data)
1231         sfree(fe->paste_data);
1232
1233     /*
1234      * For this simple application we can safely assume that the
1235      * data passed to this function is pure ASCII, which means we
1236      * can return precisely the same stuff for types STRING,
1237      * COMPOUND_TEXT or UTF8_STRING.
1238      */
1239
1240     fe->paste_data = data;
1241     fe->paste_data_len = strlen(data);
1242
1243     store_cutbuffer(fe->paste_data, fe->paste_data_len);
1244
1245     if (gtk_selection_owner_set(fe->area, GDK_SELECTION_PRIMARY,
1246                                 CurrentTime)) {
1247         gtk_selection_add_target(fe->area, GDK_SELECTION_PRIMARY,
1248                                  GDK_SELECTION_TYPE_STRING, 1);
1249         gtk_selection_add_target(fe->area, GDK_SELECTION_PRIMARY,
1250                                  compound_text_atom, 1);
1251         gtk_selection_add_target(fe->area, GDK_SELECTION_PRIMARY,
1252                                  utf8_string_atom, 1);
1253     }
1254 }
1255
1256 void selection_get(GtkWidget *widget, GtkSelectionData *seldata,
1257                    guint info, guint time_stamp, gpointer data)
1258 {
1259     frontend *fe = (frontend *)data;
1260     gtk_selection_data_set(seldata, seldata->target, 8,
1261                            fe->paste_data, fe->paste_data_len);
1262 }
1263
1264 gint selection_clear(GtkWidget *widget, GdkEventSelection *seldata,
1265                      gpointer data)
1266 {
1267     frontend *fe = (frontend *)data;
1268
1269     if (fe->paste_data)
1270         sfree(fe->paste_data);
1271     fe->paste_data = NULL;
1272     fe->paste_data_len = 0;
1273     return TRUE;
1274 }
1275
1276 static void menu_copy_event(GtkMenuItem *menuitem, gpointer data)
1277 {
1278     frontend *fe = (frontend *)data;
1279     char *text;
1280
1281     text = midend_text_format(fe->me);
1282
1283     if (text) {
1284         write_clip(fe, text);
1285     } else {
1286         gdk_beep();
1287     }
1288 }
1289
1290 static void filesel_ok(GtkButton *button, gpointer data)
1291 {
1292     frontend *fe = (frontend *)data;
1293
1294     gpointer filesel = gtk_object_get_data(GTK_OBJECT(button), "user-data");
1295
1296     const char *name =
1297         gtk_file_selection_get_filename(GTK_FILE_SELECTION(filesel));
1298
1299     fe->filesel_name = dupstr(name);
1300 }
1301
1302 static char *file_selector(frontend *fe, char *title, int save)
1303 {
1304     GtkWidget *filesel =
1305         gtk_file_selection_new(title);
1306
1307     fe->filesel_name = NULL;
1308
1309     gtk_window_set_modal(GTK_WINDOW(filesel), TRUE);
1310     gtk_object_set_data
1311         (GTK_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "user-data",
1312          (gpointer)filesel);
1313     gtk_signal_connect
1314         (GTK_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "clicked",
1315          GTK_SIGNAL_FUNC(filesel_ok), fe);
1316     gtk_signal_connect_object
1317         (GTK_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "clicked",
1318          GTK_SIGNAL_FUNC(gtk_widget_destroy), (gpointer)filesel);
1319     gtk_signal_connect_object
1320         (GTK_OBJECT(GTK_FILE_SELECTION(filesel)->cancel_button), "clicked",
1321          GTK_SIGNAL_FUNC(gtk_widget_destroy), (gpointer)filesel);
1322     gtk_signal_connect(GTK_OBJECT(filesel), "destroy",
1323                        GTK_SIGNAL_FUNC(window_destroy), NULL);
1324     gtk_widget_show(filesel);
1325     gtk_window_set_transient_for(GTK_WINDOW(filesel), GTK_WINDOW(fe->window));
1326     gtk_main();
1327
1328     return fe->filesel_name;
1329 }
1330
1331 struct savefile_write_ctx {
1332     FILE *fp;
1333     int error;
1334 };
1335
1336 static void savefile_write(void *wctx, void *buf, int len)
1337 {
1338     struct savefile_write_ctx *ctx = (struct savefile_write_ctx *)wctx;
1339     if (fwrite(buf, 1, len, ctx->fp) < len)
1340         ctx->error = errno;
1341 }
1342
1343 static int savefile_read(void *wctx, void *buf, int len)
1344 {
1345     FILE *fp = (FILE *)wctx;
1346     int ret;
1347
1348     ret = fread(buf, 1, len, fp);
1349     return (ret == len);
1350 }
1351
1352 static void menu_save_event(GtkMenuItem *menuitem, gpointer data)
1353 {
1354     frontend *fe = (frontend *)data;
1355     char *name;
1356
1357     name = file_selector(fe, "Enter name of game file to save", TRUE);
1358
1359     if (name) {
1360         FILE *fp;
1361
1362         if ((fp = fopen(name, "r")) != NULL) {
1363             char buf[256 + FILENAME_MAX];
1364             fclose(fp);
1365             /* file exists */
1366
1367             sprintf(buf, "Are you sure you want to overwrite the"
1368                     " file \"%.*s\"?",
1369                     FILENAME_MAX, name);
1370             if (!message_box(fe->window, "Question", buf, TRUE, MB_YESNO))
1371                 return;
1372         }
1373
1374         fp = fopen(name, "w");
1375         sfree(name);
1376
1377         if (!fp) {
1378             error_box(fe->window, "Unable to open save file");
1379             return;
1380         }
1381
1382         {
1383             struct savefile_write_ctx ctx;
1384             ctx.fp = fp;
1385             ctx.error = 0;
1386             midend_serialise(fe->me, savefile_write, &ctx);
1387             fclose(fp);
1388             if (ctx.error) {
1389                 char boxmsg[512];
1390                 sprintf(boxmsg, "Error writing save file: %.400s",
1391                         strerror(errno));
1392                 error_box(fe->window, boxmsg);
1393                 return;
1394             }
1395         }
1396
1397     }
1398 }
1399
1400 static void menu_load_event(GtkMenuItem *menuitem, gpointer data)
1401 {
1402     frontend *fe = (frontend *)data;
1403     char *name, *err;
1404
1405     name = file_selector(fe, "Enter name of saved game file to load", FALSE);
1406
1407     if (name) {
1408         FILE *fp = fopen(name, "r");
1409         sfree(name);
1410
1411         if (!fp) {
1412             error_box(fe->window, "Unable to open saved game file");
1413             return;
1414         }
1415
1416         err = midend_deserialise(fe->me, savefile_read, fp);
1417
1418         fclose(fp);
1419
1420         if (err) {
1421             error_box(fe->window, err);
1422             return;
1423         }
1424
1425         changed_preset(fe);
1426         resize_fe(fe);
1427     }
1428 }
1429
1430 static void menu_solve_event(GtkMenuItem *menuitem, gpointer data)
1431 {
1432     frontend *fe = (frontend *)data;
1433     char *msg;
1434
1435     msg = midend_solve(fe->me);
1436
1437     if (msg)
1438         error_box(fe->window, msg);
1439 }
1440
1441 static void menu_restart_event(GtkMenuItem *menuitem, gpointer data)
1442 {
1443     frontend *fe = (frontend *)data;
1444
1445     midend_restart_game(fe->me);
1446 }
1447
1448 static void menu_config_event(GtkMenuItem *menuitem, gpointer data)
1449 {
1450     frontend *fe = (frontend *)data;
1451     int which = GPOINTER_TO_INT(gtk_object_get_data(GTK_OBJECT(menuitem),
1452                                                     "user-data"));
1453
1454     if (!get_config(fe, which))
1455         return;
1456
1457     midend_new_game(fe->me);
1458     resize_fe(fe);
1459 }
1460
1461 static void menu_about_event(GtkMenuItem *menuitem, gpointer data)
1462 {
1463     frontend *fe = (frontend *)data;
1464     char titlebuf[256];
1465     char textbuf[1024];
1466
1467     sprintf(titlebuf, "About %.200s", thegame.name);
1468     sprintf(textbuf,
1469             "%.200s\n\n"
1470             "from Simon Tatham's Portable Puzzle Collection\n\n"
1471             "%.500s", thegame.name, ver);
1472
1473     message_box(fe->window, titlebuf, textbuf, TRUE, MB_OK);
1474 }
1475
1476 static GtkWidget *add_menu_item_with_key(frontend *fe, GtkContainer *cont,
1477                                          char *text, int key)
1478 {
1479     GtkWidget *menuitem = gtk_menu_item_new_with_label(text);
1480     int keyqual;
1481     gtk_container_add(cont, menuitem);
1482     gtk_object_set_data(GTK_OBJECT(menuitem), "user-data",
1483                         GINT_TO_POINTER(key));
1484     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1485                        GTK_SIGNAL_FUNC(menu_key_event), fe);
1486     switch (key & ~0x1F) {
1487       case 0x00:
1488         key += 0x60;
1489         keyqual = GDK_CONTROL_MASK;
1490         break;
1491       case 0x40:
1492         key += 0x20;
1493         keyqual = GDK_SHIFT_MASK;
1494         break;
1495       default:
1496         keyqual = 0;
1497         break;
1498     }
1499     gtk_widget_add_accelerator(menuitem,
1500                                "activate", fe->accelgroup,
1501                                key, keyqual,
1502                                GTK_ACCEL_VISIBLE);
1503     gtk_widget_show(menuitem);
1504     return menuitem;
1505 }
1506
1507 static void add_menu_separator(GtkContainer *cont)
1508 {
1509     GtkWidget *menuitem = gtk_menu_item_new();
1510     gtk_container_add(cont, menuitem);
1511     gtk_widget_show(menuitem);
1512 }
1513
1514 enum { ARG_EITHER, ARG_SAVE, ARG_ID }; /* for argtype */
1515
1516 static GtkWidget *make_preset_menuitem(GtkWidget **bulletlabel,
1517                                        const char *name)
1518 {
1519     GtkWidget *hbox, *lab1, *lab2, *menuitem;
1520     GtkRequisition req;
1521
1522     hbox = gtk_hbox_new(FALSE, 0);
1523     gtk_widget_show(hbox);
1524     lab1 = gtk_label_new("\xE2\x80\xA2 ");
1525     gtk_widget_show(lab1);
1526     gtk_box_pack_start(GTK_BOX(hbox), lab1, FALSE, FALSE, 0);
1527     gtk_misc_set_alignment(GTK_MISC(lab1), 0.0, 0.0);
1528     lab2 = gtk_label_new(name);
1529     gtk_widget_show(lab2);
1530     gtk_box_pack_start(GTK_BOX(hbox), lab2, TRUE, TRUE, 0);
1531     gtk_misc_set_alignment(GTK_MISC(lab2), 0.0, 0.0);
1532
1533     gtk_widget_size_request(lab1, &req);
1534     gtk_widget_set_usize(lab1, req.width, -1);
1535     gtk_label_set_text(GTK_LABEL(lab1), "");
1536
1537     menuitem = gtk_menu_item_new();
1538     gtk_container_add(GTK_CONTAINER(menuitem), hbox);
1539
1540     *bulletlabel = lab1;
1541     return menuitem;
1542 }
1543
1544 static frontend *new_window(char *arg, int argtype, char **error)
1545 {
1546     frontend *fe;
1547     GtkBox *vbox;
1548     GtkWidget *menubar, *menu, *menuitem;
1549     GdkPixmap *iconpm;
1550     GList *iconlist;
1551     int x, y, n;
1552     char errbuf[1024];
1553     extern char *const *const xpm_icons[];
1554     extern const int n_xpm_icons;
1555
1556     fe = snew(frontend);
1557
1558     fe->timer_active = FALSE;
1559     fe->timer_id = -1;
1560
1561     fe->me = midend_new(fe, &thegame, &gtk_drawing, fe);
1562
1563     if (arg) {
1564         char *err;
1565         FILE *fp;
1566
1567         errbuf[0] = '\0';
1568
1569         switch (argtype) {
1570           case ARG_ID:
1571             err = midend_game_id(fe->me, arg);
1572             if (!err)
1573                 midend_new_game(fe->me);
1574             else
1575                 sprintf(errbuf, "Invalid game ID: %.800s", err);
1576             break;
1577           case ARG_SAVE:
1578             fp = fopen(arg, "r");
1579             if (!fp) {
1580                 sprintf(errbuf, "Error opening file: %.800s", strerror(errno));
1581             } else {
1582                 err = midend_deserialise(fe->me, savefile_read, fp);
1583                 if (err)
1584                     sprintf(errbuf, "Invalid save file: %.800s", err);
1585                 fclose(fp);
1586             }
1587             break;
1588           default /*case ARG_EITHER*/:
1589             /*
1590              * First try treating the argument as a game ID.
1591              */
1592             err = midend_game_id(fe->me, arg);
1593             if (!err) {
1594                 /*
1595                  * It's a valid game ID.
1596                  */
1597                 midend_new_game(fe->me);
1598             } else {
1599                 FILE *fp = fopen(arg, "r");
1600                 if (!fp) {
1601                     sprintf(errbuf, "Supplied argument is neither a game ID (%.400s)"
1602                             " nor a save file (%.400s)", err, strerror(errno));
1603                 } else {
1604                     err = midend_deserialise(fe->me, savefile_read, fp);
1605                     if (err)
1606                         sprintf(errbuf, "%.800s", err);
1607                     fclose(fp);
1608                 }
1609             }
1610             break;
1611         }
1612         if (*errbuf) {
1613             *error = dupstr(errbuf);
1614             midend_free(fe->me);
1615             sfree(fe);
1616             return NULL;
1617         }
1618
1619     } else {
1620         midend_new_game(fe->me);
1621     }
1622
1623     fe->window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
1624     gtk_window_set_title(GTK_WINDOW(fe->window), thegame.name);
1625
1626     vbox = GTK_BOX(gtk_vbox_new(FALSE, 0));
1627     gtk_container_add(GTK_CONTAINER(fe->window), GTK_WIDGET(vbox));
1628     gtk_widget_show(GTK_WIDGET(vbox));
1629
1630     fe->accelgroup = gtk_accel_group_new();
1631     gtk_window_add_accel_group(GTK_WINDOW(fe->window), fe->accelgroup);
1632
1633     menubar = gtk_menu_bar_new();
1634     gtk_box_pack_start(vbox, menubar, FALSE, FALSE, 0);
1635     gtk_widget_show(menubar);
1636
1637     menuitem = gtk_menu_item_new_with_label("Game");
1638     gtk_container_add(GTK_CONTAINER(menubar), menuitem);
1639     gtk_widget_show(menuitem);
1640
1641     menu = gtk_menu_new();
1642     gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), menu);
1643
1644     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "New", 'n');
1645
1646     menuitem = gtk_menu_item_new_with_label("Restart");
1647     gtk_container_add(GTK_CONTAINER(menu), menuitem);
1648     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1649                        GTK_SIGNAL_FUNC(menu_restart_event), fe);
1650     gtk_widget_show(menuitem);
1651
1652     menuitem = gtk_menu_item_new_with_label("Specific...");
1653     gtk_object_set_data(GTK_OBJECT(menuitem), "user-data",
1654                         GINT_TO_POINTER(CFG_DESC));
1655     gtk_container_add(GTK_CONTAINER(menu), menuitem);
1656     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1657                        GTK_SIGNAL_FUNC(menu_config_event), fe);
1658     gtk_widget_show(menuitem);
1659
1660     menuitem = gtk_menu_item_new_with_label("Random Seed...");
1661     gtk_object_set_data(GTK_OBJECT(menuitem), "user-data",
1662                         GINT_TO_POINTER(CFG_SEED));
1663     gtk_container_add(GTK_CONTAINER(menu), menuitem);
1664     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1665                        GTK_SIGNAL_FUNC(menu_config_event), fe);
1666     gtk_widget_show(menuitem);
1667
1668     if ((n = midend_num_presets(fe->me)) > 0 || thegame.can_configure) {
1669         GtkWidget *submenu;
1670         int i;
1671
1672         menuitem = gtk_menu_item_new_with_label("Type");
1673         gtk_container_add(GTK_CONTAINER(menubar), menuitem);
1674         gtk_widget_show(menuitem);
1675
1676         submenu = gtk_menu_new();
1677         gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), submenu);
1678
1679         fe->npresets = n;
1680         fe->preset_bullets = snewn(n, GtkWidget *);
1681
1682         for (i = 0; i < n; i++) {
1683             char *name;
1684             game_params *params;
1685
1686             midend_fetch_preset(fe->me, i, &name, &params);
1687
1688             menuitem = make_preset_menuitem(&fe->preset_bullets[i], name);
1689
1690             gtk_container_add(GTK_CONTAINER(submenu), menuitem);
1691             gtk_object_set_data(GTK_OBJECT(menuitem), "user-data", params);
1692             gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1693                                GTK_SIGNAL_FUNC(menu_preset_event), fe);
1694             gtk_widget_show(menuitem);
1695         }
1696
1697         if (thegame.can_configure) {
1698             menuitem = make_preset_menuitem(&fe->preset_custom_bullet,
1699                                             "Custom...");
1700
1701             gtk_container_add(GTK_CONTAINER(submenu), menuitem);
1702             gtk_object_set_data(GTK_OBJECT(menuitem), "user-data",
1703                                 GPOINTER_TO_INT(CFG_SETTINGS));
1704             gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1705                                GTK_SIGNAL_FUNC(menu_config_event), fe);
1706             gtk_widget_show(menuitem);
1707         } else
1708             fe->preset_custom_bullet = NULL;
1709
1710     } else {
1711         fe->npresets = 0;
1712         fe->preset_bullets = NULL;
1713         fe->preset_custom_bullet = NULL;
1714     }
1715
1716     add_menu_separator(GTK_CONTAINER(menu));
1717     menuitem = gtk_menu_item_new_with_label("Load...");
1718     gtk_container_add(GTK_CONTAINER(menu), menuitem);
1719     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1720                        GTK_SIGNAL_FUNC(menu_load_event), fe);
1721     gtk_widget_show(menuitem);
1722     menuitem = gtk_menu_item_new_with_label("Save...");
1723     gtk_container_add(GTK_CONTAINER(menu), menuitem);
1724     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1725                        GTK_SIGNAL_FUNC(menu_save_event), fe);
1726     gtk_widget_show(menuitem);
1727     add_menu_separator(GTK_CONTAINER(menu));
1728     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Undo", 'u');
1729     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Redo", 'r');
1730     if (thegame.can_format_as_text_ever) {
1731         add_menu_separator(GTK_CONTAINER(menu));
1732         menuitem = gtk_menu_item_new_with_label("Copy");
1733         gtk_container_add(GTK_CONTAINER(menu), menuitem);
1734         gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1735                            GTK_SIGNAL_FUNC(menu_copy_event), fe);
1736         gtk_widget_show(menuitem);
1737         fe->copy_menu_item = menuitem;
1738     } else {
1739         fe->copy_menu_item = NULL;
1740     }
1741     if (thegame.can_solve) {
1742         add_menu_separator(GTK_CONTAINER(menu));
1743         menuitem = gtk_menu_item_new_with_label("Solve");
1744         gtk_container_add(GTK_CONTAINER(menu), menuitem);
1745         gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1746                            GTK_SIGNAL_FUNC(menu_solve_event), fe);
1747         gtk_widget_show(menuitem);
1748     }
1749     add_menu_separator(GTK_CONTAINER(menu));
1750     add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Exit", 'q');
1751
1752     menuitem = gtk_menu_item_new_with_label("Help");
1753     gtk_container_add(GTK_CONTAINER(menubar), menuitem);
1754     gtk_widget_show(menuitem);
1755
1756     menu = gtk_menu_new();
1757     gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), menu);
1758
1759     menuitem = gtk_menu_item_new_with_label("About");
1760     gtk_container_add(GTK_CONTAINER(menu), menuitem);
1761     gtk_signal_connect(GTK_OBJECT(menuitem), "activate",
1762                        GTK_SIGNAL_FUNC(menu_about_event), fe);
1763     gtk_widget_show(menuitem);
1764
1765     changed_preset(fe);
1766
1767     {
1768         int i, ncolours;
1769         float *colours;
1770         gboolean *success;
1771
1772         fe->colmap = gdk_colormap_get_system();
1773         colours = midend_colours(fe->me, &ncolours);
1774         fe->ncolours = ncolours;
1775         fe->colours = snewn(ncolours, GdkColor);
1776         for (i = 0; i < ncolours; i++) {
1777             fe->colours[i].red = colours[i*3] * 0xFFFF;
1778             fe->colours[i].green = colours[i*3+1] * 0xFFFF;
1779             fe->colours[i].blue = colours[i*3+2] * 0xFFFF;
1780         }
1781         success = snewn(ncolours, gboolean);
1782         gdk_colormap_alloc_colors(fe->colmap, fe->colours, ncolours,
1783                                   FALSE, FALSE, success);
1784         for (i = 0; i < ncolours; i++) {
1785             if (!success[i]) {
1786                 g_error("couldn't allocate colour %d (#%02x%02x%02x)\n",
1787                         i, fe->colours[i].red >> 8,
1788                         fe->colours[i].green >> 8,
1789                         fe->colours[i].blue >> 8);
1790             }
1791         }
1792     }
1793
1794     if (midend_wants_statusbar(fe->me)) {
1795         GtkWidget *viewport;
1796         GtkRequisition req;
1797
1798         viewport = gtk_viewport_new(NULL, NULL);
1799         gtk_viewport_set_shadow_type(GTK_VIEWPORT(viewport), GTK_SHADOW_NONE);
1800         fe->statusbar = gtk_statusbar_new();
1801         gtk_container_add(GTK_CONTAINER(viewport), fe->statusbar);
1802         gtk_widget_show(viewport);
1803         gtk_box_pack_end(vbox, viewport, FALSE, FALSE, 0);
1804         gtk_widget_show(fe->statusbar);
1805         fe->statusctx = gtk_statusbar_get_context_id
1806             (GTK_STATUSBAR(fe->statusbar), "game");
1807         gtk_statusbar_push(GTK_STATUSBAR(fe->statusbar), fe->statusctx,
1808                            "test");
1809         gtk_widget_size_request(fe->statusbar, &req);
1810 #if 0
1811         /* For GTK 2.0, should we be using gtk_widget_set_size_request? */
1812 #endif
1813         gtk_widget_set_usize(viewport, -1, req.height);
1814     } else
1815         fe->statusbar = NULL;
1816
1817     fe->area = gtk_drawing_area_new();
1818     get_size(fe, &x, &y);
1819     gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), x, y);
1820     fe->w = x;
1821     fe->h = y;
1822
1823     gtk_box_pack_end(vbox, fe->area, TRUE, TRUE, 0);
1824
1825     fe->pixmap = NULL;
1826     fe->fonts = NULL;
1827     fe->nfonts = fe->fontsize = 0;
1828
1829     fe->paste_data = NULL;
1830     fe->paste_data_len = 0;
1831
1832     gtk_signal_connect(GTK_OBJECT(fe->window), "destroy",
1833                        GTK_SIGNAL_FUNC(destroy), fe);
1834     gtk_signal_connect(GTK_OBJECT(fe->window), "key_press_event",
1835                        GTK_SIGNAL_FUNC(key_event), fe);
1836     gtk_signal_connect(GTK_OBJECT(fe->area), "button_press_event",
1837                        GTK_SIGNAL_FUNC(button_event), fe);
1838     gtk_signal_connect(GTK_OBJECT(fe->area), "button_release_event",
1839                        GTK_SIGNAL_FUNC(button_event), fe);
1840     gtk_signal_connect(GTK_OBJECT(fe->area), "motion_notify_event",
1841                        GTK_SIGNAL_FUNC(motion_event), fe);
1842     gtk_signal_connect(GTK_OBJECT(fe->area), "selection_get",
1843                        GTK_SIGNAL_FUNC(selection_get), fe);
1844     gtk_signal_connect(GTK_OBJECT(fe->area), "selection_clear_event",
1845                        GTK_SIGNAL_FUNC(selection_clear), fe);
1846     gtk_signal_connect(GTK_OBJECT(fe->area), "expose_event",
1847                        GTK_SIGNAL_FUNC(expose_area), fe);
1848     gtk_signal_connect(GTK_OBJECT(fe->window), "map_event",
1849                        GTK_SIGNAL_FUNC(map_window), fe);
1850     gtk_signal_connect(GTK_OBJECT(fe->area), "configure_event",
1851                        GTK_SIGNAL_FUNC(configure_area), fe);
1852
1853     gtk_widget_add_events(GTK_WIDGET(fe->area),
1854                           GDK_BUTTON_PRESS_MASK |
1855                           GDK_BUTTON_RELEASE_MASK |
1856                           GDK_BUTTON_MOTION_MASK);
1857
1858     if (n_xpm_icons) {
1859         gtk_widget_realize(fe->window);
1860         iconpm = gdk_pixmap_create_from_xpm_d(fe->window->window, NULL,
1861                                               NULL, (gchar **)xpm_icons[0]);
1862         gdk_window_set_icon(fe->window->window, NULL, iconpm, NULL);
1863         iconlist = NULL;
1864         for (n = 0; n < n_xpm_icons; n++) {
1865             iconlist =
1866                 g_list_append(iconlist,
1867                               gdk_pixbuf_new_from_xpm_data((const gchar **)
1868                                                            xpm_icons[n]));
1869         }
1870         gdk_window_set_icon_list(fe->window->window, iconlist);
1871     }
1872
1873     gtk_widget_show(fe->area);
1874     gtk_widget_show(fe->window);
1875
1876     /*
1877      * Now that we've established the preferred size of the window,
1878      * reduce the drawing area's size request so the user can shrink
1879      * the window.
1880      */
1881     gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), 1, 1);
1882
1883     gdk_window_set_background(fe->area->window, &fe->colours[0]);
1884     gdk_window_set_background(fe->window->window, &fe->colours[0]);
1885
1886     return fe;
1887 }
1888
1889 char *fgetline(FILE *fp)
1890 {
1891     char *ret = snewn(512, char);
1892     int size = 512, len = 0;
1893     while (fgets(ret + len, size - len, fp)) {
1894         len += strlen(ret + len);
1895         if (ret[len-1] == '\n')
1896             break;                     /* got a newline, we're done */
1897         size = len + 512;
1898         ret = sresize(ret, size, char);
1899     }
1900     if (len == 0) {                    /* first fgets returned NULL */
1901         sfree(ret);
1902         return NULL;
1903     }
1904     ret[len] = '\0';
1905     return ret;
1906 }
1907
1908 int main(int argc, char **argv)
1909 {
1910     char *pname = argv[0];
1911     char *error;
1912     int ngenerate = 0, print = FALSE, px = 1, py = 1;
1913     int soln = FALSE, colour = FALSE;
1914     float scale = 1.0F;
1915     float redo_proportion = 0.0F;
1916     char *savefile = NULL, *savesuffix = NULL;
1917     char *arg = NULL;
1918     int argtype = ARG_EITHER;
1919     char *screenshot_file = NULL;
1920     int doing_opts = TRUE;
1921     int ac = argc;
1922     char **av = argv;
1923     char errbuf[500];
1924
1925     /*
1926      * Command line parsing in this function is rather fiddly,
1927      * because GTK wants to have a go at argc/argv _first_ - and
1928      * yet we can't let it, because gtk_init() will bomb out if it
1929      * can't open an X display, whereas in fact we want to permit
1930      * our --generate and --print modes to run without an X
1931      * display.
1932      * 
1933      * So what we do is:
1934      *  - we parse the command line ourselves, without modifying
1935      *    argc/argv
1936      *  - if we encounter an error which might plausibly be the
1937      *    result of a GTK command line (i.e. not detailed errors in
1938      *    particular options of ours) we store the error message
1939      *    and terminate parsing.
1940      *  - if we got enough out of the command line to know it
1941      *    specifies a non-X mode of operation, we either display
1942      *    the stored error and return failure, or if there is no
1943      *    stored error we do the non-X operation and return
1944      *    success.
1945      *  - otherwise, we go straight to gtk_init().
1946      */
1947
1948     errbuf[0] = '\0';
1949     while (--ac > 0) {
1950         char *p = *++av;
1951         if (doing_opts && !strcmp(p, "--version")) {
1952             printf("%s, from Simon Tatham's Portable Puzzle Collection\n%s\n",
1953                    thegame.name, ver);
1954             return 0;
1955         } else if (doing_opts && !strcmp(p, "--generate")) {
1956             if (--ac > 0) {
1957                 ngenerate = atoi(*++av);
1958                 if (!ngenerate) {
1959                     fprintf(stderr, "%s: '--generate' expected a number\n",
1960                             pname);
1961                     return 1;
1962                 }
1963             } else
1964                 ngenerate = 1;
1965         } else if (doing_opts && !strcmp(p, "--save")) {
1966             if (--ac > 0) {
1967                 savefile = *++av;
1968             } else {
1969                 fprintf(stderr, "%s: '--save' expected a filename\n",
1970                         pname);
1971                 return 1;
1972             }
1973         } else if (doing_opts && (!strcmp(p, "--save-suffix") ||
1974                                   !strcmp(p, "--savesuffix"))) {
1975             if (--ac > 0) {
1976                 savesuffix = *++av;
1977             } else {
1978                 fprintf(stderr, "%s: '--save-suffix' expected a filename\n",
1979                         pname);
1980                 return 1;
1981             }
1982         } else if (doing_opts && !strcmp(p, "--print")) {
1983             if (!thegame.can_print) {
1984                 fprintf(stderr, "%s: this game does not support printing\n",
1985                         pname);
1986                 return 1;
1987             }
1988             print = TRUE;
1989             if (--ac > 0) {
1990                 char *dim = *++av;
1991                 if (sscanf(dim, "%dx%d", &px, &py) != 2) {
1992                     fprintf(stderr, "%s: unable to parse argument '%s' to "
1993                             "'--print'\n", pname, dim);
1994                     return 1;
1995                 }
1996             } else {
1997                 px = py = 1;
1998             }
1999         } else if (doing_opts && !strcmp(p, "--scale")) {
2000             if (--ac > 0) {
2001                 scale = atof(*++av);
2002             } else {
2003                 fprintf(stderr, "%s: no argument supplied to '--scale'\n",
2004                         pname);
2005                 return 1;
2006             }
2007         } else if (doing_opts && !strcmp(p, "--redo")) {
2008             /*
2009              * This is an internal option which I don't expect
2010              * users to have any particular use for. The effect of
2011              * --redo is that once the game has been loaded and
2012              * initialised, the next move in the redo chain is
2013              * replayed, and the game screen is redrawn part way
2014              * through the making of the move. This is only
2015              * meaningful if there _is_ a next move in the redo
2016              * chain, which means in turn that this option is only
2017              * useful if you're also passing a save file on the
2018              * command line.
2019              *
2020              * This option is used by the script which generates
2021              * the puzzle icons and website screenshots, and I
2022              * don't imagine it's useful for anything else.
2023              * (Unless, I suppose, users don't like my screenshots
2024              * and want to generate their own in the same way for
2025              * some repackaged version of the puzzles.)
2026              */
2027             if (--ac > 0) {
2028                 redo_proportion = atof(*++av);
2029             } else {
2030                 fprintf(stderr, "%s: no argument supplied to '--redo'\n",
2031                         pname);
2032                 return 1;
2033             }
2034         } else if (doing_opts && !strcmp(p, "--screenshot")) {
2035             /*
2036              * Another internal option for the icon building
2037              * script. This causes a screenshot of the central
2038              * drawing area (i.e. not including the menu bar or
2039              * status bar) to be saved to a PNG file once the
2040              * window has been drawn, and then the application
2041              * quits immediately.
2042              */
2043             if (--ac > 0) {
2044                 screenshot_file = *++av;
2045             } else {
2046                 fprintf(stderr, "%s: no argument supplied to '--screenshot'\n",
2047                         pname);
2048                 return 1;
2049             }
2050         } else if (doing_opts && (!strcmp(p, "--with-solutions") ||
2051                                   !strcmp(p, "--with-solution") ||
2052                                   !strcmp(p, "--with-solns") ||
2053                                   !strcmp(p, "--with-soln") ||
2054                                   !strcmp(p, "--solutions") ||
2055                                   !strcmp(p, "--solution") ||
2056                                   !strcmp(p, "--solns") ||
2057                                   !strcmp(p, "--soln"))) {
2058             soln = TRUE;
2059         } else if (doing_opts && !strcmp(p, "--colour")) {
2060             if (!thegame.can_print_in_colour) {
2061                 fprintf(stderr, "%s: this game does not support colour"
2062                         " printing\n", pname);
2063                 return 1;
2064             }
2065             colour = TRUE;
2066         } else if (doing_opts && !strcmp(p, "--load")) {
2067             argtype = ARG_SAVE;
2068         } else if (doing_opts && !strcmp(p, "--game")) {
2069             argtype = ARG_ID;
2070         } else if (doing_opts && !strcmp(p, "--")) {
2071             doing_opts = FALSE;
2072         } else if (!doing_opts || p[0] != '-') {
2073             if (arg) {
2074                 fprintf(stderr, "%s: more than one argument supplied\n",
2075                         pname);
2076                 return 1;
2077             }
2078             arg = p;
2079         } else {
2080             sprintf(errbuf, "%.100s: unrecognised option '%.100s'\n",
2081                     pname, p);
2082             break;
2083         }
2084     }
2085
2086     if (*errbuf) {
2087         fputs(errbuf, stderr);
2088         return 1;
2089     }
2090
2091     /*
2092      * Special standalone mode for generating puzzle IDs on the
2093      * command line. Useful for generating puzzles to be printed
2094      * out and solved offline (for puzzles where that even makes
2095      * sense - Solo, for example, is a lot more pencil-and-paper
2096      * friendly than Twiddle!)
2097      * 
2098      * Usage:
2099      * 
2100      *   <puzzle-name> --generate [<n> [<params>]]
2101      * 
2102      * <n>, if present, is the number of puzzle IDs to generate.
2103      * <params>, if present, is the same type of parameter string
2104      * you would pass to the puzzle when running it in GUI mode,
2105      * including optional extras such as the expansion factor in
2106      * Rectangles and the difficulty level in Solo.
2107      * 
2108      * If you specify <params>, you must also specify <n> (although
2109      * you may specify it to be 1). Sorry; that was the
2110      * simplest-to-parse command-line syntax I came up with.
2111      */
2112     if (ngenerate > 0 || print || savefile || savesuffix) {
2113         int i, n = 1;
2114         midend *me;
2115         char *id;
2116         document *doc = NULL;
2117
2118         n = ngenerate;
2119
2120         me = midend_new(NULL, &thegame, NULL, NULL);
2121         i = 0;
2122
2123         if (savefile && !savesuffix)
2124             savesuffix = "";
2125         if (!savefile && savesuffix)
2126             savefile = "";
2127
2128         if (print)
2129             doc = document_new(px, py, scale);
2130
2131         /*
2132          * In this loop, we either generate a game ID or read one
2133          * from stdin depending on whether we're in generate mode;
2134          * then we either write it to stdout or print it, depending
2135          * on whether we're in print mode. Thus, this loop handles
2136          * generate-to-stdout, print-from-stdin and generate-and-
2137          * immediately-print modes.
2138          * 
2139          * (It could also handle a copy-stdin-to-stdout mode,
2140          * although there's currently no combination of options
2141          * which will cause this loop to be activated in that mode.
2142          * It wouldn't be _entirely_ pointless, though, because
2143          * stdin could contain bare params strings or random-seed
2144          * IDs, and stdout would contain nothing but fully
2145          * generated descriptive game IDs.)
2146          */
2147         while (ngenerate == 0 || i < n) {
2148             char *pstr, *err;
2149
2150             if (ngenerate == 0) {
2151                 pstr = fgetline(stdin);
2152                 if (!pstr)
2153                     break;
2154                 pstr[strcspn(pstr, "\r\n")] = '\0';
2155             } else {
2156                 if (arg) {
2157                     pstr = snewn(strlen(arg) + 40, char);
2158
2159                     strcpy(pstr, arg);
2160                     if (i > 0 && strchr(arg, '#'))
2161                         sprintf(pstr + strlen(pstr), "-%d", i);
2162                 } else
2163                     pstr = NULL;
2164             }
2165
2166             if (pstr) {
2167                 err = midend_game_id(me, pstr);
2168                 if (err) {
2169                     fprintf(stderr, "%s: error parsing '%s': %s\n",
2170                             pname, pstr, err);
2171                     return 1;
2172                 }
2173             }
2174             sfree(pstr);
2175
2176             midend_new_game(me);
2177
2178             if (doc) {
2179                 err = midend_print_puzzle(me, doc, soln);
2180                 if (err) {
2181                     fprintf(stderr, "%s: error in printing: %s\n", pname, err);
2182                     return 1;
2183                 }
2184             }
2185             if (savefile) {
2186                 struct savefile_write_ctx ctx;
2187                 char *realname = snewn(40 + strlen(savefile) +
2188                                        strlen(savesuffix), char);
2189                 sprintf(realname, "%s%d%s", savefile, i, savesuffix);
2190                 ctx.fp = fopen(realname, "w");
2191                 if (!ctx.fp) {
2192                     fprintf(stderr, "%s: open: %s\n", realname,
2193                             strerror(errno));
2194                     return 1;
2195                 }
2196                 sfree(realname);
2197                 midend_serialise(me, savefile_write, &ctx);
2198                 if (ctx.error) {
2199                     fprintf(stderr, "%s: write: %s\n", realname,
2200                             strerror(ctx.error));
2201                     return 1;
2202                 }
2203                 if (fclose(ctx.fp)) {
2204                     fprintf(stderr, "%s: close: %s\n", realname,
2205                             strerror(errno));
2206                     return 1;
2207                 }
2208             }
2209             if (!doc && !savefile) {
2210                 id = midend_get_game_id(me);
2211                 puts(id);
2212                 sfree(id);
2213             }
2214
2215             i++;
2216         }
2217
2218         if (doc) {
2219             psdata *ps = ps_init(stdout, colour);
2220             document_print(doc, ps_drawing_api(ps));
2221             document_free(doc);
2222             ps_free(ps);
2223         }
2224
2225         midend_free(me);
2226
2227         return 0;
2228     } else {
2229         frontend *fe;
2230
2231         gtk_init(&argc, &argv);
2232
2233         fe = new_window(arg, argtype, &error);
2234
2235         if (!fe) {
2236             fprintf(stderr, "%s: %s\n", pname, error);
2237             return 1;
2238         }
2239
2240         if (screenshot_file) {
2241             /*
2242              * Some puzzles will not redraw their entire area if
2243              * given a partially completed animation, which means
2244              * we must redraw now and _then_ redraw again after
2245              * freezing the move timer.
2246              */
2247             midend_force_redraw(fe->me);
2248         }
2249
2250         if (redo_proportion) {
2251             /* Start a redo. */
2252             midend_process_key(fe->me, 0, 0, 'r');
2253             /* And freeze the timer at the specified position. */
2254             midend_freeze_timer(fe->me, redo_proportion);
2255         }
2256
2257         if (screenshot_file) {
2258             GdkPixbuf *pb;
2259             GError *gerror = NULL;
2260
2261             midend_redraw(fe->me);
2262
2263             pb = gdk_pixbuf_get_from_drawable(NULL, fe->pixmap,
2264                                               NULL, 0, 0, 0, 0, -1, -1);
2265             gdk_pixbuf_save(pb, screenshot_file, "png", &gerror, NULL);
2266
2267             exit(0);
2268         }
2269
2270         gtk_main();
2271     }
2272
2273     return 0;
2274 }