1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
|
// License: GPLv3 Copyright: 2023, Kovid Goyal, <kovid at kovidgoyal.net>
package sgr
import (
"fmt"
"slices"
"strconv"
"strings"
"unicode/utf8"
"github.com/kovidgoyal/kitty/tools/utils"
"github.com/kovidgoyal/kitty/tools/utils/style"
"github.com/kovidgoyal/kitty/tools/wcswidth"
)
var _ = fmt.Print
type UnderlineStyle uint8
const (
No_underline UnderlineStyle = iota
Straight_underline
Double_underline
Curly_underline
Dotted_underline
Dashed_underline
)
type Color struct {
Red, Green, Blue uint8
Is_numbered bool
}
func (self *Color) Set(val any) (err error) {
switch v := val.(type) {
case int:
self.Is_numbered = true
self.Red = uint8(v)
case style.RGBA:
self.Is_numbered = false
self.Red, self.Green, self.Blue = v.Red, v.Green, v.Blue
case string:
rgba, err := style.ParseColor(v)
if err != nil {
return err
}
self.Is_numbered = false
self.Red, self.Green, self.Blue = rgba.Red, rgba.Green, rgba.Blue
default:
return fmt.Errorf("Unknown type to set color from: %T", v)
}
return nil
}
func (self Color) AsCSI(base int) string {
if self.Is_numbered && base < 50 {
if self.Red < 8 {
return strconv.Itoa(base + int(self.Red))
}
if self.Red < 16 {
return strconv.Itoa(base + 52 + int(self.Red))
}
return fmt.Sprintf("%d:5:%d", base+8, self.Red)
}
return fmt.Sprintf("%d:2:%d:%d:%d", base+8, self.Red, self.Green, self.Blue)
}
func (self *Color) FromNumber(n uint8) {
self.Is_numbered, self.Red = true, n
}
func as_uint8(x int) uint8 {
return uint8(uint(x) & 0xff)
}
func (self *Color) FromExtended(nums ...int) bool {
switch nums[0] {
case 5:
if len(nums) > 1 {
self.Red = as_uint8(nums[1])
self.Is_numbered = true
return true
}
case 2:
if len(nums) > 3 {
self.Is_numbered = false
self.Red, self.Green, self.Blue = as_uint8(nums[1]), as_uint8(nums[2]), as_uint8(nums[3])
return true
}
}
return false
}
type BoolVal struct{ Is_set, Val bool }
type UnderlineStyleVal struct {
Is_set bool
Val UnderlineStyle
}
type ColorVal struct {
Is_set, Is_default bool
Val Color
}
type SGR struct {
Italic, Reverse, Bold, Dim, Strikethrough BoolVal
Underline_style UnderlineStyleVal
Foreground, Background, Underline_color ColorVal
}
func (self *BoolVal) AsCSI(set, reset string) string {
if !self.Is_set {
return ""
}
if self.Val {
return set
}
return reset
}
func (self *UnderlineStyleVal) AsCSI() string {
if !self.Is_set {
return ""
}
return fmt.Sprintf("4:%d;", self.Val)
}
func (self *ColorVal) AsCSI(base int) string {
if !self.Is_set {
return ""
}
if self.Is_default {
return strconv.Itoa(base + 9)
}
return self.Val.AsCSI(base)
}
func (self *SGR) AsCSI() string {
ans := make([]byte, 0, 16)
w := func(x string) {
if x != "" {
ans = append(ans, x...)
ans = append(ans, ';')
}
}
w(self.Bold.AsCSI("1", "221"))
w(self.Dim.AsCSI("2", "222"))
w(self.Italic.AsCSI("3", "23"))
w(self.Reverse.AsCSI("7", "27"))
w(self.Strikethrough.AsCSI("9", "29"))
w(self.Underline_style.AsCSI())
w(self.Foreground.AsCSI(30))
w(self.Background.AsCSI(40))
w(self.Underline_color.AsCSI(50))
if len(ans) > 0 {
ans = ans[:len(ans)-1]
ans = append(ans, 'm')
}
return utils.UnsafeBytesToString(ans)
}
func (self *SGR) IsEmpty() bool {
return !(self.Foreground.Is_set || self.Background.Is_set || self.Underline_color.Is_set || self.Underline_style.Is_set || self.Italic.Is_set || self.Bold.Is_set || self.Reverse.Is_set || self.Dim.Is_set || self.Strikethrough.Is_set)
}
func (self *SGR) ApplyMask(other SGR) {
if other.Italic.Is_set {
self.Italic.Is_set = false
}
if other.Reverse.Is_set {
self.Reverse.Is_set = false
}
if other.Bold.Is_set {
self.Bold.Is_set = false
}
if other.Dim.Is_set {
self.Dim.Is_set = false
}
if other.Strikethrough.Is_set {
self.Strikethrough.Is_set = false
}
if other.Underline_style.Is_set {
self.Underline_style.Is_set = false
}
if other.Foreground.Is_set {
self.Foreground.Is_set = false
}
if other.Background.Is_set {
self.Background.Is_set = false
}
if other.Underline_color.Is_set {
self.Underline_color.Is_set = false
}
}
func (self *SGR) ApplySGR(other SGR) {
if other.Italic.Is_set {
self.Italic = other.Italic
}
if other.Reverse.Is_set {
self.Reverse = other.Reverse
}
if other.Bold.Is_set {
self.Bold = other.Bold
}
if other.Dim.Is_set {
self.Dim = other.Dim
}
if other.Strikethrough.Is_set {
self.Strikethrough = other.Strikethrough
}
if other.Underline_style.Is_set {
self.Underline_style = other.Underline_style
}
if other.Foreground.Is_set {
self.Foreground = other.Foreground
}
if other.Background.Is_set {
self.Background = other.Background
}
if other.Underline_color.Is_set {
self.Underline_color = other.Underline_color
}
}
func SGRFromCSI(csi string) (ans SGR) {
if !strings.HasSuffix(csi, "m") {
return
}
csi = csi[:len(csi)-1]
if csi == "" {
csi = "0"
}
parts := strings.Split(csi, ";")
nums := make([]int, 0, 8)
for _, part := range parts {
subparts := strings.Split(part, ":")
nums = nums[:0]
for _, b := range subparts {
q, err := strconv.Atoi(b)
if err == nil {
nums = append(nums, q)
}
}
if len(nums) == 0 {
continue
}
switch nums[0] {
case 0:
ans = SGR{}
case 1:
ans.Bold.Val, ans.Bold.Is_set = true, true
case 221:
ans.Bold.Val, ans.Bold.Is_set = false, true
case 2:
ans.Dim.Val, ans.Dim.Is_set = true, true
case 222:
ans.Dim.Val, ans.Dim.Is_set = false, true
case 22:
ans.Dim.Val, ans.Bold.Val = false, false
ans.Dim.Is_set, ans.Bold.Is_set = true, true
case 3:
ans.Italic.Is_set, ans.Italic.Val = true, true
case 23:
ans.Italic.Is_set, ans.Italic.Val = true, false
case 7:
ans.Reverse.Is_set, ans.Reverse.Val = true, true
case 27:
ans.Reverse.Is_set, ans.Reverse.Val = true, false
case 9:
ans.Strikethrough.Is_set, ans.Strikethrough.Val = true, true
case 29:
ans.Strikethrough.Is_set, ans.Strikethrough.Val = true, false
case 24:
ans.Underline_style.Is_set, ans.Underline_style.Val = true, No_underline
case 4:
us := 1
if len(nums) > 1 {
us = nums[1]
}
switch us {
case 0:
ans.Underline_style.Is_set, ans.Underline_style.Val = true, No_underline
case 1:
ans.Underline_style.Is_set, ans.Underline_style.Val = true, Straight_underline
case 2:
ans.Underline_style.Is_set, ans.Underline_style.Val = true, Double_underline
case 3:
ans.Underline_style.Is_set, ans.Underline_style.Val = true, Curly_underline
case 4:
ans.Underline_style.Is_set, ans.Underline_style.Val = true, Dotted_underline
case 5:
ans.Underline_style.Is_set, ans.Underline_style.Val = true, Dashed_underline
}
case 30, 31, 32, 33, 34, 35, 36, 37:
ans.Foreground.Is_set, ans.Foreground.Is_default = true, false
ans.Foreground.Val.FromNumber(uint8(nums[0] - 30))
case 90, 91, 92, 93, 94, 95, 96, 97:
ans.Foreground.Is_set, ans.Foreground.Is_default = true, false
ans.Foreground.Val.FromNumber(uint8(nums[0] - 82))
case 38:
if ans.Foreground.Val.FromExtended(nums[1:]...) {
ans.Foreground.Is_set, ans.Foreground.Is_default = true, false
}
case 39:
ans.Foreground.Is_set, ans.Foreground.Is_default = true, true
case 40, 41, 42, 43, 44, 45, 46, 47:
ans.Background.Is_set, ans.Background.Is_default = true, false
ans.Background.Val.FromNumber(uint8(nums[0] - 40))
case 100, 101, 102, 103, 104, 105, 106, 107:
ans.Background.Is_set, ans.Background.Is_default = true, false
ans.Background.Val.FromNumber(uint8(nums[0] - 92))
case 48:
if ans.Background.Val.FromExtended(nums[1:]...) {
ans.Background.Is_set, ans.Background.Is_default = true, false
}
case 49:
ans.Background.Is_set, ans.Background.Is_default = true, true
case 58:
if ans.Underline_color.Val.FromExtended(nums[1:]...) {
ans.Underline_color.Is_set, ans.Underline_color.Is_default = true, false
}
case 59:
ans.Underline_color.Is_set, ans.Underline_color.Is_default = true, true
}
}
return
}
type Span struct {
Offset, Size int // in bytes
opening_sgr, closing_sgr SGR
}
func NewSpan(offset, size int) *Span {
return &Span{Offset: offset, Size: size}
}
func (self *BoolVal) Set(val bool) {
self.Is_set = true
self.Val = val
}
func (self *ColorVal) Set(val any) {
self.Is_set = true
if val == nil {
self.Is_default = true
} else {
self.Is_default = false
if err := self.Val.Set(val); err != nil {
panic(err)
}
}
}
func (self *Span) SetForeground(val any) *Span {
self.opening_sgr.Foreground.Set(val)
return self
}
func (self *Span) SetBackground(val any) *Span {
self.opening_sgr.Background.Set(val)
return self
}
func (self *Span) SetUnderlineColor(val any) *Span {
self.opening_sgr.Underline_color.Set(val)
return self
}
func (self *Span) SetItalic(val bool) *Span {
self.opening_sgr.Italic.Set(val)
return self
}
func (self *Span) SetBold(val bool) *Span {
self.opening_sgr.Bold.Set(val)
return self
}
func (self *Span) SetReverse(val bool) *Span {
self.opening_sgr.Reverse.Set(val)
return self
}
func (self *Span) SetDim(val bool) *Span {
self.opening_sgr.Dim.Set(val)
return self
}
func (self *Span) SetStrikethrough(val bool) *Span {
self.opening_sgr.Strikethrough.Set(val)
return self
}
func (self *Span) SetUnderlineStyle(val UnderlineStyle) *Span {
self.opening_sgr.Underline_style.Is_set = true
self.opening_sgr.Underline_style.Val = val
return self
}
func (self *Span) SetClosingForeground(val any) *Span {
self.closing_sgr.Foreground.Set(val)
return self
}
func (self *Span) SetClosingBackground(val any) *Span {
self.closing_sgr.Background.Set(val)
return self
}
func (self *Span) SetClosingUnderlineColor(val any) *Span {
self.closing_sgr.Underline_color.Set(val)
return self
}
func (self *Span) SetClosingItalic(val bool) *Span {
self.closing_sgr.Italic.Set(val)
return self
}
func (self *Span) SetClosingBold(val bool) *Span {
self.closing_sgr.Bold.Set(val)
return self
}
func (self *Span) SetClosingReverse(val bool) *Span {
self.closing_sgr.Reverse.Set(val)
return self
}
func (self *Span) SetClosingDim(val bool) *Span {
self.closing_sgr.Dim.Set(val)
return self
}
func (self *Span) SetClosingStrikethrough(val bool) *Span {
self.closing_sgr.Strikethrough.Set(val)
return self
}
func (self *Span) SetClosingUnderlineStyle(val UnderlineStyle) *Span {
self.closing_sgr.Underline_style.Is_set = true
self.opening_sgr.Underline_style.Val = val
return self
}
// Insert formatting into text at the specified offsets, overriding any existing formatting, and restoring
// existing formatting after the replaced sections.
func InsertFormatting(text string, spans ...*Span) string {
spans = utils.Filter(spans, func(s *Span) bool { return !s.opening_sgr.IsEmpty() })
if len(spans) == 0 {
return text
}
var in_span *Span
ans := make([]byte, 0, 2*len(text))
var overall_sgr_state SGR
slices.SortFunc(spans, func(a, b *Span) int { return a.Offset - b.Offset })
text_len := 0
var ep *wcswidth.EscapeCodeParser
write_csi := func(csi string) {
if csi != "" {
ans = append(ans, 0x1b, '[')
ans = append(ans, csi...)
}
}
open_span := func() {
in_span = spans[0]
spans = spans[1:]
if in_span.Size > 0 {
write_csi(in_span.opening_sgr.AsCSI())
} else {
in_span = nil
}
}
close_span := func() {
write_csi(in_span.closing_sgr.AsCSI())
write_csi(overall_sgr_state.AsCSI())
in_span = nil
}
ep = &wcswidth.EscapeCodeParser{
HandleRune: func(ch rune) error {
var rlen int
if in_span == nil {
if len(spans) > 0 && text_len >= spans[0].Offset {
open_span()
return ep.HandleRune(ch)
}
before := len(ans)
ans = utf8.AppendRune(ans, ch)
rlen = len(ans) - before
} else {
rlen = utf8.RuneLen(ch)
if text_len+rlen > in_span.Offset+in_span.Size {
close_span()
}
ans = utf8.AppendRune(ans, ch)
}
text_len += rlen
return nil
},
HandleCSI: func(csib []byte) error {
csi := utils.UnsafeBytesToString(csib)
if len(csi) == 0 || csi[len(csi)-1] != 'm' {
write_csi(csi)
return nil
}
sgr := SGRFromCSI(csi)
overall_sgr_state.ApplySGR(sgr)
if in_span == nil {
write_csi(csi)
} else {
sgr.ApplyMask(in_span.opening_sgr)
csi := sgr.AsCSI()
write_csi(csi)
}
return nil
},
HandleOSC: func(osc []byte) error {
ans = append(ans, 0x1b, ']')
ans = append(ans, osc...)
ans = append(ans, 0x1b, '\\')
return nil
},
}
ep.ParseString(text)
if in_span != nil {
close_span()
}
return utils.UnsafeBytesToString(ans)
}
|