mod app_menu; mod keyboard; mod keystroke; #[cfg(all(target_os = "linux", feature = "wayland"))] #[expect(missing_docs)] pub mod layer_shell; #[cfg(any(test, feature = "test-support"))] mod test; #[cfg(all(target_os = "macos", any(test, feature = "test-support")))] mod visual_test; #[cfg(all( feature = "screen-capture", any(target_os = "windows", target_os = "linux", target_os = "freebsd",) ))] pub mod scap_screen_capture; #[cfg(all( any(target_os = "windows", target_os = "linux"), feature = "screen-capture" ))] pub(crate) type PlatformScreenCaptureFrame = scap::frame::Frame; #[cfg(not(feature = "screen-capture"))] pub(crate) type PlatformScreenCaptureFrame = (); #[cfg(all(target_os = "macos", feature = "screen-capture"))] pub(crate) type PlatformScreenCaptureFrame = core_video::image_buffer::CVImageBuffer; use crate::{ Action, AnyWindowHandle, App, AsyncWindowContext, BackgroundExecutor, Bounds, DEFAULT_WINDOW_SIZE, DevicePixels, DispatchEventResult, Font, FontId, FontMetrics, FontRun, ForegroundExecutor, GlyphId, GpuSpecs, ImageSource, Keymap, LineLayout, Pixels, PlatformInput, Point, Priority, RenderGlyphParams, RenderImage, RenderImageParams, RenderSvgParams, Scene, ShapedGlyph, ShapedRun, SharedString, Size, SvgRenderer, SystemWindowTab, Task, ThreadTaskTimings, Window, WindowControlArea, hash, point, px, size, }; use anyhow::Result; #[cfg(any(target_os = "linux", target_os = "freebsd"))] use anyhow::bail; use async_task::Runnable; use futures::channel::oneshot; #[cfg(any(test, feature = "test-support"))] use image::RgbaImage; use image::codecs::gif::GifDecoder; use image::{AnimationDecoder as _, Frame}; use raw_window_handle::{HasDisplayHandle, HasWindowHandle}; use scheduler::Instant; pub use scheduler::RunnableMeta; use schemars::JsonSchema; use seahash::SeaHasher; use serde::{Deserialize, Serialize}; use smallvec::SmallVec; use std::borrow::Cow; use std::hash::{Hash, Hasher}; use std::io::Cursor; use std::ops; use std::time::Duration; use std::{ fmt::{self, Debug}, ops::Range, path::{Path, PathBuf}, rc::Rc, sync::Arc, }; use strum::EnumIter; use uuid::Uuid; pub use app_menu::*; pub use keyboard::*; pub use keystroke::*; #[cfg(any(test, feature = "test-support"))] pub(crate) use test::*; #[cfg(any(test, feature = "test-support"))] pub use test::{TestDispatcher, TestScreenCaptureSource, TestScreenCaptureStream}; #[cfg(all(target_os = "macos", any(test, feature = "test-support")))] pub use visual_test::VisualTestPlatform; // TODO(jk): return an enum instead of a string /// Return which compositor we're guessing we'll use. /// Does not attempt to connect to the given compositor. #[cfg(any(target_os = "linux", target_os = "freebsd"))] #[inline] pub fn guess_compositor() -> &'static str { if std::env::var_os("ZED_HEADLESS").is_some() { return "Headless"; } #[cfg(feature = "wayland")] let wayland_display = std::env::var_os("WAYLAND_DISPLAY"); #[cfg(not(feature = "wayland"))] let wayland_display: Option = None; #[cfg(feature = "x11")] let x11_display = std::env::var_os("DISPLAY"); #[cfg(not(feature = "x11"))] let x11_display: Option = None; let use_wayland = wayland_display.is_some_and(|display| !display.is_empty()); let use_x11 = x11_display.is_some_and(|display| !display.is_empty()); if use_wayland { "Wayland" } else if use_x11 { "X11" } else { "Headless" } } #[expect(missing_docs)] pub trait Platform: 'static { fn background_executor(&self) -> BackgroundExecutor; fn foreground_executor(&self) -> ForegroundExecutor; fn text_system(&self) -> Arc; fn run(&self, on_finish_launching: Box); fn quit(&self); fn restart(&self, binary_path: Option); fn activate(&self, ignoring_other_apps: bool); fn hide(&self); fn hide_other_apps(&self); fn unhide_other_apps(&self); fn displays(&self) -> Vec>; fn primary_display(&self) -> Option>; fn active_window(&self) -> Option; fn window_stack(&self) -> Option> { None } fn is_screen_capture_supported(&self) -> bool { false } fn screen_capture_sources( &self, ) -> oneshot::Receiver>>> { let (sources_tx, sources_rx) = oneshot::channel(); sources_tx .send(Err(anyhow::anyhow!( "gpui was compiled without the screen-capture feature" ))) .ok(); sources_rx } fn open_window( &self, handle: AnyWindowHandle, options: WindowParams, ) -> anyhow::Result>; /// Returns the appearance of the application's windows. fn window_appearance(&self) -> WindowAppearance; /// Returns the window button layout configuration when supported. fn button_layout(&self) -> Option { None } fn open_url(&self, url: &str); fn on_open_urls(&self, callback: Box)>); fn register_url_scheme(&self, url: &str) -> Task>; fn prompt_for_paths( &self, options: PathPromptOptions, ) -> oneshot::Receiver>>>; fn prompt_for_new_path( &self, directory: &Path, suggested_name: Option<&str>, ) -> oneshot::Receiver>>; fn can_select_mixed_files_and_dirs(&self) -> bool; fn reveal_path(&self, path: &Path); fn open_with_system(&self, path: &Path); fn on_quit(&self, callback: Box); fn on_reopen(&self, callback: Box); fn set_menus(&self, menus: Vec, keymap: &Keymap); fn get_menus(&self) -> Option> { None } fn set_dock_menu(&self, menu: Vec, keymap: &Keymap); fn perform_dock_menu_action(&self, _action: usize) {} fn add_recent_document(&self, _path: &Path) {} fn update_jump_list( &self, _menus: Vec, _entries: Vec>, ) -> Task>> { Task::ready(Vec::new()) } fn on_app_menu_action(&self, callback: Box); fn on_will_open_app_menu(&self, callback: Box); fn on_validate_app_menu_command(&self, callback: Box bool>); fn thermal_state(&self) -> ThermalState; fn on_thermal_state_change(&self, callback: Box); fn compositor_name(&self) -> &'static str { "" } fn app_path(&self) -> Result; fn path_for_auxiliary_executable(&self, name: &str) -> Result; fn set_cursor_style(&self, style: CursorStyle); fn should_auto_hide_scrollbars(&self) -> bool; fn read_from_clipboard(&self) -> Option; fn write_to_clipboard(&self, item: ClipboardItem); #[cfg(any(target_os = "linux", target_os = "freebsd"))] fn read_from_primary(&self) -> Option; #[cfg(any(target_os = "linux", target_os = "freebsd"))] fn write_to_primary(&self, item: ClipboardItem); #[cfg(target_os = "macos")] fn read_from_find_pasteboard(&self) -> Option; #[cfg(target_os = "macos")] fn write_to_find_pasteboard(&self, item: ClipboardItem); fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Task>; fn read_credentials(&self, url: &str) -> Task)>>>; fn delete_credentials(&self, url: &str) -> Task>; fn keyboard_layout(&self) -> Box; fn keyboard_mapper(&self) -> Rc; fn on_keyboard_layout_change(&self, callback: Box); } /// A handle to a platform's display, e.g. a monitor or laptop screen. pub trait PlatformDisplay: Debug { /// Get the ID for this display fn id(&self) -> DisplayId; /// Returns a stable identifier for this display that can be persisted and used /// across system restarts. fn uuid(&self) -> Result; /// Get the bounds for this display fn bounds(&self) -> Bounds; /// Get the visible bounds for this display, excluding taskbar/dock areas. /// This is the usable area where windows can be placed without being obscured. /// Defaults to the full display bounds if not overridden. fn visible_bounds(&self) -> Bounds { self.bounds() } /// Get the default bounds for this display to place a window fn default_bounds(&self) -> Bounds { let bounds = self.bounds(); let center = bounds.center(); let clipped_window_size = DEFAULT_WINDOW_SIZE.min(&bounds.size); let offset = clipped_window_size / 2.0; let origin = point(center.x - offset.width, center.y - offset.height); Bounds::new(origin, clipped_window_size) } } /// Thermal state of the system #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum ThermalState { /// System has no thermal constraints Nominal, /// System is slightly constrained, reduce discretionary work Fair, /// System is moderately constrained, reduce CPU/GPU intensive work Serious, /// System is critically constrained, minimize all resource usage Critical, } /// Metadata for a given [ScreenCaptureSource] #[derive(Clone)] pub struct SourceMetadata { /// Opaque identifier of this screen. pub id: u64, /// Human-readable label for this source. pub label: Option, /// Whether this source is the main display. pub is_main: Option, /// Video resolution of this source. pub resolution: Size, } /// A source of on-screen video content that can be captured. pub trait ScreenCaptureSource { /// Returns metadata for this source. fn metadata(&self) -> Result; /// Start capture video from this source, invoking the given callback /// with each frame. fn stream( &self, foreground_executor: &ForegroundExecutor, frame_callback: Box, ) -> oneshot::Receiver>>; } /// A video stream captured from a screen. pub trait ScreenCaptureStream { /// Returns metadata for this source. fn metadata(&self) -> Result; } /// A frame of video captured from a screen. pub struct ScreenCaptureFrame(pub PlatformScreenCaptureFrame); /// An opaque identifier for a hardware display #[derive(PartialEq, Eq, Hash, Copy, Clone)] pub struct DisplayId(pub(crate) u32); impl DisplayId { /// Create a new `DisplayId` from a raw platform display identifier. pub fn new(id: u32) -> Self { Self(id) } } impl From for DisplayId { fn from(id: u32) -> Self { Self(id) } } impl From for u32 { fn from(id: DisplayId) -> Self { id.0 } } impl Debug for DisplayId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "DisplayId({})", self.0) } } /// Which part of the window to resize #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub enum ResizeEdge { /// The top edge Top, /// The top right corner TopRight, /// The right edge Right, /// The bottom right corner BottomRight, /// The bottom edge Bottom, /// The bottom left corner BottomLeft, /// The left edge Left, /// The top left corner TopLeft, } /// A type to describe the appearance of a window #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)] pub enum WindowDecorations { #[default] /// Server side decorations Server, /// Client side decorations Client, } /// A type to describe how this window is currently configured #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)] pub enum Decorations { /// The window is configured to use server side decorations #[default] Server, /// The window is configured to use client side decorations Client { /// The edge tiling state tiling: Tiling, }, } /// What window controls this platform supports #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)] pub struct WindowControls { /// Whether this platform supports fullscreen pub fullscreen: bool, /// Whether this platform supports maximize pub maximize: bool, /// Whether this platform supports minimize pub minimize: bool, /// Whether this platform supports a window menu pub window_menu: bool, } impl Default for WindowControls { fn default() -> Self { // Assume that we can do anything, unless told otherwise Self { fullscreen: true, maximize: true, minimize: true, window_menu: true, } } } /// A window control button type used in [`WindowButtonLayout`]. #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)] pub enum WindowButton { /// The minimize button Minimize, /// The maximize button Maximize, /// The close button Close, } impl WindowButton { /// Returns a stable element ID for rendering this button. pub fn id(&self) -> &'static str { match self { WindowButton::Minimize => "minimize", WindowButton::Maximize => "maximize", WindowButton::Close => "close", } } #[cfg(any(target_os = "linux", target_os = "freebsd"))] fn index(&self) -> usize { match self { WindowButton::Minimize => 0, WindowButton::Maximize => 1, WindowButton::Close => 2, } } } /// Maximum number of [`WindowButton`]s per side in the titlebar. pub const MAX_BUTTONS_PER_SIDE: usize = 3; /// Describes which [`WindowButton`]s appear on each side of the titlebar. /// /// On Linux, this is read from the desktop environment's configuration /// (e.g. GNOME's `gtk-decoration-layout` gsetting) via [`WindowButtonLayout::parse`]. #[derive(Debug, Clone, Copy, PartialEq, Eq)] pub struct WindowButtonLayout { /// Buttons on the left side of the titlebar. pub left: [Option; MAX_BUTTONS_PER_SIDE], /// Buttons on the right side of the titlebar. pub right: [Option; MAX_BUTTONS_PER_SIDE], } #[cfg(any(target_os = "linux", target_os = "freebsd"))] impl WindowButtonLayout { /// Returns Zed's built-in fallback button layout for Linux titlebars. pub fn linux_default() -> Self { Self { left: [None; MAX_BUTTONS_PER_SIDE], right: [ Some(WindowButton::Minimize), Some(WindowButton::Maximize), Some(WindowButton::Close), ], } } /// Parses a GNOME-style `button-layout` string (e.g. `"close,minimize:maximize"`). pub fn parse(layout_string: &str) -> Result { fn parse_side( s: &str, seen_buttons: &mut [bool; MAX_BUTTONS_PER_SIDE], unrecognized: &mut Vec, ) -> [Option; MAX_BUTTONS_PER_SIDE] { let mut result = [None; MAX_BUTTONS_PER_SIDE]; let mut i = 0; for name in s.split(',') { let trimmed = name.trim(); if trimmed.is_empty() { continue; } let button = match trimmed { "minimize" => Some(WindowButton::Minimize), "maximize" => Some(WindowButton::Maximize), "close" => Some(WindowButton::Close), other => { unrecognized.push(other.to_string()); None } }; if let Some(button) = button { if seen_buttons[button.index()] { continue; } if let Some(slot) = result.get_mut(i) { *slot = Some(button); seen_buttons[button.index()] = true; i += 1; } } } result } let (left_str, right_str) = layout_string.split_once(':').unwrap_or(("", layout_string)); let mut unrecognized = Vec::new(); let mut seen_buttons = [false; MAX_BUTTONS_PER_SIDE]; let layout = Self { left: parse_side(left_str, &mut seen_buttons, &mut unrecognized), right: parse_side(right_str, &mut seen_buttons, &mut unrecognized), }; if !unrecognized.is_empty() && layout.left.iter().all(Option::is_none) && layout.right.iter().all(Option::is_none) { bail!( "button layout string {:?} contains no valid buttons (unrecognized: {})", layout_string, unrecognized.join(", ") ); } Ok(layout) } /// Formats the layout back into a GNOME-style `button-layout` string. #[cfg(test)] pub fn format(&self) -> String { fn format_side(buttons: &[Option; MAX_BUTTONS_PER_SIDE]) -> String { buttons .iter() .flatten() .map(|button| match button { WindowButton::Minimize => "minimize", WindowButton::Maximize => "maximize", WindowButton::Close => "close", }) .collect::>() .join(",") } format!("{}:{}", format_side(&self.left), format_side(&self.right)) } } /// A type to describe which sides of the window are currently tiled in some way #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)] pub struct Tiling { /// Whether the top edge is tiled pub top: bool, /// Whether the left edge is tiled pub left: bool, /// Whether the right edge is tiled pub right: bool, /// Whether the bottom edge is tiled pub bottom: bool, } impl Tiling { /// Initializes a [`Tiling`] type with all sides tiled pub fn tiled() -> Self { Self { top: true, left: true, right: true, bottom: true, } } /// Whether any edge is tiled pub fn is_tiled(&self) -> bool { self.top || self.left || self.right || self.bottom } } #[derive(Debug, Copy, Clone, Eq, PartialEq, Default)] #[expect(missing_docs)] pub struct RequestFrameOptions { /// Whether a presentation is required. pub require_presentation: bool, /// Force refresh of all rendering states when true. pub force_render: bool, } #[expect(missing_docs)] pub trait PlatformWindow: HasWindowHandle + HasDisplayHandle { fn bounds(&self) -> Bounds; fn is_maximized(&self) -> bool; fn window_bounds(&self) -> WindowBounds; fn content_size(&self) -> Size; fn resize(&mut self, size: Size); fn scale_factor(&self) -> f32; fn appearance(&self) -> WindowAppearance; fn display(&self) -> Option>; fn mouse_position(&self) -> Point; fn modifiers(&self) -> Modifiers; fn capslock(&self) -> Capslock; fn set_input_handler(&mut self, input_handler: PlatformInputHandler); fn take_input_handler(&mut self) -> Option; fn prompt( &self, level: PromptLevel, msg: &str, detail: Option<&str>, answers: &[PromptButton], ) -> Option>; fn activate(&self); fn is_active(&self) -> bool; fn is_hovered(&self) -> bool; fn background_appearance(&self) -> WindowBackgroundAppearance; fn set_title(&mut self, title: &str); fn set_background_appearance(&self, background_appearance: WindowBackgroundAppearance); fn minimize(&self); fn zoom(&self); fn toggle_fullscreen(&self); fn is_fullscreen(&self) -> bool; fn on_request_frame(&self, callback: Box); fn on_input(&self, callback: Box DispatchEventResult>); fn on_active_status_change(&self, callback: Box); fn on_hover_status_change(&self, callback: Box); fn on_resize(&self, callback: Box, f32)>); fn on_moved(&self, callback: Box); fn on_should_close(&self, callback: Box bool>); fn on_hit_test_window_control(&self, callback: Box Option>); fn on_close(&self, callback: Box); fn on_appearance_changed(&self, callback: Box); fn on_button_layout_changed(&self, _callback: Box) {} fn draw(&self, scene: &Scene); fn completed_frame(&self) {} fn sprite_atlas(&self) -> Arc; fn is_subpixel_rendering_supported(&self) -> bool; // macOS specific methods fn get_title(&self) -> String { String::new() } fn tabbed_windows(&self) -> Option> { None } fn tab_bar_visible(&self) -> bool { false } fn set_edited(&mut self, _edited: bool) {} fn show_character_palette(&self) {} fn titlebar_double_click(&self) {} fn on_move_tab_to_new_window(&self, _callback: Box) {} fn on_merge_all_windows(&self, _callback: Box) {} fn on_select_previous_tab(&self, _callback: Box) {} fn on_select_next_tab(&self, _callback: Box) {} fn on_toggle_tab_bar(&self, _callback: Box) {} fn merge_all_windows(&self) {} fn move_tab_to_new_window(&self) {} fn toggle_window_tab_overview(&self) {} fn set_tabbing_identifier(&self, _identifier: Option) {} #[cfg(target_os = "windows")] fn get_raw_handle(&self) -> windows::Win32::Foundation::HWND; // Linux specific methods fn inner_window_bounds(&self) -> WindowBounds { self.window_bounds() } fn request_decorations(&self, _decorations: WindowDecorations) {} fn show_window_menu(&self, _position: Point) {} fn start_window_move(&self) {} fn start_window_resize(&self, _edge: ResizeEdge) {} fn window_decorations(&self) -> Decorations { Decorations::Server } fn set_app_id(&mut self, _app_id: &str) {} fn map_window(&mut self) -> anyhow::Result<()> { Ok(()) } fn window_controls(&self) -> WindowControls { WindowControls::default() } fn set_client_inset(&self, _inset: Pixels) {} fn gpu_specs(&self) -> Option; fn update_ime_position(&self, _bounds: Bounds); #[cfg(any(test, feature = "test-support"))] fn as_test(&mut self) -> Option<&mut TestWindow> { None } /// Renders the given scene to a texture and returns the pixel data as an RGBA image. /// This does not present the frame to screen - useful for visual testing where we want /// to capture what would be rendered without displaying it or requiring the window to be visible. #[cfg(any(test, feature = "test-support"))] fn render_to_image(&self, _scene: &Scene) -> Result { anyhow::bail!("render_to_image not implemented for this platform") } } /// A renderer for headless windows that can produce real rendered output. #[cfg(any(test, feature = "test-support"))] pub trait PlatformHeadlessRenderer { /// Render a scene and return the result as an RGBA image. fn render_scene_to_image( &mut self, scene: &Scene, size: Size, ) -> Result; /// Returns the sprite atlas used by this renderer. fn sprite_atlas(&self) -> Arc; } /// Type alias for runnables with metadata. /// Previously an enum with a single variant, now simplified to a direct type alias. #[doc(hidden)] pub type RunnableVariant = Runnable; #[doc(hidden)] pub type TimerResolutionGuard = gpui_util::Deferred>; /// This type is public so that our test macro can generate and use it, but it should not /// be considered part of our public API. #[doc(hidden)] pub trait PlatformDispatcher: Send + Sync { fn get_all_timings(&self) -> Vec; fn get_current_thread_timings(&self) -> ThreadTaskTimings; fn is_main_thread(&self) -> bool; fn dispatch(&self, runnable: RunnableVariant, priority: Priority); fn dispatch_on_main_thread(&self, runnable: RunnableVariant, priority: Priority); fn dispatch_after(&self, duration: Duration, runnable: RunnableVariant); fn spawn_realtime(&self, f: Box); fn now(&self) -> Instant { Instant::now() } fn increase_timer_resolution(&self) -> TimerResolutionGuard { gpui_util::defer(Box::new(|| {})) } #[cfg(any(test, feature = "test-support"))] fn as_test(&self) -> Option<&TestDispatcher> { None } } #[expect(missing_docs)] pub trait PlatformTextSystem: Send + Sync { fn add_fonts(&self, fonts: Vec>) -> Result<()>; /// Get all available font names. fn all_font_names(&self) -> Vec; /// Get the font ID for a font descriptor. fn font_id(&self, descriptor: &Font) -> Result; /// Get metrics for a font. fn font_metrics(&self, font_id: FontId) -> FontMetrics; /// Get typographic bounds for a glyph. fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> Result>; /// Get the advance width for a glyph. fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> Result>; /// Get the glyph ID for a character. fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option; /// Get raster bounds for a glyph. fn glyph_raster_bounds(&self, params: &RenderGlyphParams) -> Result>; /// Rasterize a glyph. fn rasterize_glyph( &self, params: &RenderGlyphParams, raster_bounds: Bounds, ) -> Result<(Size, Vec)>; /// Layout a line of text with the given font runs. fn layout_line(&self, text: &str, font_size: Pixels, runs: &[FontRun]) -> LineLayout; /// Returns the recommended text rendering mode for the given font and size. fn recommended_rendering_mode(&self, _font_id: FontId, _font_size: Pixels) -> TextRenderingMode; } #[expect(missing_docs)] pub struct NoopTextSystem; #[expect(missing_docs)] impl NoopTextSystem { #[allow(dead_code)] pub fn new() -> Self { Self } } impl PlatformTextSystem for NoopTextSystem { fn add_fonts(&self, _fonts: Vec>) -> Result<()> { Ok(()) } fn all_font_names(&self) -> Vec { Vec::new() } fn font_id(&self, _descriptor: &Font) -> Result { Ok(FontId(1)) } fn font_metrics(&self, _font_id: FontId) -> FontMetrics { FontMetrics { units_per_em: 1000, ascent: 1025.0, descent: -275.0, line_gap: 0.0, underline_position: -95.0, underline_thickness: 60.0, cap_height: 698.0, x_height: 516.0, bounding_box: Bounds { origin: Point { x: -260.0, y: -245.0, }, size: Size { width: 1501.0, height: 1364.0, }, }, } } fn typographic_bounds(&self, _font_id: FontId, _glyph_id: GlyphId) -> Result> { Ok(Bounds { origin: Point { x: 54.0, y: 0.0 }, size: size(392.0, 528.0), }) } fn advance(&self, _font_id: FontId, glyph_id: GlyphId) -> Result> { Ok(size(600.0 * glyph_id.0 as f32, 0.0)) } fn glyph_for_char(&self, _font_id: FontId, ch: char) -> Option { Some(GlyphId(ch.len_utf16() as u32)) } fn glyph_raster_bounds(&self, _params: &RenderGlyphParams) -> Result> { Ok(Default::default()) } fn rasterize_glyph( &self, _params: &RenderGlyphParams, raster_bounds: Bounds, ) -> Result<(Size, Vec)> { Ok((raster_bounds.size, Vec::new())) } fn layout_line(&self, text: &str, font_size: Pixels, _runs: &[FontRun]) -> LineLayout { let mut position = px(0.); let metrics = self.font_metrics(FontId(0)); let em_width = font_size * self .advance(FontId(0), self.glyph_for_char(FontId(0), 'm').unwrap()) .unwrap() .width / metrics.units_per_em as f32; let mut glyphs = Vec::new(); for (ix, c) in text.char_indices() { if let Some(glyph) = self.glyph_for_char(FontId(0), c) { glyphs.push(ShapedGlyph { id: glyph, position: point(position, px(0.)), index: ix, is_emoji: glyph.0 == 2, }); if glyph.0 == 2 { position += em_width * 2.0; } else { position += em_width; } } else { position += em_width } } let mut runs = Vec::default(); if !glyphs.is_empty() { runs.push(ShapedRun { font_id: FontId(0), glyphs, }); } else { position = px(0.); } LineLayout { font_size, width: position, ascent: font_size * (metrics.ascent / metrics.units_per_em as f32), descent: font_size * (metrics.descent / metrics.units_per_em as f32), runs, len: text.len(), } } fn recommended_rendering_mode( &self, _font_id: FontId, _font_size: Pixels, ) -> TextRenderingMode { TextRenderingMode::Grayscale } } // Adapted from https://github.com/microsoft/terminal/blob/1283c0f5b99a2961673249fa77c6b986efb5086c/src/renderer/atlas/dwrite.cpp // Copyright (c) Microsoft Corporation. // Licensed under the MIT license. /// Compute gamma correction ratios for subpixel text rendering. #[allow(dead_code)] pub fn get_gamma_correction_ratios(gamma: f32) -> [f32; 4] { const GAMMA_INCORRECT_TARGET_RATIOS: [[f32; 4]; 13] = [ [0.0000 / 4.0, 0.0000 / 4.0, 0.0000 / 4.0, 0.0000 / 4.0], // gamma = 1.0 [0.0166 / 4.0, -0.0807 / 4.0, 0.2227 / 4.0, -0.0751 / 4.0], // gamma = 1.1 [0.0350 / 4.0, -0.1760 / 4.0, 0.4325 / 4.0, -0.1370 / 4.0], // gamma = 1.2 [0.0543 / 4.0, -0.2821 / 4.0, 0.6302 / 4.0, -0.1876 / 4.0], // gamma = 1.3 [0.0739 / 4.0, -0.3963 / 4.0, 0.8167 / 4.0, -0.2287 / 4.0], // gamma = 1.4 [0.0933 / 4.0, -0.5161 / 4.0, 0.9926 / 4.0, -0.2616 / 4.0], // gamma = 1.5 [0.1121 / 4.0, -0.6395 / 4.0, 1.1588 / 4.0, -0.2877 / 4.0], // gamma = 1.6 [0.1300 / 4.0, -0.7649 / 4.0, 1.3159 / 4.0, -0.3080 / 4.0], // gamma = 1.7 [0.1469 / 4.0, -0.8911 / 4.0, 1.4644 / 4.0, -0.3234 / 4.0], // gamma = 1.8 [0.1627 / 4.0, -1.0170 / 4.0, 1.6051 / 4.0, -0.3347 / 4.0], // gamma = 1.9 [0.1773 / 4.0, -1.1420 / 4.0, 1.7385 / 4.0, -0.3426 / 4.0], // gamma = 2.0 [0.1908 / 4.0, -1.2652 / 4.0, 1.8650 / 4.0, -0.3476 / 4.0], // gamma = 2.1 [0.2031 / 4.0, -1.3864 / 4.0, 1.9851 / 4.0, -0.3501 / 4.0], // gamma = 2.2 ]; const NORM13: f32 = ((0x10000 as f64) / (255.0 * 255.0) * 4.0) as f32; const NORM24: f32 = ((0x100 as f64) / (255.0) * 4.0) as f32; let index = ((gamma * 10.0).round() as usize).clamp(10, 22) - 10; let ratios = GAMMA_INCORRECT_TARGET_RATIOS[index]; [ ratios[0] * NORM13, ratios[1] * NORM24, ratios[2] * NORM13, ratios[3] * NORM24, ] } #[derive(PartialEq, Eq, Hash, Clone)] #[expect(missing_docs)] pub enum AtlasKey { Glyph(RenderGlyphParams), Svg(RenderSvgParams), Image(RenderImageParams), } impl AtlasKey { #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] /// Returns the texture kind for this atlas key. pub fn texture_kind(&self) -> AtlasTextureKind { match self { AtlasKey::Glyph(params) => { if params.is_emoji { AtlasTextureKind::Polychrome } else if params.subpixel_rendering { AtlasTextureKind::Subpixel } else { AtlasTextureKind::Monochrome } } AtlasKey::Svg(_) => AtlasTextureKind::Monochrome, AtlasKey::Image(_) => AtlasTextureKind::Polychrome, } } } impl From for AtlasKey { fn from(params: RenderGlyphParams) -> Self { Self::Glyph(params) } } impl From for AtlasKey { fn from(params: RenderSvgParams) -> Self { Self::Svg(params) } } impl From for AtlasKey { fn from(params: RenderImageParams) -> Self { Self::Image(params) } } #[expect(missing_docs)] pub trait PlatformAtlas { fn get_or_insert_with<'a>( &self, key: &AtlasKey, build: &mut dyn FnMut() -> Result, Cow<'a, [u8]>)>>, ) -> Result>; fn remove(&self, key: &AtlasKey); } #[doc(hidden)] pub struct AtlasTextureList { pub textures: Vec>, pub free_list: Vec, } impl Default for AtlasTextureList { fn default() -> Self { Self { textures: Vec::default(), free_list: Vec::default(), } } } impl ops::Index for AtlasTextureList { type Output = Option; fn index(&self, index: usize) -> &Self::Output { &self.textures[index] } } impl AtlasTextureList { #[allow(unused)] pub fn drain(&mut self) -> std::vec::Drain<'_, Option> { self.free_list.clear(); self.textures.drain(..) } #[allow(dead_code)] pub fn iter_mut(&mut self) -> impl DoubleEndedIterator { self.textures.iter_mut().flatten() } } #[derive(Clone, Debug, PartialEq, Eq)] #[repr(C)] #[expect(missing_docs)] pub struct AtlasTile { /// The texture this tile belongs to. pub texture_id: AtlasTextureId, /// The unique ID of this tile within its texture. pub tile_id: TileId, /// Padding around the tile content in pixels. pub padding: u32, /// The bounds of this tile within the texture. pub bounds: Bounds, } #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] #[repr(C)] #[expect(missing_docs)] pub struct AtlasTextureId { // We use u32 instead of usize for Metal Shader Language compatibility /// The index of this texture in the atlas. pub index: u32, /// The kind of content stored in this texture. pub kind: AtlasTextureKind, } #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] #[repr(C)] #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] #[expect(missing_docs)] pub enum AtlasTextureKind { Monochrome = 0, Polychrome = 1, Subpixel = 2, } #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)] #[repr(C)] #[expect(missing_docs)] pub struct TileId(pub u32); impl From for TileId { fn from(id: etagere::AllocId) -> Self { Self(id.serialize()) } } impl From for etagere::AllocId { fn from(id: TileId) -> Self { Self::deserialize(id.0) } } #[expect(missing_docs)] pub struct PlatformInputHandler { cx: AsyncWindowContext, handler: Box, } #[expect(missing_docs)] #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] impl PlatformInputHandler { pub fn new(cx: AsyncWindowContext, handler: Box) -> Self { Self { cx, handler } } pub fn selected_text_range(&mut self, ignore_disabled_input: bool) -> Option { self.cx .update(|window, cx| { self.handler .selected_text_range(ignore_disabled_input, window, cx) }) .ok() .flatten() } #[cfg_attr(target_os = "windows", allow(dead_code))] pub fn marked_text_range(&mut self) -> Option> { self.cx .update(|window, cx| self.handler.marked_text_range(window, cx)) .ok() .flatten() } #[cfg_attr( any(target_os = "linux", target_os = "freebsd", target_os = "windows"), allow(dead_code) )] pub fn text_for_range( &mut self, range_utf16: Range, adjusted: &mut Option>, ) -> Option { self.cx .update(|window, cx| { self.handler .text_for_range(range_utf16, adjusted, window, cx) }) .ok() .flatten() } pub fn replace_text_in_range(&mut self, replacement_range: Option>, text: &str) { self.cx .update(|window, cx| { self.handler .replace_text_in_range(replacement_range, text, window, cx); }) .ok(); } pub fn replace_and_mark_text_in_range( &mut self, range_utf16: Option>, new_text: &str, new_selected_range: Option>, ) { self.cx .update(|window, cx| { self.handler.replace_and_mark_text_in_range( range_utf16, new_text, new_selected_range, window, cx, ) }) .ok(); } #[cfg_attr(target_os = "windows", allow(dead_code))] pub fn unmark_text(&mut self) { self.cx .update(|window, cx| self.handler.unmark_text(window, cx)) .ok(); } pub fn bounds_for_range(&mut self, range_utf16: Range) -> Option> { self.cx .update(|window, cx| self.handler.bounds_for_range(range_utf16, window, cx)) .ok() .flatten() } #[allow(dead_code)] pub fn apple_press_and_hold_enabled(&mut self) -> bool { self.handler.apple_press_and_hold_enabled() } pub fn dispatch_input(&mut self, input: &str, window: &mut Window, cx: &mut App) { self.handler.replace_text_in_range(None, input, window, cx); } pub fn selected_bounds(&mut self, window: &mut Window, cx: &mut App) -> Option> { let selection = self.handler.selected_text_range(true, window, cx)?; self.handler.bounds_for_range( if selection.reversed { selection.range.start..selection.range.start } else { selection.range.end..selection.range.end }, window, cx, ) } #[allow(unused)] pub fn character_index_for_point(&mut self, point: Point) -> Option { self.cx .update(|window, cx| self.handler.character_index_for_point(point, window, cx)) .ok() .flatten() } #[allow(dead_code)] pub fn accepts_text_input(&mut self, window: &mut Window, cx: &mut App) -> bool { self.handler.accepts_text_input(window, cx) } #[allow(dead_code)] pub fn query_accepts_text_input(&mut self) -> bool { self.cx .update(|window, cx| self.handler.accepts_text_input(window, cx)) .unwrap_or(true) } #[allow(dead_code)] pub fn query_prefers_ime_for_printable_keys(&mut self) -> bool { self.cx .update(|window, cx| self.handler.prefers_ime_for_printable_keys(window, cx)) .unwrap_or(false) } } /// A struct representing a selection in a text buffer, in UTF16 characters. /// This is different from a range because the head may be before the tail. #[derive(Debug)] pub struct UTF16Selection { /// The range of text in the document this selection corresponds to /// in UTF16 characters. pub range: Range, /// Whether the head of this selection is at the start (true), or end (false) /// of the range pub reversed: bool, } /// Zed's interface for handling text input from the platform's IME system /// This is currently a 1:1 exposure of the NSTextInputClient API: /// /// pub trait InputHandler: 'static { /// Get the range of the user's currently selected text, if any /// Corresponds to [selectedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438242-selectedrange) /// /// Return value is in terms of UTF-16 characters, from 0 to the length of the document fn selected_text_range( &mut self, ignore_disabled_input: bool, window: &mut Window, cx: &mut App, ) -> Option; /// Get the range of the currently marked text, if any /// Corresponds to [markedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438250-markedrange) /// /// Return value is in terms of UTF-16 characters, from 0 to the length of the document fn marked_text_range(&mut self, window: &mut Window, cx: &mut App) -> Option>; /// Get the text for the given document range in UTF-16 characters /// Corresponds to [attributedSubstring(forProposedRange: actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438238-attributedsubstring) /// /// range_utf16 is in terms of UTF-16 characters fn text_for_range( &mut self, range_utf16: Range, adjusted_range: &mut Option>, window: &mut Window, cx: &mut App, ) -> Option; /// Replace the text in the given document range with the given text /// Corresponds to [insertText(_:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438258-inserttext) /// /// replacement_range is in terms of UTF-16 characters fn replace_text_in_range( &mut self, replacement_range: Option>, text: &str, window: &mut Window, cx: &mut App, ); /// Replace the text in the given document range with the given text, /// and mark the given text as part of an IME 'composing' state /// Corresponds to [setMarkedText(_:selectedRange:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438246-setmarkedtext) /// /// range_utf16 is in terms of UTF-16 characters /// new_selected_range is in terms of UTF-16 characters fn replace_and_mark_text_in_range( &mut self, range_utf16: Option>, new_text: &str, new_selected_range: Option>, window: &mut Window, cx: &mut App, ); /// Remove the IME 'composing' state from the document /// Corresponds to [unmarkText()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438239-unmarktext) fn unmark_text(&mut self, window: &mut Window, cx: &mut App); /// Get the bounds of the given document range in screen coordinates /// Corresponds to [firstRect(forCharacterRange:actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438240-firstrect) /// /// This is used for positioning the IME candidate window fn bounds_for_range( &mut self, range_utf16: Range, window: &mut Window, cx: &mut App, ) -> Option>; /// Get the character offset for the given point in terms of UTF16 characters /// /// Corresponds to [characterIndexForPoint:](https://developer.apple.com/documentation/appkit/nstextinputclient/characterindex(for:)) fn character_index_for_point( &mut self, point: Point, window: &mut Window, cx: &mut App, ) -> Option; /// Allows a given input context to opt into getting raw key repeats instead of /// sending these to the platform. /// TODO: Ideally we should be able to set ApplePressAndHoldEnabled in NSUserDefaults /// (which is how iTerm does it) but it doesn't seem to work for me. #[allow(dead_code)] fn apple_press_and_hold_enabled(&mut self) -> bool { true } /// Returns whether this handler is accepting text input to be inserted. fn accepts_text_input(&mut self, _window: &mut Window, _cx: &mut App) -> bool { true } /// Returns whether printable keys should be routed to the IME before keybinding /// matching when a non-ASCII input source (e.g. Japanese, Korean, Chinese IME) /// is active. This prevents multi-stroke keybindings like `jj` from intercepting /// keys that the IME should compose. /// /// Defaults to `false`. The editor overrides this based on whether it expects /// character input (e.g. Vim insert mode returns `true`, normal mode returns `false`). /// The terminal keeps the default `false` so that raw keys reach the terminal process. fn prefers_ime_for_printable_keys(&mut self, _window: &mut Window, _cx: &mut App) -> bool { false } } /// The variables that can be configured when creating a new window #[derive(Debug)] pub struct WindowOptions { /// Specifies the state and bounds of the window in screen coordinates. /// - `None`: Inherit the bounds. /// - `Some(WindowBounds)`: Open a window with corresponding state and its restore size. pub window_bounds: Option, /// The titlebar configuration of the window pub titlebar: Option, /// Whether the window should be focused when created pub focus: bool, /// Whether the window should be shown when created pub show: bool, /// The kind of window to create pub kind: WindowKind, /// Whether the window should be movable by the user pub is_movable: bool, /// Whether the window should be resizable by the user pub is_resizable: bool, /// Whether the window should be minimized by the user pub is_minimizable: bool, /// The display to create the window on, if this is None, /// the window will be created on the main display pub display_id: Option, /// The appearance of the window background. pub window_background: WindowBackgroundAppearance, /// Application identifier of the window. Can by used by desktop environments to group applications together. pub app_id: Option, /// Window minimum size pub window_min_size: Option>, /// Whether to use client or server side decorations. Wayland only /// Note that this may be ignored. pub window_decorations: Option, /// Tab group name, allows opening the window as a native tab on macOS 10.12+. Windows with the same tabbing identifier will be grouped together. pub tabbing_identifier: Option, } /// The variables that can be configured when creating a new window #[derive(Debug)] #[cfg_attr( all( any(target_os = "linux", target_os = "freebsd"), not(any(feature = "x11", feature = "wayland")) ), allow(dead_code) )] #[allow(missing_docs)] pub struct WindowParams { pub bounds: Bounds, /// The titlebar configuration of the window #[cfg_attr(feature = "wayland", allow(dead_code))] pub titlebar: Option, /// The kind of window to create #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))] pub kind: WindowKind, /// Whether the window should be movable by the user #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))] pub is_movable: bool, /// Whether the window should be resizable by the user #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))] pub is_resizable: bool, /// Whether the window should be minimized by the user #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))] pub is_minimizable: bool, #[cfg_attr( any(target_os = "linux", target_os = "freebsd", target_os = "windows"), allow(dead_code) )] pub focus: bool, #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))] pub show: bool, #[cfg_attr(feature = "wayland", allow(dead_code))] pub display_id: Option, pub window_min_size: Option>, #[cfg(target_os = "macos")] pub tabbing_identifier: Option, } /// Represents the status of how a window should be opened. #[derive(Debug, Copy, Clone, PartialEq)] pub enum WindowBounds { /// Indicates that the window should open in a windowed state with the given bounds. Windowed(Bounds), /// Indicates that the window should open in a maximized state. /// The bounds provided here represent the restore size of the window. Maximized(Bounds), /// Indicates that the window should open in fullscreen mode. /// The bounds provided here represent the restore size of the window. Fullscreen(Bounds), } impl Default for WindowBounds { fn default() -> Self { WindowBounds::Windowed(Bounds::default()) } } impl WindowBounds { /// Retrieve the inner bounds pub fn get_bounds(&self) -> Bounds { match self { WindowBounds::Windowed(bounds) => *bounds, WindowBounds::Maximized(bounds) => *bounds, WindowBounds::Fullscreen(bounds) => *bounds, } } /// Creates a new window bounds that centers the window on the screen. pub fn centered(size: Size, cx: &App) -> Self { WindowBounds::Windowed(Bounds::centered(None, size, cx)) } } impl Default for WindowOptions { fn default() -> Self { Self { window_bounds: None, titlebar: Some(TitlebarOptions { title: Default::default(), appears_transparent: Default::default(), traffic_light_position: Default::default(), }), focus: true, show: true, kind: WindowKind::Normal, is_movable: true, is_resizable: true, is_minimizable: true, display_id: None, window_background: WindowBackgroundAppearance::default(), app_id: None, window_min_size: None, window_decorations: None, tabbing_identifier: None, } } } /// The options that can be configured for a window's titlebar #[derive(Debug, Default)] pub struct TitlebarOptions { /// The initial title of the window pub title: Option, /// Should the default system titlebar be hidden to allow for a custom-drawn titlebar? (macOS and Windows only) /// Refer to [`WindowOptions::window_decorations`] on Linux pub appears_transparent: bool, /// The position of the macOS traffic light buttons pub traffic_light_position: Option>, } /// The kind of window to create #[derive(Clone, Debug, PartialEq, Eq)] pub enum WindowKind { /// A normal application window Normal, /// A window that appears above all other windows, usually used for alerts or popups /// use sparingly! PopUp, /// A floating window that appears on top of its parent window Floating, /// A Wayland LayerShell window, used to draw overlays or backgrounds for applications such as /// docks, notifications or wallpapers. #[cfg(all(target_os = "linux", feature = "wayland"))] LayerShell(layer_shell::LayerShellOptions), /// A window that appears on top of its parent window and blocks interaction with it /// until the modal window is closed Dialog, } /// The appearance of the window, as defined by the operating system. /// /// On macOS, this corresponds to named [`NSAppearance`](https://developer.apple.com/documentation/appkit/nsappearance) /// values. #[derive(Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum WindowAppearance { /// A light appearance. /// /// On macOS, this corresponds to the `aqua` appearance. #[default] Light, /// A light appearance with vibrant colors. /// /// On macOS, this corresponds to the `NSAppearanceNameVibrantLight` appearance. VibrantLight, /// A dark appearance. /// /// On macOS, this corresponds to the `darkAqua` appearance. Dark, /// A dark appearance with vibrant colors. /// /// On macOS, this corresponds to the `NSAppearanceNameVibrantDark` appearance. VibrantDark, } /// The appearance of the background of the window itself, when there is /// no content or the content is transparent. #[derive(Copy, Clone, Debug, Default, PartialEq)] pub enum WindowBackgroundAppearance { /// Opaque. /// /// This lets the window manager know that content behind this /// window does not need to be drawn. /// /// Actual color depends on the system and themes should define a fully /// opaque background color instead. #[default] Opaque, /// Plain alpha transparency. Transparent, /// Transparency, but the contents behind the window are blurred. /// /// Not always supported. Blurred, /// The Mica backdrop material, supported on Windows 11. MicaBackdrop, /// The Mica Alt backdrop material, supported on Windows 11. MicaAltBackdrop, } /// The text rendering mode to use for drawing glyphs. #[derive(Copy, Clone, Debug, Default, PartialEq, Eq)] pub enum TextRenderingMode { /// Use the platform's default text rendering mode. #[default] PlatformDefault, /// Use subpixel (ClearType-style) text rendering. Subpixel, /// Use grayscale text rendering. Grayscale, } /// The options that can be configured for a file dialog prompt #[derive(Clone, Debug)] pub struct PathPromptOptions { /// Should the prompt allow files to be selected? pub files: bool, /// Should the prompt allow directories to be selected? pub directories: bool, /// Should the prompt allow multiple files to be selected? pub multiple: bool, /// The prompt to show to a user when selecting a path pub prompt: Option, } /// What kind of prompt styling to show #[derive(Copy, Clone, Debug, PartialEq)] pub enum PromptLevel { /// A prompt that is shown when the user should be notified of something Info, /// A prompt that is shown when the user needs to be warned of a potential problem Warning, /// A prompt that is shown when a critical problem has occurred Critical, } /// Prompt Button #[derive(Clone, Debug, PartialEq)] pub enum PromptButton { /// Ok button Ok(SharedString), /// Cancel button Cancel(SharedString), /// Other button Other(SharedString), } impl PromptButton { /// Create a button with label pub fn new(label: impl Into) -> Self { PromptButton::Other(label.into()) } /// Create an Ok button pub fn ok(label: impl Into) -> Self { PromptButton::Ok(label.into()) } /// Create a Cancel button pub fn cancel(label: impl Into) -> Self { PromptButton::Cancel(label.into()) } /// Returns true if this button is a cancel button. #[allow(dead_code)] pub fn is_cancel(&self) -> bool { matches!(self, PromptButton::Cancel(_)) } /// Returns the label of the button pub fn label(&self) -> &SharedString { match self { PromptButton::Ok(label) => label, PromptButton::Cancel(label) => label, PromptButton::Other(label) => label, } } } impl From<&str> for PromptButton { fn from(value: &str) -> Self { match value.to_lowercase().as_str() { "ok" => PromptButton::Ok("Ok".into()), "cancel" => PromptButton::Cancel("Cancel".into()), _ => PromptButton::Other(SharedString::from(value.to_owned())), } } } /// The style of the cursor (pointer) #[derive(Copy, Clone, Default, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)] pub enum CursorStyle { /// The default cursor #[default] Arrow, /// A text input cursor /// corresponds to the CSS cursor value `text` IBeam, /// A crosshair cursor /// corresponds to the CSS cursor value `crosshair` Crosshair, /// A closed hand cursor /// corresponds to the CSS cursor value `grabbing` ClosedHand, /// An open hand cursor /// corresponds to the CSS cursor value `grab` OpenHand, /// A pointing hand cursor /// corresponds to the CSS cursor value `pointer` PointingHand, /// A resize left cursor /// corresponds to the CSS cursor value `w-resize` ResizeLeft, /// A resize right cursor /// corresponds to the CSS cursor value `e-resize` ResizeRight, /// A resize cursor to the left and right /// corresponds to the CSS cursor value `ew-resize` ResizeLeftRight, /// A resize up cursor /// corresponds to the CSS cursor value `n-resize` ResizeUp, /// A resize down cursor /// corresponds to the CSS cursor value `s-resize` ResizeDown, /// A resize cursor directing up and down /// corresponds to the CSS cursor value `ns-resize` ResizeUpDown, /// A resize cursor directing up-left and down-right /// corresponds to the CSS cursor value `nesw-resize` ResizeUpLeftDownRight, /// A resize cursor directing up-right and down-left /// corresponds to the CSS cursor value `nwse-resize` ResizeUpRightDownLeft, /// A cursor indicating that the item/column can be resized horizontally. /// corresponds to the CSS cursor value `col-resize` ResizeColumn, /// A cursor indicating that the item/row can be resized vertically. /// corresponds to the CSS cursor value `row-resize` ResizeRow, /// A text input cursor for vertical layout /// corresponds to the CSS cursor value `vertical-text` IBeamCursorForVerticalLayout, /// A cursor indicating that the operation is not allowed /// corresponds to the CSS cursor value `not-allowed` OperationNotAllowed, /// A cursor indicating that the operation will result in a link /// corresponds to the CSS cursor value `alias` DragLink, /// A cursor indicating that the operation will result in a copy /// corresponds to the CSS cursor value `copy` DragCopy, /// A cursor indicating that the operation will result in a context menu /// corresponds to the CSS cursor value `context-menu` ContextualMenu, /// Hide the cursor None, } /// A clipboard item that should be copied to the clipboard #[derive(Clone, Debug, Eq, PartialEq)] pub struct ClipboardItem { /// The entries in this clipboard item. pub entries: Vec, } /// Either a ClipboardString or a ClipboardImage #[derive(Clone, Debug, Eq, PartialEq)] pub enum ClipboardEntry { /// A string entry String(ClipboardString), /// An image entry Image(Image), /// A file entry ExternalPaths(crate::ExternalPaths), } impl ClipboardItem { /// Create a new ClipboardItem::String with no associated metadata pub fn new_string(text: String) -> Self { Self { entries: vec![ClipboardEntry::String(ClipboardString::new(text))], } } /// Create a new ClipboardItem::String with the given text and associated metadata pub fn new_string_with_metadata(text: String, metadata: String) -> Self { Self { entries: vec![ClipboardEntry::String(ClipboardString { text, metadata: Some(metadata), })], } } /// Create a new ClipboardItem::String with the given text and associated metadata pub fn new_string_with_json_metadata(text: String, metadata: T) -> Self { Self { entries: vec![ClipboardEntry::String( ClipboardString::new(text).with_json_metadata(metadata), )], } } /// Create a new ClipboardItem::Image with the given image with no associated metadata pub fn new_image(image: &Image) -> Self { Self { entries: vec![ClipboardEntry::Image(image.clone())], } } /// Concatenates together all the ClipboardString entries in the item. /// Returns None if there were no ClipboardString entries. pub fn text(&self) -> Option { let mut answer = String::new(); for entry in self.entries.iter() { if let ClipboardEntry::String(ClipboardString { text, metadata: _ }) = entry { answer.push_str(text); } } if answer.is_empty() { for entry in self.entries.iter() { if let ClipboardEntry::ExternalPaths(paths) = entry { for path in &paths.0 { use std::fmt::Write as _; _ = write!(answer, "{}", path.display()); } } } } if !answer.is_empty() { Some(answer) } else { None } } /// If this item is one ClipboardEntry::String, returns its metadata. #[cfg_attr(not(target_os = "windows"), allow(dead_code))] pub fn metadata(&self) -> Option<&String> { match self.entries().first() { Some(ClipboardEntry::String(clipboard_string)) if self.entries.len() == 1 => { clipboard_string.metadata.as_ref() } _ => None, } } /// Get the item's entries pub fn entries(&self) -> &[ClipboardEntry] { &self.entries } /// Get owned versions of the item's entries pub fn into_entries(self) -> impl Iterator { self.entries.into_iter() } } impl From for ClipboardEntry { fn from(value: ClipboardString) -> Self { Self::String(value) } } impl From for ClipboardEntry { fn from(value: String) -> Self { Self::from(ClipboardString::from(value)) } } impl From for ClipboardEntry { fn from(value: Image) -> Self { Self::Image(value) } } impl From for ClipboardItem { fn from(value: ClipboardEntry) -> Self { Self { entries: vec![value], } } } impl From for ClipboardItem { fn from(value: String) -> Self { Self::from(ClipboardEntry::from(value)) } } impl From for ClipboardItem { fn from(value: Image) -> Self { Self::from(ClipboardEntry::from(value)) } } /// One of the editor's supported image formats (e.g. PNG, JPEG) - used when dealing with images in the clipboard #[derive(Clone, Copy, Debug, Eq, PartialEq, EnumIter, Hash)] pub enum ImageFormat { // Sorted from most to least likely to be pasted into an editor, // which matters when we iterate through them trying to see if // clipboard content matches them. /// .png Png, /// .jpeg or .jpg Jpeg, /// .webp Webp, /// .gif Gif, /// .svg Svg, /// .bmp Bmp, /// .tif or .tiff Tiff, /// .ico Ico, } impl ImageFormat { /// Returns the mime type for the ImageFormat pub const fn mime_type(self) -> &'static str { match self { ImageFormat::Png => "image/png", ImageFormat::Jpeg => "image/jpeg", ImageFormat::Webp => "image/webp", ImageFormat::Gif => "image/gif", ImageFormat::Svg => "image/svg+xml", ImageFormat::Bmp => "image/bmp", ImageFormat::Tiff => "image/tiff", ImageFormat::Ico => "image/ico", } } /// Returns the ImageFormat for the given mime type pub fn from_mime_type(mime_type: &str) -> Option { match mime_type { "image/png" => Some(Self::Png), "image/jpeg" | "image/jpg" => Some(Self::Jpeg), "image/webp" => Some(Self::Webp), "image/gif" => Some(Self::Gif), "image/svg+xml" => Some(Self::Svg), "image/bmp" => Some(Self::Bmp), "image/tiff" | "image/tif" => Some(Self::Tiff), "image/ico" => Some(Self::Ico), _ => None, } } } /// An image, with a format and certain bytes #[derive(Clone, Debug, PartialEq, Eq)] pub struct Image { /// The image format the bytes represent (e.g. PNG) pub format: ImageFormat, /// The raw image bytes pub bytes: Vec, /// The unique ID for the image pub id: u64, } impl Hash for Image { fn hash(&self, state: &mut H) { state.write_u64(self.id); } } impl Image { /// An empty image containing no data pub fn empty() -> Self { Self::from_bytes(ImageFormat::Png, Vec::new()) } /// Create an image from a format and bytes pub fn from_bytes(format: ImageFormat, bytes: Vec) -> Self { Self { id: hash(&bytes), format, bytes, } } /// Get this image's ID pub fn id(&self) -> u64 { self.id } /// Use the GPUI `use_asset` API to make this image renderable pub fn use_render_image( self: Arc, window: &mut Window, cx: &mut App, ) -> Option> { ImageSource::Image(self) .use_data(None, window, cx) .and_then(|result| result.ok()) } /// Use the GPUI `get_asset` API to make this image renderable pub fn get_render_image( self: Arc, window: &mut Window, cx: &mut App, ) -> Option> { ImageSource::Image(self) .get_data(None, window, cx) .and_then(|result| result.ok()) } /// Use the GPUI `remove_asset` API to drop this image, if possible. pub fn remove_asset(self: Arc, cx: &mut App) { ImageSource::Image(self).remove_asset(cx); } /// Convert the clipboard image to an `ImageData` object. pub fn to_image_data(&self, svg_renderer: SvgRenderer) -> Result> { fn frames_for_image( bytes: &[u8], format: image::ImageFormat, ) -> Result> { let mut data = image::load_from_memory_with_format(bytes, format)?.into_rgba8(); // Convert from RGBA to BGRA. for pixel in data.chunks_exact_mut(4) { pixel.swap(0, 2); } Ok(SmallVec::from_elem(Frame::new(data), 1)) } let frames = match self.format { ImageFormat::Gif => { let decoder = GifDecoder::new(Cursor::new(&self.bytes))?; let mut frames = SmallVec::new(); for frame in decoder.into_frames() { let mut frame = frame?; // Convert from RGBA to BGRA. for pixel in frame.buffer_mut().chunks_exact_mut(4) { pixel.swap(0, 2); } frames.push(frame); } frames } ImageFormat::Png => frames_for_image(&self.bytes, image::ImageFormat::Png)?, ImageFormat::Jpeg => frames_for_image(&self.bytes, image::ImageFormat::Jpeg)?, ImageFormat::Webp => frames_for_image(&self.bytes, image::ImageFormat::WebP)?, ImageFormat::Bmp => frames_for_image(&self.bytes, image::ImageFormat::Bmp)?, ImageFormat::Tiff => frames_for_image(&self.bytes, image::ImageFormat::Tiff)?, ImageFormat::Ico => frames_for_image(&self.bytes, image::ImageFormat::Ico)?, ImageFormat::Svg => { return svg_renderer .render_single_frame(&self.bytes, 1.0) .map_err(Into::into); } }; Ok(Arc::new(RenderImage::new(frames))) } /// Get the format of the clipboard image pub fn format(&self) -> ImageFormat { self.format } /// Get the raw bytes of the clipboard image pub fn bytes(&self) -> &[u8] { self.bytes.as_slice() } } /// A clipboard item that should be copied to the clipboard #[derive(Clone, Debug, Eq, PartialEq)] pub struct ClipboardString { /// The text content. pub text: String, /// Optional metadata associated with this clipboard string. pub metadata: Option, } impl ClipboardString { /// Create a new clipboard string with the given text pub fn new(text: String) -> Self { Self { text, metadata: None, } } /// Return a new clipboard item with the metadata replaced by the given metadata, /// after serializing it as JSON. pub fn with_json_metadata(mut self, metadata: T) -> Self { self.metadata = Some(serde_json::to_string(&metadata).unwrap()); self } /// Get the text of the clipboard string pub fn text(&self) -> &String { &self.text } /// Get the owned text of the clipboard string pub fn into_text(self) -> String { self.text } /// Get the metadata of the clipboard string, formatted as JSON pub fn metadata_json(&self) -> Option where T: for<'a> Deserialize<'a>, { self.metadata .as_ref() .and_then(|m| serde_json::from_str(m).ok()) } #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))] /// Compute a hash of the given text for clipboard change detection. pub fn text_hash(text: &str) -> u64 { let mut hasher = SeaHasher::new(); text.hash(&mut hasher); hasher.finish() } } impl From for ClipboardString { fn from(value: String) -> Self { Self { text: value, metadata: None, } } } #[cfg(test)] mod image_tests { use super::*; use std::sync::Arc; #[test] fn test_svg_image_to_image_data_converts_to_bgra() { let image = Image::from_bytes( ImageFormat::Svg, br##" "## .to_vec(), ); let render_image = image.to_image_data(SvgRenderer::new(Arc::new(()))).unwrap(); let bytes = render_image.as_bytes(0).unwrap(); for pixel in bytes.chunks_exact(4) { assert_eq!(pixel, &[0xF8, 0xBD, 0x38, 0xFF]); } } } #[cfg(all(test, any(target_os = "linux", target_os = "freebsd")))] mod tests { use super::*; use std::collections::HashSet; #[test] fn test_window_button_layout_parse_standard() { let layout = WindowButtonLayout::parse("close,minimize:maximize").unwrap(); assert_eq!( layout.left, [ Some(WindowButton::Close), Some(WindowButton::Minimize), None ] ); assert_eq!(layout.right, [Some(WindowButton::Maximize), None, None]); } #[test] fn test_window_button_layout_parse_right_only() { let layout = WindowButtonLayout::parse("minimize,maximize,close").unwrap(); assert_eq!(layout.left, [None, None, None]); assert_eq!( layout.right, [ Some(WindowButton::Minimize), Some(WindowButton::Maximize), Some(WindowButton::Close) ] ); } #[test] fn test_window_button_layout_parse_left_only() { let layout = WindowButtonLayout::parse("close,minimize,maximize:").unwrap(); assert_eq!( layout.left, [ Some(WindowButton::Close), Some(WindowButton::Minimize), Some(WindowButton::Maximize) ] ); assert_eq!(layout.right, [None, None, None]); } #[test] fn test_window_button_layout_parse_with_whitespace() { let layout = WindowButtonLayout::parse(" close , minimize : maximize ").unwrap(); assert_eq!( layout.left, [ Some(WindowButton::Close), Some(WindowButton::Minimize), None ] ); assert_eq!(layout.right, [Some(WindowButton::Maximize), None, None]); } #[test] fn test_window_button_layout_parse_empty() { let layout = WindowButtonLayout::parse("").unwrap(); assert_eq!(layout.left, [None, None, None]); assert_eq!(layout.right, [None, None, None]); } #[test] fn test_window_button_layout_parse_intentionally_empty() { let layout = WindowButtonLayout::parse(":").unwrap(); assert_eq!(layout.left, [None, None, None]); assert_eq!(layout.right, [None, None, None]); } #[test] fn test_window_button_layout_parse_invalid_buttons() { let layout = WindowButtonLayout::parse("close,invalid,minimize:maximize,foo").unwrap(); assert_eq!( layout.left, [ Some(WindowButton::Close), Some(WindowButton::Minimize), None ] ); assert_eq!(layout.right, [Some(WindowButton::Maximize), None, None]); } #[test] fn test_window_button_layout_parse_deduplicates_same_side_buttons() { let layout = WindowButtonLayout::parse("close,close,minimize").unwrap(); assert_eq!( layout.right, [ Some(WindowButton::Close), Some(WindowButton::Minimize), None ] ); assert_eq!(layout.format(), ":close,minimize"); } #[test] fn test_window_button_layout_parse_deduplicates_buttons_across_sides() { let layout = WindowButtonLayout::parse("close:maximize,close,minimize").unwrap(); assert_eq!(layout.left, [Some(WindowButton::Close), None, None]); assert_eq!( layout.right, [ Some(WindowButton::Maximize), Some(WindowButton::Minimize), None ] ); let button_ids: Vec<_> = layout .left .iter() .chain(layout.right.iter()) .flatten() .map(WindowButton::id) .collect(); let unique_button_ids = button_ids.iter().copied().collect::>(); assert_eq!(unique_button_ids.len(), button_ids.len()); assert_eq!(layout.format(), "close:maximize,minimize"); } #[test] fn test_window_button_layout_parse_gnome_style() { let layout = WindowButtonLayout::parse("close").unwrap(); assert_eq!(layout.left, [None, None, None]); assert_eq!(layout.right, [Some(WindowButton::Close), None, None]); } #[test] fn test_window_button_layout_parse_elementary_style() { let layout = WindowButtonLayout::parse("close:maximize").unwrap(); assert_eq!(layout.left, [Some(WindowButton::Close), None, None]); assert_eq!(layout.right, [Some(WindowButton::Maximize), None, None]); } #[test] fn test_window_button_layout_round_trip() { let cases = [ "close:minimize,maximize", "minimize,maximize,close:", ":close", "close:", "close:maximize", ":", ]; for case in cases { let layout = WindowButtonLayout::parse(case).unwrap(); assert_eq!(layout.format(), case, "Round-trip failed for: {}", case); } } #[test] fn test_window_button_layout_linux_default() { let layout = WindowButtonLayout::linux_default(); assert_eq!(layout.left, [None, None, None]); assert_eq!( layout.right, [ Some(WindowButton::Minimize), Some(WindowButton::Maximize), Some(WindowButton::Close) ] ); let round_tripped = WindowButtonLayout::parse(&layout.format()).unwrap(); assert_eq!(round_tripped, layout); } #[test] fn test_window_button_layout_parse_all_invalid() { assert!(WindowButtonLayout::parse("asdfghjkl").is_err()); } }