2 * Copyright (C) 2006 John Ellis
3 * Copyright (C) 2008 - 2016 The Geeqie Team
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "pan-view-filter.h"
28 #include "ui-fileops.h"
30 #include "ui-tabcomp.h"
32 PanViewFilterUi *pan_filter_ui_new(PanWindow *pw)
34 auto ui = g_new0(PanViewFilterUi, 1);
39 /* Since we're using the GHashTable as a HashSet (in which key and value pointers
40 * are always identical), specifying key _and_ value destructor callbacks will
41 * cause a double-free.
45 ui->filter_mode_model = gtk_list_store_new(3, G_TYPE_INT, G_TYPE_STRING, G_TYPE_STRING);
46 gtk_list_store_append(ui->filter_mode_model, &iter);
47 gtk_list_store_set(ui->filter_mode_model, &iter,
48 0, PAN_VIEW_FILTER_REQUIRE, 1, _("Require"), 2, _("R"), -1);
49 gtk_list_store_append(ui->filter_mode_model, &iter);
50 gtk_list_store_set(ui->filter_mode_model, &iter,
51 0, PAN_VIEW_FILTER_EXCLUDE, 1, _("Exclude"), 2, _("E"), -1);
52 gtk_list_store_append(ui->filter_mode_model, &iter);
53 gtk_list_store_set(ui->filter_mode_model, &iter,
54 0, PAN_VIEW_FILTER_INCLUDE, 1, _("Include"), 2, _("I"), -1);
55 gtk_list_store_append(ui->filter_mode_model, &iter);
56 gtk_list_store_set(ui->filter_mode_model, &iter,
57 0, PAN_VIEW_FILTER_GROUP, 1, _("Group"), 2, _("G"), -1);
59 ui->filter_mode_combo = gtk_combo_box_new_with_model(GTK_TREE_MODEL(ui->filter_mode_model));
60 gtk_widget_set_focus_on_click(ui->filter_mode_combo, FALSE);
61 gtk_combo_box_set_active(GTK_COMBO_BOX(ui->filter_mode_combo), 0);
63 GtkCellRenderer *render = gtk_cell_renderer_text_new();
64 gtk_cell_layout_pack_start(GTK_CELL_LAYOUT(ui->filter_mode_combo), render, TRUE);
65 gtk_cell_layout_set_attributes(GTK_CELL_LAYOUT(ui->filter_mode_combo), render, "text", 1, NULL);
68 // Build the actual filter UI.
69 ui->filter_box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, PREF_PAD_SPACE);
70 pref_spacer(ui->filter_box, 0);
71 pref_label_new(ui->filter_box, _("Keyword Filter:"));
73 gq_gtk_box_pack_start(GTK_BOX(ui->filter_box), ui->filter_mode_combo, FALSE, FALSE, 0);
74 gtk_widget_show(ui->filter_mode_combo);
76 hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, PREF_PAD_SPACE);
77 gq_gtk_box_pack_start(GTK_BOX(ui->filter_box), hbox, TRUE, TRUE, 0);
78 gtk_widget_show(hbox);
80 combo = tab_completion_new_with_history(&ui->filter_entry, "", "pan_view_filter", -1,
81 pan_filter_activate_cb, pw);
82 gq_gtk_box_pack_start(GTK_BOX(hbox), combo, TRUE, TRUE, 0);
83 gtk_widget_show(combo);
85 ui->filter_label = gtk_label_new("");/** @todo (xsdg): Figure out whether it's useful to keep this label around. */
87 ui->filter_kw_hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, PREF_PAD_SPACE);
88 gq_gtk_box_pack_start(GTK_BOX(hbox), ui->filter_kw_hbox, TRUE, TRUE, 0);
89 gtk_widget_show(ui->filter_kw_hbox);
91 // Build the spin-button to show/hide the filter UI.
92 ui->filter_button = gtk_toggle_button_new();
93 gtk_button_set_relief(GTK_BUTTON(ui->filter_button), GTK_RELIEF_NONE);
94 gtk_widget_set_focus_on_click(ui->filter_button, FALSE);
95 hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, PREF_PAD_GAP);
96 gq_gtk_container_add(GTK_WIDGET(ui->filter_button), hbox);
97 gtk_widget_show(hbox);
98 ui->filter_button_arrow = gtk_image_new_from_icon_name(GQ_ICON_PAN_UP, GTK_ICON_SIZE_BUTTON);
99 gq_gtk_box_pack_start(GTK_BOX(hbox), ui->filter_button_arrow, FALSE, FALSE, 0);
100 gtk_widget_show(ui->filter_button_arrow);
101 pref_label_new(hbox, _("Filter"));
103 g_signal_connect(G_OBJECT(ui->filter_button), "clicked",
104 G_CALLBACK(pan_filter_toggle_cb), pw);
106 // Add check buttons for filtering by image class
107 for (i = 0; i < FILE_FORMAT_CLASSES; i++)
109 ui->filter_check_buttons[i] = gtk_check_button_new_with_label(_(format_class_list[i]));
110 gq_gtk_box_pack_start(GTK_BOX(ui->filter_box), ui->filter_check_buttons[i], FALSE, FALSE, 0);
111 gtk_widget_show(ui->filter_check_buttons[i]);
114 gtk_toggle_button_set_active(reinterpret_cast<GtkToggleButton *>(ui->filter_check_buttons[FORMAT_CLASS_IMAGE]), TRUE);
115 gtk_toggle_button_set_active(reinterpret_cast<GtkToggleButton *>(ui->filter_check_buttons[FORMAT_CLASS_RAWIMAGE]), TRUE);
116 gtk_toggle_button_set_active(reinterpret_cast<GtkToggleButton *>(ui->filter_check_buttons[FORMAT_CLASS_VIDEO]), TRUE);
117 ui->filter_classes = (1 << FORMAT_CLASS_IMAGE) | (1 << FORMAT_CLASS_RAWIMAGE) | (1 << FORMAT_CLASS_VIDEO);
119 // Connecting the signal before setting the state causes segfault as pw is not yet prepared
120 for (i = 0; i < FILE_FORMAT_CLASSES; i++)
121 g_signal_connect((GtkToggleButton *)(ui->filter_check_buttons[i]), "toggled", G_CALLBACK(pan_filter_toggle_button_cb), pw);
126 void pan_filter_ui_destroy(PanViewFilterUi **ui_ptr)
128 if (ui_ptr == nullptr || *ui_ptr == nullptr) return;
134 static void pan_filter_status(PanWindow *pw, const gchar *text)
136 gtk_label_set_text(GTK_LABEL(pw->filter_ui->filter_label), (text) ? text : "");
139 static void pan_filter_kw_button_cb(GtkButton *widget, gpointer data)
141 auto cb_state = static_cast<PanFilterCallbackState *>(data);
142 PanWindow *pw = cb_state->pw;
143 PanViewFilterUi *ui = pw->filter_ui;
145 /** @todo (xsdg): Fix filter element pointed object memory leak. */
146 ui->filter_elements = g_list_delete_link(ui->filter_elements, cb_state->filter_element);
147 g_object_unref(GTK_WIDGET(widget));
150 pan_filter_status(pw, _("Removed keyword…"));
151 pan_layout_update(pw);
154 void pan_filter_activate_cb(const gchar *text, gpointer data)
156 GtkWidget *kw_button;
157 auto pw = static_cast<PanWindow *>(data);
158 PanViewFilterUi *ui = pw->filter_ui;
163 // Get all relevant state and reset UI.
164 gtk_combo_box_get_active_iter(GTK_COMBO_BOX(ui->filter_mode_combo), &iter);
165 gq_gtk_entry_set_text(GTK_ENTRY(ui->filter_entry), "");
166 tab_completion_append_to_history(ui->filter_entry, text);
168 // Add new filter element.
169 auto element = g_new0(PanViewFilterElement, 1);
170 gtk_tree_model_get(GTK_TREE_MODEL(ui->filter_mode_model), &iter, 0, &element->mode, -1);
171 element->keyword = g_strdup(text);
172 if (g_strcmp0(text, g_regex_escape_string(text, -1)))
174 // It's an actual regex, so compile
175 element->kw_regex = g_regex_new(text, static_cast<GRegexCompileFlags>(G_REGEX_ANCHORED | G_REGEX_OPTIMIZE), G_REGEX_MATCH_ANCHORED, nullptr);
177 ui->filter_elements = g_list_append(ui->filter_elements, element);
179 // Get the short version of the mode value.
181 gtk_tree_model_get(GTK_TREE_MODEL(ui->filter_mode_model), &iter, 2, &short_mode, -1);
183 // Create the button.
184 /** @todo (xsdg): Use MVC so that the button list is an actual representation of the GList */
185 gchar *label = g_strdup_printf("(%s) %s", short_mode, text);
186 kw_button = gtk_button_new_with_label(label);
187 g_clear_pointer(&label, g_free);
189 gq_gtk_box_pack_start(GTK_BOX(ui->filter_kw_hbox), kw_button, FALSE, FALSE, 0);
190 gtk_widget_show(kw_button);
192 auto cb_state = g_new0(PanFilterCallbackState, 1);
194 cb_state->filter_element = g_list_last(ui->filter_elements);
196 g_signal_connect(G_OBJECT(kw_button), "clicked",
197 G_CALLBACK(pan_filter_kw_button_cb), cb_state);
199 pan_layout_update(pw);
202 #pragma GCC diagnostic push
203 #pragma GCC diagnostic ignored "-Wunused-function"
204 void pan_filter_activate_unused(PanWindow *pw)
208 text = g_strdup(gq_gtk_entry_get_text(GTK_ENTRY(pw->filter_ui->filter_entry)));
209 pan_filter_activate_cb(text, pw);
212 #pragma GCC diagnostic pop
214 void pan_filter_toggle_cb(GtkWidget *button, gpointer data)
216 auto pw = static_cast<PanWindow *>(data);
217 PanViewFilterUi *ui = pw->filter_ui;
221 visible = gtk_widget_get_visible(ui->filter_box);
222 if (gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(button)) == visible) return;
226 gtk_widget_hide(ui->filter_box);
228 parent = gtk_widget_get_parent(ui->filter_button_arrow);
230 g_object_unref(ui->filter_button_arrow);
231 ui->filter_button_arrow = gtk_image_new_from_icon_name(GQ_ICON_PAN_UP, GTK_ICON_SIZE_BUTTON);
233 gq_gtk_box_pack_start(GTK_BOX(parent), ui->filter_button_arrow, FALSE, FALSE, 0);
234 gtk_box_reorder_child(GTK_BOX(parent), ui->filter_button_arrow, 0);
236 gtk_widget_show(ui->filter_button_arrow);
240 gtk_widget_show(ui->filter_box);
242 parent = gtk_widget_get_parent(ui->filter_button_arrow);
244 g_object_unref(ui->filter_button_arrow);
245 ui->filter_button_arrow = gtk_image_new_from_icon_name(GQ_ICON_PAN_DOWN, GTK_ICON_SIZE_BUTTON);
247 gq_gtk_box_pack_start(GTK_BOX(parent), ui->filter_button_arrow, FALSE, FALSE, 0);
248 gtk_box_reorder_child(GTK_BOX(parent), ui->filter_button_arrow, 0);
250 gtk_widget_show(ui->filter_button_arrow);
251 gtk_widget_grab_focus(ui->filter_entry);
255 #pragma GCC diagnostic push
256 #pragma GCC diagnostic ignored "-Wunused-function"
257 void pan_filter_toggle_visible_unused(PanWindow *pw, gboolean enable)
259 PanViewFilterUi *ui = pw->filter_ui;
264 if (gtk_widget_get_visible(ui->filter_box))
266 gtk_widget_grab_focus(ui->filter_entry);
270 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(ui->filter_button), TRUE);
275 if (gtk_widget_get_visible(ui->filter_entry))
277 if (gtk_widget_has_focus(ui->filter_entry))
279 gtk_widget_grab_focus(GTK_WIDGET(pw->imd->widget));
281 gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(ui->filter_button), FALSE);
285 #pragma GCC diagnostic pop
287 void pan_filter_toggle_button_cb(GtkWidget *, gpointer data)
289 auto pw = static_cast<PanWindow *>(data);
290 PanViewFilterUi *ui = pw->filter_ui;
292 gint old_classes = ui->filter_classes;
293 ui->filter_classes = 0;
295 for (gint i = 0; i < FILE_FORMAT_CLASSES; i++)
297 ui->filter_classes |= gtk_toggle_button_get_active(reinterpret_cast<GtkToggleButton *>(ui->filter_check_buttons[i])) ? 1 << i : 0;
300 if (ui->filter_classes != old_classes)
301 pan_layout_update(pw);
304 static gboolean pan_view_list_contains_kw_pattern(GList *haystack, PanViewFilterElement *filter, gchar **found_kw)
306 if (filter->kw_regex)
308 // regex compile succeeded; attempt regex match.
309 GList *work = g_list_first(haystack);
312 auto keyword = static_cast<gchar *>(work->data);
314 if (g_regex_match(filter->kw_regex, keyword, static_cast<GRegexMatchFlags>(0), nullptr))
316 if (found_kw) *found_kw = keyword;
323 // regex compile failed; fall back to exact string match.
324 GList *found_elem = g_list_find_custom(haystack, filter->keyword, reinterpret_cast<GCompareFunc>(g_strcmp0));
325 if (found_elem && found_kw) *found_kw = static_cast<gchar *>(found_elem->data);
329 gboolean pan_filter_fd_list(GList **fd_list, GList *filter_elements, gint filter_classes)
332 gboolean modified = FALSE;
333 GHashTable *seen_kw_table = nullptr;
335 if (!fd_list || !*fd_list) return modified;
337 // seen_kw_table is only valid in this scope, so don't take ownership of any strings.
339 seen_kw_table = g_hash_table_new_full(g_str_hash, g_str_equal, nullptr, nullptr);
344 auto fd = static_cast<FileData *>(work->data);
345 GList *last_work = work;
348 gboolean should_reject = FALSE;
349 gchar *group_kw = nullptr;
351 if (!((1 << fd -> format_class) & filter_classes))
353 should_reject = TRUE;
355 else if (filter_elements)
357 /** @todo (xsdg): OPTIMIZATION Do the search inside of metadata.cc to avoid a bunch of string list copies. */
358 GList *img_keywords = metadata_read_list(fd, KEYWORD_KEY, METADATA_PLAIN);
360 /** @todo (xsdg): OPTIMIZATION Determine a heuristic for when to linear-search the keywords list, and when to build a hash table for the image's keywords. */
361 GList *filter_element = filter_elements;
363 while (filter_element)
365 auto filter = static_cast<PanViewFilterElement *>(filter_element->data);
366 filter_element = filter_element->next;
367 gchar *found_kw = nullptr;
368 gboolean has_kw = pan_view_list_contains_kw_pattern(img_keywords, filter, &found_kw);
370 switch (filter->mode)
372 case PAN_VIEW_FILTER_REQUIRE:
373 should_reject |= !has_kw;
375 case PAN_VIEW_FILTER_EXCLUDE:
376 should_reject |= has_kw;
378 case PAN_VIEW_FILTER_INCLUDE:
379 if (has_kw) should_reject = FALSE;
381 case PAN_VIEW_FILTER_GROUP:
384 if (g_hash_table_contains(seen_kw_table, found_kw))
386 should_reject = TRUE;
388 else if (group_kw == nullptr)
396 g_list_free_full(img_keywords, g_free);
397 if (!should_reject && group_kw != nullptr) g_hash_table_add(seen_kw_table, group_kw);
398 group_kw = nullptr; // group_kw references an item from img_keywords.
403 *fd_list = g_list_delete_link(*fd_list, last_work);
409 g_hash_table_destroy(seen_kw_table);