Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: support adaptive colors extension #6

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

feat: support adaptive colors extension #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e1c435
feat: support adaptive colors extension
aymanbagabas Oct 22, 2024
025daeb
fix: add adaptive color tests
aymanbagabas Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions examples/writer/writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (

func main() {
w := colorprofile.NewWriter(os.Stdout, os.Environ())
w.SetHasDarkBackground(false)

// Read from stdin and write to stdout
bts, err := io.ReadAll(os.Stdin)
Expand Down
50 changes: 42 additions & 8 deletions writer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,19 @@ func NewWriter(w io.Writer, environ []string) *Writer {
// Writer represents a color profile writer that writes ANSI sequences to the
// underlying writer.
type Writer struct {
Forward io.Writer
Profile Profile
Forward io.Writer
Profile Profile
HasLightBackground bool
}

// SetHasDarkBackground sets whether the background is dark or light.
func (w *Writer) SetHasDarkBackground(dark bool) {
w.HasLightBackground = !dark
}

// Write writes the given text to the underlying writer.
func (w *Writer) Write(p []byte) (int, error) {
switch w.Profile {
case TrueColor:
return w.Forward.Write(p)
case NoTTY:
return io.WriteString(w.Forward, ansi.Strip(string(p)))
}
Expand Down Expand Up @@ -75,7 +79,7 @@ func (w *Writer) Write(p []byte) (int, error) {
style = style.ForegroundColor(
w.Profile.Convert(ansi.BasicColor(param - 30))) //nolint:gosec
case 38: // 16 or 24-bit foreground color
c := readColor(&i, parser.Params)
c := w.readColor(&i, parser.Params)
if w.Profile > ANSI {
continue
}
Expand All @@ -92,7 +96,7 @@ func (w *Writer) Write(p []byte) (int, error) {
style = style.BackgroundColor(
w.Profile.Convert(ansi.BasicColor(param - 40))) //nolint:gosec
case 48: // 16 or 24-bit background color
c := readColor(&i, parser.Params)
c := w.readColor(&i, parser.Params)
if w.Profile > ANSI {
continue
}
Expand All @@ -103,7 +107,7 @@ func (w *Writer) Write(p []byte) (int, error) {
}
style = style.DefaultBackgroundColor()
case 58: // 16 or 24-bit underline color
c := readColor(&i, parser.Params)
c := w.readColor(&i, parser.Params)
if w.Profile > ANSI {
continue
}
Expand Down Expand Up @@ -145,7 +149,7 @@ func (w *Writer) WriteString(s string) (n int, err error) {
return w.Write([]byte(s))
}

func readColor(idxp *int, params []int) (c ansi.Color) {
func (w *Writer) readColor(idxp *int, params []int) (c ansi.Color) {
i := *idxp
paramsLen := len(params)
if i > paramsLen-1 {
Expand All @@ -170,6 +174,36 @@ func readColor(idxp *int, params []int) (c ansi.Color) {
}
c = ansi.ExtendedColor(ansi.Param(params[i+2])) //nolint:gosec
*idxp += 2
case 4: // lightDark(RGB)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should use a const value to get rid of magic numbers?

if i > paramsLen-7 {
return
}
if w.HasLightBackground {
c = color.RGBA{
R: uint8(ansi.Param(params[i+2])), //nolint:gosec
G: uint8(ansi.Param(params[i+3])), //nolint:gosec
B: uint8(ansi.Param(params[i+4])), //nolint:gosec
A: 0xff,
}
} else {
c = color.RGBA{
R: uint8(ansi.Param(params[i+5])), //nolint:gosec
G: uint8(ansi.Param(params[i+6])), //nolint:gosec
B: uint8(ansi.Param(params[i+7])), //nolint:gosec
A: 0xff,
}
}
*idxp += 7
case 10: // lightDark(256 colors)
if i > paramsLen-3 {
return
}
if w.HasLightBackground {
c = ansi.ExtendedColor(ansi.Param(params[i+2])) //nolint:gosec
} else {
c = ansi.ExtendedColor(ansi.Param(params[i+3])) //nolint:gosec
}
*idxp += 3
}
return
}
22 changes: 15 additions & 7 deletions writer_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ import (
)

var writers = map[Profile]func(io.Writer) *Writer{
TrueColor: func(w io.Writer) *Writer { return &Writer{w, TrueColor} },
ANSI256: func(w io.Writer) *Writer { return &Writer{w, ANSI256} },
ANSI: func(w io.Writer) *Writer { return &Writer{w, ANSI} },
Ascii: func(w io.Writer) *Writer { return &Writer{w, Ascii} },
NoTTY: func(w io.Writer) *Writer { return &Writer{w, NoTTY} },
TrueColor: func(w io.Writer) *Writer { return &Writer{w, TrueColor, false} },
ANSI256: func(w io.Writer) *Writer { return &Writer{w, ANSI256, false} },
ANSI: func(w io.Writer) *Writer { return &Writer{w, ANSI, false} },
Ascii: func(w io.Writer) *Writer { return &Writer{w, Ascii, false} },
NoTTY: func(w io.Writer) *Writer { return &Writer{w, NoTTY, false} },
}

var writer_cases = []struct {
Expand Down Expand Up @@ -102,11 +102,19 @@ var writer_cases = []struct {
{
name: "simple ansi 256 color bg",
input: "hello \x1b[48:5:196mworld\x1b[m",
expectedTrueColor: "hello \x1b[48:5:196mworld\x1b[m",
expectedTrueColor: "hello \x1b[48;5;196mworld\x1b[m",
expectedANSI256: "hello \x1b[48;5;196mworld\x1b[m",
expectedANSI: "hello \x1b[101mworld\x1b[m",
expectedAscii: "hello \x1b[mworld\x1b[m",
},
{
name: "adaptive color",
input: "hello \x1b[38;10;255;55mworld\x1b[m", // #ff8537
expectedTrueColor: "hello \x1b[38;5;55mworld\x1b[m",
expectedANSI256: "hello \x1b[38;5;55mworld\x1b[m",
expectedANSI: "hello \x1b[94mworld\x1b[m",
expectedAscii: "hello \x1b[mworld\x1b[m",
},
}

func TestWriter(t *testing.T) {
Expand Down Expand Up @@ -145,7 +153,7 @@ func TestNewWriterPanic(t *testing.T) {
}

func BenchmarkWriter(b *testing.B) {
w := &Writer{&bytes.Buffer{}, ANSI}
w := &Writer{&bytes.Buffer{}, ANSI, false}
input := []byte("\x1b[1;3;59mhello\x1b[m \x1b[38;2;255;133;55mworld\x1b[m")
for i := 0; i < b.N; i++ {
_, _ = w.Write(input)
Expand Down
Loading