1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2007, 2009, 2011, 2012, 2015, 2020 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 */
27 #include <sys/types.h>
29 #include "data/data-in.h"
30 #include "data/datasheet.h"
31 #include "data/format.h"
32 #include "data/value.h"
33 #include "libpspp/cast.h"
34 #include "libpspp/message.h"
35 #include "ui/gui/builder-wrapper.h"
36 #include "ui/gui/dict-display.h"
37 #include "ui/gui/find-dialog.h"
38 #include "ui/gui/helper.h"
39 #include "ui/gui/psppire-data-store.h"
40 #include "ui/gui/psppire-data-window.h"
41 #include "ui/gui/psppire-dialog.h"
42 #include "ui/gui/psppire-selector.h"
43 #include <ssw-sheet.h>
45 #include "gl/xalloc.h"
48 #define _(msgid) gettext (msgid)
49 #define N_(msgid) msgid
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;
66 find_value (const struct find_dialog *fd, casenumber current_row,
67 casenumber *row, int *column);
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.
75 refresh (GObject *obj, const struct find_dialog *fd)
77 gtk_toggle_button_set_active
78 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")),
81 gtk_toggle_button_set_active
82 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")),
85 gtk_entry_set_text (GTK_ENTRY (fd->variable_entry), "");
86 gtk_entry_set_text (GTK_ENTRY (fd->value_entry), "");
88 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox),
91 gtk_toggle_button_set_active
92 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
95 gtk_toggle_button_set_active
96 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
99 /* Callback on the "Find" button */
101 do_find (GObject *obj, const struct find_dialog *fd)
107 find_value (fd, row, &x, &column);
111 SswSheet *sheet = SSW_SHEET (fd->de->data_editor->data_sheet);
112 gtk_notebook_set_current_page (GTK_NOTEBOOK (fd->de->data_editor),
113 PSPPIRE_DATA_EDITOR_DATA_VIEW);
115 ssw_sheet_scroll_to (sheet, column, x);
116 ssw_sheet_set_active_cell (sheet, column, x, NULL);
120 /* Callback on the selector.
121 It gets invoked whenever a variable is selected */
123 on_select (GtkEntry *entry, gpointer data)
125 struct find_dialog *fd = data;
126 const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
127 struct variable *var = dict_lookup_var (fd->dict->dict, var_name);
128 gboolean search_labels ;
130 g_return_if_fail (var);
132 gtk_widget_set_sensitive (fd->value_labels_checkbox,
133 var_has_value_labels (var));
136 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox));
138 gtk_widget_set_sensitive (fd->match_regexp_checkbox,
139 var_is_alpha (var) || search_labels);
142 gtk_widget_set_sensitive (fd->match_substring_checkbox,
143 var_is_alpha (var) || search_labels);
146 /* Callback on the selector.
147 It gets invoked whenever a variable is unselected */
149 on_deselect (GtkEntry *entry, gpointer data)
151 struct find_dialog *fd = data;
153 gtk_widget_set_sensitive (fd->value_labels_checkbox, FALSE);
154 gtk_widget_set_sensitive (fd->match_substring_checkbox, FALSE);
155 gtk_widget_set_sensitive (fd->match_regexp_checkbox, FALSE);
159 value_labels_toggled (GtkToggleButton *tb, gpointer data)
161 struct find_dialog *fd = data;
163 const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
164 const struct variable *var = dict_lookup_var (fd->dict->dict, var_name);
166 gboolean active = gtk_toggle_button_get_active (tb) ;
168 gtk_widget_set_sensitive (fd->match_substring_checkbox,
169 active || (var && var_is_alpha (var)));
171 gtk_widget_set_sensitive (fd->match_regexp_checkbox,
172 active || (var && var_is_alpha (var)));
175 /* Pops up the Find dialog box
178 find_dialog (PsppireDataWindow *de)
180 struct find_dialog fd;
185 GtkWidget *find_button;
187 GtkWidget *buttonbox;
189 PsppireDataStore *ds ;
191 fd.xml = builder_new ("find.ui");
194 find_button = gtk_button_new_with_label (_("Find"));
195 gtk_widget_show (find_button);
197 buttonbox = get_widget_assert (fd.xml, "find-buttonbox");
199 psppire_box_pack_start_defaults (GTK_BOX (buttonbox), find_button);
200 gtk_box_reorder_child (GTK_BOX (buttonbox), find_button, 0);
202 dialog = get_widget_assert (fd.xml, "find-dialog");
203 source = get_widget_assert (fd.xml, "find-variable-treeview");
204 selector = get_widget_assert (fd.xml, "find-selector");
206 g_object_get (de->data_editor,
207 "dictionary", &fd.dict,
211 fd.data = ds->datasheet;
213 fd.variable_entry = get_widget_assert (fd.xml, "find-variable-entry");
214 fd.value_entry = get_widget_assert (fd.xml, "find-value-entry");
215 fd.value_labels_checkbox =
216 get_widget_assert (fd.xml,
217 "find-value-labels-checkbutton");
219 fd.match_regexp_checkbox =
220 get_widget_assert (fd.xml,
221 "find-match-regexp-checkbutton");
223 fd.match_substring_checkbox =
224 get_widget_assert (fd.xml,
225 "find-match-substring-checkbutton");
229 gtk_window_set_transient_for (GTK_WINDOW (dialog), GTK_WINDOW (de));
232 g_object_set (source, "model", fd.dict,
233 "selection-mode", GTK_SELECTION_SINGLE,
237 psppire_selector_set_filter_func (PSPPIRE_SELECTOR (selector),
238 is_currently_in_entry);
240 g_signal_connect (dialog, "refresh", G_CALLBACK (refresh), &fd);
242 g_signal_connect (find_button, "clicked", G_CALLBACK (do_find), &fd);
244 g_signal_connect (selector, "selected",
245 G_CALLBACK (on_select), &fd);
247 g_signal_connect (selector, "de-selected",
248 G_CALLBACK (on_deselect), &fd);
250 g_signal_connect (fd.value_labels_checkbox, "toggled",
251 G_CALLBACK (value_labels_toggled), &fd);
254 psppire_dialog_run (PSPPIRE_DIALOG (dialog));
256 g_object_unref (fd.xml);
263 forward (casenumber *i, struct datasheet *data UNUSED)
270 forward_wrap (casenumber *i, struct datasheet *data)
272 if (++*i >= datasheet_get_n_rows (data)) *i = 0;
276 backward (casenumber *i, struct datasheet *data UNUSED)
283 backward_wrap (casenumber *i, struct datasheet *data)
286 *i = datasheet_get_n_rows (data) - 1;
290 /* Current plus one */
292 cp1 (casenumber current, struct datasheet *data)
297 /* Current plus one, circular */
299 cp1c (casenumber current, struct datasheet *data)
301 casenumber next = current;
303 forward_wrap (&next, data);
309 /* Current minus one */
311 cm1 (casenumber current, struct datasheet *data)
314 return datasheet_get_n_rows (data);
319 /* Current minus one, circular */
321 cm1c (casenumber current, struct datasheet *data)
323 casenumber next = current;
326 return datasheet_get_n_rows (data);
328 backward_wrap (&next, data);
335 last (casenumber current, struct datasheet *data)
337 return datasheet_get_n_rows (data) ;
341 minus1 (casenumber current, struct datasheet *data)
349 /* An type to facilitate iterating through casenumbers */
350 struct casenum_iterator
352 /* returns the first case to access */
353 casenumber (*start) (casenumber, struct datasheet *);
355 /* Returns one past the last case to access */
356 casenumber (*end) (casenumber, struct datasheet *);
358 /* Sets the first arg to the next case to access */
359 void (*next) (casenumber *, struct datasheet *);
370 static const struct casenum_iterator ip[n_iterators] =
372 {cp1, last, forward},
373 {cp1c, cm1, forward_wrap},
374 {cm1, minus1, backward},
375 {cm1c, cp1, backward_wrap}
380 /* A factory returning an iterator according to the dialog box's settings */
381 static const struct casenum_iterator *
382 get_iteration_params (const struct find_dialog *fd)
384 gboolean wrap = gtk_toggle_button_get_active
385 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")));
387 gboolean reverse = gtk_toggle_button_get_active
388 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")));
393 return &ip[REVERSE_WRAP];
395 return &ip[FORWARD_WRAP];
407 enum string_cmp_flags
409 STR_CMP_SUBSTR = 0x01, /* Find strings which are substrings of the
411 STR_CMP_REGEXP = 0x02, /* Match against a regular expression */
413 STR_CMP_LABELS = 0x04 /* Match against the values' labels instead
418 /* An abstract base type for comparing union values against a reference */
421 const struct variable *var;
422 enum string_cmp_flags flags;
424 bool (*compare) (const struct comparator *,
425 const union value *);
427 void (*destroy) (struct comparator *);
431 /* A comparator which operates on the unadulterated union values */
432 struct value_comparator
434 struct comparator parent;
438 /* A comparator which matches string values or parts thereof */
439 struct string_comparator
441 struct comparator parent;
445 /* A comparator to match string values against a POSIX.2 regular expression */
446 struct regexp_comparator
448 struct comparator parent;
454 value_compare (const struct comparator *cmptr,
455 const union value *v)
457 const struct value_comparator *vc = (const struct value_comparator *) cmptr;
458 return 0 == value_compare_3way (v, &vc->pattern, var_get_width (cmptr->var));
462 /* Return true if the label of VAL matches the reference string*/
464 string_label_compare (const struct comparator *cmptr,
465 const union value *val)
467 const struct string_comparator *ssc =
468 (const struct string_comparator *) cmptr;
472 const char *text = var_lookup_value_label (cmptr->var, val);
476 width = strlen (text);
478 assert (cmptr->flags & STR_CMP_LABELS);
480 g_return_val_if_fail (width > 0, false);
482 if (cmptr->flags & STR_CMP_SUBSTR)
483 return (NULL != g_strstr_len (text, width, ssc->pattern));
485 return (0 == strncmp (text, ssc->pattern, width));
488 /* Return true if VAL matches the reference string*/
490 string_value_compare (const struct comparator *cmptr,
491 const union value *val)
495 const struct string_comparator *ssc =
496 (const struct string_comparator *) cmptr;
498 int width = var_get_width (cmptr->var);
499 g_return_val_if_fail (width > 0, false);
500 assert (! (cmptr->flags & STR_CMP_LABELS));
502 text = value_to_text (*val, cmptr->var);
504 if (cmptr->flags & STR_CMP_SUBSTR)
505 found = (NULL != g_strstr_len (text, width, ssc->pattern));
507 found = (0 == strncmp (text, ssc->pattern, width));
515 /* Return true if VAL matched the regexp */
517 regexp_value_compare (const struct comparator *cmptr,
518 const union value *val)
522 const struct regexp_comparator *rec =
523 (const struct regexp_comparator *) cmptr;
525 int width = var_get_width (cmptr->var);
527 assert (! (cmptr->flags & STR_CMP_LABELS));
529 g_return_val_if_fail (width > 0, false);
531 text = value_to_text (*val, cmptr->var);
532 /* We must remove trailing whitespace, otherwise $ will not match where
536 retval = (0 == regexec (&rec->re, text, 0, 0, 0));
543 /* Return true if the label of VAL matched the regexp */
545 regexp_label_compare (const struct comparator *cmptr,
546 const union value *val)
549 const struct regexp_comparator *rec =
550 (const struct regexp_comparator *) cmptr;
554 assert (cmptr->flags & STR_CMP_LABELS);
556 text = var_lookup_value_label (cmptr->var, val);
557 width = strlen (text);
559 g_return_val_if_fail (width > 0, false);
561 return (0 == regexec (&rec->re, text, 0, 0, 0));
567 regexp_destroy (struct comparator *cmptr)
569 struct regexp_comparator *rec
570 = UP_CAST (cmptr, struct regexp_comparator, parent);
576 cmptr_value_destroy (struct comparator *cmptr)
578 struct value_comparator *vc
579 = UP_CAST (cmptr, struct value_comparator, parent);
580 value_destroy (&vc->pattern, var_get_width (cmptr->var));
584 static struct comparator *
585 value_comparator_create (const struct variable *var, const char *target)
587 struct value_comparator *vc = xzalloc (sizeof (*vc));
588 struct comparator *cmptr = &vc->parent;
592 cmptr->compare = value_compare ;
593 cmptr->destroy = cmptr_value_destroy;
595 text_to_value (target, var, &vc->pattern);
600 static struct comparator *
601 string_comparator_create (const struct variable *var, const char *target,
602 enum string_cmp_flags flags)
604 struct string_comparator *ssc = xzalloc (sizeof (*ssc));
605 struct comparator *cmptr = &ssc->parent;
607 cmptr->flags = flags;
610 if (flags & STR_CMP_LABELS)
611 cmptr->compare = string_label_compare;
613 cmptr->compare = string_value_compare;
615 ssc->pattern = target;
621 static struct comparator *
622 regexp_comparator_create (const struct variable *var, const char *target,
623 enum string_cmp_flags flags)
626 struct regexp_comparator *rec = xzalloc (sizeof (*rec));
627 struct comparator *cmptr = &rec->parent;
629 cmptr->flags = flags;
631 cmptr->compare = (flags & STR_CMP_LABELS)
632 ? regexp_label_compare : regexp_value_compare ;
634 cmptr->destroy = regexp_destroy;
636 code = regcomp (&rec->re, target, 0);
640 size_t errbuf_size = regerror (code, &rec->re, errbuf, 0);
642 errbuf = xmalloc (errbuf_size);
644 regerror (code, &rec->re, errbuf, errbuf_size);
646 msg (ME, _("Bad regular expression: %s"), errbuf);
657 /* Compare V against CMPTR's reference */
659 comparator_compare (const struct comparator *cmptr,
660 const union value *v)
662 return cmptr->compare (cmptr, v);
667 comparator_destroy (struct comparator *cmptr)
673 cmptr->destroy (cmptr);
679 static struct comparator *
680 comparator_factory (const struct variable *var, const char *str,
681 enum string_cmp_flags flags)
683 if (flags & STR_CMP_REGEXP)
684 return regexp_comparator_create (var, str, flags);
686 if (flags & (STR_CMP_SUBSTR | STR_CMP_LABELS))
687 return string_comparator_create (var, str, flags);
689 return value_comparator_create (var, str);
693 /* Find the row and column specified by the dialog FD, starting at CURRENT_ROW.
694 After the function returns, *ROW contains the row and *COLUMN the column.
695 If no such case is found, then *ROW will be set to -1
698 find_value (const struct find_dialog *fd, casenumber current_row,
699 casenumber *row, int *column)
702 const struct variable *var;
703 const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
704 const char *target_string = gtk_entry_get_text (GTK_ENTRY (fd->value_entry));
706 enum string_cmp_flags flags = 0;
708 var = dict_lookup_var (fd->dict->dict, var_name);
712 width = var_get_width (var);
714 *column = var_get_dict_index (var);
717 if (gtk_toggle_button_get_active
718 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox)))
719 flags |= STR_CMP_SUBSTR;
721 if (gtk_toggle_button_get_active
722 (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox)))
723 flags |= STR_CMP_REGEXP;
725 if (gtk_toggle_button_get_active
726 (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox)))
727 flags |= STR_CMP_LABELS;
732 const struct casenum_iterator *ip = get_iteration_params (fd);
733 struct comparator *cmptr =
734 comparator_factory (var, target_string, flags);
736 value_init (&val, width);
740 for (i = ip->start (current_row, fd->data);
741 i != ip->end (current_row, fd->data);
742 ip->next (&i, fd->data))
744 datasheet_get_value (fd->data, i, var_get_case_index (var), &val);
746 if (comparator_compare (cmptr, &val))
754 comparator_destroy (cmptr);
755 value_destroy (&val, width);