1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2008-2015 Free Software Foundation.
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.
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.
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/>. */
19 #include "ui/gui/psppire-output-view.h"
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"
35 #include "gl/c-xvasprintf.h"
36 #include "gl/minmax.h"
37 #include "gl/tmpdir.h"
38 #include "gl/xalloc.h"
41 #define _(msgid) gettext (msgid)
43 struct output_view_item
45 struct output_item *item;
46 GtkWidget *drawing_area;
49 struct psppire_output_view
59 struct string_map render_opts;
60 GtkTreeView *overview;
61 GtkTreeIter cur_command;
66 struct output_view_item *items;
67 size_t n_items, allocated_items;
69 /* Variables pertaining to printing */
70 GtkPrintSettings *print_settings;
71 struct xr_driver *print_xrd;
79 COL_NAME, /* Table name. */
80 COL_ADDR, /* Pointer to the table */
81 COL_Y, /* Y position of top of name. */
86 draw_callback (GtkWidget *widget, cairo_t *cr, gpointer data)
88 struct xr_rendering *r = g_object_get_data (G_OBJECT (widget), "rendering");
89 xr_rendering_draw_all (r, cr);
94 free_rendering (gpointer rendering_)
96 struct xr_rendering *rendering = rendering_;
97 xr_rendering_destroy (rendering);
101 create_xr (struct psppire_output_view *view)
103 struct text_item *text_item;
104 PangoFontDescription *font_desc;
105 struct xr_rendering *r;
111 GtkStyleContext *context = gtk_widget_get_style_context (GTK_WIDGET (view->output));
112 GtkStateFlags state = gtk_widget_get_state_flags (GTK_WIDGET (view->output));
115 gtk_style_context_get (context, state,
116 "font", &font_desc, "color", &fg_color, NULL);
118 cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
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);
127 gdk_rgba_free (fg_color);
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);
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);
139 pango_font_description_free (font_desc);
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
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");
153 view->xr = xr_driver_create (cr, &view->render_opts);
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);
164 create_drawing_area (struct psppire_output_view *view,
165 GtkWidget *drawing_area, struct xr_rendering *r,
168 g_object_set_data_full (G_OBJECT (drawing_area),
169 "rendering", r, free_rendering);
171 g_signal_connect (drawing_area, "draw",
172 G_CALLBACK (draw_callback), view);
174 gtk_widget_set_size_request (drawing_area, tw, th);
175 gtk_layout_put (view->output, drawing_area, 0, view->y);
177 gtk_widget_show (drawing_area);
181 rerender (struct psppire_output_view *view)
183 struct output_view_item *item;
186 if (!view->n_items || !gtk_widget_get_window (GTK_WIDGET (view->output)))
189 cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
190 if (view->xr == NULL)
194 for (item = view->items; item < &view->items[view->n_items]; item++)
196 struct xr_rendering *r;
201 view->y += view->font_height / 2;
203 r = xr_rendering_create (view->xr, item->item, cr);
206 g_warn_if_reached ();
210 xr_rendering_measure (r, &tw, &th);
212 if (!item->drawing_area)
214 item->drawing_area = gtk_drawing_area_new ();
215 create_drawing_area (view, item->drawing_area, r, tw, th);
219 g_object_set_data_full (G_OBJECT (item->drawing_area),
220 "rendering", r, free_rendering);
221 gtk_widget_set_size_request (item->drawing_area, tw, th);
222 gtk_layout_move (view->output, item->drawing_area, 0, view->y);
229 gtk_widget_size_allocate(item->drawing_area,&alloc);
231 if (view->max_width < tw)
232 view->max_width = tw;
236 gtk_layout_set_size (view->output, view->max_width, view->y);
241 psppire_output_view_put (struct psppire_output_view *view,
242 const struct output_item *item)
244 struct output_view_item *view_item;
245 GtkWidget *drawing_area;
246 struct xr_rendering *r;
254 if (is_text_item (item))
256 const struct text_item *text_item = to_text_item (item);
257 enum text_item_type type = text_item_get_type (text_item);
258 const char *text = text_item_get_text (text_item);
260 if (type == TEXT_ITEM_COMMAND_CLOSE)
262 view->in_command = false;
265 else if (text[0] == '\0')
269 if (view->n_items >= view->allocated_items)
270 view->items = x2nrealloc (view->items, &view->allocated_items,
271 sizeof *view->items);
272 view_item = &view->items[view->n_items++];
273 view_item->item = output_item_ref (item);
274 view_item->drawing_area = NULL;
276 if (gtk_widget_get_window (GTK_WIDGET (view->output)))
278 view_item->drawing_area = drawing_area = gtk_drawing_area_new ();
280 cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
281 if (view->xr == NULL)
285 view->y += view->font_height / 2;
287 r = xr_rendering_create (view->xr, item, cr);
291 xr_rendering_measure (r, &tw, &th);
293 create_drawing_area (view, drawing_area, r, tw, th);
299 && (!is_text_item (item)
300 || text_item_get_type (to_text_item (item)) != TEXT_ITEM_SYNTAX
301 || !view->in_command))
303 store = GTK_TREE_STORE (gtk_tree_view_get_model (view->overview));
305 ds_init_empty (&name);
306 if (is_text_item (item)
307 && text_item_get_type (to_text_item (item)) == TEXT_ITEM_COMMAND_OPEN)
309 gtk_tree_store_append (store, &iter, NULL);
310 view->cur_command = iter; /* XXX shouldn't save a GtkTreeIter */
311 view->in_command = true;
315 GtkTreeIter *p = view->in_command ? &view->cur_command : NULL;
316 gtk_tree_store_append (store, &iter, p);
320 if (is_text_item (item))
321 ds_put_cstr (&name, text_item_get_text (to_text_item (item)));
322 else if (is_message_item (item))
324 const struct message_item *msg_item = to_message_item (item);
325 const struct msg *msg = message_item_get_msg (msg_item);
326 ds_put_format (&name, "%s: %s", _("Message"),
327 msg_severity_to_string (msg->severity));
329 else if (is_table_item (item))
331 const char *title = table_item_get_title (to_table_item (item));
333 ds_put_format (&name, "Table: %s", title);
335 ds_put_cstr (&name, "Table");
337 else if (is_chart_item (item))
339 const char *s = chart_item_get_title (to_chart_item (item));
341 ds_put_format (&name, "Chart: %s", s);
343 ds_put_cstr (&name, "Chart");
345 gtk_tree_store_set (store, &iter,
346 COL_NAME, ds_cstr (&name),
352 path = gtk_tree_model_get_path (GTK_TREE_MODEL (store), &iter);
353 gtk_tree_view_expand_row (view->overview, path, TRUE);
354 gtk_tree_path_free (path);
357 if (view->max_width < tw)
358 view->max_width = tw;
361 gtk_layout_set_size (view->output, view->max_width, view->y);
368 on_row_activate (GtkTreeView *overview,
370 GtkTreeViewColumn *column,
371 struct psppire_output_view *view)
379 model = gtk_tree_view_get_model (overview);
380 if (!gtk_tree_model_get_iter (model, &iter, path))
383 gtk_tree_model_get_value (model, &iter, COL_Y, &value);
384 y = g_value_get_long (&value);
385 g_value_unset (&value);
387 vadj = gtk_scrollable_get_vadjustment (GTK_SCROLLABLE (view->output));
388 min = gtk_adjustment_get_lower (vadj);
389 max = gtk_adjustment_get_upper (vadj) - gtk_adjustment_get_page_size (vadj);
394 gtk_adjustment_set_value (vadj, y);
398 on_style_updated (GtkWidget *toplevel, struct psppire_output_view *view)
400 if (!view->n_items || !gtk_widget_get_window (GTK_WIDGET (view->output)))
402 string_map_clear (&view->render_opts);
403 xr_driver_destroy (view->xr);
416 /* GNU Hurd doesn't have PATH_MAX. Use a fallback.
417 Temporary directory names are usually not that long. */
419 # define PATH_MAX 1024
423 clipboard_get_cb (GtkClipboard *clipboard,
424 GtkSelectionData *selection_data,
428 struct psppire_output_view *view = data;
432 struct output_driver *driver = NULL;
433 char dirname[PATH_MAX], *filename;
434 struct string_map options;
436 GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
437 GtkTreeModel *model = gtk_tree_view_get_model (view->overview);
439 GList *rows = gtk_tree_selection_get_selected_rows (sel, &model);
445 if (path_search (dirname, sizeof dirname, NULL, NULL, true)
446 || mkdtemp (dirname) == NULL)
448 msg_error (errno, _("failed to create temporary directory during clipboard operation"));
451 filename = xasprintf ("%s/clip.tmp", dirname);
453 string_map_init (&options);
454 string_map_insert (&options, "output-file", filename);
458 case SELECT_FMT_UTF8:
459 string_map_insert (&options, "box", "unicode");
462 case SELECT_FMT_TEXT:
463 string_map_insert (&options, "format", "txt");
466 case SELECT_FMT_HTML:
467 string_map_insert (&options, "format", "html");
468 string_map_insert (&options, "borders", "false");
469 string_map_insert (&options, "css", "false");
473 string_map_insert (&options, "format", "odt");
477 g_warning ("unsupported clip target\n");
482 driver = output_driver_create (&options);
488 GtkTreePath *path = n->data ;
490 struct output_item *item ;
492 gtk_tree_model_get_iter (model, &iter, path);
493 gtk_tree_model_get (model, &iter, COL_ADDR, &item, -1);
495 driver->class->submit (driver, item);
500 if ( driver->class->flush)
501 driver->class->flush (driver);
504 /* Some drivers (eg: the odt one) don't write anything until they
506 output_driver_destroy (driver);
509 if ( g_file_get_contents (filename, &text, &length, NULL) )
511 gtk_selection_data_set (selection_data, gtk_selection_data_get_target (selection_data),
513 (const guchar *) text, length);
519 output_driver_destroy (driver);
531 clipboard_clear_cb (GtkClipboard *clipboard,
536 static const GtkTargetEntry targets[] = {
538 { "STRING", 0, SELECT_FMT_TEXT },
539 { "TEXT", 0, SELECT_FMT_TEXT },
540 { "COMPOUND_TEXT", 0, SELECT_FMT_TEXT },
541 { "text/plain", 0, SELECT_FMT_TEXT },
543 { "UTF8_STRING", 0, SELECT_FMT_UTF8 },
544 { "text/plain;charset=utf-8", 0, SELECT_FMT_UTF8 },
546 { "text/html", 0, SELECT_FMT_HTML },
548 { "application/vnd.oasis.opendocument.text", 0, SELECT_FMT_ODT }
552 on_copy (struct psppire_output_view *view)
554 GtkWidget *widget = GTK_WIDGET (view->overview);
555 GtkClipboard *cb = gtk_widget_get_clipboard (widget, GDK_SELECTION_CLIPBOARD);
557 if (!gtk_clipboard_set_with_data (cb, targets, G_N_ELEMENTS (targets),
558 clipboard_get_cb, clipboard_clear_cb,
560 clipboard_clear_cb (cb, view);
564 on_selection_change (GtkTreeSelection *sel, GtkAction *copy_action)
566 /* The Copy action is available only if there is something selected */
567 gtk_action_set_sensitive (copy_action, gtk_tree_selection_count_selected_rows (sel) > 0);
571 on_select_all (struct psppire_output_view *view)
573 GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
574 gtk_tree_view_expand_all (view->overview);
575 gtk_tree_selection_select_all (sel);
579 on_size_allocate (GtkWidget *widget,
580 GdkRectangle *allocation,
581 struct psppire_output_view *view)
583 int new_render_width = MAX (300, allocation->width);
585 if (view->render_width != new_render_width)
587 view->render_width = new_render_width;
592 struct psppire_output_view *
593 psppire_output_view_new (GtkLayout *output, GtkTreeView *overview,
594 GtkAction *copy_action, GtkAction *select_all_action)
596 struct psppire_output_view *view;
597 GtkTreeViewColumn *column;
598 GtkCellRenderer *renderer;
599 GtkTreeSelection *sel;
602 view = xmalloc (sizeof *view);
604 view->font_height = 0;
605 view->output = output;
606 view->render_width = 0;
609 string_map_init (&view->render_opts);
610 view->overview = overview;
611 memset (&view->cur_command, 0, sizeof view->cur_command);
612 view->in_command = false;
613 view->toplevel = gtk_widget_get_toplevel (GTK_WIDGET (output));
615 view->n_items = view->allocated_items = 0;
616 view->print_settings = NULL;
617 view->print_xrd = NULL;
618 view->print_item = 0;
619 view->print_n_pages = 0;
620 view->paginated = FALSE;
622 g_signal_connect (output, "style-updated", G_CALLBACK (on_style_updated), view);
624 g_signal_connect (output, "size-allocate", G_CALLBACK (on_size_allocate), view);
626 gtk_style_context_add_class (gtk_widget_get_style_context (GTK_WIDGET (output)),
627 GTK_STYLE_CLASS_VIEW);
631 model = GTK_TREE_MODEL (gtk_tree_store_new (
633 G_TYPE_STRING, /* COL_NAME */
634 G_TYPE_POINTER, /* COL_ADDR */
635 G_TYPE_LONG)); /* COL_Y */
636 gtk_tree_view_set_model (overview, model);
637 g_object_unref (model);
639 sel = gtk_tree_view_get_selection (overview);
640 gtk_tree_selection_set_mode (sel, GTK_SELECTION_MULTIPLE);
641 g_signal_connect (sel, "changed", G_CALLBACK (on_selection_change),
644 column = gtk_tree_view_column_new ();
645 gtk_tree_view_append_column (GTK_TREE_VIEW (overview), column);
646 renderer = gtk_cell_renderer_text_new ();
647 gtk_tree_view_column_pack_start (column, renderer, TRUE);
648 gtk_tree_view_column_add_attribute (column, renderer, "text", COL_NAME);
650 g_signal_connect (GTK_TREE_VIEW (overview),
651 "row-activated", G_CALLBACK (on_row_activate), view);
653 gtk_action_set_sensitive (copy_action, FALSE);
654 g_signal_connect_swapped (copy_action, "activate",
655 G_CALLBACK (on_copy), view);
656 g_signal_connect_swapped (select_all_action, "activate",
657 G_CALLBACK (on_select_all), view);
664 psppire_output_view_destroy (struct psppire_output_view *view)
671 g_signal_handlers_disconnect_by_func (view->output,
672 G_CALLBACK (on_style_updated), view);
674 string_map_destroy (&view->render_opts);
676 for (i = 0; i < view->n_items; i++)
677 output_item_unref (view->items[i].item);
680 view->n_items = view->allocated_items = 0;
682 if (view->print_settings != NULL)
683 g_object_unref (view->print_settings);
685 xr_driver_destroy (view->xr);
691 psppire_output_view_clear (struct psppire_output_view *view)
698 for (i = 0; i < view->n_items; i++)
700 gtk_container_remove (GTK_CONTAINER (view->output),
701 view->items[i].drawing_area);
702 output_item_unref (view->items[i].item);
706 view->n_items = view->allocated_items = 0;
712 psppire_output_view_export (struct psppire_output_view *view,
713 struct string_map *options)
715 struct output_driver *driver;
717 driver = output_driver_create (options);
722 for (i = 0; i < view->n_items; i++)
723 driver->class->submit (driver, view->items[i].item);
724 output_driver_destroy (driver);
731 get_cairo_context_from_print_context (GtkPrintContext *context)
733 cairo_t *cr = gtk_print_context_get_cairo_context (context);
736 For all platforms except windows, gtk_print_context_get_dpi_[xy] returns 72.
739 double xres = gtk_print_context_get_dpi_x (context);
740 double yres = gtk_print_context_get_dpi_y (context);
742 /* This means that the cairo context now has its dimensions in Points */
743 cairo_scale (cr, xres / 72.0, yres / 72.0);
750 create_xr_print_driver (GtkPrintContext *context, struct psppire_output_view *view)
752 struct string_map options;
753 GtkPageSetup *page_setup;
754 double width, height;
758 double bottom_margin;
760 page_setup = gtk_print_context_get_page_setup (context);
761 width = gtk_page_setup_get_paper_width (page_setup, GTK_UNIT_MM);
762 height = gtk_page_setup_get_paper_height (page_setup, GTK_UNIT_MM);
763 left_margin = gtk_page_setup_get_left_margin (page_setup, GTK_UNIT_MM);
764 right_margin = gtk_page_setup_get_right_margin (page_setup, GTK_UNIT_MM);
765 top_margin = gtk_page_setup_get_top_margin (page_setup, GTK_UNIT_MM);
766 bottom_margin = gtk_page_setup_get_bottom_margin (page_setup, GTK_UNIT_MM);
768 string_map_init (&options);
769 string_map_insert_nocopy (&options, xstrdup ("paper-size"),
770 c_xasprintf("%.2fx%.2fmm", width, height));
771 string_map_insert_nocopy (&options, xstrdup ("left-margin"),
772 c_xasprintf ("%.2fmm", left_margin));
773 string_map_insert_nocopy (&options, xstrdup ("right-margin"),
774 c_xasprintf ("%.2fmm", right_margin));
775 string_map_insert_nocopy (&options, xstrdup ("top-margin"),
776 c_xasprintf ("%.2fmm", top_margin));
777 string_map_insert_nocopy (&options, xstrdup ("bottom-margin"),
778 c_xasprintf ("%.2fmm", bottom_margin));
780 view->print_xrd = xr_driver_create (get_cairo_context_from_print_context (context), &options);
782 string_map_destroy (&options);
786 paginate (GtkPrintOperation *operation,
787 GtkPrintContext *context,
788 struct psppire_output_view *view)
792 /* Sometimes GTK+ emits this signal again even after pagination is
793 complete. Don't let that screw up printing. */
796 else if ( view->print_item < view->n_items )
798 xr_driver_output_item (view->print_xrd,
799 view->items[view->print_item++].item);
800 while (xr_driver_need_new_page (view->print_xrd))
802 xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
803 view->print_n_pages ++;
809 gtk_print_operation_set_n_pages (operation, view->print_n_pages);
811 /* Re-create the driver to do the real printing. */
812 xr_driver_destroy (view->print_xrd);
813 create_xr_print_driver (context, view);
814 view->print_item = 0;
815 view->paginated = TRUE;
822 begin_print (GtkPrintOperation *operation,
823 GtkPrintContext *context,
824 struct psppire_output_view *view)
826 create_xr_print_driver (context, view);
828 view->print_item = 0;
829 view->print_n_pages = 1;
830 view->paginated = FALSE;
834 end_print (GtkPrintOperation *operation,
835 GtkPrintContext *context,
836 struct psppire_output_view *view)
838 xr_driver_destroy (view->print_xrd);
843 draw_page (GtkPrintOperation *operation,
844 GtkPrintContext *context,
846 struct psppire_output_view *view)
848 xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
849 while (!xr_driver_need_new_page (view->print_xrd)
850 && view->print_item < view->n_items)
851 xr_driver_output_item (view->print_xrd, view->items [view->print_item++].item);
856 psppire_output_view_print (struct psppire_output_view *view,
857 GtkWindow *parent_window)
859 GtkPrintOperationResult res;
861 GtkPrintOperation *print = gtk_print_operation_new ();
863 if (view->print_settings != NULL)
864 gtk_print_operation_set_print_settings (print, view->print_settings);
866 g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), view);
867 g_signal_connect (print, "end_print", G_CALLBACK (end_print), view);
868 g_signal_connect (print, "paginate", G_CALLBACK (paginate), view);
869 g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), view);
871 res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
872 parent_window, NULL);
874 if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
876 if (view->print_settings != NULL)
877 g_object_unref (view->print_settings);
878 view->print_settings = g_object_ref (gtk_print_operation_get_print_settings (print));
881 g_object_unref (print);
884 struct psppire_output_view_driver
886 struct output_driver driver;
887 struct psppire_output_view *view;
890 static struct psppire_output_view_driver *
891 psppire_output_view_driver_cast (struct output_driver *driver)
893 return UP_CAST (driver, struct psppire_output_view_driver, driver);
897 psppire_output_view_submit (struct output_driver *this,
898 const struct output_item *item)
900 struct psppire_output_view_driver *povd = psppire_output_view_driver_cast (this);
902 if (is_table_item (item))
903 psppire_output_view_put (povd->view, item);
906 static struct output_driver_class psppire_output_view_driver_class =
908 "PSPPIRE Output View", /* name */
910 psppire_output_view_submit, /* submit */
915 psppire_output_view_register_driver (struct psppire_output_view *view)
917 struct psppire_output_view_driver *povd;
918 struct output_driver *d;
920 povd = xzalloc (sizeof *povd);
923 output_driver_init (d, &psppire_output_view_driver_class, "PSPPIRE Output View",
924 SETTINGS_DEVICE_UNFILTERED);
925 output_driver_register (d);