/*************************************************************************/ /* os_macos.mm */ /*************************************************************************/ /* This file is part of: */ /* GODOT ENGINE */ /* https://godotengine.org */ /*************************************************************************/ /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */ /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */ /* */ /* Permission is hereby granted, free of charge, to any person obtaining */ /* a copy of this software and associated documentation files (the */ /* "Software"), to deal in the Software without restriction, including */ /* without limitation the rights to use, copy, modify, merge, publish, */ /* distribute, sublicense, and/or sell copies of the Software, and to */ /* permit persons to whom the Software is furnished to do so, subject to */ /* the following conditions: */ /* */ /* The above copyright notice and this permission notice shall be */ /* included in all copies or substantial portions of the Software. */ /* */ /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/ /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ /*************************************************************************/ #include "os_macos.h" #include "core/version_generated.gen.h" #include "main/main.h" #include "dir_access_macos.h" #include "display_server_macos.h" #include "godot_application.h" #include "godot_application_delegate.h" #include "macos_terminal_logger.h" #include #include #include #include #include _FORCE_INLINE_ String OS_MacOS::get_framework_executable(const String &p_path) { // Append framework executable name, or return as is if p_path is not a framework. Ref da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM); if (da->dir_exists(p_path) && da->file_exists(p_path.path_join(p_path.get_file().get_basename()))) { return p_path.path_join(p_path.get_file().get_basename()); } else { return p_path; } } void OS_MacOS::pre_wait_observer_cb(CFRunLoopObserverRef p_observer, CFRunLoopActivity p_activiy, void *p_context) { // Prevent main loop from sleeping and redraw window during modal popup display. // Do not redraw when rendering is done from the separate thread, it will conflict with the OpenGL context updates. DisplayServerMacOS *ds = (DisplayServerMacOS *)DisplayServer::get_singleton(); if (get_singleton()->get_main_loop() && ds && (get_singleton()->get_render_thread_mode() != RENDER_SEPARATE_THREAD) && !ds->get_is_resizing()) { Main::force_redraw(); if (!Main::is_iterating()) { // Avoid cyclic loop. Main::iteration(); } } CFRunLoopWakeUp(CFRunLoopGetCurrent()); // Prevent main loop from sleeping. } void OS_MacOS::initialize() { crash_handler.initialize(); initialize_core(); } String OS_MacOS::get_processor_name() const { char buffer[256]; size_t buffer_len = 256; if (sysctlbyname("machdep.cpu.brand_string", &buffer, &buffer_len, NULL, 0) == 0) { return String::utf8(buffer, buffer_len); } ERR_FAIL_V_MSG("", String("Couldn't get the CPU model name. Returning an empty string.")); } void OS_MacOS::initialize_core() { OS_Unix::initialize_core(); DirAccess::make_default(DirAccess::ACCESS_RESOURCES); DirAccess::make_default(DirAccess::ACCESS_USERDATA); DirAccess::make_default(DirAccess::ACCESS_FILESYSTEM); } void OS_MacOS::finalize() { #ifdef COREMIDI_ENABLED midi_driver.close(); #endif delete_main_loop(); if (joypad_macos) { memdelete(joypad_macos); } } void OS_MacOS::initialize_joypads() { joypad_macos = memnew(JoypadMacOS(Input::get_singleton())); } void OS_MacOS::set_main_loop(MainLoop *p_main_loop) { main_loop = p_main_loop; } void OS_MacOS::delete_main_loop() { if (!main_loop) { return; } memdelete(main_loop); main_loop = nullptr; } void OS_MacOS::set_cmdline_platform_args(const List &p_args) { launch_service_args = p_args; } List OS_MacOS::get_cmdline_platform_args() const { return launch_service_args; } String OS_MacOS::get_name() const { return "macOS"; } String OS_MacOS::get_distribution_name() const { return get_name(); } String OS_MacOS::get_version() const { NSOperatingSystemVersion ver = [NSProcessInfo processInfo].operatingSystemVersion; return vformat("%d.%d.%d", (int64_t)ver.majorVersion, (int64_t)ver.minorVersion, (int64_t)ver.patchVersion); } void OS_MacOS::alert(const String &p_alert, const String &p_title) { NSAlert *window = [[NSAlert alloc] init]; NSString *ns_title = [NSString stringWithUTF8String:p_title.utf8().get_data()]; NSString *ns_alert = [NSString stringWithUTF8String:p_alert.utf8().get_data()]; NSTextField *text_field = [NSTextField labelWithString:ns_alert]; [text_field setAlignment:NSTextAlignmentCenter]; [window addButtonWithTitle:@"OK"]; [window setMessageText:ns_title]; [window setAccessoryView:text_field]; [window setAlertStyle:NSAlertStyleWarning]; id key_window = [[NSApplication sharedApplication] keyWindow]; [window runModal]; if (key_window) { [key_window makeKeyAndOrderFront:nil]; } } Error OS_MacOS::open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path, String *r_resolved_path) { String path = get_framework_executable(p_path); if (!FileAccess::exists(path)) { // Load .dylib or framework from within the executable path. path = get_framework_executable(get_executable_path().get_base_dir().path_join(p_path.get_file())); } if (!FileAccess::exists(path)) { // Load .dylib or framework from a standard macOS location. path = get_framework_executable(get_executable_path().get_base_dir().path_join("../Frameworks").path_join(p_path.get_file())); } p_library_handle = dlopen(path.utf8().get_data(), RTLD_NOW); ERR_FAIL_COND_V_MSG(!p_library_handle, ERR_CANT_OPEN, "Can't open dynamic library: " + p_path + ", error: " + dlerror() + "."); if (r_resolved_path != nullptr) { *r_resolved_path = path; } return OK; } MainLoop *OS_MacOS::get_main_loop() const { return main_loop; } String OS_MacOS::get_config_path() const { if (has_environment("HOME")) { return get_environment("HOME").path_join("Library/Application Support"); } return "."; } String OS_MacOS::get_data_path() const { return get_config_path(); } String OS_MacOS::get_cache_path() const { if (has_environment("HOME")) { return get_environment("HOME").path_join("Library/Caches"); } return get_config_path(); } String OS_MacOS::get_bundle_resource_dir() const { String ret; NSBundle *main = [NSBundle mainBundle]; if (main) { NSString *resource_path = [main resourcePath]; ret.parse_utf8([resource_path UTF8String]); } return ret; } String OS_MacOS::get_bundle_icon_path() const { String ret; NSBundle *main = [NSBundle mainBundle]; if (main) { NSString *icon_path = [[main infoDictionary] objectForKey:@"CFBundleIconFile"]; if (icon_path) { ret.parse_utf8([icon_path UTF8String]); } } return ret; } // Get properly capitalized engine name for system paths String OS_MacOS::get_godot_dir_name() const { return String(VERSION_SHORT_NAME).capitalize(); } String OS_MacOS::get_system_dir(SystemDir p_dir, bool p_shared_storage) const { NSSearchPathDirectory id; bool found = true; switch (p_dir) { case SYSTEM_DIR_DESKTOP: { id = NSDesktopDirectory; } break; case SYSTEM_DIR_DOCUMENTS: { id = NSDocumentDirectory; } break; case SYSTEM_DIR_DOWNLOADS: { id = NSDownloadsDirectory; } break; case SYSTEM_DIR_MOVIES: { id = NSMoviesDirectory; } break; case SYSTEM_DIR_MUSIC: { id = NSMusicDirectory; } break; case SYSTEM_DIR_PICTURES: { id = NSPicturesDirectory; } break; default: { found = false; } } String ret; if (found) { NSArray *paths = NSSearchPathForDirectoriesInDomains(id, NSUserDomainMask, YES); if (paths && [paths count] >= 1) { ret.parse_utf8([[paths firstObject] UTF8String]); } } return ret; } Error OS_MacOS::shell_open(String p_uri) { NSString *string = [NSString stringWithUTF8String:p_uri.utf8().get_data()]; NSURL *uri = [[NSURL alloc] initWithString:string]; // Escape special characters in filenames if (!uri || !uri.scheme || [uri.scheme isEqual:@"file"]) { uri = [[NSURL alloc] initWithString:[string stringByAddingPercentEncodingWithAllowedCharacters:[NSCharacterSet URLFragmentAllowedCharacterSet]]]; } [[NSWorkspace sharedWorkspace] openURL:uri]; return OK; } String OS_MacOS::get_locale() const { NSString *locale_code = [[NSLocale preferredLanguages] objectAtIndex:0]; return String([locale_code UTF8String]).replace("-", "_"); } Vector OS_MacOS::get_system_fonts() const { HashSet font_names; CFArrayRef fonts = CTFontManagerCopyAvailableFontFamilyNames(); if (fonts) { for (CFIndex i = 0; i < CFArrayGetCount(fonts); i++) { CFStringRef cf_name = (CFStringRef)CFArrayGetValueAtIndex(fonts, i); if (cf_name && (CFStringGetLength(cf_name) > 0) && (CFStringCompare(cf_name, CFSTR("LastResort"), kCFCompareCaseInsensitive) != kCFCompareEqualTo) && (CFStringGetCharacterAtIndex(cf_name, 0) != '.')) { NSString *ns_name = (__bridge NSString *)cf_name; font_names.insert(String::utf8([ns_name UTF8String])); } } CFRelease(fonts); } Vector ret; for (const String &E : font_names) { ret.push_back(E); } return ret; } String OS_MacOS::_get_default_fontname(const String &p_font_name) const { String font_name = p_font_name; if (font_name.to_lower() == "sans-serif") { font_name = "Helvetica"; } else if (font_name.to_lower() == "serif") { font_name = "Times"; } else if (font_name.to_lower() == "monospace") { font_name = "Courier"; } else if (font_name.to_lower() == "fantasy") { font_name = "Papyrus"; } else if (font_name.to_lower() == "cursive") { font_name = "Apple Chancery"; }; return font_name; } CGFloat OS_MacOS::_weight_to_ct(int p_weight) const { if (p_weight < 150) { return -0.80; } else if (p_weight < 250) { return -0.60; } else if (p_weight < 350) { return -0.40; } else if (p_weight < 450) { return 0.0; } else if (p_weight < 550) { return 0.23; } else if (p_weight < 650) { return 0.30; } else if (p_weight < 750) { return 0.40; } else if (p_weight < 850) { return 0.56; } else if (p_weight < 925) { return 0.62; } else { return 1.00; } } CGFloat OS_MacOS::_stretch_to_ct(int p_stretch) const { if (p_stretch < 56) { return -0.5; } else if (p_stretch < 69) { return -0.37; } else if (p_stretch < 81) { return -0.25; } else if (p_stretch < 93) { return -0.13; } else if (p_stretch < 106) { return 0.0; } else if (p_stretch < 137) { return 0.13; } else if (p_stretch < 144) { return 0.25; } else if (p_stretch < 162) { return 0.37; } else { return 0.5; } } Vector OS_MacOS::get_system_font_path_for_text(const String &p_font_name, const String &p_text, const String &p_locale, const String &p_script, int p_weight, int p_stretch, bool p_italic) const { Vector ret; String font_name = _get_default_fontname(p_font_name); CFStringRef name = CFStringCreateWithCString(kCFAllocatorDefault, font_name.utf8().get_data(), kCFStringEncodingUTF8); CTFontSymbolicTraits traits = 0; if (p_weight >= 700) { traits |= kCTFontBoldTrait; } if (p_italic) { traits |= kCTFontItalicTrait; } if (p_stretch < 100) { traits |= kCTFontCondensedTrait; } else if (p_stretch > 100) { traits |= kCTFontExpandedTrait; } CFNumberRef sym_traits = CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt32Type, &traits); CFMutableDictionaryRef traits_dict = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, nullptr, nullptr); CFDictionaryAddValue(traits_dict, kCTFontSymbolicTrait, sym_traits); CGFloat weight = _weight_to_ct(p_weight); CFNumberRef font_weight = CFNumberCreate(kCFAllocatorDefault, kCFNumberCGFloatType, &weight); CFDictionaryAddValue(traits_dict, kCTFontWeightTrait, font_weight); CGFloat stretch = _stretch_to_ct(p_stretch); CFNumberRef font_stretch = CFNumberCreate(kCFAllocatorDefault, kCFNumberCGFloatType, &stretch); CFDictionaryAddValue(traits_dict, kCTFontWidthTrait, font_stretch); CFMutableDictionaryRef attributes = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, nullptr, nullptr); CFDictionaryAddValue(attributes, kCTFontFamilyNameAttribute, name); CFDictionaryAddValue(attributes, kCTFontTraitsAttribute, traits_dict); CTFontDescriptorRef font = CTFontDescriptorCreateWithAttributes(attributes); if (font) { CTFontRef family = CTFontCreateWithFontDescriptor(font, 0, nullptr); CFStringRef string = CFStringCreateWithCString(kCFAllocatorDefault, p_text.utf8().get_data(), kCFStringEncodingUTF8); CFRange range = CFRangeMake(0, CFStringGetLength(string)); CTFontRef fallback_family = CTFontCreateForString(family, string, range); if (fallback_family) { CTFontDescriptorRef fallback_font = CTFontCopyFontDescriptor(fallback_family); if (fallback_font) { CFURLRef url = (CFURLRef)CTFontDescriptorCopyAttribute(fallback_font, kCTFontURLAttribute); if (url) { NSString *font_path = [NSString stringWithString:[(__bridge NSURL *)url path]]; ret.push_back(String::utf8([font_path UTF8String])); CFRelease(url); } CFRelease(fallback_font); } CFRelease(fallback_family); } CFRelease(string); CFRelease(font); } CFRelease(attributes); CFRelease(traits_dict); CFRelease(sym_traits); CFRelease(font_stretch); CFRelease(font_weight); CFRelease(name); return ret; } String OS_MacOS::get_system_font_path(const String &p_font_name, int p_weight, int p_stretch, bool p_italic) const { String ret; String font_name = _get_default_fontname(p_font_name); CFStringRef name = CFStringCreateWithCString(kCFAllocatorDefault, font_name.utf8().get_data(), kCFStringEncodingUTF8); CTFontSymbolicTraits traits = 0; if (p_weight > 700) { traits |= kCTFontBoldTrait; } if (p_italic) { traits |= kCTFontItalicTrait; } if (p_stretch < 100) { traits |= kCTFontCondensedTrait; } else if (p_stretch > 100) { traits |= kCTFontExpandedTrait; } CFNumberRef sym_traits = CFNumberCreate(kCFAllocatorDefault, kCFNumberSInt32Type, &traits); CFMutableDictionaryRef traits_dict = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, nullptr, nullptr); CFDictionaryAddValue(traits_dict, kCTFontSymbolicTrait, sym_traits); CGFloat weight = _weight_to_ct(p_weight); CFNumberRef font_weight = CFNumberCreate(kCFAllocatorDefault, kCFNumberCGFloatType, &weight); CFDictionaryAddValue(traits_dict, kCTFontWeightTrait, font_weight); CGFloat stretch = _stretch_to_ct(p_stretch); CFNumberRef font_stretch = CFNumberCreate(kCFAllocatorDefault, kCFNumberCGFloatType, &stretch); CFDictionaryAddValue(traits_dict, kCTFontWidthTrait, font_stretch); CFMutableDictionaryRef attributes = CFDictionaryCreateMutable(kCFAllocatorDefault, 0, nullptr, nullptr); CFDictionaryAddValue(attributes, kCTFontFamilyNameAttribute, name); CFDictionaryAddValue(attributes, kCTFontTraitsAttribute, traits_dict); CTFontDescriptorRef font = CTFontDescriptorCreateWithAttributes(attributes); if (font) { CFURLRef url = (CFURLRef)CTFontDescriptorCopyAttribute(font, kCTFontURLAttribute); if (url) { NSString *font_path = [NSString stringWithString:[(__bridge NSURL *)url path]]; ret = String::utf8([font_path UTF8String]); CFRelease(url); } CFRelease(font); } CFRelease(attributes); CFRelease(traits_dict); CFRelease(sym_traits); CFRelease(font_stretch); CFRelease(font_weight); CFRelease(name); return ret; } String OS_MacOS::get_executable_path() const { char pathbuf[PROC_PIDPATHINFO_MAXSIZE]; int pid = getpid(); pid_t ret = proc_pidpath(pid, pathbuf, sizeof(pathbuf)); if (ret <= 0) { return OS::get_executable_path(); } else { String path; path.parse_utf8(pathbuf); return path; } } Error OS_MacOS::create_process(const String &p_path, const List &p_arguments, ProcessID *r_child_id, bool p_open_console) { // Use NSWorkspace if path is an .app bundle. NSURL *url = [NSURL fileURLWithPath:@(p_path.utf8().get_data())]; NSBundle *bundle = [NSBundle bundleWithURL:url]; if (bundle) { NSMutableArray *arguments = [[NSMutableArray alloc] init]; for (const String &arg : p_arguments) { [arguments addObject:[NSString stringWithUTF8String:arg.utf8().get_data()]]; } if (@available(macOS 10.15, *)) { NSWorkspaceOpenConfiguration *configuration = [[NSWorkspaceOpenConfiguration alloc] init]; [configuration setArguments:arguments]; [configuration setCreatesNewApplicationInstance:YES]; __block dispatch_semaphore_t lock = dispatch_semaphore_create(0); __block Error err = ERR_TIMEOUT; __block pid_t pid = 0; [[NSWorkspace sharedWorkspace] openApplicationAtURL:url configuration:configuration completionHandler:^(NSRunningApplication *app, NSError *error) { if (error) { err = ERR_CANT_FORK; NSLog(@"Failed to execute: %@", error.localizedDescription); } else { pid = [app processIdentifier]; err = OK; } dispatch_semaphore_signal(lock); }]; dispatch_semaphore_wait(lock, dispatch_time(DISPATCH_TIME_NOW, 20000000000)); // 20 sec timeout, wait for app to launch. if (err == OK) { if (r_child_id) { *r_child_id = (ProcessID)pid; } } return err; } else { Error err = ERR_TIMEOUT; NSError *error = nullptr; NSRunningApplication *app = [[NSWorkspace sharedWorkspace] launchApplicationAtURL:url options:NSWorkspaceLaunchNewInstance configuration:[NSDictionary dictionaryWithObject:arguments forKey:NSWorkspaceLaunchConfigurationArguments] error:&error]; if (error) { err = ERR_CANT_FORK; NSLog(@"Failed to execute: %@", error.localizedDescription); } else { if (r_child_id) { *r_child_id = (ProcessID)[app processIdentifier]; } err = OK; } return err; } } else { return OS_Unix::create_process(p_path, p_arguments, r_child_id, p_open_console); } } Error OS_MacOS::create_instance(const List &p_arguments, ProcessID *r_child_id) { // If executable is bundled, always execute editor instances as an app bundle to ensure app window is registered and activated correctly. NSString *nsappname = [[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleName"]; if (nsappname != nil) { String path; path.parse_utf8([[[NSBundle mainBundle] bundlePath] UTF8String]); return create_process(path, p_arguments, r_child_id, false); } else { return create_process(get_executable_path(), p_arguments, r_child_id, false); } } String OS_MacOS::get_unique_id() const { static String serial_number; if (serial_number.is_empty()) { io_service_t platform_expert = IOServiceGetMatchingService(kIOMasterPortDefault, IOServiceMatching("IOPlatformExpertDevice")); CFStringRef serial_number_cf_string = nullptr; if (platform_expert) { serial_number_cf_string = (CFStringRef)IORegistryEntryCreateCFProperty(platform_expert, CFSTR(kIOPlatformSerialNumberKey), kCFAllocatorDefault, 0); IOObjectRelease(platform_expert); } NSString *serial_number_ns_string = nil; if (serial_number_cf_string) { serial_number_ns_string = [NSString stringWithString:(__bridge NSString *)serial_number_cf_string]; CFRelease(serial_number_cf_string); } if (serial_number_ns_string) { serial_number.parse_utf8([serial_number_ns_string UTF8String]); } } return serial_number; } bool OS_MacOS::_check_internal_feature_support(const String &p_feature) { if (p_feature == "system_fonts") { return true; } if (p_feature == "pc") { return true; } return false; } void OS_MacOS::disable_crash_handler() { crash_handler.disable(); } bool OS_MacOS::is_disable_crash_handler() const { return crash_handler.is_disabled(); } Error OS_MacOS::move_to_trash(const String &p_path) { NSFileManager *fm = [NSFileManager defaultManager]; NSURL *url = [NSURL fileURLWithPath:@(p_path.utf8().get_data())]; NSError *err; if (![fm trashItemAtURL:url resultingItemURL:nil error:&err]) { ERR_PRINT("trashItemAtURL error: " + String::utf8(err.localizedDescription.UTF8String)); return FAILED; } return OK; } void OS_MacOS::run() { if (!main_loop) { return; } main_loop->initialize(); bool quit = false; while (!quit) { @try { if (DisplayServer::get_singleton()) { DisplayServer::get_singleton()->process_events(); // Get rid of pending events. } joypad_macos->process_joypads(); if (Main::iteration()) { quit = true; } } @catch (NSException *exception) { ERR_PRINT("NSException: " + String::utf8([exception reason].UTF8String)); } } main_loop->finalize(); } OS_MacOS::OS_MacOS() { main_loop = nullptr; Vector loggers; loggers.push_back(memnew(MacOSTerminalLogger)); _set_logger(memnew(CompositeLogger(loggers))); #ifdef COREAUDIO_ENABLED AudioDriverManager::add_driver(&audio_driver); #endif DisplayServerMacOS::register_macos_driver(); // Implicitly create shared NSApplication instance. [GodotApplication sharedApplication]; // In case we are unbundled, make us a proper UI application. [NSApp setActivationPolicy:NSApplicationActivationPolicyRegular]; // Menu bar setup must go between sharedApplication above and // finishLaunching below, in order to properly emulate the behavior // of NSApplicationMain. NSMenu *main_menu = [[NSMenu alloc] initWithTitle:@""]; [NSApp setMainMenu:main_menu]; [NSApp finishLaunching]; id delegate = [[GodotApplicationDelegate alloc] init]; ERR_FAIL_COND(!delegate); [NSApp setDelegate:delegate]; pre_wait_observer = CFRunLoopObserverCreate(kCFAllocatorDefault, kCFRunLoopBeforeWaiting, true, 0, &pre_wait_observer_cb, nullptr); CFRunLoopAddObserver(CFRunLoopGetCurrent(), pre_wait_observer, kCFRunLoopCommonModes); // Process application:openFile: event. while (true) { NSEvent *event = [NSApp nextEventMatchingMask:NSEventMaskAny untilDate:[NSDate distantPast] inMode:NSDefaultRunLoopMode dequeue:YES]; if (event == nil) { break; } [NSApp sendEvent:event]; } [NSApp activateIgnoringOtherApps:YES]; } OS_MacOS::~OS_MacOS() { CFRunLoopRemoveObserver(CFRunLoopGetCurrent(), pre_wait_observer, kCFRunLoopCommonModes); CFRelease(pre_wait_observer); }