Introduce DocumentConfig struct

Signed-off-by: Nico Burns <[email protected]>

Author: nicoburns

apps/readme/src/main.rs

@@ -20,6 +20,7 @@ use anyrender_vello::VelloWindowRenderer as WindowRenderer;
 #[cfg(feature = "cpu")]
 use anyrender_vello_cpu::VelloCpuWindowRenderer as WindowRenderer;
 
+use blitz_dom::DocumentConfig;
 use blitz_dom::net::Resource;
 use blitz_html::HtmlDocument;
 use blitz_net::Provider;
@@ -100,11 +101,13 @@ fn main() {
 
     let doc = HtmlDocument::from_html(
         &html,
-        Some(base_url),
-        stylesheets,
-        net_provider.clone(),
-        None,
-        navigation_provider.clone(),
+        DocumentConfig {
+            base_url: Some(base_url),
+            ua_stylesheets: Some(stylesheets),
+            net_provider: Some(net_provider.clone()),
+            navigation_provider: Some(navigation_provider.clone()),
+            ..Default::default()
+        },
     );
     let renderer = WindowRenderer::new();
     let attrs = WindowAttributes::default().with_title(title);

apps/readme/src/readme_application.rs

@@ -1,6 +1,7 @@
 use std::sync::Arc;
 
 use crate::WindowRenderer;
+use blitz_dom::DocumentConfig;
 use blitz_dom::net::Resource;
 use blitz_html::HtmlDocument;
 use blitz_net::Provider;
@@ -110,11 +111,13 @@ impl ReadmeApplication {
 
         let doc = HtmlDocument::from_html(
             &html,
-            Some(url),
-            stylesheets,
-            self.net_provider.clone(),
-            None,
-            self.navigation_provider.clone(),
+            DocumentConfig {
+                base_url: Some(url),
+                ua_stylesheets: Some(stylesheets),
+                net_provider: Some(self.net_provider.clone()),
+                navigation_provider: Some(self.navigation_provider.clone()),
+                ..Default::default()
+            },
         );
         self.window_mut()
             .replace_document(Box::new(doc) as _, retain_scroll_position);

examples/wgpu_texture/src/html.rs

@@ -1,10 +1,7 @@
-use std::sync::Arc;
-
 use anyrender_vello::VelloWindowRenderer;
-use blitz_dom::{local_name, ns, QualName};
+use blitz_dom::{local_name, ns, DocumentConfig, QualName};
 use blitz_html::HtmlDocument;
 use blitz_shell::{create_default_event_loop, BlitzApplication, BlitzShellEvent, WindowConfig};
-use blitz_traits::{navigation::DummyNavigationProvider, net::DummyNetProvider};
 
 use crate::{limits, DemoPaintSource, FEATURES, STYLES};
 
@@ -19,14 +16,7 @@ pub fn launch_html() {
 
     // Parse the HTML into a Blitz document
     let html = HTML.replace("{{STYLES_PLACEHOLDER}}", STYLES);
-    let mut doc = HtmlDocument::from_html(
-        &html,
-        None,
-        Vec::new(),
-        Arc::new(DummyNetProvider),
-        None,
-        Arc::new(DummyNavigationProvider),
-    );
+    let mut doc = HtmlDocument::from_html(&html, DocumentConfig::default());
 
     // Set the "src" attribute on the `<canvas>` element to the paint source's id
     // (`<canvas src=".." />` is proprietary blitz extension to HTML)

packages/blitz-dom/src/config.rs

@@ -0,0 +1,27 @@
+use crate::net::Resource;
+use blitz_traits::{
+    navigation::NavigationProvider,
+    net::NetProvider,
+    shell::{ShellProvider, Viewport},
+};
+use parley::FontContext;
+use std::sync::Arc;
+
+/// Options used when constructing a [`BaseDocument`](crate::BaseDocument)
+#[derive(Default)]
+pub struct DocumentConfig {
+    /// The initial `Viewport`
+    pub viewport: Option<Viewport>,
+    /// The base url which relative URLs are resolved against
+    pub base_url: Option<String>,
+    /// User Agent stylesheets
+    pub ua_stylesheets: Option<Vec<String>>,
+    /// Net provider to handle network requests for resources
+    pub net_provider: Option<Arc<dyn NetProvider<Resource>>>,
+    /// Navigation provider to handle link clicks and form submissions
+    pub navigation_provider: Option<Arc<dyn NavigationProvider>>,
+    /// Shell provider to redraw requests, clipboard, etc
+    pub shell_provider: Option<Arc<dyn ShellProvider>>,
+    /// Parley `FontContext`
+    pub font_ctx: Option<FontContext>,
+}

packages/blitz-dom/src/document.rs

@@ -6,7 +6,9 @@ use crate::node::{ImageData, NodeFlags, RasterImageData, SpecialElementData, Sta
 use crate::stylo_to_cursor_icon::stylo_to_cursor_icon;
 use crate::traversal::TreeTraverser;
 use crate::util::{ImageType, resolve_url};
-use crate::{DocumentMutator, ElementData, Node, NodeData, TextNodeData};
+use crate::{
+    DEFAULT_CSS, DocumentConfig, DocumentMutator, ElementData, Node, NodeData, TextNodeData,
+};
 use app_units::Au;
 use blitz_traits::devtools::DevtoolSettings;
 use blitz_traits::events::{DomEvent, HitResult, UiEvent};
@@ -187,14 +189,11 @@ impl BaseDocument {
 }
 
 impl BaseDocument {
-    pub fn new(viewport: Viewport) -> Self {
-        Self::with_font_ctx(viewport, parley::FontContext::default())
-    }
-
-    pub fn with_font_ctx(viewport: Viewport, mut font_ctx: FontContext) -> Self {
+    pub fn new(config: DocumentConfig) -> Self {
         static ID_GENERATOR: AtomicUsize = AtomicUsize::new(1);
 
         let id = ID_GENERATOR.fetch_add(1, Ordering::SeqCst);
+        let viewport = config.viewport.unwrap_or_default();
         let device = make_device(&viewport);
         let stylist = Stylist::new(device, QuirksMode::NoQuirks);
         let snapshots = SnapshotMap::new();
@@ -209,9 +208,23 @@ impl BaseDocument {
         style_config::set_bool("layout.unimplemented", true);
         style_config::set_bool("layout.columns.enabled", true);
 
-        font_ctx
-            .collection
-            .register_fonts(Blob::new(Arc::new(crate::BULLET_FONT) as _), None);
+        let font_ctx = config.font_ctx.unwrap_or_else(|| {
+            let mut font_ctx = FontContext::default();
+            font_ctx
+                .collection
+                .register_fonts(Blob::new(Arc::new(crate::BULLET_FONT) as _), None);
+            font_ctx
+        });
+
+        let net_provider = config
+            .net_provider
+            .unwrap_or_else(|| Arc::new(DummyNetProvider));
+        let navigation_provider = config
+            .navigation_provider
+            .unwrap_or_else(|| Arc::new(DummyNavigationProvider));
+        let shell_provider = config
+            .shell_provider
+            .unwrap_or_else(|| Arc::new(DummyShellProvider));
 
         let mut doc = Self {
             id,
@@ -236,15 +249,24 @@ impl BaseDocument {
             is_animating: false,
             changed_nodes: HashSet::new(),
             controls_to_form: HashMap::new(),
-            net_provider: Arc::new(DummyNetProvider),
-            navigation_provider: Arc::new(DummyNavigationProvider),
-            shell_provider: Arc::new(DummyShellProvider),
+            net_provider,
+            navigation_provider,
+            shell_provider,
         };
 
         // Initialise document with root Document node
         doc.create_node(NodeData::Document);
         doc.root_node_mut().flags.insert(NodeFlags::IS_IN_DOCUMENT);
 
+        match config.ua_stylesheets {
+            Some(stylesheets) => {
+                for ss in &stylesheets {
+                    doc.add_user_agent_stylesheet(ss);
+                }
+            }
+            None => doc.add_user_agent_stylesheet(DEFAULT_CSS),
+        }
+
         // Stylo data on the root node container is needed to render the node
         let stylo_element_data = StyloElementData {
             styles: ElementStyles {

packages/blitz-dom/src/lib.rs

@@ -34,6 +34,7 @@ mod document;
 /// The nodes themsleves, and their data.
 pub mod node;
 
+mod config;
 mod debug;
 mod events;
 mod form;
@@ -53,6 +54,7 @@ pub mod util;
 #[cfg(feature = "accessibility")]
 mod accessibility;
 
+pub use config::DocumentConfig;
 pub use document::{BaseDocument, Document};
 pub use markup5ever::{
     LocalName, Namespace, NamespaceStaticSet, Prefix, PrefixStaticSet, QualName, local_name,

packages/blitz-html/src/html_document.rs

@@ -1,19 +1,11 @@
-use std::{
-    ops::{Deref, DerefMut},
-    sync::Arc,
-};
+use std::ops::{Deref, DerefMut};
 
 use crate::DocumentHtmlParser;
 
 use blitz_dom::{
-    BaseDocument, DEFAULT_CSS, Document, EventDriver, FontContext, NoopEventHandler, net::Resource,
-};
-use blitz_traits::{
-    events::UiEvent,
-    navigation::NavigationProvider,
-    net::SharedProvider,
-    shell::{ColorScheme, Viewport},
+    BaseDocument, DEFAULT_CSS, Document, DocumentConfig, EventDriver, NoopEventHandler,
 };
+use blitz_traits::events::UiEvent;
 
 pub struct HtmlDocument {
     inner: BaseDocument,
@@ -52,41 +44,14 @@ impl Document for HtmlDocument {
 }
 
 impl HtmlDocument {
-    pub fn from_html(
-        html: &str,
-        base_url: Option<String>,
-        stylesheets: Vec<String>,
-        net_provider: SharedProvider<Resource>,
-        font_ctx: Option<FontContext>,
-        navigation_provider: Arc<dyn NavigationProvider>,
-    ) -> Self {
-        // Spin up the virtualdom and include the default stylesheet
-        let viewport = Viewport::new(0, 0, 1.0, ColorScheme::Light);
-        let mut doc = match font_ctx {
-            Some(font_ctx) => BaseDocument::with_font_ctx(viewport, font_ctx),
-            None => BaseDocument::new(viewport),
-        };
-
-        // Set base url if configured
-        if let Some(url) = &base_url {
-            doc.set_base_url(url);
+    pub fn from_html(html: &str, mut config: DocumentConfig) -> Self {
+        if let Some(ss) = &mut config.ua_stylesheets {
+            if !ss.iter().any(|s| s == DEFAULT_CSS) {
+                ss.push(String::from(DEFAULT_CSS));
+            }
         }
-
-        // Set the net provider
-        doc.set_net_provider(net_provider.clone());
-
-        // Set the navigation provider
-        doc.set_navigation_provider(navigation_provider.clone());
-
-        // Include default and user-specified stylesheets
-        doc.add_user_agent_stylesheet(DEFAULT_CSS);
-        for ss in &stylesheets {
-            doc.add_user_agent_stylesheet(ss);
-        }
-
-        // Parse HTML string into document
+        let mut doc = BaseDocument::new(config);
         DocumentHtmlParser::parse_into_doc(&mut doc, html);
-
         HtmlDocument { inner: doc }
     }
 }

packages/blitz-html/src/html_sink.rs

@@ -237,11 +237,10 @@ impl<'b> TreeSink for DocumentHtmlParser<'b> {
 
 #[test]
 fn parses_some_html() {
-    use blitz_traits::shell::{ColorScheme, Viewport};
+    use blitz_dom::DocumentConfig;
 
     let html = "<!DOCTYPE html><html><body><h1>hello world</h1></body></html>";
-    let viewport = Viewport::new(800, 600, 1.0, ColorScheme::Light);
-    let mut doc = BaseDocument::new(viewport);
+    let mut doc = BaseDocument::new(DocumentConfig::default());
     let sink = DocumentHtmlParser::new(&mut doc);
 
     html5ever::parse_document(sink, Default::default())

packages/blitz-traits/src/shell.rs

@@ -36,17 +36,23 @@ pub enum ColorScheme {
     Dark,
 }
 
-#[derive(Default, Debug, Clone)]
+#[derive(Debug, Clone)]
 pub struct Viewport {
+    pub color_scheme: ColorScheme,
     pub window_size: (u32, u32),
+    pub hidpi_scale: f32,
+    pub zoom: f32,
+}
 
-    hidpi_scale: f32,
-
-    zoom: f32,
-
-    pub font_size: f32,
-
-    pub color_scheme: ColorScheme,
+impl Default for Viewport {
+    fn default() -> Self {
+        Self {
+            window_size: (0, 0),
+            hidpi_scale: 1.0,
+            zoom: 1.0,
+            color_scheme: ColorScheme::Light,
+        }
+    }
 }
 
 impl Viewport {
@@ -60,7 +66,6 @@ impl Viewport {
             window_size: (physical_width, physical_height),
             hidpi_scale: scale_factor,
             zoom: 1.0,
-            font_size: 16.0,
             color_scheme,
         }
     }

packages/blitz/src/lib.rs

@@ -14,13 +14,13 @@
 use std::sync::Arc;
 
 use anyrender_vello::VelloWindowRenderer as WindowRenderer;
+use blitz_dom::DocumentConfig;
 use blitz_dom::net::Resource;
 use blitz_html::HtmlDocument;
 use blitz_shell::{
     BlitzApplication, BlitzShellEvent, BlitzShellNetCallback, Config, EventLoop, WindowConfig,
     create_default_event_loop,
 };
-use blitz_traits::navigation::DummyNavigationProvider;
 use blitz_traits::net::{NetProvider, Request};
 
 #[doc(inline)]
@@ -101,14 +101,14 @@ fn launch_internal(
     event_loop: EventLoop<BlitzShellEvent>,
     net_provider: Arc<dyn NetProvider<Resource>>,
 ) {
-    let navigation_provider = Arc::new(DummyNavigationProvider);
     let doc = HtmlDocument::from_html(
         html,
-        cfg.base_url,
-        cfg.stylesheets,
-        net_provider,
-        None,
-        navigation_provider,
+        DocumentConfig {
+            base_url: cfg.base_url,
+            ua_stylesheets: Some(cfg.stylesheets),
+            net_provider: Some(net_provider),
+            ..Default::default()
+        },
     );
     let renderer = WindowRenderer::new();
     let window = WindowConfig::new(Box::new(doc) as _, renderer);