libs/tools/lighttable.c

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2011, 2013 Henrik Andersson.
    Copyright (C) 2012 Petr Styblo.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2012-2014, 2016-2017 Tobias Ellinghaus.
    Copyright (C) 2013 johannes hanika.
    Copyright (C) 2013 Pascal de Bruijn.
    Copyright (C) 2013-2014, 2016 Roman Lebedev.
    Copyright (C) 2014, 2019-2022 Aldric Renaudin.
    Copyright (C) 2018 Mario Lueder.
    Copyright (C) 2018 Rikard Öxler.
    Copyright (C) 2019, 2022-2023, 2025 Aurélien PIERRE.
    Copyright (C) 2019, 2021 Bill Ferguson.
    Copyright (C) 2019 Edgardo Hoszowski.
    Copyright (C) 2019-2021 Pascal Obry.
    Copyright (C) 2020-2021 Chris Elston.
    Copyright (C) 2021-2022 Diederik Ter Rahe.
    Copyright (C) 2021 Ralf Brown.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2022 Nicolas Auffray.
    
    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 "system/macros.h"
#include "system/mem_alloc.h"
#include "common/module_versioning.h"
#include "control/signal.h"
#include <gdk/gdkkeysyms.h>
 
#include "common/collection.h"
#include "common/conf.h"
#include "gui/dtgtk/thumbtable.h"
#include "gui/actions/menu.h"
 
#include "gui/application.h"
#include "libs/lib.h"
#include "libs/lib_api.h"
#include "widgets/widget_settings.h"
#include "widgets/accelerators.h"
#include "widgets/widget_style.h"
 
DT_MODULE(1)
 
typedef struct dt_lib_tool_lighttable_t
{
  GtkWidget *columns;
  GList *menu_items;
  gulong scroll_handler_id;
} dt_lib_tool_lighttable_t;
 
/* set columns proxy function */
static void _lib_lighttable_set_columns(dt_lib_module_t *self, gint columns);
 
/* columns slider change callback */
static void _lib_lighttable_columns_slider_changed(GtkWidget *widget, gpointer user_data);
 
static void _set_columns(dt_lib_module_t *self, int columns);
 
const char *name(struct dt_lib_module_t *self)
{
  return _("lighttable");
}
 
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 1001;
}
 
gboolean _columns_in_action(GtkAccelGroup *accel_group, GObject *accelerable, guint keyval,
                         GdkModifierType modifier, gpointer data)
{
  dt_lib_module_t *self = (dt_lib_module_t *)data;
  int current_level = dt_conf_get_int("plugins/lighttable/images_in_row");
  int new_level = CLAMP(current_level - 1, 1, 12);
  _lib_lighttable_set_columns(self, new_level);
  dt_conf_set_int("plugins/lighttable/images_in_row_backup", new_level);
  return TRUE;
}
 
gboolean _columns_out_action(GtkAccelGroup *accel_group, GObject *accelerable, guint keyval,
                          GdkModifierType modifier, gpointer data)
{
  dt_lib_module_t *self = (dt_lib_module_t *)data;
  int current_level = dt_conf_get_int("plugins/lighttable/images_in_row");
  int new_level = CLAMP(current_level + 1, 1, 12);
  _lib_lighttable_set_columns(self, new_level);
  dt_conf_set_int("plugins/lighttable/images_in_row_backup", new_level);
  return TRUE;
}
 
static void _dt_collection_changed_callback(gpointer instance, dt_collection_change_t query_change,
                                            dt_collection_properties_t changed_property, gpointer imgs,
                                            const int next, gpointer user_data)
{
  if(IS_NULL_PTR(user_data)) return;
  // DT_COLLECTION_CHANGE_BACKGROUND_SYNC means the signal comes from a passive background sync
  // (e.g. dt_collection_notify_imported(), called once per imported image for the whole duration
  // of an import job) rather than the user navigating: nothing below -- column/zoom adjustments
  // driven by the CURRENT collection's content -- is meaningful to redo on every one of those.
  // Reacting anyway unconditionally reset thumbnail zoom (full thumbnail reload +
  // scroll-to-selection) on every such notification, fighting whatever the user was doing in the
  // grid for the entire duration of the import, whether or not it even touched what was on
  // screen.
  if(query_change == DT_COLLECTION_CHANGE_BACKGROUND_SYNC) return;
  dt_lib_module_t *self = (dt_lib_module_t *)user_data;
 
  if(dt_gui_get_global()->culling_mode)
  {
    int current_level = dt_conf_get_int("plugins/lighttable/images_in_row");
    int num_images = dt_collection_get_count(dt_collection_get_global());
 
    switch(num_images)
    {
      case 1:
      case 2:
      case 3:
      case 4:
      case 5:
        _lib_lighttable_set_columns(self, num_images);
        dt_conf_set_int("plugins/lighttable/images_in_row_backup", current_level);
        break;
      case 6:
        _lib_lighttable_set_columns(self, 3);
        dt_conf_set_int("plugins/lighttable/images_in_row_backup", current_level);
        break;
      case 7:
      case 8:
        _lib_lighttable_set_columns(self, 4);
        dt_conf_set_int("plugins/lighttable/images_in_row_backup", current_level);
        break;
      case 9:
      case 10:
      case 11:
      case 12:
      case 13:
      case 14:
      case 15:
        _lib_lighttable_set_columns(self, 5);
        dt_conf_set_int("plugins/lighttable/images_in_row_backup", current_level);
        break;
      default:
        if(dt_conf_key_exists("plugins/lighttable/images_in_row_backup"))
          _lib_lighttable_set_columns(self, dt_conf_get_int("plugins/lighttable/images_in_row_backup"));
    }
  }
  else if(dt_conf_key_exists("plugins/lighttable/images_in_row_backup"))
  {
    _lib_lighttable_set_columns(self, dt_conf_get_int("plugins/lighttable/images_in_row_backup"));
  }
 
  // Reset zoom
  dt_thumbtable_set_zoom(dt_gui_get_ui()->thumbtable_lighttable, 0);
}
 
static gboolean _zoom_combobox_changed(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  const int level = GPOINTER_TO_INT(get_custom_data(GTK_WIDGET(user_data)));
  dt_thumbtable_set_zoom(dt_gui_get_ui()->thumbtable_lighttable, level);
  return TRUE;
}
 
static gboolean _zoom_checked(GtkWidget *widget)
{
  const int level = GPOINTER_TO_INT(get_custom_data(widget));
  return dt_thumbtable_get_zoom(dt_gui_get_ui()->thumbtable_lighttable) == level;
}
 
 
// Ctrl + Scroll changes the number of columns
static gboolean _thumbtable_scroll(GtkWidget *widget, GdkEventScroll *event, gpointer data)
{
  dt_lib_module_t *self = (dt_lib_module_t *)data;
 
  if(dt_modifier_is(event->state, DT_PRIMARY_MASK))
  {
    int scroll_y;
    dt_gui_get_scroll_unit_deltas(event, NULL, &scroll_y);
 
    int current_level = dt_conf_get_int("plugins/lighttable/images_in_row");
    int new_level = CLAMP(current_level + CLAMP(scroll_y, -1, 1), 1, 12);
 
    _lib_lighttable_set_columns(self, new_level);
    dt_conf_set_int("plugins/lighttable/images_in_row_backup", new_level);
    return TRUE;
  }
  return FALSE;
}
 
static gboolean _focus_toggle_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  dt_thumbtable_t *table = dt_gui_get_ui()->thumbtable_lighttable;
  gboolean state = dt_thumbtable_get_focus_regions(table);
  dt_thumbtable_set_focus_regions(table, !state);
  return TRUE;
}
 
gboolean _focus_checked(GtkWidget *widget)
{
  dt_thumbtable_t *table = dt_gui_get_ui()->thumbtable_lighttable;
  return dt_thumbtable_get_focus_regions(table);
}
 
static gboolean focus_peaking_callback(GtkAccelGroup *group, GObject *acceleratable, guint keyval, GdkModifierType mods, gpointer user_data)
{
  dt_thumbtable_t *table = dt_gui_get_ui()->thumbtable_lighttable;
  gboolean focus_peaking = dt_thumbtable_get_focus_peaking(table);
  dt_thumbtable_set_focus_peaking(table, !focus_peaking);
  return TRUE;
}
 
static gboolean focus_peaking_checked_callback()
{
  dt_thumbtable_t *table = dt_gui_get_ui()->thumbtable_lighttable;
  return dt_thumbtable_get_focus_peaking(table);
}
 
void append_thumbnails(GtkWidget **menus, GList **lists, const dt_menus_t index, GtkAccelGroup *accel_group)
{
  // Focusing options
  add_generic_sub_menu_entry(menus, lists, _("Overlay focus zones"), index, NULL, _focus_toggle_callback, _focus_checked, NULL,
                             NULL, 0, 0, accel_group);
 
  add_generic_sub_menu_entry(menus, lists, _("Overlay focus peaking"), index, NULL, focus_peaking_callback,
                             focus_peaking_checked_callback, NULL, NULL, GDK_KEY_p,
                             DT_PRIMARY_MASK | GDK_SHIFT_MASK, accel_group);
 
  // Zoom
  add_generic_top_submenu_entry(menus, lists, _("Zoom"), index, accel_group);
  GtkWidget *parent = get_last_widget(lists);
  add_generic_sub_sub_menu_entry(menus, parent, lists, _("Fit"), index, GINT_TO_POINTER(0), _zoom_combobox_changed,
                                 _zoom_checked, NULL, NULL, 0, 0, accel_group);
  add_generic_sub_sub_menu_entry(menus, parent, lists, _("50 %"), index, GINT_TO_POINTER(1), _zoom_combobox_changed,
                                 _zoom_checked, NULL, NULL, 0, 0, accel_group);
  add_generic_sub_sub_menu_entry(menus, parent, lists, _("100 %"), index, GINT_TO_POINTER(2), _zoom_combobox_changed,
                                 _zoom_checked, NULL, NULL, 0, 0, accel_group);
  add_generic_sub_sub_menu_entry(menus, parent, lists, _("200 %"), index, GINT_TO_POINTER(3), _zoom_combobox_changed,
                                 _zoom_checked, NULL, NULL, 0, 0, accel_group);
}
 
void gui_init(dt_lib_module_t *self)
{
  /* initialize ui widgets */
  dt_lib_tool_lighttable_t *d = (dt_lib_tool_lighttable_t *)g_malloc0(sizeof(dt_lib_tool_lighttable_t));
  self->data = (void *)d;
 
  self->widget = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, DT_GUI_BOX_SPACING);
  dt_gui_add_class(self->widget, "lighttable_box");
  gtk_widget_set_halign(self->widget, GTK_ALIGN_END);
  gtk_widget_set_hexpand(self->widget, FALSE);
 
  // Thumbnail menu
  GtkAccelGroup *accel_group = dt_gui_get_accels()->lighttable_accels;
  GtkWidget *menu_bar = gtk_menu_bar_new();
  GtkWidget *menus[1];
  const int index = 0;
  d->menu_items = NULL;
  add_generic_top_menu_entry(menu_bar, menus, &d->menu_items, index, _("_Thumbnails"), accel_group, "Lighttable");
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(menu_bar), FALSE, FALSE, 0);
  append_thumbnails(menus, &d->menu_items, index, accel_group);
 
  // dumb empty flexible spacer at the end
  GtkWidget *spacer = gtk_separator_new(GTK_ORIENTATION_VERTICAL);
  gtk_box_pack_start(GTK_BOX(self->widget), spacer, TRUE, TRUE, 0);
 
  GtkWidget *label = gtk_label_new(C_("quickfilter", "Columns"));
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(label), FALSE, FALSE, 0);
 
  d->columns = gtk_spin_button_new_with_range(1., 12., 1.);
  gtk_box_pack_start(GTK_BOX(self->widget), GTK_WIDGET(d->columns), FALSE, FALSE, 0);
  gtk_spin_button_set_value(GTK_SPIN_BUTTON(d->columns), dt_conf_get_int("plugins/lighttable/images_in_row"));
  dt_accels_disconnect_on_text_input(d->columns);
 
  g_signal_connect(G_OBJECT(d->columns), "value-changed", G_CALLBACK(_lib_lighttable_columns_slider_changed), self);
 
  dt_accels_new_lighttable_action(_columns_in_action, self, NULL, N_("Lighttable/Actions"), N_("Zoom in the thumbtable grid"),
                                  GDK_KEY_plus, DT_PRIMARY_MASK, _("Triggers the action"));
  dt_accels_new_lighttable_action(_columns_out_action, self, NULL, N_("Lighttable/Actions"), N_("Zoom out the thumbtable grid"),
                                  GDK_KEY_minus, DT_PRIMARY_MASK, _("Triggers the action"));
 
  DT_DEBUG_CONTROL_SIGNAL_CONNECT(dt_control_signal_get_global(), DT_SIGNAL_COLLECTION_CHANGED,
                                  G_CALLBACK(_dt_collection_changed_callback), self);
 
  _lib_lighttable_columns_slider_changed(d->columns, self); // the slider defaults to 1 and GTK doesn't
                                                      // fire a value-changed signal when setting
                                                      // it to 1 => empty text box
 
  // Wire a scroll event handler on thumbtable here. This avoids us a proxy
  dt_thumbtable_t *table = dt_gui_get_ui()->thumbtable_lighttable;
  d->scroll_handler_id
      = g_signal_connect(G_OBJECT(table->scroll_window), "scroll-event", G_CALLBACK(_thumbtable_scroll), self);
}
 
void gui_cleanup(dt_lib_module_t *self)
{
  if(IS_NULL_PTR(self->data)) return;
  dt_lib_tool_lighttable_t *d = (dt_lib_tool_lighttable_t *)self->data;
 
  DT_DEBUG_CONTROL_SIGNAL_DISCONNECT(dt_control_signal_get_global(), G_CALLBACK(_dt_collection_changed_callback), self);
 
  if(d->scroll_handler_id > 0)
  {
    dt_thumbtable_t *table = dt_gui_get_ui()->thumbtable_lighttable;
    if(!IS_NULL_PTR(table) && !IS_NULL_PTR(table->scroll_window))
      g_signal_handler_disconnect(G_OBJECT(table->scroll_window), d->scroll_handler_id);
    d->scroll_handler_id = 0;
  }
 
  GList *menu_widgets = NULL;
  for(GList *iter = d->menu_items; iter; iter = g_list_next(iter))
  {
    dt_menu_entry_t *entry = (dt_menu_entry_t *)iter->data;
    if(IS_NULL_PTR(entry) || IS_NULL_PTR(entry->widget) || !GTK_IS_WIDGET(entry->widget)) continue;
    menu_widgets = g_list_prepend(menu_widgets, g_object_ref(entry->widget));
  }
 
  for(GList *iter = menu_widgets; iter; iter = g_list_next(iter))
  {
    GtkWidget *widget = GTK_WIDGET(iter->data);
    if(GTK_IS_WIDGET(widget)) gtk_widget_destroy(widget);
    g_object_unref(widget);
  }
  g_list_free(menu_widgets);
 
  g_list_free(d->menu_items);
  d->menu_items = NULL;
 
  dt_free(self->data);
}
 
static void _set_columns(dt_lib_module_t *self, int columns)
{
  dt_conf_set_int("plugins/lighttable/images_in_row", columns);
  
  // Use the coordinated grid configuration function that properly orders:
  // 1. Grid reconfiguration with new column count
  // 2. Thumbnail updates and resizing
  // 3. Scrolling to active selection
  // This prevents partial updates and ensures synchronization.
  dt_thumbtable_apply_grid_configuration(dt_gui_get_ui()->thumbtable_lighttable);
}
 
static void _lib_lighttable_columns_slider_changed(GtkWidget *widget, gpointer user_data)
{
  dt_lib_module_t *self = (dt_lib_module_t *)user_data;
  dt_lib_tool_lighttable_t *d = (dt_lib_tool_lighttable_t *)self->data;
  const int cols = gtk_spin_button_get_value_as_int(GTK_SPIN_BUTTON(d->columns));
  _set_columns(self, cols);
  dt_conf_set_int("plugins/lighttable/images_in_row_backup", cols);
}
 
static void _lib_lighttable_set_columns(dt_lib_module_t *self, gint columns)
{
  dt_lib_tool_lighttable_t *d = (dt_lib_tool_lighttable_t *)self->data;
  gtk_spin_button_set_value(GTK_SPIN_BUTTON(d->columns), columns);
  _set_columns(self, columns);
}
 
// 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