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>

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
group
  • References/Ruby on Rails/Ruby/Classes/PrettyPrint

group(indent=0, open_obj='', close_obj='', open_width=open_obj.length, close_width=close_obj.length) Instance Public

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

group_sub() Instance Public methods

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

breakable(sep=' ', width=sep.length) Instance Public methods This says âyou

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

break_outmost_groups() Instance Public methods Breaks the buffer into lines

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

text(obj, width=obj.length) Instance Public methods This adds obj

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

nest(indent) Instance Public methods Increases left margin after newline with

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

group(indent=nil, open_obj='', close_obj='', open_width=nil, close_width=nil) Instance Public methods

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

breakable(sep=' ', width=nil) Instance Public methods

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

deq() Instance Public methods

2025-01-10 15:47:30