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