stof 0.9.19

Data that carries its own logic.
Documentation 
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
87
88
89
90
91
92

//
// Copyright 2025 Formata, Inc. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

use arcstr::{literal, ArcStr};
use rustc_hash::FxHashSet;
use serde::{Deserialize, Serialize};
use crate::model::{DataRef, Graph, NodeRef, SPath, StofData};


/// Const prototype "type" literal.
pub const PROTOTYPE_TYPE_ATTR: ArcStr = literal!("type");

/// Const prototype "extends" literal.
pub const PROTOTYPE_EXTENDS_ATTR: ArcStr = literal!("extends");


#[derive(Debug, Clone, Serialize, Deserialize)]
/// Prototype.
pub struct Prototype {
    pub node: NodeRef,
}

#[typetag::serde(name = "Proto")]
impl StofData for Prototype {
    fn core_data(&self) -> bool {
        true
    }
}

impl Prototype {
    /// Get a prototype from a dot separated name path string.
    pub fn from_path(graph: &Graph, path: &str, start: Option<NodeRef>) -> Vec<DataRef> {
        let spath = SPath::from(path);
        if spath.path.is_empty() { return vec![]; }
        if let Some(node) = SPath::node(&graph, spath, start) {
            return Self::prototype_refs(graph, &node);
        }
        vec![]
    }
    
    /// Prototype references on a node.
    pub fn prototype_refs(graph: &Graph, node: &NodeRef) -> Vec<DataRef> {
        let mut protos = Vec::new();
        if let Some(node) = node.node(graph) {
            for (_, dref) in &node.data {
                if dref.type_of::<Self>(&graph) {
                    protos.push(dref.clone());
                }
            }
        }
        protos
    }

    /// Prototype nodes referenced by a node.
    pub fn prototype_nodes(graph: &Graph, node: &NodeRef, recursive: bool) -> Vec<NodeRef> {
        let mut seen = FxHashSet::default();
        Self::internal_prototype_nodes(graph, node, recursive, &mut seen)
    }

    /// Prototype nodes referenced by a node.
    fn internal_prototype_nodes(graph: &Graph, node: &NodeRef, recursive: bool, seen: &mut FxHashSet<NodeRef>) -> Vec<NodeRef> {
        let mut protos = Vec::new();
        if let Some(node) = node.node(graph) {
            for (_, dref) in &node.data {
                if let Some(proto) = graph.get_stof_data::<Self>(dref) {
                    if !seen.contains(&proto.node) {
                        seen.insert(proto.node.clone());
                        protos.push(proto.node.clone());

                        if recursive {
                            protos.append(&mut Self::internal_prototype_nodes(graph, &proto.node, true, seen));
                        }
                    }
                }
            }
        }
        protos
    }
}