Fix T46471: Sculpt strokes doesn't mark file as modified
[blender.git] / source / blender / editors / util / 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/undo.c
29  *  \ingroup edutil
30  */
31
32 #include <stdlib.h>
33 #include <string.h>
34 #include <math.h>
35
36 #include "MEM_guardedalloc.h"
37
38 #include "DNA_object_types.h"
39 #include "DNA_scene_types.h"
40
41 #include "BLI_utildefines.h"
42
43 #include "BLT_translation.h"
44
45 #include "BKE_blender.h"
46 #include "BKE_context.h"
47 #include "BKE_global.h"
48 #include "BKE_main.h"
49 #include "BKE_screen.h"
50
51 #include "ED_armature.h"
52 #include "ED_particle.h"
53 #include "ED_curve.h"
54 #include "ED_gpencil.h"
55 #include "ED_mball.h"
56 #include "ED_mesh.h"
57 #include "ED_object.h"
58 #include "ED_render.h"
59 #include "ED_screen.h"
60 #include "ED_paint.h"
61 #include "ED_util.h"
62 #include "ED_text.h"
63
64 #include "WM_api.h"
65 #include "WM_types.h"
66
67 #include "RNA_access.h"
68 #include "RNA_define.h"
69
70 #include "UI_interface.h"
71 #include "UI_resources.h"
72
73 #include "util_intern.h"
74
75 /* ***************** generic undo system ********************* */
76
77 void ED_undo_push(bContext *C, const char *str)
78 {
79         wmWindowManager *wm = CTX_wm_manager(C);
80         Object *obedit = CTX_data_edit_object(C);
81         Object *obact = CTX_data_active_object(C);
82
83         if (G.debug & G_DEBUG)
84                 printf("%s: %s\n", __func__, str);
85
86         if (obedit) {
87                 if (U.undosteps == 0) return;
88                 
89                 if (obedit->type == OB_MESH)
90                         undo_push_mesh(C, str);
91                 else if (ELEM(obedit->type, OB_CURVE, OB_SURF))
92                         undo_push_curve(C, str);
93                 else if (obedit->type == OB_FONT)
94                         undo_push_font(C, str);
95                 else if (obedit->type == OB_MBALL)
96                         undo_push_mball(C, str);
97                 else if (obedit->type == OB_LATTICE)
98                         undo_push_lattice(C, str);
99                 else if (obedit->type == OB_ARMATURE)
100                         undo_push_armature(C, str);
101         }
102         else if (obact && obact->mode & OB_MODE_PARTICLE_EDIT) {
103                 if (U.undosteps == 0) return;
104
105                 PE_undo_push(CTX_data_scene(C), str);
106         }
107         else if (obact && obact->mode & OB_MODE_SCULPT) {
108                 /* do nothing for now */
109         }
110         else {
111                 BKE_undo_write(C, str);
112         }
113
114         WM_file_tag_modified(C);
115 }
116
117 /* note: also check undo_history_exec() in bottom if you change notifiers */
118 static int ed_undo_step(bContext *C, int step, const char *undoname)
119 {
120         wmWindowManager *wm = CTX_wm_manager(C);
121         wmWindow *win = CTX_wm_window(C);
122         Main *bmain = CTX_data_main(C);
123         Scene *scene = CTX_data_scene(C);
124         Object *obedit = CTX_data_edit_object(C);
125         Object *obact = CTX_data_active_object(C);
126         ScrArea *sa = CTX_wm_area(C);
127
128         /* undo during jobs are running can easily lead to freeing data using by jobs,
129          * or they can just lead to freezing job in some other cases */
130         if (WM_jobs_test(wm, scene, WM_JOB_TYPE_ANY)) {
131                 return OPERATOR_CANCELLED;
132         }
133
134         /* grease pencil can be can be used in plenty of spaces, so check it first */
135         if (ED_gpencil_session_active()) {
136                 return ED_undo_gpencil_step(C, step, undoname);
137         }
138
139         if (sa && (sa->spacetype == SPACE_IMAGE)) {
140                 SpaceImage *sima = (SpaceImage *)sa->spacedata.first;
141                 
142                 if ((obact && (obact->mode & OB_MODE_TEXTURE_PAINT)) || (sima->mode == SI_MODE_PAINT)) {
143                         if (!ED_undo_paint_step(C, UNDO_PAINT_IMAGE, step, undoname) && undoname) {
144                                 if (U.uiflag & USER_GLOBALUNDO) {
145                                         ED_viewport_render_kill_jobs(wm, bmain, true);
146                                         BKE_undo_name(C, undoname);
147                                 }
148                         }
149                         
150                         WM_event_add_notifier(C, NC_WINDOW, NULL);
151                         return OPERATOR_FINISHED;
152                 }
153         }
154
155         if (sa && (sa->spacetype == SPACE_TEXT)) {
156                 ED_text_undo_step(C, step);
157         }
158         else if (obedit) {
159                 if (OB_TYPE_SUPPORT_EDITMODE(obedit->type)) {
160                         if (undoname)
161                                 undo_editmode_name(C, undoname);
162                         else
163                                 undo_editmode_step(C, step);
164                         
165                         WM_event_add_notifier(C, NC_GEOM | ND_DATA, NULL);
166                 }
167         }
168         else {
169                 /* Note: we used to do a fall-through here where if the
170                  * mode-specific undo system had no more steps to undo (or
171                  * redo), the global undo would run.
172                  *
173                  * That was inconsistent with editmode, and also makes for
174                  * unecessarily tricky interaction with the other undo
175                  * systems. */
176                 if (obact && obact->mode & OB_MODE_TEXTURE_PAINT) {
177                         ED_undo_paint_step(C, UNDO_PAINT_IMAGE, step, undoname);
178                 }
179                 else if (obact && obact->mode & OB_MODE_SCULPT) {
180                         ED_undo_paint_step(C, UNDO_PAINT_MESH, step, undoname);
181                 }
182                 else if (obact && obact->mode & OB_MODE_PARTICLE_EDIT) {
183                         if (step == 1)
184                                 PE_undo(scene);
185                         else
186                                 PE_redo(scene);
187                 }
188                 else if (U.uiflag & USER_GLOBALUNDO) {
189                         // note python defines not valid here anymore.
190                         //#ifdef WITH_PYTHON
191                         // XXX          BPY_scripts_clear_pyobjects();
192                         //#endif
193                         
194                         /* for global undo/redo we should just clear the editmode stack */
195                         /* for example, texface stores image pointers */
196                         undo_editmode_clear();
197                         
198                         ED_viewport_render_kill_jobs(wm, bmain, true);
199
200                         if (undoname)
201                                 BKE_undo_name(C, undoname);
202                         else
203                                 BKE_undo_step(C, step);
204
205                         scene = CTX_data_scene(C);
206                                 
207                         WM_event_add_notifier(C, NC_SCENE | ND_LAYER_CONTENT, scene);
208                 }
209         }
210         
211         WM_event_add_notifier(C, NC_WINDOW, NULL);
212         WM_event_add_notifier(C, NC_WM | ND_UNDO, NULL);
213
214         if (win) {
215                 win->addmousemove = true;
216         }
217         
218         return OPERATOR_FINISHED;
219 }
220
221 void ED_undo_pop(bContext *C)
222 {
223         ed_undo_step(C, 1, NULL);
224 }
225 void ED_undo_redo(bContext *C)
226 {
227         ed_undo_step(C, -1, NULL);
228 }
229
230 void ED_undo_push_op(bContext *C, wmOperator *op)
231 {
232         /* in future, get undo string info? */
233         ED_undo_push(C, op->type->name);
234 }
235
236 void ED_undo_pop_op(bContext *C, wmOperator *op)
237 {
238         /* search back a couple of undo's, in case something else added pushes */
239         ed_undo_step(C, 0, op->type->name);
240 }
241
242 /* name optionally, function used to check for operator redo panel */
243 bool ED_undo_is_valid(const bContext *C, const char *undoname)
244 {
245         Object *obedit = CTX_data_edit_object(C);
246         Object *obact = CTX_data_active_object(C);
247         ScrArea *sa = CTX_wm_area(C);
248         
249         if (sa && sa->spacetype == SPACE_IMAGE) {
250                 SpaceImage *sima = (SpaceImage *)sa->spacedata.first;
251                 
252                 if ((obact && (obact->mode & OB_MODE_TEXTURE_PAINT)) || (sima->mode == SI_MODE_PAINT)) {
253                         return 1;
254                 }
255         }
256         
257         if (sa && (sa->spacetype == SPACE_TEXT)) {
258                 return 1;
259         }
260         else if (obedit) {
261                 if (OB_TYPE_SUPPORT_EDITMODE(obedit->type)) {
262                         return undo_editmode_is_valid(undoname);
263                 }
264         }
265         else {
266                 
267                 /* if below tests fail, global undo gets executed */
268                 
269                 if (obact && obact->mode & OB_MODE_TEXTURE_PAINT) {
270                         if (ED_undo_paint_is_valid(UNDO_PAINT_IMAGE, undoname))
271                                 return 1;
272                 }
273                 else if (obact && obact->mode & OB_MODE_SCULPT) {
274                         if (ED_undo_paint_is_valid(UNDO_PAINT_MESH, undoname))
275                                 return 1;
276                 }
277                 else if (obact && obact->mode & OB_MODE_PARTICLE_EDIT) {
278                         return PE_undo_is_valid(CTX_data_scene(C));
279                 }
280                 
281                 if (U.uiflag & USER_GLOBALUNDO) {
282                         return BKE_undo_is_valid(undoname);
283                 }
284         }
285         return 0;
286 }
287
288 static int ed_undo_exec(bContext *C, wmOperator *UNUSED(op))
289 {
290         /* "last operator" should disappear, later we can tie this with undo stack nicer */
291         WM_operator_stack_clear(CTX_wm_manager(C));
292         return ed_undo_step(C, 1, NULL);
293 }
294
295 static int ed_undo_push_exec(bContext *C, wmOperator *op)
296 {
297         char str[BKE_UNDO_STR_MAX];
298         RNA_string_get(op->ptr, "message", str);
299         ED_undo_push(C, str);
300         return OPERATOR_FINISHED;
301 }
302
303 static int ed_redo_exec(bContext *C, wmOperator *UNUSED(op))
304 {
305         return ed_undo_step(C, -1, NULL);
306 }
307
308
309 /* ********************** */
310
311 void ED_OT_undo(wmOperatorType *ot)
312 {
313         /* identifiers */
314         ot->name = "Undo";
315         ot->description = "Undo previous action";
316         ot->idname = "ED_OT_undo";
317         
318         /* api callbacks */
319         ot->exec = ed_undo_exec;
320         ot->poll = ED_operator_screenactive;
321 }
322
323 void ED_OT_undo_push(wmOperatorType *ot)
324 {
325         /* identifiers */
326         ot->name = "Undo Push";
327         ot->description = "Add an undo state (internal use only)";
328         ot->idname = "ED_OT_undo_push";
329         
330         /* api callbacks */
331         ot->exec = ed_undo_push_exec;
332
333         ot->flag = OPTYPE_INTERNAL;
334
335         RNA_def_string(ot->srna, "message", "Add an undo step *function may be moved*", BKE_UNDO_STR_MAX, "Undo Message", "");
336 }
337
338 void ED_OT_redo(wmOperatorType *ot)
339 {
340         /* identifiers */
341         ot->name = "Redo";
342         ot->description = "Redo previous action";
343         ot->idname = "ED_OT_redo";
344         
345         /* api callbacks */
346         ot->exec = ed_redo_exec;
347         ot->poll = ED_operator_screenactive;
348 }
349
350
351 /* ui callbacks should call this rather than calling WM_operator_repeat() themselves */
352 int ED_undo_operator_repeat(bContext *C, struct wmOperator *op)
353 {
354         int ret = 0;
355
356         if (op) {
357                 wmWindowManager *wm = CTX_wm_manager(C);
358                 struct Scene *scene = CTX_data_scene(C);
359
360                 /* keep in sync with logic in view3d_panel_operator_redo() */
361                 ARegion *ar = CTX_wm_region(C);
362                 ARegion *ar1 = BKE_area_find_region_active_win(CTX_wm_area(C));
363
364                 if (ar1)
365                         CTX_wm_region_set(C, ar1);
366
367                 if ((WM_operator_repeat_check(C, op)) &&
368                     (WM_operator_poll(C, op->type)) &&
369                      /* note, undo/redo cant run if there are jobs active,
370                       * check for screen jobs only so jobs like material/texture/world preview
371                       * (which copy their data), wont stop redo, see [#29579]],
372                       *
373                       * note, - WM_operator_check_ui_enabled() jobs test _must_ stay in sync with this */
374                     (WM_jobs_test(wm, scene, WM_JOB_TYPE_ANY) == 0))
375                 {
376                         int retval;
377
378                         ED_viewport_render_kill_jobs(wm, CTX_data_main(C), true);
379
380                         if (G.debug & G_DEBUG)
381                                 printf("redo_cb: operator redo %s\n", op->type->name);
382                         ED_undo_pop_op(C, op);
383
384                         if (op->type->check) {
385                                 if (op->type->check(C, op)) {
386                                         /* check for popup and re-layout buttons */
387                                         ARegion *ar_menu = CTX_wm_menu(C);
388                                         if (ar_menu) {
389                                                 ED_region_tag_refresh_ui(ar_menu);
390                                         }
391                                 }
392                         }
393
394                         retval = WM_operator_repeat(C, op);
395                         if ((retval & OPERATOR_FINISHED) == 0) {
396                                 if (G.debug & G_DEBUG)
397                                         printf("redo_cb: operator redo failed: %s, return %d\n", op->type->name, retval);
398                                 ED_undo_redo(C);
399                         }
400                         else {
401                                 ret = 1;
402                         }
403                 }
404                 else {
405                         if (G.debug & G_DEBUG) {
406                                 printf("redo_cb: WM_operator_repeat_check returned false %s\n", op->type->name);
407                         }
408                 }
409
410                 /* set region back */
411                 CTX_wm_region_set(C, ar);
412         }
413         else {
414                 if (G.debug & G_DEBUG) {
415                         printf("redo_cb: ED_undo_operator_repeat called with NULL 'op'\n");
416                 }
417         }
418
419         return ret;
420 }
421
422
423 void ED_undo_operator_repeat_cb(bContext *C, void *arg_op, void *UNUSED(arg_unused))
424 {
425         ED_undo_operator_repeat(C, (wmOperator *)arg_op);
426 }
427
428 void ED_undo_operator_repeat_cb_evt(bContext *C, void *arg_op, int UNUSED(arg_event))
429 {
430         ED_undo_operator_repeat(C, (wmOperator *)arg_op);
431 }
432
433
434 /* ************************** */
435
436 enum {
437         UNDOSYSTEM_GLOBAL   = 1,
438         UNDOSYSTEM_EDITMODE = 2,
439         UNDOSYSTEM_PARTICLE = 3,
440         UNDOSYSTEM_IMAPAINT = 4
441 };
442
443 static int get_undo_system(bContext *C)
444 {
445         Object *obact = CTX_data_active_object(C);
446         Object *obedit = CTX_data_edit_object(C);
447         ScrArea *sa = CTX_wm_area(C);
448
449         /* first check for editor undo */
450         if (sa && (sa->spacetype == SPACE_IMAGE)) {
451                 SpaceImage *sima = (SpaceImage *)sa->spacedata.first;
452
453                 if ((obact && (obact->mode & OB_MODE_TEXTURE_PAINT)) || (sima->mode == SI_MODE_PAINT)) {
454                         if (!ED_undo_paint_empty(UNDO_PAINT_IMAGE))
455                                 return UNDOSYSTEM_IMAPAINT;
456                 }
457         }
458         /* find out which undo system */
459         if (obedit) {
460                 if (OB_TYPE_SUPPORT_EDITMODE(obedit->type)) {
461                         return UNDOSYSTEM_EDITMODE;
462                 }
463         }
464         else {
465                 Object *obact = CTX_data_active_object(C);
466                 
467                 if (obact) {
468                         if (obact->mode & OB_MODE_PARTICLE_EDIT)
469                                 return UNDOSYSTEM_PARTICLE;
470                         else if (obact->mode & OB_MODE_TEXTURE_PAINT) {
471                                 if (!ED_undo_paint_empty(UNDO_PAINT_IMAGE))
472                                         return UNDOSYSTEM_IMAPAINT;
473                         }
474                 }
475                 if (U.uiflag & USER_GLOBALUNDO)
476                         return UNDOSYSTEM_GLOBAL;
477         }
478         
479         return 0;
480 }
481
482 /* create enum based on undo items */
483 static EnumPropertyItem *rna_undo_itemf(bContext *C, int undosys, int *totitem)
484 {
485         EnumPropertyItem item_tmp = {0}, *item = NULL;
486         int i = 0;
487         bool active;
488         
489         while (true) {
490                 const char *name = NULL;
491                 
492                 if (undosys == UNDOSYSTEM_PARTICLE) {
493                         name = PE_undo_get_name(CTX_data_scene(C), i, &active);
494                 }
495                 else if (undosys == UNDOSYSTEM_EDITMODE) {
496                         name = undo_editmode_get_name(C, i, &active);
497                 }
498                 else if (undosys == UNDOSYSTEM_IMAPAINT) {
499                         name = ED_undo_paint_get_name(C, UNDO_PAINT_IMAGE, i, &active);
500                 }
501                 else {
502                         name = BKE_undo_get_name(i, &active);
503                 }
504                 
505                 if (name) {
506                         item_tmp.identifier = name;
507                         /* XXX This won't work with non-default contexts (e.g. operators) :/ */
508                         item_tmp.name = IFACE_(name);
509                         if (active)
510                                 item_tmp.icon = ICON_RESTRICT_VIEW_OFF;
511                         else 
512                                 item_tmp.icon = ICON_NONE;
513                         item_tmp.value = i++;
514                         RNA_enum_item_add(&item, totitem, &item_tmp);
515                 }
516                 else
517                         break;
518         }
519         
520         RNA_enum_item_end(&item, totitem);
521         
522         return item;
523 }
524
525
526 static int undo_history_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
527 {
528         int undosys, totitem = 0;
529         
530         undosys = get_undo_system(C);
531         
532         if (undosys) {
533                 EnumPropertyItem *item = rna_undo_itemf(C, undosys, &totitem);
534                 
535                 if (totitem > 0) {
536                         uiPopupMenu *pup = UI_popup_menu_begin(C, RNA_struct_ui_name(op->type->srna), ICON_NONE);
537                         uiLayout *layout = UI_popup_menu_layout(pup);
538                         uiLayout *split = uiLayoutSplit(layout, 0.0f, false);
539                         uiLayout *column = NULL;
540                         const int col_size = 20 + totitem / 12;
541                         int i, c;
542                         bool add_col = true;
543                         
544                         for (c = 0, i = totitem; i--;) {
545                                 if (add_col && !(c % col_size)) {
546                                         column = uiLayoutColumn(split, false);
547                                         add_col = false;
548                                 }
549                                 if (item[i].identifier) {
550                                         uiItemIntO(column, item[i].name, item[i].icon, op->type->idname, "item", item[i].value);
551                                         ++c;
552                                         add_col = true;
553                                 }
554                         }
555                         
556                         MEM_freeN(item);
557                         
558                         UI_popup_menu_end(C, pup);
559                 }
560                 
561         }
562         return OPERATOR_CANCELLED;
563 }
564
565 /* note: also check ed_undo_step() in top if you change notifiers */
566 static int undo_history_exec(bContext *C, wmOperator *op)
567 {
568         if (RNA_struct_property_is_set(op->ptr, "item")) {
569                 int undosys = get_undo_system(C);
570                 int item = RNA_int_get(op->ptr, "item");
571                 
572                 if (undosys == UNDOSYSTEM_PARTICLE) {
573                         PE_undo_number(CTX_data_scene(C), item);
574                 }
575                 else if (undosys == UNDOSYSTEM_EDITMODE) {
576                         undo_editmode_number(C, item + 1);
577                         WM_event_add_notifier(C, NC_GEOM | ND_DATA, NULL);
578                 }
579                 else if (undosys == UNDOSYSTEM_IMAPAINT) {
580                         ED_undo_paint_step_num(C, UNDO_PAINT_IMAGE, item);
581                 }
582                 else {
583                         ED_viewport_render_kill_jobs(CTX_wm_manager(C), CTX_data_main(C), true);
584                         BKE_undo_number(C, item);
585                         WM_event_add_notifier(C, NC_SCENE | ND_LAYER_CONTENT, CTX_data_scene(C));
586                 }
587                 WM_event_add_notifier(C, NC_WINDOW, NULL);
588                 
589                 return OPERATOR_FINISHED;
590         }
591         return OPERATOR_CANCELLED;
592 }
593
594 void ED_OT_undo_history(wmOperatorType *ot)
595 {
596         /* identifiers */
597         ot->name = "Undo History";
598         ot->description = "Redo specific action in history";
599         ot->idname = "ED_OT_undo_history";
600         
601         /* api callbacks */
602         ot->invoke = undo_history_invoke;
603         ot->exec = undo_history_exec;
604         ot->poll = ED_operator_screenactive;
605         
606         RNA_def_int(ot->srna, "item", 0, 0, INT_MAX, "Item", "", 0, INT_MAX);
607
608 }
609
610