f53292b48023a1b2fe890db510fcb74f0660aea6
[blender.git] / release / scripts / modules / bl_keymap_utils / io.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 # -----------------------------------------------------------------------------
22 # Export Functions
23
24 __all__ = (
25     "keyconfig_export_as_data",
26     "keyconfig_import_from_data",
27     "keyconfig_init_from_data",
28     "keyconfig_merge",
29     "keymap_init_from_data",
30 )
31
32
33 def indent(levels):
34     return levels * " "
35
36
37 def round_float_32(f):
38     from struct import pack, unpack
39     return unpack("f", pack("f", f))[0]
40
41
42 def repr_f32(f):
43     f_round = round_float_32(f)
44     f_str = repr(f)
45     f_str_frac = f_str.partition(".")[2]
46     if not f_str_frac:
47         return f_str
48     for i in range(1, len(f_str_frac)):
49         f_test = round(f, i)
50         f_test_round = round_float_32(f_test)
51         if f_test_round == f_round:
52             return "%.*f" % (i, f_test)
53     return f_str
54
55
56 def kmi_args_as_data(kmi):
57     s = [
58         f"\"type\": '{kmi.type}'",
59         f"\"value\": '{kmi.value}'"
60     ]
61
62     if kmi.any:
63         s.append("\"any\": True")
64     else:
65         if kmi.shift:
66             s.append("\"shift\": True")
67         if kmi.ctrl:
68             s.append("\"ctrl\": True")
69         if kmi.alt:
70             s.append("\"alt\": True")
71         if kmi.oskey:
72             s.append("\"oskey\": True")
73     if kmi.key_modifier and kmi.key_modifier != 'NONE':
74         s.append(f"\"key_modifier\": '{kmi.key_modifier}'")
75
76     return "{" + ", ".join(s) + "}"
77
78
79 def _kmi_properties_to_lines_recursive(level, properties, lines):
80     from bpy.types import OperatorProperties
81
82     def string_value(value):
83         if isinstance(value, (str, bool, int)):
84             return repr(value)
85         elif isinstance(value, float):
86             return repr_f32(value)
87         elif getattr(value, '__len__', False):
88             return repr(tuple(value))
89         raise Exception(f"Export key configuration: can't write {value!r}")
90
91     for pname in properties.bl_rna.properties.keys():
92         if pname != "rna_type":
93             value = getattr(properties, pname)
94             if isinstance(value, OperatorProperties):
95                 lines_test = []
96                 _kmi_properties_to_lines_recursive(level + 2, value, lines_test)
97                 if lines_test:
98                     lines.append(f"(")
99                     lines.append(f"\"{pname}\",\n")
100                     lines.append(f"{indent(level + 3)}" "[")
101                     lines.extend(lines_test)
102                     lines.append("],\n")
103                     lines.append(f"{indent(level + 3)}" "),\n" f"{indent(level + 2)}")
104                 del lines_test
105             elif properties.is_property_set(pname):
106                 value = string_value(value)
107                 lines.append((f"(\"{pname}\", {value:s}),\n" f"{indent(level + 2)}"))
108
109
110 def _kmi_properties_to_lines(level, kmi_props, lines):
111     if kmi_props is None:
112         return
113
114     lines_test = [f"\"properties\":\n" f"{indent(level + 1)}" "["]
115     _kmi_properties_to_lines_recursive(level, kmi_props, lines_test)
116     if len(lines_test) > 1:
117         lines_test.append("],\n")
118         lines.extend(lines_test)
119
120
121 def _kmi_attrs_or_none(level, kmi):
122     lines = []
123     _kmi_properties_to_lines(level + 1, kmi.properties, lines)
124     if kmi.active is False:
125         lines.append(f"{indent(level)}\"active\":" "False,\n")
126     if not lines:
127         return None
128     return "".join(lines)
129
130
131 def keyconfig_export_as_data(wm, kc, filepath, *, all_keymaps=False):
132     # Alternate foramt
133
134     # Generate a list of keymaps to export:
135     #
136     # First add all user_modified keymaps (found in keyconfigs.user.keymaps list),
137     # then add all remaining keymaps from the currently active custom keyconfig.
138     #
139     # This will create a final list of keymaps that can be used as a "diff" against
140     # the default blender keyconfig, recreating the current setup from a fresh blender
141     # without needing to export keymaps which haven't been edited.
142
143     class FakeKeyConfig:
144         keymaps = []
145     edited_kc = FakeKeyConfig()
146     for km in wm.keyconfigs.user.keymaps:
147         if all_keymaps or km.is_user_modified:
148             edited_kc.keymaps.append(km)
149     # merge edited keymaps with non-default keyconfig, if it exists
150     if kc != wm.keyconfigs.default:
151         export_keymaps = keyconfig_merge(edited_kc, kc)
152     else:
153         export_keymaps = keyconfig_merge(edited_kc, edited_kc)
154
155     with open(filepath, "w") as fh:
156         fw = fh.write
157         fw("keyconfig_data = \\\n[")
158
159         for km, kc_x in export_keymaps:
160             km = km.active()
161             fw("(")
162             fw(f"\"{km.name:s}\",\n")
163             fw(f"{indent(2)}" "{")
164             fw(f"\"space_type\": '{km.space_type:s}'")
165             fw(f", \"region_type\": '{km.region_type:s}'")
166             # We can detect from the kind of items.
167             if km.is_modal:
168                 fw(", \"modal\": True")
169             fw("},\n")
170             fw(f"{indent(2)}" "{")
171             is_modal = km.is_modal
172             fw(f"\"items\":\n")
173             fw(f"{indent(3)}[")
174             for kmi in km.keymap_items:
175                 if is_modal:
176                     kmi_id = kmi.propvalue
177                 else:
178                     kmi_id = kmi.idname
179                 fw(f"(")
180                 kmi_args = kmi_args_as_data(kmi)
181                 kmi_data = _kmi_attrs_or_none(4, kmi)
182                 fw(f"\"{kmi_id:s}\"")
183                 if kmi_data is None:
184                     fw(f", ")
185                 else:
186                     fw(",\n" f"{indent(5)}")
187
188                 fw(kmi_args)
189                 if kmi_data is None:
190                     fw(", None),\n")
191                 else:
192                     fw(",\n")
193                     fw(f"{indent(5)}" "{")
194                     fw(kmi_data)
195                     fw(f"{indent(6)}")
196                     fw("},\n" f"{indent(5)}")
197                     fw("),\n")
198                 fw(f"{indent(4)}")
199             fw("],\n" f"{indent(3)}")
200             fw("},\n" f"{indent(2)}")
201             fw("),\n" f"{indent(1)}")
202
203         fw("]\n")
204         fw("\n\n")
205         fw("if __name__ == \"__main__\":\n")
206         fw("    import os\n")
207         fw("    from bl_keymap_utils.io import keyconfig_import_from_data\n")
208         fw("    keyconfig_import_from_data(os.path.splitext(os.path.basename(__file__))[0], keyconfig_data)\n")
209
210
211 # -----------------------------------------------------------------------------
212 # Import Functions
213
214 def _kmi_props_setattr(kmi_props, attr, value):
215     if type(value) is list:
216         kmi_subprop = getattr(kmi_props, attr)
217         for subattr, subvalue in value:
218             _kmi_props_setattr(kmi_subprop, subattr, subvalue)
219         return
220
221     try:
222         setattr(kmi_props, attr, value)
223     except AttributeError:
224         print(f"Warning: property '{attr}' not found in keymap item '{kmi_props.__class__.__name__}'")
225     except Exception as ex:
226         print(f"Warning: {ex!r}")
227
228
229 def keymap_init_from_data(km, km_items, is_modal=False):
230     new_fn = getattr(km.keymap_items, "new_modal" if is_modal else "new")
231     for (kmi_idname, kmi_args, kmi_data) in km_items:
232         kmi = new_fn(kmi_idname, **kmi_args)
233         if kmi_data is not None:
234             if not kmi_data.get("active", True):
235                 kmi.active = False
236             kmi_props_data = kmi_data.get("properties", None)
237             if kmi_props_data is not None:
238                 kmi_props = kmi.properties
239                 for attr, value in kmi_props_data:
240                     _kmi_props_setattr(kmi_props, attr, value)
241
242
243 def keyconfig_init_from_data(kc, keyconfig_data):
244     # Load data in the format defined above.
245     #
246     # Runs at load time, keep this fast!
247     for (km_name, km_args, km_content) in keyconfig_data:
248         km = kc.keymaps.new(km_name, **km_args)
249         keymap_init_from_data(km, km_content["items"], is_modal=km_args.get("modal", False))
250
251
252 def keyconfig_import_from_data(name, keyconfig_data):
253     # Load data in the format defined above.
254     #
255     # Runs at load time, keep this fast!
256
257     import bpy
258     wm = bpy.context.window_manager
259     kc = wm.keyconfigs.new(name)
260     keyconfig_init_from_data(kc, keyconfig_data)
261     return kc
262
263
264 # -----------------------------------------------------------------------------
265 # Utility Functions
266
267 def keyconfig_merge(kc1, kc2):
268     """ note: kc1 takes priority over kc2
269     """
270     def km_exists_in(km, export_keymaps):
271         for km2, kc in export_keymaps:
272             if km2.name == km.name:
273                 return True
274         return False
275
276     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
277     if kc1 != kc2:
278         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not km_exists_in(km, merged_keymaps))
279
280     return merged_keymaps