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