2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* os_x11.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_X11_H
|
|
|
|
#define OS_X11_H
|
|
|
|
|
|
|
|
#include "context_gl_x11.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_x11.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
#include "drivers/alsa/audio_driver_alsa.h"
|
2018-07-14 14:11:28 +02:00
|
|
|
#include "drivers/alsamidi/alsa_midi.h"
|
2014-12-19 13:44:34 +01:00
|
|
|
#include "drivers/pulseaudio/audio_driver_pulseaudio.h"
|
2018-10-01 17:27:00 +02:00
|
|
|
#include "drivers/unix/os_unix.h"
|
2017-03-05 16:44:50 +01:00
|
|
|
#include "joypad_linux.h"
|
|
|
|
#include "main/input_default.h"
|
|
|
|
#include "power_x11.h"
|
|
|
|
#include "servers/audio_server.h"
|
|
|
|
#include "servers/visual/rasterizer.h"
|
2018-10-01 17:27:00 +02:00
|
|
|
#include "servers/visual_server.h"
|
|
|
|
//#include "servers/visual/visual_server_wrap_mt.h"
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
#include <X11/Xcursor/Xcursor.h>
|
2017-03-05 16:44:50 +01:00
|
|
|
#include <X11/Xlib.h>
|
2016-06-09 18:54:06 +02:00
|
|
|
#include <X11/extensions/Xrandr.h>
|
2017-03-05 16:44:50 +01:00
|
|
|
#include <X11/keysym.h>
|
2017-11-29 21:01:26 +01:00
|
|
|
#ifdef TOUCH_ENABLED
|
|
|
|
#include <X11/extensions/XInput2.h>
|
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2014-09-16 09:22:29 +02:00
|
|
|
// Hints for X11 fullscreen
|
|
|
|
typedef struct {
|
|
|
|
unsigned long flags;
|
|
|
|
unsigned long functions;
|
|
|
|
unsigned long decorations;
|
|
|
|
long inputMode;
|
|
|
|
unsigned long status;
|
|
|
|
} Hints;
|
|
|
|
|
2016-06-09 18:54:06 +02:00
|
|
|
typedef struct _xrr_monitor_info {
|
2017-03-05 16:44:50 +01:00
|
|
|
Atom name;
|
|
|
|
Bool primary;
|
|
|
|
Bool automatic;
|
|
|
|
int noutput;
|
|
|
|
int x;
|
|
|
|
int y;
|
|
|
|
int width;
|
|
|
|
int height;
|
|
|
|
int mwidth;
|
|
|
|
int mheight;
|
|
|
|
RROutput *outputs;
|
2016-06-09 18:54:06 +02:00
|
|
|
} xrr_monitor_info;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#undef CursorShape
|
|
|
|
/**
|
|
|
|
@author Juan Linietsky <reduzio@gmail.com>
|
|
|
|
*/
|
|
|
|
|
|
|
|
class OS_X11 : public OS_Unix {
|
|
|
|
|
|
|
|
Atom wm_delete;
|
2016-05-28 21:35:42 +02:00
|
|
|
Atom xdnd_enter;
|
|
|
|
Atom xdnd_position;
|
|
|
|
Atom xdnd_status;
|
|
|
|
Atom xdnd_action_copy;
|
|
|
|
Atom xdnd_drop;
|
|
|
|
Atom xdnd_finished;
|
|
|
|
Atom xdnd_selection;
|
|
|
|
Atom requested;
|
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
int xdnd_version;
|
2016-05-28 21:35:42 +02:00
|
|
|
|
2017-10-13 00:18:04 +02:00
|
|
|
#if defined(OPENGL_ENABLED)
|
2014-02-10 02:10:30 +01:00
|
|
|
ContextGL_X11 *context_gl;
|
|
|
|
#endif
|
2016-10-03 21:33:42 +02:00
|
|
|
//Rasterizer *rasterizer;
|
2014-02-10 02:10:30 +01:00
|
|
|
VisualServer *visual_server;
|
|
|
|
VideoMode current_videomode;
|
|
|
|
List<String> args;
|
|
|
|
Window x11_window;
|
2016-05-28 21:35:42 +02:00
|
|
|
Window xdnd_source_window;
|
2016-03-09 00:00:52 +01:00
|
|
|
MainLoop *main_loop;
|
2017-03-05 16:44:50 +01:00
|
|
|
::Display *x11_display;
|
2014-02-10 02:10:30 +01:00
|
|
|
char *xmbstring;
|
|
|
|
int xmblen;
|
|
|
|
unsigned long last_timestamp;
|
|
|
|
::Time last_keyrelease_time;
|
|
|
|
::XIC xic;
|
|
|
|
::XIM xim;
|
|
|
|
::XIMStyle xim_style;
|
2017-06-27 11:26:43 +02:00
|
|
|
static void xim_destroy_callback(::XIM im, ::XPointer client_data,
|
|
|
|
::XPointer call_data);
|
|
|
|
|
2018-06-07 22:16:57 +02:00
|
|
|
// IME
|
|
|
|
bool im_active;
|
|
|
|
Vector2 im_position;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
Point2i last_mouse_pos;
|
|
|
|
bool last_mouse_pos_valid;
|
|
|
|
Point2i last_click_pos;
|
|
|
|
uint64_t last_click_ms;
|
|
|
|
uint32_t last_button_state;
|
2017-11-29 21:01:26 +01:00
|
|
|
#ifdef TOUCH_ENABLED
|
|
|
|
struct {
|
|
|
|
int opcode;
|
|
|
|
Vector<int> devices;
|
|
|
|
XIEventMask event_mask;
|
|
|
|
Map<int, Vector2> state;
|
2018-02-24 03:04:30 +01:00
|
|
|
Vector2 mouse_pos_to_filter;
|
2017-11-29 21:01:26 +01:00
|
|
|
} touch;
|
|
|
|
#endif
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2018-07-08 15:12:13 +02:00
|
|
|
unsigned int get_mouse_button_state(unsigned int p_x11_button, int p_x11_type);
|
2017-05-20 17:38:03 +02:00
|
|
|
void get_key_modifier_state(unsigned int p_x11_state, Ref<InputEventWithModifiers> state);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
MouseMode mouse_mode;
|
|
|
|
Point2i center;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
void handle_key_event(XKeyEvent *p_event, bool p_echo = false);
|
2014-02-10 02:10:30 +01:00
|
|
|
void process_xevents();
|
|
|
|
virtual void delete_main_loop();
|
|
|
|
|
|
|
|
bool force_quit;
|
|
|
|
bool minimized;
|
2017-01-25 19:21:41 +01:00
|
|
|
bool window_has_focus;
|
2015-08-29 06:43:21 +02:00
|
|
|
bool do_mouse_warp;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
const char *cursor_theme;
|
|
|
|
int cursor_size;
|
2015-10-25 15:15:56 +01:00
|
|
|
XcursorImage *img[CURSOR_MAX];
|
2014-02-10 02:10:30 +01:00
|
|
|
Cursor cursors[CURSOR_MAX];
|
|
|
|
Cursor null_cursor;
|
|
|
|
CursorShape current_cursor;
|
|
|
|
|
|
|
|
InputDefault *input;
|
|
|
|
|
2015-12-21 22:39:03 +01:00
|
|
|
#ifdef JOYDEV_ENABLED
|
2017-01-08 22:22:00 +01:00
|
|
|
JoypadLinux *joypad;
|
2015-12-18 06:12:53 +01:00
|
|
|
#endif
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#ifdef ALSA_ENABLED
|
|
|
|
AudioDriverALSA driver_alsa;
|
|
|
|
#endif
|
|
|
|
|
2018-07-14 14:11:28 +02:00
|
|
|
#ifdef ALSAMIDI_ENABLED
|
|
|
|
MIDIDriverALSAMidi driver_alsamidi;
|
|
|
|
#endif
|
|
|
|
|
2014-12-19 13:44:34 +01:00
|
|
|
#ifdef PULSEAUDIO_ENABLED
|
|
|
|
AudioDriverPulseAudio driver_pulseaudio;
|
|
|
|
#endif
|
|
|
|
|
2016-07-23 13:15:55 +02:00
|
|
|
PowerX11 *power_manager;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-12-10 19:38:26 +01:00
|
|
|
bool layered_window;
|
|
|
|
|
2017-09-08 03:01:49 +02:00
|
|
|
CrashHandler crash_handler;
|
|
|
|
|
2018-07-19 23:58:15 +02:00
|
|
|
int video_driver_index;
|
2015-01-15 14:50:23 +01:00
|
|
|
bool maximized;
|
2015-01-17 16:28:04 +01:00
|
|
|
//void set_wm_border(bool p_enabled);
|
2015-01-10 14:50:31 +01:00
|
|
|
void set_wm_fullscreen(bool p_enabled);
|
2017-12-27 20:51:19 +01:00
|
|
|
void set_wm_above(bool p_enabled);
|
2015-03-22 23:00:50 +01:00
|
|
|
|
2017-03-05 16:44:50 +01:00
|
|
|
typedef xrr_monitor_info *(*xrr_get_monitors_t)(Display *dpy, Window window, Bool get_active, int *nmonitors);
|
|
|
|
typedef void (*xrr_free_monitors_t)(xrr_monitor_info *monitors);
|
2016-06-09 18:54:06 +02:00
|
|
|
xrr_get_monitors_t xrr_get_monitors;
|
2016-06-12 15:29:02 +02:00
|
|
|
xrr_free_monitors_t xrr_free_monitors;
|
2016-06-09 18:54:06 +02:00
|
|
|
void *xrandr_handle;
|
2016-06-12 15:29:02 +02:00
|
|
|
Bool xrandr_ext_ok;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
protected:
|
2018-07-20 11:56:18 +02:00
|
|
|
virtual int get_current_video_driver() const;
|
|
|
|
|
2017-09-08 03:01:49 +02: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);
|
2015-01-10 14:50:31 +01:00
|
|
|
|
2018-02-01 09:57:10 +01:00
|
|
|
void _window_changed(XEvent *event);
|
2017-10-24 21:35:28 +02:00
|
|
|
|
2017-12-27 11:25:57 +01:00
|
|
|
bool is_window_maximize_allowed();
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
public:
|
|
|
|
virtual String get_name();
|
|
|
|
|
|
|
|
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
|
|
|
|
|
|
|
void set_mouse_mode(MouseMode p_mode);
|
|
|
|
MouseMode get_mouse_mode() 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);
|
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;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
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();
|
|
|
|
|
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;
|
|
|
|
|
2014-12-02 18:02:41 +01:00
|
|
|
virtual String get_system_dir(SystemDir p_dir) const;
|
|
|
|
|
2014-04-18 16:43:54 +02:00
|
|
|
virtual Error shell_open(String p_uri);
|
2014-02-10 02:10:30 +01:00
|
|
|
|
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;
|
2015-03-22 23:00:50 +01:00
|
|
|
|
2015-01-11 11:52:42 +01:00
|
|
|
virtual int get_screen_count() const;
|
2015-03-22 23:00:50 +01:00
|
|
|
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;
|
2015-01-11 08:47:27 +01: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-01-11 10:36:56 +01:00
|
|
|
virtual Size2 get_window_size() const;
|
2018-02-12 18:17:29 +01:00
|
|
|
virtual Size2 get_real_window_size() const;
|
2015-01-11 10:36:56 +01:00
|
|
|
virtual void set_window_size(const Size2 p_size);
|
2015-03-22 23:00:50 +01:00
|
|
|
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;
|
2017-12-27 20:51:19 +01:00
|
|
|
virtual void set_window_always_on_top(bool p_enabled);
|
|
|
|
virtual bool is_window_always_on_top() const;
|
2016-07-21 19:40:36 +02:00
|
|
|
virtual void request_attention();
|
2015-03-22 23:00:50 +01:00
|
|
|
|
2017-12-14 19:15:46 +01:00
|
|
|
virtual void set_borderless_window(bool p_borderless);
|
2017-07-05 17:19:24 +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-06-25 17:50:45 +02:00
|
|
|
virtual void set_ime_position(const Point2 &p_pos);
|
2017-07-05 17:19:24 +02:00
|
|
|
|
2018-01-20 14:42:19 +01:00
|
|
|
virtual String get_unique_id() const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
virtual void move_window_to_foreground();
|
2017-03-05 16:44:50 +01:00
|
|
|
virtual void alert(const String &p_alert, const String &p_title = "ALERT!");
|
2016-01-08 00:40:41 +01:00
|
|
|
|
|
|
|
virtual bool is_joy_known(int p_device);
|
|
|
|
virtual String get_joy_guid(int p_device) const;
|
|
|
|
|
2016-01-27 21:53:37 +01:00
|
|
|
virtual void set_context(int p_context);
|
|
|
|
|
2017-12-16 21:09:25 +01:00
|
|
|
virtual void _set_use_vsync(bool p_enable);
|
|
|
|
//virtual bool is_vsync_enabled() const;
|
2016-06-06 00:14:33 +02:00
|
|
|
|
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();
|
|
|
|
|
2017-07-19 22:00:46 +02:00
|
|
|
virtual bool _check_internal_feature_support(const String &p_feature);
|
|
|
|
|
2017-12-14 12:59:46 +01:00
|
|
|
virtual void force_process_input();
|
2014-02-10 02:10:30 +01:00
|
|
|
void run();
|
|
|
|
|
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-10-30 15:40:42 +01:00
|
|
|
virtual LatinKeyboardVariant get_latin_keyboard_variant() const;
|
|
|
|
|
2018-09-09 22:13:50 +02:00
|
|
|
void update_real_mouse_position();
|
2014-02-10 02:10:30 +01:00
|
|
|
OS_X11();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|