mirror of
https://github.com/lihop/godot-xterm.git
synced 2025-06-29 18:55:31 +02:00
feat(pty): further pty development
This commit is contained in:
Leroy Hopson
parent
52a259b019
commit
c36500615d
4 changed files with 332 additions and 110 deletions
|
|
@ -8,20 +8,71 @@
|
|||
#include <unistd.h>
|
||||
#endif
|
||||
|
||||
#define UV_ERR_MSG(uv_err) \
|
||||
String(uv_err_name(uv_err)) + String(": ") + String(uv_strerror(uv_err))
|
||||
|
||||
#define ERR_FAIL_UV_ERR(uv_err) \
|
||||
ERR_FAIL_COND_V_MSG(uv_err < 0, PTY::uv_err_to_godot_err(uv_err), \
|
||||
UV_ERR_MSG(uv_err))
|
||||
|
||||
using namespace godot;
|
||||
|
||||
void _alloc_buffer(uv_handle_t *handle, size_t suggested_size, uv_buf_t *buf);
|
||||
void _read_cb(uv_stream_t *pipe, ssize_t nread, const uv_buf_t *buf);
|
||||
void _close_cb(uv_handle_t *handle);
|
||||
|
||||
void PTY::_bind_methods() {
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGHUP);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGINT);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGQUIT);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGILL);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGTRAP);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGABRT);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGBUS);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGFPE);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGKILL);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGUSR1);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGSEGV);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGUSR2);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGPIPE);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGALRM);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGTERM);
|
||||
|
||||
ADD_SIGNAL(MethodInfo("data_received", PropertyInfo(Variant::PACKED_BYTE_ARRAY, "data")));
|
||||
ADD_SIGNAL(MethodInfo("exited", PropertyInfo(Variant::INT, "exit_code"), PropertyInfo(Variant::INT, "signal_code")));
|
||||
|
||||
ClassDB::bind_method(D_METHOD("get_env"), &PTY::get_env);
|
||||
ClassDB::bind_method(D_METHOD("set_env", "env"), &PTY::set_env);
|
||||
ClassDB::add_property("PTY", PropertyInfo(Variant::DICTIONARY, "env"), "set_env", "get_env");
|
||||
|
||||
ClassDB::bind_method(D_METHOD("get_use_os_env"), &PTY::get_use_os_env);
|
||||
ClassDB::bind_method(D_METHOD("set_use_os_env", "use_os_env"), &PTY::set_use_os_env);
|
||||
ClassDB::add_property("PTY", PropertyInfo(Variant::BOOL, "use_os_env"), "set_use_os_env", "get_use_os_env");
|
||||
|
||||
ClassDB::bind_method(D_METHOD("get_pts"), &PTY::get_pts);
|
||||
|
||||
ClassDB::bind_method(D_METHOD("fork", "file", "args", "cwd", "cols", "rows"), &PTY::fork, DEFVAL(""), DEFVAL(PackedStringArray()), DEFVAL("."), DEFVAL(80), DEFVAL(24));
|
||||
ClassDB::bind_method(D_METHOD("open", "cols", "rows"), &PTY::open, DEFVAL(80), DEFVAL(24));
|
||||
ClassDB::bind_method(D_METHOD("write", "data"), &PTY::write);
|
||||
ClassDB::bind_method(D_METHOD("kill", "signal"), &PTY::kill);
|
||||
|
||||
ClassDB::bind_method(D_METHOD("_on_exit", "exit_code", "signal_code"), &PTY::_on_exit);
|
||||
}
|
||||
|
||||
PTY::PTY() {
|
||||
os = OS::get_singleton();
|
||||
status = STATUS_NONE;
|
||||
|
||||
env["TERM"] = "xterm-256color";
|
||||
env["COLORTERM"] = "truecolor";
|
||||
|
||||
#if defined(__linux__) || defined(__APPLE__)
|
||||
uv_pipe_init(uv_default_loop(), &pipe, false);
|
||||
pipe.data = this;
|
||||
#endif
|
||||
}
|
||||
|
||||
PTY::~PTY() {
|
||||
#if (defined(__linux__) || defined(__APPLE__)) && !defined(_PTY_DISABLED)
|
||||
if (pid > 0) kill(SIGNAL_SIGHUP);
|
||||
if (fd > 0) close(fd);
|
||||
#endif
|
||||
_close();
|
||||
}
|
||||
|
||||
int PTY::get_cols() const {
|
||||
|
|
@ -48,19 +99,36 @@ void PTY::set_use_os_env(const bool value) {
|
|||
use_os_env = value;
|
||||
}
|
||||
|
||||
String PTY::get_pts() const {
|
||||
return pts;
|
||||
}
|
||||
|
||||
Error PTY::fork(const String &file, const PackedStringArray &args, const String &cwd, const int cols, const int rows) {
|
||||
String fork_file = _get_fork_file(file);
|
||||
Dictionary fork_env = _get_fork_env();
|
||||
Dictionary result;
|
||||
|
||||
#if defined(__linux__) || defined(__APPLE__)
|
||||
String helper_path = ProjectSettings::get_singleton()->globalize_path("res://addons/godot_xterm/native/bin/spawn-helper");
|
||||
result = PTYUnix::fork(fork_file, args, PackedStringArray(), cwd, cols, rows, -1, -1, true, helper_path, Callable(this, "_on_exit"));
|
||||
fd = result["fd"];
|
||||
pid = result["pid"];
|
||||
String helper_path = ProjectSettings::get_singleton()->globalize_path("res://addons/godot_xterm/native/bin/spawn-helper");
|
||||
result = PTYUnix::fork(fork_file, args, PackedStringArray(), cwd, cols, rows, -1, -1, true, helper_path, Callable(this, "_on_exit"));
|
||||
#endif
|
||||
|
||||
return static_cast<Error>((int)result["error"]);
|
||||
Error err = static_cast<Error>((int)result["error"]);
|
||||
ERR_FAIL_COND_V_MSG(err != OK, err, "Failed to fork.");
|
||||
|
||||
fd = result["fd"];
|
||||
pid = result["pid"];
|
||||
pts = result["pty"];
|
||||
|
||||
# if defined(__linux__) || defined(__APPLE__)
|
||||
err = _pipe_open(fd);
|
||||
if (err != OK) {
|
||||
status = STATUS_ERROR;
|
||||
ERR_FAIL_V_MSG(err, "Failed to open pipe.");
|
||||
}
|
||||
#endif
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
||||
void PTY::kill(const int signal) {
|
||||
|
|
@ -71,14 +139,19 @@ void PTY::kill(const int signal) {
|
|||
#endif
|
||||
}
|
||||
|
||||
Error PTY::open(const int cols, const int rows) const {
|
||||
Error PTY::open(const int cols, const int rows) {
|
||||
Dictionary result;
|
||||
|
||||
#if defined(__linux__) || defined(__APPLE__)
|
||||
result = PTYUnix::open(cols, rows);
|
||||
#endif
|
||||
|
||||
return static_cast<Error>((int)result["error"]);
|
||||
Error err = static_cast<Error>((int)result["error"]);
|
||||
ERR_FAIL_COND_V(err != OK, err);
|
||||
|
||||
pts = result["pty"];
|
||||
|
||||
return OK;
|
||||
}
|
||||
|
||||
void PTY::resize(const int cols, const int rows) const {
|
||||
|
|
@ -87,45 +160,39 @@ void PTY::resize(const int cols, const int rows) const {
|
|||
void PTY::write(const Variant &data) const {
|
||||
}
|
||||
|
||||
void PTY::_bind_methods() {
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGHUP);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGINT);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGQUIT);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGILL);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGTRAP);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGABRT);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGBUS);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGFPE);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGKILL);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGUSR1);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGSEGV);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGUSR2);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGPIPE);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGALRM);
|
||||
BIND_ENUM_CONSTANT(SIGNAL_SIGTERM);
|
||||
void PTY::_process(double delta) {
|
||||
#if defined(__linux__) || defined(__APPLE__)
|
||||
if (status == STATUS_CONNECTED) {
|
||||
if (!uv_is_active((uv_handle_t *)&pipe)) {
|
||||
uv_read_start((uv_stream_t *)&pipe, _alloc_buffer, _read_cb);
|
||||
}
|
||||
|
||||
ADD_SIGNAL(MethodInfo("exited", PropertyInfo(Variant::INT, "exit_code"), PropertyInfo(Variant::INT, "signal_code")));
|
||||
|
||||
ClassDB::bind_method(D_METHOD("get_env"), &PTY::get_env);
|
||||
ClassDB::bind_method(D_METHOD("set_env", "env"), &PTY::set_env);
|
||||
ClassDB::add_property("PTY", PropertyInfo(Variant::DICTIONARY, "env"), "set_env", "get_env");
|
||||
|
||||
ClassDB::bind_method(D_METHOD("get_use_os_env"), &PTY::get_use_os_env);
|
||||
ClassDB::bind_method(D_METHOD("set_use_os_env", "use_os_env"), &PTY::set_use_os_env);
|
||||
ClassDB::add_property("PTY", PropertyInfo(Variant::BOOL, "use_os_env"), "set_use_os_env", "get_use_os_env");
|
||||
|
||||
ClassDB::bind_method(D_METHOD("fork", "file", "args", "cwd", "cols", "rows"), &PTY::fork, DEFVAL(""), DEFVAL(PackedStringArray()), DEFVAL("."), DEFVAL(80), DEFVAL(24));
|
||||
ClassDB::bind_method(D_METHOD("open", "cols", "rows"), &PTY::open, DEFVAL(80), DEFVAL(24));
|
||||
ClassDB::bind_method(D_METHOD("write", "data"), &PTY::write);
|
||||
ClassDB::bind_method(D_METHOD("kill", "signal"), &PTY::kill);
|
||||
|
||||
ClassDB::bind_method(D_METHOD("_on_exit", "exit_code", "signal_code"), &PTY::_on_exit);
|
||||
uv_run(uv_default_loop(), UV_RUN_NOWAIT);
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
void PTY::_close() {
|
||||
#if defined(__linux__) || defined(__APPLE__)
|
||||
if (!uv_is_closing((uv_handle_t *)&pipe)) {
|
||||
uv_close((uv_handle_t *)&pipe, _close_cb);
|
||||
}
|
||||
|
||||
uv_run(uv_default_loop(), UV_RUN_NOWAIT);
|
||||
|
||||
if (fd > 0) close(fd);
|
||||
if (pid > 0) kill(SIGNAL_SIGHUP);
|
||||
|
||||
fd = -1;
|
||||
pid = -1;
|
||||
status = STATUS_NONE;
|
||||
#endif
|
||||
}
|
||||
|
||||
String PTY::_get_fork_file(const String &file) const {
|
||||
if (!file.is_empty()) return file;
|
||||
|
||||
String shell_env = os->get_environment("SHELL");
|
||||
String shell_env = OS::get_singleton()->get_environment("SHELL");
|
||||
if (!shell_env.is_empty()) {
|
||||
return shell_env;
|
||||
}
|
||||
|
|
@ -186,6 +253,62 @@ Dictionary PTY::_get_fork_env() const {
|
|||
}
|
||||
|
||||
void PTY::_on_exit(int exit_code, int exit_signal) {
|
||||
pid = -1;
|
||||
emit_signal(StringName("exited"), exit_code, exit_signal);
|
||||
}
|
||||
|
||||
#if defined(__linux__) || defined(__APPLE__)
|
||||
|
||||
void _alloc_buffer(uv_handle_t *handle, size_t suggested_size, uv_buf_t *buf) {
|
||||
buf->base = (char *)malloc(suggested_size);
|
||||
buf->len = suggested_size;
|
||||
}
|
||||
|
||||
void _read_cb(uv_stream_t *pipe, ssize_t nread, const uv_buf_t *buf) {
|
||||
PTY *pty = static_cast<PTY *>(pipe->data);
|
||||
|
||||
if (nread < 0) {
|
||||
switch (nread) {
|
||||
case UV_EOF:
|
||||
// Normal after shell exits.
|
||||
case UV_EIO:
|
||||
// Can happen when the process exits.
|
||||
// As long as PTY has caught it, we should be fine.
|
||||
uv_read_stop(pipe);
|
||||
pty->status = PTY::Status::STATUS_NONE;
|
||||
return;
|
||||
default:
|
||||
pty->status = PTY::Status::STATUS_ERROR;
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
PackedByteArray data;
|
||||
data.resize(nread);
|
||||
memcpy(data.ptrw(), buf->base, nread);
|
||||
std::free((char *)buf->base);
|
||||
pty->call_deferred("emit_signal", "data_received", data);
|
||||
|
||||
// Stop reading until the next poll, otherwise _read_cb could be called
|
||||
// repeatedly, blocking Godot, and eventually resulting in a memory pool
|
||||
// allocation error. This can be triggered with the command `cat /dev/urandom`
|
||||
// if reading is not stopped.
|
||||
uv_read_stop(pipe);
|
||||
}
|
||||
|
||||
void _close_cb(uv_handle_t *pipe) {
|
||||
PTY *pty = static_cast<PTY *>(pipe->data);
|
||||
pty->status = PTY::Status::STATUS_NONE;
|
||||
}
|
||||
|
||||
Error PTY::_pipe_open(const int fd) {
|
||||
ERR_FAIL_COND_V_MSG(fd < 0, FAILED, "File descriptor must be a non-negative integer value.");
|
||||
|
||||
ERR_FAIL_UV_ERR(uv_pipe_open(&pipe, fd));
|
||||
ERR_FAIL_UV_ERR(uv_stream_set_blocking((uv_stream_t *)&pipe, false));
|
||||
ERR_FAIL_UV_ERR(uv_read_start((uv_stream_t *)&pipe, _alloc_buffer, _read_cb));
|
||||
|
||||
status = STATUS_CONNECTED;
|
||||
return OK;
|
||||
}
|
||||
|
||||
#endif
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue