history.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 Frédéric Grollier.
    Copyright (C) 2012, 2019-2022 Pascal Obry.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2016 Roman Lebedev.
    Copyright (C) 2018 Edgardo Hoszowski.
    Copyright (C) 2019-2020 Aldric Renaudin.
    Copyright (C) 2019, 2022 Hanno Schwalm.
    Copyright (C) 2020 Chris Elston.
    Copyright (C) 2020-2021 Hubert Kowalski.
    Copyright (C) 2020 Philippe Weyland.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2025 Alynx Zhou.
    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/>.
*/
 
#pragma once
 
#include <gtk/gtk.h>
#include <inttypes.h>
#include <sqlite3.h>
 
#include "common/history_actions.h"
#include "common/image_cache.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct dt_history_copy_item_t
{
  GList *selops;
  GtkTreeView *items;
  int copied_imageid;
} dt_history_copy_item_t;
 
void dt_history_item_free(gpointer data);
 
void dt_history_delete_on_image(int32_t imgid);
 
void dt_history_delete_on_image_ext(int32_t imgid, gboolean undo);
 
int32_t dt_history_get_end(const int32_t imgid);
 
gboolean dt_history_set_end(const int32_t imgid, const int32_t history_end);
 
typedef void (*dt_history_db_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_db_foreach_history_row(const int32_t imgid, dt_history_db_row_cb cb, void *user_data);
void dt_history_db_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_db_row_cb cb, void *user_data);
gboolean dt_history_db_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);
int32_t dt_history_db_get_next_history_num(const int32_t imgid);
gboolean dt_history_db_delete_history(const int32_t imgid);
gboolean dt_history_db_delete_masks_history(const int32_t imgid);
gboolean dt_history_db_delete_dev_history(const int32_t imgid);
gboolean dt_history_db_shift_history_nums(const int32_t imgid, const int delta);
gboolean dt_history_db_write_history_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 int enabled,
                                         const void *blendop_params, const int blendop_params_size,
                                         const int blendop_version, const int multi_priority, const char *multi_name);
 
/* duplicate an history list */
GList *dt_history_duplicate(GList *hist);
 
 
 
typedef struct dt_history_item_t
{
  guint num;
  gchar *op;
  gchar *name;
  gboolean enabled;
} dt_history_item_t;
 
GList *dt_history_get_items(int32_t imgid, gboolean enabled);
 
char *dt_history_get_items_as_string(int32_t imgid);
 
char *dt_history_item_as_string(const char *name, gboolean enabled);
 
/* check if a module exists in the history of corresponding image */
gboolean dt_history_check_module_exists(int32_t imgid, const char *operation, gboolean enabled);
void dt_history_cleanup(void);
 
void dt_history_hash_set_mipmap(const int32_t imgid, const uint64_t history_hash,
                                const dt_image_cache_write_mode_t mode);
 
#ifdef __cplusplus
}
#endif
 
// 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