2 * gtk.c: GTK front end for my puzzle collection.
15 #include <sys/resource.h>
18 #include <gdk/gdkkeysyms.h>
20 #include <gdk-pixbuf/gdk-pixbuf.h>
24 #include <X11/Xutil.h>
25 #include <X11/Xatom.h>
29 #if GTK_CHECK_VERSION(2,0,0)
31 # ifdef PANGO_VERSION_CHECK
32 # if PANGO_VERSION_CHECK(1,8,0)
33 # define HAVE_SENSIBLE_ABSOLUTE_SIZE_FUNCTION
37 #if !GTK_CHECK_VERSION(2,4,0)
40 #if GTK_CHECK_VERSION(2,8,0)
44 /* #undef USE_CAIRO */
45 /* #define NO_THICK_LINE */
47 static FILE *debug_fp = NULL;
52 debug_fp = fopen("debug.log", "w");
63 void debug_printf(char *fmt, ...)
69 vsprintf(buf, fmt, ap);
75 /* ----------------------------------------------------------------------
76 * Error reporting functions used elsewhere.
79 void fatal(char *fmt, ...)
83 fprintf(stderr, "fatal error: ");
86 vfprintf(stderr, fmt, ap);
89 fprintf(stderr, "\n");
93 /* ----------------------------------------------------------------------
94 * GTK front end to puzzles.
97 static void changed_preset(frontend *fe);
101 PangoFontDescription *desc;
110 * This structure holds all the data relevant to a single window.
111 * In principle this would allow us to open multiple independent
112 * puzzle windows, although I can't currently see any real point in
113 * doing so. I'm just coding cleanly because there's no
114 * particularly good reason not to.
118 GtkAccelGroup *accelgroup;
120 GtkWidget *statusbar;
126 const float *colours;
128 cairo_surface_t *image;
130 GdkColor background; /* for painting outside puzzle area */
136 int backgroundindex; /* which of colours[] is background */
139 int bbox_l, bbox_r, bbox_u, bbox_d;
140 int timer_active, timer_id;
141 struct timeval last_time;
143 int nfonts, fontsize;
145 int cfg_which, cfgret;
149 int pw, ph; /* pixmap size (w, h are area size) */
150 int ox, oy; /* offset of pixmap in drawing area */
154 int drawing_area_shrink_pending;
155 GSList *preset_radio;
156 int n_preset_menu_items;
158 GtkWidget *preset_custom;
159 GtkWidget *copy_menu_item;
160 int menubar_is_local;
165 cairo_surface_t *image;
172 void get_random_seed(void **randseed, int *randseedsize)
174 struct timeval *tvp = snew(struct timeval);
175 gettimeofday(tvp, NULL);
176 *randseed = (void *)tvp;
177 *randseedsize = sizeof(struct timeval);
180 void frontend_default_colour(frontend *fe, float *output)
182 GdkColor col = gtk_widget_get_style(fe->window)->bg[GTK_STATE_NORMAL];
183 output[0] = col.red / 65535.0;
184 output[1] = col.green / 65535.0;
185 output[2] = col.blue / 65535.0;
188 void gtk_status_bar(void *handle, char *text)
190 frontend *fe = (frontend *)handle;
192 assert(fe->statusbar);
194 gtk_statusbar_pop(GTK_STATUSBAR(fe->statusbar), fe->statusctx);
195 gtk_statusbar_push(GTK_STATUSBAR(fe->statusbar), fe->statusctx, text);
198 /* ----------------------------------------------------------------------
199 * Cairo drawing functions.
204 static void setup_drawing(frontend *fe)
206 fe->cr = cairo_create(fe->image);
207 cairo_set_antialias(fe->cr, CAIRO_ANTIALIAS_GRAY);
208 cairo_set_line_width(fe->cr, 1.0);
209 cairo_set_line_cap(fe->cr, CAIRO_LINE_CAP_SQUARE);
210 cairo_set_line_join(fe->cr, CAIRO_LINE_JOIN_ROUND);
213 static void teardown_drawing(frontend *fe)
217 cairo_destroy(fe->cr);
220 cr = gdk_cairo_create(fe->pixmap);
221 cairo_set_source_surface(cr, fe->image, 0, 0);
225 fe->bbox_r - fe->bbox_l + 2,
226 fe->bbox_d - fe->bbox_u + 2);
231 static void snaffle_colours(frontend *fe)
233 fe->colours = midend_colours(fe->me, &fe->ncolours);
236 static void set_colour(frontend *fe, int colour)
238 cairo_set_source_rgb(fe->cr,
239 fe->colours[3*colour + 0],
240 fe->colours[3*colour + 1],
241 fe->colours[3*colour + 2]);
244 static void set_window_background(frontend *fe, int colour)
248 colmap = gdk_colormap_get_system();
249 fe->background.red = fe->colours[3*colour + 0] * 65535;
250 fe->background.green = fe->colours[3*colour + 1] * 65535;
251 fe->background.blue = fe->colours[3*colour + 2] * 65535;
252 if (!gdk_colormap_alloc_color(colmap, &fe->background, FALSE, FALSE)) {
253 g_error("couldn't allocate background (#%02x%02x%02x)\n",
254 fe->background.red >> 8, fe->background.green >> 8,
255 fe->background.blue >> 8);
257 gdk_window_set_background(gtk_widget_get_window(fe->area),
259 gdk_window_set_background(gtk_widget_get_window(fe->window),
263 static PangoLayout *make_pango_layout(frontend *fe)
265 return (pango_cairo_create_layout(fe->cr));
268 static void draw_pango_layout(frontend *fe, PangoLayout *layout,
271 cairo_move_to(fe->cr, x, y);
272 pango_cairo_show_layout(fe->cr, layout);
275 static void save_screenshot_png(frontend *fe, const char *screenshot_file)
277 cairo_surface_write_to_png(fe->image, screenshot_file);
280 static void do_clip(frontend *fe, int x, int y, int w, int h)
282 cairo_new_path(fe->cr);
283 cairo_rectangle(fe->cr, x, y, w, h);
287 static void do_unclip(frontend *fe)
289 cairo_reset_clip(fe->cr);
292 static void do_draw_rect(frontend *fe, int x, int y, int w, int h)
295 cairo_new_path(fe->cr);
296 cairo_set_antialias(fe->cr, CAIRO_ANTIALIAS_NONE);
297 cairo_rectangle(fe->cr, x, y, w, h);
299 cairo_restore(fe->cr);
302 static void do_draw_line(frontend *fe, int x1, int y1, int x2, int y2)
304 cairo_new_path(fe->cr);
305 cairo_move_to(fe->cr, x1 + 0.5, y1 + 0.5);
306 cairo_line_to(fe->cr, x2 + 0.5, y2 + 0.5);
307 cairo_stroke(fe->cr);
310 static void do_draw_thick_line(frontend *fe, float thickness,
311 float x1, float y1, float x2, float y2)
314 cairo_set_line_width(fe->cr, thickness);
315 cairo_new_path(fe->cr);
316 cairo_move_to(fe->cr, x1, y1);
317 cairo_line_to(fe->cr, x2, y2);
318 cairo_stroke(fe->cr);
319 cairo_restore(fe->cr);
322 static void do_draw_poly(frontend *fe, int *coords, int npoints,
323 int fillcolour, int outlinecolour)
327 cairo_new_path(fe->cr);
328 for (i = 0; i < npoints; i++)
329 cairo_line_to(fe->cr, coords[i*2] + 0.5, coords[i*2 + 1] + 0.5);
330 cairo_close_path(fe->cr);
331 if (fillcolour >= 0) {
332 set_colour(fe, fillcolour);
333 cairo_fill_preserve(fe->cr);
335 assert(outlinecolour >= 0);
336 set_colour(fe, outlinecolour);
337 cairo_stroke(fe->cr);
340 static void do_draw_circle(frontend *fe, int cx, int cy, int radius,
341 int fillcolour, int outlinecolour)
343 cairo_new_path(fe->cr);
344 cairo_arc(fe->cr, cx + 0.5, cy + 0.5, radius, 0, 2*PI);
345 cairo_close_path(fe->cr); /* Just in case... */
346 if (fillcolour >= 0) {
347 set_colour(fe, fillcolour);
348 cairo_fill_preserve(fe->cr);
350 assert(outlinecolour >= 0);
351 set_colour(fe, outlinecolour);
352 cairo_stroke(fe->cr);
355 static void setup_blitter(blitter *bl, int w, int h)
357 bl->image = cairo_image_surface_create(CAIRO_FORMAT_RGB24, w, h);
360 static void teardown_blitter(blitter *bl)
362 cairo_surface_destroy(bl->image);
365 static void do_blitter_save(frontend *fe, blitter *bl, int x, int y)
367 cairo_t *cr = cairo_create(bl->image);
369 cairo_set_source_surface(cr, fe->image, -x, -y);
374 static void do_blitter_load(frontend *fe, blitter *bl, int x, int y)
376 cairo_set_source_surface(fe->cr, bl->image, x, y);
380 static void clear_backing_store(frontend *fe)
385 static void setup_backing_store(frontend *fe)
390 fe->pixmap = gdk_pixmap_new(gtk_widget_get_window(fe->area),
392 fe->image = cairo_image_surface_create(CAIRO_FORMAT_RGB24,
395 for (i = 0; i < 3; i++) {
397 case 0: cr = cairo_create(fe->image); break;
398 case 1: cr = gdk_cairo_create(fe->pixmap); break;
399 case 2: cr = gdk_cairo_create(gtk_widget_get_window(fe->area));
402 cairo_set_source_rgb(cr,
403 fe->colours[0], fe->colours[1], fe->colours[2]);
409 static int backing_store_ok(frontend *fe)
411 return (!!fe->image);
414 static void teardown_backing_store(frontend *fe)
416 cairo_surface_destroy(fe->image);
417 gdk_pixmap_unref(fe->pixmap);
423 /* ----------------------------------------------------------------------
424 * GDK drawing functions.
429 static void setup_drawing(frontend *fe)
431 fe->gc = gdk_gc_new(fe->area->window);
434 static void teardown_drawing(frontend *fe)
436 gdk_gc_unref(fe->gc);
440 static void snaffle_colours(frontend *fe)
446 fe->colmap = gdk_colormap_get_system();
447 colours = midend_colours(fe->me, &ncolours);
448 fe->ncolours = ncolours;
449 fe->colours = snewn(ncolours, GdkColor);
450 for (i = 0; i < ncolours; i++) {
451 fe->colours[i].red = colours[i*3] * 0xFFFF;
452 fe->colours[i].green = colours[i*3+1] * 0xFFFF;
453 fe->colours[i].blue = colours[i*3+2] * 0xFFFF;
455 success = snewn(ncolours, gboolean);
456 gdk_colormap_alloc_colors(fe->colmap, fe->colours, ncolours,
457 FALSE, FALSE, success);
458 for (i = 0; i < ncolours; i++) {
460 g_error("couldn't allocate colour %d (#%02x%02x%02x)\n",
461 i, fe->colours[i].red >> 8,
462 fe->colours[i].green >> 8,
463 fe->colours[i].blue >> 8);
468 static void set_window_background(frontend *fe, int colour)
470 fe->backgroundindex = colour;
471 gdk_window_set_background(fe->area->window, &fe->colours[colour]);
472 gdk_window_set_background(fe->window->window, &fe->colours[colour]);
475 static void set_colour(frontend *fe, int colour)
477 gdk_gc_set_foreground(fe->gc, &fe->colours[colour]);
481 static PangoLayout *make_pango_layout(frontend *fe)
483 return (pango_layout_new(gtk_widget_get_pango_context(fe->area)));
486 static void draw_pango_layout(frontend *fe, PangoLayout *layout,
489 gdk_draw_layout(fe->pixmap, fe->gc, x, y, layout);
493 static void save_screenshot_png(frontend *fe, const char *screenshot_file)
496 GError *gerror = NULL;
498 midend_redraw(fe->me);
500 pb = gdk_pixbuf_get_from_drawable(NULL, fe->pixmap,
501 NULL, 0, 0, 0, 0, -1, -1);
502 gdk_pixbuf_save(pb, screenshot_file, "png", &gerror, NULL);
505 static void do_clip(frontend *fe, int x, int y, int w, int h)
513 gdk_gc_set_clip_rectangle(fe->gc, &rect);
516 static void do_unclip(frontend *fe)
524 gdk_gc_set_clip_rectangle(fe->gc, &rect);
527 static void do_draw_rect(frontend *fe, int x, int y, int w, int h)
529 gdk_draw_rectangle(fe->pixmap, fe->gc, 1, x, y, w, h);
532 static void do_draw_line(frontend *fe, int x1, int y1, int x2, int y2)
534 gdk_draw_line(fe->pixmap, fe->gc, x1, y1, x2, y2);
537 static void do_draw_thick_line(frontend *fe, float thickness,
538 float x1, float y1, float x2, float y2)
542 gdk_gc_get_values(fe->gc, &save);
543 gdk_gc_set_line_attributes(fe->gc,
548 gdk_draw_line(fe->pixmap, fe->gc, x1, y1, x2, y2);
549 gdk_gc_set_line_attributes(fe->gc,
556 static void do_draw_poly(frontend *fe, int *coords, int npoints,
557 int fillcolour, int outlinecolour)
559 GdkPoint *points = snewn(npoints, GdkPoint);
562 for (i = 0; i < npoints; i++) {
563 points[i].x = coords[i*2];
564 points[i].y = coords[i*2+1];
567 if (fillcolour >= 0) {
568 set_colour(fe, fillcolour);
569 gdk_draw_polygon(fe->pixmap, fe->gc, TRUE, points, npoints);
571 assert(outlinecolour >= 0);
572 set_colour(fe, outlinecolour);
575 * In principle we ought to be able to use gdk_draw_polygon for
576 * the outline as well. In fact, it turns out to interact badly
577 * with a clipping region, for no terribly obvious reason, so I
578 * draw the outline as a sequence of lines instead.
580 for (i = 0; i < npoints; i++)
581 gdk_draw_line(fe->pixmap, fe->gc,
582 points[i].x, points[i].y,
583 points[(i+1)%npoints].x, points[(i+1)%npoints].y);
588 static void do_draw_circle(frontend *fe, int cx, int cy, int radius,
589 int fillcolour, int outlinecolour)
591 if (fillcolour >= 0) {
592 set_colour(fe, fillcolour);
593 gdk_draw_arc(fe->pixmap, fe->gc, TRUE,
594 cx - radius, cy - radius,
595 2 * radius, 2 * radius, 0, 360 * 64);
598 assert(outlinecolour >= 0);
599 set_colour(fe, outlinecolour);
600 gdk_draw_arc(fe->pixmap, fe->gc, FALSE,
601 cx - radius, cy - radius,
602 2 * radius, 2 * radius, 0, 360 * 64);
605 static void setup_blitter(blitter *bl, int w, int h)
608 * We can't create the pixmap right now, because fe->window
609 * might not yet exist. So we just cache w and h and create it
610 * during the firs call to blitter_save.
615 static void teardown_blitter(blitter *bl)
618 gdk_pixmap_unref(bl->pixmap);
621 static void do_blitter_save(frontend *fe, blitter *bl, int x, int y)
624 bl->pixmap = gdk_pixmap_new(fe->area->window, bl->w, bl->h, -1);
625 gdk_draw_pixmap(bl->pixmap,
626 fe->area->style->fg_gc[GTK_WIDGET_STATE(fe->area)],
628 x, y, 0, 0, bl->w, bl->h);
631 static void do_blitter_load(frontend *fe, blitter *bl, int x, int y)
634 gdk_draw_pixmap(fe->pixmap,
635 fe->area->style->fg_gc[GTK_WIDGET_STATE(fe->area)],
637 0, 0, x, y, bl->w, bl->h);
640 static void clear_backing_store(frontend *fe)
645 static void setup_backing_store(frontend *fe)
649 fe->pixmap = gdk_pixmap_new(fe->area->window, fe->pw, fe->ph, -1);
651 gc = gdk_gc_new(fe->area->window);
652 gdk_gc_set_foreground(gc, &fe->colours[0]);
653 gdk_draw_rectangle(fe->pixmap, gc, 1, 0, 0, fe->pw, fe->ph);
654 gdk_draw_rectangle(fe->area->window, gc, 1, 0, 0, fe->w, fe->h);
658 static int backing_store_ok(frontend *fe)
660 return (!!fe->pixmap);
663 static void teardown_backing_store(frontend *fe)
665 gdk_pixmap_unref(fe->pixmap);
671 static void repaint_rectangle(frontend *fe, GtkWidget *widget,
672 int x, int y, int w, int h)
674 GdkGC *gc = gdk_gc_new(gtk_widget_get_window(widget));
676 gdk_gc_set_foreground(gc, &fe->background);
678 gdk_gc_set_foreground(gc, &fe->colours[fe->backgroundindex]);
681 gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
682 TRUE, x, y, fe->ox - x, h);
687 gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
688 TRUE, x, y, w, fe->oy - y);
693 gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
694 TRUE, x + fe->pw, y, w - fe->pw, h);
698 gdk_draw_rectangle(gtk_widget_get_window(widget), gc,
699 TRUE, x, y + fe->ph, w, h - fe->ph);
702 gdk_draw_pixmap(gtk_widget_get_window(widget), gc, fe->pixmap,
703 x - fe->ox, y - fe->oy, x, y, w, h);
707 /* ----------------------------------------------------------------------
708 * Pango font functions.
713 static void add_font(frontend *fe, int index, int fonttype, int fontsize)
716 * Use Pango to find the closest match to the requested
719 PangoFontDescription *fd;
721 fd = pango_font_description_new();
722 /* `Monospace' and `Sans' are meta-families guaranteed to exist */
723 pango_font_description_set_family(fd, fonttype == FONT_FIXED ?
724 "Monospace" : "Sans");
725 pango_font_description_set_weight(fd, PANGO_WEIGHT_BOLD);
727 * I found some online Pango documentation which
728 * described a function called
729 * pango_font_description_set_absolute_size(), which is
730 * _exactly_ what I want here. Unfortunately, none of
731 * my local Pango installations have it (presumably
732 * they're too old), so I'm going to have to hack round
733 * it by figuring out the point size myself. This
734 * limits me to X and probably also breaks in later
735 * Pango installations, so ideally I should add another
736 * CHECK_VERSION type ifdef and use set_absolute_size
737 * where available. All very annoying.
739 #ifdef HAVE_SENSIBLE_ABSOLUTE_SIZE_FUNCTION
740 pango_font_description_set_absolute_size(fd, PANGO_SCALE*fontsize);
743 Display *d = GDK_DISPLAY();
744 int s = DefaultScreen(d);
746 (PANGO_SCALE * 72.27 / 25.4) *
747 ((double) DisplayWidthMM(d, s) / DisplayWidth (d, s));
748 pango_font_description_set_size(fd, resolution * fontsize);
751 fe->fonts[index].desc = fd;
754 static void align_and_draw_text(frontend *fe,
755 int index, int align, int x, int y,
761 layout = make_pango_layout(fe);
766 pango_layout_set_font_description(layout, fe->fonts[index].desc);
767 pango_layout_set_text(layout, text, strlen(text));
768 pango_layout_get_pixel_extents(layout, NULL, &rect);
770 if (align & ALIGN_VCENTRE)
771 rect.y -= rect.height / 2;
773 rect.y -= rect.height;
775 if (align & ALIGN_HCENTRE)
776 rect.x -= rect.width / 2;
777 else if (align & ALIGN_HRIGHT)
778 rect.x -= rect.width;
780 draw_pango_layout(fe, layout, rect.x + x, rect.y + y);
782 g_object_unref(layout);
787 /* ----------------------------------------------------------------------
788 * Old-fashioned font functions.
793 static void add_font(int index, int fonttype, int fontsize)
796 * In GTK 1.2, I don't know of any plausible way to
797 * pick a suitable font, so I'm just going to be
800 fe->fonts[i].font = gdk_font_load(fonttype == FONT_FIXED ?
801 "fixed" : "variable");
804 static void align_and_draw_text(int index, int align, int x, int y,
807 int lb, rb, wid, asc, desc;
810 * Measure vertical string extents with respect to the same
813 gdk_string_extents(fe->fonts[i].font,
814 "ABCDEFGHIJKLMNOPQRSTUVWXYZ",
815 &lb, &rb, &wid, &asc, &desc);
816 if (align & ALIGN_VCENTRE)
817 y += asc - (asc+desc)/2;
822 * ... but horizontal extents with respect to the provided
823 * string. This means that multiple pieces of text centred
824 * on the same y-coordinate don't have different baselines.
826 gdk_string_extents(fe->fonts[i].font, text,
827 &lb, &rb, &wid, &asc, &desc);
829 if (align & ALIGN_HCENTRE)
831 else if (align & ALIGN_HRIGHT)
835 * Actually draw the text.
837 gdk_draw_string(fe->pixmap, fe->fonts[i].font, fe->gc, x, y, text);
842 /* ----------------------------------------------------------------------
843 * The exported drawing functions.
846 void gtk_start_draw(void *handle)
848 frontend *fe = (frontend *)handle;
856 void gtk_clip(void *handle, int x, int y, int w, int h)
858 frontend *fe = (frontend *)handle;
859 do_clip(fe, x, y, w, h);
862 void gtk_unclip(void *handle)
864 frontend *fe = (frontend *)handle;
868 void gtk_draw_text(void *handle, int x, int y, int fonttype, int fontsize,
869 int align, int colour, char *text)
871 frontend *fe = (frontend *)handle;
875 * Find or create the font.
877 for (i = 0; i < fe->nfonts; i++)
878 if (fe->fonts[i].type == fonttype && fe->fonts[i].size == fontsize)
881 if (i == fe->nfonts) {
882 if (fe->fontsize <= fe->nfonts) {
883 fe->fontsize = fe->nfonts + 10;
884 fe->fonts = sresize(fe->fonts, fe->fontsize, struct font);
889 fe->fonts[i].type = fonttype;
890 fe->fonts[i].size = fontsize;
891 add_font(fe, i, fonttype, fontsize);
897 set_colour(fe, colour);
898 align_and_draw_text(fe, i, align, x, y, text);
901 void gtk_draw_rect(void *handle, int x, int y, int w, int h, int colour)
903 frontend *fe = (frontend *)handle;
904 set_colour(fe, colour);
905 do_draw_rect(fe, x, y, w, h);
908 void gtk_draw_line(void *handle, int x1, int y1, int x2, int y2, int colour)
910 frontend *fe = (frontend *)handle;
911 set_colour(fe, colour);
912 do_draw_line(fe, x1, y1, x2, y2);
915 void gtk_draw_thick_line(void *handle, float thickness,
916 float x1, float y1, float x2, float y2, int colour)
918 frontend *fe = (frontend *)handle;
919 set_colour(fe, colour);
920 do_draw_thick_line(fe, thickness, x1, y1, x2, y2);
923 void gtk_draw_poly(void *handle, int *coords, int npoints,
924 int fillcolour, int outlinecolour)
926 frontend *fe = (frontend *)handle;
927 do_draw_poly(fe, coords, npoints, fillcolour, outlinecolour);
930 void gtk_draw_circle(void *handle, int cx, int cy, int radius,
931 int fillcolour, int outlinecolour)
933 frontend *fe = (frontend *)handle;
934 do_draw_circle(fe, cx, cy, radius, fillcolour, outlinecolour);
937 blitter *gtk_blitter_new(void *handle, int w, int h)
939 blitter *bl = snew(blitter);
940 setup_blitter(bl, w, h);
946 void gtk_blitter_free(void *handle, blitter *bl)
948 teardown_blitter(bl);
952 void gtk_blitter_save(void *handle, blitter *bl, int x, int y)
954 frontend *fe = (frontend *)handle;
955 do_blitter_save(fe, bl, x, y);
960 void gtk_blitter_load(void *handle, blitter *bl, int x, int y)
962 frontend *fe = (frontend *)handle;
963 if (x == BLITTER_FROMSAVED && y == BLITTER_FROMSAVED) {
967 do_blitter_load(fe, bl, x, y);
970 void gtk_draw_update(void *handle, int x, int y, int w, int h)
972 frontend *fe = (frontend *)handle;
973 if (fe->bbox_l > x ) fe->bbox_l = x ;
974 if (fe->bbox_r < x+w) fe->bbox_r = x+w;
975 if (fe->bbox_u > y ) fe->bbox_u = y ;
976 if (fe->bbox_d < y+h) fe->bbox_d = y+h;
979 void gtk_end_draw(void *handle)
981 frontend *fe = (frontend *)handle;
983 teardown_drawing(fe);
985 if (fe->bbox_l < fe->bbox_r && fe->bbox_u < fe->bbox_d) {
986 repaint_rectangle(fe, fe->area,
987 fe->bbox_l - 1 + fe->ox,
988 fe->bbox_u - 1 + fe->oy,
989 fe->bbox_r - fe->bbox_l + 2,
990 fe->bbox_d - fe->bbox_u + 2);
995 char *gtk_text_fallback(void *handle, const char *const *strings, int nstrings)
998 * We assume Pango can cope with any UTF-8 likely to be emitted
1001 return dupstr(strings[0]);
1005 const struct drawing_api gtk_drawing = {
1021 NULL, NULL, NULL, NULL, NULL, NULL, /* {begin,end}_{doc,page,puzzle} */
1022 NULL, NULL, /* line_width, line_dotted */
1028 #ifdef NO_THICK_LINE
1031 gtk_draw_thick_line,
1035 static void destroy(GtkWidget *widget, gpointer data)
1037 frontend *fe = (frontend *)data;
1038 deactivate_timer(fe);
1039 midend_free(fe->me);
1043 static gint key_event(GtkWidget *widget, GdkEventKey *event, gpointer data)
1045 frontend *fe = (frontend *)data;
1047 int shift = (event->state & GDK_SHIFT_MASK) ? MOD_SHFT : 0;
1048 int ctrl = (event->state & GDK_CONTROL_MASK) ? MOD_CTRL : 0;
1050 if (!backing_store_ok(fe))
1053 #if !GTK_CHECK_VERSION(2,0,0)
1054 /* Gtk 1.2 passes a key event to this function even if it's also
1055 * defined as an accelerator.
1056 * Gtk 2 doesn't do this, and this function appears not to exist there. */
1057 if (fe->accelgroup &&
1058 gtk_accel_group_get_entry(fe->accelgroup,
1059 event->keyval, event->state))
1063 /* Handle mnemonics. */
1064 if (gtk_window_activate_key(GTK_WINDOW(fe->window), event))
1067 if (event->keyval == GDK_KEY_Up)
1068 keyval = shift | ctrl | CURSOR_UP;
1069 else if (event->keyval == GDK_KEY_KP_Up ||
1070 event->keyval == GDK_KEY_KP_8)
1071 keyval = MOD_NUM_KEYPAD | '8';
1072 else if (event->keyval == GDK_KEY_Down)
1073 keyval = shift | ctrl | CURSOR_DOWN;
1074 else if (event->keyval == GDK_KEY_KP_Down ||
1075 event->keyval == GDK_KEY_KP_2)
1076 keyval = MOD_NUM_KEYPAD | '2';
1077 else if (event->keyval == GDK_KEY_Left)
1078 keyval = shift | ctrl | CURSOR_LEFT;
1079 else if (event->keyval == GDK_KEY_KP_Left ||
1080 event->keyval == GDK_KEY_KP_4)
1081 keyval = MOD_NUM_KEYPAD | '4';
1082 else if (event->keyval == GDK_KEY_Right)
1083 keyval = shift | ctrl | CURSOR_RIGHT;
1084 else if (event->keyval == GDK_KEY_KP_Right ||
1085 event->keyval == GDK_KEY_KP_6)
1086 keyval = MOD_NUM_KEYPAD | '6';
1087 else if (event->keyval == GDK_KEY_KP_Home ||
1088 event->keyval == GDK_KEY_KP_7)
1089 keyval = MOD_NUM_KEYPAD | '7';
1090 else if (event->keyval == GDK_KEY_KP_End ||
1091 event->keyval == GDK_KEY_KP_1)
1092 keyval = MOD_NUM_KEYPAD | '1';
1093 else if (event->keyval == GDK_KEY_KP_Page_Up ||
1094 event->keyval == GDK_KEY_KP_9)
1095 keyval = MOD_NUM_KEYPAD | '9';
1096 else if (event->keyval == GDK_KEY_KP_Page_Down ||
1097 event->keyval == GDK_KEY_KP_3)
1098 keyval = MOD_NUM_KEYPAD | '3';
1099 else if (event->keyval == GDK_KEY_KP_Insert ||
1100 event->keyval == GDK_KEY_KP_0)
1101 keyval = MOD_NUM_KEYPAD | '0';
1102 else if (event->keyval == GDK_KEY_KP_Begin ||
1103 event->keyval == GDK_KEY_KP_5)
1104 keyval = MOD_NUM_KEYPAD | '5';
1105 else if (event->keyval == GDK_KEY_BackSpace ||
1106 event->keyval == GDK_KEY_Delete ||
1107 event->keyval == GDK_KEY_KP_Delete)
1109 else if (event->string[0] && !event->string[1])
1110 keyval = (unsigned char)event->string[0];
1115 !midend_process_key(fe->me, 0, 0, keyval))
1116 gtk_widget_destroy(fe->window);
1121 static gint button_event(GtkWidget *widget, GdkEventButton *event,
1124 frontend *fe = (frontend *)data;
1127 if (!backing_store_ok(fe))
1130 if (event->type != GDK_BUTTON_PRESS && event->type != GDK_BUTTON_RELEASE)
1133 if (event->button == 2 || (event->state & GDK_SHIFT_MASK))
1134 button = MIDDLE_BUTTON;
1135 else if (event->button == 3 || (event->state & GDK_MOD1_MASK))
1136 button = RIGHT_BUTTON;
1137 else if (event->button == 1)
1138 button = LEFT_BUTTON;
1140 return FALSE; /* don't even know what button! */
1142 if (event->type == GDK_BUTTON_RELEASE)
1143 button += LEFT_RELEASE - LEFT_BUTTON;
1145 if (!midend_process_key(fe->me, event->x - fe->ox,
1146 event->y - fe->oy, button))
1147 gtk_widget_destroy(fe->window);
1152 static gint motion_event(GtkWidget *widget, GdkEventMotion *event,
1155 frontend *fe = (frontend *)data;
1158 if (!backing_store_ok(fe))
1161 if (event->state & (GDK_BUTTON2_MASK | GDK_SHIFT_MASK))
1162 button = MIDDLE_DRAG;
1163 else if (event->state & GDK_BUTTON1_MASK)
1165 else if (event->state & GDK_BUTTON3_MASK)
1166 button = RIGHT_DRAG;
1168 return FALSE; /* don't even know what button! */
1170 if (!midend_process_key(fe->me, event->x - fe->ox,
1171 event->y - fe->oy, button))
1172 gtk_widget_destroy(fe->window);
1173 #if GTK_CHECK_VERSION(2,12,0)
1174 gdk_event_request_motions(event);
1176 gdk_window_get_pointer(gtk_widget_get_window(widget), NULL, NULL, NULL);
1182 static gint expose_area(GtkWidget *widget, GdkEventExpose *event,
1185 frontend *fe = (frontend *)data;
1187 if (backing_store_ok(fe)) {
1188 repaint_rectangle(fe, widget,
1189 event->area.x, event->area.y,
1190 event->area.width, event->area.height);
1195 static gint map_window(GtkWidget *widget, GdkEvent *event,
1198 frontend *fe = (frontend *)data;
1201 * Apparently we need to do this because otherwise the status
1202 * bar will fail to update immediately. Annoying, but there we
1205 gtk_widget_queue_draw(fe->window);
1210 static gint configure_area(GtkWidget *widget,
1211 GdkEventConfigure *event, gpointer data)
1213 frontend *fe = (frontend *)data;
1219 if (x != fe->w || y != fe->h || !backing_store_ok(fe)) {
1220 if (backing_store_ok(fe))
1221 teardown_backing_store(fe);
1225 midend_size(fe->me, &x, &y, TRUE);
1228 fe->ox = (fe->w - fe->pw) / 2;
1229 fe->oy = (fe->h - fe->ph) / 2;
1231 setup_backing_store(fe);
1234 midend_force_redraw(fe->me);
1239 static gint timer_func(gpointer data)
1241 frontend *fe = (frontend *)data;
1243 if (fe->timer_active) {
1246 gettimeofday(&now, NULL);
1247 elapsed = ((now.tv_usec - fe->last_time.tv_usec) * 0.000001F +
1248 (now.tv_sec - fe->last_time.tv_sec));
1249 midend_timer(fe->me, elapsed); /* may clear timer_active */
1250 fe->last_time = now;
1253 return fe->timer_active;
1256 void deactivate_timer(frontend *fe)
1259 return; /* can happen due to --generate */
1260 if (fe->timer_active)
1261 gtk_timeout_remove(fe->timer_id);
1262 fe->timer_active = FALSE;
1265 void activate_timer(frontend *fe)
1268 return; /* can happen due to --generate */
1269 if (!fe->timer_active) {
1270 fe->timer_id = gtk_timeout_add(20, timer_func, fe);
1271 gettimeofday(&fe->last_time, NULL);
1273 fe->timer_active = TRUE;
1276 static void window_destroy(GtkWidget *widget, gpointer data)
1281 static void msgbox_button_clicked(GtkButton *button, gpointer data)
1283 GtkWidget *window = GTK_WIDGET(data);
1286 ip = (int *)g_object_get_data(G_OBJECT(window), "user-data");
1287 v = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(button), "user-data"));
1290 gtk_widget_destroy(GTK_WIDGET(data));
1293 static int win_key_press(GtkWidget *widget, GdkEventKey *event, gpointer data)
1295 GObject *cancelbutton = G_OBJECT(data);
1298 * `Escape' effectively clicks the cancel button
1300 if (event->keyval == GDK_KEY_Escape) {
1301 g_signal_emit_by_name(cancelbutton, "clicked");
1308 enum { MB_OK, MB_YESNO };
1310 int message_box(GtkWidget *parent, char *title, char *msg, int centre,
1313 GtkWidget *window, *hbox, *text, *button;
1317 window = gtk_dialog_new();
1318 text = gtk_label_new(msg);
1319 gtk_misc_set_alignment(GTK_MISC(text), 0.0, 0.0);
1320 hbox = gtk_hbox_new(FALSE, 0);
1321 gtk_box_pack_start(GTK_BOX(hbox), text, FALSE, FALSE, 20);
1323 (GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(window))),
1324 hbox, FALSE, FALSE, 20);
1325 gtk_widget_show(text);
1326 gtk_widget_show(hbox);
1327 gtk_window_set_title(GTK_WINDOW(window), title);
1328 gtk_label_set_line_wrap(GTK_LABEL(text), TRUE);
1330 if (type == MB_OK) {
1331 titles = GTK_STOCK_OK "\0";
1334 assert(type == MB_YESNO);
1335 titles = GTK_STOCK_NO "\0" GTK_STOCK_YES "\0";
1342 button = gtk_button_new_from_stock(titles);
1344 (GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(window))),
1345 button, FALSE, FALSE, 0);
1346 gtk_widget_show(button);
1348 gtk_widget_set_can_default(button, TRUE);
1349 gtk_window_set_default(GTK_WINDOW(window), button);
1352 g_signal_connect(G_OBJECT(window), "key_press_event",
1353 G_CALLBACK(win_key_press), button);
1355 g_signal_connect(G_OBJECT(button), "clicked",
1356 G_CALLBACK(msgbox_button_clicked), window);
1357 g_object_set_data(G_OBJECT(button), "user-data",
1358 GINT_TO_POINTER(i));
1359 titles += strlen(titles)+1;
1362 g_object_set_data(G_OBJECT(window), "user-data", &i);
1363 g_signal_connect(G_OBJECT(window), "destroy",
1364 G_CALLBACK(window_destroy), NULL);
1365 gtk_window_set_modal(GTK_WINDOW(window), TRUE);
1366 gtk_window_set_transient_for(GTK_WINDOW(window), GTK_WINDOW(parent));
1367 /* set_transient_window_pos(parent, window); */
1368 gtk_widget_show(window);
1371 return (type == MB_YESNO ? i == 1 : TRUE);
1374 void error_box(GtkWidget *parent, char *msg)
1376 message_box(parent, "Error", msg, FALSE, MB_OK);
1379 static void config_ok_button_clicked(GtkButton *button, gpointer data)
1381 frontend *fe = (frontend *)data;
1384 err = midend_set_config(fe->me, fe->cfg_which, fe->cfg);
1387 error_box(fe->cfgbox, err);
1390 gtk_widget_destroy(fe->cfgbox);
1395 static void config_cancel_button_clicked(GtkButton *button, gpointer data)
1397 frontend *fe = (frontend *)data;
1399 gtk_widget_destroy(fe->cfgbox);
1402 static int editbox_key(GtkWidget *widget, GdkEventKey *event, gpointer data)
1405 * GtkEntry has a nasty habit of eating the Return key, which
1406 * is unhelpful since it doesn't actually _do_ anything with it
1407 * (it calls gtk_widget_activate, but our edit boxes never need
1408 * activating). So I catch Return before GtkEntry sees it, and
1409 * pass it straight on to the parent widget. Effect: hitting
1410 * Return in an edit box will now activate the default button
1411 * in the dialog just like it will everywhere else.
1413 if (event->keyval == GDK_KEY_Return &&
1414 gtk_widget_get_parent(widget) != NULL) {
1416 g_signal_stop_emission_by_name(G_OBJECT(widget), "key_press_event");
1417 g_signal_emit_by_name(G_OBJECT(gtk_widget_get_parent(widget)),
1418 "key_press_event", event, &return_val);
1424 static void editbox_changed(GtkEditable *ed, gpointer data)
1426 config_item *i = (config_item *)data;
1429 i->sval = dupstr(gtk_entry_get_text(GTK_ENTRY(ed)));
1432 static void button_toggled(GtkToggleButton *tb, gpointer data)
1434 config_item *i = (config_item *)data;
1436 i->ival = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(tb));
1439 static void droplist_sel(GtkMenuItem *item, gpointer data)
1441 config_item *i = (config_item *)data;
1443 i->ival = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(item), "user-data"));
1446 static int get_config(frontend *fe, int which)
1448 GtkWidget *w, *table, *cancel;
1453 fe->cfg = midend_get_config(fe->me, which, &title);
1454 fe->cfg_which = which;
1457 fe->cfgbox = gtk_dialog_new();
1458 gtk_window_set_title(GTK_WINDOW(fe->cfgbox), title);
1461 w = gtk_button_new_from_stock(GTK_STOCK_CANCEL);
1463 (GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(fe->cfgbox))),
1464 w, FALSE, FALSE, 0);
1466 g_signal_connect(G_OBJECT(w), "clicked",
1467 G_CALLBACK(config_cancel_button_clicked), fe);
1470 w = gtk_button_new_from_stock(GTK_STOCK_OK);
1472 (GTK_BOX(gtk_dialog_get_action_area(GTK_DIALOG(fe->cfgbox))),
1473 w, FALSE, FALSE, 0);
1475 gtk_widget_set_can_default(w, TRUE);
1476 gtk_window_set_default(GTK_WINDOW(fe->cfgbox), w);
1477 g_signal_connect(G_OBJECT(w), "clicked",
1478 G_CALLBACK(config_ok_button_clicked), fe);
1480 table = gtk_table_new(1, 2, FALSE);
1483 (GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(fe->cfgbox))),
1484 table, FALSE, FALSE, 0);
1485 gtk_widget_show(table);
1487 for (i = fe->cfg; i->type != C_END; i++) {
1488 gtk_table_resize(GTK_TABLE(table), y+1, 2);
1493 * Edit box with a label beside it.
1496 w = gtk_label_new(i->name);
1497 gtk_misc_set_alignment(GTK_MISC(w), 0.0, 0.5);
1498 gtk_table_attach(GTK_TABLE(table), w, 0, 1, y, y+1,
1499 GTK_SHRINK | GTK_FILL,
1500 GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1504 w = gtk_entry_new();
1505 gtk_table_attach(GTK_TABLE(table), w, 1, 2, y, y+1,
1506 GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1507 GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1509 gtk_entry_set_text(GTK_ENTRY(w), i->sval);
1510 g_signal_connect(G_OBJECT(w), "changed",
1511 G_CALLBACK(editbox_changed), i);
1512 g_signal_connect(G_OBJECT(w), "key_press_event",
1513 G_CALLBACK(editbox_key), NULL);
1522 w = gtk_check_button_new_with_label(i->name);
1523 g_signal_connect(G_OBJECT(w), "toggled",
1524 G_CALLBACK(button_toggled), i);
1525 gtk_table_attach(GTK_TABLE(table), w, 0, 2, y, y+1,
1526 GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1527 GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1529 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(w), i->ival);
1535 * Drop-down list (GtkOptionMenu).
1538 w = gtk_label_new(i->name);
1539 gtk_misc_set_alignment(GTK_MISC(w), 0.0, 0.5);
1540 gtk_table_attach(GTK_TABLE(table), w, 0, 1, y, y+1,
1541 GTK_SHRINK | GTK_FILL,
1542 GTK_EXPAND | GTK_SHRINK | GTK_FILL ,
1546 w = gtk_option_menu_new();
1547 gtk_table_attach(GTK_TABLE(table), w, 1, 2, y, y+1,
1548 GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1549 GTK_EXPAND | GTK_SHRINK | GTK_FILL,
1556 GtkWidget *menuitem;
1557 GtkWidget *menu = gtk_menu_new();
1559 gtk_option_menu_set_menu(GTK_OPTION_MENU(w), menu);
1567 while (*q && *q != c)
1570 name = snewn(q-p+1, char);
1571 strncpy(name, p, q-p);
1574 if (*q) q++; /* eat delimiter */
1576 menuitem = gtk_menu_item_new_with_label(name);
1577 gtk_container_add(GTK_CONTAINER(menu), menuitem);
1578 g_object_set_data(G_OBJECT(menuitem), "user-data",
1579 GINT_TO_POINTER(val));
1580 g_signal_connect(G_OBJECT(menuitem), "activate",
1581 G_CALLBACK(droplist_sel), i);
1582 gtk_widget_show(menuitem);
1589 gtk_option_menu_set_history(GTK_OPTION_MENU(w), i->ival);
1598 g_signal_connect(G_OBJECT(fe->cfgbox), "destroy",
1599 G_CALLBACK(window_destroy), NULL);
1600 g_signal_connect(G_OBJECT(fe->cfgbox), "key_press_event",
1601 G_CALLBACK(win_key_press), cancel);
1602 gtk_window_set_modal(GTK_WINDOW(fe->cfgbox), TRUE);
1603 gtk_window_set_transient_for(GTK_WINDOW(fe->cfgbox),
1604 GTK_WINDOW(fe->window));
1605 /* set_transient_window_pos(fe->window, fe->cfgbox); */
1606 gtk_widget_show(fe->cfgbox);
1614 static void menu_key_event(GtkMenuItem *menuitem, gpointer data)
1616 frontend *fe = (frontend *)data;
1617 int key = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(menuitem),
1619 if (!midend_process_key(fe->me, 0, 0, key))
1620 gtk_widget_destroy(fe->window);
1623 static void get_size(frontend *fe, int *px, int *py)
1628 * Currently I don't want to make the GTK port scale large
1629 * puzzles to fit on the screen. This is because X does permit
1630 * extremely large windows and many window managers provide a
1631 * means of navigating round them, and the users I consulted
1632 * before deciding said that they'd rather have enormous puzzle
1633 * windows spanning multiple screen pages than have them
1634 * shrunk. I could change my mind later or introduce
1635 * configurability; this would be the place to do so, by
1636 * replacing the initial values of x and y with the screen
1641 midend_size(fe->me, &x, &y, FALSE);
1646 #if !GTK_CHECK_VERSION(2,0,0)
1647 #define gtk_window_resize(win, x, y) \
1648 gdk_window_resize(GTK_WIDGET(win)->window, x, y)
1652 * Called when any other code in this file has changed the
1653 * selected game parameters.
1655 static void changed_preset(frontend *fe)
1657 int n = midend_which_preset(fe->me);
1659 fe->preset_threaded = TRUE;
1660 if (n < 0 && fe->preset_custom) {
1661 gtk_check_menu_item_set_active(
1662 GTK_CHECK_MENU_ITEM(fe->preset_custom),
1665 GSList *gs = fe->preset_radio;
1666 int i = fe->n_preset_menu_items - 1 - n;
1667 if (fe->preset_custom)
1674 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(gs->data),
1676 } else for (gs = fe->preset_radio; gs; gs = gs->next) {
1677 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(gs->data),
1681 fe->preset_threaded = FALSE;
1684 * Update the greying on the Copy menu option.
1686 if (fe->copy_menu_item) {
1687 int enabled = midend_can_format_as_text_now(fe->me);
1688 gtk_widget_set_sensitive(fe->copy_menu_item, enabled);
1692 static gboolean not_size_allocated_yet(GtkWidget *w)
1695 * This function tests whether a widget has not yet taken up space
1696 * on the screen which it will occupy in future. (Therefore, it
1697 * returns true only if the widget does exist but does not have a
1698 * size allocation. A null widget is already taking up all the
1699 * space it ever will.)
1702 return FALSE; /* nonexistent widgets aren't a problem */
1704 #if GTK_CHECK_VERSION(2,18,0) /* skip if no gtk_widget_get_allocation */
1707 gtk_widget_get_allocation(w, &a);
1708 if (a.height == 0 || a.width == 0)
1709 return TRUE; /* widget exists but has no size yet */
1716 static void try_shrink_drawing_area(frontend *fe)
1718 if (fe->drawing_area_shrink_pending &&
1719 (!fe->menubar_is_local || !not_size_allocated_yet(fe->menubar)) &&
1720 !not_size_allocated_yet(fe->statusbar)) {
1722 * In order to permit the user to resize the window smaller as
1723 * well as bigger, we call this function after the window size
1724 * has ended up where we want it. This shouldn't shrink the
1725 * window immediately; it just arranges that the next time the
1726 * user tries to shrink it, they can.
1728 * However, at puzzle creation time, we defer the first of
1729 * these operations until after the menu bar and status bar
1730 * are actually visible. On Ubuntu 12.04 I've found that these
1731 * can take a while to be displayed, and that it's a mistake
1732 * to reduce the drawing area's size allocation before they've
1733 * turned up or else the drawing area makes room for them by
1734 * shrinking to less than the size we intended.
1736 gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), 1, 1);
1737 fe->drawing_area_shrink_pending = FALSE;
1741 static gint configure_window(GtkWidget *widget,
1742 GdkEventConfigure *event, gpointer data)
1744 frontend *fe = (frontend *)data;
1746 * When the main puzzle window changes size, it might be because
1747 * the menu bar or status bar has turned up after starting off
1748 * absent, in which case we should have another go at enacting a
1749 * pending shrink of the drawing area.
1751 try_shrink_drawing_area(fe);
1755 static void resize_fe(frontend *fe)
1759 get_size(fe, &x, &y);
1762 fe->drawing_area_shrink_pending = FALSE;
1763 gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), x, y);
1766 gtk_widget_size_request(GTK_WIDGET(fe->window), &req);
1767 gtk_window_resize(GTK_WINDOW(fe->window), req.width, req.height);
1769 fe->drawing_area_shrink_pending = TRUE;
1770 try_shrink_drawing_area(fe);
1773 static void menu_preset_event(GtkMenuItem *menuitem, gpointer data)
1775 frontend *fe = (frontend *)data;
1776 game_params *params =
1777 (game_params *)g_object_get_data(G_OBJECT(menuitem), "user-data");
1779 if (fe->preset_threaded ||
1780 (GTK_IS_CHECK_MENU_ITEM(menuitem) &&
1781 !gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(menuitem))))
1783 midend_set_params(fe->me, params);
1784 midend_new_game(fe->me);
1789 GdkAtom compound_text_atom, utf8_string_atom;
1790 int paste_initialised = FALSE;
1792 static void set_selection(frontend *fe, GdkAtom selection)
1794 if (!paste_initialised) {
1795 compound_text_atom = gdk_atom_intern("COMPOUND_TEXT", FALSE);
1796 utf8_string_atom = gdk_atom_intern("UTF8_STRING", FALSE);
1797 paste_initialised = TRUE;
1801 * For this simple application we can safely assume that the
1802 * data passed to this function is pure ASCII, which means we
1803 * can return precisely the same stuff for types STRING,
1804 * COMPOUND_TEXT or UTF8_STRING.
1807 if (gtk_selection_owner_set(fe->area, selection, CurrentTime)) {
1808 gtk_selection_clear_targets(fe->area, selection);
1809 gtk_selection_add_target(fe->area, selection,
1810 GDK_SELECTION_TYPE_STRING, 1);
1811 gtk_selection_add_target(fe->area, selection, compound_text_atom, 1);
1812 gtk_selection_add_target(fe->area, selection, utf8_string_atom, 1);
1816 void write_clip(frontend *fe, char *data)
1819 sfree(fe->paste_data);
1821 fe->paste_data = data;
1822 fe->paste_data_len = strlen(data);
1824 set_selection(fe, GDK_SELECTION_PRIMARY);
1825 set_selection(fe, GDK_SELECTION_CLIPBOARD);
1828 void selection_get(GtkWidget *widget, GtkSelectionData *seldata,
1829 guint info, guint time_stamp, gpointer data)
1831 frontend *fe = (frontend *)data;
1832 gtk_selection_data_set(seldata, gtk_selection_data_get_target(seldata), 8,
1833 fe->paste_data, fe->paste_data_len);
1836 gint selection_clear(GtkWidget *widget, GdkEventSelection *seldata,
1839 frontend *fe = (frontend *)data;
1842 sfree(fe->paste_data);
1843 fe->paste_data = NULL;
1844 fe->paste_data_len = 0;
1848 static void menu_copy_event(GtkMenuItem *menuitem, gpointer data)
1850 frontend *fe = (frontend *)data;
1853 text = midend_text_format(fe->me);
1856 write_clip(fe, text);
1864 static void filesel_ok(GtkButton *button, gpointer data)
1866 frontend *fe = (frontend *)data;
1868 gpointer filesel = g_object_get_data(G_OBJECT(button), "user-data");
1871 gtk_file_selection_get_filename(GTK_FILE_SELECTION(filesel));
1873 fe->filesel_name = dupstr(name);
1876 static char *file_selector(frontend *fe, char *title, int save)
1878 GtkWidget *filesel =
1879 gtk_file_selection_new(title);
1881 fe->filesel_name = NULL;
1883 gtk_window_set_modal(GTK_WINDOW(filesel), TRUE);
1885 (G_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "user-data",
1888 (G_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "clicked",
1889 G_CALLBACK(filesel_ok), fe);
1890 g_signal_connect_swapped
1891 (G_OBJECT(GTK_FILE_SELECTION(filesel)->ok_button), "clicked",
1892 G_CALLBACK(gtk_widget_destroy), (gpointer)filesel);
1893 g_signal_connect_object
1894 (G_OBJECT(GTK_FILE_SELECTION(filesel)->cancel_button), "clicked",
1895 G_CALLBACK(gtk_widget_destroy), (gpointer)filesel);
1896 g_signal_connect(G_OBJECT(filesel), "destroy",
1897 G_CALLBACK(window_destroy), NULL);
1898 gtk_widget_show(filesel);
1899 gtk_window_set_transient_for(GTK_WINDOW(filesel), GTK_WINDOW(fe->window));
1902 return fe->filesel_name;
1907 static char *file_selector(frontend *fe, char *title, int save)
1909 char *filesel_name = NULL;
1911 GtkWidget *filesel =
1912 gtk_file_chooser_dialog_new(title,
1913 GTK_WINDOW(fe->window),
1914 save ? GTK_FILE_CHOOSER_ACTION_SAVE :
1915 GTK_FILE_CHOOSER_ACTION_OPEN,
1916 GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
1917 save ? GTK_STOCK_SAVE : GTK_STOCK_OPEN,
1918 GTK_RESPONSE_ACCEPT,
1921 if (gtk_dialog_run(GTK_DIALOG(filesel)) == GTK_RESPONSE_ACCEPT) {
1922 const char *name = gtk_file_chooser_get_filename(GTK_FILE_CHOOSER(filesel));
1923 filesel_name = dupstr(name);
1926 gtk_widget_destroy(filesel);
1928 return filesel_name;
1933 struct savefile_write_ctx {
1938 static void savefile_write(void *wctx, void *buf, int len)
1940 struct savefile_write_ctx *ctx = (struct savefile_write_ctx *)wctx;
1941 if (fwrite(buf, 1, len, ctx->fp) < len)
1945 static int savefile_read(void *wctx, void *buf, int len)
1947 FILE *fp = (FILE *)wctx;
1950 ret = fread(buf, 1, len, fp);
1951 return (ret == len);
1954 static void menu_save_event(GtkMenuItem *menuitem, gpointer data)
1956 frontend *fe = (frontend *)data;
1959 name = file_selector(fe, "Enter name of game file to save", TRUE);
1964 if ((fp = fopen(name, "r")) != NULL) {
1965 char buf[256 + FILENAME_MAX];
1969 sprintf(buf, "Are you sure you want to overwrite the"
1971 FILENAME_MAX, name);
1972 if (!message_box(fe->window, "Question", buf, TRUE, MB_YESNO))
1976 fp = fopen(name, "w");
1980 error_box(fe->window, "Unable to open save file");
1985 struct savefile_write_ctx ctx;
1988 midend_serialise(fe->me, savefile_write, &ctx);
1992 sprintf(boxmsg, "Error writing save file: %.400s",
1994 error_box(fe->window, boxmsg);
2002 static void menu_load_event(GtkMenuItem *menuitem, gpointer data)
2004 frontend *fe = (frontend *)data;
2007 name = file_selector(fe, "Enter name of saved game file to load", FALSE);
2010 FILE *fp = fopen(name, "r");
2014 error_box(fe->window, "Unable to open saved game file");
2018 err = midend_deserialise(fe->me, savefile_read, fp);
2023 error_box(fe->window, err);
2032 static void menu_solve_event(GtkMenuItem *menuitem, gpointer data)
2034 frontend *fe = (frontend *)data;
2037 msg = midend_solve(fe->me);
2040 error_box(fe->window, msg);
2043 static void menu_restart_event(GtkMenuItem *menuitem, gpointer data)
2045 frontend *fe = (frontend *)data;
2047 midend_restart_game(fe->me);
2050 static void menu_config_event(GtkMenuItem *menuitem, gpointer data)
2052 frontend *fe = (frontend *)data;
2053 int which = GPOINTER_TO_INT(g_object_get_data(G_OBJECT(menuitem),
2056 if (fe->preset_threaded ||
2057 (GTK_IS_CHECK_MENU_ITEM(menuitem) &&
2058 !gtk_check_menu_item_get_active(GTK_CHECK_MENU_ITEM(menuitem))))
2060 changed_preset(fe); /* Put the old preset back! */
2061 if (!get_config(fe, which))
2064 midend_new_game(fe->me);
2068 static void menu_about_event(GtkMenuItem *menuitem, gpointer data)
2070 frontend *fe = (frontend *)data;
2074 sprintf(titlebuf, "About %.200s", thegame.name);
2077 "from Simon Tatham's Portable Puzzle Collection\n\n"
2078 "%.500s", thegame.name, ver);
2080 message_box(fe->window, titlebuf, textbuf, TRUE, MB_OK);
2083 static GtkWidget *add_menu_item_with_key(frontend *fe, GtkContainer *cont,
2084 char *text, int key)
2086 GtkWidget *menuitem = gtk_menu_item_new_with_label(text);
2088 gtk_container_add(cont, menuitem);
2089 g_object_set_data(G_OBJECT(menuitem), "user-data", GINT_TO_POINTER(key));
2090 g_signal_connect(G_OBJECT(menuitem), "activate",
2091 G_CALLBACK(menu_key_event), fe);
2092 switch (key & ~0x1F) {
2095 keyqual = GDK_CONTROL_MASK;
2099 keyqual = GDK_SHIFT_MASK;
2105 gtk_widget_add_accelerator(menuitem,
2106 "activate", fe->accelgroup,
2109 gtk_widget_show(menuitem);
2113 static void add_menu_separator(GtkContainer *cont)
2115 GtkWidget *menuitem = gtk_menu_item_new();
2116 gtk_container_add(cont, menuitem);
2117 gtk_widget_show(menuitem);
2120 enum { ARG_EITHER, ARG_SAVE, ARG_ID }; /* for argtype */
2122 static frontend *new_window(char *arg, int argtype, char **error)
2125 GtkBox *vbox, *hbox;
2126 GtkWidget *menu, *menuitem;
2131 extern char *const *const xpm_icons[];
2132 extern const int n_xpm_icons;
2134 fe = snew(frontend);
2136 fe->timer_active = FALSE;
2139 fe->me = midend_new(fe, &thegame, >k_drawing, fe);
2149 err = midend_game_id(fe->me, arg);
2151 midend_new_game(fe->me);
2153 sprintf(errbuf, "Invalid game ID: %.800s", err);
2156 fp = fopen(arg, "r");
2158 sprintf(errbuf, "Error opening file: %.800s", strerror(errno));
2160 err = midend_deserialise(fe->me, savefile_read, fp);
2162 sprintf(errbuf, "Invalid save file: %.800s", err);
2166 default /*case ARG_EITHER*/:
2168 * First try treating the argument as a game ID.
2170 err = midend_game_id(fe->me, arg);
2173 * It's a valid game ID.
2175 midend_new_game(fe->me);
2177 FILE *fp = fopen(arg, "r");
2179 sprintf(errbuf, "Supplied argument is neither a game ID (%.400s)"
2180 " nor a save file (%.400s)", err, strerror(errno));
2182 err = midend_deserialise(fe->me, savefile_read, fp);
2184 sprintf(errbuf, "%.800s", err);
2191 *error = dupstr(errbuf);
2192 midend_free(fe->me);
2198 midend_new_game(fe->me);
2203 * try_shrink_drawing_area() will do some fiddling with the
2204 * window size request (see comment in that function) after
2205 * all the bits and pieces such as the menu bar and status bar
2206 * have appeared in the puzzle window.
2208 * However, on Unity systems, the menu bar _doesn't_ appear in
2209 * the puzzle window, because the Unity shell hijacks it into
2210 * the menu bar at the very top of the screen. We therefore
2211 * try to detect that situation here, so that we don't sit
2212 * here forever waiting for a menu bar.
2214 const char prop[] = "gtk-shell-shows-menubar";
2215 GtkSettings *settings = gtk_settings_get_default();
2216 if (!g_object_class_find_property(G_OBJECT_GET_CLASS(settings),
2218 fe->menubar_is_local = TRUE;
2221 g_object_get(gtk_settings_get_default(),
2223 (const gchar *)NULL);
2224 fe->menubar_is_local = !unity_mode;
2228 fe->window = gtk_window_new(GTK_WINDOW_TOPLEVEL);
2229 gtk_window_set_title(GTK_WINDOW(fe->window), thegame.name);
2231 vbox = GTK_BOX(gtk_vbox_new(FALSE, 0));
2232 gtk_container_add(GTK_CONTAINER(fe->window), GTK_WIDGET(vbox));
2233 gtk_widget_show(GTK_WIDGET(vbox));
2235 fe->accelgroup = gtk_accel_group_new();
2236 gtk_window_add_accel_group(GTK_WINDOW(fe->window), fe->accelgroup);
2238 hbox = GTK_BOX(gtk_hbox_new(FALSE, 0));
2239 gtk_box_pack_start(vbox, GTK_WIDGET(hbox), FALSE, FALSE, 0);
2240 gtk_widget_show(GTK_WIDGET(hbox));
2242 fe->menubar = gtk_menu_bar_new();
2243 gtk_box_pack_start(hbox, fe->menubar, TRUE, TRUE, 0);
2244 gtk_widget_show(fe->menubar);
2246 menuitem = gtk_menu_item_new_with_mnemonic("_Game");
2247 gtk_container_add(GTK_CONTAINER(fe->menubar), menuitem);
2248 gtk_widget_show(menuitem);
2250 menu = gtk_menu_new();
2251 gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), menu);
2253 add_menu_item_with_key(fe, GTK_CONTAINER(menu), "New", 'n');
2255 menuitem = gtk_menu_item_new_with_label("Restart");
2256 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2257 g_signal_connect(G_OBJECT(menuitem), "activate",
2258 G_CALLBACK(menu_restart_event), fe);
2259 gtk_widget_show(menuitem);
2261 menuitem = gtk_menu_item_new_with_label("Specific...");
2262 g_object_set_data(G_OBJECT(menuitem), "user-data",
2263 GINT_TO_POINTER(CFG_DESC));
2264 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2265 g_signal_connect(G_OBJECT(menuitem), "activate",
2266 G_CALLBACK(menu_config_event), fe);
2267 gtk_widget_show(menuitem);
2269 menuitem = gtk_menu_item_new_with_label("Random Seed...");
2270 g_object_set_data(G_OBJECT(menuitem), "user-data",
2271 GINT_TO_POINTER(CFG_SEED));
2272 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2273 g_signal_connect(G_OBJECT(menuitem), "activate",
2274 G_CALLBACK(menu_config_event), fe);
2275 gtk_widget_show(menuitem);
2277 fe->preset_radio = NULL;
2278 fe->preset_custom = NULL;
2279 fe->n_preset_menu_items = 0;
2280 fe->preset_threaded = FALSE;
2281 if ((n = midend_num_presets(fe->me)) > 0 || thegame.can_configure) {
2285 menuitem = gtk_menu_item_new_with_mnemonic("_Type");
2286 gtk_container_add(GTK_CONTAINER(fe->menubar), menuitem);
2287 gtk_widget_show(menuitem);
2289 submenu = gtk_menu_new();
2290 gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), submenu);
2292 for (i = 0; i < n; i++) {
2294 game_params *params;
2296 midend_fetch_preset(fe->me, i, &name, ¶ms);
2299 gtk_radio_menu_item_new_with_label(fe->preset_radio, name);
2301 gtk_radio_menu_item_group(GTK_RADIO_MENU_ITEM(menuitem));
2302 fe->n_preset_menu_items++;
2303 gtk_container_add(GTK_CONTAINER(submenu), menuitem);
2304 g_object_set_data(G_OBJECT(menuitem), "user-data", params);
2305 g_signal_connect(G_OBJECT(menuitem), "activate",
2306 G_CALLBACK(menu_preset_event), fe);
2307 gtk_widget_show(menuitem);
2310 if (thegame.can_configure) {
2311 menuitem = fe->preset_custom =
2312 gtk_radio_menu_item_new_with_label(fe->preset_radio,
2315 gtk_radio_menu_item_group(GTK_RADIO_MENU_ITEM(menuitem));
2316 gtk_container_add(GTK_CONTAINER(submenu), menuitem);
2317 g_object_set_data(G_OBJECT(menuitem), "user-data",
2318 GINT_TO_POINTER(CFG_SETTINGS));
2319 g_signal_connect(G_OBJECT(menuitem), "activate",
2320 G_CALLBACK(menu_config_event), fe);
2321 gtk_widget_show(menuitem);
2326 add_menu_separator(GTK_CONTAINER(menu));
2327 menuitem = gtk_menu_item_new_with_label("Load...");
2328 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2329 g_signal_connect(G_OBJECT(menuitem), "activate",
2330 G_CALLBACK(menu_load_event), fe);
2331 gtk_widget_show(menuitem);
2332 menuitem = gtk_menu_item_new_with_label("Save...");
2333 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2334 g_signal_connect(G_OBJECT(menuitem), "activate",
2335 G_CALLBACK(menu_save_event), fe);
2336 gtk_widget_show(menuitem);
2337 #ifndef STYLUS_BASED
2338 add_menu_separator(GTK_CONTAINER(menu));
2339 add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Undo", 'u');
2340 add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Redo", 'r');
2342 if (thegame.can_format_as_text_ever) {
2343 add_menu_separator(GTK_CONTAINER(menu));
2344 menuitem = gtk_menu_item_new_with_label("Copy");
2345 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2346 g_signal_connect(G_OBJECT(menuitem), "activate",
2347 G_CALLBACK(menu_copy_event), fe);
2348 gtk_widget_show(menuitem);
2349 fe->copy_menu_item = menuitem;
2351 fe->copy_menu_item = NULL;
2353 if (thegame.can_solve) {
2354 add_menu_separator(GTK_CONTAINER(menu));
2355 menuitem = gtk_menu_item_new_with_label("Solve");
2356 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2357 g_signal_connect(G_OBJECT(menuitem), "activate",
2358 G_CALLBACK(menu_solve_event), fe);
2359 gtk_widget_show(menuitem);
2361 add_menu_separator(GTK_CONTAINER(menu));
2362 add_menu_item_with_key(fe, GTK_CONTAINER(menu), "Exit", 'q');
2364 menuitem = gtk_menu_item_new_with_mnemonic("_Help");
2365 gtk_container_add(GTK_CONTAINER(fe->menubar), menuitem);
2366 gtk_widget_show(menuitem);
2368 menu = gtk_menu_new();
2369 gtk_menu_item_set_submenu(GTK_MENU_ITEM(menuitem), menu);
2371 menuitem = gtk_menu_item_new_with_label("About");
2372 gtk_container_add(GTK_CONTAINER(menu), menuitem);
2373 g_signal_connect(G_OBJECT(menuitem), "activate",
2374 G_CALLBACK(menu_about_event), fe);
2375 gtk_widget_show(menuitem);
2378 menuitem=gtk_button_new_with_mnemonic("_Redo");
2379 g_object_set_data(G_OBJECT(menuitem), "user-data",
2380 GINT_TO_POINTER((int)('r')));
2381 g_signal_connect(G_OBJECT(menuitem), "clicked",
2382 G_CALLBACK(menu_key_event), fe);
2383 gtk_box_pack_end(hbox, menuitem, FALSE, FALSE, 0);
2384 gtk_widget_show(menuitem);
2386 menuitem=gtk_button_new_with_mnemonic("_Undo");
2387 g_object_set_data(G_OBJECT(menuitem), "user-data",
2388 GINT_TO_POINTER((int)('u')));
2389 g_signal_connect(G_OBJECT(menuitem), "clicked",
2390 G_CALLBACK(menu_key_event), fe);
2391 gtk_box_pack_end(hbox, menuitem, FALSE, FALSE, 0);
2392 gtk_widget_show(menuitem);
2394 if (thegame.flags & REQUIRE_NUMPAD) {
2395 hbox = GTK_BOX(gtk_hbox_new(FALSE, 0));
2396 gtk_box_pack_start(vbox, GTK_WIDGET(hbox), FALSE, FALSE, 0);
2397 gtk_widget_show(GTK_WIDGET(hbox));
2401 for(errbuf[0]='0';errbuf[0]<='9';errbuf[0]++) {
2402 menuitem=gtk_button_new_with_label(errbuf);
2403 g_object_set_data(G_OBJECT(menuitem), "user-data",
2404 GINT_TO_POINTER((int)(errbuf[0])));
2405 g_signal_connect(G_OBJECT(menuitem), "clicked",
2406 G_CALLBACK(menu_key_event), fe);
2407 gtk_box_pack_start(hbox, menuitem, TRUE, TRUE, 0);
2408 gtk_widget_show(menuitem);
2411 #endif /* STYLUS_BASED */
2415 snaffle_colours(fe);
2417 if (midend_wants_statusbar(fe->me)) {
2418 GtkWidget *viewport;
2421 viewport = gtk_viewport_new(NULL, NULL);
2422 gtk_viewport_set_shadow_type(GTK_VIEWPORT(viewport), GTK_SHADOW_NONE);
2423 fe->statusbar = gtk_statusbar_new();
2424 gtk_container_add(GTK_CONTAINER(viewport), fe->statusbar);
2425 gtk_widget_show(viewport);
2426 gtk_box_pack_end(vbox, viewport, FALSE, FALSE, 0);
2427 gtk_widget_show(fe->statusbar);
2428 fe->statusctx = gtk_statusbar_get_context_id
2429 (GTK_STATUSBAR(fe->statusbar), "game");
2430 gtk_statusbar_push(GTK_STATUSBAR(fe->statusbar), fe->statusctx,
2432 gtk_widget_size_request(fe->statusbar, &req);
2434 /* For GTK 2.0, should we be using gtk_widget_set_size_request? */
2436 gtk_widget_set_usize(viewport, -1, req.height);
2438 fe->statusbar = NULL;
2440 fe->area = gtk_drawing_area_new();
2441 #if GTK_CHECK_VERSION(2,0,0)
2442 gtk_widget_set_double_buffered(fe->area, FALSE);
2444 get_size(fe, &x, &y);
2445 fe->drawing_area_shrink_pending = FALSE;
2446 gtk_drawing_area_size(GTK_DRAWING_AREA(fe->area), x, y);
2450 gtk_box_pack_end(vbox, fe->area, TRUE, TRUE, 0);
2452 clear_backing_store(fe);
2454 fe->nfonts = fe->fontsize = 0;
2456 fe->paste_data = NULL;
2457 fe->paste_data_len = 0;
2459 g_signal_connect(G_OBJECT(fe->window), "destroy",
2460 G_CALLBACK(destroy), fe);
2461 g_signal_connect(G_OBJECT(fe->window), "key_press_event",
2462 G_CALLBACK(key_event), fe);
2463 g_signal_connect(G_OBJECT(fe->area), "button_press_event",
2464 G_CALLBACK(button_event), fe);
2465 g_signal_connect(G_OBJECT(fe->area), "button_release_event",
2466 G_CALLBACK(button_event), fe);
2467 g_signal_connect(G_OBJECT(fe->area), "motion_notify_event",
2468 G_CALLBACK(motion_event), fe);
2469 g_signal_connect(G_OBJECT(fe->area), "selection_get",
2470 G_CALLBACK(selection_get), fe);
2471 g_signal_connect(G_OBJECT(fe->area), "selection_clear_event",
2472 G_CALLBACK(selection_clear), fe);
2473 g_signal_connect(G_OBJECT(fe->area), "expose_event",
2474 G_CALLBACK(expose_area), fe);
2475 g_signal_connect(G_OBJECT(fe->window), "map_event",
2476 G_CALLBACK(map_window), fe);
2477 g_signal_connect(G_OBJECT(fe->area), "configure_event",
2478 G_CALLBACK(configure_area), fe);
2479 g_signal_connect(G_OBJECT(fe->window), "configure_event",
2480 G_CALLBACK(configure_window), fe);
2482 gtk_widget_add_events(GTK_WIDGET(fe->area),
2483 GDK_BUTTON_PRESS_MASK |
2484 GDK_BUTTON_RELEASE_MASK |
2485 GDK_BUTTON_MOTION_MASK |
2486 GDK_POINTER_MOTION_HINT_MASK);
2489 gtk_widget_realize(fe->window);
2490 iconpm = gdk_pixmap_create_from_xpm_d
2491 (gtk_widget_get_window(fe->window), NULL, NULL,
2492 (gchar **)xpm_icons[0]);
2493 gdk_window_set_icon(gtk_widget_get_window(fe->window),
2494 NULL, iconpm, NULL);
2496 for (n = 0; n < n_xpm_icons; n++) {
2498 g_list_append(iconlist,
2499 gdk_pixbuf_new_from_xpm_data((const gchar **)
2502 gdk_window_set_icon_list(gtk_widget_get_window(fe->window), iconlist);
2505 gtk_widget_show(fe->area);
2506 gtk_widget_show(fe->window);
2508 fe->drawing_area_shrink_pending = TRUE;
2509 try_shrink_drawing_area(fe);
2510 set_window_background(fe, 0);
2515 char *fgetline(FILE *fp)
2517 char *ret = snewn(512, char);
2518 int size = 512, len = 0;
2519 while (fgets(ret + len, size - len, fp)) {
2520 len += strlen(ret + len);
2521 if (ret[len-1] == '\n')
2522 break; /* got a newline, we're done */
2524 ret = sresize(ret, size, char);
2526 if (len == 0) { /* first fgets returned NULL */
2534 int main(int argc, char **argv)
2536 char *pname = argv[0];
2538 int ngenerate = 0, print = FALSE, px = 1, py = 1;
2539 int time_generation = FALSE, test_solve = FALSE, list_presets = FALSE;
2540 int soln = FALSE, colour = FALSE;
2542 float redo_proportion = 0.0F;
2543 char *savefile = NULL, *savesuffix = NULL;
2545 int argtype = ARG_EITHER;
2546 char *screenshot_file = NULL;
2547 int doing_opts = TRUE;
2553 * Command line parsing in this function is rather fiddly,
2554 * because GTK wants to have a go at argc/argv _first_ - and
2555 * yet we can't let it, because gtk_init() will bomb out if it
2556 * can't open an X display, whereas in fact we want to permit
2557 * our --generate and --print modes to run without an X
2561 * - we parse the command line ourselves, without modifying
2563 * - if we encounter an error which might plausibly be the
2564 * result of a GTK command line (i.e. not detailed errors in
2565 * particular options of ours) we store the error message
2566 * and terminate parsing.
2567 * - if we got enough out of the command line to know it
2568 * specifies a non-X mode of operation, we either display
2569 * the stored error and return failure, or if there is no
2570 * stored error we do the non-X operation and return
2572 * - otherwise, we go straight to gtk_init().
2578 if (doing_opts && !strcmp(p, "--version")) {
2579 printf("%s, from Simon Tatham's Portable Puzzle Collection\n%s\n",
2582 } else if (doing_opts && !strcmp(p, "--generate")) {
2584 ngenerate = atoi(*++av);
2586 fprintf(stderr, "%s: '--generate' expected a number\n",
2592 } else if (doing_opts && !strcmp(p, "--time-generation")) {
2593 time_generation = TRUE;
2594 } else if (doing_opts && !strcmp(p, "--test-solve")) {
2596 } else if (doing_opts && !strcmp(p, "--list-presets")) {
2597 list_presets = TRUE;
2598 } else if (doing_opts && !strcmp(p, "--save")) {
2602 fprintf(stderr, "%s: '--save' expected a filename\n",
2606 } else if (doing_opts && (!strcmp(p, "--save-suffix") ||
2607 !strcmp(p, "--savesuffix"))) {
2611 fprintf(stderr, "%s: '--save-suffix' expected a filename\n",
2615 } else if (doing_opts && !strcmp(p, "--print")) {
2616 if (!thegame.can_print) {
2617 fprintf(stderr, "%s: this game does not support printing\n",
2624 if (sscanf(dim, "%dx%d", &px, &py) != 2) {
2625 fprintf(stderr, "%s: unable to parse argument '%s' to "
2626 "'--print'\n", pname, dim);
2632 } else if (doing_opts && !strcmp(p, "--scale")) {
2634 scale = atof(*++av);
2636 fprintf(stderr, "%s: no argument supplied to '--scale'\n",
2640 } else if (doing_opts && !strcmp(p, "--redo")) {
2642 * This is an internal option which I don't expect
2643 * users to have any particular use for. The effect of
2644 * --redo is that once the game has been loaded and
2645 * initialised, the next move in the redo chain is
2646 * replayed, and the game screen is redrawn part way
2647 * through the making of the move. This is only
2648 * meaningful if there _is_ a next move in the redo
2649 * chain, which means in turn that this option is only
2650 * useful if you're also passing a save file on the
2653 * This option is used by the script which generates
2654 * the puzzle icons and website screenshots, and I
2655 * don't imagine it's useful for anything else.
2656 * (Unless, I suppose, users don't like my screenshots
2657 * and want to generate their own in the same way for
2658 * some repackaged version of the puzzles.)
2661 redo_proportion = atof(*++av);
2663 fprintf(stderr, "%s: no argument supplied to '--redo'\n",
2667 } else if (doing_opts && !strcmp(p, "--screenshot")) {
2669 * Another internal option for the icon building
2670 * script. This causes a screenshot of the central
2671 * drawing area (i.e. not including the menu bar or
2672 * status bar) to be saved to a PNG file once the
2673 * window has been drawn, and then the application
2674 * quits immediately.
2677 screenshot_file = *++av;
2679 fprintf(stderr, "%s: no argument supplied to '--screenshot'\n",
2683 } else if (doing_opts && (!strcmp(p, "--with-solutions") ||
2684 !strcmp(p, "--with-solution") ||
2685 !strcmp(p, "--with-solns") ||
2686 !strcmp(p, "--with-soln") ||
2687 !strcmp(p, "--solutions") ||
2688 !strcmp(p, "--solution") ||
2689 !strcmp(p, "--solns") ||
2690 !strcmp(p, "--soln"))) {
2692 } else if (doing_opts && !strcmp(p, "--colour")) {
2693 if (!thegame.can_print_in_colour) {
2694 fprintf(stderr, "%s: this game does not support colour"
2695 " printing\n", pname);
2699 } else if (doing_opts && !strcmp(p, "--load")) {
2701 } else if (doing_opts && !strcmp(p, "--game")) {
2703 } else if (doing_opts && !strcmp(p, "--")) {
2705 } else if (!doing_opts || p[0] != '-') {
2707 fprintf(stderr, "%s: more than one argument supplied\n",
2713 sprintf(errbuf, "%.100s: unrecognised option '%.100s'\n",
2720 * Special standalone mode for generating puzzle IDs on the
2721 * command line. Useful for generating puzzles to be printed
2722 * out and solved offline (for puzzles where that even makes
2723 * sense - Solo, for example, is a lot more pencil-and-paper
2724 * friendly than Twiddle!)
2728 * <puzzle-name> --generate [<n> [<params>]]
2730 * <n>, if present, is the number of puzzle IDs to generate.
2731 * <params>, if present, is the same type of parameter string
2732 * you would pass to the puzzle when running it in GUI mode,
2733 * including optional extras such as the expansion factor in
2734 * Rectangles and the difficulty level in Solo.
2736 * If you specify <params>, you must also specify <n> (although
2737 * you may specify it to be 1). Sorry; that was the
2738 * simplest-to-parse command-line syntax I came up with.
2740 if (ngenerate > 0 || print || savefile || savesuffix) {
2744 document *doc = NULL;
2747 * If we're in this branch, we should display any pending
2748 * error message from the command line, since GTK isn't going
2749 * to take another crack at making sense of it.
2752 fputs(errbuf, stderr);
2758 me = midend_new(NULL, &thegame, NULL, NULL);
2761 if (savefile && !savesuffix)
2763 if (!savefile && savesuffix)
2767 doc = document_new(px, py, scale);
2770 * In this loop, we either generate a game ID or read one
2771 * from stdin depending on whether we're in generate mode;
2772 * then we either write it to stdout or print it, depending
2773 * on whether we're in print mode. Thus, this loop handles
2774 * generate-to-stdout, print-from-stdin and generate-and-
2775 * immediately-print modes.
2777 * (It could also handle a copy-stdin-to-stdout mode,
2778 * although there's currently no combination of options
2779 * which will cause this loop to be activated in that mode.
2780 * It wouldn't be _entirely_ pointless, though, because
2781 * stdin could contain bare params strings or random-seed
2782 * IDs, and stdout would contain nothing but fully
2783 * generated descriptive game IDs.)
2785 while (ngenerate == 0 || i < n) {
2786 char *pstr, *err, *seed;
2787 struct rusage before, after;
2789 if (ngenerate == 0) {
2790 pstr = fgetline(stdin);
2793 pstr[strcspn(pstr, "\r\n")] = '\0';
2796 pstr = snewn(strlen(arg) + 40, char);
2799 if (i > 0 && strchr(arg, '#'))
2800 sprintf(pstr + strlen(pstr), "-%d", i);
2806 err = midend_game_id(me, pstr);
2808 fprintf(stderr, "%s: error parsing '%s': %s\n",
2814 if (time_generation)
2815 getrusage(RUSAGE_SELF, &before);
2817 midend_new_game(me);
2819 seed = midend_get_random_seed(me);
2821 if (time_generation) {
2824 getrusage(RUSAGE_SELF, &after);
2826 elapsed = (after.ru_utime.tv_sec -
2827 before.ru_utime.tv_sec);
2828 elapsed += (after.ru_utime.tv_usec -
2829 before.ru_utime.tv_usec) / 1000000.0;
2831 printf("%s %s: %.6f\n", thegame.name, seed, elapsed);
2834 if (test_solve && thegame.can_solve) {
2836 * Now destroy the aux_info in the midend, by means of
2837 * re-entering the same game id, and then try to solve
2840 char *game_id, *err;
2842 game_id = midend_get_game_id(me);
2843 err = midend_game_id(me, game_id);
2845 fprintf(stderr, "%s %s: game id re-entry error: %s\n",
2846 thegame.name, seed, err);
2849 midend_new_game(me);
2852 err = midend_solve(me);
2854 * If the solve operation returned the error "Solution
2855 * not known for this puzzle", that's OK, because that
2856 * just means it's a puzzle for which we don't have an
2857 * algorithmic solver and hence can't solve it without
2858 * the aux_info, e.g. Netslide. Any other error is a
2861 if (err && strcmp(err, "Solution not known for this puzzle")) {
2862 fprintf(stderr, "%s %s: solve error: %s\n",
2863 thegame.name, seed, err);
2872 err = midend_print_puzzle(me, doc, soln);
2874 fprintf(stderr, "%s: error in printing: %s\n", pname, err);
2879 struct savefile_write_ctx ctx;
2880 char *realname = snewn(40 + strlen(savefile) +
2881 strlen(savesuffix), char);
2882 sprintf(realname, "%s%d%s", savefile, i, savesuffix);
2885 char *err = midend_solve(me);
2887 fprintf(stderr, "%s: unable to show solution: %s\n",
2893 ctx.fp = fopen(realname, "w");
2895 fprintf(stderr, "%s: open: %s\n", realname,
2900 midend_serialise(me, savefile_write, &ctx);
2902 fprintf(stderr, "%s: write: %s\n", realname,
2903 strerror(ctx.error));
2906 if (fclose(ctx.fp)) {
2907 fprintf(stderr, "%s: close: %s\n", realname,
2913 if (!doc && !savefile && !time_generation) {
2914 id = midend_get_game_id(me);
2923 psdata *ps = ps_init(stdout, colour);
2924 document_print(doc, ps_drawing_api(ps));
2932 } else if (list_presets) {
2934 * Another specialist mode which causes the puzzle to list the
2935 * game_params strings for all its preset configurations.
2940 me = midend_new(NULL, &thegame, NULL, NULL);
2941 npresets = midend_num_presets(me);
2943 for (i = 0; i < npresets; i++) {
2944 game_params *params;
2945 char *name, *paramstr;
2947 midend_fetch_preset(me, i, &name, ¶ms);
2948 paramstr = thegame.encode_params(params, TRUE);
2950 printf("%s %s\n", paramstr, name);
2959 gtk_init(&argc, &argv);
2961 fe = new_window(arg, argtype, &error);
2964 fprintf(stderr, "%s: %s\n", pname, error);
2968 if (screenshot_file) {
2970 * Some puzzles will not redraw their entire area if
2971 * given a partially completed animation, which means
2972 * we must redraw now and _then_ redraw again after
2973 * freezing the move timer.
2975 midend_force_redraw(fe->me);
2978 if (redo_proportion) {
2980 midend_process_key(fe->me, 0, 0, 'r');
2981 /* And freeze the timer at the specified position. */
2982 midend_freeze_timer(fe->me, redo_proportion);
2985 if (screenshot_file) {
2986 save_screenshot_png(fe, screenshot_file);