New module: psppire-spreadsheet-model.c 20130309030511/pspp
authorJohn Darrington <john@darrington.wattle.id.au>
Fri, 8 Mar 2013 13:03:12 +0000 (14:03 +0100)
committerJohn Darrington <john@darrington.wattle.id.au>
Fri, 8 Mar 2013 13:03:12 +0000 (14:03 +0100)
 Provides an implementation of a GtkTreeModel which can be used to
display the meta data of Gnumeric or Opendocument spreadsheet files.
Potentially, other spreadsheet files could be added too.
Used for upcomming gui features.

src/ui/gui/automake.mk
src/ui/gui/psppire-spreadsheet-model.c [new file with mode: 0644]
src/ui/gui/psppire-spreadsheet-model.h [new file with mode: 0644]

index 6d3b6d0ec3710fee9498dbbe8c4f3cd4e90712d7..1d0890ef57adaa0385dbe386e103b7a4be48274f 100644 (file)
@@ -274,6 +274,8 @@ src_ui_gui_psppire_SOURCES = \
        src/ui/gui/psppire-output-window.h \
        src/ui/gui/psppire-var-view.c \
        src/ui/gui/psppire-var-view.h \
+       src/ui/gui/psppire-spreadsheet-model.c \
+       src/ui/gui/psppire-spreadsheet-model.h \
        src/ui/gui/psppire-selector.h \
        src/ui/gui/psppire-select-dest.c \
        src/ui/gui/psppire-select-dest.h \
diff --git a/src/ui/gui/psppire-spreadsheet-model.c b/src/ui/gui/psppire-spreadsheet-model.c
new file mode 100644 (file)
index 0000000..f5be69d
--- /dev/null
@@ -0,0 +1,367 @@
+/* PSPPIRE - a graphical user interface for PSPP.
+   Copyright (C) 2013  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
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+
+/* This file implements a GtkTreeModel.  It allows GtkComboBox and 
+   GtkTreeView to display the names and non-empty cell ranges of the
+   sheets aka "Tables" of spreadsheet files.
+   It doesn't take any notice of the spreadsheet data itself.
+*/
+
+#include <config.h>
+#include <glib.h>
+
+#include <gettext.h>
+#define _(msgid) gettext (msgid)
+#define N_(msgid) msgid
+
+
+#include "psppire-spreadsheet-model.h"
+#include "data/spreadsheet-reader.h"
+
+
+static void psppire_spreadsheet_model_init (PsppireSpreadsheetModel *
+                                            spreadsheetModel);
+static void psppire_spreadsheet_model_class_init (PsppireSpreadsheetModelClass
+                                                  * class);
+
+static void psppire_spreadsheet_model_finalize (GObject * object);
+static void psppire_spreadsheet_model_dispose (GObject * object);
+
+static GObjectClass *parent_class = NULL;
+
+
+static void spreadsheet_tree_model_init (GtkTreeModelIface * iface);
+
+
+GType
+psppire_spreadsheet_model_get_type (void)
+{
+  static GType object_type = 0;
+
+  if (!object_type)
+    {
+      static const GTypeInfo spreadsheet_model_info = {
+        sizeof (PsppireSpreadsheetModelClass),
+        NULL,                   /* base_init */
+        NULL,                   /* base_finalize */
+        (GClassInitFunc) psppire_spreadsheet_model_class_init,
+        NULL,                   /* class_finalize */
+        NULL,                   /* class_data */
+        sizeof (PsppireSpreadsheetModel),
+        0,
+        (GInstanceInitFunc) psppire_spreadsheet_model_init,
+      };
+
+      static const GInterfaceInfo tree_model_info = {
+        (GInterfaceInitFunc) spreadsheet_tree_model_init,
+        NULL,
+        NULL
+      };
+
+      object_type = g_type_register_static (G_TYPE_OBJECT,
+                                            "PsppireSpreadsheetModel",
+                                            &spreadsheet_model_info, 0);
+
+      g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
+                                   &tree_model_info);
+    }
+
+  return object_type;
+}
+
+
+/* Properties */
+enum
+{
+  PROP_0,
+  PROP_SPREADSHEET
+};
+
+
+static void
+psppire_spreadsheet_model_set_property (GObject * object,
+                                        guint prop_id,
+                                        const GValue * value,
+                                        GParamSpec * pspec)
+{
+  PsppireSpreadsheetModel *spreadsheetModel = 
+    PSPPIRE_SPREADSHEET_MODEL (object);
+
+  switch (prop_id)
+    {
+    case PROP_SPREADSHEET:
+      spreadsheetModel->spreadsheet = g_value_get_pointer (value);
+      break;
+    default:
+      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+      break;
+    };
+}
+
+
+static void
+psppire_spreadsheet_model_dispose (GObject * object)
+{
+}
+
+static void
+psppire_spreadsheet_model_finalize (GObject * object)
+{
+  //  PsppireSpreadsheetModel *spreadsheetModel = PSPPIRE_SPREADSHEET_MODEL (object);
+}
+
+static void
+psppire_spreadsheet_model_class_init (PsppireSpreadsheetModelClass * class)
+{
+  GObjectClass *object_class;
+
+  GParamSpec *spreadsheet_spec = g_param_spec_pointer ("spreadsheet",
+                                                       "Spreadsheet",
+                                                       "The spreadsheet that this model represents",
+                                                       G_PARAM_CONSTRUCT_ONLY
+                                                       | G_PARAM_WRITABLE);
+
+  parent_class = g_type_class_peek_parent (class);
+  object_class = (GObjectClass *) class;
+
+  object_class->set_property = psppire_spreadsheet_model_set_property;
+
+  g_object_class_install_property (object_class,
+                                   PROP_SPREADSHEET, spreadsheet_spec);
+
+  object_class->finalize = psppire_spreadsheet_model_finalize;
+  object_class->dispose = psppire_spreadsheet_model_dispose;
+}
+
+
+static void
+psppire_spreadsheet_model_init (PsppireSpreadsheetModel * spreadsheetModel)
+{
+  spreadsheetModel->dispose_has_run = FALSE;
+  spreadsheetModel->stamp = g_random_int ();
+}
+
+
+GtkTreeModel *
+psppire_spreadsheet_model_new (struct spreadsheet *sp)
+{
+  return g_object_new (psppire_spreadsheet_model_get_type (),
+                       "spreadsheet", sp, NULL);
+}
+
+
+\f
+
+static gint
+tree_model_n_columns (GtkTreeModel * model)
+{
+  return PSPPIRE_SPREADSHEET_MODEL_N_COLS;
+}
+
+static GtkTreeModelFlags
+tree_model_get_flags (GtkTreeModel * model)
+{
+  g_return_val_if_fail (PSPPIRE_IS_SPREADSHEET_MODEL (model),
+                        (GtkTreeModelFlags) 0);
+
+  return GTK_TREE_MODEL_LIST_ONLY;
+}
+
+static GType
+tree_model_column_type (GtkTreeModel * model, gint index)
+{
+  g_return_val_if_fail (PSPPIRE_IS_SPREADSHEET_MODEL (model), (GType) 0);
+  g_return_val_if_fail (index < PSPPIRE_SPREADSHEET_MODEL_N_COLS, (GType) 0);
+
+  return G_TYPE_STRING;
+}
+
+
+static gboolean
+tree_model_get_iter (GtkTreeModel * model, GtkTreeIter * iter,
+                     GtkTreePath * path)
+{
+  PsppireSpreadsheetModel *spreadsheetModel =
+    PSPPIRE_SPREADSHEET_MODEL (model);
+  gint *indices, depth;
+  gint n;
+
+  g_return_val_if_fail (path, FALSE);
+
+  depth = gtk_tree_path_get_depth (path);
+
+  g_return_val_if_fail (depth == 1, FALSE);
+
+  indices = gtk_tree_path_get_indices (path);
+
+  n = indices[0];
+
+  iter->stamp = spreadsheetModel->stamp;
+  iter->user_data = (gpointer) n;
+
+  return TRUE;
+}
+
+static gboolean
+tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
+{
+  PsppireSpreadsheetModel *spreadsheetModel =
+    PSPPIRE_SPREADSHEET_MODEL (model);
+  g_return_val_if_fail (iter->stamp == spreadsheetModel->stamp, FALSE);
+
+  if (iter == NULL)
+    return FALSE;
+
+  if ((gint) iter->user_data >= spreadsheetModel->spreadsheet->n_sheets - 1)
+    {
+      iter->user_data = NULL;
+      iter->stamp = 0;
+      return FALSE;
+    }
+
+  iter->user_data++;
+
+  return TRUE;
+}
+
+
+static void
+tree_model_get_value (GtkTreeModel * model, GtkTreeIter * iter,
+                      gint column, GValue * value)
+{
+  PsppireSpreadsheetModel *spreadsheetModel =
+    PSPPIRE_SPREADSHEET_MODEL (model);
+  g_return_if_fail (column < PSPPIRE_SPREADSHEET_MODEL_N_COLS);
+  g_return_if_fail (iter->stamp == spreadsheetModel->stamp);
+
+  g_value_init (value, G_TYPE_STRING);
+  switch (column)
+    {
+    case PSPPIRE_SPREADSHEET_MODEL_COL_NAME:
+      {
+        const char *x =
+          spreadsheet_get_sheet_name (spreadsheetModel->spreadsheet,
+                                   (gint) iter->user_data);
+       
+        g_value_set_string (value, x);
+      }
+      break;
+    case PSPPIRE_SPREADSHEET_MODEL_COL_RANGE:
+      {
+        char *x =
+          spreadsheet_get_sheet_range (spreadsheetModel->spreadsheet,
+                                    (gint) iter->user_data);
+
+       g_value_set_string (value, x ? x : _("(empty)"));
+       g_free (x);
+      }
+      break;
+    default:
+      g_error ("%s:%d Invalid column in spreadsheet model",
+              __FILE__, __LINE__);
+      break;
+    }
+}
+
+static gboolean
+tree_model_nth_child (GtkTreeModel * model, GtkTreeIter * iter,
+                      GtkTreeIter * parent, gint n)
+{
+  PsppireSpreadsheetModel *spreadsheetModel =
+    PSPPIRE_SPREADSHEET_MODEL (model);
+
+  if (parent)
+    return FALSE;
+
+  if (n >= spreadsheetModel->spreadsheet->n_sheets)
+    return FALSE;
+
+  iter->stamp = spreadsheetModel->stamp;
+  iter->user_data = (gpointer) n;
+
+  return TRUE;
+}
+
+static gint
+tree_model_n_children (GtkTreeModel * model, GtkTreeIter * iter)
+{
+  PsppireSpreadsheetModel *spreadsheetModel =
+    PSPPIRE_SPREADSHEET_MODEL (model);
+
+  if (iter == NULL)
+    return spreadsheetModel->spreadsheet->n_sheets;
+
+  return 0;
+}
+
+static gboolean
+tree_model_iter_has_child (GtkTreeModel *tree_model, GtkTreeIter *iter)
+{
+  return FALSE;
+}
+
+static GtkTreePath *
+tree_model_get_path (GtkTreeModel * model, GtkTreeIter * iter)
+{
+  PsppireSpreadsheetModel *spreadsheetModel =
+    PSPPIRE_SPREADSHEET_MODEL (model);
+  GtkTreePath *path;
+  gint index = (gint) iter->user_data;
+
+  g_return_val_if_fail (iter->stamp == spreadsheetModel->stamp, NULL);
+
+  path = gtk_tree_path_new ();
+
+  gtk_tree_path_append_index (path, index);
+
+  return path;
+}
+
+
+static gboolean
+tree_model_children (GtkTreeModel *model, GtkTreeIter *iter, GtkTreeIter *parent)
+{
+  PsppireSpreadsheetModel *spreadsheetModel = PSPPIRE_SPREADSHEET_MODEL (model);
+
+  if (parent != NULL)
+    return FALSE;
+
+  iter->stamp = spreadsheetModel->stamp;
+  iter->user_data = 0;
+    
+  return TRUE;
+}
+
+
+
+static void
+spreadsheet_tree_model_init (GtkTreeModelIface * iface)
+{
+  iface->get_flags = tree_model_get_flags;
+  iface->get_n_columns = tree_model_n_columns;
+  iface->get_column_type = tree_model_column_type;
+  iface->get_iter = tree_model_get_iter;
+  iface->iter_next = tree_model_iter_next;
+  iface->get_value = tree_model_get_value;
+
+  iface->iter_children = tree_model_children;
+  iface->iter_parent = NULL;
+
+  iface->get_path = tree_model_get_path;
+  iface->iter_has_child = tree_model_iter_has_child;
+  iface->iter_n_children = tree_model_n_children;
+  iface->iter_nth_child = tree_model_nth_child;
+}
diff --git a/src/ui/gui/psppire-spreadsheet-model.h b/src/ui/gui/psppire-spreadsheet-model.h
new file mode 100644 (file)
index 0000000..0366ad4
--- /dev/null
@@ -0,0 +1,93 @@
+/* PSPPIRE - a graphical user interface for PSPP.
+   Copyright (C) 2013  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
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
+
+
+#include <glib-object.h>
+#include <glib.h>
+
+#include <gtk/gtk.h>
+
+#ifndef __PSPPIRE_SPREADSHEET_MODEL_H__
+#define __PSPPIRE_SPREADSHEET_MODEL_H__
+
+G_BEGIN_DECLS
+
+
+#define PSPPIRE_TYPE_SPREADSHEET_MODEL (psppire_spreadsheet_model_get_type ())
+
+#define PSPPIRE_SPREADSHEET_MODEL(obj) \
+                     (G_TYPE_CHECK_INSTANCE_CAST ((obj), \
+                   PSPPIRE_TYPE_SPREADSHEET_MODEL, PsppireSpreadsheetModel))
+
+#define PSPPIRE_SPREADSHEET_MODEL_CLASS(klass) \
+                     (G_TYPE_CHECK_CLASS_CAST ((klass), \
+                                PSPPIRE_TYPE_SPREADSHEET_MODEL, \
+                                 PsppireSpreadsheetModelClass))
+
+
+#define PSPPIRE_IS_SPREADSHEET_MODEL(obj) \
+                    (G_TYPE_CHECK_INSTANCE_TYPE ((obj), PSPPIRE_TYPE_SPREADSHEET_MODEL))
+
+#define PSPPIRE_IS_SPREADSHEET_MODEL_CLASS(klass) \
+                     (G_TYPE_CHECK_CLASS_TYPE ((klass), PSPPIRE_TYPE_SPREADSHEET_MODEL))
+
+
+#define PSPPIRE_SPREADSHEET_MODEL_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), \
+                                  PSPPIRE_TYPE_SPREADSHEET_MODEL, \
+                                  PsppireSpreadsheetModelClass))
+
+typedef struct _PsppireSpreadsheetModel       PsppireSpreadsheetModel;
+typedef struct _PsppireSpreadsheetModelClass  PsppireSpreadsheetModelClass;
+
+
+struct spreadsheet;
+
+struct _PsppireSpreadsheetModel
+{
+  GObject parent;
+
+
+  /*< private >*/
+  gint stamp;
+  struct spreadsheet *spreadsheet;
+
+  gboolean dispose_has_run ;
+};
+
+
+struct _PsppireSpreadsheetModelClass
+{
+  GObjectClass parent_class;
+};
+
+
+GType psppire_spreadsheet_model_get_type (void) G_GNUC_CONST;
+
+
+GtkTreeModel * psppire_spreadsheet_model_new (struct spreadsheet *sp);
+
+
+G_END_DECLS
+
+
+enum
+{
+  PSPPIRE_SPREADSHEET_MODEL_COL_NAME,
+  PSPPIRE_SPREADSHEET_MODEL_COL_RANGE,
+  PSPPIRE_SPREADSHEET_MODEL_N_COLS
+};
+
+#endif /* __PSPPIRE_SPREADSHEET_MODEL_H__ */