625 lines
20 KiB
Python
625 lines
20 KiB
Python
# SPDX-FileCopyrightText: 2010-2023 Blender Authors
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
__all__ = (
|
|
"draw_entry",
|
|
"draw_km",
|
|
"draw_kmi",
|
|
"draw_filtered",
|
|
"draw_hierarchy",
|
|
"draw_keymaps",
|
|
)
|
|
|
|
|
|
import bpy
|
|
from bpy.app.translations import (
|
|
contexts as i18n_contexts,
|
|
pgettext_iface as iface_,
|
|
pgettext_rpt as rpt_,
|
|
)
|
|
|
|
|
|
def _is_operator_available(idname):
|
|
module, _, operator = idname.partition(".")
|
|
|
|
# Check if the module and operator exist.
|
|
return (
|
|
module and
|
|
operator and
|
|
getattr(getattr(bpy.ops, module, None), operator, None) is not None
|
|
)
|
|
|
|
|
|
def _indented_layout(layout, level):
|
|
indentpx = 16
|
|
if level == 0:
|
|
level = 0.0001 # Tweak so that a percentage of 0 won't split by half
|
|
indent = level * indentpx / bpy.context.region.width
|
|
|
|
split = layout.split(factor=indent)
|
|
col = split.column()
|
|
col = split.column()
|
|
return col
|
|
|
|
|
|
def draw_entry(display_keymaps, entry, col, level=0):
|
|
idname, spaceid, regionid, children = entry
|
|
|
|
for km, kc in display_keymaps:
|
|
if km.name == idname and km.space_type == spaceid and km.region_type == regionid:
|
|
draw_km(display_keymaps, kc, km, children, col, level)
|
|
|
|
'''
|
|
km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
|
|
if not km:
|
|
kc = defkc
|
|
km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
|
|
|
|
if km:
|
|
draw_km(kc, km, children, col, level)
|
|
'''
|
|
|
|
|
|
def draw_km(display_keymaps, kc, km, children, layout, level):
|
|
km = km.active()
|
|
|
|
layout.context_pointer_set("keymap", km)
|
|
|
|
col = _indented_layout(layout, level)
|
|
|
|
row = col.row(align=True)
|
|
row.prop(km, "show_expanded_children", text="", emboss=False)
|
|
row.label(text=km.name, text_ctxt=i18n_contexts.id_windowmanager)
|
|
|
|
if km.is_user_modified or km.is_modal:
|
|
subrow = row.row()
|
|
subrow.alignment = 'RIGHT'
|
|
|
|
if km.is_user_modified:
|
|
subrow.operator("preferences.keymap_restore", text="Restore")
|
|
# Add margin to space the button from the scroll-bar.
|
|
subrow.separator()
|
|
if km.is_modal:
|
|
subrow.label(text="", icon='LINKED')
|
|
del subrow
|
|
|
|
if km.show_expanded_children:
|
|
if children:
|
|
# Put the Parent key map's entries in a 'global' sub-category
|
|
# equal in hierarchy to the other children categories
|
|
subcol = _indented_layout(col, level + 1)
|
|
subrow = subcol.row(align=True)
|
|
subrow.prop(km, "show_expanded_items", text="", emboss=False)
|
|
subrow.label(
|
|
text=iface_("{:s} (Global)").format(iface_(km.name, i18n_contexts.id_windowmanager)),
|
|
translate=False,
|
|
)
|
|
else:
|
|
km.show_expanded_items = True
|
|
|
|
# Key Map items
|
|
if km.show_expanded_items:
|
|
kmi_level = level + 3 if children else level + 1
|
|
for kmi in km.keymap_items:
|
|
draw_kmi(display_keymaps, kc, km, kmi, col, kmi_level)
|
|
|
|
# "Add New" at end of keymap item list
|
|
subcol = _indented_layout(col, kmi_level)
|
|
subcol = subcol.split(factor=0.2).column()
|
|
subcol.operator(
|
|
"preferences.keyitem_add",
|
|
text="Add New",
|
|
text_ctxt=i18n_contexts.id_windowmanager,
|
|
icon='ADD',
|
|
)
|
|
col.separator()
|
|
|
|
# Child key maps
|
|
if children:
|
|
for entry in children:
|
|
draw_entry(display_keymaps, entry, col, level + 1)
|
|
|
|
col.separator()
|
|
|
|
|
|
def draw_kmi(display_keymaps, kc, km, kmi, layout, level):
|
|
map_type = kmi.map_type
|
|
is_op_available = _is_operator_available(kmi.idname)
|
|
|
|
col = _indented_layout(layout, level)
|
|
|
|
if kmi.show_expanded:
|
|
col = col.column(align=True)
|
|
box = col.box()
|
|
else:
|
|
box = col.column()
|
|
|
|
split = box.split()
|
|
|
|
# header bar
|
|
row = split.row(align=True)
|
|
row.prop(kmi, "show_expanded", text="", emboss=False)
|
|
row.prop(kmi, "active", text="", emboss=False)
|
|
|
|
if km.is_modal:
|
|
row.separator()
|
|
row.alert = not kmi.propvalue
|
|
row.prop(kmi, "propvalue", text="")
|
|
else:
|
|
if is_op_available:
|
|
row.label(text=kmi.name)
|
|
# The default item when adding a new item is "none"
|
|
# so consider this unassigned along with an empty string.
|
|
elif kmi.idname in {"none", ""}:
|
|
row.alert = True
|
|
row.label(text="(Unassigned)")
|
|
else:
|
|
row.alert = True
|
|
row.label(text=rpt_("{:s} (unavailable)").format(kmi.idname), icon='WARNING_LARGE', translate=False)
|
|
|
|
row = split.row()
|
|
row.prop(kmi, "map_type", text="")
|
|
if map_type == 'KEYBOARD':
|
|
row.prop(kmi, "type", text="", full_event=True)
|
|
elif map_type == 'MOUSE':
|
|
row.prop(kmi, "type", text="", full_event=True)
|
|
elif map_type == 'NDOF':
|
|
row.prop(kmi, "type", text="", full_event=True)
|
|
elif map_type == 'TWEAK':
|
|
subrow = row.row()
|
|
subrow.prop(kmi, "type", text="")
|
|
subrow.prop(kmi, "value", text="")
|
|
elif map_type == 'TIMER':
|
|
row.prop(kmi, "type", text="")
|
|
else:
|
|
row.label()
|
|
|
|
if (not kmi.is_user_defined) and kmi.is_user_modified:
|
|
row.operator("preferences.keyitem_restore", text="", icon='BACK').item_id = kmi.id
|
|
else:
|
|
row.operator(
|
|
"preferences.keyitem_remove",
|
|
text="",
|
|
# Abusing the tracking icon, but it works pretty well here.
|
|
icon=('TRACKING_CLEAR_BACKWARDS' if kmi.is_user_defined else 'X')
|
|
).item_id = kmi.id
|
|
|
|
# Add margin to space the buttons from the scroll-bar.
|
|
row.separator(factor=0.25 if kmi.show_expanded else 1.0)
|
|
|
|
# Expanded, additional event settings
|
|
if kmi.show_expanded:
|
|
from _bpy import _wm_capabilities
|
|
capabilities = _wm_capabilities()
|
|
|
|
box = col.box()
|
|
|
|
split = box.split(factor=0.4)
|
|
sub = split.row()
|
|
|
|
if km.is_modal:
|
|
sub.alert = not kmi.propvalue
|
|
sub.prop(kmi, "propvalue", text="")
|
|
else:
|
|
subrow = sub.row()
|
|
subrow.alert = not is_op_available
|
|
subrow.prop(kmi, "idname", text="", placeholder="Operator")
|
|
|
|
if map_type not in {'TEXTINPUT', 'TIMER'}:
|
|
from sys import platform
|
|
|
|
sub = split.column()
|
|
subrow = sub.row(align=True)
|
|
|
|
if map_type == 'KEYBOARD':
|
|
subrow.prop(kmi, "type", text="", event=True)
|
|
subrow.prop(kmi, "value", text="")
|
|
subrow_repeat = subrow.row(align=True)
|
|
subrow_repeat.active = kmi.value in {'ANY', 'PRESS'}
|
|
subrow_repeat.prop(kmi, "repeat", text="Repeat")
|
|
elif map_type in {'MOUSE', 'NDOF'}:
|
|
subrow.prop(kmi, "type", text="")
|
|
subrow.prop(kmi, "value", text="")
|
|
|
|
if map_type in {'KEYBOARD', 'MOUSE'} and kmi.value == 'CLICK_DRAG':
|
|
subrow = sub.row()
|
|
subrow.prop(kmi, "direction")
|
|
|
|
subrow = sub.row()
|
|
subrow.scale_x = 0.75
|
|
subrow.prop(kmi, "any", toggle=True)
|
|
|
|
# Match text in `WM_key_event_string`.
|
|
match platform:
|
|
case "darwin":
|
|
oskey_label = "Cmd"
|
|
case "win32":
|
|
oskey_label = "Win"
|
|
case _:
|
|
oskey_label = "OS"
|
|
|
|
# Use `*_ui` properties as integers aren't practical.
|
|
subrow.prop(kmi, "shift_ui", toggle=True)
|
|
subrow.prop(kmi, "ctrl_ui", toggle=True)
|
|
subrow.prop(kmi, "alt_ui", toggle=True)
|
|
subrow.prop(kmi, "oskey_ui", text=oskey_label, toggle=True)
|
|
|
|
# On systems that don't support Hyper, only show if it's enabled.
|
|
# Otherwise the user may have a key binding that doesn't work and can't be changed.
|
|
if capabilities['KEYBOARD_HYPER_KEY'] or kmi.hyper == 1:
|
|
subrow.prop(kmi, "hyper_ui", text="Hyper", toggle=True)
|
|
|
|
subrow.prop(kmi, "key_modifier", text="", event=True)
|
|
|
|
# Operator properties
|
|
box.template_keymap_item_properties(kmi)
|
|
|
|
# Modal key maps attached to this operator
|
|
if not km.is_modal:
|
|
kmm = kc.keymaps.find_modal(kmi.idname)
|
|
if kmm:
|
|
draw_km(display_keymaps, kc, kmm, None, layout, level + 1)
|
|
layout.context_pointer_set("keymap", km)
|
|
|
|
|
|
_EVENT_TYPES = set()
|
|
_EVENT_TYPE_MAP = {}
|
|
_EVENT_TYPE_MAP_EXTRA = {}
|
|
_EVENT_TYPE_MAP_I18N = {}
|
|
|
|
_MODIFIER_ALIASES = {}
|
|
_VALUE_ALIASES = {}
|
|
|
|
_search_tables_language_init = None
|
|
|
|
|
|
def _init_search_tables():
|
|
# Build all search lookup tables once from bl_rna enums + translations.
|
|
global _search_tables_language_init
|
|
|
|
current_language = bpy.context.preferences.view.language
|
|
if _search_tables_language_init == current_language:
|
|
return
|
|
|
|
_search_tables_language_init = current_language
|
|
|
|
_EVENT_TYPES.clear()
|
|
_EVENT_TYPE_MAP.clear()
|
|
_EVENT_TYPE_MAP_EXTRA.clear()
|
|
_EVENT_TYPE_MAP_I18N.clear()
|
|
_MODIFIER_ALIASES.clear()
|
|
_VALUE_ALIASES.clear()
|
|
|
|
from sys import platform
|
|
|
|
# Event type tables.
|
|
enum = bpy.types.Event.bl_rna.properties["type"].enum_items
|
|
_EVENT_TYPES.update(enum.keys())
|
|
_EVENT_TYPE_MAP.update({
|
|
item.name.replace(" ", "_").upper(): key
|
|
for key, item in enum.items()
|
|
})
|
|
|
|
# Translated event type names (only entries that differ from English).
|
|
# Match context used by WM_key_event_string.
|
|
for key, item in enum.items():
|
|
translated = iface_(item.name, i18n_contexts.ui_events_keymaps)
|
|
if translated != item.name:
|
|
_EVENT_TYPE_MAP_I18N[translated.replace(" ", "_").upper()] = key
|
|
|
|
del enum
|
|
|
|
_EVENT_TYPE_MAP_EXTRA.update({
|
|
"`": 'ACCENT_GRAVE',
|
|
"*": 'NUMPAD_ASTERIX',
|
|
"/": 'NUMPAD_SLASH',
|
|
'+': 'NUMPAD_PLUS',
|
|
"-": 'NUMPAD_MINUS',
|
|
".": 'NUMPAD_PERIOD',
|
|
"'": 'QUOTE',
|
|
"RMB": 'RIGHTMOUSE',
|
|
"LMB": 'LEFTMOUSE',
|
|
"MMB": 'MIDDLEMOUSE',
|
|
})
|
|
_EVENT_TYPE_MAP_EXTRA.update({
|
|
"{:d}".format(i): "NUMPAD_{:d}".format(i) for i in range(10)
|
|
})
|
|
|
|
# Modifier {alias: kmi_attribute}
|
|
_MODIFIER_ALIASES.update({
|
|
"ctrl": "ctrl",
|
|
"alt": "alt",
|
|
"shift": "shift",
|
|
"oskey": "oskey",
|
|
"hyper": "hyper",
|
|
"any": "any",
|
|
|
|
# macOS specific modifiers names
|
|
"control": "ctrl",
|
|
"option": "alt",
|
|
"cmd": "oskey",
|
|
"command": "oskey",
|
|
})
|
|
|
|
match platform:
|
|
case "darwin":
|
|
pass # "cmd" already mapped above
|
|
case "win32":
|
|
_MODIFIER_ALIASES["win"] = "oskey"
|
|
case _:
|
|
_MODIFIER_ALIASES["os"] = "oskey"
|
|
|
|
# Translated modifier labels (e.g. "Maj" -> "shift" in French).
|
|
# Match contexts used by WM_key_event_string.
|
|
for english_label, attr, ctx in (
|
|
("Shift", "shift", i18n_contexts.id_windowmanager),
|
|
("Ctrl", "ctrl", None),
|
|
("Alt", "alt", None),
|
|
("Cmd", "oskey", None),
|
|
("Win", "oskey", None),
|
|
("OS", "oskey", None),
|
|
("Hyper", "hyper", None),
|
|
("Any", "any", None),
|
|
):
|
|
translated = iface_(english_label, ctx).lower()
|
|
if translated not in _MODIFIER_ALIASES:
|
|
_MODIFIER_ALIASES[translated] = attr
|
|
|
|
# Event value {alias: enum_identifier}
|
|
_VALUE_ALIASES.update({
|
|
"dbl": "DOUBLE_CLICK",
|
|
"double": "DOUBLE_CLICK",
|
|
"doubleclick": "DOUBLE_CLICK",
|
|
"double_click": "DOUBLE_CLICK",
|
|
"press": "PRESS",
|
|
"release": "RELEASE",
|
|
"click": "CLICK",
|
|
"drag": "CLICK_DRAG",
|
|
"clickdrag": "CLICK_DRAG",
|
|
"click_drag": "CLICK_DRAG",
|
|
})
|
|
|
|
# Translated event value names from bl_rna.
|
|
value_prop = bpy.types.Event.bl_rna.properties["value"]
|
|
value_enum = value_prop.enum_items
|
|
for key, item in value_enum.items():
|
|
english_norm = item.name.replace(" ", "").replace("-", "").lower()
|
|
if english_norm not in _VALUE_ALIASES:
|
|
_VALUE_ALIASES[english_norm] = key
|
|
translated = iface_(item.name, value_prop.translation_context)
|
|
if translated != item.name:
|
|
translated_norm = translated.replace(" ", "").replace("-", "").lower()
|
|
if translated_norm not in _VALUE_ALIASES:
|
|
_VALUE_ALIASES[translated_norm] = key
|
|
del value_prop, value_enum
|
|
|
|
|
|
def draw_filtered(display_keymaps, filter_type, filter_text, layout):
|
|
|
|
if filter_type == 'NAME':
|
|
def filter_func(kmi):
|
|
return (filter_text in kmi.idname.lower() or
|
|
filter_text in kmi.name.lower())
|
|
else:
|
|
_init_search_tables()
|
|
|
|
filter_text_split = filter_text.split()
|
|
|
|
# KeyMapItem like dict, use for comparing against
|
|
# attr: {states, ...}
|
|
kmi_test_dict = {}
|
|
# Special handling of 'type' using a list if sets,
|
|
# keymap items must match against all.
|
|
kmi_test_type = []
|
|
|
|
# altname: attr
|
|
remaining = []
|
|
for token in filter_text_split:
|
|
attr = _MODIFIER_ALIASES.get(token)
|
|
if attr is not None:
|
|
kmi_test_dict[attr] = {True}
|
|
else:
|
|
remaining.append(token)
|
|
filter_text_split = remaining
|
|
|
|
# Recognize event value prefixes (e.g. "dbl-a", "press a").
|
|
normalized_tokens = []
|
|
for token in filter_text_split:
|
|
prefix, sep, rest = token.partition("-")
|
|
|
|
if sep:
|
|
# "dbl-a", "drag-left" -> check prefix as event value.
|
|
val = _VALUE_ALIASES.get(prefix)
|
|
if val is not None:
|
|
kmi_test_dict.setdefault("value", set()).add(val)
|
|
if rest:
|
|
normalized_tokens.append(rest)
|
|
continue
|
|
|
|
# Try the whole token as an event value (e.g. "press", "release").
|
|
val = _VALUE_ALIASES.get(token)
|
|
if val is not None:
|
|
kmi_test_dict.setdefault("value", set()).add(val)
|
|
continue
|
|
|
|
# Not a value -> keep as an event type token.
|
|
normalized_tokens.append(token)
|
|
|
|
filter_text_split = normalized_tokens
|
|
|
|
# what's left should be the event type
|
|
def kmi_type_set_from_string(kmi_type):
|
|
kmi_type = kmi_type.upper()
|
|
kmi_type_set = set()
|
|
|
|
if kmi_type in _EVENT_TYPES:
|
|
kmi_type_set.add(kmi_type)
|
|
|
|
if not kmi_type_set or len(kmi_type) > 1:
|
|
# replacement table
|
|
for event_type_map in (_EVENT_TYPE_MAP, _EVENT_TYPE_MAP_I18N, _EVENT_TYPE_MAP_EXTRA):
|
|
kmi_type_test = event_type_map.get(kmi_type)
|
|
if kmi_type_test is not None:
|
|
kmi_type_set.add(kmi_type_test)
|
|
else:
|
|
# print("Unknown Type:", kmi_type)
|
|
|
|
# Partial match
|
|
for k, v in event_type_map.items():
|
|
if (kmi_type in k) or (kmi_type in v):
|
|
kmi_type_set.add(v)
|
|
return kmi_type_set
|
|
|
|
for kmi_type in filter_text_split:
|
|
kmi_type_set = kmi_type_set_from_string(kmi_type)
|
|
|
|
if not kmi_type_set:
|
|
return False
|
|
|
|
kmi_test_type.append(kmi_type_set)
|
|
# tiny optimization, sort sets so the smallest is first
|
|
# improve chances of failing early
|
|
kmi_test_type.sort(key=lambda kmi_type_set: len(kmi_type_set))
|
|
|
|
# main filter func, runs many times
|
|
def filter_func(kmi):
|
|
for kk, ki in kmi_test_dict.items():
|
|
val = getattr(kmi, kk)
|
|
if val not in ki:
|
|
return False
|
|
|
|
# special handling of 'type'
|
|
for ki in kmi_test_type:
|
|
val = kmi.type
|
|
if val == 'NONE' or val not in ki:
|
|
# exception for 'type'
|
|
# also inspect 'key_modifier' as a fallback
|
|
val = kmi.key_modifier
|
|
if not (val == 'NONE' or val not in ki):
|
|
continue
|
|
return False
|
|
|
|
return True
|
|
|
|
for km, kc in display_keymaps:
|
|
km = km.active()
|
|
layout.context_pointer_set("keymap", km)
|
|
|
|
filtered_items = [kmi for kmi in km.keymap_items if filter_func(kmi)]
|
|
|
|
if filtered_items:
|
|
col = layout.column()
|
|
|
|
row = col.row(align=True)
|
|
row.label(
|
|
text=km.name,
|
|
icon='DOT',
|
|
text_ctxt=i18n_contexts.id_windowmanager,
|
|
)
|
|
if km.is_user_modified:
|
|
subrow = row.row()
|
|
subrow.alignment = 'RIGHT'
|
|
subrow.operator("preferences.keymap_restore", text="Restore")
|
|
# Add margin to space the button from the scroll-bar.
|
|
subrow.separator()
|
|
|
|
for kmi in filtered_items:
|
|
draw_kmi(display_keymaps, kc, km, kmi, col, 1)
|
|
return True
|
|
|
|
|
|
def draw_hierarchy(display_keymaps, layout):
|
|
from bl_keymap_utils import keymap_hierarchy
|
|
for entry in keymap_hierarchy.generate():
|
|
draw_entry(display_keymaps, entry, layout)
|
|
|
|
|
|
def draw_keymaps(context, layout):
|
|
from bl_keymap_utils.io import keyconfig_merge
|
|
|
|
wm = context.window_manager
|
|
kc_user = wm.keyconfigs.user
|
|
kc_active = wm.keyconfigs.active
|
|
spref = context.space_data
|
|
|
|
# row.prop_search(wm.keyconfigs, "active", wm, "keyconfigs", text="Key Config")
|
|
text = bpy.path.display_name(kc_active.name, has_ext=False)
|
|
if not text:
|
|
text = "Blender (default)"
|
|
|
|
split = layout.split(factor=0.6)
|
|
|
|
row = split.row()
|
|
|
|
rowsub = row.row(align=True)
|
|
|
|
rowsub.menu("USERPREF_MT_keyconfigs", text=text)
|
|
rowsub.operator("wm.keyconfig_preset_add", text="", icon='ADD')
|
|
rowsub.operator("wm.keyconfig_preset_remove", text="", icon='REMOVE')
|
|
|
|
rowsub = split.row(align=True)
|
|
rowsub.operator("preferences.keyconfig_import", text="Import...", icon='IMPORT')
|
|
rowsub.operator("preferences.keyconfig_export", text="Export...", icon='EXPORT')
|
|
|
|
row = layout.row()
|
|
col = layout.column()
|
|
|
|
# layout.context_pointer_set("keyconfig", wm.keyconfigs.active)
|
|
# row.operator("preferences.keyconfig_remove", text="", icon='X')
|
|
rowsub = row.split(factor=0.4, align=True)
|
|
# postpone drawing into rowsub, so we can set alert!
|
|
|
|
layout.separator()
|
|
display_keymaps = keyconfig_merge(kc_user, kc_user)
|
|
filter_type = spref.filter_type
|
|
filter_text = spref.filter_text.strip()
|
|
if filter_text:
|
|
filter_text = filter_text.lower()
|
|
ok = draw_filtered(display_keymaps, filter_type, filter_text, layout)
|
|
else:
|
|
draw_hierarchy(display_keymaps, layout)
|
|
ok = True
|
|
|
|
# go back and fill in rowsub
|
|
rowsubsub = rowsub.row(align=True)
|
|
rowsubsub.prop(spref, "filter_type", expand=True)
|
|
rowsubsub = rowsub.row(align=True)
|
|
if not ok:
|
|
rowsubsub.alert = True
|
|
search_placeholder = ""
|
|
if spref.filter_type == 'NAME':
|
|
search_placeholder = iface_("Search by Name")
|
|
elif spref.filter_type == 'KEY':
|
|
search_placeholder = iface_("Search by Key-Binding")
|
|
rowsubsub.prop(spref, "filter_text", text="", icon='VIEWZOOM', placeholder=search_placeholder)
|
|
|
|
if not filter_text:
|
|
# When the keyconfig defines its own preferences.
|
|
kc_prefs = kc_active.preferences
|
|
if kc_prefs is not None:
|
|
box = col.box()
|
|
row = box.row(align=True)
|
|
|
|
pref = context.preferences
|
|
keymappref = pref.keymap
|
|
show_ui_keyconfig = keymappref.show_ui_keyconfig
|
|
row.prop(
|
|
keymappref,
|
|
"show_ui_keyconfig",
|
|
text="",
|
|
icon='DISCLOSURE_TRI_DOWN' if show_ui_keyconfig else 'DISCLOSURE_TRI_RIGHT',
|
|
emboss=False,
|
|
)
|
|
row.label(text="Preferences")
|
|
|
|
if show_ui_keyconfig:
|
|
# Defined by user preset, may contain mistakes out of our control.
|
|
try:
|
|
kc_prefs.draw(box)
|
|
except Exception:
|
|
import traceback
|
|
traceback.print_exc()
|
|
del box
|
|
del kc_prefs
|