undo.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2010-2011 Henrik Andersson.
    Copyright (C) 2010 johannes hanika.
    Copyright (C) 2010 Pascal de Bruijn.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013, 2016-2017, 2019-2021 Pascal Obry.
    Copyright (C) 2014, 2016 Tobias Ellinghaus.
    Copyright (C) 2016-2017 Roman Lebedev.
    Copyright (C) 2019 Heiko Bauke.
    Copyright (C) 2019-2021 Philippe Weyland.
    Copyright (C) 2020 Aldric Renaudin.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2023 Aurélien PIERRE.
    Copyright (C) 2023 Luca Zulberti.
    
    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_COMMON_UNDO_H
#define DT_COMMON_UNDO_H
 
#include "system/dtpthread.h"  // for dt_pthread_mutex_t
#include <glib.h>              // for gpointer, GList, gboolean
#include <stdint.h>            // for uint32_t
 
//  types that are known by the undo module
typedef enum dt_undo_type_t
{
  DT_UNDO_NONE        = 0,
  DT_UNDO_GEOTAG      = 1 << 0,
  DT_UNDO_HISTORY     = 1 << 1,
  DT_UNDO_MASK        = 1 << 2,
  DT_UNDO_RATINGS     = 1 << 3,
  DT_UNDO_COLORLABELS = 1 << 4,
  DT_UNDO_TAGS        = 1 << 5,
  DT_UNDO_METADATA    = 1 << 6,
  DT_UNDO_LT_HISTORY  = 1 << 7,
  DT_UNDO_FLAGS       = 1 << 8,
  DT_UNDO_DATETIME    = 1 << 9,
  DT_UNDO_DUPLICATE   = 1 << 10,
  DT_UNDO_REMOVE      = 1 << 11,
  DT_UNDO_DEVELOP     = DT_UNDO_HISTORY | DT_UNDO_MASK | DT_UNDO_TAGS
                        | DT_UNDO_RATINGS | DT_UNDO_COLORLABELS | DT_UNDO_DUPLICATE,
  DT_UNDO_LIGHTTABLE  = DT_UNDO_RATINGS | DT_UNDO_COLORLABELS | DT_UNDO_TAGS
                        | DT_UNDO_METADATA | DT_UNDO_LT_HISTORY | DT_UNDO_GEOTAG
                        | DT_UNDO_FLAGS | DT_UNDO_DATETIME | DT_UNDO_DUPLICATE
                        | DT_UNDO_REMOVE,
  DT_UNDO_MAP         = DT_UNDO_GEOTAG | DT_UNDO_TAGS | DT_UNDO_DATETIME,
  DT_UNDO_ALL         = DT_UNDO_MAP | DT_UNDO_DEVELOP | DT_UNDO_LIGHTTABLE
} dt_undo_type_t;
 
typedef enum dt_undo_action_t
{
  DT_ACTION_UNDO,
  DT_ACTION_REDO
} dt_undo_action_t;
 
typedef void *dt_undo_data_t;
 
typedef struct dt_undo_t
{
  GList *undo_list, *redo_list;
  dt_undo_type_t group;
  int group_indent;
  dt_pthread_mutex_t mutex;
  gboolean locked;
  gboolean disable_next;
} dt_undo_t;
 
dt_undo_t *dt_undo_init(void);
void dt_undo_cleanup(dt_undo_t *self);
 
// 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).
dt_undo_t *dt_undo_get_global(void);
 
// create a group of item to be handled together, a group
void dt_undo_start_group(dt_undo_t *self, dt_undo_type_t type);
void dt_undo_end_group(dt_undo_t *self);
 
// record a change that will be insered into the undo list
void dt_undo_record(dt_undo_t *self, gpointer user_data, dt_undo_type_t type, dt_undo_data_t data,
                    void (*undo)(gpointer user_data, dt_undo_type_t type, dt_undo_data_t item, dt_undo_action_t action, GList **imgs),
                    void (*free_data)(gpointer data));
 
//  undo an element which correspond to filter. filter here is expected to be
//  a set of dt_undo_type_t.
void dt_undo_do_undo(dt_undo_t *self, uint32_t filter);
 
//  redo a previously undone action, does nothing if the redo list is empty
void dt_undo_do_redo(dt_undo_t *self, uint32_t filter);
 
//  removes all items which correspond to filter in the undo/redo lists
void dt_undo_clear(dt_undo_t *self, uint32_t filter);
 
void dt_undo_iterate_internal(dt_undo_t *self, uint32_t filter, gpointer user_data,
                              void (*apply)(gpointer user_data, dt_undo_type_t type, dt_undo_data_t item));
 
void dt_undo_iterate(dt_undo_t *self, uint32_t filter, gpointer user_data,
                     void (*apply)(gpointer user_data, dt_undo_type_t type, dt_undo_data_t item));
 
// disable the next record, this is to avoid recording when reverting a value (in undo callbacks)
void dt_undo_disable_next(dt_undo_t *self);
 
// Check if the undo/redo stack has at least one available element for the corresponding filter.
// Mostly meant to disable GUI undo/redo controls if they wouldn't have any effect.
gboolean dt_is_undo_list_populated(dt_undo_t *self, uint32_t filter);
gboolean dt_is_redo_list_populated(dt_undo_t *self, uint32_t filter);
 
int dt_undo_list_length(dt_undo_t *self, uint32_t filter);
int dt_redo_list_length(dt_undo_t *self, uint32_t filter);
 
#endif // DT_COMMON_UNDO_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