File: prettyprint.rb [prettyprint: Ruby Standard Library Documentation]

Last Modified
  2019-05-06 17:15:13 -0500
Requires

## Description

This class implements a pretty printing algorithm. It finds line breaks and nice indentations for grouped structure.

By default, the class assumes that primitive elements are strings and each byte in the strings have single column in width. But it can be used for other situations by giving suitable arguments for some methods:

- newline object and space generation block for PrettyPrint.new

- optional width argument for PrettyPrint#text

- PrettyPrint#breakable

There are several candidate uses:

- text formatting using proportional fonts

- multibyte characters which has columns different to number of bytes

- non-string formatting

## Bugs¶ ↑

- Box based formatting?

- Other (better) model/algorithm?

Report any bugs at bugs.ruby-lang.org

## References¶ ↑

Christian Lindig, Strictly Pretty, March 2000, www.st.cs.uni-sb.de/~lindig/papers/#pretty

Philip Wadler, A prettier printer, March 1998, homepages.inf.ed.ac.uk/wadler/topics/language-design.html#prettier

## Author¶ ↑

Tanaka Akira <akr@fsij.org>