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