PrettyPrint
class PrettyPrint
Overview
This class implements a pretty printing algorithm. It finds line breaks and nice indentations for grouped structure.
References
- Ruby's prettyprint.rb
- Christian Lindig, Strictly Pretty, March 2000
- Philip Wadler, A prettier printer, March 1998
Defined in:
pretty_print.crClass Method Summary
- .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.
- .format(io : IO, width : Int32, newline = "\n", indent = 0, &block)
Creates a pretty printer and yields it to the block, appending any output to the given io.
- .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.
Instance Method Summary
- #breakable(sep = " ")
Appends an element that can turn into a newline if necessary.
- #comma
Same as:
- #fill_breakable(sep = " ")
Similar to
#breakable
except the decision to break or not is determined individually. - #flush
Outputs any buffered data.
- #group(indent = 0, open_obj = "", close_obj = "", &block)
Creates a group of objects.
- #list(left, elements, right, &block) : Nil
Appends a list of elements surrounded by left and right and separated by commas, yielding each element to the given block.
- #list(left, elements, right) : Nil
Appends a list of elements surrounded by left and right and separated by commas.
- #nest(indent = 1, &block)
Increases the indentation for breakables inside the current group.
- #surround(left, right, left_break = "", right_break = "", &block) : Nil
Appends a group that is surrounded by the given left and right objects, and optionally is surrounded by the given breakable objects.
- #text(obj)
Appends a text element.
Instance methods inherited from class Reference
==(other : self)==(other) ==, dup dup, hash 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
Class methods inherited from class Reference
new new Instance methods inherited from class Object
!=(other) !=, !~(other) !~, ==(other) ==, ===(other : JSON::Any)===(other : YAML::Any)
===(other) ===, =~(other) =~, class class, dup dup, hash hash, inspect(io : IO)
inspect inspect, itself itself, not_nil! not_nil!, pretty_inspect(width = 79, newline = "\n", indent = 0) : String pretty_inspect, pretty_print(pp : PrettyPrint) : Nil pretty_print, tap(&block) 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
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try
Class methods inherited from class Object
from_json(string_or_io, root : String) : selffrom_json(string_or_io) : self from_json, from_yaml(string_or_io) : self from_yaml
Class Method Detail
def self.format(obj, io : IO, width : Int32, newline = "\n", indent = 0)Source
Pretty prints obj into io with the given width as a limit and starting with the given indentation.
def self.format(io : IO, width : Int32, newline = "\n", indent = 0, &block)Source
Creates a pretty printer and yields it to the block, appending any output to the given io.
def self.new(output : IO, maxwidth = 79, newline = .html?lang=en"\n", indent = 0)Source
Creates a new pretty printer that will write to the given output and be capped at maxwidth.
Instance Method Detail
def breakable(sep = " ")Source
Appends an element that can turn into a newline if necessary.
def commaSource
Same as:
text "," breakable
def fill_breakable(sep = " ")Source
Similar to #breakable
except the decision to break or not is determined individually.
def flushSource
Outputs any buffered data.
def group(indent = 0, open_obj = "", close_obj = "", &block)Source
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.
def list(left, elements, right, &block) : NilSource
Appends a list of elements surrounded by left and right and separated by commas, yielding each element to the given block.
def list(left, elements, right) : NilSource
Appends a list of elements surrounded by left and right and separated by commas.
def nest(indent = 1, &block)Source
Increases the indentation for breakables inside the current group.
def surround(left, right, left_break = "", right_break = "", &block) : NilSource
Appends a group that is surrounded by the given left and right objects, and optionally is surrounded by the given breakable objects.
def text(obj)Source
Appends a text element.
© 2012–2017 Manas Technology Solutions.
Licensed under the Apache License, Version 2.0.
https://crystal-lang.org/api/0.22.0/PrettyPrint.html