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
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
use super::TreeLines;
use crate::tree::{DModule, DocTree, IDMap, ID};
use rustc_hash::FxHashSet as HashSet;
use rustdoc_types::ItemEnum;
/// how to fold the text tree
#[derive(Default, PartialEq, Eq)]
enum Kind {
/// Expand all public items in all modules.
#[default]
ExpandAll,
/// Only expand items under root module with sub modules folded.
ExpandZero,
/// Expand level zero and one items.
///
/// Level zero refers to items directly under root module.
///
/// Level one refers to items from level-zero modules.
///
/// Items from these two outermost levels may be the most important APIs.
ExpandToFirstLevelModules,
/// Always expand and focus on current module.
///
/// NOTE: this allows all (sub)modules to expand (but with non-module items hidden),
/// because it's helpful for users to not only know the current one, but also quickly
/// jump into any other one.
CurrentModule,
}
/// Fold based on module tree.
#[derive(Default)]
pub struct Fold {
kind: Kind,
/// module IDs that should be expanded
expand: HashSet<ID>,
}
// ─➤ ─⮞ ─▶ ▶
/// Fold a tree.
impl TreeLines {
/// Expand all module items including data structure's impl and trait's implementors.
pub fn expand_all_including_impls(&mut self) {
*self = Self::new_with(self.doc(), |doc| doc.dmodule_show_prettier()).0;
}
pub fn dmodule(&self) -> &DModule {
self.doc.dmodule()
}
pub fn idmap(&self) -> &IDMap {
&self.doc
}
pub fn expand_all(&mut self) {
self._expand_all();
self.lines = self.dmodule().item_tree(self.idmap()).cache_lines().0;
}
pub(super) fn _expand_all(&mut self) {
fn traversal_id(m: &DModule, mods: &mut HashSet<ID>) {
mods.insert(m.id.clone());
for submod in &m.modules {
traversal_id(submod, mods);
}
}
self.fold.kind = Kind::ExpandAll;
self.fold.expand.clear();
traversal_id(self.doc().dmodule(), &mut self.fold.expand);
}
pub fn expand_zero_level(&mut self) {
self.fold.kind = Kind::ExpandZero;
self.fold.expand.clear();
self.fold.expand.insert(self.dmodule().id.clone());
self.update_cached_lines(|dmod, map, _| {
let mut root = dmod.item_tree_only_in_one_specified_mod(map);
root.extend(
dmod.modules
.iter()
.map(|m| node!(ModuleFolded: map, Module, &m.id)),
);
root
});
}
pub fn expand_to_first_level_modules(&mut self) {
self.fold.kind = Kind::ExpandToFirstLevelModules;
let dmod = &self.dmodule().modules;
self.fold.expand = dmod.iter().map(|m| m.id.clone()).collect();
self.update_cached_lines(|dmod, map, mods| {
let mut root = dmod.item_tree_only_in_one_specified_mod(map);
for m in &dmod.modules {
let tree = if mods.contains(&m.id) {
let mut tree = m.item_tree_only_in_one_specified_mod(map);
for submod in &m.modules {
let leaf = node!(ModuleFolded: map, Module, &submod.id);
tree.push(leaf);
}
tree
} else {
node!(ModuleFolded: map, Module, &m.id)
};
root.push(tree);
}
root
});
}
}
impl TreeLines {
/// Expand a folded module or fold an expanded one.
///
/// This pushs a module ID to a without setting any fold kind.
pub fn expand_toggle(&mut self, id: ID) {
fn modules_traversal(
dmod: &DModule,
map: &IDMap,
parent: &mut DocTree,
should_stop: &mut impl FnMut(&DModule) -> bool,
) {
for m in &dmod.modules {
if should_stop(m) {
let node = node!(ModuleFolded: map, Module, &m.id);
parent.push(node);
} else {
let mut node = m.item_tree_only_in_one_specified_mod(map);
modules_traversal(m, map, &mut node, should_stop);
parent.push(node);
};
}
}
if self.fold.kind == Kind::CurrentModule {
// FIXME: poor interaction with CurrentModule bahavior
//
// To fix this, we have to remember all the modules' id and an extra
// expand-vs-fold state.
//
// This is a smallUX improvement, but for now, just forbid toggling
// when expanding CurrentModule.
return;
}
if !self.check_id(&id) {
return;
}
let mods = &mut self.fold.expand;
if mods.contains(&id) {
mods.remove(&id);
} else {
mods.insert(id);
}
self.update_cached_lines(|dmod, map, mods| {
let mut root = dmod.item_tree_only_in_one_specified_mod(map);
modules_traversal(dmod, map, &mut root, &mut |m| !mods.contains(&m.id));
root
});
}
}
impl TreeLines {
pub fn expand_current_module_only(&mut self, id: ID) {
self.fold.kind = Kind::CurrentModule;
if !self.check_id(&id) {
return;
}
self.fold.expand.clear();
self.fold.expand.insert(id);
self._expand_current_module_only();
}
fn _expand_current_module_only(&mut self) {
fn modules_traversal(
dmod: &DModule,
map: &IDMap,
parent: &mut DocTree,
should_stop: &mut impl FnMut(&DModule) -> bool,
) {
for m in &dmod.modules {
if should_stop(m) {
// use long path because it's helpful to instantly know where it is
let mut node = m.item_tree_only_in_one_specified_mod(map);
node.extend(
m.modules
.iter()
.map(|m| node!(@name ModuleFolded: map, &m.id)),
);
parent.push(node);
// NOTE: Stop traverlling down inside but still travel in other modules.
// This is because it's not helpful to only show/know target modules.
} else {
// use short name for non-target modules
let mut node = node!(@name ModuleFolded: map, &m.id);
modules_traversal(m, map, &mut node, should_stop);
parent.push(node);
};
}
}
self.update_cached_lines(|dmod, map, mods| {
let mut root = node!(Module: map, &dmod.id);
if mods.contains(&dmod.id) {
// item tree already contains the root module, thus only mv the leaves
let iter = dmod.item_tree_only_in_one_specified_mod(map).tree.leaves;
root.tree.extend(iter);
}
modules_traversal(dmod, map, &mut root, &mut |m| mods.contains(&m.id));
root
});
}
}
impl TreeLines {
/// check if the id is a module (or reexported as module)
fn check_id(&self, id: &ID) -> bool {
if !self.dmodule().modules.iter().any(|_m| {
// only Module or reexported item as Module can be in list
self.idmap()
.get_item(id)
.map(|item| match &item.inner {
ItemEnum::Module(_) => true,
ItemEnum::Import(reepxort) => {
if let Some(id) = &reepxort.id {
if let Some(item) = self.idmap().get_item(&id.0) {
return matches!(item.inner, ItemEnum::Module(_));
}
}
false
}
_ => false,
})
.unwrap_or(false)
}) {
error!(
"ID({id}) is not a non-module item `{}` {:?}",
self.idmap().name(&id),
self.idmap().get_item(id)
);
return false;
}
true
}
fn update_cached_lines(&mut self, f: impl FnOnce(&DModule, &IDMap, &HashSet<ID>) -> DocTree) {
let map = self.idmap();
let dmod = &self.dmodule();
let mods = &self.fold.expand;
if mods.is_empty() {
// if no mods are sepecified, default to expand all
self.lines = self.dmodule().item_tree(map).cache_lines().0;
return;
}
let root = f(dmod, map, mods);
self.lines = root.cache_lines().0;
}
}