12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340 |
- // Copyright 2019-2021 Tauri Programme within The Commons Conservancy
- // SPDX-License-Identifier: Apache-2.0
- // SPDX-License-Identifier: MIT
- //! The [`wry`] Tauri [`Runtime`].
- use tauri_runtime::{
- monitor::Monitor,
- webview::{
- FileDropEvent, FileDropHandler, RpcRequest, WebviewRpcHandler, WindowBuilder, WindowBuilderBase,
- },
- window::{
- dpi::{LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize, Position, Size},
- DetachedWindow, PendingWindow, WindowEvent,
- },
- Dispatch, Error, Icon, Params, Result, RunIteration, Runtime, RuntimeHandle,
- };
- #[cfg(feature = "menu")]
- use tauri_runtime::window::MenuEvent;
- #[cfg(feature = "system-tray")]
- use tauri_runtime::SystemTrayEvent;
- #[cfg(windows)]
- use winapi::shared::windef::HWND;
- #[cfg(feature = "system-tray")]
- use wry::application::platform::system_tray::SystemTrayBuilder;
- #[cfg(windows)]
- use wry::application::platform::windows::WindowBuilderExtWindows;
- use tauri_utils::config::WindowConfig;
- use uuid::Uuid;
- use wry::{
- application::{
- dpi::{
- LogicalPosition as WryLogicalPosition, LogicalSize as WryLogicalSize,
- PhysicalPosition as WryPhysicalPosition, PhysicalSize as WryPhysicalSize,
- Position as WryPosition, Size as WrySize,
- },
- event::{Event, WindowEvent as WryWindowEvent},
- event_loop::{ControlFlow, EventLoop, EventLoopProxy, EventLoopWindowTarget},
- monitor::MonitorHandle,
- window::{Fullscreen, Icon as WindowIcon, Window, WindowBuilder as WryWindowBuilder, WindowId},
- },
- webview::{
- FileDropEvent as WryFileDropEvent, RpcRequest as WryRpcRequest, RpcResponse, WebView,
- WebViewBuilder,
- },
- };
- use std::{
- collections::HashMap,
- convert::TryFrom,
- fs::read,
- sync::{
- mpsc::{channel, Receiver, Sender},
- Arc, Mutex, MutexGuard,
- },
- };
- #[cfg(any(feature = "menu", feature = "system-tray"))]
- mod menu;
- #[cfg(any(feature = "menu", feature = "system-tray"))]
- use menu::*;
- type CreateWebviewHandler =
- Box<dyn FnOnce(&EventLoopWindowTarget<Message>) -> Result<WebView> + Send>;
- type MainThreadTask = Box<dyn FnOnce() + Send>;
- type WindowEventHandler = Box<dyn Fn(&WindowEvent) + Send>;
- type WindowEventListeners = Arc<Mutex<HashMap<Uuid, WindowEventHandler>>>;
- /// Wrapper around a [`wry::application::window::Icon`] that can be created from an [`Icon`].
- pub struct WryIcon(WindowIcon);
- fn icon_err<E: std::error::Error + Send + 'static>(e: E) -> Error {
- Error::InvalidIcon(Box::new(e))
- }
- impl TryFrom<Icon> for WryIcon {
- type Error = Error;
- fn try_from(icon: Icon) -> std::result::Result<Self, Self::Error> {
- let image_bytes = match icon {
- Icon::File(path) => read(path).map_err(icon_err)?,
- Icon::Raw(raw) => raw,
- _ => unimplemented!(),
- };
- let extension = infer::get(&image_bytes)
- .expect("could not determine icon extension")
- .extension();
- match extension {
- #[cfg(windows)]
- "ico" => {
- let icon_dir = ico::IconDir::read(std::io::Cursor::new(image_bytes)).map_err(icon_err)?;
- let entry = &icon_dir.entries()[0];
- let icon = WindowIcon::from_rgba(
- entry.decode().map_err(icon_err)?.rgba_data().to_vec(),
- entry.width(),
- entry.height(),
- )
- .map_err(icon_err)?;
- Ok(Self(icon))
- }
- _ => panic!(
- "image `{}` extension not supported; please file a Tauri feature request",
- extension
- ),
- }
- }
- }
- struct WindowEventWrapper(Option<WindowEvent>);
- impl<'a> From<&WryWindowEvent<'a>> for WindowEventWrapper {
- fn from(event: &WryWindowEvent<'a>) -> Self {
- let event = match event {
- WryWindowEvent::Resized(size) => WindowEvent::Resized(PhysicalSizeWrapper(*size).into()),
- WryWindowEvent::Moved(position) => {
- WindowEvent::Moved(PhysicalPositionWrapper(*position).into())
- }
- WryWindowEvent::CloseRequested => WindowEvent::CloseRequested,
- WryWindowEvent::Destroyed => WindowEvent::Destroyed,
- WryWindowEvent::Focused(focused) => WindowEvent::Focused(*focused),
- WryWindowEvent::ScaleFactorChanged {
- scale_factor,
- new_inner_size,
- } => WindowEvent::ScaleFactorChanged {
- scale_factor: *scale_factor,
- new_inner_size: PhysicalSizeWrapper(**new_inner_size).into(),
- },
- _ => return Self(None),
- };
- Self(Some(event))
- }
- }
- pub struct MonitorHandleWrapper(MonitorHandle);
- impl From<MonitorHandleWrapper> for Monitor {
- fn from(monitor: MonitorHandleWrapper) -> Monitor {
- Self {
- name: monitor.0.name(),
- position: PhysicalPositionWrapper(monitor.0.position()).into(),
- size: PhysicalSizeWrapper(monitor.0.size()).into(),
- scale_factor: monitor.0.scale_factor(),
- }
- }
- }
- struct PhysicalPositionWrapper<T>(WryPhysicalPosition<T>);
- impl<T> From<PhysicalPositionWrapper<T>> for PhysicalPosition<T> {
- fn from(position: PhysicalPositionWrapper<T>) -> Self {
- Self {
- x: position.0.x,
- y: position.0.y,
- }
- }
- }
- impl<T> From<PhysicalPosition<T>> for PhysicalPositionWrapper<T> {
- fn from(position: PhysicalPosition<T>) -> Self {
- Self(WryPhysicalPosition {
- x: position.x,
- y: position.y,
- })
- }
- }
- struct LogicalPositionWrapper<T>(WryLogicalPosition<T>);
- impl<T> From<LogicalPosition<T>> for LogicalPositionWrapper<T> {
- fn from(position: LogicalPosition<T>) -> Self {
- Self(WryLogicalPosition {
- x: position.x,
- y: position.y,
- })
- }
- }
- struct PhysicalSizeWrapper<T>(WryPhysicalSize<T>);
- impl<T> From<PhysicalSizeWrapper<T>> for PhysicalSize<T> {
- fn from(size: PhysicalSizeWrapper<T>) -> Self {
- Self {
- width: size.0.width,
- height: size.0.height,
- }
- }
- }
- impl<T> From<PhysicalSize<T>> for PhysicalSizeWrapper<T> {
- fn from(size: PhysicalSize<T>) -> Self {
- Self(WryPhysicalSize {
- width: size.width,
- height: size.height,
- })
- }
- }
- struct LogicalSizeWrapper<T>(WryLogicalSize<T>);
- impl<T> From<LogicalSize<T>> for LogicalSizeWrapper<T> {
- fn from(size: LogicalSize<T>) -> Self {
- Self(WryLogicalSize {
- width: size.width,
- height: size.height,
- })
- }
- }
- struct SizeWrapper(WrySize);
- impl From<Size> for SizeWrapper {
- fn from(size: Size) -> Self {
- match size {
- Size::Logical(s) => Self(WrySize::Logical(LogicalSizeWrapper::from(s).0)),
- Size::Physical(s) => Self(WrySize::Physical(PhysicalSizeWrapper::from(s).0)),
- }
- }
- }
- struct PositionWrapper(WryPosition);
- impl From<Position> for PositionWrapper {
- fn from(position: Position) -> Self {
- match position {
- Position::Logical(s) => Self(WryPosition::Logical(LogicalPositionWrapper::from(s).0)),
- Position::Physical(s) => Self(WryPosition::Physical(PhysicalPositionWrapper::from(s).0)),
- }
- }
- }
- #[derive(Debug, Clone, Default)]
- pub struct WindowBuilderWrapper(WryWindowBuilder);
- impl WindowBuilderBase for WindowBuilderWrapper {}
- impl WindowBuilder for WindowBuilderWrapper {
- fn new() -> Self {
- Default::default()
- }
- fn with_config(config: WindowConfig) -> Self {
- let mut window = WindowBuilderWrapper::new()
- .title(config.title.to_string())
- .inner_size(config.width, config.height)
- .visible(config.visible)
- .resizable(config.resizable)
- .decorations(config.decorations)
- .maximized(config.maximized)
- .fullscreen(config.fullscreen)
- .transparent(config.transparent)
- .always_on_top(config.always_on_top);
- if let (Some(min_width), Some(min_height)) = (config.min_width, config.min_height) {
- window = window.min_inner_size(min_width, min_height);
- }
- if let (Some(max_width), Some(max_height)) = (config.max_width, config.max_height) {
- window = window.max_inner_size(max_width, max_height);
- }
- if let (Some(x), Some(y)) = (config.x, config.y) {
- window = window.position(x, y);
- }
- window
- }
- #[cfg(feature = "menu")]
- fn menu<I: MenuId>(self, menu: Vec<Menu<I>>) -> Self {
- Self(
- self.0.with_menu(
- menu
- .into_iter()
- .map(|m| MenuWrapper::from(m).0)
- .collect::<Vec<WryMenu>>(),
- ),
- )
- }
- fn position(self, x: f64, y: f64) -> Self {
- Self(self.0.with_position(WryLogicalPosition::new(x, y)))
- }
- fn inner_size(self, width: f64, height: f64) -> Self {
- Self(self.0.with_inner_size(WryLogicalSize::new(width, height)))
- }
- fn min_inner_size(self, min_width: f64, min_height: f64) -> Self {
- Self(
- self
- .0
- .with_min_inner_size(WryLogicalSize::new(min_width, min_height)),
- )
- }
- fn max_inner_size(self, max_width: f64, max_height: f64) -> Self {
- Self(
- self
- .0
- .with_max_inner_size(WryLogicalSize::new(max_width, max_height)),
- )
- }
- fn resizable(self, resizable: bool) -> Self {
- Self(self.0.with_resizable(resizable))
- }
- fn title<S: Into<String>>(self, title: S) -> Self {
- Self(self.0.with_title(title.into()))
- }
- fn fullscreen(self, fullscreen: bool) -> Self {
- if fullscreen {
- Self(self.0.with_fullscreen(Some(Fullscreen::Borderless(None))))
- } else {
- Self(self.0.with_fullscreen(None))
- }
- }
- fn maximized(self, maximized: bool) -> Self {
- Self(self.0.with_maximized(maximized))
- }
- fn visible(self, visible: bool) -> Self {
- Self(self.0.with_visible(visible))
- }
- fn transparent(self, transparent: bool) -> Self {
- Self(self.0.with_transparent(transparent))
- }
- fn decorations(self, decorations: bool) -> Self {
- Self(self.0.with_decorations(decorations))
- }
- fn always_on_top(self, always_on_top: bool) -> Self {
- Self(self.0.with_always_on_top(always_on_top))
- }
- #[cfg(windows)]
- fn parent_window(self, parent: HWND) -> Self {
- Self(self.0.with_parent_window(parent))
- }
- #[cfg(windows)]
- fn owner_window(self, owner: HWND) -> Self {
- Self(self.0.with_owner_window(owner))
- }
- fn icon(self, icon: Icon) -> Result<Self> {
- Ok(Self(
- self.0.with_window_icon(Some(WryIcon::try_from(icon)?.0)),
- ))
- }
- fn has_icon(&self) -> bool {
- self.0.window.window_icon.is_some()
- }
- #[cfg(feature = "menu")]
- fn has_menu(&self) -> bool {
- self.0.window.window_menu.is_some()
- }
- }
- pub struct RpcRequestWrapper(WryRpcRequest);
- impl From<RpcRequestWrapper> for RpcRequest {
- fn from(request: RpcRequestWrapper) -> Self {
- Self {
- command: request.0.method,
- params: request.0.params,
- }
- }
- }
- pub struct FileDropEventWrapper(WryFileDropEvent);
- impl From<FileDropEventWrapper> for FileDropEvent {
- fn from(event: FileDropEventWrapper) -> Self {
- match event.0 {
- WryFileDropEvent::Hovered(paths) => FileDropEvent::Hovered(paths),
- WryFileDropEvent::Dropped(paths) => FileDropEvent::Dropped(paths),
- WryFileDropEvent::Cancelled => FileDropEvent::Cancelled,
- }
- }
- }
- #[cfg(windows)]
- struct Hwnd(*mut std::ffi::c_void);
- #[cfg(windows)]
- unsafe impl Send for Hwnd {}
- #[derive(Debug, Clone)]
- enum WindowMessage {
- // Getters
- ScaleFactor(Sender<f64>),
- InnerPosition(Sender<Result<PhysicalPosition<i32>>>),
- OuterPosition(Sender<Result<PhysicalPosition<i32>>>),
- InnerSize(Sender<PhysicalSize<u32>>),
- OuterSize(Sender<PhysicalSize<u32>>),
- IsFullscreen(Sender<bool>),
- IsMaximized(Sender<bool>),
- IsDecorated(Sender<bool>),
- IsResizable(Sender<bool>),
- CurrentMonitor(Sender<Option<MonitorHandle>>),
- PrimaryMonitor(Sender<Option<MonitorHandle>>),
- AvailableMonitors(Sender<Vec<MonitorHandle>>),
- #[cfg(windows)]
- Hwnd(Sender<Hwnd>),
- // Setters
- SetResizable(bool),
- SetTitle(String),
- Maximize,
- Unmaximize,
- Minimize,
- Unminimize,
- Show,
- Hide,
- Close,
- SetDecorations(bool),
- SetAlwaysOnTop(bool),
- SetSize(Size),
- SetMinSize(Option<Size>),
- SetMaxSize(Option<Size>),
- SetPosition(Position),
- SetFullscreen(bool),
- SetFocus,
- SetIcon(WindowIcon),
- DragWindow,
- }
- #[derive(Debug, Clone)]
- enum WebviewMessage {
- EvaluateScript(String),
- Print,
- }
- #[derive(Clone)]
- enum Message {
- Window(WindowId, WindowMessage),
- Webview(WindowId, WebviewMessage),
- CreateWebview(Arc<Mutex<Option<CreateWebviewHandler>>>, Sender<WindowId>),
- }
- #[derive(Clone)]
- struct DispatcherContext {
- proxy: EventLoopProxy<Message>,
- task_tx: Sender<MainThreadTask>,
- window_event_listeners: WindowEventListeners,
- #[cfg(feature = "menu")]
- menu_event_listeners: MenuEventListeners,
- }
- /// The Tauri [`Dispatch`] for [`Wry`].
- #[derive(Clone)]
- pub struct WryDispatcher {
- window_id: WindowId,
- context: DispatcherContext,
- }
- macro_rules! dispatcher_getter {
- ($self: ident, $message: expr) => {{
- let (tx, rx) = channel();
- $self
- .context
- .proxy
- .send_event(Message::Window($self.window_id, $message(tx)))
- .map_err(|_| Error::FailedToSendMessage)?;
- rx.recv().unwrap()
- }};
- }
- impl Dispatch for WryDispatcher {
- type Runtime = Wry;
- type WindowBuilder = WindowBuilderWrapper;
- fn run_on_main_thread<F: FnOnce() + Send + 'static>(&self, f: F) -> Result<()> {
- self
- .context
- .task_tx
- .send(Box::new(f))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn on_window_event<F: Fn(&WindowEvent) + Send + 'static>(&self, f: F) -> Uuid {
- let id = Uuid::new_v4();
- self
- .context
- .window_event_listeners
- .lock()
- .unwrap()
- .insert(id, Box::new(f));
- id
- }
- #[cfg(feature = "menu")]
- fn on_menu_event<F: Fn(&MenuEvent) + Send + 'static>(&self, f: F) -> Uuid {
- let id = Uuid::new_v4();
- self
- .context
- .menu_event_listeners
- .lock()
- .unwrap()
- .insert(id, Box::new(f));
- id
- }
- // Getters
- fn scale_factor(&self) -> Result<f64> {
- Ok(dispatcher_getter!(self, WindowMessage::ScaleFactor))
- }
- fn inner_position(&self) -> Result<PhysicalPosition<i32>> {
- dispatcher_getter!(self, WindowMessage::InnerPosition)
- }
- fn outer_position(&self) -> Result<PhysicalPosition<i32>> {
- dispatcher_getter!(self, WindowMessage::OuterPosition)
- }
- fn inner_size(&self) -> Result<PhysicalSize<u32>> {
- Ok(dispatcher_getter!(self, WindowMessage::InnerSize))
- }
- fn outer_size(&self) -> Result<PhysicalSize<u32>> {
- Ok(dispatcher_getter!(self, WindowMessage::OuterSize))
- }
- fn is_fullscreen(&self) -> Result<bool> {
- Ok(dispatcher_getter!(self, WindowMessage::IsFullscreen))
- }
- fn is_maximized(&self) -> Result<bool> {
- Ok(dispatcher_getter!(self, WindowMessage::IsMaximized))
- }
- /// Gets the window’s current decoration state.
- fn is_decorated(&self) -> Result<bool> {
- Ok(dispatcher_getter!(self, WindowMessage::IsDecorated))
- }
- /// Gets the window’s current resizable state.
- fn is_resizable(&self) -> Result<bool> {
- Ok(dispatcher_getter!(self, WindowMessage::IsResizable))
- }
- fn current_monitor(&self) -> Result<Option<Monitor>> {
- Ok(
- dispatcher_getter!(self, WindowMessage::CurrentMonitor)
- .map(|m| MonitorHandleWrapper(m).into()),
- )
- }
- fn primary_monitor(&self) -> Result<Option<Monitor>> {
- Ok(
- dispatcher_getter!(self, WindowMessage::PrimaryMonitor)
- .map(|m| MonitorHandleWrapper(m).into()),
- )
- }
- fn available_monitors(&self) -> Result<Vec<Monitor>> {
- Ok(
- dispatcher_getter!(self, WindowMessage::AvailableMonitors)
- .into_iter()
- .map(|m| MonitorHandleWrapper(m).into())
- .collect(),
- )
- }
- #[cfg(windows)]
- fn hwnd(&self) -> Result<*mut std::ffi::c_void> {
- Ok(dispatcher_getter!(self, WindowMessage::Hwnd).0)
- }
- // Setters
- fn print(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Webview(self.window_id, WebviewMessage::Print))
- .map_err(|_| Error::FailedToSendMessage)
- }
- // Creates a window by dispatching a message to the event loop.
- // Note that this must be called from a separate thread, otherwise the channel will introduce a deadlock.
- fn create_window<P: Params<Runtime = Self::Runtime>>(
- &mut self,
- pending: PendingWindow<P>,
- ) -> Result<DetachedWindow<P>> {
- let (tx, rx) = channel();
- let label = pending.label.clone();
- let context = self.context.clone();
- self
- .context
- .proxy
- .send_event(Message::CreateWebview(
- Arc::new(Mutex::new(Some(Box::new(move |event_loop| {
- create_webview(event_loop, context, pending)
- })))),
- tx,
- ))
- .map_err(|_| Error::FailedToSendMessage)?;
- let window_id = rx.recv().unwrap();
- let dispatcher = WryDispatcher {
- window_id,
- context: self.context.clone(),
- };
- Ok(DetachedWindow { label, dispatcher })
- }
- fn set_resizable(&self, resizable: bool) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetResizable(resizable),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_title<S: Into<String>>(&self, title: S) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetTitle(title.into()),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn maximize(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::Maximize))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn unmaximize(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::Unmaximize))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn minimize(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::Minimize))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn unminimize(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::Unminimize))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn show(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::Show))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn hide(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::Hide))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn close(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::Close))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_decorations(&self, decorations: bool) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetDecorations(decorations),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_always_on_top(&self, always_on_top: bool) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetAlwaysOnTop(always_on_top),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_size(&self, size: Size) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetSize(size),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_min_size(&self, size: Option<Size>) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetMinSize(size),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_max_size(&self, size: Option<Size>) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetMaxSize(size),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_position(&self, position: Position) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetPosition(position),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_fullscreen(&self, fullscreen: bool) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetFullscreen(fullscreen),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_focus(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::SetFocus))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn set_icon(&self, icon: Icon) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(
- self.window_id,
- WindowMessage::SetIcon(WryIcon::try_from(icon)?.0),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn start_dragging(&self) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Window(self.window_id, WindowMessage::DragWindow))
- .map_err(|_| Error::FailedToSendMessage)
- }
- fn eval_script<S: Into<String>>(&self, script: S) -> Result<()> {
- self
- .context
- .proxy
- .send_event(Message::Webview(
- self.window_id,
- WebviewMessage::EvaluateScript(script.into()),
- ))
- .map_err(|_| Error::FailedToSendMessage)
- }
- }
- /// A Tauri [`Runtime`] wrapper around wry.
- pub struct Wry {
- event_loop: EventLoop<Message>,
- webviews: Arc<Mutex<HashMap<WindowId, WebView>>>,
- task_tx: Sender<MainThreadTask>,
- window_event_listeners: WindowEventListeners,
- #[cfg(feature = "menu")]
- menu_event_listeners: MenuEventListeners,
- #[cfg(feature = "system-tray")]
- system_tray_event_listeners: SystemTrayEventListeners,
- task_rx: Arc<Receiver<MainThreadTask>>,
- }
- /// A handle to the Wry runtime.
- #[derive(Clone)]
- pub struct WryHandle {
- dispatcher_context: DispatcherContext,
- }
- impl RuntimeHandle for WryHandle {
- type Runtime = Wry;
- // Creates a window by dispatching a message to the event loop.
- // Note that this must be called from a separate thread, otherwise the channel will introduce a deadlock.
- fn create_window<P: Params<Runtime = Self::Runtime>>(
- &self,
- pending: PendingWindow<P>,
- ) -> Result<DetachedWindow<P>> {
- let (tx, rx) = channel();
- let label = pending.label.clone();
- let dispatcher_context = self.dispatcher_context.clone();
- self
- .dispatcher_context
- .proxy
- .send_event(Message::CreateWebview(
- Arc::new(Mutex::new(Some(Box::new(move |event_loop| {
- create_webview(event_loop, dispatcher_context, pending)
- })))),
- tx,
- ))
- .map_err(|_| Error::FailedToSendMessage)?;
- let window_id = rx.recv().unwrap();
- let dispatcher = WryDispatcher {
- window_id,
- context: self.dispatcher_context.clone(),
- };
- Ok(DetachedWindow { label, dispatcher })
- }
- }
- impl Runtime for Wry {
- type Dispatcher = WryDispatcher;
- type Handle = WryHandle;
- fn new() -> Result<Self> {
- let event_loop = EventLoop::<Message>::with_user_event();
- let (task_tx, task_rx) = channel();
- Ok(Self {
- event_loop,
- webviews: Default::default(),
- task_tx,
- task_rx: Arc::new(task_rx),
- window_event_listeners: Default::default(),
- #[cfg(feature = "menu")]
- menu_event_listeners: Default::default(),
- #[cfg(feature = "system-tray")]
- system_tray_event_listeners: Default::default(),
- })
- }
- fn handle(&self) -> Self::Handle {
- WryHandle {
- dispatcher_context: DispatcherContext {
- proxy: self.event_loop.create_proxy(),
- task_tx: self.task_tx.clone(),
- window_event_listeners: self.window_event_listeners.clone(),
- #[cfg(feature = "menu")]
- menu_event_listeners: self.menu_event_listeners.clone(),
- },
- }
- }
- fn create_window<P: Params<Runtime = Self>>(
- &self,
- pending: PendingWindow<P>,
- ) -> Result<DetachedWindow<P>> {
- let label = pending.label.clone();
- let proxy = self.event_loop.create_proxy();
- let webview = create_webview(
- &self.event_loop,
- DispatcherContext {
- proxy: proxy.clone(),
- task_tx: self.task_tx.clone(),
- window_event_listeners: self.window_event_listeners.clone(),
- #[cfg(feature = "menu")]
- menu_event_listeners: self.menu_event_listeners.clone(),
- },
- pending,
- )?;
- let dispatcher = WryDispatcher {
- window_id: webview.window().id(),
- context: DispatcherContext {
- proxy,
- task_tx: self.task_tx.clone(),
- window_event_listeners: self.window_event_listeners.clone(),
- #[cfg(feature = "menu")]
- menu_event_listeners: self.menu_event_listeners.clone(),
- },
- };
- self
- .webviews
- .lock()
- .unwrap()
- .insert(webview.window().id(), webview);
- Ok(DetachedWindow { label, dispatcher })
- }
- #[cfg(feature = "system-tray")]
- fn system_tray<I: MenuId>(
- &self,
- icon: Icon,
- menu_items: Vec<SystemTrayMenuItem<I>>,
- ) -> Result<()> {
- // todo: fix this interface in Tao to an enum similar to Icon
- // we expect the code that passes the Icon enum to have already checked the platform.
- let icon = match icon {
- #[cfg(target_os = "linux")]
- Icon::File(path) => path,
- #[cfg(not(target_os = "linux"))]
- Icon::Raw(bytes) => bytes,
- #[cfg(target_os = "linux")]
- Icon::Raw(_) => {
- panic!("linux requires the system menu icon to be a file path, not bytes.")
- }
- #[cfg(not(target_os = "linux"))]
- Icon::File(_) => {
- panic!("non-linux system menu icons must be bytes, not a file path",)
- }
- _ => unreachable!(),
- };
- SystemTrayBuilder::new(
- icon,
- menu_items
- .into_iter()
- .map(|m| MenuItemWrapper::from(m).0)
- .collect(),
- )
- .build(&self.event_loop)
- .map_err(|e| Error::SystemTray(Box::new(e)))?;
- Ok(())
- }
- #[cfg(feature = "system-tray")]
- fn on_system_tray_event<F: Fn(&SystemTrayEvent) + Send + 'static>(&mut self, f: F) -> Uuid {
- let id = Uuid::new_v4();
- self
- .system_tray_event_listeners
- .lock()
- .unwrap()
- .insert(id, Box::new(f));
- id
- }
- #[cfg(any(target_os = "windows", target_os = "macos"))]
- fn run_iteration(&mut self) -> RunIteration {
- use wry::application::platform::run_return::EventLoopExtRunReturn;
- let webviews = self.webviews.clone();
- let task_rx = self.task_rx.clone();
- let window_event_listeners = self.window_event_listeners.clone();
- #[cfg(feature = "menu")]
- let menu_event_listeners = self.menu_event_listeners.clone();
- #[cfg(feature = "system-tray")]
- let system_tray_event_listeners = self.system_tray_event_listeners.clone();
- let mut iteration = RunIteration::default();
- self
- .event_loop
- .run_return(|event, event_loop, control_flow| {
- if let Event::MainEventsCleared = &event {
- *control_flow = ControlFlow::Exit;
- }
- iteration = handle_event_loop(
- event,
- event_loop,
- control_flow,
- EventLoopIterationContext {
- webviews: webviews.lock().expect("poisoned webview collection"),
- task_rx: task_rx.clone(),
- window_event_listeners: window_event_listeners.clone(),
- #[cfg(feature = "menu")]
- menu_event_listeners: menu_event_listeners.clone(),
- #[cfg(feature = "system-tray")]
- system_tray_event_listeners: system_tray_event_listeners.clone(),
- },
- );
- });
- iteration
- }
- fn run(self) {
- let webviews = self.webviews.clone();
- let task_rx = self.task_rx;
- let window_event_listeners = self.window_event_listeners.clone();
- #[cfg(feature = "menu")]
- let menu_event_listeners = self.menu_event_listeners.clone();
- #[cfg(feature = "system-tray")]
- let system_tray_event_listeners = self.system_tray_event_listeners;
- self.event_loop.run(move |event, event_loop, control_flow| {
- handle_event_loop(
- event,
- event_loop,
- control_flow,
- EventLoopIterationContext {
- webviews: webviews.lock().expect("poisoned webview collection"),
- task_rx: task_rx.clone(),
- window_event_listeners: window_event_listeners.clone(),
- #[cfg(feature = "menu")]
- menu_event_listeners: menu_event_listeners.clone(),
- #[cfg(feature = "system-tray")]
- system_tray_event_listeners: system_tray_event_listeners.clone(),
- },
- );
- })
- }
- }
- struct EventLoopIterationContext<'a> {
- webviews: MutexGuard<'a, HashMap<WindowId, WebView>>,
- task_rx: Arc<Receiver<MainThreadTask>>,
- window_event_listeners: WindowEventListeners,
- #[cfg(feature = "menu")]
- menu_event_listeners: MenuEventListeners,
- #[cfg(feature = "system-tray")]
- system_tray_event_listeners: SystemTrayEventListeners,
- }
- fn handle_event_loop(
- event: Event<Message>,
- event_loop: &EventLoopWindowTarget<Message>,
- control_flow: &mut ControlFlow,
- context: EventLoopIterationContext<'_>,
- ) -> RunIteration {
- let EventLoopIterationContext {
- mut webviews,
- task_rx,
- window_event_listeners,
- #[cfg(feature = "menu")]
- menu_event_listeners,
- #[cfg(feature = "system-tray")]
- system_tray_event_listeners,
- } = context;
- *control_flow = ControlFlow::Wait;
- for (_, w) in webviews.iter() {
- if let Err(e) = w.evaluate_script() {
- eprintln!("{}", e);
- }
- }
- while let Ok(task) = task_rx.try_recv() {
- task();
- }
- match event {
- #[cfg(feature = "menu")]
- Event::MenuEvent {
- menu_id,
- origin: MenuType::Menubar,
- } => {
- let event = MenuEvent {
- menu_item_id: menu_id.0,
- };
- for handler in menu_event_listeners.lock().unwrap().values() {
- handler(&event);
- }
- }
- #[cfg(feature = "system-tray")]
- Event::MenuEvent {
- menu_id,
- origin: MenuType::SystemTray,
- } => {
- let event = SystemTrayEvent {
- menu_item_id: menu_id.0,
- };
- for handler in system_tray_event_listeners.lock().unwrap().values() {
- handler(&event);
- }
- }
- Event::WindowEvent { event, window_id } => {
- if let Some(event) = WindowEventWrapper::from(&event).0 {
- for handler in window_event_listeners.lock().unwrap().values() {
- handler(&event);
- }
- }
- match event {
- WryWindowEvent::CloseRequested => {
- webviews.remove(&window_id);
- if webviews.is_empty() {
- *control_flow = ControlFlow::Exit;
- }
- }
- WryWindowEvent::Resized(_) => {
- if let Err(e) = webviews[&window_id].resize() {
- eprintln!("{}", e);
- }
- }
- _ => {}
- }
- }
- Event::UserEvent(message) => match message {
- Message::Window(id, window_message) => {
- if let Some(webview) = webviews.get_mut(&id) {
- let window = webview.window();
- match window_message {
- // Getters
- WindowMessage::ScaleFactor(tx) => tx.send(window.scale_factor()).unwrap(),
- WindowMessage::InnerPosition(tx) => tx
- .send(
- window
- .inner_position()
- .map(|p| PhysicalPositionWrapper(p).into())
- .map_err(|_| Error::FailedToSendMessage),
- )
- .unwrap(),
- WindowMessage::OuterPosition(tx) => tx
- .send(
- window
- .outer_position()
- .map(|p| PhysicalPositionWrapper(p).into())
- .map_err(|_| Error::FailedToSendMessage),
- )
- .unwrap(),
- WindowMessage::InnerSize(tx) => tx
- .send(PhysicalSizeWrapper(window.inner_size()).into())
- .unwrap(),
- WindowMessage::OuterSize(tx) => tx
- .send(PhysicalSizeWrapper(window.outer_size()).into())
- .unwrap(),
- WindowMessage::IsFullscreen(tx) => tx.send(window.fullscreen().is_some()).unwrap(),
- WindowMessage::IsMaximized(tx) => tx.send(window.is_maximized()).unwrap(),
- WindowMessage::IsDecorated(tx) => tx.send(window.is_decorated()).unwrap(),
- WindowMessage::IsResizable(tx) => tx.send(window.is_resizable()).unwrap(),
- WindowMessage::CurrentMonitor(tx) => tx.send(window.current_monitor()).unwrap(),
- WindowMessage::PrimaryMonitor(tx) => tx.send(window.primary_monitor()).unwrap(),
- WindowMessage::AvailableMonitors(tx) => {
- tx.send(window.available_monitors().collect()).unwrap()
- }
- #[cfg(windows)]
- WindowMessage::Hwnd(tx) => {
- use wry::application::platform::windows::WindowExtWindows;
- tx.send(Hwnd(window.hwnd())).unwrap()
- }
- // Setters
- WindowMessage::SetResizable(resizable) => window.set_resizable(resizable),
- WindowMessage::SetTitle(title) => window.set_title(&title),
- WindowMessage::Maximize => window.set_maximized(true),
- WindowMessage::Unmaximize => window.set_maximized(false),
- WindowMessage::Minimize => window.set_minimized(true),
- WindowMessage::Unminimize => window.set_minimized(false),
- WindowMessage::Show => window.set_visible(true),
- WindowMessage::Hide => window.set_visible(false),
- WindowMessage::Close => {
- webviews.remove(&id);
- if webviews.is_empty() {
- *control_flow = ControlFlow::Exit;
- }
- }
- WindowMessage::SetDecorations(decorations) => window.set_decorations(decorations),
- WindowMessage::SetAlwaysOnTop(always_on_top) => window.set_always_on_top(always_on_top),
- WindowMessage::SetSize(size) => {
- window.set_inner_size(SizeWrapper::from(size).0);
- }
- WindowMessage::SetMinSize(size) => {
- window.set_min_inner_size(size.map(|s| SizeWrapper::from(s).0));
- }
- WindowMessage::SetMaxSize(size) => {
- window.set_max_inner_size(size.map(|s| SizeWrapper::from(s).0));
- }
- WindowMessage::SetPosition(position) => {
- window.set_outer_position(PositionWrapper::from(position).0)
- }
- WindowMessage::SetFullscreen(fullscreen) => {
- if fullscreen {
- window.set_fullscreen(Some(Fullscreen::Borderless(None)))
- } else {
- window.set_fullscreen(None)
- }
- }
- WindowMessage::SetFocus => {
- window.set_focus();
- }
- WindowMessage::SetIcon(icon) => {
- window.set_window_icon(Some(icon));
- }
- WindowMessage::DragWindow => {
- let _ = window.drag_window();
- }
- }
- }
- }
- Message::Webview(id, webview_message) => {
- if let Some(webview) = webviews.get_mut(&id) {
- match webview_message {
- WebviewMessage::EvaluateScript(script) => {
- let _ = webview.dispatch_script(&script);
- }
- WebviewMessage::Print => {
- let _ = webview.print();
- }
- }
- }
- }
- Message::CreateWebview(handler, sender) => {
- let handler = {
- let mut lock = handler.lock().expect("poisoned create webview handler");
- std::mem::take(&mut *lock).unwrap()
- };
- match handler(event_loop) {
- Ok(webview) => {
- let window_id = webview.window().id();
- webviews.insert(window_id, webview);
- sender.send(window_id).unwrap();
- }
- Err(e) => {
- eprintln!("{}", e);
- }
- }
- }
- },
- _ => (),
- }
- RunIteration {
- webview_count: webviews.len(),
- }
- }
- fn create_webview<P: Params<Runtime = Wry>>(
- event_loop: &EventLoopWindowTarget<Message>,
- context: DispatcherContext,
- pending: PendingWindow<P>,
- ) -> Result<WebView> {
- let PendingWindow {
- webview_attributes,
- window_builder,
- rpc_handler,
- file_drop_handler,
- label,
- url,
- ..
- } = pending;
- let is_window_transparent = window_builder.0.window.transparent;
- let window = window_builder.0.build(event_loop).unwrap();
- let mut webview_builder = WebViewBuilder::new(window)
- .map_err(|e| Error::CreateWebview(Box::new(e)))?
- .with_url(&url)
- .unwrap() // safe to unwrap because we validate the URL beforehand
- .with_transparent(is_window_transparent);
- if let Some(handler) = rpc_handler {
- webview_builder =
- webview_builder.with_rpc_handler(create_rpc_handler(context.clone(), label.clone(), handler));
- }
- if let Some(handler) = file_drop_handler {
- webview_builder =
- webview_builder.with_file_drop_handler(create_file_drop_handler(context, label, handler));
- }
- for (scheme, protocol) in webview_attributes.uri_scheme_protocols {
- webview_builder = webview_builder.with_custom_protocol(scheme, move |_window, url| {
- protocol(url).map_err(|_| wry::Error::InitScriptError)
- });
- }
- if let Some(data_directory) = webview_attributes.data_directory {
- webview_builder = webview_builder.with_data_directory(data_directory);
- }
- for script in webview_attributes.initialization_scripts {
- webview_builder = webview_builder.with_initialization_script(&script);
- }
- webview_builder
- .build()
- .map_err(|e| Error::CreateWebview(Box::new(e)))
- }
- /// Create a wry rpc handler from a tauri rpc handler.
- fn create_rpc_handler<P: Params<Runtime = Wry>>(
- context: DispatcherContext,
- label: P::Label,
- handler: WebviewRpcHandler<P>,
- ) -> Box<dyn Fn(&Window, WryRpcRequest) -> Option<RpcResponse> + 'static> {
- Box::new(move |window, request| {
- handler(
- DetachedWindow {
- dispatcher: WryDispatcher {
- window_id: window.id(),
- context: context.clone(),
- },
- label: label.clone(),
- },
- RpcRequestWrapper(request).into(),
- );
- None
- })
- }
- /// Create a wry file drop handler from a tauri file drop handler.
- fn create_file_drop_handler<P: Params<Runtime = Wry>>(
- context: DispatcherContext,
- label: P::Label,
- handler: FileDropHandler<P>,
- ) -> Box<dyn Fn(&Window, WryFileDropEvent) -> bool + 'static> {
- Box::new(move |window, event| {
- handler(
- FileDropEventWrapper(event).into(),
- DetachedWindow {
- dispatcher: WryDispatcher {
- window_id: window.id(),
- context: context.clone(),
- },
- label: label.clone(),
- },
- )
- })
- }
|