469966af2325adf73faafbba8e29194dcfc7168a
[pspp] / src / ui / gui / psppire-output-window.c
1 /* PSPPIRE - a graphical user interface for PSPP.
2    Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013, 2014  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-window.h"
20
21 #include <errno.h>
22 #include <gtk/gtk.h>
23 #include <stdlib.h>
24 #include <sys/stat.h>
25 #include <sys/types.h>
26 #include <unistd.h>
27
28 #include "libpspp/cast.h"
29 #include "libpspp/message.h"
30 #include "libpspp/string-map.h"
31 #include "output/chart-item.h"
32 #include "output/driver-provider.h"
33 #include "output/message-item.h"
34 #include "output/output-item.h"
35 #include "output/tab.h"
36 #include "output/table-item.h"
37 #include "output/text-item.h"
38 #include "ui/gui/help-menu.h"
39 #include "ui/gui/builder-wrapper.h"
40 #include "ui/gui/psppire-output-view.h"
41 #include "ui/gui/windows-menu.h"
42
43 #include "gl/xalloc.h"
44
45 #include "helper.h"
46
47 #include <gettext.h>
48 #define _(msgid) gettext (msgid)
49 #define N_(msgid) msgid
50
51 static void psppire_output_window_class_init    (PsppireOutputWindowClass *class);
52 static void psppire_output_window_init          (PsppireOutputWindow      *window);
53
54 GType
55 psppire_output_window_get_type (void)
56 {
57   static GType psppire_output_window_type = 0;
58
59   if (!psppire_output_window_type)
60     {
61       static const GTypeInfo psppire_output_window_info =
62       {
63         sizeof (PsppireOutputWindowClass),
64         (GBaseInitFunc) NULL,
65         (GBaseFinalizeFunc) NULL,
66         (GClassInitFunc)psppire_output_window_class_init,
67         (GClassFinalizeFunc) NULL,
68         NULL,
69         sizeof (PsppireOutputWindow),
70         0,
71         (GInstanceInitFunc) psppire_output_window_init,
72       };
73
74       psppire_output_window_type =
75         g_type_register_static (PSPPIRE_TYPE_WINDOW, "PsppireOutputWindow",
76                                 &psppire_output_window_info, 0);
77     }
78
79   return psppire_output_window_type;
80 }
81
82 static GObjectClass *parent_class;
83
84 static void
85 psppire_output_window_finalize (GObject *object)
86 {
87   if (G_OBJECT_CLASS (parent_class)->finalize)
88     (*G_OBJECT_CLASS (parent_class)->finalize) (object);
89 }
90
91
92 static void
93 psppire_output_window_dispose (GObject *obj)
94 {
95   PsppireOutputWindow *window = PSPPIRE_OUTPUT_WINDOW (obj);
96
97   if (window->dispose_has_run) 
98     return;
99
100   window->dispose_has_run = TRUE;
101   psppire_output_view_destroy (window->view);
102   window->view = NULL;
103
104   /* Chain up to the parent class */
105   G_OBJECT_CLASS (parent_class)->dispose (obj);
106 }
107
108 static void
109 psppire_output_window_class_init (PsppireOutputWindowClass *class)
110 {
111   GObjectClass *object_class = G_OBJECT_CLASS (class);
112
113   parent_class = g_type_class_peek_parent (class);
114   object_class->dispose = psppire_output_window_dispose;
115   
116   object_class->finalize = psppire_output_window_finalize;
117 }
118 \f
119 /* Output driver class. */
120
121 struct psppire_output_driver
122   {
123     struct output_driver driver;
124     PsppireOutputWindow *window;
125   };
126
127 static struct output_driver_class psppire_output_class;
128
129 static struct psppire_output_driver *
130 psppire_output_cast (struct output_driver *driver)
131 {
132   assert (driver->class == &psppire_output_class);
133   return UP_CAST (driver, struct psppire_output_driver, driver);
134 }
135
136 static void
137 psppire_output_submit (struct output_driver *this,
138                        const struct output_item *item)
139 {
140   struct psppire_output_driver *pod = psppire_output_cast (this);
141   PsppireOutputWindow *window;
142   bool new;
143
144   new = pod->window == NULL;
145   if (new)
146     {
147       pod->window = PSPPIRE_OUTPUT_WINDOW (psppire_output_window_new ());
148       pod->window->driver = pod;
149     }
150   window = pod->window;
151
152   psppire_output_view_put (window->view, item);
153
154   if (new)
155     {
156       /* We could have called this earlier in the previous "if (new)" block,
157          but doing it here finds, in a plain GTK+ environment, a bug that
158          otherwise only showed up on an Ubuntu Unity desktop.  See bug
159          #43362. */
160       gtk_widget_show_all (GTK_WIDGET (pod->window));
161     }
162
163   gtk_window_set_urgency_hint (GTK_WINDOW (pod->window), TRUE);
164 }
165
166 static struct output_driver_class psppire_output_class =
167   {
168     "PSPPIRE",                  /* name */
169     NULL,                       /* destroy */
170     psppire_output_submit,      /* submit */
171     NULL,                       /* flush */
172   };
173
174 void
175 psppire_output_window_setup (void)
176 {
177   struct psppire_output_driver *pod;
178   struct output_driver *d;
179
180   pod = xzalloc (sizeof *pod);
181   d = &pod->driver;
182   output_driver_init (d, &psppire_output_class, "PSPPIRE",
183                       SETTINGS_DEVICE_UNFILTERED);
184   output_driver_register (d);
185 }
186
187 \f
188
189 /* Callback for the "delete" action (clicking the x on the top right
190    hand corner of the window) */
191 static gboolean
192 on_delete (GtkWidget *w, GdkEvent *event, gpointer user_data)
193 {
194   PsppireOutputWindow *ow = PSPPIRE_OUTPUT_WINDOW (user_data);
195
196   gtk_widget_destroy (GTK_WIDGET (ow));
197
198   ow->driver->window = NULL;
199
200   return FALSE;
201 }
202
203
204
205 static void
206 cancel_urgency (GtkWindow *window,  gpointer data)
207 {
208   gtk_window_set_urgency_hint (window, FALSE);
209 }
210
211 static void psppire_output_window_print (PsppireOutputWindow *window);
212
213
214 static void
215 export_output (PsppireOutputWindow *window, struct string_map *options,
216                const char *format)
217 {
218   string_map_insert (options, "format", format);
219   psppire_output_view_export (window->view, options);
220 }
221
222
223 struct file_types
224 {
225   const gchar *label;
226   const gchar *ext;
227 };
228
229 enum 
230   {
231     FT_AUTO = 0,
232     FT_PDF,
233     FT_HTML,
234     FT_ODT,
235     FT_TXT,
236     FT_ASCII,
237     FT_PS,
238     FT_CSV,
239     n_FT
240   };
241
242 #define N_EXTENSIONS (n_FT - 1)
243
244 struct file_types ft[n_FT] = {
245   {N_("Infer file type from extension"),  NULL},
246   {N_("PDF (*.pdf)"),                     ".pdf"},
247   {N_("HTML (*.html)"),                   ".html"},
248   {N_("OpenDocument (*.odt)"),            ".odt"},
249   {N_("Text (*.txt)"),                    ".txt"},
250   {N_("Text [plain] (*.txt)"),            ".txt"},
251   {N_("PostScript (*.ps)"),               ".ps"},
252   {N_("Comma-Separated Values (*.csv)"),  ".csv"}
253 };
254
255
256 static void
257 on_combo_change (GtkFileChooser *chooser)
258 {
259   gboolean sensitive = FALSE;
260   GtkWidget *combo = gtk_file_chooser_get_extra_widget (chooser);
261
262   int x = 0; 
263   gchar *fn = gtk_file_chooser_get_filename (chooser);
264
265   if (combo &&  gtk_widget_get_realized (combo))
266     x = gtk_combo_box_get_active (GTK_COMBO_BOX (combo));
267
268   if (fn == NULL)
269     {
270       sensitive = FALSE;
271     }
272   else
273     {
274       gint i;
275       if ( x != 0 )
276         sensitive = TRUE;
277
278       for (i = 1 ; i < N_EXTENSIONS ; ++i)
279         {
280           if ( g_str_has_suffix (fn, ft[i].ext))
281             {
282               sensitive = TRUE;
283               break;
284             }
285         }
286     }
287
288   g_free (fn);
289
290   gtk_dialog_set_response_sensitive (GTK_DIALOG (chooser), GTK_RESPONSE_ACCEPT, sensitive);
291 }
292
293
294 static void
295 on_file_chooser_change (GObject *w, GParamSpec *pspec, gpointer data)
296 {
297
298   GtkFileChooser *chooser = data;
299   const gchar *name = g_param_spec_get_name (pspec);
300
301   if ( ! gtk_widget_get_realized (GTK_WIDGET (chooser)))
302     return;
303
304   /* Ignore this one.  It causes recursion. */
305   if ( 0 == strcmp ("tooltip-text", name))
306     return;
307
308   on_combo_change (chooser);
309 }
310
311
312 /* Recursively descend all the children of W, connecting
313    to their "notify" signal */
314 static void
315 iterate_widgets (GtkWidget *w, gpointer data)
316 {
317   if ( GTK_IS_CONTAINER (w))
318     gtk_container_forall (GTK_CONTAINER (w), iterate_widgets, data);
319   else
320     g_signal_connect (w, "notify",  G_CALLBACK (on_file_chooser_change), data);
321 }
322
323
324
325 static GtkListStore *
326 create_file_type_list (void)
327 {
328   int i;
329   GtkTreeIter iter;
330   GtkListStore *list = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_STRING);
331   
332   for (i = 0 ; i < n_FT ; ++i)
333     {
334       gtk_list_store_append (list, &iter);
335       gtk_list_store_set (list, &iter,
336                           0,  gettext (ft[i].label),
337                           1,  ft[i].ext,
338                           -1);
339     }
340   
341   return list;
342 }
343
344 static void
345 psppire_output_window_export (PsppireOutputWindow *window)
346 {
347   gint response;
348   GtkWidget *combo;
349   GtkListStore *list;
350
351   GtkFileChooser *chooser;
352   
353   GtkWidget *dialog = gtk_file_chooser_dialog_new (_("Export Output"),
354                                         GTK_WINDOW (window),
355                                         GTK_FILE_CHOOSER_ACTION_SAVE,
356                                         _("Cancel"), GTK_RESPONSE_CANCEL,
357                                         _("Save"),   GTK_RESPONSE_ACCEPT,
358                                         NULL);
359
360   g_object_set (dialog, "local-only", FALSE, NULL);
361
362   chooser = GTK_FILE_CHOOSER (dialog);
363
364   list = create_file_type_list ();
365
366   combo = gtk_combo_box_new_with_model (GTK_TREE_MODEL (list));
367
368
369   {
370     /* Create text cell renderer */
371     GtkCellRenderer *cell = gtk_cell_renderer_text_new();
372     gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combo), cell, FALSE );
373
374     gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (combo), cell,  "text", 0);
375   }
376
377   g_signal_connect_swapped (combo, "changed", G_CALLBACK (on_combo_change), chooser);
378
379   gtk_combo_box_set_active (GTK_COMBO_BOX (combo), 0);
380
381   gtk_file_chooser_set_extra_widget (chooser, combo);
382
383   /* This kludge is necessary because there is no signal to tell us
384      when the candidate filename of a GtkFileChooser has changed */
385   gtk_container_forall (GTK_CONTAINER (dialog), iterate_widgets, dialog);
386
387
388   gtk_file_chooser_set_do_overwrite_confirmation (chooser, TRUE);
389
390   response = gtk_dialog_run (GTK_DIALOG (dialog));
391
392   if ( response == GTK_RESPONSE_ACCEPT )
393     {
394       gint file_type = gtk_combo_box_get_active (GTK_COMBO_BOX (combo));
395       gchar *filename = gtk_file_chooser_get_filename (chooser);
396       struct string_map options;
397
398       g_return_if_fail (filename);
399
400       if (file_type == FT_AUTO)
401         {
402           /* If the "Infer file type from extension" option was chosen,
403              search for the respective type in the list.
404              (It's a O(n) search, but fortunately n is small). */
405           gint i;
406           for (i = 1 ; i < N_EXTENSIONS ; ++i)
407             {
408               if ( g_str_has_suffix (filename, ft[i].ext))
409                 {
410                   file_type = i;
411                   break;
412                 }
413             }
414         }
415       else if (! g_str_has_suffix (filename, ft[file_type].ext))
416         {
417           /* If an explicit document format was chosen, and if the chosen
418              filename does not already have that particular "extension",
419              then append it.
420            */
421
422           gchar *of = filename;
423           filename = g_strconcat (filename, ft[file_type].ext, NULL);
424           g_free (of);
425         }
426       
427       string_map_init (&options);
428       string_map_insert (&options, "output-file", filename);
429
430       switch (file_type)
431         {
432         case FT_PDF:
433           export_output (window, &options, "pdf");
434           break;
435         case FT_HTML:
436           export_output (window, &options, "html");
437           break;
438         case FT_ODT:
439           export_output (window, &options, "odt");
440           break;
441         case FT_PS:
442           export_output (window, &options, "ps");
443           break;
444         case FT_CSV:
445           export_output (window, &options, "csv");
446           break;
447
448         case FT_TXT:
449           string_map_insert (&options, "box", "unicode");
450           /* Fall through */
451
452         case FT_ASCII:
453           string_map_insert (&options, "headers", "false");
454           string_map_insert (&options, "paginate", "false");
455           string_map_insert (&options, "squeeze", "true");
456           string_map_insert (&options, "emphasis", "none");
457           string_map_insert (&options, "charts", "none");
458           string_map_insert (&options, "top-margin", "0");
459           string_map_insert (&options, "bottom-margin", "0");
460           export_output (window, &options, "txt");
461           break;
462         default:
463           g_assert_not_reached ();
464         }
465
466       string_map_destroy (&options);
467
468       free (filename);
469     }
470
471   gtk_widget_destroy (dialog);
472 }
473
474 static void
475 psppire_output_window_init (PsppireOutputWindow *window)
476 {
477   GtkBuilder *xml = builder_new ("output-window.ui");
478
479   GtkWidget *box = get_widget_assert (xml, "box1");
480   gtk_container_add (GTK_CONTAINER (window), box);
481
482   window->dispose_has_run = FALSE;
483
484   window->view = psppire_output_view_new (
485     GTK_LAYOUT (get_widget_assert (xml, "output")),
486     GTK_TREE_VIEW (get_widget_assert (xml, "overview")),
487     get_action_assert (xml, "edit_copy"),
488     get_action_assert (xml, "edit_select-all"));
489
490
491   connect_help (xml);
492
493   g_signal_connect (window,
494                     "focus-in-event",
495                     G_CALLBACK (cancel_urgency),
496                     NULL);
497
498   GtkWidget *menubar = get_widget_assert (xml, "menubar");
499
500   gtk_menu_shell_append (GTK_MENU_SHELL (menubar),
501                          create_windows_menu (GTK_WINDOW (window)));
502     
503   gtk_menu_shell_append (GTK_MENU_SHELL (menubar),
504                          create_help_menu (GTK_WINDOW (window)));
505
506
507   g_signal_connect_swapped (get_action_assert (xml, "file_export"), "activate",
508                             G_CALLBACK (psppire_output_window_export), window);
509
510
511   g_signal_connect_swapped (get_action_assert (xml, "file_print"), "activate",
512                             G_CALLBACK (psppire_output_window_print), window);
513
514   g_object_unref (xml);
515
516   g_signal_connect (window, "delete-event",
517                     G_CALLBACK (on_delete), window);
518 }
519
520
521 GtkWidget*
522 psppire_output_window_new (void)
523 {
524   return GTK_WIDGET (g_object_new (psppire_output_window_get_type (),
525                                    /* TRANSLATORS: This will form a filename.  Please avoid whitespace. */
526                                    "filename", _("Output"),
527                                    "description", _("Output Viewer"),
528                                    NULL));
529 }
530
531 static void
532 psppire_output_window_print (PsppireOutputWindow *window)
533 {
534   psppire_output_view_print (window->view, GTK_WINDOW (window));
535 }