lib.rs 86 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856
  1. // Copyright 2019-2021 Tauri Programme within The Commons Conservancy
  2. // SPDX-License-Identifier: Apache-2.0
  3. // SPDX-License-Identifier: MIT
  4. //! The [`wry`] Tauri [`Runtime`].
  5. use tauri_runtime::{
  6. http::{
  7. Request as HttpRequest, RequestParts as HttpRequestParts, Response as HttpResponse,
  8. ResponseParts as HttpResponseParts,
  9. },
  10. menu::{AboutMetadata, CustomMenuItem, Menu, MenuEntry, MenuHash, MenuId, MenuItem, MenuUpdate},
  11. monitor::Monitor,
  12. webview::{WebviewIpcHandler, WindowBuilder, WindowBuilderBase},
  13. window::{
  14. dpi::{LogicalPosition, LogicalSize, PhysicalPosition, PhysicalSize, Position, Size},
  15. DetachedWindow, FileDropEvent, JsEventListenerKey, PendingWindow, WindowEvent,
  16. },
  17. ClipboardManager, Dispatch, Error, EventLoopProxy, ExitRequestedEventAction,
  18. GlobalShortcutManager, Result, RunEvent, RunIteration, Runtime, RuntimeHandle, UserAttentionType,
  19. UserEvent, WindowIcon,
  20. };
  21. use tauri_runtime::window::MenuEvent;
  22. #[cfg(feature = "system-tray")]
  23. use tauri_runtime::{SystemTray, SystemTrayEvent};
  24. #[cfg(windows)]
  25. use webview2_com::FocusChangedEventHandler;
  26. #[cfg(windows)]
  27. use windows::Win32::{Foundation::HWND, System::WinRT::EventRegistrationToken};
  28. #[cfg(all(feature = "system-tray", target_os = "macos"))]
  29. use wry::application::platform::macos::{SystemTrayBuilderExtMacOS, SystemTrayExtMacOS};
  30. #[cfg(target_os = "linux")]
  31. use wry::application::platform::unix::{WindowBuilderExtUnix, WindowExtUnix};
  32. #[cfg(windows)]
  33. use wry::application::platform::windows::{WindowBuilderExtWindows, WindowExtWindows};
  34. #[cfg(feature = "system-tray")]
  35. use wry::application::system_tray::{SystemTray as WrySystemTray, SystemTrayBuilder};
  36. use tauri_utils::config::WindowConfig;
  37. use uuid::Uuid;
  38. use wry::{
  39. application::{
  40. accelerator::{Accelerator, AcceleratorId},
  41. clipboard::Clipboard,
  42. dpi::{
  43. LogicalPosition as WryLogicalPosition, LogicalSize as WryLogicalSize,
  44. PhysicalPosition as WryPhysicalPosition, PhysicalSize as WryPhysicalSize,
  45. Position as WryPosition, Size as WrySize,
  46. },
  47. event::{Event, StartCause, WindowEvent as WryWindowEvent},
  48. event_loop::{
  49. ControlFlow, EventLoop, EventLoopProxy as WryEventLoopProxy, EventLoopWindowTarget,
  50. },
  51. global_shortcut::{GlobalShortcut, ShortcutManager as WryShortcutManager},
  52. menu::{
  53. AboutMetadata as WryAboutMetadata, CustomMenuItem as WryCustomMenuItem, MenuBar,
  54. MenuId as WryMenuId, MenuItem as WryMenuItem, MenuItemAttributes as WryMenuItemAttributes,
  55. MenuType,
  56. },
  57. monitor::MonitorHandle,
  58. window::{Fullscreen, Icon as WryWindowIcon, UserAttentionType as WryUserAttentionType},
  59. },
  60. http::{
  61. Request as WryHttpRequest, RequestParts as WryRequestParts, Response as WryHttpResponse,
  62. ResponseParts as WryResponseParts,
  63. },
  64. webview::{FileDropEvent as WryFileDropEvent, WebContext, WebView, WebViewBuilder},
  65. };
  66. pub use wry::application::window::{Window, WindowBuilder as WryWindowBuilder, WindowId};
  67. #[cfg(windows)]
  68. use wry::webview::WebviewExtWindows;
  69. #[cfg(target_os = "macos")]
  70. use tauri_runtime::{menu::NativeImage, ActivationPolicy};
  71. #[cfg(target_os = "macos")]
  72. pub use wry::application::platform::macos::{
  73. ActivationPolicy as WryActivationPolicy, CustomMenuItemExtMacOS, EventLoopExtMacOS,
  74. NativeImage as WryNativeImage, WindowExtMacOS,
  75. };
  76. use std::{
  77. collections::{
  78. hash_map::Entry::{Occupied, Vacant},
  79. HashMap, HashSet,
  80. },
  81. fmt,
  82. ops::Deref,
  83. path::PathBuf,
  84. sync::{
  85. mpsc::{channel, Sender},
  86. Arc, Mutex, MutexGuard, Weak,
  87. },
  88. thread::{current as current_thread, ThreadId},
  89. };
  90. type WebviewId = u64;
  91. #[cfg(feature = "system-tray")]
  92. mod system_tray;
  93. #[cfg(feature = "system-tray")]
  94. use system_tray::*;
  95. type WebContextStore = Arc<Mutex<HashMap<Option<PathBuf>, WebContext>>>;
  96. // window
  97. type WindowEventHandler = Box<dyn Fn(&WindowEvent) + Send>;
  98. type WindowEventListenersMap = Arc<Mutex<HashMap<Uuid, WindowEventHandler>>>;
  99. type WindowEventListeners = Arc<Mutex<HashMap<WebviewId, WindowEventListenersMap>>>;
  100. // global shortcut
  101. type GlobalShortcutListeners = Arc<Mutex<HashMap<AcceleratorId, Box<dyn Fn() + Send>>>>;
  102. // menu
  103. pub type MenuEventHandler = Box<dyn Fn(&MenuEvent) + Send>;
  104. pub type MenuEventListeners = Arc<Mutex<HashMap<WebviewId, WindowMenuEventListeners>>>;
  105. pub type WindowMenuEventListeners = Arc<Mutex<HashMap<Uuid, MenuEventHandler>>>;
  106. #[derive(Debug, Clone, Default)]
  107. struct WebviewIdStore(Arc<Mutex<HashMap<WindowId, WebviewId>>>);
  108. impl WebviewIdStore {
  109. fn insert(&self, w: WindowId, id: WebviewId) {
  110. self.0.lock().unwrap().insert(w, id);
  111. }
  112. fn get(&self, w: &WindowId) -> WebviewId {
  113. *self.0.lock().unwrap().get(w).unwrap()
  114. }
  115. }
  116. macro_rules! getter {
  117. ($self: ident, $rx: expr, $message: expr) => {{
  118. send_user_message(&$self.context, $message)?;
  119. $rx.recv().map_err(|_| Error::FailedToReceiveMessage)
  120. }};
  121. }
  122. macro_rules! window_getter {
  123. ($self: ident, $message: expr) => {{
  124. let (tx, rx) = channel();
  125. getter!($self, rx, Message::Window($self.window_id, $message(tx)))
  126. }};
  127. }
  128. fn send_user_message<T: UserEvent>(context: &Context<T>, message: Message<T>) -> Result<()> {
  129. if current_thread().id() == context.main_thread_id {
  130. handle_user_message(
  131. &context.main_thread.window_target,
  132. message,
  133. UserMessageContext {
  134. window_event_listeners: &context.window_event_listeners,
  135. global_shortcut_manager: context.main_thread.global_shortcut_manager.clone(),
  136. clipboard_manager: context.main_thread.clipboard_manager.clone(),
  137. menu_event_listeners: &context.menu_event_listeners,
  138. windows: context.main_thread.windows.clone(),
  139. #[cfg(feature = "system-tray")]
  140. tray_context: &context.main_thread.tray_context,
  141. },
  142. &context.main_thread.web_context,
  143. );
  144. Ok(())
  145. } else {
  146. context
  147. .proxy
  148. .send_event(message)
  149. .map_err(|_| Error::FailedToSendMessage)
  150. }
  151. }
  152. #[derive(Clone)]
  153. struct Context<T: UserEvent> {
  154. webview_id_map: WebviewIdStore,
  155. main_thread_id: ThreadId,
  156. proxy: WryEventLoopProxy<Message<T>>,
  157. window_event_listeners: WindowEventListeners,
  158. menu_event_listeners: MenuEventListeners,
  159. main_thread: DispatcherMainThreadContext<T>,
  160. }
  161. impl<T: UserEvent> Context<T> {
  162. fn prepare_window(&self, window_id: WebviewId) {
  163. self
  164. .window_event_listeners
  165. .lock()
  166. .unwrap()
  167. .insert(window_id, WindowEventListenersMap::default());
  168. self
  169. .menu_event_listeners
  170. .lock()
  171. .unwrap()
  172. .insert(window_id, WindowMenuEventListeners::default());
  173. }
  174. fn create_webview(&self, pending: PendingWindow<T, Wry<T>>) -> Result<DetachedWindow<T, Wry<T>>> {
  175. let label = pending.label.clone();
  176. let menu_ids = pending.menu_ids.clone();
  177. let js_event_listeners = pending.js_event_listeners.clone();
  178. let context = self.clone();
  179. let window_id = rand::random();
  180. self.prepare_window(window_id);
  181. self
  182. .proxy
  183. .send_event(Message::CreateWebview(
  184. window_id,
  185. Box::new(move |event_loop, web_context| {
  186. create_webview(window_id, event_loop, web_context, context, pending)
  187. }),
  188. ))
  189. .map_err(|_| Error::FailedToSendMessage)?;
  190. let dispatcher = WryDispatcher {
  191. window_id,
  192. context: self.clone(),
  193. };
  194. Ok(DetachedWindow {
  195. label,
  196. dispatcher,
  197. menu_ids,
  198. js_event_listeners,
  199. })
  200. }
  201. }
  202. #[derive(Debug, Clone)]
  203. struct DispatcherMainThreadContext<T: UserEvent> {
  204. window_target: EventLoopWindowTarget<Message<T>>,
  205. web_context: WebContextStore,
  206. global_shortcut_manager: Arc<Mutex<WryShortcutManager>>,
  207. clipboard_manager: Arc<Mutex<Clipboard>>,
  208. windows: Arc<Mutex<HashMap<WebviewId, WindowWrapper>>>,
  209. #[cfg(feature = "system-tray")]
  210. tray_context: TrayContext,
  211. }
  212. // SAFETY: we ensure this type is only used on the main thread.
  213. #[allow(clippy::non_send_fields_in_send_ty)]
  214. unsafe impl<T: UserEvent> Send for DispatcherMainThreadContext<T> {}
  215. impl<T: UserEvent> fmt::Debug for Context<T> {
  216. fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  217. f.debug_struct("Context")
  218. .field("main_thread_id", &self.main_thread_id)
  219. .field("proxy", &self.proxy)
  220. .field("main_thread", &self.main_thread)
  221. .finish()
  222. }
  223. }
  224. struct HttpRequestPartsWrapper(HttpRequestParts);
  225. impl From<HttpRequestPartsWrapper> for HttpRequestParts {
  226. fn from(parts: HttpRequestPartsWrapper) -> Self {
  227. Self {
  228. method: parts.0.method,
  229. uri: parts.0.uri,
  230. headers: parts.0.headers,
  231. }
  232. }
  233. }
  234. impl From<HttpRequestParts> for HttpRequestPartsWrapper {
  235. fn from(request: HttpRequestParts) -> Self {
  236. Self(HttpRequestParts {
  237. method: request.method,
  238. uri: request.uri,
  239. headers: request.headers,
  240. })
  241. }
  242. }
  243. impl From<WryRequestParts> for HttpRequestPartsWrapper {
  244. fn from(request: WryRequestParts) -> Self {
  245. Self(HttpRequestParts {
  246. method: request.method,
  247. uri: request.uri,
  248. headers: request.headers,
  249. })
  250. }
  251. }
  252. struct HttpRequestWrapper(HttpRequest);
  253. impl From<&WryHttpRequest> for HttpRequestWrapper {
  254. fn from(req: &WryHttpRequest) -> Self {
  255. Self(HttpRequest::new_internal(
  256. HttpRequestPartsWrapper::from(req.head.clone()).0,
  257. req.body.clone(),
  258. ))
  259. }
  260. }
  261. // response
  262. struct HttpResponsePartsWrapper(WryResponseParts);
  263. impl From<HttpResponseParts> for HttpResponsePartsWrapper {
  264. fn from(response: HttpResponseParts) -> Self {
  265. Self(WryResponseParts {
  266. mimetype: response.mimetype,
  267. status: response.status,
  268. version: response.version,
  269. headers: response.headers,
  270. })
  271. }
  272. }
  273. struct HttpResponseWrapper(WryHttpResponse);
  274. impl From<HttpResponse> for HttpResponseWrapper {
  275. fn from(response: HttpResponse) -> Self {
  276. let (parts, body) = response.into_parts();
  277. Self(WryHttpResponse {
  278. body,
  279. head: HttpResponsePartsWrapper::from(parts).0,
  280. })
  281. }
  282. }
  283. pub struct MenuItemAttributesWrapper<'a>(pub WryMenuItemAttributes<'a>);
  284. impl<'a> From<&'a CustomMenuItem> for MenuItemAttributesWrapper<'a> {
  285. fn from(item: &'a CustomMenuItem) -> Self {
  286. let mut attributes = WryMenuItemAttributes::new(&item.title)
  287. .with_enabled(item.enabled)
  288. .with_selected(item.selected)
  289. .with_id(WryMenuId(item.id));
  290. if let Some(accelerator) = item.keyboard_accelerator.as_ref() {
  291. attributes = attributes.with_accelerators(&accelerator.parse().expect("invalid accelerator"));
  292. }
  293. Self(attributes)
  294. }
  295. }
  296. pub struct AboutMetadataWrapper(pub WryAboutMetadata);
  297. impl From<AboutMetadata> for AboutMetadataWrapper {
  298. fn from(metadata: AboutMetadata) -> Self {
  299. Self(WryAboutMetadata {
  300. version: metadata.version,
  301. authors: metadata.authors,
  302. comments: metadata.comments,
  303. copyright: metadata.copyright,
  304. license: metadata.license,
  305. website: metadata.website,
  306. website_label: metadata.website_label,
  307. })
  308. }
  309. }
  310. pub struct MenuItemWrapper(pub WryMenuItem);
  311. impl From<MenuItem> for MenuItemWrapper {
  312. fn from(item: MenuItem) -> Self {
  313. match item {
  314. MenuItem::About(name, metadata) => Self(WryMenuItem::About(
  315. name,
  316. AboutMetadataWrapper::from(metadata).0,
  317. )),
  318. MenuItem::Hide => Self(WryMenuItem::Hide),
  319. MenuItem::Services => Self(WryMenuItem::Services),
  320. MenuItem::HideOthers => Self(WryMenuItem::HideOthers),
  321. MenuItem::ShowAll => Self(WryMenuItem::ShowAll),
  322. MenuItem::CloseWindow => Self(WryMenuItem::CloseWindow),
  323. MenuItem::Quit => Self(WryMenuItem::Quit),
  324. MenuItem::Copy => Self(WryMenuItem::Copy),
  325. MenuItem::Cut => Self(WryMenuItem::Cut),
  326. MenuItem::Undo => Self(WryMenuItem::Undo),
  327. MenuItem::Redo => Self(WryMenuItem::Redo),
  328. MenuItem::SelectAll => Self(WryMenuItem::SelectAll),
  329. MenuItem::Paste => Self(WryMenuItem::Paste),
  330. MenuItem::EnterFullScreen => Self(WryMenuItem::EnterFullScreen),
  331. MenuItem::Minimize => Self(WryMenuItem::Minimize),
  332. MenuItem::Zoom => Self(WryMenuItem::Zoom),
  333. MenuItem::Separator => Self(WryMenuItem::Separator),
  334. _ => unimplemented!(),
  335. }
  336. }
  337. }
  338. #[cfg(target_os = "macos")]
  339. pub struct NativeImageWrapper(pub WryNativeImage);
  340. #[cfg(target_os = "macos")]
  341. impl std::fmt::Debug for NativeImageWrapper {
  342. fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
  343. f.debug_struct("NativeImageWrapper").finish()
  344. }
  345. }
  346. #[cfg(target_os = "macos")]
  347. impl From<NativeImage> for NativeImageWrapper {
  348. fn from(image: NativeImage) -> NativeImageWrapper {
  349. let wry_image = match image {
  350. NativeImage::Add => WryNativeImage::Add,
  351. NativeImage::Advanced => WryNativeImage::Advanced,
  352. NativeImage::Bluetooth => WryNativeImage::Bluetooth,
  353. NativeImage::Bookmarks => WryNativeImage::Bookmarks,
  354. NativeImage::Caution => WryNativeImage::Caution,
  355. NativeImage::ColorPanel => WryNativeImage::ColorPanel,
  356. NativeImage::ColumnView => WryNativeImage::ColumnView,
  357. NativeImage::Computer => WryNativeImage::Computer,
  358. NativeImage::EnterFullScreen => WryNativeImage::EnterFullScreen,
  359. NativeImage::Everyone => WryNativeImage::Everyone,
  360. NativeImage::ExitFullScreen => WryNativeImage::ExitFullScreen,
  361. NativeImage::FlowView => WryNativeImage::FlowView,
  362. NativeImage::Folder => WryNativeImage::Folder,
  363. NativeImage::FolderBurnable => WryNativeImage::FolderBurnable,
  364. NativeImage::FolderSmart => WryNativeImage::FolderSmart,
  365. NativeImage::FollowLinkFreestanding => WryNativeImage::FollowLinkFreestanding,
  366. NativeImage::FontPanel => WryNativeImage::FontPanel,
  367. NativeImage::GoLeft => WryNativeImage::GoLeft,
  368. NativeImage::GoRight => WryNativeImage::GoRight,
  369. NativeImage::Home => WryNativeImage::Home,
  370. NativeImage::IChatTheater => WryNativeImage::IChatTheater,
  371. NativeImage::IconView => WryNativeImage::IconView,
  372. NativeImage::Info => WryNativeImage::Info,
  373. NativeImage::InvalidDataFreestanding => WryNativeImage::InvalidDataFreestanding,
  374. NativeImage::LeftFacingTriangle => WryNativeImage::LeftFacingTriangle,
  375. NativeImage::ListView => WryNativeImage::ListView,
  376. NativeImage::LockLocked => WryNativeImage::LockLocked,
  377. NativeImage::LockUnlocked => WryNativeImage::LockUnlocked,
  378. NativeImage::MenuMixedState => WryNativeImage::MenuMixedState,
  379. NativeImage::MenuOnState => WryNativeImage::MenuOnState,
  380. NativeImage::MobileMe => WryNativeImage::MobileMe,
  381. NativeImage::MultipleDocuments => WryNativeImage::MultipleDocuments,
  382. NativeImage::Network => WryNativeImage::Network,
  383. NativeImage::Path => WryNativeImage::Path,
  384. NativeImage::PreferencesGeneral => WryNativeImage::PreferencesGeneral,
  385. NativeImage::QuickLook => WryNativeImage::QuickLook,
  386. NativeImage::RefreshFreestanding => WryNativeImage::RefreshFreestanding,
  387. NativeImage::Refresh => WryNativeImage::Refresh,
  388. NativeImage::Remove => WryNativeImage::Remove,
  389. NativeImage::RevealFreestanding => WryNativeImage::RevealFreestanding,
  390. NativeImage::RightFacingTriangle => WryNativeImage::RightFacingTriangle,
  391. NativeImage::Share => WryNativeImage::Share,
  392. NativeImage::Slideshow => WryNativeImage::Slideshow,
  393. NativeImage::SmartBadge => WryNativeImage::SmartBadge,
  394. NativeImage::StatusAvailable => WryNativeImage::StatusAvailable,
  395. NativeImage::StatusNone => WryNativeImage::StatusNone,
  396. NativeImage::StatusPartiallyAvailable => WryNativeImage::StatusPartiallyAvailable,
  397. NativeImage::StatusUnavailable => WryNativeImage::StatusUnavailable,
  398. NativeImage::StopProgressFreestanding => WryNativeImage::StopProgressFreestanding,
  399. NativeImage::StopProgress => WryNativeImage::StopProgress,
  400. NativeImage::TrashEmpty => WryNativeImage::TrashEmpty,
  401. NativeImage::TrashFull => WryNativeImage::TrashFull,
  402. NativeImage::User => WryNativeImage::User,
  403. NativeImage::UserAccounts => WryNativeImage::UserAccounts,
  404. NativeImage::UserGroup => WryNativeImage::UserGroup,
  405. NativeImage::UserGuest => WryNativeImage::UserGuest,
  406. };
  407. Self(wry_image)
  408. }
  409. }
  410. #[derive(Debug, Clone)]
  411. pub struct GlobalShortcutWrapper(GlobalShortcut);
  412. // SAFETY: usage outside of main thread is guarded, we use the event loop on such cases.
  413. #[allow(clippy::non_send_fields_in_send_ty)]
  414. unsafe impl Send for GlobalShortcutWrapper {}
  415. /// Wrapper around [`WryShortcutManager`].
  416. #[derive(Clone)]
  417. pub struct GlobalShortcutManagerHandle<T: UserEvent> {
  418. context: Context<T>,
  419. shortcuts: Arc<Mutex<HashMap<String, (AcceleratorId, GlobalShortcutWrapper)>>>,
  420. listeners: GlobalShortcutListeners,
  421. }
  422. // SAFETY: this is safe since the `Context` usage is guarded on `send_user_message`.
  423. #[allow(clippy::non_send_fields_in_send_ty)]
  424. unsafe impl<T: UserEvent> Sync for GlobalShortcutManagerHandle<T> {}
  425. impl<T: UserEvent> fmt::Debug for GlobalShortcutManagerHandle<T> {
  426. fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  427. f.debug_struct("GlobalShortcutManagerHandle")
  428. .field("context", &self.context)
  429. .field("shortcuts", &self.shortcuts)
  430. .finish()
  431. }
  432. }
  433. impl<T: UserEvent> GlobalShortcutManager for GlobalShortcutManagerHandle<T> {
  434. fn is_registered(&self, accelerator: &str) -> Result<bool> {
  435. let (tx, rx) = channel();
  436. getter!(
  437. self,
  438. rx,
  439. Message::GlobalShortcut(GlobalShortcutMessage::IsRegistered(
  440. accelerator.parse().expect("invalid accelerator"),
  441. tx
  442. ))
  443. )
  444. }
  445. fn register<F: Fn() + Send + 'static>(&mut self, accelerator: &str, handler: F) -> Result<()> {
  446. let wry_accelerator: Accelerator = accelerator.parse().expect("invalid accelerator");
  447. let id = wry_accelerator.clone().id();
  448. let (tx, rx) = channel();
  449. let shortcut = getter!(
  450. self,
  451. rx,
  452. Message::GlobalShortcut(GlobalShortcutMessage::Register(wry_accelerator, tx))
  453. )??;
  454. self.listeners.lock().unwrap().insert(id, Box::new(handler));
  455. self
  456. .shortcuts
  457. .lock()
  458. .unwrap()
  459. .insert(accelerator.into(), (id, shortcut));
  460. Ok(())
  461. }
  462. fn unregister_all(&mut self) -> Result<()> {
  463. let (tx, rx) = channel();
  464. getter!(
  465. self,
  466. rx,
  467. Message::GlobalShortcut(GlobalShortcutMessage::UnregisterAll(tx))
  468. )??;
  469. self.listeners.lock().unwrap().clear();
  470. self.shortcuts.lock().unwrap().clear();
  471. Ok(())
  472. }
  473. fn unregister(&mut self, accelerator: &str) -> Result<()> {
  474. if let Some((accelerator_id, shortcut)) = self.shortcuts.lock().unwrap().remove(accelerator) {
  475. let (tx, rx) = channel();
  476. getter!(
  477. self,
  478. rx,
  479. Message::GlobalShortcut(GlobalShortcutMessage::Unregister(shortcut, tx))
  480. )??;
  481. self.listeners.lock().unwrap().remove(&accelerator_id);
  482. }
  483. Ok(())
  484. }
  485. }
  486. #[derive(Debug, Clone)]
  487. pub struct ClipboardManagerWrapper<T: UserEvent> {
  488. context: Context<T>,
  489. }
  490. // SAFETY: this is safe since the `Context` usage is guarded on `send_user_message`.
  491. #[allow(clippy::non_send_fields_in_send_ty)]
  492. unsafe impl<T: UserEvent> Sync for ClipboardManagerWrapper<T> {}
  493. impl<T: UserEvent> ClipboardManager for ClipboardManagerWrapper<T> {
  494. fn read_text(&self) -> Result<Option<String>> {
  495. let (tx, rx) = channel();
  496. getter!(self, rx, Message::Clipboard(ClipboardMessage::ReadText(tx)))
  497. }
  498. fn write_text<V: Into<String>>(&mut self, text: V) -> Result<()> {
  499. let (tx, rx) = channel();
  500. getter!(
  501. self,
  502. rx,
  503. Message::Clipboard(ClipboardMessage::WriteText(text.into(), tx))
  504. )?;
  505. Ok(())
  506. }
  507. }
  508. /// Wrapper around a [`wry::application::window::Icon`] that can be created from an [`WindowIcon`].
  509. pub struct WryIcon(WryWindowIcon);
  510. fn icon_err<E: std::error::Error + Send + Sync + 'static>(e: E) -> Error {
  511. Error::InvalidIcon(Box::new(e))
  512. }
  513. impl TryFrom<WindowIcon> for WryIcon {
  514. type Error = Error;
  515. fn try_from(icon: WindowIcon) -> std::result::Result<Self, Self::Error> {
  516. WryWindowIcon::from_rgba(icon.rgba, icon.width, icon.height)
  517. .map(Self)
  518. .map_err(icon_err)
  519. }
  520. }
  521. struct WindowEventWrapper(Option<WindowEvent>);
  522. impl WindowEventWrapper {
  523. fn parse(webview: &WindowHandle, event: &WryWindowEvent<'_>) -> Self {
  524. match event {
  525. // resized event from tao doesn't include a reliable size on macOS
  526. // because wry replaces the NSView
  527. WryWindowEvent::Resized(_) => Self(Some(WindowEvent::Resized(
  528. PhysicalSizeWrapper(webview.inner_size()).into(),
  529. ))),
  530. e => e.into(),
  531. }
  532. }
  533. }
  534. impl<'a> From<&WryWindowEvent<'a>> for WindowEventWrapper {
  535. fn from(event: &WryWindowEvent<'a>) -> Self {
  536. let event = match event {
  537. WryWindowEvent::Resized(size) => WindowEvent::Resized(PhysicalSizeWrapper(*size).into()),
  538. WryWindowEvent::Moved(position) => {
  539. WindowEvent::Moved(PhysicalPositionWrapper(*position).into())
  540. }
  541. WryWindowEvent::Destroyed => WindowEvent::Destroyed,
  542. WryWindowEvent::ScaleFactorChanged {
  543. scale_factor,
  544. new_inner_size,
  545. } => WindowEvent::ScaleFactorChanged {
  546. scale_factor: *scale_factor,
  547. new_inner_size: PhysicalSizeWrapper(**new_inner_size).into(),
  548. },
  549. #[cfg(any(target_os = "linux", target_os = "macos"))]
  550. WryWindowEvent::Focused(focused) => WindowEvent::Focused(*focused),
  551. _ => return Self(None),
  552. };
  553. Self(Some(event))
  554. }
  555. }
  556. impl From<&WebviewEvent> for WindowEventWrapper {
  557. fn from(event: &WebviewEvent) -> Self {
  558. let event = match event {
  559. WebviewEvent::Focused(focused) => WindowEvent::Focused(*focused),
  560. };
  561. Self(Some(event))
  562. }
  563. }
  564. pub struct MonitorHandleWrapper(MonitorHandle);
  565. impl From<MonitorHandleWrapper> for Monitor {
  566. fn from(monitor: MonitorHandleWrapper) -> Monitor {
  567. Self {
  568. name: monitor.0.name(),
  569. position: PhysicalPositionWrapper(monitor.0.position()).into(),
  570. size: PhysicalSizeWrapper(monitor.0.size()).into(),
  571. scale_factor: monitor.0.scale_factor(),
  572. }
  573. }
  574. }
  575. struct PhysicalPositionWrapper<T>(WryPhysicalPosition<T>);
  576. impl<T> From<PhysicalPositionWrapper<T>> for PhysicalPosition<T> {
  577. fn from(position: PhysicalPositionWrapper<T>) -> Self {
  578. Self {
  579. x: position.0.x,
  580. y: position.0.y,
  581. }
  582. }
  583. }
  584. impl<T> From<PhysicalPosition<T>> for PhysicalPositionWrapper<T> {
  585. fn from(position: PhysicalPosition<T>) -> Self {
  586. Self(WryPhysicalPosition {
  587. x: position.x,
  588. y: position.y,
  589. })
  590. }
  591. }
  592. struct LogicalPositionWrapper<T>(WryLogicalPosition<T>);
  593. impl<T> From<LogicalPosition<T>> for LogicalPositionWrapper<T> {
  594. fn from(position: LogicalPosition<T>) -> Self {
  595. Self(WryLogicalPosition {
  596. x: position.x,
  597. y: position.y,
  598. })
  599. }
  600. }
  601. struct PhysicalSizeWrapper<T>(WryPhysicalSize<T>);
  602. impl<T> From<PhysicalSizeWrapper<T>> for PhysicalSize<T> {
  603. fn from(size: PhysicalSizeWrapper<T>) -> Self {
  604. Self {
  605. width: size.0.width,
  606. height: size.0.height,
  607. }
  608. }
  609. }
  610. impl<T> From<PhysicalSize<T>> for PhysicalSizeWrapper<T> {
  611. fn from(size: PhysicalSize<T>) -> Self {
  612. Self(WryPhysicalSize {
  613. width: size.width,
  614. height: size.height,
  615. })
  616. }
  617. }
  618. struct LogicalSizeWrapper<T>(WryLogicalSize<T>);
  619. impl<T> From<LogicalSize<T>> for LogicalSizeWrapper<T> {
  620. fn from(size: LogicalSize<T>) -> Self {
  621. Self(WryLogicalSize {
  622. width: size.width,
  623. height: size.height,
  624. })
  625. }
  626. }
  627. struct SizeWrapper(WrySize);
  628. impl From<Size> for SizeWrapper {
  629. fn from(size: Size) -> Self {
  630. match size {
  631. Size::Logical(s) => Self(WrySize::Logical(LogicalSizeWrapper::from(s).0)),
  632. Size::Physical(s) => Self(WrySize::Physical(PhysicalSizeWrapper::from(s).0)),
  633. }
  634. }
  635. }
  636. struct PositionWrapper(WryPosition);
  637. impl From<Position> for PositionWrapper {
  638. fn from(position: Position) -> Self {
  639. match position {
  640. Position::Logical(s) => Self(WryPosition::Logical(LogicalPositionWrapper::from(s).0)),
  641. Position::Physical(s) => Self(WryPosition::Physical(PhysicalPositionWrapper::from(s).0)),
  642. }
  643. }
  644. }
  645. #[derive(Debug, Clone)]
  646. pub struct UserAttentionTypeWrapper(WryUserAttentionType);
  647. impl From<UserAttentionType> for UserAttentionTypeWrapper {
  648. fn from(request_type: UserAttentionType) -> UserAttentionTypeWrapper {
  649. let o = match request_type {
  650. UserAttentionType::Critical => WryUserAttentionType::Critical,
  651. UserAttentionType::Informational => WryUserAttentionType::Informational,
  652. };
  653. Self(o)
  654. }
  655. }
  656. #[derive(Debug, Clone, Default)]
  657. pub struct WindowBuilderWrapper {
  658. inner: WryWindowBuilder,
  659. center: bool,
  660. menu: Option<Menu>,
  661. }
  662. // SAFETY: this type is `Send` since `menu_items` are read only here
  663. #[allow(clippy::non_send_fields_in_send_ty)]
  664. unsafe impl Send for WindowBuilderWrapper {}
  665. impl WindowBuilderBase for WindowBuilderWrapper {}
  666. impl WindowBuilder for WindowBuilderWrapper {
  667. fn new() -> Self {
  668. Default::default()
  669. }
  670. fn with_config(config: WindowConfig) -> Self {
  671. let mut window = WindowBuilderWrapper::new()
  672. .title(config.title.to_string())
  673. .inner_size(config.width, config.height)
  674. .visible(config.visible)
  675. .resizable(config.resizable)
  676. .fullscreen(config.fullscreen)
  677. .decorations(config.decorations)
  678. .maximized(config.maximized)
  679. .always_on_top(config.always_on_top)
  680. .skip_taskbar(config.skip_taskbar);
  681. #[cfg(any(not(target_os = "macos"), feature = "macos-private-api"))]
  682. {
  683. window = window.transparent(config.transparent);
  684. }
  685. #[cfg(all(
  686. target_os = "macos",
  687. not(feature = "macos-private-api"),
  688. debug_assertions
  689. ))]
  690. if config.transparent {
  691. eprintln!(
  692. "The window is set to be transparent but the `macos-private-api` is not enabled.
  693. This can be enabled via the `tauri.macOSPrivateApi` configuration property <https://tauri.studio/docs/api/config#tauri.macOSPrivateApi>
  694. ");
  695. }
  696. if let (Some(min_width), Some(min_height)) = (config.min_width, config.min_height) {
  697. window = window.min_inner_size(min_width, min_height);
  698. }
  699. if let (Some(max_width), Some(max_height)) = (config.max_width, config.max_height) {
  700. window = window.max_inner_size(max_width, max_height);
  701. }
  702. if let (Some(x), Some(y)) = (config.x, config.y) {
  703. window = window.position(x, y);
  704. }
  705. if config.center {
  706. window = window.center();
  707. }
  708. window
  709. }
  710. fn menu(mut self, menu: Menu) -> Self {
  711. self.menu.replace(menu);
  712. self
  713. }
  714. fn center(mut self) -> Self {
  715. self.center = true;
  716. self
  717. }
  718. fn position(mut self, x: f64, y: f64) -> Self {
  719. self.inner = self.inner.with_position(WryLogicalPosition::new(x, y));
  720. self
  721. }
  722. fn inner_size(mut self, width: f64, height: f64) -> Self {
  723. self.inner = self
  724. .inner
  725. .with_inner_size(WryLogicalSize::new(width, height));
  726. self
  727. }
  728. fn min_inner_size(mut self, min_width: f64, min_height: f64) -> Self {
  729. self.inner = self
  730. .inner
  731. .with_min_inner_size(WryLogicalSize::new(min_width, min_height));
  732. self
  733. }
  734. fn max_inner_size(mut self, max_width: f64, max_height: f64) -> Self {
  735. self.inner = self
  736. .inner
  737. .with_max_inner_size(WryLogicalSize::new(max_width, max_height));
  738. self
  739. }
  740. fn resizable(mut self, resizable: bool) -> Self {
  741. self.inner = self.inner.with_resizable(resizable);
  742. self
  743. }
  744. fn title<S: Into<String>>(mut self, title: S) -> Self {
  745. self.inner = self.inner.with_title(title.into());
  746. self
  747. }
  748. fn fullscreen(mut self, fullscreen: bool) -> Self {
  749. self.inner = if fullscreen {
  750. self
  751. .inner
  752. .with_fullscreen(Some(Fullscreen::Borderless(None)))
  753. } else {
  754. self.inner.with_fullscreen(None)
  755. };
  756. self
  757. }
  758. /// Deprecated since 0.1.4 (noop)
  759. /// Windows is automatically focused when created.
  760. fn focus(self) -> Self {
  761. self
  762. }
  763. fn maximized(mut self, maximized: bool) -> Self {
  764. self.inner = self.inner.with_maximized(maximized);
  765. self
  766. }
  767. fn visible(mut self, visible: bool) -> Self {
  768. self.inner = self.inner.with_visible(visible);
  769. self
  770. }
  771. #[cfg(any(not(target_os = "macos"), feature = "macos-private-api"))]
  772. fn transparent(mut self, transparent: bool) -> Self {
  773. self.inner = self.inner.with_transparent(transparent);
  774. self
  775. }
  776. fn decorations(mut self, decorations: bool) -> Self {
  777. self.inner = self.inner.with_decorations(decorations);
  778. self
  779. }
  780. fn always_on_top(mut self, always_on_top: bool) -> Self {
  781. self.inner = self.inner.with_always_on_top(always_on_top);
  782. self
  783. }
  784. #[cfg(windows)]
  785. fn parent_window(mut self, parent: HWND) -> Self {
  786. self.inner = self.inner.with_parent_window(parent);
  787. self
  788. }
  789. #[cfg(target_os = "macos")]
  790. fn parent_window(mut self, parent: *mut std::ffi::c_void) -> Self {
  791. use wry::application::platform::macos::WindowBuilderExtMacOS;
  792. self.inner = self.inner.with_parent_window(parent);
  793. self
  794. }
  795. #[cfg(windows)]
  796. fn owner_window(mut self, owner: HWND) -> Self {
  797. self.inner = self.inner.with_owner_window(owner);
  798. self
  799. }
  800. fn icon(mut self, icon: WindowIcon) -> Result<Self> {
  801. self.inner = self
  802. .inner
  803. .with_window_icon(Some(WryIcon::try_from(icon)?.0));
  804. Ok(self)
  805. }
  806. #[cfg(any(windows, target_os = "linux"))]
  807. fn skip_taskbar(mut self, skip: bool) -> Self {
  808. self.inner = self.inner.with_skip_taskbar(skip);
  809. self
  810. }
  811. #[cfg(target_os = "macos")]
  812. fn skip_taskbar(self, _skip: bool) -> Self {
  813. self
  814. }
  815. fn has_icon(&self) -> bool {
  816. self.inner.window.window_icon.is_some()
  817. }
  818. fn get_menu(&self) -> Option<&Menu> {
  819. self.menu.as_ref()
  820. }
  821. }
  822. pub struct FileDropEventWrapper(WryFileDropEvent);
  823. impl From<FileDropEventWrapper> for FileDropEvent {
  824. fn from(event: FileDropEventWrapper) -> Self {
  825. match event.0 {
  826. WryFileDropEvent::Hovered(paths) => FileDropEvent::Hovered(paths),
  827. WryFileDropEvent::Dropped(paths) => FileDropEvent::Dropped(paths),
  828. // default to cancelled
  829. // FIXME(maybe): Add `FileDropEvent::Unknown` event?
  830. _ => FileDropEvent::Cancelled,
  831. }
  832. }
  833. }
  834. #[cfg(target_os = "macos")]
  835. pub struct NSWindow(*mut std::ffi::c_void);
  836. #[cfg(target_os = "macos")]
  837. #[allow(clippy::non_send_fields_in_send_ty)]
  838. unsafe impl Send for NSWindow {}
  839. #[cfg(windows)]
  840. pub struct Hwnd(HWND);
  841. #[cfg(windows)]
  842. #[allow(clippy::non_send_fields_in_send_ty)]
  843. unsafe impl Send for Hwnd {}
  844. #[cfg(any(
  845. target_os = "linux",
  846. target_os = "dragonfly",
  847. target_os = "freebsd",
  848. target_os = "netbsd",
  849. target_os = "openbsd"
  850. ))]
  851. pub struct GtkWindow(gtk::ApplicationWindow);
  852. #[cfg(any(
  853. target_os = "linux",
  854. target_os = "dragonfly",
  855. target_os = "freebsd",
  856. target_os = "netbsd",
  857. target_os = "openbsd"
  858. ))]
  859. #[allow(clippy::non_send_fields_in_send_ty)]
  860. unsafe impl Send for GtkWindow {}
  861. #[derive(Debug, Clone)]
  862. pub enum WindowMessage {
  863. #[cfg(any(debug_assertions, feature = "devtools"))]
  864. OpenDevTools,
  865. // Getters
  866. ScaleFactor(Sender<f64>),
  867. InnerPosition(Sender<Result<PhysicalPosition<i32>>>),
  868. OuterPosition(Sender<Result<PhysicalPosition<i32>>>),
  869. InnerSize(Sender<PhysicalSize<u32>>),
  870. OuterSize(Sender<PhysicalSize<u32>>),
  871. IsFullscreen(Sender<bool>),
  872. IsMaximized(Sender<bool>),
  873. IsDecorated(Sender<bool>),
  874. IsResizable(Sender<bool>),
  875. IsVisible(Sender<bool>),
  876. IsMenuVisible(Sender<bool>),
  877. CurrentMonitor(Sender<Option<MonitorHandle>>),
  878. PrimaryMonitor(Sender<Option<MonitorHandle>>),
  879. AvailableMonitors(Sender<Vec<MonitorHandle>>),
  880. #[cfg(target_os = "macos")]
  881. NSWindow(Sender<NSWindow>),
  882. #[cfg(windows)]
  883. Hwnd(Sender<Hwnd>),
  884. #[cfg(any(
  885. target_os = "linux",
  886. target_os = "dragonfly",
  887. target_os = "freebsd",
  888. target_os = "netbsd",
  889. target_os = "openbsd"
  890. ))]
  891. GtkWindow(Sender<GtkWindow>),
  892. // Setters
  893. Center(Sender<Result<()>>),
  894. RequestUserAttention(Option<UserAttentionTypeWrapper>),
  895. SetResizable(bool),
  896. SetTitle(String),
  897. Maximize,
  898. Unmaximize,
  899. Minimize,
  900. Unminimize,
  901. ShowMenu,
  902. HideMenu,
  903. Show,
  904. Hide,
  905. Close,
  906. SetDecorations(bool),
  907. SetAlwaysOnTop(bool),
  908. SetSize(Size),
  909. SetMinSize(Option<Size>),
  910. SetMaxSize(Option<Size>),
  911. SetPosition(Position),
  912. SetFullscreen(bool),
  913. SetFocus,
  914. SetIcon(WryWindowIcon),
  915. SetSkipTaskbar(bool),
  916. DragWindow,
  917. UpdateMenuItem(u16, MenuUpdate),
  918. RequestRedraw,
  919. }
  920. #[derive(Debug, Clone)]
  921. pub enum WebviewMessage {
  922. EvaluateScript(String),
  923. #[allow(dead_code)]
  924. WebviewEvent(WebviewEvent),
  925. Print,
  926. }
  927. #[allow(dead_code)]
  928. #[derive(Debug, Clone)]
  929. pub enum WebviewEvent {
  930. Focused(bool),
  931. }
  932. #[cfg(feature = "system-tray")]
  933. #[derive(Debug, Clone)]
  934. pub enum TrayMessage {
  935. UpdateItem(u16, MenuUpdate),
  936. UpdateMenu(SystemTrayMenu),
  937. UpdateIcon(TrayIcon),
  938. #[cfg(target_os = "macos")]
  939. UpdateIconAsTemplate(bool),
  940. Close,
  941. }
  942. #[derive(Debug, Clone)]
  943. pub enum GlobalShortcutMessage {
  944. IsRegistered(Accelerator, Sender<bool>),
  945. Register(Accelerator, Sender<Result<GlobalShortcutWrapper>>),
  946. Unregister(GlobalShortcutWrapper, Sender<Result<()>>),
  947. UnregisterAll(Sender<Result<()>>),
  948. }
  949. #[derive(Debug, Clone)]
  950. pub enum ClipboardMessage {
  951. WriteText(String, Sender<()>),
  952. ReadText(Sender<Option<String>>),
  953. }
  954. pub type CreateWebviewClosure<T> = Box<
  955. dyn FnOnce(&EventLoopWindowTarget<Message<T>>, &WebContextStore) -> Result<WindowWrapper> + Send,
  956. >;
  957. pub enum Message<T: 'static> {
  958. Task(Box<dyn FnOnce() + Send>),
  959. Window(WebviewId, WindowMessage),
  960. Webview(WebviewId, WebviewMessage),
  961. #[cfg(feature = "system-tray")]
  962. Tray(TrayMessage),
  963. CreateWebview(WebviewId, CreateWebviewClosure<T>),
  964. CreateWindow(
  965. WebviewId,
  966. Box<dyn FnOnce() -> (String, WryWindowBuilder) + Send>,
  967. Sender<Result<Weak<Window>>>,
  968. ),
  969. GlobalShortcut(GlobalShortcutMessage),
  970. Clipboard(ClipboardMessage),
  971. UserEvent(T),
  972. }
  973. impl<T: UserEvent> Clone for Message<T> {
  974. fn clone(&self) -> Self {
  975. match self {
  976. Self::Window(i, m) => Self::Window(*i, m.clone()),
  977. Self::Webview(i, m) => Self::Webview(*i, m.clone()),
  978. #[cfg(feature = "system-tray")]
  979. Self::Tray(m) => Self::Tray(m.clone()),
  980. Self::GlobalShortcut(m) => Self::GlobalShortcut(m.clone()),
  981. Self::Clipboard(m) => Self::Clipboard(m.clone()),
  982. Self::UserEvent(t) => Self::UserEvent(t.clone()),
  983. _ => unimplemented!(),
  984. }
  985. }
  986. }
  987. /// The Tauri [`Dispatch`] for [`Wry`].
  988. #[derive(Debug, Clone)]
  989. pub struct WryDispatcher<T: UserEvent> {
  990. window_id: WebviewId,
  991. context: Context<T>,
  992. }
  993. // SAFETY: this is safe since the `Context` usage is guarded on `send_user_message`.
  994. #[allow(clippy::non_send_fields_in_send_ty)]
  995. unsafe impl<T: UserEvent> Sync for WryDispatcher<T> {}
  996. impl<T: UserEvent> Dispatch<T> for WryDispatcher<T> {
  997. type Runtime = Wry<T>;
  998. type WindowBuilder = WindowBuilderWrapper;
  999. fn run_on_main_thread<F: FnOnce() + Send + 'static>(&self, f: F) -> Result<()> {
  1000. send_user_message(&self.context, Message::Task(Box::new(f)))
  1001. }
  1002. fn on_window_event<F: Fn(&WindowEvent) + Send + 'static>(&self, f: F) -> Uuid {
  1003. let id = Uuid::new_v4();
  1004. self
  1005. .context
  1006. .window_event_listeners
  1007. .lock()
  1008. .unwrap()
  1009. .get(&self.window_id)
  1010. .unwrap()
  1011. .lock()
  1012. .unwrap()
  1013. .insert(id, Box::new(f));
  1014. id
  1015. }
  1016. fn on_menu_event<F: Fn(&MenuEvent) + Send + 'static>(&self, f: F) -> Uuid {
  1017. let id = Uuid::new_v4();
  1018. self
  1019. .context
  1020. .menu_event_listeners
  1021. .lock()
  1022. .unwrap()
  1023. .get(&self.window_id)
  1024. .unwrap()
  1025. .lock()
  1026. .unwrap()
  1027. .insert(id, Box::new(f));
  1028. id
  1029. }
  1030. #[cfg(any(debug_assertions, feature = "devtools"))]
  1031. fn open_devtools(&self) {
  1032. let _ = send_user_message(
  1033. &self.context,
  1034. Message::Window(self.window_id, WindowMessage::OpenDevTools),
  1035. );
  1036. }
  1037. // Getters
  1038. fn scale_factor(&self) -> Result<f64> {
  1039. window_getter!(self, WindowMessage::ScaleFactor)
  1040. }
  1041. fn inner_position(&self) -> Result<PhysicalPosition<i32>> {
  1042. window_getter!(self, WindowMessage::InnerPosition)?
  1043. }
  1044. fn outer_position(&self) -> Result<PhysicalPosition<i32>> {
  1045. window_getter!(self, WindowMessage::OuterPosition)?
  1046. }
  1047. fn inner_size(&self) -> Result<PhysicalSize<u32>> {
  1048. window_getter!(self, WindowMessage::InnerSize)
  1049. }
  1050. fn outer_size(&self) -> Result<PhysicalSize<u32>> {
  1051. window_getter!(self, WindowMessage::OuterSize)
  1052. }
  1053. fn is_fullscreen(&self) -> Result<bool> {
  1054. window_getter!(self, WindowMessage::IsFullscreen)
  1055. }
  1056. fn is_maximized(&self) -> Result<bool> {
  1057. window_getter!(self, WindowMessage::IsMaximized)
  1058. }
  1059. /// Gets the window’s current decoration state.
  1060. fn is_decorated(&self) -> Result<bool> {
  1061. window_getter!(self, WindowMessage::IsDecorated)
  1062. }
  1063. /// Gets the window’s current resizable state.
  1064. fn is_resizable(&self) -> Result<bool> {
  1065. window_getter!(self, WindowMessage::IsResizable)
  1066. }
  1067. fn is_visible(&self) -> Result<bool> {
  1068. window_getter!(self, WindowMessage::IsVisible)
  1069. }
  1070. fn is_menu_visible(&self) -> Result<bool> {
  1071. window_getter!(self, WindowMessage::IsMenuVisible)
  1072. }
  1073. fn current_monitor(&self) -> Result<Option<Monitor>> {
  1074. Ok(window_getter!(self, WindowMessage::CurrentMonitor)?.map(|m| MonitorHandleWrapper(m).into()))
  1075. }
  1076. fn primary_monitor(&self) -> Result<Option<Monitor>> {
  1077. Ok(window_getter!(self, WindowMessage::PrimaryMonitor)?.map(|m| MonitorHandleWrapper(m).into()))
  1078. }
  1079. fn available_monitors(&self) -> Result<Vec<Monitor>> {
  1080. Ok(
  1081. window_getter!(self, WindowMessage::AvailableMonitors)?
  1082. .into_iter()
  1083. .map(|m| MonitorHandleWrapper(m).into())
  1084. .collect(),
  1085. )
  1086. }
  1087. #[cfg(target_os = "macos")]
  1088. fn ns_window(&self) -> Result<*mut std::ffi::c_void> {
  1089. window_getter!(self, WindowMessage::NSWindow).map(|w| w.0)
  1090. }
  1091. #[cfg(windows)]
  1092. fn hwnd(&self) -> Result<HWND> {
  1093. window_getter!(self, WindowMessage::Hwnd).map(|w| w.0)
  1094. }
  1095. /// Returns the `ApplicatonWindow` from gtk crate that is used by this window.
  1096. #[cfg(any(
  1097. target_os = "linux",
  1098. target_os = "dragonfly",
  1099. target_os = "freebsd",
  1100. target_os = "netbsd",
  1101. target_os = "openbsd"
  1102. ))]
  1103. fn gtk_window(&self) -> Result<gtk::ApplicationWindow> {
  1104. window_getter!(self, WindowMessage::GtkWindow).map(|w| w.0)
  1105. }
  1106. // Setters
  1107. fn center(&self) -> Result<()> {
  1108. window_getter!(self, WindowMessage::Center)?
  1109. }
  1110. fn print(&self) -> Result<()> {
  1111. send_user_message(
  1112. &self.context,
  1113. Message::Webview(self.window_id, WebviewMessage::Print),
  1114. )
  1115. }
  1116. fn request_user_attention(&self, request_type: Option<UserAttentionType>) -> Result<()> {
  1117. send_user_message(
  1118. &self.context,
  1119. Message::Window(
  1120. self.window_id,
  1121. WindowMessage::RequestUserAttention(request_type.map(Into::into)),
  1122. ),
  1123. )
  1124. }
  1125. // Creates a window by dispatching a message to the event loop.
  1126. // Note that this must be called from a separate thread, otherwise the channel will introduce a deadlock.
  1127. fn create_window(
  1128. &mut self,
  1129. pending: PendingWindow<T, Self::Runtime>,
  1130. ) -> Result<DetachedWindow<T, Self::Runtime>> {
  1131. self.context.create_webview(pending)
  1132. }
  1133. fn set_resizable(&self, resizable: bool) -> Result<()> {
  1134. send_user_message(
  1135. &self.context,
  1136. Message::Window(self.window_id, WindowMessage::SetResizable(resizable)),
  1137. )
  1138. }
  1139. fn set_title<S: Into<String>>(&self, title: S) -> Result<()> {
  1140. send_user_message(
  1141. &self.context,
  1142. Message::Window(self.window_id, WindowMessage::SetTitle(title.into())),
  1143. )
  1144. }
  1145. fn maximize(&self) -> Result<()> {
  1146. send_user_message(
  1147. &self.context,
  1148. Message::Window(self.window_id, WindowMessage::Maximize),
  1149. )
  1150. }
  1151. fn unmaximize(&self) -> Result<()> {
  1152. send_user_message(
  1153. &self.context,
  1154. Message::Window(self.window_id, WindowMessage::Unmaximize),
  1155. )
  1156. }
  1157. fn minimize(&self) -> Result<()> {
  1158. send_user_message(
  1159. &self.context,
  1160. Message::Window(self.window_id, WindowMessage::Minimize),
  1161. )
  1162. }
  1163. fn unminimize(&self) -> Result<()> {
  1164. send_user_message(
  1165. &self.context,
  1166. Message::Window(self.window_id, WindowMessage::Unminimize),
  1167. )
  1168. }
  1169. fn show_menu(&self) -> Result<()> {
  1170. send_user_message(
  1171. &self.context,
  1172. Message::Window(self.window_id, WindowMessage::ShowMenu),
  1173. )
  1174. }
  1175. fn hide_menu(&self) -> Result<()> {
  1176. send_user_message(
  1177. &self.context,
  1178. Message::Window(self.window_id, WindowMessage::HideMenu),
  1179. )
  1180. }
  1181. fn show(&self) -> Result<()> {
  1182. send_user_message(
  1183. &self.context,
  1184. Message::Window(self.window_id, WindowMessage::Show),
  1185. )
  1186. }
  1187. fn hide(&self) -> Result<()> {
  1188. send_user_message(
  1189. &self.context,
  1190. Message::Window(self.window_id, WindowMessage::Hide),
  1191. )
  1192. }
  1193. fn close(&self) -> Result<()> {
  1194. // NOTE: close cannot use the `send_user_message` function because it accesses the event loop callback
  1195. self
  1196. .context
  1197. .proxy
  1198. .send_event(Message::Window(self.window_id, WindowMessage::Close))
  1199. .map_err(|_| Error::FailedToSendMessage)
  1200. }
  1201. fn set_decorations(&self, decorations: bool) -> Result<()> {
  1202. send_user_message(
  1203. &self.context,
  1204. Message::Window(self.window_id, WindowMessage::SetDecorations(decorations)),
  1205. )
  1206. }
  1207. fn set_always_on_top(&self, always_on_top: bool) -> Result<()> {
  1208. send_user_message(
  1209. &self.context,
  1210. Message::Window(self.window_id, WindowMessage::SetAlwaysOnTop(always_on_top)),
  1211. )
  1212. }
  1213. fn set_size(&self, size: Size) -> Result<()> {
  1214. send_user_message(
  1215. &self.context,
  1216. Message::Window(self.window_id, WindowMessage::SetSize(size)),
  1217. )
  1218. }
  1219. fn set_min_size(&self, size: Option<Size>) -> Result<()> {
  1220. send_user_message(
  1221. &self.context,
  1222. Message::Window(self.window_id, WindowMessage::SetMinSize(size)),
  1223. )
  1224. }
  1225. fn set_max_size(&self, size: Option<Size>) -> Result<()> {
  1226. send_user_message(
  1227. &self.context,
  1228. Message::Window(self.window_id, WindowMessage::SetMaxSize(size)),
  1229. )
  1230. }
  1231. fn set_position(&self, position: Position) -> Result<()> {
  1232. send_user_message(
  1233. &self.context,
  1234. Message::Window(self.window_id, WindowMessage::SetPosition(position)),
  1235. )
  1236. }
  1237. fn set_fullscreen(&self, fullscreen: bool) -> Result<()> {
  1238. send_user_message(
  1239. &self.context,
  1240. Message::Window(self.window_id, WindowMessage::SetFullscreen(fullscreen)),
  1241. )
  1242. }
  1243. fn set_focus(&self) -> Result<()> {
  1244. send_user_message(
  1245. &self.context,
  1246. Message::Window(self.window_id, WindowMessage::SetFocus),
  1247. )
  1248. }
  1249. fn set_icon(&self, icon: WindowIcon) -> Result<()> {
  1250. send_user_message(
  1251. &self.context,
  1252. Message::Window(
  1253. self.window_id,
  1254. WindowMessage::SetIcon(WryIcon::try_from(icon)?.0),
  1255. ),
  1256. )
  1257. }
  1258. fn set_skip_taskbar(&self, skip: bool) -> Result<()> {
  1259. send_user_message(
  1260. &self.context,
  1261. Message::Window(self.window_id, WindowMessage::SetSkipTaskbar(skip)),
  1262. )
  1263. }
  1264. fn start_dragging(&self) -> Result<()> {
  1265. send_user_message(
  1266. &self.context,
  1267. Message::Window(self.window_id, WindowMessage::DragWindow),
  1268. )
  1269. }
  1270. fn eval_script<S: Into<String>>(&self, script: S) -> Result<()> {
  1271. send_user_message(
  1272. &self.context,
  1273. Message::Webview(
  1274. self.window_id,
  1275. WebviewMessage::EvaluateScript(script.into()),
  1276. ),
  1277. )
  1278. }
  1279. fn update_menu_item(&self, id: u16, update: MenuUpdate) -> Result<()> {
  1280. send_user_message(
  1281. &self.context,
  1282. Message::Window(self.window_id, WindowMessage::UpdateMenuItem(id, update)),
  1283. )
  1284. }
  1285. }
  1286. #[cfg(feature = "system-tray")]
  1287. #[derive(Clone, Default)]
  1288. struct TrayContext {
  1289. tray: Arc<Mutex<Option<Arc<Mutex<WrySystemTray>>>>>,
  1290. listeners: SystemTrayEventListeners,
  1291. items: SystemTrayItems,
  1292. }
  1293. #[cfg(feature = "system-tray")]
  1294. impl fmt::Debug for TrayContext {
  1295. fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  1296. f.debug_struct("TrayContext")
  1297. .field("items", &self.items)
  1298. .finish()
  1299. }
  1300. }
  1301. enum WindowHandle {
  1302. Webview(WebView),
  1303. Window(Arc<Window>),
  1304. }
  1305. impl fmt::Debug for WindowHandle {
  1306. fn fmt(&self, _f: &mut fmt::Formatter<'_>) -> fmt::Result {
  1307. Ok(())
  1308. }
  1309. }
  1310. impl WindowHandle {
  1311. fn window(&self) -> &Window {
  1312. match self {
  1313. Self::Webview(w) => w.window(),
  1314. Self::Window(w) => w,
  1315. }
  1316. }
  1317. fn inner_size(&self) -> WryPhysicalSize<u32> {
  1318. match self {
  1319. WindowHandle::Window(w) => w.inner_size(),
  1320. WindowHandle::Webview(w) => w.inner_size(),
  1321. }
  1322. }
  1323. }
  1324. #[derive(Debug)]
  1325. pub struct WindowWrapper {
  1326. label: String,
  1327. inner: WindowHandle,
  1328. menu_items: Option<HashMap<u16, WryCustomMenuItem>>,
  1329. }
  1330. #[derive(Debug, Clone)]
  1331. pub struct EventProxy<T: UserEvent>(WryEventLoopProxy<Message<T>>);
  1332. impl<T: UserEvent> EventLoopProxy<T> for EventProxy<T> {
  1333. fn send_event(&self, event: T) -> Result<()> {
  1334. self
  1335. .0
  1336. .send_event(Message::UserEvent(event))
  1337. .map_err(|_| Error::EventLoopClosed)
  1338. }
  1339. }
  1340. /// A Tauri [`Runtime`] wrapper around wry.
  1341. pub struct Wry<T: UserEvent> {
  1342. main_thread_id: ThreadId,
  1343. global_shortcut_manager: Arc<Mutex<WryShortcutManager>>,
  1344. global_shortcut_manager_handle: GlobalShortcutManagerHandle<T>,
  1345. clipboard_manager: Arc<Mutex<Clipboard>>,
  1346. clipboard_manager_handle: ClipboardManagerWrapper<T>,
  1347. event_loop: EventLoop<Message<T>>,
  1348. windows: Arc<Mutex<HashMap<WebviewId, WindowWrapper>>>,
  1349. webview_id_map: WebviewIdStore,
  1350. web_context: WebContextStore,
  1351. window_event_listeners: WindowEventListeners,
  1352. menu_event_listeners: MenuEventListeners,
  1353. #[cfg(feature = "system-tray")]
  1354. tray_context: TrayContext,
  1355. }
  1356. impl<T: UserEvent> fmt::Debug for Wry<T> {
  1357. fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  1358. let mut d = f.debug_struct("Wry");
  1359. d.field("main_thread_id", &self.main_thread_id)
  1360. .field("global_shortcut_manager", &self.global_shortcut_manager)
  1361. .field(
  1362. "global_shortcut_manager_handle",
  1363. &self.global_shortcut_manager_handle,
  1364. )
  1365. .field("clipboard_manager", &self.clipboard_manager)
  1366. .field("clipboard_manager_handle", &self.clipboard_manager_handle)
  1367. .field("event_loop", &self.event_loop)
  1368. .field("windows", &self.windows)
  1369. .field("web_context", &self.web_context);
  1370. #[cfg(feature = "system-tray")]
  1371. d.field("tray_context", &self.tray_context);
  1372. d.finish()
  1373. }
  1374. }
  1375. /// A handle to the Wry runtime.
  1376. #[derive(Debug, Clone)]
  1377. pub struct WryHandle<T: UserEvent> {
  1378. context: Context<T>,
  1379. }
  1380. // SAFETY: this is safe since the `Context` usage is guarded on `send_user_message`.
  1381. #[allow(clippy::non_send_fields_in_send_ty)]
  1382. unsafe impl<T: UserEvent> Sync for WryHandle<T> {}
  1383. impl<T: UserEvent> WryHandle<T> {
  1384. /// Creates a new tao window using a callback, and returns its window id.
  1385. pub fn create_tao_window<F: FnOnce() -> (String, WryWindowBuilder) + Send + 'static>(
  1386. &self,
  1387. f: F,
  1388. ) -> Result<Weak<Window>> {
  1389. let (tx, rx) = channel();
  1390. send_user_message(
  1391. &self.context,
  1392. Message::CreateWindow(rand::random(), Box::new(f), tx),
  1393. )?;
  1394. rx.recv().unwrap()
  1395. }
  1396. /// Gets the [`WebviewId'] associated with the given [`WindowId`].
  1397. pub fn window_id(&self, window_id: WindowId) -> WebviewId {
  1398. *self
  1399. .context
  1400. .webview_id_map
  1401. .0
  1402. .lock()
  1403. .unwrap()
  1404. .get(&window_id)
  1405. .unwrap()
  1406. }
  1407. /// Send a message to the event loop.
  1408. pub fn send_event(&self, message: Message<T>) -> Result<()> {
  1409. self
  1410. .context
  1411. .proxy
  1412. .send_event(message)
  1413. .map_err(|_| Error::FailedToSendMessage)?;
  1414. Ok(())
  1415. }
  1416. }
  1417. impl<T: UserEvent> RuntimeHandle<T> for WryHandle<T> {
  1418. type Runtime = Wry<T>;
  1419. fn create_proxy(&self) -> EventProxy<T> {
  1420. EventProxy(self.context.proxy.clone())
  1421. }
  1422. // Creates a window by dispatching a message to the event loop.
  1423. // Note that this must be called from a separate thread, otherwise the channel will introduce a deadlock.
  1424. fn create_window(
  1425. &self,
  1426. pending: PendingWindow<T, Self::Runtime>,
  1427. ) -> Result<DetachedWindow<T, Self::Runtime>> {
  1428. self.context.create_webview(pending)
  1429. }
  1430. fn run_on_main_thread<F: FnOnce() + Send + 'static>(&self, f: F) -> Result<()> {
  1431. send_user_message(&self.context, Message::Task(Box::new(f)))
  1432. }
  1433. #[cfg(all(windows, feature = "system-tray"))]
  1434. /// Deprecated. (not needed anymore)
  1435. fn remove_system_tray(&self) -> Result<()> {
  1436. send_user_message(&self.context, Message::Tray(TrayMessage::Close))
  1437. }
  1438. }
  1439. impl<T: UserEvent> Wry<T> {
  1440. fn init(event_loop: EventLoop<Message<T>>) -> Result<Self> {
  1441. let proxy = event_loop.create_proxy();
  1442. let main_thread_id = current_thread().id();
  1443. let web_context = WebContextStore::default();
  1444. let global_shortcut_manager = Arc::new(Mutex::new(WryShortcutManager::new(&event_loop)));
  1445. let clipboard_manager = Arc::new(Mutex::new(Clipboard::new()));
  1446. let windows = Arc::new(Mutex::new(HashMap::default()));
  1447. let webview_id_map = WebviewIdStore::default();
  1448. let window_event_listeners = WindowEventListeners::default();
  1449. let menu_event_listeners = MenuEventListeners::default();
  1450. #[cfg(feature = "system-tray")]
  1451. let tray_context = TrayContext::default();
  1452. let event_loop_context = Context {
  1453. webview_id_map: webview_id_map.clone(),
  1454. main_thread_id,
  1455. proxy,
  1456. window_event_listeners: window_event_listeners.clone(),
  1457. menu_event_listeners: menu_event_listeners.clone(),
  1458. main_thread: DispatcherMainThreadContext {
  1459. window_target: event_loop.deref().clone(),
  1460. web_context: web_context.clone(),
  1461. global_shortcut_manager: global_shortcut_manager.clone(),
  1462. clipboard_manager: clipboard_manager.clone(),
  1463. windows: windows.clone(),
  1464. #[cfg(feature = "system-tray")]
  1465. tray_context: tray_context.clone(),
  1466. },
  1467. };
  1468. let global_shortcut_listeners = GlobalShortcutListeners::default();
  1469. let clipboard_manager_handle = ClipboardManagerWrapper {
  1470. context: event_loop_context.clone(),
  1471. };
  1472. Ok(Self {
  1473. main_thread_id,
  1474. global_shortcut_manager,
  1475. global_shortcut_manager_handle: GlobalShortcutManagerHandle {
  1476. context: event_loop_context,
  1477. shortcuts: Default::default(),
  1478. listeners: global_shortcut_listeners,
  1479. },
  1480. clipboard_manager,
  1481. clipboard_manager_handle,
  1482. event_loop,
  1483. windows,
  1484. webview_id_map,
  1485. web_context,
  1486. window_event_listeners,
  1487. menu_event_listeners,
  1488. #[cfg(feature = "system-tray")]
  1489. tray_context,
  1490. })
  1491. }
  1492. }
  1493. impl<T: UserEvent> Runtime<T> for Wry<T> {
  1494. type Dispatcher = WryDispatcher<T>;
  1495. type Handle = WryHandle<T>;
  1496. type GlobalShortcutManager = GlobalShortcutManagerHandle<T>;
  1497. type ClipboardManager = ClipboardManagerWrapper<T>;
  1498. #[cfg(feature = "system-tray")]
  1499. type TrayHandler = SystemTrayHandle<T>;
  1500. type EventLoopProxy = EventProxy<T>;
  1501. fn new() -> Result<Self> {
  1502. let event_loop = EventLoop::<Message<T>>::with_user_event();
  1503. Self::init(event_loop)
  1504. }
  1505. #[cfg(any(windows, target_os = "linux"))]
  1506. fn new_any_thread() -> Result<Self> {
  1507. #[cfg(target_os = "linux")]
  1508. use wry::application::platform::unix::EventLoopExtUnix;
  1509. #[cfg(windows)]
  1510. use wry::application::platform::windows::EventLoopExtWindows;
  1511. let event_loop = EventLoop::<Message<T>>::new_any_thread();
  1512. Self::init(event_loop)
  1513. }
  1514. fn create_proxy(&self) -> EventProxy<T> {
  1515. EventProxy(self.event_loop.create_proxy())
  1516. }
  1517. fn handle(&self) -> Self::Handle {
  1518. WryHandle {
  1519. context: Context {
  1520. webview_id_map: self.webview_id_map.clone(),
  1521. main_thread_id: self.main_thread_id,
  1522. proxy: self.event_loop.create_proxy(),
  1523. window_event_listeners: self.window_event_listeners.clone(),
  1524. menu_event_listeners: self.menu_event_listeners.clone(),
  1525. main_thread: DispatcherMainThreadContext {
  1526. window_target: self.event_loop.deref().clone(),
  1527. web_context: self.web_context.clone(),
  1528. global_shortcut_manager: self.global_shortcut_manager.clone(),
  1529. clipboard_manager: self.clipboard_manager.clone(),
  1530. windows: self.windows.clone(),
  1531. #[cfg(feature = "system-tray")]
  1532. tray_context: self.tray_context.clone(),
  1533. },
  1534. },
  1535. }
  1536. }
  1537. fn global_shortcut_manager(&self) -> Self::GlobalShortcutManager {
  1538. self.global_shortcut_manager_handle.clone()
  1539. }
  1540. fn clipboard_manager(&self) -> Self::ClipboardManager {
  1541. self.clipboard_manager_handle.clone()
  1542. }
  1543. fn create_window(&self, pending: PendingWindow<T, Self>) -> Result<DetachedWindow<T, Self>> {
  1544. let label = pending.label.clone();
  1545. let menu_ids = pending.menu_ids.clone();
  1546. let js_event_listeners = pending.js_event_listeners.clone();
  1547. let proxy = self.event_loop.create_proxy();
  1548. let window_id = rand::random();
  1549. let context = Context {
  1550. webview_id_map: self.webview_id_map.clone(),
  1551. main_thread_id: self.main_thread_id,
  1552. proxy,
  1553. window_event_listeners: self.window_event_listeners.clone(),
  1554. menu_event_listeners: self.menu_event_listeners.clone(),
  1555. main_thread: DispatcherMainThreadContext {
  1556. window_target: self.event_loop.deref().clone(),
  1557. web_context: self.web_context.clone(),
  1558. global_shortcut_manager: self.global_shortcut_manager.clone(),
  1559. clipboard_manager: self.clipboard_manager.clone(),
  1560. windows: self.windows.clone(),
  1561. #[cfg(feature = "system-tray")]
  1562. tray_context: self.tray_context.clone(),
  1563. },
  1564. };
  1565. context.prepare_window(window_id);
  1566. let webview = create_webview(
  1567. window_id,
  1568. &self.event_loop,
  1569. &self.web_context,
  1570. context.clone(),
  1571. pending,
  1572. )?;
  1573. let dispatcher = WryDispatcher { window_id, context };
  1574. self.windows.lock().unwrap().insert(window_id, webview);
  1575. Ok(DetachedWindow {
  1576. label,
  1577. dispatcher,
  1578. menu_ids,
  1579. js_event_listeners,
  1580. })
  1581. }
  1582. #[cfg(feature = "system-tray")]
  1583. fn system_tray(&self, system_tray: SystemTray) -> Result<Self::TrayHandler> {
  1584. let icon = system_tray
  1585. .icon
  1586. .expect("tray icon not set")
  1587. .into_platform_icon();
  1588. let mut items = HashMap::new();
  1589. #[cfg(target_os = "macos")]
  1590. let tray = SystemTrayBuilder::new(
  1591. icon,
  1592. system_tray
  1593. .menu
  1594. .map(|menu| to_wry_context_menu(&mut items, menu)),
  1595. )
  1596. .with_icon_as_template(system_tray.icon_as_template)
  1597. .build(&self.event_loop)
  1598. .map_err(|e| Error::SystemTray(Box::new(e)))?;
  1599. #[cfg(not(target_os = "macos"))]
  1600. let tray = SystemTrayBuilder::new(
  1601. icon,
  1602. system_tray
  1603. .menu
  1604. .map(|menu| to_wry_context_menu(&mut items, menu)),
  1605. )
  1606. .build(&self.event_loop)
  1607. .map_err(|e| Error::SystemTray(Box::new(e)))?;
  1608. *self.tray_context.items.lock().unwrap() = items;
  1609. *self.tray_context.tray.lock().unwrap() = Some(Arc::new(Mutex::new(tray)));
  1610. Ok(SystemTrayHandle {
  1611. proxy: self.event_loop.create_proxy(),
  1612. })
  1613. }
  1614. #[cfg(feature = "system-tray")]
  1615. fn on_system_tray_event<F: Fn(&SystemTrayEvent) + Send + 'static>(&mut self, f: F) -> Uuid {
  1616. let id = Uuid::new_v4();
  1617. self
  1618. .tray_context
  1619. .listeners
  1620. .lock()
  1621. .unwrap()
  1622. .insert(id, Arc::new(Box::new(f)));
  1623. id
  1624. }
  1625. #[cfg(target_os = "macos")]
  1626. fn set_activation_policy(&mut self, activation_policy: ActivationPolicy) {
  1627. self
  1628. .event_loop
  1629. .set_activation_policy(match activation_policy {
  1630. ActivationPolicy::Regular => WryActivationPolicy::Regular,
  1631. ActivationPolicy::Accessory => WryActivationPolicy::Accessory,
  1632. ActivationPolicy::Prohibited => WryActivationPolicy::Prohibited,
  1633. _ => unimplemented!(),
  1634. });
  1635. }
  1636. fn run_iteration<F: FnMut(RunEvent<T>) + 'static>(&mut self, mut callback: F) -> RunIteration {
  1637. use wry::application::platform::run_return::EventLoopExtRunReturn;
  1638. let windows = self.windows.clone();
  1639. let webview_id_map = self.webview_id_map.clone();
  1640. let web_context = &self.web_context;
  1641. let window_event_listeners = self.window_event_listeners.clone();
  1642. let menu_event_listeners = self.menu_event_listeners.clone();
  1643. #[cfg(feature = "system-tray")]
  1644. let tray_context = self.tray_context.clone();
  1645. let global_shortcut_manager = self.global_shortcut_manager.clone();
  1646. let global_shortcut_manager_handle = self.global_shortcut_manager_handle.clone();
  1647. let clipboard_manager = self.clipboard_manager.clone();
  1648. let mut iteration = RunIteration::default();
  1649. self
  1650. .event_loop
  1651. .run_return(|event, event_loop, control_flow| {
  1652. *control_flow = ControlFlow::Wait;
  1653. if let Event::MainEventsCleared = &event {
  1654. *control_flow = ControlFlow::Exit;
  1655. }
  1656. iteration = handle_event_loop(
  1657. event,
  1658. event_loop,
  1659. control_flow,
  1660. EventLoopIterationContext {
  1661. callback: &mut callback,
  1662. windows: windows.clone(),
  1663. webview_id_map: webview_id_map.clone(),
  1664. window_event_listeners: &window_event_listeners,
  1665. global_shortcut_manager: global_shortcut_manager.clone(),
  1666. global_shortcut_manager_handle: &global_shortcut_manager_handle,
  1667. clipboard_manager: clipboard_manager.clone(),
  1668. menu_event_listeners: &menu_event_listeners,
  1669. #[cfg(feature = "system-tray")]
  1670. tray_context: &tray_context,
  1671. },
  1672. web_context,
  1673. );
  1674. });
  1675. iteration
  1676. }
  1677. fn run<F: FnMut(RunEvent<T>) + 'static>(self, mut callback: F) {
  1678. let windows = self.windows.clone();
  1679. let webview_id_map = self.webview_id_map.clone();
  1680. let web_context = self.web_context;
  1681. let window_event_listeners = self.window_event_listeners.clone();
  1682. let menu_event_listeners = self.menu_event_listeners.clone();
  1683. #[cfg(feature = "system-tray")]
  1684. let tray_context = self.tray_context;
  1685. let global_shortcut_manager = self.global_shortcut_manager.clone();
  1686. let global_shortcut_manager_handle = self.global_shortcut_manager_handle.clone();
  1687. let clipboard_manager = self.clipboard_manager.clone();
  1688. self.event_loop.run(move |event, event_loop, control_flow| {
  1689. handle_event_loop(
  1690. event,
  1691. event_loop,
  1692. control_flow,
  1693. EventLoopIterationContext {
  1694. callback: &mut callback,
  1695. webview_id_map: webview_id_map.clone(),
  1696. windows: windows.clone(),
  1697. window_event_listeners: &window_event_listeners,
  1698. global_shortcut_manager: global_shortcut_manager.clone(),
  1699. global_shortcut_manager_handle: &global_shortcut_manager_handle,
  1700. clipboard_manager: clipboard_manager.clone(),
  1701. menu_event_listeners: &menu_event_listeners,
  1702. #[cfg(feature = "system-tray")]
  1703. tray_context: &tray_context,
  1704. },
  1705. &web_context,
  1706. );
  1707. })
  1708. }
  1709. }
  1710. pub struct EventLoopIterationContext<'a, T: UserEvent> {
  1711. callback: &'a mut (dyn FnMut(RunEvent<T>) + 'static),
  1712. webview_id_map: WebviewIdStore,
  1713. windows: Arc<Mutex<HashMap<WebviewId, WindowWrapper>>>,
  1714. window_event_listeners: &'a WindowEventListeners,
  1715. global_shortcut_manager: Arc<Mutex<WryShortcutManager>>,
  1716. global_shortcut_manager_handle: &'a GlobalShortcutManagerHandle<T>,
  1717. clipboard_manager: Arc<Mutex<Clipboard>>,
  1718. menu_event_listeners: &'a MenuEventListeners,
  1719. #[cfg(feature = "system-tray")]
  1720. tray_context: &'a TrayContext,
  1721. }
  1722. struct UserMessageContext<'a> {
  1723. window_event_listeners: &'a WindowEventListeners,
  1724. global_shortcut_manager: Arc<Mutex<WryShortcutManager>>,
  1725. clipboard_manager: Arc<Mutex<Clipboard>>,
  1726. menu_event_listeners: &'a MenuEventListeners,
  1727. windows: Arc<Mutex<HashMap<WebviewId, WindowWrapper>>>,
  1728. #[cfg(feature = "system-tray")]
  1729. tray_context: &'a TrayContext,
  1730. }
  1731. fn handle_user_message<T: UserEvent>(
  1732. event_loop: &EventLoopWindowTarget<Message<T>>,
  1733. message: Message<T>,
  1734. context: UserMessageContext<'_>,
  1735. web_context: &WebContextStore,
  1736. ) -> RunIteration {
  1737. let UserMessageContext {
  1738. window_event_listeners,
  1739. menu_event_listeners,
  1740. global_shortcut_manager,
  1741. clipboard_manager,
  1742. windows,
  1743. #[cfg(feature = "system-tray")]
  1744. tray_context,
  1745. } = context;
  1746. match message {
  1747. Message::Task(task) => task(),
  1748. Message::Window(id, window_message) => {
  1749. if let Some(webview) = windows
  1750. .lock()
  1751. .expect("poisoned webview collection")
  1752. .get_mut(&id)
  1753. {
  1754. let window = webview.inner.window();
  1755. match window_message {
  1756. #[cfg(any(debug_assertions, feature = "devtools"))]
  1757. WindowMessage::OpenDevTools => {
  1758. if let WindowHandle::Webview(w) = &webview.inner {
  1759. w.open_devtools();
  1760. }
  1761. }
  1762. // Getters
  1763. WindowMessage::ScaleFactor(tx) => tx.send(window.scale_factor()).unwrap(),
  1764. WindowMessage::InnerPosition(tx) => tx
  1765. .send(
  1766. window
  1767. .inner_position()
  1768. .map(|p| PhysicalPositionWrapper(p).into())
  1769. .map_err(|_| Error::FailedToSendMessage),
  1770. )
  1771. .unwrap(),
  1772. WindowMessage::OuterPosition(tx) => tx
  1773. .send(
  1774. window
  1775. .outer_position()
  1776. .map(|p| PhysicalPositionWrapper(p).into())
  1777. .map_err(|_| Error::FailedToSendMessage),
  1778. )
  1779. .unwrap(),
  1780. WindowMessage::InnerSize(tx) => tx
  1781. .send(PhysicalSizeWrapper(webview.inner.inner_size()).into())
  1782. .unwrap(),
  1783. WindowMessage::OuterSize(tx) => tx
  1784. .send(PhysicalSizeWrapper(window.outer_size()).into())
  1785. .unwrap(),
  1786. WindowMessage::IsFullscreen(tx) => tx.send(window.fullscreen().is_some()).unwrap(),
  1787. WindowMessage::IsMaximized(tx) => tx.send(window.is_maximized()).unwrap(),
  1788. WindowMessage::IsDecorated(tx) => tx.send(window.is_decorated()).unwrap(),
  1789. WindowMessage::IsResizable(tx) => tx.send(window.is_resizable()).unwrap(),
  1790. WindowMessage::IsVisible(tx) => tx.send(window.is_visible()).unwrap(),
  1791. WindowMessage::IsMenuVisible(tx) => tx.send(window.is_menu_visible()).unwrap(),
  1792. WindowMessage::CurrentMonitor(tx) => tx.send(window.current_monitor()).unwrap(),
  1793. WindowMessage::PrimaryMonitor(tx) => tx.send(window.primary_monitor()).unwrap(),
  1794. WindowMessage::AvailableMonitors(tx) => {
  1795. tx.send(window.available_monitors().collect()).unwrap()
  1796. }
  1797. #[cfg(target_os = "macos")]
  1798. WindowMessage::NSWindow(tx) => tx.send(NSWindow(window.ns_window())).unwrap(),
  1799. #[cfg(windows)]
  1800. WindowMessage::Hwnd(tx) => tx.send(Hwnd(HWND(window.hwnd() as _))).unwrap(),
  1801. #[cfg(any(
  1802. target_os = "linux",
  1803. target_os = "dragonfly",
  1804. target_os = "freebsd",
  1805. target_os = "netbsd",
  1806. target_os = "openbsd"
  1807. ))]
  1808. WindowMessage::GtkWindow(tx) => tx.send(GtkWindow(window.gtk_window().clone())).unwrap(),
  1809. // Setters
  1810. WindowMessage::Center(tx) => {
  1811. tx.send(center_window(window, webview.inner.inner_size()))
  1812. .unwrap();
  1813. }
  1814. WindowMessage::RequestUserAttention(request_type) => {
  1815. window.request_user_attention(request_type.map(|r| r.0));
  1816. }
  1817. WindowMessage::SetResizable(resizable) => window.set_resizable(resizable),
  1818. WindowMessage::SetTitle(title) => window.set_title(&title),
  1819. WindowMessage::Maximize => window.set_maximized(true),
  1820. WindowMessage::Unmaximize => window.set_maximized(false),
  1821. WindowMessage::Minimize => window.set_minimized(true),
  1822. WindowMessage::Unminimize => window.set_minimized(false),
  1823. WindowMessage::ShowMenu => window.show_menu(),
  1824. WindowMessage::HideMenu => window.hide_menu(),
  1825. WindowMessage::Show => window.set_visible(true),
  1826. WindowMessage::Hide => window.set_visible(false),
  1827. WindowMessage::Close => panic!("cannot handle `WindowMessage::Close` on the main thread"),
  1828. WindowMessage::SetDecorations(decorations) => window.set_decorations(decorations),
  1829. WindowMessage::SetAlwaysOnTop(always_on_top) => window.set_always_on_top(always_on_top),
  1830. WindowMessage::SetSize(size) => {
  1831. window.set_inner_size(SizeWrapper::from(size).0);
  1832. }
  1833. WindowMessage::SetMinSize(size) => {
  1834. window.set_min_inner_size(size.map(|s| SizeWrapper::from(s).0));
  1835. }
  1836. WindowMessage::SetMaxSize(size) => {
  1837. window.set_max_inner_size(size.map(|s| SizeWrapper::from(s).0));
  1838. }
  1839. WindowMessage::SetPosition(position) => {
  1840. window.set_outer_position(PositionWrapper::from(position).0)
  1841. }
  1842. WindowMessage::SetFullscreen(fullscreen) => {
  1843. if fullscreen {
  1844. window.set_fullscreen(Some(Fullscreen::Borderless(None)))
  1845. } else {
  1846. window.set_fullscreen(None)
  1847. }
  1848. }
  1849. WindowMessage::SetFocus => {
  1850. window.set_focus();
  1851. }
  1852. WindowMessage::SetIcon(icon) => {
  1853. window.set_window_icon(Some(icon));
  1854. }
  1855. WindowMessage::SetSkipTaskbar(_skip) => {
  1856. #[cfg(any(windows, target_os = "linux"))]
  1857. window.set_skip_taskbar(_skip);
  1858. }
  1859. WindowMessage::DragWindow => {
  1860. let _ = window.drag_window();
  1861. }
  1862. WindowMessage::UpdateMenuItem(id, update) => {
  1863. if let Some(menu_items) = webview.menu_items.as_mut() {
  1864. let item = menu_items.get_mut(&id).expect("menu item not found");
  1865. match update {
  1866. MenuUpdate::SetEnabled(enabled) => item.set_enabled(enabled),
  1867. MenuUpdate::SetTitle(title) => item.set_title(&title),
  1868. MenuUpdate::SetSelected(selected) => item.set_selected(selected),
  1869. #[cfg(target_os = "macos")]
  1870. MenuUpdate::SetNativeImage(image) => {
  1871. item.set_native_image(NativeImageWrapper::from(image).0)
  1872. }
  1873. }
  1874. }
  1875. }
  1876. WindowMessage::RequestRedraw => {
  1877. window.request_redraw();
  1878. }
  1879. }
  1880. }
  1881. }
  1882. Message::Webview(id, webview_message) => match webview_message {
  1883. WebviewMessage::EvaluateScript(script) => {
  1884. if let Some(WindowHandle::Webview(webview)) = windows
  1885. .lock()
  1886. .expect("poisoned webview collection")
  1887. .get(&id)
  1888. .map(|w| &w.inner)
  1889. {
  1890. if let Err(e) = webview.evaluate_script(&script) {
  1891. #[cfg(debug_assertions)]
  1892. eprintln!("{}", e);
  1893. }
  1894. }
  1895. }
  1896. WebviewMessage::Print => {
  1897. if let Some(WindowHandle::Webview(webview)) = windows
  1898. .lock()
  1899. .expect("poisoned webview collection")
  1900. .get(&id)
  1901. .map(|w| &w.inner)
  1902. {
  1903. let _ = webview.print();
  1904. }
  1905. }
  1906. WebviewMessage::WebviewEvent(event) => {
  1907. if let Some(event) = WindowEventWrapper::from(&event).0 {
  1908. for handler in window_event_listeners
  1909. .lock()
  1910. .unwrap()
  1911. .get(&id)
  1912. .unwrap()
  1913. .lock()
  1914. .unwrap()
  1915. .values()
  1916. {
  1917. handler(&event);
  1918. }
  1919. }
  1920. }
  1921. },
  1922. Message::CreateWebview(window_id, handler) => match handler(event_loop, web_context) {
  1923. Ok(webview) => {
  1924. windows
  1925. .lock()
  1926. .expect("poisoned webview collection")
  1927. .insert(window_id, webview);
  1928. }
  1929. Err(e) => {
  1930. #[cfg(debug_assertions)]
  1931. eprintln!("{}", e);
  1932. }
  1933. },
  1934. Message::CreateWindow(window_id, handler, sender) => {
  1935. let (label, builder) = handler();
  1936. if let Ok(window) = builder.build(event_loop) {
  1937. window_event_listeners
  1938. .lock()
  1939. .unwrap()
  1940. .insert(window_id, WindowEventListenersMap::default());
  1941. menu_event_listeners
  1942. .lock()
  1943. .unwrap()
  1944. .insert(window_id, WindowMenuEventListeners::default());
  1945. let w = Arc::new(window);
  1946. windows.lock().expect("poisoned webview collection").insert(
  1947. window_id,
  1948. WindowWrapper {
  1949. label,
  1950. inner: WindowHandle::Window(w.clone()),
  1951. menu_items: Default::default(),
  1952. },
  1953. );
  1954. sender.send(Ok(Arc::downgrade(&w))).unwrap();
  1955. } else {
  1956. sender.send(Err(Error::CreateWindow)).unwrap();
  1957. }
  1958. }
  1959. #[cfg(feature = "system-tray")]
  1960. Message::Tray(tray_message) => match tray_message {
  1961. TrayMessage::UpdateItem(menu_id, update) => {
  1962. let mut tray = tray_context.items.as_ref().lock().unwrap();
  1963. let item = tray.get_mut(&menu_id).expect("menu item not found");
  1964. match update {
  1965. MenuUpdate::SetEnabled(enabled) => item.set_enabled(enabled),
  1966. MenuUpdate::SetTitle(title) => item.set_title(&title),
  1967. MenuUpdate::SetSelected(selected) => item.set_selected(selected),
  1968. #[cfg(target_os = "macos")]
  1969. MenuUpdate::SetNativeImage(image) => {
  1970. item.set_native_image(NativeImageWrapper::from(image).0)
  1971. }
  1972. }
  1973. }
  1974. TrayMessage::UpdateMenu(menu) => {
  1975. if let Some(tray) = &*tray_context.tray.lock().unwrap() {
  1976. let mut items = HashMap::new();
  1977. tray
  1978. .lock()
  1979. .unwrap()
  1980. .set_menu(&to_wry_context_menu(&mut items, menu));
  1981. *tray_context.items.lock().unwrap() = items;
  1982. }
  1983. }
  1984. TrayMessage::UpdateIcon(icon) => {
  1985. if let Some(tray) = &*tray_context.tray.lock().unwrap() {
  1986. tray.lock().unwrap().set_icon(icon.into_platform_icon());
  1987. }
  1988. }
  1989. #[cfg(target_os = "macos")]
  1990. TrayMessage::UpdateIconAsTemplate(is_template) => {
  1991. if let Some(tray) = &*tray_context.tray.lock().unwrap() {
  1992. tray.lock().unwrap().set_icon_as_template(is_template);
  1993. }
  1994. }
  1995. TrayMessage::Close => {
  1996. *tray_context.tray.lock().unwrap() = None;
  1997. tray_context.listeners.lock().unwrap().clear();
  1998. tray_context.items.lock().unwrap().clear();
  1999. }
  2000. },
  2001. Message::GlobalShortcut(message) => match message {
  2002. GlobalShortcutMessage::IsRegistered(accelerator, tx) => tx
  2003. .send(
  2004. global_shortcut_manager
  2005. .lock()
  2006. .unwrap()
  2007. .is_registered(&accelerator),
  2008. )
  2009. .unwrap(),
  2010. GlobalShortcutMessage::Register(accelerator, tx) => tx
  2011. .send(
  2012. global_shortcut_manager
  2013. .lock()
  2014. .unwrap()
  2015. .register(accelerator)
  2016. .map(GlobalShortcutWrapper)
  2017. .map_err(|e| Error::GlobalShortcut(Box::new(e))),
  2018. )
  2019. .unwrap(),
  2020. GlobalShortcutMessage::Unregister(shortcut, tx) => tx
  2021. .send(
  2022. global_shortcut_manager
  2023. .lock()
  2024. .unwrap()
  2025. .unregister(shortcut.0)
  2026. .map_err(|e| Error::GlobalShortcut(Box::new(e))),
  2027. )
  2028. .unwrap(),
  2029. GlobalShortcutMessage::UnregisterAll(tx) => tx
  2030. .send(
  2031. global_shortcut_manager
  2032. .lock()
  2033. .unwrap()
  2034. .unregister_all()
  2035. .map_err(|e| Error::GlobalShortcut(Box::new(e))),
  2036. )
  2037. .unwrap(),
  2038. },
  2039. Message::Clipboard(message) => match message {
  2040. ClipboardMessage::WriteText(text, tx) => {
  2041. clipboard_manager.lock().unwrap().write_text(text);
  2042. tx.send(()).unwrap();
  2043. }
  2044. ClipboardMessage::ReadText(tx) => tx
  2045. .send(clipboard_manager.lock().unwrap().read_text())
  2046. .unwrap(),
  2047. },
  2048. Message::UserEvent(_) => (),
  2049. }
  2050. let it = RunIteration {
  2051. window_count: windows.lock().expect("poisoned webview collection").len(),
  2052. };
  2053. it
  2054. }
  2055. fn handle_event_loop<T: UserEvent>(
  2056. event: Event<'_, Message<T>>,
  2057. event_loop: &EventLoopWindowTarget<Message<T>>,
  2058. control_flow: &mut ControlFlow,
  2059. context: EventLoopIterationContext<'_, T>,
  2060. web_context: &WebContextStore,
  2061. ) -> RunIteration {
  2062. let EventLoopIterationContext {
  2063. callback,
  2064. webview_id_map,
  2065. windows,
  2066. window_event_listeners,
  2067. global_shortcut_manager,
  2068. global_shortcut_manager_handle,
  2069. clipboard_manager,
  2070. menu_event_listeners,
  2071. #[cfg(feature = "system-tray")]
  2072. tray_context,
  2073. } = context;
  2074. if *control_flow != ControlFlow::Exit {
  2075. *control_flow = ControlFlow::Wait;
  2076. }
  2077. match event {
  2078. Event::NewEvents(StartCause::Init) => {
  2079. callback(RunEvent::Ready);
  2080. }
  2081. Event::NewEvents(StartCause::Poll) => {
  2082. callback(RunEvent::Resumed);
  2083. }
  2084. Event::MainEventsCleared => {
  2085. callback(RunEvent::MainEventsCleared);
  2086. }
  2087. Event::LoopDestroyed => {
  2088. callback(RunEvent::Exit);
  2089. }
  2090. Event::GlobalShortcutEvent(accelerator_id) => {
  2091. for (id, handler) in &*global_shortcut_manager_handle.listeners.lock().unwrap() {
  2092. if accelerator_id == *id {
  2093. handler();
  2094. }
  2095. }
  2096. }
  2097. Event::MenuEvent {
  2098. window_id,
  2099. menu_id,
  2100. origin: MenuType::MenuBar,
  2101. ..
  2102. } => {
  2103. let window_id = window_id.unwrap(); // always Some on MenuBar event
  2104. let event = MenuEvent {
  2105. menu_item_id: menu_id.0,
  2106. };
  2107. let window_menu_event_listeners = {
  2108. let window_id = webview_id_map.get(&window_id);
  2109. let listeners = menu_event_listeners.lock().unwrap();
  2110. listeners.get(&window_id).cloned().unwrap_or_default()
  2111. };
  2112. for handler in window_menu_event_listeners.lock().unwrap().values() {
  2113. handler(&event);
  2114. }
  2115. }
  2116. #[cfg(feature = "system-tray")]
  2117. Event::MenuEvent {
  2118. window_id: _,
  2119. menu_id,
  2120. origin: MenuType::ContextMenu,
  2121. ..
  2122. } => {
  2123. let event = SystemTrayEvent::MenuItemClick(menu_id.0);
  2124. let listeners = tray_context.listeners.lock().unwrap().clone();
  2125. for handler in listeners.values() {
  2126. handler(&event);
  2127. }
  2128. }
  2129. #[cfg(feature = "system-tray")]
  2130. Event::TrayEvent {
  2131. bounds,
  2132. event,
  2133. position: _cursor_position,
  2134. ..
  2135. } => {
  2136. let (position, size) = (
  2137. PhysicalPositionWrapper(bounds.position).into(),
  2138. PhysicalSizeWrapper(bounds.size).into(),
  2139. );
  2140. let event = match event {
  2141. TrayEvent::RightClick => SystemTrayEvent::RightClick { position, size },
  2142. TrayEvent::DoubleClick => SystemTrayEvent::DoubleClick { position, size },
  2143. // default to left click
  2144. _ => SystemTrayEvent::LeftClick { position, size },
  2145. };
  2146. for handler in tray_context.listeners.lock().unwrap().values() {
  2147. handler(&event);
  2148. }
  2149. }
  2150. Event::WindowEvent {
  2151. event, window_id, ..
  2152. } => {
  2153. let window_id = webview_id_map.get(&window_id);
  2154. // NOTE(amrbashir): we handle this event here instead of `match` statement below because
  2155. // we want to focus the webview as soon as possible, especially on windows.
  2156. if event == WryWindowEvent::Focused(true) {
  2157. if let Some(WindowHandle::Webview(webview)) = windows
  2158. .lock()
  2159. .expect("poisoned webview collection")
  2160. .get(&window_id)
  2161. .map(|w| &w.inner)
  2162. {
  2163. // only focus the webview if the window is visible
  2164. // somehow tao is sending a Focused(true) event even when the window is invisible,
  2165. // which causes a deadlock: https://github.com/tauri-apps/tauri/issues/3534
  2166. if webview.window().is_visible() {
  2167. webview.focus();
  2168. }
  2169. }
  2170. }
  2171. {
  2172. let windows_lock = windows.lock().expect("poisoned webview collection");
  2173. if let Some(window_handle) = windows_lock.get(&window_id).map(|w| &w.inner) {
  2174. if let Some(event) = WindowEventWrapper::parse(window_handle, &event).0 {
  2175. drop(windows_lock);
  2176. for handler in window_event_listeners
  2177. .lock()
  2178. .unwrap()
  2179. .get(&window_id)
  2180. .unwrap()
  2181. .lock()
  2182. .unwrap()
  2183. .values()
  2184. {
  2185. handler(&event);
  2186. }
  2187. }
  2188. }
  2189. }
  2190. match event {
  2191. WryWindowEvent::CloseRequested => {
  2192. on_close_requested(
  2193. callback,
  2194. window_id,
  2195. windows.clone(),
  2196. control_flow,
  2197. window_event_listeners,
  2198. menu_event_listeners.clone(),
  2199. );
  2200. }
  2201. WryWindowEvent::Resized(_) => {
  2202. if let Some(WindowHandle::Webview(webview)) = windows
  2203. .lock()
  2204. .expect("poisoned webview collection")
  2205. .get(&window_id)
  2206. .map(|w| &w.inner)
  2207. {
  2208. if let Err(e) = webview.resize() {
  2209. #[cfg(debug_assertions)]
  2210. eprintln!("{}", e);
  2211. }
  2212. }
  2213. }
  2214. _ => {}
  2215. }
  2216. }
  2217. Event::UserEvent(message) => match message {
  2218. Message::Window(id, WindowMessage::Close) => {
  2219. on_window_close(
  2220. callback,
  2221. id,
  2222. windows.lock().expect("poisoned webview collection"),
  2223. control_flow,
  2224. #[cfg(target_os = "linux")]
  2225. window_event_listeners,
  2226. menu_event_listeners.clone(),
  2227. );
  2228. }
  2229. Message::UserEvent(t) => callback(RunEvent::UserEvent(t)),
  2230. message => {
  2231. return handle_user_message(
  2232. event_loop,
  2233. message,
  2234. UserMessageContext {
  2235. window_event_listeners,
  2236. global_shortcut_manager,
  2237. clipboard_manager,
  2238. menu_event_listeners,
  2239. windows,
  2240. #[cfg(feature = "system-tray")]
  2241. tray_context,
  2242. },
  2243. web_context,
  2244. );
  2245. }
  2246. },
  2247. _ => (),
  2248. }
  2249. let it = RunIteration {
  2250. window_count: windows.lock().expect("poisoned webview collection").len(),
  2251. };
  2252. it
  2253. }
  2254. fn on_close_requested<'a, T: UserEvent>(
  2255. callback: &'a mut (dyn FnMut(RunEvent<T>) + 'static),
  2256. window_id: WebviewId,
  2257. windows: Arc<Mutex<HashMap<WebviewId, WindowWrapper>>>,
  2258. control_flow: &mut ControlFlow,
  2259. window_event_listeners: &WindowEventListeners,
  2260. menu_event_listeners: MenuEventListeners,
  2261. ) -> Option<WindowWrapper> {
  2262. let (tx, rx) = channel();
  2263. let windows_guard = windows.lock().expect("poisoned webview collection");
  2264. if let Some(w) = windows_guard.get(&window_id) {
  2265. let label = w.label.clone();
  2266. drop(windows_guard);
  2267. for handler in window_event_listeners
  2268. .lock()
  2269. .unwrap()
  2270. .get(&window_id)
  2271. .unwrap()
  2272. .lock()
  2273. .unwrap()
  2274. .values()
  2275. {
  2276. handler(&WindowEvent::CloseRequested {
  2277. label: label.clone(),
  2278. signal_tx: tx.clone(),
  2279. });
  2280. }
  2281. callback(RunEvent::CloseRequested {
  2282. label,
  2283. signal_tx: tx,
  2284. });
  2285. if let Ok(true) = rx.try_recv() {
  2286. None
  2287. } else {
  2288. on_window_close(
  2289. callback,
  2290. window_id,
  2291. windows.lock().expect("poisoned webview collection"),
  2292. control_flow,
  2293. #[cfg(target_os = "linux")]
  2294. window_event_listeners,
  2295. menu_event_listeners,
  2296. )
  2297. }
  2298. } else {
  2299. None
  2300. }
  2301. }
  2302. fn on_window_close<'a, T: UserEvent>(
  2303. callback: &'a mut (dyn FnMut(RunEvent<T>) + 'static),
  2304. window_id: WebviewId,
  2305. mut windows: MutexGuard<'a, HashMap<WebviewId, WindowWrapper>>,
  2306. control_flow: &mut ControlFlow,
  2307. #[cfg(target_os = "linux")] window_event_listeners: &WindowEventListeners,
  2308. menu_event_listeners: MenuEventListeners,
  2309. ) -> Option<WindowWrapper> {
  2310. #[allow(unused_mut)]
  2311. let w = if let Some(mut webview) = windows.remove(&window_id) {
  2312. let is_empty = windows.is_empty();
  2313. drop(windows);
  2314. menu_event_listeners.lock().unwrap().remove(&window_id);
  2315. callback(RunEvent::WindowClose(webview.label.clone()));
  2316. if is_empty {
  2317. let (tx, rx) = channel();
  2318. callback(RunEvent::ExitRequested {
  2319. window_label: webview.label.clone(),
  2320. tx,
  2321. });
  2322. let recv = rx.try_recv();
  2323. let should_prevent = matches!(recv, Ok(ExitRequestedEventAction::Prevent));
  2324. if !should_prevent {
  2325. *control_flow = ControlFlow::Exit;
  2326. }
  2327. }
  2328. Some(webview)
  2329. } else {
  2330. None
  2331. };
  2332. // TODO: tao does not fire the destroyed event properly
  2333. #[cfg(target_os = "linux")]
  2334. {
  2335. for handler in window_event_listeners
  2336. .lock()
  2337. .unwrap()
  2338. .get(&window_id)
  2339. .unwrap()
  2340. .lock()
  2341. .unwrap()
  2342. .values()
  2343. {
  2344. handler(&WindowEvent::Destroyed);
  2345. }
  2346. }
  2347. w
  2348. }
  2349. fn center_window(window: &Window, window_size: WryPhysicalSize<u32>) -> Result<()> {
  2350. if let Some(monitor) = window.current_monitor() {
  2351. let screen_size = monitor.size();
  2352. let x = (screen_size.width as i32 - window_size.width as i32) / 2;
  2353. let y = (screen_size.height as i32 - window_size.height as i32) / 2;
  2354. window.set_outer_position(WryPhysicalPosition::new(x, y));
  2355. Ok(())
  2356. } else {
  2357. Err(Error::FailedToGetMonitor)
  2358. }
  2359. }
  2360. fn to_wry_menu(
  2361. custom_menu_items: &mut HashMap<MenuHash, WryCustomMenuItem>,
  2362. menu: Menu,
  2363. ) -> MenuBar {
  2364. let mut wry_menu = MenuBar::new();
  2365. for item in menu.items {
  2366. match item {
  2367. MenuEntry::CustomItem(c) => {
  2368. let mut attributes = MenuItemAttributesWrapper::from(&c).0;
  2369. attributes = attributes.with_id(WryMenuId(c.id));
  2370. #[allow(unused_mut)]
  2371. let mut item = wry_menu.add_item(attributes);
  2372. #[cfg(target_os = "macos")]
  2373. if let Some(native_image) = c.native_image {
  2374. item.set_native_image(NativeImageWrapper::from(native_image).0);
  2375. }
  2376. custom_menu_items.insert(c.id, item);
  2377. }
  2378. MenuEntry::NativeItem(i) => {
  2379. wry_menu.add_native_item(MenuItemWrapper::from(i).0);
  2380. }
  2381. MenuEntry::Submenu(submenu) => {
  2382. wry_menu.add_submenu(
  2383. &submenu.title,
  2384. submenu.enabled,
  2385. to_wry_menu(custom_menu_items, submenu.inner),
  2386. );
  2387. }
  2388. }
  2389. }
  2390. wry_menu
  2391. }
  2392. fn create_webview<T: UserEvent>(
  2393. window_id: WebviewId,
  2394. event_loop: &EventLoopWindowTarget<Message<T>>,
  2395. web_context: &WebContextStore,
  2396. context: Context<T>,
  2397. pending: PendingWindow<T, Wry<T>>,
  2398. ) -> Result<WindowWrapper> {
  2399. #[allow(unused_mut)]
  2400. let PendingWindow {
  2401. webview_attributes,
  2402. uri_scheme_protocols,
  2403. mut window_builder,
  2404. ipc_handler,
  2405. label,
  2406. url,
  2407. menu_ids,
  2408. js_event_listeners,
  2409. ..
  2410. } = pending;
  2411. let webview_id_map = context.webview_id_map.clone();
  2412. #[cfg(windows)]
  2413. let proxy = context.proxy.clone();
  2414. let is_window_transparent = window_builder.inner.window.transparent;
  2415. let menu_items = if let Some(menu) = window_builder.menu {
  2416. let mut menu_items = HashMap::new();
  2417. let menu = to_wry_menu(&mut menu_items, menu);
  2418. window_builder.inner = window_builder.inner.with_menu(menu);
  2419. Some(menu_items)
  2420. } else {
  2421. None
  2422. };
  2423. let window = window_builder.inner.build(event_loop).unwrap();
  2424. if window_builder.center {
  2425. let _ = center_window(&window, window.inner_size());
  2426. }
  2427. let mut webview_builder = WebViewBuilder::new(window)
  2428. .map_err(|e| Error::CreateWebview(Box::new(e)))?
  2429. .with_url(&url)
  2430. .unwrap() // safe to unwrap because we validate the URL beforehand
  2431. .with_transparent(is_window_transparent);
  2432. if webview_attributes.file_drop_handler_enabled {
  2433. webview_builder = webview_builder.with_file_drop_handler(create_file_drop_handler(&context));
  2434. }
  2435. if let Some(handler) = ipc_handler {
  2436. webview_builder = webview_builder.with_ipc_handler(create_ipc_handler(
  2437. context,
  2438. label.clone(),
  2439. menu_ids,
  2440. js_event_listeners,
  2441. handler,
  2442. ));
  2443. }
  2444. for (scheme, protocol) in uri_scheme_protocols {
  2445. webview_builder = webview_builder.with_custom_protocol(scheme, move |wry_request| {
  2446. protocol(&HttpRequestWrapper::from(wry_request).0)
  2447. .map(|tauri_response| HttpResponseWrapper::from(tauri_response).0)
  2448. .map_err(|_| wry::Error::InitScriptError)
  2449. });
  2450. }
  2451. for script in webview_attributes.initialization_scripts {
  2452. webview_builder = webview_builder.with_initialization_script(&script);
  2453. }
  2454. let mut web_context = web_context.lock().expect("poisoned WebContext store");
  2455. let is_first_context = web_context.is_empty();
  2456. let automation_enabled = std::env::var("TAURI_AUTOMATION").as_deref() == Ok("true");
  2457. let web_context = match web_context.entry(
  2458. // force a unique WebContext when automation is false;
  2459. // the context must be stored on the HashMap because it must outlive the WebView on macOS
  2460. if automation_enabled {
  2461. webview_attributes.data_directory.clone()
  2462. } else {
  2463. // random unique key
  2464. Some(Uuid::new_v4().to_hyphenated().to_string().into())
  2465. },
  2466. ) {
  2467. Occupied(occupied) => occupied.into_mut(),
  2468. Vacant(vacant) => {
  2469. let mut web_context = WebContext::new(webview_attributes.data_directory);
  2470. web_context.set_allows_automation(if automation_enabled {
  2471. is_first_context
  2472. } else {
  2473. false
  2474. });
  2475. vacant.insert(web_context)
  2476. }
  2477. };
  2478. if webview_attributes.clipboard {
  2479. webview_builder.webview.clipboard = true;
  2480. }
  2481. #[cfg(any(debug_assertions, feature = "devtools"))]
  2482. {
  2483. webview_builder = webview_builder.with_devtools(true);
  2484. }
  2485. let webview = webview_builder
  2486. .with_web_context(web_context)
  2487. .build()
  2488. .map_err(|e| Error::CreateWebview(Box::new(e)))?;
  2489. webview_id_map.insert(webview.window().id(), window_id);
  2490. #[cfg(windows)]
  2491. {
  2492. let controller = webview.controller();
  2493. let proxy_ = proxy.clone();
  2494. let mut token = EventRegistrationToken::default();
  2495. unsafe {
  2496. controller.GotFocus(
  2497. FocusChangedEventHandler::create(Box::new(move |_, _| {
  2498. let _ = proxy_.send_event(Message::Webview(
  2499. window_id,
  2500. WebviewMessage::WebviewEvent(WebviewEvent::Focused(true)),
  2501. ));
  2502. Ok(())
  2503. })),
  2504. &mut token,
  2505. )
  2506. }
  2507. .unwrap();
  2508. unsafe {
  2509. controller.LostFocus(
  2510. FocusChangedEventHandler::create(Box::new(move |_, _| {
  2511. let _ = proxy.send_event(Message::Webview(
  2512. window_id,
  2513. WebviewMessage::WebviewEvent(WebviewEvent::Focused(false)),
  2514. ));
  2515. Ok(())
  2516. })),
  2517. &mut token,
  2518. )
  2519. }
  2520. .unwrap();
  2521. }
  2522. Ok(WindowWrapper {
  2523. label,
  2524. inner: WindowHandle::Webview(webview),
  2525. menu_items,
  2526. })
  2527. }
  2528. /// Create a wry ipc handler from a tauri ipc handler.
  2529. fn create_ipc_handler<T: UserEvent>(
  2530. context: Context<T>,
  2531. label: String,
  2532. menu_ids: Arc<Mutex<HashMap<MenuHash, MenuId>>>,
  2533. js_event_listeners: Arc<Mutex<HashMap<JsEventListenerKey, HashSet<u64>>>>,
  2534. handler: WebviewIpcHandler<T, Wry<T>>,
  2535. ) -> Box<dyn Fn(&Window, String) + 'static> {
  2536. Box::new(move |window, request| {
  2537. handler(
  2538. DetachedWindow {
  2539. dispatcher: WryDispatcher {
  2540. window_id: *context
  2541. .webview_id_map
  2542. .0
  2543. .lock()
  2544. .unwrap()
  2545. .get(&window.id())
  2546. .unwrap(),
  2547. context: context.clone(),
  2548. },
  2549. label: label.clone(),
  2550. menu_ids: menu_ids.clone(),
  2551. js_event_listeners: js_event_listeners.clone(),
  2552. },
  2553. request,
  2554. );
  2555. })
  2556. }
  2557. /// Create a wry file drop handler.
  2558. fn create_file_drop_handler<T: UserEvent>(
  2559. context: &Context<T>,
  2560. ) -> Box<dyn Fn(&Window, WryFileDropEvent) -> bool + 'static> {
  2561. let window_event_listeners = context.window_event_listeners.clone();
  2562. let webview_id_map = context.webview_id_map.clone();
  2563. Box::new(move |window, event| {
  2564. let event: FileDropEvent = FileDropEventWrapper(event).into();
  2565. let window_event = WindowEvent::FileDrop(event);
  2566. let listeners = window_event_listeners.lock().unwrap();
  2567. if let Some(window_listeners) = listeners.get(&webview_id_map.get(&window.id())) {
  2568. let listeners_map = window_listeners.lock().unwrap();
  2569. let has_listener = !listeners_map.is_empty();
  2570. for listener in listeners_map.values() {
  2571. listener(&window_event);
  2572. }
  2573. // block the default OS action on file drop if we had a listener
  2574. has_listener
  2575. } else {
  2576. false
  2577. }
  2578. })
  2579. }