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   struct variable *var =  dict_get_weight (d);
 285   dict->dict = d;
 286
 287   weight_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
 288
 289   var = dict_get_filter (d);
 290   filter_changed_callback (d, var ? var_get_dict_index (var) : -1, dict);
 291
 292   split_changed_callback (d, dict);
 293
 294   dict_set_callbacks (dict->dict, &gui_callbacks, dict);
 295 }
 296
 297
 298 /* Returns a valid name for a new variable in DICT.
 299    The return value is statically allocated */
 300 static gchar *
 301 auto_generate_var_name (PsppireDict *dict)
 302 {
 303   gint d = 0;
 304   static gchar name[10];
 305
 306   while (g_snprintf (name, 10, "VAR%05d",d++),
 307          psppire_dict_lookup_var (dict, name))
 308     ;
 309
 310   return name;
 311 }
 312
 313 /* Insert a new variable at posn IDX, with the name NAME.
 314    If NAME is null, then a name will be automatically assigned.
 315 */
 316 void
 317 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
 318 {
 319   struct variable *var ;
 320   g_return_if_fail (idx >= 0);
 321   g_return_if_fail (d);
 322   g_return_if_fail (PSPPIRE_IS_DICT (d));
 323
 324   if ( ! name )
 325     name = auto_generate_var_name (d);
 326
 327   var = dict_create_var (d->dict, name, 0);
 328
 329   dict_reorder_var (d->dict, var, idx);
 330 }
 331
 332 /* Delete N variables beginning at FIRST */
 333 void
 334 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
 335 {
 336   gint idx;
 337   g_return_if_fail (d);
 338   g_return_if_fail (d->dict);
 339   g_return_if_fail (PSPPIRE_IS_DICT (d));
 340
 341   for (idx = 0 ; idx < n ; ++idx )
 342     {
 343       struct variable *var;
 344
 345       /* Do nothing if it's out of bounds */
 346       if ( first >= dict_get_var_cnt (d->dict))
 347         break;
 348
 349       var = dict_get_var (d->dict, first);
 350       dict_delete_var (d->dict, var);
 351     }
 352   dict_compact_values (d->dict);
 353 }
 354
 355
 356 gboolean
 357 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
 358 {
 359   struct variable *var;
 360   g_assert (d);
 361   g_assert (PSPPIRE_IS_DICT (d));
 362
 363   if ( ! var_is_valid_name (name, false))
 364     return FALSE;
 365
 366   if ( idx < dict_get_var_cnt (d->dict))
 367     {
 368       /* This is an existing variable? */
 369       var = dict_get_var (d->dict, idx);
 370       dict_rename_var (d->dict, var, name);
 371     }
 372   else
 373     {
 374       /* new variable */
 375       dict_create_var (d->dict, name, 0);
 376     }
 377
 378   return TRUE;
 379 }
 380
 381
 382
 383 /* Return the IDXth variable */
 384 struct variable *
 385 psppire_dict_get_variable (const PsppireDict *d, gint idx)
 386 {
 387   g_return_val_if_fail (d, NULL);
 388   g_return_val_if_fail (d->dict, NULL);
 389
 390   if ( dict_get_var_cnt (d->dict) <= idx )
 391     return NULL;
 392
 393   return dict_get_var (d->dict, idx);
 394 }
 395
 396
 397 /* Return the number of variables in the dictionary */
 398 gint
 399 psppire_dict_get_var_cnt (const PsppireDict *d)
 400 {
 401   g_return_val_if_fail (d, -1);
 402   g_return_val_if_fail (d->dict, -1);
 403
 404   return dict_get_var_cnt (d->dict);
 405 }
 406
 407
 408 /* Return a variable by name.
 409    Return NULL if it doesn't exist
 410 */
 411 struct variable *
 412 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
 413 {
 414   g_return_val_if_fail (d, NULL);
 415   g_return_val_if_fail (d->dict, NULL);
 416
 417   return dict_lookup_var (d->dict, name);
 418 }
 419
 420 /* Clears the contents of D */
 421 void
 422 psppire_dict_clear (PsppireDict *d)
 423 {
 424   g_return_if_fail (d);
 425   g_return_if_fail (d->dict);
 426
 427   {
 428     dict_clear (d->dict);
 429   }
 430 }
 431
 432
 433 /* Return true is NAME would be a valid name of a variable to add to the
 434    dictionary.  False otherwise.
 435    If REPORT is true, then invalid names will be reported as such as errors
 436 */
 437 gboolean
 438 psppire_dict_check_name (const PsppireDict *dict,
 439                          const gchar *name, gboolean report)
 440 {
 441   if ( ! var_is_valid_name (name, report ) )
 442     return FALSE;
 443
 444   if (psppire_dict_lookup_var (dict, name))
 445     {
 446       if ( report )
 447         msg (ME,"Duplicate variable name.");
 448       return FALSE;
 449     }
 450
 451   return TRUE;
 452 }
 453
 454
 455 inline gint
 456 psppire_dict_get_next_value_idx (const PsppireDict *dict)
 457 {
 458   return dict_get_next_value_idx (dict->dict);
 459 }
 460
 461
 462 void
 463 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
 464                               gint old_size, gint new_size)
 465 {
 466   gint fv;
 467   g_return_if_fail (d);
 468   g_return_if_fail (d->dict);
 469
 470   if ( old_size == new_size )
 471     return ;
 472
 473   dict_compact_values (d->dict);
 474
 475   fv = var_get_case_index (pv);
 476
 477   g_signal_emit (d, signals [VARIABLE_RESIZED], 0,
 478                  fv + old_size,
 479                  new_size - old_size );
 480 }
 481
 482
 483 /* Tree Model Stuff */
 484
 485 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
 486
 487 static gint tree_model_n_columns (GtkTreeModel *model);
 488
 489 static GType tree_model_column_type (GtkTreeModel *model, gint index);
 490
 491 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
 492                                      GtkTreePath *path);
 493
 494 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
 495
 496 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
 497                                           GtkTreeIter *iter);
 498
 499 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
 500                                   gint column, GValue *value);
 501
 502 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
 503                                       GtkTreeIter *parent, gint n);
 504
 505 static gint tree_model_n_children (GtkTreeModel *tree_model,
 506                                    GtkTreeIter  *iter);
 507
 508 static gboolean tree_model_iter_children (GtkTreeModel *,
 509                                           GtkTreeIter *,
 510                                           GtkTreeIter *);
 511
 512 static gboolean tree_model_iter_parent (GtkTreeModel *tree_model,
 513                                         GtkTreeIter *iter,
 514                                         GtkTreeIter *child);
 515
 516 static gboolean tree_model_iter_has_child  (GtkTreeModel *tree_model,
 517                                             GtkTreeIter  *iter);
 518
 519 static void
 520 dictionary_tree_model_init (GtkTreeModelIface *iface)
 521 {
 522   iface->get_flags = tree_model_get_flags;
 523   iface->get_n_columns = tree_model_n_columns;
 524   iface->get_column_type = tree_model_column_type;
 525   iface->get_iter = tree_model_get_iter;
 526   iface->iter_next = tree_model_iter_next;
 527   iface->get_path = tree_model_get_path;
 528   iface->get_value = tree_model_get_value;
 529
 530   iface->iter_children = tree_model_iter_children ;
 531   iface->iter_has_child = tree_model_iter_has_child ;
 532   iface->iter_n_children = tree_model_n_children ;
 533   iface->iter_nth_child = tree_model_nth_child ;
 534   iface->iter_parent = tree_model_iter_parent ;
 535 }
 536
 537 static gboolean
 538 tree_model_iter_has_child  (GtkTreeModel *tree_model,
 539                             GtkTreeIter  *iter)
 540 {
 541   return FALSE;
 542 }
 543
 544 static gboolean
 545 tree_model_iter_parent (GtkTreeModel *tree_model,
 546                         GtkTreeIter *iter,
 547                         GtkTreeIter *child)
 548 {
 549   return TRUE;
 550 }
 551
 552 static GtkTreeModelFlags
 553 tree_model_get_flags (GtkTreeModel *model)
 554 {
 555   g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GtkTreeModelFlags) 0);
 556
 557   return GTK_TREE_MODEL_LIST_ONLY;
 558 }
 559
 560
 561 static gint
 562 tree_model_n_columns (GtkTreeModel *model)
 563 {
 564   return n_DICT_COLS;
 565 }
 566
 567 static GType
 568 tree_model_column_type (GtkTreeModel *model, gint index)
 569 {
 570   g_return_val_if_fail (PSPPIRE_IS_DICT (model), (GType) 0);
 571
 572   switch (index)
 573     {
 574     case DICT_TVM_COL_NAME:
 575       return G_TYPE_STRING;
 576       break;
 577     case DICT_TVM_COL_VAR:
 578       return G_TYPE_POINTER;
 579       break;
 580     default:
 581       g_return_val_if_reached ((GType)0);
 582       break;
 583     }
 584
 585   g_assert_not_reached ();
 586   return ((GType)0);
 587 }
 588
 589 static gboolean
 590 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
 591 {
 592   gint *indices, depth;
 593   gint n;
 594   struct variable *var;
 595
 596   PsppireDict *dict = PSPPIRE_DICT (model);
 597
 598   g_return_val_if_fail (path, FALSE);
 599
 600   indices = gtk_tree_path_get_indices (path);
 601   depth = gtk_tree_path_get_depth (path);
 602
 603   g_return_val_if_fail (depth == 1, FALSE);
 604
 605   n = indices [0];
 606
 607   if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
 608     {
 609       iter->stamp = 0;
 610       iter->user_data = NULL;
 611       return FALSE;
 612     }
 613
 614   var = psppire_dict_get_variable (dict, n);
 615
 616   g_assert (var_get_dict_index (var) == n);
 617
 618   iter->stamp = dict->stamp;
 619   iter->user_data = var;
 620
 621   return TRUE;
 622 }
 623
 624
 625 static gboolean
 626 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
 627 {
 628   PsppireDict *dict = PSPPIRE_DICT (model);
 629   struct variable *var;
 630   gint idx;
 631
 632   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
 633
 634   if ( iter == NULL || iter->user_data == NULL)
 635     return FALSE;
 636
 637   var = iter->user_data;
 638
 639   idx = var_get_dict_index (var);
 640
 641   if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
 642     {
 643       iter->user_data = NULL;
 644       iter->stamp = 0;
 645       return FALSE;
 646     }
 647
 648   var = psppire_dict_get_variable (dict, idx + 1);
 649
 650   g_assert (var_get_dict_index (var) == idx + 1);
 651
 652   iter->user_data = var;
 653
 654   return TRUE;
 655 }
 656
 657 static GtkTreePath *
 658 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
 659 {
 660   GtkTreePath *path;
 661   struct variable *var;
 662   PsppireDict *dict = PSPPIRE_DICT (model);
 663
 664   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
 665
 666   var = iter->user_data;
 667
 668   path = gtk_tree_path_new ();
 669   gtk_tree_path_append_index (path, var_get_dict_index (var));
 670
 671   return path;
 672 }
 673
 674
 675 static void
 676 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
 677                       gint column, GValue *value)
 678 {
 679   struct variable *var;
 680   PsppireDict *dict = PSPPIRE_DICT (model);
 681
 682   g_return_if_fail (iter->stamp == dict->stamp);
 683
 684   var =  iter->user_data;
 685
 686   switch (column)
 687     {
 688     case DICT_TVM_COL_NAME:
 689       {
 690       gchar *name = pspp_locale_to_utf8(var_get_name (var), -1, NULL);
 691       g_value_init (value, G_TYPE_STRING);
 692       g_value_set_string (value, name);
 693       g_free (name);
 694       }
 695       break;
 696     case DICT_TVM_COL_VAR:
 697       g_value_init (value, G_TYPE_POINTER);
 698       g_value_set_pointer (value, var);
 699       break;
 700     default:
 701       g_return_if_reached ();
 702       break;
 703     }
 704 }
 705
 706 static gboolean
 707 tree_model_iter_children (GtkTreeModel *tree_model,
 708                           GtkTreeIter *iter,
 709                           GtkTreeIter *parent)
 710 {
 711   return FALSE;
 712 }
 713
 714 static gint
 715 tree_model_n_children (GtkTreeModel *model,
 716                        GtkTreeIter  *iter)
 717 {
 718   PsppireDict *dict = PSPPIRE_DICT (model);
 719
 720   if ( iter == NULL )
 721     return psppire_dict_get_var_cnt (dict);
 722
 723   return 0;
 724 }
 725
 726 static gboolean
 727 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
 728                       GtkTreeIter *parent, gint n)
 729 {
 730   PsppireDict *dict;
 731
 732   g_return_val_if_fail (PSPPIRE_IS_DICT (model), FALSE);
 733
 734   dict = PSPPIRE_DICT (model);
 735
 736   if ( parent )
 737     return FALSE;
 738
 739   if ( n >= psppire_dict_get_var_cnt (dict) )
 740     return FALSE;
 741
 742   iter->stamp = dict->stamp;
 743   iter->user_data = psppire_dict_get_variable (dict, n);
 744
 745   if ( !iter->user_data)
 746     return FALSE;
 747
 748   return TRUE;
 749 }
 750
 751
 752 gboolean
 753 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
 754                          const gchar *name)
 755 {
 756   if ( ! var_is_valid_name (name, false))
 757     return FALSE;
 758
 759   dict_rename_var (dict->dict, v, name);
 760
 761   return TRUE;
 762 }
 763
 764
 765 struct variable *
 766 psppire_dict_get_weight_variable (const PsppireDict *dict)
 767 {
 768   return dict_get_weight (dict->dict);
 769 }