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,
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                _handle = ctx.hook(move |a| {
978                    handle.enabled().set(*a.value());
979                    win_handle.enabled().set(*a.value());
980                    true
981                });
982            } else {
983                _wgt_handle = handle;
984                _win_handle = win_handle;
985            }
986        }
987        UiNodeOp::Deinit => {
988            _handle = VarHandle::dummy();
989            _wgt_handle = CommandHandle::dummy();
990            _win_handle = CommandHandle::dummy();
991        }
992        _ => {}
993    })
994}
995
996/// Logs an error if the `_var` is always read-only.
997pub fn validate_getter_var<T: VarValue>(_var: &Var<T>) {
998    #[cfg(debug_assertions)]
999    if _var.capabilities().is_always_read_only() {
1000        tracing::error!(
1001            "`is_`, `has_` or `get_` property inited with read-only var in `{}`",
1002            WIDGET.trace_id()
1003        );
1004    }
1005}
1006
1007/// Helper for declaring state properties that are controlled by a variable.
1008///
1009/// On init the `state` variable is set to `source` and bound to it, you can use this to create state properties
1010/// that map from a context variable or to create composite properties that merge other state properties.
1011pub fn bind_state<T: VarValue>(child: impl IntoUiNode, source: impl IntoVar<T>, state: impl IntoVar<T>) -> UiNode {
1012    let source = source.into_var();
1013    bind_state_init(child, state, move |state| {
1014        state.set_from(&source);
1015        source.bind(state)
1016    })
1017}
1018
1019/// Helper for declaring state properties that are controlled by a variable.
1020///
1021/// On init the `bind` closure is called with the `state` variable, it must set and bind it.
1022pub fn bind_state_init<T>(
1023    child: impl IntoUiNode,
1024    state: impl IntoVar<T>,
1025    mut bind: impl FnMut(&Var<T>) -> VarHandle + Send + 'static,
1026) -> UiNode
1027where
1028    T: VarValue,
1029{
1030    let state = state.into_var();
1031    let mut _binding = VarHandle::dummy();
1032
1033    match_node(child, move |_, op| match op {
1034        UiNodeOp::Init => {
1035            validate_getter_var(&state);
1036            _binding = bind(&state);
1037        }
1038        UiNodeOp::Deinit => {
1039            _binding = VarHandle::dummy();
1040        }
1041        _ => {}
1042    })
1043}
1044
1045/// Helper for declaring state properties that are controlled by values in the widget state map.
1046///
1047/// The `predicate` closure is called with the widget state on init and every update, if the returned value changes the `state`
1048/// updates. The `deinit` closure is called on deinit to get the *reset* value.
1049pub fn widget_state_is_state(
1050    child: impl IntoUiNode,
1051    predicate: impl Fn(StateMapRef<WIDGET>) -> bool + Send + 'static,
1052    deinit: impl Fn(StateMapRef<WIDGET>) -> bool + Send + 'static,
1053    state: impl IntoVar<bool>,
1054) -> UiNode {
1055    let state = state.into_var();
1056
1057    match_node(child, move |child, op| match op {
1058        UiNodeOp::Init => {
1059            validate_getter_var(&state);
1060            child.init();
1061            let s = WIDGET.with_state(&predicate);
1062            if s != state.get() {
1063                state.set(s);
1064            }
1065        }
1066        UiNodeOp::Deinit => {
1067            child.deinit();
1068            let s = WIDGET.with_state(&deinit);
1069            if s != state.get() {
1070                state.set(s);
1071            }
1072        }
1073        UiNodeOp::Update { updates } => {
1074            child.update(updates);
1075            let s = WIDGET.with_state(&predicate);
1076            if s != state.get() {
1077                state.set(s);
1078            }
1079        }
1080        _ => {}
1081    })
1082}
1083
1084/// Helper for declaring state getter properties that are controlled by values in the widget state map.
1085///
1086/// The `get_new` closure is called with the widget state and current `state` every init and update, if it returns some value
1087/// the `state` updates. The `get_deinit` closure is called on deinit to get the *reset* value.
1088pub fn widget_state_get_state<T: VarValue>(
1089    child: impl IntoUiNode,
1090    get_new: impl Fn(StateMapRef<WIDGET>, &T) -> Option<T> + Send + 'static,
1091    get_deinit: impl Fn(StateMapRef<WIDGET>, &T) -> Option<T> + Send + 'static,
1092    state: impl IntoVar<T>,
1093) -> UiNode {
1094    let state = state.into_var();
1095    match_node(child, move |child, op| match op {
1096        UiNodeOp::Init => {
1097            validate_getter_var(&state);
1098            child.init();
1099            let new = state.with(|s| WIDGET.with_state(|w| get_new(w, s)));
1100            if let Some(new) = new {
1101                state.set(new);
1102            }
1103        }
1104        UiNodeOp::Deinit => {
1105            child.deinit();
1106
1107            let new = state.with(|s| WIDGET.with_state(|w| get_deinit(w, s)));
1108            if let Some(new) = new {
1109                state.set(new);
1110            }
1111        }
1112        UiNodeOp::Update { updates } => {
1113            child.update(updates);
1114            let new = state.with(|s| WIDGET.with_state(|w| get_new(w, s)));
1115            if let Some(new) = new {
1116                state.set(new);
1117            }
1118        }
1119        _ => {}
1120    })
1121}
1122
1123/// Transforms and clips the `content` node according with the default widget border align behavior.
1124///
1125/// Properties that *fill* the widget can wrap their fill content in this node to automatically implement
1126/// the expected interaction with the widget borders, the content will be positioned, sized and clipped according to the
1127/// widget borders, corner radius and border align.
1128pub fn fill_node(content: impl IntoUiNode) -> UiNode {
1129    let mut clip_bounds = PxSize::zero();
1130    let mut clip_corners = PxCornerRadius::zero();
1131
1132    let mut offset = PxVector::zero();
1133    let offset_key = FrameValueKey::new_unique();
1134    let mut define_frame = false;
1135
1136    match_node(content, move |child, op| match op {
1137        UiNodeOp::Init => {
1138            WIDGET.sub_var_layout(&BORDER_ALIGN_VAR);
1139            define_frame = false;
1140            offset = PxVector::zero();
1141        }
1142        UiNodeOp::Measure { desired_size, .. } => {
1143            let offsets = BORDER.inner_offsets();
1144            let align = BORDER_ALIGN_VAR.get();
1145
1146            let our_offsets = offsets * align;
1147            let size_offset = offsets - our_offsets;
1148
1149            let size_increase = PxSize::new(size_offset.horizontal(), size_offset.vertical());
1150
1151            *desired_size = LAYOUT.constraints().fill_size() + size_increase;
1152        }
1153        UiNodeOp::Layout { wl, final_size } => {
1154            // We are inside the *inner* bounds AND inside border_nodes:
1155            //
1156            // .. ( layout ( new_border/inner ( border_nodes ( FILL_NODES ( new_child_context ( new_child_layout ( ..
1157
1158            let (bounds, corners) = BORDER.fill_bounds();
1159
1160            let mut new_offset = bounds.origin.to_vector();
1161
1162            if clip_bounds != bounds.size || clip_corners != corners {
1163                clip_bounds = bounds.size;
1164                clip_corners = corners;
1165                WIDGET.render();
1166            }
1167
1168            let (_, branch_offset) = LAYOUT.with_constraints(PxConstraints2d::new_exact_size(bounds.size), || {
1169                wl.with_branch_child(|wl| child.layout(wl))
1170            });
1171            new_offset += branch_offset;
1172
1173            if offset != new_offset {
1174                offset = new_offset;
1175
1176                if define_frame {
1177                    WIDGET.render_update();
1178                } else {
1179                    define_frame = true;
1180                    WIDGET.render();
1181                }
1182            }
1183
1184            *final_size = bounds.size;
1185        }
1186        UiNodeOp::Render { frame } => {
1187            let mut render = |frame: &mut FrameBuilder| {
1188                let bounds = PxRect::from_size(clip_bounds);
1189                frame.push_clips(
1190                    |c| {
1191                        if clip_corners != PxCornerRadius::zero() {
1192                            c.push_clip_rounded_rect(bounds, clip_corners, false, false);
1193                        } else {
1194                            c.push_clip_rect(bounds, false, false);
1195                        }
1196
1197                        if let Some(inline) = WIDGET.bounds().inline() {
1198                            for r in inline.negative_space().iter() {
1199                                c.push_clip_rect(*r, true, false);
1200                            }
1201                        }
1202                    },
1203                    |f| child.render(f),
1204                );
1205            };
1206
1207            if define_frame {
1208                frame.push_reference_frame(offset_key.into(), offset_key.bind(offset.into(), false), true, false, |frame| {
1209                    render(frame);
1210                });
1211            } else {
1212                render(frame);
1213            }
1214        }
1215        UiNodeOp::RenderUpdate { update } => {
1216            if define_frame {
1217                update.with_transform(offset_key.update(offset.into(), false), false, |update| {
1218                    child.render_update(update);
1219                });
1220            } else {
1221                child.render_update(update);
1222            }
1223        }
1224        _ => {}
1225    })
1226}
1227
1228/// Creates a border node that delegates rendering to a `border_visual` and manages the `border_offsets` coordinating
1229/// with the other borders of the widget.
1230///
1231/// This node disables inline layout for the widget.
1232pub fn border_node(child: impl IntoUiNode, border_offsets: impl IntoVar<SideOffsets>, border_visual: impl IntoUiNode) -> UiNode {
1233    let offsets = border_offsets.into_var();
1234    let mut render_offsets = PxSideOffsets::zero();
1235    let mut border_rect = PxRect::zero();
1236
1237    match_node(ui_vec![child, border_visual], move |children, op| match op {
1238        UiNodeOp::Init => {
1239            WIDGET.sub_var_layout(&offsets).sub_var_render(&BORDER_OVER_VAR);
1240        }
1241        UiNodeOp::Measure { wm, desired_size } => {
1242            let offsets = offsets.layout();
1243            *desired_size = BORDER.measure_border(offsets, || {
1244                LAYOUT.with_sub_size(PxSize::new(offsets.horizontal(), offsets.vertical()), || {
1245                    children.node().with_child(0, |n| wm.measure_block(n))
1246                })
1247            });
1248            children.delegated();
1249        }
1250        UiNodeOp::Layout { wl, final_size } => {
1251            // We are inside the *inner* bounds or inside a parent border_node:
1252            //
1253            // .. ( layout ( new_border/inner ( BORDER_NODES ( fill_nodes ( new_child_context ( new_child_layout ( ..
1254            //
1255            // `wl` is targeting the child transform, child nodes are naturally inside borders, so we
1256            // need to add to the offset and take the size, fill_nodes optionally cancel this transform.
1257
1258            let offsets = offsets.layout();
1259            if render_offsets != offsets {
1260                render_offsets = offsets;
1261                WIDGET.render();
1262            }
1263
1264            let parent_offsets = BORDER.inner_offsets();
1265            let origin = PxPoint::new(parent_offsets.left, parent_offsets.top);
1266            if border_rect.origin != origin {
1267                border_rect.origin = origin;
1268                WIDGET.render();
1269            }
1270
1271            // layout child and border visual
1272            BORDER.layout_border(offsets, || {
1273                wl.translate(PxVector::new(offsets.left, offsets.top));
1274
1275                let taken_size = PxSize::new(offsets.horizontal(), offsets.vertical());
1276                border_rect.size = LAYOUT.with_sub_size(taken_size, || children.node().with_child(0, |n| n.layout(wl)));
1277
1278                // layout border visual
1279                LAYOUT.with_constraints(PxConstraints2d::new_exact_size(border_rect.size), || {
1280                    BORDER.with_border_layout(border_rect, offsets, || {
1281                        children.node().with_child(1, |n| n.layout(wl));
1282                    });
1283                });
1284            });
1285            children.delegated();
1286
1287            *final_size = border_rect.size;
1288        }
1289        UiNodeOp::Render { frame } => {
1290            if BORDER_OVER_VAR.get() {
1291                children.node().with_child(0, |c| c.render(frame));
1292                BORDER.with_border_layout(border_rect, render_offsets, || {
1293                    children.node().with_child(1, |c| c.render(frame));
1294                });
1295            } else {
1296                BORDER.with_border_layout(border_rect, render_offsets, || {
1297                    children.node().with_child(1, |c| c.render(frame));
1298                });
1299                children.node().with_child(0, |c| c.render(frame));
1300            }
1301            children.delegated();
1302        }
1303        UiNodeOp::RenderUpdate { update } => {
1304            children.node().with_child(0, |c| c.render_update(update));
1305            BORDER.with_border_layout(border_rect, render_offsets, || {
1306                children.node().with_child(1, |c| c.render_update(update));
1307            });
1308            children.delegated();
1309        }
1310        _ => {}
1311    })
1312}
1313
1314/// Helper for declaring nodes that sets a context local value.
1315///
1316/// See [`context_local!`] for more details about contextual values.
1317///
1318/// [`context_local!`]: crate::prelude::context_local
1319pub fn with_context_local<T: Any + Send + Sync + 'static>(
1320    child: impl IntoUiNode,
1321    context: &'static ContextLocal<T>,
1322    value: impl Into<T>,
1323) -> UiNode {
1324    let mut value = Some(Arc::new(value.into()));
1325
1326    match_node(child, move |child, op| {
1327        context.with_context(&mut value, || child.op(op));
1328    })
1329}
1330
1331/// Helper for declaring nodes that sets a context local value generated on init.
1332///
1333/// The method calls the `init_value` closure on init to produce a *value* var that is presented as the [`ContextLocal<T>`]
1334/// in the widget and widget descendants. The closure can be called more than once if the returned node is reinited.
1335///
1336/// Apart from the value initialization this behaves just like [`with_context_local`].
1337///
1338/// [`ContextLocal<T>`]: zng_app_context::ContextLocal
1339pub fn with_context_local_init<T: Any + Send + Sync + 'static>(
1340    child: impl IntoUiNode,
1341    context: &'static ContextLocal<T>,
1342    init_value: impl FnMut() -> T + Send + 'static,
1343) -> UiNode {
1344    with_context_local_init_impl(child.into_node(), context, init_value)
1345}
1346fn with_context_local_init_impl<T: Any + Send + Sync + 'static>(
1347    child: UiNode,
1348    context: &'static ContextLocal<T>,
1349    mut init_value: impl FnMut() -> T + Send + 'static,
1350) -> UiNode {
1351    let mut value = None;
1352
1353    match_node(child, move |child, op| {
1354        let mut is_deinit = false;
1355        match &op {
1356            UiNodeOp::Init => {
1357                value = Some(Arc::new(init_value()));
1358            }
1359            UiNodeOp::Deinit => {
1360                is_deinit = true;
1361            }
1362            _ => {}
1363        }
1364
1365        context.with_context(&mut value, || child.op(op));
1366
1367        if is_deinit {
1368            value = None;
1369        }
1370    })
1371}
1372
1373/// Helper for declaring widgets that are recontextualized to take in some of the context
1374/// of an *original* parent.
1375///
1376/// See [`LocalContext::with_context_blend`] for more details about `over`. The returned
1377/// node will delegate all node operations to inside the blend. The [`WidgetUiNode::with_context`]
1378/// will delegate to the `child` widget context, but the `ctx` is not blended for this method, only
1379/// for [`UiNodeOp`] methods.
1380///
1381/// # Warning
1382///
1383/// Properties, context vars and context locals are implemented with the assumption that all consumers have
1384/// released the context on return, that is even if the context was shared with worker threads all work was block-waited.
1385/// This node breaks this assumption, specially with `over: true` you may cause unexpected behavior if you don't consider
1386/// carefully what context is being captured and what context is being replaced.
1387///
1388/// As a general rule, only capture during init or update in [`NestGroup::CHILD`], only wrap full widgets and only place the wrapped
1389/// widget in a parent's [`NestGroup::CHILD`] for a parent that has no special expectations about the child.
1390///
1391/// As an example of things that can go wrong, if you capture during layout, the `LAYOUT` context is captured
1392/// and replaces `over` the actual layout context during all subsequent layouts in the actual parent.
1393///
1394/// # Panics
1395///
1396/// Panics during init if `ctx` is not from the same app as the init context.
1397///
1398/// [`NestGroup::CHILD`]: zng_app::widget::builder::NestGroup::CHILD
1399/// [`UiNodeOp`]: zng_app::widget::node::UiNodeOp
1400/// [`LocalContext::with_context_blend`]: zng_app_context::LocalContext::with_context_blend
1401pub fn with_context_blend(mut ctx: LocalContext, over: bool, child: impl IntoUiNode) -> UiNode {
1402    match_widget(child, move |c, op| {
1403        if let UiNodeOp::Init = op {
1404            let init_app = LocalContext::current_app();
1405            ctx.with_context_blend(over, || {
1406                let ctx_app = LocalContext::current_app();
1407                assert_eq!(init_app, ctx_app);
1408                c.op(op)
1409            });
1410        } else {
1411            ctx.with_context_blend(over, || c.op(op));
1412        }
1413    })
1414}
1415
1416/// Helper for declaring properties that set the widget state.
1417///
1418/// The state ID is set in [`WIDGET`] on init and is kept updated. On deinit it is set to the `default` value.
1419///
1420/// # Examples
1421///
1422/// ```
1423/// # fn main() -> () { }
1424/// # use zng_app::{widget::{property, node::{UiNode, IntoUiNode}, WIDGET, WidgetUpdateMode}};
1425/// # use zng_var::IntoVar;
1426/// # use zng_wgt::node::with_widget_state;
1427/// # use zng_state_map::{StateId, static_id};
1428/// #
1429/// static_id! {
1430///     pub static ref FOO_ID: StateId<u32>;
1431/// }
1432///
1433/// #[property(CONTEXT)]
1434/// pub fn foo(child: impl IntoUiNode, value: impl IntoVar<u32>) -> UiNode {
1435///     with_widget_state(child, *FOO_ID, || 0, value)
1436/// }
1437///
1438/// // after the property is used and the widget initializes:
1439///
1440/// /// Get the value from outside the widget.
1441/// fn get_foo_outer(widget: &mut UiNode) -> u32 {
1442///     if let Some(mut wgt) = widget.as_widget() {
1443///         wgt.with_context(WidgetUpdateMode::Ignore, || WIDGET.get_state(*FOO_ID))
1444///             .unwrap_or(0)
1445///     } else {
1446///         0
1447///     }
1448/// }
1449///
1450/// /// Get the value from inside the widget.
1451/// fn get_foo_inner() -> u32 {
1452///     WIDGET.get_state(*FOO_ID).unwrap_or_default()
1453/// }
1454/// ```
1455///
1456/// [`WIDGET`]: zng_app::widget::WIDGET
1457pub fn with_widget_state<U, I, T>(child: U, id: impl Into<StateId<T>>, default: I, value: impl IntoVar<T>) -> UiNode
1458where
1459    U: IntoUiNode,
1460    I: Fn() -> T + Send + 'static,
1461    T: StateValue + VarValue,
1462{
1463    with_widget_state_impl(child.into_node(), id.into(), default, value.into_var())
1464}
1465fn with_widget_state_impl<I, T>(child: UiNode, id: impl Into<StateId<T>>, default: I, value: impl IntoVar<T>) -> UiNode
1466where
1467    I: Fn() -> T + Send + 'static,
1468    T: StateValue + VarValue,
1469{
1470    let id = id.into();
1471    let value = value.into_var();
1472
1473    match_node(child, move |child, op| match op {
1474        UiNodeOp::Init => {
1475            child.init();
1476            WIDGET.sub_var(&value);
1477            WIDGET.set_state(id, value.get());
1478        }
1479        UiNodeOp::Deinit => {
1480            child.deinit();
1481            WIDGET.set_state(id, default());
1482        }
1483        UiNodeOp::Update { updates } => {
1484            child.update(updates);
1485            if let Some(v) = value.get_new() {
1486                WIDGET.set_state(id, v);
1487            }
1488        }
1489        _ => {}
1490    })
1491}
1492
1493/// Helper for declaring properties that set the widget state with a custom closure.
1494///
1495/// The `default` closure is used to init the state value, then the `modify` closure is used to modify the state using the variable value.
1496///
1497/// On deinit the `default` value is set on the state again.
1498///
1499/// See [`with_widget_state`] for more details.
1500pub 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
1501where
1502    U: IntoUiNode,
1503    S: StateValue,
1504    V: VarValue,
1505    I: Fn() -> S + Send + 'static,
1506    M: FnMut(&mut S, &V) + Send + 'static,
1507{
1508    with_widget_state_modify_impl(child.into_node(), id.into(), value.into_var(), default, modify)
1509}
1510fn with_widget_state_modify_impl<S, V, I, M>(
1511    child: UiNode,
1512    id: impl Into<StateId<S>>,
1513    value: impl IntoVar<V>,
1514    default: I,
1515    mut modify: M,
1516) -> UiNode
1517where
1518    S: StateValue,
1519    V: VarValue,
1520    I: Fn() -> S + Send + 'static,
1521    M: FnMut(&mut S, &V) + Send + 'static,
1522{
1523    let id = id.into();
1524    let value = value.into_var();
1525
1526    match_node(child, move |child, op| match op {
1527        UiNodeOp::Init => {
1528            child.init();
1529
1530            WIDGET.sub_var(&value);
1531
1532            value.with(|v| {
1533                WIDGET.with_state_mut(|mut s| {
1534                    modify(s.entry(id).or_insert_with(&default), v);
1535                })
1536            })
1537        }
1538        UiNodeOp::Deinit => {
1539            child.deinit();
1540
1541            WIDGET.set_state(id, default());
1542        }
1543        UiNodeOp::Update { updates } => {
1544            child.update(updates);
1545            value.with_new(|v| {
1546                WIDGET.with_state_mut(|mut s| {
1547                    modify(s.req_mut(id), v);
1548                })
1549            });
1550        }
1551        _ => {}
1552    })
1553}
1554
1555/// Create a node that controls interaction for all widgets inside `node`.
1556///
1557/// When the `interactive` var is `false` all descendant widgets are [`BLOCKED`].
1558///
1559/// Unlike the [`interactive`] property this does not apply to the contextual widget, only `child` and descendants.
1560///
1561/// The node works for either if the `child` is a widget or if it only contains widgets, the performance
1562/// is slightly better if the `child` is a widget.
1563///
1564/// [`interactive`]: fn@crate::interactive
1565/// [`BLOCKED`]: Interactivity::BLOCKED
1566pub fn interactive_node(child: impl IntoUiNode, interactive: impl IntoVar<bool>) -> UiNode {
1567    let interactive = interactive.into_var();
1568
1569    match_node(child, move |child, op| match op {
1570        UiNodeOp::Init => {
1571            WIDGET.sub_var_info(&interactive);
1572        }
1573        UiNodeOp::Info { info } => {
1574            if interactive.get() {
1575                child.info(info);
1576            } else if let Some(mut wgt) = child.node().as_widget() {
1577                let id = wgt.id();
1578                // child is a widget.
1579                info.push_interactivity_filter(move |args| {
1580                    if args.info.id() == id {
1581                        Interactivity::BLOCKED
1582                    } else {
1583                        Interactivity::ENABLED
1584                    }
1585                });
1586                child.info(info);
1587            } else {
1588                let block_range = info.with_children_range(|info| child.info(info));
1589                if !block_range.is_empty() {
1590                    // has child widgets.
1591
1592                    let id = WIDGET.id();
1593                    info.push_interactivity_filter(move |args| {
1594                        if let Some(parent) = args.info.parent()
1595                            && parent.id() == id
1596                        {
1597                            // check child range
1598                            for (i, item) in parent.children().enumerate() {
1599                                if item == args.info {
1600                                    return if !block_range.contains(&i) {
1601                                        Interactivity::ENABLED
1602                                    } else {
1603                                        Interactivity::BLOCKED
1604                                    };
1605                                } else if i >= block_range.end {
1606                                    break;
1607                                }
1608                            }
1609                        }
1610                        Interactivity::ENABLED
1611                    });
1612                }
1613            }
1614        }
1615        _ => {}
1616    })
1617}
1618
1619/// Helper for a property that gets the index of the widget in the parent panel.
1620///
1621/// See [`with_index_len_node`] for more details.
1622pub fn with_index_node(
1623    child: impl IntoUiNode,
1624    panel_list_id: impl Into<StateId<PanelListRange>>,
1625    mut update: impl FnMut(Option<usize>) + Send + 'static,
1626) -> UiNode {
1627    let panel_list_id = panel_list_id.into();
1628    let mut version = None;
1629    match_node(child, move |_, op| match op {
1630        UiNodeOp::Deinit => {
1631            update(None);
1632            version = None;
1633        }
1634        UiNodeOp::Update { .. } => {
1635            // parent PanelList requests updates for this widget every time there is an update.
1636            let info = WIDGET.info();
1637            if let Some(parent) = info.parent()
1638                && let Some(mut c) = PanelListRange::update(&parent, panel_list_id, &mut version)
1639            {
1640                let id = info.id();
1641                let p = c.position(|w| w.id() == id);
1642                update(p);
1643            }
1644        }
1645        _ => {}
1646    })
1647}
1648
1649/// Helper for a property that gets the reverse index of the widget in the parent panel.
1650///
1651/// See [`with_index_len_node`] for more details.
1652pub fn with_rev_index_node(
1653    child: impl IntoUiNode,
1654    panel_list_id: impl Into<StateId<PanelListRange>>,
1655    mut update: impl FnMut(Option<usize>) + Send + 'static,
1656) -> UiNode {
1657    let panel_list_id = panel_list_id.into();
1658    let mut version = None;
1659    match_node(child, move |_, op| match op {
1660        UiNodeOp::Deinit => {
1661            update(None);
1662            version = None;
1663        }
1664        UiNodeOp::Update { .. } => {
1665            let info = WIDGET.info();
1666            if let Some(parent) = info.parent()
1667                && let Some(c) = PanelListRange::update(&parent, panel_list_id, &mut version)
1668            {
1669                let id = info.id();
1670                let p = c.rev().position(|w| w.id() == id);
1671                update(p);
1672            }
1673        }
1674        _ => {}
1675    })
1676}
1677
1678/// Helper for a property that gets the index of the widget in the parent panel and the number of children.
1679///  
1680/// Panels must use [`PanelList::track_info_range`] to collect the `panel_list_id`, then implement getter properties
1681/// using the methods in this module. See the `stack!` getter properties for examples.
1682///
1683/// [`PanelList::track_info_range`]: zng_app::widget::node::PanelList::track_info_range
1684pub fn with_index_len_node(
1685    child: impl IntoUiNode,
1686    panel_list_id: impl Into<StateId<PanelListRange>>,
1687    mut update: impl FnMut(Option<(usize, usize)>) + Send + 'static,
1688) -> UiNode {
1689    let panel_list_id = panel_list_id.into();
1690    let mut version = None;
1691    match_node(child, move |_, op| match op {
1692        UiNodeOp::Deinit => {
1693            update(None);
1694            version = None;
1695        }
1696        UiNodeOp::Update { .. } => {
1697            let info = WIDGET.info();
1698            if let Some(parent) = info.parent()
1699                && let Some(mut iter) = PanelListRange::update(&parent, panel_list_id, &mut version)
1700            {
1701                let id = info.id();
1702                let mut p = 0;
1703                let mut count = 0;
1704                for c in &mut iter {
1705                    if c.id() == id {
1706                        p = count;
1707                        count += 1 + iter.count();
1708                        break;
1709                    } else {
1710                        count += 1;
1711                    }
1712                }
1713                update(Some((p, count)));
1714            }
1715        }
1716        _ => {}
1717    })
1718}
1719
1720/// Node that presents `data` using `wgt_fn`.
1721///
1722/// The node's child is always the result of `wgt_fn` called for the `data` value, it is reinited every time
1723/// either variable changes. If the child is an widget the node becomes it.
1724///
1725/// See also [`presenter_opt`] for a presenter that is nil with the data is `None`.
1726///
1727/// See also the [`present`](VarPresent::present) method that can be called on the `data`` variable and [`present_data`](VarPresentData::present_data)
1728/// that can be called on the `wgt_fn` variable.
1729pub fn presenter<D: VarValue>(data: impl IntoVar<D>, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
1730    let data = data.into_var();
1731    let wgt_fn = wgt_fn.into_var();
1732
1733    match_widget(UiNode::nil(), move |c, op| match op {
1734        UiNodeOp::Init => {
1735            WIDGET.sub_var(&data).sub_var(&wgt_fn);
1736            *c.node() = wgt_fn.get()(data.get());
1737        }
1738        UiNodeOp::Deinit => {
1739            c.deinit();
1740            *c.node() = UiNode::nil();
1741        }
1742        UiNodeOp::Update { .. } => {
1743            if data.is_new() || wgt_fn.is_new() {
1744                c.node().deinit();
1745                *c.node() = wgt_fn.get()(data.get());
1746                c.node().init();
1747                c.delegated();
1748                WIDGET.update_info().layout().render();
1749            }
1750        }
1751        _ => {}
1752    })
1753}
1754
1755/// Node that presents `data` using `wgt_fn` if data is available, otherwise presents nil.
1756///
1757/// This behaves like [`presenter`], but `wgt_fn` is not called if `data` is `None`.
1758///
1759/// See also the [`present_opt`](VarPresentOpt::present_opt) method that can be called on the data variable.
1760pub fn presenter_opt<D: VarValue>(data: impl IntoVar<Option<D>>, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
1761    let data = data.into_var();
1762    let wgt_fn = wgt_fn.into_var();
1763
1764    match_widget(UiNode::nil(), move |c, op| match op {
1765        UiNodeOp::Init => {
1766            WIDGET.sub_var(&data).sub_var(&wgt_fn);
1767            if let Some(data) = data.get() {
1768                *c.node() = wgt_fn.get()(data);
1769            }
1770        }
1771        UiNodeOp::Deinit => {
1772            c.deinit();
1773            *c.node() = UiNode::nil();
1774        }
1775        UiNodeOp::Update { .. } => {
1776            if data.is_new() || wgt_fn.is_new() {
1777                if let Some(data) = data.get() {
1778                    c.node().deinit();
1779                    *c.node() = wgt_fn.get()(data);
1780                    c.node().init();
1781                    c.delegated();
1782                    WIDGET.update_info().layout().render();
1783                } else if !c.node().is_nil() {
1784                    c.node().deinit();
1785                    *c.node() = UiNode::nil();
1786                    c.delegated();
1787                    WIDGET.update_info().layout().render();
1788                }
1789            }
1790        }
1791        _ => {}
1792    })
1793}
1794
1795/// Node list that presents `list` using `item_fn` for each new list item.
1796///
1797/// 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.
1798///
1799/// See also the [`present_list`](VarPresentList::present_list) method that can be called on the list variable.
1800pub fn list_presenter<D: VarValue>(list: impl IntoVar<ObservableVec<D>>, item_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
1801    ListPresenter {
1802        list: list.into_var(),
1803        item_fn: item_fn.into_var(),
1804        view: ui_vec![],
1805        _e: std::marker::PhantomData,
1806    }
1807    .into_node()
1808}
1809
1810/// Node list that presents `list` using `item_fn` for each list item.
1811///
1812/// The node's children are **regenerated** for each change in `list`, if possible prefer using [`ObservableVec`] with [`list_presenter`].
1813///
1814/// See also the [`present_list_from_iter`](VarPresentListFromIter::present_list_from_iter) method that can be called on the list variable.
1815pub fn list_presenter_from_iter<D, L>(list: impl IntoVar<L>, item_fn: impl IntoVar<WidgetFn<D>>) -> UiNode
1816where
1817    D: VarValue,
1818    L: IntoIterator<Item = D> + VarValue,
1819{
1820    ListPresenterFromIter {
1821        list: list.into_var(),
1822        item_fn: item_fn.into_var(),
1823        view: ui_vec![],
1824        _e: std::marker::PhantomData,
1825    }
1826    .into_node()
1827}
1828
1829struct ListPresenter<D>
1830where
1831    D: VarValue,
1832{
1833    list: Var<ObservableVec<D>>,
1834    item_fn: Var<WidgetFn<D>>,
1835    view: UiVec,
1836    _e: std::marker::PhantomData<D>,
1837}
1838
1839impl<D> UiNodeImpl for ListPresenter<D>
1840where
1841    D: VarValue,
1842{
1843    fn children_len(&self) -> usize {
1844        self.view.len()
1845    }
1846
1847    fn with_child(&mut self, index: usize, visitor: &mut dyn FnMut(&mut UiNode)) {
1848        self.view.with_child(index, visitor)
1849    }
1850
1851    fn is_list(&self) -> bool {
1852        true
1853    }
1854
1855    fn for_each_child(&mut self, visitor: &mut dyn FnMut(usize, &mut UiNode)) {
1856        self.view.for_each_child(visitor);
1857    }
1858
1859    fn try_for_each_child(
1860        &mut self,
1861        visitor: &mut dyn FnMut(usize, &mut UiNode) -> std::ops::ControlFlow<BoxAnyVarValue>,
1862    ) -> std::ops::ControlFlow<BoxAnyVarValue> {
1863        self.view.try_for_each_child(visitor)
1864    }
1865
1866    fn par_each_child(&mut self, visitor: &(dyn Fn(usize, &mut UiNode) + Sync)) {
1867        self.view.par_each_child(visitor);
1868    }
1869
1870    fn par_fold_reduce(
1871        &mut self,
1872        identity: BoxAnyVarValue,
1873        fold: &(dyn Fn(BoxAnyVarValue, usize, &mut UiNode) -> BoxAnyVarValue + Sync),
1874        reduce: &(dyn Fn(BoxAnyVarValue, BoxAnyVarValue) -> BoxAnyVarValue + Sync),
1875    ) -> BoxAnyVarValue {
1876        self.view.par_fold_reduce(identity, fold, reduce)
1877    }
1878
1879    fn init(&mut self) {
1880        debug_assert!(self.view.is_empty());
1881        self.view.clear();
1882
1883        WIDGET.sub_var(&self.list).sub_var(&self.item_fn);
1884
1885        let e_fn = self.item_fn.get();
1886        self.list.with(|l| {
1887            for el in l.iter() {
1888                let child = e_fn(el.clone());
1889                self.view.push(child);
1890            }
1891        });
1892
1893        self.view.init();
1894    }
1895
1896    fn deinit(&mut self) {
1897        self.view.deinit();
1898        self.view.clear();
1899    }
1900
1901    fn update(&mut self, updates: &WidgetUpdates) {
1902        self.update_list(updates, &mut ());
1903    }
1904
1905    fn update_list(&mut self, updates: &WidgetUpdates, observer: &mut dyn UiNodeListObserver) {
1906        let mut need_reset = self.item_fn.is_new();
1907
1908        let is_new = self
1909            .list
1910            .with_new(|l| {
1911                need_reset |= l.changes().is_empty() || l.changes() == [VecChange::Clear];
1912
1913                if need_reset {
1914                    return;
1915                }
1916
1917                // update before new items to avoid update before init.
1918                self.view.update_list(updates, observer);
1919
1920                let e_fn = self.item_fn.get();
1921
1922                for change in l.changes() {
1923                    match change {
1924                        VecChange::Insert { index, count } => {
1925                            for i in *index..(*index + count) {
1926                                let mut el = e_fn(l[i].clone());
1927                                el.init();
1928                                self.view.insert(i, el);
1929                                observer.inserted(i);
1930                            }
1931                        }
1932                        VecChange::Remove { index, count } => {
1933                            let mut count = *count;
1934                            let index = *index;
1935                            while count > 0 {
1936                                count -= 1;
1937
1938                                let mut el = self.view.remove(index);
1939                                el.deinit();
1940                                observer.removed(index);
1941                            }
1942                        }
1943                        VecChange::Move { from_index, to_index } => {
1944                            let el = self.view.remove(*from_index);
1945                            self.view.insert(*to_index, el);
1946                            observer.moved(*from_index, *to_index);
1947                        }
1948                        VecChange::Clear => unreachable!(),
1949                    }
1950                }
1951            })
1952            .is_some();
1953
1954        if !need_reset && !is_new && self.list.with(|l| l.len() != self.view.len()) {
1955            need_reset = true;
1956        }
1957
1958        if need_reset {
1959            self.view.deinit();
1960            self.view.clear();
1961
1962            let e_fn = self.item_fn.get();
1963            self.list.with(|l| {
1964                for el in l.iter() {
1965                    let child = e_fn(el.clone());
1966                    self.view.push(child);
1967                }
1968            });
1969
1970            self.view.init();
1971        } else if !is_new {
1972            self.view.update_list(updates, observer);
1973        }
1974    }
1975
1976    fn info(&mut self, info: &mut zng_app::widget::info::WidgetInfoBuilder) {
1977        self.view.info(info);
1978    }
1979
1980    fn measure(&mut self, wm: &mut zng_app::widget::info::WidgetMeasure) -> PxSize {
1981        self.view.measure(wm)
1982    }
1983
1984    fn measure_list(
1985        &mut self,
1986        wm: &mut zng_app::widget::info::WidgetMeasure,
1987        measure: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetMeasure) -> PxSize + Sync),
1988        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
1989    ) -> PxSize {
1990        self.view.measure_list(wm, measure, fold_size)
1991    }
1992
1993    fn layout(&mut self, wl: &mut zng_app::widget::info::WidgetLayout) -> PxSize {
1994        self.view.layout(wl)
1995    }
1996
1997    fn layout_list(
1998        &mut self,
1999        wl: &mut zng_app::widget::info::WidgetLayout,
2000        layout: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetLayout) -> PxSize + Sync),
2001        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
2002    ) -> PxSize {
2003        self.view.layout_list(wl, layout, fold_size)
2004    }
2005
2006    fn render(&mut self, frame: &mut FrameBuilder) {
2007        self.view.render(frame);
2008    }
2009
2010    fn render_list(&mut self, frame: &mut FrameBuilder, render: &(dyn Fn(usize, &mut UiNode, &mut FrameBuilder) + Sync)) {
2011        self.view.render_list(frame, render);
2012    }
2013
2014    fn render_update(&mut self, update: &mut zng_app::render::FrameUpdate) {
2015        self.view.render_update(update);
2016    }
2017
2018    fn render_update_list(
2019        &mut self,
2020        update: &mut zng_app::render::FrameUpdate,
2021        render_update: &(dyn Fn(usize, &mut UiNode, &mut zng_app::render::FrameUpdate) + Sync),
2022    ) {
2023        self.view.render_update_list(update, render_update);
2024    }
2025
2026    fn as_widget(&mut self) -> Option<&mut dyn WidgetUiNodeImpl> {
2027        None
2028    }
2029}
2030
2031struct ListPresenterFromIter<D, L>
2032where
2033    D: VarValue,
2034    L: IntoIterator<Item = D> + VarValue,
2035{
2036    list: Var<L>,
2037    item_fn: Var<WidgetFn<D>>,
2038    view: UiVec,
2039    _e: std::marker::PhantomData<(D, L)>,
2040}
2041
2042impl<D, L> UiNodeImpl for ListPresenterFromIter<D, L>
2043where
2044    D: VarValue,
2045    L: IntoIterator<Item = D> + VarValue,
2046{
2047    fn children_len(&self) -> usize {
2048        self.view.len()
2049    }
2050
2051    fn with_child(&mut self, index: usize, visitor: &mut dyn FnMut(&mut UiNode)) {
2052        self.view.with_child(index, visitor)
2053    }
2054
2055    fn for_each_child(&mut self, visitor: &mut dyn FnMut(usize, &mut UiNode)) {
2056        self.view.for_each_child(visitor)
2057    }
2058
2059    fn try_for_each_child(
2060        &mut self,
2061        visitor: &mut dyn FnMut(usize, &mut UiNode) -> std::ops::ControlFlow<BoxAnyVarValue>,
2062    ) -> std::ops::ControlFlow<BoxAnyVarValue> {
2063        self.view.try_for_each_child(visitor)
2064    }
2065
2066    fn par_each_child(&mut self, visitor: &(dyn Fn(usize, &mut UiNode) + Sync)) {
2067        self.view.par_each_child(visitor);
2068    }
2069
2070    fn par_fold_reduce(
2071        &mut self,
2072        identity: BoxAnyVarValue,
2073        fold: &(dyn Fn(BoxAnyVarValue, usize, &mut UiNode) -> BoxAnyVarValue + Sync),
2074        reduce: &(dyn Fn(BoxAnyVarValue, BoxAnyVarValue) -> BoxAnyVarValue + Sync),
2075    ) -> BoxAnyVarValue {
2076        self.view.par_fold_reduce(identity, fold, reduce)
2077    }
2078
2079    fn is_list(&self) -> bool {
2080        true
2081    }
2082
2083    fn init(&mut self) {
2084        debug_assert!(self.view.is_empty());
2085        self.view.clear();
2086
2087        WIDGET.sub_var(&self.list).sub_var(&self.item_fn);
2088
2089        let e_fn = self.item_fn.get();
2090
2091        self.view.extend(self.list.get().into_iter().map(&*e_fn));
2092        self.view.init();
2093    }
2094
2095    fn deinit(&mut self) {
2096        self.view.deinit();
2097        self.view.clear();
2098    }
2099
2100    fn update(&mut self, updates: &WidgetUpdates) {
2101        self.update_list(updates, &mut ())
2102    }
2103    fn update_list(&mut self, updates: &WidgetUpdates, observer: &mut dyn UiNodeListObserver) {
2104        if self.list.is_new() || self.item_fn.is_new() {
2105            self.view.deinit();
2106            self.view.clear();
2107            let e_fn = self.item_fn.get();
2108            self.view.extend(self.list.get().into_iter().map(&*e_fn));
2109            self.view.init();
2110            observer.reset();
2111        } else {
2112            self.view.update_list(updates, observer);
2113        }
2114    }
2115
2116    fn info(&mut self, info: &mut zng_app::widget::info::WidgetInfoBuilder) {
2117        self.view.info(info)
2118    }
2119
2120    fn measure(&mut self, wm: &mut zng_app::widget::info::WidgetMeasure) -> PxSize {
2121        self.view.measure(wm)
2122    }
2123
2124    fn measure_list(
2125        &mut self,
2126        wm: &mut zng_app::widget::info::WidgetMeasure,
2127        measure: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetMeasure) -> PxSize + Sync),
2128        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
2129    ) -> PxSize {
2130        self.view.measure_list(wm, measure, fold_size)
2131    }
2132
2133    fn layout(&mut self, wl: &mut zng_app::widget::info::WidgetLayout) -> PxSize {
2134        self.view.layout(wl)
2135    }
2136
2137    fn layout_list(
2138        &mut self,
2139        wl: &mut zng_app::widget::info::WidgetLayout,
2140        layout: &(dyn Fn(usize, &mut UiNode, &mut zng_app::widget::info::WidgetLayout) -> PxSize + Sync),
2141        fold_size: &(dyn Fn(PxSize, PxSize) -> PxSize + Sync),
2142    ) -> PxSize {
2143        self.view.layout_list(wl, layout, fold_size)
2144    }
2145
2146    fn render(&mut self, frame: &mut FrameBuilder) {
2147        self.view.render(frame);
2148    }
2149
2150    fn render_list(&mut self, frame: &mut FrameBuilder, render: &(dyn Fn(usize, &mut UiNode, &mut FrameBuilder) + Sync)) {
2151        self.view.render_list(frame, render);
2152    }
2153
2154    fn render_update(&mut self, update: &mut zng_app::render::FrameUpdate) {
2155        self.view.render_update(update);
2156    }
2157
2158    fn render_update_list(
2159        &mut self,
2160        update: &mut zng_app::render::FrameUpdate,
2161        render_update: &(dyn Fn(usize, &mut UiNode, &mut zng_app::render::FrameUpdate) + Sync),
2162    ) {
2163        self.view.render_update_list(update, render_update);
2164    }
2165
2166    fn as_widget(&mut self) -> Option<&mut dyn WidgetUiNodeImpl> {
2167        None
2168    }
2169}
2170
2171/// Extension method to *convert* a variable to a node.
2172pub trait VarPresent<D: VarValue> {
2173    /// Present the variable data using a [`presenter`] node.
2174    fn present(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2175}
2176impl<D: VarValue> VarPresent<D> for Var<D> {
2177    fn present(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2178        presenter(self.clone(), wgt_fn)
2179    }
2180}
2181
2182/// Extension method to *convert* a variable to a node.
2183pub trait VarPresentOpt<D: VarValue> {
2184    /// Present the variable data using a [`presenter_opt`] node.
2185    fn present_opt(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2186}
2187impl<D: VarValue> VarPresentOpt<D> for Var<Option<D>> {
2188    fn present_opt(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2189        presenter_opt(self.clone(), wgt_fn)
2190    }
2191}
2192
2193/// Extension method fo *convert* a variable to a node list.
2194pub trait VarPresentList<D: VarValue> {
2195    /// Present the variable data using a [`list_presenter`] node list.
2196    fn present_list(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2197}
2198impl<D: VarValue> VarPresentList<D> for Var<ObservableVec<D>> {
2199    fn present_list(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2200        list_presenter(self.clone(), wgt_fn)
2201    }
2202}
2203
2204/// Extension method fo *convert* a variable to a node list.
2205pub trait VarPresentListFromIter<D: VarValue, L: IntoIterator<Item = D> + VarValue> {
2206    /// Present the variable data using a [`list_presenter_from_iter`] node list.
2207    fn present_list_from_iter(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode;
2208}
2209impl<D: VarValue, L: IntoIterator<Item = D> + VarValue> VarPresentListFromIter<D, L> for Var<L> {
2210    fn present_list_from_iter(&self, wgt_fn: impl IntoVar<WidgetFn<D>>) -> UiNode {
2211        list_presenter_from_iter(self.clone(), wgt_fn)
2212    }
2213}
2214
2215/// Extension method to *convert* a variable to a node.
2216pub trait VarPresentData<D: VarValue> {
2217    /// Present the `data` variable using a [`presenter`] node.
2218    fn present_data(&self, data: impl IntoVar<D>) -> UiNode;
2219}
2220impl<D: VarValue> VarPresentData<D> for Var<WidgetFn<D>> {
2221    fn present_data(&self, data: impl IntoVar<D>) -> UiNode {
2222        presenter(data, self.clone())
2223    }
2224}