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