PrettyPrint

このクラスは pretty printing アルゴリズムの実装です。改行の位置を探し、構造のまとまりのためにきれいなインデントを施します。

デフォルトでは、このクラスは最も基本的な要素は文字列であり、その1バイトが出力幅の中で1カラムを占めると仮定しています。しかし、いくつかのメソッドに対して適切な引数を与えることで、そうでない状況にも利用できます: PrettyPrint.new には改行オブジェクトと空白の生成を表すブロックを、 PrettyPrint#text や PrettyPrint#breakable には幅といった具合に。これらを使ういくつかの候補は例えば次のようなものでしょう。 proportional font を使ったテキストの整形、出力幅とバイト数が異なるような多バイト文字、文字以外の出力などです。

class methods

PrettyPrint.new([output[, maxwidth[, newline]]]) [{|width| ...}]

pretty printing のためのバッファを生成します。

output は出力先で、もし指定されなければ '' が仮定されます。このオブジェクトは次のものを受け付ける << メソッドを持っていなければなりません。それは、 PrettyPrint#text の第1引数 obj、 PrettyPrint#breakable の第1引数 sep、 PrettyPrint.new の第1引数 newline および PrettyPrint.new に与えられたブロックを評価した結果です。

maxwidth は行の最大幅を指定します。与えられない場合は 79 が仮定されます。ただし、改行できないものが渡された場合は実際の出力幅は maxwidth を越えることがあります。

newline は改行に使われます。指定されない場合は "\n" が仮定されます。

ブロックは空白を生成します。指定されない場合は {|width| ' ' * width} が使われます。

PrettyPrint.format([output[, maxwidth[, newline[, genspace]]]]) {|pp| ...}

以下と同じ働きをするもので簡便のために用意されています。

begin
  pp = PrettyPrint.new(output, maxwidth, newline, &genspace)
  ...
  pp.flush
  output
end

PrettyPrint.singleline_format([output[, maxwidth[, newline[, genspace]]]]) {|pp| ...}

PrettyPrint.format に似ていますが、改行しません。引数 maxwidth, newline と genspace は無視されます。ブロック中の breakable の実行は、改行せずに text の実行であるかのように扱います。

methods

text(obj[, width])

obj を width カラムのテキストとして追加します。

width が指定されなかった場合、obj.length が利用されます。

breakable([sep[, width]])

「必要ならここで改行出来る」ということを通知します。もしその位置で改行されなければ、 widthカラムのテキスト sep がそこに挿入されます。

sep が指定されなければ " " が利用されます。

width が指定されなければ、sep.length が利用されます。例えば sep が多バイト文字の際に指定する必要があるかも知れません。

nest(indent) {...}

ブロックの中で追加された改行の後の左マージンを indent ぶんだけ増加させます。

group([indent[, open_obj[, close_obj[, open_width[, close_width]]]]]) {...}

ブロック内で追加された改行のヒントをグループ化します。

indent が指定された場合、このメソッド呼び出しは nest(indent) { ... } でネストしているものとして扱われます。

open_obj が指定された場合、text open_obj, open_width が最初に呼ばれます。 close_obj が指定された場合、text close_obj, close_width が最後に呼ばれます。

flush

バッファされたデータを出力します。

first?

現在のグループで first? に対する最初の呼び出しかどうかを判定する述語です。これはカンマで区切られた値を整形するのに有用です。

pp.group(1, '[', ']') {
  xxx.each {|yyy|
    unless pp.first?
      pp.text ','
      pp.breakable
    end
    ... pretty printing yyy ...
  }
}

Bugs

箱指向の整形? 他のアルゴリズム?

References

Christian Lindig, Strictly Pretty, March 2000, <URL:http://www.st.cs.uni-sb.de/~lindig/papers/pretty/strictly-pretty.html>

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