1mod event;
2#[cfg(target_os = "macos")]
3pub mod mac;
4pub mod test;
5pub mod current {
6 #[cfg(target_os = "macos")]
7 pub use super::mac::*;
8}
9
10use crate::{
11 executor,
12 fonts::{FontId, GlyphId, Metrics as FontMetrics, Properties as FontProperties},
13 geometry::{
14 rect::{RectF, RectI},
15 vector::Vector2F,
16 },
17 keymap,
18 text_layout::{LineLayout, RunStyle},
19 Action, ClipboardItem, Menu, Scene,
20};
21use anyhow::{anyhow, Result};
22use async_task::Runnable;
23pub use event::{Event, NavigationDirection};
24use postage::oneshot;
25use serde::Deserialize;
26use std::{
27 any::Any,
28 fmt::{self, Display},
29 path::{Path, PathBuf},
30 rc::Rc,
31 str::FromStr,
32 sync::Arc,
33};
34use time::UtcOffset;
35
36pub trait Platform: Send + Sync {
37 fn dispatcher(&self) -> Arc<dyn Dispatcher>;
38 fn fonts(&self) -> Arc<dyn FontSystem>;
39
40 fn activate(&self, ignoring_other_apps: bool);
41 fn open_window(
42 &self,
43 id: usize,
44 options: WindowOptions,
45 executor: Rc<executor::Foreground>,
46 ) -> Box<dyn Window>;
47 fn key_window_id(&self) -> Option<usize>;
48 fn quit(&self);
49
50 fn write_to_clipboard(&self, item: ClipboardItem);
51 fn read_from_clipboard(&self) -> Option<ClipboardItem>;
52 fn open_url(&self, url: &str);
53
54 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Result<()>;
55 fn read_credentials(&self, url: &str) -> Result<Option<(String, Vec<u8>)>>;
56 fn delete_credentials(&self, url: &str) -> Result<()>;
57
58 fn set_cursor_style(&self, style: CursorStyle);
59
60 fn local_timezone(&self) -> UtcOffset;
61
62 fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf>;
63 fn app_path(&self) -> Result<PathBuf>;
64 fn app_version(&self) -> Result<AppVersion>;
65}
66
67pub(crate) trait ForegroundPlatform {
68 fn on_become_active(&self, callback: Box<dyn FnMut()>);
69 fn on_resign_active(&self, callback: Box<dyn FnMut()>);
70 fn on_quit(&self, callback: Box<dyn FnMut()>);
71 fn on_event(&self, callback: Box<dyn FnMut(Event) -> bool>);
72 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>);
73 fn run(&self, on_finish_launching: Box<dyn FnOnce() -> ()>);
74
75 fn on_menu_command(&self, callback: Box<dyn FnMut(&dyn Action)>);
76 fn on_validate_menu_command(&self, callback: Box<dyn FnMut(&dyn Action) -> bool>);
77 fn on_will_open_menu(&self, callback: Box<dyn FnMut()>);
78 fn set_menus(&self, menus: Vec<Menu>, matcher: &keymap::Matcher);
79 fn prompt_for_paths(
80 &self,
81 options: PathPromptOptions,
82 ) -> oneshot::Receiver<Option<Vec<PathBuf>>>;
83 fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>>;
84}
85
86pub trait Dispatcher: Send + Sync {
87 fn is_main_thread(&self) -> bool;
88 fn run_on_main_thread(&self, task: Runnable);
89}
90
91pub trait Window: WindowContext {
92 fn as_any_mut(&mut self) -> &mut dyn Any;
93 fn on_event(&mut self, callback: Box<dyn FnMut(Event)>);
94 fn on_active_status_change(&mut self, callback: Box<dyn FnMut(bool)>);
95 fn on_resize(&mut self, callback: Box<dyn FnMut()>);
96 fn on_close(&mut self, callback: Box<dyn FnOnce()>);
97 fn prompt(&self, level: PromptLevel, msg: &str, answers: &[&str]) -> oneshot::Receiver<usize>;
98 fn activate(&self);
99 fn set_title(&mut self, title: &str);
100}
101
102pub trait WindowContext {
103 fn size(&self) -> Vector2F;
104 fn scale_factor(&self) -> f32;
105 fn titlebar_height(&self) -> f32;
106 fn present_scene(&mut self, scene: Scene);
107}
108
109#[derive(Debug)]
110pub struct WindowOptions<'a> {
111 pub bounds: WindowBounds,
112 pub title: Option<&'a str>,
113 pub titlebar_appears_transparent: bool,
114 pub traffic_light_position: Option<Vector2F>,
115}
116
117#[derive(Debug)]
118pub enum WindowBounds {
119 Maximized,
120 Fixed(RectF),
121}
122
123pub struct PathPromptOptions {
124 pub files: bool,
125 pub directories: bool,
126 pub multiple: bool,
127}
128
129pub enum PromptLevel {
130 Info,
131 Warning,
132 Critical,
133}
134
135#[derive(Copy, Clone, Debug, Deserialize)]
136pub enum CursorStyle {
137 Arrow,
138 ResizeLeftRight,
139 PointingHand,
140 IBeam,
141}
142
143#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
144pub struct AppVersion {
145 major: usize,
146 minor: usize,
147 patch: usize,
148}
149
150impl FromStr for AppVersion {
151 type Err = anyhow::Error;
152
153 fn from_str(s: &str) -> Result<Self> {
154 let mut components = s.trim().split('.');
155 let major = components
156 .next()
157 .ok_or_else(|| anyhow!("missing major version number"))?
158 .parse()?;
159 let minor = components
160 .next()
161 .ok_or_else(|| anyhow!("missing minor version number"))?
162 .parse()?;
163 let patch = components
164 .next()
165 .ok_or_else(|| anyhow!("missing patch version number"))?
166 .parse()?;
167 Ok(Self {
168 major,
169 minor,
170 patch,
171 })
172 }
173}
174
175impl Display for AppVersion {
176 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
177 write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
178 }
179}
180
181#[derive(Copy, Clone, Debug)]
182pub enum RasterizationOptions {
183 Alpha,
184 Bgra,
185}
186
187pub trait FontSystem: Send + Sync {
188 fn add_fonts(&self, fonts: &[Arc<Vec<u8>>]) -> anyhow::Result<()>;
189 fn load_family(&self, name: &str) -> anyhow::Result<Vec<FontId>>;
190 fn select_font(
191 &self,
192 font_ids: &[FontId],
193 properties: &FontProperties,
194 ) -> anyhow::Result<FontId>;
195 fn font_metrics(&self, font_id: FontId) -> FontMetrics;
196 fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result<RectF>;
197 fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result<Vector2F>;
198 fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option<GlyphId>;
199 fn rasterize_glyph(
200 &self,
201 font_id: FontId,
202 font_size: f32,
203 glyph_id: GlyphId,
204 subpixel_shift: Vector2F,
205 scale_factor: f32,
206 options: RasterizationOptions,
207 ) -> Option<(RectI, Vec<u8>)>;
208 fn layout_line(&self, text: &str, font_size: f32, runs: &[(usize, RunStyle)]) -> LineLayout;
209 fn wrap_line(&self, text: &str, font_id: FontId, font_size: f32, width: f32) -> Vec<usize>;
210}
211
212impl<'a> Default for WindowOptions<'a> {
213 fn default() -> Self {
214 Self {
215 bounds: WindowBounds::Maximized,
216 title: Default::default(),
217 titlebar_appears_transparent: Default::default(),
218 traffic_light_position: Default::default(),
219 }
220 }
221}