godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/drivers/unix/os_unix.h

113 lines
5.0 KiB
C++
Raw Normal View History

GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
/* os_unix.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
Use HTTPS URL for Godot's website in the headers
2017-08-27 12:16:55 +00:00
/* https://godotengine.org */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-13 08:45:09 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00: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. */
/*************************************************************************/
Add missing copyright headers and fix formatting Using `misc/scripts/fix_headers.py` on all Godot files. Some missing header guards were added, and the header inclusion order was fixed in the Bullet module.
2018-01-04 23:50:27 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#ifndef OS_UNIX_H
#define OS_UNIX_H
#ifdef UNIX_ENABLED
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/os/os.h"
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#include "drivers/unix/ip_unix.h"
class OS_Unix : public OS {
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
protected:
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
// UNIX only handles the core functions.
// inheriting platforms under unix (eg. X11) should handle the rest
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void initialize_core();
virtual int unix_initialize_audio(int p_audio_driver);
Change OS::initialize signature to return Error (fix segfault on x11)
2018-01-03 17:26:44 +00:00
//virtual Error initialize(int p_video_driver,int p_audio_driver);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual void finalize_core();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
String stdin_buf;
public:
Return and repair file logging And make it configurable, too.
2017-11-21 09:35:01 +00:00
OS_Unix();
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void alert(const String &p_alert, const String &p_title = "ALERT!");
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_stdin_string(bool p_block);
//virtual void set_mouse_show(bool p_show);
//virtual void set_mouse_grab(bool p_grab);
//virtual bool is_mouse_grab_enabled() const = 0;
Rename [gs]et_pos to [gs]et_position for Controls Control set_pos -> set_position Control set_global_pos -> set_global_position [gs]et_mouse_pos -> [gs]et_mouse_position [gs]et_global_mouse_pos -> [gs]et_global_mouse_position fixes #8005
2017-03-29 15:29:38 +00:00
//virtual void get_mouse_position(int &x, int &y) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
//virtual void set_window_title(const String& p_title);
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
//virtual void set_video_mode(const VideoMode& p_video_mode);
//virtual VideoMode get_video_mode() const;
//virtual void get_fullscreen_mode_list(List<VideoMode> *p_list) const;
Style: Apply clang-format again on all files Fixes issues introduced by newer clang-format versions or commits pushed directly without using the clang-format pre-commit hook.
2017-12-06 18:54:22 +00:00
virtual Error open_dynamic_library(const String p_path, void *&p_library_handle, bool p_also_set_library_path = false);
added dlscript module This module was written by bojidar-bg and me, with the help of ClikCode and touilleMan. This adds a module to Godot that enables the use of dynamic libraries as a source for scripts. That also allows third party libraries to be linked to Godot more easily and without creating modules. For a readme see https://github.com/GodotNativeTools/godot_headers/blob/master/README.md
2017-04-03 14:11:38 +00:00
virtual Error close_dynamic_library(void *p_library_handle);
added an optional parameter to OS symbol lookup When looking up a symbol from a library, previously an error was shown when the symbol did not exist. That caused confusion when the lookup was completely optional. This adds a new parameter to that method so that those errors can be handled manually if needed.
2017-07-27 07:23:21 +00:00
virtual Error get_dynamic_library_symbol_handle(void *p_library_handle, const String p_name, void *&p_symbol_handle, bool p_optional = false);
Added methods for opening dynamic libraries to OS
2017-03-08 01:50:13 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual Error set_cwd(const String &p_cwd);
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
added a const keyword for a methods that return constant literal...
2019-05-20 17:36:24 +00:00
virtual String get_name() const;
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
Add utc param to get_time and get_date methods If utc == false, we return the local time, like before. Otherwise, we return UTC time. utc defaults to false to not break behaviour.
2015-06-06 01:40:56 +00:00
virtual Date get_date(bool utc) const;
virtual Time get_time(bool utc) const;
Add OS.get_time_zone_info function The returned dictionary maps "name" to the name of the current time zone, and "bias" to a bias from UTC in minutes.
2015-06-06 03:35:38 +00:00
virtual TimeZoneInfo get_time_zone_info() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual uint64_t get_unix_time() const;
-Removed OS.get_system_time_msec(), this is undoable on Windows and also unusable from GDscript due to precision. -Added, instead an OS.get_system_time_secs(), which is 32 bits friendly, fixes #3143
2016-01-10 21:24:55 +00:00
virtual uint64_t get_system_time_secs() const;
Added OS.get_system_time_msecs()
2018-12-19 21:18:52 +00:00
virtual uint64_t get_system_time_msecs() const;
Fix Time.get_unix_time_from_system() not including msecs
2022-08-08 09:45:32 +00:00
virtual double get_subsecond_unix_time() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual void delay_usec(uint32_t p_usec) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual uint64_t get_ticks_usec() const;
[Windows] Improve console handling and execute. Always build with the GUI subsystem. Redirect stdout and stderr output to the parent process console. Use CreateProcessW for blocking `execute` calls with piped stdout and stderr (prevent console windows for popping up when used with the GUI subsystem build, and have more consistent behavior with non-blocking calls). Add `open_console` argument to the `execute` to open a new console window (for both blocking and non-blocking calls). Remove `interface/editor/hide_console_window` editor setting. Remove `Toggle System Console` menu option. Remove `set_console_visible` and `is_console_visible` functions.
2021-12-16 11:08:09 +00:00
virtual Error execute(const String &p_path, const List<String> &p_arguments, bool p_blocking = true, ProcessID *r_child_id = nullptr, String *r_pipe = nullptr, int *r_exitcode = nullptr, bool read_stderr = false, Mutex *p_pipe_mutex = nullptr, bool p_open_console = false);
Revert "Try closing gracefully before terminating process"
2018-08-27 15:32:43 +00:00
virtual Error kill(const ProcessID &p_pid);
Makes all Godot API's methods Lower Case
2017-08-07 10:17:31 +00:00
virtual int get_process_id() const;
Add OS::is_process_running function. Adds the is_process_running function to the native OS class and exposes it to script. This is implemented on Windows and Unix platforms. A stub is provided for other platforms that do not support this function. Documentation is updated to reflect new API function. (cherry picked from commit f3c1232c5984a540c33841694469febbe951e7a8)
2021-08-13 03:36:23 +00:00
virtual bool is_process_running(const ProcessID &p_pid) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
A Whole New World (clang-format edition) I can show you the code Pretty, with proper whitespace Tell me, coder, now when did You last write readable code? I can open your eyes Make you see your bad indent Force you to respect the style The core devs agreed upon A whole new world A new fantastic code format A de facto standard With some sugar Enforced with clang-format A whole new world A dazzling style we all dreamed of And when we read it through It's crystal clear That now we're in a whole new world of code
2017-03-05 15:44:50 +00:00
virtual bool has_environment(const String &p_var) const;
virtual String get_environment(const String &p_var) const;
Added set_environment to OS class
2019-01-29 21:59:38 +00:00
virtual bool set_environment(const String &p_var, const String &p_value) const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_locale() const;
Local debugger fixes and extensions - Adds q/quit option to console debugging - Adds options (variable_prefix) - Breaks into debugger with Ctrl-C in local debug mode (Unix/Windows) - Added option to list all breakpoints - Fixes add/remove breakpoint bug (invalid path parsing) - Minor cleanup
2018-02-11 11:08:37 +00:00
virtual void initialize_debugging();
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
virtual String get_executable_path() const;
Rename OS::get_data_dir to OS::get_user_data_dir Will be needed to avoid confusion with system data path (XDG_DATA_HOME) and editor data dir in upcoming refactoring.
2017-11-17 14:25:22 +00:00
virtual String get_user_data_dir() const;
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
};
Extract logging logic Previously logging logic was scattered over OS class implementations with plenty of duplication. Major changes in this commit: - Extracted logging logic into a separate Logger hierarchy. It allows easy configuration of logging mechanism depending on compile-time or run-time configuration. - Implemented RotatedFileLogger which is usually used with StdLogger, providing persistency of logs. It is often important to be able to obtain logs of the game even in production to be able to understand what happened prior to some problem. On mobile there previously was no way to obtain the logs aside from having the device connected to your machine. - flush() is not performed in release mode for every logged line. It is only performed for errors.
2017-09-22 05:56:02 +00:00
class UnixTerminalLogger : public StdLogger {
public:
virtual void log_error(const char *p_function, const char *p_file, int p_line, const char *p_code, const char *p_rationale, ErrorType p_type = ERR_ERROR);
virtual ~UnixTerminalLogger();
};
GODOT IS OPEN SOURCE
2014-02-10 01:10:30 +00:00
#endif
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-25 10:33:41 +00:00
#endif // OS_UNIX_H