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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
//! Rust AST visualization using syn.
use crate::tree::Tree;
use std::path::Path;
impl Tree {
/// Builds a tree from a Rust source file's AST.
///
/// Requires the `syn` feature.
///
/// Parses the Rust file and converts its AST into a tree structure.
///
/// # Examples
///
/// ```no_run
/// use treelog::Tree;
///
/// let tree = Tree::from_syn_file("src/lib.rs").unwrap();
/// ```
#[cfg(feature = "arbitrary-syn")]
pub fn from_syn_file<P: AsRef<Path>>(path: P) -> Result<Self, Box<dyn std::error::Error>> {
let content = std::fs::read_to_string(path)?;
let ast = syn::parse_file(&content)?;
Ok(Self::from_syn_file_ast(&ast))
}
/// Builds a tree from a syn::File AST.
///
/// Requires the `syn` feature.
///
/// # Examples
///
/// ```
/// use treelog::Tree;
/// use syn::parse_file;
///
/// let code = "fn main() {}";
/// let ast = parse_file(code).unwrap();
/// let tree = Tree::from_syn_file_ast(&ast);
/// ```
#[cfg(feature = "arbitrary-syn")]
pub fn from_syn_file_ast(file: &syn::File) -> Self {
let mut children = Vec::new();
for item in &file.items {
children.push(Self::from_syn_item(item));
}
if children.is_empty() {
Tree::new_leaf("file (empty)".to_string())
} else {
Tree::Node("file".to_string(), children)
}
}
/// Builds a tree from a syn::Item.
///
/// Requires the `syn` feature.
///
/// # Examples
///
/// ```
/// use treelog::Tree;
/// use syn::parse_quote;
///
/// let item: syn::Item = parse_quote! {
/// fn hello() {}
/// };
/// let tree = Tree::from_syn_item(&item);
/// ```
#[cfg(feature = "arbitrary-syn")]
pub fn from_syn_item(item: &syn::Item) -> Self {
match item {
syn::Item::Const(item) => {
let label = format!("const {}", item.ident);
Tree::new_leaf(label)
}
syn::Item::Enum(item) => {
let label = format!("enum {}", item.ident);
let mut children = Vec::new();
for variant in &item.variants {
let variant_label = format!("variant {}", variant.ident);
children.push(Tree::new_leaf(variant_label));
}
if children.is_empty() {
Tree::new_leaf(label)
} else {
Tree::Node(label, children)
}
}
syn::Item::ExternCrate(item) => Tree::new_leaf(format!("extern crate {}", item.ident)),
syn::Item::Fn(item) => {
let label = format!("fn {}", item.sig.ident);
let mut children = Vec::new();
// Add parameters
if !item.sig.inputs.is_empty() {
let params: Vec<String> = item
.sig
.inputs
.iter()
.map(|input| match input {
syn::FnArg::Receiver(_) => "self".to_string(),
syn::FnArg::Typed(typed) => {
if let syn::Pat::Ident(ident) = &*typed.pat {
ident.ident.to_string()
} else {
"param".to_string()
}
}
})
.collect();
children.push(Tree::new_leaf(format!("params: {}", params.join(", "))));
}
if children.is_empty() {
Tree::new_leaf(label)
} else {
Tree::Node(label, children)
}
}
syn::Item::Impl(item) => {
let label = if let Some((_, trait_path, _)) = &item.trait_ {
format!("impl {:?} for {:?}", trait_path, item.self_ty)
} else {
format!("impl {:?}", item.self_ty)
};
let mut children = Vec::new();
for impl_item in &item.items {
match impl_item {
syn::ImplItem::Fn(method) => {
children.push(Tree::new_leaf(format!("method {}", method.sig.ident)));
}
syn::ImplItem::Const(const_item) => {
children.push(Tree::new_leaf(format!("const {}", const_item.ident)));
}
_ => {
children.push(Tree::new_leaf("item".to_string()));
}
}
}
if children.is_empty() {
Tree::new_leaf(label)
} else {
Tree::Node(label, children)
}
}
syn::Item::Mod(item) => {
let label = format!("mod {}", item.ident);
Tree::new_leaf(label)
}
syn::Item::Static(item) => Tree::new_leaf(format!("static {}", item.ident)),
syn::Item::Struct(item) => {
let label = format!("struct {}", item.ident);
let mut children = Vec::new();
if let syn::Fields::Named(fields) = &item.fields {
for field in &fields.named {
let field_name = field
.ident
.as_ref()
.map(|i| i.to_string())
.unwrap_or_else(|| "unnamed".to_string());
children.push(Tree::new_leaf(field_name));
}
}
if children.is_empty() {
Tree::new_leaf(label)
} else {
Tree::Node(label, children)
}
}
syn::Item::Trait(item) => {
let label = format!("trait {}", item.ident);
let mut children = Vec::new();
for item in &item.items {
if let syn::TraitItem::Fn(method) = item {
children.push(Tree::new_leaf(format!("method {}", method.sig.ident)));
}
}
if children.is_empty() {
Tree::new_leaf(label)
} else {
Tree::Node(label, children)
}
}
syn::Item::Type(item) => Tree::new_leaf(format!("type {}", item.ident)),
syn::Item::Use(item) => Tree::new_leaf(format!("use {:?}", item)),
_ => Tree::new_leaf(format!("item: {:?}", std::any::type_name_of_val(item))),
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[cfg(feature = "arbitrary-syn")]
#[test]
fn test_from_syn_file_ast() {
let code = "fn main() {}";
let ast = syn::parse_file(code).unwrap();
let tree = Tree::from_syn_file_ast(&ast);
assert!(tree.is_node());
}
#[cfg(feature = "arbitrary-syn")]
#[test]
fn test_from_syn_item() {
let item: syn::Item = syn::parse_quote! {
struct Test {
field: i32,
}
};
let tree = Tree::from_syn_item(&item);
assert!(tree.is_node());
}
}