1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
//! This crate provides a cross platform API for working with the //! psuedo terminal (pty) interfaces provided by the system. //! Unlike other crates in this space, this crate provides a set //! of traits that allow selecting from different implementations //! at runtime, which is important on Windows systems. //! This crate is part of [wezterm](https://github.com/wez/wezterm). //! //! ```no_run //! use portable_pty::{CommandBuilder, PtySize, PtySystemSelection}; //! use failure::Error; //! //! // Use the native pty implementation for the system //! let pty_system = PtySystemSelection::default().get()?; //! //! // Create a new pty //! let (mut master, slave) = pty_system.openpty(PtySize { //! rows: 24, //! cols: 80, //! // Not all systems support pixel_width, pixel_height, //! // but it is good practice to set it to something //! // that matches the size of the selected font. That //! // is more complex than can be shown here in this //! // brief example though! //! pixel_width: 0, //! pixel_height: 0, //! })?; //! //! // Spawn a shell into the pty //! let cmd = CommandBuilder::new("bash"); //! let child = slave.spawn_command(cmd)?; //! //! // Read and parse output from the pty with reader //! let mut reader = master.try_clone_reader()?; //! //! // Send data to the pty by writing to the master //! writeln!(master, "ls -l\r\n")?; //! # Ok::<(), Error>(()) //! ``` use failure::{bail, format_err, Error}; #[cfg(feature = "serde_support")] use serde_derive::*; use std::io::Result as IoResult; pub mod cmdbuilder; pub use cmdbuilder::CommandBuilder; #[cfg(unix)] pub mod unix; #[cfg(windows)] pub mod win; /// Represents the size of the visible display area in the pty #[derive(Debug, Clone, Copy)] pub struct PtySize { /// The number of lines of text pub rows: u16, /// The number of columns of text pub cols: u16, /// The width of a cell in pixels. Note that some systems never /// fill this value and ignore it. pub pixel_width: u16, /// The height of a cell in pixels. Note that some systems never /// fill this value and ignore it. pub pixel_height: u16, } /// Represents the master/control end of the pty pub trait MasterPty: std::io::Write { /// Inform the kernel and thus the child process that the window resized. /// It will update the winsize information maintained by the kernel, /// and generate a signal for the child to notice and update its state. fn resize(&self, size: PtySize) -> Result<(), Error>; /// Retrieves the size of the pty as known by the kernel fn get_size(&self) -> Result<PtySize, Error>; /// Obtain a readable handle; output from the slave(s) is readable /// via this stream. fn try_clone_reader(&self) -> Result<Box<std::io::Read + Send>, Error>; } /// Represents a child process spawned into the pty. /// This handle can be used to wait for or terminate that child process. pub trait Child: std::fmt::Debug { /// Poll the child to see if it has completed. /// Does not block. /// Returns None if the has not yet terminated, /// else returns its exit status. fn try_wait(&mut self) -> IoResult<Option<ExitStatus>>; /// Terminate the child process fn kill(&mut self) -> IoResult<()>; /// Blocks execution until the child process has completed, /// yielding its exit status. fn wait(&mut self) -> IoResult<ExitStatus>; } /// Represents the slave side of a pty. /// Can be used to spawn processes into the pty. pub trait SlavePty { /// Spawns the command specified by the provided CommandBuilder fn spawn_command(&self, cmd: CommandBuilder) -> Result<Box<Child>, Error>; } /// Represents the exit status of a child process. /// This is rather anemic in the current version of this crate, /// holding only an indicator of success or failure. #[derive(Debug)] pub struct ExitStatus { successful: bool, } impl ExitStatus { /// Construct an ExitStatus from a process return code pub fn with_exit_code(code: u32) -> Self { Self { successful: if code == 0 { true } else { false }, } } pub fn success(&self) -> bool { self.successful } } impl From<std::process::ExitStatus> for ExitStatus { fn from(status: std::process::ExitStatus) -> ExitStatus { ExitStatus { successful: status.success(), } } } /// The `PtySystem` trait allows an application to work with multiple /// possible Pty implementations at runtime. This is important on /// Windows systems which have a variety of implementations. pub trait PtySystem { /// Create a new Pty instance with the window size set to the specified /// dimensions. Returns a (master, slave) Pty pair. The master side /// is used to drive the slave side. fn openpty(&self, size: PtySize) -> Result<(Box<MasterPty>, Box<SlavePty>), Error>; } impl Child for std::process::Child { fn try_wait(&mut self) -> IoResult<Option<ExitStatus>> { std::process::Child::try_wait(self).map(|s| match s { Some(s) => Some(s.into()), None => None, }) } fn kill(&mut self) -> IoResult<()> { std::process::Child::kill(self) } fn wait(&mut self) -> IoResult<ExitStatus> { std::process::Child::wait(self).map(Into::into) } } /// `PtySystemSelection` allows selecting and constructing one of the /// pty implementations provided by this crate. #[derive(Debug, Clone, Copy)] #[cfg_attr(feature = "serde_support", derive(Deserialize))] pub enum PtySystemSelection { /// The Unix style pty interface Unix, /// The Windows 10+ native Console Pty interface ConPty, /// rprichard's WinPty interface to cygwin and msys pty. /// This requires that `winpty.dll` be resolvable by the /// embedding application. Instructions on obtaining /// an appropriate implementation of `winpty.dll` can be /// found here: /// [winpty](https://github.com/rprichard/winpty) WinPty, } impl PtySystemSelection { /// Construct an instance of PtySystem described by the enum value. /// Windows specific enum variants result in an error. #[cfg(unix)] pub fn get(&self) -> Result<Box<PtySystem>, Error> { match self { PtySystemSelection::Unix => Ok(Box::new(unix::UnixPtySystem {})), _ => bail!("{:?} not available on unix", self), } } /// Construct an instance of PtySystem described by the enum value. /// Unix specific enum variants result in an error. #[cfg(windows)] pub fn get(&self) -> Result<Box<PtySystem>, Error> { match self { PtySystemSelection::ConPty => Ok(Box::new(win::conpty::ConPtySystem {})), PtySystemSelection::WinPty => Ok(Box::new(win::winpty::WinPtySystem {})), _ => bail!("{:?} not available on Windows", self), } } /// Returns a list of the variant names. /// This can be useful for example to specify the list of allowable /// options in a clap argument specification. pub fn variants() -> Vec<&'static str> { vec!["Unix", "ConPty", "WinPty"] } } /// Parse a string into a `PtySystemSelection` value. /// This is useful when parsing arguments or configuration files. impl std::str::FromStr for PtySystemSelection { type Err = Error; fn from_str(s: &str) -> Result<Self, Self::Err> { match s.to_lowercase().as_ref() { "unix" => Ok(PtySystemSelection::Unix), "winpty" => Ok(PtySystemSelection::WinPty), "conpty" => Ok(PtySystemSelection::ConPty), _ => Err(format_err!( "{} is not a valid PtySystemSelection variant, possible values are {:?}", s, PtySystemSelection::variants() )), } } } impl Default for PtySystemSelection { /// Returns the default, system native PtySystemSelection fn default() -> PtySystemSelection { #[cfg(unix)] return PtySystemSelection::Unix; #[cfg(windows)] return PtySystemSelection::ConPty; } }