asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Minor typo fixups to Windows console changes

Browse source
This commit is contained in:
Max Hilbrunner 2022-01-27 03:11:00 +01:00
parent 2c7ff931df
commit 9590eeebb5
2 changed files with 11 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/OS.xml
View file

@ -54,7 +54,7 @@
<argument index="2" name="open_console" type="bool" default="false" /> <argument index="2" name="open_console" type="bool" default="false" />
<description> <description>
Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in [code]path[/code] must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. Creates a new process that runs independently of Godot. It will not terminate if Godot terminates. The path specified in [code]path[/code] must exist and be executable file or macOS .app bundle. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space.
On Windows, if [code]open_console[/code] is [code]true[/code] and process is console app, new terminal window will be opened, it's ignored on other platforms. On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms.
If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code]. If the process creation succeeds, the method will return the new process ID, which you can use to monitor the process (and potentially terminate it with [method kill]). If the process creation fails, the method will return [code]-1[/code].
For example, running another instance of the project: For example, running another instance of the project:
[codeblocks] [codeblocks]
@ -114,7 +114,7 @@
<argument index="4" name="open_console" type="bool" default="false" /> <argument index="4" name="open_console" type="bool" default="false" />
<description> <description>
Executes a command. The file specified in [code]path[/code] must exist and be executable. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. If an [code]output[/code] [Array] is provided, the complete shell output of the process will be appended as a single [String] element in [code]output[/code]. If [code]read_stderr[/code] is [code]true[/code], the output to the standard error stream will be included too. Executes a command. The file specified in [code]path[/code] must exist and be executable. Platform path resolution will be used. The [code]arguments[/code] are used in the given order and separated by a space. If an [code]output[/code] [Array] is provided, the complete shell output of the process will be appended as a single [String] element in [code]output[/code]. If [code]read_stderr[/code] is [code]true[/code], the output to the standard error stream will be included too.
On Windows, if [code]open_console[/code] is [code]true[/code] and process is console app, new terminal window will be opened, it's ignored on other platforms. On Windows, if [code]open_console[/code] is [code]true[/code] and the process is a console app, a new terminal window will be opened. This is ignored on other platforms.
If the command is successfully executed, the method will return the exit code of the command, or [code]-1[/code] if it fails. If the command is successfully executed, the method will return the exit code of the command, or [code]-1[/code] if it fails.
[b]Note:[/b] The Godot thread will pause its execution until the executed command terminates. Use [Thread] to create a separate thread that will not pause the Godot thread, or use [method create_process] to create a completely independent process. [b]Note:[/b] The Godot thread will pause its execution until the executed command terminates. Use [Thread] to create a separate thread that will not pause the Godot thread, or use [method create_process] to create a completely independent process.
For example, to retrieve a list of the working directory's contents: For example, to retrieve a list of the working directory's contents:
@ -128,7 +128,7 @@
int exitCode = OS.Execute("ls", new string[] {"-l", "/tmp"}, output); int exitCode = OS.Execute("ls", new string[] {"-l", "/tmp"}, output);
[/csharp] [/csharp]
[/codeblocks] [/codeblocks]
If you wish to access a shell built-in or perform a composite command, a platform-specific shell can be invoked. For example: If you wish to access a shell built-in or execute a composite command, a platform-specific shell can be invoked. For example:
[codeblocks] [codeblocks]
[gdscript] [gdscript]
var output = [] var output = []

16
platform/windows/os_windows.cpp
View file

@ -385,14 +385,14 @@ Error OS_Windows::execute(const String &p_path, const List<String> &p_arguments,
} }
inherit_handles = true; inherit_handles = true;
} }
DWORD creaton_flags = NORMAL_PRIORITY_CLASS; DWORD creation_flags = NORMAL_PRIORITY_CLASS;
if (p_open_console) { if (p_open_console) {
creaton_flags |= CREATE_NEW_CONSOLE; creation_flags |= CREATE_NEW_CONSOLE;
} else { } else {
creaton_flags |= CREATE_NO_WINDOW; creation_flags |= CREATE_NO_WINDOW;
} }
int ret = CreateProcessW(nullptr, (LPWSTR)(command.utf16().ptrw()), nullptr, nullptr, inherit_handles, creaton_flags, nullptr, nullptr, si_w, &pi.pi); int ret = CreateProcessW(nullptr, (LPWSTR)(command.utf16().ptrw()), nullptr, nullptr, inherit_handles, creation_flags, nullptr, nullptr, si_w, &pi.pi);
if (!ret && r_pipe) { if (!ret && r_pipe) {
CloseHandle(pipe[0]); // Cleanup pipe handles. CloseHandle(pipe[0]); // Cleanup pipe handles.
CloseHandle(pipe[1]); CloseHandle(pipe[1]);
@ -446,14 +446,14 @@ Error OS_Windows::create_process(const String &p_path, const List<String> &p_arg
ZeroMemory(&pi.pi, sizeof(pi.pi)); ZeroMemory(&pi.pi, sizeof(pi.pi));
LPSTARTUPINFOW si_w = (LPSTARTUPINFOW)&pi.si; LPSTARTUPINFOW si_w = (LPSTARTUPINFOW)&pi.si;
DWORD creaton_flags = NORMAL_PRIORITY_CLASS; DWORD creation_flags = NORMAL_PRIORITY_CLASS;
if (p_open_console) { if (p_open_console) {
creaton_flags |= CREATE_NEW_CONSOLE; creation_flags |= CREATE_NEW_CONSOLE;
} else { } else {
creaton_flags |= CREATE_NO_WINDOW; creation_flags |= CREATE_NO_WINDOW;
} }
int ret = CreateProcessW(nullptr, (LPWSTR)(command.utf16().ptrw()), nullptr, nullptr, false, creaton_flags, nullptr, nullptr, si_w, &pi.pi); int ret = CreateProcessW(nullptr, (LPWSTR)(command.utf16().ptrw()), nullptr, nullptr, false, creation_flags, nullptr, nullptr, si_w, &pi.pi);
ERR_FAIL_COND_V_MSG(ret == 0, ERR_CANT_FORK, "Could not create child process: " + command); ERR_FAIL_COND_V_MSG(ret == 0, ERR_CANT_FORK, "Could not create child process: " + command);
ProcessID pid = pi.pi.dwProcessId; ProcessID pid = pi.pi.dwProcessId;