sgr

Documentation

Index

• Constants
• Variables
• func MakeCSI(codes ...string) string
• func WrapCSI(s string, csi string) string
• func WrapCode(s string, c string) string
• func WrapCodes(s string, cs ...string) string
• func WrapColor(s string, color Flag) string
• func WrapColor256(s string, color256 Color256) string
• func WrapColorRGB(s string, rgb ColorRGB) string
• func WrapFlag(s string, flag Flag) string
• func WrapRGB(s string, r, g, b uint8) string
• func WrapRGB24(s string, rgb uint32) string
• func WrapSGR(s string, sgr *SGR) string
• type Color256
• type ColorRGB
  • func RGB(r, g, b uint8) ColorRGB
  • func RGB24(rgb uint32) ColorRGB
• type Flag
  • func Flags(flags ...Flag) (fs Flag)
  • func (f Flag) Add(flag Flag) Flag
  • func (f Flag) Color() Flag
  • func (f Flag) Has(flag Flag) bool
  • func (f Flag) HasMulti(flags ...Flag) bool
  • func (f Flag) Meta() *SGRMeta
  • func (f Flag) Remove(flag Flag) Flag
• type Option
  • func BgColor256Option(color256 Color256) Option
  • func BgColorRGBOption(rgb ColorRGB) Option
  • func BgRGB24Option(rgb uint32) Option
  • func BgRGBOption(r, g, b uint8) Option
  • func FgColor256Option(color256 Color256) Option
  • func FgColorRGBOption(rgb ColorRGB) Option
  • func FgRGB24Option(rgb uint32) Option
  • func FgRGBOption(r, g, b uint8) Option
  • func UlColor256Option(color256 Color256) Option
  • func UlColorRGBOption(rgb ColorRGB) Option
  • func UlRGB24Option(rgb uint32) Option
  • func UlRGBOption(r, g, b uint8) Option
• type SGR
  • func NewSGR(flags ...Flag) *SGR
  • func (s *SGR) BgColorCodes() []string
  • func (s *SGR) CSI() string
  • func (s *SGR) CachedCodes() []string
  • func (s *SGR) Codes() []string
  • func (s *SGR) FgColorCodes() []string
  • func (s *SGR) Options(opts ...Option) *SGR
  • func (s *SGR) UlColorCodes() []string
  • func (s *SGR) Wrap(str string) string
• type SGRMeta

Constants

const (
	ResetCode      = "0"
	BoldCode       = "1"
	FaintCode      = "2"
	ItalicCode     = "3"
	UnderlineCode  = "4"
	SlowBlinkCode  = "5"
	RapidBlinkCode = "6"
	ReversedCode   = "7"
	ConcealCode    = "8"
	CrossedOutCode = "9"

	PrimaryFontCode      = "10"
	AlternativeFont1Code = "11"
	AlternativeFont2Code = "12"
	AlternativeFont3Code = "13"
	AlternativeFont4Code = "14"
	AlternativeFont5Code = "15"
	AlternativeFont6Code = "16"
	AlternativeFont7Code = "17"
	AlternativeFont8Code = "18"
	AlternativeFont9Code = "19"

	FrakturCode              = "20"
	DoublyUnderlinedCode     = "21"
	NormalIntensityCode      = "22"
	NotItalicBlackLetterCode = "23"
	NotUnderlinedCode        = "24"
	NotBlinkingCode          = "25"
	ProportionalSpacingCode  = "26"
	NotReversedCode          = "27"
	RevealCode               = "28"
	NotCrossedOutCode        = "29"

	FgBlackCode        = "30"
	FgRedCode          = "31"
	FgGreenCode        = "32"
	FgYellowCode       = "33"
	FgBlueCode         = "34"
	FgMagentaCode      = "35"
	FgCyanCode         = "36"
	FgWhiteCode        = "37"
	CustomFgColorCode  = "38"
	DefaultFgColorCode = "39"

	BgBlackCode        = "40"
	BgRedCode          = "41"
	BgGreenCode        = "42"
	BgYellowCode       = "43"
	BgBlueCode         = "44"
	BgMagentaCode      = "45"
	BgCyanCode         = "46"
	BgWhiteCode        = "47"
	CustomBgColorCode  = "48"
	DefaultBgColorCode = "49"

	DisableProportionalSpacingCode = "50"
	FramedCode                     = "51"
	EncircledCode                  = "52"
	OverlinedCode                  = "53"
	NotFramedEncircledCode         = "54"
	NotOverlinedCode               = "55"
	CustomUnderlineColorCode       = "58"
	DefaultUnderlineColorCode      = "59"

	IdeogramUnderlineCode       = "60"
	IdeogramDoubleUnderlineCode = "61"
	IdeogramOverlineCode        = "62"
	IdeogramDoubleOverlineCode  = "63"
	IdeogramStressMarkingCode   = "64"
	NoIdeogramAttributesCode    = "65"

	SuperscriptCode             = "73"
	SubscriptCode               = "74"
	NotSuperscriptSubscriptCode = "75"

	FgBrightBlackCode   = "90"
	FgBrightRedCode     = "91"
	FgBrightGreenCode   = "92"
	FgBrightYellowCode  = "93"
	FgBrightBlueCode    = "94"
	FgBrightMagentaCode = "95"
	FgBrightCyanCode    = "96"
	FgBrightWhiteCode   = "97"

	BgBrightBlackCode   = "100"
	BgBrightRedCode     = "101"
	BgBrightGreenCode   = "102"
	BgBrightYellowCode  = "103"
	BgBrightBlueCode    = "104"
	BgBrightMagentaCode = "105"
	BgBrightCyanCode    = "106"
	BgBrightWhiteCode   = "107"
)

const (
	SGR_CSIHead = "\x1b["
	SGR_CSIEnd  = "m"
)

const (
	ResetSGR_CSI = SGR_CSIHead + ResetCode + SGR_CSIEnd

	FgBlackCSI        = SGR_CSIHead + FgBlackCode + SGR_CSIEnd
	FgRedCSI          = SGR_CSIHead + FgRedCode + SGR_CSIEnd
	FgGreenCSI        = SGR_CSIHead + FgGreenCode + SGR_CSIEnd
	FgYellowCSI       = SGR_CSIHead + FgYellowCode + SGR_CSIEnd
	FgBlueCSI         = SGR_CSIHead + FgBlueCode + SGR_CSIEnd
	FgMagentaCSI      = SGR_CSIHead + FgMagentaCode + SGR_CSIEnd
	FgCyanCSI         = SGR_CSIHead + FgCyanCode + SGR_CSIEnd
	FgWhiteCSI        = SGR_CSIHead + FgWhiteCode + SGR_CSIEnd
	CustomFgColorCSI  = SGR_CSIHead + CustomFgColorCode + SGR_CSIEnd
	DefaultFgColorCSI = SGR_CSIHead + DefaultFgColorCode + SGR_CSIEnd

	BgBlackCSI        = SGR_CSIHead + BgBlackCode + SGR_CSIEnd
	BgRedCSI          = SGR_CSIHead + BgRedCode + SGR_CSIEnd
	BgGreenCSI        = SGR_CSIHead + BgGreenCode + SGR_CSIEnd
	BgYellowCSI       = SGR_CSIHead + BgYellowCode + SGR_CSIEnd
	BgBlueCSI         = SGR_CSIHead + BgBlueCode + SGR_CSIEnd
	BgMagentaCSI      = SGR_CSIHead + BgMagentaCode + SGR_CSIEnd
	BgCyanCSI         = SGR_CSIHead + BgCyanCode + SGR_CSIEnd
	BgWhiteCSI        = SGR_CSIHead + BgWhiteCode + SGR_CSIEnd
	CustomBgColorCSI  = SGR_CSIHead + CustomBgColorCode + SGR_CSIEnd
	DefaultBgColorCSI = SGR_CSIHead + DefaultBgColorCode + SGR_CSIEnd

	FgBrightBlackCSI   = SGR_CSIHead + FgBrightBlackCode + SGR_CSIEnd
	FgBrightRedCSI     = SGR_CSIHead + FgBrightRedCode + SGR_CSIEnd
	FgBrightGreenCSI   = SGR_CSIHead + FgBrightGreenCode + SGR_CSIEnd
	FgBrightYellowCSI  = SGR_CSIHead + FgBrightYellowCode + SGR_CSIEnd
	FgBrightBlueCSI    = SGR_CSIHead + FgBrightBlueCode + SGR_CSIEnd
	FgBrightMagentaCSI = SGR_CSIHead + FgBrightMagentaCode + SGR_CSIEnd
	FgBrightCyanCSI    = SGR_CSIHead + FgBrightCyanCode + SGR_CSIEnd
	FgBrightWhiteCSI   = SGR_CSIHead + FgBrightWhiteCode + SGR_CSIEnd

	BgBrightBlackCSI   = SGR_CSIHead + BgBrightBlackCode + SGR_CSIEnd
	BgBrightRedCSI     = SGR_CSIHead + BgBrightRedCode + SGR_CSIEnd
	BgBrightGreenCSI   = SGR_CSIHead + BgBrightGreenCode + SGR_CSIEnd
	BgBrightYellowCSI  = SGR_CSIHead + BgBrightYellowCode + SGR_CSIEnd
	BgBrightBlueCSI    = SGR_CSIHead + BgBrightBlueCode + SGR_CSIEnd
	BgBrightMagentaCSI = SGR_CSIHead + BgBrightMagentaCode + SGR_CSIEnd
	BgBrightCyanCSI    = SGR_CSIHead + BgBrightCyanCode + SGR_CSIEnd
	BgBrightWhiteCSI   = SGR_CSIHead + BgBrightWhiteCode + SGR_CSIEnd
)

const (
	ResetName = "reset"

	BoldName                 = "bold"
	FaintName                = "faint"
	ItalicName               = "italic"
	FrakturName              = "fraktur"
	ReversedName             = "reversed"
	NormalIntensityName      = "normal-intensity"
	NotItalicBlackLetterName = "not-italic-black-letter"
	NotReversedName          = "not-reversed"

	UnderlineName        = "underline"
	DoublyUnderlinedName = "doubly-underlined"
	SlowBlinkName        = "slow-blink"
	RapidBlinkName       = "rapid-blink"
	OverlinedName        = "overlined"
	NotUnderlinedName    = "not-underlined"
	NotBlinkingName      = "not-blinking"
	NotOverlinedName     = "not-overlined"

	ConcealName                    = "conceal"
	CrossedOutName                 = "crossed-out"
	DisableProportionalSpacingName = "disable-proportional-spacing"
	RevealName                     = "reveal"
	NotCrossedOutName              = "not-crossed-out"
	ProportionalSpacingName        = "proportional-spacing"

	FramedName                  = "framed"
	EncircledName               = "encircled"
	SuperscriptName             = "superscript"
	SubscriptName               = "subscript"
	NotFramedEncircledName      = "not-framed-encircled"
	NotSuperscriptSubscriptName = "not-superscript-subscript"

	IdeogramUnderlineName       = "ideogram-underline"
	IdeogramDoubleUnderlineName = "ideogram-double-underline"
	IdeogramOverlineName        = "ideogram-overline"
	IdeogramDoubleOverlineName  = "ideogram-double-overline"
	IdeogramStressMarkingName   = "ideogram-stress-marking"
	NoIdeogramAttributesName    = "no-ideogram-attributes"

	FgBlackName   = "fg-black"
	FgRedName     = "fg-red"
	FgGreenName   = "fg-green"
	FgYellowName  = "fg-yellow"
	FgBlueName    = "fg-blue"
	FgMagentaName = "fg-magenta"
	FgCyanName    = "fg-cyan"
	FgWhiteName   = "fg-white"

	BgBlackName   = "bg-black"
	BgRedName     = "bg-red"
	BgGreenName   = "bg-green"
	BgYellowName  = "bg-yellow"
	BgBlueName    = "bg-blue"
	BgMagentaName = "bg-magenta"
	BgCyanName    = "bg-cyan"
	BgWhiteName   = "bg-white"

	FgBrightBlackName   = "fg-bright-black"
	FgBrightRedName     = "fg-bright-red"
	FgBrightGreenName   = "fg-bright-green"
	FgBrightYellowName  = "fg-bright-yellow"
	FgBrightBlueName    = "fg-bright-blue"
	FgBrightMagentaName = "fg-bright-magenta"
	FgBrightCyanName    = "fg-bright-cyan"
	FgBrightWhiteName   = "fg-bright-white"

	BgBrightBlackName   = "bg-bright-black"
	BgBrightRedName     = "bg-bright-red"
	BgBrightGreenName   = "bg-bright-green"
	BgBrightYellowName  = "bg-bright-yellow"
	BgBrightBlueName    = "bg-bright-blue"
	BgBrightMagentaName = "bg-bright-magenta"
	BgBrightCyanName    = "bg-bright-cyan"
	BgBrightWhiteName   = "bg-bright-white"

	CustomFgColorName         = "custom-fg-color"
	DefaultFgColorName        = "default-fg-color"
	CustomBgColorName         = "custom-bg-color"
	DefaultBgColorName        = "default-bg-color"
	CustomUnderlineColorName  = "custom-underline-color"
	DefaultUnderlineColorName = "default-underline-color"

	FgColor256Name        = "fg-color-256"
	FgColorRGBName        = "fg-color-rgb"
	BgColor256Name        = "bg-color-256"
	BgColorRGBName        = "bg-color-rgb"
	UnderlineColor256Name = "underline-color-256"
	UnderlineColorRGBName = "underline-color-rgb"

	PrimaryFontName      = "primary-font"
	AlternativeFont1Name = "alternative-font1"
	AlternativeFont2Name = "alternative-font2"
	AlternativeFont3Name = "alternative-font3"
	AlternativeFont4Name = "alternative-font4"
	AlternativeFont5Name = "alternative-font5"
	AlternativeFont6Name = "alternative-font6"
	AlternativeFont7Name = "alternative-font7"

	AlternativeFont8Name = "alternative-font8"
	AlternativeFont9Name = "alternative-font9"
)

Variables

var (
	Reset = Flag{0, 1 << 0}

	Bold                 = Flag{0, 1 << 8}
	Faint                = Flag{0, 1 << 9}
	Italic               = Flag{0, 1 << 10}
	Fraktur              = Flag{0, 1 << 11}
	Reversed             = Flag{0, 1 << 12}
	NormalIntensity      = Flag{0, 1 << 13}
	NotItalicBlackLetter = Flag{0, 1 << 14}
	NotReversed          = Flag{0, 1 << 15}

	Underline        = Flag{0, 1 << 16}
	DoublyUnderlined = Flag{0, 1 << 17}
	SlowBlink        = Flag{0, 1 << 18}
	RapidBlink       = Flag{0, 1 << 19}
	Overlined        = Flag{0, 1 << 20}
	NotUnderlined    = Flag{0, 1 << 21}
	NotBlinking      = Flag{0, 1 << 22}
	NotOverlined     = Flag{0, 1 << 23}

	Conceal                    = Flag{0, 1 << 24}
	CrossedOut                 = Flag{0, 1 << 25}
	DisableProportionalSpacing = Flag{0, 1 << 26}
	Reveal                     = Flag{0, 1 << 27}
	NotCrossedOut              = Flag{0, 1 << 28}
	ProportionalSpacing        = Flag{0, 1 << 29}

	Framed                  = Flag{0, 1 << 32}
	Encircled               = Flag{0, 1 << 33}
	Superscript             = Flag{0, 1 << 34}
	Subscript               = Flag{0, 1 << 35}
	NotFramedEncircled      = Flag{0, 1 << 36}
	NotSuperscriptSubscript = Flag{0, 1 << 37}

	IdeogramUnderline       = Flag{0, 1 << 40}
	IdeogramDoubleUnderline = Flag{0, 1 << 41}
	IdeogramOverline        = Flag{0, 1 << 42}
	IdeogramDoubleOverline  = Flag{0, 1 << 43}
	IdeogramStressMarking   = Flag{0, 1 << 44}
	NoIdeogramAttributes    = Flag{0, 1 << 45}

	FgBlack   = Flag{0, 1 << 48}
	FgRed     = Flag{0, 1 << 49}
	FgGreen   = Flag{0, 1 << 50}
	FgYellow  = Flag{0, 1 << 51}
	FgBlue    = Flag{0, 1 << 52}
	FgMagenta = Flag{0, 1 << 53}
	FgCyan    = Flag{0, 1 << 54}
	FgWhite   = Flag{0, 1 << 55}

	BgBlack   = Flag{0, 1 << 56}
	BgRed     = Flag{0, 1 << 57}
	BgGreen   = Flag{0, 1 << 58}
	BgYellow  = Flag{0, 1 << 59}
	BgBlue    = Flag{0, 1 << 60}
	BgMagenta = Flag{0, 1 << 61}
	BgCyan    = Flag{0, 1 << 62}
	BgWhite   = Flag{0, 1 << 63}

	FgBrightBlack   = Flag{1 << 0, 0}
	FgBrightRed     = Flag{1 << 1, 0}
	FgBrightGreen   = Flag{1 << 2, 0}
	FgBrightYellow  = Flag{1 << 3, 0}
	FgBrightBlue    = Flag{1 << 4, 0}
	FgBrightMagenta = Flag{1 << 5, 0}
	FgBrightCyan    = Flag{1 << 6, 0}
	FgBrightWhite   = Flag{1 << 7, 0}

	BgBrightBlack   = Flag{1 << 8, 0}
	BgBrightRed     = Flag{1 << 9, 0}
	BgBrightGreen   = Flag{1 << 10, 0}
	BgBrightYellow  = Flag{1 << 11, 0}
	BgBrightBlue    = Flag{1 << 12, 0}
	BgBrightMagenta = Flag{1 << 13, 0}
	BgBrightCyan    = Flag{1 << 14, 0}
	BgBrightWhite   = Flag{1 << 15, 0}

	CustomFgColor         = Flag{1 << 16, 0}
	DefaultFgColor        = Flag{1 << 17, 0}
	CustomBgColor         = Flag{1 << 18, 0}
	DefaultBgColor        = Flag{1 << 19, 0}
	CustomUnderlineColor  = Flag{1 << 20, 0}
	DefaultUnderlineColor = Flag{1 << 21, 0}

	FgColor256        = Flag{1 << 24, 0}
	FgColorRGB        = Flag{1 << 25, 0}
	BgColor256        = Flag{1 << 26, 0}
	BgColorRGB        = Flag{1 << 27, 0}
	UnderlineColor256 = Flag{1 << 28, 0}
	UnderlineColorRGB = Flag{1 << 29, 0}

	PrimaryFont      = Flag{1 << 32, 0}
	AlternativeFont1 = Flag{1 << 33, 0}
	AlternativeFont2 = Flag{1 << 34, 0}
	AlternativeFont3 = Flag{1 << 35, 0}
	AlternativeFont4 = Flag{1 << 36, 0}
	AlternativeFont5 = Flag{1 << 37, 0}
	AlternativeFont6 = Flag{1 << 38, 0}
	AlternativeFont7 = Flag{1 << 39, 0}

	AlternativeFont8 = Flag{1 << 40, 0}
	AlternativeFont9 = Flag{1 << 41, 0}
)

var (
	ResetMeta = SGRMeta{Flag: Reset, Name: ResetName, Code: ResetCode}

	BoldMeta                 = SGRMeta{Flag: Bold, Name: BoldName, Code: BoldCode}
	FaintMeta                = SGRMeta{Flag: Faint, Name: FaintName, Code: FaintCode}
	ItalicMeta               = SGRMeta{Flag: Italic, Name: ItalicName, Code: ItalicCode}
	FrakturMeta              = SGRMeta{Flag: Fraktur, Name: FrakturName, Code: FrakturCode}
	ReversedMeta             = SGRMeta{Flag: Reversed, Name: ReversedName, Code: ReversedCode}
	NormalIntensityMeta      = SGRMeta{Flag: NormalIntensity, Name: NormalIntensityName, Code: NormalIntensityCode}
	NotItalicBlackLetterMeta = SGRMeta{Flag: NotItalicBlackLetter, Name: NotItalicBlackLetterName, Code: NotItalicBlackLetterCode}
	NotReversedMeta          = SGRMeta{Flag: NotReversed, Name: NotReversedName, Code: NotReversedCode}

	UnderlineMeta        = SGRMeta{Flag: Underline, Name: UnderlineName, Code: UnderlineCode}
	DoublyUnderlinedMeta = SGRMeta{Flag: DoublyUnderlined, Name: DoublyUnderlinedName, Code: DoublyUnderlinedCode}
	SlowBlinkMeta        = SGRMeta{Flag: SlowBlink, Name: SlowBlinkName, Code: SlowBlinkCode}
	RapidBlinkMeta       = SGRMeta{Flag: RapidBlink, Name: RapidBlinkName, Code: RapidBlinkCode}
	OverlinedMeta        = SGRMeta{Flag: Overlined, Name: OverlinedName, Code: OverlinedCode}
	NotUnderlinedMeta    = SGRMeta{Flag: NotUnderlined, Name: NotUnderlinedName, Code: NotUnderlinedCode}
	NotBlinkingMeta      = SGRMeta{Flag: NotBlinking, Name: NotBlinkingName, Code: NotBlinkingCode}
	NotOverlinedMeta     = SGRMeta{Flag: NotOverlined, Name: NotOverlinedName, Code: NotOverlinedCode}

	ConcealMeta                    = SGRMeta{Flag: Conceal, Name: ConcealName, Code: ConcealCode}
	CrossedOutMeta                 = SGRMeta{Flag: CrossedOut, Name: CrossedOutName, Code: CrossedOutCode}
	DisableProportionalSpacingMeta = SGRMeta{Flag: DisableProportionalSpacing, Name: DisableProportionalSpacingName, Code: DisableProportionalSpacingCode}
	RevealMeta                     = SGRMeta{Flag: Reveal, Name: RevealName, Code: RevealCode}
	NotCrossedOutMeta              = SGRMeta{Flag: NotCrossedOut, Name: NotCrossedOutName, Code: NotCrossedOutCode}
	ProportionalSpacingMeta        = SGRMeta{Flag: ProportionalSpacing, Name: ProportionalSpacingName, Code: ProportionalSpacingCode}

	FramedMeta                  = SGRMeta{Flag: Framed, Name: FramedName, Code: FramedCode}
	EncircledMeta               = SGRMeta{Flag: Encircled, Name: EncircledName, Code: EncircledCode}
	SuperscriptMeta             = SGRMeta{Flag: Superscript, Name: SuperscriptName, Code: SuperscriptCode}
	SubscriptMeta               = SGRMeta{Flag: Subscript, Name: SubscriptName, Code: SubscriptCode}
	NotFramedEncircledMeta      = SGRMeta{Flag: NotFramedEncircled, Name: NotFramedEncircledName, Code: NotFramedEncircledCode}
	NotSuperscriptSubscriptMeta = SGRMeta{Flag: NotSuperscriptSubscript, Name: NotSuperscriptSubscriptName, Code: NotSuperscriptSubscriptCode}

	IdeogramUnderlineMeta       = SGRMeta{Flag: IdeogramUnderline, Name: IdeogramUnderlineName, Code: IdeogramUnderlineCode}
	IdeogramDoubleUnderlineMeta = SGRMeta{Flag: IdeogramDoubleUnderline, Name: IdeogramDoubleUnderlineName, Code: IdeogramDoubleUnderlineCode}
	IdeogramOverlineMeta        = SGRMeta{Flag: IdeogramOverline, Name: IdeogramOverlineName, Code: IdeogramOverlineCode}
	IdeogramDoubleOverlineMeta  = SGRMeta{Flag: IdeogramDoubleOverline, Name: IdeogramDoubleOverlineName, Code: IdeogramDoubleOverlineCode}
	IdeogramStressMarkingMeta   = SGRMeta{Flag: IdeogramStressMarking, Name: IdeogramStressMarkingName, Code: IdeogramStressMarkingCode}
	NoIdeogramAttributesMeta    = SGRMeta{Flag: NoIdeogramAttributes, Name: NoIdeogramAttributesName, Code: NoIdeogramAttributesCode}

	FgBlackMeta   = SGRMeta{Flag: FgBlack, Name: FgBlackName, Code: FgBlackCode}
	FgRedMeta     = SGRMeta{Flag: FgRed, Name: FgRedName, Code: FgRedCode}
	FgGreenMeta   = SGRMeta{Flag: FgGreen, Name: FgGreenName, Code: FgGreenCode}
	FgYellowMeta  = SGRMeta{Flag: FgYellow, Name: FgYellowName, Code: FgYellowCode}
	FgBlueMeta    = SGRMeta{Flag: FgBlue, Name: FgBlueName, Code: FgBlueCode}
	FgMagentaMeta = SGRMeta{Flag: FgMagenta, Name: FgMagentaName, Code: FgMagentaCode}
	FgCyanMeta    = SGRMeta{Flag: FgCyan, Name: FgCyanName, Code: FgCyanCode}
	FgWhiteMeta   = SGRMeta{Flag: FgWhite, Name: FgWhiteName, Code: FgWhiteCode}

	BgBlackMeta   = SGRMeta{Flag: BgBlack, Name: BgBlackName, Code: BgBlackCode}
	BgRedMeta     = SGRMeta{Flag: BgRed, Name: BgRedName, Code: BgRedCode}
	BgGreenMeta   = SGRMeta{Flag: BgGreen, Name: BgGreenName, Code: BgGreenCode}
	BgYellowMeta  = SGRMeta{Flag: BgYellow, Name: BgYellowName, Code: BgYellowCode}
	BgBlueMeta    = SGRMeta{Flag: BgBlue, Name: BgBlueName, Code: BgBlueCode}
	BgMagentaMeta = SGRMeta{Flag: BgMagenta, Name: BgMagentaName, Code: BgMagentaCode}
	BgCyanMeta    = SGRMeta{Flag: BgCyan, Name: BgCyanName, Code: BgCyanCode}
	BgWhiteMeta   = SGRMeta{Flag: BgWhite, Name: BgWhiteName, Code: BgWhiteCode}

	FgBrightBlackMeta   = SGRMeta{Flag: FgBrightBlack, Name: FgBrightBlackName, Code: FgBrightBlackCode}
	FgBrightRedMeta     = SGRMeta{Flag: FgBrightRed, Name: FgBrightRedName, Code: FgBrightRedCode}
	FgBrightGreenMeta   = SGRMeta{Flag: FgBrightGreen, Name: FgBrightGreenName, Code: FgBrightGreenCode}
	FgBrightYellowMeta  = SGRMeta{Flag: FgBrightYellow, Name: FgBrightYellowName, Code: FgBrightYellowCode}
	FgBrightBlueMeta    = SGRMeta{Flag: FgBrightBlue, Name: FgBrightBlueName, Code: FgBrightBlueCode}
	FgBrightMagentaMeta = SGRMeta{Flag: FgBrightMagenta, Name: FgBrightMagentaName, Code: FgBrightMagentaCode}
	FgBrightCyanMeta    = SGRMeta{Flag: FgBrightCyan, Name: FgBrightCyanName, Code: FgBrightCyanCode}
	FgBrightWhiteMeta   = SGRMeta{Flag: FgBrightWhite, Name: FgBrightWhiteName, Code: FgBrightWhiteCode}

	BgBrightBlackMeta   = SGRMeta{Flag: BgBrightBlack, Name: BgBrightBlackName, Code: BgBrightBlackCode}
	BgBrightRedMeta     = SGRMeta{Flag: BgBrightRed, Name: BgBrightRedName, Code: BgBrightRedCode}
	BgBrightGreenMeta   = SGRMeta{Flag: BgBrightGreen, Name: BgBrightGreenName, Code: BgBrightGreenCode}
	BgBrightYellowMeta  = SGRMeta{Flag: BgBrightYellow, Name: BgBrightYellowName, Code: BgBrightYellowCode}
	BgBrightBlueMeta    = SGRMeta{Flag: BgBrightBlue, Name: BgBrightBlueName, Code: BgBrightBlueCode}
	BgBrightMagentaMeta = SGRMeta{Flag: BgBrightMagenta, Name: BgBrightMagentaName, Code: BgBrightMagentaCode}
	BgBrightCyanMeta    = SGRMeta{Flag: BgBrightCyan, Name: BgBrightCyanName, Code: BgBrightCyanCode}
	BgBrightWhiteMeta   = SGRMeta{Flag: BgBrightWhite, Name: BgBrightWhiteName, Code: BgBrightWhiteCode}

	CustomFgColorMeta         = SGRMeta{Flag: CustomFgColor, Name: CustomFgColorName, Code: CustomFgColorCode}
	DefaultFgColorMeta        = SGRMeta{Flag: DefaultFgColor, Name: DefaultFgColorName, Code: DefaultFgColorCode}
	CustomBgColorMeta         = SGRMeta{Flag: CustomBgColor, Name: CustomBgColorName, Code: CustomBgColorCode}
	DefaultBgColorMeta        = SGRMeta{Flag: DefaultBgColor, Name: DefaultBgColorName, Code: DefaultBgColorCode}
	CustomUnderlineColorMeta  = SGRMeta{Flag: CustomUnderlineColor, Name: CustomUnderlineColorName, Code: CustomUnderlineColorCode}
	DefaultUnderlineColorMeta = SGRMeta{Flag: DefaultUnderlineColor, Name: DefaultUnderlineColorName, Code: DefaultUnderlineColorCode}

	PrimaryFontMeta      = SGRMeta{Flag: PrimaryFont, Name: PrimaryFontName, Code: PrimaryFontCode}
	AlternativeFont1Meta = SGRMeta{Flag: AlternativeFont1, Name: AlternativeFont1Name, Code: AlternativeFont1Code}
	AlternativeFont2Meta = SGRMeta{Flag: AlternativeFont2, Name: AlternativeFont2Name, Code: AlternativeFont2Code}
	AlternativeFont3Meta = SGRMeta{Flag: AlternativeFont3, Name: AlternativeFont3Name, Code: AlternativeFont3Code}
	AlternativeFont4Meta = SGRMeta{Flag: AlternativeFont4, Name: AlternativeFont4Name, Code: AlternativeFont4Code}
	AlternativeFont5Meta = SGRMeta{Flag: AlternativeFont5, Name: AlternativeFont5Name, Code: AlternativeFont5Code}
	AlternativeFont6Meta = SGRMeta{Flag: AlternativeFont6, Name: AlternativeFont6Name, Code: AlternativeFont6Code}
	AlternativeFont7Meta = SGRMeta{Flag: AlternativeFont7, Name: AlternativeFont7Name, Code: AlternativeFont7Code}

	AlternativeFont8Meta = SGRMeta{Flag: AlternativeFont8, Name: AlternativeFont8Name, Code: AlternativeFont8Code}
	AlternativeFont9Meta = SGRMeta{Flag: AlternativeFont9, Name: AlternativeFont9Name, Code: AlternativeFont9Code}
)

Functions

func MakeCSI

func MakeCSI(codes ...string) string

func WrapCSI

func WrapCSI(s string, csi string) string

func WrapCode

func WrapCode(s string, c string) string

func WrapCodes

func WrapCodes(s string, cs ...string) string

func WrapColor

func WrapColor(s string, color Flag) string

func WrapColor256

func WrapColor256(s string, color256 Color256) string

func WrapColorRGB

func WrapColorRGB(s string, rgb ColorRGB) string

func WrapFlag

func WrapFlag(s string, flag Flag) string

func WrapRGB

func WrapRGB(s string, r, g, b uint8) string

func WrapRGB24

func WrapRGB24(s string, rgb uint32) string

func WrapSGR

func WrapSGR(s string, sgr *SGR) string

Types

type Color256

type Color256 uint8

type ColorRGB

type ColorRGB struct {
	R uint8
	G uint8
	B uint8
}

func RGB

func RGB(r, g, b uint8) ColorRGB

func RGB24

func RGB24(rgb uint32) ColorRGB

type Flag

type Flag [2]uint64

func Flags

func Flags(flags ...Flag) (fs Flag)

func (Flag) Add

func (f Flag) Add(flag Flag) Flag

func (Flag) Color

func (f Flag) Color() Flag

func (Flag) Has

func (f Flag) Has(flag Flag) bool

func (Flag) HasMulti

func (f Flag) HasMulti(flags ...Flag) bool

func (Flag) Meta

func (f Flag) Meta() *SGRMeta

func (Flag) Remove

func (f Flag) Remove(flag Flag) Flag

type Option

type Option interface {
	// contains filtered or unexported methods
}

func BgColor256Option

func BgColor256Option(color256 Color256) Option

func BgColorRGBOption

func BgColorRGBOption(rgb ColorRGB) Option

func BgRGB24Option

func BgRGB24Option(rgb uint32) Option

func BgRGBOption

func BgRGBOption(r, g, b uint8) Option

func FgColor256Option

func FgColor256Option(color256 Color256) Option

func FgColorRGBOption

func FgColorRGBOption(rgb ColorRGB) Option

func FgRGB24Option

func FgRGB24Option(rgb uint32) Option

func FgRGBOption

func FgRGBOption(r, g, b uint8) Option

func UlColor256Option

func UlColor256Option(color256 Color256) Option

func UlColorRGBOption

func UlColorRGBOption(rgb ColorRGB) Option

func UlRGB24Option

func UlRGB24Option(rgb uint32) Option

func UlRGBOption

func UlRGBOption(r, g, b uint8) Option

type SGR

type SGR struct {
	Flag       Flag
	FgColor256 Color256
	FgColorRGB ColorRGB
	BgColor256 Color256
	BgColorRGB ColorRGB
	UlColor256 Color256
	UlColorRGB ColorRGB
}

SGR Select Graphic Rendition

func NewSGR

func NewSGR(flags ...Flag) *SGR

func (*SGR) BgColorCodes

func (s *SGR) BgColorCodes() []string

func (*SGR) CSI

func (s *SGR) CSI() string

func (*SGR) CachedCodes

func (s *SGR) CachedCodes() []string

func (*SGR) Codes

func (s *SGR) Codes() []string

func (*SGR) FgColorCodes

func (s *SGR) FgColorCodes() []string

func (*SGR) Options

func (s *SGR) Options(opts ...Option) *SGR

func (*SGR) UlColorCodes

func (s *SGR) UlColorCodes() []string

func (*SGR) Wrap

func (s *SGR) Wrap(str string) string

type SGRMeta

type SGRMeta struct {
	Flag Flag
	Name string
	Code string
}