imageop.c

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2009-2014 johannes hanika.
    Copyright (C) 2010-2011 Bruce Guenter.
    Copyright (C) 2010-2012 Henrik Andersson.
    Copyright (C) 2010 Stuart Henderson.
    Copyright (C) 2011 Antony Dovgal.
    Copyright (C) 2011 Brian Teague.
    Copyright (C) 2011-2012 Jérémy Rosen.
    Copyright (C) 2011 Robert Bieber.
    Copyright (C) 2011 Rostyslav Pidgornyi.
    Copyright (C) 2011-2020 Tobias Ellinghaus.
    Copyright (C) 2011-2015, 2017, 2019 Ulrich Pegelow.
    Copyright (C) 2012-2014, 2019-2022 Aldric Renaudin.
    Copyright (C) 2012 Edouard Gomez.
    Copyright (C) 2012-2013, 2015, 2018, 2020 parafin.
    Copyright (C) 2012-2013, 2018-2022 Pascal Obry.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013-2016 Roman Lebedev.
    Copyright (C) 2013 Simon Spannagel.
    Copyright (C) 2013 Thomas Pryds.
    Copyright (C) 2014, 2017, 2021 Dan Torop.
    Copyright (C) 2014 Mikhail Trishchenkov.
    Copyright (C) 2014-2016 Pedro Côrte-Real.
    Copyright (C) 2017 Dominik Markiewicz.
    Copyright (C) 2017-2019 Edgardo Hoszowski.
    Copyright (C) 2017-2020 Heiko Bauke.
    Copyright (C) 2017 Peter Budai.
    Copyright (C) 2018 Matthieu Moy.
    Copyright (C) 2018 rawfiner.
    Copyright (C) 2019-2026 Aurélien PIERRE.
    Copyright (C) 2019-2022 Diederik Ter Rahe.
    Copyright (C) 2019 Jacques Le Clerc.
    Copyright (C) 2020-2022 Chris Elston.
    Copyright (C) 2020-2022 Hanno Schwalm.
    Copyright (C) 2020 Harold le Clément de Saint-Marcq.
    Copyright (C) 2020-2021 Hubert Kowalski.
    Copyright (C) 2020-2021 Marco.
    Copyright (C) 2020 Philippe Weyland.
    Copyright (C) 2020-2021 Ralf Brown.
    Copyright (C) 2021 Mark-64.
    Copyright (C) 2021-2022 Philipp Lutz.
    Copyright (C) 2021 Sakari Kapanen.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2022 Miloš Komarčević.
    Copyright (C) 2022 Nicolas Auffray.
    Copyright (C) 2023 Alynx Zhou.
    Copyright (C) 2023 Luca Zulberti.
    Copyright (C) 2025-2026 Guillaume Stutin.
    Copyright (C) 2025 Miguel Moquillon.
    
    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/darktable.h"
#include "common/sentry.h"
#include "common/telemetry.h"
#include "develop/imageop.h"
#include "bauhaus/bauhaus.h"
#include "common/collection.h"
#include "common/debug.h"
#include "common/exif.h"
#include "common/history.h"
#include "common/imagebuf.h"
#include "common/imageio_rawspeed.h"
#include "common/interpolation.h"
#include "common/module.h"
#include "common/opencl.h"
#include "common/usermanual_url.h"
#include "control/control.h"
#include "control/signal.h"
#include "develop/blend.h"
#include "develop/develop.h"
#include "develop/format.h"
#include "develop/masks.h"
#include "develop/tiling.h"
#include "gui/gdkkeys.h"
#include "gui/presets.h"
#include "dtgtk/button.h"
#include "dtgtk/expander.h"
#include "dtgtk/gradientslider.h"
#include "dtgtk/icon.h"
 
#include "gui/color_picker_proxy.h"
#include "gui/gtk.h"
#include "gui/gui_throttle.h"
#include "gui/presets.h"
#ifdef GDK_WINDOWING_QUARTZ
#include "osx/osx.h"
#endif
 
#include <assert.h>
#include <gmodule.h>
#include <math.h>
#include <complex.h>
#include <stdlib.h>
 
static sqlite3_stmt *_iop_presets_select_stmt = NULL;
#include <string.h>
#include <strings.h>
#include <time.h>
 
#define DT_IOP_HEADER_MENU_OPEN "dt-module-header-menu-open"
#define DT_IOP_HEADER_MENU_DISMISS_CLICK "dt-module-header-menu-dismiss-click"
#define DT_IOP_HEADER_IGNORE_RELEASE "dt-module-header-ignore-release"
 
typedef struct dt_iop_gui_simple_callback_t
{
  dt_iop_module_t *self;
  int index;
} dt_iop_gui_simple_callback_t;
 
static gboolean _iop_plugin_focus_accel(GtkAccelGroup *accel_group, GObject *accelerable, guint keyval,
                                        GdkModifierType modifier, gpointer data);
static gboolean _iop_plugin_enable_accel(GtkAccelGroup *accel_group, GObject *accelerable, guint keyval,
                                        GdkModifierType modifier, gpointer data);
static gboolean _iop_plugin_header_button_release(GtkWidget *w, GdkEventButton *e, gpointer user_data);
static void _gui_set_single_expanded(dt_iop_module_t *module, gboolean expanded);
 
float dt_dev_get_module_scale(const dt_dev_pixelpipe_t *const pipe, const dt_iop_roi_t *const roi_in)
{
  return pipe->iscale / roi_in->scale;
}
 
uint32_t dt_dev_get_roi_filters(const dt_dev_pixelpipe_iop_t *const piece, const dt_iop_roi_t *const roi_in)
{
  return dt_rawspeed_crop_dcraw_filters(piece->dsc_in.filters, roi_in->x, roi_in->y);
}
 
 
void dt_iop_load_default_params(dt_iop_module_t *module)
{
  memcpy(module->params, module->default_params, module->params_size);
  dt_develop_blend_colorspace_t cst = dt_develop_blend_default_module_blend_colorspace(module);
  dt_develop_blend_init_blend_parameters(module->default_blendop_params, cst);
  dt_iop_commit_blend_params(module, module->default_blendop_params);
  dt_iop_gui_blending_reload_defaults(module);
  dt_iop_compute_module_hash(module, module->dev->forms);
}
 
static void _iop_modify_roi_in(struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                               struct dt_dev_pixelpipe_iop_t *piece,
                               const dt_iop_roi_t *roi_out, dt_iop_roi_t *roi_in)
{
  *roi_in = *roi_out;
}
 
static void _iop_modify_roi_out(struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                                struct dt_dev_pixelpipe_iop_t *piece,
                                dt_iop_roi_t *roi_out, const dt_iop_roi_t *roi_in)
{
  *roi_out = *roi_in;
}
 
/* default group for modules which do not implement the default_group() function */
static int default_default_group(void)
{
  return IOP_GROUP_TECHNICAL;
}
 
/* default flags for modules which does not implement the flags() function */
static int default_flags(void)
{
  return 0;
}
 
/* default operation tags for modules which does not implement the flags() function */
static int default_operation_tags(void)
{
  return 0;
}
 
/* default operation tags filter for modules which does not implement the flags() function */
static int default_operation_tags_filter(void)
{
  return 0;
}
 
static const char **default_description(struct dt_iop_module_t *self)
{
  return NULL;
}
 
static const char *default_aliases(void)
{
  return "";
}
 
static const char *default_deprecated_msg(void)
{
  return NULL;
}
 
static gboolean default_has_defaults(struct dt_iop_module_t *self)
{
  return memcmp(self->params, self->default_params, self->params_size) == 0;
}
 
static gboolean default_runtime_data_hash(struct dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe,
                                          const dt_dev_pixelpipe_iop_t *piece)
{
  (void)self;
  (void)pipe;
  (void)piece;
  return FALSE;
}
 
static void default_commit_params(struct dt_iop_module_t *self, dt_iop_params_t *params,
                                   dt_dev_pixelpipe_t *pipe, dt_dev_pixelpipe_iop_t *piece)
{
  memcpy(piece->data, params, self->params_size);
}
 
// WARNING: this works only if the data struct has the same size
// as the param structure. You need to implement your own IOP module
// method if they don't match !!!
static void default_init_pipe(struct dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe,
                              dt_dev_pixelpipe_iop_t *piece)
{
  size_t data_size = (size_t)self->params_size;
  piece->data = dt_calloc_align(data_size);
  piece->data_size = data_size;
}
 
static void default_cleanup_pipe(struct dt_iop_module_t *self, dt_dev_pixelpipe_t *pipe,
                                 dt_dev_pixelpipe_iop_t *piece)
{
  dt_free_align(piece->data);
  piece->data = NULL;
}
 
static void default_gui_cleanup(dt_iop_module_t *self)
{
  IOP_GUI_FREE;
}
 
static void default_cleanup(dt_iop_module_t *module)
{
  dt_free(module->params);
  dt_free(module->default_params);
}
 
static void _iop_color_picker_data_ready_callback(gpointer instance, gpointer user_data)
{
  dt_iop_module_t *const module = user_data;
  GtkWidget *picker = NULL;
  dt_dev_pixelpipe_t *pipe = NULL;
  const dt_dev_pixelpipe_iop_t *piece = NULL;
  if(IS_NULL_PTR(module) || IS_NULL_PTR(module->color_picker_apply)) return;
  if(dt_iop_color_picker_get_ready_data(module, &picker, &pipe, &piece)) return;
 
  dt_print(DT_DEBUG_DEV, "[picker] dispatch module=%s picker=%p pipe=%p hash=%" PRIu64 "\n",
           module->op, (void *)picker, (void *)pipe, piece ? piece->global_hash : 0);
 
  if(!module->blend_data || !blend_color_picker_apply(module, picker, pipe, (dt_dev_pixelpipe_iop_t *)piece))
    module->color_picker_apply(module, picker, pipe, (dt_dev_pixelpipe_iop_t *)piece);
}
 
 
static int default_distort_transform(dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe,
                                     const dt_dev_pixelpipe_iop_t *piece, float *points,
                                     size_t points_count)
{
  (void)self;
  (void)pipe;
  (void)piece;
  (void)points;
  (void)points_count;
  return 1;
}
static int default_distort_backtransform(dt_iop_module_t *self, const dt_dev_pixelpipe_t *pipe,
                                         const dt_dev_pixelpipe_iop_t *piece, float *points,
                                         size_t points_count)
{
  (void)self;
  (void)pipe;
  (void)piece;
  (void)points;
  (void)points_count;
  return 1;
}
 
static int default_process(struct dt_iop_module_t *self, const struct dt_dev_pixelpipe_t *pipe,
                           const struct dt_dev_pixelpipe_iop_t *piece,
                           const void *const i, void *const o)
{
  const struct dt_iop_roi_t *const roi_in = &piece->roi_in;
  const struct dt_iop_roi_t *const roi_out = &piece->roi_out;
  if(roi_in->width <= 1 || roi_in->height <= 1 || roi_out->width <= 1 || roi_out->height <= 1) return 0;
  return self->process_plain(self, pipe, piece, i, o);
}
 
static dt_introspection_field_t *default_get_introspection_linear(void)
{
  return NULL;
}
static dt_introspection_t *default_get_introspection(void)
{
  return NULL;
}
static void *default_get_p(const void *param, const char *name)
{
  return NULL;
}
static dt_introspection_field_t *default_get_f(const char *name)
{
  return NULL;
}
 
void dt_iop_default_init(dt_iop_module_t *module)
{
  size_t param_size = module->so->get_introspection()->size;
  module->params_size = param_size;
  /* Keep ownership explicit: if init is re-entered on the same instance,
   * release previous params before rebuilding defaults from introspection. */
  if(!IS_NULL_PTR(module->params))
  {
    dt_free(module->params);
    module->params = NULL;
  }
  if(!IS_NULL_PTR(module->default_params))
  {
    dt_free(module->default_params);
    module->default_params = NULL;
  }
  module->params = (dt_iop_params_t *)calloc(1, param_size);
  module->default_params = (dt_iop_params_t *)calloc(1, param_size);
 
  module->default_enabled = 0;
  module->gui_data = NULL;
 
  dt_introspection_field_t *i = module->so->get_introspection_linear();
  while(i->header.type != DT_INTROSPECTION_TYPE_NONE)
  {
    switch(i->header.type)
    {
    case DT_INTROSPECTION_TYPE_FLOAT:
      *(float*)((uint8_t *)module->default_params + i->header.offset) = i->Float.Default;
      break;
    case DT_INTROSPECTION_TYPE_INT:
      *(int*)((uint8_t *)module->default_params + i->header.offset) = i->Int.Default;
      break;
    case DT_INTROSPECTION_TYPE_UINT:
      *(unsigned int*)((uint8_t *)module->default_params + i->header.offset) = i->UInt.Default;
      break;
    case DT_INTROSPECTION_TYPE_USHORT:
      *(unsigned short*)((uint8_t *)module->default_params + i->header.offset) = i->UShort.Default;
      break;
    case DT_INTROSPECTION_TYPE_ENUM:
      *(int*)((uint8_t *)module->default_params + i->header.offset) = i->Enum.Default;
      break;
    case DT_INTROSPECTION_TYPE_BOOL:
      *(gboolean*)((uint8_t *)module->default_params + i->header.offset) = i->Bool.Default;
      break;
    case DT_INTROSPECTION_TYPE_CHAR:
      *(char*)((uint8_t *)module->default_params + i->header.offset) = i->Char.Default;
      break;
    case DT_INTROSPECTION_TYPE_OPAQUE:
      memset((uint8_t *)module->default_params + i->header.offset, 0, i->header.size);
      break;
    case DT_INTROSPECTION_TYPE_ARRAY:
      {
        if(i->Array.type == DT_INTROSPECTION_TYPE_CHAR) break;
 
        size_t element_size = i->Array.field->header.size;
        if(element_size % sizeof(int))
        {
          int8_t *p = (int8_t *)module->default_params + i->header.offset;
          for (size_t c = element_size; c < i->header.size; c++, p++)
            p[element_size] = *p;
        }
        else
        {
          element_size /= sizeof(int);
          size_t num_ints = i->header.size / sizeof(int);
 
          int *p = (int *)((uint8_t *)module->default_params + i->header.offset);
          for (size_t c = element_size; c < num_ints; c++, p++)
            p[element_size] = *p;
        }
      }
      break;
    case DT_INTROSPECTION_TYPE_STRUCT:
      // ignore STRUCT; nothing to do
      break;
    default:
      fprintf(stderr, "unsupported introspection type \"%s\" encountered in dt_iop_default_init (field %s)\n", i->header.type_name, i->header.field_name);
      break;
    }
 
    i++;
  }
}
 
int default_iop_focus(dt_gui_module_t *m, gboolean toggle)
{
  dt_iop_module_t *module = (dt_iop_module_t *) m;
 
  // Expand and scroll
  if(darktable.develop->gui_module != module)
  {
    dt_iop_request_focus(module);
    dt_iop_gui_set_expanded(module, TRUE, TRUE);
  }
  else if(toggle)
  {
    darktable.develop->gui_module = NULL;
    dt_iop_gui_set_expanded(module, FALSE, TRUE);
    dt_gui_refocus_center();
  }
 
  return 1;
}
 
int dt_iop_load_module_so(void *m, const char *libname, const char *module_name)
{
  dt_iop_module_so_t *module = (dt_iop_module_so_t *)m;
  g_strlcpy(module->op, module_name, sizeof(module->op));
 
#define INCLUDE_API_FROM_MODULE_LOAD "iop_load_module"
#include "iop/iop_api.h"
 
  if(IS_NULL_PTR(module->init)) module->init = dt_iop_default_init;
  if(IS_NULL_PTR(module->modify_roi_in)) module->modify_roi_in = _iop_modify_roi_in;
  if(IS_NULL_PTR(module->modify_roi_out)) module->modify_roi_out = _iop_modify_roi_out;
 
  #ifdef HAVE_OPENCL
  if(IS_NULL_PTR(module->process_tiling_cl)) module->process_tiling_cl = darktable.opencl->inited ? default_process_tiling_cl : NULL;
  if(!darktable.opencl->inited) module->process_cl = NULL;
  #endif // HAVE_OPENCL
 
  module->process_plain = module->process;
  module->process = default_process;
 
  module->data = NULL;
 
  // the introspection api
  module->have_introspection = FALSE;
  if(module->introspection_init)
  {
    if(!module->introspection_init(module, DT_INTROSPECTION_VERSION))
    {
      // set the introspection related fields in module
      module->have_introspection = TRUE;
 
      if(module->get_p == default_get_p ||
         module->get_f == default_get_f ||
         module->get_introspection_linear == default_get_introspection_linear ||
         module->get_introspection == default_get_introspection)
        goto api_h_error;
    }
    else
      fprintf(stderr, "[iop_load_module] failed to initialize introspection for operation `%s'\n", module_name);
  }
 
  if(module->init_global) module->init_global(module);
  return 0;
}
 
int dt_iop_load_module_by_so(dt_iop_module_t *module, dt_iop_module_so_t *so, dt_develop_t *dev)
{
  module->dev = dev;
  module->widget = NULL;
  module->header = NULL;
  module->off = NULL;
  module->hide_enable_button = 0;
  module->request_color_pick = DT_REQUEST_COLORPICK_OFF;
  module->request_histogram = DT_REQUEST_ONLY_IN_GUI;
  module->histogram_stats.bins_count = 0;
  module->histogram_stats.pixels = 0;
  module->multi_priority = 0;
  module->iop_order = 0;
  for(int k = 0; k < 3; k++)
  {
    module->picked_color[k] = module->picked_output_color[k] = 0.0f;
    module->picked_color_min[k] = module->picked_output_color_min[k] = 666.0f;
    module->picked_color_max[k] = module->picked_output_color_max[k] = -666.0f;
  }
  module->histogram_cst = IOP_CS_NONE;
  module->histogram = NULL;
  module->histogram_max[0] = module->histogram_max[1] = module->histogram_max[2] = module->histogram_max[3]
      = 0;
  module->histogram_middle_grey = FALSE;
  module->request_mask_display = DT_DEV_PIXELPIPE_DISPLAY_NONE;
  module->bypass_cache = FALSE;
  module->bypass_cache_variant = 0;
  module->enabled = module->default_enabled = module->workflow_enabled = 0; // all modules disabled by default.
  g_strlcpy(module->op, so->op, 20);
  module->raster_mask.source.users = g_hash_table_new(NULL, NULL);
  module->raster_mask.source.masks = g_hash_table_new_full(g_direct_hash, g_direct_equal, NULL, dt_free_gpointer);
  module->raster_mask.sink.source = NULL;
  module->raster_mask.sink.id = 0;
 
  // only reference cached results of dlopen:
  module->module = so->module;
  module->so = so;
 
#define INCLUDE_API_FROM_MODULE_LOAD_BY_SO
#include "iop/iop_api.h"
 
  module->version = so->version;
  module->process_plain = so->process_plain;
  module->have_introspection = so->have_introspection;
 
  module->reset_button = NULL;
  module->presets_button = NULL;
  module->fusion_slider = NULL;
 
  module->global_data = so->data;
 
  // now init the instance:
  module->init(module);
  module->hash = DT_PIXELPIPE_CACHE_HASH_INVALID;
  module->blendop_hash = DT_PIXELPIPE_CACHE_HASH_INVALID;
 
  if(module->params_size == 0)
  {
    fprintf(stderr, "[iop_load_module] `%s' needs to have a params size > 0!\n", so->op);
    return 1; // empty params hurt us in many places, just add a dummy value
  }
 
  /* Allocate params only when module init did not allocate them already.
   * Some init paths (notably default_init) already own the params buffers. */
  if(IS_NULL_PTR(module->params))
    module->params = calloc(1, module->params_size);
  if(IS_NULL_PTR(module->default_params))
    module->default_params = calloc(1, module->params_size);
  module->blend_params = calloc(1, sizeof(dt_develop_blend_params_t));
  module->default_blendop_params = calloc(1, sizeof(dt_develop_blend_params_t));
 
  // Don't init defaults here, it's done when reading/initing history
 
  /* pass on the dt_gui_module_t args for bauhaus widgets
   * only when a GUI lifetime exists for this module instance. */
  if(IS_NULL_PTR(module->dev) || module->dev->gui_attached)
  {
    module->common_fields.name = delete_underscore(module->name());
    module->common_fields.view = g_strdup(_("Darkroom")); // IOP modules belong necessarily to darkroom
  }
  else
  {
    module->common_fields.name = NULL;
    module->common_fields.view = NULL;
  }
  module->common_fields.widget_list = NULL;
  module->common_fields.widget_list_bh = NULL;
  module->common_fields.focus = module->iop_focus;
  module->common_fields.deprecated = (module->flags() & IOP_FLAGS_DEPRECATED) == IOP_FLAGS_DEPRECATED;
 
  return 0;
}
 
void dt_iop_init_pipe(struct dt_iop_module_t *module, struct dt_dev_pixelpipe_t *pipe,
                      struct dt_dev_pixelpipe_iop_t *piece)
{
  module->init_pipe(module, pipe, piece);
  piece->blendop_data = dt_calloc_align(sizeof(dt_develop_blend_params_t));
}
 
void dt_iop_cleanup_pipe(struct dt_iop_module_t *module, struct dt_dev_pixelpipe_t *pipe,
                        struct dt_dev_pixelpipe_iop_t *piece)
{
  if(IS_NULL_PTR(piece)) return;
 
  if(IS_NULL_PTR(module))
  {
    dt_print(DT_DEBUG_ALWAYS,
             "[dt_iop_cleanup_pipe] missing module, skipping module pipe cleanup\n");
  }
  else if(IS_NULL_PTR(pipe))
  {
    dt_print(DT_DEBUG_ALWAYS,
             "[dt_iop_cleanup_pipe] missing pipe for `%s`, skipping module pipe cleanup\n",
             module->op);
  }
  else
  {
    dt_iop_module_so_t *module_so = module->so;
    gboolean module_so_loaded = FALSE;
 
    /* Search the process-owned descriptor list by address before reading the
     * candidate. A removed instance may outlive its GUI, but its descriptor
     * must remain one of the objects loaded at startup. */
    for(GList *iop = g_list_first(darktable.iop); iop; iop = g_list_next(iop))
    {
      if(iop->data == module_so)
      {
        module_so_loaded = TRUE;
        break;
      }
    }
 
    if(!module_so_loaded)
      dt_print(DT_DEBUG_ALWAYS,
               "[dt_iop_cleanup_pipe] invalid shared-object descriptor %p, skipping module pipe cleanup\n",
               (void *)module_so);
    else if(module->cleanup_pipe != module_so->cleanup_pipe)
      dt_print(DT_DEBUG_ALWAYS,
               "[dt_iop_cleanup_pipe] stale cleanup callback for `%s`, skipping module pipe cleanup\n",
               module_so->op);
    else
      module_so->cleanup_pipe(module, pipe, piece);
  }
 
  if(!IS_NULL_PTR(piece->blendop_data))
  {
    dt_free_align(piece->blendop_data);
    piece->blendop_data = NULL;
  }
}
 
static void _gui_delete_callback(GtkButton *button, dt_iop_module_t *module)
{
  dt_develop_t *dev = module->dev;
 
  // we search another module with the same base
  // we want the next module if any or the previous one
  GList *modules = module->dev->iop;
  dt_iop_module_t *next = NULL;
  int find = 0;
  while(modules)
  {
    dt_iop_module_t *mod = (dt_iop_module_t *)modules->data;
    if(mod == module)
    {
      find = 1;
      if(next) break;
    }
    else if(mod->instance == module->instance)
    {
      next = mod;
      if(find) break;
    }
    modules = g_list_next(modules);
  }
  if(IS_NULL_PTR(next)) return; // what happened ???
 
  if(module->module_will_remove && !module->module_will_remove(module)) return;
 
  if(dev->gui_attached) dt_dev_undo_start_record(dev);
 
  // we must pay attention if priority is 0
  const gboolean is_zero = (module->multi_priority == 0);
 
  // We are about to destroy this module GUI. Drop darkroom focus first so the
  // center expose callback cannot call module->gui_post_expose() with a stale
  // module->gui_data pointer during teardown-triggered redraws.
  if(dev->gui_module == module) dt_iop_request_focus(NULL);
 
  dt_gui_freeze_begin();
 
  // we remove the plugin effectively
  if(!dt_iop_is_hidden(module))
  {
    // we just hide the module to avoid lots of gtk critical warnings
    gtk_widget_hide(module->expander);
 
    dt_iop_gui_cleanup_module(module);
    dt_gui_refocus_center();
  }
 
  // we remove all references in the history stack and dev->iop
  // this will inform that a module has been removed from history
  // we do it here so we have the multi_priorities to reconstruct
  // de deleted module if the user undo it
  dt_dev_module_remove(dev, module);
 
  // if module was priority 0, then we set next to priority 0
  if(is_zero)
  {
    // we want the first one in history
    dt_iop_module_t *first = NULL;
    GList *history = dev->history;
    while(history)
    {
      dt_dev_history_item_t *hist = (dt_dev_history_item_t *)(history->data);
      if(!hist || !hist->module)
      {
        history = g_list_next(history);
        continue;
      }
      if(hist->module->instance == module->instance && hist->module != module)
      {
        first = hist->module;
        break;
      }
      history = g_list_next(history);
    }
    if(IS_NULL_PTR(first)) first = next;
 
    // we set priority of first to 0
    dt_iop_update_multi_priority(first, 0);
 
    // we change this in the history stack too
    for(history = dev->history; history; history = g_list_next(history))
    {
      dt_dev_history_item_t *hist = (dt_dev_history_item_t *)(history->data);
      if(hist->module == first) hist->multi_priority = 0;
    }
  }
 
  // Commit undo snapshot for the whole delete operation (module removal + multi_priority adjustments).
  if(dev->gui_attached) dt_dev_undo_end_record(dev);
 
  // Save history
  dt_dev_write_history(dev, FALSE);
 
  // don't delete the module, a pipe may still need it
  dev->alliop = g_list_append(dev->alliop, module);
 
  /* redraw */
  dt_dev_pixelpipe_rebuild_all(dev);
  dt_control_queue_redraw_center();
 
  dt_gui_freeze_end();
}
 
gboolean dt_iop_gui_module_is_visible(dt_iop_module_t *module)
{
  GtkWidget *expander = module->expander;
  return (expander && gtk_widget_is_visible(expander) && !dt_iop_is_hidden(module));
}
 
gboolean dt_iop_gui_commit_iop_order_change(dt_develop_t *dev, dt_iop_module_t *module,
                                            gboolean enable, gboolean write_history, const char *reason)
{
  if(IS_NULL_PTR(dev)) return FALSE;
 
  dt_dev_pixelpipe_rebuild_all(dev);
  if(write_history) dt_dev_add_history_item(dev, module, enable, TRUE);
 
  if(!IS_NULL_PTR(reason)) dt_ioppr_check_iop_order(dev, 0, reason);
 
  dt_dev_signal_modules_moved(dev);
  return TRUE;
}
 
gboolean dt_iop_gui_move_module_before(dt_iop_module_t *module, dt_iop_module_t *module_next,
                                       const char *reason)
{
  if(!dt_ioppr_move_iop_before(module->dev, module, module_next)) return FALSE;
  return dt_iop_gui_commit_iop_order_change(module->dev, module, TRUE, TRUE, reason);
}
 
gboolean dt_iop_gui_move_module_after(dt_iop_module_t *module, dt_iop_module_t *module_prev,
                                      const char *reason)
{
  if(!dt_ioppr_move_iop_after(module->dev, module, module_prev)) return FALSE;
  return dt_iop_gui_commit_iop_order_change(module->dev, module, TRUE, TRUE, reason);
}
 
dt_iop_module_t *dt_iop_gui_get_previous_visible_module(dt_iop_module_t *module)
{
  dt_iop_module_t *prev = NULL;
  for(GList *modules = g_list_first(module->dev->iop); modules; modules = g_list_next(modules))
  {
    dt_iop_module_t *mod = (dt_iop_module_t *)modules->data;
    if(mod == module)
      break;
    else if(dt_iop_gui_module_is_visible(mod))
      prev = mod;
  }
  return prev;
}
 
dt_iop_module_t *dt_iop_gui_get_next_visible_module(dt_iop_module_t *module)
{
  dt_iop_module_t *next = NULL;
  for(GList *modules = g_list_last(module->dev->iop); modules; modules = g_list_previous(modules))
  {
    dt_iop_module_t *mod = (dt_iop_module_t *)modules->data;
    if(mod == module)
      break;
    else if(dt_iop_gui_module_is_visible(mod))
      next = mod;
  }
  return next;
}
 
dt_iop_module_t *dt_iop_gui_duplicate(dt_iop_module_t *base, gboolean copy_params)
{
  // make sure the duplicated module appears in the history
  dt_dev_add_history_item(base->dev, base, FALSE, FALSE);
 
  // first we create the new module
  dt_gui_freeze_begin();
  dt_iop_module_t *module = dt_dev_module_duplicate(base->dev, base);
  dt_gui_freeze_end();
  if(IS_NULL_PTR(module)) return NULL;
 
  // we set the gui part of it
  /* initialize gui if iop have one defined */
  if(!dt_iop_is_hidden(module))
  {
    // make sure gui_init and reload defaults is called safely
    dt_iop_gui_init(module);
 
    /* add module to right panel */
    dt_iop_gui_set_expander(module);
    darktable.gui->scroll_to_header_once = module->expander;
 
    dt_iop_reload_defaults(module); // some modules like profiled denoise update the gui in reload_defaults
 
    if(copy_params)
    {
      memcpy(module->params, base->params, module->params_size);
      if(module->flags() & IOP_FLAGS_SUPPORTS_BLENDING)
      {
        dt_iop_commit_blend_params(module, base->blend_params);
        if(base->blend_params->mask_id > 0)
        {
          module->blend_params->mask_id = 0;
          dt_masks_iop_use_same_as(module, base);
        }
      }
    }
 
    dt_iop_request_focus(module);
    dt_iop_gui_set_expanded(module, TRUE, FALSE);
    if(base != module && !IS_NULL_PTR(base->expander)) _gui_set_single_expanded(base, FALSE);
    dt_iop_gui_update_blending(module);
 
    if(module->dev->gui_attached)
      dt_dev_pixelpipe_rebuild_all(module->dev);
 
    // we save the new instance creation
    dt_dev_add_history_item(module->dev, module, TRUE, TRUE);
  }
 
  /* update ui to new parameters */
  dt_iop_gui_update(module);
 
  return module;
}
 
void dt_iop_gui_rename_module(dt_iop_module_t *module);
 
static gboolean _rename_module_idle(gpointer user_data)
{
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
  dt_iop_gui_rename_module(module);
 
  return G_SOURCE_REMOVE;
}
 
static void _gui_copy_callback(GtkButton *button, gpointer user_data)
{
  dt_iop_module_t *module = dt_iop_gui_duplicate(user_data, FALSE);
  if(IS_NULL_PTR(module)) return;
 
  g_idle_add(_rename_module_idle, module);
}
 
static void _gui_duplicate_callback(GtkButton *button, gpointer user_data)
{
  dt_iop_module_t *module = dt_iop_gui_duplicate(user_data, TRUE);
  if(IS_NULL_PTR(module)) return;
 
  g_idle_add(_rename_module_idle, module);
}
 
static gboolean _rename_module_key_press(GtkWidget *entry, GdkEventKey *event, dt_iop_module_t *module)
{
  int ended = 0;
  guint key = dt_keys_mainpad_alternatives(event->keyval);
 
  if(event->type == GDK_FOCUS_CHANGE || key == GDK_KEY_Return)
  {
    if(gtk_entry_get_text_length(GTK_ENTRY(entry)) > 0)
    {
      // name is not empty, set new multi_name
 
       const gchar *name = gtk_entry_get_text(GTK_ENTRY(entry));
 
      // restore saved 1st character of instance name (without it the same name wouls still produce unnecessary copy + add history item)
      module->multi_name[0] = module->multi_name[sizeof(module->multi_name) - 1];
      module->multi_name[sizeof(module->multi_name) - 1] = 0;
 
      if(g_strcmp0(module->multi_name, name) != 0)
      {
        g_strlcpy(module->multi_name, name, sizeof(module->multi_name));
        dt_dev_add_history_item(module->dev, module, TRUE, TRUE);
      }
    }
    else
    {
      // clear out multi-name (set 1st char to 0)
      module->multi_name[0] = 0;
      dt_dev_add_history_item(module->dev, module, TRUE, TRUE);
    }
 
    ended = 1;
  }
  else if(key == GDK_KEY_Escape)
  {
    // restore saved 1st character of instance name
    module->multi_name[0] = module->multi_name[sizeof(module->multi_name) - 1];
    module->multi_name[sizeof(module->multi_name) - 1] = 0;
 
    ended = 1;
  }
 
  if(ended)
  {
    g_signal_handlers_disconnect_by_func(entry, G_CALLBACK(_rename_module_key_press), module);
    gtk_widget_destroy(entry);
    dt_iop_gui_update_header(module);
    dt_masks_group_update_name(module);
    return TRUE;
  }
 
  return FALSE; /* event not handled */
}
 
static gboolean _rename_module_resize(GtkWidget *entry, GdkEventKey *event, dt_iop_module_t *module)
{
  int width = 0;
  GtkBorder padding;
 
  pango_layout_get_pixel_size(gtk_entry_get_layout(GTK_ENTRY(entry)), &width, NULL);
  gtk_style_context_get_padding(gtk_widget_get_style_context (entry),
                                gtk_widget_get_state_flags (entry),
                                &padding);
  gtk_widget_set_size_request(entry, width + padding.left + padding.right + 1, -1);
 
  return TRUE;
}
 
void dt_iop_gui_rename_module(dt_iop_module_t *module)
{
  GtkWidget *focused = gtk_container_get_focus_child(GTK_CONTAINER(module->header));
  if(focused && GTK_IS_ENTRY(focused)) return;
 
  GtkWidget *entry = gtk_entry_new();
  dt_accels_disconnect_on_text_input(entry);
 
  gtk_widget_set_name(entry, "iop-panel-label");
  gtk_entry_set_width_chars(GTK_ENTRY(entry), 0);
  gtk_entry_set_max_length(GTK_ENTRY(entry), sizeof(module->multi_name) - 1);
  gtk_entry_set_text(GTK_ENTRY(entry), module->multi_name);
 
  // remove instance name but save 1st character in case of escape
  module->multi_name[sizeof(module->multi_name) - 1] = module->multi_name[0];
  module->multi_name[0] = 0;
  dt_iop_gui_update_header(module);
 
  gtk_widget_add_events(entry, GDK_FOCUS_CHANGE_MASK);
  g_signal_connect(entry, "key-press-event", G_CALLBACK(_rename_module_key_press), module);
  g_signal_connect(entry, "focus-out-event", G_CALLBACK(_rename_module_key_press), module);
  g_signal_connect(entry, "style-updated", G_CALLBACK(_rename_module_resize), module);
  g_signal_connect(entry, "changed", G_CALLBACK(_rename_module_resize), module);
 
  gtk_box_pack_start(GTK_BOX(module->header), entry, TRUE, TRUE, 0);
  gtk_widget_show(entry);
  gtk_widget_grab_focus(entry);
}
 
static void _gui_rename_callback(GtkButton *button, dt_iop_module_t *module)
{
  dt_iop_gui_rename_module(module);
}
 
static gboolean _iop_plugin_header_menu_dismiss_idle(gpointer user_data)
{
  GtkWidget *expander = GTK_WIDGET(user_data);
  if(GTK_IS_WIDGET(expander))
    g_object_set_data(G_OBJECT(expander), DT_IOP_HEADER_MENU_DISMISS_CLICK, NULL);
 
  g_object_unref(expander);
  return G_SOURCE_REMOVE;
}
 
static void _iop_plugin_header_menu_deactivate(GtkWidget *menu, gpointer user_data)
{
  GtkWidget *expander = GTK_WIDGET(user_data);
  if(!GTK_IS_WIDGET(expander)) return;
 
  g_object_set_data(G_OBJECT(expander), DT_IOP_HEADER_MENU_OPEN, NULL);
  g_object_set_data(G_OBJECT(expander), DT_IOP_HEADER_MENU_DISMISS_CLICK, GINT_TO_POINTER(TRUE));
  g_idle_add(_iop_plugin_header_menu_dismiss_idle, g_object_ref(expander));
}
 
static gboolean _gui_multiinstance_callback(GtkButton *button, GdkEventButton *event, gpointer user_data)
{
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
 
  if(!IS_NULL_PTR(event) && event->button == 3)
  {
    if(!(module->flags() & IOP_FLAGS_ONE_INSTANCE)) _gui_copy_callback(button, user_data);
    return TRUE;
  }
  else if(!IS_NULL_PTR(event) && event->button == 2)
  {
    return FALSE;
  }
 
  GtkMenuShell *menu = GTK_MENU_SHELL(gtk_menu_new());
  GtkWidget *item;
 
  item = gtk_menu_item_new_with_label(_("new instance"));
  // gtk_widget_set_tooltip_text(item, _("add a new instance of this module to the pipe"));
  g_signal_connect(G_OBJECT(item), "activate", G_CALLBACK(_gui_copy_callback), module);
  gtk_widget_set_sensitive(item, module->multi_show_new);
  gtk_menu_shell_append(menu, item);
 
  item = gtk_menu_item_new_with_label(_("duplicate instance"));
  // gtk_widget_set_tooltip_text(item, _("add a copy of this instance to the pipe"));
  g_signal_connect(G_OBJECT(item), "activate", G_CALLBACK(_gui_duplicate_callback), module);
  gtk_widget_set_sensitive(item, module->multi_show_new);
  gtk_menu_shell_append(menu, item);
 
  item = gtk_menu_item_new_with_label(_("delete"));
  // gtk_widget_set_tooltip_text(item, _("delete this instance"));
  g_signal_connect(G_OBJECT(item), "activate", G_CALLBACK(_gui_delete_callback), module);
  gtk_widget_set_sensitive(item, module->multi_show_close);
  gtk_menu_shell_append(menu, item);
 
  gtk_menu_shell_append(GTK_MENU_SHELL(menu), gtk_separator_menu_item_new());
 
  item = gtk_menu_item_new_with_label(_("rename"));
  g_signal_connect(G_OBJECT(item), "activate", G_CALLBACK(_gui_rename_callback), module);
  gtk_menu_shell_append(menu, item);
 
  if(!IS_NULL_PTR(module->expander))
  {
    g_object_set_data(G_OBJECT(module->expander), DT_IOP_HEADER_MENU_OPEN, GINT_TO_POINTER(TRUE));
    g_signal_connect_data(G_OBJECT(menu), "deactivate",
                          G_CALLBACK(_iop_plugin_header_menu_deactivate),
                          g_object_ref(module->expander), (GClosureNotify)g_object_unref, 0);
  }
 
  dt_gui_menu_popup(GTK_MENU(menu), GTK_WIDGET(button), GDK_GRAVITY_SOUTH_EAST, GDK_GRAVITY_NORTH_EAST);
 
  // make sure the button is deactivated now that the menu is opened
  if(button) dtgtk_button_set_active(DTGTK_BUTTON(button), FALSE);
  return TRUE;
}
 
static void _gui_off_callback(GtkToggleButton *togglebutton, gpointer user_data)
{
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
 
  if(!dt_gui_widgets_suppressed())
  {
    dt_gui_throttle_cancel(module);
 
    if(gtk_toggle_button_get_active(togglebutton))
    {
      module->enabled = 1;
      dt_sentry_record_module_usage("iop", module->op);
      dt_telemetry_record_module_usage("iop", module->op);
      dt_dev_add_history_item(module->dev, module, FALSE, TRUE);
    }
    else
    {
      module->enabled = 0;
 
      //  if current module is set as the CAT instance, remove that setting
      if(module->dev->proxy.chroma_adaptation == module)
        module->dev->proxy.chroma_adaptation = NULL;
 
      dt_dev_add_history_item(module->dev, module, FALSE, TRUE);
    }
  }
 
  char tooltip[512];
  gchar *module_label = dt_history_item_get_name(module);
  snprintf(tooltip, sizeof(tooltip), module->enabled ? _("%s is switched on") : _("%s is switched off"),
           module_label);
  dt_free(module_label);
  gtk_widget_set_tooltip_text(GTK_WIDGET(togglebutton), tooltip);
  gtk_widget_queue_draw(GTK_WIDGET(togglebutton));
}
 
gboolean dt_iop_so_is_hidden(dt_iop_module_so_t *module)
{
  gboolean is_hidden = TRUE;
  if(!(module->flags() & IOP_FLAGS_HIDDEN))
  {
    if(IS_NULL_PTR(module->gui_init))
      g_debug("Module '%s' is not hidden and lacks implementation of gui_init()...", module->op);
    else if(!module->gui_cleanup)
      g_debug("Module '%s' is not hidden and lacks implementation of gui_cleanup()...", module->op);
    else
      is_hidden = FALSE;
  }
  return is_hidden;
}
 
gboolean dt_iop_is_hidden(dt_iop_module_t *module)
{
  return dt_iop_so_is_hidden(module->so);
}
 
gboolean dt_iop_is_visible(dt_iop_module_t *module)
{
  return !dt_iop_is_hidden(module) && !IS_NULL_PTR(module->expander) && gtk_widget_is_visible(module->expander);
}
 
static void _iop_panel_label(dt_iop_module_t *module)
{
  GtkWidget *lab = dt_gui_container_nth_child(GTK_CONTAINER(module->header), IOP_MODULE_LABEL);
  lab = gtk_bin_get_child(GTK_BIN(lab));
  gtk_widget_set_name(lab, "iop-panel-label");
 
  char *module_name = dt_history_item_get_label(module);
  dt_capitalize_label(module_name);
  gtk_label_set_markup_with_mnemonic(GTK_LABEL(lab), module_name);
  dt_free(module_name);
 
  // Module name hasn't changed or no instance name: abort now
  if(!g_strcmp0(module_name, gtk_label_get_text(GTK_LABEL(lab))) || module->multi_name[0] == '\0')
    return;
 
  dt_gui_module_t *mod = (dt_gui_module_t *)module;
  if(mod->instance_name)
  {
    char *instance_path = dt_accels_build_path(_("Darkroom/Modules/Instances"), mod->instance_name);
    dt_accels_remove_shortcut(darktable.gui->accels, instance_path);
    dt_free(instance_path);
    dt_free(mod->instance_name);
  }
 
  gchar *clean_name = delete_underscore(module->name());
  dt_capitalize_label(clean_name);
 
  mod->instance_name
      = g_strdup_printf("%s/%s", clean_name, (module->multi_name[0] != '\0') ? module->multi_name : "0");
 
  dt_accels_new_virtual_instance_shortcut(darktable.gui->accels, _iop_plugin_focus_accel, module,
                                          darktable.gui->accels->darkroom_accels, _("Darkroom/Modules/Instances"),
                                          mod->instance_name);
 
  dt_free(clean_name);
 
  gtk_label_set_ellipsize(GTK_LABEL(lab), !module->multi_name[0] ? PANGO_ELLIPSIZE_END: PANGO_ELLIPSIZE_MIDDLE);
  g_object_set(G_OBJECT(lab), "xalign", 0.0, (gchar *)0);
}
 
void dt_iop_gui_update_header(dt_iop_module_t *module)
{
  if (IS_NULL_PTR(module->header))                  /* some modules such as overexposed don't actually have a header */
    return;
 
  // set panel name to display correct multi-instance
  _iop_panel_label(module);
  dt_iop_gui_set_enable_button(module);
  dt_iop_add_remove_mask_indicator(module);
}
 
void dt_iop_gui_set_enable_button_icon(GtkWidget *w, dt_iop_module_t *module)
{
  // set on/off icon
  if(module->default_enabled && module->hide_enable_button)
  {
    dtgtk_togglebutton_set_paint(DTGTK_TOGGLEBUTTON(w), dtgtk_cairo_paint_module_switch_on, 0, module);
  }
  else if(!module->default_enabled && module->hide_enable_button)
  {
    dtgtk_togglebutton_set_paint(DTGTK_TOGGLEBUTTON(w), dtgtk_cairo_paint_module_switch_on, 0, module);
  }
  else
  {
    dtgtk_togglebutton_set_paint(DTGTK_TOGGLEBUTTON(w), dtgtk_cairo_paint_module_switch, 0, module);
  }
}
 
void dt_iop_gui_set_enable_button(dt_iop_module_t *module)
{
  if(IS_NULL_PTR(module)) return;
 
  if(module->off)
  {
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(module->off), module->enabled);
    if(module->hide_enable_button)
      gtk_widget_set_sensitive(GTK_WIDGET(module->off), FALSE);
    else
      gtk_widget_set_sensitive(GTK_WIDGET(module->off), TRUE);
 
    dt_gui_remove_class(GTK_WIDGET(module->off), "dt_iop_enable_forced_on");
    dt_gui_remove_class(GTK_WIDGET(module->off), "dt_iop_enable_forced_off");
    if(module->hide_enable_button)
    {
      dt_gui_add_class(GTK_WIDGET(module->off),
                       module->enabled ? "dt_iop_enable_forced_on" : "dt_iop_enable_forced_off");
    }
 
    dt_iop_gui_set_enable_button_icon(GTK_WIDGET(module->off), module);
  }
}
 
void dt_iop_gui_init(dt_iop_module_t *module)
{
  // Suppress widget value-changed callbacks for the whole GUI build. Setting a slider's soft
  // range (etc.) in gui_init emits "value-changed", which would re-enter the module's
  // gui_changed handler before its sibling widgets exist and crash on dt_bauhaus_*(NULL)
  // (Sentry #129494618, #129578628). The scope guard releases the freeze automatically on every
  // exit path, and the central depth is GUI-thread-only and self-healing, so it cannot drift.
  dt_gui_widget_freeze();
 
  // Add the accelerators
  if(!dt_iop_is_hidden(module) && !(module->flags() & IOP_FLAGS_DEPRECATED))
  {
    gchar *clean_name = delete_underscore(module->name());
    dt_capitalize_label(clean_name);
 
    // slash is not allowed in module names because that makes accel pathes fail
    assert(g_strrstr(clean_name, "/") == NULL);
 
    dt_gui_module_t *mod = (dt_gui_module_t *)module;
    const gchar *const main_scope = _("Darkroom/Modules");
    mod->accel_path =  dt_accels_build_path(main_scope, clean_name);
    
    dt_accels_new_darkroom_action(_iop_plugin_focus_accel, module, main_scope, clean_name, 0, 0, _("Focuses the module"));
 
    // NOTE: we should enable the accel only if the module is disable-able, but this property is set at runtime
    // in reload_defaults(), which depends on the image metadata for each pipeline.
    // We have no way of knowing here at init time.
    // if(!module->hide_enable_button)
    dt_accels_new_darkroom_action(_iop_plugin_enable_accel, module, mod->accel_path, _("Enable"), 0, 0, _("Enables the module"));
 
    dt_free(clean_name);
  }
 
  // We absolutely need to init the module controls after the module object
  if(module->gui_init) module->gui_init(module);
  if(module->color_picker_apply)
  {
    DT_DEBUG_CONTROL_SIGNAL_CONNECT(darktable.signals, DT_SIGNAL_CONTROL_PICKERDATA_READY,
                                    G_CALLBACK(_iop_color_picker_data_ready_callback), module);
  }
  // the freeze ends here as the scope guard goes out of scope
}
 
void dt_iop_reload_defaults(dt_iop_module_t *module)
{
  // Suppress GUI callbacks while a module's reload_defaults() rewrites widget defaults. This is
  // a no-op off the GUI thread (worker-thread thumbnail/export devs have no widgets, so they
  // must never touch -- and race/drift -- the shared depth); the central API enforces that.
  // The previous root cause of NULL-bauhaus-widget crashes was exactly this counter drifting
  // (Sentry #129494618, #129578628, #129908540). Scope the freeze to the params work so the
  // header update below still runs unsuppressed, exactly as before.
  {
    dt_gui_widget_freeze();
 
    if(module->reload_defaults)
    {
      // report if reload_defaults was called unnecessarily => this should be considered a bug
      // the whole point of reload_defaults is to update defaults _based on current image_
      // any required initialisation should go in init (and not be performed repeatedly here)
      if(module->dev)
      {
        module->reload_defaults(module);
        dt_print(DT_DEBUG_PARAMS, "[params] defaults reloaded for %s\n", module->op);
      }
      else
      {
        fprintf(stderr, "reload_defaults should not be called without image.\n");
      }
    }
    dt_iop_load_default_params(module);
  }
 
  if(module->header) dt_iop_gui_update_header(module);
}
 
 
static void _init_presets(dt_iop_module_so_t *module_so)
{
  // Skip auto-preset regeneration when the build + UI language haven't changed.
  if(module_so->init_presets && dt_gui_presets_autogen_enabled())
    module_so->init_presets(module_so);
 
  // this seems like a reasonable place to check for and update legacy
  // presets.
 
  const int32_t module_version = module_so->version();
  if(IS_NULL_PTR(_iop_presets_select_stmt))
  {
    DT_DEBUG_SQLITE3_PREPARE_V2(
        dt_database_get(darktable.db),
        "SELECT name, op_version, op_params, blendop_version, blendop_params FROM data.presets WHERE operation = ?1",
        -1, &_iop_presets_select_stmt, NULL);
  }
  sqlite3_stmt *stmt = _iop_presets_select_stmt;
  sqlite3_reset(stmt);
  sqlite3_clear_bindings(stmt);
  DT_DEBUG_SQLITE3_BIND_TEXT(stmt, 1, module_so->op, -1, SQLITE_TRANSIENT);
 
  while(sqlite3_step(stmt) == SQLITE_ROW)
  {
    const char *name = (char *)sqlite3_column_text(stmt, 0);
    int32_t old_params_version = sqlite3_column_int(stmt, 1);
    const void *old_params = (void *)sqlite3_column_blob(stmt, 2);
    const int32_t old_params_size = sqlite3_column_bytes(stmt, 2);
    const int32_t old_blend_params_version = sqlite3_column_int(stmt, 3);
    const void *old_blend_params = (void *)sqlite3_column_blob(stmt, 4);
    const int32_t old_blend_params_size = sqlite3_column_bytes(stmt, 4);
 
    if(old_params_version == 0)
    {
      // this preset doesn't have a version.  go digging through the database
      // to find a history entry that matches the preset params, and get
      // the module version from that.
 
      sqlite3_stmt *stmt2;
      DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db),
                                  "SELECT module FROM main.history WHERE operation = ?1 AND op_params = ?2", -1,
                                  &stmt2, NULL);
      DT_DEBUG_SQLITE3_BIND_TEXT(stmt2, 1, module_so->op, -1, SQLITE_TRANSIENT);
      DT_DEBUG_SQLITE3_BIND_BLOB(stmt2, 2, old_params, old_params_size, SQLITE_TRANSIENT);
 
      if(sqlite3_step(stmt2) == SQLITE_ROW)
      {
        old_params_version = sqlite3_column_int(stmt2, 0);
      }
      else
      {
        fprintf(stderr, "[imageop_init_presets] WARNING: Could not find versioning information for '%s' "
                        "preset '%s'\nUntil some is found, the preset will be unavailable.\n(To make it "
                        "return, please load an image that uses the preset.)\n",
                module_so->op, name);
        sqlite3_finalize(stmt2);
        continue;
      }
 
      sqlite3_finalize(stmt2);
 
      // we found an old params version.  Update the database with it.
 
      fprintf(stderr, "[imageop_init_presets] Found version %d for '%s' preset '%s'\n", old_params_version,
              module_so->op, name);
 
      DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db),
                                  "UPDATE data.presets SET op_version=?1 WHERE operation=?2 AND name=?3", -1,
                                  &stmt2, NULL);
      DT_DEBUG_SQLITE3_BIND_INT(stmt2, 1, old_params_version);
      DT_DEBUG_SQLITE3_BIND_TEXT(stmt2, 2, module_so->op, -1, SQLITE_TRANSIENT);
      DT_DEBUG_SQLITE3_BIND_TEXT(stmt2, 3, name, -1, SQLITE_TRANSIENT);
 
      sqlite3_step(stmt2);
      sqlite3_finalize(stmt2);
    }
 
    if(module_version > old_params_version && !IS_NULL_PTR(module_so->legacy_params))
    {
      // we need a dt_iop_module_t for legacy_params()
      dt_iop_module_t *module;
      module = (dt_iop_module_t *)calloc(1, sizeof(dt_iop_module_t));
      if(dt_iop_load_module_by_so(module, module_so, NULL))
      {
        dt_free(module);
        continue;
      }
/*
      module->init(module);
      if(module->params_size == 0)
      {
        dt_iop_cleanup_module(module);
        dt_free(module);
        continue;
      }
      // we call reload_defaults() in case the module defines it
      if(module->reload_defaults) module->reload_defaults(module); // why not call dt_iop_reload_defaults? (if needed at all)
*/
 
      const int32_t new_params_size = module->params_size;
      void *new_params = calloc(1, new_params_size);
 
      // convert the old params to new
      if(module->legacy_params(module, old_params, old_params_version, new_params, module_version))
      {
        dt_free(new_params);
        dt_iop_cleanup_module(module);
        dt_free(module);
        continue;
      }
 
      fprintf(stderr, "[imageop_init_presets] updating '%s' preset '%s' from version %d to version %d\nto:'%s'",
              module_so->op, name, old_params_version, module_version,
              dt_exif_xmp_encode(new_params, new_params_size, NULL));
 
      // and write the new params back to the database
      sqlite3_stmt *stmt2;
      // clang-format off
      DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db), "UPDATE data.presets "
                                                                 "SET op_version=?1, op_params=?2 "
                                                                 "WHERE operation=?3 AND name=?4",
                                  -1, &stmt2, NULL);
      // clang-format on
      DT_DEBUG_SQLITE3_BIND_INT(stmt2, 1, module->version());
      DT_DEBUG_SQLITE3_BIND_BLOB(stmt2, 2, new_params, new_params_size, SQLITE_TRANSIENT);
      DT_DEBUG_SQLITE3_BIND_TEXT(stmt2, 3, module->op, -1, SQLITE_TRANSIENT);
      DT_DEBUG_SQLITE3_BIND_TEXT(stmt2, 4, name, -1, SQLITE_TRANSIENT);
 
      sqlite3_step(stmt2);
      sqlite3_finalize(stmt2);
 
      dt_free(new_params);
      dt_iop_cleanup_module(module);
      dt_free(module);
    }
    else if(module_version > old_params_version)
    {
      fprintf(stderr, "[imageop_init_presets] Can't upgrade '%s' preset '%s' from version %d to %d, no "
                      "legacy_params() implemented \n",
              module_so->op, name, old_params_version, module_version);
    }
 
    if(IS_NULL_PTR(old_blend_params) || dt_develop_blend_version() > old_blend_params_version)
    {
      fprintf(stderr,
              "[imageop_init_presets] updating '%s' preset '%s' from blendop version %d to version %d\n",
              module_so->op, name, old_blend_params_version, dt_develop_blend_version());
 
      // we need a dt_iop_module_t for dt_develop_blend_legacy_params()
      // using dt_develop_blend_legacy_params_by_so won't help as we need "module" anyway
      dt_iop_module_t *module;
      module = (dt_iop_module_t *)calloc(1, sizeof(dt_iop_module_t));
      if(dt_iop_load_module_by_so(module, module_so, NULL))
      {
        dt_free(module);
        continue;
      }
 
      if(module->params_size == 0)
      {
        dt_iop_cleanup_module(module);
        dt_free(module);
        continue;
      }
      void *new_blend_params = malloc(sizeof(dt_develop_blend_params_t));
 
      // convert the old blend params to new
      if(old_blend_params
         && dt_develop_blend_legacy_params(module, old_blend_params, old_blend_params_version,
                                           new_blend_params, dt_develop_blend_version(),
                                           old_blend_params_size) == 0)
      {
        // do nothing
      }
      else
      {
        memcpy(new_blend_params, module->default_blendop_params, sizeof(dt_develop_blend_params_t));
      }
 
      // and write the new blend params back to the database
      sqlite3_stmt *stmt2;
      // clang-format off
      DT_DEBUG_SQLITE3_PREPARE_V2(dt_database_get(darktable.db), "UPDATE data.presets "
                                                                 "SET blendop_version=?1, blendop_params=?2 "
                                                                 "WHERE operation=?3 AND name=?4",
                                  -1, &stmt2, NULL);
      // clang-format on
      DT_DEBUG_SQLITE3_BIND_INT(stmt2, 1, dt_develop_blend_version());
      DT_DEBUG_SQLITE3_BIND_BLOB(stmt2, 2, new_blend_params, sizeof(dt_develop_blend_params_t),
                                 SQLITE_TRANSIENT);
      DT_DEBUG_SQLITE3_BIND_TEXT(stmt2, 3, module->op, -1, SQLITE_TRANSIENT);
      DT_DEBUG_SQLITE3_BIND_TEXT(stmt2, 4, name, -1, SQLITE_TRANSIENT);
 
      sqlite3_step(stmt2);
      sqlite3_finalize(stmt2);
 
      dt_free(new_blend_params);
      dt_iop_cleanup_module(module);
      dt_free(module);
    }
  }
  sqlite3_reset(stmt);
}
 
 
static void _init_module_so(void *m)
{
  dt_iop_module_so_t *module = (dt_iop_module_so_t *)m;
 
  _init_presets(module);
 
  // do not init accelerators if there is no gui
  if(darktable.gui)
  {
    // create a gui and have the widgets register their accelerators
    dt_iop_module_t *module_instance = (dt_iop_module_t *)calloc(1, sizeof(dt_iop_module_t));
 
    if(module->gui_init && !dt_iop_load_module_by_so(module_instance, module, NULL))
    {
      dt_iop_gui_init(module_instance);
 
      static gboolean blending_accels_initialized = FALSE;
      if(!blending_accels_initialized)
      {
        dt_iop_colorspace_type_t cst = module->blend_colorspace(module_instance, NULL, NULL);
 
        if((module->flags() & IOP_FLAGS_SUPPORTS_BLENDING) &&
           !(module->flags() & IOP_FLAGS_NO_MASKS) &&
           (cst == IOP_CS_LAB || dt_iop_colorspace_is_rgb(cst)))
        {
          dt_iop_gui_init_blending(module_instance);
          dt_iop_gui_cleanup_blending(module_instance);
 
          blending_accels_initialized = TRUE;
        }
      }
 
      dt_iop_gui_cleanup_module(module_instance);
 
      dt_iop_cleanup_module(module_instance);
 
    }
 
    dt_free(module_instance);
  }
}
 
void dt_iop_load_modules_so(void)
{
  // Batch presets initialization in a single transaction to avoid per-module BEGIN/COMMIT overhead.
  dt_database_begin_transaction_batch(darktable.db);
  darktable.iop = dt_module_load_modules("/plugins", sizeof(dt_iop_module_so_t), dt_iop_load_module_so,
                                         _init_module_so, NULL);
  dt_database_end_transaction_batch(darktable.db);
}
 
int dt_iop_load_module(dt_iop_module_t *module, dt_iop_module_so_t *module_so, dt_develop_t *dev)
{
  memset(module, 0, sizeof(dt_iop_module_t));
  if(dt_iop_load_module_by_so(module, module_so, dev))
  {
    dt_free(module);
    return 1;
  }
  return 0;
}
 
void dt_iop_cleanup_module(dt_iop_module_t *module)
{
  // Safety net: dt_iop_cleanup_module() is the one choke point every module teardown path (darkroom
  // leave(), studio_capture's viewer teardown, dev->alliop reclaim...) calls right before dt_free(module).
  // Some of those paths skip dt_iop_gui_cleanup_module() entirely (e.g. studio_capture never runs
  // gui_init on its modules), and dt_iop_gui_cleanup_module() itself only invokes the module's own
  // gui_cleanup() -- which does the DT_DEBUG_CONTROL_SIGNAL_DISCONNECT() calls -- when gui_data is
  // non-NULL. Any signal a module connected in gui_init() (module_moved_callback in lut3d.c,
  // _develop_ui_pipe_started_callback in toneequal.c...) is broadcast globally on darktable.signals,
  // so a single missed disconnect leaves a dangling self pointer that a later, unrelated dev's signal
  // raise will invoke -- SIGSEGV on the freed instance. Disconnecting everything keyed on this module's
  // address here, unconditionally, guarantees no module can be invoked again once freed.
  dt_control_signal_disconnect_all(darktable.signals, module);
 
  module->cleanup(module);
 
  if(!IS_NULL_PTR(module->common_fields.name))
  {
    dt_free(module->common_fields.name);
    module->common_fields.name = NULL;
  }
  if(!IS_NULL_PTR(module->common_fields.view))
  {
    dt_free(module->common_fields.view);
    module->common_fields.view = NULL;
  }
 
  dt_free(module->blend_params);
  dt_free(module->default_blendop_params);
 
  // don't have a picker pointing to a disappeared module
  if(darktable.develop
     && darktable.develop->color_picker.picker
     && darktable.develop->color_picker.picker->module == module)
  {
    darktable.develop->color_picker.picker = NULL;
    darktable.develop->color_picker.widget = NULL;
    darktable.develop->color_picker.module = NULL;
    darktable.develop->color_picker.enabled = FALSE;
    darktable.develop->color_picker.update_pending = FALSE;
  }
 
  dt_free(module->histogram);
  g_hash_table_destroy(module->raster_mask.source.users);
  g_hash_table_destroy(module->raster_mask.source.masks);
  module->raster_mask.source.users = NULL;
  module->raster_mask.source.masks = NULL;
}
 
void dt_iop_unload_modules_so()
{
  if(!IS_NULL_PTR(_iop_presets_select_stmt))
  {
    sqlite3_finalize(_iop_presets_select_stmt);
    _iop_presets_select_stmt = NULL;
  }
 
  while(darktable.iop)
  {
    dt_iop_module_so_t *module = (dt_iop_module_so_t *)darktable.iop->data;
    if(module->cleanup_global) module->cleanup_global(module);
    if(module->module) g_module_close(module->module);
    dt_free(darktable.iop->data);
    darktable.iop = g_list_delete_link(darktable.iop, darktable.iop);
  }
}
 
void dt_iop_set_mask_mode(dt_iop_module_t *module, int mask_mode)
{
  (void)mask_mode;
  static const int key = 0;
 
  gboolean drawn_used = FALSE;
  gboolean parametric_used = FALSE;
  dt_develop_blend_get_mask_usage(module, module->blend_params, NULL, NULL, &drawn_used, &parametric_used);
 
  if(drawn_used || parametric_used)
  {
    char *modulename = dt_history_item_get_name(module);
    g_hash_table_insert(module->raster_mask.source.masks, GINT_TO_POINTER(key), modulename);
  }
  else
  {
    g_hash_table_remove(module->raster_mask.source.masks, GINT_TO_POINTER(key));
  }
}
 
gboolean dt_iop_module_has_raster_mask(const dt_iop_module_t *module)
{
  if(IS_NULL_PTR(module)) return FALSE;
 
  const gboolean mask_mode_raster = module->blend_params
                                    && ((module->blend_params->mask_mode & DEVELOP_MASK_RASTER) == DEVELOP_MASK_RASTER);
  const gboolean has_raster_sink = (!IS_NULL_PTR(module->raster_mask.sink.source));
 
  return mask_mode_raster || has_raster_sink;
}
 
gboolean dt_iop_module_needs_mask_history_ext(const dt_iop_module_t *module, gboolean *raster, gboolean *drawn, gboolean *parametric)
{
  gboolean raster_used = FALSE;
  gboolean drawn_used = FALSE;
  gboolean parametric_used = FALSE;
  if(IS_NULL_PTR(module)) return FALSE;
 
  const gboolean supports_blending
      = ((module->flags() & IOP_FLAGS_SUPPORTS_BLENDING) == IOP_FLAGS_SUPPORTS_BLENDING);
  const gboolean internal_masks = ((module->flags() & IOP_FLAGS_INTERNAL_MASKS) == IOP_FLAGS_INTERNAL_MASKS);
 
  if(!supports_blending) return internal_masks;
  if(IS_NULL_PTR(module->blend_params)) return internal_masks;
 
  dt_develop_blend_get_mask_usage(module, module->blend_params, NULL, &raster_used, &drawn_used, &parametric_used);
 
  if(!IS_NULL_PTR(raster)) *raster = raster_used;
  if(!IS_NULL_PTR(drawn)) *drawn = drawn_used;
  if(!IS_NULL_PTR(parametric)) *parametric = parametric_used;
 
  return raster_used || drawn_used || parametric_used || internal_masks;
}
 
gboolean dt_iop_module_needs_mask_history(const dt_iop_module_t *module)
{
  return dt_iop_module_needs_mask_history_ext(module, NULL, NULL, NULL);
}
 
// make sure that blend_params are in sync with the iop struct
void dt_iop_commit_blend_params(dt_iop_module_t *module, const dt_develop_blend_params_t *blendop_params)
{
  if(module->raster_mask.sink.source)
    g_hash_table_remove(module->raster_mask.sink.source->raster_mask.source.users, module);
 
  if(module->blend_params != blendop_params)
    memcpy(module->blend_params, blendop_params, sizeof(dt_develop_blend_params_t));
 
  if(blendop_params->blend_cst == DEVELOP_BLEND_CS_NONE)
  {
    module->blend_params->blend_cst = dt_develop_blend_default_module_blend_colorspace(module);
  }
  dt_iop_set_mask_mode(module, blendop_params->mask_mode);
 
  // This assumes that the module providing raster mask to the current one is ALWAYS
  // MANDATORILY before the current one BOTH in history order AND in pipe order,
  // because the current function is run in history order when we load/reload/pop history
  if(module->dev)
    for(GList *iter = g_list_first(module->dev->iop); iter; iter = g_list_next(iter))
    {
      dt_iop_module_t *m = (dt_iop_module_t *)iter->data;
      if(!strcmp(m->op, blendop_params->raster_mask_source))
      {
        if(m->multi_priority == blendop_params->raster_mask_instance)
        {
          g_hash_table_insert(m->raster_mask.source.users, module, GINT_TO_POINTER(blendop_params->raster_mask_id));
          dt_print(DT_DEBUG_MASKS, "[raster masks] Committing raster mask from %s (%s) into %s (%s)\n", m->op, m->multi_name, module->op,
                  module->multi_name);
          module->raster_mask.sink.source = m;
          module->raster_mask.sink.id = blendop_params->raster_mask_id;
          return;
        }
      }
    }
  // else if no module->dev, it means we are only loading module's .so
 
  module->raster_mask.sink.source = NULL;
  module->raster_mask.sink.id = 0;
}
 
gboolean _iop_validate_params(dt_introspection_field_t *field, gpointer params, gboolean report)
{
  dt_iop_params_t *p = (dt_iop_params_t *)((uint8_t *)params + field->header.offset);
 
  gboolean all_ok = TRUE;
 
  switch(field->header.type)
  {
  case DT_INTROSPECTION_TYPE_STRUCT:
    for(int i = 0; i < field->Struct.entries; i++)
    {
      dt_introspection_field_t *entry = field->Struct.fields[i];
 
      all_ok &= _iop_validate_params(entry, params, report);
    }
    break;
  case DT_INTROSPECTION_TYPE_UNION:
    all_ok = FALSE;
    for(int i = field->Union.entries - 1; i >= 0 ; i--)
    {
      dt_introspection_field_t *entry = field->Union.fields[i];
 
      if(_iop_validate_params(entry, params, report && i == 0))
      {
        all_ok = TRUE;
        break;
      }
    }
    break;
  case DT_INTROSPECTION_TYPE_ARRAY:
    if(field->Array.type == DT_INTROSPECTION_TYPE_CHAR)
    {
      if(!memchr(p, '\0', field->Array.count))
      {
        if(report)
          fprintf(stderr, "validation check failed in _iop_validate_params for type \"%s\"; string not null terminated.\n",
                          field->header.type_name);
        all_ok = FALSE;
      }
    }
    else
    {
      for(int i = 0, item_offset = 0; i < field->Array.count; i++, item_offset += field->Array.field->header.size)
      {
        if(!_iop_validate_params(field->Array.field, (uint8_t *)params + item_offset, report))
        {
          if(report)
            fprintf(stderr, "validation check failed in _iop_validate_params for type \"%s\", for array element \"%d\"\n",
                            field->header.type_name, i);
          all_ok = FALSE;
          break;
        }
      }
    }
    break;
  case DT_INTROSPECTION_TYPE_FLOAT:
    all_ok = isnan(*(float*)p) || ((*(float*)p >= field->Float.Min && *(float*)p <= field->Float.Max));
    break;
  case DT_INTROSPECTION_TYPE_INT:
    all_ok = (*(int*)p >= field->Int.Min && *(int*)p <= field->Int.Max);
    break;
  case DT_INTROSPECTION_TYPE_UINT:
    all_ok = (*(unsigned int*)p >= field->UInt.Min && *(unsigned int*)p <= field->UInt.Max);
    break;
  case DT_INTROSPECTION_TYPE_USHORT:
    all_ok = (*(unsigned short int*)p >= field->UShort.Min && *(unsigned short int*)p <= field->UShort.Max);
    break;
  case DT_INTROSPECTION_TYPE_INT8:
    all_ok = (*(uint8_t*)p >= field->Int8.Min && *(uint8_t*)p <= field->Int8.Max);
    break;
  case DT_INTROSPECTION_TYPE_CHAR:
    all_ok = (*(char*)p >= field->Char.Min && *(char*)p <= field->Char.Max);
    break;
  case DT_INTROSPECTION_TYPE_FLOATCOMPLEX:
    all_ok = creal(*(float complex*)p) >= creal(field->FloatComplex.Min) &&
             creal(*(float complex*)p) <= creal(field->FloatComplex.Max) &&
             cimag(*(float complex*)p) >= cimag(field->FloatComplex.Min) &&
             cimag(*(float complex*)p) <= cimag(field->FloatComplex.Max);
    break;
  case DT_INTROSPECTION_TYPE_ENUM:
    all_ok = FALSE;
    for(dt_introspection_type_enum_tuple_t *i = field->Enum.values; i && i->name; i++)
    {
      if(i->value == *(int*)p)
      {
        all_ok = TRUE;
        break;
      }
    }
    break;
  case DT_INTROSPECTION_TYPE_BOOL:
    // *(gboolean*)p
    break;
  case DT_INTROSPECTION_TYPE_OPAQUE:
    // TODO: special case float2
    break;
  default:
    fprintf(stderr, "unsupported introspection type \"%s\" encountered in _iop_validate_params (field %s)\n",
                    field->header.type_name, field->header.name);
    all_ok = FALSE;
    break;
  }
 
  if(!all_ok && report)
    fprintf(stderr, "validation check failed in _iop_validate_params for type \"%s\"%s%s\n",
                    field->header.type_name, (*field->header.name ? ", field: " : ""), field->header.name);
 
  return all_ok;
}
 
 
gboolean dt_iop_check_modules_equal(dt_iop_module_t *mod_1, dt_iop_module_t *mod_2)
{
  // Use module fingerprints to determine if two instances are actually the same
  return mod_1 == mod_2
          && mod_1->instance == mod_2->instance
          && mod_1->multi_priority == mod_2->multi_priority
          && mod_1->iop_order == mod_2->iop_order;
}
 
 
void _hash_raster_masks(gpointer key, gpointer value, uint64_t *hash)
{
  dt_iop_module_t *module = (dt_iop_module_t *)key;
 
  // Use only "constant" module params with regard to the pipeline
  // init/resync aka we can't use any module pre-computed hash.
  *hash = dt_hash(*hash, (char *)module->op, sizeof(module->op));
  *hash = dt_hash(*hash, (char *)&module->iop_order, sizeof(module->iop_order));
  *hash = dt_hash(*hash, (char *)&module->instance, sizeof(module->instance));
  *hash = dt_hash(*hash, (char *)&module->multi_priority, sizeof(module->multi_priority));
  *hash = dt_hash(*hash, (char *)module->blend_params, sizeof(dt_develop_blend_params_t));
}
 
 
void dt_iop_compute_blendop_hash(dt_iop_module_t *module, uint64_t hash, GList *masks)
{
  // Blend params are always inited even when module doesn't support blending
  hash = dt_hash(hash, (char *)module->blend_params, sizeof(dt_develop_blend_params_t));
 
  if(module->flags() & IOP_FLAGS_SUPPORTS_BLENDING)
  {
    // Drawn masks from dev for this module
    if(!IS_NULL_PTR(masks))
    {
      dt_masks_form_t *grp = dt_masks_get_from_id_ext(masks, module->blend_params->mask_id);
      hash = dt_masks_group_get_hash(hash, grp);
    }
 
    // else : no module->dev when running from init_default_params()
 
    // If module PROVIDES raster masks to others later in the pipe:
    // Account for later modules that reuse the raster mask provided by the current module.
    // This is a little cache invalidation trick: we change the final piece hash of this module,
    // to signal to the pipeline that it needs to recompute from lower than just the last changed module,
    // if that module references the raster mask produced here.
    // This contains the list of consumer modules:
    g_hash_table_foreach(module->raster_mask.source.users, (GHFunc)_hash_raster_masks, (gpointer)&hash);
 
    // module->raster_mask.source.masks contains only one mask as of now,
    // aka its blendop output, so no need to iterate over that.
 
    // If module CONSUMES raster masks from a module earlier in the pipe:
    // Account for its blendops.
    dt_iop_module_t *raster_source = module->raster_mask.sink.source;
    if(raster_source)
    {
      // Drawn masks
      if(!IS_NULL_PTR(masks))
      {
        dt_masks_form_t *raster_grp = dt_masks_get_from_id_ext(masks, raster_source->blend_params->mask_id);
        hash = dt_masks_group_get_hash(hash, raster_grp);
      }
 
      // Blending
      hash = dt_hash(hash, (char *)raster_source->blend_params, sizeof(dt_develop_blend_params_t));
    }
  }
 
  module->blendop_hash = hash;
}
 
 
void dt_iop_compute_module_hash(dt_iop_module_t *module, GList *masks)
{
  // Uniform way of getting the full state hash of user-defined parameters,
  // including masks and blending.
  // WARNING: doesn't take into account parameters dynamically set at runtime.
 
  uint64_t hash = dt_hash(5381, (char *)module->op, sizeof(dt_dev_operation_t));
  hash = dt_hash(hash, (char *)&module->enabled, sizeof(gboolean));
  hash = dt_hash(hash, (char *)&module->instance, sizeof(int32_t));
  hash = dt_hash(hash, (char *)&module->multi_priority, sizeof(int));
  hash = dt_hash(hash, (char *)&module->iop_order, sizeof(int));
 
  // Compute stand-alone blendop hash (mask hash) from the above
  // save to module->blendop_hash
  dt_iop_compute_blendop_hash(module, hash, masks);
 
  // Finish our module-wide (output) hash
  hash = dt_hash(hash, (char *)module->params, module->params_size);
  hash = dt_hash(hash, (char *)&module->blendop_hash, sizeof(uint64_t));
 
  module->hash = hash;
}
 
void dt_iop_commit_params(dt_iop_module_t *module, dt_iop_params_t *params,
                          dt_develop_blend_params_t *blendop_params, dt_dev_pixelpipe_t *pipe,
                          dt_dev_pixelpipe_iop_t *piece)
{
  // We need to commit also modules that are disabled because some of them
  // may self-enabled at commit time, depending on image input.
  // 1. commit params
  memcpy(piece->blendop_data, blendop_params, sizeof(dt_develop_blend_params_t));
 
#ifdef HAVE_OPENCL
  // assume process_cl is ready, commit_params can overwrite this.
  if(module->process_cl)
    piece->process_cl_ready = 1;
 
  piece->cache_output_on_ram = 0;
#endif // HAVE_OPENCL
 
  // register if module allows tiling, commit_params can overwrite this.
  if(module->flags() & IOP_FLAGS_ALLOW_TILING)
    piece->process_tiling_ready = 1;
 
  if(darktable.unmuted & DT_DEBUG_PARAMS && module->so->get_introspection())
    _iop_validate_params(module->so->get_introspection()->field, params, TRUE);
 
  module->commit_params(module, params, pipe, piece);
 
  gchar *string = g_strdup_printf("/plugins/%s/opencl", module->op);
 
  if(!dt_conf_key_exists(string) || !dt_conf_key_not_empty(string)) 
      dt_conf_set_bool(string, TRUE);
 
  piece->process_cl_ready &= dt_conf_get_bool(string);
  dt_free(string);
 
  //uint64_t old_hash = module->hash;
 
  // 2. Update the internal hash
  // We need to update the blendop params dynamically, because drawn masks (forms)
  // belong to pipeline not to modules user params, and raster masks travel through the pipe.
  // So, module's blendops depend on the current and whole state of dev->forms if they use them
  dt_iop_compute_module_hash(module, module->dev->forms);
 
  uint64_t hash = module->hash;
 
  //if(old_hash != hash)
  //  fprintf(stdout, "WARNING: hash changed at history -> pipeline commit time for %s\n", module->op);
 
  /* Some modules seal part of their effective runtime contract only in commit_params(),
   * after reading GUI-only state, pipe mode, or other non-history inputs. Those modules
   * must opt in explicitly, because piece->data may also contain transient pointers or
   * scratch state for other modules and therefore cannot be hashed blindly. */
  if(module->runtime_data_hash(module, pipe, piece))
  {
    hash = dt_hash(hash, (const char *)piece->data, piece->data_size);
  }
 
  piece->global_hash = piece->hash = hash;
  piece->global_mask_hash = piece->blendop_hash = module->blendop_hash;
 
  dt_print(DT_DEBUG_PARAMS, "[pixelpipe] params commit for %s (%s) in pipe %s with hash %" PRIu64 "\n", 
           module->op, module->multi_name, 
           dt_pixelpipe_get_pipe_name(pipe->type), piece->hash);
}
 
static void _iop_gui_widget_gone(gpointer user_data, GObject *where_the_object_was)
{
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
  if(IS_NULL_PTR(module)) return;
 
  if(module->header == (GtkWidget *)where_the_object_was) module->header = NULL;
  if(module->expander == (GtkWidget *)where_the_object_was) module->expander = NULL;
 
  if(IS_NULL_PTR(darktable.gui)) return;
 
  if(darktable.gui->scroll_to[0] == (GtkWidget *)where_the_object_was) darktable.gui->scroll_to[0] = NULL;
  if(darktable.gui->scroll_to[1] == (GtkWidget *)where_the_object_was) darktable.gui->scroll_to[1] = NULL;
  if(darktable.gui->scroll_to_header_once == (GtkWidget *)where_the_object_was) darktable.gui->scroll_to_header_once = NULL;
}
 
void dt_iop_gui_cleanup_module(dt_iop_module_t *module)
{
  if(IS_NULL_PTR(module)) return;
  dt_gui_module_t *mod = (dt_gui_module_t *)module;
  if(!IS_NULL_PTR(module->dev) && module->dev->gui_module == module) module->dev->gui_module = NULL;
 
  // remove multiple delayed gtk_widget_queue_draw triggers
  if(module->widget)
    while(g_idle_remove_by_data(module->widget));
 
  // Detach accels. accel_path is only ever set by dt_iop_gui_init() (never for a module that was
  // only backend-loaded, e.g. studio_capture's dev->iop -- see studio-capture.md): a NULL path
  // here means there is nothing registered to remove, and dt_accels_remove_accel() would
  // otherwise g_strrstr() every entry in accels->acceleratables against a NULL needle, tripping
  // a GLib-CRITICAL for each one.
  if(!dt_iop_is_hidden(module) && !(module->flags() & IOP_FLAGS_DEPRECATED) && !IS_NULL_PTR(mod->accel_path))
  {
    dt_accels_remove_accel(darktable.gui->accels, mod->accel_path, module);
    dt_free(mod->accel_path);
  }
 
  if(mod->instance_name)
  {
    char *instance_path = dt_accels_build_path(_("Darkroom/Modules/Instances"), mod->instance_name);
    dt_accels_remove_shortcut(darktable.gui->accels, instance_path);
    dt_free(instance_path);
  }
 
  dt_free(mod->instance_name);
 
  // widget_list doesn't own the widget referenced, so don't deep_free
  dt_gui_module_t *m = DT_GUI_MODULE(module);
  g_list_free(m->widget_list);
  m->widget_list = NULL;
  g_list_free(m->widget_list_bh);
  m->widget_list_bh = NULL;
  dt_free(m->name);
  m->name = NULL;
  dt_free(m->view);
  m->view = NULL;
 
  if(module->color_picker_apply)
  {
    DT_DEBUG_CONTROL_SIGNAL_DISCONNECT(darktable.signals, G_CALLBACK(_iop_color_picker_data_ready_callback), module);
  }
  // History refresh can delete pipeline-only modules created for ordering/history
  // resolution. They have a module GUI cleanup callback but no module GUI data.
  if(module->gui_cleanup && !IS_NULL_PTR(module->gui_data))
    module->gui_cleanup(module);
  dt_iop_gui_cleanup_blending(module);
 
  // size-allocate callbacks can still read scroll targets while GTK tears down widgets
  if(!IS_NULL_PTR(darktable.gui))
  {
    if(darktable.gui->scroll_to[0] == module->header || darktable.gui->scroll_to[0] == module->expander)
      darktable.gui->scroll_to[0] = NULL;
    if(darktable.gui->scroll_to[1] == module->header || darktable.gui->scroll_to[1] == module->expander)
      darktable.gui->scroll_to[1] = NULL;
    if(darktable.gui->scroll_to_header_once == module->expander)
      darktable.gui->scroll_to_header_once = NULL;
  }
 
  /* Release the transient widget tree explicitly. In normal GUI lifetime, these
   * widgets are parented and get destroyed by container teardown. During module
   * probe/init paths, they can stay unparented and would otherwise leak. */
  if(!IS_NULL_PTR(module->expander) && GTK_IS_WIDGET(module->expander))
  {
    GtkWidget *expander = module->expander;
    g_object_ref_sink(expander);
    gtk_widget_destroy(expander);
    g_object_unref(expander);
  }
  else
  {
    if(!IS_NULL_PTR(module->header) && GTK_IS_WIDGET(module->header))
    {
      GtkWidget *header = module->header;
      g_object_ref_sink(header);
      gtk_widget_destroy(header);
      g_object_unref(header);
    }
 
    if(!IS_NULL_PTR(module->widget) && GTK_IS_WIDGET(module->widget))
    {
      GtkWidget *widget = module->widget;
      g_object_ref_sink(widget);
      gtk_widget_destroy(widget);
      g_object_unref(widget);
    }
  }
 
  module->widget = NULL;
  module->header = NULL;
  module->expander = NULL;
  module->off = NULL;
}
 
void dt_iop_gui_update(dt_iop_module_t *module)
{
  dt_gui_freeze_begin();
  if(!dt_iop_is_hidden(module))
  {
    if(module->gui_data)
    {
      dt_bauhaus_update_module(module);
 
      if(module->params && module->gui_update)
        module->gui_update(module);
 
      dt_iop_gui_update_blending(module);
      dt_iop_gui_update_expanded(module);
    }
    dt_iop_gui_update_header(module);
  }
  dt_gui_freeze_end();
}
 
void dt_iop_gui_reset(dt_iop_module_t *module)
{
  dt_gui_freeze_begin();
  if(module->gui_reset && !dt_iop_is_hidden(module)) module->gui_reset(module);
  dt_gui_freeze_end();
}
 
static void _gui_reset_callback(GtkButton *button, GdkEventButton *event, dt_iop_module_t *module)
{
  // never use the callback if module is always disabled
  const gboolean disabled = !module->default_enabled && module->hide_enable_button;
  if(disabled) return;
 
  //Ctrl is used to apply any auto-presets to the current module
  //If Ctrl was not pressed, or no auto-presets were applied, reset the module parameters
  // FIXME: can we stop with all the easter-eggs key modifiers doing undocumented stuff all along ?
  if(!(event && dt_modifier_is(event->state, GDK_CONTROL_MASK)) || !dt_gui_presets_autoapply_for_module(module))
  {
    /* Resetting a module's parameters does not change GUI focus, so the
       focus-loss cleanup in dt_iop_request_focus() never runs here: an active
       eye-dropper (this module's own, or its blending/masking parametric-mask
       picker -- both share dev->color_picker) and any live mask-shape editing
       state (edit mode, shape buttons, mask/channel display) must be turned
       off explicitly, or they keep sampling/drawing on the image against
       parameters that no longer exist. */
    dt_iop_color_picker_reset(module, FALSE);
    dt_iop_gui_blending_lose_focus(module);
 
    // if a drawn mask is set, remove it from the list
    if(module->blend_params->mask_id > 0)
    {
      dt_masks_form_t *grp = dt_masks_get_from_id(darktable.develop, module->blend_params->mask_id);
      // FIXME: ask the user if he wants to delete the mask, or just unlink them.
      if(grp) dt_masks_form_delete(module, NULL, grp);
      DT_DEBUG_CONTROL_SIGNAL_RAISE(darktable.signals, DT_SIGNAL_MASK_CHANGED, -1, -1, DT_MASKS_EVENT_RESET);
    }
    /* reset to default params */
    dt_iop_reload_defaults(module);
    dt_iop_commit_blend_params(module, module->default_blendop_params);
 
    /* reset ui to its defaults */
    dt_iop_gui_reset(module);
 
    /* update ui to default params*/
    dt_iop_gui_update(module);
 
    dt_dev_add_history_item(module->dev, module, TRUE, TRUE);
  }
}
 
static void _presets_popup_callback(GtkButton *button, dt_iop_module_t *module)
{
  const gboolean disabled = !module->default_enabled && module->hide_enable_button;
  if(disabled) return;
 
  dt_gui_presets_popup_menu_show_for_module(module);
 
  if(!IS_NULL_PTR(module->expander) && !IS_NULL_PTR(darktable.gui->presets_popup_menu))
  {
    g_object_set_data(G_OBJECT(module->expander), DT_IOP_HEADER_MENU_OPEN, GINT_TO_POINTER(TRUE));
    g_signal_connect_data(G_OBJECT(darktable.gui->presets_popup_menu), "deactivate",
                          G_CALLBACK(_iop_plugin_header_menu_deactivate),
                          g_object_ref(module->expander), (GClosureNotify)g_object_unref, 0);
  }
 
  dt_gui_menu_popup(darktable.gui->presets_popup_menu, GTK_WIDGET(button), GDK_GRAVITY_SOUTH_EAST, GDK_GRAVITY_NORTH_EAST);
}
 
void dt_iop_request_focus(dt_iop_module_t *module)
{
  dt_iop_module_t *out_focus_module = darktable.develop->gui_module;
 
  if(dt_gui_widgets_suppressed() || (out_focus_module == module)) return;
 
  darktable.develop->gui_module = module;
  if(!IS_NULL_PTR(module))
  {
    const gboolean scroll_new_instance_to_header
      = (darktable.gui->scroll_to_header_once == module->expander
         && !IS_NULL_PTR(module->header) && GTK_IS_WIDGET(module->header));
    darktable.gui->scroll_to[1] = scroll_new_instance_to_header ? module->header : module->expander;
  }
 
  /* lets lose the focus of previous focus module*/
  if(out_focus_module)
  {
    GtkWidget *out_focus_widget = dt_iop_gui_get_pluginui(out_focus_module);
    GtkWidget *scroll_focus = darktable.gui->has_scroll_focus;
    if(scroll_focus && out_focus_widget && gtk_widget_is_ancestor(scroll_focus, out_focus_widget))
    {
      darktable.gui->has_scroll_focus = NULL;
      gtk_widget_queue_draw(scroll_focus);
    }
 
    if(out_focus_module->gui_focus)
      out_focus_module->gui_focus(out_focus_module, FALSE);
 
    /* A module that loses focus (switching to another module, or collapsing the
       focused module, which calls dt_iop_request_focus(NULL)) must not leave an
       active picker sampling/drawn on the image behind it: the picker's own
       "must have GUI focus" invariant only hides its on-screen overlay, it does
       not stop it or reset the toggle button, so a stale enabled picker can
       resurface unexpectedly (e.g. when the module's GUI is rebuilt). A real
       reset (keep = FALSE) is required here, not the "preserve across a soft
       refresh" keep = TRUE used by gui_update()/gui_changed() call sites. */
    dt_iop_color_picker_reset(out_focus_module, FALSE);
    dt_gui_refocus_center();
 
    gtk_widget_set_state_flags(dt_iop_gui_get_pluginui(out_focus_module), GTK_STATE_FLAG_NORMAL, TRUE);
 
    /* reset mask view */
    dt_masks_reset_form_gui();
 
    /* do stuff needed in the blending gui */
    dt_iop_gui_blending_lose_focus(out_focus_module);
 
    /* redraw the expander */
    gtk_widget_queue_draw(out_focus_module->expander);
 
    /* and finally collection restore hinter messages */
    dt_collection_hint_message(darktable.collection);
 
    // we also remove the focus css class
    GtkWidget *iop_w = gtk_widget_get_parent(dt_iop_gui_get_pluginui(out_focus_module));
    dt_gui_remove_class(iop_w, "dt_module_focus");
  }
 
  /* set the focus on module */
  if(!IS_NULL_PTR(module))
  {
    // In case we tried giving focus to a module that is not in the visible tab
    dt_dev_modulegroups_switch_tab(module->dev, module);
 
    gtk_widget_set_state_flags(dt_iop_gui_get_pluginui(module), GTK_STATE_FLAG_SELECTED, TRUE);
 
    if(module->gui_focus) module->gui_focus(module, TRUE);
 
    /* redraw the expander */
    gtk_widget_queue_draw(module->expander);
    gtk_widget_grab_focus(module->expander);
 
    /* set the focus on the first child to enable arrow-key navigation and accessibility stuff */
    GList *widget_list = ((dt_gui_module_t *)module)->widget_list;
    if(widget_list)
    {
      GList *first_child = g_list_first(widget_list);
      if(first_child)
      {
        GtkWidget *widget = (GtkWidget *)first_child->data;
        if(widget) gtk_widget_grab_focus(widget);
      }
    }
 
    // we also add the focus css class
    GtkWidget *iop_w = gtk_widget_get_parent(dt_iop_gui_get_pluginui(darktable.develop->gui_module));
    dt_gui_add_class(iop_w, "dt_module_focus");
  }
 
  DT_DEBUG_CONTROL_SIGNAL_RAISE(darktable.signals, DT_SIGNAL_DEVELOP_MASKS_GUI_CHANGED);
  dt_control_queue_cursor(GDK_LEFT_PTR);
  dt_control_queue_redraw_center();
}
 
/*
 * NEW EXPANDER
 */
 
static void _gui_set_single_expanded(dt_iop_module_t *module, gboolean expanded)
{
  if(IS_NULL_PTR(module->expander)) return;
 
  /* update expander arrow state */
  dtgtk_expander_set_expanded(DTGTK_EXPANDER(module->expander), expanded);
 
  /* store expanded state of module.
   * we do that first, so update_expanded won't think it should be visible
   * and undo our changes right away. */
  module->expanded = expanded;
 
  /* show / hide plugin widget */
  if(expanded)
  {
    /* set this module to receive focus / draw events*/
    dt_iop_request_focus(module);
 
    /* focus the current module */
    for(int k = 0; k < DT_UI_CONTAINER_SIZE; k++)
      dt_ui_container_focus_widget(darktable.gui->ui, k, module->expander);
 
    /* redraw center, iop might have post expose */
    dt_control_queue_redraw_center();
  }
  else
  {
    if(module->dev->gui_module == module)
    {
      dt_iop_request_focus(NULL);
      dt_control_queue_redraw_center();
    }
  }
 
  if(expanded)
    dt_gui_add_class(module->expander, "expanded");
  else
    dt_gui_remove_class(module->expander, "expanded");
 
  char var[1024];
  snprintf(var, sizeof(var), "plugins/darkroom/%s/expanded", module->op);
  dt_conf_set_bool(var, expanded);
}
 
void _iop_dim_all_but(dt_iop_module_t *module, gboolean dim)
{
  for(GList *iop = g_list_first(darktable.develop->iop); iop; iop = g_list_next(iop))
  {
    dt_iop_module_t *m = (dt_iop_module_t *)iop->data;
 
    // Handle invisible modules
    if(IS_NULL_PTR(m) || !m->expander) continue;
 
    if(dim && m != module)
      dt_gui_add_class(gtk_widget_get_parent(dt_iop_gui_get_pluginui(m)), "module-dimmed");
    else
      dt_gui_remove_class(gtk_widget_get_parent(dt_iop_gui_get_pluginui(m)), "module-dimmed");
  }
}
 
void dt_iop_gui_set_expanded(dt_iop_module_t *module, gboolean expanded, gboolean collapse_others)
{
  if(IS_NULL_PTR(module) || !module->expander) return;
  if(collapse_others)
  {
    for(GList *iop = g_list_first(darktable.develop->iop); iop; iop = g_list_next(iop))
    {
      dt_iop_module_t *m = (dt_iop_module_t *)iop->data;
      if(m != module) _gui_set_single_expanded(m, FALSE);
    }
  }
 
  _gui_set_single_expanded(module, expanded);
  _iop_dim_all_but((expanded) ? module : NULL, expanded);
  gtk_widget_queue_draw(module->widget);
}
 
void dt_iop_gui_update_expanded(dt_iop_module_t *module)
{
  if(IS_NULL_PTR(module->expander)) return;
 
  const gboolean expanded = module->expanded;
 
  dtgtk_expander_set_expanded(DTGTK_EXPANDER(module->expander), expanded);
}
 
static gboolean _iop_plugin_body_button_press(GtkWidget *w, GdkEventButton *e, gpointer user_data)
{
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
 
  /* Reset the scrolling focus. If the click happened on any bauhaus element,
   * its internal button_press method will set it for itself */
  darktable.gui->has_scroll_focus = NULL;
 
  gboolean handled = FALSE;
 
  if(e->button == 1)
  {
    dt_iop_request_focus(module);
    handled = TRUE;
  }
  else if(e->button == 3)
  {
    _presets_popup_callback(NULL, module);
    handled = TRUE;
  }
  return handled;
}
 
static gboolean _iop_plugin_header_activate(GtkWidget* self, gboolean group_cycling, gpointer user_data)
{
  dt_gui_module_t *module = (dt_gui_module_t *)user_data;
  if(IS_NULL_PTR(module) || !module->focus) return FALSE;
  return module->focus(module, TRUE);
}
 
static gboolean _iop_plugin_header_child_button_press(GtkWidget *widget, GdkEventButton *event, gpointer user_data)
{
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
  if(module && module->expander)
    g_object_set_data(G_OBJECT(module->expander), "dt-module-header-child-click", GINT_TO_POINTER(TRUE));
 
  return FALSE;
}
 
static gboolean _iop_plugin_focus_accel(GtkAccelGroup *accel_group, GObject *accelerable, guint keyval,
                                        GdkModifierType modifier, gpointer data)
{
  dt_gui_module_t *module = (dt_gui_module_t *)data;
  dt_iop_module_t *iop = (dt_iop_module_t *)data;
  if(IS_NULL_PTR(module) || !module->focus) return FALSE;
 
  // Accel search explicitly targets a module, so allow modulegroups to leave
  // the Pipeline tab once for this focus request.
  if(iop->expander)
    g_object_set_data(G_OBJECT(iop->expander), "dt-modulegroups-switch-from-active-once",
                      GINT_TO_POINTER(TRUE));
 
  return module->focus(module, FALSE);
}
 
static gboolean _iop_plugin_enable_accel(GtkAccelGroup *accel_group, GObject *accelerable, guint keyval,
                                         GdkModifierType modifier, gpointer data)
{
  dt_iop_module_t *module = (dt_iop_module_t *)data;
  if(IS_NULL_PTR(module)) return FALSE;
 
  // Direct actions from accel search should prioritize Pipeline when they focus
  // the edited module right after applying the change.
  if(!IS_NULL_PTR(module->expander))
    g_object_set_data(G_OBJECT(module->expander), "dt-modulegroups-prefer-active-once",
                      GINT_TO_POINTER(TRUE));
 
  // Kind of ugly to go through history to change module GUI state
  // FIXME: we should have a GUI callback that enables module and dispatches history instead, 
  // history should not care about module GUI. This is a wrong, reversed inheritance.
  if(!module->hide_enable_button)
  {
    module->enabled = TRUE;
    dt_dev_add_history_item(module->dev, module, TRUE, TRUE);
  }
 
  dt_iop_request_focus(module);
  dt_iop_gui_set_expanded(module, TRUE, TRUE);
  return TRUE;
}
 
static gboolean _iop_plugin_header_button_press(GtkWidget *w, GdkEventButton *e, gpointer user_data)
{
  if(e->type == GDK_2BUTTON_PRESS || e->type == GDK_3BUTTON_PRESS) return TRUE;
 
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
  if(IS_NULL_PTR(module)) return FALSE;
 
  if(!IS_NULL_PTR(module->expander)
     && (g_object_get_data(G_OBJECT(module->expander), DT_IOP_HEADER_MENU_OPEN)
         || g_object_get_data(G_OBJECT(module->expander), DT_IOP_HEADER_MENU_DISMISS_CLICK)))
  {
    g_object_set_data(G_OBJECT(module->expander), DT_IOP_HEADER_IGNORE_RELEASE, GINT_TO_POINTER(TRUE));
    return TRUE;
  }
 
  /* Reset the scrolling focus. If the click happened on any bauhaus element,
   * its internal button_press method will set it for itself */
  darktable.gui->has_scroll_focus = NULL;
 
  if(e->button == 1)
  {
    if(module->expander) g_object_set_data(G_OBJECT(module->expander), "dt-module-dragged", NULL);
 
    if(!dt_modifier_is(e->state, GDK_CONTROL_MASK))
    {
      return FALSE;
    }
    else
    {
      if(module->expander)
        g_object_set_data(G_OBJECT(module->expander), DT_IOP_HEADER_IGNORE_RELEASE, GINT_TO_POINTER(TRUE));
      dt_iop_gui_rename_module(module);
      return TRUE;
    }
  }
  else if(e->button == 3)
  {
    _presets_popup_callback(NULL, module);
 
    return TRUE;
  }
  return FALSE;
}
 
static gboolean _iop_plugin_header_button_release(GtkWidget *w, GdkEventButton *e, gpointer user_data)
{
  if(e->button != 1 || e->type != GDK_BUTTON_RELEASE) return FALSE;
 
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
  if(IS_NULL_PTR(module) || !module->expander) return FALSE;
 
  if(g_object_get_data(G_OBJECT(module->expander), DT_IOP_HEADER_IGNORE_RELEASE))
  {
    g_object_set_data(G_OBJECT(module->expander), DT_IOP_HEADER_IGNORE_RELEASE, NULL);
    return TRUE;
  }
 
  if(g_object_get_data(G_OBJECT(module->expander), DT_IOP_HEADER_MENU_OPEN)
     || g_object_get_data(G_OBJECT(module->expander), DT_IOP_HEADER_MENU_DISMISS_CLICK))
  {
    return TRUE;
  }
 
  if(g_object_get_data(G_OBJECT(module->expander), "dt-module-header-child-click"))
  {
    g_object_set_data(G_OBJECT(module->expander), "dt-module-header-child-click", NULL);
    return FALSE;
  }
 
  if(g_object_get_data(G_OBJECT(module->expander), "dt-module-dragged"))
  {
    g_object_set_data(G_OBJECT(module->expander), "dt-module-dragged", NULL);
    return TRUE;
  }
 
  // make gtk scroll to the module once it updated its allocation size
  const gboolean collapse_others = dt_modifier_is(e->state, GDK_SHIFT_MASK) ? FALSE : TRUE;
  dt_iop_request_focus(module);
  dt_iop_gui_set_expanded(module, !module->expanded, collapse_others);
 
  return TRUE;
}
 
static void _display_mask_indicator_callback(GtkToggleButton *bt, dt_iop_module_t *module)
{
  if(dt_gui_widgets_suppressed()) return;
 
  const gboolean is_active = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(bt));
  const dt_iop_gui_blend_data_t *bd = (dt_iop_gui_blend_data_t *)module->blend_data;
 
  module->request_mask_display
      &= ~(DT_DEV_PIXELPIPE_DISPLAY_MASK | DT_DEV_PIXELPIPE_DISPLAY_CHANNEL
           | DT_DEV_PIXELPIPE_DISPLAY_ANY | DT_DEV_PIXELPIPE_DISPLAY_STICKY);
 
  if(is_active)
    module->request_mask_display |= DT_DEV_PIXELPIPE_DISPLAY_MASK;
 
  dt_iop_set_cache_bypass(module, module->request_mask_display != DT_DEV_PIXELPIPE_DISPLAY_NONE);
 
  // set the module show mask button too
  if(bd->showmask)
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(bd->showmask), is_active);
 
  dt_gui_freeze_begin();
  if(GTK_IS_TOGGLE_BUTTON(bd->filter[0].channel_display))
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(bd->filter[0].channel_display), FALSE);
  if(GTK_IS_TOGGLE_BUTTON(bd->filter[1].channel_display))
    gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(bd->filter[1].channel_display), FALSE);
  dt_gui_freeze_end();
 
  dt_iop_request_focus(module);
  dt_dev_pixelpipe_update_history_main(module->dev);
}
 
static void _mask_indicator_get_usage(dt_iop_module_t *module, gboolean *top_enabled, gboolean *raster_used,
                                      gboolean *drawn_used, gboolean *parametric_used)
{
  if(!IS_NULL_PTR(top_enabled)) *top_enabled = FALSE;
  if(!IS_NULL_PTR(raster_used)) *raster_used = FALSE;
  if(!IS_NULL_PTR(drawn_used)) *drawn_used = FALSE;
  if(!IS_NULL_PTR(parametric_used)) *parametric_used = FALSE;
 
  if(IS_NULL_PTR(module) || IS_NULL_PTR(module->blend_params)) return;
 
  const dt_iop_gui_blend_data_t *bd = (const dt_iop_gui_blend_data_t *)module->blend_data;
  gboolean top = FALSE;
  gboolean raster = FALSE;
  gboolean drawn = FALSE;
  gboolean parametric = FALSE;
  dt_develop_blend_get_mask_usage(module, module->blend_params, &top, &raster, &drawn, &parametric);
 
  // look if the user disabled masks modes
 
  // raster mask must be enabled and a raster mask must be selected in the combo
  if(!IS_NULL_PTR(bd) && GTK_IS_TOGGLE_BUTTON(bd->raster_enable)
     && gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(bd->raster_enable)))
    raster = FALSE;
 
  if(!IS_NULL_PTR(bd) && GTK_IS_TOGGLE_BUTTON(bd->masks_enable)
     && gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(bd->masks_enable)))
    drawn = FALSE;
 
  if(!IS_NULL_PTR(bd) && GTK_IS_TOGGLE_BUTTON(bd->blendif_enable)
     && gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(bd->blendif_enable)))
    parametric = FALSE;
 
  if(!IS_NULL_PTR(top_enabled)) *top_enabled = top;
  if(!IS_NULL_PTR(raster_used)) *raster_used = raster;
  if(!IS_NULL_PTR(drawn_used)) *drawn_used = drawn;
  if(!IS_NULL_PTR(parametric_used)) *parametric_used = parametric;
}
 
static gboolean _mask_indicator_tooltip(GtkWidget *treeview, gint x, gint y, gboolean kb_mode,
      GtkTooltip* tooltip, dt_iop_module_t *module)
{
  (void)treeview;
  (void)x;
  (void)y;
  (void)kb_mode;
 
  gboolean res = FALSE;
  if(module->mask_indicator)
  {
    gchar *type = _("unknown mask");
    gchar *text;
    gboolean top_enabled = FALSE, raster_used = FALSE, drawn_used = FALSE, parametric_used = FALSE;
    _mask_indicator_get_usage(module, &top_enabled, &raster_used, &drawn_used, &parametric_used);
    if(!top_enabled) return FALSE;
 
    if(drawn_used && parametric_used)
      type=_("drawn + parametric mask");
    else if(drawn_used)
      type=_("drawn mask");
    else if(parametric_used)
      type=_("parametric mask");
    else if(raster_used)
      type=_("raster mask");
    else
      return FALSE;
    gchar *part1 = g_strdup_printf(_("this module has a '%s'"), type);
    gchar *part2 = NULL;
    if(raster_used && module->raster_mask.sink.source)
    {
      gchar *source = dt_history_item_get_name(module->raster_mask.sink.source);
      part2 = g_strdup_printf(_("taken from module %s"), source);
      dt_free(source);
    }
 
    if(part2)
    {
      gchar *details = g_strdup_printf("%s\n%s", part2, _("click to display (module must be activated first)"));
      dt_free(part2);
      part2 = details;
    }
    else
    {
      part2 = g_strdup(_("click to display (module must be activated first)"));
    }
 
    if(part2)
      text = g_strconcat(part1, "\n", part2, NULL);
    else
      text = g_strdup(part1);
 
    gtk_tooltip_set_text(tooltip, text);
    res = TRUE;
    dt_free(part1);
    dt_free(part2);
    dt_free(text);
  }
  return res;
}
 
void dt_iop_add_remove_mask_indicator(dt_iop_module_t *module)
{
  if(IS_NULL_PTR(module) || IS_NULL_PTR(module->mask_indicator)) return;
 
  const gboolean support_blending = (module->flags() & IOP_FLAGS_SUPPORTS_BLENDING) == IOP_FLAGS_SUPPORTS_BLENDING;
 
  if(!support_blending || !module->blend_params)
  {
    gtk_widget_set_visible(GTK_WIDGET(module->mask_indicator), FALSE);
    gtk_widget_set_has_tooltip(GTK_WIDGET(module->mask_indicator), FALSE);
    gtk_widget_set_sensitive(GTK_WIDGET(module->mask_indicator), FALSE);
    return;
  }
 
  gboolean top_enabled = FALSE, raster_used = FALSE, drawn_used = FALSE, parametric_used = FALSE;
  _mask_indicator_get_usage(module, &top_enabled, &raster_used, &drawn_used, &parametric_used);
 
  const gboolean use_masks = top_enabled && (raster_used || drawn_used || parametric_used);
 
  gtk_widget_set_visible(GTK_WIDGET(module->mask_indicator), use_masks);
  gtk_widget_set_sensitive(GTK_WIDGET(module->mask_indicator), module->enabled);
  gtk_widget_set_has_tooltip(GTK_WIDGET(module->mask_indicator), use_masks);
}
 
gboolean _iop_tooltip_callback(GtkWidget *widget, gint x, gint y, gboolean keyboard_mode,
                               GtkTooltip *tooltip, gpointer user_data)
{
  dt_iop_module_t *module = (dt_iop_module_t *)user_data;
 
  const char **des = module->description(module);
 
  if(IS_NULL_PTR(des)) return FALSE;
 
  GtkWidget *vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, DT_GUI_BOX_SPACING);
  GtkWidget *grid = gtk_grid_new();
  gtk_grid_set_column_homogeneous(GTK_GRID(grid), FALSE);
  gtk_grid_set_column_spacing(GTK_GRID(grid), DT_GUI_BOX_SPACING);
  gtk_widget_set_hexpand(grid, FALSE);
 
  GtkWidget *label = gtk_label_new(des[0] ? des[0] : "");
  gtk_label_set_justify(GTK_LABEL(label), GTK_JUSTIFY_LEFT);
  gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
  gtk_label_set_max_width_chars(GTK_LABEL(label), 40);
  // if there is no more description, do not add a separator
  if(des[1]) dt_gui_add_class(label, "dt_section_label");
  gtk_box_pack_start(GTK_BOX(vbox), label, FALSE, FALSE, 0);
 
  gtk_widget_set_size_request(label, DT_PIXEL_APPLY_DPI(300), -1);
  gtk_widget_set_size_request(grid, DT_PIXEL_APPLY_DPI(300), -1);
  gtk_widget_set_size_request(vbox, DT_PIXEL_APPLY_DPI(300), -1);
 
  const char *icon_purpose = "\342\237\263";
  const char *icon_input   = "\342\207\245";
  const char *icon_process = "\342\237\264";
  const char *icon_output  = "\342\206\246";
 
  const char *icons[4] = {icon_purpose, icon_input, icon_process, icon_output};
  const char *ilabs[4] = {_("Purpose"), _("Input"), _("Process"), _("Output")};
 
  for(int k=1; k<5; k++)
  {
    if(des[k])
    {
      label = gtk_label_new(icons[k-1]);
      gtk_widget_set_halign(label, GTK_ALIGN_START);
      gtk_grid_attach(GTK_GRID(grid), label, 0, k, 1, 1);
      gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
 
      label = gtk_label_new(ilabs[k-1]);
      gtk_widget_set_halign(label, GTK_ALIGN_START);
      gtk_grid_attach(GTK_GRID(grid), label, 1, k, 1, 1);
      gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
 
      label = gtk_label_new(":");
      gtk_widget_set_halign(label, GTK_ALIGN_START);
      gtk_grid_attach(GTK_GRID(grid), label, 2, k, 1, 1);
      gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
 
      label = gtk_label_new(des[k]);
      gtk_widget_set_halign(label, GTK_ALIGN_START);
      gtk_grid_attach(GTK_GRID(grid), label, 3, k, 1, 1);
      gtk_label_set_line_wrap(GTK_LABEL(label), TRUE);
    }
  }
 
  gtk_box_pack_start(GTK_BOX(vbox), grid, FALSE, FALSE, 0);
  gtk_widget_show_all(vbox);
  gtk_tooltip_set_custom(tooltip, vbox);
 
  return TRUE;
}
 
void dt_iop_gui_set_expander(dt_iop_module_t *module)
{
  GtkWidget *header = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, DT_GUI_BOX_SPACING / 2.);
  gtk_widget_set_name(GTK_WIDGET(header), "module-header");
 
  GtkWidget *iopw = gtk_box_new(GTK_ORIENTATION_VERTICAL, DT_GUI_BOX_SPACING);
  GtkWidget *expander = dtgtk_expander_new(header, iopw);
  dt_gui_add_class(expander, "dt_module_frame");
  dt_gui_add_class(expander, "dt_iop_module");
 
  GtkWidget *header_evb = dtgtk_expander_get_header_event_box(DTGTK_EXPANDER(expander));
  GtkWidget *body_evb = dtgtk_expander_get_body_event_box(DTGTK_EXPANDER(expander));
  GtkWidget *pluginui_frame = dtgtk_expander_get_frame(DTGTK_EXPANDER(expander));
 
  dt_gui_add_class(pluginui_frame, "dt_plugin_ui");
 
  module->header = header;
 
  /* setup the header box */
  g_signal_connect(G_OBJECT(header_evb), "button-press-event", G_CALLBACK(_iop_plugin_header_button_press), module);
  g_signal_connect(G_OBJECT(header_evb), "button-release-event", G_CALLBACK(_iop_plugin_header_button_release), module);
  g_signal_connect(G_OBJECT(header_evb), "mnemonic-activate", G_CALLBACK(_iop_plugin_header_activate), module);
  gtk_widget_add_events(header_evb, GDK_POINTER_MOTION_MASK);
 
  /* connect mouse button callbacks for focus and presets */
  g_signal_connect(G_OBJECT(body_evb), "button-press-event", G_CALLBACK(_iop_plugin_body_button_press), module);
  gtk_widget_add_events(body_evb, GDK_POINTER_MOTION_MASK);
 
  /*
   * initialize the header widgets
   */
  GtkWidget *hw[IOP_MODULE_LAST] = { NULL };
 
  /* init empty place for icon, this is then set in CSS if needed */
  char w_name[256] = { 0 };
  snprintf(w_name, sizeof(w_name), "iop-panel-icon-%s", module->op);
  hw[IOP_MODULE_ICON] = gtk_label_new("");
  gtk_widget_set_name(GTK_WIDGET(hw[IOP_MODULE_ICON]), w_name);
 
  /* add module label */
  hw[IOP_MODULE_LABEL] = gtk_event_box_new();
  GtkWidget *lab = hw[IOP_MODULE_LABEL];
  GtkWidget *label = gtk_label_new_with_mnemonic("");
  gtk_container_add(GTK_CONTAINER(lab), label);
  gtk_label_set_mnemonic_widget(GTK_LABEL(label), header_evb);
 
  if((module->flags() & IOP_FLAGS_DEPRECATED) && module->deprecated_msg())
    gtk_widget_set_tooltip_text(lab, module->deprecated_msg());
  else
  {
    gtk_widget_set_name(lab, "iop_description");
    g_signal_connect(lab, "query-tooltip", G_CALLBACK(_iop_tooltip_callback), module);
  }
 
  /* add mask preview button */
  hw[IOP_MODULE_MASK] = dtgtk_togglebutton_new(dtgtk_cairo_paint_showmask, 0, NULL);
 
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_MASK]), "toggled",
                    G_CALLBACK(_display_mask_indicator_callback), module);
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_MASK]), "button-press-event",
                   G_CALLBACK(_iop_plugin_header_child_button_press), module);
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_MASK]), "query-tooltip",
                    G_CALLBACK(_mask_indicator_tooltip), module);
  module->mask_indicator = hw[IOP_MODULE_MASK];
 
  /* add multi instances menu button */
  hw[IOP_MODULE_INSTANCE] = dtgtk_button_new(dtgtk_cairo_paint_multiinstance, 0, NULL);
  module->multimenu_button = GTK_WIDGET(hw[IOP_MODULE_INSTANCE]);
  gtk_widget_set_tooltip_text(GTK_WIDGET(hw[IOP_MODULE_INSTANCE]),
                              _("multiple instance actions\nright-click creates new instance"));
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_INSTANCE]), "button-press-event",
                   G_CALLBACK(_iop_plugin_header_child_button_press), module);
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_INSTANCE]), "button-press-event", G_CALLBACK(_gui_multiinstance_callback),
                   module);
 
  dt_gui_add_help_link(expander, dt_get_help_url(module->op));
 
  /* add reset button */
  hw[IOP_MODULE_RESET] = dtgtk_button_new(dtgtk_cairo_paint_reset, 0, NULL);
  module->reset_button = GTK_WIDGET(hw[IOP_MODULE_RESET]);
  gtk_widget_set_tooltip_text(GTK_WIDGET(hw[IOP_MODULE_RESET]), _("reset parameters\nctrl+click to reapply any automatic presets"));
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_RESET]), "button-press-event",
                   G_CALLBACK(_iop_plugin_header_child_button_press), module);
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_RESET]), "button-press-event", G_CALLBACK(_gui_reset_callback), module);
 
  /* add preset button if module has implementation */
  hw[IOP_MODULE_PRESETS] = dtgtk_button_new(dtgtk_cairo_paint_presets, 0, NULL);
  module->presets_button = GTK_WIDGET(hw[IOP_MODULE_PRESETS]);
  if(!(module->flags() & IOP_FLAGS_ONE_INSTANCE))
    gtk_widget_set_tooltip_text(GTK_WIDGET(hw[IOP_MODULE_PRESETS]), _("presets\nright-click to apply on new instance"));
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_PRESETS]), "button-press-event",
                   G_CALLBACK(_iop_plugin_header_child_button_press), module);
  g_signal_connect(G_OBJECT(hw[IOP_MODULE_PRESETS]), "clicked", G_CALLBACK(_presets_popup_callback), module);
 
  /* add enabled button */
  GtkWidget *switch_button = dtgtk_togglebutton_new(dtgtk_cairo_paint_module_switch, 0, module);
 
  dt_gui_add_class(switch_button, "dt_iop_enable_button");
  dt_iop_gui_set_enable_button_icon(switch_button, module);
  gtk_toggle_button_set_active(GTK_TOGGLE_BUTTON(switch_button), module->enabled);
  g_signal_connect(G_OBJECT(switch_button), "button-press-event",
                   G_CALLBACK(_iop_plugin_header_child_button_press), module);
  g_signal_connect(G_OBJECT(switch_button), "toggled", G_CALLBACK(_gui_off_callback), module);
 
  module->off = DTGTK_TOGGLEBUTTON(switch_button);
  gtk_widget_set_sensitive(GTK_WIDGET(switch_button), !module->hide_enable_button);
 
  /* Wrap the switch in a plain box so the CSS spacing trick that visually tucks it
     against the header edge (negative margin, see ansel.css) lives on the wrapper,
     not on the button itself. dtgtk_togglebutton's custom draw() reinterprets its own
     CSS margin a second time (as a paint-only offset) to size its icon -- if that same
     margin also carries a position nudge, the icon gets painted outside the button's
     real GTK allocation, which is what drives hover/click hit-testing. Keeping the
     button's own margin at 0 keeps its drawing and its hit-region intrinsically in
     sync; the wrapper absorbs the nudge at the layout level instead. */
  hw[IOP_MODULE_SWITCH] = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
  dt_gui_add_class(hw[IOP_MODULE_SWITCH], "dt_iop_enable_button_box");
  gtk_container_add(GTK_CONTAINER(hw[IOP_MODULE_SWITCH]), switch_button);
 
  /* reorder header, for now, iop are always in the right panel */
  for(int i = 0; i <= IOP_MODULE_LABEL; i++)
  {
    if(hw[i]) 
      gtk_box_pack_start(GTK_BOX(header), hw[i], FALSE, FALSE, 0);
  }
  for(int i = IOP_MODULE_LAST - 1; i > IOP_MODULE_LABEL; i--)
  {
    if(hw[i]) 
      gtk_box_pack_end(GTK_BOX(header), hw[i], FALSE, FALSE, 0);
  }
 
  dt_gui_add_help_link(header, dt_get_help_url("module_header"));
  // for the module label, point to module specific help page
  dt_gui_add_help_link(hw[IOP_MODULE_LABEL], dt_get_help_url(module->op));
 
  gtk_widget_set_halign(hw[IOP_MODULE_LABEL], GTK_ALIGN_START);
  gtk_widget_set_halign(hw[IOP_MODULE_INSTANCE], GTK_ALIGN_END);
 
  // show deprecated message if any
  if(module->deprecated_msg())
  {
    GtkWidget *lb = gtk_label_new(module->deprecated_msg());
    gtk_label_set_line_wrap(GTK_LABEL(lb), TRUE);
    gtk_label_set_xalign(GTK_LABEL(lb), 0.0);
    dt_gui_add_class(lb, "dt_warning");
    gtk_box_pack_start(GTK_BOX(iopw), lb, TRUE, TRUE, 0);
    gtk_widget_show(lb);
  }
 
  /* initialize blending state if supported; the detached widget is hosted by the masks lib */
  gtk_box_pack_start(GTK_BOX(iopw), module->widget, TRUE, TRUE, 0);
  dt_iop_gui_init_blending(module);
  dt_gui_add_class(module->widget, "dt_plugin_ui_main");
  dt_gui_add_help_link(module->widget, dt_get_help_url(module->op));
  gtk_widget_hide(iopw);
 
  module->expander = expander;
  g_object_weak_ref(G_OBJECT(header), _iop_gui_widget_gone, module);
  g_object_weak_ref(G_OBJECT(expander), _iop_gui_widget_gone, module);
 
  /* update header */
  dt_iop_gui_update_header(module);
 
  gtk_widget_set_hexpand(module->widget, FALSE);
  gtk_widget_set_vexpand(module->widget, FALSE);
 
  dt_ui_container_add_widget(darktable.gui->ui, DT_UI_CONTAINER_PANEL_RIGHT_CENTER, expander);
}
 
GtkWidget *dt_iop_gui_get_widget(dt_iop_module_t *module)
{
  return dtgtk_expander_get_body(DTGTK_EXPANDER(module->expander));
}
 
GtkWidget *dt_iop_gui_get_pluginui(dt_iop_module_t *module)
{
  // return gtkframe (pluginui_frame)
  return dtgtk_expander_get_frame(DTGTK_EXPANDER(module->expander));
}
 
void dt_iop_nap(int32_t usec)
{
  if(usec <= 0) return;
 
  // relinquish processor
  sched_yield();
 
  // additionally wait the given amount of time
  g_usleep(usec);
}
 
gboolean dt_iop_get_cache_bypass(dt_iop_module_t *module)
{
  return module->bypass_cache;
}
 
void dt_iop_set_cache_bypass(dt_iop_module_t *module, gboolean state)
{
  module->bypass_cache = state;
 
  if(state && module->dev)
  {
    // Disable other modules bypass if set.
    for(GList *iop = g_list_last(module->dev->iop);
        iop;
        iop = g_list_previous(iop))
    {
      dt_iop_module_t *current = (dt_iop_module_t *)iop->data;
      if(current != module && current->bypass_cache) current->bypass_cache = FALSE;
    }
  }
}
 
void dt_iop_set_cache_bypass_variant(dt_iop_module_t *module, int variant)
{
  module->bypass_cache_variant = variant;
}
 
 
dt_iop_module_t *dt_iop_get_colorout_module(void)
{
  return dt_iop_get_module_from_list(darktable.develop->iop, "colorout");
}
 
dt_iop_module_t *dt_iop_get_module_from_list(GList *iop_list, const char *op)
{
  dt_iop_module_t *result = NULL;
 
  for(GList *modules = iop_list; modules; modules = g_list_next(modules))
  {
    dt_iop_module_t *mod = (dt_iop_module_t *)modules->data;
    if(strcmp(mod->op, op) == 0)
    {
      result = mod;
      break;
    }
  }
 
  return result;
}
 
dt_iop_module_t *dt_iop_get_module(const char *op)
{
  return dt_iop_get_module_from_list(darktable.develop->iop, op);
}
 
int dt_iop_get_module_flags(const char *op)
{
  GList *modules = darktable.iop;
  while(modules)
  {
    dt_iop_module_so_t *module = (dt_iop_module_so_t *)modules->data;
    if(!strcmp(module->op, op)) return module->flags();
    modules = g_list_next(modules);
  }
  return 0;
}
 
// to be called before issuing any query based on memory.darktable_iop_names
void dt_iop_set_darktable_iop_table()
{
  if(IS_NULL_PTR(darktable.iop)) return;
 
  // Faster than building a huge VALUES string: reuse a prepared statement and bind per module.
  sqlite3_stmt *stmt = NULL;
  DT_DEBUG_SQLITE3_PREPARE_V2(
      dt_database_get(darktable.db),
      "INSERT INTO memory.darktable_iop_names (operation, name) VALUES (?1, ?2)",
      -1, &stmt, NULL);
  if(IS_NULL_PTR(stmt)) return;
 
  dt_database_start_transaction(darktable.db);
  for(GList *iop = darktable.iop; iop; iop = g_list_next(iop))
  {
    dt_iop_module_so_t *module = (dt_iop_module_so_t *)iop->data;
    sqlite3_reset(stmt);
    sqlite3_clear_bindings(stmt);
    DT_DEBUG_SQLITE3_BIND_TEXT(stmt, 1, module->op, -1, SQLITE_TRANSIENT);
    DT_DEBUG_SQLITE3_BIND_TEXT(stmt, 2, module->name(), -1, SQLITE_TRANSIENT);
    sqlite3_step(stmt);
  }
  dt_database_release_transaction(darktable.db);
  sqlite3_finalize(stmt);
}
 
const gchar *dt_iop_get_localized_name(const gchar *op)
{
  // Prepare mapping op -> localized name
  static GHashTable *module_names = NULL;
  if(IS_NULL_PTR(module_names))
  {
    module_names = g_hash_table_new(g_str_hash, g_str_equal);
    for(GList *iop = darktable.iop; iop; iop = g_list_next(iop))
    {
      dt_iop_module_so_t *module = (dt_iop_module_so_t *)iop->data;
      g_hash_table_insert(module_names, module->op, g_strdup(module->name()));
    }
  }
  if(!IS_NULL_PTR(op))
  {
    return (gchar *)g_hash_table_lookup(module_names, op);
  }
  else {
    return _("ERROR");
  }
}
 
const gchar *dt_iop_get_localized_aliases(const gchar *op)
{
  // Prepare mapping op -> localized name
  static GHashTable *module_aliases = NULL;
  if(IS_NULL_PTR(module_aliases))
  {
    module_aliases = g_hash_table_new(g_str_hash, g_str_equal);
    for(GList *iop = darktable.iop; iop; iop = g_list_next(iop))
    {
      dt_iop_module_so_t *module = (dt_iop_module_so_t *)iop->data;
      g_hash_table_insert(module_aliases, module->op, g_strdup(module->aliases()));
    }
  }
  if(!IS_NULL_PTR(op))
  {
    return (gchar *)g_hash_table_lookup(module_aliases, op);
  }
  else {
    return _("ERROR");
  }
}
 
void dt_iop_update_multi_priority(dt_iop_module_t *module, int new_priority)
{
  GHashTableIter iter;
  gpointer key, value;
 
  g_hash_table_iter_init(&iter, module->raster_mask.source.users);
  while(g_hash_table_iter_next(&iter, &key, &value))
  {
    dt_iop_module_t *sink_module = (dt_iop_module_t *)key;
 
    sink_module->blend_params->raster_mask_instance = new_priority;
 
    // also fix history entries
    for(GList *hiter = module->dev->history; hiter; hiter = g_list_next(hiter))
    {
      dt_dev_history_item_t *hist = (dt_dev_history_item_t *)hiter->data;
      if(hist->module == sink_module)
        hist->blend_params->raster_mask_instance = new_priority;
    }
  }
 
  module->multi_priority = new_priority;
}
 
gboolean dt_iop_is_raster_mask_used(dt_iop_module_t *module, int id)
{
  GHashTableIter iter;
  gpointer key, value;
 
  g_hash_table_iter_init(&iter, module->raster_mask.source.users);
  while(g_hash_table_iter_next(&iter, &key, &value))
  {
    if(GPOINTER_TO_INT(value) == id)
      return TRUE;
  }
  return FALSE;
}
 
dt_iop_module_t *dt_iop_get_module_by_op_priority(GList *modules, const char *operation, const int multi_priority)
{
  dt_iop_module_t *mod_ret = NULL;
 
  for(GList *m = modules; m; m = g_list_next(m))
  {
    dt_iop_module_t *mod = (dt_iop_module_t *)m->data;
 
    if(strcmp(mod->op, operation) == 0
       && (mod->multi_priority == multi_priority || multi_priority == -1))
    {
      mod_ret = mod;
      break;
    }
  }
  return mod_ret;
}
 
dt_iop_module_t *dt_iop_get_module_by_instance_name(GList *modules, const char *operation, const char *multi_name)
{
  dt_iop_module_t *mod_ret = NULL;
 
  for(GList *m = modules; m; m = g_list_next(m))
  {
    dt_iop_module_t *mod = (dt_iop_module_t *)m->data;
 
    if((strcmp(mod->op, operation) == 0)
       && ((IS_NULL_PTR(multi_name)) || (strcmp(mod->multi_name, multi_name) == 0)))
    {
      mod_ret = mod;
      break;
    }
  }
  return mod_ret;
}
 
gboolean dt_iop_is_first_instance(GList *modules, dt_iop_module_t *module)
{
  gboolean is_first = TRUE;
  GList *iop = modules;
  while(iop)
  {
    dt_iop_module_t *m = (dt_iop_module_t *)iop->data;
    if(!strcmp(m->op, module->op))
    {
      is_first = (m == module);
      break;
    }
    iop = g_list_next(iop);
  }
 
  return is_first;
}
 
void dt_iop_throttled_history_update(gpointer data)
{
  dt_iop_module_t *self = (dt_iop_module_t*)data;
  dt_dev_add_history_item(darktable.develop, self, TRUE, TRUE);
}
 
const char **dt_iop_set_description(dt_iop_module_t *module, const char *main_text, const char *purpose, const char *input, const char *process,
                             const char *output)
{
  static const char *str_out[5] = {NULL, NULL, NULL, NULL, NULL};
 
  str_out[0] = main_text;
  str_out[1] = purpose;
  str_out[2] = input;
  str_out[3] = process;
  str_out[4] = output;
 
  return (const char **)str_out;
}
 
void dt_iop_gui_changed(dt_iop_module_t *action, GtkWidget *widget, gpointer data)
{
  if(IS_NULL_PTR(action)) return;
  dt_iop_module_t *module = (dt_iop_module_t *)action;
 
  if(module->gui_changed) module->gui_changed(module, widget, data);
 
  dt_iop_color_picker_reset(module, TRUE);
 
  dt_dev_add_history_item(darktable.develop, module, TRUE, TRUE);
 
  if(!IS_NULL_PTR(widget) && g_object_get_data(G_OBJECT(widget), "dt-blendop-header-update"))
    dt_iop_gui_update_header(module);
  else
    dt_iop_gui_set_enable_button(module);
}
 
 
void dt_bauhaus_update_module(dt_iop_module_t *self)
{
  dt_gui_module_t *m = DT_GUI_MODULE(self);
 
  for(GList *w = g_list_first(m->widget_list_bh); w; w = g_list_next(w))
  {
    GtkWidget *widget = (GtkWidget *)w->data;
    struct dt_bauhaus_widget_t *bhw = DT_BAUHAUS_WIDGET(widget);
    if(IS_NULL_PTR(bhw)) continue;
 
    switch(bhw->type)
    {
      case DT_BAUHAUS_SLIDER:
        switch(bhw->field_type)
        {
          case DT_INTROSPECTION_TYPE_FLOAT:
            dt_bauhaus_slider_set(widget, *(float *)bhw->field);
            break;
          case DT_INTROSPECTION_TYPE_INT:
            dt_bauhaus_slider_set(widget, *(int *)bhw->field);
            break;
          case DT_INTROSPECTION_TYPE_USHORT:
            dt_bauhaus_slider_set(widget, *(unsigned short *)bhw->field);
            break;
          default:
            fprintf(stderr, "[dt_bauhaus_update_module] unsupported slider data type\n");
        }
        break;
      case DT_BAUHAUS_COMBOBOX:
        switch(bhw->field_type)
        {
          case DT_INTROSPECTION_TYPE_ENUM:
            dt_bauhaus_combobox_set_from_value(widget, *(int *)bhw->field);
            break;
          case DT_INTROSPECTION_TYPE_INT:
            dt_bauhaus_combobox_set(widget, *(int *)bhw->field);
            break;
          case DT_INTROSPECTION_TYPE_UINT:
            dt_bauhaus_combobox_set(widget, *(unsigned int *)bhw->field);
            break;
          case DT_INTROSPECTION_TYPE_BOOL:
            dt_bauhaus_combobox_set(widget, *(gboolean *)bhw->field);
            break;
          default:
            fprintf(stderr, "[dt_bauhaus_update_module] unsupported combo data type\n");
        }
        break;
      default:
        fprintf(stderr, "[dt_bauhaus_update_module] invalid bauhaus widget type encountered\n");
    }
  }
}
 
void dt_bauhaus_value_changed_default_callback(GtkWidget *widget)
{
  dt_bauhaus_widget_t *w = DT_BAUHAUS_WIDGET(widget);
  dt_iop_module_t *module = (dt_iop_module_t *)w->module;
  if(IS_NULL_PTR(w->field) || IS_NULL_PTR(module)) return;
 
  switch(w->type)
  {
    case DT_BAUHAUS_SLIDER:
    {
      float val = dt_bauhaus_slider_get(widget);
      switch(w->field_type)
      {
        case DT_INTROSPECTION_TYPE_FLOAT:
        {
          float *f = w->field, prevf = *f; *f = val;
          if(*f != prevf) dt_iop_gui_changed(module, widget, &prevf);
          break;
        }
        case DT_INTROSPECTION_TYPE_INT:
        {
          int *i = w->field, previ = *i; *i = val;
          if(*i != previ) dt_iop_gui_changed(module, widget, &previ);
          break;
        }
        case DT_INTROSPECTION_TYPE_USHORT:
        {
          unsigned short *s = w->field, prevs = *s; *s = val;
          if(*s != prevs) dt_iop_gui_changed(module, widget, &prevs);
          break;
        }
        default:
          fprintf(stderr, "[_bauhaus_slider_value_change] unsupported slider data type\n");
      }
      break;
    }
    case DT_BAUHAUS_COMBOBOX:
    {
      dt_bauhaus_combobox_data_t *d = &w->data.combobox;
      switch(w->field_type)
      {
        case DT_INTROSPECTION_TYPE_ENUM:
        {
          if(d->active >= 0)
          {
            const dt_bauhaus_combobox_entry_t *entry = g_ptr_array_index(d->entries, d->active);
            int *e = w->field, preve = *e; *e = GPOINTER_TO_INT(entry->data);
            if(*e != preve) dt_iop_gui_changed(module, widget, &preve);
          }
          break;
        }
        case DT_INTROSPECTION_TYPE_INT:
        {
          int *i = w->field, previ = *i; *i = d->active;
          if(*i != previ) dt_iop_gui_changed(module, widget, &previ);
          break;
        }
        case DT_INTROSPECTION_TYPE_UINT:
        {
          unsigned int *u = w->field, prevu = *u; *u = d->active;
          if(*u != prevu) dt_iop_gui_changed(module, widget, &prevu);
          break;
        }
        case DT_INTROSPECTION_TYPE_BOOL:
        {
          gboolean *b = w->field, prevb = *b; *b = d->active;
          if(*b != prevb) dt_iop_gui_changed(module, widget, &prevb);
          break;
        }
        default:
          fprintf(stderr, "[_bauhaus_combobox_set] unsupported combo data type\n");
      }
      break;
    }
    default:
      fprintf(stderr, "[dt_bauhaus_value_changed_default_callback] invalid bauhaus widget type encountered for %s %s: %i\n", w->label, w->module->name, w->type);
  }
}
 
// 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