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) -> bool>);
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 fn set_edited(&mut self, edited: bool);
101}
102
103pub trait WindowContext {
104 fn size(&self) -> Vector2F;
105 fn scale_factor(&self) -> f32;
106 fn titlebar_height(&self) -> f32;
107 fn present_scene(&mut self, scene: Scene);
108}
109
110#[derive(Debug)]
111pub struct WindowOptions<'a> {
112 pub bounds: WindowBounds,
113 pub title: Option<&'a str>,
114 pub titlebar_appears_transparent: bool,
115 pub traffic_light_position: Option<Vector2F>,
116}
117
118#[derive(Debug)]
119pub enum WindowBounds {
120 Maximized,
121 Fixed(RectF),
122}
123
124pub struct PathPromptOptions {
125 pub files: bool,
126 pub directories: bool,
127 pub multiple: bool,
128}
129
130pub enum PromptLevel {
131 Info,
132 Warning,
133 Critical,
134}
135
136#[derive(Copy, Clone, Debug, Deserialize)]
137pub enum CursorStyle {
138 Arrow,
139 ResizeLeftRight,
140 PointingHand,
141 IBeam,
142}
143
144#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
145pub struct AppVersion {
146 major: usize,
147 minor: usize,
148 patch: usize,
149}
150
151impl Default for CursorStyle {
152 fn default() -> Self {
153 Self::Arrow
154 }
155}
156
157impl FromStr for AppVersion {
158 type Err = anyhow::Error;
159
160 fn from_str(s: &str) -> Result<Self> {
161 let mut components = s.trim().split('.');
162 let major = components
163 .next()
164 .ok_or_else(|| anyhow!("missing major version number"))?
165 .parse()?;
166 let minor = components
167 .next()
168 .ok_or_else(|| anyhow!("missing minor version number"))?
169 .parse()?;
170 let patch = components
171 .next()
172 .ok_or_else(|| anyhow!("missing patch version number"))?
173 .parse()?;
174 Ok(Self {
175 major,
176 minor,
177 patch,
178 })
179 }
180}
181
182impl Display for AppVersion {
183 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
184 write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
185 }
186}
187
188#[derive(Copy, Clone, Debug)]
189pub enum RasterizationOptions {
190 Alpha,
191 Bgra,
192}
193
194pub trait FontSystem: Send + Sync {
195 fn add_fonts(&self, fonts: &[Arc<Vec<u8>>]) -> anyhow::Result<()>;
196 fn load_family(&self, name: &str) -> anyhow::Result<Vec<FontId>>;
197 fn select_font(
198 &self,
199 font_ids: &[FontId],
200 properties: &FontProperties,
201 ) -> anyhow::Result<FontId>;
202 fn font_metrics(&self, font_id: FontId) -> FontMetrics;
203 fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result<RectF>;
204 fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result<Vector2F>;
205 fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option<GlyphId>;
206 fn rasterize_glyph(
207 &self,
208 font_id: FontId,
209 font_size: f32,
210 glyph_id: GlyphId,
211 subpixel_shift: Vector2F,
212 scale_factor: f32,
213 options: RasterizationOptions,
214 ) -> Option<(RectI, Vec<u8>)>;
215 fn layout_line(&self, text: &str, font_size: f32, runs: &[(usize, RunStyle)]) -> LineLayout;
216 fn wrap_line(&self, text: &str, font_id: FontId, font_size: f32, width: f32) -> Vec<usize>;
217}
218
219impl<'a> Default for WindowOptions<'a> {
220 fn default() -> Self {
221 Self {
222 bounds: WindowBounds::Maximized,
223 title: Default::default(),
224 titlebar_appears_transparent: Default::default(),
225 traffic_light_position: Default::default(),
226 }
227 }
228}