fansi

package fansi

Type members

Classlikes

sealed trait Attr extends Attrs

Represents a single, atomic ANSI escape sequence that results in a color, background or decoration being added to the output. May or may not have an escape sequence (escapeOpt), as some attributes (e.g. Bold.Off) are not widely/directly supported by terminals and so fansi.Str supports them by rendering a hard Attr.Reset and then re-rendering other Attrs that are active.

Represents a single, atomic ANSI escape sequence that results in a color, background or decoration being added to the output. May or may not have an escape sequence (escapeOpt), as some attributes (e.g. Bold.Off) are not widely/directly supported by terminals and so fansi.Str supports them by rendering a hard Attr.Reset and then re-rendering other Attrs that are active.

Many of the codes were stolen shamelessly from

http://misc.flogisoft.com/bash/tip_colors_and_formatting

Companion:
object
object Attr
Companion:
class
sealed trait Attrs

Represents one or more fansi.Attrs, that can be passed around as a set or combined with other sets of fansi.Attrs.

Represents one or more fansi.Attrs, that can be passed around as a set or combined with other sets of fansi.Attrs.

Note that a single Attr is a subclass of Attrs. If you want to know if this contains multiple Attrs, you should check for Attrs.Multiple.

Companion:
object
object Attrs
Companion:
class
object Back extends ColorCategory

Attrs to set or reset the color of your background

Attrs to set or reset the color of your background

object Bold extends Category

Attrs to turn text bold/bright or disable it

Attrs to turn text bold/bright or disable it

sealed abstract class Category(val offset: Int, val width: Int)(implicit catName: Name)

Represents a set of fansi.Attrs all occupying the same bit-space in the state Int

Represents a set of fansi.Attrs all occupying the same bit-space in the state Int

object Color extends ColorCategory

Attrs to set or reset the color of your foreground text

Attrs to set or reset the color of your foreground text

abstract class ColorCategory(offset: Int, width: Int, val colorCode: Int)(implicit catName: Name) extends Category
  • Color a encoded on 25 bit as follow : 0 : reset value 1 - 16 : 3 bit colors 17 - 272 : 8 bit colors 273 - 16 777 388 : 24 bit colors
sealed trait ErrorMode

Used to control what kind of behavior you get if the a CharSequence you are trying to parse into a fansi.Str contains an Ansi escape not recognized by Fansi as a valid color.

Used to control what kind of behavior you get if the a CharSequence you are trying to parse into a fansi.Str contains an Ansi escape not recognized by Fansi as a valid color.

Companion:
object
object ErrorMode
Companion:
class
case class EscapeAttr extends Attr

An Attr represented by an fansi escape sequence

An Attr represented by an fansi escape sequence

case class ResetAttr extends Attr

An Attr for which no fansi escape sequence exists

An Attr for which no fansi escape sequence exists

object Reversed extends Category

Attrs to reverse the background/foreground colors of your text, or un-reverse them

Attrs to reverse the background/foreground colors of your text, or un-reverse them

class Str

Encapsulates a string with associated ANSI colors and text decorations.

Encapsulates a string with associated ANSI colors and text decorations.

This is your primary data-type when you are dealing with colored fansi strings.

Contains some basic string methods, as well as some ansi methods to e.g. apply particular colors or other decorations to particular sections of the fansi.Str. render flattens it out into a java.lang.String with all the colors present as ANSI escapes.

Avoids using Scala collections operations in favor of util.Arrays, giving 20% (on ++) to >1000% (on splitAt, subString and Str.parse) speedups

Companion:
object
object Str
Companion:
class
object Underlined extends Category

Attrs to enable or disable underlined text

Attrs to enable or disable underlined text