telar 0.2.1

A modular Rust UI framework with its own template language, reactive signals and a self-contained renderer.
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

//! Which frontend an app runs on.
//!
//! The three predicates below are spelled out at every use rather than named once, because a `cfg` attribute takes no macro: `all(feature = "desktop-bare", not(target_os = "android"), not(target_arch = "wasm32"))` is a window, `all(feature = "web-dom", target_arch = "wasm32")` is a page, and `feature = "tui"` is a terminal.

use crate::app::App;
use crate::app_config::AppConfig;

/// Runs `app` on the frontend this build has.
///
/// Which one that is is a *build* decision: a binary compiled with `desktop` opens a window, a `wasm32` one compiled with `web` mounts on a page, one compiled with only `tui` runs in the terminal it was launched from. Both a window and a terminal being compiled in is the case a dev session wants — switching frontend without a rebuild — and there `TELAR_TARGET=tui` picks the terminal, with the window remaining the default.
///
/// This is what [`telar::app!`](telar_macros::app)'s generated `run()` calls, so a `.rsx` app reaches every frontend from one entry point and one source tree.
pub fn run_app_with_name<A: App>(config: AppConfig, app: A, app_name: &str) {
    run_app_with_devtools::<A, crate::DefaultDevTools>(config, app, app_name)
}

/// The same, with a devtools overlay of your own drawn over the application.
///
/// The seam is [`DevPlugin`](crate::DevPlugin), and it was reachable only by building a platform by hand: the frame loop has always been generic over the overlay, but every entry point that opens a window for you named the built-in one. This is that entry point with the choice left open.
///
/// Only a window has an overlay. A terminal run ignores `D`, because the frame it composes is a grid of cells with nothing to draw chrome on.
pub fn run_app_with_devtools<A: App, D: crate::DevPlugin>(
    config: AppConfig,
    app: A,
    app_name: &str,
) {
    #[cfg(feature = "tui")]
    if tui_selected() {
        super::run_tui_app_with_name(config, super::TuiOptions::default(), app, app_name);
        return;
    }
    run_default_frontend::<A, D>(config, app, app_name)
}

/// Whether this run should go to the terminal: because it is the only frontend compiled in, or because it was asked for.
#[cfg(feature = "tui")]
fn tui_selected() -> bool {
    let has_window = cfg!(all(
        feature = "desktop-bare",
        not(target_os = "android"),
        not(target_arch = "wasm32")
    ));
    let has_page = cfg!(all(feature = "web-dom", target_arch = "wasm32"));
    if !has_window && !has_page {
        return true;
    }
    std::env::var("TELAR_TARGET").is_ok_and(|target| target.eq_ignore_ascii_case("tui"))
}

#[cfg(all(
    feature = "desktop-bare",
    not(target_os = "android"),
    not(target_arch = "wasm32")
))]
fn run_default_frontend<A: App, D: crate::DevPlugin>(config: AppConfig, app: A, app_name: &str) {
    super::desktop::run_desktop_app_with_devtools::<A, D>(config, app, app_name)
}

#[cfg(all(
    feature = "web-dom",
    target_arch = "wasm32",
    not(all(
        feature = "desktop-bare",
        not(target_os = "android"),
        not(target_arch = "wasm32")
    ))
))]
fn run_default_frontend<A: App, D: crate::DevPlugin>(config: AppConfig, app: A, app_name: &str) {
    super::run_web_app_with_name(config, super::WebOptions::default(), app, app_name)
}

#[cfg(not(any(
    all(
        feature = "desktop-bare",
        not(target_os = "android"),
        not(target_arch = "wasm32")
    ),
    all(feature = "web-dom", target_arch = "wasm32")
)))]
fn run_default_frontend<A: App, D: crate::DevPlugin>(_config: AppConfig, _app: A, _app_name: &str) {
    // Reachable only from a build with no frontend at all: a `tui`-only build never gets here, because `tui_selected` answers `true` when nothing else is compiled in.
    panic!(
        "this build of telar has no frontend to run on — enable `desktop` for a window, `web` for a page, \
         or `tui` for the terminal"
    );
}