6ecdd0c5e139d691c37d5eb3f06ac4ff1738a2fa
[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 # Utility functions
145
146 def km_exists_in(km, export_keymaps):
147     for km2, kc in export_keymaps:
148         if km2.name == km.name:
149             return True
150     return False
151
152
153 def keyconfig_merge(kc1, kc2):
154     """ note: kc1 takes priority over kc2
155     """
156     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
157     if kc1 != kc2:
158         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not km_exists_in(km, merged_keymaps))
159
160     return merged_keymaps
161
162
163 def _export_properties(prefix, properties, kmi_id, lines=None):
164     from bpy.types import OperatorProperties
165
166     if lines is None:
167         lines = []
168
169     def string_value(value):
170         if isinstance(value, str) or isinstance(value, bool) or isinstance(value, float) or isinstance(value, int):
171             return repr(value)
172         elif getattr(value, '__len__', False):
173             return repr(list(value))
174
175         print("Export key configuration: can't write ", value)
176         return ""
177
178     for pname in properties.bl_rna.properties.keys():
179         if pname != "rna_type":
180             value = getattr(properties, pname)
181             if isinstance(value, OperatorProperties):
182                 _export_properties(prefix + "." + pname, value, kmi_id, lines)
183             elif properties.is_property_set(pname):
184                 value = string_value(value)
185                 if value != "":
186                     lines.append("kmi_props_setattr(%s, '%s', %s)\n" % (prefix, pname, value))
187     return lines
188
189
190 def _kmistr(kmi, is_modal):
191     if is_modal:
192         kmi_id = kmi.propvalue
193         kmi_newfunc = 'new_modal'
194     else:
195         kmi_id = kmi.idname
196         kmi_newfunc = 'new'
197     s = ["kmi = km.keymap_items.%s(\'%s\', \'%s\', \'%s\'" % (kmi_newfunc, kmi_id, kmi.type, kmi.value)]
198
199     if kmi.any:
200         s.append(", any=True")
201     else:
202         if kmi.shift:
203             s.append(", shift=True")
204         if kmi.ctrl:
205             s.append(", ctrl=True")
206         if kmi.alt:
207             s.append(", alt=True")
208         if kmi.oskey:
209             s.append(", oskey=True")
210     if kmi.key_modifier and kmi.key_modifier != 'NONE':
211         s.append(", key_modifier=\'%s\'" % kmi.key_modifier)
212
213     s.append(")\n")
214
215     props = kmi.properties
216
217     if props is not None:
218         _export_properties("kmi.properties", props, kmi_id, s)
219
220     if not kmi.active:
221         s.append("kmi.active = False\n")
222
223     return "".join(s)
224
225
226 def keyconfig_export(wm, kc, filepath):
227
228     f = open(filepath, "w")
229
230     f.write("import bpy\n")
231     f.write("import os\n\n")
232     f.write("def kmi_props_setattr(kmi_props, attr, value):\n"
233             "    try:\n"
234             "        setattr(kmi_props, attr, value)\n"
235             "    except AttributeError:\n"
236             "        print(\"Warning: property '%s' not found in keymap item '%s'\" %\n"
237             "              (attr, kmi_props.__class__.__name__))\n"
238             "    except Exception as e:\n"
239             "        print(\"Warning: %r\" % e)\n\n")
240     f.write("wm = bpy.context.window_manager\n")
241     # keymap must be created by caller
242     f.write("kc = wm.keyconfigs.new(os.path.splitext(os.path.basename(__file__))[0])\n\n")
243
244     # Generate a list of keymaps to export:
245     #
246     # First add all user_modified keymaps (found in keyconfigs.user.keymaps list),
247     # then add all remaining keymaps from the currently active custom keyconfig.
248     #
249     # This will create a final list of keymaps that can be used as a "diff" against
250     # the default blender keyconfig, recreating the current setup from a fresh blender
251     # without needing to export keymaps which haven't been edited.
252
253     class FakeKeyConfig:
254         keymaps = []
255     edited_kc = FakeKeyConfig()
256     for km in wm.keyconfigs.user.keymaps:
257         if km.is_user_modified:
258             edited_kc.keymaps.append(km)
259     # merge edited keymaps with non-default keyconfig, if it exists
260     if kc != wm.keyconfigs.default:
261         export_keymaps = keyconfig_merge(edited_kc, kc)
262     else:
263         export_keymaps = keyconfig_merge(edited_kc, edited_kc)
264
265     for km, kc_x in export_keymaps:
266
267         km = km.active()
268
269         f.write("# Map %s\n" % km.name)
270         f.write("km = kc.keymaps.new('%s', space_type='%s', region_type='%s', modal=%s)\n\n" %
271                 (km.name, km.space_type, km.region_type, km.is_modal))
272         for kmi in km.keymap_items:
273             f.write(_kmistr(kmi, km.is_modal))
274         f.write("\n")
275
276     f.close()
277
278
279 def keyconfig_test(kc):
280
281     def testEntry(kc, entry, src=None, parent=None):
282         result = False
283
284         idname, spaceid, regionid, children = entry
285
286         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
287
288         if km:
289             km = km.active()
290             is_modal = km.is_modal
291
292             if src:
293                 for item in km.keymap_items:
294                     if src.compare(item):
295                         print("===========")
296                         print(parent.name)
297                         print(_kmistr(src, is_modal).strip())
298                         print(km.name)
299                         print(_kmistr(item, is_modal).strip())
300                         result = True
301
302                 for child in children:
303                     if testEntry(kc, child, src, parent):
304                         result = True
305             else:
306                 for i in range(len(km.keymap_items)):
307                     src = km.keymap_items[i]
308
309                     for child in children:
310                         if testEntry(kc, child, src, km):
311                             result = True
312
313                     for j in range(len(km.keymap_items) - i - 1):
314                         item = km.keymap_items[j + i + 1]
315                         if src.compare(item):
316                             print("===========")
317                             print(km.name)
318                             print(_kmistr(src, is_modal).strip())
319                             print(_kmistr(item, is_modal).strip())
320                             result = True
321
322                 for child in children:
323                     if testEntry(kc, child):
324                         result = True
325
326         return result
327
328     # -------------------------------------------------------------------------
329     # Function body
330
331     result = False
332     for entry in KM_HIERARCHY:
333         if testEntry(kc, entry):
334             result = True
335     return result