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