mirror of
https://github.com/rust-windowing/winit.git
synced 2026-08-29 21:00:04 -04:00
Overhaul the Keyboard API
Overhaul the keyboard API in winit to mimic the W3C specification
to achieve better crossplatform parity. The `KeyboardInput` event
is now uses `KeyEvent` which consists of:
- `physical_key` - a cross platform way to refer to scancodes;
- `logical_key` - keysym value, which shows your key respecting the
layout;
- `text` - the text produced by this keypress;
- `location` - the location of the key on the keyboard;
- `repeat` - whether the key was produced by the repeat.
And also a `platform_specific` field which encapsulates extra
information on desktop platforms, like key without modifiers
and text with all modifiers.
The `Modifiers` were also slightly reworked as in, the information
whether the left or right modifier is pressed is now also exposed
on platforms where it could be queried reliably. The support was
also added for the web and orbital platforms finishing the API
change.
This change made the `OptionAsAlt` API on macOS redundant thus it
was removed all together.
Co-authored-by: Artúr Kovács <kovacs.artur.barnabas@gmail.com>
Co-authored-by: Kirill Chibisov <contact@kchibisov.com>
Co-authored-by: daxpedda <daxpedda@gmail.com>
Fixes: #2631.
Fixes: #2055.
Fixes: #2032.
Fixes: #1904.
Fixes: #1810.
Fixes: #1700.
Fixes: #1443.
Fixes: #1343.
Fixes: #1208.
Fixes: #1151.
Fixes: #812.
Fixes: #600.
Fixes: #361.
Fixes: #343.
This commit is contained in:
Markus Røyset
GitHub
@@ -12,99 +12,102 @@ use orbclient::{
|
||||
use raw_window_handle::{OrbitalDisplayHandle, RawDisplayHandle};
|
||||
|
||||
use crate::{
|
||||
event::{self, StartCause, VirtualKeyCode},
|
||||
event::{self, Ime, Modifiers, StartCause},
|
||||
event_loop::{self, ControlFlow},
|
||||
keyboard::{
|
||||
Key, KeyCode, KeyLocation, ModifiersKeys, ModifiersState, NativeKey, NativeKeyCode,
|
||||
},
|
||||
window::WindowId as RootWindowId,
|
||||
};
|
||||
|
||||
use super::{
|
||||
DeviceId, MonitorHandle, PlatformSpecificEventLoopAttributes, RedoxSocket, TimeSocket,
|
||||
WindowId, WindowProperties,
|
||||
DeviceId, KeyEventExtra, MonitorHandle, PlatformSpecificEventLoopAttributes, RedoxSocket,
|
||||
TimeSocket, WindowId, WindowProperties,
|
||||
};
|
||||
|
||||
fn convert_scancode(scancode: u8) -> Option<VirtualKeyCode> {
|
||||
fn convert_scancode(scancode: u8) -> KeyCode {
|
||||
match scancode {
|
||||
orbclient::K_A => Some(VirtualKeyCode::A),
|
||||
orbclient::K_B => Some(VirtualKeyCode::B),
|
||||
orbclient::K_C => Some(VirtualKeyCode::C),
|
||||
orbclient::K_D => Some(VirtualKeyCode::D),
|
||||
orbclient::K_E => Some(VirtualKeyCode::E),
|
||||
orbclient::K_F => Some(VirtualKeyCode::F),
|
||||
orbclient::K_G => Some(VirtualKeyCode::G),
|
||||
orbclient::K_H => Some(VirtualKeyCode::H),
|
||||
orbclient::K_I => Some(VirtualKeyCode::I),
|
||||
orbclient::K_J => Some(VirtualKeyCode::J),
|
||||
orbclient::K_K => Some(VirtualKeyCode::K),
|
||||
orbclient::K_L => Some(VirtualKeyCode::L),
|
||||
orbclient::K_M => Some(VirtualKeyCode::M),
|
||||
orbclient::K_N => Some(VirtualKeyCode::N),
|
||||
orbclient::K_O => Some(VirtualKeyCode::O),
|
||||
orbclient::K_P => Some(VirtualKeyCode::P),
|
||||
orbclient::K_Q => Some(VirtualKeyCode::Q),
|
||||
orbclient::K_R => Some(VirtualKeyCode::R),
|
||||
orbclient::K_S => Some(VirtualKeyCode::S),
|
||||
orbclient::K_T => Some(VirtualKeyCode::T),
|
||||
orbclient::K_U => Some(VirtualKeyCode::U),
|
||||
orbclient::K_V => Some(VirtualKeyCode::V),
|
||||
orbclient::K_W => Some(VirtualKeyCode::W),
|
||||
orbclient::K_X => Some(VirtualKeyCode::X),
|
||||
orbclient::K_Y => Some(VirtualKeyCode::Y),
|
||||
orbclient::K_Z => Some(VirtualKeyCode::Z),
|
||||
orbclient::K_0 => Some(VirtualKeyCode::Key0),
|
||||
orbclient::K_1 => Some(VirtualKeyCode::Key1),
|
||||
orbclient::K_2 => Some(VirtualKeyCode::Key2),
|
||||
orbclient::K_3 => Some(VirtualKeyCode::Key3),
|
||||
orbclient::K_4 => Some(VirtualKeyCode::Key4),
|
||||
orbclient::K_5 => Some(VirtualKeyCode::Key5),
|
||||
orbclient::K_6 => Some(VirtualKeyCode::Key6),
|
||||
orbclient::K_7 => Some(VirtualKeyCode::Key7),
|
||||
orbclient::K_8 => Some(VirtualKeyCode::Key8),
|
||||
orbclient::K_9 => Some(VirtualKeyCode::Key9),
|
||||
orbclient::K_A => KeyCode::KeyA,
|
||||
orbclient::K_B => KeyCode::KeyB,
|
||||
orbclient::K_C => KeyCode::KeyC,
|
||||
orbclient::K_D => KeyCode::KeyD,
|
||||
orbclient::K_E => KeyCode::KeyE,
|
||||
orbclient::K_F => KeyCode::KeyF,
|
||||
orbclient::K_G => KeyCode::KeyG,
|
||||
orbclient::K_H => KeyCode::KeyH,
|
||||
orbclient::K_I => KeyCode::KeyI,
|
||||
orbclient::K_J => KeyCode::KeyJ,
|
||||
orbclient::K_K => KeyCode::KeyK,
|
||||
orbclient::K_L => KeyCode::KeyL,
|
||||
orbclient::K_M => KeyCode::KeyM,
|
||||
orbclient::K_N => KeyCode::KeyN,
|
||||
orbclient::K_O => KeyCode::KeyO,
|
||||
orbclient::K_P => KeyCode::KeyP,
|
||||
orbclient::K_Q => KeyCode::KeyQ,
|
||||
orbclient::K_R => KeyCode::KeyR,
|
||||
orbclient::K_S => KeyCode::KeyS,
|
||||
orbclient::K_T => KeyCode::KeyT,
|
||||
orbclient::K_U => KeyCode::KeyU,
|
||||
orbclient::K_V => KeyCode::KeyV,
|
||||
orbclient::K_W => KeyCode::KeyW,
|
||||
orbclient::K_X => KeyCode::KeyX,
|
||||
orbclient::K_Y => KeyCode::KeyY,
|
||||
orbclient::K_Z => KeyCode::KeyZ,
|
||||
orbclient::K_0 => KeyCode::Digit0,
|
||||
orbclient::K_1 => KeyCode::Digit1,
|
||||
orbclient::K_2 => KeyCode::Digit2,
|
||||
orbclient::K_3 => KeyCode::Digit3,
|
||||
orbclient::K_4 => KeyCode::Digit4,
|
||||
orbclient::K_5 => KeyCode::Digit5,
|
||||
orbclient::K_6 => KeyCode::Digit6,
|
||||
orbclient::K_7 => KeyCode::Digit7,
|
||||
orbclient::K_8 => KeyCode::Digit8,
|
||||
orbclient::K_9 => KeyCode::Digit9,
|
||||
|
||||
orbclient::K_TICK => Some(VirtualKeyCode::Grave),
|
||||
orbclient::K_MINUS => Some(VirtualKeyCode::Minus),
|
||||
orbclient::K_EQUALS => Some(VirtualKeyCode::Equals),
|
||||
orbclient::K_BACKSLASH => Some(VirtualKeyCode::Backslash),
|
||||
orbclient::K_BRACE_OPEN => Some(VirtualKeyCode::LBracket),
|
||||
orbclient::K_BRACE_CLOSE => Some(VirtualKeyCode::RBracket),
|
||||
orbclient::K_SEMICOLON => Some(VirtualKeyCode::Semicolon),
|
||||
orbclient::K_QUOTE => Some(VirtualKeyCode::Apostrophe),
|
||||
orbclient::K_COMMA => Some(VirtualKeyCode::Comma),
|
||||
orbclient::K_PERIOD => Some(VirtualKeyCode::Period),
|
||||
orbclient::K_SLASH => Some(VirtualKeyCode::Slash),
|
||||
orbclient::K_BKSP => Some(VirtualKeyCode::Back),
|
||||
orbclient::K_SPACE => Some(VirtualKeyCode::Space),
|
||||
orbclient::K_TAB => Some(VirtualKeyCode::Tab),
|
||||
//orbclient::K_CAPS => Some(VirtualKeyCode::CAPS),
|
||||
orbclient::K_LEFT_SHIFT => Some(VirtualKeyCode::LShift),
|
||||
orbclient::K_RIGHT_SHIFT => Some(VirtualKeyCode::RShift),
|
||||
orbclient::K_CTRL => Some(VirtualKeyCode::LControl),
|
||||
orbclient::K_ALT => Some(VirtualKeyCode::LAlt),
|
||||
orbclient::K_ENTER => Some(VirtualKeyCode::Return),
|
||||
orbclient::K_ESC => Some(VirtualKeyCode::Escape),
|
||||
orbclient::K_F1 => Some(VirtualKeyCode::F1),
|
||||
orbclient::K_F2 => Some(VirtualKeyCode::F2),
|
||||
orbclient::K_F3 => Some(VirtualKeyCode::F3),
|
||||
orbclient::K_F4 => Some(VirtualKeyCode::F4),
|
||||
orbclient::K_F5 => Some(VirtualKeyCode::F5),
|
||||
orbclient::K_F6 => Some(VirtualKeyCode::F6),
|
||||
orbclient::K_F7 => Some(VirtualKeyCode::F7),
|
||||
orbclient::K_F8 => Some(VirtualKeyCode::F8),
|
||||
orbclient::K_F9 => Some(VirtualKeyCode::F9),
|
||||
orbclient::K_F10 => Some(VirtualKeyCode::F10),
|
||||
orbclient::K_HOME => Some(VirtualKeyCode::Home),
|
||||
orbclient::K_UP => Some(VirtualKeyCode::Up),
|
||||
orbclient::K_PGUP => Some(VirtualKeyCode::PageUp),
|
||||
orbclient::K_LEFT => Some(VirtualKeyCode::Left),
|
||||
orbclient::K_RIGHT => Some(VirtualKeyCode::Right),
|
||||
orbclient::K_END => Some(VirtualKeyCode::End),
|
||||
orbclient::K_DOWN => Some(VirtualKeyCode::Down),
|
||||
orbclient::K_PGDN => Some(VirtualKeyCode::PageDown),
|
||||
orbclient::K_DEL => Some(VirtualKeyCode::Delete),
|
||||
orbclient::K_F11 => Some(VirtualKeyCode::F11),
|
||||
orbclient::K_F12 => Some(VirtualKeyCode::F12),
|
||||
orbclient::K_TICK => KeyCode::Backquote,
|
||||
orbclient::K_MINUS => KeyCode::Minus,
|
||||
orbclient::K_EQUALS => KeyCode::Equal,
|
||||
orbclient::K_BACKSLASH => KeyCode::Backslash,
|
||||
orbclient::K_BRACE_OPEN => KeyCode::BracketLeft,
|
||||
orbclient::K_BRACE_CLOSE => KeyCode::BracketRight,
|
||||
orbclient::K_SEMICOLON => KeyCode::Semicolon,
|
||||
orbclient::K_QUOTE => KeyCode::Quote,
|
||||
orbclient::K_COMMA => KeyCode::Comma,
|
||||
orbclient::K_PERIOD => KeyCode::Period,
|
||||
orbclient::K_SLASH => KeyCode::Slash,
|
||||
orbclient::K_BKSP => KeyCode::Backspace,
|
||||
orbclient::K_SPACE => KeyCode::Space,
|
||||
orbclient::K_TAB => KeyCode::Tab,
|
||||
//orbclient::K_CAPS => KeyCode::CAPS,
|
||||
orbclient::K_LEFT_SHIFT => KeyCode::ShiftLeft,
|
||||
orbclient::K_RIGHT_SHIFT => KeyCode::ShiftRight,
|
||||
orbclient::K_CTRL => KeyCode::ControlLeft,
|
||||
orbclient::K_ALT => KeyCode::AltLeft,
|
||||
orbclient::K_ENTER => KeyCode::Enter,
|
||||
orbclient::K_ESC => KeyCode::Escape,
|
||||
orbclient::K_F1 => KeyCode::F1,
|
||||
orbclient::K_F2 => KeyCode::F2,
|
||||
orbclient::K_F3 => KeyCode::F3,
|
||||
orbclient::K_F4 => KeyCode::F4,
|
||||
orbclient::K_F5 => KeyCode::F5,
|
||||
orbclient::K_F6 => KeyCode::F6,
|
||||
orbclient::K_F7 => KeyCode::F7,
|
||||
orbclient::K_F8 => KeyCode::F8,
|
||||
orbclient::K_F9 => KeyCode::F9,
|
||||
orbclient::K_F10 => KeyCode::F10,
|
||||
orbclient::K_HOME => KeyCode::Home,
|
||||
orbclient::K_UP => KeyCode::ArrowUp,
|
||||
orbclient::K_PGUP => KeyCode::PageUp,
|
||||
orbclient::K_LEFT => KeyCode::ArrowLeft,
|
||||
orbclient::K_RIGHT => KeyCode::ArrowRight,
|
||||
orbclient::K_END => KeyCode::End,
|
||||
orbclient::K_DOWN => KeyCode::ArrowDown,
|
||||
orbclient::K_PGDN => KeyCode::PageDown,
|
||||
orbclient::K_DEL => KeyCode::Delete,
|
||||
orbclient::K_F11 => KeyCode::F11,
|
||||
orbclient::K_F12 => KeyCode::F12,
|
||||
|
||||
_ => None,
|
||||
_ => KeyCode::Unidentified(NativeKeyCode::Unidentified),
|
||||
}
|
||||
}
|
||||
|
||||
@@ -147,16 +150,16 @@ struct EventState {
|
||||
}
|
||||
|
||||
impl EventState {
|
||||
fn key(&mut self, vk: VirtualKeyCode, pressed: bool) {
|
||||
match vk {
|
||||
VirtualKeyCode::LShift => self.keyboard.set(KeyboardModifierState::LSHIFT, pressed),
|
||||
VirtualKeyCode::RShift => self.keyboard.set(KeyboardModifierState::RSHIFT, pressed),
|
||||
VirtualKeyCode::LControl => self.keyboard.set(KeyboardModifierState::LCTRL, pressed),
|
||||
VirtualKeyCode::RControl => self.keyboard.set(KeyboardModifierState::RCTRL, pressed),
|
||||
VirtualKeyCode::LAlt => self.keyboard.set(KeyboardModifierState::LALT, pressed),
|
||||
VirtualKeyCode::RAlt => self.keyboard.set(KeyboardModifierState::RALT, pressed),
|
||||
VirtualKeyCode::LWin => self.keyboard.set(KeyboardModifierState::LSUPER, pressed),
|
||||
VirtualKeyCode::RWin => self.keyboard.set(KeyboardModifierState::RSUPER, pressed),
|
||||
fn key(&mut self, code: KeyCode, pressed: bool) {
|
||||
match code {
|
||||
KeyCode::ShiftLeft => self.keyboard.set(KeyboardModifierState::LSHIFT, pressed),
|
||||
KeyCode::ShiftRight => self.keyboard.set(KeyboardModifierState::RSHIFT, pressed),
|
||||
KeyCode::ControlLeft => self.keyboard.set(KeyboardModifierState::LCTRL, pressed),
|
||||
KeyCode::ControlRight => self.keyboard.set(KeyboardModifierState::RCTRL, pressed),
|
||||
KeyCode::AltLeft => self.keyboard.set(KeyboardModifierState::LALT, pressed),
|
||||
KeyCode::AltRight => self.keyboard.set(KeyboardModifierState::RALT, pressed),
|
||||
KeyCode::SuperLeft => self.keyboard.set(KeyboardModifierState::LSUPER, pressed),
|
||||
KeyCode::SuperRight => self.keyboard.set(KeyboardModifierState::RSUPER, pressed),
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
@@ -185,33 +188,78 @@ impl EventState {
|
||||
None
|
||||
}
|
||||
|
||||
fn modifiers(&self) -> event::ModifiersState {
|
||||
let mut modifiers = event::ModifiersState::empty();
|
||||
fn modifiers(&self) -> Modifiers {
|
||||
let mut state = ModifiersState::empty();
|
||||
let mut pressed_mods = ModifiersKeys::empty();
|
||||
|
||||
if self
|
||||
.keyboard
|
||||
.intersects(KeyboardModifierState::LSHIFT | KeyboardModifierState::RSHIFT)
|
||||
{
|
||||
modifiers |= event::ModifiersState::SHIFT;
|
||||
state |= ModifiersState::SHIFT;
|
||||
}
|
||||
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::LSHIFT,
|
||||
self.keyboard.contains(KeyboardModifierState::LSHIFT),
|
||||
);
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::RSHIFT,
|
||||
self.keyboard.contains(KeyboardModifierState::RSHIFT),
|
||||
);
|
||||
|
||||
if self
|
||||
.keyboard
|
||||
.intersects(KeyboardModifierState::LCTRL | KeyboardModifierState::RCTRL)
|
||||
{
|
||||
modifiers |= event::ModifiersState::CTRL;
|
||||
state |= ModifiersState::CONTROL;
|
||||
}
|
||||
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::LCONTROL,
|
||||
self.keyboard.contains(KeyboardModifierState::LCTRL),
|
||||
);
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::RCONTROL,
|
||||
self.keyboard.contains(KeyboardModifierState::RCTRL),
|
||||
);
|
||||
|
||||
if self
|
||||
.keyboard
|
||||
.intersects(KeyboardModifierState::LALT | KeyboardModifierState::RALT)
|
||||
{
|
||||
modifiers |= event::ModifiersState::ALT;
|
||||
state |= ModifiersState::ALT;
|
||||
}
|
||||
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::LALT,
|
||||
self.keyboard.contains(KeyboardModifierState::LALT),
|
||||
);
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::RALT,
|
||||
self.keyboard.contains(KeyboardModifierState::RALT),
|
||||
);
|
||||
|
||||
if self
|
||||
.keyboard
|
||||
.intersects(KeyboardModifierState::LSUPER | KeyboardModifierState::RSUPER)
|
||||
{
|
||||
modifiers |= event::ModifiersState::LOGO
|
||||
state |= ModifiersState::SUPER
|
||||
}
|
||||
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::LSUPER,
|
||||
self.keyboard.contains(KeyboardModifierState::LSUPER),
|
||||
);
|
||||
pressed_mods.set(
|
||||
ModifiersKeys::RSUPER,
|
||||
self.keyboard.contains(KeyboardModifierState::RSUPER),
|
||||
);
|
||||
|
||||
Modifiers {
|
||||
state,
|
||||
pressed_mods,
|
||||
}
|
||||
modifiers
|
||||
}
|
||||
}
|
||||
|
||||
@@ -277,32 +325,44 @@ impl<T: 'static> EventLoop<T> {
|
||||
pressed,
|
||||
}) => {
|
||||
if scancode != 0 {
|
||||
let vk_opt = convert_scancode(scancode);
|
||||
if let Some(vk) = vk_opt {
|
||||
event_state.key(vk, pressed);
|
||||
}
|
||||
event_handler(
|
||||
#[allow(deprecated)]
|
||||
event::Event::WindowEvent {
|
||||
window_id: RootWindowId(window_id),
|
||||
event: event::WindowEvent::KeyboardInput {
|
||||
device_id: event::DeviceId(DeviceId),
|
||||
input: event::KeyboardInput {
|
||||
scancode: scancode as u32,
|
||||
state: element_state(pressed),
|
||||
virtual_keycode: vk_opt,
|
||||
modifiers: event_state.modifiers(),
|
||||
},
|
||||
is_synthetic: false,
|
||||
let code = convert_scancode(scancode);
|
||||
let modifiers_before = event_state.keyboard;
|
||||
event_state.key(code, pressed);
|
||||
event_handler(event::Event::WindowEvent {
|
||||
window_id: RootWindowId(window_id),
|
||||
event: event::WindowEvent::KeyboardInput {
|
||||
device_id: event::DeviceId(DeviceId),
|
||||
event: event::KeyEvent {
|
||||
logical_key: Key::Unidentified(NativeKey::Unidentified),
|
||||
physical_key: code,
|
||||
location: KeyLocation::Standard,
|
||||
state: element_state(pressed),
|
||||
repeat: false,
|
||||
text: None,
|
||||
|
||||
platform_specific: KeyEventExtra {},
|
||||
},
|
||||
is_synthetic: false,
|
||||
},
|
||||
);
|
||||
});
|
||||
|
||||
// If the state of the modifiers has changed, send the event.
|
||||
if modifiers_before != event_state.keyboard {
|
||||
event_handler(event::Event::WindowEvent {
|
||||
window_id: RootWindowId(window_id),
|
||||
event: event::WindowEvent::ModifiersChanged(event_state.modifiers()),
|
||||
})
|
||||
}
|
||||
}
|
||||
}
|
||||
EventOption::TextInput(TextInputEvent { character }) => {
|
||||
event_handler(event::Event::WindowEvent {
|
||||
window_id: RootWindowId(window_id),
|
||||
event: event::WindowEvent::ReceivedCharacter(character),
|
||||
event: event::WindowEvent::Ime(Ime::Preedit("".into(), None)),
|
||||
});
|
||||
event_handler(event::Event::WindowEvent {
|
||||
window_id: RootWindowId(window_id),
|
||||
event: event::WindowEvent::Ime(Ime::Commit(character.into())),
|
||||
});
|
||||
}
|
||||
EventOption::Mouse(MouseEvent { x, y }) => {
|
||||
@@ -311,7 +371,6 @@ impl<T: 'static> EventLoop<T> {
|
||||
event: event::WindowEvent::CursorMoved {
|
||||
device_id: event::DeviceId(DeviceId),
|
||||
position: (x, y).into(),
|
||||
modifiers: event_state.modifiers(),
|
||||
},
|
||||
});
|
||||
}
|
||||
@@ -327,7 +386,6 @@ impl<T: 'static> EventLoop<T> {
|
||||
device_id: event::DeviceId(DeviceId),
|
||||
state,
|
||||
button,
|
||||
modifiers: event_state.modifiers(),
|
||||
},
|
||||
});
|
||||
}
|
||||
@@ -339,7 +397,6 @@ impl<T: 'static> EventLoop<T> {
|
||||
device_id: event::DeviceId(DeviceId),
|
||||
delta: event::MouseScrollDelta::LineDelta(x as f32, y as f32),
|
||||
phase: event::TouchPhase::Moved,
|
||||
modifiers: event_state.modifiers(),
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user