style cleanup
[blender.git] / source / blender / editors / util / editmode_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  * The Original Code is Copyright (C) 2004 Blender Foundation
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/editors/util/editmode_undo.c
29  *  \ingroup edutil
30  */
31
32
33
34 #include <stdlib.h>
35 #include <string.h>
36 #include <math.h>
37
38 #include "MEM_guardedalloc.h"
39
40 #include "DNA_object_types.h"
41 #include "DNA_screen_types.h"
42
43 #include "BLI_blenlib.h"
44 #include "BLI_dynstr.h"
45 #include "BLI_utildefines.h"
46
47
48 #include "BKE_context.h"
49 #include "BKE_depsgraph.h"
50 #include "BKE_global.h"
51
52 #include "ED_util.h"
53 #include "ED_mesh.h"
54
55 #include "UI_interface.h"
56 #include "UI_resources.h"
57
58 #include "util_intern.h"
59
60 /* ***************** generic editmode undo system ********************* */
61 /*
62  * Add this in your local code:
63  *
64  * void undo_editmode_push(bContext *C, const char *name, 
65  *      void * (*getdata)(bContext *C),     // use context to retrieve current editdata
66  *      void (*freedata)(void *),           // pointer to function freeing data
67  *      void (*to_editmode)(void *, void *),        // data to editmode conversion
68  *      void * (*from_editmode)(void *))      // editmode to data conversion
69  *      int  (*validate_undo)(void *, void *))      // check if undo data is still valid
70  *
71  *
72  * Further exported for UI is:
73  *
74  * void undo_editmode_step(bContext *C, int step);       // undo and redo
75  * void undo_editmode_clear(void)                               // free & clear all data
76  * void undo_editmode_menu(void)                                // history menu
77  */
78
79 /* ********************************************************************* */
80
81 /* ****** XXX ***** */
82 static void error(const char *UNUSED(arg)) {}
83 /* ****** XXX ***** */
84
85
86 #define MAXUNDONAME 64
87 typedef struct UndoElem {
88         struct UndoElem *next, *prev;
89         ID id;          // copy of editmode object ID
90         Object *ob;     // pointer to edited object
91         int type;       // type of edited object
92         void *undodata;
93         uintptr_t undosize;
94         char name[MAXUNDONAME];
95         void * (*getdata)(bContext * C);
96         void (*freedata)(void *);
97         void (*to_editmode)(void *, void *, void *);
98         void * (*from_editmode)(void *, void *);
99         int (*validate_undo)(void *, void *);
100 } UndoElem;
101
102 static ListBase undobase = {NULL, NULL};
103 static UndoElem *curundo = NULL;
104
105
106 /* ********************* xtern api calls ************* */
107
108 static void undo_restore(UndoElem *undo, void *editdata, void *obdata)
109 {
110         if (undo) {
111                 undo->to_editmode(undo->undodata, editdata, obdata);    
112         }
113 }
114
115 /* name can be a dynamic string */
116 void undo_editmode_push(bContext *C, const char *name, 
117                         void * (*getdata)(bContext * C),
118                         void (*freedata)(void *),
119                         void (*to_editmode)(void *, void *, void *),
120                         void *(*from_editmode)(void *, void *),
121                         int (*validate_undo)(void *, void *))
122 {
123         UndoElem *uel;
124         Object *obedit = CTX_data_edit_object(C);
125         void *editdata;
126         int nr;
127         uintptr_t memused, totmem, maxmem;
128
129         /* at first here was code to prevent an "original" key to be inserted twice
130          * this was giving conflicts for example when mesh changed due to keys or apply */
131         
132         /* remove all undos after (also when curundo == NULL) */
133         while (undobase.last != curundo) {
134                 uel = undobase.last;
135                 uel->freedata(uel->undodata);
136                 BLI_freelinkN(&undobase, uel);
137         }
138         
139         /* make new */
140         curundo = uel = MEM_callocN(sizeof(UndoElem), "undo editmode");
141         BLI_strncpy(uel->name, name, sizeof(uel->name));
142         BLI_addtail(&undobase, uel);
143         
144         uel->getdata = getdata;
145         uel->freedata = freedata;
146         uel->to_editmode = to_editmode;
147         uel->from_editmode = from_editmode;
148         uel->validate_undo = validate_undo;
149         
150         /* limit amount to the maximum amount*/
151         nr = 0;
152         uel = undobase.last;
153         while (uel) {
154                 nr++;
155                 if (nr == U.undosteps) break;
156                 uel = uel->prev;
157         }
158         if (uel) {
159                 while (undobase.first != uel) {
160                         UndoElem *first = undobase.first;
161                         first->freedata(first->undodata);
162                         BLI_freelinkN(&undobase, first);
163                 }
164         }
165
166         /* copy  */
167         memused = MEM_get_memory_in_use();
168         editdata = getdata(C);
169         curundo->undodata = curundo->from_editmode(editdata, obedit->data);
170         curundo->undosize = MEM_get_memory_in_use() - memused;
171         curundo->ob = obedit;
172         curundo->id = obedit->id;
173         curundo->type = obedit->type;
174
175         if (U.undomemory != 0) {
176                 /* limit to maximum memory (afterwards, we can't know in advance) */
177                 totmem = 0;
178                 maxmem = ((uintptr_t)U.undomemory) * 1024 * 1024;
179
180                 uel = undobase.last;
181                 while (uel && uel->prev) {
182                         totmem += uel->undosize;
183                         if (totmem > maxmem) break;
184                         uel = uel->prev;
185                 }
186
187                 if (uel) {
188                         if (uel->prev && uel->prev->prev)
189                                 uel = uel->prev;
190
191                         while (undobase.first != uel) {
192                                 UndoElem *first = undobase.first;
193                                 first->freedata(first->undodata);
194                                 BLI_freelinkN(&undobase, first);
195                         }
196                 }
197         }
198 }
199
200 /* helper to remove clean other objects from undo stack */
201 static void undo_clean_stack(bContext *C)
202 {
203         UndoElem *uel, *next;
204         Object *obedit = CTX_data_edit_object(C);
205         
206         /* global undo changes pointers, so we also allow identical names */
207         /* side effect: when deleting/renaming object and start editing new one with same name */
208         
209         uel = undobase.first;
210         while (uel) {
211                 void *editdata = uel->getdata(C);
212                 int is_valid = FALSE;
213                 next = uel->next;
214                 
215                 /* for when objects are converted, renamed, or global undo changes pointers... */
216                 if (uel->type == obedit->type) {
217                         if (strcmp(uel->id.name, obedit->id.name) == 0) {
218                                 if (uel->validate_undo == NULL)
219                                         is_valid = TRUE;
220                                 else if (uel->validate_undo(uel->undodata, editdata))
221                                         is_valid = TRUE;
222                         }
223                 }
224                 if (is_valid)
225                         uel->ob = obedit;
226                 else {
227                         if (uel == curundo)
228                                 curundo = NULL;
229
230                         uel->freedata(uel->undodata);
231                         BLI_freelinkN(&undobase, uel);
232                 }
233                 
234                 uel = next;
235         }
236         
237         if (curundo == NULL) curundo = undobase.last;
238 }
239
240 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
241 void undo_editmode_step(bContext *C, int step)
242 {
243         Object *obedit = CTX_data_edit_object(C);
244         
245         /* prevent undo to happen on wrong object, stack can be a mix */
246         undo_clean_stack(C);
247         
248         if (step == 0) {
249                 undo_restore(curundo, curundo->getdata(C), obedit->data);
250         }
251         else if (step == 1) {
252                 
253                 if (curundo == NULL || curundo->prev == NULL) error("No more steps to undo");
254                 else {
255                         if (G.debug & G_DEBUG) printf("undo %s\n", curundo->name);
256                         curundo = curundo->prev;
257                         undo_restore(curundo, curundo->getdata(C), obedit->data);
258                 }
259         }
260         else {
261                 /* curundo has to remain current situation! */
262                 
263                 if (curundo == NULL || curundo->next == NULL) error("No more steps to redo");
264                 else {
265                         undo_restore(curundo->next, curundo->getdata(C), obedit->data);
266                         curundo = curundo->next;
267                         if (G.debug & G_DEBUG) printf("redo %s\n", curundo->name);
268                 }
269         }
270         
271         /* special case for editmesh, mode must be copied back to the scene */
272         if (obedit->type == OB_MESH) {
273                 EDBM_selectmode_to_scene(C);
274         }
275
276         DAG_id_tag_update(&obedit->id, OB_RECALC_DATA);
277
278         /* XXX notifiers */
279 }
280
281 void undo_editmode_clear(void)
282 {
283         UndoElem *uel;
284         
285         uel = undobase.first;
286         while (uel) {
287                 uel->freedata(uel->undodata);
288                 uel = uel->next;
289         }
290         BLI_freelistN(&undobase);
291         curundo = NULL;
292 }
293
294 /* based on index nr it does a restore */
295 void undo_editmode_number(bContext *C, int nr)
296 {
297         UndoElem *uel;
298         int a = 1;
299         
300         for (uel = undobase.first; uel; uel = uel->next, a++) {
301                 if (a == nr) break;
302         }
303         curundo = uel;
304         undo_editmode_step(C, 0);
305 }
306
307 void undo_editmode_name(bContext *C, const char *undoname)
308 {
309         UndoElem *uel;
310         
311         for (uel = undobase.last; uel; uel = uel->prev) {
312                 if (strcmp(undoname, uel->name) == 0)
313                         break;
314         }
315         if (uel && uel->prev) {
316                 curundo = uel->prev;
317                 undo_editmode_step(C, 0);
318         }
319 }
320
321 /* undoname optionally, if NULL it just checks for existing undo steps */
322 int undo_editmode_valid(const char *undoname)
323 {
324         if (undoname) {
325                 UndoElem *uel;
326                 
327                 for (uel = undobase.last; uel; uel = uel->prev) {
328                         if (strcmp(undoname, uel->name) == 0)
329                                 break;
330                 }
331                 return uel != NULL;
332         }
333         return undobase.last != undobase.first;
334 }
335
336
337 /* get name of undo item, return null if no item with this index */
338 /* if active pointer, set it to 1 if true */
339 const char *undo_editmode_get_name(bContext *C, int nr, int *active)
340 {
341         UndoElem *uel;
342         
343         /* prevent wrong numbers to be returned */
344         undo_clean_stack(C);
345         
346         if (active) *active = 0;
347         
348         uel = BLI_findlink(&undobase, nr);
349         if (uel) {
350                 if (active && uel == curundo)
351                         *active = 1;
352                 return uel->name;
353         }
354         return NULL;
355 }
356
357
358 void *undo_editmode_get_prev(Object *ob)
359 {
360         UndoElem *ue = undobase.last;
361         if (ue && ue->prev && ue->prev->ob == ob) return ue->prev->undodata;
362         return NULL;
363 }