Workspaces: reference count screens, otherwise they are never freed.
[blender.git] / source / blender / editors / undo / ed_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/undo/ed_undo.c
29  *  \ingroup edundo
30  */
31
32 #include <string.h>
33
34 #include "MEM_guardedalloc.h"
35
36 #include "CLG_log.h"
37
38 #include "DNA_scene_types.h"
39 #include "DNA_object_types.h"
40
41 #include "BLI_utildefines.h"
42 #include "BLI_callbacks.h"
43 #include "BLI_listbase.h"
44
45 #include "BLT_translation.h"
46
47 #include "BKE_blender_undo.h"
48 #include "BKE_context.h"
49 #include "BKE_global.h"
50 #include "BKE_main.h"
51 #include "BKE_scene.h"
52 #include "BKE_screen.h"
53 #include "BKE_layer.h"
54 #include "BKE_undo_system.h"
55 #include "BKE_workspace.h"
56 #include "BKE_paint.h"
57
58 #include "ED_gpencil.h"
59 #include "ED_render.h"
60 #include "ED_object.h"
61 #include "ED_screen.h"
62 #include "ED_undo.h"
63
64 #include "WM_api.h"
65 #include "WM_types.h"
66 #include "WM_toolsystem.h"
67
68 #include "RNA_access.h"
69 #include "RNA_define.h"
70
71 #include "UI_interface.h"
72 #include "UI_resources.h"
73
74 /** We only need this locally. */
75 static CLG_LogRef LOG = {"ed.undo"};
76
77 /* -------------------------------------------------------------------- */
78 /** \name Generic Undo System Access
79  *
80  * Non-operator undo editor functions.
81  * \{ */
82
83 void ED_undo_push(bContext *C, const char *str)
84 {
85         CLOG_INFO(&LOG, 1, "name='%s'", str);
86
87         const int steps = U.undosteps;
88
89         if (steps <= 0) {
90                 return;
91         }
92
93         wmWindowManager *wm = CTX_wm_manager(C);
94
95         /* Only apply limit if this is the last undo step. */
96         if (wm->undo_stack->step_active && (wm->undo_stack->step_active->next == NULL)) {
97                 BKE_undosys_stack_limit_steps_and_memory(wm->undo_stack, steps - 1, 0);
98         }
99
100         BKE_undosys_step_push(wm->undo_stack, C, str);
101
102         if (U.undomemory != 0) {
103                 const size_t memory_limit = (size_t)U.undomemory * 1024 * 1024;
104                 BKE_undosys_stack_limit_steps_and_memory(wm->undo_stack, 0, memory_limit);
105         }
106
107         WM_file_tag_modified();
108 }
109
110 /* note: also check undo_history_exec() in bottom if you change notifiers */
111 static int ed_undo_step(bContext *C, int step, const char *undoname)
112 {
113         CLOG_INFO(&LOG, 1, "name='%s', step=%d", undoname, step);
114         wmWindowManager *wm = CTX_wm_manager(C);
115         wmWindow *win = CTX_wm_window(C);
116         Scene *scene = CTX_data_scene(C);
117         ScrArea *sa = CTX_wm_area(C);
118
119         /* undo during jobs are running can easily lead to freeing data using by jobs,
120          * or they can just lead to freezing job in some other cases */
121         WM_jobs_kill_all(wm);
122
123         /* TODO(campbell): undo_system: use undo system */
124         /* grease pencil can be can be used in plenty of spaces, so check it first */
125         if (ED_gpencil_session_active()) {
126                 return ED_undo_gpencil_step(C, step, undoname);
127         }
128         if (sa && (sa->spacetype == SPACE_VIEW3D)) {
129                 Object *obact = CTX_data_active_object(C);
130                 if (obact && (obact->type == OB_GPENCIL)) {
131                         ED_gpencil_toggle_brush_cursor(C, false, NULL);
132                 }
133         }
134
135         UndoStep *step_data_from_name = NULL;
136         int step_for_callback = step;
137         if (undoname != NULL) {
138                 step_data_from_name = BKE_undosys_step_find_by_name(wm->undo_stack, undoname);
139                 if (step_data_from_name == NULL) {
140                         return OPERATOR_CANCELLED;
141                 }
142
143                 /* TODO(campbell), could use simple optimization. */
144                 /* Pointers match on redo. */
145                 step_for_callback = (
146                         BLI_findindex(&wm->undo_stack->steps, step_data_from_name) <
147                         BLI_findindex(&wm->undo_stack->steps, wm->undo_stack->step_active)) ? 1 : -1;
148         }
149
150         /* App-Handlers (pre). */
151         {
152                 /* Note: ignore grease pencil for now. */
153                 Main *bmain = CTX_data_main(C);
154                 wm->op_undo_depth++;
155                 BLI_callback_exec(bmain, &scene->id, (step_for_callback > 0) ? BLI_CB_EVT_UNDO_PRE : BLI_CB_EVT_REDO_PRE);
156                 wm->op_undo_depth--;
157         }
158
159
160         /* Undo System */
161         {
162                 if (undoname) {
163                         BKE_undosys_step_undo_with_data(wm->undo_stack, C, step_data_from_name);
164                 }
165                 else {
166                         BKE_undosys_step_undo_compat_only(wm->undo_stack, C, step);
167                 }
168
169                 /* Set special modes for grease pencil */
170                 if (sa && (sa->spacetype == SPACE_VIEW3D)) {
171                         Object *obact = CTX_data_active_object(C);
172                         if (obact && (obact->type == OB_GPENCIL)) {
173                                 /* set cursor */
174                                 if (ELEM(obact->mode, OB_MODE_GPENCIL_PAINT, OB_MODE_GPENCIL_SCULPT, OB_MODE_GPENCIL_WEIGHT)) {
175                                         ED_gpencil_toggle_brush_cursor(C, true, NULL);
176                                 }
177                                 else {
178                                         ED_gpencil_toggle_brush_cursor(C, false, NULL);
179                                 }
180                                 /* set workspace mode */
181                                 Base *basact = CTX_data_active_base(C);
182                                 ED_object_base_activate(C, basact);
183                         }
184                 }
185         }
186
187         /* App-Handlers (post). */
188         {
189                 Main *bmain = CTX_data_main(C);
190                 scene = CTX_data_scene(C);
191                 wm->op_undo_depth++;
192                 BLI_callback_exec(bmain, &scene->id, step_for_callback > 0 ? BLI_CB_EVT_UNDO_PRE : BLI_CB_EVT_REDO_PRE);
193                 wm->op_undo_depth--;
194         }
195
196         WM_event_add_notifier(C, NC_WINDOW, NULL);
197         WM_event_add_notifier(C, NC_WM | ND_UNDO, NULL);
198
199         Main *bmain = CTX_data_main(C);
200         WM_toolsystem_refresh_screen_all(bmain);
201
202         if (win) {
203                 win->addmousemove = true;
204         }
205
206         return OPERATOR_FINISHED;
207 }
208
209 void ED_undo_grouped_push(bContext *C, const char *str)
210 {
211         /* do nothing if previous undo task is the same as this one (or from the same undo group) */
212         wmWindowManager *wm = CTX_wm_manager(C);
213         const UndoStep *us = wm->undo_stack->step_active;
214         if (us && STREQ(str, us->name)) {
215                 BKE_undosys_stack_clear_active(wm->undo_stack);
216         }
217
218         /* push as usual */
219         ED_undo_push(C, str);
220 }
221
222 void ED_undo_pop(bContext *C)
223 {
224         ed_undo_step(C, 1, NULL);
225 }
226 void ED_undo_redo(bContext *C)
227 {
228         ed_undo_step(C, -1, NULL);
229 }
230
231 void ED_undo_push_op(bContext *C, wmOperator *op)
232 {
233         /* in future, get undo string info? */
234         ED_undo_push(C, op->type->name);
235 }
236
237 void ED_undo_grouped_push_op(bContext *C, wmOperator *op)
238 {
239         if (op->type->undo_group[0] != '\0') {
240                 ED_undo_grouped_push(C, op->type->undo_group);
241         }
242         else {
243                 ED_undo_grouped_push(C, op->type->name);
244         }
245 }
246
247 void ED_undo_pop_op(bContext *C, wmOperator *op)
248 {
249         /* search back a couple of undo's, in case something else added pushes */
250         ed_undo_step(C, 0, op->type->name);
251 }
252
253 /* name optionally, function used to check for operator redo panel */
254 bool ED_undo_is_valid(const bContext *C, const char *undoname)
255 {
256         wmWindowManager *wm = CTX_wm_manager(C);
257         return BKE_undosys_stack_has_undo(wm->undo_stack, undoname);
258 }
259
260 /**
261  * Ideally we wont access the stack directly,
262  * this is needed for modes which handle undo themselves (bypassing #ED_undo_push).
263  *
264  * Using global isn't great, this just avoids doing inline,
265  * causing 'BKE_global.h' & 'BKE_main.h' includes.
266  */
267 UndoStack *ED_undo_stack_get(void)
268 {
269         wmWindowManager *wm = G_MAIN->wm.first;
270         return wm->undo_stack;
271 }
272
273 /** \} */
274
275 /* -------------------------------------------------------------------- */
276 /** \name Undo, Undo Push & Redo Operators
277  * \{ */
278
279 static int ed_undo_exec(bContext *C, wmOperator *UNUSED(op))
280 {
281         /* "last operator" should disappear, later we can tie this with undo stack nicer */
282         WM_operator_stack_clear(CTX_wm_manager(C));
283         return ed_undo_step(C, 1, NULL);
284 }
285
286 static int ed_undo_push_exec(bContext *C, wmOperator *op)
287 {
288         char str[BKE_UNDO_STR_MAX];
289         RNA_string_get(op->ptr, "message", str);
290         ED_undo_push(C, str);
291         return OPERATOR_FINISHED;
292 }
293
294 static int ed_redo_exec(bContext *C, wmOperator *UNUSED(op))
295 {
296         return ed_undo_step(C, -1, NULL);
297 }
298
299 static int ed_undo_redo_exec(bContext *C, wmOperator *UNUSED(op))
300 {
301         wmOperator *last_op = WM_operator_last_redo(C);
302         const int ret = ED_undo_operator_repeat(C, last_op);
303         return ret ? OPERATOR_FINISHED : OPERATOR_CANCELLED;
304 }
305
306 static bool ed_undo_redo_poll(bContext *C)
307 {
308         wmOperator *last_op = WM_operator_last_redo(C);
309         return last_op && ED_operator_screenactive(C) &&
310                 WM_operator_check_ui_enabled(C, last_op->type->name);
311 }
312
313 void ED_OT_undo(wmOperatorType *ot)
314 {
315         /* identifiers */
316         ot->name = "Undo";
317         ot->description = "Undo previous action";
318         ot->idname = "ED_OT_undo";
319
320         /* api callbacks */
321         ot->exec = ed_undo_exec;
322         ot->poll = ED_operator_screenactive;
323 }
324
325 void ED_OT_undo_push(wmOperatorType *ot)
326 {
327         /* identifiers */
328         ot->name = "Undo Push";
329         ot->description = "Add an undo state (internal use only)";
330         ot->idname = "ED_OT_undo_push";
331
332         /* api callbacks */
333         ot->exec = ed_undo_push_exec;
334
335         ot->flag = OPTYPE_INTERNAL;
336
337         RNA_def_string(ot->srna, "message", "Add an undo step *function may be moved*", BKE_UNDO_STR_MAX, "Undo Message", "");
338 }
339
340 void ED_OT_redo(wmOperatorType *ot)
341 {
342         /* identifiers */
343         ot->name = "Redo";
344         ot->description = "Redo previous action";
345         ot->idname = "ED_OT_redo";
346
347         /* api callbacks */
348         ot->exec = ed_redo_exec;
349         ot->poll = ED_operator_screenactive;
350 }
351
352 void ED_OT_undo_redo(wmOperatorType *ot)
353 {
354         /* identifiers */
355         ot->name = "Undo and Redo";
356         ot->description = "Undo and redo previous action";
357         ot->idname = "ED_OT_undo_redo";
358
359         /* api callbacks */
360         ot->exec = ed_undo_redo_exec;
361         ot->poll = ed_undo_redo_poll;
362 }
363
364 /** \} */
365
366 /* -------------------------------------------------------------------- */
367 /** \name Operator Repeat
368  * \{ */
369
370 /* ui callbacks should call this rather than calling WM_operator_repeat() themselves */
371 int ED_undo_operator_repeat(bContext *C, wmOperator *op)
372 {
373         int ret = 0;
374
375         if (op) {
376                 CLOG_INFO(&LOG, 1, "idname='%s'", op->type->idname);
377                 wmWindowManager *wm = CTX_wm_manager(C);
378                 struct Scene *scene = CTX_data_scene(C);
379
380                 /* keep in sync with logic in view3d_panel_operator_redo() */
381                 ARegion *ar_orig = CTX_wm_region(C);
382                 ARegion *ar_win = BKE_area_find_region_active_win(CTX_wm_area(C));
383
384                 if (ar_win) {
385                         CTX_wm_region_set(C, ar_win);
386                 }
387
388                 if ((WM_operator_repeat_check(C, op)) &&
389                     (WM_operator_poll(C, op->type)) &&
390                      /* note, undo/redo cant run if there are jobs active,
391                       * check for screen jobs only so jobs like material/texture/world preview
392                       * (which copy their data), wont stop redo, see [#29579]],
393                       *
394                       * note, - WM_operator_check_ui_enabled() jobs test _must_ stay in sync with this */
395                     (WM_jobs_test(wm, scene, WM_JOB_TYPE_ANY) == 0))
396                 {
397                         int retval;
398
399                         if (G.debug & G_DEBUG)
400                                 printf("redo_cb: operator redo %s\n", op->type->name);
401
402                         WM_operator_free_all_after(wm, op);
403
404                         ED_undo_pop_op(C, op);
405
406                         if (op->type->check) {
407                                 if (op->type->check(C, op)) {
408                                         /* check for popup and re-layout buttons */
409                                         ARegion *ar_menu = CTX_wm_menu(C);
410                                         if (ar_menu) {
411                                                 ED_region_tag_refresh_ui(ar_menu);
412                                         }
413                                 }
414                         }
415
416                         if (op->type->flag & OPTYPE_USE_EVAL_DATA) {
417                                 /* We need to force refresh of depsgraph after undo step,
418                                  * redoing the operator *may* rely on some valid evaluated data. */
419                                 Main *bmain = CTX_data_main(C);
420                                 scene = CTX_data_scene(C);
421                                 ViewLayer *view_layer = CTX_data_view_layer(C);
422                                 BKE_scene_view_layer_graph_evaluated_ensure(bmain, scene, view_layer);
423                         }
424
425                         retval = WM_operator_repeat(C, op);
426                         if ((retval & OPERATOR_FINISHED) == 0) {
427                                 if (G.debug & G_DEBUG)
428                                         printf("redo_cb: operator redo failed: %s, return %d\n", op->type->name, retval);
429                                 ED_undo_redo(C);
430                         }
431                         else {
432                                 ret = 1;
433                         }
434                 }
435                 else {
436                         if (G.debug & G_DEBUG) {
437                                 printf("redo_cb: WM_operator_repeat_check returned false %s\n", op->type->name);
438                         }
439                 }
440
441                 /* set region back */
442                 CTX_wm_region_set(C, ar_orig);
443         }
444         else {
445                 CLOG_WARN(&LOG, "called with NULL 'op'");
446         }
447
448         return ret;
449 }
450
451
452 void ED_undo_operator_repeat_cb(bContext *C, void *arg_op, void *UNUSED(arg_unused))
453 {
454         ED_undo_operator_repeat(C, (wmOperator *)arg_op);
455 }
456
457 void ED_undo_operator_repeat_cb_evt(bContext *C, void *arg_op, int UNUSED(arg_event))
458 {
459         ED_undo_operator_repeat(C, (wmOperator *)arg_op);
460 }
461
462 /** \} */
463
464 /* -------------------------------------------------------------------- */
465 /** \name Undo History Operator
466  * \{ */
467
468 /* create enum based on undo items */
469 static const EnumPropertyItem *rna_undo_itemf(bContext *C, int *totitem)
470 {
471         EnumPropertyItem item_tmp = {0}, *item = NULL;
472         int i = 0;
473
474         wmWindowManager *wm = CTX_wm_manager(C);
475         if (wm->undo_stack == NULL) {
476                 return NULL;
477         }
478
479         for (UndoStep *us = wm->undo_stack->steps.first; us; us = us->next, i++) {
480                 if (us->skip == false) {
481                         item_tmp.identifier = us->name;
482                         item_tmp.name = IFACE_(us->name);
483                         if (us == wm->undo_stack->step_active) {
484                                 item_tmp.icon = ICON_HIDE_OFF;
485                         }
486                         else {
487                                 item_tmp.icon = ICON_NONE;
488                         }
489                         item_tmp.value = i;
490                         RNA_enum_item_add(&item, totitem, &item_tmp);
491                 }
492         }
493         RNA_enum_item_end(&item, totitem);
494
495         return item;
496 }
497
498
499 static int undo_history_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
500 {
501         int totitem = 0;
502
503         {
504                 const EnumPropertyItem *item = rna_undo_itemf(C, &totitem);
505
506                 if (totitem > 0) {
507                         uiPopupMenu *pup = UI_popup_menu_begin(C, RNA_struct_ui_name(op->type->srna), ICON_NONE);
508                         uiLayout *layout = UI_popup_menu_layout(pup);
509                         uiLayout *split = uiLayoutSplit(layout, 0.0f, false);
510                         uiLayout *column = NULL;
511                         const int col_size = 20 + totitem / 12;
512                         int i, c;
513                         bool add_col = true;
514
515                         for (c = 0, i = totitem; i--;) {
516                                 if (add_col && !(c % col_size)) {
517                                         column = uiLayoutColumn(split, false);
518                                         add_col = false;
519                                 }
520                                 if (item[i].identifier) {
521                                         uiItemIntO(column, item[i].name, item[i].icon, op->type->idname, "item", item[i].value);
522                                         ++c;
523                                         add_col = true;
524                                 }
525                         }
526
527                         MEM_freeN((void *)item);
528
529                         UI_popup_menu_end(C, pup);
530                 }
531
532         }
533         return OPERATOR_CANCELLED;
534 }
535
536 /* note: also check ed_undo_step() in top if you change notifiers */
537 static int undo_history_exec(bContext *C, wmOperator *op)
538 {
539         PropertyRNA *prop = RNA_struct_find_property(op->ptr, "item");
540         if (RNA_property_is_set(op->ptr, prop)) {
541                 int item = RNA_property_int_get(op->ptr, prop);
542                 wmWindowManager *wm = CTX_wm_manager(C);
543                 BKE_undosys_step_undo_from_index(wm->undo_stack, C, item);
544                 WM_event_add_notifier(C, NC_WINDOW, NULL);
545                 return OPERATOR_FINISHED;
546         }
547         return OPERATOR_CANCELLED;
548 }
549
550 void ED_OT_undo_history(wmOperatorType *ot)
551 {
552         /* identifiers */
553         ot->name = "Undo History";
554         ot->description = "Redo specific action in history";
555         ot->idname = "ED_OT_undo_history";
556
557         /* api callbacks */
558         ot->invoke = undo_history_invoke;
559         ot->exec = undo_history_exec;
560         ot->poll = ED_operator_screenactive;
561
562         RNA_def_int(ot->srna, "item", 0, 0, INT_MAX, "Item", "", 0, INT_MAX);
563
564 }
565
566 /** \} */
567
568 /* -------------------------------------------------------------------- */
569 /** \name Undo Helper Functions
570  * \{ */
571
572 void ED_undo_object_set_active_or_warn(ViewLayer *view_layer, Object *ob, const char *info, CLG_LogRef *log)
573 {
574         Object *ob_prev = OBACT(view_layer);
575         if (ob_prev != ob) {
576                 Base *base = BKE_view_layer_base_find(view_layer, ob);
577                 if (base != NULL) {
578                         view_layer->basact = base;
579                 }
580                 else {
581                         /* Should never fail, may not crash but can give odd behavior. */
582                         CLOG_WARN(log, "'%s' failed to restore active object: '%s'", info, ob->id.name + 2);
583                 }
584         }
585 }
586
587 /** \} */