Added display sort feature to PsppireDictView
authorJohn Darrington <john@darrington.wattle.id.au>
Mon, 17 Mar 2014 20:03:27 +0000 (21:03 +0100)
committerJohn Darrington <john@darrington.wattle.id.au>
Tue, 18 Mar 2014 21:29:24 +0000 (22:29 +0100)
Added a feature to the dialog boxes where the user can choose
the sort order in which to display the variables.

NEWS
src/ui/gui/dialog-common.c
src/ui/gui/dict-display.c
src/ui/gui/dict-display.h
src/ui/gui/psppire-dialog-action-compute.c
src/ui/gui/psppire-dict.c
src/ui/gui/psppire-dictview.c
src/ui/gui/psppire-dictview.h

diff --git a/NEWS b/NEWS
index 5a0202d84402be3dd5341ae0af794713950aca03..e62e7fe48b08b6009896bd94236530444fb1d091 100644 (file)
--- a/NEWS
+++ b/NEWS
@@ -11,6 +11,9 @@ Changes since 0.8.2:
 
  * PSPPIRE graphical user interface improvements:
 
+   - Dialog boxes with source  variable lists can now choose the sort
+     order;  right click and select from the popup menu.
+
    - File|Open now allows an encoding to be selected for opening
      system files.
 
index 7472b5708fa99294de1a102ae541572b1669f2c2..0d32904d141434e55488b5c9ee1c59e6a79adf5a 100644 (file)
 
 #include <libpspp/i18n.h>
 #include "dialog-common.h"
+#include "dict-display.h"
 
 #include "psppire-var-ptr.h"
 
 #include "helper.h"
 
+/* 
+   If m is not a base TreeModel type (ie, is a filter or sorter) then 
+   convert OP to a TreePath for the base and return it.
+   The return value must be freed by the caller.
+*/
+static GtkTreePath *
+get_base_tree_path (GtkTreeModel *m, GtkTreePath *op)
+{
+  GtkTreePath *p = gtk_tree_path_copy (op);
+  while ( ! PSPPIRE_IS_DICT (m))
+    {
+      GtkTreePath *oldp = p;
+      
+      if (GTK_IS_TREE_MODEL_FILTER (m))
+       {
+         p = gtk_tree_model_filter_convert_path_to_child_path (GTK_TREE_MODEL_FILTER (m), oldp);
+         m = gtk_tree_model_filter_get_model (GTK_TREE_MODEL_FILTER (m));
+       }
+      else if (GTK_IS_TREE_MODEL_SORT (m))
+       {
+         p = gtk_tree_model_sort_convert_path_to_child_path (GTK_TREE_MODEL_SORT (m), oldp);
+         m = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (m));
+       }
+      else
+       {
+         g_error ("Unexpected model type: %s", G_OBJECT_TYPE_NAME (m));
+       }
+      
+      gtk_tree_path_free (oldp);
+    }
+
+  return p;
+}
+
 
 /* Returns FALSE if the variables represented by the union of the rows
    currently selected by SOURCE widget, and contents of the DEST
@@ -39,7 +74,8 @@ homogeneous_types (GtkWidget *source, GtkWidget *dest)
   GtkTreeIter iter;
   gboolean retval = TRUE;
 
-  GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (source));
+  GtkTreeModel *top_model = gtk_tree_view_get_model (GTK_TREE_VIEW (source));
+  GtkTreeModel *model;
 
   PsppireDict *dict;
   GtkTreeSelection *selection;
@@ -47,10 +83,8 @@ homogeneous_types (GtkWidget *source, GtkWidget *dest)
   GList *list, *l;
   bool have_type;
 
-  while (GTK_IS_TREE_MODEL_FILTER (model))
-    {
-      model = gtk_tree_model_filter_get_model (GTK_TREE_MODEL_FILTER (model));
-    }
+
+  get_base_model (top_model, NULL, &model, NULL);
 
   dict = PSPPIRE_DICT (model);
 
@@ -62,16 +96,11 @@ homogeneous_types (GtkWidget *source, GtkWidget *dest)
   have_type = false;
   for (l = list; l ; l = l->next)
     {
-      GtkTreePath *path = l->data;
-
-      GtkTreePath *fpath =
-       gtk_tree_model_filter_convert_path_to_child_path (GTK_TREE_MODEL_FILTER (model), path);
-
-      gint *idx = gtk_tree_path_get_indices (fpath);
-
+      GtkTreePath *p = get_base_tree_path (top_model, l->data);
+      gint *idx = gtk_tree_path_get_indices (p);
       const struct variable *v = psppire_dict_get_variable (dict, idx[0]);
 
-      gtk_tree_path_free (fpath);
+      gtk_tree_path_free (p);
 
       if (have_type && var_get_type (v) != type)
         {
@@ -120,35 +149,28 @@ numeric_only (GtkWidget *source, GtkWidget *dest)
 {
   gboolean retval = TRUE;
 
-  GtkTreeModel *model = gtk_tree_view_get_model (GTK_TREE_VIEW (source));
+  GtkTreeModel *top_model = gtk_tree_view_get_model (GTK_TREE_VIEW (source));
+  GtkTreeModel *model = NULL;
 
   PsppireDict *dict;
   GtkTreeSelection *selection;
   GList *list, *l;
 
-  while (GTK_IS_TREE_MODEL_FILTER (model))
-    {
-      model = gtk_tree_model_filter_get_model (GTK_TREE_MODEL_FILTER (model));
-    }
+  get_base_model (top_model, NULL, &model, NULL);
 
   dict = PSPPIRE_DICT (model);
 
   selection = gtk_tree_view_get_selection (GTK_TREE_VIEW (source));
 
-  list = gtk_tree_selection_get_selected_rows (selection, &model);
+  list = gtk_tree_selection_get_selected_rows (selection, &top_model);
 
   /* Iterate through the selection of the source treeview */
   for (l = list; l ; l = l->next)
     {
-      GtkTreePath *path = l->data;
-      GtkTreePath *fpath = gtk_tree_model_filter_convert_path_to_child_path
-       (GTK_TREE_MODEL_FILTER (model), path);
-
-      gint *idx = gtk_tree_path_get_indices (fpath);
-
+      GtkTreePath *p = get_base_tree_path (top_model, l->data);
+      gint *idx = gtk_tree_path_get_indices (p);
       const struct variable *v = psppire_dict_get_variable (dict, idx[0]);
-
-      gtk_tree_path_free (fpath);
+      gtk_tree_path_free (p);
 
       if ( var_is_alpha (v))
        {
index cb46ad5716eaf7bd2d6c2a90f243ba799332e2ef..6c4e21158fba294a0d9355239d11e8651422c166 100644 (file)
 #define _(msgid) gettext (msgid)
 #define N_(msgid) msgid
 
-static void
+
+void
 get_base_model (GtkTreeModel *top_model, GtkTreeIter *top_iter,
-               GtkTreeModel **model, GtkTreeIter *iter
-               )
+               GtkTreeModel **model, GtkTreeIter *iter)
 {
   *model = top_model;
-  *iter = *top_iter;
-  while (GTK_IS_TREE_MODEL_FILTER (*model))
-    {
-      GtkTreeIter parent_iter = *iter;
-      GtkTreeModelFilter *parent_model = GTK_TREE_MODEL_FILTER (*model);
 
-      *model = gtk_tree_model_filter_get_model (parent_model);
+  if ( iter)
+    *iter = *top_iter;
 
-      gtk_tree_model_filter_convert_iter_to_child_iter (parent_model,
-                                                       iter,
-                                                       &parent_iter);
+  while ( ! PSPPIRE_IS_DICT (*model))
+    {
+      GtkTreeIter parent_iter;
+      if (iter)
+       parent_iter = *iter;
+
+      if ( GTK_IS_TREE_MODEL_FILTER (*model))
+       {
+         GtkTreeModelFilter *parent_model = GTK_TREE_MODEL_FILTER (*model);
+
+         *model = gtk_tree_model_filter_get_model (parent_model);
+
+         if (iter)
+           gtk_tree_model_filter_convert_iter_to_child_iter (parent_model,
+                                                             iter,
+                                                             &parent_iter);
+       }
+      else if (GTK_IS_TREE_MODEL_SORT (*model))
+       {
+         GtkTreeModelSort *parent_model = GTK_TREE_MODEL_SORT (*model);
+
+         *model = gtk_tree_model_sort_get_model (parent_model);
+
+         if (iter)
+           gtk_tree_model_sort_convert_iter_to_child_iter (parent_model,
+                                                           iter,
+                                                           &parent_iter);
+       }
     }
-
-  g_assert (PSPPIRE_IS_DICT (*model));
 }
 
 
index 6a086b7ada39306c9a324ea983a092510eda2ce3..0a079bcd25bfa987dbcfddcd499dc848f6890a5e 100644 (file)
 #include "psppire-selector.h"
 
 
+void
+get_base_model (GtkTreeModel *top_model, GtkTreeIter *top_iter,
+               GtkTreeModel **model, GtkTreeIter *iter);
+
 /* A SelectItemsFunc function for GtkTreeView widgets */
 void insert_source_row_into_tree_view (GtkTreeIter source_iter,
                                       GtkWidget *dest,
index 46944c3fd3da9c37f1045fb6e639b03d92124d42..048c05de384843bd23e003e0a69ea5d291a7f4c1 100644 (file)
@@ -22,7 +22,7 @@
 #include <language/expressions/public.h>
 
 #include "psppire-var-view.h"
-
+#include "dict-display.h"
 #include "psppire-dialog.h"
 #include "psppire-keypad.h"
 #include "psppire-selector.h"
@@ -365,10 +365,10 @@ static void
 insert_source_row_into_text_view (GtkTreeIter iter,
                                  GtkWidget *dest,
                                  GtkTreeModel *model,
-                                 gpointer data
-                                 )
+                                 gpointer data)
 {
   GtkTreePath *path;
+  GtkTreeModel *m;
   PsppireDict *dict;
   gint *idx;
   struct variable *var;
@@ -377,20 +377,8 @@ insert_source_row_into_text_view (GtkTreeIter iter,
 
   g_return_if_fail (GTK_IS_TEXT_VIEW (dest));
 
-  if ( GTK_IS_TREE_MODEL_FILTER (model))
-    {
-      dict = PSPPIRE_DICT (gtk_tree_model_filter_get_model
-                          (GTK_TREE_MODEL_FILTER(model)));
-
-      gtk_tree_model_filter_convert_iter_to_child_iter (GTK_TREE_MODEL_FILTER
-                                                       (model),
-                                                       &dict_iter, &iter);
-    }
-  else
-    {
-      dict = PSPPIRE_DICT (model);
-      dict_iter = iter;
-    }
+  get_base_model (model, &iter, &m, &dict_iter);
+  dict = PSPPIRE_DICT (m);
 
   path = gtk_tree_model_get_path (GTK_TREE_MODEL (dict), &dict_iter);
 
@@ -405,7 +393,6 @@ insert_source_row_into_text_view (GtkTreeIter iter,
   erase_selection (buffer);
 
   gtk_text_buffer_insert_at_cursor (buffer, var_get_name (var), -1);
-
 }
 
 static void
index 5e95550efb24e5dafa99499b8c56ca98cc960895..b88bbe7766300a6a110bd211902c5e5aa95691c7 100644 (file)
@@ -625,6 +625,9 @@ tree_model_column_type (GtkTreeModel *model, gint index)
     case DICT_TVM_COL_VAR:
       return PSPPIRE_VAR_PTR_TYPE;
       break;
+    case DICT_TVM_COL_LABEL:
+      return G_TYPE_STRING;
+      break;
     default:
       g_return_val_if_reached ((GType)0);
       break;
index 23073a5f264821036208c0bc2d2057c471e21249..b51d9ad4f031998f16df3c7d1cff8557b5e04c9f 100644 (file)
@@ -19,6 +19,7 @@
 #include <gtk/gtk.h>
 #include "psppire-dictview.h"
 #include "psppire-dict.h"
+#include "dict-display.h"
 #include "psppire-conf.h"
 #include <data/format.h>
 #include <libpspp/i18n.h>
@@ -33,7 +34,6 @@ static void psppire_dict_view_base_init     (PsppireDictViewClass *class);
 static void psppire_dict_view_class_init    (PsppireDictViewClass *class);
 static void psppire_dict_view_init          (PsppireDictView      *dict_view);
 
-
 GType
 psppire_dict_view_get_type (void)
 {
@@ -81,18 +81,24 @@ enum
 };
 
 
+
 /* A GtkTreeModelFilterVisibleFunc to filter lines in the treeview */
 static gboolean
-filter_variables (GtkTreeModel *model, GtkTreeIter *iter, gpointer data)
+filter_variables (GtkTreeModel *tmodel, GtkTreeIter *titer, gpointer data)
 {
   var_predicate_func *predicate = data;
   struct variable *var;
-  PsppireDict *dict = PSPPIRE_DICT (model);
-
-  GtkTreePath *path = gtk_tree_model_get_path (model, iter);
+  GtkTreeModel *model = NULL;
+  GtkTreeIter iter ;
+  PsppireDict *dict ;
+  GtkTreePath *path ;
+  gint *idx;
 
-  gint *idx = gtk_tree_path_get_indices (path);
+  get_base_model (tmodel, titer, &model, &iter);
 
+  dict = PSPPIRE_DICT (model);
+  path = gtk_tree_model_get_path (model, &iter);
+  idx = gtk_tree_path_get_indices (path);
   var =  psppire_dict_get_variable (dict, *idx);
 
   gtk_tree_path_free (path);
@@ -100,18 +106,70 @@ filter_variables (GtkTreeModel *model, GtkTreeIter *iter, gpointer data)
   return predicate (var);
 }
 
+
+static gint
+unsorted (GtkTreeModel *model,
+     GtkTreeIter *a,
+     GtkTreeIter *b,
+     gpointer user_data)
+{
+  const struct variable *var_a;
+  const struct variable *var_b;
+
+
+  gtk_tree_model_get (model, a, DICT_TVM_COL_VAR,  &var_a, -1);
+  gtk_tree_model_get (model, b, DICT_TVM_COL_VAR,  &var_b, -1);
+
+  return compare_var_ptrs_by_dict_index (&var_a, &var_b, NULL);
+}
+
+static gint
+sort_by_name (GtkTreeModel *model,
+     GtkTreeIter *a,
+     GtkTreeIter *b,
+     gpointer user_data)
+{
+  const struct variable *var_a;
+  const struct variable *var_b;
+
+  gtk_tree_model_get (model, a, DICT_TVM_COL_VAR,  &var_a, -1);
+  gtk_tree_model_get (model, b, DICT_TVM_COL_VAR,  &var_b, -1);
+
+  return g_strcmp0 (var_get_name (var_a), var_get_name (var_b));
+}
+
+
+static gint
+sort_by_label (GtkTreeModel *model,
+     GtkTreeIter *a,
+     GtkTreeIter *b,
+     gpointer user_data)
+{
+  const struct variable *var_a;
+  const struct variable *var_b;
+
+  gtk_tree_model_get (model, a, DICT_TVM_COL_VAR,  &var_a, -1);
+  gtk_tree_model_get (model, b, DICT_TVM_COL_VAR,  &var_b, -1);
+
+  return g_strcmp0 (var_get_label (var_a), var_get_label (var_b));
+}
+
 static void
 set_model (PsppireDictView *dict_view)
 {
-  GtkTreeModel *model ;
+  GtkTreeModel *model = NULL;
 
   if ( dict_view->dict == NULL)
     return;
 
+  dict_view->sorted_model = gtk_tree_model_sort_new_with_model (GTK_TREE_MODEL (dict_view->dict));
+  gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dict_view->sorted_model), unsorted, dict_view, 0);
+  gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (dict_view->sorted_model), 
+                                       GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, GTK_SORT_ASCENDING);
+
    if ( dict_view->predicate )
     {
-      model = gtk_tree_model_filter_new (GTK_TREE_MODEL (dict_view->dict),
-                                        NULL);
+      model = gtk_tree_model_filter_new (dict_view->sorted_model,       NULL);
 
       gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (model),
                                              filter_variables,
@@ -120,7 +178,7 @@ set_model (PsppireDictView *dict_view)
     }
   else
     {
-      model = GTK_TREE_MODEL (dict_view->dict);
+      model = dict_view->sorted_model;
       g_object_ref (model);
     }
 
@@ -250,46 +308,6 @@ psppire_dict_view_base_finalize (PsppireDictViewClass *class,
 }
 
 
-static void
-dv_get_base_model (GtkTreeModel *top_model, GtkTreeIter *top_iter,
-               GtkTreeModel **model, GtkTreeIter *iter)
-{
-  *model = top_model;
-
-  if ( iter)
-    *iter = *top_iter;
-
-  while ( ! PSPPIRE_IS_DICT (*model))
-    {
-      GtkTreeIter parent_iter;
-      if (iter)
-       parent_iter = *iter;
-
-      if ( GTK_IS_TREE_MODEL_FILTER (*model))
-       {
-         GtkTreeModelFilter *parent_model = GTK_TREE_MODEL_FILTER (*model);
-
-         *model = gtk_tree_model_filter_get_model (parent_model);
-
-         if (iter)
-           gtk_tree_model_filter_convert_iter_to_child_iter (parent_model,
-                                                             iter,
-                                                             &parent_iter);
-       }
-      else if (GTK_IS_TREE_MODEL_SORT (*model))
-       {
-         GtkTreeModelSort *parent_model = GTK_TREE_MODEL_SORT (*model);
-
-         *model = gtk_tree_model_sort_get_model (parent_model);
-
-         if (iter)
-           gtk_tree_model_sort_convert_iter_to_child_iter (parent_model,
-                                                           iter,
-                                                           &parent_iter);
-       }
-    }
-}
-
 
 
 /* A GtkTreeCellDataFunc which renders the name and/or label of the
@@ -306,7 +324,7 @@ var_description_cell_data_func (GtkTreeViewColumn *col,
   GtkTreeIter iter;
   GtkTreeModel *model;
 
-  dv_get_base_model (top_model, top_iter, &model, &iter);
+  get_base_model (top_model, top_iter, &model, &iter);
 
   gtk_tree_model_get (model,
                      &iter, DICT_TVM_COL_VAR, &var, -1);
@@ -432,7 +450,7 @@ set_tooltip_for_variable (GtkTreeView  *treeview,
     const gchar *tip ;
     GtkTreeModel *m;
 
-    dv_get_base_model (tree_model, NULL, &m, NULL);
+    get_base_model (tree_model, NULL, &m, NULL);
 
     if ( PSPPIRE_DICT_VIEW (treeview)->prefer_labels )
       tip = var_get_name (var);
@@ -468,6 +486,46 @@ toggle_label_preference (GtkCheckMenuItem *checkbox, gpointer data)
 }
 
 
+static void
+set_sort_criteria (GtkCheckMenuItem *checkbox, PsppireDictView *dv, GtkTreeIterCompareFunc func)
+{
+  if (!gtk_check_menu_item_get_active (checkbox))
+    {
+      gtk_widget_queue_draw (GTK_WIDGET (dv));
+      return;
+    }
+
+
+  gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dv->sorted_model), func, 0, 0);
+
+
+  gtk_widget_queue_draw (GTK_WIDGET (dv));
+}
+
+static void
+set_sort_criteria_name (GtkCheckMenuItem *checkbox, gpointer data)
+{
+  PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
+  set_sort_criteria (checkbox, dv, sort_by_name);
+}
+
+
+static void
+set_sort_criteria_label (GtkCheckMenuItem *checkbox, gpointer data)
+{
+  PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
+  set_sort_criteria (checkbox, dv, sort_by_label);
+}
+
+
+static void
+set_sort_criteria_unsorted (GtkCheckMenuItem *checkbox, gpointer data)
+{
+  PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
+  set_sort_criteria (checkbox, dv, unsorted);
+}
+
+
 
 static void
 psppire_dict_view_init (PsppireDictView *dict_view)
@@ -477,6 +535,7 @@ psppire_dict_view_init (PsppireDictView *dict_view)
   GtkCellRenderer *renderer = gtk_cell_renderer_pixbuf_new ();
 
   dict_view->prefer_labels = TRUE;
+  dict_view->sorted_model = NULL;
 
   psppire_conf_get_boolean (psppire_conf_new (),
                            G_OBJECT_TYPE_NAME (dict_view),
@@ -519,18 +578,36 @@ psppire_dict_view_init (PsppireDictView *dict_view)
 
 
   {
-    GtkWidget *checkbox =
+    GSList *group = NULL;
+    GtkWidget *item =
       gtk_check_menu_item_new_with_label  (_("Prefer variable labels"));
 
-    gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (checkbox),
+    gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item),
                                    dict_view->prefer_labels);
 
-    g_signal_connect (checkbox, "toggled",
+    g_signal_connect (item, "toggled",
                      G_CALLBACK (toggle_label_preference), dict_view);
 
+    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
+
+    item = gtk_separator_menu_item_new ();
+    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
+
+    item = gtk_radio_menu_item_new_with_label (group, _("Unsorted (dictionary order)"));
+    group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
+    gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
+    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
+    g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_unsorted), dict_view);
 
-    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), checkbox);
+    item = gtk_radio_menu_item_new_with_label (group, _("Sort by name"));
+    group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
+    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
+    g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_name), dict_view);
 
+    item = gtk_radio_menu_item_new_with_label (group, _("Sort by label"));
+    group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
+    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
+    g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_label), dict_view);
   }
 
   gtk_widget_show_all (dict_view->menu);
@@ -557,7 +634,7 @@ psppire_dict_view_iter_to_var (PsppireDictView *dict_view,
   GtkTreeModel *model;
   GtkTreeIter iter;
 
-  dv_get_base_model (top_model, top_iter, &model, &iter);
+  get_base_model (top_model, top_iter, &model, &iter);
 
   g_assert (PSPPIRE_IS_DICT (model));
 
index 96a13297e00c3cec4a7f5f0cbf1f1dad959f43d4..622ed6135cb9670f7be3c19a594bad12298c4366 100644 (file)
@@ -52,6 +52,7 @@ struct _PsppireDictView
   var_predicate_func *predicate;
   GtkWidget *menu;
   gboolean prefer_labels;
+  GtkTreeModel *sorted_model;
 };
 
 struct _PsppireDictViewClass