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     ('Clip', 'CLIP_EDITOR', 'WINDOW', []),
  99
 100     ('View3D Gesture Circle', 'EMPTY', 'WINDOW', []),
 101     ('Gesture Border', 'EMPTY', 'WINDOW', []),
 102     ('Standard Modal Map', 'EMPTY', 'WINDOW', []),
 103     ('Transform Modal Map', 'EMPTY', 'WINDOW', []),
 104     ('View3D Fly Modal', 'EMPTY', 'WINDOW', []),
 105     ('View3D Rotate Modal', 'EMPTY', 'WINDOW', []),
 106     ('View3D Move Modal', 'EMPTY', 'WINDOW', []),
 107     ('View3D Zoom Modal', 'EMPTY', 'WINDOW', []),
 108     ]
 109
 110
 111 def _km_exists_in(km, export_keymaps):
 112     for km2, kc in export_keymaps:
 113         if km2.name == km.name:
 114             return True
 115     return False
 116
 117
 118 def _merge_keymaps(kc1, kc2):
 119     """ note: kc1 takes priority over kc2
 120     """
 121     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
 122     if kc1 != kc2:
 123         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not _km_exists_in(km, merged_keymaps))
 124
 125     return merged_keymaps
 126
 127
 128 class USERPREF_MT_keyconfigs(bpy.types.Menu):
 129     bl_label = "KeyPresets"
 130     preset_subdir = "keyconfig"
 131     preset_operator = "wm.keyconfig_activate"
 132
 133     def draw(self, context):
 134         props = self.layout.operator("wm.context_set_value", text="Blender (default)")
 135         props.data_path = "window_manager.keyconfigs.active"
 136         props.value = "context.window_manager.keyconfigs.default"
 137
 138         # now draw the presets
 139         bpy.types.Menu.draw_preset(self, context)
 140
 141
 142 class InputKeyMapPanel:
 143     bl_space_type = 'USER_PREFERENCES'
 144     bl_label = "Input"
 145     bl_region_type = 'WINDOW'
 146     bl_options = {'HIDE_HEADER'}
 147
 148     def draw_entry(self, display_keymaps, entry, col, level=0):
 149         idname, spaceid, regionid, children = entry
 150
 151         for km, kc in display_keymaps:
 152             if km.name == idname and km.space_type == spaceid and km.region_type == regionid:
 153                 self.draw_km(display_keymaps, kc, km, children, col, level)
 154
 155         '''
 156         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
 157         if not km:
 158             kc = defkc
 159             km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
 160
 161         if km:
 162             self.draw_km(kc, km, children, col, level)
 163         '''
 164
 165     def indented_layout(self, layout, level):
 166         indentpx = 16
 167         if level == 0:
 168             level = 0.0001   # Tweak so that a percentage of 0 won't split by half
 169         indent = level * indentpx / bpy.context.region.width
 170
 171         split = layout.split(percentage=indent)
 172         col = split.column()
 173         col = split.column()
 174         return col
 175
 176     def draw_km(self, display_keymaps, kc, km, children, layout, level):
 177         km = km.active()
 178
 179         layout.context_pointer_set("keymap", km)
 180
 181         col = self.indented_layout(layout, level)
 182
 183         row = col.row()
 184         row.prop(km, "show_expanded_children", text="", emboss=False)
 185         row.label(text=km.name)
 186
 187         row.label()
 188         row.label()
 189
 190         if km.is_modal:
 191             row.label(text="", icon='LINKED')
 192         if km.is_user_defined:
 193             row.operator("wm.keymap_restore", text="Restore")
 194         else:
 195             row.operator("wm.keymap_edit", text="Edit")
 196
 197         if km.show_expanded_children:
 198             if children:
 199                 # Put the Parent key map's entries in a 'global' sub-category
 200                 # equal in hierarchy to the other children categories
 201                 subcol = self.indented_layout(col, level + 1)
 202                 subrow = subcol.row()
 203                 subrow.prop(km, "show_expanded_items", text="", emboss=False)
 204                 subrow.label(text="%s (Global)" % km.name)
 205             else:
 206                 km.show_expanded_items = True
 207
 208             # Key Map items
 209             if km.show_expanded_items:
 210                 for kmi in km.keymap_items:
 211                     self.draw_kmi(display_keymaps, kc, km, kmi, col, level + 1)
 212
 213                 # "Add New" at end of keymap item list
 214                 col = self.indented_layout(col, level + 1)
 215                 subcol = col.split(percentage=0.2).column()
 216                 subcol.enabled = km.is_user_defined
 217                 subcol.operator("wm.keyitem_add", text="Add New", icon='ZOOMIN')
 218
 219             col.separator()
 220
 221             # Child key maps
 222             if children:
 223                 subcol = col.column()
 224                 row = subcol.row()
 225
 226                 for entry in children:
 227                     self.draw_entry(display_keymaps, entry, col, level + 1)
 228
 229     @staticmethod
 230     def draw_kmi_properties(box, properties, title=None):
 231         box.separator()
 232         if title:
 233             box.label(text=title)
 234         flow = box.column_flow(columns=2)
 235         for pname, value in properties.bl_rna.properties.items():
 236             if pname != "rna_type" and not properties.is_property_hidden(pname):
 237                 if isinstance(value, bpy.types.OperatorProperties):
 238                     InputKeyMapPanel.draw_kmi_properties(box, value, title=pname)
 239                 else:
 240                     flow.prop(properties, pname)
 241
 242     def draw_kmi(self, display_keymaps, kc, km, kmi, layout, level):
 243         map_type = kmi.map_type
 244
 245         col = self.indented_layout(layout, level)
 246
 247         if km.is_user_defined:
 248             col = col.column(align=True)
 249             box = col.box()
 250         else:
 251             box = col.column()
 252
 253         split = box.split(percentage=0.05)
 254
 255         # header bar
 256         row = split.row()
 257         row.prop(kmi, "show_expanded", text="", emboss=False)
 258
 259         row = split.row()
 260         row.enabled = km.is_user_defined
 261         row.prop(kmi, "active", text="", emboss=False)
 262
 263         if km.is_modal:
 264             row.prop(kmi, "propvalue", text="")
 265         else:
 266             row.label(text=kmi.name)
 267
 268         row = split.row()
 269         row.enabled = km.is_user_defined
 270         row.prop(kmi, "map_type", text="")
 271         if map_type == 'KEYBOARD':
 272             row.prop(kmi, "type", text="", full_event=True)
 273         elif map_type == 'MOUSE':
 274             row.prop(kmi, "type", text="", full_event=True)
 275         elif map_type == 'TWEAK':
 276             subrow = row.row()
 277             subrow.prop(kmi, "type", text="")
 278             subrow.prop(kmi, "value", text="")
 279         elif map_type == 'TIMER':
 280             row.prop(kmi, "type", text="")
 281         else:
 282             row.label()
 283
 284         if not kmi.is_user_defined:
 285             op = row.operator("wm.keyitem_restore", text="", icon='BACK')
 286             op.item_id = kmi.id
 287         op = row.operator("wm.keyitem_remove", text="", icon='X')
 288         op.item_id = kmi.id
 289
 290         # Expanded, additional event settings
 291         if kmi.show_expanded:
 292             box = col.box()
 293
 294             box.enabled = km.is_user_defined
 295
 296             if map_type not in {'TEXTINPUT', 'TIMER'}:
 297                 split = box.split(percentage=0.4)
 298                 sub = split.row()
 299
 300                 if km.is_modal:
 301                     sub.prop(kmi, "propvalue", text="")
 302                 else:
 303                     # One day...
 304                     # sub.prop_search(kmi, "idname", bpy.context.window_manager, "operators_all", text="")
 305                     sub.prop(kmi, "idname", text="")
 306
 307                 sub = split.column()
 308                 subrow = sub.row(align=True)
 309
 310                 if map_type == 'KEYBOARD':
 311                     subrow.prop(kmi, "type", text="", event=True)
 312                     subrow.prop(kmi, "value", text="")
 313                 elif map_type == 'MOUSE':
 314                     subrow.prop(kmi, "type", text="")
 315                     subrow.prop(kmi, "value", text="")
 316
 317                 subrow = sub.row()
 318                 subrow.scale_x = 0.75
 319                 subrow.prop(kmi, "any")
 320                 subrow.prop(kmi, "shift")
 321                 subrow.prop(kmi, "ctrl")
 322                 subrow.prop(kmi, "alt")
 323                 subrow.prop(kmi, "oskey", text="Cmd")
 324                 subrow.prop(kmi, "key_modifier", text="", event=True)
 325
 326             # Operator properties
 327             props = kmi.properties
 328             if props is not None:
 329                 InputKeyMapPanel.draw_kmi_properties(box, props)
 330
 331             # Modal key maps attached to this operator
 332             if not km.is_modal:
 333                 kmm = kc.keymaps.find_modal(kmi.idname)
 334                 if kmm:
 335                     self.draw_km(display_keymaps, kc, kmm, None, layout, level + 1)
 336                     layout.context_pointer_set("keymap", km)
 337
 338     def draw_filtered(self, display_keymaps, filter_text, layout):
 339         for km, kc in display_keymaps:
 340             km = km.active()
 341             layout.context_pointer_set("keymap", km)
 342
 343             filtered_items = [kmi for kmi in km.keymap_items if filter_text in kmi.name.lower()]
 344
 345             if len(filtered_items) != 0:
 346                 col = layout.column()
 347
 348                 row = col.row()
 349                 row.label(text=km.name, icon="DOT")
 350
 351                 row.label()
 352                 row.label()
 353
 354                 if km.is_user_defined:
 355                     row.operator("wm.keymap_restore", text="Restore")
 356                 else:
 357                     row.operator("wm.keymap_edit", text="Edit")
 358
 359                 for kmi in filtered_items:
 360                     self.draw_kmi(display_keymaps, kc, km, kmi, col, 1)
 361
 362                 # "Add New" at end of keymap item list
 363                 col = self.indented_layout(layout, 1)
 364                 subcol = col.split(percentage=0.2).column()
 365                 subcol.enabled = km.is_user_defined
 366                 subcol.operator("wm.keyitem_add", text="Add New", icon='ZOOMIN')
 367
 368     def draw_hierarchy(self, display_keymaps, layout):
 369         for entry in KM_HIERARCHY:
 370             self.draw_entry(display_keymaps, entry, layout)
 371
 372     def draw_keymaps(self, context, layout):
 373         wm = context.window_manager
 374         kc = wm.keyconfigs.active
 375         defkc = wm.keyconfigs.default
 376
 377         col = layout.column()
 378         sub = col.column()
 379
 380         subsplit = sub.split()
 381         subcol = subsplit.column()
 382
 383         row = subcol.row(align=True)
 384
 385         #row.prop_search(wm.keyconfigs, "active", wm, "keyconfigs", text="Key Config:")
 386         text = bpy.path.display_name(context.window_manager.keyconfigs.active.name)
 387         if not text:
 388             text = "Blender (default)"
 389         row.menu("USERPREF_MT_keyconfigs", text=text)
 390         row.operator("wm.keyconfig_preset_add", text="", icon="ZOOMIN")
 391         row.operator("wm.keyconfig_preset_add", text="", icon="ZOOMOUT").remove_active = True
 392
 393 #        layout.context_pointer_set("keyconfig", wm.keyconfigs.active)
 394 #        row.operator("wm.keyconfig_remove", text="", icon='X')
 395
 396         row.prop(context.space_data, "filter_text", icon="VIEWZOOM")
 397
 398         col.separator()
 399
 400         display_keymaps = _merge_keymaps(kc, defkc)
 401         if context.space_data.filter_text != "":
 402             filter_text = context.space_data.filter_text.lower()
 403             self.draw_filtered(display_keymaps, filter_text, col)
 404         else:
 405             self.draw_hierarchy(display_keymaps, col)
 406
 407
 408 from bpy.props import StringProperty, BoolProperty, IntProperty
 409
 410
 411 def export_properties(prefix, properties, lines=None):
 412     if lines is None:
 413         lines = []
 414
 415     for pname in properties.bl_rna.properties.keys():
 416         if pname != "rna_type" and not properties.is_property_hidden(pname):
 417             value = getattr(properties, pname)
 418             if isinstance(value, bpy.types.OperatorProperties):
 419                 export_properties(prefix + "." + pname, value, lines)
 420             elif properties.is_property_set(pname):
 421                 value = _string_value(value)
 422                 if value != "":
 423                     lines.append("%s.%s = %s\n" % (prefix, pname, value))
 424     return lines
 425
 426
 427 class WM_OT_keyconfig_test(bpy.types.Operator):
 428     "Test keyconfig for conflicts"
 429     bl_idname = "wm.keyconfig_test"
 430     bl_label = "Test Key Configuration for Conflicts"
 431
 432     def testEntry(self, kc, entry, src=None, parent=None):
 433         result = False
 434
 435         def kmistr(kmi):
 436             if km.is_modal:
 437                 s = ["kmi = km.keymap_items.new_modal(\'%s\', \'%s\', \'%s\'" % (kmi.propvalue, kmi.type, kmi.value)]
 438             else:
 439                 s = ["kmi = km.keymap_items.new(\'%s\', \'%s\', \'%s\'" % (kmi.idname, kmi.type, kmi.value)]
 440
 441             if kmi.any:
 442                 s.append(", any=True")
 443             else:
 444                 if kmi.shift:
 445                     s.append(", shift=True")
 446                 if kmi.ctrl:
 447                     s.append(", ctrl=True")
 448                 if kmi.alt:
 449                     s.append(", alt=True")
 450                 if kmi.oskey:
 451                     s.append(", oskey=True")
 452             if kmi.key_modifier and kmi.key_modifier != 'NONE':
 453                 s.append(", key_modifier=\'%s\'" % kmi.key_modifier)
 454
 455             s.append(")\n")
 456
 457             props = kmi.properties
 458
 459             if props is not None:
 460                 export_properties("kmi.properties", props, s)
 461
 462             return "".join(s).strip()
 463
 464         idname, spaceid, regionid, children = entry
 465
 466         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
 467
 468         if km:
 469             km = km.active()
 470
 471             if src:
 472                 for item in km.keymap_items:
 473                     if src.compare(item):
 474                         print("===========")
 475                         print(parent.name)
 476                         print(kmistr(src))
 477                         print(km.name)
 478                         print(kmistr(item))
 479                         result = True
 480
 481                 for child in children:
 482                     if self.testEntry(kc, child, src, parent):
 483                         result = True
 484             else:
 485                 for i in range(len(km.keymap_items)):
 486                     src = km.keymap_items[i]
 487
 488                     for child in children:
 489                         if self.testEntry(kc, child, src, km):
 490                             result = True
 491
 492                     for j in range(len(km.keymap_items) - i - 1):
 493                         item = km.keymap_items[j + i + 1]
 494                         if src.compare(item):
 495                             print("===========")
 496                             print(km.name)
 497                             print(kmistr(src))
 498                             print(kmistr(item))
 499                             result = True
 500
 501                 for child in children:
 502                     if self.testEntry(kc, child):
 503                         result = True
 504
 505         return result
 506
 507     def testConfig(self, kc):
 508         result = False
 509         for entry in KM_HIERARCHY:
 510             if self.testEntry(kc, entry):
 511                 result = True
 512         return result
 513
 514     def execute(self, context):
 515         wm = context.window_manager
 516         kc = wm.keyconfigs.default
 517
 518         if self.testConfig(kc):
 519             print("CONFLICT")
 520
 521         return {'FINISHED'}
 522
 523
 524 def _string_value(value):
 525     if isinstance(value, str) or isinstance(value, bool) or isinstance(value, float) or isinstance(value, int):
 526         result = repr(value)
 527     elif getattr(value, '__len__', False):
 528         return repr(list(value))
 529     else:
 530         print("Export key configuration: can't write ", value)
 531
 532     return result
 533
 534
 535 class WM_OT_keyconfig_import(bpy.types.Operator):
 536     "Import key configuration from a python script"
 537     bl_idname = "wm.keyconfig_import"
 538     bl_label = "Import Key Configuration..."
 539
 540     filepath = StringProperty(name="File Path", description="Filepath to write file to", default="keymap.py")
 541     filter_folder = BoolProperty(name="Filter folders", description="", default=True, options={'HIDDEN'})
 542     filter_text = BoolProperty(name="Filter text", description="", default=True, options={'HIDDEN'})
 543     filter_python = BoolProperty(name="Filter python", description="", default=True, options={'HIDDEN'})
 544
 545     keep_original = BoolProperty(name="Keep original", description="Keep original file after copying to configuration folder", default=True)
 546
 547     def execute(self, context):
 548         from os.path import basename
 549         import shutil
 550         if not self.filepath:
 551             raise Exception("Filepath not set")
 552
 553         f = open(self.filepath, "r")
 554         if not f:
 555             raise Exception("Could not open file")
 556
 557         config_name = basename(self.filepath)
 558
 559         path = bpy.utils.user_resource('SCRIPTS', os.path.join("presets", "keyconfig"), create=True)
 560         path = os.path.join(path, config_name)
 561
 562         if self.keep_original:
 563             shutil.copy(self.filepath, path)
 564         else:
 565             shutil.move(self.filepath, path)
 566
 567         # sneaky way to check we're actually running the code.
 568         bpy.utils.keyconfig_set(path)
 569
 570         return {'FINISHED'}
 571
 572     def invoke(self, context, event):
 573         wm = context.window_manager
 574         wm.fileselect_add(self)
 575         return {'RUNNING_MODAL'}
 576
 577 # This operator is also used by interaction presets saving - AddPresetBase
 578
 579
 580 class WM_OT_keyconfig_export(bpy.types.Operator):
 581     "Export key configuration to a python script"
 582     bl_idname = "wm.keyconfig_export"
 583     bl_label = "Export Key Configuration..."
 584
 585     filepath = StringProperty(name="File Path", description="Filepath to write file to", default="keymap.py")
 586     filter_folder = BoolProperty(name="Filter folders", description="", default=True, options={'HIDDEN'})
 587     filter_text = BoolProperty(name="Filter text", description="", default=True, options={'HIDDEN'})
 588     filter_python = BoolProperty(name="Filter python", description="", default=True, options={'HIDDEN'})
 589
 590     def execute(self, context):
 591         if not self.filepath:
 592             raise Exception("Filepath not set")
 593
 594         f = open(self.filepath, "w")
 595         if not f:
 596             raise Exception("Could not open file")
 597
 598         wm = context.window_manager
 599         kc = wm.keyconfigs.active
 600
 601         f.write("import bpy\n")
 602         f.write("import os\n\n")
 603         f.write("wm = bpy.context.window_manager\n")
 604         f.write("kc = wm.keyconfigs.new(os.path.splitext(os.path.basename(__file__))[0])\n\n")  # keymap must be created by caller
 605
 606         # Generate a list of keymaps to export:
 607         #
 608         # First add all user_defined keymaps (found in inputs.edited_keymaps list),
 609         # then add all remaining keymaps from the currently active custom keyconfig.
 610         #
 611         # This will create a final list of keymaps that can be used as a 'diff' against
 612         # the default blender keyconfig, recreating the current setup from a fresh blender
 613         # without needing to export keymaps which haven't been edited.
 614
 615         class FakeKeyConfig():
 616             keymaps = []
 617         edited_kc = FakeKeyConfig()
 618         edited_kc.keymaps.extend(context.user_preferences.inputs.edited_keymaps)
 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_edit(bpy.types.Operator):
 669     "Edit stored key map"
 670     bl_idname = "wm.keymap_edit"
 671     bl_label = "Edit Key Map"
 672
 673     def execute(self, context):
 674         km = context.keymap
 675         km.copy_to_user()
 676         return {'FINISHED'}
 677
 678
 679 class WM_OT_keymap_restore(bpy.types.Operator):
 680     "Restore key map(s)"
 681     bl_idname = "wm.keymap_restore"
 682     bl_label = "Restore Key Map(s)"
 683
 684     all = BoolProperty(name="All Keymaps", description="Restore all keymaps to default")
 685
 686     def execute(self, context):
 687         wm = context.window_manager
 688
 689         if self.all:
 690             for km in wm.keyconfigs.default.keymaps:
 691                 km.restore_to_default()
 692         else:
 693             km = context.keymap
 694             km.restore_to_default()
 695
 696         return {'FINISHED'}
 697
 698
 699 class WM_OT_keyitem_restore(bpy.types.Operator):
 700     "Restore key map item"
 701     bl_idname = "wm.keyitem_restore"
 702     bl_label = "Restore Key Map Item"
 703
 704     item_id = IntProperty(name="Item Identifier", description="Identifier of the item to remove")
 705
 706     @classmethod
 707     def poll(cls, context):
 708         keymap = getattr(context, "keymap", None)
 709         return keymap and keymap.is_user_defined
 710
 711     def execute(self, context):
 712         km = context.keymap
 713         kmi = km.keymap_items.from_id(self.item_id)
 714
 715         if not kmi.is_user_defined:
 716             km.restore_item_to_default(kmi)
 717
 718         return {'FINISHED'}
 719
 720
 721 class WM_OT_keyitem_add(bpy.types.Operator):
 722     "Add key map item"
 723     bl_idname = "wm.keyitem_add"
 724     bl_label = "Add Key Map Item"
 725
 726     def execute(self, context):
 727         km = context.keymap
 728
 729         if km.is_modal:
 730             km.keymap_items.new_modal("", 'A', 'PRESS')  # kmi
 731         else:
 732             km.keymap_items.new("none", 'A', 'PRESS')  # kmi
 733
 734         # clear filter and expand keymap so we can see the newly added item
 735         if context.space_data.filter_text != "":
 736             context.space_data.filter_text = ""
 737             km.show_expanded_items = True
 738             km.show_expanded_children = True
 739
 740         return {'FINISHED'}
 741
 742
 743 class WM_OT_keyitem_remove(bpy.types.Operator):
 744     "Remove key map item"
 745     bl_idname = "wm.keyitem_remove"
 746     bl_label = "Remove Key Map Item"
 747
 748     item_id = IntProperty(name="Item Identifier", description="Identifier of the item to remove")
 749
 750     @classmethod
 751     def poll(cls, context):
 752         return hasattr(context, "keymap") and context.keymap.is_user_defined
 753
 754     def execute(self, context):
 755         km = context.keymap
 756         kmi = km.keymap_items.from_id(self.item_id)
 757         km.keymap_items.remove(kmi)
 758         return {'FINISHED'}
 759
 760
 761 class WM_OT_keyconfig_remove(bpy.types.Operator):
 762     "Remove key config"
 763     bl_idname = "wm.keyconfig_remove"
 764     bl_label = "Remove Key Config"
 765
 766     @classmethod
 767     def poll(cls, context):
 768         wm = context.window_manager
 769         keyconf = wm.keyconfigs.active
 770         return keyconf and keyconf.is_user_defined
 771
 772     def execute(self, context):
 773         wm = context.window_manager
 774         keyconfig = wm.keyconfigs.active
 775         wm.keyconfigs.remove(keyconfig)
 776         return {'FINISHED'}
 777
 778 if __name__ == "__main__":  # only for live edit.
 779     bpy.utils.register_module(__name__)