#include <cstring>
#include <fmt/format.h>
#include "DNA_object_types.h"
#include "DNA_screen_types.h"
#include "DNA_space_types.h"
#include "DNA_userdef_types.h"
#include "DNA_windowmanager_types.h"
#include "DNA_workspace_types.h"
#include "CLG_log.h"
#include "MEM_guardedalloc.h"
#include "BLI_blenlib.h"
#include "BLI_string_utils.hh"
#include "BLI_utildefines.h"
#include "BLF_api.hh"
#include "UI_interface.hh"
#include "BKE_context.hh"
#include "BKE_global.hh"
#include "BKE_idprop.hh"
#include "BKE_main.hh"
#include "BKE_screen.hh"
#include "BKE_workspace.hh"
#include "BLT_translation.hh"
#include "RNA_access.hh"
#include "RNA_enum_types.hh"
#include "WM_api.hh"
#include "WM_types.hh"
#include "wm_event_system.hh"
#include "wm_event_types.hh"
#include "ED_screen.hh"

Classes
struct	wmKeyMapItemFind_Params

Functions
Keymap Item
Item in a keymap, that maps from an event to an operator or modal map item.
static wmKeyMapItem *	wm_keymap_item_copy (wmKeyMapItem *kmi)

static void	wm_keymap_item_free_data (wmKeyMapItem *kmi)

static void	wm_keymap_item_clear_runtime (wmKeyMapItem *kmi)

static void	wm_keymap_item_properties_set (wmKeyMapItem *kmi)

static void	wm_keymap_item_properties_update_ot (wmKeyMapItem *kmi, const bool keep_properties)

static void	wm_keymap_item_properties_update_ot_from_list (ListBase *km_lb, const bool keep_properties)

static bool	wm_keymap_item_equals_result (wmKeyMapItem a, wmKeyMapItem b)

static bool	wm_keymap_item_equals (wmKeyMapItem a, wmKeyMapItem b)

void	WM_keymap_item_properties_reset (wmKeyMapItem kmi, IDProperty properties)

int	WM_keymap_item_map_type_get (const wmKeyMapItem *kmi)

Keymap Diff Item
Item in a diff keymap, used for saving diff of keymaps in user preferences.
static wmKeyMapDiffItem *	wm_keymap_diff_item_copy (wmKeyMapDiffItem *kmdi)

static void	wm_keymap_diff_item_free (wmKeyMapDiffItem *kmdi)

Key Configuration
List of keymaps for all editors, modes, etc. There is a builtin default key configuration, a user key configuration, and other preset configurations.
wmKeyConfig *	WM_keyconfig_new (wmWindowManager wm, const char idname, bool user_defined)

wmKeyConfig *	WM_keyconfig_ensure (wmWindowManager wm, const char idname, bool user_defined)

void	WM_keyconfig_remove (wmWindowManager wm, wmKeyConfig keyconf)

void	WM_keyconfig_clear (wmKeyConfig *keyconf)

void	WM_keyconfig_free (wmKeyConfig *keyconf)

static wmKeyConfig *	WM_keyconfig_active (wmWindowManager *wm)

void	WM_keyconfig_set_active (wmWindowManager wm, const char idname)

Keymap
List of keymap items for one editor, mode, modal operator.
static wmKeyMap *	wm_keymap_new (const char *idname, int spaceid, int regionid)

static wmKeyMap *	wm_keymap_copy (wmKeyMap *keymap)

void	WM_keymap_clear (wmKeyMap *keymap)

void	WM_keymap_remove (wmKeyConfig keyconf, wmKeyMap keymap)

bool	WM_keymap_poll (bContext C, wmKeyMap keymap)

static void	keymap_event_set (wmKeyMapItem kmi, const KeyMapItem_Params params)

static void	keymap_item_set_id (wmKeyMap keymap, wmKeyMapItem kmi)

wmKeyMapItem *	WM_keymap_add_item (wmKeyMap keymap, const char idname, const KeyMapItem_Params *params)

wmKeyMapItem *	WM_keymap_add_item_copy (wmKeyMap keymap, wmKeyMapItem kmi_src)

void	WM_keymap_remove_item (wmKeyMap keymap, wmKeyMapItem kmi)

Keymap Diff and Patch
Rather than saving the entire keymap for user preferences, we only save a diff so that changes in the defaults get synced. This system is not perfect but works better than overriding the keymap entirely when only few items are changed.
static void	wm_keymap_addon_add (wmKeyMap keymap, wmKeyMap addonmap)

static wmKeyMapItem *	wm_keymap_find_item_equals (wmKeyMap km, wmKeyMapItem needle)

static wmKeyMapItem *	wm_keymap_find_item_equals_result (wmKeyMap km, wmKeyMapItem needle)

static void	wm_keymap_diff (wmKeyMap diff_km, wmKeyMap from_km, wmKeyMap to_km, wmKeyMap orig_km, wmKeyMap *addon_km)

static void	wm_keymap_patch (wmKeyMap km, wmKeyMap diff_km)

static wmKeyMap *	wm_keymap_patch_update (ListBase lb, wmKeyMap defaultmap, wmKeyMap addonmap, wmKeyMap usermap)

static void	wm_keymap_diff_update (ListBase lb, wmKeyMap defaultmap, wmKeyMap addonmap, wmKeyMap km)

Storage in WM
Name id's are for storing general or multiple keymaps. Space/region ids are same as `DNA_space_types.h`. Gets freed in `wm.cc`.
wmKeyMap *	WM_keymap_list_find (ListBase lb, const char idname, int spaceid, int regionid)

wmKeyMap *	WM_keymap_list_find_spaceid_or_empty (ListBase lb, const char idname, int spaceid, int regionid)

wmKeyMap *	WM_keymap_ensure (wmKeyConfig keyconf, const char idname, int spaceid, int regionid)

wmKeyMap *	WM_keymap_find_all (wmWindowManager wm, const char idname, int spaceid, int regionid)

wmKeyMap *	WM_keymap_find_all_spaceid_or_empty (wmWindowManager wm, const char idname, int spaceid, int regionid)

Modal Keymaps
Modal key-maps get linked to a running operator, and filter the keys before sending to wmOperatorType.modal callback.
wmKeyMap *	WM_modalkeymap_ensure (wmKeyConfig keyconf, const char idname, const EnumPropertyItem *items)

wmKeyMap *	WM_modalkeymap_find (wmKeyConfig keyconf, const char idname)

wmKeyMapItem *	WM_modalkeymap_add_item (wmKeyMap km, const KeyMapItem_Params params, int value)

wmKeyMapItem *	WM_modalkeymap_add_item_str (wmKeyMap km, const KeyMapItem_Params params, const char *value)

static const wmKeyMapItem *	wm_modalkeymap_find_propvalue_iter (const wmKeyMap km, const wmKeyMapItem kmi, const int propvalue)

const wmKeyMapItem *	WM_modalkeymap_find_propvalue (const wmKeyMap *km, const int propvalue)

void	WM_modalkeymap_assign (wmKeyMap km, const char opname)

static void	wm_user_modal_keymap_set_items (wmWindowManager wm, wmKeyMap km)

Text from Key Events
static const char *	key_event_glyph_or_text (const int font_id, const char text, const char single_glyph)

const char *	WM_key_event_string (const short type, const bool compact)

std::optional< std::string >	WM_keymap_item_raw_to_string (const short shift, const short ctrl, const short alt, const short oskey, const short keymodifier, const short val, const short type, const bool compact)

std::optional< std::string >	WM_keymap_item_to_string (const wmKeyMapItem *kmi, const bool compact)

std::optional< std::string >	WM_modalkeymap_items_to_string (const wmKeyMap *km, const int propvalue, const bool compact)

std::optional< std::string >	WM_modalkeymap_operator_items_to_string (wmOperatorType *ot, const int propvalue, const bool compact)

Keymap Finding Utilities
static wmKeyMapItem *	wm_keymap_item_find_in_keymap (wmKeyMap keymap, const char opname, IDProperty properties, const bool is_strict, const wmKeyMapItemFind_Params params)

static wmKeyMapItem *	wm_keymap_item_find_handlers (const bContext C, wmWindowManager wm, wmWindow win, ListBase handlers, const char opname, wmOperatorCallContext, IDProperty properties, const bool is_strict, const wmKeyMapItemFind_Params params, wmKeyMap *r_keymap)

static wmKeyMapItem *	wm_keymap_item_find_props (const bContext C, const char opname, wmOperatorCallContext opcontext, IDProperty properties, const bool is_strict, const wmKeyMapItemFind_Params params, wmKeyMap **r_keymap)

static wmKeyMapItem *	wm_keymap_item_find (const bContext C, const char opname, wmOperatorCallContext opcontext, IDProperty properties, bool is_strict, const wmKeyMapItemFind_Params params, wmKeyMap **r_keymap)

static bool	kmi_filter_is_visible (const wmKeyMap , const wmKeyMapItem kmi, void *)

std::optional< std::string >	WM_key_event_operator_string (const bContext C, const char opname, wmOperatorCallContext opcontext, IDProperty *properties, const bool is_strict)

static bool	kmi_filter_is_visible_type_mask (const wmKeyMap km, const wmKeyMapItem kmi, void *user_data)

wmKeyMapItem *	WM_key_event_operator (const bContext C, const char opname, wmOperatorCallContext opcontext, IDProperty properties, const short include_mask, const short exclude_mask, wmKeyMap *r_keymap)

wmKeyMapItem *	WM_key_event_operator_from_keymap (wmKeyMap keymap, const char opname, IDProperty *properties, const short include_mask, const short exclude_mask)

bool	WM_keymap_item_compare (const wmKeyMapItem k1, const wmKeyMapItem k2)

Event Handling
Handlers have pointers to the keymap in the default configuration. During event handling this function is called to get the keymap from the final configuration.
wmKeyMap *	WM_keymap_active (const wmWindowManager wm, wmKeyMap keymap)

Keymap Editor
In the keymap editor the user key configuration is edited.
void	WM_keymap_item_restore_to_default (wmWindowManager wm, wmKeyMap keymap, wmKeyMapItem *kmi)

void	WM_keymap_restore_to_default (wmKeyMap keymap, wmWindowManager wm)

wmKeyMapItem *	WM_keymap_item_find_id (wmKeyMap *keymap, int id)

const char *	WM_bool_as_string (bool test)

Update Final Configuration
On load or other changes, the final user key configuration is rebuilt from the preset, add-on and user preferences keymaps. We also test if the final configuration changed and write the changes to the user preferences.
enum	{ WM_KEYMAP_UPDATE_RECONFIGURE = (1 << 0) , WM_KEYMAP_UPDATE_OPERATORTYPE = (1 << 1) , WM_KEYMAP_UPDATE_POSTPONE = (1 << 2) }

static char	wm_keymap_update_flag = 0

static char	wm_keymap_update_suppress_flag = 0

static int8_t	wm_keymap_update_suppress_count = 0

void	WM_keyconfig_update_tag (wmKeyMap keymap, wmKeyMapItem kmi)

void	WM_keyconfig_update_operatortype ()

void	WM_keyconfig_update_suppress_begin ()

void	WM_keyconfig_update_suppress_end ()

void	WM_keyconfig_update_postpone_begin ()

void	WM_keyconfig_update_postpone_end ()

static bool	wm_keymap_test_and_clear_update (wmKeyMap *km)

static wmKeyMap *	wm_keymap_preset (wmWindowManager wm, wmKeyMap km)

void	WM_keyconfig_update (wmWindowManager *wm)

void	WM_keyconfig_update_ex (wmWindowManager *wm, bool keep_properties)

Detailed Description

Configurable key-maps - add/remove/find/compare/patch...

Definition in file wm_keymap.cc.

Enumeration Type Documentation

◆ anonymous enum

anonymous enum

Enumerator
WM_KEYMAP_UPDATE_RECONFIGURE
WM_KEYMAP_UPDATE_OPERATORTYPE
WM_KEYMAP_UPDATE_POSTPONE

Definition at line 1758 of file wm_keymap.cc.

Function Documentation

◆ key_event_glyph_or_text()

static const char * key_event_glyph_or_text	(	const int	font_id,
		const char *	text,
		const char *	single_glyph )

static

Definition at line 1088 of file wm_keymap.cc.

References BLF_has_glyph(), BLI_assert, BLI_str_utf8_as_unicode_or_error(), and BLI_strlen_utf8().

Referenced by WM_key_event_string().

◆ keymap_event_set()

static void keymap_event_set	(	wmKeyMapItem *	kmi,
		const KeyMapItem_Params *	params )

static

Definition at line 503 of file wm_keymap.cc.

References wmKeyMapItem::alt, BLI_assert, wmKeyMapItem::ctrl, wmKeyMapItem::direction, wmKeyMapItem::keymodifier, KM_ALT, KM_ALT_ANY, KM_ANY, KM_CTRL, KM_CTRL_ANY, KM_MOD_HELD, KM_NOTHING, KM_OSKEY, KM_OSKEY_ANY, KM_SHIFT, KM_SHIFT_ANY, wmKeyMapItem::oskey, params, wmKeyMapItem::shift, wmKeyMapItem::type, and wmKeyMapItem::val.

Referenced by WM_keymap_add_item(), WM_modalkeymap_add_item(), and WM_modalkeymap_add_item_str().

◆ keymap_item_set_id()

static void keymap_item_set_id	(	wmKeyMap *	keymap,
		wmKeyMapItem *	kmi )

static

Definition at line 535 of file wm_keymap.cc.

References wmKeyMap::flag, wmKeyMapItem::id, KEYMAP_USER, and wmKeyMap::kmi_id.

Referenced by WM_keymap_add_item(), WM_keymap_add_item_copy(), wm_keymap_addon_add(), wm_keymap_patch(), WM_modalkeymap_add_item(), and WM_modalkeymap_add_item_str().

◆ kmi_filter_is_visible()

static bool kmi_filter_is_visible	(	const wmKeyMap *	,
		const wmKeyMapItem *	kmi,
		void *	)

static

Definition at line 1620 of file wm_keymap.cc.

References IS_EVENT_ACTIONZONE, wmKeyMapItem::type, and WM_key_event_string().

Referenced by kmi_filter_is_visible_type_mask(), WM_key_event_operator(), WM_key_event_operator_from_keymap(), and WM_key_event_operator_string().

◆ kmi_filter_is_visible_type_mask()

static bool kmi_filter_is_visible_type_mask	(	const wmKeyMap *	km,
		const wmKeyMapItem *	kmi,
		void *	user_data )

static

Definition at line 1653 of file wm_keymap.cc.

References kmi_filter_is_visible(), wmKeyMapItem::type, and WM_event_type_mask_test().

Referenced by WM_key_event_operator(), and WM_key_event_operator_from_keymap().

◆ WM_bool_as_string()

const char * WM_bool_as_string ( bool test )

Definition at line 2114 of file wm_keymap.cc.

References IFACE_.

Referenced by applyShrinkFatten(), applyVertSlide(), Bend(), point_normals_update_header(), and stitch_update_header().

◆ WM_key_event_operator()

wmKeyMapItem * WM_key_event_operator	(	const bContext *	C,
		const char *	opname,
		wmOperatorCallContext	opcontext,
		IDProperty *	properties,
		short	include_mask,
		short	exclude_mask,
		wmKeyMap **	r_keymap )

Parameters

include_mask,exclude_mask Event types to include/exclude when looking up keys (eEventType_Mask).

Definition at line 1663 of file wm_keymap.cc.

References EVT_TYPE_MASK_ALL, kmi_filter_is_visible(), kmi_filter_is_visible_type_mask(), params, and wm_keymap_item_find().

Referenced by menu_change_shortcut(), remove_shortcut_func(), and ui_popup_context_menu_for_button().

◆ WM_key_event_operator_from_keymap()

wmKeyMapItem * WM_key_event_operator_from_keymap	(	wmKeyMap *	keymap,
		const char *	opname,
		IDProperty *	properties,
		const short	include_mask,
		const short	exclude_mask )

Definition at line 1679 of file wm_keymap.cc.

References EVT_TYPE_MASK_ALL, kmi_filter_is_visible(), kmi_filter_is_visible_type_mask(), params, and wm_keymap_item_find_in_keymap().

◆ WM_key_event_operator_string()

std::optional< std::string > WM_key_event_operator_string	(	const bContext *	C,
		const char *	opname,
		wmOperatorCallContext	opcontext,
		IDProperty *	properties,
		const bool	is_strict )

Definition at line 1628 of file wm_keymap.cc.

References kmi_filter_is_visible(), params, result, UI_key_event_operator_string(), wm_keymap_item_find(), and WM_keymap_item_to_string().

Referenced by but_shortcut_name_func(), operator_search_update_fn(), ui_but_event_operator_string_from_menu(), ui_but_event_operator_string_from_operator(), ui_but_event_operator_string_from_panel(), ui_but_event_property_operator_string(), ui_tooltip_data_from_gizmo(), ui_tooltip_data_from_tool(), and uiItemMenuEnumFullO_ptr().

◆ WM_key_event_string()

const char * WM_key_event_string	(	const short	type,
		const bool	compact )

Definition at line 1098 of file wm_keymap.cc.

References BLF_default(), BLI_STR_UTF8_BLACK_DIAMOND_MINUS_WHITE_X, BLI_STR_UTF8_BROKEN_CIRCLE_WITH_NORTHWEST_ARROW, BLI_STR_UTF8_DOWNWARDS_ARROW, BLI_STR_UTF8_ERASE_TO_THE_LEFT, BLI_STR_UTF8_HORIZONTAL_TAB_KEY, BLI_STR_UTF8_LEFTWARDS_ARROW, BLI_STR_UTF8_OPEN_BOX, BLI_STR_UTF8_OPTION_KEY, BLI_STR_UTF8_PLACE_OF_INTEREST_SIGN, BLI_STR_UTF8_RETURN_SYMBOL, BLI_STR_UTF8_RIGHTWARDS_ARROW, BLI_STR_UTF8_UP_ARROWHEAD, BLI_STR_UTF8_UPWARDS_ARROW, BLI_STR_UTF8_UPWARDS_WHITE_ARROW, BLT_I18NCONTEXT_ID_WINDOWMANAGER, BLT_I18NCONTEXT_UI_EVENTS, CTX_IFACE_, CTX_N_, EVT_BACKSPACEKEY, EVT_DOWNARROWKEY, EVT_ESCKEY, EVT_LEFTALTKEY, EVT_LEFTARROWKEY, EVT_LEFTCTRLKEY, EVT_LEFTSHIFTKEY, EVT_OSKEY, EVT_RETKEY, EVT_RIGHTALTKEY, EVT_RIGHTARROWKEY, EVT_RIGHTCTRLKEY, EVT_RIGHTSHIFTKEY, EVT_SPACEKEY, EVT_TABKEY, EVT_UPARROWKEY, IFACE_, key_event_glyph_or_text(), rna_enum_event_type_items, and RNA_enum_from_value().

Referenced by kmi_filter_is_visible(), ui_but_update_ex(), ui_do_but_HOTKEYEVT(), ui_do_but_KEYEVT(), uiTemplateEventFromKeymapItem(), and WM_keymap_item_raw_to_string().

◆ WM_keyconfig_active()

static wmKeyConfig * WM_keyconfig_active ( wmWindowManager * wm )

static

Definition at line 366 of file wm_keymap.cc.

References BLI_findstring(), wmWindowManager::defaultconf, wmWindowManager::keyconfigs, and offsetof.

Referenced by wm_keymap_preset().

◆ WM_keyconfig_clear()

void WM_keyconfig_clear ( wmKeyConfig * keyconf )

Definition at line 350 of file wm_keymap.cc.

References BLI_listbase_clear(), wmKeyConfig::keymaps, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), and WM_keymap_clear().

Referenced by WM_keyconfig_ensure(), and WM_keyconfig_free().

◆ WM_keyconfig_ensure()

wmKeyConfig * WM_keyconfig_ensure	(	wmWindowManager *	wm,
		const char *	idname,
		bool	user_defined )

Definition at line 305 of file wm_keymap.cc.

References BLI_findstring(), wmWindowManager::defaultconf, wmWindowManager::keyconfigs, wmKeyConfig::keymaps, LISTBASE_FOREACH, offsetof, WM_keyconfig_clear(), WM_keyconfig_new(), and WM_keymap_clear().

◆ WM_keyconfig_free()

void WM_keyconfig_free ( wmKeyConfig * keyconf )

Definition at line 360 of file wm_keymap.cc.

References MEM_freeN(), and WM_keyconfig_clear().

Referenced by wm_close_and_free(), and WM_keyconfig_remove().

◆ WM_keyconfig_new()

wmKeyConfig * WM_keyconfig_new	(	wmWindowManager *	wm,
		const char *	idname,
		bool	user_defined )

Definition at line 289 of file wm_keymap.cc.

References BLI_addtail(), BLI_assert, BLI_findstring(), wmKeyConfig::flag, wmKeyConfig::idname, KEYCONF_USER, wmWindowManager::keyconfigs, MEM_callocN, offsetof, and STRNCPY_UTF8.

Referenced by WM_keyconfig_ensure(), and WM_keyconfig_init().

◆ WM_keyconfig_remove()

void WM_keyconfig_remove	(	wmWindowManager *	wm,
		wmKeyConfig *	keyconf )

Definition at line 328 of file wm_keymap.cc.

References ARRAY_SIZE, BLI_assert, BLI_findindex(), BLI_remlink(), wmWindowManager::defaultconf, wmKeyConfig::idname, wmWindowManager::keyconfigs, STREQLEN, STRNCPY, WM_KEYCONFIG_ARRAY_P, WM_keyconfig_free(), and WM_keyconfig_update_tag().

◆ WM_keyconfig_set_active()

void WM_keyconfig_set_active	(	wmWindowManager *	wm,
		const char *	idname )

Definition at line 381 of file wm_keymap.cc.

References wmWindowManager::init_flag, STRNCPY, WM_INIT_FLAG_KEYCONFIG, WM_keyconfig_update(), and WM_keyconfig_update_tag().

◆ WM_keyconfig_update()

void WM_keyconfig_update ( wmWindowManager * wm )

Definition at line 1853 of file wm_keymap.cc.

References WM_keyconfig_update_ex().

Referenced by menu_add_shortcut(), wm_event_do_handlers(), wm_homefile_write_exec(), WM_init(), WM_keyconfig_set_active(), WM_keyconfig_update_ex(), WM_keymap_restore_to_default(), and wm_userpref_write_exec().

◆ WM_keyconfig_update_ex()

void WM_keyconfig_update_ex	(	wmWindowManager *	wm,
		bool	keep_properties )

Parameters

keep_properties When true, the properties for operators which cannot be found are kept. This is needed for operator reloading that validates key-map items for operators that may have their operators loaded back in the future, see: #113309.

Definition at line 1858 of file wm_keymap.cc.

References wmWindowManager::addonconf, BLI_assert, wmWindowManager::defaultconf, ED_area_tag_redraw(), wmKeyMap::flag, wmWindowManager::keyconfigs, KEYMAP_DIFF, KEYMAP_MODAL, wmKeyConfig::keymaps, LISTBASE_FOREACH, wmKeyMap::modal_items, wmKeyMap::poll, wmKeyMap::poll_modal_item, SPACE_USERPREF, USER_SECTION_KEYMAP, wmWindowManager::userconf, wmWindowManager::windows, WM_dropbox_update_ot(), WM_keyconfig_update(), WM_keyconfig_update_tag(), wm_keymap_diff_update(), wm_keymap_item_properties_set(), wm_keymap_item_properties_update_ot_from_list(), WM_keymap_list_find(), wm_keymap_patch_update(), wm_keymap_preset(), wm_keymap_test_and_clear_update(), wm_keymap_update_flag, WM_KEYMAP_UPDATE_OPERATORTYPE, WM_KEYMAP_UPDATE_POSTPONE, WM_KEYMAP_UPDATE_RECONFIGURE, wm_user_modal_keymap_set_items(), and WM_window_get_active_screen().

Referenced by WM_keyconfig_update().

◆ WM_keyconfig_update_operatortype()

void WM_keyconfig_update_operatortype ( )

Definition at line 1787 of file wm_keymap.cc.

References wm_keymap_update_flag, and WM_KEYMAP_UPDATE_OPERATORTYPE.

Referenced by WM_operatortype_remove_ptr().

◆ WM_keyconfig_update_postpone_begin()

void WM_keyconfig_update_postpone_begin ( )

Definition at line 1819 of file wm_keymap.cc.

References wm_keymap_update_flag, and WM_KEYMAP_UPDATE_POSTPONE.

Referenced by WM_init().

◆ WM_keyconfig_update_postpone_end()

void WM_keyconfig_update_postpone_end ( )

Definition at line 1824 of file wm_keymap.cc.

References wm_keymap_update_flag.

Referenced by WM_init().

◆ WM_keyconfig_update_suppress_begin()

void WM_keyconfig_update_suppress_begin ( )

Definition at line 1800 of file wm_keymap.cc.

References BLI_assert, wm_keymap_update_flag, wm_keymap_update_suppress_count, and wm_keymap_update_suppress_flag.

Referenced by ViewOpsData_Utility::ViewOpsData_Utility(), and ViewOpsData_Utility::~ViewOpsData_Utility().

◆ WM_keyconfig_update_suppress_end()

void WM_keyconfig_update_suppress_end ( )

Definition at line 1809 of file wm_keymap.cc.

References BLI_assert, wm_keymap_update_flag, wm_keymap_update_suppress_count, and wm_keymap_update_suppress_flag.

Referenced by ViewOpsData_Utility::ViewOpsData_Utility(), and ViewOpsData_Utility::~ViewOpsData_Utility().

◆ WM_keyconfig_update_tag()

void WM_keyconfig_update_tag	(	wmKeyMap *	keymap,
		wmKeyMapItem *	kmi )

◆ WM_keymap_active()

wmKeyMap * WM_keymap_active	(	const wmWindowManager *	wm,
		wmKeyMap *	keymap )

Definition at line 2003 of file wm_keymap.cc.

References wmKeyMap::idname, wmKeyConfig::keymaps, wmKeyMap::regionid, wmKeyMap::spaceid, wmWindowManager::userconf, and WM_keymap_list_find().

Referenced by initTransform(), initTransInfo(), WorkspaceStatus::opmodal(), v3d_cursor_is_snap_invert(), WM_event_get_keymaps_from_handler(), wm_event_modalkeymap_begin(), wm_gizmo_keymap_uses_event_modifier(), wm_handlers_do_gizmo_handler(), WM_modalkeymap_operator_items_to_string(), and WM_window_modal_keymap_status_draw().

◆ WM_keymap_add_item()

wmKeyMapItem * WM_keymap_add_item	(	wmKeyMap *	keymap,
		const char *	idname,
		const KeyMapItem_Params *	params )

Always add item.

Definition at line 546 of file wm_keymap.cc.

References BLI_addtail(), wmKeyMapItem::idname, wmKeyMap::items, keymap_event_set(), keymap_item_set_id(), MEM_callocN, params, STRNCPY, WM_keyconfig_update_tag(), and wm_keymap_item_properties_set().

Referenced by menu_add_shortcut(), WM_gizmogroup_keymap_template_select_ex(), WM_keymap_add_menu(), WM_keymap_add_menu_pie(), WM_keymap_add_panel(), and WM_keymap_add_tool().

◆ WM_keymap_add_item_copy()

wmKeyMapItem * WM_keymap_add_item_copy	(	wmKeyMap *	keymap,
		wmKeyMapItem *	kmi_src )

Definition at line 566 of file wm_keymap.cc.

References BLI_addtail(), wmKeyMap::items, keymap_item_set_id(), WM_keyconfig_update_tag(), and wm_keymap_item_copy().

Referenced by ViewOpsData_Utility::ViewOpsData_Utility().

◆ wm_keymap_addon_add()

static void wm_keymap_addon_add	(	wmKeyMap *	keymap,
		wmKeyMap *	addonmap )

static

Definition at line 605 of file wm_keymap.cc.

References BLI_addhead(), wmKeyMap::items, keymap_item_set_id(), LISTBASE_FOREACH, and wm_keymap_item_copy().

Referenced by wm_keymap_diff_update(), WM_keymap_item_restore_to_default(), and wm_keymap_patch_update().

◆ WM_keymap_clear()

void WM_keymap_clear ( wmKeyMap * keymap )

Definition at line 445 of file wm_keymap.cc.

References BLI_listbase_clear(), wmKeyMap::diff_items, wmKeyMap::items, LISTBASE_FOREACH_MUTABLE, MEM_freeN(), wm_keymap_diff_item_free(), and wm_keymap_item_free_data().

Referenced by WM_keyconfig_clear(), WM_keyconfig_ensure(), wm_keymap_diff_update(), WM_keymap_item_restore_to_default(), wm_keymap_patch_update(), WM_keymap_remove(), WM_keymap_restore_to_default(), and ViewOpsData_Utility::~ViewOpsData_Utility().

◆ wm_keymap_copy()

static wmKeyMap * wm_keymap_copy ( wmKeyMap * keymap )

static

Definition at line 422 of file wm_keymap.cc.

References BLI_addtail(), BLI_listbase_clear(), wmKeyMap::diff_items, wmKeyMap::flag, wmKeyMap::items, KEYMAP_EXPANDED, KEYMAP_UPDATE, LISTBASE_FOREACH, MEM_dupallocN, wmKeyMap::modal_items, wmKeyMap::poll, wmKeyMap::poll_modal_item, wm_keymap_diff_item_copy(), and wm_keymap_item_copy().

Referenced by wm_keymap_diff_update(), WM_keymap_item_restore_to_default(), and wm_keymap_patch_update().

◆ wm_keymap_diff()

static void wm_keymap_diff	(	wmKeyMap *	diff_km,
		wmKeyMap *	from_km,
		wmKeyMap *	to_km,
		wmKeyMap *	orig_km,
		wmKeyMap *	addon_km )

static

Definition at line 636 of file wm_keymap.cc.

References wmKeyMapDiffItem::add_item, BLI_addtail(), wmKeyMap::diff_items, wmKeyMapItem::flag, wmKeyMap::items, KMI_EXPANDED, LISTBASE_FOREACH, MEM_callocN, wmKeyMapDiffItem::remove_item, wm_keymap_find_item_equals(), wm_keymap_item_copy(), wm_keymap_item_equals(), and WM_keymap_item_find_id().

Referenced by wm_keymap_diff_update().

◆ wm_keymap_diff_item_copy()

static wmKeyMapDiffItem * wm_keymap_diff_item_copy ( wmKeyMapDiffItem * kmdi )

static

Definition at line 252 of file wm_keymap.cc.

References wmKeyMapDiffItem::add_item, MEM_dupallocN, wmKeyMapDiffItem::next, wmKeyMapDiffItem::prev, wmKeyMapDiffItem::remove_item, and wm_keymap_item_copy().

Referenced by wm_keymap_copy().

◆ wm_keymap_diff_item_free()

static void wm_keymap_diff_item_free ( wmKeyMapDiffItem * kmdi )

static

Definition at line 267 of file wm_keymap.cc.

References wmKeyMapDiffItem::add_item, MEM_freeN(), wmKeyMapDiffItem::remove_item, and wm_keymap_item_free_data().

Referenced by WM_keymap_clear().

◆ wm_keymap_diff_update()

static void wm_keymap_diff_update	(	ListBase *	lb,
		wmKeyMap *	defaultmap,
		wmKeyMap *	addonmap,
		wmKeyMap *	km )

static

Definition at line 813 of file wm_keymap.cc.

References BLI_addtail(), BLI_freelinkN(), wmKeyMap::diff_items, ListBase::first, wmKeyMap::flag, wmKeyMap::idname, KEYMAP_DIFF, KEYMAP_MODAL, MEM_freeN(), wmKeyMap::regionid, wmKeyMap::spaceid, wm_keymap_addon_add(), WM_keymap_clear(), wm_keymap_copy(), wm_keymap_diff(), WM_keymap_list_find(), and wm_keymap_new().

Referenced by WM_keyconfig_update_ex().

◆ WM_keymap_ensure()

wmKeyMap * WM_keymap_ensure	(	wmKeyConfig *	keyconf,
		const char *	idname,
		int	spaceid,
		int	regionid )

Definition at line 897 of file wm_keymap.cc.

References BLI_addtail(), wmKeyConfig::keymaps, WM_keyconfig_update_tag(), WM_keymap_list_find(), and wm_keymap_new().

◆ WM_keymap_find_all()

wmKeyMap * WM_keymap_find_all	(	wmWindowManager *	wm,
		const char *	idname,
		int	spaceid,
		int	regionid )

Definition at line 911 of file wm_keymap.cc.

References wmKeyConfig::keymaps, wmWindowManager::userconf, and WM_keymap_list_find().

Referenced by ViewOpsData_Utility::ViewOpsData_Utility(), WM_keymap_guess_from_context(), and WM_keymap_guess_opname().

◆ WM_keymap_find_all_spaceid_or_empty()

wmKeyMap * WM_keymap_find_all_spaceid_or_empty	(	wmWindowManager *	wm,
		const char *	idname,
		int	spaceid,
		int	regionid )

Definition at line 916 of file wm_keymap.cc.

References wmKeyConfig::keymaps, wmWindowManager::userconf, and WM_keymap_list_find_spaceid_or_empty().

◆ wm_keymap_find_item_equals()

static wmKeyMapItem * wm_keymap_find_item_equals	(	wmKeyMap *	km,
		wmKeyMapItem *	needle )

static

Definition at line 614 of file wm_keymap.cc.

References wmKeyMap::items, LISTBASE_FOREACH, and wm_keymap_item_equals().

Referenced by wm_keymap_diff(), wm_keymap_patch(), and wm_keymap_patch_update().

◆ wm_keymap_find_item_equals_result()

static wmKeyMapItem * wm_keymap_find_item_equals_result	(	wmKeyMap *	km,
		wmKeyMapItem *	needle )

static

Definition at line 625 of file wm_keymap.cc.

References wmKeyMap::items, LISTBASE_FOREACH, and wm_keymap_item_equals_result().

Referenced by wm_keymap_patch(), and wm_keymap_patch_update().

◆ wm_keymap_item_clear_runtime()

static void wm_keymap_item_clear_runtime ( wmKeyMapItem * kmi )

static

Definition at line 102 of file wm_keymap.cc.

References PointerRNA::data, wmKeyMapItem::properties, wmKeyMapItem::ptr, and wm_keymap_item_free_data().

Referenced by wm_keymap_item_properties_update_ot().

◆ WM_keymap_item_compare()

bool WM_keymap_item_compare	(	const wmKeyMapItem *	k1,
		const wmKeyMapItem *	k2 )

Definition at line 1694 of file wm_keymap.cc.

References wmKeyMapItem::alt, wmKeyMapItem::ctrl, wmKeyMapItem::direction, ELEM, wmKeyMapItem::flag, wmKeyMapItem::keymodifier, KM_ANY, KM_CLICK, KM_CLICK_DRAG, KM_PRESS, KM_RELEASE, KMI_INACTIVE, wmKeyMapItem::oskey, wmKeyMapItem::shift, wmKeyMapItem::type, wmKeyMapItem::val, and WM_userdef_event_map().

◆ wm_keymap_item_copy()

static wmKeyMapItem * wm_keymap_item_copy ( wmKeyMapItem * kmi )

static

Definition at line 62 of file wm_keymap.cc.

References PointerRNA::data, wmKeyMapItem::flag, wmKeyMapItem::idname, IDP_CopyProperty(), MEM_dupallocN, wmKeyMapItem::next, PointerRNA::owner_id, wmKeyMapItem::prev, wmKeyMapItem::properties, wmKeyMapItem::ptr, and WM_operator_properties_create().

Referenced by WM_keymap_add_item_copy(), wm_keymap_addon_add(), wm_keymap_copy(), wm_keymap_diff(), wm_keymap_diff_item_copy(), and wm_keymap_patch().

◆ wm_keymap_item_equals()

static bool wm_keymap_item_equals	(	wmKeyMapItem *	a,
		wmKeyMapItem *	b )

static

Definition at line 194 of file wm_keymap.cc.

References b, ISKEYBOARD, KM_CLICK_DRAG, KMI_REPEAT_IGNORE, and wm_keymap_item_equals_result().

Referenced by wm_keymap_diff(), and wm_keymap_find_item_equals().

◆ wm_keymap_item_equals_result()

static bool wm_keymap_item_equals_result	(	wmKeyMapItem *	a,
		wmKeyMapItem *	b )

static

Definition at line 186 of file wm_keymap.cc.

References b, G_MAIN, KMI_INACTIVE, RNA_EQ_UNSET_MATCH_NONE, RNA_struct_equals(), and STREQ.

Referenced by wm_keymap_find_item_equals_result(), and wm_keymap_item_equals().

◆ wm_keymap_item_find()

static wmKeyMapItem * wm_keymap_item_find	(	const bContext *	C,
		const char *	opname,
		wmOperatorCallContext	opcontext,
		IDProperty *	properties,
		bool	is_strict,
		const wmKeyMapItemFind_Params *	params,
		wmKeyMap **	r_keymap )

static

Definition at line 1532 of file wm_keymap.cc.

References PointerRNA::data, wmOperatorType::flag, G, G_DEBUG_WM, wmKeyMap::idname, IDP_CopyProperty(), IDP_FreeProperty(), IDP_print(), OPTYPE_MACRO, ot, params, printf, wmOperatorType::prop, wmKeyMapItem::ptr, RNA_pointer_create(), RNA_property_is_set(), RNA_property_unset(), wmOperatorType::srna, wm_keymap_item_find_props(), WM_keymap_item_to_string(), WM_operator_properties_default(), and WM_operatortype_find().

Referenced by WM_key_event_operator(), and WM_key_event_operator_string().

◆ wm_keymap_item_find_handlers()

static wmKeyMapItem * wm_keymap_item_find_handlers	(	const bContext *	C,
		wmWindowManager *	wm,
		wmWindow *	win,
		ListBase *	handlers,
		const char *	opname,
		wmOperatorCallContext	,
		IDProperty *	properties,
		const bool	is_strict,
		const wmKeyMapItemFind_Params *	params,
		wmKeyMap **	r_keymap )

static

Definition at line 1380 of file wm_keymap.cc.

References wmEventHandler_KeymapResult::keymaps, wmEventHandler_KeymapResult::keymaps_len, LISTBASE_FOREACH, params, WM_event_get_keymaps_from_handler(), WM_HANDLER_TYPE_KEYMAP, wm_keymap_item_find_in_keymap(), and WM_keymap_poll().

Referenced by wm_keymap_item_find_props().

◆ WM_keymap_item_find_id()

wmKeyMapItem * WM_keymap_item_find_id	(	wmKeyMap *	keymap,
		int	id )

Definition at line 2103 of file wm_keymap.cc.

References wmKeyMap::items, and LISTBASE_FOREACH.

Referenced by menu_add_shortcut(), menu_add_shortcut_cancel(), wm_keymap_diff(), and WM_keymap_item_restore_to_default().

◆ wm_keymap_item_find_in_keymap()

static wmKeyMapItem * wm_keymap_item_find_in_keymap	(	wmKeyMap *	keymap,
		const char *	opname,
		IDProperty *	properties,
		const bool	is_strict,
		const wmKeyMapItemFind_Params *	params )

static

Definition at line 1297 of file wm_keymap.cc.

References G, G_DEBUG_WM, wmKeyMap::idname, IDP_CopyProperty(), IDP_EqualsProperties_ex(), IDP_FreeProperty(), IDP_print(), wmKeyMap::items, KMI_INACTIVE, LISTBASE_FOREACH, ot, params, printf, RNA_pointer_create(), wmOperatorType::srna, STREQ, WM_keymap_item_to_string(), WM_operator_properties_default(), and WM_operatortype_find().

Referenced by WM_key_event_operator_from_keymap(), and wm_keymap_item_find_handlers().

◆ wm_keymap_item_find_props()

static wmKeyMapItem * wm_keymap_item_find_props	(	const bContext *	C,
		const char *	opname,
		wmOperatorCallContext	opcontext,
		IDProperty *	properties,
		const bool	is_strict,
		const wmKeyMapItemFind_Params *	params,
		wmKeyMap **	r_keymap )

static

◆ wm_keymap_item_free_data()

static void wm_keymap_item_free_data ( wmKeyMapItem * kmi )

static

Definition at line 87 of file wm_keymap.cc.

References IDP_FreeProperty(), wmKeyMapItem::properties, wmKeyMapItem::ptr, and WM_operator_properties_free().

Referenced by WM_keymap_clear(), wm_keymap_diff_item_free(), wm_keymap_item_clear_runtime(), wm_keymap_item_properties_update_ot(), and wm_keymap_patch().

◆ WM_keymap_item_map_type_get()

int WM_keymap_item_map_type_get ( const wmKeyMapItem * kmi )

Definition at line 221 of file wm_keymap.cc.

References ELEM, ISKEYBOARD, ISMOUSE, ISNDOF, ISTIMER, KM_TEXTINPUT, KMI_TYPE_KEYBOARD, KMI_TYPE_MOUSE, KMI_TYPE_NDOF, KMI_TYPE_TEXTINPUT, KMI_TYPE_TIMER, TABLET_ERASER, TABLET_STYLUS, and wmKeyMapItem::type.

◆ WM_keymap_item_properties_reset()

void WM_keymap_item_properties_reset	(	wmKeyMapItem *	kmi,
		IDProperty *	properties )

Properties can be NULL, otherwise the arg passed is used and ownership is given to the kmi.

Definition at line 204 of file wm_keymap.cc.

References IDP_FreeProperty(), LIKELY, wmKeyMapItem::properties, wmKeyMapItem::ptr, wm_keymap_item_properties_set(), and WM_operator_properties_free().

Referenced by menu_add_shortcut(), and WM_keymap_item_restore_to_default().

◆ wm_keymap_item_properties_set()

static void wm_keymap_item_properties_set ( wmKeyMapItem * kmi )

static

Definition at line 113 of file wm_keymap.cc.

References wmKeyMapItem::idname, PointerRNA::owner_id, wmKeyMapItem::properties, wmKeyMapItem::ptr, WM_operator_properties_alloc(), and WM_operator_properties_sanitize().

Referenced by WM_keyconfig_update_ex(), WM_keymap_add_item(), WM_keymap_item_properties_reset(), and wm_keymap_item_properties_update_ot().

◆ wm_keymap_item_properties_update_ot()

static void wm_keymap_item_properties_update_ot	(	wmKeyMapItem *	kmi,
		const bool	keep_properties )

static

Similar to wm_keymap_item_properties_set but checks for the wmOperatorType having changed, see #38042.

Definition at line 126 of file wm_keymap.cc.

References BLI_assert, PointerRNA::data, wmKeyMapItem::idname, ot, PointerRNA::owner_id, wmKeyMapItem::properties, wmKeyMapItem::ptr, wmOperatorType::srna, PointerRNA::type, wm_keymap_item_clear_runtime(), wm_keymap_item_free_data(), wm_keymap_item_properties_set(), WM_operator_properties_create_ptr(), WM_operator_properties_sanitize(), and WM_operatortype_find().

Referenced by wm_keymap_item_properties_update_ot_from_list().

◆ wm_keymap_item_properties_update_ot_from_list()

static void wm_keymap_item_properties_update_ot_from_list	(	ListBase *	km_lb,
		const bool	keep_properties )

static

Definition at line 167 of file wm_keymap.cc.

References LISTBASE_FOREACH, and wm_keymap_item_properties_update_ot().

Referenced by WM_keyconfig_update_ex().

◆ WM_keymap_item_raw_to_string()

std::optional< std::string > WM_keymap_item_raw_to_string	(	const short	shift,
		const short	ctrl,
		const short	alt,
		const short	oskey,
		const short	keymodifier,
		const short	val,
		const short	type,
		const bool	compact )

Definition at line 1196 of file wm_keymap.cc.

References blender::Vector< T, InlineBufferCapacity, Allocator >::append(), EVT_LEFTALTKEY, EVT_LEFTCTRLKEY, EVT_LEFTSHIFTKEY, EVT_OSKEY, IFACE_, blender::Vector< T, InlineBufferCapacity, Allocator >::is_empty(), KM_ANY, KM_CLICK_DRAG, KM_DBL_CLICK, blender::Vector< T, InlineBufferCapacity, Allocator >::last(), blender::Vector< T, InlineBufferCapacity, Allocator >::remove_last(), and WM_key_event_string().

Referenced by UI_key_event_operator_string(), and WM_keymap_item_to_string().

◆ WM_keymap_item_restore_to_default()

void WM_keymap_item_restore_to_default	(	wmWindowManager *	wm,
		wmKeyMap *	keymap,
		wmKeyMapItem *	kmi )

◆ WM_keymap_item_to_string()

std::optional< std::string > WM_keymap_item_to_string	(	const wmKeyMapItem *	kmi,
		const bool	compact )

◆ WM_keymap_list_find()

wmKeyMap * WM_keymap_list_find	(	ListBase *	lb,
		const char *	idname,
		int	spaceid,
		int	regionid )

Definition at line 868 of file wm_keymap.cc.

References KMAP_MAX_NAME, LISTBASE_FOREACH, and STREQLEN.

Referenced by WM_keyconfig_update_ex(), WM_keymap_active(), wm_keymap_diff_update(), WM_keymap_ensure(), WM_keymap_find_all(), WM_keymap_item_restore_to_default(), wm_keymap_patch_update(), wm_keymap_preset(), WM_keymap_restore_to_default(), WM_modalkeymap_ensure(), and wm_user_modal_keymap_set_items().

◆ WM_keymap_list_find_spaceid_or_empty()

wmKeyMap * WM_keymap_list_find_spaceid_or_empty	(	ListBase *	lb,
		const char *	idname,
		int	spaceid,
		int	regionid )

Definition at line 881 of file wm_keymap.cc.

References ELEM, KMAP_MAX_NAME, LISTBASE_FOREACH, SPACE_EMPTY, and STREQLEN.

Referenced by wm_event_get_keymap_from_toolsystem_ex(), and WM_keymap_find_all_spaceid_or_empty().

◆ wm_keymap_new()

static wmKeyMap * wm_keymap_new	(	const char *	idname,
		int	spaceid,
		int	regionid )

static

Definition at line 405 of file wm_keymap.cc.

References wmKeyMap::idname, MEM_callocN, wmKeyMap::owner_id, wmKeyMap::regionid, RNA_struct_state_owner_get(), wmKeyMap::spaceid, STRNCPY, and STRNCPY_UTF8.

Referenced by wm_keymap_diff_update(), and WM_keymap_ensure().

◆ wm_keymap_patch()

static void wm_keymap_patch	(	wmKeyMap *	km,
		wmKeyMap *	diff_km )

static

Note: This typically happens when we apply user-defined keymap diff to a base one that was exported with that customized keymap already. In that case:

wm_keymap_find_item_equals(km, kmdi->remove_item) finds nothing (because actual shortcut of current base does not match kmdi->remove_item any more).
wm_keymap_find_item_equals_result(km, kmdi->remove_item) finds the current kmi from base keymap (because it does exactly the same thing).
wm_keymap_find_item_equals(km, kmdi->add_item) finds the same kmi, since base keymap was exported with that user-defined shortcut already!
```
Maybe we should rather keep user-defined keymaps specific to a given base one? 
```

Definition at line 684 of file wm_keymap.cc.

References BLI_addtail(), BLI_freelinkN(), BLI_insertlinkbefore(), wmKeyMap::diff_items, wmKeyMapItem::flag, wmKeyMapItem::id, wmKeyMap::items, keymap_item_set_id(), KMI_EXPANDED, KMI_USER_MODIFIED, LISTBASE_FOREACH, wm_keymap_find_item_equals(), wm_keymap_find_item_equals_result(), wm_keymap_item_copy(), and wm_keymap_item_free_data().