diff options
| author | a-kenji <aks.kenji@protonmail.com> | 2021-07-02 18:44:36 +0200 |
|---|---|---|
| committer | a-kenji <aks.kenji@protonmail.com> | 2021-07-09 16:43:44 +0200 |
| commit | 261e691f9f966d250c15f27969327753cf6ce59a (patch) | |
| tree | 268bce5e28e7b4d654ad5bafe7784c58c914963a | |
| parent | chore(changelog): Add run-command option #596 (diff) | |
| download | sl0ppij-261e691f9f966d250c15f27969327753cf6ce59a.tar.gz sl0ppij-261e691f9f966d250c15f27969327753cf6ce59a.tar.xz sl0ppij-261e691f9f966d250c15f27969327753cf6ce59a.zip | |
Add commands to layout
Add the ability to run commands on loading a layout:
```
- direction: Horizontal
split_size:
Percent: 50
run:
command: {cmd: htop}
```
or respectively:
```
- direction: Horizontal
split_size:
Percent: 50
run:
command: {cmd: htop, args: ["-C"]}
```
In order to specify the difference of commands and
plugins now the plugins need to be under the `run` section:
```
- direction: Vertical
split_size:
Fixed: 2
run:
plugin: status-bar
```
This also means that this is a breaking change for people
that already have a custom layout.
Example layouts:
```
---
direction: Vertical
parts:
- direction: Horizontal
split_size:
Percent: 50
parts:
- direction: Vertical
split_size:
Percent: 50
- direction: Vertical
split_size:
Percent: 50
run:
command: {cmd: htop}
- direction: Horizontal
split_size:
Percent: 50
run:
command: {cmd: htop}
```
and:
```
---
direction: Horizontal
parts:
- direction: Vertical
split_size:
Fixed: 1
run:
plugin: tab-bar
- direction: Vertical
parts:
- direction: Vertical
parts:
- direction: Vertical
split_size:
Percent: 50
run:
command: {cmd: htop}
- direction: Vertical
split_size:
Percent: 50
run:
command: {cmd: htop, args: ["-C"]}
- direction: Vertical
split_size:
Fixed: 5
- direction: Vertical
split_size:
Fixed: 2
run:
plugin: status-bar
```
closes #551, closes #284
| -rw-r--r-- | example/run_htop_layout.yaml | 20 | ||||
| -rw-r--r-- | example/run_htop_layout_with_plugins.yaml | 30 | ||||
| -rw-r--r-- | zellij-server/src/pty.rs | 62 | ||||
| -rw-r--r-- | zellij-server/src/tab.rs | 7 | ||||
| -rw-r--r-- | zellij-utils/assets/layouts/default.yaml | 6 | ||||
| -rw-r--r-- | zellij-utils/assets/layouts/disable-status-bar.yaml | 3 | ||||
| -rw-r--r-- | zellij-utils/assets/layouts/strider.yaml | 9 | ||||
| -rw-r--r-- | zellij-utils/src/input/command.rs | 1 | ||||
| -rw-r--r-- | zellij-utils/src/input/layout.rs | 36 |
9 files changed, 142 insertions, 32 deletions
diff --git a/example/run_htop_layout.yaml b/example/run_htop_layout.yaml new file mode 100644 index 00000000..949435d6 --- /dev/null +++ b/example/run_htop_layout.yaml @@ -0,0 +1,20 @@ +--- +direction: Vertical +parts: + - direction: Horizontal + split_size: + Percent: 50 + parts: + - direction: Vertical + split_size: + Percent: 50 + - direction: Vertical + split_size: + Percent: 50 + run: + command: {cmd: htop} + - direction: Horizontal + split_size: + Percent: 50 + run: + command: {cmd: htop} diff --git a/example/run_htop_layout_with_plugins.yaml b/example/run_htop_layout_with_plugins.yaml new file mode 100644 index 00000000..99f72edb --- /dev/null +++ b/example/run_htop_layout_with_plugins.yaml @@ -0,0 +1,30 @@ +--- +direction: Horizontal +parts: + - direction: Vertical + split_size: + Fixed: 1 + run: + plugin: tab-bar + - direction: Vertical + parts: + - direction: Vertical + parts: + - direction: Vertical + split_size: + Percent: 50 + run: + command: {cmd: htop} + - direction: Vertical + split_size: + Percent: 50 + run: + command: {cmd: htop, args: ["-C"]} + - direction: Vertical + split_size: + Fixed: 5 + - direction: Vertical + split_size: + Fixed: 2 + run: + plugin: status-bar diff --git a/zellij-server/src/pty.rs b/zellij-server/src/pty.rs index 0dba3611..dd1ff3f5 100644 --- a/zellij-server/src/pty.rs +++ b/zellij-server/src/pty.rs @@ -1,11 +1,3 @@ -use zellij_utils::async_std; - -use async_std::future::timeout as async_timeout; -use async_std::task::{self, JoinHandle}; -use std::collections::HashMap; -use std::os::unix::io::RawFd; -use std::time::{Duration, Instant}; - use crate::{ os_input_output::{AsyncReader, Pid, ServerOsApi}, panes::PaneId, @@ -14,9 +6,22 @@ use crate::{ wasm_vm::PluginInstruction, ServerInstruction, }; +use async_std::{ + future::timeout as async_timeout, + task::{self, JoinHandle}, +}; +use std::{ + collections::HashMap, + os::unix::io::RawFd, + time::{Duration, Instant}, +}; use zellij_utils::{ + async_std, errors::{get_current_ctx, ContextType, PtyContext}, - input::{command::TerminalAction, layout::Layout}, + input::{ + command::TerminalAction, + layout::{Layout, Run}, + }, logging::debug_to_file, }; @@ -237,19 +242,36 @@ impl Pty { pub fn spawn_terminals_for_layout( &mut self, layout: Layout, - terminal_action: Option<TerminalAction>, + default_shell: Option<TerminalAction>, ) { - let total_panes = layout.total_terminal_panes(); + let extracted_run_instructions = layout.extract_run_instructions(); let mut new_pane_pids = vec![]; - for _ in 0..total_panes { - let (pid_primary, pid_secondary): (RawFd, Pid) = self - .bus - .os_input - .as_mut() - .unwrap() - .spawn_terminal(terminal_action.clone()); - self.id_to_child_pid.insert(pid_primary, pid_secondary); - new_pane_pids.push(pid_primary); + for run_instruction in extracted_run_instructions { + match run_instruction { + Some(Run::Command(command)) => { + let cmd = TerminalAction::RunCommand(command); + let (pid_primary, pid_secondary): (RawFd, Pid) = self + .bus + .os_input + .as_mut() + .unwrap() + .spawn_terminal(Some(cmd)); + self.id_to_child_pid.insert(pid_primary, pid_secondary); + new_pane_pids.push(pid_primary); + } + None => { + let (pid_primary, pid_secondary): (RawFd, Pid) = self + .bus + .os_input + .as_mut() + .unwrap() + .spawn_terminal(default_shell.clone()); + self.id_to_child_pid.insert(pid_primary, pid_secondary); + new_pane_pids.push(pid_primary); + } + // Investigate moving plugin loading to here. + Some(Run::Plugin(_)) => {} + } } self.bus .senders diff --git a/zellij-server/src/tab.rs b/zellij-server/src/tab.rs index 523f65df..ff074459 100644 --- a/zellij-server/src/tab.rs +++ b/zellij-server/src/tab.rs @@ -26,7 +26,10 @@ use std::{ }; use zellij_tile::data::{Event, InputMode, ModeInfo, Palette}; use zellij_utils::{ - input::{layout::Layout, parse_keys}, + input::{ + layout::{Layout, Run}, + parse_keys, + }, pane_size::PositionAndSize, shared::adjust_to_size, }; @@ -319,7 +322,7 @@ impl Tab { let mut new_pids = new_pids.iter(); for (layout, position_and_size) in positions_and_size { // A plugin pane - if let Some(plugin) = &layout.plugin { + if let Some(Run::Plugin(Some(plugin))) = &layout.run { let (pid_tx, pid_rx) = channel(); self.senders .send_to_plugin(PluginInstruction::Load(pid_tx, plugin.clone())) diff --git a/zellij-utils/assets/layouts/default.yaml b/zellij-utils/assets/layouts/default.yaml index 9be7af2a..96bf1809 100644 --- a/zellij-utils/assets/layouts/default.yaml +++ b/zellij-utils/assets/layouts/default.yaml @@ -4,9 +4,11 @@ parts: - direction: Vertical split_size: Fixed: 1 - plugin: tab-bar + run: + plugin: tab-bar - direction: Vertical - direction: Vertical split_size: Fixed: 2 - plugin: status-bar + run: + plugin: status-bar diff --git a/zellij-utils/assets/layouts/disable-status-bar.yaml b/zellij-utils/assets/layouts/disable-status-bar.yaml index fd9c97da..b990ba50 100644 --- a/zellij-utils/assets/layouts/disable-status-bar.yaml +++ b/zellij-utils/assets/layouts/disable-status-bar.yaml @@ -4,5 +4,6 @@ parts: - direction: Vertical split_size: Fixed: 1 - plugin: tab-bar + run: + plugin: tab-bar - direction: Vertical diff --git a/zellij-utils/assets/layouts/strider.yaml b/zellij-utils/assets/layouts/strider.yaml index 5dc9b08f..9bbe5772 100644 --- a/zellij-utils/assets/layouts/strider.yaml +++ b/zellij-utils/assets/layouts/strider.yaml @@ -4,15 +4,18 @@ parts: - direction: Vertical split_size: Fixed: 1 - plugin: tab-bar + run: + plugin: tab-bar - direction: Vertical parts: - direction: Horizontal split_size: Percent: 20 - plugin: strider + run: + plugin: strider - direction: Horizontal - direction: Vertical split_size: Fixed: 2 - plugin: status-bar + run: + plugin: status-bar diff --git a/zellij-utils/src/input/command.rs b/zellij-utils/src/input/command.rs index ca505ea2..7916e5cf 100644 --- a/zellij-utils/src/input/command.rs +++ b/zellij-utils/src/input/command.rs @@ -11,6 +11,7 @@ pub enum TerminalAction { #[derive(Clone, Debug, Deserialize, Default, Serialize, PartialEq, Eq)] pub struct RunCommand { + #[serde(alias = "cmd")] pub command: PathBuf, #[serde(default)] pub args: Vec<String>, diff --git a/zellij-utils/src/input/layout.rs b/zellij-utils/src/input/layout.rs index 16309db1..a48c3521 100644 --- a/zellij-utils/src/input/layout.rs +++ b/zellij-utils/src/input/layout.rs @@ -8,7 +8,11 @@ // place. // If plugins should be able to depend on the layout system // then [`zellij-utils`] could be a proper place. -use crate::{input::config::ConfigError, pane_size::PositionAndSize, setup}; +use crate::{ + input::{command::RunCommand, config::ConfigError}, + pane_size::PositionAndSize, + setup, +}; use crate::{serde, serde_yaml}; use serde::{Deserialize, Serialize}; @@ -31,12 +35,21 @@ pub enum SplitSize { #[derive(Debug, Serialize, Deserialize, Clone)] #[serde(crate = "self::serde")] +pub enum Run { + #[serde(rename = "plugin")] + Plugin(Option<PathBuf>), + #[serde(rename = "command")] + Command(RunCommand), +} + +#[derive(Debug, Serialize, Deserialize, Clone)] +#[serde(crate = "self::serde")] pub struct Layout { pub direction: Direction, #[serde(default)] pub parts: Vec<Layout>, pub split_size: Option<SplitSize>, - pub plugin: Option<PathBuf>, + pub run: Option<Run>, } type LayoutResult = Result<Layout, ConfigError>; @@ -127,13 +140,28 @@ impl Layout { let mut total_panes = 0; total_panes += self.parts.len(); for part in self.parts.iter() { - if part.plugin.is_none() { - total_panes += part.total_terminal_panes(); + match part.run { + Some(Run::Command(_)) | None => { + total_panes += part.total_terminal_panes(); + } + Some(Run::Plugin(_)) => {} } } total_panes } + pub fn extract_run_instructions(&self) -> Vec<Option<Run>> { + let mut run_instructions = vec![]; + if self.parts.is_empty() { + run_instructions.push(self.run.clone()); + } + for part in self.parts.iter() { + let mut current_runnables = part.extract_run_instructions(); + run_instructions.append(&mut current_runnables); + } + run_instructions + } + pub fn position_panes_in_space( &self, space: &PositionAndSize, |
