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

Parser fixes #20

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Parser fixes #20

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ac1b11c
Fix parsing issues when Colors Immediately follow others and newlines
knivey Jan 3, 2025
b236900
Fix failure to parse colored commas
knivey Jan 3, 2025
12eb69a
Fix background being cleared after several colors without text
knivey Jan 3, 2025
df8451a
Make state reset after newline match that at start of function
knivey Jan 6, 2025
5c52340
Cleanup logic handling new color immediately following color
knivey Jan 6, 2025
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
21 changes: 17 additions & 4 deletions ascii/ascii.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,15 @@ func NewASCII(dat string) (*ASCII, error) {
var row []Cell
chompState, fg, bg, fgs, bgs := 0, -1, -1, 0, 0
var bold, underline, italic, strikethrough bool
for _, v := range dat {
for i, v := range dat {
switch v {
case '\r':
continue
case '\n':
bold, underline, strikethrough, italic = false, false, false, false
cells = append(cells, row)
chompState, fg, bg = 0, -1, -1
Copy link
Owner

Choose a reason for hiding this comment

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

chompState, fg, bg, fgs, bgs := 0, -1, -1, 0, 0 so it matches the initialization at the beginning of the function

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in df8451a

fgs, bgs = 0, 0
row = nil
continue
case '\x02':
Expand All @@ -60,6 +61,15 @@ func NewASCII(dat string) (*ASCII, error) {
continue
}
case 1:
if v == '\x03' {
if fgs > 0 {
Copy link
Owner

Choose a reason for hiding this comment

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

if fgs == 0 { bg = -1 }
fg, fgs = -1, 0
continue

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed in 5c52340

fg = -1
} else {
fg, bg = -1, -1
}
fgs = 0
continue
}
if v >= '0' && v <= '9' && fgs < 2 {
if fg == -1 {
fg = 0
Expand All @@ -74,8 +84,11 @@ func NewASCII(dat string) (*ASCII, error) {
break
}
if v == ',' {
chompState, bg = 2, -1
continue
if len(dat) > i+1 && dat[i+1] >= '0' && dat[i+1] <= '9' {
Copy link
Owner

Choose a reason for hiding this comment

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

peaking ahead like this breaks the fsm formulation; I think the handling should be in case 2 as like if v >= ... {} else if bgs == 0 { chompState = 0; break }

chompState, bg = 2, -1
continue
}
chompState = 0
}
case 2:
if v >= '0' && v <= '9' && bgs < 2 {
Expand All @@ -90,7 +103,7 @@ func NewASCII(dat string) (*ASCII, error) {
}
bgs, chompState = 0, 0
if bg == -1 {
return nil, ErrBadMircCode
// return nil, ErrBadMircCode
}
}
fgc, err := MircColor(fg)
Expand Down
269 changes: 269 additions & 0 deletions ascii/ascii_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
package ascii

import (
"strings"
"testing"
)

Expand Down Expand Up @@ -31,6 +32,274 @@ func TestControlCodes(t *testing.T) {
}
}

func PrettyFormat(ircText string) string {
out := strings.ReplaceAll(ircText, "\x03", "\x1b[033m[C]\x1b[0m")
out = strings.ReplaceAll(out, "\x02", "\x1b[034m[B]\x1b[0m")
out = strings.ReplaceAll(out, "\x1F", "\x1b[035m[U]\x1b[0m")
out = strings.ReplaceAll(out, "\x1D", "\x1b[036m[I]\x1b[0m")
return out
}

func PrintExpectedVsParsed(expected string, ascii *ASCII, t *testing.T) {
t.Errorf(" Input : %s", PrettyFormat(expected))
t.Errorf(" Parsed : %s", PrettyFormat(string(ascii.Bytes())))
}

func TestColorCodes(t *testing.T) {
s := "hello \x0315,01hello"
// 012345 6789
a, _ := NewASCII(s)
if c := a.Get(2, 0); c == nil || c.Value != 'l' {
Copy link
Owner

Choose a reason for hiding this comment

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

Too much repetition-- idiomatic go uses a table driven test pattern like https://github.com/chzchzchz/sitbot/blob/master/msl/grammar_test.go#L49

Struct would be like

struct {
input string
col []int
expected []Cell
}

Driver would be like

for _, tt := range tests {
a, _ := NewAscii(tt.input);
for i := range tt.col {
c := a.Get(tt.col[i], 0)
if c == nil || c != tt.expected[i] {
t.Errorf("got %+v, want %+v at %d for %q",  c, tt.expected[i], tt.col[i], tt.input)
}
}

t.Errorf("Expected l but found %c", c.Value)
}
if c := a.Get(2, 0); c == nil || c.Foreground != nil {
t.Errorf("Expected nil but found %v", c.Foreground)
}
if c := a.Get(2, 0); c == nil || c.Background != nil {
t.Errorf("Expected nil but found %v", c.Background)
}

if c := a.Get(7, 0); c == nil || c.Value != 'e' {
t.Errorf("Expected e but found %c", c.Value)
}
fg, _ := MircColor(15)
if c := a.Get(7, 0); c == nil || c.Foreground != fg {
t.Errorf("Expected 15 but found %v", c.Foreground)
}
bg, _ := MircColor(1)
if c := a.Get(7, 0); c == nil || c.Background != bg {
t.Errorf("Expected 1 but found %v", c.Background)
}
}

func TestColorCodesBackToBack(t *testing.T) {
s := "he\x037,01he\x03\x0315lo"
// 01 23 45
a, _ := NewASCII(s)

c := a.Get(4, 0)
if c == nil {
t.Error("Expected l at pos 4 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'l' {
t.Errorf("Expected l at pos 4 but found '%c'", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(15)
if c.Foreground != fg {
t.Errorf("Expected color 4 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
}

c = a.Get(5, 0)
if c == nil {
t.Error("Expected o at pos 5 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Background != nil {
t.Errorf("Expected nil but found %v", c.Background)
}
}
}

func TestColorCodesNoText(t *testing.T) {
s := "ab\x037\x034cd"
// 01 23
a, _ := NewASCII(s)

c := a.Get(2, 0)
if c == nil {
t.Error("Expected c at pos 2 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'c' {
t.Errorf("Expected c at pos 2 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(4)
if c.Foreground != fg {
t.Errorf("Expected color 4 at pos 2 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
}
}
func TestColorCodesNoText2d(t *testing.T) {
s := "ab\x0315\x0314cd"
// 01 23
a, _ := NewASCII(s)

c := a.Get(2, 0)
if c == nil {
t.Error("Expected c at pos 2 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'c' {
t.Errorf("Expected c at pos 2 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(14)
if c.Foreground != fg {
t.Errorf("Expected color 4 at pos 2 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
}
}

func TestBoldAfterColorCode(t *testing.T) {
s := "ab\x0315\x02cd"
// 01 23
a, _ := NewASCII(s)

c := a.Get(2, 0)
if c == nil {
t.Error("Expected c at pos 2 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'c' {
t.Errorf("Expected c at pos 2 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(15)
if c.Foreground != fg {
t.Errorf("Expected color 4 at pos 2 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
if !c.Bold {
t.Errorf("Expected bold pos 2 but found %v", c.Bold)
PrintExpectedVsParsed(s, a, t)
}
}
}

func TestColorAfterBoldAfterColorCode(t *testing.T) {
s := "ab\x0315\x02\x0314cd"
// 01 23
a, _ := NewASCII(s)

c := a.Get(2, 0)
if c == nil {
t.Error("Expected c at pos 2 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'c' {
t.Errorf("Expected c at pos 2 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(14)
if c.Foreground != fg {
t.Errorf("Expected color 4 at pos 2 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
if !c.Bold {
t.Errorf("Expected bold pos 2 but found %v", c.Bold)
PrintExpectedVsParsed(s, a, t)
}
}
}

func TestLeadingColorAfterItalicAfterColorCode(t *testing.T) {
s := "\x0315\x1D\x0314cd"
// 01
a, _ := NewASCII(s)

c := a.Get(0, 0)
if c == nil {
t.Error("Expected c at pos 2 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'c' {
t.Errorf("Expected c at pos 2 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(14)
if c.Foreground != fg {
t.Errorf("Expected color 4 at pos 2 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
if !c.Italic {
t.Errorf("Expected bold pos 2 but found %v", c.Bold)
PrintExpectedVsParsed(s, a, t)
}
}
}

func TestLeadingColorAfterItalicAfterColorCodeAfterNewlineAfterColor(t *testing.T) {
s := "\x0315\n\x0313\x1D\x0314cd"
// 01
a, _ := NewASCII(s)

c := a.Get(0, 1)
if c == nil {
t.Error("Expected c at pos 2 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'c' {
t.Errorf("Expected c at pos 2 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(14)
if c.Foreground != fg {
t.Errorf("Expected color 4 at pos 2 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
if !c.Italic {
t.Errorf("Expected italic pos 2 but found %v", c.Bold)
PrintExpectedVsParsed(s, a, t)
}
}
}

func TestColoredComma(t *testing.T) {
s := "\x0315, "
// 01
a, _ := NewASCII(s)

c := a.Get(0, 0)
if c == nil {
t.Error("Expected , at pos 0 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != ',' {
t.Errorf("Expected , at pos 0 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(15)
if c.Foreground != fg {
t.Errorf("Expected color 15 at pos 0 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
}
}

func TestBackgroundPersistsAfterBackToBack(t *testing.T) {
s := "\x0315,01\x0303\x0304moo"
// 012
a, _ := NewASCII(s)

c := a.Get(0, 0)
if c == nil {
t.Error("Expected m at pos 0 but found nil")
PrintExpectedVsParsed(s, a, t)
} else {
if c.Value != 'm' {
t.Errorf("Expected m at pos 0 but found %c", c.Value)
PrintExpectedVsParsed(s, a, t)
}
fg, _ := MircColor(4)
if c.Foreground != fg {
t.Errorf("Expected color 4 at pos 0 but found %v", c.Foreground)
PrintExpectedVsParsed(s, a, t)
}
bg, _ := MircColor(1)
if c.Background != bg {
t.Errorf("Expected color 1 at pos 0 but found %v", c.Background)
PrintExpectedVsParsed(s, a, t)
}
}
}

func TestColorCancelAteChars(t *testing.T) {
s := `11,11 test`
// 01 2345
Expand Down