shared/io.github.aplcornell.viaduct.prettyprinting

Package-level declarations

Types

enum AnsiBaseColor : Enum<AnsiBaseColor>

One of the 8 basic colors supported by the ANSI standard.

sealed class AnsiColor

An ANSI 4-bit color.

data class BrightColor(val baseColor: AnsiBaseColor) : AnsiColor

Bright variant of baseColor.

object DefaultColor : AnsiColor

The default foreground or background color.

object DefaultStyle : Style

The default Style.

sealed class Document : PrettyPrintable

Represents a pretty printed document.

data class NormalColor(val baseColor: AnsiBaseColor) : AnsiColor

Normal variant of baseColor.

PrettyPrintable

interface PrettyPrintable

An object that has a pretty text representation.

interface Style

A style describing how text should be printed on an ANSI terminal.

Functions

fun List<PrettyPrintable>.braced(): Document

Like joined but using commas as separators and enclosed in curly braces.

fun List<PrettyPrintable>.bracketed(): Document

Like joined but using commas as separators and enclosed in square brackets.

fun PrettyPrintable.commented(): Document

Like joined but using commas as separators and enclosed in /* and */.

fun List<PrettyPrintable>.concatenated(separator: PrettyPrintable = Document()): Document

Concatenates all the elements together with separators in between.

operator fun PrettyPrintable.div(other: PrettyPrintable): Document

Concatenates this and other with a line break in between.

operator fun PrettyPrintable.div(other: String): Document

Convenience method. See plus.

fun PrettyPrintable.grouped(): Document

Tries laying out this document into a single line by removing the contained Document.lineBreaks (and replacing them with spaces); if this does not fit the page, the document is laid out without any changes. This function is the key to layouts that adapt to available space nicely.

fun List<PrettyPrintable>.joined(separator: PrettyPrintable = Document(","), prefix: PrettyPrintable = Document(), postfix: PrettyPrintable = Document()): Document

Concatenates all the elements separated by separator and enclosed in prefix and postfix.

fun PrettyPrintable.nested(indentationChange: Int = 4): Document

Returns a new document that is this with the nesting level (indentation after newlines) increased by indentationChange. Negative values for indentationChange are allowed, and decrease the nesting level accordingly.

operator fun PrettyPrintable.plus(other: PrettyPrintable): Document

Concatenates this and other.

operator fun PrettyPrintable.plus(other: String): Document

Convenience method that automatically converts other to a Document.

fun PrettyPrintable.styled(style: Style): Document

Returns a new document that is this with style applied.

operator fun PrettyPrintable.times(other: PrettyPrintable): Document

Concatenates this and other with a space in between.

operator fun PrettyPrintable.times(other: String): Document

Convenience method. See plus.

fun List<PrettyPrintable>.tupled(): Document

Like joined but using commas as separators and enclosed in parentheses.

Properties

DEFAULT_LINE_WIDTH

const val DEFAULT_LINE_WIDTH: Int = 80

The maximum number of characters to put on one line.