Blender V5.3
BKE_undo_system.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4#pragma once
5
9
10#include "BLI_enum_flags.hh"
11#include "BLI_function_ref.hh"
12#include "BLI_path_utils.hh"
13
14#include "DNA_ID.h"
15#include "DNA_listBase.h"
16#include "DNA_userdef_types.h"
17
18namespace blender {
19
20struct Main;
21struct UndoStep;
22struct UndoType;
23struct bContext;
24
25/* IDs */
26struct GreasePencil;
27struct Main;
28struct Mesh;
29struct Object;
30struct Scene;
31struct Text;
32
38enum class UndoEncodeHints {
40 None = 0,
56};
58
64/* UndoRefID_Mesh & friends. */
65#define UNDO_REF_ID_TYPE(ptr_ty) \
66 struct UndoRefID_##ptr_ty { \
67 struct ptr_ty *ptr; \
68 char name[MAX_ID_NAME]; \
69 char library_filepath_abs[FILE_MAX]; \
70 }
78
102
103struct UndoStep {
105 char name[64];
108 size_t data_size;
110 bool skip;
120 /* Over alloc 'type->struct_size'. */
121};
122
128
135
136using UndoTypeForEachIDRefFn = void (*)(void *user_data, UndoRefID *id_ref);
137
138struct UndoType {
144 const char *identifier;
145
152 bool (*poll)(bContext *C);
153
161
162 bool (*step_encode)(bContext *C, Main *bmain, UndoStep *us);
163
167 void (*step_decode)(bContext *C, Main *bmain, UndoStep *us, eUndoStepDir dir, bool is_final);
168
174 void (*step_free)(UndoStep *us);
175
189 UndoTypeForEachIDRefFn foreach_ID_ref_fn,
190 void *user_data);
191
194
199 size_t step_size;
200};
201
223
224/* -------------------------------------------------------------------- */
229
230extern const UndoType *BKE_UNDOSYS_TYPE_IMAGE;
231extern const UndoType *BKE_UNDOSYS_TYPE_MEMFILE;
232extern const UndoType *BKE_UNDOSYS_TYPE_PAINTCURVE;
233extern const UndoType *BKE_UNDOSYS_TYPE_PARTICLE;
234extern const UndoType *BKE_UNDOSYS_TYPE_SCULPT;
235extern const UndoType *BKE_UNDOSYS_TYPE_TEXT;
236
238
239#define BKE_UNDOSYS_TYPE_IS_MEMFILE_SKIP(ty) ELEM(ty, BKE_UNDOSYS_TYPE_IMAGE)
240
241UndoStack *BKE_undosys_stack_create();
242void BKE_undosys_stack_destroy(UndoStack *ustack);
243void BKE_undosys_stack_clear(UndoStack *ustack);
244void BKE_undosys_stack_clear_active(UndoStack *ustack);
245/* name optional */
246bool BKE_undosys_stack_has_undo(const UndoStack *ustack, const char *name);
250bool BKE_undosys_stack_has_redo(const UndoStack *ustack);
251void BKE_undosys_stack_init_from_main(UndoStack *ustack, Main *bmain);
252/* Called after #BKE_undosys_stack_init_from_main. */
253void BKE_undosys_stack_init_from_context(UndoStack *ustack, bContext *C);
254UndoStep *BKE_undosys_stack_active_with_type(UndoStack *ustack, const UndoType *ut);
255UndoStep *BKE_undosys_stack_init_or_active_with_type(UndoStack *ustack, const UndoType *ut);
260void BKE_undosys_stack_limit_steps_and_memory(UndoStack *ustack, int steps, size_t memory_limit);
261#define BKE_undosys_stack_limit_steps_and_memory_defaults(ustack) \
262 BKE_undosys_stack_limit_steps_and_memory(ustack, U.undosteps, size_t(U.undomemory) * 1024 * 1024)
263
264void BKE_undosys_stack_group_begin(UndoStack *ustack);
265void BKE_undosys_stack_group_end(UndoStack *ustack);
266
270UndoStep *BKE_undosys_step_push_init_with_type(UndoStack *ustack,
271 bContext *C,
272 const char *name,
273 const UndoType *ut);
274UndoStep *BKE_undosys_step_push_init(UndoStack *ustack, bContext *C, const char *name);
275
280 UndoStack *ustack, bContext *C, const char *name, UndoEncodeHints hints, const UndoType *ut);
281eUndoPushReturn BKE_undosys_step_push(UndoStack *ustack,
282 bContext *C,
283 const char *name,
284 UndoEncodeHints hints);
285
286UndoStep *BKE_undosys_step_find_by_name_with_type(UndoStack *ustack,
287 const char *name,
288 const UndoType *ut);
289UndoStep *BKE_undosys_step_find_by_type(UndoStack *ustack, const UndoType *ut);
290UndoStep *BKE_undosys_step_find_by_name(UndoStack *ustack, const char *name);
291
300eUndoStepDir BKE_undosys_step_calc_direction(const UndoStack *ustack,
301 const UndoStep *us_target,
302 const UndoStep *us_reference);
303
318 UndoStack *ustack, bContext *C, UndoStep *us_target, UndoStep *us_reference, bool use_skip);
322bool BKE_undosys_step_load_data(UndoStack *ustack, bContext *C, UndoStep *us_target);
327void BKE_undosys_step_load_from_index(UndoStack *ustack, bContext *C, int index);
328
340bool BKE_undosys_step_undo_with_data_ex(UndoStack *ustack,
341 bContext *C,
342 UndoStep *us_target,
343 bool use_skip);
349bool BKE_undosys_step_undo_with_data(UndoStack *ustack, bContext *C, UndoStep *us_target);
353bool BKE_undosys_step_undo(UndoStack *ustack, bContext *C);
354
366bool BKE_undosys_step_redo_with_data_ex(UndoStack *ustack,
367 bContext *C,
368 UndoStep *us_target,
369 bool use_skip);
375bool BKE_undosys_step_redo_with_data(UndoStack *ustack, bContext *C, UndoStep *us_target);
379bool BKE_undosys_step_redo(UndoStack *ustack, bContext *C);
380
384UndoStep *BKE_undosys_step_same_type_next(UndoStep *us);
388UndoStep *BKE_undosys_step_same_type_prev(UndoStep *us);
389
390/* Type System. */
391
399bool BKE_undosys_type_foreach(FunctionRef<bool(const UndoType *ut)> fn);
400
404UndoType *BKE_undosys_type_append(void (*undosys_fn)(UndoType *));
406
411const UndoType *BKE_undosys_type_from_context(bContext *C);
412
413/* ID Accessor. */
414
415#if 0 /* functionality is only used internally for now. */
416void BKE_undosys_foreach_ID_ref(UndoStack *ustack,
417 UndoTypeForEachIDRefFn foreach_ID_ref_fn,
418 void *user_data);
419#endif
420
421void BKE_undosys_print(UndoStack *ustack);
422
423} // namespace blender
#define ENUM_OPERATORS(_enum_type)
#define FILE_MAX
ID and Library types, which are fundamental for SDNA.
#define MAX_ID_NAME
Definition DNA_ID.h:367
These structs are the foundation for all linked lists in the library system.
#define C
Definition RandGen.cpp:29
#define index(i)
ENUM_OPERATORS(Layer::Flags)
BMesh Iterators.
void BKE_undosys_stack_init_from_main(UndoStack *ustack, Main *bmain)
void BKE_undosys_type_free_all()
UndoStep * BKE_undosys_step_same_type_next(UndoStep *us)
unsigned int uint
Definition BKE_text.h:55
bool BKE_undosys_stack_has_undo(const UndoStack *ustack, const char *name)
@ UNDOTYPE_FLAG_DECODE_ACTIVE_STEP
@ UNDOTYPE_FLAG_NEED_CONTEXT_FOR_ENCODE
@ UNDOTYPE_FLAG_ENCODE_PRE_MEMFILE_SUPPORTED
const UndoType * BKE_UNDOSYS_TYPE_PAINTCURVE
const UndoType * BKE_UNDOSYS_TYPE_PARTICLE
bool BKE_undosys_step_redo_with_data(UndoStack *ustack, bContext *C, UndoStep *us_target)
void BKE_undosys_stack_clear_active(UndoStack *ustack)
void BKE_undosys_stack_group_end(UndoStack *ustack)
UndoStack * BKE_undosys_stack_create()
bool BKE_undosys_step_undo_with_data_ex(UndoStack *ustack, bContext *C, UndoStep *us_target, bool use_skip)
bool BKE_undosys_step_load_data(UndoStack *ustack, bContext *C, UndoStep *us_target)
void BKE_undosys_stack_group_begin(UndoStack *ustack)
void BKE_undosys_stack_clear(UndoStack *ustack)
eUndoStepDir BKE_undosys_step_calc_direction(const UndoStack *ustack, const UndoStep *us_target, const UndoStep *us_reference)
void BKE_undosys_print(UndoStack *ustack)
void BKE_undosys_step_load_from_index(UndoStack *ustack, bContext *C, int index)
const UndoType * BKE_UNDOSYS_TYPE_TEXT
bool BKE_undosys_type_foreach(FunctionRef< bool(const UndoType *ut)> fn)
UndoStep * BKE_undosys_stack_init_or_active_with_type(UndoStack *ustack, const UndoType *ut)
const UndoType * BKE_UNDOSYS_TYPE_SCULPT
const UndoType * BKE_UNDOSYS_TYPE_MEMFILE
bool BKE_undosys_step_undo(UndoStack *ustack, bContext *C)
bool BKE_undosys_step_undo_with_data(UndoStack *ustack, bContext *C, UndoStep *us_target)
bool BKE_undosys_step_redo(UndoStack *ustack, bContext *C)
UNDO_REF_ID_TYPE(GreasePencil)
UndoStep * BKE_undosys_step_push_init(UndoStack *ustack, bContext *C, const char *name)
UndoStep * BKE_undosys_stack_active_with_type(UndoStack *ustack, const UndoType *ut)
@ UNDO_PUSH_RET_OVERRIDE_CHANGED
void BKE_undosys_stack_init_from_context(UndoStack *ustack, bContext *C)
void BKE_undosys_stack_limit_steps_and_memory(UndoStack *ustack, int steps, size_t memory_limit)
bool BKE_undosys_stack_has_redo(const UndoStack *ustack)
UndoStep * BKE_undosys_step_find_by_name_with_type(UndoStack *ustack, const char *name, const UndoType *ut)
void(*)(void *user_data, UndoRefID *id_ref) UndoTypeForEachIDRefFn
UndoStep * BKE_undosys_step_same_type_prev(UndoStep *us)
bool BKE_undosys_step_load_data_ex(UndoStack *ustack, bContext *C, UndoStep *us_target, UndoStep *us_reference, bool use_skip)
UndoStep * BKE_undosys_step_find_by_name(UndoStack *ustack, const char *name)
void BKE_undosys_stack_destroy(UndoStack *ustack)
UndoStep * BKE_undosys_step_find_by_type(UndoStack *ustack, const UndoType *ut)
eUndoPushReturn BKE_undosys_step_push_with_type(UndoStack *ustack, bContext *C, const char *name, UndoEncodeHints hints, const UndoType *ut)
bool BKE_undosys_step_redo_with_data_ex(UndoStack *ustack, bContext *C, UndoStep *us_target, bool use_skip)
const UndoType * BKE_UNDOSYS_TYPE_IMAGE
const UndoType * BKE_undosys_type_from_context(bContext *C)
UndoType * BKE_undosys_type_append(void(*undosys_fn)(UndoType *))
eUndoPushReturn BKE_undosys_step_push(UndoStack *ustack, bContext *C, const char *name, UndoEncodeHints hints)
UndoStep * BKE_undosys_step_push_init_with_type(UndoStack *ustack, bContext *C, const char *name, const UndoType *ut)
char library_filepath_abs[FILE_MAX]
char name[MAX_ID_NAME]
UndoStep * step_active_memfile
ListBaseT< UndoStep > steps
const UndoType * type
bool(*) poll(bContext *C)
void(*) step_free(UndoStep *us)
void(*) step_decode(bContext *C, Main *bmain, UndoStep *us, eUndoStepDir dir, bool is_final)
void(*) step_foreach_ID_ref(UndoStep *us, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data)
bool(*) step_encode(bContext *C, Main *bmain, UndoStep *us)
const char * identifier
void(*) step_encode_init(bContext *C, UndoStep *us)