tmux_interface 0.3.2

Rust language library for communication with TMUX via CLI
Documentation
use crate::commands::constants::*;
use crate::PaneSize;
use crate::TmuxCommand;
use std::borrow::Cow;

pub type SplitW<'a> = SplitWindow<'a>;

/// Create a new pane by splitting target-pane
///
/// # Manual
///
/// tmux ^3.2:
/// ```text
/// split-window [-bdfhIvPZ] [-c start-directory] [-e environment] [-l size] [-t target-pane]
/// [shell-command] [-F format]
/// (alias: splitw)
/// ```
///
/// tmux ^3.1:
/// ```text
/// split-window [-bdfhIvP] [-c start-directory] [-e environment] [-l size] [-t target-pane]
/// [shell-command] [-F format]
/// (alias: splitw)
/// ```
///
/// tmux ^3.0:
/// ```text
/// split-window [-bdfhIvP] [-c start-directory] [-e environment] [-l size | -p percentage]
/// [-t target-pane] [shell-command] [-F format]
/// (alias: splitw)
/// ```
///
/// tmux ^2.4:
/// ```text
/// split-window [-bdfhvP] [-c start-directory] [-l size | -p percentage] [-t target-pane]
/// [shell-command] [-F format]
/// (alias: splitw)
/// ```
///
/// tmux ^2.0:
/// ```text
/// split-window [-bdhvP] [-c start-directory] [-l size | -p percentage] [-t target-pane]
/// [shell-command] [-F format]
/// (alias: splitw)
/// ```
///
/// tmux ^1.7:
/// ```text
/// split-window [-dhvP] [-c start-directory] [-l size | -p percentage] [-t target-pane]
/// [shell-command] [-F format]
/// (alias: splitw)
/// ```
///
/// tmux ^1.5:
/// ```text
/// split-window [-dhvP] [-l size | -p percentage] [-t target-pane] [shell-command]
/// (alias: splitw)
/// ```
///
/// tmux ^1.2:
/// ```text
/// split-window [-dhv] [-l size | -p percentage] [-t target-pane] [shell-command]
/// (alias: splitw)
/// ```
///
/// tmux ^1.0:
/// ```text
/// split-window [-dhv] [-l size | -p percentage] [-t target-window] [command]
/// (alias: splitw)
/// ```
///
/// tmux ^0.8:
/// ```text
/// split-window [-d] [-l size | -p percentage] [-t target-window] [command]
/// (alias: splitw)
/// ```
#[derive(Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug, Default)]
pub struct SplitWindow<'a> {
    /// `[-b]` - cause the new pane to be created to the left of or above target-pane
    #[cfg(feature = "tmux_2_4")]
    pub before: bool,

    /// `[-d]` - do not make the new window the current window
    #[cfg(feature = "tmux_0_8")]
    pub detached: bool,

    /// `[-f]` - creates a new pane spanning the full window size (h, v)
    #[cfg(feature = "tmux_2_4")]
    pub full: bool,

    /// `[-h]` - horizontal split
    #[cfg(feature = "tmux_1_0")]
    pub horizontal: bool,

    /// `[-I]` - create an empty pane and forward any output from stdin to it
    #[cfg(feature = "tmux_3_0")]
    pub stdin_forward: bool,

    /// `[-v]` - vertical split
    #[cfg(feature = "tmux_1_0")]
    pub vertical: bool,

    /// `[-P]` - print information about the new window after it has been created
    #[cfg(feature = "tmux_1_5")]
    pub print: bool,

    /// `[-Z]` - print information about the new window after it has been created
    #[cfg(feature = "tmux_3_2")]
    pub zoom: bool,

    /// `[-c start_directory]` - start-directory
    #[cfg(feature = "tmux_1_7")]
    pub start_directory: Option<Cow<'a, str>>,

    /// `[-e environment]` - environment
    #[cfg(feature = "tmux_3_1")]
    pub environment: Option<Cow<'a, str>>,

    /// `[-l size]` - specify the size of the new pane in lines
    /// `[-l size | -p percentage]` - specify the size of the new pane in lines
    #[cfg(feature = "tmux_0_8")]
    pub size: Option<&'a PaneSize>,

    /// `[-F format]` - format
    #[cfg(feature = "tmux_1_7")]
    pub format: Option<Cow<'a, str>>,

    /// `[-t target-pane]` -
    #[cfg(feature = "tmux_1_2")]
    pub target_pane: Option<Cow<'a, str>>,

    /// `[-t target-window]` -
    #[cfg(feature = "tmux_0_8")]
    pub target_window: Option<Cow<'a, str>>,

    /// `[shell-command]` - shell-command
    #[cfg(feature = "tmux_1_2")]
    pub shell_command: Option<Cow<'a, str>>,
}

impl<'a> SplitWindow<'a> {
    pub fn new() -> Self {
        Default::default()
    }

    /// `[-b]` - cause the new pane to be created to the left of or above target-pane
    #[cfg(feature = "tmux_2_4")]
    pub fn before(mut self) -> Self {
        self.before = true;
        self
    }

    /// `[-d]` - do not make the new window the current window
    #[cfg(feature = "tmux_0_8")]
    pub fn detached(mut self) -> Self {
        self.detached = true;
        self
    }

    /// `[-f]` - creates a new pane spanning the full window size (h, v)
    #[cfg(feature = "tmux_2_4")]
    pub fn full(mut self) -> Self {
        self.full = true;
        self
    }

    /// `[-h]` - horizontal split
    #[cfg(feature = "tmux_1_0")]
    pub fn horizontal(mut self) -> Self {
        self.horizontal = true;
        self
    }

    /// `[-I]` - create an empty pane and forward any output from stdin to it
    #[cfg(feature = "tmux_3_0")]
    pub fn stdin_forward(mut self) -> Self {
        self.stdin_forward = true;
        self
    }

    /// `[-v]` - vertical split
    #[cfg(feature = "tmux_1_0")]
    pub fn vertical(mut self) -> Self {
        self.vertical = true;
        self
    }

    /// `[-P]` - print information about the new window after it has been created
    #[cfg(feature = "tmux_1_5")]
    pub fn print(mut self) -> Self {
        self.print = true;
        self
    }

    /// `[-Z]` - zooms if the window is not zoomed, or keeps it zoomed if already zoomed
    #[cfg(feature = "tmux_3_2")]
    pub fn zoom(mut self) -> Self {
        self.zoom = true;
        self
    }

    /// `[-c start_directory]` - start-directory
    #[cfg(feature = "tmux_1_7")]
    pub fn start_directory<S: Into<Cow<'a, str>>>(mut self, start_directory: S) -> Self {
        self.start_directory = Some(start_directory.into());
        self
    }

    /// `[-e environment]` - environment
    #[cfg(feature = "tmux_3_1")]
    pub fn environment<S: Into<Cow<'a, str>>>(mut self, environment: S) -> Self {
        self.environment = Some(environment.into());
        self
    }

    /// `[-l size]` - specify the size of the new pane in lines
    /// `[-l size | -p percentage]` - specify the size of the new pane in lines
    #[cfg(feature = "tmux_0_8")]
    pub fn size(mut self, size: &'a PaneSize) -> Self {
        self.size = Some(size);
        self
    }

    /// `[-t target-pane]` -
    #[cfg(feature = "tmux_1_2")]
    pub fn target_pane<S: Into<Cow<'a, str>>>(mut self, target_pane: S) -> Self {
        self.target_pane = Some(target_pane.into());
        self
    }

    /// `[-F format]` - format
    #[cfg(feature = "tmux_1_7")]
    pub fn format<S: Into<Cow<'a, str>>>(mut self, format: S) -> Self {
        self.format = Some(format.into());
        self
    }

    /// `[-t target-window]` -
    #[cfg(feature = "tmux_0_8")]
    pub fn target_window<S: Into<Cow<'a, str>>>(mut self, target_window: S) -> Self {
        self.target_window = Some(target_window.into());
        self
    }

    /// `[shell-command]` - shell-command
    #[cfg(feature = "tmux_1_2")]
    pub fn shell_command<S: Into<Cow<'a, str>>>(mut self, shell_command: S) -> Self {
        self.shell_command = Some(shell_command.into());
        self
    }

    pub fn build(self) -> TmuxCommand<'a> {
        let mut cmd = TmuxCommand::new();

        cmd.name(SPLIT_WINDOW);

        // `[-b]` - cause the new pane to be created to the left of or above target-pane
        #[cfg(feature = "tmux_2_4")]
        if self.before {
            cmd.push_flag(B_LOWERCASE_KEY);
        }

        // `[-d]` - do not make the new window the current window
        #[cfg(feature = "tmux_0_8")]
        if self.detached {
            cmd.push_flag(D_LOWERCASE_KEY);
        }

        // `[-f]` - creates a new pane spanning the full window size (h, v)
        #[cfg(feature = "tmux_2_4")]
        if self.full {
            cmd.push_flag(F_LOWERCASE_KEY);
        }

        // `[-h]` - horizontal split
        #[cfg(feature = "tmux_1_0")]
        if self.horizontal {
            cmd.push_flag(H_LOWERCASE_KEY);
        }

        // `[-I]` - create an empty pane and forward any output from stdin to it
        #[cfg(feature = "tmux_3_0")]
        if self.stdin_forward {
            cmd.push_flag(I_UPPERCASE_KEY);
        }

        // `[-v]` - vertical split
        #[cfg(feature = "tmux_1_0")]
        if self.vertical {
            cmd.push_flag(V_LOWERCASE_KEY);
        }

        // `[-P]` - print information about the new window after it has been created
        #[cfg(feature = "tmux_1_5")]
        if self.print {
            cmd.push_flag(P_UPPERCASE_KEY);
        }

        // `[-c start_directory]` - start-directory
        #[cfg(feature = "tmux_1_7")]
        if let Some(start_directory) = self.start_directory {
            cmd.push_option(C_LOWERCASE_KEY, start_directory);
        }

        // `[-e environment]` - environment
        #[cfg(feature = "tmux_3_1")]
        if let Some(environment) = self.environment {
            cmd.push_option(E_LOWERCASE_KEY, environment);
        }

        // `[-l size]` - specify the size of the new pane in lines
        // `[-l size | -p percentage]` - specify the size of the new pane in lines
        #[cfg(feature = "tmux_0_8")]
        if let Some(size) = &self.size {
            #[cfg(all(feature = "tmux_0_8", not(feature = "tmux_3_1")))]
            match size {
                PaneSize::Size(size) => {
                    cmd.push_option(L_LOWERCASE_KEY, Cow::Owned(size.to_string()))
                }
                PaneSize::Percentage(size) => {
                    cmd.push_option(L_LOWERCASE_KEY, Cow::Owned(format!("{}%", size)))
                }
            };
            #[cfg(feature = "tmux_3_1")]
            match size {
                PaneSize::Size(size) => cmd.push_option(L_LOWERCASE_KEY, size.to_string()),
                PaneSize::Percentage(size) => cmd.push_option(P_LOWERCASE_KEY, size.to_string()),
            };
        }

        // `[-F format]` - format
        #[cfg(feature = "tmux_1_7")]
        if let Some(format) = self.format {
            cmd.push_option(F_UPPERCASE_KEY, format);
        }

        // `[-t target-pane]` -
        #[cfg(feature = "tmux_1_2")]
        if let Some(target_pane) = self.target_pane {
            cmd.push_option(T_LOWERCASE_KEY, target_pane);
        }

        // `[-t target-window]` -
        #[cfg(feature = "tmux_0_8")]
        if let Some(target_window) = self.target_window {
            cmd.push_option(T_LOWERCASE_KEY, target_window);
        }

        // `[shell-command]` - shell-command
        #[cfg(feature = "tmux_1_2")]
        if let Some(shell_command) = self.shell_command {
            cmd.push_param(shell_command);
        }

        cmd
    }
}