Skip to main content

zng_wgt/
node.rs

1//! Helper nodes.
2//!
3//! This module defines some foundational nodes that can be used for declaring properties and widgets.
4
5use std::{any::Any, sync::Arc};
6
7use crate::WidgetFn;
8use zng_app::{
9    event::{Command, CommandHandle, CommandScope, Event, EventArgs},
10    handler::{Handler, HandlerExt as _},
11    render::{FrameBuilder, FrameValueKey},
12    update::WidgetUpdates,
13    widget::{
14        VarLayout, WIDGET,
15        border::{BORDER, BORDER_ALIGN_VAR, BORDER_OVER_VAR},
16        info::{Interactivity, WIDGET_TREE_CHANGED_EVENT},
17        node::*,
18    },
19    window::WINDOW,
20};
21use zng_app_context::{ContextLocal, LocalContext};
22use zng_layout::{
23    context::LAYOUT,
24    unit::{PxConstraints2d, PxCornerRadius, PxPoint, PxRect, PxSideOffsets, PxSize, PxVector, SideOffsets},
25};
26use zng_state_map::{StateId, StateMapRef, StateValue};
27use zng_var::*;
28
29#[doc(hidden)]
30pub use pastey::paste;
31
32#[doc(hidden)]
33pub mod __macro_util {
34    pub use zng_app::{
35        event::CommandArgs,
36        handler::{Handler, hn},
37        widget::{
38            node::{IntoUiNode, UiNode},
39            property,
40        },
41    };
42    pub use zng_var::{IntoVar, context_var};
43}
44
45/// Helper for declaring properties that sets a context var.
46///
47/// The generated [`UiNode`] delegates each method to `child` inside a call to [`ContextVar::with_context`].
48///
49/// # Examples
50///
51/// A simple context property declaration:
52///
53/// ```
54/// # fn main() -> () { }
55/// # use zng_app::{*, widget::{node::*, *}};
56/// # use zng_var::*;
57/// # use zng_wgt::node::*;
58/// #
59/// context_var! {
60///     pub static FOO_VAR: u32 = 0u32;
61/// }
62///
63/// /// Sets the [`FOO_VAR`] in the widgets and its content.
64/// #[property(CONTEXT, default(FOO_VAR))]
65/// pub fn foo(child: impl IntoUiNode, value: impl IntoVar<u32>) -> UiNode {
66///     with_context_var(child, FOO_VAR, value)
67/// }
68/// ```
69///
70/// When set in a widget, the `value` is accessible in all inner nodes of the widget, using `FOO_VAR.get`, and if `value` is set to a
71/// variable the `FOO_VAR` will also reflect its [`is_new`] and [`read_only`]. If the `value` var is not read-only inner nodes
72/// can modify it using `FOO_VAR.set` or `FOO_VAR.modify`.
73///
74/// Also note that the property [`default`] is set to the same `FOO_VAR`, this causes the property to *pass-through* the outer context
75/// value, as if it was not set.
76///
77/// **Tip:** You can use a [`merge_var!`] to merge a new value to the previous context value:
78///
79/// ```
80/// # fn main() -> () { }
81/// # use zng_app::{*, widget::{node::*, *}};
82/// # use zng_var::*;
83/// # use zng_wgt::node::*;
84/// #
85/// #[derive(Debug, Clone, Default, PartialEq)]
86/// pub struct Config {
87///     pub foo: bool,
88///     pub bar: bool,
89/// }
90///
91/// context_var! {
92///     pub static CONFIG_VAR: Config = Config::default();
93/// }
94///
95/// /// Sets the *foo* config.
96/// #[property(CONTEXT, default(false))]
97/// pub fn foo(child: impl IntoUiNode, value: impl IntoVar<bool>) -> UiNode {
98///     with_context_var(
99///         child,
100///         CONFIG_VAR,
101///         merge_var!(CONFIG_VAR, value.into_var(), |c, &v| {
102///             let mut c = c.clone();
103///             c.foo = v;
104///             c
105///         }),
106///     )
107/// }
108///
109/// /// Sets the *bar* config.
110/// #[property(CONTEXT, default(false))]
111/// pub fn bar(child: impl IntoUiNode, value: impl IntoVar<bool>) -> UiNode {
112///     with_context_var(
113///         child,
114///         CONFIG_VAR,
115///         merge_var!(CONFIG_VAR, value.into_var(), |c, &v| {
116///             let mut c = c.clone();
117///             c.bar = v;
118///             c
119///         }),
120///     )
121/// }
122/// ```
123///
124/// When set in a widget, the [`merge_var!`] will read the context value of the parent properties, modify a clone of the value and
125/// the result will be accessible to the inner properties, the widget user can then set with the composed value in steps and
126/// the final consumer of the composed value only need to monitor to a single context variable.
127///
128/// [`is_new`]: zng_var::AnyVar::is_new
129/// [`read_only`]: zng_var::Var::read_only
130/// [`default`]: zng_app::widget::property#default
131/// [`merge_var!`]: zng_var::merge_var
132/// [`UiNode`]: zng_app::widget::node::UiNode
133/// [`ContextVar::with_context`]: zng_var::ContextVar::with_context
134pub fn with_context_var<T: VarValue>(child: impl IntoUiNode, context_var: ContextVar<T>, value: impl IntoVar<T>) -> UiNode {
135    let value = value.into_var();
136    let mut actual_value = None;
137    let mut id = None;
138
139    match_node(child, move |child, op| {
140        let mut is_deinit = false;
141        match &op {
142            UiNodeOp::Init => {
143                id = Some(ContextInitHandle::new());
144                actual_value = Some(Arc::new(value.current_context().into()));
145            }
146            UiNodeOp::Deinit => {
147                is_deinit = true;
148            }
149            _ => {}
150        }
151
152        context_var.with_context(id.clone().expect("node not inited"), &mut actual_value, || child.op(op));
153
154        if is_deinit {
155            id = None;
156            actual_value = None;
157        }
158    })
159}
160
161/// Helper for declaring properties that sets a context var to a value generated on init.
162///
163/// The method calls the `init_value` closure on init to produce a *value* var that is presented as the [`ContextVar<T>`]
164/// in the widget and widget descendants. The closure can be called more than once if the returned node is reinited.
165///
166/// Apart from the value initialization this behaves just like [`with_context_var`].
167///
168/// [`ContextVar<T>`]: zng_var::ContextVar
169pub fn with_context_var_init<T: VarValue>(
170    child: impl IntoUiNode,
171    var: ContextVar<T>,
172    mut init_value: impl FnMut() -> Var<T> + Send + 'static,
173) -> UiNode {
174    let mut id = None;
175    let mut value = None;
176    match_node(child, move |child, op| {
177        let mut is_deinit = false;
178        match &op {
179            UiNodeOp::Init => {
180                id = Some(ContextInitHandle::new());
181                value = Some(Arc::new(init_value().current_context().into()));
182            }
183            UiNodeOp::Deinit => {
184                is_deinit = true;
185            }
186            _ => {}
187        }
188
189        var.with_context(id.clone().expect("node not inited"), &mut value, || child.op(op));
190
191        if is_deinit {
192            id = None;
193            value = None;
194        }
195    })
196}
197
198/// Helper for declaring event properties.
199pub struct EventNodeBuilder<A: EventArgs, F, M> {
200    event: Event<A>,
201    filter_builder: F,
202    map_args: M,
203}
204/// Helper for declaring event properties from variables.
205pub struct VarEventNodeBuilder<I, F, M> {
206    init_var: I,
207    filter_builder: F,
208    map_args: M,
209}
210
211impl<A: EventArgs> EventNodeBuilder<A, (), ()> {
212    /// Node that calls the handler for all args that target the widget and has not stopped propagation.
213    pub fn new(event: Event<A>) -> EventNodeBuilder<A, (), ()> {
214        EventNodeBuilder {
215            event,
216            filter_builder: (),
217            map_args: (),
218        }
219    }
220}
221impl<I, T> VarEventNodeBuilder<I, (), ()>
222where
223    T: VarValue,
224    I: FnMut() -> Var<T> + Send + 'static,
225{
226    /// Node that calls the handler for var updates.
227    ///
228    /// The `init_var` is called on init to
229    pub fn new(init_var: I) -> VarEventNodeBuilder<I, (), ()> {
230        VarEventNodeBuilder {
231            init_var,
232            filter_builder: (),
233            map_args: (),
234        }
235    }
236}
237
238impl<A: EventArgs, M> EventNodeBuilder<A, (), M> {
239    /// Filter event.
240    ///
241    /// The `filter_builder` is called on init and on event, it must produce another closure, the filter predicate. The `filter_builder`
242    /// runs in the widget context, the filter predicate does not always.
243    ///
244    /// In the event hook the filter predicate runs in the app context, it is called if the args target the widget, the predicate must
245    /// use any captured contextual info to filter the args, this is an optimization, it can save a visit to the widget node.
246    ///
247    /// If the event is received the second filter predicate is called again to confirm the event.
248    /// The second instance is called if [`propagation`] was not stopped, if it returns `true` the `handler` closure is called.
249    ///
250    /// Note that events that represent an *interaction* with the widget are send for both [`ENABLED`] and [`DISABLED`] targets,
251    /// event properties should probably distinguish if they fire on normal interactions vs on *disabled* interactions.
252    ///
253    /// [`propagation`]: zng_app::event::AnyEventArgs::propagation
254    /// [`ENABLED`]: Interactivity::ENABLED
255    /// [`DISABLED`]: Interactivity::DISABLED
256    pub fn filter<FB, F>(self, filter_builder: FB) -> EventNodeBuilder<A, FB, M>
257    where
258        FB: FnMut() -> F + Send + 'static,
259        F: Fn(&A) -> bool + Send + Sync + 'static,
260    {
261        EventNodeBuilder {
262            event: self.event,
263            filter_builder,
264            map_args: self.map_args,
265        }
266    }
267}
268impl<T, I, M> VarEventNodeBuilder<I, (), M>
269where
270    T: VarValue,
271    I: FnMut() -> Var<T> + Send + 'static,
272{
273    /// Filter event.
274    ///
275    /// The `filter_builder` is called on init and on new, it must produce another closure, the filter predicate. The `filter_builder`
276    /// runs in the widget context, the filter predicate does not always.
277    ///
278    /// In the variable hook the filter predicate runs in the app context, it is called if the args target the widget, the predicate must
279    /// use any captured contextual info to filter the args, this is an optimization, it can save a visit to the widget node.
280    ///
281    /// If the update is received the second filter predicate is called again to confirm the update.
282    /// If it returns `true` the `handler` closure is called.
283    pub fn filter<FB, F>(self, filter_builder: FB) -> VarEventNodeBuilder<I, FB, M>
284    where
285        FB: FnMut() -> F + Send + 'static,
286        F: Fn(&T) -> bool + Send + Sync + 'static,
287    {
288        VarEventNodeBuilder {
289            init_var: self.init_var,
290            filter_builder,
291            map_args: self.map_args,
292        }
293    }
294}
295
296impl<A: EventArgs, F> EventNodeBuilder<A, F, ()> {
297    /// Convert args.
298    ///
299    /// The `map_args` closure is called in context, just before the handler is called.
300    pub fn map_args<M, MA>(self, map_args: M) -> EventNodeBuilder<A, F, M>
301    where
302        M: FnMut(&A) -> MA + Send + 'static,
303        MA: Clone + 'static,
304    {
305        EventNodeBuilder {
306            event: self.event,
307            filter_builder: self.filter_builder,
308            map_args,
309        }
310    }
311}
312impl<T, I, F> VarEventNodeBuilder<I, F, ()>
313where
314    T: VarValue,
315    I: FnMut() -> Var<T> + Send + 'static,
316{
317    /// Convert args.
318    ///
319    /// The `map_args` closure is called in context, just before the handler is called.
320    ///
321    /// Note that if the args is a full [`EventArgs`] type it must share the same propagation handle in the preview and normal route
322    /// properties, if the source type is also a full args just clone the propagation handle, otherwise you must use [`WIDGET::set_state`]
323    /// to communicate between the properties.
324    pub fn map_args<M, MA>(self, map_args: M) -> VarEventNodeBuilder<I, F, M>
325    where
326        M: FnMut(&T) -> MA + Send + 'static,
327        MA: Clone + 'static,
328    {
329        VarEventNodeBuilder {
330            init_var: self.init_var,
331            filter_builder: self.filter_builder,
332            map_args,
333        }
334    }
335}
336
337/// Build with filter and args mapping.
338impl<A, F, FB, MA, M> EventNodeBuilder<A, FB, M>
339where
340    A: EventArgs,
341    F: Fn(&A) -> bool + Send + Sync + 'static,
342    FB: FnMut() -> F + Send + 'static,
343    MA: Clone + 'static,
344    M: FnMut(&A) -> MA + Send + 'static,
345{
346    /// Build node.
347    ///
348    /// If `PRE` is `true` the handler is called before the children, *preview* route.
349    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<MA>) -> UiNode {
350        let Self {
351            event,
352            mut filter_builder,
353            mut map_args,
354        } = self;
355        let mut handler = handler.into_wgt_runner();
356        match_node(child, move |child, op| match op {
357            UiNodeOp::Init => {
358                WIDGET.sub_event_when(&event, filter_builder());
359            }
360            UiNodeOp::Deinit => {
361                handler.deinit();
362            }
363            UiNodeOp::Update { updates } => {
364                if !PRE {
365                    child.update(updates);
366                }
367
368                handler.update();
369
370                let mut f = None;
371                event.each_update(false, |args| {
372                    if f.get_or_insert_with(&mut filter_builder)(args) {
373                        handler.event(&map_args(args));
374                    }
375                });
376            }
377            _ => {}
378        })
379    }
380}
381
382/// Build with filter and args mapping.
383impl<T, I, F, FB, MA, M> VarEventNodeBuilder<I, FB, M>
384where
385    T: VarValue,
386    I: FnMut() -> Var<T> + Send + 'static,
387    F: Fn(&T) -> bool + Send + Sync + 'static,
388    FB: FnMut() -> F + Send + 'static,
389    MA: Clone + 'static,
390    M: FnMut(&T) -> MA + Send + 'static,
391{
392    /// Build node.
393    ///
394    /// If `PRE` is `true` the handler is called before the children, *preview* route.
395    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<MA>) -> UiNode {
396        let Self {
397            mut init_var,
398            mut filter_builder,
399            mut map_args,
400        } = self;
401        let mut handler = handler.into_wgt_runner();
402        let mut var = None;
403        match_node(child, move |child, op| match op {
404            UiNodeOp::Init => {
405                let v = init_var();
406                let f = filter_builder();
407                WIDGET.sub_var_when(&v, move |a| f(a.value()));
408                var = Some(v);
409            }
410            UiNodeOp::Deinit => {
411                handler.deinit();
412                var = None;
413            }
414            UiNodeOp::Update { updates } => {
415                if PRE {
416                    child.update(updates);
417                }
418
419                handler.update();
420
421                var.as_ref().unwrap().with_new(|t| {
422                    if filter_builder()(t) {
423                        handler.event(&map_args(t));
424                    }
425                });
426            }
427            _ => {}
428        })
429    }
430}
431
432/// Build with filter and without args mapping.
433impl<A, F, FB> EventNodeBuilder<A, FB, ()>
434where
435    A: EventArgs,
436    F: Fn(&A) -> bool + Send + Sync + 'static,
437    FB: FnMut() -> F + Send + 'static,
438{
439    /// Build node.
440    ///
441    /// If `PRE` is `true` the handler is called before the children, *preview* route.
442    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<A>) -> UiNode {
443        let Self {
444            event, mut filter_builder, ..
445        } = self;
446        let mut handler = handler.into_wgt_runner();
447        match_node(child, move |child, op| match op {
448            UiNodeOp::Init => {
449                WIDGET.sub_event_when(&event, filter_builder());
450            }
451            UiNodeOp::Deinit => {
452                handler.deinit();
453            }
454            UiNodeOp::Update { updates } => {
455                if !PRE {
456                    child.update(updates);
457                }
458
459                handler.update();
460
461                let mut f = None;
462                event.each_update(false, |args| {
463                    if f.get_or_insert_with(&mut filter_builder)(args) {
464                        handler.event(args);
465                    }
466                });
467            }
468            _ => {}
469        })
470    }
471}
472/// Build with filter and without args mapping.
473impl<T, I, F, FB> VarEventNodeBuilder<I, FB, ()>
474where
475    T: VarValue,
476    I: FnMut() -> Var<T> + Send + 'static,
477    F: Fn(&T) -> bool + Send + Sync + 'static,
478    FB: FnMut() -> F + Send + 'static,
479{
480    /// Build node.
481    ///
482    /// If `PRE` is `true` the handler is called before the children, *preview* route.
483    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<T>) -> UiNode {
484        let Self {
485            mut init_var,
486            mut filter_builder,
487            ..
488        } = self;
489        let mut handler = handler.into_wgt_runner();
490        let mut var = None;
491        match_node(child, move |child, op| match op {
492            UiNodeOp::Init => {
493                let v = init_var();
494                let f = filter_builder();
495                WIDGET.sub_var_when(&v, move |a| f(a.value()));
496                var = Some(v);
497            }
498            UiNodeOp::Deinit => {
499                handler.deinit();
500                var = None;
501            }
502            UiNodeOp::Update { updates } => {
503                if !PRE {
504                    child.update(updates);
505                }
506
507                handler.update();
508
509                var.as_ref().unwrap().with_new(|t| {
510                    if filter_builder()(t) {
511                        handler.event(t);
512                    }
513                });
514            }
515            _ => {}
516        })
517    }
518}
519
520/// Build without filter and without args mapping.
521impl<A> EventNodeBuilder<A, (), ()>
522where
523    A: EventArgs,
524{
525    /// Build node.
526    ///
527    /// If `PRE` is `true` the handler is called before the children, *preview* route.
528    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<A>) -> UiNode {
529        let Self { event, .. } = self;
530        let mut handler = handler.into_wgt_runner();
531        match_node(child, move |child, op| match op {
532            UiNodeOp::Init => {
533                WIDGET.sub_event(&event);
534            }
535            UiNodeOp::Deinit => {
536                handler.deinit();
537            }
538            UiNodeOp::Update { updates } => {
539                if !PRE {
540                    child.update(updates);
541                }
542
543                handler.update();
544
545                event.each_update(false, |args| {
546                    handler.event(args);
547                });
548            }
549            _ => {}
550        })
551    }
552}
553/// Build without filter and without args mapping.
554impl<T, I> VarEventNodeBuilder<I, (), ()>
555where
556    T: VarValue,
557    I: FnMut() -> Var<T> + Send + 'static,
558{
559    /// Build node.
560    ///
561    /// If `PRE` is `true` the handler is called before the children, *preview* route.
562    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<T>) -> UiNode {
563        let Self { mut init_var, .. } = self;
564        let mut handler = handler.into_wgt_runner();
565        let mut var = None;
566        match_node(child, move |child, op| match op {
567            UiNodeOp::Init => {
568                let v = init_var();
569                WIDGET.sub_var(&v);
570                var = Some(v);
571            }
572            UiNodeOp::Deinit => {
573                handler.deinit();
574                var = None;
575            }
576            UiNodeOp::Update { updates } => {
577                if !PRE {
578                    child.update(updates);
579                }
580
581                handler.update();
582
583                var.as_ref().unwrap().with_new(|t| {
584                    handler.event(t);
585                });
586            }
587            _ => {}
588        })
589    }
590}
591
592/// Build with no filter and args mapping.
593impl<A, MA, M> EventNodeBuilder<A, (), M>
594where
595    A: EventArgs,
596    MA: Clone + 'static,
597    M: FnMut(&A) -> MA + Send + 'static,
598{
599    /// Build node.
600    ///
601    /// If `PRE` is `true` the handler is called before the children, *preview* route.
602    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<MA>) -> UiNode {
603        self.filter(|| |_| true).build::<PRE>(child, handler)
604    }
605}
606/// Build with no filter and args mapping.
607impl<T, I, MA, M> VarEventNodeBuilder<I, (), M>
608where
609    T: VarValue,
610    I: FnMut() -> Var<T> + Send + 'static,
611    MA: Clone + 'static,
612    M: FnMut(&T) -> MA + Send + 'static,
613{
614    /// Build node.
615    ///
616    /// If `PRE` is `true` the handler is called before the children, *preview* route.
617    pub fn build<const PRE: bool>(self, child: impl IntoUiNode, handler: Handler<MA>) -> UiNode {
618        self.filter(|| |_| true).build::<PRE>(child, handler)
619    }
620}
621
622///<span data-del-macro-root></span> Declare event properties.
623///
624/// Each declaration can expand to an `on_event` and optionally an `on_pre_event`. The body can be declared using [`EventNodeBuilder`] or
625/// [`VarEventNodeBuilder`].
626///
627/// # Examples
628///
629/// ```
630/// # fn main() { }
631/// # use zng_app::{event::*, widget::{node::*, *}, handler::*};
632/// # use zng_wgt::node::*;
633/// # #[derive(Clone, Debug, PartialEq)] pub enum KeyState { Pressed }
634/// # event_args! { pub struct KeyInputArgs { pub state: KeyState, .. fn is_in_target(&self, _id: WidgetId) -> bool { true } } }
635/// # event! { pub static KEY_INPUT_EVENT: KeyInputArgs; }
636/// # struct CONTEXT;
637/// # impl CONTEXT { pub fn state(&self) -> zng_var::Var<bool> { zng_var::var(true) } }
638/// event_property! {
639///     /// Docs copied for `on_key_input` and `on_pre_key_input`.
640///     ///
641///     /// The macro also generates docs linking between the two properties.
642///     #[property(EVENT)]
643///     pub fn on_key_input<on_pre_key_input>(child: impl IntoUiNode, handler: Handler<KeyInputArgs>) -> UiNode {
644///         // Preview flag, only if the signature contains the `<on_pre...>` part,
645///         // the macro matches `const $IDENT: bool;` and expands to `const IDENT: bool = true/false;`.
646///         const PRE: bool;
647///
648///         // rest of the body can be anything the builds a node.
649///         EventNodeBuilder::new(KEY_INPUT_EVENT).build::<PRE>(child, handler)
650///     }
651///
652///     /// Another property.
653///     #[property(EVENT)]
654///     pub fn on_key_down<on_pre_key_down>(child: impl IntoUiNode, handler: Handler<KeyInputArgs>) -> UiNode {
655///         const PRE: bool;
656///         EventNodeBuilder::new(KEY_INPUT_EVENT)
657///             .filter(|| |a| a.state == KeyState::Pressed)
658///             .build::<PRE>(child, handler)
659///     }
660///
661///     /// Another, this time derived from a var source, and without the optional preview property.
662///     #[property(EVENT)]
663///     pub fn on_state(child: impl IntoUiNode, handler: Handler<bool>) -> UiNode {
664///         VarEventNodeBuilder::new(|| CONTEXT.state())
665///             .map_args(|b| !*b)
666///             .build::<false>(child, handler)
667///     }
668/// }
669/// ```
670///
671/// The example above generates five event properties.
672///
673/// # Route
674///
675/// Note that is an event property has an `on_pre_*` pair it is expected to be representing a fully routing event, with args that
676/// implement [`EventArgs`]. If the property does not have a preview pair it is expected to be a *direct* event. This is the event
677/// property pattern and is explained in the generated documentation, don't declare a non-standard pair using this macro.
678///
679/// # Commands
680///
681/// You can use [`command_property`] to declare command event properties, it also generates enabled control properties.
682#[macro_export]
683macro_rules! event_property {
684    ($(
685        $(#[$meta:meta])+
686        $vis:vis fn $on_ident:ident $(< $on_pre_ident:ident $(,)?>)? (
687            $child:ident: impl $IntoUiNode:path,
688            $handler:ident: $Handler:ty $(,)?
689        ) -> $UiNode:path {
690            $($body:tt)+
691        }
692    )+) => {$(
693       $crate::event_property_impl! {
694            $(#[$meta])+
695            $vis fn $on_ident $(< $on_pre_ident >)? ($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
696                $($body)+
697            }
698       }
699    )+};
700}
701#[doc(inline)]
702pub use event_property;
703
704#[doc(hidden)]
705#[macro_export]
706macro_rules! event_property_impl {
707    (
708        $(#[$meta:meta])+
709        $vis:vis fn $on_ident:ident < $on_pre_ident:ident > ($child:ident : impl $IntoUiNode:path, $handler:ident : $Handler:ty) -> $UiNode:path {
710            const $PRE:ident : bool;
711            $($body:tt)+
712        }
713    ) => {
714        $(#[$meta])+
715        ///
716        /// # Route
717        ///
718        /// This event property uses the normal route, that is, the `handler` is called after the children widget handlers and after the
719        #[doc = concat!("[`", stringify!($pn_pre_ident), "`](fn@", stringify!($pn_pre_ident), ")")]
720        /// handlers.
721        $vis fn $on_ident($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
722            const $PRE: bool = false;
723            $($body)+
724        }
725
726        $(#[$meta])+
727        ///
728        /// # Route
729        ///
730        /// This event property uses the preview route, that is, the `handler` is called before the children widget handlers and before the
731        #[doc = concat!("[`", stringify!($pn_ident), "`](fn@", stringify!($pn_ident), ")")]
732        /// handlers.
733        $vis fn $on_pre_ident($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
734            const $PRE: bool = true;
735            $($body)+
736        }
737    };
738
739    (
740        $(#[$meta:meta])+
741        $vis:vis fn $on_ident:ident ($child:ident : impl $IntoUiNode:path, $handler:ident : $Handler:path) -> $UiNode:path {
742            $($body:tt)+
743        }
744    ) => {
745        $(#[$meta])+
746        ///
747        /// # Route
748        ///
749        /// This event property uses a *direct* route, that is, it cannot be intercepted in parent widgets.
750        $vis fn $on_ident($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
751            $($body)+
752        }
753    };
754}
755
756///<span data-del-macro-root></span> Declare command event properties.
757///
758/// Each declaration can expand to an `on_cmd`, `on_pre_cmd` and  and optionally an `can_cmd` and `CAN_CMD_VAR`.
759///
760/// # Examples
761///
762/// ```
763/// # fn main() { }
764/// # use zng_app::{event::*, widget::{*, node::*}, handler::*};
765/// # use zng_app::var::*;
766/// # use zng_wgt::node::*;
767/// # command! {
768/// # pub static COPY_CMD;
769/// # pub static PASTE_CMD;
770/// # }
771/// command_property! {
772///     /// Property docs.
773///     #[property(EVENT)]
774///     pub fn on_paste<on_pre_paste>(child: impl IntoUiNode, handler: Handler<CommandArgs>) -> UiNode {
775///         PASTE_CMD
776///     }
777///
778///     /// Another property, with optional `can_*` contextual property.
779///     #[property(EVENT)]
780///     pub fn on_copy<on_pre_copy, can_copy>(child: impl IntoUiNode, handler: Handler<CommandArgs>) -> UiNode {
781///         COPY_CMD
782///     }
783/// }
784/// ```
785///
786/// The example above declares five properties and a context var. Note that unlike [`event_property!`] the body only defines the command,
787/// a standard node is generated.
788///
789/// # Enabled
790///
791/// An optional contextual property (`can_*`) and context var (`CAN_*_VAR`) can be generated. When defined the command handle enabled status
792/// is controlled by the contextual property. When not defined the command handle is always enabled.
793#[macro_export]
794macro_rules! command_property {
795    ($(
796        $(#[$meta:meta])+
797        $vis:vis fn $on_ident:ident $(< $on_pre_ident:ident $(, $can_ident:ident)? $(,)?>)? (
798            $child:ident: impl $IntoUiNode:path,
799            $handler:ident: $Handler:ty $(,)?
800        ) -> $UiNode:path {
801            $COMMAND:path
802        }
803    )+) => {$(
804       $crate::command_property_impl! {
805            $(#[$meta])+
806            $vis fn $on_ident$(<$on_pre_ident $(, $can_ident)?>)?($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
807                $COMMAND
808            }
809       }
810    )+};
811}
812#[doc(inline)]
813pub use command_property;
814#[doc(hidden)]
815#[macro_export]
816macro_rules! command_property_impl {
817    (
818        $(#[$meta:meta])+
819        $vis:vis fn $on_ident:ident < $on_pre_ident:ident, $can_ident:ident> (
820            $child:ident: impl $IntoUiNode:path,
821            $handler:ident: $Handler:ty
822        ) -> $UiNode:path {
823            $COMMAND:path
824        }
825    ) => {
826        $crate::node::paste! {
827            $crate::node::__macro_util::context_var! {
828                /// Defines if
829                #[doc = concat!("[`", stringify!($on_ident), "`](fn@", stringify!($on_ident), ")")]
830                /// and
831                #[doc = concat!("[`", stringify!($on_pre_ident), "`](fn@", stringify!($on_pre_ident), ")")]
832                /// command handlers are enabled in a widget and descendants.
833                ///
834                /// Use
835                #[doc = concat!("[`", stringify!($can_ident), "`](fn@", stringify!($can_ident), ")")]
836                /// to set. Is enabled by default.
837                $vis static [<$can_ident:upper _VAR>]: bool = true;
838            }
839
840            /// Defines if
841            #[doc = concat!("[`", stringify!($on_ident), "`](fn@", stringify!($on_ident), ")")]
842            /// and
843            #[doc = concat!("[`", stringify!($on_pre_ident), "`](fn@", stringify!($on_pre_ident), ")")]
844            /// command handlers are enabled in the widget and descendants.
845            ///
846            #[doc = "Sets the [`"$can_ident:upper "_VAR`]."]
847            #[$crate::node::__macro_util::property(CONTEXT, default([<$can_ident:upper _VAR>]))]
848            $vis fn $can_ident(
849                child: impl $crate::node::__macro_util::IntoUiNode,
850                enabled: impl $crate::node::__macro_util::IntoVar<bool>,
851            ) -> $crate::node::__macro_util::UiNode {
852                $crate::node::with_context_var(child, self::[<$can_ident:upper _VAR>], enabled)
853            }
854
855            $crate::event_property! {
856                $(#[$meta])+
857                ///
858                /// # Command
859                ///
860                /// This property will subscribe to the
861                #[doc = concat!("[`", stringify!($COMMAND), "`]")]
862                /// command scoped on the widget. If set on the `Window!` root widget it will also subscribe to
863                /// the command scoped on the window.
864                ///
865                /// The command handle is enabled by default and can be disabled using the contextual property
866                #[doc = concat!("[`", stringify!($can_ident), "`](fn@", stringify!($can_ident), ")")]
867                /// .
868                $vis fn $on_ident<$on_pre_ident>($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
869                    const PRE: bool;
870                    let child = $crate::node::EventNodeBuilder::new(*$COMMAND)
871                        .filter(|| {
872                            let enabled = self::[<$can_ident:upper _VAR>].current_context();
873                            move |_| enabled.get()
874                        })
875                        .build::<PRE>($child, $handler);
876                    $crate::node::command_contextual_enabled(child, $COMMAND, [<$can_ident:upper _VAR>])
877                }
878            }
879        }
880    };
881    (
882        $(#[$meta:meta])+
883        $vis:vis fn $on_ident:ident< $on_pre_ident:ident> (
884            $child:ident: impl $IntoUiNode:path,
885            $handler:ident: $Handler:ty
886        ) -> $UiNode:path {
887            $COMMAND:path
888        }
889    ) => {
890        $crate::event_property! {
891            $(#[$meta])+
892            ///
893            /// # Command
894            ///
895            /// This property will subscribe to the
896            #[doc = concat!("[`", stringify!($COMMAND), "`]")]
897            /// command scoped on the widget. If set on the `Window!` root widget it will also subscribe to
898            /// the command scoped on the window.
899            ///
900            /// The command handle is always enabled.
901            $vis fn $on_ident<$on_pre_ident>($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
902                const PRE: bool;
903                let child = $crate::node::EventNodeBuilder::new(*$COMMAND).build::<PRE>($child, $handler);
904                $crate::node::command_always_enabled(child, $COMMAND)
905            }
906        }
907    };
908    (
909        $(#[$meta:meta])+
910        $vis:vis fn $on_ident:ident (
911            $child:ident: impl $IntoUiNode:path,
912            $handler:ident: $Handler:ty
913        ) -> $UiNode:path {
914            $COMMAND:path
915        }
916    ) => {
917        $crate::event_property! {
918            $(#[$meta])+
919            ///
920            /// # Command
921            ///
922            /// This property will subscribe to the
923            #[doc = concat!("[`", stringify!($COMMAND), "`]")]
924            /// command scoped on the widget. If set on the `Window!` root widget it will also subscribe to
925            /// the command scoped on the window.
926            ///
927            /// The command handle is always enabled.
928            $vis fn $on_ident($child: impl $IntoUiNode, $handler: $Handler) -> $UiNode {
929                let child = $crate::node::EventNodeBuilder::new(*$COMMAND).build::<false>($child, $handler);
930                $crate::node::command_always_enabled(child, $COMMAND)
931            }
932        }
933    };
934}
935
936fn validate_cmd(cmd: Command) {
937    if !matches!(cmd.scope(), CommandScope::App) {
938        tracing::error!("command for command property cannot be scoped, {cmd:?} scope will be ignored");
939    }
940}
941
942#[doc(hidden)]
943pub fn command_always_enabled(child: UiNode, cmd: Command) -> UiNode {
944    let mut _wgt_handle = CommandHandle::dummy();
945    let mut _win_handle = CommandHandle::dummy();
946    match_node(child, move |_, op| match op {
947        UiNodeOp::Init => {
948            validate_cmd(cmd);
949            _wgt_handle = cmd.scoped(WIDGET.id()).subscribe(true);
950            if WIDGET.parent_id().is_none() {
951                _win_handle = cmd.scoped(WINDOW.id()).subscribe(true);
952            }
953        }
954        UiNodeOp::Deinit => {
955            _wgt_handle = CommandHandle::dummy();
956            _win_handle = CommandHandle::dummy();
957        }
958        _ => {}
959    })
960}
961
962#[doc(hidden)]
963pub fn command_contextual_enabled(child: UiNode, cmd: Command, ctx: ContextVar<bool>) -> UiNode {
964    let mut _handle = VarHandle::dummy();
965    let mut _wgt_handle = CommandHandle::dummy();
966    let mut _win_handle = CommandHandle::dummy();
967    match_node(child, move |_, op| match op {
968        UiNodeOp::Init => {
969            let ctx = ctx.current_context();
970            let handle = cmd.scoped(WIDGET.id()).subscribe(ctx.get());
971            let win_handle = if WIDGET.parent_id().is_none() {
972                cmd.scoped(WINDOW.id()).subscribe(ctx.get())
973            } else {
974                CommandHandle::dummy()
975            };
976            if !ctx.capabilities().is_const() {
977                let handle = handle.enabled().clone();
978                let win_handle = win_handle.enabled().clone();
979                _handle = ctx.hook(move |a| {
980                    handle.set(*a.value());
981                    win_handle.set(*a.value());
982                    true
983                });
984            }
985            _wgt_handle = handle;
986            _win_handle = win_handle;
987        }
988        UiNodeOp::Deinit => {
989            _handle = VarHandle::dummy();
990            _wgt_handle = CommandHandle::dummy();
991            _win_handle = CommandHandle::dummy();
992        }
993        _ => {}
994    })
995}
996
997/// Logs an error if the `_var` is always read-only.
998pub fn validate_getter_var<T: VarValue>(_var: &Var<T>) {
999    #[cfg(debug_assertions)]
1000    if _var.capabilities().is_always_read_only() {
1001        tracing::error!(
1002            "`is_`, `has_` or `get_` property inited with read-only var in `{}`",
1003            WIDGET.trace_id()
1004        );
1005    }
1006}
1007
1008/// Helper for declaring state properties that are controlled by a variable.
1009///
1010/// On init the `state` variable is set to `source` and bound to it, you can use this to create state properties
1011/// that map from a context variable or to create composite properties that merge other state properties.
1012pub fn bind_state<T: VarValue>(child: impl IntoUiNode, source: impl IntoVar<T>, state: impl IntoVar<T>) -> UiNode {
1013    let source = source.into_var();
1014    bind_state_init(child, state, move |state| {
1015        state.set_from(&source);
1016        source.bind(state)
1017    })
1018}
1019
1020/// Helper for declaring state properties that are controlled by a variable that can only be retrieved on init.
1021///
1022/// On init the `bind` closure is called with the `state` variable, it must set and bind it.
1023pub fn bind_state_init<T>(
1024    child: impl IntoUiNode,
1025    state: impl IntoVar<T>,
1026    mut bind: impl FnMut(&Var<T>) -> VarHandle + Send + 'static,
1027) -> UiNode
1028where
1029    T: VarValue,
1030{
1031    let state = state.into_var();
1032    let mut _binding = VarHandle::dummy();
1033
1034    match_node(child, move |_, op| match op {
1035        UiNodeOp::Init => {
1036            validate_getter_var(&state);
1037            _binding = bind(&state);
1038        }
1039        UiNodeOp::Deinit => {
1040            _binding = VarHandle::dummy();
1041        }
1042        _ => {}
1043    })
1044}
1045
1046/// Helper for declaring state properties that are controlled by a variable that can only be derived from the widget info.
1047///
1048/// On info init (first update after the window info tree builds) the `bind` closure is called with the `state` variable, it must set and bind it.
1049pub fn bind_state_info<T>(
1050    child: impl IntoUiNode,
1051    state: impl IntoVar<T>,
1052    mut bind: impl FnMut(&Var<T>) -> VarHandle + Send + 'static,
1053) -> UiNode
1054where
1055    T: VarValue,
1056{
1057    let state = state.into_var();
1058    let mut _binding = VarHandle::dummy();
1059
1060    match_node(child, move |_, op| match op {
1061        UiNodeOp::Init => {
1062            let id = WINDOW.id();
1063            WIDGET.sub_event_when(&WIDGET_TREE_CHANGED_EVENT, move |a| !a.is_update && a.tree.window_id() == id);
1064        }
1065        UiNodeOp::Update { .. } => {
1066            WIDGET_TREE_CHANGED_EVENT.each_update(true, |a| {
1067                if !a.is_update && a.tree.window_id() == WINDOW.id() {
1068                    _binding = bind(&state);
1069                }
1070            });
1071        }
1072        UiNodeOp::Deinit => {
1073            _binding = VarHandle::dummy();
1074        }
1075        _ => {}
1076    })
1077}
1078
1079/// Helper for declaring state properties that are controlled by values in the widget state map.
1080///
1081/// The `predicate` closure is called with the widget state on init and every update, if the returned value changes the `state`
1082/// updates. The `deinit` closure is called on deinit to get the *reset* value.
1083pub fn widget_state_is_state(
1084    child: impl IntoUiNode,
1085    predicate: impl Fn(StateMapRef<WIDGET>) -> bool + Send + 'static,
1086    deinit: impl Fn(StateMapRef<WIDGET>) -> bool + Send + 'static,
1087    state: impl IntoVar<bool>,
1088) -> UiNode {
1089    let state = state.into_var();
1090
1091    match_node(child, move |child, op| match op {
1092        UiNodeOp::Init => {
1093            validate_getter_var(&state);
1094            child.init();
1095            let s = WIDGET.with_state(&predicate);
1096            if s != state.get() {
1097                state.set(s);
1098            }
1099        }
1100        UiNodeOp::Deinit => {
1101            child.deinit();
1102            let s = WIDGET.with_state(&deinit);
1103            if s != state.get() {
1104                state.set(s);
1105            }
1106        }
1107        UiNodeOp::Update { updates } => {
1108            child.update(updates);
1109            let s = WIDGET.with_state(&predicate);
1110            if s != state.get() {
1111                state.set(s);
1112            }
1113        }
1114        _ => {}
1115    })
1116}
1117
1118/// Helper for declaring state getter properties that are controlled by values in the widget state map.
1119///
1120/// The `get_new` closure is called with the widget state and current `state` every init and update, if it returns some value
1121/// the `state` updates. The `get_deinit` closure is called on deinit to get the *reset* value.
1122pub fn widget_state_get_state<T: VarValue>(
1123    child: impl IntoUiNode,
1124    get_new: impl Fn(StateMapRef<WIDGET>, &T) -> Option<T> + Send + 'static,
1125    get_deinit: impl Fn(StateMapRef<WIDGET>, &T) -> Option<T> + Send + 'static,
1126    state: impl IntoVar<T>,
1127) -> UiNode {
1128    let state = state.into_var();
1129    match_node(child, move |child, op| match op {
1130        UiNodeOp::Init => {
1131            validate_getter_var(&state);
1132            child.init();
1133            let new = state.with(|s| WIDGET.with_state(|w| get_new(w, s)));
1134            if let Some(new) = new {
1135                state.set(new);
1136            }
1137        }
1138        UiNodeOp::Deinit => {
1139            child.deinit();
1140
1141            let new = state.with(|s| WIDGET.with_state(|w| get_deinit(w, s)));
1142            if let Some(new) = new {
1143                state.set(new);
1144            }
1145        }
1146        UiNodeOp::Update { updates } => {
1147            child.update(updates);
1148            let new = state.with(|s| WIDGET.with_state(|w| get_new(w, s)));
1149            if let Some(new) = new {
1150                state.set(new);
1151            }
1152        }
1153        _ => {}
1154    })
1155}
1156
1157/// Transforms and clips the `content` node according with the default widget border align behavior.
1158///
1159/// Properties that *fill* the widget can wrap their fill content in this node to automatically implement
1160/// the expected interaction with the widget borders, the content will be positioned, sized and clipped according to the
1161/// widget borders, corner radius and border align.
1162pub fn fill_node(content: impl IntoUiNode) -> UiNode {
1163    let mut clip_bounds = PxSize::zero();
1164    let mut clip_corners = PxCornerRadius::zero();
1165
1166    let mut offset = PxVector::zero();
1167    let offset_key = FrameValueKey::new_unique();
1168    let mut define_frame = false;
1169
1170    match_node(content, move |child, op| match op {
1171        UiNodeOp::Init => {
1172            WIDGET.sub_var_layout(&BORDER_ALIGN_VAR);
1173            define_frame = false;
1174            offset = PxVector::zero();
1175        }
1176        UiNodeOp::Measure { desired_size, .. } => {
1177            let offsets = BORDER.inner_offsets();
1178            let align = BORDER_ALIGN_VAR.get();
1179
1180            let our_offsets = offsets * align;
1181            let size_offset = offsets - our_offsets;
1182
1183            let size_increase = PxSize::new(size_offset.horizontal(), size_offset.vertical());
1184
1185            *desired_size = LAYOUT.constraints().fill_size() + size_increase;
1186        }
1187        UiNodeOp::Layout { wl, final_size } => {
1188            // We are inside the *inner* bounds AND inside border_nodes:
1189            //
1190            // .. ( layout ( new_border/inner ( border_nodes ( FILL_NODES ( new_child_context ( new_child_layout ( ..
1191
1192            let (bounds, corners) = BORDER.fill_bounds();
1193
1194            let mut new_offset = bounds.origin.to_vector();
1195
1196            if clip_bounds != bounds.size || clip_corners != corners {
1197                clip_bounds = bounds.size;
1198                clip_corners = corners;
1199                WIDGET.render();
1200            }
1201
1202            let (_, branch_offset) = LAYOUT.with_constraints(PxConstraints2d::new_exact_size(bounds.size), || {
1203                wl.with_branch_child(|wl| child.layout(wl))
1204            });
1205            new_offset += branch_offset;
1206
1207            if offset != new_offset {
1208                offset = new_offset;
1209
1210                if define_frame {
1211                    WIDGET.render_update();
1212                } else {
1213                    define_frame = true;
1214                    WIDGET.render();
1215                }
1216            }
1217
1218            *final_size = bounds.size;
1219        }
1220        UiNodeOp::Render { frame } => {
1221            let mut render = |frame: &mut FrameBuilder| {
1222                let bounds = PxRect::from_size(clip_bounds);
1223                frame.push_clips(
1224                    |c| {
1225                        if clip_corners != PxCornerRadius::zero() {
1226                            c.push_clip_rounded_rect(bounds, clip_corners, false, false);
1227                        } else {
1228                            c.push_clip_rect(bounds, false, false);
1229                        }
1230
1231                        if let Some(inline) = WIDGET.bounds().inline() {
1232                            for r in inline.negative_space().iter() {
1233                                c.push_clip_rect(*r, true, false);
1234                            }
1235                        }
1236                    },
1237                    |f| child.render(f),
1238                );
1239            };
1240
1241            if define_frame {
1242                frame.push_reference_frame(offset_key.into(), offset_key.bind(offset.into(), false), true, false, |frame| {
1243                    render(frame);
1244                });
1245            } else {
1246                render(frame);
1247            }
1248        }
1249        UiNodeOp::RenderUpdate { update } => {
1250            if define_frame {
1251                update.with_transform(offset_key.update(offset.into(), false), false, |update| {
1252                    child.render_update(update);
1253                });
1254            } else {
1255                child.render_update(update);
1256            }
1257        }
1258        _ => {}
1259    })
1260}
1261
1262/// Creates a border node that delegates rendering to a `border_visual` and manages the `border_offsets` coordinating
1263/// with the other borders of the widget.
1264///
1265/// This node disables inline layout for the widget.
1266pub fn border_node(child: impl IntoUiNode, border_offsets: impl IntoVar<SideOffsets>, border_visual: impl IntoUiNode) -> UiNode {
1267    let offsets = border_offsets.into_var();
1268    let mut render_offsets = PxSideOffsets::zero();
1269    let mut border_rect = PxRect::zero();
1270
1271    match_node(ui_vec![child, border_visual], move |children, op| match op {
1272        UiNodeOp::Init => {
1273            WIDGET.sub_var_layout(&offsets).sub_var_render(&BORDER_OVER_VAR);
1274        }
1275        UiNodeOp::Measure { wm, desired_size } => {
1276            let offsets = offsets.layout();
1277            *desired_size = BORDER.measure_border(offsets, || {
1278                LAYOUT.with_sub_size(PxSize::new(offsets.horizontal(), offsets.vertical()), || {
1279                    children.node().with_child(0, |n| wm.measure_block(n))
1280                })
1281            });
1282            children.delegated();
1283        }
1284        UiNodeOp::Layout { wl, final_size } => {
1285            // We are inside the *inner* bounds or inside a parent border_node:
1286            //
1287            // .. ( layout ( new_border/inner ( BORDER_NODES ( fill_nodes ( new_child_context ( new_child_layout ( ..
1288            //
1289            // `wl` is targeting the child transform, child nodes are naturally inside borders, so we
1290            // need to add to the offset and take the size, fill_nodes optionally cancel this transform.
1291
1292            let offsets = offsets.layout();
1293            if render_offsets != offsets {
1294                render_offsets = offsets;
1295                WIDGET.render();
1296            }
1297
1298            let parent_offsets = BORDER.inner_offsets();
1299            let origin = PxPoint::new(parent_offsets.left, parent_offsets.top);
1300            if border_rect.origin != origin {
1301                border_rect.origin = origin;
1302                WIDGET.render();
1303            }
1304
1305            // layout child and border visual
1306            BORDER.layout_border(offsets, || {
1307                wl.translate(PxVector::new(offsets.left, offsets.top));
1308
1309                let taken_size = PxSize::new(offsets.horizontal(), offsets.vertical());
1310                border_rect.size = LAYOUT.with_sub_size(taken_size, || children.node().with_child(0, |n| n.layout(wl)));
1311
1312                // layout border visual
1313                LAYOUT.with_constraints(PxConstraints2d::new_exact_size(border_rect.size), || {
1314                    BORDER.with_border_layout(border_rect, offsets, || {
1315                        children.node().with_child(1, |n| n.layout(wl));
1316                    });
1317                });
1318            });
1319            children.delegated();
1320
1321            *final_size = border_rect.size;
1322        }
1323        UiNodeOp::Render { frame } => {
1324            if BORDER_OVER_VAR.get() {
1325                children.node().with_child(0, |c| c.render(frame));
1326                BORDER.with_border_layout(border_rect, render_offsets, || {
1327                    children.node().with_child(1, |c| c.render(frame));
1328                });
1329            } else {
1330                BORDER.with_border_layout(border_rect, render_offsets, || {
1331                    children.node().with_child(1, |c| c.render(frame));
1332                });
1333                children.node().with_child(0, |c| c.render(frame));
1334            }
1335            children.delegated();
1336        }
1337        UiNodeOp::RenderUpdate { update } => {
1338            children.node().with_child(0, |c| c.render_update(update));
1339            BORDER.with_border_layout(border_rect, render_offsets, || {
1340                children.node().with_child(1, |c| c.render_update(update));
1341            });
1342            children.delegated();
1343        }
1344        _ => {}
1345    })
1346}
1347
1348/// Helper for declaring nodes that sets a context local value.
1349///
1350/// See [`context_local!`] for more details about contextual values.
1351///
1352/// [`context_local!`]: crate::prelude::context_local
1353pub fn with_context_local<T: Any + Send + Sync + 'static>(
1354    child: impl IntoUiNode,
1355    context: &'static ContextLocal<T>,
1356    value: impl Into<T>,
1357) -> UiNode {
1358    let mut value = Some(Arc::new(value.into()));
1359
1360    match_node(child, move |child, op| {
1361        context.with_context(&mut value, || child.op(op));
1362    })
1363}
1364
1365/// Helper for declaring nodes that sets a context local value generated on init.
1366///
1367/// The method calls the `init_value` closure on init to produce a *value* var that is presented as the [`ContextLocal<T>`]
1368/// in the widget and widget descendants. The closure can be called more than once if the returned node is reinited.
1369///
1370/// Apart from the value initialization this behaves just like [`with_context_local`].
1371///
1372/// [`ContextLocal<T>`]: zng_app_context::ContextLocal
1373pub fn with_context_local_init<T: Any + Send + Sync + 'static>(
1374    child: impl IntoUiNode,
1375    context: &'static ContextLocal<T>,
1376    init_value: impl FnMut() -> T + Send + 'static,
1377) -> UiNode {
1378    with_context_local_init_impl(child.into_node(), context, init_value)
1379}
1380fn with_context_local_init_impl<T: Any + Send + Sync + 'static>(
1381    child: UiNode,
1382    context: &'static ContextLocal<T>,
1383    mut init_value: impl FnMut() -> T + Send + 'static,
1384) -> UiNode {
1385    let mut value = None;
1386
1387    match_node(child, move |child, op| {
1388        let mut is_deinit = false;
1389        match &op {
1390            UiNodeOp::Init => {
1391                value = Some(Arc::new(init_value()));
1392            }
1393            UiNodeOp::Deinit => {
1394                is_deinit = true;
1395            }
1396            _ => {}
1397        }
1398
1399        context.with_context(&mut value, || child.op(op));
1400
1401        if is_deinit {
1402            value = None;
1403        }
1404    })
1405}
1406
1407/// Helper for declaring widgets that are recontextualized to take in some of the context
1408/// of an *original* parent.
1409///
1410/// See [`LocalContext::with_context_blend`] for more details about `over`. The returned
1411/// node will delegate all node operations to inside the blend. The [`WidgetUiNode::with_context`]
1412/// will delegate to the `child` widget context, but the `ctx` is not blended for this method, only
1413/// for [`UiNodeOp`] methods.
1414///
1415/// # Warning
1416///
1417/// Properties, context vars and context locals are implemented with the assumption that all consumers have
1418/// released the context on return, that is even if the context was shared with worker threads all work was block-waited.
1419/// This node breaks this assumption, specially with `over: true` you may cause unexpected behavior if you don't consider
1420/// carefully what context is being captured and what context is being replaced.
1421///
1422/// As a general rule, only capture during init or update in [`NestGroup::CHILD`], only wrap full widgets and only place the wrapped
1423/// widget in a parent's [`NestGroup::CHILD`] for a parent that has no special expectations about the child.
1424///
1425/// As an example of things that can go wrong, if you capture during layout, the `LAYOUT` context is captured
1426/// and replaces `over` the actual layout context during all subsequent layouts in the actual parent.
1427///
1428/// # Panics
1429///
1430/// Panics during init if `ctx` is not from the same app as the init context.
1431///
1432/// [`NestGroup::CHILD`]: zng_app::widget::builder::NestGroup::CHILD
1433/// [`UiNodeOp`]: zng_app::widget::node::UiNodeOp
1434/// [`LocalContext::with_context_blend`]: zng_app_context::LocalContext::with_context_blend
1435pub fn with_context_blend(mut ctx: LocalContext, over: bool, child: impl IntoUiNode) -> UiNode {
1436    match_widget(child, move |c, op| {
1437        if let UiNodeOp::Init = op {
1438            let init_app = LocalContext::current_app();
1439            ctx.with_context_blend(over, || {
1440                let ctx_app = LocalContext::current_app();
1441                assert_eq!(init_app, ctx_app);
1442                c.op(op)
1443            });
1444        } else {
1445            ctx.with_context_blend(over, || c.op(op));
1446        }
1447    })
1448}
1449
1450/// Helper for declaring properties that set the widget state.
1451///
1452/// The state ID is set in [`WIDGET`] on init and is kept updated. On deinit it is set to the `default` value.
1453///
1454/// # Examples
1455///
1456/// ```
1457/// # fn main() -> () { }
1458/// # use zng_app::{widget::{property, node::{UiNode, IntoUiNode}, WIDGET, WidgetUpdateMode}};
1459/// # use zng_var::IntoVar;
1460/// # use zng_wgt::node::with_widget_state;
1461/// # use zng_state_map::{StateId, static_id};
1462/// #
1463/// static_id! {
1464///     pub static ref FOO_ID: StateId<u32>;
1465/// }
1466///
1467/// #[property(CONTEXT)]
1468/// pub fn foo(child: impl IntoUiNode, value: impl IntoVar<u32>) -> UiNode {
1469///     with_widget_state(child, *FOO_ID, || 0, value)
1470/// }
1471///
1472/// // after the property is used and the widget initializes:
1473///
1474/// /// Get the value from outside the widget.
1475/// fn get_foo_outer(widget: &mut UiNode) -> u32 {
1476///     if let Some(mut wgt) = widget.as_widget() {
1477///         wgt.with_context(WidgetUpdateMode::Ignore, || WIDGET.get_state(*FOO_ID))
1478///             .unwrap_or(0)
1479///     } else {
1480///         0
1481///     }
1482/// }
1483///
1484/// /// Get the value from inside the widget.
1485/// fn get_foo_inner() -> u32 {
1486///     WIDGET.get_state(*FOO_ID).unwrap_or_default()
1487/// }
1488/// ```
1489///
1490/// [`WIDGET`]: zng_app::widget::WIDGET
1491pub fn with_widget_state<U, I, T>(child: U, id: impl Into<StateId<T>>, default: I, value: impl IntoVar<T>) -> UiNode
1492where
1493    U: IntoUiNode,
1494    I: Fn() -> T + Send + 'static,
1495    T: StateValue + VarValue,
1496{
1497    with_widget_state_impl(child.into_node(), id.into(), default, value.into_var())
1498}
1499fn with_widget_state_impl<I, T>(child: UiNode, id: impl Into<StateId<T>>, default: I, value: impl IntoVar<T>) -> UiNode
1500where
1501    I: Fn() -> T + Send + 'static,
1502    T: StateValue + VarValue,
1503{
1504    let id = id.into();
1505    let value = value.into_var();
1506
1507    match_node(child, move |child, op| match op {
1508        UiNodeOp::Init => {
1509            child.init();
1510            WIDGET.sub_var(&value);
1511            WIDGET.set_state(id, value.get());
1512        }
1513        UiNodeOp::Deinit => {
1514            child.deinit();
1515            WIDGET.set_state(id, default());
1516        }
1517        UiNodeOp::Update { updates } => {
1518            child.update(updates);
1519            if let Some(v) = value.get_new() {
1520                WIDGET.set_state(id, v);
1521            }
1522        }
1523        _ => {}
1524    })
1525}
1526
1527/// Helper for declaring properties that set the widget state with a custom closure.
1528///
1529/// The `default` closure is used to init the state value, then the `modify` closure is used to modify the state using the variable value.
1530///
1531/// On deinit the `default` value is set on the state again.
1532///
1533/// See [`with_widget_state`] for more details.
1534pub fn with_widget_state_modify<U, S, V, I, M>(child: U, id: impl Into<StateId<S>>, value: impl IntoVar<V>, default: I, modify: M) -> UiNode
1535where
1536    U: IntoUiNode,
1537    S: StateValue,
1538    V: VarValue,
1539    I: Fn() -> S + Send + 'static,
1540    M: FnMut(&mut S, &V) + Send + 'static,
1541{
1542    with_widget_state_modify_impl(child.into_node(), id.into(), value.into_var(), default, modify)
1543}
1544fn with_widget_state_modify_impl<S, V, I, M>(
1545    child: UiNode,
1546    id: impl Into<StateId<S>>,
1547    value: impl IntoVar<V>,
1548    default: I,
1549    mut modify: M,
1550) -> UiNode
1551where
1552    S: StateValue,
1553    V: VarValue,
1554    I: Fn() -> S + Send + 'static,
1555    M: FnMut(&mut S, &V) + Send + 'static,
1556{
1557    let id = id.into();
1558    let value = value.into_var();
1559
1560    match_node(child, move |child, op| match op {
1561        UiNodeOp::Init => {
1562            child.init();
1563
1564            WIDGET.sub_var(&value);
1565
1566            value.with(|v| {
1567                WIDGET.with_state_mut(|mut s| {
1568                    modify(s.entry(id).or_insert_with(&default), v);
1569                })
1570            })
1571        }
1572        UiNodeOp::Deinit => {
1573            child.deinit();
1574
1575            WIDGET.set_state(id, default());
1576        }
1577        UiNodeOp::Update { updates } => {
1578            child.update(updates);
1579            value.with_new(|v| {
1580                WIDGET.with_state_mut(|mut s| {
1581                    modify(s.req_mut(id), v);
1582                })
1583            });
1584        }
1585        _ => {}
1586    })
1587}
1588
1589/// Create a node that controls interaction for all widgets inside `node`.
1590///
1591/// When the `interactive` var is `false` all descendant widgets are [`BLOCKED`].
1592///
1593/// Unlike the [`interactive`] property this does not apply to the contextual widget, only `child` and descendants.
1594///
1595/// The node works for either if the `child` is a widget or if it only contains widgets, the performance
1596/// is slightly better if the `child` is a widget.
1597///
1598/// [`interactive`]: fn@crate::interactive
1599/// [`BLOCKED`]: Interactivity::BLOCKED
1600pub fn interactive_node(child: impl IntoUiNode, interactive: impl IntoVar<bool>) -> UiNode {
1601    let interactive = interactive.into_var();
1602
1603    match_node(child, move |child, op| match op {
1604        UiNodeOp::Init => {
1605            WIDGET.sub_var_info(&interactive);
1606        }
1607        UiNodeOp::Info { info } => {
1608            if interactive.get() {
1609                child.info(info);
1610            } else if let Some(mut wgt) = child.node().as_widget() {
1611                let id = wgt.id();
1612                // child is a widget.
1613                info.push_interactivity_filter(move |args| {
1614                    if args.info.id() == id {
1615                        Interactivity::BLOCKED
1616                    } else {
1617                        Interactivity::ENABLED
1618                    }
1619                });
1620                child.info(info);
1621            } else {
1622                let block_range = info.with_children_range(|info| child.info(info));
1623                if !block_range.is_empty() {
1624                    // has child widgets.
1625
1626                    let id = WIDGET.id();
1627                    info.push_interactivity_filter(move |args| {
1628                        if let Some(parent) = args.info.parent()
1629                            && parent.id() == id
1630                        {
1631                            // check child range
1632                            for (i, item) in parent.children().enumerate() {
1633                                if item == args.info {
1634                                    return if !block_range.contains(&i) {
1635                                        Interactivity::ENABLED
1636                                    } else {
1637                                        Interactivity::BLOCKED
1638                                    };
1639                                } else if i >= block_range.end {
1640                                    break;
1641                                }
1642                            }
1643                        }
1644                        Interactivity::ENABLED
1645                    });
1646                }
1647            }
1648        }
1649        _ => {}
1650    })
1651}
1652
1653/// Helper for a property that gets the index of the widget in the parent panel.
1654///
1655/// See [`with_index_len_node`] for more details.
1656pub fn with_index_node(
1657    child: impl IntoUiNode,
1658    panel_list_id: impl Into<StateId<PanelListRange>>,
1659    mut update: impl FnMut(Option<usize>) + Send + 'static,
1660) -> UiNode {
1661    let panel_list_id = panel_list_id.into();
1662    let mut version = None;
1663    match_node(child, move |_, op| match op {
1664        UiNodeOp::Deinit => {
1665            update(None);
1666            version = None;
1667        }
1668        UiNodeOp::Update { .. } => {
1669            // parent PanelList requests updates for this widget every time there is an update.
1670            let info = WIDGET.info();
1671            if let Some(parent) = info.parent()
1672                && let Some(mut c) = PanelListRange::update(&parent, panel_list_id, &mut version)
1673            {
1674                let id = info.id();
1675                let p = c.position(|w| w.id() == id);
1676                update(p);
1677            }
1678        }
1679        _ => {}
1680    })
1681}
1682
1683/// Helper for a property that gets the reverse index of the widget in the parent panel.
1684///
1685/// See [`with_index_len_node`] for more details.
1686pub fn with_rev_index_node(
1687    child: impl IntoUiNode,
1688    panel_list_id: impl Into<StateId<PanelListRange>>,
1689    mut update: impl FnMut(Option<usize>) + Send + 'static,
1690) -> UiNode {
1691    let panel_list_id = panel_list_id.into();
1692    let mut version = None;
1693    match_node(child, move |_, op| match op {
1694        UiNodeOp::Deinit => {
1695            update(None);
1696            version = None;
1697        }
1698        UiNodeOp::Update { .. } => {
1699            let info = WIDGET.info();
1700            if let Some(parent) = info.parent()
1701                && let Some(c) = PanelListRange::update(&parent, panel_list_id, &mut version)
1702            {
1703                let id = info.id();
1704                let p = c.rev().position(|w| w.id() == id);
1705                update(p);
1706            }
1707        }
1708        _ => {}
1709    })
1710}
1711
1712/// Helper for a property that gets the index of the widget in the parent panel and the number of children.
1713///  
1714/// Panels must use [`PanelList::track_info_range`] to collect the `panel_list_id`, then implement getter properties
1715/// using the methods in this module. See the `stack!` getter properties for examples.
1716///
1717/// [`PanelList::track_info_range`]: zng_app::widget::node::PanelList::track_info_range
1718pub fn with_index_len_node(
1719    child: impl IntoUiNode,
1720    panel_list_id: impl Into<StateId<PanelListRange>>,
1721    mut update: impl FnMut(Option<(usize, usize)>) + Send + 'static,
1722) -> UiNode {
1723    let panel_list_id = panel_list_id.into();
1724    let mut version = None;
1725    match_node(child, move |_, op| match op {
1726        UiNodeOp::Deinit => {
1727            update(None);
1728            version = None;
1729        }
1730        UiNodeOp::Update { .. } => {
1731            let info = WIDGET.info();
1732            if let Some(parent) = info.parent()
1733                && let Some(mut iter) = PanelListRange::update(&parent, panel_list_id, &mut version)
1734            {
1735                let id = info.id();
1736                let mut p = 0;
1737                let mut count = 0;
1738                for c in &mut iter {
1739                    if c.id() == id {
1740                        p = count;
1741                        count += 1 + iter.count();
1742                        break;
1743                    } else {
1744                        count += 1;
1745                    }
1746                }
1747                update(Some((p, count)));
1748            }
1749        }
1750        _ => {}
1751    })
1752}
1753
1754/// Node that presents `data` using `wgt_fn`.
1755///
1756/// The node's child is always the result of `wgt_fn` called for the `data` value, it is reinited every time
1757/// either variable changes. If the child is an widget the node becomes it.
1758///
1759/// See also [`presenter_opt`] for a presenter that is nil with the data is `None`.
1760///
1761/// See also the [`present`](VarPresent::present) method that can be called on the `data`` variable and [`present_data`](VarPresentData::present_data)
1762/// that can be called on the `wgt_fn` variable.
1763pub fn presenter<D: VarValue>(data: impl IntoVar<D>, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
1764    let data = data.into_var();
1765    let wgt_fn = wgt_fn.into_var();
1766
1767    match_widget(UiNode::nil(), move |c, op| match op {
1768        UiNodeOp::Init => {
1769            WIDGET.sub_var(&data).sub_var(&wgt_fn);
1770            *c.node() = wgt_fn.get()(data.get());
1771        }
1772        UiNodeOp::Deinit => {
1773            c.deinit();
1774            *c.node() = UiNode::nil();
1775        }
1776        UiNodeOp::Update { .. } if (data.is_new() || wgt_fn.is_new()) => {
1777            c.node().deinit();
1778            *c.node() = wgt_fn.get()(data.get());
1779            c.node().init();
1780            c.delegated();
1781            WIDGET.update_info().layout().render();
1782        }
1783        _ => {}
1784    })
1785}
1786
1787/// Node that presents `data` using `wgt_fn` if data is available, otherwise presents nil.
1788///
1789/// This behaves like [`presenter`], but `wgt_fn` is not called if `data` is `None`.
1790///
1791/// See also the [`present_opt`](VarPresentOpt::present_opt) method that can be called on the data variable.
1792pub fn presenter_opt<D: VarValue>(data: impl IntoVar<Option<D>>, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
1793    let data = data.into_var();
1794    let wgt_fn = wgt_fn.into_var();
1795
1796    match_widget(UiNode::nil(), move |c, op| match op {
1797        UiNodeOp::Init => {
1798            WIDGET.sub_var(&data).sub_var(&wgt_fn);
1799            if let Some(data) = data.get() {
1800                *c.node() = wgt_fn.get()(data);
1801            }
1802        }
1803        UiNodeOp::Deinit => {
1804            c.deinit();
1805            *c.node() = UiNode::nil();
1806        }
1807        UiNodeOp::Update { .. } if data.is_new() || wgt_fn.is_new() => {
1808            if let Some(data) = data.get() {
1809                c.node().deinit();
1810                *c.node() = wgt_fn.get()(data);
1811                c.node().init();
1812                c.delegated();
1813                WIDGET.update_info().layout().render();
1814            } else if !c.node().is_nil() {
1815                c.node().deinit();
1816                *c.node() = UiNode::nil();
1817                c.delegated();
1818                WIDGET.update_info().layout().render();
1819            }
1820        }
1821        _ => {}
1822    })
1823}
1824
1825/// Node list that presents `list` using `item_fn` for each new list item.
1826///
1827/// The node's children is the list mapped to node items, it is kept in sync, any list update is propagated to the node list.
1828///
1829/// See also the [`present_list`](VarPresentList::present_list) method that can be called on the list variable.
1830pub fn list_presenter<D: VarValue>(list: impl IntoVar<ObservableVec<D>>, item_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
1831    ListPresenter {
1832        list: list.into_var(),
1833        item_fn: item_fn.into_var(),
1834        view: ui_vec![],
1835        _e: std::marker::PhantomData,
1836    }
1837    .into_node()
1838}
1839
1840/// Node list that presents `list` using `item_fn` for each list item.
1841///
1842/// The node's children are **regenerated** for each change in `list`, if possible prefer using [`ObservableVec`] with [`list_presenter`].
1843///
1844/// See also the [`present_list_from_iter`](VarPresentListFromIter::present_list_from_iter) method that can be called on the list variable.
1845pub fn list_presenter_from_iter<D, L>(list: impl IntoVar<L>, item_fn: impl IntoVar<WidgetFn<D>>) -> UiNode
1846where
1847    D: VarValue,
1848    L: IntoIterator<Item = D> + VarValue,
1849{
1850    ListPresenterFromIter {
1851        list: list.into_var(),
1852        item_fn: item_fn.into_var(),
1853        view: ui_vec![],
1854        _e: std::marker::PhantomData,
1855    }
1856    .into_node()
1857}
1858
1859struct ListPresenter<D>
1860where
1861    D: VarValue,
1862{
1863    list: Var<ObservableVec<D>>,
1864    item_fn: Var<WidgetFn<D>>,
1865    view: UiVec,
1866    _e: std::marker::PhantomData<D>,
1867}
1868
1869impl<D> UiNodeImpl for ListPresenter<D>
1870where
1871    D: VarValue,
1872{
1873    fn children_len(&self) -> usize {
1874        self.view.len()
1875    }
1876
1877    fn with_child(&mut self, index: usize, visitor: &mut dyn FnMut(&mut UiNode)) {
1878        self.view.with_child(index, visitor)
1879    }
1880
1881    fn is_list(&self) -> bool {
1882        true
1883    }
1884
1885    fn for_each_child(&mut self, visitor: &mut dyn FnMut(usize, &mut UiNode)) {
1886        self.view.for_each_child(visitor);
1887    }
1888
1889    fn try_for_each_child(
1890        &mut self,
1891        visitor: &mut dyn FnMut(usize, &mut UiNode) -> std::ops::ControlFlow<BoxAnyVarValue>,
1892    ) -> std::ops::ControlFlow<BoxAnyVarValue> {
1893        self.view.try_for_each_child(visitor)
1894    }
1895
1896    fn par_each_child(&mut self, visitor: &(dyn Fn(usize, &mut UiNode) + Sync)) {
1897        self.view.par_each_child(visitor);
1898    }
1899
1900    fn par_fold_reduce(
1901        &mut self,
1902        identity: BoxAnyVarValue,
1903        fold: &(dyn Fn(BoxAnyVarValue, usize, &mut UiNode) -> BoxAnyVarValue + Sync),
1904        reduce: &(dyn Fn(BoxAnyVarValue, BoxAnyVarValue) -> BoxAnyVarValue + Sync),
1905    ) -> BoxAnyVarValue {
1906        self.view.par_fold_reduce(identity, fold, reduce)
1907    }
1908
1909    fn init(&mut self) {
1910        debug_assert!(self.view.is_empty());
1911        self.view.clear();
1912
1913        WIDGET.sub_var(&self.list).sub_var(&self.item_fn);
1914
1915        let e_fn = self.item_fn.get();
1916        self.list.with(|l| {
1917            for el in l.iter() {
1918                let child = e_fn(el.clone());
1919                self.view.push(child);
1920            }
1921        });
1922
1923        self.view.init();
1924    }
1925
1926    fn deinit(&mut self) {
1927        self.view.deinit();
1928        self.view.clear();
1929    }
1930
1931    fn update(&mut self, updates: &WidgetUpdates) {
1932        self.update_list(updates, &mut ());
1933    }
1934
1935    fn update_list(&mut self, updates: &WidgetUpdates, observer: &mut dyn UiNodeListObserver) {
1936        let mut need_reset = self.item_fn.is_new();
1937
1938        let is_new = self
1939            .list
1940            .with_new(|l| {
1941                need_reset |= l.changes().is_empty() || l.changes() == [VecChange::Clear];
1942
1943                if need_reset {
1944                    return;
1945                }
1946
1947                // update before new items to avoid update before init.
1948                self.view.update_list(updates, observer);
1949
1950                let e_fn = self.item_fn.get();
1951
1952                for change in l.changes() {
1953                    match change {
1954                        VecChange::Insert { index, count } => {
1955                            for i in *index..(*index + count) {
1956                                let mut el = e_fn(l[i].clone());
1957                                el.init();
1958                                self.view.insert(i, el);
1959                                observer.inserted(i);
1960                            }
1961                        }
1962                        VecChange::Remove { index, count } => {
1963                            let mut count = *count;
1964                            let index = *index;
1965                            while count > 0 {
1966                                count -= 1;
1967
1968                                let mut el = self.view.remove(index);
1969                                el.deinit();
1970                                observer.removed(index);
1971                            }
1972                        }
1973                        VecChange::Move { from_index, to_index } => {
1974                            let el = self.view.remove(*from_index);
1975                            self.view.insert(*to_index, el);
1976                            observer.moved(*from_index, *to_index);
1977                        }
1978                        VecChange::Clear => unreachable!(),
1979                    }
1980                }
1981            })
1982            .is_some();
1983
1984        if !need_reset && !is_new && self.list.with(|l| l.len() != self.view.len()) {
1985            need_reset = true;
1986        }
1987
1988        if need_reset {
1989            self.view.deinit();
1990            self.view.clear();
1991
1992            let e_fn = self.item_fn.get();
1993            self.list.with(|l| {
1994                for el in l.iter() {
1995                    let child = e_fn(el.clone());
1996                    self.view.push(child);
1997                }
1998            });
1999
2000            self.view.init();
2001        } else if !is_new {
2002            self.view.update_list(updates, observer);
2003        }
2004    }
2005
2006    fn info(&mut self, info: &mut zng_app::widget::info::WidgetInfoBuilder) {
2007        self.view.info(info);
2008    }
2009
2010    fn measure(&mut self, wm: &mut zng_app::widget::info::WidgetMeasure) -> PxSize {
2011        self.view.measure(wm)
2012    }
2013
2014    fn measure_list(
2015        &mut self,
2016        wm: &mut zng_app::widget::info::WidgetMeasure,
2017        measure: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetMeasure) -> PxSize + Sync),
2018        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
2019    ) -> PxSize {
2020        self.view.measure_list(wm, measure, fold_size)
2021    }
2022
2023    fn layout(&mut self, wl: &mut zng_app::widget::info::WidgetLayout) -> PxSize {
2024        self.view.layout(wl)
2025    }
2026
2027    fn layout_list(
2028        &mut self,
2029        wl: &mut zng_app::widget::info::WidgetLayout,
2030        layout: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetLayout) -> PxSize + Sync),
2031        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
2032    ) -> PxSize {
2033        self.view.layout_list(wl, layout, fold_size)
2034    }
2035
2036    fn render(&mut self, frame: &mut FrameBuilder) {
2037        self.view.render(frame);
2038    }
2039
2040    fn render_list(&mut self, frame: &mut FrameBuilder, render: &(dyn Fn(usize, &mut UiNode, &mut FrameBuilder) + Sync)) {
2041        self.view.render_list(frame, render);
2042    }
2043
2044    fn render_update(&mut self, update: &mut zng_app::render::FrameUpdate) {
2045        self.view.render_update(update);
2046    }
2047
2048    fn render_update_list(
2049        &mut self,
2050        update: &mut zng_app::render::FrameUpdate,
2051        render_update: &(dyn Fn(usize, &mut UiNode, &mut zng_app::render::FrameUpdate) + Sync),
2052    ) {
2053        self.view.render_update_list(update, render_update);
2054    }
2055
2056    fn as_widget(&mut self) -> Option<&mut dyn WidgetUiNodeImpl> {
2057        None
2058    }
2059}
2060
2061struct ListPresenterFromIter<D, L>
2062where
2063    D: VarValue,
2064    L: IntoIterator<Item = D> + VarValue,
2065{
2066    list: Var<L>,
2067    item_fn: Var<WidgetFn<D>>,
2068    view: UiVec,
2069    _e: std::marker::PhantomData<(D, L)>,
2070}
2071
2072impl<D, L> UiNodeImpl for ListPresenterFromIter<D, L>
2073where
2074    D: VarValue,
2075    L: IntoIterator<Item = D> + VarValue,
2076{
2077    fn children_len(&self) -> usize {
2078        self.view.len()
2079    }
2080
2081    fn with_child(&mut self, index: usize, visitor: &mut dyn FnMut(&mut UiNode)) {
2082        self.view.with_child(index, visitor)
2083    }
2084
2085    fn for_each_child(&mut self, visitor: &mut dyn FnMut(usize, &mut UiNode)) {
2086        self.view.for_each_child(visitor)
2087    }
2088
2089    fn try_for_each_child(
2090        &mut self,
2091        visitor: &mut dyn FnMut(usize, &mut UiNode) -> std::ops::ControlFlow<BoxAnyVarValue>,
2092    ) -> std::ops::ControlFlow<BoxAnyVarValue> {
2093        self.view.try_for_each_child(visitor)
2094    }
2095
2096    fn par_each_child(&mut self, visitor: &(dyn Fn(usize, &mut UiNode) + Sync)) {
2097        self.view.par_each_child(visitor);
2098    }
2099
2100    fn par_fold_reduce(
2101        &mut self,
2102        identity: BoxAnyVarValue,
2103        fold: &(dyn Fn(BoxAnyVarValue, usize, &mut UiNode) -> BoxAnyVarValue + Sync),
2104        reduce: &(dyn Fn(BoxAnyVarValue, BoxAnyVarValue) -> BoxAnyVarValue + Sync),
2105    ) -> BoxAnyVarValue {
2106        self.view.par_fold_reduce(identity, fold, reduce)
2107    }
2108
2109    fn is_list(&self) -> bool {
2110        true
2111    }
2112
2113    fn init(&mut self) {
2114        debug_assert!(self.view.is_empty());
2115        self.view.clear();
2116
2117        WIDGET.sub_var(&self.list).sub_var(&self.item_fn);
2118
2119        let e_fn = self.item_fn.get();
2120
2121        self.view.extend(self.list.get().into_iter().map(&*e_fn));
2122        self.view.init();
2123    }
2124
2125    fn deinit(&mut self) {
2126        self.view.deinit();
2127        self.view.clear();
2128    }
2129
2130    fn update(&mut self, updates: &WidgetUpdates) {
2131        self.update_list(updates, &mut ())
2132    }
2133    fn update_list(&mut self, updates: &WidgetUpdates, observer: &mut dyn UiNodeListObserver) {
2134        if self.list.is_new() || self.item_fn.is_new() {
2135            self.view.deinit();
2136            self.view.clear();
2137            let e_fn = self.item_fn.get();
2138            self.view.extend(self.list.get().into_iter().map(&*e_fn));
2139            self.view.init();
2140            observer.reset();
2141        } else {
2142            self.view.update_list(updates, observer);
2143        }
2144    }
2145
2146    fn info(&mut self, info: &mut zng_app::widget::info::WidgetInfoBuilder) {
2147        self.view.info(info)
2148    }
2149
2150    fn measure(&mut self, wm: &mut zng_app::widget::info::WidgetMeasure) -> PxSize {
2151        self.view.measure(wm)
2152    }
2153
2154    fn measure_list(
2155        &mut self,
2156        wm: &mut zng_app::widget::info::WidgetMeasure,
2157        measure: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetMeasure) -> PxSize + Sync),
2158        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
2159    ) -> PxSize {
2160        self.view.measure_list(wm, measure, fold_size)
2161    }
2162
2163    fn layout(&mut self, wl: &mut zng_app::widget::info::WidgetLayout) -> PxSize {
2164        self.view.layout(wl)
2165    }
2166
2167    fn layout_list(
2168        &mut self,
2169        wl: &mut zng_app::widget::info::WidgetLayout,
2170        layout: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetLayout) -> PxSize + Sync),
2171        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
2172    ) -> PxSize {
2173        self.view.layout_list(wl, layout, fold_size)
2174    }
2175
2176    fn render(&mut self, frame: &mut FrameBuilder) {
2177        self.view.render(frame);
2178    }
2179
2180    fn render_list(&mut self, frame: &mut FrameBuilder, render: &(dyn Fn(usize, &mut UiNode, &mut FrameBuilder) + Sync)) {
2181        self.view.render_list(frame, render);
2182    }
2183
2184    fn render_update(&mut self, update: &mut zng_app::render::FrameUpdate) {
2185        self.view.render_update(update);
2186    }
2187
2188    fn render_update_list(
2189        &mut self,
2190        update: &mut zng_app::render::FrameUpdate,
2191        render_update: &(dyn Fn(usize, &mut UiNode, &mut zng_app::render::FrameUpdate) + Sync),
2192    ) {
2193        self.view.render_update_list(update, render_update);
2194    }
2195
2196    fn as_widget(&mut self) -> Option<&mut dyn WidgetUiNodeImpl> {
2197        None
2198    }
2199}
2200
2201/// Extension method to *convert* a variable to a node.
2202pub trait VarPresent<D: VarValue> {
2203    /// Present the variable data using a [`presenter`] node.
2204    fn present(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2205}
2206impl<D: VarValue> VarPresent<D> for Var<D> {
2207    fn present(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2208        presenter(self.clone(), wgt_fn)
2209    }
2210}
2211
2212/// Extension method to *convert* a variable to a node.
2213pub trait VarPresentOpt<D: VarValue> {
2214    /// Present the variable data using a [`presenter_opt`] node.
2215    fn present_opt(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2216}
2217impl<D: VarValue> VarPresentOpt<D> for Var<Option<D>> {
2218    fn present_opt(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2219        presenter_opt(self.clone(), wgt_fn)
2220    }
2221}
2222
2223/// Extension method fo *convert* a variable to a node list.
2224pub trait VarPresentList<D: VarValue> {
2225    /// Present the variable data using a [`list_presenter`] node list.
2226    fn present_list(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2227}
2228impl<D: VarValue> VarPresentList<D> for Var<ObservableVec<D>> {
2229    fn present_list(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2230        list_presenter(self.clone(), wgt_fn)
2231    }
2232}
2233
2234/// Extension method fo *convert* a variable to a node list.
2235pub trait VarPresentListFromIter<D: VarValue, L: IntoIterator<Item = D> + VarValue> {
2236    /// Present the variable data using a [`list_presenter_from_iter`] node list.
2237    fn present_list_from_iter(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2238}
2239impl<D: VarValue, L: IntoIterator<Item = D> + VarValue> VarPresentListFromIter<D, L> for Var<L> {
2240    fn present_list_from_iter(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2241        list_presenter_from_iter(self.clone(), wgt_fn)
2242    }
2243}
2244
2245/// Extension method to *convert* a variable to a node.
2246pub trait VarPresentData<D: VarValue> {
2247    /// Present the `data` variable using a [`presenter`] node.
2248    fn present_data(&self, data: impl IntoVar<D>) -> UiNode;
2249}
2250impl<D: VarValue> VarPresentData<D> for Var<WidgetFn<D>> {
2251    fn present_data(&self, data: impl IntoVar<D>) -> UiNode {
2252        presenter(data, self.clone())
2253    }
2254}