summaryrefslogtreecommitdiff
path: root/packages/frontend/src/utility/key-event.ts
blob: 020a6c2174b65b4e8093b037996ff5cc12b8e875 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*
 * SPDX-FileCopyrightText: syuilo and misskey-project
 * SPDX-License-Identifier: AGPL-3.0-only
 */

/**
 * {@link KeyboardEvent.code} の値を表す文字列。不足分は適宜追加する
 * @see https://developer.mozilla.org/en-US/docs/Web/API/UI_Events/Keyboard_event_code_values
 */
export type KeyCode = (
	| 'Backspace'
	| 'Tab'
	| 'Enter'
	| 'Shift'
	| 'Control'
	| 'Alt'
	| 'Pause'
	| 'CapsLock'
	| 'Escape'
	| 'Space'
	| 'PageUp'
	| 'PageDown'
	| 'End'
	| 'Home'
	| 'ArrowLeft'
	| 'ArrowUp'
	| 'ArrowRight'
	| 'ArrowDown'
	| 'Insert'
	| 'Delete'
	| 'Digit0'
	| 'Digit1'
	| 'Digit2'
	| 'Digit3'
	| 'Digit4'
	| 'Digit5'
	| 'Digit6'
	| 'Digit7'
	| 'Digit8'
	| 'Digit9'
	| 'KeyA'
	| 'KeyB'
	| 'KeyC'
	| 'KeyD'
	| 'KeyE'
	| 'KeyF'
	| 'KeyG'
	| 'KeyH'
	| 'KeyI'
	| 'KeyJ'
	| 'KeyK'
	| 'KeyL'
	| 'KeyM'
	| 'KeyN'
	| 'KeyO'
	| 'KeyP'
	| 'KeyQ'
	| 'KeyR'
	| 'KeyS'
	| 'KeyT'
	| 'KeyU'
	| 'KeyV'
	| 'KeyW'
	| 'KeyX'
	| 'KeyY'
	| 'KeyZ'
	| 'MetaLeft'
	| 'MetaRight'
	| 'ContextMenu'
	| 'F1'
	| 'F2'
	| 'F3'
	| 'F4'
	| 'F5'
	| 'F6'
	| 'F7'
	| 'F8'
	| 'F9'
	| 'F10'
	| 'F11'
	| 'F12'
	| 'NumLock'
	| 'ScrollLock'
	| 'Semicolon'
	| 'Equal'
	| 'Comma'
	| 'Minus'
	| 'Period'
	| 'Slash'
	| 'Backquote'
	| 'BracketLeft'
	| 'Backslash'
	| 'BracketRight'
	| 'Quote'
	| 'Meta'
	| 'AltGraph'
);

/**
 * 修飾キーを表す文字列。不足分は適宜追加する。
 */
export type KeyModifier = (
	| 'Shift'
	| 'Control'
	| 'Alt'
	| 'Meta'
);

/**
 * 押下されたキー以外の状態を表す文字列。不足分は適宜追加する。
 */
export type KeyState = (
	| 'composing'
	| 'repeat'
);

export type KeyEventHandler = {
	modifiers?: KeyModifier[];
	states?: KeyState[];
	code: KeyCode | 'any';
	handler: (event: KeyboardEvent) => void;
};

export function handleKeyEvent(event: KeyboardEvent, handlers: KeyEventHandler[]) {
	function checkModifier(ev: KeyboardEvent, modifiers? : KeyModifier[]) {
		if (modifiers) {
			return modifiers.every(modifier => ev.getModifierState(modifier));
		}
		return true;
	}

	function checkState(ev: KeyboardEvent, states?: KeyState[]) {
		if (states) {
			return states.every(state => ev.getModifierState(state));
		}
		return true;
	}

	let hit = false;
	for (const handler of handlers.filter(it => it.code === event.code)) {
		if (checkModifier(event, handler.modifiers) && checkState(event, handler.states)) {
			handler.handler(event);
			hit = true;
			break;
		}
	}

	if (!hit) {
		for (const handler of handlers.filter(it => it.code === 'any')) {
			handler.handler(event);
		}
	}
}