Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add composition event on macOS #1979

Merged
merged 14 commits into from Aug 9, 2021
Merged

Add composition event on macOS #1979

Changes from 6 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
077d264
Enable to show text when IME is active
Jul 21, 2021
a6ea943
Remove unnecessary variable
Jul 21, 2021
6a9f1af
Enable to use IME
Jul 27, 2021
ccf7682
fmt
Jul 27, 2021
e6b7922
Remove println! for debug
Jul 27, 2021
a8f7bd6
Fix handling of utf-8 string
Jul 27, 2021
8fb12c8
clear_marked_text should be rust function, not member function
Aug 4, 2021
c385a9d
Store state information in ViewState
Aug 5, 2021
0fba5d4
Remove unnecessary function
Aug 5, 2021
f4d49a5
format
Aug 5, 2021
1791244
Remove mut
Aug 5, 2021
69bdc03
format
Aug 5, 2021
33f84ca
Remove duplicate marked text
ArturKovacs Aug 5, 2021
bb7d8fb
Remove unused `is_preediting` field
ArturKovacs Aug 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
115 changes: 107 additions & 8 deletions src/platform_impl/macos/view.rs
View file
Open in desktop
Expand Up @@ -159,7 +159,7 @@ lazy_static! {
);
decl.add_method(
sel!(insertText:replacementRange:),
insert_text as extern "C" fn(&Object, Sel, id, NSRange),
insert_text as extern "C" fn(&mut Object, Sel, id, NSRange),
);
decl.add_method(
sel!(characterIndexForPoint:),
Expand All @@ -174,7 +174,10 @@ lazy_static! {
sel!(doCommandBySelector:),
do_command_by_selector as extern "C" fn(&Object, Sel, Sel),
);
decl.add_method(sel!(keyDown:), key_down as extern "C" fn(&Object, Sel, id));
decl.add_method(
sel!(keyDown:),
key_down as extern "C" fn(&mut Object, Sel, id),
);
decl.add_method(sel!(keyUp:), key_up as extern "C" fn(&Object, Sel, id));
decl.add_method(
sel!(flagsChanged:),
Expand Down Expand Up @@ -257,8 +260,16 @@ lazy_static! {
sel!(acceptsFirstMouse:),
accepts_first_mouse as extern "C" fn(&Object, Sel, id) -> BOOL,
);
decl.add_method(
sel!(clearMarkedText),
clear_marked_text as extern "C" fn(&mut Object, Sel),
);
komi1230 marked this conversation as resolved.
Show resolved Hide resolved
decl.add_ivar::<*mut c_void>("winitState");
decl.add_ivar::<id>("markedText");
decl.add_ivar::<bool>("isIMEActivated");
decl.add_ivar::<bool>("isPreediting");
decl.add_ivar::<i32>("currentCursorPosition");
decl.add_ivar::<i32>("previousCursorPosition");
komi1230 marked this conversation as resolved.
Show resolved Hide resolved
let protocol = Protocol::get("NSTextInputClient").unwrap();
decl.add_protocol(&protocol);
ViewClass(decl.register())
Expand All @@ -282,6 +293,10 @@ extern "C" fn init_with_winit(this: &Object, _sel: Sel, state: *mut c_void) -> i
let marked_text =
<id as NSMutableAttributedString>::init(NSMutableAttributedString::alloc(nil));
(*this).set_ivar("markedText", marked_text);
(*this).set_ivar("isIMEActivated", false);
(*this).set_ivar("isPreediting", false);
(*this).set_ivar("currentCursorPosition", 0);
(*this).set_ivar("previousCursorPosition", 0);
let _: () = msg_send![this, setPostsFrameChangedNotifications: YES];

let notification_center: &Object =
Expand Down Expand Up @@ -418,12 +433,14 @@ extern "C" fn set_marked_text(
this: &mut Object,
_sel: Sel,
string: id,
_selected_range: NSRange,
selected_range: NSRange,
_replacement_range: NSRange,
) {
trace!("Triggered `setMarkedText`");
unsafe {
this.set_ivar("isIMEActivated", true);
let marked_text_ref: &mut id = this.get_mut_ivar("markedText");

let _: () = msg_send![(*marked_text_ref), release];
let marked_text = NSMutableAttributedString::alloc(nil);
let has_attr = msg_send![string, isKindOfClass: class!(NSAttributedString)];
Expand All @@ -433,22 +450,57 @@ extern "C" fn set_marked_text(
marked_text.initWithString(string);
};
*marked_text_ref = marked_text;

let composed_string = marked_text_ref.clone().string();
let slice = slice::from_raw_parts(
composed_string.UTF8String() as *const c_uchar,
composed_string.len(),
);
let composed_string = str::from_utf8_unchecked(slice);

let state_ptr: *mut c_void = *this.get_ivar("winitState");
let state = &mut *(state_ptr as *mut ViewState);

let cursor_position = selected_range.location as i32;
(*this).set_ivar("currentCursorPosition", cursor_position);

// Delete previous marked text, so that we don't see duplicated texts.
let is_preediting: bool = *this.get_ivar("isPreediting");
if !is_preediting {
let previous_cursor_position = *this.get_ivar::<i32>("previousCursorPosition");
delete_marked_text(state, previous_cursor_position);
}

for character in composed_string.chars() {
AppState::queue_event(EventWrapper::StaticEvent(Event::WindowEvent {
window_id: WindowId(get_window_id(state.ns_window)),
event: WindowEvent::ReceivedCharacter(character),
}));
}

(*this).set_ivar("previousCursorPosition", cursor_position);
}
trace!("Completed `setMarkedText`");
}

extern "C" fn unmark_text(this: &Object, _sel: Sel) {
trace!("Triggered `unmarkText`");
unsafe {
let marked_text: id = *this.get_ivar("markedText");
let mutable_string = marked_text.mutableString();
let _: () = msg_send![mutable_string, setString:""];
let _: () = msg_send![this, clearMarkedText];
komi1230 marked this conversation as resolved.
Show resolved Hide resolved
let input_context: id = msg_send![this, inputContext];
let _: () = msg_send![input_context, discardMarkedText];
}
trace!("Completed `unmarkText`");
}

extern "C" fn clear_marked_text(this: &mut Object, _sel: Sel) {
unsafe {
let marked_text_ref: &mut id = this.get_mut_ivar("markedText");
let _: () = msg_send![(*marked_text_ref), release];
*marked_text_ref = NSMutableAttributedString::alloc(nil);
}
}

extern "C" fn valid_attributes_for_marked_text(_this: &Object, _sel: Sel) -> id {
trace!("Triggered `validAttributesForMarkedText`");
trace!("Completed `validAttributesForMarkedText`");
Expand Down Expand Up @@ -496,9 +548,19 @@ extern "C" fn first_rect_for_character_range(
}
}

extern "C" fn insert_text(this: &Object, _sel: Sel, string: id, _replacement_range: NSRange) {
extern "C" fn insert_text(this: &mut Object, sel: Sel, string: id, _replacement_range: NSRange) {
trace!("Triggered `insertText`");
unsafe {
let is_ime_activated: bool = *this.get_ivar("isIMEActivated");
if is_ime_activated {
clear_marked_text(this, sel);
unmark_text(this, sel);
this.set_ivar("isIMEActivated", false);
this.set_ivar("isPreediting", false);
this.set_ivar("currentCursorPosition", 0);
this.set_ivar("previousCursorPosition", 0);
return;
}
let state_ptr: *mut c_void = *this.get_ivar("winitState");
let state = &mut *(state_ptr as *mut ViewState);

Expand Down Expand Up @@ -568,6 +630,15 @@ extern "C" fn do_command_by_selector(this: &Object, _sel: Sel, command: Sel) {
trace!("Completed `doCommandBySelector`");
}

fn delete_marked_text(state: &mut ViewState, count: i32) {
for _ in 0..count {
AppState::queue_event(EventWrapper::StaticEvent(Event::WindowEvent {
window_id: WindowId(get_window_id(state.ns_window)),
event: WindowEvent::ReceivedCharacter('\u{7f}'), // fire DELETE
}));
}
}

fn get_characters(event: id, ignore_modifiers: bool) -> String {
unsafe {
let characters: id = if ignore_modifiers {
Expand Down Expand Up @@ -600,6 +671,17 @@ fn is_corporate_character(c: char) -> bool {
}
}

fn is_arrow_or_space_key(virtual_keycode: VirtualKeyCode) -> bool {
match virtual_keycode {
VirtualKeyCode::Up
| VirtualKeyCode::Right
| VirtualKeyCode::Down
| VirtualKeyCode::Left
| VirtualKeyCode::Space => true,
_ => false,
}
}

// Retrieves a layout-independent keycode given an event.
fn retrieve_keycode(event: id) -> Option<VirtualKeyCode> {
#[inline]
Expand Down Expand Up @@ -637,7 +719,7 @@ fn update_potentially_stale_modifiers(state: &mut ViewState, event: id) {
}
}

extern "C" fn key_down(this: &Object, _sel: Sel, event: id) {
extern "C" fn key_down(this: &mut Object, _sel: Sel, event: id) {
komi1230 marked this conversation as resolved.
Show resolved Hide resolved
trace!("Triggered `keyDown`");
unsafe {
let state_ptr: *mut c_void = *this.get_ivar("winitState");
Expand Down Expand Up @@ -686,6 +768,23 @@ extern "C" fn key_down(this: &Object, _sel: Sel, event: id) {
};

if pass_along {
// Use IME
let is_ime_activated: bool = *this.get_ivar("isIMEActivated");
if is_ime_activated && is_arrow_or_space_key(virtual_keycode.unwrap()) {
(*this).set_ivar("isPreediting", true);
let marked_text_ref: &mut id = this.get_mut_ivar("markedText");
let composed_string = marked_text_ref.clone().string();
let slice = slice::from_raw_parts(
composed_string.UTF8String() as *const c_uchar,
composed_string.len(),
);
let composed_string = str::from_utf8_unchecked(slice);
delete_marked_text(state, composed_string.chars().count() as i32);
komi1230 marked this conversation as resolved.
Show resolved Hide resolved
}

// Clear them here so that we can know whether they have changed afterwards.
let _: () = msg_send![this, clearMarkedText];

komi1230 marked this conversation as resolved.
Show resolved Hide resolved
// Some keys (and only *some*, with no known reason) don't trigger `insertText`, while others do...
// So, we don't give repeats the opportunity to trigger that, since otherwise our hack will cause some
// keys to generate twice as many characters.
Expand Down