2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* os_osx.h */
|
|
|
|
/*************************************************************************/
|
|
|
|
/* This file is part of: */
|
|
|
|
/* GODOT ENGINE */
|
2017-08-27 14:16:55 +02:00
|
|
|
/* https://godotengine.org */
|
2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
2018-01-01 14:40:08 +01:00
|
|
|
/* Copyright (c) 2007-2018 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2018 Godot Engine contributors (cf. AUTHORS.md) */
|
2014-02-10 02:10:30 +01: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-10 02:10:30 +01:00
|
|
|
#ifndef OS_OSX_H
|
|
|
|
#define OS_OSX_H
|
|
|
|
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/os/input.h"
|
2017-09-08 03:01:49 +02:00
|
|
|
#include "crash_handler_osx.h"
|
2017-09-29 20:22:42 +02:00
|
|
|
#include "drivers/coreaudio/audio_driver_coreaudio.h"
|
2018-07-14 14:11:28 +02:00
|
|
|
#include "drivers/coremidi/core_midi.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
#include "drivers/unix/os_unix.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "joypad_osx.h"
|
2015-09-24 23:06:15 +02:00
|
|
|
#include "main/input_default.h"
|
2017-06-10 15:15:33 +02:00
|
|
|
#include "power_osx.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "servers/audio_server.h"
|
|
|
|
#include "servers/visual/rasterizer.h"
|
2017-06-10 15:15:33 +02:00
|
|
|
#include "servers/visual/visual_server_wrap_mt.h"
|
|
|
|
#include "servers/visual_server.h"
|
2017-11-10 11:50:11 +01:00
|
|
|
#include <AppKit/NSCursor.h>
|
2014-02-10 02:10:30 +01:00
|
|
|
#include <ApplicationServices/ApplicationServices.h>
|
|
|
|
|
|
|
|
#undef CursorShape
|
|
|
|
/**
|
|
|
|
@author Juan Linietsky <reduzio@gmail.com>
|
|
|
|
*/
|
|
|
|
|
|
|
|
class OS_OSX : public OS_Unix {
|
|
|
|
public:
|
2018-01-10 12:22:28 +01:00
|
|
|
struct KeyEvent {
|
|
|
|
unsigned int osx_state;
|
|
|
|
bool pressed;
|
|
|
|
bool echo;
|
|
|
|
uint32_t scancode;
|
|
|
|
uint32_t unicode;
|
|
|
|
};
|
|
|
|
|
2018-01-19 08:47:30 +01:00
|
|
|
Vector<KeyEvent> key_event_buffer;
|
2018-01-10 12:22:28 +01:00
|
|
|
int key_event_pos;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
bool force_quit;
|
2017-03-05 16:44:50 +01:00
|
|
|
// rasterizer seems to no longer be given to visual server, its using GLES3 directly?
|
2017-01-14 12:26:56 +01:00
|
|
|
//Rasterizer *rasterizer;
|
2014-02-10 02:10:30 +01:00
|
|
|
VisualServer *visual_server;
|
2016-05-30 05:28:29 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
List<String> args;
|
|
|
|
MainLoop *main_loop;
|
|
|
|
|
|
|
|
IP_Unix *ip_unix;
|
|
|
|
|
2018-10-25 15:59:26 +02:00
|
|
|
#ifdef COREAUDIO_ENABLED
|
2017-09-29 20:22:42 +02:00
|
|
|
AudioDriverCoreAudio audio_driver;
|
2018-10-25 15:59:26 +02:00
|
|
|
#endif
|
|
|
|
#ifdef COREMIDI_ENABLED
|
2018-07-14 14:11:28 +02:00
|
|
|
MIDIDriverCoreMidi midi_driver;
|
2018-10-25 15:59:26 +02:00
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
InputDefault *input;
|
2017-01-08 21:05:51 +01:00
|
|
|
JoypadOSX *joypad_osx;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
/* objc */
|
|
|
|
|
|
|
|
CGEventSourceRef eventSource;
|
|
|
|
|
|
|
|
void process_events();
|
2018-01-10 12:22:28 +01:00
|
|
|
void process_key_events();
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void *framework;
|
|
|
|
// pthread_key_t current;
|
2014-02-10 02:10:30 +01:00
|
|
|
bool mouse_grab;
|
|
|
|
Point2 mouse_pos;
|
|
|
|
|
|
|
|
id delegate;
|
|
|
|
id window_delegate;
|
|
|
|
id window_object;
|
|
|
|
id window_view;
|
|
|
|
id autoreleasePool;
|
|
|
|
id cursor;
|
|
|
|
id pixelFormat;
|
|
|
|
id context;
|
|
|
|
|
2017-12-10 19:38:26 +01:00
|
|
|
bool layered_window;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
CursorShape cursor_shape;
|
2018-03-22 04:17:18 +01:00
|
|
|
NSCursor *cursors[CURSOR_MAX];
|
2014-06-26 14:14:37 +02:00
|
|
|
MouseMode mouse_mode;
|
2015-04-02 06:32:02 +02:00
|
|
|
|
2017-06-27 18:13:03 +02:00
|
|
|
String title;
|
2015-04-02 06:32:02 +02:00
|
|
|
bool minimized;
|
|
|
|
bool maximized;
|
|
|
|
bool zoomed;
|
2018-05-23 21:25:41 +02:00
|
|
|
bool resizable;
|
2016-05-30 05:28:29 +02:00
|
|
|
|
|
|
|
Size2 window_size;
|
2015-04-02 06:32:02 +02:00
|
|
|
Rect2 restore_rect;
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2018-01-12 15:38:19 +01:00
|
|
|
String open_with_filename;
|
|
|
|
|
2017-08-07 13:09:56 +02:00
|
|
|
Point2 im_position;
|
2018-06-07 22:16:57 +02:00
|
|
|
bool im_active;
|
2017-08-07 13:09:56 +02:00
|
|
|
ImeCallback im_callback;
|
|
|
|
void *im_target;
|
|
|
|
|
2016-07-23 13:15:55 +02:00
|
|
|
power_osx *power_manager;
|
2016-05-30 05:28:29 +02:00
|
|
|
|
2017-09-08 03:01:49 +02:00
|
|
|
CrashHandler crash_handler;
|
|
|
|
|
2016-05-30 05:28:29 +02:00
|
|
|
float _mouse_scale(float p_scale) {
|
2017-09-30 12:50:30 +02:00
|
|
|
if (_display_scale() > 1.0)
|
2016-05-30 05:28:29 +02:00
|
|
|
return p_scale;
|
|
|
|
else
|
|
|
|
return 1.0;
|
|
|
|
}
|
|
|
|
|
2017-09-30 12:50:30 +02:00
|
|
|
float _display_scale() const;
|
|
|
|
float _display_scale(id screen) const;
|
2017-07-03 03:44:42 +02:00
|
|
|
|
2017-09-30 12:50:30 +02:00
|
|
|
void _update_window();
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2018-07-19 23:58:15 +02:00
|
|
|
int video_driver_index;
|
|
|
|
virtual int get_current_video_driver() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
protected:
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void initialize_core();
|
2018-01-03 18:26:44 +01:00
|
|
|
virtual Error initialize(const VideoMode &p_desired, int p_video_driver, int p_audio_driver);
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void finalize();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void set_main_loop(MainLoop *p_main_loop);
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void delete_main_loop();
|
|
|
|
|
|
|
|
public:
|
2017-03-05 16:44:50 +01:00
|
|
|
static OS_OSX *singleton;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-04-02 06:32:02 +02:00
|
|
|
void wm_minimized(bool p_minimized);
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual String get_name();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void alert(const String &p_alert, const String &p_title = "ALERT!");
|
2016-06-22 17:58:31 +02:00
|
|
|
|
2018-01-04 20:36:44 +01:00
|
|
|
virtual Error open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path = false);
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void set_cursor_shape(CursorShape p_shape);
|
2017-11-10 11:50:11 +01:00
|
|
|
virtual void set_custom_mouse_cursor(const RES &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
virtual void set_mouse_show(bool p_show);
|
|
|
|
virtual void set_mouse_grab(bool p_grab);
|
|
|
|
virtual bool is_mouse_grab_enabled() const;
|
2017-09-10 15:37:49 +02:00
|
|
|
virtual void warp_mouse_position(const Point2 &p_to);
|
2017-03-29 17:29:38 +02:00
|
|
|
virtual Point2 get_mouse_position() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual int get_mouse_button_state() const;
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void set_window_title(const String &p_title);
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2015-03-24 06:07:03 +01:00
|
|
|
virtual Size2 get_window_size() const;
|
2018-02-12 18:17:29 +01:00
|
|
|
virtual Size2 get_real_window_size() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-05-17 12:36:47 +02:00
|
|
|
virtual void set_icon(const Ref<Image> &p_icon);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
virtual MainLoop *get_main_loop() const;
|
|
|
|
|
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
|
|
|
virtual String get_config_path() const;
|
|
|
|
virtual String get_data_path() const;
|
|
|
|
virtual String get_cache_path() const;
|
|
|
|
virtual String get_godot_dir_name() const;
|
|
|
|
|
2017-08-29 18:22:06 +02:00
|
|
|
virtual String get_system_dir(SystemDir p_dir) const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual bool can_draw() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void set_clipboard(const String &p_text);
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual String get_clipboard() const;
|
|
|
|
|
|
|
|
virtual void release_rendering_thread();
|
|
|
|
virtual void make_rendering_thread();
|
|
|
|
virtual void swap_buffers();
|
|
|
|
|
|
|
|
Error shell_open(String p_uri);
|
2017-05-20 17:38:03 +02:00
|
|
|
void push_input(const Ref<InputEvent> &p_event);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2015-10-16 19:42:26 +02:00
|
|
|
String get_locale() const;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void set_video_mode(const VideoMode &p_video_mode, int p_screen = 0);
|
|
|
|
virtual VideoMode get_video_mode(int p_screen = 0) const;
|
|
|
|
virtual void get_fullscreen_mode_list(List<VideoMode> *p_list, int p_screen = 0) const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
virtual String get_executable_path() const;
|
|
|
|
|
2015-01-08 08:26:27 +01:00
|
|
|
virtual LatinKeyboardVariant get_latin_keyboard_variant() const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void move_window_to_foreground();
|
|
|
|
|
2015-04-02 06:32:02 +02:00
|
|
|
virtual int get_screen_count() const;
|
|
|
|
virtual int get_current_screen() const;
|
|
|
|
virtual void set_current_screen(int p_screen);
|
2017-08-20 21:12:29 +02:00
|
|
|
virtual Point2 get_screen_position(int p_screen = -1) const;
|
|
|
|
virtual Size2 get_screen_size(int p_screen = -1) const;
|
|
|
|
virtual int get_screen_dpi(int p_screen = -1) const;
|
2016-05-30 05:28:29 +02:00
|
|
|
|
2015-04-02 06:32:02 +02:00
|
|
|
virtual Point2 get_window_position() const;
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void set_window_position(const Point2 &p_position);
|
2015-04-02 06:32:02 +02:00
|
|
|
virtual void set_window_size(const Size2 p_size);
|
|
|
|
virtual void set_window_fullscreen(bool p_enabled);
|
|
|
|
virtual bool is_window_fullscreen() const;
|
|
|
|
virtual void set_window_resizable(bool p_enabled);
|
|
|
|
virtual bool is_window_resizable() const;
|
|
|
|
virtual void set_window_minimized(bool p_enabled);
|
|
|
|
virtual bool is_window_minimized() const;
|
|
|
|
virtual void set_window_maximized(bool p_enabled);
|
|
|
|
virtual bool is_window_maximized() const;
|
2018-01-30 20:39:53 +01:00
|
|
|
virtual void set_window_always_on_top(bool p_enabled);
|
|
|
|
virtual bool is_window_always_on_top() const;
|
2016-07-21 17:30:20 +02:00
|
|
|
virtual void request_attention();
|
2016-09-06 00:47:54 +02:00
|
|
|
virtual String get_joy_guid(int p_device) const;
|
2017-03-05 16:44:50 +01:00
|
|
|
|
2017-12-14 19:15:46 +01:00
|
|
|
virtual void set_borderless_window(bool p_borderless);
|
2017-06-27 18:13:03 +02:00
|
|
|
virtual bool get_borderless_window();
|
2017-12-10 19:38:26 +01:00
|
|
|
|
|
|
|
virtual bool get_window_per_pixel_transparency_enabled() const;
|
|
|
|
virtual void set_window_per_pixel_transparency_enabled(bool p_enabled);
|
|
|
|
|
2018-06-07 22:16:57 +02:00
|
|
|
virtual void set_ime_active(const bool p_active);
|
2017-08-07 13:09:56 +02:00
|
|
|
virtual void set_ime_position(const Point2 &p_pos);
|
|
|
|
virtual void set_ime_intermediate_text_callback(ImeCallback p_callback, void *p_inp);
|
2017-06-27 18:13:03 +02:00
|
|
|
|
2018-01-20 16:17:39 +01:00
|
|
|
virtual String get_unique_id() const;
|
|
|
|
|
2017-09-12 21:09:06 +02:00
|
|
|
virtual OS::PowerState get_power_state();
|
2016-07-23 13:15:55 +02:00
|
|
|
virtual int get_power_seconds_left();
|
|
|
|
virtual int get_power_percent_left();
|
2015-04-02 06:32:02 +02:00
|
|
|
|
2017-07-19 22:00:46 +02:00
|
|
|
virtual bool _check_internal_feature_support(const String &p_feature);
|
|
|
|
|
2017-12-16 21:09:25 +01:00
|
|
|
virtual void _set_use_vsync(bool p_enable);
|
|
|
|
//virtual bool is_vsync_enabled() const;
|
2017-10-23 18:26:33 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
void run();
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void set_mouse_mode(MouseMode p_mode);
|
|
|
|
MouseMode get_mouse_mode() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-09-08 03:01:49 +02:00
|
|
|
void disable_crash_handler();
|
|
|
|
bool is_disable_crash_handler() const;
|
|
|
|
|
2017-09-25 15:15:11 +02:00
|
|
|
virtual Error move_to_trash(const String &p_path);
|
|
|
|
|
2017-12-14 12:59:46 +01:00
|
|
|
void force_process_input();
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
OS_OSX();
|
2017-11-03 11:00:29 +01:00
|
|
|
|
|
|
|
private:
|
|
|
|
Point2 get_native_screen_position(int p_screen) const;
|
|
|
|
Point2 get_native_window_position() const;
|
|
|
|
void set_native_window_position(const Point2 &p_position);
|
|
|
|
Point2 get_screens_origin() const;
|
2014-02-10 02:10:30 +01:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|