Convert to utf8 in data_out function.
[pspp-builds.git] / src / ui / gui / psppire-dict.c
index 40ddf501ade9d7ec801574ee074b39610a37058b..c82395f2ebdc047e1f8678b9e9d6873df2452207 100644 (file)
@@ -1,39 +1,53 @@
-/*
-    PSPPIRE --- A Graphical User Interface for PSPP
-    Copyright (C) 2004, 2006, 2007  Free Software Foundation
+/* PSPPIRE - a graphical user interface for PSPP.
+   Copyright (C) 2004, 2006, 2007, 2009  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 2 of the License, or
-    (at your option) any later version.
+   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.
+   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, write to the Free Software
-    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-    02110-1301, USA. */
+   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 <config.h>
 #include <string.h>
 #include <stdlib.h>
 
 #include <gtk/gtk.h>
-#include <gtksheet/gtkextra-marshal.h>
+#include <ui/gui/psppire-marshal.h>
 
-#include "psppire-object.h"
 #include "psppire-dict.h"
-#include <data/format.h>
 #include <data/dictionary.h>
 #include <data/missing-values.h>
 #include <data/value-labels.h>
 #include <data/variable.h>
+#include <libpspp/i18n.h>
 
+#include "helper.h"
 #include "message-dialog.h"
 
+
+enum  {
+  BACKEND_CHANGED,
+
+  VARIABLE_CHANGED,
+  VARIABLE_RESIZED,
+  VARIABLE_INSERTED,
+  VARIABLE_DELETED,
+  VARIABLE_DISPLAY_WIDTH_CHANGED,
+
+  WEIGHT_CHANGED,
+  FILTER_CHANGED,
+  SPLIT_CHANGED,
+  n_SIGNALS
+};
+
+
 /* --- prototypes --- */
 static void psppire_dict_class_init    (PsppireDictClass       *class);
 static void psppire_dict_init  (PsppireDict            *dict);
@@ -45,15 +59,6 @@ static void dictionary_tree_model_init (GtkTreeModelIface *iface);
 /* --- variables --- */
 static GObjectClass     *parent_class = NULL;
 
-enum  {VARIABLE_CHANGED,
-       VARIABLE_RESIZED,
-       VARIABLE_INSERTED,
-       VARIABLES_DELETED,
-       WEIGHT_CHANGED,
-       FILTER_CHANGED,
-       SPLIT_CHANGED,
-       n_SIGNALS};
-
 static guint signals [n_SIGNALS];
 
 /* --- functions --- */
@@ -86,14 +91,12 @@ psppire_dict_get_type (void)
        NULL
       };
 
-      object_type = g_type_register_static (G_TYPE_PSPPIRE_OBJECT,
+      object_type = g_type_register_static (G_TYPE_OBJECT,
                                            "PsppireDict",
                                            &object_info, 0);
 
       g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
-                                 &tree_model_info);
-
-
+                                  &tree_model_info);
     }
 
   return object_type;
@@ -109,6 +112,17 @@ psppire_dict_class_init (PsppireDictClass *class)
 
   object_class->finalize = psppire_dict_finalize;
 
+  signals [BACKEND_CHANGED] =
+    g_signal_new ("backend-changed",
+                 G_TYPE_FROM_CLASS (class),
+                 G_SIGNAL_RUN_FIRST,
+                 0,
+                 NULL, NULL,
+                 g_cclosure_marshal_VOID__VOID,
+                 G_TYPE_NONE,
+                 0);
+
+
   signals [VARIABLE_CHANGED] =
     g_signal_new ("variable_changed",
                  G_TYPE_FROM_CLASS (class),
@@ -134,15 +148,16 @@ psppire_dict_class_init (PsppireDictClass *class)
                  G_TYPE_INT);
 
 
-  signals [VARIABLES_DELETED] =
-    g_signal_new ("variables_deleted",
+  signals [VARIABLE_DELETED] =
+    g_signal_new ("variable-deleted",
                  G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
-                 gtkextra_VOID__INT_INT,
+                 psppire_marshal_VOID__INT_INT_INT,
                  G_TYPE_NONE,
-                 2,
+                 3,
+                 G_TYPE_INT,
                  G_TYPE_INT,
                  G_TYPE_INT);
 
@@ -153,12 +168,23 @@ psppire_dict_class_init (PsppireDictClass *class)
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
-                 gtkextra_VOID__INT_INT,
+                 psppire_marshal_VOID__INT_INT,
                  G_TYPE_NONE,
                  2,
                  G_TYPE_INT,
                  G_TYPE_INT);
 
+  signals [VARIABLE_DISPLAY_WIDTH_CHANGED] =
+    g_signal_new ("variable-display-width-changed",
+                 G_TYPE_FROM_CLASS (class),
+                 G_SIGNAL_RUN_FIRST,
+                 0,
+                 NULL, NULL,
+                 g_cclosure_marshal_VOID__INT,
+                 G_TYPE_NONE,
+                 1,
+                 G_TYPE_INT);
+
 
   signals [WEIGHT_CHANGED] =
     g_signal_new ("weight-changed",
@@ -210,13 +236,17 @@ psppire_dict_finalize (GObject *object)
 static void
 addcb (struct dictionary *d, int idx, void *pd)
 {
-  g_signal_emit (pd, signals [VARIABLE_INSERTED], 0, idx);
+  PsppireDict *dict = PSPPIRE_DICT (pd);
+
+  if ( ! dict->disable_insert_signal)
+    g_signal_emit (dict, signals [VARIABLE_INSERTED], 0, idx);
 }
 
 static void
-delcb (struct dictionary *d, int idx, void *pd)
+delcb (struct dictionary *d, int dict_idx, int case_idx, int width, void *pd)
 {
-  g_signal_emit (pd, signals [VARIABLES_DELETED], 0, idx, 1);
+  g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
+                 dict_idx, case_idx, width );
 }
 
 static void
@@ -225,6 +255,12 @@ mutcb (struct dictionary *d, int idx, void *pd)
   g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx);
 }
 
+static void
+resize_cb (struct dictionary *d, int idx, int old_width, void *pd)
+{
+  g_signal_emit (pd, signals [VARIABLE_RESIZED], 0, idx, old_width);
+}
+
 static void
 weight_changed_callback (struct dictionary *d, int idx, void *pd)
 {
@@ -243,21 +279,31 @@ split_changed_callback (struct dictionary *d, void *pd)
   g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
 }
 
+static void
+variable_display_width_callback (struct dictionary *d, int idx, void *pd)
+{
+  g_signal_emit (pd, signals [VARIABLE_DISPLAY_WIDTH_CHANGED], 0, idx);
+}
+
+
 
 static const struct dict_callbacks gui_callbacks =
   {
     addcb,
     delcb,
     mutcb,
+    resize_cb,
     weight_changed_callback,
     filter_changed_callback,
-    split_changed_callback
+    split_changed_callback,
+    variable_display_width_callback
   };
 
 static void
 psppire_dict_init (PsppireDict *psppire_dict)
 {
   psppire_dict->stamp = g_random_int ();
+  psppire_dict->disable_insert_signal = FALSE;
 }
 
 /**
@@ -269,7 +315,7 @@ psppire_dict_init (PsppireDict *psppire_dict)
 PsppireDict*
 psppire_dict_new_from_dict (struct dictionary *d)
 {
-  PsppireDict *new_dict = g_object_new (G_TYPE_PSPPIRE_DICT, NULL);
+  PsppireDict *new_dict = g_object_new (PSPPIRE_TYPE_DICT, NULL);
   new_dict->dict = d;
 
   dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
@@ -281,7 +327,20 @@ psppire_dict_new_from_dict (struct dictionary *d)
 void
 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
 {
+  struct variable *var =  dict_get_weight (d);
+
   dict->dict = d;
+
+  weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
+
+  var = dict_get_filter (d);
+  filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
+
+  split_changed_callback (d, dict);
+
+  dict_set_callbacks (dict->dict, &gui_callbacks, dict);
+
+  g_signal_emit (dict, signals [BACKEND_CHANGED], 0);
 }
 
 
@@ -302,21 +361,27 @@ auto_generate_var_name (PsppireDict *dict)
 
 /* Insert a new variable at posn IDX, with the name NAME.
    If NAME is null, then a name will be automatically assigned.
- */
+*/
 void
 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
 {
   struct variable *var ;
   g_return_if_fail (idx >= 0);
   g_return_if_fail (d);
-  g_return_if_fail (G_IS_PSPPIRE_DICT (d));
+  g_return_if_fail (PSPPIRE_IS_DICT (d));
 
   if ( ! name )
     name = auto_generate_var_name (d);
 
+  d->disable_insert_signal = TRUE;
+
   var = dict_create_var (d->dict, name, 0);
 
   dict_reorder_var (d->dict, var, idx);
+
+  d->disable_insert_signal = FALSE;
+
+  g_signal_emit (d, signals[VARIABLE_INSERTED], 0, idx);
 }
 
 /* Delete N variables beginning at FIRST */
@@ -326,7 +391,7 @@ psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
   gint idx;
   g_return_if_fail (d);
   g_return_if_fail (d->dict);
-  g_return_if_fail (G_IS_PSPPIRE_DICT (d));
+  g_return_if_fail (PSPPIRE_IS_DICT (d));
 
   for (idx = 0 ; idx < n ; ++idx )
     {
@@ -339,17 +404,18 @@ psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
       var = dict_get_var (d->dict, first);
       dict_delete_var (d->dict, var);
     }
-  dict_compact_values (d->dict);
 }
 
 
-void
+gboolean
 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
 {
   struct variable *var;
   g_assert (d);
-  g_assert (G_IS_PSPPIRE_DICT (d));
+  g_assert (PSPPIRE_IS_DICT (d));
 
+  if ( ! var_is_valid_name (name, false))
+    return FALSE;
 
   if ( idx < dict_get_var_cnt (d->dict))
     {
@@ -362,11 +428,15 @@ psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
       /* new variable */
       dict_create_var (d->dict, name, 0);
     }
+
+  return TRUE;
 }
 
 
 
-/* Return the IDXth variable */
+/* Return the IDXth variable.
+   Will return NULL if IDX  exceeds the number of variables in the dictionary.
+ */
 struct variable *
 psppire_dict_get_variable (const PsppireDict *d, gint idx)
 {
@@ -391,6 +461,28 @@ psppire_dict_get_var_cnt (const PsppireDict *d)
 }
 
 
+/* Return the number of `union value's in the dictionary */
+size_t
+psppire_dict_get_value_cnt (const PsppireDict *d)
+{
+  g_return_val_if_fail (d, -1);
+  g_return_val_if_fail (d->dict, -1);
+
+  return dict_get_next_value_idx (d->dict);
+}
+
+
+/* Returns the prototype for the cases that match the dictionary */
+const struct caseproto *
+psppire_dict_get_proto (const PsppireDict *d)
+{
+  g_return_val_if_fail (d, NULL);
+  g_return_val_if_fail (d->dict, NULL);
+
+  return dict_get_proto (d->dict);
+}
+
+
 /* Return a variable by name.
    Return NULL if it doesn't exist
 */
@@ -422,10 +514,10 @@ psppire_dict_clear (PsppireDict *d)
 */
 gboolean
 psppire_dict_check_name (const PsppireDict *dict,
-                    const gchar *name, gboolean report)
+                        const gchar *name, gboolean report)
 {
   if ( ! var_is_valid_name (name, report ) )
-      return FALSE;
+    return FALSE;
 
   if (psppire_dict_lookup_var (dict, name))
     {
@@ -438,7 +530,7 @@ psppire_dict_check_name (const PsppireDict *dict,
 }
 
 
-inline gint
+gint
 psppire_dict_get_next_value_idx (const PsppireDict *dict)
 {
   return dict_get_next_value_idx (dict->dict);
@@ -449,20 +541,15 @@ void
 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
                              gint old_size, gint new_size)
 {
-  gint fv;
   g_return_if_fail (d);
   g_return_if_fail (d->dict);
 
   if ( old_size == new_size )
     return ;
 
-  dict_compact_values (d->dict);
-
-  fv = var_get_case_index (pv);
-
   g_signal_emit (d, signals [VARIABLE_RESIZED], 0,
-               fv + old_size,
-               new_size - old_size );
+                var_get_dict_index (pv),
+                new_size - old_size );
 }
 
 
@@ -488,6 +575,19 @@ static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
                                      GtkTreeIter *parent, gint n);
 
+static gint tree_model_n_children (GtkTreeModel *tree_model,
+                                  GtkTreeIter  *iter);
+
+static gboolean tree_model_iter_children (GtkTreeModel *,
+                                         GtkTreeIter *,
+                                         GtkTreeIter *);
+
+static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
+                                       GtkTreeIter *iter,
+                                       GtkTreeIter *child);
+
+static gboolean tree_model_iter_has_child  (GtkTreeModel *tree_model,
+                                           GtkTreeIter  *iter);
 
 static void
 dictionary_tree_model_init (GtkTreeModelIface *iface)
@@ -500,17 +600,32 @@ dictionary_tree_model_init (GtkTreeModelIface *iface)
   iface->get_path = tree_model_get_path;
   iface->get_value = tree_model_get_value;
 
-  iface->iter_children = 0;
-  iface->iter_has_child =0;
-  iface->iter_n_children =0;
+  iface->iter_children = tree_model_iter_children ;
+  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 ;
-  iface->iter_parent =0;
+  iface->iter_parent = tree_model_iter_parent ;
+}
+
+static gboolean
+tree_model_iter_has_child  (GtkTreeModel *tree_model,
+                           GtkTreeIter  *iter)
+{
+  return FALSE;
+}
+
+static gboolean
+tree_model_iter_parent (GtkTreeModel *tree_model,
+                       GtkTreeIter *iter,
+                       GtkTreeIter *child)
+{
+  return TRUE;
 }
 
 static GtkTreeModelFlags
 tree_model_get_flags (GtkTreeModel *model)
 {
-  g_return_val_if_fail (G_IS_PSPPIRE_DICT (model), (GtkTreeModelFlags) 0);
+  g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
 
   return GTK_TREE_MODEL_LIST_ONLY;
 }
@@ -525,7 +640,7 @@ tree_model_n_columns (GtkTreeModel *model)
 static GType
 tree_model_column_type (GtkTreeModel *model, gint index)
 {
-  g_return_val_if_fail (G_IS_PSPPIRE_DICT (model), (GType) 0);
+  g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
 
   switch (index)
     {
@@ -549,7 +664,7 @@ tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
 {
   gint *indices, depth;
   gint n;
-  struct variable *variable;
+  struct variable *var;
 
   PsppireDict *dict = PSPPIRE_DICT (model);
 
@@ -560,17 +675,21 @@ tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
 
   g_return_val_if_fail (depth == 1, FALSE);
 
-  n = indices[0];
+  n = indices [0];
 
   if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
-    return FALSE;
+    {
+      iter->stamp = 0;
+      iter->user_data = NULL;
+      return FALSE;
+    }
 
-  variable = dict_get_var (dict->dict, n);
+  var = psppire_dict_get_variable (dict, n);
 
-  g_assert (var_get_dict_index (variable) == n);
+  g_assert (var_get_dict_index (var) == n);
 
   iter->stamp = dict->stamp;
-  iter->user_data = variable;
+  iter->user_data = var;
 
   return TRUE;
 }
@@ -580,7 +699,7 @@ static gboolean
 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
 {
   PsppireDict *dict = PSPPIRE_DICT (model);
-  struct variable *variable;
+  struct variable *var;
   gint idx;
 
   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
@@ -588,18 +707,22 @@ tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
   if ( iter == NULL || iter->user_data == NULL)
     return FALSE;
 
-  variable = (struct variable *) iter->user_data;
+  var = iter->user_data;
 
-  idx = var_get_dict_index (variable);
+  idx = var_get_dict_index (var);
 
   if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
-    return FALSE;
+    {
+      iter->user_data = NULL;
+      iter->stamp = 0;
+      return FALSE;
+    }
 
-  variable = psppire_dict_get_variable (dict, idx + 1);
+  var = psppire_dict_get_variable (dict, idx + 1);
 
-  g_assert (var_get_dict_index (variable) == idx + 1);
+  g_assert (var_get_dict_index (var) == idx + 1);
 
-  iter->user_data = variable;
+  iter->user_data = var;
 
   return TRUE;
 }
@@ -608,15 +731,15 @@ static GtkTreePath *
 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
 {
   GtkTreePath *path;
-  struct variable *variable;
+  struct variable *var;
   PsppireDict *dict = PSPPIRE_DICT (model);
 
   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
 
-  variable = (struct variable *) iter->user_data;
+  var = iter->user_data;
 
   path = gtk_tree_path_new ();
-  gtk_tree_path_append_index (path, var_get_dict_index (variable));
+  gtk_tree_path_append_index (path, var_get_dict_index (var));
 
   return path;
 }
@@ -624,24 +747,26 @@ tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
 
 static void
 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
-                    gint column, GValue *value)
+                     gint column, GValue *value)
 {
-  struct variable *variable;
+  struct variable *var;
   PsppireDict *dict = PSPPIRE_DICT (model);
 
   g_return_if_fail (iter->stamp == dict->stamp);
 
-  variable = (struct variable *) iter->user_data;
+  var =  iter->user_data;
 
   switch (column)
     {
     case DICT_TVM_COL_NAME:
-      g_value_init (value, G_TYPE_STRING);
-      g_value_set_string (value, var_get_name (variable));
+      {
+       g_value_init (value, G_TYPE_STRING);
+       g_value_set_string (value, var_get_name (var));
+      }
       break;
     case DICT_TVM_COL_VAR:
       g_value_init (value, G_TYPE_POINTER);
-      g_value_set_pointer (value, variable);
+      g_value_set_pointer (value, var);
       break;
     default:
       g_return_if_reached ();
@@ -649,13 +774,33 @@ tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
     }
 }
 
+static gboolean
+tree_model_iter_children (GtkTreeModel *tree_model,
+                         GtkTreeIter *iter,
+                         GtkTreeIter *parent)
+{
+  return FALSE;
+}
+
+static gint
+tree_model_n_children (GtkTreeModel *model,
+                      GtkTreeIter  *iter)
+{
+  PsppireDict *dict = PSPPIRE_DICT (model);
+
+  if ( iter == NULL )
+    return psppire_dict_get_var_cnt (dict);
+
+  return 0;
+}
 
 static gboolean
 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
-                    GtkTreeIter *parent, gint n)
+                     GtkTreeIter *parent, gint n)
 {
   PsppireDict *dict;
-  g_return_val_if_fail (G_IS_PSPPIRE_DICT (model), FALSE);
+
+  g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
 
   dict = PSPPIRE_DICT (model);
 
@@ -671,24 +816,24 @@ tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
   if ( !iter->user_data)
     return FALSE;
 
-
   return TRUE;
 }
 
 
-void
+gboolean
 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
-                        const gchar *text)
+                        const gchar *name)
 {
-  dict_rename_var (dict->dict, v, text);
-}
+  if ( ! var_is_valid_name (name, false))
+    return FALSE;
+
+  /* Make sure no other variable has this name */
+  if ( NULL != psppire_dict_lookup_var (dict, name))
+    return FALSE;
 
+  dict_rename_var (dict->dict, v, name);
 
-void
-psppire_dict_set_weight_variable (PsppireDict *dict, struct variable *v)
-{
-  g_return_if_fail (v == NULL || var_is_numeric (v));
-  dict_set_weight (dict->dict, v);
+  return TRUE;
 }
 
 
@@ -697,3 +842,34 @@ psppire_dict_get_weight_variable (const PsppireDict *dict)
 {
   return dict_get_weight (dict->dict);
 }
+
+
+
+#if DEBUGGING
+void
+psppire_dict_dump (const PsppireDict *dict)
+{
+  gint i;
+  const struct dictionary *d = dict->dict;
+
+  for (i = 0; i < dict_get_var_cnt (d); ++i)
+    {
+      const struct variable *v = psppire_dict_get_variable (dict, i);
+      int di = var_get_dict_index (v);
+      g_print ("\"%s\" idx=%d, fv=%d\n",
+              var_get_name(v),
+              di,
+              var_get_case_index(v));
+
+    }
+}
+#endif
+
+
+
+
+const gchar *
+psppire_dict_encoding (const PsppireDict *dict)
+{
+  return dict_get_encoding (dict->dict);
+}