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
549 #[cfg(any(test, feature = "test-support"))]
550 fn as_test(&self) -> Option<&TestDispatcher> {
551 None
552 }
553}
554
555pub(crate) trait PlatformTextSystem: Send + Sync {
556 fn add_fonts(&self, fonts: Vec<Cow<'static, [u8]>>) -> Result<()>;
557 fn all_font_names(&self) -> Vec<String>;
558 fn font_id(&self, descriptor: &Font) -> Result<FontId>;
559 fn font_metrics(&self, font_id: FontId) -> FontMetrics;
560 fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Bounds<f32>>;
561 fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Size<f32>>;
562 fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option<GlyphId>;
563 fn glyph_raster_bounds(&self, params: &RenderGlyphParams) -> Result<Bounds<DevicePixels>>;
564 fn rasterize_glyph(
565 &self,
566 params: &RenderGlyphParams,
567 raster_bounds: Bounds<DevicePixels>,
568 ) -> Result<(Size<DevicePixels>, Vec<u8>)>;
569 fn layout_line(&self, text: &str, font_size: Pixels, runs: &[FontRun]) -> LineLayout;
570}
571
572pub(crate) struct NoopTextSystem;
573
574impl NoopTextSystem {
575 #[allow(dead_code)]
576 pub fn new() -> Self {
577 Self
578 }
579}
580
581impl PlatformTextSystem for NoopTextSystem {
582 fn add_fonts(&self, _fonts: Vec<Cow<'static, [u8]>>) -> Result<()> {
583 Ok(())
584 }
585
586 fn all_font_names(&self) -> Vec<String> {
587 Vec::new()
588 }
589
590 fn font_id(&self, _descriptor: &Font) -> Result<FontId> {
591 return Ok(FontId(1));
592 }
593
594 fn font_metrics(&self, _font_id: FontId) -> FontMetrics {
595 FontMetrics {
596 units_per_em: 1000,
597 ascent: 1025.0,
598 descent: -275.0,
599 line_gap: 0.0,
600 underline_position: -95.0,
601 underline_thickness: 60.0,
602 cap_height: 698.0,
603 x_height: 516.0,
604 bounding_box: Bounds {
605 origin: Point {
606 x: -260.0,
607 y: -245.0,
608 },
609 size: Size {
610 width: 1501.0,
611 height: 1364.0,
612 },
613 },
614 }
615 }
616
617 fn typographic_bounds(&self, _font_id: FontId, _glyph_id: GlyphId) -> Result<Bounds<f32>> {
618 Ok(Bounds {
619 origin: Point { x: 54.0, y: 0.0 },
620 size: size(392.0, 528.0),
621 })
622 }
623
624 fn advance(&self, _font_id: FontId, glyph_id: GlyphId) -> Result<Size<f32>> {
625 Ok(size(600.0 * glyph_id.0 as f32, 0.0))
626 }
627
628 fn glyph_for_char(&self, _font_id: FontId, ch: char) -> Option<GlyphId> {
629 Some(GlyphId(ch.len_utf16() as u32))
630 }
631
632 fn glyph_raster_bounds(&self, _params: &RenderGlyphParams) -> Result<Bounds<DevicePixels>> {
633 Ok(Default::default())
634 }
635
636 fn rasterize_glyph(
637 &self,
638 _params: &RenderGlyphParams,
639 raster_bounds: Bounds<DevicePixels>,
640 ) -> Result<(Size<DevicePixels>, Vec<u8>)> {
641 Ok((raster_bounds.size, Vec::new()))
642 }
643
644 fn layout_line(&self, text: &str, font_size: Pixels, _runs: &[FontRun]) -> LineLayout {
645 let mut position = px(0.);
646 let metrics = self.font_metrics(FontId(0));
647 let em_width = font_size
648 * self
649 .advance(FontId(0), self.glyph_for_char(FontId(0), 'm').unwrap())
650 .unwrap()
651 .width
652 / metrics.units_per_em as f32;
653 let mut glyphs = Vec::new();
654 for (ix, c) in text.char_indices() {
655 if let Some(glyph) = self.glyph_for_char(FontId(0), c) {
656 glyphs.push(ShapedGlyph {
657 id: glyph,
658 position: point(position, px(0.)),
659 index: ix,
660 is_emoji: glyph.0 == 2,
661 });
662 if glyph.0 == 2 {
663 position += em_width * 2.0;
664 } else {
665 position += em_width;
666 }
667 } else {
668 position += em_width
669 }
670 }
671 let mut runs = Vec::default();
672 if glyphs.len() > 0 {
673 runs.push(ShapedRun {
674 font_id: FontId(0),
675 glyphs,
676 });
677 } else {
678 position = px(0.);
679 }
680
681 LineLayout {
682 font_size,
683 width: position,
684 ascent: font_size * (metrics.ascent / metrics.units_per_em as f32),
685 descent: font_size * (metrics.descent / metrics.units_per_em as f32),
686 runs,
687 len: text.len(),
688 }
689 }
690}
691
692#[derive(PartialEq, Eq, Hash, Clone)]
693pub(crate) enum AtlasKey {
694 Glyph(RenderGlyphParams),
695 Svg(RenderSvgParams),
696 Image(RenderImageParams),
697}
698
699impl AtlasKey {
700 #[cfg_attr(
701 all(
702 any(target_os = "linux", target_os = "freebsd"),
703 not(any(feature = "x11", feature = "wayland"))
704 ),
705 allow(dead_code)
706 )]
707 pub(crate) fn texture_kind(&self) -> AtlasTextureKind {
708 match self {
709 AtlasKey::Glyph(params) => {
710 if params.is_emoji {
711 AtlasTextureKind::Polychrome
712 } else {
713 AtlasTextureKind::Monochrome
714 }
715 }
716 AtlasKey::Svg(_) => AtlasTextureKind::Monochrome,
717 AtlasKey::Image(_) => AtlasTextureKind::Polychrome,
718 }
719 }
720}
721
722impl From<RenderGlyphParams> for AtlasKey {
723 fn from(params: RenderGlyphParams) -> Self {
724 Self::Glyph(params)
725 }
726}
727
728impl From<RenderSvgParams> for AtlasKey {
729 fn from(params: RenderSvgParams) -> Self {
730 Self::Svg(params)
731 }
732}
733
734impl From<RenderImageParams> for AtlasKey {
735 fn from(params: RenderImageParams) -> Self {
736 Self::Image(params)
737 }
738}
739
740pub(crate) trait PlatformAtlas: Send + Sync {
741 fn get_or_insert_with<'a>(
742 &self,
743 key: &AtlasKey,
744 build: &mut dyn FnMut() -> Result<Option<(Size<DevicePixels>, Cow<'a, [u8]>)>>,
745 ) -> Result<Option<AtlasTile>>;
746 fn remove(&self, key: &AtlasKey);
747}
748
749struct AtlasTextureList<T> {
750 textures: Vec<Option<T>>,
751 free_list: Vec<usize>,
752}
753
754impl<T> Default for AtlasTextureList<T> {
755 fn default() -> Self {
756 Self {
757 textures: Vec::default(),
758 free_list: Vec::default(),
759 }
760 }
761}
762
763impl<T> ops::Index<usize> for AtlasTextureList<T> {
764 type Output = Option<T>;
765
766 fn index(&self, index: usize) -> &Self::Output {
767 &self.textures[index]
768 }
769}
770
771impl<T> AtlasTextureList<T> {
772 #[allow(unused)]
773 fn drain(&mut self) -> std::vec::Drain<'_, Option<T>> {
774 self.free_list.clear();
775 self.textures.drain(..)
776 }
777
778 #[allow(dead_code)]
779 fn iter_mut(&mut self) -> impl DoubleEndedIterator<Item = &mut T> {
780 self.textures.iter_mut().flatten()
781 }
782}
783
784#[derive(Clone, Debug, PartialEq, Eq)]
785#[repr(C)]
786pub(crate) struct AtlasTile {
787 pub(crate) texture_id: AtlasTextureId,
788 pub(crate) tile_id: TileId,
789 pub(crate) padding: u32,
790 pub(crate) bounds: Bounds<DevicePixels>,
791}
792
793#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
794#[repr(C)]
795pub(crate) struct AtlasTextureId {
796 // We use u32 instead of usize for Metal Shader Language compatibility
797 pub(crate) index: u32,
798 pub(crate) kind: AtlasTextureKind,
799}
800
801#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
802#[repr(C)]
803#[cfg_attr(
804 all(
805 any(target_os = "linux", target_os = "freebsd"),
806 not(any(feature = "x11", feature = "wayland"))
807 ),
808 allow(dead_code)
809)]
810pub(crate) enum AtlasTextureKind {
811 Monochrome = 0,
812 Polychrome = 1,
813}
814
815#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
816#[repr(C)]
817pub(crate) struct TileId(pub(crate) u32);
818
819impl From<etagere::AllocId> for TileId {
820 fn from(id: etagere::AllocId) -> Self {
821 Self(id.serialize())
822 }
823}
824
825impl From<TileId> for etagere::AllocId {
826 fn from(id: TileId) -> Self {
827 Self::deserialize(id.0)
828 }
829}
830
831pub(crate) struct PlatformInputHandler {
832 cx: AsyncWindowContext,
833 handler: Box<dyn InputHandler>,
834}
835
836#[cfg_attr(
837 all(
838 any(target_os = "linux", target_os = "freebsd"),
839 not(any(feature = "x11", feature = "wayland"))
840 ),
841 allow(dead_code)
842)]
843impl PlatformInputHandler {
844 pub fn new(cx: AsyncWindowContext, handler: Box<dyn InputHandler>) -> Self {
845 Self { cx, handler }
846 }
847
848 fn selected_text_range(&mut self, ignore_disabled_input: bool) -> Option<UTF16Selection> {
849 self.cx
850 .update(|window, cx| {
851 self.handler
852 .selected_text_range(ignore_disabled_input, window, cx)
853 })
854 .ok()
855 .flatten()
856 }
857
858 #[cfg_attr(target_os = "windows", allow(dead_code))]
859 fn marked_text_range(&mut self) -> Option<Range<usize>> {
860 self.cx
861 .update(|window, cx| self.handler.marked_text_range(window, cx))
862 .ok()
863 .flatten()
864 }
865
866 #[cfg_attr(
867 any(target_os = "linux", target_os = "freebsd", target_os = "windows"),
868 allow(dead_code)
869 )]
870 fn text_for_range(
871 &mut self,
872 range_utf16: Range<usize>,
873 adjusted: &mut Option<Range<usize>>,
874 ) -> Option<String> {
875 self.cx
876 .update(|window, cx| {
877 self.handler
878 .text_for_range(range_utf16, adjusted, window, cx)
879 })
880 .ok()
881 .flatten()
882 }
883
884 fn replace_text_in_range(&mut self, replacement_range: Option<Range<usize>>, text: &str) {
885 self.cx
886 .update(|window, cx| {
887 self.handler
888 .replace_text_in_range(replacement_range, text, window, cx);
889 })
890 .ok();
891 }
892
893 pub fn replace_and_mark_text_in_range(
894 &mut self,
895 range_utf16: Option<Range<usize>>,
896 new_text: &str,
897 new_selected_range: Option<Range<usize>>,
898 ) {
899 self.cx
900 .update(|window, cx| {
901 self.handler.replace_and_mark_text_in_range(
902 range_utf16,
903 new_text,
904 new_selected_range,
905 window,
906 cx,
907 )
908 })
909 .ok();
910 }
911
912 #[cfg_attr(target_os = "windows", allow(dead_code))]
913 fn unmark_text(&mut self) {
914 self.cx
915 .update(|window, cx| self.handler.unmark_text(window, cx))
916 .ok();
917 }
918
919 fn bounds_for_range(&mut self, range_utf16: Range<usize>) -> Option<Bounds<Pixels>> {
920 self.cx
921 .update(|window, cx| self.handler.bounds_for_range(range_utf16, window, cx))
922 .ok()
923 .flatten()
924 }
925
926 #[allow(dead_code)]
927 fn apple_press_and_hold_enabled(&mut self) -> bool {
928 self.handler.apple_press_and_hold_enabled()
929 }
930
931 pub(crate) fn dispatch_input(&mut self, input: &str, window: &mut Window, cx: &mut App) {
932 self.handler.replace_text_in_range(None, input, window, cx);
933 }
934
935 pub fn selected_bounds(&mut self, window: &mut Window, cx: &mut App) -> Option<Bounds<Pixels>> {
936 let selection = self.handler.selected_text_range(true, window, cx)?;
937 self.handler.bounds_for_range(
938 if selection.reversed {
939 selection.range.start..selection.range.start
940 } else {
941 selection.range.end..selection.range.end
942 },
943 window,
944 cx,
945 )
946 }
947
948 #[allow(unused)]
949 pub fn character_index_for_point(&mut self, point: Point<Pixels>) -> Option<usize> {
950 self.cx
951 .update(|window, cx| self.handler.character_index_for_point(point, window, cx))
952 .ok()
953 .flatten()
954 }
955}
956
957/// A struct representing a selection in a text buffer, in UTF16 characters.
958/// This is different from a range because the head may be before the tail.
959#[derive(Debug)]
960pub struct UTF16Selection {
961 /// The range of text in the document this selection corresponds to
962 /// in UTF16 characters.
963 pub range: Range<usize>,
964 /// Whether the head of this selection is at the start (true), or end (false)
965 /// of the range
966 pub reversed: bool,
967}
968
969/// Zed's interface for handling text input from the platform's IME system
970/// This is currently a 1:1 exposure of the NSTextInputClient API:
971///
972/// <https://developer.apple.com/documentation/appkit/nstextinputclient>
973pub trait InputHandler: 'static {
974 /// Get the range of the user's currently selected text, if any
975 /// Corresponds to [selectedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438242-selectedrange)
976 ///
977 /// Return value is in terms of UTF-16 characters, from 0 to the length of the document
978 fn selected_text_range(
979 &mut self,
980 ignore_disabled_input: bool,
981 window: &mut Window,
982 cx: &mut App,
983 ) -> Option<UTF16Selection>;
984
985 /// Get the range of the currently marked text, if any
986 /// Corresponds to [markedRange()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438250-markedrange)
987 ///
988 /// Return value is in terms of UTF-16 characters, from 0 to the length of the document
989 fn marked_text_range(&mut self, window: &mut Window, cx: &mut App) -> Option<Range<usize>>;
990
991 /// Get the text for the given document range in UTF-16 characters
992 /// Corresponds to [attributedSubstring(forProposedRange: actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438238-attributedsubstring)
993 ///
994 /// range_utf16 is in terms of UTF-16 characters
995 fn text_for_range(
996 &mut self,
997 range_utf16: Range<usize>,
998 adjusted_range: &mut Option<Range<usize>>,
999 window: &mut Window,
1000 cx: &mut App,
1001 ) -> Option<String>;
1002
1003 /// Replace the text in the given document range with the given text
1004 /// Corresponds to [insertText(_:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438258-inserttext)
1005 ///
1006 /// replacement_range is in terms of UTF-16 characters
1007 fn replace_text_in_range(
1008 &mut self,
1009 replacement_range: Option<Range<usize>>,
1010 text: &str,
1011 window: &mut Window,
1012 cx: &mut App,
1013 );
1014
1015 /// Replace the text in the given document range with the given text,
1016 /// and mark the given text as part of an IME 'composing' state
1017 /// Corresponds to [setMarkedText(_:selectedRange:replacementRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438246-setmarkedtext)
1018 ///
1019 /// range_utf16 is in terms of UTF-16 characters
1020 /// new_selected_range is in terms of UTF-16 characters
1021 fn replace_and_mark_text_in_range(
1022 &mut self,
1023 range_utf16: Option<Range<usize>>,
1024 new_text: &str,
1025 new_selected_range: Option<Range<usize>>,
1026 window: &mut Window,
1027 cx: &mut App,
1028 );
1029
1030 /// Remove the IME 'composing' state from the document
1031 /// Corresponds to [unmarkText()](https://developer.apple.com/documentation/appkit/nstextinputclient/1438239-unmarktext)
1032 fn unmark_text(&mut self, window: &mut Window, cx: &mut App);
1033
1034 /// Get the bounds of the given document range in screen coordinates
1035 /// Corresponds to [firstRect(forCharacterRange:actualRange:)](https://developer.apple.com/documentation/appkit/nstextinputclient/1438240-firstrect)
1036 ///
1037 /// This is used for positioning the IME candidate window
1038 fn bounds_for_range(
1039 &mut self,
1040 range_utf16: Range<usize>,
1041 window: &mut Window,
1042 cx: &mut App,
1043 ) -> Option<Bounds<Pixels>>;
1044
1045 /// Get the character offset for the given point in terms of UTF16 characters
1046 ///
1047 /// Corresponds to [characterIndexForPoint:](https://developer.apple.com/documentation/appkit/nstextinputclient/characterindex(for:))
1048 fn character_index_for_point(
1049 &mut self,
1050 point: Point<Pixels>,
1051 window: &mut Window,
1052 cx: &mut App,
1053 ) -> Option<usize>;
1054
1055 /// Allows a given input context to opt into getting raw key repeats instead of
1056 /// sending these to the platform.
1057 /// TODO: Ideally we should be able to set ApplePressAndHoldEnabled in NSUserDefaults
1058 /// (which is how iTerm does it) but it doesn't seem to work for me.
1059 #[allow(dead_code)]
1060 fn apple_press_and_hold_enabled(&mut self) -> bool {
1061 true
1062 }
1063}
1064
1065/// The variables that can be configured when creating a new window
1066#[derive(Debug)]
1067pub struct WindowOptions {
1068 /// Specifies the state and bounds of the window in screen coordinates.
1069 /// - `None`: Inherit the bounds.
1070 /// - `Some(WindowBounds)`: Open a window with corresponding state and its restore size.
1071 pub window_bounds: Option<WindowBounds>,
1072
1073 /// The titlebar configuration of the window
1074 pub titlebar: Option<TitlebarOptions>,
1075
1076 /// Whether the window should be focused when created
1077 pub focus: bool,
1078
1079 /// Whether the window should be shown when created
1080 pub show: bool,
1081
1082 /// The kind of window to create
1083 pub kind: WindowKind,
1084
1085 /// Whether the window should be movable by the user
1086 pub is_movable: bool,
1087
1088 /// The display to create the window on, if this is None,
1089 /// the window will be created on the main display
1090 pub display_id: Option<DisplayId>,
1091
1092 /// The appearance of the window background.
1093 pub window_background: WindowBackgroundAppearance,
1094
1095 /// Application identifier of the window. Can by used by desktop environments to group applications together.
1096 pub app_id: Option<String>,
1097
1098 /// Window minimum size
1099 pub window_min_size: Option<Size<Pixels>>,
1100
1101 /// Whether to use client or server side decorations. Wayland only
1102 /// Note that this may be ignored.
1103 pub window_decorations: Option<WindowDecorations>,
1104}
1105
1106/// The variables that can be configured when creating a new window
1107#[derive(Debug)]
1108#[cfg_attr(
1109 all(
1110 any(target_os = "linux", target_os = "freebsd"),
1111 not(any(feature = "x11", feature = "wayland"))
1112 ),
1113 allow(dead_code)
1114)]
1115pub(crate) struct WindowParams {
1116 pub bounds: Bounds<Pixels>,
1117
1118 /// The titlebar configuration of the window
1119 #[cfg_attr(feature = "wayland", allow(dead_code))]
1120 pub titlebar: Option<TitlebarOptions>,
1121
1122 /// The kind of window to create
1123 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1124 pub kind: WindowKind,
1125
1126 /// Whether the window should be movable by the user
1127 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1128 pub is_movable: bool,
1129
1130 #[cfg_attr(
1131 any(target_os = "linux", target_os = "freebsd", target_os = "windows"),
1132 allow(dead_code)
1133 )]
1134 pub focus: bool,
1135
1136 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1137 pub show: bool,
1138
1139 #[cfg_attr(feature = "wayland", allow(dead_code))]
1140 pub display_id: Option<DisplayId>,
1141
1142 pub window_min_size: Option<Size<Pixels>>,
1143}
1144
1145/// Represents the status of how a window should be opened.
1146#[derive(Debug, Copy, Clone, PartialEq)]
1147pub enum WindowBounds {
1148 /// Indicates that the window should open in a windowed state with the given bounds.
1149 Windowed(Bounds<Pixels>),
1150 /// Indicates that the window should open in a maximized state.
1151 /// The bounds provided here represent the restore size of the window.
1152 Maximized(Bounds<Pixels>),
1153 /// Indicates that the window should open in fullscreen mode.
1154 /// The bounds provided here represent the restore size of the window.
1155 Fullscreen(Bounds<Pixels>),
1156}
1157
1158impl Default for WindowBounds {
1159 fn default() -> Self {
1160 WindowBounds::Windowed(Bounds::default())
1161 }
1162}
1163
1164impl WindowBounds {
1165 /// Retrieve the inner bounds
1166 pub fn get_bounds(&self) -> Bounds<Pixels> {
1167 match self {
1168 WindowBounds::Windowed(bounds) => *bounds,
1169 WindowBounds::Maximized(bounds) => *bounds,
1170 WindowBounds::Fullscreen(bounds) => *bounds,
1171 }
1172 }
1173}
1174
1175impl Default for WindowOptions {
1176 fn default() -> Self {
1177 Self {
1178 window_bounds: None,
1179 titlebar: Some(TitlebarOptions {
1180 title: Default::default(),
1181 appears_transparent: Default::default(),
1182 traffic_light_position: Default::default(),
1183 }),
1184 focus: true,
1185 show: true,
1186 kind: WindowKind::Normal,
1187 is_movable: true,
1188 display_id: None,
1189 window_background: WindowBackgroundAppearance::default(),
1190 app_id: None,
1191 window_min_size: None,
1192 window_decorations: None,
1193 }
1194 }
1195}
1196
1197/// The options that can be configured for a window's titlebar
1198#[derive(Debug, Default)]
1199pub struct TitlebarOptions {
1200 /// The initial title of the window
1201 pub title: Option<SharedString>,
1202
1203 /// Should the default system titlebar be hidden to allow for a custom-drawn titlebar? (macOS and Windows only)
1204 /// Refer to [`WindowOptions::window_decorations`] on Linux
1205 pub appears_transparent: bool,
1206
1207 /// The position of the macOS traffic light buttons
1208 pub traffic_light_position: Option<Point<Pixels>>,
1209}
1210
1211/// The kind of window to create
1212#[derive(Copy, Clone, Debug, PartialEq, Eq)]
1213pub enum WindowKind {
1214 /// A normal application window
1215 Normal,
1216
1217 /// A window that appears above all other windows, usually used for alerts or popups
1218 /// use sparingly!
1219 PopUp,
1220}
1221
1222/// The appearance of the window, as defined by the operating system.
1223///
1224/// On macOS, this corresponds to named [`NSAppearance`](https://developer.apple.com/documentation/appkit/nsappearance)
1225/// values.
1226#[derive(Copy, Clone, Debug, PartialEq, Eq)]
1227pub enum WindowAppearance {
1228 /// A light appearance.
1229 ///
1230 /// On macOS, this corresponds to the `aqua` appearance.
1231 Light,
1232
1233 /// A light appearance with vibrant colors.
1234 ///
1235 /// On macOS, this corresponds to the `NSAppearanceNameVibrantLight` appearance.
1236 VibrantLight,
1237
1238 /// A dark appearance.
1239 ///
1240 /// On macOS, this corresponds to the `darkAqua` appearance.
1241 Dark,
1242
1243 /// A dark appearance with vibrant colors.
1244 ///
1245 /// On macOS, this corresponds to the `NSAppearanceNameVibrantDark` appearance.
1246 VibrantDark,
1247}
1248
1249impl Default for WindowAppearance {
1250 fn default() -> Self {
1251 Self::Light
1252 }
1253}
1254
1255/// The appearance of the background of the window itself, when there is
1256/// no content or the content is transparent.
1257#[derive(Copy, Clone, Debug, Default, PartialEq)]
1258pub enum WindowBackgroundAppearance {
1259 /// Opaque.
1260 ///
1261 /// This lets the window manager know that content behind this
1262 /// window does not need to be drawn.
1263 ///
1264 /// Actual color depends on the system and themes should define a fully
1265 /// opaque background color instead.
1266 #[default]
1267 Opaque,
1268 /// Plain alpha transparency.
1269 Transparent,
1270 /// Transparency, but the contents behind the window are blurred.
1271 ///
1272 /// Not always supported.
1273 Blurred,
1274}
1275
1276/// The options that can be configured for a file dialog prompt
1277#[derive(Copy, Clone, Debug)]
1278pub struct PathPromptOptions {
1279 /// Should the prompt allow files to be selected?
1280 pub files: bool,
1281 /// Should the prompt allow directories to be selected?
1282 pub directories: bool,
1283 /// Should the prompt allow multiple files to be selected?
1284 pub multiple: bool,
1285}
1286
1287/// What kind of prompt styling to show
1288#[derive(Copy, Clone, Debug, PartialEq)]
1289pub enum PromptLevel {
1290 /// A prompt that is shown when the user should be notified of something
1291 Info,
1292
1293 /// A prompt that is shown when the user needs to be warned of a potential problem
1294 Warning,
1295
1296 /// A prompt that is shown when a critical problem has occurred
1297 Critical,
1298}
1299
1300/// Prompt Button
1301#[derive(Clone, Debug, PartialEq)]
1302pub enum PromptButton {
1303 /// Ok button
1304 Ok(SharedString),
1305 /// Cancel button
1306 Cancel(SharedString),
1307 /// Other button
1308 Other(SharedString),
1309}
1310
1311impl PromptButton {
1312 /// Create a button with label
1313 pub fn new(label: impl Into<SharedString>) -> Self {
1314 PromptButton::Other(label.into())
1315 }
1316
1317 /// Create an Ok button
1318 pub fn ok(label: impl Into<SharedString>) -> Self {
1319 PromptButton::Ok(label.into())
1320 }
1321
1322 /// Create a Cancel button
1323 pub fn cancel(label: impl Into<SharedString>) -> Self {
1324 PromptButton::Cancel(label.into())
1325 }
1326
1327 #[allow(dead_code)]
1328 pub(crate) fn is_cancel(&self) -> bool {
1329 matches!(self, PromptButton::Cancel(_))
1330 }
1331
1332 /// Returns the label of the button
1333 pub fn label(&self) -> &SharedString {
1334 match self {
1335 PromptButton::Ok(label) => label,
1336 PromptButton::Cancel(label) => label,
1337 PromptButton::Other(label) => label,
1338 }
1339 }
1340}
1341
1342impl From<&str> for PromptButton {
1343 fn from(value: &str) -> Self {
1344 match value.to_lowercase().as_str() {
1345 "ok" => PromptButton::Ok("Ok".into()),
1346 "cancel" => PromptButton::Cancel("Cancel".into()),
1347 _ => PromptButton::Other(SharedString::from(value.to_owned())),
1348 }
1349 }
1350}
1351
1352/// The style of the cursor (pointer)
1353#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize, JsonSchema)]
1354pub enum CursorStyle {
1355 /// The default cursor
1356 Arrow,
1357
1358 /// A text input cursor
1359 /// corresponds to the CSS cursor value `text`
1360 IBeam,
1361
1362 /// A crosshair cursor
1363 /// corresponds to the CSS cursor value `crosshair`
1364 Crosshair,
1365
1366 /// A closed hand cursor
1367 /// corresponds to the CSS cursor value `grabbing`
1368 ClosedHand,
1369
1370 /// An open hand cursor
1371 /// corresponds to the CSS cursor value `grab`
1372 OpenHand,
1373
1374 /// A pointing hand cursor
1375 /// corresponds to the CSS cursor value `pointer`
1376 PointingHand,
1377
1378 /// A resize left cursor
1379 /// corresponds to the CSS cursor value `w-resize`
1380 ResizeLeft,
1381
1382 /// A resize right cursor
1383 /// corresponds to the CSS cursor value `e-resize`
1384 ResizeRight,
1385
1386 /// A resize cursor to the left and right
1387 /// corresponds to the CSS cursor value `ew-resize`
1388 ResizeLeftRight,
1389
1390 /// A resize up cursor
1391 /// corresponds to the CSS cursor value `n-resize`
1392 ResizeUp,
1393
1394 /// A resize down cursor
1395 /// corresponds to the CSS cursor value `s-resize`
1396 ResizeDown,
1397
1398 /// A resize cursor directing up and down
1399 /// corresponds to the CSS cursor value `ns-resize`
1400 ResizeUpDown,
1401
1402 /// A resize cursor directing up-left and down-right
1403 /// corresponds to the CSS cursor value `nesw-resize`
1404 ResizeUpLeftDownRight,
1405
1406 /// A resize cursor directing up-right and down-left
1407 /// corresponds to the CSS cursor value `nwse-resize`
1408 ResizeUpRightDownLeft,
1409
1410 /// A cursor indicating that the item/column can be resized horizontally.
1411 /// corresponds to the CSS cursor value `col-resize`
1412 ResizeColumn,
1413
1414 /// A cursor indicating that the item/row can be resized vertically.
1415 /// corresponds to the CSS cursor value `row-resize`
1416 ResizeRow,
1417
1418 /// A text input cursor for vertical layout
1419 /// corresponds to the CSS cursor value `vertical-text`
1420 IBeamCursorForVerticalLayout,
1421
1422 /// A cursor indicating that the operation is not allowed
1423 /// corresponds to the CSS cursor value `not-allowed`
1424 OperationNotAllowed,
1425
1426 /// A cursor indicating that the operation will result in a link
1427 /// corresponds to the CSS cursor value `alias`
1428 DragLink,
1429
1430 /// A cursor indicating that the operation will result in a copy
1431 /// corresponds to the CSS cursor value `copy`
1432 DragCopy,
1433
1434 /// A cursor indicating that the operation will result in a context menu
1435 /// corresponds to the CSS cursor value `context-menu`
1436 ContextualMenu,
1437
1438 /// Hide the cursor
1439 None,
1440}
1441
1442impl Default for CursorStyle {
1443 fn default() -> Self {
1444 Self::Arrow
1445 }
1446}
1447
1448/// A clipboard item that should be copied to the clipboard
1449#[derive(Clone, Debug, Eq, PartialEq)]
1450pub struct ClipboardItem {
1451 entries: Vec<ClipboardEntry>,
1452}
1453
1454/// Either a ClipboardString or a ClipboardImage
1455#[derive(Clone, Debug, Eq, PartialEq)]
1456pub enum ClipboardEntry {
1457 /// A string entry
1458 String(ClipboardString),
1459 /// An image entry
1460 Image(Image),
1461}
1462
1463impl ClipboardItem {
1464 /// Create a new ClipboardItem::String with no associated metadata
1465 pub fn new_string(text: String) -> Self {
1466 Self {
1467 entries: vec![ClipboardEntry::String(ClipboardString::new(text))],
1468 }
1469 }
1470
1471 /// Create a new ClipboardItem::String with the given text and associated metadata
1472 pub fn new_string_with_metadata(text: String, metadata: String) -> Self {
1473 Self {
1474 entries: vec![ClipboardEntry::String(ClipboardString {
1475 text,
1476 metadata: Some(metadata),
1477 })],
1478 }
1479 }
1480
1481 /// Create a new ClipboardItem::String with the given text and associated metadata
1482 pub fn new_string_with_json_metadata<T: Serialize>(text: String, metadata: T) -> Self {
1483 Self {
1484 entries: vec![ClipboardEntry::String(
1485 ClipboardString::new(text).with_json_metadata(metadata),
1486 )],
1487 }
1488 }
1489
1490 /// Create a new ClipboardItem::Image with the given image with no associated metadata
1491 pub fn new_image(image: &Image) -> Self {
1492 Self {
1493 entries: vec![ClipboardEntry::Image(image.clone())],
1494 }
1495 }
1496
1497 /// Concatenates together all the ClipboardString entries in the item.
1498 /// Returns None if there were no ClipboardString entries.
1499 pub fn text(&self) -> Option<String> {
1500 let mut answer = String::new();
1501 let mut any_entries = false;
1502
1503 for entry in self.entries.iter() {
1504 if let ClipboardEntry::String(ClipboardString { text, metadata: _ }) = entry {
1505 answer.push_str(&text);
1506 any_entries = true;
1507 }
1508 }
1509
1510 if any_entries { Some(answer) } else { None }
1511 }
1512
1513 /// If this item is one ClipboardEntry::String, returns its metadata.
1514 #[cfg_attr(not(target_os = "windows"), allow(dead_code))]
1515 pub fn metadata(&self) -> Option<&String> {
1516 match self.entries().first() {
1517 Some(ClipboardEntry::String(clipboard_string)) if self.entries.len() == 1 => {
1518 clipboard_string.metadata.as_ref()
1519 }
1520 _ => None,
1521 }
1522 }
1523
1524 /// Get the item's entries
1525 pub fn entries(&self) -> &[ClipboardEntry] {
1526 &self.entries
1527 }
1528
1529 /// Get owned versions of the item's entries
1530 pub fn into_entries(self) -> impl Iterator<Item = ClipboardEntry> {
1531 self.entries.into_iter()
1532 }
1533}
1534
1535impl From<ClipboardString> for ClipboardEntry {
1536 fn from(value: ClipboardString) -> Self {
1537 Self::String(value)
1538 }
1539}
1540
1541impl From<String> for ClipboardEntry {
1542 fn from(value: String) -> Self {
1543 Self::from(ClipboardString::from(value))
1544 }
1545}
1546
1547impl From<Image> for ClipboardEntry {
1548 fn from(value: Image) -> Self {
1549 Self::Image(value)
1550 }
1551}
1552
1553impl From<ClipboardEntry> for ClipboardItem {
1554 fn from(value: ClipboardEntry) -> Self {
1555 Self {
1556 entries: vec![value],
1557 }
1558 }
1559}
1560
1561impl From<String> for ClipboardItem {
1562 fn from(value: String) -> Self {
1563 Self::from(ClipboardEntry::from(value))
1564 }
1565}
1566
1567impl From<Image> for ClipboardItem {
1568 fn from(value: Image) -> Self {
1569 Self::from(ClipboardEntry::from(value))
1570 }
1571}
1572
1573/// One of the editor's supported image formats (e.g. PNG, JPEG) - used when dealing with images in the clipboard
1574#[derive(Clone, Copy, Debug, Eq, PartialEq, EnumIter, Hash)]
1575pub enum ImageFormat {
1576 // Sorted from most to least likely to be pasted into an editor,
1577 // which matters when we iterate through them trying to see if
1578 // clipboard content matches them.
1579 /// .png
1580 Png,
1581 /// .jpeg or .jpg
1582 Jpeg,
1583 /// .webp
1584 Webp,
1585 /// .gif
1586 Gif,
1587 /// .svg
1588 Svg,
1589 /// .bmp
1590 Bmp,
1591 /// .tif or .tiff
1592 Tiff,
1593}
1594
1595impl ImageFormat {
1596 /// Returns the mime type for the ImageFormat
1597 pub const fn mime_type(self) -> &'static str {
1598 match self {
1599 ImageFormat::Png => "image/png",
1600 ImageFormat::Jpeg => "image/jpeg",
1601 ImageFormat::Webp => "image/webp",
1602 ImageFormat::Gif => "image/gif",
1603 ImageFormat::Svg => "image/svg+xml",
1604 ImageFormat::Bmp => "image/bmp",
1605 ImageFormat::Tiff => "image/tiff",
1606 }
1607 }
1608
1609 /// Returns the ImageFormat for the given mime type
1610 pub fn from_mime_type(mime_type: &str) -> Option<Self> {
1611 match mime_type {
1612 "image/png" => Some(Self::Png),
1613 "image/jpeg" | "image/jpg" => Some(Self::Jpeg),
1614 "image/webp" => Some(Self::Webp),
1615 "image/gif" => Some(Self::Gif),
1616 "image/svg+xml" => Some(Self::Svg),
1617 "image/bmp" => Some(Self::Bmp),
1618 "image/tiff" | "image/tif" => Some(Self::Tiff),
1619 _ => None,
1620 }
1621 }
1622}
1623
1624/// An image, with a format and certain bytes
1625#[derive(Clone, Debug, PartialEq, Eq)]
1626pub struct Image {
1627 /// The image format the bytes represent (e.g. PNG)
1628 pub format: ImageFormat,
1629 /// The raw image bytes
1630 pub bytes: Vec<u8>,
1631 /// The unique ID for the image
1632 id: u64,
1633}
1634
1635impl Hash for Image {
1636 fn hash<H: Hasher>(&self, state: &mut H) {
1637 state.write_u64(self.id);
1638 }
1639}
1640
1641impl Image {
1642 /// An empty image containing no data
1643 pub fn empty() -> Self {
1644 Self::from_bytes(ImageFormat::Png, Vec::new())
1645 }
1646
1647 /// Create an image from a format and bytes
1648 pub fn from_bytes(format: ImageFormat, bytes: Vec<u8>) -> Self {
1649 Self {
1650 id: hash(&bytes),
1651 format,
1652 bytes,
1653 }
1654 }
1655
1656 /// Get this image's ID
1657 pub fn id(&self) -> u64 {
1658 self.id
1659 }
1660
1661 /// Use the GPUI `use_asset` API to make this image renderable
1662 pub fn use_render_image(
1663 self: Arc<Self>,
1664 window: &mut Window,
1665 cx: &mut App,
1666 ) -> Option<Arc<RenderImage>> {
1667 ImageSource::Image(self)
1668 .use_data(None, window, cx)
1669 .and_then(|result| result.ok())
1670 }
1671
1672 /// Use the GPUI `get_asset` API to make this image renderable
1673 pub fn get_render_image(
1674 self: Arc<Self>,
1675 window: &mut Window,
1676 cx: &mut App,
1677 ) -> Option<Arc<RenderImage>> {
1678 ImageSource::Image(self)
1679 .get_data(None, window, cx)
1680 .and_then(|result| result.ok())
1681 }
1682
1683 /// Use the GPUI `remove_asset` API to drop this image, if possible.
1684 pub fn remove_asset(self: Arc<Self>, cx: &mut App) {
1685 ImageSource::Image(self).remove_asset(cx);
1686 }
1687
1688 /// Convert the clipboard image to an `ImageData` object.
1689 pub fn to_image_data(&self, svg_renderer: SvgRenderer) -> Result<Arc<RenderImage>> {
1690 fn frames_for_image(
1691 bytes: &[u8],
1692 format: image::ImageFormat,
1693 ) -> Result<SmallVec<[Frame; 1]>> {
1694 let mut data = image::load_from_memory_with_format(bytes, format)?.into_rgba8();
1695
1696 // Convert from RGBA to BGRA.
1697 for pixel in data.chunks_exact_mut(4) {
1698 pixel.swap(0, 2);
1699 }
1700
1701 Ok(SmallVec::from_elem(Frame::new(data), 1))
1702 }
1703
1704 let frames = match self.format {
1705 ImageFormat::Gif => {
1706 let decoder = GifDecoder::new(Cursor::new(&self.bytes))?;
1707 let mut frames = SmallVec::new();
1708
1709 for frame in decoder.into_frames() {
1710 let mut frame = frame?;
1711 // Convert from RGBA to BGRA.
1712 for pixel in frame.buffer_mut().chunks_exact_mut(4) {
1713 pixel.swap(0, 2);
1714 }
1715 frames.push(frame);
1716 }
1717
1718 frames
1719 }
1720 ImageFormat::Png => frames_for_image(&self.bytes, image::ImageFormat::Png)?,
1721 ImageFormat::Jpeg => frames_for_image(&self.bytes, image::ImageFormat::Jpeg)?,
1722 ImageFormat::Webp => frames_for_image(&self.bytes, image::ImageFormat::WebP)?,
1723 ImageFormat::Bmp => frames_for_image(&self.bytes, image::ImageFormat::Bmp)?,
1724 ImageFormat::Tiff => frames_for_image(&self.bytes, image::ImageFormat::Tiff)?,
1725 ImageFormat::Svg => {
1726 let pixmap = svg_renderer.render_pixmap(&self.bytes, SvgSize::ScaleFactor(1.0))?;
1727
1728 let buffer =
1729 image::ImageBuffer::from_raw(pixmap.width(), pixmap.height(), pixmap.take())
1730 .unwrap();
1731
1732 SmallVec::from_elem(Frame::new(buffer), 1)
1733 }
1734 };
1735
1736 Ok(Arc::new(RenderImage::new(frames)))
1737 }
1738
1739 /// Get the format of the clipboard image
1740 pub fn format(&self) -> ImageFormat {
1741 self.format
1742 }
1743
1744 /// Get the raw bytes of the clipboard image
1745 pub fn bytes(&self) -> &[u8] {
1746 self.bytes.as_slice()
1747 }
1748}
1749
1750/// A clipboard item that should be copied to the clipboard
1751#[derive(Clone, Debug, Eq, PartialEq)]
1752pub struct ClipboardString {
1753 pub(crate) text: String,
1754 pub(crate) metadata: Option<String>,
1755}
1756
1757impl ClipboardString {
1758 /// Create a new clipboard string with the given text
1759 pub fn new(text: String) -> Self {
1760 Self {
1761 text,
1762 metadata: None,
1763 }
1764 }
1765
1766 /// Return a new clipboard item with the metadata replaced by the given metadata,
1767 /// after serializing it as JSON.
1768 pub fn with_json_metadata<T: Serialize>(mut self, metadata: T) -> Self {
1769 self.metadata = Some(serde_json::to_string(&metadata).unwrap());
1770 self
1771 }
1772
1773 /// Get the text of the clipboard string
1774 pub fn text(&self) -> &String {
1775 &self.text
1776 }
1777
1778 /// Get the owned text of the clipboard string
1779 pub fn into_text(self) -> String {
1780 self.text
1781 }
1782
1783 /// Get the metadata of the clipboard string, formatted as JSON
1784 pub fn metadata_json<T>(&self) -> Option<T>
1785 where
1786 T: for<'a> Deserialize<'a>,
1787 {
1788 self.metadata
1789 .as_ref()
1790 .and_then(|m| serde_json::from_str(m).ok())
1791 }
1792
1793 #[cfg_attr(any(target_os = "linux", target_os = "freebsd"), allow(dead_code))]
1794 pub(crate) fn text_hash(text: &str) -> u64 {
1795 let mut hasher = SeaHasher::new();
1796 text.hash(&mut hasher);
1797 hasher.finish()
1798 }
1799}
1800
1801impl From<String> for ClipboardString {
1802 fn from(value: String) -> Self {
1803 Self {
1804 text: value,
1805 metadata: None,
1806 }
1807 }
1808}