mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
f6a78f83aa
godot/drivers/unix/os_unix.h

107 lines
5.1 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 20:25:55 +08:00
/**************************************************************************/
/* os_unix.h */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* 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-05 07:50:27 +08:00
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08: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-12 00:13:45 +08:00
#include "core/os/os.h"
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08: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 23:44:50 +08:00
protected:
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08: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 23:44:50 +08:00
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
virtual void initialize_core();
virtual int unix_initialize_audio(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 23:44:50 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual void finalize_core() override;
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 23:44:50 +08:00
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
public:
Return and repair file logging And make it configurable, too.
2017-11-21 17:35:01 +08:00
OS_Unix();
Fetch video adapter driver name and version from OS on Linux/*BSD and Windows
2022-10-11 18:39:41 +08:00
virtual Vector<String> get_video_adapter_driver_info() const override;
Improve documentation for `OS.read_string_from_stdin()` This makes it clearer that calls to this method are blocking. The unused method parameter was also removed.
2022-12-30 04:06:11 +08:00
virtual String get_stdin_string() override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Unix: Remove now unnecessary I/O defines, cleanup - `LIBC_FILEIO_ENABLED` wasn't defined anywhere, even in _other platforms_. - `NO_NETWORK` is also never defined. It probably isn't enough anyway to disable network APIs in the current codebase. - `UNIX_SOCKET_UNAVAILABLE` is never defined in this code but used by some other platforms, clarify that. - `NO_STATVFS` can be removed as Android supports it since API level 19, which is our current min SDK level. It's also only used for `DirAccessUnix::get_space_left()` which is anyway overridden by `DirAccessJAndroid::get_space_left()` so it shouldn't make a difference. * Fixed documentation for `DirAccess.get_space_left()`. - `NO_FCNTL` is likely also a remnant of early Android days, in current NDK r23 it seems to be available. Also cleaned up unused `fcntl.h` includes. - `NO_ALLOCA` is never defined, and we use alloca in many places now.
2022-10-03 17:43:20 +08:00
virtual Error get_entropy(uint8_t *r_buffer, int p_bytes) override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Add const lvalue ref to core/* container parameters
2024-01-09 09:36:19 +08:00
virtual Error open_dynamic_library(const String &p_path, void *&p_library_handle, bool p_also_set_library_path = false, String *r_resolved_path = nullptr) override;
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual Error close_dynamic_library(void *p_library_handle) override;
Add const lvalue ref to core/* container parameters
2024-01-09 09:36:19 +08:00
virtual Error get_dynamic_library_symbol_handle(void *p_library_handle, const String &p_name, void *&p_symbol_handle, bool p_optional = false) override;
Added methods for opening dynamic libraries to OS
2017-03-08 09:50:13 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual Error set_cwd(const String &p_cwd) override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual String get_name() const override;
Add get_distribution_name() and get_version() to OS supports: LinuxBSD, Windows, macOS, iOS, Android, UWP Co-authored-by: bruvzg
2022-09-16 17:14:14 +08:00
virtual String get_distribution_name() const override;
virtual String get_version() const override;
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 23:44:50 +08:00
Fixes #65377: get_datetime_* functions can return wrong values
2022-09-08 13:36:10 +08:00
virtual DateTime get_datetime(bool p_utc) const override;
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual TimeZoneInfo get_time_zone_info() const override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual double get_unix_time() const override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual void delay_usec(uint32_t p_usec) const override;
virtual uint64_t get_ticks_usec() const override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
[OS] Implement and expose to scripting APIs `get_memory_info` method instead of old `get_free_static_memory`.
2023-04-03 16:46:29 +08:00
virtual Dictionary get_memory_info() const override;
[Windows] Improve console handling and execute/create_process. 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 `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. 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 21:00:55 +08: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;
Implement `OS.execute_with_pipe` method to run process with redirected stdio. Implement `pipe://*` path handling for creation of named pipes.
2023-10-19 19:35:10 +08:00
virtual Dictionary execute_with_pipe(const String &p_path, const List<String> &p_arguments) override;
[Windows] Improve console handling and execute/create_process. 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 `create_process`). Add `open_console` argument to the `execute` and `create_process` to open a new console window. 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 21:00:55 +08:00
virtual Error create_process(const String &p_path, const List<String> &p_arguments, ProcessID *r_child_id = nullptr, bool p_open_console = false) override;
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual Error kill(const ProcessID &p_pid) override;
virtual int get_process_id() const override;
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.
2021-08-13 11:36:23 +08:00
virtual bool is_process_running(const ProcessID &p_pid) const override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual bool has_environment(const String &p_var) const override;
virtual String get_environment(const String &p_var) const override;
OS: Add `unset_environment`, better validate input Instead of returning an undocumented boolean error code, we do the validation checks that should ensure a successful result. Based on: - https://linux.die.net/man/3/setenv - https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-setenvironmentvariable
2023-01-16 21:26:14 +08:00
virtual void set_environment(const String &p_var, const String &p_value) const override;
virtual void unset_environment(const String &p_var) const override;
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual String get_locale() const override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual void initialize_debugging() override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
Add override keywords to core/os.h derived classes.
2020-12-18 01:15:59 +08:00
virtual String get_executable_path() const override;
virtual String get_user_data_dir() const override;
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08: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 13:56:02 +08:00
class UnixTerminalLogger : public StdLogger {
public:
Fix console colors on Windows
2021-11-26 17:18:15 +08:00
virtual void log_error(const char *p_function, const char *p_file, int p_line, const char *p_code, const char *p_rationale, bool p_editor_notify = false, ErrorType p_type = ERR_ERROR) override;
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 13:56:02 +08:00
virtual ~UnixTerminalLogger();
};
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-24 05:41:51 +08:00
#endif // UNIX_ENABLED
GODOT IS OPEN SOURCE
2014-02-10 09:10:30 +08:00
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-24 05:41:51 +08:00
#endif // OS_UNIX_H
Reference in New Issue Copy Permalink