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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
use crate::{visitor::visit_sequence_rev, Doc, DocPtr, Render};
use super::write::{write_newline, BufferWrite};
pub fn print_doc<'a, W, T>(doc: &Doc<'a, T>, width: usize, out: &mut W) -> Result<(), W::Error>
where
T: DocPtr<'a> + 'a,
W: ?Sized + Render,
{
Printer {
pos: 0,
cmds: vec![Cmd {
indent: 0,
mode: Mode::Break,
doc,
}],
fit_docs: vec![],
line_suffixes: vec![],
width,
#[cfg(feature = "contextual")]
temp_arena: &typed_arena::Arena::new(),
}
.print_to(out, PrintState::default())?;
Ok(())
}
#[derive(Clone, Copy, Debug, Eq, Ord, PartialEq, PartialOrd)]
enum Mode {
Break,
Flat,
}
struct Cmd<'d, 'a, T>
where
T: DocPtr<'a> + 'a,
{
indent: usize,
mode: Mode,
doc: &'d Doc<'a, T>,
}
struct FitCmd<'d, 'a, T>
where
T: DocPtr<'a> + 'a,
{
mode: Mode,
doc: &'d Doc<'a, T>,
}
struct Printer<'d, 'a, T>
where
T: DocPtr<'a> + 'a,
{
pos: usize,
cmds: Vec<Cmd<'d, 'a, T>>,
fit_docs: Vec<FitCmd<'d, 'a, T>>,
line_suffixes: Vec<&'d Doc<'a, T>>,
width: usize,
#[cfg(feature = "contextual")]
temp_arena: &'d typed_arena::Arena<T>,
}
#[derive(Default, Clone, Copy)]
struct PrintState {
cmd_top: usize,
line_suffix_top: usize,
}
impl<'d, 'a, T> Printer<'d, 'a, T>
where
T: DocPtr<'a> + 'a,
{
fn print_to<W>(&mut self, out: &mut W, state: PrintState) -> Result<bool, W::Error>
where
W: ?Sized + Render,
{
let PrintState {
cmd_top: top,
line_suffix_top: ls_top,
} = state;
let mut fits = true;
while self.cmds.len() > top {
// Pop the next command
let mut cmd = self.cmds.pop().unwrap();
// Drill down until we hit a leaf or emit something
loop {
let Cmd { indent, mode, doc } = cmd;
match *doc {
Doc::Nil => break,
Doc::Fail => return Err(out.fail_doc()),
Doc::Text(ref s) => {
out.write_str_all(s)?;
self.pos += s.len();
fits &= self.pos <= self.width;
break;
}
Doc::TextWithLen(len, ref inner) => {
// inner must be a text node
let str = match **inner {
Doc::Text(ref s) => s,
_ => unreachable!(),
};
out.write_str_all(str)?;
self.pos += len;
fits &= self.pos <= self.width;
break;
}
Doc::HardLine => {
// flush line suffixes
if self.line_suffixes.len() > ls_top {
self.cmds.push(cmd);
self.push_line_suffixes(ls_top, mode, indent);
break;
}
// The next document may have different indentation so we should use it if
// we can
if let Some(next) = self.cmds.pop() {
write_newline(next.indent, out)?;
self.pos = next.indent;
cmd = next;
} else {
write_newline(indent, out)?;
self.pos = indent;
break;
}
}
Doc::Append(ref left, ref right) => {
// Push children in reverse so we process ldoc before rdoc
cmd.doc = visit_sequence2(left, right, |doc| {
self.cmds.push(Cmd { indent, mode, doc })
});
}
Doc::LineSuffix(ref inner) => {
self.line_suffixes.push(inner);
break;
}
Doc::Nest(offset, ref inner) => {
cmd.indent = indent.saturating_add_signed(offset);
cmd.doc = inner;
}
Doc::DedentToRoot(ref inner) => {
// Dedent to the root level, which is always 0.
cmd.indent = 0;
cmd.doc = inner;
}
Doc::Align(ref inner) => {
// Align to the current position.
cmd.indent = self.pos;
cmd.doc = inner;
}
Doc::ExpandParent => break,
Doc::Flatten(ref inner) => {
cmd.mode = Mode::Flat;
cmd.doc = inner;
}
Doc::BreakOrFlat(ref break_doc, ref flat_doc) => {
cmd.doc = match mode {
Mode::Break => break_doc,
Mode::Flat => flat_doc,
};
}
Doc::Group(ref inner) => {
if mode == Mode::Break && self.fitting(inner, self.pos, indent, Mode::Flat)
{
cmd.mode = Mode::Flat;
}
cmd.doc = inner;
}
Doc::Union(ref left, ref right) => {
if mode == Mode::Flat {
cmd.doc = left;
continue;
}
// Try the left branch in a buffer
let save_pos = self.pos;
let save_state = PrintState {
cmd_top: self.cmds.len(),
line_suffix_top: self.line_suffixes.len(),
};
self.cmds.push(Cmd {
indent,
mode,
doc: left,
});
let mut buffer = BufferWrite::new();
if let Ok(true) = self.print_to(&mut buffer, save_state) {
buffer.render(out)?;
break;
} else {
// Revert and try right
self.pos = save_pos;
self.cmds.truncate(save_state.cmd_top);
self.line_suffixes.truncate(save_state.line_suffix_top);
cmd.doc = right;
}
}
Doc::PartialUnion(ref left, ref right) => {
if mode == Mode::Flat || self.fitting(left, self.pos, indent, Mode::Break) {
cmd.doc = left;
} else {
cmd.doc = right;
}
}
#[cfg(feature = "contextual")]
Doc::OnColumn(ref f) => {
cmd.doc = self.temp_arena.alloc(f(self.pos));
}
#[cfg(feature = "contextual")]
Doc::OnNesting(ref f) => {
cmd.doc = self.temp_arena.alloc(f(indent));
}
}
}
// handle line suffixes when all cleared
if self.cmds.len() == top && self.line_suffixes.len() > ls_top {
self.push_line_suffixes(ls_top, Mode::Break, 0);
}
}
Ok(fits)
}
fn push_line_suffixes(&mut self, ls_top: usize, mode: Mode, indent: usize) {
self.line_suffixes
.drain(ls_top..)
.rev()
.for_each(|doc| self.cmds.push(Cmd { indent, mode, doc }));
}
#[cfg_attr(not(feature = "contextual"), allow(unused_variables))]
fn fitting(&mut self, next: &'d Doc<'a, T>, mut pos: usize, indent: usize, mode: Mode) -> bool {
// We start in "flat" mode and may fall back to "break" mode when backtracking.
let mut cmd_bottom = self.cmds.len();
// fit_docs is our work‐stack for documents to check in flat mode.
self.fit_docs.clear();
self.fit_docs.push(FitCmd { mode, doc: next });
// As long as we have either flat‐stack items or break commands to try...
while cmd_bottom > 0 || !self.fit_docs.is_empty() {
// Pop the next doc to inspect, or backtrack to bcmds in break mode.
let FitCmd { mut mode, mut doc } = self.fit_docs.pop().unwrap_or_else(|| {
cmd_bottom -= 1;
FitCmd {
mode: Mode::Break,
doc: self.cmds[cmd_bottom].doc,
}
});
// Drill into this doc until we either bail or consume a leaf.
loop {
match *doc {
Doc::Nil => break,
Doc::Fail => return false,
Doc::Text(ref s) => {
pos += s.len();
if pos > self.width {
return false;
}
break;
}
Doc::TextWithLen(len, _) => {
pos += len;
if pos > self.width {
return false;
}
break;
}
Doc::HardLine => {
// A hardline only “fits” in break mode.
return mode == Mode::Break;
}
Doc::Append(ref left, ref right) => {
// Push r then l so we process l first.
doc = visit_sequence2(left, right, |doc| {
self.fit_docs.push(FitCmd { mode, doc })
});
}
Doc::LineSuffix(_) => break, // Line suffixes don't affect fitting, skip them entirely
Doc::ExpandParent => {
if mode == Mode::Flat {
return false;
}
break;
}
Doc::Flatten(ref inner) => {
mode = Mode::Flat;
doc = inner;
}
Doc::BreakOrFlat(ref break_doc, ref flat_doc) => {
// Select branch based on current mode.
doc = if mode == Mode::Break {
break_doc
} else {
flat_doc
};
}
Doc::Union(ref inner, _) | Doc::PartialUnion(ref inner, _)
if mode == Mode::Flat =>
{
// In flat mode we only consider the first branch.
doc = inner;
}
Doc::Nest(_, ref inner)
| Doc::DedentToRoot(ref inner)
| Doc::Align(ref inner)
| Doc::Group(ref inner)
| Doc::Union(_, ref inner)
| Doc::PartialUnion(_, ref inner) => {
doc = inner;
}
#[cfg(feature = "contextual")]
Doc::OnColumn(ref f) => {
doc = self.temp_arena.alloc(f(pos));
}
#[cfg(feature = "contextual")]
Doc::OnNesting(ref f) => {
doc = self.temp_arena.alloc(f(indent));
}
}
}
}
// If we've exhausted both fcmds and break_idx, everything fit.
true
}
}
fn visit_sequence2<'a, 'd, T>(
ldoc: &'d Doc<'a, T>,
rdoc: &'d Doc<'a, T>,
mut consumer: impl FnMut(&'d Doc<'a, T>),
) -> &'d Doc<'a, T>
where
T: DocPtr<'a>,
{
let d = visit_sequence_rev(rdoc, &mut consumer);
consumer(d);
visit_sequence_rev(ldoc, &mut consumer)
}