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