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