cargo-modules 0.4.4

A cargo plugin for showing a tree-like overview of a crate's modules.
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

use std::cmp::Ordering;

pub trait Visitor {
    fn visit(&self, module: &Tree, path: &[(usize, usize)], parents: &[&str]);
}

#[derive(Debug, Clone, Copy, PartialEq)]
pub enum Visibility {
    Public,
    Private,
}

#[derive(Debug)]
pub enum Tree {
    Crate {
        name: String,
        subtrees: Vec<Tree>,
        uses: Vec<(Visibility, String)>,
    },
    Module {
        name: String,
        visibility: Visibility,
        condition: Option<String>,
        subtrees: Vec<Tree>,
        uses: Vec<(Visibility, String)>,
    },
    Orphan {
        name: String,
    },
}

impl PartialEq<Tree> for Tree {
    fn eq(&self, other: &Tree) -> bool {
        self.name() == other.name()
    }
}

impl Eq for Tree {}

impl PartialOrd<Tree> for Tree {
    fn partial_cmp(&self, other: &Tree) -> Option<Ordering> {
        self.name().partial_cmp(other.name())
    }
}

impl Ord for Tree {
    fn cmp(&self, other: &Tree) -> Ordering {
        self.name().cmp(other.name())
    }
}

impl Tree {
    pub fn new_crate(name: String) -> Self {
        Tree::Crate {
            name,
            subtrees: vec![],
            uses: vec![],
        }
    }

    pub fn new_module(name: String, visibility: Visibility, condition: Option<String>) -> Self {
        Tree::Module {
            name,
            visibility,
            condition,
            subtrees: vec![],
            uses: vec![],
        }
    }

    pub fn new_orphan(name: String) -> Self {
        Tree::Orphan { name }
    }

    pub fn subtree_at_path(&mut self, path: &[String]) -> Option<&mut Tree> {
        if let Some((name, sub_path)) = path.split_first() {
            match *self {
                Tree::Crate {
                    ref mut subtrees, ..
                }
                | Tree::Module {
                    ref mut subtrees, ..
                } => subtrees
                    .iter_mut()
                    .find(|m| m.name() == *name)
                    .and_then(|subtree| subtree.subtree_at_path(sub_path)),
                Tree::Orphan { .. } => None,
            }
        } else {
            Some(self)
        }
    }

    pub fn insert(&mut self, subtree: Tree) {
        match *self {
            Tree::Crate {
                ref mut subtrees, ..
            }
            | Tree::Module {
                ref mut subtrees, ..
            } => {
                subtrees.push(subtree);
                subtrees.sort();
            }
            Tree::Orphan { .. } => {}
        }
    }

    pub fn insert_use(&mut self, used_module: (Visibility, String)) {
        match *self {
            Tree::Crate { ref mut uses, .. } | Tree::Module { ref mut uses, .. } => {
                uses.push(used_module);
                uses.sort_by(|a, b| a.1.cmp(&b.1));
            }
            Tree::Orphan { .. } => {}
        }
    }

    pub fn name(&self) -> &str {
        match *self {
            Tree::Crate { ref name, .. }
            | Tree::Module { ref name, .. }
            | Tree::Orphan { ref name } => name,
        }
    }

    pub fn subtree_names(&self) -> Vec<String> {
        match *self {
            Tree::Crate { ref subtrees, .. } | Tree::Module { ref subtrees, .. } => {
                subtrees.iter().map(|m| m.name().to_string()).collect()
            }
            Tree::Orphan { .. } => vec![],
        }
    }

    pub fn accept<'a, V>(
        &'a self,
        path: &mut Vec<(usize, usize)>,
        parents: &mut Vec<&'a str>,
        visitor: &V,
    ) where
        V: Visitor,
    {
        visitor.visit(self, path, parents);
        match *self {
            Tree::Crate {
                ref subtrees,
                ref name,
                ..
            }
            | Tree::Module {
                ref subtrees,
                ref name,
                ..
            } => {
                let count = subtrees.len();
                parents.push(name);
                for (index, subtree) in subtrees.iter().enumerate() {
                    path.push((index, count));
                    subtree.accept(path, parents, visitor);
                    let _ = path.pop();
                    let _ = parents.pop();
                }
            }
            Tree::Orphan { .. } => {}
        }
    }
}