UI: workaround for glitch redo panel glitch
[blender.git] / source / blender / windowmanager / intern / wm_operators.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) 2007 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/windowmanager/intern/wm_operators.c
28  *  \ingroup wm
29  *
30  * Functions for dealing with wmOperator, adding, removing, calling
31  * as well as some generic operators and shared operator properties.
32  */
33
34
35 #include <float.h>
36 #include <string.h>
37 #include <ctype.h>
38 #include <stdio.h>
39 #include <stddef.h>
40 #include <assert.h>
41 #include <errno.h>
42
43 #ifdef WIN32
44 #  include "GHOST_C-api.h"
45 #endif
46
47 #include "MEM_guardedalloc.h"
48
49 #include "CLG_log.h"
50
51 #include "DNA_ID.h"
52 #include "DNA_object_types.h"
53 #include "DNA_screen_types.h"
54 #include "DNA_scene_types.h"
55 #include "DNA_userdef_types.h"
56 #include "DNA_windowmanager_types.h"
57 #include "DNA_workspace_types.h"
58
59 #include "BLT_translation.h"
60
61 #include "PIL_time.h"
62
63 #include "BLI_blenlib.h"
64 #include "BLI_dial_2d.h"
65 #include "BLI_dynstr.h" /*for WM_operator_pystring */
66 #include "BLI_math.h"
67 #include "BLI_utildefines.h"
68 #include "BLI_ghash.h"
69
70 #include "BLO_readfile.h"
71
72 #include "BKE_appdir.h"
73 #include "BKE_blender_version.h"
74 #include "BKE_brush.h"
75 #include "BKE_context.h"
76 #include "BKE_icons.h"
77 #include "BKE_idprop.h"
78 #include "BKE_image.h"
79 #include "BKE_library.h"
80 #include "BKE_library_query.h"
81 #include "BKE_global.h"
82 #include "BKE_main.h"
83 #include "BKE_material.h"
84 #include "BKE_report.h"
85 #include "BKE_scene.h"
86 #include "BKE_screen.h" /* BKE_ST_MAXNAME */
87 #include "BKE_unit.h"
88
89 #include "BKE_idcode.h"
90
91 #include "BLF_api.h"
92
93 #include "GPU_immediate.h"
94 #include "GPU_immediate_util.h"
95 #include "GPU_matrix.h"
96
97 #include "IMB_imbuf_types.h"
98 #include "IMB_imbuf.h"
99
100 #include "ED_numinput.h"
101 #include "ED_screen.h"
102 #include "ED_undo.h"
103 #include "ED_view3d.h"
104
105 #include "RNA_access.h"
106 #include "RNA_define.h"
107 #include "RNA_enum_types.h"
108
109 #include "UI_interface.h"
110 #include "UI_interface_icons.h"
111 #include "UI_resources.h"
112
113 #include "WM_api.h"
114 #include "WM_types.h"
115
116 #include "wm.h"
117 #include "wm_draw.h"
118 #include "wm_event_system.h"
119 #include "wm_event_types.h"
120 #include "wm_files.h"
121 #include "wm_window.h"
122
123 #define UNDOCUMENTED_OPERATOR_TIP N_("(undocumented operator)")
124
125 /* ************ operator API, exported ********** */
126
127 /* SOME_OT_op -> some.op */
128 void WM_operator_py_idname(char *to, const char *from)
129 {
130         const char *sep = strstr(from, "_OT_");
131         if (sep) {
132                 int ofs = (sep - from);
133
134                 /* note, we use ascii tolower instead of system tolower, because the
135                  * latter depends on the locale, and can lead to idname mismatch */
136                 memcpy(to, from, sizeof(char) * ofs);
137                 BLI_str_tolower_ascii(to, ofs);
138
139                 to[ofs] = '.';
140                 BLI_strncpy(to + (ofs + 1), sep + 4, OP_MAX_TYPENAME - (ofs + 1));
141         }
142         else {
143                 /* should not happen but support just in case */
144                 BLI_strncpy(to, from, OP_MAX_TYPENAME);
145         }
146 }
147
148 /* some.op -> SOME_OT_op */
149 void WM_operator_bl_idname(char *to, const char *from)
150 {
151         if (from) {
152                 const char *sep = strchr(from, '.');
153
154                 if (sep) {
155                         int ofs = (sep - from);
156
157                         memcpy(to, from, sizeof(char) * ofs);
158                         BLI_str_toupper_ascii(to, ofs);
159                         strcpy(to + ofs, "_OT_");
160                         strcpy(to + (ofs + 4), sep + 1);
161                 }
162                 else {
163                         /* should not happen but support just in case */
164                         BLI_strncpy(to, from, OP_MAX_TYPENAME);
165                 }
166         }
167         else
168                 to[0] = 0;
169 }
170
171 /**
172  * Sanity check to ensure #WM_operator_bl_idname won't fail.
173  * \returns true when there are no problems with \a idname, otherwise report an error.
174  */
175 bool WM_operator_py_idname_ok_or_report(ReportList *reports, const char *classname, const char *idname)
176 {
177         const char *ch = idname;
178         int dot = 0;
179         int i;
180         for (i = 0; *ch; i++, ch++) {
181                 if ((*ch >= 'a' && *ch <= 'z') || (*ch >= '0' && *ch <= '9') || *ch == '_') {
182                         /* pass */
183                 }
184                 else if (*ch == '.') {
185                         dot++;
186                 }
187                 else {
188                         BKE_reportf(reports, RPT_ERROR,
189                                     "Registering operator class: '%s', invalid bl_idname '%s', at position %d",
190                                     classname, idname, i);
191                         return false;
192                 }
193         }
194
195         if (i > (MAX_NAME - 3)) {
196                 BKE_reportf(reports, RPT_ERROR, "Registering operator class: '%s', invalid bl_idname '%s', "
197                             "is too long, maximum length is %d", classname, idname,
198                             MAX_NAME - 3);
199                 return false;
200         }
201
202         if (dot != 1) {
203                 BKE_reportf(reports, RPT_ERROR,
204                             "Registering operator class: '%s', invalid bl_idname '%s', must contain 1 '.' character",
205                             classname, idname);
206                 return false;
207         }
208         return true;
209 }
210
211 /**
212  * Print a string representation of the operator, with the args that it runs so python can run it again.
213  *
214  * When calling from an existing wmOperator, better to use simple version:
215  * `WM_operator_pystring(C, op);`
216  *
217  * \note Both \a op and \a opptr may be `NULL` (\a op is only used for macro operators).
218  */
219 char *WM_operator_pystring_ex(bContext *C, wmOperator *op, const bool all_args, const bool macro_args,
220                               wmOperatorType *ot, PointerRNA *opptr)
221 {
222         char idname_py[OP_MAX_TYPENAME];
223
224         /* for building the string */
225         DynStr *dynstr = BLI_dynstr_new();
226         char *cstring;
227         char *cstring_args;
228
229         /* arbitrary, but can get huge string with stroke painting otherwise */
230         int max_prop_length = 10;
231
232         WM_operator_py_idname(idname_py, ot->idname);
233         BLI_dynstr_appendf(dynstr, "bpy.ops.%s(", idname_py);
234
235         if (op && op->macro.first) {
236                 /* Special handling for macros, else we only get default values in this case... */
237                 wmOperator *opm;
238                 bool first_op = true;
239
240                 opm = macro_args ? op->macro.first : NULL;
241
242                 for (; opm; opm = opm->next) {
243                         PointerRNA *opmptr = opm->ptr;
244                         PointerRNA opmptr_default;
245                         if (opmptr == NULL) {
246                                 WM_operator_properties_create_ptr(&opmptr_default, opm->type);
247                                 opmptr = &opmptr_default;
248                         }
249
250                         cstring_args = RNA_pointer_as_string_id(C, opmptr);
251                         if (first_op) {
252                                 BLI_dynstr_appendf(dynstr, "%s=%s", opm->type->idname, cstring_args);
253                                 first_op = false;
254                         }
255                         else {
256                                 BLI_dynstr_appendf(dynstr, ", %s=%s", opm->type->idname, cstring_args);
257                         }
258                         MEM_freeN(cstring_args);
259
260                         if (opmptr == &opmptr_default) {
261                                 WM_operator_properties_free(&opmptr_default);
262                         }
263                 }
264         }
265         else {
266                 /* only to get the orginal props for comparisons */
267                 PointerRNA opptr_default;
268                 const bool macro_args_test = ot->macro.first ? macro_args : true;
269
270                 if (opptr == NULL) {
271                         WM_operator_properties_create_ptr(&opptr_default, ot);
272                         opptr = &opptr_default;
273                 }
274
275                 cstring_args = RNA_pointer_as_string_keywords(C, opptr, false, all_args, macro_args_test, max_prop_length);
276                 BLI_dynstr_append(dynstr, cstring_args);
277                 MEM_freeN(cstring_args);
278
279                 if (opptr == &opptr_default) {
280                         WM_operator_properties_free(&opptr_default);
281                 }
282         }
283
284         BLI_dynstr_append(dynstr, ")");
285
286         cstring = BLI_dynstr_get_cstring(dynstr);
287         BLI_dynstr_free(dynstr);
288         return cstring;
289 }
290
291 char *WM_operator_pystring(bContext *C, wmOperator *op,
292                            const bool all_args, const bool macro_args)
293 {
294         return WM_operator_pystring_ex(C, op, all_args, macro_args, op->type, op->ptr);
295 }
296
297
298 /**
299  * \return true if the string was shortened
300  */
301 bool WM_operator_pystring_abbreviate(char *str, int str_len_max)
302 {
303         const int str_len = strlen(str);
304         const char *parens_start = strchr(str, '(');
305
306         if (parens_start) {
307                 const int parens_start_pos = parens_start - str;
308                 const char *parens_end = strrchr(parens_start + 1, ')');
309
310                 if (parens_end) {
311                         const int parens_len = parens_end - parens_start;
312
313                         if (parens_len > str_len_max) {
314                                 const char *comma_first = strchr(parens_start, ',');
315
316                                 /* truncate after the first comma */
317                                 if (comma_first) {
318                                         const char end_str[] = " ... )";
319                                         const int end_str_len = sizeof(end_str) - 1;
320
321                                         /* leave a place for the first argument*/
322                                         const int new_str_len = (comma_first - parens_start) + 1;
323
324                                         if (str_len >= new_str_len + parens_start_pos + end_str_len + 1) {
325                                                 /* append " ... )" to the string after the comma */
326                                                 memcpy(str + new_str_len + parens_start_pos, end_str, end_str_len + 1);
327
328                                                 return true;
329                                         }
330                                 }
331                         }
332                 }
333         }
334
335         return false;
336 }
337
338 /* return NULL if no match is found */
339 #if 0
340 static const char *wm_context_member_from_ptr(bContext *C, const PointerRNA *ptr)
341 {
342         /* loop over all context items and do 2 checks
343          *
344          * - see if the pointer is in the context.
345          * - see if the pointers ID is in the context.
346          */
347
348         /* don't get from the context store since this is normally set only for the UI and not usable elsewhere */
349         ListBase lb = CTX_data_dir_get_ex(C, false, true, true);
350         LinkData *link;
351
352         const char *member_found = NULL;
353         const char *member_id = NULL;
354
355         for (link = lb.first; link; link = link->next) {
356                 const char *identifier = link->data;
357                 PointerRNA ctx_item_ptr = {{0}}; // CTX_data_pointer_get(C, identifier); // XXX, this isnt working
358
359                 if (ctx_item_ptr.type == NULL) {
360                         continue;
361                 }
362
363                 if (ptr->id.data == ctx_item_ptr.id.data) {
364                         if ((ptr->data == ctx_item_ptr.data) &&
365                             (ptr->type == ctx_item_ptr.type))
366                         {
367                                 /* found! */
368                                 member_found = identifier;
369                                 break;
370                         }
371                         else if (RNA_struct_is_ID(ctx_item_ptr.type)) {
372                                 /* we found a reference to this ID,
373                                  * so fallback to it if there is no direct reference */
374                                 member_id = identifier;
375                         }
376                 }
377         }
378         BLI_freelistN(&lb);
379
380         if (member_found) {
381                 return member_found;
382         }
383         else if (member_id) {
384                 return member_id;
385         }
386         else {
387                 return NULL;
388         }
389 }
390
391 #else
392
393 /* use hard coded checks for now */
394
395 static const char *wm_context_member_from_ptr(bContext *C, const PointerRNA *ptr)
396 {
397         const char *member_id = NULL;
398
399         if (ptr->id.data) {
400
401 #define CTX_TEST_PTR_ID(C, member, idptr) \
402                 { \
403                         const char *ctx_member = member; \
404                         PointerRNA ctx_item_ptr = CTX_data_pointer_get(C, ctx_member); \
405                         if (ctx_item_ptr.id.data == idptr) { \
406                                 member_id = ctx_member; \
407                                 break; \
408                         } \
409                 } (void)0
410
411 #define CTX_TEST_PTR_ID_CAST(C, member, member_full, cast, idptr) \
412                 { \
413                         const char *ctx_member = member; \
414                         const char *ctx_member_full = member_full; \
415                         PointerRNA ctx_item_ptr = CTX_data_pointer_get(C, ctx_member); \
416                         if (ctx_item_ptr.id.data && cast(ctx_item_ptr.id.data) == idptr) { \
417                                 member_id = ctx_member_full; \
418                                 break; \
419                         } \
420                 } (void)0
421
422 #define CTX_TEST_PTR_DATA_TYPE(C, member, rna_type, rna_ptr, dataptr_cmp) \
423                 { \
424                         const char *ctx_member = member; \
425                         if (RNA_struct_is_a((ptr)->type, &(rna_type)) && (ptr)->data == (dataptr_cmp)) { \
426                                 member_id = ctx_member; \
427                                 break; \
428                         } \
429                 } (void)0
430
431 #define CTX_TEST_SPACE_TYPE(space_data_type, member_full, dataptr_cmp) \
432                 { \
433                         const char *ctx_member_full = member_full; \
434                         if (space_data->spacetype == space_data_type && ptr->data == dataptr_cmp) { \
435                                 member_id = ctx_member_full; \
436                                 break; \
437                         } \
438                 } (void)0
439
440                 switch (GS(((ID *)ptr->id.data)->name)) {
441                         case ID_SCE:
442                         {
443                                 CTX_TEST_PTR_DATA_TYPE(C, "active_gpencil_brush", RNA_Brush, ptr, CTX_data_active_gpencil_brush(C));
444                                 CTX_TEST_PTR_ID(C, "scene", ptr->id.data);
445                                 break;
446                         }
447                         case ID_OB:
448                         {
449                                 CTX_TEST_PTR_ID(C, "object", ptr->id.data);
450                                 break;
451                         }
452                         /* from rna_Main_objects_new */
453                         case OB_DATA_SUPPORT_ID_CASE:
454                         {
455 #define ID_CAST_OBDATA(id_pt) (((Object *)(id_pt))->data)
456                                 CTX_TEST_PTR_ID_CAST(C, "object", "object.data", ID_CAST_OBDATA, ptr->id.data);
457                                 break;
458 #undef ID_CAST_OBDATA
459                         }
460                         case ID_MA:
461                         {
462 #define ID_CAST_OBMATACT(id_pt) (give_current_material(((Object *)id_pt), ((Object *)id_pt)->actcol))
463                                 CTX_TEST_PTR_ID_CAST(C, "object", "object.active_material", ID_CAST_OBMATACT, ptr->id.data);
464                                 break;
465 #undef ID_CAST_OBMATACT
466                         }
467                         case ID_WO:
468                         {
469 #define ID_CAST_SCENEWORLD(id_pt) (((Scene *)(id_pt))->world)
470                                 CTX_TEST_PTR_ID_CAST(C, "scene", "scene.world", ID_CAST_SCENEWORLD, ptr->id.data);
471                                 break;
472 #undef ID_CAST_SCENEWORLD
473                         }
474                         case ID_SCR:
475                         {
476                                 CTX_TEST_PTR_ID(C, "screen", ptr->id.data);
477
478                                 SpaceLink *space_data = CTX_wm_space_data(C);
479
480                                 CTX_TEST_PTR_DATA_TYPE(C, "space_data", RNA_Space, ptr, space_data);
481                                 CTX_TEST_PTR_DATA_TYPE(C, "space_data", RNA_View3DOverlay, ptr, space_data);
482                                 CTX_TEST_PTR_DATA_TYPE(C, "space_data", RNA_View3DShading, ptr, space_data);
483                                 CTX_TEST_PTR_DATA_TYPE(C, "area", RNA_Area, ptr, CTX_wm_area(C));
484                                 CTX_TEST_PTR_DATA_TYPE(C, "region", RNA_Region, ptr, CTX_wm_region(C));
485
486                                 CTX_TEST_SPACE_TYPE(SPACE_IMAGE, "space_data.uv_editor", space_data);
487                                 CTX_TEST_SPACE_TYPE(SPACE_VIEW3D, "space_data.fx_settings", &(CTX_wm_view3d(C)->fx_settings));
488                                 CTX_TEST_SPACE_TYPE(SPACE_NLA, "space_data.dopesheet", CTX_wm_space_nla(C)->ads);
489                                 CTX_TEST_SPACE_TYPE(SPACE_IPO, "space_data.dopesheet", CTX_wm_space_graph(C)->ads);
490                                 CTX_TEST_SPACE_TYPE(SPACE_ACTION, "space_data.dopesheet", &(CTX_wm_space_action(C)->ads));
491                                 CTX_TEST_SPACE_TYPE(SPACE_FILE, "space_data.params", CTX_wm_space_file(C)->params);
492                                 break;
493                         }
494                         default:
495                                 break;
496                 }
497 #undef CTX_TEST_PTR_ID
498 #undef CTX_TEST_PTR_ID_CAST
499 #undef CTX_TEST_SPACE_TYPE
500         }
501
502         return member_id;
503 }
504 #endif
505
506 static char *wm_prop_pystring_from_context(bContext *C, PointerRNA *ptr, PropertyRNA *prop, int index)
507 {
508         const char *member_id = wm_context_member_from_ptr(C, ptr);
509         char *ret = NULL;
510         if (member_id != NULL) {
511                 char *prop_str = RNA_path_struct_property_py(ptr, prop, index);
512                 if (prop_str) {
513                         ret = BLI_sprintfN("bpy.context.%s.%s", member_id, prop_str);
514                         MEM_freeN(prop_str);
515                 }
516         }
517         return ret;
518 }
519
520 const char *WM_context_member_from_ptr(bContext *C, const PointerRNA *ptr)
521 {
522         return wm_context_member_from_ptr(C, ptr);
523 }
524
525 char *WM_prop_pystring_assign(bContext *C, PointerRNA *ptr, PropertyRNA *prop, int index)
526 {
527         char *lhs, *rhs, *ret;
528
529         lhs = C ? wm_prop_pystring_from_context(C, ptr, prop, index) : NULL;
530
531         if (lhs == NULL) {
532                 /* fallback to bpy.data.foo[id] if we dont find in the context */
533                 lhs = RNA_path_full_property_py(ptr, prop, index);
534         }
535
536         if (!lhs) {
537                 return NULL;
538         }
539
540         rhs = RNA_property_as_string(C, ptr, prop, index, INT_MAX);
541         if (!rhs) {
542                 MEM_freeN(lhs);
543                 return NULL;
544         }
545
546         ret = BLI_sprintfN("%s = %s", lhs, rhs);
547         MEM_freeN(lhs);
548         MEM_freeN(rhs);
549         return ret;
550 }
551
552 void WM_operator_properties_create_ptr(PointerRNA *ptr, wmOperatorType *ot)
553 {
554         RNA_pointer_create(NULL, ot->srna, NULL, ptr);
555 }
556
557 void WM_operator_properties_create(PointerRNA *ptr, const char *opstring)
558 {
559         wmOperatorType *ot = WM_operatortype_find(opstring, false);
560
561         if (ot)
562                 WM_operator_properties_create_ptr(ptr, ot);
563         else
564                 RNA_pointer_create(NULL, &RNA_OperatorProperties, NULL, ptr);
565 }
566
567 /* similar to the function above except its uses ID properties
568  * used for keymaps and macros */
569 void WM_operator_properties_alloc(PointerRNA **ptr, IDProperty **properties, const char *opstring)
570 {
571         if (*properties == NULL) {
572                 IDPropertyTemplate val = {0};
573                 *properties = IDP_New(IDP_GROUP, &val, "wmOpItemProp");
574         }
575
576         if (*ptr == NULL) {
577                 *ptr = MEM_callocN(sizeof(PointerRNA), "wmOpItemPtr");
578                 WM_operator_properties_create(*ptr, opstring);
579         }
580
581         (*ptr)->data = *properties;
582
583 }
584
585 void WM_operator_properties_sanitize(PointerRNA *ptr, const bool no_context)
586 {
587         RNA_STRUCT_BEGIN (ptr, prop)
588         {
589                 switch (RNA_property_type(prop)) {
590                         case PROP_ENUM:
591                                 if (no_context)
592                                         RNA_def_property_flag(prop, PROP_ENUM_NO_CONTEXT);
593                                 else
594                                         RNA_def_property_clear_flag(prop, PROP_ENUM_NO_CONTEXT);
595                                 break;
596                         case PROP_POINTER:
597                         {
598                                 StructRNA *ptype = RNA_property_pointer_type(ptr, prop);
599
600                                 /* recurse into operator properties */
601                                 if (RNA_struct_is_a(ptype, &RNA_OperatorProperties)) {
602                                         PointerRNA opptr = RNA_property_pointer_get(ptr, prop);
603                                         WM_operator_properties_sanitize(&opptr, no_context);
604                                 }
605                                 break;
606                         }
607                         default:
608                                 break;
609                 }
610         }
611         RNA_STRUCT_END;
612 }
613
614
615 /** set all props to their default,
616  * \param do_update Only update un-initialized props.
617  *
618  * \note, theres nothing specific to operators here.
619  * this could be made a general function.
620  */
621 bool WM_operator_properties_default(PointerRNA *ptr, const bool do_update)
622 {
623         bool changed = false;
624         RNA_STRUCT_BEGIN (ptr, prop)
625         {
626                 switch (RNA_property_type(prop)) {
627                         case PROP_POINTER:
628                         {
629                                 StructRNA *ptype = RNA_property_pointer_type(ptr, prop);
630                                 if (ptype != &RNA_Struct) {
631                                         PointerRNA opptr = RNA_property_pointer_get(ptr, prop);
632                                         changed |= WM_operator_properties_default(&opptr, do_update);
633                                 }
634                                 break;
635                         }
636                         default:
637                                 if ((do_update == false) || (RNA_property_is_set(ptr, prop) == false)) {
638                                         if (RNA_property_reset(ptr, prop, -1)) {
639                                                 changed = true;
640                                         }
641                                 }
642                                 break;
643                 }
644         }
645         RNA_STRUCT_END;
646
647         return changed;
648 }
649
650 /* remove all props without PROP_SKIP_SAVE */
651 void WM_operator_properties_reset(wmOperator *op)
652 {
653         if (op->ptr->data) {
654                 PropertyRNA *iterprop;
655                 iterprop = RNA_struct_iterator_property(op->type->srna);
656
657                 RNA_PROP_BEGIN (op->ptr, itemptr, iterprop)
658                 {
659                         PropertyRNA *prop = itemptr.data;
660
661                         if ((RNA_property_flag(prop) & PROP_SKIP_SAVE) == 0) {
662                                 const char *identifier = RNA_property_identifier(prop);
663                                 RNA_struct_idprops_unset(op->ptr, identifier);
664                         }
665                 }
666                 RNA_PROP_END;
667         }
668 }
669
670 void WM_operator_properties_clear(PointerRNA *ptr)
671 {
672         IDProperty *properties = ptr->data;
673
674         if (properties) {
675                 IDP_ClearProperty(properties);
676         }
677 }
678
679 void WM_operator_properties_free(PointerRNA *ptr)
680 {
681         IDProperty *properties = ptr->data;
682
683         if (properties) {
684                 IDP_FreeProperty(properties);
685                 MEM_freeN(properties);
686                 ptr->data = NULL; /* just in case */
687         }
688 }
689
690 /* ************ default op callbacks, exported *********** */
691
692 void WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op)
693 {
694         if (op->flag & OP_IS_INVOKE) {
695                 Scene *scene = CTX_data_scene(C);
696                 View3D *v3d = CTX_wm_view3d(C);
697
698                 const float dia = v3d ? ED_view3d_grid_scale(scene, v3d, NULL) : ED_scene_grid_scale(scene, NULL);
699
700                 /* always run, so the values are initialized,
701                  * otherwise we may get differ behavior when (dia != 1.0) */
702                 RNA_STRUCT_BEGIN (op->ptr, prop)
703                 {
704                         if (RNA_property_type(prop) == PROP_FLOAT) {
705                                 PropertySubType pstype = RNA_property_subtype(prop);
706                                 if (pstype == PROP_DISTANCE) {
707                                         /* we don't support arrays yet */
708                                         BLI_assert(RNA_property_array_check(prop) == false);
709                                         /* initialize */
710                                         if (!RNA_property_is_set_ex(op->ptr, prop, false)) {
711                                                 const float value = RNA_property_float_get_default(op->ptr, prop) * dia;
712                                                 RNA_property_float_set(op->ptr, prop, value);
713                                         }
714                                 }
715                         }
716                 }
717                 RNA_STRUCT_END;
718         }
719 }
720
721 int WM_operator_smooth_viewtx_get(const wmOperator *op)
722 {
723         return (op->flag & OP_IS_INVOKE) ? U.smooth_viewtx : 0;
724 }
725
726 /* invoke callback, uses enum property named "type" */
727 int WM_menu_invoke_ex(bContext *C, wmOperator *op, int opcontext)
728 {
729         PropertyRNA *prop = op->type->prop;
730         uiPopupMenu *pup;
731         uiLayout *layout;
732
733         if (prop == NULL) {
734                 CLOG_ERROR(WM_LOG_OPERATORS,
735                            "'%s' has no enum property set",
736                            op->type->idname);
737         }
738         else if (RNA_property_type(prop) != PROP_ENUM) {
739                 CLOG_ERROR(WM_LOG_OPERATORS,
740                            "'%s', '%s' is not an enum property",
741                            op->type->idname, RNA_property_identifier(prop));
742         }
743         else if (RNA_property_is_set(op->ptr, prop)) {
744                 const int retval = op->type->exec(C, op);
745                 OPERATOR_RETVAL_CHECK(retval);
746                 return retval;
747         }
748         else {
749                 pup = UI_popup_menu_begin(C, RNA_struct_ui_name(op->type->srna), ICON_NONE);
750                 layout = UI_popup_menu_layout(pup);
751                 /* set this so the default execution context is the same as submenus */
752                 uiLayoutSetOperatorContext(layout, opcontext);
753                 uiItemsFullEnumO(layout, op->type->idname, RNA_property_identifier(prop), op->ptr->data, opcontext, 0);
754                 UI_popup_menu_end(C, pup);
755                 return OPERATOR_INTERFACE;
756         }
757
758         return OPERATOR_CANCELLED;
759 }
760
761 int WM_menu_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
762 {
763         return WM_menu_invoke_ex(C, op, WM_OP_INVOKE_REGION_WIN);
764 }
765
766 struct EnumSearchMenu {
767         wmOperator *op; /* the operator that will be executed when selecting an item */
768
769         bool use_previews;
770         short prv_cols, prv_rows;
771 };
772
773 /* generic enum search invoke popup */
774 static uiBlock *wm_enum_search_menu(bContext *C, ARegion *ar, void *arg)
775 {
776         struct EnumSearchMenu *search_menu = arg;
777         wmWindow *win = CTX_wm_window(C);
778         wmOperator *op = search_menu->op;
779         /* template_ID uses 4 * widget_unit for width, we use a bit more, some items may have a suffix to show */
780         const int width = search_menu->use_previews ? 5 * U.widget_unit * search_menu->prv_cols : UI_searchbox_size_x();
781         const int height = search_menu->use_previews ? 5 * U.widget_unit * search_menu->prv_rows : UI_searchbox_size_y();
782         static char search[256] = "";
783         uiBlock *block;
784         uiBut *but;
785
786         block = UI_block_begin(C, ar, "_popup", UI_EMBOSS);
787         UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_MOVEMOUSE_QUIT | UI_BLOCK_SEARCH_MENU);
788
789         search[0] = '\0';
790         BLI_assert(search_menu->use_previews || (search_menu->prv_cols == 0 && search_menu->prv_rows == 0));
791 #if 0 /* ok, this isn't so easy... */
792         uiDefBut(block, UI_BTYPE_LABEL, 0, RNA_struct_ui_name(op->type->srna), 10, 10, UI_searchbox_size_x(), UI_UNIT_Y, NULL, 0.0, 0.0, 0, 0, "");
793 #endif
794         but = uiDefSearchButO_ptr(block, op->type, op->ptr->data, search, 0, ICON_VIEWZOOM, sizeof(search),
795                                   10, 10, width, UI_UNIT_Y, search_menu->prv_rows, search_menu->prv_cols, "");
796
797         /* fake button, it holds space for search items */
798         uiDefBut(block, UI_BTYPE_LABEL, 0, "", 10, 10 - UI_searchbox_size_y(), width, height, NULL, 0, 0, 0, 0, NULL);
799
800         UI_block_bounds_set_popup(block, 6, 0, -UI_UNIT_Y); /* move it downwards, mouse over button */
801         UI_but_focus_on_enter_event(win, but);
802
803         return block;
804 }
805
806 /**
807  * Similar to #WM_enum_search_invoke, but draws previews. Also, this can't
808  * be used as invoke callback directly since it needs additional info.
809  */
810 int WM_enum_search_invoke_previews(
811         bContext *C, wmOperator *op, short prv_cols, short prv_rows)
812 {
813         static struct EnumSearchMenu search_menu;
814
815         search_menu.op = op;
816         search_menu.use_previews = true;
817         search_menu.prv_cols = prv_cols;
818         search_menu.prv_rows = prv_rows;
819
820         UI_popup_block_invoke(C, wm_enum_search_menu, &search_menu);
821
822         return OPERATOR_INTERFACE;
823 }
824
825 int WM_enum_search_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
826 {
827         static struct EnumSearchMenu search_menu;
828         search_menu.op = op;
829         UI_popup_block_invoke(C, wm_enum_search_menu, &search_menu);
830         return OPERATOR_INTERFACE;
831 }
832
833 /* Can't be used as an invoke directly, needs message arg (can be NULL) */
834 int WM_operator_confirm_message_ex(bContext *C, wmOperator *op,
835                                    const char *title, const int icon,
836                                    const char *message)
837 {
838         uiPopupMenu *pup;
839         uiLayout *layout;
840         IDProperty *properties = op->ptr->data;
841
842         if (properties && properties->len)
843                 properties = IDP_CopyProperty(op->ptr->data);
844         else
845                 properties = NULL;
846
847         pup = UI_popup_menu_begin(C, title, icon);
848         layout = UI_popup_menu_layout(pup);
849         uiItemFullO_ptr(layout, op->type, message, ICON_NONE, properties, WM_OP_EXEC_REGION_WIN, 0, NULL);
850         UI_popup_menu_end(C, pup);
851
852         return OPERATOR_INTERFACE;
853 }
854
855 int WM_operator_confirm_message(bContext *C, wmOperator *op, const char *message)
856 {
857         return WM_operator_confirm_message_ex(C, op, IFACE_("OK?"), ICON_QUESTION, message);
858 }
859
860 int WM_operator_confirm(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
861 {
862         return WM_operator_confirm_message(C, op, NULL);
863 }
864
865 /* op->invoke, opens fileselect if path property not set, otherwise executes */
866 int WM_operator_filesel(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
867 {
868         if (RNA_struct_property_is_set(op->ptr, "filepath")) {
869                 return WM_operator_call_notest(C, op); /* call exec direct */
870         }
871         else {
872                 WM_event_add_fileselect(C, op);
873                 return OPERATOR_RUNNING_MODAL;
874         }
875 }
876
877 bool WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format)
878 {
879         PropertyRNA *prop;
880         char filepath[FILE_MAX];
881         /* dont NULL check prop, this can only run on ops with a 'filepath' */
882         prop = RNA_struct_find_property(op->ptr, "filepath");
883         RNA_property_string_get(op->ptr, prop, filepath);
884         if (BKE_image_path_ensure_ext_from_imformat(filepath, im_format)) {
885                 RNA_property_string_set(op->ptr, prop, filepath);
886                 /* note, we could check for and update 'filename' here,
887                  * but so far nothing needs this. */
888                 return true;
889         }
890         return false;
891 }
892
893 /* op->poll */
894 bool WM_operator_winactive(bContext *C)
895 {
896         if (CTX_wm_window(C) == NULL) return 0;
897         return 1;
898 }
899
900 /* return false, if the UI should be disabled */
901 bool WM_operator_check_ui_enabled(const bContext *C, const char *idname)
902 {
903         wmWindowManager *wm = CTX_wm_manager(C);
904         Scene *scene = CTX_data_scene(C);
905
906         return !((ED_undo_is_valid(C, idname) == false) || WM_jobs_test(wm, scene, WM_JOB_TYPE_ANY));
907 }
908
909 wmOperator *WM_operator_last_redo(const bContext *C)
910 {
911         wmWindowManager *wm = CTX_wm_manager(C);
912         wmOperator *op;
913
914         /* only for operators that are registered and did an undo push */
915         for (op = wm->operators.last; op; op = op->prev)
916                 if ((op->type->flag & OPTYPE_REGISTER) && (op->type->flag & OPTYPE_UNDO))
917                         break;
918
919         return op;
920 }
921
922 IDProperty *WM_operator_last_properties_ensure_idprops(wmOperatorType *ot)
923 {
924         if (ot->last_properties == NULL) {
925                 IDPropertyTemplate val = {0};
926                 ot->last_properties = IDP_New(IDP_GROUP, &val, "wmOperatorProperties");
927         }
928         return ot->last_properties;
929 }
930
931 void WM_operator_last_properties_ensure(wmOperatorType *ot, PointerRNA *ptr)
932 {
933         IDProperty *props = WM_operator_last_properties_ensure_idprops(ot);
934         RNA_pointer_create(NULL, ot->srna, props, ptr);
935 }
936
937 /**
938  * Use for drag & drop a path or name with operators invoke() function.
939  */
940 ID *WM_operator_drop_load_path(struct bContext *C, wmOperator *op, const short idcode)
941 {
942         Main *bmain = CTX_data_main(C);
943         ID *id = NULL;
944         /* check input variables */
945         if (RNA_struct_property_is_set(op->ptr, "filepath")) {
946                 const bool is_relative_path = RNA_boolean_get(op->ptr, "relative_path");
947                 char path[FILE_MAX];
948                 bool exists = false;
949
950                 RNA_string_get(op->ptr, "filepath", path);
951
952                 errno = 0;
953
954                 if (idcode == ID_IM) {
955                         id = (ID *)BKE_image_load_exists_ex(bmain, path, &exists);
956                 }
957                 else {
958                         BLI_assert(0);
959                 }
960
961                 if (!id) {
962                         BKE_reportf(op->reports, RPT_ERROR, "Cannot read %s '%s': %s",
963                                     BKE_idcode_to_name(idcode), path,
964                                     errno ? strerror(errno) : TIP_("unsupported format"));
965                         return NULL;
966                 }
967
968                 if (is_relative_path ) {
969                         if (exists == false) {
970                                 if (idcode == ID_IM) {
971                                         BLI_path_rel(((Image *)id)->name, BKE_main_blendfile_path(bmain));
972                                 }
973                                 else {
974                                         BLI_assert(0);
975                                 }
976                         }
977                 }
978         }
979         else if (RNA_struct_property_is_set(op->ptr, "name")) {
980                 char name[MAX_ID_NAME - 2];
981                 RNA_string_get(op->ptr, "name", name);
982                 id = BKE_libblock_find_name(bmain, idcode, name);
983                 if (!id) {
984                         BKE_reportf(op->reports, RPT_ERROR, "%s '%s' not found",
985                                     BKE_idcode_to_name(idcode), name);
986                         return NULL;
987                 }
988                 id_us_plus(id);
989         }
990
991         return id;
992 }
993
994 static void wm_block_redo_cb(bContext *C, void *arg_op, int UNUSED(arg_event))
995 {
996         wmOperator *op = arg_op;
997
998         if (op == WM_operator_last_redo(C)) {
999                 /* operator was already executed once? undo & repeat */
1000                 ED_undo_operator_repeat(C, op);
1001         }
1002         else {
1003                 /* operator not executed yet, call it */
1004                 ED_undo_push_op(C, op);
1005                 wm_operator_register(C, op);
1006
1007                 WM_operator_repeat(C, op);
1008         }
1009 }
1010
1011 static void wm_block_redo_cancel_cb(bContext *C, void *arg_op)
1012 {
1013         wmOperator *op = arg_op;
1014
1015         /* if operator never got executed, free it */
1016         if (op != WM_operator_last_redo(C))
1017                 WM_operator_free(op);
1018 }
1019
1020 static uiBlock *wm_block_create_redo(bContext *C, ARegion *ar, void *arg_op)
1021 {
1022         wmOperator *op = arg_op;
1023         uiBlock *block;
1024         uiLayout *layout;
1025         uiStyle *style = UI_style_get();
1026         int width = 15 * UI_UNIT_X;
1027
1028         block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
1029         UI_block_flag_disable(block, UI_BLOCK_LOOP);
1030         /* UI_BLOCK_NUMSELECT for layer buttons */
1031         UI_block_flag_enable(block, UI_BLOCK_NUMSELECT | UI_BLOCK_KEEP_OPEN | UI_BLOCK_MOVEMOUSE_QUIT);
1032
1033         /* if register is not enabled, the operator gets freed on OPERATOR_FINISHED
1034          * ui_apply_but_funcs_after calls ED_undo_operator_repeate_cb and crashes */
1035         assert(op->type->flag & OPTYPE_REGISTER);
1036
1037         UI_block_func_handle_set(block, wm_block_redo_cb, arg_op);
1038         layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, width, UI_UNIT_Y, 0, style);
1039
1040         if (op == WM_operator_last_redo(C))
1041                 if (!WM_operator_check_ui_enabled(C, op->type->name))
1042                         uiLayoutSetEnabled(layout, false);
1043
1044         if (op->type->flag & OPTYPE_MACRO) {
1045                 for (op = op->macro.first; op; op = op->next) {
1046                         uiTemplateOperatorPropertyButs(
1047                                 C, layout, op, UI_BUT_LABEL_ALIGN_SPLIT_COLUMN,
1048                                 UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
1049                         if (op->next)
1050                                 uiItemS(layout);
1051                 }
1052         }
1053         else {
1054                 uiTemplateOperatorPropertyButs(
1055                         C, layout, op, UI_BUT_LABEL_ALIGN_SPLIT_COLUMN,
1056                         UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
1057         }
1058
1059         UI_block_bounds_set_popup(block, 4, 0, 0);
1060
1061         return block;
1062 }
1063
1064 typedef struct wmOpPopUp {
1065         wmOperator *op;
1066         int width;
1067         int height;
1068         int free_op;
1069 } wmOpPopUp;
1070
1071 /* Only invoked by OK button in popups created with wm_block_dialog_create() */
1072 static void dialog_exec_cb(bContext *C, void *arg1, void *arg2)
1073 {
1074         wmOpPopUp *data = arg1;
1075         uiBlock *block = arg2;
1076
1077         /* Explicitly set UI_RETURN_OK flag, otherwise the menu might be canceled
1078          * in case WM_operator_call_ex exits/reloads the current file (T49199). */
1079         UI_popup_menu_retval_set(block, UI_RETURN_OK, true);
1080
1081         WM_operator_call_ex(C, data->op, true);
1082
1083         /* let execute handle freeing it */
1084         //data->free_op = false;
1085         //data->op = NULL;
1086
1087         /* in this case, wm_operator_ui_popup_cancel wont run */
1088         MEM_freeN(data);
1089
1090         /* get context data *after* WM_operator_call_ex which might have closed the current file and changed context */
1091         wmWindowManager *wm = CTX_wm_manager(C);
1092         wmWindow *win = CTX_wm_window(C);
1093
1094         /* check window before 'block->handle' incase the
1095          * popup execution closed the window and freed the block. see T44688.
1096          */
1097         /* Post 2.78 TODO: Check if this fix and others related to T44688 are still
1098          * needed or can be improved now that requesting context data has been corrected
1099          * (see above). We're close to release so not a good time for experiments.
1100          * -- Julian
1101          */
1102         if (BLI_findindex(&wm->windows, win) != -1) {
1103                 UI_popup_block_close(C, win, block);
1104         }
1105 }
1106
1107 /* Dialogs are popups that require user verification (click OK) before exec */
1108 static uiBlock *wm_block_dialog_create(bContext *C, ARegion *ar, void *userData)
1109 {
1110         wmOpPopUp *data = userData;
1111         wmOperator *op = data->op;
1112         uiBlock *block;
1113         uiLayout *layout;
1114         uiStyle *style = UI_style_get();
1115
1116         block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
1117         UI_block_flag_disable(block, UI_BLOCK_LOOP);
1118
1119         /* intentionally don't use 'UI_BLOCK_MOVEMOUSE_QUIT', some dialogues have many items
1120          * where quitting by accident is very annoying */
1121         UI_block_flag_enable(block, UI_BLOCK_KEEP_OPEN | UI_BLOCK_NUMSELECT);
1122
1123         layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, data->width, data->height, 0, style);
1124
1125         uiTemplateOperatorPropertyButs(
1126                 C, layout, op, UI_BUT_LABEL_ALIGN_SPLIT_COLUMN,
1127                 UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
1128
1129         /* clear so the OK button is left alone */
1130         UI_block_func_set(block, NULL, NULL, NULL);
1131
1132         /* new column so as not to interfere with custom layouts [#26436] */
1133         {
1134                 uiBlock *col_block;
1135                 uiLayout *col;
1136                 uiBut *btn;
1137
1138                 col = uiLayoutColumn(layout, false);
1139                 col_block = uiLayoutGetBlock(col);
1140                 /* Create OK button, the callback of which will execute op */
1141                 btn = uiDefBut(col_block, UI_BTYPE_BUT, 0, IFACE_("OK"), 0, -30, 0, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
1142                 UI_but_func_set(btn, dialog_exec_cb, data, col_block);
1143         }
1144
1145         /* center around the mouse */
1146         UI_block_bounds_set_popup(block, 4, data->width / -2, data->height / 2);
1147
1148         return block;
1149 }
1150
1151 static uiBlock *wm_operator_ui_create(bContext *C, ARegion *ar, void *userData)
1152 {
1153         wmOpPopUp *data = userData;
1154         wmOperator *op = data->op;
1155         uiBlock *block;
1156         uiLayout *layout;
1157         uiStyle *style = UI_style_get();
1158
1159         block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
1160         UI_block_flag_disable(block, UI_BLOCK_LOOP);
1161         UI_block_flag_enable(block, UI_BLOCK_KEEP_OPEN | UI_BLOCK_MOVEMOUSE_QUIT);
1162
1163         layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, data->width, data->height, 0, style);
1164
1165         /* since ui is defined the auto-layout args are not used */
1166         uiTemplateOperatorPropertyButs(C, layout, op, UI_BUT_LABEL_ALIGN_COLUMN, 0);
1167
1168         UI_block_func_set(block, NULL, NULL, NULL);
1169
1170         UI_block_bounds_set_popup(block, 4, 0, 0);
1171
1172         return block;
1173 }
1174
1175 static void wm_operator_ui_popup_cancel(struct bContext *C, void *userData)
1176 {
1177         wmOpPopUp *data = userData;
1178         wmOperator *op = data->op;
1179
1180         if (op) {
1181                 if (op->type->cancel) {
1182                         op->type->cancel(C, op);
1183                 }
1184
1185                 if (data->free_op) {
1186                         WM_operator_free(op);
1187                 }
1188         }
1189
1190         MEM_freeN(data);
1191 }
1192
1193 static void wm_operator_ui_popup_ok(struct bContext *C, void *arg, int retval)
1194 {
1195         wmOpPopUp *data = arg;
1196         wmOperator *op = data->op;
1197
1198         if (op && retval > 0)
1199                 WM_operator_call_ex(C, op, true);
1200
1201         MEM_freeN(data);
1202 }
1203
1204 int WM_operator_ui_popup(bContext *C, wmOperator *op, int width, int height)
1205 {
1206         wmOpPopUp *data = MEM_callocN(sizeof(wmOpPopUp), "WM_operator_ui_popup");
1207         data->op = op;
1208         data->width = width;
1209         data->height = height;
1210         data->free_op = true; /* if this runs and gets registered we may want not to free it */
1211         UI_popup_block_ex(C, wm_operator_ui_create, NULL, wm_operator_ui_popup_cancel, data, op);
1212         return OPERATOR_RUNNING_MODAL;
1213 }
1214
1215 /**
1216  * For use by #WM_operator_props_popup_call, #WM_operator_props_popup only.
1217  *
1218  * \note operator menu needs undo flag enabled, for redo callback */
1219 static int wm_operator_props_popup_ex(bContext *C, wmOperator *op,
1220                                       const bool do_call, const bool do_redo)
1221 {
1222         if ((op->type->flag & OPTYPE_REGISTER) == 0) {
1223                 BKE_reportf(op->reports, RPT_ERROR,
1224                             "Operator '%s' does not have register enabled, incorrect invoke function", op->type->idname);
1225                 return OPERATOR_CANCELLED;
1226         }
1227
1228         if (do_redo) {
1229                 if ((op->type->flag & OPTYPE_UNDO) == 0) {
1230                         BKE_reportf(op->reports, RPT_ERROR,
1231                                     "Operator '%s' does not have undo enabled, incorrect invoke function", op->type->idname);
1232                         return OPERATOR_CANCELLED;
1233                 }
1234         }
1235
1236         /* if we don't have global undo, we can't do undo push for automatic redo,
1237          * so we require manual OK clicking in this popup */
1238         if (!do_redo || !(U.uiflag & USER_GLOBALUNDO))
1239                 return WM_operator_props_dialog_popup(C, op, 15 * UI_UNIT_X, UI_UNIT_Y);
1240
1241         UI_popup_block_ex(C, wm_block_create_redo, NULL, wm_block_redo_cancel_cb, op, op);
1242
1243         if (do_call)
1244                 wm_block_redo_cb(C, op, 0);
1245
1246         return OPERATOR_RUNNING_MODAL;
1247 }
1248
1249 /**
1250  * Same as #WM_operator_props_popup but don't use operator redo.
1251  * just wraps #WM_operator_props_dialog_popup.
1252  */
1253 int WM_operator_props_popup_confirm(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1254 {
1255         return wm_operator_props_popup_ex(C, op, false, false);
1256 }
1257
1258 /**
1259  * Same as #WM_operator_props_popup but call the operator first,
1260  * This way - the button values correspond to the result of the operator.
1261  * Without this, first access to a button will make the result jump, see T32452.
1262  */
1263 int WM_operator_props_popup_call(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1264 {
1265         return wm_operator_props_popup_ex(C, op, true, true);
1266 }
1267
1268 int WM_operator_props_popup(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1269 {
1270         return wm_operator_props_popup_ex(C, op, false, true);
1271 }
1272
1273 int WM_operator_props_dialog_popup(bContext *C, wmOperator *op, int width, int height)
1274 {
1275         wmOpPopUp *data = MEM_callocN(sizeof(wmOpPopUp), "WM_operator_props_dialog_popup");
1276
1277         data->op = op;
1278         data->width = width;
1279         data->height = height;
1280         data->free_op = true; /* if this runs and gets registered we may want not to free it */
1281
1282         /* op is not executed until popup OK but is clicked */
1283         UI_popup_block_ex(C, wm_block_dialog_create, wm_operator_ui_popup_ok, wm_operator_ui_popup_cancel, data, op);
1284
1285         return OPERATOR_RUNNING_MODAL;
1286 }
1287
1288 int WM_operator_redo_popup(bContext *C, wmOperator *op)
1289 {
1290         /* CTX_wm_reports(C) because operator is on stack, not active in event system */
1291         if ((op->type->flag & OPTYPE_REGISTER) == 0) {
1292                 BKE_reportf(CTX_wm_reports(C), RPT_ERROR,
1293                             "Operator redo '%s' does not have register enabled, incorrect invoke function", op->type->idname);
1294                 return OPERATOR_CANCELLED;
1295         }
1296         if (op->type->poll && op->type->poll(C) == 0) {
1297                 BKE_reportf(CTX_wm_reports(C), RPT_ERROR, "Operator redo '%s': wrong context", op->type->idname);
1298                 return OPERATOR_CANCELLED;
1299         }
1300
1301         UI_popup_block_invoke(C, wm_block_create_redo, op);
1302
1303         return OPERATOR_CANCELLED;
1304 }
1305
1306 /* ***************** Debug menu ************************* */
1307
1308 static int wm_debug_menu_exec(bContext *C, wmOperator *op)
1309 {
1310         G.debug_value = RNA_int_get(op->ptr, "debug_value");
1311         ED_screen_refresh(CTX_wm_manager(C), CTX_wm_window(C));
1312         WM_event_add_notifier(C, NC_WINDOW, NULL);
1313
1314         return OPERATOR_FINISHED;
1315 }
1316
1317 static int wm_debug_menu_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1318 {
1319         RNA_int_set(op->ptr, "debug_value", G.debug_value);
1320         return WM_operator_props_dialog_popup(C, op, 9 * UI_UNIT_X, UI_UNIT_Y);
1321 }
1322
1323 static void WM_OT_debug_menu(wmOperatorType *ot)
1324 {
1325         ot->name = "Debug Menu";
1326         ot->idname = "WM_OT_debug_menu";
1327         ot->description = "Open a popup to set the debug level";
1328
1329         ot->invoke = wm_debug_menu_invoke;
1330         ot->exec = wm_debug_menu_exec;
1331         ot->poll = WM_operator_winactive;
1332
1333         RNA_def_int(ot->srna, "debug_value", 0, SHRT_MIN, SHRT_MAX, "Debug Value", "", -10000, 10000);
1334 }
1335
1336 /* ***************** Operator defaults ************************* */
1337 static int wm_operator_defaults_exec(bContext *C, wmOperator *op)
1338 {
1339         PointerRNA ptr = CTX_data_pointer_get_type(C, "active_operator", &RNA_Operator);
1340
1341         if (!ptr.data) {
1342                 BKE_report(op->reports, RPT_ERROR, "No operator in context");
1343                 return OPERATOR_CANCELLED;
1344         }
1345
1346         WM_operator_properties_reset((wmOperator *)ptr.data);
1347         return OPERATOR_FINISHED;
1348 }
1349
1350 /* used by operator preset menu. pre-2.65 this was a 'Reset' button */
1351 static void WM_OT_operator_defaults(wmOperatorType *ot)
1352 {
1353         ot->name = "Restore Defaults";
1354         ot->idname = "WM_OT_operator_defaults";
1355         ot->description = "Set the active operator to its default values";
1356
1357         ot->exec = wm_operator_defaults_exec;
1358
1359         ot->flag = OPTYPE_INTERNAL;
1360 }
1361
1362 /* ***************** Splash Screen ************************* */
1363
1364 static void wm_block_splash_close(bContext *C, void *arg_block, void *UNUSED(arg))
1365 {
1366         wmWindow *win = CTX_wm_window(C);
1367         UI_popup_block_close(C, win, arg_block);
1368 }
1369
1370 static uiBlock *wm_block_create_splash(bContext *C, ARegion *ar, void *arg_unused);
1371
1372 static void wm_block_splash_refreshmenu(bContext *C, void *UNUSED(arg_block), void *UNUSED(arg))
1373 {
1374         ARegion *ar_menu = CTX_wm_menu(C);
1375         ED_region_tag_refresh_ui(ar_menu);
1376 }
1377
1378 static int wm_resource_check_prev(void)
1379 {
1380
1381         const char *res = BKE_appdir_folder_id_version(BLENDER_RESOURCE_PATH_USER, BLENDER_VERSION, true);
1382
1383         // if (res) printf("USER: %s\n", res);
1384
1385 #if 0 /* ignore the local folder */
1386         if (res == NULL) {
1387                 /* with a local dir, copying old files isn't useful since local dir get priority for config */
1388                 res = BKE_appdir_folder_id_version(BLENDER_RESOURCE_PATH_LOCAL, BLENDER_VERSION, true);
1389         }
1390 #endif
1391
1392         // if (res) printf("LOCAL: %s\n", res);
1393         if (res) {
1394                 return false;
1395         }
1396         else {
1397                 return (BKE_appdir_folder_id_version(BLENDER_RESOURCE_PATH_USER, BLENDER_VERSION - 1, true) != NULL);
1398         }
1399 }
1400
1401 static uiBlock *wm_block_create_splash(bContext *C, ARegion *ar, void *UNUSED(arg))
1402 {
1403         uiBlock *block;
1404         uiBut *but;
1405         uiLayout *layout, *split, *col;
1406         uiStyle *style = UI_style_get();
1407         const struct RecentFile *recent;
1408         int i;
1409         MenuType *mt = WM_menutype_find("USERPREF_MT_splash", true);
1410         char url[96];
1411         const char *version_suffix = NULL;
1412
1413 #ifndef WITH_HEADLESS
1414         extern char datatoc_splash_png[];
1415         extern int datatoc_splash_png_size;
1416
1417         extern char datatoc_splash_2x_png[];
1418         extern int datatoc_splash_2x_png_size;
1419         ImBuf *ibuf;
1420 #else
1421         ImBuf *ibuf = NULL;
1422 #endif
1423
1424 #ifdef WITH_BUILDINFO
1425         int label_delta = 0;
1426         int hash_width, date_width;
1427         char date_buf[128] = "\0";
1428         char hash_buf[128] = "\0";
1429         extern unsigned long build_commit_timestamp;
1430         extern char build_hash[], build_commit_date[], build_commit_time[], build_branch[];
1431
1432         /* Builds made from tag only shows tag sha */
1433         BLI_snprintf(hash_buf, sizeof(hash_buf), "Hash: %s", build_hash);
1434         BLI_snprintf(date_buf, sizeof(date_buf), "Date: %s %s", build_commit_date, build_commit_time);
1435
1436         BLF_size(style->widgetlabel.uifont_id, style->widgetlabel.points, U.pixelsize * U.dpi);
1437         hash_width = (int)BLF_width(style->widgetlabel.uifont_id, hash_buf, sizeof(hash_buf)) + U.widget_unit;
1438         date_width = (int)BLF_width(style->widgetlabel.uifont_id, date_buf, sizeof(date_buf)) + U.widget_unit;
1439 #endif  /* WITH_BUILDINFO */
1440
1441 #ifndef WITH_HEADLESS
1442         if (U.pixelsize == 2) {
1443                 ibuf = IMB_ibImageFromMemory((unsigned char *)datatoc_splash_2x_png,
1444                                              datatoc_splash_2x_png_size, IB_rect, NULL, "<splash screen>");
1445         }
1446         else {
1447                 ibuf = IMB_ibImageFromMemory((unsigned char *)datatoc_splash_png,
1448                                              datatoc_splash_png_size, IB_rect, NULL, "<splash screen>");
1449         }
1450
1451         /* overwrite splash with template image */
1452         if (U.app_template[0] != '\0') {
1453                 ImBuf *ibuf_template = NULL;
1454                 char splash_filepath[FILE_MAX];
1455                 char template_directory[FILE_MAX];
1456
1457                 if (BKE_appdir_app_template_id_search(
1458                         U.app_template,
1459                         template_directory, sizeof(template_directory)))
1460                 {
1461                         BLI_join_dirfile(
1462                                 splash_filepath, sizeof(splash_filepath), template_directory,
1463                                 (U.pixelsize == 2) ? "splash_2x.png" : "splash.png");
1464                         ibuf_template = IMB_loadiffname(splash_filepath, IB_rect, NULL);
1465                         if (ibuf_template) {
1466                                 const int x_expect = ibuf->x;
1467                                 const int y_expect = 282 * (int)U.pixelsize;
1468                                 /* don't cover the header text */
1469                                 if (ibuf_template->x == x_expect && ibuf_template->y == y_expect) {
1470                                         memcpy(ibuf->rect, ibuf_template->rect, ibuf_template->x * ibuf_template->y * sizeof(char[4]));
1471                                 }
1472                                 else {
1473                                         CLOG_ERROR(WM_LOG_OPERATORS,
1474                                                    "Splash expected %dx%d found %dx%d, ignoring: %s\n",
1475                                                    x_expect, y_expect, ibuf_template->x, ibuf_template->y, splash_filepath);
1476                                 }
1477                                 IMB_freeImBuf(ibuf_template);
1478                         }
1479                 }
1480         }
1481 #endif
1482
1483         block = UI_block_begin(C, ar, "_popup", UI_EMBOSS);
1484
1485         /* note on UI_BLOCK_NO_WIN_CLIP, the window size is not always synchronized
1486          * with the OS when the splash shows, window clipping in this case gives
1487          * ugly results and clipping the splash isn't useful anyway, just disable it [#32938] */
1488         UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_KEEP_OPEN | UI_BLOCK_NO_WIN_CLIP);
1489
1490         /* XXX splash scales with pixelsize, should become widget-units */
1491         but = uiDefBut(block, UI_BTYPE_IMAGE, 0, "", 0, 0.5f * U.widget_unit, U.pixelsize * 501, U.pixelsize * 282, ibuf, 0.0, 0.0, 0, 0, ""); /* button owns the imbuf now */
1492         UI_but_func_set(but, wm_block_splash_close, block, NULL);
1493         UI_block_func_set(block, wm_block_splash_refreshmenu, block, NULL);
1494
1495         /* label for 'a' bugfix releases, or 'Release Candidate 1'...
1496          * avoids recreating splash for version updates */
1497         if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "alpha")) {
1498                 version_suffix = "Alpha 2";
1499         }
1500         else if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "beta")) {
1501                 version_suffix = "Beta";
1502         }
1503         else if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "rc")) {
1504                 version_suffix = "Release Candidate";
1505         }
1506         else if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "release")) {
1507                 version_suffix = STRINGIFY(BLENDER_VERSION_CHAR);
1508         }
1509         if (version_suffix != NULL && version_suffix[0]) {
1510                 /* placed after the version number in the image,
1511                  * placing y is tricky to match baseline */
1512                 int x = 236 * U.pixelsize - (2 * UI_DPI_FAC);
1513                 int y = 231 * U.pixelsize + (4 * UI_DPI_FAC);
1514                 int w = 240 * U.pixelsize;
1515
1516                 /* hack to have text draw 'text_sel' */
1517                 UI_block_emboss_set(block, UI_EMBOSS_NONE);
1518                 but = uiDefBut(block, UI_BTYPE_LABEL, 0, version_suffix, x, y, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, NULL);
1519                 /* XXX, set internal flag - UI_SELECT */
1520                 UI_but_flag_enable(but, 1);
1521                 UI_block_emboss_set(block, UI_EMBOSS);
1522         }
1523
1524 #ifdef WITH_BUILDINFO
1525         if (build_commit_timestamp != 0) {
1526                 but = uiDefBut(
1527                           block, UI_BTYPE_LABEL, 0, date_buf,
1528                           U.pixelsize * 502 - date_width, U.pixelsize * 267,
1529                           date_width, UI_UNIT_Y, NULL, 0, 0, 0, 0, NULL);
1530                 /* XXX, set internal flag - UI_SELECT */
1531                 UI_but_flag_enable(but, 1);
1532                 label_delta = 12;
1533         }
1534         but = uiDefBut(
1535                   block, UI_BTYPE_LABEL, 0, hash_buf,
1536                   U.pixelsize * 502 - hash_width, U.pixelsize * (267 - label_delta),
1537                   hash_width, UI_UNIT_Y, NULL, 0, 0, 0, 0, NULL);
1538         /* XXX, set internal flag - UI_SELECT */
1539         UI_but_flag_enable(but, 1);
1540
1541         if (!STREQ(build_branch, "master")) {
1542                 char branch_buf[128] = "\0";
1543                 int branch_width;
1544                 BLI_snprintf(branch_buf, sizeof(branch_buf), "Branch: %s", build_branch);
1545                 branch_width = (int)BLF_width(style->widgetlabel.uifont_id, branch_buf, sizeof(branch_buf)) + U.widget_unit;
1546                 but = uiDefBut(
1547                           block, UI_BTYPE_LABEL, 0, branch_buf,
1548                           U.pixelsize * 502 - branch_width, U.pixelsize * (255 - label_delta),
1549                           branch_width, UI_UNIT_Y, NULL, 0, 0, 0, 0, NULL);
1550                 /* XXX, set internal flag - UI_SELECT */
1551                 UI_but_flag_enable(but, 1);
1552         }
1553 #endif  /* WITH_BUILDINFO */
1554
1555         layout = UI_block_layout(block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 10, 2, U.pixelsize * 480, U.pixelsize * 110, 0, style);
1556
1557         UI_block_emboss_set(block, UI_EMBOSS);
1558         /* show the splash menu (containing interaction presets), using python */
1559         if (mt) {
1560                 UI_menutype_draw(C, mt, layout);
1561
1562 //              uiItemM(layout, "USERPREF_MT_keyconfigs", U.keyconfigstr, ICON_NONE);
1563         }
1564
1565         UI_block_emboss_set(block, UI_EMBOSS_PULLDOWN);
1566         uiLayoutSetOperatorContext(layout, WM_OP_EXEC_REGION_WIN);
1567
1568         split = uiLayoutSplit(layout, 0.0f, false);
1569         col = uiLayoutColumn(split, false);
1570         uiItemL(col, IFACE_("Links"), ICON_NONE);
1571         uiItemStringO(col, IFACE_("Join the Development Fund"), ICON_URL, "WM_OT_url_open", "url",
1572                       "https://www.blender.org/foundation/development-fund/");
1573         uiItemStringO(col, IFACE_("Donate"), ICON_URL, "WM_OT_url_open", "url",
1574                       "https://www.blender.org/foundation/donation-payment/");
1575         uiItemS(col);
1576         uiItemStringO(col, IFACE_("Manual"), ICON_URL, "WM_OT_url_open", "url",
1577                       "https://docs.blender.org/manual/en/dev/");
1578         BLI_snprintf(url, sizeof(url), "https://wiki.blender.org/wiki/Reference/Release_Notes/%d.%d",
1579                      BLENDER_VERSION / 100, BLENDER_VERSION % 100);
1580         uiItemStringO(col, IFACE_("Release Notes"), ICON_URL, "WM_OT_url_open", "url", url);
1581         uiItemStringO(col, IFACE_("Blender Website"), ICON_URL, "WM_OT_url_open", "url", "https://www.blender.org");
1582         uiItemStringO(col, IFACE_("Credits"), ICON_URL, "WM_OT_url_open", "url",
1583                       "https://www.blender.org/about/credits/");
1584         uiItemL(col, "", ICON_NONE);
1585
1586         col = uiLayoutColumn(split, false);
1587
1588         if (wm_resource_check_prev()) {
1589                 uiItemO(col, NULL, ICON_NEW, "WM_OT_copy_prev_settings");
1590                 uiItemS(col);
1591         }
1592
1593         uiItemL(col, IFACE_("Recent"), ICON_NONE);
1594         for (recent = G.recent_files.first, i = 0; (i < 5) && (recent); recent = recent->next, i++) {
1595                 const char *filename = BLI_path_basename(recent->filepath);
1596                 uiItemStringO(col, filename,
1597                               BLO_has_bfile_extension(filename) ? ICON_FILE_BLEND : ICON_FILE_BACKUP,
1598                               "WM_OT_open_mainfile", "filepath", recent->filepath);
1599         }
1600
1601         uiItemS(col);
1602         uiItemO(col, NULL, ICON_RECOVER_LAST, "WM_OT_recover_last_session");
1603         uiItemL(col, "", ICON_NONE);
1604
1605         mt = WM_menutype_find("USERPREF_MT_splash_footer", false);
1606         if (mt) {
1607                 UI_menutype_draw(C, mt, uiLayoutColumn(layout, false));
1608         }
1609
1610         UI_block_bounds_set_centered(block, 0);
1611
1612         return block;
1613 }
1614
1615 static int wm_splash_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *UNUSED(event))
1616 {
1617         UI_popup_block_invoke(C, wm_block_create_splash, NULL);
1618
1619         return OPERATOR_FINISHED;
1620 }
1621
1622 static void WM_OT_splash(wmOperatorType *ot)
1623 {
1624         ot->name = "Splash Screen";
1625         ot->idname = "WM_OT_splash";
1626         ot->description = "Open the splash screen with release info";
1627
1628         ot->invoke = wm_splash_invoke;
1629         ot->poll = WM_operator_winactive;
1630 }
1631
1632
1633 /* ***************** Search menu ************************* */
1634
1635 struct SearchPopupInit_Data {
1636         int size[2];
1637 };
1638
1639 static uiBlock *wm_block_search_menu(bContext *C, ARegion *ar, void *userdata)
1640 {
1641         const struct SearchPopupInit_Data *init_data = userdata;
1642         static char search[256] = "";
1643         wmEvent event;
1644         wmWindow *win = CTX_wm_window(C);
1645         uiBlock *block;
1646         uiBut *but;
1647
1648         block = UI_block_begin(C, ar, "_popup", UI_EMBOSS);
1649         UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_MOVEMOUSE_QUIT | UI_BLOCK_SEARCH_MENU);
1650
1651         but = uiDefSearchBut(block, search, 0, ICON_VIEWZOOM, sizeof(search), 10, 10, init_data->size[0], UI_UNIT_Y, 0, 0, "");
1652         UI_but_func_operator_search(but);
1653
1654         /* fake button, it holds space for search items */
1655         uiDefBut(block, UI_BTYPE_LABEL, 0, "", 10, 10 - init_data->size[1],
1656                  init_data->size[0], init_data->size[1], NULL, 0, 0, 0, 0, NULL);
1657
1658         UI_block_bounds_set_popup(block, 6, 0, -UI_UNIT_Y); /* move it downwards, mouse over button */
1659
1660         wm_event_init_from_window(win, &event);
1661         event.type = EVT_BUT_OPEN;
1662         event.val = KM_PRESS;
1663         event.customdata = but;
1664         event.customdatafree = false;
1665         wm_event_add(win, &event);
1666
1667         return block;
1668 }
1669
1670 static int wm_search_menu_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
1671 {
1672         return OPERATOR_FINISHED;
1673 }
1674
1675 static int wm_search_menu_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *UNUSED(event))
1676 {
1677         struct SearchPopupInit_Data data = {
1678                 .size = {
1679                     UI_searchbox_size_x() * 2,
1680                     UI_searchbox_size_y(),
1681                 },
1682         };
1683
1684         UI_popup_block_invoke(C, wm_block_search_menu, &data);
1685
1686         return OPERATOR_INTERFACE;
1687 }
1688
1689 /* op->poll */
1690 static bool wm_search_menu_poll(bContext *C)
1691 {
1692         if (CTX_wm_window(C) == NULL) {
1693                 return 0;
1694         }
1695         else {
1696                 ScrArea *sa = CTX_wm_area(C);
1697                 if (sa) {
1698                         if (sa->spacetype == SPACE_CONSOLE) return 0;  /* XXX - so we can use the shortcut in the console */
1699                         if (sa->spacetype == SPACE_TEXT) return 0;     /* XXX - so we can use the spacebar in the text editor */
1700                 }
1701                 else {
1702                         Object *editob = CTX_data_edit_object(C);
1703                         if (editob && editob->type == OB_FONT) return 0;  /* XXX - so we can use the spacebar for entering text */
1704                 }
1705         }
1706         return 1;
1707 }
1708
1709 static void WM_OT_search_menu(wmOperatorType *ot)
1710 {
1711         ot->name = "Search Menu";
1712         ot->idname = "WM_OT_search_menu";
1713         ot->description = "Pop-up a search menu over all available operators in current context";
1714
1715         ot->invoke = wm_search_menu_invoke;
1716         ot->exec = wm_search_menu_exec;
1717         ot->poll = wm_search_menu_poll;
1718 }
1719
1720 static int wm_call_menu_exec(bContext *C, wmOperator *op)
1721 {
1722         char idname[BKE_ST_MAXNAME];
1723         RNA_string_get(op->ptr, "name", idname);
1724
1725         return UI_popup_menu_invoke(C, idname, op->reports);
1726 }
1727
1728 static void WM_OT_call_menu(wmOperatorType *ot)
1729 {
1730         ot->name = "Call Menu";
1731         ot->idname = "WM_OT_call_menu";
1732         ot->description = "Call (draw) a pre-defined menu";
1733
1734         ot->exec = wm_call_menu_exec;
1735         ot->poll = WM_operator_winactive;
1736
1737         ot->flag = OPTYPE_INTERNAL;
1738
1739         RNA_def_string(ot->srna, "name", NULL, BKE_ST_MAXNAME, "Name", "Name of the menu");
1740 }
1741
1742 static int wm_call_pie_menu_invoke(bContext *C, wmOperator *op, const wmEvent *event)
1743 {
1744         char idname[BKE_ST_MAXNAME];
1745         RNA_string_get(op->ptr, "name", idname);
1746
1747         return UI_pie_menu_invoke(C, idname, event);
1748 }
1749
1750 static int wm_call_pie_menu_exec(bContext *C, wmOperator *op)
1751 {
1752         char idname[BKE_ST_MAXNAME];
1753         RNA_string_get(op->ptr, "name", idname);
1754
1755         return UI_pie_menu_invoke(C, idname, CTX_wm_window(C)->eventstate);
1756 }
1757
1758 static void WM_OT_call_menu_pie(wmOperatorType *ot)
1759 {
1760         ot->name = "Call Pie Menu";
1761         ot->idname = "WM_OT_call_menu_pie";
1762         ot->description = "Call (draw) a pre-defined pie menu";
1763
1764         ot->invoke = wm_call_pie_menu_invoke;
1765         ot->exec = wm_call_pie_menu_exec;
1766         ot->poll = WM_operator_winactive;
1767
1768         ot->flag = OPTYPE_INTERNAL;
1769
1770         RNA_def_string(ot->srna, "name", NULL, BKE_ST_MAXNAME, "Name", "Name of the pie menu");
1771 }
1772
1773 static int wm_call_panel_exec(bContext *C, wmOperator *op)
1774 {
1775         char idname[BKE_ST_MAXNAME];
1776         RNA_string_get(op->ptr, "name", idname);
1777         const bool keep_open = RNA_boolean_get(op->ptr, "keep_open");
1778
1779         return UI_popover_panel_invoke(C, idname, keep_open, op->reports);
1780 }
1781
1782 static void WM_OT_call_panel(wmOperatorType *ot)
1783 {
1784         ot->name = "Call Panel";
1785         ot->idname = "WM_OT_call_panel";
1786         ot->description = "Call (draw) a pre-defined panel";
1787
1788         ot->exec = wm_call_panel_exec;
1789         ot->poll = WM_operator_winactive;
1790
1791         ot->flag = OPTYPE_INTERNAL;
1792
1793         PropertyRNA *prop;
1794
1795         prop = RNA_def_string(ot->srna, "name", NULL, BKE_ST_MAXNAME, "Name", "Name of the menu");
1796         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
1797         prop = RNA_def_boolean(ot->srna, "keep_open", true, "Keep Open", "");
1798         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
1799 }
1800
1801 /* ************ window / screen operator definitions ************** */
1802
1803 /* this poll functions is needed in place of WM_operator_winactive
1804  * while it crashes on full screen */
1805 static bool wm_operator_winactive_normal(bContext *C)
1806 {
1807         wmWindow *win = CTX_wm_window(C);
1808         bScreen *screen;
1809
1810         if (win == NULL)
1811                 return 0;
1812         if (!((screen = WM_window_get_active_screen(win)) && (screen->state == SCREENNORMAL)))
1813                 return 0;
1814
1815         return 1;
1816 }
1817
1818 /* included for script-access */
1819 static void WM_OT_window_close(wmOperatorType *ot)
1820 {
1821         ot->name = "Close Window";
1822         ot->idname = "WM_OT_window_close";
1823         ot->description = "Close the current window";
1824
1825         ot->exec = wm_window_close_exec;
1826         ot->poll = WM_operator_winactive;
1827 }
1828
1829 static void WM_OT_window_new(wmOperatorType *ot)
1830 {
1831         ot->name = "New Window";
1832         ot->idname = "WM_OT_window_new";
1833         ot->description = "Create a new window";
1834
1835         ot->exec = wm_window_new_exec;
1836         ot->poll = wm_operator_winactive_normal;
1837 }
1838
1839 static void WM_OT_window_new_main(wmOperatorType *ot)
1840 {
1841         ot->name = "New Main Window";
1842         ot->idname = "WM_OT_window_new_main";
1843         ot->description = "Create a new main window with its own workspace and scene selection";
1844
1845         ot->exec = wm_window_new_main_exec;
1846         ot->poll = wm_operator_winactive_normal;
1847 }
1848
1849 static void WM_OT_window_fullscreen_toggle(wmOperatorType *ot)
1850 {
1851         ot->name = "Toggle Window Fullscreen";
1852         ot->idname = "WM_OT_window_fullscreen_toggle";
1853         ot->description = "Toggle the current window fullscreen";
1854
1855         ot->exec = wm_window_fullscreen_toggle_exec;
1856         ot->poll = WM_operator_winactive;
1857 }
1858
1859 static int wm_exit_blender_exec(bContext *C, wmOperator *UNUSED(op))
1860 {
1861         wm_quit_with_optional_confirmation_prompt(C, CTX_wm_window(C));
1862         return OPERATOR_FINISHED;
1863 }
1864
1865 static int wm_exit_blender_invoke(bContext *C, wmOperator *op, const wmEvent *event)
1866 {
1867         if (U.uiflag & USER_QUIT_PROMPT) {
1868                 return wm_exit_blender_exec(C, op);
1869         }
1870         else {
1871                 return WM_operator_confirm(C, op, event);
1872         }
1873 }
1874
1875 static void WM_OT_quit_blender(wmOperatorType *ot)
1876 {
1877         ot->name = "Quit Blender";
1878         ot->idname = "WM_OT_quit_blender";
1879         ot->description = "Quit Blender";
1880
1881         ot->invoke = wm_exit_blender_invoke;
1882         ot->exec = wm_exit_blender_exec;
1883 }
1884
1885 /* *********************** */
1886
1887 #if defined(WIN32)
1888
1889 static int wm_console_toggle_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
1890 {
1891         GHOST_toggleConsole(2);
1892         return OPERATOR_FINISHED;
1893 }
1894
1895 static void WM_OT_console_toggle(wmOperatorType *ot)
1896 {
1897         /* XXX Have to mark these for xgettext, as under linux they do not exists... */
1898         ot->name = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Toggle System Console");
1899         ot->idname = "WM_OT_console_toggle";
1900         ot->description = N_("Toggle System Console");
1901
1902         ot->exec = wm_console_toggle_exec;
1903         ot->poll = WM_operator_winactive;
1904 }
1905
1906 #endif
1907
1908 /* ************ default paint cursors, draw always around cursor *********** */
1909 /*
1910  * - returns handler to free
1911  * - poll(bContext): returns 1 if draw should happen
1912  * - draw(bContext): drawing callback for paint cursor
1913  */
1914
1915 void *WM_paint_cursor_activate(
1916         wmWindowManager *wm, bool (*poll)(bContext *C),
1917         wmPaintCursorDraw draw, void *customdata)
1918 {
1919         wmPaintCursor *pc = MEM_callocN(sizeof(wmPaintCursor), "paint cursor");
1920
1921         BLI_addtail(&wm->paintcursors, pc);
1922
1923         pc->customdata = customdata;
1924         pc->poll = poll;
1925         pc->draw = draw;
1926
1927         return pc;
1928 }
1929
1930 void WM_paint_cursor_end(wmWindowManager *wm, void *handle)
1931 {
1932         wmPaintCursor *pc;
1933
1934         for (pc = wm->paintcursors.first; pc; pc = pc->next) {
1935                 if (pc == (wmPaintCursor *)handle) {
1936                         BLI_remlink(&wm->paintcursors, pc);
1937                         MEM_freeN(pc);
1938                         return;
1939                 }
1940         }
1941 }
1942
1943 /* *********************** radial control ****************** */
1944
1945 #define WM_RADIAL_CONTROL_DISPLAY_SIZE (200 * UI_DPI_FAC)
1946 #define WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE (35 * UI_DPI_FAC)
1947 #define WM_RADIAL_CONTROL_DISPLAY_WIDTH (WM_RADIAL_CONTROL_DISPLAY_SIZE - WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE)
1948 #define WM_RADIAL_MAX_STR 10
1949
1950 typedef struct {
1951         PropertyType type;
1952         PropertySubType subtype;
1953         PointerRNA ptr, col_ptr, fill_col_ptr, rot_ptr, zoom_ptr, image_id_ptr;
1954         PointerRNA fill_col_override_ptr, fill_col_override_test_ptr;
1955         PropertyRNA *prop, *col_prop, *fill_col_prop, *rot_prop, *zoom_prop;
1956         PropertyRNA *fill_col_override_prop, *fill_col_override_test_prop;
1957         StructRNA *image_id_srna;
1958         float initial_value, current_value, min_value, max_value;
1959         int initial_mouse[2];
1960         int slow_mouse[2];
1961         bool slow_mode;
1962         Dial *dial;
1963         unsigned int gltex;
1964         ListBase orig_paintcursors;
1965         bool use_secondary_tex;
1966         void *cursor;
1967         NumInput num_input;
1968 } RadialControl;
1969
1970 static void radial_control_update_header(wmOperator *op, bContext *C)
1971 {
1972         RadialControl *rc = op->customdata;
1973         char msg[UI_MAX_DRAW_STR];
1974         ScrArea *sa = CTX_wm_area(C);
1975         Scene *scene = CTX_data_scene(C);
1976
1977         if (hasNumInput(&rc->num_input)) {
1978                 char num_str[NUM_STR_REP_LEN];
1979                 outputNumInput(&rc->num_input, num_str, &scene->unit);
1980                 BLI_snprintf(msg, sizeof(msg), "%s: %s", RNA_property_ui_name(rc->prop), num_str);
1981         }
1982         else {
1983                 const char *ui_name = RNA_property_ui_name(rc->prop);
1984                 switch (rc->subtype) {
1985                         case PROP_NONE:
1986                         case PROP_DISTANCE:
1987                                 BLI_snprintf(msg, sizeof(msg), "%s: %0.4f", ui_name, rc->current_value);
1988                                 break;
1989                         case PROP_PIXEL:
1990                                 BLI_snprintf(msg, sizeof(msg), "%s: %d", ui_name, (int)rc->current_value); /* XXX: round to nearest? */
1991                                 break;
1992                         case PROP_PERCENTAGE:
1993                                 BLI_snprintf(msg, sizeof(msg), "%s: %3.1f%%", ui_name, rc->current_value);
1994                                 break;
1995                         case PROP_FACTOR:
1996                                 BLI_snprintf(msg, sizeof(msg), "%s: %1.3f", ui_name, rc->current_value);
1997                                 break;
1998                         case PROP_ANGLE:
1999                                 BLI_snprintf(msg, sizeof(msg), "%s: %3.2f", ui_name, RAD2DEGF(rc->current_value));
2000                                 break;
2001                         default:
2002                                 BLI_snprintf(msg, sizeof(msg), "%s", ui_name); /* XXX: No value? */
2003                                 break;
2004                 }
2005         }
2006
2007         ED_area_status_text(sa, msg);
2008 }
2009
2010 static void radial_control_set_initial_mouse(RadialControl *rc, const wmEvent *event)
2011 {
2012         float d[2] = {0, 0};
2013         float zoom[2] = {1, 1};
2014
2015         rc->initial_mouse[0] = event->x;
2016         rc->initial_mouse[1] = event->y;
2017
2018         switch (rc->subtype) {
2019                 case PROP_NONE:
2020                 case PROP_DISTANCE:
2021                 case PROP_PIXEL:
2022                         d[0] = rc->initial_value;
2023                         break;
2024                 case PROP_PERCENTAGE:
2025                         d[0] = (rc->initial_value) / 100.0f * WM_RADIAL_CONTROL_DISPLAY_WIDTH + WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2026                         break;
2027                 case PROP_FACTOR:
2028                         d[0] = (1 - rc->initial_value) * WM_RADIAL_CONTROL_DISPLAY_WIDTH + WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2029                         break;
2030                 case PROP_ANGLE:
2031                         d[0] = WM_RADIAL_CONTROL_DISPLAY_SIZE * cosf(rc->initial_value);
2032                         d[1] = WM_RADIAL_CONTROL_DISPLAY_SIZE * sinf(rc->initial_value);
2033                         break;
2034                 default:
2035                         return;
2036         }
2037
2038         if (rc->zoom_prop) {
2039                 RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2040                 d[0] *= zoom[0];
2041                 d[1] *= zoom[1];
2042         }
2043
2044         rc->initial_mouse[0] -= d[0];
2045         rc->initial_mouse[1] -= d[1];
2046 }
2047
2048 static void radial_control_set_tex(RadialControl *rc)
2049 {
2050         ImBuf *ibuf;
2051
2052         switch (RNA_type_to_ID_code(rc->image_id_ptr.type)) {
2053                 case ID_BR:
2054                         if ((ibuf = BKE_brush_gen_radial_control_imbuf(rc->image_id_ptr.data, rc->use_secondary_tex))) {
2055                                 glGenTextures(1, &rc->gltex);
2056                                 glBindTexture(GL_TEXTURE_2D, rc->gltex);
2057                                 glTexImage2D(GL_TEXTURE_2D, 0, GL_R8, ibuf->x, ibuf->y, 0,
2058                                              GL_RED, GL_FLOAT, ibuf->rect_float);
2059                                 glBindTexture(GL_TEXTURE_2D, 0);
2060                                 MEM_freeN(ibuf->rect_float);
2061                                 MEM_freeN(ibuf);
2062                         }
2063                         break;
2064                 default:
2065                         break;
2066         }
2067 }
2068
2069 static void radial_control_paint_tex(RadialControl *rc, float radius, float alpha)
2070 {
2071         float col[3] = {0, 0, 0};
2072         float rot;
2073
2074         /* set fill color */
2075         if (rc->fill_col_prop) {
2076                 PointerRNA *fill_ptr;
2077                 PropertyRNA *fill_prop;
2078
2079                 if (rc->fill_col_override_prop &&
2080                     RNA_property_boolean_get(&rc->fill_col_override_test_ptr, rc->fill_col_override_test_prop))
2081                 {
2082                         fill_ptr = &rc->fill_col_override_ptr;
2083                         fill_prop = rc->fill_col_override_prop;
2084                 }
2085                 else {
2086                         fill_ptr = &rc->fill_col_ptr;
2087                         fill_prop = rc->fill_col_prop;
2088                 }
2089
2090                 RNA_property_float_get_array(fill_ptr, fill_prop, col);
2091         }
2092
2093         GPUVertFormat *format = immVertexFormat();
2094         uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2095
2096         if (rc->gltex) {
2097
2098                 uint texCoord = GPU_vertformat_attr_add(format, "texCoord", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2099
2100                 glActiveTexture(GL_TEXTURE0);
2101                 glBindTexture(GL_TEXTURE_2D, rc->gltex);
2102
2103                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
2104                 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
2105
2106                 GLint swizzleMask[] = {GL_ZERO, GL_ZERO, GL_ZERO, GL_RED};
2107                 glTexParameteriv(GL_TEXTURE_2D, GL_TEXTURE_SWIZZLE_RGBA, swizzleMask);
2108
2109                 immBindBuiltinProgram(GPU_SHADER_2D_IMAGE_MASK_UNIFORM_COLOR);
2110
2111                 immUniformColor3fvAlpha(col, alpha);
2112                 immUniform1i("image", 0);
2113
2114                 /* set up rotation if available */
2115                 if (rc->rot_prop) {
2116                         rot = RNA_property_float_get(&rc->rot_ptr, rc->rot_prop);
2117                         GPU_matrix_push();
2118                         GPU_matrix_rotate_2d(RAD2DEGF(rot));
2119                 }
2120
2121                 /* draw textured quad */
2122                 immBegin(GPU_PRIM_TRI_FAN, 4);
2123
2124                 immAttrib2f(texCoord, 0, 0);
2125                 immVertex2f(pos, -radius, -radius);
2126
2127                 immAttrib2f(texCoord, 1, 0);
2128                 immVertex2f(pos, radius, -radius);
2129
2130                 immAttrib2f(texCoord, 1, 1);
2131                 immVertex2f(pos, radius, radius);
2132
2133                 immAttrib2f(texCoord, 0, 1);
2134                 immVertex2f(pos, -radius, radius);
2135
2136                 immEnd();
2137
2138                 /* undo rotation */
2139                 if (rc->rot_prop)
2140                         GPU_matrix_pop();
2141         }
2142         else {
2143                 /* flat color if no texture available */
2144                 immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2145                 immUniformColor3fvAlpha(col, alpha);
2146                 imm_draw_circle_fill_2d(pos, 0.0f, 0.0f, radius, 40);
2147         }
2148
2149         immUnbindProgram();
2150 }
2151
2152 static void radial_control_paint_cursor(bContext *UNUSED(C), int x, int y, void *customdata)
2153 {
2154         RadialControl *rc = customdata;
2155         uiStyle *style = UI_style_get();
2156         const uiFontStyle *fstyle = &style->widget;
2157         const int fontid = fstyle->uifont_id;
2158         short fstyle_points = fstyle->points;
2159         char str[WM_RADIAL_MAX_STR];
2160         short strdrawlen = 0;
2161         float strwidth, strheight;
2162         float r1 = 0.0f, r2 = 0.0f, rmin = 0.0, tex_radius, alpha;
2163         float zoom[2], col[3] = {1, 1, 1};
2164
2165         switch (rc->subtype) {
2166                 case PROP_NONE:
2167                 case PROP_DISTANCE:
2168                 case PROP_PIXEL:
2169                         r1 = rc->current_value;
2170                         r2 = rc->initial_value;
2171                         tex_radius = r1;
2172                         alpha = 0.75;
2173                         break;
2174                 case PROP_PERCENTAGE:
2175                         r1 = rc->current_value / 100.0f * WM_RADIAL_CONTROL_DISPLAY_WIDTH + WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2176                         r2 = tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE;
2177                         rmin = WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2178                         BLI_snprintf(str, WM_RADIAL_MAX_STR, "%3.1f%%", rc->current_value);
2179                         strdrawlen = BLI_strlen_utf8(str);
2180                         tex_radius = r1;
2181                         alpha = 0.75;
2182                         break;
2183                 case PROP_FACTOR:
2184                         r1 = (1 - rc->current_value) * WM_RADIAL_CONTROL_DISPLAY_WIDTH + WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2185                         r2 = tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE;
2186                         rmin = WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2187                         alpha = rc->current_value / 2.0f + 0.5f;
2188                         BLI_snprintf(str, WM_RADIAL_MAX_STR, "%1.3f", rc->current_value);
2189                         strdrawlen = BLI_strlen_utf8(str);
2190                         break;
2191                 case PROP_ANGLE:
2192                         r1 = r2 = tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE;
2193                         alpha = 0.75;
2194                         rmin = WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2195                         BLI_snprintf(str, WM_RADIAL_MAX_STR, "%3.2f", RAD2DEGF(rc->current_value));
2196                         strdrawlen = BLI_strlen_utf8(str);
2197                         break;
2198                 default:
2199                         tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE; /* note, this is a dummy value */
2200                         alpha = 0.75;
2201                         break;
2202         }
2203
2204         /* Keep cursor in the original place */
2205         x = rc->initial_mouse[0];
2206         y = rc->initial_mouse[1];
2207         GPU_matrix_translate_2f((float)x, (float)y);
2208
2209         glEnable(GL_BLEND);
2210         glEnable(GL_LINE_SMOOTH);
2211
2212         /* apply zoom if available */
2213         if (rc->zoom_prop) {
2214                 RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2215                 GPU_matrix_scale_2fv(zoom);
2216         }
2217
2218         /* draw rotated texture */
2219         radial_control_paint_tex(rc, tex_radius, alpha);
2220
2221         /* set line color */
2222         if (rc->col_prop)
2223                 RNA_property_float_get_array(&rc->col_ptr, rc->col_prop, col);
2224
2225         GPUVertFormat *format = immVertexFormat();
2226         uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2227
2228         immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2229         immUniformColor3fvAlpha(col, 0.5f);
2230
2231         if (rc->subtype == PROP_ANGLE) {
2232                 GPU_matrix_push();
2233
2234                 /* draw original angle line */
2235                 GPU_matrix_rotate_2d(RAD2DEGF(rc->initial_value));
2236                 immBegin(GPU_PRIM_LINES, 2);
2237                 immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE, 0.0f);
2238                 immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_SIZE, 0.0f);
2239                 immEnd();
2240
2241                 /* draw new angle line */
2242                 GPU_matrix_rotate_2d(RAD2DEGF(rc->current_value - rc->initial_value));
2243                 immBegin(GPU_PRIM_LINES, 2);
2244                 immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE, 0.0f);
2245                 immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_SIZE, 0.0f);
2246                 immEnd();
2247
2248                 GPU_matrix_pop();
2249         }
2250
2251         /* draw circles on top */
2252         imm_draw_circle_wire_2d(pos, 0.0f, 0.0f, r1, 40);
2253         imm_draw_circle_wire_2d(pos, 0.0f, 0.0f, r2, 40);
2254         if (rmin > 0.0f)
2255                 imm_draw_circle_wire_2d(pos, 0.0, 0.0f, rmin, 40);
2256         immUnbindProgram();
2257
2258         BLF_size(fontid, 1.5 * fstyle_points * U.pixelsize, U.dpi);
2259         BLF_enable(fontid, BLF_SHADOW);
2260         BLF_shadow(fontid, 3, (const float[4]){0.0f, 0.0f, 0.0f, 0.5f});
2261         BLF_shadow_offset(fontid, 1, -1);
2262
2263         /* draw value */
2264         BLF_width_and_height(fontid, str, strdrawlen, &strwidth, &strheight);
2265         BLF_position(fontid, -0.5f * strwidth, -0.5f * strheight, 0.0f);
2266         BLF_draw(fontid, str, strdrawlen);
2267
2268         BLF_disable(fontid, BLF_SHADOW);
2269
2270         glDisable(GL_BLEND);
2271         glDisable(GL_LINE_SMOOTH);
2272
2273 }
2274
2275 typedef enum {
2276         RC_PROP_ALLOW_MISSING = 1,
2277         RC_PROP_REQUIRE_FLOAT = 2,
2278         RC_PROP_REQUIRE_BOOL = 4,
2279 } RCPropFlags;
2280
2281 /**
2282  * Attempt to retrieve the rna pointer/property from an rna path.
2283  *
2284  * \return 0 for failure, 1 for success, and also 1 if property is not set.
2285  */
2286 static int radial_control_get_path(
2287         PointerRNA *ctx_ptr, wmOperator *op,
2288         const char *name, PointerRNA *r_ptr,
2289         PropertyRNA **r_prop, int req_length, RCPropFlags flags)
2290 {
2291         PropertyRNA *unused_prop;
2292         int len;
2293         char *str;
2294
2295         /* check flags */
2296         if ((flags & RC_PROP_REQUIRE_BOOL) && (flags & RC_PROP_REQUIRE_FLOAT)) {
2297                 BKE_report(op->reports, RPT_ERROR, "Property cannot be both boolean and float");
2298                 return 0;
2299         }
2300
2301         /* get an rna string path from the operator's properties */
2302         if (!(str = RNA_string_get_alloc(op->ptr, name, NULL, 0)))
2303                 return 1;
2304
2305         if (str[0] == '\0') {
2306                 if (r_prop) *r_prop = NULL;
2307                 MEM_freeN(str);
2308                 return 1;
2309         }
2310
2311         if (!r_prop)
2312                 r_prop = &unused_prop;
2313
2314         /* get rna from path */
2315         if (!RNA_path_resolve(ctx_ptr, str, r_ptr, r_prop)) {
2316                 MEM_freeN(str);
2317                 if (flags & RC_PROP_ALLOW_MISSING)
2318                         return 1;
2319                 else {
2320                         BKE_reportf(op->reports, RPT_ERROR, "Could not resolve path '%s'", name);
2321                         return 0;
2322                 }
2323         }
2324
2325         /* check property type */
2326         if (flags & (RC_PROP_REQUIRE_BOOL | RC_PROP_REQUIRE_FLOAT)) {
2327                 PropertyType prop_type = RNA_property_type(*r_prop);
2328
2329                 if (((flags & RC_PROP_REQUIRE_BOOL) && (prop_type != PROP_BOOLEAN)) ||
2330                     ((flags & RC_PROP_REQUIRE_FLOAT) && (prop_type != PROP_FLOAT)))
2331                 {
2332                         MEM_freeN(str);
2333                         BKE_reportf(op->reports, RPT_ERROR, "Property from path '%s' is not a float", name);
2334                         return 0;
2335                 }
2336         }
2337
2338         /* check property's array length */
2339         if (*r_prop && (len = RNA_property_array_length(r_ptr, *r_prop)) != req_length) {
2340                 MEM_freeN(str);
2341                 BKE_reportf(op->reports, RPT_ERROR, "Property from path '%s' has length %d instead of %d",
2342                             name, len, req_length);
2343                 return 0;
2344         }
2345
2346         /* success */
2347         MEM_freeN(str);
2348         return 1;
2349 }
2350
2351 /* initialize the rna pointers and properties using rna paths */
2352 static int radial_control_get_properties(bContext *C, wmOperator *op)
2353 {
2354         RadialControl *rc = op->customdata;
2355         PointerRNA ctx_ptr, use_secondary_ptr;
2356         PropertyRNA *use_secondary_prop = NULL;
2357         const char *data_path;
2358
2359         RNA_pointer_create(NULL, &RNA_Context, C, &ctx_ptr);
2360
2361         /* check if we use primary or secondary path */
2362         if (!radial_control_get_path(&ctx_ptr, op, "use_secondary",
2363                                      &use_secondary_ptr, &use_secondary_prop,
2364                                      0, (RC_PROP_ALLOW_MISSING |
2365                                          RC_PROP_REQUIRE_BOOL)))
2366         {
2367                 return 0;
2368         }
2369         else {
2370                 if (use_secondary_prop &&
2371                     RNA_property_boolean_get(&use_secondary_ptr, use_secondary_prop))
2372                 {
2373                         data_path = "data_path_secondary";
2374                 }
2375                 else {
2376                         data_path = "data_path_primary";
2377                 }
2378         }
2379
2380         if (!radial_control_get_path(&ctx_ptr, op, data_path, &rc->ptr, &rc->prop, 0, 0))
2381                 return 0;
2382
2383         /* data path is required */
2384         if (!rc->prop)
2385                 return 0;
2386
2387         if (!radial_control_get_path(&ctx_ptr, op, "rotation_path", &rc->rot_ptr, &rc->rot_prop, 0, RC_PROP_REQUIRE_FLOAT))
2388                 return 0;
2389         if (!radial_control_get_path(&ctx_ptr, op, "color_path", &rc->col_ptr, &rc->col_prop, 3, RC_PROP_REQUIRE_FLOAT))
2390                 return 0;
2391
2392
2393         if (!radial_control_get_path(
2394                 &ctx_ptr, op, "fill_color_path", &rc->fill_col_ptr, &rc->fill_col_prop, 3, RC_PROP_REQUIRE_FLOAT))
2395         {
2396                 return 0;
2397         }
2398
2399         if (!radial_control_get_path(
2400                 &ctx_ptr, op, "fill_color_override_path",
2401                 &rc->fill_col_override_ptr, &rc->fill_col_override_prop, 3, RC_PROP_REQUIRE_FLOAT))
2402         {
2403                 return 0;
2404         }
2405         if (!radial_control_get_path(
2406                 &ctx_ptr, op, "fill_color_override_test_path",
2407                 &rc->fill_col_override_test_ptr, &rc->fill_col_override_test_prop, 0, RC_PROP_REQUIRE_BOOL))
2408         {
2409                 return 0;
2410         }
2411
2412         /* slightly ugly; allow this property to not resolve
2413          * correctly. needed because 3d texture paint shares the same
2414          * keymap as 2d image paint */
2415         if (!radial_control_get_path(&ctx_ptr, op, "zoom_path",
2416                                      &rc->zoom_ptr, &rc->zoom_prop, 2,
2417                                      RC_PROP_REQUIRE_FLOAT | RC_PROP_ALLOW_MISSING))
2418         {
2419                 return 0;
2420         }
2421
2422         if (!radial_control_get_path(&ctx_ptr, op, "image_id", &rc->image_id_ptr, NULL, 0, 0))
2423                 return 0;
2424         else if (rc->image_id_ptr.data) {
2425                 /* extra check, pointer must be to an ID */
2426                 if (!RNA_struct_is_ID(rc->image_id_ptr.type)) {
2427                         BKE_report(op->reports, RPT_ERROR, "Pointer from path image_id is not an ID");
2428                         return 0;
2429                 }
2430         }
2431
2432         rc->use_secondary_tex = RNA_boolean_get(op->ptr, "secondary_tex");
2433
2434         return 1;
2435 }
2436
2437 static int radial_control_invoke(bContext *C, wmOperator *op, const wmEvent *event)
2438 {
2439         wmWindowManager *wm;
2440         RadialControl *rc;
2441
2442
2443         if (!(op->customdata = rc = MEM_callocN(sizeof(RadialControl), "RadialControl")))
2444                 return OPERATOR_CANCELLED;
2445
2446         if (!radial_control_get_properties(C, op)) {
2447                 MEM_freeN(rc);
2448                 return OPERATOR_CANCELLED;
2449         }
2450
2451         /* get type, initial, min, and max values of the property */
2452         switch ((rc->type = RNA_property_type(rc->prop))) {
2453                 case PROP_INT:
2454                 {
2455                         int value, min, max, step;
2456
2457                         value = RNA_property_int_get(&rc->ptr, rc->prop);
2458                         RNA_property_int_ui_range(&rc->ptr, rc->prop, &min, &max, &step);
2459
2460                         rc->initial_value = value;
2461                         rc->min_value = min_ii(value, min);
2462                         rc->max_value = max_ii(value, max);
2463                         break;
2464                 }
2465                 case PROP_FLOAT:
2466                 {
2467                         float value, min, max, step, precision;
2468
2469                         value = RNA_property_float_get(&rc->ptr, rc->prop);
2470                         RNA_property_float_ui_range(&rc->ptr, rc->prop, &min, &max, &step, &precision);
2471
2472                         rc->initial_value = value;
2473                         rc->min_value = min_ff(value, min);
2474                         rc->max_value = max_ff(value, max);
2475                         break;
2476                 }
2477                 default:
2478                         BKE_report(op->reports, RPT_ERROR, "Property must be an integer or a float");
2479                         MEM_freeN(rc);
2480                         return OPERATOR_CANCELLED;
2481         }
2482
2483         /* initialize numerical input */
2484         initNumInput(&rc->num_input);
2485         rc->num_input.idx_max = 0;
2486         rc->num_input.val_flag[0] |= NUM_NO_NEGATIVE;
2487         rc->num_input.unit_sys = USER_UNIT_NONE;
2488         rc->num_input.unit_type[0] = B_UNIT_LENGTH;
2489
2490         /* get subtype of property */
2491         rc->subtype = RNA_property_subtype(rc->prop);
2492         if (!ELEM(rc->subtype, PROP_NONE, PROP_DISTANCE, PROP_FACTOR, PROP_PERCENTAGE, PROP_ANGLE, PROP_PIXEL)) {
2493                 BKE_report(op->reports, RPT_ERROR, "Property must be a none, distance, factor, percentage, angle, or pixel");
2494                 MEM_freeN(rc);
2495                 return OPERATOR_CANCELLED;
2496         }
2497
2498         rc->current_value = rc->initial_value;
2499         radial_control_set_initial_mouse(rc, event);
2500         radial_control_set_tex(rc);
2501
2502         /* temporarily disable other paint cursors */
2503         wm = CTX_wm_manager(C);
2504         rc->orig_paintcursors = wm->paintcursors;
2505         BLI_listbase_clear(&wm->paintcursors);
2506
2507         /* add radial control paint cursor */
2508         rc->cursor = WM_paint_cursor_activate(wm, op->type->poll,
2509                                               radial_control_paint_cursor, rc);
2510
2511         WM_event_add_modal_handler(C, op);
2512
2513         return OPERATOR_RUNNING_MODAL;
2514 }
2515
2516 static void radial_control_set_value(RadialControl *rc, float val)
2517 {
2518         switch (rc->type) {
2519                 case PROP_INT:
2520                         RNA_property_int_set(&rc->ptr, rc->prop, val);
2521                         break;
2522                 case PROP_FLOAT:
2523                         RNA_property_float_set(&rc->ptr, rc->prop, val);
2524                         break;
2525                 default:
2526                         break;
2527         }
2528 }
2529
2530 static void radial_control_cancel(bContext *C, wmOperator *op)
2531 {
2532         RadialControl *rc = op->customdata;
2533         wmWindowManager *wm = CTX_wm_manager(C);
2534         ScrArea *sa = CTX_wm_area(C);
2535
2536         if (rc->dial) {
2537                 MEM_freeN(rc->dial);
2538                 rc->dial = NULL;
2539         }
2540
2541         ED_area_status_text(sa, NULL);
2542
2543         WM_paint_cursor_end(wm, rc->cursor);
2544
2545         /* restore original paint cursors */
2546         wm->paintcursors = rc->orig_paintcursors;
2547
2548         /* not sure if this is a good notifier to use;
2549          * intended purpose is to update the UI so that the
2550          * new value is displayed in sliders/numfields */
2551         WM_event_add_notifier(C, NC_WINDOW, NULL);
2552
2553         glDeleteTextures(1, &rc->gltex);
2554
2555         MEM_freeN(rc);
2556 }
2557
2558 static int radial_control_modal(bContext *C, wmOperator *op, const wmEvent *event)
2559 {
2560         RadialControl *rc = op->customdata;
2561         float new_value, dist = 0.0f, zoom[2];
2562         float delta[2], ret = OPERATOR_RUNNING_MODAL;
2563         bool snap;
2564         float angle_precision = 0.0f;
2565         const bool has_numInput = hasNumInput(&rc->num_input);
2566         bool handled = false;
2567         float numValue;
2568         /* TODO: fix hardcoded events */
2569
2570         snap = event->ctrl != 0;
2571
2572         /* Modal numinput active, try to handle numeric inputs first... */
2573         if (event->val == KM_PRESS && has_numInput && handleNumInput(C, &rc->num_input, event)) {
2574                 handled = true;
2575                 applyNumInput(&rc->num_input, &numValue);
2576
2577                 if (rc->subtype == PROP_ANGLE) {
2578                         numValue = DEG2RADF(numValue);
2579                         numValue = fmod(numValue, 2.0f * (float)M_PI);
2580                         if (numValue < 0.0f)
2581                                 numValue += 2.0f * (float)M_PI;
2582                 }
2583
2584                 CLAMP(numValue, rc->min_value, rc->max_value);
2585                 new_value = numValue;
2586
2587                 radial_control_set_value(rc, new_value);
2588                 rc->current_value = new_value;
2589                 radial_control_update_header(op, C);
2590                 return OPERATOR_RUNNING_MODAL;
2591         }
2592         else {
2593                 handled = false;
2594                 switch (event->type) {
2595                         case ESCKEY:
2596                         case RIGHTMOUSE:
2597                                 /* canceled; restore original value */
2598                                 radial_control_set_value(rc, rc->initial_value);
2599                                 ret = OPERATOR_CANCELLED;
2600                                 break;
2601
2602                         case LEFTMOUSE:
2603                         case PADENTER:
2604                         case RETKEY:
2605                                 /* done; value already set */
2606                                 RNA_property_update(C, &rc->ptr, rc->prop);
2607                                 ret = OPERATOR_FINISHED;
2608                                 break;
2609
2610                         case MOUSEMOVE:
2611                                 if (!has_numInput) {
2612                                         if (rc->slow_mode) {
2613                                                 if (rc->subtype == PROP_ANGLE) {
2614                                                         float position[2] = {event->x, event->y};
2615
2616                                                         /* calculate the initial angle here first */
2617                                                         delta[0] = rc->initial_mouse[0] - rc->slow_mouse[0];
2618                                                         delta[1] = rc->initial_mouse[1] - rc->slow_mouse[1];
2619
2620                                                         /* precision angle gets calculated from dial and gets added later */
2621                                                         angle_precision = -0.1f * BLI_dial_angle(rc->dial, position);
2622                                                 }
2623                                                 else {
2624                                                         delta[0] = rc->initial_mouse[0] - rc->slow_mouse[0];
2625                                                         delta[1] = rc->initial_mouse[1] - rc->slow_mouse[1];
2626
2627                                                         if (rc->zoom_prop) {
2628                                                                 RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2629                                                                 delta[0] /= zoom[0];
2630                                                                 delta[1] /= zoom[1];
2631                                                         }
2632
2633                                                         dist = len_v2(delta);
2634
2635                                                         delta[0] = event->x - rc->slow_mouse[0];
2636                                                         delta[1] = event->y - rc->slow_mouse[1];
2637
2638                                                         if (rc->zoom_prop) {
2639                                                                 delta[0] /= zoom[0];
2640                                                                 delta[1] /= zoom[1];
2641                                                         }
2642
2643                                                         dist = dist + 0.1f * (delta[0] + delta[1]);
2644                                                 }
2645                                         }
2646                                         else {
2647                                                 delta[0] = rc->initial_mouse[0] - event->x;
2648                                                 delta[1] = rc->initial_mouse[1] - event->y;
2649
2650                                                 if (rc->zoom_prop) {
2651                                                         RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2652                                                         delta[0] /= zoom[0];
2653                                                         delta[1] /= zoom[1];
2654                                                 }
2655
2656                                                 dist = len_v2(delta);
2657                                         }
2658
2659                                         /* calculate new value and apply snapping  */
2660                                         switch (rc->subtype) {
2661                                                 case PROP_NONE:
2662                                                 case PROP_DISTANCE:
2663                                                 case PROP_PIXEL:
2664                                                         new_value = dist;
2665                                                         if (snap) new_value = ((int)new_value + 5) / 10 * 10;
2666                                                         break;
2667                                                 case PROP_PERCENTAGE:
2668                                                         new_value = ((dist - WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE) / WM_RADIAL_CONTROL_DISPLAY_WIDTH) * 100.0f;
2669                                                         if (snap) new_value = ((int)(new_value + 2.5f)) / 5 * 5;
2670                                                         break;
2671                                                 case PROP_FACTOR:
2672                                                         new_value = (WM_RADIAL_CONTROL_DISPLAY_SIZE - dist) / WM_RADIAL_CONTROL_DISPLAY_WIDTH;
2673                                                         if (snap) new_value = ((int)ceil(new_value * 10.f) * 10.0f) / 100.f;
2674                                                         break;
2675                                                 case PROP_ANGLE:
2676                                                         new_value = atan2f(delta[1], delta[0]) + (float)M_PI + angle_precision;
2677                                                         new_value = fmod(new_value, 2.0f * (float)M_PI);
2678                                                         if (new_value < 0.0f)
2679                                                                 new_value += 2.0f * (float)M_PI;
2680                                                         if (snap) new_value = DEG2RADF(((int)RAD2DEGF(new_value) + 5) / 10 * 10);
2681                                                         break;
2682                                                 default:
2683                                                         new_value = dist; /* dummy value, should this ever happen? - campbell */
2684                                                         break;
2685                                         }
2686
2687                                         /* clamp and update */
2688                                         CLAMP(new_value, rc->min_value, rc->max_value);
2689                                         radial_control_set_value(rc, new_value);
2690                                         rc->current_value = new_value;
2691                                         handled = true;
2692                                         break;
2693                                 }
2694                                 break;
2695
2696                         case LEFTSHIFTKEY:
2697                         case RIGHTSHIFTKEY:
2698                         {
2699                                 if (event->val == KM_PRESS) {
2700                                         rc->slow_mouse[0] = event->x;
2701                                         rc->slow_mouse[1] = event->y;
2702                                         rc->slow_mode = true;
2703                                         if (rc->subtype == PROP_ANGLE) {
2704                                                 float initial_position[2] = {UNPACK2(rc->initial_mouse)};
2705                                                 float current_position[2] = {UNPACK2(rc->slow_mouse)};
2706                                                 rc->dial = BLI_dial_initialize(initial_position, 0.0f);
2707                                                 /* immediately set the position to get a an initial direction */
2708                                                 BLI_dial_angle(rc->dial, current_position);
2709                                         }
2710                                         handled = true;
2711                                 }
2712                                 if (event->val == KM_RELEASE) {
2713                                         rc->slow_mode = false;
2714                                         handled = true;
2715                                         if (rc->dial) {
2716                                                 MEM_freeN(rc->dial);
2717                                                 rc->dial = NULL;
2718                                         }
2719                                 }
2720                                 break;
2721                         }
2722                 }
2723
2724                 /* Modal numinput inactive, try to handle numeric inputs last... */
2725                 if (!handled && event->val == KM_PRESS && handleNumInput(C, &rc->num_input, event)) {
2726                         applyNumInput(&rc->num_input, &numValue);
2727
2728                         if (rc->subtype == PROP_ANGLE) {
2729                                 numValue = DEG2RADF(numValue);
2730                                 numValue = fmod(numValue, 2.0f * (float)M_PI);
2731                                 if (numValue < 0.0f)
2732                                         numValue += 2.0f * (float)M_PI;
2733                         }
2734
2735                         CLAMP(numValue, rc->min_value, rc->max_value);
2736                         new_value = numValue;
2737
2738                         radial_control_set_value(rc, new_value);
2739
2740                         rc->current_value = new_value;
2741                         radial_control_update_header(op, C);
2742                         return OPERATOR_RUNNING_MODAL;
2743                 }
2744         }
2745
2746         ED_region_tag_redraw(CTX_wm_region(C));
2747         radial_control_update_header(op, C);
2748
2749         if (ret != OPERATOR_RUNNING_MODAL)
2750                 radial_control_cancel(C, op);
2751
2752         return ret;
2753 }
2754
2755 static void WM_OT_radial_control(wmOperatorType *ot)
2756 {
2757         ot->name = "Radial Control";
2758         ot->idname = "WM_OT_radial_control";
2759         ot->description = "Set some size property (like e.g. brush size) with mouse wheel";
2760
2761         ot->invoke = radial_control_invoke;
2762         ot->modal = radial_control_modal;
2763         ot->cancel = radial_control_cancel;
2764
2765         ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_BLOCKING;
2766
2767         /* all paths relative to the context */
2768         PropertyRNA *prop;
2769         prop = RNA_def_string(ot->srna, "data_path_primary", NULL, 0, "Primary Data Path", "Primary path of property to be set by the radial control");
2770         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2771
2772         prop = RNA_def_string(ot->srna, "data_path_secondary", NULL, 0, "Secondary Data Path", "Secondary path of property to be set by the radial control");
2773         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2774
2775         prop = RNA_def_string(ot->srna, "use_secondary", NULL, 0, "Use Secondary", "Path of property to select between the primary and secondary data paths");
2776         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2777
2778         prop = RNA_def_string(ot->srna, "rotation_path", NULL, 0, "Rotation Path", "Path of property used to rotate the texture display");
2779         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2780
2781         prop = RNA_def_string(ot->srna, "color_path", NULL, 0, "Color Path", "Path of property used to set the color of the control");
2782         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2783
2784         prop = RNA_def_string(ot->srna, "fill_color_path", NULL, 0, "Fill Color Path", "Path of property used to set the fill color of the control");
2785         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2786
2787         prop = RNA_def_string(ot->srna, "fill_color_override_path", NULL, 0, "Fill Color Override Path", "");
2788         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2789         prop = RNA_def_string(ot->srna, "fill_color_override_test_path", NULL, 0, "Fill Color Override Test", "");
2790         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2791
2792         prop = RNA_def_string(ot->srna, "zoom_path", NULL, 0, "Zoom Path", "Path of property used to set the zoom level for the control");
2793         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2794
2795         prop = RNA_def_string(ot->srna, "image_id", NULL, 0, "Image ID", "Path of ID that is used to generate an image for the control");
2796         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2797
2798         prop = RNA_def_boolean(ot->srna, "secondary_tex", false, "Secondary Texture", "Tweak brush secondary/mask texture");
2799         RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2800 }
2801
2802 /* ************************** timer for testing ***************** */
2803
2804 /* uses no type defines, fully local testing function anyway... ;) */
2805
2806 static void redraw_timer_window_swap(bContext *C)
2807 {
2808         wmWindow *win = CTX_wm_window(C);
2809         ScrArea *sa;
2810         CTX_wm_menu_set(C, NULL);
2811
2812         for (sa = CTX_wm_screen(C)->areabase.first; sa; sa = sa->next)
2813                 ED_area_tag_redraw(sa);
2814         wm_draw_update(C);
2815
2816         CTX_wm_window_set(C, win);  /* XXX context manipulation warning! */
2817 }
2818
2819 enum {
2820         eRTDrawRegion = 0,
2821         eRTDrawRegionSwap = 1,
2822         eRTDrawWindow = 2,
2823         eRTDrawWindowSwap = 3,
2824         eRTAnimationStep = 4,
2825         eRTAnimationPlay = 5,
2826         eRTUndo = 6,
2827 };
2828
2829 static const EnumPropertyItem redraw_timer_type_items[] = {
2830         {eRTDrawRegion, "DRAW", 0, "Draw Region", "Draw Region"},
2831         {eRTDrawRegionSwap, "DRAW_SWAP", 0, "Draw Region + Swap", "Draw Region and Swap"},
2832         {eRTDrawWindow, "DRAW_WIN", 0, "Draw Window", "Draw Window"},
2833         {eRTDrawWindowSwap, "DRAW_WIN_SWAP", 0, "Draw Window + Swap", "Draw Window and Swap"},
2834         {eRTAnimationStep, "ANIM_STEP", 0, "Anim Step", "Animation Steps"},
2835         {eRTAnimationPlay, "ANIM_PLAY", 0, "Anim Play", "Animation Playback"},
2836         {eRTUndo, "UNDO", 0, "Undo/Redo", "Undo/Redo"},
2837         {0, NULL, 0, NULL, NULL}
2838 };
2839
2840
2841 static void redraw_timer_step(
2842         bContext *C, Main *bmain, Scene *scene,
2843         struct Depsgraph *depsgraph,
2844         wmWindow *win, ScrArea *sa, ARegion *ar,
2845         const int type, const int cfra)
2846 {
2847         if (type == eRTDrawRegion) {
2848                 if (ar) {
2849                         ED_region_do_draw(C, ar);
2850                         ar->do_draw = false;
2851                 }
2852         }
2853         else if (type == eRTDrawRegionSwap) {
2854                 CTX_wm_menu_set(C, NULL);
2855
2856                 ED_region_tag_redraw(ar);
2857                 wm_draw_update(C);
2858
2859                 CTX_wm_window_set(C, win);  /* XXX context manipulation warning! */
2860         }
2861         else if (type == eRTDrawWindow) {
2862                 bScreen *screen = WM_window_get_active_screen(win);
2863                 ScrArea *sa_iter;
2864
2865                 CTX_wm_menu_set(C, NULL);
2866
2867                 for (sa_iter = screen->areabase.first; sa_iter; sa_iter = sa_iter->next) {
2868                         ARegion *ar_iter;
2869                         CTX_wm_area_set(C, sa_iter);
2870
2871                         for (ar_iter = sa_iter->regionbase.first; ar_iter; ar_iter = ar_iter->next) {
2872                                 if (ar_iter->visible) {
2873                                         CTX_wm_region_set(C, ar_iter);
2874                                         ED_region_do_draw(C, ar_iter);
2875                                         ar_iter->do_draw = false;
2876                                 }
2877                         }
2878                 }
2879
2880                 CTX_wm_window_set(C, win);  /* XXX context manipulation warning! */
2881
2882                 CTX_wm_area_set(C, sa);
2883                 CTX_wm_region_set(C, ar);
2884         }
2885         else if (type == eRTDrawWindowSwap) {
2886                 redraw_timer_window_swap(C);
2887         }
2888         else if (type == eRTAnimationStep) {
2889                 scene->r.cfra += (cfra == scene->r.cfra) ? 1 : -1;
2890                 BKE_scene_graph_update_for_newframe(depsgraph, bmain);
2891         }
2892         else if (type == eRTAnimationPlay) {
2893                 /* play anim, return on same frame as started with */
2894                 int tot = (scene->r.efra - scene->r.sfra) + 1;
2895
2896                 while (tot--) {
2897                         /* todo, ability to escape! */
2898                         scene->r.cfra++;
2899                         if (scene->r.cfra > scene->r.efra)
2900                                 scene->r.cfra = scene->r.sfra;
2901
2902                         BKE_scene_graph_update_for_newframe(depsgraph, bmain);
2903                         redraw_timer_window_swap(C);
2904                 }
2905         }
2906         else { /* eRTUndo */
2907                 ED_undo_pop(C);
2908                 ED_undo_redo(C);
2909         }
2910 }
2911
2912 static int redraw_timer_exec(bContext *C, wmOperator *op)
2913 {
2914         Main *bmain = CTX_data_main(C);
2915         Scene *scene = CTX_data_scene(C);
2916         wmWindow *win = CTX_wm_window(C);
2917         ScrArea *sa = CTX_wm_area(C);
2918         ARegion *ar = CTX_wm_region(C);
2919         double time_start, time_delta;
2920         const int type = RNA_enum_get(op->ptr, "type");
2921         const int iter = RNA_int_get(op->ptr, "iterations");
2922         const double time_limit = (double)RNA_float_get(op->ptr, "time_limit");
2923         const int cfra = scene->r.cfra;
2924         int a, iter_steps = 0;
2925         const char *infostr = "";
2926         struct Depsgraph *depsgraph = CTX_data_depsgraph(C);
2927
2928         WM_cursor_wait(1);
2929
2930         time_start = PIL_check_seconds_timer();
2931
2932         for (a = 0; a < iter; a++) {
2933                 redraw_timer_step(C, bmain, scene, depsgraph, win, sa, ar, type, cfra);
2934                 iter_steps += 1;
2935
2936                 if (time_limit != 0.0) {
2937                         if ((PIL_check_seconds_timer() - time_start) > time_limit) {
2938                                 break;
2939                         }
2940                         a = 0;
2941                 }
2942         }
2943
2944         time_delta = (PIL_check_seconds_timer() - time_start) * 1000;
2945
2946         RNA_enum_description(redraw_timer_type_items, type, &infostr);
2947
2948         WM_cursor_wait(0);
2949
2950         BKE_reportf(op->reports, RPT_WARNING,
2951                     "%d x %s: %.4f ms, average: %.8f ms",
2952                     iter_steps, infostr, time_delta, time_delta / iter_steps);
2953
2954         return OPERATOR_FINISHED;
2955 }
2956
2957 static void WM_OT_redraw_timer(wmOperatorType *ot)
2958 {
2959         ot->name = "Redraw Timer";
2960         ot->idname = "WM_OT_redraw_timer";
2961         ot->description = "Simple redraw timer to test the speed of updating the interface";
2962
2963         ot->invoke = WM_menu_invoke;
2964         ot->exec = redraw_timer_exec;
2965         ot->poll = WM_operator_winactive;
2966
2967         ot->prop = RNA_def_enum(ot->srna, "type", redraw_timer_type_items, eRTDrawRegion, "Type", "");
2968         RNA_def_int(ot->srna, "iterations", 10, 1, INT_MAX, "Iterations", "Number of times to redraw", 1, 1000);
2969         RNA_def_float(ot->srna, "time_limit", 0.0, 0.0, FLT_MAX,
2970                       "Time Limit", "Seconds to run the test for (override iterations)", 0.0, 60.0);
2971
2972 }
2973
2974 /* ************************** memory statistics for testing ***************** */
2975
2976 static int memory_statistics_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
2977 {
2978         MEM_printmemlist_stats();
2979         return OPERATOR_FINISHED;
2980 }
2981
2982 static void WM_OT_memory_statistics(wmOperatorType *ot)
2983 {
2984         ot->name = "Memory Statistics";
2985         ot->idname = "WM_OT_memory_statistics";
2986         ot->description = "Print memory statistics to the console";
2987
2988         ot->exec = memory_statistics_exec;
2989 }
2990
2991 /* *************************** Mat/tex/etc. previews generation ************* */
2992
2993 typedef struct PreviewsIDEnsureData {
2994         bContext *C;
2995         Scene *scene;
2996 } PreviewsIDEnsureData;
2997
2998 static void previews_id_ensure(bContext *C, Scene *scene, ID *id)
2999 {
3000         BLI_assert(ELEM(GS(id->name), ID_MA, ID_TE, ID_IM, ID_WO, ID_LA));
3001
3002         /* Only preview non-library datablocks, lib ones do not pertain to this .blend file!
3003          * Same goes for ID with no user. */
3004         if (!ID_IS_LINKED(id) && (id->us != 0)) {
3005                 UI_id_icon_render(C, scene, id, false, false);
3006                 UI_id_icon_render(C, scene, id, true, false);
3007         }
3008 }
3009
3010 static int previews_id_ensure_callback(void *userdata, ID *UNUSED(self_id), ID **idptr, int cb_flag)
3011 {
3012         if (cb_flag & IDWALK_CB_PRIVATE) {
3013                 return IDWALK_RET_NOP;
3014         }
3015
3016         PreviewsIDEnsureData *data = userdata;
3017         ID *id = *idptr;
3018
3019         if (id && (id->tag & LIB_TAG_DOIT)) {
3020                 BLI_assert(ELEM(GS(id->name), ID_MA, ID_TE, ID_IM, ID_WO, ID_LA));
3021                 previews_id_ensure(data->C, data->scene, id);
3022                 id->tag &= ~LIB_TAG_DOIT;
3023         }
3024
3025         return IDWALK_RET_NOP;
3026 }
3027
3028 static int previews_ensure_exec(bContext *C, wmOperator *UNUSED(op))
3029 {
3030         Main *bmain = CTX_data_main(C);
3031         ListBase *lb[] = {&bmain->mat, &bmain->tex, &bmain->image, &bmain->world, &bmain->lamp, NULL};
3032         PreviewsIDEnsureData preview_id_data;
3033         Scene *scene;
3034         ID *id;
3035         int i;
3036
3037         /* We use LIB_TAG_DOIT to check whether we have already handled a given ID or not. */
3038         BKE_main_id_tag_all(bmain, LIB_TAG_DOIT, false);
3039         for (i = 0; lb[i]; i++) {
3040                 BKE_main_id_tag_listbase(lb[i], LIB_TAG_DOIT, true);
3041         }
3042
3043         preview_id_data.C = C;
3044         for (scene = bmain->scene.first; scene; scene = scene->id.next) {
3045                 preview_id_data.scene = scene;
3046                 id = (ID *)scene;
3047
3048                 BKE_library_foreach_ID_link(NULL, id, previews_id_ensure_callback, &preview_id_data, IDWALK_RECURSE);
3049         }
3050
3051         /* Check a last time for ID not used (fake users only, in theory), and
3052          * do our best for those, using current scene... */
3053         for (i = 0; lb[i]; i++) {
3054                 for (id = lb[i]->first; id; id = id->next) {
3055                         if (id->tag & LIB_TAG_DOIT) {
3056                                 previews_id_ensure(C, NULL, id);
3057                                 id->tag &= ~LIB_TAG_DOIT;
3058                         }
3059                 }
3060         }
3061
3062         return OPERATOR_FINISHED;
3063 }
3064
3065 static void WM_OT_previews_ensure(wmOperatorType *ot)
3066 {
3067         ot->name = "Refresh Data-Block Previews";
3068         ot->idname = "WM_OT_previews_ensure";
3069         ot->description = "Ensure data-block previews are available and up-to-date "
3070                           "(to be saved in .blend file, only for some types like materials, textures, etc.)";
3071
3072         ot->exec = previews_ensure_exec;
3073 }
3074
3075 /* *************************** Datablocks previews clear ************* */
3076
3077 /* Only types supporting previews currently. */
3078 static const EnumPropertyItem preview_id_type_items[] = {
3079     {FILTER_ID_SCE, "SCENE", 0, "Scenes", ""},
3080     {FILTER_ID_GR, "GROUP", 0, "Groups", ""},
3081     {FILTER_ID_OB, "OBJECT", 0, "Objects", ""},
3082     {FILTER_ID_MA, "MATERIAL", 0, "Materials", ""},
3083     {FILTER_ID_LA, "LIGHT", 0, "Lights", ""},
3084     {FILTER_ID_WO, "WORLD", 0, "Worlds", ""},
3085     {FILTER_ID_TE, "TEXTURE", 0, "Textures", ""},
3086     {FILTER_ID_IM, "IMAGE", 0, "Images", ""},
3087 #if 0  /* XXX TODO */
3088     {FILTER_ID_BR, "BRUSH", 0, "Brushes", ""},
3089 #endif
3090     {0, NULL, 0, NULL, NULL}
3091 };
3092
3093 static int previews_clear_exec(bContext *C, wmOperator *op)
3094 {
3095         Main *bmain = CTX_data_main(C);
3096         ListBase *lb[] = {&bmain->object, &bmain->collection,
3097                           &bmain->mat, &bmain->world, &bmain->lamp, &bmain->tex, &bmain->image, NULL};
3098         int i;
3099
3100         const int id_filters = RNA_enum_get(op->ptr, "id_type");
3101
3102         for (i = 0; lb[i]; i++) {
3103                 ID *id = lb[i]->first;
3104
3105                 if (!id) continue;
3106
3107 //              printf("%s: %d, %d, %d -> %d\n", id->name, GS(id->name), BKE_idcode_to_idfilter(GS(id->name)),
3108 //                                               id_filters, BKE_idcode_to_idfilter(GS(id->name)) & id_filters);
3109
3110                 if (!id || !(BKE_idcode_to_idfilter(GS(id->name)) & id_filters)) {
3111                         continue;
3112                 }
3113
3114                 for (; id; id = id->next) {
3115                         PreviewImage *prv_img = BKE_previewimg_id_ensure(id);
3116
3117                         BKE_previewimg_clear(prv_img);
3118                 }
3119         }
3120
3121         return OPERATOR_FINISHED;
3122 }
3123
3124 static void WM_OT_previews_clear(wmOperatorType *ot)
3125 {
3126         ot->name = "Clear Data-Block Previews";
3127         ot->idname = "WM_OT_previews_clear";
3128         ot->description = "Clear data-block previews (only for some types like objects, materials, textures, etc.)";
3129
3130         ot->exec = previews_clear_exec;
3131         ot->invoke = WM_menu_invoke;
3132
3133         ot->prop = RNA_def_enum_flag(ot->srna, "id_type", preview_id_type_items,
3134                                      FILTER_ID_SCE | FILTER_ID_OB | FILTER_ID_GR |
3135                                      FILTER_ID_MA | FILTER_ID_LA | FILTER_ID_WO | FILTER_ID_TE | FILTER_ID_IM,
3136                                      "Data-Block Type", "Which data-block previews to clear");
3137 }
3138
3139 /* *************************** Doc from UI ************* */
3140
3141 static int doc_view_manual_ui_context_exec(bContext *C, wmOperator *UNUSED(op))
3142 {
3143         PointerRNA ptr_props;
3144         char buf[512];
3145         short retval = OPERATOR_CANCELLED;
3146
3147         if (UI_but_online_manual_id_from_active(C, buf, sizeof(buf))) {
3148                 WM_operator_properties_create(&ptr_props, "WM_OT_doc_view_manual");
3149                 RNA_string_set(&ptr_props, "doc_id", buf);
3150
3151                 retval = WM_operator_name_call_ptr(
3152                         C, WM_operatortype_find("WM_OT_doc_view_manual", false),
3153                         WM_OP_EXEC_DEFAULT, &ptr_props);
3154
3155                 WM_operator_properties_free(&ptr_props);
3156         }
3157