#![allow(unused)] use std::any::{type_name, Any}; use std::cell::{self, RefCell}; use std::env; use std::fs::File; use std::io::Read; use std::ops::{Deref, DerefMut}; use std::os::fd::{AsRawFd, FromRawFd}; use std::panic::Location; use std::{ path::{Path, PathBuf}, process::Command, rc::Rc, sync::Arc, time::Duration, }; use anyhow::anyhow; use ashpd::desktop::file_chooser::{OpenFileRequest, SaveFileRequest}; use async_task::Runnable; use calloop::channel::Channel; use calloop::{EventLoop, LoopHandle, LoopSignal}; use copypasta::ClipboardProvider; use filedescriptor::FileDescriptor; use flume::{Receiver, Sender}; use futures::channel::oneshot; use parking_lot::Mutex; use time::UtcOffset; use wayland_client::Connection; use wayland_protocols::wp::cursor_shape::v1::client::wp_cursor_shape_device_v1::Shape; use xkbcommon::xkb::{self, Keycode, Keysym, State}; use crate::platform::linux::wayland::WaylandClient; use crate::{ px, Action, AnyWindowHandle, BackgroundExecutor, ClipboardItem, CosmicTextSystem, CursorStyle, DisplayId, ForegroundExecutor, Keymap, Keystroke, LinuxDispatcher, Menu, Modifiers, PathPromptOptions, Pixels, Platform, PlatformDisplay, PlatformInputHandler, PlatformTextSystem, PlatformWindow, Point, PromptLevel, Result, SemanticVersion, Size, Task, WindowAppearance, WindowOptions, WindowParams, }; use super::x11::X11Client; pub(crate) const SCROLL_LINES: f64 = 3.0; // Values match the defaults on GTK. // Taken from https://github.com/GNOME/gtk/blob/main/gtk/gtksettings.c#L320 pub(crate) const DOUBLE_CLICK_INTERVAL: Duration = Duration::from_millis(400); pub(crate) const DOUBLE_CLICK_DISTANCE: Pixels = px(5.0); pub(crate) const KEYRING_LABEL: &str = "zed-github-account"; pub trait LinuxClient { fn with_common(&self, f: impl FnOnce(&mut LinuxCommon) -> R) -> R; fn displays(&self) -> Vec>; fn primary_display(&self) -> Option>; fn display(&self, id: DisplayId) -> Option>; fn open_window( &self, handle: AnyWindowHandle, options: WindowParams, ) -> Box; fn set_cursor_style(&self, style: CursorStyle); fn open_uri(&self, uri: &str); fn write_to_primary(&self, item: ClipboardItem); fn write_to_clipboard(&self, item: ClipboardItem); fn read_from_primary(&self) -> Option; fn read_from_clipboard(&self) -> Option; fn run(&self); } #[derive(Default)] pub(crate) struct PlatformHandlers { pub(crate) open_urls: Option)>>, pub(crate) quit: Option>, pub(crate) reopen: Option>, pub(crate) app_menu_action: Option>, pub(crate) will_open_app_menu: Option>, pub(crate) validate_app_menu_command: Option bool>>, } pub(crate) struct LinuxCommon { pub(crate) background_executor: BackgroundExecutor, pub(crate) foreground_executor: ForegroundExecutor, pub(crate) text_system: Arc, pub(crate) callbacks: PlatformHandlers, pub(crate) signal: LoopSignal, } impl LinuxCommon { pub fn new(signal: LoopSignal) -> (Self, Channel) { let (main_sender, main_receiver) = calloop::channel::channel::(); let text_system = Arc::new(CosmicTextSystem::new()); let callbacks = PlatformHandlers::default(); let dispatcher = Arc::new(LinuxDispatcher::new(main_sender)); let common = LinuxCommon { background_executor: BackgroundExecutor::new(dispatcher.clone()), foreground_executor: ForegroundExecutor::new(dispatcher.clone()), text_system, callbacks, signal, }; (common, main_receiver) } } impl Platform for P { fn background_executor(&self) -> BackgroundExecutor { self.with_common(|common| common.background_executor.clone()) } fn foreground_executor(&self) -> ForegroundExecutor { self.with_common(|common| common.foreground_executor.clone()) } fn text_system(&self) -> Arc { self.with_common(|common| common.text_system.clone()) } fn run(&self, on_finish_launching: Box) { on_finish_launching(); LinuxClient::run(self); self.with_common(|common| { if let Some(mut fun) = common.callbacks.quit.take() { fun(); } }); } fn quit(&self) { self.with_common(|common| common.signal.stop()); } fn restart(&self, binary_path: Option) { use std::os::unix::process::CommandExt as _; // get the process id of the current process let app_pid = std::process::id().to_string(); // get the path to the executable let app_path = if let Some(path) = binary_path { path } else { match self.app_path() { Ok(path) => path, Err(err) => { log::error!("Failed to get app path: {:?}", err); return; } } }; log::info!("Restarting process, using app path: {:?}", app_path); // Script to wait for the current process to exit and then restart the app. // We also wait for possibly open TCP sockets by the process to be closed, // since on Linux it's not guaranteed that a process' resources have been // cleaned up when `kill -0` returns. let script = format!( r#" while kill -O {pid} 2>/dev/null; do sleep 0.1 done while lsof -nP -iTCP -a -p {pid} 2>/dev/null; do sleep 0.1 done {app_path} "#, pid = app_pid, app_path = app_path.display() ); // execute the script using /bin/bash let restart_process = Command::new("/bin/bash") .arg("-c") .arg(script) .process_group(0) .spawn(); match restart_process { Ok(_) => self.quit(), Err(e) => log::error!("failed to spawn restart script: {:?}", e), } } // todo(linux) fn activate(&self, ignoring_other_apps: bool) {} // todo(linux) fn hide(&self) {} fn hide_other_apps(&self) { log::warn!("hide_other_apps is not implemented on Linux, ignoring the call") } // todo(linux) fn unhide_other_apps(&self) {} fn primary_display(&self) -> Option> { self.primary_display() } fn displays(&self) -> Vec> { self.displays() } // todo(linux) fn active_window(&self) -> Option { None } fn open_window( &self, handle: AnyWindowHandle, options: WindowParams, ) -> Box { self.open_window(handle, options) } fn open_url(&self, url: &str) { self.open_uri(url); } fn on_open_urls(&self, callback: Box)>) { self.with_common(|common| common.callbacks.open_urls = Some(callback)); } fn prompt_for_paths( &self, options: PathPromptOptions, ) -> oneshot::Receiver>> { let (done_tx, done_rx) = oneshot::channel(); self.foreground_executor() .spawn(async move { let title = if options.multiple { if !options.files { "Open folders" } else { "Open files" } } else { if !options.files { "Open folder" } else { "Open file" } }; let result = OpenFileRequest::default() .modal(true) .title(title) .accept_label("Select") .multiple(options.multiple) .directory(options.directories) .send() .await .ok() .and_then(|request| request.response().ok()) .and_then(|response| { response .uris() .iter() .map(|uri| uri.to_file_path().ok()) .collect() }); done_tx.send(result); }) .detach(); done_rx } fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver> { let (done_tx, done_rx) = oneshot::channel(); let directory = directory.to_owned(); self.foreground_executor() .spawn(async move { let result = SaveFileRequest::default() .modal(true) .title("Select new path") .accept_label("Accept") .send() .await .ok() .and_then(|request| request.response().ok()) .and_then(|response| { response .uris() .first() .and_then(|uri| uri.to_file_path().ok()) }); done_tx.send(result); }) .detach(); done_rx } fn reveal_path(&self, path: &Path) { if path.is_dir() { open::that_detached(path); return; } // If `path` is a file, the system may try to open it in a text editor let dir = path.parent().unwrap_or(Path::new("")); open::that_detached(dir); } fn on_quit(&self, callback: Box) { self.with_common(|common| { common.callbacks.quit = Some(callback); }); } fn on_reopen(&self, callback: Box) { self.with_common(|common| { common.callbacks.reopen = Some(callback); }); } fn on_app_menu_action(&self, callback: Box) { self.with_common(|common| { common.callbacks.app_menu_action = Some(callback); }); } fn on_will_open_app_menu(&self, callback: Box) { self.with_common(|common| { common.callbacks.will_open_app_menu = Some(callback); }); } fn on_validate_app_menu_command(&self, callback: Box bool>) { self.with_common(|common| { common.callbacks.validate_app_menu_command = Some(callback); }); } fn os_name(&self) -> &'static str { "Linux" } fn os_version(&self) -> Result { Ok(SemanticVersion::new(1, 0, 0)) } fn app_version(&self) -> Result { const VERSION: Option<&str> = option_env!("RELEASE_VERSION"); if let Some(version) = VERSION { version.parse() } else { Ok(SemanticVersion::new(1, 0, 0)) } } fn app_path(&self) -> Result { // get the path of the executable of the current process let exe_path = std::env::current_exe()?; Ok(exe_path) } // todo(linux) fn set_menus(&self, menus: Vec, keymap: &Keymap) {} fn local_timezone(&self) -> UtcOffset { UtcOffset::UTC } //todo(linux) fn path_for_auxiliary_executable(&self, name: &str) -> Result { Err(anyhow::Error::msg( "Platform::path_for_auxiliary_executable is not implemented yet", )) } fn set_cursor_style(&self, style: CursorStyle) { self.set_cursor_style(style) } // todo(linux) fn should_auto_hide_scrollbars(&self) -> bool { false } fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Task> { let url = url.to_string(); let username = username.to_string(); let password = password.to_vec(); self.background_executor().spawn(async move { let keyring = oo7::Keyring::new().await?; keyring.unlock().await?; keyring .create_item( KEYRING_LABEL, &vec![("url", &url), ("username", &username)], password, true, ) .await?; Ok(()) }) } fn read_credentials(&self, url: &str) -> Task)>>> { let url = url.to_string(); self.background_executor().spawn(async move { let keyring = oo7::Keyring::new().await?; keyring.unlock().await?; let items = keyring.search_items(&vec![("url", &url)]).await?; for item in items.into_iter() { if item.label().await.is_ok_and(|label| label == KEYRING_LABEL) { let attributes = item.attributes().await?; let username = attributes .get("username") .ok_or_else(|| anyhow!("Cannot find username in stored credentials"))?; let secret = item.secret().await?; // we lose the zeroizing capabilities at this boundary, // a current limitation GPUI's credentials api return Ok(Some((username.to_string(), secret.to_vec()))); } else { continue; } } Ok(None) }) } fn delete_credentials(&self, url: &str) -> Task> { let url = url.to_string(); self.background_executor().spawn(async move { let keyring = oo7::Keyring::new().await?; keyring.unlock().await?; let items = keyring.search_items(&vec![("url", &url)]).await?; for item in items.into_iter() { if item.label().await.is_ok_and(|label| label == KEYRING_LABEL) { item.delete().await?; return Ok(()); } } Ok(()) }) } fn window_appearance(&self) -> crate::WindowAppearance { crate::WindowAppearance::Light } fn register_url_scheme(&self, _: &str) -> Task> { Task::ready(Err(anyhow!("register_url_scheme unimplemented"))) } fn write_to_primary(&self, item: ClipboardItem) { self.write_to_primary(item) } fn write_to_clipboard(&self, item: ClipboardItem) { self.write_to_clipboard(item) } fn read_from_primary(&self) -> Option { self.read_from_primary() } fn read_from_clipboard(&self) -> Option { self.read_from_clipboard() } } pub(super) fn open_uri_internal(uri: &str, activation_token: Option<&str>) { let mut last_err = None; for mut command in open::commands(uri) { if let Some(token) = activation_token { command.env("XDG_ACTIVATION_TOKEN", token); } match command.status() { Ok(_) => return, Err(err) => last_err = Some(err), } } log::error!("failed to open uri: {uri:?}, last error: {last_err:?}"); } pub(super) fn is_within_click_distance(a: Point, b: Point) -> bool { let diff = a - b; diff.x.abs() <= DOUBLE_CLICK_DISTANCE && diff.y.abs() <= DOUBLE_CLICK_DISTANCE } pub(super) unsafe fn read_fd(mut fd: FileDescriptor) -> Result { let mut file = File::from_raw_fd(fd.as_raw_fd()); let mut buffer = String::new(); file.read_to_string(&mut buffer)?; // Normalize the text to unix line endings, otherwise // copying from eg: firefox inserts a lot of blank // lines, and that is super annoying. let result = buffer.replace("\r\n", "\n"); Ok(result) } impl CursorStyle { pub(super) fn to_shape(&self) -> Shape { match self { CursorStyle::Arrow => Shape::Default, CursorStyle::IBeam => Shape::Text, CursorStyle::Crosshair => Shape::Crosshair, CursorStyle::ClosedHand => Shape::Grabbing, CursorStyle::OpenHand => Shape::Grab, CursorStyle::PointingHand => Shape::Pointer, CursorStyle::ResizeLeft => Shape::WResize, CursorStyle::ResizeRight => Shape::EResize, CursorStyle::ResizeLeftRight => Shape::EwResize, CursorStyle::ResizeUp => Shape::NResize, CursorStyle::ResizeDown => Shape::SResize, CursorStyle::ResizeUpDown => Shape::NsResize, CursorStyle::ResizeColumn => Shape::ColResize, CursorStyle::ResizeRow => Shape::RowResize, CursorStyle::DisappearingItem => Shape::Grabbing, // todo(linux) - couldn't find equivalent icon in linux CursorStyle::IBeamCursorForVerticalLayout => Shape::VerticalText, CursorStyle::OperationNotAllowed => Shape::NotAllowed, CursorStyle::DragLink => Shape::Alias, CursorStyle::DragCopy => Shape::Copy, CursorStyle::ContextualMenu => Shape::ContextMenu, } } pub(super) fn to_icon_name(&self) -> String { // Based on cursor names from https://gitlab.gnome.org/GNOME/adwaita-icon-theme (GNOME) // and https://github.com/KDE/breeze (KDE). Both of them seem to be also derived from // Web CSS cursor names: https://developer.mozilla.org/en-US/docs/Web/CSS/cursor#values match self { CursorStyle::Arrow => "arrow", CursorStyle::IBeam => "text", CursorStyle::Crosshair => "crosshair", CursorStyle::ClosedHand => "grabbing", CursorStyle::OpenHand => "grab", CursorStyle::PointingHand => "pointer", CursorStyle::ResizeLeft => "w-resize", CursorStyle::ResizeRight => "e-resize", CursorStyle::ResizeLeftRight => "ew-resize", CursorStyle::ResizeUp => "n-resize", CursorStyle::ResizeDown => "s-resize", CursorStyle::ResizeUpDown => "ns-resize", CursorStyle::ResizeColumn => "col-resize", CursorStyle::ResizeRow => "row-resize", CursorStyle::DisappearingItem => "grabbing", // todo(linux) - couldn't find equivalent icon in linux CursorStyle::IBeamCursorForVerticalLayout => "vertical-text", CursorStyle::OperationNotAllowed => "not-allowed", CursorStyle::DragLink => "alias", CursorStyle::DragCopy => "copy", CursorStyle::ContextualMenu => "context-menu", } .to_string() } } impl Keystroke { pub(super) fn from_xkb(state: &State, modifiers: Modifiers, keycode: Keycode) -> Self { let mut modifiers = modifiers; let key_utf32 = state.key_get_utf32(keycode); let key_utf8 = state.key_get_utf8(keycode); let key_sym = state.key_get_one_sym(keycode); // The logic here tries to replicate the logic in `../mac/events.rs` // "Consumed" modifiers are modifiers that have been used to translate a key, for example // pressing "shift" and "1" on US layout produces the key `!` but "consumes" the shift. // Notes: // - macOS gets the key character directly ("."), xkb gives us the key name ("period") // - macOS logic removes consumed shift modifier for symbols: "{", not "shift-{" // - macOS logic keeps consumed shift modifiers for letters: "shift-a", not "a" or "A" let mut handle_consumed_modifiers = true; let key = match key_sym { Keysym::Return => "enter".to_owned(), Keysym::Prior => "pageup".to_owned(), Keysym::Next => "pagedown".to_owned(), Keysym::comma => ",".to_owned(), Keysym::period => ".".to_owned(), Keysym::less => "<".to_owned(), Keysym::greater => ">".to_owned(), Keysym::slash => "/".to_owned(), Keysym::question => "?".to_owned(), Keysym::semicolon => ";".to_owned(), Keysym::colon => ":".to_owned(), Keysym::apostrophe => "'".to_owned(), Keysym::quotedbl => "\"".to_owned(), Keysym::bracketleft => "[".to_owned(), Keysym::braceleft => "{".to_owned(), Keysym::bracketright => "]".to_owned(), Keysym::braceright => "}".to_owned(), Keysym::backslash => "\\".to_owned(), Keysym::bar => "|".to_owned(), Keysym::grave => "`".to_owned(), Keysym::asciitilde => "~".to_owned(), Keysym::exclam => "!".to_owned(), Keysym::at => "@".to_owned(), Keysym::numbersign => "#".to_owned(), Keysym::dollar => "$".to_owned(), Keysym::percent => "%".to_owned(), Keysym::asciicircum => "^".to_owned(), Keysym::ampersand => "&".to_owned(), Keysym::asterisk => "*".to_owned(), Keysym::parenleft => "(".to_owned(), Keysym::parenright => ")".to_owned(), Keysym::minus => "-".to_owned(), Keysym::underscore => "_".to_owned(), Keysym::equal => "=".to_owned(), Keysym::plus => "+".to_owned(), Keysym::ISO_Left_Tab => { handle_consumed_modifiers = false; "tab".to_owned() } _ => { handle_consumed_modifiers = false; xkb::keysym_get_name(key_sym).to_lowercase() } }; // Ignore control characters (and DEL) for the purposes of ime_key let ime_key = (key_utf32 >= 32 && key_utf32 != 127 && !key_utf8.is_empty()).then_some(key_utf8); if handle_consumed_modifiers { let mod_shift_index = state.get_keymap().mod_get_index(xkb::MOD_NAME_SHIFT); let is_shift_consumed = state.mod_index_is_consumed(keycode, mod_shift_index); if modifiers.shift && is_shift_consumed { modifiers.shift = false; } } Keystroke { modifiers, key, ime_key, } } } impl Modifiers { pub(super) fn from_xkb(keymap_state: &State) -> Self { let shift = keymap_state.mod_name_is_active(xkb::MOD_NAME_SHIFT, xkb::STATE_MODS_EFFECTIVE); let alt = keymap_state.mod_name_is_active(xkb::MOD_NAME_ALT, xkb::STATE_MODS_EFFECTIVE); let control = keymap_state.mod_name_is_active(xkb::MOD_NAME_CTRL, xkb::STATE_MODS_EFFECTIVE); let platform = keymap_state.mod_name_is_active(xkb::MOD_NAME_LOGO, xkb::STATE_MODS_EFFECTIVE); Modifiers { shift, alt, control, platform, function: false, } } } #[cfg(test)] mod tests { use super::*; use crate::{px, Point}; #[test] fn test_is_within_click_distance() { let zero = Point::new(px(0.0), px(0.0)); assert_eq!( is_within_click_distance(zero, Point::new(px(5.0), px(5.0))), true ); assert_eq!( is_within_click_distance(zero, Point::new(px(-4.9), px(5.0))), true ); assert_eq!( is_within_click_distance(Point::new(px(3.0), px(2.0)), Point::new(px(-2.0), px(-2.0))), true ); assert_eq!( is_within_click_distance(zero, Point::new(px(5.0), px(5.1))), false ); } }