freya-core 0.3.4

Internal core funcionatilies for Freya.
Documentation
use dioxus_core::{
    ElementId,
    Template,
    WriteMutations,
};
use freya_native_core::{
    prelude::{
        DioxusNativeCoreMutationWriter,
        NodeImmutable,
    },
    tree::TreeRef,
    NodeId,
};
use torin::torin::{
    DirtyReason,
    Torin,
};

use super::{
    CompositorDirtyNodes,
    DioxusDOMAdapter,
    ImagesCache,
    ParagraphElements,
};
use crate::{
    accessibility::{
        AccessibilityDirtyNodes,
        NodeAccessibility,
    },
    custom_attributes::CustomAttributeValues,
    layers::Layers,
    render::{
        Compositor,
        CompositorCache,
        CompositorDirtyArea,
    },
    states::{
        CursorState,
        ImageState,
        LayerState,
    },
};

pub struct MutationsWriter<'a> {
    pub native_writer: DioxusNativeCoreMutationWriter<'a, CustomAttributeValues>,
    pub layout: &'a mut Torin<NodeId>,
    pub layers: &'a mut Layers,
    pub paragraphs: &'a mut ParagraphElements,
    pub scale_factor: f32,
    pub compositor_dirty_nodes: &'a mut CompositorDirtyNodes,
    pub compositor_dirty_area: &'a mut CompositorDirtyArea,
    pub compositor_cache: &'a mut CompositorCache,
    pub accessibility_dirty_nodes: &'a mut AccessibilityDirtyNodes,
    pub images_cache: &'a mut ImagesCache,
}

impl MutationsWriter<'_> {
    pub fn remove(&mut self, id: ElementId) {
        let node_id = self.native_writer.state.element_to_node_id(id);
        let mut dom_adapter = DioxusDOMAdapter::new(self.native_writer.rdom, self.scale_factor);

        // Remove from layers , paragraph elements and unite the removed areas with the compositor dirty area
        let mut stack = vec![node_id];
        let tree = self.native_writer.rdom.tree_ref();
        while let Some(node_id) = stack.pop() {
            if let Some(node) = self.native_writer.rdom.get(node_id) {
                if !node.node_type().is_visible_element() {
                    continue;
                }

                let layer_state = node.get::<LayerState>();

                let Some(layer_state) = layer_state else {
                    // There might exist Nodes in the RealDOM with no states yet,
                    // this is mainly due to nodes being created in the same run as when this function (remove) is being called,
                    // like nodes created by loaded templates.
                    // In this case we can safely skip these nodes.
                    continue;
                };

                let traverse_children = node
                    .node_type()
                    .tag()
                    .map(|tag| tag.has_children_with_intrinsic_layout())
                    .unwrap_or_default();
                if traverse_children {
                    let children = tree.children_ids_advanced(node_id, false);
                    stack.extend(children.iter().copied().rev());
                }

                // Remove from layers
                self.layers
                    .remove_node_from_layer(node_id, layer_state.layer);

                // Remove from paragraph elements
                if let Some(cursor_state) = node.get::<CursorState>() {
                    if let Some(cursor_ref) = cursor_state.cursor_ref.as_ref() {
                        self.paragraphs
                            .remove_paragraph(node_id, &cursor_ref.text_id);
                    }
                }

                // Remove from the accessibility tree
                if node.get_accessibility_id().is_some() {
                    let parent_id = node
                        .parent_id()
                        .unwrap_or(self.native_writer.rdom.root_id());
                    self.accessibility_dirty_nodes.remove(node.id(), parent_id);
                }

                // Unite the removed area with the dirty area
                if let Some(area) = Compositor::get_drawing_area(
                    node_id,
                    self.layout,
                    self.native_writer.rdom,
                    self.scale_factor,
                ) {
                    self.compositor_dirty_area.unite_or_insert(&area);
                }

                // Remove the node from the compositor cache
                self.compositor_cache.remove(&node_id);

                if let Some(image_state) = node.get::<ImageState>() {
                    if let Some(image_cache_key) = &image_state.image_cache_key {
                        self.images_cache.remove(image_cache_key);
                    }
                }
            }
        }

        // Remove from layout
        self.layout.remove(node_id, &mut dom_adapter, true);
    }
}

impl WriteMutations for MutationsWriter<'_> {
    fn append_children(&mut self, id: dioxus_core::ElementId, m: usize) {
        self.native_writer.append_children(id, m);
    }

    fn assign_node_id(&mut self, path: &'static [u8], id: dioxus_core::ElementId) {
        self.native_writer.assign_node_id(path, id);
    }

    fn create_placeholder(&mut self, id: dioxus_core::ElementId) {
        self.native_writer.create_placeholder(id);
    }

    fn create_text_node(&mut self, value: &str, id: dioxus_core::ElementId) {
        self.native_writer.create_text_node(value, id);
    }

    fn load_template(&mut self, template: Template, index: usize, id: dioxus_core::ElementId) {
        self.native_writer.load_template(template, index, id);
    }

    fn replace_node_with(&mut self, id: dioxus_core::ElementId, m: usize) {
        if m > 0 {
            self.remove(id);
            self.native_writer.replace_node_with(id, m);
        }
    }

    fn replace_placeholder_with_nodes(&mut self, path: &'static [u8], m: usize) {
        if m > 0 {
            self.native_writer.replace_placeholder_with_nodes(path, m);
        }
    }

    fn insert_nodes_after(&mut self, id: dioxus_core::ElementId, m: usize) {
        if m > 0 {
            self.layout.invalidate_with_reason(
                self.native_writer.state.element_to_node_id(id),
                DirtyReason::Reorder,
            );
            let new_nodes =
                &self.native_writer.state.stack[self.native_writer.state.stack.len() - m..];
            for new in new_nodes {
                self.layout
                    .invalidate_with_reason(*new, DirtyReason::Reorder);
            }

            self.native_writer.insert_nodes_after(id, m);
        }
    }

    fn insert_nodes_before(&mut self, id: dioxus_core::ElementId, m: usize) {
        if m > 0 {
            self.layout.invalidate_with_reason(
                self.native_writer.state.element_to_node_id(id),
                DirtyReason::Reorder,
            );
            let new_nodes =
                &self.native_writer.state.stack[self.native_writer.state.stack.len() - m..];
            for new in new_nodes {
                self.layout
                    .invalidate_with_reason(*new, DirtyReason::Reorder);
            }

            self.native_writer.insert_nodes_before(id, m);
        }
    }

    fn set_attribute(
        &mut self,
        name: &'static str,
        ns: Option<&'static str>,
        value: &dioxus_core::AttributeValue,
        id: dioxus_core::ElementId,
    ) {
        self.native_writer.set_attribute(name, ns, value, id);
    }

    fn set_node_text(&mut self, value: &str, id: dioxus_core::ElementId) {
        self.compositor_dirty_nodes
            .invalidate(self.native_writer.state.element_to_node_id(id));
        self.layout
            .invalidate(self.native_writer.state.element_to_node_id(id));
        self.native_writer.set_node_text(value, id);
    }

    fn create_event_listener(&mut self, name: &'static str, id: dioxus_core::ElementId) {
        self.native_writer.create_event_listener(name, id);
    }

    fn remove_event_listener(&mut self, name: &'static str, id: dioxus_core::ElementId) {
        self.native_writer.remove_event_listener(name, id);
    }

    fn remove_node(&mut self, id: dioxus_core::ElementId) {
        self.remove(id);
        self.native_writer.remove_node(id);
    }

    fn push_root(&mut self, id: dioxus_core::ElementId) {
        self.native_writer.push_root(id);
    }
}