spade-ast-lowering 0.13.0

Helper crate for https://spade-lang.org/
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
132
133
134

use spade_common::{
    location_info::{Loc, WithLocation},
    name::{Identifier, Path},
};
use spade_hir::{
    symbol_table::{GenericArg, SymbolTable, Thing, TypeDeclKind, TypeSymbol},
    TypeDeclaration,
};
use spade_hir::{ItemList, TypeParam};
use spade_types::{meta_types::MetaType, PrimitiveType};

/// Add built in symbols like types to the symtab. The symbols are added with very high NameIDs to
/// not interfere with tests with hardcoded NameIDs
pub fn populate_symtab(symtab: &mut SymbolTable, item_list: &mut ItemList) {
    // Add primitive data types
    let mut id = std::u64::MAX;

    let mut add_type =
        |path: &[&str], args: Vec<Loc<GenericArg>>, primitive: PrimitiveType, is_port: bool| {
            let name = symtab
                .add_type_with_id(
                    id,
                    Path::from_strs(path),
                    TypeSymbol::Declared(args.clone(), TypeDeclKind::Primitive { is_port })
                        .nowhere(),
                )
                .nowhere();
            id -= 1;

            symtab.new_scope();
            let args = args
                .iter()
                .map(|arg| {
                    let result = match &arg.inner {
                        GenericArg::TypeName { name: a, traits: t } => {
                            assert!(
                                t.is_empty(),
                                "Constrained generics are not supported on primitives"
                            );

                            let id = symtab.add_type_with_id(
                                id,
                                Path(vec![a.clone().nowhere()]),
                                TypeSymbol::GenericArg { traits: vec![] }.nowhere(),
                            );
                            TypeParam {
                                ident: a.clone().nowhere(),
                                name_id: id,
                                trait_bounds: vec![],
                                meta: MetaType::Type,
                            }
                        }
                        GenericArg::TypeWithMeta { name, meta } => {
                            let id = symtab.add_type_with_id(
                                id,
                                Path(vec![name.clone().nowhere()]),
                                TypeSymbol::GenericMeta(meta.clone()).nowhere(),
                            );
                            TypeParam {
                                ident: name.clone().nowhere(),
                                name_id: id,
                                trait_bounds: vec![],
                                meta: meta.clone(),
                            }
                        }
                    }
                    .nowhere();
                    id -= 1;
                    result
                })
                .collect();
            symtab.close_scope();

            item_list.types.insert(
                name.inner.clone(),
                TypeDeclaration {
                    name,
                    kind: spade_hir::TypeDeclKind::Primitive(primitive),
                    generic_args: args,
                }
                .nowhere(),
            );
        };
    add_type(
        &["uint"],
        vec![GenericArg::uint(Identifier("size".into())).nowhere()],
        PrimitiveType::Uint,
        false,
    );
    add_type(
        &["int"],
        vec![GenericArg::uint(Identifier("size".into())).nowhere()],
        PrimitiveType::Int,
        false,
    );
    add_type(
        &["Memory"],
        vec![
            GenericArg::TypeName {
                name: Identifier("D".into()),
                traits: vec![],
            }
            .nowhere(),
            GenericArg::uint(Identifier("AddrWidth".into())).nowhere(),
        ],
        PrimitiveType::Memory,
        true,
    );
    add_type(&["clock"], vec![], PrimitiveType::Clock, true);
    add_type(&["bool"], vec![], PrimitiveType::Bool, false);
    add_type(&["bit"], vec![], PrimitiveType::Bool, false);
    add_type(
        &["inout"],
        vec![GenericArg::uint(Identifier("T".into())).nowhere()],
        PrimitiveType::InOut,
        false,
    );

    let mut add_marker_trait = |path: &[&str]| {
        let name = symtab
            .add_thing_with_id(
                id,
                Path::from_strs(path),
                Thing::Trait(Identifier(path.last().unwrap().to_string()).nowhere()),
            )
            .nowhere();
        id -= 1;

        item_list
            .add_trait(spade_hir::TraitName::Named(name), None, vec![])
            .unwrap();
    };
    add_marker_trait(&["Number"])
}