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