1mod events;
2mod keystroke;
3#[cfg(target_os = "macos")]
4mod mac;
5#[cfg(any(test, feature = "test"))]
6mod test;
7
8use crate::{
9 AnyWindowHandle, Bounds, DevicePixels, Font, FontId, FontMetrics, GlyphId, GlyphRasterParams,
10 Pixels, Point, Result, Scene, ShapedLine, SharedString, Size,
11};
12use anyhow::anyhow;
13use async_task::Runnable;
14use futures::channel::oneshot;
15use seahash::SeaHasher;
16use serde::{Deserialize, Serialize};
17use std::ffi::c_void;
18use std::hash::{Hash, Hasher};
19use std::{
20 any::Any,
21 fmt::{self, Debug, Display},
22 ops::Range,
23 path::{Path, PathBuf},
24 rc::Rc,
25 str::FromStr,
26 sync::Arc,
27};
28use uuid::Uuid;
29
30pub use events::*;
31pub use keystroke::*;
32#[cfg(target_os = "macos")]
33pub use mac::*;
34#[cfg(any(test, feature = "test"))]
35pub use test::*;
36pub use time::UtcOffset;
37
38#[cfg(target_os = "macos")]
39pub(crate) fn current_platform() -> Arc<dyn Platform> {
40 Arc::new(MacPlatform::new())
41}
42
43pub trait Platform: 'static {
44 fn dispatcher(&self) -> Arc<dyn PlatformDispatcher>;
45 fn text_system(&self) -> Arc<dyn PlatformTextSystem>;
46
47 fn run(&self, on_finish_launching: Box<dyn 'static + FnOnce()>);
48 fn quit(&self);
49 fn restart(&self);
50 fn activate(&self, ignoring_other_apps: bool);
51 fn hide(&self);
52 fn hide_other_apps(&self);
53 fn unhide_other_apps(&self);
54
55 fn screens(&self) -> Vec<Rc<dyn PlatformScreen>>;
56 fn screen_by_id(&self, id: ScreenId) -> Option<Rc<dyn PlatformScreen>>;
57 fn main_window(&self) -> Option<AnyWindowHandle>;
58 fn open_window(
59 &self,
60 handle: AnyWindowHandle,
61 options: WindowOptions,
62 ) -> Box<dyn PlatformWindow>;
63 // fn add_status_item(&self, _handle: AnyWindowHandle) -> Box<dyn PlatformWindow>;
64
65 fn open_url(&self, url: &str);
66 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>);
67 fn prompt_for_paths(
68 &self,
69 options: PathPromptOptions,
70 ) -> oneshot::Receiver<Option<Vec<PathBuf>>>;
71 fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>>;
72 fn reveal_path(&self, path: &Path);
73
74 fn on_become_active(&self, callback: Box<dyn FnMut()>);
75 fn on_resign_active(&self, callback: Box<dyn FnMut()>);
76 fn on_quit(&self, callback: Box<dyn FnMut()>);
77 fn on_reopen(&self, callback: Box<dyn FnMut()>);
78 fn on_event(&self, callback: Box<dyn FnMut(Event) -> bool>);
79
80 fn os_name(&self) -> &'static str;
81 fn os_version(&self) -> Result<SemanticVersion>;
82 fn app_version(&self) -> Result<SemanticVersion>;
83 fn app_path(&self) -> Result<PathBuf>;
84 fn local_timezone(&self) -> UtcOffset;
85 fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf>;
86
87 fn set_cursor_style(&self, style: CursorStyle);
88 fn should_auto_hide_scrollbars(&self) -> bool;
89
90 fn write_to_clipboard(&self, item: ClipboardItem);
91 fn read_from_clipboard(&self) -> Option<ClipboardItem>;
92
93 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Result<()>;
94 fn read_credentials(&self, url: &str) -> Result<Option<(String, Vec<u8>)>>;
95 fn delete_credentials(&self, url: &str) -> Result<()>;
96}
97
98pub trait PlatformScreen: Debug {
99 fn id(&self) -> Option<ScreenId>;
100 fn handle(&self) -> PlatformScreenHandle;
101 fn as_any(&self) -> &dyn Any;
102 fn bounds(&self) -> Bounds<Pixels>;
103 fn content_bounds(&self) -> Bounds<Pixels>;
104}
105
106pub struct PlatformScreenHandle(pub *mut c_void);
107
108impl Debug for PlatformScreenHandle {
109 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
110 write!(f, "PlatformScreenHandle({:p})", self.0)
111 }
112}
113
114unsafe impl Send for PlatformScreenHandle {}
115
116pub trait PlatformWindow {
117 fn bounds(&self) -> WindowBounds;
118 fn content_size(&self) -> Size<Pixels>;
119 fn scale_factor(&self) -> f32;
120 fn titlebar_height(&self) -> Pixels;
121 fn appearance(&self) -> WindowAppearance;
122 fn screen(&self) -> Rc<dyn PlatformScreen>;
123 fn mouse_position(&self) -> Point<Pixels>;
124 fn as_any_mut(&mut self) -> &mut dyn Any;
125 fn set_input_handler(&mut self, input_handler: Box<dyn PlatformInputHandler>);
126 fn prompt(
127 &self,
128 level: WindowPromptLevel,
129 msg: &str,
130 answers: &[&str],
131 ) -> oneshot::Receiver<usize>;
132 fn activate(&self);
133 fn set_title(&mut self, title: &str);
134 fn set_edited(&mut self, edited: bool);
135 fn show_character_palette(&self);
136 fn minimize(&self);
137 fn zoom(&self);
138 fn toggle_full_screen(&self);
139 fn on_event(&self, callback: Box<dyn FnMut(Event) -> bool>);
140 fn on_active_status_change(&self, callback: Box<dyn FnMut(bool)>);
141 fn on_resize(&self, callback: Box<dyn FnMut(Size<Pixels>, f32)>);
142 fn on_fullscreen(&self, callback: Box<dyn FnMut(bool)>);
143 fn on_moved(&self, callback: Box<dyn FnMut()>);
144 fn on_should_close(&self, callback: Box<dyn FnMut() -> bool>);
145 fn on_close(&self, callback: Box<dyn FnOnce()>);
146 fn on_appearance_changed(&self, callback: Box<dyn FnMut()>);
147 fn is_topmost_for_position(&self, position: Point<Pixels>) -> bool;
148 fn draw(&self, scene: Scene);
149
150 fn glyph_atlas(&self) -> Arc<dyn PlatformAtlas<GlyphRasterParams>>;
151}
152
153pub trait PlatformDispatcher: Send + Sync {
154 fn is_main_thread(&self) -> bool;
155 fn run_on_main_thread(&self, task: Runnable);
156}
157
158pub trait PlatformTextSystem: Send + Sync {
159 fn add_fonts(&self, fonts: &[Arc<Vec<u8>>]) -> Result<()>;
160 fn all_font_families(&self) -> Vec<String>;
161 fn font_id(&self, descriptor: &Font) -> Result<FontId>;
162 fn font_metrics(&self, font_id: FontId) -> FontMetrics;
163 fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Bounds<f32>>;
164 fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> Result<Size<f32>>;
165 fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option<GlyphId>;
166 fn glyph_raster_bounds(&self, params: &GlyphRasterParams) -> Result<Bounds<DevicePixels>>;
167 fn rasterize_glyph(&self, params: &GlyphRasterParams) -> Result<(Size<DevicePixels>, Vec<u8>)>;
168 fn layout_line(&self, text: &str, font_size: Pixels, runs: &[(usize, FontId)]) -> ShapedLine;
169 fn wrap_line(
170 &self,
171 text: &str,
172 font_id: FontId,
173 font_size: Pixels,
174 width: Pixels,
175 ) -> Vec<usize>;
176}
177
178pub trait PlatformAtlas<Key>: Send + Sync {
179 fn get_or_insert_with(
180 &self,
181 key: &Key,
182 build: &mut dyn FnMut() -> Result<(Size<DevicePixels>, Vec<u8>)>,
183 ) -> Result<AtlasTile>;
184
185 fn clear(&self);
186}
187
188#[derive(Clone, Debug, PartialEq, Eq)]
189#[repr(C)]
190pub struct AtlasTile {
191 pub(crate) texture_id: AtlasTextureId,
192 pub(crate) tile_id: TileId,
193 pub(crate) bounds: Bounds<DevicePixels>,
194}
195
196#[derive(Clone, Copy, Debug, PartialEq, Eq)]
197#[repr(C)]
198pub(crate) struct AtlasTextureId(pub(crate) u32); // We use u32 instead of usize for Metal Shader Language compatibility
199
200#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
201#[repr(C)]
202pub(crate) struct TileId(pub(crate) u32);
203
204impl From<etagere::AllocId> for TileId {
205 fn from(id: etagere::AllocId) -> Self {
206 Self(id.serialize())
207 }
208}
209
210impl From<TileId> for etagere::AllocId {
211 fn from(id: TileId) -> Self {
212 Self::deserialize(id.0)
213 }
214}
215
216pub trait PlatformInputHandler {
217 fn selected_text_range(&self) -> Option<Range<usize>>;
218 fn marked_text_range(&self) -> Option<Range<usize>>;
219 fn text_for_range(&self, range_utf16: Range<usize>) -> Option<String>;
220 fn replace_text_in_range(&mut self, replacement_range: Option<Range<usize>>, text: &str);
221 fn replace_and_mark_text_in_range(
222 &mut self,
223 range_utf16: Option<Range<usize>>,
224 new_text: &str,
225 new_selected_range: Option<Range<usize>>,
226 );
227 fn unmark_text(&mut self);
228 fn bounds_for_range(&self, range_utf16: Range<usize>) -> Option<Bounds<f32>>;
229}
230
231#[derive(Copy, Clone, Debug, PartialEq)]
232pub struct ScreenId(pub(crate) Uuid);
233
234#[derive(Copy, Clone, Debug)]
235pub enum RasterizationOptions {
236 Alpha,
237 Bgra,
238}
239
240#[derive(Debug)]
241pub struct WindowOptions {
242 pub bounds: WindowBounds,
243 pub titlebar: Option<TitlebarOptions>,
244 pub center: bool,
245 pub focus: bool,
246 pub show: bool,
247 pub kind: WindowKind,
248 pub is_movable: bool,
249 pub screen: Option<PlatformScreenHandle>,
250}
251
252impl Default for WindowOptions {
253 fn default() -> Self {
254 Self {
255 bounds: WindowBounds::default(),
256 titlebar: Some(TitlebarOptions {
257 title: Default::default(),
258 appears_transparent: Default::default(),
259 traffic_light_position: Default::default(),
260 }),
261 center: false,
262 focus: true,
263 show: true,
264 kind: WindowKind::Normal,
265 is_movable: true,
266 screen: None,
267 }
268 }
269}
270
271#[derive(Debug, Default)]
272pub struct TitlebarOptions {
273 pub title: Option<SharedString>,
274 pub appears_transparent: bool,
275 pub traffic_light_position: Option<Point<Pixels>>,
276}
277
278#[derive(Copy, Clone, Debug)]
279pub enum Appearance {
280 Light,
281 VibrantLight,
282 Dark,
283 VibrantDark,
284}
285
286impl Default for Appearance {
287 fn default() -> Self {
288 Self::Light
289 }
290}
291
292#[derive(Copy, Clone, Debug, PartialEq, Eq)]
293pub enum WindowKind {
294 Normal,
295 PopUp,
296}
297
298#[derive(Copy, Clone, Debug, PartialEq, Default)]
299pub enum WindowBounds {
300 Fullscreen,
301 #[default]
302 Maximized,
303 Fixed(Bounds<Pixels>),
304}
305
306#[derive(Copy, Clone, Debug)]
307pub enum WindowAppearance {
308 Light,
309 VibrantLight,
310 Dark,
311 VibrantDark,
312}
313
314impl Default for WindowAppearance {
315 fn default() -> Self {
316 Self::Light
317 }
318}
319
320#[derive(Copy, Clone, Debug, PartialEq, Default)]
321pub enum WindowPromptLevel {
322 #[default]
323 Info,
324 Warning,
325 Critical,
326}
327
328#[derive(Copy, Clone, Debug)]
329pub struct PathPromptOptions {
330 pub files: bool,
331 pub directories: bool,
332 pub multiple: bool,
333}
334
335#[derive(Copy, Clone, Debug)]
336pub enum PromptLevel {
337 Info,
338 Warning,
339 Critical,
340}
341
342#[derive(Copy, Clone, Debug)]
343pub enum CursorStyle {
344 Arrow,
345 ResizeLeftRight,
346 ResizeUpDown,
347 PointingHand,
348 IBeam,
349}
350
351impl Default for CursorStyle {
352 fn default() -> Self {
353 Self::Arrow
354 }
355}
356
357#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
358pub struct SemanticVersion {
359 major: usize,
360 minor: usize,
361 patch: usize,
362}
363
364impl FromStr for SemanticVersion {
365 type Err = anyhow::Error;
366
367 fn from_str(s: &str) -> Result<Self> {
368 let mut components = s.trim().split('.');
369 let major = components
370 .next()
371 .ok_or_else(|| anyhow!("missing major version number"))?
372 .parse()?;
373 let minor = components
374 .next()
375 .ok_or_else(|| anyhow!("missing minor version number"))?
376 .parse()?;
377 let patch = components
378 .next()
379 .ok_or_else(|| anyhow!("missing patch version number"))?
380 .parse()?;
381 Ok(Self {
382 major,
383 minor,
384 patch,
385 })
386 }
387}
388
389impl Display for SemanticVersion {
390 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
391 write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
392 }
393}
394
395#[derive(Clone, Debug, Eq, PartialEq)]
396pub struct ClipboardItem {
397 pub(crate) text: String,
398 pub(crate) metadata: Option<String>,
399}
400
401impl ClipboardItem {
402 pub fn new(text: String) -> Self {
403 Self {
404 text,
405 metadata: None,
406 }
407 }
408
409 pub fn with_metadata<T: Serialize>(mut self, metadata: T) -> Self {
410 self.metadata = Some(serde_json::to_string(&metadata).unwrap());
411 self
412 }
413
414 pub fn text(&self) -> &String {
415 &self.text
416 }
417
418 pub fn metadata<T>(&self) -> Option<T>
419 where
420 T: for<'a> Deserialize<'a>,
421 {
422 self.metadata
423 .as_ref()
424 .and_then(|m| serde_json::from_str(m).ok())
425 }
426
427 pub(crate) fn text_hash(text: &str) -> u64 {
428 let mut hasher = SeaHasher::new();
429 text.hash(&mut hasher);
430 hasher.finish()
431 }
432}