Automatically infer variables' measurement level from format and data.
[pspp] / src / ui / gui / psppire-dictview.c
index fc2c0325613f81d8c7534e831efa232940766b2e..5e998fc6f08946a562e565c2648de1103fe0382e 100644 (file)
@@ -1,5 +1,6 @@
 /* PSPPIRE - a graphical user interface for PSPP.
-   Copyright (C) 2009, 2010, 2011, 2012, 2013, 2017  Free Software Foundation
+   Copyright (C) 2009, 2010, 2011, 2012, 2013, 2017,
+   2020  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 <libpspp/i18n.h>
 #include "helper.h"
 
+#include "psppire-dialog.h"
+#include "psppire-var-info.h"
+#include "psppire-buttonbox.h"
+
 #include <gettext.h>
 #define _(msgid) gettext (msgid)
 #define N_(msgid) msgid
 
-static void psppire_dict_view_base_finalize (PsppireDictViewClass *, gpointer);
-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)
-{
-  static GType psppire_dict_view_type = 0;
-
-  if (!psppire_dict_view_type)
-    {
-      static const GTypeInfo psppire_dict_view_info =
-      {
-       sizeof (PsppireDictViewClass),
-       (GBaseInitFunc) psppire_dict_view_base_init,
-        (GBaseFinalizeFunc) psppire_dict_view_base_finalize,
-       (GClassInitFunc)psppire_dict_view_class_init,
-       (GClassFinalizeFunc) NULL,
-       NULL,
-        sizeof (PsppireDictView),
-       0,
-       (GInstanceInitFunc) psppire_dict_view_init,
-      };
-
-      psppire_dict_view_type =
-       g_type_register_static (GTK_TYPE_TREE_VIEW, "PsppireDictView",
-                               &psppire_dict_view_info, 0);
-    }
-
-  return psppire_dict_view_type;
-}
-
+G_DEFINE_TYPE (PsppireDictView, psppire_dict_view, GTK_TYPE_TREE_VIEW)
 
 static void
 psppire_dict_view_finalize (GObject *object)
@@ -113,14 +89,18 @@ unsorted (GtkTreeModel *model,
      GtkTreeIter *b,
      gpointer user_data)
 {
-  const struct variable *var_a;
-  const struct variable *var_b;
-
+  struct variable *var_a;
+  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);
+  gint rval = compare_var_ptrs_by_dict_index (&var_a, &var_b, NULL);
+
+  var_unref (var_a);
+  var_unref (var_b);
+
+  return rval;
 }
 
 static gint
@@ -129,13 +109,18 @@ sort_by_name (GtkTreeModel *model,
      GtkTreeIter *b,
      gpointer user_data)
 {
-  const struct variable *var_a;
-  const struct variable *var_b;
+  struct variable *var_a;
+  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));
+  gint rval =  g_strcmp0 (var_get_name (var_a), var_get_name (var_b));
+
+  var_unref (var_a);
+  var_unref (var_b);
+
+  return rval;
 }
 
 
@@ -145,13 +130,18 @@ sort_by_label (GtkTreeModel *model,
      GtkTreeIter *b,
      gpointer user_data)
 {
-  const struct variable *var_a;
-  const struct variable *var_b;
+  struct variable *var_a;
+  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));
+  gint rval = g_strcmp0 (var_get_label (var_a), var_get_label (var_b));
+
+  var_unref (var_a);
+  var_unref (var_b);
+
+  return rval;
 }
 
 
@@ -189,7 +179,7 @@ set_model (PsppireDictView *dict_view)
 {
   GtkTreeModel *model = NULL;
 
-  if ( dict_view->dict == NULL)
+  if (dict_view->dict == NULL)
     return;
 
   dict_view->sorted_model = gtk_tree_model_sort_new_with_model (GTK_TREE_MODEL (dict_view->dict));
@@ -197,7 +187,7 @@ set_model (PsppireDictView *dict_view)
   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 )
+   if (dict_view->predicate)
     {
       model = gtk_tree_model_filter_new (dict_view->sorted_model,       NULL);
 
@@ -275,6 +265,7 @@ psppire_dict_view_get_property (GObject         *object,
 
        g_value_set_enum (value, gtk_tree_selection_get_mode (selection));
       }
+      break;
     default:
       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
       break;
@@ -288,6 +279,8 @@ psppire_dict_view_class_init (PsppireDictViewClass *class)
 {
   GObjectClass *object_class = G_OBJECT_CLASS (class);
 
+  object_class->finalize = psppire_dict_view_finalize;
+
   GParamSpec *predicate_spec =
     g_param_spec_pointer ("predicate",
                          "Predicate",
@@ -319,24 +312,6 @@ psppire_dict_view_class_init (PsppireDictViewClass *class)
                                    selection_mode_spec);
 }
 
-
-static void
-psppire_dict_view_base_init (PsppireDictViewClass *class)
-{
-  GObjectClass *object_class = G_OBJECT_CLASS (class);
-
-  object_class->finalize = psppire_dict_view_finalize;
-}
-
-
-
-static void
-psppire_dict_view_base_finalize (PsppireDictViewClass *class,
-                                gpointer class_data)
-{
-
-}
-
 static gboolean
 use_labels (PsppireDictView *dv)
 {
@@ -389,6 +364,8 @@ var_description_cell_data_func (GtkTreeViewColumn *col,
     {
       g_object_set (cell, "text", var_get_name (var), NULL);
     }
+
+  var_unref (var);
 }
 
 
@@ -411,6 +388,8 @@ var_icon_cell_data_func (GtkTreeViewColumn *col,
                "icon-name", get_var_measurement_stock_id (var_get_print_format (var)->type,
                                                           var_get_measure (var)),
                 NULL);
+
+  var_unref (var);
 }
 
 const char *
@@ -421,6 +400,7 @@ get_var_measurement_stock_id (enum fmt_type type, enum measure measure)
     case FMT_CAT_STRING:
       switch (measure)
        {
+       case MEASURE_UNKNOWN: return "role-none";
        case MEASURE_NOMINAL: return "measure-string-nominal";
        case MEASURE_ORDINAL: return "measure-string-ordinal";
        case MEASURE_SCALE:   return "role-none";
@@ -432,6 +412,7 @@ get_var_measurement_stock_id (enum fmt_type type, enum measure measure)
     case FMT_CAT_TIME:
       switch (measure)
         {
+        case MEASURE_UNKNOWN: return "role-none";
         case MEASURE_NOMINAL: return "measure-date-nominal";
         case MEASURE_ORDINAL: return "measure-date-ordinal";
         case MEASURE_SCALE:   return "measure-date-scale";
@@ -442,6 +423,7 @@ get_var_measurement_stock_id (enum fmt_type type, enum measure measure)
     default:
       switch (measure)
         {
+        case MEASURE_UNKNOWN: return "role-none";
         case MEASURE_NOMINAL: return "measure-nominal";
         case MEASURE_ORDINAL: return "measure-ordinal";
         case MEASURE_SCALE:   return "measure-scale";
@@ -488,11 +470,13 @@ set_tooltip_for_variable (GtkTreeView  *treeview,
   if (!ok)
     return FALSE;
 
-
   gtk_tree_model_get (tree_model, &iter, DICT_TVM_COL_VAR,  &var, -1);
 
-  if ( ! var_has_label (var))
-    return FALSE;
+  if (! var_has_label (var))
+    {
+      var_unref (var);
+      return FALSE;
+    }
 
   {
     const gchar *tip ;
@@ -500,7 +484,7 @@ set_tooltip_for_variable (GtkTreeView  *treeview,
 
     get_base_model (tree_model, NULL, &m, NULL);
 
-    if ( use_labels (PSPPIRE_DICT_VIEW (treeview)))
+    if (use_labels (PSPPIRE_DICT_VIEW (treeview)))
       tip = var_get_name (var);
     else
       tip = var_get_label (var);
@@ -508,15 +492,54 @@ set_tooltip_for_variable (GtkTreeView  *treeview,
     gtk_tooltip_set_text (tooltip, tip);
   }
 
+  var_unref (var);
   return TRUE;
 }
 
+static struct variable *
+psppire_dict_view_iter_to_var (PsppireDictView *dict_view,
+                               GtkTreeIter *top_iter)
+{
+  GtkTreeView *treeview = GTK_TREE_VIEW (dict_view);
+  GtkTreeModel *top_model = gtk_tree_view_get_model (treeview);
+
+  struct variable *var;
+  GtkTreeModel *model;
+  GtkTreeIter iter;
+
+  get_base_model (top_model, top_iter, &model, &iter);
+  g_assert (PSPPIRE_IS_DICT (model));
+
+  gtk_tree_model_get (model,
+                     &iter, DICT_TVM_COL_VAR, &var, -1);
+
+  return var;
+}
+
 static gboolean
 show_menu (PsppireDictView *dv, GdkEvent *event, gpointer data)
 {
-  if (((GdkEventButton *) event)->button != 3)
+  GdkEventButton *button_event = (GdkEventButton *) event;
+  if (button_event->button != 3)
     return FALSE;
 
+  dv->var_under_cursor = NULL;
+  GtkTreePath *path = NULL;
+  gboolean is_row =
+    gtk_tree_view_get_path_at_pos (GTK_TREE_VIEW (dv),
+                                   button_event->x, button_event->y,
+                                   &path, NULL, NULL, NULL);
+  if (is_row)
+    {
+      GtkTreeIter iter;
+      GtkTreeModel *top_model = gtk_tree_view_get_model (GTK_TREE_VIEW (dv));
+      gtk_tree_model_get_iter (top_model, &iter, path);
+      dv->var_under_cursor = psppire_dict_view_iter_to_var (dv, &iter);
+    }
+  gtk_tree_path_free (path);
+
+  gtk_widget_set_sensitive (GTK_WIDGET (dv->var_info_check), is_row);
+
   gtk_menu_popup_at_pointer (GTK_MENU (dv->menu), event);
 
   return TRUE;
@@ -587,7 +610,51 @@ set_sort_criteria_unsorted (GtkCheckMenuItem *checkbox, gpointer data)
   set_sort_criteria (checkbox, dv, unsorted);
 }
 
+static void
+check_item_set_inactive (GtkCheckMenuItem *cmi)
+{
+  gtk_check_menu_item_set_active (cmi, FALSE);
+}
 
+static void
+pop_up_down_variable_information (GtkCheckMenuItem *cmi, PsppireDictView *dv)
+{
+  gboolean active;
+  g_object_get (cmi, "active", &active, NULL);
+
+  g_return_if_fail (dv->var_under_cursor);
+
+  if (!active)
+    return;
+
+  GtkWidget *dialog = psppire_dialog_new ();
+  g_object_set (dialog,
+                "title", _("Variable Details"),
+                "help-page", "Manipulating-Variables",
+                NULL);
+
+  GtkWidget *box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 5);
+  gtk_container_add (GTK_CONTAINER (dialog), box);
+
+  GtkWidget *var_info = psppire_var_info_new ();
+  g_object_set (var_info, "variable", dv->var_under_cursor, NULL);
+  gtk_box_pack_start (GTK_BOX (box), var_info, TRUE, TRUE, 5);
+
+  GtkWidget *button_box = psppire_button_box_new ();
+  g_object_set (button_box,
+                "buttons", PSPPIRE_BUTTON_CLOSE_MASK | PSPPIRE_BUTTON_HELP_MASK,
+                NULL);
+  g_object_set (button_box, "layout-style", GTK_BUTTONBOX_SPREAD, NULL);
+  gtk_box_pack_start (GTK_BOX (box), button_box, FALSE, TRUE, 5);
+
+  g_signal_connect_swapped (dialog, "unmap",
+                            G_CALLBACK (check_item_set_inactive), cmi);
+
+  gtk_widget_show_all (box);
+  gtk_window_set_modal (GTK_WINDOW (dialog), TRUE);
+
+  psppire_dialog_run (PSPPIRE_DIALOG (dialog));
+}
 
 static void
 psppire_dict_view_init (PsppireDictView *dict_view)
@@ -598,6 +665,7 @@ psppire_dict_view_init (PsppireDictView *dict_view)
 
   dict_view->prefer_labels_override = FALSE;
   dict_view->sorted_model = NULL;
+  dict_view->var_under_cursor = NULL;
 
   gtk_tree_view_column_set_title (col, _("Variable"));
 
@@ -670,6 +738,14 @@ psppire_dict_view_init (PsppireDictView *dict_view)
     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);
+
+    item = gtk_separator_menu_item_new ();
+    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
+
+    item = gtk_check_menu_item_new_with_label (_("Variable Information"));
+    dict_view->var_info_check = item;
+    gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
+    g_signal_connect (item, "toggled", G_CALLBACK (pop_up_down_variable_information), dict_view);
   }
 
   gtk_widget_show_all (dict_view->menu);
@@ -678,34 +754,6 @@ psppire_dict_view_init (PsppireDictView *dict_view)
                    G_CALLBACK (show_menu), NULL);
 }
 
-
-GtkWidget*
-psppire_dict_view_new (void)
-{
-  return GTK_WIDGET (g_object_new (psppire_dict_view_get_type (), NULL));
-}
-
-static struct variable *
-psppire_dict_view_iter_to_var (PsppireDictView *dict_view,
-                               GtkTreeIter *top_iter)
-{
-  GtkTreeView *treeview = GTK_TREE_VIEW (dict_view);
-  GtkTreeModel *top_model = gtk_tree_view_get_model (treeview);
-
-  struct variable *var;
-  GtkTreeModel *model;
-  GtkTreeIter iter;
-
-  get_base_model (top_model, top_iter, &model, &iter);
-
-  g_assert (PSPPIRE_IS_DICT (model));
-
-  gtk_tree_model_get (model,
-                     &iter, DICT_TVM_COL_VAR, &var, -1);
-
-  return var;
-}
-
 struct get_vars_aux
   {
     PsppireDictView *dict_view;
@@ -757,5 +805,3 @@ psppire_dict_view_get_selected_variable (PsppireDictView *dict_view)
   else
     return NULL;
 }
-
-