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
|
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
/*!
Divides the document tree into pages.
Each page corresponds is a logical section. There may be pages for
individual modules, pages for the crate, indexes, etc.
*/
use astsrv;
use config;
use doc::ItemUtils;
use doc;
use fold::Fold;
use fold;
use pass::Pass;
use std::comm::*;
use std::task;
use syntax::ast;
#[cfg(test)] use doc::PageUtils;
pub fn mk_pass(output_style: config::OutputStyle) -> Pass {
Pass {
name: ~"page",
f: |srv, doc| run(srv, doc, output_style)
}
}
pub fn run(
_srv: astsrv::Srv,
doc: doc::Doc,
output_style: config::OutputStyle
) -> doc::Doc {
if output_style == config::DocPerCrate {
return doc;
}
let (result_port, result_chan) = stream();
let (page_port, page_chan) = stream();
let page_chan = SharedChan::new(page_chan);
do task::spawn {
result_chan.send(make_doc_from_pages(&page_port));
};
find_pages(doc, page_chan);
result_port.recv()
}
type PagePort = Port<Option<doc::Page>>;
type PageChan = SharedChan<Option<doc::Page>>;
fn make_doc_from_pages(page_port: &PagePort) -> doc::Doc {
let mut pages = ~[];
loop {
let val = page_port.recv();
if val.is_some() {
pages.push(val.unwrap());
} else {
break;
}
}
doc::Doc {
pages: pages
}
}
fn find_pages(doc: doc::Doc, page_chan: PageChan) {
let fold = Fold {
ctxt: page_chan.clone(),
fold_crate: fold_crate,
fold_mod: fold_mod,
fold_nmod: fold_nmod,
.. fold::default_any_fold(page_chan.clone())
};
(fold.fold_doc)(&fold, doc.clone());
page_chan.send(None);
}
fn fold_crate(fold: &fold::Fold<PageChan>, doc: doc::CrateDoc)
-> doc::CrateDoc {
let doc = fold::default_seq_fold_crate(fold, doc);
let page = doc::CratePage(doc::CrateDoc {
topmod: strip_mod(doc.topmod.clone()),
.. doc.clone()
});
fold.ctxt.send(Some(page));
doc
}
fn fold_mod(fold: &fold::Fold<PageChan>, doc: doc::ModDoc) -> doc::ModDoc {
let doc = fold::default_any_fold_mod(fold, doc);
if doc.id() != ast::CRATE_NODE_ID {
let doc = strip_mod(doc.clone());
let page = doc::ItemPage(doc::ModTag(doc));
fold.ctxt.send(Some(page));
}
doc
}
fn strip_mod(doc: doc::ModDoc) -> doc::ModDoc {
doc::ModDoc {
items: do doc.items.iter().filter |item| {
match **item {
doc::ModTag(_) | doc::NmodTag(_) => false,
_ => true
}
}.map(|x| (*x).clone()).collect::<~[doc::ItemTag]>(),
.. doc.clone()
}
}
fn fold_nmod(fold: &fold::Fold<PageChan>, doc: doc::NmodDoc) -> doc::NmodDoc {
let doc = fold::default_seq_fold_nmod(fold, doc);
let page = doc::ItemPage(doc::NmodTag(doc.clone()));
fold.ctxt.send(Some(page));
return doc;
}
#[cfg(test)]
mod test {
use astsrv;
use config;
use attr_pass;
use doc;
use extract;
use prune_hidden_pass;
use page_pass::run;
fn mk_doc_(
output_style: config::OutputStyle,
source: ~str
) -> doc::Doc {
do astsrv::from_str(source.clone()) |srv| {
let doc = extract::from_srv(srv.clone(), ~"");
let doc = (attr_pass::mk_pass().f)(srv.clone(), doc);
let doc = (prune_hidden_pass::mk_pass().f)(srv.clone(), doc);
run(srv.clone(), doc, output_style)
}
}
fn mk_doc(source: ~str) -> doc::Doc {
mk_doc_(config::DocPerMod, source.clone())
}
#[test]
fn should_not_split_the_doc_into_pages_for_doc_per_crate() {
let doc = mk_doc_(
config::DocPerCrate,
~"mod a { } mod b { mod c { } }"
);
assert_eq!(doc.pages.len(), 1u);
}
#[test]
fn should_make_a_page_for_every_mod() {
let doc = mk_doc(~"mod a { }");
// hidden __std_macros module at the start.
assert_eq!(doc.pages.mods()[0].name_(), ~"a");
}
#[test]
fn should_remove_mods_from_containing_mods() {
let doc = mk_doc(~"mod a { }");
assert!(doc.cratemod().mods().is_empty());
}
}
|
