1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2007, 2009, 2011 Free Software Foundation
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.
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.
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/>. */
18 /* This module implements the "Find" dialog; a dialog box to locate cases
19 which match particular strings */
23 #include "find-dialog.h"
24 #include "psppire-selector.h"
25 #include "psppire-dialog.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"
35 #include <sys/types.h>
37 #include <libpspp/cast.h>
38 #include <libpspp/message.h>
46 #define _(msgid) gettext (msgid)
47 #define N_(msgid) msgid
50 /* FIXME: These shouldn't be here */
51 #include "psppire-var-store.h"
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;
67 find_value (const struct find_dialog *fd, casenumber current_row,
68 casenumber *row, int *column);
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.
76 refresh (GObject *obj, const struct find_dialog *fd)
78 gtk_toggle_button_set_active
79 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")),
82 gtk_toggle_button_set_active
83 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")),
86 gtk_entry_set_text (GTK_ENTRY (fd->variable_entry), "");
87 gtk_entry_set_text (GTK_ENTRY (fd->value_entry), "");
89 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox),
92 gtk_toggle_button_set_active
93 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
96 gtk_toggle_button_set_active
97 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
100 /* Callback on the "Find" button */
102 do_find (GObject *obj, const struct find_dialog *fd)
108 g_object_get (fd->de->data_editor, "current-case", &row, NULL);
113 find_value (fd, row, &x, &column);
118 gtk_notebook_set_current_page (GTK_NOTEBOOK (fd->de->data_editor),
119 PSPPIRE_DATA_EDITOR_DATA_VIEW);
121 g_object_set (fd->de->data_editor,
123 "current-variable", column,
129 /* Callback on the selector.
130 It gets invoked whenever a variable is selected */
132 on_select (GtkEntry *entry, gpointer data)
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 ;
139 g_return_if_fail (var);
141 gtk_widget_set_sensitive (fd->value_labels_checkbox,
142 var_has_value_labels (var));
145 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox));
147 gtk_widget_set_sensitive (fd->match_regexp_checkbox,
148 var_is_alpha (var) || search_labels);
151 gtk_widget_set_sensitive (fd->match_substring_checkbox,
152 var_is_alpha (var) || search_labels);
155 /* Callback on the selector.
156 It gets invoked whenever a variable is unselected */
158 on_deselect (GtkEntry *entry, gpointer data)
160 struct find_dialog *fd = data;
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);
168 value_labels_toggled (GtkToggleButton *tb, gpointer data)
170 struct find_dialog *fd = data;
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);
175 gboolean active = gtk_toggle_button_get_active (tb) ;
177 gtk_widget_set_sensitive (fd->match_substring_checkbox,
178 active || (var && var_is_alpha (var)));
180 gtk_widget_set_sensitive (fd->match_regexp_checkbox,
181 active || (var && var_is_alpha (var)));
184 /* Pops up the Find dialog box
187 find_dialog (PsppireDataWindow *de)
189 struct find_dialog fd;
194 GtkWidget *find_button;
196 GtkWidget *buttonbox;
198 PsppireVarStore *vs ;
199 PsppireDataStore *ds ;
201 fd.xml = builder_new ("find.ui");
204 find_button = gtk_button_new_from_stock (GTK_STOCK_FIND);
205 gtk_widget_show (find_button);
207 buttonbox = get_widget_assert (fd.xml, "find-buttonbox");
209 psppire_box_pack_start_defaults (GTK_BOX (buttonbox), find_button);
210 gtk_box_reorder_child (GTK_BOX (buttonbox), find_button, 0);
212 dialog = get_widget_assert (fd.xml, "find-dialog");
213 source = get_widget_assert (fd.xml, "find-variable-treeview");
214 selector = get_widget_assert (fd.xml, "find-selector");
216 g_object_get (de->data_editor,
221 g_object_get (vs, "dictionary", &fd.dict, NULL);
223 fd.data = ds->datasheet;
225 fd.variable_entry = get_widget_assert (fd.xml, "find-variable-entry");
226 fd.value_entry = get_widget_assert (fd.xml, "find-value-entry");
227 fd.value_labels_checkbox =
228 get_widget_assert (fd.xml,
229 "find-value-labels-checkbutton");
231 fd.match_regexp_checkbox =
232 get_widget_assert (fd.xml,
233 "find-match-regexp-checkbutton");
235 fd.match_substring_checkbox =
236 get_widget_assert (fd.xml,
237 "find-match-substring-checkbutton");
241 gtk_window_set_transient_for (GTK_WINDOW (dialog), GTK_WINDOW (de));
244 g_object_set (source, "model", fd.dict,
245 "selection-mode", GTK_SELECTION_SINGLE,
249 psppire_selector_set_filter_func (PSPPIRE_SELECTOR (selector),
250 is_currently_in_entry);
252 g_signal_connect (dialog, "refresh", G_CALLBACK (refresh), &fd);
254 g_signal_connect (find_button, "clicked", G_CALLBACK (do_find), &fd);
256 g_signal_connect (selector, "selected",
257 G_CALLBACK (on_select), &fd);
259 g_signal_connect (selector, "de-selected",
260 G_CALLBACK (on_deselect), &fd);
262 g_signal_connect (fd.value_labels_checkbox, "toggled",
263 G_CALLBACK (value_labels_toggled), &fd);
266 psppire_dialog_run (PSPPIRE_DIALOG (dialog));
268 g_object_unref (fd.xml);
275 forward (casenumber *i, struct datasheet *data UNUSED)
282 forward_wrap (casenumber *i, struct datasheet *data)
284 if ( ++*i >= datasheet_get_n_rows (data) ) *i = 0;
288 backward (casenumber *i, struct datasheet *data UNUSED)
295 backward_wrap (casenumber *i, struct datasheet *data)
298 *i = datasheet_get_n_rows (data) - 1;
302 /* Current plus one */
304 cp1 (casenumber current, struct datasheet *data)
309 /* Current plus one, circular */
311 cp1c (casenumber current, struct datasheet *data)
313 casenumber next = current;
315 forward_wrap (&next, data);
321 /* Current minus one */
323 cm1 (casenumber current, struct datasheet *data)
328 /* Current minus one, circular */
330 cm1c (casenumber current, struct datasheet *data)
332 casenumber next = current;
334 backward_wrap (&next, data);
341 last (casenumber current, struct datasheet *data)
343 return datasheet_get_n_rows (data) ;
347 minus1 (casenumber current, struct datasheet *data)
352 /* An type to facilitate iterating through casenumbers */
353 struct casenum_iterator
355 /* returns the first case to access */
356 casenumber (*start) (casenumber, struct datasheet *);
358 /* Returns one past the last case to access */
359 casenumber (*end) (casenumber, struct datasheet *);
361 /* Sets the first arg to the next case to access */
362 void (*next) (casenumber *, struct datasheet *);
373 static const struct casenum_iterator ip[n_iterators] =
375 {cp1, last, forward},
376 {cp1c, cm1, forward_wrap},
377 {cm1, minus1, backward},
378 {cm1c, cp1, backward_wrap}
383 /* A factory returning an iterator according to the dialog box's settings */
384 static const struct casenum_iterator *
385 get_iteration_params (const struct find_dialog *fd)
387 gboolean wrap = gtk_toggle_button_get_active
388 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")));
390 gboolean reverse = gtk_toggle_button_get_active
391 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")));
396 return &ip[REVERSE_WRAP];
398 return &ip[FORWARD_WRAP];
410 enum string_cmp_flags
412 STR_CMP_SUBSTR = 0x01, /* Find strings which are substrings of the
414 STR_CMP_REGEXP = 0x02, /* Match against a regular expression */
416 STR_CMP_LABELS = 0x04 /* Match against the values' labels instead
421 /* An abstract base type for comparing union values against a reference */
424 const struct variable *var;
425 enum string_cmp_flags flags;
427 bool (*compare) (const struct comparator *,
428 const union value *);
430 void (*destroy) (struct comparator *);
434 /* A comparator which operates on the unadulterated union values */
435 struct value_comparator
437 struct comparator parent;
441 /* A comparator which matches string values or parts thereof */
442 struct string_comparator
444 struct comparator parent;
448 /* A comparator to match string values against a POSIX.2 regular expression */
449 struct regexp_comparator
451 struct comparator parent;
457 value_compare (const struct comparator *cmptr,
458 const union value *v)
460 const struct value_comparator *vc = (const struct value_comparator *) cmptr;
461 return 0 == value_compare_3way (v, &vc->pattern, var_get_width (cmptr->var));
465 /* Return true if the label of VAL matches the reference string*/
467 string_label_compare (const struct comparator *cmptr,
468 const union value *val)
470 const struct string_comparator *ssc =
471 (const struct string_comparator *) cmptr;
473 const char *text = var_lookup_value_label (cmptr->var, val);
474 int width = strlen (text);
476 assert ( cmptr->flags & STR_CMP_LABELS);
478 g_return_val_if_fail (width > 0, false);
480 if ( cmptr->flags & STR_CMP_SUBSTR)
481 return (NULL != g_strstr_len (text, width, ssc->pattern));
483 return (0 == strncmp (text, ssc->pattern, width));
486 /* Return true if VAL matches the reference string*/
488 string_value_compare (const struct comparator *cmptr,
489 const union value *val)
493 const struct string_comparator *ssc =
494 (const struct string_comparator *) cmptr;
496 int width = var_get_width (cmptr->var);
497 g_return_val_if_fail (width > 0, false);
498 assert ( ! (cmptr->flags & STR_CMP_LABELS));
500 text = value_to_text (*val, cmptr->var);
502 if ( cmptr->flags & STR_CMP_SUBSTR)
503 found = (NULL != g_strstr_len (text, width, ssc->pattern));
505 found = (0 == strncmp (text, ssc->pattern, width));
513 /* Return true if VAL matched the regexp */
515 regexp_value_compare (const struct comparator *cmptr,
516 const union value *val)
520 const struct regexp_comparator *rec =
521 (const struct regexp_comparator *) cmptr;
523 int width = var_get_width (cmptr->var);
525 assert ( ! (cmptr->flags & STR_CMP_LABELS) );
527 g_return_val_if_fail (width > 0, false);
529 text = value_to_text (*val, cmptr->var);
530 /* We must remove trailing whitespace, otherwise $ will not match where
534 retval = (0 == regexec (&rec->re, text, 0, 0, 0));
541 /* Return true if the label of VAL matched the regexp */
543 regexp_label_compare (const struct comparator *cmptr,
544 const union value *val)
547 const struct regexp_comparator *rec =
548 (const struct regexp_comparator *) cmptr;
552 assert ( cmptr->flags & STR_CMP_LABELS);
554 text = var_lookup_value_label (cmptr->var, val);
555 width = strlen (text);
557 g_return_val_if_fail (width > 0, false);
559 return (0 == regexec (&rec->re, text, 0, 0, 0));
565 regexp_destroy (struct comparator *cmptr)
567 struct regexp_comparator *rec
568 = UP_CAST (cmptr, struct regexp_comparator, parent);
574 cmptr_value_destroy (struct comparator *cmptr)
576 struct value_comparator *vc
577 = UP_CAST (cmptr, struct value_comparator, parent);
578 value_destroy (&vc->pattern, var_get_width (cmptr->var));
582 static struct comparator *
583 value_comparator_create (const struct variable *var, const char *target)
585 struct value_comparator *vc = xzalloc (sizeof (*vc));
586 struct comparator *cmptr = &vc->parent;
590 cmptr->compare = value_compare ;
591 cmptr->destroy = cmptr_value_destroy;
593 text_to_value (target, var, &vc->pattern);
598 static struct comparator *
599 string_comparator_create (const struct variable *var, const char *target,
600 enum string_cmp_flags flags)
602 struct string_comparator *ssc = xzalloc (sizeof (*ssc));
603 struct comparator *cmptr = &ssc->parent;
605 cmptr->flags = flags;
608 if ( flags & STR_CMP_LABELS)
609 cmptr->compare = string_label_compare;
611 cmptr->compare = string_value_compare;
613 ssc->pattern = target;
619 static struct comparator *
620 regexp_comparator_create (const struct variable *var, const char *target,
621 enum string_cmp_flags flags)
624 struct regexp_comparator *rec = xzalloc (sizeof (*rec));
625 struct comparator *cmptr = &rec->parent;
627 cmptr->flags = flags;
629 cmptr->compare = (flags & STR_CMP_LABELS)
630 ? regexp_label_compare : regexp_value_compare ;
632 cmptr->destroy = regexp_destroy;
634 code = regcomp (&rec->re, target, 0);
638 size_t errbuf_size = regerror (code, &rec->re, errbuf, 0);
640 errbuf = xmalloc (errbuf_size);
642 regerror (code, &rec->re, errbuf, errbuf_size);
644 msg (ME, _("Bad regular expression: %s"), errbuf);
655 /* Compare V against CMPTR's reference */
657 comparator_compare (const struct comparator *cmptr,
658 const union value *v)
660 return cmptr->compare (cmptr, v);
665 comparator_destroy (struct comparator *cmptr)
670 if ( cmptr->destroy )
671 cmptr->destroy (cmptr);
677 static struct comparator *
678 comparator_factory (const struct variable *var, const char *str,
679 enum string_cmp_flags flags)
681 if ( flags & STR_CMP_REGEXP )
682 return regexp_comparator_create (var, str, flags);
684 if ( flags & (STR_CMP_SUBSTR | STR_CMP_LABELS) )
685 return string_comparator_create (var, str, flags);
687 return value_comparator_create (var, str);
691 /* Find the row and column specified by the dialog FD, starting at CURRENT_ROW.
692 After the function returns, *ROW contains the row and *COLUMN the column.
693 If no such case is found, then *ROW will be set to -1
696 find_value (const struct find_dialog *fd, casenumber current_row,
697 casenumber *row, int *column)
700 const struct variable *var;
701 const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
702 const char *target_string = gtk_entry_get_text (GTK_ENTRY (fd->value_entry));
704 enum string_cmp_flags flags = 0;
705 g_assert (current_row >= 0);
707 var = dict_lookup_var (fd->dict->dict, var_name);
711 width = var_get_width (var);
713 *column = var_get_dict_index (var);
716 if ( gtk_toggle_button_get_active
717 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox)))
718 flags |= STR_CMP_SUBSTR;
720 if ( gtk_toggle_button_get_active
721 (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox)))
722 flags |= STR_CMP_REGEXP;
724 if ( gtk_toggle_button_get_active
725 (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox)))
726 flags |= STR_CMP_LABELS;
731 const struct casenum_iterator *ip = get_iteration_params (fd);
732 struct comparator *cmptr =
733 comparator_factory (var, target_string, flags);
735 value_init (&val, width);
739 for (i = ip->start (current_row, fd->data);
740 i != ip->end (current_row, fd->data);
741 ip->next (&i, fd->data))
743 datasheet_get_value (fd->data, i, var_get_case_index (var), &val);
745 if ( comparator_compare (cmptr, &val))
753 comparator_destroy (cmptr);
754 value_destroy (&val, width);