class PrettyPrint

Overview

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

References

Defined in:

pretty_print.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Reference

==(other : self)
==(other : JSON::Any)
==(other : YAML::Any)
==(other)
==
, dup dup, hash(hasher) hash, inspect(io : IO) : Nil inspect, object_id : UInt64 object_id, pretty_print(pp) : Nil pretty_print, same?(other : Reference)
same?(other : Nil)
same?
, to_s(io : IO) : Nil to_s

Constructor methods inherited from class Reference

new new

Instance methods inherited from class Object

! : Bool !, !=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)
===(other : YAML::Any)
===(other)
===
, =~(other) =~, as(type : Class) as, as?(type : Class) as?, class class, dup dup, hash
hash(hasher)
hash
, inspect(io : IO) : Nil
inspect : String
inspect
, is_a?(type : Class) : Bool is_a?, itself itself, nil? : Bool nil?, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, responds_to?(name : Symbol) : Bool responds_to?, tap(&) tap, to_json(io : IO)
to_json
to_json
, to_pretty_json(indent : String = " ")
to_pretty_json(io : IO, indent : String = " ")
to_pretty_json
, to_s : String
to_s(io : IO) : Nil
to_s
, to_yaml(io : IO)
to_yaml
to_yaml
, try(&) try, unsafe_as(type : T.class) forall T unsafe_as

Constructor methods inherited from class Object

from_json(string_or_io, root : String) : self
from_json(string_or_io) : self
from_json
, from_yaml(string_or_io : String | IO) : self from_yaml

Constructor Detail

def self.new(output : IO, maxwidth = 79, newline = "\n", indent = 0) #

Creates a new pretty printer that will write to the given output and be capped at maxwidth.


[View source]

Class Method Detail

def self.format(obj, io : IO, width : Int32, newline = "\n", indent = 0) #

Pretty prints obj into io with the given width as a limit and starting with the given indentation.


[View source]
def self.format(io : IO, width : Int32, newline = "\n", indent = 0, &) #

Creates a pretty printer and yields it to the block, appending any output to the given io.


[View source]

Instance Method Detail

def breakable(sep = " ") #

Appends an element that can turn into a newline if necessary.


[View source]
def comma #

Same as:

text ","
breakable

[View source]
def fill_breakable(sep = " ") #

Similar to #breakable except the decision to break or not is determined individually.


[View source]
def flush #

Outputs any buffered data.


[View source]
def group(indent = 0, open_obj = "", close_obj = "", &) #

Creates a group of objects. Inside a group all breakable objects are either turned into newlines or are output as is, depending on the available width.


[View source]
def list(left, elements, right, &) : Nil #

Appends a list of elements surrounded by left and right and separated by commas, yielding each element to the given block.


[View source]
def list(left, elements, right) : Nil #

Appends a list of elements surrounded by left and right and separated by commas.


[View source]
def nest(indent = 1, &) #

Increases the indentation for breakables inside the current group.


[View source]
def surround(left, right, left_break = "", right_break = "", &) : Nil #

Appends a group that is surrounded by the given left and right objects, and optionally is surrounded by the given breakable objects.


[View source]
def text(obj) #

Appends a text element.


[View source]