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 /* Enable this to help with debugging. It shows you which widgets are being
172 GdkRGBA green = {0, 1, 0, 1};
173 gtk_widget_override_background_color (view->output, GTK_STATE_NORMAL, &green);
174 GdkRGBA red = {1, 0, 0, 1};
175 gtk_widget_override_background_color (drawing_area, GTK_STATE_NORMAL, &red);
178 g_object_set_data_full (G_OBJECT (drawing_area),
179 "rendering", r, free_rendering);
181 g_signal_connect (drawing_area, "draw",
182 G_CALLBACK (draw_callback), view);
184 gtk_widget_set_size_request (drawing_area, tw, th);
185 gtk_layout_put (view->output, drawing_area, 0, view->y);
187 gtk_widget_show (drawing_area);
191 rerender (struct psppire_output_view *view)
193 struct output_view_item *item;
196 if (!view->n_items || !gtk_widget_get_window (GTK_WIDGET (view->output)))
199 cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
200 if (view->xr == NULL)
204 for (item = view->items; item < &view->items[view->n_items]; item++)
206 struct xr_rendering *r;
211 view->y += view->font_height / 2;
213 r = xr_rendering_create (view->xr, item->item, cr);
216 g_warn_if_reached ();
220 xr_rendering_measure (r, &tw, &th);
222 if (!item->drawing_area)
224 item->drawing_area = gtk_drawing_area_new ();
225 create_drawing_area (view, item->drawing_area, r, tw, th);
229 g_object_set_data_full (G_OBJECT (item->drawing_area),
230 "rendering", r, free_rendering);
231 gtk_widget_set_size_request (item->drawing_area, tw, th);
232 gtk_layout_move (view->output, item->drawing_area, 0, view->y);
239 gtk_widget_size_allocate(item->drawing_area,&alloc);
241 if (view->max_width < tw)
242 view->max_width = tw;
246 gtk_layout_set_size (view->output, view->max_width, view->y);
251 psppire_output_view_put (struct psppire_output_view *view,
252 const struct output_item *item)
254 struct output_view_item *view_item;
255 GtkWidget *drawing_area;
256 struct xr_rendering *r;
264 if (is_text_item (item))
266 const struct text_item *text_item = to_text_item (item);
267 enum text_item_type type = text_item_get_type (text_item);
268 const char *text = text_item_get_text (text_item);
270 if (type == TEXT_ITEM_COMMAND_CLOSE)
272 view->in_command = false;
275 else if (text[0] == '\0')
279 if (view->n_items >= view->allocated_items)
280 view->items = x2nrealloc (view->items, &view->allocated_items,
281 sizeof *view->items);
282 view_item = &view->items[view->n_items++];
283 view_item->item = output_item_ref (item);
284 view_item->drawing_area = NULL;
286 if (gtk_widget_get_window (GTK_WIDGET (view->output)))
288 view_item->drawing_area = drawing_area = gtk_drawing_area_new ();
290 cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
291 if (view->xr == NULL)
295 view->y += view->font_height / 2;
297 r = xr_rendering_create (view->xr, item, cr);
301 xr_rendering_measure (r, &tw, &th);
303 create_drawing_area (view, drawing_area, r, tw, th);
309 && (!is_text_item (item)
310 || text_item_get_type (to_text_item (item)) != TEXT_ITEM_SYNTAX
311 || !view->in_command))
313 store = GTK_TREE_STORE (gtk_tree_view_get_model (view->overview));
315 ds_init_empty (&name);
316 if (is_text_item (item)
317 && text_item_get_type (to_text_item (item)) == TEXT_ITEM_COMMAND_OPEN)
319 gtk_tree_store_append (store, &iter, NULL);
320 view->cur_command = iter; /* XXX shouldn't save a GtkTreeIter */
321 view->in_command = true;
325 GtkTreeIter *p = view->in_command ? &view->cur_command : NULL;
326 gtk_tree_store_append (store, &iter, p);
330 if (is_text_item (item))
331 ds_put_cstr (&name, text_item_get_text (to_text_item (item)));
332 else if (is_message_item (item))
334 const struct message_item *msg_item = to_message_item (item);
335 const struct msg *msg = message_item_get_msg (msg_item);
336 ds_put_format (&name, "%s: %s", _("Message"),
337 msg_severity_to_string (msg->severity));
339 else if (is_table_item (item))
341 const char *title = table_item_get_title (to_table_item (item));
343 ds_put_format (&name, "Table: %s", title);
345 ds_put_cstr (&name, "Table");
347 else if (is_chart_item (item))
349 const char *s = chart_item_get_title (to_chart_item (item));
351 ds_put_format (&name, "Chart: %s", s);
353 ds_put_cstr (&name, "Chart");
355 gtk_tree_store_set (store, &iter,
356 COL_NAME, ds_cstr (&name),
362 path = gtk_tree_model_get_path (GTK_TREE_MODEL (store), &iter);
363 gtk_tree_view_expand_row (view->overview, path, TRUE);
364 gtk_tree_path_free (path);
367 if (view->max_width < tw)
368 view->max_width = tw;
371 gtk_layout_set_size (view->output, view->max_width, view->y);
378 on_row_activate (GtkTreeView *overview,
380 GtkTreeViewColumn *column,
381 struct psppire_output_view *view)
389 model = gtk_tree_view_get_model (overview);
390 if (!gtk_tree_model_get_iter (model, &iter, path))
393 gtk_tree_model_get_value (model, &iter, COL_Y, &value);
394 y = g_value_get_long (&value);
395 g_value_unset (&value);
397 vadj = gtk_scrollable_get_vadjustment (GTK_SCROLLABLE (view->output));
398 min = gtk_adjustment_get_lower (vadj);
399 max = gtk_adjustment_get_upper (vadj) - gtk_adjustment_get_page_size (vadj);
404 gtk_adjustment_set_value (vadj, y);
408 on_style_updated (GtkWidget *toplevel, struct psppire_output_view *view)
410 if (!view->n_items || !gtk_widget_get_window (GTK_WIDGET (view->output)))
412 string_map_clear (&view->render_opts);
413 xr_driver_destroy (view->xr);
426 /* GNU Hurd doesn't have PATH_MAX. Use a fallback.
427 Temporary directory names are usually not that long. */
429 # define PATH_MAX 1024
433 clipboard_get_cb (GtkClipboard *clipboard,
434 GtkSelectionData *selection_data,
438 struct psppire_output_view *view = data;
442 struct output_driver *driver = NULL;
443 char dirname[PATH_MAX], *filename;
444 struct string_map options;
446 GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
447 GtkTreeModel *model = gtk_tree_view_get_model (view->overview);
449 GList *rows = gtk_tree_selection_get_selected_rows (sel, &model);
455 if (path_search (dirname, sizeof dirname, NULL, NULL, true)
456 || mkdtemp (dirname) == NULL)
458 msg_error (errno, _("failed to create temporary directory during clipboard operation"));
461 filename = xasprintf ("%s/clip.tmp", dirname);
463 string_map_init (&options);
464 string_map_insert (&options, "output-file", filename);
468 case SELECT_FMT_UTF8:
469 string_map_insert (&options, "box", "unicode");
472 case SELECT_FMT_TEXT:
473 string_map_insert (&options, "format", "txt");
476 case SELECT_FMT_HTML:
477 string_map_insert (&options, "format", "html");
478 string_map_insert (&options, "borders", "false");
479 string_map_insert (&options, "css", "false");
483 string_map_insert (&options, "format", "odt");
487 g_warning ("unsupported clip target\n");
492 driver = output_driver_create (&options);
498 GtkTreePath *path = n->data ;
500 struct output_item *item ;
502 gtk_tree_model_get_iter (model, &iter, path);
503 gtk_tree_model_get (model, &iter, COL_ADDR, &item, -1);
505 driver->class->submit (driver, item);
510 if ( driver->class->flush)
511 driver->class->flush (driver);
514 /* Some drivers (eg: the odt one) don't write anything until they
516 output_driver_destroy (driver);
519 if ( g_file_get_contents (filename, &text, &length, NULL) )
521 gtk_selection_data_set (selection_data, gtk_selection_data_get_target (selection_data),
523 (const guchar *) text, length);
529 output_driver_destroy (driver);
541 clipboard_clear_cb (GtkClipboard *clipboard,
546 static const GtkTargetEntry targets[] = {
548 { "STRING", 0, SELECT_FMT_TEXT },
549 { "TEXT", 0, SELECT_FMT_TEXT },
550 { "COMPOUND_TEXT", 0, SELECT_FMT_TEXT },
551 { "text/plain", 0, SELECT_FMT_TEXT },
553 { "UTF8_STRING", 0, SELECT_FMT_UTF8 },
554 { "text/plain;charset=utf-8", 0, SELECT_FMT_UTF8 },
556 { "text/html", 0, SELECT_FMT_HTML },
558 { "application/vnd.oasis.opendocument.text", 0, SELECT_FMT_ODT }
562 on_copy (struct psppire_output_view *view)
564 GtkWidget *widget = GTK_WIDGET (view->overview);
565 GtkClipboard *cb = gtk_widget_get_clipboard (widget, GDK_SELECTION_CLIPBOARD);
567 if (!gtk_clipboard_set_with_data (cb, targets, G_N_ELEMENTS (targets),
568 clipboard_get_cb, clipboard_clear_cb,
570 clipboard_clear_cb (cb, view);
574 on_selection_change (GtkTreeSelection *sel, GtkAction *copy_action)
576 /* The Copy action is available only if there is something selected */
577 gtk_action_set_sensitive (copy_action, gtk_tree_selection_count_selected_rows (sel) > 0);
581 on_select_all (struct psppire_output_view *view)
583 GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
584 gtk_tree_view_expand_all (view->overview);
585 gtk_tree_selection_select_all (sel);
589 on_size_allocate (GtkWidget *widget,
590 GdkRectangle *allocation,
591 struct psppire_output_view *view)
593 int new_render_width = MAX (300, allocation->width);
595 if (view->render_width != new_render_width)
597 view->render_width = new_render_width;
602 struct psppire_output_view *
603 psppire_output_view_new (GtkLayout *output, GtkTreeView *overview,
604 GtkAction *copy_action, GtkAction *select_all_action)
606 struct psppire_output_view *view;
607 GtkTreeViewColumn *column;
608 GtkCellRenderer *renderer;
609 GtkTreeSelection *sel;
612 view = xmalloc (sizeof *view);
614 view->font_height = 0;
615 view->output = output;
616 view->render_width = 0;
619 string_map_init (&view->render_opts);
620 view->overview = overview;
621 memset (&view->cur_command, 0, sizeof view->cur_command);
622 view->in_command = false;
623 view->toplevel = gtk_widget_get_toplevel (GTK_WIDGET (output));
625 view->n_items = view->allocated_items = 0;
626 view->print_settings = NULL;
627 view->print_xrd = NULL;
628 view->print_item = 0;
629 view->print_n_pages = 0;
630 view->paginated = FALSE;
632 g_signal_connect (output, "style-updated", G_CALLBACK (on_style_updated), view);
634 g_signal_connect (output, "size-allocate", G_CALLBACK (on_size_allocate), view);
636 gtk_style_context_add_class (gtk_widget_get_style_context (GTK_WIDGET (output)),
637 GTK_STYLE_CLASS_VIEW);
641 model = GTK_TREE_MODEL (gtk_tree_store_new (
643 G_TYPE_STRING, /* COL_NAME */
644 G_TYPE_POINTER, /* COL_ADDR */
645 G_TYPE_LONG)); /* COL_Y */
646 gtk_tree_view_set_model (overview, model);
647 g_object_unref (model);
649 sel = gtk_tree_view_get_selection (overview);
650 gtk_tree_selection_set_mode (sel, GTK_SELECTION_MULTIPLE);
651 g_signal_connect (sel, "changed", G_CALLBACK (on_selection_change),
654 column = gtk_tree_view_column_new ();
655 gtk_tree_view_append_column (GTK_TREE_VIEW (overview), column);
656 renderer = gtk_cell_renderer_text_new ();
657 gtk_tree_view_column_pack_start (column, renderer, TRUE);
658 gtk_tree_view_column_add_attribute (column, renderer, "text", COL_NAME);
660 g_signal_connect (GTK_TREE_VIEW (overview),
661 "row-activated", G_CALLBACK (on_row_activate), view);
663 gtk_action_set_sensitive (copy_action, FALSE);
664 g_signal_connect_swapped (copy_action, "activate",
665 G_CALLBACK (on_copy), view);
666 g_signal_connect_swapped (select_all_action, "activate",
667 G_CALLBACK (on_select_all), view);
674 psppire_output_view_destroy (struct psppire_output_view *view)
681 g_signal_handlers_disconnect_by_func (view->output,
682 G_CALLBACK (on_style_updated), view);
684 string_map_destroy (&view->render_opts);
686 for (i = 0; i < view->n_items; i++)
687 output_item_unref (view->items[i].item);
690 view->n_items = view->allocated_items = 0;
692 if (view->print_settings != NULL)
693 g_object_unref (view->print_settings);
695 xr_driver_destroy (view->xr);
701 psppire_output_view_clear (struct psppire_output_view *view)
708 for (i = 0; i < view->n_items; i++)
710 gtk_container_remove (GTK_CONTAINER (view->output),
711 view->items[i].drawing_area);
712 output_item_unref (view->items[i].item);
716 view->n_items = view->allocated_items = 0;
722 psppire_output_view_export (struct psppire_output_view *view,
723 struct string_map *options)
725 struct output_driver *driver;
727 driver = output_driver_create (options);
732 for (i = 0; i < view->n_items; i++)
733 driver->class->submit (driver, view->items[i].item);
734 output_driver_destroy (driver);
741 get_cairo_context_from_print_context (GtkPrintContext *context)
743 cairo_t *cr = gtk_print_context_get_cairo_context (context);
746 For all platforms except windows, gtk_print_context_get_dpi_[xy] returns 72.
749 double xres = gtk_print_context_get_dpi_x (context);
750 double yres = gtk_print_context_get_dpi_y (context);
752 /* This means that the cairo context now has its dimensions in Points */
753 cairo_scale (cr, xres / 72.0, yres / 72.0);
760 create_xr_print_driver (GtkPrintContext *context, struct psppire_output_view *view)
762 struct string_map options;
763 GtkPageSetup *page_setup;
764 double width, height;
768 double bottom_margin;
770 page_setup = gtk_print_context_get_page_setup (context);
771 width = gtk_page_setup_get_paper_width (page_setup, GTK_UNIT_MM);
772 height = gtk_page_setup_get_paper_height (page_setup, GTK_UNIT_MM);
773 left_margin = gtk_page_setup_get_left_margin (page_setup, GTK_UNIT_MM);
774 right_margin = gtk_page_setup_get_right_margin (page_setup, GTK_UNIT_MM);
775 top_margin = gtk_page_setup_get_top_margin (page_setup, GTK_UNIT_MM);
776 bottom_margin = gtk_page_setup_get_bottom_margin (page_setup, GTK_UNIT_MM);
778 string_map_init (&options);
779 string_map_insert_nocopy (&options, xstrdup ("paper-size"),
780 c_xasprintf("%.2fx%.2fmm", width, height));
781 string_map_insert_nocopy (&options, xstrdup ("left-margin"),
782 c_xasprintf ("%.2fmm", left_margin));
783 string_map_insert_nocopy (&options, xstrdup ("right-margin"),
784 c_xasprintf ("%.2fmm", right_margin));
785 string_map_insert_nocopy (&options, xstrdup ("top-margin"),
786 c_xasprintf ("%.2fmm", top_margin));
787 string_map_insert_nocopy (&options, xstrdup ("bottom-margin"),
788 c_xasprintf ("%.2fmm", bottom_margin));
790 view->print_xrd = xr_driver_create (get_cairo_context_from_print_context (context), &options);
792 string_map_destroy (&options);
796 paginate (GtkPrintOperation *operation,
797 GtkPrintContext *context,
798 struct psppire_output_view *view)
802 /* Sometimes GTK+ emits this signal again even after pagination is
803 complete. Don't let that screw up printing. */
806 else if ( view->print_item < view->n_items )
808 xr_driver_output_item (view->print_xrd,
809 view->items[view->print_item++].item);
810 while (xr_driver_need_new_page (view->print_xrd))
812 xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
813 view->print_n_pages ++;
819 gtk_print_operation_set_n_pages (operation, view->print_n_pages);
821 /* Re-create the driver to do the real printing. */
822 xr_driver_destroy (view->print_xrd);
823 create_xr_print_driver (context, view);
824 view->print_item = 0;
825 view->paginated = TRUE;
832 begin_print (GtkPrintOperation *operation,
833 GtkPrintContext *context,
834 struct psppire_output_view *view)
836 create_xr_print_driver (context, view);
838 view->print_item = 0;
839 view->print_n_pages = 1;
840 view->paginated = FALSE;
844 end_print (GtkPrintOperation *operation,
845 GtkPrintContext *context,
846 struct psppire_output_view *view)
848 xr_driver_destroy (view->print_xrd);
853 draw_page (GtkPrintOperation *operation,
854 GtkPrintContext *context,
856 struct psppire_output_view *view)
858 xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
859 while (!xr_driver_need_new_page (view->print_xrd)
860 && view->print_item < view->n_items)
861 xr_driver_output_item (view->print_xrd, view->items [view->print_item++].item);
866 psppire_output_view_print (struct psppire_output_view *view,
867 GtkWindow *parent_window)
869 GtkPrintOperationResult res;
871 GtkPrintOperation *print = gtk_print_operation_new ();
873 if (view->print_settings != NULL)
874 gtk_print_operation_set_print_settings (print, view->print_settings);
876 g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), view);
877 g_signal_connect (print, "end_print", G_CALLBACK (end_print), view);
878 g_signal_connect (print, "paginate", G_CALLBACK (paginate), view);
879 g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), view);
881 res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
882 parent_window, NULL);
884 if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
886 if (view->print_settings != NULL)
887 g_object_unref (view->print_settings);
888 view->print_settings = g_object_ref (gtk_print_operation_get_print_settings (print));
891 g_object_unref (print);
894 struct psppire_output_view_driver
896 struct output_driver driver;
897 struct psppire_output_view *view;
900 static struct psppire_output_view_driver *
901 psppire_output_view_driver_cast (struct output_driver *driver)
903 return UP_CAST (driver, struct psppire_output_view_driver, driver);
907 psppire_output_view_submit (struct output_driver *this,
908 const struct output_item *item)
910 struct psppire_output_view_driver *povd = psppire_output_view_driver_cast (this);
912 if (is_table_item (item))
913 psppire_output_view_put (povd->view, item);
916 static struct output_driver_class psppire_output_view_driver_class =
918 "PSPPIRE Output View", /* name */
920 psppire_output_view_submit, /* submit */
925 psppire_output_view_register_driver (struct psppire_output_view *view)
927 struct psppire_output_view_driver *povd;
928 struct output_driver *d;
930 povd = xzalloc (sizeof *povd);
933 output_driver_init (d, &psppire_output_view_driver_class, "PSPPIRE Output View",
934 SETTINGS_DEVICE_UNFILTERED);
935 output_driver_register (d);