src/ui/gui/find-dialog.c

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2007, 2009  Free Software Foundation
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17
  18 /* This module implements the "Find" dialog; a dialog box to locate cases
  19 which match particular strings */
  20
  21 #include <config.h>
  22
  23 #include "find-dialog.h"
  24 #include "psppire-selector.h"
  25 #include "psppire-dialog.h"
  26 #include "helper.h"
  27 #include "psppire-data-window.h"
  28 #include "dict-display.h"
  29 #include <data/value.h>
  30 #include <data/format.h>
  31 #include <data/datasheet.h>
  32 #include <data/data-in.h>
  33 #include "psppire-data-store.h"
  34 #include <ctype.h>
  35 #include <sys/types.h>
  36 #include <regex.h>
  37 #include <libpspp/message.h>
  38
  39 #include <gtk/gtk.h>
  40 #include <stdlib.h>
  41
  42 #include "xalloc.h"
  43
  44 #include <gettext.h>
  45 #define _(msgid) gettext (msgid)
  46 #define N_(msgid) msgid
  47
  48
  49 /* FIXME: These shouldn't be here */
  50 #include "psppire-var-store.h"
  51
  52 struct find_dialog
  53 {
  54   GtkBuilder *xml;
  55   PsppireDict *dict;
  56   struct datasheet *data;
  57   PsppireDataWindow *de;
  58   GtkWidget *variable_entry;
  59   GtkWidget *value_entry;
  60   GtkWidget *value_labels_checkbox;
  61   GtkWidget *match_regexp_checkbox;
  62   GtkWidget *match_substring_checkbox;
  63 };
  64
  65 static void
  66 find_value (const struct find_dialog *fd, casenumber current_row,
  67            casenumber *row, int *column);
  68
  69
  70 /* A callback which occurs whenever the "Refresh" button is clicked,
  71    and when the dialog pops up.
  72    It restores the dialog to its default state.
  73 */
  74 static void
  75 refresh (GObject *obj, const struct find_dialog *fd)
  76 {
  77   gtk_toggle_button_set_active
  78     (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")),
  79      FALSE);
  80
  81   gtk_toggle_button_set_active
  82     (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")),
  83      FALSE);
  84
  85   gtk_entry_set_text (GTK_ENTRY (fd->variable_entry), "");
  86   gtk_entry_set_text (GTK_ENTRY (fd->value_entry), "");
  87
  88   gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox),
  89                                 FALSE);
  90
  91   gtk_toggle_button_set_active
  92     (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
  93
  94
  95   gtk_toggle_button_set_active
  96     (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
  97 }
  98
  99 /* Callback on the "Find" button */
 100 static void
 101 do_find (GObject *obj, const struct find_dialog *fd)
 102 {
 103   casenumber x = -1;
 104   gint column = -1;
 105   glong row;
 106
 107   g_object_get (fd->de->data_editor, "current-case", &row, NULL);
 108
 109   if ( row < 0 )
 110     row = 0;
 111
 112   find_value (fd, row, &x, &column);
 113
 114
 115   if ( x != -1)
 116     {
 117       gtk_notebook_set_current_page (GTK_NOTEBOOK (fd->de->data_editor),
 118                                      PSPPIRE_DATA_EDITOR_DATA_VIEW);
 119
 120       g_object_set (fd->de->data_editor,
 121                     "current-case", x,
 122                     "current-variable", column,
 123                     NULL);
 124     }
 125
 126 }
 127
 128 /* Callback on the selector.
 129    It gets invoked whenever a variable is selected */
 130 static void
 131 on_select (GtkEntry *entry, gpointer data)
 132 {
 133   struct find_dialog *fd = data;
 134   const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
 135   struct variable *var = dict_lookup_var (fd->dict->dict, var_name);
 136   gboolean search_labels ;
 137
 138   g_return_if_fail (var);
 139
 140   gtk_widget_set_sensitive (fd->value_labels_checkbox,
 141                             var_has_value_labels (var));
 142
 143   search_labels =
 144     gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox));
 145
 146   gtk_widget_set_sensitive (fd->match_regexp_checkbox,
 147                             var_is_alpha (var) || search_labels);
 148
 149
 150   gtk_widget_set_sensitive (fd->match_substring_checkbox,
 151                             var_is_alpha (var) || search_labels);
 152 }
 153
 154 /* Callback on the selector.
 155    It gets invoked whenever a variable is unselected */
 156 static void
 157 on_deselect (GtkEntry *entry, gpointer data)
 158 {
 159   struct find_dialog *fd = data;
 160
 161   gtk_widget_set_sensitive (fd->value_labels_checkbox, FALSE);
 162   gtk_widget_set_sensitive (fd->match_substring_checkbox, FALSE);
 163   gtk_widget_set_sensitive (fd->match_regexp_checkbox, FALSE);
 164 }
 165
 166 static void
 167 value_labels_toggled (GtkToggleButton *tb, gpointer data)
 168 {
 169   struct find_dialog *fd = data;
 170
 171   const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
 172   const struct variable *var = dict_lookup_var (fd->dict->dict, var_name);
 173
 174   gboolean active = gtk_toggle_button_get_active  (tb) ;
 175
 176   gtk_widget_set_sensitive (fd->match_substring_checkbox,
 177                             active || (var && var_is_alpha (var)));
 178
 179   gtk_widget_set_sensitive (fd->match_regexp_checkbox,
 180                               active || (var && var_is_alpha (var)));
 181 }
 182
 183 /* Pops up the Find dialog box
 184  */
 185 void
 186 find_dialog (GObject *o, gpointer data)
 187 {
 188   PsppireDataWindow *de = PSPPIRE_DATA_WINDOW (data);
 189
 190   struct find_dialog fd;
 191
 192   GtkWidget *dialog ;
 193   GtkWidget *source ;
 194   GtkWidget *selector;
 195   GtkWidget *find_button;
 196
 197   GtkWidget *buttonbox;
 198
 199   PsppireVarStore *vs ;
 200   PsppireDataStore *ds ;
 201
 202   fd.xml = builder_new ("find.ui");
 203   fd.de = de;
 204
 205   find_button = gtk_button_new_from_stock  (GTK_STOCK_FIND);
 206   gtk_widget_show (find_button);
 207
 208   buttonbox = get_widget_assert (fd.xml, "find-buttonbox");
 209
 210   gtk_box_pack_start_defaults (GTK_BOX (buttonbox), find_button);
 211   gtk_box_reorder_child (GTK_BOX (buttonbox), find_button, 0);
 212
 213   dialog = get_widget_assert (fd.xml, "find-dialog");
 214   source = get_widget_assert (fd.xml, "find-variable-treeview");
 215   selector = get_widget_assert (fd.xml, "find-selector");
 216
 217   g_object_get (de->data_editor,
 218                 "var-store", &vs,
 219                 "data-store", &ds,
 220                 NULL);
 221
 222   g_object_get (vs, "dictionary", &fd.dict, NULL);
 223
 224   fd.data = ds->datasheet;
 225
 226   fd.variable_entry        = get_widget_assert (fd.xml, "find-variable-entry");
 227   fd.value_entry           = get_widget_assert (fd.xml, "find-value-entry");
 228   fd.value_labels_checkbox =
 229     get_widget_assert (fd.xml,
 230                        "find-value-labels-checkbutton");
 231
 232   fd.match_regexp_checkbox =
 233     get_widget_assert (fd.xml,
 234                        "find-match-regexp-checkbutton");
 235
 236   fd.match_substring_checkbox =
 237     get_widget_assert (fd.xml,
 238                        "find-match-substring-checkbutton");
 239
 240
 241
 242   gtk_window_set_transient_for (GTK_WINDOW (dialog), GTK_WINDOW (de));
 243
 244
 245   g_object_set (source, "model", fd.dict,
 246         "selection-mode", GTK_SELECTION_SINGLE,
 247         NULL);
 248
 249
 250   psppire_selector_set_filter_func (PSPPIRE_SELECTOR (selector),
 251                                     is_currently_in_entry);
 252
 253   g_signal_connect (dialog, "refresh", G_CALLBACK (refresh),  &fd);
 254
 255   g_signal_connect (find_button, "clicked", G_CALLBACK (do_find),  &fd);
 256
 257   g_signal_connect (selector, "selected",
 258                     G_CALLBACK (on_select),  &fd);
 259
 260   g_signal_connect (selector, "de-selected",
 261                     G_CALLBACK (on_deselect),  &fd);
 262
 263   g_signal_connect (fd.value_labels_checkbox, "toggled",
 264                     G_CALLBACK (value_labels_toggled),  &fd);
 265
 266
 267   psppire_dialog_run (PSPPIRE_DIALOG (dialog));
 268
 269   g_object_unref (fd.xml);
 270 }
 271
 272 \f
 273 /* Iterators */
 274
 275 static void
 276 forward (casenumber *i, struct datasheet *data UNUSED)
 277 {
 278   ++*i;
 279 }
 280
 281
 282 static void
 283 forward_wrap (casenumber *i, struct datasheet *data)
 284 {
 285   if ( ++*i >=  datasheet_get_n_rows (data) ) *i = 0;
 286 }
 287
 288 static void
 289 backward (casenumber *i, struct datasheet *data UNUSED)
 290 {
 291   --*i;
 292 }
 293
 294
 295 static void
 296 backward_wrap (casenumber *i, struct datasheet *data)
 297 {
 298   if ( --*i < 0 )
 299     *i = datasheet_get_n_rows (data) - 1;
 300 }
 301
 302
 303 /* Current plus one */
 304 static casenumber
 305 cp1 (casenumber current, struct datasheet *data)
 306 {
 307   return current + 1;
 308 }
 309
 310 /* Current plus one, circular */
 311 static casenumber
 312 cp1c (casenumber current, struct datasheet *data)
 313 {
 314   casenumber next = current;
 315
 316   forward_wrap (&next, data);
 317
 318   return next;
 319 }
 320
 321
 322 /* Current minus one */
 323 static casenumber
 324 cm1 (casenumber current, struct datasheet *data)
 325 {
 326   return current - 1;
 327 }
 328
 329 /* Current minus one, circular */
 330 static casenumber
 331 cm1c (casenumber current, struct datasheet *data)
 332 {
 333   casenumber next = current;
 334
 335   backward_wrap (&next, data);
 336
 337   return next;
 338 }
 339
 340
 341 static casenumber
 342 last (casenumber current, struct datasheet *data)
 343 {
 344   return datasheet_get_n_rows (data) ;
 345 }
 346
 347 static casenumber
 348 minus1 (casenumber current, struct datasheet *data)
 349 {
 350   return -1;
 351 }
 352
 353 /* An type to facilitate iterating through casenumbers */
 354 struct casenum_iterator
 355 {
 356   /* returns the first case to access */
 357   casenumber (*start) (casenumber, struct datasheet *);
 358
 359   /* Returns one past the last case to access */
 360   casenumber (*end) (casenumber, struct datasheet *);
 361
 362   /* Sets the first arg to the next case to access */
 363   void (*next) (casenumber *, struct datasheet *);
 364 };
 365
 366 enum iteration_type{
 367   FORWARD = 0,
 368   FORWARD_WRAP,
 369   REVERSE,
 370   REVERSE_WRAP,
 371   n_iterators
 372 };
 373
 374 static const struct casenum_iterator ip[n_iterators] =
 375   {
 376     {cp1, last, forward},
 377     {cp1c, cm1, forward_wrap},
 378     {cm1, minus1, backward},
 379     {cm1c, cp1, backward_wrap}
 380   };
 381
 382
 383 \f
 384 /* A factory returning an iterator according to the dialog box's settings */
 385 static const struct casenum_iterator *
 386 get_iteration_params (const struct find_dialog *fd)
 387 {
 388   gboolean wrap = gtk_toggle_button_get_active
 389     (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")));
 390
 391   gboolean reverse = gtk_toggle_button_get_active
 392     (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")));
 393
 394   if ( wrap )
 395     {
 396       if ( reverse )
 397         return &ip[REVERSE_WRAP];
 398       else
 399         return &ip[FORWARD_WRAP];
 400     }
 401   else
 402     {
 403       if ( reverse )
 404         return &ip[REVERSE];
 405       else
 406         return &ip[FORWARD];
 407     }
 408 }
 409
 410
 411 enum string_cmp_flags
 412   {
 413     STR_CMP_SUBSTR = 0x01, /* Find strings which are substrings of the
 414                               values */
 415     STR_CMP_REGEXP = 0x02, /* Match against a regular expression */
 416
 417     STR_CMP_LABELS = 0x04  /* Match against the values' labels instead
 418                               of the data */
 419   };
 420
 421
 422 /* An abstract base type for comparing union values against a reference */
 423 struct comparator
 424 {
 425   const struct variable *var;
 426   enum string_cmp_flags flags;
 427   const PsppireDict *dict;
 428
 429   bool (*compare) (const struct comparator *,
 430                    const union value *);
 431
 432   void (*destroy) (struct comparator *);
 433 };
 434
 435
 436 /* A comparator which operates on the unadulterated union values */
 437 struct value_comparator
 438 {
 439   struct comparator parent;
 440   union value pattern;
 441 };
 442
 443 /* A comparator which matches string values or parts thereof */
 444 struct string_comparator
 445 {
 446   struct comparator parent;
 447   const char *pattern;
 448 };
 449
 450 /* A comparator to match string values against a POSIX.2 regular expression */
 451 struct regexp_comparator
 452 {
 453   struct comparator parent;
 454   regex_t re;
 455 };
 456
 457
 458 static bool
 459 value_compare (const struct comparator *cmptr,
 460                const union value *v)
 461 {
 462   const struct value_comparator *vc = (const struct value_comparator *) cmptr;
 463   return 0 == value_compare_3way (v, &vc->pattern, var_get_width (cmptr->var));
 464 }
 465
 466
 467 /* Return true if the label of VAL matches the reference string*/
 468 static bool
 469 string_label_compare (const struct comparator *cmptr,
 470                 const union value *val)
 471 {
 472   const struct string_comparator *ssc =
 473     (const struct string_comparator *) cmptr;
 474
 475   const char *text = var_lookup_value_label (cmptr->var, val);
 476   int width = strlen (text);
 477
 478   assert ( cmptr->flags & STR_CMP_LABELS);
 479
 480   g_return_val_if_fail (width > 0, false);
 481
 482   if ( cmptr->flags & STR_CMP_SUBSTR)
 483     return (NULL != g_strstr_len (text, width, ssc->pattern));
 484   else
 485     return (0 == strncmp (text, ssc->pattern, width));
 486 }
 487
 488 /* Return true if VAL matches the reference string*/
 489 static bool
 490 string_value_compare (const struct comparator *cmptr,
 491                       const union value *val)
 492 {
 493   bool found;
 494   char *text;
 495   const struct string_comparator *ssc =
 496     (const struct string_comparator *) cmptr;
 497
 498   int width = var_get_width (cmptr->var);
 499   g_return_val_if_fail (width > 0, false);
 500   assert ( ! (cmptr->flags & STR_CMP_LABELS));
 501
 502   text = value_to_text (*val, cmptr->dict, *var_get_write_format (cmptr->var));
 503
 504   if ( cmptr->flags & STR_CMP_SUBSTR)
 505     found =  (NULL != g_strstr_len (text, width, ssc->pattern));
 506   else
 507     found = (0 == strncmp (text, ssc->pattern, width));
 508
 509   free (text);
 510   return found;
 511 }
 512
 513
 514
 515 /* Return true if VAL matched the regexp */
 516 static bool
 517 regexp_value_compare (const struct comparator *cmptr,
 518                 const union value *val)
 519 {
 520   char *text;
 521   bool retval;
 522   const struct regexp_comparator *rec =
 523     (const struct regexp_comparator *) cmptr;
 524
 525   int width = var_get_width (cmptr->var);
 526
 527   assert  ( ! (cmptr->flags & STR_CMP_LABELS) );
 528
 529   g_return_val_if_fail (width > 0, false);
 530
 531   text = value_to_text (*val, cmptr->dict, *var_get_write_format (cmptr->var));
 532   /* We must remove trailing whitespace, otherwise $ will not match where
 533      one would expect */
 534   g_strchomp (text);
 535
 536   retval = (0 == regexec (&rec->re, text, 0, 0, 0));
 537
 538   g_free (text);
 539
 540   return retval;
 541 }
 542
 543 /* Return true if the label of VAL matched the regexp */
 544 static bool
 545 regexp_label_compare (const struct comparator *cmptr,
 546                       const union value *val)
 547 {
 548   const char *text;
 549   const struct regexp_comparator *rec =
 550     (const struct regexp_comparator *) cmptr;
 551
 552   int width ;
 553
 554   assert ( cmptr->flags & STR_CMP_LABELS);
 555
 556   text = var_lookup_value_label (cmptr->var, val);
 557   width = strlen (text);
 558
 559   g_return_val_if_fail (width > 0, false);
 560
 561   return (0 == regexec (&rec->re, text, 0, 0, 0));
 562 }
 563
 564
 565
 566 static void
 567 regexp_destroy (struct comparator *cmptr)
 568 {
 569   struct regexp_comparator *rec = (struct regexp_comparator *) cmptr;
 570
 571   regfree (&rec->re);
 572 }
 573
 574 static void
 575 cmptr_value_destroy (struct comparator *cmptr)
 576 {
 577   struct value_comparator *vc = (struct value_comparator *) cmptr;
 578   value_destroy (&vc->pattern, var_get_width (cmptr->var));
 579 }
 580
 581
 582 static struct comparator *
 583 value_comparator_create (const struct variable *var, const PsppireDict *dict, const char *target)
 584 {
 585   struct value_comparator *vc = xzalloc (sizeof (*vc));
 586   struct comparator *cmptr = (struct comparator *) vc;
 587
 588   cmptr->flags = 0;
 589   cmptr->var = var;
 590   cmptr->compare  = value_compare ;
 591   cmptr->destroy = cmptr_value_destroy;
 592   cmptr->dict = dict;
 593
 594   text_to_value (target, dict, var, &vc->pattern);
 595
 596   return cmptr;
 597 }
 598
 599 static struct comparator *
 600 string_comparator_create (const struct variable *var, const PsppireDict *dict,
 601                           const char *target,
 602                           enum string_cmp_flags flags)
 603 {
 604   struct string_comparator *ssc = xzalloc (sizeof (*ssc));
 605   struct comparator *cmptr = (struct comparator *) ssc;
 606
 607   cmptr->flags = flags;
 608   cmptr->var = var;
 609   cmptr->dict = dict;
 610
 611   if ( flags & STR_CMP_LABELS)
 612     cmptr->compare = string_label_compare;
 613   else
 614     cmptr->compare = string_value_compare;
 615
 616   ssc->pattern = target;
 617
 618   return cmptr;
 619 }
 620
 621
 622 static struct comparator *
 623 regexp_comparator_create (const struct variable *var, const PsppireDict *dict, const char *target,
 624                           enum string_cmp_flags flags)
 625 {
 626   int code;
 627   struct regexp_comparator *rec = xzalloc (sizeof (*rec));
 628   struct comparator *cmptr = (struct comparator *) rec;
 629
 630   cmptr->flags = flags;
 631   cmptr->var = var;
 632   cmptr->dict = dict;
 633   cmptr->compare  = (flags & STR_CMP_LABELS)
 634     ? regexp_label_compare : regexp_value_compare ;
 635
 636   cmptr->destroy  = regexp_destroy;
 637
 638   code = regcomp (&rec->re, target, 0);
 639   if ( code != 0 )
 640     {
 641       char *errbuf = NULL;
 642       size_t errbuf_size = regerror (code, &rec->re, errbuf,  0);
 643
 644       errbuf = xmalloc (errbuf_size);
 645
 646       regerror (code, &rec->re, errbuf, errbuf_size);
 647
 648       msg (ME, _("Bad regular expression: %s"), errbuf);
 649
 650       free ( cmptr);
 651       free (errbuf);
 652       return NULL;
 653     }
 654
 655   return cmptr;
 656 }
 657
 658
 659 /* Compare V against CMPTR's reference */
 660 static bool
 661 comparator_compare (const struct comparator *cmptr,
 662                     const union value *v)
 663 {
 664   return cmptr->compare (cmptr, v);
 665 }
 666
 667 /* Destroy CMPTR */
 668 static void
 669 comparator_destroy (struct comparator *cmptr)
 670 {
 671   if ( ! cmptr )
 672     return ;
 673
 674   if ( cmptr->destroy )
 675     cmptr->destroy (cmptr);
 676
 677   free (cmptr);
 678 }
 679
 680
 681 static struct comparator *
 682 comparator_factory (const struct variable *var, const PsppireDict *dict, const char *str,
 683                     enum string_cmp_flags flags)
 684 {
 685   if ( flags & STR_CMP_REGEXP )
 686     return regexp_comparator_create (var, dict, str, flags);
 687
 688   if ( flags & (STR_CMP_SUBSTR | STR_CMP_LABELS) )
 689     return string_comparator_create (var, dict, str, flags);
 690
 691   return value_comparator_create (var, dict, str);
 692 }
 693
 694
 695 /* Find the row and column specified by the dialog FD, starting at CURRENT_ROW.
 696    After the function returns, *ROW contains the row and *COLUMN the column.
 697    If no such case is found, then *ROW will be set to -1
 698  */
 699 static void
 700 find_value (const struct find_dialog *fd, casenumber current_row,
 701            casenumber *row, int *column)
 702 {
 703   int width;
 704   const struct variable *var;
 705   const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
 706   const char *target_string = gtk_entry_get_text (GTK_ENTRY (fd->value_entry));
 707
 708   enum string_cmp_flags flags = 0;
 709   g_assert (current_row >= 0);
 710
 711   var = dict_lookup_var (fd->dict->dict, var_name);
 712   if ( ! var )
 713     return ;
 714
 715   width = var_get_width (var);
 716
 717   *column = var_get_dict_index (var);
 718   *row = -1;
 719
 720   if ( gtk_toggle_button_get_active
 721        (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox)))
 722     flags |= STR_CMP_SUBSTR;
 723
 724   if ( gtk_toggle_button_get_active
 725        (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox)))
 726     flags |= STR_CMP_REGEXP;
 727
 728   if ( gtk_toggle_button_get_active
 729        (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox)))
 730     flags |= STR_CMP_LABELS;
 731
 732   {
 733     union value val;
 734     casenumber i;
 735     const struct casenum_iterator *ip = get_iteration_params (fd);
 736     struct comparator *cmptr =
 737       comparator_factory (var, fd->dict, target_string, flags);
 738
 739     value_init (&val, width);
 740     if ( ! cmptr)
 741       goto finish;
 742
 743     for (i = ip->start (current_row, fd->data);
 744          i != ip->end (current_row, fd->data);
 745          ip->next (&i, fd->data))
 746       {
 747         datasheet_get_value (fd->data, i, var_get_case_index (var), &val);
 748
 749         if ( comparator_compare (cmptr, &val))
 750           {
 751             *row = i;
 752             break;
 753           }
 754       }
 755
 756   finish:
 757     comparator_destroy (cmptr);
 758     value_destroy (&val, width);
 759   }
 760 }