1mod app_menu;
2mod keyboard;
3mod keystroke;
4
5#[cfg(any(target_os = "linux", target_os = "freebsd"))]
6mod linux;
7
8#[cfg(target_os = "macos")]
9mod mac;
10
11#[cfg(any(
12 all(
13 any(target_os = "linux", target_os = "freebsd"),
14 any(feature = "x11", feature = "wayland")
15 ),
16 all(target_os = "macos", feature = "macos-blade")
17))]
18mod blade;
19
20#[cfg(any(test, feature = "test-support"))]
21mod test;
22
23#[cfg(target_os = "windows")]
24mod windows;
25
26#[cfg(all(
27 feature = "screen-capture",
28 any(
29 target_os = "windows",
30 all(
31 any(target_os = "linux", target_os = "freebsd"),
32 any(feature = "wayland", feature = "x11"),
33 )
34 )
35))]
36pub(crate) mod scap_screen_capture;
37
38use crate::{
39 Action, AnyWindowHandle, App, AsyncWindowContext, BackgroundExecutor, Bounds,
40 DEFAULT_WINDOW_SIZE, DevicePixels, DispatchEventResult, Font, FontId, FontMetrics, FontRun,
41 ForegroundExecutor, GlyphId, GpuSpecs, ImageSource, Keymap, LineLayout, Pixels, PlatformInput,
42 Point, Priority, RealtimePriority, RenderGlyphParams, RenderImage, RenderImageParams,
43 RenderSvgParams, Scene, ShapedGlyph, ShapedRun, SharedString, Size, SvgRenderer,
44 SystemWindowTab, Task, TaskLabel, TaskTiming, ThreadTaskTimings, Window, WindowControlArea,
45 hash, point, px, size,
46};
47use anyhow::Result;
48use async_task::Runnable;
49use futures::channel::oneshot;
50use image::codecs::gif::GifDecoder;
51use image::{AnimationDecoder as _, Frame};
52use raw_window_handle::{HasDisplayHandle, HasWindowHandle};
53use schemars::JsonSchema;
54use seahash::SeaHasher;
55use serde::{Deserialize, Serialize};
56use smallvec::SmallVec;
57use std::borrow::Cow;
58use std::hash::{Hash, Hasher};
59use std::io::Cursor;
60use std::ops;
61use std::time::{Duration, Instant};
62use std::{
63 fmt::{self, Debug},
64 ops::Range,
65 path::{Path, PathBuf},
66 rc::Rc,
67 sync::Arc,
68};
69use strum::EnumIter;
70use uuid::Uuid;
71
72pub use app_menu::*;
73pub use keyboard::*;
74pub use keystroke::*;
75
76#[cfg(any(target_os = "linux", target_os = "freebsd"))]
77pub(crate) use linux::*;
78#[cfg(target_os = "macos")]
79pub(crate) use mac::*;
80#[cfg(any(test, feature = "test-support"))]
81pub(crate) use test::*;
82#[cfg(target_os = "windows")]
83pub(crate) use windows::*;
84
85#[cfg(all(target_os = "linux", feature = "wayland"))]
86pub use linux::layer_shell;
87
88#[cfg(any(test, feature = "test-support"))]
89pub use test::{TestDispatcher, TestScreenCaptureSource, TestScreenCaptureStream};
90
91/// Returns a background executor for the current platform.
92pub fn background_executor() -> BackgroundExecutor {
93 current_platform(true).background_executor()
94}
95
96#[cfg(target_os = "macos")]
97pub(crate) fn current_platform(headless: bool) -> Rc<dyn Platform> {
98 Rc::new(MacPlatform::new(headless))
99}
100
101#[cfg(any(target_os = "linux", target_os = "freebsd"))]
102pub(crate) fn current_platform(headless: bool) -> Rc<dyn Platform> {
103 #[cfg(feature = "x11")]
104 use anyhow::Context as _;
105
106 if headless {
107 return Rc::new(HeadlessClient::new());
108 }
109
110 match guess_compositor() {
111 #[cfg(feature = "wayland")]
112 "Wayland" => Rc::new(WaylandClient::new()),
113
114 #[cfg(feature = "x11")]
115 "X11" => Rc::new(
116 X11Client::new()
117 .context("Failed to initialize X11 client.")
118 .unwrap(),
119 ),
120
121 "Headless" => Rc::new(HeadlessClient::new()),
122 _ => unreachable!(),
123 }
124}
125
126#[cfg(target_os = "windows")]
127pub(crate) fn current_platform(_headless: bool) -> Rc<dyn Platform> {
128 Rc::new(
129 WindowsPlatform::new()
130 .inspect_err(|err| show_error("Failed to launch", err.to_string()))
131 .unwrap(),
132 )
133}
134
135/// Return which compositor we're guessing we'll use.
136/// Does not attempt to connect to the given compositor
137#[cfg(any(target_os = "linux", target_os = "freebsd"))]
138#[inline]
139pub fn guess_compositor() -> &'static str {
140 if std::env::var_os("ZED_HEADLESS").is_some() {
141 return "Headless";
142 }
143
144 #[cfg(feature = "wayland")]
145 let wayland_display = std::env::var_os("WAYLAND_DISPLAY");
146 #[cfg(not(feature = "wayland"))]
147 let wayland_display: Option<std::ffi::OsString> = None;
148
149 #[cfg(feature = "x11")]
150 let x11_display = std::env::var_os("DISPLAY");
151 #[cfg(not(feature = "x11"))]
152 let x11_display: Option<std::ffi::OsString> = None;
153
154 let use_wayland = wayland_display.is_some_and(|display| !display.is_empty());
155 let use_x11 = x11_display.is_some_and(|display| !display.is_empty());
156
157 if use_wayland {
158 "Wayland"
159 } else if use_x11 {
160 "X11"
161 } else {
162 "Headless"
163 }
164}
165
166pub(crate) trait Platform: 'static {
167 fn background_executor(&self) -> BackgroundExecutor;
168 fn foreground_executor(&self) -> ForegroundExecutor;
169 fn text_system(&self) -> Arc<dyn PlatformTextSystem>;
170
171 fn run(&self, on_finish_launching: Box<dyn 'static + FnOnce()>);
172 fn quit(&self);
173 fn restart(&self, binary_path: Option<PathBuf>);
174 fn activate(&self, ignoring_other_apps: bool);
175 fn hide(&self);
176 fn hide_other_apps(&self);
177 fn unhide_other_apps(&self);
178
179 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>>;
180 fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>>;
181 fn active_window(&self) -> Option<AnyWindowHandle>;
182 fn window_stack(&self) -> Option<Vec<AnyWindowHandle>> {
183 None
184 }
185
186 #[cfg(feature = "screen-capture")]
187 fn is_screen_capture_supported(&self) -> bool;
188 #[cfg(not(feature = "screen-capture"))]
189 fn is_screen_capture_supported(&self) -> bool {
190 false
191 }
192 #[cfg(feature = "screen-capture")]
193 fn screen_capture_sources(&self)
194 -> oneshot::Receiver<Result<Vec<Rc<dyn ScreenCaptureSource>>>>;
195 #[cfg(not(feature = "screen-capture"))]
196 fn screen_capture_sources(
197 &self,
198 ) -> oneshot::Receiver<anyhow::Result<Vec<Rc<dyn ScreenCaptureSource>>>> {
199 let (sources_tx, sources_rx) = oneshot::channel();
200 sources_tx
201 .send(Err(anyhow::anyhow!(
202 "gpui was compiled without the screen-capture feature"
203 )))
204 .ok();
205 sources_rx
206 }
207
208 fn open_window(
209 &self,
210 handle: AnyWindowHandle,
211 options: WindowParams,
212 ) -> anyhow::Result<Box<dyn PlatformWindow>>;
213
214 /// Returns the appearance of the application's windows.
215 fn window_appearance(&self) -> WindowAppearance;
216
217 fn open_url(&self, url: &str);
218 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>);
219 fn register_url_scheme(&self, url: &str) -> Task<Result<()>>;
220
221 fn prompt_for_paths(
222 &self,
223 options: PathPromptOptions,
224 ) -> oneshot::Receiver<Result<Option<Vec<PathBuf>>>>;
225 fn prompt_for_new_path(
226 &self,
227 directory: &Path,
228 suggested_name: Option<&str>,
229 ) -> oneshot::Receiver<Result<Option<PathBuf>>>;
230 fn can_select_mixed_files_and_dirs(&self) -> bool;
231 fn reveal_path(&self, path: &Path);
232 fn open_with_system(&self, path: &Path);
233
234 fn on_quit(&self, callback: Box<dyn FnMut()>);
235 fn on_reopen(&self, callback: Box<dyn FnMut()>);
236
237 fn set_menus(&self, menus: Vec<Menu>, keymap: &Keymap);
238 fn get_menus(&self) -> Option<Vec<OwnedMenu>> {
239 None
240 }
241
242 fn set_dock_menu(&self, menu: Vec<MenuItem>, keymap: &Keymap);
243 fn perform_dock_menu_action(&self, _action: usize) {}
244 fn add_recent_document(&self, _path: &Path) {}
245 fn update_jump_list(
246 &self,
247 _menus: Vec<MenuItem>,
248 _entries: Vec<SmallVec<[PathBuf; 2]>>,
249 ) -> Vec<SmallVec<[PathBuf; 2]>> {
250 Vec::new()
251 }
252 fn on_app_menu_action(&self, callback: Box<dyn FnMut(&dyn Action)>);
253 fn on_will_open_app_menu(&self, callback: Box<dyn FnMut()>);
254 fn on_validate_app_menu_command(&self, callback: Box<dyn FnMut(&dyn Action) -> bool>);
255
256 fn compositor_name(&self) -> &'static str {
257 ""
258 }
259 fn app_path(&self) -> Result<PathBuf>;
260 fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf>;
261
262 fn set_cursor_style(&self, style: CursorStyle);
263 fn should_auto_hide_scrollbars(&self) -> bool;
264
265 fn read_from_clipboard(&self) -> Option<ClipboardItem>;
266 fn write_to_clipboard(&self, item: ClipboardItem);
267
268 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
269 fn read_from_primary(&self) -> Option<ClipboardItem>;
270 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
271 fn write_to_primary(&self, item: ClipboardItem);
272
273 #[cfg(target_os = "macos")]
274 fn read_from_find_pasteboard(&self) -> Option<ClipboardItem>;
275 #[cfg(target_os = "macos")]
276 fn write_to_find_pasteboard(&self, item: ClipboardItem);
277
278 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Task<Result<()>>;
279 fn read_credentials(&self, url: &str) -> Task<Result<Option<(String, Vec<u8>)>>>;
280 fn delete_credentials(&self, url: &str) -> Task<Result<()>>;
281
282 fn keyboard_layout(&self) -> Box<dyn PlatformKeyboardLayout>;
283 fn keyboard_mapper(&self) -> Rc<dyn PlatformKeyboardMapper>;
284 fn on_keyboard_layout_change(&self, callback: Box<dyn FnMut()>);
285}
286
287/// A handle to a platform's display, e.g. a monitor or laptop screen.
288pub trait PlatformDisplay: Send + Sync + Debug {
289 /// Get the ID for this display
290 fn id(&self) -> DisplayId;
291
292 /// Returns a stable identifier for this display that can be persisted and used
293 /// across system restarts.
294 fn uuid(&self) -> Result<Uuid>;
295
296 /// Get the bounds for this display
297 fn bounds(&self) -> Bounds<Pixels>;
298
299 /// Get the visible bounds for this display, excluding taskbar/dock areas.
300 /// This is the usable area where windows can be placed without being obscured.
301 /// Defaults to the full display bounds if not overridden.
302 fn visible_bounds(&self) -> Bounds<Pixels> {
303 self.bounds()
304 }
305
306 /// Get the default bounds for this display to place a window
307 fn default_bounds(&self) -> Bounds<Pixels> {
308 let bounds = self.bounds();
309 let center = bounds.center();
310 let clipped_window_size = DEFAULT_WINDOW_SIZE.min(&bounds.size);
311
312 let offset = clipped_window_size / 2.0;
313 let origin = point(center.x - offset.width, center.y - offset.height);
314 Bounds::new(origin, clipped_window_size)
315 }
316}
317
318/// Metadata for a given [ScreenCaptureSource]
319#[derive(Clone)]
320pub struct SourceMetadata {
321 /// Opaque identifier of this screen.
322 pub id: u64,
323 /// Human-readable label for this source.
324 pub label: Option<SharedString>,
325 /// Whether this source is the main display.
326 pub is_main: Option<bool>,
327 /// Video resolution of this source.
328 pub resolution: Size<DevicePixels>,
329}
330
331/// A source of on-screen video content that can be captured.
332pub trait ScreenCaptureSource {
333 /// Returns metadata for this source.
334 fn metadata(&self) -> Result<SourceMetadata>;
335
336 /// Start capture video from this source, invoking the given callback
337 /// with each frame.
338 fn stream(
339 &self,
340 foreground_executor: &ForegroundExecutor,
341 frame_callback: Box<dyn Fn(ScreenCaptureFrame) + Send>,
342 ) -> oneshot::Receiver<Result<Box<dyn ScreenCaptureStream>>>;
343}
344
345/// A video stream captured from a screen.
346pub trait ScreenCaptureStream {
347 /// Returns metadata for this source.
348 fn metadata(&self) -> Result<SourceMetadata>;
349}
350
351/// A frame of video captured from a screen.
352pub struct ScreenCaptureFrame(pub PlatformScreenCaptureFrame);
353
354/// An opaque identifier for a hardware display
355#[derive(PartialEq, Eq, Hash, Copy, Clone)]
356pub struct DisplayId(pub(crate) u32);
357
358impl From<DisplayId> for u32 {
359 fn from(id: DisplayId) -> Self {
360 id.0
361 }
362}
363
364impl Debug for DisplayId {
365 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
366 write!(f, "DisplayId({})", self.0)
367 }
368}
369
370/// Which part of the window to resize
371#[derive(Debug, Clone, Copy, PartialEq, Eq)]
372pub enum ResizeEdge {
373 /// The top edge
374 Top,
375 /// The top right corner
376 TopRight,
377 /// The right edge
378 Right,
379 /// The bottom right corner
380 BottomRight,
381 /// The bottom edge
382 Bottom,
383 /// The bottom left corner
384 BottomLeft,
385 /// The left edge
386 Left,
387 /// The top left corner
388 TopLeft,
389}
390
391/// A type to describe the appearance of a window
392#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)]
393pub enum WindowDecorations {
394 #[default]
395 /// Server side decorations
396 Server,
397 /// Client side decorations
398 Client,
399}
400
401/// A type to describe how this window is currently configured
402#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)]
403pub enum Decorations {
404 /// The window is configured to use server side decorations
405 #[default]
406 Server,
407 /// The window is configured to use client side decorations
408 Client {
409 /// The edge tiling state
410 tiling: Tiling,
411 },
412}
413
414/// What window controls this platform supports
415#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
416pub struct WindowControls {
417 /// Whether this platform supports fullscreen
418 pub fullscreen: bool,
419 /// Whether this platform supports maximize
420 pub maximize: bool,
421 /// Whether this platform supports minimize
422 pub minimize: bool,
423 /// Whether this platform supports a window menu
424 pub window_menu: bool,
425}
426
427impl Default for WindowControls {
428 fn default() -> Self {
429 // Assume that we can do anything, unless told otherwise
430 Self {
431 fullscreen: true,
432 maximize: true,
433 minimize: true,
434 window_menu: true,
435 }
436 }
437}
438
439/// A type to describe which sides of the window are currently tiled in some way
440#[derive(Debug, Copy, Clone, Eq, PartialEq, Hash, Default)]
441pub struct Tiling {
442 /// Whether the top edge is tiled
443 pub top: bool,
444 /// Whether the left edge is tiled
445 pub left: bool,
446 /// Whether the right edge is tiled
447 pub right: bool,
448 /// Whether the bottom edge is tiled
449 pub bottom: bool,
450}
451
452impl Tiling {
453 /// Initializes a [`Tiling`] type with all sides tiled
454 pub fn tiled() -> Self {
455 Self {
456 top: true,
457 left: true,
458 right: true,
459 bottom: true,
460 }
461 }
462
463 /// Whether any edge is tiled
464 pub fn is_tiled(&self) -> bool {
465 self.top || self.left || self.right || self.bottom
466 }
467}
468
469#[derive(Debug, Copy, Clone, Eq, PartialEq, Default)]
470pub(crate) struct RequestFrameOptions {
471 pub(crate) require_presentation: bool,
472 /// Force refresh of all rendering states when true
473 pub(crate) force_render: bool,
474}
475
476pub(crate) trait PlatformWindow: HasWindowHandle + HasDisplayHandle {
477 fn bounds(&self) -> Bounds<Pixels>;
478 fn is_maximized(&self) -> bool;
479 fn window_bounds(&self) -> WindowBounds;
480 fn content_size(&self) -> Size<Pixels>;
481 fn resize(&mut self, size: Size<Pixels>);
482 fn scale_factor(&self) -> f32;
483 fn appearance(&self) -> WindowAppearance;
484 fn display(&self) -> Option<Rc<dyn PlatformDisplay>>;
485 fn mouse_position(&self) -> Point<Pixels>;
486 fn modifiers(&self) -> Modifiers;
487 fn capslock(&self) -> Capslock;
488 fn set_input_handler(&mut self, input_handler: PlatformInputHandler);
489 fn take_input_handler(&mut self) -> Option<PlatformInputHandler>;
490 fn prompt(
491 &self,
492 level: PromptLevel,
493 msg: &str,
494 detail: Option<&str>,
495 answers: &[PromptButton],
496 ) -> Option<oneshot::Receiver<usize>>;
497 fn activate(&self);
498 fn is_active(&self) -> bool;
499 fn is_hovered(&self) -> bool;
500 fn set_title(&mut self, title: &str);
501 fn set_background_appearance(&self, background_appearance: WindowBackgroundAppearance);
502 fn minimize(&self);
503 fn zoom(&self);
504 fn toggle_fullscreen(&self);
505 fn is_fullscreen(&self) -> bool;
506 fn on_request_frame(&self, callback: Box<dyn FnMut(RequestFrameOptions)>);
507 fn on_input(&self, callback: Box<dyn FnMut(PlatformInput) -> DispatchEventResult>);
508 fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>);
509 fn on_hover_status_change(&self, callback: Box<dyn FnMut(bool)>);
510 fn on_resize(&self, callback: Box<dyn FnMut(Size<Pixels>, f32)>);
511 fn on_moved(&self, callback: Box<dyn FnMut()>);
512 fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>);
513 fn on_hit_test_window_control(&self, callback: Box<dyn FnMut() -> Option<WindowControlArea>>);
514 fn on_close(&self, callback: Box<dyn FnOnce()>);
515 fn on_appearance_changed(&self, callback: Box<dyn FnMut()>);
516 fn draw(&self, scene: &Scene);
517 fn completed_frame(&self) {}
518 fn sprite_atlas(&self) -> Arc<dyn PlatformAtlas>;
519
520 // macOS specific methods
521 fn get_title(&self) -> String {
522 String::new()
523 }
524 fn tabbed_windows(&self) -> Option<Vec<SystemWindowTab>> {
525 None
526 }
527 fn tab_bar_visible(&self) -> bool {
528 false
529 }
530 fn set_edited(&mut self, _edited: bool) {}
531 fn show_character_palette(&self) {}
532 fn titlebar_double_click(&self) {}
533 fn on_move_tab_to_new_window(&self, _callback: Box<dyn FnMut()>) {}
534 fn on_merge_all_windows(&self, _callback: Box<dyn FnMut()>) {}
535 fn on_select_previous_tab(&self, _callback: Box<dyn FnMut()>) {}
536 fn on_select_next_tab(&self, _callback: Box<dyn FnMut()>) {}
537 fn on_toggle_tab_bar(&self, _callback: Box<dyn FnMut()>) {}
538 fn merge_all_windows(&self) {}
539 fn move_tab_to_new_window(&self) {}
540 fn toggle_window_tab_overview(&self) {}
541 fn set_tabbing_identifier(&self, _identifier: Option<String>) {}
542
543 #[cfg(target_os = "windows")]
544 fn get_raw_handle(&self) -> windows::HWND;
545
546 // Linux specific methods
547 fn inner_window_bounds(&self) -> WindowBounds {
548 self.window_bounds()
549 }
550 fn request_decorations(&self, _decorations: WindowDecorations) {}
551 fn show_window_menu(&self, _position: Point<Pixels>) {}
552 fn start_window_move(&self) {}
553 fn start_window_resize(&self, _edge: ResizeEdge) {}
554 fn window_decorations(&self) -> Decorations {
555 Decorations::Server
556 }
557 fn set_app_id(&mut self, _app_id: &str) {}
558 fn map_window(&mut self) -> anyhow::Result<()> {
559 Ok(())
560 }
561 fn window_controls(&self) -> WindowControls {
562 WindowControls::default()
563 }
564 fn set_client_inset(&self, _inset: Pixels) {}
565 fn gpu_specs(&self) -> Option<GpuSpecs>;
566
567 fn update_ime_position(&self, _bounds: Bounds<Pixels>);
568
569 #[cfg(any(test, feature = "test-support"))]
570 fn as_test(&mut self) -> Option<&mut TestWindow> {
571 None
572 }
573}
574
575/// This type is public so that our test macro can generate and use it, but it should not
576/// be considered part of our public API.
577#[doc(hidden)]
578pub struct RunnableMeta {
579 /// Location of the runnable
580 pub location: &'static core::panic::Location<'static>,
581 /// Weak reference to check if the app is still alive before running this task
582 pub app: Option<std::sync::Weak<()>>,
583}
584
585impl std::fmt::Debug for RunnableMeta {
586 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
587 f.debug_struct("RunnableMeta")
588 .field("location", &self.location)
589 .field("app_alive", &self.is_app_alive())
590 .finish()
591 }
592}
593
594impl RunnableMeta {
595 /// Returns true if the app is still alive (or if no app tracking is configured).
596 pub fn is_app_alive(&self) -> bool {
597 match &self.app {
598 Some(weak) => weak.strong_count() > 0,
599 None => true,
600 }
601 }
602}
603
604#[doc(hidden)]
605pub enum RunnableVariant {
606 Meta(Runnable<RunnableMeta>),
607 Compat(Runnable),
608}
609
610/// This type is public so that our test macro can generate and use it, but it should not
611/// be considered part of our public API.
612#[doc(hidden)]
613pub trait PlatformDispatcher: Send + Sync {
614 fn get_all_timings(&self) -> Vec<ThreadTaskTimings>;
615 fn get_current_thread_timings(&self) -> Vec<TaskTiming>;
616 fn is_main_thread(&self) -> bool;
617 fn dispatch(&self, runnable: RunnableVariant, label: Option<TaskLabel>, priority: Priority);
618 fn dispatch_on_main_thread(&self, runnable: RunnableVariant, priority: Priority);
619 fn dispatch_after(&self, duration: Duration, runnable: RunnableVariant);
620 fn spawn_realtime(&self, priority: RealtimePriority, f: Box<dyn FnOnce() + Send>);
621
622 fn now(&self) -> Instant {
623 Instant::now()
624 }
625
626 #[cfg(any(test, feature = "test-support"))]
627 fn as_test(&self) -> Option<&TestDispatcher> {
628 None
629 }
630}
631
632pub(crate) trait PlatformTextSystem: Send + Sync {
633 fn add_fonts(&self, fonts: Vec<Cow<'static, [u8]>>) -> Result<()>;
634 fn all_font_names(&self) -> Vec<String>;
635 fn font_id(&self, descriptor: &Font) -> Result<FontId>;
636 fn font_metrics(&self, font_id: FontId) -> FontMetrics;
637 fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Bounds<f32>>;
638 fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Size<f32>>;
639 fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option<GlyphId>;
640 fn glyph_raster_bounds(&self, params: &RenderGlyphParams) -> Result<Bounds<DevicePixels>>;
641 fn rasterize_glyph(
642 &self,
643 params: &RenderGlyphParams,
644 raster_bounds: Bounds<DevicePixels>,
645 ) -> Result<(Size<DevicePixels>, Vec<u8>)>;
646 fn layout_line(&self, text: &str, font_size: Pixels, runs: &[FontRun]) -> LineLayout;
647}
648
649pub(crate) struct NoopTextSystem;
650
651impl NoopTextSystem {
652 #[allow(dead_code)]
653 pub fn new() -> Self {
654 Self
655 }
656}
657
658impl PlatformTextSystem for NoopTextSystem {
659 fn add_fonts(&self, _fonts: Vec<Cow<'static, [u8]>>) -> Result<()> {
660 Ok(())
661 }
662
663 fn all_font_names(&self) -> Vec<String> {
664 Vec::new()
665 }
666
667 fn font_id(&self, _descriptor: &Font) -> Result<FontId> {
668 Ok(FontId(1))
669 }
670
671 fn font_metrics(&self, _font_id: FontId) -> FontMetrics {
672 FontMetrics {
673 units_per_em: 1000,
674 ascent: 1025.0,
675 descent: -275.0,
676 line_gap: 0.0,
677 underline_position: -95.0,
678 underline_thickness: 60.0,
679 cap_height: 698.0,
680 x_height: 516.0,
681 bounding_box: Bounds {
682 origin: Point {
683 x: -260.0,
684 y: -245.0,
685 },
686 size: Size {
687 width: 1501.0,
688 height: 1364.0,
689 },
690 },
691 }
692 }
693
694 fn typographic_bounds(&self, _font_id: FontId, _glyph_id: GlyphId) -> Result<Bounds<f32>> {
695 Ok(Bounds {
696 origin: Point { x: 54.0, y: 0.0 },
697 size: size(392.0, 528.0),
698 })
699 }
700
701 fn advance(&self, _font_id: FontId, glyph_id: GlyphId) -> Result<Size<f32>> {
702 Ok(size(600.0 * glyph_id.0 as f32, 0.0))
703 }
704
705 fn glyph_for_char(&self, _font_id: FontId, ch: char) -> Option<GlyphId> {
706 Some(GlyphId(ch.len_utf16() as u32))
707 }
708
709 fn glyph_raster_bounds(&self, _params: &RenderGlyphParams) -> Result<Bounds<DevicePixels>> {
710 Ok(Default::default())
711 }
712
713 fn rasterize_glyph(
714 &self,
715 _params: &RenderGlyphParams,
716 raster_bounds: Bounds<DevicePixels>,
717 ) -> Result<(Size<DevicePixels>, Vec<u8>)> {
718 Ok((raster_bounds.size, Vec::new()))
719 }
720
721 fn layout_line(&self, text: &str, font_size: Pixels, _runs: &[FontRun]) -> LineLayout {
722 let mut position = px(0.);
723 let metrics = self.font_metrics(FontId(0));
724 let em_width = font_size
725 * self
726 .advance(FontId(0), self.glyph_for_char(FontId(0), 'm').unwrap())
727 .unwrap()
728 .width
729 / metrics.units_per_em as f32;
730 let mut glyphs = Vec::new();
731 for (ix, c) in text.char_indices() {
732 if let Some(glyph) = self.glyph_for_char(FontId(0), c) {
733 glyphs.push(ShapedGlyph {
734 id: glyph,
735 position: point(position, px(0.)),
736 index: ix,
737 is_emoji: glyph.0 == 2,
738 });
739 if glyph.0 == 2 {
740 position += em_width * 2.0;
741 } else {
742 position += em_width;
743 }
744 } else {
745 position += em_width
746 }
747 }
748 let mut runs = Vec::default();
749 if !glyphs.is_empty() {
750 runs.push(ShapedRun {
751 font_id: FontId(0),
752 glyphs,
753 });
754 } else {
755 position = px(0.);
756 }
757
758 LineLayout {
759 font_size,
760 width: position,
761 ascent: font_size * (metrics.ascent / metrics.units_per_em as f32),
762 descent: font_size * (metrics.descent / metrics.units_per_em as f32),
763 runs,
764 len: text.len(),
765 }
766 }
767}
768
769// Adapted from https://github.com/microsoft/terminal/blob/1283c0f5b99a2961673249fa77c6b986efb5086c/src/renderer/atlas/dwrite.cpp
770// Copyright (c) Microsoft Corporation.
771// Licensed under the MIT license.
772#[allow(dead_code)]
773pub(crate) fn get_gamma_correction_ratios(gamma: f32) -> [f32; 4] {
774 const GAMMA_INCORRECT_TARGET_RATIOS: [[f32; 4]; 13] = [
775 [0.0000 / 4.0, 0.0000 / 4.0, 0.0000 / 4.0, 0.0000 / 4.0], // gamma = 1.0
776 [0.0166 / 4.0, -0.0807 / 4.0, 0.2227 / 4.0, -0.0751 / 4.0], // gamma = 1.1
777 [0.0350 / 4.0, -0.1760 / 4.0, 0.4325 / 4.0, -0.1370 / 4.0], // gamma = 1.2
778 [0.0543 / 4.0, -0.2821 / 4.0, 0.6302 / 4.0, -0.1876 / 4.0], // gamma = 1.3
779 [0.0739 / 4.0, -0.3963 / 4.0, 0.8167 / 4.0, -0.2287 / 4.0], // gamma = 1.4
780 [0.0933 / 4.0, -0.5161 / 4.0, 0.9926 / 4.0, -0.2616 / 4.0], // gamma = 1.5
781 [0.1121 / 4.0, -0.6395 / 4.0, 1.1588 / 4.0, -0.2877 / 4.0], // gamma = 1.6
782 [0.1300 / 4.0, -0.7649 / 4.0, 1.3159 / 4.0, -0.3080 / 4.0], // gamma = 1.7
783 [0.1469 / 4.0, -0.8911 / 4.0, 1.4644 / 4.0, -0.3234 / 4.0], // gamma = 1.8
784 [0.1627 / 4.0, -1.0170 / 4.0, 1.6051 / 4.0, -0.3347 / 4.0], // gamma = 1.9
785 [0.1773 / 4.0, -1.1420 / 4.0, 1.7385 / 4.0, -0.3426 / 4.0], // gamma = 2.0
786 [0.1908 / 4.0, -1.2652 / 4.0, 1.8650 / 4.0, -0.3476 / 4.0], // gamma = 2.1
787 [0.2031 / 4.0, -1.3864 / 4.0, 1.9851 / 4.0, -0.3501 / 4.0], // gamma = 2.2
788 ];
789
790 const NORM13: f32 = ((0x10000 as f64) / (255.0 * 255.0) * 4.0) as f32;
791 const NORM24: f32 = ((0x100 as f64) / (255.0) * 4.0) as f32;
792
793 let index = ((gamma * 10.0).round() as usize).clamp(10, 22) - 10;
794 let ratios = GAMMA_INCORRECT_TARGET_RATIOS[index];
795
796 [
797 ratios[0] * NORM13,
798 ratios[1] * NORM24,
799 ratios[2] * NORM13,
800 ratios[3] * NORM24,
801 ]
802}
803
804#[derive(PartialEq, Eq, Hash, Clone)]
805pub(crate) enum AtlasKey {
806 Glyph(RenderGlyphParams),
807 Svg(RenderSvgParams),
808 Image(RenderImageParams),
809}
810
811impl AtlasKey {
812 #[cfg_attr(
813 all(
814 any(target_os = "linux", target_os = "freebsd"),
815 not(any(feature = "x11", feature = "wayland"))
816 ),
817 allow(dead_code)
818 )]
819 pub(crate) fn texture_kind(&self) -> AtlasTextureKind {
820 match self {
821 AtlasKey::Glyph(params) => {
822 if params.is_emoji {
823 AtlasTextureKind::Polychrome
824 } else {
825 AtlasTextureKind::Monochrome
826 }
827 }
828 AtlasKey::Svg(_) => AtlasTextureKind::Monochrome,
829 AtlasKey::Image(_) => AtlasTextureKind::Polychrome,
830 }
831 }
832}
833
834impl From<RenderGlyphParams> for AtlasKey {
835 fn from(params: RenderGlyphParams) -> Self {
836 Self::Glyph(params)
837 }
838}
839
840impl From<RenderSvgParams> for AtlasKey {
841 fn from(params: RenderSvgParams) -> Self {
842 Self::Svg(params)
843 }
844}
845
846impl From<RenderImageParams> for AtlasKey {
847 fn from(params: RenderImageParams) -> Self {
848 Self::Image(params)
849 }
850}
851
852pub(crate) trait PlatformAtlas: Send + Sync {
853 fn get_or_insert_with<'a>(
854 &self,
855 key: &AtlasKey,
856 build: &mut dyn FnMut() -> Result<Option<(Size<DevicePixels>, Cow<'a, [u8]>)>>,
857 ) -> Result<Option<AtlasTile>>;
858 fn remove(&self, key: &AtlasKey);
859}
860
861struct AtlasTextureList<T> {
862 textures: Vec<Option<T>>,
863 free_list: Vec<usize>,
864}
865
866impl<T> Default for AtlasTextureList<T> {
867 fn default() -> Self {
868 Self {
869 textures: Vec::default(),
870 free_list: Vec::default(),
871 }
872 }
873}
874
875impl<T> ops::Index<usize> for AtlasTextureList<T> {
876 type Output = Option<T>;
877
878 fn index(&self, index: usize) -> &Self::Output {
879 &self.textures[index]
880 }
881}
882
883impl<T> AtlasTextureList<T> {
884 #[allow(unused)]
885 fn drain(&mut self) -> std::vec::Drain<'_, Option<T>> {
886 self.free_list.clear();
887 self.textures.drain(..)
888 }
889
890 #[allow(dead_code)]
891 fn iter_mut(&mut self) -> impl DoubleEndedIterator<Item = &mut T> {
892 self.textures.iter_mut().flatten()
893 }
894}
895
896#[derive(Clone, Debug, PartialEq, Eq)]
897#[repr(C)]
898pub(crate) struct AtlasTile {
899 pub(crate) texture_id: AtlasTextureId,
900 pub(crate) tile_id: TileId,
901 pub(crate) padding: u32,
902 pub(crate) bounds: Bounds<DevicePixels>,
903}
904
905#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
906#[repr(C)]
907pub(crate) struct AtlasTextureId {
908 // We use u32 instead of usize for Metal Shader Language compatibility
909 pub(crate) index: u32,
910 pub(crate) kind: AtlasTextureKind,
911}
912
913#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
914#[repr(C)]
915#[cfg_attr(
916 all(
917 any(target_os = "linux", target_os = "freebsd"),
918 not(any(feature = "x11", feature = "wayland"))
919 ),
920 allow(dead_code)
921)]
922pub(crate) enum AtlasTextureKind {
923 Monochrome = 0,
924 Polychrome = 1,
925}
926
927#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
928#[repr(C)]
929pub(crate) struct TileId(pub(crate) u32);
930
931impl From<etagere::AllocId> for TileId {
932 fn from(id: etagere::AllocId) -> Self {
933 Self(id.serialize())
934 }
935}
936
937impl From<TileId> for etagere::AllocId {
938 fn from(id: TileId) -> Self {
939 Self::deserialize(id.0)
940 }
941}
942
943pub(crate) struct PlatformInputHandler {
944 cx: AsyncWindowContext,
945 handler: Box<dyn InputHandler>,
946}
947
948#[cfg_attr(
949 all(
950 any(target_os = "linux", target_os = "freebsd"),
951 not(any(feature = "x11", feature = "wayland"))
952 ),
953 allow(dead_code)
954)]
955impl PlatformInputHandler {
956 pub fn new(cx: AsyncWindowContext, handler: Box<dyn InputHandler>) -> Self {
957 Self { cx, handler }
958 }
959
960 fn selected_text_range(&mut self, ignore_disabled_input: bool) -> Option<UTF16Selection> {
961 self.cx
962 .update(|window, cx| {
963 self.handler
964 .selected_text_range(ignore_disabled_input, window, cx)
965 })
966 .ok()
967 .flatten()
968 }
969
970 #[cfg_attr(target_os = "windows", allow(dead_code))]
971 fn marked_text_range(&mut self) -> Option<Range<usize>> {
972 self.cx
973 .update(|window, cx| self.handler.marked_text_range(window, cx))
974 .ok()
975 .flatten()
976 }
977
978 #[cfg_attr(
979 any(target_os = "linux", target_os = "freebsd", target_os = "windows"),
980 allow(dead_code)
981 )]
982 fn text_for_range(
983 &mut self,
984 range_utf16: Range<usize>,
985 adjusted: &mut Option<Range<usize>>,
986 ) -> Option<String> {
987 self.cx
988 .update(|window, cx| {
989 self.handler
990 .text_for_range(range_utf16, adjusted, window, cx)
991 })
992 .ok()
993 .flatten()
994 }
995
996 fn replace_text_in_range(&mut self, replacement_range: Option<Range<usize>>, text: &str) {
997 self.cx
998 .update(|window, cx| {
999 self.handler
1000 .replace_text_in_range(replacement_range, text, window, cx);
1001 })
1002 .ok();
1003 }
1004
1005 pub fn replace_and_mark_text_in_range(
1006 &mut self,
1007 range_utf16: Option<Range<usize>>,
1008 new_text: &str,
1009 new_selected_range: Option<Range<usize>>,
1010 ) {
1011 self.cx
1012 .update(|window, cx| {
1013 self.handler.replace_and_mark_text_in_range(
1014 range_utf16,
1015 new_text,
1016 new_selected_range,
1017 window,
1018 cx,
1019 )
1020 })
1021 .ok();
1022 }
1023
1024 #[cfg_attr(target_os = "windows", allow(dead_code))]
1025 fn unmark_text(&mut self) {
1026 self.cx
1027 .update(|window, cx| self.handler.unmark_text(window, cx))
1028 .ok();
1029 }
1030
1031 fn bounds_for_range(&mut self, range_utf16: Range<usize>) -> Option<Bounds<Pixels>> {
1032 self.cx
1033 .update(|window, cx| self.handler.bounds_for_range(range_utf16, window, cx))
1034 .ok()
1035 .flatten()
1036 }
1037
1038 #[allow(dead_code)]
1039 fn apple_press_and_hold_enabled(&mut self) -> bool {
1040 self.handler.apple_press_and_hold_enabled()
1041 }
1042
1043 pub(crate) fn dispatch_input(&mut self, input: &str, window: &mut Window, cx: &mut App) {
1044 self.handler.replace_text_in_range(None, input, window, cx);
1045 }
1046
1047 pub fn selected_bounds(&mut self, window: &mut Window, cx: &mut App) -> Option<Bounds<Pixels>> {
1048 let selection = self.handler.selected_text_range(true, window, cx)?;
1049 self.handler.bounds_for_range(
1050 if selection.reversed {
1051 selection.range.start..selection.range.start
1052 } else {
1053 selection.range.end..selection.range.end
1054 },
1055 window,
1056 cx,
1057 )
1058 }
1059
1060 #[allow(unused)]
1061 pub fn character_index_for_point(&mut self, point: Point<Pixels>) -> Option<usize> {
1062 self.cx
1063 .update(|window, cx| self.handler.character_index_for_point(point, window, cx))
1064 .ok()
1065 .flatten()
1066 }
1067
1068 #[allow(dead_code)]
1069 pub(crate) fn accepts_text_input(&mut self, window: &mut Window, cx: &mut App) -> bool {
1070 self.handler.accepts_text_input(window, cx)
1071 }
1072}
1073
1074/// A struct representing a selection in a text buffer, in UTF16 characters.
1075/// This is different from a range because the head may be before the tail.
1076#[derive(Debug)]
1077pub struct UTF16Selection {
1078 /// The range of text in the document this selection corresponds to
1079 /// in UTF16 characters.
1080 pub range: Range<usize>,
1081 /// Whether the head of this selection is at the start (true), or end (false)
1082 /// of the range
1083 pub reversed: bool,
1084}
1085
1086/// Zed's interface for handling text input from the platform's IME system
1087/// This is currently a 1:1 exposure of the NSTextInputClient API:
1088///
1089/// <https://developer.apple.com/documentation/appkit/nstextinputclient>
1090pub trait InputHandler: 'static {
1091 /// Get the range of the user's currently selected text, if any
1092 /// Corresponds to [selectedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438242-selectedrange)
1093 ///
1094 /// Return value is in terms of UTF-16 characters, from 0 to the length of the document
1095 fn selected_text_range(
1096 &mut self,
1097 ignore_disabled_input: bool,
1098 window: &mut Window,
1099 cx: &mut App,
1100 ) -> Option<UTF16Selection>;
1101
1102 /// Get the range of the currently marked text, if any
1103 /// Corresponds to [markedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438250-markedrange)
1104 ///
1105 /// Return value is in terms of UTF-16 characters, from 0 to the length of the document
1106 fn marked_text_range(&mut self, window: &mut Window, cx: &mut App) -> Option<Range<usize>>;
1107
1108 /// Get the text for the given document range in UTF-16 characters
1109 /// Corresponds to [attributedSubstring(forProposedRange: actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438238-attributedsubstring)
1110 ///
1111 /// range_utf16 is in terms of UTF-16 characters
1112 fn text_for_range(
1113 &mut self,
1114 range_utf16: Range<usize>,
1115 adjusted_range: &mut Option<Range<usize>>,
1116 window: &mut Window,
1117 cx: &mut App,
1118 ) -> Option<String>;
1119
1120 /// Replace the text in the given document range with the given text
1121 /// Corresponds to [insertText(_:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438258-inserttext)
1122 ///
1123 /// replacement_range is in terms of UTF-16 characters
1124 fn replace_text_in_range(
1125 &mut self,
1126 replacement_range: Option<Range<usize>>,
1127 text: &str,
1128 window: &mut Window,
1129 cx: &mut App,
1130 );
1131
1132 /// Replace the text in the given document range with the given text,
1133 /// and mark the given text as part of an IME 'composing' state
1134 /// Corresponds to [setMarkedText(_:selectedRange:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438246-setmarkedtext)
1135 ///
1136 /// range_utf16 is in terms of UTF-16 characters
1137 /// new_selected_range is in terms of UTF-16 characters
1138 fn replace_and_mark_text_in_range(
1139 &mut self,
1140 range_utf16: Option<Range<usize>>,
1141 new_text: &str,
1142 new_selected_range: Option<Range<usize>>,
1143 window: &mut Window,
1144 cx: &mut App,
1145 );
1146
1147 /// Remove the IME 'composing' state from the document
1148 /// Corresponds to [unmarkText()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438239-unmarktext)
1149 fn unmark_text(&mut self, window: &mut Window, cx: &mut App);
1150
1151 /// Get the bounds of the given document range in screen coordinates
1152 /// Corresponds to [firstRect(forCharacterRange:actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438240-firstrect)
1153 ///
1154 /// This is used for positioning the IME candidate window
1155 fn bounds_for_range(
1156 &mut self,
1157 range_utf16: Range<usize>,
1158 window: &mut Window,
1159 cx: &mut App,
1160 ) -> Option<Bounds<Pixels>>;
1161
1162 /// Get the character offset for the given point in terms of UTF16 characters
1163 ///
1164 /// Corresponds to [characterIndexForPoint:](https://developer.apple.com/documentation/appkit/nstextinputclient/characterindex(for:))
1165 fn character_index_for_point(
1166 &mut self,
1167 point: Point<Pixels>,
1168 window: &mut Window,
1169 cx: &mut App,
1170 ) -> Option<usize>;
1171
1172 /// Allows a given input context to opt into getting raw key repeats instead of
1173 /// sending these to the platform.
1174 /// TODO: Ideally we should be able to set ApplePressAndHoldEnabled in NSUserDefaults
1175 /// (which is how iTerm does it) but it doesn't seem to work for me.
1176 #[allow(dead_code)]
1177 fn apple_press_and_hold_enabled(&mut self) -> bool {
1178 true
1179 }
1180
1181 /// Returns whether this handler is accepting text input to be inserted.
1182 fn accepts_text_input(&mut self, _window: &mut Window, _cx: &mut App) -> bool {
1183 true
1184 }
1185}
1186
1187/// The variables that can be configured when creating a new window
1188#[derive(Debug)]
1189pub struct WindowOptions {
1190 /// Specifies the state and bounds of the window in screen coordinates.
1191 /// - `None`: Inherit the bounds.
1192 /// - `Some(WindowBounds)`: Open a window with corresponding state and its restore size.
1193 pub window_bounds: Option<WindowBounds>,
1194
1195 /// The titlebar configuration of the window
1196 pub titlebar: Option<TitlebarOptions>,
1197
1198 /// Whether the window should be focused when created
1199 pub focus: bool,
1200
1201 /// Whether the window should be shown when created
1202 pub show: bool,
1203
1204 /// The kind of window to create
1205 pub kind: WindowKind,
1206
1207 /// Whether the window should be movable by the user
1208 pub is_movable: bool,
1209
1210 /// Whether the window should be resizable by the user
1211 pub is_resizable: bool,
1212
1213 /// Whether the window should be minimized by the user
1214 pub is_minimizable: bool,
1215
1216 /// The display to create the window on, if this is None,
1217 /// the window will be created on the main display
1218 pub display_id: Option<DisplayId>,
1219
1220 /// The appearance of the window background.
1221 pub window_background: WindowBackgroundAppearance,
1222
1223 /// Application identifier of the window. Can by used by desktop environments to group applications together.
1224 pub app_id: Option<String>,
1225
1226 /// Window minimum size
1227 pub window_min_size: Option<Size<Pixels>>,
1228
1229 /// Whether to use client or server side decorations. Wayland only
1230 /// Note that this may be ignored.
1231 pub window_decorations: Option<WindowDecorations>,
1232
1233 /// 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.
1234 pub tabbing_identifier: Option<String>,
1235}
1236
1237/// The variables that can be configured when creating a new window
1238#[derive(Debug)]
1239#[cfg_attr(
1240 all(
1241 any(target_os = "linux", target_os = "freebsd"),
1242 not(any(feature = "x11", feature = "wayland"))
1243 ),
1244 allow(dead_code)
1245)]
1246pub(crate) struct WindowParams {
1247 pub bounds: Bounds<Pixels>,
1248
1249 /// The titlebar configuration of the window
1250 #[cfg_attr(feature = "wayland", allow(dead_code))]
1251 pub titlebar: Option<TitlebarOptions>,
1252
1253 /// The kind of window to create
1254 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1255 pub kind: WindowKind,
1256
1257 /// Whether the window should be movable by the user
1258 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1259 pub is_movable: bool,
1260
1261 /// Whether the window should be resizable by the user
1262 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1263 pub is_resizable: bool,
1264
1265 /// Whether the window should be minimized by the user
1266 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1267 pub is_minimizable: bool,
1268
1269 #[cfg_attr(
1270 any(target_os = "linux", target_os = "freebsd", target_os = "windows"),
1271 allow(dead_code)
1272 )]
1273 pub focus: bool,
1274
1275 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1276 pub show: bool,
1277
1278 #[cfg_attr(feature = "wayland", allow(dead_code))]
1279 pub display_id: Option<DisplayId>,
1280
1281 pub window_min_size: Option<Size<Pixels>>,
1282 #[cfg(target_os = "macos")]
1283 pub tabbing_identifier: Option<String>,
1284}
1285
1286/// Represents the status of how a window should be opened.
1287#[derive(Debug, Copy, Clone, PartialEq)]
1288pub enum WindowBounds {
1289 /// Indicates that the window should open in a windowed state with the given bounds.
1290 Windowed(Bounds<Pixels>),
1291 /// Indicates that the window should open in a maximized state.
1292 /// The bounds provided here represent the restore size of the window.
1293 Maximized(Bounds<Pixels>),
1294 /// Indicates that the window should open in fullscreen mode.
1295 /// The bounds provided here represent the restore size of the window.
1296 Fullscreen(Bounds<Pixels>),
1297}
1298
1299impl Default for WindowBounds {
1300 fn default() -> Self {
1301 WindowBounds::Windowed(Bounds::default())
1302 }
1303}
1304
1305impl WindowBounds {
1306 /// Retrieve the inner bounds
1307 pub fn get_bounds(&self) -> Bounds<Pixels> {
1308 match self {
1309 WindowBounds::Windowed(bounds) => *bounds,
1310 WindowBounds::Maximized(bounds) => *bounds,
1311 WindowBounds::Fullscreen(bounds) => *bounds,
1312 }
1313 }
1314
1315 /// Creates a new window bounds that centers the window on the screen.
1316 pub fn centered(size: Size<Pixels>, cx: &App) -> Self {
1317 WindowBounds::Windowed(Bounds::centered(None, size, cx))
1318 }
1319}
1320
1321impl Default for WindowOptions {
1322 fn default() -> Self {
1323 Self {
1324 window_bounds: None,
1325 titlebar: Some(TitlebarOptions {
1326 title: Default::default(),
1327 appears_transparent: Default::default(),
1328 traffic_light_position: Default::default(),
1329 }),
1330 focus: true,
1331 show: true,
1332 kind: WindowKind::Normal,
1333 is_movable: true,
1334 is_resizable: true,
1335 is_minimizable: true,
1336 display_id: None,
1337 window_background: WindowBackgroundAppearance::default(),
1338 app_id: None,
1339 window_min_size: None,
1340 window_decorations: None,
1341 tabbing_identifier: None,
1342 }
1343 }
1344}
1345
1346/// The options that can be configured for a window's titlebar
1347#[derive(Debug, Default)]
1348pub struct TitlebarOptions {
1349 /// The initial title of the window
1350 pub title: Option<SharedString>,
1351
1352 /// Should the default system titlebar be hidden to allow for a custom-drawn titlebar? (macOS and Windows only)
1353 /// Refer to [`WindowOptions::window_decorations`] on Linux
1354 pub appears_transparent: bool,
1355
1356 /// The position of the macOS traffic light buttons
1357 pub traffic_light_position: Option<Point<Pixels>>,
1358}
1359
1360/// The kind of window to create
1361#[derive(Clone, Debug, PartialEq, Eq)]
1362pub enum WindowKind {
1363 /// A normal application window
1364 Normal,
1365
1366 /// A window that appears above all other windows, usually used for alerts or popups
1367 /// use sparingly!
1368 PopUp,
1369
1370 /// A floating window that appears on top of its parent window
1371 Floating,
1372
1373 /// A Wayland LayerShell window, used to draw overlays or backgrounds for applications such as
1374 /// docks, notifications or wallpapers.
1375 #[cfg(all(target_os = "linux", feature = "wayland"))]
1376 LayerShell(layer_shell::LayerShellOptions),
1377
1378 /// A window that appears on top of its parent window and blocks interaction with it
1379 /// until the modal window is closed
1380 Dialog,
1381}
1382
1383/// The appearance of the window, as defined by the operating system.
1384///
1385/// On macOS, this corresponds to named [`NSAppearance`](https://developer.apple.com/documentation/appkit/nsappearance)
1386/// values.
1387#[derive(Copy, Clone, Debug, Default, PartialEq, Eq)]
1388pub enum WindowAppearance {
1389 /// A light appearance.
1390 ///
1391 /// On macOS, this corresponds to the `aqua` appearance.
1392 #[default]
1393 Light,
1394
1395 /// A light appearance with vibrant colors.
1396 ///
1397 /// On macOS, this corresponds to the `NSAppearanceNameVibrantLight` appearance.
1398 VibrantLight,
1399
1400 /// A dark appearance.
1401 ///
1402 /// On macOS, this corresponds to the `darkAqua` appearance.
1403 Dark,
1404
1405 /// A dark appearance with vibrant colors.
1406 ///
1407 /// On macOS, this corresponds to the `NSAppearanceNameVibrantDark` appearance.
1408 VibrantDark,
1409}
1410
1411/// The appearance of the background of the window itself, when there is
1412/// no content or the content is transparent.
1413#[derive(Copy, Clone, Debug, Default, PartialEq)]
1414pub enum WindowBackgroundAppearance {
1415 /// Opaque.
1416 ///
1417 /// This lets the window manager know that content behind this
1418 /// window does not need to be drawn.
1419 ///
1420 /// Actual color depends on the system and themes should define a fully
1421 /// opaque background color instead.
1422 #[default]
1423 Opaque,
1424 /// Plain alpha transparency.
1425 Transparent,
1426 /// Transparency, but the contents behind the window are blurred.
1427 ///
1428 /// Not always supported.
1429 Blurred,
1430 /// The Mica backdrop material, supported on Windows 11.
1431 MicaBackdrop,
1432 /// The Mica Alt backdrop material, supported on Windows 11.
1433 MicaAltBackdrop,
1434}
1435
1436/// The options that can be configured for a file dialog prompt
1437#[derive(Clone, Debug)]
1438pub struct PathPromptOptions {
1439 /// Should the prompt allow files to be selected?
1440 pub files: bool,
1441 /// Should the prompt allow directories to be selected?
1442 pub directories: bool,
1443 /// Should the prompt allow multiple files to be selected?
1444 pub multiple: bool,
1445 /// The prompt to show to a user when selecting a path
1446 pub prompt: Option<SharedString>,
1447}
1448
1449/// What kind of prompt styling to show
1450#[derive(Copy, Clone, Debug, PartialEq)]
1451pub enum PromptLevel {
1452 /// A prompt that is shown when the user should be notified of something
1453 Info,
1454
1455 /// A prompt that is shown when the user needs to be warned of a potential problem
1456 Warning,
1457
1458 /// A prompt that is shown when a critical problem has occurred
1459 Critical,
1460}
1461
1462/// Prompt Button
1463#[derive(Clone, Debug, PartialEq)]
1464pub enum PromptButton {
1465 /// Ok button
1466 Ok(SharedString),
1467 /// Cancel button
1468 Cancel(SharedString),
1469 /// Other button
1470 Other(SharedString),
1471}
1472
1473impl PromptButton {
1474 /// Create a button with label
1475 pub fn new(label: impl Into<SharedString>) -> Self {
1476 PromptButton::Other(label.into())
1477 }
1478
1479 /// Create an Ok button
1480 pub fn ok(label: impl Into<SharedString>) -> Self {
1481 PromptButton::Ok(label.into())
1482 }
1483
1484 /// Create a Cancel button
1485 pub fn cancel(label: impl Into<SharedString>) -> Self {
1486 PromptButton::Cancel(label.into())
1487 }
1488
1489 #[allow(dead_code)]
1490 pub(crate) fn is_cancel(&self) -> bool {
1491 matches!(self, PromptButton::Cancel(_))
1492 }
1493
1494 /// Returns the label of the button
1495 pub fn label(&self) -> &SharedString {
1496 match self {
1497 PromptButton::Ok(label) => label,
1498 PromptButton::Cancel(label) => label,
1499 PromptButton::Other(label) => label,
1500 }
1501 }
1502}
1503
1504impl From<&str> for PromptButton {
1505 fn from(value: &str) -> Self {
1506 match value.to_lowercase().as_str() {
1507 "ok" => PromptButton::Ok("Ok".into()),
1508 "cancel" => PromptButton::Cancel("Cancel".into()),
1509 _ => PromptButton::Other(SharedString::from(value.to_owned())),
1510 }
1511 }
1512}
1513
1514/// The style of the cursor (pointer)
1515#[derive(Copy, Clone, Default, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)]
1516pub enum CursorStyle {
1517 /// The default cursor
1518 #[default]
1519 Arrow,
1520
1521 /// A text input cursor
1522 /// corresponds to the CSS cursor value `text`
1523 IBeam,
1524
1525 /// A crosshair cursor
1526 /// corresponds to the CSS cursor value `crosshair`
1527 Crosshair,
1528
1529 /// A closed hand cursor
1530 /// corresponds to the CSS cursor value `grabbing`
1531 ClosedHand,
1532
1533 /// An open hand cursor
1534 /// corresponds to the CSS cursor value `grab`
1535 OpenHand,
1536
1537 /// A pointing hand cursor
1538 /// corresponds to the CSS cursor value `pointer`
1539 PointingHand,
1540
1541 /// A resize left cursor
1542 /// corresponds to the CSS cursor value `w-resize`
1543 ResizeLeft,
1544
1545 /// A resize right cursor
1546 /// corresponds to the CSS cursor value `e-resize`
1547 ResizeRight,
1548
1549 /// A resize cursor to the left and right
1550 /// corresponds to the CSS cursor value `ew-resize`
1551 ResizeLeftRight,
1552
1553 /// A resize up cursor
1554 /// corresponds to the CSS cursor value `n-resize`
1555 ResizeUp,
1556
1557 /// A resize down cursor
1558 /// corresponds to the CSS cursor value `s-resize`
1559 ResizeDown,
1560
1561 /// A resize cursor directing up and down
1562 /// corresponds to the CSS cursor value `ns-resize`
1563 ResizeUpDown,
1564
1565 /// A resize cursor directing up-left and down-right
1566 /// corresponds to the CSS cursor value `nesw-resize`
1567 ResizeUpLeftDownRight,
1568
1569 /// A resize cursor directing up-right and down-left
1570 /// corresponds to the CSS cursor value `nwse-resize`
1571 ResizeUpRightDownLeft,
1572
1573 /// A cursor indicating that the item/column can be resized horizontally.
1574 /// corresponds to the CSS cursor value `col-resize`
1575 ResizeColumn,
1576
1577 /// A cursor indicating that the item/row can be resized vertically.
1578 /// corresponds to the CSS cursor value `row-resize`
1579 ResizeRow,
1580
1581 /// A text input cursor for vertical layout
1582 /// corresponds to the CSS cursor value `vertical-text`
1583 IBeamCursorForVerticalLayout,
1584
1585 /// A cursor indicating that the operation is not allowed
1586 /// corresponds to the CSS cursor value `not-allowed`
1587 OperationNotAllowed,
1588
1589 /// A cursor indicating that the operation will result in a link
1590 /// corresponds to the CSS cursor value `alias`
1591 DragLink,
1592
1593 /// A cursor indicating that the operation will result in a copy
1594 /// corresponds to the CSS cursor value `copy`
1595 DragCopy,
1596
1597 /// A cursor indicating that the operation will result in a context menu
1598 /// corresponds to the CSS cursor value `context-menu`
1599 ContextualMenu,
1600
1601 /// Hide the cursor
1602 None,
1603}
1604
1605/// A clipboard item that should be copied to the clipboard
1606#[derive(Clone, Debug, Eq, PartialEq)]
1607pub struct ClipboardItem {
1608 entries: Vec<ClipboardEntry>,
1609}
1610
1611/// Either a ClipboardString or a ClipboardImage
1612#[derive(Clone, Debug, Eq, PartialEq)]
1613pub enum ClipboardEntry {
1614 /// A string entry
1615 String(ClipboardString),
1616 /// An image entry
1617 Image(Image),
1618 /// A file entry
1619 ExternalPaths(crate::ExternalPaths),
1620}
1621
1622impl ClipboardItem {
1623 /// Create a new ClipboardItem::String with no associated metadata
1624 pub fn new_string(text: String) -> Self {
1625 Self {
1626 entries: vec![ClipboardEntry::String(ClipboardString::new(text))],
1627 }
1628 }
1629
1630 /// Create a new ClipboardItem::String with the given text and associated metadata
1631 pub fn new_string_with_metadata(text: String, metadata: String) -> Self {
1632 Self {
1633 entries: vec![ClipboardEntry::String(ClipboardString {
1634 text,
1635 metadata: Some(metadata),
1636 })],
1637 }
1638 }
1639
1640 /// Create a new ClipboardItem::String with the given text and associated metadata
1641 pub fn new_string_with_json_metadata<T: Serialize>(text: String, metadata: T) -> Self {
1642 Self {
1643 entries: vec![ClipboardEntry::String(
1644 ClipboardString::new(text).with_json_metadata(metadata),
1645 )],
1646 }
1647 }
1648
1649 /// Create a new ClipboardItem::Image with the given image with no associated metadata
1650 pub fn new_image(image: &Image) -> Self {
1651 Self {
1652 entries: vec![ClipboardEntry::Image(image.clone())],
1653 }
1654 }
1655
1656 /// Concatenates together all the ClipboardString entries in the item.
1657 /// Returns None if there were no ClipboardString entries.
1658 pub fn text(&self) -> Option<String> {
1659 let mut answer = String::new();
1660
1661 for entry in self.entries.iter() {
1662 if let ClipboardEntry::String(ClipboardString { text, metadata: _ }) = entry {
1663 answer.push_str(text);
1664 }
1665 }
1666
1667 if answer.is_empty() {
1668 for entry in self.entries.iter() {
1669 if let ClipboardEntry::ExternalPaths(paths) = entry {
1670 for path in &paths.0 {
1671 use std::fmt::Write as _;
1672 _ = write!(answer, "{}", path.display());
1673 }
1674 }
1675 }
1676 }
1677
1678 if !answer.is_empty() {
1679 Some(answer)
1680 } else {
1681 None
1682 }
1683 }
1684
1685 /// If this item is one ClipboardEntry::String, returns its metadata.
1686 #[cfg_attr(not(target_os = "windows"), allow(dead_code))]
1687 pub fn metadata(&self) -> Option<&String> {
1688 match self.entries().first() {
1689 Some(ClipboardEntry::String(clipboard_string)) if self.entries.len() == 1 => {
1690 clipboard_string.metadata.as_ref()
1691 }
1692 _ => None,
1693 }
1694 }
1695
1696 /// Get the item's entries
1697 pub fn entries(&self) -> &[ClipboardEntry] {
1698 &self.entries
1699 }
1700
1701 /// Get owned versions of the item's entries
1702 pub fn into_entries(self) -> impl Iterator<Item = ClipboardEntry> {
1703 self.entries.into_iter()
1704 }
1705}
1706
1707impl From<ClipboardString> for ClipboardEntry {
1708 fn from(value: ClipboardString) -> Self {
1709 Self::String(value)
1710 }
1711}
1712
1713impl From<String> for ClipboardEntry {
1714 fn from(value: String) -> Self {
1715 Self::from(ClipboardString::from(value))
1716 }
1717}
1718
1719impl From<Image> for ClipboardEntry {
1720 fn from(value: Image) -> Self {
1721 Self::Image(value)
1722 }
1723}
1724
1725impl From<ClipboardEntry> for ClipboardItem {
1726 fn from(value: ClipboardEntry) -> Self {
1727 Self {
1728 entries: vec![value],
1729 }
1730 }
1731}
1732
1733impl From<String> for ClipboardItem {
1734 fn from(value: String) -> Self {
1735 Self::from(ClipboardEntry::from(value))
1736 }
1737}
1738
1739impl From<Image> for ClipboardItem {
1740 fn from(value: Image) -> Self {
1741 Self::from(ClipboardEntry::from(value))
1742 }
1743}
1744
1745/// One of the editor's supported image formats (e.g. PNG, JPEG) - used when dealing with images in the clipboard
1746#[derive(Clone, Copy, Debug, Eq, PartialEq, EnumIter, Hash)]
1747pub enum ImageFormat {
1748 // Sorted from most to least likely to be pasted into an editor,
1749 // which matters when we iterate through them trying to see if
1750 // clipboard content matches them.
1751 /// .png
1752 Png,
1753 /// .jpeg or .jpg
1754 Jpeg,
1755 /// .webp
1756 Webp,
1757 /// .gif
1758 Gif,
1759 /// .svg
1760 Svg,
1761 /// .bmp
1762 Bmp,
1763 /// .tif or .tiff
1764 Tiff,
1765 /// .ico
1766 Ico,
1767}
1768
1769impl ImageFormat {
1770 /// Returns the mime type for the ImageFormat
1771 pub const fn mime_type(self) -> &'static str {
1772 match self {
1773 ImageFormat::Png => "image/png",
1774 ImageFormat::Jpeg => "image/jpeg",
1775 ImageFormat::Webp => "image/webp",
1776 ImageFormat::Gif => "image/gif",
1777 ImageFormat::Svg => "image/svg+xml",
1778 ImageFormat::Bmp => "image/bmp",
1779 ImageFormat::Tiff => "image/tiff",
1780 ImageFormat::Ico => "image/ico",
1781 }
1782 }
1783
1784 /// Returns the ImageFormat for the given mime type
1785 pub fn from_mime_type(mime_type: &str) -> Option<Self> {
1786 match mime_type {
1787 "image/png" => Some(Self::Png),
1788 "image/jpeg" | "image/jpg" => Some(Self::Jpeg),
1789 "image/webp" => Some(Self::Webp),
1790 "image/gif" => Some(Self::Gif),
1791 "image/svg+xml" => Some(Self::Svg),
1792 "image/bmp" => Some(Self::Bmp),
1793 "image/tiff" | "image/tif" => Some(Self::Tiff),
1794 "image/ico" => Some(Self::Ico),
1795 _ => None,
1796 }
1797 }
1798}
1799
1800/// An image, with a format and certain bytes
1801#[derive(Clone, Debug, PartialEq, Eq)]
1802pub struct Image {
1803 /// The image format the bytes represent (e.g. PNG)
1804 pub format: ImageFormat,
1805 /// The raw image bytes
1806 pub bytes: Vec<u8>,
1807 /// The unique ID for the image
1808 id: u64,
1809}
1810
1811impl Hash for Image {
1812 fn hash<H: Hasher>(&self, state: &mut H) {
1813 state.write_u64(self.id);
1814 }
1815}
1816
1817impl Image {
1818 /// An empty image containing no data
1819 pub fn empty() -> Self {
1820 Self::from_bytes(ImageFormat::Png, Vec::new())
1821 }
1822
1823 /// Create an image from a format and bytes
1824 pub fn from_bytes(format: ImageFormat, bytes: Vec<u8>) -> Self {
1825 Self {
1826 id: hash(&bytes),
1827 format,
1828 bytes,
1829 }
1830 }
1831
1832 /// Get this image's ID
1833 pub fn id(&self) -> u64 {
1834 self.id
1835 }
1836
1837 /// Use the GPUI `use_asset` API to make this image renderable
1838 pub fn use_render_image(
1839 self: Arc<Self>,
1840 window: &mut Window,
1841 cx: &mut App,
1842 ) -> Option<Arc<RenderImage>> {
1843 ImageSource::Image(self)
1844 .use_data(None, window, cx)
1845 .and_then(|result| result.ok())
1846 }
1847
1848 /// Use the GPUI `get_asset` API to make this image renderable
1849 pub fn get_render_image(
1850 self: Arc<Self>,
1851 window: &mut Window,
1852 cx: &mut App,
1853 ) -> Option<Arc<RenderImage>> {
1854 ImageSource::Image(self)
1855 .get_data(None, window, cx)
1856 .and_then(|result| result.ok())
1857 }
1858
1859 /// Use the GPUI `remove_asset` API to drop this image, if possible.
1860 pub fn remove_asset(self: Arc<Self>, cx: &mut App) {
1861 ImageSource::Image(self).remove_asset(cx);
1862 }
1863
1864 /// Convert the clipboard image to an `ImageData` object.
1865 pub fn to_image_data(&self, svg_renderer: SvgRenderer) -> Result<Arc<RenderImage>> {
1866 fn frames_for_image(
1867 bytes: &[u8],
1868 format: image::ImageFormat,
1869 ) -> Result<SmallVec<[Frame; 1]>> {
1870 let mut data = image::load_from_memory_with_format(bytes, format)?.into_rgba8();
1871
1872 // Convert from RGBA to BGRA.
1873 for pixel in data.chunks_exact_mut(4) {
1874 pixel.swap(0, 2);
1875 }
1876
1877 Ok(SmallVec::from_elem(Frame::new(data), 1))
1878 }
1879
1880 let frames = match self.format {
1881 ImageFormat::Gif => {
1882 let decoder = GifDecoder::new(Cursor::new(&self.bytes))?;
1883 let mut frames = SmallVec::new();
1884
1885 for frame in decoder.into_frames() {
1886 let mut frame = frame?;
1887 // Convert from RGBA to BGRA.
1888 for pixel in frame.buffer_mut().chunks_exact_mut(4) {
1889 pixel.swap(0, 2);
1890 }
1891 frames.push(frame);
1892 }
1893
1894 frames
1895 }
1896 ImageFormat::Png => frames_for_image(&self.bytes, image::ImageFormat::Png)?,
1897 ImageFormat::Jpeg => frames_for_image(&self.bytes, image::ImageFormat::Jpeg)?,
1898 ImageFormat::Webp => frames_for_image(&self.bytes, image::ImageFormat::WebP)?,
1899 ImageFormat::Bmp => frames_for_image(&self.bytes, image::ImageFormat::Bmp)?,
1900 ImageFormat::Tiff => frames_for_image(&self.bytes, image::ImageFormat::Tiff)?,
1901 ImageFormat::Ico => frames_for_image(&self.bytes, image::ImageFormat::Ico)?,
1902 ImageFormat::Svg => {
1903 return svg_renderer
1904 .render_single_frame(&self.bytes, 1.0, false)
1905 .map_err(Into::into);
1906 }
1907 };
1908
1909 Ok(Arc::new(RenderImage::new(frames)))
1910 }
1911
1912 /// Get the format of the clipboard image
1913 pub fn format(&self) -> ImageFormat {
1914 self.format
1915 }
1916
1917 /// Get the raw bytes of the clipboard image
1918 pub fn bytes(&self) -> &[u8] {
1919 self.bytes.as_slice()
1920 }
1921}
1922
1923/// A clipboard item that should be copied to the clipboard
1924#[derive(Clone, Debug, Eq, PartialEq)]
1925pub struct ClipboardString {
1926 pub(crate) text: String,
1927 pub(crate) metadata: Option<String>,
1928}
1929
1930impl ClipboardString {
1931 /// Create a new clipboard string with the given text
1932 pub fn new(text: String) -> Self {
1933 Self {
1934 text,
1935 metadata: None,
1936 }
1937 }
1938
1939 /// Return a new clipboard item with the metadata replaced by the given metadata,
1940 /// after serializing it as JSON.
1941 pub fn with_json_metadata<T: Serialize>(mut self, metadata: T) -> Self {
1942 self.metadata = Some(serde_json::to_string(&metadata).unwrap());
1943 self
1944 }
1945
1946 /// Get the text of the clipboard string
1947 pub fn text(&self) -> &String {
1948 &self.text
1949 }
1950
1951 /// Get the owned text of the clipboard string
1952 pub fn into_text(self) -> String {
1953 self.text
1954 }
1955
1956 /// Get the metadata of the clipboard string, formatted as JSON
1957 pub fn metadata_json<T>(&self) -> Option<T>
1958 where
1959 T: for<'a> Deserialize<'a>,
1960 {
1961 self.metadata
1962 .as_ref()
1963 .and_then(|m| serde_json::from_str(m).ok())
1964 }
1965
1966 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1967 pub(crate) fn text_hash(text: &str) -> u64 {
1968 let mut hasher = SeaHasher::new();
1969 text.hash(&mut hasher);
1970 hasher.finish()
1971 }
1972}
1973
1974impl From<String> for ClipboardString {
1975 fn from(value: String) -> Self {
1976 Self {
1977 text: value,
1978 metadata: None,
1979 }
1980 }
1981}