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