filter.c

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2011 Henrik Andersson.
    Copyright (C) 2011, 2013 johannes hanika.
    Copyright (C) 2011 Robert Bieber.
    Copyright (C) 2011-2018 Tobias Ellinghaus.
    Copyright (C) 2012-2013 José Carlos García Sogo.
    Copyright (C) 2012 marcel.
    Copyright (C) 2012 Mika Boström.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2012 Simon Spannagel.
    Copyright (C) 2013 Benjamin Cahill.
    Copyright (C) 2013-2014, 2016 Roman Lebedev.
    Copyright (C) 2015 JohnnyRun.
    Copyright (C) 2016, 2019-2022 Aldric Renaudin.
    Copyright (C) 2017 Dan Torop.
    Copyright (C) 2018 Mario Lueder.
    Copyright (C) 2018-2020, 2022 Pascal Obry.
    Copyright (C) 2018 Sam Smith.
    Copyright (C) 2018 Simon Legner.
    Copyright (C) 2019, 2022-2023, 2025 Aurélien PIERRE.
    Copyright (C) 2019, 2021 Bill Ferguson.
    Copyright (C) 2020 Chris Elston.
    Copyright (C) 2020 Hubert Kowalski.
    Copyright (C) 2020 jpverrue.
    Copyright (C) 2020-2022 Philippe Weyland.
    Copyright (C) 2021 Davide.
    Copyright (C) 2021-2022 Diederik Ter Rahe.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2022 Nicolas Auffray.
    Copyright (C) 2022 Victor Forsiuk.
    Copyright (C) 2023 Luca Zulberti.
    
    darktable is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    
    darktable is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#include "common/collection.h"
#include "metadata/tags.h"
#include "common/selection.h"
#include "system/mem_alloc.h"
#include "common/times.h"
#include "common/module_versioning.h"
#include "control/signal.h"
#include "control/control.h"
#include "develop/develop.h"
 
#include "gui/application.h"
#include "widgets/accelerators.h"
#include "widgets/button.h"
#include "libs/lib.h"
#include "libs/lib_api.h"
#include "widgets/bauhaus.h"
#include "widgets/popup.h"
#include "widgets/widget_style.h"
#include "widgets/togglebutton.h"
 
DT_MODULE(1)
 
typedef struct dt_lib_tool_filter_t
{
  GtkWidget *stars[8];
  GtkWidget *comparator;
  GtkWidget *sort;
  GtkWidget *reverse;
  GtkWidget *text;
  GtkWidget *colors[6];
  GtkWidget *culling;
  GtkWidget *refresh;
  GtkWidget *altered;
  GtkWidget *unaltered;
  GtkWidget *menu;
  int time_out;
  double last_key_time;
} dt_lib_tool_filter_t;
 
/* callback for sort combobox change */
static void _lib_filter_sort_combobox_changed(GtkWidget *widget, gpointer user_data);
/* callback for reverse sort check button change */
static void _lib_filter_reverse_button_changed(GtkDarktableToggleButton *widget, gpointer user_data);
/* updates the query and redraws the view */
static void _lib_filter_update_query(dt_lib_module_t *self, dt_collection_properties_t changed_property);
 
/* save the images order if the first collect filter is on tag*/
static void _lib_filter_set_tag_order(dt_lib_module_t *self);
/* images order change from outside */
static void _lib_filter_images_order_change(gpointer instance, int order, dt_lib_module_t *self);
 
static gboolean _show_popover_menu(dt_lib_module_t *self, GtkWidget *w);
 
const dt_collection_sort_t items[] =
{
  DT_COLLECTION_SORT_FILENAME,
  DT_COLLECTION_SORT_DATETIME,
  DT_COLLECTION_SORT_IMPORT_TIMESTAMP,
  DT_COLLECTION_SORT_CHANGE_TIMESTAMP,
  DT_COLLECTION_SORT_EXPORT_TIMESTAMP,
  DT_COLLECTION_SORT_PRINT_TIMESTAMP,
  DT_COLLECTION_SORT_RATING,
  DT_COLLECTION_SORT_ID,
  DT_COLLECTION_SORT_COLOR,
  DT_COLLECTION_SORT_GROUP,
  DT_COLLECTION_SORT_PATH,
  DT_COLLECTION_SORT_TITLE,
};
#define NB_ITEMS (sizeof(items) / sizeof(dt_collection_sort_t))
 
static const char *_sort_names[]
  = { N_("filename"),
      N_("captured"),
      N_("imported"),
      N_("modified"),
      N_("exported"),
      N_("printed"),
      N_("rating"),
      N_("id"),
      N_("color label"),
      N_("group"),
      N_("full path"),
      N_("title"),
      NULL };
 
static int _filter_get_items(const dt_collection_sort_t sort)
{
  for(int i = 0; i < NB_ITEMS; i++)
  {
    if(sort == items[i])
    return i;
  }
  return 0;
}
 
const char *name(struct dt_lib_module_t *self)
{
  return _("filter");
}
 
const char **views(dt_lib_module_t *self)
{
  static const char *v[] = {"lighttable", NULL};
  return v;
}
 
uint32_t container(dt_lib_module_t *self)
{
  return DT_UI_CONTAINER_PANEL_TOP_SECOND_ROW;
}
 
int expandable(dt_lib_module_t *self)
{
  return 0;
}
 
int position()
{
  return 2001;
}
 
static void _set_widget_dimmed(GtkWidget *widget, const gboolean dimmed)
{
  if(dimmed) dt_gui_add_class(widget, "dt_dimmed");
  else dt_gui_remove_class(widget, "dt_dimmed");
  gtk_widget_queue_draw(GTK_WIDGET(widget));
}
 
static char *_encode_text_filter(const char *entry)
{
  // by default adds start and end wildcard
  // " removes the corresponding wildcard
  char start[2] = {0};
  char *text = NULL;
  char *p = (char *)entry;
  if(strlen(entry) > 1 && !(entry[0] == '"' && entry[1] == '"'))
  {
    if(entry[0] == '"')
      p++;
    else if(entry[0])
      start[0] = '%';
    if(entry[strlen(entry) - 1] == '"')
    {
      text = g_strconcat(start, (char *)p, NULL);
      text[strlen(text) - 1] = '\0';
    }
    else if(entry[0])
      text = g_strconcat(start, (char *)p, "%", NULL);
  }
  return text;
}
 
static char *_decode_text_filter(const char *text)
{
  // revert the encoded filter for display
  char start[2] = {0};
  char *text1 = g_strdup(text);
  char *p = text1;
  char *text2;
  if(text1[0])
  {
    if(text1[0] == '%')
      p++;
    else
      start[0] = '\"';
    if(strlen(text1) > 1 && text1[strlen(text1) - 1] == '%')
    {
      text1[strlen(text1) - 1] = '\0';
      text2 = g_strconcat(start, (char *)p, NULL);
    }
    else
      text2 = g_strconcat(start, (char *)p, "\"", NULL);
    dt_free(text1);
    return text2;
  }
  else return text1;
}
 
static gboolean _text_entry_changed_wait(gpointer user_data)
{
  dt_lib_module_t *self = (dt_lib_module_t *)user_data;
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  if(d->time_out)
  {
    d->time_out--;
    double clock = dt_get_wtime();
    if(clock - d->last_key_time >= 0.4)
    {
      d->time_out = 1; // force the query execution
      d->last_key_time = clock;
    }
 
    if(d->time_out == 1)
    { // tell we are busy
      _set_widget_dimmed(d->text, TRUE);
    }
    else if(!d->time_out)
    {
      char *text = _encode_text_filter(gtk_entry_get_text(GTK_ENTRY(d->text)));
 
      // avoids activating twice the same query
      if(g_strcmp0(dt_collection_get_text_filter(dt_collection_get_global()), text))
      {
        dt_collection_set_text_filter(dt_collection_get_global(), text);
        _lib_filter_update_query(self, DT_COLLECTION_PROP_SORT);
      }
      else dt_free(text);
      _set_widget_dimmed(d->text, FALSE);
      return FALSE;
    }
  }
  return TRUE;
}
 
static void _launch_text_query(dt_lib_module_t *self)
{
  // two timeouts 1) 0.4 sec after the last key, 2) 1.5 sec of successive keys
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  d->last_key_time = dt_get_wtime();
  if(!d->time_out)
  {
    d->time_out = 15;
    g_timeout_add(100, _text_entry_changed_wait, self);
  }
}
 
static void _text_entry_changed(GtkEntry *entry, dt_lib_module_t *self)
{
  _launch_text_query(self);
}
 
static void _reset_text_filter(dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  dt_collection_set_text_filter(dt_collection_get_global(), strdup(""));
  gtk_entry_set_text(GTK_ENTRY(d->text), "");
}
 
static void _reset_text_entry(GtkButton *button, dt_lib_module_t *self)
{
  _reset_text_filter(self);
  dt_collection_update_query(dt_collection_get_global(), DT_COLLECTION_CHANGE_RELOAD, DT_COLLECTION_PROP_SORT, NULL);
}
 
gboolean _focus_search_action(GtkAccelGroup *accel_group, GObject *accelerable, guint keyval,
                              GdkModifierType modifier, gpointer data)
{
  dt_lib_module_t *self = (dt_lib_module_t *)data;
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  gtk_widget_grab_focus(GTK_WIDGET(d->text));
  return TRUE;
}
 
const dt_collection_filter_flag_t colors[6] =
{
  COLLECTION_FILTER_WHITE,
  COLLECTION_FILTER_RED,
  COLLECTION_FILTER_YELLOW,
  COLLECTION_FILTER_GREEN,
  COLLECTION_FILTER_BLUE,
  COLLECTION_FILTER_MAGENTA,
};
 
static void _dtgtk_button_set_active(GtkWidget *w, gboolean active)
{
  // shitty design: the active rejected state is signaled as a right orientation...
  if(active)
    DTGTK_BUTTON(w)->icon_flags |= CPF_DIRECTION_RIGHT;
  else
    DTGTK_BUTTON(w)->icon_flags &= ~CPF_DIRECTION_RIGHT;
 
  dtgtk_button_set_active(DTGTK_BUTTON(DTGTK_BUTTON(w)), active);
  gtk_widget_queue_draw(w);
}
 
 
static void _update_colors_filter(dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  dt_collection_filter_flag_t flags = dt_collection_get_filter_flags(dt_collection_get_global());
  for(int i = 0; i <= DT_COLORLABELS_LAST; i++)
    _dtgtk_button_set_active(d->colors[i], flags & colors[i]);
}
 
static gboolean _colorlabel_clicked(GtkWidget *w, GdkEventButton *e, dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
 
  if(e->button == 3)
  {
    _show_popover_menu(self, w);
    return TRUE;
  }
 
  dt_collection_filter_flag_t flags = dt_collection_get_filter_flags(dt_collection_get_global());
 
  // Toggle state
  dtgtk_button_set_active(DTGTK_BUTTON(w), !dtgtk_button_get_active(DTGTK_BUTTON(w)));
 
  // Update collection flags
  for(int i = 0; i <= DT_COLORLABELS_LAST; i++)
  {
    if(dtgtk_button_get_active(DTGTK_BUTTON(d->colors[i])))
      flags |= colors[i];
    else
      flags &= ~colors[i];
  }
 
  dt_collection_set_filter_flags(dt_collection_get_global(), flags);
  _update_colors_filter(self);
  _lib_filter_update_query(self, DT_COLLECTION_PROP_COLORLABEL);
  return TRUE;
}
 
static void _update_altered_filters(dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  dt_collection_filter_flag_t flags = dt_collection_get_filter_flags(dt_collection_get_global());
  _dtgtk_button_set_active(d->altered, flags & COLLECTION_FILTER_ALTERED);
  _dtgtk_button_set_active(d->unaltered, flags & COLLECTION_FILTER_UNALTERED);
}
 
 
static gboolean _altered_clicked(GtkWidget *w, GdkEventButton *e, dt_lib_module_t *self)
{
  if(e->button == 3)
  {
    _show_popover_menu(self, w);
    return TRUE;
  }
 
  dt_collection_filter_flag_t flags = dt_collection_get_filter_flags(dt_collection_get_global());
 
  // Toggle state
  dtgtk_button_set_active(DTGTK_BUTTON(w), !dtgtk_button_get_active(DTGTK_BUTTON(w)));
 
  // Update collection flags
  if(dtgtk_button_get_active(DTGTK_BUTTON(w)))
    flags |= COLLECTION_FILTER_ALTERED;
  else
    flags &= ~COLLECTION_FILTER_ALTERED;
 
  dt_collection_set_filter_flags(dt_collection_get_global(), flags);
  _update_altered_filters(self);
  _lib_filter_update_query(self, DT_COLLECTION_PROP_COLORLABEL);
  return TRUE;
}
 
static gboolean _unaltered_clicked(GtkWidget *w, GdkEventButton *e, dt_lib_module_t *self)
{
  if(e->button == 3)
  {
    _show_popover_menu(self, w);
    return TRUE;
  }
 
  dt_collection_filter_flag_t flags = dt_collection_get_filter_flags(dt_collection_get_global());
 
  // Toggle state
  dtgtk_button_set_active(DTGTK_BUTTON(w), !dtgtk_button_get_active(DTGTK_BUTTON(w)));
 
  // Update collection flags
  if(dtgtk_button_get_active(DTGTK_BUTTON(w)))
    flags |= COLLECTION_FILTER_UNALTERED;
  else
    flags &= ~COLLECTION_FILTER_UNALTERED;
 
  dt_collection_set_filter_flags(dt_collection_get_global(), flags);
  _update_altered_filters(self);
  _lib_filter_update_query(self, DT_COLLECTION_PROP_COLORLABEL);
  return TRUE;
}
 
static void _culling_mode(GtkWidget *widget, gpointer data)
{
  dt_gui_get_global()->culling_mode = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
 
  // If we are exiting culling mode, we need to pop the selection before resetting the thumbtable collection
  if(!dt_gui_get_global()->culling_mode) dt_culling_mode_to_selection();
 
  // Anchor the re-scrollings to the right image
  const int32_t imgid = dt_selection_get_first_id(dt_selection_get_global());
  dt_control_set_mouse_over_id(imgid);
  dt_control_set_keyboard_over_id(imgid);
 
  // Force-rebuild the whole thumbtable on the next collection update
  dt_thumbtable_reset_collection(dt_gui_get_ui()->thumbtable_lighttable);
 
  dt_collection_update_query(dt_collection_get_global(), DT_COLLECTION_CHANGE_RELOAD, DT_COLLECTION_PROP_UNDEF, NULL);
  DT_DEBUG_CONTROL_SIGNAL_RAISE(dt_control_signal_get_global(), DT_SIGNAL_SELECTION_CHANGED);
}
 
static void _refresh_collection_callback(GtkButton *button, gpointer user_data)
{
  dt_collection_update_query(dt_collection_get_global(), DT_COLLECTION_CHANGE_RELOAD, DT_COLLECTION_PROP_UNDEF, NULL);
}
 
void _widget_align_left(GtkWidget *widget)
{
  gtk_widget_set_halign(widget, GTK_ALIGN_FILL);
  gtk_widget_set_hexpand(widget, TRUE);
 
  gtk_widget_set_valign(widget, GTK_ALIGN_CENTER);
  gtk_widget_set_vexpand(widget, FALSE);
}
 
const dt_collection_filter_flag_t ratings[7] =
  {
    COLLECTION_FILTER_0_STAR,
    COLLECTION_FILTER_REJECTED,
    COLLECTION_FILTER_1_STAR,
    COLLECTION_FILTER_2_STAR,
    COLLECTION_FILTER_3_STAR,
    COLLECTION_FILTER_4_STAR,
    COLLECTION_FILTER_5_STAR };
 
 
static void _update_rating_filter(dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  dt_collection_filter_flag_t flags = dt_collection_get_filter_flags(dt_collection_get_global());
 
  // Update GUI button state
  for(int i = 0; i < 7; i++)
  {
    gboolean active = flags & ratings[i];
    if(i != 1)
    {
      // fill stars if active
      if(active)
        DTGTK_BUTTON(d->stars[i])->icon_data = &dt_bauhaus_get_global()->color_fg;
      else
        DTGTK_BUTTON(d->stars[i])->icon_data = NULL;
    }
 
    _dtgtk_button_set_active(d->stars[i], active);
  }
}
 
 
static gboolean _rating_clicked(GtkWidget *w, GdkEventButton *e, dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
 
  if(e->button == 3)
  {
    _show_popover_menu(self, w);
    return TRUE;
  }
 
  dt_collection_filter_flag_t flags = dt_collection_get_filter_flags(dt_collection_get_global());
 
  // Do range selection for >= rating if Shift + Click
  if(dt_modifier_is(e->state, GDK_SHIFT_MASK))
  {
    gboolean include = TRUE;
    for(int i = 6; i > 1; i--)
    {
      dtgtk_button_set_active(DTGTK_BUTTON(d->stars[i]), include);
      if(w == d->stars[i]) include = FALSE;
    }
  }
  else
  {
    // Toggle state for clicked button
    dtgtk_button_set_active(DTGTK_BUTTON(w), !dtgtk_button_get_active(DTGTK_BUTTON(w)));
  }
 
  // Update collection flags
  for(int i = 0; i < 7; i++)
  {
    if(dtgtk_button_get_active(DTGTK_BUTTON(d->stars[i])))
      flags |= ratings[i];
    else
      flags &= ~ratings[i];
  }
 
  dt_collection_set_filter_flags(dt_collection_get_global(), flags);
  _update_rating_filter(self);
  _lib_filter_update_query(self, DT_COLLECTION_PROP_RATING);
  return TRUE;
}
 
 
static void _select_all_callback(GtkWidget *widget, dt_lib_module_t *self)
{
  dt_collection_set_filter_flags(dt_collection_get_global(), COLLECTION_FILTER_ALL);
  _update_rating_filter(self);
  _update_colors_filter(self);
  _update_altered_filters(self);
  _lib_filter_update_query(self, DT_COLLECTION_PROP_UNDEF);
}
 
static void _select_none_callback(GtkWidget *widget, dt_lib_module_t *self)
{
  dt_collection_set_filter_flags(dt_collection_get_global(), COLLECTION_FILTER_NONE);
  _update_rating_filter(self);
  _update_colors_filter(self);
  _update_altered_filters(self);
  _lib_filter_update_query(self, DT_COLLECTION_PROP_UNDEF);
}
 
 
static gboolean _show_popover_menu(dt_lib_module_t *self, GtkWidget *w)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  dt_gui_menu_popup(GTK_MENU(d->menu), w, GDK_GRAVITY_SOUTH, GDK_GRAVITY_NORTH);
  return TRUE;
}
 
static void _insert_section_sep(dt_lib_module_t *self)
{
  GtkWidget *spacer = gtk_separator_new(GTK_ORIENTATION_VERTICAL);
  gtk_box_pack_start(GTK_BOX(self->widget), spacer, FALSE, FALSE, 0);
}
 
static void _insert_subsection_sep(dt_lib_module_t *self)
{
  GtkWidget *spacer = gtk_separator_new(GTK_ORIENTATION_VERTICAL);
  dt_gui_add_class(spacer, "subsection");
  gtk_box_pack_start(GTK_BOX(self->widget), spacer, FALSE, FALSE, 0);
}
 
void gui_init(dt_lib_module_t *self)
{
  /* initialize ui widgets */
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)g_malloc0(sizeof(dt_lib_tool_filter_t));
  self->data = (void *)d;
 
  self->widget = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, DT_GUI_BOX_SPACING);
  _widget_align_left(self->widget);
  dt_gui_add_class(self->widget, "quick_filter_box");
 
  GtkWidget *label;
 
  d->refresh = dtgtk_button_new(dtgtk_cairo_paint_refresh, 0, NULL);
  gtk_widget_set_tooltip_text(d->refresh, _("Refresh the current collection to evict images\n"
                                            "which properties have been changed\n"
                                            "and don't match the current filters anymore."));
  g_signal_connect(G_OBJECT(d->refresh), "clicked", G_CALLBACK(_refresh_collection_callback), NULL);
  gtk_widget_set_name(d->refresh, "quick-filter-reload");
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(d->refresh), FALSE, FALSE, 0);
 
  gchar *path = dt_accels_build_path(_("Lighttable/Actions"), _("Reload current collection"));
  dt_accels_new_widget_shortcut(dt_gui_get_accels(), d->refresh, "activate",
                                dt_gui_get_accels()->lighttable_accels, path, GDK_KEY_r, DT_PRIMARY_MASK,
                                FALSE);
  dt_free(path);
 
  _insert_section_sep(self);
 
  label = gtk_label_new(_("Include"));
  gtk_box_pack_start(GTK_BOX(self->widget), label, FALSE, FALSE, 0);
 
  GtkWidget *hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, DT_GUI_BOX_SPACING);
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(hbox), FALSE, FALSE, 0);
  gtk_widget_set_name(hbox, "quick-filter-ratings");
 
  // star buttons
  for(int k = 0; k < 7; k++)
  {
    if(k == 0)
    {
      d->stars[k] = dtgtk_button_new(dtgtk_cairo_paint_unratestar, k, NULL);
      gtk_widget_set_name(d->stars[k], "no-star-filter");
    }
    else if(k == 1)
    {
      d->stars[k] = dtgtk_button_new(dtgtk_cairo_paint_reject, k, NULL);
      gtk_widget_set_name(d->stars[k], "rejected-filter");
    }
    else
      d->stars[k] = dtgtk_button_new(dtgtk_cairo_paint_star, k, NULL);
 
    dt_gui_add_class(d->stars[k], "star");
    gtk_box_pack_start(GTK_BOX(hbox), GTK_WIDGET(d->stars[k]), FALSE, FALSE, 0);
    g_signal_connect(G_OBJECT(d->stars[k]), "button-press-event", G_CALLBACK(_rating_clicked), self);
 
    if(k == 1)
    {
      GtkWidget *spacer = gtk_separator_new(GTK_ORIENTATION_VERTICAL);
      dt_gui_add_class(spacer, "subsection");
      gtk_box_pack_start(GTK_BOX(hbox), spacer, FALSE, FALSE, 0);
    }
  }
  _update_rating_filter(self);
 
  gtk_widget_set_tooltip_text(d->stars[0], _("Toggle filtering in/out unrated images (0 star)"));
  gtk_widget_set_tooltip_text(d->stars[1], _("Toggle filtering in/out rejected images"));
  gtk_widget_set_tooltip_text(d->stars[2], _("Toggle filtering in/out images rated 1 star"));
  gtk_widget_set_tooltip_text(d->stars[3], _("Toggle filtering in/out images rated 2 stars"));
  gtk_widget_set_tooltip_text(d->stars[4], _("Toggle filtering in/out images rated 3 stars"));
  gtk_widget_set_tooltip_text(d->stars[5], _("Toggle filtering in/out images rated 4 stars"));
  gtk_widget_set_tooltip_text(d->stars[6], _("Toggle filtering in/out images rated 5 stars"));
 
  _insert_subsection_sep(self);
 
  // colorlabels filter
  hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, DT_GUI_BOX_SPACING);
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(hbox), FALSE, FALSE, 0);
  gtk_widget_set_name(hbox, "quickfilters-colors");
 
  const int col[] = { DT_COLORLABELS_LAST,  DT_COLORLABELS_RED,  DT_COLORLABELS_YELLOW,
                      DT_COLORLABELS_GREEN, DT_COLORLABELS_BLUE, DT_COLORLABELS_PURPLE };
 
  for(int k = 0; k < DT_COLORLABELS_LAST + 1; k++)
  {
    d->colors[k] = dtgtk_button_new(dtgtk_cairo_paint_label_sel, col[k], NULL);
    gtk_box_pack_start(GTK_BOX(hbox), GTK_WIDGET(d->colors[k]), FALSE, FALSE, 0);
    g_signal_connect(G_OBJECT(d->colors[k]), "button-press-event", G_CALLBACK(_colorlabel_clicked), self);
  }
  _update_colors_filter(self);
 
  gtk_widget_set_tooltip_text(d->colors[0], _("Toggle filtering in/out images without color label"));
  gtk_widget_set_tooltip_text(d->colors[1], _("Toggle filtering in/out images with red label"));
  gtk_widget_set_tooltip_text(d->colors[2], _("Toggle filtering in/out images with yellow label"));
  gtk_widget_set_tooltip_text(d->colors[3], _("Toggle filtering in/out images with green label"));
  gtk_widget_set_tooltip_text(d->colors[4], _("Toggle filtering in/out images with blue label"));
  gtk_widget_set_tooltip_text(d->colors[5], _("Toggle filtering in/out images with purple label"));
 
  _insert_subsection_sep(self);
 
  // changed filter
  hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, DT_GUI_BOX_SPACING);
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(hbox), FALSE, FALSE, 0);
  gtk_widget_set_name(hbox, "quickfilters-altered");
 
  d->unaltered = dtgtk_button_new(dtgtk_cairo_paint_unaltered, 0, NULL);
  gtk_box_pack_start(GTK_BOX(hbox), GTK_WIDGET(d->unaltered), FALSE, FALSE, 0);
  g_signal_connect(G_OBJECT(d->unaltered), "button-press-event", G_CALLBACK(_unaltered_clicked), self);
  gtk_widget_set_tooltip_text(d->unaltered, _("Toggle filtering in/out unedited images"));
 
  d->altered = dtgtk_button_new(dtgtk_cairo_paint_altered, 0, NULL);
  gtk_box_pack_start(GTK_BOX(hbox), GTK_WIDGET(d->altered), FALSE, FALSE, 0);
  g_signal_connect(G_OBJECT(d->altered), "button-press-event", G_CALLBACK(_altered_clicked), self);
  gtk_widget_set_tooltip_text(d->altered, _("Toggle filtering in/out edited images"));
 
  _update_altered_filters(self);
 
  _insert_subsection_sep(self);
 
  // Culling mode
  d->culling = gtk_toggle_button_new_with_label(_("Restrict to selection"));
  gtk_widget_set_tooltip_text(d->culling, _("Restrict the current view to only selected pictures"));
  g_signal_connect(G_OBJECT(d->culling), "toggled", G_CALLBACK(_culling_mode), (gpointer)self);
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(d->culling), FALSE, FALSE, 0);
  gtk_widget_set_name(d->culling, "quickfilter-culling");
 
  path = dt_accels_build_path(_("Lighttable/Actions"), _("Toggle culling mode"));
  dt_accels_new_widget_shortcut(dt_gui_get_accels(), d->culling, "activate",
                                dt_gui_get_accels()->lighttable_accels, path, GDK_KEY_s, DT_PRIMARY_MASK,
                                FALSE);
  dt_free(path);
 
  _insert_section_sep(self);
 
  label = gtk_label_new(_("Sort by"));
  gtk_box_pack_start(GTK_BOX(self->widget), label, FALSE, FALSE, 0);
 
  /* sort combobox */
  const dt_collection_sort_t sort = dt_collection_get_sort_field(dt_collection_get_global());
 
  d->sort = gtk_combo_box_text_new();
 
  for(int i = 0; i < NB_ITEMS; i++)
    gtk_combo_box_text_append(GTK_COMBO_BOX_TEXT(d->sort), NULL, _(_sort_names[i]));
 
  gtk_combo_box_set_active(GTK_COMBO_BOX(d->sort ), _filter_get_items(sort));
  g_signal_connect(G_OBJECT(d->sort), "changed", G_CALLBACK(_lib_filter_sort_combobox_changed), (gpointer)self);
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(d->sort), FALSE, FALSE, 0);
  gtk_widget_set_name(d->sort, "quick-filter-sort");
 
  /* reverse order checkbutton */
  d->reverse = dtgtk_togglebutton_new(dtgtk_cairo_paint_sortby, CPF_DIRECTION_UP, NULL);
  if(dt_collection_get_global()->params.descending)
    dtgtk_togglebutton_set_paint(DTGTK_TOGGLEBUTTON(d->reverse), dtgtk_cairo_paint_sortby,
                                 CPF_DIRECTION_DOWN, NULL);
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(d->reverse), FALSE, FALSE, 0);
  dt_gui_add_class(d->reverse, "dt_ignore_fg_state");
 
  /* select the last value and connect callback */
  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(d->reverse),
                               dt_collection_get_sort_descending(dt_collection_get_global()));
  g_signal_connect(G_OBJECT(d->reverse), "toggled", G_CALLBACK(_lib_filter_reverse_button_changed),
                   (gpointer)self);
 
  _insert_section_sep(self);
 
  // text filter
  d->text = gtk_search_entry_new();
  dt_accels_disconnect_on_text_input(d->text);
  gtk_widget_set_hexpand(d->text, TRUE);
  dt_gui_add_class(GTK_WIDGET(d->text), "menu-text-entry");
  char *text = _decode_text_filter(dt_collection_get_text_filter(dt_collection_get_global()));
  gtk_entry_set_text(GTK_ENTRY(d->text), text);
  gtk_entry_set_placeholder_text(GTK_ENTRY(d->text), _("Search an image..."));
  dt_free(text);
  g_signal_connect(G_OBJECT(d->text), "search-changed", G_CALLBACK(_text_entry_changed), self);
  g_signal_connect(G_OBJECT(d->text), "stop-search", G_CALLBACK(_reset_text_entry), self);
  gtk_entry_set_width_chars(GTK_ENTRY(d->text), 24);
  gtk_widget_set_tooltip_text(d->text,
          /* xgettext:no-c-format */
                              _("filter by text from images metadata, tags, file path and name"
          /* xgettext:no-c-format */
                                "\n`%' is the wildcard character"
          /* xgettext:no-c-format */
                                "\nby default start and end wildcards are auto-applied"
          /* xgettext:no-c-format */
                                "\nstarting or ending with a double quote disables the corresponding wildcard"
          /* xgettext:no-c-format */
                                "\nis dimmed during the search execution"));
  //dt_gui_add_class(d->text, "dt_transparent_background");
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(d->text), TRUE, TRUE, 0);
  gtk_widget_set_name(d->text, "quickfilter-search-box");
 
  dt_accels_new_lighttable_action(_focus_search_action, self, NULL, N_("Lighttable/Actions"), N_("Search a picture"),
                                  GDK_KEY_f, DT_PRIMARY_MASK, _("Focuses the control"));
 
  _insert_section_sep(self);
 
  DT_DEBUG_CONTROL_SIGNAL_CONNECT(dt_control_signal_get_global(), DT_SIGNAL_IMAGES_ORDER_CHANGE,
                            G_CALLBACK(_lib_filter_images_order_change), self);
 
  // context menu
  d->menu = gtk_menu_new();
 
  GtkWidget *first_entry = gtk_menu_item_new_with_label(_("Select all filters"));
  gtk_menu_shell_append(GTK_MENU_SHELL(d->menu), first_entry);
  g_signal_connect(G_OBJECT(first_entry), "activate", G_CALLBACK(_select_all_callback), self);
  path = dt_accels_build_path(_("Lighttable/Actions"), _("Select all filters"));
  dt_accels_new_widget_shortcut(dt_gui_get_accels(), first_entry, "activate",
                                dt_gui_get_accels()->lighttable_accels, path, 0, 0,
                                FALSE);
  dt_free(path);
 
  GtkWidget *second_entry = gtk_menu_item_new_with_label(_("Deselect all filters"));
  gtk_menu_shell_append(GTK_MENU_SHELL(d->menu), second_entry);
  g_signal_connect(G_OBJECT(second_entry), "activate", G_CALLBACK(_select_none_callback), self);
  path = dt_accels_build_path(_("Lighttable/Actions"), _("Deselect all filters"));
  dt_accels_new_widget_shortcut(dt_gui_get_accels(), second_entry, "activate",
                                dt_gui_get_accels()->lighttable_accels, path, 0, 0,
                                FALSE);
  dt_free(path);
 
  gtk_widget_show_all(d->menu);
}
 
void gui_cleanup(dt_lib_module_t *self)
{
  gchar *path = dt_accels_build_path(_("Lighttable/Actions"), _("Reload current collection"));
  dt_accels_remove_shortcut(dt_gui_get_accels(), path);
  dt_free(path);
 
  path = dt_accels_build_path(_("Lighttable/Actions"), _("Toggle culling mode"));
  dt_accels_remove_shortcut(dt_gui_get_accels(), path);
  dt_free(path);
 
  path = dt_accels_build_path(_("Lighttable/Actions"), _("Select all filters"));
  dt_accels_remove_shortcut(dt_gui_get_accels(), path);
  dt_free(path);
 
  path = dt_accels_build_path(_("Lighttable/Actions"), _("Deselect all filters"));
  dt_accels_remove_shortcut(dt_gui_get_accels(), path);
  dt_free(path);
 
  dt_collection_set_text_filter(dt_collection_get_global(), NULL);
  DT_DEBUG_CONTROL_SIGNAL_DISCONNECT(dt_control_signal_get_global(), G_CALLBACK(_lib_filter_images_order_change), self);
  dt_free(self->data);
}
 
/* save the images order if the first collect filter is on tag*/
static void _lib_filter_set_tag_order(dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  if(dt_collection_get_global()->tagid)
  {
    const uint32_t sort = items[gtk_combo_box_get_active(GTK_COMBO_BOX(d->sort))];
    const gboolean descending = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(d->reverse));
    dt_tag_set_tag_order_by_id(dt_collection_get_global()->tagid, sort, descending);
  }
}
 
static void _lib_filter_images_order_change(gpointer instance, const int order, dt_lib_module_t *self)
{
  dt_lib_tool_filter_t *d = (dt_lib_tool_filter_t *)self->data;
  gtk_combo_box_set_active(GTK_COMBO_BOX(d->sort), _filter_get_items(order & ~DT_COLLECTION_ORDER_FLAG));
  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(d->reverse), order & DT_COLLECTION_ORDER_FLAG);
}
 
static void _lib_filter_reverse_button_changed(GtkDarktableToggleButton *widget, gpointer user_data)
{
  const gboolean reverse = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
 
  if(reverse)
    dtgtk_togglebutton_set_paint(widget, dtgtk_cairo_paint_sortby, CPF_DIRECTION_DOWN, NULL);
  else
    dtgtk_togglebutton_set_paint(widget, dtgtk_cairo_paint_sortby, CPF_DIRECTION_UP, NULL);
  gtk_widget_queue_draw(GTK_WIDGET(widget));
 
  /* update last settings */
  dt_collection_set_sort(dt_collection_get_global(), DT_COLLECTION_SORT_NONE, reverse);
 
  /* save the images order */
  _lib_filter_set_tag_order(user_data);
 
  /* update query and view */
  _lib_filter_update_query(user_data, DT_COLLECTION_PROP_SORT);
}
 
static void _lib_filter_sort_combobox_changed(GtkWidget *widget, gpointer user_data)
{
  /* update the ui last settings */
  dt_collection_set_sort(dt_collection_get_global(), items[gtk_combo_box_get_active(GTK_COMBO_BOX(widget))], -1);
 
  /* save the images order */
  _lib_filter_set_tag_order(user_data);
 
  /* update the query and view */
  _lib_filter_update_query(user_data, DT_COLLECTION_PROP_SORT);
}
 
static void _lib_filter_update_query(dt_lib_module_t *self, dt_collection_properties_t changed_property)
{
  /* sometimes changes */
  dt_collection_set_query_flags(dt_collection_get_global(), COLLECTION_QUERY_FULL);
 
  /* updates query */
  dt_collection_update_query(dt_collection_get_global(), DT_COLLECTION_CHANGE_RELOAD, changed_property, NULL);
}
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on