platform.rs

   1use super::{
   2    event::key_to_native, screen::Screen, status_item::StatusItem, BoolExt as _, Dispatcher,
   3    FontSystem, Window,
   4};
   5use crate::{
   6    executor,
   7    keymap_matcher::KeymapMatcher,
   8    platform::{self, CursorStyle},
   9    Action, AppVersion, ClipboardItem, Event, Menu, MenuItem,
  10};
  11use anyhow::{anyhow, Result};
  12use block::ConcreteBlock;
  13use cocoa::{
  14    appkit::{
  15        NSApplication, NSApplicationActivationPolicy::NSApplicationActivationPolicyRegular,
  16        NSEventModifierFlags, NSMenu, NSMenuItem, NSModalResponse, NSOpenPanel, NSPasteboard,
  17        NSPasteboardTypeString, NSSavePanel, NSWindow,
  18    },
  19    base::{id, nil, selector, YES},
  20    foundation::{
  21        NSArray, NSAutoreleasePool, NSBundle, NSData, NSInteger, NSProcessInfo, NSString,
  22        NSUInteger, NSURL,
  23    },
  24};
  25use core_foundation::{
  26    base::{CFType, CFTypeRef, OSStatus, TCFType as _},
  27    boolean::CFBoolean,
  28    data::CFData,
  29    dictionary::{CFDictionary, CFDictionaryRef, CFMutableDictionary},
  30    string::{CFString, CFStringRef},
  31};
  32use ctor::ctor;
  33use objc::{
  34    class,
  35    declare::ClassDecl,
  36    msg_send,
  37    runtime::{Class, Object, Sel},
  38    sel, sel_impl,
  39};
  40use postage::oneshot;
  41use ptr::null_mut;
  42use std::{
  43    cell::{Cell, RefCell},
  44    convert::TryInto,
  45    ffi::{c_void, CStr, OsStr},
  46    os::{raw::c_char, unix::ffi::OsStrExt},
  47    path::{Path, PathBuf},
  48    ptr,
  49    rc::Rc,
  50    slice, str,
  51    sync::Arc,
  52};
  53use time::UtcOffset;
  54
  55#[allow(non_upper_case_globals)]
  56const NSUTF8StringEncoding: NSUInteger = 4;
  57
  58#[allow(non_upper_case_globals)]
  59pub const NSViewLayerContentsRedrawDuringViewResize: NSInteger = 2;
  60
  61const MAC_PLATFORM_IVAR: &str = "platform";
  62static mut APP_CLASS: *const Class = ptr::null();
  63static mut APP_DELEGATE_CLASS: *const Class = ptr::null();
  64
  65#[ctor]
  66unsafe fn build_classes() {
  67    APP_CLASS = {
  68        let mut decl = ClassDecl::new("GPUIApplication", class!(NSApplication)).unwrap();
  69        decl.add_ivar::<*mut c_void>(MAC_PLATFORM_IVAR);
  70        decl.add_method(
  71            sel!(sendEvent:),
  72            send_event as extern "C" fn(&mut Object, Sel, id),
  73        );
  74        decl.register()
  75    };
  76
  77    APP_DELEGATE_CLASS = {
  78        let mut decl = ClassDecl::new("GPUIApplicationDelegate", class!(NSResponder)).unwrap();
  79        decl.add_ivar::<*mut c_void>(MAC_PLATFORM_IVAR);
  80        decl.add_method(
  81            sel!(applicationDidFinishLaunching:),
  82            did_finish_launching as extern "C" fn(&mut Object, Sel, id),
  83        );
  84        decl.add_method(
  85            sel!(applicationDidBecomeActive:),
  86            did_become_active as extern "C" fn(&mut Object, Sel, id),
  87        );
  88        decl.add_method(
  89            sel!(applicationDidResignActive:),
  90            did_resign_active as extern "C" fn(&mut Object, Sel, id),
  91        );
  92        decl.add_method(
  93            sel!(applicationWillTerminate:),
  94            will_terminate as extern "C" fn(&mut Object, Sel, id),
  95        );
  96        decl.add_method(
  97            sel!(handleGPUIMenuItem:),
  98            handle_menu_item as extern "C" fn(&mut Object, Sel, id),
  99        );
 100        decl.add_method(
 101            sel!(validateMenuItem:),
 102            validate_menu_item as extern "C" fn(&mut Object, Sel, id) -> bool,
 103        );
 104        decl.add_method(
 105            sel!(menuWillOpen:),
 106            menu_will_open as extern "C" fn(&mut Object, Sel, id),
 107        );
 108        decl.add_method(
 109            sel!(application:openURLs:),
 110            open_urls as extern "C" fn(&mut Object, Sel, id, id),
 111        );
 112        decl.register()
 113    }
 114}
 115
 116#[derive(Default)]
 117pub struct MacForegroundPlatform(RefCell<MacForegroundPlatformState>);
 118
 119#[derive(Default)]
 120pub struct MacForegroundPlatformState {
 121    become_active: Option<Box<dyn FnMut()>>,
 122    resign_active: Option<Box<dyn FnMut()>>,
 123    quit: Option<Box<dyn FnMut()>>,
 124    event: Option<Box<dyn FnMut(crate::Event) -> bool>>,
 125    menu_command: Option<Box<dyn FnMut(&dyn Action)>>,
 126    validate_menu_command: Option<Box<dyn FnMut(&dyn Action) -> bool>>,
 127    will_open_menu: Option<Box<dyn FnMut()>>,
 128    open_urls: Option<Box<dyn FnMut(Vec<String>)>>,
 129    finish_launching: Option<Box<dyn FnOnce()>>,
 130    menu_actions: Vec<Box<dyn Action>>,
 131}
 132
 133impl MacForegroundPlatform {
 134    unsafe fn create_menu_bar(
 135        &self,
 136        menus: Vec<Menu>,
 137        delegate: id,
 138        actions: &mut Vec<Box<dyn Action>>,
 139        keystroke_matcher: &KeymapMatcher,
 140    ) -> id {
 141        let application_menu = NSMenu::new(nil).autorelease();
 142        application_menu.setDelegate_(delegate);
 143
 144        for menu_config in menus {
 145            let menu = NSMenu::new(nil).autorelease();
 146            menu.setTitle_(ns_string(menu_config.name));
 147            menu.setDelegate_(delegate);
 148
 149            for item_config in menu_config.items {
 150                menu.addItem_(self.create_menu_item(
 151                    item_config,
 152                    delegate,
 153                    actions,
 154                    keystroke_matcher,
 155                ));
 156            }
 157
 158            let menu_item = NSMenuItem::new(nil).autorelease();
 159            menu_item.setSubmenu_(menu);
 160            application_menu.addItem_(menu_item);
 161
 162            if menu_config.name == "Window" {
 163                let app: id = msg_send![APP_CLASS, sharedApplication];
 164                app.setWindowsMenu_(menu);
 165            }
 166        }
 167
 168        application_menu
 169    }
 170
 171    unsafe fn create_menu_item(
 172        &self,
 173        item: MenuItem,
 174        delegate: id,
 175        actions: &mut Vec<Box<dyn Action>>,
 176        keystroke_matcher: &KeymapMatcher,
 177    ) -> id {
 178        match item {
 179            MenuItem::Separator => NSMenuItem::separatorItem(nil),
 180            MenuItem::Action { name, action } => {
 181                let keystrokes = keystroke_matcher
 182                    .bindings_for_action_type(action.as_any().type_id())
 183                    .find(|binding| binding.action().eq(action.as_ref()))
 184                    .map(|binding| binding.keystrokes());
 185
 186                let item;
 187                if let Some(keystrokes) = keystrokes.flatten() {
 188                    if keystrokes.len() == 1 {
 189                        let keystroke = &keystrokes[0];
 190                        let mut mask = NSEventModifierFlags::empty();
 191                        for (modifier, flag) in &[
 192                            (keystroke.cmd, NSEventModifierFlags::NSCommandKeyMask),
 193                            (keystroke.ctrl, NSEventModifierFlags::NSControlKeyMask),
 194                            (keystroke.alt, NSEventModifierFlags::NSAlternateKeyMask),
 195                            (keystroke.shift, NSEventModifierFlags::NSShiftKeyMask),
 196                        ] {
 197                            if *modifier {
 198                                mask |= *flag;
 199                            }
 200                        }
 201
 202                        item = NSMenuItem::alloc(nil)
 203                            .initWithTitle_action_keyEquivalent_(
 204                                ns_string(name),
 205                                selector("handleGPUIMenuItem:"),
 206                                ns_string(key_to_native(&keystroke.key).as_ref()),
 207                            )
 208                            .autorelease();
 209                        item.setKeyEquivalentModifierMask_(mask);
 210                    }
 211                    // For multi-keystroke bindings, render the keystroke as part of the title.
 212                    else {
 213                        use std::fmt::Write;
 214
 215                        let mut name = format!("{name} [");
 216                        for (i, keystroke) in keystrokes.iter().enumerate() {
 217                            if i > 0 {
 218                                name.push(' ');
 219                            }
 220                            write!(&mut name, "{}", keystroke).unwrap();
 221                        }
 222                        name.push(']');
 223
 224                        item = NSMenuItem::alloc(nil)
 225                            .initWithTitle_action_keyEquivalent_(
 226                                ns_string(&name),
 227                                selector("handleGPUIMenuItem:"),
 228                                ns_string(""),
 229                            )
 230                            .autorelease();
 231                    }
 232                } else {
 233                    item = NSMenuItem::alloc(nil)
 234                        .initWithTitle_action_keyEquivalent_(
 235                            ns_string(name),
 236                            selector("handleGPUIMenuItem:"),
 237                            ns_string(""),
 238                        )
 239                        .autorelease();
 240                }
 241
 242                let tag = actions.len() as NSInteger;
 243                let _: () = msg_send![item, setTag: tag];
 244                actions.push(action);
 245                item
 246            }
 247            MenuItem::Submenu(Menu { name, items }) => {
 248                let item = NSMenuItem::new(nil).autorelease();
 249                let submenu = NSMenu::new(nil).autorelease();
 250                submenu.setDelegate_(delegate);
 251                for item in items {
 252                    submenu.addItem_(self.create_menu_item(
 253                        item,
 254                        delegate,
 255                        actions,
 256                        keystroke_matcher,
 257                    ));
 258                }
 259                item.setSubmenu_(submenu);
 260                item.setTitle_(ns_string(name));
 261                item
 262            }
 263        }
 264    }
 265}
 266
 267impl platform::ForegroundPlatform for MacForegroundPlatform {
 268    fn on_become_active(&self, callback: Box<dyn FnMut()>) {
 269        self.0.borrow_mut().become_active = Some(callback);
 270    }
 271
 272    fn on_resign_active(&self, callback: Box<dyn FnMut()>) {
 273        self.0.borrow_mut().resign_active = Some(callback);
 274    }
 275
 276    fn on_quit(&self, callback: Box<dyn FnMut()>) {
 277        self.0.borrow_mut().quit = Some(callback);
 278    }
 279
 280    fn on_event(&self, callback: Box<dyn FnMut(crate::Event) -> bool>) {
 281        self.0.borrow_mut().event = Some(callback);
 282    }
 283
 284    fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>) {
 285        self.0.borrow_mut().open_urls = Some(callback);
 286    }
 287
 288    fn run(&self, on_finish_launching: Box<dyn FnOnce()>) {
 289        self.0.borrow_mut().finish_launching = Some(on_finish_launching);
 290
 291        unsafe {
 292            let app: id = msg_send![APP_CLASS, sharedApplication];
 293            let app_delegate: id = msg_send![APP_DELEGATE_CLASS, new];
 294            app.setDelegate_(app_delegate);
 295
 296            let self_ptr = self as *const Self as *const c_void;
 297            (*app).set_ivar(MAC_PLATFORM_IVAR, self_ptr);
 298            (*app_delegate).set_ivar(MAC_PLATFORM_IVAR, self_ptr);
 299
 300            let pool = NSAutoreleasePool::new(nil);
 301            app.run();
 302            pool.drain();
 303
 304            (*app).set_ivar(MAC_PLATFORM_IVAR, null_mut::<c_void>());
 305            (*app.delegate()).set_ivar(MAC_PLATFORM_IVAR, null_mut::<c_void>());
 306        }
 307    }
 308
 309    fn on_menu_command(&self, callback: Box<dyn FnMut(&dyn Action)>) {
 310        self.0.borrow_mut().menu_command = Some(callback);
 311    }
 312
 313    fn on_will_open_menu(&self, callback: Box<dyn FnMut()>) {
 314        self.0.borrow_mut().will_open_menu = Some(callback);
 315    }
 316
 317    fn on_validate_menu_command(&self, callback: Box<dyn FnMut(&dyn Action) -> bool>) {
 318        self.0.borrow_mut().validate_menu_command = Some(callback);
 319    }
 320
 321    fn set_menus(&self, menus: Vec<Menu>, keystroke_matcher: &KeymapMatcher) {
 322        unsafe {
 323            let app: id = msg_send![APP_CLASS, sharedApplication];
 324            let mut state = self.0.borrow_mut();
 325            let actions = &mut state.menu_actions;
 326            app.setMainMenu_(self.create_menu_bar(
 327                menus,
 328                app.delegate(),
 329                actions,
 330                keystroke_matcher,
 331            ));
 332        }
 333    }
 334
 335    fn prompt_for_paths(
 336        &self,
 337        options: platform::PathPromptOptions,
 338    ) -> oneshot::Receiver<Option<Vec<PathBuf>>> {
 339        unsafe {
 340            let panel = NSOpenPanel::openPanel(nil);
 341            panel.setCanChooseDirectories_(options.directories.to_objc());
 342            panel.setCanChooseFiles_(options.files.to_objc());
 343            panel.setAllowsMultipleSelection_(options.multiple.to_objc());
 344            panel.setResolvesAliases_(false.to_objc());
 345            let (done_tx, done_rx) = oneshot::channel();
 346            let done_tx = Cell::new(Some(done_tx));
 347            let block = ConcreteBlock::new(move |response: NSModalResponse| {
 348                let result = if response == NSModalResponse::NSModalResponseOk {
 349                    let mut result = Vec::new();
 350                    let urls = panel.URLs();
 351                    for i in 0..urls.count() {
 352                        let url = urls.objectAtIndex(i);
 353                        if url.isFileURL() == YES {
 354                            if let Ok(path) = ns_url_to_path(url) {
 355                                result.push(path)
 356                            }
 357                        }
 358                    }
 359                    Some(result)
 360                } else {
 361                    None
 362                };
 363
 364                if let Some(mut done_tx) = done_tx.take() {
 365                    let _ = postage::sink::Sink::try_send(&mut done_tx, result);
 366                }
 367            });
 368            let block = block.copy();
 369            let _: () = msg_send![panel, beginWithCompletionHandler: block];
 370            done_rx
 371        }
 372    }
 373
 374    fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>> {
 375        unsafe {
 376            let panel = NSSavePanel::savePanel(nil);
 377            let path = ns_string(directory.to_string_lossy().as_ref());
 378            let url = NSURL::fileURLWithPath_isDirectory_(nil, path, true.to_objc());
 379            panel.setDirectoryURL(url);
 380
 381            let (done_tx, done_rx) = oneshot::channel();
 382            let done_tx = Cell::new(Some(done_tx));
 383            let block = ConcreteBlock::new(move |response: NSModalResponse| {
 384                let mut result = None;
 385                if response == NSModalResponse::NSModalResponseOk {
 386                    let url = panel.URL();
 387                    if url.isFileURL() == YES {
 388                        result = ns_url_to_path(panel.URL()).ok()
 389                    }
 390                }
 391
 392                if let Some(mut done_tx) = done_tx.take() {
 393                    let _ = postage::sink::Sink::try_send(&mut done_tx, result);
 394                }
 395            });
 396            let block = block.copy();
 397            let _: () = msg_send![panel, beginWithCompletionHandler: block];
 398            done_rx
 399        }
 400    }
 401}
 402
 403pub struct MacPlatform {
 404    dispatcher: Arc<Dispatcher>,
 405    fonts: Arc<FontSystem>,
 406    pasteboard: id,
 407    text_hash_pasteboard_type: id,
 408    metadata_pasteboard_type: id,
 409}
 410
 411impl MacPlatform {
 412    pub fn new() -> Self {
 413        Self {
 414            dispatcher: Arc::new(Dispatcher),
 415            fonts: Arc::new(FontSystem::new()),
 416            pasteboard: unsafe { NSPasteboard::generalPasteboard(nil) },
 417            text_hash_pasteboard_type: unsafe { ns_string("zed-text-hash") },
 418            metadata_pasteboard_type: unsafe { ns_string("zed-metadata") },
 419        }
 420    }
 421
 422    unsafe fn read_from_pasteboard(&self, kind: id) -> Option<&[u8]> {
 423        let data = self.pasteboard.dataForType(kind);
 424        if data == nil {
 425            None
 426        } else {
 427            Some(slice::from_raw_parts(
 428                data.bytes() as *mut u8,
 429                data.length() as usize,
 430            ))
 431        }
 432    }
 433}
 434
 435unsafe impl Send for MacPlatform {}
 436unsafe impl Sync for MacPlatform {}
 437
 438impl platform::Platform for MacPlatform {
 439    fn dispatcher(&self) -> Arc<dyn platform::Dispatcher> {
 440        self.dispatcher.clone()
 441    }
 442
 443    fn fonts(&self) -> Arc<dyn platform::FontSystem> {
 444        self.fonts.clone()
 445    }
 446
 447    fn activate(&self, ignoring_other_apps: bool) {
 448        unsafe {
 449            let app = NSApplication::sharedApplication(nil);
 450            app.activateIgnoringOtherApps_(ignoring_other_apps.to_objc());
 451        }
 452    }
 453
 454    fn hide(&self) {
 455        unsafe {
 456            let app = NSApplication::sharedApplication(nil);
 457            let _: () = msg_send![app, hide: nil];
 458        }
 459    }
 460
 461    fn hide_other_apps(&self) {
 462        unsafe {
 463            let app = NSApplication::sharedApplication(nil);
 464            let _: () = msg_send![app, hideOtherApplications: nil];
 465        }
 466    }
 467
 468    fn unhide_other_apps(&self) {
 469        unsafe {
 470            let app = NSApplication::sharedApplication(nil);
 471            let _: () = msg_send![app, unhideAllApplications: nil];
 472        }
 473    }
 474
 475    fn quit(&self) {
 476        // Quitting the app causes us to close windows, which invokes `Window::on_close` callbacks
 477        // synchronously before this method terminates. If we call `Platform::quit` while holding a
 478        // borrow of the app state (which most of the time we will do), we will end up
 479        // double-borrowing the app state in the `on_close` callbacks for our open windows. To solve
 480        // this, we make quitting the application asynchronous so that we aren't holding borrows to
 481        // the app state on the stack when we actually terminate the app.
 482
 483        use super::dispatcher::{dispatch_async_f, dispatch_get_main_queue};
 484
 485        unsafe {
 486            dispatch_async_f(dispatch_get_main_queue(), ptr::null_mut(), Some(quit));
 487        }
 488
 489        unsafe extern "C" fn quit(_: *mut c_void) {
 490            let app = NSApplication::sharedApplication(nil);
 491            let _: () = msg_send![app, terminate: nil];
 492        }
 493    }
 494
 495    fn screen_by_id(&self, id: uuid::Uuid) -> Option<Rc<dyn crate::Screen>> {
 496        Screen::find_by_id(id).map(|screen| Rc::new(screen) as Rc<_>)
 497    }
 498
 499    fn screens(&self) -> Vec<Rc<dyn platform::Screen>> {
 500        Screen::all()
 501            .into_iter()
 502            .map(|screen| Rc::new(screen) as Rc<_>)
 503            .collect()
 504    }
 505
 506    fn open_window(
 507        &self,
 508        id: usize,
 509        options: platform::WindowOptions,
 510        executor: Rc<executor::Foreground>,
 511    ) -> Box<dyn platform::Window> {
 512        Box::new(Window::open(id, options, executor, self.fonts()))
 513    }
 514
 515    fn key_window_id(&self) -> Option<usize> {
 516        Window::key_window_id()
 517    }
 518
 519    fn add_status_item(&self) -> Box<dyn platform::Window> {
 520        Box::new(StatusItem::add(self.fonts()))
 521    }
 522
 523    fn write_to_clipboard(&self, item: ClipboardItem) {
 524        unsafe {
 525            self.pasteboard.clearContents();
 526
 527            let text_bytes = NSData::dataWithBytes_length_(
 528                nil,
 529                item.text.as_ptr() as *const c_void,
 530                item.text.len() as u64,
 531            );
 532            self.pasteboard
 533                .setData_forType(text_bytes, NSPasteboardTypeString);
 534
 535            if let Some(metadata) = item.metadata.as_ref() {
 536                let hash_bytes = ClipboardItem::text_hash(&item.text).to_be_bytes();
 537                let hash_bytes = NSData::dataWithBytes_length_(
 538                    nil,
 539                    hash_bytes.as_ptr() as *const c_void,
 540                    hash_bytes.len() as u64,
 541                );
 542                self.pasteboard
 543                    .setData_forType(hash_bytes, self.text_hash_pasteboard_type);
 544
 545                let metadata_bytes = NSData::dataWithBytes_length_(
 546                    nil,
 547                    metadata.as_ptr() as *const c_void,
 548                    metadata.len() as u64,
 549                );
 550                self.pasteboard
 551                    .setData_forType(metadata_bytes, self.metadata_pasteboard_type);
 552            }
 553        }
 554    }
 555
 556    fn read_from_clipboard(&self) -> Option<ClipboardItem> {
 557        unsafe {
 558            if let Some(text_bytes) = self.read_from_pasteboard(NSPasteboardTypeString) {
 559                let text = String::from_utf8_lossy(text_bytes).to_string();
 560                let hash_bytes = self
 561                    .read_from_pasteboard(self.text_hash_pasteboard_type)
 562                    .and_then(|bytes| bytes.try_into().ok())
 563                    .map(u64::from_be_bytes);
 564                let metadata_bytes = self
 565                    .read_from_pasteboard(self.metadata_pasteboard_type)
 566                    .and_then(|bytes| String::from_utf8(bytes.to_vec()).ok());
 567
 568                if let Some((hash, metadata)) = hash_bytes.zip(metadata_bytes) {
 569                    if hash == ClipboardItem::text_hash(&text) {
 570                        Some(ClipboardItem {
 571                            text,
 572                            metadata: Some(metadata),
 573                        })
 574                    } else {
 575                        Some(ClipboardItem {
 576                            text,
 577                            metadata: None,
 578                        })
 579                    }
 580                } else {
 581                    Some(ClipboardItem {
 582                        text,
 583                        metadata: None,
 584                    })
 585                }
 586            } else {
 587                None
 588            }
 589        }
 590    }
 591
 592    fn open_url(&self, url: &str) {
 593        unsafe {
 594            let url = NSURL::alloc(nil)
 595                .initWithString_(ns_string(url))
 596                .autorelease();
 597            let workspace: id = msg_send![class!(NSWorkspace), sharedWorkspace];
 598            msg_send![workspace, openURL: url]
 599        }
 600    }
 601
 602    fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Result<()> {
 603        let url = CFString::from(url);
 604        let username = CFString::from(username);
 605        let password = CFData::from_buffer(password);
 606
 607        unsafe {
 608            use security::*;
 609
 610            // First, check if there are already credentials for the given server. If so, then
 611            // update the username and password.
 612            let mut verb = "updating";
 613            let mut query_attrs = CFMutableDictionary::with_capacity(2);
 614            query_attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
 615            query_attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
 616
 617            let mut attrs = CFMutableDictionary::with_capacity(4);
 618            attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
 619            attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
 620            attrs.set(kSecAttrAccount as *const _, username.as_CFTypeRef());
 621            attrs.set(kSecValueData as *const _, password.as_CFTypeRef());
 622
 623            let mut status = SecItemUpdate(
 624                query_attrs.as_concrete_TypeRef(),
 625                attrs.as_concrete_TypeRef(),
 626            );
 627
 628            // If there were no existing credentials for the given server, then create them.
 629            if status == errSecItemNotFound {
 630                verb = "creating";
 631                status = SecItemAdd(attrs.as_concrete_TypeRef(), ptr::null_mut());
 632            }
 633
 634            if status != errSecSuccess {
 635                return Err(anyhow!("{} password failed: {}", verb, status));
 636            }
 637        }
 638        Ok(())
 639    }
 640
 641    fn read_credentials(&self, url: &str) -> Result<Option<(String, Vec<u8>)>> {
 642        let url = CFString::from(url);
 643        let cf_true = CFBoolean::true_value().as_CFTypeRef();
 644
 645        unsafe {
 646            use security::*;
 647
 648            // Find any credentials for the given server URL.
 649            let mut attrs = CFMutableDictionary::with_capacity(5);
 650            attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
 651            attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
 652            attrs.set(kSecReturnAttributes as *const _, cf_true);
 653            attrs.set(kSecReturnData as *const _, cf_true);
 654
 655            let mut result = CFTypeRef::from(ptr::null());
 656            let status = SecItemCopyMatching(attrs.as_concrete_TypeRef(), &mut result);
 657            match status {
 658                security::errSecSuccess => {}
 659                security::errSecItemNotFound | security::errSecUserCanceled => return Ok(None),
 660                _ => return Err(anyhow!("reading password failed: {}", status)),
 661            }
 662
 663            let result = CFType::wrap_under_create_rule(result)
 664                .downcast::<CFDictionary>()
 665                .ok_or_else(|| anyhow!("keychain item was not a dictionary"))?;
 666            let username = result
 667                .find(kSecAttrAccount as *const _)
 668                .ok_or_else(|| anyhow!("account was missing from keychain item"))?;
 669            let username = CFType::wrap_under_get_rule(*username)
 670                .downcast::<CFString>()
 671                .ok_or_else(|| anyhow!("account was not a string"))?;
 672            let password = result
 673                .find(kSecValueData as *const _)
 674                .ok_or_else(|| anyhow!("password was missing from keychain item"))?;
 675            let password = CFType::wrap_under_get_rule(*password)
 676                .downcast::<CFData>()
 677                .ok_or_else(|| anyhow!("password was not a string"))?;
 678
 679            Ok(Some((username.to_string(), password.bytes().to_vec())))
 680        }
 681    }
 682
 683    fn delete_credentials(&self, url: &str) -> Result<()> {
 684        let url = CFString::from(url);
 685
 686        unsafe {
 687            use security::*;
 688
 689            let mut query_attrs = CFMutableDictionary::with_capacity(2);
 690            query_attrs.set(kSecClass as *const _, kSecClassInternetPassword as *const _);
 691            query_attrs.set(kSecAttrServer as *const _, url.as_CFTypeRef());
 692
 693            let status = SecItemDelete(query_attrs.as_concrete_TypeRef());
 694
 695            if status != errSecSuccess {
 696                return Err(anyhow!("delete password failed: {}", status));
 697            }
 698        }
 699        Ok(())
 700    }
 701
 702    fn set_cursor_style(&self, style: CursorStyle) {
 703        unsafe {
 704            let cursor: id = match style {
 705                CursorStyle::Arrow => msg_send![class!(NSCursor), arrowCursor],
 706                CursorStyle::ResizeLeftRight => {
 707                    msg_send![class!(NSCursor), resizeLeftRightCursor]
 708                }
 709                CursorStyle::ResizeUpDown => msg_send![class!(NSCursor), resizeUpDownCursor],
 710                CursorStyle::PointingHand => msg_send![class!(NSCursor), pointingHandCursor],
 711                CursorStyle::IBeam => msg_send![class!(NSCursor), IBeamCursor],
 712            };
 713            let _: () = msg_send![cursor, set];
 714        }
 715    }
 716
 717    fn should_auto_hide_scrollbars(&self) -> bool {
 718        #[allow(non_upper_case_globals)]
 719        const NSScrollerStyleOverlay: NSInteger = 1;
 720
 721        unsafe {
 722            let style: NSInteger = msg_send![class!(NSScroller), preferredScrollerStyle];
 723            style == NSScrollerStyleOverlay
 724        }
 725    }
 726
 727    fn local_timezone(&self) -> UtcOffset {
 728        unsafe {
 729            let local_timezone: id = msg_send![class!(NSTimeZone), localTimeZone];
 730            let seconds_from_gmt: NSInteger = msg_send![local_timezone, secondsFromGMT];
 731            UtcOffset::from_whole_seconds(seconds_from_gmt.try_into().unwrap()).unwrap()
 732        }
 733    }
 734
 735    fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf> {
 736        unsafe {
 737            let bundle: id = NSBundle::mainBundle();
 738            if bundle.is_null() {
 739                Err(anyhow!("app is not running inside a bundle"))
 740            } else {
 741                let name = ns_string(name);
 742                let url: id = msg_send![bundle, URLForAuxiliaryExecutable: name];
 743                if url.is_null() {
 744                    Err(anyhow!("resource not found"))
 745                } else {
 746                    ns_url_to_path(url)
 747                }
 748            }
 749        }
 750    }
 751
 752    fn app_path(&self) -> Result<PathBuf> {
 753        unsafe {
 754            let bundle: id = NSBundle::mainBundle();
 755            if bundle.is_null() {
 756                Err(anyhow!("app is not running inside a bundle"))
 757            } else {
 758                Ok(path_from_objc(msg_send![bundle, bundlePath]))
 759            }
 760        }
 761    }
 762
 763    fn app_version(&self) -> Result<platform::AppVersion> {
 764        unsafe {
 765            let bundle: id = NSBundle::mainBundle();
 766            if bundle.is_null() {
 767                Err(anyhow!("app is not running inside a bundle"))
 768            } else {
 769                let version: id = msg_send![bundle, objectForInfoDictionaryKey: ns_string("CFBundleShortVersionString")];
 770                let len = msg_send![version, lengthOfBytesUsingEncoding: NSUTF8StringEncoding];
 771                let bytes = version.UTF8String() as *const u8;
 772                let version = str::from_utf8(slice::from_raw_parts(bytes, len)).unwrap();
 773                version.parse()
 774            }
 775        }
 776    }
 777
 778    fn os_name(&self) -> &'static str {
 779        "macOS"
 780    }
 781
 782    fn os_version(&self) -> Result<crate::AppVersion> {
 783        unsafe {
 784            let process_info = NSProcessInfo::processInfo(nil);
 785            let version = process_info.operatingSystemVersion();
 786            Ok(AppVersion {
 787                major: version.majorVersion as usize,
 788                minor: version.minorVersion as usize,
 789                patch: version.patchVersion as usize,
 790            })
 791        }
 792    }
 793}
 794
 795unsafe fn path_from_objc(path: id) -> PathBuf {
 796    let len = msg_send![path, lengthOfBytesUsingEncoding: NSUTF8StringEncoding];
 797    let bytes = path.UTF8String() as *const u8;
 798    let path = str::from_utf8(slice::from_raw_parts(bytes, len)).unwrap();
 799    PathBuf::from(path)
 800}
 801
 802unsafe fn get_foreground_platform(object: &mut Object) -> &MacForegroundPlatform {
 803    let platform_ptr: *mut c_void = *object.get_ivar(MAC_PLATFORM_IVAR);
 804    assert!(!platform_ptr.is_null());
 805    &*(platform_ptr as *const MacForegroundPlatform)
 806}
 807
 808extern "C" fn send_event(this: &mut Object, _sel: Sel, native_event: id) {
 809    unsafe {
 810        if let Some(event) = Event::from_native(native_event, None) {
 811            let platform = get_foreground_platform(this);
 812            if let Some(callback) = platform.0.borrow_mut().event.as_mut() {
 813                if callback(event) {
 814                    return;
 815                }
 816            }
 817        }
 818
 819        msg_send![super(this, class!(NSApplication)), sendEvent: native_event]
 820    }
 821}
 822
 823extern "C" fn did_finish_launching(this: &mut Object, _: Sel, _: id) {
 824    unsafe {
 825        let app: id = msg_send![APP_CLASS, sharedApplication];
 826        app.setActivationPolicy_(NSApplicationActivationPolicyRegular);
 827
 828        let platform = get_foreground_platform(this);
 829        let callback = platform.0.borrow_mut().finish_launching.take();
 830        if let Some(callback) = callback {
 831            callback();
 832        }
 833    }
 834}
 835
 836extern "C" fn did_become_active(this: &mut Object, _: Sel, _: id) {
 837    let platform = unsafe { get_foreground_platform(this) };
 838    if let Some(callback) = platform.0.borrow_mut().become_active.as_mut() {
 839        callback();
 840    }
 841}
 842
 843extern "C" fn did_resign_active(this: &mut Object, _: Sel, _: id) {
 844    let platform = unsafe { get_foreground_platform(this) };
 845    if let Some(callback) = platform.0.borrow_mut().resign_active.as_mut() {
 846        callback();
 847    }
 848}
 849
 850extern "C" fn will_terminate(this: &mut Object, _: Sel, _: id) {
 851    let platform = unsafe { get_foreground_platform(this) };
 852    if let Some(callback) = platform.0.borrow_mut().quit.as_mut() {
 853        callback();
 854    }
 855}
 856
 857extern "C" fn open_urls(this: &mut Object, _: Sel, _: id, urls: id) {
 858    let urls = unsafe {
 859        (0..urls.count())
 860            .into_iter()
 861            .filter_map(|i| {
 862                let url = urls.objectAtIndex(i);
 863                match CStr::from_ptr(url.absoluteString().UTF8String() as *mut c_char).to_str() {
 864                    Ok(string) => Some(string.to_string()),
 865                    Err(err) => {
 866                        log::error!("error converting path to string: {}", err);
 867                        None
 868                    }
 869                }
 870            })
 871            .collect::<Vec<_>>()
 872    };
 873    let platform = unsafe { get_foreground_platform(this) };
 874    if let Some(callback) = platform.0.borrow_mut().open_urls.as_mut() {
 875        callback(urls);
 876    }
 877}
 878
 879extern "C" fn handle_menu_item(this: &mut Object, _: Sel, item: id) {
 880    unsafe {
 881        let platform = get_foreground_platform(this);
 882        let mut platform = platform.0.borrow_mut();
 883        if let Some(mut callback) = platform.menu_command.take() {
 884            let tag: NSInteger = msg_send![item, tag];
 885            let index = tag as usize;
 886            if let Some(action) = platform.menu_actions.get(index) {
 887                callback(action.as_ref());
 888            }
 889            platform.menu_command = Some(callback);
 890        }
 891    }
 892}
 893
 894extern "C" fn validate_menu_item(this: &mut Object, _: Sel, item: id) -> bool {
 895    unsafe {
 896        let mut result = false;
 897        let platform = get_foreground_platform(this);
 898        let mut platform = platform.0.borrow_mut();
 899        if let Some(mut callback) = platform.validate_menu_command.take() {
 900            let tag: NSInteger = msg_send![item, tag];
 901            let index = tag as usize;
 902            if let Some(action) = platform.menu_actions.get(index) {
 903                result = callback(action.as_ref());
 904            }
 905            platform.validate_menu_command = Some(callback);
 906        }
 907        result
 908    }
 909}
 910
 911extern "C" fn menu_will_open(this: &mut Object, _: Sel, _: id) {
 912    unsafe {
 913        let platform = get_foreground_platform(this);
 914        let mut platform = platform.0.borrow_mut();
 915        if let Some(mut callback) = platform.will_open_menu.take() {
 916            callback();
 917            platform.will_open_menu = Some(callback);
 918        }
 919    }
 920}
 921
 922unsafe fn ns_string(string: &str) -> id {
 923    NSString::alloc(nil).init_str(string).autorelease()
 924}
 925
 926unsafe fn ns_url_to_path(url: id) -> Result<PathBuf> {
 927    let path: *mut c_char = msg_send![url, fileSystemRepresentation];
 928    if path.is_null() {
 929        Err(anyhow!(
 930            "url is not a file path: {}",
 931            CStr::from_ptr(url.absoluteString().UTF8String()).to_string_lossy()
 932        ))
 933    } else {
 934        Ok(PathBuf::from(OsStr::from_bytes(
 935            CStr::from_ptr(path).to_bytes(),
 936        )))
 937    }
 938}
 939
 940mod security {
 941    #![allow(non_upper_case_globals)]
 942    use super::*;
 943
 944    #[link(name = "Security", kind = "framework")]
 945    extern "C" {
 946        pub static kSecClass: CFStringRef;
 947        pub static kSecClassInternetPassword: CFStringRef;
 948        pub static kSecAttrServer: CFStringRef;
 949        pub static kSecAttrAccount: CFStringRef;
 950        pub static kSecValueData: CFStringRef;
 951        pub static kSecReturnAttributes: CFStringRef;
 952        pub static kSecReturnData: CFStringRef;
 953
 954        pub fn SecItemAdd(attributes: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
 955        pub fn SecItemUpdate(query: CFDictionaryRef, attributes: CFDictionaryRef) -> OSStatus;
 956        pub fn SecItemDelete(query: CFDictionaryRef) -> OSStatus;
 957        pub fn SecItemCopyMatching(query: CFDictionaryRef, result: *mut CFTypeRef) -> OSStatus;
 958    }
 959
 960    pub const errSecSuccess: OSStatus = 0;
 961    pub const errSecUserCanceled: OSStatus = -128;
 962    pub const errSecItemNotFound: OSStatus = -25300;
 963}
 964
 965#[cfg(test)]
 966mod tests {
 967    use crate::platform::Platform;
 968
 969    use super::*;
 970
 971    #[test]
 972    fn test_clipboard() {
 973        let platform = build_platform();
 974        assert_eq!(platform.read_from_clipboard(), None);
 975
 976        let item = ClipboardItem::new("1".to_string());
 977        platform.write_to_clipboard(item.clone());
 978        assert_eq!(platform.read_from_clipboard(), Some(item));
 979
 980        let item = ClipboardItem::new("2".to_string()).with_metadata(vec![3, 4]);
 981        platform.write_to_clipboard(item.clone());
 982        assert_eq!(platform.read_from_clipboard(), Some(item));
 983
 984        let text_from_other_app = "text from other app";
 985        unsafe {
 986            let bytes = NSData::dataWithBytes_length_(
 987                nil,
 988                text_from_other_app.as_ptr() as *const c_void,
 989                text_from_other_app.len() as u64,
 990            );
 991            platform
 992                .pasteboard
 993                .setData_forType(bytes, NSPasteboardTypeString);
 994        }
 995        assert_eq!(
 996            platform.read_from_clipboard(),
 997            Some(ClipboardItem::new(text_from_other_app.to_string()))
 998        );
 999    }
1000
1001    fn build_platform() -> MacPlatform {
1002        let mut platform = MacPlatform::new();
1003        platform.pasteboard = unsafe { NSPasteboard::pasteboardWithUniqueName(nil) };
1004        platform
1005    }
1006}