///|
#cfg(platform="windows")
let invalid_handle : @handle.Handle = @handle.Handle::invalid()
///|
#cfg(platform="windows")
#borrow(pty)
extern "c" fn pty_win32_open(
pty : FixedArray[@handle.Handle],
rows~ : Int,
cols~ : Int,
) -> Int = "moonbit_pty_win32_open"
///|
#cfg(platform="windows")
#borrow(hpc, session, cmd, app, env, cwd)
extern "c" fn pty_win32_spawn(
hpc : PseudoConsole,
session : FixedArray[@handle.Handle],
cmd~ : String,
app~ : String,
env~ : String,
cwd~ : String,
) -> Int = "moonbit_pty_win32_spawn"
///|
#cfg(platform="windows")
priv struct PseudoConsole(@handle.Handle)
///|
#cfg(platform="windows")
#borrow(hpc)
extern "c" fn PseudoConsole::close(hpc : PseudoConsole) = "ClosePseudoConsole"
///|
/// A pseudo-terminal attached to a spawned child process.
///
/// `Pty` implements `@async/io.Reader` and `@async/io.Writer`: writes send
/// input to the child's terminal, reads carry the terminal's output (stdout
/// and stderr merged). On Windows the output is a ConPTY screen rendering,
/// so it is wrapped in VT escape sequences (including an initial
/// clear-screen) rather than being the child's raw bytes.
///
/// The pty's resources are released when the task group passed to `spawn`
/// exits. If the group is cancelled, the child gets a 5 s grace period,
/// then a hard kill.
#cfg(platform="windows")
struct Pty {
input_writer : @async/raw_fd.RawFdStream
output_reader : @async/raw_fd.RawFdStream
hpc : Ref[PseudoConsole?]
pid : Int
result : @async.Task[Int]
}
///|
#cfg(platform="windows")
const ERROR_FILE_NOT_FOUND : Int = 2
///|
/// Spawns a child process attached to a new pseudo-terminal and returns the
/// `Pty` handle.
///
/// The child runs `file` with `args` as its arguments; its `argv[0]` is
/// `file` verbatim, so programs that dispatch on `argv[0]` (busybox-style
/// multi-call binaries, shells checking for a leading `-`) see what the
/// caller wrote. `file` is looked up through `PATH` when it does not contain
/// a path separator, and used directly otherwise.
///
/// * `rows` and `cols` set the initial terminal size in characters.
/// * `extra_env` adds or overrides environment variables; by default
/// (`inherit_env=true`) the child also inherits the current process's
/// environment.
/// * `cwd` sets the child's working directory; by default the child starts
/// in the current directory.
/// * `no_wait` has the same semantics as `@async/process.spawn`: by default
/// the task group waits for the child to terminate; with `no_wait=true`
/// the group exits as soon as its own tasks are done, terminating the
/// child.
///
/// The returned `Pty` implements `@async/io.Reader` and `@async/io.Writer`,
/// and its resources are released when `group` exits. Raises
/// `@os_error.OSError` if the pty cannot be opened or the child cannot be
/// spawned.
#cfg(platform="windows")
pub async fn[X] spawn(
group : @async.TaskGroup[X],
rows? : Int = 24,
cols? : Int = 80,
file : StringView,
args : ArrayView[StringView],
extra_env? : Map[String, String] = Map([]),
inherit_env? : Bool = true,
cwd? : StringView,
no_wait? : Bool,
) -> Pty {
let env_map : Map[String, (String, String)] = Map([])
if inherit_env {
for k, v in @env.get_env_vars() {
env_map[k.to_upper()] = (k, v)
}
}
for k, v in extra_env {
let uk = k.to_upper()
env_map[uk] = if env_map.get(uk) is Some((ok, _)) {
(ok, v)
} else {
(k, v)
}
}
let env = {
let sb = StringBuilder()
for _, kv in env_map {
let (k, v) = kv
sb <+ "\{k}=\{v}\u{0000}"
}
sb.write_char('\u{000}')
sb.to_string()
}
let cwd = {
let cwd = if cwd is Some(cwd) { cwd.to_owned() } else { "." }
get_full_path_name(cwd)
}
// Build the command line the way `CommandLineToArgvW` would parse it back
// into `[file, ..args]`. `CreateProcessW` mutates this buffer in place, so
// `to_string` must hand back a fresh heap copy (never a string literal).
let cmd = {
let sb = StringBuilder()
sb.write_arg_with_windows_escape(file)
for arg in args {
sb..write_char(' ').write_arg_with_windows_escape(arg)
}
sb.to_string()
}
let app = {
let path = if env_map.get("PATH") is Some((_, path)) { path } else { "" }
let candidates = get_path_candidates(file~, path~, cwd~)
for candidate in candidates {
if win32_file_exists(candidate) {
break candidate
}
} nobreak {
raise @os_error.OSError(ERROR_FILE_NOT_FOUND, context="@pty.spawn")
}
}
let pty : FixedArray[@handle.Handle] = [
invalid_handle, invalid_handle, invalid_handle,
]
if pty_win32_open(pty, rows~, cols~) < 0 {
raise @os_error.OSError(@os_error.get_errno(), context="@pty.open")
}
guard! pty is [input_writer_handle, output_reader_handle, hpc_handle]
let hpc = PseudoConsole(hpc_handle)
let input_writer = {
errdefer {
output_reader_handle.close()
hpc.close()
}
input_writer_handle.to_raw_fd_stream()
}
let output_reader = {
errdefer {
input_writer.close()
hpc.close()
}
output_reader_handle.to_raw_fd_stream()
}
let session : FixedArray[@handle.Handle] = [invalid_handle, invalid_handle]
let pid = pty_win32_spawn(hpc, session, cmd~, app~, env~, cwd~)
if pid < 0 {
input_writer.close()
output_reader.close()
hpc.close()
raise @os_error.OSError(@os_error.get_errno(), context="@pty.spawn")
}
guard! session is [process_handle, job_handle]
let process = Process(process_handle)
let job = JobObject(job_handle)
let hpc = Ref(Some(hpc))
fn close_pseudo_console() -> Unit {
if hpc.val is Some(h) {
h.close()
hpc.val = None
}
}
let result = group.spawn(no_wait?) <| () => {
defer (if !job.is_invalid() { job.close() })
defer process.close()
defer close_pseudo_console()
if @async.handle_cancellation(() => @async/process.wait_pid(pid))
is Some(status) {
status
} else {
// Cancelled: reap the child anyway — close the pseudo console, give it
// the grace period, then hard kill — and complete with its exit
// status, like `@async/process.spawn` does. `try ... catch` no longer
// observes cancellation (async 0.22), so this match is the only thing
// that makes the cleanup run at all.
@async.protect_from_cancel() <| () => {
wait_pid_with(pid) <| () => {
close_pseudo_console()
// Grace period before the hard kill; matches the ~5s the OS
// itself grants on CTRL_CLOSE_EVENT. Keep in sync with the
// unix side (pty_unix.mbt), which is not type-checked here.
@async.sleep(5000)
if !job.is_invalid() {
job.terminate(1) |> ignore()
} else {
process.terminate(1) |> ignore()
}
}
}
}
}
group.add_defer() <| () => {
input_writer.close()
output_reader.close()
}
{ input_writer, output_reader, hpc, pid, result, }
}
///|
#cfg(platform="windows")
const ERROR_BROKEN_PIPE : Int = 109
///|
#cfg(platform="windows")
pub impl @async/io.Reader for Pty with fn _direct_read(
self : Pty,
buf : FixedArray[Byte],
offset~ : Int,
max_len~ : Int,
) -> Int {
@async/io.Reader::_direct_read(self.output_reader, buf, offset~, max_len~) catch {
@os_error.OSError(ERROR_BROKEN_PIPE, ..) => 0
error => raise error
}
}
///|
#cfg(platform="windows")
#warnings("-alert_internal")
pub impl @async/io.Reader for Pty with fn _get_internal_buffer(self : Pty) -> @async/io.ReaderBuffer {
@async/io.Reader::_get_internal_buffer(self.output_reader)
}
///|
#cfg(platform="windows")
pub impl @async/io.Writer for Pty with fn write_once(
self : Pty,
buf : Bytes,
offset~ : Int,
len~ : Int,
) -> Int {
self.input_writer.write_once(buf, offset~, len~)
}
///|
#cfg(platform="windows")
#borrow(hpc)
extern "c" fn PseudoConsole::resize(
hpc : PseudoConsole,
rows~ : Int,
cols~ : Int,
) -> Int = "moonbit_pty_win32_resize"
///|
/// Resizes the child's terminal, in characters.
/// Raises `@os_error.OSError` if the resize fails, including when the pty
/// has already been closed (for example after the owning task group has
/// exited).
#cfg(platform="windows")
pub fn Pty::resize(
self : Pty,
rows~ : Int,
cols~ : Int,
) -> Unit raise @os_error.OSError {
guard self.hpc.val is Some(hpc) else {
raise @os_error.OSError(9, context="@pty.Pty::resize")
}
if hpc.resize(rows~, cols~) < 0 {
raise @os_error.OSError(@os_error.get_errno(), context="@pty.Pty::resize")
}
}
///|
/// Waits for the child process to terminate and returns its exit code.
/// If the process was killed by a signal, the result is `-signal_number`
/// (the same convention as `@async/process.wait_pid`).
///
/// Do not wait first and read afterwards: the pty master is a bounded
/// kernel queue, and on macOS the kernel discards whatever is still queued
/// a few hundred milliseconds after the child exits. Read concurrently
/// while waiting; reading late yields a clean but empty EOF.
#cfg(platform="windows")
pub async fn Pty::wait(self : Pty) -> Int {
return self.result.wait()
}
///|
#cfg(platform="windows")
priv struct JobObject(@handle.Handle)
///|
#cfg(platform="windows")
#borrow(job)
extern "c" fn JobObject::terminate(job : JobObject, exit_code : Int) -> Bool = "TerminateJobObject"
///|
#cfg(platform="windows")
fn JobObject::close(self : JobObject) -> Unit {
self.0.close()
}
///|
#cfg(platform="windows")
fn JobObject::is_invalid(self : JobObject) -> Bool {
self.0 == invalid_handle
}
///|
#cfg(platform="windows")
priv struct Process(@handle.Handle)
///|
#cfg(platform="windows")
#borrow(process)
extern "c" fn Process::terminate(process : Process, exit_code : UInt) -> Bool = "TerminateProcess"
///|
#cfg(platform="windows")
fn Process::close(self : Process) -> Unit {
self.0.close()
}
///|
/// The process ID of the spawned child process.
#cfg(platform="windows")
pub fn Pty::pid(self : Pty) -> Int {
self.pid
}
///|
#cfg(platform="windows")
let _unused_packages : Unit = ignore(@encoding/utf8.encode("hello"))