Type:
Class

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:

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?

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@m17n.org>

new
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::SingleLine

new(output, maxwidth=nil, newline=nil) Class Public methods

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::Breakable

new(sep, width, q) Class Public methods

2025-01-10 15:47:30
output
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::Text

output(out, output_width) Instance Public methods

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::GroupQueue

new(*groups) Class Public methods

2025-01-10 15:47:30
output
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::Breakable

output(out, output_width) Instance Public methods

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::Text

new() Class Public methods

2025-01-10 15:47:30
break?
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::Group

break?() Instance Public methods

2025-01-10 15:47:30
new
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::Group

new(depth) Class Public methods

2025-01-10 15:47:30
add
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::Text

add(obj, width) Instance Public methods

2025-01-10 15:47:30
nest
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint/PrettyPrint::SingleLine

nest(indent) Instance Public methods

2025-01-10 15:47:30