5fb93b0f8ec36cf17c7ececed4b50af8612a7b77
[blender-staging.git] / source / blender / editors / util / editmode_undo.c
1 /**
2  * $Id: 
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2004 Blender Foundation
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29
30
31 #include <stdlib.h>
32 #include <string.h>
33 #include <math.h>
34
35 #include "MEM_guardedalloc.h"
36
37 #include "DNA_mesh_types.h"
38 #include "DNA_meshdata_types.h"
39 #include "DNA_object_types.h"
40 #include "DNA_screen_types.h"
41 #include "DNA_scene_types.h"
42 #include "DNA_userdef_types.h"
43
44 #include "BKE_context.h"
45 #include "BKE_depsgraph.h"
46 #include "BKE_global.h"
47 #include "BKE_object.h"
48
49 #include "BLI_blenlib.h"
50 #include "BLI_dynstr.h"
51
52 #include "BKE_utildefines.h"
53
54 #include "ED_util.h"
55
56 #include "UI_interface.h"
57 #include "UI_resources.h"
58
59 /* ***************** generic editmode undo system ********************* */
60 /*
61
62 Add this in your local code:
63
64 void undo_editmode_push(bContext *C, 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
82 /* ****** XXX ***** */
83 void error() {}
84 /* ****** XXX ***** */
85
86
87 #define MAXUNDONAME     64
88 typedef struct UndoElem {
89         struct UndoElem *next, *prev;
90         ID id;                  // copy of editmode object ID
91         Object *ob;             // pointer to edited object
92         int type;               // type of edited object
93         void *undodata;
94         uintptr_t undosize;
95         char name[MAXUNDONAME];
96         void * (*getdata)(bContext *C);
97         void (*freedata)(void *);
98         void (*to_editmode)(void *, void *);
99         void * (*from_editmode)(void *);
100         int (*validate_undo)(void *, void *);
101 } UndoElem;
102
103 static ListBase undobase={NULL, NULL};
104 static UndoElem *curundo= NULL;
105
106
107 /* ********************* xtern api calls ************* */
108
109 static void undo_restore(UndoElem *undo, void *editdata)
110 {
111         if(undo) {
112                 undo->to_editmode(undo->undodata, editdata);    
113         }
114 }
115
116 /* name can be a dynamic string */
117 void undo_editmode_push(bContext *C, char *name, 
118                                                 void * (*getdata)(bContext *C),
119                                                 void (*freedata)(void *), 
120                                                 void (*to_editmode)(void *, void *),  
121                                                 void *(*from_editmode)(void *),
122                                                 int (*validate_undo)(void *, void *))
123 {
124         UndoElem *uel;
125         Object *obedit= CTX_data_edit_object(C);
126         void *editdata;
127         int nr;
128         uintptr_t memused, totmem, maxmem;
129
130         /* at first here was code to prevent an "original" key to be insterted twice
131            this was giving conflicts for example when mesh changed due to keys or apply */
132         
133         /* remove all undos after (also when curundo==NULL) */
134         while(undobase.last != curundo) {
135                 uel= undobase.last;
136                 uel->freedata(uel->undodata);
137                 BLI_freelinkN(&undobase, uel);
138         }
139         
140         /* make new */
141         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo editmode");
142         strncpy(uel->name, name, MAXUNDONAME-1);
143         BLI_addtail(&undobase, uel);
144         
145         uel->getdata= getdata;
146         uel->freedata= freedata;
147         uel->to_editmode= to_editmode;
148         uel->from_editmode= from_editmode;
149         uel->validate_undo= validate_undo;
150         
151         /* limit amount to the maximum amount*/
152         nr= 0;
153         uel= undobase.last;
154         while(uel) {
155                 nr++;
156                 if(nr==U.undosteps) break;
157                 uel= uel->prev;
158         }
159         if(uel) {
160                 while(undobase.first!=uel) {
161                         UndoElem *first= undobase.first;
162                         first->freedata(first->undodata);
163                         BLI_freelinkN(&undobase, first);
164                 }
165         }
166
167         /* copy  */
168         memused= MEM_get_memory_in_use();
169         editdata= getdata(C);
170         curundo->undodata= curundo->from_editmode(editdata);
171         curundo->undosize= MEM_get_memory_in_use() - memused;
172         curundo->ob= obedit;
173         curundo->id= obedit->id;
174         curundo->type= obedit->type;
175
176         if(U.undomemory != 0) {
177                 /* limit to maximum memory (afterwards, we can't know in advance) */
178                 totmem= 0;
179                 maxmem= ((uintptr_t)U.undomemory)*1024*1024;
180
181                 uel= undobase.last;
182                 while(uel && uel->prev) {
183                         totmem+= uel->undosize;
184                         if(totmem>maxmem) break;
185                         uel= uel->prev;
186                 }
187
188                 if(uel) {
189                         if(uel->prev && uel->prev->prev)
190                                 uel= uel->prev;
191
192                         while(undobase.first!=uel) {
193                                 UndoElem *first= undobase.first;
194                                 first->freedata(first->undodata);
195                                 BLI_freelinkN(&undobase, first);
196                         }
197                 }
198         }
199 }
200
201 /* helper to remove clean other objects from undo stack */
202 static void undo_clean_stack(bContext *C)
203 {
204         UndoElem *uel, *next;
205         Object *obedit= CTX_data_edit_object(C);
206         int mixed= 0;
207         
208         /* global undo changes pointers, so we also allow identical names */
209         /* side effect: when deleting/renaming object and start editing new one with same name */
210         
211         uel= undobase.first; 
212         while(uel) {
213                 void *editdata= uel->getdata(C);
214                 int isvalid= 0;
215                 next= uel->next;
216                 
217                 /* for when objects are converted, renamed, or global undo changes pointers... */
218                 if(uel->type==obedit->type) {
219                         if(strcmp(uel->id.name, obedit->id.name)==0) {
220                                 if(uel->validate_undo==NULL)
221                                         isvalid= 1;
222                                 else if(uel->validate_undo(uel->undodata, editdata))
223                                         isvalid= 1;
224                         }
225                 }
226                 if(isvalid) 
227                         uel->ob= obedit;
228                 else {
229                         mixed= 1;
230                         uel->freedata(uel->undodata);
231                         BLI_freelinkN(&undobase, uel);
232                 }
233                 
234                 uel= next;
235         }
236         
237         if(mixed) 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));
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.f & G_DEBUG) printf("undo %s\n", curundo->name);
256                         curundo= curundo->prev;
257                         undo_restore(curundo, curundo->getdata(C));
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));
266                         curundo= curundo->next;
267                         if(G.f & G_DEBUG) printf("redo %s\n", curundo->name);
268                 }
269         }
270         
271         DAG_id_flush_update(&obedit->id, OB_RECALC_DATA);
272
273         /* XXX notifiers */
274 }
275
276 void undo_editmode_clear(void)
277 {
278         UndoElem *uel;
279         
280         uel= undobase.first;
281         while(uel) {
282                 uel->freedata(uel->undodata);
283                 uel= uel->next;
284         }
285         BLI_freelistN(&undobase);
286         curundo= NULL;
287 }
288
289 /* based on index nr it does a restore */
290 static void undo_number(bContext *C, int nr)
291 {
292         UndoElem *uel;
293         int a=1;
294         
295         for(uel= undobase.first; uel; uel= uel->next, a++) {
296                 if(a==nr) break;
297         }
298         curundo= uel;
299         undo_editmode_step(C, 0);
300 }
301
302 void undo_editmode_name(bContext *C, const char *undoname)
303 {
304         UndoElem *uel;
305         
306         for(uel= undobase.last; uel; uel= uel->prev) {
307                 if(strcmp(undoname, uel->name)==0)
308                         break;
309         }
310         if(uel && uel->prev) {
311                 curundo= uel->prev;
312                 undo_editmode_step(C, 0);
313         }
314 }
315
316
317 /* ************** for interaction with menu/pullown */
318
319 void undo_editmode_menu(bContext *C)
320 {
321         UndoElem *uel;
322         DynStr *ds= BLI_dynstr_new();
323         short event= 0;
324         char *menu;
325
326         undo_clean_stack(C);    // removes other objects from it
327         
328         BLI_dynstr_append(ds, "Editmode Undo History %t");
329         
330         for(uel= undobase.first; uel; uel= uel->next) {
331                 BLI_dynstr_append(ds, "|");
332                 BLI_dynstr_append(ds, uel->name);
333         }
334         
335         menu= BLI_dynstr_get_cstring(ds);
336         BLI_dynstr_free(ds);
337         
338 // XXX  event= pupmenu_col(menu, 20);
339         MEM_freeN(menu);
340         
341         if(event>0) undo_number(C, event);
342 }
343
344 static void do_editmode_undohistorymenu(bContext *C, void *arg, int event)
345 {
346         Object *obedit= CTX_data_edit_object(C);
347         
348         if(obedit==NULL || event<1) return;
349
350         undo_number(C, event-1);
351         
352 }
353
354 uiBlock *editmode_undohistorymenu(bContext *C, ARegion *ar, void *arg_unused)
355 {
356         uiBlock *block;
357         UndoElem *uel;
358         short yco = 20, menuwidth = 120;
359         short item= 1;
360         
361         undo_clean_stack(C);    // removes other objects from it
362
363         block= uiBeginBlock(C, ar, "view3d_edit_mesh_undohistorymenu", UI_EMBOSSP);
364         uiBlockSetButmFunc(block, do_editmode_undohistorymenu, NULL);
365         
366         for(uel= undobase.first; uel; uel= uel->next, item++) {
367                 if (uel==curundo) uiDefBut(block, SEPR, 0, "",          0, yco-=6, menuwidth, 6, NULL, 0.0, 0.0, 0, 0, "");
368                 uiDefIconTextBut(block, BUTM, 1, ICON_BLANK1, uel->name, 0, yco-=20, menuwidth, 19, NULL, 0.0, 0.0, 1, (float)item, "");
369                 if (uel==curundo) uiDefBut(block, SEPR, 0, "",          0, yco-=6, menuwidth, 6, NULL, 0.0, 0.0, 0, 0, "");
370         }
371         
372         uiBlockSetDirection(block, UI_RIGHT);
373         uiTextBoundsBlock(block, 60);
374         return block;
375 }
376
377 void *undo_editmode_get_prev(Object *ob)
378 {
379         UndoElem *ue= undobase.last;
380         if(ue && ue->prev && ue->prev->ob==ob) return ue->prev->undodata;
381         return NULL;
382 }