os_osx.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334
  1. /*************************************************************************/
  2. /* os_osx.h */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #ifndef OS_OSX_H
  31. #define OS_OSX_H
  32. #define BitMap _QDBitMap // Suppress deprecated QuickDraw definition.
  33. #include "core/os/input.h"
  34. #include "crash_handler_osx.h"
  35. #include "drivers/coreaudio/audio_driver_coreaudio.h"
  36. #include "drivers/coremidi/midi_driver_coremidi.h"
  37. #include "drivers/unix/os_unix.h"
  38. #include "joypad_osx.h"
  39. #include "main/input_default.h"
  40. #include "power_osx.h"
  41. #include "servers/audio_server.h"
  42. #include "servers/visual/rasterizer.h"
  43. #include "servers/visual/visual_server_wrap_mt.h"
  44. #include "servers/visual_server.h"
  45. #include <AppKit/AppKit.h>
  46. #include <AppKit/NSCursor.h>
  47. #include <ApplicationServices/ApplicationServices.h>
  48. #include <CoreVideo/CoreVideo.h>
  49. #undef BitMap
  50. #undef CursorShape
  51. class OS_OSX : public OS_Unix {
  52. public:
  53. struct KeyEvent {
  54. unsigned int osx_state;
  55. bool pressed;
  56. bool echo;
  57. bool raw;
  58. uint32_t scancode;
  59. uint32_t physical_scancode;
  60. uint32_t unicode;
  61. };
  62. struct WarpEvent {
  63. NSTimeInterval timestamp;
  64. NSPoint delta;
  65. };
  66. List<WarpEvent> warp_events;
  67. NSTimeInterval last_warp = 0;
  68. bool ignore_warp = false;
  69. Vector<KeyEvent> key_event_buffer;
  70. int key_event_pos;
  71. bool force_quit;
  72. // rasterizer seems to no longer be given to visual server, its using GLES3 directly?
  73. //Rasterizer *rasterizer;
  74. VisualServer *visual_server;
  75. List<String> args;
  76. MainLoop *main_loop;
  77. #ifdef COREAUDIO_ENABLED
  78. AudioDriverCoreAudio audio_driver;
  79. #endif
  80. #ifdef COREMIDI_ENABLED
  81. MIDIDriverCoreMidi midi_driver;
  82. #endif
  83. InputDefault *input;
  84. JoypadOSX *joypad_osx;
  85. /* objc */
  86. CGEventSourceRef eventSource;
  87. void process_events();
  88. void process_key_events();
  89. void *framework;
  90. // pthread_key_t current;
  91. bool mouse_grab;
  92. Point2 mouse_pos;
  93. id delegate;
  94. id window_delegate;
  95. id window_object;
  96. id window_view;
  97. id autoreleasePool;
  98. id cursor;
  99. NSOpenGLPixelFormat *pixelFormat;
  100. NSOpenGLContext *context;
  101. Vector<Vector2> mpath;
  102. bool layered_window;
  103. CursorShape cursor_shape;
  104. NSCursor *cursors[CURSOR_MAX];
  105. Map<CursorShape, Vector<Variant>> cursors_cache;
  106. MouseMode mouse_mode;
  107. String title;
  108. bool minimized;
  109. bool maximized;
  110. bool zoomed;
  111. bool resizable;
  112. bool window_focused;
  113. bool on_top;
  114. Size2 window_size;
  115. Rect2 restore_rect;
  116. String open_with_filename;
  117. Point2 im_position;
  118. bool im_active;
  119. String im_text;
  120. Point2 im_selection;
  121. Size2 min_size;
  122. Size2 max_size;
  123. PowerOSX *power_manager;
  124. CrashHandler crash_handler;
  125. void _update_window();
  126. int video_driver_index;
  127. virtual int get_current_video_driver() const;
  128. struct GlobalMenuItem {
  129. String label;
  130. Variant signal;
  131. Variant meta;
  132. GlobalMenuItem() {
  133. //NOP
  134. }
  135. GlobalMenuItem(const String &p_label, const Variant &p_signal, const Variant &p_meta) {
  136. label = p_label;
  137. signal = p_signal;
  138. meta = p_meta;
  139. }
  140. };
  141. Map<String, Vector<GlobalMenuItem>> global_menus;
  142. List<String> global_menus_order;
  143. void _update_global_menu();
  144. protected:
  145. virtual void initialize_core();
  146. virtual Error initialize(const VideoMode &p_desired, int p_video_driver, int p_audio_driver);
  147. virtual void finalize();
  148. virtual void set_main_loop(MainLoop *p_main_loop);
  149. virtual void delete_main_loop();
  150. public:
  151. static OS_OSX *singleton;
  152. void global_menu_add_item(const String &p_menu, const String &p_label, const Variant &p_signal, const Variant &p_meta);
  153. void global_menu_add_separator(const String &p_menu);
  154. void global_menu_remove_item(const String &p_menu, int p_idx);
  155. void global_menu_clear(const String &p_menu);
  156. void wm_minimized(bool p_minimized);
  157. virtual String get_name() const;
  158. virtual void alert(const String &p_alert, const String &p_title = "ALERT!");
  159. virtual Error open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path = false);
  160. virtual void set_cursor_shape(CursorShape p_shape);
  161. virtual CursorShape get_cursor_shape() const;
  162. virtual void set_custom_mouse_cursor(const RES &p_cursor, CursorShape p_shape, const Vector2 &p_hotspot);
  163. virtual void set_mouse_show(bool p_show);
  164. virtual void set_mouse_grab(bool p_grab);
  165. virtual bool is_mouse_grab_enabled() const;
  166. virtual void warp_mouse_position(const Point2 &p_to);
  167. virtual Point2 get_mouse_position() const;
  168. virtual int get_mouse_button_state() const;
  169. void update_real_mouse_position();
  170. virtual void set_window_title(const String &p_title);
  171. virtual void set_window_mouse_passthrough(const PoolVector2Array &p_region);
  172. virtual Size2 get_window_size() const;
  173. virtual Size2 get_real_window_size() const;
  174. virtual void set_native_icon(const String &p_filename);
  175. virtual void set_icon(const Ref<Image> &p_icon);
  176. virtual MainLoop *get_main_loop() const;
  177. virtual String get_config_path() const;
  178. virtual String get_data_path() const;
  179. virtual String get_cache_path() const;
  180. virtual String get_bundle_resource_dir() const;
  181. virtual String get_godot_dir_name() const;
  182. virtual String get_system_dir(SystemDir p_dir) const;
  183. virtual bool can_draw() const;
  184. virtual void set_clipboard(const String &p_text);
  185. virtual String get_clipboard() const;
  186. virtual void release_rendering_thread();
  187. virtual void make_rendering_thread();
  188. virtual void swap_buffers();
  189. Error shell_open(String p_uri);
  190. void push_input(const Ref<InputEvent> &p_event);
  191. String get_locale() const;
  192. virtual void set_video_mode(const VideoMode &p_video_mode, int p_screen = 0);
  193. virtual VideoMode get_video_mode(int p_screen = 0) const;
  194. virtual void get_fullscreen_mode_list(List<VideoMode> *p_list, int p_screen = 0) const;
  195. virtual String get_executable_path() const;
  196. virtual LatinKeyboardVariant get_latin_keyboard_variant() const;
  197. virtual int keyboard_get_layout_count() const;
  198. virtual int keyboard_get_current_layout() const;
  199. virtual void keyboard_set_current_layout(int p_index);
  200. virtual String keyboard_get_layout_language(int p_index) const;
  201. virtual String keyboard_get_layout_name(int p_index) const;
  202. virtual void move_window_to_foreground();
  203. virtual int get_screen_count() const;
  204. virtual int get_current_screen() const;
  205. virtual void set_current_screen(int p_screen);
  206. virtual Point2 get_screen_position(int p_screen = -1) const;
  207. virtual Size2 get_screen_size(int p_screen = -1) const;
  208. virtual int get_screen_dpi(int p_screen = -1) const;
  209. virtual float get_screen_scale(int p_screen = -1) const;
  210. virtual float get_screen_max_scale() const;
  211. virtual Point2 get_window_position() const;
  212. virtual void set_window_position(const Point2 &p_position);
  213. virtual Size2 get_max_window_size() const;
  214. virtual Size2 get_min_window_size() const;
  215. virtual void set_min_window_size(const Size2 p_size);
  216. virtual void set_max_window_size(const Size2 p_size);
  217. virtual void set_window_size(const Size2 p_size);
  218. virtual void set_window_fullscreen(bool p_enabled);
  219. virtual bool is_window_fullscreen() const;
  220. virtual void set_window_resizable(bool p_enabled);
  221. virtual bool is_window_resizable() const;
  222. virtual void set_window_minimized(bool p_enabled);
  223. virtual bool is_window_minimized() const;
  224. virtual void set_window_maximized(bool p_enabled);
  225. virtual bool is_window_maximized() const;
  226. virtual void set_window_always_on_top(bool p_enabled);
  227. virtual bool is_window_always_on_top() const;
  228. virtual bool is_window_focused() const;
  229. virtual void request_attention();
  230. virtual String get_joy_guid(int p_device) const;
  231. virtual void set_borderless_window(bool p_borderless);
  232. virtual bool get_borderless_window();
  233. virtual bool get_window_per_pixel_transparency_enabled() const;
  234. virtual void set_window_per_pixel_transparency_enabled(bool p_enabled);
  235. virtual void set_ime_active(const bool p_active);
  236. virtual void set_ime_position(const Point2 &p_pos);
  237. virtual Point2 get_ime_selection() const;
  238. virtual String get_ime_text() const;
  239. virtual String get_unique_id() const;
  240. virtual OS::PowerState get_power_state();
  241. virtual int get_power_seconds_left();
  242. virtual int get_power_percent_left();
  243. virtual bool _check_internal_feature_support(const String &p_feature);
  244. virtual void _set_use_vsync(bool p_enable);
  245. //virtual bool is_vsync_enabled() const;
  246. void run();
  247. void set_mouse_mode(MouseMode p_mode);
  248. MouseMode get_mouse_mode() const;
  249. void disable_crash_handler();
  250. bool is_disable_crash_handler() const;
  251. virtual Error move_to_trash(const String &p_path);
  252. void force_process_input();
  253. OS_OSX();
  254. private:
  255. Point2 get_native_screen_position(int p_screen) const;
  256. Point2 get_native_window_position() const;
  257. void set_native_window_position(const Point2 &p_position);
  258. Point2 get_screens_origin() const;
  259. };
  260. #endif