history_repository.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2009-2011 johannes hanika.
    Copyright (C) 2010 Henrik Andersson.
    Copyright (C) 2011, 2014-2016 Tobias Ellinghaus.
    Copyright (C) 2012, 2019-2022 Pascal Obry.
    Copyright (C) 2018 Edgardo Hoszowski.
    Copyright (C) 2025-2026 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_DATABASE_HISTORY_REPOSITORY_H
#define DT_DATABASE_HISTORY_REPOSITORY_H
 
#include <glib.h>
#include <inttypes.h>
 
#include "common/image.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ---------------------------------------------------------------------------------------------
 * history_end (main.images.history_end)
 * ------------------------------------------------------------------------------------------ */
 
int32_t dt_history_repository_get_end(const int32_t imgid);
 
gboolean dt_history_repository_set_end(const int32_t imgid, const int32_t history_end);
 
/* ---------------------------------------------------------------------------------------------
 * writing history items
 * ------------------------------------------------------------------------------------------ */
 
int32_t dt_history_repository_get_next_num(const int32_t imgid);
 
gboolean dt_history_repository_shift_nums(const int32_t imgid, const int delta);
 
gboolean dt_history_repository_write_item(const int32_t imgid, const int num, const char *operation,
                                          const void *op_params, const int op_params_size,
                                          const int module_version, const gboolean enabled,
                                          const void *blendop_params, const int blendop_params_size,
                                          const int blendop_version, const int multi_priority,
                                          const char *multi_name);
 
/* ---------------------------------------------------------------------------------------------
 * deleting
 * ------------------------------------------------------------------------------------------ */
 
gboolean dt_history_repository_delete_history(const int32_t imgid);
gboolean dt_history_repository_delete_masks_history(const int32_t imgid);
 
gboolean dt_history_repository_delete_dev_history(const int32_t imgid);
 
gboolean dt_history_repository_delete_all_for_image(const int32_t imgid);
 
/* ---------------------------------------------------------------------------------------------
 * reading history rows
 * ------------------------------------------------------------------------------------------ */
 
typedef void (*dt_history_repository_row_cb)(void *user_data,
                                             const int32_t imgid,
                                             const int num,
                                             const int module_version,
                                             const char *operation,
                                             const void *op_params,
                                             const int op_params_len,
                                             const gboolean enabled,
                                             const void *blendop_params,
                                             const int blendop_params_len,
                                             const int blendop_version,
                                             const int multi_priority,
                                             const char *multi_name,
                                             const char *preset_name);
 
void dt_history_repository_foreach_row(const int32_t imgid, dt_history_repository_row_cb cb,
                                       void *user_data);
 
void dt_history_repository_foreach_auto_preset_row(const int32_t imgid, const struct dt_image_t *image,
                                                   const char *workflow_preset, const int iformat,
                                                   const int excluded, dt_history_repository_row_cb cb,
                                                   void *user_data);
 
gboolean dt_history_repository_get_autoapply_ioporder_params(const int32_t imgid,
                                                             const struct dt_image_t *image,
                                                             const int iformat, const int excluded,
                                                             void **params, int32_t *params_len);
 
int dt_history_repository_count_items(const int32_t imgid);
 
gboolean dt_history_repository_get_last_enabled_params(const int32_t imgid, const char *operation,
                                                       void **params, int32_t *params_len);
 
gboolean dt_history_repository_module_exists(const int32_t imgid, const char *operation);
 
/* ---------------------------------------------------------------------------------------------
 * listing history items for display
 * ------------------------------------------------------------------------------------------ */
 
typedef void (*dt_history_repository_item_cb)(void *user_data, const int num, const char *operation,
                                              const gboolean enabled, const char *multi_name);
 
void dt_history_repository_foreach_last_item(const int32_t imgid, const gboolean enabled,
                                             dt_history_repository_item_cb cb, void *user_data);
 
void dt_history_repository_foreach_item(const int32_t imgid, dt_history_repository_item_cb cb,
                                        void *user_data);
 
/* ---------------------------------------------------------------------------------------------
 * main.masks_history
 *
 * The drawn shapes a development refers to, one row per (history step, form). Persisted beside
 * main.history and read back with it, so it lives in the same repository.
 * ------------------------------------------------------------------------------------------ */
 
gboolean dt_history_repository_write_mask_item(const int32_t imgid, const int num, const int formid,
                                               const int form, const char *name, const int version,
                                               const void *points, const int points_len,
                                               const int points_count, const void *source,
                                               const int source_len);
 
int dt_history_repository_count_mask_items(const int32_t imgid);
 
typedef void (*dt_history_repository_mask_cb)(void *user_data, const int num, const int formid,
                                              const int form, const char *name, const int version,
                                              const void *points, const int points_len,
                                              const int points_count, const void *source,
                                              const int source_len);
 
void dt_history_repository_foreach_mask_item(const int32_t imgid,
                                             dt_history_repository_mask_cb cb, void *user_data);
 
int dt_history_repository_find_version_for_params(const char *operation, const void *op_params,
                                                  const int op_params_size);
 
typedef void (*dt_history_repository_active_module_cb)(void *user_data, const int num,
                                                       const char *operation, const char *multi_name);
 
void dt_history_repository_foreach_active_module(const int32_t imgid,
                                                 dt_history_repository_active_module_cb cb,
                                                 void *user_data);
 
/* ------------------------------------------------------------------------------------------
 * main.module_order
 *
 * Which order the modules run in for one image: a version from ::dt_iop_order_t, plus -- when
 * that version is CUSTOM, or when the image carries multiple instances of a module -- the
 * serialized list itself. One row per image, or no row at all, which is a meaningful state:
 * it means nobody has chosen, and the caller picks a built-in default from the image's kind.
 * ------------------------------------------------------------------------------------------ */
 
gboolean dt_history_repository_get_module_order_version(const int32_t imgid, int *version);
 
gboolean dt_history_repository_has_module_order(const int32_t imgid);
 
gboolean dt_history_repository_has_custom_module_order(const int32_t imgid);
 
typedef struct dt_module_order_row_t
{
  int version;      
  char *iop_list;   
} dt_module_order_row_t;
 
gboolean dt_history_repository_get_module_order(const int32_t imgid, dt_module_order_row_t *row);
 
void dt_module_order_row_cleanup(dt_module_order_row_t *row);
 
gboolean dt_history_repository_set_module_order(const int32_t imgid, const int version,
                                                const char *iop_list);
 
void dt_history_repository_cleanup(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_DATABASE_HISTORY_REPOSITORY_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