MENU
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>

format
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint

format(output='', maxwidth=79, newline="\n", genspace=lambda {|n| ' ' * n}) Class Public methods

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

first?() Instance Public methods

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

delete(group) Instance Public methods

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

new(output='', maxwidth=79, newline="\n", &genspace) Class Public methods Creates

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

singleline_format(output='', maxwidth=nil, newline=nil, genspace=nil) Class Public methods

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

enq(group) Instance 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
first?
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint

first?() Instance Public methods first? is a predicate to test the call is a

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

fill_breakable(sep=' ', width=sep.length) Instance Public methods This is similar

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

flush() Instance Public methods outputs buffered data.

2025-01-10 15:47:30