1use crate::{
2 px, size, Action, AnyBox, AnyView, AppContext, AsyncWindowContext, AvailableSpace,
3 BorrowAppContext, Bounds, BoxShadow, Context, Corners, DevicePixels, DispatchContext,
4 DisplayId, Edges, Effect, Element, EntityId, EventEmitter, FocusEvent, FontId, GlobalElementId,
5 GlyphId, Handle, Hsla, ImageData, InputEvent, IsZero, KeyListener, KeyMatch, KeyMatcher,
6 Keystroke, LayoutId, MainThread, MainThreadOnly, MonochromeSprite, MouseMoveEvent, Path,
7 Pixels, Platform, PlatformAtlas, PlatformWindow, Point, PolychromeSprite, Quad, Reference,
8 RenderGlyphParams, RenderImageParams, RenderSvgParams, ScaledPixels, SceneBuilder, Shadow,
9 SharedString, Size, Style, Subscription, TaffyLayoutEngine, Task, Underline, UnderlineStyle,
10 WeakHandle, WindowOptions, SUBPIXEL_VARIANTS,
11};
12use anyhow::Result;
13use collections::HashMap;
14use derive_more::{Deref, DerefMut};
15use parking_lot::RwLock;
16use slotmap::SlotMap;
17use smallvec::SmallVec;
18use std::{
19 any::{Any, TypeId},
20 borrow::Cow,
21 fmt::Debug,
22 future::Future,
23 marker::PhantomData,
24 mem,
25 sync::{
26 atomic::{AtomicUsize, Ordering::SeqCst},
27 Arc,
28 },
29};
30use util::ResultExt;
31
32#[derive(Deref, DerefMut, Ord, PartialOrd, Eq, PartialEq, Clone, Default)]
33pub struct StackingOrder(pub(crate) SmallVec<[u32; 16]>);
34
35#[derive(Default, Copy, Clone, Debug, Eq, PartialEq)]
36pub enum DispatchPhase {
37 /// After the capture phase comes the bubble phase, in which event handlers are
38 /// invoked front to back. This is the phase you'll usually want to use for event handlers.
39 #[default]
40 Bubble,
41 /// During the initial capture phase, event handlers are invoked back to front. This phase
42 /// is used for special purposes such as clearing the "pressed" state for click events. If
43 /// you stop event propagation during this phase, you need to know what you're doing. Handlers
44 /// outside of the immediate region may rely on detecting non-local events during this phase.
45 Capture,
46}
47
48type AnyListener = Arc<dyn Fn(&dyn Any, DispatchPhase, &mut WindowContext) + Send + Sync + 'static>;
49type AnyKeyListener = Arc<
50 dyn Fn(
51 &dyn Any,
52 &[&DispatchContext],
53 DispatchPhase,
54 &mut WindowContext,
55 ) -> Option<Box<dyn Action>>
56 + Send
57 + Sync
58 + 'static,
59>;
60type AnyFocusListener = Arc<dyn Fn(&FocusEvent, &mut WindowContext) + Send + Sync + 'static>;
61
62slotmap::new_key_type! { pub struct FocusId; }
63
64pub struct FocusHandle {
65 pub(crate) id: FocusId,
66 handles: Arc<RwLock<SlotMap<FocusId, AtomicUsize>>>,
67}
68
69impl FocusHandle {
70 pub(crate) fn new(handles: &Arc<RwLock<SlotMap<FocusId, AtomicUsize>>>) -> Self {
71 let id = handles.write().insert(AtomicUsize::new(1));
72 Self {
73 id,
74 handles: handles.clone(),
75 }
76 }
77
78 pub(crate) fn for_id(
79 id: FocusId,
80 handles: &Arc<RwLock<SlotMap<FocusId, AtomicUsize>>>,
81 ) -> Option<Self> {
82 let lock = handles.read();
83 let ref_count = lock.get(id)?;
84 if ref_count.load(SeqCst) == 0 {
85 None
86 } else {
87 ref_count.fetch_add(1, SeqCst);
88 Some(Self {
89 id,
90 handles: handles.clone(),
91 })
92 }
93 }
94
95 pub fn is_focused(&self, cx: &WindowContext) -> bool {
96 cx.window.focus == Some(self.id)
97 }
98
99 pub fn contains_focused(&self, cx: &WindowContext) -> bool {
100 cx.focused()
101 .map_or(false, |focused| self.contains(&focused, cx))
102 }
103
104 pub fn within_focused(&self, cx: &WindowContext) -> bool {
105 let focused = cx.focused();
106 focused.map_or(false, |focused| focused.contains(self, cx))
107 }
108
109 pub(crate) fn contains(&self, other: &Self, cx: &WindowContext) -> bool {
110 let mut ancestor = Some(other.id);
111 while let Some(ancestor_id) = ancestor {
112 if self.id == ancestor_id {
113 return true;
114 } else {
115 ancestor = cx.window.focus_parents_by_child.get(&ancestor_id).copied();
116 }
117 }
118 false
119 }
120}
121
122impl Clone for FocusHandle {
123 fn clone(&self) -> Self {
124 Self::for_id(self.id, &self.handles).unwrap()
125 }
126}
127
128impl PartialEq for FocusHandle {
129 fn eq(&self, other: &Self) -> bool {
130 self.id == other.id
131 }
132}
133
134impl Eq for FocusHandle {}
135
136impl Drop for FocusHandle {
137 fn drop(&mut self) {
138 self.handles
139 .read()
140 .get(self.id)
141 .unwrap()
142 .fetch_sub(1, SeqCst);
143 }
144}
145
146pub struct Window {
147 handle: AnyWindowHandle,
148 platform_window: MainThreadOnly<Box<dyn PlatformWindow>>,
149 display_id: DisplayId,
150 sprite_atlas: Arc<dyn PlatformAtlas>,
151 rem_size: Pixels,
152 content_size: Size<Pixels>,
153 layout_engine: TaffyLayoutEngine,
154 pub(crate) root_view: Option<AnyView>,
155 pub(crate) element_id_stack: GlobalElementId,
156 prev_frame_element_states: HashMap<GlobalElementId, AnyBox>,
157 element_states: HashMap<GlobalElementId, AnyBox>,
158 prev_frame_key_matchers: HashMap<GlobalElementId, KeyMatcher>,
159 key_matchers: HashMap<GlobalElementId, KeyMatcher>,
160 z_index_stack: StackingOrder,
161 content_mask_stack: Vec<ContentMask<Pixels>>,
162 scroll_offset_stack: Vec<Point<Pixels>>,
163 mouse_listeners: HashMap<TypeId, Vec<(StackingOrder, AnyListener)>>,
164 key_dispatch_stack: Vec<KeyDispatchStackFrame>,
165 freeze_key_dispatch_stack: bool,
166 focus_stack: Vec<FocusId>,
167 focus_parents_by_child: HashMap<FocusId, FocusId>,
168 pub(crate) focus_listeners: Vec<AnyFocusListener>,
169 pub(crate) focus_handles: Arc<RwLock<SlotMap<FocusId, AtomicUsize>>>,
170 default_prevented: bool,
171 mouse_position: Point<Pixels>,
172 scale_factor: f32,
173 pub(crate) scene_builder: SceneBuilder,
174 pub(crate) dirty: bool,
175 pub(crate) last_blur: Option<Option<FocusId>>,
176 pub(crate) focus: Option<FocusId>,
177}
178
179impl Window {
180 pub fn new(
181 handle: AnyWindowHandle,
182 options: WindowOptions,
183 cx: &mut MainThread<AppContext>,
184 ) -> Self {
185 let platform_window = cx.platform().open_window(handle, options);
186 let display_id = platform_window.display().id();
187 let sprite_atlas = platform_window.sprite_atlas();
188 let mouse_position = platform_window.mouse_position();
189 let content_size = platform_window.content_size();
190 let scale_factor = platform_window.scale_factor();
191 platform_window.on_resize(Box::new({
192 let cx = cx.to_async();
193 move |content_size, scale_factor| {
194 cx.update_window(handle, |cx| {
195 cx.window.scale_factor = scale_factor;
196 cx.window.scene_builder = SceneBuilder::new();
197 cx.window.content_size = content_size;
198 cx.window.display_id = cx
199 .window
200 .platform_window
201 .borrow_on_main_thread()
202 .display()
203 .id();
204 cx.window.dirty = true;
205 })
206 .log_err();
207 }
208 }));
209
210 platform_window.on_input({
211 let cx = cx.to_async();
212 Box::new(move |event| {
213 cx.update_window(handle, |cx| cx.dispatch_event(event))
214 .log_err()
215 .unwrap_or(true)
216 })
217 });
218
219 let platform_window = MainThreadOnly::new(Arc::new(platform_window), cx.executor.clone());
220
221 Window {
222 handle,
223 platform_window,
224 display_id,
225 sprite_atlas,
226 rem_size: px(16.),
227 content_size,
228 layout_engine: TaffyLayoutEngine::new(),
229 root_view: None,
230 element_id_stack: GlobalElementId::default(),
231 prev_frame_element_states: HashMap::default(),
232 element_states: HashMap::default(),
233 prev_frame_key_matchers: HashMap::default(),
234 key_matchers: HashMap::default(),
235 z_index_stack: StackingOrder(SmallVec::new()),
236 content_mask_stack: Vec::new(),
237 scroll_offset_stack: Vec::new(),
238 mouse_listeners: HashMap::default(),
239 key_dispatch_stack: Vec::new(),
240 freeze_key_dispatch_stack: false,
241 focus_stack: Vec::new(),
242 focus_parents_by_child: HashMap::default(),
243 focus_listeners: Vec::new(),
244 focus_handles: Arc::new(RwLock::new(SlotMap::with_key())),
245 default_prevented: true,
246 mouse_position,
247 scale_factor,
248 scene_builder: SceneBuilder::new(),
249 dirty: true,
250 last_blur: None,
251 focus: None,
252 }
253 }
254}
255
256enum KeyDispatchStackFrame {
257 Listener {
258 event_type: TypeId,
259 listener: AnyKeyListener,
260 },
261 Context(DispatchContext),
262}
263
264#[derive(Clone, Debug, Default, PartialEq, Eq)]
265#[repr(C)]
266pub struct ContentMask<P: Clone + Default + Debug> {
267 pub bounds: Bounds<P>,
268}
269
270impl ContentMask<Pixels> {
271 pub fn scale(&self, factor: f32) -> ContentMask<ScaledPixels> {
272 ContentMask {
273 bounds: self.bounds.scale(factor),
274 }
275 }
276
277 pub fn intersect(&self, other: &Self) -> Self {
278 let bounds = self.bounds.intersect(&other.bounds);
279 ContentMask { bounds }
280 }
281}
282
283pub struct WindowContext<'a, 'w> {
284 app: Reference<'a, AppContext>,
285 pub(crate) window: Reference<'w, Window>,
286}
287
288impl<'a, 'w> WindowContext<'a, 'w> {
289 pub(crate) fn immutable(app: &'a AppContext, window: &'w Window) -> Self {
290 Self {
291 app: Reference::Immutable(app),
292 window: Reference::Immutable(window),
293 }
294 }
295
296 pub(crate) fn mutable(app: &'a mut AppContext, window: &'w mut Window) -> Self {
297 Self {
298 app: Reference::Mutable(app),
299 window: Reference::Mutable(window),
300 }
301 }
302
303 pub fn window_handle(&self) -> AnyWindowHandle {
304 self.window.handle
305 }
306
307 pub fn notify(&mut self) {
308 self.window.dirty = true;
309 }
310
311 pub fn focus_handle(&mut self) -> FocusHandle {
312 FocusHandle::new(&self.window.focus_handles)
313 }
314
315 pub fn focused(&self) -> Option<FocusHandle> {
316 self.window
317 .focus
318 .and_then(|id| FocusHandle::for_id(id, &self.window.focus_handles))
319 }
320
321 pub fn focus(&mut self, handle: &FocusHandle) {
322 if self.window.last_blur.is_none() {
323 self.window.last_blur = Some(self.window.focus);
324 }
325
326 let window_id = self.window.handle.id;
327 self.window.focus = Some(handle.id);
328 self.app.push_effect(Effect::FocusChanged {
329 window_id,
330 focused: Some(handle.id),
331 });
332 self.notify();
333 }
334
335 pub fn blur(&mut self) {
336 if self.window.last_blur.is_none() {
337 self.window.last_blur = Some(self.window.focus);
338 }
339
340 let window_id = self.window.handle.id;
341 self.window.focus = None;
342 self.app.push_effect(Effect::FocusChanged {
343 window_id,
344 focused: None,
345 });
346 self.notify();
347 }
348
349 pub fn run_on_main<R>(
350 &mut self,
351 f: impl FnOnce(&mut MainThread<WindowContext<'_, '_>>) -> R + Send + 'static,
352 ) -> Task<Result<R>>
353 where
354 R: Send + 'static,
355 {
356 if self.executor.is_main_thread() {
357 Task::ready(Ok(f(unsafe {
358 mem::transmute::<&mut Self, &mut MainThread<Self>>(self)
359 })))
360 } else {
361 let id = self.window.handle.id;
362 self.app.run_on_main(move |cx| cx.update_window(id, f))
363 }
364 }
365
366 pub fn to_async(&self) -> AsyncWindowContext {
367 AsyncWindowContext::new(self.app.to_async(), self.window.handle)
368 }
369
370 pub fn on_next_frame(&mut self, f: impl FnOnce(&mut WindowContext) + Send + 'static) {
371 let f = Box::new(f);
372 let display_id = self.window.display_id;
373 self.run_on_main(move |cx| {
374 if let Some(callbacks) = cx.next_frame_callbacks.get_mut(&display_id) {
375 callbacks.push(f);
376 // If there was already a callback, it means that we already scheduled a frame.
377 if callbacks.len() > 1 {
378 return;
379 }
380 } else {
381 let async_cx = cx.to_async();
382 cx.next_frame_callbacks.insert(display_id, vec![f]);
383 cx.platform().set_display_link_output_callback(
384 display_id,
385 Box::new(move |_current_time, _output_time| {
386 let _ = async_cx.update(|cx| {
387 let callbacks = cx
388 .next_frame_callbacks
389 .get_mut(&display_id)
390 .unwrap()
391 .drain(..)
392 .collect::<Vec<_>>();
393 for callback in callbacks {
394 callback(cx);
395 }
396
397 cx.run_on_main(move |cx| {
398 if cx.next_frame_callbacks.get(&display_id).unwrap().is_empty() {
399 cx.platform().stop_display_link(display_id);
400 }
401 })
402 .detach();
403 });
404 }),
405 );
406 }
407
408 cx.platform().start_display_link(display_id);
409 })
410 .detach();
411 }
412
413 pub fn spawn<Fut, R>(
414 &mut self,
415 f: impl FnOnce(AnyWindowHandle, AsyncWindowContext) -> Fut + Send + 'static,
416 ) -> Task<R>
417 where
418 R: Send + 'static,
419 Fut: Future<Output = R> + Send + 'static,
420 {
421 let window = self.window.handle;
422 self.app.spawn(move |app| {
423 let cx = AsyncWindowContext::new(app, window);
424 let future = f(window, cx);
425 async move { future.await }
426 })
427 }
428
429 pub fn update_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
430 where
431 G: 'static + Send + Sync,
432 {
433 let mut global = self.app.lease_global::<G>();
434 let result = f(global.as_mut(), self);
435 self.app.set_global(global);
436 result
437 }
438
439 pub fn request_layout(
440 &mut self,
441 style: &Style,
442 children: impl IntoIterator<Item = LayoutId>,
443 ) -> LayoutId {
444 self.app.layout_id_buffer.clear();
445 self.app.layout_id_buffer.extend(children.into_iter());
446 let rem_size = self.rem_size();
447
448 self.window
449 .layout_engine
450 .request_layout(style, rem_size, &self.app.layout_id_buffer)
451 }
452
453 pub fn request_measured_layout<
454 F: Fn(Size<Option<Pixels>>, Size<AvailableSpace>) -> Size<Pixels> + Send + Sync + 'static,
455 >(
456 &mut self,
457 style: Style,
458 rem_size: Pixels,
459 measure: F,
460 ) -> LayoutId {
461 self.window
462 .layout_engine
463 .request_measured_layout(style, rem_size, measure)
464 }
465
466 pub fn layout_bounds(&mut self, layout_id: LayoutId) -> Bounds<Pixels> {
467 let mut bounds = self
468 .window
469 .layout_engine
470 .layout_bounds(layout_id)
471 .map(Into::into);
472 bounds.origin -= self.scroll_offset();
473 bounds
474 }
475
476 pub fn scale_factor(&self) -> f32 {
477 self.window.scale_factor
478 }
479
480 pub fn rem_size(&self) -> Pixels {
481 self.window.rem_size
482 }
483
484 pub fn line_height(&self) -> Pixels {
485 let rem_size = self.rem_size();
486 let text_style = self.text_style();
487 text_style
488 .line_height
489 .to_pixels(text_style.font_size.into(), rem_size)
490 }
491
492 pub fn prevent_default(&mut self) {
493 self.window.default_prevented = true;
494 }
495
496 pub fn default_prevented(&self) -> bool {
497 self.window.default_prevented
498 }
499
500 pub fn on_mouse_event<Event: 'static>(
501 &mut self,
502 handler: impl Fn(&Event, DispatchPhase, &mut WindowContext) + Send + Sync + 'static,
503 ) {
504 let order = self.window.z_index_stack.clone();
505 self.window
506 .mouse_listeners
507 .entry(TypeId::of::<Event>())
508 .or_default()
509 .push((
510 order,
511 Arc::new(move |event: &dyn Any, phase, cx| {
512 handler(event.downcast_ref().unwrap(), phase, cx)
513 }),
514 ))
515 }
516
517 pub fn mouse_position(&self) -> Point<Pixels> {
518 self.window.mouse_position
519 }
520
521 pub fn stack<R>(&mut self, order: u32, f: impl FnOnce(&mut Self) -> R) -> R {
522 self.window.z_index_stack.push(order);
523 let result = f(self);
524 self.window.z_index_stack.pop();
525 result
526 }
527
528 pub fn paint_shadows(
529 &mut self,
530 bounds: Bounds<Pixels>,
531 corner_radii: Corners<Pixels>,
532 shadows: &[BoxShadow],
533 ) {
534 let scale_factor = self.scale_factor();
535 let content_mask = self.content_mask();
536 let window = &mut *self.window;
537 for shadow in shadows {
538 let mut shadow_bounds = bounds;
539 shadow_bounds.origin += shadow.offset;
540 shadow_bounds.dilate(shadow.spread_radius);
541 window.scene_builder.insert(
542 &window.z_index_stack,
543 Shadow {
544 order: 0,
545 bounds: shadow_bounds.scale(scale_factor),
546 content_mask: content_mask.scale(scale_factor),
547 corner_radii: corner_radii.scale(scale_factor),
548 color: shadow.color,
549 blur_radius: shadow.blur_radius.scale(scale_factor),
550 },
551 );
552 }
553 }
554
555 pub fn paint_quad(
556 &mut self,
557 bounds: Bounds<Pixels>,
558 corner_radii: Corners<Pixels>,
559 background: impl Into<Hsla>,
560 border_widths: Edges<Pixels>,
561 border_color: impl Into<Hsla>,
562 ) {
563 let scale_factor = self.scale_factor();
564 let content_mask = self.content_mask();
565
566 let window = &mut *self.window;
567 window.scene_builder.insert(
568 &window.z_index_stack,
569 Quad {
570 order: 0,
571 bounds: bounds.scale(scale_factor),
572 content_mask: content_mask.scale(scale_factor),
573 background: background.into(),
574 border_color: border_color.into(),
575 corner_radii: corner_radii.scale(scale_factor),
576 border_widths: border_widths.scale(scale_factor),
577 },
578 );
579 }
580
581 pub fn paint_path(&mut self, mut path: Path<Pixels>, color: impl Into<Hsla>) {
582 let scale_factor = self.scale_factor();
583 let content_mask = self.content_mask();
584 path.content_mask = content_mask;
585 path.color = color.into();
586 let window = &mut *self.window;
587 window
588 .scene_builder
589 .insert(&window.z_index_stack, path.scale(scale_factor));
590 }
591
592 pub fn paint_underline(
593 &mut self,
594 origin: Point<Pixels>,
595 width: Pixels,
596 style: &UnderlineStyle,
597 ) -> Result<()> {
598 let scale_factor = self.scale_factor();
599 let height = if style.wavy {
600 style.thickness * 3.
601 } else {
602 style.thickness
603 };
604 let bounds = Bounds {
605 origin,
606 size: size(width, height),
607 };
608 let content_mask = self.content_mask();
609 let window = &mut *self.window;
610 window.scene_builder.insert(
611 &window.z_index_stack,
612 Underline {
613 order: 0,
614 bounds: bounds.scale(scale_factor),
615 content_mask: content_mask.scale(scale_factor),
616 thickness: style.thickness.scale(scale_factor),
617 color: style.color.unwrap_or_default(),
618 wavy: style.wavy,
619 },
620 );
621 Ok(())
622 }
623
624 pub fn paint_glyph(
625 &mut self,
626 origin: Point<Pixels>,
627 font_id: FontId,
628 glyph_id: GlyphId,
629 font_size: Pixels,
630 color: Hsla,
631 ) -> Result<()> {
632 let scale_factor = self.scale_factor();
633 let glyph_origin = origin.scale(scale_factor);
634 let subpixel_variant = Point {
635 x: (glyph_origin.x.0.fract() * SUBPIXEL_VARIANTS as f32).floor() as u8,
636 y: (glyph_origin.y.0.fract() * SUBPIXEL_VARIANTS as f32).floor() as u8,
637 };
638 let params = RenderGlyphParams {
639 font_id,
640 glyph_id,
641 font_size,
642 subpixel_variant,
643 scale_factor,
644 is_emoji: false,
645 };
646
647 let raster_bounds = self.text_system().raster_bounds(¶ms)?;
648 if !raster_bounds.is_zero() {
649 let tile =
650 self.window
651 .sprite_atlas
652 .get_or_insert_with(¶ms.clone().into(), &mut || {
653 let (size, bytes) = self.text_system().rasterize_glyph(¶ms)?;
654 Ok((size, Cow::Owned(bytes)))
655 })?;
656 let bounds = Bounds {
657 origin: glyph_origin.map(|px| px.floor()) + raster_bounds.origin.map(Into::into),
658 size: tile.bounds.size.map(Into::into),
659 };
660 let content_mask = self.content_mask().scale(scale_factor);
661 let window = &mut *self.window;
662 window.scene_builder.insert(
663 &window.z_index_stack,
664 MonochromeSprite {
665 order: 0,
666 bounds,
667 content_mask,
668 color,
669 tile,
670 },
671 );
672 }
673 Ok(())
674 }
675
676 pub fn paint_emoji(
677 &mut self,
678 origin: Point<Pixels>,
679 font_id: FontId,
680 glyph_id: GlyphId,
681 font_size: Pixels,
682 ) -> Result<()> {
683 let scale_factor = self.scale_factor();
684 let glyph_origin = origin.scale(scale_factor);
685 let params = RenderGlyphParams {
686 font_id,
687 glyph_id,
688 font_size,
689 // We don't render emojis with subpixel variants.
690 subpixel_variant: Default::default(),
691 scale_factor,
692 is_emoji: true,
693 };
694
695 let raster_bounds = self.text_system().raster_bounds(¶ms)?;
696 if !raster_bounds.is_zero() {
697 let tile =
698 self.window
699 .sprite_atlas
700 .get_or_insert_with(¶ms.clone().into(), &mut || {
701 let (size, bytes) = self.text_system().rasterize_glyph(¶ms)?;
702 Ok((size, Cow::Owned(bytes)))
703 })?;
704 let bounds = Bounds {
705 origin: glyph_origin.map(|px| px.floor()) + raster_bounds.origin.map(Into::into),
706 size: tile.bounds.size.map(Into::into),
707 };
708 let content_mask = self.content_mask().scale(scale_factor);
709 let window = &mut *self.window;
710
711 window.scene_builder.insert(
712 &window.z_index_stack,
713 PolychromeSprite {
714 order: 0,
715 bounds,
716 corner_radii: Default::default(),
717 content_mask,
718 tile,
719 grayscale: false,
720 },
721 );
722 }
723 Ok(())
724 }
725
726 pub fn paint_svg(
727 &mut self,
728 bounds: Bounds<Pixels>,
729 path: SharedString,
730 color: Hsla,
731 ) -> Result<()> {
732 let scale_factor = self.scale_factor();
733 let bounds = bounds.scale(scale_factor);
734 // Render the SVG at twice the size to get a higher quality result.
735 let params = RenderSvgParams {
736 path,
737 size: bounds
738 .size
739 .map(|pixels| DevicePixels::from((pixels.0 * 2.).ceil() as i32)),
740 };
741
742 let tile =
743 self.window
744 .sprite_atlas
745 .get_or_insert_with(¶ms.clone().into(), &mut || {
746 let bytes = self.svg_renderer.render(¶ms)?;
747 Ok((params.size, Cow::Owned(bytes)))
748 })?;
749 let content_mask = self.content_mask().scale(scale_factor);
750
751 let window = &mut *self.window;
752 window.scene_builder.insert(
753 &window.z_index_stack,
754 MonochromeSprite {
755 order: 0,
756 bounds,
757 content_mask,
758 color,
759 tile,
760 },
761 );
762
763 Ok(())
764 }
765
766 pub fn paint_image(
767 &mut self,
768 bounds: Bounds<Pixels>,
769 corner_radii: Corners<Pixels>,
770 data: Arc<ImageData>,
771 grayscale: bool,
772 ) -> Result<()> {
773 let scale_factor = self.scale_factor();
774 let bounds = bounds.scale(scale_factor);
775 let params = RenderImageParams { image_id: data.id };
776
777 let tile = self
778 .window
779 .sprite_atlas
780 .get_or_insert_with(¶ms.clone().into(), &mut || {
781 Ok((data.size(), Cow::Borrowed(data.as_bytes())))
782 })?;
783 let content_mask = self.content_mask().scale(scale_factor);
784 let corner_radii = corner_radii.scale(scale_factor);
785
786 let window = &mut *self.window;
787 window.scene_builder.insert(
788 &window.z_index_stack,
789 PolychromeSprite {
790 order: 0,
791 bounds,
792 content_mask,
793 corner_radii,
794 tile,
795 grayscale,
796 },
797 );
798 Ok(())
799 }
800
801 pub(crate) fn draw(&mut self) {
802 let unit_entity = self.unit_entity.clone();
803 self.update_entity(&unit_entity, |view, cx| {
804 cx.start_frame();
805
806 let mut root_view = cx.window.root_view.take().unwrap();
807
808 if let Some(element_id) = root_view.id() {
809 cx.with_element_state(element_id, |element_state, cx| {
810 let element_state = draw_with_element_state(&mut root_view, element_state, cx);
811 ((), element_state)
812 });
813 } else {
814 draw_with_element_state(&mut root_view, None, cx);
815 };
816
817 cx.window.root_view = Some(root_view);
818 let scene = cx.window.scene_builder.build();
819
820 cx.run_on_main(view, |_, cx| {
821 cx.window
822 .platform_window
823 .borrow_on_main_thread()
824 .draw(scene);
825 cx.window.dirty = false;
826 })
827 .detach();
828 });
829
830 fn draw_with_element_state(
831 root_view: &mut AnyView,
832 element_state: Option<AnyBox>,
833 cx: &mut ViewContext<()>,
834 ) -> AnyBox {
835 let mut element_state = root_view.initialize(&mut (), element_state, cx);
836 let layout_id = root_view.layout(&mut (), &mut element_state, cx);
837 let available_space = cx.window.content_size.map(Into::into);
838 cx.window
839 .layout_engine
840 .compute_layout(layout_id, available_space);
841 let bounds = cx.window.layout_engine.layout_bounds(layout_id);
842 root_view.paint(bounds, &mut (), &mut element_state, cx);
843 element_state
844 }
845 }
846
847 fn start_frame(&mut self) {
848 self.text_system().start_frame();
849
850 let window = &mut *self.window;
851
852 // Move the current frame element states to the previous frame.
853 // The new empty element states map will be populated for any element states we
854 // reference during the upcoming frame.
855 mem::swap(
856 &mut window.element_states,
857 &mut window.prev_frame_element_states,
858 );
859 window.element_states.clear();
860
861 // Make the current key matchers the previous, and then clear the current.
862 // An empty key matcher map will be created for every identified element in the
863 // upcoming frame.
864 mem::swap(
865 &mut window.key_matchers,
866 &mut window.prev_frame_key_matchers,
867 );
868 window.key_matchers.clear();
869
870 // Clear mouse event listeners, because elements add new element listeners
871 // when the upcoming frame is painted.
872 window.mouse_listeners.values_mut().for_each(Vec::clear);
873
874 // Clear focus state, because we determine what is focused when the new elements
875 // in the upcoming frame are initialized.
876 window.focus_listeners.clear();
877 window.key_dispatch_stack.clear();
878 window.focus_parents_by_child.clear();
879 window.freeze_key_dispatch_stack = false;
880 }
881
882 fn dispatch_event(&mut self, event: InputEvent) -> bool {
883 if let Some(any_mouse_event) = event.mouse_event() {
884 if let Some(MouseMoveEvent { position, .. }) = any_mouse_event.downcast_ref() {
885 self.window.mouse_position = *position;
886 }
887
888 // Handlers may set this to false by calling `stop_propagation`
889 self.app.propagate_event = true;
890 self.window.default_prevented = false;
891
892 if let Some(mut handlers) = self
893 .window
894 .mouse_listeners
895 .remove(&any_mouse_event.type_id())
896 {
897 // Because handlers may add other handlers, we sort every time.
898 handlers.sort_by(|(a, _), (b, _)| a.cmp(b));
899
900 // Capture phase, events bubble from back to front. Handlers for this phase are used for
901 // special purposes, such as detecting events outside of a given Bounds.
902 for (_, handler) in &handlers {
903 handler(any_mouse_event, DispatchPhase::Capture, self);
904 if !self.app.propagate_event {
905 break;
906 }
907 }
908
909 // Bubble phase, where most normal handlers do their work.
910 if self.app.propagate_event {
911 for (_, handler) in handlers.iter().rev() {
912 handler(any_mouse_event, DispatchPhase::Bubble, self);
913 if !self.app.propagate_event {
914 break;
915 }
916 }
917 }
918
919 // Just in case any handlers added new handlers, which is weird, but possible.
920 handlers.extend(
921 self.window
922 .mouse_listeners
923 .get_mut(&any_mouse_event.type_id())
924 .into_iter()
925 .flat_map(|handlers| handlers.drain(..)),
926 );
927 self.window
928 .mouse_listeners
929 .insert(any_mouse_event.type_id(), handlers);
930 }
931 } else if let Some(any_key_event) = event.keyboard_event() {
932 let key_dispatch_stack = mem::take(&mut self.window.key_dispatch_stack);
933 let key_event_type = any_key_event.type_id();
934 let mut context_stack = SmallVec::<[&DispatchContext; 16]>::new();
935
936 for (ix, frame) in key_dispatch_stack.iter().enumerate() {
937 match frame {
938 KeyDispatchStackFrame::Listener {
939 event_type,
940 listener,
941 } => {
942 if key_event_type == *event_type {
943 if let Some(action) = listener(
944 any_key_event,
945 &context_stack,
946 DispatchPhase::Capture,
947 self,
948 ) {
949 self.dispatch_action(action, &key_dispatch_stack[..ix]);
950 }
951 if !self.app.propagate_event {
952 break;
953 }
954 }
955 }
956 KeyDispatchStackFrame::Context(context) => {
957 context_stack.push(&context);
958 }
959 }
960 }
961
962 if self.app.propagate_event {
963 for (ix, frame) in key_dispatch_stack.iter().enumerate().rev() {
964 match frame {
965 KeyDispatchStackFrame::Listener {
966 event_type,
967 listener,
968 } => {
969 if key_event_type == *event_type {
970 if let Some(action) = listener(
971 any_key_event,
972 &context_stack,
973 DispatchPhase::Bubble,
974 self,
975 ) {
976 self.dispatch_action(action, &key_dispatch_stack[..ix]);
977 }
978
979 if !self.app.propagate_event {
980 break;
981 }
982 }
983 }
984 KeyDispatchStackFrame::Context(_) => {
985 context_stack.pop();
986 }
987 }
988 }
989 }
990
991 drop(context_stack);
992 self.window.key_dispatch_stack = key_dispatch_stack;
993 }
994
995 true
996 }
997
998 pub fn match_keystroke(
999 &mut self,
1000 element_id: &GlobalElementId,
1001 keystroke: &Keystroke,
1002 context_stack: &[&DispatchContext],
1003 ) -> KeyMatch {
1004 let key_match = self
1005 .window
1006 .key_matchers
1007 .get_mut(element_id)
1008 .unwrap()
1009 .match_keystroke(keystroke, context_stack);
1010
1011 if key_match.is_some() {
1012 for matcher in self.window.key_matchers.values_mut() {
1013 matcher.clear_pending();
1014 }
1015 }
1016
1017 key_match
1018 }
1019
1020 pub fn observe_global<G: 'static>(
1021 &mut self,
1022 f: impl Fn(&G, &mut WindowContext<'_, '_>) + Send + Sync + 'static,
1023 ) -> Subscription {
1024 let window_id = self.window.handle.id;
1025 self.global_observers.insert(
1026 TypeId::of::<G>(),
1027 Box::new(move |global, cx| {
1028 let global = global.downcast_ref::<G>().unwrap();
1029 cx.update_window(window_id, |cx| f(global, cx)).is_ok()
1030 }),
1031 )
1032 }
1033
1034 fn dispatch_action(
1035 &mut self,
1036 action: Box<dyn Action>,
1037 dispatch_stack: &[KeyDispatchStackFrame],
1038 ) {
1039 let action_type = action.as_any().type_id();
1040
1041 if let Some(mut global_listeners) = self.app.global_action_listeners.remove(&action_type) {
1042 for listener in &global_listeners {
1043 listener(action.as_ref(), DispatchPhase::Capture, self);
1044 if !self.app.propagate_event {
1045 break;
1046 }
1047 }
1048 global_listeners.extend(
1049 self.global_action_listeners
1050 .remove(&action_type)
1051 .unwrap_or_default(),
1052 );
1053 self.global_action_listeners
1054 .insert(action_type, global_listeners);
1055 }
1056
1057 if self.app.propagate_event {
1058 for stack_frame in dispatch_stack {
1059 if let KeyDispatchStackFrame::Listener {
1060 event_type,
1061 listener,
1062 } = stack_frame
1063 {
1064 if action_type == *event_type {
1065 listener(action.as_any(), &[], DispatchPhase::Capture, self);
1066 if !self.app.propagate_event {
1067 break;
1068 }
1069 }
1070 }
1071 }
1072 }
1073
1074 if self.app.propagate_event {
1075 for stack_frame in dispatch_stack.iter().rev() {
1076 if let KeyDispatchStackFrame::Listener {
1077 event_type,
1078 listener,
1079 } = stack_frame
1080 {
1081 if action_type == *event_type {
1082 listener(action.as_any(), &[], DispatchPhase::Bubble, self);
1083 if !self.app.propagate_event {
1084 break;
1085 }
1086 }
1087 }
1088 }
1089 }
1090
1091 if self.app.propagate_event {
1092 if let Some(mut global_listeners) =
1093 self.app.global_action_listeners.remove(&action_type)
1094 {
1095 for listener in global_listeners.iter().rev() {
1096 listener(action.as_ref(), DispatchPhase::Bubble, self);
1097 if !self.app.propagate_event {
1098 break;
1099 }
1100 }
1101 global_listeners.extend(
1102 self.global_action_listeners
1103 .remove(&action_type)
1104 .unwrap_or_default(),
1105 );
1106 self.global_action_listeners
1107 .insert(action_type, global_listeners);
1108 }
1109 }
1110 }
1111}
1112
1113impl<'a, 'w> MainThread<WindowContext<'a, 'w>> {
1114 fn platform(&self) -> &dyn Platform {
1115 self.platform.borrow_on_main_thread()
1116 }
1117}
1118
1119impl Context for WindowContext<'_, '_> {
1120 type EntityContext<'a, 'w, T: 'static + Send + Sync> = ViewContext<'a, 'w, T>;
1121 type Result<T> = T;
1122
1123 fn entity<T: Send + Sync + 'static>(
1124 &mut self,
1125 build_entity: impl FnOnce(&mut Self::EntityContext<'_, '_, T>) -> T,
1126 ) -> Handle<T> {
1127 let slot = self.app.entities.reserve();
1128 let entity = build_entity(&mut ViewContext::mutable(
1129 &mut *self.app,
1130 &mut self.window,
1131 slot.id,
1132 ));
1133 self.entities.insert(slot, entity)
1134 }
1135
1136 fn update_entity<T: Send + Sync + 'static, R>(
1137 &mut self,
1138 handle: &Handle<T>,
1139 update: impl FnOnce(&mut T, &mut Self::EntityContext<'_, '_, T>) -> R,
1140 ) -> R {
1141 let mut entity = self.entities.lease(handle);
1142 let result = update(
1143 &mut *entity,
1144 &mut ViewContext::mutable(&mut *self.app, &mut *self.window, handle.id),
1145 );
1146 self.entities.end_lease(entity);
1147 result
1148 }
1149}
1150
1151impl<'a, 'w> std::ops::Deref for WindowContext<'a, 'w> {
1152 type Target = AppContext;
1153
1154 fn deref(&self) -> &Self::Target {
1155 &self.app
1156 }
1157}
1158
1159impl<'a, 'w> std::ops::DerefMut for WindowContext<'a, 'w> {
1160 fn deref_mut(&mut self) -> &mut Self::Target {
1161 &mut self.app
1162 }
1163}
1164
1165impl BorrowAppContext for WindowContext<'_, '_> {
1166 fn app_mut(&mut self) -> &mut AppContext {
1167 &mut *self.app
1168 }
1169}
1170
1171pub trait BorrowWindow: BorrowAppContext {
1172 fn window(&self) -> &Window;
1173 fn window_mut(&mut self) -> &mut Window;
1174
1175 fn with_element_id<R>(
1176 &mut self,
1177 id: impl Into<ElementId>,
1178 f: impl FnOnce(GlobalElementId, &mut Self) -> R,
1179 ) -> R {
1180 let keymap = self.app_mut().keymap.clone();
1181 let window = self.window_mut();
1182 window.element_id_stack.push(id.into());
1183 let global_id = window.element_id_stack.clone();
1184
1185 if window.key_matchers.get(&global_id).is_none() {
1186 window.key_matchers.insert(
1187 global_id.clone(),
1188 window
1189 .prev_frame_key_matchers
1190 .remove(&global_id)
1191 .unwrap_or_else(|| KeyMatcher::new(keymap)),
1192 );
1193 }
1194
1195 let result = f(global_id, self);
1196 self.window_mut().element_id_stack.pop();
1197 result
1198 }
1199
1200 fn with_content_mask<R>(
1201 &mut self,
1202 mask: ContentMask<Pixels>,
1203 f: impl FnOnce(&mut Self) -> R,
1204 ) -> R {
1205 let mask = mask.intersect(&self.content_mask());
1206 self.window_mut().content_mask_stack.push(mask);
1207 let result = f(self);
1208 self.window_mut().content_mask_stack.pop();
1209 result
1210 }
1211
1212 fn with_scroll_offset<R>(
1213 &mut self,
1214 offset: Option<Point<Pixels>>,
1215 f: impl FnOnce(&mut Self) -> R,
1216 ) -> R {
1217 let Some(offset) = offset else {
1218 return f(self);
1219 };
1220
1221 let offset = self.scroll_offset() + offset;
1222 self.window_mut().scroll_offset_stack.push(offset);
1223 let result = f(self);
1224 self.window_mut().scroll_offset_stack.pop();
1225 result
1226 }
1227
1228 fn scroll_offset(&self) -> Point<Pixels> {
1229 self.window()
1230 .scroll_offset_stack
1231 .last()
1232 .copied()
1233 .unwrap_or_default()
1234 }
1235
1236 fn with_element_state<S: 'static + Send + Sync, R>(
1237 &mut self,
1238 id: ElementId,
1239 f: impl FnOnce(Option<S>, &mut Self) -> (R, S),
1240 ) -> R {
1241 self.with_element_id(id, |global_id, cx| {
1242 if let Some(any) = cx
1243 .window_mut()
1244 .element_states
1245 .remove(&global_id)
1246 .or_else(|| cx.window_mut().prev_frame_element_states.remove(&global_id))
1247 {
1248 // Using the extra inner option to avoid needing to reallocate a new box.
1249 let mut state_box = any
1250 .downcast::<Option<S>>()
1251 .expect("invalid element state type for id");
1252 let state = state_box
1253 .take()
1254 .expect("element state is already on the stack");
1255 let (result, state) = f(Some(state), cx);
1256 state_box.replace(state);
1257 cx.window_mut().element_states.insert(global_id, state_box);
1258 result
1259 } else {
1260 let (result, state) = f(None, cx);
1261 cx.window_mut()
1262 .element_states
1263 .insert(global_id, Box::new(Some(state)));
1264 result
1265 }
1266 })
1267 }
1268
1269 fn content_mask(&self) -> ContentMask<Pixels> {
1270 self.window()
1271 .content_mask_stack
1272 .last()
1273 .cloned()
1274 .unwrap_or_else(|| ContentMask {
1275 bounds: Bounds {
1276 origin: Point::default(),
1277 size: self.window().content_size,
1278 },
1279 })
1280 }
1281
1282 fn rem_size(&self) -> Pixels {
1283 self.window().rem_size
1284 }
1285}
1286
1287impl BorrowWindow for WindowContext<'_, '_> {
1288 fn window(&self) -> &Window {
1289 &*self.window
1290 }
1291
1292 fn window_mut(&mut self) -> &mut Window {
1293 &mut *self.window
1294 }
1295}
1296
1297pub struct ViewContext<'a, 'w, S> {
1298 window_cx: WindowContext<'a, 'w>,
1299 entity_type: PhantomData<S>,
1300 entity_id: EntityId,
1301}
1302
1303impl<S> BorrowAppContext for ViewContext<'_, '_, S> {
1304 fn app_mut(&mut self) -> &mut AppContext {
1305 &mut *self.window_cx.app
1306 }
1307}
1308
1309impl<S> BorrowWindow for ViewContext<'_, '_, S> {
1310 fn window(&self) -> &Window {
1311 &self.window_cx.window
1312 }
1313
1314 fn window_mut(&mut self) -> &mut Window {
1315 &mut *self.window_cx.window
1316 }
1317}
1318
1319impl<'a, 'w, V: Send + Sync + 'static> ViewContext<'a, 'w, V> {
1320 fn mutable(app: &'a mut AppContext, window: &'w mut Window, entity_id: EntityId) -> Self {
1321 Self {
1322 window_cx: WindowContext::mutable(app, window),
1323 entity_id,
1324 entity_type: PhantomData,
1325 }
1326 }
1327
1328 pub fn handle(&self) -> WeakHandle<V> {
1329 self.entities.weak_handle(self.entity_id)
1330 }
1331
1332 pub fn stack<R>(&mut self, order: u32, f: impl FnOnce(&mut Self) -> R) -> R {
1333 self.window.z_index_stack.push(order);
1334 let result = f(self);
1335 self.window.z_index_stack.pop();
1336 result
1337 }
1338
1339 pub fn on_next_frame(&mut self, f: impl FnOnce(&mut V, &mut ViewContext<V>) + Send + 'static) {
1340 let entity = self.handle();
1341 self.window_cx.on_next_frame(move |cx| {
1342 entity.update(cx, f).ok();
1343 });
1344 }
1345
1346 pub fn observe<E: Send + Sync + 'static>(
1347 &mut self,
1348 handle: &Handle<E>,
1349 on_notify: impl Fn(&mut V, Handle<E>, &mut ViewContext<'_, '_, V>) + Send + Sync + 'static,
1350 ) -> Subscription {
1351 let this = self.handle();
1352 let handle = handle.downgrade();
1353 let window_handle = self.window.handle;
1354 self.app.observers.insert(
1355 handle.id,
1356 Box::new(move |cx| {
1357 cx.update_window(window_handle.id, |cx| {
1358 if let Some(handle) = handle.upgrade() {
1359 this.update(cx, |this, cx| on_notify(this, handle, cx))
1360 .is_ok()
1361 } else {
1362 false
1363 }
1364 })
1365 .unwrap_or(false)
1366 }),
1367 )
1368 }
1369
1370 pub fn subscribe<E: EventEmitter + Send + Sync + 'static>(
1371 &mut self,
1372 handle: &Handle<E>,
1373 on_event: impl Fn(&mut V, Handle<E>, &E::Event, &mut ViewContext<'_, '_, V>)
1374 + Send
1375 + Sync
1376 + 'static,
1377 ) -> Subscription {
1378 let this = self.handle();
1379 let handle = handle.downgrade();
1380 let window_handle = self.window.handle;
1381 self.app.event_listeners.insert(
1382 handle.id,
1383 Box::new(move |event, cx| {
1384 cx.update_window(window_handle.id, |cx| {
1385 if let Some(handle) = handle.upgrade() {
1386 let event = event.downcast_ref().expect("invalid event type");
1387 this.update(cx, |this, cx| on_event(this, handle, event, cx))
1388 .is_ok()
1389 } else {
1390 false
1391 }
1392 })
1393 .unwrap_or(false)
1394 }),
1395 )
1396 }
1397
1398 pub fn on_release(
1399 &mut self,
1400 on_release: impl Fn(&mut V, &mut WindowContext) + Send + Sync + 'static,
1401 ) -> Subscription {
1402 let window_handle = self.window.handle;
1403 self.app.release_listeners.insert(
1404 self.entity_id,
1405 Box::new(move |this, cx| {
1406 let this = this.downcast_mut().expect("invalid entity type");
1407 // todo!("are we okay with silently swallowing the error?")
1408 let _ = cx.update_window(window_handle.id, |cx| on_release(this, cx));
1409 }),
1410 )
1411 }
1412
1413 pub fn observe_release<E: Send + Sync + 'static>(
1414 &mut self,
1415 handle: &Handle<E>,
1416 on_release: impl Fn(&mut V, &mut E, &mut ViewContext<'_, '_, V>) + Send + Sync + 'static,
1417 ) -> Subscription {
1418 let this = self.handle();
1419 let window_handle = self.window.handle;
1420 self.app.release_listeners.insert(
1421 handle.id,
1422 Box::new(move |entity, cx| {
1423 let entity = entity.downcast_mut().expect("invalid entity type");
1424 // todo!("are we okay with silently swallowing the error?")
1425 let _ = cx.update_window(window_handle.id, |cx| {
1426 this.update(cx, |this, cx| on_release(this, entity, cx))
1427 });
1428 }),
1429 )
1430 }
1431
1432 pub fn notify(&mut self) {
1433 self.window_cx.notify();
1434 self.window_cx.app.push_effect(Effect::Notify {
1435 emitter: self.entity_id,
1436 });
1437 }
1438
1439 pub fn on_focus_changed(
1440 &mut self,
1441 listener: impl Fn(&mut V, &FocusEvent, &mut ViewContext<V>) + Send + Sync + 'static,
1442 ) {
1443 let handle = self.handle();
1444 self.window.focus_listeners.push(Arc::new(move |event, cx| {
1445 handle
1446 .update(cx, |view, cx| listener(view, event, cx))
1447 .log_err();
1448 }));
1449 }
1450
1451 pub fn with_key_listeners<R>(
1452 &mut self,
1453 key_listeners: &[(TypeId, KeyListener<V>)],
1454 f: impl FnOnce(&mut Self) -> R,
1455 ) -> R {
1456 if !self.window.freeze_key_dispatch_stack {
1457 for (event_type, listener) in key_listeners.iter().cloned() {
1458 let handle = self.handle();
1459 let listener = Arc::new(
1460 move |event: &dyn Any,
1461 context_stack: &[&DispatchContext],
1462 phase: DispatchPhase,
1463 cx: &mut WindowContext<'_, '_>| {
1464 handle
1465 .update(cx, |view, cx| {
1466 listener(view, event, context_stack, phase, cx)
1467 })
1468 .log_err()
1469 .flatten()
1470 },
1471 );
1472 self.window
1473 .key_dispatch_stack
1474 .push(KeyDispatchStackFrame::Listener {
1475 event_type,
1476 listener,
1477 });
1478 }
1479 }
1480
1481 let result = f(self);
1482
1483 if !self.window.freeze_key_dispatch_stack {
1484 let prev_len = self.window.key_dispatch_stack.len() - key_listeners.len();
1485 self.window.key_dispatch_stack.truncate(prev_len);
1486 }
1487
1488 result
1489 }
1490
1491 pub fn with_key_dispatch_context<R>(
1492 &mut self,
1493 context: DispatchContext,
1494 f: impl FnOnce(&mut Self) -> R,
1495 ) -> R {
1496 if context.is_empty() {
1497 return f(self);
1498 }
1499
1500 if !self.window.freeze_key_dispatch_stack {
1501 self.window
1502 .key_dispatch_stack
1503 .push(KeyDispatchStackFrame::Context(context));
1504 }
1505
1506 let result = f(self);
1507
1508 if !self.window.freeze_key_dispatch_stack {
1509 self.window.key_dispatch_stack.pop();
1510 }
1511
1512 result
1513 }
1514
1515 pub fn with_focus<R>(
1516 &mut self,
1517 focus_handle: FocusHandle,
1518 f: impl FnOnce(&mut Self) -> R,
1519 ) -> R {
1520 if let Some(parent_focus_id) = self.window.focus_stack.last().copied() {
1521 self.window
1522 .focus_parents_by_child
1523 .insert(focus_handle.id, parent_focus_id);
1524 }
1525 self.window.focus_stack.push(focus_handle.id);
1526
1527 if Some(focus_handle.id) == self.window.focus {
1528 self.window.freeze_key_dispatch_stack = true;
1529 }
1530
1531 let result = f(self);
1532
1533 self.window.focus_stack.pop();
1534 result
1535 }
1536
1537 pub fn run_on_main<R>(
1538 &mut self,
1539 view: &mut V,
1540 f: impl FnOnce(&mut V, &mut MainThread<ViewContext<'_, '_, V>>) -> R + Send + 'static,
1541 ) -> Task<Result<R>>
1542 where
1543 R: Send + 'static,
1544 {
1545 if self.executor.is_main_thread() {
1546 let cx = unsafe { mem::transmute::<&mut Self, &mut MainThread<Self>>(self) };
1547 Task::ready(Ok(f(view, cx)))
1548 } else {
1549 let handle = self.handle().upgrade().unwrap();
1550 self.window_cx.run_on_main(move |cx| handle.update(cx, f))
1551 }
1552 }
1553
1554 pub fn spawn<Fut, R>(
1555 &mut self,
1556 f: impl FnOnce(WeakHandle<V>, AsyncWindowContext) -> Fut + Send + 'static,
1557 ) -> Task<R>
1558 where
1559 R: Send + 'static,
1560 Fut: Future<Output = R> + Send + 'static,
1561 {
1562 let handle = self.handle();
1563 self.window_cx.spawn(move |_, cx| {
1564 let result = f(handle, cx);
1565 async move { result.await }
1566 })
1567 }
1568
1569 pub fn update_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
1570 where
1571 G: 'static + Send + Sync,
1572 {
1573 let mut global = self.app.lease_global::<G>();
1574 let result = f(global.as_mut(), self);
1575 self.app.restore_global(global);
1576 result
1577 }
1578
1579 pub fn observe_global<G: 'static>(
1580 &mut self,
1581 f: impl Fn(&mut V, &G, &mut ViewContext<'_, '_, V>) + Send + Sync + 'static,
1582 ) -> Subscription {
1583 let window_id = self.window.handle.id;
1584 let handle = self.handle();
1585 self.global_observers.insert(
1586 TypeId::of::<G>(),
1587 Box::new(move |global, cx| {
1588 let global = global.downcast_ref::<G>().unwrap();
1589 cx.update_window(window_id, |cx| {
1590 handle.update(cx, |view, cx| f(view, global, cx)).is_ok()
1591 })
1592 .unwrap_or(false)
1593 }),
1594 )
1595 }
1596
1597 pub fn on_mouse_event<Event: 'static>(
1598 &mut self,
1599 handler: impl Fn(&mut V, &Event, DispatchPhase, &mut ViewContext<V>) + Send + Sync + 'static,
1600 ) {
1601 let handle = self.handle().upgrade().unwrap();
1602 self.window_cx.on_mouse_event(move |event, phase, cx| {
1603 handle.update(cx, |view, cx| {
1604 handler(view, event, phase, cx);
1605 })
1606 });
1607 }
1608}
1609
1610impl<'a, 'w, V: EventEmitter + Send + Sync + 'static> ViewContext<'a, 'w, V> {
1611 pub fn emit(&mut self, event: V::Event) {
1612 let emitter = self.entity_id;
1613 self.app.push_effect(Effect::Emit {
1614 emitter,
1615 event: Box::new(event),
1616 });
1617 }
1618}
1619
1620impl<'a, 'w, V> Context for ViewContext<'a, 'w, V>
1621where
1622 V: 'static + Send + Sync,
1623{
1624 type EntityContext<'b, 'c, U: 'static + Send + Sync> = ViewContext<'b, 'c, U>;
1625 type Result<U> = U;
1626
1627 fn entity<T2: Send + Sync + 'static>(
1628 &mut self,
1629 build_entity: impl FnOnce(&mut Self::EntityContext<'_, '_, T2>) -> T2,
1630 ) -> Handle<T2> {
1631 self.window_cx.entity(build_entity)
1632 }
1633
1634 fn update_entity<U: 'static + Send + Sync, R>(
1635 &mut self,
1636 handle: &Handle<U>,
1637 update: impl FnOnce(&mut U, &mut Self::EntityContext<'_, '_, U>) -> R,
1638 ) -> R {
1639 self.window_cx.update_entity(handle, update)
1640 }
1641}
1642
1643impl<'a, 'w, S: 'static> std::ops::Deref for ViewContext<'a, 'w, S> {
1644 type Target = WindowContext<'a, 'w>;
1645
1646 fn deref(&self) -> &Self::Target {
1647 &self.window_cx
1648 }
1649}
1650
1651impl<'a, 'w, S: 'static> std::ops::DerefMut for ViewContext<'a, 'w, S> {
1652 fn deref_mut(&mut self) -> &mut Self::Target {
1653 &mut self.window_cx
1654 }
1655}
1656
1657// #[derive(Clone, Copy, Eq, PartialEq, Hash)]
1658slotmap::new_key_type! { pub struct WindowId; }
1659
1660#[derive(PartialEq, Eq)]
1661pub struct WindowHandle<S> {
1662 id: WindowId,
1663 state_type: PhantomData<S>,
1664}
1665
1666impl<S> Copy for WindowHandle<S> {}
1667
1668impl<S> Clone for WindowHandle<S> {
1669 fn clone(&self) -> Self {
1670 WindowHandle {
1671 id: self.id,
1672 state_type: PhantomData,
1673 }
1674 }
1675}
1676
1677impl<S> WindowHandle<S> {
1678 pub fn new(id: WindowId) -> Self {
1679 WindowHandle {
1680 id,
1681 state_type: PhantomData,
1682 }
1683 }
1684}
1685
1686impl<S: 'static> Into<AnyWindowHandle> for WindowHandle<S> {
1687 fn into(self) -> AnyWindowHandle {
1688 AnyWindowHandle {
1689 id: self.id,
1690 state_type: TypeId::of::<S>(),
1691 }
1692 }
1693}
1694
1695#[derive(Copy, Clone, PartialEq, Eq)]
1696pub struct AnyWindowHandle {
1697 pub(crate) id: WindowId,
1698 state_type: TypeId,
1699}
1700
1701#[cfg(any(test, feature = "test"))]
1702impl From<SmallVec<[u32; 16]>> for StackingOrder {
1703 fn from(small_vec: SmallVec<[u32; 16]>) -> Self {
1704 StackingOrder(small_vec)
1705 }
1706}
1707
1708#[derive(Clone, Debug, Eq, PartialEq, Hash)]
1709pub enum ElementId {
1710 View(EntityId),
1711 Number(usize),
1712 Name(SharedString),
1713 FocusHandle(FocusId),
1714}
1715
1716impl From<EntityId> for ElementId {
1717 fn from(id: EntityId) -> Self {
1718 ElementId::View(id)
1719 }
1720}
1721
1722impl From<usize> for ElementId {
1723 fn from(id: usize) -> Self {
1724 ElementId::Number(id)
1725 }
1726}
1727
1728impl From<i32> for ElementId {
1729 fn from(id: i32) -> Self {
1730 Self::Number(id as usize)
1731 }
1732}
1733
1734impl From<SharedString> for ElementId {
1735 fn from(name: SharedString) -> Self {
1736 ElementId::Name(name)
1737 }
1738}
1739
1740impl From<&'static str> for ElementId {
1741 fn from(name: &'static str) -> Self {
1742 ElementId::Name(name.into())
1743 }
1744}
1745
1746impl<'a> From<&'a FocusHandle> for ElementId {
1747 fn from(handle: &'a FocusHandle) -> Self {
1748 ElementId::FocusHandle(handle.id)
1749 }
1750}