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;
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 instance_buffer_pool: Arc<Mutex<Vec<metal::Buffer>>>,
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 instance_buffer_pool: Arc::default(),
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 let instance_buffer_pool = self.0.lock().instance_buffer_pool.clone();
498 Box::new(MacWindow::open(
499 handle,
500 options,
501 self.foreground_executor(),
502 instance_buffer_pool,
503 ))
504 }
505
506 fn window_appearance(&self) -> WindowAppearance {
507 unsafe {
508 let app = NSApplication::sharedApplication(nil);
509 let appearance: id = msg_send![app, effectiveAppearance];
510 WindowAppearance::from_native(appearance)
511 }
512 }
513
514 fn open_url(&self, url: &str) {
515 unsafe {
516 let url = NSURL::alloc(nil)
517 .initWithString_(ns_string(url))
518 .autorelease();
519 let workspace: id = msg_send![class!(NSWorkspace), sharedWorkspace];
520 msg_send![workspace, openURL: url]
521 }
522 }
523
524 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>) {
525 self.0.lock().open_urls = Some(callback);
526 }
527
528 fn prompt_for_paths(
529 &self,
530 options: PathPromptOptions,
531 ) -> oneshot::Receiver<Option<Vec<PathBuf>>> {
532 let (done_tx, done_rx) = oneshot::channel();
533 self.foreground_executor()
534 .spawn(async move {
535 unsafe {
536 let panel = NSOpenPanel::openPanel(nil);
537 panel.setCanChooseDirectories_(options.directories.to_objc());
538 panel.setCanChooseFiles_(options.files.to_objc());
539 panel.setAllowsMultipleSelection_(options.multiple.to_objc());
540 panel.setResolvesAliases_(false.to_objc());
541 let done_tx = Cell::new(Some(done_tx));
542 let block = ConcreteBlock::new(move |response: NSModalResponse| {
543 let result = if response == NSModalResponse::NSModalResponseOk {
544 let mut result = Vec::new();
545 let urls = panel.URLs();
546 for i in 0..urls.count() {
547 let url = urls.objectAtIndex(i);
548 if url.isFileURL() == YES {
549 if let Ok(path) = ns_url_to_path(url) {
550 result.push(path)
551 }
552 }
553 }
554 Some(result)
555 } else {
556 None
557 };
558
559 if let Some(done_tx) = done_tx.take() {
560 let _ = done_tx.send(result);
561 }
562 });
563 let block = block.copy();
564 let _: () = msg_send![panel, beginWithCompletionHandler: block];
565 }
566 })
567 .detach();
568 done_rx
569 }
570
571 fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>> {
572 let directory = directory.to_owned();
573 let (done_tx, done_rx) = oneshot::channel();
574 self.foreground_executor()
575 .spawn(async move {
576 unsafe {
577 let panel = NSSavePanel::savePanel(nil);
578 let path = ns_string(directory.to_string_lossy().as_ref());
579 let url = NSURL::fileURLWithPath_isDirectory_(nil, path, true.to_objc());
580 panel.setDirectoryURL(url);
581
582 let done_tx = Cell::new(Some(done_tx));
583 let block = ConcreteBlock::new(move |response: NSModalResponse| {
584 let mut result = None;
585 if response == NSModalResponse::NSModalResponseOk {
586 let url = panel.URL();
587 if url.isFileURL() == YES {
588 result = ns_url_to_path(panel.URL()).ok()
589 }
590 }
591
592 if let Some(done_tx) = done_tx.take() {
593 let _ = done_tx.send(result);
594 }
595 });
596 let block = block.copy();
597 let _: () = msg_send![panel, beginWithCompletionHandler: block];
598 }
599 })
600 .detach();
601
602 done_rx
603 }
604
605 fn reveal_path(&self, path: &Path) {
606 unsafe {
607 let path = path.to_path_buf();
608 self.0
609 .lock()
610 .background_executor
611 .spawn(async move {
612 let full_path = ns_string(path.to_str().unwrap_or(""));
613 let root_full_path = ns_string("");
614 let workspace: id = msg_send![class!(NSWorkspace), sharedWorkspace];
615 let _: BOOL = msg_send![
616 workspace,
617 selectFile: full_path
618 inFileViewerRootedAtPath: root_full_path
619 ];
620 })
621 .detach();
622 }
623 }
624
625 fn on_become_active(&self, callback: Box<dyn FnMut()>) {
626 self.0.lock().become_active = Some(callback);
627 }
628
629 fn on_resign_active(&self, callback: Box<dyn FnMut()>) {
630 self.0.lock().resign_active = Some(callback);
631 }
632
633 fn on_quit(&self, callback: Box<dyn FnMut()>) {
634 self.0.lock().quit = Some(callback);
635 }
636
637 fn on_reopen(&self, callback: Box<dyn FnMut()>) {
638 self.0.lock().reopen = Some(callback);
639 }
640
641 fn on_event(&self, callback: Box<dyn FnMut(PlatformInput) -> bool>) {
642 self.0.lock().event = Some(callback);
643 }
644
645 fn on_app_menu_action(&self, callback: Box<dyn FnMut(&dyn Action)>) {
646 self.0.lock().menu_command = Some(callback);
647 }
648
649 fn on_will_open_app_menu(&self, callback: Box<dyn FnMut()>) {
650 self.0.lock().will_open_menu = Some(callback);
651 }
652
653 fn on_validate_app_menu_command(&self, callback: Box<dyn FnMut(&dyn Action) -> bool>) {
654 self.0.lock().validate_menu_command = Some(callback);
655 }
656
657 fn os_name(&self) -> &'static str {
658 "macOS"
659 }
660
661 fn double_click_interval(&self) -> Duration {
662 unsafe {
663 let double_click_interval: f64 = msg_send![class!(NSEvent), doubleClickInterval];
664 Duration::from_secs_f64(double_click_interval)
665 }
666 }
667
668 fn os_version(&self) -> Result<SemanticVersion> {
669 unsafe {
670 let process_info = NSProcessInfo::processInfo(nil);
671 let version = process_info.operatingSystemVersion();
672 Ok(SemanticVersion {
673 major: version.majorVersion as usize,
674 minor: version.minorVersion as usize,
675 patch: version.patchVersion as usize,
676 })
677 }
678 }
679
680 fn app_version(&self) -> Result<SemanticVersion> {
681 unsafe {
682 let bundle: id = NSBundle::mainBundle();
683 if bundle.is_null() {
684 Err(anyhow!("app is not running inside a bundle"))
685 } else {
686 let version: id = msg_send![bundle, objectForInfoDictionaryKey: ns_string("CFBundleShortVersionString")];
687 let len = msg_send![version, lengthOfBytesUsingEncoding: NSUTF8StringEncoding];
688 let bytes = version.UTF8String() as *const u8;
689 let version = str::from_utf8(slice::from_raw_parts(bytes, len)).unwrap();
690 version.parse()
691 }
692 }
693 }
694
695 fn app_path(&self) -> Result<PathBuf> {
696 unsafe {
697 let bundle: id = NSBundle::mainBundle();
698 if bundle.is_null() {
699 Err(anyhow!("app is not running inside a bundle"))
700 } else {
701 Ok(path_from_objc(msg_send![bundle, bundlePath]))
702 }
703 }
704 }
705
706 fn set_menus(&self, menus: Vec<Menu>, keymap: &Keymap) {
707 unsafe {
708 let app: id = msg_send![APP_CLASS, sharedApplication];
709 let mut state = self.0.lock();
710 let actions = &mut state.menu_actions;
711 app.setMainMenu_(self.create_menu_bar(menus, app.delegate(), actions, keymap));
712 }
713 }
714
715 fn local_timezone(&self) -> UtcOffset {
716 unsafe {
717 let local_timezone: id = msg_send![class!(NSTimeZone), localTimeZone];
718 let seconds_from_gmt: NSInteger = msg_send![local_timezone, secondsFromGMT];
719 UtcOffset::from_whole_seconds(seconds_from_gmt.try_into().unwrap()).unwrap()
720 }
721 }
722
723 fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf> {
724 unsafe {
725 let bundle: id = NSBundle::mainBundle();
726 if bundle.is_null() {
727 Err(anyhow!("app is not running inside a bundle"))
728 } else {
729 let name = ns_string(name);
730 let url: id = msg_send![bundle, URLForAuxiliaryExecutable: name];
731 if url.is_null() {
732 Err(anyhow!("resource not found"))
733 } else {
734 ns_url_to_path(url)
735 }
736 }
737 }
738 }
739
740 /// Match cursor style to one of the styles available
741 /// in macOS's [NSCursor](https://developer.apple.com/documentation/appkit/nscursor).
742 fn set_cursor_style(&self, style: CursorStyle) {
743 unsafe {
744 let new_cursor: id = match style {
745 CursorStyle::Arrow => msg_send![class!(NSCursor), arrowCursor],
746 CursorStyle::IBeam => msg_send![class!(NSCursor), IBeamCursor],
747 CursorStyle::Crosshair => msg_send![class!(NSCursor), crosshairCursor],
748 CursorStyle::ClosedHand => msg_send![class!(NSCursor), closedHandCursor],
749 CursorStyle::OpenHand => msg_send![class!(NSCursor), openHandCursor],
750 CursorStyle::PointingHand => msg_send![class!(NSCursor), pointingHandCursor],
751 CursorStyle::ResizeLeft => msg_send![class!(NSCursor), resizeLeftCursor],
752 CursorStyle::ResizeRight => msg_send![class!(NSCursor), resizeRightCursor],
753 CursorStyle::ResizeLeftRight => msg_send![class!(NSCursor), resizeLeftRightCursor],
754 CursorStyle::ResizeUp => msg_send![class!(NSCursor), resizeUpCursor],
755 CursorStyle::ResizeDown => msg_send![class!(NSCursor), resizeDownCursor],
756 CursorStyle::ResizeUpDown => msg_send![class!(NSCursor), resizeUpDownCursor],
757 CursorStyle::DisappearingItem => {
758 msg_send![class!(NSCursor), disappearingItemCursor]
759 }
760 CursorStyle::IBeamCursorForVerticalLayout => {
761 msg_send![class!(NSCursor), IBeamCursorForVerticalLayout]
762 }
763 CursorStyle::OperationNotAllowed => {
764 msg_send![class!(NSCursor), operationNotAllowedCursor]
765 }
766 CursorStyle::DragLink => msg_send![class!(NSCursor), dragLinkCursor],
767 CursorStyle::DragCopy => msg_send![class!(NSCursor), dragCopyCursor],
768 CursorStyle::ContextualMenu => msg_send![class!(NSCursor), contextualMenuCursor],
769 };
770
771 let old_cursor: id = msg_send![class!(NSCursor), currentCursor];
772 if new_cursor != old_cursor {
773 let _: () = msg_send![new_cursor, set];
774 }
775 }
776 }
777
778 fn should_auto_hide_scrollbars(&self) -> bool {
779 #[allow(non_upper_case_globals)]
780 const NSScrollerStyleOverlay: NSInteger = 1;
781
782 unsafe {
783 let style: NSInteger = msg_send![class!(NSScroller), preferredScrollerStyle];
784 style == NSScrollerStyleOverlay
785 }
786 }
787
788 fn write_to_clipboard(&self, item: ClipboardItem) {
789 let state = self.0.lock();
790 unsafe {
791 state.pasteboard.clearContents();
792
793 let text_bytes = NSData::dataWithBytes_length_(
794 nil,
795 item.text.as_ptr() as *const c_void,
796 item.text.len() as u64,
797 );
798 state
799 .pasteboard
800 .setData_forType(text_bytes, NSPasteboardTypeString);
801
802 if let Some(metadata) = item.metadata.as_ref() {
803 let hash_bytes = ClipboardItem::text_hash(&item.text).to_be_bytes();
804 let hash_bytes = NSData::dataWithBytes_length_(
805 nil,
806 hash_bytes.as_ptr() as *const c_void,
807 hash_bytes.len() as u64,
808 );
809 state
810 .pasteboard
811 .setData_forType(hash_bytes, state.text_hash_pasteboard_type);
812
813 let metadata_bytes = NSData::dataWithBytes_length_(
814 nil,
815 metadata.as_ptr() as *const c_void,
816 metadata.len() as u64,
817 );
818 state
819 .pasteboard
820 .setData_forType(metadata_bytes, state.metadata_pasteboard_type);
821 }
822 }
823 }
824
825 fn read_from_clipboard(&self) -> Option<ClipboardItem> {
826 let state = self.0.lock();
827 unsafe {
828 if let Some(text_bytes) =
829 self.read_from_pasteboard(state.pasteboard, NSPasteboardTypeString)
830 {
831 let text = String::from_utf8_lossy(text_bytes).to_string();
832 let hash_bytes = self
833 .read_from_pasteboard(state.pasteboard, state.text_hash_pasteboard_type)
834 .and_then(|bytes| bytes.try_into().ok())
835 .map(u64::from_be_bytes);
836 let metadata_bytes = self
837 .read_from_pasteboard(state.pasteboard, state.metadata_pasteboard_type)
838 .and_then(|bytes| String::from_utf8(bytes.to_vec()).ok());
839
840 if let Some((hash, metadata)) = hash_bytes.zip(metadata_bytes) {
841 if hash == ClipboardItem::text_hash(&text) {
842 Some(ClipboardItem {
843 text,
844 metadata: Some(metadata),
845 })
846 } else {
847 Some(ClipboardItem {
848 text,
849 metadata: None,
850 })
851 }
852 } else {
853 Some(ClipboardItem {
854 text,
855 metadata: None,
856 })
857 }
858 } else {
859 None
860 }
861 }
862 }
863
864 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Task<Result<()>> {
865 let url = url.to_string();
866 let username = username.to_string();
867 let password = password.to_vec();
868 self.background_executor().spawn(async move {
869 unsafe {
870 use security::*;
871
872 let url = CFString::from(url.as_str());
873 let username = CFString::from(username.as_str());
874 let password = CFData::from_buffer(&password);
875
876 // First, check if there are already credentials for the given server. If so, then
877 // update the username and password.
878 let mut verb = "updating";
879 let mut query_attrs = CFMutableDictionary::with_capacity(2);
880 query_attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
881 query_attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
882
883 let mut attrs = CFMutableDictionary::with_capacity(4);
884 attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
885 attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
886 attrs.set(kSecAttrAccount as *const _, username.as_CFTypeRef());
887 attrs.set(kSecValueData as *const _, password.as_CFTypeRef());
888
889 let mut status = SecItemUpdate(
890 query_attrs.as_concrete_TypeRef(),
891 attrs.as_concrete_TypeRef(),
892 );
893
894 // If there were no existing credentials for the given server, then create them.
895 if status == errSecItemNotFound {
896 verb = "creating";
897 status = SecItemAdd(attrs.as_concrete_TypeRef(), ptr::null_mut());
898 }
899
900 if status != errSecSuccess {
901 return Err(anyhow!("{} password failed: {}", verb, status));
902 }
903 }
904 Ok(())
905 })
906 }
907
908 fn read_credentials(&self, url: &str) -> Task<Result<Option<(String, Vec<u8>)>>> {
909 let url = url.to_string();
910 self.background_executor().spawn(async move {
911 let url = CFString::from(url.as_str());
912 let cf_true = CFBoolean::true_value().as_CFTypeRef();
913
914 unsafe {
915 use security::*;
916
917 // Find any credentials for the given server URL.
918 let mut attrs = CFMutableDictionary::with_capacity(5);
919 attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
920 attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
921 attrs.set(kSecReturnAttributes as *const _, cf_true);
922 attrs.set(kSecReturnData as *const _, cf_true);
923
924 let mut result = CFTypeRef::from(ptr::null());
925 let status = SecItemCopyMatching(attrs.as_concrete_TypeRef(), &mut result);
926 match status {
927 security::errSecSuccess => {}
928 security::errSecItemNotFound | security::errSecUserCanceled => return Ok(None),
929 _ => return Err(anyhow!("reading password failed: {}", status)),
930 }
931
932 let result = CFType::wrap_under_create_rule(result)
933 .downcast::<CFDictionary>()
934 .ok_or_else(|| anyhow!("keychain item was not a dictionary"))?;
935 let username = result
936 .find(kSecAttrAccount as *const _)
937 .ok_or_else(|| anyhow!("account was missing from keychain item"))?;
938 let username = CFType::wrap_under_get_rule(*username)
939 .downcast::<CFString>()
940 .ok_or_else(|| anyhow!("account was not a string"))?;
941 let password = result
942 .find(kSecValueData as *const _)
943 .ok_or_else(|| anyhow!("password was missing from keychain item"))?;
944 let password = CFType::wrap_under_get_rule(*password)
945 .downcast::<CFData>()
946 .ok_or_else(|| anyhow!("password was not a string"))?;
947
948 Ok(Some((username.to_string(), password.bytes().to_vec())))
949 }
950 })
951 }
952
953 fn delete_credentials(&self, url: &str) -> Task<Result<()>> {
954 let url = url.to_string();
955
956 self.background_executor().spawn(async move {
957 unsafe {
958 use security::*;
959
960 let url = CFString::from(url.as_str());
961 let mut query_attrs = CFMutableDictionary::with_capacity(2);
962 query_attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
963 query_attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
964
965 let status = SecItemDelete(query_attrs.as_concrete_TypeRef());
966
967 if status != errSecSuccess {
968 return Err(anyhow!("delete password failed: {}", status));
969 }
970 }
971 Ok(())
972 })
973 }
974}
975
976unsafe fn path_from_objc(path: id) -> PathBuf {
977 let len = msg_send![path, lengthOfBytesUsingEncoding: NSUTF8StringEncoding];
978 let bytes = path.UTF8String() as *const u8;
979 let path = str::from_utf8(slice::from_raw_parts(bytes, len)).unwrap();
980 PathBuf::from(path)
981}
982
983unsafe fn get_mac_platform(object: &mut Object) -> &MacPlatform {
984 let platform_ptr: *mut c_void = *object.get_ivar(MAC_PLATFORM_IVAR);
985 assert!(!platform_ptr.is_null());
986 &*(platform_ptr as *const MacPlatform)
987}
988
989extern "C" fn send_event(this: &mut Object, _sel: Sel, native_event: id) {
990 unsafe {
991 if let Some(event) = PlatformInput::from_native(native_event, None) {
992 let platform = get_mac_platform(this);
993 let mut lock = platform.0.lock();
994 if let Some(mut callback) = lock.event.take() {
995 drop(lock);
996 let result = callback(event);
997 platform.0.lock().event.get_or_insert(callback);
998 if !result {
999 return;
1000 }
1001 }
1002 }
1003 msg_send![super(this, class!(NSApplication)), sendEvent: native_event]
1004 }
1005}
1006
1007extern "C" fn did_finish_launching(this: &mut Object, _: Sel, _: id) {
1008 unsafe {
1009 let app: id = msg_send![APP_CLASS, sharedApplication];
1010 app.setActivationPolicy_(NSApplicationActivationPolicyRegular);
1011
1012 let platform = get_mac_platform(this);
1013 let callback = platform.0.lock().finish_launching.take();
1014 if let Some(callback) = callback {
1015 callback();
1016 }
1017 }
1018}
1019
1020extern "C" fn should_handle_reopen(this: &mut Object, _: Sel, _: id, has_open_windows: bool) {
1021 if !has_open_windows {
1022 let platform = unsafe { get_mac_platform(this) };
1023 let mut lock = platform.0.lock();
1024 if let Some(mut callback) = lock.reopen.take() {
1025 drop(lock);
1026 callback();
1027 platform.0.lock().reopen.get_or_insert(callback);
1028 }
1029 }
1030}
1031
1032extern "C" fn did_become_active(this: &mut Object, _: Sel, _: id) {
1033 let platform = unsafe { get_mac_platform(this) };
1034 let mut lock = platform.0.lock();
1035 if let Some(mut callback) = lock.become_active.take() {
1036 drop(lock);
1037 callback();
1038 platform.0.lock().become_active.get_or_insert(callback);
1039 }
1040}
1041
1042extern "C" fn did_resign_active(this: &mut Object, _: Sel, _: id) {
1043 let platform = unsafe { get_mac_platform(this) };
1044 let mut lock = platform.0.lock();
1045 if let Some(mut callback) = lock.resign_active.take() {
1046 drop(lock);
1047 callback();
1048 platform.0.lock().resign_active.get_or_insert(callback);
1049 }
1050}
1051
1052extern "C" fn will_terminate(this: &mut Object, _: Sel, _: id) {
1053 let platform = unsafe { get_mac_platform(this) };
1054 let mut lock = platform.0.lock();
1055 if let Some(mut callback) = lock.quit.take() {
1056 drop(lock);
1057 callback();
1058 platform.0.lock().quit.get_or_insert(callback);
1059 }
1060}
1061
1062extern "C" fn open_urls(this: &mut Object, _: Sel, _: id, urls: id) {
1063 let urls = unsafe {
1064 (0..urls.count())
1065 .filter_map(|i| {
1066 let url = urls.objectAtIndex(i);
1067 match CStr::from_ptr(url.absoluteString().UTF8String() as *mut c_char).to_str() {
1068 Ok(string) => Some(string.to_string()),
1069 Err(err) => {
1070 log::error!("error converting path to string: {}", err);
1071 None
1072 }
1073 }
1074 })
1075 .collect::<Vec<_>>()
1076 };
1077 let platform = unsafe { get_mac_platform(this) };
1078 let mut lock = platform.0.lock();
1079 if let Some(mut callback) = lock.open_urls.take() {
1080 drop(lock);
1081 callback(urls);
1082 platform.0.lock().open_urls.get_or_insert(callback);
1083 }
1084}
1085
1086extern "C" fn handle_menu_item(this: &mut Object, _: Sel, item: id) {
1087 unsafe {
1088 let platform = get_mac_platform(this);
1089 let mut lock = platform.0.lock();
1090 if let Some(mut callback) = lock.menu_command.take() {
1091 let tag: NSInteger = msg_send![item, tag];
1092 let index = tag as usize;
1093 if let Some(action) = lock.menu_actions.get(index) {
1094 let action = action.boxed_clone();
1095 drop(lock);
1096 callback(&*action);
1097 }
1098 platform.0.lock().menu_command.get_or_insert(callback);
1099 }
1100 }
1101}
1102
1103extern "C" fn validate_menu_item(this: &mut Object, _: Sel, item: id) -> bool {
1104 unsafe {
1105 let mut result = false;
1106 let platform = get_mac_platform(this);
1107 let mut lock = platform.0.lock();
1108 if let Some(mut callback) = lock.validate_menu_command.take() {
1109 let tag: NSInteger = msg_send![item, tag];
1110 let index = tag as usize;
1111 if let Some(action) = lock.menu_actions.get(index) {
1112 let action = action.boxed_clone();
1113 drop(lock);
1114 result = callback(action.as_ref());
1115 }
1116 platform
1117 .0
1118 .lock()
1119 .validate_menu_command
1120 .get_or_insert(callback);
1121 }
1122 result
1123 }
1124}
1125
1126extern "C" fn menu_will_open(this: &mut Object, _: Sel, _: id) {
1127 unsafe {
1128 let platform = get_mac_platform(this);
1129 let mut lock = platform.0.lock();
1130 if let Some(mut callback) = lock.will_open_menu.take() {
1131 drop(lock);
1132 callback();
1133 platform.0.lock().will_open_menu.get_or_insert(callback);
1134 }
1135 }
1136}
1137
1138unsafe fn ns_string(string: &str) -> id {
1139 NSString::alloc(nil).init_str(string).autorelease()
1140}
1141
1142unsafe fn ns_url_to_path(url: id) -> Result<PathBuf> {
1143 let path: *mut c_char = msg_send![url, fileSystemRepresentation];
1144 if path.is_null() {
1145 Err(anyhow!(
1146 "url is not a file path: {}",
1147 CStr::from_ptr(url.absoluteString().UTF8String()).to_string_lossy()
1148 ))
1149 } else {
1150 Ok(PathBuf::from(OsStr::from_bytes(
1151 CStr::from_ptr(path).to_bytes(),
1152 )))
1153 }
1154}
1155
1156mod security {
1157 #![allow(non_upper_case_globals)]
1158 use super::*;
1159
1160 #[link(name = "Security", kind = "framework")]
1161 extern "C" {
1162 pub static kSecClass: CFStringRef;
1163 pub static kSecClassInternetPassword: CFStringRef;
1164 pub static kSecAttrServer: CFStringRef;
1165 pub static kSecAttrAccount: CFStringRef;
1166 pub static kSecValueData: CFStringRef;
1167 pub static kSecReturnAttributes: CFStringRef;
1168 pub static kSecReturnData: CFStringRef;
1169
1170 pub fn SecItemAdd(attributes: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
1171 pub fn SecItemUpdate(query: CFDictionaryRef, attributes: CFDictionaryRef) -> OSStatus;
1172 pub fn SecItemDelete(query: CFDictionaryRef) -> OSStatus;
1173 pub fn SecItemCopyMatching(query: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
1174 }
1175
1176 pub const errSecSuccess: OSStatus = 0;
1177 pub const errSecUserCanceled: OSStatus = -128;
1178 pub const errSecItemNotFound: OSStatus = -25300;
1179}
1180
1181#[cfg(test)]
1182mod tests {
1183 use crate::ClipboardItem;
1184
1185 use super::*;
1186
1187 #[test]
1188 fn test_clipboard() {
1189 let platform = build_platform();
1190 assert_eq!(platform.read_from_clipboard(), None);
1191
1192 let item = ClipboardItem::new("1".to_string());
1193 platform.write_to_clipboard(item.clone());
1194 assert_eq!(platform.read_from_clipboard(), Some(item));
1195
1196 let item = ClipboardItem::new("2".to_string()).with_metadata(vec![3, 4]);
1197 platform.write_to_clipboard(item.clone());
1198 assert_eq!(platform.read_from_clipboard(), Some(item));
1199
1200 let text_from_other_app = "text from other app";
1201 unsafe {
1202 let bytes = NSData::dataWithBytes_length_(
1203 nil,
1204 text_from_other_app.as_ptr() as *const c_void,
1205 text_from_other_app.len() as u64,
1206 );
1207 platform
1208 .0
1209 .lock()
1210 .pasteboard
1211 .setData_forType(bytes, NSPasteboardTypeString);
1212 }
1213 assert_eq!(
1214 platform.read_from_clipboard(),
1215 Some(ClipboardItem::new(text_from_other_app.to_string()))
1216 );
1217 }
1218
1219 fn build_platform() -> MacPlatform {
1220 let platform = MacPlatform::new();
1221 platform.0.lock().pasteboard = unsafe { NSPasteboard::pasteboardWithUniqueName(nil) };
1222 platform
1223 }
1224}