korge-foundation/korlibs.logger/AnsiEscape

AnsiEscape

Supports generating AnsiEscape escape codes. This allows to change the color and attributes of the text.

For example:

println(AnsiEscape { ("hello".red + " world".blue).bold })

Inheritors

Companion

BaseConsole

Types

Color

enum Color : Enum<AnsiEscape.Color>

Available Ansi Colors: BLACK, RED, GREEN, YELLOW, BLUE, PURPLE, CYAN, WHITE

Companion

object Companion : AnsiEscape

Properties

bgBlack

open val String.bgBlack: String

Shortcut for this.bgColor(Color.BLACK)

bgBlue

open val String.bgBlue: String

Shortcut for this.bgColor(Color.BLUE)

bgCyan

open val String.bgCyan: String

Shortcut for this.bgColor(Color.CYAN)

bgGreen

open val String.bgGreen: String

Shortcut for this.bgColor(Color.GREEN)

bgPurple

open val String.bgPurple: String

Shortcut for this.bgColor(Color.PURPLE)

bgRed

open val String.bgRed: String

Shortcut for this.bgColor(Color.RED)

bgWhite

open val String.bgWhite: String

Shortcut for this.bgColor(Color.WHITE)

bgYellow

open val String.bgYellow: String

Shortcut for this.bgColor(Color.YELLOW)

black

open val String.black: String

Shortcut for this.color(Color.BLACK)

blue

open val String.blue: String

Shortcut for this.color(Color.BLUE)

bold

open val String.bold: String

Makes this String to be bold

colorReversed

open val String.colorReversed: String

Makes this String to be reversed/highlighted (background/color swapped)

cyan

open val String.cyan: String

Shortcut for this.color(Color.CYAN)

green

open val String.green: String

Shortcut for this.color(Color.GREEN)

purple

open val String.purple: String

Shortcut for this.color(Color.PURPLE)

red

open val String.red: String

Shortcut for this.color(Color.RED)

underline

open val String.underline: String

Makes this String to be underlined

white

open val String.white: String

Shortcut for this.color(Color.WHITE)

yellow

open val String.yellow: String

Shortcut for this.color(Color.YELLOW)

Functions

ansiEscape

open fun String.ansiEscape(code: Int, extra: String? = null, char: Char = 'm'): String

Sets a raw ansi escape sequence for this String

appendAnsiScape

open fun StringBuilder.appendAnsiScape(code: Int, extra: String? = null, char: Char = 'm'): StringBuilder

appendBgColor

open fun StringBuilder.appendBgColor(color: AnsiEscape.Color, bright: Boolean = false): StringBuilder

appendBgColor256

open fun StringBuilder.appendBgColor256(index: Int): StringBuilder

appendBold

open fun StringBuilder.appendBold(): StringBuilder

appendColorReversed

open fun StringBuilder.appendColorReversed(): StringBuilder

appendFgColor

open fun StringBuilder.appendFgColor(color: AnsiEscape.Color, bright: Boolean = false): StringBuilder

appendFgColor256

open fun StringBuilder.appendFgColor256(index: Int): StringBuilder

appendMoveDown

open fun StringBuilder.appendMoveDown(n: Int = 1): StringBuilder

appendMoveLeft

open fun StringBuilder.appendMoveLeft(n: Int = 1): StringBuilder

appendMoveRight

open fun StringBuilder.appendMoveRight(n: Int = 1): StringBuilder

appendMoveUp

open fun StringBuilder.appendMoveUp(n: Int = 1): StringBuilder

appendReset

open fun StringBuilder.appendReset(): StringBuilder

appendUnderline

open fun StringBuilder.appendUnderline(): StringBuilder

bgColor

open fun String.bgColor(color: AnsiEscape.Color, bright: Boolean = false): String

Makes this string to be in background color and bright

bgColor256

open fun String.bgColor256(index: Int): String

Makes this string to be in background color index

color

open fun String.color(color: AnsiEscape.Color, bright: Boolean = false): String

Makes this string to be in foreground color and bright

color256

open fun String.color256(index: Int): String

Makes this string to be in foreground color index