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,
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)>,
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);
166 fn dispatch_on_main_thread(&self, runnable: Runnable);
167 fn dispatch_after(&self, duration: Duration, runnable: Runnable);
168 fn poll(&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(&self, params: &RenderGlyphParams) -> Result<(Size<DevicePixels>, Vec<u8>)>;
188 fn layout_line(&self, text: &str, font_size: Pixels, runs: &[FontRun]) -> LineLayout;
189 fn wrap_line(
190 &self,
191 text: &str,
192 font_id: FontId,
193 font_size: Pixels,
194 width: Pixels,
195 ) -> Vec<usize>;
196}
197
198#[derive(Clone, Debug)]
199pub struct AppMetadata {
200 pub os_name: &'static str,
201 pub os_version: Option<SemanticVersion>,
202 pub app_version: Option<SemanticVersion>,
203}
204
205#[derive(PartialEq, Eq, Hash, Clone)]
206pub enum AtlasKey {
207 Glyph(RenderGlyphParams),
208 Svg(RenderSvgParams),
209 Image(RenderImageParams),
210}
211
212impl AtlasKey {
213 pub(crate) fn texture_kind(&self) -> AtlasTextureKind {
214 match self {
215 AtlasKey::Glyph(params) => {
216 if params.is_emoji {
217 AtlasTextureKind::Polychrome
218 } else {
219 AtlasTextureKind::Monochrome
220 }
221 }
222 AtlasKey::Svg(_) => AtlasTextureKind::Monochrome,
223 AtlasKey::Image(_) => AtlasTextureKind::Polychrome,
224 }
225 }
226}
227
228impl From<RenderGlyphParams> for AtlasKey {
229 fn from(params: RenderGlyphParams) -> Self {
230 Self::Glyph(params)
231 }
232}
233
234impl From<RenderSvgParams> for AtlasKey {
235 fn from(params: RenderSvgParams) -> Self {
236 Self::Svg(params)
237 }
238}
239
240impl From<RenderImageParams> for AtlasKey {
241 fn from(params: RenderImageParams) -> Self {
242 Self::Image(params)
243 }
244}
245
246pub trait PlatformAtlas: Send + Sync {
247 fn get_or_insert_with<'a>(
248 &self,
249 key: &AtlasKey,
250 build: &mut dyn FnMut() -> Result<(Size<DevicePixels>, Cow<'a, [u8]>)>,
251 ) -> Result<AtlasTile>;
252
253 fn clear(&self);
254}
255
256#[derive(Clone, Debug, PartialEq, Eq)]
257#[repr(C)]
258pub struct AtlasTile {
259 pub(crate) texture_id: AtlasTextureId,
260 pub(crate) tile_id: TileId,
261 pub(crate) bounds: Bounds<DevicePixels>,
262}
263
264#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
265#[repr(C)]
266pub(crate) struct AtlasTextureId {
267 // We use u32 instead of usize for Metal Shader Language compatibility
268 pub(crate) index: u32,
269 pub(crate) kind: AtlasTextureKind,
270}
271
272#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
273#[repr(C)]
274pub(crate) enum AtlasTextureKind {
275 Monochrome = 0,
276 Polychrome = 1,
277 Path = 2,
278}
279
280#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
281#[repr(C)]
282pub(crate) struct TileId(pub(crate) u32);
283
284impl From<etagere::AllocId> for TileId {
285 fn from(id: etagere::AllocId) -> Self {
286 Self(id.serialize())
287 }
288}
289
290impl From<TileId> for etagere::AllocId {
291 fn from(id: TileId) -> Self {
292 Self::deserialize(id.0)
293 }
294}
295
296pub trait PlatformInputHandler {
297 fn selected_text_range(&self) -> Option<Range<usize>>;
298 fn marked_text_range(&self) -> Option<Range<usize>>;
299 fn text_for_range(&self, range_utf16: Range<usize>) -> Option<String>;
300 fn replace_text_in_range(&mut self, replacement_range: Option<Range<usize>>, text: &str);
301 fn replace_and_mark_text_in_range(
302 &mut self,
303 range_utf16: Option<Range<usize>>,
304 new_text: &str,
305 new_selected_range: Option<Range<usize>>,
306 );
307 fn unmark_text(&mut self);
308 fn bounds_for_range(&self, range_utf16: Range<usize>) -> Option<Bounds<f32>>;
309}
310
311#[derive(Debug)]
312pub struct WindowOptions {
313 pub bounds: WindowBounds,
314 pub titlebar: Option<TitlebarOptions>,
315 pub center: bool,
316 pub focus: bool,
317 pub show: bool,
318 pub kind: WindowKind,
319 pub is_movable: bool,
320 pub display_id: Option<DisplayId>,
321}
322
323impl Default for WindowOptions {
324 fn default() -> Self {
325 Self {
326 bounds: WindowBounds::default(),
327 titlebar: Some(TitlebarOptions {
328 title: Default::default(),
329 appears_transparent: Default::default(),
330 traffic_light_position: Default::default(),
331 }),
332 center: false,
333 focus: true,
334 show: true,
335 kind: WindowKind::Normal,
336 is_movable: true,
337 display_id: None,
338 }
339 }
340}
341
342#[derive(Debug, Default)]
343pub struct TitlebarOptions {
344 pub title: Option<SharedString>,
345 pub appears_transparent: bool,
346 pub traffic_light_position: Option<Point<Pixels>>,
347}
348
349#[derive(Copy, Clone, Debug)]
350pub enum Appearance {
351 Light,
352 VibrantLight,
353 Dark,
354 VibrantDark,
355}
356
357impl Default for Appearance {
358 fn default() -> Self {
359 Self::Light
360 }
361}
362
363#[derive(Copy, Clone, Debug, PartialEq, Eq)]
364pub enum WindowKind {
365 Normal,
366 PopUp,
367}
368
369#[derive(Copy, Clone, Debug, PartialEq, Default)]
370pub enum WindowBounds {
371 Fullscreen,
372 #[default]
373 Maximized,
374 Fixed(Bounds<GlobalPixels>),
375}
376
377impl StaticColumnCount for WindowBounds {
378 fn column_count() -> usize {
379 5
380 }
381}
382
383impl Bind for WindowBounds {
384 fn bind(&self, statement: &Statement, start_index: i32) -> Result<i32> {
385 let (region, next_index) = match self {
386 WindowBounds::Fullscreen => {
387 let next_index = statement.bind(&"Fullscreen", start_index)?;
388 (None, next_index)
389 }
390 WindowBounds::Maximized => {
391 let next_index = statement.bind(&"Maximized", start_index)?;
392 (None, next_index)
393 }
394 WindowBounds::Fixed(region) => {
395 let next_index = statement.bind(&"Fixed", start_index)?;
396 (Some(*region), next_index)
397 }
398 };
399
400 statement.bind(
401 ®ion.map(|region| {
402 (
403 region.origin.x,
404 region.origin.y,
405 region.size.width,
406 region.size.height,
407 )
408 }),
409 next_index,
410 )
411 }
412}
413
414impl Column for WindowBounds {
415 fn column(statement: &mut Statement, start_index: i32) -> Result<(Self, i32)> {
416 let (window_state, next_index) = String::column(statement, start_index)?;
417 let bounds = match window_state.as_str() {
418 "Fullscreen" => WindowBounds::Fullscreen,
419 "Maximized" => WindowBounds::Maximized,
420 "Fixed" => {
421 let ((x, y, width, height), _) = Column::column(statement, next_index)?;
422 let x: f64 = x;
423 let y: f64 = y;
424 let width: f64 = width;
425 let height: f64 = height;
426 WindowBounds::Fixed(Bounds {
427 origin: point(x.into(), y.into()),
428 size: size(width.into(), height.into()),
429 })
430 }
431 _ => bail!("Window State did not have a valid string"),
432 };
433
434 Ok((bounds, next_index + 4))
435 }
436}
437
438#[derive(Copy, Clone, Debug)]
439pub enum WindowAppearance {
440 Light,
441 VibrantLight,
442 Dark,
443 VibrantDark,
444}
445
446impl Default for WindowAppearance {
447 fn default() -> Self {
448 Self::Light
449 }
450}
451
452#[derive(Copy, Clone, Debug)]
453pub struct PathPromptOptions {
454 pub files: bool,
455 pub directories: bool,
456 pub multiple: bool,
457}
458
459#[derive(Copy, Clone, Debug)]
460pub enum PromptLevel {
461 Info,
462 Warning,
463 Critical,
464}
465
466#[derive(Copy, Clone, Debug)]
467pub enum CursorStyle {
468 Arrow,
469 ResizeLeftRight,
470 ResizeUpDown,
471 PointingHand,
472 IBeam,
473}
474
475impl Default for CursorStyle {
476 fn default() -> Self {
477 Self::Arrow
478 }
479}
480
481#[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
482pub struct SemanticVersion {
483 major: usize,
484 minor: usize,
485 patch: usize,
486}
487
488impl FromStr for SemanticVersion {
489 type Err = anyhow::Error;
490
491 fn from_str(s: &str) -> Result<Self> {
492 let mut components = s.trim().split('.');
493 let major = components
494 .next()
495 .ok_or_else(|| anyhow!("missing major version number"))?
496 .parse()?;
497 let minor = components
498 .next()
499 .ok_or_else(|| anyhow!("missing minor version number"))?
500 .parse()?;
501 let patch = components
502 .next()
503 .ok_or_else(|| anyhow!("missing patch version number"))?
504 .parse()?;
505 Ok(Self {
506 major,
507 minor,
508 patch,
509 })
510 }
511}
512
513impl Display for SemanticVersion {
514 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
515 write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
516 }
517}
518
519#[derive(Clone, Debug, Eq, PartialEq)]
520pub struct ClipboardItem {
521 pub(crate) text: String,
522 pub(crate) metadata: Option<String>,
523}
524
525impl ClipboardItem {
526 pub fn new(text: String) -> Self {
527 Self {
528 text,
529 metadata: None,
530 }
531 }
532
533 pub fn with_metadata<T: Serialize>(mut self, metadata: T) -> Self {
534 self.metadata = Some(serde_json::to_string(&metadata).unwrap());
535 self
536 }
537
538 pub fn text(&self) -> &String {
539 &self.text
540 }
541
542 pub fn metadata<T>(&self) -> Option<T>
543 where
544 T: for<'a> Deserialize<'a>,
545 {
546 self.metadata
547 .as_ref()
548 .and_then(|m| serde_json::from_str(m).ok())
549 }
550
551 pub(crate) fn text_hash(text: &str) -> u64 {
552 let mut hasher = SeaHasher::new();
553 text.hash(&mut hasher);
554 hasher.finish()
555 }
556}