lib.rs 96 KB

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