package ccolor

Import Path
	github.com/gookit/goutil/x/ccolor (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	  d ccolor.go
		Package ccolor is a simple color render library for terminal.
		Its main code is the code that is extracted and simplified from gookit/color,
		
		TIP:
		
			If you want to render with richer colors, use the https://github.com/gookit/color package.

	    color16.go
	    color_tag.go
	    quickuse.go
	    style.go
	    util.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Color uint8 (basic type)
		Color Color16, 16 color value type
		3(2^3=8) OR 4(2^4=16) bite color.

		Methods (total 21)
			( Color) Code() string
				Code convert to code string. eg "35"

			( Color) Darken() Color
				Darken current color. eg. 96(FgLightCyan) -> 36(FgCyan)
				
				Usage:
				
					cyan := LightCyan.Darken()
					cyan.Print("message")

			( Color) Fprint(w io.Writer, a ...any)
				Fprint writes to w with color setting.
				
				Usage:
				
					ccolor.Green.Fprint(os.Stdout, "message")

			( Color) Fprintf(w io.Writer, format string, a ...any)
				Fprintf formats and writes to w with color setting.
				
				Usage:
				
					ccolor.Cyan.Fprintf(os.Stdout, "string %s", "arg0")

			( Color) Fprintln(w io.Writer, a ...any)
				Fprintln writes to w with color setting and adds a new line.
				
				Usage:
				
					ccolor.Green.Fprintln(os.Stdout, "message")

			( Color) IsBg() bool
				IsBg check is background color

			( Color) IsFg() bool
				IsFg check is foreground color

			( Color) IsOption() bool
				IsOption check is option code: 0-9

			( Color) IsValid() bool
				IsValid color value

			( Color) Light() Color
				Light current color. eg: 36(FgCyan) -> 96(FgLightCyan).
				
				Usage:
				
					lightCyan := Cyan.Light()
					lightCyan.Print("message")

			( Color) Print(args ...any)
				Print messages.
				
				Usage:
				
					ccolor.Green.Print("message")
				
				OR:
				
					green := ccolor.FgGreen.Print
					green("message")

			( Color) Printf(format string, a ...any)
				Printf format and print messages.
				
				Usage:
				
					ccolor.Cyan.Printf("string %s", "arg0")

			( Color) Println(a ...any)
				Println messages with new line

			( Color) Render(a ...any) string
				Render messages by color setting
				
				Usage:
				
					green := ccolor.FgGreen.Render
					fmt.Println(green("message"))

			( Color) Renderln(a ...any) string
				Renderln messages by color setting.
				like fmt.Println, will add spaces for each argument
				
				Usage:
				
					green := ccolor.FgGreen.Renderln
					fmt.Println(green("message"))

			( Color) Sprint(a ...any) string
				Sprint render messages by color setting. is alias of the Render()

			( Color) Sprintf(format string, args ...any) string
				Sprintf format and render message.
				
				Usage:
				
						green := ccolor.Green.Sprintf
					 	colored := green("message")

			( Color) String() string
				String convert to code string. eg "35"

			( Color) Text(message string) string
				Text render a text message

			( Color) ToBg() Color
				ToBg always convert bg

			( Color) ToFg() Color
				ToFg always convert fg

		Implements (at least 6)
			 Color : github.com/go-sql-driver/mysql.Logger
			 Color : database/sql/driver.Validator
			 Color : expvar.Var
			 Color : fmt.Stringer
			 Color : go.uber.org/fx.Printer
			 Color : gorm.io/gorm/logger.Writer
		As Outputs Of (at least 4)
			func Color.Darken() Color
			func Color.Light() Color
			func Color.ToBg() Color
			func Color.ToFg() Color
		As Inputs Of (at least 4)
			func ColorsToCode(colors ...Color) string
			func NewStyle(fg Color, bg Color, opts ...Color) *Style
			func NewStyle(fg Color, bg Color, opts ...Color) *Style
			func NewStyle(fg Color, bg Color, opts ...Color) *Style
		As Types Of (total 78)
			const BgBlack
			const BgBlue
			const BgCyan
			const BgDarkGray
			const BgDefault
			const BgGray
			const BgGreen
			const BgHiBlue
			const BgHiCyan
			const BgHiGreen
			const BgHiMagenta
			const BgHiRed
			const BgHiWhite
			const BgHiYellow
			const BgLightBlue
			const BgLightCyan
			const BgLightGreen
			const BgLightMagenta
			const BgLightRed
			const BgLightWhite
			const BgLightYellow
			const BgMagenta
			const BgRed
			const BgWhite
			const BgYellow
			const Black
			const Blue
			const Bold
			const Cyan
			const FgBlack
			const FgBlue
			const FgCyan
			const FgDarkGray
			const FgDefault
			const FgGray
			const FgGreen
			const FgLightBlue
			const FgLightCyan
			const FgLightGreen
			const FgLightMagenta
			const FgLightRed
			const FgLightWhite
			const FgLightYellow
			const FgMagenta
			const FgRed
			const FgWhite
			const FgYellow
			const Gray
			const Green
			const HiBlue
			const HiCyan
			const HiGreen
			const HiMagenta
			const HiRed
			const HiWhite
			const HiYellow
			const LightBlue
			const LightCyan
			const LightGreen
			const LightMagenta
			const LightRed
			const LightWhite
			const LightYellow
			const Magenta
			const Normal
			const OpBlink
			const OpBold
			const OpConcealed
			const OpFastBlink
			const OpFuzzy
			const OpItalic
			const OpReset
			const OpReverse
			const OpStrikethrough
			const OpUnderscore
			const Red
			const White
			const Yellow

	 type String string (basic type)
		String color style string. TODO
		eg:
		
			s := String("red,bold")
			s.Println("some text message")

	 type Style (struct)
		Style for color render.

		Fields (total 3)
			Bg Color
			Fg Color
			Opts []Color
		Methods (total 10)
			(*Style) Fprint(w io.Writer, v ...any)
				Fprint like fmt.Fprint, but with color

			(*Style) Fprintf(w io.Writer, format string, v ...any)
				Fprintf like fmt.Fprintf, but with color

			(*Style) Fprintln(w io.Writer, v ...any)
				Fprintln like fmt.Fprintln, but with color

			(*Style) Print(v ...any)
				Print like fmt.Print, but with color

			(*Style) Printf(format string, v ...any)
				Printf render and print text

			(*Style) Println(v ...any)
				Println like fmt.Println, but with color

			(*Style) Sprint(v ...any) string
				Sprint like fmt.Sprint, but with color

			(*Style) Sprintf(format string, v ...any) string
				Sprintf format and render message.

			(*Style) Sprintln(v ...any) string
				Sprintln like fmt.Sprintln, but with color

			(*Style) String() string
				String convert style setting to color code string.

		Implements (at least 5)
			*Style : github.com/go-sql-driver/mysql.Logger
			*Style : expvar.Var
			*Style : fmt.Stringer
			*Style : go.uber.org/fx.Printer
			*Style : gorm.io/gorm/logger.Writer
		As Outputs Of (at least one exported)
			func NewStyle(fg Color, bg Color, opts ...Color) *Style
		As Types Of (total 5)
			  var Debug *Style
			  var Error *Style
			  var Info *Style
			  var Success *Style
			  var Warn *Style


Package-Level Functions (total 69)

	 func ApplyTag(tag string, a ...any) string
		ApplyTag for messages

	 func Bg2Fg(val uint8) uint8
		Bg2Fg bg color value to fg value

	 func Bluef(format string, a ...any)
		Bluef print message with Blue color

	 func Blueln(a ...any)
		Blueln print message line with Blue color

	 func Bluep(a ...any)
		Bluep print message with Blue color

	 func ClearCode(str string) string
		ClearCode clear color codes.
		
		eg:
		
			"\033[36;1mText\x1b[0m" -> "Text"

	 func ClearTag(s string) string
		ClearTag clear-all tag for a string

	 func ColorsToCode(colors ...Color) string
		ColorsToCode convert colors to code. return like "32;45;3"

	 func ColorTags() map[string]string
		ColorTags get all internal color tags

	 func Cyanf(format string, a ...any)
		Cyanf print message with Cyan color

	 func Cyanln(a ...any)
		Cyanln print message line with Cyan color

	 func Cyanp(a ...any)
		Cyanp print message with Cyan color

	 func Disable()
		Disable color of current terminal.
		
		Usage:
		
			ccolor.Disable()
			defer ccolor.RevertColorSupport()

	 func Errorf(format string, a ...any)
		Errorf print message with error style

	 func Errorln(a ...any)
		Errorln print message with error style

	 func Errorp(a ...any)
		Errorp print message with error color

	 func Fg2Bg(val uint8) uint8
		Fg2Bg fg color value to bg value

	 func ForceEnableColor()
		ForceEnableColor setting value. TIP: use for unit testing.
		
		Usage:
		
			ccolor.ForceEnableColor()
			defer ccolor.RevertColorSupport()

	 func Fprint(w io.Writer, v ...any)
		Fprint auto parse color-tag, print rendered messages to the writer

	 func Fprintf(w io.Writer, format string, v ...any)
		Fprintf auto parse color-tag, print rendered messages to the writer.

	 func Fprintln(w io.Writer, v ...any)
		Fprintln auto parse color-tag, print rendered messages to the writer

	 func GetTagCode(name string) string
		GetTagCode get color code by tag name

	 func Grayf(format string, a ...any)
		Grayf print message with gray color

	 func Grayln(a ...any)
		Grayln print message line with gray color

	 func Grayp(a ...any)
		Grayp print message with gray color

	 func Greenf(format string, a ...any)
		Greenf print message with green color

	 func Greenln(a ...any)
		Greenln print message line with green color

	 func Greenp(a ...any)
		Greenp print message with green color

	 func Infof(format string, a ...any)
		Infof print message with info style

	 func Infoln(a ...any)
		Infoln print message with info style

	 func Infop(a ...any)
		Infop print message with info color

	 func IsDefinedTag(name string) bool
		IsDefinedTag is defined tag name

	 func IsSupport256Color() bool
		IsSupport256Color returns true if the terminal supports 256 colors.

	 func IsSupportColor() bool
		IsSupportColor returns true if the terminal supports color.

	 func IsSupportTrueColor() bool
		IsSupportTrueColor returns true if the terminal supports true color.

	 func LastErr() error
		LastErr info

	 func Level() termenv.ColorLevel
		Level value of current terminal.

	 func Lprint(l *log.Logger, v ...any)
		Lprint passes colored messages to a log.Logger for printing.

	 func Magentaf(format string, a ...any)
		Magentaf print message with magenta color

	 func Magentaln(a ...any)
		Magentaln print message line with magenta color

	 func Magentap(a ...any)
		Magentap print message with magenta color

	 func NewStyle(fg Color, bg Color, opts ...Color) *Style
		NewStyle fg, bg and options

	 func ParseTag(str string) string
		ParseTag parse given string, replace color tag and return rendered string
		
		Use built in tags:
		
			<TAG_NAME>CONTENT</>
			// e.g: `<info>message</>`
		
		TIP: code is from gookit/color package
		
		  - Not support custom attributes
		  - Not support c256 or rgb color

	 func ParseTagByEnv(str string) string
		ParseTagByEnv parse given string. will check package setting.

	 func Print(v ...any)
		Print parse color tag and print messages

	 func Printf(format string, v ...any)
		Printf format and print messages

	 func Println(v ...any)
		Println messages with new line

	 func Redf(format string, a ...any)
		Redf print message with Red color

	 func Redln(a ...any)
		Redln print message line with Red color

	 func Redp(a ...any)
		Redp print message with Red color

	 func Render(a ...any) string
		Render parse color tags, return rendered string.
		
		Usage:
		
			text := Render("<info>hello</> <cyan>world</>!")
			fmt.Println(text)

	 func RenderCode(code string, args ...any) string
		RenderCode render message by color code.
		
		Usage:
		
			msg := RenderCode("3;32;45", "some", "message")

	 func RenderString(code string, str string) string
		RenderString render a string with color code.
		
		Usage:
		
			msg := RenderString("3;32;45", "a message")

	 func RenderWithSpaces(code string, args ...any) string
		RenderWithSpaces Render code with spaces.
		If the number of args is > 1, a space will be added between the args

	 func ReplaceTag(str string) string
		ReplaceTag parse string, replace color tag and return rendered string

	 func RevertColorSupport()
		RevertColorSupport value

	 func SetOutput(w io.Writer)
		SetOutput set output writer

	 func Sprint(v ...any) string
		Sprint parse color tags, return rendered string

	 func Sprintf(format string, a ...any) string
		Sprintf format and return rendered string

	 func Successf(format string, a ...any)
		Successf print message with success style

	 func Successln(a ...any)
		Successln print message with success style

	 func Successp(a ...any)
		Successp print message with success color

	 func Warnf(format string, a ...any)
		Warnf print message with warn style

	 func Warnln(a ...any)
		Warnln print message with warn style

	 func Warnp(a ...any)
		Warnp print message with warn color

	 func WrapTag(s string, tag string) string
		WrapTag wrap a tag for a string "<tag>content</>"

	 func Yellowf(format string, a ...any)
		Yellowf print message with yellow color

	 func Yellowln(a ...any)
		Yellowln print message line with yellow color

	 func Yellowp(a ...any)
		Yellowp print message with yellow color


Package-Level Variables (total 10)

	  var AllOptions map[string]Color
		AllOptions color options map

	  var BgColors map[string]Color
		BgColors background colors map

	  var Debug *Style
		Debug color style

	  var Error *Style
		Error color style

	  var ExBgColors map[string]Color
		ExBgColors extra background colors map

	  var ExFgColors map[string]Color
		ExFgColors extra foreground colors map

	  var FgColors map[string]Color
		FgColors foreground colors map

	  var Info *Style
		Info color style

	  var Success *Style
		Success color style

	  var Warn *Style
		Warn color style


Package-Level Constants (total 86)

	const BgBlack Color = 40
		Background colors. basic background colors 40 - 47

	const BgBlue Color = 44
		Background colors. basic background colors 40 - 47

	const BgCyan Color = 46
		Background colors. basic background colors 40 - 47

	const BgDarkGray Color = 100
		Extra background color 100 - 107 (non-standard)

	const BgDefault Color = 49
		BgDefault revert default BG

	const BgGray Color = 100
		BgGray is alias of BgDarkGray

	const BgGreen Color = 42
		Background colors. basic background colors 40 - 47

	const BgHiBlue Color = 104
		There are basic and light foreground color aliases

	const BgHiCyan Color = 106
		There are basic and light foreground color aliases

	const BgHiGreen Color = 102
		There are basic and light foreground color aliases

	const BgHiMagenta Color = 105
		There are basic and light foreground color aliases

	const BgHiRed Color = 101
		There are basic and light foreground color aliases

	const BgHiWhite Color = 107
		There are basic and light foreground color aliases

	const BgHiYellow Color = 103
		There are basic and light foreground color aliases

	const BgLightBlue Color = 104
		Extra background color 100 - 107 (non-standard)

	const BgLightCyan Color = 106
		Extra background color 100 - 107 (non-standard)

	const BgLightGreen Color = 102
		Extra background color 100 - 107 (non-standard)

	const BgLightMagenta Color = 105
		Extra background color 100 - 107 (non-standard)

	const BgLightRed Color = 101
		Extra background color 100 - 107 (non-standard)

	const BgLightWhite Color = 107
		Extra background color 100 - 107 (non-standard)

	const BgLightYellow Color = 103
		Extra background color 100 - 107 (non-standard)

	const BgMagenta Color = 45
		Background colors. basic background colors 40 - 47

	const BgRed Color = 41
		Background colors. basic background colors 40 - 47

	const BgWhite Color = 47
		Background colors. basic background colors 40 - 47

	const BgYellow Color = 43 // BgBrown like yellow
		Background colors. basic background colors 40 - 47

	const Black Color = 30
		There are basic and light foreground color aliases

	const Blue Color = 34
		There are basic and light foreground color aliases

	const Bold Color = 1
		There are basic and light foreground color aliases

	const CodeExpr = "\\033\\[[\\d;?]+m"
		CodeExpr regex to clear color codes eg "\033[1;36mText\x1b[0m"

	const CodeSuffix = "[0m"
		CodeSuffix string for color code.

	const Cyan Color = 36
		There are basic and light foreground color aliases

	const FgBlack Color = 30
		Foreground colors. basic foreground colors 30 - 37

	const FgBlue Color = 34
		Foreground colors. basic foreground colors 30 - 37

	const FgCyan Color = 36 // 青色
		Foreground colors. basic foreground colors 30 - 37

	const FgDarkGray Color = 90 // 亮黑（灰）
		Extra foreground color 90 - 97(非标准)

	const FgDefault Color = 39
		FgDefault revert default FG

	const FgGray Color = 90 // 亮黑（灰）
		FgGray is alias of FgDarkGray

	const FgGreen Color = 32
		Foreground colors. basic foreground colors 30 - 37

	const FgLightBlue Color = 94
		Extra foreground color 90 - 97(非标准)

	const FgLightCyan Color = 96
		Extra foreground color 90 - 97(非标准)

	const FgLightGreen Color = 92
		Extra foreground color 90 - 97(非标准)

	const FgLightMagenta Color = 95
		Extra foreground color 90 - 97(非标准)

	const FgLightRed Color = 91
		Extra foreground color 90 - 97(非标准)

	const FgLightWhite Color = 97
		Extra foreground color 90 - 97(非标准)

	const FgLightYellow Color = 93
		Extra foreground color 90 - 97(非标准)

	const FgMagenta Color = 35 // 品红
		Foreground colors. basic foreground colors 30 - 37

	const FgRed Color = 31
		Foreground colors. basic foreground colors 30 - 37

	const FgWhite Color = 37
		Foreground colors. basic foreground colors 30 - 37

	const FgYellow Color = 33
		Foreground colors. basic foreground colors 30 - 37

	const FullColorTpl = "\x1b[%sm%s\x1b[0m"
		FullColorTpl for build color code

	const Gray Color = 90 // is light Black
		There are basic and light foreground color aliases

	const Green Color = 32
		There are basic and light foreground color aliases

	const HiBlue Color = 94
		There are basic and light foreground color aliases

	const HiCyan Color = 96
		There are basic and light foreground color aliases

	const HiGreen Color = 92
		There are basic and light foreground color aliases

	const HiMagenta Color = 95
		There are basic and light foreground color aliases

	const HiRed Color = 91
		There are basic and light foreground color aliases

	const HiWhite Color = 97
		There are basic and light foreground color aliases

	const HiYellow Color = 93
		There are basic and light foreground color aliases

	const LightBlue Color = 94
		There are basic and light foreground color aliases

	const LightCyan Color = 96
		There are basic and light foreground color aliases

	const LightGreen Color = 92
		There are basic and light foreground color aliases

	const LightMagenta Color = 95
		There are basic and light foreground color aliases

	const LightRed Color = 91
		There are basic and light foreground color aliases

	const LightWhite Color = 97
		There are basic and light foreground color aliases

	const LightYellow Color = 93
		There are basic and light foreground color aliases

	const Magenta Color = 35
		There are basic and light foreground color aliases

	const MatchExpr = "<([0-9a-zA-Z_]+)>(?s:(.*?))<\\/>"
		MatchExpr regex to match color tags
		
		Notice: golang 不支持反向引用. 即不支持使用 \1 引用第一个匹配 ([a-z=;]+)
		MatchExpr = `<([a-z=;]+)>(.*?)<\/\1>`
		所以调整一下 统一使用 `</>` 来结束标签，例如 "<info>some text</>"
		
		- NOTE: 不支持自定义属性。如有需要请使用 gookit/color 包
		
		(?s:...) s - 让 "." 匹配换行

	const Normal Color = 39
		There are basic and light foreground color aliases

	const OpBlink Color = 5 // 5 闪烁
		Option settings. range: 0 - 9

	const OpBold Color = 1 // 1 加粗
		Option settings. range: 0 - 9

	const OpConcealed Color = 8 // 8 隐匿的
		Option settings. range: 0 - 9

	const OpFastBlink Color = 6 // 6 快速闪烁(未广泛支持)
		Option settings. range: 0 - 9

	const OpFuzzy Color = 2 // 2 模糊(不是所有的终端仿真器都支持)
		Option settings. range: 0 - 9

	const OpItalic Color = 3 // 3 斜体(不是所有的终端仿真器都支持)
		Option settings. range: 0 - 9

	const OpReset Color = 0 // 0 重置所有设置
		Option settings. range: 0 - 9

	const OpReverse Color = 7 // 7 颠倒的 交换背景色与前景色
		Option settings. range: 0 - 9

	const OpStrikethrough Color = 9 // 9 删除的，删除线(未广泛支持)
		Option settings. range: 0 - 9

	const OpUnderscore Color = 4 // 4 下划线
		Option settings. range: 0 - 9

	const Red Color = 31
		There are basic and light foreground color aliases

	const ResetSet = "\x1b[0m"
		ResetSet close all properties.

	const SettingTpl = "\x1b[%sm"
		SettingTpl string.

	const StartSet = "\x1b["
		StartSet chars

	const StripExpr = "<[\\/]?[0-9a-zA-Z_=,;]*>"
		StripExpr regex used for removing color tags
		StripExpr = `<[\/]?[a-zA-Z=;]+>`
		随着上面的做一些调整

	const White Color = 37
		There are basic and light foreground color aliases

	const Yellow Color = 33
		There are basic and light foreground color aliases

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.