rust/src/libsyntax/print/pp.rs

606 lines
22 KiB
Rust

// 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.
use core::prelude::*;
use core::cmp;
use core::dvec::DVec;
use core::io::WriterUtil;
use core::io;
use core::str;
use core::vec;
/*
* This pretty-printer is a direct reimplementation of Philip Karlton's
* Mesa pretty-printer, as described in appendix A of
*
* STAN-CS-79-770: "Pretty Printing", by Derek C. Oppen.
* Stanford Department of Computer Science, 1979.
*
* The algorithm's aim is to break a stream into as few lines as possible
* while respecting the indentation-consistency requirements of the enclosing
* block, and avoiding breaking at silly places on block boundaries, for
* example, between "x" and ")" in "x)".
*
* I am implementing this algorithm because it comes with 20 pages of
* documentation explaining its theory, and because it addresses the set of
* concerns I've seen other pretty-printers fall down on. Weirdly. Even though
* it's 32 years old. What can I say?
*
* Despite some redundancies and quirks in the way it's implemented in that
* paper, I've opted to keep the implementation here as similar as I can,
* changing only what was blatantly wrong, a typo, or sufficiently
* non-idiomatic rust that it really stuck out.
*
* In particular you'll see a certain amount of churn related to INTEGER vs.
* CARDINAL in the Mesa implementation. Mesa apparently interconverts the two
* somewhat readily? In any case, I've used uint for indices-in-buffers and
* ints for character-sizes-and-indentation-offsets. This respects the need
* for ints to "go negative" while carrying a pending-calculation balance, and
* helps differentiate all the numbers flying around internally (slightly).
*
* I also inverted the indentation arithmetic used in the print stack, since
* the Mesa implementation (somewhat randomly) stores the offset on the print
* stack in terms of margin-col rather than col itself. I store col.
*
* I also implemented a small change in the STRING token, in that I store an
* explicit length for the string. For most tokens this is just the length of
* the accompanying string. But it's necessary to permit it to differ, for
* encoding things that are supposed to "go on their own line" -- certain
* classes of comment and blank-line -- where relying on adjacent
* hardbreak-like BREAK tokens with long blankness indication doesn't actually
* work. To see why, consider when there is a "thing that should be on its own
* line" between two long blocks, say functions. If you put a hardbreak after
* each function (or before each) and the breaking algorithm decides to break
* there anyways (because the functions themselves are long) you wind up with
* extra blank lines. If you don't put hardbreaks you can wind up with the
* "thing which should be on its own line" not getting its own line in the
* rare case of "really small functions" or such. This re-occurs with comments
* and explicit blank lines. So in those cases we use a string with a payload
* we want isolated to a line and an explicit length that's huge, surrounded
* by two zero-length breaks. The algorithm will try its best to fit it on a
* line (which it can't) and so naturally place the content on its own line to
* avoid combining it with other lines and making matters even worse.
*/
#[deriving_eq]
pub enum breaks { consistent, inconsistent, }
pub struct break_t {
offset: int,
blank_space: int
}
pub struct begin_t {
offset: int,
breaks: breaks
}
pub enum token {
STRING(@~str, int),
BREAK(break_t),
BEGIN(begin_t),
END,
EOF,
}
pub impl token {
fn is_eof(&self) -> bool {
match *self { EOF => true, _ => false }
}
fn is_hardbreak_tok(&self) -> bool {
match *self {
BREAK(break_t {
offset: 0,
blank_space: bs
}) if bs == size_infinity =>
true,
_ =>
false
}
}
}
pub fn tok_str(++t: token) -> ~str {
match t {
STRING(s, len) => return fmt!("STR(%s,%d)", *s, len),
BREAK(_) => return ~"BREAK",
BEGIN(_) => return ~"BEGIN",
END => return ~"END",
EOF => return ~"EOF"
}
}
pub fn buf_str(toks: ~[token], szs: ~[int], left: uint, right: uint,
lim: uint) -> ~str {
let n = vec::len(toks);
assert (n == vec::len(szs));
let mut i = left;
let mut L = lim;
let mut s = ~"[";
while i != right && L != 0u {
L -= 1u;
if i != left { s += ~", "; }
s += fmt!("%d=%s", szs[i], tok_str(toks[i]));
i += 1u;
i %= n;
}
s += ~"]";
return s;
}
pub enum print_stack_break { fits, broken(breaks), }
pub struct print_stack_elt {
offset: int,
pbreak: print_stack_break
}
pub const size_infinity: int = 0xffff;
pub fn mk_printer(out: @io::Writer, linewidth: uint) -> @mut Printer {
// Yes 3, it makes the ring buffers big enough to never
// fall behind.
let n: uint = 3 * linewidth;
debug!("mk_printer %u", linewidth);
let mut token: ~[token] = vec::from_elem(n, EOF);
let mut size: ~[int] = vec::from_elem(n, 0);
let mut scan_stack: ~[uint] = vec::from_elem(n, 0u);
@mut Printer {
out: @out,
buf_len: n,
margin: linewidth as int,
space: linewidth as int,
left: 0,
right: 0,
token: token,
size: size,
left_total: 0,
right_total: 0,
scan_stack: scan_stack,
scan_stack_empty: true,
top: 0,
bottom: 0,
print_stack: @mut ~[],
pending_indentation: 0
}
}
/*
* In case you do not have the paper, here is an explanation of what's going
* on.
*
* There is a stream of input tokens flowing through this printer.
*
* The printer buffers up to 3N tokens inside itself, where N is linewidth.
* Yes, linewidth is chars and tokens are multi-char, but in the worst
* case every token worth buffering is 1 char long, so it's ok.
*
* Tokens are STRING, BREAK, and BEGIN/END to delimit blocks.
*
* BEGIN tokens can carry an offset, saying "how far to indent when you break
* inside here", as well as a flag indicating "consistent" or "inconsistent"
* breaking. Consistent breaking means that after the first break, no attempt
* will be made to flow subsequent breaks together onto lines. Inconsistent
* is the opposite. Inconsistent breaking example would be, say:
*
* foo(hello, there, good, friends)
*
* breaking inconsistently to become
*
* foo(hello, there
* good, friends);
*
* whereas a consistent breaking would yield:
*
* foo(hello,
* there
* good,
* friends);
*
* That is, in the consistent-break blocks we value vertical alignment
* more than the ability to cram stuff onto a line. But in all cases if it
* can make a block a one-liner, it'll do so.
*
* Carrying on with high-level logic:
*
* The buffered tokens go through a ring-buffer, 'tokens'. The 'left' and
* 'right' indices denote the active portion of the ring buffer as well as
* describing hypothetical points-in-the-infinite-stream at most 3N tokens
* apart (i.e. "not wrapped to ring-buffer boundaries"). The paper will switch
* between using 'left' and 'right' terms to denote the wrapepd-to-ring-buffer
* and point-in-infinite-stream senses freely.
*
* There is a parallel ring buffer, 'size', that holds the calculated size of
* each token. Why calculated? Because for BEGIN/END pairs, the "size"
* includes everything betwen the pair. That is, the "size" of BEGIN is
* actually the sum of the sizes of everything between BEGIN and the paired
* END that follows. Since that is arbitrarily far in the future, 'size' is
* being rewritten regularly while the printer runs; in fact most of the
* machinery is here to work out 'size' entries on the fly (and give up when
* they're so obviously over-long that "infinity" is a good enough
* approximation for purposes of line breaking).
*
* The "input side" of the printer is managed as an abstract process called
* SCAN, which uses 'scan_stack', 'scan_stack_empty', 'top' and 'bottom', to
* manage calculating 'size'. SCAN is, in other words, the process of
* calculating 'size' entries.
*
* The "output side" of the printer is managed by an abstract process called
* PRINT, which uses 'print_stack', 'margin' and 'space' to figure out what to
* do with each token/size pair it consumes as it goes. It's trying to consume
* the entire buffered window, but can't output anything until the size is >=
* 0 (sizes are set to negative while they're pending calculation).
*
* So SCAN takeks input and buffers tokens and pending calculations, while
* PRINT gobbles up completed calculations and tokens from the buffer. The
* theory is that the two can never get more than 3N tokens apart, because
* once there's "obviously" too much data to fit on a line, in a size
* calculation, SCAN will write "infinity" to the size and let PRINT consume
* it.
*
* In this implementation (following the paper, again) the SCAN process is
* the method called 'pretty_print', and the 'PRINT' process is the method
* called 'print'.
*/
pub struct Printer {
out: @@io::Writer,
buf_len: uint,
margin: int, // width of lines we're constrained to
space: int, // number of spaces left on line
left: uint, // index of left side of input stream
right: uint, // index of right side of input stream
token: ~[token], // ring-buffr stream goes through
size: ~[int], // ring-buffer of calculated sizes
left_total: int, // running size of stream "...left"
right_total: int, // running size of stream "...right"
// pseudo-stack, really a ring too. Holds the
// primary-ring-buffers index of the BEGIN that started the
// current block, possibly with the most recent BREAK after that
// BEGIN (if there is any) on top of it. Stuff is flushed off the
// bottom as it becomes irrelevant due to the primary ring-buffer
// advancing.
scan_stack: ~[uint],
scan_stack_empty: bool, // top==bottom disambiguator
top: uint, // index of top of scan_stack
bottom: uint, // index of bottom of scan_stack
// stack of blocks-in-progress being flushed by print
print_stack: @mut ~[print_stack_elt],
// buffered indentation to avoid writing trailing whitespace
pending_indentation: int,
}
pub impl Printer {
fn last_token(&mut self) -> token { self.token[self.right] }
// be very careful with this!
fn replace_last_token(&mut self, t: token) { self.token[self.right] = t; }
fn pretty_print(&mut self, t: token) {
debug!("pp ~[%u,%u]", self.left, self.right);
match t {
EOF => {
if !self.scan_stack_empty {
self.check_stack(0);
self.advance_left(self.token[self.left],
self.size[self.left]);
}
self.indent(0);
}
BEGIN(b) => {
if self.scan_stack_empty {
self.left_total = 1;
self.right_total = 1;
self.left = 0u;
self.right = 0u;
} else { self.advance_right(); }
debug!("pp BEGIN(%d)/buffer ~[%u,%u]",
b.offset, self.left, self.right);
self.token[self.right] = t;
self.size[self.right] = -self.right_total;
self.scan_push(self.right);
}
END => {
if self.scan_stack_empty {
debug!("pp END/print ~[%u,%u]", self.left, self.right);
self.print(t, 0);
} else {
debug!("pp END/buffer ~[%u,%u]", self.left, self.right);
self.advance_right();
self.token[self.right] = t;
self.size[self.right] = -1;
self.scan_push(self.right);
}
}
BREAK(b) => {
if self.scan_stack_empty {
self.left_total = 1;
self.right_total = 1;
self.left = 0u;
self.right = 0u;
} else { self.advance_right(); }
debug!("pp BREAK(%d)/buffer ~[%u,%u]",
b.offset, self.left, self.right);
self.check_stack(0);
self.scan_push(self.right);
self.token[self.right] = t;
self.size[self.right] = -self.right_total;
self.right_total += b.blank_space;
}
STRING(s, len) => {
if self.scan_stack_empty {
debug!("pp STRING('%s')/print ~[%u,%u]",
*s, self.left, self.right);
self.print(t, len);
} else {
debug!("pp STRING('%s')/buffer ~[%u,%u]",
*s, self.left, self.right);
self.advance_right();
self.token[self.right] = t;
self.size[self.right] = len;
self.right_total += len;
self.check_stream();
}
}
}
}
fn check_stream(&mut self) {
debug!("check_stream ~[%u, %u] with left_total=%d, right_total=%d",
self.left, self.right, self.left_total, self.right_total);
if self.right_total - self.left_total > self.space {
debug!("scan window is %d, longer than space on line (%d)",
self.right_total - self.left_total, self.space);
if !self.scan_stack_empty {
if self.left == self.scan_stack[self.bottom] {
debug!("setting %u to infinity and popping", self.left);
self.size[self.scan_pop_bottom()] = size_infinity;
}
}
self.advance_left(self.token[self.left], self.size[self.left]);
if self.left != self.right { self.check_stream(); }
}
}
fn scan_push(&mut self, x: uint) {
debug!("scan_push %u", x);
if self.scan_stack_empty {
self.scan_stack_empty = false;
} else {
self.top += 1u;
self.top %= self.buf_len;
assert (self.top != self.bottom);
}
self.scan_stack[self.top] = x;
}
fn scan_pop(&mut self) -> uint {
assert (!self.scan_stack_empty);
let x = self.scan_stack[self.top];
if self.top == self.bottom {
self.scan_stack_empty = true;
} else { self.top += self.buf_len - 1u; self.top %= self.buf_len; }
return x;
}
fn scan_top(&mut self) -> uint {
assert (!self.scan_stack_empty);
return self.scan_stack[self.top];
}
fn scan_pop_bottom(&mut self) -> uint {
assert (!self.scan_stack_empty);
let x = self.scan_stack[self.bottom];
if self.top == self.bottom {
self.scan_stack_empty = true;
} else { self.bottom += 1u; self.bottom %= self.buf_len; }
return x;
}
fn advance_right(&mut self) {
self.right += 1u;
self.right %= self.buf_len;
assert (self.right != self.left);
}
fn advance_left(&mut self, ++x: token, L: int) {
debug!("advnce_left ~[%u,%u], sizeof(%u)=%d", self.left, self.right,
self.left, L);
if L >= 0 {
self.print(x, L);
match x {
BREAK(b) => self.left_total += b.blank_space,
STRING(_, len) => { assert (len == L); self.left_total += len; }
_ => ()
}
if self.left != self.right {
self.left += 1u;
self.left %= self.buf_len;
self.advance_left(self.token[self.left],
self.size[self.left]);
}
}
}
fn check_stack(&mut self, k: int) {
if !self.scan_stack_empty {
let x = self.scan_top();
match copy self.token[x] {
BEGIN(_) => {
if k > 0 {
self.size[self.scan_pop()] = self.size[x] +
self.right_total;
self.check_stack(k - 1);
}
}
END => {
// paper says + not =, but that makes no sense.
self.size[self.scan_pop()] = 1;
self.check_stack(k + 1);
}
_ => {
self.size[self.scan_pop()] = self.size[x] + self.right_total;
if k > 0 { self.check_stack(k); }
}
}
}
}
fn print_newline(&mut self, amount: int) {
debug!("NEWLINE %d", amount);
(*self.out).write_str(~"\n");
self.pending_indentation = 0;
self.indent(amount);
}
fn indent(&mut self, amount: int) {
debug!("INDENT %d", amount);
self.pending_indentation += amount;
}
fn get_top(&mut self) -> print_stack_elt {
let n = self.print_stack.len();
if n != 0u {
self.print_stack[n - 1u]
} else {
print_stack_elt {
offset: 0,
pbreak: broken(inconsistent)
}
}
}
fn print_str(&mut self, s: ~str) {
while self.pending_indentation > 0 {
(*self.out).write_str(~" ");
self.pending_indentation -= 1;
}
(*self.out).write_str(s);
}
fn print(&mut self, x: token, L: int) {
debug!("print %s %d (remaining line space=%d)", tok_str(x), L,
self.space);
log(debug, buf_str(copy self.token,
copy self.size,
self.left,
self.right,
6u));
match x {
BEGIN(b) => {
if L > self.space {
let col = self.margin - self.space + b.offset;
debug!("print BEGIN -> push broken block at col %d", col);
self.print_stack.push(print_stack_elt {
offset: col,
pbreak: broken(b.breaks)
});
} else {
debug!("print BEGIN -> push fitting block");
self.print_stack.push(print_stack_elt {
offset: 0,
pbreak: fits
});
}
}
END => {
debug!("print END -> pop END");
assert (self.print_stack.len() != 0u);
self.print_stack.pop();
}
BREAK(b) => {
let top = self.get_top();
match top.pbreak {
fits => {
debug!("print BREAK(%d) in fitting block", b.blank_space);
self.space -= b.blank_space;
self.indent(b.blank_space);
}
broken(consistent) => {
debug!("print BREAK(%d+%d) in consistent block",
top.offset, b.offset);
self.print_newline(top.offset + b.offset);
self.space = self.margin - (top.offset + b.offset);
}
broken(inconsistent) => {
if L > self.space {
debug!("print BREAK(%d+%d) w/ newline in inconsistent",
top.offset, b.offset);
self.print_newline(top.offset + b.offset);
self.space = self.margin - (top.offset + b.offset);
} else {
debug!("print BREAK(%d) w/o newline in inconsistent",
b.blank_space);
self.indent(b.blank_space);
self.space -= b.blank_space;
}
}
}
}
STRING(s, len) => {
debug!("print STRING(%s)", *s);
assert (L == len);
// assert L <= space;
self.space -= len;
self.print_str(*s);
}
EOF => {
// EOF should never get here.
fail!();
}
}
}
}
// Convenience functions to talk to the printer.
pub fn box(p: @mut Printer, indent: uint, b: breaks) {
p.pretty_print(BEGIN(begin_t {
offset: indent as int,
breaks: b
}));
}
pub fn ibox(p: @mut Printer, indent: uint) { box(p, indent, inconsistent); }
pub fn cbox(p: @mut Printer, indent: uint) { box(p, indent, consistent); }
pub fn break_offset(p: @mut Printer, n: uint, off: int) {
p.pretty_print(BREAK(break_t {
offset: off,
blank_space: n as int
}));
}
pub fn end(p: @mut Printer) { p.pretty_print(END); }
pub fn eof(p: @mut Printer) { p.pretty_print(EOF); }
pub fn word(p: @mut Printer, wrd: ~str) {
p.pretty_print(STRING(@wrd, str::len(wrd) as int));
}
pub fn huge_word(p: @mut Printer, wrd: ~str) {
p.pretty_print(STRING(@wrd, size_infinity));
}
pub fn zero_word(p: @mut Printer, wrd: ~str) {
p.pretty_print(STRING(@wrd, 0));
}
pub fn spaces(p: @mut Printer, n: uint) { break_offset(p, n, 0); }
pub fn zerobreak(p: @mut Printer) { spaces(p, 0u); }
pub fn space(p: @mut Printer) { spaces(p, 1u); }
pub fn hardbreak(p: @mut Printer) { spaces(p, size_infinity as uint); }
pub fn hardbreak_tok_offset(off: int) -> token {
BREAK(break_t {offset: off, blank_space: size_infinity})
}
pub fn hardbreak_tok() -> token { return hardbreak_tok_offset(0); }
//
// Local Variables:
// mode: rust
// fill-column: 78;
// indent-tabs-mode: nil
// c-basic-offset: 4
// buffer-file-coding-system: utf-8-unix
// End:
//