2014-02-10 02:10:30 +01:00
|
|
|
/*************************************************************************/
|
|
|
|
/* os_windows.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
|
|
|
/*************************************************************************/
|
2022-01-03 21:27:34 +01:00
|
|
|
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
|
|
|
|
/* Copyright (c) 2014-2022 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_WINDOWS_H
|
|
|
|
#define OS_WINDOWS_H
|
2019-02-12 14:23:35 +01:00
|
|
|
|
2020-11-07 23:33:38 +01:00
|
|
|
#include "core/config/project_settings.h"
|
2020-04-28 15:19:37 +02:00
|
|
|
#include "core/input/input.h"
|
2018-09-11 18:13:45 +02:00
|
|
|
#include "core/os/os.h"
|
2019-02-12 15:43:54 +01:00
|
|
|
#include "crash_handler_windows.h"
|
2019-02-12 14:23:35 +01:00
|
|
|
#include "drivers/unix/ip_unix.h"
|
2017-08-27 19:01:34 +02:00
|
|
|
#include "drivers/wasapi/audio_driver_wasapi.h"
|
2019-02-12 14:23:35 +01:00
|
|
|
#include "drivers/winmidi/midi_driver_winmidi.h"
|
2019-02-12 15:43:54 +01:00
|
|
|
#include "key_mapping_windows.h"
|
2017-01-16 19:19:45 +01:00
|
|
|
#include "servers/audio_server.h"
|
2020-12-04 19:26:24 +01:00
|
|
|
#include "servers/rendering/renderer_compositor.h"
|
2020-03-27 19:21:27 +01:00
|
|
|
#include "servers/rendering_server.h"
|
2016-10-17 17:40:45 +02:00
|
|
|
#ifdef XAUDIO2_ENABLED
|
|
|
|
#include "drivers/xaudio2/audio_driver_xaudio2.h"
|
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2019-06-22 18:34:26 +02:00
|
|
|
#if defined(VULKAN_ENABLED)
|
|
|
|
#include "drivers/vulkan/rendering_device_vulkan.h"
|
|
|
|
#include "platform/windows/vulkan_context_win.h"
|
|
|
|
#endif
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
#include <fcntl.h>
|
2017-03-05 16:44:50 +01:00
|
|
|
#include <io.h>
|
2021-09-23 08:56:12 +02:00
|
|
|
#include <shellapi.h>
|
2014-02-10 02:10:30 +01:00
|
|
|
#include <stdio.h>
|
2021-09-23 08:56:12 +02:00
|
|
|
#define WIN32_LEAN_AND_MEAN
|
2017-03-05 16:44:50 +01:00
|
|
|
#include <windows.h>
|
|
|
|
#include <windowsx.h>
|
2017-01-16 19:19:45 +01:00
|
|
|
|
2017-01-08 23:52:38 +01:00
|
|
|
class JoypadWindows;
|
2014-02-10 02:10:30 +01:00
|
|
|
class OS_Windows : public OS {
|
2019-10-24 16:34:18 +02:00
|
|
|
#ifdef STDOUT_FILE
|
2014-02-10 02:10:30 +01:00
|
|
|
FILE *stdo;
|
2019-10-24 16:34:18 +02:00
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
uint64_t ticks_start;
|
|
|
|
uint64_t ticks_per_second;
|
|
|
|
|
2020-03-09 16:56:48 +01:00
|
|
|
HINSTANCE hInstance;
|
2014-02-10 02:10:30 +01:00
|
|
|
MainLoop *main_loop;
|
|
|
|
|
2017-08-27 19:01:34 +02:00
|
|
|
#ifdef WASAPI_ENABLED
|
|
|
|
AudioDriverWASAPI driver_wasapi;
|
|
|
|
#endif
|
2016-10-17 17:40:45 +02:00
|
|
|
#ifdef XAUDIO2_ENABLED
|
|
|
|
AudioDriverXAudio2 driver_xaudio2;
|
|
|
|
#endif
|
2018-07-14 14:11:28 +02:00
|
|
|
#ifdef WINMIDI_ENABLED
|
|
|
|
MIDIDriverWinMidi driver_midi;
|
|
|
|
#endif
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2017-09-08 03:01:49 +02:00
|
|
|
CrashHandler crash_handler;
|
|
|
|
|
2020-03-09 16:56:48 +01:00
|
|
|
bool force_quit;
|
|
|
|
HWND main_window;
|
2018-11-09 20:30:08 +01:00
|
|
|
|
2018-09-13 03:38:39 +02:00
|
|
|
// functions used by main to initialize/deinitialize the OS
|
2016-03-09 00:00:52 +01:00
|
|
|
protected:
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual void initialize() override;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual void set_main_loop(MainLoop *p_main_loop) override;
|
|
|
|
virtual void delete_main_loop() override;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual void finalize() override;
|
|
|
|
virtual void finalize_core() override;
|
|
|
|
virtual String get_stdin_string(bool p_block) override;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2020-05-19 15:34:15 +02:00
|
|
|
String _quote_command_line_argument(const String &p_text) const;
|
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
struct ProcessInfo {
|
|
|
|
STARTUPINFO si;
|
|
|
|
PROCESS_INFORMATION pi;
|
|
|
|
};
|
2017-03-05 16:44:50 +01:00
|
|
|
Map<ProcessID, ProcessInfo> *process_map;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
|
|
|
public:
|
2021-07-22 18:23:48 +02:00
|
|
|
virtual void alert(const String &p_alert, const String &p_title = "ALERT!") override;
|
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual Error open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path = false) override;
|
|
|
|
virtual Error close_dynamic_library(void *p_library_handle) override;
|
|
|
|
virtual Error get_dynamic_library_symbol_handle(void *p_library_handle, const String p_name, void *&p_symbol_handle, bool p_optional = false) override;
|
2017-03-08 02:50:13 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual MainLoop *get_main_loop() const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual String get_name() const override;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual void initialize_joypads() override {}
|
2020-03-09 16:56:48 +01:00
|
|
|
|
2021-10-28 17:16:47 +02:00
|
|
|
virtual Date get_date(bool p_utc) const override;
|
|
|
|
virtual Time get_time(bool p_utc) const override;
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual TimeZoneInfo get_time_zone_info() const override;
|
|
|
|
virtual double get_unix_time() const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual Error set_cwd(const String &p_cwd) override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual void delay_usec(uint32_t p_usec) const override;
|
|
|
|
virtual uint64_t get_ticks_usec() const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2021-12-16 14:00:55 +01:00
|
|
|
virtual Error execute(const String &p_path, const List<String> &p_arguments, String *r_pipe = nullptr, int *r_exitcode = nullptr, bool read_stderr = false, Mutex *p_pipe_mutex = nullptr, bool p_open_console = false) override;
|
|
|
|
virtual Error create_process(const String &p_path, const List<String> &p_arguments, ProcessID *r_child_id = nullptr, bool p_open_console = false) override;
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual Error kill(const ProcessID &p_pid) override;
|
|
|
|
virtual int get_process_id() const override;
|
2016-03-09 00:00:52 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual bool has_environment(const String &p_var) const override;
|
|
|
|
virtual String get_environment(const String &p_var) const override;
|
|
|
|
virtual bool set_environment(const String &p_var, const String &p_value) const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual String get_executable_path() const override;
|
2014-02-10 02:10:30 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual String get_locale() const override;
|
2018-01-29 16:46:30 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual int get_processor_count() const override;
|
2018-01-29 16:46:30 +01:00
|
|
|
|
2020-12-17 18:15:59 +01: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_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-11 03:39:31 +02:00
|
|
|
virtual String get_system_dir(SystemDir p_dir, bool p_shared_storage = true) const override;
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual String get_user_data_dir() const override;
|
2014-12-02 18:02:41 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual String get_unique_id() const override;
|
2018-01-20 14:40:52 +01:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual Error shell_open(String p_uri) override;
|
2014-04-18 16:43:54 +02:00
|
|
|
|
2014-02-10 02:10:30 +01:00
|
|
|
void run();
|
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual bool _check_internal_feature_support(const String &p_feature) override;
|
2017-02-09 00:07:35 +01:00
|
|
|
|
2020-12-18 10:38:09 +01:00
|
|
|
virtual void disable_crash_handler() override;
|
|
|
|
virtual bool is_disable_crash_handler() const override;
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual void initialize_debugging() override;
|
2017-09-08 03:01:49 +02:00
|
|
|
|
2020-12-17 18:15:59 +01:00
|
|
|
virtual Error move_to_trash(const String &p_path) override;
|
2017-09-25 15:15:11 +02:00
|
|
|
|
2020-03-09 16:56:48 +01:00
|
|
|
void set_main_window(HWND p_main_window) { main_window = p_main_window; }
|
2019-03-03 21:12:19 +01:00
|
|
|
|
2020-03-09 16:56:48 +01:00
|
|
|
HINSTANCE get_hinstance() { return hInstance; }
|
2016-03-09 00:00:52 +01:00
|
|
|
OS_Windows(HINSTANCE _hInstance);
|
2014-02-10 02:10:30 +01:00
|
|
|
~OS_Windows();
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|