KEYMAP REFACTORING
[blender.git] / release / scripts / startup / bl_ui / space_userpref_keymap.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 import bpy
21 import os
22
23
24 KM_HIERARCHY = [
25     ('Window', 'EMPTY', 'WINDOW', []),  # file save, window change, exit
26     ('Screen', 'EMPTY', 'WINDOW', [     # full screen, undo, screenshot
27         ('Screen Editing', 'EMPTY', 'WINDOW', []),    # resizing, action corners
28         ]),
29
30     ('View2D', 'EMPTY', 'WINDOW', []),    # view 2d navigation (per region)
31     ('View2D Buttons List', 'EMPTY', 'WINDOW', []),  # view 2d with buttons navigation
32     ('Header', 'EMPTY', 'WINDOW', []),    # header stuff (per region)
33     ('Grease Pencil', 'EMPTY', 'WINDOW', []),  # grease pencil stuff (per region)
34
35     ('3D View', 'VIEW_3D', 'WINDOW', [  # view 3d navigation and generic stuff (select, transform)
36         ('Object Mode', 'EMPTY', 'WINDOW', []),
37         ('Mesh', 'EMPTY', 'WINDOW', []),
38         ('Curve', 'EMPTY', 'WINDOW', []),
39         ('Armature', 'EMPTY', 'WINDOW', []),
40         ('Metaball', 'EMPTY', 'WINDOW', []),
41         ('Lattice', 'EMPTY', 'WINDOW', []),
42         ('Font', 'EMPTY', 'WINDOW', []),
43
44         ('Pose', 'EMPTY', 'WINDOW', []),
45
46         ('Vertex Paint', 'EMPTY', 'WINDOW', []),
47         ('Weight Paint', 'EMPTY', 'WINDOW', []),
48         ('Face Mask', 'EMPTY', 'WINDOW', []),
49         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
50         ('Sculpt', 'EMPTY', 'WINDOW', []),
51
52         ('Armature Sketch', 'EMPTY', 'WINDOW', []),
53         ('Particle', 'EMPTY', 'WINDOW', []),
54
55         ('Object Non-modal', 'EMPTY', 'WINDOW', []),  # mode change
56
57         ('3D View Generic', 'VIEW_3D', 'WINDOW', [])    # toolbar and properties
58         ]),
59
60     ('Frames', 'EMPTY', 'WINDOW', []),    # frame navigation (per region)
61     ('Markers', 'EMPTY', 'WINDOW', []),    # markers (per region)
62     ('Animation', 'EMPTY', 'WINDOW', []),    # frame change on click, preview range (per region)
63     ('Animation Channels', 'EMPTY', 'WINDOW', []),
64     ('Graph Editor', 'GRAPH_EDITOR', 'WINDOW', [
65         ('Graph Editor Generic', 'GRAPH_EDITOR', 'WINDOW', [])
66         ]),
67     ('Dopesheet', 'DOPESHEET_EDITOR', 'WINDOW', []),
68     ('NLA Editor', 'NLA_EDITOR', 'WINDOW', [
69         ('NLA Channels', 'NLA_EDITOR', 'WINDOW', []),
70         ('NLA Generic', 'NLA_EDITOR', 'WINDOW', [])
71         ]),
72
73     ('Image', 'IMAGE_EDITOR', 'WINDOW', [
74         ('UV Editor', 'EMPTY', 'WINDOW', []),  # image (reverse order, UVEdit before Image
75         ('Image Paint', 'EMPTY', 'WINDOW', []),  # image and view3d
76         ('Image Generic', 'IMAGE_EDITOR', 'WINDOW', [])
77         ]),
78
79     ('Timeline', 'TIMELINE', 'WINDOW', []),
80     ('Outliner', 'OUTLINER', 'WINDOW', []),
81
82     ('Node Editor', 'NODE_EDITOR', 'WINDOW', [
83         ('Node Generic', 'NODE_EDITOR', 'WINDOW', [])
84         ]),
85     ('Sequencer', 'SEQUENCE_EDITOR', 'WINDOW', []),
86     ('Logic Editor', 'LOGIC_EDITOR', 'WINDOW', []),
87
88     ('File Browser', 'FILE_BROWSER', 'WINDOW', [
89         ('File Browser Main', 'FILE_BROWSER', 'WINDOW', []),
90         ('File Browser Buttons', 'FILE_BROWSER', 'WINDOW', [])
91         ]),
92
93     ('Property Editor', 'PROPERTIES', 'WINDOW', []),  # align context menu
94
95     ('Script', 'SCRIPTS_WINDOW', 'WINDOW', []),
96     ('Text', 'TEXT_EDITOR', 'WINDOW', []),
97     ('Console', 'CONSOLE', 'WINDOW', []),
98
99     ('View3D Gesture Circle', 'EMPTY', 'WINDOW', []),
100     ('Gesture Border', 'EMPTY', 'WINDOW', []),
101     ('Standard Modal Map', 'EMPTY', 'WINDOW', []),
102     ('Transform Modal Map', 'EMPTY', 'WINDOW', []),
103     ('View3D Fly Modal', 'EMPTY', 'WINDOW', []),
104     ('View3D Rotate Modal', 'EMPTY', 'WINDOW', []),
105     ('View3D Move Modal', 'EMPTY', 'WINDOW', []),
106     ('View3D Zoom Modal', 'EMPTY', 'WINDOW', []),
107     ]
108
109
110 def _km_exists_in(km, export_keymaps):
111     for km2, kc in export_keymaps:
112         if km2.name == km.name:
113             return True
114     return False
115
116
117 def _merge_keymaps(kc1, kc2):
118     """ note: kc1 takes priority over kc2
119     """
120     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
121     if kc1 != kc2:
122         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not _km_exists_in(km, merged_keymaps))
123
124     return merged_keymaps
125
126
127 class USERPREF_MT_keyconfigs(bpy.types.Menu):
128     bl_label = "KeyPresets"
129     preset_subdir = "keyconfig"
130     preset_operator = "wm.keyconfig_activate"
131
132     def draw(self, context):
133         props = self.layout.operator("wm.context_set_value", text="Blender (default)")
134         props.data_path = "window_manager.keyconfigs.active"
135         props.value = "context.window_manager.keyconfigs.default"
136
137         # now draw the presets
138         bpy.types.Menu.draw_preset(self, context)
139
140
141 class InputKeyMapPanel:
142     bl_space_type = 'USER_PREFERENCES'
143     bl_label = "Input"
144     bl_region_type = 'WINDOW'
145     bl_options = {'HIDE_HEADER'}
146
147     def draw_entry(self, display_keymaps, entry, col, level=0):
148         idname, spaceid, regionid, children = entry
149
150         for km, kc in display_keymaps:
151             if km.name == idname and km.space_type == spaceid and km.region_type == regionid:
152                 self.draw_km(display_keymaps, kc, km, children, col, level)
153
154         '''
155         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
156         if not km:
157             kc = defkc
158             km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
159
160         if km:
161             self.draw_km(kc, km, children, col, level)
162         '''
163
164     def indented_layout(self, layout, level):
165         indentpx = 16
166         if level == 0:
167             level = 0.0001   # Tweak so that a percentage of 0 won't split by half
168         indent = level * indentpx / bpy.context.region.width
169
170         split = layout.split(percentage=indent)
171         col = split.column()
172         col = split.column()
173         return col
174
175     def draw_km(self, display_keymaps, kc, km, children, layout, level):
176         km = km.active()
177
178         layout.context_pointer_set("keymap", km)
179
180         col = self.indented_layout(layout, level)
181
182         row = col.row()
183         row.prop(km, "show_expanded_children", text="", emboss=False)
184         row.label(text=km.name)
185
186         row.label()
187         row.label()
188
189         if km.is_modal:
190             row.label(text="", icon='LINKED')
191         if km.is_user_modified:
192             row.operator("wm.keymap_restore", text="Restore")
193         else:
194             row.label()
195
196         if km.show_expanded_children:
197             if children:
198                 # Put the Parent key map's entries in a 'global' sub-category
199                 # equal in hierarchy to the other children categories
200                 subcol = self.indented_layout(col, level + 1)
201                 subrow = subcol.row()
202                 subrow.prop(km, "show_expanded_items", text="", emboss=False)
203                 subrow.label(text="%s (Global)" % km.name)
204             else:
205                 km.show_expanded_items = True
206
207             # Key Map items
208             if km.show_expanded_items:
209                 for kmi in km.keymap_items:
210                     self.draw_kmi(display_keymaps, kc, km, kmi, col, level + 1)
211
212                 # "Add New" at end of keymap item list
213                 col = self.indented_layout(col, level + 1)
214                 subcol = col.split(percentage=0.2).column()
215                 subcol.operator("wm.keyitem_add", text="Add New", icon='ZOOMIN')
216
217             col.separator()
218
219             # Child key maps
220             if children:
221                 subcol = col.column()
222                 row = subcol.row()
223
224                 for entry in children:
225                     self.draw_entry(display_keymaps, entry, col, level + 1)
226
227     @staticmethod
228     def draw_kmi_properties(box, properties, title=None):
229         box.separator()
230         if title:
231             box.label(text=title)
232         flow = box.column_flow(columns=2)
233         for pname, value in properties.bl_rna.properties.items():
234             if pname != "rna_type" and not properties.is_property_hidden(pname):
235                 if isinstance(value, bpy.types.OperatorProperties):
236                     InputKeyMapPanel.draw_kmi_properties(box, value, title=pname)
237                 else:
238                     flow.prop(properties, pname)
239
240     def draw_kmi(self, display_keymaps, kc, km, kmi, layout, level):
241         map_type = kmi.map_type
242
243         col = self.indented_layout(layout, level)
244
245         if kmi.show_expanded:
246             col = col.column(align=True)
247             box = col.box()
248         else:
249             box = col.column()
250
251         split = box.split(percentage=0.05)
252
253         # header bar
254         row = split.row()
255         row.prop(kmi, "show_expanded", text="", emboss=False)
256
257         row = split.row()
258         row.prop(kmi, "active", text="", emboss=False)
259
260         if km.is_modal:
261             row.prop(kmi, "propvalue", text="")
262         else:
263             row.label(text=kmi.name)
264
265         row = split.row()
266         row.prop(kmi, "map_type", text="")
267         if map_type == 'KEYBOARD':
268             row.prop(kmi, "type", text="", full_event=True)
269         elif map_type == 'MOUSE':
270             row.prop(kmi, "type", text="", full_event=True)
271         elif map_type == 'NDOF':
272             row.prop(kmi, "type", text="", full_event=True)
273         elif map_type == 'TWEAK':
274             subrow = row.row()
275             subrow.prop(kmi, "type", text="")
276             subrow.prop(kmi, "value", text="")
277         elif map_type == 'TIMER':
278             row.prop(kmi, "type", text="")
279         else:
280             row.label()
281
282         if (not kmi.is_user_defined) and kmi.is_user_modified:
283             op = row.operator("wm.keyitem_restore", text="", icon='BACK')
284             op.item_id = kmi.id
285         else:
286             op = row.operator("wm.keyitem_remove", text="", icon='X')
287             op.item_id = kmi.id
288
289         # Expanded, additional event settings
290         if kmi.show_expanded:
291             box = col.box()
292
293             if map_type not in {'TEXTINPUT', 'TIMER'}:
294                 split = box.split(percentage=0.4)
295                 sub = split.row()
296
297                 if km.is_modal:
298                     sub.prop(kmi, "propvalue", text="")
299                 else:
300                     # One day...
301                     # sub.prop_search(kmi, "idname", bpy.context.window_manager, "operators_all", text="")
302                     sub.prop(kmi, "idname", text="")
303
304                 sub = split.column()
305                 subrow = sub.row(align=True)
306
307                 if map_type in {'KEYBOARD', 'NDOF'}:
308                     subrow.prop(kmi, "type", text="", event=True)
309                     subrow.prop(kmi, "value", text="")
310                 elif map_type == 'MOUSE':
311                     subrow.prop(kmi, "type", text="")
312                     subrow.prop(kmi, "value", text="")
313
314                 subrow = sub.row()
315                 subrow.scale_x = 0.75
316                 subrow.prop(kmi, "any")
317                 subrow.prop(kmi, "shift")
318                 subrow.prop(kmi, "ctrl")
319                 subrow.prop(kmi, "alt")
320                 subrow.prop(kmi, "oskey", text="Cmd")
321                 subrow.prop(kmi, "key_modifier", text="", event=True)
322
323             # Operator properties
324             props = kmi.properties
325             if props is not None:
326                 InputKeyMapPanel.draw_kmi_properties(box, props)
327
328             # Modal key maps attached to this operator
329             if not km.is_modal:
330                 kmm = kc.keymaps.find_modal(kmi.idname)
331                 if kmm:
332                     self.draw_km(display_keymaps, kc, kmm, None, layout, level + 1)
333                     layout.context_pointer_set("keymap", km)
334
335     def draw_filtered(self, display_keymaps, filter_text, layout):
336         for km, kc in display_keymaps:
337             km = km.active()
338             layout.context_pointer_set("keymap", km)
339
340             filtered_items = [kmi for kmi in km.keymap_items if filter_text in kmi.name.lower()]
341
342             if len(filtered_items) != 0:
343                 col = layout.column()
344
345                 row = col.row()
346                 row.label(text=km.name, icon="DOT")
347
348                 row.label()
349                 row.label()
350
351                 if km.is_user_modified:
352                     row.operator("wm.keymap_restore", text="Restore")
353                 else:
354                     row.label()
355
356                 for kmi in filtered_items:
357                     self.draw_kmi(display_keymaps, kc, km, kmi, col, 1)
358
359                 # "Add New" at end of keymap item list
360                 col = self.indented_layout(layout, 1)
361                 subcol = col.split(percentage=0.2).column()
362                 subcol.operator("wm.keyitem_add", text="Add New", icon='ZOOMIN')
363
364     def draw_hierarchy(self, display_keymaps, layout):
365         for entry in KM_HIERARCHY:
366             self.draw_entry(display_keymaps, entry, layout)
367
368     def draw_keymaps(self, context, layout):
369         wm = context.window_manager
370         kc = wm.keyconfigs.user
371
372         col = layout.column()
373         sub = col.column()
374
375         subsplit = sub.split()
376         subcol = subsplit.column()
377
378         row = subcol.row(align=True)
379
380         #row.prop_search(wm.keyconfigs, "active", wm, "keyconfigs", text="Key Config:")
381         text = bpy.path.display_name(context.window_manager.keyconfigs.active.name)
382         if not text:
383             text = "Blender (default)"
384         row.menu("USERPREF_MT_keyconfigs", text=text)
385         row.operator("wm.keyconfig_preset_add", text="", icon="ZOOMIN")
386         row.operator("wm.keyconfig_preset_add", text="", icon="ZOOMOUT").remove_active = True
387
388 #        layout.context_pointer_set("keyconfig", wm.keyconfigs.active)
389 #        row.operator("wm.keyconfig_remove", text="", icon='X')
390
391         row.prop(context.space_data, "filter_text", icon="VIEWZOOM")
392
393         col.separator()
394
395         display_keymaps = _merge_keymaps(kc, kc)
396         if context.space_data.filter_text != "":
397             filter_text = context.space_data.filter_text.lower()
398             self.draw_filtered(display_keymaps, filter_text, col)
399         else:
400             self.draw_hierarchy(display_keymaps, col)
401
402
403 from bpy.props import StringProperty, BoolProperty, IntProperty
404
405
406 def export_properties(prefix, properties, lines=None):
407     if lines is None:
408         lines = []
409
410     for pname in properties.bl_rna.properties.keys():
411         if pname != "rna_type" and not properties.is_property_hidden(pname):
412             value = getattr(properties, pname)
413             if isinstance(value, bpy.types.OperatorProperties):
414                 export_properties(prefix + "." + pname, value, lines)
415             elif properties.is_property_set(pname):
416                 value = _string_value(value)
417                 if value != "":
418                     lines.append("%s.%s = %s\n" % (prefix, pname, value))
419     return lines
420
421
422 class WM_OT_keyconfig_test(bpy.types.Operator):
423     "Test keyconfig for conflicts"
424     bl_idname = "wm.keyconfig_test"
425     bl_label = "Test Key Configuration for Conflicts"
426
427     def testEntry(self, kc, entry, src=None, parent=None):
428         result = False
429
430         def kmistr(kmi):
431             if km.is_modal:
432                 s = ["kmi = km.keymap_items.new_modal(\'%s\', \'%s\', \'%s\'" % (kmi.propvalue, kmi.type, kmi.value)]
433             else:
434                 s = ["kmi = km.keymap_items.new(\'%s\', \'%s\', \'%s\'" % (kmi.idname, kmi.type, kmi.value)]
435
436             if kmi.any:
437                 s.append(", any=True")
438             else:
439                 if kmi.shift:
440                     s.append(", shift=True")
441                 if kmi.ctrl:
442                     s.append(", ctrl=True")
443                 if kmi.alt:
444                     s.append(", alt=True")
445                 if kmi.oskey:
446                     s.append(", oskey=True")
447             if kmi.key_modifier and kmi.key_modifier != 'NONE':
448                 s.append(", key_modifier=\'%s\'" % kmi.key_modifier)
449
450             s.append(")\n")
451
452             props = kmi.properties
453
454             if props is not None:
455                 export_properties("kmi.properties", props, s)
456
457             return "".join(s).strip()
458
459         idname, spaceid, regionid, children = entry
460
461         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
462
463         if km:
464             km = km.active()
465
466             if src:
467                 for item in km.keymap_items:
468                     if src.compare(item):
469                         print("===========")
470                         print(parent.name)
471                         print(kmistr(src))
472                         print(km.name)
473                         print(kmistr(item))
474                         result = True
475
476                 for child in children:
477                     if self.testEntry(kc, child, src, parent):
478                         result = True
479             else:
480                 for i in range(len(km.keymap_items)):
481                     src = km.keymap_items[i]
482
483                     for child in children:
484                         if self.testEntry(kc, child, src, km):
485                             result = True
486
487                     for j in range(len(km.keymap_items) - i - 1):
488                         item = km.keymap_items[j + i + 1]
489                         if src.compare(item):
490                             print("===========")
491                             print(km.name)
492                             print(kmistr(src))
493                             print(kmistr(item))
494                             result = True
495
496                 for child in children:
497                     if self.testEntry(kc, child):
498                         result = True
499
500         return result
501
502     def testConfig(self, kc):
503         result = False
504         for entry in KM_HIERARCHY:
505             if self.testEntry(kc, entry):
506                 result = True
507         return result
508
509     def execute(self, context):
510         wm = context.window_manager
511         kc = wm.keyconfigs.default
512
513         if self.testConfig(kc):
514             print("CONFLICT")
515
516         return {'FINISHED'}
517
518
519 def _string_value(value):
520     if isinstance(value, str) or isinstance(value, bool) or isinstance(value, float) or isinstance(value, int):
521         result = repr(value)
522     elif getattr(value, '__len__', False):
523         return repr(list(value))
524     else:
525         print("Export key configuration: can't write ", value)
526
527     return result
528
529
530 class WM_OT_keyconfig_import(bpy.types.Operator):
531     "Import key configuration from a python script"
532     bl_idname = "wm.keyconfig_import"
533     bl_label = "Import Key Configuration..."
534
535     filepath = StringProperty(name="File Path", description="Filepath to write file to", default="keymap.py")
536     filter_folder = BoolProperty(name="Filter folders", description="", default=True, options={'HIDDEN'})
537     filter_text = BoolProperty(name="Filter text", description="", default=True, options={'HIDDEN'})
538     filter_python = BoolProperty(name="Filter python", description="", default=True, options={'HIDDEN'})
539
540     keep_original = BoolProperty(name="Keep original", description="Keep original file after copying to configuration folder", default=True)
541
542     def execute(self, context):
543         from os.path import basename
544         import shutil
545         if not self.filepath:
546             raise Exception("Filepath not set")
547
548         f = open(self.filepath, "r")
549         if not f:
550             raise Exception("Could not open file")
551
552         config_name = basename(self.filepath)
553
554         path = bpy.utils.user_resource('SCRIPTS', os.path.join("presets", "keyconfig"), create=True)
555         path = os.path.join(path, config_name)
556
557         if self.keep_original:
558             shutil.copy(self.filepath, path)
559         else:
560             shutil.move(self.filepath, path)
561
562         # sneaky way to check we're actually running the code.
563         bpy.utils.keyconfig_set(path)
564
565         return {'FINISHED'}
566
567     def invoke(self, context, event):
568         wm = context.window_manager
569         wm.fileselect_add(self)
570         return {'RUNNING_MODAL'}
571
572 # This operator is also used by interaction presets saving - AddPresetBase
573
574
575 class WM_OT_keyconfig_export(bpy.types.Operator):
576     "Export key configuration to a python script"
577     bl_idname = "wm.keyconfig_export"
578     bl_label = "Export Key Configuration..."
579
580     filepath = StringProperty(name="File Path", description="Filepath to write file to", default="keymap.py")
581     filter_folder = BoolProperty(name="Filter folders", description="", default=True, options={'HIDDEN'})
582     filter_text = BoolProperty(name="Filter text", description="", default=True, options={'HIDDEN'})
583     filter_python = BoolProperty(name="Filter python", description="", default=True, options={'HIDDEN'})
584
585     def execute(self, context):
586         if not self.filepath:
587             raise Exception("Filepath not set")
588
589         if not self.filepath.endswith('.py'):
590             self.filepath += '.py'
591
592         f = open(self.filepath, "w")
593         if not f:
594             raise Exception("Could not open file")
595
596         wm = context.window_manager
597         kc = wm.keyconfigs.active
598
599         f.write("import bpy\n")
600         f.write("import os\n\n")
601         f.write("wm = bpy.context.window_manager\n")
602         f.write("kc = wm.keyconfigs.new(os.path.splitext(os.path.basename(__file__))[0])\n\n")  # keymap must be created by caller
603
604         # Generate a list of keymaps to export:
605         #
606         # First add all user_modified keymaps (found in keyconfigs.user.keymaps list),
607         # then add all remaining keymaps from the currently active custom keyconfig.
608         #
609         # This will create a final list of keymaps that can be used as a 'diff' against
610         # the default blender keyconfig, recreating the current setup from a fresh blender
611         # without needing to export keymaps which haven't been edited.
612
613         class FakeKeyConfig():
614             keymaps = []
615         edited_kc = FakeKeyConfig()
616         for km in wm.keyconfigs.user.keymaps:
617             if km.is_user_modified:
618                 edited_kc.keymaps.append(km)
619         # merge edited keymaps with non-default keyconfig, if it exists
620         if kc != wm.keyconfigs.default:
621             export_keymaps = _merge_keymaps(edited_kc, kc)
622         else:
623             export_keymaps = _merge_keymaps(edited_kc, edited_kc)
624
625         for km, kc_x in export_keymaps:
626
627             km = km.active()
628
629             f.write("# Map %s\n" % km.name)
630             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))
631             for kmi in km.keymap_items:
632                 if km.is_modal:
633                     f.write("kmi = km.keymap_items.new_modal('%s', '%s', '%s'" % (kmi.propvalue, kmi.type, kmi.value))
634                 else:
635                     f.write("kmi = km.keymap_items.new('%s', '%s', '%s'" % (kmi.idname, kmi.type, kmi.value))
636                 if kmi.any:
637                     f.write(", any=True")
638                 else:
639                     if kmi.shift:
640                         f.write(", shift=True")
641                     if kmi.ctrl:
642                         f.write(", ctrl=True")
643                     if kmi.alt:
644                         f.write(", alt=True")
645                     if kmi.oskey:
646                         f.write(", oskey=True")
647                 if kmi.key_modifier and kmi.key_modifier != 'NONE':
648                     f.write(", key_modifier='%s'" % kmi.key_modifier)
649                 f.write(")\n")
650
651                 props = kmi.properties
652
653                 if props is not None:
654                     f.write("".join(export_properties("kmi.properties", props)))
655
656             f.write("\n")
657
658         f.close()
659
660         return {'FINISHED'}
661
662     def invoke(self, context, event):
663         wm = context.window_manager
664         wm.fileselect_add(self)
665         return {'RUNNING_MODAL'}
666
667
668 class WM_OT_keymap_restore(bpy.types.Operator):
669     "Restore key map(s)"
670     bl_idname = "wm.keymap_restore"
671     bl_label = "Restore Key Map(s)"
672
673     all = BoolProperty(name="All Keymaps", description="Restore all keymaps to default")
674
675     def execute(self, context):
676         wm = context.window_manager
677
678         if self.all:
679             for km in wm.keyconfigs.user.keymaps:
680                 km.restore_to_default()
681         else:
682             km = context.keymap
683             km.restore_to_default()
684
685         return {'FINISHED'}
686
687
688 class WM_OT_keyitem_restore(bpy.types.Operator):
689     "Restore key map item"
690     bl_idname = "wm.keyitem_restore"
691     bl_label = "Restore Key Map Item"
692
693     item_id = IntProperty(name="Item Identifier", description="Identifier of the item to remove")
694
695     @classmethod
696     def poll(cls, context):
697         keymap = getattr(context, "keymap", None)
698         return keymap
699
700     def execute(self, context):
701         km = context.keymap
702         kmi = km.keymap_items.from_id(self.item_id)
703
704         if (not kmi.is_user_defined) and kmi.is_user_modified:
705             km.restore_item_to_default(kmi)
706
707         return {'FINISHED'}
708
709
710 class WM_OT_keyitem_add(bpy.types.Operator):
711     "Add key map item"
712     bl_idname = "wm.keyitem_add"
713     bl_label = "Add Key Map Item"
714
715     def execute(self, context):
716         km = context.keymap
717
718         if km.is_modal:
719             km.keymap_items.new_modal("", 'A', 'PRESS')  # kmi
720         else:
721             km.keymap_items.new("none", 'A', 'PRESS')  # kmi
722
723         # clear filter and expand keymap so we can see the newly added item
724         if context.space_data.filter_text != "":
725             context.space_data.filter_text = ""
726             km.show_expanded_items = True
727             km.show_expanded_children = True
728
729         return {'FINISHED'}
730
731
732 class WM_OT_keyitem_remove(bpy.types.Operator):
733     "Remove key map item"
734     bl_idname = "wm.keyitem_remove"
735     bl_label = "Remove Key Map Item"
736
737     item_id = IntProperty(name="Item Identifier", description="Identifier of the item to remove")
738
739     @classmethod
740     def poll(cls, context):
741         return hasattr(context, "keymap")
742
743     def execute(self, context):
744         km = context.keymap
745         kmi = km.keymap_items.from_id(self.item_id)
746         km.keymap_items.remove(kmi)
747         return {'FINISHED'}
748
749
750 class WM_OT_keyconfig_remove(bpy.types.Operator):
751     "Remove key config"
752     bl_idname = "wm.keyconfig_remove"
753     bl_label = "Remove Key Config"
754
755     @classmethod
756     def poll(cls, context):
757         wm = context.window_manager
758         keyconf = wm.keyconfigs.active
759         return keyconf and keyconf.is_user_defined
760
761     def execute(self, context):
762         wm = context.window_manager
763         keyconfig = wm.keyconfigs.active
764         wm.keyconfigs.remove(keyconfig)
765         return {'FINISHED'}
766
767 if __name__ == "__main__":  # only for live edit.
768     bpy.utils.register_module(__name__)