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>
30 #include "data/data-in.h"
31 #include "data/datasheet.h"
32 #include "data/format.h"
33 #include "data/value.h"
34 #include "libpspp/cast.h"
35 #include "libpspp/message.h"
36 #include "ui/gui/builder-wrapper.h"
37 #include "ui/gui/dict-display.h"
38 #include "ui/gui/find-dialog.h"
39 #include "ui/gui/helper.h"
40 #include "ui/gui/psppire-data-store.h"
41 #include "ui/gui/psppire-data-window.h"
42 #include "ui/gui/psppire-dialog.h"
43 #include "ui/gui/psppire-selector.h"
44 #include <ssw-sheet.h>
46 #include "gl/xalloc.h"
49 #define _(msgid) gettext (msgid)
50 #define N_(msgid) msgid
52 /* Some systems like MacOS do not have exp10 */
54 inline static double exp10(double x)
64 struct datasheet *data;
65 PsppireDataWindow *de;
66 GtkWidget *variable_entry;
67 GtkWidget *value_entry;
68 GtkWidget *value_labels_checkbox;
69 GtkWidget *match_regexp_checkbox;
70 GtkWidget *match_substring_checkbox;
74 find_value (const struct find_dialog *fd, casenumber current_row,
75 casenumber *row, int *column);
78 /* A callback which occurs whenever the "Refresh" button is clicked,
79 and when the dialog pops up.
80 It restores the dialog to its default state.
83 refresh (GObject *obj, const struct find_dialog *fd)
85 gtk_toggle_button_set_active
86 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")),
89 gtk_toggle_button_set_active
90 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")),
93 gtk_entry_set_text (GTK_ENTRY (fd->variable_entry), "");
94 gtk_entry_set_text (GTK_ENTRY (fd->value_entry), "");
96 gtk_toggle_button_set_active (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox),
99 gtk_toggle_button_set_active
100 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
103 gtk_toggle_button_set_active
104 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox), FALSE);
107 /* Callback on the "Find" button */
109 do_find (GObject *obj, const struct find_dialog *fd)
115 find_value (fd, row, &x, &column);
119 SswSheet *sheet = SSW_SHEET (fd->de->data_editor->data_sheet);
120 gtk_notebook_set_current_page (GTK_NOTEBOOK (fd->de->data_editor),
121 PSPPIRE_DATA_EDITOR_DATA_VIEW);
123 ssw_sheet_scroll_to (sheet, column, x);
124 ssw_sheet_set_active_cell (sheet, column, x, NULL);
128 /* Callback on the selector.
129 It gets invoked whenever a variable is selected */
131 on_select (GtkEntry *entry, gpointer data)
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 ;
138 g_return_if_fail (var);
140 gtk_widget_set_sensitive (fd->value_labels_checkbox,
141 var_has_value_labels (var));
144 gtk_toggle_button_get_active (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox));
146 gtk_widget_set_sensitive (fd->match_regexp_checkbox,
147 var_is_alpha (var) || search_labels);
150 gtk_widget_set_sensitive (fd->match_substring_checkbox,
151 var_is_alpha (var) || search_labels);
154 /* Callback on the selector.
155 It gets invoked whenever a variable is unselected */
157 on_deselect (GtkEntry *entry, gpointer data)
159 struct find_dialog *fd = data;
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);
167 value_labels_toggled (GtkToggleButton *tb, gpointer data)
169 struct find_dialog *fd = data;
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);
174 gboolean active = gtk_toggle_button_get_active (tb) ;
176 gtk_widget_set_sensitive (fd->match_substring_checkbox,
177 active || (var && var_is_alpha (var)));
179 gtk_widget_set_sensitive (fd->match_regexp_checkbox,
180 active || (var && var_is_alpha (var)));
183 /* Pops up the Find dialog box
186 find_dialog (PsppireDataWindow *de)
188 struct find_dialog fd;
193 GtkWidget *find_button;
195 GtkWidget *buttonbox;
197 PsppireDataStore *ds ;
199 fd.xml = builder_new ("find.ui");
202 find_button = gtk_button_new_with_label (_("Find"));
203 gtk_widget_show (find_button);
205 buttonbox = get_widget_assert (fd.xml, "find-buttonbox");
207 psppire_box_pack_start_defaults (GTK_BOX (buttonbox), find_button);
208 gtk_box_reorder_child (GTK_BOX (buttonbox), find_button, 0);
210 dialog = get_widget_assert (fd.xml, "find-dialog");
211 source = get_widget_assert (fd.xml, "find-variable-treeview");
212 selector = get_widget_assert (fd.xml, "find-selector");
214 g_object_get (de->data_editor,
215 "dictionary", &fd.dict,
219 fd.data = ds->datasheet;
221 fd.variable_entry = get_widget_assert (fd.xml, "find-variable-entry");
222 fd.value_entry = get_widget_assert (fd.xml, "find-value-entry");
223 fd.value_labels_checkbox =
224 get_widget_assert (fd.xml,
225 "find-value-labels-checkbutton");
227 fd.match_regexp_checkbox =
228 get_widget_assert (fd.xml,
229 "find-match-regexp-checkbutton");
231 fd.match_substring_checkbox =
232 get_widget_assert (fd.xml,
233 "find-match-substring-checkbutton");
237 gtk_window_set_transient_for (GTK_WINDOW (dialog), GTK_WINDOW (de));
240 g_object_set (source, "model", fd.dict,
241 "selection-mode", GTK_SELECTION_SINGLE,
245 psppire_selector_set_filter_func (PSPPIRE_SELECTOR (selector),
246 is_currently_in_entry);
248 g_signal_connect (dialog, "refresh", G_CALLBACK (refresh), &fd);
250 g_signal_connect (find_button, "clicked", G_CALLBACK (do_find), &fd);
252 g_signal_connect (selector, "selected",
253 G_CALLBACK (on_select), &fd);
255 g_signal_connect (selector, "de-selected",
256 G_CALLBACK (on_deselect), &fd);
258 g_signal_connect (fd.value_labels_checkbox, "toggled",
259 G_CALLBACK (value_labels_toggled), &fd);
262 psppire_dialog_run (PSPPIRE_DIALOG (dialog));
264 g_object_unref (fd.xml);
271 forward (casenumber *i, struct datasheet *data UNUSED)
278 forward_wrap (casenumber *i, struct datasheet *data)
280 if (++*i >= datasheet_get_n_rows (data)) *i = 0;
284 backward (casenumber *i, struct datasheet *data UNUSED)
291 backward_wrap (casenumber *i, struct datasheet *data)
294 *i = datasheet_get_n_rows (data) - 1;
298 /* Current plus one */
300 cp1 (casenumber current, struct datasheet *data)
305 /* Current plus one, circular */
307 cp1c (casenumber current, struct datasheet *data)
309 casenumber next = current;
311 forward_wrap (&next, data);
317 /* Current minus one */
319 cm1 (casenumber current, struct datasheet *data)
322 return datasheet_get_n_rows (data);
327 /* Current minus one, circular */
329 cm1c (casenumber current, struct datasheet *data)
331 casenumber next = current;
334 return datasheet_get_n_rows (data);
336 backward_wrap (&next, data);
343 last (casenumber current, struct datasheet *data)
345 return datasheet_get_n_rows (data) ;
349 minus1 (casenumber current, struct datasheet *data)
357 /* An type to facilitate iterating through casenumbers */
358 struct casenum_iterator
360 /* returns the first case to access */
361 casenumber (*start) (casenumber, struct datasheet *);
363 /* Returns one past the last case to access */
364 casenumber (*end) (casenumber, struct datasheet *);
366 /* Sets the first arg to the next case to access */
367 void (*next) (casenumber *, struct datasheet *);
378 static const struct casenum_iterator ip[n_iterators] =
380 {cp1, last, forward},
381 {cp1c, cm1, forward_wrap},
382 {cm1, minus1, backward},
383 {cm1c, cp1, backward_wrap}
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)
392 gboolean wrap = gtk_toggle_button_get_active
393 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")));
395 gboolean reverse = gtk_toggle_button_get_active
396 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")));
401 return &ip[REVERSE_WRAP];
403 return &ip[FORWARD_WRAP];
415 enum string_cmp_flags
417 STR_CMP_SUBSTR = 0x01, /* Find strings which are substrings of the
419 STR_CMP_REGEXP = 0x02, /* Match against a regular expression */
421 STR_CMP_LABELS = 0x04 /* Match against the values' labels instead
426 /* An abstract base type for comparing union values against a reference */
429 const struct variable *var;
430 enum string_cmp_flags flags;
432 bool (*compare) (const struct comparator *,
433 const union value *);
435 void (*destroy) (struct comparator *);
439 /* A comparator which operates on the numerical values,
440 rounded to the number of decimal places indicated by
441 the variable's format. */
442 struct numeric_comparator
444 struct comparator parent;
448 /* A comparator which matches string values or parts thereof */
449 struct string_comparator
451 struct comparator parent;
455 /* A comparator to match string values against a POSIX.2 regular expression */
456 struct regexp_comparator
458 struct comparator parent;
464 value_compare (const struct comparator *cmptr,
465 const union value *v)
467 const struct numeric_comparator *nc = (const struct numeric_comparator *) cmptr;
468 const struct fmt_spec *fs = var_get_print_format (cmptr->var);
470 double c = nearbyint (v->f * exp10 (fs->d));
472 return c == nc->rounded_ref;
476 /* Return true if the label of VAL matches the reference string*/
478 string_label_compare (const struct comparator *cmptr,
479 const union value *val)
481 const struct string_comparator *ssc =
482 (const struct string_comparator *) cmptr;
486 const char *text = var_lookup_value_label (cmptr->var, val);
490 width = strlen (text);
492 assert (cmptr->flags & STR_CMP_LABELS);
494 g_return_val_if_fail (width > 0, false);
496 if (cmptr->flags & STR_CMP_SUBSTR)
497 return (NULL != g_strstr_len (text, width, ssc->pattern));
499 return (0 == strncmp (text, ssc->pattern, width));
502 /* Return true if VAL matches the reference string*/
504 string_value_compare (const struct comparator *cmptr,
505 const union value *val)
509 const struct string_comparator *ssc =
510 (const struct string_comparator *) cmptr;
512 int width = var_get_width (cmptr->var);
513 g_return_val_if_fail (width > 0, false);
514 assert (! (cmptr->flags & STR_CMP_LABELS));
516 text = value_to_text (*val, cmptr->var);
518 if (cmptr->flags & STR_CMP_SUBSTR)
519 found = (NULL != g_strstr_len (text, width, ssc->pattern));
521 found = (0 == strncmp (text, ssc->pattern, width));
529 /* Return true if VAL matched the regexp */
531 regexp_value_compare (const struct comparator *cmptr,
532 const union value *val)
536 const struct regexp_comparator *rec =
537 (const struct regexp_comparator *) cmptr;
539 int width = var_get_width (cmptr->var);
541 assert (! (cmptr->flags & STR_CMP_LABELS));
543 g_return_val_if_fail (width > 0, false);
545 text = value_to_text (*val, cmptr->var);
546 /* We must remove trailing whitespace, otherwise $ will not match where
550 retval = (0 == regexec (&rec->re, text, 0, 0, 0));
557 /* Return true if the label of VAL matched the regexp */
559 regexp_label_compare (const struct comparator *cmptr,
560 const union value *val)
563 const struct regexp_comparator *rec =
564 (const struct regexp_comparator *) cmptr;
568 assert (cmptr->flags & STR_CMP_LABELS);
570 text = var_lookup_value_label (cmptr->var, val);
571 width = strlen (text);
573 g_return_val_if_fail (width > 0, false);
575 return (0 == regexec (&rec->re, text, 0, 0, 0));
581 regexp_destroy (struct comparator *cmptr)
583 struct regexp_comparator *rec
584 = UP_CAST (cmptr, struct regexp_comparator, parent);
589 static struct comparator *
590 numeric_comparator_create (const struct variable *var, const char *target)
592 struct numeric_comparator *nc = xzalloc (sizeof (*nc));
593 struct comparator *cmptr = &nc->parent;
597 cmptr->compare = value_compare;
598 const struct fmt_spec *fs = var_get_write_format (var);
601 text_to_value (target, var, &val);
602 nc->rounded_ref = nearbyint (val.f * exp10 (fs->d));
603 value_destroy (&val, var_get_width (var));
608 static struct comparator *
609 string_comparator_create (const struct variable *var, const char *target,
610 enum string_cmp_flags flags)
612 struct string_comparator *ssc = xzalloc (sizeof (*ssc));
613 struct comparator *cmptr = &ssc->parent;
615 cmptr->flags = flags;
618 if (flags & STR_CMP_LABELS)
619 cmptr->compare = string_label_compare;
621 cmptr->compare = string_value_compare;
623 ssc->pattern = target;
629 static struct comparator *
630 regexp_comparator_create (const struct variable *var, const char *target,
631 enum string_cmp_flags flags)
634 struct regexp_comparator *rec = xzalloc (sizeof (*rec));
635 struct comparator *cmptr = &rec->parent;
637 cmptr->flags = flags;
639 cmptr->compare = (flags & STR_CMP_LABELS)
640 ? regexp_label_compare : regexp_value_compare ;
642 cmptr->destroy = regexp_destroy;
644 code = regcomp (&rec->re, target, 0);
648 size_t errbuf_size = regerror (code, &rec->re, errbuf, 0);
650 errbuf = xmalloc (errbuf_size);
652 regerror (code, &rec->re, errbuf, errbuf_size);
654 msg (ME, _("Bad regular expression: %s"), errbuf);
665 /* Compare V against CMPTR's reference */
667 comparator_compare (const struct comparator *cmptr,
668 const union value *v)
670 return cmptr->compare (cmptr, v);
675 comparator_destroy (struct comparator *cmptr)
681 cmptr->destroy (cmptr);
687 static struct comparator *
688 comparator_factory (const struct variable *var, const char *str,
689 enum string_cmp_flags flags)
691 if (flags & STR_CMP_REGEXP)
692 return regexp_comparator_create (var, str, flags);
694 if (flags & (STR_CMP_SUBSTR | STR_CMP_LABELS))
695 return string_comparator_create (var, str, flags);
697 return numeric_comparator_create (var, str);
701 /* Find the row and column specified by the dialog FD, starting at CURRENT_ROW.
702 After the function returns, *ROW contains the row and *COLUMN the column.
703 If no such case is found, then *ROW will be set to -1
706 find_value (const struct find_dialog *fd, casenumber current_row,
707 casenumber *row, int *column)
710 const struct variable *var;
711 const char *var_name = gtk_entry_get_text (GTK_ENTRY (fd->variable_entry));
712 const char *target_string = gtk_entry_get_text (GTK_ENTRY (fd->value_entry));
714 enum string_cmp_flags flags = 0;
716 var = dict_lookup_var (fd->dict->dict, var_name);
720 width = var_get_width (var);
722 *column = var_get_dict_index (var);
725 if (gtk_toggle_button_get_active
726 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox)))
727 flags |= STR_CMP_SUBSTR;
729 if (gtk_toggle_button_get_active
730 (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox)))
731 flags |= STR_CMP_REGEXP;
733 if (gtk_toggle_button_get_active
734 (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox)))
735 flags |= STR_CMP_LABELS;
740 const struct casenum_iterator *ip = get_iteration_params (fd);
741 struct comparator *cmptr =
742 comparator_factory (var, target_string, flags);
744 value_init (&val, width);
748 for (i = ip->start (current_row, fd->data);
749 i != ip->end (current_row, fd->data);
750 ip->next (&i, fd->data))
752 datasheet_get_value (fd->data, i, var_get_case_index (var), &val);
754 if (comparator_compare (cmptr, &val))
762 comparator_destroy (cmptr);
763 value_destroy (&val, width);