psppire-output-window: Factor out output view as psppire-output-view.
[pspp] / src / ui / gui / psppire-output-window.c
index 5fc52e9bea1561177bc5ce33917f7e3a60584f42..074f90a88be77477ac9d9f8e095b058801464fad 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPPIRE - a graphical user interface for PSPP.
-   Copyright (C) 2008  Free Software Foundation
+   Copyright (C) 2008, 2009, 2010, 2011, 2012, 2013, 2014  Free Software Foundation
 
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
 
 #include <config.h>
 
-#include <gtk/gtksignal.h>
-#include <gtk/gtkbox.h>
-#include <glade/glade.h>
-#include "helper.h"
+#include "ui/gui/psppire-output-window.h"
 
-#include <libpspp/message.h>
+#include <errno.h>
+#include <gtk/gtk.h>
 #include <stdlib.h>
-
-#include "about.h"
-
-#include "psppire-output-window.h"
-
-
-#include "xalloc.h"
-
-#include <sys/types.h>
 #include <sys/stat.h>
+#include <sys/types.h>
 #include <unistd.h>
 
+#include "libpspp/cast.h"
+#include "libpspp/message.h"
+#include "libpspp/string-map.h"
+#include "output/cairo.h"
+#include "output/chart-item.h"
+#include "output/driver-provider.h"
+#include "output/message-item.h"
+#include "output/output-item.h"
+#include "output/tab.h"
+#include "output/table-item.h"
+#include "output/text-item.h"
+#include "ui/gui/help-menu.h"
+#include "ui/gui/builder-wrapper.h"
+#include "ui/gui/psppire-output-view.h"
+
+#include "gl/xalloc.h"
+
+#include "helper.h"
+
 #include <gettext.h>
 #define _(msgid) gettext (msgid)
 #define N_(msgid) msgid
 
-
-
-static void psppire_output_window_base_finalize (PsppireOutputWindowClass *, gpointer);
-static void psppire_output_window_base_init     (PsppireOutputWindowClass *class);
 static void psppire_output_window_class_init    (PsppireOutputWindowClass *class);
 static void psppire_output_window_init          (PsppireOutputWindow      *window);
 
-
 GType
 psppire_output_window_get_type (void)
 {
@@ -57,8 +61,8 @@ psppire_output_window_get_type (void)
       static const GTypeInfo psppire_output_window_info =
       {
        sizeof (PsppireOutputWindowClass),
-       (GBaseInitFunc) psppire_output_window_base_init,
-        (GBaseFinalizeFunc) psppire_output_window_base_finalize,
+       (GBaseInitFunc) NULL,
+        (GBaseFinalizeFunc) NULL,
        (GClassInitFunc)psppire_output_window_class_init,
        (GClassFinalizeFunc) NULL,
        NULL,
@@ -68,58 +72,109 @@ psppire_output_window_get_type (void)
       };
 
       psppire_output_window_type =
-       g_type_register_static (PSPPIRE_WINDOW_TYPE, "PsppireOutputWindow",
+       g_type_register_static (PSPPIRE_TYPE_WINDOW, "PsppireOutputWindow",
                                &psppire_output_window_info, 0);
     }
 
   return psppire_output_window_type;
 }
 
+static GObjectClass *parent_class;
 
 static void
 psppire_output_window_finalize (GObject *object)
 {
-  GObjectClass *class = G_OBJECT_GET_CLASS (object);
-
-  GObjectClass *parent_class = g_type_class_peek_parent (class);
-
-
   if (G_OBJECT_CLASS (parent_class)->finalize)
     (*G_OBJECT_CLASS (parent_class)->finalize) (object);
-
 }
 
 
 static void
-psppire_output_window_class_init (PsppireOutputWindowClass *class)
+psppire_output_window_dispose (GObject *obj)
 {
-}
+  PsppireOutputWindow *window = PSPPIRE_OUTPUT_WINDOW (obj);
+
+  if (window->dispose_has_run) 
+    return;
 
+  window->dispose_has_run = TRUE;
+  psppire_output_view_destroy (window->view);
+  window->view = NULL;
+
+  /* Chain up to the parent class */
+  G_OBJECT_CLASS (parent_class)->dispose (obj);
+}
 
 static void
-psppire_output_window_base_init (PsppireOutputWindowClass *class)
+psppire_output_window_class_init (PsppireOutputWindowClass *class)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (class);
 
+  parent_class = g_type_class_peek_parent (class);
+  object_class->dispose = psppire_output_window_dispose;
+  
   object_class->finalize = psppire_output_window_finalize;
 }
+\f
+/* Output driver class. */
 
+struct psppire_output_driver
+  {
+    struct output_driver driver;
+    PsppireOutputWindow *window;
+  };
 
+static struct output_driver_class psppire_output_class;
 
-static void
-psppire_output_window_base_finalize (PsppireOutputWindowClass *class,
-                                    gpointer class_data)
+static struct psppire_output_driver *
+psppire_output_cast (struct output_driver *driver)
 {
+  assert (driver->class == &psppire_output_class);
+  return UP_CAST (driver, struct psppire_output_driver, driver);
 }
 
+static void
+psppire_output_submit (struct output_driver *this,
+                       const struct output_item *item)
+{
+  struct psppire_output_driver *pod = psppire_output_cast (this);
+  PsppireOutputWindow *window;
 
-\f
+  if (pod->window == NULL)
+    {
+      pod->window = PSPPIRE_OUTPUT_WINDOW (psppire_output_window_new ());
+      gtk_widget_show_all (GTK_WIDGET (pod->window));
+      pod->window->driver = pod;
+    }
+  window = pod->window;
 
-static PsppireOutputWindow *the_output_viewer = NULL;
+  psppire_output_view_put (window->view, item);
 
+  gtk_window_set_urgency_hint (GTK_WINDOW (pod->window), TRUE);
+}
 
-int viewer_length = 16;
-int viewer_width = 59;
+static struct output_driver_class psppire_output_class =
+  {
+    "PSPPIRE",                  /* name */
+    NULL,                       /* destroy */
+    psppire_output_submit,      /* submit */
+    NULL,                       /* flush */
+  };
+
+void
+psppire_output_window_setup (void)
+{
+  struct psppire_output_driver *pod;
+  struct output_driver *d;
+
+  pod = xzalloc (sizeof *pod);
+  d = &pod->driver;
+  output_driver_init (d, &psppire_output_class, "PSPPIRE",
+                      SETTINGS_DEVICE_UNFILTERED);
+  output_driver_register (d);
+}
+
+\f
 
 /* Callback for the "delete" action (clicking the x on the top right
    hand corner of the window) */
@@ -130,9 +185,7 @@ on_delete (GtkWidget *w, GdkEvent *event, gpointer user_data)
 
   gtk_widget_destroy (GTK_WIDGET (ow));
 
-  the_output_viewer = NULL;
-
-  unlink (OUTPUT_FILE_NAME);
+  ow->driver->window = NULL;
 
   return FALSE;
 }
@@ -144,233 +197,328 @@ cancel_urgency (GtkWindow *window,  gpointer data)
 {
   gtk_window_set_urgency_hint (window, FALSE);
 }
-/* Sets width and length according to the new size
-   of the output window */
-static void
-on_textview_resize (GtkWidget     *widget,
-                   GtkAllocation *allocation,
-                   gpointer       user_data)
-{
-  PangoContext * context ;
-  PangoLayout *layout ;
-  PangoRectangle logical;
-  GtkStyle *style;
-  gint right_margin, left_margin;
-  GtkTextView *text_view = GTK_TEXT_VIEW (widget);
-
-  context = gtk_widget_create_pango_context (widget);
-  layout = pango_layout_new (context);
-
-  style = gtk_widget_get_style (widget);
 
-  pango_layout_set_font_description (layout, style->font_desc);
+static void psppire_output_window_print (PsppireOutputWindow *window);
 
-  /* Find the width of one character.  We can use any character, because
-     the textview has a monospaced font */
-  pango_layout_set_text (layout, "M", 1);
 
-  pango_layout_get_extents (layout,  NULL, &logical);
+static void
+export_output (PsppireOutputWindow *window, struct string_map *options,
+               const char *format)
+{
+  string_map_insert (options, "format", format);
+  psppire_output_view_export (window->view, options);
+}
 
-  left_margin = gtk_text_view_get_left_margin (text_view);
-  right_margin = gtk_text_view_get_right_margin (text_view);
 
-  viewer_length = allocation->height / PANGO_PIXELS (logical.height);
-  viewer_width = (allocation->width - right_margin - left_margin)
-    / PANGO_PIXELS (logical.width);
+struct file_types
+{
+  const gchar *label;
+  const gchar *ext;
+};
 
-  g_object_unref (G_OBJECT (layout));
-  g_object_unref (G_OBJECT (context));
-}
+enum 
+  {
+    FT_AUTO = 0,
+    FT_PDF,
+    FT_HTML,
+    FT_ODT,
+    FT_TXT,
+    FT_PS,
+    FT_CSV,
+    n_FT
+  };
+
+#define N_EXTENSIONS (n_FT - 1)
+
+struct file_types ft[n_FT] = {
+  {N_("Infer file type from extension"),  NULL},
+  {N_("PDF (*.pdf)"),                     ".pdf"},
+  {N_("HTML (*.html)"),                   ".html"},
+  {N_("OpenDocument (*.odt)"),            ".odt"},
+  {N_("Text (*.txt)"),                    ".txt"},
+  {N_("PostScript (*.ps)"),               ".ps"},
+  {N_("Comma-Separated Values (*.csv)"),  ".csv"}
+};
 
 
 static void
-psppire_output_window_init (PsppireOutputWindow *window)
+on_combo_change (GtkFileChooser *chooser)
 {
-  GladeXML *xml = XML_NEW ("output-viewer.glade");
+  gboolean sensitive = FALSE;
+  GtkWidget *combo = gtk_file_chooser_get_extra_widget (chooser);
 
-  GtkWidget *box = gtk_vbox_new (FALSE, 0);
+  int x = 0; 
+  gchar *fn = gtk_file_chooser_get_filename (chooser);
 
-  GtkWidget *sw = get_widget_assert (xml, "scrolledwindow1");
+  if (combo &&  gtk_widget_get_realized (combo))
+    x = gtk_combo_box_get_active (GTK_COMBO_BOX (combo));
 
-  GtkWidget *menubar = get_widget_assert (xml, "menubar1");
+  if (fn == NULL)
+    {
+      sensitive = FALSE;
+    }
+  else
+    {
+      gint i;
+      if ( x != 0 )
+       sensitive = TRUE;
+
+      for (i = 1 ; i < N_EXTENSIONS ; ++i)
+       {
+         if ( g_str_has_suffix (fn, ft[i].ext))
+           {
+             sensitive = TRUE;
+             break;
+           }
+       }
+    }
 
-  window->textview = get_widget_assert (xml, "output-viewer-textview");
+  g_free (fn);
 
+  gtk_dialog_set_response_sensitive (GTK_DIALOG (chooser), GTK_RESPONSE_ACCEPT, sensitive);
+}
 
-  gtk_container_add (GTK_CONTAINER (window), box);
 
+static void
+on_file_chooser_change (GObject *w, GParamSpec *pspec, gpointer data)
+{
 
-  g_object_ref (menubar);
-  gtk_widget_unparent (menubar);
+  GtkFileChooser *chooser = data;
+  const gchar *name = g_param_spec_get_name (pspec);
 
-  g_object_ref (sw);
-  gtk_widget_unparent (sw);
+  if ( ! gtk_widget_get_realized (GTK_WIDGET (chooser)))
+    return;
 
+  /* Ignore this one.  It causes recursion. */
+  if ( 0 == strcmp ("tooltip-text", name))
+    return;
 
-  gtk_box_pack_start (GTK_BOX (box), menubar, FALSE, TRUE, 0);
-  gtk_box_pack_start (GTK_BOX (box), sw, TRUE, TRUE, 0);
+  on_combo_change (chooser);
+}
 
 
-  gtk_widget_show_all (box);
+/* Recursively descend all the children of W, connecting
+   to their "notify" signal */
+static void
+iterate_widgets (GtkWidget *w, gpointer data)
+{
+  if ( GTK_IS_CONTAINER (w))
+    gtk_container_forall (GTK_CONTAINER (w), iterate_widgets, data);
+  else
+    g_signal_connect (w, "notify",  G_CALLBACK (on_file_chooser_change), data);
+}
 
-  connect_help (xml);
 
-  window->buffer = gtk_text_view_get_buffer (GTK_TEXT_VIEW (window->textview));
 
-  g_signal_connect (window,
-                   "focus-in-event",
-                   G_CALLBACK (cancel_urgency),
-                   NULL);
+static GtkListStore *
+create_file_type_list (void)
+{
+  int i;
+  GtkTreeIter iter;
+  GtkListStore *list = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_STRING);
+  
+  for (i = 0 ; i < n_FT ; ++i)
+    {
+      gtk_list_store_append (list, &iter);
+      gtk_list_store_set (list, &iter,
+                         0,  gettext (ft[i].label),
+                         1,  ft[i].ext,
+                         -1);
+    }
+  
+  return list;
+}
 
-  {
-    /* Output uses ascii characters for tabular material.
-       So we need a monospaced font otherwise it'll look silly */
-    PangoFontDescription *font_desc =
-      pango_font_description_from_string ("monospace");
+static void
+psppire_output_window_export (PsppireOutputWindow *window)
+{
+  gint response;
+  GtkWidget *combo;
+  GtkListStore *list;
 
-    gtk_widget_modify_font (window->textview, font_desc);
-    pango_font_description_free (font_desc);
-  }
+  GtkFileChooser *chooser;
+  
+  GtkWidget *dialog = gtk_file_chooser_dialog_new (_("Export Output"),
+                                        GTK_WINDOW (window),
+                                        GTK_FILE_CHOOSER_ACTION_SAVE,
+                                        GTK_STOCK_CANCEL, GTK_RESPONSE_CANCEL,
+                                        GTK_STOCK_SAVE,   GTK_RESPONSE_ACCEPT,
+                                        NULL);
 
-  g_signal_connect (window->textview, "size-allocate",
-                   G_CALLBACK (on_textview_resize), NULL);
+  g_object_set (dialog, "local-only", FALSE, NULL);
 
-  window->fp = NULL;
+  chooser = GTK_FILE_CHOOSER (dialog);
 
-  g_signal_connect (get_widget_assert (xml,"help_about"),
-                   "activate",
-                   G_CALLBACK (about_new),
-                   window);
+  list = create_file_type_list ();
 
-  g_signal_connect (get_widget_assert (xml,"help_reference"),
-                   "activate",
-                   G_CALLBACK (reference_manual),
-                   NULL);
+  combo = gtk_combo_box_new_with_model (GTK_TREE_MODEL (list));
 
-  g_signal_connect (get_widget_assert (xml,"windows_minimise-all"),
-                   "activate",
-                   G_CALLBACK (psppire_window_minimise_all),
-                   NULL);
 
-  PSPPIRE_WINDOW (window)->menu = GTK_MENU_SHELL (get_widget_assert (xml,"windows_menu"));
+  {
+    /* Create text cell renderer */
+    GtkCellRenderer *cell = gtk_cell_renderer_text_new();
+    gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combo), cell, FALSE );
 
+    gtk_cell_layout_add_attribute (GTK_CELL_LAYOUT (combo), cell,  "text", 0);
+  }
 
-  g_object_unref (xml);
+  g_signal_connect_swapped (combo, "changed", G_CALLBACK (on_combo_change), chooser);
 
-  g_signal_connect (window, "delete-event",
-                   G_CALLBACK (on_delete), window);
-}
+  gtk_combo_box_set_active (GTK_COMBO_BOX (combo), 0);
 
+  gtk_file_chooser_set_extra_widget (chooser, combo);
 
-GtkWidget*
-psppire_output_window_new (void)
-{
-  return GTK_WIDGET (g_object_new (psppire_output_window_get_type (),
-                                  "usage", PSPPIRE_WINDOW_USAGE_OUTPUT,
-                                  NULL));
-}
+  /* This kludge is necessary because there is no signal to tell us
+     when the candidate filename of a GtkFileChooser has changed */
+  gtk_container_forall (GTK_CONTAINER (dialog), iterate_widgets, dialog);
 
-static void reload_viewer (PsppireOutputWindow *ow);
 
-void
-psppire_output_window_reload (void)
-{
-  struct stat buf;
+  gtk_file_chooser_set_do_overwrite_confirmation (chooser, TRUE);
 
-  /* If there is no output, then don't do anything */
-  if (0 != stat (OUTPUT_FILE_NAME, &buf))
-    return ;
+  response = gtk_dialog_run (GTK_DIALOG (dialog));
 
-  if ( NULL == the_output_viewer )
+  if ( response == GTK_RESPONSE_ACCEPT )
     {
-      the_output_viewer = PSPPIRE_OUTPUT_WINDOW (psppire_output_window_new ());
-      gtk_widget_show (GTK_WIDGET (the_output_viewer));
+      gint file_type = gtk_combo_box_get_active (GTK_COMBO_BOX (combo));
+      gchar *filename = gtk_file_chooser_get_filename (chooser);
+      struct string_map options;
+
+      g_return_if_fail (filename);
+
+      if (file_type == FT_AUTO)
+       {
+          /* If the "Infer file type from extension" option was chosen,
+             search for the respective type in the list.
+             (It's a O(n) search, but fortunately n is small). */
+         gint i;
+         for (i = 1 ; i < N_EXTENSIONS ; ++i)
+           {
+             if ( g_str_has_suffix (filename, ft[i].ext))
+               {
+                 file_type = i;
+                 break;
+               }
+           }
+       }
+      else if (! g_str_has_suffix (filename, ft[file_type].ext))
+        {
+          /* If an explicit document format was chosen, and if the chosen
+             filename does not already have that particular "extension",
+             then append it.
+           */
+
+          gchar *of = filename;
+          filename = g_strconcat (filename, ft[file_type].ext, NULL);
+          g_free (of);
+        }
+      
+      string_map_init (&options);
+      string_map_insert (&options, "output-file", filename);
+
+      switch (file_type)
+       {
+       case FT_PDF:
+          export_output (window, &options, "pdf");
+         break;
+       case FT_HTML:
+          export_output (window, &options, "html");
+         break;
+       case FT_ODT:
+          export_output (window, &options, "odt");
+         break;
+       case FT_PS:
+          export_output (window, &options, "ps");
+         break;
+       case FT_CSV:
+          export_output (window, &options, "csv");
+         break;
+
+       case FT_TXT:
+          string_map_insert (&options, "headers", "false");
+          string_map_insert (&options, "paginate", "false");
+          string_map_insert (&options, "squeeze", "true");
+          string_map_insert (&options, "emphasis", "none");
+          string_map_insert (&options, "charts", "none");
+          string_map_insert (&options, "top-margin", "0");
+          string_map_insert (&options, "bottom-margin", "0");
+          export_output (window, &options, "txt");
+         break;
+       default:
+         g_assert_not_reached ();
+       }
+
+      string_map_destroy (&options);
+
+      free (filename);
     }
 
-  reload_viewer (the_output_viewer);
-
+  gtk_widget_destroy (dialog);
 }
 
-
 static void
-reload_viewer (PsppireOutputWindow *ow)
+psppire_output_window_init (PsppireOutputWindow *window)
 {
-  GtkTextIter end_iter;
-  GtkTextMark *mark ;
+  GtkBuilder *xml;
 
-  static char *line = NULL;
+  xml = builder_new ("output-window.ui");
 
-  gboolean chars_inserted = FALSE;
+  gtk_widget_reparent (get_widget_assert (xml, "vbox1"), GTK_WIDGET (window));
 
-  gtk_text_buffer_get_end_iter (ow->buffer, &end_iter);
+  window->dispose_has_run = FALSE;
 
-  line = xrealloc (line, sizeof (char) * (viewer_width + 1));
+  window->view = psppire_output_view_new (
+    GTK_LAYOUT (get_widget_assert (xml, "output")),
+    GTK_TREE_VIEW (get_widget_assert (xml, "overview")),
+    get_action_assert (xml, "edit_copy"),
+    get_action_assert (xml, "edit_select-all"));
 
-  mark = gtk_text_buffer_create_mark (ow->buffer, NULL, &end_iter, TRUE);
-
-#ifdef __CYGWIN__
-  /*
-    Apparently Windoze is not capabale of writing to a file whilst
-    another (or the same) process is reading from it.   Therefore, we
-    must close the file after reading it, and clear the entire buffer
-    before writing to it.
-    This will be slower for large buffers, but should work
-    (in so far as anything ever works on windows).
-  */
-  {
-    GtkTextIter start_iter;
-    FILE *fp = fopen (OUTPUT_FILE_NAME, "r");
-    if ( !fp)
-      {
-       g_print ("Cannot open %s\n", OUTPUT_FILE_NAME);
-       return;
-      }
 
-    /* Delete all the entire buffer */
-    gtk_text_buffer_get_start_iter (ov->buffer, &start_iter);
-    gtk_text_buffer_delete (ov->buffer, &start_iter, &end_iter);
+  connect_help (xml);
 
+  g_signal_connect (window,
+                   "focus-in-event",
+                   G_CALLBACK (cancel_urgency),
+                   NULL);
 
-    gtk_text_buffer_get_start_iter (ov->buffer, &start_iter);
-    /* Read in the next lot of text */
-    while (fgets (line, viewer_width + 1, fp) != NULL)
-      {
-       chars_inserted = TRUE;
-       gtk_text_buffer_insert (ov->buffer, &start_iter, line, -1);
-      }
+  g_signal_connect (get_action_assert (xml,"windows_minimise-all"),
+                   "activate",
+                   G_CALLBACK (psppire_window_minimise_all),
+                   NULL);
 
-    fclose (fp);
-  }
-#else
   {
-    if ( ow->fp == NULL)
-      {
-       ow->fp = fopen (OUTPUT_FILE_NAME, "r");
-       if ( ow->fp == NULL)
-         {
-           g_print ("Cannot open %s\n", OUTPUT_FILE_NAME);
-           return;
-         }
-      }
-
-    /* Read in the next lot of text */
-    while (fgets (line, viewer_width + 1, ow->fp) != NULL)
-      {
-       chars_inserted = TRUE;
-       gtk_text_buffer_insert (ow->buffer, &end_iter, line, -1);
-      }
+    GtkUIManager *uim = GTK_UI_MANAGER (get_object_assert (xml, "uimanager1", GTK_TYPE_UI_MANAGER));
+    merge_help_menu (uim);
+
+    PSPPIRE_WINDOW (window)->menu =
+      GTK_MENU_SHELL (gtk_ui_manager_get_widget (uim,"/ui/menubar/windows_menuitem/windows_minimise-all")->parent);
   }
-#endif
 
-  /* Scroll to where the start of this lot of text begins */
-  gtk_text_view_scroll_to_mark (GTK_TEXT_VIEW (ow->textview),
-                               mark,
-                               0.1, TRUE, 0.0, 0.0);
+  g_signal_connect_swapped (get_action_assert (xml, "file_export"), "activate",
+                            G_CALLBACK (psppire_output_window_export), window);
+
+
+  g_signal_connect_swapped (get_action_assert (xml, "file_print"), "activate",
+                            G_CALLBACK (psppire_output_window_print), window);
 
+  g_object_unref (xml);
 
-  if ( chars_inserted )
-    gtk_window_set_urgency_hint ( GTK_WINDOW (ow), TRUE);
+  g_signal_connect (window, "delete-event",
+                   G_CALLBACK (on_delete), window);
 }
 
 
+GtkWidget*
+psppire_output_window_new (void)
+{
+  return GTK_WIDGET (g_object_new (psppire_output_window_get_type (),
+                                  /* TRANSLATORS: This will form a filename.  Please avoid whitespace. */
+                                  "filename", _("Output"),
+                                  "description", _("Output Viewer"),
+                                  NULL));
+}
 
+static void
+psppire_output_window_print (PsppireOutputWindow *window)
+{
+  psppire_output_view_print (window->view, GTK_WINDOW (window));
+}