Merge branch 'master' into blender2.8
[blender.git] / source / blender / editors / undo / memfile_undo.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/editors/undo/memfile_undo.c
22  *  \ingroup edundo
23  *
24  * Wrapper between 'ED_undo.h' and 'BKE_undo_system.h' API's.
25  */
26
27 #include "BLI_utildefines.h"
28 #include "BLI_sys_types.h"
29
30 #include "DNA_object_enums.h"
31
32 #include "BKE_blender_undo.h"
33 #include "BKE_context.h"
34 #include "BKE_undo_system.h"
35
36 #include "WM_api.h"
37 #include "WM_types.h"
38
39 #include "ED_object.h"
40 #include "ED_undo.h"
41 #include "ED_render.h"
42
43
44 #include "../blenloader/BLO_undofile.h"
45
46 #include "undo_intern.h"
47
48 /* -------------------------------------------------------------------- */
49 /** \name Implements ED Undo System
50  * \{ */
51
52 typedef struct MemFileUndoStep {
53         UndoStep step;
54         MemFileUndoData *data;
55 } MemFileUndoStep;
56
57 static bool memfile_undosys_poll(bContext *UNUSED(C))
58 {
59         /* other poll functions must run first, this is a catch-all. */
60
61         if ((U.uiflag & USER_GLOBALUNDO) == 0) {
62                 return false;
63         }
64         return true;
65 }
66
67 static bool memfile_undosys_step_encode(struct bContext *C, UndoStep *us_p)
68 {
69         MemFileUndoStep *us = (MemFileUndoStep *)us_p;
70
71         /* Important we only use 'main' from the context (see: BKE_undosys_stack_init_from_main). */
72         struct Main *bmain = CTX_data_main(C);
73         UndoStack *ustack = ED_undo_stack_get();
74
75         /* can be NULL, use when set. */
76         MemFileUndoStep *us_prev = (MemFileUndoStep *)BKE_undosys_step_find_by_type(ustack, BKE_UNDOSYS_TYPE_MEMFILE);
77         us->data = BKE_memfile_undo_encode(bmain, us_prev ? us_prev->data : NULL);
78         us->step.data_size = us->data->undo_size;
79
80         return true;
81 }
82
83 static void memfile_undosys_step_decode(struct bContext *C, UndoStep *us_p, int UNUSED(dir))
84 {
85         /* Loading the content will correctly switch into compatible non-object modes. */
86         ED_object_mode_set(C, OB_MODE_OBJECT);
87
88         /* This is needed so undoing/redoing doesn't crash with threaded previews going */
89         ED_viewport_render_kill_jobs(CTX_wm_manager(C), CTX_data_main(C), true);
90         MemFileUndoStep *us = (MemFileUndoStep *)us_p;
91         BKE_memfile_undo_decode(us->data, C);
92
93         WM_event_add_notifier(C, NC_SCENE | ND_LAYER_CONTENT, CTX_data_scene(C));
94 }
95
96 static void memfile_undosys_step_free(UndoStep *us_p)
97 {
98         /* To avoid unnecessary slow down, free backwards (so we don't need to merge when clearing all). */
99         MemFileUndoStep *us = (MemFileUndoStep *)us_p;
100         if (us_p->next != NULL) {
101                 UndoStep *us_next_p = BKE_undosys_step_same_type_next(us_p);
102                 if (us_next_p != NULL) {
103                         MemFileUndoStep *us_next = (MemFileUndoStep *)us_next_p;
104                         BLO_memfile_merge(&us->data->memfile, &us_next->data->memfile);
105                 }
106         }
107
108         BKE_memfile_undo_free(us->data);
109 }
110
111 /* Export for ED_undo_sys. */
112 void ED_memfile_undosys_type(UndoType *ut)
113 {
114         ut->name = "Global Undo";
115         ut->poll = memfile_undosys_poll;
116         ut->step_encode = memfile_undosys_step_encode;
117         ut->step_decode = memfile_undosys_step_decode;
118         ut->step_free = memfile_undosys_step_free;
119
120         ut->mode = BKE_UNDOTYPE_MODE_STORE;
121         ut->use_context = true;
122
123         ut->step_size = sizeof(MemFileUndoStep);
124 }
125
126 /** \} */
127
128 /* -------------------------------------------------------------------- */
129 /** \name Utilities
130  * \{ */
131
132 /**
133  * Ideally we wouldn't need to export global undo internals, there are some cases where it's needed though.
134  */
135 static struct MemFile *ed_undosys_step_get_memfile(UndoStep *us_p)
136 {
137         MemFileUndoStep *us = (MemFileUndoStep *)us_p;
138         return &us->data->memfile;
139 }
140
141 struct MemFile *ED_undosys_stack_memfile_get_active(UndoStack *ustack)
142 {
143         UndoStep *us = BKE_undosys_stack_active_with_type(ustack, BKE_UNDOSYS_TYPE_MEMFILE);
144         if (us) {
145                 return ed_undosys_step_get_memfile(us);
146         }
147         return NULL;
148 }
149
150
151 /** \} */