0c16bfa8140c0a78f4036c2c2ef2e3eeadb5023a
[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   g_object_get (vs, "dictionary", &fd.dict, NULL);
224
225   fd.data = ds->datasheet;
226
227   fd.variable_entry        = get_widget_assert (fd.xml, "find-variable-entry");
228   fd.value_entry           = get_widget_assert (fd.xml, "find-value-entry");
229   fd.value_labels_checkbox =
230     get_widget_assert (fd.xml,
231                        "find-value-labels-checkbutton");
232
233   fd.match_regexp_checkbox =
234     get_widget_assert (fd.xml,
235                        "find-match-regexp-checkbutton");
236
237   fd.match_substring_checkbox =
238     get_widget_assert (fd.xml,
239                        "find-match-substring-checkbutton");
240
241
242
243   gtk_window_set_transient_for (GTK_WINDOW (dialog), GTK_WINDOW (de));
244
245
246   g_object_set (source, "dictionary", fd.dict,
247         "selection-mode", GTK_SELECTION_SINGLE,
248         NULL);
249
250   psppire_selector_set_subjects (PSPPIRE_SELECTOR (selector),
251                                  source,
252                                  fd.variable_entry,
253                                  insert_source_row_into_entry,
254                                  is_currently_in_entry,
255                                  NULL
256                                  );
257
258   g_signal_connect (dialog, "refresh", G_CALLBACK (refresh),  &fd);
259
260   g_signal_connect (find_button, "clicked", G_CALLBACK (do_find),  &fd);
261
262   g_signal_connect (selector, "selected",
263                     G_CALLBACK (on_select),  &fd);
264
265   g_signal_connect (selector, "de-selected",
266                     G_CALLBACK (on_deselect),  &fd);
267
268   g_signal_connect (fd.value_labels_checkbox, "toggled",
269                     G_CALLBACK (value_labels_toggled),  &fd);
270
271
272   psppire_dialog_run (PSPPIRE_DIALOG (dialog));
273
274   g_object_unref (fd.xml);
275 }
276
277 \f
278 /* Iterators */
279
280 static void
281 forward (casenumber *i, struct datasheet *data UNUSED)
282 {
283   ++*i;
284 }
285
286
287 static void
288 forward_wrap (casenumber *i, struct datasheet *data)
289 {
290   if ( ++*i >=  datasheet_get_n_rows (data) ) *i = 0;
291 }
292
293 static void
294 backward (casenumber *i, struct datasheet *data UNUSED)
295 {
296   --*i;
297 }
298
299
300 static void
301 backward_wrap (casenumber *i, struct datasheet *data)
302 {
303   if ( --*i < 0 )
304     *i = datasheet_get_n_rows (data) - 1;
305 }
306
307
308 /* Current plus one */
309 static casenumber
310 cp1 (casenumber current, struct datasheet *data)
311 {
312   return current + 1;
313 }
314
315 /* Current plus one, circular */
316 static casenumber
317 cp1c (casenumber current, struct datasheet *data)
318 {
319   casenumber next = current;
320
321   forward_wrap (&next, data);
322
323   return next;
324 }
325
326
327 /* Current minus one */
328 static casenumber
329 cm1 (casenumber current, struct datasheet *data)
330 {
331   return current - 1;
332 }
333
334 /* Current minus one, circular */
335 static casenumber
336 cm1c (casenumber current, struct datasheet *data)
337 {
338   casenumber next = current;
339
340   backward_wrap (&next, data);
341
342   return next;
343 }
344
345
346 static casenumber
347 last (casenumber current, struct datasheet *data)
348 {
349   return datasheet_get_n_rows (data) ;
350 }
351
352 static casenumber
353 minus1 (casenumber current, struct datasheet *data)
354 {
355   return -1;
356 }
357
358 /* An type to facilitate iterating through casenumbers */
359 struct casenum_iterator
360 {
361   /* returns the first case to access */
362   casenumber (*start) (casenumber, struct datasheet *);
363
364   /* Returns one past the last case to access */
365   casenumber (*end) (casenumber, struct datasheet *);
366
367   /* Sets the first arg to the next case to access */
368   void (*next) (casenumber *, struct datasheet *);
369 };
370
371 enum iteration_type{
372   FORWARD = 0,
373   FORWARD_WRAP,
374   REVERSE,
375   REVERSE_WRAP,
376   n_iterators
377 };
378
379 static const struct casenum_iterator ip[n_iterators] =
380   {
381     {cp1, last, forward},
382     {cp1c, cm1, forward_wrap},
383     {cm1, minus1, backward},
384     {cm1c, cp1, backward_wrap}
385   };
386
387
388 \f
389 /* A factory returning an iterator according to the dialog box's settings */
390 static const struct casenum_iterator *
391 get_iteration_params (const struct find_dialog *fd)
392 {
393   gboolean wrap = gtk_toggle_button_get_active
394     (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")));
395
396   gboolean reverse = gtk_toggle_button_get_active
397     (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")));
398
399   if ( wrap )
400     {
401       if ( reverse )
402         return &ip[REVERSE_WRAP];
403       else
404         return &ip[FORWARD_WRAP];
405     }
406   else
407     {
408       if ( reverse )
409         return &ip[REVERSE];
410       else
411         return &ip[FORWARD];
412     }
413 }
414
415
416 enum string_cmp_flags
417   {
418     STR_CMP_SUBSTR = 0x01, /* Find strings which are substrings of the
419                               values */
420     STR_CMP_REGEXP = 0x02, /* Match against a regular expression */
421
422     STR_CMP_LABELS = 0x04  /* Match against the values' labels instead
423                               of the data */
424   };
425
426
427 /* An abstract base type for comparing union values against a reference */
428 struct comparator
429 {
430   const struct variable *var;
431   enum string_cmp_flags flags;
432   const PsppireDict *dict;
433
434   bool (*compare) (const struct comparator *,
435                    const union value *);
436
437   void (*destroy) (struct comparator *);
438 };
439
440
441 /* A comparator which operates on the unadulterated union values */
442 struct value_comparator
443 {
444   struct comparator parent;
445   union value pattern;
446 };
447
448 /* A comparator which matches string values or parts thereof */
449 struct string_comparator
450 {
451   struct comparator parent;
452   const char *pattern;
453 };
454
455 /* A comparator to match string values against a POSIX.2 regular expression */
456 struct regexp_comparator
457 {
458   struct comparator parent;
459   regex_t re;
460 };
461
462
463 static bool
464 value_compare (const struct comparator *cmptr,
465                const union value *v)
466 {
467   const struct value_comparator *vc = (const struct value_comparator *) cmptr;
468   return 0 == value_compare_3way (v, &vc->pattern, var_get_width (cmptr->var));
469 }
470
471
472 /* Return true if the label of VAL matches the reference string*/
473 static bool
474 string_label_compare (const struct comparator *cmptr,
475                 const union value *val)
476 {
477   const struct string_comparator *ssc =
478     (const struct string_comparator *) cmptr;
479
480   const char *text = var_lookup_value_label (cmptr->var, val);
481   int width = strlen (text);
482
483   assert ( cmptr->flags & STR_CMP_LABELS);
484
485   g_return_val_if_fail (width > 0, false);
486
487   if ( cmptr->flags & STR_CMP_SUBSTR)
488     return (NULL != g_strstr_len (text, width, ssc->pattern));
489   else
490     return (0 == strncmp (text, ssc->pattern, width));
491 }
492
493 /* Return true if VAL matches the reference string*/
494 static bool
495 string_value_compare (const struct comparator *cmptr,
496                       const union value *val)
497 {
498   bool found;
499   char *text;
500   const struct string_comparator *ssc =
501     (const struct string_comparator *) cmptr;
502
503   int width = var_get_width (cmptr->var);
504   g_return_val_if_fail (width > 0, false);
505   assert ( ! (cmptr->flags & STR_CMP_LABELS));
506
507   text = value_to_text (*val, cmptr->dict, *var_get_write_format (cmptr->var));
508
509   if ( cmptr->flags & STR_CMP_SUBSTR)
510     found =  (NULL != g_strstr_len (text, width, ssc->pattern));
511   else
512     found = (0 == strncmp (text, ssc->pattern, width));
513
514   free (text);
515   return found;
516 }
517
518
519
520 /* Return true if VAL matched the regexp */
521 static bool
522 regexp_value_compare (const struct comparator *cmptr,
523                 const union value *val)
524 {
525   char *text;
526   bool retval;
527   const struct regexp_comparator *rec =
528     (const struct regexp_comparator *) cmptr;
529
530   int width = var_get_width (cmptr->var);
531
532   assert  ( ! (cmptr->flags & STR_CMP_LABELS) );
533
534   g_return_val_if_fail (width > 0, false);
535
536   text = value_to_text (*val, cmptr->dict, *var_get_write_format (cmptr->var));
537   /* We must remove trailing whitespace, otherwise $ will not match where
538      one would expect */
539   g_strchomp (text);
540
541   retval = (0 == regexec (&rec->re, text, 0, 0, 0));
542
543   g_free (text);
544
545   return retval;
546 }
547
548 /* Return true if the label of VAL matched the regexp */
549 static bool
550 regexp_label_compare (const struct comparator *cmptr,
551                       const union value *val)
552 {
553   const char *text;
554   const struct regexp_comparator *rec =
555     (const struct regexp_comparator *) cmptr;
556
557   int width ;
558
559   assert ( cmptr->flags & STR_CMP_LABELS);
560
561   text = var_lookup_value_label (cmptr->var, val);
562   width = strlen (text);
563
564   g_return_val_if_fail (width > 0, false);
565
566   return (0 == regexec (&rec->re, text, 0, 0, 0));
567 }
568
569
570
571 static void
572 regexp_destroy (struct comparator *cmptr)
573 {
574   struct regexp_comparator *rec
575     = UP_CAST (cmptr, struct regexp_comparator, parent);
576
577   regfree (&rec->re);
578 }
579
580 static void
581 cmptr_value_destroy (struct comparator *cmptr)
582 {
583   struct value_comparator *vc
584     = UP_CAST (cmptr, struct value_comparator, parent);
585   value_destroy (&vc->pattern, var_get_width (cmptr->var));
586 }
587
588
589 static struct comparator *
590 value_comparator_create (const struct variable *var, const PsppireDict *dict, const char *target)
591 {
592   struct value_comparator *vc = xzalloc (sizeof (*vc));
593   struct comparator *cmptr = &vc->parent;
594
595   cmptr->flags = 0;
596   cmptr->var = var;
597   cmptr->compare  = value_compare ;
598   cmptr->destroy = cmptr_value_destroy;
599   cmptr->dict = dict;
600
601   text_to_value (target, dict, var, &vc->pattern);
602
603   return cmptr;
604 }
605
606 static struct comparator *
607 string_comparator_create (const struct variable *var, const PsppireDict *dict, 
608                           const char *target,
609                           enum string_cmp_flags flags)
610 {
611   struct string_comparator *ssc = xzalloc (sizeof (*ssc));
612   struct comparator *cmptr = &ssc->parent;
613
614   cmptr->flags = flags;
615   cmptr->var = var;
616   cmptr->dict = dict;
617
618   if ( flags & STR_CMP_LABELS)
619     cmptr->compare = string_label_compare;
620   else
621     cmptr->compare = string_value_compare;
622
623   ssc->pattern = target;
624
625   return cmptr;
626 }
627
628
629 static struct comparator *
630 regexp_comparator_create (const struct variable *var, const PsppireDict *dict, const char *target,
631                           enum string_cmp_flags flags)
632 {
633   int code;
634   struct regexp_comparator *rec = xzalloc (sizeof (*rec));
635   struct comparator *cmptr = &rec->parent;
636
637   cmptr->flags = flags;
638   cmptr->var = var;
639   cmptr->dict = dict;
640   cmptr->compare  = (flags & STR_CMP_LABELS)
641     ? regexp_label_compare : regexp_value_compare ;
642
643   cmptr->destroy  = regexp_destroy;
644
645   code = regcomp (&rec->re, target, 0);
646   if ( code != 0 )
647     {
648       char *errbuf = NULL;
649       size_t errbuf_size = regerror (code, &rec->re, errbuf,  0);
650
651       errbuf = xmalloc (errbuf_size);
652
653       regerror (code, &rec->re, errbuf, errbuf_size);
654
655       msg (ME, _("Bad regular expression: %s"), errbuf);
656
657       free ( cmptr);
658       free (errbuf);
659       return NULL;
660     }
661
662   return cmptr;
663 }
664
665
666 /* Compare V against CMPTR's reference */
667 static bool
668 comparator_compare (const struct comparator *cmptr,
669                     const union value *v)
670 {
671   return cmptr->compare (cmptr, v);
672 }
673
674 /* Destroy CMPTR */
675 static void
676 comparator_destroy (struct comparator *cmptr)
677 {
678   if ( ! cmptr )
679     return ;
680
681   if ( cmptr->destroy )
682     cmptr->destroy (cmptr);
683
684   free (cmptr);
685 }
686
687
688 static struct comparator *
689 comparator_factory (const struct variable *var, const PsppireDict *dict, const char *str,
690                     enum string_cmp_flags flags)
691 {
692   if ( flags & STR_CMP_REGEXP )
693     return regexp_comparator_create (var, dict, str, flags);
694
695   if ( flags & (STR_CMP_SUBSTR | STR_CMP_LABELS) )
696     return string_comparator_create (var, dict, str, flags);
697
698   return value_comparator_create (var, dict, str);
699 }
700
701
702 /* Find the row and column specified by the dialog FD, starting at CURRENT_ROW.
703    After the function returns, *ROW contains the row and *COLUMN the column.
704    If no such case is found, then *ROW will be set to -1
705  */
706 static void
707 find_value (const struct find_dialog *fd, casenumber current_row,
708            casenumber *row, int *column)
709 {
710   int width;
711   const struct variable *var;
712   const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
713   const char *target_string = gtk_entry_get_text (GTK_ENTRY (fd->value_entry));
714
715   enum string_cmp_flags flags = 0;
716   g_assert (current_row >= 0);
717
718   var = dict_lookup_var (fd->dict->dict, var_name);
719   if ( ! var )
720     return ;
721
722   width = var_get_width (var);
723
724   *column = var_get_dict_index (var);
725   *row = -1;
726
727   if ( gtk_toggle_button_get_active
728        (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox)))
729     flags |= STR_CMP_SUBSTR;
730
731   if ( gtk_toggle_button_get_active
732        (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox)))
733     flags |= STR_CMP_REGEXP;
734
735   if ( gtk_toggle_button_get_active
736        (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox)))
737     flags |= STR_CMP_LABELS;
738
739   {
740     union value val;
741     casenumber i;
742     const struct casenum_iterator *ip = get_iteration_params (fd);
743     struct comparator *cmptr =
744       comparator_factory (var, fd->dict, target_string, flags);
745
746     value_init (&val, width);
747     if ( ! cmptr)
748       goto finish;
749
750     for (i = ip->start (current_row, fd->data);
751          i != ip->end (current_row, fd->data);
752          ip->next (&i, fd->data))
753       {
754         datasheet_get_value (fd->data, i, var_get_case_index (var), &val);
755
756         if ( comparator_compare (cmptr, &val))
757           {
758             *row = i;
759             break;
760           }
761       }
762
763   finish:
764     comparator_destroy (cmptr);
765     value_destroy (&val, width);
766   }
767 }