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