Reference

ColorPreference

The color preference type.

ColorPreference(;kw...)

See pprint for available keyword configurations.

GarishIO{IO_t <: IO} <: IO

GarishIO contains the pretty printing preference and states.

Members

• bland_io::IO_t: the original io.
• indent::Int: indentation size.
• compact::Bool: whether the printing should be compact.
• displaysize::Tuple{Int, Int}: the terminal displaysize.
• show_indent: print the indentation hint or not.
• color: color preference, either ColorPreference or nothing for no color.
• state: the state of the printer, see PrintState.

GarishIO(io::IO, garish_io::GarishIO; kw...)

Create a new similar GarishIO with new bland IO object io based on an existing garish io preference. The preference can be overloaded by kw. See pprint for the available keyword arguments.

GarishIO(io::IO; kw...)

See pprint for available keywords.

@enum PrintType

PrintType to tell lower level printing some useful context. Currently only supports Unknown and StructField.

default_colors_256()

The default color 256 theme.

default_colors_ansi()

The default ANSI color theme.

pprint_list_like(io::GarishIO, list, opn='[', cls=']'; compact::Bool=io.compact)

Print a list-like object list. A list-like object should support the iterable interface such as Base.iterate and Base.length. This is modified based on base/arrayshow.jl:show_vector.

Arguments

• io::GarishIO: the GarishIO object one wants to print to.
• list: the list-like object.
• opn: the openning marker, default is [.
• cls: the closing marker, default is ].

Keyword Arguments

• compact::Bool: print the list within one line or not.

pprint_struct([io::IO=stdout], [mimetype], x; kw...)

Pretty print object x that is a struct type (isstructtype returns true).

Keyword Arguments

See pprint, they share the same keyword arguments.

pprint_struct(io, ::MIME"text/plain", @nospecialize(x))

Print x as a struct type with mime type MIME"text/plain".

print_indent(io::GarishIO)

Print an indentation. This should be only used under MIME"text/plain" or equivalent.

print_operator(io::GarishIO, op)

Print an operator, such as =, +, => etc. This should be only used under MIME"text/plain" or equivalent.

print_token(f, io::GarishIO, type::Symbol, xs...)

Print xs to a GarishIO as given token type using f(io, xs...)

print_token(io::GarishIO, type::Symbol, xs...)

Print xs to a GarishIO as given token type. The token type should match the field name of ColorPreference.

supports_color256()

Check if the terminal supports color 256.

tty_has_color()

Check if TTY supports color. This is mainly for lower Julia version like 1.0.

within_nextlevel(f, io::GarishIO)

Run f() within the next level of indentation where f is a function that print into io.