Command Sequences, Blocking CLI Commands, New Plugin APIs (#4546)

* fix deadlocks

* initial logging to plugin implementation

* only log actions, include keys as Action::Write

* send actions to plugins as a new Event::UserAction

* add Action::Write metadata to plugin API

* run_action plugin command and permission

* block-until-exit/success/failure in the cli

* fix tests

* add NewBlockingPane to the plugin API

* run actions in a different thread so as not to block plugin execution

* add custom context to run_action flow

* fixes for floating pane z_index sorting and unknown protobuf events not crashing plugins

* always render the frame of pinned panes

* macros module

* add macros to config

* KDL macro parsing

* thread macros to the plugin thread

* get/update/delete macros from plugins

* add macros updated event

* add ability to rename macros

* fix deadlock

* fix z_indices with pinned unselectable panes bug

* allow plugins to opt-in to show_cursor

* change show_cursor(bool) to show_cursor(Option<coordinates>)

* test

* upgrade strum to allow proper enum iteration and case insensitive fromstr implementation for Actions

* better cwd tracking for exited command panes

* add initial panes to NewTab Action (no-op for now)

* add initial panes to cli newtab action

* make initial panes work

* add close_on_exit and start_suspended to the cli

* properly convert newtab action (potentially breaking for plugins)

* allow first pane in tab to block

* make distinction between opening panes with the last active client and the current pane in the cli

* improve some apis

* fix fixed size closing pane bug

* fix plugin cursor coordinates

* fix issues with launch-or-focus-plugin having to do with in-place and suppressed panes

* fix: set affected pane in replace pane

* allow setting a pane in place when it is suppressed and being focused (tests failing)

* fix tests

* some fixes for unsuppression of panes

* some fixes for completion_tx in new tab action

* allow replace/suppressed rather than replace/close only

* fixes for inserting suppressed panes without conflicts

* pane focus history and explicit unsuppress plugin api

* fix: prefer explicitly provided pane id in placement in actions that provide it

* fix floating pane coordinate change and z_index

* fix plugin cache dir to persist between sessions

* fix some stack focusing issues when adding panes without a client id

* make sure pinned panes are always above non-pinned floating panes

* allow plugins to copy to clipboard

* initial text styling additions implementations - buggy

* fix dimming issues

* remove extras, stay with just dim and unbold

* unbold and dim as indices

* allow ui components to render success/error colors

* allow plugins to send sigint/sigkill to processes, as well as receive their pid

* ui component fixes and send originating plugin context with run_action

* originating plugin for new tab too

* make plugn show pane command also expand stacked panes

* add sequence plugin

* remove macros

* remove snapshots

* add shortcut for sequence plugin

* fix plugin tests

* plugin tests for new apis

* update snapshots for sequence shortcut

* cleanups and formatting

* Event::CwdChanged

* moar cleanups

* remove some warnings

* remove mroe warnings

* remove dead code

* remove more dead code

* fix minor bugs in sequence plugin

* update sequence help and format codebase

* fix conditional blocking cli commands

* fix initial-command new-tab cli flag

* add client_ids to CwdChanged Event

* last fixes

* add pr

1 files changed, 86 insertions, 0 deletions

diff --git a/default-plugins/sequence/src/state/command_entry.rs b/default-plugins/sequence/src/state/command_entry.rs
new file mode 100644
index 00000000..96a0020b
--- /dev/null
+++ b/default-plugins/sequence/src/state/command_entry.rs
@@ -0,0 +1,86 @@
+use super::{ChainType, CommandStatus};
+use std::path::PathBuf;
+use std::time::Instant;
+use zellij_tile::prelude::PaneId;
+
+#[derive(Debug, Clone)]
+pub struct CommandEntry {
+    text: String,
+    cwd: Option<PathBuf>,
+    pub(super) chain_type: ChainType,
+    pub(super) status: CommandStatus,
+    pub(super) start_time: std::time::Instant,
+}
+
+impl Default for CommandEntry {
+    fn default() -> Self {
+        CommandEntry {
+            text: String::default(),
+            cwd: None,
+            chain_type: ChainType::default(),
+            status: CommandStatus::default(),
+            start_time: Instant::now(),
+        }
+    }
+}
+
+impl CommandEntry {
+    pub fn new(text: &str, cwd: Option<PathBuf>) -> Self {
+        CommandEntry {
+            text: text.to_owned(),
+            cwd,
+            ..Default::default()
+        }
+    }
+    pub fn with_and(mut self) -> Self {
+        self.chain_type = ChainType::And;
+        self
+    }
+    pub fn get_text(&self) -> String {
+        self.text.clone()
+    }
+    pub fn set_text(&mut self, text: String) {
+        self.text = text;
+    }
+    pub fn clear_text(&mut self) {
+        self.text.clear();
+    }
+    pub fn get_chain_type(&self) -> ChainType {
+        self.chain_type
+    }
+    pub fn set_chain_type(&mut self, chain_type: ChainType) {
+        self.chain_type = chain_type;
+    }
+    pub fn get_status(&self) -> CommandStatus {
+        self.status.clone()
+    }
+    pub fn set_status(&mut self, status: CommandStatus) {
+        self.status = status;
+    }
+    pub fn get_pane_id(&self) -> Option<PaneId> {
+        self.status.get_pane_id()
+    }
+    pub fn is_empty(&self) -> bool {
+        self.text.trim().is_empty()
+    }
+    pub fn fill_chain_type_if_empty(&mut self) {
+        if let ChainType::None = self.chain_type {
+            self.chain_type = ChainType::And;
+        }
+    }
+    pub fn clear_chain_type(&mut self) {
+        self.chain_type = ChainType::None;
+    }
+    pub fn clear_status(&mut self) {
+        self.status = CommandStatus::Pending;
+    }
+    pub fn cycle_chain_type(&mut self) {
+        self.chain_type.cycle_next();
+    }
+    pub fn get_cwd(&self) -> Option<PathBuf> {
+        self.cwd.clone()
+    }
+    pub fn set_cwd(&mut self, cwd: Option<PathBuf>) {
+        self.cwd = cwd;
+    }
+}