Add helpers in bpy_extras.keyconfig_utils for addons to (un)register their keymaps.
[blender.git] / release / scripts / modules / bpy_extras / keyconfig_utils.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 # bpy.type.KeyMap: (km.name, km.space_type, km.region_type, [...])
22
23 #    ('Script', 'EMPTY', 'WINDOW', []),
24
25
26 KM_HIERARCHY = [
27     ('Window', 'EMPTY', 'WINDOW', []),  # file save, window change, exit
28     ('Screen', 'EMPTY', 'WINDOW', [     # full screen, undo, screenshot
29         ('Screen Editing', 'EMPTY', 'WINDOW', []),    # re-sizing, action corners
30         ('Header', 'EMPTY', 'WINDOW', []),            # header stuff (per region)
31     ]),
32
33     ('View2D', 'EMPTY', 'WINDOW', []),    # view 2d navigation (per region)
34     ('View2D Buttons List', 'EMPTY', 'WINDOW', []),  # view 2d with buttons navigation
35
36     ('User Interface', 'EMPTY', 'WINDOW', []),
37
38     ('3D View', 'VIEW_3D', 'WINDOW', [  # view 3d navigation and generic stuff (select, transform)
39         ('Object Mode', 'EMPTY', 'WINDOW', []),
40         ('Mesh', 'EMPTY', 'WINDOW', []),
41         ('Curve', 'EMPTY', 'WINDOW', []),
42         ('Armature', 'EMPTY', 'WINDOW', []),
43         ('Metaball', 'EMPTY', 'WINDOW', []),
44         ('Lattice', 'EMPTY', 'WINDOW', []),
45         ('Font', 'EMPTY', 'WINDOW', []),
46
47         ('Pose', 'EMPTY', 'WINDOW', []),
48
49         ('Vertex Paint', 'EMPTY', 'WINDOW', []),
50         ('Weight Paint', 'EMPTY', 'WINDOW', []),
51         ('Weight Paint Vertex Selection', 'EMPTY', 'WINDOW', []),
52         ('Face Mask', 'EMPTY', 'WINDOW', []),
53         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
54         ('Sculpt', 'EMPTY', 'WINDOW', []),
55
56         ('Particle', 'EMPTY', 'WINDOW', []),
57
58         ('Knife Tool Modal Map', 'EMPTY', 'WINDOW', []),
59         ('Paint Stroke Modal', 'EMPTY', 'WINDOW', []),
60         ('Paint Curve', 'EMPTY', 'WINDOW', []),
61
62         ('Object Non-modal', 'EMPTY', 'WINDOW', []),  # mode change
63
64         ('View3D Walk Modal', 'EMPTY', 'WINDOW', []),
65         ('View3D Fly Modal', 'EMPTY', 'WINDOW', []),
66         ('View3D Rotate Modal', 'EMPTY', 'WINDOW', []),
67         ('View3D Move Modal', 'EMPTY', 'WINDOW', []),
68         ('View3D Zoom Modal', 'EMPTY', 'WINDOW', []),
69         ('View3D Dolly Modal', 'EMPTY', 'WINDOW', []),
70
71         ('3D View Generic', 'VIEW_3D', 'WINDOW', []),    # toolbar and properties
72     ]),
73
74     ('Graph Editor', 'GRAPH_EDITOR', 'WINDOW', [
75         ('Graph Editor Generic', 'GRAPH_EDITOR', 'WINDOW', []),
76     ]),
77     ('Dopesheet', 'DOPESHEET_EDITOR', 'WINDOW', [
78         ('Dopesheet Generic', 'DOPESHEET_EDITOR', 'WINDOW', []),
79     ]),
80     ('NLA Editor', 'NLA_EDITOR', 'WINDOW', [
81         ('NLA Channels', 'NLA_EDITOR', 'WINDOW', []),
82         ('NLA Generic', 'NLA_EDITOR', 'WINDOW', []),
83     ]),
84     ('Timeline', 'TIMELINE', 'WINDOW', []),
85
86     ('Image', 'IMAGE_EDITOR', 'WINDOW', [
87         ('UV Editor', 'EMPTY', 'WINDOW', []),  # image (reverse order, UVEdit before Image)
88         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
89         ('UV Sculpt', 'EMPTY', 'WINDOW', []),
90         ('Image Generic', 'IMAGE_EDITOR', 'WINDOW', []),
91     ]),
92
93     ('Outliner', 'OUTLINER', 'WINDOW', []),
94
95     ('Node Editor', 'NODE_EDITOR', 'WINDOW', [
96         ('Node Generic', 'NODE_EDITOR', 'WINDOW', []),
97     ]),
98     ('Sequencer', 'SEQUENCE_EDITOR', 'WINDOW', [
99         ('SequencerCommon', 'SEQUENCE_EDITOR', 'WINDOW', []),
100         ('SequencerPreview', 'SEQUENCE_EDITOR', 'WINDOW', []),
101     ]),
102     ('Logic Editor', 'LOGIC_EDITOR', 'WINDOW', []),
103
104     ('File Browser', 'FILE_BROWSER', 'WINDOW', [
105         ('File Browser Main', 'FILE_BROWSER', 'WINDOW', []),
106         ('File Browser Buttons', 'FILE_BROWSER', 'WINDOW', []),
107     ]),
108
109     ('Info', 'INFO', 'WINDOW', []),
110
111     ('Property Editor', 'PROPERTIES', 'WINDOW', []),  # align context menu
112
113     ('Text', 'TEXT_EDITOR', 'WINDOW', [
114         ('Text Generic', 'TEXT_EDITOR', 'WINDOW', []),
115     ]),
116     ('Console', 'CONSOLE', 'WINDOW', []),
117     ('Clip', 'CLIP_EDITOR', 'WINDOW', [
118         ('Clip Editor', 'CLIP_EDITOR', 'WINDOW', []),
119         ('Clip Graph Editor', 'CLIP_EDITOR', 'WINDOW', []),
120         ('Clip Dopesheet Editor', 'CLIP_EDITOR', 'WINDOW', []),
121     ]),
122
123     ('Grease Pencil', 'EMPTY', 'WINDOW', [  # grease pencil stuff (per region)
124         ('Grease Pencil Stroke Edit Mode', 'EMPTY', 'WINDOW', []),
125     ]),
126     ('Mask Editing', 'EMPTY', 'WINDOW', []),
127     ('Frames', 'EMPTY', 'WINDOW', []),    # frame navigation (per region)
128     ('Markers', 'EMPTY', 'WINDOW', []),    # markers (per region)
129     ('Animation', 'EMPTY', 'WINDOW', []),    # frame change on click, preview range (per region)
130     ('Animation Channels', 'EMPTY', 'WINDOW', []),
131
132     ('View3D Gesture Circle', 'EMPTY', 'WINDOW', []),
133     ('Gesture Straight Line', 'EMPTY', 'WINDOW', []),
134     ('Gesture Zoom Border', 'EMPTY', 'WINDOW', []),
135     ('Gesture Border', 'EMPTY', 'WINDOW', []),
136
137     ('Standard Modal Map', 'EMPTY', 'WINDOW', []),
138     ('Transform Modal Map', 'EMPTY', 'WINDOW', []),
139     ('Eyedropper Modal Map', 'EMPTY', 'WINDOW', []),
140 ]
141
142
143 # -----------------------------------------------------------------------------
144 # Add-on helpers to properly (un)register their own keymaps.
145
146 # Example of keymaps_description:
147 keymaps_description_doc = """
148 keymaps_description is a tuple (((keymap_description), (tuple of keymap_item_descriptions))).
149 keymap_description is a tuple (name, space_type, region_type, is_modal).
150 keymap_item_description is a tuple ({kw_args_for_keymap_new}, (tuple of properties)).
151 kw_args_for_keymap_new is a mapping which keywords match parameters of keymap.new() function.
152 tuple of properties is a tuple of pairs (prop_name, prop_value) (properties being those of called operator).
153
154 Example:
155
156 KEYMAPS = (
157     # First, keymap identifiers (last bool is True for modal km).
158     (('Sequencer', 'SEQUENCE_EDITOR', 'WINDOW', False), (
159     # Then a tuple of keymap items, defined by a dict of kwargs for the km new func, and a tuple of tuples (name, val)
160     # for ops properties, if needing non-default values.
161         ({"idname": export_strips.SEQExportStrip.bl_idname, "type": 'P', "value": 'PRESS', "shift": True, "ctrl": True},
162          ()),
163     )),
164 )
165 """
166
167
168 def addon_keymap_register(wm, keymaps_description):
169     """
170     Register a set of keymaps for addons.
171
172     """ + keymaps_description_doc
173     kconf = wm.keyconfigs.addon
174     if not kconf:
175         return  # happens in background mode...
176     for km_info, km_items in keymaps_description:
177         km_name, km_sptype, km_regtype, km_ismodal = km_info
178         kmap = [k for k in kconf.keymaps
179                   if k.name == km_name and k.region_type == km_regtype and
180                      k.space_type == km_sptype and k.is_modal == km_ismodal]
181         if kmap:
182             kmap = kmap[0]
183         else:
184             kmap = kconf.keymaps.new(km_name, region_type=km_regtype, space_type=km_sptype, modal=km_ismodal)
185         for kmi_kwargs, props in km_items:
186             kmi = kmap.keymap_items.new(**kmi_kwargs)
187             kmi.active = True
188             for prop, val in props:
189                 setattr(kmi.properties, prop, val)
190
191
192 def addon_keymap_unregister(wm, keymaps_description):
193     """
194     Unregister a set of keymaps for addons.
195
196     """ + keymaps_description_doc
197     # NOTE: We must also clean up user keyconfig, else, if user has customized one of add-on's shortcut, this
198     #       customization remains in memory, and comes back when re-enabling the addon, causing a segfault... :/
199     kconfs = wm.keyconfigs
200     for kconf in (kconfs.user, kconfs.addon):
201         for km_info, km_items in keymaps_description:
202             km_name, km_sptype, km_regtype, km_ismodal = km_info
203             kmaps = (k for k in kconf.keymaps
204                        if k.name == km_name and k.region_type == km_regtype and
205                           k.space_type == km_sptype and k.is_modal == km_ismodal)
206             for kmap in kmaps:
207                 for kmi_kwargs, props in km_items:
208                     idname = kmi_kwargs["idname"]
209                     for kmi in kmap.keymap_items:
210                         if kmi.idname == idname:
211                             kmap.keymap_items.remove(kmi)
212             # NOTE: We won't remove addons keymaps themselves, other addons might also use them!
213
214
215 # -----------------------------------------------------------------------------
216 # Utility functions
217
218 def km_exists_in(km, export_keymaps):
219     for km2, kc in export_keymaps:
220         if km2.name == km.name:
221             return True
222     return False
223
224
225 def keyconfig_merge(kc1, kc2):
226     """ note: kc1 takes priority over kc2
227     """
228     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
229     if kc1 != kc2:
230         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not km_exists_in(km, merged_keymaps))
231
232     return merged_keymaps
233
234
235 def _export_properties(prefix, properties, kmi_id, lines=None):
236     from bpy.types import OperatorProperties
237
238     if lines is None:
239         lines = []
240
241     def string_value(value):
242         if isinstance(value, str) or isinstance(value, bool) or isinstance(value, float) or isinstance(value, int):
243             return repr(value)
244         elif getattr(value, '__len__', False):
245             return repr(list(value))
246
247         print("Export key configuration: can't write ", value)
248         return ""
249
250     for pname in properties.bl_rna.properties.keys():
251         if pname != "rna_type":
252             value = getattr(properties, pname)
253             if isinstance(value, OperatorProperties):
254                 _export_properties(prefix + "." + pname, value, kmi_id, lines)
255             elif properties.is_property_set(pname):
256                 value = string_value(value)
257                 if value != "":
258                     lines.append("kmi_props_setattr(%s, '%s', %s)\n" % (prefix, pname, value))
259     return lines
260
261
262 def _kmistr(kmi, is_modal):
263     if is_modal:
264         kmi_id = kmi.propvalue
265         kmi_newfunc = 'new_modal'
266     else:
267         kmi_id = kmi.idname
268         kmi_newfunc = 'new'
269     s = ["kmi = km.keymap_items.%s(\'%s\', \'%s\', \'%s\'" % (kmi_newfunc, kmi_id, kmi.type, kmi.value)]
270
271     if kmi.any:
272         s.append(", any=True")
273     else:
274         if kmi.shift:
275             s.append(", shift=True")
276         if kmi.ctrl:
277             s.append(", ctrl=True")
278         if kmi.alt:
279             s.append(", alt=True")
280         if kmi.oskey:
281             s.append(", oskey=True")
282     if kmi.key_modifier and kmi.key_modifier != 'NONE':
283         s.append(", key_modifier=\'%s\'" % kmi.key_modifier)
284
285     s.append(")\n")
286
287     props = kmi.properties
288
289     if props is not None:
290         _export_properties("kmi.properties", props, kmi_id, s)
291
292     if not kmi.active:
293         s.append("kmi.active = False\n")
294
295     return "".join(s)
296
297
298 def keyconfig_export(wm, kc, filepath):
299
300     f = open(filepath, "w")
301
302     f.write("import bpy\n")
303     f.write("import os\n\n")
304     f.write("def kmi_props_setattr(kmi_props, attr, value):\n"
305             "    try:\n"
306             "        setattr(kmi_props, attr, value)\n"
307             "    except AttributeError:\n"
308             "        print(\"Warning: property '%s' not found in keymap item '%s'\" %\n"
309             "              (attr, kmi_props.__class__.__name__))\n"
310             "    except Exception as e:\n"
311             "        print(\"Warning: %r\" % e)\n\n")
312     f.write("wm = bpy.context.window_manager\n")
313     # keymap must be created by caller
314     f.write("kc = wm.keyconfigs.new(os.path.splitext(os.path.basename(__file__))[0])\n\n")
315
316     # Generate a list of keymaps to export:
317     #
318     # First add all user_modified keymaps (found in keyconfigs.user.keymaps list),
319     # then add all remaining keymaps from the currently active custom keyconfig.
320     #
321     # This will create a final list of keymaps that can be used as a "diff" against
322     # the default blender keyconfig, recreating the current setup from a fresh blender
323     # without needing to export keymaps which haven't been edited.
324
325     class FakeKeyConfig:
326         keymaps = []
327     edited_kc = FakeKeyConfig()
328     for km in wm.keyconfigs.user.keymaps:
329         if km.is_user_modified:
330             edited_kc.keymaps.append(km)
331     # merge edited keymaps with non-default keyconfig, if it exists
332     if kc != wm.keyconfigs.default:
333         export_keymaps = keyconfig_merge(edited_kc, kc)
334     else:
335         export_keymaps = keyconfig_merge(edited_kc, edited_kc)
336
337     for km, kc_x in export_keymaps:
338
339         km = km.active()
340
341         f.write("# Map %s\n" % km.name)
342         f.write("km = kc.keymaps.new('%s', space_type='%s', region_type='%s', modal=%s)\n\n" %
343                 (km.name, km.space_type, km.region_type, km.is_modal))
344         for kmi in km.keymap_items:
345             f.write(_kmistr(kmi, km.is_modal))
346         f.write("\n")
347
348     f.close()
349
350
351 def keyconfig_test(kc):
352
353     def testEntry(kc, entry, src=None, parent=None):
354         result = False
355
356         idname, spaceid, regionid, children = entry
357
358         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
359
360         if km:
361             km = km.active()
362             is_modal = km.is_modal
363
364             if src:
365                 for item in km.keymap_items:
366                     if src.compare(item):
367                         print("===========")
368                         print(parent.name)
369                         print(_kmistr(src, is_modal).strip())
370                         print(km.name)
371                         print(_kmistr(item, is_modal).strip())
372                         result = True
373
374                 for child in children:
375                     if testEntry(kc, child, src, parent):
376                         result = True
377             else:
378                 for i in range(len(km.keymap_items)):
379                     src = km.keymap_items[i]
380
381                     for child in children:
382                         if testEntry(kc, child, src, km):
383                             result = True
384
385                     for j in range(len(km.keymap_items) - i - 1):
386                         item = km.keymap_items[j + i + 1]
387                         if src.compare(item):
388                             print("===========")
389                             print(km.name)
390                             print(_kmistr(src, is_modal).strip())
391                             print(_kmistr(item, is_modal).strip())
392                             result = True
393
394                 for child in children:
395                     if testEntry(kc, child):
396                         result = True
397
398         return result
399
400     # -------------------------------------------------------------------------
401     # Function body
402
403     result = False
404     for entry in KM_HIERARCHY:
405         if testEntry(kc, entry):
406             result = True
407     return result