tauri/core/tauri-runtime-wry/src/lib.rs

1322 lines
37 KiB
Rust
Raw Normal View History

feat(license): SPDX Headers (#1449) * chore(licenses): api Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(licenses): scripts Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): cli/core Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): cli/tauri-bundler Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): workflows Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): require license_template in rust Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): core/tauri Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): core/tauri-api Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): core/tauri-build Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): core/tauri-codegen Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): core/tauri-macros Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): core/tauri-updater Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): core/tauri-utils Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): examples Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): cli/tauri.js Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): changefile Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): place both licenses in root Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): package.json SPDX Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): SPDX everywhere Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * fix(tauri.js): tests more time for ubuntu Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): commons conservancy language Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): add spdx file Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * fix(license): clippy Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com> * chore(license): language Signed-off-by: Daniel Thompson-Yvetot <denjell@mailscript.com>
2021-04-11 01:09:09 +03:00
// 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,
};
2021-04-29 01:56:05 +03:00
#[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;
2021-04-29 01:56:05 +03:00
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},
2021-04-29 01:56:05 +03:00
event_loop::{ControlFlow, EventLoop, EventLoopProxy, EventLoopWindowTarget},
monitor::MonitorHandle,
2021-04-29 01:56:05 +03:00
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,
2021-04-29 01:56:05 +03:00
sync::{
mpsc::{channel, Receiver, Sender},
Arc, Mutex, MutexGuard,
2021-04-29 01:56:05 +03:00
},
};
#[cfg(any(feature = "menu", feature = "system-tray"))]
mod menu;
#[cfg(any(feature = "menu", feature = "system-tray"))]
use menu::*;
2021-04-29 01:56:05 +03:00
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>>>;
2021-04-29 01:56:05 +03:00
/// Wrapper around a [`wry::application::window::Icon`] that can be created from an [`Icon`].
pub struct WryIcon(WindowIcon);
2021-02-14 03:35:55 +03:00
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!(),
2021-02-14 03:35:55 +03:00
};
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
),
2021-04-29 01:56:05 +03:00
}
2021-02-14 03:35:55 +03:00
}
}
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())
2021-04-29 01:56:05 +03:00
.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);
2021-04-29 01:56:05 +03:00
if let (Some(min_width), Some(min_height)) = (config.min_width, config.min_height) {
window = window.min_inner_size(min_width, min_height);
}
2021-04-29 01:56:05 +03:00
if let (Some(max_width), Some(max_height)) = (config.max_width, config.max_height) {
window = window.max_inner_size(max_width, max_height);
}
2021-04-29 01:56:05 +03:00
if let (Some(x), Some(y)) = (config.x, config.y) {
window = window.position(x, y);
}
2021-04-29 01:56:05 +03:00
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>>(),
),
)
2021-05-08 18:11:40 +03:00
}
2021-04-29 01:56:05 +03:00
fn position(self, x: f64, y: f64) -> Self {
Self(self.0.with_position(WryLogicalPosition::new(x, y)))
}
2021-04-29 01:56:05 +03:00
fn inner_size(self, width: f64, height: f64) -> Self {
Self(self.0.with_inner_size(WryLogicalSize::new(width, height)))
}
2021-04-29 01:56:05 +03:00
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)),
)
}
2021-04-29 01:56:05 +03:00
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)),
)
}
2021-04-29 01:56:05 +03:00
fn resizable(self, resizable: bool) -> Self {
Self(self.0.with_resizable(resizable))
}
2021-04-29 01:56:05 +03:00
fn title<S: Into<String>>(self, title: S) -> Self {
Self(self.0.with_title(title.into()))
}
2021-04-29 01:56:05 +03:00
fn fullscreen(self, fullscreen: bool) -> Self {
if fullscreen {
Self(self.0.with_fullscreen(Some(Fullscreen::Borderless(None))))
2021-04-29 01:56:05 +03:00
} else {
Self(self.0.with_fullscreen(None))
2021-04-29 01:56:05 +03:00
}
}
2021-04-29 01:56:05 +03:00
fn maximized(self, maximized: bool) -> Self {
Self(self.0.with_maximized(maximized))
}
2021-04-29 01:56:05 +03:00
fn visible(self, visible: bool) -> Self {
Self(self.0.with_visible(visible))
}
2021-04-29 01:56:05 +03:00
fn transparent(self, transparent: bool) -> Self {
Self(self.0.with_transparent(transparent))
}
2021-04-29 01:56:05 +03:00
fn decorations(self, decorations: bool) -> Self {
Self(self.0.with_decorations(decorations))
}
2021-04-29 01:56:05 +03:00
fn always_on_top(self, always_on_top: bool) -> Self {
Self(self.0.with_always_on_top(always_on_top))
}
2021-02-16 20:42:08 +03:00
#[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()
2021-02-16 20:42:08 +03:00
}
2021-05-08 18:11:40 +03:00
#[cfg(feature = "menu")]
2021-05-08 18:11:40 +03:00
fn has_menu(&self) -> bool {
self.0.window.window_menu.is_some()
2021-05-08 18:11:40 +03:00
}
}
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 {
2021-04-29 01:56:05 +03:00
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 {}
2021-04-29 01:56:05 +03:00
#[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>),
CurrentMonitor(Sender<Option<MonitorHandle>>),
PrimaryMonitor(Sender<Option<MonitorHandle>>),
AvailableMonitors(Sender<Vec<MonitorHandle>>),
#[cfg(windows)]
Hwnd(Sender<Hwnd>),
// Setters
2021-04-29 01:56:05 +03:00
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),
2021-04-29 01:56:05 +03:00
SetFullscreen(bool),
SetIcon(WindowIcon),
DragWindow,
}
#[derive(Debug, Clone)]
enum WebviewMessage {
EvaluateScript(String),
Print,
2021-04-29 01:56:05 +03:00
}
#[derive(Clone)]
enum Message {
Window(WindowId, WindowMessage),
Webview(WindowId, WebviewMessage),
CreateWebview(Arc<Mutex<Option<CreateWebviewHandler>>>, Sender<WindowId>),
}
2021-02-16 20:42:08 +03:00
#[derive(Clone)]
2021-05-08 18:11:40 +03:00
struct DispatcherContext {
2021-04-29 01:56:05 +03:00
proxy: EventLoopProxy<Message>,
task_tx: Sender<MainThreadTask>,
window_event_listeners: WindowEventListeners,
#[cfg(feature = "menu")]
2021-05-08 18:11:40 +03:00
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
2021-05-08 18:11:40 +03:00
.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
2021-05-08 18:11:40 +03:00
.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
2021-05-08 18:11:40 +03:00
.context
.window_event_listeners
.lock()
.unwrap()
.insert(id, Box::new(f));
id
}
#[cfg(feature = "menu")]
2021-05-08 18:11:40 +03:00
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 windows current decoration state.
fn is_decorated(&self) -> Result<bool> {
Ok(dispatcher_getter!(self, WindowMessage::IsDecorated))
}
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
2021-05-08 18:11:40 +03:00
.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>> {
2021-04-29 01:56:05 +03:00
let (tx, rx) = channel();
let label = pending.label.clone();
2021-05-08 18:11:40 +03:00
let context = self.context.clone();
2021-04-29 01:56:05 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::CreateWebview(
Arc::new(Mutex::new(Some(Box::new(move |event_loop| {
2021-05-08 18:11:40 +03:00
create_webview(event_loop, context, pending)
2021-04-29 01:56:05 +03:00
})))),
tx,
))
.map_err(|_| Error::FailedToSendMessage)?;
2021-04-29 01:56:05 +03:00
let window_id = rx.recv().unwrap();
let dispatcher = WryDispatcher {
2021-04-29 01:56:05 +03:00
window_id,
2021-05-08 18:11:40 +03:00
context: self.context.clone(),
};
Ok(DetachedWindow { label, dispatcher })
}
fn set_resizable(&self, resizable: bool) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.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
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetTitle(title.into()),
))
.map_err(|_| Error::FailedToSendMessage)
}
fn maximize(&self) -> Result<()> {
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::Maximize))
.map_err(|_| Error::FailedToSendMessage)
}
fn unmaximize(&self) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::Unmaximize))
.map_err(|_| Error::FailedToSendMessage)
}
fn minimize(&self) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::Minimize))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn unminimize(&self) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::Unminimize))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn show(&self) -> Result<()> {
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::Show))
.map_err(|_| Error::FailedToSendMessage)
}
fn hide(&self) -> Result<()> {
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::Hide))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn close(&self) -> Result<()> {
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::Close))
.map_err(|_| Error::FailedToSendMessage)
}
fn set_decorations(&self, decorations: bool) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetDecorations(decorations),
))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn set_always_on_top(&self, always_on_top: bool) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetAlwaysOnTop(always_on_top),
))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn set_size(&self, size: Size) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetSize(size),
2021-04-29 01:56:05 +03:00
))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn set_min_size(&self, size: Option<Size>) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetMinSize(size),
2021-04-29 01:56:05 +03:00
))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn set_max_size(&self, size: Option<Size>) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetMaxSize(size),
2021-04-29 01:56:05 +03:00
))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn set_position(&self, position: Position) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetPosition(position),
2021-04-29 01:56:05 +03:00
))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn set_fullscreen(&self, fullscreen: bool) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetFullscreen(fullscreen),
))
.map_err(|_| Error::FailedToSendMessage)
2021-04-29 01:56:05 +03:00
}
fn set_icon(&self, icon: Icon) -> Result<()> {
2021-04-29 01:56:05 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(
self.window_id,
WindowMessage::SetIcon(WryIcon::try_from(icon)?.0),
))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn start_dragging(&self) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Window(self.window_id, WindowMessage::DragWindow))
.map_err(|_| Error::FailedToSendMessage)
2021-02-16 20:42:08 +03:00
}
fn eval_script<S: Into<String>>(&self, script: S) -> Result<()> {
2021-02-16 20:42:08 +03:00
self
2021-05-08 18:11:40 +03:00
.context
2021-04-29 01:56:05 +03:00
.proxy
.send_event(Message::Webview(
self.window_id,
WebviewMessage::EvaluateScript(script.into()),
))
.map_err(|_| Error::FailedToSendMessage)
}
}
2021-04-29 01:56:05 +03:00
/// A Tauri [`Runtime`] wrapper around wry.
pub struct Wry {
2021-04-29 01:56:05 +03:00
event_loop: EventLoop<Message>,
webviews: Arc<Mutex<HashMap<WindowId, WebView>>>,
task_tx: Sender<MainThreadTask>,
window_event_listeners: WindowEventListeners,
#[cfg(feature = "menu")]
2021-05-08 18:11:40 +03:00
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> {
2021-04-29 01:56:05 +03:00
let event_loop = EventLoop::<Message>::with_user_event();
let (task_tx, task_rx) = channel();
2021-04-29 01:56:05 +03:00
Ok(Self {
event_loop,
webviews: Default::default(),
task_tx,
task_rx: Arc::new(task_rx),
window_event_listeners: Default::default(),
#[cfg(feature = "menu")]
2021-05-08 18:11:40 +03:00
menu_event_listeners: Default::default(),
#[cfg(feature = "system-tray")]
system_tray_event_listeners: Default::default(),
2021-04-29 01:56:05 +03:00
})
}
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>> {
2021-04-29 01:56:05 +03:00
let label = pending.label.clone();
let proxy = self.event_loop.create_proxy();
let webview = create_webview(
&self.event_loop,
2021-05-08 18:11:40 +03:00
DispatcherContext {
proxy: proxy.clone(),
task_tx: self.task_tx.clone(),
window_event_listeners: self.window_event_listeners.clone(),
#[cfg(feature = "menu")]
2021-05-08 18:11:40 +03:00
menu_event_listeners: self.menu_event_listeners.clone(),
},
pending,
)?;
let dispatcher = WryDispatcher {
2021-04-29 01:56:05 +03:00
window_id: webview.window().id(),
2021-05-08 18:11:40 +03:00
context: DispatcherContext {
proxy,
task_tx: self.task_tx.clone(),
window_event_listeners: self.window_event_listeners.clone(),
#[cfg(feature = "menu")]
2021-05-08 18:11:40 +03:00
menu_event_listeners: self.menu_event_listeners.clone(),
},
};
self
.webviews
.lock()
.unwrap()
.insert(webview.window().id(), webview);
2021-04-29 01:56:05 +03:00
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")]
2021-05-08 18:11:40 +03:00
let menu_event_listeners = self.menu_event_listeners.clone();
#[cfg(feature = "system-tray")]
let system_tray_event_listeners = self.system_tray_event_listeners;
2021-04-29 01:56:05 +03:00
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(),
},
);
})
}
}
2021-04-29 01:56:05 +03:00
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,
}
2021-04-29 01:56:05 +03:00
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);
}
}
2021-04-29 01:56:05 +03:00
match event {
WryWindowEvent::CloseRequested => {
webviews.remove(&window_id);
if webviews.is_empty() {
*control_flow = ControlFlow::Exit;
2021-05-08 18:11:40 +03:00
}
}
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::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()
2021-04-29 01:56:05 +03:00
}
#[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;
}
2021-04-29 01:56:05 +03:00
}
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::SetIcon(icon) => {
window.set_window_icon(Some(icon));
}
WindowMessage::DragWindow => {
let _ = window.drag_window();
}
2021-04-29 01:56:05 +03:00
}
}
}
Message::Webview(id, webview_message) => {
if let Some(webview) = webviews.get_mut(&id) {
match webview_message {
WebviewMessage::EvaluateScript(script) => {
let _ = webview.dispatch_script(&script);
2021-04-29 01:56:05 +03:00
}
WebviewMessage::Print => {
let _ = webview.print();
2021-04-29 01:56:05 +03:00
}
}
}
}
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();
2021-04-29 01:56:05 +03:00
}
Err(e) => {
eprintln!("{}", e);
}
}
2021-04-29 01:56:05 +03:00
}
},
_ => (),
}
RunIteration {
webview_count: webviews.len(),
}
}
fn create_webview<P: Params<Runtime = Wry>>(
2021-04-29 01:56:05 +03:00
event_loop: &EventLoopWindowTarget<Message>,
2021-05-08 18:11:40 +03:00
context: DispatcherContext,
pending: PendingWindow<P>,
) -> Result<WebView> {
2021-04-29 01:56:05 +03:00
let PendingWindow {
webview_attributes,
window_builder,
2021-04-29 01:56:05 +03:00
rpc_handler,
file_drop_handler,
label,
url,
..
} = pending;
2021-05-12 16:55:12 +03:00
let is_window_transparent = window_builder.0.window.transparent;
let window = window_builder.0.build(event_loop).unwrap();
2021-04-29 01:56:05 +03:00
let mut webview_builder = WebViewBuilder::new(window)
.map_err(|e| Error::CreateWebview(Box::new(e)))?
2021-04-29 01:56:05 +03:00
.with_url(&url)
2021-05-12 16:55:12 +03:00
.unwrap() // safe to unwrap because we validate the URL beforehand
.with_transparent(is_window_transparent);
2021-04-29 01:56:05 +03:00
if let Some(handler) = rpc_handler {
2021-05-08 18:11:40 +03:00
webview_builder =
webview_builder.with_rpc_handler(create_rpc_handler(context.clone(), label.clone(), handler));
2021-04-29 01:56:05 +03:00
}
if let Some(handler) = file_drop_handler {
2021-05-08 18:11:40 +03:00
webview_builder =
webview_builder.with_file_drop_handler(create_file_drop_handler(context, label, handler));
2021-04-29 01:56:05 +03:00
}
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)))
2021-04-29 01:56:05 +03:00
}
/// Create a wry rpc handler from a tauri rpc handler.
fn create_rpc_handler<P: Params<Runtime = Wry>>(
2021-05-08 18:11:40 +03:00
context: DispatcherContext,
label: P::Label,
handler: WebviewRpcHandler<P>,
2021-04-29 01:56:05 +03:00
) -> Box<dyn Fn(&Window, WryRpcRequest) -> Option<RpcResponse> + 'static> {
Box::new(move |window, request| {
handler(
DetachedWindow {
dispatcher: WryDispatcher {
2021-04-29 01:56:05 +03:00
window_id: window.id(),
2021-05-08 18:11:40 +03:00
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>>(
2021-05-08 18:11:40 +03:00
context: DispatcherContext,
label: P::Label,
handler: FileDropHandler<P>,
2021-04-29 01:56:05 +03:00
) -> Box<dyn Fn(&Window, WryFileDropEvent) -> bool + 'static> {
Box::new(move |window, event| {
handler(
FileDropEventWrapper(event).into(),
DetachedWindow {
dispatcher: WryDispatcher {
2021-04-29 01:56:05 +03:00
window_id: window.id(),
2021-05-08 18:11:40 +03:00
context: context.clone(),
},
label: label.clone(),
},
)
})
}