1use super::{events::key_to_native, BoolExt};
2use crate::{
3 Action, AnyWindowHandle, BackgroundExecutor, ClipboardItem, CursorStyle, DisplayId,
4 ForegroundExecutor, Keymap, MacDispatcher, MacDisplay, MacTextSystem, MacWindow, Menu,
5 MenuItem, PathPromptOptions, Platform, PlatformDisplay, PlatformInput, PlatformTextSystem,
6 PlatformWindow, Result, SemanticVersion, Task, WindowAppearance, WindowOptions,
7};
8use anyhow::{anyhow, bail};
9use block::ConcreteBlock;
10use cocoa::{
11 appkit::{
12 NSApplication, NSApplicationActivationPolicy::NSApplicationActivationPolicyRegular,
13 NSEventModifierFlags, NSMenu, NSMenuItem, NSModalResponse, NSOpenPanel, NSPasteboard,
14 NSPasteboardTypeString, NSSavePanel, NSWindow,
15 },
16 base::{id, nil, selector, BOOL, YES},
17 foundation::{
18 NSArray, NSAutoreleasePool, NSBundle, NSData, NSInteger, NSProcessInfo, NSString,
19 NSUInteger, NSURL,
20 },
21};
22use core_foundation::{
23 base::{CFType, CFTypeRef, OSStatus, TCFType as _},
24 boolean::CFBoolean,
25 data::CFData,
26 dictionary::{CFDictionary, CFDictionaryRef, CFMutableDictionary},
27 string::{CFString, CFStringRef},
28};
29use ctor::ctor;
30use futures::channel::oneshot;
31use objc::{
32 class,
33 declare::ClassDecl,
34 msg_send,
35 runtime::{Class, Object, Sel},
36 sel, sel_impl,
37};
38use parking_lot::Mutex;
39use ptr::null_mut;
40use std::{
41 cell::Cell,
42 convert::TryInto,
43 ffi::{c_void, CStr, OsStr},
44 os::{raw::c_char, unix::ffi::OsStrExt},
45 path::{Path, PathBuf},
46 process::Command,
47 ptr,
48 rc::Rc,
49 slice, str,
50 sync::Arc,
51 time::Duration,
52};
53use time::UtcOffset;
54
55use super::renderer;
56
57#[allow(non_upper_case_globals)]
58const NSUTF8StringEncoding: NSUInteger = 4;
59
60const MAC_PLATFORM_IVAR: &str = "platform";
61static mut APP_CLASS: *const Class = ptr::null();
62static mut APP_DELEGATE_CLASS: *const Class = ptr::null();
63
64#[ctor]
65unsafe fn build_classes() {
66 APP_CLASS = {
67 let mut decl = ClassDecl::new("GPUIApplication", class!(NSApplication)).unwrap();
68 decl.add_ivar::<*mut c_void>(MAC_PLATFORM_IVAR);
69 decl.add_method(
70 sel!(sendEvent:),
71 send_event as extern "C" fn(&mut Object, Sel, id),
72 );
73 decl.register()
74 };
75
76 APP_DELEGATE_CLASS = {
77 let mut decl = ClassDecl::new("GPUIApplicationDelegate", class!(NSResponder)).unwrap();
78 decl.add_ivar::<*mut c_void>(MAC_PLATFORM_IVAR);
79 decl.add_method(
80 sel!(applicationDidFinishLaunching:),
81 did_finish_launching as extern "C" fn(&mut Object, Sel, id),
82 );
83 decl.add_method(
84 sel!(applicationShouldHandleReopen:hasVisibleWindows:),
85 should_handle_reopen as extern "C" fn(&mut Object, Sel, id, bool),
86 );
87 decl.add_method(
88 sel!(applicationDidBecomeActive:),
89 did_become_active as extern "C" fn(&mut Object, Sel, id),
90 );
91 decl.add_method(
92 sel!(applicationDidResignActive:),
93 did_resign_active as extern "C" fn(&mut Object, Sel, id),
94 );
95 decl.add_method(
96 sel!(applicationWillTerminate:),
97 will_terminate as extern "C" fn(&mut Object, Sel, id),
98 );
99 decl.add_method(
100 sel!(handleGPUIMenuItem:),
101 handle_menu_item as extern "C" fn(&mut Object, Sel, id),
102 );
103 // Add menu item handlers so that OS save panels have the correct key commands
104 decl.add_method(
105 sel!(cut:),
106 handle_menu_item as extern "C" fn(&mut Object, Sel, id),
107 );
108 decl.add_method(
109 sel!(copy:),
110 handle_menu_item as extern "C" fn(&mut Object, Sel, id),
111 );
112 decl.add_method(
113 sel!(paste:),
114 handle_menu_item as extern "C" fn(&mut Object, Sel, id),
115 );
116 decl.add_method(
117 sel!(selectAll:),
118 handle_menu_item as extern "C" fn(&mut Object, Sel, id),
119 );
120 decl.add_method(
121 sel!(undo:),
122 handle_menu_item as extern "C" fn(&mut Object, Sel, id),
123 );
124 decl.add_method(
125 sel!(redo:),
126 handle_menu_item as extern "C" fn(&mut Object, Sel, id),
127 );
128 decl.add_method(
129 sel!(validateMenuItem:),
130 validate_menu_item as extern "C" fn(&mut Object, Sel, id) -> bool,
131 );
132 decl.add_method(
133 sel!(menuWillOpen:),
134 menu_will_open as extern "C" fn(&mut Object, Sel, id),
135 );
136 decl.add_method(
137 sel!(application:openURLs:),
138 open_urls as extern "C" fn(&mut Object, Sel, id, id),
139 );
140 decl.register()
141 }
142}
143
144pub(crate) struct MacPlatform(Mutex<MacPlatformState>);
145
146pub(crate) struct MacPlatformState {
147 background_executor: BackgroundExecutor,
148 foreground_executor: ForegroundExecutor,
149 text_system: Arc<MacTextSystem>,
150 renderer_context: renderer::Context,
151 pasteboard: id,
152 text_hash_pasteboard_type: id,
153 metadata_pasteboard_type: id,
154 become_active: Option<Box<dyn FnMut()>>,
155 resign_active: Option<Box<dyn FnMut()>>,
156 reopen: Option<Box<dyn FnMut()>>,
157 quit: Option<Box<dyn FnMut()>>,
158 event: Option<Box<dyn FnMut(PlatformInput) -> bool>>,
159 menu_command: Option<Box<dyn FnMut(&dyn Action)>>,
160 validate_menu_command: Option<Box<dyn FnMut(&dyn Action) -> bool>>,
161 will_open_menu: Option<Box<dyn FnMut()>>,
162 menu_actions: Vec<Box<dyn Action>>,
163 open_urls: Option<Box<dyn FnMut(Vec<String>)>>,
164 finish_launching: Option<Box<dyn FnOnce()>>,
165}
166
167impl Default for MacPlatform {
168 fn default() -> Self {
169 Self::new()
170 }
171}
172
173impl MacPlatform {
174 pub(crate) fn new() -> Self {
175 let dispatcher = Arc::new(MacDispatcher::new());
176 Self(Mutex::new(MacPlatformState {
177 background_executor: BackgroundExecutor::new(dispatcher.clone()),
178 foreground_executor: ForegroundExecutor::new(dispatcher),
179 text_system: Arc::new(MacTextSystem::new()),
180 renderer_context: renderer::Context::default(),
181 pasteboard: unsafe { NSPasteboard::generalPasteboard(nil) },
182 text_hash_pasteboard_type: unsafe { ns_string("zed-text-hash") },
183 metadata_pasteboard_type: unsafe { ns_string("zed-metadata") },
184 become_active: None,
185 resign_active: None,
186 reopen: None,
187 quit: None,
188 event: None,
189 menu_command: None,
190 validate_menu_command: None,
191 will_open_menu: None,
192 menu_actions: Default::default(),
193 open_urls: None,
194 finish_launching: None,
195 }))
196 }
197
198 unsafe fn read_from_pasteboard(&self, pasteboard: *mut Object, kind: id) -> Option<&[u8]> {
199 let data = pasteboard.dataForType(kind);
200 if data == nil {
201 None
202 } else {
203 Some(slice::from_raw_parts(
204 data.bytes() as *mut u8,
205 data.length() as usize,
206 ))
207 }
208 }
209
210 unsafe fn create_menu_bar(
211 &self,
212 menus: Vec<Menu>,
213 delegate: id,
214 actions: &mut Vec<Box<dyn Action>>,
215 keymap: &Keymap,
216 ) -> id {
217 let application_menu = NSMenu::new(nil).autorelease();
218 application_menu.setDelegate_(delegate);
219
220 for menu_config in menus {
221 let menu = NSMenu::new(nil).autorelease();
222 menu.setTitle_(ns_string(menu_config.name));
223 menu.setDelegate_(delegate);
224
225 for item_config in menu_config.items {
226 menu.addItem_(Self::create_menu_item(
227 item_config,
228 delegate,
229 actions,
230 keymap,
231 ));
232 }
233
234 let menu_item = NSMenuItem::new(nil).autorelease();
235 menu_item.setSubmenu_(menu);
236 application_menu.addItem_(menu_item);
237
238 if menu_config.name == "Window" {
239 let app: id = msg_send![APP_CLASS, sharedApplication];
240 app.setWindowsMenu_(menu);
241 }
242 }
243
244 application_menu
245 }
246
247 unsafe fn create_menu_item(
248 item: MenuItem,
249 delegate: id,
250 actions: &mut Vec<Box<dyn Action>>,
251 keymap: &Keymap,
252 ) -> id {
253 match item {
254 MenuItem::Separator => NSMenuItem::separatorItem(nil),
255 MenuItem::Action {
256 name,
257 action,
258 os_action,
259 } => {
260 let keystrokes = keymap
261 .bindings_for_action(action.as_ref())
262 .next()
263 .map(|binding| binding.keystrokes());
264
265 let selector = match os_action {
266 Some(crate::OsAction::Cut) => selector("cut:"),
267 Some(crate::OsAction::Copy) => selector("copy:"),
268 Some(crate::OsAction::Paste) => selector("paste:"),
269 Some(crate::OsAction::SelectAll) => selector("selectAll:"),
270 Some(crate::OsAction::Undo) => selector("undo:"),
271 Some(crate::OsAction::Redo) => selector("redo:"),
272 None => selector("handleGPUIMenuItem:"),
273 };
274
275 let item;
276 if let Some(keystrokes) = keystrokes {
277 if keystrokes.len() == 1 {
278 let keystroke = &keystrokes[0];
279 let mut mask = NSEventModifierFlags::empty();
280 for (modifier, flag) in &[
281 (
282 keystroke.modifiers.command,
283 NSEventModifierFlags::NSCommandKeyMask,
284 ),
285 (
286 keystroke.modifiers.control,
287 NSEventModifierFlags::NSControlKeyMask,
288 ),
289 (
290 keystroke.modifiers.alt,
291 NSEventModifierFlags::NSAlternateKeyMask,
292 ),
293 (
294 keystroke.modifiers.shift,
295 NSEventModifierFlags::NSShiftKeyMask,
296 ),
297 ] {
298 if *modifier {
299 mask |= *flag;
300 }
301 }
302
303 item = NSMenuItem::alloc(nil)
304 .initWithTitle_action_keyEquivalent_(
305 ns_string(name),
306 selector,
307 ns_string(key_to_native(&keystroke.key).as_ref()),
308 )
309 .autorelease();
310 item.setKeyEquivalentModifierMask_(mask);
311 }
312 // For multi-keystroke bindings, render the keystroke as part of the title.
313 else {
314 use std::fmt::Write;
315
316 let mut name = format!("{name} [");
317 for (i, keystroke) in keystrokes.iter().enumerate() {
318 if i > 0 {
319 name.push(' ');
320 }
321 write!(&mut name, "{}", keystroke).unwrap();
322 }
323 name.push(']');
324
325 item = NSMenuItem::alloc(nil)
326 .initWithTitle_action_keyEquivalent_(
327 ns_string(&name),
328 selector,
329 ns_string(""),
330 )
331 .autorelease();
332 }
333 } else {
334 item = NSMenuItem::alloc(nil)
335 .initWithTitle_action_keyEquivalent_(
336 ns_string(name),
337 selector,
338 ns_string(""),
339 )
340 .autorelease();
341 }
342
343 let tag = actions.len() as NSInteger;
344 let _: () = msg_send![item, setTag: tag];
345 actions.push(action);
346 item
347 }
348 MenuItem::Submenu(Menu { name, items }) => {
349 let item = NSMenuItem::new(nil).autorelease();
350 let submenu = NSMenu::new(nil).autorelease();
351 submenu.setDelegate_(delegate);
352 for item in items {
353 submenu.addItem_(Self::create_menu_item(item, delegate, actions, keymap));
354 }
355 item.setSubmenu_(submenu);
356 item.setTitle_(ns_string(name));
357 item
358 }
359 }
360 }
361}
362
363impl Platform for MacPlatform {
364 fn background_executor(&self) -> BackgroundExecutor {
365 self.0.lock().background_executor.clone()
366 }
367
368 fn foreground_executor(&self) -> crate::ForegroundExecutor {
369 self.0.lock().foreground_executor.clone()
370 }
371
372 fn text_system(&self) -> Arc<dyn PlatformTextSystem> {
373 self.0.lock().text_system.clone()
374 }
375
376 fn run(&self, on_finish_launching: Box<dyn FnOnce()>) {
377 self.0.lock().finish_launching = Some(on_finish_launching);
378
379 unsafe {
380 let app: id = msg_send![APP_CLASS, sharedApplication];
381 let app_delegate: id = msg_send![APP_DELEGATE_CLASS, new];
382 app.setDelegate_(app_delegate);
383
384 let self_ptr = self as *const Self as *const c_void;
385 (*app).set_ivar(MAC_PLATFORM_IVAR, self_ptr);
386 (*app_delegate).set_ivar(MAC_PLATFORM_IVAR, self_ptr);
387
388 let pool = NSAutoreleasePool::new(nil);
389 app.run();
390 pool.drain();
391
392 (*app).set_ivar(MAC_PLATFORM_IVAR, null_mut::<c_void>());
393 (*app.delegate()).set_ivar(MAC_PLATFORM_IVAR, null_mut::<c_void>());
394 }
395 }
396
397 fn quit(&self) {
398 // Quitting the app causes us to close windows, which invokes `Window::on_close` callbacks
399 // synchronously before this method terminates. If we call `Platform::quit` while holding a
400 // borrow of the app state (which most of the time we will do), we will end up
401 // double-borrowing the app state in the `on_close` callbacks for our open windows. To solve
402 // this, we make quitting the application asynchronous so that we aren't holding borrows to
403 // the app state on the stack when we actually terminate the app.
404
405 use super::dispatcher::{dispatch_get_main_queue, dispatch_sys::dispatch_async_f};
406
407 unsafe {
408 dispatch_async_f(dispatch_get_main_queue(), ptr::null_mut(), Some(quit));
409 }
410
411 unsafe extern "C" fn quit(_: *mut c_void) {
412 let app = NSApplication::sharedApplication(nil);
413 let _: () = msg_send![app, terminate: nil];
414 }
415 }
416
417 fn restart(&self) {
418 use std::os::unix::process::CommandExt as _;
419
420 let app_pid = std::process::id().to_string();
421 let app_path = self
422 .app_path()
423 .ok()
424 // When the app is not bundled, `app_path` returns the
425 // directory containing the executable. Disregard this
426 // and get the path to the executable itself.
427 .and_then(|path| (path.extension()?.to_str()? == "app").then_some(path))
428 .unwrap_or_else(|| std::env::current_exe().unwrap());
429
430 // Wait until this process has exited and then re-open this path.
431 let script = r#"
432 while kill -0 $0 2> /dev/null; do
433 sleep 0.1
434 done
435 open "$1"
436 "#;
437
438 let restart_process = Command::new("/bin/bash")
439 .arg("-c")
440 .arg(script)
441 .arg(app_pid)
442 .arg(app_path)
443 .process_group(0)
444 .spawn();
445
446 match restart_process {
447 Ok(_) => self.quit(),
448 Err(e) => log::error!("failed to spawn restart script: {:?}", e),
449 }
450 }
451
452 fn activate(&self, ignoring_other_apps: bool) {
453 unsafe {
454 let app = NSApplication::sharedApplication(nil);
455 app.activateIgnoringOtherApps_(ignoring_other_apps.to_objc());
456 }
457 }
458
459 fn hide(&self) {
460 unsafe {
461 let app = NSApplication::sharedApplication(nil);
462 let _: () = msg_send![app, hide: nil];
463 }
464 }
465
466 fn hide_other_apps(&self) {
467 unsafe {
468 let app = NSApplication::sharedApplication(nil);
469 let _: () = msg_send![app, hideOtherApplications: nil];
470 }
471 }
472
473 fn unhide_other_apps(&self) {
474 unsafe {
475 let app = NSApplication::sharedApplication(nil);
476 let _: () = msg_send![app, unhideAllApplications: nil];
477 }
478 }
479
480 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
481 MacDisplay::all()
482 .map(|screen| Rc::new(screen) as Rc<_>)
483 .collect()
484 }
485
486 fn display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
487 MacDisplay::find_by_id(id).map(|screen| Rc::new(screen) as Rc<_>)
488 }
489
490 fn active_window(&self) -> Option<AnyWindowHandle> {
491 MacWindow::active_window()
492 }
493
494 fn open_window(
495 &self,
496 handle: AnyWindowHandle,
497 options: WindowOptions,
498 ) -> Box<dyn PlatformWindow> {
499 // Clippy thinks that this evaluates to `()`, for some reason.
500 #[allow(clippy::unit_arg, clippy::clone_on_copy)]
501 let renderer_context = self.0.lock().renderer_context.clone();
502 Box::new(MacWindow::open(
503 handle,
504 options,
505 self.foreground_executor(),
506 renderer_context,
507 ))
508 }
509
510 fn window_appearance(&self) -> WindowAppearance {
511 unsafe {
512 let app = NSApplication::sharedApplication(nil);
513 let appearance: id = msg_send![app, effectiveAppearance];
514 WindowAppearance::from_native(appearance)
515 }
516 }
517
518 fn open_url(&self, url: &str) {
519 unsafe {
520 let url = NSURL::alloc(nil)
521 .initWithString_(ns_string(url))
522 .autorelease();
523 let workspace: id = msg_send![class!(NSWorkspace), sharedWorkspace];
524 msg_send![workspace, openURL: url]
525 }
526 }
527
528 fn register_url_scheme(&self, scheme: &str) -> Task<anyhow::Result<()>> {
529 // API only available post Monterey
530 // https://developer.apple.com/documentation/appkit/nsworkspace/3753004-setdefaultapplicationaturl
531 let (done_tx, done_rx) = oneshot::channel();
532 if self.os_version().ok() < Some(SemanticVersion::new(12, 0, 0)) {
533 return Task::ready(Err(anyhow!(
534 "macOS 12.0 or later is required to register URL schemes"
535 )));
536 }
537
538 let bundle_id = unsafe {
539 let bundle: id = msg_send![class!(NSBundle), mainBundle];
540 let bundle_id: id = msg_send![bundle, bundleIdentifier];
541 if bundle_id == nil {
542 return Task::ready(Err(anyhow!("Can only register URL scheme in bundled apps")));
543 }
544 bundle_id
545 };
546
547 unsafe {
548 let workspace: id = msg_send![class!(NSWorkspace), sharedWorkspace];
549 let scheme: id = ns_string(scheme);
550 let app: id = msg_send![workspace, URLForApplicationWithBundleIdentifier: bundle_id];
551 if app == nil {
552 return Task::ready(Err(anyhow!(
553 "Cannot register URL scheme until app is installed"
554 )));
555 }
556 let done_tx = Cell::new(Some(done_tx));
557 let block = ConcreteBlock::new(move |error: id| {
558 let result = if error == nil {
559 Ok(())
560 } else {
561 let msg: id = msg_send![error, localizedDescription];
562 Err(anyhow!("Failed to register: {:?}", msg))
563 };
564
565 if let Some(done_tx) = done_tx.take() {
566 let _ = done_tx.send(result);
567 }
568 });
569 let _: () = msg_send![workspace, setDefaultApplicationAtURL: app toOpenURLsWithScheme: scheme completionHandler: block];
570 }
571
572 self.background_executor()
573 .spawn(async { crate::Flatten::flatten(done_rx.await.map_err(|e| anyhow!(e))) })
574 }
575
576 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>) {
577 self.0.lock().open_urls = Some(callback);
578 }
579
580 fn prompt_for_paths(
581 &self,
582 options: PathPromptOptions,
583 ) -> oneshot::Receiver<Option<Vec<PathBuf>>> {
584 let (done_tx, done_rx) = oneshot::channel();
585 self.foreground_executor()
586 .spawn(async move {
587 unsafe {
588 let panel = NSOpenPanel::openPanel(nil);
589 panel.setCanChooseDirectories_(options.directories.to_objc());
590 panel.setCanChooseFiles_(options.files.to_objc());
591 panel.setAllowsMultipleSelection_(options.multiple.to_objc());
592 panel.setResolvesAliases_(false.to_objc());
593 let done_tx = Cell::new(Some(done_tx));
594 let block = ConcreteBlock::new(move |response: NSModalResponse| {
595 let result = if response == NSModalResponse::NSModalResponseOk {
596 let mut result = Vec::new();
597 let urls = panel.URLs();
598 for i in 0..urls.count() {
599 let url = urls.objectAtIndex(i);
600 if url.isFileURL() == YES {
601 if let Ok(path) = ns_url_to_path(url) {
602 result.push(path)
603 }
604 }
605 }
606 Some(result)
607 } else {
608 None
609 };
610
611 if let Some(done_tx) = done_tx.take() {
612 let _ = done_tx.send(result);
613 }
614 });
615 let block = block.copy();
616 let _: () = msg_send![panel, beginWithCompletionHandler: block];
617 }
618 })
619 .detach();
620 done_rx
621 }
622
623 fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>> {
624 let directory = directory.to_owned();
625 let (done_tx, done_rx) = oneshot::channel();
626 self.foreground_executor()
627 .spawn(async move {
628 unsafe {
629 let panel = NSSavePanel::savePanel(nil);
630 let path = ns_string(directory.to_string_lossy().as_ref());
631 let url = NSURL::fileURLWithPath_isDirectory_(nil, path, true.to_objc());
632 panel.setDirectoryURL(url);
633
634 let done_tx = Cell::new(Some(done_tx));
635 let block = ConcreteBlock::new(move |response: NSModalResponse| {
636 let mut result = None;
637 if response == NSModalResponse::NSModalResponseOk {
638 let url = panel.URL();
639 if url.isFileURL() == YES {
640 result = ns_url_to_path(panel.URL()).ok()
641 }
642 }
643
644 if let Some(done_tx) = done_tx.take() {
645 let _ = done_tx.send(result);
646 }
647 });
648 let block = block.copy();
649 let _: () = msg_send![panel, beginWithCompletionHandler: block];
650 }
651 })
652 .detach();
653
654 done_rx
655 }
656
657 fn reveal_path(&self, path: &Path) {
658 unsafe {
659 let path = path.to_path_buf();
660 self.0
661 .lock()
662 .background_executor
663 .spawn(async move {
664 let full_path = ns_string(path.to_str().unwrap_or(""));
665 let root_full_path = ns_string("");
666 let workspace: id = msg_send![class!(NSWorkspace), sharedWorkspace];
667 let _: BOOL = msg_send![
668 workspace,
669 selectFile: full_path
670 inFileViewerRootedAtPath: root_full_path
671 ];
672 })
673 .detach();
674 }
675 }
676
677 fn on_become_active(&self, callback: Box<dyn FnMut()>) {
678 self.0.lock().become_active = Some(callback);
679 }
680
681 fn on_resign_active(&self, callback: Box<dyn FnMut()>) {
682 self.0.lock().resign_active = Some(callback);
683 }
684
685 fn on_quit(&self, callback: Box<dyn FnMut()>) {
686 self.0.lock().quit = Some(callback);
687 }
688
689 fn on_reopen(&self, callback: Box<dyn FnMut()>) {
690 self.0.lock().reopen = Some(callback);
691 }
692
693 fn on_event(&self, callback: Box<dyn FnMut(PlatformInput) -> bool>) {
694 self.0.lock().event = Some(callback);
695 }
696
697 fn on_app_menu_action(&self, callback: Box<dyn FnMut(&dyn Action)>) {
698 self.0.lock().menu_command = Some(callback);
699 }
700
701 fn on_will_open_app_menu(&self, callback: Box<dyn FnMut()>) {
702 self.0.lock().will_open_menu = Some(callback);
703 }
704
705 fn on_validate_app_menu_command(&self, callback: Box<dyn FnMut(&dyn Action) -> bool>) {
706 self.0.lock().validate_menu_command = Some(callback);
707 }
708
709 fn os_name(&self) -> &'static str {
710 "macOS"
711 }
712
713 fn double_click_interval(&self) -> Duration {
714 unsafe {
715 let double_click_interval: f64 = msg_send![class!(NSEvent), doubleClickInterval];
716 Duration::from_secs_f64(double_click_interval)
717 }
718 }
719
720 fn os_version(&self) -> Result<SemanticVersion> {
721 unsafe {
722 let process_info = NSProcessInfo::processInfo(nil);
723 let version = process_info.operatingSystemVersion();
724 Ok(SemanticVersion {
725 major: version.majorVersion as usize,
726 minor: version.minorVersion as usize,
727 patch: version.patchVersion as usize,
728 })
729 }
730 }
731
732 fn app_version(&self) -> Result<SemanticVersion> {
733 unsafe {
734 let bundle: id = NSBundle::mainBundle();
735 if bundle.is_null() {
736 Err(anyhow!("app is not running inside a bundle"))
737 } else {
738 let version: id = msg_send![bundle, objectForInfoDictionaryKey: ns_string("CFBundleShortVersionString")];
739 if version.is_null() {
740 bail!("bundle does not have version");
741 }
742 let len = msg_send![version, lengthOfBytesUsingEncoding: NSUTF8StringEncoding];
743 let bytes = version.UTF8String() as *const u8;
744 let version = str::from_utf8(slice::from_raw_parts(bytes, len)).unwrap();
745 version.parse()
746 }
747 }
748 }
749
750 fn app_path(&self) -> Result<PathBuf> {
751 unsafe {
752 let bundle: id = NSBundle::mainBundle();
753 if bundle.is_null() {
754 Err(anyhow!("app is not running inside a bundle"))
755 } else {
756 Ok(path_from_objc(msg_send![bundle, bundlePath]))
757 }
758 }
759 }
760
761 fn set_menus(&self, menus: Vec<Menu>, keymap: &Keymap) {
762 unsafe {
763 let app: id = msg_send![APP_CLASS, sharedApplication];
764 let mut state = self.0.lock();
765 let actions = &mut state.menu_actions;
766 app.setMainMenu_(self.create_menu_bar(menus, app.delegate(), actions, keymap));
767 }
768 }
769
770 fn local_timezone(&self) -> UtcOffset {
771 unsafe {
772 let local_timezone: id = msg_send![class!(NSTimeZone), localTimeZone];
773 let seconds_from_gmt: NSInteger = msg_send![local_timezone, secondsFromGMT];
774 UtcOffset::from_whole_seconds(seconds_from_gmt.try_into().unwrap()).unwrap()
775 }
776 }
777
778 fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf> {
779 unsafe {
780 let bundle: id = NSBundle::mainBundle();
781 if bundle.is_null() {
782 Err(anyhow!("app is not running inside a bundle"))
783 } else {
784 let name = ns_string(name);
785 let url: id = msg_send![bundle, URLForAuxiliaryExecutable: name];
786 if url.is_null() {
787 Err(anyhow!("resource not found"))
788 } else {
789 ns_url_to_path(url)
790 }
791 }
792 }
793 }
794
795 /// Match cursor style to one of the styles available
796 /// in macOS's [NSCursor](https://developer.apple.com/documentation/appkit/nscursor).
797 fn set_cursor_style(&self, style: CursorStyle) {
798 unsafe {
799 let new_cursor: id = match style {
800 CursorStyle::Arrow => msg_send![class!(NSCursor), arrowCursor],
801 CursorStyle::IBeam => msg_send![class!(NSCursor), IBeamCursor],
802 CursorStyle::Crosshair => msg_send![class!(NSCursor), crosshairCursor],
803 CursorStyle::ClosedHand => msg_send![class!(NSCursor), closedHandCursor],
804 CursorStyle::OpenHand => msg_send![class!(NSCursor), openHandCursor],
805 CursorStyle::PointingHand => msg_send![class!(NSCursor), pointingHandCursor],
806 CursorStyle::ResizeLeft => msg_send![class!(NSCursor), resizeLeftCursor],
807 CursorStyle::ResizeRight => msg_send![class!(NSCursor), resizeRightCursor],
808 CursorStyle::ResizeLeftRight => msg_send![class!(NSCursor), resizeLeftRightCursor],
809 CursorStyle::ResizeUp => msg_send![class!(NSCursor), resizeUpCursor],
810 CursorStyle::ResizeDown => msg_send![class!(NSCursor), resizeDownCursor],
811 CursorStyle::ResizeUpDown => msg_send![class!(NSCursor), resizeUpDownCursor],
812 CursorStyle::DisappearingItem => {
813 msg_send![class!(NSCursor), disappearingItemCursor]
814 }
815 CursorStyle::IBeamCursorForVerticalLayout => {
816 msg_send![class!(NSCursor), IBeamCursorForVerticalLayout]
817 }
818 CursorStyle::OperationNotAllowed => {
819 msg_send![class!(NSCursor), operationNotAllowedCursor]
820 }
821 CursorStyle::DragLink => msg_send![class!(NSCursor), dragLinkCursor],
822 CursorStyle::DragCopy => msg_send![class!(NSCursor), dragCopyCursor],
823 CursorStyle::ContextualMenu => msg_send![class!(NSCursor), contextualMenuCursor],
824 };
825
826 let old_cursor: id = msg_send![class!(NSCursor), currentCursor];
827 if new_cursor != old_cursor {
828 let _: () = msg_send![new_cursor, set];
829 }
830 }
831 }
832
833 fn should_auto_hide_scrollbars(&self) -> bool {
834 #[allow(non_upper_case_globals)]
835 const NSScrollerStyleOverlay: NSInteger = 1;
836
837 unsafe {
838 let style: NSInteger = msg_send![class!(NSScroller), preferredScrollerStyle];
839 style == NSScrollerStyleOverlay
840 }
841 }
842
843 fn write_to_clipboard(&self, item: ClipboardItem) {
844 let state = self.0.lock();
845 unsafe {
846 state.pasteboard.clearContents();
847
848 let text_bytes = NSData::dataWithBytes_length_(
849 nil,
850 item.text.as_ptr() as *const c_void,
851 item.text.len() as u64,
852 );
853 state
854 .pasteboard
855 .setData_forType(text_bytes, NSPasteboardTypeString);
856
857 if let Some(metadata) = item.metadata.as_ref() {
858 let hash_bytes = ClipboardItem::text_hash(&item.text).to_be_bytes();
859 let hash_bytes = NSData::dataWithBytes_length_(
860 nil,
861 hash_bytes.as_ptr() as *const c_void,
862 hash_bytes.len() as u64,
863 );
864 state
865 .pasteboard
866 .setData_forType(hash_bytes, state.text_hash_pasteboard_type);
867
868 let metadata_bytes = NSData::dataWithBytes_length_(
869 nil,
870 metadata.as_ptr() as *const c_void,
871 metadata.len() as u64,
872 );
873 state
874 .pasteboard
875 .setData_forType(metadata_bytes, state.metadata_pasteboard_type);
876 }
877 }
878 }
879
880 fn read_from_clipboard(&self) -> Option<ClipboardItem> {
881 let state = self.0.lock();
882 unsafe {
883 if let Some(text_bytes) =
884 self.read_from_pasteboard(state.pasteboard, NSPasteboardTypeString)
885 {
886 let text = String::from_utf8_lossy(text_bytes).to_string();
887 let hash_bytes = self
888 .read_from_pasteboard(state.pasteboard, state.text_hash_pasteboard_type)
889 .and_then(|bytes| bytes.try_into().ok())
890 .map(u64::from_be_bytes);
891 let metadata_bytes = self
892 .read_from_pasteboard(state.pasteboard, state.metadata_pasteboard_type)
893 .and_then(|bytes| String::from_utf8(bytes.to_vec()).ok());
894
895 if let Some((hash, metadata)) = hash_bytes.zip(metadata_bytes) {
896 if hash == ClipboardItem::text_hash(&text) {
897 Some(ClipboardItem {
898 text,
899 metadata: Some(metadata),
900 })
901 } else {
902 Some(ClipboardItem {
903 text,
904 metadata: None,
905 })
906 }
907 } else {
908 Some(ClipboardItem {
909 text,
910 metadata: None,
911 })
912 }
913 } else {
914 None
915 }
916 }
917 }
918
919 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Task<Result<()>> {
920 let url = url.to_string();
921 let username = username.to_string();
922 let password = password.to_vec();
923 self.background_executor().spawn(async move {
924 unsafe {
925 use security::*;
926
927 let url = CFString::from(url.as_str());
928 let username = CFString::from(username.as_str());
929 let password = CFData::from_buffer(&password);
930
931 // First, check if there are already credentials for the given server. If so, then
932 // update the username and password.
933 let mut verb = "updating";
934 let mut query_attrs = CFMutableDictionary::with_capacity(2);
935 query_attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
936 query_attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
937
938 let mut attrs = CFMutableDictionary::with_capacity(4);
939 attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
940 attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
941 attrs.set(kSecAttrAccount as *const _, username.as_CFTypeRef());
942 attrs.set(kSecValueData as *const _, password.as_CFTypeRef());
943
944 let mut status = SecItemUpdate(
945 query_attrs.as_concrete_TypeRef(),
946 attrs.as_concrete_TypeRef(),
947 );
948
949 // If there were no existing credentials for the given server, then create them.
950 if status == errSecItemNotFound {
951 verb = "creating";
952 status = SecItemAdd(attrs.as_concrete_TypeRef(), ptr::null_mut());
953 }
954
955 if status != errSecSuccess {
956 return Err(anyhow!("{} password failed: {}", verb, status));
957 }
958 }
959 Ok(())
960 })
961 }
962
963 fn read_credentials(&self, url: &str) -> Task<Result<Option<(String, Vec<u8>)>>> {
964 let url = url.to_string();
965 self.background_executor().spawn(async move {
966 let url = CFString::from(url.as_str());
967 let cf_true = CFBoolean::true_value().as_CFTypeRef();
968
969 unsafe {
970 use security::*;
971
972 // Find any credentials for the given server URL.
973 let mut attrs = CFMutableDictionary::with_capacity(5);
974 attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
975 attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
976 attrs.set(kSecReturnAttributes as *const _, cf_true);
977 attrs.set(kSecReturnData as *const _, cf_true);
978
979 let mut result = CFTypeRef::from(ptr::null());
980 let status = SecItemCopyMatching(attrs.as_concrete_TypeRef(), &mut result);
981 match status {
982 security::errSecSuccess => {}
983 security::errSecItemNotFound | security::errSecUserCanceled => return Ok(None),
984 _ => return Err(anyhow!("reading password failed: {}", status)),
985 }
986
987 let result = CFType::wrap_under_create_rule(result)
988 .downcast::<CFDictionary>()
989 .ok_or_else(|| anyhow!("keychain item was not a dictionary"))?;
990 let username = result
991 .find(kSecAttrAccount as *const _)
992 .ok_or_else(|| anyhow!("account was missing from keychain item"))?;
993 let username = CFType::wrap_under_get_rule(*username)
994 .downcast::<CFString>()
995 .ok_or_else(|| anyhow!("account was not a string"))?;
996 let password = result
997 .find(kSecValueData as *const _)
998 .ok_or_else(|| anyhow!("password was missing from keychain item"))?;
999 let password = CFType::wrap_under_get_rule(*password)
1000 .downcast::<CFData>()
1001 .ok_or_else(|| anyhow!("password was not a string"))?;
1002
1003 Ok(Some((username.to_string(), password.bytes().to_vec())))
1004 }
1005 })
1006 }
1007
1008 fn delete_credentials(&self, url: &str) -> Task<Result<()>> {
1009 let url = url.to_string();
1010
1011 self.background_executor().spawn(async move {
1012 unsafe {
1013 use security::*;
1014
1015 let url = CFString::from(url.as_str());
1016 let mut query_attrs = CFMutableDictionary::with_capacity(2);
1017 query_attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
1018 query_attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
1019
1020 let status = SecItemDelete(query_attrs.as_concrete_TypeRef());
1021
1022 if status != errSecSuccess {
1023 return Err(anyhow!("delete password failed: {}", status));
1024 }
1025 }
1026 Ok(())
1027 })
1028 }
1029}
1030
1031unsafe fn path_from_objc(path: id) -> PathBuf {
1032 let len = msg_send![path, lengthOfBytesUsingEncoding: NSUTF8StringEncoding];
1033 let bytes = path.UTF8String() as *const u8;
1034 let path = str::from_utf8(slice::from_raw_parts(bytes, len)).unwrap();
1035 PathBuf::from(path)
1036}
1037
1038unsafe fn get_mac_platform(object: &mut Object) -> &MacPlatform {
1039 let platform_ptr: *mut c_void = *object.get_ivar(MAC_PLATFORM_IVAR);
1040 assert!(!platform_ptr.is_null());
1041 &*(platform_ptr as *const MacPlatform)
1042}
1043
1044extern "C" fn send_event(this: &mut Object, _sel: Sel, native_event: id) {
1045 unsafe {
1046 if let Some(event) = PlatformInput::from_native(native_event, None) {
1047 let platform = get_mac_platform(this);
1048 let mut lock = platform.0.lock();
1049 if let Some(mut callback) = lock.event.take() {
1050 drop(lock);
1051 let result = callback(event);
1052 platform.0.lock().event.get_or_insert(callback);
1053 if !result {
1054 return;
1055 }
1056 }
1057 }
1058 msg_send![super(this, class!(NSApplication)), sendEvent: native_event]
1059 }
1060}
1061
1062extern "C" fn did_finish_launching(this: &mut Object, _: Sel, _: id) {
1063 unsafe {
1064 let app: id = msg_send![APP_CLASS, sharedApplication];
1065 app.setActivationPolicy_(NSApplicationActivationPolicyRegular);
1066
1067 let platform = get_mac_platform(this);
1068 let callback = platform.0.lock().finish_launching.take();
1069 if let Some(callback) = callback {
1070 callback();
1071 }
1072 }
1073}
1074
1075extern "C" fn should_handle_reopen(this: &mut Object, _: Sel, _: id, has_open_windows: bool) {
1076 if !has_open_windows {
1077 let platform = unsafe { get_mac_platform(this) };
1078 let mut lock = platform.0.lock();
1079 if let Some(mut callback) = lock.reopen.take() {
1080 drop(lock);
1081 callback();
1082 platform.0.lock().reopen.get_or_insert(callback);
1083 }
1084 }
1085}
1086
1087extern "C" fn did_become_active(this: &mut Object, _: Sel, _: id) {
1088 let platform = unsafe { get_mac_platform(this) };
1089 let mut lock = platform.0.lock();
1090 if let Some(mut callback) = lock.become_active.take() {
1091 drop(lock);
1092 callback();
1093 platform.0.lock().become_active.get_or_insert(callback);
1094 }
1095}
1096
1097extern "C" fn did_resign_active(this: &mut Object, _: Sel, _: id) {
1098 let platform = unsafe { get_mac_platform(this) };
1099 let mut lock = platform.0.lock();
1100 if let Some(mut callback) = lock.resign_active.take() {
1101 drop(lock);
1102 callback();
1103 platform.0.lock().resign_active.get_or_insert(callback);
1104 }
1105}
1106
1107extern "C" fn will_terminate(this: &mut Object, _: Sel, _: id) {
1108 let platform = unsafe { get_mac_platform(this) };
1109 let mut lock = platform.0.lock();
1110 if let Some(mut callback) = lock.quit.take() {
1111 drop(lock);
1112 callback();
1113 platform.0.lock().quit.get_or_insert(callback);
1114 }
1115}
1116
1117extern "C" fn open_urls(this: &mut Object, _: Sel, _: id, urls: id) {
1118 let urls = unsafe {
1119 (0..urls.count())
1120 .filter_map(|i| {
1121 let url = urls.objectAtIndex(i);
1122 match CStr::from_ptr(url.absoluteString().UTF8String() as *mut c_char).to_str() {
1123 Ok(string) => Some(string.to_string()),
1124 Err(err) => {
1125 log::error!("error converting path to string: {}", err);
1126 None
1127 }
1128 }
1129 })
1130 .collect::<Vec<_>>()
1131 };
1132 let platform = unsafe { get_mac_platform(this) };
1133 let mut lock = platform.0.lock();
1134 if let Some(mut callback) = lock.open_urls.take() {
1135 drop(lock);
1136 callback(urls);
1137 platform.0.lock().open_urls.get_or_insert(callback);
1138 }
1139}
1140
1141extern "C" fn handle_menu_item(this: &mut Object, _: Sel, item: id) {
1142 unsafe {
1143 let platform = get_mac_platform(this);
1144 let mut lock = platform.0.lock();
1145 if let Some(mut callback) = lock.menu_command.take() {
1146 let tag: NSInteger = msg_send![item, tag];
1147 let index = tag as usize;
1148 if let Some(action) = lock.menu_actions.get(index) {
1149 let action = action.boxed_clone();
1150 drop(lock);
1151 callback(&*action);
1152 }
1153 platform.0.lock().menu_command.get_or_insert(callback);
1154 }
1155 }
1156}
1157
1158extern "C" fn validate_menu_item(this: &mut Object, _: Sel, item: id) -> bool {
1159 unsafe {
1160 let mut result = false;
1161 let platform = get_mac_platform(this);
1162 let mut lock = platform.0.lock();
1163 if let Some(mut callback) = lock.validate_menu_command.take() {
1164 let tag: NSInteger = msg_send![item, tag];
1165 let index = tag as usize;
1166 if let Some(action) = lock.menu_actions.get(index) {
1167 let action = action.boxed_clone();
1168 drop(lock);
1169 result = callback(action.as_ref());
1170 }
1171 platform
1172 .0
1173 .lock()
1174 .validate_menu_command
1175 .get_or_insert(callback);
1176 }
1177 result
1178 }
1179}
1180
1181extern "C" fn menu_will_open(this: &mut Object, _: Sel, _: id) {
1182 unsafe {
1183 let platform = get_mac_platform(this);
1184 let mut lock = platform.0.lock();
1185 if let Some(mut callback) = lock.will_open_menu.take() {
1186 drop(lock);
1187 callback();
1188 platform.0.lock().will_open_menu.get_or_insert(callback);
1189 }
1190 }
1191}
1192
1193unsafe fn ns_string(string: &str) -> id {
1194 NSString::alloc(nil).init_str(string).autorelease()
1195}
1196
1197unsafe fn ns_url_to_path(url: id) -> Result<PathBuf> {
1198 let path: *mut c_char = msg_send![url, fileSystemRepresentation];
1199 if path.is_null() {
1200 Err(anyhow!(
1201 "url is not a file path: {}",
1202 CStr::from_ptr(url.absoluteString().UTF8String()).to_string_lossy()
1203 ))
1204 } else {
1205 Ok(PathBuf::from(OsStr::from_bytes(
1206 CStr::from_ptr(path).to_bytes(),
1207 )))
1208 }
1209}
1210
1211mod security {
1212 #![allow(non_upper_case_globals)]
1213 use super::*;
1214
1215 #[link(name = "Security", kind = "framework")]
1216 extern "C" {
1217 pub static kSecClass: CFStringRef;
1218 pub static kSecClassInternetPassword: CFStringRef;
1219 pub static kSecAttrServer: CFStringRef;
1220 pub static kSecAttrAccount: CFStringRef;
1221 pub static kSecValueData: CFStringRef;
1222 pub static kSecReturnAttributes: CFStringRef;
1223 pub static kSecReturnData: CFStringRef;
1224
1225 pub fn SecItemAdd(attributes: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
1226 pub fn SecItemUpdate(query: CFDictionaryRef, attributes: CFDictionaryRef) -> OSStatus;
1227 pub fn SecItemDelete(query: CFDictionaryRef) -> OSStatus;
1228 pub fn SecItemCopyMatching(query: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
1229 }
1230
1231 pub const errSecSuccess: OSStatus = 0;
1232 pub const errSecUserCanceled: OSStatus = -128;
1233 pub const errSecItemNotFound: OSStatus = -25300;
1234}
1235
1236#[cfg(test)]
1237mod tests {
1238 use crate::ClipboardItem;
1239
1240 use super::*;
1241
1242 #[test]
1243 fn test_clipboard() {
1244 let platform = build_platform();
1245 assert_eq!(platform.read_from_clipboard(), None);
1246
1247 let item = ClipboardItem::new("1".to_string());
1248 platform.write_to_clipboard(item.clone());
1249 assert_eq!(platform.read_from_clipboard(), Some(item));
1250
1251 let item = ClipboardItem::new("2".to_string()).with_metadata(vec![3, 4]);
1252 platform.write_to_clipboard(item.clone());
1253 assert_eq!(platform.read_from_clipboard(), Some(item));
1254
1255 let text_from_other_app = "text from other app";
1256 unsafe {
1257 let bytes = NSData::dataWithBytes_length_(
1258 nil,
1259 text_from_other_app.as_ptr() as *const c_void,
1260 text_from_other_app.len() as u64,
1261 );
1262 platform
1263 .0
1264 .lock()
1265 .pasteboard
1266 .setData_forType(bytes, NSPasteboardTypeString);
1267 }
1268 assert_eq!(
1269 platform.read_from_clipboard(),
1270 Some(ClipboardItem::new(text_from_other_app.to_string()))
1271 );
1272 }
1273
1274 fn build_platform() -> MacPlatform {
1275 let platform = MacPlatform::new();
1276 platform.0.lock().pasteboard = unsafe { NSPasteboard::pasteboardWithUniqueName(nil) };
1277 platform
1278 }
1279}