05093deec702aabba97f4bf071cd66353c0610da
[blender.git] / source / blender / blenkernel / BKE_undo_system.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * ***** END GPL LICENSE BLOCK *****
19  */
20 #ifndef __BKE_UNDO_SYSTEM_H__
21 #define __BKE_UNDO_SYSTEM_H__
22
23 /** \file BKE_undo_system.h
24  *  \ingroup bke
25  */
26
27 struct Main;
28 struct UndoStep;
29 struct bContext;
30
31 /* ID's */
32 struct Mesh;
33 struct Object;
34 struct Scene;
35 struct Text;
36
37 #include "DNA_ID.h"
38 #include "DNA_listBase.h"
39
40 typedef struct UndoRefID { struct ID *ptr; char name[MAX_ID_NAME]; } UndoRefID;
41 /* UndoRefID_Mesh & friends. */
42 #define UNDO_REF_ID_TYPE(ptr_ty) \
43         typedef struct UndoRefID_##ptr_ty { struct ptr_ty *ptr; char name[MAX_ID_NAME]; } UndoRefID_##ptr_ty
44 UNDO_REF_ID_TYPE(Mesh);
45 UNDO_REF_ID_TYPE(Object);
46 UNDO_REF_ID_TYPE(Scene);
47 UNDO_REF_ID_TYPE(Text);
48
49 typedef struct UndoStack {
50         ListBase         steps;
51         struct UndoStep *step_active;
52
53         /**
54          * Some undo systems require begin/end, see: #UndoType.step_encode_init
55          *
56          * \note This is not included in the 'steps' list.
57          * That is done once end is called.
58          */
59         struct UndoStep *step_init;
60 } UndoStack;
61
62
63 typedef struct UndoStep {
64         struct UndoStep *next, *prev;
65         char name[64];
66         const struct UndoType *type;
67         /** Size in bytes of all data in step (not including the step). */
68         size_t data_size;
69         /** Users should never see this step (only use for internal consistency). */
70         bool skip;
71         /* Over alloc 'type->struct_size'. */
72 } UndoStep;
73
74 typedef enum eUndoTypeMode {
75         /**
76          * Each undo step stores a version of the state.
77          * This means we can simply load in a previous state at any time.
78          */
79         BKE_UNDOTYPE_MODE_STORE = 1,
80         /**
81          * Each undo step is a series of edits.
82          * This means to change states we need to apply each edit.
83          * It also means the 'step_decode' callback needs to detect the difference between undo and redo.
84          * (Currently used for text edit and image & sculpt painting).
85          */
86         BKE_UNDOTYPE_MODE_ACCUMULATE = 2,
87 } eUndoTypeMode;
88
89 typedef void (*UndoTypeForEachIDRefFn)(void *user_data, struct UndoRefID *id_ref);
90
91 typedef struct UndoType {
92         struct UndoType *next, *prev;
93         /** Only for debugging. */
94         const char *name;
95
96         /**
97          * When NULL, we don't consider this undo type for context checks.
98          * Operators must explicitly set the undo type and handle adding the undo step.
99          * This is needed when tools operate on data which isn't the primary mode (eg, paint-curve in sculpt mode).
100          */
101         bool (*poll)(struct bContext *C);
102
103         /**
104          * None of these callbacks manage list add/removal.
105          *
106          * Note that 'step_encode_init' is optional,
107          * some undo types need to perform operatons before undo push finishes.
108          */
109         void (*step_encode_init)(struct bContext *C, UndoStep *us);
110
111         bool (*step_encode)(struct bContext *C, UndoStep *us);
112         void (*step_decode)(struct bContext *C, UndoStep *us, int dir);
113
114         /**
115          * \note When freeing all steps,
116          * free from the last since #MemFileUndoType will merge with the next undo type in the list. */
117         void (*step_free)(UndoStep *us);
118
119         void (*step_foreach_ID_ref)(UndoStep *us, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data);
120
121         eUndoTypeMode mode;
122         bool use_context;
123
124         int step_size;
125 } UndoType;
126
127 /* expose since we need to perform operations on spesific undo types (rarely). */
128 extern const UndoType *BKE_UNDOSYS_TYPE_IMAGE;
129 extern const UndoType *BKE_UNDOSYS_TYPE_MEMFILE;
130 extern const UndoType *BKE_UNDOSYS_TYPE_PAINTCURVE;
131 extern const UndoType *BKE_UNDOSYS_TYPE_PARTICLE;
132 extern const UndoType *BKE_UNDOSYS_TYPE_SCULPT;
133 extern const UndoType *BKE_UNDOSYS_TYPE_TEXT;
134
135 UndoStack      *BKE_undosys_stack_create(void);
136 void            BKE_undosys_stack_destroy(UndoStack *ustack);
137 void            BKE_undosys_stack_clear(UndoStack *ustack);
138 bool            BKE_undosys_stack_has_undo(UndoStack *ustack, const char *name);
139 void            BKE_undosys_stack_init_from_main(UndoStack *ustack, struct Main *bmain);
140 void            BKE_undosys_stack_init_from_context(UndoStack *ustack, struct bContext *C);
141 UndoStep       *BKE_undosys_stack_active_with_type(UndoStack *ustack, const UndoType *ut);
142 UndoStep       *BKE_undosys_stack_init_or_active_with_type(UndoStack *ustack, const UndoType *ut);
143 void            BKE_undosys_stack_limit_steps_and_memory(UndoStack *ustack, int steps, size_t memory_limit);
144
145 /* Only some UndoType's require init. */
146 UndoStep *BKE_undosys_step_push_init_with_type(UndoStack *ustack, struct bContext *C, const char *name, const UndoType *ut);
147 UndoStep *BKE_undosys_step_push_init(UndoStack *ustack, struct bContext *C, const char *name);
148
149 bool BKE_undosys_step_push_with_type(UndoStack *ustack, struct bContext *C, const char *name, const UndoType *ut);
150 bool BKE_undosys_step_push(UndoStack *ustack, struct bContext *C, const char *name);
151
152 UndoStep *BKE_undosys_step_find_by_name_with_type(UndoStack *ustack, const char *name, const UndoType *ut);
153 UndoStep *BKE_undosys_step_find_by_type(UndoStack *ustack, const UndoType *ut);
154 UndoStep *BKE_undosys_step_find_by_name(UndoStack *ustack, const char *name);
155
156 bool BKE_undosys_step_undo_with_data_ex(UndoStack *ustack, struct bContext *C, UndoStep *us, bool use_skip);
157 bool BKE_undosys_step_undo_with_data(UndoStack *ustack, struct bContext *C, UndoStep *us);
158 bool BKE_undosys_step_undo(UndoStack *ustack, struct bContext *C);
159
160 bool BKE_undosys_step_redo_with_data_ex(UndoStack *ustack, struct bContext *C, UndoStep *us, bool use_skip);
161 bool BKE_undosys_step_redo_with_data(UndoStack *ustack, struct bContext *C, UndoStep *us);
162 bool BKE_undosys_step_redo(UndoStack *ustack, struct bContext *C);
163
164 bool BKE_undosys_step_load_data(UndoStack *ustack, struct bContext *C, UndoStep *us);
165
166 bool BKE_undosys_step_undo_compat_only(UndoStack *ustack, struct bContext *C, int step);
167 void BKE_undosys_step_undo_from_index(UndoStack *ustack, struct bContext *C, int index);
168 UndoStep *BKE_undosys_step_same_type_next(UndoStep *us);
169 UndoStep *BKE_undosys_step_same_type_prev(UndoStep *us);
170
171 /* Type System */
172 UndoType *BKE_undosys_type_append(void (*undosys_fn)(UndoType *));
173 void      BKE_undosys_type_free_all(void);
174
175 /* ID Accessor */
176 #if 0  /* functionality is only used internally for now. */
177 void BKE_undosys_foreach_ID_ref(UndoStack *ustack, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data);
178 #endif
179
180 /* Use when the undo step stores many arbitrary pointers. */
181 struct UndoIDPtrMap;
182 struct UndoIDPtrMap *BKE_undosys_ID_map_create(void);
183 void                 BKE_undosys_ID_map_destroy(struct UndoIDPtrMap *map);
184 void                 BKE_undosys_ID_map_add(struct UndoIDPtrMap *map, ID *id);
185 struct ID           *BKE_undosys_ID_map_lookup(const struct UndoIDPtrMap *map, const struct ID *id_src);
186
187 void BKE_undosys_ID_map_add_with_prev(
188         struct UndoIDPtrMap *map, struct ID *id,
189         struct ID **id_prev);
190 struct ID *BKE_undosys_ID_map_lookup_with_prev(
191         const struct UndoIDPtrMap *map, struct ID *id_src,
192         struct ID *id_prev_match[2]);
193
194 void BKE_undosys_ID_map_foreach_ID_ref(
195         struct UndoIDPtrMap *map,
196         UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data);
197
198 #endif  /* __BKE_UNDO_SYSTEM_H__ */