development_iskeyfree.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 (https://www.python.org/dev/peps/pep-0008)
  20
  21 bl_info = {
  22     "name": "Is key Free",
  23     "author": "Antonio Vazquez (antonioya)",
  24     "version": (1, 1, 2),
  25     "blender": (2, 80, 0),
  26     "location": "Text Editor > Sidebar > Dev Tab",
  27     "description": "Find free shortcuts, inform about used and print a key list",
  28     "doc_url": "{BLENDER_MANUAL_URL}/addons/development/is_key_free.html",
  29     "category": "Development",
  30 }
  31
  32 import bpy
  33 from bpy.props import (
  34     BoolProperty,
  35     EnumProperty,
  36     StringProperty,
  37     PointerProperty,
  38 )
  39 from bpy.types import (
  40     Operator,
  41     Panel,
  42     PropertyGroup,
  43 )
  44
  45
  46 # ------------------------------------------------------
  47 # Class to find keymaps
  48 # ------------------------------------------------------
  49
  50 class MyChecker():
  51     lastfind = None
  52     lastkey = None
  53     mylist = []
  54
  55     # Init
  56     def __init__(self):
  57         self.var = 5
  58
  59     # Verify if the key is used
  60     @classmethod
  61     def check(cls, findkey, ctrl, alt, shift, oskey):
  62         if len(findkey) > 0:
  63             cmd = ""
  64             if ctrl is True:
  65                 cmd += "Ctrl+"
  66             if alt is True:
  67                 cmd += "Alt+"
  68             if shift is True:
  69                 cmd += "Shift+"
  70             if oskey is True:
  71                 cmd += "OsKey+"
  72             cls.lastfind = cmd + findkey.upper()
  73             cls.lastkey = findkey.upper()
  74         else:
  75             cls.lastfind = None
  76             cls.lastkey = None
  77
  78         wm = bpy.context.window_manager
  79         mykeys = []
  80
  81         for context, keyboardmap in wm.keyconfigs.user.keymaps.items():
  82             for myitem in keyboardmap.keymap_items:
  83                 if myitem.active is True and myitem.type == findkey:
  84                     if ctrl is True and myitem.ctrl is not True:
  85                         continue
  86                     if alt is True and myitem.alt is not True:
  87                         continue
  88                     if shift is True and myitem.shift is not True:
  89                         continue
  90                     if oskey is True and myitem.oskey is not True:
  91                         continue
  92                     t = (context,
  93                          myitem.type,
  94                          "Ctrl" if myitem.ctrl is True else "",
  95                          "Alt" if myitem.alt is True else "",
  96                          "Shift" if myitem.shift is True else "",
  97                          "OsKey" if myitem.oskey is True else "",
  98                          myitem.name)
  99
 100                     mykeys.append(t)
 101
 102         sortkeys = sorted(mykeys, key=lambda key: (key[0], key[1], key[2], key[3], key[4], key[5]))
 103
 104         cls.mylist.clear()
 105         for e in sortkeys:
 106             cmd = ""
 107             if e[2] != "":
 108                 cmd += e[2] + "+"
 109             if e[3] != "":
 110                 cmd += e[3] + "+"
 111             if e[4] != "":
 112                 cmd += e[4] + "+"
 113             if e[5] != "":
 114                 cmd += e[5] + "+"
 115
 116             cmd += e[1]
 117
 118             if e[6] != "":
 119                 cmd += "  " + e[6]
 120             cls.mylist.append([e[0], cmd])
 121
 122     # return context
 123     @classmethod
 124     def getcontext(cls):
 125         return str(bpy.context.screen.name)
 126
 127     # return last search
 128     @classmethod
 129     def getlast(cls):
 130         return cls.lastfind
 131
 132     # return last key
 133     @classmethod
 134     def getlastkey(cls):
 135         return cls.lastkey
 136
 137     # return result of last search
 138     @classmethod
 139     def getlist(cls):
 140         return cls.mylist
 141
 142     # verify if key is valid
 143     @classmethod
 144     def isvalidkey(cls, txt):
 145         allkeys = [
 146             "LEFTMOUSE", "MIDDLEMOUSE", "RIGHTMOUSE", "BUTTON4MOUSE", "BUTTON5MOUSE", "BUTTON6MOUSE",
 147             "BUTTON7MOUSE",
 148             "MOUSEMOVE", "INBETWEEN_MOUSEMOVE", "TRACKPADPAN", "TRACKPADZOOM",
 149             "MOUSEROTATE", "WHEELUPMOUSE", "WHEELDOWNMOUSE", "WHEELINMOUSE", "WHEELOUTMOUSE", "EVT_TWEAK_L",
 150             "EVT_TWEAK_M", "EVT_TWEAK_R", "A", "B", "C", "D", "E", "F", "G", "H",
 151             "I", "J",
 152             "K", "L", "M", "N", "O", "P", "Q", "R", "S", "T", "U", "V", "W", "X", "Y", "Z", "ZERO", "ONE", "TWO",
 153             "THREE", "FOUR", "FIVE", "SIX", "SEVEN", "EIGHT", "NINE", "LEFT_CTRL", "LEFT_ALT", "LEFT_SHIFT",
 154             "RIGHT_ALT",
 155             "RIGHT_CTRL", "RIGHT_SHIFT", "OSKEY", "GRLESS", "ESC", "TAB", "RET", "SPACE", "LINE_FEED",
 156             "BACK_SPACE",
 157             "DEL", "SEMI_COLON", "PERIOD", "COMMA", "QUOTE", "ACCENT_GRAVE", "MINUS", "SLASH", "BACK_SLASH",
 158             "EQUAL",
 159             "LEFT_BRACKET", "RIGHT_BRACKET", "LEFT_ARROW", "DOWN_ARROW", "RIGHT_ARROW", "UP_ARROW", "NUMPAD_2",
 160             "NUMPAD_4", "NUMPAD_6", "NUMPAD_8", "NUMPAD_1", "NUMPAD_3", "NUMPAD_5", "NUMPAD_7", "NUMPAD_9",
 161             "NUMPAD_PERIOD", "NUMPAD_SLASH", "NUMPAD_ASTERIX", "NUMPAD_0", "NUMPAD_MINUS", "NUMPAD_ENTER",
 162             "NUMPAD_PLUS",
 163             "F1", "F2", "F3", "F4", "F5", "F6", "F7", "F8", "F9", "F10", "F11", "F12", "F13", "F14", "F15",
 164             "F16", "F17",
 165             "F18", "F19", "PAUSE", "INSERT", "HOME", "PAGE_UP", "PAGE_DOWN", "END", "MEDIA_PLAY", "MEDIA_STOP",
 166             "MEDIA_FIRST", "MEDIA_LAST", "TEXTINPUT", "WINDOW_DEACTIVATE", "TIMER", "TIMER0", "TIMER1", "TIMER2",
 167             "TIMER_JOBS", "TIMER_AUTOSAVE", "TIMER_REPORT", "TIMERREGION", "NDOF_MOTION", "NDOF_BUTTON_MENU",
 168             "NDOF_BUTTON_FIT", "NDOF_BUTTON_TOP", "NDOF_BUTTON_BOTTOM", "NDOF_BUTTON_LEFT", "NDOF_BUTTON_RIGHT",
 169             "NDOF_BUTTON_FRONT", "NDOF_BUTTON_BACK", "NDOF_BUTTON_ISO1", "NDOF_BUTTON_ISO2",
 170             "NDOF_BUTTON_ROLL_CW",
 171             "NDOF_BUTTON_ROLL_CCW", "NDOF_BUTTON_SPIN_CW", "NDOF_BUTTON_SPIN_CCW", "NDOF_BUTTON_TILT_CW",
 172             "NDOF_BUTTON_TILT_CCW", "NDOF_BUTTON_ROTATE", "NDOF_BUTTON_PANZOOM", "NDOF_BUTTON_DOMINANT",
 173             "NDOF_BUTTON_PLUS", "NDOF_BUTTON_MINUS", "NDOF_BUTTON_ESC", "NDOF_BUTTON_ALT", "NDOF_BUTTON_SHIFT",
 174             "NDOF_BUTTON_CTRL", "NDOF_BUTTON_1", "NDOF_BUTTON_2", "NDOF_BUTTON_3", "NDOF_BUTTON_4",
 175             "NDOF_BUTTON_5",
 176             "NDOF_BUTTON_6", "NDOF_BUTTON_7", "NDOF_BUTTON_8", "NDOF_BUTTON_9", "NDOF_BUTTON_10",
 177             "NDOF_BUTTON_A",
 178             "NDOF_BUTTON_B", "NDOF_BUTTON_C"
 179             ]
 180         try:
 181             allkeys.index(txt)
 182             return True
 183         except ValueError:
 184             return False
 185
 186
 187 mychecker = MyChecker()  # Global class handler
 188
 189
 190 # ------------------------------------------------------
 191 # Button: Class for search button
 192 # ------------------------------------------------------
 193 class RunActionCheck(Operator):
 194     bl_idname = "iskeyfree.action_check"
 195     bl_label = ""
 196     bl_description = "Verify if the selected shortcut is free"
 197
 198     # noinspection PyUnusedLocal
 199     def execute(self, context):
 200         scene = context.scene.is_keyfree
 201         txt = scene.data.upper()
 202         global mychecker
 203         mychecker.check(txt, scene.use_crtl, scene.use_alt, scene.use_shift,
 204                         scene.use_oskey)
 205
 206         return {'FINISHED'}
 207
 208
 209 # ------------------------------------------------------
 210 # Defines UI panel
 211 # ------------------------------------------------------
 212 class UIControlPanel(Panel):
 213     bl_idname = "DEVISKEYFREE_PT_ui"
 214     bl_space_type = "TEXT_EDITOR"
 215     bl_region_type = "UI"
 216     bl_label = "Is Key Free"
 217     bl_category = 'Dev'
 218     bl_options = {'DEFAULT_CLOSED'}
 219
 220     # noinspection PyUnusedLocal
 221     def draw(self, context):
 222         layout = self.layout
 223         scene = context.scene.is_keyfree
 224
 225         row = layout.row(align=True)
 226         row.prop(scene, "data")
 227         row.operator("iskeyfree.action_check", icon="VIEWZOOM")
 228
 229         row = layout.row(align=True)
 230         row.prop(scene, "use_crtl", toggle=True)
 231         row.prop(scene, "use_alt", toggle=True)
 232         row.prop(scene, "use_shift", toggle=True)
 233         row.prop(scene, "use_oskey", toggle=True)
 234
 235         row = layout.row()
 236         row.prop(scene, "numpad")
 237
 238         layout.operator("iskeyfree.run_export_keys", icon="FILE_TEXT")
 239
 240         global mychecker
 241         mylist = mychecker.getlist()
 242         oldcontext = None
 243
 244         box = None
 245         if len(mylist) > 0:
 246             cmd = mychecker.getlast()
 247             if cmd is not None:
 248                 row = layout.row()
 249                 row.label(text="Current uses of " + str(cmd), icon="PARTICLE_DATA")
 250             for e in mylist:
 251                 if oldcontext != e[0]:
 252                     box = layout.box()
 253                     box.label(text=e[0], icon="UNPINNED")
 254                     oldcontext = e[0]
 255
 256                 row = box.row(align=True)
 257                 row.label(text=e[1])
 258         else:
 259             cmd = mychecker.getlast()
 260             if cmd is not None:
 261                 box = layout.box()
 262                 if mychecker.isvalidkey(mychecker.getlastkey()) is False:
 263                     box.label(text=str(mychecker.getlastkey()) + " looks not valid key", icon="ERROR")
 264                 else:
 265                     box.label(text=str(cmd) + " is free", icon="FILE_TICK")
 266
 267
 268 # ------------------------------------------------------
 269 # Update key (special values) event handler
 270 # ------------------------------------------------------
 271 # noinspection PyUnusedLocal
 272 def update_data(self, context):
 273     scene = context.scene.is_keyfree
 274     if scene.numpad != "NONE":
 275         scene.data = scene.numpad
 276
 277
 278 class IskeyFreeProperties(PropertyGroup):
 279     data: StringProperty(
 280         name="Key", maxlen=32,
 281         description="Shortcut to verify"
 282     )
 283     use_crtl: BoolProperty(
 284         name="Ctrl",
 285         description="Ctrl key used in shortcut",
 286         default=False
 287     )
 288     use_alt: BoolProperty(
 289         name="Alt",
 290         description="Alt key used in shortcut",
 291         default=False
 292     )
 293     use_shift: BoolProperty(
 294         name="Shift",
 295         description="Shift key used in shortcut",
 296         default=False
 297     )
 298     use_oskey: BoolProperty(
 299         name="OsKey",
 300         description="Operating system key used in shortcut",
 301         default=False
 302     )
 303     numpad: EnumProperty(
 304         items=(
 305             ('NONE', "Select key", ""),
 306             ("LEFTMOUSE", "LEFTMOUSE", ""),
 307             ("MIDDLEMOUSE", "MIDDLEMOUSE", ""),
 308             ("RIGHTMOUSE", "RIGHTMOUSE", ""),
 309             ("BUTTON4MOUSE", "BUTTON4MOUSE", ""),
 310             ("BUTTON5MOUSE", "BUTTON5MOUSE", ""),
 311             ("BUTTON6MOUSE", "BUTTON6MOUSE", ""),
 312             ("BUTTON7MOUSE", "BUTTON7MOUSE", ""),
 313             ("MOUSEMOVE", "MOUSEMOVE", ""),
 314             ("INBETWEEN_MOUSEMOVE", "INBETWEEN_MOUSEMOVE", ""),
 315             ("TRACKPADPAN", "TRACKPADPAN", ""),
 316             ("TRACKPADZOOM", "TRACKPADZOOM", ""),
 317             ("MOUSEROTATE", "MOUSEROTATE", ""),
 318             ("WHEELUPMOUSE", "WHEELUPMOUSE", ""),
 319             ("WHEELDOWNMOUSE", "WHEELDOWNMOUSE", ""),
 320             ("WHEELINMOUSE", "WHEELINMOUSE", ""),
 321             ("WHEELOUTMOUSE", "WHEELOUTMOUSE", ""),
 322             ("EVT_TWEAK_L", "EVT_TWEAK_L", ""),
 323             ("EVT_TWEAK_M", "EVT_TWEAK_M", ""),
 324             ("EVT_TWEAK_R", "EVT_TWEAK_R", ""),
 325             ("A", "A", ""),
 326             ("B", "B", ""),
 327             ("C", "C", ""),
 328             ("D", "D", ""),
 329             ("E", "E", ""),
 330             ("F", "F", ""),
 331             ("G", "G", ""),
 332             ("H", "H", ""),
 333             ("I", "I", ""),
 334             ("J", "J", ""),
 335             ("K", "K", ""),
 336             ("L", "L", ""),
 337             ("M", "M", ""),
 338             ("N", "N", ""),
 339             ("O", "O", ""),
 340             ("P", "P", ""),
 341             ("Q", "Q", ""),
 342             ("R", "R", ""),
 343             ("S", "S", ""),
 344             ("T", "T", ""),
 345             ("U", "U", ""),
 346             ("V", "V", ""),
 347             ("W", "W", ""),
 348             ("X", "X", ""),
 349             ("Y", "Y", ""),
 350             ("Z", "Z", ""),
 351             ("ZERO", "ZERO", ""),
 352             ("ONE", "ONE", ""),
 353             ("TWO", "TWO", ""),
 354             ("THREE", "THREE", ""),
 355             ("FOUR", "FOUR", ""),
 356             ("FIVE", "FIVE", ""),
 357             ("SIX", "SIX", ""),
 358             ("SEVEN", "SEVEN", ""),
 359             ("EIGHT", "EIGHT", ""),
 360             ("NINE", "NINE", ""),
 361             ("LEFT_CTRL", "LEFT_CTRL", ""),
 362             ("LEFT_ALT", "LEFT_ALT", ""),
 363             ("LEFT_SHIFT", "LEFT_SHIFT", ""),
 364             ("RIGHT_ALT", "RIGHT_ALT", ""),
 365             ("RIGHT_CTRL", "RIGHT_CTRL", ""),
 366             ("RIGHT_SHIFT", "RIGHT_SHIFT", ""),
 367             ("OSKEY", "OSKEY", ""),
 368             ("GRLESS", "GRLESS", ""),
 369             ("ESC", "ESC", ""),
 370             ("TAB", "TAB", ""),
 371             ("RET", "RET", ""),
 372             ("SPACE", "SPACE", ""),
 373             ("LINE_FEED", "LINE_FEED", ""),
 374             ("BACK_SPACE", "BACK_SPACE", ""),
 375             ("DEL", "DEL", ""),
 376             ("SEMI_COLON", "SEMI_COLON", ""),
 377             ("PERIOD", "PERIOD", ""),
 378             ("COMMA", "COMMA", ""),
 379             ("QUOTE", "QUOTE", ""),
 380             ("ACCENT_GRAVE", "ACCENT_GRAVE", ""),
 381             ("MINUS", "MINUS", ""),
 382             ("SLASH", "SLASH", ""),
 383             ("BACK_SLASH", "BACK_SLASH", ""),
 384             ("EQUAL", "EQUAL", ""),
 385             ("LEFT_BRACKET", "LEFT_BRACKET", ""),
 386             ("RIGHT_BRACKET", "RIGHT_BRACKET", ""),
 387             ("LEFT_ARROW", "LEFT_ARROW", ""),
 388             ("DOWN_ARROW", "DOWN_ARROW", ""),
 389             ("RIGHT_ARROW", "RIGHT_ARROW", ""),
 390             ("UP_ARROW", "UP_ARROW", ""),
 391             ("NUMPAD_1", "NUMPAD_1", ""),
 392             ("NUMPAD_2", "NUMPAD_2", ""),
 393             ("NUMPAD_3", "NUMPAD_3", ""),
 394             ("NUMPAD_4", "NUMPAD_4", ""),
 395             ("NUMPAD_5", "NUMPAD_5", ""),
 396             ("NUMPAD_6", "NUMPAD_6", ""),
 397             ("NUMPAD_7", "NUMPAD_7", ""),
 398             ("NUMPAD_8", "NUMPAD_8", ""),
 399             ("NUMPAD_9", "NUMPAD_9", ""),
 400             ("NUMPAD_0", "NUMPAD_0", ""),
 401             ("NUMPAD_PERIOD", "NUMPAD_PERIOD", ""),
 402             ("NUMPAD_SLASH", "NUMPAD_SLASH", ""),
 403             ("NUMPAD_ASTERIX", "NUMPAD_ASTERIX", ""),
 404             ("NUMPAD_MINUS", "NUMPAD_MINUS", ""),
 405             ("NUMPAD_ENTER", "NUMPAD_ENTER", ""),
 406             ("NUMPAD_PLUS", "NUMPAD_PLUS", ""),
 407             ("F1", "F1", ""),
 408             ("F2", "F2", ""),
 409             ("F3", "F3", ""),
 410             ("F4", "F4", ""),
 411             ("F5", "F5", ""),
 412             ("F6", "F6", ""),
 413             ("F7", "F7", ""),
 414             ("F8", "F8", ""),
 415             ("F9", "F9", ""),
 416             ("F10", "F10", ""),
 417             ("F11", "F11", ""),
 418             ("F12", "F12", ""),
 419             ("F13", "F13", ""),
 420             ("F14", "F14", ""),
 421             ("F15", "F15", ""),
 422             ("F16", "F16", ""),
 423             ("F17", "F17", ""),
 424             ("F18", "F18", ""),
 425             ("F19", "F19", ""),
 426             ("PAUSE", "PAUSE", ""),
 427             ("INSERT", "INSERT", ""),
 428             ("HOME", "HOME", ""),
 429             ("PAGE_UP", "PAGE_UP", ""),
 430             ("PAGE_DOWN", "PAGE_DOWN", ""),
 431             ("END", "END", ""),
 432             ("MEDIA_PLAY", "MEDIA_PLAY", ""),
 433             ("MEDIA_STOP", "MEDIA_STOP", ""),
 434             ("MEDIA_FIRST", "MEDIA_FIRST", ""),
 435             ("MEDIA_LAST", "MEDIA_LAST", ""),
 436             ("TEXTINPUT", "TEXTINPUT", ""),
 437             ("WINDOW_DEACTIVATE", "WINDOW_DEACTIVATE", ""),
 438             ("TIMER", "TIMER", ""),
 439             ("TIMER0", "TIMER0", ""),
 440             ("TIMER1", "TIMER1", ""),
 441             ("TIMER2", "TIMER2", ""),
 442             ("TIMER_JOBS", "TIMER_JOBS", ""),
 443             ("TIMER_AUTOSAVE", "TIMER_AUTOSAVE", ""),
 444             ("TIMER_REPORT", "TIMER_REPORT", ""),
 445             ("TIMERREGION", "TIMERREGION", ""),
 446             ("NDOF_MOTION", "NDOF_MOTION", ""),
 447             ("NDOF_BUTTON_MENU", "NDOF_BUTTON_MENU", ""),
 448             ("NDOF_BUTTON_FIT", "NDOF_BUTTON_FIT", ""),
 449             ("NDOF_BUTTON_TOP", "NDOF_BUTTON_TOP", ""),
 450             ("NDOF_BUTTON_BOTTOM", "NDOF_BUTTON_BOTTOM", ""),
 451             ("NDOF_BUTTON_LEFT", "NDOF_BUTTON_LEFT", ""),
 452             ("NDOF_BUTTON_RIGHT", "NDOF_BUTTON_RIGHT", ""),
 453             ("NDOF_BUTTON_FRONT", "NDOF_BUTTON_FRONT", ""),
 454             ("NDOF_BUTTON_BACK", "NDOF_BUTTON_BACK", ""),
 455             ("NDOF_BUTTON_ISO1", "NDOF_BUTTON_ISO1", ""),
 456             ("NDOF_BUTTON_ISO2", "NDOF_BUTTON_ISO2", ""),
 457             ("NDOF_BUTTON_ROLL_CW", "NDOF_BUTTON_ROLL_CW", ""),
 458             ("NDOF_BUTTON_ROLL_CCW", "NDOF_BUTTON_ROLL_CCW", ""),
 459             ("NDOF_BUTTON_SPIN_CW", "NDOF_BUTTON_SPIN_CW", ""),
 460             ("NDOF_BUTTON_SPIN_CCW", "NDOF_BUTTON_SPIN_CCW", ""),
 461             ("NDOF_BUTTON_TILT_CW", "NDOF_BUTTON_TILT_CW", ""),
 462             ("NDOF_BUTTON_TILT_CCW", "NDOF_BUTTON_TILT_CCW", ""),
 463             ("NDOF_BUTTON_ROTATE", "NDOF_BUTTON_ROTATE", ""),
 464             ("NDOF_BUTTON_PANZOOM", "NDOF_BUTTON_PANZOOM", ""),
 465             ("NDOF_BUTTON_DOMINANT", "NDOF_BUTTON_DOMINANT", ""),
 466             ("NDOF_BUTTON_PLUS", "NDOF_BUTTON_PLUS", ""),
 467             ("NDOF_BUTTON_MINUS", "NDOF_BUTTON_MINUS", ""),
 468             ("NDOF_BUTTON_ESC", "NDOF_BUTTON_ESC", ""),
 469             ("NDOF_BUTTON_ALT", "NDOF_BUTTON_ALT", ""),
 470             ("NDOF_BUTTON_SHIFT", "NDOF_BUTTON_SHIFT", ""),
 471             ("NDOF_BUTTON_CTRL", "NDOF_BUTTON_CTRL", ""),
 472             ("NDOF_BUTTON_1", "NDOF_BUTTON_1", ""),
 473             ("NDOF_BUTTON_2", "NDOF_BUTTON_2", ""),
 474             ("NDOF_BUTTON_3", "NDOF_BUTTON_3", ""),
 475             ("NDOF_BUTTON_4", "NDOF_BUTTON_4", ""),
 476             ("NDOF_BUTTON_5", "NDOF_BUTTON_5", ""),
 477             ("NDOF_BUTTON_6", "NDOF_BUTTON_6", ""),
 478             ("NDOF_BUTTON_7", "NDOF_BUTTON_7", ""),
 479             ("NDOF_BUTTON_8", "NDOF_BUTTON_8", ""),
 480             ("NDOF_BUTTON_9", "NDOF_BUTTON_9", ""),
 481             ("NDOF_BUTTON_10", "NDOF_BUTTON_10", ""),
 482             ("NDOF_BUTTON_A", "NDOF_BUTTON_A", ""),
 483             ("NDOF_BUTTON_B", "NDOF_BUTTON_B", ""),
 484             ("NDOF_BUTTON_C", "NDOF_BUTTON_C", "")
 485         ),
 486         name="Quick Type",
 487         description="Enter key code in find text",
 488         update=update_data
 489     )
 490
 491
 492 class IsKeyFreeRunExportKeys(Operator):
 493     bl_idname = "iskeyfree.run_export_keys"
 494     bl_label = "List all Shortcuts"
 495     bl_description = ("List all existing shortcuts in a text block\n"
 496                       "The newly generated list will be made active in the Text Editor\n"
 497                       "To access the previous ones, select them from the Header dropdown")
 498
 499     def all_shortcuts_name(self, context):
 500         new_name, def_name, ext = "", "All_Shortcuts", ".txt"
 501         suffix = 1
 502         try:
 503             # first slap a simple linear count + 1 for numeric suffix, if it fails
 504             # harvest for the rightmost numbers and append the max value
 505             list_txt = []
 506             data_txt = bpy.data.texts
 507             list_txt = [txt.name for txt in data_txt if txt.name.startswith("All_Shortcuts")]
 508             new_name = "{}_{}{}".format(def_name, len(list_txt) + 1, ext)
 509
 510             if new_name in list_txt:
 511                 from re import findall
 512                 test_num = [findall("\d+", words) for words in list_txt]
 513                 suffix += max([int(l[-1]) for l in test_num])
 514                 new_name = "{}_{}{}".format(def_name, suffix, ext)
 515             return new_name
 516         except:
 517             return None
 518
 519     def execute(self, context):
 520         wm = bpy.context.window_manager
 521         from collections import defaultdict
 522         mykeys = defaultdict(list)
 523         file_name = self.all_shortcuts_name(context) or "All_Shortcut.txt"
 524         start_note = "# Note: Some of the shortcuts entries don't have a name. Mostly Modal stuff\n"
 525         col_width, col_shortcuts = 2, 2
 526
 527         for ctx_type, keyboardmap in wm.keyconfigs.user.keymaps.items():
 528             for myitem in keyboardmap.keymap_items:
 529                 padding = len(myitem.name)
 530                 col_width = padding + 2 if padding > col_width else col_width
 531
 532                 short_type = myitem.type if myitem.type else "UNKNOWN"
 533                 is_ctrl = " Ctrl" if myitem.ctrl is True else ""
 534                 is_alt = " Alt" if myitem.alt is True else ""
 535                 is_shift = " Shift" if myitem.shift is True else ""
 536                 is_oskey = " OsKey" if myitem.oskey is True else ""
 537                 short_cuts = "{}{}{}{}{}".format(short_type, is_ctrl, is_alt, is_shift, is_oskey)
 538
 539                 t = (
 540                     myitem.name if myitem.name else "No Name",
 541                     short_cuts,
 542                 )
 543                 mykeys[ctx_type].append(t)
 544                 padding_s = len(short_cuts) + 2
 545                 col_shortcuts = padding_s if padding_s > col_shortcuts else col_shortcuts
 546
 547         max_line = col_shortcuts + col_width + 4
 548         textblock = bpy.data.texts.new(file_name)
 549         total = sum([len(mykeys[ctxs]) for ctxs in mykeys])
 550         textblock.write('# %d Total Shortcuts\n\n' % total)
 551         textblock.write(start_note)
 552
 553         for ctx in mykeys:
 554             textblock.write("\n[%s]\nEntries: %s\n\n" % (ctx, len(mykeys[ctx])))
 555             line_k = sorted(mykeys[ctx])
 556             for keys in line_k:
 557                 add_ticks = "-" * (max_line - (len(keys[0]) + len(keys[1])))
 558                 entries = "{ticks} {entry}".format(ticks=add_ticks, entry=keys[1])
 559                 textblock.write("{name} {entry}\n".format(name=keys[0], entry=entries))
 560
 561             textblock.write("\n\n")
 562
 563         # try to set the created text block to active
 564         if context.area.type in {"TEXT_EDITOR"}:
 565             bpy.context.space_data.text = bpy.data.texts[file_name]
 566
 567         self.report({'INFO'}, "See %s textblock" % file_name)
 568
 569         return {"FINISHED"}
 570
 571
 572 # -----------------------------------------------------
 573 # Registration
 574 # ------------------------------------------------------
 575 classes = (
 576     IskeyFreeProperties,
 577     RunActionCheck,
 578     UIControlPanel,
 579     IsKeyFreeRunExportKeys,
 580 )
 581
 582
 583 def register():
 584     for cls in classes:
 585         bpy.utils.register_class(cls)
 586     bpy.types.Scene.is_keyfree = PointerProperty(type=IskeyFreeProperties)
 587
 588
 589 def unregister():
 590     for cls in classes:
 591         bpy.utils.unregister_class(cls)
 592     del bpy.types.Scene.is_keyfree