stack-graphs 0.14.1

Name binding for arbitrary programming languages
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

// -*- coding: utf-8 -*-
// ------------------------------------------------------------------------------------------------
// Copyright © 2021, stack-graphs authors.
// Licensed under either of Apache License, Version 2.0, or MIT license, at your option.
// Please see the LICENSE-APACHE or LICENSE-MIT files in this distribution for license details.
// ------------------------------------------------------------------------------------------------

//! Contains several useful stack graphs that can be used in test cases.

use stack_graphs::arena::Handle;
use stack_graphs::graph::*;

pub mod class_field_through_function_parameter;
pub mod cyclic_imports_python;
pub mod cyclic_imports_rust;
pub mod sequenced_import_star;
pub mod simple;

/// An extension trait that makes it a bit easier to add stuff to our test stack graphs.
pub trait CreateStackGraph {
    type File: Clone + Copy;
    type Node: Clone + Copy;
    type Symbol: Clone + Copy;

    fn definition(&mut self, file: Self::File, local_id: u32, symbol: Self::Symbol) -> Self::Node;

    fn drop_scopes(&mut self, file: Self::File, local_id: u32) -> Self::Node;

    fn edge(&mut self, source: Self::Node, sink: Self::Node);

    fn exported_scope(&mut self, file: Self::File, local_id: u32) -> Self::Node;

    fn file(&mut self, name: &str) -> Self::File;

    fn internal_scope(&mut self, file: Self::File, local_id: u32) -> Self::Node;

    fn jump_to_node(&mut self) -> Self::Node;

    fn pop_scoped_symbol(
        &mut self,
        file: Self::File,
        local_id: u32,
        symbol: Self::Symbol,
    ) -> Self::Node;

    fn pop_symbol(&mut self, file: Self::File, local_id: u32, symbol: Self::Symbol) -> Self::Node;

    fn push_scoped_symbol(
        &mut self,
        file: Self::File,
        local_id: u32,
        symbol: Self::Symbol,
        scope_file: Self::File,
        scope_id: u32,
    ) -> Self::Node;

    fn push_symbol(&mut self, file: Self::File, local_id: u32, symbol: Self::Symbol) -> Self::Node;

    fn reference(&mut self, file: Self::File, local_id: u32, symbol: Self::Symbol) -> Self::Node;

    fn root_node(&mut self) -> Self::Node;

    fn symbol(&mut self, value: &str) -> Self::Symbol;
}

impl CreateStackGraph for StackGraph {
    type File = Handle<File>;
    type Node = Handle<Node>;
    type Symbol = Handle<Symbol>;

    fn definition(
        &mut self,
        file: Handle<File>,
        local_id: u32,
        symbol: Handle<Symbol>,
    ) -> Handle<Node> {
        self.add_pop_symbol_node(NodeID::new_in_file(file, local_id), symbol, true)
            .expect("Duplicate node ID")
    }

    fn drop_scopes(&mut self, file: Handle<File>, local_id: u32) -> Handle<Node> {
        self.add_drop_scopes_node(NodeID::new_in_file(file, local_id))
            .expect("Duplicate node ID")
    }

    fn edge(&mut self, source: Handle<Node>, sink: Handle<Node>) {
        self.add_edge(source, sink, 0);
    }

    fn exported_scope(&mut self, file: Handle<File>, local_id: u32) -> Handle<Node> {
        self.add_scope_node(NodeID::new_in_file(file, local_id), true)
            .expect("Duplicate node ID")
    }

    fn file(&mut self, name: &str) -> Handle<File> {
        self.get_or_create_file(name)
    }

    fn internal_scope(&mut self, file: Handle<File>, local_id: u32) -> Handle<Node> {
        self.add_scope_node(NodeID::new_in_file(file, local_id), false)
            .expect("Duplicate node ID")
    }

    fn jump_to_node(&mut self) -> Handle<Node> {
        StackGraph::jump_to_node()
    }

    fn pop_scoped_symbol(
        &mut self,
        file: Handle<File>,
        local_id: u32,
        symbol: Handle<Symbol>,
    ) -> Handle<Node> {
        self.add_pop_scoped_symbol_node(NodeID::new_in_file(file, local_id), symbol, false)
            .expect("Duplicate node ID")
    }

    fn pop_symbol(
        &mut self,
        file: Handle<File>,
        local_id: u32,
        symbol: Handle<Symbol>,
    ) -> Handle<Node> {
        self.add_pop_symbol_node(NodeID::new_in_file(file, local_id), symbol, false)
            .expect("Duplicate node ID")
    }

    fn push_scoped_symbol(
        &mut self,
        file: Handle<File>,
        local_id: u32,
        symbol: Handle<Symbol>,
        scope_file: Handle<File>,
        scope_id: u32,
    ) -> Handle<Node> {
        let scope = NodeID::new_in_file(scope_file, scope_id);
        self.add_push_scoped_symbol_node(NodeID::new_in_file(file, local_id), symbol, scope, false)
            .expect("Duplicate node ID")
    }

    fn push_symbol(
        &mut self,
        file: Handle<File>,
        local_id: u32,
        symbol: Handle<Symbol>,
    ) -> Handle<Node> {
        self.add_push_symbol_node(NodeID::new_in_file(file, local_id), symbol, false)
            .expect("Duplicate node ID")
    }

    fn reference(
        &mut self,
        file: Handle<File>,
        local_id: u32,
        symbol: Handle<Symbol>,
    ) -> Handle<Node> {
        self.add_push_symbol_node(NodeID::new_in_file(file, local_id), symbol, true)
            .expect("Duplicate node ID")
    }

    fn root_node(&mut self) -> Handle<Node> {
        StackGraph::root_node()
    }

    fn symbol(&mut self, value: &str) -> Handle<Symbol> {
        self.add_symbol(value)
    }
}