summaryrefslogtreecommitdiff
path: root/platform/osx/os_osx.mm
diff options
context:
space:
mode:
Diffstat (limited to 'platform/osx/os_osx.mm')
-rw-r--r--platform/osx/os_osx.mm524
1 files changed, 0 insertions, 524 deletions
diff --git a/platform/osx/os_osx.mm b/platform/osx/os_osx.mm
deleted file mode 100644
index 5230ed4155..0000000000
--- a/platform/osx/os_osx.mm
+++ /dev/null
@@ -1,524 +0,0 @@
-/*************************************************************************/
-/* os_osx.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_osx.h"
-
-#include "core/version_generated.gen.h"
-#include "main/main.h"
-
-#include "dir_access_osx.h"
-#include "display_server_osx.h"
-#include "godot_application.h"
-#include "godot_application_delegate.h"
-#include "osx_terminal_logger.h"
-
-#include <dlfcn.h>
-#include <libproc.h>
-#include <mach-o/dyld.h>
-#include <os/log.h>
-#include <sys/sysctl.h>
-
-_FORCE_INLINE_ String OS_OSX::get_framework_executable(const String &p_path) {
- // Append framework executable name, or return as is if p_path is not a framework.
- Ref<DirAccess> da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- if (da->dir_exists(p_path) && da->file_exists(p_path.plus_file(p_path.get_file().get_basename()))) {
- return p_path.plus_file(p_path.get_file().get_basename());
- } else {
- return p_path;
- }
-}
-
-void OS_OSX::pre_wait_observer_cb(CFRunLoopObserverRef p_observer, CFRunLoopActivity p_activiy, void *p_context) {
- // Prevent main loop from sleeping and redraw window during resize / modal popups.
-
- DisplayServerOSX *ds = (DisplayServerOSX *)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_OSX::initialize() {
- crash_handler.initialize();
-
- initialize_core();
-}
-
-String OS_OSX::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_OSX::initialize_core() {
- OS_Unix::initialize_core();
-
- DirAccess::make_default<DirAccessOSX>(DirAccess::ACCESS_RESOURCES);
- DirAccess::make_default<DirAccessOSX>(DirAccess::ACCESS_USERDATA);
- DirAccess::make_default<DirAccessOSX>(DirAccess::ACCESS_FILESYSTEM);
-}
-
-void OS_OSX::finalize() {
-#ifdef COREMIDI_ENABLED
- midi_driver.close();
-#endif
-
- delete_main_loop();
-
- if (joypad_osx) {
- memdelete(joypad_osx);
- }
-}
-
-void OS_OSX::initialize_joypads() {
- joypad_osx = memnew(JoypadOSX(Input::get_singleton()));
-}
-
-void OS_OSX::set_main_loop(MainLoop *p_main_loop) {
- main_loop = p_main_loop;
-}
-
-void OS_OSX::delete_main_loop() {
- if (!main_loop) {
- return;
- }
-
- memdelete(main_loop);
- main_loop = nullptr;
-}
-
-void OS_OSX::set_cmdline_platform_args(const List<String> &p_args) {
- launch_service_args = p_args;
-}
-
-List<String> OS_OSX::get_cmdline_platform_args() const {
- return launch_service_args;
-}
-
-String OS_OSX::get_name() const {
- return "macOS";
-}
-
-void OS_OSX::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()];
-
- [window addButtonWithTitle:@"OK"];
- [window setMessageText:ns_title];
- [window setInformativeText:ns_alert];
- [window setAlertStyle:NSAlertStyleWarning];
-
- id key_window = [[NSApplication sharedApplication] keyWindow];
- [window runModal];
- if (key_window) {
- [key_window makeKeyAndOrderFront:nil];
- }
-}
-
-Error OS_OSX::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().plus_file(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().plus_file("../Frameworks").plus_file(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_OSX::get_main_loop() const {
- return main_loop;
-}
-
-String OS_OSX::get_config_path() const {
- // The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on macOS as well.
- if (has_environment("XDG_CONFIG_HOME")) {
- if (get_environment("XDG_CONFIG_HOME").is_absolute_path()) {
- return get_environment("XDG_CONFIG_HOME");
- } else {
- WARN_PRINT_ONCE("`XDG_CONFIG_HOME` is a relative path. Ignoring its value and falling back to `$HOME/Library/Application Support` or `.` per the XDG Base Directory specification.");
- }
- }
- if (has_environment("HOME")) {
- return get_environment("HOME").plus_file("Library/Application Support");
- }
- return ".";
-}
-
-String OS_OSX::get_data_path() const {
- // The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on macOS as well.
- if (has_environment("XDG_DATA_HOME")) {
- if (get_environment("XDG_DATA_HOME").is_absolute_path()) {
- return get_environment("XDG_DATA_HOME");
- } else {
- WARN_PRINT_ONCE("`XDG_DATA_HOME` is a relative path. Ignoring its value and falling back to `get_config_path()` per the XDG Base Directory specification.");
- }
- }
- return get_config_path();
-}
-
-String OS_OSX::get_cache_path() const {
- // The XDG Base Directory specification technically only applies on Linux/*BSD, but it doesn't hurt to support it on macOS as well.
- if (has_environment("XDG_CACHE_HOME")) {
- if (get_environment("XDG_CACHE_HOME").is_absolute_path()) {
- return get_environment("XDG_CACHE_HOME");
- } else {
- WARN_PRINT_ONCE("`XDG_CACHE_HOME` is a relative path. Ignoring its value and falling back to `$HOME/Library/Caches` or `get_config_path()` per the XDG Base Directory specification.");
- }
- }
- if (has_environment("HOME")) {
- return get_environment("HOME").plus_file("Library/Caches");
- }
- return get_config_path();
-}
-
-String OS_OSX::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_OSX::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_OSX::get_godot_dir_name() const {
- return String(VERSION_SHORT_NAME).capitalize();
-}
-
-String OS_OSX::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_OSX::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_OSX::get_locale() const {
- NSString *locale_code = [[NSLocale preferredLanguages] objectAtIndex:0];
- return String([locale_code UTF8String]).replace("-", "_");
-}
-
-String OS_OSX::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_OSX::create_process(const String &p_path, const List<String> &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_OSX::create_instance(const List<String> &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_OSX::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_OSX::_check_internal_feature_support(const String &p_feature) {
- return p_feature == "pc";
-}
-
-void OS_OSX::disable_crash_handler() {
- crash_handler.disable();
-}
-
-bool OS_OSX::is_disable_crash_handler() const {
- return crash_handler.is_disabled();
-}
-
-Error OS_OSX::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_OSX::run() {
- force_quit = false;
-
- if (!main_loop) {
- return;
- }
-
- main_loop->initialize();
-
- bool quit = false;
- while (!force_quit && !quit) {
- @try {
- if (DisplayServer::get_singleton()) {
- DisplayServer::get_singleton()->process_events(); // Get rid of pending events.
- }
- joypad_osx->process_joypads();
-
- if (Main::iteration()) {
- quit = true;
- }
- } @catch (NSException *exception) {
- ERR_PRINT("NSException: " + String::utf8([exception reason].UTF8String));
- }
- }
-
- main_loop->finalize();
-}
-
-OS_OSX::OS_OSX() {
- main_loop = nullptr;
- force_quit = false;
-
- Vector<Logger *> loggers;
- loggers.push_back(memnew(OSXTerminalLogger));
- _set_logger(memnew(CompositeLogger(loggers)));
-
-#ifdef COREAUDIO_ENABLED
- AudioDriverManager::add_driver(&audio_driver);
-#endif
-
- DisplayServerOSX::register_osx_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_OSX::~OS_OSX() {
- CFRunLoopRemoveObserver(CFRunLoopGetCurrent(), pre_wait_observer, kCFRunLoopCommonModes);
- CFRelease(pre_wait_observer);
-}