1use std::{
2 any::{type_name, TypeId},
3 cell::{Ref, RefCell, RefMut},
4 marker::PhantomData,
5 ops::{Deref, DerefMut},
6 path::{Path, PathBuf},
7 rc::{Rc, Weak},
8 sync::{atomic::Ordering::SeqCst, Arc},
9 time::Duration,
10};
11
12use anyhow::{anyhow, Result};
13use derive_more::{Deref, DerefMut};
14use futures::{channel::oneshot, future::LocalBoxFuture, Future};
15use slotmap::SlotMap;
16use smol::future::FutureExt;
17use time::UtcOffset;
18
19pub use async_context::*;
20use collections::{FxHashMap, FxHashSet, VecDeque};
21pub use entity_map::*;
22use http::{self, HttpClient};
23pub use model_context::*;
24#[cfg(any(test, feature = "test-support"))]
25pub use test_context::*;
26use util::ResultExt;
27
28use crate::{
29 current_platform, init_app_menus, Action, ActionRegistry, Any, AnyView, AnyWindowHandle,
30 AppMetadata, AssetCache, AssetSource, BackgroundExecutor, ClipboardItem, Context,
31 DispatchPhase, DisplayId, Entity, EventEmitter, ForegroundExecutor, Global, KeyBinding, Keymap,
32 Keystroke, LayoutId, Menu, PathPromptOptions, Pixels, Platform, PlatformDisplay, Point,
33 PromptBuilder, PromptHandle, PromptLevel, Render, RenderablePromptHandle, Reservation,
34 SharedString, SubscriberSet, Subscription, SvgRenderer, Task, TextSystem, View, ViewContext,
35 Window, WindowAppearance, WindowContext, WindowHandle, WindowId,
36};
37
38mod async_context;
39mod entity_map;
40mod model_context;
41#[cfg(any(test, feature = "test-support"))]
42mod test_context;
43
44/// The duration for which futures returned from [AppContext::on_app_context] or [ModelContext::on_app_quit] can run before the application fully quits.
45pub const SHUTDOWN_TIMEOUT: Duration = Duration::from_millis(100);
46
47/// Temporary(?) wrapper around [`RefCell<AppContext>`] to help us debug any double borrows.
48/// Strongly consider removing after stabilization.
49#[doc(hidden)]
50pub struct AppCell {
51 app: RefCell<AppContext>,
52}
53
54impl AppCell {
55 #[doc(hidden)]
56 #[track_caller]
57 pub fn borrow(&self) -> AppRef {
58 if option_env!("TRACK_THREAD_BORROWS").is_some() {
59 let thread_id = std::thread::current().id();
60 eprintln!("borrowed {thread_id:?}");
61 }
62 AppRef(self.app.borrow())
63 }
64
65 #[doc(hidden)]
66 #[track_caller]
67 pub fn borrow_mut(&self) -> AppRefMut {
68 if option_env!("TRACK_THREAD_BORROWS").is_some() {
69 let thread_id = std::thread::current().id();
70 eprintln!("borrowed {thread_id:?}");
71 }
72 AppRefMut(self.app.borrow_mut())
73 }
74}
75
76#[doc(hidden)]
77#[derive(Deref, DerefMut)]
78pub struct AppRef<'a>(Ref<'a, AppContext>);
79
80impl<'a> Drop for AppRef<'a> {
81 fn drop(&mut self) {
82 if option_env!("TRACK_THREAD_BORROWS").is_some() {
83 let thread_id = std::thread::current().id();
84 eprintln!("dropped borrow from {thread_id:?}");
85 }
86 }
87}
88
89#[doc(hidden)]
90#[derive(Deref, DerefMut)]
91pub struct AppRefMut<'a>(RefMut<'a, AppContext>);
92
93impl<'a> Drop for AppRefMut<'a> {
94 fn drop(&mut self) {
95 if option_env!("TRACK_THREAD_BORROWS").is_some() {
96 let thread_id = std::thread::current().id();
97 eprintln!("dropped {thread_id:?}");
98 }
99 }
100}
101
102/// A reference to a GPUI application, typically constructed in the `main` function of your app.
103/// You won't interact with this type much outside of initial configuration and startup.
104pub struct App(Rc<AppCell>);
105
106/// Represents an application before it is fully launched. Once your app is
107/// configured, you'll start the app with `App::run`.
108impl App {
109 /// Builds an app with the given asset source.
110 #[allow(clippy::new_without_default)]
111 pub fn new() -> Self {
112 #[cfg(any(test, feature = "test-support"))]
113 log::info!("GPUI was compiled in test mode");
114
115 Self(AppContext::new(
116 current_platform(),
117 Arc::new(()),
118 http::client(),
119 ))
120 }
121
122 /// Assign
123 pub fn with_assets(self, asset_source: impl AssetSource) -> Self {
124 let mut context_lock = self.0.borrow_mut();
125 let asset_source = Arc::new(asset_source);
126 context_lock.asset_source = asset_source.clone();
127 context_lock.svg_renderer = SvgRenderer::new(asset_source);
128 drop(context_lock);
129 self
130 }
131
132 /// Start the application. The provided callback will be called once the
133 /// app is fully launched.
134 pub fn run<F>(self, on_finish_launching: F)
135 where
136 F: 'static + FnOnce(&mut AppContext),
137 {
138 let this = self.0.clone();
139 let platform = self.0.borrow().platform.clone();
140 platform.run(Box::new(move || {
141 let cx = &mut *this.borrow_mut();
142 on_finish_launching(cx);
143 }));
144 }
145
146 /// Register a handler to be invoked when the platform instructs the application
147 /// to open one or more URLs.
148 pub fn on_open_urls<F>(&self, mut callback: F) -> &Self
149 where
150 F: 'static + FnMut(Vec<String>),
151 {
152 self.0.borrow().platform.on_open_urls(Box::new(callback));
153 self
154 }
155
156 /// Invokes a handler when an already-running application is launched.
157 /// On macOS, this can occur when the application icon is double-clicked or the app is launched via the dock.
158 pub fn on_reopen<F>(&self, mut callback: F) -> &Self
159 where
160 F: 'static + FnMut(&mut AppContext),
161 {
162 let this = Rc::downgrade(&self.0);
163 self.0.borrow_mut().platform.on_reopen(Box::new(move || {
164 if let Some(app) = this.upgrade() {
165 callback(&mut app.borrow_mut());
166 }
167 }));
168 self
169 }
170
171 /// Returns metadata associated with the application
172 pub fn metadata(&self) -> AppMetadata {
173 self.0.borrow().app_metadata.clone()
174 }
175
176 /// Returns a handle to the [`BackgroundExecutor`] associated with this app, which can be used to spawn futures in the background.
177 pub fn background_executor(&self) -> BackgroundExecutor {
178 self.0.borrow().background_executor.clone()
179 }
180
181 /// Returns a handle to the [`ForegroundExecutor`] associated with this app, which can be used to spawn futures in the foreground.
182 pub fn foreground_executor(&self) -> ForegroundExecutor {
183 self.0.borrow().foreground_executor.clone()
184 }
185
186 /// Returns a reference to the [`TextSystem`] associated with this app.
187 pub fn text_system(&self) -> Arc<TextSystem> {
188 self.0.borrow().text_system.clone()
189 }
190
191 /// Returns the file URL of the executable with the specified name in the application bundle
192 pub fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf> {
193 self.0.borrow().path_for_auxiliary_executable(name)
194 }
195}
196
197type Handler = Box<dyn FnMut(&mut AppContext) -> bool + 'static>;
198type Listener = Box<dyn FnMut(&dyn Any, &mut AppContext) -> bool + 'static>;
199type KeystrokeObserver = Box<dyn FnMut(&KeystrokeEvent, &mut WindowContext) + 'static>;
200type QuitHandler = Box<dyn FnOnce(&mut AppContext) -> LocalBoxFuture<'static, ()> + 'static>;
201type ReleaseListener = Box<dyn FnOnce(&mut dyn Any, &mut AppContext) + 'static>;
202type NewViewListener = Box<dyn FnMut(AnyView, &mut WindowContext) + 'static>;
203
204/// Contains the state of the full application, and passed as a reference to a variety of callbacks.
205/// Other contexts such as [ModelContext], [WindowContext], and [ViewContext] deref to this type, making it the most general context type.
206/// You need a reference to an `AppContext` to access the state of a [Model].
207pub struct AppContext {
208 pub(crate) this: Weak<AppCell>,
209 pub(crate) platform: Rc<dyn Platform>,
210 app_metadata: AppMetadata,
211 text_system: Arc<TextSystem>,
212 flushing_effects: bool,
213 pending_updates: usize,
214 pub(crate) actions: Rc<ActionRegistry>,
215 pub(crate) active_drag: Option<AnyDrag>,
216 pub(crate) background_executor: BackgroundExecutor,
217 pub(crate) foreground_executor: ForegroundExecutor,
218 pub(crate) loading_assets: FxHashMap<(TypeId, u64), Box<dyn Any>>,
219 pub(crate) asset_cache: AssetCache,
220 asset_source: Arc<dyn AssetSource>,
221 pub(crate) svg_renderer: SvgRenderer,
222 http_client: Arc<dyn HttpClient>,
223 pub(crate) globals_by_type: FxHashMap<TypeId, Box<dyn Any>>,
224 pub(crate) entities: EntityMap,
225 pub(crate) new_view_observers: SubscriberSet<TypeId, NewViewListener>,
226 pub(crate) windows: SlotMap<WindowId, Option<Window>>,
227 pub(crate) window_handles: FxHashMap<WindowId, AnyWindowHandle>,
228 pub(crate) keymap: Rc<RefCell<Keymap>>,
229 pub(crate) global_action_listeners:
230 FxHashMap<TypeId, Vec<Rc<dyn Fn(&dyn Any, DispatchPhase, &mut Self)>>>,
231 pending_effects: VecDeque<Effect>,
232 pub(crate) pending_notifications: FxHashSet<EntityId>,
233 pub(crate) pending_global_notifications: FxHashSet<TypeId>,
234 pub(crate) observers: SubscriberSet<EntityId, Handler>,
235 // TypeId is the type of the event that the listener callback expects
236 pub(crate) event_listeners: SubscriberSet<EntityId, (TypeId, Listener)>,
237 pub(crate) keystroke_observers: SubscriberSet<(), KeystrokeObserver>,
238 pub(crate) release_listeners: SubscriberSet<EntityId, ReleaseListener>,
239 pub(crate) global_observers: SubscriberSet<TypeId, Handler>,
240 pub(crate) quit_observers: SubscriberSet<(), QuitHandler>,
241 pub(crate) layout_id_buffer: Vec<LayoutId>, // We recycle this memory across layout requests.
242 pub(crate) propagate_event: bool,
243 pub(crate) prompt_builder: Option<PromptBuilder>,
244}
245
246impl AppContext {
247 #[allow(clippy::new_ret_no_self)]
248 pub(crate) fn new(
249 platform: Rc<dyn Platform>,
250 asset_source: Arc<dyn AssetSource>,
251 http_client: Arc<dyn HttpClient>,
252 ) -> Rc<AppCell> {
253 let executor = platform.background_executor();
254 let foreground_executor = platform.foreground_executor();
255 assert!(
256 executor.is_main_thread(),
257 "must construct App on main thread"
258 );
259
260 let text_system = Arc::new(TextSystem::new(platform.text_system()));
261 let entities = EntityMap::new();
262
263 let app_metadata = AppMetadata {
264 os_name: platform.os_name(),
265 os_version: platform.os_version().ok(),
266 app_version: platform.app_version().ok(),
267 };
268
269 let app = Rc::new_cyclic(|this| AppCell {
270 app: RefCell::new(AppContext {
271 this: this.clone(),
272 platform: platform.clone(),
273 app_metadata,
274 text_system,
275 actions: Rc::new(ActionRegistry::default()),
276 flushing_effects: false,
277 pending_updates: 0,
278 active_drag: None,
279 background_executor: executor,
280 foreground_executor,
281 svg_renderer: SvgRenderer::new(asset_source.clone()),
282 asset_cache: AssetCache::new(),
283 loading_assets: Default::default(),
284 asset_source,
285 http_client,
286 globals_by_type: FxHashMap::default(),
287 entities,
288 new_view_observers: SubscriberSet::new(),
289 window_handles: FxHashMap::default(),
290 windows: SlotMap::with_key(),
291 keymap: Rc::new(RefCell::new(Keymap::default())),
292 global_action_listeners: FxHashMap::default(),
293 pending_effects: VecDeque::new(),
294 pending_notifications: FxHashSet::default(),
295 pending_global_notifications: FxHashSet::default(),
296 observers: SubscriberSet::new(),
297 event_listeners: SubscriberSet::new(),
298 release_listeners: SubscriberSet::new(),
299 keystroke_observers: SubscriberSet::new(),
300 global_observers: SubscriberSet::new(),
301 quit_observers: SubscriberSet::new(),
302 layout_id_buffer: Default::default(),
303 propagate_event: true,
304 prompt_builder: Some(PromptBuilder::Default),
305 }),
306 });
307
308 init_app_menus(platform.as_ref(), &mut app.borrow_mut());
309
310 platform.on_quit(Box::new({
311 let cx = app.clone();
312 move || {
313 cx.borrow_mut().shutdown();
314 }
315 }));
316
317 app
318 }
319
320 /// Quit the application gracefully. Handlers registered with [`ModelContext::on_app_quit`]
321 /// will be given 100ms to complete before exiting.
322 pub fn shutdown(&mut self) {
323 let mut futures = Vec::new();
324
325 for observer in self.quit_observers.remove(&()) {
326 futures.push(observer(self));
327 }
328
329 self.windows.clear();
330 self.window_handles.clear();
331 self.flush_effects();
332
333 let futures = futures::future::join_all(futures);
334 if self
335 .background_executor
336 .block_with_timeout(SHUTDOWN_TIMEOUT, futures)
337 .is_err()
338 {
339 log::error!("timed out waiting on app_will_quit");
340 }
341 }
342
343 /// Gracefully quit the application via the platform's standard routine.
344 pub fn quit(&mut self) {
345 self.platform.quit();
346 }
347
348 /// Get metadata about the app and platform.
349 pub fn app_metadata(&self) -> AppMetadata {
350 self.app_metadata.clone()
351 }
352
353 /// Schedules all windows in the application to be redrawn. This can be called
354 /// multiple times in an update cycle and still result in a single redraw.
355 pub fn refresh(&mut self) {
356 self.pending_effects.push_back(Effect::Refresh);
357 }
358
359 pub(crate) fn update<R>(&mut self, update: impl FnOnce(&mut Self) -> R) -> R {
360 self.pending_updates += 1;
361 let result = update(self);
362 if !self.flushing_effects && self.pending_updates == 1 {
363 self.flushing_effects = true;
364 self.flush_effects();
365 self.flushing_effects = false;
366 }
367 self.pending_updates -= 1;
368 result
369 }
370
371 /// Arrange a callback to be invoked when the given model or view calls `notify` on its respective context.
372 pub fn observe<W, E>(
373 &mut self,
374 entity: &E,
375 mut on_notify: impl FnMut(E, &mut AppContext) + 'static,
376 ) -> Subscription
377 where
378 W: 'static,
379 E: Entity<W>,
380 {
381 self.observe_internal(entity, move |e, cx| {
382 on_notify(e, cx);
383 true
384 })
385 }
386
387 pub(crate) fn new_observer(&mut self, key: EntityId, value: Handler) -> Subscription {
388 let (subscription, activate) = self.observers.insert(key, value);
389 self.defer(move |_| activate());
390 subscription
391 }
392 pub(crate) fn observe_internal<W, E>(
393 &mut self,
394 entity: &E,
395 mut on_notify: impl FnMut(E, &mut AppContext) -> bool + 'static,
396 ) -> Subscription
397 where
398 W: 'static,
399 E: Entity<W>,
400 {
401 let entity_id = entity.entity_id();
402 let handle = entity.downgrade();
403 self.new_observer(
404 entity_id,
405 Box::new(move |cx| {
406 if let Some(handle) = E::upgrade_from(&handle) {
407 on_notify(handle, cx)
408 } else {
409 false
410 }
411 }),
412 )
413 }
414
415 /// Arrange for the given callback to be invoked whenever the given model or view emits an event of a given type.
416 /// The callback is provided a handle to the emitting entity and a reference to the emitted event.
417 pub fn subscribe<T, E, Event>(
418 &mut self,
419 entity: &E,
420 mut on_event: impl FnMut(E, &Event, &mut AppContext) + 'static,
421 ) -> Subscription
422 where
423 T: 'static + EventEmitter<Event>,
424 E: Entity<T>,
425 Event: 'static,
426 {
427 self.subscribe_internal(entity, move |entity, event, cx| {
428 on_event(entity, event, cx);
429 true
430 })
431 }
432
433 pub(crate) fn new_subscription(
434 &mut self,
435 key: EntityId,
436 value: (TypeId, Listener),
437 ) -> Subscription {
438 let (subscription, activate) = self.event_listeners.insert(key, value);
439 self.defer(move |_| activate());
440 subscription
441 }
442 pub(crate) fn subscribe_internal<T, E, Evt>(
443 &mut self,
444 entity: &E,
445 mut on_event: impl FnMut(E, &Evt, &mut AppContext) -> bool + 'static,
446 ) -> Subscription
447 where
448 T: 'static + EventEmitter<Evt>,
449 E: Entity<T>,
450 Evt: 'static,
451 {
452 let entity_id = entity.entity_id();
453 let entity = entity.downgrade();
454 self.new_subscription(
455 entity_id,
456 (
457 TypeId::of::<Evt>(),
458 Box::new(move |event, cx| {
459 let event: &Evt = event.downcast_ref().expect("invalid event type");
460 if let Some(handle) = E::upgrade_from(&entity) {
461 on_event(handle, event, cx)
462 } else {
463 false
464 }
465 }),
466 ),
467 )
468 }
469
470 /// Returns handles to all open windows in the application.
471 /// Each handle could be downcast to a handle typed for the root view of that window.
472 /// To find all windows of a given type, you could filter on
473 pub fn windows(&self) -> Vec<AnyWindowHandle> {
474 self.windows
475 .keys()
476 .flat_map(|window_id| self.window_handles.get(&window_id).copied())
477 .collect()
478 }
479
480 /// Returns a handle to the window that is currently focused at the platform level, if one exists.
481 pub fn active_window(&self) -> Option<AnyWindowHandle> {
482 self.platform.active_window()
483 }
484
485 /// Opens a new window with the given option and the root view returned by the given function.
486 /// The function is invoked with a `WindowContext`, which can be used to interact with window-specific
487 /// functionality.
488 pub fn open_window<V: 'static + Render>(
489 &mut self,
490 options: crate::WindowOptions,
491 build_root_view: impl FnOnce(&mut WindowContext) -> View<V>,
492 ) -> WindowHandle<V> {
493 self.update(|cx| {
494 let id = cx.windows.insert(None);
495 let handle = WindowHandle::new(id);
496 let mut window = Window::new(handle.into(), options, cx);
497 let root_view = build_root_view(&mut WindowContext::new(cx, &mut window));
498 window.root_view.replace(root_view.into());
499 cx.window_handles.insert(id, window.handle);
500 cx.windows.get_mut(id).unwrap().replace(window);
501 handle
502 })
503 }
504
505 /// Instructs the platform to activate the application by bringing it to the foreground.
506 pub fn activate(&self, ignoring_other_apps: bool) {
507 self.platform.activate(ignoring_other_apps);
508 }
509
510 /// Hide the application at the platform level.
511 pub fn hide(&self) {
512 self.platform.hide();
513 }
514
515 /// Hide other applications at the platform level.
516 pub fn hide_other_apps(&self) {
517 self.platform.hide_other_apps();
518 }
519
520 /// Unhide other applications at the platform level.
521 pub fn unhide_other_apps(&self) {
522 self.platform.unhide_other_apps();
523 }
524
525 /// Returns the list of currently active displays.
526 pub fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
527 self.platform.displays()
528 }
529
530 /// Returns the primary display that will be used for new windows.
531 pub fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>> {
532 self.platform.primary_display()
533 }
534
535 /// Returns the display with the given ID, if one exists.
536 pub fn find_display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
537 self.displays()
538 .iter()
539 .find(|display| display.id() == id)
540 .cloned()
541 }
542
543 /// Returns the appearance of the application's windows.
544 pub fn window_appearance(&self) -> WindowAppearance {
545 self.platform.window_appearance()
546 }
547
548 /// Writes data to the primary selection buffer.
549 /// Only available on Linux.
550 pub fn write_to_primary(&self, item: ClipboardItem) {
551 self.platform.write_to_primary(item)
552 }
553
554 /// Writes data to the platform clipboard.
555 pub fn write_to_clipboard(&self, item: ClipboardItem) {
556 self.platform.write_to_clipboard(item)
557 }
558
559 /// Reads data from the primary selection buffer.
560 /// Only available on Linux.
561 pub fn read_from_primary(&self) -> Option<ClipboardItem> {
562 self.platform.read_from_primary()
563 }
564
565 /// Reads data from the platform clipboard.
566 pub fn read_from_clipboard(&self) -> Option<ClipboardItem> {
567 self.platform.read_from_clipboard()
568 }
569
570 /// Writes credentials to the platform keychain.
571 pub fn write_credentials(
572 &self,
573 url: &str,
574 username: &str,
575 password: &[u8],
576 ) -> Task<Result<()>> {
577 self.platform.write_credentials(url, username, password)
578 }
579
580 /// Reads credentials from the platform keychain.
581 pub fn read_credentials(&self, url: &str) -> Task<Result<Option<(String, Vec<u8>)>>> {
582 self.platform.read_credentials(url)
583 }
584
585 /// Deletes credentials from the platform keychain.
586 pub fn delete_credentials(&self, url: &str) -> Task<Result<()>> {
587 self.platform.delete_credentials(url)
588 }
589
590 /// Directs the platform's default browser to open the given URL.
591 pub fn open_url(&self, url: &str) {
592 self.platform.open_url(url);
593 }
594
595 /// register_url_scheme requests that the given scheme (e.g. `zed` for `zed://` urls)
596 /// is opened by the current app.
597 /// On some platforms (e.g. macOS) you may be able to register URL schemes as part of app
598 /// distribution, but this method exists to let you register schemes at runtime.
599 pub fn register_url_scheme(&self, scheme: &str) -> Task<Result<()>> {
600 self.platform.register_url_scheme(scheme)
601 }
602
603 /// Returns the full pathname of the current app bundle.
604 /// If the app is not being run from a bundle, returns an error.
605 pub fn app_path(&self) -> Result<PathBuf> {
606 self.platform.app_path()
607 }
608
609 /// Returns the file URL of the executable with the specified name in the application bundle
610 pub fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf> {
611 self.platform.path_for_auxiliary_executable(name)
612 }
613
614 /// Displays a platform modal for selecting paths.
615 /// When one or more paths are selected, they'll be relayed asynchronously via the returned oneshot channel.
616 /// If cancelled, a `None` will be relayed instead.
617 pub fn prompt_for_paths(
618 &self,
619 options: PathPromptOptions,
620 ) -> oneshot::Receiver<Option<Vec<PathBuf>>> {
621 self.platform.prompt_for_paths(options)
622 }
623
624 /// Displays a platform modal for selecting a new path where a file can be saved.
625 /// The provided directory will be used to set the initial location.
626 /// When a path is selected, it is relayed asynchronously via the returned oneshot channel.
627 /// If cancelled, a `None` will be relayed instead.
628 pub fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>> {
629 self.platform.prompt_for_new_path(directory)
630 }
631
632 /// Reveals the specified path at the platform level, such as in Finder on macOS.
633 pub fn reveal_path(&self, path: &Path) {
634 self.platform.reveal_path(path)
635 }
636
637 /// Returns whether the user has configured scrollbars to auto-hide at the platform level.
638 pub fn should_auto_hide_scrollbars(&self) -> bool {
639 self.platform.should_auto_hide_scrollbars()
640 }
641
642 /// Restart the application.
643 pub fn restart(&self, binary_path: Option<PathBuf>) {
644 self.platform.restart(binary_path)
645 }
646
647 /// Returns the local timezone at the platform level.
648 pub fn local_timezone(&self) -> UtcOffset {
649 self.platform.local_timezone()
650 }
651
652 /// Returns the http client assigned to GPUI
653 pub fn http_client(&self) -> Arc<dyn HttpClient> {
654 self.http_client.clone()
655 }
656
657 /// Returns the SVG renderer GPUI uses
658 pub(crate) fn svg_renderer(&self) -> SvgRenderer {
659 self.svg_renderer.clone()
660 }
661
662 pub(crate) fn push_effect(&mut self, effect: Effect) {
663 match &effect {
664 Effect::Notify { emitter } => {
665 if !self.pending_notifications.insert(*emitter) {
666 return;
667 }
668 }
669 Effect::NotifyGlobalObservers { global_type } => {
670 if !self.pending_global_notifications.insert(*global_type) {
671 return;
672 }
673 }
674 _ => {}
675 };
676
677 self.pending_effects.push_back(effect);
678 }
679
680 /// Called at the end of [`AppContext::update`] to complete any side effects
681 /// such as notifying observers, emitting events, etc. Effects can themselves
682 /// cause effects, so we continue looping until all effects are processed.
683 fn flush_effects(&mut self) {
684 loop {
685 self.release_dropped_entities();
686 self.release_dropped_focus_handles();
687
688 if let Some(effect) = self.pending_effects.pop_front() {
689 match effect {
690 Effect::Notify { emitter } => {
691 self.apply_notify_effect(emitter);
692 }
693
694 Effect::Emit {
695 emitter,
696 event_type,
697 event,
698 } => self.apply_emit_effect(emitter, event_type, event),
699
700 Effect::Refresh => {
701 self.apply_refresh_effect();
702 }
703
704 Effect::NotifyGlobalObservers { global_type } => {
705 self.apply_notify_global_observers_effect(global_type);
706 }
707
708 Effect::Defer { callback } => {
709 self.apply_defer_effect(callback);
710 }
711 }
712 } else {
713 #[cfg(any(test, feature = "test-support"))]
714 for window in self
715 .windows
716 .values()
717 .filter_map(|window| {
718 let window = window.as_ref()?;
719 window.dirty.get().then_some(window.handle)
720 })
721 .collect::<Vec<_>>()
722 {
723 self.update_window(window, |_, cx| cx.draw()).unwrap();
724 }
725
726 if self.pending_effects.is_empty() {
727 break;
728 }
729 }
730 }
731 }
732
733 /// Repeatedly called during `flush_effects` to release any entities whose
734 /// reference count has become zero. We invoke any release observers before dropping
735 /// each entity.
736 fn release_dropped_entities(&mut self) {
737 loop {
738 let dropped = self.entities.take_dropped();
739 if dropped.is_empty() {
740 break;
741 }
742
743 for (entity_id, mut entity) in dropped {
744 self.observers.remove(&entity_id);
745 self.event_listeners.remove(&entity_id);
746 for release_callback in self.release_listeners.remove(&entity_id) {
747 release_callback(entity.as_mut(), self);
748 }
749 }
750 }
751 }
752
753 /// Repeatedly called during `flush_effects` to handle a focused handle being dropped.
754 fn release_dropped_focus_handles(&mut self) {
755 for window_handle in self.windows() {
756 window_handle
757 .update(self, |_, cx| {
758 let mut blur_window = false;
759 let focus = cx.window.focus;
760 cx.window.focus_handles.write().retain(|handle_id, count| {
761 if count.load(SeqCst) == 0 {
762 if focus == Some(handle_id) {
763 blur_window = true;
764 }
765 false
766 } else {
767 true
768 }
769 });
770
771 if blur_window {
772 cx.blur();
773 }
774 })
775 .unwrap();
776 }
777 }
778
779 fn apply_notify_effect(&mut self, emitter: EntityId) {
780 self.pending_notifications.remove(&emitter);
781
782 self.observers
783 .clone()
784 .retain(&emitter, |handler| handler(self));
785 }
786
787 fn apply_emit_effect(&mut self, emitter: EntityId, event_type: TypeId, event: Box<dyn Any>) {
788 self.event_listeners
789 .clone()
790 .retain(&emitter, |(stored_type, handler)| {
791 if *stored_type == event_type {
792 handler(event.as_ref(), self)
793 } else {
794 true
795 }
796 });
797 }
798
799 fn apply_refresh_effect(&mut self) {
800 for window in self.windows.values_mut() {
801 if let Some(window) = window.as_mut() {
802 window.dirty.set(true);
803 }
804 }
805 }
806
807 fn apply_notify_global_observers_effect(&mut self, type_id: TypeId) {
808 self.pending_global_notifications.remove(&type_id);
809 self.global_observers
810 .clone()
811 .retain(&type_id, |observer| observer(self));
812 }
813
814 fn apply_defer_effect(&mut self, callback: Box<dyn FnOnce(&mut Self) + 'static>) {
815 callback(self);
816 }
817
818 /// Creates an `AsyncAppContext`, which can be cloned and has a static lifetime
819 /// so it can be held across `await` points.
820 pub fn to_async(&self) -> AsyncAppContext {
821 AsyncAppContext {
822 app: self.this.clone(),
823 background_executor: self.background_executor.clone(),
824 foreground_executor: self.foreground_executor.clone(),
825 }
826 }
827
828 /// Obtains a reference to the executor, which can be used to spawn futures.
829 pub fn background_executor(&self) -> &BackgroundExecutor {
830 &self.background_executor
831 }
832
833 /// Obtains a reference to the executor, which can be used to spawn futures.
834 pub fn foreground_executor(&self) -> &ForegroundExecutor {
835 &self.foreground_executor
836 }
837
838 /// Spawns the future returned by the given function on the thread pool. The closure will be invoked
839 /// with [AsyncAppContext], which allows the application state to be accessed across await points.
840 pub fn spawn<Fut, R>(&self, f: impl FnOnce(AsyncAppContext) -> Fut) -> Task<R>
841 where
842 Fut: Future<Output = R> + 'static,
843 R: 'static,
844 {
845 self.foreground_executor.spawn(f(self.to_async()))
846 }
847
848 /// Schedules the given function to be run at the end of the current effect cycle, allowing entities
849 /// that are currently on the stack to be returned to the app.
850 pub fn defer(&mut self, f: impl FnOnce(&mut AppContext) + 'static) {
851 self.push_effect(Effect::Defer {
852 callback: Box::new(f),
853 });
854 }
855
856 /// Accessor for the application's asset source, which is provided when constructing the `App`.
857 pub fn asset_source(&self) -> &Arc<dyn AssetSource> {
858 &self.asset_source
859 }
860
861 /// Accessor for the text system.
862 pub fn text_system(&self) -> &Arc<TextSystem> {
863 &self.text_system
864 }
865
866 /// Check whether a global of the given type has been assigned.
867 pub fn has_global<G: Global>(&self) -> bool {
868 self.globals_by_type.contains_key(&TypeId::of::<G>())
869 }
870
871 /// Access the global of the given type. Panics if a global for that type has not been assigned.
872 #[track_caller]
873 pub fn global<G: Global>(&self) -> &G {
874 self.globals_by_type
875 .get(&TypeId::of::<G>())
876 .map(|any_state| any_state.downcast_ref::<G>().unwrap())
877 .ok_or_else(|| anyhow!("no state of type {} exists", type_name::<G>()))
878 .unwrap()
879 }
880
881 /// Access the global of the given type if a value has been assigned.
882 pub fn try_global<G: Global>(&self) -> Option<&G> {
883 self.globals_by_type
884 .get(&TypeId::of::<G>())
885 .map(|any_state| any_state.downcast_ref::<G>().unwrap())
886 }
887
888 /// Access the global of the given type mutably. Panics if a global for that type has not been assigned.
889 #[track_caller]
890 pub fn global_mut<G: Global>(&mut self) -> &mut G {
891 let global_type = TypeId::of::<G>();
892 self.push_effect(Effect::NotifyGlobalObservers { global_type });
893 self.globals_by_type
894 .get_mut(&global_type)
895 .and_then(|any_state| any_state.downcast_mut::<G>())
896 .ok_or_else(|| anyhow!("no state of type {} exists", type_name::<G>()))
897 .unwrap()
898 }
899
900 /// Access the global of the given type mutably. A default value is assigned if a global of this type has not
901 /// yet been assigned.
902 pub fn default_global<G: Global + Default>(&mut self) -> &mut G {
903 let global_type = TypeId::of::<G>();
904 self.push_effect(Effect::NotifyGlobalObservers { global_type });
905 self.globals_by_type
906 .entry(global_type)
907 .or_insert_with(|| Box::<G>::default())
908 .downcast_mut::<G>()
909 .unwrap()
910 }
911
912 /// Sets the value of the global of the given type.
913 pub fn set_global<G: Global>(&mut self, global: G) {
914 let global_type = TypeId::of::<G>();
915 self.push_effect(Effect::NotifyGlobalObservers { global_type });
916 self.globals_by_type.insert(global_type, Box::new(global));
917 }
918
919 /// Clear all stored globals. Does not notify global observers.
920 #[cfg(any(test, feature = "test-support"))]
921 pub fn clear_globals(&mut self) {
922 self.globals_by_type.drain();
923 }
924
925 /// Remove the global of the given type from the app context. Does not notify global observers.
926 pub fn remove_global<G: Global>(&mut self) -> G {
927 let global_type = TypeId::of::<G>();
928 self.push_effect(Effect::NotifyGlobalObservers { global_type });
929 *self
930 .globals_by_type
931 .remove(&global_type)
932 .unwrap_or_else(|| panic!("no global added for {}", std::any::type_name::<G>()))
933 .downcast()
934 .unwrap()
935 }
936
937 /// Register a callback to be invoked when a global of the given type is updated.
938 pub fn observe_global<G: Global>(
939 &mut self,
940 mut f: impl FnMut(&mut Self) + 'static,
941 ) -> Subscription {
942 let (subscription, activate) = self.global_observers.insert(
943 TypeId::of::<G>(),
944 Box::new(move |cx| {
945 f(cx);
946 true
947 }),
948 );
949 self.defer(move |_| activate());
950 subscription
951 }
952
953 /// Move the global of the given type to the stack.
954 pub(crate) fn lease_global<G: Global>(&mut self) -> GlobalLease<G> {
955 GlobalLease::new(
956 self.globals_by_type
957 .remove(&TypeId::of::<G>())
958 .ok_or_else(|| anyhow!("no global registered of type {}", type_name::<G>()))
959 .unwrap(),
960 )
961 }
962
963 /// Restore the global of the given type after it is moved to the stack.
964 pub(crate) fn end_global_lease<G: Global>(&mut self, lease: GlobalLease<G>) {
965 let global_type = TypeId::of::<G>();
966 self.push_effect(Effect::NotifyGlobalObservers { global_type });
967 self.globals_by_type.insert(global_type, lease.global);
968 }
969
970 pub(crate) fn new_view_observer(
971 &mut self,
972 key: TypeId,
973 value: NewViewListener,
974 ) -> Subscription {
975 let (subscription, activate) = self.new_view_observers.insert(key, value);
976 activate();
977 subscription
978 }
979 /// Arrange for the given function to be invoked whenever a view of the specified type is created.
980 /// The function will be passed a mutable reference to the view along with an appropriate context.
981 pub fn observe_new_views<V: 'static>(
982 &mut self,
983 on_new: impl 'static + Fn(&mut V, &mut ViewContext<V>),
984 ) -> Subscription {
985 self.new_view_observer(
986 TypeId::of::<V>(),
987 Box::new(move |any_view: AnyView, cx: &mut WindowContext| {
988 any_view
989 .downcast::<V>()
990 .unwrap()
991 .update(cx, |view_state, cx| {
992 on_new(view_state, cx);
993 })
994 }),
995 )
996 }
997
998 /// Observe the release of a model or view. The callback is invoked after the model or view
999 /// has no more strong references but before it has been dropped.
1000 pub fn observe_release<E, T>(
1001 &mut self,
1002 handle: &E,
1003 on_release: impl FnOnce(&mut T, &mut AppContext) + 'static,
1004 ) -> Subscription
1005 where
1006 E: Entity<T>,
1007 T: 'static,
1008 {
1009 let (subscription, activate) = self.release_listeners.insert(
1010 handle.entity_id(),
1011 Box::new(move |entity, cx| {
1012 let entity = entity.downcast_mut().expect("invalid entity type");
1013 on_release(entity, cx)
1014 }),
1015 );
1016 activate();
1017 subscription
1018 }
1019
1020 /// Register a callback to be invoked when a keystroke is received by the application
1021 /// in any window. Note that this fires after all other action and event mechanisms have resolved
1022 /// and that this API will not be invoked if the event's propagation is stopped.
1023 pub fn observe_keystrokes(
1024 &mut self,
1025 f: impl FnMut(&KeystrokeEvent, &mut WindowContext) + 'static,
1026 ) -> Subscription {
1027 fn inner(
1028 keystroke_observers: &mut SubscriberSet<(), KeystrokeObserver>,
1029 handler: KeystrokeObserver,
1030 ) -> Subscription {
1031 let (subscription, activate) = keystroke_observers.insert((), handler);
1032 activate();
1033 subscription
1034 }
1035 inner(&mut self.keystroke_observers, Box::new(f))
1036 }
1037
1038 /// Register key bindings.
1039 pub fn bind_keys(&mut self, bindings: impl IntoIterator<Item = KeyBinding>) {
1040 self.keymap.borrow_mut().add_bindings(bindings);
1041 self.pending_effects.push_back(Effect::Refresh);
1042 }
1043
1044 /// Clear all key bindings in the app.
1045 pub fn clear_key_bindings(&mut self) {
1046 self.keymap.borrow_mut().clear();
1047 self.pending_effects.push_back(Effect::Refresh);
1048 }
1049
1050 /// Register a global listener for actions invoked via the keyboard.
1051 pub fn on_action<A: Action>(&mut self, listener: impl Fn(&A, &mut Self) + 'static) {
1052 self.global_action_listeners
1053 .entry(TypeId::of::<A>())
1054 .or_default()
1055 .push(Rc::new(move |action, phase, cx| {
1056 if phase == DispatchPhase::Bubble {
1057 let action = action.downcast_ref().unwrap();
1058 listener(action, cx)
1059 }
1060 }));
1061 }
1062
1063 /// Event handlers propagate events by default. Call this method to stop dispatching to
1064 /// event handlers with a lower z-index (mouse) or higher in the tree (keyboard). This is
1065 /// the opposite of [`Self::propagate`]. It's also possible to cancel a call to [`Self::propagate`] by
1066 /// calling this method before effects are flushed.
1067 pub fn stop_propagation(&mut self) {
1068 self.propagate_event = false;
1069 }
1070
1071 /// Action handlers stop propagation by default during the bubble phase of action dispatch
1072 /// dispatching to action handlers higher in the element tree. This is the opposite of
1073 /// [`Self::stop_propagation`]. It's also possible to cancel a call to [`Self::stop_propagation`] by calling
1074 /// this method before effects are flushed.
1075 pub fn propagate(&mut self) {
1076 self.propagate_event = true;
1077 }
1078
1079 /// Build an action from some arbitrary data, typically a keymap entry.
1080 pub fn build_action(
1081 &self,
1082 name: &str,
1083 data: Option<serde_json::Value>,
1084 ) -> Result<Box<dyn Action>> {
1085 self.actions.build_action(name, data)
1086 }
1087
1088 /// Get a list of all action names that have been registered.
1089 /// in the application. Note that registration only allows for
1090 /// actions to be built dynamically, and is unrelated to binding
1091 /// actions in the element tree.
1092 pub fn all_action_names(&self) -> &[SharedString] {
1093 self.actions.all_action_names()
1094 }
1095
1096 /// Register a callback to be invoked when the application is about to quit.
1097 /// It is not possible to cancel the quit event at this point.
1098 pub fn on_app_quit<Fut>(
1099 &mut self,
1100 mut on_quit: impl FnMut(&mut AppContext) -> Fut + 'static,
1101 ) -> Subscription
1102 where
1103 Fut: 'static + Future<Output = ()>,
1104 {
1105 let (subscription, activate) = self.quit_observers.insert(
1106 (),
1107 Box::new(move |cx| {
1108 let future = on_quit(cx);
1109 future.boxed_local()
1110 }),
1111 );
1112 activate();
1113 subscription
1114 }
1115
1116 pub(crate) fn clear_pending_keystrokes(&mut self) {
1117 for window in self.windows() {
1118 window
1119 .update(self, |_, cx| {
1120 cx.window
1121 .rendered_frame
1122 .dispatch_tree
1123 .clear_pending_keystrokes();
1124 cx.window
1125 .next_frame
1126 .dispatch_tree
1127 .clear_pending_keystrokes();
1128 })
1129 .ok();
1130 }
1131 }
1132
1133 /// Checks if the given action is bound in the current context, as defined by the app's current focus,
1134 /// the bindings in the element tree, and any global action listeners.
1135 pub fn is_action_available(&mut self, action: &dyn Action) -> bool {
1136 let mut action_available = false;
1137 if let Some(window) = self.active_window() {
1138 if let Ok(window_action_available) =
1139 window.update(self, |_, cx| cx.is_action_available(action))
1140 {
1141 action_available = window_action_available;
1142 }
1143 }
1144
1145 action_available
1146 || self
1147 .global_action_listeners
1148 .contains_key(&action.as_any().type_id())
1149 }
1150
1151 /// Sets the menu bar for this application. This will replace any existing menu bar.
1152 pub fn set_menus(&mut self, menus: Vec<Menu>) {
1153 self.platform.set_menus(menus, &self.keymap.borrow());
1154 }
1155
1156 /// Adds given path to the bottom of the list of recent paths for the application.
1157 /// The list is usually shown on the application icon's context menu in the dock,
1158 /// and allows to open the recent files via that context menu.
1159 /// If the path is already in the list, it will be moved to the bottom of the list.
1160 pub fn add_recent_document(&mut self, path: &Path) {
1161 self.platform.add_recent_document(path);
1162 }
1163
1164 /// Dispatch an action to the currently active window or global action handler
1165 /// See [action::Action] for more information on how actions work
1166 pub fn dispatch_action(&mut self, action: &dyn Action) {
1167 if let Some(active_window) = self.active_window() {
1168 active_window
1169 .update(self, |_, cx| cx.dispatch_action(action.boxed_clone()))
1170 .log_err();
1171 } else {
1172 self.dispatch_global_action(action);
1173 }
1174 }
1175
1176 fn dispatch_global_action(&mut self, action: &dyn Action) {
1177 self.propagate_event = true;
1178
1179 if let Some(mut global_listeners) = self
1180 .global_action_listeners
1181 .remove(&action.as_any().type_id())
1182 {
1183 for listener in &global_listeners {
1184 listener(action.as_any(), DispatchPhase::Capture, self);
1185 if !self.propagate_event {
1186 break;
1187 }
1188 }
1189
1190 global_listeners.extend(
1191 self.global_action_listeners
1192 .remove(&action.as_any().type_id())
1193 .unwrap_or_default(),
1194 );
1195
1196 self.global_action_listeners
1197 .insert(action.as_any().type_id(), global_listeners);
1198 }
1199
1200 if self.propagate_event {
1201 if let Some(mut global_listeners) = self
1202 .global_action_listeners
1203 .remove(&action.as_any().type_id())
1204 {
1205 for listener in global_listeners.iter().rev() {
1206 listener(action.as_any(), DispatchPhase::Bubble, self);
1207 if !self.propagate_event {
1208 break;
1209 }
1210 }
1211
1212 global_listeners.extend(
1213 self.global_action_listeners
1214 .remove(&action.as_any().type_id())
1215 .unwrap_or_default(),
1216 );
1217
1218 self.global_action_listeners
1219 .insert(action.as_any().type_id(), global_listeners);
1220 }
1221 }
1222 }
1223
1224 /// Is there currently something being dragged?
1225 pub fn has_active_drag(&self) -> bool {
1226 self.active_drag.is_some()
1227 }
1228
1229 /// Set the prompt renderer for GPUI. This will replace the default or platform specific
1230 /// prompts with this custom implementation.
1231 pub fn set_prompt_builder(
1232 &mut self,
1233 renderer: impl Fn(
1234 PromptLevel,
1235 &str,
1236 Option<&str>,
1237 &[&str],
1238 PromptHandle,
1239 &mut WindowContext,
1240 ) -> RenderablePromptHandle
1241 + 'static,
1242 ) {
1243 self.prompt_builder = Some(PromptBuilder::Custom(Box::new(renderer)))
1244 }
1245}
1246
1247impl Context for AppContext {
1248 type Result<T> = T;
1249
1250 /// Build an entity that is owned by the application. The given function will be invoked with
1251 /// a `ModelContext` and must return an object representing the entity. A `Model` handle will be returned,
1252 /// which can be used to access the entity in a context.
1253 fn new_model<T: 'static>(
1254 &mut self,
1255 build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T,
1256 ) -> Model<T> {
1257 self.update(|cx| {
1258 let slot = cx.entities.reserve();
1259 let entity = build_model(&mut ModelContext::new(cx, slot.downgrade()));
1260 cx.entities.insert(slot, entity)
1261 })
1262 }
1263
1264 fn reserve_model<T: 'static>(&mut self) -> Self::Result<Reservation<T>> {
1265 Reservation(self.entities.reserve())
1266 }
1267
1268 fn insert_model<T: 'static>(
1269 &mut self,
1270 reservation: Reservation<T>,
1271 build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T,
1272 ) -> Self::Result<Model<T>> {
1273 self.update(|cx| {
1274 let slot = reservation.0;
1275 let entity = build_model(&mut ModelContext::new(cx, slot.downgrade()));
1276 cx.entities.insert(slot, entity)
1277 })
1278 }
1279
1280 /// Updates the entity referenced by the given model. The function is passed a mutable reference to the
1281 /// entity along with a `ModelContext` for the entity.
1282 fn update_model<T: 'static, R>(
1283 &mut self,
1284 model: &Model<T>,
1285 update: impl FnOnce(&mut T, &mut ModelContext<'_, T>) -> R,
1286 ) -> R {
1287 self.update(|cx| {
1288 let mut entity = cx.entities.lease(model);
1289 let result = update(&mut entity, &mut ModelContext::new(cx, model.downgrade()));
1290 cx.entities.end_lease(entity);
1291 result
1292 })
1293 }
1294
1295 fn read_model<T, R>(
1296 &self,
1297 handle: &Model<T>,
1298 read: impl FnOnce(&T, &AppContext) -> R,
1299 ) -> Self::Result<R>
1300 where
1301 T: 'static,
1302 {
1303 let entity = self.entities.read(handle);
1304 read(entity, self)
1305 }
1306
1307 fn update_window<T, F>(&mut self, handle: AnyWindowHandle, update: F) -> Result<T>
1308 where
1309 F: FnOnce(AnyView, &mut WindowContext<'_>) -> T,
1310 {
1311 self.update(|cx| {
1312 let mut window = cx
1313 .windows
1314 .get_mut(handle.id)
1315 .ok_or_else(|| anyhow!("window not found"))?
1316 .take()
1317 .ok_or_else(|| anyhow!("window not found"))?;
1318
1319 let root_view = window.root_view.clone().unwrap();
1320 let result = update(root_view, &mut WindowContext::new(cx, &mut window));
1321
1322 if window.removed {
1323 cx.window_handles.remove(&handle.id);
1324 cx.windows.remove(handle.id);
1325 } else {
1326 cx.windows
1327 .get_mut(handle.id)
1328 .ok_or_else(|| anyhow!("window not found"))?
1329 .replace(window);
1330 }
1331
1332 Ok(result)
1333 })
1334 }
1335
1336 fn read_window<T, R>(
1337 &self,
1338 window: &WindowHandle<T>,
1339 read: impl FnOnce(View<T>, &AppContext) -> R,
1340 ) -> Result<R>
1341 where
1342 T: 'static,
1343 {
1344 let window = self
1345 .windows
1346 .get(window.id)
1347 .ok_or_else(|| anyhow!("window not found"))?
1348 .as_ref()
1349 .unwrap();
1350
1351 let root_view = window.root_view.clone().unwrap();
1352 let view = root_view
1353 .downcast::<T>()
1354 .map_err(|_| anyhow!("root view's type has changed"))?;
1355
1356 Ok(read(view, self))
1357 }
1358}
1359
1360/// These effects are processed at the end of each application update cycle.
1361pub(crate) enum Effect {
1362 Notify {
1363 emitter: EntityId,
1364 },
1365 Emit {
1366 emitter: EntityId,
1367 event_type: TypeId,
1368 event: Box<dyn Any>,
1369 },
1370 Refresh,
1371 NotifyGlobalObservers {
1372 global_type: TypeId,
1373 },
1374 Defer {
1375 callback: Box<dyn FnOnce(&mut AppContext) + 'static>,
1376 },
1377}
1378
1379/// Wraps a global variable value during `update_global` while the value has been moved to the stack.
1380pub(crate) struct GlobalLease<G: Global> {
1381 global: Box<dyn Any>,
1382 global_type: PhantomData<G>,
1383}
1384
1385impl<G: Global> GlobalLease<G> {
1386 fn new(global: Box<dyn Any>) -> Self {
1387 GlobalLease {
1388 global,
1389 global_type: PhantomData,
1390 }
1391 }
1392}
1393
1394impl<G: Global> Deref for GlobalLease<G> {
1395 type Target = G;
1396
1397 fn deref(&self) -> &Self::Target {
1398 self.global.downcast_ref().unwrap()
1399 }
1400}
1401
1402impl<G: Global> DerefMut for GlobalLease<G> {
1403 fn deref_mut(&mut self) -> &mut Self::Target {
1404 self.global.downcast_mut().unwrap()
1405 }
1406}
1407
1408/// Contains state associated with an active drag operation, started by dragging an element
1409/// within the window or by dragging into the app from the underlying platform.
1410pub struct AnyDrag {
1411 /// The view used to render this drag
1412 pub view: AnyView,
1413
1414 /// The value of the dragged item, to be dropped
1415 pub value: Box<dyn Any>,
1416
1417 /// This is used to render the dragged item in the same place
1418 /// on the original element that the drag was initiated
1419 pub cursor_offset: Point<Pixels>,
1420}
1421
1422/// Contains state associated with a tooltip. You'll only need this struct if you're implementing
1423/// tooltip behavior on a custom element. Otherwise, use [Div::tooltip].
1424#[derive(Clone)]
1425pub struct AnyTooltip {
1426 /// The view used to display the tooltip
1427 pub view: AnyView,
1428
1429 /// The absolute position of the mouse when the tooltip was deployed.
1430 pub mouse_position: Point<Pixels>,
1431}
1432
1433/// A keystroke event, and potentially the associated action
1434#[derive(Debug)]
1435pub struct KeystrokeEvent {
1436 /// The keystroke that occurred
1437 pub keystroke: Keystroke,
1438
1439 /// The action that was resolved for the keystroke, if any
1440 pub action: Option<Box<dyn Action>>,
1441}