use serde::{de::DeserializeOwned, Serialize}; use std::collections::{BTreeMap, HashSet}; use std::{ io, path::{Path, PathBuf}, }; use zellij_utils::data::*; use zellij_utils::errors::prelude::*; use zellij_utils::input::actions::Action; use zellij_utils::pane_size::Size; pub use zellij_utils::plugin_api; use zellij_utils::plugin_api::event::ProtobufPaneScrollbackResponse; use zellij_utils::plugin_api::generated_api::api::plugin_command::{ hide_floating_panes_response, save_session_response, show_floating_panes_response, }; use zellij_utils::plugin_api::plugin_command::{ dump_layout_response, dump_session_layout_response, get_focused_pane_info_response, get_pane_cwd_response, get_pane_running_command_response, get_session_list_response, parse_layout_response, CreateTokenResponse, ListTokensResponse, ProtobufBreakPanesToNewTabResponse, ProtobufBreakPanesToTabWithIdResponse, ProtobufBreakPanesToTabWithIndexResponse, ProtobufCurrentSessionLastSavedTimeResponse, ProtobufDeleteAllDeadSessionsResponse, ProtobufDeleteDeadSessionResponse, ProtobufDeleteLayoutResponse, ProtobufDumpLayoutResponse, ProtobufDumpSessionLayoutResponse, ProtobufEditLayoutResponse, ProtobufFocusOrCreateTabResponse, ProtobufGenerateRandomNameResponse, ProtobufGetFocusedPaneInfoResponse, ProtobufGetLayoutDirResponse, ProtobufGetPaneCwdResponse, ProtobufGetPaneInfoResponse, ProtobufGetPanePidResponse, ProtobufGetPaneRunningCommandResponse, ProtobufGetSessionEnvironmentVariablesResponse, ProtobufGetSessionListResponse, ProtobufGetTabInfoResponse, ProtobufHideFloatingPanesResponse, ProtobufKillSessionsResponse, ProtobufNewTabResponse, ProtobufNewTabUnfocusedResponse, ProtobufNewTabsResponse, ProtobufNewTiledPaneInTabResponse, ProtobufOpenCommandPaneBackgroundResponse, ProtobufOpenCommandPaneFloatingNearPluginResponse, ProtobufOpenCommandPaneFloatingResponse, ProtobufOpenCommandPaneInPlaceOfPaneIdResponse, ProtobufOpenCommandPaneInPlaceOfPluginResponse, ProtobufOpenCommandPaneInPlaceResponse, ProtobufOpenCommandPaneNearPluginResponse, ProtobufOpenCommandPaneResponse, ProtobufOpenEditPaneInPlaceOfPaneIdResponse, ProtobufOpenFileFloatingNearPluginResponse, ProtobufOpenFileFloatingResponse, ProtobufOpenFileInPlaceOfPluginResponse, ProtobufOpenFileInPlaceResponse, ProtobufOpenFileNearPluginResponse, ProtobufOpenFileResponse, ProtobufOpenPaneInNewTabResponse, ProtobufOpenPluginPaneFloatingResponse, ProtobufOpenTerminalFloatingNearPluginResponse, ProtobufOpenTerminalFloatingResponse, ProtobufOpenTerminalInPlaceOfPluginResponse, ProtobufOpenTerminalInPlaceResponse, ProtobufOpenTerminalNearPluginResponse, ProtobufOpenTerminalPaneInPlaceOfPaneIdResponse, ProtobufOpenTerminalResponse, ProtobufParseLayoutResponse, ProtobufPluginCommand, ProtobufRenameLayoutResponse, ProtobufSaveLayoutResponse, ProtobufSaveSessionResponse, ProtobufShowFloatingPanesResponse, RenameWebTokenResponse, RevokeAllWebTokensResponse, RevokeTokenResponse, }; use zellij_utils::plugin_api::plugin_ids::{ProtobufPluginIds, ProtobufZellijVersion}; pub use super::ui_components::*; pub use prost::{self, *}; // Subscription Handling /// Subscribe to a list of [`Event`]s represented by their [`EventType`]s that will then trigger the `update` method pub fn subscribe(event_types: &[EventType]) { let event_types: HashSet = event_types.iter().cloned().collect(); let plugin_command = PluginCommand::Subscribe(event_types); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Unsubscribe to a list of [`Event`]s represented by their [`EventType`]s. pub fn unsubscribe(event_types: &[EventType]) { let event_types: HashSet = event_types.iter().cloned().collect(); let plugin_command = PluginCommand::Unsubscribe(event_types); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } // Plugin Settings /// Sets the plugin as selectable or unselectable to the user. Unselectable plugins might be desired when they do not accept user input. pub fn set_selectable(selectable: bool) { let plugin_command = PluginCommand::SetSelectable(selectable); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Shows the cursor at specific coordinates or hides it /// /// # Arguments /// * `cursor_position` - None to hide cursor, Some((x, y)) to show at coordinates pub fn show_cursor(cursor_position: Option<(usize, usize)>) { let plugin_command = PluginCommand::ShowCursor(cursor_position); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn request_permission(permissions: &[PermissionType]) { let plugin_command = PluginCommand::RequestPluginPermissions(permissions.into()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } // Query Functions /// Returns the unique Zellij pane ID for the plugin as well as the Zellij process id. pub fn get_plugin_ids() -> PluginIds { let plugin_command = PluginCommand::GetPluginIds; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_plugin_ids = ProtobufPluginIds::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); PluginIds::try_from(protobuf_plugin_ids).unwrap() } /// Returns the version of the running Zellij instance - can be useful to check plugin compatibility pub fn get_zellij_version() -> String { let plugin_command = PluginCommand::GetZellijVersion; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_zellij_version = ProtobufZellijVersion::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); protobuf_zellij_version.version } /// Generates a random human-readable name using Zellij's curated word lists. /// Returns a name in the format AdjectiveNoun (e.g., "BraveRustacean", "ZippyWeasel"). /// /// This uses the same word lists as session name generation, providing /// approximately 4,096 unique combinations. pub fn generate_random_name() -> String { let plugin_command = PluginCommand::GenerateRandomName; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufGenerateRandomNameResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); response.name } /// Dumps a layout by name and returns its KDL content as a String /// /// Supports both built-in layouts (eg. "default", "compact", "welcome") /// and custom layouts from the plugin's layout directory. pub fn dump_layout(layout_name: &str) -> Result { // Create the plugin command with the layout name let plugin_command = PluginCommand::DumpLayout(layout_name.to_string()); // Convert to protobuf and encode let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); // Call the host function (blocks until response) unsafe { host_run_plugin_command() }; // Read and decode the response let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; let protobuf_response = ProtobufDumpLayoutResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Extract result from the oneof field match protobuf_response.result { Some(dump_layout_response::Result::LayoutContent(content)) => Ok(content), Some(dump_layout_response::Result::Error(error)) => Err(error), None => Err("Server returned empty response".to_string()), } } /// Returns the path to the layout directory. /// /// This is the directory where Zellij looks for layout files. It can be: /// - The directory specified via CLI `--layout-dir` flag /// - The directory specified in the config file /// - The directory specified via ZELLIJ_LAYOUT_DIR env var /// - The default: `~/.config/zellij/layouts` /// /// # Returns /// A String containing the absolute path to the layout directory. /// Returns an empty string if the layout directory cannot be determined (rare edge case). pub fn get_layout_dir() -> String { let plugin_command = PluginCommand::GetLayoutDir; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufGetLayoutDirResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); response.layout_dir } pub fn get_session_environment_variables() -> BTreeMap { let plugin_command = PluginCommand::GetSessionEnvironmentVariables; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufGetSessionEnvironmentVariablesResponse::decode( bytes_from_stdin().unwrap().as_slice(), ) .unwrap(); response .env_vars .into_iter() .map(|env_var| (env_var.name, env_var.value)) .collect() } /// Returns the focused pane ID and tab index for the client associated with this plugin. pub fn get_focused_pane_info() -> Result<(usize, PaneId), String> { let plugin_command = PluginCommand::GetFocusedPaneInfo; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_response = ProtobufGetFocusedPaneInfoResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); match protobuf_response.result { Some(get_focused_pane_info_response::Result::FocusedPaneInfo(info)) => { let tab_index = info.focused_tab_index as usize; match info.focused_pane_id { Some(pb_pane_id) => match pb_pane_id.try_into() { Ok(pane_id) => Ok((tab_index, pane_id)), Err(_) => Err("Invalid pane_id in response".to_string()), }, None => Err("Missing pane_id in response".to_string()), } }, Some(get_focused_pane_info_response::Result::Error(err)) => Err(err), None => Err("Empty response from host".to_string()), } } /// Query information about a specific pane by its PaneId. /// /// This synchronously queries Zellij for detailed information about the pane with the given ID, /// including its position, size, state, and other metadata. /// /// # Parameters /// /// - `pane_id`: The ID of the pane to query /// /// # Returns /// /// - `Some(PaneInfo)` if the pane exists and information was successfully retrieved /// - `None` if the pane does not exist or could not be found /// /// # Example /// /// ```no_run /// use zellij_tile::prelude::*; /// /// // Query info for a specific pane /// let pane_id = PaneId::Terminal(1); /// match get_pane_info(pane_id) { /// Some(info) => { /// println!("Pane title: {}", info.title); /// println!("Pane is focused: {}", info.is_focused); /// println!("Pane position: ({}, {})", info.pane_x, info.pane_y); /// }, /// None => println!("Pane not found"), /// } /// ``` pub fn get_pane_info(pane_id: PaneId) -> Option { let plugin_command = PluginCommand::GetPaneInfo(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_response = ProtobufGetPaneInfoResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); protobuf_response .pane_info .and_then(|pb_pane_info| pb_pane_info.try_into().ok()) } /// Query information about a specific tab by its tab ID. /// /// This synchronously queries Zellij for detailed information about the tab with the given ID, /// including its name, position, active state, pane counts, and other metadata. /// /// # Parameters /// /// - `tab_id`: The stable ID of the tab to query /// /// # Returns /// /// - `Some(TabInfo)` if the tab exists and information was successfully retrieved /// - `None` if the tab does not exist or could not be found /// /// # Example /// /// ```no_run /// use zellij_tile::prelude::*; /// /// // Query info for a specific tab /// let tab_id = 3; /// match get_tab_info(tab_id) { /// Some(info) => { /// println!("Tab name: {}", info.name); /// println!("Tab position: {}", info.position); /// println!("Tab is active: {}", info.active); /// println!("Tiled panes: {}", info.selectable_tiled_panes_count); /// }, /// None => println!("Tab not found"), /// } /// ``` pub fn get_tab_info(tab_id: usize) -> Option { let plugin_command = PluginCommand::GetTabInfo(tab_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_response = ProtobufGetTabInfoResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); protobuf_response .tab_info .and_then(|pb_tab_info| pb_tab_info.try_into().ok()) } /// Save the current session state to disk immediately. /// /// This triggers an immediate write of the current session metadata and layout /// to the session cache directory (~/.cache/zellij/contract_version_1/session_info//). /// /// # Returns /// /// - `Ok(())` if the save request was successfully sent /// - `Err(String)` if there was an error sending the request /// /// # Example /// /// ```no_run /// use zellij_tile::prelude::*; /// /// // Save the current session /// match save_session() { /// Ok(()) => println!("Session saved successfully"), /// Err(e) => eprintln!("Failed to save session: {}", e), /// } /// ``` pub fn save_session() -> Result<(), String> { let plugin_command = PluginCommand::SaveSession; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response: {:?}", e))?; let protobuf_response = ProtobufSaveSessionResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode response: {}", e))?; match protobuf_response.result { Some(save_session_response::Result::Success(_)) => Ok(()), Some(save_session_response::Result::Error(error)) => Err(error), None => Err("Server returned empty response".to_string()), } } /// Returns the elapsed time in milliseconds since the current session state was last saved to disk. /// /// Returns `None` if the session has never been saved during this session. /// The returned value is the number of milliseconds elapsed since the last save, not a Unix epoch timestamp. /// /// # Example /// /// ```no_run /// use zellij_tile::prelude::*; /// /// if let Some(elapsed_millis) = current_session_last_saved_time() { /// println!("Session was last saved {} ms ago", elapsed_millis); /// } else { /// println!("Session has not been saved yet"); /// } /// ``` pub fn current_session_last_saved_time() -> Option { let plugin_command = PluginCommand::CurrentSessionLastSavedTime; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_response = ProtobufCurrentSessionLastSavedTimeResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); protobuf_response.timestamp_millis } // Host Functions /// Open a file in the user's default `$EDITOR` in a new pane pub fn open_file(file_to_open: FileToOpen, context: BTreeMap) -> Option { let plugin_command = PluginCommand::OpenFile(file_to_open, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = match bytes_from_stdin() { Ok(bytes_from_stdin) => ProtobufOpenFileResponse::decode(bytes_from_stdin.as_slice()).ok(), Err(e) => { eprintln!("{}", e); None }, }; response.and_then(|r| OpenFileResponse::try_from(r).ok().flatten()) } /// Open a file in the user's default `$EDITOR` in a new floating pane pub fn open_file_floating( file_to_open: FileToOpen, coordinates: Option, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenFileFloating(file_to_open, coordinates, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenFileFloatingResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); OpenFileFloatingResponse::try_from(response).unwrap() } /// Open a file in the user's default `$EDITOR`, replacing the focused pane pub fn open_file_in_place( file_to_open: FileToOpen, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenFileInPlace(file_to_open, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenFileInPlaceResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); OpenFileInPlaceResponse::try_from(response).unwrap() } /// Open a file in the user's default `$EDITOR` in a new pane near th eplugin pub fn open_file_near_plugin( file_to_open: FileToOpen, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenFileNearPlugin(file_to_open, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenFileNearPluginResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); OpenFileNearPluginResponse::try_from(response).unwrap() } /// Open a file in the user's default `$EDITOR` in a new floating pane near the plugin pub fn open_file_floating_near_plugin( file_to_open: FileToOpen, coordinates: Option, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenFileFloatingNearPlugin(file_to_open, coordinates, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenFileFloatingNearPluginResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenFileFloatingNearPluginResponse::try_from(response).unwrap() } /// Open a file in the user's default `$EDITOR`, replacing the plugin pane pub fn open_file_in_place_of_plugin( file_to_open: FileToOpen, close_plugin_after_replace: bool, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenFileInPlaceOfPlugin(file_to_open, close_plugin_after_replace, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenFileInPlaceOfPluginResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenFileInPlaceOfPluginResponse::try_from(response).unwrap() } /// Open a new terminal pane to the specified location on the host filesystem pub fn open_terminal>(path: P) -> Option { let file_to_open = FileToOpen::new(path.as_ref().to_path_buf()); let plugin_command = PluginCommand::OpenTerminal(file_to_open); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenTerminalResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); OpenTerminalResponse::try_from(response).unwrap() } /// Open a new terminal pane to the specified location on the host filesystem /// This variant is identical to open_terminal, excpet it opens it near the plugin regardless of /// whether the user was focused on it or not pub fn open_terminal_near_plugin>(path: P) -> Option { let file_to_open = FileToOpen::new(path.as_ref().to_path_buf()); let plugin_command = PluginCommand::OpenTerminalNearPlugin(file_to_open); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenTerminalNearPluginResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenTerminalNearPluginResponse::try_from(response).unwrap() } /// Open a new floating terminal pane to the specified location on the host filesystem pub fn open_terminal_floating>( path: P, coordinates: Option, ) -> Option { let file_to_open = FileToOpen::new(path.as_ref().to_path_buf()); let plugin_command = PluginCommand::OpenTerminalFloating(file_to_open, coordinates); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenTerminalFloatingResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenTerminalFloatingResponse::try_from(response).unwrap() } /// Open a new floating terminal pane to the specified location on the host filesystem /// This variant is identical to open_terminal_floating, excpet it opens it near the plugin regardless of /// whether the user was focused on it or not pub fn open_terminal_floating_near_plugin>( path: P, coordinates: Option, ) -> Option { let file_to_open = FileToOpen::new(path.as_ref().to_path_buf()); let plugin_command = PluginCommand::OpenTerminalFloatingNearPlugin(file_to_open, coordinates); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenTerminalFloatingNearPluginResponse::decode( bytes_from_stdin().unwrap().as_slice(), ) .unwrap(); OpenTerminalFloatingNearPluginResponse::try_from(response).unwrap() } /// Open a new terminal pane to the specified location on the host filesystem, temporarily /// replacing the focused pane pub fn open_terminal_in_place>(path: P) -> Option { let file_to_open = FileToOpen::new(path.as_ref().to_path_buf()); let plugin_command = PluginCommand::OpenTerminalInPlace(file_to_open); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenTerminalInPlaceResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenTerminalInPlaceResponse::try_from(response).unwrap() } /// Open a new terminal pane to the specified location on the host filesystem, temporarily /// replacing the plugin pane pub fn open_terminal_in_place_of_plugin>( path: P, close_plugin_after_replace: bool, ) -> Option { let file_to_open = FileToOpen::new(path.as_ref().to_path_buf()); let plugin_command = PluginCommand::OpenTerminalInPlaceOfPlugin(file_to_open, close_plugin_after_replace); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenTerminalInPlaceOfPluginResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenTerminalInPlaceOfPluginResponse::try_from(response).unwrap() } /// Open a new command pane with the specified command and args (this sort of pane allows the user to control the command, re-run it and see its exit status through the Zellij UI). pub fn open_command_pane( command_to_run: CommandToRun, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPane(command_to_run, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); OpenCommandPaneResponse::try_from(response).unwrap() } /// Open a new command pane with the specified command and args (this sort of pane allows the user to control the command, re-run it and see its exit status through the Zellij UI). /// This variant is the same as `open_command_pane` except it opens the pane in the same tab as the /// plugin regardless of whether the user is focused on it pub fn open_command_pane_near_plugin( command_to_run: CommandToRun, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPaneNearPlugin(command_to_run, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneNearPluginResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenCommandPaneNearPluginResponse::try_from(response).unwrap() } /// Open a new floating command pane with the specified command and args (this sort of pane allows the user to control the command, re-run it and see its exit status through the Zellij UI). pub fn open_command_pane_floating( command_to_run: CommandToRun, coordinates: Option, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPaneFloating(command_to_run, coordinates, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneFloatingResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenCommandPaneFloatingResponse::try_from(response).unwrap() } /// Open a new floating command pane with the specified command and args (this sort of pane allows the user to control the command, re-run it and see its exit status through the Zellij UI). /// This variant is the same as `open_command_pane_floating` except it opens the pane in the same tab as the /// plugin regardless of whether the user is focused on it pub fn open_command_pane_floating_near_plugin( command_to_run: CommandToRun, coordinates: Option, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPaneFloatingNearPlugin(command_to_run, coordinates, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneFloatingNearPluginResponse::decode( bytes_from_stdin().unwrap().as_slice(), ) .unwrap(); OpenCommandPaneFloatingNearPluginResponse::try_from(response).unwrap() } /// Open a new in place command pane with the specified command and args (this sort of pane allows the user to control the command, re-run it and see its exit status through the Zellij UI). pub fn open_command_pane_in_place( command_to_run: CommandToRun, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPaneInPlace(command_to_run, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneInPlaceResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenCommandPaneInPlaceResponse::try_from(response).unwrap() } /// Open a new in place command pane with the specified command and args (this sort of pane allows the user to control the command, re-run it and see its exit status through the Zellij UI). /// This variant is the same as open_command_pane_in_place, except that it always replaces the /// plugin pane rather than whichever pane the user is focused on pub fn open_command_pane_in_place_of_plugin( command_to_run: CommandToRun, close_plugin_after_replace: bool, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPaneInPlaceOfPlugin( command_to_run, close_plugin_after_replace, context, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneInPlaceOfPluginResponse::decode( bytes_from_stdin().unwrap().as_slice(), ) .unwrap(); OpenCommandPaneInPlaceOfPluginResponse::try_from(response).unwrap() } /// Opens a command pane in place of the pane identified by `pane_id`. /// Unlike `open_command_pane_in_place`, this targets an arbitrary pane by ID rather than the /// focused pane, and does not change focus. If `close_replaced_pane` is false, the replaced /// pane is suppressed and restored when the new pane closes; if true, it is permanently closed. /// Returns the `PaneId` of the newly opened pane, or `None` if the operation failed. pub fn open_command_pane_in_place_of_pane_id( pane_id: PaneId, command_to_run: CommandToRun, close_replaced_pane: bool, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPaneInPlaceOfPaneId( pane_id, command_to_run, close_replaced_pane, context, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneInPlaceOfPaneIdResponse::decode( bytes_from_stdin().unwrap().as_slice(), ) .unwrap(); OpenCommandPaneInPlaceOfPaneIdResponse::try_from(response).unwrap() } /// Opens a terminal pane in place of the pane identified by `pane_id`. /// Unlike `open_terminal_in_place`, this targets an arbitrary pane by ID rather than the /// focused pane, and does not change focus. If `close_replaced_pane` is false, the replaced /// pane is suppressed and restored when the new pane closes; if true, it is permanently closed. /// `cwd` sets the working directory for the new terminal. Returns the `PaneId` of the newly /// opened pane, or `None` if the operation failed. pub fn open_terminal_pane_in_place_of_pane_id>( pane_id: PaneId, cwd: P, close_replaced_pane: bool, ) -> Option { let file_to_open = FileToOpen { path: cwd.as_ref().to_path_buf(), ..Default::default() }; let plugin_command = PluginCommand::OpenTerminalPaneInPlaceOfPaneId(pane_id, file_to_open, close_replaced_pane); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenTerminalPaneInPlaceOfPaneIdResponse::decode( bytes_from_stdin().unwrap().as_slice(), ) .unwrap(); OpenTerminalPaneInPlaceOfPaneIdResponse::try_from(response).unwrap() } /// Opens an editor pane in place of the pane identified by `pane_id`. /// Unlike `open_file_in_place`, this targets an arbitrary pane by ID rather than the /// focused pane, and does not change focus. If `close_replaced_pane` is false, the replaced /// pane is suppressed and restored when the new pane closes; if true, it is permanently closed. /// Returns the `PaneId` of the newly opened pane, or `None` if the operation failed. pub fn open_edit_pane_in_place_of_pane_id( pane_id: PaneId, file_to_open: FileToOpen, close_replaced_pane: bool, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenEditPaneInPlaceOfPaneId( pane_id, file_to_open, close_replaced_pane, context, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenEditPaneInPlaceOfPaneIdResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenEditPaneInPlaceOfPaneIdResponse::try_from(response).unwrap() } /// Open a new hidden (background) command pane with the specified command and args (this sort of pane allows the user to control the command, re-run it and see its exit status through the Zellij UI). pub fn open_command_pane_background( command_to_run: CommandToRun, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenCommandPaneBackground(command_to_run, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenCommandPaneBackgroundResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenCommandPaneBackgroundResponse::try_from(response).unwrap() } /// Change the focused tab to the specified index (corresponding with the default tab names, to starting at `1`, `0` will be considered as `1`). pub fn switch_tab_to(tab_idx: u32) { let plugin_command = PluginCommand::SwitchTabTo(tab_idx); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Set a timeout in seconds (or fractions thereof) after which the plugins [update](./plugin-api-events#update) method will be called with the [`Timer`](./plugin-api-events.md#timer) event. pub fn set_timeout(secs: f64) { let plugin_command = PluginCommand::SetTimeout(secs); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } #[doc(hidden)] pub fn exec_cmd(cmd: &[&str]) { let plugin_command = PluginCommand::ExecCmd(cmd.iter().cloned().map(|s| s.to_owned()).collect()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Run this command in the background on the host machine, optionally being notified of its output /// if subscribed to the `RunCommandResult` Event pub fn run_command(cmd: &[&str], context: BTreeMap) { let plugin_command = PluginCommand::RunCommand( cmd.iter().cloned().map(|s| s.to_owned()).collect(), BTreeMap::new(), PathBuf::from("."), context, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Run this command in the background on the host machine, providing environment variables and a /// cwd. Optionally being notified of its output if subscribed to the `RunCommandResult` Event pub fn run_command_with_env_variables_and_cwd( cmd: &[&str], env_variables: BTreeMap, cwd: PathBuf, context: BTreeMap, ) { let plugin_command = PluginCommand::RunCommand( cmd.iter().cloned().map(|s| s.to_owned()).collect(), env_variables, cwd, context, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Make a web request, optionally being notified of its output /// if subscribed to the `WebRequestResult` Event, the context will be returned verbatim in this /// event and can be used for eg. marking the request_id pub fn web_request>( url: S, verb: HttpVerb, headers: BTreeMap, body: Vec, context: BTreeMap, ) where S: ToString, { let plugin_command = PluginCommand::WebRequest(url.to_string(), verb, headers, body, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Hide the plugin pane (suppress it) from the UI pub fn hide_self() { let plugin_command = PluginCommand::HideSelf; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Hide the pane (suppress it) with the specified [PaneId] from the UI pub fn hide_pane_with_id(pane_id: PaneId) { let plugin_command = PluginCommand::HidePaneWithId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Show the plugin pane (unsuppress it if it is suppressed), focus it and switch to its tab pub fn show_self(should_float_if_hidden: bool) { let plugin_command = PluginCommand::ShowSelf(should_float_if_hidden); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Show the pane (unsuppress it if it is suppressed) with the specified [PaneId], focus it and switch to its tab pub fn show_pane_with_id(pane_id: PaneId, should_float_if_hidden: bool, should_focus_pane: bool) { let plugin_command = PluginCommand::ShowPaneWithId(pane_id, should_float_if_hidden, should_focus_pane); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Close this plugin pane pub fn close_self() { let plugin_command = PluginCommand::CloseSelf; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch to the specified Input Mode (eg. `Normal`, `Tab`, `Pane`) pub fn switch_to_input_mode(mode: &InputMode) { let plugin_command = PluginCommand::SwitchToMode(*mode); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Provide a stringified [`layout`](https://zellij.dev/documentation/layouts.html) to be applied to the current session. If the layout has multiple tabs, they will all be opened. pub fn new_tabs_with_layout(layout: &str) -> Vec { let plugin_command = PluginCommand::NewTabsWithLayout(layout.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufNewTabsResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); NewTabsResponse::try_from(response).unwrap() } /// Provide a LayoutInfo to be applied to the current session in a new tab. If the layout has multiple tabs, they will all be opened. pub fn new_tabs_with_layout_info>(layout_info: L) -> Vec { let plugin_command = PluginCommand::NewTabsWithLayoutInfo(layout_info.as_ref().clone()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufNewTabsResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); NewTabsResponse::try_from(response).unwrap() } /// Open a new tab with the default layout pub fn new_tab>(name: Option, cwd: Option) -> Option where S: ToString, { let name = name.map(|s| s.to_string()); let cwd = cwd.map(|s| s.to_string()); let plugin_command = PluginCommand::NewTab { name, cwd }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufNewTabResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); NewTabResponse::try_from(response).unwrap() } pub fn new_tab_unfocused>(name: Option, cwd: Option) -> Option where S: ToString, { let name = name.map(|s| s.to_string()); let cwd = cwd.map(|s| s.to_string()); let plugin_command = PluginCommand::NewTabUnfocused { name, cwd }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufNewTabUnfocusedResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); NewTabUnfocusedResponse::try_from(response).unwrap() } pub fn new_tiled_pane_in_tab(tab_position: usize) -> Option { let plugin_command = PluginCommand::NewTiledPaneInTab { tab_position }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufNewTiledPaneInTabResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); NewTiledPaneInTabResponse::try_from(response).unwrap() } /// Opens a new tab with a command pane running `command_to_run`. /// Returns `(tab_id, pane_id)` of the created tab and pane, or `None` if unavailable. pub fn open_command_pane_in_new_tab( command_to_run: CommandToRun, context: BTreeMap, ) -> (Option, Option) { let plugin_command = PluginCommand::OpenCommandPaneInNewTab(command_to_run, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenPaneInNewTabResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); let result = OpenPaneInNewTabResponse::try_from(response).unwrap(); (result.tab_id, result.pane_id) } /// Opens a new tab with a plugin pane loaded from `plugin_url`. /// `plugin_url` can be a path (`file:/path/to/plugin.wasm`) or a named alias. /// Returns `(tab_id, pane_id)` of the created tab and pane. pub fn open_plugin_pane_in_new_tab( plugin_url: impl ToString, configuration: BTreeMap, context: BTreeMap, ) -> (Option, Option) { let plugin_command = PluginCommand::OpenPluginPaneInNewTab { plugin_url: plugin_url.to_string(), configuration, context, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenPaneInNewTabResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); let result = OpenPaneInNewTabResponse::try_from(response).unwrap(); (result.tab_id, result.pane_id) } /// Open a new floating plugin pane with the specified plugin URL and configuration. /// Returns the pane ID of the newly created plugin pane, if successful. pub fn open_plugin_pane_floating( plugin_url: &str, configuration: BTreeMap, coordinates: Option, context: BTreeMap, ) -> Option { let plugin_command = PluginCommand::OpenPluginPaneFloating { plugin_url: plugin_url.to_owned(), configuration, floating_pane_coordinates: coordinates, context, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenPluginPaneFloatingResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); OpenPluginPaneFloatingResponse::try_from(response).unwrap() } /// Opens a new tab with an editor pane for `file_to_open`. /// Returns `(tab_id, pane_id)` of the created tab and pane. pub fn open_editor_pane_in_new_tab( file_to_open: FileToOpen, context: BTreeMap, ) -> (Option, Option) { let plugin_command = PluginCommand::OpenEditorPaneInNewTab(file_to_open, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufOpenPaneInNewTabResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); let result = OpenPaneInNewTabResponse::try_from(response).unwrap(); (result.tab_id, result.pane_id) } /// Change focus to the next tab or loop back to the first pub fn go_to_next_tab() { let plugin_command = PluginCommand::GoToNextTab; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change focus to the previous tab or loop back to the last pub fn go_to_previous_tab() { let plugin_command = PluginCommand::GoToPreviousTab; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn report_panic(info: &std::panic::PanicHookInfo) { let panic_payload = if let Some(s) = info.payload().downcast_ref::<&str>() { format!("{}", s) } else { format!("") }; let panic_stringified = format!("{}\n\r{:#?}", panic_payload, info).replace("\n", "\r\n"); let plugin_command = PluginCommand::ReportPanic(panic_stringified); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Either Increase or Decrease the size of the focused pane pub fn resize_focused_pane(resize: Resize) { let plugin_command = PluginCommand::Resize(resize); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Either Increase or Decrease the size of the focused pane in a specified direction (eg. `Left`, `Right`, `Up`, `Down`). pub fn resize_focused_pane_with_direction(resize: Resize, direction: Direction) { let resize_strategy = ResizeStrategy { resize, direction: Some(direction), invert_on_boundaries: false, }; let plugin_command = PluginCommand::ResizeWithDirection(resize_strategy); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change focus tot he next pane in chronological order pub fn focus_next_pane() { let plugin_command = PluginCommand::FocusNextPane; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change focus to the previous pane in chronological order pub fn focus_previous_pane() { let plugin_command = PluginCommand::FocusPreviousPane; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change focus to the previously focused pane pub fn focus_last_pane() { let plugin_command = PluginCommand::FocusLastPane; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change the focused pane in the specified direction pub fn move_focus(direction: Direction) { let plugin_command = PluginCommand::MoveFocus(direction); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change the focused pane in the specified direction, if the pane is on the edge of the screen, the next tab is focused (next if right edge, previous if left edge). pub fn move_focus_or_tab(direction: Direction) { let plugin_command = PluginCommand::MoveFocusOrTab(direction); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Detach the user from the active session pub fn detach() { let plugin_command = PluginCommand::Detach; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Edit the scrollback of the focused pane in the user's default `$EDITOR` pub fn edit_scrollback() { let plugin_command = PluginCommand::EditScrollback; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Write bytes to the `STDIN` of the focused pane pub fn write(bytes: Vec) { let plugin_command = PluginCommand::Write(bytes); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Write characters to the `STDIN` of the focused pane pub fn write_chars(chars: &str) { let plugin_command = PluginCommand::WriteChars(chars.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Copy arbitrary text to the user's clipboard /// /// Respects the user's configured clipboard destination (system clipboard or primary selection). /// Requires the WriteToClipboard permission. pub fn copy_to_clipboard(text: impl Into) { let plugin_command = PluginCommand::CopyToClipboard(text.into()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Focused the previously focused tab (regardless of the tab position) pub fn toggle_tab() { let plugin_command = PluginCommand::ToggleTab; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch the position of the focused pane with a different pane pub fn move_pane() { let plugin_command = PluginCommand::MovePane; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch the position of the focused pane with a different pane in the specified direction (eg. `Down`, `Up`, `Left`, `Right`). pub fn move_pane_with_direction(direction: Direction) { let plugin_command = PluginCommand::MovePaneWithDirection(direction); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Clear the scroll buffer of the focused pane pub fn clear_screen() { let plugin_command = PluginCommand::ClearScreen; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the focused pane up 1 line pub fn scroll_up() { let plugin_command = PluginCommand::ScrollUp; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the focused pane down 1 line pub fn scroll_down() { let plugin_command = PluginCommand::ScrollDown; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the focused pane all the way to the top of the scrollbuffer pub fn scroll_to_top() { let plugin_command = PluginCommand::ScrollToTop; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the focused pane all the way to the bottom of the scrollbuffer pub fn scroll_to_bottom() { let plugin_command = PluginCommand::ScrollToBottom; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the focused pane up one page pub fn page_scroll_up() { let plugin_command = PluginCommand::PageScrollUp; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the focused pane down one page pub fn page_scroll_down() { let plugin_command = PluginCommand::PageScrollDown; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Toggle the focused pane to be fullscreen or normal sized pub fn toggle_focus_fullscreen() { let plugin_command = PluginCommand::ToggleFocusFullscreen; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn toggle_focus_no_ui_fullscreen() { let plugin_command = PluginCommand::ToggleFocusNoUiFullscreen; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn focus_host_session() { let plugin_command = PluginCommand::FocusHostSession; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Toggle the UI pane frames on or off pub fn toggle_pane_frames() { let plugin_command = PluginCommand::TogglePaneFrames; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn set_pane_frame_style(pane_frame_style: PaneFrameStyle) { let plugin_command = PluginCommand::SetPaneFrameStyle(pane_frame_style); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Embed the currently focused pane (make it stop floating) or turn it to a float pane if it is not pub fn toggle_pane_embed_or_eject() { let plugin_command = PluginCommand::TogglePaneEmbedOrEject; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn undo_rename_pane() { let plugin_command = PluginCommand::UndoRenamePane; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Close the focused pane pub fn close_focus() { let plugin_command = PluginCommand::CloseFocus; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn new_pane() { let plugin_command = PluginCommand::NewPane; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn toggle_floating_panes(tab_id: Option) { let plugin_command = PluginCommand::ToggleFloatingPanes { tab_id }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Turn the `STDIN` synchronization of the current tab on or off pub fn toggle_active_tab_sync() { let plugin_command = PluginCommand::ToggleActiveTabSync; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Close the focused tab pub fn close_focused_tab() { let plugin_command = PluginCommand::CloseFocusedTab; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn undo_rename_tab() { let plugin_command = PluginCommand::UndoRenameTab; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Compeltely quit Zellij for this and all other connected clients pub fn quit_zellij() { let plugin_command = PluginCommand::QuitZellij; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change to the previous [swap layout](https://zellij.dev/documentation/swap-layouts.html) pub fn previous_swap_layout() { let plugin_command = PluginCommand::PreviousSwapLayout; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change to the next [swap layout](https://zellij.dev/documentation/swap-layouts.html) pub fn next_swap_layout() { let plugin_command = PluginCommand::NextSwapLayout; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change focus to the tab with the specified name pub fn go_to_tab_name(tab_name: &str) { let plugin_command = PluginCommand::GoToTabName(tab_name.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change focus to the tab with the specified name or create it if it does not exist pub fn focus_or_create_tab(tab_name: &str) -> Option { let plugin_command = PluginCommand::FocusOrCreateTab(tab_name.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufFocusOrCreateTabResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); FocusOrCreateTabResponse::try_from(response).unwrap() } pub fn go_to_tab(tab_index: u32) { let plugin_command = PluginCommand::GoToTab(tab_index); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn start_or_reload_plugin(url: &str) { let plugin_command = PluginCommand::StartOrReloadPlugin(url.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Closes a terminal pane with the specified id pub fn close_terminal_pane(terminal_pane_id: u32) { let plugin_command = PluginCommand::CloseTerminalPane(terminal_pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Closes a plugin pane with the specified id pub fn close_plugin_pane(plugin_pane_id: u32) { let plugin_command = PluginCommand::ClosePluginPane(plugin_pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Changes the focus to the terminal pane with the specified id, unsuppressing it if it was suppressed and switching to its tab and layer (eg. floating/tiled). pub fn focus_terminal_pane( terminal_pane_id: u32, should_float_if_hidden: bool, should_be_in_place_if_hidden: bool, ) { let plugin_command = PluginCommand::FocusTerminalPane( terminal_pane_id, should_float_if_hidden, should_be_in_place_if_hidden, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Changes the focus to the plugin pane with the specified id, unsuppressing it if it was suppressed and switching to its tab and layer (eg. floating/tiled). pub fn focus_plugin_pane( plugin_pane_id: u32, should_float_if_hidden: bool, should_be_in_place_if_hidden: bool, ) { let plugin_command = PluginCommand::FocusPluginPane( plugin_pane_id, should_float_if_hidden, should_be_in_place_if_hidden, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Changes the name (the title that appears in the UI) of the terminal pane with the specified id. pub fn rename_terminal_pane>(terminal_pane_id: u32, new_name: S) where S: ToString, { let plugin_command = PluginCommand::RenameTerminalPane(terminal_pane_id, new_name.to_string()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Changes the name (the title that appears in the UI) of the plugin pane with the specified id. pub fn rename_plugin_pane>(plugin_pane_id: u32, new_name: S) where S: ToString, { let plugin_command = PluginCommand::RenamePluginPane(plugin_pane_id, new_name.to_string()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Changes the name (the title that appears in the UI) of the tab with the specified position. pub fn rename_tab>(tab_position: u32, new_name: S) where S: ToString, { let plugin_command = PluginCommand::RenameTab(tab_position, new_name.to_string()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Changes the name (the title that appears in the UI) of the tab with the specified id. pub fn rename_tab_with_id>(tab_id: u64, new_name: S) where S: ToString, { let plugin_command = PluginCommand::RenameTabWithId(tab_id, new_name.to_string()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch to a session with the given name, create one if no name is given pub fn switch_session(name: Option<&str>) { let plugin_command = PluginCommand::SwitchSession(ConnectToSession { name: name.map(|n| n.to_string()), ..Default::default() }); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch to a session with the given name, create one if no name is given pub fn switch_session_with_layout(name: Option<&str>, layout: LayoutInfo, cwd: Option) { let plugin_command = PluginCommand::SwitchSession(ConnectToSession { name: name.map(|n| n.to_string()), layout: Some(layout), cwd, ..Default::default() }); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch to a session with the given name, create one if no name is given pub fn switch_session_with_cwd(name: Option<&str>, cwd: Option) { let plugin_command = PluginCommand::SwitchSession(ConnectToSession { name: name.map(|n| n.to_string()), cwd, ..Default::default() }); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch to a session with the given name, focusing either the provided pane_id or the provided /// tab position (in that order) pub fn switch_session_with_focus( name: &str, tab_position: Option, pane_id: Option<(u32, bool)>, ) { let plugin_command = PluginCommand::SwitchSession(ConnectToSession { name: Some(name.to_owned()), tab_position, pane_id, ..Default::default() }); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Permanently delete a resurrectable session with the given name. /// /// Returns `Ok(())` if the session's cache directory was removed; `Err(...)` /// if the underlying `remove_dir_all` failed (e.g. permissions, missing path). pub fn delete_dead_session(name: &str) -> Result<(), String> { let plugin_command = PluginCommand::DeleteDeadSessionAndReply(name.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin() .map_err(|e| format!("Failed to read DeleteDeadSession response: {}", e))?; let protobuf_response = ProtobufDeleteDeadSessionResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Malformed DeleteDeadSession response: {}", e))?; match protobuf_response.error { Some(err) => Err(err), None => Ok(()), } } /// Permanently delete all resurrectable sessions on this machine. /// /// Bounded by a host-side wedge timeout (matching the kill-all budget) so a /// pathological filesystem cannot freeze the calling plugin. pub fn delete_all_dead_sessions() -> Result<(), String> { let plugin_command = PluginCommand::DeleteAllDeadSessionsAndReply; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin() .map_err(|e| format!("Failed to read DeleteAllDeadSessions response: {}", e))?; let protobuf_response = ProtobufDeleteAllDeadSessionsResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Malformed DeleteAllDeadSessions response: {}", e))?; match protobuf_response.error { Some(err) => Err(err), None => Ok(()), } } /// Rename the current session pub fn rename_session(name: &str) { let plugin_command = PluginCommand::RenameSession(name.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Unblock the input side of a pipe, requesting the next message be sent if there is one pub fn unblock_cli_pipe_input(pipe_name: &str) { let plugin_command = PluginCommand::UnblockCliPipeInput(pipe_name.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Block the input side of a pipe, will only be released once this or another plugin unblocks it pub fn block_cli_pipe_input(pipe_name: &str) { let plugin_command = PluginCommand::BlockCliPipeInput(pipe_name.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Send output to the output side of a pipe, ths does not affect the input side of same pipe pub fn cli_pipe_output(pipe_name: &str, output: &str) { let plugin_command = PluginCommand::CliPipeOutput(pipe_name.to_owned(), output.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Send a message to a plugin, it will be launched if it is not already running pub fn pipe_message_to_plugin(message_to_plugin: MessageToPlugin) { let plugin_command = PluginCommand::MessageToPlugin(message_to_plugin); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Disconnect all other clients from the current session pub fn disconnect_other_clients() { let plugin_command = PluginCommand::DisconnectOtherClients; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Kill all Zellij sessions in the list. /// /// Waits for each peer session to acknowledge the kill (over its own IPC /// socket -- the server-side handler reads back the `Exit` message the peer /// sends as part of its shutdown, or a stream-close if the peer dies first). /// Returns once every kill has been confirmed or one has failed. A wedged /// peer is bounded by a short server-side wedge timeout. pub fn kill_sessions>(session_names: &[S]) -> Result<(), String> where S: ToString, { let plugin_command = PluginCommand::KillSessionsAndReply( session_names.into_iter().map(|s| s.to_string()).collect(), ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read KillSessions response: {}", e))?; let protobuf_response = ProtobufKillSessionsResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Malformed KillSessions response: {}", e))?; match protobuf_response.error { Some(err) => Err(err), None => Ok(()), } } /// List Windows volumes (drives and WSL distributions). /// Results are returned via the `FileSystemUpdate` event. /// This command is only supported on Windows and requires FullHdAccess permission. pub fn list_windows_volumes() { let plugin_command = PluginCommand::ListWindowsVolumes; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scan a specific folder in the host filesystem (this is a hack around some WASI runtime performance /// issues), will not follow symlinks pub fn scan_host_folder>(folder_to_scan: &S) { let plugin_command = PluginCommand::ScanHostFolder(folder_to_scan.as_ref().to_path_buf()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn set_soft_keyboard(on: bool) { let plugin_command = PluginCommand::SetSoftKeyboard(on); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn set_tab_fit(tab_id: usize, fit: Option<(PaneId, Size)>) { let plugin_command = PluginCommand::SetTabFit { tab_id, fit }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn exit_mobile_mode() { let plugin_command = PluginCommand::ExitMobileMode; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn set_shadow_focus(pane_id: PaneId) { let plugin_command = PluginCommand::SetShadowFocus(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Start watching the host folder for filesystem changes (Note: somewhat unstable at the time /// being) pub fn watch_filesystem() { let plugin_command = PluginCommand::WatchFilesystem; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Get the serialized session layout in KDL format synchronously /// note: this removes the requesting plugin from the dumped layout pub fn dump_session_layout() -> Result<(String, Option), String> { dump_session_layout_impl(None) } /// Get the serialized layout for a specific tab in KDL format synchronously /// note: this removes the requesting plugin from the dumped layout pub fn dump_session_layout_for_tab( tab_index: usize, ) -> Result<(String, Option), String> { dump_session_layout_impl(Some(tab_index)) } fn dump_session_layout_impl( tab_index: Option, ) -> Result<(String, Option), String> { let plugin_command = PluginCommand::DumpSessionLayout { tab_index }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; let protobuf_response = ProtobufDumpSessionLayoutResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Extract metadata if present let metadata = protobuf_response .metadata .and_then(|pb_metadata| pb_metadata.try_into().ok()); match protobuf_response.result { Some(dump_session_layout_response::Result::LayoutContent(content)) => { Ok((content, metadata)) }, Some(dump_session_layout_response::Result::Error(error)) => Err(error), None => Err("Server returned empty response".to_string()), } } /// Parses a KDL layout string and returns LayoutMetadata pub fn parse_layout(layout_string: &str) -> Result { let plugin_command = PluginCommand::ParseLayout(layout_string.to_string()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin().map_err(|_| LayoutParsingError::SyntaxError)?; let protobuf_response = ProtobufParseLayoutResponse::decode(response_bytes.as_slice()) .map_err(|_| LayoutParsingError::SyntaxError)?; match protobuf_response.result { Some(parse_layout_response::Result::Metadata(metadata)) => metadata .try_into() .map_err(|_| LayoutParsingError::SyntaxError), Some(parse_layout_response::Result::Error(error)) => Err(error .try_into() .map_err(|_| LayoutParsingError::SyntaxError)?), None => Err(LayoutParsingError::SyntaxError), } } /// Get a list of clients, their focused pane and running command or focused plugin back as an /// Event::ListClients (note: this event must be subscribed to) pub fn list_clients() { let plugin_command = PluginCommand::ListClients; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Change configuration for the current user pub fn reconfigure(new_config: String, save_configuration_file: bool) { let plugin_command = PluginCommand::Reconfigure(new_config, save_configuration_file); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Re-run command in pane pub fn rerun_command_pane(terminal_pane_id: u32) { let plugin_command = PluginCommand::RerunCommandPane(terminal_pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Sugar for close_terminal_pane and close_plugin_pane pub fn close_pane_with_id(pane_id: PaneId) { let plugin_command = match pane_id { PaneId::Terminal(terminal_pane_id) => PluginCommand::CloseTerminalPane(terminal_pane_id), PaneId::Plugin(plugin_pane_id) => PluginCommand::ClosePluginPane(plugin_pane_id), }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Resize the specified pane (increase/decrease) with an optional direction (left/right/up/down) pub fn resize_pane_with_id(resize_strategy: ResizeStrategy, pane_id: PaneId) { let plugin_command = PluginCommand::ResizePaneIdWithDirection(resize_strategy, pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Changes the focus to the pane with the specified id, unsuppressing it if it was suppressed and switching to its tab and layer (eg. floating/tiled). pub fn focus_pane_with_id( pane_id: PaneId, should_float_if_hidden: bool, should_be_in_place_if_hidden: bool, ) { let plugin_command = match pane_id { PaneId::Terminal(terminal_pane_id) => PluginCommand::FocusTerminalPane( terminal_pane_id, should_float_if_hidden, should_be_in_place_if_hidden, ), PaneId::Plugin(plugin_pane_id) => PluginCommand::FocusPluginPane( plugin_pane_id, should_float_if_hidden, should_be_in_place_if_hidden, ), }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Edit the scrollback of the specified pane in the user's default `$EDITOR` (currently only works /// for terminal panes) pub fn edit_scrollback_for_pane_with_id(pane_id: PaneId) { let plugin_command = PluginCommand::EditScrollbackForPaneWithId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Retrieves the scrollback contents from the specified pane /// /// # Arguments /// * `pane_id` - The ID of the pane to get scrollback from /// * `get_full_scrollback` - Whether to retrieve the full scrollback buffer (including lines above and below viewport) /// /// # Returns /// * `Ok(PaneContents)` - The pane contents if successful /// * `Err(String)` - An error message if the pane was not found, timed out, or another error occurred pub fn get_pane_scrollback( pane_id: PaneId, get_full_scrollback: bool, ) -> Result { let plugin_command = PluginCommand::GetPaneScrollback { pane_id, get_full_scrollback, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; // Read response from stdin let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; // Decode protobuf response let protobuf_response = ProtobufPaneScrollbackResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Convert to Rust type let response = PaneScrollbackResponse::try_from(protobuf_response) .map_err(|e| format!("Failed to convert protobuf response: {}", e))?; // Convert Result enum to actual Result type match response { PaneScrollbackResponse::Ok(contents) => Ok(contents), PaneScrollbackResponse::Err(error_msg) => Err(error_msg), } } /// Write bytes to the `STDIN` of the specified pane pub fn write_to_pane_id(bytes: Vec, pane_id: PaneId) { let plugin_command = PluginCommand::WriteToPaneId(bytes, pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Write characters to the `STDIN` of the specified pane pub fn write_chars_to_pane_id(chars: &str, pane_id: PaneId) { let plugin_command = PluginCommand::WriteCharsToPaneId(chars.to_owned(), pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Send SIGINT to the process running inside a terminal pane identified by this PaneId pub fn send_sigint_to_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::SendSigintToPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Send SIGKILL to the process running inside a terminal pane identified by this PaneId pub fn send_sigkill_to_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::SendSigkillToPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Get the PID of the process running inside a terminal pane pub fn get_pane_pid(pane_id: PaneId) -> Result { let plugin_command = PluginCommand::GetPanePid { pane_id }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; // Read response from stdin let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; // Decode protobuf response let protobuf_response = ProtobufGetPanePidResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Convert to Rust type let response = GetPanePidResponse::try_from(protobuf_response) .map_err(|e| format!("Failed to convert protobuf response: {}", e))?; // Convert Result enum to actual Result type match response { GetPanePidResponse::Ok(pid) => Ok(pid), GetPanePidResponse::Err(error_msg) => Err(error_msg), } } /// Gets the current running command for a specific pane by its ID. /// /// This queries the operating system for the **current** running command, /// not the initial command used to launch the pane. The command is returned /// as a vector of strings (argv-style), where the first element is the /// executable and subsequent elements are arguments. /// /// # Arguments /// * `pane_id` - The ID of the pane to query /// /// # Returns /// * `Ok(Vec)` - The command and arguments as separate strings /// * `Err(String)` - Error message if: /// - Pane is a plugin (only terminal panes have commands) /// - Pane doesn't exist /// - OS query failed /// /// # Permissions Required /// * `ReadApplicationState` /// /// # Example /// ```no_run /// use zellij_tile::prelude::*; /// /// let pane_id = PaneId::Terminal(1); /// match get_pane_running_command(pane_id) { /// Ok(cmd) => eprintln!("Running: {} {}", cmd[0], cmd[1..].join(" ")), /// Err(e) => eprintln!("Error: {}", e), /// } /// ``` pub fn get_pane_running_command(pane_id: PaneId) -> Result, String> { let plugin_command = PluginCommand::GetPaneRunningCommand { pane_id }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_response = ProtobufGetPaneRunningCommandResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); match protobuf_response.result { Some(get_pane_running_command_response::Result::Command(cmd)) => Ok(cmd.args), Some(get_pane_running_command_response::Result::Error(err)) => Err(err), None => Err("Empty response from server".to_string()), } } /// Fetches a fresh snapshot of all live and resurrectable sessions on this machine. /// /// # Permissions Required /// * `ReadApplicationState` pub fn get_session_list() -> Result { let plugin_command = PluginCommand::GetSessionList; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_response = ProtobufGetSessionListResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); match protobuf_response.result { Some(get_session_list_response::Result::Snapshot(snapshot)) => { let mut live_sessions = Vec::new(); for manifest in snapshot.live_sessions { match SessionInfo::try_from(manifest) { Ok(si) => live_sessions.push(si), Err(e) => return Err(format!("Malformed session manifest: {}", e)), } } let resurrectable_sessions = snapshot .resurrectable_sessions .into_iter() .map(<(String, std::time::Duration)>::from) .collect(); Ok(SessionListSnapshot { live_sessions, resurrectable_sessions, }) }, Some(get_session_list_response::Result::Error(err)) => Err(err), None => Err("Empty response from server".to_string()), } } /// Gets the current working directory for a specific pane by its ID. /// /// This queries the operating system for the **current** working directory /// of the process running in the pane. The CWD may change as the user /// navigates directories within the terminal. /// /// # Arguments /// * `pane_id` - The ID of the pane to query /// /// # Returns /// * `Ok(PathBuf)` - The current working directory /// * `Err(String)` - Error message if: /// - Pane is a plugin (only terminal panes have CWDs) /// - Pane doesn't exist /// - OS query failed (process may have exited) /// - CWD is inaccessible (permissions, deleted directory) /// /// # Permissions Required /// * `ReadApplicationState` /// /// # Example /// ```no_run /// use zellij_tile::prelude::*; /// /// let pane_id = PaneId::Terminal(1); /// match get_pane_cwd(pane_id) { /// Ok(cwd) => eprintln!("CWD: {}", cwd.display()), /// Err(e) => eprintln!("Error: {}", e), /// } /// ``` pub fn get_pane_cwd(pane_id: PaneId) -> Result { let plugin_command = PluginCommand::GetPaneCwd { pane_id }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let protobuf_response = ProtobufGetPaneCwdResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); match protobuf_response.result { Some(get_pane_cwd_response::Result::Cwd(cwd_str)) => Ok(PathBuf::from(cwd_str)), Some(get_pane_cwd_response::Result::Error(err)) => Err(err), None => Err("Empty response from server".to_string()), } } /// Save a layout to the user's layout directory /// /// # Arguments /// * `layout_name` - Name of the layout file (without .kdl extension) /// * `layout_kdl` - KDL string representing the layout /// * `overwrite` - Whether to overwrite if the file already exists /// /// # Returns /// * `Ok(())` - Layout was successfully validated and saved /// * `Err(String)` - Error message (parse error, I/O error, file exists, etc.) pub fn save_layout>( layout_name: S, layout_kdl: S, overwrite: bool, ) -> Result<(), String> { let plugin_command = PluginCommand::SaveLayout { layout_name: layout_name.as_ref().to_owned(), layout_kdl: layout_kdl.as_ref().to_owned(), overwrite, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; // Read response from stdin let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; // Decode protobuf response let protobuf_response = ProtobufSaveLayoutResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Convert to Rust type let response = SaveLayoutResponse::try_from(protobuf_response) .map_err(|e| format!("Failed to convert protobuf response: {}", e))?; // Convert Result enum to actual Result type match response { SaveLayoutResponse::Ok(_) => Ok(()), SaveLayoutResponse::Err(error_msg) => Err(error_msg), } } /// Delete a layout from the user's layout directory. /// /// # Arguments /// /// * `layout_name` - The name of the layout file to delete (without the `.kdl` extension). /// Layout names are sanitized server-side to prevent directory traversal. /// /// # Returns /// /// * `Ok(())` - The layout was successfully deleted /// * `Err(String)` - An error occurred with a descriptive message (e.g., file not found, permission denied) /// /// # Permissions /// /// Requires the `ChangeApplicationState` permission. /// /// # Examples /// /// ```no_run /// use zellij_tile::prelude::*; /// /// // Delete a layout named "my-layout" /// match delete_layout("my-layout") { /// Ok(_) => eprintln!("Layout deleted successfully"), /// Err(e) => eprintln!("Failed to delete layout: {}", e), /// } /// ``` pub fn delete_layout>(layout_name: S) -> Result<(), String> { let plugin_command = PluginCommand::DeleteLayout { layout_name: layout_name.as_ref().to_owned(), }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; // Read response from stdin let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; // Decode protobuf response let protobuf_response = ProtobufDeleteLayoutResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Convert to Rust type let response = DeleteLayoutResponse::try_from(protobuf_response) .map_err(|e| format!("Failed to convert protobuf response: {}", e))?; // Convert Result enum to actual Result type match response { DeleteLayoutResponse::Ok(_) => Ok(()), DeleteLayoutResponse::Err(error_msg) => Err(error_msg), } } /// Rename a layout file in the user's layout directory /// /// # Arguments /// * `old_layout_name` - Current name of the layout (without .kdl extension) /// * `new_layout_name` - New name for the layout (without .kdl extension) /// /// # Returns /// * `Ok(())` - Layout was successfully renamed /// * `Err(String)` - Error message describing what went wrong /// /// # Error Cases /// * Old layout name is invalid (empty, contains path separators, etc.) /// * New layout name is invalid /// * Source layout file doesn't exist /// * Target layout file already exists (no overwrite) /// * Layout directory not found /// * File system error during rename operation /// /// # Permissions /// /// Requires the `ChangeApplicationState` permission. /// /// # Examples /// /// ```no_run /// use zellij_tile::prelude::*; /// /// // Rename a layout from "old-name" to "new-name" /// match rename_layout("old-name", "new-name") { /// Ok(_) => eprintln!("Layout renamed successfully"), /// Err(e) => eprintln!("Failed to rename layout: {}", e), /// } /// ``` pub fn rename_layout( old_layout_name: impl Into, new_layout_name: impl Into, ) -> Result<(), String> { let plugin_command = PluginCommand::RenameLayout { old_layout_name: old_layout_name.into(), new_layout_name: new_layout_name.into(), }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; // Read response from stdin let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; // Decode protobuf response let protobuf_response = ProtobufRenameLayoutResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Convert to native response type let response: RenameLayoutResponse = protobuf_response .try_into() .map_err(|e| format!("Failed to convert protobuf response: {}", e))?; match response { RenameLayoutResponse::Ok(_) => Ok(()), RenameLayoutResponse::Err(error_msg) => Err(error_msg), } } /// Opens a layout file in the user's default `$EDITOR` pub fn edit_layout>( layout_name: S, context: BTreeMap, ) -> Result<(), String> { let layout_name = layout_name.as_ref().to_owned(); let plugin_command = PluginCommand::EditLayout { layout_name, context, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; // Read response from stdin let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response from stdin: {:?}", e))?; // Decode protobuf response let protobuf_response = ProtobufEditLayoutResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode protobuf response: {}", e))?; // Convert to Rust type let response = EditLayoutResponse::try_from(protobuf_response) .map_err(|e| format!("Failed to convert protobuf response: {}", e))?; // Convert Result enum to actual Result type match response { EditLayoutResponse::Ok(_) => Ok(()), EditLayoutResponse::Err(error_msg) => Err(error_msg), } } /// Switch the position of the pane with this id with a different pane pub fn move_pane_with_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::MovePaneWithPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Switch the position of the pane with this id with a different pane in the specified direction (eg. `Down`, `Up`, `Left`, `Right`). pub fn move_pane_with_pane_id_in_direction(pane_id: PaneId, direction: Direction) { let plugin_command = PluginCommand::MovePaneWithPaneIdInDirection(pane_id, direction); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Clear the scroll buffer of the specified pane pub fn clear_screen_for_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::ClearScreenForPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the specified pane up 1 line pub fn scroll_up_in_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::ScrollUpInPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the specified pane down 1 line pub fn scroll_down_in_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::ScrollDownInPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the specified pane all the way to the top of the scrollbuffer pub fn scroll_to_top_in_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::ScrollToTopInPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the specified pane all the way to the bottom of the scrollbuffer pub fn scroll_to_bottom_in_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::ScrollToBottomInPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the specified pane up one page pub fn page_scroll_up_in_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::PageScrollUpInPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Scroll the specified pane down one page pub fn page_scroll_down_in_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::PageScrollDownInPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Toggle the specified pane to be fullscreen or normal sized pub fn toggle_pane_id_fullscreen(pane_id: PaneId) { let plugin_command = PluginCommand::TogglePaneIdFullscreen(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Embed the specified pane (make it stop floating) or turn it to a float pane if it is not pub fn toggle_pane_embed_or_eject_for_pane_id(pane_id: PaneId) { let plugin_command = PluginCommand::TogglePaneEmbedOrEjectForPaneId(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Close the focused tab pub fn close_tab_with_index(tab_index: usize) { let plugin_command = PluginCommand::CloseTabWithIndex(tab_index); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Close the tab with the given stable ID. /// /// Unlike `close_tab_with_index`, this function identifies the tab by its stable /// `tab_id` rather than its display position, which may change as tabs are moved /// or closed. The tab_id can be obtained from `TabInfo.tab_id`. pub fn close_tab_with_id(tab_id: u64) { let plugin_command = PluginCommand::CloseTabWithId(tab_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Rename the specified pane pub fn rename_pane_with_id>(pane_id: PaneId, new_name: S) where S: ToString, { let plugin_command = match pane_id { PaneId::Terminal(terminal_pane_id) => { PluginCommand::RenameTerminalPane(terminal_pane_id, new_name.to_string()) }, PaneId::Plugin(plugin_pane_id) => { PluginCommand::RenamePluginPane(plugin_pane_id, new_name.to_string()) }, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Create a new tab that includes the specified pane ids pub fn break_panes_to_new_tab( pane_ids: &[PaneId], new_tab_name: Option, should_change_focus_to_new_tab: bool, ) -> Option { let plugin_command = PluginCommand::BreakPanesToNewTab( pane_ids.to_vec(), new_tab_name, should_change_focus_to_new_tab, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufBreakPanesToNewTabResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); BreakPanesToNewTabResponse::try_from(response).unwrap() } /// Move the pane ids to the tab with the specified index pub fn break_panes_to_tab_with_index( pane_ids: &[PaneId], tab_index: usize, should_change_focus_to_new_tab: bool, ) -> Option { let plugin_command = PluginCommand::BreakPanesToTabWithIndex( pane_ids.to_vec(), tab_index, should_change_focus_to_new_tab, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufBreakPanesToTabWithIndexResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); BreakPanesToTabWithIndexResponse::try_from(response).unwrap() } /// Move the pane ids to the tab with the specified id pub fn break_panes_to_tab_with_id( pane_ids: &[PaneId], tab_id: usize, should_change_focus_to_target_tab: bool, ) -> Option { let plugin_command = PluginCommand::BreakPanesToTabWithId( pane_ids.to_vec(), tab_id as u64, should_change_focus_to_target_tab, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response = ProtobufBreakPanesToTabWithIdResponse::decode(bytes_from_stdin().unwrap().as_slice()) .unwrap(); BreakPanesToTabWithIdResponse::try_from(response).unwrap() } /// Reload an already-running in this session, optionally skipping the cache pub fn reload_plugin_with_id(plugin_id: u32) { let plugin_command = PluginCommand::ReloadPlugin(plugin_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Reload an already-running in this session, optionally skipping the cache pub fn load_new_plugin>( url: S, config: BTreeMap, load_in_background: bool, skip_plugin_cache: bool, ) where S: ToString, { let plugin_command = PluginCommand::LoadNewPlugin { url: url.to_string(), config, load_in_background, skip_plugin_cache, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Rebind keys for the current user pub fn rebind_keys( keys_to_unbind: Vec<(InputMode, KeyWithModifier)>, keys_to_rebind: Vec<(InputMode, KeyWithModifier, Vec)>, write_config_to_disk: bool, ) { let plugin_command = PluginCommand::RebindKeys { keys_to_rebind, keys_to_unbind, write_config_to_disk, }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn change_host_folder(new_host_folder: PathBuf) { let plugin_command = PluginCommand::ChangeHostFolder(new_host_folder); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn set_floating_pane_pinned(pane_id: PaneId, should_be_pinned: bool) { let plugin_command = PluginCommand::SetFloatingPanePinned(pane_id, should_be_pinned); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn stack_panes(pane_ids: Vec) { let plugin_command = PluginCommand::StackPanes(pane_ids); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn change_floating_panes_coordinates( pane_ids_and_coordinates: Vec<(PaneId, FloatingPaneCoordinates)>, ) { let plugin_command = PluginCommand::ChangeFloatingPanesCoordinates(pane_ids_and_coordinates); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Toggle the borderless state of a pane identified by pane_id /// /// # Arguments /// * `pane_id` - The ID of the pane to toggle (PaneId::Terminal or PaneId::Plugin) pub fn toggle_pane_borderless(pane_id: PaneId) { let plugin_command = PluginCommand::TogglePaneBorderless(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Set the borderless state of a pane explicitly /// /// # Arguments /// * `pane_id` - The ID of the pane (PaneId::Terminal or PaneId::Plugin) /// * `borderless` - true for borderless, false for bordered pub fn set_pane_borderless(pane_id: PaneId, borderless: bool) { let plugin_command = PluginCommand::SetPaneBorderless(pane_id, borderless); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Set the default foreground and/or background color of a pane /// /// # Arguments /// * `pane_id` - The ID of the pane (PaneId::Terminal or PaneId::Plugin) /// * `fg` - Optional foreground color string (e.g. "#00e000"), None to leave unchanged /// * `bg` - Optional background color string (e.g. "#001a3a"), None to leave unchanged pub fn set_pane_color(pane_id: PaneId, fg: Option, bg: Option) { let plugin_command = PluginCommand::SetPaneColor(pane_id, fg, bg); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn start_web_server() { let plugin_command = PluginCommand::StartWebServer; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn stop_web_server() { let plugin_command = PluginCommand::StopWebServer; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn query_web_server_status() { let plugin_command = PluginCommand::QueryWebServerStatus; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn share_current_session() { let plugin_command = PluginCommand::ShareCurrentSession; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn stop_sharing_current_session() { let plugin_command = PluginCommand::StopSharingCurrentSession; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn group_and_ungroup_panes( pane_ids_to_group: Vec, pane_ids_to_ungroup: Vec, for_all_clients: bool, ) { let plugin_command = PluginCommand::GroupAndUngroupPanes( pane_ids_to_group, pane_ids_to_ungroup, for_all_clients, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn highlight_and_unhighlight_panes( pane_ids_to_highlight: Vec, pane_ids_to_unhighlight: Vec, ) { let plugin_command = PluginCommand::HighlightAndUnhighlightPanes(pane_ids_to_highlight, pane_ids_to_unhighlight); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn close_multiple_panes(pane_ids: Vec) { let plugin_command = PluginCommand::CloseMultiplePanes(pane_ids); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn float_multiple_panes(pane_ids: Vec) { let plugin_command = PluginCommand::FloatMultiplePanes(pane_ids); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn embed_multiple_panes(pane_ids: Vec) { let plugin_command = PluginCommand::EmbedMultiplePanes(pane_ids); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn set_self_mouse_selection_support(selection_support: bool) { let plugin_command = PluginCommand::SetSelfMouseSelectionSupport(selection_support); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn generate_web_login_token( token_label: Option, read_only: bool, ) -> Result { let plugin_command = PluginCommand::GenerateWebLoginToken(token_label, read_only); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let create_token_response = CreateTokenResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); if let Some(error) = create_token_response.error { Err(error) } else if let Some(token) = create_token_response.token { Ok(token) } else { Err("Received empty response".to_owned()) } } pub fn revoke_web_login_token(token_label: &str) -> Result<(), String> { let plugin_command = PluginCommand::RevokeWebLoginToken(token_label.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let revoke_token_response = RevokeTokenResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); if let Some(error) = revoke_token_response.error { Err(error) } else { Ok(()) } } pub fn list_web_login_tokens() -> Result, String> { // (name, created_at, read_only) let plugin_command = PluginCommand::ListWebLoginTokens; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let list_tokens_response = ListTokensResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); if let Some(error) = list_tokens_response.error { Err(error) } else { let tokens_with_info = list_tokens_response .tokens .iter() .zip(list_tokens_response.creation_times.iter()) .zip(list_tokens_response.read_only_flags.iter()) .map(|((name, created_at), read_only)| (name.clone(), created_at.clone(), *read_only)) .collect(); Ok(tokens_with_info) } } pub fn revoke_all_web_tokens() -> Result<(), String> { let plugin_command = PluginCommand::RevokeAllWebLoginTokens; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let revoke_all_web_tokens_response = RevokeAllWebTokensResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); if let Some(error) = revoke_all_web_tokens_response.error { Err(error) } else { Ok(()) } } pub fn rename_web_token(old_name: &str, new_name: &str) -> Result<(), String> { let plugin_command = PluginCommand::RenameWebLoginToken(old_name.to_owned(), new_name.to_owned()); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let rename_web_token_response = RenameWebTokenResponse::decode(bytes_from_stdin().unwrap().as_slice()).unwrap(); if let Some(error) = rename_web_token_response.error { Err(error) } else { Ok(()) } } pub fn intercept_key_presses() { let plugin_command = PluginCommand::InterceptKeyPresses; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn clear_key_presses_intercepts() { let plugin_command = PluginCommand::ClearKeyPressesIntercepts; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn replace_pane_with_existing_pane( pane_id_to_replace: PaneId, existing_pane_id: PaneId, suppress_replaced_pane: bool, ) { let plugin_command = PluginCommand::ReplacePaneWithExistingPane( pane_id_to_replace, existing_pane_id, suppress_replaced_pane, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } // Utility Functions #[allow(unused)] /// Returns the `TabInfo` corresponding to the currently active tab pub fn get_focused_tab(tab_infos: &Vec) -> Option { for tab_info in tab_infos { if tab_info.active { return Some(tab_info.clone()); } } return None; } #[allow(unused)] /// Returns the `PaneInfo` corresponding to the currently active pane (ignoring plugins) pub fn get_focused_pane(tab_position: usize, pane_manifest: &PaneManifest) -> Option { let panes = pane_manifest.panes.get(&tab_position); if let Some(panes) = panes { for pane in panes { if pane.is_focused & !pane.is_plugin { return Some(pane.clone()); } } } None } pub fn override_layout>( layout_info: L, retain_existing_terminal_panes: bool, retain_existing_plugin_panes: bool, apply_only_to_active_tab: bool, context: BTreeMap, ) { let plugin_command = PluginCommand::OverrideLayout( layout_info.as_ref().clone(), retain_existing_terminal_panes, retain_existing_plugin_panes, apply_only_to_active_tab, context, ); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } // Internal Functions #[doc(hidden)] pub fn object_from_stdin() -> Result { let err_context = || "failed to deserialize object from stdin".to_string(); let mut json = String::new(); io::stdin().read_line(&mut json).with_context(err_context)?; serde_json::from_str(&json).with_context(err_context) } #[doc(hidden)] pub fn bytes_from_stdin() -> Result> { let err_context = || "failed to deserialize bytes from stdin".to_string(); let mut json = String::new(); io::stdin().read_line(&mut json).with_context(err_context)?; serde_json::from_str(&json).with_context(err_context) } #[doc(hidden)] pub fn object_to_stdout(object: &impl Serialize) { // TODO: no crashy println!("{}", serde_json::to_string(object).unwrap()); } /// Post a message to a worker of this plugin, for more information please see [Plugin Workers](https://zellij.dev/documentation/plugin-api-workers.md) pub fn post_message_to(plugin_message: PluginMessage) { let plugin_command = PluginCommand::PostMessageTo(plugin_message); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Post a message to this plugin, for more information please see [Plugin Workers](https://zellij.dev/documentation/plugin-api-workers.md) pub fn post_message_to_plugin(plugin_message: PluginMessage) { let plugin_command = PluginCommand::PostMessageToPlugin(plugin_message); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } pub fn run_action(action: Action, context: BTreeMap) { // TODO: also accept reference let plugin_command = PluginCommand::RunAction(action, context); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Show all floating panes in the specified tab, or the active tab if `tab_id` is `None`. /// /// Blocks until the server-side action is complete. /// /// Returns `Ok(true)` if the floating panes were made visible (state changed), /// `Ok(false)` if the floating panes were already visible (no change), /// or `Err(String)` if the specified tab was not found. pub fn show_floating_panes(tab_id: Option) -> Result { let plugin_command = PluginCommand::ShowFloatingPanes { tab_id }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response: {:?}", e))?; let response = ProtobufShowFloatingPanesResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode response: {}", e))?; match response.result { Some(show_floating_panes_response::Result::Success(changed)) => Ok(changed), Some(show_floating_panes_response::Result::Error(e)) => Err(e), None => Err("Empty response".to_string()), } } /// Hide all floating panes in the specified tab, or the active tab if `tab_id` is `None`. /// /// Blocks until the server-side action is complete. /// /// Returns `Ok(true)` if the floating panes were hidden (state changed), /// `Ok(false)` if the floating panes were already hidden (no change), /// or `Err(String)` if the specified tab was not found. pub fn hide_floating_panes(tab_id: Option) -> Result { let plugin_command = PluginCommand::HideFloatingPanes { tab_id }; let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; let response_bytes = bytes_from_stdin().map_err(|e| format!("Failed to read response: {:?}", e))?; let response = ProtobufHideFloatingPanesResponse::decode(response_bytes.as_slice()) .map_err(|e| format!("Failed to decode response: {}", e))?; match response.result { Some(hide_floating_panes_response::Result::Success(changed)) => Ok(changed), Some(hide_floating_panes_response::Result::Error(e)) => Err(e), None => Err("Empty response".to_string()), } } /// Set or update regex-based content highlights for a pane. /// /// Each entry in `highlights` is keyed by its `pattern` string. Calling this /// function again with the same pattern updates its style; new patterns are /// added; patterns not present in this call are kept. To remove all highlights /// for this plugin on the pane, use `clear_pane_highlights`. /// /// Pattern matching is performed by the server against the current viewport at /// render time. The plugin never handles coordinates, so there is no race /// condition between content changes and highlight application. /// /// When `on_hover` is `true` and `tooltip_text` is `Some(...)`, the tooltip /// text is displayed at the bottom of the pane frame (formatted as /// `" Alt - {tooltip_text} "`) whenever the mouse cursor hovers over /// the highlighted region. /// /// Requires `ChangeApplicationState` permission. pub fn set_pane_regex_highlights(pane_id: PaneId, highlights: Vec) { let plugin_command = PluginCommand::SetPaneRegexHighlights(pane_id, highlights); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } /// Remove all regex highlights this plugin has set on the given pane. /// /// Other plugins' highlights on the same pane are not affected. /// /// Requires `ChangeApplicationState` permission. pub fn clear_pane_highlights(pane_id: PaneId) { let plugin_command = PluginCommand::ClearPaneHighlights(pane_id); let protobuf_plugin_command: ProtobufPluginCommand = plugin_command.try_into().unwrap(); object_to_stdout(&protobuf_plugin_command.encode_to_vec()); unsafe { host_run_plugin_command() }; } #[cfg(target_arch = "wasm32")] #[link(wasm_import_module = "zellij")] extern "C" { fn host_run_plugin_command(); } #[cfg(not(target_arch = "wasm32"))] unsafe fn host_run_plugin_command() {}