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