e955c94ed3
Listing the "Blender Foundation" as copyright holder implied the Blender Foundation holds copyright to files which may include work from many developers. While keeping copyright on headers makes sense for isolated libraries, Blender's own code may be refactored or moved between files in a way that makes the per file copyright holders less meaningful. Copyright references to the "Blender Foundation" have been replaced with "Blender Authors", with the exception of `./extern/` since these this contains libraries which are more isolated, any changed to license headers there can be handled on a case-by-case basis. Some directories in `./intern/` have also been excluded: - `./intern/cycles/` it's own `AUTHORS` file is planned. - `./intern/opensubdiv/`. An "AUTHORS" file has been added, using the chromium projects authors file as a template. Design task: #110784 Ref !110783.
128 lines
4.5 KiB
Python
128 lines
4.5 KiB
Python
# SPDX-FileCopyrightText: 2011-2023 Blender Authors
|
|
#
|
|
# SPDX-License-Identifier: GPL-2.0-or-later
|
|
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Add-on helpers to properly (un)register their own keymaps.
|
|
|
|
def addon_keymap_register(keymap_data):
|
|
"""
|
|
Register a set of keymaps for addons using a list of keymaps.
|
|
|
|
See 'blender_defaults.py' for examples of the format this takes.
|
|
"""
|
|
import bpy
|
|
wm = bpy.context.window_manager
|
|
|
|
from bl_keymap_utils.io import keymap_init_from_data
|
|
|
|
kconf = wm.keyconfigs.addon
|
|
if not kconf:
|
|
return # happens in background mode...
|
|
for km_name, km_args, km_content in keymap_data:
|
|
km_space_type = km_args["space_type"]
|
|
km_region_type = km_args["region_type"]
|
|
km_modal = km_args.get("modal", False)
|
|
kmap = next(iter(
|
|
k for k in kconf.keymaps
|
|
if k.name == km_name and
|
|
k.region_type == km_region_type and
|
|
k.space_type == km_space_type and
|
|
k.is_modal == km_modal
|
|
), None)
|
|
if kmap is None:
|
|
kmap = kconf.keymaps.new(km_name, **km_args)
|
|
keymap_init_from_data(kmap, km_content["items"], is_modal=km_modal)
|
|
|
|
|
|
def addon_keymap_unregister(keymap_data):
|
|
"""
|
|
Unregister a set of keymaps for addons.
|
|
"""
|
|
# NOTE: We must also clean up user keyconfig, else, if user has customized one of add-on's shortcut, this
|
|
# customization remains in memory, and comes back when re-enabling the addon, causing a segfault... :/
|
|
import bpy
|
|
wm = bpy.context.window_manager
|
|
|
|
kconfs = wm.keyconfigs
|
|
for kconf in (kconfs.user, kconfs.addon):
|
|
for km_name, km_args, km_content in keymap_data:
|
|
km_space_type = km_args["space_type"]
|
|
km_region_type = km_args["region_type"]
|
|
km_modal = km_args.get("modal", False)
|
|
kmaps = (
|
|
k for k in kconf.keymaps
|
|
if k.name == km_name and
|
|
k.region_type == km_region_type and
|
|
k.space_type == km_space_type and
|
|
k.is_modal == km_modal
|
|
)
|
|
for kmap in kmaps:
|
|
for kmi_idname, _, _ in km_content["items"]:
|
|
for kmi in kmap.keymap_items:
|
|
if kmi.idname == kmi_idname:
|
|
kmap.keymap_items.remove(kmi)
|
|
# NOTE: We won't remove addons keymaps themselves, other addons might also use them!
|
|
|
|
|
|
# -----------------------------------------------------------------------------
|
|
# Utility Functions
|
|
|
|
def keyconfig_test(kc):
|
|
|
|
def testEntry(kc, entry, src=None, parent=None):
|
|
result = False
|
|
|
|
idname, spaceid, regionid, children = entry
|
|
|
|
km = kc.keymaps.find(idname, space_type=spaceid, region_type=regionid)
|
|
|
|
if km:
|
|
km = km.active()
|
|
is_modal = km.is_modal
|
|
|
|
if src:
|
|
for item in km.keymap_items:
|
|
if src.compare(item):
|
|
print("===========")
|
|
print(parent.name)
|
|
print(_kmistr(src, is_modal).strip())
|
|
print(km.name)
|
|
print(_kmistr(item, is_modal).strip())
|
|
result = True
|
|
|
|
for child in children:
|
|
if testEntry(kc, child, src, parent):
|
|
result = True
|
|
else:
|
|
for i, src in enumerate(km.keymap_items):
|
|
for child in children:
|
|
if testEntry(kc, child, src, km):
|
|
result = True
|
|
|
|
for j in range(len(km.keymap_items) - i - 1):
|
|
item = km.keymap_items[j + i + 1]
|
|
if src.compare(item):
|
|
print("===========")
|
|
print(km.name)
|
|
print(_kmistr(src, is_modal).strip())
|
|
print(_kmistr(item, is_modal).strip())
|
|
result = True
|
|
|
|
for child in children:
|
|
if testEntry(kc, child):
|
|
result = True
|
|
|
|
return result
|
|
|
|
# -------------------------------------------------------------------------
|
|
# Function body
|
|
|
|
from bl_keymap_utils import keymap_hierarchy
|
|
result = False
|
|
for entry in keymap_hierarchy.generate():
|
|
if testEntry(kc, entry):
|
|
result = True
|
|
return result
|