1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2007, 2009 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 (GObject *o, gpointer data)
189 PsppireDataWindow *de = PSPPIRE_DATA_WINDOW (data);
191 struct find_dialog fd;
196 GtkWidget *find_button;
198 GtkWidget *buttonbox;
200 PsppireVarStore *vs ;
201 PsppireDataStore *ds ;
203 fd.xml = builder_new ("find.ui");
206 find_button = gtk_button_new_from_stock (GTK_STOCK_FIND);
207 gtk_widget_show (find_button);
209 buttonbox = get_widget_assert (fd.xml, "find-buttonbox");
211 gtk_box_pack_start_defaults (GTK_BOX (buttonbox), find_button);
212 gtk_box_reorder_child (GTK_BOX (buttonbox), find_button, 0);
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");
218 g_object_get (de->data_editor,
223 g_object_get (vs, "dictionary", &fd.dict, NULL);
225 fd.data = ds->datasheet;
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");
233 fd.match_regexp_checkbox =
234 get_widget_assert (fd.xml,
235 "find-match-regexp-checkbutton");
237 fd.match_substring_checkbox =
238 get_widget_assert (fd.xml,
239 "find-match-substring-checkbutton");
243 gtk_window_set_transient_for (GTK_WINDOW (dialog), GTK_WINDOW (de));
246 g_object_set (source, "dictionary", fd.dict,
247 "selection-mode", GTK_SELECTION_SINGLE,
250 psppire_selector_set_subjects (PSPPIRE_SELECTOR (selector),
253 insert_source_row_into_entry,
254 is_currently_in_entry,
258 g_signal_connect (dialog, "refresh", G_CALLBACK (refresh), &fd);
260 g_signal_connect (find_button, "clicked", G_CALLBACK (do_find), &fd);
262 g_signal_connect (selector, "selected",
263 G_CALLBACK (on_select), &fd);
265 g_signal_connect (selector, "de-selected",
266 G_CALLBACK (on_deselect), &fd);
268 g_signal_connect (fd.value_labels_checkbox, "toggled",
269 G_CALLBACK (value_labels_toggled), &fd);
272 psppire_dialog_run (PSPPIRE_DIALOG (dialog));
274 g_object_unref (fd.xml);
281 forward (casenumber *i, struct datasheet *data UNUSED)
288 forward_wrap (casenumber *i, struct datasheet *data)
290 if ( ++*i >= datasheet_get_n_rows (data) ) *i = 0;
294 backward (casenumber *i, struct datasheet *data UNUSED)
301 backward_wrap (casenumber *i, struct datasheet *data)
304 *i = datasheet_get_n_rows (data) - 1;
308 /* Current plus one */
310 cp1 (casenumber current, struct datasheet *data)
315 /* Current plus one, circular */
317 cp1c (casenumber current, struct datasheet *data)
319 casenumber next = current;
321 forward_wrap (&next, data);
327 /* Current minus one */
329 cm1 (casenumber current, struct datasheet *data)
334 /* Current minus one, circular */
336 cm1c (casenumber current, struct datasheet *data)
338 casenumber next = current;
340 backward_wrap (&next, data);
347 last (casenumber current, struct datasheet *data)
349 return datasheet_get_n_rows (data) ;
353 minus1 (casenumber current, struct datasheet *data)
358 /* An type to facilitate iterating through casenumbers */
359 struct casenum_iterator
361 /* returns the first case to access */
362 casenumber (*start) (casenumber, struct datasheet *);
364 /* Returns one past the last case to access */
365 casenumber (*end) (casenumber, struct datasheet *);
367 /* Sets the first arg to the next case to access */
368 void (*next) (casenumber *, struct datasheet *);
379 static const struct casenum_iterator ip[n_iterators] =
381 {cp1, last, forward},
382 {cp1c, cm1, forward_wrap},
383 {cm1, minus1, backward},
384 {cm1c, cp1, backward_wrap}
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)
393 gboolean wrap = gtk_toggle_button_get_active
394 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-wrap")));
396 gboolean reverse = gtk_toggle_button_get_active
397 (GTK_TOGGLE_BUTTON (get_widget_assert (fd->xml, "find-backwards")));
402 return &ip[REVERSE_WRAP];
404 return &ip[FORWARD_WRAP];
416 enum string_cmp_flags
418 STR_CMP_SUBSTR = 0x01, /* Find strings which are substrings of the
420 STR_CMP_REGEXP = 0x02, /* Match against a regular expression */
422 STR_CMP_LABELS = 0x04 /* Match against the values' labels instead
427 /* An abstract base type for comparing union values against a reference */
430 const struct variable *var;
431 enum string_cmp_flags flags;
432 const PsppireDict *dict;
434 bool (*compare) (const struct comparator *,
435 const union value *);
437 void (*destroy) (struct comparator *);
441 /* A comparator which operates on the unadulterated union values */
442 struct value_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 value_comparator *vc = (const struct value_comparator *) cmptr;
468 return 0 == value_compare_3way (v, &vc->pattern, var_get_width (cmptr->var));
472 /* Return true if the label of VAL matches the reference string*/
474 string_label_compare (const struct comparator *cmptr,
475 const union value *val)
477 const struct string_comparator *ssc =
478 (const struct string_comparator *) cmptr;
480 const char *text = var_lookup_value_label (cmptr->var, val);
481 int width = strlen (text);
483 assert ( cmptr->flags & STR_CMP_LABELS);
485 g_return_val_if_fail (width > 0, false);
487 if ( cmptr->flags & STR_CMP_SUBSTR)
488 return (NULL != g_strstr_len (text, width, ssc->pattern));
490 return (0 == strncmp (text, ssc->pattern, width));
493 /* Return true if VAL matches the reference string*/
495 string_value_compare (const struct comparator *cmptr,
496 const union value *val)
500 const struct string_comparator *ssc =
501 (const struct string_comparator *) cmptr;
503 int width = var_get_width (cmptr->var);
504 g_return_val_if_fail (width > 0, false);
505 assert ( ! (cmptr->flags & STR_CMP_LABELS));
507 text = value_to_text (*val, cmptr->dict, *var_get_write_format (cmptr->var));
509 if ( cmptr->flags & STR_CMP_SUBSTR)
510 found = (NULL != g_strstr_len (text, width, ssc->pattern));
512 found = (0 == strncmp (text, ssc->pattern, width));
520 /* Return true if VAL matched the regexp */
522 regexp_value_compare (const struct comparator *cmptr,
523 const union value *val)
527 const struct regexp_comparator *rec =
528 (const struct regexp_comparator *) cmptr;
530 int width = var_get_width (cmptr->var);
532 assert ( ! (cmptr->flags & STR_CMP_LABELS) );
534 g_return_val_if_fail (width > 0, false);
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
541 retval = (0 == regexec (&rec->re, text, 0, 0, 0));
548 /* Return true if the label of VAL matched the regexp */
550 regexp_label_compare (const struct comparator *cmptr,
551 const union value *val)
554 const struct regexp_comparator *rec =
555 (const struct regexp_comparator *) cmptr;
559 assert ( cmptr->flags & STR_CMP_LABELS);
561 text = var_lookup_value_label (cmptr->var, val);
562 width = strlen (text);
564 g_return_val_if_fail (width > 0, false);
566 return (0 == regexec (&rec->re, text, 0, 0, 0));
572 regexp_destroy (struct comparator *cmptr)
574 struct regexp_comparator *rec
575 = UP_CAST (cmptr, struct regexp_comparator, parent);
581 cmptr_value_destroy (struct comparator *cmptr)
583 struct value_comparator *vc
584 = UP_CAST (cmptr, struct value_comparator, parent);
585 value_destroy (&vc->pattern, var_get_width (cmptr->var));
589 static struct comparator *
590 value_comparator_create (const struct variable *var, const PsppireDict *dict, const char *target)
592 struct value_comparator *vc = xzalloc (sizeof (*vc));
593 struct comparator *cmptr = &vc->parent;
597 cmptr->compare = value_compare ;
598 cmptr->destroy = cmptr_value_destroy;
601 text_to_value (target, dict, var, &vc->pattern);
606 static struct comparator *
607 string_comparator_create (const struct variable *var, const PsppireDict *dict,
609 enum string_cmp_flags flags)
611 struct string_comparator *ssc = xzalloc (sizeof (*ssc));
612 struct comparator *cmptr = &ssc->parent;
614 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 PsppireDict *dict, 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;
640 cmptr->compare = (flags & STR_CMP_LABELS)
641 ? regexp_label_compare : regexp_value_compare ;
643 cmptr->destroy = regexp_destroy;
645 code = regcomp (&rec->re, target, 0);
649 size_t errbuf_size = regerror (code, &rec->re, errbuf, 0);
651 errbuf = xmalloc (errbuf_size);
653 regerror (code, &rec->re, errbuf, errbuf_size);
655 msg (ME, _("Bad regular expression: %s"), errbuf);
666 /* Compare V against CMPTR's reference */
668 comparator_compare (const struct comparator *cmptr,
669 const union value *v)
671 return cmptr->compare (cmptr, v);
676 comparator_destroy (struct comparator *cmptr)
681 if ( cmptr->destroy )
682 cmptr->destroy (cmptr);
688 static struct comparator *
689 comparator_factory (const struct variable *var, const PsppireDict *dict, const char *str,
690 enum string_cmp_flags flags)
692 if ( flags & STR_CMP_REGEXP )
693 return regexp_comparator_create (var, dict, str, flags);
695 if ( flags & (STR_CMP_SUBSTR | STR_CMP_LABELS) )
696 return string_comparator_create (var, dict, str, flags);
698 return value_comparator_create (var, dict, str);
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
707 find_value (const struct find_dialog *fd, casenumber current_row,
708 casenumber *row, int *column)
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));
715 enum string_cmp_flags flags = 0;
716 g_assert (current_row >= 0);
718 var = dict_lookup_var (fd->dict->dict, var_name);
722 width = var_get_width (var);
724 *column = var_get_dict_index (var);
727 if ( gtk_toggle_button_get_active
728 (GTK_TOGGLE_BUTTON (fd->match_substring_checkbox)))
729 flags |= STR_CMP_SUBSTR;
731 if ( gtk_toggle_button_get_active
732 (GTK_TOGGLE_BUTTON (fd->match_regexp_checkbox)))
733 flags |= STR_CMP_REGEXP;
735 if ( gtk_toggle_button_get_active
736 (GTK_TOGGLE_BUTTON (fd->value_labels_checkbox)))
737 flags |= STR_CMP_LABELS;
742 const struct casenum_iterator *ip = get_iteration_params (fd);
743 struct comparator *cmptr =
744 comparator_factory (var, fd->dict, target_string, flags);
746 value_init (&val, width);
750 for (i = ip->start (current_row, fd->data);
751 i != ip->end (current_row, fd->data);
752 ip->next (&i, fd->data))
754 datasheet_get_value (fd->data, i, var_get_case_index (var), &val);
756 if ( comparator_compare (cmptr, &val))
764 comparator_destroy (cmptr);
765 value_destroy (&val, width);