Move escape code parser into wcswidth package

This commit is contained in:
Kovid Goyal
2022-08-25 05:55:38 +05:30
parent 9be2247081
commit 7280c712d6
6 changed files with 30 additions and 27 deletions

View File

@@ -1,300 +0,0 @@
package utils
import (
"bytes"
)
type parser_state uint8
type csi_state uint8
type csi_char_type uint8
var bracketed_paste_start = []byte{'2', '0', '0', '~'}
const (
normal parser_state = iota
esc
csi
st
st_or_bel
esc_st
c1_st
bracketed_paste
)
const (
parameter csi_state = iota
intermediate
)
const (
unknown_csi_char csi_char_type = iota
parameter_csi_char
intermediate_csi_char
final_csi_char
)
type EscapeCodeParser struct {
state parser_state
utf8_state UTF8State
csi_state csi_state
current_buffer []byte
bracketed_paste_buffer []UTF8State
current_callback func([]byte) error
// Callbacks
HandleRune func(rune) error
HandleCSI func([]byte) error
HandleOSC func([]byte) error
HandleDCS func([]byte) error
HandlePM func([]byte) error
HandleSOS func([]byte) error
HandleAPC func([]byte) error
}
func (self *EscapeCodeParser) InBracketedPaste() bool { return self.state == bracketed_paste }
func (self *EscapeCodeParser) Parse(data []byte) error {
prev := UTF8_ACCEPT
codep := UTF8_ACCEPT
for i := 0; i < len(data); i++ {
switch self.state {
case normal, bracketed_paste:
switch decode_utf8(&self.utf8_state, &codep, data[i]) {
case UTF8_ACCEPT:
err := self.dispatch_char(codep)
if err != nil {
self.Reset()
return err
}
case UTF8_REJECT:
self.utf8_state = UTF8_ACCEPT
if prev != UTF8_ACCEPT && i > 0 {
i = i - 1
}
}
prev = self.utf8_state
default:
err := self.dispatch_byte(data[i])
if err != nil {
self.Reset()
return err
}
}
}
return nil
}
func (self *EscapeCodeParser) Reset() {
self.reset_state()
}
func (self *EscapeCodeParser) write_ch(ch byte) {
self.current_buffer = append(self.current_buffer, ch)
}
func csi_type(ch byte) csi_char_type {
if 0x30 <= ch && ch <= 0x3f {
return parameter_csi_char
}
if 0x40 <= ch && ch <= 0x7E {
return final_csi_char
}
if 0x20 <= ch && ch <= 0x2F {
return intermediate_csi_char
}
return unknown_csi_char
}
func (self *EscapeCodeParser) reset_state() {
self.current_buffer = self.current_buffer[:0]
self.bracketed_paste_buffer = self.bracketed_paste_buffer[:0]
self.state = normal
self.utf8_state = UTF8_ACCEPT
self.current_callback = nil
self.csi_state = parameter
}
func (self *EscapeCodeParser) dispatch_esc_code() error {
if self.state == csi && bytes.Equal(self.current_buffer, bracketed_paste_start) {
self.reset_state()
self.state = bracketed_paste
return nil
}
var err error
if self.current_callback != nil {
err = self.current_callback(self.current_buffer)
}
self.reset_state()
return err
}
func (self *EscapeCodeParser) invalid_escape_code() {
self.reset_state()
}
func (self *EscapeCodeParser) dispatch_rune(ch UTF8State) error {
if self.HandleRune != nil {
return self.HandleRune(rune(ch))
}
return nil
}
func (self *EscapeCodeParser) bp_buffer_equals(chars []UTF8State) bool {
if len(self.bracketed_paste_buffer) != len(chars) {
return false
}
for i, q := range chars {
if self.bracketed_paste_buffer[i] != q {
return false
}
}
return true
}
func (self *EscapeCodeParser) dispatch_char(ch UTF8State) error {
if self.state == bracketed_paste {
dispatch := func() error {
if len(self.bracketed_paste_buffer) > 0 {
for _, c := range self.bracketed_paste_buffer {
err := self.dispatch_rune(c)
if err != nil {
return err
}
}
self.bracketed_paste_buffer = self.bracketed_paste_buffer[:0]
}
return self.dispatch_rune(ch)
}
handle_ch := func(chars ...UTF8State) error {
if self.bp_buffer_equals(chars) {
self.bracketed_paste_buffer = append(self.bracketed_paste_buffer, ch)
if self.bracketed_paste_buffer[len(self.bracketed_paste_buffer)-1] == '~' {
self.reset_state()
}
return nil
} else {
return dispatch()
}
}
switch ch {
case 0x1b:
return handle_ch()
case '[':
return handle_ch(0x1b)
case '2':
return handle_ch(0x1b, '[')
case '0':
return handle_ch(0x1b, '[', '2')
case '1':
return handle_ch(0x1b, '[', '2', '0')
case '~':
return handle_ch(0x1b, '[', '2', '0', '1')
default:
return dispatch()
}
} // end self.state == bracketed_paste
switch ch {
case 0x1b:
self.state = esc
case 0x90:
self.state = st
self.current_callback = self.HandleDCS
case 0x9b:
self.state = csi
self.current_callback = self.HandleCSI
case 0x9d:
self.state = st_or_bel
self.current_callback = self.HandleOSC
case 0x98:
self.state = st
self.current_callback = self.HandleSOS
case 0x9e:
self.state = st
self.current_callback = self.HandlePM
case 0x9f:
self.state = st
self.current_callback = self.HandleAPC
default:
return self.dispatch_rune(ch)
}
return nil
}
func (self *EscapeCodeParser) dispatch_byte(ch byte) error {
switch self.state {
case esc:
switch ch {
case 'P':
self.state = st
self.current_callback = self.HandleDCS
case '[':
self.state = csi
self.csi_state = parameter
self.current_callback = self.HandleCSI
case ']':
self.state = st_or_bel
self.current_callback = self.HandleOSC
case '^':
self.state = st
self.current_callback = self.HandlePM
case '_':
self.state = st
self.current_callback = self.HandleAPC
default:
self.state = normal
}
case csi:
self.write_ch(ch)
switch self.csi_state {
case parameter:
switch csi_type(ch) {
case intermediate_csi_char:
self.csi_state = intermediate
case final_csi_char:
return self.dispatch_esc_code()
case unknown_csi_char:
self.invalid_escape_code()
}
case intermediate:
switch csi_type(ch) {
case parameter_csi_char, unknown_csi_char:
self.invalid_escape_code()
case final_csi_char:
return self.dispatch_esc_code()
}
}
case st_or_bel:
if ch == 0x7 {
return self.dispatch_esc_code()
}
fallthrough
case st:
if ch == 0x1b {
self.state = esc_st
} else if ch == 0xc2 {
self.state = c1_st
} else {
self.write_ch(ch)
}
case esc_st:
if ch == '\\' {
return self.dispatch_esc_code()
} else {
self.state = st
self.write_ch(0x1b)
if ch != 0x1b {
self.write_ch(ch)
}
}
case c1_st:
if ch == 0x9c {
return self.dispatch_esc_code()
} else {
self.state = st
self.write_ch(0xc2)
self.write_ch(ch)
}
}
return nil
}

View File

@@ -1,54 +0,0 @@
package utils
import (
"testing"
)
func TestEscapeCodeParsing(t *testing.T) {
type test_parse_collection struct {
actual, expected string
}
var d test_parse_collection
add := func(prefix string, b []byte) error {
d.actual += "\n" + prefix + ": " + string(b)
return nil
}
var test_parser = EscapeCodeParser{
HandleCSI: func(b []byte) error { return add("CSI", b) },
HandleOSC: func(b []byte) error { return add("OSC", b) },
HandleDCS: func(b []byte) error { return add("DCS", b) },
HandleSOS: func(b []byte) error { return add("SOS", b) },
HandlePM: func(b []byte) error { return add("PM", b) },
HandleAPC: func(b []byte) error { return add("APC", b) },
HandleRune: func(b rune) error { return add("CH", []byte(string(b))) },
}
reset_test_parser := func() {
test_parser.Reset()
d = test_parse_collection{}
}
check_test_result := func(raw string) {
if d.actual != d.expected {
t.Fatalf("parsing: %#v actual != expected: %#v != %#v", raw, string(d.actual), string(d.expected))
}
}
test := func(raw string, expected string) {
reset_test_parser()
d.expected = "\n" + expected
test_parser.Parse([]byte(raw))
check_test_result(raw)
}
test("\x1b[31m\xc2\x9bm", "CSI: 31m\nCSI: m")
test("ab\nc", "CH: a\nCH: b\nCH: \n\nCH: c")
test("a\x1b[200m\x1b[mb\x1b[5:3;2;4~", "CH: a\nCSI: 200m\nCSI: m\nCH: b\nCSI: 5:3;2;4~")
test("\x1b[200~a\x1b[201m\x1b[201~\x1b[x", "CH: a\nCH: \x1b\nCH: [\nCH: 2\nCH: 0\nCH: 1\nCH: m\nCSI: x")
test("a\x1bPb\x1b\x1bc\x1b\\d", "CH: a\nDCS: b\x1bc\nCH: d")
test("a\x1b_b\x1b\x1b\x1bc\x1b\\d", "CH: a\nAPC: b\x1b\x1bc\nCH: d")
test("\x1b]X\x07\x1b]X\x1b\x07\x1b\\", "OSC: X\nOSC: X\x1b\x07")
}

View File

@@ -26,7 +26,7 @@ const (
UTF8_REJECT = 1
)
func decode_utf8(state *UTF8State, codep *UTF8State, byte_ byte) UTF8State {
func DecodeUtf8(state *UTF8State, codep *UTF8State, byte_ byte) UTF8State {
typ := UTF8State(utf8_data[byte_])
b := UTF8State(byte_)
@@ -41,7 +41,7 @@ func decode_utf8(state *UTF8State, codep *UTF8State, byte_ byte) UTF8State {
return *state
}
func encode_utf8(ch UTF8State, dest []byte) int {
func EncodeUtf8(ch UTF8State, dest []byte) int {
if ch < 0x80 {
dest[0] = byte(ch)
return 1