aboutsummaryrefslogtreecommitdiffstats
path: root/zellij-utils/src/client_server_contract
diff options
context:
space:
mode:
authorAram Drevekenin <aram@poor.dev>2025-12-11 14:25:42 +0100
committerGitHub <noreply@github.com>2025-12-11 14:25:42 +0100
commit693fa082def5ef0fe030cd7fdc3b1df051b35dc6 (patch)
treeb3f651462bbc1cd2fa5b2d79207343413ef6b83c /zellij-utils/src/client_server_contract
parentfix(zellij-server): unblock building on 32bit targets (#4484) (diff)
downloadsl0ppij-693fa082def5ef0fe030cd7fdc3b1df051b35dc6.tar.gz
sl0ppij-693fa082def5ef0fe030cd7fdc3b1df051b35dc6.tar.xz
sl0ppij-693fa082def5ef0fe030cd7fdc3b1df051b35dc6.zip
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
Diffstat (limited to 'zellij-utils/src/client_server_contract')
-rw-r--r--zellij-utils/src/client_server_contract/common_types.proto29
1 files changed, 29 insertions, 0 deletions
diff --git a/zellij-utils/src/client_server_contract/common_types.proto b/zellij-utils/src/client_server_contract/common_types.proto
index 254a2a75..e4561989 100644
--- a/zellij-utils/src/client_server_contract/common_types.proto
+++ b/zellij-utils/src/client_server_contract/common_types.proto
@@ -333,6 +333,7 @@ message NewPaneAction {
optional Direction direction = 1;
optional string pane_name = 2;
bool start_suppressed = 3;
+ bool near_current_pane = 4;
}
message EditFileAction {
@@ -342,34 +343,43 @@ message EditFileAction {
bool in_place = 4;
bool start_suppressed = 5;
optional FloatingPaneCoordinates coordinates = 6;
+ bool near_current_pane = 7;
}
message NewFloatingPaneAction {
optional RunCommandAction command = 1;
optional string pane_name = 2;
optional FloatingPaneCoordinates coordinates = 3;
+ bool near_current_pane = 7;
}
message NewTiledPaneAction {
optional Direction direction = 1;
optional RunCommandAction command = 2;
optional string pane_name = 3;
+ bool near_current_pane = 7;
}
message NewInPlacePaneAction {
optional RunCommandAction command = 1;
optional string pane_name = 2;
+ bool near_current_pane = 3;
+ optional PaneId pane_id_to_replace = 4;
+ bool close_replace_pane = 5;
}
message NewStackedPaneAction {
optional RunCommandAction command = 1;
optional string pane_name = 2;
+ bool near_current_pane = 3;
}
message NewBlockingPaneAction {
NewPanePlacement placement = 1;
optional string pane_name = 2;
optional RunCommandAction command = 3;
+ optional UnblockCondition unblock_condition = 4;
+ bool near_current_pane = 5;
}
message PaneNameInputAction {
@@ -384,6 +394,8 @@ message NewTabAction {
optional string tab_name = 5;
bool should_change_focus_to_new_tab = 6;
optional string cwd = 7;
+ repeated CommandOrPlugin initial_panes = 8;
+ optional UnblockCondition first_pane_unblock_condition = 9;
}
message GoToTabAction {
@@ -405,6 +417,7 @@ message MoveTabAction {
message RunAction {
RunCommandAction command = 1;
+ bool near_current_pane = 2;
}
message LaunchOrFocusPluginAction {
@@ -479,11 +492,13 @@ message ClosePluginPaneAction {
message FocusTerminalPaneWithIdAction {
uint32 pane_id = 1;
bool should_float_if_hidden = 2;
+ bool should_be_in_place_if_hidden = 3;
}
message FocusPluginPaneWithIdAction {
uint32 pane_id = 1;
bool should_float_if_hidden = 2;
+ bool should_be_in_place_if_hidden = 3;
}
message RenameTerminalPaneAction {
@@ -571,6 +586,13 @@ enum Direction {
DIRECTION_DOWN = 4;
}
+enum UnblockCondition {
+ UNBLOCK_CONDITION_UNSPECIFIED = 0;
+ UNBLOCK_CONDITION_ON_EXIT_SUCCESS = 1;
+ UNBLOCK_CONDITION_ON_EXIT_FAILURE = 2;
+ UNBLOCK_CONDITION_ON_ANY_EXIT = 3;
+}
+
enum ResizeType {
RESIZE_TYPE_UNSPECIFIED = 0;
RESIZE_TYPE_INCREASE = 1;
@@ -761,6 +783,13 @@ message PluginAlias {
optional RunPlugin run_plugin = 4;
}
+message CommandOrPlugin {
+ oneof command_or_plugin_type {
+ RunCommandAction command = 1;
+ RunPluginOrAlias plugin = 2;
+ }
+}
+
message MouseEvent {
MouseEventType event_type = 1;
bool left = 2;