// todo(linux): remove #![cfg_attr(target_os = "linux", allow(dead_code))] // todo(windows): remove #![cfg_attr(windows, allow(dead_code))] mod app_menu; mod keystroke; #[cfg(not(target_os = "macos"))] mod cosmic_text; #[cfg(target_os = "linux")] mod linux; #[cfg(target_os = "macos")] mod mac; #[cfg(any(target_os = "linux", target_os = "windows", feature = "macos-blade"))] mod blade; #[cfg(any(test, feature = "test-support"))] mod test; #[cfg(target_os = "windows")] mod windows; use crate::{ point, Action, AnyWindowHandle, AsyncWindowContext, BackgroundExecutor, Bounds, DevicePixels, DispatchEventResult, Font, FontId, FontMetrics, FontRun, ForegroundExecutor, GlyphId, Keymap, LineLayout, Pixels, PlatformInput, Point, RenderGlyphParams, RenderImageParams, RenderSvgParams, Scene, SharedString, Size, Task, TaskLabel, WindowContext, DEFAULT_WINDOW_SIZE, }; use anyhow::Result; use async_task::Runnable; use futures::channel::oneshot; use parking::Unparker; use raw_window_handle::{HasDisplayHandle, HasWindowHandle}; use seahash::SeaHasher; use serde::{Deserialize, Serialize}; use std::borrow::Cow; use std::hash::{Hash, Hasher}; use std::time::Duration; use std::{ fmt::{self, Debug}, ops::Range, path::{Path, PathBuf}, rc::Rc, sync::Arc, }; use uuid::Uuid; pub use app_menu::*; pub use keystroke::*; #[cfg(not(target_os = "macos"))] pub(crate) use cosmic_text::*; #[cfg(target_os = "linux")] pub(crate) use linux::*; #[cfg(target_os = "macos")] pub(crate) use mac::*; pub use semantic_version::SemanticVersion; #[cfg(any(test, feature = "test-support"))] pub(crate) use test::*; use time::UtcOffset; #[cfg(target_os = "windows")] pub(crate) use windows::*; #[cfg(target_os = "macos")] pub(crate) fn current_platform() -> Rc { Rc::new(MacPlatform::new()) } #[cfg(target_os = "linux")] pub(crate) fn current_platform() -> Rc { let wayland_display = std::env::var_os("WAYLAND_DISPLAY"); let x11_display = std::env::var_os("DISPLAY"); 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 { Rc::new(WaylandClient::new()) } else if use_x11 { Rc::new(X11Client::new()) } else { Rc::new(HeadlessClient::new()) } } // todo("windows") #[cfg(target_os = "windows")] pub(crate) fn current_platform() -> Rc { Rc::new(WindowsPlatform::new()) } pub(crate) 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 open_window( &self, handle: AnyWindowHandle, options: WindowParams, ) -> Box; /// Returns the appearance of the application's windows. fn window_appearance(&self) -> WindowAppearance; 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) -> oneshot::Receiver>; fn reveal_path(&self, path: &Path); fn on_quit(&self, callback: Box); fn on_reopen(&self, callback: Box); fn set_menus(&self, menus: Vec, keymap: &Keymap); fn add_recent_document(&self, _path: &Path) {} 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 os_name(&self) -> &'static str; fn os_version(&self) -> Result; fn app_version(&self) -> Result; fn app_path(&self) -> Result; fn local_timezone(&self) -> UtcOffset; fn path_for_auxiliary_executable(&self, name: &str) -> Result; fn set_cursor_style(&self, style: CursorStyle); fn should_auto_hide_scrollbars(&self) -> bool; 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 write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Task>; fn read_credentials(&self, url: &str) -> Task)>>>; fn delete_credentials(&self, url: &str) -> Task>; } /// A handle to a platform's display, e.g. a monitor or laptop screen. pub trait PlatformDisplay: Send + Sync + 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 default bounds for this display to place a window fn default_bounds(&self) -> Bounds { let center = self.bounds().center(); let offset = DEFAULT_WINDOW_SIZE / 2; let origin = point(center.x - offset.width, center.y - offset.height); Bounds::new(origin, DEFAULT_WINDOW_SIZE) } } /// An opaque identifier for a hardware display #[derive(PartialEq, Eq, Hash, Copy, Clone)] pub struct DisplayId(pub(crate) u32); impl Debug for DisplayId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "DisplayId({})", self.0) } } unsafe impl Send for DisplayId {} pub(crate) trait PlatformWindow: HasWindowHandle + HasDisplayHandle { fn bounds(&self) -> Bounds; fn is_maximized(&self) -> bool; fn window_bounds(&self) -> WindowBounds; fn content_size(&self) -> Size; fn scale_factor(&self) -> f32; fn appearance(&self) -> WindowAppearance; fn display(&self) -> Rc; fn mouse_position(&self) -> Point; fn modifiers(&self) -> Modifiers; 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: &[&str], ) -> Option>; fn activate(&self); fn is_active(&self) -> bool; fn set_title(&mut self, title: &str); fn set_app_id(&mut self, app_id: &str); fn set_background_appearance(&mut self, background_appearance: WindowBackgroundAppearance); fn set_edited(&mut self, edited: bool); fn show_character_palette(&self); 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_resize(&self, callback: Box, f32)>); fn on_moved(&self, callback: Box); fn on_should_close(&self, callback: Box bool>); fn on_close(&self, callback: Box); fn on_appearance_changed(&self, callback: Box); fn draw(&self, scene: &Scene); fn completed_frame(&self) {} fn sprite_atlas(&self) -> Arc; #[cfg(target_os = "windows")] fn get_raw_handle(&self) -> windows::HWND; fn show_window_menu(&self, position: Point); fn start_system_move(&self); fn should_render_window_controls(&self) -> bool; #[cfg(any(test, feature = "test-support"))] fn as_test(&mut self) -> Option<&mut TestWindow> { None } } /// 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 is_main_thread(&self) -> bool; fn dispatch(&self, runnable: Runnable, label: Option); fn dispatch_on_main_thread(&self, runnable: Runnable); fn dispatch_after(&self, duration: Duration, runnable: Runnable); fn park(&self, timeout: Option) -> bool; fn unparker(&self) -> Unparker; #[cfg(any(test, feature = "test-support"))] fn as_test(&self) -> Option<&TestDispatcher> { None } } pub(crate) trait PlatformTextSystem: Send + Sync { fn add_fonts(&self, fonts: Vec>) -> Result<()>; fn all_font_names(&self) -> Vec; fn all_font_families(&self) -> Vec; fn font_id(&self, descriptor: &Font) -> Result; fn font_metrics(&self, font_id: FontId) -> FontMetrics; fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> Result>; fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> Result>; fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option; fn glyph_raster_bounds(&self, params: &RenderGlyphParams) -> Result>; fn rasterize_glyph( &self, params: &RenderGlyphParams, raster_bounds: Bounds, ) -> Result<(Size, Vec)>; fn layout_line(&self, text: &str, font_size: Pixels, runs: &[FontRun]) -> LineLayout; } /// Basic metadata about the current application and operating system. #[derive(Clone, Debug)] pub struct AppMetadata { /// The name of the current operating system pub os_name: &'static str, /// The operating system's version pub os_version: Option, /// The current version of the application pub app_version: Option, } #[derive(PartialEq, Eq, Hash, Clone)] pub(crate) enum AtlasKey { Glyph(RenderGlyphParams), Svg(RenderSvgParams), Image(RenderImageParams), } impl AtlasKey { pub(crate) fn texture_kind(&self) -> AtlasTextureKind { match self { AtlasKey::Glyph(params) => { if params.is_emoji { AtlasTextureKind::Polychrome } 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) } } pub(crate) trait PlatformAtlas: Send + Sync { fn get_or_insert_with<'a>( &self, key: &AtlasKey, build: &mut dyn FnMut() -> Result<(Size, Cow<'a, [u8]>)>, ) -> Result; } #[derive(Clone, Debug, PartialEq, Eq)] #[repr(C)] pub(crate) struct AtlasTile { pub(crate) texture_id: AtlasTextureId, pub(crate) tile_id: TileId, pub(crate) padding: u32, pub(crate) bounds: Bounds, } #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub(crate) struct AtlasTextureId { // We use u32 instead of usize for Metal Shader Language compatibility pub(crate) index: u32, pub(crate) kind: AtlasTextureKind, } #[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)] #[repr(C)] pub(crate) enum AtlasTextureKind { Monochrome = 0, Polychrome = 1, Path = 2, } #[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)] #[repr(C)] pub(crate) struct TileId(pub(crate) 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) } } pub(crate) struct PlatformInputHandler { cx: AsyncWindowContext, handler: Box, } impl PlatformInputHandler { pub fn new(cx: AsyncWindowContext, handler: Box) -> Self { Self { cx, handler } } fn selected_text_range(&mut self) -> Option> { self.cx .update(|cx| self.handler.selected_text_range(cx)) .ok() .flatten() } fn marked_text_range(&mut self) -> Option> { self.cx .update(|cx| self.handler.marked_text_range(cx)) .ok() .flatten() } fn text_for_range(&mut self, range_utf16: Range) -> Option { self.cx .update(|cx| self.handler.text_for_range(range_utf16, cx)) .ok() .flatten() } fn replace_text_in_range(&mut self, replacement_range: Option>, text: &str) { self.cx .update(|cx| { self.handler .replace_text_in_range(replacement_range, text, cx); }) .ok(); } fn replace_and_mark_text_in_range( &mut self, range_utf16: Option>, new_text: &str, new_selected_range: Option>, ) { self.cx .update(|cx| { self.handler.replace_and_mark_text_in_range( range_utf16, new_text, new_selected_range, cx, ) }) .ok(); } fn unmark_text(&mut self) { self.cx.update(|cx| self.handler.unmark_text(cx)).ok(); } fn bounds_for_range(&mut self, range_utf16: Range) -> Option> { self.cx .update(|cx| self.handler.bounds_for_range(range_utf16, cx)) .ok() .flatten() } pub(crate) fn dispatch_input(&mut self, input: &str, cx: &mut WindowContext) { self.handler.replace_text_in_range(None, input, cx); } } /// 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, cx: &mut WindowContext) -> 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, cx: &mut WindowContext) -> 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, cx: &mut WindowContext, ) -> 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, cx: &mut WindowContext, ); /// Replace the text in the given document range with the given text, /// and mark the given text as part of 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>, cx: &mut WindowContext, ); /// 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, cx: &mut WindowContext); /// 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, cx: &mut WindowContext, ) -> Option>; } /// 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, /// 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, } /// The variables that can be configured when creating a new window #[derive(Debug)] pub(crate) struct WindowParams { pub bounds: Bounds, /// The titlebar configuration of the window pub titlebar: Option, /// The kind of window to create pub kind: WindowKind, /// Whether the window should be movable by the user pub is_movable: bool, pub focus: bool, pub show: bool, pub display_id: Option, pub window_background: WindowBackgroundAppearance, } /// 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, } } } 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, display_id: None, window_background: WindowBackgroundAppearance::default(), app_id: 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, /// Whether the titlebar should appear transparent pub appears_transparent: bool, /// The position of the macOS traffic light buttons pub traffic_light_position: Option>, } /// The kind of window to create #[derive(Copy, 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, } /// 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)] pub enum WindowAppearance { /// A light appearance. /// /// On macOS, this corresponds to the `aqua` appearance. 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, } impl Default for WindowAppearance { fn default() -> Self { Self::Light } } /// 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 options that can be configured for a file dialog prompt #[derive(Copy, 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, } /// 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, } /// The style of the cursor (pointer) #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)] pub enum CursorStyle { /// The default cursor 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 cursor indicating that the item/column can be resized horizontally. /// corresponds to the CSS curosr value `col-resize` ResizeColumn, /// A cursor indicating that the item/row can be resized vertically. /// corresponds to the CSS curosr value `row-resize` ResizeRow, /// A cursor indicating that something will disappear if moved here /// Does not correspond to a CSS cursor value DisappearingItem, /// 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, } impl Default for CursorStyle { fn default() -> Self { Self::Arrow } } /// A clipboard item that should be copied to the clipboard #[derive(Clone, Debug, Eq, PartialEq)] pub struct ClipboardItem { pub(crate) text: String, pub(crate) metadata: Option, } impl ClipboardItem { /// Create a new clipboard item with the given text pub fn new(text: String) -> Self { Self { text, metadata: None, } } /// Create a new clipboard item with the given text and metadata pub fn with_metadata(mut self, metadata: T) -> Self { self.metadata = Some(serde_json::to_string(&metadata).unwrap()); self } /// Get the text of the clipboard item pub fn text(&self) -> &String { &self.text } /// Get the metadata of the clipboard item pub fn metadata(&self) -> Option where T: for<'a> Deserialize<'a>, { self.metadata .as_ref() .and_then(|m| serde_json::from_str(m).ok()) } pub(crate) fn text_hash(text: &str) -> u64 { let mut hasher = SeaHasher::new(); text.hash(&mut hasher); hasher.finish() } }