rumtk_web/components/form/
mod.rs

1/*
2 * rumtk attempts to implement HL7 and medical protocols for interoperability in medicine.
3 * This toolkit aims to be reliable, simple, performant, and standards compliant.
4 * Copyright (C) 2025  Luis M. Santos, M.D. <lsantos@medicalmasses.com>
5 * Copyright (C) 2025  Ethan Dixon
6 * Copyright (C) 2025  MedicalMasses L.L.C. <contact@medicalmasses.com>
7 *
8 * This program is free software: you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation, either version 3 of the License, or
11 * (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
20 */
21use crate::components::form::form_element::form_element;
22use crate::components::form::props::InputProps;
23use crate::rumtk_web_render_component;
24use crate::utils::HTMLResult;
25use rumtk_core::cache::{new_cache, LazyRUMCache};
26use rumtk_core::core::RUMResult;
27use rumtk_core::strings::RUMString;
28use rumtk_core::{rumtk_cache_fetch, rumtk_cache_push};
29
30pub mod form;
31pub mod form_element;
32pub mod props;
33
34pub type FormElements = Vec<RUMString>;
35pub type FormCache = LazyRUMCache<RUMString, FormElements>;
36pub type FormElementBuilder =
37    fn(element: &str, data: &str, props: InputProps, css: &str) -> RUMString;
38pub type FormBuilderFunction = fn(builder: FormElementBuilder) -> FormElements;
39pub type FormItem<'a> = (&'a str, FormBuilderFunction);
40pub type Forms<'a> = Vec<FormItem<'a>>;
41pub type FormCacheItem = FormElements;
42
43static mut FORM_CACHE: FormCache = new_cache();
44static DEFAULT_FORMELEMENTS: FormElements = vec![];
45
46fn new_form_entry() -> RUMResult<FormElements> {
47    Ok(DEFAULT_FORMELEMENTS.clone())
48}
49
50fn build_form_element(element: &str, data: &str, props: InputProps, css: &str) -> RUMString {
51    rumtk_web_render_component!(|| -> HTMLResult { form_element(element, data, props, css) })
52}
53
54pub fn register_form_elements(name: &str, element_builder: &FormBuilderFunction) {
55    let key = RUMString::from(name);
56    let _ = rumtk_cache_fetch!(&raw mut FORM_CACHE, &key, new_form_entry);
57    let data = element_builder(build_form_element);
58    rumtk_cache_push!(&raw mut FORM_CACHE, &key, data);
59}
60
61pub fn register_forms(forms: Option<Forms>) {
62    for (form_name, form_builder) in forms.unwrap_or_default() {
63        register_form_elements(form_name, &form_builder);
64    }
65}
66
67pub fn get_form(name: &str) -> RUMResult<FormCacheItem> {
68    rumtk_cache_fetch!(&raw mut FORM_CACHE, &RUMString::from(name), new_form_entry)
69}
70
71///
72/// This is an API macro for defining a form that can be used to render it later in your web pages.
73///
74#[macro_export]
75macro_rules! rumtk_web_init_forms {
76    ( $forms:expr ) => {{
77        use $crate::components::form::register_forms;
78
79        register_forms($forms);
80    }};
81}
82
83///
84/// This is an API macro to get the list of rendered elements that will be fed into the form shell
85/// to render your form in your web page.
86///
87#[macro_export]
88macro_rules! rumtk_web_get_form {
89    ( $name:expr ) => {{
90        use $crate::components::form::get_form;
91
92        get_form($name)
93    }};
94}
rumtk_web/components/form/mod.rs

rumtk_web/components/form/
mod.rs
