cleanup
[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         ]),
31
32     ('View2D', 'EMPTY', 'WINDOW', []),    # view 2d navigation (per region)
33     ('View2D Buttons List', 'EMPTY', 'WINDOW', []),  # view 2d with buttons navigation
34     ('Header', 'EMPTY', 'WINDOW', []),    # header stuff (per region)
35
36     ('Grease Pencil', 'EMPTY', 'WINDOW', [  # grease pencil stuff (per region)
37         ('Grease Pencil Stroke Edit Mode', 'EMPTY', 'WINDOW', []),
38         ]),
39
40     ('3D View', 'VIEW_3D', 'WINDOW', [  # view 3d navigation and generic stuff (select, transform)
41         ('Object Mode', 'EMPTY', 'WINDOW', []),
42         ('Mesh', 'EMPTY', 'WINDOW', []),
43         ('Curve', 'EMPTY', 'WINDOW', []),
44         ('Armature', 'EMPTY', 'WINDOW', []),
45         ('Metaball', 'EMPTY', 'WINDOW', []),
46         ('Lattice', 'EMPTY', 'WINDOW', []),
47         ('Font', 'EMPTY', 'WINDOW', []),
48
49         ('Pose', 'EMPTY', 'WINDOW', []),
50
51         ('Vertex Paint', 'EMPTY', 'WINDOW', []),
52         ('Weight Paint', 'EMPTY', 'WINDOW', []),
53         ('Weight Paint Vertex Selection', 'EMPTY', 'WINDOW', []),
54         ('Face Mask', 'EMPTY', 'WINDOW', []),
55         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
56         ('Sculpt', 'EMPTY', 'WINDOW', []),
57
58         ('Particle', 'EMPTY', 'WINDOW', []),
59
60         ('Knife Tool Modal Map', 'EMPTY', 'WINDOW', []),
61         ('Paint Stroke Modal', 'EMPTY', 'WINDOW', []),
62         ('Paint Curve', 'EMPTY', 'WINDOW', []),
63
64         ('Object Non-modal', 'EMPTY', 'WINDOW', []),  # mode change
65
66         ('View3D Walk Modal', 'EMPTY', 'WINDOW', []),
67         ('View3D Fly Modal', 'EMPTY', 'WINDOW', []),
68         ('View3D Rotate Modal', 'EMPTY', 'WINDOW', []),
69         ('View3D Move Modal', 'EMPTY', 'WINDOW', []),
70         ('View3D Zoom Modal', 'EMPTY', 'WINDOW', []),
71         ('View3D Dolly Modal', 'EMPTY', 'WINDOW', []),
72
73         ('3D View Generic', 'VIEW_3D', 'WINDOW', []),    # toolbar and properties
74         ]),
75
76     ('Frames', 'EMPTY', 'WINDOW', []),    # frame navigation (per region)
77     ('Markers', 'EMPTY', 'WINDOW', []),    # markers (per region)
78     ('Animation', 'EMPTY', 'WINDOW', []),    # frame change on click, preview range (per region)
79     ('Animation Channels', 'EMPTY', 'WINDOW', []),
80     ('Graph Editor', 'GRAPH_EDITOR', 'WINDOW', [
81         ('Graph Editor Generic', 'GRAPH_EDITOR', 'WINDOW', []),
82         ]),
83     ('Dopesheet', 'DOPESHEET_EDITOR', 'WINDOW', []),
84     ('NLA Editor', 'NLA_EDITOR', 'WINDOW', [
85         ('NLA Channels', 'NLA_EDITOR', 'WINDOW', []),
86         ('NLA Generic', 'NLA_EDITOR', 'WINDOW', []),
87         ]),
88
89     ('Image', 'IMAGE_EDITOR', 'WINDOW', [
90         ('UV Editor', 'EMPTY', 'WINDOW', []),  # image (reverse order, UVEdit before Image
91         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
92         ('UV Sculpt', 'EMPTY', 'WINDOW', []),
93         ('Image Generic', 'IMAGE_EDITOR', 'WINDOW', []),
94         ]),
95
96     ('Timeline', 'TIMELINE', 'WINDOW', []),
97     ('Outliner', 'OUTLINER', 'WINDOW', []),
98
99     ('Node Editor', 'NODE_EDITOR', 'WINDOW', [
100         ('Node Generic', 'NODE_EDITOR', 'WINDOW', []),
101         ]),
102     ('Sequencer', 'SEQUENCE_EDITOR', 'WINDOW', [
103         ('SequencerCommon', 'SEQUENCE_EDITOR', 'WINDOW', []),
104         ('SequencerPreview', 'SEQUENCE_EDITOR', 'WINDOW', []),
105         ]),
106     ('Logic Editor', 'LOGIC_EDITOR', 'WINDOW', []),
107
108     ('File Browser', 'FILE_BROWSER', 'WINDOW', [
109         ('File Browser Main', 'FILE_BROWSER', 'WINDOW', []),
110         ('File Browser Buttons', 'FILE_BROWSER', 'WINDOW', []),
111         ]),
112
113     ('Info', 'INFO', 'WINDOW', []),
114
115     ('Property Editor', 'PROPERTIES', 'WINDOW', []),  # align context menu
116
117     ('Text', 'TEXT_EDITOR', 'WINDOW', [
118         ('Text Generic', 'TEXT_EDITOR', 'WINDOW', []),
119         ]),
120     ('Console', 'CONSOLE', 'WINDOW', []),
121     ('Clip', 'CLIP_EDITOR', 'WINDOW', [
122         ('Clip Editor', 'CLIP_EDITOR', 'WINDOW', []),
123         ('Clip Graph Editor', 'CLIP_EDITOR', 'WINDOW', []),
124         ('Clip Dopesheet Editor', 'CLIP_EDITOR', 'WINDOW', []),
125         ('Mask Editing', 'EMPTY', 'WINDOW', []),  # image (reverse order, UVEdit before Image
126         ]),
127
128     ('View3D Gesture Circle', 'EMPTY', 'WINDOW', []),
129     ('Gesture Straight Line', 'EMPTY', 'WINDOW', []),
130     ('Gesture Zoom Border', 'EMPTY', 'WINDOW', []),
131     ('Gesture Border', 'EMPTY', 'WINDOW', []),
132
133     ('Standard Modal Map', 'EMPTY', 'WINDOW', []),
134     ('Transform Modal Map', 'EMPTY', 'WINDOW', []),
135     ]
136
137
138 # -----------------------------------------------------------------------------
139 # Utility functions
140
141 def km_exists_in(km, export_keymaps):
142     for km2, kc in export_keymaps:
143         if km2.name == km.name:
144             return True
145     return False
146
147
148 def keyconfig_merge(kc1, kc2):
149     """ note: kc1 takes priority over kc2
150     """
151     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
152     if kc1 != kc2:
153         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not km_exists_in(km, merged_keymaps))
154
155     return merged_keymaps
156
157
158 def _export_properties(prefix, properties, kmi_id, lines=None):
159     from bpy.types import OperatorProperties
160
161     if lines is None:
162         lines = []
163
164     def string_value(value):
165         if isinstance(value, str) or isinstance(value, bool) or isinstance(value, float) or isinstance(value, int):
166             result = repr(value)
167         elif getattr(value, '__len__', False):
168             return repr(list(value))
169         else:
170             print("Export key configuration: can't write ", value)
171
172         return result
173
174     for pname in properties.bl_rna.properties.keys():
175         if pname != "rna_type":
176             value = getattr(properties, pname)
177             if isinstance(value, OperatorProperties):
178                 _export_properties(prefix + "." + pname, value, kmi_id, lines)
179             elif properties.is_property_set(pname):
180                 value = string_value(value)
181                 if value != "":
182                     lines.append("kmi_props_setattr(%s, '%s', %s)\n" % (prefix, pname, value))
183     return lines
184
185
186 def _kmistr(kmi, is_modal):
187     if is_modal:
188         kmi_id = kmi.propvalue
189         kmi_newfunc = 'new_modal'
190     else:
191         kmi_id = kmi.idname
192         kmi_newfunc = 'new'
193     s = ["kmi = km.keymap_items.%s(\'%s\', \'%s\', \'%s\'" % (kmi_newfunc, kmi_id, kmi.type, kmi.value)]
194
195     if kmi.any:
196         s.append(", any=True")
197     else:
198         if kmi.shift:
199             s.append(", shift=True")
200         if kmi.ctrl:
201             s.append(", ctrl=True")
202         if kmi.alt:
203             s.append(", alt=True")
204         if kmi.oskey:
205             s.append(", oskey=True")
206     if kmi.key_modifier and kmi.key_modifier != 'NONE':
207         s.append(", key_modifier=\'%s\'" % kmi.key_modifier)
208
209     s.append(")\n")
210
211     props = kmi.properties
212
213     if props is not None:
214         _export_properties("kmi.properties", props, kmi_id, s)
215
216     if not kmi.active:
217         s.append("kmi.active = False\n")
218
219     return "".join(s)
220
221
222 def keyconfig_export(wm, kc, filepath):
223
224     f = open(filepath, "w")
225
226     f.write("import bpy\n")
227     f.write("import os\n\n")
228     f.write("def kmi_props_setattr(kmi_props, attr, value):\n"
229             "    try:\n"
230             "        setattr(kmi_props, attr, value)\n"
231             "    except AttributeError:\n"
232             "        print(\"Warning: property '%s' not found in keymap item '%s'\" %\n"
233             "              (attr, kmi_props.__class__.__name__))\n"
234             "    except Exception as e:\n"
235             "        print(\"Warning: %r\" % e)\n\n")
236     f.write("wm = bpy.context.window_manager\n")
237     f.write("kc = wm.keyconfigs.new(os.path.splitext(os.path.basename(__file__))[0])\n\n")  # keymap must be created by caller
238
239     # Generate a list of keymaps to export:
240     #
241     # First add all user_modified keymaps (found in keyconfigs.user.keymaps list),
242     # then add all remaining keymaps from the currently active custom keyconfig.
243     #
244     # This will create a final list of keymaps that can be used as a "diff" against
245     # the default blender keyconfig, recreating the current setup from a fresh blender
246     # without needing to export keymaps which haven't been edited.
247
248     class FakeKeyConfig:
249         keymaps = []
250     edited_kc = FakeKeyConfig()
251     for km in wm.keyconfigs.user.keymaps:
252         if km.is_user_modified:
253             edited_kc.keymaps.append(km)
254     # merge edited keymaps with non-default keyconfig, if it exists
255     if kc != wm.keyconfigs.default:
256         export_keymaps = keyconfig_merge(edited_kc, kc)
257     else:
258         export_keymaps = keyconfig_merge(edited_kc, edited_kc)
259
260     for km, kc_x in export_keymaps:
261
262         km = km.active()
263
264         f.write("# Map %s\n" % km.name)
265         f.write("km = kc.keymaps.new('%s', space_type='%s', region_type='%s', modal=%s)\n\n" % (km.name, km.space_type, km.region_type, km.is_modal))
266         for kmi in km.keymap_items:
267             f.write(_kmistr(kmi, km.is_modal))
268         f.write("\n")
269
270     f.close()
271
272
273 def keyconfig_test(kc):
274
275     def testEntry(kc, entry, src=None, parent=None):
276         result = False
277
278         idname, spaceid, regionid, children = entry
279
280         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
281
282         if km:
283             km = km.active()
284             is_modal = km.is_modal
285
286             if src:
287                 for item in km.keymap_items:
288                     if src.compare(item):
289                         print("===========")
290                         print(parent.name)
291                         print(_kmistr(src, is_modal).strip())
292                         print(km.name)
293                         print(_kmistr(item, is_modal).strip())
294                         result = True
295
296                 for child in children:
297                     if testEntry(kc, child, src, parent):
298                         result = True
299             else:
300                 for i in range(len(km.keymap_items)):
301                     src = km.keymap_items[i]
302
303                     for child in children:
304                         if testEntry(kc, child, src, km):
305                             result = True
306
307                     for j in range(len(km.keymap_items) - i - 1):
308                         item = km.keymap_items[j + i + 1]
309                         if src.compare(item):
310                             print("===========")
311                             print(km.name)
312                             print(_kmistr(src, is_modal).strip())
313                             print(_kmistr(item, is_modal).strip())
314                             result = True
315
316                 for child in children:
317                     if testEntry(kc, child):
318                         result = True
319
320         return result
321
322     # -------------------------------------------------------------------------
323     # Function body
324
325     result = False
326     for entry in KM_HIERARCHY:
327         if testEntry(kc, entry):
328             result = True
329     return result