7eaf42591f0619054dff093a50d383f6558bd6bd
[blender.git] / source / blender / blenkernel / intern / undo_system.c
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
21 /** \file blender/blenkernel/intern/undo_system.c
22  *  \ingroup bke
23  *
24  * Used by ED_undo.h, internal implementation.
25  */
26
27 #include <string.h>
28
29 #include "CLG_log.h"
30
31 #include "BLI_utildefines.h"
32 #include "BLI_sys_types.h"
33 #include "BLI_listbase.h"
34 #include "BLI_string.h"
35 #include "BLI_sort_utils.h"
36
37 #include "DNA_listBase.h"
38 #include "DNA_windowmanager_types.h"
39
40 #include "BKE_context.h"
41 #include "BKE_global.h"
42 #include "BKE_main.h"
43 #include "BKE_undo_system.h"
44
45 #include "MEM_guardedalloc.h"
46
47 #define undo_stack _wm_undo_stack_disallow  /* pass in as a variable always. */
48
49 /** Odd requirement of Blender that we always keep a memfile undo in the stack. */
50 #define WITH_GLOBAL_UNDO_KEEP_ONE
51
52 /** Make sure all ID's created at the point we add an undo step that uses ID's. */
53 #define WITH_GLOBAL_UNDO_ENSURE_UPDATED
54
55 /** We only need this locally. */
56 static CLG_LogRef LOG = {"bke.undosys"};
57
58 /* -------------------------------------------------------------------- */
59 /** \name Internal Nested Undo Checks
60  *
61  * Make sure we're not running undo operations from 'step_encode', 'step_decode' callbacks.
62  * bugs caused by this situation aren't _that_ hard to spot but aren't always so obvious.
63  * Best we have a check which shows the problem immediately.
64  *
65  * \{ */
66 #define WITH_NESTED_UNDO_CHECK
67
68 #ifdef WITH_NESTED_UNDO_CHECK
69 static bool g_undo_callback_running = false;
70 #  define UNDO_NESTED_ASSERT(state) BLI_assert(g_undo_callback_running == state)
71 #  define UNDO_NESTED_CHECK_BEGIN { \
72         UNDO_NESTED_ASSERT(false); \
73         g_undo_callback_running = true; \
74 } ((void)0)
75 #  define UNDO_NESTED_CHECK_END { \
76         UNDO_NESTED_ASSERT(true); \
77         g_undo_callback_running = false; \
78 } ((void)0)
79 #else
80 #  define UNDO_NESTED_ASSERT(state) ((void)0)
81 #  define UNDO_NESTED_CHECK_BEGIN ((void)0)
82 #  define UNDO_NESTED_CHECK_END   ((void)0)
83 #endif
84 /** \} */
85
86 /* -------------------------------------------------------------------- */
87 /** \name Public Undo Types
88  *
89  * Unfortunately we need this for a handful of places.
90  */
91 const UndoType *BKE_UNDOSYS_TYPE_IMAGE = NULL;
92 const UndoType *BKE_UNDOSYS_TYPE_MEMFILE = NULL;
93 const UndoType *BKE_UNDOSYS_TYPE_PAINTCURVE = NULL;
94 const UndoType *BKE_UNDOSYS_TYPE_PARTICLE = NULL;
95 const UndoType *BKE_UNDOSYS_TYPE_SCULPT = NULL;
96 const UndoType *BKE_UNDOSYS_TYPE_TEXT = NULL;
97 /** \} */
98
99 /* UndoType */
100
101 static ListBase g_undo_types = {NULL, NULL};
102
103 static const UndoType *BKE_undosys_type_from_context(bContext *C)
104 {
105         for (const UndoType *ut = g_undo_types.first; ut; ut = ut->next) {
106                 /* No poll means we don't check context. */
107                 if (ut->poll && ut->poll(C)) {
108                         return ut;
109                 }
110         }
111         return NULL;
112 }
113
114 /* -------------------------------------------------------------------- */
115 /** \name Internal Callback Wrappers
116  *
117  * #UndoRefID is simply a way to avoid inlining name copy and lookups,
118  * since it's easy to forget a single case when done inline (crashing in some cases).
119  *
120  * \{ */
121
122 static void undosys_id_ref_store(void *UNUSED(user_data), UndoRefID *id_ref)
123 {
124         BLI_assert(id_ref->name[0] == '\0');
125         if (id_ref->ptr) {
126                 BLI_strncpy(id_ref->name, id_ref->ptr->name, sizeof(id_ref->name));
127                 /* Not needed, just prevents stale data access. */
128                 id_ref->ptr = NULL;
129         }
130 }
131
132 static void undosys_id_ref_resolve(void *user_data, UndoRefID *id_ref)
133 {
134         /* Note: we could optimize this, for now it's not too bad since it only runs when we access undo! */
135         Main *bmain = user_data;
136         ListBase *lb = which_libbase(bmain, GS(id_ref->name));
137         for (ID *id = lb->first; id; id = id->next) {
138                 if (STREQ(id_ref->name, id->name) && (id->lib == NULL)) {
139                         id_ref->ptr = id;
140                         break;
141                 }
142         }
143 }
144
145 static bool undosys_step_encode(bContext *C, UndoStep *us)
146 {
147         CLOG_INFO(&LOG, 2, "addr=%p, name='%s', type='%s'", us, us->name, us->type->name);
148         UNDO_NESTED_CHECK_BEGIN;
149         bool ok = us->type->step_encode(C, us);
150         UNDO_NESTED_CHECK_END;
151         if (ok) {
152                 if (us->type->step_foreach_ID_ref != NULL) {
153                         /* Don't use from context yet because sometimes context is fake and not all members are filled in. */
154                         Main *bmain = G.main;
155                         us->type->step_foreach_ID_ref(us, undosys_id_ref_store, bmain);
156                 }
157         }
158         if (ok == false) {
159                 CLOG_INFO(&LOG, 2, "encode callback didn't create undo step");
160         }
161         return ok;
162 }
163
164 static void undosys_step_decode(bContext *C, UndoStep *us, int dir)
165 {
166         CLOG_INFO(&LOG, 2, "addr=%p, name='%s', type='%s'", us, us->name, us->type->name);
167         if (us->type->step_foreach_ID_ref) {
168                 /* Don't use from context yet because sometimes context is fake and not all members are filled in. */
169                 Main *bmain = G.main;
170                 us->type->step_foreach_ID_ref(us, undosys_id_ref_resolve, bmain);
171         }
172
173         UNDO_NESTED_CHECK_BEGIN;
174         us->type->step_decode(C, us, dir);
175         UNDO_NESTED_CHECK_END;
176 }
177
178 static void undosys_step_free_and_unlink(UndoStack *ustack, UndoStep *us)
179 {
180         CLOG_INFO(&LOG, 2, "addr=%p, name='%s', type='%s'", us, us->name, us->type->name);
181         UNDO_NESTED_CHECK_BEGIN;
182         us->type->step_free(us);
183         UNDO_NESTED_CHECK_END;
184
185         BLI_remlink(&ustack->steps, us);
186         MEM_freeN(us);
187 }
188
189 /** \} */
190
191 /* -------------------------------------------------------------------- */
192 /** \name Undo Stack
193  * \{ */
194
195 #ifndef NDEBUG
196 static void undosys_stack_validate(UndoStack *ustack, bool expect_non_empty)
197 {
198         if (ustack->step_active != NULL) {
199                 BLI_assert(!BLI_listbase_is_empty(&ustack->steps));
200                 BLI_assert(BLI_findindex(&ustack->steps, ustack->step_active) != -1);
201         }
202         if (expect_non_empty) {
203                 BLI_assert(!BLI_listbase_is_empty(&ustack->steps));
204         }
205 }
206 #else
207 static void undosys_stack_validate(UndoStack *ustack, bool expect_non_empty)
208 {
209         UNUSED_VARS(ustack, expect_non_empty);
210 }
211 #endif
212
213 UndoStack *BKE_undosys_stack_create(void)
214 {
215         UndoStack *ustack = MEM_callocN(sizeof(UndoStack), __func__);
216         return ustack;
217 }
218
219 void BKE_undosys_stack_destroy(UndoStack *ustack)
220 {
221         BKE_undosys_stack_clear(ustack);
222         MEM_freeN(ustack);
223 }
224
225 void BKE_undosys_stack_clear(UndoStack *ustack)
226 {
227         UNDO_NESTED_ASSERT(false);
228         CLOG_INFO(&LOG, 1, "steps=%d", BLI_listbase_count(&ustack->steps));
229         for (UndoStep *us = ustack->steps.last, *us_prev; us; us = us_prev) {
230                 us_prev = us->prev;
231                 undosys_step_free_and_unlink(ustack, us);
232         }
233         BLI_listbase_clear(&ustack->steps);
234         ustack->step_active = NULL;
235 }
236
237 static bool undosys_stack_push_main(UndoStack *ustack, const char *name, struct Main *bmain)
238 {
239         UNDO_NESTED_ASSERT(false);
240         CLOG_INFO(&LOG, 1, "'%s'", name);
241         bContext *C_temp = CTX_create();
242         CTX_data_main_set(C_temp, bmain);
243         bool ok = BKE_undosys_step_push_with_type(ustack, C_temp, name, BKE_UNDOSYS_TYPE_MEMFILE);
244         CTX_free(C_temp);
245         return ok;
246 }
247
248 void BKE_undosys_stack_init_from_main(UndoStack *ustack, struct Main *bmain)
249 {
250         UNDO_NESTED_ASSERT(false);
251         undosys_stack_push_main(ustack, "original", bmain);
252 }
253
254 /* called after 'BKE_undosys_stack_init_from_main' */
255 void BKE_undosys_stack_init_from_context(UndoStack *ustack, bContext *C)
256 {
257         const UndoType *ut = BKE_undosys_type_from_context(C);
258         if ((ut != NULL) && (ut != BKE_UNDOSYS_TYPE_MEMFILE) && (ut->mode == BKE_UNDOTYPE_MODE_STORE)) {
259                 BKE_undosys_step_push_with_type(ustack, C, "original mode", ut);
260         }
261 }
262
263 /* name optional */
264 bool BKE_undosys_stack_has_undo(UndoStack *ustack, const char *name)
265 {
266         if (name) {
267                 UndoStep *us = BLI_rfindstring(&ustack->steps, name, offsetof(UndoStep, name));
268                 return us && us->prev;
269         }
270
271         return !BLI_listbase_is_empty(&ustack->steps);
272 }
273
274 UndoStep *BKE_undosys_stack_active_with_type(UndoStack *ustack, const UndoType *ut)
275 {
276         UndoStep *us = ustack->step_active;
277         while (us && (us->type != ut)) {
278                 us = us->prev;
279         }
280         return us;
281 }
282
283 UndoStep *BKE_undosys_stack_init_or_active_with_type(UndoStack *ustack, const UndoType *ut)
284 {
285         UNDO_NESTED_ASSERT(false);
286         CLOG_INFO(&LOG, 1, "type='%s'", ut->name);
287         if (ustack->step_init && (ustack->step_init->type == ut)) {
288                 return ustack->step_init;
289         }
290         return BKE_undosys_stack_active_with_type(ustack, ut);
291 }
292
293 /**
294  * \param steps: Limit the number of undo steps.
295  * \param memory_limit: Limit the amount of memory used by the undo stack.
296  */
297 void BKE_undosys_stack_limit_steps_and_memory(UndoStack *ustack, int steps, size_t memory_limit)
298 {
299         UNDO_NESTED_ASSERT(false);
300         if (!(steps || memory_limit)) {
301                 return;
302         }
303
304         CLOG_INFO(&LOG, 1, "steps=%d, memory_limit=%zu", steps, memory_limit);
305         UndoStep *us;
306 #ifdef WITH_GLOBAL_UNDO_KEEP_ONE
307         UndoStep *us_exclude = NULL;
308 #endif
309         /* keep at least two (original + other) */
310         size_t data_size_all = 0;
311         size_t us_count = 0;
312         for (us = ustack->steps.last; us && us->prev; us = us->prev) {
313                 if (memory_limit) {
314                         data_size_all += us->data_size;
315                         if (data_size_all > memory_limit) {
316                                 break;
317                         }
318                 }
319                 if (steps) {
320                         if (us_count == steps) {
321                                 break;
322                         }
323                         if (us->skip == false) {
324                                 us_count += 1;
325                         }
326                 }
327         }
328
329         if (us) {
330                 if (us->prev && us->prev->prev) {
331                         us = us->prev;
332                 }
333
334 #ifdef WITH_GLOBAL_UNDO_KEEP_ONE
335                 /* Hack, we need to keep at least one BKE_UNDOSYS_TYPE_MEMFILE. */
336                 if (us->type != BKE_UNDOSYS_TYPE_MEMFILE) {
337                         us_exclude = us->prev;
338                         while (us_exclude && us->type != BKE_UNDOSYS_TYPE_MEMFILE) {
339                                 us_exclude = us_exclude->prev;
340                         }
341                         if (us_exclude) {
342                                 BLI_remlink(&ustack->steps, us_exclude);
343                         }
344                 }
345 #endif
346                 /* Free from first to last, free functions may update de-duplication info (see #MemFileUndoStep). */
347                 while (ustack->steps.first != us) {
348                         UndoStep *us_first = ustack->steps.first;
349                         BLI_assert(us_first != ustack->step_active);
350                         undosys_step_free_and_unlink(ustack, us_first);
351                 }
352
353 #ifdef WITH_GLOBAL_UNDO_KEEP_ONE
354                 if (us_exclude) {
355                         BLI_addhead(&ustack->steps, us_exclude);
356                 }
357 #endif
358         }
359 }
360
361 /** \} */
362
363 UndoStep *BKE_undosys_step_push_init_with_type(UndoStack *ustack, bContext *C, const char *name, const UndoType *ut)
364 {
365         UNDO_NESTED_ASSERT(false);
366         /* We could detect and clean this up (but it should never happen!). */
367         BLI_assert(ustack->step_init == NULL);
368         if (ut->step_encode_init) {
369                 undosys_stack_validate(ustack, false);
370                 UndoStep *us = MEM_callocN(ut->step_size, __func__);
371                 CLOG_INFO(&LOG, 1, "addr=%p, name='%s', type='%s'", us, name, ut->name);
372                 if (name != NULL) {
373                         BLI_strncpy(us->name, name, sizeof(us->name));
374                 }
375                 us->type = ut;
376                 ustack->step_init = us;
377                 ut->step_encode_init(C, us);
378                 undosys_stack_validate(ustack, true);
379                 return us;
380         }
381         else {
382                 return NULL;
383         }
384 }
385
386 UndoStep *BKE_undosys_step_push_init(UndoStack *ustack, bContext *C, const char *name)
387 {
388         UNDO_NESTED_ASSERT(false);
389         /* We could detect and clean this up (but it should never happen!). */
390         BLI_assert(ustack->step_init == NULL);
391         const UndoType *ut = BKE_undosys_type_from_context(C);
392         if (ut == NULL) {
393                 return NULL;
394         }
395         return BKE_undosys_step_push_init_with_type(ustack, C, name, ut);
396 }
397
398 bool BKE_undosys_step_push_with_type(UndoStack *ustack, bContext *C, const char *name, const UndoType *ut)
399 {
400         UNDO_NESTED_ASSERT(false);
401         undosys_stack_validate(ustack, false);
402         bool is_not_empty = ustack->step_active != NULL;
403
404         /* Remove all undos after (also when 'ustack->step_active == NULL'). */
405         while (ustack->steps.last != ustack->step_active) {
406                 UndoStep *us_iter = ustack->steps.last;
407                 undosys_step_free_and_unlink(ustack, us_iter);
408                 undosys_stack_validate(ustack, is_not_empty);
409         }
410
411         if (ustack->step_active) {
412                 BLI_assert(BLI_findindex(&ustack->steps, ustack->step_active) != -1);
413         }
414
415 #ifdef WITH_GLOBAL_UNDO_ENSURE_UPDATED
416         if (ut->step_foreach_ID_ref != NULL) {
417                 Main *bmain = G.main;
418                 if (bmain->is_memfile_undo_written == false) {
419                         const char *name_internal = "MemFile Internal";
420                         if (undosys_stack_push_main(ustack, name_internal, bmain)) {
421                                 UndoStep *us = ustack->steps.last;
422                                 BLI_assert(STREQ(us->name, name_internal));
423                                 us->skip = true;
424                         }
425                 }
426         }
427 #endif
428
429         UndoStep *us = ustack->step_init ? ustack->step_init : MEM_callocN(ut->step_size, __func__);
430         ustack->step_init = NULL;
431         if (us->name[0] == '\0') {
432                 BLI_strncpy(us->name, name, sizeof(us->name));
433         }
434         us->type = ut;
435         /* initialized, not added yet. */
436
437         if (undosys_step_encode(C, us)) {
438                 ustack->step_active = us;
439                 BLI_addtail(&ustack->steps, us);
440                 undosys_stack_validate(ustack, true);
441                 return true;
442         }
443         else {
444                 MEM_freeN(us);
445                 undosys_stack_validate(ustack, true);
446                 return false;
447         }
448 }
449
450 bool BKE_undosys_step_push(UndoStack *ustack, bContext *C, const char *name)
451 {
452         UNDO_NESTED_ASSERT(false);
453         const UndoType *ut = ustack->step_init ? ustack->step_init->type : BKE_undosys_type_from_context(C);
454         if (ut == NULL) {
455                 return false;
456         }
457         return BKE_undosys_step_push_with_type(ustack, C, name, ut);
458 }
459
460
461 /**
462  * Useful when we want to diff against previous undo data but can't be sure the types match.
463  */
464 UndoStep *BKE_undosys_step_same_type_next(UndoStep *us)
465 {
466         if (us) {
467                 const UndoType *ut = us->type;
468                 while ((us = us->next)) {
469                         if (us->type == ut) {
470                                 return us;
471                         }
472                 }
473
474         }
475         return us;
476 }
477
478 /**
479  * Useful when we want to diff against previous undo data but can't be sure the types match.
480  */
481 UndoStep *BKE_undosys_step_same_type_prev(UndoStep *us)
482 {
483         if (us) {
484                 const UndoType *ut = us->type;
485                 while ((us = us->prev)) {
486                         if (us->type == ut) {
487                                 return us;
488                         }
489                 }
490
491         }
492         return us;
493 }
494
495 UndoStep *BKE_undosys_step_find_by_name_with_type(UndoStack *ustack, const char *name, const UndoType *ut)
496 {
497         for (UndoStep *us = ustack->steps.last; us; us = us->prev) {
498                 if (us->type == ut) {
499                         if (STREQ(name, us->name)) {
500                                 return us;
501                         }
502                 }
503         }
504         return NULL;
505 }
506
507 UndoStep *BKE_undosys_step_find_by_name(UndoStack *ustack, const char *name)
508 {
509         return BLI_rfindstring(&ustack->steps, name, offsetof(UndoStep, name));
510 }
511
512 UndoStep *BKE_undosys_step_find_by_type(UndoStack *ustack, const UndoType *ut)
513 {
514         for (UndoStep *us = ustack->steps.last; us; us = us->prev) {
515                 if (us->type == ut) {
516                         return us;
517                 }
518         }
519         return NULL;
520 }
521
522 bool BKE_undosys_step_undo_with_data_ex(
523         UndoStack *ustack, bContext *C, UndoStep *us,
524         bool use_skip)
525 {
526         UNDO_NESTED_ASSERT(false);
527         if (us) {
528                 undosys_stack_validate(ustack, true);
529         }
530         UndoStep *us_prev = us ? us->prev : NULL;
531         if (us && us->type->mode == BKE_UNDOTYPE_MODE_STORE) {
532                 /* The current state is a copy, we need to load the previous state. */
533                 us = us_prev;
534         }
535
536         if (us != NULL) {
537                 CLOG_INFO(&LOG, 1, "addr=%p, name='%s', type='%s'", us, us->name, us->type->name);
538                 undosys_step_decode(C, us, -1);
539                 ustack->step_active = us_prev;
540                 undosys_stack_validate(ustack, true);
541                 if (use_skip) {
542                         if (ustack->step_active && ustack->step_active->skip) {
543                                 CLOG_INFO(&LOG, 2, "undo continue with skip %p '%s', type='%s'", us, us->name, us->type->name);
544                                 BKE_undosys_step_undo_with_data(ustack, C, ustack->step_active);
545                         }
546                 }
547                 return true;
548         }
549         return false;
550 }
551 bool BKE_undosys_step_undo_with_data(UndoStack *ustack, bContext *C, UndoStep *us)
552 {
553         return BKE_undosys_step_undo_with_data_ex(ustack, C, us, true);
554 }
555
556 bool BKE_undosys_step_undo(UndoStack *ustack, bContext *C)
557 {
558         return BKE_undosys_step_undo_with_data(ustack, C, ustack->step_active);
559 }
560
561 void BKE_undosys_step_undo_from_index(UndoStack *ustack, bContext *C, int index)
562 {
563         UndoStep *us = BLI_findlink(&ustack->steps, index);
564         BLI_assert(us->skip == false);
565         BKE_undosys_step_load_data(ustack, C, us);
566 }
567
568 bool BKE_undosys_step_redo_with_data_ex(
569         UndoStack *ustack, bContext *C, UndoStep *us,
570         bool use_skip)
571 {
572         UNDO_NESTED_ASSERT(false);
573         UndoStep *us_next = us ? us->next : NULL;
574         /* Unlike undo accumulate, we always use the next. */
575         us = us_next;
576
577         if (us != NULL) {
578                 CLOG_INFO(&LOG, 1, "addr=%p, name='%s', type='%s'", us, us->name, us->type->name);
579                 undosys_step_decode(C, us, 1);
580                 ustack->step_active = us_next;
581                 if (use_skip) {
582                         if (ustack->step_active && ustack->step_active->skip) {
583                                 CLOG_INFO(&LOG, 2, "redo continue with skip %p '%s', type='%s'", us, us->name, us->type->name);
584                                 BKE_undosys_step_redo_with_data(ustack, C, ustack->step_active);
585                         }
586                 }
587                 return true;
588         }
589         return false;
590 }
591 bool BKE_undosys_step_redo_with_data(UndoStack *ustack, bContext *C, UndoStep *us)
592 {
593         return BKE_undosys_step_redo_with_data_ex(ustack, C, us, true);
594 }
595
596 bool BKE_undosys_step_redo(UndoStack *ustack, bContext *C)
597 {
598         return BKE_undosys_step_redo_with_data(ustack, C, ustack->step_active);
599 }
600
601 bool BKE_undosys_step_load_data(UndoStack *ustack, bContext *C, UndoStep *us)
602 {
603         UNDO_NESTED_ASSERT(false);
604         const int index_active = BLI_findindex(&ustack->steps, ustack->step_active);
605         const int index_target = BLI_findindex(&ustack->steps, us);
606         BLI_assert(!ELEM(-1, index_active, index_target));
607         bool ok = true;
608
609         if (index_target < index_active) {
610                 uint i = index_active - index_target;
611                 while (i-- && ok) {
612                         ok = BKE_undosys_step_undo_with_data_ex(ustack, C, ustack->step_active, false);
613                 }
614         }
615         else if (index_target > index_active) {
616                 uint i = index_target - index_active;
617                 while (i-- && ok) {
618                         ok = BKE_undosys_step_redo_with_data_ex(ustack, C, ustack->step_active, false);
619                 }
620         }
621
622         if (ok) {
623                 BLI_assert(ustack->step_active == us);
624         }
625
626         return ok;
627 }
628
629 bool BKE_undosys_step_undo_compat_only(UndoStack *ustack, bContext *C, int step)
630 {
631         if (step == 0) {
632                 return BKE_undosys_step_undo_with_data(ustack, C, ustack->step_active);
633         }
634         else if (step == 1) {
635                 return BKE_undosys_step_undo(ustack, C);
636         }
637         else {
638                 return BKE_undosys_step_redo(ustack, C);
639         }
640 }
641 /**
642  * Similar to #WM_operatortype_append
643  */
644 UndoType *BKE_undosys_type_append(void (*undosys_fn)(UndoType *))
645 {
646         UndoType *ut;
647
648         ut = MEM_callocN(sizeof(UndoType), __func__);
649
650         undosys_fn(ut);
651
652         BLI_assert(ut->mode != 0);
653
654         BLI_addtail(&g_undo_types, ut);
655
656         return ut;
657 }
658
659 void BKE_undosys_type_free_all(void)
660 {
661         UndoType *ut;
662         while ((ut = BLI_pophead(&g_undo_types))) {
663                 MEM_freeN(ut);
664         }
665 }
666
667 /** \} */
668
669 /* -------------------------------------------------------------------- */
670 /** \name ID Reference Utilities
671  *
672  * Unfortunately we need this for a handful of places.
673  */
674
675 static void UNUSED_FUNCTION(BKE_undosys_foreach_ID_ref(
676         UndoStack *ustack, UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data))
677 {
678         for (UndoStep *us = ustack->steps.first; us; us = us->next) {
679                 const UndoType *ut = us->type;
680                 if (ut->step_foreach_ID_ref != NULL) {
681                         ut->step_foreach_ID_ref(us, foreach_ID_ref_fn, user_data);
682                 }
683         }
684 }
685
686 typedef struct UndoIDPtrMapItem {
687         /** Never changes (matches undo data). Use as sort key for binary search. */
688         const void *ptr;
689         /** Write the new pointers here. */
690         uint index;
691 } UndoIDPtrMapItem;
692
693 typedef struct UndoIDPtrMap {
694         UndoRefID *refs;
695         /**
696          * Pointer map, update 'dst' members before use.
697          * This is always sorted (adds some overhead when adding, in practice it's acceptable since).
698          */
699         UndoIDPtrMapItem *pmap;
700
701         /** Length for both 'refs' & 'pmap' */
702         uint len;
703         uint len_alloc;
704 } UndoIDPtrMap;
705
706 #ifdef DEBUG
707 #  define PMAP_DEFAULT_ALLOC 1
708 #else
709 #  define PMAP_DEFAULT_ALLOC 32
710 #endif
711
712 void BKE_undosys_ID_map_foreach_ID_ref(
713         UndoIDPtrMap *map,
714         UndoTypeForEachIDRefFn foreach_ID_ref_fn, void *user_data)
715 {
716         for (uint i = 0; i < map->len; i++) {
717                 foreach_ID_ref_fn(user_data, &map->refs[i]);
718         }
719 }
720
721 /**
722  * Return true when found, otherwise index is set to the index we should insert.
723  */
724 static bool undosys_ID_map_lookup_index(const UndoIDPtrMap *map, const void *key, uint *r_index)
725 {
726         const UndoIDPtrMapItem *pmap = map->pmap;
727         const uint len = map->len;
728         if (len == 0) {
729                 if (*r_index) {
730                         *r_index = 0;
731                 }
732                 return false;
733         }
734         int min = 0, max = len - 1;
735         while (min <= max) {
736                 const uint mid = (min + max) / 2;
737                 if (pmap[mid].ptr < key) {
738                         min = mid + 1;
739                 }
740                 else if (pmap[mid].ptr == key) {
741                         if (r_index) {
742                                 *r_index = mid;
743                         }
744                         return true;
745                 }
746                 else if (pmap[mid].ptr > key) {
747                         max = mid - 1;
748                 }
749         }
750         if (r_index) {
751                 *r_index = min;
752         }
753         return false;
754 }
755
756 /**
757  * A set of ID's use for efficient decoding, so we can map pointers back to the newly loaded data
758  * without performing full look ups each time.
759  *
760  * This can be used as an old_pointer -> new_pointer lookup.
761  */
762 UndoIDPtrMap *BKE_undosys_ID_map_create(void)
763 {
764         UndoIDPtrMap *map = MEM_mallocN(sizeof(*map), __func__);
765         map->len_alloc = PMAP_DEFAULT_ALLOC;
766         map->refs = MEM_mallocN(sizeof(*map->refs) * map->len_alloc, __func__);
767         map->pmap = MEM_mallocN(sizeof(*map->pmap) * map->len_alloc, __func__);
768         map->len = 0;
769         return map;
770 }
771 void BKE_undosys_ID_map_destroy(UndoIDPtrMap *idpmap)
772 {
773         MEM_SAFE_FREE(idpmap->refs);
774         MEM_SAFE_FREE(idpmap->pmap);
775         MEM_freeN(idpmap);
776 }
777
778 void BKE_undosys_ID_map_add(UndoIDPtrMap *map, ID *id)
779 {
780         uint index;
781         if (id->lib != NULL) {
782                 return;
783         }
784
785         if (undosys_ID_map_lookup_index(map, id, &index)) {
786                 return;  /* exists. */
787         }
788
789         const uint len_src = map->len;
790         const uint len_dst = map->len + 1;
791         if (len_dst > map->len_alloc) {
792                 map->len_alloc *= 2;
793                 BLI_assert(map->len_alloc >= len_dst);
794                 map->pmap = MEM_reallocN(map->pmap, sizeof(*map->pmap) * map->len_alloc);
795                 map->refs = MEM_reallocN(map->refs, sizeof(*map->refs) * map->len_alloc);
796         }
797
798 #if 0  /* Will be done automatically in callback. */
799         BLI_strncpy(map->refs[len_src].name, id->name, sizeof(id->name));
800 #else
801         map->refs[len_src].name[0] = '\0';
802 #endif
803         map->refs[len_src].ptr = id;
804
805         if (len_src != 0 && index != len_src) {
806                 memmove(&map->pmap[index + 1], &map->pmap[index], sizeof(*map->pmap) * (len_src - index));
807         }
808         map->pmap[index].ptr = id;
809         map->pmap[index].index = len_src;
810
811         map->len = len_dst;
812 }
813
814 ID *BKE_undosys_ID_map_lookup(const UndoIDPtrMap *map, const ID *id_src)
815 {
816         /* We should only ever lookup indices which exist! */
817         uint index;
818         if (!undosys_ID_map_lookup_index(map, id_src, &index)) {
819                 BLI_assert(0);
820         }
821         index = map->pmap[index].index;
822         ID *id_dst = map->refs[index].ptr;
823         BLI_assert(id_dst != NULL);
824         BLI_assert(STREQ(id_dst->name, map->refs[index].name));
825         return id_dst;
826 }
827
828 void BKE_undosys_ID_map_add_with_prev(UndoIDPtrMap *map, ID *id, ID **id_prev)
829 {
830         if (id == *id_prev) {
831                 return;
832         }
833         *id_prev = id;
834         BKE_undosys_ID_map_add(map, id);
835 }
836
837 ID *BKE_undosys_ID_map_lookup_with_prev(const UndoIDPtrMap *map, ID *id_src, ID *id_prev_match[2])
838 {
839         if (id_src == id_prev_match[0]) {
840                 return id_prev_match[1];
841         }
842         else {
843                 ID *id_dst = BKE_undosys_ID_map_lookup(map, id_src);
844                 id_prev_match[0] = id_src;
845                 id_prev_match[1] = id_dst;
846                 return id_dst;
847         }
848 }
849
850 /** \} */