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 ops::Range,
30 path::{Path, PathBuf},
31 rc::Rc,
32 str::FromStr,
33 sync::Arc,
34};
35use time::UtcOffset;
36
37pub trait Platform: Send + Sync {
38 fn dispatcher(&self) -> Arc<dyn Dispatcher>;
39 fn fonts(&self) -> Arc<dyn FontSystem>;
40
41 fn activate(&self, ignoring_other_apps: bool);
42 fn hide(&self);
43 fn hide_other_apps(&self);
44 fn unhide_other_apps(&self);
45 fn quit(&self);
46
47 fn open_window(
48 &self,
49 id: usize,
50 options: WindowOptions,
51 executor: Rc<executor::Foreground>,
52 ) -> Box<dyn Window>;
53 fn key_window_id(&self) -> Option<usize>;
54
55 fn add_status_item(&self) -> Box<dyn StatusItem>;
56
57 fn write_to_clipboard(&self, item: ClipboardItem);
58 fn read_from_clipboard(&self) -> Option<ClipboardItem>;
59 fn open_url(&self, url: &str);
60
61 fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Result<()>;
62 fn read_credentials(&self, url: &str) -> Result<Option<(String, Vec<u8>)>>;
63 fn delete_credentials(&self, url: &str) -> Result<()>;
64
65 fn set_cursor_style(&self, style: CursorStyle);
66
67 fn local_timezone(&self) -> UtcOffset;
68
69 fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf>;
70 fn app_path(&self) -> Result<PathBuf>;
71 fn app_version(&self) -> Result<AppVersion>;
72}
73
74pub(crate) trait ForegroundPlatform {
75 fn on_become_active(&self, callback: Box<dyn FnMut()>);
76 fn on_resign_active(&self, callback: Box<dyn FnMut()>);
77 fn on_quit(&self, callback: Box<dyn FnMut()>);
78 fn on_event(&self, callback: Box<dyn FnMut(Event) -> bool>);
79 fn on_open_urls(&self, callback: Box<dyn FnMut(Vec<String>)>);
80 fn run(&self, on_finish_launching: Box<dyn FnOnce()>);
81
82 fn on_menu_command(&self, callback: Box<dyn FnMut(&dyn Action)>);
83 fn on_validate_menu_command(&self, callback: Box<dyn FnMut(&dyn Action) -> bool>);
84 fn on_will_open_menu(&self, callback: Box<dyn FnMut()>);
85 fn set_menus(&self, menus: Vec<Menu>, matcher: &keymap::Matcher);
86 fn prompt_for_paths(
87 &self,
88 options: PathPromptOptions,
89 ) -> oneshot::Receiver<Option<Vec<PathBuf>>>;
90 fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>>;
91}
92
93pub trait Dispatcher: Send + Sync {
94 fn is_main_thread(&self) -> bool;
95 fn run_on_main_thread(&self, task: Runnable);
96}
97
98pub trait InputHandler {
99 fn selected_text_range(&self) -> Option<Range<usize>>;
100 fn marked_text_range(&self) -> Option<Range<usize>>;
101 fn text_for_range(&self, range_utf16: Range<usize>) -> Option<String>;
102 fn replace_text_in_range(&mut self, replacement_range: Option<Range<usize>>, text: &str);
103 fn replace_and_mark_text_in_range(
104 &mut self,
105 range_utf16: Option<Range<usize>>,
106 new_text: &str,
107 new_selected_range: Option<Range<usize>>,
108 );
109 fn unmark_text(&mut self);
110 fn rect_for_range(&self, range_utf16: Range<usize>) -> Option<RectF>;
111}
112
113pub trait Window {
114 fn as_any_mut(&mut self) -> &mut dyn Any;
115 fn on_event(&mut self, callback: Box<dyn FnMut(Event) -> bool>);
116 fn on_active_status_change(&mut self, callback: Box<dyn FnMut(bool)>);
117 fn on_resize(&mut self, callback: Box<dyn FnMut()>);
118 fn on_fullscreen(&mut self, callback: Box<dyn FnMut(bool)>);
119 fn on_should_close(&mut self, callback: Box<dyn FnMut() -> bool>);
120 fn on_close(&mut self, callback: Box<dyn FnOnce()>);
121 fn set_input_handler(&mut self, input_handler: Box<dyn InputHandler>);
122 fn prompt(&self, level: PromptLevel, msg: &str, answers: &[&str]) -> oneshot::Receiver<usize>;
123 fn activate(&self);
124 fn set_title(&mut self, title: &str);
125 fn set_edited(&mut self, edited: bool);
126 fn show_character_palette(&self);
127 fn minimize(&self);
128 fn zoom(&self);
129 fn toggle_full_screen(&self);
130
131 fn size(&self) -> Vector2F;
132 fn scale_factor(&self) -> f32;
133 fn titlebar_height(&self) -> f32;
134 fn present_scene(&mut self, scene: Scene);
135}
136
137pub trait StatusItem {}
138
139#[derive(Debug)]
140pub struct WindowOptions<'a> {
141 pub bounds: WindowBounds,
142 pub titlebar: Option<TitlebarOptions<'a>>,
143}
144
145#[derive(Debug)]
146pub struct TitlebarOptions<'a> {
147 pub title: Option<&'a str>,
148 pub appears_transparent: bool,
149 pub traffic_light_position: Option<Vector2F>,
150}
151
152#[derive(Debug)]
153pub enum WindowBounds {
154 Maximized,
155 Fixed(RectF),
156}
157
158pub struct PathPromptOptions {
159 pub files: bool,
160 pub directories: bool,
161 pub multiple: bool,
162}
163
164pub enum PromptLevel {
165 Info,
166 Warning,
167 Critical,
168}
169
170#[derive(Copy, Clone, Debug, Deserialize)]
171pub enum CursorStyle {
172 Arrow,
173 ResizeLeftRight,
174 PointingHand,
175 IBeam,
176}
177
178#[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
179pub struct AppVersion {
180 major: usize,
181 minor: usize,
182 patch: usize,
183}
184
185impl Default for CursorStyle {
186 fn default() -> Self {
187 Self::Arrow
188 }
189}
190
191impl FromStr for AppVersion {
192 type Err = anyhow::Error;
193
194 fn from_str(s: &str) -> Result<Self> {
195 let mut components = s.trim().split('.');
196 let major = components
197 .next()
198 .ok_or_else(|| anyhow!("missing major version number"))?
199 .parse()?;
200 let minor = components
201 .next()
202 .ok_or_else(|| anyhow!("missing minor version number"))?
203 .parse()?;
204 let patch = components
205 .next()
206 .ok_or_else(|| anyhow!("missing patch version number"))?
207 .parse()?;
208 Ok(Self {
209 major,
210 minor,
211 patch,
212 })
213 }
214}
215
216impl Display for AppVersion {
217 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
218 write!(f, "{}.{}.{}", self.major, self.minor, self.patch)
219 }
220}
221
222#[derive(Copy, Clone, Debug)]
223pub enum RasterizationOptions {
224 Alpha,
225 Bgra,
226}
227
228pub trait FontSystem: Send + Sync {
229 fn add_fonts(&self, fonts: &[Arc<Vec<u8>>]) -> anyhow::Result<()>;
230 fn load_family(&self, name: &str) -> anyhow::Result<Vec<FontId>>;
231 fn select_font(
232 &self,
233 font_ids: &[FontId],
234 properties: &FontProperties,
235 ) -> anyhow::Result<FontId>;
236 fn font_metrics(&self, font_id: FontId) -> FontMetrics;
237 fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result<RectF>;
238 fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result<Vector2F>;
239 fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option<GlyphId>;
240 fn rasterize_glyph(
241 &self,
242 font_id: FontId,
243 font_size: f32,
244 glyph_id: GlyphId,
245 subpixel_shift: Vector2F,
246 scale_factor: f32,
247 options: RasterizationOptions,
248 ) -> Option<(RectI, Vec<u8>)>;
249 fn layout_line(&self, text: &str, font_size: f32, runs: &[(usize, RunStyle)]) -> LineLayout;
250 fn wrap_line(&self, text: &str, font_id: FontId, font_size: f32, width: f32) -> Vec<usize>;
251}
252
253impl<'a> Default for WindowOptions<'a> {
254 fn default() -> Self {
255 Self {
256 bounds: WindowBounds::Maximized,
257 titlebar: Some(TitlebarOptions {
258 title: Default::default(),
259 appears_transparent: Default::default(),
260 traffic_light_position: Default::default(),
261 }),
262 }
263 }
264}