tab-api 0.5.6

the common api module for the tab terminal multiplexer
Documentation 
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

use log::debug;
use tokio::process::Command;

/// Instructs the command module that it should interact with the terminal in raw mode
/// If false, the environment may not be a terminal pty.
/// The integration tests disable this flag.
pub fn is_raw_mode() -> bool {
    std::env::var("TAB_RAW_MODE")
        .ok()
        .map(|raw| raw.parse().unwrap_or(true))
        .unwrap_or(true)
}

/// Environment variables that should be forwarded from the command, to Daemon and pty processes.
pub const FORWARD_ENV_VARS: &[&str] = &[
    "TAB_RUNTIME_DIR", // The daemon & pty should inherit the runtime directory of the command client
    "TAB_RAW_MODE", // Raw mode controls stderr forwarding.  When disabled, the command stderr pipe is inherited by the daemon/client
    "TAB_BIN", // path to the initiating tab binary (where the command was launched).  used by integration tests to launch tab within a shell
];

/// Forwards the environment variables required by tab from the current process, to the child
/// See FORWARD_ENV_VARS for a list and explanation of forwarded vars.
pub fn forward_env(child: &mut Command) {
    for var in crate::env::FORWARD_ENV_VARS.iter().copied() {
        if let Ok(value) = std::env::var(var) {
            debug!("forwarding env {} as {}", var, &value);
            child.env(var, value);
        }
    }
}

/// Forwards the environment variables required by tab from the current process, to the child
/// See FORWARD_ENV_VARS for a list and explanation of forwarded vars.
pub fn forward_env_std(child: &mut std::process::Command) {
    for var in crate::env::FORWARD_ENV_VARS.iter().copied() {
        if let Ok(value) = std::env::var(var) {
            debug!("forwarding env {} as {}", var, &value);
            child.env(var, value);
        }
    }
}