BGL: Expose OpenGL API for FrameBuffers and RenderBuffers.
[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
74         /* can be NULL, use when set. */
75         MemFileUndoStep *us_prev = (MemFileUndoStep *)BKE_undosys_step_same_type_prev(us_p);
76         us->data = BKE_memfile_undo_encode(bmain, us_prev ? us_prev->data : NULL);
77         us->step.data_size = us->data->undo_size;
78
79         return true;
80 }
81
82 static void memfile_undosys_step_decode(struct bContext *C, UndoStep *us_p, int UNUSED(dir))
83 {
84         /* Loading the content will correctly switch into compatible non-object modes. */
85         ED_object_mode_set(C, OB_MODE_OBJECT);
86
87         /* This is needed so undoing/redoing doesn't crash with threaded previews going */
88         ED_viewport_render_kill_jobs(CTX_wm_manager(C), CTX_data_main(C), true);
89         MemFileUndoStep *us = (MemFileUndoStep *)us_p;
90         BKE_memfile_undo_decode(us->data, C);
91
92         WM_event_add_notifier(C, NC_SCENE | ND_LAYER_CONTENT, CTX_data_scene(C));
93 }
94
95 static void memfile_undosys_step_free(UndoStep *us_p)
96 {
97         /* To avoid unnecessary slow down, free backwards (so we don't need to merge when clearing all). */
98         MemFileUndoStep *us = (MemFileUndoStep *)us_p;
99         if (us_p->next != NULL) {
100                 UndoStep *us_next_p = BKE_undosys_step_same_type_next(us_p);
101                 if (us_next_p != NULL) {
102                         MemFileUndoStep *us_next = (MemFileUndoStep *)us_next_p;
103                         BLO_memfile_merge(&us->data->memfile, &us_next->data->memfile);
104                 }
105         }
106
107         BKE_memfile_undo_free(us->data);
108 }
109
110 /* Export for ED_undo_sys. */
111 void ED_memfile_undosys_type(UndoType *ut)
112 {
113         ut->name = "Global Undo";
114         ut->poll = memfile_undosys_poll;
115         ut->step_encode = memfile_undosys_step_encode;
116         ut->step_decode = memfile_undosys_step_decode;
117         ut->step_free = memfile_undosys_step_free;
118
119         ut->mode = BKE_UNDOTYPE_MODE_STORE;
120         ut->use_context = true;
121
122         ut->step_size = sizeof(MemFileUndoStep);
123 }
124
125 /** \} */
126
127 /* -------------------------------------------------------------------- */
128 /** \name Utilities
129  * \{ */
130
131 /**
132  * Ideally we wouldn't need to export global undo internals, there are some cases where it's needed though.
133  */
134 static struct MemFile *ed_undosys_step_get_memfile(UndoStep *us_p)
135 {
136         MemFileUndoStep *us = (MemFileUndoStep *)us_p;
137         return &us->data->memfile;
138 }
139
140 struct MemFile *ED_undosys_stack_memfile_get_active(UndoStack *ustack)
141 {
142         UndoStep *us = BKE_undosys_stack_active_with_type(ustack, BKE_UNDOSYS_TYPE_MEMFILE);
143         if (us) {
144                 return ed_undosys_step_get_memfile(us);
145         }
146         return NULL;
147 }
148
149
150 /** \} */