scala.io.AnsiColor.scala Maven / Gradle / Ivy
/*
* Scala (https://www.scala-lang.org)
*
* Copyright EPFL and Lightbend, Inc.
*
* Licensed under Apache License 2.0
* (http://www.apache.org/licenses/LICENSE-2.0).
*
* See the NOTICE file distributed with this work for
* additional information regarding copyright ownership.
*/
package scala
package io
/** ANSI escape codes providing control over text formatting and color on supporting text terminals.
*
* ==ANSI Style and Control Codes==
*
* This group of escape codes provides control over text styling. For example, to turn on reverse video with bold and
* then turn off all styling embed these codes,
*
* {{{
* import io.AnsiColor._
*
* object ColorDemo extends App {
*
* println(s"\${REVERSED}\${BOLD}Hello 1979!\${RESET}")
* }
* }}}
*
* ==Foreground and Background Colors==
*
* Embedding ANSI color codes in text output will control the text foreground and background colors.
*
*
* Foreground Background BLACK BLACK_B RED RED_B GREEN GREEN_B YELLOW YELLOW_B BLUE BLUE_B MAGENTA MAGENTA_B CYAN CYAN_B WHITE WHITE_B
*
* @groupname style-control ANSI Style and Control Codes
* @groupprio style-control 101
*
* @groupname color-black ANSI Black
* @groupdesc color-black
* @groupprio color-black 110
*
* @groupname color-red ANSI Red
* @groupdesc color-red
* @groupprio color-red 120
*
* @groupname color-green ANSI Green
* @groupdesc color-green
* @groupprio color-green 130
*
* @groupname color-yellow ANSI Yellow
* @groupdesc color-yellow
* @groupprio color-yellow 140
*
* @groupname color-blue ANSI Blue
* @groupdesc color-blue
* @groupprio color-blue 150
*
* @groupname color-magenta ANSI Magenta
* @groupdesc color-magenta
* @groupprio color-magenta 160
*
* @groupname color-cyan ANSI Cyan
* @groupdesc color-cyan
* @groupprio color-cyan 170
*
* @groupname color-white ANSI White
* @groupdesc color-white
* @groupprio color-white 180
*/
trait AnsiColor {
/** Foreground color for ANSI black
* @group color-black
*/
final val BLACK = "\u001b[30m"
/** Foreground color for ANSI red
* @group color-red
*/
final val RED = "\u001b[31m"
/** Foreground color for ANSI green
* @group color-green
*/
final val GREEN = "\u001b[32m"
/** Foreground color for ANSI yellow
* @group color-yellow
*/
final val YELLOW = "\u001b[33m"
/** Foreground color for ANSI blue
* @group color-blue
*/
final val BLUE = "\u001b[34m"
/** Foreground color for ANSI magenta
* @group color-magenta
*/
final val MAGENTA = "\u001b[35m"
/** Foreground color for ANSI cyan
* @group color-cyan
*/
final val CYAN = "\u001b[36m"
/** Foreground color for ANSI white
* @group color-white
*/
final val WHITE = "\u001b[37m"
/** Background color for ANSI black
* @group color-black
*/
final val BLACK_B = "\u001b[40m"
/** Background color for ANSI red
* @group color-red
*/
final val RED_B = "\u001b[41m"
/** Background color for ANSI green
* @group color-green
*/
final val GREEN_B = "\u001b[42m"
/** Background color for ANSI yellow
* @group color-yellow
*/
final val YELLOW_B = "\u001b[43m"
/** Background color for ANSI blue
* @group color-blue
*/
final val BLUE_B = "\u001b[44m"
/** Background color for ANSI magenta
* @group color-magenta
*/
final val MAGENTA_B = "\u001b[45m"
/** Background color for ANSI cyan
* @group color-cyan
*/
final val CYAN_B = "\u001b[46m"
/** Background color for ANSI white
* @group color-white
*/
final val WHITE_B = "\u001b[47m"
/** Reset ANSI styles
* @group style-control
*/
final val RESET = "\u001b[0m"
/** ANSI bold
* @group style-control
*/
final val BOLD = "\u001b[1m"
/** ANSI underlines
* @group style-control
*/
final val UNDERLINED = "\u001b[4m"
/** ANSI blink
* @group style-control
*/
final val BLINK = "\u001b[5m"
/** ANSI reversed
* @group style-control
*/
final val REVERSED = "\u001b[7m"
/** ANSI invisible
* @group style-control
*/
final val INVISIBLE = "\u001b[8m"
}
object AnsiColor extends AnsiColor { }