blob: 2b16112fe16c75751485b66777ae93c3011c3995 (
plain)
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
|
/*!
Attribute parsing
The attribute parser provides methods for pulling documentation out of
an AST's attributes.
*/
use syntax::ast;
use syntax::attr;
use core::tuple;
export CrateAttrs;
export parse_crate, parse_desc;
export parse_hidden;
type CrateAttrs = {
name: Option<~str>
};
#[cfg(test)]
mod test {
#[legacy_exports];
fn parse_attributes(source: ~str) -> ~[ast::attribute] {
use syntax::parse;
use parse::parser;
use parse::attr::parser_attr;
use syntax::codemap;
use syntax::diagnostic;
let parse_sess = syntax::parse::new_parse_sess(None);
let parser = parse::new_parser_from_source_str(
parse_sess, ~[], ~"-", codemap::fss_none, @source);
parser.parse_outer_attributes()
}
}
fn doc_metas(
attrs: ~[ast::attribute]
) -> ~[@ast::meta_item] {
let doc_attrs = attr::find_attrs_by_name(attrs, ~"doc");
let doc_metas = do doc_attrs.map |attr| {
attr::attr_meta(attr::desugar_doc_attr(attr))
};
return doc_metas;
}
fn parse_crate(attrs: ~[ast::attribute]) -> CrateAttrs {
let link_metas = attr::find_linkage_metas(attrs);
{
name: attr::last_meta_item_value_str_by_name(link_metas, ~"name")
}
}
#[test]
fn should_extract_crate_name_from_link_attribute() {
let source = ~"#[link(name = \"snuggles\")]";
let attrs = test::parse_attributes(source);
let attrs = parse_crate(attrs);
assert attrs.name == Some(~"snuggles");
}
#[test]
fn should_not_extract_crate_name_if_no_link_attribute() {
let source = ~"";
let attrs = test::parse_attributes(source);
let attrs = parse_crate(attrs);
assert attrs.name == None;
}
#[test]
fn should_not_extract_crate_name_if_no_name_value_in_link_attribute() {
let source = ~"#[link(whatever)]";
let attrs = test::parse_attributes(source);
let attrs = parse_crate(attrs);
assert attrs.name == None;
}
fn parse_desc(attrs: ~[ast::attribute]) -> Option<~str> {
let doc_strs = do doc_metas(attrs).filter_map |meta| {
attr::get_meta_item_value_str(*meta)
};
if doc_strs.is_empty() {
None
} else {
Some(str::connect(doc_strs, "\n"))
}
}
#[test]
fn parse_desc_should_handle_undocumented_mods() {
let source = ~"";
let attrs = test::parse_attributes(source);
let attrs = parse_desc(attrs);
assert attrs == None;
}
#[test]
fn parse_desc_should_parse_simple_doc_attributes() {
let source = ~"#[doc = \"basic\"]";
let attrs = test::parse_attributes(source);
let attrs = parse_desc(attrs);
assert attrs == Some(~"basic");
}
fn parse_hidden(attrs: ~[ast::attribute]) -> bool {
do doc_metas(attrs).find |meta| {
match attr::get_meta_item_list(meta) {
Some(metas) => {
let hiddens = attr::find_meta_items_by_name(metas, ~"hidden");
vec::is_not_empty(hiddens)
}
None => false
}
}.is_some()
}
#[test]
fn should_parse_hidden_attribute() {
let source = ~"#[doc(hidden)]";
let attrs = test::parse_attributes(source);
assert parse_hidden(attrs) == true;
}
#[test]
fn should_parse_hidden_attribute_with_other_docs() {
let source = ~"#[doc = \"foo\"] #[doc(hidden)] #[doc = \"foo\"]";
let attrs = test::parse_attributes(source);
assert parse_hidden(attrs) == true;
}
#[test]
fn should_not_parse_non_hidden_attribute() {
let source = ~"#[doc = \"\"]";
let attrs = test::parse_attributes(source);
assert parse_hidden(attrs) == false;
}
#[test]
fn should_concatenate_multiple_doc_comments() {
let source = ~"/// foo\n/// bar";
let desc = parse_desc(test::parse_attributes(source));
assert desc == Some(~"foo\nbar");
}
|
