| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | /**************************************************************************/ | 
					
						
							| 
									
										
										
										
											2022-07-20 09:28:22 +03:00
										 |  |  | /*  os_macos.h                                                            */ | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | /**************************************************************************/ | 
					
						
							|  |  |  | /*                         This file is part of:                          */ | 
					
						
							|  |  |  | /*                             GODOT ENGINE                               */ | 
					
						
							|  |  |  | /*                        https://godotengine.org                         */ | 
					
						
							|  |  |  | /**************************************************************************/ | 
					
						
							|  |  |  | /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | 
					
						
							|  |  |  | /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur.                  */ | 
					
						
							|  |  |  | /*                                                                        */ | 
					
						
							|  |  |  | /* 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.                 */ | 
					
						
							|  |  |  | /**************************************************************************/ | 
					
						
							| 
									
										
										
										
											2018-01-05 00:50:27 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 09:28:22 +03:00
										 |  |  | #ifndef OS_MACOS_H
 | 
					
						
							|  |  |  | #define OS_MACOS_H
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 09:28:22 +03:00
										 |  |  | #include "crash_handler_macos.h"
 | 
					
						
							|  |  |  | #include "joypad_macos.h"
 | 
					
						
							| 
									
										
										
										
											2023-06-08 14:51:32 +02:00
										 |  |  | 
 | 
					
						
							|  |  |  | #include "core/input/input.h"
 | 
					
						
							|  |  |  | #import "drivers/coreaudio/audio_driver_coreaudio.h"
 | 
					
						
							|  |  |  | #import "drivers/coremidi/midi_driver_coremidi.h"
 | 
					
						
							|  |  |  | #include "drivers/unix/os_unix.h"
 | 
					
						
							| 
									
										
										
										
											2017-01-16 20:32:44 +11:00
										 |  |  | #include "servers/audio_server.h"
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 09:28:22 +03:00
										 |  |  | class OS_MacOS : public OS_Unix { | 
					
						
							|  |  |  | 	JoypadMacOS *joypad_macos = nullptr; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2018-10-25 10:59:26 -03:00
										 |  |  | #ifdef COREAUDIO_ENABLED
 | 
					
						
							| 
									
										
										
										
											2017-09-29 15:22:42 -03:00
										 |  |  | 	AudioDriverCoreAudio audio_driver; | 
					
						
							| 
									
										
										
										
											2018-10-25 10:59:26 -03:00
										 |  |  | #endif
 | 
					
						
							|  |  |  | #ifdef COREMIDI_ENABLED
 | 
					
						
							| 
									
										
										
										
											2018-07-14 09:11:28 -03:00
										 |  |  | 	MIDIDriverCoreMidi midi_driver; | 
					
						
							| 
									
										
										
										
											2018-10-25 10:59:26 -03:00
										 |  |  | #endif
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-09-07 22:01:49 -03:00
										 |  |  | 	CrashHandler crash_handler; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	CFRunLoopObserverRef pre_wait_observer; | 
					
						
							| 
									
										
										
										
											2019-02-06 15:57:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	MainLoop *main_loop = nullptr; | 
					
						
							| 
									
										
										
										
											2021-11-08 12:35:13 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-07 10:57:22 +03:00
										 |  |  | 	List<String> launch_service_args; | 
					
						
							| 
									
										
										
										
											2019-02-06 15:57:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-11-21 15:04:01 +02:00
										 |  |  | 	CGFloat _weight_to_ct(int p_weight) const; | 
					
						
							|  |  |  | 	CGFloat _stretch_to_ct(int p_stretch) const; | 
					
						
							|  |  |  | 	String _get_default_fontname(const String &p_font_name) const; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	static _FORCE_INLINE_ String get_framework_executable(const String &p_path); | 
					
						
							|  |  |  | 	static void pre_wait_observer_cb(CFRunLoopObserverRef p_observer, CFRunLoopActivity p_activiy, void *p_context); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | protected: | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual void initialize_core() override; | 
					
						
							|  |  |  | 	virtual void initialize() override; | 
					
						
							|  |  |  | 	virtual void finalize() override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual void initialize_joypads() override; | 
					
						
							| 
									
										
										
										
											2020-03-07 18:02:54 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual void set_main_loop(MainLoop *p_main_loop) override; | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	virtual void delete_main_loop() override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							|  |  |  | public: | 
					
						
							| 
									
										
										
										
											2022-07-07 10:57:22 +03:00
										 |  |  | 	virtual void set_cmdline_platform_args(const List<String> &p_args); | 
					
						
							|  |  |  | 	virtual List<String> get_cmdline_platform_args() const override; | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_name() const override; | 
					
						
							| 
									
										
										
										
											2022-09-16 11:14:14 +02:00
										 |  |  | 	virtual String get_distribution_name() const override; | 
					
						
							|  |  |  | 	virtual String get_version() const override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-07-22 19:23:48 +03:00
										 |  |  | 	virtual void alert(const String &p_alert, const String &p_title = "ALERT!") override; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-04-29 00:51:04 +02:00
										 |  |  | 	virtual Error open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path = false, String *r_resolved_path = nullptr) override; | 
					
						
							| 
									
										
										
										
											2018-01-04 21:36:44 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual MainLoop *get_main_loop() const override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_config_path() const override; | 
					
						
							|  |  |  | 	virtual String get_data_path() const override; | 
					
						
							|  |  |  | 	virtual String get_cache_path() const override; | 
					
						
							|  |  |  | 	virtual String get_bundle_resource_dir() const override; | 
					
						
							| 
									
										
										
										
											2021-05-13 09:25:09 +03:00
										 |  |  | 	virtual String get_bundle_icon_path() const override; | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_godot_dir_name() const override; | 
					
						
							| 
									
										
											  
											
												Add initial support for the XDG Base Directory spec
Spec version 0.7 from https://standards.freedesktop.org/basedir-spec/basedir-spec-0.7.html
(latest as of this commit).
Three virtual methods are added to OS for the various XDG paths we will use:
- OS::get_data_path gives XDG_DATA_HOME, or if missing:
  ~/.local/share on X11, ~/Library/Application Support/ on macOS and %APPDATA% on Windows
- OS::get_config_path gives XDG_CONFIG_HOME, or if missing:
  ~/.config on X11, ~/Library/Application Support/ on macOS and %APPDATA% on Windows
- OS::get_cache_path gives XDG_CACHE_HOME, or if missing:
  ~/.cache on X11, ~/Library/Caches on macOS and %APPDATA% on Windows
So for Windows there are no changes, for Linux we follow the full split spec
and for macOS stuff will move from ~/.godot to ~/Library/Application Support/Godot.
Support for system-wide installation of templates on Unix was removed for now,
as it's a bit hackish and I don't think anyone uses it.
user:// will still be OS::get_data_path() + "/godot/app_userdata/$name" by
default, but when using the application/config/use_shared_user_dir option
it will now use XDG_DATA_HOME/$name, e.g. ~/.local/share/MyGame.
For now everything still goes in EditorSettings::get_settings_dir(), but
this will be changed in a later commit to make use of the new splitting
where relevant.
Part of #3513.
											
										 
											2017-11-17 17:11:41 +01:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-07-10 18:39:31 -07:00
										 |  |  | 	virtual String get_system_dir(SystemDir p_dir, bool p_shared_storage = true) const override; | 
					
						
							| 
									
										
										
										
											2017-08-29 18:22:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	virtual Error shell_open(String p_uri) override; | 
					
						
							| 
									
										
										
										
											2023-04-25 11:15:38 +03:00
										 |  |  | 	virtual Error shell_show_in_file_manager(String p_path, bool p_open_folder) override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	virtual String get_locale() const override; | 
					
						
							| 
									
										
										
										
											2015-10-16 19:42:26 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-08 15:38:30 +03:00
										 |  |  | 	virtual Vector<String> get_system_fonts() const override; | 
					
						
							| 
									
										
										
										
											2022-11-21 15:04:01 +02:00
										 |  |  | 	virtual String get_system_font_path(const String &p_font_name, int p_weight = 400, int p_stretch = 100, bool p_italic = false) const override; | 
					
						
							|  |  |  | 	virtual Vector<String> get_system_font_path_for_text(const String &p_font_name, const String &p_text, const String &p_locale = String(), const String &p_script = String(), int p_weight = 400, int p_stretch = 100, bool p_italic = false) const override; | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_executable_path() const override; | 
					
						
							| 
									
										
										
										
											2021-12-16 15:00:55 +02:00
										 |  |  | 	virtual Error create_process(const String &p_path, const List<String> &p_arguments, ProcessID *r_child_id = nullptr, bool p_open_console = false) override; | 
					
						
							| 
									
										
										
										
											2021-11-01 11:12:52 +02:00
										 |  |  | 	virtual Error create_instance(const List<String> &p_arguments, ProcessID *r_child_id = nullptr) override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	virtual String get_unique_id() const override; | 
					
						
							| 
									
										
										
										
											2020-12-27 01:50:21 +01:00
										 |  |  | 	virtual String get_processor_name() const override; | 
					
						
							| 
									
										
										
										
											2018-01-20 23:17:39 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2021-03-30 15:42:50 +03:00
										 |  |  | 	virtual bool is_sandboxed() const override; | 
					
						
							|  |  |  | 	virtual Vector<String> get_granted_permissions() const override; | 
					
						
							|  |  |  | 	virtual void revoke_granted_permissions() override; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual bool _check_internal_feature_support(const String &p_feature) override; | 
					
						
							| 
									
										
										
										
											2017-07-19 17:00:46 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual void disable_crash_handler() override; | 
					
						
							|  |  |  | 	virtual bool is_disable_crash_handler() const override; | 
					
						
							| 
									
										
										
										
											2017-09-07 22:01:49 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual Error move_to_trash(const String &p_path) override; | 
					
						
							| 
									
										
										
										
											2017-09-25 10:15:11 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2023-04-13 21:17:55 +02:00
										 |  |  | 	virtual String get_system_ca_certificates() override; | 
					
						
							| 
									
										
										
										
											2023-05-15 11:04:49 -05:00
										 |  |  | 	virtual OS::PreferredTextureFormat get_preferred_texture_format() const override; | 
					
						
							| 
									
										
										
										
											2023-04-13 21:17:55 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-01-26 11:01:27 +02:00
										 |  |  | 	void run(); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-20 09:28:22 +03:00
										 |  |  | 	OS_MacOS(); | 
					
						
							|  |  |  | 	~OS_MacOS(); | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | }; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2022-07-23 23:41:51 +02:00
										 |  |  | #endif // OS_MACOS_H
 |