anathema_runtime/

builder.rs

use std::sync::atomic::Ordering;

use anathema_backend::Backend;
use anathema_default_widgets::register_default_widgets;
use anathema_geometry::Size;
use anathema_templates::{Document, ToSourceKind};
use anathema_widgets::components::deferred::DeferredComponents;
use anathema_widgets::components::events::Event;
use anathema_widgets::components::{Component, ComponentId, ComponentRegistry, Emitter, ViewMessage};
use anathema_widgets::tabindex::TabIndex;
use anathema_widgets::{Factory, Widget};
use notify::{Event as NotifyEvent, RecommendedWatcher, RecursiveMode, Watcher, recommended_watcher};

use crate::REBUILD;
pub use crate::error::{Error, Result};
use crate::events::GlobalEventHandler;
use crate::runtime::{Runtime, show_error};

pub struct Builder<G> {
    factory: Factory,
    document: Document,
    component_registry: ComponentRegistry,
    emitter: Emitter,
    message_receiver: flume::Receiver<ViewMessage>,
    fps: u32,
    size: Size,
    global_event_handler: G,
    hot_reload: bool,
}

impl<G: GlobalEventHandler> Builder<G> {
    /// Create a new runtime builder
    pub(super) fn new(document: Document, size: Size, global_event_handler: G) -> Self {
        let mut factory = Factory::new();
        register_default_widgets(&mut factory);

        let (tx, message_receiver) = flume::unbounded();
        let emitter = tx.into();

        Self {
            factory,
            document,
            component_registry: ComponentRegistry::new(),
            emitter,
            message_receiver,
            fps: 30,
            size,
            global_event_handler,
            hot_reload: true,
        }
    }

    /// Disable hot reloading
    pub fn disable_hot_reload(&mut self) {
        self.hot_reload = false;
    }

    /// Register a new widget
    pub fn register_widget<T: Widget + Default + 'static>(&mut self, ident: &'static str) {
        self.factory.register_default::<T>(ident);
    }

    /// Set the expected frame rate
    pub fn fps(&mut self, fps: u32) {
        self.fps = fps;
    }

    /// Returns an [Emitter] to send messages to components
    pub fn emitter(&self) -> Emitter {
        self.emitter.clone()
    }

    /// Registers a component as a template-only component.
    ///
    /// This component has no state or reacts to any events
    pub fn template(&mut self, ident: impl Into<String>, template: impl ToSourceKind) -> Result<()> {
        self.prototype(ident, template, || (), || ())
    }

    /// Registers a [Component] with the runtime.
    /// This returns a unique [ComponentId] that is used to send messages to the component.
    ///
    /// A component can only be used once in a template.
    /// If you want multiple instances, register the component as a prototype instead,
    /// see [RuntimeBuilder::prototype].
    pub fn component<C: Component>(
        &mut self,
        ident: impl Into<String>,
        template: impl ToSourceKind,
        component: C,
        state: C::State,
    ) -> Result<ComponentId<C::Message>> {
        let id = self.document.add_component(ident, template.to_source_kind())?;
        self.component_registry.add_component(id, component, state);
        Ok(id.into())
    }

    /// Registers a [Component] with the runtime as long as the component and the associated state
    /// implements the `Default` trait.
    /// This returns a unique [ComponentId] that is used to send messages to the component.
    pub fn default<C>(
        &mut self,
        ident: impl Into<String>,
        template: impl ToSourceKind,
    ) -> Result<ComponentId<C::Message>>
    where
        C: Component + Default,
        C::State: Default,
    {
        let component = C::default();
        let state = C::State::default();
        let id = self.document.add_component(ident, template.to_source_kind())?;
        self.component_registry.add_component(id, component, state);
        Ok(id.into())
    }

    /// Registers a [Component] as a prototype with the [Runtime],
    /// which allows for multiple instances of the component to exist the templates.
    pub fn prototype<FC, FS, C>(
        &mut self,
        ident: impl Into<String>,
        template: impl ToSourceKind,
        proto: FC,
        state: FS,
    ) -> Result<()>
    where
        FC: 'static + Fn() -> C,
        FS: 'static + FnMut() -> C::State,
        C: Component + 'static,
    {
        let id = self.document.add_component(ident, template.to_source_kind())?;
        self.component_registry.add_prototype(id, proto, state);
        Ok(())
    }

    /// Assign a new event handler (make sure not to forget to add some mechanism to stop the
    /// runtime)
    pub fn with_global_event_handler<Eh>(self, global_event_handler: Eh) -> Builder<Eh>
    where
        Eh: Fn(Event, &mut TabIndex<'_, '_>, &mut DeferredComponents) -> Option<Event>,
    {
        Builder {
            factory: self.factory,
            document: self.document,
            component_registry: self.component_registry,
            emitter: self.emitter,
            message_receiver: self.message_receiver,
            fps: self.fps,
            size: self.size,
            global_event_handler,
            hot_reload: self.hot_reload,
        }
    }

    pub fn finish<F, B>(mut self, backend: &mut B, mut f: F) -> Result<()>
    where
        F: FnMut(&mut Runtime<G>, &mut B) -> Result<()>,
        B: Backend,
    {
        #[cfg(feature = "profile")]
        let _puffin_server = {
            let server_addr = format!("127.0.0.1:{}", puffin_http::DEFAULT_PORT);
            let server = puffin_http::Server::new(&server_addr).unwrap();
            puffin::set_scopes_on(true);
            server
        };

        let (blueprint, globals) = loop {
            match self.document.compile() {
                Ok(val) => break val,
                Err(error) => {
                    show_error(error, backend, &mut self.document)?;
                }
            }
        };

        let watcher = self.set_watcher(self.hot_reload)?;

        let mut inst = Runtime::new(
            blueprint,
            globals,
            self.component_registry,
            self.document,
            self.factory,
            self.message_receiver,
            self.emitter,
            watcher,
            self.size,
            self.fps,
            self.global_event_handler,
        );

        // NOTE:
        // this enables hot reload,
        // however with this enabled the `with_frame` function
        // on the runtime will repeat
        loop {
            match f(&mut inst, backend) {
                Ok(()) => (),
                e => match e {
                    Ok(_) => continue,
                    Err(Error::Stop) => break Ok(()),
                    Err(Error::Template(error)) => match show_error(error, backend, &mut inst.document) {
                        Ok(_) => continue,
                        Err(err) => panic!("error console failed: {err}"),
                    },
                    Err(Error::Widget(err)) => panic!("this should not panic in the future: {err}"),
                    Err(e) => break Err(e),
                },
            }

            if !self.hot_reload {
                break Ok(());
            }

            match inst.reload() {
                Ok(()) => continue,
                Err(Error::Stop) => todo!(),
                Err(Error::Template(error)) => match show_error(error, backend, &mut inst.document) {
                    Ok(_) => continue,
                    Err(err) => panic!("error console failed: {err}"),
                },
                Err(Error::Widget(_error)) => todo!(),
                Err(e) => break Err(e),
            }
        }
    }

    fn set_watcher(&mut self, hot_reload: bool) -> Result<Option<RecommendedWatcher>> {
        if !hot_reload {
            return Ok(None);
        }

        let paths = self
            .document
            .template_paths()
            .filter_map(|p| p.canonicalize().ok())
            .collect::<Vec<_>>();

        let mut watcher = recommended_watcher(move |event: std::result::Result<NotifyEvent, _>| match event {
            Ok(event) => match event.kind {
                notify::EventKind::Create(_) | notify::EventKind::Remove(_) | notify::EventKind::Modify(_) => {
                    if paths.iter().any(|p| event.paths.contains(p)) {
                        REBUILD.store(true, Ordering::Relaxed);
                    }
                }
                notify::EventKind::Any | notify::EventKind::Access(_) | notify::EventKind::Other => (),
            },
            Err(_err) => (),
        })?;

        for path in self.document.template_paths() {
            let path = path.canonicalize().unwrap();

            if let Some(parent) = path.parent() {
                watcher.watch(parent, RecursiveMode::NonRecursive)?;
            }
        }

        Ok(Some(watcher))
    }
}