Skip to main content

ps_blitz/
lib.rs

1#![cfg_attr(docsrs, feature(doc_cfg))]
2
3//! Blitz is a modular, embeddable web engine with a native Rust API.
4//!
5//! It powers the [`dioxus-native`] UI framework.
6//!
7//! This crate exists to collect the most important functionality for users together in one place.
8//! It does not bring any unique functionality, but rather, it re-exports the relevant crates as modules.
9//! The exported crate corresponding to each module is also available in a stand-alone manner, i.e. [`blitz-dom`] as [`blitz::dom`](crate::dom).
10//!
11//! [`dioxus-native`]: https://docs.rs/dioxus-native
12//! [`blitz-dom`]: https://docs.rs/blitz-dom
13
14use std::sync::Arc;
15
16use anyrender_vello::VelloWindowRenderer as WindowRenderer;
17use blitz_dom::DocumentConfig;
18use blitz_html::HtmlDocument;
19use blitz_shell::{
20    BlitzApplication, BlitzShellProxy, Config, EventLoop, WindowConfig, create_default_event_loop,
21};
22use blitz_traits::net::NetProvider;
23
24#[doc(inline)]
25/// Re-export of [`blitz_dom`].
26pub use blitz_dom as dom;
27#[doc(inline)]
28/// Re-export of [`blitz_html`]. HTML parsing on top of blitz-dom
29pub use blitz_html as html;
30#[cfg(feature = "net")]
31#[doc(inline)]
32/// Re-export of [`blitz_net`].
33pub use blitz_net as net;
34#[doc(inline)]
35/// Re-export of [`blitz_paint`].
36pub use blitz_paint as paint;
37#[doc(inline)]
38/// Re-export of [`blitz_shell`].
39pub use blitz_shell as shell;
40#[doc(inline)]
41/// Re-export of [`blitz_traits`](https://docs.rs/blitz-traits). Base types and traits for interoperability between modules
42pub use blitz_traits as traits;
43
44#[cfg(feature = "net")]
45#[cfg(not(target_arch = "wasm32"))]
46pub fn launch_url(url: &str) {
47    // Assert that url is valid
48    #[cfg(feature = "tracing")]
49    tracing::info!("Launching {url}");
50    let url = url.to_owned();
51    let url = url::Url::parse(&url).expect("Invalid url");
52
53    // Turn on the runtime and enter it
54    let rt = tokio::runtime::Builder::new_multi_thread()
55        .enable_all()
56        .build()
57        .unwrap();
58    let _guard = rt.enter();
59
60    let event_loop = create_default_event_loop();
61    let (proxy, reciever) = BlitzShellProxy::new(event_loop.create_proxy());
62    let net_provider = create_net_provider(proxy.clone());
63    let application = BlitzApplication::new(proxy, reciever);
64
65    let (url, bytes) = rt
66        .block_on(net_provider.fetch_async(blitz_traits::net::Request::get(url)))
67        .unwrap();
68    let html = std::str::from_utf8(bytes.as_ref()).unwrap();
69
70    launch_internal(
71        html,
72        Config {
73            stylesheets: Vec::new(),
74            base_url: Some(url),
75        },
76        event_loop,
77        application,
78        net_provider,
79    )
80}
81
82pub fn launch_static_html(html: &str) {
83    launch_static_html_cfg(html, Config::default())
84}
85
86pub fn launch_static_html_cfg(html: &str, cfg: Config) {
87    // Turn on the runtime and enter it
88    #[cfg(feature = "net")]
89    #[cfg(not(target_arch = "wasm32"))]
90    let rt = tokio::runtime::Builder::new_multi_thread()
91        .enable_all()
92        .build()
93        .unwrap();
94    #[cfg(feature = "net")]
95    #[cfg(not(target_arch = "wasm32"))]
96    let _guard = rt.enter();
97
98    let event_loop = create_default_event_loop();
99    let (proxy, reciever) = BlitzShellProxy::new(event_loop.create_proxy());
100    let net_provider = create_net_provider(proxy.clone());
101    let application = BlitzApplication::new(proxy, reciever);
102
103    launch_internal(html, cfg, event_loop, application, net_provider)
104}
105
106fn launch_internal(
107    html: &str,
108    cfg: Config,
109    event_loop: EventLoop,
110    mut application: BlitzApplication<WindowRenderer>,
111    net_provider: Arc<dyn NetProvider>,
112) {
113    let doc = HtmlDocument::from_html(
114        html,
115        DocumentConfig {
116            base_url: cfg.base_url,
117            ua_stylesheets: Some(cfg.stylesheets),
118            net_provider: Some(net_provider),
119            ..Default::default()
120        },
121    );
122    let renderer = WindowRenderer::new();
123    let window = WindowConfig::new(Box::new(doc) as _, renderer);
124
125    // Create application
126
127    application.add_window(window);
128
129    // Run event loop
130    event_loop.run_app(application).unwrap()
131}
132
133#[cfg(feature = "net")]
134type EnabledNetProvider = blitz_net::Provider;
135#[cfg(not(feature = "net"))]
136type EnabledNetProvider = blitz_traits::net::DummyNetProvider;
137
138fn create_net_provider(proxy: BlitzShellProxy) -> Arc<EnabledNetProvider> {
139    #[cfg(feature = "net")]
140    let net_provider = Arc::new(blitz_net::Provider::new(Some(Arc::new(proxy))));
141    #[cfg(not(feature = "net"))]
142    let net_provider = {
143        use blitz_traits::net::DummyNetProvider;
144
145        // This isn't used without the net feature, so ignore it here to not
146        // get unnused warnings.
147        let _ = event_loop;
148        Arc::new(DummyNetProvider::default())
149    };
150
151    net_provider
152}