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', []),    # resizing, 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         ('Image Generic', 'IMAGE_EDITOR', 'WINDOW', [])
  74         ]),
  75
  76     ('Timeline', 'TIMELINE', 'WINDOW', []),
  77     ('Outliner', 'OUTLINER', 'WINDOW', []),
  78
  79     ('Node Editor', 'NODE_EDITOR', 'WINDOW', [
  80         ('Node Generic', 'NODE_EDITOR', 'WINDOW', [])
  81         ]),
  82     ('Sequencer', 'SEQUENCE_EDITOR', 'WINDOW', []),
  83     ('Logic Editor', 'LOGIC_EDITOR', 'WINDOW', []),
  84
  85     ('File Browser', 'FILE_BROWSER', 'WINDOW', [
  86         ('File Browser Main', 'FILE_BROWSER', 'WINDOW', []),
  87         ('File Browser Buttons', 'FILE_BROWSER', 'WINDOW', [])
  88         ]),
  89
  90     ('Property Editor', 'PROPERTIES', 'WINDOW', []),  # align context menu
  91
  92     ('Script', 'SCRIPTS_WINDOW', 'WINDOW', []),
  93     ('Text', 'TEXT_EDITOR', 'WINDOW', []),
  94     ('Console', 'CONSOLE', 'WINDOW', []),
  95     ('Clip Editor', 'CLIP_EDITOR', 'WINDOW', []),
  96     ('Clip Globals', 'CLIP_EDITOR', 'WINDOW', []),
  97
  98     ('View3D Gesture Circle', 'EMPTY', 'WINDOW', []),
  99     ('Gesture Border', 'EMPTY', 'WINDOW', []),
 100     ('Standard Modal Map', 'EMPTY', 'WINDOW', []),
 101     ('Transform Modal Map', 'EMPTY', 'WINDOW', []),
 102     ('View3D Fly Modal', 'EMPTY', 'WINDOW', []),
 103     ('View3D Rotate Modal', 'EMPTY', 'WINDOW', []),
 104     ('View3D Move Modal', 'EMPTY', 'WINDOW', []),
 105     ('View3D Zoom Modal', 'EMPTY', 'WINDOW', []),
 106     ]
 107
 108
 109 # -----------------------------------------------------------------------------
 110 # Utility functions
 111
 112 def km_exists_in(km, export_keymaps):
 113     for km2, kc in export_keymaps:
 114         if km2.name == km.name:
 115             return True
 116     return False
 117
 118
 119 def keyconfig_merge(kc1, kc2):
 120     """ note: kc1 takes priority over kc2
 121     """
 122     merged_keymaps = [(km, kc1) for km in kc1.keymaps]
 123     if kc1 != kc2:
 124         merged_keymaps.extend((km, kc2) for km in kc2.keymaps if not _km_exists_in(km, merged_keymaps))
 125
 126     return merged_keymaps
 127
 128
 129 def keyconfig_export(wm, kc, filepath):
 130     from bpy.types import OperatorProperties
 131
 132     def string_value(value):
 133         if isinstance(value, str) or isinstance(value, bool) or isinstance(value, float) or isinstance(value, int):
 134             result = repr(value)
 135         elif getattr(value, '__len__', False):
 136             return repr(list(value))
 137         else:
 138             print("Export key configuration: can't write ", value)
 139
 140         return result
 141
 142     def export_properties(prefix, properties, lines=None):
 143         if lines is None:
 144             lines = []
 145
 146         for pname in properties.bl_rna.properties.keys():
 147             if pname != "rna_type" and not properties.is_property_hidden(pname):
 148                 value = getattr(properties, pname)
 149                 if isinstance(value, OperatorProperties):
 150                     export_properties(prefix + "." + pname, value, lines)
 151                 elif properties.is_property_set(pname):
 152                     value = string_value(value)
 153                     if value != "":
 154                         lines.append("%s.%s = %s\n" % (prefix, pname, value))
 155         return lines
 156
 157     f = open(filepath, "w")
 158
 159     f.write("import bpy\n")
 160     f.write("import os\n\n")
 161     f.write("wm = bpy.context.window_manager\n")
 162     f.write("kc = wm.keyconfigs.new(os.path.splitext(os.path.basename(__file__))[0])\n\n")  # keymap must be created by caller
 163
 164     # Generate a list of keymaps to export:
 165     #
 166     # First add all user_modified keymaps (found in keyconfigs.user.keymaps list),
 167     # then add all remaining keymaps from the currently active custom keyconfig.
 168     #
 169     # This will create a final list of keymaps that can be used as a 'diff' against
 170     # the default blender keyconfig, recreating the current setup from a fresh blender
 171     # without needing to export keymaps which haven't been edited.
 172
 173     class FakeKeyConfig():
 174         keymaps = []
 175     edited_kc = FakeKeyConfig()
 176     for km in wm.keyconfigs.user.keymaps:
 177         if km.is_user_modified:
 178             edited_kc.keymaps.append(km)
 179     # merge edited keymaps with non-default keyconfig, if it exists
 180     if kc != wm.keyconfigs.default:
 181         export_keymaps = keyconfig_merge(edited_kc, kc)
 182     else:
 183         export_keymaps = keyconfig_merge(edited_kc, edited_kc)
 184
 185     for km, kc_x in export_keymaps:
 186
 187         km = km.active()
 188
 189         f.write("# Map %s\n" % km.name)
 190         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))
 191         for kmi in km.keymap_items:
 192             if km.is_modal:
 193                 f.write("kmi = km.keymap_items.new_modal('%s', '%s', '%s'" % (kmi.propvalue, kmi.type, kmi.value))
 194             else:
 195                 f.write("kmi = km.keymap_items.new('%s', '%s', '%s'" % (kmi.idname, kmi.type, kmi.value))
 196             if kmi.any:
 197                 f.write(", any=True")
 198             else:
 199                 if kmi.shift:
 200                     f.write(", shift=True")
 201                 if kmi.ctrl:
 202                     f.write(", ctrl=True")
 203                 if kmi.alt:
 204                     f.write(", alt=True")
 205                 if kmi.oskey:
 206                     f.write(", oskey=True")
 207             if kmi.key_modifier and kmi.key_modifier != 'NONE':
 208                 f.write(", key_modifier='%s'" % kmi.key_modifier)
 209             f.write(")\n")
 210
 211             props = kmi.properties
 212
 213             if props is not None:
 214                 f.write("".join(export_properties("kmi.properties", props)))
 215
 216         f.write("\n")
 217
 218     f.close()
 219
 220
 221 def keyconfig_test(kc):
 222
 223     def testEntry(kc, entry, src=None, parent=None):
 224         result = False
 225
 226         def kmistr(kmi):
 227             if km.is_modal:
 228                 s = ["kmi = km.keymap_items.new_modal(\'%s\', \'%s\', \'%s\'" % (kmi.propvalue, kmi.type, kmi.value)]
 229             else:
 230                 s = ["kmi = km.keymap_items.new(\'%s\', \'%s\', \'%s\'" % (kmi.idname, kmi.type, kmi.value)]
 231
 232             if kmi.any:
 233                 s.append(", any=True")
 234             else:
 235                 if kmi.shift:
 236                     s.append(", shift=True")
 237                 if kmi.ctrl:
 238                     s.append(", ctrl=True")
 239                 if kmi.alt:
 240                     s.append(", alt=True")
 241                 if kmi.oskey:
 242                     s.append(", oskey=True")
 243             if kmi.key_modifier and kmi.key_modifier != 'NONE':
 244                 s.append(", key_modifier=\'%s\'" % kmi.key_modifier)
 245
 246             s.append(")\n")
 247
 248             props = kmi.properties
 249
 250             if props is not None:
 251                 export_properties("kmi.properties", props, s)
 252
 253             return "".join(s).strip()
 254
 255         idname, spaceid, regionid, children = entry
 256
 257         km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
 258
 259         if km:
 260             km = km.active()
 261
 262             if src:
 263                 for item in km.keymap_items:
 264                     if src.compare(item):
 265                         print("===========")
 266                         print(parent.name)
 267                         print(kmistr(src))
 268                         print(km.name)
 269                         print(kmistr(item))
 270                         result = True
 271
 272                 for child in children:
 273                     if testEntry(kc, child, src, parent):
 274                         result = True
 275             else:
 276                 for i in range(len(km.keymap_items)):
 277                     src = km.keymap_items[i]
 278
 279                     for child in children:
 280                         if testEntry(kc, child, src, km):
 281                             result = True
 282
 283                     for j in range(len(km.keymap_items) - i - 1):
 284                         item = km.keymap_items[j + i + 1]
 285                         if src.compare(item):
 286                             print("===========")
 287                             print(km.name)
 288                             print(kmistr(src))
 289                             print(kmistr(item))
 290                             result = True
 291
 292                 for child in children:
 293                     if testEntry(kc, child):
 294                         result = True
 295
 296         return result
 297
 298     # -------------------------------------------------------------------------
 299     # Function body
 300
 301     result = False
 302     for entry in KM_HIERARCHY:
 303         if testEntry(kc, entry):
 304             result = True
 305     return result