| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | /*************************************************************************/ | 
					
						
							|  |  |  | /*  os_osx.h                                                             */ | 
					
						
							|  |  |  | /*************************************************************************/ | 
					
						
							|  |  |  | /*                       This file is part of:                           */ | 
					
						
							|  |  |  | /*                           GODOT ENGINE                                */ | 
					
						
							| 
									
										
										
										
											2017-08-27 14:16:55 +02:00
										 |  |  | /*                      https://godotengine.org                          */ | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | /*************************************************************************/ | 
					
						
							| 
									
										
										
										
											2021-01-01 20:13:46 +01:00
										 |  |  | /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur.                 */ | 
					
						
							|  |  |  | /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md).   */ | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | /*                                                                       */ | 
					
						
							|  |  |  | /* 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
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | #ifndef OS_OSX_H
 | 
					
						
							|  |  |  | #define OS_OSX_H
 | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-04-28 15:19:37 +02:00
										 |  |  | #include "core/input/input.h"
 | 
					
						
							| 
									
										
										
										
											2017-09-07 22:01:49 -03:00
										 |  |  | #include "crash_handler_osx.h"
 | 
					
						
							| 
									
										
										
										
											2017-09-29 15:22:42 -03:00
										 |  |  | #include "drivers/coreaudio/audio_driver_coreaudio.h"
 | 
					
						
							| 
									
										
										
										
											2019-02-12 14:23:35 +01:00
										 |  |  | #include "drivers/coremidi/midi_driver_coremidi.h"
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | #include "drivers/unix/os_unix.h"
 | 
					
						
							| 
									
										
										
										
											2017-03-05 16:44:50 +01:00
										 |  |  | #include "joypad_osx.h"
 | 
					
						
							|  |  |  | #include "servers/audio_server.h"
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							|  |  |  | class OS_OSX : public OS_Unix { | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual void delete_main_loop() override; | 
					
						
							| 
									
										
										
										
											2018-01-10 13:22:28 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 	bool force_quit; | 
					
						
							| 
									
										
										
										
											2016-05-30 00:28:29 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-08-02 21:30:56 +03:00
										 |  |  | 	JoypadOSX *joypad_osx = 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; | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-03-07 18:02:54 +02:00
										 |  |  | 	MainLoop *main_loop; | 
					
						
							| 
									
										
										
										
											2019-02-06 15:57:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-03-07 18:02:54 +02:00
										 |  |  | public: | 
					
						
							|  |  |  | 	String open_with_filename; | 
					
						
							| 
									
										
										
										
											2019-02-06 15:57:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2017-03-05 16:44:50 +01: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; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							|  |  |  | public: | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_name() const override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual Error open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path = false) 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; | 
					
						
							|  |  |  | 	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
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_system_dir(SystemDir p_dir) const override; | 
					
						
							| 
									
										
										
										
											2017-08-29 18:22:06 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	Error shell_open(String p_uri) override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	String get_locale() const override; | 
					
						
							| 
									
										
										
										
											2015-10-16 19:42:26 +02:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_executable_path() const override; | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2020-12-17 17:15:59 +00:00
										 |  |  | 	virtual String get_unique_id() const override; //++
 | 
					
						
							| 
									
										
										
										
											2018-01-20 23:17:39 +08:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											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
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 	void run(); | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											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
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2014-02-09 22:10:30 -03:00
										 |  |  | 	OS_OSX(); | 
					
						
							|  |  |  | }; | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | #endif
 |