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, 39 insertions, 3 deletions

diff --git a/default-plugins/fixture-plugin-for-tests/src/main.rs b/default-plugins/fixture-plugin-for-tests/src/main.rs
index 01489860..9f5b7e93 100644
--- a/default-plugins/fixture-plugin-for-tests/src/main.rs
+++ b/default-plugins/fixture-plugin-for-tests/src/main.rs
@@ -2,6 +2,7 @@ use serde::{Deserialize, Serialize};
 use std::collections::BTreeMap;
 #[allow(unused_imports)]
 use std::io::prelude::*;
+use zellij_tile::prelude::actions::Action;
 use zellij_tile::prelude::*;
 
 // This is a fixture plugin used only for tests in Zellij
@@ -59,6 +60,8 @@ impl ZellijPlugin for State {
             PermissionType::ReadCliPipes,
             PermissionType::MessageAndLaunchOtherPlugins,
             PermissionType::Reconfigure,
+            PermissionType::WriteToClipboard,
+            PermissionType::RunActionsAsUser,
         ]);
         self.configuration = configuration;
         subscribe(&[
@@ -258,11 +261,13 @@ impl ZellijPlugin for State {
                 },
                 BareKey::Char('t') if key.has_modifiers(&[KeyModifier::Ctrl]) => {
                     let should_float_if_hidden = false;
-                    focus_terminal_pane(1, should_float_if_hidden);
+                    let should_be_in_place_if_hidden = false;
+                    focus_terminal_pane(1, should_float_if_hidden, should_be_in_place_if_hidden);
                 },
                 BareKey::Char('u') if key.has_modifiers(&[KeyModifier::Ctrl]) => {
                     let should_float_if_hidden = false;
-                    focus_plugin_pane(1, should_float_if_hidden);
+                    let should_be_in_place_if_hidden = false;
+                    focus_plugin_pane(1, should_float_if_hidden, should_be_in_place_if_hidden);
                 },
                 BareKey::Char('v') if key.has_modifiers(&[KeyModifier::Ctrl]) => {
                     rename_terminal_pane(1, "new terminal_pane_name");
@@ -354,7 +359,7 @@ impl ZellijPlugin for State {
                     hide_pane_with_id(PaneId::Terminal(1));
                 },
                 BareKey::Char('b') if key.has_modifiers(&[KeyModifier::Alt]) => {
-                    show_pane_with_id(PaneId::Terminal(1), true);
+                    show_pane_with_id(PaneId::Terminal(1), true, true);
                 },
                 BareKey::Char('c') if key.has_modifiers(&[KeyModifier::Alt]) => {
                     open_command_pane_background(
@@ -549,6 +554,37 @@ impl ZellijPlugin for State {
                 BareKey::Char('z') if key.has_modifiers(&[KeyModifier::Alt]) => {
                     list_clients();
                 },
+                BareKey::Char('a') if key.has_modifiers(&[KeyModifier::Super]) => {
+                    // Test show_cursor with coordinates
+                    show_cursor(Some((5, 10)));
+                },
+                BareKey::Char('b') if key.has_modifiers(&[KeyModifier::Super]) => {
+                    // Test hide_cursor
+                    show_cursor(None);
+                },
+                BareKey::Char('c') if key.has_modifiers(&[KeyModifier::Super]) => {
+                    // Test copy_to_clipboard
+                    copy_to_clipboard("test clipboard text");
+                },
+                BareKey::Char('d') if key.has_modifiers(&[KeyModifier::Super]) => {
+                    // Test run_action with MoveFocus
+                    let mut context = BTreeMap::new();
+                    context.insert("test_key".to_string(), "test_value".to_string());
+                    run_action(
+                        Action::MoveFocus {
+                            direction: Direction::Left,
+                        },
+                        context,
+                    );
+                },
+                BareKey::Char('e') if key.has_modifiers(&[KeyModifier::Super]) => {
+                    // Test send_sigint_to_pane_id
+                    send_sigint_to_pane_id(PaneId::Terminal(1));
+                },
+                BareKey::Char('f') if key.has_modifiers(&[KeyModifier::Super]) => {
+                    // Test send_sigkill_to_pane_id
+                    send_sigkill_to_pane_id(PaneId::Terminal(1));
+                },
                 _ => {},
             },
             Event::CustomMessage(message, payload) => {