1use crate::{
2 px, size, Action, AnyBox, AnyView, AppContext, AsyncWindowContext, AvailableSpace, Bounds,
3 BoxShadow, Context, Corners, DevicePixels, DispatchContext, DisplayId, Edges, Effect, Element,
4 EntityId, EventEmitter, FileDropEvent, FocusEvent, FontId, GlobalElementId, GlyphId, Handle,
5 Hsla, ImageData, InputEvent, IsZero, KeyListener, KeyMatch, KeyMatcher, Keystroke, LayoutId,
6 MainThread, MainThreadOnly, MonochromeSprite, MouseMoveEvent, MouseUpEvent, Path, Pixels,
7 PlatformAtlas, PlatformWindow, Point, PolychromeSprite, Quad, Reference, RenderGlyphParams,
8 RenderImageParams, RenderSvgParams, ScaledPixels, SceneBuilder, Shadow, SharedString, Size,
9 Style, Subscription, TaffyLayoutEngine, Task, Underline, UnderlineStyle, WeakHandle,
10 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::{Borrow, BorrowMut, 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 element_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(crate) 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 element_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,
432 {
433 let mut global = self.app.lease_global::<G>();
434 let result = f(&mut global, self);
435 self.app.end_global_lease(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.element_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 cx.stack(0, |cx| {
809 let available_space = cx.window.content_size.map(Into::into);
810 draw_any_view(&mut root_view, available_space, cx);
811 });
812
813 if let Some(mut active_drag) = cx.active_drag.take() {
814 cx.stack(1, |cx| {
815 let offset = cx.mouse_position() - active_drag.cursor_offset;
816 cx.with_element_offset(Some(offset), |cx| {
817 let available_space =
818 size(AvailableSpace::MinContent, AvailableSpace::MinContent);
819 draw_any_view(&mut active_drag.drag_handle_view, available_space, cx);
820 cx.active_drag = Some(active_drag);
821 });
822 });
823 }
824
825 cx.window.root_view = Some(root_view);
826 let scene = cx.window.scene_builder.build();
827
828 cx.run_on_main(view, |_, cx| {
829 cx.window
830 .platform_window
831 .borrow_on_main_thread()
832 .draw(scene);
833 cx.window.dirty = false;
834 })
835 .detach();
836 });
837
838 fn draw_any_view(
839 view: &mut AnyView,
840 available_space: Size<AvailableSpace>,
841 cx: &mut ViewContext<()>,
842 ) {
843 cx.with_optional_element_state(view.id(), |element_state, cx| {
844 let mut element_state = view.initialize(&mut (), element_state, cx);
845 let layout_id = view.layout(&mut (), &mut element_state, cx);
846 cx.window
847 .layout_engine
848 .compute_layout(layout_id, available_space);
849 let bounds = cx.window.layout_engine.layout_bounds(layout_id);
850 view.paint(bounds, &mut (), &mut element_state, cx);
851 ((), element_state)
852 });
853 }
854 }
855
856 fn start_frame(&mut self) {
857 self.text_system().start_frame();
858
859 let window = &mut *self.window;
860
861 // Move the current frame element states to the previous frame.
862 // The new empty element states map will be populated for any element states we
863 // reference during the upcoming frame.
864 mem::swap(
865 &mut window.element_states,
866 &mut window.prev_frame_element_states,
867 );
868 window.element_states.clear();
869
870 // Make the current key matchers the previous, and then clear the current.
871 // An empty key matcher map will be created for every identified element in the
872 // upcoming frame.
873 mem::swap(
874 &mut window.key_matchers,
875 &mut window.prev_frame_key_matchers,
876 );
877 window.key_matchers.clear();
878
879 // Clear mouse event listeners, because elements add new element listeners
880 // when the upcoming frame is painted.
881 window.mouse_listeners.values_mut().for_each(Vec::clear);
882
883 // Clear focus state, because we determine what is focused when the new elements
884 // in the upcoming frame are initialized.
885 window.focus_listeners.clear();
886 window.key_dispatch_stack.clear();
887 window.focus_parents_by_child.clear();
888 window.freeze_key_dispatch_stack = false;
889 }
890
891 fn dispatch_event(&mut self, event: InputEvent) -> bool {
892 if let Some(any_mouse_event) = event.mouse_event() {
893 if let Some(MouseMoveEvent { position, .. }) = any_mouse_event.downcast_ref() {
894 self.window.mouse_position = *position;
895 }
896
897 match any_mouse_event.downcast_ref() {
898 Some(FileDropEvent::Pending { position }) => {
899 dbg!("FileDropEvent::Pending", position);
900 return true;
901 }
902 Some(FileDropEvent::Submit { position, paths }) => {
903 dbg!("FileDropEvent::Submit", position, paths);
904 return true;
905 }
906 Some(FileDropEvent::End) => {
907 self.active_drag = None;
908 return true;
909 }
910 _ => {}
911 }
912
913 // Handlers may set this to false by calling `stop_propagation`
914 self.app.propagate_event = true;
915 self.window.default_prevented = false;
916
917 if let Some(mut handlers) = self
918 .window
919 .mouse_listeners
920 .remove(&any_mouse_event.type_id())
921 {
922 // Because handlers may add other handlers, we sort every time.
923 handlers.sort_by(|(a, _), (b, _)| a.cmp(b));
924
925 // Capture phase, events bubble from back to front. Handlers for this phase are used for
926 // special purposes, such as detecting events outside of a given Bounds.
927 for (_, handler) in &handlers {
928 handler(any_mouse_event, DispatchPhase::Capture, self);
929 if !self.app.propagate_event {
930 break;
931 }
932 }
933
934 // Bubble phase, where most normal handlers do their work.
935 if self.app.propagate_event {
936 for (_, handler) in handlers.iter().rev() {
937 handler(any_mouse_event, DispatchPhase::Bubble, self);
938 if !self.app.propagate_event {
939 break;
940 }
941 }
942 }
943
944 if self.app.propagate_event
945 && any_mouse_event.downcast_ref::<MouseUpEvent>().is_some()
946 {
947 self.active_drag = None;
948 }
949
950 // Just in case any handlers added new handlers, which is weird, but possible.
951 handlers.extend(
952 self.window
953 .mouse_listeners
954 .get_mut(&any_mouse_event.type_id())
955 .into_iter()
956 .flat_map(|handlers| handlers.drain(..)),
957 );
958 self.window
959 .mouse_listeners
960 .insert(any_mouse_event.type_id(), handlers);
961 }
962 } else if let Some(any_key_event) = event.keyboard_event() {
963 let key_dispatch_stack = mem::take(&mut self.window.key_dispatch_stack);
964 let key_event_type = any_key_event.type_id();
965 let mut context_stack = SmallVec::<[&DispatchContext; 16]>::new();
966
967 for (ix, frame) in key_dispatch_stack.iter().enumerate() {
968 match frame {
969 KeyDispatchStackFrame::Listener {
970 event_type,
971 listener,
972 } => {
973 if key_event_type == *event_type {
974 if let Some(action) = listener(
975 any_key_event,
976 &context_stack,
977 DispatchPhase::Capture,
978 self,
979 ) {
980 self.dispatch_action(action, &key_dispatch_stack[..ix]);
981 }
982 if !self.app.propagate_event {
983 break;
984 }
985 }
986 }
987 KeyDispatchStackFrame::Context(context) => {
988 context_stack.push(&context);
989 }
990 }
991 }
992
993 if self.app.propagate_event {
994 for (ix, frame) in key_dispatch_stack.iter().enumerate().rev() {
995 match frame {
996 KeyDispatchStackFrame::Listener {
997 event_type,
998 listener,
999 } => {
1000 if key_event_type == *event_type {
1001 if let Some(action) = listener(
1002 any_key_event,
1003 &context_stack,
1004 DispatchPhase::Bubble,
1005 self,
1006 ) {
1007 self.dispatch_action(action, &key_dispatch_stack[..ix]);
1008 }
1009
1010 if !self.app.propagate_event {
1011 break;
1012 }
1013 }
1014 }
1015 KeyDispatchStackFrame::Context(_) => {
1016 context_stack.pop();
1017 }
1018 }
1019 }
1020 }
1021
1022 drop(context_stack);
1023 self.window.key_dispatch_stack = key_dispatch_stack;
1024 }
1025
1026 true
1027 }
1028
1029 pub fn match_keystroke(
1030 &mut self,
1031 element_id: &GlobalElementId,
1032 keystroke: &Keystroke,
1033 context_stack: &[&DispatchContext],
1034 ) -> KeyMatch {
1035 let key_match = self
1036 .window
1037 .key_matchers
1038 .get_mut(element_id)
1039 .unwrap()
1040 .match_keystroke(keystroke, context_stack);
1041
1042 if key_match.is_some() {
1043 for matcher in self.window.key_matchers.values_mut() {
1044 matcher.clear_pending();
1045 }
1046 }
1047
1048 key_match
1049 }
1050
1051 pub fn observe_global<G: 'static>(
1052 &mut self,
1053 f: impl Fn(&mut WindowContext<'_, '_>) + Send + Sync + 'static,
1054 ) -> Subscription {
1055 let window_id = self.window.handle.id;
1056 self.global_observers.insert(
1057 TypeId::of::<G>(),
1058 Box::new(move |cx| cx.update_window(window_id, |cx| f(cx)).is_ok()),
1059 )
1060 }
1061
1062 fn dispatch_action(
1063 &mut self,
1064 action: Box<dyn Action>,
1065 dispatch_stack: &[KeyDispatchStackFrame],
1066 ) {
1067 let action_type = action.as_any().type_id();
1068
1069 if let Some(mut global_listeners) = self.app.global_action_listeners.remove(&action_type) {
1070 for listener in &global_listeners {
1071 listener(action.as_ref(), DispatchPhase::Capture, self);
1072 if !self.app.propagate_event {
1073 break;
1074 }
1075 }
1076 global_listeners.extend(
1077 self.global_action_listeners
1078 .remove(&action_type)
1079 .unwrap_or_default(),
1080 );
1081 self.global_action_listeners
1082 .insert(action_type, global_listeners);
1083 }
1084
1085 if self.app.propagate_event {
1086 for stack_frame in dispatch_stack {
1087 if let KeyDispatchStackFrame::Listener {
1088 event_type,
1089 listener,
1090 } = stack_frame
1091 {
1092 if action_type == *event_type {
1093 listener(action.as_any(), &[], DispatchPhase::Capture, self);
1094 if !self.app.propagate_event {
1095 break;
1096 }
1097 }
1098 }
1099 }
1100 }
1101
1102 if self.app.propagate_event {
1103 for stack_frame in dispatch_stack.iter().rev() {
1104 if let KeyDispatchStackFrame::Listener {
1105 event_type,
1106 listener,
1107 } = stack_frame
1108 {
1109 if action_type == *event_type {
1110 listener(action.as_any(), &[], DispatchPhase::Bubble, self);
1111 if !self.app.propagate_event {
1112 break;
1113 }
1114 }
1115 }
1116 }
1117 }
1118
1119 if self.app.propagate_event {
1120 if let Some(mut global_listeners) =
1121 self.app.global_action_listeners.remove(&action_type)
1122 {
1123 for listener in global_listeners.iter().rev() {
1124 listener(action.as_ref(), DispatchPhase::Bubble, self);
1125 if !self.app.propagate_event {
1126 break;
1127 }
1128 }
1129 global_listeners.extend(
1130 self.global_action_listeners
1131 .remove(&action_type)
1132 .unwrap_or_default(),
1133 );
1134 self.global_action_listeners
1135 .insert(action_type, global_listeners);
1136 }
1137 }
1138 }
1139}
1140
1141impl Context for WindowContext<'_, '_> {
1142 type EntityContext<'a, 'w, T> = ViewContext<'a, 'w, T>;
1143 type Result<T> = T;
1144
1145 fn entity<T>(
1146 &mut self,
1147 build_entity: impl FnOnce(&mut Self::EntityContext<'_, '_, T>) -> T,
1148 ) -> Handle<T>
1149 where
1150 T: Any + Send + Sync,
1151 {
1152 let slot = self.app.entities.reserve();
1153 let entity = build_entity(&mut ViewContext::mutable(
1154 &mut *self.app,
1155 &mut self.window,
1156 slot.downgrade(),
1157 ));
1158 self.entities.insert(slot, entity)
1159 }
1160
1161 fn update_entity<T: 'static, R>(
1162 &mut self,
1163 handle: &Handle<T>,
1164 update: impl FnOnce(&mut T, &mut Self::EntityContext<'_, '_, T>) -> R,
1165 ) -> R {
1166 let mut entity = self.entities.lease(handle);
1167 let result = update(
1168 &mut *entity,
1169 &mut ViewContext::mutable(&mut *self.app, &mut *self.window, handle.downgrade()),
1170 );
1171 self.entities.end_lease(entity);
1172 result
1173 }
1174}
1175
1176impl<'a, 'w> std::ops::Deref for WindowContext<'a, 'w> {
1177 type Target = AppContext;
1178
1179 fn deref(&self) -> &Self::Target {
1180 &self.app
1181 }
1182}
1183
1184impl<'a, 'w> std::ops::DerefMut for WindowContext<'a, 'w> {
1185 fn deref_mut(&mut self) -> &mut Self::Target {
1186 &mut self.app
1187 }
1188}
1189
1190impl<'a, 'w> Borrow<AppContext> for WindowContext<'a, 'w> {
1191 fn borrow(&self) -> &AppContext {
1192 &self.app
1193 }
1194}
1195
1196impl<'a, 'w> BorrowMut<AppContext> for WindowContext<'a, 'w> {
1197 fn borrow_mut(&mut self) -> &mut AppContext {
1198 &mut self.app
1199 }
1200}
1201
1202pub trait BorrowWindow: BorrowMut<Window> + BorrowMut<AppContext> {
1203 fn app_mut(&mut self) -> &mut AppContext {
1204 self.borrow_mut()
1205 }
1206
1207 fn window(&self) -> &Window {
1208 self.borrow()
1209 }
1210
1211 fn window_mut(&mut self) -> &mut Window {
1212 self.borrow_mut()
1213 }
1214
1215 fn with_element_id<R>(
1216 &mut self,
1217 id: impl Into<ElementId>,
1218 f: impl FnOnce(GlobalElementId, &mut Self) -> R,
1219 ) -> R {
1220 let keymap = self.app_mut().keymap.clone();
1221 let window = self.window_mut();
1222 window.element_id_stack.push(id.into());
1223 let global_id = window.element_id_stack.clone();
1224
1225 if window.key_matchers.get(&global_id).is_none() {
1226 window.key_matchers.insert(
1227 global_id.clone(),
1228 window
1229 .prev_frame_key_matchers
1230 .remove(&global_id)
1231 .unwrap_or_else(|| KeyMatcher::new(keymap)),
1232 );
1233 }
1234
1235 let result = f(global_id, self);
1236 let window: &mut Window = self.borrow_mut();
1237 window.element_id_stack.pop();
1238 result
1239 }
1240
1241 fn with_content_mask<R>(
1242 &mut self,
1243 mask: ContentMask<Pixels>,
1244 f: impl FnOnce(&mut Self) -> R,
1245 ) -> R {
1246 let mask = mask.intersect(&self.content_mask());
1247 self.window_mut().content_mask_stack.push(mask);
1248 let result = f(self);
1249 self.window_mut().content_mask_stack.pop();
1250 result
1251 }
1252
1253 fn with_element_offset<R>(
1254 &mut self,
1255 offset: Option<Point<Pixels>>,
1256 f: impl FnOnce(&mut Self) -> R,
1257 ) -> R {
1258 let Some(offset) = offset else {
1259 return f(self);
1260 };
1261
1262 let offset = self.element_offset() + offset;
1263 self.window_mut().element_offset_stack.push(offset);
1264 let result = f(self);
1265 self.window_mut().element_offset_stack.pop();
1266 result
1267 }
1268
1269 fn element_offset(&self) -> Point<Pixels> {
1270 self.window()
1271 .element_offset_stack
1272 .last()
1273 .copied()
1274 .unwrap_or_default()
1275 }
1276
1277 fn with_element_state<S, R>(
1278 &mut self,
1279 id: ElementId,
1280 f: impl FnOnce(Option<S>, &mut Self) -> (R, S),
1281 ) -> R
1282 where
1283 S: Any + Send + Sync,
1284 {
1285 self.with_element_id(id, |global_id, cx| {
1286 if let Some(any) = cx
1287 .window_mut()
1288 .element_states
1289 .remove(&global_id)
1290 .or_else(|| cx.window_mut().prev_frame_element_states.remove(&global_id))
1291 {
1292 // Using the extra inner option to avoid needing to reallocate a new box.
1293 let mut state_box = any
1294 .downcast::<Option<S>>()
1295 .expect("invalid element state type for id");
1296 let state = state_box
1297 .take()
1298 .expect("element state is already on the stack");
1299 let (result, state) = f(Some(state), cx);
1300 state_box.replace(state);
1301 cx.window_mut().element_states.insert(global_id, state_box);
1302 result
1303 } else {
1304 let (result, state) = f(None, cx);
1305 cx.window_mut()
1306 .element_states
1307 .insert(global_id, Box::new(Some(state)));
1308 result
1309 }
1310 })
1311 }
1312
1313 fn with_optional_element_state<S, R>(
1314 &mut self,
1315 element_id: Option<ElementId>,
1316 f: impl FnOnce(Option<S>, &mut Self) -> (R, S),
1317 ) -> R
1318 where
1319 S: Any + Send + Sync,
1320 {
1321 if let Some(element_id) = element_id {
1322 self.with_element_state(element_id, f)
1323 } else {
1324 f(None, self).0
1325 }
1326 }
1327
1328 fn content_mask(&self) -> ContentMask<Pixels> {
1329 self.window()
1330 .content_mask_stack
1331 .last()
1332 .cloned()
1333 .unwrap_or_else(|| ContentMask {
1334 bounds: Bounds {
1335 origin: Point::default(),
1336 size: self.window().content_size,
1337 },
1338 })
1339 }
1340
1341 fn rem_size(&self) -> Pixels {
1342 self.window().rem_size
1343 }
1344}
1345
1346impl Borrow<Window> for WindowContext<'_, '_> {
1347 fn borrow(&self) -> &Window {
1348 &self.window
1349 }
1350}
1351
1352impl BorrowMut<Window> for WindowContext<'_, '_> {
1353 fn borrow_mut(&mut self) -> &mut Window {
1354 &mut self.window
1355 }
1356}
1357
1358impl<T> BorrowWindow for T where T: BorrowMut<AppContext> + BorrowMut<Window> {}
1359
1360pub struct ViewContext<'a, 'w, V> {
1361 window_cx: WindowContext<'a, 'w>,
1362 view_state: WeakHandle<V>,
1363}
1364
1365impl<V> Borrow<AppContext> for ViewContext<'_, '_, V> {
1366 fn borrow(&self) -> &AppContext {
1367 &*self.window_cx.app
1368 }
1369}
1370
1371impl<V> BorrowMut<AppContext> for ViewContext<'_, '_, V> {
1372 fn borrow_mut(&mut self) -> &mut AppContext {
1373 &mut *self.window_cx.app
1374 }
1375}
1376
1377impl<V> Borrow<Window> for ViewContext<'_, '_, V> {
1378 fn borrow(&self) -> &Window {
1379 &*self.window_cx.window
1380 }
1381}
1382
1383impl<V> BorrowMut<Window> for ViewContext<'_, '_, V> {
1384 fn borrow_mut(&mut self) -> &mut Window {
1385 &mut *self.window_cx.window
1386 }
1387}
1388
1389impl<'a, 'w, V: 'static> ViewContext<'a, 'w, V> {
1390 fn mutable(app: &'a mut AppContext, window: &'w mut Window, view_state: WeakHandle<V>) -> Self {
1391 Self {
1392 window_cx: WindowContext::mutable(app, window),
1393 view_state,
1394 }
1395 }
1396
1397 pub fn handle(&self) -> WeakHandle<V> {
1398 self.view_state.clone()
1399 }
1400
1401 pub fn stack<R>(&mut self, order: u32, f: impl FnOnce(&mut Self) -> R) -> R {
1402 self.window.z_index_stack.push(order);
1403 let result = f(self);
1404 self.window.z_index_stack.pop();
1405 result
1406 }
1407
1408 pub fn on_next_frame(&mut self, f: impl FnOnce(&mut V, &mut ViewContext<V>) + Send + 'static)
1409 where
1410 V: Any + Send + Sync,
1411 {
1412 let entity = self.handle();
1413 self.window_cx.on_next_frame(move |cx| {
1414 entity.update(cx, f).ok();
1415 });
1416 }
1417
1418 pub fn observe<E>(
1419 &mut self,
1420 handle: &Handle<E>,
1421 mut on_notify: impl FnMut(&mut V, Handle<E>, &mut ViewContext<'_, '_, V>)
1422 + Send
1423 + Sync
1424 + 'static,
1425 ) -> Subscription
1426 where
1427 E: 'static,
1428 V: Any + Send + Sync,
1429 {
1430 let this = self.handle();
1431 let handle = handle.downgrade();
1432 let window_handle = self.window.handle;
1433 self.app.observers.insert(
1434 handle.entity_id,
1435 Box::new(move |cx| {
1436 cx.update_window(window_handle.id, |cx| {
1437 if let Some(handle) = handle.upgrade() {
1438 this.update(cx, |this, cx| on_notify(this, handle, cx))
1439 .is_ok()
1440 } else {
1441 false
1442 }
1443 })
1444 .unwrap_or(false)
1445 }),
1446 )
1447 }
1448
1449 pub fn subscribe<E: EventEmitter>(
1450 &mut self,
1451 handle: &Handle<E>,
1452 mut on_event: impl FnMut(&mut V, Handle<E>, &E::Event, &mut ViewContext<'_, '_, V>)
1453 + Send
1454 + Sync
1455 + 'static,
1456 ) -> Subscription {
1457 let this = self.handle();
1458 let handle = handle.downgrade();
1459 let window_handle = self.window.handle;
1460 self.app.event_listeners.insert(
1461 handle.entity_id,
1462 Box::new(move |event, cx| {
1463 cx.update_window(window_handle.id, |cx| {
1464 if let Some(handle) = handle.upgrade() {
1465 let event = event.downcast_ref().expect("invalid event type");
1466 this.update(cx, |this, cx| on_event(this, handle, event, cx))
1467 .is_ok()
1468 } else {
1469 false
1470 }
1471 })
1472 .unwrap_or(false)
1473 }),
1474 )
1475 }
1476
1477 pub fn on_release(
1478 &mut self,
1479 mut on_release: impl FnMut(&mut V, &mut WindowContext) + Send + Sync + 'static,
1480 ) -> Subscription {
1481 let window_handle = self.window.handle;
1482 self.app.release_listeners.insert(
1483 self.view_state.entity_id,
1484 Box::new(move |this, cx| {
1485 let this = this.downcast_mut().expect("invalid entity type");
1486 // todo!("are we okay with silently swallowing the error?")
1487 let _ = cx.update_window(window_handle.id, |cx| on_release(this, cx));
1488 }),
1489 )
1490 }
1491
1492 pub fn observe_release<T: 'static>(
1493 &mut self,
1494 handle: &Handle<T>,
1495 mut on_release: impl FnMut(&mut V, &mut T, &mut ViewContext<'_, '_, V>) + Send + Sync + 'static,
1496 ) -> Subscription
1497 where
1498 V: Any + Send + Sync,
1499 {
1500 let this = self.handle();
1501 let window_handle = self.window.handle;
1502 self.app.release_listeners.insert(
1503 handle.entity_id,
1504 Box::new(move |entity, cx| {
1505 let entity = entity.downcast_mut().expect("invalid entity type");
1506 // todo!("are we okay with silently swallowing the error?")
1507 let _ = cx.update_window(window_handle.id, |cx| {
1508 this.update(cx, |this, cx| on_release(this, entity, cx))
1509 });
1510 }),
1511 )
1512 }
1513
1514 pub fn notify(&mut self) {
1515 self.window_cx.notify();
1516 self.window_cx.app.push_effect(Effect::Notify {
1517 emitter: self.view_state.entity_id,
1518 });
1519 }
1520
1521 pub fn on_focus_changed(
1522 &mut self,
1523 listener: impl Fn(&mut V, &FocusEvent, &mut ViewContext<V>) + Send + Sync + 'static,
1524 ) {
1525 let handle = self.handle();
1526 self.window.focus_listeners.push(Arc::new(move |event, cx| {
1527 handle
1528 .update(cx, |view, cx| listener(view, event, cx))
1529 .log_err();
1530 }));
1531 }
1532
1533 pub fn with_key_listeners<R>(
1534 &mut self,
1535 key_listeners: &[(TypeId, KeyListener<V>)],
1536 f: impl FnOnce(&mut Self) -> R,
1537 ) -> R {
1538 if !self.window.freeze_key_dispatch_stack {
1539 for (event_type, listener) in key_listeners.iter().cloned() {
1540 let handle = self.handle();
1541 let listener = Arc::new(
1542 move |event: &dyn Any,
1543 context_stack: &[&DispatchContext],
1544 phase: DispatchPhase,
1545 cx: &mut WindowContext<'_, '_>| {
1546 handle
1547 .update(cx, |view, cx| {
1548 listener(view, event, context_stack, phase, cx)
1549 })
1550 .log_err()
1551 .flatten()
1552 },
1553 );
1554 self.window
1555 .key_dispatch_stack
1556 .push(KeyDispatchStackFrame::Listener {
1557 event_type,
1558 listener,
1559 });
1560 }
1561 }
1562
1563 let result = f(self);
1564
1565 if !self.window.freeze_key_dispatch_stack {
1566 let prev_len = self.window.key_dispatch_stack.len() - key_listeners.len();
1567 self.window.key_dispatch_stack.truncate(prev_len);
1568 }
1569
1570 result
1571 }
1572
1573 pub fn with_key_dispatch_context<R>(
1574 &mut self,
1575 context: DispatchContext,
1576 f: impl FnOnce(&mut Self) -> R,
1577 ) -> R {
1578 if context.is_empty() {
1579 return f(self);
1580 }
1581
1582 if !self.window.freeze_key_dispatch_stack {
1583 self.window
1584 .key_dispatch_stack
1585 .push(KeyDispatchStackFrame::Context(context));
1586 }
1587
1588 let result = f(self);
1589
1590 if !self.window.freeze_key_dispatch_stack {
1591 self.window.key_dispatch_stack.pop();
1592 }
1593
1594 result
1595 }
1596
1597 pub fn with_focus<R>(
1598 &mut self,
1599 focus_handle: FocusHandle,
1600 f: impl FnOnce(&mut Self) -> R,
1601 ) -> R {
1602 if let Some(parent_focus_id) = self.window.focus_stack.last().copied() {
1603 self.window
1604 .focus_parents_by_child
1605 .insert(focus_handle.id, parent_focus_id);
1606 }
1607 self.window.focus_stack.push(focus_handle.id);
1608
1609 if Some(focus_handle.id) == self.window.focus {
1610 self.window.freeze_key_dispatch_stack = true;
1611 }
1612
1613 let result = f(self);
1614
1615 self.window.focus_stack.pop();
1616 result
1617 }
1618
1619 pub fn run_on_main<R>(
1620 &mut self,
1621 view: &mut V,
1622 f: impl FnOnce(&mut V, &mut MainThread<ViewContext<'_, '_, V>>) -> R + Send + 'static,
1623 ) -> Task<Result<R>>
1624 where
1625 R: Send + 'static,
1626 {
1627 if self.executor.is_main_thread() {
1628 let cx = unsafe { mem::transmute::<&mut Self, &mut MainThread<Self>>(self) };
1629 Task::ready(Ok(f(view, cx)))
1630 } else {
1631 let handle = self.handle().upgrade().unwrap();
1632 self.window_cx.run_on_main(move |cx| handle.update(cx, f))
1633 }
1634 }
1635
1636 pub fn spawn<Fut, R>(
1637 &mut self,
1638 f: impl FnOnce(WeakHandle<V>, AsyncWindowContext) -> Fut + Send + 'static,
1639 ) -> Task<R>
1640 where
1641 R: Send + 'static,
1642 Fut: Future<Output = R> + Send + 'static,
1643 {
1644 let handle = self.handle();
1645 self.window_cx.spawn(move |_, cx| {
1646 let result = f(handle, cx);
1647 async move { result.await }
1648 })
1649 }
1650
1651 pub fn update_global<G, R>(&mut self, f: impl FnOnce(&mut G, &mut Self) -> R) -> R
1652 where
1653 G: 'static + Send + Sync,
1654 {
1655 let mut global = self.app.lease_global::<G>();
1656 let result = f(&mut global, self);
1657 self.app.end_global_lease(global);
1658 result
1659 }
1660
1661 pub fn observe_global<G: 'static>(
1662 &mut self,
1663 f: impl Fn(&mut V, &mut ViewContext<'_, '_, V>) + Send + Sync + 'static,
1664 ) -> Subscription {
1665 let window_id = self.window.handle.id;
1666 let handle = self.handle();
1667 self.global_observers.insert(
1668 TypeId::of::<G>(),
1669 Box::new(move |cx| {
1670 cx.update_window(window_id, |cx| {
1671 handle.update(cx, |view, cx| f(view, cx)).is_ok()
1672 })
1673 .unwrap_or(false)
1674 }),
1675 )
1676 }
1677
1678 pub fn on_mouse_event<Event: 'static>(
1679 &mut self,
1680 handler: impl Fn(&mut V, &Event, DispatchPhase, &mut ViewContext<V>) + Send + Sync + 'static,
1681 ) {
1682 let handle = self.handle().upgrade().unwrap();
1683 self.window_cx.on_mouse_event(move |event, phase, cx| {
1684 handle.update(cx, |view, cx| {
1685 handler(view, event, phase, cx);
1686 })
1687 });
1688 }
1689}
1690
1691impl<'a, 'w, V> ViewContext<'a, 'w, V>
1692where
1693 V: EventEmitter,
1694 V::Event: Any + Send + Sync,
1695{
1696 pub fn emit(&mut self, event: V::Event) {
1697 let emitter = self.view_state.entity_id;
1698 self.app.push_effect(Effect::Emit {
1699 emitter,
1700 event: Box::new(event),
1701 });
1702 }
1703}
1704
1705impl<'a, 'w, V> Context for ViewContext<'a, 'w, V> {
1706 type EntityContext<'b, 'c, U> = ViewContext<'b, 'c, U>;
1707 type Result<U> = U;
1708
1709 fn entity<T>(
1710 &mut self,
1711 build_entity: impl FnOnce(&mut Self::EntityContext<'_, '_, T>) -> T,
1712 ) -> Handle<T>
1713 where
1714 T: 'static + Send + Sync,
1715 {
1716 self.window_cx.entity(build_entity)
1717 }
1718
1719 fn update_entity<T: 'static, R>(
1720 &mut self,
1721 handle: &Handle<T>,
1722 update: impl FnOnce(&mut T, &mut Self::EntityContext<'_, '_, T>) -> R,
1723 ) -> R {
1724 self.window_cx.update_entity(handle, update)
1725 }
1726}
1727
1728impl<'a, 'w, V> std::ops::Deref for ViewContext<'a, 'w, V> {
1729 type Target = WindowContext<'a, 'w>;
1730
1731 fn deref(&self) -> &Self::Target {
1732 &self.window_cx
1733 }
1734}
1735
1736impl<'a, 'w, V> std::ops::DerefMut for ViewContext<'a, 'w, V> {
1737 fn deref_mut(&mut self) -> &mut Self::Target {
1738 &mut self.window_cx
1739 }
1740}
1741
1742// #[derive(Clone, Copy, Eq, PartialEq, Hash)]
1743slotmap::new_key_type! { pub struct WindowId; }
1744
1745impl WindowId {
1746 pub fn as_u64(&self) -> u64 {
1747 self.0.as_ffi()
1748 }
1749}
1750
1751#[derive(PartialEq, Eq)]
1752pub struct WindowHandle<V> {
1753 id: WindowId,
1754 state_type: PhantomData<V>,
1755}
1756
1757impl<S> Copy for WindowHandle<S> {}
1758
1759impl<S> Clone for WindowHandle<S> {
1760 fn clone(&self) -> Self {
1761 WindowHandle {
1762 id: self.id,
1763 state_type: PhantomData,
1764 }
1765 }
1766}
1767
1768impl<S> WindowHandle<S> {
1769 pub fn new(id: WindowId) -> Self {
1770 WindowHandle {
1771 id,
1772 state_type: PhantomData,
1773 }
1774 }
1775}
1776
1777impl<S: 'static> Into<AnyWindowHandle> for WindowHandle<S> {
1778 fn into(self) -> AnyWindowHandle {
1779 AnyWindowHandle {
1780 id: self.id,
1781 state_type: TypeId::of::<S>(),
1782 }
1783 }
1784}
1785
1786#[derive(Copy, Clone, PartialEq, Eq)]
1787pub struct AnyWindowHandle {
1788 pub(crate) id: WindowId,
1789 state_type: TypeId,
1790}
1791
1792impl AnyWindowHandle {
1793 pub fn window_id(&self) -> WindowId {
1794 self.id
1795 }
1796}
1797
1798#[cfg(any(test, feature = "test"))]
1799impl From<SmallVec<[u32; 16]>> for StackingOrder {
1800 fn from(small_vec: SmallVec<[u32; 16]>) -> Self {
1801 StackingOrder(small_vec)
1802 }
1803}
1804
1805#[derive(Clone, Debug, Eq, PartialEq, Hash)]
1806pub enum ElementId {
1807 View(EntityId),
1808 Number(usize),
1809 Name(SharedString),
1810 FocusHandle(FocusId),
1811}
1812
1813impl From<EntityId> for ElementId {
1814 fn from(id: EntityId) -> Self {
1815 ElementId::View(id)
1816 }
1817}
1818
1819impl From<usize> for ElementId {
1820 fn from(id: usize) -> Self {
1821 ElementId::Number(id)
1822 }
1823}
1824
1825impl From<i32> for ElementId {
1826 fn from(id: i32) -> Self {
1827 Self::Number(id as usize)
1828 }
1829}
1830
1831impl From<SharedString> for ElementId {
1832 fn from(name: SharedString) -> Self {
1833 ElementId::Name(name)
1834 }
1835}
1836
1837impl From<&'static str> for ElementId {
1838 fn from(name: &'static str) -> Self {
1839 ElementId::Name(name.into())
1840 }
1841}
1842
1843impl<'a> From<&'a FocusHandle> for ElementId {
1844 fn from(handle: &'a FocusHandle) -> Self {
1845 ElementId::FocusHandle(handle.id)
1846 }
1847}