Fix some typos (found by codespell)
[pspp] / src / ui / gui / psppire-dict.c
index 3e37343b7d10b141bb5aebcf7a1d13b27897b466..239f3ce2f3b08eb8ee47653b05884a0b4e2919c7 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPPIRE - a graphical user interface for PSPP.
-   Copyright (C) 2004, 2006, 2007  Free Software Foundation
+   Copyright (C) 2004, 2006, 2007, 2009, 2010, 2011, 2012  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
    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #include <config.h>
+
+#include "ui/gui/psppire-dict.h"
+
 #include <string.h>
 #include <stdlib.h>
-
 #include <gtk/gtk.h>
-#include <gtksheet/gtkextra-marshal.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 "data/dictionary.h"
+#include "data/identifier.h"
+#include "data/missing-values.h"
+#include "data/value-labels.h"
+#include "data/variable.h"
+#include "libpspp/i18n.h"
+#include "libpspp/message.h"
+#include "ui/gui/helper.h"
+#include "ui/gui/psppire-marshal.h"
+#include "ui/gui/psppire-var-ptr.h"
+
+#include <gettext.h>
+#define _(msgid) gettext (msgid)
+#define N_(msgid) msgid
+
+enum  {
+  BACKEND_CHANGED,
+
+  VARIABLE_CHANGED,
+  VARIABLE_INSERTED,
+  VARIABLE_DELETED,
+
+  WEIGHT_CHANGED,
+  FILTER_CHANGED,
+  SPLIT_CHANGED,
+  n_SIGNALS
+};
 
-#include "helper.h"
-#include "message-dialog.h"
 
 /* --- prototypes --- */
 static void psppire_dict_class_init    (PsppireDictClass       *class);
 static void psppire_dict_init  (PsppireDict            *dict);
-static void psppire_dict_finalize      (GObject                *object);
+static void psppire_dict_dispose       (GObject                *object);
 
 static void dictionary_tree_model_init (GtkTreeModelIface *iface);
 
@@ -42,15 +62,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 --- */
@@ -89,8 +100,6 @@ psppire_dict_get_type (void)
 
       g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
                                   &tree_model_info);
-
-
     }
 
   return object_type;
@@ -104,55 +113,57 @@ psppire_dict_class_init (PsppireDictClass *class)
 
   parent_class = g_type_class_peek_parent (class);
 
-  object_class->finalize = psppire_dict_finalize;
+  object_class->dispose = psppire_dict_dispose;
 
-  signals [VARIABLE_CHANGED] =
-    g_signal_new ("variable_changed",
+  signals [BACKEND_CHANGED] =
+    g_signal_new ("backend-changed",
                  G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
-                 g_cclosure_marshal_VOID__INT,
+                 g_cclosure_marshal_VOID__VOID,
                  G_TYPE_NONE,
-                 1,
-                 G_TYPE_INT);
-
+                 0);
 
 
-  signals [VARIABLE_INSERTED] =
-    g_signal_new ("variable_inserted",
+  signals [VARIABLE_CHANGED] =
+    g_signal_new ("variable-changed",
                  G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
-                 g_cclosure_marshal_VOID__INT,
+                 psppire_marshal_VOID__INT_UINT_POINTER,
                  G_TYPE_NONE,
-                 1,
-                 G_TYPE_INT);
+                 3,
+                 G_TYPE_INT,
+                 G_TYPE_UINT,
+                 G_TYPE_POINTER
+                 );
+
 
 
-  signals [VARIABLES_DELETED] =
-    g_signal_new ("variables_deleted",
+  signals [VARIABLE_INSERTED] =
+    g_signal_new ("variable-inserted",
                  G_TYPE_FROM_CLASS (class),
                  G_SIGNAL_RUN_FIRST,
                  0,
                  NULL, NULL,
-                 gtkextra_VOID__INT_INT,
+                 g_cclosure_marshal_VOID__INT,
                  G_TYPE_NONE,
-                 2,
-                 G_TYPE_INT,
+                 1,
                  G_TYPE_INT);
 
 
-  signals [VARIABLE_RESIZED] =
-    g_signal_new ("dict-size-changed",
+  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__POINTER_INT_INT,
                  G_TYPE_NONE,
-                 2,
+                 3,
+                 G_TYPE_POINTER,
                  G_TYPE_INT,
                  G_TYPE_INT);
 
@@ -193,13 +204,13 @@ psppire_dict_class_init (PsppireDictClass *class)
 }
 
 static void
-psppire_dict_finalize (GObject *object)
+psppire_dict_dispose (GObject *object)
 {
   PsppireDict *d = PSPPIRE_DICT (object);
 
-  dict_destroy (d->dict);
+  dict_set_callbacks (d->dict, NULL, NULL);
 
-  G_OBJECT_CLASS (parent_class)->finalize (object);
+  G_OBJECT_CLASS (parent_class)->dispose (object);
 }
 
 /* Pass on callbacks from src/data/dictionary, as
@@ -207,19 +218,24 @@ 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, const struct variable *var,
+       int dict_idx, int case_idx, void *pd)
 {
-  g_signal_emit (pd, signals [VARIABLES_DELETED], 0, idx, 1);
+  g_signal_emit (pd, signals [VARIABLE_DELETED], 0,
+                 var, dict_idx, case_idx);
 }
 
 static void
-mutcb (struct dictionary *d, int idx, void *pd)
+mutcb (struct dictionary *d, int idx, unsigned int what, const struct variable *oldvar, void *pd)
 {
-  g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx);
+  g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx, what, oldvar);
 }
 
 static void
@@ -240,7 +256,6 @@ split_changed_callback (struct dictionary *d, void *pd)
   g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
 }
 
-
 static const struct dict_callbacks gui_callbacks =
   {
     addcb,
@@ -255,6 +270,7 @@ static void
 psppire_dict_init (PsppireDict *psppire_dict)
 {
   psppire_dict->stamp = g_random_int ();
+  psppire_dict->disable_insert_signal = FALSE;
 }
 
 /**
@@ -266,7 +282,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);
@@ -279,6 +295,7 @@ 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);
@@ -289,41 +306,73 @@ psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
   split_changed_callback (d, dict);
 
   dict_set_callbacks (dict->dict, &gui_callbacks, dict);
+
+  g_signal_emit (dict, signals [BACKEND_CHANGED], 0);
 }
 
 
-/* Returns a valid name for a new variable in DICT.
-   The return value is statically allocated */
-static gchar *
-auto_generate_var_name (PsppireDict *dict)
+/* Stores a valid name for a new variable in DICT into the SIZE bytes in NAME.
+   Returns true if successful, false if SIZE is insufficient. */
+bool
+psppire_dict_generate_name (const PsppireDict *dict, char *name, size_t size)
 {
-  gint d = 0;
-  static gchar name[10];
+  gint d;
 
-  while (g_snprintf (name, 10, "VAR%05d",d++),
-        psppire_dict_lookup_var (dict, name))
-    ;
+  for (d = 1; ; d++)
+    {
+      int len;
+
+      /* TRANSLATORS: This string must be a valid variable name.  That means:
+         - The string must be at most 64 bytes (not characters) long.
+         - The string may not contain whitespace.
+         - The first character may not be '$'
+         - The first character may not be a digit
+         - The final character may not be '.' or '_'
+      */
+      len = snprintf (name, size, _("Var%04d"), d);
+      if (len + 1 >= size)
+        return false;
+
+      if (psppire_dict_lookup_var (dict, name) == NULL)
+        return true;
+    }
 
   return name;
 }
 
-/* Insert a new variable at posn IDX, with the name NAME.
+/* Insert a new variable at posn IDX, with the name NAME, and return the
+   new variable.
    If NAME is null, then a name will be automatically assigned.
 */
-void
+struct variable *
 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 (PSPPIRE_IS_DICT (d));
+  struct variable *var;
+  char tmpname[64];
+
+  g_return_val_if_fail (idx >= 0, NULL);
+  g_return_val_if_fail (d, NULL);
+  g_return_val_if_fail (PSPPIRE_IS_DICT (d), NULL);
+
+  if (name == NULL)
+    {
+      if (!psppire_dict_generate_name (d, tmpname, sizeof tmpname))
+        g_return_val_if_reached (NULL);
+
+      name = tmpname;
+    }
 
-  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);
+
+  return var;
 }
 
 /* Delete N variables beginning at FIRST */
@@ -346,7 +395,6 @@ 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);
 }
 
 
@@ -357,7 +405,7 @@ psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
   g_assert (d);
   g_assert (PSPPIRE_IS_DICT (d));
 
-  if ( ! var_is_valid_name (name, false))
+  if ( ! dict_id_is_valid (d->dict, name, false))
     return FALSE;
 
   if ( idx < dict_get_var_cnt (d->dict))
@@ -377,7 +425,9 @@ psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
 
 
 
-/* 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)
 {
@@ -402,6 +452,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
 */
@@ -435,13 +507,13 @@ gboolean
 psppire_dict_check_name (const PsppireDict *dict,
                         const gchar *name, gboolean report)
 {
-  if ( ! var_is_valid_name (name, report ) )
+  if ( ! dict_id_is_valid (dict->dict, name, report ) )
     return FALSE;
 
   if (psppire_dict_lookup_var (dict, name))
     {
       if ( report )
-       msg (ME,"Duplicate variable name.");
+       msg (ME, _("Duplicate variable name."));
       return FALSE;
     }
 
@@ -449,34 +521,13 @@ 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);
 }
 
 
-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 );
-}
-
-
 /* Tree Model Stuff */
 
 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
@@ -572,7 +623,10 @@ tree_model_column_type (GtkTreeModel *model, gint index)
       return G_TYPE_STRING;
       break;
     case DICT_TVM_COL_VAR:
-      return G_TYPE_POINTER;
+      return PSPPIRE_VAR_PTR_TYPE;
+      break;
+    case DICT_TVM_COL_LABEL:
+      return G_TYPE_STRING;
       break;
     default:
       g_return_val_if_reached ((GType)0);
@@ -626,11 +680,11 @@ tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
   struct variable *var;
   gint idx;
 
-  g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
-
   if ( iter == NULL || iter->user_data == NULL)
     return FALSE;
 
+  g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
+
   var = iter->user_data;
 
   idx = var_get_dict_index (var);
@@ -684,15 +738,13 @@ tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
     {
     case DICT_TVM_COL_NAME:
       {
-      gchar *name = pspp_locale_to_utf8(var_get_name (var), -1, NULL);
-      g_value_init (value, G_TYPE_STRING);
-      g_value_set_string (value, name);
-      g_free (name);
+       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, var);
+      g_value_init (value, PSPPIRE_VAR_PTR_TYPE);
+      g_value_set_boxed (value, var);
       break;
     default:
       g_return_if_reached ();
@@ -750,7 +802,11 @@ gboolean
 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
                         const gchar *name)
 {
-  if ( ! var_is_valid_name (name, false))
+  if ( ! dict_id_is_valid (dict->dict, 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);
@@ -764,3 +820,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);
+}