Cleanup: comment line length (windowmanager)
[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     MEM_freeN(properties);
695     ptr->data = NULL; /* just in case */
696   }
697 }
698
699 /* ************ default op callbacks, exported *********** */
700
701 void WM_operator_view3d_unit_defaults(struct bContext *C, struct wmOperator *op)
702 {
703   if (op->flag & OP_IS_INVOKE) {
704     Scene *scene = CTX_data_scene(C);
705     View3D *v3d = CTX_wm_view3d(C);
706
707     const float dia = v3d ? ED_view3d_grid_scale(scene, v3d, NULL) :
708                             ED_scene_grid_scale(scene, NULL);
709
710     /* always run, so the values are initialized,
711      * otherwise we may get differ behavior when (dia != 1.0) */
712     RNA_STRUCT_BEGIN (op->ptr, prop) {
713       if (RNA_property_type(prop) == PROP_FLOAT) {
714         PropertySubType pstype = RNA_property_subtype(prop);
715         if (pstype == PROP_DISTANCE) {
716           /* we don't support arrays yet */
717           BLI_assert(RNA_property_array_check(prop) == false);
718           /* initialize */
719           if (!RNA_property_is_set_ex(op->ptr, prop, false)) {
720             const float value = RNA_property_float_get_default(op->ptr, prop) * dia;
721             RNA_property_float_set(op->ptr, prop, value);
722           }
723         }
724       }
725     }
726     RNA_STRUCT_END;
727   }
728 }
729
730 int WM_operator_smooth_viewtx_get(const wmOperator *op)
731 {
732   return (op->flag & OP_IS_INVOKE) ? U.smooth_viewtx : 0;
733 }
734
735 /* invoke callback, uses enum property named "type" */
736 int WM_menu_invoke_ex(bContext *C, wmOperator *op, int opcontext)
737 {
738   PropertyRNA *prop = op->type->prop;
739   uiPopupMenu *pup;
740   uiLayout *layout;
741
742   if (prop == NULL) {
743     CLOG_ERROR(WM_LOG_OPERATORS, "'%s' has no enum property set", op->type->idname);
744   }
745   else if (RNA_property_type(prop) != PROP_ENUM) {
746     CLOG_ERROR(WM_LOG_OPERATORS,
747                "'%s', '%s' is not an enum property",
748                op->type->idname,
749                RNA_property_identifier(prop));
750   }
751   else if (RNA_property_is_set(op->ptr, prop)) {
752     const int retval = op->type->exec(C, op);
753     OPERATOR_RETVAL_CHECK(retval);
754     return retval;
755   }
756   else {
757     pup = UI_popup_menu_begin(C, RNA_struct_ui_name(op->type->srna), ICON_NONE);
758     layout = UI_popup_menu_layout(pup);
759     /* set this so the default execution context is the same as submenus */
760     uiLayoutSetOperatorContext(layout, opcontext);
761     uiItemsFullEnumO(
762         layout, op->type->idname, RNA_property_identifier(prop), op->ptr->data, opcontext, 0);
763     UI_popup_menu_end(C, pup);
764     return OPERATOR_INTERFACE;
765   }
766
767   return OPERATOR_CANCELLED;
768 }
769
770 int WM_menu_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
771 {
772   return WM_menu_invoke_ex(C, op, WM_OP_INVOKE_REGION_WIN);
773 }
774
775 struct EnumSearchMenu {
776   wmOperator *op; /* the operator that will be executed when selecting an item */
777
778   bool use_previews;
779   short prv_cols, prv_rows;
780 };
781
782 /** Generic enum search invoke popup. */
783 static uiBlock *wm_enum_search_menu(bContext *C, ARegion *ar, void *arg)
784 {
785   struct EnumSearchMenu *search_menu = arg;
786   wmWindow *win = CTX_wm_window(C);
787   wmOperator *op = search_menu->op;
788   /* template_ID uses 4 * widget_unit for width,
789    * we use a bit more, some items may have a suffix to show. */
790   const int width = search_menu->use_previews ? 5 * U.widget_unit * search_menu->prv_cols :
791                                                 UI_searchbox_size_x();
792   const int height = search_menu->use_previews ? 5 * U.widget_unit * search_menu->prv_rows :
793                                                  UI_searchbox_size_y();
794   static char search[256] = "";
795   uiBlock *block;
796   uiBut *but;
797
798   block = UI_block_begin(C, ar, "_popup", UI_EMBOSS);
799   UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_MOVEMOUSE_QUIT | UI_BLOCK_SEARCH_MENU);
800   UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_POPUP);
801
802   search[0] = '\0';
803   BLI_assert(search_menu->use_previews ||
804              (search_menu->prv_cols == 0 && search_menu->prv_rows == 0));
805 #if 0 /* ok, this isn't so easy... */
806   uiDefBut(block,
807            UI_BTYPE_LABEL,
808            0,
809            RNA_struct_ui_name(op->type->srna),
810            10,
811            10,
812            UI_searchbox_size_x(),
813            UI_UNIT_Y,
814            NULL,
815            0.0,
816            0.0,
817            0,
818            0,
819            "");
820 #endif
821   but = uiDefSearchButO_ptr(block,
822                             op->type,
823                             op->ptr->data,
824                             search,
825                             0,
826                             ICON_VIEWZOOM,
827                             sizeof(search),
828                             10,
829                             10,
830                             width,
831                             UI_UNIT_Y,
832                             search_menu->prv_rows,
833                             search_menu->prv_cols,
834                             "");
835
836   /* fake button, it holds space for search items */
837   uiDefBut(block,
838            UI_BTYPE_LABEL,
839            0,
840            "",
841            10,
842            10 - UI_searchbox_size_y(),
843            width,
844            height,
845            NULL,
846            0,
847            0,
848            0,
849            0,
850            NULL);
851
852   /* Move it downwards, mouse over button. */
853   UI_block_bounds_set_popup(block, 6, (const int[2]){0, -UI_UNIT_Y});
854
855   UI_but_focus_on_enter_event(win, but);
856
857   return block;
858 }
859
860 /**
861  * Similar to #WM_enum_search_invoke, but draws previews. Also, this can't
862  * be used as invoke callback directly since it needs additional info.
863  */
864 int WM_enum_search_invoke_previews(bContext *C, wmOperator *op, short prv_cols, short prv_rows)
865 {
866   static struct EnumSearchMenu search_menu;
867
868   search_menu.op = op;
869   search_menu.use_previews = true;
870   search_menu.prv_cols = prv_cols;
871   search_menu.prv_rows = prv_rows;
872
873   UI_popup_block_invoke(C, wm_enum_search_menu, &search_menu);
874
875   return OPERATOR_INTERFACE;
876 }
877
878 int WM_enum_search_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
879 {
880   static struct EnumSearchMenu search_menu;
881   search_menu.op = op;
882   UI_popup_block_invoke(C, wm_enum_search_menu, &search_menu);
883   return OPERATOR_INTERFACE;
884 }
885
886 /* Can't be used as an invoke directly, needs message arg (can be NULL) */
887 int WM_operator_confirm_message_ex(
888     bContext *C, wmOperator *op, const char *title, const int icon, const char *message)
889 {
890   uiPopupMenu *pup;
891   uiLayout *layout;
892   IDProperty *properties = op->ptr->data;
893
894   if (properties && properties->len) {
895     properties = IDP_CopyProperty(op->ptr->data);
896   }
897   else {
898     properties = NULL;
899   }
900
901   pup = UI_popup_menu_begin(C, title, icon);
902   layout = UI_popup_menu_layout(pup);
903   uiItemFullO_ptr(
904       layout, op->type, message, ICON_NONE, properties, WM_OP_EXEC_REGION_WIN, 0, NULL);
905   UI_popup_menu_end(C, pup);
906
907   return OPERATOR_INTERFACE;
908 }
909
910 int WM_operator_confirm_message(bContext *C, wmOperator *op, const char *message)
911 {
912   return WM_operator_confirm_message_ex(C, op, IFACE_("OK?"), ICON_QUESTION, message);
913 }
914
915 int WM_operator_confirm(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
916 {
917   return WM_operator_confirm_message(C, op, NULL);
918 }
919
920 int WM_operator_confirm_or_exec(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
921 {
922   const bool confirm = RNA_boolean_get(op->ptr, "confirm");
923   if (confirm) {
924     return WM_operator_confirm_message(C, op, NULL);
925   }
926   else {
927     return op->type->exec(C, op);
928   }
929 }
930
931 /* op->invoke, opens fileselect if path property not set, otherwise executes */
932 int WM_operator_filesel(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
933 {
934   if (RNA_struct_property_is_set(op->ptr, "filepath")) {
935     return WM_operator_call_notest(C, op); /* call exec direct */
936   }
937   else {
938     WM_event_add_fileselect(C, op);
939     return OPERATOR_RUNNING_MODAL;
940   }
941 }
942
943 bool WM_operator_filesel_ensure_ext_imtype(wmOperator *op, const struct ImageFormatData *im_format)
944 {
945   PropertyRNA *prop;
946   char filepath[FILE_MAX];
947   /* dont NULL check prop, this can only run on ops with a 'filepath' */
948   prop = RNA_struct_find_property(op->ptr, "filepath");
949   RNA_property_string_get(op->ptr, prop, filepath);
950   if (BKE_image_path_ensure_ext_from_imformat(filepath, im_format)) {
951     RNA_property_string_set(op->ptr, prop, filepath);
952     /* note, we could check for and update 'filename' here,
953      * but so far nothing needs this. */
954     return true;
955   }
956   return false;
957 }
958
959 /* op->poll */
960 bool WM_operator_winactive(bContext *C)
961 {
962   if (CTX_wm_window(C) == NULL) {
963     return 0;
964   }
965   return 1;
966 }
967
968 /* return false, if the UI should be disabled */
969 bool WM_operator_check_ui_enabled(const bContext *C, const char *idname)
970 {
971   wmWindowManager *wm = CTX_wm_manager(C);
972   Scene *scene = CTX_data_scene(C);
973
974   return !((ED_undo_is_valid(C, idname) == false) || WM_jobs_test(wm, scene, WM_JOB_TYPE_ANY));
975 }
976
977 wmOperator *WM_operator_last_redo(const bContext *C)
978 {
979   wmWindowManager *wm = CTX_wm_manager(C);
980   wmOperator *op;
981
982   /* only for operators that are registered and did an undo push */
983   for (op = wm->operators.last; op; op = op->prev) {
984     if ((op->type->flag & OPTYPE_REGISTER) && (op->type->flag & OPTYPE_UNDO)) {
985       break;
986     }
987   }
988
989   return op;
990 }
991
992 IDProperty *WM_operator_last_properties_ensure_idprops(wmOperatorType *ot)
993 {
994   if (ot->last_properties == NULL) {
995     IDPropertyTemplate val = {0};
996     ot->last_properties = IDP_New(IDP_GROUP, &val, "wmOperatorProperties");
997   }
998   return ot->last_properties;
999 }
1000
1001 void WM_operator_last_properties_ensure(wmOperatorType *ot, PointerRNA *ptr)
1002 {
1003   IDProperty *props = WM_operator_last_properties_ensure_idprops(ot);
1004   RNA_pointer_create(NULL, ot->srna, props, ptr);
1005 }
1006
1007 /**
1008  * Use for drag & drop a path or name with operators invoke() function.
1009  */
1010 ID *WM_operator_drop_load_path(struct bContext *C, wmOperator *op, const short idcode)
1011 {
1012   Main *bmain = CTX_data_main(C);
1013   ID *id = NULL;
1014   /* check input variables */
1015   if (RNA_struct_property_is_set(op->ptr, "filepath")) {
1016     const bool is_relative_path = RNA_boolean_get(op->ptr, "relative_path");
1017     char path[FILE_MAX];
1018     bool exists = false;
1019
1020     RNA_string_get(op->ptr, "filepath", path);
1021
1022     errno = 0;
1023
1024     if (idcode == ID_IM) {
1025       id = (ID *)BKE_image_load_exists_ex(bmain, path, &exists);
1026     }
1027     else {
1028       BLI_assert(0);
1029     }
1030
1031     if (!id) {
1032       BKE_reportf(op->reports,
1033                   RPT_ERROR,
1034                   "Cannot read %s '%s': %s",
1035                   BKE_idcode_to_name(idcode),
1036                   path,
1037                   errno ? strerror(errno) : TIP_("unsupported format"));
1038       return NULL;
1039     }
1040
1041     if (is_relative_path) {
1042       if (exists == false) {
1043         if (idcode == ID_IM) {
1044           BLI_path_rel(((Image *)id)->name, BKE_main_blendfile_path(bmain));
1045         }
1046         else {
1047           BLI_assert(0);
1048         }
1049       }
1050     }
1051   }
1052   else if (RNA_struct_property_is_set(op->ptr, "name")) {
1053     char name[MAX_ID_NAME - 2];
1054     RNA_string_get(op->ptr, "name", name);
1055     id = BKE_libblock_find_name(bmain, idcode, name);
1056     if (!id) {
1057       BKE_reportf(op->reports, RPT_ERROR, "%s '%s' not found", BKE_idcode_to_name(idcode), name);
1058       return NULL;
1059     }
1060     id_us_plus(id);
1061   }
1062
1063   return id;
1064 }
1065
1066 static void wm_block_redo_cb(bContext *C, void *arg_op, int UNUSED(arg_event))
1067 {
1068   wmOperator *op = arg_op;
1069
1070   if (op == WM_operator_last_redo(C)) {
1071     /* operator was already executed once? undo & repeat */
1072     ED_undo_operator_repeat(C, op);
1073   }
1074   else {
1075     /* operator not executed yet, call it */
1076     ED_undo_push_op(C, op);
1077     wm_operator_register(C, op);
1078
1079     WM_operator_repeat(C, op);
1080   }
1081 }
1082
1083 static void wm_block_redo_cancel_cb(bContext *C, void *arg_op)
1084 {
1085   wmOperator *op = arg_op;
1086
1087   /* if operator never got executed, free it */
1088   if (op != WM_operator_last_redo(C)) {
1089     WM_operator_free(op);
1090   }
1091 }
1092
1093 static uiBlock *wm_block_create_redo(bContext *C, ARegion *ar, void *arg_op)
1094 {
1095   wmOperator *op = arg_op;
1096   uiBlock *block;
1097   uiLayout *layout;
1098   uiStyle *style = UI_style_get();
1099   int width = 15 * UI_UNIT_X;
1100
1101   block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
1102   UI_block_flag_disable(block, UI_BLOCK_LOOP);
1103   UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_REGULAR);
1104
1105   /* UI_BLOCK_NUMSELECT for layer buttons */
1106   UI_block_flag_enable(block, UI_BLOCK_NUMSELECT | UI_BLOCK_KEEP_OPEN | UI_BLOCK_MOVEMOUSE_QUIT);
1107
1108   /* if register is not enabled, the operator gets freed on OPERATOR_FINISHED
1109    * ui_apply_but_funcs_after calls ED_undo_operator_repeate_cb and crashes */
1110   assert(op->type->flag & OPTYPE_REGISTER);
1111
1112   UI_block_func_handle_set(block, wm_block_redo_cb, arg_op);
1113   layout = UI_block_layout(
1114       block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, width, UI_UNIT_Y, 0, style);
1115
1116   if (op == WM_operator_last_redo(C)) {
1117     if (!WM_operator_check_ui_enabled(C, op->type->name)) {
1118       uiLayoutSetEnabled(layout, false);
1119     }
1120   }
1121
1122   if (op->type->flag & OPTYPE_MACRO) {
1123     for (op = op->macro.first; op; op = op->next) {
1124       uiTemplateOperatorPropertyButs(
1125           C, layout, op, UI_BUT_LABEL_ALIGN_SPLIT_COLUMN, UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
1126       if (op->next) {
1127         uiItemS(layout);
1128       }
1129     }
1130   }
1131   else {
1132     uiTemplateOperatorPropertyButs(
1133         C, layout, op, UI_BUT_LABEL_ALIGN_SPLIT_COLUMN, UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
1134   }
1135
1136   UI_block_bounds_set_popup(block, 4, NULL);
1137
1138   return block;
1139 }
1140
1141 typedef struct wmOpPopUp {
1142   wmOperator *op;
1143   int width;
1144   int height;
1145   int free_op;
1146 } wmOpPopUp;
1147
1148 /* Only invoked by OK button in popups created with wm_block_dialog_create() */
1149 static void dialog_exec_cb(bContext *C, void *arg1, void *arg2)
1150 {
1151   wmOpPopUp *data = arg1;
1152   uiBlock *block = arg2;
1153
1154   /* Explicitly set UI_RETURN_OK flag, otherwise the menu might be canceled
1155    * in case WM_operator_call_ex exits/reloads the current file (T49199). */
1156   UI_popup_menu_retval_set(block, UI_RETURN_OK, true);
1157
1158   WM_operator_call_ex(C, data->op, true);
1159
1160   /* let execute handle freeing it */
1161   //data->free_op = false;
1162   //data->op = NULL;
1163
1164   /* in this case, wm_operator_ui_popup_cancel wont run */
1165   MEM_freeN(data);
1166
1167   /* Get context data *after* WM_operator_call_ex
1168    * which might have closed the current file and changed context. */
1169   wmWindowManager *wm = CTX_wm_manager(C);
1170   wmWindow *win = CTX_wm_window(C);
1171
1172   /* check window before 'block->handle' incase the
1173    * popup execution closed the window and freed the block. see T44688.
1174    */
1175   /* Post 2.78 TODO: Check if this fix and others related to T44688 are still
1176    * needed or can be improved now that requesting context data has been corrected
1177    * (see above). We're close to release so not a good time for experiments.
1178    * -- Julian
1179    */
1180   if (BLI_findindex(&wm->windows, win) != -1) {
1181     UI_popup_block_close(C, win, block);
1182   }
1183 }
1184
1185 /* Dialogs are popups that require user verification (click OK) before exec */
1186 static uiBlock *wm_block_dialog_create(bContext *C, ARegion *ar, void *userData)
1187 {
1188   wmOpPopUp *data = userData;
1189   wmOperator *op = data->op;
1190   uiBlock *block;
1191   uiLayout *layout;
1192   uiStyle *style = UI_style_get();
1193
1194   block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
1195   UI_block_flag_disable(block, UI_BLOCK_LOOP);
1196   UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_REGULAR);
1197
1198   /* intentionally don't use 'UI_BLOCK_MOVEMOUSE_QUIT', some dialogues have many items
1199    * where quitting by accident is very annoying */
1200   UI_block_flag_enable(block, UI_BLOCK_KEEP_OPEN | UI_BLOCK_NUMSELECT);
1201
1202   layout = UI_block_layout(
1203       block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, data->width, data->height, 0, style);
1204
1205   uiTemplateOperatorPropertyButs(
1206       C, layout, op, UI_BUT_LABEL_ALIGN_SPLIT_COLUMN, UI_TEMPLATE_OP_PROPS_SHOW_TITLE);
1207
1208   /* clear so the OK button is left alone */
1209   UI_block_func_set(block, NULL, NULL, NULL);
1210
1211   /* new column so as not to interfere with custom layouts [#26436] */
1212   {
1213     uiBlock *col_block;
1214     uiLayout *col;
1215     uiBut *btn;
1216
1217     col = uiLayoutColumn(layout, false);
1218     col_block = uiLayoutGetBlock(col);
1219     /* Create OK button, the callback of which will execute op */
1220     btn = uiDefBut(
1221         col_block, UI_BTYPE_BUT, 0, IFACE_("OK"), 0, -30, 0, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
1222     UI_but_flag_enable(btn, UI_BUT_ACTIVE_DEFAULT);
1223     UI_but_func_set(btn, dialog_exec_cb, data, col_block);
1224   }
1225
1226   /* center around the mouse */
1227   UI_block_bounds_set_popup(block, 4, (const int[2]){data->width / -2, data->height / 2});
1228
1229   UI_block_active_only_flagged_buttons(C, ar, block);
1230
1231   return block;
1232 }
1233
1234 static uiBlock *wm_operator_ui_create(bContext *C, ARegion *ar, void *userData)
1235 {
1236   wmOpPopUp *data = userData;
1237   wmOperator *op = data->op;
1238   uiBlock *block;
1239   uiLayout *layout;
1240   uiStyle *style = UI_style_get();
1241
1242   block = UI_block_begin(C, ar, __func__, UI_EMBOSS);
1243   UI_block_flag_disable(block, UI_BLOCK_LOOP);
1244   UI_block_flag_enable(block, UI_BLOCK_KEEP_OPEN | UI_BLOCK_MOVEMOUSE_QUIT);
1245   UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_REGULAR);
1246
1247   layout = UI_block_layout(
1248       block, UI_LAYOUT_VERTICAL, UI_LAYOUT_PANEL, 0, 0, data->width, data->height, 0, style);
1249
1250   /* since ui is defined the auto-layout args are not used */
1251   uiTemplateOperatorPropertyButs(C, layout, op, UI_BUT_LABEL_ALIGN_COLUMN, 0);
1252
1253   UI_block_func_set(block, NULL, NULL, NULL);
1254
1255   UI_block_bounds_set_popup(block, 4, NULL);
1256
1257   UI_block_active_only_flagged_buttons(C, ar, block);
1258
1259   return block;
1260 }
1261
1262 static void wm_operator_ui_popup_cancel(struct bContext *C, void *userData)
1263 {
1264   wmOpPopUp *data = userData;
1265   wmOperator *op = data->op;
1266
1267   if (op) {
1268     if (op->type->cancel) {
1269       op->type->cancel(C, op);
1270     }
1271
1272     if (data->free_op) {
1273       WM_operator_free(op);
1274     }
1275   }
1276
1277   MEM_freeN(data);
1278 }
1279
1280 static void wm_operator_ui_popup_ok(struct bContext *C, void *arg, int retval)
1281 {
1282   wmOpPopUp *data = arg;
1283   wmOperator *op = data->op;
1284
1285   if (op && retval > 0) {
1286     WM_operator_call_ex(C, op, true);
1287   }
1288
1289   MEM_freeN(data);
1290 }
1291
1292 int WM_operator_ui_popup(bContext *C, wmOperator *op, int width, int height)
1293 {
1294   wmOpPopUp *data = MEM_callocN(sizeof(wmOpPopUp), "WM_operator_ui_popup");
1295   data->op = op;
1296   data->width = width * U.dpi_fac;
1297   data->height = height * U.dpi_fac;
1298   data->free_op = true; /* if this runs and gets registered we may want not to free it */
1299   UI_popup_block_ex(C, wm_operator_ui_create, NULL, wm_operator_ui_popup_cancel, data, op);
1300   return OPERATOR_RUNNING_MODAL;
1301 }
1302
1303 /**
1304  * For use by #WM_operator_props_popup_call, #WM_operator_props_popup only.
1305  *
1306  * \note operator menu needs undo flag enabled, for redo callback */
1307 static int wm_operator_props_popup_ex(bContext *C,
1308                                       wmOperator *op,
1309                                       const bool do_call,
1310                                       const bool do_redo)
1311 {
1312   if ((op->type->flag & OPTYPE_REGISTER) == 0) {
1313     BKE_reportf(op->reports,
1314                 RPT_ERROR,
1315                 "Operator '%s' does not have register enabled, incorrect invoke function",
1316                 op->type->idname);
1317     return OPERATOR_CANCELLED;
1318   }
1319
1320   if (do_redo) {
1321     if ((op->type->flag & OPTYPE_UNDO) == 0) {
1322       BKE_reportf(op->reports,
1323                   RPT_ERROR,
1324                   "Operator '%s' does not have undo enabled, incorrect invoke function",
1325                   op->type->idname);
1326       return OPERATOR_CANCELLED;
1327     }
1328   }
1329
1330   /* if we don't have global undo, we can't do undo push for automatic redo,
1331    * so we require manual OK clicking in this popup */
1332   if (!do_redo || !(U.uiflag & USER_GLOBALUNDO)) {
1333     return WM_operator_props_dialog_popup(C, op, 300, 20);
1334   }
1335
1336   UI_popup_block_ex(C, wm_block_create_redo, NULL, wm_block_redo_cancel_cb, op, op);
1337
1338   if (do_call) {
1339     wm_block_redo_cb(C, op, 0);
1340   }
1341
1342   return OPERATOR_RUNNING_MODAL;
1343 }
1344
1345 /**
1346  * Same as #WM_operator_props_popup but don't use operator redo.
1347  * just wraps #WM_operator_props_dialog_popup.
1348  */
1349 int WM_operator_props_popup_confirm(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1350 {
1351   return wm_operator_props_popup_ex(C, op, false, false);
1352 }
1353
1354 /**
1355  * Same as #WM_operator_props_popup but call the operator first,
1356  * This way - the button values correspond to the result of the operator.
1357  * Without this, first access to a button will make the result jump, see T32452.
1358  */
1359 int WM_operator_props_popup_call(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1360 {
1361   return wm_operator_props_popup_ex(C, op, true, true);
1362 }
1363
1364 int WM_operator_props_popup(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1365 {
1366   return wm_operator_props_popup_ex(C, op, false, true);
1367 }
1368
1369 int WM_operator_props_dialog_popup(bContext *C, wmOperator *op, int width, int height)
1370 {
1371   wmOpPopUp *data = MEM_callocN(sizeof(wmOpPopUp), "WM_operator_props_dialog_popup");
1372
1373   data->op = op;
1374   data->width = width * U.dpi_fac;
1375   data->height = height * U.dpi_fac;
1376   data->free_op = true; /* if this runs and gets registered we may want not to free it */
1377
1378   /* op is not executed until popup OK but is clicked */
1379   UI_popup_block_ex(
1380       C, wm_block_dialog_create, wm_operator_ui_popup_ok, wm_operator_ui_popup_cancel, data, op);
1381
1382   return OPERATOR_RUNNING_MODAL;
1383 }
1384
1385 int WM_operator_redo_popup(bContext *C, wmOperator *op)
1386 {
1387   /* CTX_wm_reports(C) because operator is on stack, not active in event system */
1388   if ((op->type->flag & OPTYPE_REGISTER) == 0) {
1389     BKE_reportf(CTX_wm_reports(C),
1390                 RPT_ERROR,
1391                 "Operator redo '%s' does not have register enabled, incorrect invoke function",
1392                 op->type->idname);
1393     return OPERATOR_CANCELLED;
1394   }
1395   if (op->type->poll && op->type->poll(C) == 0) {
1396     BKE_reportf(
1397         CTX_wm_reports(C), RPT_ERROR, "Operator redo '%s': wrong context", op->type->idname);
1398     return OPERATOR_CANCELLED;
1399   }
1400
1401   UI_popup_block_invoke(C, wm_block_create_redo, op);
1402
1403   return OPERATOR_CANCELLED;
1404 }
1405
1406 /* ***************** Debug menu ************************* */
1407
1408 static int wm_debug_menu_exec(bContext *C, wmOperator *op)
1409 {
1410   G.debug_value = RNA_int_get(op->ptr, "debug_value");
1411   ED_screen_refresh(CTX_wm_manager(C), CTX_wm_window(C));
1412   WM_event_add_notifier(C, NC_WINDOW, NULL);
1413
1414   return OPERATOR_FINISHED;
1415 }
1416
1417 static int wm_debug_menu_invoke(bContext *C, wmOperator *op, const wmEvent *UNUSED(event))
1418 {
1419   RNA_int_set(op->ptr, "debug_value", G.debug_value);
1420   return WM_operator_props_dialog_popup(C, op, 180, 20);
1421 }
1422
1423 static void WM_OT_debug_menu(wmOperatorType *ot)
1424 {
1425   ot->name = "Debug Menu";
1426   ot->idname = "WM_OT_debug_menu";
1427   ot->description = "Open a popup to set the debug level";
1428
1429   ot->invoke = wm_debug_menu_invoke;
1430   ot->exec = wm_debug_menu_exec;
1431   ot->poll = WM_operator_winactive;
1432
1433   RNA_def_int(ot->srna, "debug_value", 0, SHRT_MIN, SHRT_MAX, "Debug Value", "", -10000, 10000);
1434 }
1435
1436 /* ***************** Operator defaults ************************* */
1437 static int wm_operator_defaults_exec(bContext *C, wmOperator *op)
1438 {
1439   PointerRNA ptr = CTX_data_pointer_get_type(C, "active_operator", &RNA_Operator);
1440
1441   if (!ptr.data) {
1442     BKE_report(op->reports, RPT_ERROR, "No operator in context");
1443     return OPERATOR_CANCELLED;
1444   }
1445
1446   WM_operator_properties_reset((wmOperator *)ptr.data);
1447   return OPERATOR_FINISHED;
1448 }
1449
1450 /* used by operator preset menu. pre-2.65 this was a 'Reset' button */
1451 static void WM_OT_operator_defaults(wmOperatorType *ot)
1452 {
1453   ot->name = "Restore Defaults";
1454   ot->idname = "WM_OT_operator_defaults";
1455   ot->description = "Set the active operator to its default values";
1456
1457   ot->exec = wm_operator_defaults_exec;
1458
1459   ot->flag = OPTYPE_INTERNAL;
1460 }
1461
1462 /* ***************** Splash Screen ************************* */
1463
1464 static void wm_block_splash_close(bContext *C, void *arg_block, void *UNUSED(arg))
1465 {
1466   wmWindow *win = CTX_wm_window(C);
1467   UI_popup_block_close(C, win, arg_block);
1468 }
1469
1470 static uiBlock *wm_block_create_splash(bContext *C, ARegion *ar, void *arg_unused);
1471
1472 static void wm_block_splash_refreshmenu(bContext *C, void *UNUSED(arg_block), void *UNUSED(arg))
1473 {
1474   ARegion *ar_menu = CTX_wm_menu(C);
1475   ED_region_tag_refresh_ui(ar_menu);
1476 }
1477
1478 static uiBlock *wm_block_create_splash(bContext *C, ARegion *ar, void *UNUSED(arg))
1479 {
1480   uiBlock *block;
1481   uiBut *but;
1482   uiStyle *style = UI_style_get();
1483
1484 #ifndef WITH_HEADLESS
1485   extern char datatoc_splash_png[];
1486   extern int datatoc_splash_png_size;
1487
1488   extern char datatoc_splash_2x_png[];
1489   extern int datatoc_splash_2x_png_size;
1490   ImBuf *ibuf;
1491 #else
1492   ImBuf *ibuf = NULL;
1493 #endif
1494
1495 #ifdef WITH_BUILDINFO
1496   int label_delta = 0;
1497   int hash_width, date_width;
1498   char date_buf[128] = "\0";
1499   char hash_buf[128] = "\0";
1500   extern unsigned long build_commit_timestamp;
1501   extern char build_hash[], build_commit_date[], build_commit_time[], build_branch[];
1502
1503   /* Builds made from tag only shows tag sha */
1504   BLI_snprintf(hash_buf, sizeof(hash_buf), "Hash: %s", build_hash);
1505   BLI_snprintf(date_buf, sizeof(date_buf), "Date: %s %s", build_commit_date, build_commit_time);
1506
1507   BLF_size(style->widgetlabel.uifont_id, style->widgetlabel.points, U.pixelsize * U.dpi);
1508   hash_width = (int)BLF_width(style->widgetlabel.uifont_id, hash_buf, sizeof(hash_buf)) +
1509                U.widget_unit;
1510   date_width = (int)BLF_width(style->widgetlabel.uifont_id, date_buf, sizeof(date_buf)) +
1511                U.widget_unit;
1512 #endif /* WITH_BUILDINFO */
1513
1514 #ifndef WITH_HEADLESS
1515   if (U.dpi_fac > 1.0) {
1516     ibuf = IMB_ibImageFromMemory((const uchar *)datatoc_splash_2x_png,
1517                                  datatoc_splash_2x_png_size,
1518                                  IB_rect,
1519                                  NULL,
1520                                  "<splash screen>");
1521   }
1522   else {
1523     ibuf = IMB_ibImageFromMemory((const uchar *)datatoc_splash_png,
1524                                  datatoc_splash_png_size,
1525                                  IB_rect,
1526                                  NULL,
1527                                  "<splash screen>");
1528   }
1529
1530   /* overwrite splash with template image */
1531   if (U.app_template[0] != '\0') {
1532     ImBuf *ibuf_template = NULL;
1533     char splash_filepath[FILE_MAX];
1534     char template_directory[FILE_MAX];
1535
1536     if (BKE_appdir_app_template_id_search(
1537             U.app_template, template_directory, sizeof(template_directory))) {
1538       BLI_join_dirfile(splash_filepath,
1539                        sizeof(splash_filepath),
1540                        template_directory,
1541                        (U.pixelsize == 2) ? "splash_2x.png" : "splash.png");
1542       ibuf_template = IMB_loadiffname(splash_filepath, IB_rect, NULL);
1543       if (ibuf_template) {
1544         const int x_expect = ibuf->x;
1545         const int y_expect = 250 * (int)U.dpi_fac;
1546         /* don't cover the header text */
1547         if (ibuf_template->x == x_expect && ibuf_template->y == y_expect) {
1548           memcpy(ibuf->rect,
1549                  ibuf_template->rect,
1550                  ibuf_template->x * ibuf_template->y * sizeof(char[4]));
1551         }
1552         else {
1553           CLOG_ERROR(WM_LOG_OPERATORS,
1554                      "Splash expected %dx%d found %dx%d, ignoring: %s\n",
1555                      x_expect,
1556                      y_expect,
1557                      ibuf_template->x,
1558                      ibuf_template->y,
1559                      splash_filepath);
1560         }
1561         IMB_freeImBuf(ibuf_template);
1562       }
1563     }
1564   }
1565 #endif
1566
1567   block = UI_block_begin(C, ar, "splash", UI_EMBOSS);
1568
1569   /* note on UI_BLOCK_NO_WIN_CLIP, the window size is not always synchronized
1570    * with the OS when the splash shows, window clipping in this case gives
1571    * ugly results and clipping the splash isn't useful anyway, just disable it [#32938] */
1572   UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_KEEP_OPEN | UI_BLOCK_NO_WIN_CLIP);
1573   UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_POPUP);
1574
1575   but = uiDefBut(block,
1576                  UI_BTYPE_IMAGE,
1577                  0,
1578                  "",
1579                  0,
1580                  0.5f * U.widget_unit,
1581                  U.dpi_fac * 501,
1582                  U.dpi_fac * 250,
1583                  ibuf,
1584                  0.0,
1585                  0.0,
1586                  0,
1587                  0,
1588                  ""); /* button owns the imbuf now */
1589   UI_but_func_set(but, wm_block_splash_close, block, NULL);
1590   UI_block_func_set(block, wm_block_splash_refreshmenu, block, NULL);
1591
1592   /* label for 'a' bugfix releases, or 'Release Candidate 1'...
1593    * avoids recreating splash for version updates */
1594   const char *version_suffix = NULL;
1595
1596   if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "alpha")) {
1597     version_suffix = " Alpha";
1598   }
1599   else if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "beta")) {
1600     version_suffix = " Beta";
1601   }
1602   else if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "rc")) {
1603     version_suffix = " Release Candidate";
1604   }
1605   else if (STREQ(STRINGIFY(BLENDER_VERSION_CYCLE), "release")) {
1606     version_suffix = STRINGIFY(BLENDER_VERSION_CHAR);
1607   }
1608
1609   char *version = BLI_sprintfN(
1610       "Version %d.%d%s", BLENDER_VERSION / 100, BLENDER_VERSION % 100, version_suffix);
1611
1612   if (version != NULL && version[0]) {
1613     /* placed after the version number in the image,
1614      * placing y is tricky to match baseline */
1615     /* hack to have text draw 'text_sel' */
1616     UI_block_emboss_set(block, UI_EMBOSS_NONE);
1617     int x = 202 * U.dpi_fac;
1618     int y = 130 * U.dpi_fac;
1619     int w = 240 * U.dpi_fac;
1620
1621     but = uiDefBut(block, UI_BTYPE_LABEL, 0, version, x, y, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, NULL);
1622     /* XXX, set internal flag - UI_SELECT */
1623     UI_but_flag_enable(but, 1);
1624     UI_block_emboss_set(block, UI_EMBOSS);
1625   }
1626
1627   MEM_freeN(version);
1628
1629 #ifdef WITH_BUILDINFO
1630   if (build_commit_timestamp != 0) {
1631     but = uiDefBut(block,
1632                    UI_BTYPE_LABEL,
1633                    0,
1634                    date_buf,
1635                    U.dpi_fac * 502 - date_width,
1636                    U.dpi_fac * 237,
1637                    date_width,
1638                    UI_UNIT_Y,
1639                    NULL,
1640                    0,
1641                    0,
1642                    0,
1643                    0,
1644                    NULL);
1645     /* XXX, set internal flag - UI_SELECT */
1646     UI_but_flag_enable(but, 0);
1647     label_delta = 12;
1648   }
1649   but = uiDefBut(block,
1650                  UI_BTYPE_LABEL,
1651                  0,
1652                  hash_buf,
1653                  U.dpi_fac * 502 - hash_width,
1654                  U.dpi_fac * (237 - label_delta),
1655                  hash_width,
1656                  UI_UNIT_Y,
1657                  NULL,
1658                  0,
1659                  0,
1660                  0,
1661                  0,
1662                  NULL);
1663   /* XXX, set internal flag - UI_SELECT */
1664   UI_but_flag_enable(but, 0);
1665
1666   if (!STREQ(build_branch, "master")) {
1667     char branch_buf[128] = "\0";
1668     int branch_width;
1669     BLI_snprintf(branch_buf, sizeof(branch_buf), "Branch: %s", build_branch);
1670     branch_width = (int)BLF_width(style->widgetlabel.uifont_id, branch_buf, sizeof(branch_buf)) +
1671                    U.widget_unit;
1672     but = uiDefBut(block,
1673                    UI_BTYPE_LABEL,
1674                    0,
1675                    branch_buf,
1676                    U.dpi_fac * 502 - branch_width,
1677                    U.dpi_fac * (225 - label_delta),
1678                    branch_width,
1679                    UI_UNIT_Y,
1680                    NULL,
1681                    0,
1682                    0,
1683                    0,
1684                    0,
1685                    NULL);
1686     /* XXX, set internal flag - UI_SELECT */
1687     UI_but_flag_enable(but, 0);
1688   }
1689 #endif /* WITH_BUILDINFO */
1690
1691   uiLayout *layout = UI_block_layout(block,
1692                                      UI_LAYOUT_VERTICAL,
1693                                      UI_LAYOUT_PANEL,
1694                                      U.dpi_fac * 40,
1695                                      0,
1696                                      U.dpi_fac * 450,
1697                                      U.dpi_fac * 110,
1698                                      0,
1699                                      style);
1700
1701   MenuType *mt = WM_menutype_find("WM_MT_splash", true);
1702   if (mt) {
1703     UI_menutype_draw(C, mt, layout);
1704   }
1705
1706   UI_block_bounds_set_centered(block, 0);
1707
1708   return block;
1709 }
1710
1711 static int wm_splash_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *UNUSED(event))
1712 {
1713   UI_popup_block_invoke(C, wm_block_create_splash, NULL);
1714
1715   return OPERATOR_FINISHED;
1716 }
1717
1718 static void WM_OT_splash(wmOperatorType *ot)
1719 {
1720   ot->name = "Splash Screen";
1721   ot->idname = "WM_OT_splash";
1722   ot->description = "Open the splash screen with release info";
1723
1724   ot->invoke = wm_splash_invoke;
1725   ot->poll = WM_operator_winactive;
1726 }
1727
1728 /* ***************** Search menu ************************* */
1729
1730 struct SearchPopupInit_Data {
1731   int size[2];
1732 };
1733
1734 static uiBlock *wm_block_search_menu(bContext *C, ARegion *ar, void *userdata)
1735 {
1736   const struct SearchPopupInit_Data *init_data = userdata;
1737   static char search[256] = "";
1738   uiBlock *block;
1739   uiBut *but;
1740
1741   block = UI_block_begin(C, ar, "_popup", UI_EMBOSS);
1742   UI_block_flag_enable(block, UI_BLOCK_LOOP | UI_BLOCK_MOVEMOUSE_QUIT | UI_BLOCK_SEARCH_MENU);
1743   UI_block_theme_style_set(block, UI_BLOCK_THEME_STYLE_POPUP);
1744
1745   but = uiDefSearchBut(block,
1746                        search,
1747                        0,
1748                        ICON_VIEWZOOM,
1749                        sizeof(search),
1750                        10,
1751                        10,
1752                        init_data->size[0],
1753                        UI_UNIT_Y,
1754                        0,
1755                        0,
1756                        "");
1757   UI_but_func_operator_search(but);
1758   UI_but_flag_enable(but, UI_BUT_ACTIVATE_ON_INIT);
1759
1760   /* fake button, it holds space for search items */
1761   uiDefBut(block,
1762            UI_BTYPE_LABEL,
1763            0,
1764            "",
1765            10,
1766            10 - init_data->size[1],
1767            init_data->size[0],
1768            init_data->size[1],
1769            NULL,
1770            0,
1771            0,
1772            0,
1773            0,
1774            NULL);
1775
1776   /* Move it downwards, mouse over button. */
1777   UI_block_bounds_set_popup(block, 6, (const int[2]){0, -UI_UNIT_Y});
1778
1779   return block;
1780 }
1781
1782 static int wm_search_menu_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
1783 {
1784   return OPERATOR_FINISHED;
1785 }
1786
1787 static int wm_search_menu_invoke(bContext *C, wmOperator *UNUSED(op), const wmEvent *event)
1788 {
1789   /* Exception for launching via spacebar */
1790   if (event->type == SPACEKEY) {
1791     bool ok = true;
1792     ScrArea *sa = CTX_wm_area(C);
1793     if (sa) {
1794       if (sa->spacetype == SPACE_CONSOLE) {
1795         /* So we can use the shortcut in the console. */
1796         ok = false;
1797       }
1798       else if (sa->spacetype == SPACE_TEXT) {
1799         /* So we can use the spacebar in the text editor. */
1800         ok = false;
1801       }
1802     }
1803     else {
1804       Object *editob = CTX_data_edit_object(C);
1805       if (editob && editob->type == OB_FONT) {
1806         /* So we can use the spacebar for entering text. */
1807         ok = false;
1808       }
1809     }
1810     if (!ok) {
1811       return OPERATOR_PASS_THROUGH;
1812     }
1813   }
1814
1815   static struct SearchPopupInit_Data data;
1816   data.size[0] = UI_searchbox_size_x() * 2;
1817   data.size[1] = UI_searchbox_size_y();
1818
1819   UI_popup_block_invoke(C, wm_block_search_menu, &data);
1820
1821   return OPERATOR_INTERFACE;
1822 }
1823
1824 static void WM_OT_search_menu(wmOperatorType *ot)
1825 {
1826   ot->name = "Search Menu";
1827   ot->idname = "WM_OT_search_menu";
1828   ot->description = "Pop-up a search menu over all available operators in current context";
1829
1830   ot->invoke = wm_search_menu_invoke;
1831   ot->exec = wm_search_menu_exec;
1832   ot->poll = WM_operator_winactive;
1833 }
1834
1835 static int wm_call_menu_exec(bContext *C, wmOperator *op)
1836 {
1837   char idname[BKE_ST_MAXNAME];
1838   RNA_string_get(op->ptr, "name", idname);
1839
1840   return UI_popup_menu_invoke(C, idname, op->reports);
1841 }
1842
1843 static void WM_OT_call_menu(wmOperatorType *ot)
1844 {
1845   ot->name = "Call Menu";
1846   ot->idname = "WM_OT_call_menu";
1847   ot->description = "Call (draw) a pre-defined menu";
1848
1849   ot->exec = wm_call_menu_exec;
1850   ot->poll = WM_operator_winactive;
1851
1852   ot->flag = OPTYPE_INTERNAL;
1853
1854   RNA_def_string(ot->srna, "name", NULL, BKE_ST_MAXNAME, "Name", "Name of the menu");
1855 }
1856
1857 static int wm_call_pie_menu_invoke(bContext *C, wmOperator *op, const wmEvent *event)
1858 {
1859   char idname[BKE_ST_MAXNAME];
1860   RNA_string_get(op->ptr, "name", idname);
1861
1862   return UI_pie_menu_invoke(C, idname, event);
1863 }
1864
1865 static int wm_call_pie_menu_exec(bContext *C, wmOperator *op)
1866 {
1867   char idname[BKE_ST_MAXNAME];
1868   RNA_string_get(op->ptr, "name", idname);
1869
1870   return UI_pie_menu_invoke(C, idname, CTX_wm_window(C)->eventstate);
1871 }
1872
1873 static void WM_OT_call_menu_pie(wmOperatorType *ot)
1874 {
1875   ot->name = "Call Pie Menu";
1876   ot->idname = "WM_OT_call_menu_pie";
1877   ot->description = "Call (draw) a pre-defined pie menu";
1878
1879   ot->invoke = wm_call_pie_menu_invoke;
1880   ot->exec = wm_call_pie_menu_exec;
1881   ot->poll = WM_operator_winactive;
1882
1883   ot->flag = OPTYPE_INTERNAL;
1884
1885   RNA_def_string(ot->srna, "name", NULL, BKE_ST_MAXNAME, "Name", "Name of the pie menu");
1886 }
1887
1888 static int wm_call_panel_exec(bContext *C, wmOperator *op)
1889 {
1890   char idname[BKE_ST_MAXNAME];
1891   RNA_string_get(op->ptr, "name", idname);
1892   const bool keep_open = RNA_boolean_get(op->ptr, "keep_open");
1893
1894   return UI_popover_panel_invoke(C, idname, keep_open, op->reports);
1895 }
1896
1897 static void WM_OT_call_panel(wmOperatorType *ot)
1898 {
1899   ot->name = "Call Panel";
1900   ot->idname = "WM_OT_call_panel";
1901   ot->description = "Call (draw) a pre-defined panel";
1902
1903   ot->exec = wm_call_panel_exec;
1904   ot->poll = WM_operator_winactive;
1905
1906   ot->flag = OPTYPE_INTERNAL;
1907
1908   PropertyRNA *prop;
1909
1910   prop = RNA_def_string(ot->srna, "name", NULL, BKE_ST_MAXNAME, "Name", "Name of the menu");
1911   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
1912   prop = RNA_def_boolean(ot->srna, "keep_open", true, "Keep Open", "");
1913   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
1914 }
1915
1916 /* ************ window / screen operator definitions ************** */
1917
1918 /* this poll functions is needed in place of WM_operator_winactive
1919  * while it crashes on full screen */
1920 static bool wm_operator_winactive_normal(bContext *C)
1921 {
1922   wmWindow *win = CTX_wm_window(C);
1923   bScreen *screen;
1924
1925   if (win == NULL) {
1926     return 0;
1927   }
1928   if (!((screen = WM_window_get_active_screen(win)) && (screen->state == SCREENNORMAL))) {
1929     return 0;
1930   }
1931
1932   return 1;
1933 }
1934
1935 /* included for script-access */
1936 static void WM_OT_window_close(wmOperatorType *ot)
1937 {
1938   ot->name = "Close Window";
1939   ot->idname = "WM_OT_window_close";
1940   ot->description = "Close the current window";
1941
1942   ot->exec = wm_window_close_exec;
1943   ot->poll = WM_operator_winactive;
1944 }
1945
1946 static void WM_OT_window_new(wmOperatorType *ot)
1947 {
1948   ot->name = "New Window";
1949   ot->idname = "WM_OT_window_new";
1950   ot->description = "Create a new window";
1951
1952   ot->exec = wm_window_new_exec;
1953   ot->poll = wm_operator_winactive_normal;
1954 }
1955
1956 static void WM_OT_window_new_main(wmOperatorType *ot)
1957 {
1958   ot->name = "New Main Window";
1959   ot->idname = "WM_OT_window_new_main";
1960   ot->description = "Create a new main window with its own workspace and scene selection";
1961
1962   ot->exec = wm_window_new_main_exec;
1963   ot->poll = wm_operator_winactive_normal;
1964 }
1965
1966 static void WM_OT_window_fullscreen_toggle(wmOperatorType *ot)
1967 {
1968   ot->name = "Toggle Window Fullscreen";
1969   ot->idname = "WM_OT_window_fullscreen_toggle";
1970   ot->description = "Toggle the current window fullscreen";
1971
1972   ot->exec = wm_window_fullscreen_toggle_exec;
1973   ot->poll = WM_operator_winactive;
1974 }
1975
1976 static int wm_exit_blender_exec(bContext *C, wmOperator *UNUSED(op))
1977 {
1978   wm_exit_schedule_delayed(C);
1979   return OPERATOR_FINISHED;
1980 }
1981
1982 static int wm_exit_blender_invoke(bContext *C,
1983                                   wmOperator *UNUSED(op),
1984                                   const wmEvent *UNUSED(event))
1985 {
1986   if (U.uiflag & USER_SAVE_PROMPT) {
1987     wm_quit_with_optional_confirmation_prompt(C, CTX_wm_window(C));
1988   }
1989   else {
1990     wm_exit_schedule_delayed(C);
1991   }
1992   return OPERATOR_FINISHED;
1993 }
1994
1995 static void WM_OT_quit_blender(wmOperatorType *ot)
1996 {
1997   ot->name = "Quit Blender";
1998   ot->idname = "WM_OT_quit_blender";
1999   ot->description = "Quit Blender";
2000
2001   ot->invoke = wm_exit_blender_invoke;
2002   ot->exec = wm_exit_blender_exec;
2003 }
2004
2005 /* *********************** */
2006
2007 #if defined(WIN32)
2008
2009 static int wm_console_toggle_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
2010 {
2011   GHOST_toggleConsole(2);
2012   return OPERATOR_FINISHED;
2013 }
2014
2015 static void WM_OT_console_toggle(wmOperatorType *ot)
2016 {
2017   /* XXX Have to mark these for xgettext, as under linux they do not exists... */
2018   ot->name = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Toggle System Console");
2019   ot->idname = "WM_OT_console_toggle";
2020   ot->description = N_("Toggle System Console");
2021
2022   ot->exec = wm_console_toggle_exec;
2023   ot->poll = WM_operator_winactive;
2024 }
2025
2026 #endif
2027
2028 /* ************ default paint cursors, draw always around cursor *********** */
2029 /*
2030  * - returns handler to free
2031  * - poll(bContext): returns 1 if draw should happen
2032  * - draw(bContext): drawing callback for paint cursor
2033  */
2034
2035 wmPaintCursor *WM_paint_cursor_activate(wmWindowManager *wm,
2036                                         short space_type,
2037                                         short region_type,
2038                                         bool (*poll)(bContext *C),
2039                                         wmPaintCursorDraw draw,
2040                                         void *customdata)
2041 {
2042   wmPaintCursor *pc = MEM_callocN(sizeof(wmPaintCursor), "paint cursor");
2043
2044   BLI_addtail(&wm->paintcursors, pc);
2045
2046   pc->customdata = customdata;
2047   pc->poll = poll;
2048   pc->draw = draw;
2049
2050   pc->space_type = space_type;
2051   pc->region_type = region_type;
2052
2053   return pc;
2054 }
2055
2056 bool WM_paint_cursor_end(wmWindowManager *wm, wmPaintCursor *handle)
2057 {
2058   wmPaintCursor *pc;
2059
2060   for (pc = wm->paintcursors.first; pc; pc = pc->next) {
2061     if (pc == (wmPaintCursor *)handle) {
2062       BLI_remlink(&wm->paintcursors, pc);
2063       MEM_freeN(pc);
2064       return true;
2065     }
2066   }
2067   return false;
2068 }
2069
2070 /* *********************** radial control ****************** */
2071
2072 #define WM_RADIAL_CONTROL_DISPLAY_SIZE (200 * UI_DPI_FAC)
2073 #define WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE (35 * UI_DPI_FAC)
2074 #define WM_RADIAL_CONTROL_DISPLAY_WIDTH \
2075   (WM_RADIAL_CONTROL_DISPLAY_SIZE - WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE)
2076 #define WM_RADIAL_MAX_STR 10
2077
2078 typedef struct {
2079   PropertyType type;
2080   PropertySubType subtype;
2081   PointerRNA ptr, col_ptr, fill_col_ptr, rot_ptr, zoom_ptr, image_id_ptr;
2082   PointerRNA fill_col_override_ptr, fill_col_override_test_ptr;
2083   PropertyRNA *prop, *col_prop, *fill_col_prop, *rot_prop, *zoom_prop;
2084   PropertyRNA *fill_col_override_prop, *fill_col_override_test_prop;
2085   StructRNA *image_id_srna;
2086   float initial_value, current_value, min_value, max_value;
2087   int initial_mouse[2];
2088   int slow_mouse[2];
2089   bool slow_mode;
2090   Dial *dial;
2091   unsigned int gltex;
2092   ListBase orig_paintcursors;
2093   bool use_secondary_tex;
2094   void *cursor;
2095   NumInput num_input;
2096 } RadialControl;
2097
2098 static void radial_control_update_header(wmOperator *op, bContext *C)
2099 {
2100   RadialControl *rc = op->customdata;
2101   char msg[UI_MAX_DRAW_STR];
2102   ScrArea *sa = CTX_wm_area(C);
2103   Scene *scene = CTX_data_scene(C);
2104
2105   if (hasNumInput(&rc->num_input)) {
2106     char num_str[NUM_STR_REP_LEN];
2107     outputNumInput(&rc->num_input, num_str, &scene->unit);
2108     BLI_snprintf(msg, sizeof(msg), "%s: %s", RNA_property_ui_name(rc->prop), num_str);
2109   }
2110   else {
2111     const char *ui_name = RNA_property_ui_name(rc->prop);
2112     switch (rc->subtype) {
2113       case PROP_NONE:
2114       case PROP_DISTANCE:
2115         BLI_snprintf(msg, sizeof(msg), "%s: %0.4f", ui_name, rc->current_value);
2116         break;
2117       case PROP_PIXEL:
2118         BLI_snprintf(msg,
2119                      sizeof(msg),
2120                      "%s: %d",
2121                      ui_name,
2122                      (int)rc->current_value); /* XXX: round to nearest? */
2123         break;
2124       case PROP_PERCENTAGE:
2125         BLI_snprintf(msg, sizeof(msg), "%s: %3.1f%%", ui_name, rc->current_value);
2126         break;
2127       case PROP_FACTOR:
2128         BLI_snprintf(msg, sizeof(msg), "%s: %1.3f", ui_name, rc->current_value);
2129         break;
2130       case PROP_ANGLE:
2131         BLI_snprintf(msg, sizeof(msg), "%s: %3.2f", ui_name, RAD2DEGF(rc->current_value));
2132         break;
2133       default:
2134         BLI_snprintf(msg, sizeof(msg), "%s", ui_name); /* XXX: No value? */
2135         break;
2136     }
2137   }
2138
2139   ED_area_status_text(sa, msg);
2140 }
2141
2142 static void radial_control_set_initial_mouse(RadialControl *rc, const wmEvent *event)
2143 {
2144   float d[2] = {0, 0};
2145   float zoom[2] = {1, 1};
2146
2147   rc->initial_mouse[0] = event->x;
2148   rc->initial_mouse[1] = event->y;
2149
2150   switch (rc->subtype) {
2151     case PROP_NONE:
2152     case PROP_DISTANCE:
2153     case PROP_PIXEL:
2154       d[0] = rc->initial_value;
2155       break;
2156     case PROP_PERCENTAGE:
2157       d[0] = (rc->initial_value) / 100.0f * WM_RADIAL_CONTROL_DISPLAY_WIDTH +
2158              WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2159       break;
2160     case PROP_FACTOR:
2161       d[0] = (1 - rc->initial_value) * WM_RADIAL_CONTROL_DISPLAY_WIDTH +
2162              WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2163       break;
2164     case PROP_ANGLE:
2165       d[0] = WM_RADIAL_CONTROL_DISPLAY_SIZE * cosf(rc->initial_value);
2166       d[1] = WM_RADIAL_CONTROL_DISPLAY_SIZE * sinf(rc->initial_value);
2167       break;
2168     default:
2169       return;
2170   }
2171
2172   if (rc->zoom_prop) {
2173     RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2174     d[0] *= zoom[0];
2175     d[1] *= zoom[1];
2176   }
2177
2178   rc->initial_mouse[0] -= d[0];
2179   rc->initial_mouse[1] -= d[1];
2180 }
2181
2182 static void radial_control_set_tex(RadialControl *rc)
2183 {
2184   ImBuf *ibuf;
2185
2186   switch (RNA_type_to_ID_code(rc->image_id_ptr.type)) {
2187     case ID_BR:
2188       if ((ibuf = BKE_brush_gen_radial_control_imbuf(rc->image_id_ptr.data,
2189                                                      rc->use_secondary_tex))) {
2190         glGenTextures(1, &rc->gltex);
2191         glBindTexture(GL_TEXTURE_2D, rc->gltex);
2192         glTexImage2D(
2193             GL_TEXTURE_2D, 0, GL_R8, ibuf->x, ibuf->y, 0, GL_RED, GL_FLOAT, ibuf->rect_float);
2194         glBindTexture(GL_TEXTURE_2D, 0);
2195         MEM_freeN(ibuf->rect_float);
2196         MEM_freeN(ibuf);
2197       }
2198       break;
2199     default:
2200       break;
2201   }
2202 }
2203
2204 static void radial_control_paint_tex(RadialControl *rc, float radius, float alpha)
2205 {
2206   float col[3] = {0, 0, 0};
2207   float rot;
2208
2209   /* set fill color */
2210   if (rc->fill_col_prop) {
2211     PointerRNA *fill_ptr;
2212     PropertyRNA *fill_prop;
2213
2214     if (rc->fill_col_override_prop && RNA_property_boolean_get(&rc->fill_col_override_test_ptr,
2215                                                                rc->fill_col_override_test_prop)) {
2216       fill_ptr = &rc->fill_col_override_ptr;
2217       fill_prop = rc->fill_col_override_prop;
2218     }
2219     else {
2220       fill_ptr = &rc->fill_col_ptr;
2221       fill_prop = rc->fill_col_prop;
2222     }
2223
2224     RNA_property_float_get_array(fill_ptr, fill_prop, col);
2225   }
2226
2227   GPUVertFormat *format = immVertexFormat();
2228   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2229
2230   if (rc->gltex) {
2231
2232     uint texCoord = GPU_vertformat_attr_add(format, "texCoord", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2233
2234     glActiveTexture(GL_TEXTURE0);
2235     glBindTexture(GL_TEXTURE_2D, rc->gltex);
2236
2237     glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
2238     glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
2239
2240     GLint swizzleMask[] = {GL_ZERO, GL_ZERO, GL_ZERO, GL_RED};
2241     glTexParameteriv(GL_TEXTURE_2D, GL_TEXTURE_SWIZZLE_RGBA, swizzleMask);
2242
2243     /* set up rotation if available */
2244     if (rc->rot_prop) {
2245       rot = RNA_property_float_get(&rc->rot_ptr, rc->rot_prop);
2246       GPU_matrix_push();
2247       GPU_matrix_rotate_2d(RAD2DEGF(rot));
2248     }
2249
2250     immBindBuiltinProgram(GPU_SHADER_2D_IMAGE_MASK_UNIFORM_COLOR);
2251
2252     immUniformColor3fvAlpha(col, alpha);
2253     immUniform1i("image", 0);
2254
2255     /* draw textured quad */
2256     immBegin(GPU_PRIM_TRI_FAN, 4);
2257
2258     immAttr2f(texCoord, 0, 0);
2259     immVertex2f(pos, -radius, -radius);
2260
2261     immAttr2f(texCoord, 1, 0);
2262     immVertex2f(pos, radius, -radius);
2263
2264     immAttr2f(texCoord, 1, 1);
2265     immVertex2f(pos, radius, radius);
2266
2267     immAttr2f(texCoord, 0, 1);
2268     immVertex2f(pos, -radius, radius);
2269
2270     immEnd();
2271
2272     /* undo rotation */
2273     if (rc->rot_prop) {
2274       GPU_matrix_pop();
2275     }
2276   }
2277   else {
2278     /* flat color if no texture available */
2279     immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2280     immUniformColor3fvAlpha(col, alpha);
2281     imm_draw_circle_fill_2d(pos, 0.0f, 0.0f, radius, 40);
2282   }
2283
2284   immUnbindProgram();
2285 }
2286
2287 static void radial_control_paint_cursor(bContext *UNUSED(C), int x, int y, void *customdata)
2288 {
2289   RadialControl *rc = customdata;
2290   uiStyle *style = UI_style_get();
2291   const uiFontStyle *fstyle = &style->widget;
2292   const int fontid = fstyle->uifont_id;
2293   short fstyle_points = fstyle->points;
2294   char str[WM_RADIAL_MAX_STR];
2295   short strdrawlen = 0;
2296   float strwidth, strheight;
2297   float r1 = 0.0f, r2 = 0.0f, rmin = 0.0, tex_radius, alpha;
2298   float zoom[2], col[3] = {1, 1, 1};
2299
2300   switch (rc->subtype) {
2301     case PROP_NONE:
2302     case PROP_DISTANCE:
2303     case PROP_PIXEL:
2304       r1 = rc->current_value;
2305       r2 = rc->initial_value;
2306       tex_radius = r1;
2307       alpha = 0.75;
2308       break;
2309     case PROP_PERCENTAGE:
2310       r1 = rc->current_value / 100.0f * WM_RADIAL_CONTROL_DISPLAY_WIDTH +
2311            WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2312       r2 = tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE;
2313       rmin = WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2314       BLI_snprintf(str, WM_RADIAL_MAX_STR, "%3.1f%%", rc->current_value);
2315       strdrawlen = BLI_strlen_utf8(str);
2316       tex_radius = r1;
2317       alpha = 0.75;
2318       break;
2319     case PROP_FACTOR:
2320       r1 = (1 - rc->current_value) * WM_RADIAL_CONTROL_DISPLAY_WIDTH +
2321            WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2322       r2 = tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE;
2323       rmin = WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2324       alpha = rc->current_value / 2.0f + 0.5f;
2325       BLI_snprintf(str, WM_RADIAL_MAX_STR, "%1.3f", rc->current_value);
2326       strdrawlen = BLI_strlen_utf8(str);
2327       break;
2328     case PROP_ANGLE:
2329       r1 = r2 = tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE;
2330       alpha = 0.75;
2331       rmin = WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE;
2332       BLI_snprintf(str, WM_RADIAL_MAX_STR, "%3.2f", RAD2DEGF(rc->current_value));
2333       strdrawlen = BLI_strlen_utf8(str);
2334       break;
2335     default:
2336       tex_radius = WM_RADIAL_CONTROL_DISPLAY_SIZE; /* note, this is a dummy value */
2337       alpha = 0.75;
2338       break;
2339   }
2340
2341   /* Keep cursor in the original place */
2342   x = rc->initial_mouse[0];
2343   y = rc->initial_mouse[1];
2344   GPU_matrix_translate_2f((float)x, (float)y);
2345
2346   GPU_blend(true);
2347   GPU_line_smooth(true);
2348
2349   /* apply zoom if available */
2350   if (rc->zoom_prop) {
2351     RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2352     GPU_matrix_scale_2fv(zoom);
2353   }
2354
2355   /* draw rotated texture */
2356   radial_control_paint_tex(rc, tex_radius, alpha);
2357
2358   /* set line color */
2359   if (rc->col_prop) {
2360     RNA_property_float_get_array(&rc->col_ptr, rc->col_prop, col);
2361   }
2362
2363   GPUVertFormat *format = immVertexFormat();
2364   uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
2365
2366   immBindBuiltinProgram(GPU_SHADER_2D_UNIFORM_COLOR);
2367   immUniformColor3fvAlpha(col, 0.5f);
2368
2369   if (rc->subtype == PROP_ANGLE) {
2370     GPU_matrix_push();
2371
2372     /* draw original angle line */
2373     GPU_matrix_rotate_3f(RAD2DEGF(rc->initial_value), 0.0f, 0.0f, 1.0f);
2374     immBegin(GPU_PRIM_LINES, 2);
2375     immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE, 0.0f);
2376     immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_SIZE, 0.0f);
2377     immEnd();
2378
2379     /* draw new angle line */
2380     GPU_matrix_rotate_3f(RAD2DEGF(rc->current_value - rc->initial_value), 0.0f, 0.0f, 1.0f);
2381     immBegin(GPU_PRIM_LINES, 2);
2382     immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE, 0.0f);
2383     immVertex2f(pos, (float)WM_RADIAL_CONTROL_DISPLAY_SIZE, 0.0f);
2384     immEnd();
2385
2386     GPU_matrix_pop();
2387   }
2388
2389   /* draw circles on top */
2390   imm_draw_circle_wire_2d(pos, 0.0f, 0.0f, r1, 40);
2391   imm_draw_circle_wire_2d(pos, 0.0f, 0.0f, r2, 40);
2392   if (rmin > 0.0f) {
2393     imm_draw_circle_wire_2d(pos, 0.0, 0.0f, rmin, 40);
2394   }
2395   immUnbindProgram();
2396
2397   BLF_size(fontid, 1.5 * fstyle_points * U.pixelsize, U.dpi);
2398   BLF_enable(fontid, BLF_SHADOW);
2399   BLF_shadow(fontid, 3, (const float[4]){0.0f, 0.0f, 0.0f, 0.5f});
2400   BLF_shadow_offset(fontid, 1, -1);
2401
2402   /* draw value */
2403   BLF_width_and_height(fontid, str, strdrawlen, &strwidth, &strheight);
2404   BLF_position(fontid, -0.5f * strwidth, -0.5f * strheight, 0.0f);
2405   BLF_draw(fontid, str, strdrawlen);
2406
2407   BLF_disable(fontid, BLF_SHADOW);
2408
2409   GPU_blend(false);
2410   GPU_line_smooth(false);
2411 }
2412
2413 typedef enum {
2414   RC_PROP_ALLOW_MISSING = 1,
2415   RC_PROP_REQUIRE_FLOAT = 2,
2416   RC_PROP_REQUIRE_BOOL = 4,
2417 } RCPropFlags;
2418
2419 /**
2420  * Attempt to retrieve the rna pointer/property from an rna path.
2421  *
2422  * \return 0 for failure, 1 for success, and also 1 if property is not set.
2423  */
2424 static int radial_control_get_path(PointerRNA *ctx_ptr,
2425                                    wmOperator *op,
2426                                    const char *name,
2427                                    PointerRNA *r_ptr,
2428                                    PropertyRNA **r_prop,
2429                                    int req_length,
2430                                    RCPropFlags flags)
2431 {
2432   PropertyRNA *unused_prop;
2433   int len;
2434   char *str;
2435
2436   /* check flags */
2437   if ((flags & RC_PROP_REQUIRE_BOOL) && (flags & RC_PROP_REQUIRE_FLOAT)) {
2438     BKE_report(op->reports, RPT_ERROR, "Property cannot be both boolean and float");
2439     return 0;
2440   }
2441
2442   /* get an rna string path from the operator's properties */
2443   if (!(str = RNA_string_get_alloc(op->ptr, name, NULL, 0))) {
2444     return 1;
2445   }
2446
2447   if (str[0] == '\0') {
2448     if (r_prop) {
2449       *r_prop = NULL;
2450     }
2451     MEM_freeN(str);
2452     return 1;
2453   }
2454
2455   if (!r_prop) {
2456     r_prop = &unused_prop;
2457   }
2458
2459   /* get rna from path */
2460   if (!RNA_path_resolve(ctx_ptr, str, r_ptr, r_prop)) {
2461     MEM_freeN(str);
2462     if (flags & RC_PROP_ALLOW_MISSING) {
2463       return 1;
2464     }
2465     else {
2466       BKE_reportf(op->reports, RPT_ERROR, "Could not resolve path '%s'", name);
2467       return 0;
2468     }
2469   }
2470
2471   /* check property type */
2472   if (flags & (RC_PROP_REQUIRE_BOOL | RC_PROP_REQUIRE_FLOAT)) {
2473     PropertyType prop_type = RNA_property_type(*r_prop);
2474
2475     if (((flags & RC_PROP_REQUIRE_BOOL) && (prop_type != PROP_BOOLEAN)) ||
2476         ((flags & RC_PROP_REQUIRE_FLOAT) && (prop_type != PROP_FLOAT))) {
2477       MEM_freeN(str);
2478       BKE_reportf(op->reports, RPT_ERROR, "Property from path '%s' is not a float", name);
2479       return 0;
2480     }
2481   }
2482
2483   /* check property's array length */
2484   if (*r_prop && (len = RNA_property_array_length(r_ptr, *r_prop)) != req_length) {
2485     MEM_freeN(str);
2486     BKE_reportf(op->reports,
2487                 RPT_ERROR,
2488                 "Property from path '%s' has length %d instead of %d",
2489                 name,
2490                 len,
2491                 req_length);
2492     return 0;
2493   }
2494
2495   /* success */
2496   MEM_freeN(str);
2497   return 1;
2498 }
2499
2500 /* initialize the rna pointers and properties using rna paths */
2501 static int radial_control_get_properties(bContext *C, wmOperator *op)
2502 {
2503   RadialControl *rc = op->customdata;
2504   PointerRNA ctx_ptr, use_secondary_ptr;
2505   PropertyRNA *use_secondary_prop = NULL;
2506   const char *data_path;
2507
2508   RNA_pointer_create(NULL, &RNA_Context, C, &ctx_ptr);
2509
2510   /* check if we use primary or secondary path */
2511   if (!radial_control_get_path(&ctx_ptr,
2512                                op,
2513                                "use_secondary",
2514                                &use_secondary_ptr,
2515                                &use_secondary_prop,
2516                                0,
2517                                (RC_PROP_ALLOW_MISSING | RC_PROP_REQUIRE_BOOL))) {
2518     return 0;
2519   }
2520   else {
2521     if (use_secondary_prop && RNA_property_boolean_get(&use_secondary_ptr, use_secondary_prop)) {
2522       data_path = "data_path_secondary";
2523     }
2524     else {
2525       data_path = "data_path_primary";
2526     }
2527   }
2528
2529   if (!radial_control_get_path(&ctx_ptr, op, data_path, &rc->ptr, &rc->prop, 0, 0)) {
2530     return 0;
2531   }
2532
2533   /* data path is required */
2534   if (!rc->prop) {
2535     return 0;
2536   }
2537
2538   if (!radial_control_get_path(
2539           &ctx_ptr, op, "rotation_path", &rc->rot_ptr, &rc->rot_prop, 0, RC_PROP_REQUIRE_FLOAT)) {
2540     return 0;
2541   }
2542
2543   if (!radial_control_get_path(
2544           &ctx_ptr, op, "color_path", &rc->col_ptr, &rc->col_prop, 3, RC_PROP_REQUIRE_FLOAT)) {
2545     return 0;
2546   }
2547
2548   if (!radial_control_get_path(&ctx_ptr,
2549                                op,
2550                                "fill_color_path",
2551                                &rc->fill_col_ptr,
2552                                &rc->fill_col_prop,
2553                                3,
2554                                RC_PROP_REQUIRE_FLOAT)) {
2555     return 0;
2556   }
2557
2558   if (!radial_control_get_path(&ctx_ptr,
2559                                op,
2560                                "fill_color_override_path",
2561                                &rc->fill_col_override_ptr,
2562                                &rc->fill_col_override_prop,
2563                                3,
2564                                RC_PROP_REQUIRE_FLOAT)) {
2565     return 0;
2566   }
2567   if (!radial_control_get_path(&ctx_ptr,
2568                                op,
2569                                "fill_color_override_test_path",
2570                                &rc->fill_col_override_test_ptr,
2571                                &rc->fill_col_override_test_prop,
2572                                0,
2573                                RC_PROP_REQUIRE_BOOL)) {
2574     return 0;
2575   }
2576
2577   /* slightly ugly; allow this property to not resolve
2578    * correctly. needed because 3d texture paint shares the same
2579    * keymap as 2d image paint */
2580   if (!radial_control_get_path(&ctx_ptr,
2581                                op,
2582                                "zoom_path",
2583                                &rc->zoom_ptr,
2584                                &rc->zoom_prop,
2585                                2,
2586                                RC_PROP_REQUIRE_FLOAT | RC_PROP_ALLOW_MISSING)) {
2587     return 0;
2588   }
2589
2590   if (!radial_control_get_path(&ctx_ptr, op, "image_id", &rc->image_id_ptr, NULL, 0, 0)) {
2591     return 0;
2592   }
2593   else if (rc->image_id_ptr.data) {
2594     /* extra check, pointer must be to an ID */
2595     if (!RNA_struct_is_ID(rc->image_id_ptr.type)) {
2596       BKE_report(op->reports, RPT_ERROR, "Pointer from path image_id is not an ID");
2597       return 0;
2598     }
2599   }
2600
2601   rc->use_secondary_tex = RNA_boolean_get(op->ptr, "secondary_tex");
2602
2603   return 1;
2604 }
2605
2606 static int radial_control_invoke(bContext *C, wmOperator *op, const wmEvent *event)
2607 {
2608   wmWindowManager *wm;
2609   RadialControl *rc;
2610
2611   if (!(op->customdata = rc = MEM_callocN(sizeof(RadialControl), "RadialControl"))) {
2612     return OPERATOR_CANCELLED;
2613   }
2614
2615   if (!radial_control_get_properties(C, op)) {
2616     MEM_freeN(rc);
2617     return OPERATOR_CANCELLED;
2618   }
2619
2620   /* get type, initial, min, and max values of the property */
2621   switch ((rc->type = RNA_property_type(rc->prop))) {
2622     case PROP_INT: {
2623       int value, min, max, step;
2624
2625       value = RNA_property_int_get(&rc->ptr, rc->prop);
2626       RNA_property_int_ui_range(&rc->ptr, rc->prop, &min, &max, &step);
2627
2628       rc->initial_value = value;
2629       rc->min_value = min_ii(value, min);
2630       rc->max_value = max_ii(value, max);
2631       break;
2632     }
2633     case PROP_FLOAT: {
2634       float value, min, max, step, precision;
2635
2636       value = RNA_property_float_get(&rc->ptr, rc->prop);
2637       RNA_property_float_ui_range(&rc->ptr, rc->prop, &min, &max, &step, &precision);
2638
2639       rc->initial_value = value;
2640       rc->min_value = min_ff(value, min);
2641       rc->max_value = max_ff(value, max);
2642       break;
2643     }
2644     default:
2645       BKE_report(op->reports, RPT_ERROR, "Property must be an integer or a float");
2646       MEM_freeN(rc);
2647       return OPERATOR_CANCELLED;
2648   }
2649
2650   /* initialize numerical input */
2651   initNumInput(&rc->num_input);
2652   rc->num_input.idx_max = 0;
2653   rc->num_input.val_flag[0] |= NUM_NO_NEGATIVE;
2654   rc->num_input.unit_sys = USER_UNIT_NONE;
2655   rc->num_input.unit_type[0] = B_UNIT_LENGTH;
2656
2657   /* get subtype of property */
2658   rc->subtype = RNA_property_subtype(rc->prop);
2659   if (!ELEM(rc->subtype,
2660             PROP_NONE,
2661             PROP_DISTANCE,
2662             PROP_FACTOR,
2663             PROP_PERCENTAGE,
2664             PROP_ANGLE,
2665             PROP_PIXEL)) {
2666     BKE_report(op->reports,
2667                RPT_ERROR,
2668                "Property must be a none, distance, factor, percentage, angle, or pixel");
2669     MEM_freeN(rc);
2670     return OPERATOR_CANCELLED;
2671   }
2672
2673   rc->current_value = rc->initial_value;
2674   radial_control_set_initial_mouse(rc, event);
2675   radial_control_set_tex(rc);
2676
2677   /* temporarily disable other paint cursors */
2678   wm = CTX_wm_manager(C);
2679   rc->orig_paintcursors = wm->paintcursors;
2680   BLI_listbase_clear(&wm->paintcursors);
2681
2682   /* add radial control paint cursor */
2683   rc->cursor = WM_paint_cursor_activate(
2684       wm, SPACE_TYPE_ANY, RGN_TYPE_ANY, op->type->poll, radial_control_paint_cursor, rc);
2685
2686   WM_event_add_modal_handler(C, op);
2687
2688   return OPERATOR_RUNNING_MODAL;
2689 }
2690
2691 static void radial_control_set_value(RadialControl *rc, float val)
2692 {
2693   switch (rc->type) {
2694     case PROP_INT:
2695       RNA_property_int_set(&rc->ptr, rc->prop, val);
2696       break;
2697     case PROP_FLOAT:
2698       RNA_property_float_set(&rc->ptr, rc->prop, val);
2699       break;
2700     default:
2701       break;
2702   }
2703 }
2704
2705 static void radial_control_cancel(bContext *C, wmOperator *op)
2706 {
2707   RadialControl *rc = op->customdata;
2708   wmWindowManager *wm = CTX_wm_manager(C);
2709   ScrArea *sa = CTX_wm_area(C);
2710
2711   if (rc->dial) {
2712     MEM_freeN(rc->dial);
2713     rc->dial = NULL;
2714   }
2715
2716   ED_area_status_text(sa, NULL);
2717
2718   WM_paint_cursor_end(wm, rc->cursor);
2719
2720   /* restore original paint cursors */
2721   wm->paintcursors = rc->orig_paintcursors;
2722
2723   /* not sure if this is a good notifier to use;
2724    * intended purpose is to update the UI so that the
2725    * new value is displayed in sliders/numfields */
2726   WM_event_add_notifier(C, NC_WINDOW, NULL);
2727
2728   glDeleteTextures(1, &rc->gltex);
2729
2730   MEM_freeN(rc);
2731 }
2732
2733 static int radial_control_modal(bContext *C, wmOperator *op, const wmEvent *event)
2734 {
2735   RadialControl *rc = op->customdata;
2736   float new_value, dist = 0.0f, zoom[2];
2737   float delta[2], ret = OPERATOR_RUNNING_MODAL;
2738   bool snap;
2739   float angle_precision = 0.0f;
2740   const bool has_numInput = hasNumInput(&rc->num_input);
2741   bool handled = false;
2742   float numValue;
2743   /* TODO: fix hardcoded events */
2744
2745   snap = event->ctrl != 0;
2746
2747   /* Modal numinput active, try to handle numeric inputs first... */
2748   if (event->val == KM_PRESS && has_numInput && handleNumInput(C, &rc->num_input, event)) {
2749     handled = true;
2750     applyNumInput(&rc->num_input, &numValue);
2751
2752     if (rc->subtype == PROP_ANGLE) {
2753       numValue = DEG2RADF(numValue);
2754       numValue = fmod(numValue, 2.0f * (float)M_PI);
2755       if (numValue < 0.0f) {
2756         numValue += 2.0f * (float)M_PI;
2757       }
2758     }
2759
2760     CLAMP(numValue, rc->min_value, rc->max_value);
2761     new_value = numValue;
2762
2763     radial_control_set_value(rc, new_value);
2764     rc->current_value = new_value;
2765     radial_control_update_header(op, C);
2766     return OPERATOR_RUNNING_MODAL;
2767   }
2768   else {
2769     handled = false;
2770     switch (event->type) {
2771       case ESCKEY:
2772       case RIGHTMOUSE:
2773         /* canceled; restore original value */
2774         radial_control_set_value(rc, rc->initial_value);
2775         ret = OPERATOR_CANCELLED;
2776         break;
2777
2778       case LEFTMOUSE:
2779       case PADENTER:
2780       case RETKEY:
2781         /* done; value already set */
2782         RNA_property_update(C, &rc->ptr, rc->prop);
2783         ret = OPERATOR_FINISHED;
2784         break;
2785
2786       case MOUSEMOVE:
2787         if (!has_numInput) {
2788           if (rc->slow_mode) {
2789             if (rc->subtype == PROP_ANGLE) {
2790               float position[2] = {event->x, event->y};
2791
2792               /* calculate the initial angle here first */
2793               delta[0] = rc->initial_mouse[0] - rc->slow_mouse[0];
2794               delta[1] = rc->initial_mouse[1] - rc->slow_mouse[1];
2795
2796               /* precision angle gets calculated from dial and gets added later */
2797               angle_precision = -0.1f * BLI_dial_angle(rc->dial, position);
2798             }
2799             else {
2800               delta[0] = rc->initial_mouse[0] - rc->slow_mouse[0];
2801               delta[1] = rc->initial_mouse[1] - rc->slow_mouse[1];
2802
2803               if (rc->zoom_prop) {
2804                 RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2805                 delta[0] /= zoom[0];
2806                 delta[1] /= zoom[1];
2807               }
2808
2809               dist = len_v2(delta);
2810
2811               delta[0] = event->x - rc->slow_mouse[0];
2812               delta[1] = event->y - rc->slow_mouse[1];
2813
2814               if (rc->zoom_prop) {
2815                 delta[0] /= zoom[0];
2816                 delta[1] /= zoom[1];
2817               }
2818
2819               dist = dist + 0.1f * (delta[0] + delta[1]);
2820             }
2821           }
2822           else {
2823             delta[0] = rc->initial_mouse[0] - event->x;
2824             delta[1] = rc->initial_mouse[1] - event->y;
2825
2826             if (rc->zoom_prop) {
2827               RNA_property_float_get_array(&rc->zoom_ptr, rc->zoom_prop, zoom);
2828               delta[0] /= zoom[0];
2829               delta[1] /= zoom[1];
2830             }
2831
2832             dist = len_v2(delta);
2833           }
2834
2835           /* calculate new value and apply snapping  */
2836           switch (rc->subtype) {
2837             case PROP_NONE:
2838             case PROP_DISTANCE:
2839             case PROP_PIXEL:
2840               new_value = dist;
2841               if (snap) {
2842                 new_value = ((int)new_value + 5) / 10 * 10;
2843               }
2844               break;
2845             case PROP_PERCENTAGE:
2846               new_value = ((dist - WM_RADIAL_CONTROL_DISPLAY_MIN_SIZE) /
2847                            WM_RADIAL_CONTROL_DISPLAY_WIDTH) *
2848                           100.0f;
2849               if (snap) {
2850                 new_value = ((int)(new_value + 2.5f)) / 5 * 5;
2851               }
2852               break;
2853             case PROP_FACTOR:
2854               new_value = (WM_RADIAL_CONTROL_DISPLAY_SIZE - dist) /
2855                           WM_RADIAL_CONTROL_DISPLAY_WIDTH;
2856               if (snap) {
2857                 new_value = ((int)ceil(new_value * 10.f) * 10.0f) / 100.f;
2858               }
2859               break;
2860             case PROP_ANGLE:
2861               new_value = atan2f(delta[1], delta[0]) + (float)M_PI + angle_precision;
2862               new_value = fmod(new_value, 2.0f * (float)M_PI);
2863               if (new_value < 0.0f) {
2864                 new_value += 2.0f * (float)M_PI;
2865               }
2866               if (snap) {
2867                 new_value = DEG2RADF(((int)RAD2DEGF(new_value) + 5) / 10 * 10);
2868               }
2869               break;
2870             default:
2871               new_value = dist; /* dummy value, should this ever happen? - campbell */
2872               break;
2873           }
2874
2875           /* clamp and update */
2876           CLAMP(new_value, rc->min_value, rc->max_value);
2877           radial_control_set_value(rc, new_value);
2878           rc->current_value = new_value;
2879           handled = true;
2880           break;
2881         }
2882         break;
2883
2884       case LEFTSHIFTKEY:
2885       case RIGHTSHIFTKEY: {
2886         if (event->val == KM_PRESS) {
2887           rc->slow_mouse[0] = event->x;
2888           rc->slow_mouse[1] = event->y;
2889           rc->slow_mode = true;
2890           if (rc->subtype == PROP_ANGLE) {
2891             float initial_position[2] = {UNPACK2(rc->initial_mouse)};
2892             float current_position[2] = {UNPACK2(rc->slow_mouse)};
2893             rc->dial = BLI_dial_initialize(initial_position, 0.0f);
2894             /* immediately set the position to get a an initial direction */
2895             BLI_dial_angle(rc->dial, current_position);
2896           }
2897           handled = true;
2898         }
2899         if (event->val == KM_RELEASE) {
2900           rc->slow_mode = false;
2901           handled = true;
2902           if (rc->dial) {
2903             MEM_freeN(rc->dial);
2904             rc->dial = NULL;
2905           }
2906         }
2907         break;
2908       }
2909     }
2910
2911     /* Modal numinput inactive, try to handle numeric inputs last... */
2912     if (!handled && event->val == KM_PRESS && handleNumInput(C, &rc->num_input, event)) {
2913       applyNumInput(&rc->num_input, &numValue);
2914
2915       if (rc->subtype == PROP_ANGLE) {
2916         numValue = DEG2RADF(numValue);
2917         numValue = fmod(numValue, 2.0f * (float)M_PI);
2918         if (numValue < 0.0f) {
2919           numValue += 2.0f * (float)M_PI;
2920         }
2921       }
2922
2923       CLAMP(numValue, rc->min_value, rc->max_value);
2924       new_value = numValue;
2925
2926       radial_control_set_value(rc, new_value);
2927
2928       rc->current_value = new_value;
2929       radial_control_update_header(op, C);
2930       return OPERATOR_RUNNING_MODAL;
2931     }
2932   }
2933
2934   ED_region_tag_redraw(CTX_wm_region(C));
2935   radial_control_update_header(op, C);
2936
2937   if (ret != OPERATOR_RUNNING_MODAL) {
2938     radial_control_cancel(C, op);
2939   }
2940
2941   return ret;
2942 }
2943
2944 static void WM_OT_radial_control(wmOperatorType *ot)
2945 {
2946   ot->name = "Radial Control";
2947   ot->idname = "WM_OT_radial_control";
2948   ot->description = "Set some size property (like e.g. brush size) with mouse wheel";
2949
2950   ot->invoke = radial_control_invoke;
2951   ot->modal = radial_control_modal;
2952   ot->cancel = radial_control_cancel;
2953
2954   ot->flag = OPTYPE_REGISTER | OPTYPE_UNDO | OPTYPE_BLOCKING;
2955
2956   /* all paths relative to the context */
2957   PropertyRNA *prop;
2958   prop = RNA_def_string(ot->srna,
2959                         "data_path_primary",
2960                         NULL,
2961                         0,
2962                         "Primary Data Path",
2963                         "Primary path of property to be set by the radial control");
2964   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2965
2966   prop = RNA_def_string(ot->srna,
2967                         "data_path_secondary",
2968                         NULL,
2969                         0,
2970                         "Secondary Data Path",
2971                         "Secondary path of property to be set by the radial control");
2972   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2973
2974   prop = RNA_def_string(ot->srna,
2975                         "use_secondary",
2976                         NULL,
2977                         0,
2978                         "Use Secondary",
2979                         "Path of property to select between the primary and secondary data paths");
2980   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2981
2982   prop = RNA_def_string(ot->srna,
2983                         "rotation_path",
2984                         NULL,
2985                         0,
2986                         "Rotation Path",
2987                         "Path of property used to rotate the texture display");
2988   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2989
2990   prop = RNA_def_string(ot->srna,
2991                         "color_path",
2992                         NULL,
2993                         0,
2994                         "Color Path",
2995                         "Path of property used to set the color of the control");
2996   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
2997
2998   prop = RNA_def_string(ot->srna,
2999                         "fill_color_path",
3000                         NULL,
3001                         0,
3002                         "Fill Color Path",
3003                         "Path of property used to set the fill color of the control");
3004   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3005
3006   prop = RNA_def_string(
3007       ot->srna, "fill_color_override_path", NULL, 0, "Fill Color Override Path", "");
3008   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3009   prop = RNA_def_string(
3010       ot->srna, "fill_color_override_test_path", NULL, 0, "Fill Color Override Test", "");
3011   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3012
3013   prop = RNA_def_string(ot->srna,
3014                         "zoom_path",
3015                         NULL,
3016                         0,
3017                         "Zoom Path",
3018                         "Path of property used to set the zoom level for the control");
3019   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3020
3021   prop = RNA_def_string(ot->srna,
3022                         "image_id",
3023                         NULL,
3024                         0,
3025                         "Image ID",
3026                         "Path of ID that is used to generate an image for the control");
3027   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3028
3029   prop = RNA_def_boolean(
3030       ot->srna, "secondary_tex", false, "Secondary Texture", "Tweak brush secondary/mask texture");
3031   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3032 }
3033
3034 /* ************************** timer for testing ***************** */
3035
3036 /* uses no type defines, fully local testing function anyway... ;) */
3037
3038 static void redraw_timer_window_swap(bContext *C)
3039 {
3040   wmWindow *win = CTX_wm_window(C);
3041   ScrArea *sa;
3042   CTX_wm_menu_set(C, NULL);
3043
3044   for (sa = CTX_wm_screen(C)->areabase.first; sa; sa = sa->next) {
3045     ED_area_tag_redraw(sa);
3046   }
3047   wm_draw_update(C);
3048
3049   CTX_wm_window_set(C, win); /* XXX context manipulation warning! */
3050 }
3051
3052 enum {
3053   eRTDrawRegion = 0,
3054   eRTDrawRegionSwap = 1,
3055   eRTDrawWindow = 2,
3056   eRTDrawWindowSwap = 3,
3057   eRTAnimationStep = 4,
3058   eRTAnimationPlay = 5,
3059   eRTUndo = 6,
3060 };
3061
3062 static const EnumPropertyItem redraw_timer_type_items[] = {
3063     {eRTDrawRegion, "DRAW", 0, "Draw Region", "Draw Region"},
3064     {eRTDrawRegionSwap, "DRAW_SWAP", 0, "Draw Region + Swap", "Draw Region and Swap"},
3065     {eRTDrawWindow, "DRAW_WIN", 0, "Draw Window", "Draw Window"},
3066     {eRTDrawWindowSwap, "DRAW_WIN_SWAP", 0, "Draw Window + Swap", "Draw Window and Swap"},
3067     {eRTAnimationStep, "ANIM_STEP", 0, "Anim Step", "Animation Steps"},
3068     {eRTAnimationPlay, "ANIM_PLAY", 0, "Anim Play", "Animation Playback"},
3069     {eRTUndo, "UNDO", 0, "Undo/Redo", "Undo/Redo"},
3070     {0, NULL, 0, NULL, NULL},
3071 };
3072
3073 static void redraw_timer_step(bContext *C,
3074                               Main *bmain,
3075                               Scene *scene,
3076                               struct Depsgraph *depsgraph,
3077                               wmWindow *win,
3078                               ScrArea *sa,
3079                               ARegion *ar,
3080                               const int type,
3081                               const int cfra)
3082 {
3083   if (type == eRTDrawRegion) {
3084     if (ar) {
3085       ED_region_do_draw(C, ar);
3086       ar->do_draw = false;
3087     }
3088   }
3089   else if (type == eRTDrawRegionSwap) {
3090     CTX_wm_menu_set(C, NULL);
3091
3092     ED_region_tag_redraw(ar);
3093     wm_draw_update(C);
3094
3095     CTX_wm_window_set(C, win); /* XXX context manipulation warning! */
3096   }
3097   else if (type == eRTDrawWindow) {
3098     bScreen *screen = WM_window_get_active_screen(win);
3099     ScrArea *sa_iter;
3100
3101     CTX_wm_menu_set(C, NULL);
3102
3103     for (sa_iter = screen->areabase.first; sa_iter; sa_iter = sa_iter->next) {
3104       ARegion *ar_iter;
3105       CTX_wm_area_set(C, sa_iter);
3106
3107       for (ar_iter = sa_iter->regionbase.first; ar_iter; ar_iter = ar_iter->next) {
3108         if (ar_iter->visible) {
3109           CTX_wm_region_set(C, ar_iter);
3110           ED_region_do_draw(C, ar_iter);
3111           ar_iter->do_draw = false;
3112         }
3113       }
3114     }
3115
3116     CTX_wm_window_set(C, win); /* XXX context manipulation warning! */
3117
3118     CTX_wm_area_set(C, sa);
3119     CTX_wm_region_set(C, ar);
3120   }
3121   else if (type == eRTDrawWindowSwap) {
3122     redraw_timer_window_swap(C);
3123   }
3124   else if (type == eRTAnimationStep) {
3125     scene->r.cfra += (cfra == scene->r.cfra) ? 1 : -1;
3126     BKE_scene_graph_update_for_newframe(depsgraph, bmain);
3127   }
3128   else if (type == eRTAnimationPlay) {
3129     /* play anim, return on same frame as started with */
3130     int tot = (scene->r.efra - scene->r.sfra) + 1;
3131
3132     while (tot--) {
3133       /* todo, ability to escape! */
3134       scene->r.cfra++;
3135       if (scene->r.cfra > scene->r.efra) {
3136         scene->r.cfra = scene->r.sfra;
3137       }
3138
3139       BKE_scene_graph_update_for_newframe(depsgraph, bmain);
3140       redraw_timer_window_swap(C);
3141     }
3142   }
3143   else { /* eRTUndo */
3144     ED_undo_pop(C);
3145     ED_undo_redo(C);
3146   }
3147 }
3148
3149 static int redraw_timer_exec(bContext *C, wmOperator *op)
3150 {
3151   Main *bmain = CTX_data_main(C);
3152   Scene *scene = CTX_data_scene(C);
3153   wmWindow *win = CTX_wm_window(C);
3154   ScrArea *sa = CTX_wm_area(C);
3155   ARegion *ar = CTX_wm_region(C);
3156   double time_start, time_delta;
3157   const int type = RNA_enum_get(op->ptr, "type");
3158   const int iter = RNA_int_get(op->ptr, "iterations");
3159   const double time_limit = (double)RNA_float_get(op->ptr, "time_limit");
3160   const int cfra = scene->r.cfra;
3161   int a, iter_steps = 0;
3162   const char *infostr = "";
3163   struct Depsgraph *depsgraph = CTX_data_depsgraph(C);
3164
3165   WM_cursor_wait(1);
3166
3167   time_start = PIL_check_seconds_timer();
3168
3169   for (a = 0; a < iter; a++) {
3170     redraw_timer_step(C, bmain, scene, depsgraph, win, sa, ar, type, cfra);
3171     iter_steps += 1;
3172
3173     if (time_limit != 0.0) {
3174       if ((PIL_check_seconds_timer() - time_start) > time_limit) {
3175         break;
3176       }
3177       a = 0;
3178     }
3179   }
3180
3181   time_delta = (PIL_check_seconds_timer() - time_start) * 1000;
3182
3183   RNA_enum_description(redraw_timer_type_items, type, &infostr);
3184
3185   WM_cursor_wait(0);
3186
3187   BKE_reportf(op->reports,
3188               RPT_WARNING,
3189               "%d x %s: %.4f ms, average: %.8f ms",
3190               iter_steps,
3191               infostr,
3192               time_delta,
3193               time_delta / iter_steps);
3194
3195   return OPERATOR_FINISHED;
3196 }
3197
3198 static void WM_OT_redraw_timer(wmOperatorType *ot)
3199 {
3200   ot->name = "Redraw Timer";
3201   ot->idname = "WM_OT_redraw_timer";
3202   ot->description = "Simple redraw timer to test the speed of updating the interface";
3203
3204   ot->invoke = WM_menu_invoke;
3205   ot->exec = redraw_timer_exec;
3206   ot->poll = WM_operator_winactive;
3207
3208   ot->prop = RNA_def_enum(ot->srna, "type", redraw_timer_type_items, eRTDrawRegion, "Type", "");
3209   RNA_def_int(
3210       ot->srna, "iterations", 10, 1, INT_MAX, "Iterations", "Number of times to redraw", 1, 1000);
3211   RNA_def_float(ot->srna,
3212                 "time_limit",
3213                 0.0,
3214                 0.0,
3215                 FLT_MAX,
3216                 "Time Limit",
3217                 "Seconds to run the test for (override iterations)",
3218                 0.0,
3219                 60.0);
3220 }
3221
3222 /* ************************** memory statistics for testing ***************** */
3223
3224 static int memory_statistics_exec(bContext *UNUSED(C), wmOperator *UNUSED(op))
3225 {
3226   MEM_printmemlist_stats();
3227   return OPERATOR_FINISHED;
3228 }
3229
3230 static void WM_OT_memory_statistics(wmOperatorType *ot)
3231 {
3232   ot->name = "Memory Statistics";
3233   ot->idname = "WM_OT_memory_statistics";
3234   ot->description = "Print memory statistics to the console";
3235
3236   ot->exec = memory_statistics_exec;
3237 }
3238
3239 /* *************************** Mat/tex/etc. previews generation ************* */
3240
3241 typedef struct PreviewsIDEnsureData {
3242   bContext *C;
3243   Scene *scene;
3244 } PreviewsIDEnsureData;
3245
3246 static void previews_id_ensure(bContext *C, Scene *scene, ID *id)
3247 {
3248   BLI_assert(ELEM(GS(id->name), ID_MA, ID_TE, ID_IM, ID_WO, ID_LA));
3249
3250   /* Only preview non-library datablocks, lib ones do not pertain to this .blend file!
3251    * Same goes for ID with no user. */
3252   if (!ID_IS_LINKED(id) && (id->us != 0)) {
3253     UI_id_icon_render(C, scene, id, false, false);
3254     UI_id_icon_render(C, scene, id, true, false);
3255   }
3256 }
3257
3258 static int previews_id_ensure_callback(void *userdata,
3259                                        ID *UNUSED(self_id),
3260                                        ID **idptr,
3261                                        int cb_flag)
3262 {
3263   if (cb_flag & IDWALK_CB_PRIVATE) {
3264     return IDWALK_RET_NOP;
3265   }
3266
3267   PreviewsIDEnsureData *data = userdata;
3268   ID *id = *idptr;
3269
3270   if (id && (id->tag & LIB_TAG_DOIT)) {
3271     BLI_assert(ELEM(GS(id->name), ID_MA, ID_TE, ID_IM, ID_WO, ID_LA));
3272     previews_id_ensure(data->C, data->scene, id);
3273     id->tag &= ~LIB_TAG_DOIT;
3274   }
3275
3276   return IDWALK_RET_NOP;
3277 }
3278
3279 static int previews_ensure_exec(bContext *C, wmOperator *UNUSED(op))
3280 {
3281   Main *bmain = CTX_data_main(C);
3282   ListBase *lb[] = {
3283       &bmain->materials, &bmain->textures, &bmain->images, &bmain->worlds, &bmain->lights, NULL};
3284   PreviewsIDEnsureData preview_id_data;
3285   Scene *scene;
3286   ID *id;
3287   int i;
3288
3289   /* We use LIB_TAG_DOIT to check whether we have already handled a given ID or not. */
3290   BKE_main_id_tag_all(bmain, LIB_TAG_DOIT, false);
3291   for (i = 0; lb[i]; i++) {
3292     BKE_main_id_tag_listbase(lb[i], LIB_TAG_DOIT, true);
3293   }
3294
3295   preview_id_data.C = C;
3296   for (scene = bmain->scenes.first; scene; scene = scene->id.next) {
3297     preview_id_data.scene = scene;
3298     id = (ID *)scene;
3299
3300     BKE_library_foreach_ID_link(
3301         NULL, id, previews_id_ensure_callback, &preview_id_data, IDWALK_RECURSE);
3302   }
3303
3304   /* Check a last time for ID not used (fake users only, in theory), and
3305    * do our best for those, using current scene... */
3306   for (i = 0; lb[i]; i++) {
3307     for (id = lb[i]->first; id; id = id->next) {
3308       if (id->tag & LIB_TAG_DOIT) {
3309         previews_id_ensure(C, NULL, id);
3310         id->tag &= ~LIB_TAG_DOIT;
3311       }
3312     }
3313   }
3314
3315   return OPERATOR_FINISHED;
3316 }
3317
3318 static void WM_OT_previews_ensure(wmOperatorType *ot)
3319 {
3320   ot->name = "Refresh Data-Block Previews";
3321   ot->idname = "WM_OT_previews_ensure";
3322   ot->description =
3323       "Ensure data-block previews are available and up-to-date "
3324       "(to be saved in .blend file, only for some types like materials, textures, etc.)";
3325
3326   ot->exec = previews_ensure_exec;
3327 }
3328
3329 /* *************************** Datablocks previews clear ************* */
3330
3331 /* Only types supporting previews currently. */
3332 static const EnumPropertyItem preview_id_type_items[] = {
3333     {FILTER_ID_SCE, "SCENE", 0, "Scenes", ""},
3334     {FILTER_ID_GR, "GROUP", 0, "Groups", ""},
3335     {FILTER_ID_OB, "OBJECT", 0, "Objects", ""},
3336     {FILTER_ID_MA, "MATERIAL", 0, "Materials", ""},
3337     {FILTER_ID_LA, "LIGHT", 0, "Lights", ""},
3338     {FILTER_ID_WO, "WORLD", 0, "Worlds", ""},
3339     {FILTER_ID_TE, "TEXTURE", 0, "Textures", ""},
3340     {FILTER_ID_IM, "IMAGE", 0, "Images", ""},
3341 #if 0 /* XXX TODO */
3342     {FILTER_ID_BR, "BRUSH", 0, "Brushes", ""},
3343 #endif
3344     {0, NULL, 0, NULL, NULL},
3345 };
3346
3347 static int previews_clear_exec(bContext *C, wmOperator *op)
3348 {
3349   Main *bmain = CTX_data_main(C);
3350   ListBase *lb[] = {
3351       &bmain->objects,
3352       &bmain->collections,
3353       &bmain->materials,
3354       &bmain->worlds,
3355       &bmain->lights,
3356       &bmain->textures,
3357       &bmain->images,
3358       NULL,
3359   };
3360   int i;
3361
3362   const int id_filters = RNA_enum_get(op->ptr, "id_type");
3363
3364   for (i = 0; lb[i]; i++) {
3365     ID *id = lb[i]->first;
3366     if (!id) {
3367       continue;
3368     }
3369
3370 #if 0
3371     printf("%s: %d, %d, %d -> %d\n",
3372            id->name,
3373            GS(id->name),
3374            BKE_idcode_to_idfilter(GS(id->name)),
3375            id_filters,
3376            BKE_idcode_to_idfilter(GS(id->name)) & id_filters);
3377 #endif
3378
3379     if (!id || !(BKE_idcode_to_idfilter(GS(id->name)) & id_filters)) {
3380       continue;
3381     }
3382
3383     for (; id; id = id->next) {
3384       PreviewImage *prv_img = BKE_previewimg_id_ensure(id);
3385
3386       BKE_previewimg_clear(prv_img);
3387     }
3388   }
3389
3390   return OPERATOR_FINISHED;
3391 }
3392
3393 static void WM_OT_previews_clear(wmOperatorType *ot)
3394 {
3395   ot->name = "Clear Data-Block Previews";
3396   ot->idname = "WM_OT_previews_clear";
3397   ot->description =
3398       "Clear data-block previews (only for some types like objects, materials, textures, etc.)";
3399
3400   ot->exec = previews_clear_exec;
3401   ot->invoke = WM_menu_invoke;
3402
3403   ot->prop = RNA_def_enum_flag(ot->srna,
3404                                "id_type",
3405                                preview_id_type_items,
3406                                FILTER_ID_SCE | FILTER_ID_OB | FILTER_ID_GR | FILTER_ID_MA |
3407                                    FILTER_ID_LA | FILTER_ID_WO | FILTER_ID_TE | FILTER_ID_IM,
3408                                "Data-Block Type",
3409                                "Which data-block previews to clear");
3410 }
3411
3412 /* *************************** Doc from UI ************* */
3413
3414 static int doc_view_manual_ui_context_exec(bContext *C, wmOperator *UNUSED(op))
3415 {
3416   PointerRNA ptr_props;
3417   char buf[512];
3418   short retval = OPERATOR_CANCELLED;
3419
3420   if (UI_but_online_manual_id_from_active(C, buf, sizeof(buf))) {
3421     WM_operator_properties_create(&ptr_props, "WM_OT_doc_view_manual");
3422     RNA_string_set(&ptr_props, "doc_id", buf);
3423
3424     retval = WM_operator_name_call_ptr(
3425         C, WM_operatortype_find("WM_OT_doc_view_manual", false), WM_OP_EXEC_DEFAULT, &ptr_props);
3426
3427     WM_operator_properties_free(&ptr_props);
3428   }
3429
3430   return retval;
3431 }
3432
3433 static void WM_OT_doc_view_manual_ui_context(wmOperatorType *ot)
3434 {
3435   /* identifiers */
3436   ot->name = "View Online Manual";
3437   ot->idname = "WM_OT_doc_view_manual_ui_context";
3438   ot->description = "View a context based online manual in a web browser";
3439
3440   /* callbacks */
3441   ot->poll = ED_operator_regionactive;
3442   ot->exec = doc_view_manual_ui_context_exec;
3443 }
3444
3445 /* ******************************************************* */
3446 /* toggle 3D for current window, turning it fullscreen if needed */
3447 static void WM_OT_stereo3d_set(wmOperatorType *ot)
3448 {
3449   PropertyRNA *prop;
3450
3451   ot->name = "Set Stereo 3D";
3452   ot->idname = "WM_OT_set_stereo_3d";
3453   ot->description = "Toggle 3D stereo support for current window (or change the display mode)";
3454
3455   ot->exec = wm_stereo3d_set_exec;
3456   ot->invoke = wm_stereo3d_set_invoke;
3457   ot->poll = WM_operator_winactive;
3458   ot->ui = wm_stereo3d_set_draw;
3459   ot->check = wm_stereo3d_set_check;
3460   ot->cancel = wm_stereo3d_set_cancel;
3461
3462   prop = RNA_def_enum(ot->srna,
3463                       "display_mode",
3464                       rna_enum_stereo3d_display_items,
3465                       S3D_DISPLAY_ANAGLYPH,
3466                       "Display Mode",
3467                       "");
3468   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3469   prop = RNA_def_enum(ot->srna,
3470                       "anaglyph_type",
3471                       rna_enum_stereo3d_anaglyph_type_items,
3472                       S3D_ANAGLYPH_REDCYAN,
3473                       "Anaglyph Type",
3474                       "");
3475   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3476   prop = RNA_def_enum(ot->srna,
3477                       "interlace_type",
3478                       rna_enum_stereo3d_interlace_type_items,
3479                       S3D_INTERLACE_ROW,
3480                       "Interlace Type",
3481                       "");
3482   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3483   prop = RNA_def_boolean(ot->srna,
3484                          "use_interlace_swap",
3485                          false,
3486                          "Swap Left/Right",
3487                          "Swap left and right stereo channels");
3488   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3489   prop = RNA_def_boolean(ot->srna,
3490                          "use_sidebyside_crosseyed",
3491                          false,
3492                          "Cross-Eyed",
3493                          "Right eye should see left image and vice-versa");
3494   RNA_def_property_flag(prop, PROP_SKIP_SAVE);
3495 }
3496
3497 void wm_operatortypes_register(void)
3498 {
3499   WM_operatortype_append(WM_OT_window_close);
3500   WM_operatortype_append(WM_OT_window_new);
3501   WM_operatortype_append(WM_OT_window_new_main);
3502   WM_operatortype_append(WM_OT_read_history);
3503   WM_operatortype_append(WM_OT_read_homefile);
3504   WM_operatortype_append(WM_OT_read_factory_settings);
3505   WM_operatortype_append(WM_OT_save_homefile);
3506   WM_operatortype_append(WM_OT_save_userpref);
3507   WM_operatortype_append(WM_OT_userpref_autoexec_path_add);
3508   WM_operatortype_append(WM_OT_userpref_autoexec_path_remove);
3509   WM_operatortype_append(WM_OT_window_fullscreen_toggle);
3510   WM_operatortype_append(WM_OT_quit_blender);
3511   WM_operatortype_append(WM_OT_open_mainfile);
3512   WM_operatortype_append(WM_OT_revert_mainfile);
3513   WM_operatortype_append(WM_OT_link);
3514   WM_operatortype_append(WM_OT_append);
3515   WM_operatortype_append(WM_OT_lib_relocate);
3516   WM_operatortype_append(WM_OT_lib_reload);
3517   WM_operatortype_append(WM_OT_recover_last_session);
3518   WM_operatortype_append(WM_OT_recover_auto_save);
3519   WM_operatortype_append(WM_OT_save_as_mainfile);
3520   WM_operatortype_append(WM_OT_save_mainfile);
3521   WM_operatortype_append(WM_OT_redraw_timer);
3522   WM_operatortype_append(WM_OT_memory_statistics);
3523   WM_operatortype_append(WM_OT_debug_menu);
3524   WM_operatortype_append(WM_OT_operator_defaults);
3525   WM_operatortype_append(WM_OT_splash);
3526   WM_operatortype_append(WM_OT_search_menu);
3527   WM_operatortype_append(WM_OT_call_menu);
3528   WM_operatortype_append(WM_OT_call_menu_pie);
3529   WM_operatortype_append(WM_OT_call_panel);
3530   WM_operatortype_append(WM_OT_radial_control);
3531   WM_operatortype_append(WM_OT_stereo3d_set);
3532 #if defined(WIN32)
3533   WM_operatortype_append(WM_OT_console_toggle);
3534 #endif
3535   WM_operatortype_append(WM_OT_previews_ensure);
3536   WM_operatortype_append(WM_OT_previews_clear);
3537   WM_operatortype_append(WM_OT_doc_view_manual_ui_context);
3538
3539   /* gizmos */
3540   WM_operatortype_append(GIZMOGROUP_OT_gizmo_select);
3541   WM_operatortype_append(GIZMOGROUP_OT_gizmo_tweak);
3542 }
3543
3544 /* circleselect-like modal operators */
3545 static void gesture_circle_modal_keymap(wmKeyConfig *keyconf)
3546 {
3547   static const EnumPropertyItem modal_items[] = {
3548       {GESTURE_MODAL_CANCEL, "CANCEL", 0, "Cancel", ""},
3549       {GESTURE_MODAL_CONFIRM, "CONFIRM", 0, "Confirm", ""},
3550       {GESTURE_MODAL_CIRCLE_ADD, "ADD", 0, "Add", ""},
3551       {GESTURE_MODAL_CIRCLE_SUB, "SUBTRACT", 0, "Subtract", ""},
3552       {GESTURE_MODAL_CIRCLE_SIZE, "SIZE", 0, "Size", ""},
3553
3554       {GESTURE_MODAL_SELECT, "SELECT", 0, "Select", ""},
3555       {GESTURE_MODAL_DESELECT, "DESELECT", 0, "DeSelect", ""},
3556       {GESTURE_MODAL_NOP, "NOP", 0, "No Operation", ""},
3557
3558       {0, NULL, 0, NULL, NULL},
3559   };
3560
3561   /* WARNING - name is incorrect, use for non-3d views */
3562   wmKeyMap *keymap = WM_modalkeymap_get(keyconf, "View3D Gesture Circle");
3563
3564   /* this function is called for each spacetype, only needs to add map once */
3565   if (keymap && keymap->modal_items) {
3566     return;
3567   }
3568
3569   keymap = WM_modalkeymap_add(keyconf, "View3D Gesture Circle", modal_items);
3570
3571   /* assign map to operators */
3572   WM_modalkeymap_assign(keymap, "VIEW3D_OT_select_circle");
3573   WM_modalkeymap_assign(keymap, "UV_OT_select_circle");
3574   WM_modalkeymap_assign(keymap, "CLIP_OT_select_circle");
3575   WM_modalkeymap_assign(keymap, "MASK_OT_select_circle");
3576   WM_modalkeymap_assign(keymap, "NODE_OT_select_circle");
3577   WM_modalkeymap_assign(keymap, "GPENCIL_OT_select_circle");
3578   WM_modalkeymap_assign(keymap, "GRAPH_OT_select_circle");
3579   WM_modalkeymap_assign(keymap, "ACTION_OT_select_circle");
3580 }
3581
3582 /* straight line modal operators */
3583 static void gesture_straightline_modal_keymap(wmKeyConfig *keyconf)
3584 {
3585   static const EnumPropertyItem modal_items[] = {