Tool System: per space/mode tool support
[blender.git] / release / scripts / startup / bl_operators / wm.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 import bpy
22 from bpy.types import Operator
23 from bpy.props import (
24     BoolProperty,
25     EnumProperty,
26     FloatProperty,
27     IntProperty,
28     StringProperty,
29 )
30
31 from bpy.app.translations import pgettext_tip as tip_
32
33
34 rna_path_prop = StringProperty(
35         name="Context Attributes",
36         description="RNA context string",
37         maxlen=1024,
38         )
39
40 rna_reverse_prop = BoolProperty(
41         name="Reverse",
42         description="Cycle backwards",
43         default=False,
44         )
45
46 rna_wrap_prop = BoolProperty(
47         name="Wrap",
48         description="Wrap back to the first/last values",
49         default=False,
50         )
51
52 rna_relative_prop = BoolProperty(
53         name="Relative",
54         description="Apply relative to the current value (delta)",
55         default=False,
56         )
57
58
59 def context_path_validate(context, data_path):
60     try:
61         value = eval("context.%s" % data_path) if data_path else Ellipsis
62     except AttributeError as ex:
63         if str(ex).startswith("'NoneType'"):
64             # One of the items in the rna path is None, just ignore this
65             value = Ellipsis
66         else:
67             # We have a real error in the rna path, don't ignore that
68             raise
69
70     return value
71
72
73 def operator_value_is_undo(value):
74     if value in {None, Ellipsis}:
75         return False
76
77     # typical properties or objects
78     id_data = getattr(value, "id_data", Ellipsis)
79
80     if id_data is None:
81         return False
82     elif id_data is Ellipsis:
83         # handle mathutils types
84         id_data = getattr(getattr(value, "owner", None), "id_data", None)
85
86         if id_data is None:
87             return False
88
89     # return True if its a non window ID type
90     return (isinstance(id_data, bpy.types.ID) and
91             (not isinstance(id_data, (bpy.types.WindowManager,
92                                       bpy.types.Screen,
93                                       bpy.types.Brush,
94                                       ))))
95
96
97 def operator_path_is_undo(context, data_path):
98     # note that if we have data paths that use strings this could fail
99     # luckily we don't do this!
100     #
101     # When we cant find the data owner assume no undo is needed.
102     data_path_head = data_path.rpartition(".")[0]
103
104     if not data_path_head:
105         return False
106
107     value = context_path_validate(context, data_path_head)
108
109     return operator_value_is_undo(value)
110
111
112 def operator_path_undo_return(context, data_path):
113     return {'FINISHED'} if operator_path_is_undo(context, data_path) else {'CANCELLED'}
114
115
116 def operator_value_undo_return(value):
117     return {'FINISHED'} if operator_value_is_undo(value) else {'CANCELLED'}
118
119
120 def execute_context_assign(self, context):
121     data_path = self.data_path
122     if context_path_validate(context, data_path) is Ellipsis:
123         return {'PASS_THROUGH'}
124
125     if getattr(self, "relative", False):
126         exec("context.%s += self.value" % data_path)
127     else:
128         exec("context.%s = self.value" % data_path)
129
130     return operator_path_undo_return(context, data_path)
131
132
133 def module_filesystem_remove(path_base, module_name):
134     import os
135     module_name = os.path.splitext(module_name)[0]
136     for f in os.listdir(path_base):
137         f_base = os.path.splitext(f)[0]
138         if f_base == module_name:
139             f_full = os.path.join(path_base, f)
140
141             if os.path.isdir(f_full):
142                 os.rmdir(f_full)
143             else:
144                 os.remove(f_full)
145
146
147 class BRUSH_OT_active_index_set(Operator):
148     """Set active sculpt/paint brush from it's number"""
149     bl_idname = "brush.active_index_set"
150     bl_label = "Set Brush Number"
151
152     mode = StringProperty(
153             name="Mode",
154             description="Paint mode to set brush for",
155             maxlen=1024,
156             )
157     index = IntProperty(
158             name="Number",
159             description="Brush number",
160             )
161
162     _attr_dict = {
163         "sculpt": "use_paint_sculpt",
164         "vertex_paint": "use_paint_vertex",
165         "weight_paint": "use_paint_weight",
166         "image_paint": "use_paint_image",
167     }
168
169     def execute(self, context):
170         attr = self._attr_dict.get(self.mode)
171         if attr is None:
172             return {'CANCELLED'}
173
174         toolsettings = context.tool_settings
175         for i, brush in enumerate((cur for cur in bpy.data.brushes if getattr(cur, attr))):
176             if i == self.index:
177                 getattr(toolsettings, self.mode).brush = brush
178                 return {'FINISHED'}
179
180         return {'CANCELLED'}
181
182
183 class WM_OT_context_set_boolean(Operator):
184     """Set a context value"""
185     bl_idname = "wm.context_set_boolean"
186     bl_label = "Context Set Boolean"
187     bl_options = {'UNDO', 'INTERNAL'}
188
189     data_path = rna_path_prop
190     value = BoolProperty(
191             name="Value",
192             description="Assignment value",
193             default=True,
194             )
195
196     execute = execute_context_assign
197
198
199 class WM_OT_context_set_int(Operator):  # same as enum
200     """Set a context value"""
201     bl_idname = "wm.context_set_int"
202     bl_label = "Context Set"
203     bl_options = {'UNDO', 'INTERNAL'}
204
205     data_path = rna_path_prop
206     value = IntProperty(
207             name="Value",
208             description="Assign value",
209             default=0,
210             )
211     relative = rna_relative_prop
212
213     execute = execute_context_assign
214
215
216 class WM_OT_context_scale_float(Operator):
217     """Scale a float context value"""
218     bl_idname = "wm.context_scale_float"
219     bl_label = "Context Scale Float"
220     bl_options = {'UNDO', 'INTERNAL'}
221
222     data_path = rna_path_prop
223     value = FloatProperty(
224             name="Value",
225             description="Assign value",
226             default=1.0,
227             )
228
229     def execute(self, context):
230         data_path = self.data_path
231         if context_path_validate(context, data_path) is Ellipsis:
232             return {'PASS_THROUGH'}
233
234         value = self.value
235
236         if value == 1.0:  # nothing to do
237             return {'CANCELLED'}
238
239         exec("context.%s *= value" % data_path)
240
241         return operator_path_undo_return(context, data_path)
242
243
244 class WM_OT_context_scale_int(Operator):
245     """Scale an int context value"""
246     bl_idname = "wm.context_scale_int"
247     bl_label = "Context Scale Int"
248     bl_options = {'UNDO', 'INTERNAL'}
249
250     data_path = rna_path_prop
251     value = FloatProperty(
252             name="Value",
253             description="Assign value",
254             default=1.0,
255             )
256     always_step = BoolProperty(
257             name="Always Step",
258             description="Always adjust the value by a minimum of 1 when 'value' is not 1.0",
259             default=True,
260             )
261
262     def execute(self, context):
263         data_path = self.data_path
264         if context_path_validate(context, data_path) is Ellipsis:
265             return {'PASS_THROUGH'}
266
267         value = self.value
268
269         if value == 1.0:  # nothing to do
270             return {'CANCELLED'}
271
272         if getattr(self, "always_step", False):
273             if value > 1.0:
274                 add = "1"
275                 func = "max"
276             else:
277                 add = "-1"
278                 func = "min"
279             exec("context.%s = %s(round(context.%s * value), context.%s + %s)" %
280                  (data_path, func, data_path, data_path, add))
281         else:
282             exec("context.%s *= value" % data_path)
283
284         return operator_path_undo_return(context, data_path)
285
286
287 class WM_OT_context_set_float(Operator):  # same as enum
288     """Set a context value"""
289     bl_idname = "wm.context_set_float"
290     bl_label = "Context Set Float"
291     bl_options = {'UNDO', 'INTERNAL'}
292
293     data_path = rna_path_prop
294     value = FloatProperty(
295             name="Value",
296             description="Assignment value",
297             default=0.0,
298             )
299     relative = rna_relative_prop
300
301     execute = execute_context_assign
302
303
304 class WM_OT_context_set_string(Operator):  # same as enum
305     """Set a context value"""
306     bl_idname = "wm.context_set_string"
307     bl_label = "Context Set String"
308     bl_options = {'UNDO', 'INTERNAL'}
309
310     data_path = rna_path_prop
311     value = StringProperty(
312             name="Value",
313             description="Assign value",
314             maxlen=1024,
315             )
316
317     execute = execute_context_assign
318
319
320 class WM_OT_context_set_enum(Operator):
321     """Set a context value"""
322     bl_idname = "wm.context_set_enum"
323     bl_label = "Context Set Enum"
324     bl_options = {'UNDO', 'INTERNAL'}
325
326     data_path = rna_path_prop
327     value = StringProperty(
328             name="Value",
329             description="Assignment value (as a string)",
330             maxlen=1024,
331             )
332
333     execute = execute_context_assign
334
335
336 class WM_OT_context_set_value(Operator):
337     """Set a context value"""
338     bl_idname = "wm.context_set_value"
339     bl_label = "Context Set Value"
340     bl_options = {'UNDO', 'INTERNAL'}
341
342     data_path = rna_path_prop
343     value = StringProperty(
344             name="Value",
345             description="Assignment value (as a string)",
346             maxlen=1024,
347             )
348
349     def execute(self, context):
350         data_path = self.data_path
351         if context_path_validate(context, data_path) is Ellipsis:
352             return {'PASS_THROUGH'}
353         exec("context.%s = %s" % (data_path, self.value))
354         return operator_path_undo_return(context, data_path)
355
356
357 class WM_OT_context_toggle(Operator):
358     """Toggle a context value"""
359     bl_idname = "wm.context_toggle"
360     bl_label = "Context Toggle"
361     bl_options = {'UNDO', 'INTERNAL'}
362
363     data_path = rna_path_prop
364
365     def execute(self, context):
366         data_path = self.data_path
367
368         if context_path_validate(context, data_path) is Ellipsis:
369             return {'PASS_THROUGH'}
370
371         exec("context.%s = not (context.%s)" % (data_path, data_path))
372
373         return operator_path_undo_return(context, data_path)
374
375
376 class WM_OT_context_toggle_enum(Operator):
377     """Toggle a context value"""
378     bl_idname = "wm.context_toggle_enum"
379     bl_label = "Context Toggle Values"
380     bl_options = {'UNDO', 'INTERNAL'}
381
382     data_path = rna_path_prop
383     value_1 = StringProperty(
384             name="Value",
385             description="Toggle enum",
386             maxlen=1024,
387             )
388     value_2 = StringProperty(
389             name="Value",
390             description="Toggle enum",
391             maxlen=1024,
392             )
393
394     def execute(self, context):
395         data_path = self.data_path
396
397         if context_path_validate(context, data_path) is Ellipsis:
398             return {'PASS_THROUGH'}
399
400         # failing silently is not ideal, but we don't want errors for shortcut
401         # keys that some values that are only available in a particular context
402         try:
403             exec("context.%s = ('%s', '%s')[context.%s != '%s']" %
404                  (data_path, self.value_1,
405                   self.value_2, data_path,
406                   self.value_2,
407                   ))
408         except:
409             return {'PASS_THROUGH'}
410
411         return operator_path_undo_return(context, data_path)
412
413
414 class WM_OT_context_cycle_int(Operator):
415     """Set a context value (useful for cycling active material, """ \
416     """vertex keys, groups, etc.)"""
417     bl_idname = "wm.context_cycle_int"
418     bl_label = "Context Int Cycle"
419     bl_options = {'UNDO', 'INTERNAL'}
420
421     data_path = rna_path_prop
422     reverse = rna_reverse_prop
423     wrap = rna_wrap_prop
424
425     def execute(self, context):
426         data_path = self.data_path
427         value = context_path_validate(context, data_path)
428         if value is Ellipsis:
429             return {'PASS_THROUGH'}
430
431         if self.reverse:
432             value -= 1
433         else:
434             value += 1
435
436         exec("context.%s = value" % data_path)
437
438         if self.wrap:
439             if value != eval("context.%s" % data_path):
440                 # relies on rna clamping integers out of the range
441                 if self.reverse:
442                     value = (1 << 31) - 1
443                 else:
444                     value = -1 << 31
445
446                 exec("context.%s = value" % data_path)
447
448         return operator_path_undo_return(context, data_path)
449
450
451 class WM_OT_context_cycle_enum(Operator):
452     """Toggle a context value"""
453     bl_idname = "wm.context_cycle_enum"
454     bl_label = "Context Enum Cycle"
455     bl_options = {'UNDO', 'INTERNAL'}
456
457     data_path = rna_path_prop
458     reverse = rna_reverse_prop
459     wrap = rna_wrap_prop
460
461     def execute(self, context):
462         data_path = self.data_path
463         value = context_path_validate(context, data_path)
464         if value is Ellipsis:
465             return {'PASS_THROUGH'}
466
467         orig_value = value
468
469         # Have to get rna enum values
470         rna_struct_str, rna_prop_str = data_path.rsplit('.', 1)
471         i = rna_prop_str.find('[')
472
473         # just in case we get "context.foo.bar[0]"
474         if i != -1:
475             rna_prop_str = rna_prop_str[0:i]
476
477         rna_struct = eval("context.%s.rna_type" % rna_struct_str)
478
479         rna_prop = rna_struct.properties[rna_prop_str]
480
481         if type(rna_prop) != bpy.types.EnumProperty:
482             raise Exception("expected an enum property")
483
484         enums = rna_struct.properties[rna_prop_str].enum_items.keys()
485         orig_index = enums.index(orig_value)
486
487         # Have the info we need, advance to the next item.
488         #
489         # When wrap's disabled we may set the value to its self,
490         # this is done to ensure update callbacks run.
491         if self.reverse:
492             if orig_index == 0:
493                 advance_enum = enums[-1] if self.wrap else enums[0]
494             else:
495                 advance_enum = enums[orig_index - 1]
496         else:
497             if orig_index == len(enums) - 1:
498                 advance_enum = enums[0] if self.wrap else enums[-1]
499             else:
500                 advance_enum = enums[orig_index + 1]
501
502         # set the new value
503         exec("context.%s = advance_enum" % data_path)
504         return operator_path_undo_return(context, data_path)
505
506
507 class WM_OT_context_cycle_array(Operator):
508     """Set a context array value """ \
509     """(useful for cycling the active mesh edit mode)"""
510     bl_idname = "wm.context_cycle_array"
511     bl_label = "Context Array Cycle"
512     bl_options = {'UNDO', 'INTERNAL'}
513
514     data_path = rna_path_prop
515     reverse = rna_reverse_prop
516
517     def execute(self, context):
518         data_path = self.data_path
519         value = context_path_validate(context, data_path)
520         if value is Ellipsis:
521             return {'PASS_THROUGH'}
522
523         def cycle(array):
524             if self.reverse:
525                 array.insert(0, array.pop())
526             else:
527                 array.append(array.pop(0))
528             return array
529
530         exec("context.%s = cycle(context.%s[:])" % (data_path, data_path))
531
532         return operator_path_undo_return(context, data_path)
533
534
535 class WM_OT_context_menu_enum(Operator):
536     bl_idname = "wm.context_menu_enum"
537     bl_label = "Context Enum Menu"
538     bl_options = {'UNDO', 'INTERNAL'}
539     data_path = rna_path_prop
540
541     def execute(self, context):
542         data_path = self.data_path
543         value = context_path_validate(context, data_path)
544
545         if value is Ellipsis:
546             return {'PASS_THROUGH'}
547
548         base_path, prop_string = data_path.rsplit(".", 1)
549         value_base = context_path_validate(context, base_path)
550         prop = value_base.bl_rna.properties[prop_string]
551
552         def draw_cb(self, context):
553             layout = self.layout
554             layout.prop(value_base, prop_string, expand=True)
555
556         context.window_manager.popup_menu(draw_func=draw_cb, title=prop.name, icon=prop.icon)
557
558         return {'FINISHED'}
559
560
561 class WM_OT_context_pie_enum(Operator):
562     bl_idname = "wm.context_pie_enum"
563     bl_label = "Context Enum Pie"
564     bl_options = {'UNDO', 'INTERNAL'}
565     data_path = rna_path_prop
566
567     def invoke(self, context, event):
568         wm = context.window_manager
569         data_path = self.data_path
570         value = context_path_validate(context, data_path)
571
572         if value is Ellipsis:
573             return {'PASS_THROUGH'}
574
575         base_path, prop_string = data_path.rsplit(".", 1)
576         value_base = context_path_validate(context, base_path)
577         prop = value_base.bl_rna.properties[prop_string]
578
579         def draw_cb(self, context):
580             layout = self.layout
581             layout.prop(value_base, prop_string, expand=True)
582
583         wm.popup_menu_pie(draw_func=draw_cb, title=prop.name, icon=prop.icon, event=event)
584
585         return {'FINISHED'}
586
587
588 class WM_OT_operator_pie_enum(Operator):
589     bl_idname = "wm.operator_pie_enum"
590     bl_label = "Operator Enum Pie"
591     bl_options = {'UNDO', 'INTERNAL'}
592     data_path = StringProperty(
593             name="Operator",
594             description="Operator name (in python as string)",
595             maxlen=1024,
596             )
597     prop_string = StringProperty(
598             name="Property",
599             description="Property name (as a string)",
600             maxlen=1024,
601             )
602
603     def invoke(self, context, event):
604         wm = context.window_manager
605
606         data_path = self.data_path
607         prop_string = self.prop_string
608
609         # same as eval("bpy.ops." + data_path)
610         op_mod_str, ob_id_str = data_path.split(".", 1)
611         op = getattr(getattr(bpy.ops, op_mod_str), ob_id_str)
612         del op_mod_str, ob_id_str
613
614         try:
615             op_rna = op.get_rna()
616         except KeyError:
617             self.report({'ERROR'}, "Operator not found: bpy.ops.%s" % data_path)
618             return {'CANCELLED'}
619
620         def draw_cb(self, context):
621             layout = self.layout
622             pie = layout.menu_pie()
623             pie.operator_enum(data_path, prop_string)
624
625         wm.popup_menu_pie(draw_func=draw_cb, title=op_rna.bl_rna.name, event=event)
626
627         return {'FINISHED'}
628
629
630 class WM_OT_context_set_id(Operator):
631     """Set a context value to an ID data-block"""
632     bl_idname = "wm.context_set_id"
633     bl_label = "Set Library ID"
634     bl_options = {'UNDO', 'INTERNAL'}
635
636     data_path = rna_path_prop
637     value = StringProperty(
638             name="Value",
639             description="Assign value",
640             maxlen=1024,
641             )
642
643     def execute(self, context):
644         value = self.value
645         data_path = self.data_path
646
647         # match the pointer type from the target property to bpy.data.*
648         # so we lookup the correct list.
649         data_path_base, data_path_prop = data_path.rsplit(".", 1)
650         data_prop_rna = eval("context.%s" % data_path_base).rna_type.properties[data_path_prop]
651         data_prop_rna_type = data_prop_rna.fixed_type
652
653         id_iter = None
654
655         for prop in bpy.data.rna_type.properties:
656             if prop.rna_type.identifier == "CollectionProperty":
657                 if prop.fixed_type == data_prop_rna_type:
658                     id_iter = prop.identifier
659                     break
660
661         if id_iter:
662             value_id = getattr(bpy.data, id_iter).get(value)
663             exec("context.%s = value_id" % data_path)
664
665         return operator_path_undo_return(context, data_path)
666
667
668 doc_id = StringProperty(
669         name="Doc ID",
670         maxlen=1024,
671         options={'HIDDEN'},
672         )
673
674 data_path_iter = StringProperty(
675         description="The data path relative to the context, must point to an iterable")
676
677 data_path_item = StringProperty(
678         description="The data path from each iterable to the value (int or float)")
679
680
681 class WM_OT_context_collection_boolean_set(Operator):
682     """Set boolean values for a collection of items"""
683     bl_idname = "wm.context_collection_boolean_set"
684     bl_label = "Context Collection Boolean Set"
685     bl_options = {'UNDO', 'REGISTER', 'INTERNAL'}
686
687     data_path_iter = data_path_iter
688     data_path_item = data_path_item
689
690     type = EnumProperty(
691             name="Type",
692             items=(('TOGGLE', "Toggle", ""),
693                    ('ENABLE', "Enable", ""),
694                    ('DISABLE', "Disable", ""),
695                    ),
696             )
697
698     def execute(self, context):
699         data_path_iter = self.data_path_iter
700         data_path_item = self.data_path_item
701
702         items = list(getattr(context, data_path_iter))
703         items_ok = []
704         is_set = False
705         for item in items:
706             try:
707                 value_orig = eval("item." + data_path_item)
708             except:
709                 continue
710
711             if value_orig is True:
712                 is_set = True
713             elif value_orig is False:
714                 pass
715             else:
716                 self.report({'WARNING'}, "Non boolean value found: %s[ ].%s" %
717                             (data_path_iter, data_path_item))
718                 return {'CANCELLED'}
719
720             items_ok.append(item)
721
722         # avoid undo push when nothing to do
723         if not items_ok:
724             return {'CANCELLED'}
725
726         if self.type == 'ENABLE':
727             is_set = True
728         elif self.type == 'DISABLE':
729             is_set = False
730         else:
731             is_set = not is_set
732
733         exec_str = "item.%s = %s" % (data_path_item, is_set)
734         for item in items_ok:
735             exec(exec_str)
736
737         return operator_value_undo_return(item)
738
739
740 class WM_OT_context_modal_mouse(Operator):
741     """Adjust arbitrary values with mouse input"""
742     bl_idname = "wm.context_modal_mouse"
743     bl_label = "Context Modal Mouse"
744     bl_options = {'GRAB_CURSOR', 'BLOCKING', 'UNDO', 'INTERNAL'}
745
746     data_path_iter = data_path_iter
747     data_path_item = data_path_item
748     header_text = StringProperty(
749             name="Header Text",
750             description="Text to display in header during scale",
751             )
752
753     input_scale = FloatProperty(
754             description="Scale the mouse movement by this value before applying the delta",
755             default=0.01,
756             )
757     invert = BoolProperty(
758             description="Invert the mouse input",
759             default=False,
760             )
761     initial_x = IntProperty(options={'HIDDEN'})
762
763     def _values_store(self, context):
764         data_path_iter = self.data_path_iter
765         data_path_item = self.data_path_item
766
767         self._values = values = {}
768
769         for item in getattr(context, data_path_iter):
770             try:
771                 value_orig = eval("item." + data_path_item)
772             except:
773                 continue
774
775             # check this can be set, maybe this is library data.
776             try:
777                 exec("item.%s = %s" % (data_path_item, value_orig))
778             except:
779                 continue
780
781             values[item] = value_orig
782
783     def _values_delta(self, delta):
784         delta *= self.input_scale
785         if self.invert:
786             delta = - delta
787
788         data_path_item = self.data_path_item
789         for item, value_orig in self._values.items():
790             if type(value_orig) == int:
791                 exec("item.%s = int(%d)" % (data_path_item, round(value_orig + delta)))
792             else:
793                 exec("item.%s = %f" % (data_path_item, value_orig + delta))
794
795     def _values_restore(self):
796         data_path_item = self.data_path_item
797         for item, value_orig in self._values.items():
798             exec("item.%s = %s" % (data_path_item, value_orig))
799
800         self._values.clear()
801
802     def _values_clear(self):
803         self._values.clear()
804
805     def modal(self, context, event):
806         event_type = event.type
807
808         if event_type == 'MOUSEMOVE':
809             delta = event.mouse_x - self.initial_x
810             self._values_delta(delta)
811             header_text = self.header_text
812             if header_text:
813                 if len(self._values) == 1:
814                     (item, ) = self._values.keys()
815                     header_text = header_text % eval("item.%s" % self.data_path_item)
816                 else:
817                     header_text = (self.header_text % delta) + " (delta)"
818                 context.area.header_text_set(header_text)
819
820         elif 'LEFTMOUSE' == event_type:
821             item = next(iter(self._values.keys()))
822             self._values_clear()
823             context.area.header_text_set()
824             return operator_value_undo_return(item)
825
826         elif event_type in {'RIGHTMOUSE', 'ESC'}:
827             self._values_restore()
828             context.area.header_text_set()
829             return {'CANCELLED'}
830
831         return {'RUNNING_MODAL'}
832
833     def invoke(self, context, event):
834         self._values_store(context)
835
836         if not self._values:
837             self.report({'WARNING'}, "Nothing to operate on: %s[ ].%s" %
838                         (self.data_path_iter, self.data_path_item))
839
840             return {'CANCELLED'}
841         else:
842             self.initial_x = event.mouse_x
843
844             context.window_manager.modal_handler_add(self)
845             return {'RUNNING_MODAL'}
846
847
848 class WM_OT_url_open(Operator):
849     """Open a website in the web-browser"""
850     bl_idname = "wm.url_open"
851     bl_label = ""
852     bl_options = {'INTERNAL'}
853
854     url = StringProperty(
855             name="URL",
856             description="URL to open",
857             )
858
859     def execute(self, context):
860         import webbrowser
861         webbrowser.open(self.url)
862         return {'FINISHED'}
863
864
865 class WM_OT_path_open(Operator):
866     """Open a path in a file browser"""
867     bl_idname = "wm.path_open"
868     bl_label = ""
869     bl_options = {'INTERNAL'}
870
871     filepath = StringProperty(
872             subtype='FILE_PATH',
873             options={'SKIP_SAVE'},
874             )
875
876     def execute(self, context):
877         import sys
878         import os
879         import subprocess
880
881         filepath = self.filepath
882
883         if not filepath:
884             self.report({'ERROR'}, "File path was not set")
885             return {'CANCELLED'}
886
887         filepath = bpy.path.abspath(filepath)
888         filepath = os.path.normpath(filepath)
889
890         if not os.path.exists(filepath):
891             self.report({'ERROR'}, "File '%s' not found" % filepath)
892             return {'CANCELLED'}
893
894         if sys.platform[:3] == "win":
895             os.startfile(filepath)
896         elif sys.platform == "darwin":
897             subprocess.check_call(["open", filepath])
898         else:
899             try:
900                 subprocess.check_call(["xdg-open", filepath])
901             except:
902                 # xdg-open *should* be supported by recent Gnome, KDE, Xfce
903                 import traceback
904                 traceback.print_exc()
905
906         return {'FINISHED'}
907
908
909 def _wm_doc_get_id(doc_id, do_url=True, url_prefix=""):
910
911     def operator_exists_pair(a, b):
912         # Not fast, this is only for docs.
913         return b in dir(getattr(bpy.ops, a))
914
915     def operator_exists_single(a):
916         a, b = a.partition("_OT_")[::2]
917         return operator_exists_pair(a.lower(), b)
918
919     id_split = doc_id.split(".")
920     url = rna = None
921
922     if len(id_split) == 1:  # rna, class
923         if do_url:
924             url = "%s/bpy.types.%s.html" % (url_prefix, id_split[0])
925         else:
926             rna = "bpy.types.%s" % id_split[0]
927
928     elif len(id_split) == 2:  # rna, class.prop
929         class_name, class_prop = id_split
930
931         # an operator (common case - just button referencing an op)
932         if operator_exists_pair(class_name, class_prop):
933             if do_url:
934                 url = (
935                     "%s/bpy.ops.%s.html#bpy.ops.%s.%s" %
936                     (url_prefix, class_name, class_name, class_prop)
937                 )
938             else:
939                 rna = "bpy.ops.%s.%s" % (class_name, class_prop)
940         elif operator_exists_single(class_name):
941             # note: ignore the prop name since we don't have a way to link into it
942             class_name, class_prop = class_name.split("_OT_", 1)
943             class_name = class_name.lower()
944             if do_url:
945                 url = (
946                     "%s/bpy.ops.%s.html#bpy.ops.%s.%s" %
947                     (url_prefix, class_name, class_name, class_prop)
948                 )
949             else:
950                 rna = "bpy.ops.%s.%s" % (class_name, class_prop)
951         else:
952             # an RNA setting, common case
953             rna_class = getattr(bpy.types, class_name)
954
955             # detect if this is a inherited member and use that name instead
956             rna_parent = rna_class.bl_rna
957             rna_prop = rna_parent.properties.get(class_prop)
958             if rna_prop:
959                 rna_parent = rna_parent.base
960                 while rna_parent and rna_prop == rna_parent.properties.get(class_prop):
961                     class_name = rna_parent.identifier
962                     rna_parent = rna_parent.base
963
964                 if do_url:
965                     url = (
966                         "%s/bpy.types.%s.html#bpy.types.%s.%s" %
967                         (url_prefix, class_name, class_name, class_prop)
968                     )
969                 else:
970                     rna = "bpy.types.%s.%s" % (class_name, class_prop)
971             else:
972                 # We assume this is custom property, only try to generate generic url/rna_id...
973                 if do_url:
974                     url = ("%s/bpy.types.bpy_struct.html#bpy.types.bpy_struct.items" % (url_prefix,))
975                 else:
976                     rna = "bpy.types.bpy_struct"
977
978     return url if do_url else rna
979
980
981 class WM_OT_doc_view_manual(Operator):
982     """Load online manual"""
983     bl_idname = "wm.doc_view_manual"
984     bl_label = "View Manual"
985
986     doc_id = doc_id
987
988     @staticmethod
989     def _find_reference(rna_id, url_mapping, verbose=True):
990         if verbose:
991             print("online manual check for: '%s'... " % rna_id)
992         from fnmatch import fnmatchcase
993         # XXX, for some reason all RNA ID's are stored lowercase
994         # Adding case into all ID's isn't worth the hassle so force lowercase.
995         rna_id = rna_id.lower()
996         for pattern, url_suffix in url_mapping:
997             if fnmatchcase(rna_id, pattern):
998                 if verbose:
999                     print("            match found: '%s' --> '%s'" % (pattern, url_suffix))
1000                 return url_suffix
1001         if verbose:
1002             print("match not found")
1003         return None
1004
1005     @staticmethod
1006     def _lookup_rna_url(rna_id, verbose=True):
1007         for prefix, url_manual_mapping in bpy.utils.manual_map():
1008             rna_ref = WM_OT_doc_view_manual._find_reference(rna_id, url_manual_mapping, verbose=verbose)
1009             if rna_ref is not None:
1010                 url = prefix + rna_ref
1011                 return url
1012
1013     def execute(self, context):
1014         rna_id = _wm_doc_get_id(self.doc_id, do_url=False)
1015         if rna_id is None:
1016             return {'PASS_THROUGH'}
1017
1018         url = self._lookup_rna_url(rna_id)
1019
1020         if url is None:
1021             self.report(
1022                 {'WARNING'},
1023                 "No reference available %r, "
1024                 "Update info in 'rna_manual_reference.py' "
1025                 "or callback to bpy.utils.manual_map()" %
1026                 self.doc_id
1027             )
1028             return {'CANCELLED'}
1029         else:
1030             import webbrowser
1031             webbrowser.open(url)
1032             return {'FINISHED'}
1033
1034
1035 class WM_OT_doc_view(Operator):
1036     """Load online reference docs"""
1037     bl_idname = "wm.doc_view"
1038     bl_label = "View Documentation"
1039
1040     doc_id = doc_id
1041     if bpy.app.version_cycle == "release":
1042         _prefix = ("https://docs.blender.org/api/blender_python_api_current")
1043     else:
1044         _prefix = ("https://docs.blender.org/api/blender_python_api_master")
1045
1046     def execute(self, context):
1047         url = _wm_doc_get_id(self.doc_id, do_url=True, url_prefix=self._prefix)
1048         if url is None:
1049             return {'PASS_THROUGH'}
1050
1051         import webbrowser
1052         webbrowser.open(url)
1053
1054         return {'FINISHED'}
1055
1056
1057 rna_path = StringProperty(
1058         name="Property Edit",
1059         description="Property data_path edit",
1060         maxlen=1024,
1061         options={'HIDDEN'},
1062         )
1063
1064 rna_value = StringProperty(
1065         name="Property Value",
1066         description="Property value edit",
1067         maxlen=1024,
1068         )
1069
1070 rna_property = StringProperty(
1071         name="Property Name",
1072         description="Property name edit",
1073         maxlen=1024,
1074         )
1075
1076 rna_min = FloatProperty(
1077         name="Min",
1078         default=-10000.0,
1079         precision=3,
1080         )
1081
1082 rna_max = FloatProperty(
1083         name="Max",
1084         default=10000.0,
1085         precision=3,
1086         )
1087
1088 rna_use_soft_limits = BoolProperty(
1089         name="Use Soft Limits",
1090         )
1091
1092 rna_is_overridable_static = BoolProperty(
1093         name="Is Statically Overridable",
1094         default=False,
1095         )
1096
1097
1098 class WM_OT_properties_edit(Operator):
1099     bl_idname = "wm.properties_edit"
1100     bl_label = "Edit Property"
1101     # register only because invoke_props_popup requires.
1102     bl_options = {'REGISTER', 'INTERNAL'}
1103
1104     data_path = rna_path
1105     property = rna_property
1106     value = rna_value
1107     min = rna_min
1108     max = rna_max
1109     use_soft_limits = rna_use_soft_limits
1110     is_overridable_static = rna_is_overridable_static
1111     soft_min = rna_min
1112     soft_max = rna_max
1113     description = StringProperty(
1114             name="Tooltip",
1115             )
1116
1117     def _cmp_props_get(self):
1118         # Changing these properties will refresh the UI
1119         return {
1120             "use_soft_limits": self.use_soft_limits,
1121             "soft_range": (self.soft_min, self.soft_max),
1122             "hard_range": (self.min, self.max),
1123         }
1124
1125     def execute(self, context):
1126         from rna_prop_ui import (
1127             rna_idprop_ui_prop_get,
1128             rna_idprop_ui_prop_clear,
1129             rna_idprop_ui_prop_update,
1130         )
1131
1132         data_path = self.data_path
1133         value = self.value
1134         prop = self.property
1135
1136         prop_old = getattr(self, "_last_prop", [None])[0]
1137
1138         if prop_old is None:
1139             self.report({'ERROR'}, "Direct execution not supported")
1140             return {'CANCELLED'}
1141
1142         try:
1143             value_eval = eval(value)
1144             # assert else None -> None, not "None", see [#33431]
1145             assert(type(value_eval) in {str, float, int, bool, tuple, list})
1146         except:
1147             value_eval = value
1148
1149         # First remove
1150         item = eval("context.%s" % data_path)
1151         prop_type_old = type(item[prop_old])
1152
1153         rna_idprop_ui_prop_clear(item, prop_old)
1154         exec_str = "del item[%r]" % prop_old
1155         # print(exec_str)
1156         exec(exec_str)
1157
1158         # Reassign
1159         exec_str = "item[%r] = %s" % (prop, repr(value_eval))
1160         # print(exec_str)
1161         exec(exec_str)
1162
1163         exec_str = "item.property_overridable_static_set('[\"%s\"]', %s)" % (prop, self.is_overridable_static)
1164         exec(exec_str)
1165
1166         rna_idprop_ui_prop_update(item, prop)
1167
1168         self._last_prop[:] = [prop]
1169
1170         prop_type = type(item[prop])
1171
1172         prop_ui = rna_idprop_ui_prop_get(item, prop)
1173
1174         if prop_type in {float, int}:
1175             prop_ui["min"] = prop_type(self.min)
1176             prop_ui["max"] = prop_type(self.max)
1177
1178             if self.use_soft_limits:
1179                 prop_ui["soft_min"] = prop_type(self.soft_min)
1180                 prop_ui["soft_max"] = prop_type(self.soft_max)
1181             else:
1182                 prop_ui["soft_min"] = prop_type(self.min)
1183                 prop_ui["soft_max"] = prop_type(self.max)
1184
1185         prop_ui["description"] = self.description
1186
1187         # If we have changed the type of the property, update its potential anim curves!
1188         if prop_type_old != prop_type:
1189             data_path = '["%s"]' % bpy.utils.escape_identifier(prop)
1190             done = set()
1191
1192             def _update(fcurves):
1193                 for fcu in fcurves:
1194                     if fcu not in done and fcu.data_path == data_path:
1195                         fcu.update_autoflags(item)
1196                         done.add(fcu)
1197
1198             def _update_strips(strips):
1199                 for st in strips:
1200                     if st.type == 'CLIP' and st.action:
1201                         _update(st.action.fcurves)
1202                     elif st.type == 'META':
1203                         _update_strips(st.strips)
1204
1205             adt = getattr(item, "animation_data", None)
1206             if adt is not None:
1207                 if adt.action:
1208                     _update(adt.action.fcurves)
1209                 if adt.drivers:
1210                     _update(adt.drivers)
1211                 if adt.nla_tracks:
1212                     for nt in adt.nla_tracks:
1213                         _update_strips(nt.strips)
1214
1215         # otherwise existing buttons which reference freed
1216         # memory may crash blender [#26510]
1217         # context.area.tag_redraw()
1218         for win in context.window_manager.windows:
1219             for area in win.screen.areas:
1220                 area.tag_redraw()
1221
1222         return {'FINISHED'}
1223
1224     def invoke(self, context, event):
1225         from rna_prop_ui import rna_idprop_ui_prop_get
1226
1227         data_path = self.data_path
1228
1229         if not data_path:
1230             self.report({'ERROR'}, "Data path not set")
1231             return {'CANCELLED'}
1232
1233         self._last_prop = [self.property]
1234
1235         item = eval("context.%s" % data_path)
1236
1237         # setup defaults
1238         prop_ui = rna_idprop_ui_prop_get(item, self.property, False)  # don't create
1239         if prop_ui:
1240             self.min = prop_ui.get("min", -1000000000)
1241             self.max = prop_ui.get("max", 1000000000)
1242             self.description = prop_ui.get("description", "")
1243
1244             self.soft_min = prop_ui.get("soft_min", self.min)
1245             self.soft_max = prop_ui.get("soft_max", self.max)
1246             self.use_soft_limits = (
1247                 self.min != self.soft_min or
1248                 self.max != self.soft_max
1249             )
1250
1251         # store for comparison
1252         self._cmp_props = self._cmp_props_get()
1253
1254         wm = context.window_manager
1255         return wm.invoke_props_dialog(self)
1256
1257     def check(self, context):
1258         cmp_props = self._cmp_props_get()
1259         changed = False
1260         if self._cmp_props != cmp_props:
1261             if cmp_props["use_soft_limits"]:
1262                 if cmp_props["soft_range"] != self._cmp_props["soft_range"]:
1263                     self.min = min(self.min, self.soft_min)
1264                     self.max = max(self.max, self.soft_max)
1265                     changed = True
1266                 if cmp_props["hard_range"] != self._cmp_props["hard_range"]:
1267                     self.soft_min = max(self.min, self.soft_min)
1268                     self.soft_max = min(self.max, self.soft_max)
1269                     changed = True
1270             else:
1271                 if cmp_props["soft_range"] != cmp_props["hard_range"]:
1272                     self.soft_min = self.min
1273                     self.soft_max = self.max
1274                     changed = True
1275
1276             changed |= (cmp_props["use_soft_limits"] != self._cmp_props["use_soft_limits"])
1277
1278             if changed:
1279                 cmp_props = self._cmp_props_get()
1280
1281             self._cmp_props = cmp_props
1282
1283         return changed
1284
1285     def draw(self, context):
1286         layout = self.layout
1287         layout.prop(self, "property")
1288         layout.prop(self, "value")
1289         row = layout.row(align=True)
1290         row.prop(self, "min")
1291         row.prop(self, "max")
1292
1293         row = layout.row()
1294         row.prop(self, "use_soft_limits")
1295         row.prop(self, "is_overridable_static")
1296
1297         row = layout.row(align=True)
1298         row.enabled = self.use_soft_limits
1299         row.prop(self, "soft_min", text="Soft Min")
1300         row.prop(self, "soft_max", text="Soft Max")
1301         layout.prop(self, "description")
1302
1303
1304 class WM_OT_properties_add(Operator):
1305     bl_idname = "wm.properties_add"
1306     bl_label = "Add Property"
1307     bl_options = {'UNDO', 'INTERNAL'}
1308
1309     data_path = rna_path
1310
1311     def execute(self, context):
1312         from rna_prop_ui import (
1313             rna_idprop_ui_prop_get,
1314             rna_idprop_ui_prop_update,
1315         )
1316
1317         data_path = self.data_path
1318         item = eval("context.%s" % data_path)
1319
1320         def unique_name(names):
1321             prop = "prop"
1322             prop_new = prop
1323             i = 1
1324             while prop_new in names:
1325                 prop_new = prop + str(i)
1326                 i += 1
1327
1328             return prop_new
1329
1330         prop = unique_name({
1331             *item.keys(),
1332             *type(item).bl_rna.properties.keys(),
1333         })
1334
1335         item[prop] = 1.0
1336         rna_idprop_ui_prop_update(item, prop)
1337
1338         # not essential, but without this we get [#31661]
1339         prop_ui = rna_idprop_ui_prop_get(item, prop)
1340         prop_ui["soft_min"] = prop_ui["min"] = 0.0
1341         prop_ui["soft_max"] = prop_ui["max"] = 1.0
1342
1343         return {'FINISHED'}
1344
1345
1346 class WM_OT_properties_context_change(Operator):
1347     """Jump to a different tab inside the properties editor"""
1348     bl_idname = "wm.properties_context_change"
1349     bl_label = ""
1350     bl_options = {'INTERNAL'}
1351
1352     context = StringProperty(
1353             name="Context",
1354             maxlen=64,
1355             )
1356
1357     def execute(self, context):
1358         context.space_data.context = self.context
1359         return {'FINISHED'}
1360
1361
1362 class WM_OT_properties_remove(Operator):
1363     """Internal use (edit a property data_path)"""
1364     bl_idname = "wm.properties_remove"
1365     bl_label = "Remove Property"
1366     bl_options = {'UNDO', 'INTERNAL'}
1367
1368     data_path = rna_path
1369     property = rna_property
1370
1371     def execute(self, context):
1372         from rna_prop_ui import (
1373             rna_idprop_ui_prop_clear,
1374             rna_idprop_ui_prop_update,
1375         )
1376         data_path = self.data_path
1377         item = eval("context.%s" % data_path)
1378         prop = self.property
1379         rna_idprop_ui_prop_update(item, prop)
1380         del item[prop]
1381         rna_idprop_ui_prop_clear(item, prop)
1382
1383         return {'FINISHED'}
1384
1385
1386 class WM_OT_keyconfig_activate(Operator):
1387     bl_idname = "wm.keyconfig_activate"
1388     bl_label = "Activate Keyconfig"
1389
1390     filepath = StringProperty(
1391             subtype='FILE_PATH',
1392             )
1393
1394     def execute(self, context):
1395         if bpy.utils.keyconfig_set(self.filepath, report=self.report):
1396             return {'FINISHED'}
1397         else:
1398             return {'CANCELLED'}
1399
1400
1401 class WM_OT_appconfig_default(Operator):
1402     bl_idname = "wm.appconfig_default"
1403     bl_label = "Default Application Configuration"
1404
1405     def execute(self, context):
1406         import os
1407
1408         context.window_manager.keyconfigs.active = context.window_manager.keyconfigs.default
1409
1410         filepath = os.path.join(bpy.utils.preset_paths("interaction")[0], "blender.py")
1411
1412         if os.path.exists(filepath):
1413             bpy.ops.script.execute_preset(
1414                 filepath=filepath,
1415                 menu_idname="USERPREF_MT_interaction_presets",
1416             )
1417
1418         return {'FINISHED'}
1419
1420
1421 class WM_OT_appconfig_activate(Operator):
1422     bl_idname = "wm.appconfig_activate"
1423     bl_label = "Activate Application Configuration"
1424
1425     filepath = StringProperty(
1426             subtype='FILE_PATH',
1427             )
1428
1429     def execute(self, context):
1430         import os
1431         bpy.utils.keyconfig_set(self.filepath)
1432
1433         filepath = self.filepath.replace("keyconfig", "interaction")
1434
1435         if os.path.exists(filepath):
1436             bpy.ops.script.execute_preset(
1437                 filepath=filepath,
1438                 menu_idname="USERPREF_MT_interaction_presets",
1439             )
1440
1441         return {'FINISHED'}
1442
1443
1444 class WM_OT_sysinfo(Operator):
1445     """Generate system information, saved into a text file"""
1446
1447     bl_idname = "wm.sysinfo"
1448     bl_label = "Save System Info"
1449
1450     filepath = StringProperty(
1451             subtype='FILE_PATH',
1452             options={'SKIP_SAVE'},
1453             )
1454
1455     def execute(self, context):
1456         import sys_info
1457         sys_info.write_sysinfo(self.filepath)
1458         return {'FINISHED'}
1459
1460     def invoke(self, context, event):
1461         import os
1462
1463         if not self.filepath:
1464             self.filepath = os.path.join(
1465                     os.path.expanduser("~"), "system-info.txt")
1466
1467         wm = context.window_manager
1468         wm.fileselect_add(self)
1469         return {'RUNNING_MODAL'}
1470
1471
1472 class WM_OT_copy_prev_settings(Operator):
1473     """Copy settings from previous version"""
1474     bl_idname = "wm.copy_prev_settings"
1475     bl_label = "Copy Previous Settings"
1476
1477     def execute(self, context):
1478         import os
1479         import shutil
1480         ver = bpy.app.version
1481         ver_old = ((ver[0] * 100) + ver[1]) - 1
1482         path_src = bpy.utils.resource_path('USER', ver_old // 100, ver_old % 100)
1483         path_dst = bpy.utils.resource_path('USER')
1484
1485         if os.path.isdir(path_dst):
1486             self.report({'ERROR'}, "Target path %r exists" % path_dst)
1487         elif not os.path.isdir(path_src):
1488             self.report({'ERROR'}, "Source path %r does not exist" % path_src)
1489         else:
1490             shutil.copytree(path_src, path_dst, symlinks=True)
1491
1492             # reload recent-files.txt
1493             bpy.ops.wm.read_history()
1494
1495             # don't loose users work if they open the splash later.
1496             if bpy.data.is_saved is bpy.data.is_dirty is False:
1497                 bpy.ops.wm.read_homefile()
1498             else:
1499                 self.report({'INFO'}, "Reload Start-Up file to restore settings")
1500
1501             return {'FINISHED'}
1502
1503         return {'CANCELLED'}
1504
1505
1506 class WM_OT_keyconfig_test(Operator):
1507     """Test key-config for conflicts"""
1508     bl_idname = "wm.keyconfig_test"
1509     bl_label = "Test Key Configuration for Conflicts"
1510
1511     def execute(self, context):
1512         from bpy_extras import keyconfig_utils
1513
1514         wm = context.window_manager
1515         kc = wm.keyconfigs.default
1516
1517         if keyconfig_utils.keyconfig_test(kc):
1518             print("CONFLICT")
1519
1520         return {'FINISHED'}
1521
1522
1523 class WM_OT_keyconfig_import(Operator):
1524     """Import key configuration from a python script"""
1525     bl_idname = "wm.keyconfig_import"
1526     bl_label = "Import Key Configuration..."
1527
1528     filepath = StringProperty(
1529             subtype='FILE_PATH',
1530             default="keymap.py",
1531             )
1532     filter_folder = BoolProperty(
1533             name="Filter folders",
1534             default=True,
1535             options={'HIDDEN'},
1536             )
1537     filter_text = BoolProperty(
1538             name="Filter text",
1539             default=True,
1540             options={'HIDDEN'},
1541             )
1542     filter_python = BoolProperty(
1543             name="Filter python",
1544             default=True,
1545             options={'HIDDEN'},
1546             )
1547     keep_original = BoolProperty(
1548             name="Keep original",
1549             description="Keep original file after copying to configuration folder",
1550             default=True,
1551             )
1552
1553     def execute(self, context):
1554         import os
1555         from os.path import basename
1556         import shutil
1557
1558         if not self.filepath:
1559             self.report({'ERROR'}, "Filepath not set")
1560             return {'CANCELLED'}
1561
1562         config_name = basename(self.filepath)
1563
1564         path = bpy.utils.user_resource('SCRIPTS', os.path.join("presets", "keyconfig"), create=True)
1565         path = os.path.join(path, config_name)
1566
1567         try:
1568             if self.keep_original:
1569                 shutil.copy(self.filepath, path)
1570             else:
1571                 shutil.move(self.filepath, path)
1572         except Exception as ex:
1573             self.report({'ERROR'}, "Installing keymap failed: %s" % ex)
1574             return {'CANCELLED'}
1575
1576         # sneaky way to check we're actually running the code.
1577         if bpy.utils.keyconfig_set(path, report=self.report):
1578             return {'FINISHED'}
1579         else:
1580             return {'CANCELLED'}
1581
1582     def invoke(self, context, event):
1583         wm = context.window_manager
1584         wm.fileselect_add(self)
1585         return {'RUNNING_MODAL'}
1586
1587 # This operator is also used by interaction presets saving - AddPresetBase
1588
1589
1590 class WM_OT_keyconfig_export(Operator):
1591     """Export key configuration to a python script"""
1592     bl_idname = "wm.keyconfig_export"
1593     bl_label = "Export Key Configuration..."
1594
1595     filepath = StringProperty(
1596             subtype='FILE_PATH',
1597             default="keymap.py",
1598             )
1599     filter_folder = BoolProperty(
1600             name="Filter folders",
1601             default=True,
1602             options={'HIDDEN'},
1603             )
1604     filter_text = BoolProperty(
1605             name="Filter text",
1606             default=True,
1607             options={'HIDDEN'},
1608             )
1609     filter_python = BoolProperty(
1610             name="Filter python",
1611             default=True,
1612             options={'HIDDEN'},
1613             )
1614
1615     def execute(self, context):
1616         from bpy_extras import keyconfig_utils
1617
1618         if not self.filepath:
1619             raise Exception("Filepath not set")
1620
1621         if not self.filepath.endswith(".py"):
1622             self.filepath += ".py"
1623
1624         wm = context.window_manager
1625
1626         keyconfig_utils.keyconfig_export(
1627             wm,
1628             wm.keyconfigs.active,
1629             self.filepath,
1630         )
1631
1632         return {'FINISHED'}
1633
1634     def invoke(self, context, event):
1635         wm = context.window_manager
1636         wm.fileselect_add(self)
1637         return {'RUNNING_MODAL'}
1638
1639
1640 class WM_OT_keymap_restore(Operator):
1641     """Restore key map(s)"""
1642     bl_idname = "wm.keymap_restore"
1643     bl_label = "Restore Key Map(s)"
1644
1645     all = BoolProperty(
1646             name="All Keymaps",
1647             description="Restore all keymaps to default",
1648             )
1649
1650     def execute(self, context):
1651         wm = context.window_manager
1652
1653         if self.all:
1654             for km in wm.keyconfigs.user.keymaps:
1655                 km.restore_to_default()
1656         else:
1657             km = context.keymap
1658             km.restore_to_default()
1659
1660         return {'FINISHED'}
1661
1662
1663 class WM_OT_keyitem_restore(Operator):
1664     """Restore key map item"""
1665     bl_idname = "wm.keyitem_restore"
1666     bl_label = "Restore Key Map Item"
1667
1668     item_id = IntProperty(
1669             name="Item Identifier",
1670             description="Identifier of the item to remove",
1671             )
1672
1673     @classmethod
1674     def poll(cls, context):
1675         keymap = getattr(context, "keymap", None)
1676         return keymap
1677
1678     def execute(self, context):
1679         km = context.keymap
1680         kmi = km.keymap_items.from_id(self.item_id)
1681
1682         if (not kmi.is_user_defined) and kmi.is_user_modified:
1683             km.restore_item_to_default(kmi)
1684
1685         return {'FINISHED'}
1686
1687
1688 class WM_OT_keyitem_add(Operator):
1689     """Add key map item"""
1690     bl_idname = "wm.keyitem_add"
1691     bl_label = "Add Key Map Item"
1692
1693     def execute(self, context):
1694         km = context.keymap
1695
1696         if km.is_modal:
1697             km.keymap_items.new_modal("", 'A', 'PRESS')
1698         else:
1699             km.keymap_items.new("none", 'A', 'PRESS')
1700
1701         # clear filter and expand keymap so we can see the newly added item
1702         if context.space_data.filter_text != "":
1703             context.space_data.filter_text = ""
1704             km.show_expanded_items = True
1705             km.show_expanded_children = True
1706
1707         return {'FINISHED'}
1708
1709
1710 class WM_OT_keyitem_remove(Operator):
1711     """Remove key map item"""
1712     bl_idname = "wm.keyitem_remove"
1713     bl_label = "Remove Key Map Item"
1714
1715     item_id = IntProperty(
1716             name="Item Identifier",
1717             description="Identifier of the item to remove",
1718             )
1719
1720     @classmethod
1721     def poll(cls, context):
1722         return hasattr(context, "keymap")
1723
1724     def execute(self, context):
1725         km = context.keymap
1726         kmi = km.keymap_items.from_id(self.item_id)
1727         km.keymap_items.remove(kmi)
1728         return {'FINISHED'}
1729
1730
1731 class WM_OT_keyconfig_remove(Operator):
1732     """Remove key config"""
1733     bl_idname = "wm.keyconfig_remove"
1734     bl_label = "Remove Key Config"
1735
1736     @classmethod
1737     def poll(cls, context):
1738         wm = context.window_manager
1739         keyconf = wm.keyconfigs.active
1740         return keyconf and keyconf.is_user_defined
1741
1742     def execute(self, context):
1743         wm = context.window_manager
1744         keyconfig = wm.keyconfigs.active
1745         wm.keyconfigs.remove(keyconfig)
1746         return {'FINISHED'}
1747
1748
1749 class WM_OT_operator_cheat_sheet(Operator):
1750     """List all the Operators in a text-block, useful for scripting"""
1751     bl_idname = "wm.operator_cheat_sheet"
1752     bl_label = "Operator Cheat Sheet"
1753
1754     def execute(self, context):
1755         op_strings = []
1756         tot = 0
1757         for op_module_name in dir(bpy.ops):
1758             op_module = getattr(bpy.ops, op_module_name)
1759             for op_submodule_name in dir(op_module):
1760                 op = getattr(op_module, op_submodule_name)
1761                 text = repr(op)
1762                 if text.split("\n")[-1].startswith("bpy.ops."):
1763                     op_strings.append(text)
1764                     tot += 1
1765
1766             op_strings.append('')
1767
1768         textblock = bpy.data.texts.new("OperatorList.txt")
1769         textblock.write('# %d Operators\n\n' % tot)
1770         textblock.write('\n'.join(op_strings))
1771         self.report({'INFO'}, "See OperatorList.txt textblock")
1772         return {'FINISHED'}
1773
1774
1775 # -----------------------------------------------------------------------------
1776 # Add-on Operators
1777
1778 class WM_OT_addon_enable(Operator):
1779     """Enable an add-on"""
1780     bl_idname = "wm.addon_enable"
1781     bl_label = "Enable Add-on"
1782
1783     module = StringProperty(
1784             name="Module",
1785             description="Module name of the add-on to enable",
1786             )
1787
1788     def execute(self, context):
1789         import addon_utils
1790
1791         err_str = ""
1792
1793         def err_cb(ex):
1794             import traceback
1795             nonlocal err_str
1796             err_str = traceback.format_exc()
1797             print(err_str)
1798
1799         mod = addon_utils.enable(self.module, default_set=True, handle_error=err_cb)
1800
1801         if mod:
1802             info = addon_utils.module_bl_info(mod)
1803
1804             info_ver = info.get("blender", (0, 0, 0))
1805
1806             if info_ver > bpy.app.version:
1807                 self.report(
1808                     {'WARNING'},
1809                     "This script was written Blender "
1810                     "version %d.%d.%d and might not "
1811                     "function (correctly), "
1812                     "though it is enabled" %
1813                     info_ver
1814                 )
1815             return {'FINISHED'}
1816         else:
1817
1818             if err_str:
1819                 self.report({'ERROR'}, err_str)
1820
1821             return {'CANCELLED'}
1822
1823
1824 class WM_OT_addon_disable(Operator):
1825     """Disable an add-on"""
1826     bl_idname = "wm.addon_disable"
1827     bl_label = "Disable Add-on"
1828
1829     module = StringProperty(
1830             name="Module",
1831             description="Module name of the add-on to disable",
1832             )
1833
1834     def execute(self, context):
1835         import addon_utils
1836
1837         err_str = ""
1838
1839         def err_cb(ex):
1840             import traceback
1841             nonlocal err_str
1842             err_str = traceback.format_exc()
1843             print(err_str)
1844
1845         addon_utils.disable(self.module, default_set=True, handle_error=err_cb)
1846
1847         if err_str:
1848             self.report({'ERROR'}, err_str)
1849
1850         return {'FINISHED'}
1851
1852
1853 class WM_OT_owner_enable(Operator):
1854     """Enable workspace owner ID"""
1855     bl_idname = "wm.owner_enable"
1856     bl_label = "Enable Add-on"
1857
1858     owner_id = StringProperty(
1859             name="UI Tag",
1860             )
1861
1862     def execute(self, context):
1863         workspace = context.workspace
1864         workspace.owner_ids.new(self.owner_id)
1865         return {'FINISHED'}
1866
1867
1868 class WM_OT_owner_disable(Operator):
1869     """Enable workspace owner ID"""
1870     bl_idname = "wm.owner_disable"
1871     bl_label = "Disable UI Tag"
1872
1873     owner_id = StringProperty(
1874             name="UI Tag",
1875             )
1876
1877     def execute(self, context):
1878         workspace = context.workspace
1879         owner_id = workspace.owner_ids[self.owner_id]
1880         workspace.owner_ids.remove(owner_id)
1881         return {'FINISHED'}
1882
1883
1884 class WM_OT_theme_install(Operator):
1885     """Load and apply a Blender XML theme file"""
1886     bl_idname = "wm.theme_install"
1887     bl_label = "Install Theme..."
1888
1889     overwrite = BoolProperty(
1890             name="Overwrite",
1891             description="Remove existing theme file if exists",
1892             default=True,
1893             )
1894     filepath = StringProperty(
1895             subtype='FILE_PATH',
1896             )
1897     filter_folder = BoolProperty(
1898             name="Filter folders",
1899             default=True,
1900             options={'HIDDEN'},
1901             )
1902     filter_glob = StringProperty(
1903             default="*.xml",
1904             options={'HIDDEN'},
1905             )
1906
1907     def execute(self, context):
1908         import os
1909         import shutil
1910         import traceback
1911
1912         xmlfile = self.filepath
1913
1914         path_themes = bpy.utils.user_resource('SCRIPTS', "presets/interface_theme", create=True)
1915
1916         if not path_themes:
1917             self.report({'ERROR'}, "Failed to get themes path")
1918             return {'CANCELLED'}
1919
1920         path_dest = os.path.join(path_themes, os.path.basename(xmlfile))
1921
1922         if not self.overwrite:
1923             if os.path.exists(path_dest):
1924                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
1925                 return {'CANCELLED'}
1926
1927         try:
1928             shutil.copyfile(xmlfile, path_dest)
1929             bpy.ops.script.execute_preset(
1930                 filepath=path_dest,
1931                 menu_idname="USERPREF_MT_interface_theme_presets",
1932             )
1933
1934         except:
1935             traceback.print_exc()
1936             return {'CANCELLED'}
1937
1938         return {'FINISHED'}
1939
1940     def invoke(self, context, event):
1941         wm = context.window_manager
1942         wm.fileselect_add(self)
1943         return {'RUNNING_MODAL'}
1944
1945
1946 class WM_OT_addon_refresh(Operator):
1947     """Scan add-on directories for new modules"""
1948     bl_idname = "wm.addon_refresh"
1949     bl_label = "Refresh"
1950
1951     def execute(self, context):
1952         import addon_utils
1953
1954         addon_utils.modules_refresh()
1955
1956         return {'FINISHED'}
1957
1958
1959 # Note: shares some logic with WM_OT_app_template_install
1960 # but not enough to de-duplicate. Fixed here may apply to both.
1961 class WM_OT_addon_install(Operator):
1962     """Install an add-on"""
1963     bl_idname = "wm.addon_install"
1964     bl_label = "Install Add-on from File..."
1965
1966     overwrite = BoolProperty(
1967             name="Overwrite",
1968             description="Remove existing add-ons with the same ID",
1969             default=True,
1970             )
1971     target = EnumProperty(
1972             name="Target Path",
1973             items=(('DEFAULT', "Default", ""),
1974                    ('PREFS', "User Prefs", "")),
1975             )
1976
1977     filepath = StringProperty(
1978             subtype='FILE_PATH',
1979             )
1980     filter_folder = BoolProperty(
1981             name="Filter folders",
1982             default=True,
1983             options={'HIDDEN'},
1984             )
1985     filter_python = BoolProperty(
1986             name="Filter python",
1987             default=True,
1988             options={'HIDDEN'},
1989             )
1990     filter_glob = StringProperty(
1991             default="*.py;*.zip",
1992             options={'HIDDEN'},
1993             )
1994
1995     def execute(self, context):
1996         import addon_utils
1997         import traceback
1998         import zipfile
1999         import shutil
2000         import os
2001
2002         pyfile = self.filepath
2003
2004         if self.target == 'DEFAULT':
2005             # don't use bpy.utils.script_paths("addons") because we may not be able to write to it.
2006             path_addons = bpy.utils.user_resource('SCRIPTS', "addons", create=True)
2007         else:
2008             path_addons = context.user_preferences.filepaths.script_directory
2009             if path_addons:
2010                 path_addons = os.path.join(path_addons, "addons")
2011
2012         if not path_addons:
2013             self.report({'ERROR'}, "Failed to get add-ons path")
2014             return {'CANCELLED'}
2015
2016         if not os.path.isdir(path_addons):
2017             try:
2018                 os.makedirs(path_addons, exist_ok=True)
2019             except:
2020                 traceback.print_exc()
2021
2022         # Check if we are installing from a target path,
2023         # doing so causes 2+ addons of same name or when the same from/to
2024         # location is used, removal of the file!
2025         addon_path = ""
2026         pyfile_dir = os.path.dirname(pyfile)
2027         for addon_path in addon_utils.paths():
2028             if os.path.samefile(pyfile_dir, addon_path):
2029                 self.report({'ERROR'}, "Source file is in the add-on search path: %r" % addon_path)
2030                 return {'CANCELLED'}
2031         del addon_path
2032         del pyfile_dir
2033         # done checking for exceptional case
2034
2035         addons_old = {mod.__name__ for mod in addon_utils.modules()}
2036
2037         # check to see if the file is in compressed format (.zip)
2038         if zipfile.is_zipfile(pyfile):
2039             try:
2040                 file_to_extract = zipfile.ZipFile(pyfile, 'r')
2041             except:
2042                 traceback.print_exc()
2043                 return {'CANCELLED'}
2044
2045             if self.overwrite:
2046                 for f in file_to_extract.namelist():
2047                     module_filesystem_remove(path_addons, f)
2048             else:
2049                 for f in file_to_extract.namelist():
2050                     path_dest = os.path.join(path_addons, os.path.basename(f))
2051                     if os.path.exists(path_dest):
2052                         self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
2053                         return {'CANCELLED'}
2054
2055             try:  # extract the file to "addons"
2056                 file_to_extract.extractall(path_addons)
2057             except:
2058                 traceback.print_exc()
2059                 return {'CANCELLED'}
2060
2061         else:
2062             path_dest = os.path.join(path_addons, os.path.basename(pyfile))
2063
2064             if self.overwrite:
2065                 module_filesystem_remove(path_addons, os.path.basename(pyfile))
2066             elif os.path.exists(path_dest):
2067                 self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
2068                 return {'CANCELLED'}
2069
2070             # if not compressed file just copy into the addon path
2071             try:
2072                 shutil.copyfile(pyfile, path_dest)
2073             except:
2074                 traceback.print_exc()
2075                 return {'CANCELLED'}
2076
2077         addons_new = {mod.__name__ for mod in addon_utils.modules()} - addons_old
2078         addons_new.discard("modules")
2079
2080         # disable any addons we may have enabled previously and removed.
2081         # this is unlikely but do just in case. bug [#23978]
2082         for new_addon in addons_new:
2083             addon_utils.disable(new_addon, default_set=True)
2084
2085         # possible the zip contains multiple addons, we could disallow this
2086         # but for now just use the first
2087         for mod in addon_utils.modules(refresh=False):
2088             if mod.__name__ in addons_new:
2089                 info = addon_utils.module_bl_info(mod)
2090
2091                 # show the newly installed addon.
2092                 context.window_manager.addon_filter = 'All'
2093                 context.window_manager.addon_search = info["name"]
2094                 break
2095
2096         # in case a new module path was created to install this addon.
2097         bpy.utils.refresh_script_paths()
2098
2099         # print message
2100         msg = (
2101             tip_("Modules Installed (%s) from %r into %r") %
2102             (", ".join(sorted(addons_new)), pyfile, path_addons)
2103         )
2104         print(msg)
2105         self.report({'INFO'}, msg)
2106
2107         return {'FINISHED'}
2108
2109     def invoke(self, context, event):
2110         wm = context.window_manager
2111         wm.fileselect_add(self)
2112         return {'RUNNING_MODAL'}
2113
2114
2115 class WM_OT_addon_remove(Operator):
2116     """Delete the add-on from the file system"""
2117     bl_idname = "wm.addon_remove"
2118     bl_label = "Remove Add-on"
2119
2120     module = StringProperty(
2121             name="Module",
2122             description="Module name of the add-on to remove",
2123             )
2124
2125     @staticmethod
2126     def path_from_addon(module):
2127         import os
2128         import addon_utils
2129
2130         for mod in addon_utils.modules():
2131             if mod.__name__ == module:
2132                 filepath = mod.__file__
2133                 if os.path.exists(filepath):
2134                     if os.path.splitext(os.path.basename(filepath))[0] == "__init__":
2135                         return os.path.dirname(filepath), True
2136                     else:
2137                         return filepath, False
2138         return None, False
2139
2140     def execute(self, context):
2141         import addon_utils
2142         import os
2143
2144         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
2145         if path is None:
2146             self.report({'WARNING'}, "Add-on path %r could not be found" % path)
2147             return {'CANCELLED'}
2148
2149         # in case its enabled
2150         addon_utils.disable(self.module, default_set=True)
2151
2152         import shutil
2153         if isdir:
2154             shutil.rmtree(path)
2155         else:
2156             os.remove(path)
2157
2158         addon_utils.modules_refresh()
2159
2160         context.area.tag_redraw()
2161         return {'FINISHED'}
2162
2163     # lame confirmation check
2164     def draw(self, context):
2165         self.layout.label(text="Remove Add-on: %r?" % self.module)
2166         path, isdir = WM_OT_addon_remove.path_from_addon(self.module)
2167         self.layout.label(text="Path: %r" % path)
2168
2169     def invoke(self, context, event):
2170         wm = context.window_manager
2171         return wm.invoke_props_dialog(self, width=600)
2172
2173
2174 class WM_OT_addon_expand(Operator):
2175     """Display information and preferences for this add-on"""
2176     bl_idname = "wm.addon_expand"
2177     bl_label = ""
2178     bl_options = {'INTERNAL'}
2179
2180     module = StringProperty(
2181             name="Module",
2182             description="Module name of the add-on to expand",
2183             )
2184
2185     def execute(self, context):
2186         import addon_utils
2187
2188         module_name = self.module
2189
2190         mod = addon_utils.addons_fake_modules.get(module_name)
2191         if mod is not None:
2192             info = addon_utils.module_bl_info(mod)
2193             info["show_expanded"] = not info["show_expanded"]
2194
2195         return {'FINISHED'}
2196
2197
2198 class WM_OT_addon_userpref_show(Operator):
2199     """Show add-on user preferences"""
2200     bl_idname = "wm.addon_userpref_show"
2201     bl_label = ""
2202     bl_options = {'INTERNAL'}
2203
2204     module = StringProperty(
2205             name="Module",
2206             description="Module name of the add-on to expand",
2207             )
2208
2209     def execute(self, context):
2210         import addon_utils
2211
2212         module_name = self.module
2213
2214         modules = addon_utils.modules(refresh=False)
2215         mod = addon_utils.addons_fake_modules.get(module_name)
2216         if mod is not None:
2217             info = addon_utils.module_bl_info(mod)
2218             info["show_expanded"] = True
2219
2220             context.user_preferences.active_section = 'ADDONS'
2221             context.window_manager.addon_filter = 'All'
2222             context.window_manager.addon_search = info["name"]
2223             bpy.ops.screen.userpref_show('INVOKE_DEFAULT')
2224
2225         return {'FINISHED'}
2226
2227
2228 # Note: shares some logic with WM_OT_addon_install
2229 # but not enough to de-duplicate. Fixes here may apply to both.
2230 class WM_OT_app_template_install(Operator):
2231     """Install an application-template"""
2232     bl_idname = "wm.app_template_install"
2233     bl_label = "Install Template from File..."
2234
2235     overwrite = BoolProperty(
2236             name="Overwrite",
2237             description="Remove existing template with the same ID",
2238             default=True,
2239             )
2240
2241     filepath = StringProperty(
2242             subtype='FILE_PATH',
2243             )
2244     filter_folder = BoolProperty(
2245             name="Filter folders",
2246             default=True,
2247             options={'HIDDEN'},
2248             )
2249     filter_glob = StringProperty(
2250             default="*.zip",
2251             options={'HIDDEN'},
2252             )
2253
2254     def execute(self, context):
2255         import traceback
2256         import zipfile
2257         import shutil
2258         import os
2259
2260         filepath = self.filepath
2261
2262         path_app_templates = bpy.utils.user_resource(
2263             'SCRIPTS', os.path.join("startup", "bl_app_templates_user"),
2264             create=True,
2265         )
2266
2267         if not path_app_templates:
2268             self.report({'ERROR'}, "Failed to get add-ons path")
2269             return {'CANCELLED'}
2270
2271         if not os.path.isdir(path_app_templates):
2272             try:
2273                 os.makedirs(path_app_templates, exist_ok=True)
2274             except:
2275                 traceback.print_exc()
2276
2277         app_templates_old = set(os.listdir(path_app_templates))
2278
2279         # check to see if the file is in compressed format (.zip)
2280         if zipfile.is_zipfile(filepath):
2281             try:
2282                 file_to_extract = zipfile.ZipFile(filepath, 'r')
2283             except:
2284                 traceback.print_exc()
2285                 return {'CANCELLED'}
2286
2287             if self.overwrite:
2288                 for f in file_to_extract.namelist():
2289                     module_filesystem_remove(path_app_templates, f)
2290             else:
2291                 for f in file_to_extract.namelist():
2292                     path_dest = os.path.join(path_app_templates, os.path.basename(f))
2293                     if os.path.exists(path_dest):
2294                         self.report({'WARNING'}, "File already installed to %r\n" % path_dest)
2295                         return {'CANCELLED'}
2296
2297             try:  # extract the file to "bl_app_templates_user"
2298                 file_to_extract.extractall(path_app_templates)
2299             except:
2300                 traceback.print_exc()
2301                 return {'CANCELLED'}
2302
2303         else:
2304             # Only support installing zipfiles
2305             self.report({'WARNING'}, "Expected a zip-file %r\n" % filepath)
2306             return {'CANCELLED'}
2307
2308         app_templates_new = set(os.listdir(path_app_templates)) - app_templates_old
2309
2310         # in case a new module path was created to install this addon.
2311         bpy.utils.refresh_script_paths()
2312
2313         # print message
2314         msg = (
2315             tip_("Template Installed (%s) from %r into %r") %
2316             (", ".join(sorted(app_templates_new)), filepath, path_app_templates)
2317         )
2318         print(msg)
2319         self.report({'INFO'}, msg)
2320
2321         return {'FINISHED'}
2322
2323     def invoke(self, context, event):
2324         wm = context.window_manager
2325         wm.fileselect_add(self)
2326         return {'RUNNING_MODAL'}
2327
2328
2329 class WM_OT_tool_set_by_name(Operator):
2330     """Set the tool by name (for keymaps)"""
2331     bl_idname = "wm.tool_set_by_name"
2332     bl_label = "Set Tool By Name"
2333
2334     name = StringProperty(
2335             name="Text",
2336             description="Display name of the tool",
2337             )
2338     space_type = EnumProperty(
2339             name="Type",
2340             items=tuple(
2341                 (e.identifier, e.name, "", e. value)
2342                 for e in bpy.types.Space.bl_rna.properties["type"].enum_items
2343             ),
2344             default='EMPTY',
2345             )
2346
2347     def execute(self, context):
2348         from bl_ui.space_toolsystem_common import activate_by_name
2349         space_type = self.space_type
2350         if space_type == 'EMPTY':
2351             space_type = context.space_data.type
2352         if activate_by_name(context, space_type, self.name):
2353             return {'FINISHED'}
2354         else:
2355             self.report({'WARNING'}, f"Tool {self.name!r} not found.")
2356             return {'CANCELLED'}
2357
2358
2359 classes = (
2360     BRUSH_OT_active_index_set,
2361     WM_OT_addon_disable,
2362     WM_OT_addon_enable,
2363     WM_OT_addon_expand,
2364     WM_OT_addon_install,
2365     WM_OT_addon_refresh,
2366     WM_OT_addon_remove,
2367     WM_OT_addon_userpref_show,
2368     WM_OT_app_template_install,
2369     WM_OT_appconfig_activate,
2370     WM_OT_appconfig_default,
2371     WM_OT_context_collection_boolean_set,
2372     WM_OT_context_cycle_array,
2373     WM_OT_context_cycle_enum,
2374     WM_OT_context_cycle_int,
2375     WM_OT_context_menu_enum,
2376     WM_OT_context_modal_mouse,
2377     WM_OT_context_pie_enum,
2378     WM_OT_context_scale_float,
2379     WM_OT_context_scale_int,
2380     WM_OT_context_set_boolean,
2381     WM_OT_context_set_enum,
2382     WM_OT_context_set_float,
2383     WM_OT_context_set_id,
2384     WM_OT_context_set_int,
2385     WM_OT_context_set_string,
2386     WM_OT_context_set_value,
2387     WM_OT_context_toggle,
2388     WM_OT_context_toggle_enum,
2389     WM_OT_copy_prev_settings,
2390     WM_OT_doc_view,
2391     WM_OT_doc_view_manual,
2392     WM_OT_keyconfig_activate,
2393     WM_OT_keyconfig_export,
2394     WM_OT_keyconfig_import,
2395     WM_OT_keyconfig_remove,
2396     WM_OT_keyconfig_test,
2397     WM_OT_keyitem_add,
2398     WM_OT_keyitem_remove,
2399     WM_OT_keyitem_restore,
2400     WM_OT_keymap_restore,
2401     WM_OT_operator_cheat_sheet,
2402     WM_OT_operator_pie_enum,
2403     WM_OT_path_open,
2404     WM_OT_properties_add,
2405     WM_OT_properties_context_change,
2406     WM_OT_properties_edit,
2407     WM_OT_properties_remove,
2408     WM_OT_sysinfo,
2409     WM_OT_theme_install,
2410     WM_OT_owner_disable,
2411     WM_OT_owner_enable,
2412     WM_OT_url_open,
2413     WM_OT_tool_set_by_name,
2414 )