mod event; #[cfg(target_os = "macos")] pub mod mac; pub mod test; pub mod current { #[cfg(target_os = "macos")] pub use super::mac::*; } use crate::{ executor, fonts::{ Features as FontFeatures, FontId, GlyphId, Metrics as FontMetrics, Properties as FontProperties, }, geometry::{ rect::{RectF, RectI}, vector::Vector2F, }, keymap_matcher::KeymapMatcher, text_layout::{LineLayout, RunStyle}, Action, ClipboardItem, Menu, Scene, }; use anyhow::{anyhow, bail, Result}; use async_task::Runnable; pub use event::*; use postage::oneshot; use serde::Deserialize; use sqlez::{ bindable::{Bind, Column, StaticColumnCount}, statement::Statement, }; use std::{ any::Any, fmt::{self, Debug, Display}, ops::Range, path::{Path, PathBuf}, rc::Rc, str::FromStr, sync::Arc, }; use time::UtcOffset; use uuid::Uuid; pub trait Platform: Send + Sync { fn dispatcher(&self) -> Arc; fn fonts(&self) -> Arc; fn activate(&self, ignoring_other_apps: bool); fn hide(&self); fn hide_other_apps(&self); fn unhide_other_apps(&self); fn quit(&self); fn screen_by_id(&self, id: Uuid) -> Option>; fn screens(&self) -> Vec>; fn open_window( &self, id: usize, options: WindowOptions, executor: Rc, ) -> Box; fn main_window_id(&self) -> Option; fn add_status_item(&self, id: usize) -> Box; fn write_to_clipboard(&self, item: ClipboardItem); fn read_from_clipboard(&self) -> Option; fn open_url(&self, url: &str); fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Result<()>; fn read_credentials(&self, url: &str) -> Result)>>; fn delete_credentials(&self, url: &str) -> Result<()>; fn set_cursor_style(&self, style: CursorStyle); fn should_auto_hide_scrollbars(&self) -> bool; fn local_timezone(&self) -> UtcOffset; fn path_for_auxiliary_executable(&self, name: &str) -> Result; fn app_path(&self) -> Result; fn app_version(&self) -> Result; fn os_name(&self) -> &'static str; fn os_version(&self) -> Result; fn restart(&self); } pub(crate) trait ForegroundPlatform { fn on_become_active(&self, callback: Box); fn on_resign_active(&self, callback: Box); fn on_quit(&self, callback: Box); /// Handle the application being re-activated with no windows open. fn on_reopen(&self, callback: Box); fn on_event(&self, callback: Box bool>); fn on_open_urls(&self, callback: Box)>); fn run(&self, on_finish_launching: Box); fn on_menu_command(&self, callback: Box); fn on_validate_menu_command(&self, callback: Box bool>); fn on_will_open_menu(&self, callback: Box); fn set_menus(&self, menus: Vec, matcher: &KeymapMatcher); fn prompt_for_paths( &self, options: PathPromptOptions, ) -> oneshot::Receiver>>; fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver>; fn reveal_path(&self, path: &Path); } pub trait Dispatcher: Send + Sync { fn is_main_thread(&self) -> bool; fn run_on_main_thread(&self, task: Runnable); } pub trait InputHandler { fn selected_text_range(&self) -> Option>; fn marked_text_range(&self) -> Option>; fn text_for_range(&self, range_utf16: Range) -> Option; fn replace_text_in_range(&mut self, replacement_range: Option>, text: &str); fn replace_and_mark_text_in_range( &mut self, range_utf16: Option>, new_text: &str, new_selected_range: Option>, ); fn unmark_text(&mut self); fn rect_for_range(&self, range_utf16: Range) -> Option; } pub trait Screen: Debug { fn as_any(&self) -> &dyn Any; fn bounds(&self) -> RectF; fn display_uuid(&self) -> Option; } pub trait Window { fn bounds(&self) -> WindowBounds; fn content_size(&self) -> Vector2F; fn scale_factor(&self) -> f32; fn titlebar_height(&self) -> f32; fn appearance(&self) -> Appearance; fn screen(&self) -> Rc; fn as_any_mut(&mut self) -> &mut dyn Any; fn set_input_handler(&mut self, input_handler: Box); fn prompt(&self, level: PromptLevel, msg: &str, answers: &[&str]) -> oneshot::Receiver; fn activate(&self); fn set_title(&mut self, title: &str); fn set_edited(&mut self, edited: bool); fn show_character_palette(&self); fn minimize(&self); fn zoom(&self); fn present_scene(&mut self, scene: Scene); fn toggle_full_screen(&self); fn on_event(&mut self, callback: Box bool>); fn on_active_status_change(&mut self, callback: Box); fn on_resize(&mut self, callback: Box); fn on_fullscreen(&mut self, callback: Box); fn on_moved(&mut self, callback: Box); fn on_should_close(&mut self, callback: Box bool>); fn on_close(&mut self, callback: Box); fn on_appearance_changed(&mut self, callback: Box); fn is_topmost_for_position(&self, position: Vector2F) -> bool; } #[derive(Debug)] pub struct WindowOptions<'a> { pub bounds: WindowBounds, pub titlebar: Option>, pub center: bool, pub focus: bool, pub kind: WindowKind, pub is_movable: bool, pub screen: Option>, } #[derive(Debug)] pub struct TitlebarOptions<'a> { pub title: Option<&'a str>, pub appears_transparent: bool, pub traffic_light_position: Option, } #[derive(Copy, Clone, Debug)] pub enum Appearance { Light, VibrantLight, Dark, VibrantDark, } impl Default for Appearance { fn default() -> Self { Self::Light } } #[derive(Copy, Clone, Debug, PartialEq, Eq)] pub enum WindowKind { Normal, PopUp, } #[derive(Copy, Clone, Debug, PartialEq)] pub enum WindowBounds { Fullscreen, Maximized, Fixed(RectF), } impl StaticColumnCount for WindowBounds { fn column_count() -> usize { 5 } } impl Bind for WindowBounds { fn bind(&self, statement: &Statement, start_index: i32) -> Result { let (region, next_index) = match self { WindowBounds::Fullscreen => { let next_index = statement.bind("Fullscreen", start_index)?; (None, next_index) } WindowBounds::Maximized => { let next_index = statement.bind("Maximized", start_index)?; (None, next_index) } WindowBounds::Fixed(region) => { let next_index = statement.bind("Fixed", start_index)?; (Some(*region), next_index) } }; statement.bind( region.map(|region| { ( region.min_x(), region.min_y(), region.width(), region.height(), ) }), next_index, ) } } impl Column for WindowBounds { fn column(statement: &mut Statement, start_index: i32) -> Result<(Self, i32)> { let (window_state, next_index) = String::column(statement, start_index)?; let bounds = match window_state.as_str() { "Fullscreen" => WindowBounds::Fullscreen, "Maximized" => WindowBounds::Maximized, "Fixed" => { let ((x, y, width, height), _) = Column::column(statement, next_index)?; WindowBounds::Fixed(RectF::new( Vector2F::new(x, y), Vector2F::new(width, height), )) } _ => bail!("Window State did not have a valid string"), }; Ok((bounds, next_index + 4)) } } pub struct PathPromptOptions { pub files: bool, pub directories: bool, pub multiple: bool, } pub enum PromptLevel { Info, Warning, Critical, } #[derive(Copy, Clone, Debug, Deserialize)] pub enum CursorStyle { Arrow, ResizeLeftRight, ResizeUpDown, PointingHand, IBeam, } impl Default for CursorStyle { fn default() -> Self { Self::Arrow } } #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)] pub struct AppVersion { major: usize, minor: usize, patch: usize, } impl FromStr for AppVersion { type Err = anyhow::Error; fn from_str(s: &str) -> Result { let mut components = s.trim().split('.'); let major = components .next() .ok_or_else(|| anyhow!("missing major version number"))? .parse()?; let minor = components .next() .ok_or_else(|| anyhow!("missing minor version number"))? .parse()?; let patch = components .next() .ok_or_else(|| anyhow!("missing patch version number"))? .parse()?; Ok(Self { major, minor, patch, }) } } impl Display for AppVersion { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { write!(f, "{}.{}.{}", self.major, self.minor, self.patch) } } #[derive(Copy, Clone, Debug)] pub enum RasterizationOptions { Alpha, Bgra, } pub trait FontSystem: Send + Sync { fn add_fonts(&self, fonts: &[Arc>]) -> anyhow::Result<()>; fn load_family(&self, name: &str, features: &FontFeatures) -> anyhow::Result>; fn select_font( &self, font_ids: &[FontId], properties: &FontProperties, ) -> anyhow::Result; fn font_metrics(&self, font_id: FontId) -> FontMetrics; fn typographic_bounds(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result; fn advance(&self, font_id: FontId, glyph_id: GlyphId) -> anyhow::Result; fn glyph_for_char(&self, font_id: FontId, ch: char) -> Option; fn rasterize_glyph( &self, font_id: FontId, font_size: f32, glyph_id: GlyphId, subpixel_shift: Vector2F, scale_factor: f32, options: RasterizationOptions, ) -> Option<(RectI, Vec)>; fn layout_line(&self, text: &str, font_size: f32, runs: &[(usize, RunStyle)]) -> LineLayout; fn wrap_line(&self, text: &str, font_id: FontId, font_size: f32, width: f32) -> Vec; } impl<'a> Default for WindowOptions<'a> { fn default() -> Self { Self { bounds: WindowBounds::Maximized, titlebar: Some(TitlebarOptions { title: Default::default(), appears_transparent: Default::default(), traffic_light_position: Default::default(), }), center: false, focus: true, kind: WindowKind::Normal, is_movable: true, screen: None, } } }