Skip to content

Commit

Permalink
Auto merge of #126690 - andyolivares:feature/show_window, r=dtolnay
Browse files Browse the repository at this point in the history
Exposing STARTUPINFOW.wShowWindow in CommandExt trait

Hi:

I needed a way to control how a new process's window is displayed in Windows (normal, minimized, maximized, etc).
I noticed that there is no direct way to do that (I even searched for crates doing this, but didn't find any).

Inspecting the standard library source code, I figured that it would be a good addition to CommandExt trait that allows some Windows specific customization to a Command.

This is my first time contributing to Rust, so please bear with me if I'm not following the rules :)
  • Loading branch information
bors committed Jul 10, 2024
2 parents 0fdfb61 + b8b6d14 commit d819876
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 0 deletions.
13 changes: 13 additions & 0 deletions library/std/src/os/windows/process.rs
Original file line number Diff line number Diff line change
Expand Up @@ -181,6 +181,14 @@ pub trait CommandExt: Sealed {
#[stable(feature = "windows_process_extensions", since = "1.16.0")]
fn creation_flags(&mut self, flags: u32) -> &mut process::Command;

/// Sets the field `wShowWindow` of [STARTUPINFO][1] that is passed to `CreateProcess`.
/// Allowed values are the ones listed in
/// <https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-showwindow>
///
/// [1]: <https://learn.microsoft.com/en-us/windows/win32/api/processthreadsapi/ns-processthreadsapi-startupinfow>
#[unstable(feature = "windows_process_extensions_show_window", issue = "127544")]
fn show_window(&mut self, cmd_show: u16) -> &mut process::Command;

/// Forces all arguments to be wrapped in quote (`"`) characters.
///
/// This is useful for passing arguments to [MSYS2/Cygwin][1] based
Expand Down Expand Up @@ -370,6 +378,11 @@ impl CommandExt for process::Command {
self
}

fn show_window(&mut self, cmd_show: u16) -> &mut process::Command {
self.as_inner_mut().show_window(Some(cmd_show));
self
}

fn force_quotes(&mut self, enabled: bool) -> &mut process::Command {
self.as_inner_mut().force_quotes(enabled);
self
Expand Down
10 changes: 10 additions & 0 deletions library/std/src/sys/pal/windows/process.rs
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ pub struct Command {
env: CommandEnv,
cwd: Option<OsString>,
flags: u32,
show_window: Option<u16>,
detach: bool, // not currently exposed in std::process
stdin: Option<Stdio>,
stdout: Option<Stdio>,
Expand Down Expand Up @@ -194,6 +195,7 @@ impl Command {
env: Default::default(),
cwd: None,
flags: 0,
show_window: None,
detach: false,
stdin: None,
stdout: None,
Expand Down Expand Up @@ -224,6 +226,9 @@ impl Command {
pub fn creation_flags(&mut self, flags: u32) {
self.flags = flags;
}
pub fn show_window(&mut self, cmd_show: Option<u16>) {
self.show_window = cmd_show;
}

pub fn force_quotes(&mut self, enabled: bool) {
self.force_quotes_enabled = enabled;
Expand Down Expand Up @@ -337,6 +342,11 @@ impl Command {
si.hStdError = stderr.as_raw_handle();
}

if let Some(cmd_show) = self.show_window {
si.dwFlags |= c::STARTF_USESHOWWINDOW;
si.wShowWindow = cmd_show;
}

let si_ptr: *mut c::STARTUPINFOW;

let mut proc_thread_attribute_list;
Expand Down

0 comments on commit d819876

Please sign in to comment.