Skip to content

Commit cf40b60

Browse files
committed
rustdoc: Begin writting the attribute extracting pass
1 parent a0ed75b commit cf40b60

File tree

2 files changed

+68
-3
lines changed

2 files changed

+68
-3
lines changed

src/rustdoc/attr_pass.rs

Lines changed: 67 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,74 @@
11
import rustc::syntax::ast;
2+
import rustc::middle::ast_map;
23

34
export run;
45

56
fn run(
6-
_doc: doc::cratedoc,
7-
_crate: @ast::crate
7+
srv: astsrv::seq_srv,
8+
doc: doc::cratedoc
89
) -> doc::cratedoc {
9-
fail;
10+
let fold = fold::fold({
11+
fold_fn: fn~(
12+
f: fold::fold<astsrv::seq_srv>,
13+
d: doc::fndoc
14+
) -> doc::fndoc {
15+
fold_fn(f, d)
16+
}
17+
with *fold::default_seq_fold(srv)
18+
});
19+
fold.fold_crate(fold, doc)
20+
}
21+
22+
fn fold_fn(
23+
fold: fold::fold<astsrv::seq_srv>,
24+
doc: doc::fndoc
25+
) -> doc::fndoc {
26+
27+
let srv = fold.ctxt;
28+
29+
let attrs = alt srv.map.get(doc.id) {
30+
ast_map::node_item(item) { item.attrs }
31+
};
32+
let attrs = attr_parser::parse_fn(attrs);
33+
ret merge_fn_attrs(doc, attrs);
34+
35+
fn merge_fn_attrs(
36+
doc: doc::fndoc,
37+
attrs: attr_parser::fn_attrs
38+
) -> doc::fndoc {
39+
ret ~{
40+
id: doc.id,
41+
name: doc.name,
42+
brief: attrs.brief,
43+
desc: attrs.desc,
44+
return: merge_ret_attrs(doc.return, attrs.return),
45+
args: merge_arg_attrs(doc.args, attrs.args)
46+
};
47+
}
48+
49+
fn merge_arg_attrs(
50+
doc: [(str, str)],
51+
_attrs: [attr_parser::arg_attrs]
52+
) -> [(str, str)] {
53+
// FIXME
54+
doc
55+
}
56+
57+
fn merge_ret_attrs(
58+
doc: option<doc::retdoc>,
59+
_attrs: option<str>
60+
) -> option<doc::retdoc> {
61+
// FIXME
62+
doc
63+
}
64+
}
65+
66+
#[test]
67+
fn fold_fn_should_extract_fn_attributes() {
68+
let source = "#[doc = \"test\"] fn a() -> int { }";
69+
let srv = astsrv::mk_seq_srv_from_str(source);
70+
let doc = extract::from_srv(srv, "");
71+
let fold = fold::default_seq_fold(srv);
72+
let doc = fold_fn(fold, doc.topmod.fns[0]);
73+
assert doc.desc == some("test");
1074
}

src/rustdoc/rustdoc.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ fn run(source_file: str) {
7676
let srv = astsrv::mk_seq_srv_from_file(source_file);
7777
let doc = extract::from_srv(srv, default_name);
7878
let doc = run_passes(srv, doc, [
79+
attr_pass::run,
7980
tystr_pass::run
8081
]);
8182
gen::write_markdown(doc, std::io::stdout());

0 commit comments

Comments
 (0)