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