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
|
#[doc(
brief = "The attribute parsing pass",
desc =
"Traverses the document tree, pulling relevant documention out of the \
corresponding AST nodes. The information gathered here is the basis \
of the natural-language documentation for a crate."
)];
import rustc::syntax::ast;
import rustc::middle::ast_map;
export mk_pass;
fn mk_pass() -> pass {
run
}
fn run(
srv: astsrv::srv,
doc: doc::cratedoc
) -> doc::cratedoc {
let fold = fold::fold({
fold_crate: fold_crate,
fold_mod: fold_mod,
fold_fn: fold_fn
with *fold::default_seq_fold(srv)
});
fold.fold_crate(fold, doc)
}
fn fold_crate(
fold: fold::fold<astsrv::srv>,
doc: doc::cratedoc
) -> doc::cratedoc {
let srv = fold.ctxt;
let doc = fold::default_seq_fold_crate(fold, doc);
let attrs = astsrv::exec(srv) {|ctxt|
let attrs = ctxt.ast.node.attrs;
attr_parser::parse_crate(attrs)
};
~{
topmod: ~{
name: option::from_maybe(doc.topmod.name, attrs.name)
with *doc.topmod
}
}
}
#[test]
fn should_replace_top_module_name_with_crate_name() {
let source = "#[link(name = \"bond\")];";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let fold = fold::default_seq_fold(srv);
let doc = fold_crate(fold, doc);
assert doc.topmod.name == "bond";
}
fn fold_mod(fold: fold::fold<astsrv::srv>, doc: doc::moddoc) -> doc::moddoc {
let srv = fold.ctxt;
let attrs = if doc.id == ast::crate_node_id {
// This is the top-level mod, use the crate attributes
astsrv::exec(srv) {|ctxt|
attr_parser::parse_mod(ctxt.ast.node.attrs)
}
} else {
astsrv::exec(srv) {|ctxt|
let attrs = alt ctxt.map.get(doc.id) {
ast_map::node_item(item) { item.attrs }
};
attr_parser::parse_mod(attrs)
}
};
let doc = fold::default_seq_fold_mod(fold, doc);
ret merge_mod_attrs(doc, attrs);
fn merge_mod_attrs(
doc: doc::moddoc,
attrs: attr_parser::mod_attrs
) -> doc::moddoc {
~{
brief: attrs.brief,
desc: attrs.desc
with *doc
}
}
}
#[test]
fn fold_mod_should_extract_mod_attributes() {
let source = "#[doc = \"test\"] mod a { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let fold = fold::default_seq_fold(srv);
let doc = fold_mod(fold, doc.topmod.mods[0]);
assert doc.desc == some("test");
}
#[test]
fn fold_mod_should_extract_top_mod_attributes() {
let source = "#[doc = \"test\"];";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let fold = fold::default_seq_fold(srv);
let doc = fold_mod(fold, doc.topmod);
assert doc.desc == some("test");
}
fn fold_fn(
fold: fold::fold<astsrv::srv>,
doc: doc::fndoc
) -> doc::fndoc {
let srv = fold.ctxt;
let attrs = astsrv::exec(srv) {|ctxt|
let attrs = alt ctxt.map.get(doc.id) {
ast_map::node_item(item) { item.attrs }
};
attr_parser::parse_fn(attrs)
};
ret merge_fn_attrs(doc, attrs);
fn merge_fn_attrs(
doc: doc::fndoc,
attrs: attr_parser::fn_attrs
) -> doc::fndoc {
ret ~{
brief: attrs.brief,
desc: attrs.desc,
args: merge_arg_attrs(doc.args, attrs.args),
return: merge_ret_attrs(doc.return, attrs.return)
with *doc
};
}
fn merge_arg_attrs(
docs: [doc::argdoc],
attrs: [attr_parser::arg_attrs]
) -> [doc::argdoc] {
vec::map(docs) {|doc|
alt vec::find(attrs) {|attr|
attr.name == doc.name
} {
some(attr) {
~{
desc: some(attr.desc)
with *doc
}
}
none { doc }
}
}
// FIXME: Warning when documenting a non-existent arg
}
fn merge_ret_attrs(
doc: doc::retdoc,
attrs: option<str>
) -> doc::retdoc {
{
desc: attrs
with doc
}
}
}
#[test]
fn fold_fn_should_extract_fn_attributes() {
let source = "#[doc = \"test\"] fn a() -> int { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let fold = fold::default_seq_fold(srv);
let doc = fold_fn(fold, doc.topmod.fns[0]);
assert doc.desc == some("test");
}
#[test]
fn fold_fn_should_extract_arg_attributes() {
let source = "#[doc(args(a = \"b\"))] fn c(a: bool) { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let fold = fold::default_seq_fold(srv);
let doc = fold_fn(fold, doc.topmod.fns[0]);
assert doc.args[0].desc == some("b");
}
#[test]
fn fold_fn_should_extract_return_attributes() {
let source = "#[doc(return = \"what\")] fn a() -> int { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let doc = tystr_pass::mk_pass()(srv, doc);
let fold = fold::default_seq_fold(srv);
let doc = fold_fn(fold, doc.topmod.fns[0]);
assert doc.return.desc == some("what");
}
#[test]
fn fold_fn_should_preserve_sig() {
let source = "fn a() -> int { }";
let srv = astsrv::mk_srv_from_str(source);
let doc = extract::from_srv(srv, "");
let doc = tystr_pass::mk_pass()(srv, doc);
let fold = fold::default_seq_fold(srv);
let doc = fold_fn(fold, doc.topmod.fns[0]);
assert doc.sig == some("fn a() -> int");
}
|
