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