1mod keystroke;
2#[cfg(target_os = "macos")]
3mod mac;
4#[cfg(any(test, feature = "test-support"))]
5mod test;
6
7use crate::{
8 point, size, AnyWindowHandle, BackgroundExecutor, Bounds, DevicePixels, Font, FontId,
9 FontMetrics, FontRun, ForegroundExecutor, GlobalPixels, GlyphId, InputEvent, LineLayout,
10 Pixels, Point, RenderGlyphParams, RenderImageParams, RenderSvgParams, Result, Scene,
11 SharedString, Size, TaskLabel,
12};
13use anyhow::{anyhow, bail};
14use async_task::Runnable;
15use futures::channel::oneshot;
16use parking::Unparker;
17use seahash::SeaHasher;
18use serde::{Deserialize, Serialize};
19use sqlez::bindable::{Bind, Column, StaticColumnCount};
20use sqlez::statement::Statement;
21use std::borrow::Cow;
22use std::hash::{Hash, Hasher};
23use std::time::Duration;
24use std::{
25 any::Any,
26 fmt::{self, Debug, Display},
27 ops::Range,
28 path::{Path, PathBuf},
29 rc::Rc,
30 str::FromStr,
31 sync::Arc,
32};
33use uuid::Uuid;
34
35pub use keystroke::*;
36#[cfg(target_os = "macos")]
37pub use mac::*;
38#[cfg(any(test, feature = "test-support"))]
39pub use test::*;
40pub use time::UtcOffset;
41
42#[cfg(target_os = "macos")]
43pub(crate) fn current_platform() -> Rc<dyn Platform> {
44 Rc::new(MacPlatform::new())
45}
46
47pub(crate) trait Platform: 'static {
48 fn background_executor(&self) -> BackgroundExecutor;
49 fn foreground_executor(&self) -> ForegroundExecutor;
50 fn text_system(&self) -> Arc<dyn PlatformTextSystem>;
51
52 fn run(&self, on_finish_launching: Box<dyn 'static + FnOnce()>);
53 fn quit(&self);
54 fn restart(&self);
55 fn activate(&self, ignoring_other_apps: bool);
56 fn hide(&self);
57 fn hide_other_apps(&self);
58 fn unhide_other_apps(&self);
59
60 fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>>;
61 fn display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>>;
62 fn main_window(&self) -> Option<AnyWindowHandle>;
63 fn open_window(
64 &self,
65 handle: AnyWindowHandle,
66 options: WindowOptions,
67 ) -> Box<dyn PlatformWindow>;
68
69 fn set_display_link_output_callback(
70 &self,
71 display_id: DisplayId,
72 callback: Box<dyn FnMut(&VideoTimestamp, &VideoTimestamp) + Send>,
73 );
74 fn start_display_link(&self, display_id: DisplayId);
75 fn stop_display_link(&self, display_id: DisplayId);
76 // fn add_status_item(&self, _handle: AnyWindowHandle) -> Box<dyn PlatformWindow>;
77
78 fn open_url(&self, url: &str);
79 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>);
80 fn prompt_for_paths(
81 &self,
82 options: PathPromptOptions,
83 ) -> oneshot::Receiver<Option<Vec<PathBuf>>>;
84 fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>>;
85 fn reveal_path(&self, path: &Path);
86
87 fn on_become_active(&self, callback: Box<dyn FnMut()>);
88 fn on_resign_active(&self, callback: Box<dyn FnMut()>);
89 fn on_quit(&self, callback: Box<dyn FnMut()>);
90 fn on_reopen(&self, callback: Box<dyn FnMut()>);
91 fn on_event(&self, callback: Box<dyn FnMut(InputEvent) -> bool>);
92
93 fn os_name(&self) -> &'static str;
94 fn os_version(&self) -> Result<SemanticVersion>;
95 fn app_version(&self) -> Result<SemanticVersion>;
96 fn app_path(&self) -> Result<PathBuf>;
97 fn local_timezone(&self) -> UtcOffset;
98 fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf>;
99
100 fn set_cursor_style(&self, style: CursorStyle);
101 fn should_auto_hide_scrollbars(&self) -> bool;
102
103 fn write_to_clipboard(&self, item: ClipboardItem);
104 fn read_from_clipboard(&self) -> Option<ClipboardItem>;
105
106 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Result<()>;
107 fn read_credentials(&self, url: &str) -> Result<Option<(String, Vec<u8>)>>;
108 fn delete_credentials(&self, url: &str) -> Result<()>;
109}
110
111pub trait PlatformDisplay: Send + Sync + Debug {
112 fn id(&self) -> DisplayId;
113 /// Returns a stable identifier for this display that can be persisted and used
114 /// across system restarts.
115 fn uuid(&self) -> Result<Uuid>;
116 fn as_any(&self) -> &dyn Any;
117 fn bounds(&self) -> Bounds<GlobalPixels>;
118}
119
120#[derive(PartialEq, Eq, Hash, Copy, Clone)]
121pub struct DisplayId(pub(crate) u32);
122
123impl Debug for DisplayId {
124 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
125 write!(f, "DisplayId({})", self.0)
126 }
127}
128
129unsafe impl Send for DisplayId {}
130
131pub(crate) trait PlatformWindow {
132 fn bounds(&self) -> WindowBounds;
133 fn content_size(&self) -> Size<Pixels>;
134 fn scale_factor(&self) -> f32;
135 fn titlebar_height(&self) -> Pixels;
136 fn appearance(&self) -> WindowAppearance;
137 fn display(&self) -> Rc<dyn PlatformDisplay>;
138 fn mouse_position(&self) -> Point<Pixels>;
139 fn as_any_mut(&mut self) -> &mut dyn Any;
140 fn set_input_handler(&mut self, input_handler: Box<dyn PlatformInputHandler>);
141 fn prompt(&self, level: PromptLevel, msg: &str, answers: &[&str]) -> oneshot::Receiver<usize>;
142 fn activate(&self);
143 fn set_title(&mut self, title: &str);
144 fn set_edited(&mut self, edited: bool);
145 fn show_character_palette(&self);
146 fn minimize(&self);
147 fn zoom(&self);
148 fn toggle_full_screen(&self);
149 fn on_input(&self, callback: Box<dyn FnMut(InputEvent) -> bool>);
150 fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>);
151 fn on_resize(&self, callback: Box<dyn FnMut(Size<Pixels>, f32)>);
152 fn on_fullscreen(&self, callback: Box<dyn FnMut(bool)>);
153 fn on_moved(&self, callback: Box<dyn FnMut()>);
154 fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>);
155 fn on_close(&self, callback: Box<dyn FnOnce()>);
156 fn on_appearance_changed(&self, callback: Box<dyn FnMut()>);
157 fn is_topmost_for_position(&self, position: Point<Pixels>) -> bool;
158 fn draw(&self, scene: Scene);
159
160 fn sprite_atlas(&self) -> Arc<dyn PlatformAtlas>;
161}
162
163pub trait PlatformDispatcher: Send + Sync {
164 fn is_main_thread(&self) -> bool;
165 fn dispatch(&self, runnable: Runnable, label: Option<TaskLabel>);
166 fn dispatch_on_main_thread(&self, runnable: Runnable);
167 fn dispatch_after(&self, duration: Duration, runnable: Runnable);
168 fn tick(&self, background_only: bool) -> bool;
169 fn park(&self);
170 fn unparker(&self) -> Unparker;
171
172 #[cfg(any(test, feature = "test-support"))]
173 fn as_test(&self) -> Option<&TestDispatcher> {
174 None
175 }
176}
177
178pub trait PlatformTextSystem: Send + Sync {
179 fn add_fonts(&self, fonts: &[Arc<Vec<u8>>]) -> Result<()>;
180 fn all_font_families(&self) -> Vec<String>;
181 fn font_id(&self, descriptor: &Font) -> Result<FontId>;
182 fn font_metrics(&self, font_id: FontId) -> FontMetrics;
183 fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Bounds<f32>>;
184 fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Size<f32>>;
185 fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option<GlyphId>;
186 fn glyph_raster_bounds(&self, params: &RenderGlyphParams) -> Result<Bounds<DevicePixels>>;
187 fn rasterize_glyph(
188 &self,
189 params: &RenderGlyphParams,
190 raster_bounds: Bounds<DevicePixels>,
191 ) -> Result<(Size<DevicePixels>, Vec<u8>)>;
192 fn layout_line(&self, text: &str, font_size: Pixels, runs: &[FontRun]) -> LineLayout;
193 fn wrap_line(
194 &self,
195 text: &str,
196 font_id: FontId,
197 font_size: Pixels,
198 width: Pixels,
199 ) -> Vec<usize>;
200}
201
202#[derive(Clone, Debug)]
203pub struct AppMetadata {
204 pub os_name: &'static str,
205 pub os_version: Option<SemanticVersion>,
206 pub app_version: Option<SemanticVersion>,
207}
208
209#[derive(PartialEq, Eq, Hash, Clone)]
210pub enum AtlasKey {
211 Glyph(RenderGlyphParams),
212 Svg(RenderSvgParams),
213 Image(RenderImageParams),
214}
215
216impl AtlasKey {
217 pub(crate) fn texture_kind(&self) -> AtlasTextureKind {
218 match self {
219 AtlasKey::Glyph(params) => {
220 if params.is_emoji {
221 AtlasTextureKind::Polychrome
222 } else {
223 AtlasTextureKind::Monochrome
224 }
225 }
226 AtlasKey::Svg(_) => AtlasTextureKind::Monochrome,
227 AtlasKey::Image(_) => AtlasTextureKind::Polychrome,
228 }
229 }
230}
231
232impl From<RenderGlyphParams> for AtlasKey {
233 fn from(params: RenderGlyphParams) -> Self {
234 Self::Glyph(params)
235 }
236}
237
238impl From<RenderSvgParams> for AtlasKey {
239 fn from(params: RenderSvgParams) -> Self {
240 Self::Svg(params)
241 }
242}
243
244impl From<RenderImageParams> for AtlasKey {
245 fn from(params: RenderImageParams) -> Self {
246 Self::Image(params)
247 }
248}
249
250pub trait PlatformAtlas: Send + Sync {
251 fn get_or_insert_with<'a>(
252 &self,
253 key: &AtlasKey,
254 build: &mut dyn FnMut() -> Result<(Size<DevicePixels>, Cow<'a, [u8]>)>,
255 ) -> Result<AtlasTile>;
256
257 fn clear(&self);
258}
259
260#[derive(Clone, Debug, PartialEq, Eq)]
261#[repr(C)]
262pub struct AtlasTile {
263 pub(crate) texture_id: AtlasTextureId,
264 pub(crate) tile_id: TileId,
265 pub(crate) bounds: Bounds<DevicePixels>,
266}
267
268#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
269#[repr(C)]
270pub(crate) struct AtlasTextureId {
271 // We use u32 instead of usize for Metal Shader Language compatibility
272 pub(crate) index: u32,
273 pub(crate) kind: AtlasTextureKind,
274}
275
276#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
277#[repr(C)]
278pub(crate) enum AtlasTextureKind {
279 Monochrome = 0,
280 Polychrome = 1,
281 Path = 2,
282}
283
284#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
285#[repr(C)]
286pub(crate) struct TileId(pub(crate) u32);
287
288impl From<etagere::AllocId> for TileId {
289 fn from(id: etagere::AllocId) -> Self {
290 Self(id.serialize())
291 }
292}
293
294impl From<TileId> for etagere::AllocId {
295 fn from(id: TileId) -> Self {
296 Self::deserialize(id.0)
297 }
298}
299
300pub trait PlatformInputHandler: 'static {
301 fn selected_text_range(&mut self) -> Option<Range<usize>>;
302 fn marked_text_range(&mut self) -> Option<Range<usize>>;
303 fn text_for_range(&mut self, range_utf16: Range<usize>) -> Option<String>;
304 fn replace_text_in_range(&mut self, replacement_range: Option<Range<usize>>, text: &str);
305 fn replace_and_mark_text_in_range(
306 &mut self,
307 range_utf16: Option<Range<usize>>,
308 new_text: &str,
309 new_selected_range: Option<Range<usize>>,
310 );
311 fn unmark_text(&mut self);
312 fn bounds_for_range(&mut self, range_utf16: Range<usize>) -> Option<Bounds<Pixels>>;
313}
314
315#[derive(Debug)]
316pub struct WindowOptions {
317 pub bounds: WindowBounds,
318 pub titlebar: Option<TitlebarOptions>,
319 pub center: bool,
320 pub focus: bool,
321 pub show: bool,
322 pub kind: WindowKind,
323 pub is_movable: bool,
324 pub display_id: Option<DisplayId>,
325}
326
327impl Default for WindowOptions {
328 fn default() -> Self {
329 Self {
330 bounds: WindowBounds::default(),
331 titlebar: Some(TitlebarOptions {
332 title: Default::default(),
333 appears_transparent: Default::default(),
334 traffic_light_position: Default::default(),
335 }),
336 center: false,
337 focus: true,
338 show: true,
339 kind: WindowKind::Normal,
340 is_movable: true,
341 display_id: None,
342 }
343 }
344}
345
346#[derive(Debug, Default)]
347pub struct TitlebarOptions {
348 pub title: Option<SharedString>,
349 pub appears_transparent: bool,
350 pub traffic_light_position: Option<Point<Pixels>>,
351}
352
353#[derive(Copy, Clone, Debug)]
354pub enum Appearance {
355 Light,
356 VibrantLight,
357 Dark,
358 VibrantDark,
359}
360
361impl Default for Appearance {
362 fn default() -> Self {
363 Self::Light
364 }
365}
366
367#[derive(Copy, Clone, Debug, PartialEq, Eq)]
368pub enum WindowKind {
369 Normal,
370 PopUp,
371}
372
373#[derive(Copy, Clone, Debug, PartialEq, Default)]
374pub enum WindowBounds {
375 Fullscreen,
376 #[default]
377 Maximized,
378 Fixed(Bounds<GlobalPixels>),
379}
380
381impl StaticColumnCount for WindowBounds {
382 fn column_count() -> usize {
383 5
384 }
385}
386
387impl Bind for WindowBounds {
388 fn bind(&self, statement: &Statement, start_index: i32) -> Result<i32> {
389 let (region, next_index) = match self {
390 WindowBounds::Fullscreen => {
391 let next_index = statement.bind(&"Fullscreen", start_index)?;
392 (None, next_index)
393 }
394 WindowBounds::Maximized => {
395 let next_index = statement.bind(&"Maximized", start_index)?;
396 (None, next_index)
397 }
398 WindowBounds::Fixed(region) => {
399 let next_index = statement.bind(&"Fixed", start_index)?;
400 (Some(*region), next_index)
401 }
402 };
403
404 statement.bind(
405 ®ion.map(|region| {
406 (
407 region.origin.x,
408 region.origin.y,
409 region.size.width,
410 region.size.height,
411 )
412 }),
413 next_index,
414 )
415 }
416}
417
418impl Column for WindowBounds {
419 fn column(statement: &mut Statement, start_index: i32) -> Result<(Self, i32)> {
420 let (window_state, next_index) = String::column(statement, start_index)?;
421 let bounds = match window_state.as_str() {
422 "Fullscreen" => WindowBounds::Fullscreen,
423 "Maximized" => WindowBounds::Maximized,
424 "Fixed" => {
425 let ((x, y, width, height), _) = Column::column(statement, next_index)?;
426 let x: f64 = x;
427 let y: f64 = y;
428 let width: f64 = width;
429 let height: f64 = height;
430 WindowBounds::Fixed(Bounds {
431 origin: point(x.into(), y.into()),
432 size: size(width.into(), height.into()),
433 })
434 }
435 _ => bail!("Window State did not have a valid string"),
436 };
437
438 Ok((bounds, next_index + 4))
439 }
440}
441
442#[derive(Copy, Clone, Debug)]
443pub enum WindowAppearance {
444 Light,
445 VibrantLight,
446 Dark,
447 VibrantDark,
448}
449
450impl Default for WindowAppearance {
451 fn default() -> Self {
452 Self::Light
453 }
454}
455
456#[derive(Copy, Clone, Debug)]
457pub struct PathPromptOptions {
458 pub files: bool,
459 pub directories: bool,
460 pub multiple: bool,
461}
462
463#[derive(Copy, Clone, Debug)]
464pub enum PromptLevel {
465 Info,
466 Warning,
467 Critical,
468}
469
470#[derive(Copy, Clone, Debug)]
471pub enum CursorStyle {
472 Arrow,
473 ResizeLeftRight,
474 ResizeUpDown,
475 PointingHand,
476 IBeam,
477}
478
479impl Default for CursorStyle {
480 fn default() -> Self {
481 Self::Arrow
482 }
483}
484
485#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
486pub struct SemanticVersion {
487 major: usize,
488 minor: usize,
489 patch: usize,
490}
491
492impl FromStr for SemanticVersion {
493 type Err = anyhow::Error;
494
495 fn from_str(s: &str) -> Result<Self> {
496 let mut components = s.trim().split('.');
497 let major = components
498 .next()
499 .ok_or_else(|| anyhow!("missing major version number"))?
500 .parse()?;
501 let minor = components
502 .next()
503 .ok_or_else(|| anyhow!("missing minor version number"))?
504 .parse()?;
505 let patch = components
506 .next()
507 .ok_or_else(|| anyhow!("missing patch version number"))?
508 .parse()?;
509 Ok(Self {
510 major,
511 minor,
512 patch,
513 })
514 }
515}
516
517impl Display for SemanticVersion {
518 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
519 write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
520 }
521}
522
523#[derive(Clone, Debug, Eq, PartialEq)]
524pub struct ClipboardItem {
525 pub(crate) text: String,
526 pub(crate) metadata: Option<String>,
527}
528
529impl ClipboardItem {
530 pub fn new(text: String) -> Self {
531 Self {
532 text,
533 metadata: None,
534 }
535 }
536
537 pub fn with_metadata<T: Serialize>(mut self, metadata: T) -> Self {
538 self.metadata = Some(serde_json::to_string(&metadata).unwrap());
539 self
540 }
541
542 pub fn text(&self) -> &String {
543 &self.text
544 }
545
546 pub fn metadata<T>(&self) -> Option<T>
547 where
548 T: for<'a> Deserialize<'a>,
549 {
550 self.metadata
551 .as_ref()
552 .and_then(|m| serde_json::from_str(m).ok())
553 }
554
555 pub(crate) fn text_hash(text: &str) -> u64 {
556 let mut hasher = SeaHasher::new();
557 text.hash(&mut hasher);
558 hasher.finish()
559 }
560}