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)));
193 for (item = view->items; item < &view->items[view->n_items]; item++)
195 struct xr_rendering *r;
200 view->y += view->font_height / 2;
202 r = xr_rendering_create (view->xr, item->item, cr);
205 g_warn_if_reached ();
209 xr_rendering_measure (r, &tw, &th);
211 if (!item->drawing_area)
213 item->drawing_area = gtk_drawing_area_new ();
214 create_drawing_area (view, item->drawing_area, r, tw, th);
218 g_object_set_data_full (G_OBJECT (item->drawing_area),
219 "rendering", r, free_rendering);
220 gtk_widget_set_size_request (item->drawing_area, tw, th);
221 gtk_layout_move (view->output, item->drawing_area, 0, view->y);
228 gtk_widget_size_allocate(item->drawing_area,&alloc);
230 if (view->max_width < tw)
231 view->max_width = tw;
235 gtk_layout_set_size (view->output, view->max_width, view->y);
240 psppire_output_view_put (struct psppire_output_view *view,
241 const struct output_item *item)
243 struct output_view_item *view_item;
244 GtkWidget *drawing_area;
245 struct xr_rendering *r;
253 if (is_text_item (item))
255 const struct text_item *text_item = to_text_item (item);
256 enum text_item_type type = text_item_get_type (text_item);
257 const char *text = text_item_get_text (text_item);
259 if (type == TEXT_ITEM_COMMAND_CLOSE)
261 view->in_command = false;
264 else if (text[0] == '\0')
268 if (view->n_items >= view->allocated_items)
269 view->items = x2nrealloc (view->items, &view->allocated_items,
270 sizeof *view->items);
271 view_item = &view->items[view->n_items++];
272 view_item->item = output_item_ref (item);
273 view_item->drawing_area = NULL;
275 if (gtk_widget_get_window (GTK_WIDGET (view->output)))
277 view_item->drawing_area = drawing_area = gtk_drawing_area_new ();
279 cr = gdk_cairo_create (gtk_widget_get_window (GTK_WIDGET (view->output)));
280 if (view->xr == NULL)
284 view->y += view->font_height / 2;
286 r = xr_rendering_create (view->xr, item, cr);
290 xr_rendering_measure (r, &tw, &th);
292 create_drawing_area (view, drawing_area, r, tw, th);
298 && (!is_text_item (item)
299 || text_item_get_type (to_text_item (item)) != TEXT_ITEM_SYNTAX
300 || !view->in_command))
302 store = GTK_TREE_STORE (gtk_tree_view_get_model (view->overview));
304 ds_init_empty (&name);
305 if (is_text_item (item)
306 && text_item_get_type (to_text_item (item)) == TEXT_ITEM_COMMAND_OPEN)
308 gtk_tree_store_append (store, &iter, NULL);
309 view->cur_command = iter; /* XXX shouldn't save a GtkTreeIter */
310 view->in_command = true;
314 GtkTreeIter *p = view->in_command ? &view->cur_command : NULL;
315 gtk_tree_store_append (store, &iter, p);
319 if (is_text_item (item))
320 ds_put_cstr (&name, text_item_get_text (to_text_item (item)));
321 else if (is_message_item (item))
323 const struct message_item *msg_item = to_message_item (item);
324 const struct msg *msg = message_item_get_msg (msg_item);
325 ds_put_format (&name, "%s: %s", _("Message"),
326 msg_severity_to_string (msg->severity));
328 else if (is_table_item (item))
330 const char *title = table_item_get_title (to_table_item (item));
332 ds_put_format (&name, "Table: %s", title);
334 ds_put_cstr (&name, "Table");
336 else if (is_chart_item (item))
338 const char *s = chart_item_get_title (to_chart_item (item));
340 ds_put_format (&name, "Chart: %s", s);
342 ds_put_cstr (&name, "Chart");
344 gtk_tree_store_set (store, &iter,
345 COL_NAME, ds_cstr (&name),
347 COL_Y, (glong)(view->y),
351 path = gtk_tree_model_get_path (GTK_TREE_MODEL (store), &iter);
352 gtk_tree_view_expand_row (view->overview, path, TRUE);
353 gtk_tree_path_free (path);
356 if (view->max_width < tw)
357 view->max_width = tw;
360 gtk_layout_set_size (view->output, view->max_width, view->y);
367 on_row_activate (GtkTreeView *overview,
369 GtkTreeViewColumn *column,
370 struct psppire_output_view *view)
378 model = gtk_tree_view_get_model (overview);
379 if (!gtk_tree_model_get_iter (model, &iter, path))
382 gtk_tree_model_get_value (model, &iter, COL_Y, &value);
383 y = g_value_get_long (&value);
384 g_value_unset (&value);
386 vadj = gtk_scrollable_get_vadjustment (GTK_SCROLLABLE (view->output));
387 min = gtk_adjustment_get_lower (vadj);
388 max = gtk_adjustment_get_upper (vadj) - gtk_adjustment_get_page_size (vadj);
393 gtk_adjustment_set_value (vadj, y);
397 on_style_updated (GtkWidget *toplevel, struct psppire_output_view *view)
399 if (!view->n_items || !gtk_widget_get_window (GTK_WIDGET (view->output)))
401 string_map_clear (&view->render_opts);
402 xr_driver_destroy (view->xr);
415 /* GNU Hurd doesn't have PATH_MAX. Use a fallback.
416 Temporary directory names are usually not that long. */
418 # define PATH_MAX 1024
422 clipboard_get_cb (GtkClipboard *clipboard,
423 GtkSelectionData *selection_data,
427 struct psppire_output_view *view = data;
431 struct output_driver *driver = NULL;
432 char dirname[PATH_MAX], *filename;
433 struct string_map options;
435 GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
436 GtkTreeModel *model = gtk_tree_view_get_model (view->overview);
438 GList *rows = gtk_tree_selection_get_selected_rows (sel, &model);
444 if (path_search (dirname, sizeof dirname, NULL, NULL, true)
445 || mkdtemp (dirname) == NULL)
447 msg_error (errno, _("failed to create temporary directory during clipboard operation"));
450 filename = xasprintf ("%s/clip.tmp", dirname);
452 string_map_init (&options);
453 string_map_insert (&options, "output-file", filename);
457 case SELECT_FMT_UTF8:
458 string_map_insert (&options, "box", "unicode");
461 case SELECT_FMT_TEXT:
462 string_map_insert (&options, "format", "txt");
465 case SELECT_FMT_HTML:
466 string_map_insert (&options, "format", "html");
467 string_map_insert (&options, "borders", "false");
468 string_map_insert (&options, "css", "false");
472 string_map_insert (&options, "format", "odt");
476 g_warning ("unsupported clip target\n");
481 driver = output_driver_create (&options);
487 GtkTreePath *path = n->data ;
489 struct output_item *item ;
491 gtk_tree_model_get_iter (model, &iter, path);
492 gtk_tree_model_get (model, &iter, COL_ADDR, &item, -1);
494 driver->class->submit (driver, item);
499 if ( driver->class->flush)
500 driver->class->flush (driver);
503 /* Some drivers (eg: the odt one) don't write anything until they
505 output_driver_destroy (driver);
508 if ( g_file_get_contents (filename, &text, &length, NULL) )
510 gtk_selection_data_set (selection_data, gtk_selection_data_get_target (selection_data),
512 (const guchar *) text, length);
518 output_driver_destroy (driver);
530 clipboard_clear_cb (GtkClipboard *clipboard,
535 static const GtkTargetEntry targets[] = {
537 { "STRING", 0, SELECT_FMT_TEXT },
538 { "TEXT", 0, SELECT_FMT_TEXT },
539 { "COMPOUND_TEXT", 0, SELECT_FMT_TEXT },
540 { "text/plain", 0, SELECT_FMT_TEXT },
542 { "UTF8_STRING", 0, SELECT_FMT_UTF8 },
543 { "text/plain;charset=utf-8", 0, SELECT_FMT_UTF8 },
545 { "text/html", 0, SELECT_FMT_HTML },
547 { "application/vnd.oasis.opendocument.text", 0, SELECT_FMT_ODT }
551 on_copy (struct psppire_output_view *view)
553 GtkWidget *widget = GTK_WIDGET (view->overview);
554 GtkClipboard *cb = gtk_widget_get_clipboard (widget, GDK_SELECTION_CLIPBOARD);
556 if (!gtk_clipboard_set_with_data (cb, targets, G_N_ELEMENTS (targets),
557 clipboard_get_cb, clipboard_clear_cb,
559 clipboard_clear_cb (cb, view);
563 on_selection_change (GtkTreeSelection *sel, GtkAction *copy_action)
565 /* The Copy action is available only if there is something selected */
566 gtk_action_set_sensitive (copy_action, gtk_tree_selection_count_selected_rows (sel) > 0);
570 on_select_all (struct psppire_output_view *view)
572 GtkTreeSelection *sel = gtk_tree_view_get_selection (view->overview);
573 gtk_tree_view_expand_all (view->overview);
574 gtk_tree_selection_select_all (sel);
578 on_size_allocate (GtkWidget *widget,
579 GdkRectangle *allocation,
580 struct psppire_output_view *view)
582 int new_render_width = MAX (300, allocation->width);
584 if (view->render_width != new_render_width)
586 view->render_width = new_render_width;
591 struct psppire_output_view *
592 psppire_output_view_new (GtkLayout *output, GtkTreeView *overview,
593 GtkAction *copy_action, GtkAction *select_all_action)
595 struct psppire_output_view *view;
596 GtkTreeViewColumn *column;
597 GtkCellRenderer *renderer;
598 GtkTreeSelection *sel;
601 view = xmalloc (sizeof *view);
603 view->font_height = 0;
604 view->output = output;
605 view->render_width = 0;
608 string_map_init (&view->render_opts);
609 view->overview = overview;
610 memset (&view->cur_command, 0, sizeof view->cur_command);
611 view->in_command = false;
612 view->toplevel = gtk_widget_get_toplevel (GTK_WIDGET (output));
614 view->n_items = view->allocated_items = 0;
615 view->print_settings = NULL;
616 view->print_xrd = NULL;
617 view->print_item = 0;
618 view->print_n_pages = 0;
619 view->paginated = FALSE;
621 g_signal_connect (output, "style-updated", G_CALLBACK (on_style_updated), view);
623 g_signal_connect (output, "size-allocate", G_CALLBACK (on_size_allocate), view);
625 gtk_style_context_add_class (gtk_widget_get_style_context (GTK_WIDGET (output)),
626 GTK_STYLE_CLASS_VIEW);
630 model = GTK_TREE_MODEL (gtk_tree_store_new (
632 G_TYPE_STRING, /* COL_NAME */
633 G_TYPE_POINTER, /* COL_ADDR */
634 G_TYPE_LONG)); /* COL_Y */
635 gtk_tree_view_set_model (overview, model);
636 g_object_unref (model);
638 sel = gtk_tree_view_get_selection (overview);
639 gtk_tree_selection_set_mode (sel, GTK_SELECTION_MULTIPLE);
640 g_signal_connect (sel, "changed", G_CALLBACK (on_selection_change),
643 column = gtk_tree_view_column_new ();
644 gtk_tree_view_append_column (GTK_TREE_VIEW (overview), column);
645 renderer = gtk_cell_renderer_text_new ();
646 gtk_tree_view_column_pack_start (column, renderer, TRUE);
647 gtk_tree_view_column_add_attribute (column, renderer, "text", COL_NAME);
649 g_signal_connect (GTK_TREE_VIEW (overview),
650 "row-activated", G_CALLBACK (on_row_activate), view);
652 gtk_action_set_sensitive (copy_action, FALSE);
653 g_signal_connect_swapped (copy_action, "activate",
654 G_CALLBACK (on_copy), view);
655 g_signal_connect_swapped (select_all_action, "activate",
656 G_CALLBACK (on_select_all), view);
663 psppire_output_view_destroy (struct psppire_output_view *view)
670 g_signal_handlers_disconnect_by_func (view->output,
671 G_CALLBACK (on_style_updated), view);
673 string_map_destroy (&view->render_opts);
675 for (i = 0; i < view->n_items; i++)
676 output_item_unref (view->items[i].item);
679 view->n_items = view->allocated_items = 0;
681 if (view->print_settings != NULL)
682 g_object_unref (view->print_settings);
684 xr_driver_destroy (view->xr);
690 psppire_output_view_clear (struct psppire_output_view *view)
697 for (i = 0; i < view->n_items; i++)
699 gtk_container_remove (GTK_CONTAINER (view->output),
700 view->items[i].drawing_area);
701 output_item_unref (view->items[i].item);
705 view->n_items = view->allocated_items = 0;
711 psppire_output_view_export (struct psppire_output_view *view,
712 struct string_map *options)
714 struct output_driver *driver;
716 driver = output_driver_create (options);
721 for (i = 0; i < view->n_items; i++)
722 driver->class->submit (driver, view->items[i].item);
723 output_driver_destroy (driver);
730 get_cairo_context_from_print_context (GtkPrintContext *context)
732 cairo_t *cr = gtk_print_context_get_cairo_context (context);
735 For all platforms except windows, gtk_print_context_get_dpi_[xy] returns 72.
738 double xres = gtk_print_context_get_dpi_x (context);
739 double yres = gtk_print_context_get_dpi_y (context);
741 /* This means that the cairo context now has its dimensions in Points */
742 cairo_scale (cr, xres / 72.0, yres / 72.0);
749 create_xr_print_driver (GtkPrintContext *context, struct psppire_output_view *view)
751 struct string_map options;
752 GtkPageSetup *page_setup;
753 double width, height;
757 double bottom_margin;
759 page_setup = gtk_print_context_get_page_setup (context);
760 width = gtk_page_setup_get_paper_width (page_setup, GTK_UNIT_MM);
761 height = gtk_page_setup_get_paper_height (page_setup, GTK_UNIT_MM);
762 left_margin = gtk_page_setup_get_left_margin (page_setup, GTK_UNIT_MM);
763 right_margin = gtk_page_setup_get_right_margin (page_setup, GTK_UNIT_MM);
764 top_margin = gtk_page_setup_get_top_margin (page_setup, GTK_UNIT_MM);
765 bottom_margin = gtk_page_setup_get_bottom_margin (page_setup, GTK_UNIT_MM);
767 string_map_init (&options);
768 string_map_insert_nocopy (&options, xstrdup ("paper-size"),
769 c_xasprintf("%.2fx%.2fmm", width, height));
770 string_map_insert_nocopy (&options, xstrdup ("left-margin"),
771 c_xasprintf ("%.2fmm", left_margin));
772 string_map_insert_nocopy (&options, xstrdup ("right-margin"),
773 c_xasprintf ("%.2fmm", right_margin));
774 string_map_insert_nocopy (&options, xstrdup ("top-margin"),
775 c_xasprintf ("%.2fmm", top_margin));
776 string_map_insert_nocopy (&options, xstrdup ("bottom-margin"),
777 c_xasprintf ("%.2fmm", bottom_margin));
779 view->print_xrd = xr_driver_create (get_cairo_context_from_print_context (context), &options);
781 string_map_destroy (&options);
785 paginate (GtkPrintOperation *operation,
786 GtkPrintContext *context,
787 struct psppire_output_view *view)
791 /* Sometimes GTK+ emits this signal again even after pagination is
792 complete. Don't let that screw up printing. */
795 else if ( view->print_item < view->n_items )
797 xr_driver_output_item (view->print_xrd,
798 view->items[view->print_item++].item);
799 while (xr_driver_need_new_page (view->print_xrd))
801 xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
802 view->print_n_pages ++;
808 gtk_print_operation_set_n_pages (operation, view->print_n_pages);
810 /* Re-create the driver to do the real printing. */
811 xr_driver_destroy (view->print_xrd);
812 create_xr_print_driver (context, view);
813 view->print_item = 0;
814 view->paginated = TRUE;
821 begin_print (GtkPrintOperation *operation,
822 GtkPrintContext *context,
823 struct psppire_output_view *view)
825 create_xr_print_driver (context, view);
827 view->print_item = 0;
828 view->print_n_pages = 1;
829 view->paginated = FALSE;
833 end_print (GtkPrintOperation *operation,
834 GtkPrintContext *context,
835 struct psppire_output_view *view)
837 xr_driver_destroy (view->print_xrd);
842 draw_page (GtkPrintOperation *operation,
843 GtkPrintContext *context,
845 struct psppire_output_view *view)
847 xr_driver_next_page (view->print_xrd, get_cairo_context_from_print_context (context));
848 while (!xr_driver_need_new_page (view->print_xrd)
849 && view->print_item < view->n_items)
850 xr_driver_output_item (view->print_xrd, view->items [view->print_item++].item);
855 psppire_output_view_print (struct psppire_output_view *view,
856 GtkWindow *parent_window)
858 GtkPrintOperationResult res;
860 GtkPrintOperation *print = gtk_print_operation_new ();
862 if (view->print_settings != NULL)
863 gtk_print_operation_set_print_settings (print, view->print_settings);
865 g_signal_connect (print, "begin_print", G_CALLBACK (begin_print), view);
866 g_signal_connect (print, "end_print", G_CALLBACK (end_print), view);
867 g_signal_connect (print, "paginate", G_CALLBACK (paginate), view);
868 g_signal_connect (print, "draw_page", G_CALLBACK (draw_page), view);
870 res = gtk_print_operation_run (print, GTK_PRINT_OPERATION_ACTION_PRINT_DIALOG,
871 parent_window, NULL);
873 if (res == GTK_PRINT_OPERATION_RESULT_APPLY)
875 if (view->print_settings != NULL)
876 g_object_unref (view->print_settings);
877 view->print_settings = g_object_ref (gtk_print_operation_get_print_settings (print));
880 g_object_unref (print);
883 struct psppire_output_view_driver
885 struct output_driver driver;
886 struct psppire_output_view *view;
889 static struct psppire_output_view_driver *
890 psppire_output_view_driver_cast (struct output_driver *driver)
892 return UP_CAST (driver, struct psppire_output_view_driver, driver);
896 psppire_output_view_submit (struct output_driver *this,
897 const struct output_item *item)
899 struct psppire_output_view_driver *povd = psppire_output_view_driver_cast (this);
901 if (is_table_item (item))
902 psppire_output_view_put (povd->view, item);
905 static struct output_driver_class psppire_output_view_driver_class =
907 "PSPPIRE Output View", /* name */
909 psppire_output_view_submit, /* submit */
914 psppire_output_view_register_driver (struct psppire_output_view *view)
916 struct psppire_output_view_driver *povd;
917 struct output_driver *d;
919 povd = xzalloc (sizeof *povd);
922 output_driver_init (d, &psppire_output_view_driver_class, "PSPPIRE Output View",
923 SETTINGS_DEVICE_UNFILTERED);
924 output_driver_register (d);