r3bl_tui 0.3.6

TUI library inspired by Redux, Redux, Flexbox, CSS, editor components, etc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99

/*
 *   Copyright (c) 2022 R3BL LLC
 *   All rights reserved.
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */

/// Render the component in the current box (which is retrieved from the surface). This is the
/// "normal" way to render a component, in the FlexBox that is currently being laid out.
#[macro_export]
macro_rules! render_component_in_current_box {
    (
        in:           $arg_surface          : expr, // Eg: in: surface
        component_id: $arg_component_id     : expr, // Eg: "component1"
        from:         $arg_registry         : expr, // Eg: from: registry
        state:        $arg_state            : expr, // Eg: state
        shared_store: $arg_shared_store     : expr, // Eg: shared_store
        shared_global_data: $arg_shared_global_data : expr, // Eg: shared_global_data
        window_size:  $arg_window_size      : expr  // Eg: window_size
      ) => {
        let maybe_component_ref = ComponentRegistry::get_component_ref_by_id(
            &mut $arg_registry,
            $arg_component_id,
        );

        if let Some(component_ref) = maybe_component_ref {
            let surface_bounds = SurfaceBounds::from(&*($arg_surface));
            let current_box = $arg_surface.current_box()?;
            let queue = component_ref
                .write()
                .await
                .render(
                    ComponentScopeArgs {
                        shared_global_data: $arg_shared_global_data,
                        shared_store: $arg_shared_store,
                        state: $arg_state,
                        component_registry: &mut $arg_registry,
                        window_size: $arg_window_size,
                    },
                    current_box,
                    surface_bounds,
                )
                .await?;
            $arg_surface.render_pipeline += queue;
        }
    };
}

/// Render the component in the given box (which is not retrieved from the surface). This is usually
/// to do "absolute positioned" rendering of components (like for a modal dialog box that paints on
/// top of everything else in the window).
#[macro_export]
macro_rules! render_component_in_given_box {
    (
        in:           $arg_surface          : expr, // Eg: in: surface
        box:          $arg_box              : expr, // Eg: box: FlexBox::default()
        component_id: $arg_component_id     : expr, // Eg: "component1"
        from:         $arg_registry         : expr, // Eg: from: registry
        state:        $arg_state            : expr, // Eg: state
        shared_store: $arg_shared_store     : expr, // Eg: shared_store
        shared_global_data: $arg_shared_global_data : expr, // Eg: shared_global_data
        window_size:  $arg_window_size      : expr  // Eg: window_size
     ) => {{
        let maybe_component_ref = ComponentRegistry::get_component_ref_by_id(
            &mut $arg_registry,
            $arg_component_id,
        );

        if let Some(component_ref) = maybe_component_ref {
            let surface_bounds = SurfaceBounds::from(&*($arg_surface));
            let queue: RenderPipeline = component_ref
                .write()
                .await
                .render(
                    ComponentScopeArgs {
                        shared_global_data: $arg_shared_global_data,
                        shared_store: $arg_shared_store,
                        state: $arg_state,
                        component_registry: &mut $arg_registry,
                        window_size: $arg_window_size,
                    },
                    &$arg_box,
                    surface_bounds,
                )
                .await?;
            $arg_surface.render_pipeline += queue;
        }
    }};
}