4c0150e848b410ab15059bd1f1142a788a3d2e5a
[blender.git] / source / blender / src / editmode_undo.c
1 /**
2  * $Id: 
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32
33
34 #include <stdlib.h>
35 #include <string.h>
36 #include <math.h>
37
38 #ifdef HAVE_CONFIG_H
39 #include <config.h>
40 #endif
41
42 #ifdef WIN32
43 #include "BLI_winstuff.h"
44 #endif
45 #include "MEM_guardedalloc.h"
46
47 #include "DNA_mesh_types.h"
48 #include "DNA_meshdata_types.h"
49 #include "DNA_object_types.h"
50 #include "DNA_screen_types.h"
51 #include "DNA_scene_types.h"
52 #include "DNA_userdef_types.h"
53
54 #include "BKE_displist.h"
55 #include "BKE_global.h"
56 #include "BKE_object.h"
57
58 #include "BLI_blenlib.h"
59 #include "BLI_dynstr.h"
60
61 #include "BKE_utildefines.h"
62
63 #include "BIF_editmesh.h"
64 #include "BIF_interface.h"
65 #include "BIF_screen.h"
66 #include "BIF_resources.h"
67 #include "BIF_toolbox.h"
68 #include "BIF_space.h"
69
70 #include "BDR_editcurve.h"
71
72 #include "BSE_edit.h"
73
74 #include "mydevice.h"
75
76 /* ***************** generic editmode undo system ********************* */
77 /*
78
79 Add this in your local code:
80
81 void undo_editmode_push(char *name, 
82                 void (*freedata)(void *),                       // pointer to function freeing data
83                 void (*to_editmode)(void *),        // data to editmode conversion
84                 void * (*from_editmode)(void))      // editmode to data conversion
85
86
87 Further exported for UI is:
88
89 void undo_editmode_step(int step);                      // undo and redo
90 void undo_editmode_clear(void)                          // free & clear all data
91 void undo_editmode_menu(void)                           // history menu
92
93
94 */
95 /* ********************************************************************* */
96
97
98 #define MAXUNDONAME     64
99 typedef struct UndoElem {
100         struct UndoElem *next, *prev;
101         ID id;                  // copy of editmode object ID
102         Object *ob;             // pointer to edited object
103         void *undodata;
104         char name[MAXUNDONAME];
105         void (*freedata)(void *);
106         void (*to_editmode)(void *);
107         void * (*from_editmode)(void);
108 } UndoElem;
109
110 static ListBase undobase={NULL, NULL};
111 static UndoElem *curundo= NULL;
112
113
114 /* ********************* xtern api calls ************* */
115
116 static void undo_restore(UndoElem *undo)
117 {
118         if(undo) {
119                 waitcursor(1);
120                 undo->to_editmode(undo->undodata);      
121                 waitcursor(0);
122         
123                 countall();
124         }
125 }
126
127 /* name can be a dynamic string */
128 void undo_editmode_push(char *name, void (*freedata)(void *), 
129                 void (*to_editmode)(void *),  void *(*from_editmode)(void)) 
130 {
131         UndoElem *uel;
132         int nr;
133
134         /* prevent two same undocalls */
135         if(curundo && strcmp("Original", name)==0) {
136                 if( curundo->ob==G.obedit ) {
137                         return;
138                 }
139         }
140         /* remove all undos after (also when curundo==NULL) */
141         while(undobase.last != curundo) {
142                 uel= undobase.last;
143                 BLI_remlink(&undobase, uel);
144                 uel->freedata(uel->undodata);
145                 MEM_freeN(uel);
146         }
147         
148         /* make new */
149         curundo= uel= MEM_callocN(sizeof(UndoElem), "undo file");
150         strncpy(uel->name, name, MAXUNDONAME-1);
151         BLI_addtail(&undobase, uel);
152         
153         uel->freedata= freedata;
154         uel->to_editmode= to_editmode;
155         uel->from_editmode= from_editmode;
156         
157         /* and limit amount to the maximum */
158         nr= 0;
159         uel= undobase.last;
160         while(uel) {
161                 nr++;
162                 if(nr==U.undosteps) break;
163                 uel= uel->prev;
164         }
165         if(uel) {
166                 while(undobase.first!=uel) {
167                         UndoElem *first= undobase.first;
168                         BLI_remlink(&undobase, first);
169                         first->freedata(first->undodata);
170                         MEM_freeN(first);
171                 }
172         }
173
174         /* copy  */
175         curundo->undodata= curundo->from_editmode();
176         curundo->ob= G.obedit;
177         curundo->id= G.obedit->id;
178 }
179
180
181 /* helper to remove clean other objects from undo stack */
182 static void undo_clean_stack(void)
183 {
184         UndoElem *uel, *next;
185         int mixed= 0, checknames= 1;
186         
187         /* global undo changes pointers, so we also allow identical names */
188         /* side effect: when deleting/renaming object and start editing new one with same name */
189         
190         uel= undobase.first; 
191         while(uel) {
192                 next= uel->next;
193                 if(uel->ob != G.obedit) {
194                         
195                         /* for when global undo changes pointers... */
196                         if(checknames && strcmp(uel->id.name, G.obedit->id.name)==0) {
197                                 uel->ob= G.obedit;
198                         }
199                         else {
200                                 mixed= 1;
201                                 BLI_remlink(&undobase, uel);
202                                 uel->freedata(uel->undodata);
203                                 MEM_freeN(uel);
204                         }
205                 }
206                 uel= next;
207         }
208         
209         if(mixed) curundo= undobase.last;
210 }
211
212 /* 1= an undo, -1 is a redo. we have to make sure 'curundo' remains at current situation */
213 void undo_editmode_step(int step)
214 {
215         
216         /* prevent undo to happen on wrong object, stack can be a mix */
217         undo_clean_stack();
218         
219         if(step==0) {
220                 undo_restore(curundo);
221         }
222         else if(step==1) {
223                 
224                 if(curundo==NULL || curundo->prev==NULL) error("No more steps to undo");
225                 else {
226                         printf("undo %s\n", curundo->name);
227                         curundo= curundo->prev;
228                         undo_restore(curundo);
229                 }
230         }
231         else {
232                 /* curundo has to remain current situation! */
233                 
234                 if(curundo==NULL || curundo->next==NULL) error("No more steps to redo");
235                 else {
236                         undo_restore(curundo->next);
237                         curundo= curundo->next;
238                         printf("redo %s\n", curundo->name);
239                 }
240         }
241
242         makeDispList(G.obedit);
243         // type specific redraw events...
244         if(G.obedit->type==OB_CURVE) curve_changes_other_objects(G.obedit);
245
246         allqueue(REDRAWVIEW3D, 0);
247         allqueue(REDRAWBUTSEDIT, 0);
248         allqueue(REDRAWIMAGE, 0);
249 }
250
251 void undo_editmode_clear(void)
252 {
253         UndoElem *uel;
254         
255         uel= undobase.first;
256         while(uel) {
257                 uel->freedata(uel->undodata);
258                 uel= uel->next;
259         }
260         BLI_freelistN(&undobase);
261         curundo= NULL;
262 }
263
264 /* based on index nr it does a restore */
265 static void undo_number(int nr)
266 {
267         UndoElem *uel;
268         int a=1;
269         
270         for(uel= undobase.first; uel; uel= uel->next, a++) {
271                 if(a==nr) break;
272         }
273         curundo= uel;
274         undo_editmode_step(0);
275 }
276
277 /* ************** for interaction with menu/pullown */
278
279 void undo_editmode_menu(void)
280 {
281         UndoElem *uel;
282         DynStr *ds= BLI_dynstr_new();
283         short event;
284         char *menu;
285
286         undo_clean_stack();     // removes other objects from it
287         
288         BLI_dynstr_append(ds, "Undo History %t");
289         
290         for(uel= undobase.first; uel; uel= uel->next) {
291                 BLI_dynstr_append(ds, "|");
292                 BLI_dynstr_append(ds, uel->name);
293         }
294         
295         menu= BLI_dynstr_get_cstring(ds);
296         BLI_dynstr_free(ds);
297         
298         event= pupmenu_col(menu, 20);
299         MEM_freeN(menu);
300         
301         if(event>0) undo_number(event);
302 }
303
304 static void do_editmode_undohistorymenu(void *arg, int event)
305 {
306         
307         if(G.obedit==NULL || event<1) return;
308
309         if (event==1) {
310                 if(G.obedit->type==OB_MESH) remake_editMesh();
311         }
312         else undo_number(event-1);
313         
314         allqueue(REDRAWVIEW3D, 0);
315 }
316
317 uiBlock *editmode_undohistorymenu(void *arg_unused)
318 {
319         uiBlock *block;
320         UndoElem *uel;
321         short yco = 20, menuwidth = 120;
322         short item=2;
323         
324         undo_clean_stack();     // removes other objects from it
325
326         block= uiNewBlock(&curarea->uiblocks, "view3d_edit_mesh_undohistorymenu", UI_EMBOSSP, UI_HELV, G.curscreen->mainwin);
327         uiBlockSetButmFunc(block, do_editmode_undohistorymenu, NULL);
328         
329         uiDefIconTextBut(block, BUTM, 1, ICON_BLANK1, "Undo All Changes|Ctrl U", 0, yco-=20, menuwidth, 19, NULL, 0.0, 0.0, 1, 1, "");
330         
331         for(uel= undobase.first; uel; uel= uel->next, item++) {
332                 if (uel==curundo) uiDefBut(block, SEPR, 0, "",          0, yco-=6, menuwidth, 6, NULL, 0.0, 0.0, 0, 0, "");
333                 uiDefIconTextBut(block, BUTM, 1, ICON_BLANK1, uel->name, 0, yco-=20, menuwidth, 19, NULL, 0.0, 0.0, 1, (float)item, "");
334                 if (uel==curundo) uiDefBut(block, SEPR, 0, "",          0, yco-=6, menuwidth, 6, NULL, 0.0, 0.0, 0, 0, "");
335         }
336         
337         uiBlockSetDirection(block, UI_RIGHT);
338         uiTextBoundsBlock(block, 60);
339         return block;
340 }
341
342