use crate::{
Capslock, KeyDownEvent, KeyUpEvent, Keystroke, MagnifyEvent, Modifiers, ModifiersChangedEvent,
MouseButton, MouseDownEvent, MouseExitEvent, MouseMoveEvent, MouseUpEvent, NavigationDirection,
Pixels, PlatformInput, ScrollDelta, ScrollWheelEvent, TouchPhase,
platform::mac::{
LMGetKbdType, TISCopyCurrentKeyboardLayoutInputSource, TISGetInputSourceProperty,
UCKeyTranslate, kTISPropertyUnicodeKeyLayoutData,
},
point, px,
};
use core_foundation::data::{CFDataGetBytePtr, CFDataRef};
use core_graphics::event::CGKeyCode;
use objc2::{msg_send, runtime::AnyObject};
use objc2_app_kit::{NSEvent, NSEventModifierFlags, NSEventPhase, NSEventType};
use std::{borrow::Cow, ffi::c_void};
#[allow(non_upper_case_globals)]
mod appkit_key_codes {
pub(super) const NSUpArrowFunctionKey: u16 = objc2_app_kit::NSUpArrowFunctionKey as u16;
pub(super) const NSDownArrowFunctionKey: u16 = objc2_app_kit::NSDownArrowFunctionKey as u16;
pub(super) const NSLeftArrowFunctionKey: u16 = objc2_app_kit::NSLeftArrowFunctionKey as u16;
pub(super) const NSRightArrowFunctionKey: u16 = objc2_app_kit::NSRightArrowFunctionKey as u16;
pub(super) const NSF1FunctionKey: u16 = objc2_app_kit::NSF1FunctionKey as u16;
pub(super) const NSF2FunctionKey: u16 = objc2_app_kit::NSF2FunctionKey as u16;
pub(super) const NSF3FunctionKey: u16 = objc2_app_kit::NSF3FunctionKey as u16;
pub(super) const NSF4FunctionKey: u16 = objc2_app_kit::NSF4FunctionKey as u16;
pub(super) const NSF5FunctionKey: u16 = objc2_app_kit::NSF5FunctionKey as u16;
pub(super) const NSF6FunctionKey: u16 = objc2_app_kit::NSF6FunctionKey as u16;
pub(super) const NSF7FunctionKey: u16 = objc2_app_kit::NSF7FunctionKey as u16;
pub(super) const NSF8FunctionKey: u16 = objc2_app_kit::NSF8FunctionKey as u16;
pub(super) const NSF9FunctionKey: u16 = objc2_app_kit::NSF9FunctionKey as u16;
pub(super) const NSF10FunctionKey: u16 = objc2_app_kit::NSF10FunctionKey as u16;
pub(super) const NSF11FunctionKey: u16 = objc2_app_kit::NSF11FunctionKey as u16;
pub(super) const NSF12FunctionKey: u16 = objc2_app_kit::NSF12FunctionKey as u16;
pub(super) const NSF13FunctionKey: u16 = objc2_app_kit::NSF13FunctionKey as u16;
pub(super) const NSF14FunctionKey: u16 = objc2_app_kit::NSF14FunctionKey as u16;
pub(super) const NSF15FunctionKey: u16 = objc2_app_kit::NSF15FunctionKey as u16;
pub(super) const NSF16FunctionKey: u16 = objc2_app_kit::NSF16FunctionKey as u16;
pub(super) const NSF17FunctionKey: u16 = objc2_app_kit::NSF17FunctionKey as u16;
pub(super) const NSF18FunctionKey: u16 = objc2_app_kit::NSF18FunctionKey as u16;
pub(super) const NSF19FunctionKey: u16 = objc2_app_kit::NSF19FunctionKey as u16;
pub(super) const NSF20FunctionKey: u16 = objc2_app_kit::NSF20FunctionKey as u16;
pub(super) const NSF21FunctionKey: u16 = objc2_app_kit::NSF21FunctionKey as u16;
pub(super) const NSF22FunctionKey: u16 = objc2_app_kit::NSF22FunctionKey as u16;
pub(super) const NSF23FunctionKey: u16 = objc2_app_kit::NSF23FunctionKey as u16;
pub(super) const NSF24FunctionKey: u16 = objc2_app_kit::NSF24FunctionKey as u16;
pub(super) const NSF25FunctionKey: u16 = objc2_app_kit::NSF25FunctionKey as u16;
pub(super) const NSF26FunctionKey: u16 = objc2_app_kit::NSF26FunctionKey as u16;
pub(super) const NSF27FunctionKey: u16 = objc2_app_kit::NSF27FunctionKey as u16;
pub(super) const NSF28FunctionKey: u16 = objc2_app_kit::NSF28FunctionKey as u16;
pub(super) const NSF29FunctionKey: u16 = objc2_app_kit::NSF29FunctionKey as u16;
pub(super) const NSF30FunctionKey: u16 = objc2_app_kit::NSF30FunctionKey as u16;
pub(super) const NSF31FunctionKey: u16 = objc2_app_kit::NSF31FunctionKey as u16;
pub(super) const NSF32FunctionKey: u16 = objc2_app_kit::NSF32FunctionKey as u16;
pub(super) const NSF33FunctionKey: u16 = objc2_app_kit::NSF33FunctionKey as u16;
pub(super) const NSF34FunctionKey: u16 = objc2_app_kit::NSF34FunctionKey as u16;
pub(super) const NSF35FunctionKey: u16 = objc2_app_kit::NSF35FunctionKey as u16;
pub(super) const NSDeleteFunctionKey: u16 = objc2_app_kit::NSDeleteFunctionKey as u16;
pub(super) const NSHomeFunctionKey: u16 = objc2_app_kit::NSHomeFunctionKey as u16;
pub(super) const NSEndFunctionKey: u16 = objc2_app_kit::NSEndFunctionKey as u16;
pub(super) const NSPageUpFunctionKey: u16 = objc2_app_kit::NSPageUpFunctionKey as u16;
pub(super) const NSPageDownFunctionKey: u16 = objc2_app_kit::NSPageDownFunctionKey as u16;
pub(super) const NSHelpFunctionKey: u16 = objc2_app_kit::NSHelpFunctionKey as u16;
pub(super) const NSModeSwitchFunctionKey: u16 = objc2_app_kit::NSModeSwitchFunctionKey as u16;
}
const BACKSPACE_KEY: u16 = 0x7f;
const SPACE_KEY: u16 = b' ' as u16;
const ENTER_KEY: u16 = 0x0d;
const NUMPAD_ENTER_KEY: u16 = 0x03;
pub(crate) const ESCAPE_KEY: u16 = 0x1b;
const TAB_KEY: u16 = 0x09;
const SHIFT_TAB_KEY: u16 = 0x19;
pub fn key_to_native(key: &str) -> Cow<'_, str> {
use appkit_key_codes::*;
let code = match key {
"space" => SPACE_KEY,
"backspace" => BACKSPACE_KEY,
"escape" => ESCAPE_KEY,
"up" => NSUpArrowFunctionKey,
"down" => NSDownArrowFunctionKey,
"left" => NSLeftArrowFunctionKey,
"right" => NSRightArrowFunctionKey,
"pageup" => NSPageUpFunctionKey,
"pagedown" => NSPageDownFunctionKey,
"home" => NSHomeFunctionKey,
"end" => NSEndFunctionKey,
"delete" => NSDeleteFunctionKey,
"insert" => NSHelpFunctionKey,
"f1" => NSF1FunctionKey,
"f2" => NSF2FunctionKey,
"f3" => NSF3FunctionKey,
"f4" => NSF4FunctionKey,
"f5" => NSF5FunctionKey,
"f6" => NSF6FunctionKey,
"f7" => NSF7FunctionKey,
"f8" => NSF8FunctionKey,
"f9" => NSF9FunctionKey,
"f10" => NSF10FunctionKey,
"f11" => NSF11FunctionKey,
"f12" => NSF12FunctionKey,
"f13" => NSF13FunctionKey,
"f14" => NSF14FunctionKey,
"f15" => NSF15FunctionKey,
"f16" => NSF16FunctionKey,
"f17" => NSF17FunctionKey,
"f18" => NSF18FunctionKey,
"f19" => NSF19FunctionKey,
"f20" => NSF20FunctionKey,
"f21" => NSF21FunctionKey,
"f22" => NSF22FunctionKey,
"f23" => NSF23FunctionKey,
"f24" => NSF24FunctionKey,
"f25" => NSF25FunctionKey,
"f26" => NSF26FunctionKey,
"f27" => NSF27FunctionKey,
"f28" => NSF28FunctionKey,
"f29" => NSF29FunctionKey,
"f30" => NSF30FunctionKey,
"f31" => NSF31FunctionKey,
"f32" => NSF32FunctionKey,
"f33" => NSF33FunctionKey,
"f34" => NSF34FunctionKey,
"f35" => NSF35FunctionKey,
_ => return Cow::Borrowed(key),
};
Cow::Owned(String::from_utf16(&[code]).unwrap())
}
fn read_modifiers(native_event: &NSEvent) -> Modifiers {
let modifiers = native_event.modifierFlags();
let control = modifiers.contains(NSEventModifierFlags::Control);
let alt = modifiers.contains(NSEventModifierFlags::Option);
let shift = modifiers.contains(NSEventModifierFlags::Shift);
let command = modifiers.contains(NSEventModifierFlags::Command);
let function = modifiers.contains(NSEventModifierFlags::Function);
Modifiers {
control,
alt,
shift,
platform: command,
function,
}
}
impl PlatformInput {
pub(crate) unsafe fn from_native(
native_event: *mut AnyObject,
window_height: Option<Pixels>,
) -> Option<Self> {
unsafe {
let native_event = &*(native_event as *const NSEvent);
let event_type = native_event.r#type();
match event_type.0 as u64 {
0 | 21 | 32 | 33 | 35 | 36 | 37 => {
return None;
}
_ => {}
}
match event_type {
NSEventType::FlagsChanged => Some(Self::ModifiersChanged(ModifiersChangedEvent {
modifiers: read_modifiers(native_event),
capslock: Capslock {
on: native_event
.modifierFlags()
.contains(NSEventModifierFlags::CapsLock),
},
})),
NSEventType::KeyDown => Some(Self::KeyDown(KeyDownEvent {
keystroke: parse_keystroke(native_event),
is_held: native_event.isARepeat(),
})),
NSEventType::KeyUp => Some(Self::KeyUp(KeyUpEvent {
keystroke: parse_keystroke(native_event),
})),
NSEventType::LeftMouseDown
| NSEventType::RightMouseDown
| NSEventType::OtherMouseDown => {
let button = match native_event.buttonNumber() {
0 => MouseButton::Left,
1 => MouseButton::Right,
2 => MouseButton::Middle,
3 => MouseButton::Navigate(NavigationDirection::Back),
4 => MouseButton::Navigate(NavigationDirection::Forward),
_ => return None,
};
window_height.map(|window_height| {
Self::MouseDown(MouseDownEvent {
button,
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
modifiers: read_modifiers(native_event),
click_count: native_event.clickCount() as usize,
first_mouse: false,
})
})
}
NSEventType::LeftMouseUp
| NSEventType::RightMouseUp
| NSEventType::OtherMouseUp => {
let button = match native_event.buttonNumber() {
0 => MouseButton::Left,
1 => MouseButton::Right,
2 => MouseButton::Middle,
3 => MouseButton::Navigate(NavigationDirection::Back),
4 => MouseButton::Navigate(NavigationDirection::Forward),
_ => return None,
};
window_height.map(|window_height| {
Self::MouseUp(MouseUpEvent {
button,
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
modifiers: read_modifiers(native_event),
click_count: native_event.clickCount() as usize,
})
})
}
NSEventType::Swipe => {
let navigation_direction = match native_event.phase() {
NSEventPhase::Ended => match native_event.deltaX() {
x if x > 0.0 => Some(NavigationDirection::Back),
x if x < 0.0 => Some(NavigationDirection::Forward),
_ => return None,
},
_ => return None,
};
match navigation_direction {
Some(direction) => window_height.map(|window_height| {
Self::MouseDown(MouseDownEvent {
button: MouseButton::Navigate(direction),
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
modifiers: read_modifiers(native_event),
click_count: 1,
first_mouse: false,
})
}),
_ => None,
}
}
NSEventType::ScrollWheel => window_height.map(|window_height| {
let phase = match native_event.phase() {
NSEventPhase::MayBegin | NSEventPhase::Began => TouchPhase::Started,
NSEventPhase::Ended | NSEventPhase::Cancelled => TouchPhase::Ended,
_ => TouchPhase::Moved,
};
let is_momentum = native_event.momentumPhase() != NSEventPhase::None;
let raw_data = point(
native_event.scrollingDeltaX() as f32,
native_event.scrollingDeltaY() as f32,
);
let delta = if native_event.hasPreciseScrollingDeltas() {
ScrollDelta::Pixels(raw_data.map(px))
} else {
ScrollDelta::Lines(raw_data)
};
Self::ScrollWheel(ScrollWheelEvent {
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
delta,
touch_phase: phase,
is_momentum,
modifiers: read_modifiers(native_event),
})
}),
NSEventType::Magnify => window_height.map(|window_height| {
let phase = match native_event.phase() {
NSEventPhase::MayBegin | NSEventPhase::Began => TouchPhase::Started,
NSEventPhase::Ended | NSEventPhase::Cancelled => TouchPhase::Ended,
_ => TouchPhase::Moved,
};
Self::Magnify(MagnifyEvent {
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
delta: native_event.magnification() as f32,
modifiers: read_modifiers(native_event),
touch_phase: phase,
})
}),
NSEventType::LeftMouseDragged
| NSEventType::RightMouseDragged
| NSEventType::OtherMouseDragged => {
let pressed_button = match native_event.buttonNumber() {
0 => MouseButton::Left,
1 => MouseButton::Right,
2 => MouseButton::Middle,
3 => MouseButton::Navigate(NavigationDirection::Back),
4 => MouseButton::Navigate(NavigationDirection::Forward),
_ => return None,
};
window_height.map(|window_height| {
Self::MouseMove(MouseMoveEvent {
pressed_button: Some(pressed_button),
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
modifiers: read_modifiers(native_event),
})
})
}
NSEventType::MouseMoved => window_height.map(|window_height| {
Self::MouseMove(MouseMoveEvent {
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
pressed_button: None,
modifiers: read_modifiers(native_event),
})
}),
NSEventType::MouseExited => window_height.map(|window_height| {
Self::MouseExited(MouseExitEvent {
position: point(
px(native_event.locationInWindow().x as f32),
window_height - px(native_event.locationInWindow().y as f32),
),
pressed_button: None,
modifiers: read_modifiers(native_event),
})
}),
_ => None,
}
}
}
}
fn parse_keystroke(native_event: &NSEvent) -> Keystroke {
use appkit_key_codes::*;
let mut characters = native_event
.charactersIgnoringModifiers()
.map(|characters| characters.to_string())
.unwrap_or_default();
let mut key_char = None;
let first_char = characters.chars().next().map(|ch| ch as u16);
let modifiers = native_event.modifierFlags();
let control = modifiers.contains(NSEventModifierFlags::Control);
let alt = modifiers.contains(NSEventModifierFlags::Option);
let mut shift = modifiers.contains(NSEventModifierFlags::Shift);
let command = modifiers.contains(NSEventModifierFlags::Command);
let function = modifiers.contains(NSEventModifierFlags::Function)
&& first_char
.is_none_or(|ch| !(NSUpArrowFunctionKey..=NSModeSwitchFunctionKey).contains(&ch));
#[allow(non_upper_case_globals)]
let key = match first_char {
Some(SPACE_KEY) => {
key_char = Some(" ".to_string());
"space".to_string()
}
Some(TAB_KEY) => {
key_char = Some("\t".to_string());
"tab".to_string()
}
Some(ENTER_KEY) | Some(NUMPAD_ENTER_KEY) => {
key_char = Some("\n".to_string());
"enter".to_string()
}
Some(BACKSPACE_KEY) => "backspace".to_string(),
Some(ESCAPE_KEY) => "escape".to_string(),
Some(SHIFT_TAB_KEY) => "tab".to_string(),
Some(NSUpArrowFunctionKey) => "up".to_string(),
Some(NSDownArrowFunctionKey) => "down".to_string(),
Some(NSLeftArrowFunctionKey) => "left".to_string(),
Some(NSRightArrowFunctionKey) => "right".to_string(),
Some(NSPageUpFunctionKey) => "pageup".to_string(),
Some(NSPageDownFunctionKey) => "pagedown".to_string(),
Some(NSHomeFunctionKey) => "home".to_string(),
Some(NSEndFunctionKey) => "end".to_string(),
Some(NSDeleteFunctionKey) => "delete".to_string(),
Some(NSHelpFunctionKey) => "insert".to_string(),
Some(NSF1FunctionKey) => "f1".to_string(),
Some(NSF2FunctionKey) => "f2".to_string(),
Some(NSF3FunctionKey) => "f3".to_string(),
Some(NSF4FunctionKey) => "f4".to_string(),
Some(NSF5FunctionKey) => "f5".to_string(),
Some(NSF6FunctionKey) => "f6".to_string(),
Some(NSF7FunctionKey) => "f7".to_string(),
Some(NSF8FunctionKey) => "f8".to_string(),
Some(NSF9FunctionKey) => "f9".to_string(),
Some(NSF10FunctionKey) => "f10".to_string(),
Some(NSF11FunctionKey) => "f11".to_string(),
Some(NSF12FunctionKey) => "f12".to_string(),
Some(NSF13FunctionKey) => "f13".to_string(),
Some(NSF14FunctionKey) => "f14".to_string(),
Some(NSF15FunctionKey) => "f15".to_string(),
Some(NSF16FunctionKey) => "f16".to_string(),
Some(NSF17FunctionKey) => "f17".to_string(),
Some(NSF18FunctionKey) => "f18".to_string(),
Some(NSF19FunctionKey) => "f19".to_string(),
Some(NSF20FunctionKey) => "f20".to_string(),
Some(NSF21FunctionKey) => "f21".to_string(),
Some(NSF22FunctionKey) => "f22".to_string(),
Some(NSF23FunctionKey) => "f23".to_string(),
Some(NSF24FunctionKey) => "f24".to_string(),
Some(NSF25FunctionKey) => "f25".to_string(),
Some(NSF26FunctionKey) => "f26".to_string(),
Some(NSF27FunctionKey) => "f27".to_string(),
Some(NSF28FunctionKey) => "f28".to_string(),
Some(NSF29FunctionKey) => "f29".to_string(),
Some(NSF30FunctionKey) => "f30".to_string(),
Some(NSF31FunctionKey) => "f31".to_string(),
Some(NSF32FunctionKey) => "f32".to_string(),
Some(NSF33FunctionKey) => "f33".to_string(),
Some(NSF34FunctionKey) => "f34".to_string(),
Some(NSF35FunctionKey) => "f35".to_string(),
_ => {
let mut chars_ignoring_modifiers =
chars_for_modified_key(native_event.keyCode(), NO_MOD);
let mut chars_with_shift = chars_for_modified_key(native_event.keyCode(), SHIFT_MOD);
let always_use_cmd_layout = always_use_command_layout();
if command || always_use_cmd_layout {
let chars_with_cmd = chars_for_modified_key(native_event.keyCode(), CMD_MOD);
let chars_with_both =
chars_for_modified_key(native_event.keyCode(), CMD_MOD | SHIFT_MOD);
if chars_with_both != chars_with_cmd {
chars_with_shift = chars_with_both;
} else if chars_with_cmd.to_ascii_uppercase() != chars_with_cmd {
chars_with_shift = chars_with_cmd.to_ascii_uppercase();
}
chars_ignoring_modifiers = chars_with_cmd;
}
if !control && !command && !function {
let mut mods = NO_MOD;
if shift {
mods |= SHIFT_MOD;
}
if alt {
mods |= OPTION_MOD;
}
key_char = Some(chars_for_modified_key(native_event.keyCode(), mods));
}
if shift
&& chars_ignoring_modifiers
.chars()
.all(|c| c.is_ascii_lowercase())
{
chars_ignoring_modifiers
} else if shift {
shift = false;
chars_with_shift
} else {
chars_ignoring_modifiers
}
}
};
Keystroke {
modifiers: Modifiers {
control,
alt,
shift,
platform: command,
function,
},
key,
key_char,
}
}
fn always_use_command_layout() -> bool {
if chars_for_modified_key(0, NO_MOD).is_ascii() {
return false;
}
chars_for_modified_key(0, CMD_MOD).is_ascii()
}
const NO_MOD: u32 = 0;
const CMD_MOD: u32 = 1;
const SHIFT_MOD: u32 = 2;
const OPTION_MOD: u32 = 8;
fn chars_for_modified_key(code: CGKeyCode, modifiers: u32) -> String {
const CG_SPACE_KEY: u16 = 49;
#[allow(non_upper_case_globals)]
const kUCKeyActionDown: u16 = 0;
#[allow(non_upper_case_globals)]
const kUCKeyTranslateNoDeadKeysMask: u32 = 0;
let keyboard_type = unsafe { LMGetKbdType() as u32 };
const BUFFER_SIZE: usize = 4;
let mut dead_key_state = 0;
let mut buffer: [u16; BUFFER_SIZE] = [0; BUFFER_SIZE];
let mut buffer_size: usize = 0;
let keyboard = unsafe { TISCopyCurrentKeyboardLayoutInputSource() };
if keyboard.is_null() {
return "".to_string();
}
let layout_data = unsafe {
TISGetInputSourceProperty(keyboard, kTISPropertyUnicodeKeyLayoutData as *const c_void)
as CFDataRef
};
if layout_data.is_null() {
unsafe {
let _: () = msg_send![keyboard as *mut AnyObject, release];
}
return "".to_string();
}
let keyboard_layout = unsafe { CFDataGetBytePtr(layout_data) };
unsafe {
UCKeyTranslate(
keyboard_layout as *const c_void,
code,
kUCKeyActionDown,
modifiers,
keyboard_type,
kUCKeyTranslateNoDeadKeysMask,
&mut dead_key_state,
BUFFER_SIZE,
&mut buffer_size as *mut usize,
&mut buffer as *mut u16,
);
if dead_key_state != 0 {
UCKeyTranslate(
keyboard_layout as *const c_void,
CG_SPACE_KEY,
kUCKeyActionDown,
modifiers,
keyboard_type,
kUCKeyTranslateNoDeadKeysMask,
&mut dead_key_state,
BUFFER_SIZE,
&mut buffer_size as *mut usize,
&mut buffer as *mut u16,
);
}
let _: () = msg_send![keyboard as *mut AnyObject, release];
}
String::from_utf16(&buffer[..buffer_size]).unwrap_or_default()
}