output: Expand footnote support.
[pspp] / src / ui / gui / psppire-output-view.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008-2015, 2016 Free Software Foundation.
3
4    This program is free software: you can redistribute it and/or modify
5    it under the terms of the GNU General Public License as published by
6    the Free Software Foundation, either version 3 of the License, or
7    (at your option) any later version.
8
9    This program is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12    GNU General Public License for more details.
13
14    You should have received a copy of the GNU General Public License
15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
16
17 #include <config.h>
18
19 #include "ui/gui/psppire-output-view.h"
20
21 #include <errno.h>
22 #include <stdbool.h>
23
24 #include "libpspp/assertion.h"
25 #include "libpspp/string-map.h"
26 #include "output/cairo.h"
27 #include "output/driver-provider.h"
28 #include "output/driver.h"
29 #include "output/chart-item.h"
30 #include "output/message-item.h"
31 #include "output/output-item.h"
32 #include "output/table-item.h"
33 #include "output/text-item.h"
34
35 #include "gl/c-xvasprintf.h"
36 #include "gl/minmax.h"
37 #include "gl/tmpdir.h"
38 #include "gl/xalloc.h"
39
40 #include <gettext.h>
41 #define _(msgid) gettext (msgid)
42
43 struct output_view_item
44   {
45     struct output_item *item;
46     GtkWidget *drawing_area;
47   };
48
49 struct psppire_output_view
50   {
51     struct xr_driver *xr;
52     int font_height;
53
54     GtkLayout *output;
55     int render_width;
56     int max_width;
57     glong y;
58
59     struct string_map render_opts;
60     GtkTreeView *overview;
61     GtkTreeIter cur_command;
62     bool in_command;
63
64     GtkWidget *toplevel;
65
66     struct output_view_item *items;
67     size_t n_items, allocated_items;
68
69     /* Variables pertaining to printing */
70     GtkPrintSettings *print_settings;
71     struct xr_driver *print_xrd;
72     int print_item;
73     int print_n_pages;
74     gboolean paginated;
75   };
76
77 enum
78   {
79     COL_NAME,                   /* Table name. */
80     COL_ADDR,                   /* Pointer to the table */
81     COL_Y,                      /* Y position of top of name. */
82     N_COLS
83   };
84
85 static gboolean
86 draw_callback (GtkWidget *widget, cairo_t *cr, gpointer data)
87 {
88   struct xr_rendering *r = g_object_get_data (G_OBJECT (widget), "rendering");
89   xr_rendering_draw_all (r, cr);
90   return TRUE;
91 }
92
93 static void
94 free_rendering (gpointer rendering_)
95 {
96   struct xr_rendering *rendering = rendering_;
97   xr_rendering_destroy (rendering);
98 }
99
100 static void
101 create_xr (struct psppire_output_view *view)
102 {
103   struct text_item *text_item;
104   PangoFontDescription *font_desc;
105   struct xr_rendering *r;
106   char *font_name;
107   int font_width;
108   cairo_t *cr;
109   gchar *fgc;
110
111   GtkStyleContext *context = gtk_widget_get_style_context (GTK_WIDGET (view->output));
112   GtkStateFlags state = gtk_widget_get_state_flags (GTK_WIDGET (view->output));
113   GdkRGBA *fg_color;
114
115   gtk_style_context_get (context, state,
116     "font", &font_desc, "color", &fg_color, NULL);
117
118   cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
119
120   /* Set the widget's text color as the foreground color for the output driver */
121   /* gdk_rgba_to_string() would be perfect, but xr's parse_color does not      */
122   /* understand the rgb(255,128,33) format. Therefore we do it ourself.        */
123   fgc = xasprintf("#%4x%4x%4x",(int)(fg_color->red*0xffff),
124     (int)(fg_color->green*0xffff),(int)(fg_color->blue*0xffff));
125   string_map_insert (&view->render_opts, "foreground-color", fgc);
126   g_free (fgc);
127   gdk_rgba_free (fg_color);
128
129   /* Use GTK+ default font as proportional font. */
130   font_name = pango_font_description_to_string (font_desc);
131   string_map_insert (&view->render_opts, "prop-font", font_name);
132   g_free (font_name);
133
134   /* Derived emphasized font from proportional font. */
135   pango_font_description_set_style (font_desc, PANGO_STYLE_ITALIC);
136   font_name = pango_font_description_to_string (font_desc);
137   string_map_insert (&view->render_opts, "emph-font", font_name);
138   g_free (font_name);
139   pango_font_description_free (font_desc);
140
141   /* Pretend that the "page" has a reasonable width and a very big length,
142      so that most tables can be conveniently viewed on-screen with vertical
143      scrolling only.  (The length should not be increased very much because
144      it is already close enough to INT_MAX when expressed as thousands of a
145      point.) */
146   string_map_insert_nocopy (&view->render_opts, xstrdup ("paper-size"),
147                             xasprintf ("%dx1000000pt", view->render_width));
148   string_map_insert (&view->render_opts, "left-margin", "0");
149   string_map_insert (&view->render_opts, "right-margin", "0");
150   string_map_insert (&view->render_opts, "top-margin", "0");
151   string_map_insert (&view->render_opts, "bottom-margin", "0");
152
153   view->xr = xr_driver_create (cr, &view->render_opts);
154
155   text_item = text_item_create (TEXT_ITEM_PARAGRAPH, "X");
156   r = xr_rendering_create (view->xr, text_item_super (text_item), cr);
157   xr_rendering_measure (r, &font_width, &view->font_height);
158   text_item_unref (text_item);
159
160   cairo_destroy (cr);
161 }
162
163 /* Return the horizontal position to place a widget whose
164    width is CHILD_WIDTH */
165 static gint
166 get_xpos (const struct psppire_output_view *view, gint child_width)
167 {
168   GdkWindow *gdkw = gtk_widget_get_window (GTK_WIDGET (view->output));
169   guint w = gdk_window_get_width (gdkw);
170   int gutter = 0;
171   g_object_get (view->output, "border-width", &gutter, NULL);
172   return (gtk_widget_get_direction (GTK_WIDGET (view->output)) ==  GTK_TEXT_DIR_RTL) ? w - child_width - gutter: gutter;
173 }
174
175 static void
176 create_drawing_area (struct psppire_output_view *view,
177                      GtkWidget *drawing_area, struct xr_rendering *r,
178                      int tw, int th)
179 {
180   /* Enable this to help with debugging.  It shows you which widgets are being
181      put where. */
182   if (0)
183     {
184       GdkRGBA green = {0, 1, 0, 1};
185       gtk_widget_override_background_color (GTK_WIDGET (view->output),
186                                             GTK_STATE_FLAG_NORMAL, &green);
187       GdkRGBA red = {1, 0, 0, 1};
188       gtk_widget_override_background_color (drawing_area,
189                                             GTK_STATE_FLAG_NORMAL, &red);
190     }
191
192   g_object_set_data_full (G_OBJECT (drawing_area),
193                           "rendering", r, free_rendering);
194
195   g_signal_connect (drawing_area, "draw",
196                     G_CALLBACK (draw_callback), view);
197
198   gtk_widget_set_size_request (drawing_area, tw, th);
199   gint xpos = get_xpos (view, tw);
200
201   gtk_layout_put (view->output, drawing_area, xpos, view->y);
202
203   gtk_widget_show (drawing_area);
204 }
205
206 static void
207 rerender (struct psppire_output_view *view)
208 {
209   struct output_view_item *item;
210   GdkWindow *gdkw = gtk_widget_get_window (GTK_WIDGET (view->output));
211   cairo_t *cr;
212
213   if (!view->n_items || ! gdkw)
214     return;
215
216   cr = gdk_cairo_create (gdkw);
217   if (view->xr == NULL)
218     create_xr (view);
219   view->y = 0;
220   view->max_width = 0;
221   for (item = view->items; item < &view->items[view->n_items]; item++)
222     {
223       struct xr_rendering *r;
224       GtkAllocation alloc;
225       int tw, th;
226
227       if (view->y > 0)
228         view->y += view->font_height / 2;
229
230       r = xr_rendering_create (view->xr, item->item, cr);
231       if (r == NULL)
232         {
233           g_warn_if_reached ();
234           continue;
235         }
236
237       xr_rendering_measure (r, &tw, &th);
238
239       gint xpos = get_xpos (view, tw);
240
241       if (!item->drawing_area)
242         {
243           item->drawing_area = gtk_drawing_area_new ();
244           create_drawing_area (view, item->drawing_area, r, tw, th);
245         }
246       else
247         {
248           g_object_set_data_full (G_OBJECT (item->drawing_area),
249                                   "rendering", r, free_rendering);
250           gtk_widget_set_size_request (item->drawing_area, tw, th);
251           gtk_layout_move (view->output, item->drawing_area, xpos, view->y);
252         }
253
254       {
255         gint minw;
256         gint minh;
257         /* This code probably doesn't bring us anthing, but Gtk
258            shows warnings if get_preferred_width/height is not
259            called before the size_allocate below is called. */
260         gtk_widget_get_preferred_width (item->drawing_area, &minw, NULL);
261         gtk_widget_get_preferred_height (item->drawing_area, &minh, NULL);
262         if (th > minh) th = minh;
263         if (tw > minw) tw = minw;
264       }
265       alloc.x = xpos;
266       alloc.y = view->y;
267       alloc.width = tw;
268       alloc.height = th;
269
270       gtk_widget_size_allocate (item->drawing_area, &alloc);
271
272       if (view->max_width < tw)
273         view->max_width = tw;
274       view->y += th;
275     }
276
277   gtk_layout_set_size (view->output, view->max_width, view->y);
278   cairo_destroy (cr);
279 }
280
281 void
282 psppire_output_view_put (struct psppire_output_view *view,
283                          const struct output_item *item)
284 {
285   struct output_view_item *view_item;
286   GtkWidget *drawing_area;
287   struct xr_rendering *r;
288   struct string name;
289   GtkTreeStore *store;
290   cairo_t *cr = NULL;
291   GtkTreePath *path;
292   GtkTreeIter iter;
293   int tw, th;
294
295   if (is_text_item (item))
296     {
297       const struct text_item *text_item = to_text_item (item);
298       enum text_item_type type = text_item_get_type (text_item);
299       const char *text = text_item_get_text (text_item);
300
301       if (type == TEXT_ITEM_COMMAND_CLOSE)
302         {
303           view->in_command = false;
304           return;
305         }
306       else if (text[0] == '\0')
307         return;
308     }
309
310   if (view->n_items >= view->allocated_items)
311     view->items = x2nrealloc (view->items, &view->allocated_items,
312                                 sizeof *view->items);
313   view_item = &view->items[view->n_items++];
314   view_item->item = output_item_ref (item);
315   view_item->drawing_area = NULL;
316
317   if (gtk_widget_get_window (GTK_WIDGET (view->output)))
318     {
319       view_item->drawing_area = drawing_area = gtk_drawing_area_new ();
320
321       cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
322       if (view->xr == NULL)
323         create_xr (view);
324
325       if (view->y > 0)
326         view->y += view->font_height / 2;
327
328       r = xr_rendering_create (view->xr, item, cr);
329       if (r == NULL)
330         goto done;
331
332       xr_rendering_measure (r, &tw, &th);
333
334       create_drawing_area (view, drawing_area, r, tw, th);
335     }
336   else
337     tw = th = 0;
338
339   if (view->overview
340       && (!is_text_item (item)
341           || text_item_get_type (to_text_item (item)) != TEXT_ITEM_SYNTAX
342           || !view->in_command))
343     {
344       store = GTK_TREE_STORE (gtk_tree_view_get_model (view->overview));
345
346       ds_init_empty (&name);
347       if (is_text_item (item)
348           && text_item_get_type (to_text_item (item)) == TEXT_ITEM_COMMAND_OPEN)
349         {
350           gtk_tree_store_append (store, &iter, NULL);
351           view->cur_command = iter; /* XXX shouldn't save a GtkTreeIter */
352           view->in_command = true;
353         }
354       else
355         {
356           GtkTreeIter *p = view->in_command ? &view->cur_command : NULL;
357           gtk_tree_store_append (store, &iter, p);
358         }
359
360       ds_clear (&name);
361       if (is_text_item (item))
362         ds_put_cstr (&name, text_item_get_text (to_text_item (item)));
363       else if (is_message_item (item))
364         {
365           const struct message_item *msg_item = to_message_item (item);
366           const struct msg *msg = message_item_get_msg (msg_item);
367           ds_put_format (&name, "%s: %s", _("Message"),
368                          msg_severity_to_string (msg->severity));
369         }
370       else if (is_table_item (item))
371         {
372           const struct table_item_text *title
373             = table_item_get_title (to_table_item (item));
374           if (title != NULL)
375             ds_put_format (&name, "Table: %s", title->content);
376           else
377             ds_put_cstr (&name, "Table");
378         }
379       else if (is_chart_item (item))
380         {
381           const char *s = chart_item_get_title (to_chart_item (item));
382           if (s != NULL)
383             ds_put_format (&name, "Chart: %s", s);
384           else
385             ds_put_cstr (&name, "Chart");
386         }
387       gtk_tree_store_set (store, &iter,
388                           COL_NAME, ds_cstr (&name),
389                           COL_ADDR, item,
390                           COL_Y, (view->y),
391                           -1);
392       ds_destroy (&name);
393
394       path = gtk_tree_model_get_path (GTK_TREE_MODEL (store), &iter);
395       gtk_tree_view_expand_row (view->overview, path, TRUE);
396       gtk_tree_path_free (path);
397     }
398
399   if (view->max_width < tw)
400     view->max_width = tw;
401   view->y += th;
402
403   gtk_layout_set_size (view->output, view->max_width, view->y);
404
405 done:
406   cairo_destroy (cr);
407 }
408
409 static void
410 on_row_activate (GtkTreeView *overview,
411                  GtkTreePath *path,
412                  GtkTreeViewColumn *column,
413                  struct psppire_output_view *view)
414 {
415   GtkTreeModel *model;
416   GtkTreeIter iter;
417   GtkAdjustment *vadj;
418   GValue value = {0};
419   double y, min, max;
420
421   model = gtk_tree_view_get_model (overview);
422   if (!gtk_tree_model_get_iter (model, &iter, path))
423     return;
424
425   gtk_tree_model_get_value (model, &iter, COL_Y, &value);
426   y = g_value_get_long (&value);
427   g_value_unset (&value);
428
429   vadj = gtk_scrollable_get_vadjustment (GTK_SCROLLABLE (view->output));
430   min = gtk_adjustment_get_lower (vadj);
431   max = gtk_adjustment_get_upper (vadj) - gtk_adjustment_get_page_size (vadj);
432   if (y < min)
433     y = min;
434   else if (y > max)
435     y = max;
436   gtk_adjustment_set_value (vadj, y);
437 }
438
439 static void
440 on_style_updated (GtkWidget *toplevel, struct psppire_output_view *view)
441 {
442   if (!view->n_items || !gtk_widget_get_window (GTK_WIDGET (view->output)))
443     return;
444   string_map_clear (&view->render_opts);
445   xr_driver_destroy (view->xr);
446   create_xr (view);
447   rerender (view);
448 }
449
450 enum {
451   SELECT_FMT_NULL,
452   SELECT_FMT_TEXT,
453   SELECT_FMT_UTF8,
454   SELECT_FMT_HTML,
455   SELECT_FMT_ODT
456 };
457
458 /* GNU Hurd doesn't have PATH_MAX.  Use a fallback.
459    Temporary directory names are usually not that long.  */
460 #ifndef PATH_MAX
461 # define PATH_MAX 1024
462 #endif
463
464 static void
465 clipboard_get_cb (GtkClipboard     *clipboard,
466                   GtkSelectionData *selection_data,
467                   guint             info,
468                   gpointer          data)
469 {
470   struct psppire_output_view *view = data;
471
472   gsize length;
473   gchar *text = NULL;
474   struct output_driver *driver = NULL;
475   char dirname[PATH_MAX], *filename;
476   struct string_map options;
477
478   GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
479   GtkTreeModel *model = gtk_tree_view_get_model (view->overview);
480
481   GList *rows = gtk_tree_selection_get_selected_rows (sel, &model);
482   GList *n = rows;
483
484   if ( n == NULL)
485     return;
486
487   if (path_search (dirname, sizeof dirname, NULL, NULL, true)
488       || mkdtemp (dirname) == NULL)
489     {
490       msg_error (errno, _("failed to create temporary directory during clipboard operation"));
491       return;
492     }
493   filename = xasprintf ("%s/clip.tmp", dirname);
494
495   string_map_init (&options);
496   string_map_insert (&options, "output-file", filename);
497
498   switch (info)
499     {
500     case SELECT_FMT_UTF8:
501       string_map_insert (&options, "box", "unicode");
502       /* fall-through */
503
504     case SELECT_FMT_TEXT:
505       string_map_insert (&options, "format", "txt");
506       break;
507
508     case SELECT_FMT_HTML:
509       string_map_insert (&options, "format", "html");
510       string_map_insert (&options, "borders", "false");
511       string_map_insert (&options, "css", "false");
512       break;
513
514     case SELECT_FMT_ODT:
515       string_map_insert (&options, "format", "odt");
516       break;
517
518     default:
519       g_warning ("unsupported clip target\n");
520       goto finish;
521       break;
522     }
523
524   driver = output_driver_create (&options);
525   if (driver == NULL)
526     goto finish;
527
528   while (n)
529     {
530       GtkTreePath *path = n->data ;
531       GtkTreeIter iter;
532       struct output_item *item ;
533
534       gtk_tree_model_get_iter (model, &iter, path);
535       gtk_tree_model_get (model, &iter, COL_ADDR, &item, -1);
536
537       driver->class->submit (driver, item);
538
539       n = n->next;
540     }
541
542   if ( driver->class->flush)
543     driver->class->flush (driver);
544
545
546   /* Some drivers (eg: the odt one) don't write anything until they
547      are closed */
548   output_driver_destroy (driver);
549   driver = NULL;
550
551   if ( g_file_get_contents (filename, &text, &length, NULL) )
552     {
553       gtk_selection_data_set (selection_data, gtk_selection_data_get_target (selection_data),
554                               8,
555                               (const guchar *) text, length);
556     }
557
558  finish:
559
560   if (driver != NULL)
561     output_driver_destroy (driver);
562
563   g_free (text);
564
565   unlink (filename);
566   free (filename);
567   rmdir (dirname);
568
569   g_list_free (rows);
570 }
571
572 static void
573 clipboard_clear_cb (GtkClipboard *clipboard,
574                     gpointer data)
575 {
576 }
577
578 static const GtkTargetEntry targets[] = {
579
580   { "STRING",        0, SELECT_FMT_TEXT },
581   { "TEXT",          0, SELECT_FMT_TEXT },
582   { "COMPOUND_TEXT", 0, SELECT_FMT_TEXT },
583   { "text/plain",    0, SELECT_FMT_TEXT },
584
585   { "UTF8_STRING",   0, SELECT_FMT_UTF8 },
586   { "text/plain;charset=utf-8", 0, SELECT_FMT_UTF8 },
587
588   { "text/html",     0, SELECT_FMT_HTML },
589
590   { "application/vnd.oasis.opendocument.text", 0, SELECT_FMT_ODT }
591 };
592
593 static void
594 on_copy (struct psppire_output_view *view)
595 {
596   GtkWidget *widget = GTK_WIDGET (view->overview);
597   GtkClipboard *cb = gtk_widget_get_clipboard (widget, GDK_SELECTION_CLIPBOARD);
598
599   if (!gtk_clipboard_set_with_data (cb, targets, G_N_ELEMENTS (targets),
600                                     clipboard_get_cb, clipboard_clear_cb,
601                                     view))
602     clipboard_clear_cb (cb, view);
603 }
604
605 static void
606 on_selection_change (GtkTreeSelection *sel, GAction *copy_action)
607 {
608   /* The Copy action is available only if there is something selected */
609   g_object_set (copy_action,
610                 "enabled", gtk_tree_selection_count_selected_rows (sel) > 0,
611                 NULL);
612 }
613
614 static void
615 on_select_all (struct psppire_output_view *view)
616 {
617   GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
618   gtk_tree_view_expand_all (view->overview);
619   gtk_tree_selection_select_all (sel);
620 }
621
622 static void
623 on_size_allocate (GtkWidget    *widget,
624                   GdkRectangle *allocation,
625                   struct psppire_output_view *view)
626 {
627   int new_render_width = MAX (300, allocation->width);
628
629   if (view->render_width != new_render_width)
630     {
631       view->render_width = new_render_width;
632       rerender (view);
633     }
634 }
635
636 static void
637 on_realize (GtkWidget *overview, GObject *view)
638 {
639   GtkTreeSelection *sel = gtk_tree_view_get_selection (GTK_TREE_VIEW (overview));
640   gtk_tree_selection_set_mode (sel, GTK_SELECTION_MULTIPLE);
641
642   GtkWidget *toplevel = gtk_widget_get_toplevel (GTK_WIDGET (overview));
643
644   GAction *copy_action = g_action_map_lookup_action (G_ACTION_MAP (toplevel),
645                                                      "copy");
646
647   GAction *select_all_action = g_action_map_lookup_action (G_ACTION_MAP (toplevel),
648                                                            "select-all");
649
650   g_object_set (copy_action, "enabled", FALSE, NULL);
651
652   g_signal_connect_swapped (select_all_action, "activate",
653                             G_CALLBACK (on_select_all), view);
654
655   g_signal_connect_swapped (copy_action, "activate",
656                             G_CALLBACK (on_copy), view);
657
658   g_signal_connect (sel, "changed", G_CALLBACK (on_selection_change),
659                     copy_action);
660 }
661
662 struct psppire_output_view *
663 psppire_output_view_new (GtkLayout *output, GtkTreeView *overview)
664 {
665   struct psppire_output_view *view;
666   GtkTreeViewColumn *column;
667   GtkCellRenderer *renderer;
668
669   GtkTreeModel *model;
670
671   view = xmalloc (sizeof *view);
672   view->xr = NULL;
673   view->font_height = 0;
674   view->output = output;
675   view->render_width = 0;
676   view->max_width = 0;
677   view->y = 0;
678   string_map_init (&view->render_opts);
679   view->overview = overview;
680   memset (&view->cur_command, 0, sizeof view->cur_command);
681   view->in_command = false;
682   view->toplevel = gtk_widget_get_toplevel (GTK_WIDGET (output));
683   view->items = NULL;
684   view->n_items = view->allocated_items = 0;
685   view->print_settings = NULL;
686   view->print_xrd = NULL;
687   view->print_item = 0;
688   view->print_n_pages = 0;
689   view->paginated = FALSE;
690
691   g_signal_connect (output, "style-updated", G_CALLBACK (on_style_updated), view);
692
693   g_signal_connect (output, "size-allocate", G_CALLBACK (on_size_allocate), view);
694
695   gtk_style_context_add_class (gtk_widget_get_style_context (GTK_WIDGET (output)),
696                                GTK_STYLE_CLASS_VIEW);
697
698   if (overview)
699     {
700       g_signal_connect (overview, "realize", G_CALLBACK (on_realize), view);
701
702       model = GTK_TREE_MODEL (gtk_tree_store_new (
703                                 N_COLS,
704                                 G_TYPE_STRING,  /* COL_NAME */
705                                 G_TYPE_POINTER, /* COL_ADDR */
706                                 G_TYPE_LONG));  /* COL_Y */
707       gtk_tree_view_set_model (overview, model);
708       g_object_unref (model);
709
710       column = gtk_tree_view_column_new ();
711       gtk_tree_view_append_column (GTK_TREE_VIEW (overview), column);
712       renderer = gtk_cell_renderer_text_new ();
713       gtk_tree_view_column_pack_start (column, renderer, TRUE);
714       gtk_tree_view_column_add_attribute (column, renderer, "text", COL_NAME);
715
716       g_signal_connect (GTK_TREE_VIEW (overview),
717                         "row-activated", G_CALLBACK (on_row_activate), view);
718     }
719
720   return view;
721 }
722
723 void
724 psppire_output_view_destroy (struct psppire_output_view *view)
725 {
726   size_t i;
727
728   if (!view)
729     return;
730
731   g_signal_handlers_disconnect_by_func (view->output,
732                                         G_CALLBACK (on_style_updated), view);
733
734   string_map_destroy (&view->render_opts);
735
736   for (i = 0; i < view->n_items; i++)
737     output_item_unref (view->items[i].item);
738   free (view->items);
739   view->items = NULL;
740   view->n_items = view->allocated_items = 0;
741
742   if (view->print_settings != NULL)
743     g_object_unref (view->print_settings);
744
745   xr_driver_destroy (view->xr);
746
747   free (view);
748 }
749
750 void
751 psppire_output_view_clear (struct psppire_output_view *view)
752 {
753   size_t i;
754
755   view->max_width = 0;
756   view->y = 0;
757
758   for (i = 0; i < view->n_items; i++)
759     {
760       gtk_container_remove (GTK_CONTAINER (view->output),
761                             view->items[i].drawing_area);
762       output_item_unref (view->items[i].item);
763     }
764   free (view->items);
765   view->items = NULL;
766   view->n_items = view->allocated_items = 0;
767 }
768
769 /* Export. */
770
771 void
772 psppire_output_view_export (struct psppire_output_view *view,
773                             struct string_map *options)
774 {
775   struct output_driver *driver;
776
777   driver = output_driver_create (options);
778   if (driver)
779     {
780       size_t i;
781
782       for (i = 0; i < view->n_items; i++)
783         driver->class->submit (driver, view->items[i].item);
784       output_driver_destroy (driver);
785     }
786 }
787 \f
788 /* Print. */
789
790 static cairo_t *
791 get_cairo_context_from_print_context (GtkPrintContext *context)
792 {
793   cairo_t *cr = gtk_print_context_get_cairo_context (context);
794
795   /*
796     For all platforms except windows, gtk_print_context_get_dpi_[xy] returns 72.
797     Windows returns 600.
798   */
799   double xres = gtk_print_context_get_dpi_x (context);
800   double yres = gtk_print_context_get_dpi_y (context);
801
802   /* This means that the cairo context now has its dimensions in Points */
803   cairo_scale (cr, xres / 72.0, yres / 72.0);
804
805   return cr;
806 }
807
808
809 static void
810 create_xr_print_driver (GtkPrintContext *context, struct psppire_output_view *view)
811 {
812   struct string_map options;
813   GtkPageSetup *page_setup;
814   double width, height;
815   double left_margin;
816   double right_margin;
817   double top_margin;
818   double bottom_margin;
819
820   page_setup = gtk_print_context_get_page_setup (context);
821   width = gtk_page_setup_get_paper_width (page_setup, GTK_UNIT_MM);
822   height = gtk_page_setup_get_paper_height (page_setup, GTK_UNIT_MM);
823   left_margin = gtk_page_setup_get_left_margin (page_setup, GTK_UNIT_MM);
824   right_margin = gtk_page_setup_get_right_margin (page_setup, GTK_UNIT_MM);
825   top_margin = gtk_page_setup_get_top_margin (page_setup, GTK_UNIT_MM);
826   bottom_margin = gtk_page_setup_get_bottom_margin (page_setup, GTK_UNIT_MM);
827
828   string_map_init (&options);
829   string_map_insert_nocopy (&options, xstrdup ("paper-size"),
830                             c_xasprintf("%.2fx%.2fmm", width, height));
831   string_map_insert_nocopy (&options, xstrdup ("left-margin"),
832                             c_xasprintf ("%.2fmm", left_margin));
833   string_map_insert_nocopy (&options, xstrdup ("right-margin"),
834                             c_xasprintf ("%.2fmm", right_margin));
835   string_map_insert_nocopy (&options, xstrdup ("top-margin"),
836                             c_xasprintf ("%.2fmm", top_margin));
837   string_map_insert_nocopy (&options, xstrdup ("bottom-margin"),
838                             c_xasprintf ("%.2fmm", bottom_margin));
839
840   view->print_xrd = xr_driver_create (get_cairo_context_from_print_context (context), &options);
841
842   string_map_destroy (&options);
843 }
844
845 static gboolean
846 paginate (GtkPrintOperation *operation,
847           GtkPrintContext   *context,
848           struct psppire_output_view *view)
849 {
850   if (view->paginated)
851     {
852       /* Sometimes GTK+ emits this signal again even after pagination is
853          complete.  Don't let that screw up printing. */
854       return TRUE;
855     }
856   else if ( view->print_item < view->n_items )
857     {
858       xr_driver_output_item (view->print_xrd,
859                              view->items[view->print_item++].item);
860       while (xr_driver_need_new_page (view->print_xrd))
861         {
862           xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
863           view->print_n_pages ++;
864         }
865       return FALSE;
866     }
867   else
868     {
869       gtk_print_operation_set_n_pages (operation, view->print_n_pages);
870
871       /* Re-create the driver to do the real printing. */
872       xr_driver_destroy (view->print_xrd);
873       create_xr_print_driver (context, view);
874       view->print_item = 0;
875       view->paginated = TRUE;
876
877       return TRUE;
878     }
879 }
880
881 static void
882 begin_print (GtkPrintOperation *operation,
883              GtkPrintContext   *context,
884              struct psppire_output_view *view)
885 {
886   create_xr_print_driver (context, view);
887
888   view->print_item = 0;
889   view->print_n_pages = 1;
890   view->paginated = FALSE;
891 }
892
893 static void
894 end_print (GtkPrintOperation *operation,
895            GtkPrintContext   *context,
896            struct psppire_output_view *view)
897 {
898   xr_driver_destroy (view->print_xrd);
899 }
900
901
902 static void
903 draw_page (GtkPrintOperation *operation,
904            GtkPrintContext   *context,
905            gint               page_number,
906            struct psppire_output_view *view)
907 {
908   xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
909   while (!xr_driver_need_new_page (view->print_xrd)
910          && view->print_item < view->n_items)
911     xr_driver_output_item (view->print_xrd, view->items [view->print_item++].item);
912 }
913
914
915 void
916 psppire_output_view_print (struct psppire_output_view *view,
917                            GtkWindow *parent_window)
918 {
919   GtkPrintOperationResult res;
920
921   GtkPrintOperation *print = gtk_print_operation_new ();
922
923   if (view->print_settings != NULL)
924     gtk_print_operation_set_print_settings (print, view->print_settings);
925
926   g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), view);
927   g_signal_connect (print, "end_print",   G_CALLBACK (end_print),   view);
928   g_signal_connect (print, "paginate",    G_CALLBACK (paginate),    view);
929   g_signal_connect (print, "draw_page",   G_CALLBACK (draw_page),   view);
930
931   res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
932                                  parent_window, NULL);
933
934   if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
935     {
936       if (view->print_settings != NULL)
937         g_object_unref (view->print_settings);
938       view->print_settings = g_object_ref (gtk_print_operation_get_print_settings (print));
939     }
940
941   g_object_unref (print);
942 }
943 \f
944 struct psppire_output_view_driver
945   {
946     struct output_driver driver;
947     struct psppire_output_view *view;
948   };
949
950 static struct psppire_output_view_driver *
951 psppire_output_view_driver_cast (struct output_driver *driver)
952 {
953   return UP_CAST (driver, struct psppire_output_view_driver, driver);
954 }
955
956 static void
957 psppire_output_view_submit (struct output_driver *this,
958                             const struct output_item *item)
959 {
960   struct psppire_output_view_driver *povd = psppire_output_view_driver_cast (this);
961
962   if (is_table_item (item))
963     psppire_output_view_put (povd->view, item);
964 }
965
966 static struct output_driver_class psppire_output_view_driver_class =
967   {
968     "PSPPIRE Output View",      /* name */
969     NULL,                       /* destroy */
970     psppire_output_view_submit, /* submit */
971     NULL,                       /* flush */
972   };
973
974 void
975 psppire_output_view_register_driver (struct psppire_output_view *view)
976 {
977   struct psppire_output_view_driver *povd;
978   struct output_driver *d;
979
980   povd = xzalloc (sizeof *povd);
981   povd->view = view;
982   d = &povd->driver;
983   output_driver_init (d, &psppire_output_view_driver_class, "PSPPIRE Output View",
984                       SETTINGS_DEVICE_UNFILTERED);
985   output_driver_register (d);
986 }