src/ui/gui/psppire-dict.c

   1 /*
   2   PSPPIRE --- A Graphical User Interface for PSPP
   3   Copyright (C) 2004, 2006, 2007  Free Software Foundation
   4
   5   This program is free software; you can redistribute it and/or modify
   6   it under the terms of the GNU General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or
   8   (at your option) any later version.
   9
  10   This program is distributed in the hope that it will be useful,
  11   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13   GNU General Public License for more details.
  14
  15   You should have received a copy of the GNU General Public License
  16   along with this program; if not, write to the Free Software
  17   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18   02110-1301, USA. */
  19
  20 #include <config.h>
  21 #include <string.h>
  22 #include <stdlib.h>
  23
  24 #include <gtk/gtk.h>
  25 #include <gtksheet/gtkextra-marshal.h>
  26
  27 #include "psppire-dict.h"
  28 #include <data/format.h>
  29 #include <data/dictionary.h>
  30 #include <data/missing-values.h>
  31 #include <data/value-labels.h>
  32 #include <data/variable.h>
  33
  34 #include "helper.h"
  35 #include "message-dialog.h"
  36
  37 /* --- prototypes --- */
  38 static void psppire_dict_class_init     (PsppireDictClass       *class);
  39 static void psppire_dict_init   (PsppireDict            *dict);
  40 static void psppire_dict_finalize       (GObject                *object);
  41
  42 static void dictionary_tree_model_init (GtkTreeModelIface *iface);
  43
  44
  45 /* --- variables --- */
  46 static GObjectClass     *parent_class = NULL;
  47
  48 enum  {VARIABLE_CHANGED,
  49        VARIABLE_RESIZED,
  50        VARIABLE_INSERTED,
  51        VARIABLES_DELETED,
  52        WEIGHT_CHANGED,
  53        FILTER_CHANGED,
  54        SPLIT_CHANGED,
  55        n_SIGNALS};
  56
  57 static guint signals [n_SIGNALS];
  58
  59 /* --- functions --- */
  60 /**
  61  * psppire_dict_get_type:
  62  * @returns: the type ID for accelerator groups.
  63  */
  64 GType
  65 psppire_dict_get_type (void)
  66 {
  67   static GType object_type = 0;
  68
  69   if (!object_type)
  70     {
  71       static const GTypeInfo object_info = {
  72         sizeof (PsppireDictClass),
  73         (GBaseInitFunc) NULL,
  74         (GBaseFinalizeFunc) NULL,
  75         (GClassInitFunc) psppire_dict_class_init,
  76         NULL,   /* class_finalize */
  77         NULL,   /* class_data */
  78         sizeof (PsppireDict),
  79         0,      /* n_preallocs */
  80         (GInstanceInitFunc) psppire_dict_init,
  81       };
  82
  83       static const GInterfaceInfo tree_model_info = {
  84         (GInterfaceInitFunc) dictionary_tree_model_init,
  85         NULL,
  86         NULL
  87       };
  88
  89       object_type = g_type_register_static (G_TYPE_OBJECT,
  90                                             "PsppireDict",
  91                                             &object_info, 0);
  92
  93       g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
  94                                    &tree_model_info);
  95
  96
  97     }
  98
  99   return object_type;
 100 }
 101
 102
 103 static void
 104 psppire_dict_class_init (PsppireDictClass *class)
 105 {
 106   GObjectClass *object_class = G_OBJECT_CLASS (class);
 107
 108   parent_class = g_type_class_peek_parent (class);
 109
 110   object_class->finalize = psppire_dict_finalize;
 111
 112   signals [VARIABLE_CHANGED] =
 113     g_signal_new ("variable_changed",
 114                   G_TYPE_FROM_CLASS (class),
 115                   G_SIGNAL_RUN_FIRST,
 116                   0,
 117                   NULL, NULL,
 118                   g_cclosure_marshal_VOID__INT,
 119                   G_TYPE_NONE,
 120                   1,
 121                   G_TYPE_INT);
 122
 123
 124
 125   signals [VARIABLE_INSERTED] =
 126     g_signal_new ("variable_inserted",
 127                   G_TYPE_FROM_CLASS (class),
 128                   G_SIGNAL_RUN_FIRST,
 129                   0,
 130                   NULL, NULL,
 131                   g_cclosure_marshal_VOID__INT,
 132                   G_TYPE_NONE,
 133                   1,
 134                   G_TYPE_INT);
 135
 136
 137   signals [VARIABLES_DELETED] =
 138     g_signal_new ("variables_deleted",
 139                   G_TYPE_FROM_CLASS (class),
 140                   G_SIGNAL_RUN_FIRST,
 141                   0,
 142                   NULL, NULL,
 143                   gtkextra_VOID__INT_INT,
 144                   G_TYPE_NONE,
 145                   2,
 146                   G_TYPE_INT,
 147                   G_TYPE_INT);
 148
 149
 150   signals [VARIABLE_RESIZED] =
 151     g_signal_new ("dict-size-changed",
 152                   G_TYPE_FROM_CLASS (class),
 153                   G_SIGNAL_RUN_FIRST,
 154                   0,
 155                   NULL, NULL,
 156                   gtkextra_VOID__INT_INT,
 157                   G_TYPE_NONE,
 158                   2,
 159                   G_TYPE_INT,
 160                   G_TYPE_INT);
 161
 162
 163   signals [WEIGHT_CHANGED] =
 164     g_signal_new ("weight-changed",
 165                   G_TYPE_FROM_CLASS (class),
 166                   G_SIGNAL_RUN_FIRST,
 167                   0,
 168                   NULL, NULL,
 169                   g_cclosure_marshal_VOID__INT,
 170                   G_TYPE_NONE,
 171                   1,
 172                   G_TYPE_INT);
 173
 174
 175   signals [FILTER_CHANGED] =
 176     g_signal_new ("filter-changed",
 177                   G_TYPE_FROM_CLASS (class),
 178                   G_SIGNAL_RUN_FIRST,
 179                   0,
 180                   NULL, NULL,
 181                   g_cclosure_marshal_VOID__INT,
 182                   G_TYPE_NONE,
 183                   1,
 184                   G_TYPE_INT);
 185
 186
 187   signals [SPLIT_CHANGED] =
 188     g_signal_new ("split-changed",
 189                   G_TYPE_FROM_CLASS (class),
 190                   G_SIGNAL_RUN_FIRST,
 191                   0,
 192                   NULL, NULL,
 193                   g_cclosure_marshal_VOID__VOID,
 194                   G_TYPE_NONE,
 195                   0);
 196 }
 197
 198 static void
 199 psppire_dict_finalize (GObject *object)
 200 {
 201   PsppireDict *d = PSPPIRE_DICT (object);
 202
 203   dict_destroy (d->dict);
 204
 205   G_OBJECT_CLASS (parent_class)->finalize (object);
 206 }
 207
 208 /* Pass on callbacks from src/data/dictionary, as
 209    signals in the Gtk library */
 210 static void
 211 addcb (struct dictionary *d, int idx, void *pd)
 212 {
 213   g_signal_emit (pd, signals [VARIABLE_INSERTED], 0, idx);
 214 }
 215
 216 static void
 217 delcb (struct dictionary *d, int idx, void *pd)
 218 {
 219   g_signal_emit (pd, signals [VARIABLES_DELETED], 0, idx, 1);
 220 }
 221
 222 static void
 223 mutcb (struct dictionary *d, int idx, void *pd)
 224 {
 225   g_signal_emit (pd, signals [VARIABLE_CHANGED], 0, idx);
 226 }
 227
 228 static void
 229 weight_changed_callback (struct dictionary *d, int idx, void *pd)
 230 {
 231   g_signal_emit (pd, signals [WEIGHT_CHANGED], 0, idx);
 232 }
 233
 234 static void
 235 filter_changed_callback (struct dictionary *d, int idx, void *pd)
 236 {
 237   g_signal_emit (pd, signals [FILTER_CHANGED], 0, idx);
 238 }
 239
 240 static void
 241 split_changed_callback (struct dictionary *d, void *pd)
 242 {
 243   g_signal_emit (pd, signals [SPLIT_CHANGED], 0);
 244 }
 245
 246
 247 static const struct dict_callbacks gui_callbacks =
 248   {
 249     addcb,
 250     delcb,
 251     mutcb,
 252     weight_changed_callback,
 253     filter_changed_callback,
 254     split_changed_callback
 255   };
 256
 257 static void
 258 psppire_dict_init (PsppireDict *psppire_dict)
 259 {
 260   psppire_dict->stamp = g_random_int ();
 261 }
 262
 263 /**
 264  * psppire_dict_new_from_dict:
 265  * @returns: a new #PsppireDict object
 266  *
 267  * Creates a new #PsppireDict.
 268  */
 269 PsppireDict*
 270 psppire_dict_new_from_dict (struct dictionary *d)
 271 {
 272   PsppireDict *new_dict = g_object_new (G_TYPE_PSPPIRE_DICT, NULL);
 273   new_dict->dict = d;
 274
 275   dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
 276
 277   return new_dict;
 278 }
 279
 280
 281 void
 282 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
 283 {
 284   dict->dict = d;
 285 }
 286
 287
 288 /* Returns a valid name for a new variable in DICT.
 289    The return value is statically allocated */
 290 static gchar *
 291 auto_generate_var_name (PsppireDict *dict)
 292 {
 293   gint d = 0;
 294   static gchar name[10];
 295
 296   while (g_snprintf (name, 10, "VAR%05d",d++),
 297          psppire_dict_lookup_var (dict, name))
 298     ;
 299
 300   return name;
 301 }
 302
 303 /* Insert a new variable at posn IDX, with the name NAME.
 304    If NAME is null, then a name will be automatically assigned.
 305 */
 306 void
 307 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
 308 {
 309   struct variable *var ;
 310   g_return_if_fail (idx >= 0);
 311   g_return_if_fail (d);
 312   g_return_if_fail (PSPPIRE_IS_DICT (d));
 313
 314   if ( ! name )
 315     name = auto_generate_var_name (d);
 316
 317   var = dict_create_var (d->dict, name, 0);
 318
 319   dict_reorder_var (d->dict, var, idx);
 320 }
 321
 322 /* Delete N variables beginning at FIRST */
 323 void
 324 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
 325 {
 326   gint idx;
 327   g_return_if_fail (d);
 328   g_return_if_fail (d->dict);
 329   g_return_if_fail (PSPPIRE_IS_DICT (d));
 330
 331   for (idx = 0 ; idx < n ; ++idx )
 332     {
 333       struct variable *var;
 334
 335       /* Do nothing if it's out of bounds */
 336       if ( first >= dict_get_var_cnt (d->dict))
 337         break;
 338
 339       var = dict_get_var (d->dict, first);
 340       dict_delete_var (d->dict, var);
 341     }
 342   dict_compact_values (d->dict);
 343 }
 344
 345
 346 gboolean
 347 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
 348 {
 349   struct variable *var;
 350   g_assert (d);
 351   g_assert (PSPPIRE_IS_DICT (d));
 352
 353   if ( ! var_is_valid_name (name, false))
 354     return FALSE;
 355
 356   if ( idx < dict_get_var_cnt (d->dict))
 357     {
 358       /* This is an existing variable? */
 359       var = dict_get_var (d->dict, idx);
 360       dict_rename_var (d->dict, var, name);
 361     }
 362   else
 363     {
 364       /* new variable */
 365       dict_create_var (d->dict, name, 0);
 366     }
 367
 368   return TRUE;
 369 }
 370
 371
 372
 373 /* Return the IDXth variable */
 374 struct variable *
 375 psppire_dict_get_variable (const PsppireDict *d, gint idx)
 376 {
 377   g_return_val_if_fail (d, NULL);
 378   g_return_val_if_fail (d->dict, NULL);
 379
 380   if ( dict_get_var_cnt (d->dict) <= idx )
 381     return NULL;
 382
 383   return dict_get_var (d->dict, idx);
 384 }
 385
 386
 387 /* Return the number of variables in the dictionary */
 388 gint
 389 psppire_dict_get_var_cnt (const PsppireDict *d)
 390 {
 391   g_return_val_if_fail (d, -1);
 392   g_return_val_if_fail (d->dict, -1);
 393
 394   return dict_get_var_cnt (d->dict);
 395 }
 396
 397
 398 /* Return a variable by name.
 399    Return NULL if it doesn't exist
 400 */
 401 struct variable *
 402 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
 403 {
 404   g_return_val_if_fail (d, NULL);
 405   g_return_val_if_fail (d->dict, NULL);
 406
 407   return dict_lookup_var (d->dict, name);
 408 }
 409
 410 /* Clears the contents of D */
 411 void
 412 psppire_dict_clear (PsppireDict *d)
 413 {
 414   g_return_if_fail (d);
 415   g_return_if_fail (d->dict);
 416
 417   {
 418     dict_clear (d->dict);
 419   }
 420 }
 421
 422
 423 /* Return true is NAME would be a valid name of a variable to add to the
 424    dictionary.  False otherwise.
 425    If REPORT is true, then invalid names will be reported as such as errors
 426 */
 427 gboolean
 428 psppire_dict_check_name (const PsppireDict *dict,
 429                          const gchar *name, gboolean report)
 430 {
 431   if ( ! var_is_valid_name (name, report ) )
 432     return FALSE;
 433
 434   if (psppire_dict_lookup_var (dict, name))
 435     {
 436       if ( report )
 437         msg (ME,"Duplicate variable name.");
 438       return FALSE;
 439     }
 440
 441   return TRUE;
 442 }
 443
 444
 445 inline gint
 446 psppire_dict_get_next_value_idx (const PsppireDict *dict)
 447 {
 448   return dict_get_next_value_idx (dict->dict);
 449 }
 450
 451
 452 void
 453 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
 454                               gint old_size, gint new_size)
 455 {
 456   gint fv;
 457   g_return_if_fail (d);
 458   g_return_if_fail (d->dict);
 459
 460   if ( old_size == new_size )
 461     return ;
 462
 463   dict_compact_values (d->dict);
 464
 465   fv = var_get_case_index (pv);
 466
 467   g_signal_emit (d, signals [VARIABLE_RESIZED], 0,
 468                  fv + old_size,
 469                  new_size - old_size );
 470 }
 471
 472
 473 /* Tree Model Stuff */
 474
 475 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
 476
 477 static gint tree_model_n_columns (GtkTreeModel *model);
 478
 479 static GType tree_model_column_type (GtkTreeModel *model, gint index);
 480
 481 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
 482                                      GtkTreePath *path);
 483
 484 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
 485
 486 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
 487                                           GtkTreeIter *iter);
 488
 489 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
 490                                   gint column, GValue *value);
 491
 492 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
 493                                       GtkTreeIter *parent, gint n);
 494
 495 static gint tree_model_n_children (GtkTreeModel *tree_model,
 496                                    GtkTreeIter  *iter);
 497
 498 static gboolean tree_model_iter_children (GtkTreeModel *,
 499                                           GtkTreeIter *,
 500                                           GtkTreeIter *);
 501
 502 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
 503                                         GtkTreeIter *iter,
 504                                         GtkTreeIter *child);
 505
 506 static gboolean tree_model_iter_has_child  (GtkTreeModel *tree_model,
 507                                             GtkTreeIter  *iter);
 508
 509 static void
 510 dictionary_tree_model_init (GtkTreeModelIface *iface)
 511 {
 512   iface->get_flags = tree_model_get_flags;
 513   iface->get_n_columns = tree_model_n_columns;
 514   iface->get_column_type = tree_model_column_type;
 515   iface->get_iter = tree_model_get_iter;
 516   iface->iter_next = tree_model_iter_next;
 517   iface->get_path = tree_model_get_path;
 518   iface->get_value = tree_model_get_value;
 519
 520   iface->iter_children = tree_model_iter_children ;
 521   iface->iter_has_child = tree_model_iter_has_child ;
 522   iface->iter_n_children = tree_model_n_children ;
 523   iface->iter_nth_child = tree_model_nth_child ;
 524   iface->iter_parent = tree_model_iter_parent ;
 525 }
 526
 527 static gboolean
 528 tree_model_iter_has_child  (GtkTreeModel *tree_model,
 529                             GtkTreeIter  *iter)
 530 {
 531   return FALSE;
 532 }
 533
 534 static gboolean
 535 tree_model_iter_parent (GtkTreeModel *tree_model,
 536                         GtkTreeIter *iter,
 537                         GtkTreeIter *child)
 538 {
 539   return TRUE;
 540 }
 541
 542 static GtkTreeModelFlags
 543 tree_model_get_flags (GtkTreeModel *model)
 544 {
 545   g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
 546
 547   return GTK_TREE_MODEL_LIST_ONLY;
 548 }
 549
 550
 551 static gint
 552 tree_model_n_columns (GtkTreeModel *model)
 553 {
 554   return n_DICT_COLS;
 555 }
 556
 557 static GType
 558 tree_model_column_type (GtkTreeModel *model, gint index)
 559 {
 560   g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
 561
 562   switch (index)
 563     {
 564     case DICT_TVM_COL_NAME:
 565       return G_TYPE_STRING;
 566       break;
 567     case DICT_TVM_COL_VAR:
 568       return G_TYPE_POINTER;
 569       break;
 570     default:
 571       g_return_val_if_reached ((GType)0);
 572       break;
 573     }
 574
 575   g_assert_not_reached ();
 576   return ((GType)0);
 577 }
 578
 579 static gboolean
 580 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
 581 {
 582   gint *indices, depth;
 583   gint n;
 584   struct variable *var;
 585
 586   PsppireDict *dict = PSPPIRE_DICT (model);
 587
 588   g_return_val_if_fail (path, FALSE);
 589
 590   indices = gtk_tree_path_get_indices (path);
 591   depth = gtk_tree_path_get_depth (path);
 592
 593   g_return_val_if_fail (depth == 1, FALSE);
 594
 595   n = indices [0];
 596
 597   if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
 598     {
 599       iter->stamp = 0;
 600       iter->user_data = NULL;
 601       return FALSE;
 602     }
 603
 604   var = psppire_dict_get_variable (dict, n);
 605
 606   g_assert (var_get_dict_index (var) == n);
 607
 608   iter->stamp = dict->stamp;
 609   iter->user_data = var;
 610
 611   return TRUE;
 612 }
 613
 614
 615 static gboolean
 616 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
 617 {
 618   PsppireDict *dict = PSPPIRE_DICT (model);
 619   struct variable *var;
 620   gint idx;
 621
 622   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
 623
 624   if ( iter == NULL || iter->user_data == NULL)
 625     return FALSE;
 626
 627   var = iter->user_data;
 628
 629   idx = var_get_dict_index (var);
 630
 631   if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
 632     {
 633       iter->user_data = NULL;
 634       iter->stamp = 0;
 635       return FALSE;
 636     }
 637
 638   var = psppire_dict_get_variable (dict, idx + 1);
 639
 640   g_assert (var_get_dict_index (var) == idx + 1);
 641
 642   iter->user_data = var;
 643
 644   return TRUE;
 645 }
 646
 647 static GtkTreePath *
 648 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
 649 {
 650   GtkTreePath *path;
 651   struct variable *var;
 652   PsppireDict *dict = PSPPIRE_DICT (model);
 653
 654   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
 655
 656   var = iter->user_data;
 657
 658   path = gtk_tree_path_new ();
 659   gtk_tree_path_append_index (path, var_get_dict_index (var));
 660
 661   return path;
 662 }
 663
 664
 665 static void
 666 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
 667                       gint column, GValue *value)
 668 {
 669   struct variable *var;
 670   PsppireDict *dict = PSPPIRE_DICT (model);
 671
 672   g_return_if_fail (iter->stamp == dict->stamp);
 673
 674   var =  iter->user_data;
 675
 676   switch (column)
 677     {
 678     case DICT_TVM_COL_NAME:
 679       {
 680       gchar *name = pspp_locale_to_utf8(var_get_name (var), -1, NULL);
 681       g_value_init (value, G_TYPE_STRING);
 682       g_value_set_string (value, name);
 683       g_free (name);
 684       }
 685       break;
 686     case DICT_TVM_COL_VAR:
 687       g_value_init (value, G_TYPE_POINTER);
 688       g_value_set_pointer (value, var);
 689       break;
 690     default:
 691       g_return_if_reached ();
 692       break;
 693     }
 694 }
 695
 696 static gboolean
 697 tree_model_iter_children (GtkTreeModel *tree_model,
 698                           GtkTreeIter *iter,
 699                           GtkTreeIter *parent)
 700 {
 701   return FALSE;
 702 }
 703
 704 static gint
 705 tree_model_n_children (GtkTreeModel *model,
 706                        GtkTreeIter  *iter)
 707 {
 708   PsppireDict *dict = PSPPIRE_DICT (model);
 709
 710   if ( iter == NULL )
 711     return psppire_dict_get_var_cnt (dict);
 712
 713   return 0;
 714 }
 715
 716 static gboolean
 717 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
 718                       GtkTreeIter *parent, gint n)
 719 {
 720   PsppireDict *dict;
 721
 722   g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
 723
 724   dict = PSPPIRE_DICT (model);
 725
 726   if ( parent )
 727     return FALSE;
 728
 729   if ( n >= psppire_dict_get_var_cnt (dict) )
 730     return FALSE;
 731
 732   iter->stamp = dict->stamp;
 733   iter->user_data = psppire_dict_get_variable (dict, n);
 734
 735   if ( !iter->user_data)
 736     return FALSE;
 737
 738   return TRUE;
 739 }
 740
 741
 742 gboolean
 743 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
 744                          const gchar *name)
 745 {
 746   if ( ! var_is_valid_name (name, false))
 747     return FALSE;
 748
 749   dict_rename_var (dict->dict, v, name);
 750
 751   return TRUE;
 752 }
 753
 754
 755 struct variable *
 756 psppire_dict_get_weight_variable (const PsppireDict *dict)
 757 {
 758   return dict_get_weight (dict->dict);
 759 }