e217c0edca665274a7a9d28daa8c60bb69693558
[pspp] / src / ui / gui / psppire-output-window.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008, 2009, 2010  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 <gtk/gtksignal.h>
20 #include <gtk/gtkbox.h>
21 #include "helper.h"
22
23 #include <libpspp/cast.h>
24 #include <libpspp/message.h>
25 #include <libpspp/string-map.h>
26 #include <output/cairo.h>
27 #include <output/chart-item.h>
28 #include <output/driver-provider.h>
29 #include <output/output-item.h>
30 #include <output/table-item.h>
31 #include <output/text-item.h>
32 #include <output/tab.h>
33 #include <stdlib.h>
34
35 #include "about.h"
36
37 #include "psppire-output-window.h"
38
39
40 #include "xalloc.h"
41
42 #include <sys/types.h>
43 #include <sys/stat.h>
44 #include <unistd.h>
45
46 #include <gettext.h>
47 #define _(msgid) gettext (msgid)
48 #define N_(msgid) msgid
49
50 enum
51   {
52     COL_TITLE,                  /* Table title. */
53     COL_Y,                      /* Y position of top of title. */
54     N_COLS
55   };
56
57 static void psppire_output_window_base_finalize (PsppireOutputWindowClass *, gpointer);
58 static void psppire_output_window_base_init     (PsppireOutputWindowClass *class);
59 static void psppire_output_window_class_init    (PsppireOutputWindowClass *class);
60 static void psppire_output_window_init          (PsppireOutputWindow      *window);
61
62
63 GType
64 psppire_output_window_get_type (void)
65 {
66   static GType psppire_output_window_type = 0;
67
68   if (!psppire_output_window_type)
69     {
70       static const GTypeInfo psppire_output_window_info =
71       {
72         sizeof (PsppireOutputWindowClass),
73         (GBaseInitFunc) psppire_output_window_base_init,
74         (GBaseFinalizeFunc) psppire_output_window_base_finalize,
75         (GClassInitFunc)psppire_output_window_class_init,
76         (GClassFinalizeFunc) NULL,
77         NULL,
78         sizeof (PsppireOutputWindow),
79         0,
80         (GInstanceInitFunc) psppire_output_window_init,
81       };
82
83       psppire_output_window_type =
84         g_type_register_static (PSPPIRE_TYPE_WINDOW, "PsppireOutputWindow",
85                                 &psppire_output_window_info, 0);
86     }
87
88   return psppire_output_window_type;
89 }
90
91 static GObjectClass *parent_class;
92
93 static void
94 psppire_output_window_finalize (GObject *object)
95 {
96   if (G_OBJECT_CLASS (parent_class)->finalize)
97     (*G_OBJECT_CLASS (parent_class)->finalize) (object);
98 }
99
100
101 static void
102 psppire_output_window_dispose (GObject *obj)
103 {
104   PsppireOutputWindow *viewer = PSPPIRE_OUTPUT_WINDOW (obj);
105   size_t i;
106
107   for (i = 0; i < viewer->n_items; i++)
108     output_item_unref (viewer->items[i]);
109   free (viewer->items);
110   viewer->items = NULL;
111   viewer->n_items = viewer->allocated_items = 0;
112
113   /* Chain up to the parent class */
114   G_OBJECT_CLASS (parent_class)->dispose (obj);
115 }
116
117 static void
118 psppire_output_window_class_init (PsppireOutputWindowClass *class)
119 {
120   GObjectClass *object_class = G_OBJECT_CLASS (class);
121
122   parent_class = g_type_class_peek_parent (class);
123   object_class->dispose = psppire_output_window_dispose;
124 }
125
126
127 static void
128 psppire_output_window_base_init (PsppireOutputWindowClass *class)
129 {
130   GObjectClass *object_class = G_OBJECT_CLASS (class);
131
132   object_class->finalize = psppire_output_window_finalize;
133 }
134
135
136
137 static void
138 psppire_output_window_base_finalize (PsppireOutputWindowClass *class,
139                                      gpointer class_data)
140 {
141 }
142 \f
143 /* Output driver class. */
144
145 struct psppire_output_driver
146   {
147     struct output_driver driver;
148     PsppireOutputWindow *viewer;
149     struct xr_driver *xr;
150   };
151
152 static struct output_driver_class psppire_output_class;
153
154 static struct psppire_output_driver *
155 psppire_output_cast (struct output_driver *driver)
156 {
157   assert (driver->class == &psppire_output_class);
158   return UP_CAST (driver, struct psppire_output_driver, driver);
159 }
160
161 static gboolean
162 expose_event_callback (GtkWidget *widget, GdkEventExpose *event, gpointer data)
163 {
164   struct xr_rendering *r = g_object_get_data (G_OBJECT (widget), "rendering");
165   cairo_t *cr;
166
167   cr = gdk_cairo_create (widget->window);
168   xr_rendering_draw (r, cr);
169   cairo_destroy (cr);
170
171   return TRUE;
172 }
173
174 static void
175 psppire_output_submit (struct output_driver *this,
176                        const struct output_item *item)
177 {
178   struct psppire_output_driver *pod = psppire_output_cast (this);
179   PsppireOutputWindow *viewer;
180   GtkWidget *drawing_area;
181   struct xr_rendering *r;
182   struct string title;
183   GtkTreeStore *store;
184   GtkTreePath *path;
185   GtkTreeIter iter;
186   cairo_t *cr;
187   int tw, th;
188
189   if (pod->viewer == NULL)
190     {
191       pod->viewer = PSPPIRE_OUTPUT_WINDOW (psppire_output_window_new ());
192       gtk_widget_show_all (GTK_WIDGET (pod->viewer));
193       pod->viewer->driver = pod;
194     }
195   viewer = pod->viewer;
196
197   if (viewer->n_items >= viewer->allocated_items)
198     viewer->items = x2nrealloc (viewer->items, &viewer->allocated_items,
199                                 sizeof *viewer->items);
200   viewer->items[viewer->n_items++] = output_item_ref (item);
201
202   if (is_text_item (item))
203     {
204       const struct text_item *text_item = to_text_item (item);
205       enum text_item_type type = text_item_get_type (text_item);
206       const char *text = text_item_get_text (text_item);
207
208       if (type == TEXT_ITEM_COMMAND_CLOSE)
209         {
210           viewer->in_command = false;
211           return;
212         }
213       else if (text[0] == '\0')
214         return;
215     }
216
217   cr = gdk_cairo_create (GTK_WIDGET (pod->viewer)->window);
218   if (pod->xr == NULL)
219     pod->xr = xr_create_driver (cr);
220
221   r = xr_rendering_create (pod->xr, item, cr);
222   if (r == NULL)
223     goto done;
224
225   xr_rendering_measure (r, &tw, &th);
226
227   drawing_area = gtk_drawing_area_new ();
228   gtk_widget_modify_bg (
229     GTK_WIDGET (drawing_area), GTK_STATE_NORMAL,
230     &gtk_widget_get_style (drawing_area)->base[GTK_STATE_NORMAL]);
231   g_object_set_data (G_OBJECT (drawing_area), "rendering", r);
232   gtk_widget_set_size_request (drawing_area, tw, th);
233   gtk_layout_put (pod->viewer->output, drawing_area, 0, pod->viewer->y);
234   gtk_widget_show (drawing_area);
235   g_signal_connect (G_OBJECT (drawing_area), "expose_event",
236                      G_CALLBACK (expose_event_callback), NULL);
237
238   if (!is_text_item (item)
239       || text_item_get_type (to_text_item (item)) != TEXT_ITEM_SYNTAX
240       || !viewer->in_command)
241     {
242       store = GTK_TREE_STORE (gtk_tree_view_get_model (viewer->overview));
243
244       ds_init_empty (&title);
245       if (is_text_item (item)
246           && text_item_get_type (to_text_item (item)) == TEXT_ITEM_COMMAND_OPEN)
247         {
248           gtk_tree_store_append (store, &iter, NULL);
249           viewer->cur_command = iter; /* XXX shouldn't save a GtkTreeIter */
250           viewer->in_command = true;
251         }
252       else
253         {
254           GtkTreeIter *p = viewer->in_command ? &viewer->cur_command : NULL;
255           gtk_tree_store_append (store, &iter, p);
256         }
257
258       ds_clear (&title);
259       if (is_text_item (item))
260         ds_put_cstr (&title, text_item_get_text (to_text_item (item)));
261       else if (is_table_item (item))
262         {
263           const char *caption = table_item_get_caption (to_table_item (item));
264           if (caption != NULL)
265             ds_put_format (&title, "Table: %s", caption);
266           else
267             ds_put_cstr (&title, "Table");
268         }
269       else if (is_chart_item (item))
270         {
271           const char *s = chart_item_get_title (to_chart_item (item));
272           if (s != NULL)
273             ds_put_format (&title, "Chart: %s", s);
274           else
275             ds_put_cstr (&title, "Chart");
276         }
277       gtk_tree_store_set (store, &iter,
278                           COL_TITLE, ds_cstr (&title),
279                           COL_Y, viewer->y,
280                           -1);
281       ds_destroy (&title);
282
283       path = gtk_tree_model_get_path (GTK_TREE_MODEL (store), &iter);
284       gtk_tree_view_expand_row (viewer->overview, path, TRUE);
285       gtk_tree_path_free (path);
286     }
287
288   if (pod->viewer->max_width < tw)
289     pod->viewer->max_width = tw;
290   pod->viewer->y += th;
291
292   gtk_layout_set_size (pod->viewer->output,
293                        pod->viewer->max_width, pod->viewer->y);
294
295   gtk_window_set_urgency_hint (GTK_WINDOW (pod->viewer), TRUE);
296
297 done:
298   cairo_destroy (cr);
299 }
300
301 static struct output_driver_class psppire_output_class =
302   {
303     "PSPPIRE",                  /* name */
304     NULL,                       /* destroy */
305     psppire_output_submit,      /* submit */
306     NULL,                       /* flush */
307   };
308
309 void
310 psppire_output_window_setup (void)
311 {
312   struct psppire_output_driver *pod;
313   struct output_driver *d;
314
315   pod = xzalloc (sizeof *pod);
316   d = &pod->driver;
317   output_driver_init (d, &psppire_output_class, "PSPPIRE",
318                       SETTINGS_DEVICE_UNFILTERED);
319   output_driver_register (d);
320 }
321 \f
322 int viewer_length = 16;
323 int viewer_width = 59;
324
325 /* Callback for the "delete" action (clicking the x on the top right
326    hand corner of the window) */
327 static gboolean
328 on_delete (GtkWidget *w, GdkEvent *event, gpointer user_data)
329 {
330   PsppireOutputWindow *ow = PSPPIRE_OUTPUT_WINDOW (user_data);
331
332   gtk_widget_destroy (GTK_WIDGET (ow));
333
334   ow->driver->viewer = NULL;
335
336   return FALSE;
337 }
338
339
340
341 static void
342 cancel_urgency (GtkWindow *window,  gpointer data)
343 {
344   gtk_window_set_urgency_hint (window, FALSE);
345 }
346
347 static void
348 on_row_activate (GtkTreeView *overview,
349                  GtkTreePath *path,
350                  GtkTreeViewColumn *column,
351                  PsppireOutputWindow *window)
352 {
353   GtkTreeModel *model;
354   GtkTreeIter iter;
355   GtkAdjustment *vadj;
356   GValue value = {0};
357   double y, min, max;
358
359   model = gtk_tree_view_get_model (overview);
360   if (!gtk_tree_model_get_iter (model, &iter, path))
361     return;
362
363   gtk_tree_model_get_value (model, &iter, COL_Y, &value);
364   y = g_value_get_long (&value);
365   g_value_unset (&value);
366
367   vadj = gtk_layout_get_vadjustment (window->output);
368   min = vadj->lower;
369   max = vadj->upper - vadj->page_size;
370   if (y < min)
371     y = min;
372   else if (y > max)
373     y = max;
374   gtk_adjustment_set_value (vadj, y);
375 }
376
377 static GtkFileFilter *
378 add_filter (GtkFileChooser *chooser, const char *name, const char *pattern)
379 {
380   GtkFileFilter *filter = gtk_file_filter_new ();
381   g_object_ref_sink (G_OBJECT (filter));
382   gtk_file_filter_set_name (filter, name);
383   gtk_file_filter_add_pattern (filter, pattern);
384   gtk_file_chooser_add_filter (chooser, filter);
385   return filter;
386 }
387
388 static void
389 export_output (PsppireOutputWindow *window, struct string_map *options,
390                const char *format)
391 {
392   struct output_driver *driver;
393   size_t i;
394
395   string_map_insert (options, "format", format);
396   driver = output_driver_create (options);
397   if (driver == NULL)
398     return;
399
400   for (i = 0; i < window->n_items; i++)
401     driver->class->submit (driver, window->items[i]);
402   output_driver_destroy (driver);
403 }
404
405 static void
406 psppire_output_window_export (PsppireOutputWindow *window)
407 {
408   gint response;
409
410   GtkFileFilter *pdf_filter;
411   GtkFileFilter *html_filter;
412   GtkFileFilter *odt_filter;
413   GtkFileFilter *txt_filter;
414   GtkFileFilter *ps_filter;
415   GtkFileFilter *csv_filter;
416   GtkFileChooser *chooser;
417   GtkWidget *dialog;
418
419   dialog = gtk_file_chooser_dialog_new (_("Export Output"),
420                                         GTK_WINDOW (window),
421                                         GTK_FILE_CHOOSER_ACTION_SAVE,
422                                         GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
423                                         GTK_STOCK_SAVE,   GTK_RESPONSE_ACCEPT,
424                                         NULL);
425   chooser = GTK_FILE_CHOOSER (dialog);
426
427   pdf_filter = add_filter (chooser, _("PDF Files (*.pdf)"), "*.pdf");
428   html_filter = add_filter (chooser, _("HTML Files (*.html)"), "*.html");
429   odt_filter = add_filter (chooser, _("OpenDocument Files (*.odt)"), "*.odt");
430   txt_filter = add_filter (chooser, _("Text Files (*.txt)"), "*.txt");
431   ps_filter = add_filter (chooser, _("PostScript Files (*.ps)"), "*.ps");
432   csv_filter = add_filter (chooser, _("Comma-Separated Value Files (*.csv)"),
433                            "*.csv");
434
435   gtk_file_chooser_set_do_overwrite_confirmation (chooser, TRUE);
436   gtk_file_chooser_set_filter (chooser, pdf_filter);
437
438   response = gtk_dialog_run (GTK_DIALOG (dialog));
439
440   if ( response == GTK_RESPONSE_ACCEPT )
441     {
442       char *filename = gtk_file_chooser_get_filename (chooser);
443       GtkFileFilter *filter = gtk_file_chooser_get_filter (chooser);
444       struct string_map options;
445
446       g_return_if_fail (filename);
447       g_return_if_fail (filter);
448
449       string_map_init (&options);
450       string_map_insert (&options, "output-file", filename);
451       if (filter == pdf_filter)
452         {
453           export_output (window, &options, "pdf");
454         }
455       else if (filter == html_filter)
456         export_output (window, &options, "html");
457       else if (filter == odt_filter)
458         export_output (window, &options, "odt");
459       else if (filter == txt_filter)
460         {
461           string_map_insert (&options, "headers", "false");
462           string_map_insert (&options, "paginate", "false");
463           string_map_insert (&options, "squeeze", "true");
464           string_map_insert (&options, "emphasis", "none");
465           string_map_insert (&options, "charts", "none");
466           string_map_insert (&options, "top-margin", "0");
467           string_map_insert (&options, "bottom-margin", "0");
468           export_output (window, &options, "txt");
469         }
470       else if (filter == ps_filter)
471         export_output (window, &options, "ps");
472       else if (filter == csv_filter)
473         export_output (window, &options, "csv");
474       else
475         g_return_if_reached ();
476
477       free (filename);
478     }
479
480   g_object_unref (G_OBJECT (pdf_filter));
481   g_object_unref (G_OBJECT (html_filter));
482   g_object_unref (G_OBJECT (txt_filter));
483   g_object_unref (G_OBJECT (ps_filter));
484   g_object_unref (G_OBJECT (csv_filter));
485
486   gtk_widget_destroy (dialog);
487 }
488
489 static void
490 psppire_output_window_init (PsppireOutputWindow *window)
491 {
492   GtkTreeViewColumn *column;
493   GtkCellRenderer *renderer;
494   GtkBuilder *xml;
495
496   xml = builder_new ("output-viewer.ui");
497
498   gtk_widget_reparent (get_widget_assert (xml, "vbox1"), GTK_WIDGET (window));
499
500   window->output = GTK_LAYOUT (get_widget_assert (xml, "output"));
501   window->y = 0;
502
503   window->overview = GTK_TREE_VIEW (get_widget_assert (xml, "overview"));
504   gtk_tree_view_set_model (window->overview,
505                            GTK_TREE_MODEL (gtk_tree_store_new (
506                                              N_COLS,
507                                              G_TYPE_STRING, /* COL_TITLE */
508                                              G_TYPE_LONG))); /* COL_Y */
509
510   window->in_command = false;
511
512   window->items = NULL;
513   window->n_items = window->allocated_items = 0;
514
515   column = gtk_tree_view_column_new ();
516   gtk_tree_view_append_column (GTK_TREE_VIEW (window->overview), column);
517   renderer = gtk_cell_renderer_text_new ();
518   gtk_tree_view_column_pack_start (column, renderer, TRUE);
519   gtk_tree_view_column_add_attribute (column, renderer, "text", COL_TITLE);
520
521   g_signal_connect (GTK_TREE_VIEW (window->overview),
522                     "row-activated", G_CALLBACK (on_row_activate), window);
523
524   gtk_widget_modify_bg (GTK_WIDGET (window->output), GTK_STATE_NORMAL,
525                         &gtk_widget_get_style (GTK_WIDGET (window->output))->base[GTK_STATE_NORMAL]);
526
527   connect_help (xml);
528
529   g_signal_connect (window,
530                     "focus-in-event",
531                     G_CALLBACK (cancel_urgency),
532                     NULL);
533
534   g_signal_connect (get_action_assert (xml,"help_about"),
535                     "activate",
536                     G_CALLBACK (about_new),
537                     window);
538
539   g_signal_connect (get_action_assert (xml,"help_reference"),
540                     "activate",
541                     G_CALLBACK (reference_manual),
542                     NULL);
543
544   g_signal_connect (get_action_assert (xml,"windows_minimise-all"),
545                     "activate",
546                     G_CALLBACK (psppire_window_minimise_all),
547                     NULL);
548
549   {
550     GtkUIManager *uim = GTK_UI_MANAGER (get_object_assert (xml, "uimanager1", GTK_TYPE_UI_MANAGER));
551
552     PSPPIRE_WINDOW (window)->menu =
553       GTK_MENU_SHELL (gtk_ui_manager_get_widget (uim,"/ui/menubar1/windows_menuitem/windows_minimise-all")->parent);
554   }
555
556   g_signal_connect_swapped (get_action_assert (xml, "file_export"), "activate",
557                             G_CALLBACK (psppire_output_window_export), window);
558
559   g_object_unref (xml);
560
561   g_signal_connect (window, "delete-event",
562                     G_CALLBACK (on_delete), window);
563 }
564
565
566 GtkWidget*
567 psppire_output_window_new (void)
568 {
569   return GTK_WIDGET (g_object_new (psppire_output_window_get_type (),
570                                    "filename", "Output",
571                                    "description", _("Output Viewer"),
572                                    NULL));
573 }