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