lib.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2009-2012 johannes hanika.
    Copyright (C) 2010-2012 Henrik Andersson.
    Copyright (C) 2011 Brian Teague.
    Copyright (C) 2011 Robert Bieber.
    Copyright (C) 2011-2014, 2016-2017 Tobias Ellinghaus.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2014-2016 Jérémy Rosen.
    Copyright (C) 2014, 2016 Roman Lebedev.
    Copyright (C) 2019-2021 Aldric Renaudin.
    Copyright (C) 2019 Edgardo Hoszowski.
    Copyright (C) 2019 Heiko Bauke.
    Copyright (C) 2019-2021 Pascal Obry.
    Copyright (C) 2020-2021 Dan Torop.
    Copyright (C) 2020-2022 Diederik Ter Rahe.
    Copyright (C) 2020 Matthias Vogelgesang.
    Copyright (C) 2020, 2022 Philippe Weyland.
    Copyright (C) 2020 Ralf Brown.
    Copyright (C) 2021 Mark-64.
    Copyright (C) 2022 luzpaz.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2024-2025 Aurélien PIERRE.
    
    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/>.
*/
 
#ifndef DT_LIBS_LIB_H
#define DT_LIBS_LIB_H
 
#include "common/gui_module_api.h"
#include "views/view.h"
#include <gmodule.h>
#include <gtk/gtk.h>
#include <glib.h>
 
struct dt_lib_module_t;
struct dt_colorpicker_sample_t;
 
typedef struct dt_lib_t
{
  GList *plugins;
  struct dt_lib_module_t *gui_module;
 
  struct
  {
    struct
    {
      struct dt_lib_module_t *module;
    } navigation;
  } proxy;
} dt_lib_t;
 
 
typedef struct dt_lib_module_t
{
  // Needs to stay on top for casting
  dt_gui_module_t common_fields;
 
#define INCLUDE_API_FROM_MODULE_H
#include "libs/lib_api.h"
 
  GModule *module;
  void *data;
  char plugin_name[128];
  GtkWidget *widget;
  GtkWidget *expander;
  void (*_postponed_update)(struct dt_lib_module_t *self);
  guint timeout_handle;
 
  GtkWidget *arrow;
  GtkWidget *reset_button;
  GtkWidget *presets_button;
 
} dt_lib_module_t;
 
void dt_lib_init(dt_lib_t *lib);
 
// Interim accessor (Strategy B, doc/globals-migration.md): implemented by the orchestrator; long-term the handle should be carried on the job/view context (Strategy C).
struct dt_lib_t *dt_lib_get_global(void);
void dt_lib_cleanup(dt_lib_t *lib);
 
GtkWidget *dt_lib_gui_get_expander(dt_lib_module_t *module);
void dt_lib_gui_set_expanded(dt_lib_module_t *module, gboolean expanded);
gboolean dt_lib_gui_get_expanded(dt_lib_module_t *module);
 
dt_lib_module_t *dt_lib_get_module(const char *name);
 
gboolean dt_lib_is_visible(dt_lib_module_t *module);
void dt_lib_set_visible(dt_lib_module_t *module, gboolean visible);
gboolean dt_lib_is_visible_in_view(dt_lib_module_t *module, const dt_view_t *view);
 
gchar *dt_lib_get_localized_name(const gchar *plugin_name);
 
void dt_lib_presets_add(const char *name, const char *plugin_name, const int32_t version, const void *params,
                        const int32_t params_size, gboolean readonly);
 
void dt_lib_queue_postponed_update(dt_lib_module_t *mod, void (*update_fn)(dt_lib_module_t *self));
void dt_lib_cancel_postponed_update(dt_lib_module_t *mod);
 
// apply a preset to the given module
gboolean dt_lib_presets_apply(const gchar *preset, const gchar *module_name, int module_version);
// duplicate a preset
gchar *dt_lib_presets_duplicate(const gchar *preset, const gchar *module_name, int module_version);
// remove a preset
void dt_lib_presets_remove(const gchar *preset, const gchar *module_name, int module_version);
// update a preset
void dt_lib_presets_update(const gchar *preset, const gchar *module_name, int module_version, const gchar *newname,
                           const gchar *desc, const void *params, const int32_t params_size);
// know if the module can autoapply presets
gboolean dt_lib_presets_can_autoapply(dt_lib_module_t *mod);
 
/*
 * Proxy functions
 */
 
void dt_lib_colorpicker_set_box_area(dt_lib_t *lib, const dt_boundingbox_t box);
 
void dt_lib_colorpicker_set_point(dt_lib_t *lib, const float pos[2]);
 
gint dt_lib_sort_plugins(gconstpointer a, gconstpointer b);
void dt_lib_init_presets(dt_lib_module_t *module);
 
gboolean dt_handle_dialog_enter(GtkWidget *widget, GdkEventKey *event, gpointer data);
 
GtkWidget *dt_action_button_new(dt_lib_module_t *self, const gchar *label, gpointer callback, gpointer data,
                                const gchar *tooltip, guint accel_key, GdkModifierType mods);
 
#endif // DT_LIBS_LIB_H
 
// 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