1mod async_context;
2mod entity_map;
3mod model_context;
4#[cfg(any(test, feature = "test-support"))]
5mod test_context;
6
7pub use async_context::*;
8use derive_more::{Deref, DerefMut};
9pub use entity_map::*;
10pub use model_context::*;
11use refineable::Refineable;
12use smallvec::SmallVec;
13#[cfg(any(test, feature = "test-support"))]
14pub use test_context::*;
15
16use crate::{
17 current_platform, image_cache::ImageCache, Action, AnyBox, AnyView, AnyWindowHandle,
18 AppMetadata, AssetSource, BackgroundExecutor, ClipboardItem, Context, DispatchPhase, DisplayId,
19 Entity, EventEmitter, FocusEvent, FocusHandle, FocusId, ForegroundExecutor, KeyBinding, Keymap,
20 LayoutId, PathPromptOptions, Pixels, Platform, PlatformDisplay, Point, Render, SubscriberSet,
21 Subscription, SvgRenderer, Task, TextStyle, TextStyleRefinement, TextSystem, View, ViewContext,
22 Window, WindowContext, WindowHandle, WindowId,
23};
24use anyhow::{anyhow, Result};
25use collections::{HashMap, HashSet, VecDeque};
26use futures::{channel::oneshot, future::LocalBoxFuture, Future};
27use parking_lot::Mutex;
28use slotmap::SlotMap;
29use std::{
30 any::{type_name, Any, TypeId},
31 cell::{Ref, RefCell, RefMut},
32 marker::PhantomData,
33 mem,
34 ops::{Deref, DerefMut},
35 path::{Path, PathBuf},
36 rc::{Rc, Weak},
37 sync::{atomic::Ordering::SeqCst, Arc},
38 time::Duration,
39};
40use util::http::{self, HttpClient};
41
42/// Temporary(?) wrapper around RefCell<AppContext> to help us debug any double borrows.
43/// Strongly consider removing after stabilization.
44pub struct AppCell {
45 app: RefCell<AppContext>,
46}
47
48impl AppCell {
49 #[track_caller]
50 pub fn borrow(&self) -> AppRef {
51 if let Some(_) = option_env!("TRACK_THREAD_BORROWS") {
52 let thread_id = std::thread::current().id();
53 eprintln!("borrowed {thread_id:?}");
54 }
55 AppRef(self.app.borrow())
56 }
57
58 #[track_caller]
59 pub fn borrow_mut(&self) -> AppRefMut {
60 if let Some(_) = option_env!("TRACK_THREAD_BORROWS") {
61 let thread_id = std::thread::current().id();
62 eprintln!("borrowed {thread_id:?}");
63 }
64 AppRefMut(self.app.borrow_mut())
65 }
66}
67
68#[derive(Deref, DerefMut)]
69pub struct AppRef<'a>(Ref<'a, AppContext>);
70
71impl<'a> Drop for AppRef<'a> {
72 fn drop(&mut self) {
73 if let Some(_) = option_env!("TRACK_THREAD_BORROWS") {
74 let thread_id = std::thread::current().id();
75 eprintln!("dropped borrow from {thread_id:?}");
76 }
77 }
78}
79
80#[derive(Deref, DerefMut)]
81pub struct AppRefMut<'a>(RefMut<'a, AppContext>);
82
83impl<'a> Drop for AppRefMut<'a> {
84 fn drop(&mut self) {
85 if let Some(_) = option_env!("TRACK_THREAD_BORROWS") {
86 let thread_id = std::thread::current().id();
87 eprintln!("dropped {thread_id:?}");
88 }
89 }
90}
91
92pub struct App(Rc<AppCell>);
93
94/// Represents an application before it is fully launched. Once your app is
95/// configured, you'll start the app with `App::run`.
96impl App {
97 /// Builds an app with the given asset source.
98 pub fn production(asset_source: Arc<dyn AssetSource>) -> Self {
99 Self(AppContext::new(
100 current_platform(),
101 asset_source,
102 http::client(),
103 ))
104 }
105
106 /// Start the application. The provided callback will be called once the
107 /// app is fully launched.
108 pub fn run<F>(self, on_finish_launching: F)
109 where
110 F: 'static + FnOnce(&mut AppContext),
111 {
112 let this = self.0.clone();
113 let platform = self.0.borrow().platform.clone();
114 platform.run(Box::new(move || {
115 let cx = &mut *this.borrow_mut();
116 on_finish_launching(cx);
117 }));
118 }
119
120 /// Register a handler to be invoked when the platform instructs the application
121 /// to open one or more URLs.
122 pub fn on_open_urls<F>(&self, mut callback: F) -> &Self
123 where
124 F: 'static + FnMut(Vec<String>, &mut AppContext),
125 {
126 let this = Rc::downgrade(&self.0);
127 self.0.borrow().platform.on_open_urls(Box::new(move |urls| {
128 if let Some(app) = this.upgrade() {
129 callback(urls, &mut *app.borrow_mut());
130 }
131 }));
132 self
133 }
134
135 pub fn on_reopen<F>(&self, mut callback: F) -> &Self
136 where
137 F: 'static + FnMut(&mut AppContext),
138 {
139 let this = Rc::downgrade(&self.0);
140 self.0.borrow_mut().platform.on_reopen(Box::new(move || {
141 if let Some(app) = this.upgrade() {
142 callback(&mut app.borrow_mut());
143 }
144 }));
145 self
146 }
147
148 pub fn metadata(&self) -> AppMetadata {
149 self.0.borrow().app_metadata.clone()
150 }
151
152 pub fn background_executor(&self) -> BackgroundExecutor {
153 self.0.borrow().background_executor.clone()
154 }
155
156 pub fn foreground_executor(&self) -> ForegroundExecutor {
157 self.0.borrow().foreground_executor.clone()
158 }
159
160 pub fn text_system(&self) -> Arc<TextSystem> {
161 self.0.borrow().text_system.clone()
162 }
163}
164
165pub(crate) type FrameCallback = Box<dyn FnOnce(&mut AppContext)>;
166type Handler = Box<dyn FnMut(&mut AppContext) -> bool + 'static>;
167type Listener = Box<dyn FnMut(&dyn Any, &mut AppContext) -> bool + 'static>;
168type QuitHandler = Box<dyn FnOnce(&mut AppContext) -> LocalBoxFuture<'static, ()> + 'static>;
169type ReleaseListener = Box<dyn FnOnce(&mut dyn Any, &mut AppContext) + 'static>;
170type NewViewListener = Box<dyn FnMut(AnyView, &mut WindowContext) + 'static>;
171
172// struct FrameConsumer {
173// next_frame_callbacks: Vec<FrameCallback>,
174// task: Task<()>,
175// display_linker
176// }
177
178pub struct AppContext {
179 pub(crate) this: Weak<AppCell>,
180 pub(crate) platform: Rc<dyn Platform>,
181 app_metadata: AppMetadata,
182 text_system: Arc<TextSystem>,
183 flushing_effects: bool,
184 pending_updates: usize,
185 pub(crate) active_drag: Option<AnyDrag>,
186 pub(crate) active_tooltip: Option<AnyTooltip>,
187 pub(crate) next_frame_callbacks: HashMap<DisplayId, Vec<FrameCallback>>,
188 pub(crate) frame_consumers: HashMap<DisplayId, Task<()>>,
189 pub(crate) background_executor: BackgroundExecutor,
190 pub(crate) foreground_executor: ForegroundExecutor,
191 pub(crate) svg_renderer: SvgRenderer,
192 asset_source: Arc<dyn AssetSource>,
193 pub(crate) image_cache: ImageCache,
194 pub(crate) text_style_stack: Vec<TextStyleRefinement>,
195 pub(crate) globals_by_type: HashMap<TypeId, AnyBox>,
196 pub(crate) entities: EntityMap,
197 pub(crate) new_view_observers: SubscriberSet<TypeId, NewViewListener>,
198 pub(crate) windows: SlotMap<WindowId, Option<Window>>,
199 pub(crate) keymap: Arc<Mutex<Keymap>>,
200 pub(crate) global_action_listeners:
201 HashMap<TypeId, Vec<Box<dyn Fn(&dyn Action, DispatchPhase, &mut Self)>>>,
202 pending_effects: VecDeque<Effect>,
203 pub(crate) pending_notifications: HashSet<EntityId>,
204 pub(crate) pending_global_notifications: HashSet<TypeId>,
205 pub(crate) observers: SubscriberSet<EntityId, Handler>,
206 // TypeId is the type of the event that the listener callback expects
207 pub(crate) event_listeners: SubscriberSet<EntityId, (TypeId, Listener)>,
208 pub(crate) release_listeners: SubscriberSet<EntityId, ReleaseListener>,
209 pub(crate) global_observers: SubscriberSet<TypeId, Handler>,
210 pub(crate) quit_observers: SubscriberSet<(), QuitHandler>,
211 pub(crate) layout_id_buffer: Vec<LayoutId>, // We recycle this memory across layout requests.
212 pub(crate) propagate_event: bool,
213}
214
215impl AppContext {
216 pub(crate) fn new(
217 platform: Rc<dyn Platform>,
218 asset_source: Arc<dyn AssetSource>,
219 http_client: Arc<dyn HttpClient>,
220 ) -> Rc<AppCell> {
221 let executor = platform.background_executor();
222 let foreground_executor = platform.foreground_executor();
223 assert!(
224 executor.is_main_thread(),
225 "must construct App on main thread"
226 );
227
228 let text_system = Arc::new(TextSystem::new(platform.text_system()));
229 let entities = EntityMap::new();
230
231 let app_metadata = AppMetadata {
232 os_name: platform.os_name(),
233 os_version: platform.os_version().ok(),
234 app_version: platform.app_version().ok(),
235 };
236
237 Rc::new_cyclic(|this| AppCell {
238 app: RefCell::new(AppContext {
239 this: this.clone(),
240 platform,
241 app_metadata,
242 text_system,
243 flushing_effects: false,
244 pending_updates: 0,
245 active_drag: None,
246 active_tooltip: None,
247 next_frame_callbacks: HashMap::default(),
248 frame_consumers: HashMap::default(),
249 background_executor: executor,
250 foreground_executor,
251 svg_renderer: SvgRenderer::new(asset_source.clone()),
252 asset_source,
253 image_cache: ImageCache::new(http_client),
254 text_style_stack: Vec::new(),
255 globals_by_type: HashMap::default(),
256 entities,
257 new_view_observers: SubscriberSet::new(),
258 windows: SlotMap::with_key(),
259 keymap: Arc::new(Mutex::new(Keymap::default())),
260 global_action_listeners: HashMap::default(),
261 pending_effects: VecDeque::new(),
262 pending_notifications: HashSet::default(),
263 pending_global_notifications: HashSet::default(),
264 observers: SubscriberSet::new(),
265 event_listeners: SubscriberSet::new(),
266 release_listeners: SubscriberSet::new(),
267 global_observers: SubscriberSet::new(),
268 quit_observers: SubscriberSet::new(),
269 layout_id_buffer: Default::default(),
270 propagate_event: true,
271 }),
272 })
273 }
274
275 /// Quit the application gracefully. Handlers registered with `ModelContext::on_app_quit`
276 /// will be given 100ms to complete before exiting.
277 pub fn quit(&mut self) {
278 let mut futures = Vec::new();
279
280 for observer in self.quit_observers.remove(&()) {
281 futures.push(observer(self));
282 }
283
284 self.windows.clear();
285 self.flush_effects();
286
287 let futures = futures::future::join_all(futures);
288 if self
289 .background_executor
290 .block_with_timeout(Duration::from_millis(100), futures)
291 .is_err()
292 {
293 log::error!("timed out waiting on app_will_quit");
294 }
295
296 self.globals_by_type.clear();
297 }
298
299 pub fn app_metadata(&self) -> AppMetadata {
300 self.app_metadata.clone()
301 }
302
303 /// Schedules all windows in the application to be redrawn. This can be called
304 /// multiple times in an update cycle and still result in a single redraw.
305 pub fn refresh(&mut self) {
306 self.pending_effects.push_back(Effect::Refresh);
307 }
308 pub(crate) fn update<R>(&mut self, update: impl FnOnce(&mut Self) -> R) -> R {
309 self.pending_updates += 1;
310 let result = update(self);
311 if !self.flushing_effects && self.pending_updates == 1 {
312 self.flushing_effects = true;
313 self.flush_effects();
314 self.flushing_effects = false;
315 }
316 self.pending_updates -= 1;
317 result
318 }
319
320 pub fn observe<W, E>(
321 &mut self,
322 entity: &E,
323 mut on_notify: impl FnMut(E, &mut AppContext) + 'static,
324 ) -> Subscription
325 where
326 W: 'static,
327 E: Entity<W>,
328 {
329 self.observe_internal(entity, move |e, cx| {
330 on_notify(e, cx);
331 true
332 })
333 }
334
335 pub fn observe_internal<W, E>(
336 &mut self,
337 entity: &E,
338 mut on_notify: impl FnMut(E, &mut AppContext) -> bool + 'static,
339 ) -> Subscription
340 where
341 W: 'static,
342 E: Entity<W>,
343 {
344 let entity_id = entity.entity_id();
345 let handle = entity.downgrade();
346 self.observers.insert(
347 entity_id,
348 Box::new(move |cx| {
349 if let Some(handle) = E::upgrade_from(&handle) {
350 on_notify(handle, cx)
351 } else {
352 false
353 }
354 }),
355 )
356 }
357
358 pub fn subscribe<T, E, Evt>(
359 &mut self,
360 entity: &E,
361 mut on_event: impl FnMut(E, &Evt, &mut AppContext) + 'static,
362 ) -> Subscription
363 where
364 T: 'static + EventEmitter<Evt>,
365 E: Entity<T>,
366 Evt: 'static,
367 {
368 self.subscribe_internal(entity, move |entity, event, cx| {
369 on_event(entity, event, cx);
370 true
371 })
372 }
373
374 pub(crate) fn subscribe_internal<T, E, Evt>(
375 &mut self,
376 entity: &E,
377 mut on_event: impl FnMut(E, &Evt, &mut AppContext) -> bool + 'static,
378 ) -> Subscription
379 where
380 T: 'static + EventEmitter<Evt>,
381 E: Entity<T>,
382 Evt: 'static,
383 {
384 let entity_id = entity.entity_id();
385 let entity = entity.downgrade();
386
387 self.event_listeners.insert(
388 entity_id,
389 (
390 TypeId::of::<Evt>(),
391 Box::new(move |event, cx| {
392 let event: &Evt = event.downcast_ref().expect("invalid event type");
393 if let Some(handle) = E::upgrade_from(&entity) {
394 on_event(handle, event, cx)
395 } else {
396 false
397 }
398 }),
399 ),
400 )
401 }
402
403 pub fn windows(&self) -> Vec<AnyWindowHandle> {
404 self.windows
405 .values()
406 .filter_map(|window| Some(window.as_ref()?.handle.clone()))
407 .collect()
408 }
409
410 /// Opens a new window with the given option and the root view returned by the given function.
411 /// The function is invoked with a `WindowContext`, which can be used to interact with window-specific
412 /// functionality.
413 pub fn open_window<V: Render>(
414 &mut self,
415 options: crate::WindowOptions,
416 build_root_view: impl FnOnce(&mut WindowContext) -> View<V>,
417 ) -> WindowHandle<V> {
418 self.update(|cx| {
419 let id = cx.windows.insert(None);
420 let handle = WindowHandle::new(id);
421 let mut window = Window::new(handle.into(), options, cx);
422 let root_view = build_root_view(&mut WindowContext::new(cx, &mut window));
423 window.root_view.replace(root_view.into());
424 cx.windows.get_mut(id).unwrap().replace(window);
425 handle
426 })
427 }
428
429 /// Instructs the platform to activate the application by bringing it to the foreground.
430 pub fn activate(&self, ignoring_other_apps: bool) {
431 self.platform.activate(ignoring_other_apps);
432 }
433
434 /// Returns the list of currently active displays.
435 pub fn displays(&self) -> Vec<Rc<dyn PlatformDisplay>> {
436 self.platform.displays()
437 }
438
439 /// Writes data to the platform clipboard.
440 pub fn write_to_clipboard(&self, item: ClipboardItem) {
441 self.platform.write_to_clipboard(item)
442 }
443
444 /// Reads data from the platform clipboard.
445 pub fn read_from_clipboard(&self) -> Option<ClipboardItem> {
446 self.platform.read_from_clipboard()
447 }
448
449 /// Writes credentials to the platform keychain.
450 pub fn write_credentials(&self, url: &str, username: &str, password: &[u8]) -> Result<()> {
451 self.platform.write_credentials(url, username, password)
452 }
453
454 /// Reads credentials from the platform keychain.
455 pub fn read_credentials(&self, url: &str) -> Result<Option<(String, Vec<u8>)>> {
456 self.platform.read_credentials(url)
457 }
458
459 /// Deletes credentials from the platform keychain.
460 pub fn delete_credentials(&self, url: &str) -> Result<()> {
461 self.platform.delete_credentials(url)
462 }
463
464 /// Directs the platform's default browser to open the given URL.
465 pub fn open_url(&self, url: &str) {
466 self.platform.open_url(url);
467 }
468
469 pub fn path_for_auxiliary_executable(&self, name: &str) -> Result<PathBuf> {
470 self.platform.path_for_auxiliary_executable(name)
471 }
472
473 pub fn prompt_for_paths(
474 &self,
475 options: PathPromptOptions,
476 ) -> oneshot::Receiver<Option<Vec<PathBuf>>> {
477 self.platform.prompt_for_paths(options)
478 }
479
480 pub fn prompt_for_new_path(&self, directory: &Path) -> oneshot::Receiver<Option<PathBuf>> {
481 self.platform.prompt_for_new_path(directory)
482 }
483
484 pub fn reveal_path(&self, path: &Path) {
485 self.platform.reveal_path(path)
486 }
487
488 pub fn should_auto_hide_scrollbars(&self) -> bool {
489 self.platform.should_auto_hide_scrollbars()
490 }
491
492 pub(crate) fn push_effect(&mut self, effect: Effect) {
493 match &effect {
494 Effect::Notify { emitter } => {
495 if !self.pending_notifications.insert(*emitter) {
496 return;
497 }
498 }
499 Effect::NotifyGlobalObservers { global_type } => {
500 if !self.pending_global_notifications.insert(*global_type) {
501 return;
502 }
503 }
504 _ => {}
505 };
506
507 self.pending_effects.push_back(effect);
508 }
509
510 /// Called at the end of AppContext::update to complete any side effects
511 /// such as notifying observers, emitting events, etc. Effects can themselves
512 /// cause effects, so we continue looping until all effects are processed.
513 fn flush_effects(&mut self) {
514 loop {
515 self.release_dropped_entities();
516 self.release_dropped_focus_handles();
517 if let Some(effect) = self.pending_effects.pop_front() {
518 match effect {
519 Effect::Notify { emitter } => {
520 self.apply_notify_effect(emitter);
521 }
522 Effect::Emit {
523 emitter,
524 event_type,
525 event,
526 } => self.apply_emit_effect(emitter, event_type, event),
527 Effect::FocusChanged {
528 window_handle,
529 focused,
530 } => {
531 self.apply_focus_changed_effect(window_handle, focused);
532 }
533 Effect::Refresh => {
534 self.apply_refresh_effect();
535 }
536 Effect::NotifyGlobalObservers { global_type } => {
537 self.apply_notify_global_observers_effect(global_type);
538 }
539 Effect::Defer { callback } => {
540 self.apply_defer_effect(callback);
541 }
542 }
543 } else {
544 break;
545 }
546 }
547
548 let dirty_window_ids = self
549 .windows
550 .iter()
551 .filter_map(|(_, window)| {
552 let window = window.as_ref().unwrap();
553 if window.dirty {
554 Some(window.handle.clone())
555 } else {
556 None
557 }
558 })
559 .collect::<SmallVec<[_; 8]>>();
560
561 for dirty_window_handle in dirty_window_ids {
562 dirty_window_handle.update(self, |_, cx| cx.draw()).unwrap();
563 }
564 }
565
566 /// Repeatedly called during `flush_effects` to release any entities whose
567 /// reference count has become zero. We invoke any release observers before dropping
568 /// each entity.
569 fn release_dropped_entities(&mut self) {
570 loop {
571 let dropped = self.entities.take_dropped();
572 if dropped.is_empty() {
573 break;
574 }
575
576 for (entity_id, mut entity) in dropped {
577 self.observers.remove(&entity_id);
578 self.event_listeners.remove(&entity_id);
579 for release_callback in self.release_listeners.remove(&entity_id) {
580 release_callback(entity.as_mut(), self);
581 }
582 }
583 }
584 }
585
586 /// Repeatedly called during `flush_effects` to handle a focused handle being dropped.
587 /// For now, we simply blur the window if this happens, but we may want to support invoking
588 /// a window blur handler to restore focus to some logical element.
589 fn release_dropped_focus_handles(&mut self) {
590 for window_handle in self.windows() {
591 window_handle
592 .update(self, |_, cx| {
593 let mut blur_window = false;
594 let focus = cx.window.focus;
595 cx.window.focus_handles.write().retain(|handle_id, count| {
596 if count.load(SeqCst) == 0 {
597 if focus == Some(handle_id) {
598 blur_window = true;
599 }
600 false
601 } else {
602 true
603 }
604 });
605
606 if blur_window {
607 cx.blur();
608 }
609 })
610 .unwrap();
611 }
612 }
613
614 fn apply_notify_effect(&mut self, emitter: EntityId) {
615 self.pending_notifications.remove(&emitter);
616
617 self.observers
618 .clone()
619 .retain(&emitter, |handler| handler(self));
620 }
621
622 fn apply_emit_effect(&mut self, emitter: EntityId, event_type: TypeId, event: Box<dyn Any>) {
623 self.event_listeners
624 .clone()
625 .retain(&emitter, |(stored_type, handler)| {
626 if *stored_type == event_type {
627 handler(event.as_ref(), self)
628 } else {
629 true
630 }
631 });
632 }
633
634 fn apply_focus_changed_effect(
635 &mut self,
636 window_handle: AnyWindowHandle,
637 focused: Option<FocusId>,
638 ) {
639 window_handle
640 .update(self, |_, cx| {
641 // The window might change focus multiple times in an effect cycle.
642 // We only honor effects for the most recently focused handle.
643 if cx.window.focus == focused {
644 // if someone calls focus multiple times in one frame with the same handle
645 // the first apply_focus_changed_effect will have taken the last blur already
646 // and run the rest of this, so we can return.
647 let Some(last_blur) = cx.window.last_blur.take() else {
648 return;
649 };
650
651 let focused = focused
652 .map(|id| FocusHandle::for_id(id, &cx.window.focus_handles).unwrap());
653
654 let blurred =
655 last_blur.and_then(|id| FocusHandle::for_id(id, &cx.window.focus_handles));
656
657 let focus_changed = focused.is_some() || blurred.is_some();
658 let event = FocusEvent { focused, blurred };
659
660 let mut listeners = mem::take(&mut cx.window.current_frame.focus_listeners);
661 if focus_changed {
662 for listener in &mut listeners {
663 listener(&event, cx);
664 }
665 }
666 listeners.extend(cx.window.current_frame.focus_listeners.drain(..));
667 cx.window.current_frame.focus_listeners = listeners;
668
669 if focus_changed {
670 cx.window
671 .focus_listeners
672 .clone()
673 .retain(&(), |listener| listener(&event, cx));
674 }
675 }
676 })
677 .ok();
678 }
679
680 fn apply_refresh_effect(&mut self) {
681 for window in self.windows.values_mut() {
682 if let Some(window) = window.as_mut() {
683 window.dirty = true;
684 }
685 }
686 }
687
688 fn apply_notify_global_observers_effect(&mut self, type_id: TypeId) {
689 self.pending_global_notifications.remove(&type_id);
690 self.global_observers
691 .clone()
692 .retain(&type_id, |observer| observer(self));
693 }
694
695 fn apply_defer_effect(&mut self, callback: Box<dyn FnOnce(&mut Self) + 'static>) {
696 callback(self);
697 }
698
699 /// Creates an `AsyncAppContext`, which can be cloned and has a static lifetime
700 /// so it can be held across `await` points.
701 pub fn to_async(&self) -> AsyncAppContext {
702 AsyncAppContext {
703 app: unsafe { mem::transmute(self.this.clone()) },
704 background_executor: self.background_executor.clone(),
705 foreground_executor: self.foreground_executor.clone(),
706 }
707 }
708
709 /// Obtains a reference to the executor, which can be used to spawn futures.
710 pub fn background_executor(&self) -> &BackgroundExecutor {
711 &self.background_executor
712 }
713
714 /// Obtains a reference to the executor, which can be used to spawn futures.
715 pub fn foreground_executor(&self) -> &ForegroundExecutor {
716 &self.foreground_executor
717 }
718
719 /// Spawns the future returned by the given function on the thread pool. The closure will be invoked
720 /// with AsyncAppContext, which allows the application state to be accessed across await points.
721 pub fn spawn<Fut, R>(&self, f: impl FnOnce(AsyncAppContext) -> Fut) -> Task<R>
722 where
723 Fut: Future<Output = R> + 'static,
724 R: 'static,
725 {
726 self.foreground_executor.spawn(f(self.to_async()))
727 }
728
729 /// Schedules the given function to be run at the end of the current effect cycle, allowing entities
730 /// that are currently on the stack to be returned to the app.
731 pub fn defer(&mut self, f: impl FnOnce(&mut AppContext) + 'static) {
732 self.push_effect(Effect::Defer {
733 callback: Box::new(f),
734 });
735 }
736
737 /// Accessor for the application's asset source, which is provided when constructing the `App`.
738 pub fn asset_source(&self) -> &Arc<dyn AssetSource> {
739 &self.asset_source
740 }
741
742 /// Accessor for the text system.
743 pub fn text_system(&self) -> &Arc<TextSystem> {
744 &self.text_system
745 }
746
747 /// The current text style. Which is composed of all the style refinements provided to `with_text_style`.
748 pub fn text_style(&self) -> TextStyle {
749 let mut style = TextStyle::default();
750 for refinement in &self.text_style_stack {
751 style.refine(refinement);
752 }
753 style
754 }
755
756 /// Check whether a global of the given type has been assigned.
757 pub fn has_global<G: 'static>(&self) -> bool {
758 self.globals_by_type.contains_key(&TypeId::of::<G>())
759 }
760
761 /// Access the global of the given type. Panics if a global for that type has not been assigned.
762 #[track_caller]
763 pub fn global<G: 'static>(&self) -> &G {
764 self.globals_by_type
765 .get(&TypeId::of::<G>())
766 .map(|any_state| any_state.downcast_ref::<G>().unwrap())
767 .ok_or_else(|| anyhow!("no state of type {} exists", type_name::<G>()))
768 .unwrap()
769 }
770
771 /// Access the global of the given type if a value has been assigned.
772 pub fn try_global<G: 'static>(&self) -> Option<&G> {
773 self.globals_by_type
774 .get(&TypeId::of::<G>())
775 .map(|any_state| any_state.downcast_ref::<G>().unwrap())
776 }
777
778 /// Access the global of the given type mutably. Panics if a global for that type has not been assigned.
779 #[track_caller]
780 pub fn global_mut<G: 'static>(&mut self) -> &mut G {
781 let global_type = TypeId::of::<G>();
782 self.push_effect(Effect::NotifyGlobalObservers { global_type });
783 self.globals_by_type
784 .get_mut(&global_type)
785 .and_then(|any_state| any_state.downcast_mut::<G>())
786 .ok_or_else(|| anyhow!("no state of type {} exists", type_name::<G>()))
787 .unwrap()
788 }
789
790 /// Access the global of the given type mutably. A default value is assigned if a global of this type has not
791 /// yet been assigned.
792 pub fn default_global<G: 'static + Default>(&mut self) -> &mut G {
793 let global_type = TypeId::of::<G>();
794 self.push_effect(Effect::NotifyGlobalObservers { global_type });
795 self.globals_by_type
796 .entry(global_type)
797 .or_insert_with(|| Box::new(G::default()))
798 .downcast_mut::<G>()
799 .unwrap()
800 }
801
802 /// Set the value of the global of the given type.
803 pub fn set_global<G: Any>(&mut self, global: G) {
804 let global_type = TypeId::of::<G>();
805 self.push_effect(Effect::NotifyGlobalObservers { global_type });
806 self.globals_by_type.insert(global_type, Box::new(global));
807 }
808
809 /// Clear all stored globals. Does not notify global observers.
810 #[cfg(any(test, feature = "test-support"))]
811 pub fn clear_globals(&mut self) {
812 self.globals_by_type.drain();
813 }
814
815 /// Remove the global of the given type from the app context. Does not notify global observers.
816 #[cfg(any(test, feature = "test-support"))]
817 pub fn remove_global<G: Any>(&mut self) -> G {
818 let global_type = TypeId::of::<G>();
819 *self
820 .globals_by_type
821 .remove(&global_type)
822 .unwrap_or_else(|| panic!("no global added for {}", std::any::type_name::<G>()))
823 .downcast()
824 .unwrap()
825 }
826
827 /// Update the global of the given type with a closure. Unlike `global_mut`, this method provides
828 /// your closure with mutable access to the `AppContext` and the global simultaneously.
829 pub fn update_global<G: 'static, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R {
830 let mut global = self.lease_global::<G>();
831 let result = f(&mut global, self);
832 self.end_global_lease(global);
833 result
834 }
835
836 /// Register a callback to be invoked when a global of the given type is updated.
837 pub fn observe_global<G: 'static>(
838 &mut self,
839 mut f: impl FnMut(&mut Self) + 'static,
840 ) -> Subscription {
841 self.global_observers.insert(
842 TypeId::of::<G>(),
843 Box::new(move |cx| {
844 f(cx);
845 true
846 }),
847 )
848 }
849
850 /// Move the global of the given type to the stack.
851 pub(crate) fn lease_global<G: 'static>(&mut self) -> GlobalLease<G> {
852 GlobalLease::new(
853 self.globals_by_type
854 .remove(&TypeId::of::<G>())
855 .ok_or_else(|| anyhow!("no global registered of type {}", type_name::<G>()))
856 .unwrap(),
857 )
858 }
859
860 /// Restore the global of the given type after it is moved to the stack.
861 pub(crate) fn end_global_lease<G: 'static>(&mut self, lease: GlobalLease<G>) {
862 let global_type = TypeId::of::<G>();
863 self.push_effect(Effect::NotifyGlobalObservers { global_type });
864 self.globals_by_type.insert(global_type, lease.global);
865 }
866
867 pub fn observe_new_views<V: 'static>(
868 &mut self,
869 on_new: impl 'static + Fn(&mut V, &mut ViewContext<V>),
870 ) -> Subscription {
871 self.new_view_observers.insert(
872 TypeId::of::<V>(),
873 Box::new(move |any_view: AnyView, cx: &mut WindowContext| {
874 any_view
875 .downcast::<V>()
876 .unwrap()
877 .update(cx, |view_state, cx| {
878 on_new(view_state, cx);
879 })
880 }),
881 )
882 }
883
884 pub fn observe_release<E, T>(
885 &mut self,
886 handle: &E,
887 on_release: impl FnOnce(&mut T, &mut AppContext) + 'static,
888 ) -> Subscription
889 where
890 E: Entity<T>,
891 T: 'static,
892 {
893 self.release_listeners.insert(
894 handle.entity_id(),
895 Box::new(move |entity, cx| {
896 let entity = entity.downcast_mut().expect("invalid entity type");
897 on_release(entity, cx)
898 }),
899 )
900 }
901
902 pub(crate) fn push_text_style(&mut self, text_style: TextStyleRefinement) {
903 self.text_style_stack.push(text_style);
904 }
905
906 pub(crate) fn pop_text_style(&mut self) {
907 self.text_style_stack.pop();
908 }
909
910 /// Register key bindings.
911 pub fn bind_keys(&mut self, bindings: impl IntoIterator<Item = KeyBinding>) {
912 self.keymap.lock().add_bindings(bindings);
913 self.pending_effects.push_back(Effect::Refresh);
914 }
915
916 /// Register a global listener for actions invoked via the keyboard.
917 pub fn on_action<A: Action>(&mut self, listener: impl Fn(&A, &mut Self) + 'static) {
918 self.global_action_listeners
919 .entry(TypeId::of::<A>())
920 .or_default()
921 .push(Box::new(move |action, phase, cx| {
922 if phase == DispatchPhase::Bubble {
923 let action = action.as_any().downcast_ref().unwrap();
924 listener(action, cx)
925 }
926 }));
927 }
928
929 /// Event handlers propagate events by default. Call this method to stop dispatching to
930 /// event handlers with a lower z-index (mouse) or higher in the tree (keyboard). This is
931 /// the opposite of [propagate]. It's also possible to cancel a call to [propagate] by
932 /// calling this method before effects are flushed.
933 pub fn stop_propagation(&mut self) {
934 self.propagate_event = false;
935 }
936
937 /// Action handlers stop propagation by default during the bubble phase of action dispatch
938 /// dispatching to action handlers higher in the element tree. This is the opposite of
939 /// [stop_propagation]. It's also possible to cancel a call to [stop_propagate] by calling
940 /// this method before effects are flushed.
941 pub fn propagate(&mut self) {
942 self.propagate_event = true;
943 }
944}
945
946impl Context for AppContext {
947 type Result<T> = T;
948
949 /// Build an entity that is owned by the application. The given function will be invoked with
950 /// a `ModelContext` and must return an object representing the entity. A `Model` will be returned
951 /// which can be used to access the entity in a context.
952 fn build_model<T: 'static>(
953 &mut self,
954 build_model: impl FnOnce(&mut ModelContext<'_, T>) -> T,
955 ) -> Model<T> {
956 self.update(|cx| {
957 let slot = cx.entities.reserve();
958 let entity = build_model(&mut ModelContext::new(cx, slot.downgrade()));
959 cx.entities.insert(slot, entity)
960 })
961 }
962
963 /// Update the entity referenced by the given model. The function is passed a mutable reference to the
964 /// entity along with a `ModelContext` for the entity.
965 fn update_model<T: 'static, R>(
966 &mut self,
967 model: &Model<T>,
968 update: impl FnOnce(&mut T, &mut ModelContext<'_, T>) -> R,
969 ) -> R {
970 self.update(|cx| {
971 let mut entity = cx.entities.lease(model);
972 let result = update(&mut entity, &mut ModelContext::new(cx, model.downgrade()));
973 cx.entities.end_lease(entity);
974 result
975 })
976 }
977
978 fn update_window<T, F>(&mut self, handle: AnyWindowHandle, update: F) -> Result<T>
979 where
980 F: FnOnce(AnyView, &mut WindowContext<'_>) -> T,
981 {
982 self.update(|cx| {
983 let mut window = cx
984 .windows
985 .get_mut(handle.id)
986 .ok_or_else(|| anyhow!("window not found"))?
987 .take()
988 .unwrap();
989
990 let root_view = window.root_view.clone().unwrap();
991 let result = update(root_view, &mut WindowContext::new(cx, &mut window));
992
993 if !window.removed {
994 cx.windows
995 .get_mut(handle.id)
996 .ok_or_else(|| anyhow!("window not found"))?
997 .replace(window);
998 }
999
1000 Ok(result)
1001 })
1002 }
1003
1004 fn read_model<T, R>(
1005 &self,
1006 handle: &Model<T>,
1007 read: impl FnOnce(&T, &AppContext) -> R,
1008 ) -> Self::Result<R>
1009 where
1010 T: 'static,
1011 {
1012 let entity = self.entities.read(handle);
1013 read(entity, self)
1014 }
1015
1016 fn read_window<T, R>(
1017 &self,
1018 window: &WindowHandle<T>,
1019 read: impl FnOnce(View<T>, &AppContext) -> R,
1020 ) -> Result<R>
1021 where
1022 T: 'static,
1023 {
1024 let window = self
1025 .windows
1026 .get(window.id)
1027 .ok_or_else(|| anyhow!("window not found"))?
1028 .as_ref()
1029 .unwrap();
1030
1031 let root_view = window.root_view.clone().unwrap();
1032 let view = root_view
1033 .downcast::<T>()
1034 .map_err(|_| anyhow!("root view's type has changed"))?;
1035
1036 Ok(read(view, self))
1037 }
1038}
1039
1040/// These effects are processed at the end of each application update cycle.
1041pub(crate) enum Effect {
1042 Notify {
1043 emitter: EntityId,
1044 },
1045 Emit {
1046 emitter: EntityId,
1047 event_type: TypeId,
1048 event: Box<dyn Any>,
1049 },
1050 FocusChanged {
1051 window_handle: AnyWindowHandle,
1052 focused: Option<FocusId>,
1053 },
1054 Refresh,
1055 NotifyGlobalObservers {
1056 global_type: TypeId,
1057 },
1058 Defer {
1059 callback: Box<dyn FnOnce(&mut AppContext) + 'static>,
1060 },
1061}
1062
1063/// Wraps a global variable value during `update_global` while the value has been moved to the stack.
1064pub(crate) struct GlobalLease<G: 'static> {
1065 global: AnyBox,
1066 global_type: PhantomData<G>,
1067}
1068
1069impl<G: 'static> GlobalLease<G> {
1070 fn new(global: AnyBox) -> Self {
1071 GlobalLease {
1072 global,
1073 global_type: PhantomData,
1074 }
1075 }
1076}
1077
1078impl<G: 'static> Deref for GlobalLease<G> {
1079 type Target = G;
1080
1081 fn deref(&self) -> &Self::Target {
1082 self.global.downcast_ref().unwrap()
1083 }
1084}
1085
1086impl<G: 'static> DerefMut for GlobalLease<G> {
1087 fn deref_mut(&mut self) -> &mut Self::Target {
1088 self.global.downcast_mut().unwrap()
1089 }
1090}
1091
1092/// Contains state associated with an active drag operation, started by dragging an element
1093/// within the window or by dragging into the app from the underlying platform.
1094pub struct AnyDrag {
1095 pub view: AnyView,
1096 pub cursor_offset: Point<Pixels>,
1097}
1098
1099#[derive(Clone)]
1100pub(crate) struct AnyTooltip {
1101 pub view: AnyView,
1102 pub cursor_offset: Point<Pixels>,
1103}