src/ui/gui/psppire-dict.c

   1 /*
   2     PSPPIRE --- A Graphical User Interface for PSPP
   3     Copyright (C) 2004, 2006  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-object.h"
  28 #include "psppire-dict.h"
  29 #include <data/format.h>
  30 #include <data/dictionary.h>
  31 #include <data/missing-values.h>
  32 #include <data/value-labels.h>
  33 #include <data/variable.h>
  34
  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        n_SIGNALS};
  53
  54 static guint signal[n_SIGNALS];
  55
  56 #define CACHE_CHUNK 5
  57
  58 /* --- functions --- */
  59 /**
  60  * psppire_dict_get_type:
  61  * @returns: the type ID for accelerator groups.
  62  */
  63 GType
  64 psppire_dict_get_type (void)
  65 {
  66   static GType object_type = 0;
  67
  68   if (!object_type)
  69     {
  70       static const GTypeInfo object_info = {
  71         sizeof (PsppireDictClass),
  72         (GBaseInitFunc) NULL,
  73         (GBaseFinalizeFunc) NULL,
  74         (GClassInitFunc) psppire_dict_class_init,
  75         NULL,   /* class_finalize */
  76         NULL,   /* class_data */
  77         sizeof (PsppireDict),
  78         0,      /* n_preallocs */
  79         (GInstanceInitFunc) psppire_dict_init,
  80       };
  81
  82       static const GInterfaceInfo tree_model_info = {
  83         (GInterfaceInitFunc) dictionary_tree_model_init,
  84         NULL,
  85         NULL
  86       };
  87
  88       object_type = g_type_register_static (G_TYPE_PSPPIRE_OBJECT,
  89                                             "PsppireDict",
  90                                             &object_info, 0);
  91
  92       g_type_add_interface_static (object_type, GTK_TYPE_TREE_MODEL,
  93                                   &tree_model_info);
  94
  95
  96     }
  97
  98   return object_type;
  99 }
 100
 101
 102 static void
 103 psppire_dict_class_init (PsppireDictClass *class)
 104 {
 105   GObjectClass *object_class = G_OBJECT_CLASS (class);
 106
 107   parent_class = g_type_class_peek_parent (class);
 108
 109   object_class->finalize = psppire_dict_finalize;
 110
 111   signal[VARIABLE_CHANGED] =
 112     g_signal_new ("variable_changed",
 113                   G_TYPE_FROM_CLASS (class),
 114                   G_SIGNAL_RUN_FIRST,
 115                   0,
 116                   NULL, NULL,
 117                   g_cclosure_marshal_VOID__INT,
 118                   G_TYPE_NONE,
 119                   1,
 120                   G_TYPE_INT);
 121
 122
 123
 124   signal[VARIABLE_INSERTED] =
 125     g_signal_new ("variable_inserted",
 126                   G_TYPE_FROM_CLASS (class),
 127                   G_SIGNAL_RUN_FIRST,
 128                   0,
 129                   NULL, NULL,
 130                   g_cclosure_marshal_VOID__INT,
 131                   G_TYPE_NONE,
 132                   1,
 133                   G_TYPE_INT);
 134
 135
 136   signal[VARIABLES_DELETED] =
 137     g_signal_new ("variables_deleted",
 138                   G_TYPE_FROM_CLASS (class),
 139                   G_SIGNAL_RUN_FIRST,
 140                   0,
 141                   NULL, NULL,
 142                   gtkextra_VOID__INT_INT,
 143                   G_TYPE_NONE,
 144                   2,
 145                   G_TYPE_INT,
 146                   G_TYPE_INT);
 147
 148
 149   signal[VARIABLE_RESIZED] =
 150     g_signal_new ("dict-size-changed",
 151                   G_TYPE_FROM_CLASS (class),
 152                   G_SIGNAL_RUN_FIRST,
 153                   0,
 154                   NULL, NULL,
 155                   gtkextra_VOID__INT_INT,
 156                   G_TYPE_NONE,
 157                   2,
 158                   G_TYPE_INT,
 159                   G_TYPE_INT);
 160
 161 }
 162
 163 static void
 164 psppire_dict_finalize (GObject *object)
 165 {
 166   PsppireDict *d = PSPPIRE_DICT (object);
 167
 168   dict_destroy (d->dict);
 169
 170   G_OBJECT_CLASS (parent_class)->finalize (object);
 171 }
 172
 173 /* Pass on callbacks from src/data/dictionary, as
 174    signals in the Gtk library */
 175 static void
 176 addcb (struct dictionary *d, int idx, void *pd)
 177 {
 178   g_signal_emit (pd, signal[VARIABLE_INSERTED], 0, idx);
 179 }
 180
 181 static void
 182 delcb (struct dictionary *d, int idx, void *pd)
 183 {
 184   g_signal_emit (pd, signal[VARIABLES_DELETED], 0, idx, 1);
 185 }
 186
 187 static void
 188 mutcb (struct dictionary *d, int idx, void *pd)
 189 {
 190   g_signal_emit (pd, signal[VARIABLE_CHANGED], 0, idx);
 191 }
 192
 193 static const struct dict_callbacks gui_callbacks =
 194   {
 195     addcb,
 196     delcb,
 197     mutcb
 198   };
 199
 200 static void
 201 psppire_dict_init (PsppireDict *psppire_dict)
 202 {
 203   psppire_dict->stamp = g_random_int ();
 204 }
 205
 206 /**
 207  * psppire_dict_new_from_dict:
 208  * @returns: a new #PsppireDict object
 209  *
 210  * Creates a new #PsppireDict.
 211  */
 212 PsppireDict*
 213 psppire_dict_new_from_dict (struct dictionary *d)
 214 {
 215   PsppireDict *new_dict = g_object_new (G_TYPE_PSPPIRE_DICT, NULL);
 216   new_dict->dict = d;
 217
 218   dict_set_callbacks (new_dict->dict, &gui_callbacks, new_dict);
 219
 220   return new_dict;
 221 }
 222
 223
 224 void
 225 psppire_dict_replace_dictionary (PsppireDict *dict, struct dictionary *d)
 226 {
 227   dict->dict = d;
 228 }
 229
 230
 231 /* Returns a valid name for a new variable in DICT.
 232    The return value is statically allocated */
 233 static gchar *
 234 auto_generate_var_name (PsppireDict *dict)
 235 {
 236   gint d = 0;
 237   static gchar name[10];
 238
 239   while (g_snprintf (name, 10, "VAR%05d",d++),
 240          psppire_dict_lookup_var (dict, name))
 241     ;
 242
 243   return name;
 244 }
 245
 246 /* Insert a new variable at posn IDX, with the name NAME.
 247    If NAME is null, then a name will be automatically assigned.
 248  */
 249 void
 250 psppire_dict_insert_variable (PsppireDict *d, gint idx, const gchar *name)
 251 {
 252   struct variable *var ;
 253   g_return_if_fail (idx >= 0);
 254   g_return_if_fail (d);
 255   g_return_if_fail (G_IS_PSPPIRE_DICT (d));
 256
 257   if ( ! name )
 258     name = auto_generate_var_name (d);
 259
 260   var = dict_create_var (d->dict, name, 0);
 261
 262   dict_reorder_var (d->dict, var, idx);
 263 }
 264
 265 /* Delete N variables beginning at FIRST */
 266 void
 267 psppire_dict_delete_variables (PsppireDict *d, gint first, gint n)
 268 {
 269   gint idx;
 270   g_return_if_fail (d);
 271   g_return_if_fail (d->dict);
 272   g_return_if_fail (G_IS_PSPPIRE_DICT (d));
 273
 274   for (idx = 0 ; idx < n ; ++idx )
 275     {
 276       struct variable *var;
 277
 278       /* Do nothing if it's out of bounds */
 279       if ( first >= dict_get_var_cnt (d->dict))
 280         break;
 281
 282       var = dict_get_var (d->dict, first);
 283       dict_delete_var (d->dict, var);
 284     }
 285   dict_compact_values (d->dict);
 286 }
 287
 288
 289 void
 290 psppire_dict_set_name (PsppireDict* d, gint idx, const gchar *name)
 291 {
 292   struct variable *var;
 293   g_assert (d);
 294   g_assert (G_IS_PSPPIRE_DICT (d));
 295
 296
 297   if ( idx < dict_get_var_cnt (d->dict))
 298     {
 299       /* This is an existing variable? */
 300       var = dict_get_var (d->dict, idx);
 301       dict_rename_var (d->dict, var, name);
 302     }
 303   else
 304     {
 305       /* new variable */
 306       dict_create_var (d->dict, name, 0);
 307     }
 308 }
 309
 310
 311
 312 /* Return the IDXth variable */
 313 struct variable *
 314 psppire_dict_get_variable (PsppireDict *d, gint idx)
 315 {
 316   g_return_val_if_fail (d, NULL);
 317   g_return_val_if_fail (d->dict, NULL);
 318
 319   if ( dict_get_var_cnt (d->dict) <= idx )
 320     return NULL;
 321
 322   return dict_get_var (d->dict, idx);
 323 }
 324
 325
 326 /* Return the number of variables in the dictionary */
 327 gint
 328 psppire_dict_get_var_cnt (const PsppireDict *d)
 329 {
 330   g_return_val_if_fail (d, -1);
 331   g_return_val_if_fail (d->dict, -1);
 332
 333   return dict_get_var_cnt (d->dict);
 334 }
 335
 336
 337 /* Return a variable by name.
 338    Return NULL if it doesn't exist
 339 */
 340 struct variable *
 341 psppire_dict_lookup_var (const PsppireDict *d, const gchar *name)
 342 {
 343   g_return_val_if_fail (d, NULL);
 344   g_return_val_if_fail (d->dict, NULL);
 345
 346   return dict_lookup_var (d->dict, name);
 347 }
 348
 349 /* Clears the contents of D */
 350 void
 351 psppire_dict_clear (PsppireDict *d)
 352 {
 353   g_return_if_fail (d);
 354   g_return_if_fail (d->dict);
 355
 356   {
 357     dict_clear (d->dict);
 358   }
 359 }
 360
 361
 362 /* Return true is NAME would be a valid name of a variable to add to the
 363    dictionary.  False otherwise.
 364    If REPORT is true, then invalid names will be reported as such as errors
 365 */
 366 gboolean
 367 psppire_dict_check_name (const PsppireDict *dict,
 368                      const gchar *name, gboolean report)
 369 {
 370   if ( ! var_is_valid_name (name, report ) )
 371       return FALSE;
 372
 373   if (psppire_dict_lookup_var (dict, name))
 374     {
 375       if ( report )
 376         msg (ME,"Duplicate variable name.");
 377       return FALSE;
 378     }
 379
 380   return TRUE;
 381 }
 382
 383
 384 inline gint
 385 psppire_dict_get_next_value_idx (const PsppireDict *dict)
 386 {
 387   return dict_get_next_value_idx (dict->dict);
 388 }
 389
 390
 391 void
 392 psppire_dict_resize_variable (PsppireDict *d, const struct variable *pv,
 393                               gint old_size, gint new_size)
 394 {
 395   gint fv;
 396   g_return_if_fail (d);
 397   g_return_if_fail (d->dict);
 398
 399   if ( old_size == new_size )
 400     return ;
 401
 402   dict_compact_values (d->dict);
 403
 404   fv = var_get_case_index (pv);
 405
 406   g_signal_emit (d, signal[VARIABLE_RESIZED], 0,
 407                 fv + old_size,
 408                 new_size - old_size );
 409 }
 410
 411
 412 /* Tree Model Stuff */
 413
 414 static GtkTreeModelFlags tree_model_get_flags (GtkTreeModel *model);
 415
 416 static gint tree_model_n_columns (GtkTreeModel *model);
 417
 418 static GType tree_model_column_type (GtkTreeModel *model, gint index);
 419
 420 static gboolean tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter,
 421                                      GtkTreePath *path);
 422
 423 static gboolean tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter);
 424
 425 static GtkTreePath * tree_model_get_path (GtkTreeModel *model,
 426                                           GtkTreeIter *iter);
 427
 428 static void tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
 429                                   gint column, GValue *value);
 430
 431 static gboolean tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
 432                                       GtkTreeIter *parent, gint n);
 433
 434
 435 static void
 436 dictionary_tree_model_init (GtkTreeModelIface *iface)
 437 {
 438   iface->get_flags = tree_model_get_flags;
 439   iface->get_n_columns = tree_model_n_columns;
 440   iface->get_column_type = tree_model_column_type;
 441   iface->get_iter = tree_model_get_iter;
 442   iface->iter_next = tree_model_iter_next;
 443   iface->get_path = tree_model_get_path;
 444   iface->get_value = tree_model_get_value;
 445
 446   iface->iter_children = 0;
 447   iface->iter_has_child =0;
 448   iface->iter_n_children =0;
 449   iface->iter_nth_child = tree_model_nth_child ;
 450   iface->iter_parent =0;
 451 }
 452
 453 static GtkTreeModelFlags
 454 tree_model_get_flags (GtkTreeModel *model)
 455 {
 456   g_return_val_if_fail (G_IS_PSPPIRE_DICT (model), (GtkTreeModelFlags) 0);
 457
 458   return GTK_TREE_MODEL_LIST_ONLY;
 459 }
 460
 461
 462 static gint
 463 tree_model_n_columns (GtkTreeModel *model)
 464 {
 465   return n_DICT_COLS;
 466 }
 467
 468 static GType
 469 tree_model_column_type (GtkTreeModel *model, gint index)
 470 {
 471   g_return_val_if_fail (G_IS_PSPPIRE_DICT (model), (GType) 0);
 472
 473   switch (index)
 474     {
 475     case DICT_TVM_COL_NAME:
 476       return G_TYPE_STRING;
 477       break;
 478     case DICT_TVM_COL_VAR:
 479       return G_TYPE_POINTER;
 480       break;
 481     default:
 482       g_return_val_if_reached ((GType)0);
 483       break;
 484     }
 485
 486   g_assert_not_reached ();
 487   return ((GType)0);
 488 }
 489
 490 static gboolean
 491 tree_model_get_iter (GtkTreeModel *model, GtkTreeIter *iter, GtkTreePath *path)
 492 {
 493   gint *indices, depth;
 494   gint n;
 495   struct variable *variable;
 496
 497   PsppireDict *dict = PSPPIRE_DICT (model);
 498
 499   g_return_val_if_fail (path, FALSE);
 500
 501   indices = gtk_tree_path_get_indices (path);
 502   depth = gtk_tree_path_get_depth (path);
 503
 504   g_return_val_if_fail (depth == 1, FALSE);
 505
 506   n = indices[0];
 507
 508   if ( n < 0 || n >= psppire_dict_get_var_cnt (dict))
 509     return FALSE;
 510
 511   variable = dict_get_var (dict->dict, n);
 512
 513   g_assert (var_get_dict_index (variable) == n);
 514
 515   iter->stamp = dict->stamp;
 516   iter->user_data = variable;
 517
 518   return TRUE;
 519 }
 520
 521
 522 static gboolean
 523 tree_model_iter_next (GtkTreeModel *model, GtkTreeIter *iter)
 524 {
 525   PsppireDict *dict = PSPPIRE_DICT (model);
 526   struct variable *variable;
 527   gint idx;
 528
 529   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
 530
 531   if ( iter == NULL || iter->user_data == NULL)
 532     return FALSE;
 533
 534   variable = (struct variable *) iter->user_data;
 535
 536   idx = var_get_dict_index (variable);
 537
 538   if ( idx + 1 >= psppire_dict_get_var_cnt (dict))
 539     return FALSE;
 540
 541   variable = psppire_dict_get_variable (dict, idx + 1);
 542
 543   g_assert (var_get_dict_index (variable) == idx + 1);
 544
 545   iter->user_data = variable;
 546
 547   return TRUE;
 548 }
 549
 550 static GtkTreePath *
 551 tree_model_get_path (GtkTreeModel *model, GtkTreeIter *iter)
 552 {
 553   GtkTreePath *path;
 554   struct variable *variable;
 555   PsppireDict *dict = PSPPIRE_DICT (model);
 556
 557   g_return_val_if_fail (iter->stamp == dict->stamp, FALSE);
 558
 559   variable = (struct variable *) iter->user_data;
 560
 561   path = gtk_tree_path_new ();
 562   gtk_tree_path_append_index (path, var_get_dict_index (variable));
 563
 564   return path;
 565 }
 566
 567
 568 static void
 569 tree_model_get_value (GtkTreeModel *model, GtkTreeIter *iter,
 570                      gint column, GValue *value)
 571 {
 572   struct variable *variable;
 573   PsppireDict *dict = PSPPIRE_DICT (model);
 574
 575   g_return_if_fail (iter->stamp == dict->stamp);
 576
 577   variable = (struct variable *) iter->user_data;
 578
 579   switch (column)
 580     {
 581     case DICT_TVM_COL_NAME:
 582       g_value_init (value, G_TYPE_STRING);
 583       g_value_set_string (value, var_get_name (variable));
 584       break;
 585     case DICT_TVM_COL_VAR:
 586       g_value_init (value, G_TYPE_POINTER);
 587       g_value_set_pointer (value, variable);
 588       break;
 589     default:
 590       g_return_if_reached ();
 591       break;
 592     }
 593 }
 594
 595
 596 static gboolean
 597 tree_model_nth_child (GtkTreeModel *model, GtkTreeIter *iter,
 598                      GtkTreeIter *parent, gint n)
 599 {
 600   PsppireDict *dict;
 601   g_return_val_if_fail (G_IS_PSPPIRE_DICT (model), FALSE);
 602
 603   dict = PSPPIRE_DICT (model);
 604
 605   if ( parent )
 606     return FALSE;
 607
 608   if ( n >= psppire_dict_get_var_cnt (dict) )
 609     return FALSE;
 610
 611   iter->stamp = dict->stamp;
 612   iter->user_data = psppire_dict_get_variable (dict, n);
 613
 614   if ( !iter->user_data)
 615     return FALSE;
 616
 617
 618   return TRUE;
 619 }
 620
 621
 622 void
 623 psppire_dict_rename_var (PsppireDict *dict, struct variable *v,
 624                          const gchar *text)
 625 {
 626   dict_rename_var (dict->dict, v, text);
 627 }