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, MenuItem, PathPromptOptions, Pixels, Platform, PlatformDisplay,
33 Point, 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(None),
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 /// Returns Ok() if the platform supports opening windows.
506 /// This returns false (for example) on linux when we could
507 /// not establish a connection to X or Wayland.
508 pub fn can_open_windows(&self) -> anyhow::Result<()> {
509 self.platform.can_open_windows()
510 }
511
512 /// Instructs the platform to activate the application by bringing it to the foreground.
513 pub fn activate(&self, ignoring_other_apps: bool) {
514 self.platform.activate(ignoring_other_apps);
515 }
516
517 /// Hide the application at the platform level.
518 pub fn hide(&self) {
519 self.platform.hide();
520 }
521
522 /// Hide other applications at the platform level.
523 pub fn hide_other_apps(&self) {
524 self.platform.hide_other_apps();
525 }
526
527 /// Unhide other applications at the platform level.
528 pub fn unhide_other_apps(&self) {
529 self.platform.unhide_other_apps();
530 }
531
532 /// Returns the list of currently active displays.
533 pub fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
534 self.platform.displays()
535 }
536
537 /// Returns the primary display that will be used for new windows.
538 pub fn primary_display(&self) -> Option<Rc<dyn PlatformDisplay>> {
539 self.platform.primary_display()
540 }
541
542 /// Returns the display with the given ID, if one exists.
543 pub fn find_display(&self, id: DisplayId) -> Option<Rc<dyn PlatformDisplay>> {
544 self.displays()
545 .iter()
546 .find(|display| display.id() == id)
547 .cloned()
548 }
549
550 /// Returns the appearance of the application's windows.
551 pub fn window_appearance(&self) -> WindowAppearance {
552 self.platform.window_appearance()
553 }
554
555 /// Writes data to the primary selection buffer.
556 /// Only available on Linux.
557 #[cfg(target_os = "linux")]
558 pub fn write_to_primary(&self, item: ClipboardItem) {
559 self.platform.write_to_primary(item)
560 }
561
562 /// Writes data to the platform clipboard.
563 pub fn write_to_clipboard(&self, item: ClipboardItem) {
564 self.platform.write_to_clipboard(item)
565 }
566
567 /// Reads data from the primary selection buffer.
568 /// Only available on Linux.
569 #[cfg(target_os = "linux")]
570 pub fn read_from_primary(&self) -> Option<ClipboardItem> {
571 self.platform.read_from_primary()
572 }
573
574 /// Reads data from the platform clipboard.
575 pub fn read_from_clipboard(&self) -> Option<ClipboardItem> {
576 self.platform.read_from_clipboard()
577 }
578
579 /// Writes credentials to the platform keychain.
580 pub fn write_credentials(
581 &self,
582 url: &str,
583 username: &str,
584 password: &[u8],
585 ) -> Task<Result<()>> {
586 self.platform.write_credentials(url, username, password)
587 }
588
589 /// Reads credentials from the platform keychain.
590 pub fn read_credentials(&self, url: &str) -> Task<Result<Option<(String, Vec<u8>)>>> {
591 self.platform.read_credentials(url)
592 }
593
594 /// Deletes credentials from the platform keychain.
595 pub fn delete_credentials(&self, url: &str) -> Task<Result<()>> {
596 self.platform.delete_credentials(url)
597 }
598
599 /// Directs the platform's default browser to open the given URL.
600 pub fn open_url(&self, url: &str) {
601 self.platform.open_url(url);
602 }
603
604 /// register_url_scheme requests that the given scheme (e.g. `zed` for `zed://` urls)
605 /// is opened by the current app.
606 /// On some platforms (e.g. macOS) you may be able to register URL schemes as part of app
607 /// distribution, but this method exists to let you register schemes at runtime.
608 pub fn register_url_scheme(&self, scheme: &str) -> Task<Result<()>> {
609 self.platform.register_url_scheme(scheme)
610 }
611
612 /// Returns the full pathname of the current app bundle.
613 /// If the app is not being run from a bundle, returns an error.
614 pub fn app_path(&self) -> Result<PathBuf> {
615 self.platform.app_path()
616 }
617
618 /// Returns the file URL of the executable with the specified name in the application bundle
619 pub fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf> {
620 self.platform.path_for_auxiliary_executable(name)
621 }
622
623 /// Displays a platform modal for selecting paths.
624 /// When one or more paths are selected, they'll be relayed asynchronously via the returned oneshot channel.
625 /// If cancelled, a `None` will be relayed instead.
626 pub fn prompt_for_paths(
627 &self,
628 options: PathPromptOptions,
629 ) -> oneshot::Receiver<Option<Vec<PathBuf>>> {
630 self.platform.prompt_for_paths(options)
631 }
632
633 /// Displays a platform modal for selecting a new path where a file can be saved.
634 /// The provided directory will be used to set the initial location.
635 /// When a path is selected, it is relayed asynchronously via the returned oneshot channel.
636 /// If cancelled, a `None` will be relayed instead.
637 pub fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>> {
638 self.platform.prompt_for_new_path(directory)
639 }
640
641 /// Reveals the specified path at the platform level, such as in Finder on macOS.
642 pub fn reveal_path(&self, path: &Path) {
643 self.platform.reveal_path(path)
644 }
645
646 /// Returns whether the user has configured scrollbars to auto-hide at the platform level.
647 pub fn should_auto_hide_scrollbars(&self) -> bool {
648 self.platform.should_auto_hide_scrollbars()
649 }
650
651 /// Restart the application.
652 pub fn restart(&self, binary_path: Option<PathBuf>) {
653 self.platform.restart(binary_path)
654 }
655
656 /// Returns the local timezone at the platform level.
657 pub fn local_timezone(&self) -> UtcOffset {
658 self.platform.local_timezone()
659 }
660
661 /// Updates the http client assigned to GPUI
662 pub fn update_http_client(&mut self, new_client: Arc<dyn HttpClient>) {
663 self.http_client = new_client;
664 }
665
666 /// Returns the http client assigned to GPUI
667 pub fn http_client(&self) -> Arc<dyn HttpClient> {
668 self.http_client.clone()
669 }
670
671 /// Returns the SVG renderer GPUI uses
672 pub(crate) fn svg_renderer(&self) -> SvgRenderer {
673 self.svg_renderer.clone()
674 }
675
676 pub(crate) fn push_effect(&mut self, effect: Effect) {
677 match &effect {
678 Effect::Notify { emitter } => {
679 if !self.pending_notifications.insert(*emitter) {
680 return;
681 }
682 }
683 Effect::NotifyGlobalObservers { global_type } => {
684 if !self.pending_global_notifications.insert(*global_type) {
685 return;
686 }
687 }
688 _ => {}
689 };
690
691 self.pending_effects.push_back(effect);
692 }
693
694 /// Called at the end of [`AppContext::update`] to complete any side effects
695 /// such as notifying observers, emitting events, etc. Effects can themselves
696 /// cause effects, so we continue looping until all effects are processed.
697 fn flush_effects(&mut self) {
698 loop {
699 self.release_dropped_entities();
700 self.release_dropped_focus_handles();
701
702 if let Some(effect) = self.pending_effects.pop_front() {
703 match effect {
704 Effect::Notify { emitter } => {
705 self.apply_notify_effect(emitter);
706 }
707
708 Effect::Emit {
709 emitter,
710 event_type,
711 event,
712 } => self.apply_emit_effect(emitter, event_type, event),
713
714 Effect::Refresh => {
715 self.apply_refresh_effect();
716 }
717
718 Effect::NotifyGlobalObservers { global_type } => {
719 self.apply_notify_global_observers_effect(global_type);
720 }
721
722 Effect::Defer { callback } => {
723 self.apply_defer_effect(callback);
724 }
725 }
726 } else {
727 #[cfg(any(test, feature = "test-support"))]
728 for window in self
729 .windows
730 .values()
731 .filter_map(|window| {
732 let window = window.as_ref()?;
733 window.dirty.get().then_some(window.handle)
734 })
735 .collect::<Vec<_>>()
736 {
737 self.update_window(window, |_, cx| cx.draw()).unwrap();
738 }
739
740 if self.pending_effects.is_empty() {
741 break;
742 }
743 }
744 }
745 }
746
747 /// Repeatedly called during `flush_effects` to release any entities whose
748 /// reference count has become zero. We invoke any release observers before dropping
749 /// each entity.
750 fn release_dropped_entities(&mut self) {
751 loop {
752 let dropped = self.entities.take_dropped();
753 if dropped.is_empty() {
754 break;
755 }
756
757 for (entity_id, mut entity) in dropped {
758 self.observers.remove(&entity_id);
759 self.event_listeners.remove(&entity_id);
760 for release_callback in self.release_listeners.remove(&entity_id) {
761 release_callback(entity.as_mut(), self);
762 }
763 }
764 }
765 }
766
767 /// Repeatedly called during `flush_effects` to handle a focused handle being dropped.
768 fn release_dropped_focus_handles(&mut self) {
769 for window_handle in self.windows() {
770 window_handle
771 .update(self, |_, cx| {
772 let mut blur_window = false;
773 let focus = cx.window.focus;
774 cx.window.focus_handles.write().retain(|handle_id, count| {
775 if count.load(SeqCst) == 0 {
776 if focus == Some(handle_id) {
777 blur_window = true;
778 }
779 false
780 } else {
781 true
782 }
783 });
784
785 if blur_window {
786 cx.blur();
787 }
788 })
789 .unwrap();
790 }
791 }
792
793 fn apply_notify_effect(&mut self, emitter: EntityId) {
794 self.pending_notifications.remove(&emitter);
795
796 self.observers
797 .clone()
798 .retain(&emitter, |handler| handler(self));
799 }
800
801 fn apply_emit_effect(&mut self, emitter: EntityId, event_type: TypeId, event: Box<dyn Any>) {
802 self.event_listeners
803 .clone()
804 .retain(&emitter, |(stored_type, handler)| {
805 if *stored_type == event_type {
806 handler(event.as_ref(), self)
807 } else {
808 true
809 }
810 });
811 }
812
813 fn apply_refresh_effect(&mut self) {
814 for window in self.windows.values_mut() {
815 if let Some(window) = window.as_mut() {
816 window.dirty.set(true);
817 }
818 }
819 }
820
821 fn apply_notify_global_observers_effect(&mut self, type_id: TypeId) {
822 self.pending_global_notifications.remove(&type_id);
823 self.global_observers
824 .clone()
825 .retain(&type_id, |observer| observer(self));
826 }
827
828 fn apply_defer_effect(&mut self, callback: Box<dyn FnOnce(&mut Self) + 'static>) {
829 callback(self);
830 }
831
832 /// Creates an `AsyncAppContext`, which can be cloned and has a static lifetime
833 /// so it can be held across `await` points.
834 pub fn to_async(&self) -> AsyncAppContext {
835 AsyncAppContext {
836 app: self.this.clone(),
837 background_executor: self.background_executor.clone(),
838 foreground_executor: self.foreground_executor.clone(),
839 }
840 }
841
842 /// Obtains a reference to the executor, which can be used to spawn futures.
843 pub fn background_executor(&self) -> &BackgroundExecutor {
844 &self.background_executor
845 }
846
847 /// Obtains a reference to the executor, which can be used to spawn futures.
848 pub fn foreground_executor(&self) -> &ForegroundExecutor {
849 &self.foreground_executor
850 }
851
852 /// Spawns the future returned by the given function on the thread pool. The closure will be invoked
853 /// with [AsyncAppContext], which allows the application state to be accessed across await points.
854 pub fn spawn<Fut, R>(&self, f: impl FnOnce(AsyncAppContext) -> Fut) -> Task<R>
855 where
856 Fut: Future<Output = R> + 'static,
857 R: 'static,
858 {
859 self.foreground_executor.spawn(f(self.to_async()))
860 }
861
862 /// Schedules the given function to be run at the end of the current effect cycle, allowing entities
863 /// that are currently on the stack to be returned to the app.
864 pub fn defer(&mut self, f: impl FnOnce(&mut AppContext) + 'static) {
865 self.push_effect(Effect::Defer {
866 callback: Box::new(f),
867 });
868 }
869
870 /// Accessor for the application's asset source, which is provided when constructing the `App`.
871 pub fn asset_source(&self) -> &Arc<dyn AssetSource> {
872 &self.asset_source
873 }
874
875 /// Accessor for the text system.
876 pub fn text_system(&self) -> &Arc<TextSystem> {
877 &self.text_system
878 }
879
880 /// Check whether a global of the given type has been assigned.
881 pub fn has_global<G: Global>(&self) -> bool {
882 self.globals_by_type.contains_key(&TypeId::of::<G>())
883 }
884
885 /// Access the global of the given type. Panics if a global for that type has not been assigned.
886 #[track_caller]
887 pub fn global<G: Global>(&self) -> &G {
888 self.globals_by_type
889 .get(&TypeId::of::<G>())
890 .map(|any_state| any_state.downcast_ref::<G>().unwrap())
891 .ok_or_else(|| anyhow!("no state of type {} exists", type_name::<G>()))
892 .unwrap()
893 }
894
895 /// Access the global of the given type if a value has been assigned.
896 pub fn try_global<G: Global>(&self) -> Option<&G> {
897 self.globals_by_type
898 .get(&TypeId::of::<G>())
899 .map(|any_state| any_state.downcast_ref::<G>().unwrap())
900 }
901
902 /// Access the global of the given type mutably. Panics if a global for that type has not been assigned.
903 #[track_caller]
904 pub fn global_mut<G: Global>(&mut self) -> &mut G {
905 let global_type = TypeId::of::<G>();
906 self.push_effect(Effect::NotifyGlobalObservers { global_type });
907 self.globals_by_type
908 .get_mut(&global_type)
909 .and_then(|any_state| any_state.downcast_mut::<G>())
910 .ok_or_else(|| anyhow!("no state of type {} exists", type_name::<G>()))
911 .unwrap()
912 }
913
914 /// Access the global of the given type mutably. A default value is assigned if a global of this type has not
915 /// yet been assigned.
916 pub fn default_global<G: Global + Default>(&mut self) -> &mut G {
917 let global_type = TypeId::of::<G>();
918 self.push_effect(Effect::NotifyGlobalObservers { global_type });
919 self.globals_by_type
920 .entry(global_type)
921 .or_insert_with(|| Box::<G>::default())
922 .downcast_mut::<G>()
923 .unwrap()
924 }
925
926 /// Sets the value of the global of the given type.
927 pub fn set_global<G: Global>(&mut self, global: G) {
928 let global_type = TypeId::of::<G>();
929 self.push_effect(Effect::NotifyGlobalObservers { global_type });
930 self.globals_by_type.insert(global_type, Box::new(global));
931 }
932
933 /// Clear all stored globals. Does not notify global observers.
934 #[cfg(any(test, feature = "test-support"))]
935 pub fn clear_globals(&mut self) {
936 self.globals_by_type.drain();
937 }
938
939 /// Remove the global of the given type from the app context. Does not notify global observers.
940 pub fn remove_global<G: Global>(&mut self) -> G {
941 let global_type = TypeId::of::<G>();
942 self.push_effect(Effect::NotifyGlobalObservers { global_type });
943 *self
944 .globals_by_type
945 .remove(&global_type)
946 .unwrap_or_else(|| panic!("no global added for {}", std::any::type_name::<G>()))
947 .downcast()
948 .unwrap()
949 }
950
951 /// Register a callback to be invoked when a global of the given type is updated.
952 pub fn observe_global<G: Global>(
953 &mut self,
954 mut f: impl FnMut(&mut Self) + 'static,
955 ) -> Subscription {
956 let (subscription, activate) = self.global_observers.insert(
957 TypeId::of::<G>(),
958 Box::new(move |cx| {
959 f(cx);
960 true
961 }),
962 );
963 self.defer(move |_| activate());
964 subscription
965 }
966
967 /// Move the global of the given type to the stack.
968 pub(crate) fn lease_global<G: Global>(&mut self) -> GlobalLease<G> {
969 GlobalLease::new(
970 self.globals_by_type
971 .remove(&TypeId::of::<G>())
972 .ok_or_else(|| anyhow!("no global registered of type {}", type_name::<G>()))
973 .unwrap(),
974 )
975 }
976
977 /// Restore the global of the given type after it is moved to the stack.
978 pub(crate) fn end_global_lease<G: Global>(&mut self, lease: GlobalLease<G>) {
979 let global_type = TypeId::of::<G>();
980 self.push_effect(Effect::NotifyGlobalObservers { global_type });
981 self.globals_by_type.insert(global_type, lease.global);
982 }
983
984 pub(crate) fn new_view_observer(
985 &mut self,
986 key: TypeId,
987 value: NewViewListener,
988 ) -> Subscription {
989 let (subscription, activate) = self.new_view_observers.insert(key, value);
990 activate();
991 subscription
992 }
993 /// Arrange for the given function to be invoked whenever a view of the specified type is created.
994 /// The function will be passed a mutable reference to the view along with an appropriate context.
995 pub fn observe_new_views<V: 'static>(
996 &mut self,
997 on_new: impl 'static + Fn(&mut V, &mut ViewContext<V>),
998 ) -> Subscription {
999 self.new_view_observer(
1000 TypeId::of::<V>(),
1001 Box::new(move |any_view: AnyView, cx: &mut WindowContext| {
1002 any_view
1003 .downcast::<V>()
1004 .unwrap()
1005 .update(cx, |view_state, cx| {
1006 on_new(view_state, cx);
1007 })
1008 }),
1009 )
1010 }
1011
1012 /// Observe the release of a model or view. The callback is invoked after the model or view
1013 /// has no more strong references but before it has been dropped.
1014 pub fn observe_release<E, T>(
1015 &mut self,
1016 handle: &E,
1017 on_release: impl FnOnce(&mut T, &mut AppContext) + 'static,
1018 ) -> Subscription
1019 where
1020 E: Entity<T>,
1021 T: 'static,
1022 {
1023 let (subscription, activate) = self.release_listeners.insert(
1024 handle.entity_id(),
1025 Box::new(move |entity, cx| {
1026 let entity = entity.downcast_mut().expect("invalid entity type");
1027 on_release(entity, cx)
1028 }),
1029 );
1030 activate();
1031 subscription
1032 }
1033
1034 /// Register a callback to be invoked when a keystroke is received by the application
1035 /// in any window. Note that this fires after all other action and event mechanisms have resolved
1036 /// and that this API will not be invoked if the event's propagation is stopped.
1037 pub fn observe_keystrokes(
1038 &mut self,
1039 f: impl FnMut(&KeystrokeEvent, &mut WindowContext) + 'static,
1040 ) -> Subscription {
1041 fn inner(
1042 keystroke_observers: &mut SubscriberSet<(), KeystrokeObserver>,
1043 handler: KeystrokeObserver,
1044 ) -> Subscription {
1045 let (subscription, activate) = keystroke_observers.insert((), handler);
1046 activate();
1047 subscription
1048 }
1049 inner(&mut self.keystroke_observers, Box::new(f))
1050 }
1051
1052 /// Register key bindings.
1053 pub fn bind_keys(&mut self, bindings: impl IntoIterator<Item = KeyBinding>) {
1054 self.keymap.borrow_mut().add_bindings(bindings);
1055 self.pending_effects.push_back(Effect::Refresh);
1056 }
1057
1058 /// Clear all key bindings in the app.
1059 pub fn clear_key_bindings(&mut self) {
1060 self.keymap.borrow_mut().clear();
1061 self.pending_effects.push_back(Effect::Refresh);
1062 }
1063
1064 /// Register a global listener for actions invoked via the keyboard.
1065 pub fn on_action<A: Action>(&mut self, listener: impl Fn(&A, &mut Self) + 'static) {
1066 self.global_action_listeners
1067 .entry(TypeId::of::<A>())
1068 .or_default()
1069 .push(Rc::new(move |action, phase, cx| {
1070 if phase == DispatchPhase::Bubble {
1071 let action = action.downcast_ref().unwrap();
1072 listener(action, cx)
1073 }
1074 }));
1075 }
1076
1077 /// Event handlers propagate events by default. Call this method to stop dispatching to
1078 /// event handlers with a lower z-index (mouse) or higher in the tree (keyboard). This is
1079 /// the opposite of [`Self::propagate`]. It's also possible to cancel a call to [`Self::propagate`] by
1080 /// calling this method before effects are flushed.
1081 pub fn stop_propagation(&mut self) {
1082 self.propagate_event = false;
1083 }
1084
1085 /// Action handlers stop propagation by default during the bubble phase of action dispatch
1086 /// dispatching to action handlers higher in the element tree. This is the opposite of
1087 /// [`Self::stop_propagation`]. It's also possible to cancel a call to [`Self::stop_propagation`] by calling
1088 /// this method before effects are flushed.
1089 pub fn propagate(&mut self) {
1090 self.propagate_event = true;
1091 }
1092
1093 /// Build an action from some arbitrary data, typically a keymap entry.
1094 pub fn build_action(
1095 &self,
1096 name: &str,
1097 data: Option<serde_json::Value>,
1098 ) -> Result<Box<dyn Action>> {
1099 self.actions.build_action(name, data)
1100 }
1101
1102 /// Get a list of all action names that have been registered.
1103 /// in the application. Note that registration only allows for
1104 /// actions to be built dynamically, and is unrelated to binding
1105 /// actions in the element tree.
1106 pub fn all_action_names(&self) -> &[SharedString] {
1107 self.actions.all_action_names()
1108 }
1109
1110 /// Register a callback to be invoked when the application is about to quit.
1111 /// It is not possible to cancel the quit event at this point.
1112 pub fn on_app_quit<Fut>(
1113 &mut self,
1114 mut on_quit: impl FnMut(&mut AppContext) -> Fut + 'static,
1115 ) -> Subscription
1116 where
1117 Fut: 'static + Future<Output = ()>,
1118 {
1119 let (subscription, activate) = self.quit_observers.insert(
1120 (),
1121 Box::new(move |cx| {
1122 let future = on_quit(cx);
1123 future.boxed_local()
1124 }),
1125 );
1126 activate();
1127 subscription
1128 }
1129
1130 pub(crate) fn clear_pending_keystrokes(&mut self) {
1131 for window in self.windows() {
1132 window
1133 .update(self, |_, cx| {
1134 cx.window
1135 .rendered_frame
1136 .dispatch_tree
1137 .clear_pending_keystrokes();
1138 cx.window
1139 .next_frame
1140 .dispatch_tree
1141 .clear_pending_keystrokes();
1142 })
1143 .ok();
1144 }
1145 }
1146
1147 /// Checks if the given action is bound in the current context, as defined by the app's current focus,
1148 /// the bindings in the element tree, and any global action listeners.
1149 pub fn is_action_available(&mut self, action: &dyn Action) -> bool {
1150 let mut action_available = false;
1151 if let Some(window) = self.active_window() {
1152 if let Ok(window_action_available) =
1153 window.update(self, |_, cx| cx.is_action_available(action))
1154 {
1155 action_available = window_action_available;
1156 }
1157 }
1158
1159 action_available
1160 || self
1161 .global_action_listeners
1162 .contains_key(&action.as_any().type_id())
1163 }
1164
1165 /// Sets the menu bar for this application. This will replace any existing menu bar.
1166 pub fn set_menus(&mut self, menus: Vec<Menu>) {
1167 self.platform.set_menus(menus, &self.keymap.borrow());
1168 }
1169
1170 /// Sets the right click menu for the app icon in the dock
1171 pub fn set_dock_menu(&mut self, menus: Vec<MenuItem>) {
1172 self.platform.set_dock_menu(menus, &self.keymap.borrow());
1173 }
1174
1175 /// Adds given path to the bottom of the list of recent paths for the application.
1176 /// The list is usually shown on the application icon's context menu in the dock,
1177 /// and allows to open the recent files via that context menu.
1178 /// If the path is already in the list, it will be moved to the bottom of the list.
1179 pub fn add_recent_document(&mut self, path: &Path) {
1180 self.platform.add_recent_document(path);
1181 }
1182
1183 /// Dispatch an action to the currently active window or global action handler
1184 /// See [action::Action] for more information on how actions work
1185 pub fn dispatch_action(&mut self, action: &dyn Action) {
1186 if let Some(active_window) = self.active_window() {
1187 active_window
1188 .update(self, |_, cx| cx.dispatch_action(action.boxed_clone()))
1189 .log_err();
1190 } else {
1191 self.dispatch_global_action(action);
1192 }
1193 }
1194
1195 fn dispatch_global_action(&mut self, action: &dyn Action) {
1196 self.propagate_event = true;
1197
1198 if let Some(mut global_listeners) = self
1199 .global_action_listeners
1200 .remove(&action.as_any().type_id())
1201 {
1202 for listener in &global_listeners {
1203 listener(action.as_any(), DispatchPhase::Capture, self);
1204 if !self.propagate_event {
1205 break;
1206 }
1207 }
1208
1209 global_listeners.extend(
1210 self.global_action_listeners
1211 .remove(&action.as_any().type_id())
1212 .unwrap_or_default(),
1213 );
1214
1215 self.global_action_listeners
1216 .insert(action.as_any().type_id(), global_listeners);
1217 }
1218
1219 if self.propagate_event {
1220 if let Some(mut global_listeners) = self
1221 .global_action_listeners
1222 .remove(&action.as_any().type_id())
1223 {
1224 for listener in global_listeners.iter().rev() {
1225 listener(action.as_any(), DispatchPhase::Bubble, self);
1226 if !self.propagate_event {
1227 break;
1228 }
1229 }
1230
1231 global_listeners.extend(
1232 self.global_action_listeners
1233 .remove(&action.as_any().type_id())
1234 .unwrap_or_default(),
1235 );
1236
1237 self.global_action_listeners
1238 .insert(action.as_any().type_id(), global_listeners);
1239 }
1240 }
1241 }
1242
1243 /// Is there currently something being dragged?
1244 pub fn has_active_drag(&self) -> bool {
1245 self.active_drag.is_some()
1246 }
1247
1248 /// Set the prompt renderer for GPUI. This will replace the default or platform specific
1249 /// prompts with this custom implementation.
1250 pub fn set_prompt_builder(
1251 &mut self,
1252 renderer: impl Fn(
1253 PromptLevel,
1254 &str,
1255 Option<&str>,
1256 &[&str],
1257 PromptHandle,
1258 &mut WindowContext,
1259 ) -> RenderablePromptHandle
1260 + 'static,
1261 ) {
1262 self.prompt_builder = Some(PromptBuilder::Custom(Box::new(renderer)))
1263 }
1264}
1265
1266impl Context for AppContext {
1267 type Result<T> = T;
1268
1269 /// Build an entity that is owned by the application. The given function will be invoked with
1270 /// a `ModelContext` and must return an object representing the entity. A `Model` handle will be returned,
1271 /// which can be used to access the entity in a context.
1272 fn new_model<T: 'static>(
1273 &mut self,
1274 build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T,
1275 ) -> Model<T> {
1276 self.update(|cx| {
1277 let slot = cx.entities.reserve();
1278 let entity = build_model(&mut ModelContext::new(cx, slot.downgrade()));
1279 cx.entities.insert(slot, entity)
1280 })
1281 }
1282
1283 fn reserve_model<T: 'static>(&mut self) -> Self::Result<Reservation<T>> {
1284 Reservation(self.entities.reserve())
1285 }
1286
1287 fn insert_model<T: 'static>(
1288 &mut self,
1289 reservation: Reservation<T>,
1290 build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T,
1291 ) -> Self::Result<Model<T>> {
1292 self.update(|cx| {
1293 let slot = reservation.0;
1294 let entity = build_model(&mut ModelContext::new(cx, slot.downgrade()));
1295 cx.entities.insert(slot, entity)
1296 })
1297 }
1298
1299 /// Updates the entity referenced by the given model. The function is passed a mutable reference to the
1300 /// entity along with a `ModelContext` for the entity.
1301 fn update_model<T: 'static, R>(
1302 &mut self,
1303 model: &Model<T>,
1304 update: impl FnOnce(&mut T, &mut ModelContext<'_, T>) -> R,
1305 ) -> R {
1306 self.update(|cx| {
1307 let mut entity = cx.entities.lease(model);
1308 let result = update(&mut entity, &mut ModelContext::new(cx, model.downgrade()));
1309 cx.entities.end_lease(entity);
1310 result
1311 })
1312 }
1313
1314 fn read_model<T, R>(
1315 &self,
1316 handle: &Model<T>,
1317 read: impl FnOnce(&T, &AppContext) -> R,
1318 ) -> Self::Result<R>
1319 where
1320 T: 'static,
1321 {
1322 let entity = self.entities.read(handle);
1323 read(entity, self)
1324 }
1325
1326 fn update_window<T, F>(&mut self, handle: AnyWindowHandle, update: F) -> Result<T>
1327 where
1328 F: FnOnce(AnyView, &mut WindowContext<'_>) -> T,
1329 {
1330 self.update(|cx| {
1331 let mut window = cx
1332 .windows
1333 .get_mut(handle.id)
1334 .ok_or_else(|| anyhow!("window not found"))?
1335 .take()
1336 .ok_or_else(|| anyhow!("window not found"))?;
1337
1338 let root_view = window.root_view.clone().unwrap();
1339 let result = update(root_view, &mut WindowContext::new(cx, &mut window));
1340
1341 if window.removed {
1342 cx.window_handles.remove(&handle.id);
1343 cx.windows.remove(handle.id);
1344 } else {
1345 cx.windows
1346 .get_mut(handle.id)
1347 .ok_or_else(|| anyhow!("window not found"))?
1348 .replace(window);
1349 }
1350
1351 Ok(result)
1352 })
1353 }
1354
1355 fn read_window<T, R>(
1356 &self,
1357 window: &WindowHandle<T>,
1358 read: impl FnOnce(View<T>, &AppContext) -> R,
1359 ) -> Result<R>
1360 where
1361 T: 'static,
1362 {
1363 let window = self
1364 .windows
1365 .get(window.id)
1366 .ok_or_else(|| anyhow!("window not found"))?
1367 .as_ref()
1368 .unwrap();
1369
1370 let root_view = window.root_view.clone().unwrap();
1371 let view = root_view
1372 .downcast::<T>()
1373 .map_err(|_| anyhow!("root view's type has changed"))?;
1374
1375 Ok(read(view, self))
1376 }
1377}
1378
1379/// These effects are processed at the end of each application update cycle.
1380pub(crate) enum Effect {
1381 Notify {
1382 emitter: EntityId,
1383 },
1384 Emit {
1385 emitter: EntityId,
1386 event_type: TypeId,
1387 event: Box<dyn Any>,
1388 },
1389 Refresh,
1390 NotifyGlobalObservers {
1391 global_type: TypeId,
1392 },
1393 Defer {
1394 callback: Box<dyn FnOnce(&mut AppContext) + 'static>,
1395 },
1396}
1397
1398/// Wraps a global variable value during `update_global` while the value has been moved to the stack.
1399pub(crate) struct GlobalLease<G: Global> {
1400 global: Box<dyn Any>,
1401 global_type: PhantomData<G>,
1402}
1403
1404impl<G: Global> GlobalLease<G> {
1405 fn new(global: Box<dyn Any>) -> Self {
1406 GlobalLease {
1407 global,
1408 global_type: PhantomData,
1409 }
1410 }
1411}
1412
1413impl<G: Global> Deref for GlobalLease<G> {
1414 type Target = G;
1415
1416 fn deref(&self) -> &Self::Target {
1417 self.global.downcast_ref().unwrap()
1418 }
1419}
1420
1421impl<G: Global> DerefMut for GlobalLease<G> {
1422 fn deref_mut(&mut self) -> &mut Self::Target {
1423 self.global.downcast_mut().unwrap()
1424 }
1425}
1426
1427/// Contains state associated with an active drag operation, started by dragging an element
1428/// within the window or by dragging into the app from the underlying platform.
1429pub struct AnyDrag {
1430 /// The view used to render this drag
1431 pub view: AnyView,
1432
1433 /// The value of the dragged item, to be dropped
1434 pub value: Box<dyn Any>,
1435
1436 /// This is used to render the dragged item in the same place
1437 /// on the original element that the drag was initiated
1438 pub cursor_offset: Point<Pixels>,
1439}
1440
1441/// Contains state associated with a tooltip. You'll only need this struct if you're implementing
1442/// tooltip behavior on a custom element. Otherwise, use [Div::tooltip].
1443#[derive(Clone)]
1444pub struct AnyTooltip {
1445 /// The view used to display the tooltip
1446 pub view: AnyView,
1447
1448 /// The absolute position of the mouse when the tooltip was deployed.
1449 pub mouse_position: Point<Pixels>,
1450}
1451
1452/// A keystroke event, and potentially the associated action
1453#[derive(Debug)]
1454pub struct KeystrokeEvent {
1455 /// The keystroke that occurred
1456 pub keystroke: Keystroke,
1457
1458 /// The action that was resolved for the keystroke, if any
1459 pub action: Option<Box<dyn Action>>,
1460}