stof 0.3.24

Stof is a unified data interface and interchange format for creating, sharing, and manipulating data. Stof removes the fragile and cumbersome parts of combining and using data in applications.
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131

//
// Copyright 2024 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 std::collections::{BTreeMap, HashSet};
use nanoid::nanoid;
use serde::{Deserialize, Serialize};
use crate::{SData, SField, SFunc, SGraph, SNodeRef, SPrototype, SType, SVal};
use super::Expr;


/// Custom type declaration information.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomType {
    /// Location ID for this custom type.
    /// This is the SNodeRef ID to this prototype in a SGraph.
    pub locid: String,

    /// Location ID for where this type was declared.
    /// This is the SNodeRef ID associated with this type.
    pub decid: String,

    pub name: String,
    pub fields: Vec<CustomTypeField>,
    pub attributes: BTreeMap<String, SVal>,
}
impl CustomType {
    /// New Type.
    pub fn new(decid: &str, name: &str, fields: Vec<CustomTypeField>) -> Self {
        Self {
            name: name.to_owned(),
            fields,
            locid: format!("ctl{}", nanoid!(10)),
            decid: decid.to_owned(),
            attributes: Default::default(),
        }
    }

    /// Is a private type?
    /// Means this type can only be instantiated/casted to from within it's own scope (or sub-scopes)!
    pub fn is_private(&self) -> bool {
        return self.attributes.contains_key("private");
    }

    /// Create a new prototype for this custom type.
    pub fn prototype(&self) -> SPrototype {
        SPrototype::new(&self.locid)
    }

    /// Field names.
    pub fn fieldnames(&self) -> HashSet<String> {
        let mut names = HashSet::new();
        for param in &self.fields {
            names.insert(param.name.clone());
        }
        names
    }

    /// Typepath for this type.
    pub fn typepath(&self, graph: &SGraph) -> String {
        let typepath = SNodeRef::new(&self.decid).path(&graph).replace('/', ".");
        format!("{}.{}", typepath, self.name)
    }

    /// Insert this custom type into the graph.
    pub fn insert(&mut self, graph: &mut SGraph, location: &str, functions: Vec<SFunc>) {
        let nref = graph.ensure_nodes(location, '/', true, None);
        
        // Set the location of this custom type so it is not lost
        self.locid = nref.id.clone();

        // Insert functions into the graph
        for f in functions {
            SData::insert_new(graph, &nref, Box::new(f));
        }

        // Insert typename into the graph
        if let Some(typename_field_ref) = SField::field_ref(graph, "typename", '.', Some(&nref)) {
            if let Some(field) = SData::get_mut::<SField>(graph, &typename_field_ref) {
                field.value = SVal::String(self.name.clone());
            }
        } else {
            SField::new_string(graph, "typename", &self.name, &nref);
        }

        // Insert typepath into the graph, which includes the declaration path
        let typepath = SNodeRef::new(&self.decid).path(&graph).replace('/', ".");
        if let Some(typepath_field_ref) = SField::field_ref(graph, "typepath", '.', Some(&nref)) {
            if let Some(field) = SData::get_mut::<SField>(graph, &typepath_field_ref) {
                field.value = SVal::String(format!("{}.{}", typepath, self.name));
            }
        } else {
            SField::new_string(graph, "typepath", &format!("{}.{}", typepath, self.name), &nref);
        }
    }
}


/// Custom type field.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct CustomTypeField {
    pub name: String,
    pub ptype: SType,
    pub default: Option<Expr>,
    pub optional: bool,
    pub attributes: BTreeMap<String, SVal>,
}
impl CustomTypeField {
    /// New parameter.
    pub fn new(name: &str, ptype: SType, default: Option<Expr>, attrs: BTreeMap<String, SVal>, optional: bool) -> Self {
        Self {
            name: name.into(),
            ptype,
            default,
            optional,
            attributes: attrs,
        }
    }
}