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, 73 insertions, 0 deletions

diff --git a/default-plugins/sequence/src/state/layout.rs b/default-plugins/sequence/src/state/layout.rs
new file mode 100644
index 00000000..65a267e0
--- /dev/null
+++ b/default-plugins/sequence/src/state/layout.rs
@@ -0,0 +1,73 @@
+use crate::state::positioning;
+use std::path::PathBuf;
+use zellij_tile::prelude::*;
+
+pub struct Layout {
+    pub needs_reposition: bool,
+    pub cached_cursor_position: Option<(usize, usize)>,
+    pub spinner_frame: usize,
+    pub spinner_timer_scheduled: bool,
+}
+
+impl Layout {
+    pub fn new() -> Self {
+        Self {
+            needs_reposition: false,
+            cached_cursor_position: None,
+            spinner_frame: 0,
+            spinner_timer_scheduled: false,
+        }
+    }
+
+    pub fn reposition_plugin_based_on_sequence_state(
+        &mut self,
+        is_running: bool,
+        first_command_pane_id: Option<PaneId>,
+        pane_manifest: &PaneManifest,
+        plugin_id: Option<u32>,
+        total_viewport_columns: Option<usize>,
+        total_viewport_rows: Option<usize>,
+        total_commands: usize,
+        _selected_index: Option<usize>,
+        _running_index: usize,
+        _cwd: &Option<PathBuf>,
+    ) {
+        let Some(plugin_id) = plugin_id else {
+            return;
+        };
+        let (Some(total_cols), Some(total_rows)) = (total_viewport_columns, total_viewport_rows)
+        else {
+            return;
+        };
+
+        if !self.needs_reposition || !is_running {
+            return;
+        }
+
+        let Some(first_pane_id) = first_command_pane_id else {
+            return;
+        };
+
+        for (_tab_index, panes) in &pane_manifest.panes {
+            for pane in panes {
+                if !pane.is_plugin && PaneId::Terminal(pane.id) == first_pane_id {
+                    positioning::reposition_plugin_for_sequence(
+                        plugin_id,
+                        total_cols,
+                        total_rows,
+                        total_commands,
+                    );
+
+                    self.needs_reposition = false;
+                    return;
+                }
+            }
+        }
+    }
+}
+
+impl Default for Layout {
+    fn default() -> Self {
+        Self::new()
+    }
+}