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 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
|
package tblfmt
import (
"bytes"
"database/sql"
"encoding/json"
"fmt"
"reflect"
"strconv"
"strings"
"time"
"unicode"
"unicode/utf8"
runewidth "github.com/mattn/go-runewidth"
"golang.org/x/text/language"
"golang.org/x/text/message"
"golang.org/x/text/number"
)
// Formatter is the common interface for formatting values.
type Formatter interface {
// Header returns a slice of formatted values for the provided headers.
Header([]string) ([]*Value, error)
// Format returns a slice of formatted value the provided row values.
Format([]any) ([]*Value, error)
}
// EscapeFormatter is an escaping formatter, that handles formatting the
// standard Go types.
//
// When the encoder is not nil, then it will be passed any
// map[string]interface{} and []interface{} values encountered, otherwise the
// stdlib's encoding/json.Encoder will be used.
type EscapeFormatter struct {
// mask is used to format header values when the formatted value (after
// trimming spaces) is the empty string.
//
// Note: will have %d replaced with the column number (starting at 1).
mask string
// timeFormat is the format to use for time values.
timeFormat string
// timeLocation is the location to use for time values.
timeLocation *time.Location
// encoder will be used to encode map[string]interface{} and []interface{}
// types.
//
// If nil, the standard encoding/json.Encoder will be used instead.
encoder func(any) ([]byte, error)
// prefix is indent prefix used by the JSON encoder when encoder is nil.
prefix string
// indent is the indent used by the JSON encoder when encoder is nil.
indent string
// isJSON sets escaping JSON characters.
isJSON bool
// escapeHTML sets the JSON encoder used when encoder is nil to escape HTML
// characters.
escapeHTML bool
// isRaw sets raw escaping.
isRaw bool
// sep is the separator to use for raw (csv) encoding.
sep rune
// quote is the quote to use for raw (csv) encoding.
quote rune
// invalid is the value used for invalid utf8 runes when escaping.
invalid []byte
// invalidWidth is the rune width of the invalid value
invalidWidth int
// headerAlign is the default header values alignment
headerAlign Align
// numericLocalePrinter is the numeric locale printer.
numericLocalePrinter *message.Printer
}
// NewEscapeFormatter creates a escape formatter to handle basic Go values,
// such as []byte, string, time.Time, and sql.Null*. Formatting for
// map[string]interface{} and []interface{} will be passed to a marshaler
// provided by [WithEncoder], otherwise the standard [encoding/json.Encoder]
// will be used to marshal those values.
func NewEscapeFormatter(opts ...EscapeFormatterOption) *EscapeFormatter {
f := &EscapeFormatter{
mask: "%d",
timeFormat: time.RFC3339Nano,
indent: " ",
}
for _, o := range opts {
o(f)
}
return f
}
// Header satisfies the Formatter interface.
func (f *EscapeFormatter) Header(headers []string) ([]*Value, error) {
n := len(headers)
res := make([]*Value, n)
for i := range n {
s := strings.TrimSpace(headers[i])
switch {
case s == "" && strings.ContainsRune(f.mask, '%'):
s = fmt.Sprintf(f.mask, i+1)
case s == "":
s = f.mask
}
res[i] = FormatBytes([]byte(s), f.invalid, f.invalidWidth, f.isJSON, f.isRaw, f.sep, f.quote)
res[i].Align = f.headerAlign
}
return res, nil
}
// Format satisfies the Formatter interface.
func (f *EscapeFormatter) Format(vals []any) ([]*Value, error) {
n := len(vals)
res := make([]*Value, n)
// TODO: change time to v.AppendFormat() + pool
// TODO: use strconv.Format* for numeric times
// TODO: use pool
// TODO: allow configurable runes that can be escaped
// TODO: handler driver.Valuer
for i := range n {
val := deref(vals[i])
switch v := val.(type) {
case nil:
case bool:
res[i] = newValue(strconv.FormatBool(v), AlignLeft, true)
case int, int8, int16, int32, int64,
uint, uint8, uint16, uint32, uint64:
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v))
} else {
s = fmt.Sprintf("%d", v)
}
res[i] = newValue(s, AlignRight, true)
case float32:
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v, number.MinFractionDigits(1)))
} else {
s = strconv.FormatFloat(float64(v), 'g', -1, 32)
}
res[i] = newValue(s, AlignRight, true)
case float64:
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v, number.MinFractionDigits(1)))
} else {
s = strconv.FormatFloat(v, 'g', -1, 64)
}
res[i] = newValue(s, AlignRight, true)
case uintptr:
res[i] = newValue(fmt.Sprintf("(0x%x)", v), AlignRight, true)
case complex64:
res[i] = newValue(fmt.Sprintf("%g", v), AlignRight, false)
case complex128:
res[i] = newValue(fmt.Sprintf("%g", v), AlignRight, false)
case []byte:
res[i] = FormatBytes(v, f.invalid, f.invalidWidth, f.isJSON, f.isRaw, f.sep, f.quote)
case string:
res[i] = FormatBytes([]byte(v), f.invalid, f.invalidWidth, f.isJSON, f.isRaw, f.sep, f.quote)
case time.Time:
t := v
if f.timeLocation != nil {
t = t.In(f.timeLocation)
}
res[i] = newValue(t.Format(f.timeFormat), AlignLeft, false)
case sql.NullBool:
if v.Valid {
res[i] = newValue(strconv.FormatBool(v.Bool), AlignLeft, true)
}
case sql.NullByte:
if v.Valid {
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v.Byte))
} else {
s = fmt.Sprintf("%d", v.Byte)
}
res[i] = newValue(s, AlignRight, true)
}
case sql.NullFloat64:
if v.Valid {
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v.Float64))
} else {
s = strconv.FormatFloat(v.Float64, 'g', -1, 64)
}
res[i] = newValue(s, AlignRight, true)
}
case sql.NullInt16:
if v.Valid {
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v.Int16))
} else {
s = strconv.FormatInt(int64(v.Int16), 10)
}
res[i] = newValue(s, AlignRight, true)
}
case sql.NullInt32:
if v.Valid {
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v.Int32))
} else {
s = strconv.FormatInt(int64(v.Int32), 10)
}
res[i] = newValue(s, AlignRight, true)
}
case sql.NullInt64:
if v.Valid {
var s string
if f.numericLocalePrinter != nil {
s = f.numericLocalePrinter.Sprintf("%v", number.Decimal(v.Int64))
} else {
s = strconv.FormatInt(v.Int64, 10)
}
res[i] = newValue(s, AlignRight, true)
}
case sql.NullString:
if v.Valid {
res[i] = FormatBytes([]byte(v.String), f.invalid, f.invalidWidth, f.isJSON, f.isRaw, f.sep, f.quote)
}
case sql.NullTime:
if v.Valid {
t := v.Time
if f.timeLocation != nil {
t = t.In(f.timeLocation)
}
res[i] = newValue(t.Format(f.timeFormat), AlignLeft, false)
}
case sql.RawBytes:
res[i] = FormatBytes(v, f.invalid, f.invalidWidth, f.isJSON, f.isRaw, f.sep, f.quote)
case fmt.Stringer:
res[i] = FormatBytes([]byte(v.String()), f.invalid, f.invalidWidth, f.isJSON, f.isRaw, f.sep, f.quote)
default:
// TODO: pool
if f.encoder != nil {
buf, err := f.encoder(v)
if err != nil {
return nil, err
}
res[i] = &Value{
Buf: buf,
Raw: true,
}
} else {
// json encode
buf := new(bytes.Buffer)
enc := json.NewEncoder(buf)
enc.SetIndent(f.prefix, f.indent)
enc.SetEscapeHTML(f.escapeHTML)
if err := enc.Encode(v); err != nil {
return nil, err
}
if f.isJSON {
res[i] = &Value{
Buf: bytes.TrimSpace(buf.Bytes()),
Raw: true,
}
} else {
res[i] = FormatBytes(bytes.TrimSpace(buf.Bytes()), f.invalid, f.invalidWidth, false, f.isRaw, f.sep, f.quote)
res[i].Raw = true
}
}
}
}
return res, nil
}
// valueFromBuffer returns a value from a buffer known not to contain
// characters to escape.
func newValue(str string, align Align, raw bool) *Value {
v := &Value{Buf: []byte(str), Align: align, Raw: raw}
v.Width = len(v.Buf)
return v
}
// lowerhex is the set of lower hex characters.
const lowerhex = "0123456789abcdef"
// FormatBytes parses src, saving escaped (encoded) and unescaped runes to a
// Value, along with tab and newline positions in the generated buf.
func FormatBytes(src []byte, invalid []byte, invalidWidth int, isJSON, isRaw bool, sep, quote rune) *Value {
res := &Value{
Tabs: make([][][2]int, 1),
}
var tmp [4]byte
var r rune
var l, w int
for ; len(src) > 0; src = src[w:] {
r, w = rune(src[0]), 1
// lazy decode
if r >= utf8.RuneSelf {
r, w = utf8.DecodeRune(src)
}
// invalid rune decoded
if w == 1 && r == utf8.RuneError {
// replace with invalid (if set), otherwise hex encode
if invalid != nil {
res.Buf = append(res.Buf, invalid...)
res.Width += invalidWidth
res.Quoted = true
} else if isJSON {
res.Buf = append(res.Buf, '\\', 'u')
for s := 12; s >= 0; s -= 4 {
res.Buf = append(res.Buf, lowerhex[r>>uint(s)&0xf])
}
} else {
res.Buf = append(res.Buf, '\\', 'x', lowerhex[src[0]>>4], lowerhex[src[0]&0xf])
res.Width += 4
res.Quoted = true
}
continue
}
// handle json encoding
if isJSON {
switch r {
case '\a':
res.Buf = append(res.Buf, '\\', 'u', '0', '0', '0', '7')
res.Width += 6
continue
case '\b':
res.Buf = append(res.Buf, '\\', 'b')
res.Width += 2
continue
case '\f':
res.Buf = append(res.Buf, '\\', 'f')
res.Width += 2
continue
case '\n':
res.Buf = append(res.Buf, '\\', 'n')
res.Width += 2
continue
case '\r':
res.Buf = append(res.Buf, '\\', 'r')
res.Width += 2
continue
case '\t':
res.Buf = append(res.Buf, '\\', 't')
res.Width += 2
continue
case '"':
res.Buf = append(res.Buf, '\\', '"')
res.Width += 2
continue
case '\\':
res.Buf = append(res.Buf, '\\', '\\')
res.Width += 2
continue
}
}
// handle raw encoding
if isRaw {
n := utf8.EncodeRune(tmp[:], r)
res.Buf = append(res.Buf, tmp[:n]...)
res.Width += runewidth.RuneWidth(r)
switch {
case r == sep:
res.Quoted = true
case r == quote && quote != 0:
res.Buf = append(res.Buf, tmp[:n]...)
res.Width += runewidth.RuneWidth(r)
res.Quoted = true
default:
res.Quoted = res.Quoted || unicode.IsSpace(r)
}
continue
}
// printable character
if strconv.IsGraphic(r) {
n := utf8.EncodeRune(tmp[:], r)
res.Buf = append(res.Buf, tmp[:n]...)
res.Width += runewidth.RuneWidth(r)
continue
}
switch r {
// escape \a \b \f \r \v (Go special characters)
case '\a':
res.Buf = append(res.Buf, '\\', 'a')
res.Width += 2
case '\b':
res.Buf = append(res.Buf, '\\', 'b')
res.Width += 2
case '\f':
res.Buf = append(res.Buf, '\\', 'f')
res.Width += 2
case '\r':
res.Buf = append(res.Buf, '\\', 'r')
res.Width += 2
case '\v':
res.Buf = append(res.Buf, '\\', 'v')
res.Width += 2
case '\t':
// save position
res.Tabs[l] = append(res.Tabs[l], [2]int{len(res.Buf), res.Width})
res.Buf = append(res.Buf, '\t')
res.Width = 0
case '\n':
// save position
res.Newlines = append(res.Newlines, [2]int{len(res.Buf), res.Width})
res.Buf = append(res.Buf, '\n')
res.Width = 0
// increase line count
res.Tabs = append(res.Tabs, nil)
l++
default:
switch {
// escape as \x00
case r < ' ' && !isJSON:
res.Buf = append(res.Buf, '\\', 'x', lowerhex[byte(r)>>4], lowerhex[byte(r)&0xf])
res.Width += 4
// escape as \u0000
case r > utf8.MaxRune:
r = 0xfffd
fallthrough
case r < 0x10000:
res.Buf = append(res.Buf, '\\', 'u')
for s := 12; s >= 0; s -= 4 {
res.Buf = append(res.Buf, lowerhex[r>>uint(s)&0xf])
}
res.Width += 6
// escape as \U00000000
default:
res.Buf = append(res.Buf, '\\', 'U')
for s := 28; s >= 0; s -= 4 {
res.Buf = append(res.Buf, lowerhex[r>>uint(s)&0xf])
}
res.Width += 10
}
}
}
return res
}
// Value contains information pertaining to a formatted value.
type Value struct {
// Buf is the formatted value.
Buf []byte
// Newlines are the positions of newline characters in Buf.
Newlines [][2]int
// Tabs are the positions of tab characters in Buf, split per line.
Tabs [][][2]int
// Width is the remaining width.
Width int
// Align indicates value alignment.
Align Align
// Raw tracks whether or not the value should be encoded or not.
Raw bool
// Quoted tracks whether or not a raw value should be quoted or not (ie,
// contains a space or non printable character).
Quoted bool
}
func (v Value) String() string {
return string(v.Buf)
}
// LineWidth returns the line width (in runes) of line l.
func (v *Value) LineWidth(l, offset, tab int) int {
var width int
if l < len(v.Newlines) {
width += v.Newlines[l][1]
}
if len(v.Tabs[l]) != 0 {
width += tabwidth(v.Tabs[l], offset, tab)
}
if l == len(v.Newlines) {
width += v.Width
}
return width
}
// MaxWidth calculates the maximum width (in runes) of the longest line
// contained in Buf, relative to starting offset and the tab width.
func (v *Value) MaxWidth(offset, tab int) int {
// simple values do not have tabulations
width := v.Width
for l := 0; l < len(v.Tabs); l++ {
width = max(width, v.LineWidth(l, offset, tab))
}
return width
}
// Align indicates an alignment direction for a value.
type Align int
// Align values.
const (
AlignLeft Align = iota
AlignRight
AlignCenter
)
// String satisfies the fmt.Stringer interface.
func (a Align) String() string {
switch a {
case AlignLeft:
return "Left"
case AlignRight:
return "Right"
case AlignCenter:
return "Center"
}
return fmt.Sprintf("Align(%d)", a)
}
// tabwidth returns the rune width of buf containing tabs from start position
// in buf, a column offset, and given tab width.
func tabwidth(tabs [][2]int, offset, tab int) int {
// log.Printf("tabs: %v, offset: %d, tab: %d", tabs, offset, tab)
width := offset
for i := range tabs {
width += tabs[i][1]
width += (tab - width%tab)
}
// log.Printf("res: %d", width-offset)
return width - offset
}
// EscapeFormatterOption is an escape formatter option.
type EscapeFormatterOption func(*EscapeFormatter)
// WithMask is an escape formatter option to set the mask used for empty
// headers.
func WithMask(mask string) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.mask = mask
}
}
// WithTimeFormat is an escape formatter option to set the time format used for
// time values.
func WithTimeFormat(timeFormat string) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.timeFormat = timeFormat
}
}
// WithTimeLocation is an escape formatter option to set the time location used
// for time values.
func WithTimeLocation(timeLocation *time.Location) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.timeLocation = timeLocation
}
}
// WithEncoder is an escape formatter option to set a standard Go encoder to
// use for encoding the value.
func WithEncoder(encoder func(any) ([]byte, error)) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.encoder = encoder
}
}
// WithIsJSON is an escape formatter option to enable special escaping for JSON
// characters in non-complex values.
func WithIsJSON(isJSON bool) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.isJSON = isJSON
}
}
// WithJSONConfig is an escape formatter option to set the JSON encoding
// prefix, indent value, and whether or not to escape HTML. Passed to the
// standard encoding/json.Encoder when a marshaler has not been set on the
// escape formatter.
func WithJSONConfig(prefix, indent string, escapeHTML bool) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.prefix, f.indent, f.escapeHTML = prefix, indent, escapeHTML
}
}
// WithIsRaw is an escape formatter option to enable special escaping for raw
// characters in values.
func WithIsRaw(isRaw bool, sep, quote rune) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.isRaw, f.sep, f.quote = isRaw, sep, quote
}
}
// WithInvalid is an escape formatter option to set the invalid value used when
// an invalid rune is encountered during escaping.
func WithInvalid(invalid string) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.invalid = []byte(invalid)
f.invalidWidth = runewidth.StringWidth(invalid)
}
}
// WithHeaderAlign sets the alignment of header values.
func WithHeaderAlign(a Align) EscapeFormatterOption {
return func(f *EscapeFormatter) {
f.headerAlign = a
}
}
// WithNumericLocale sets the numeric locale printer.
func WithNumericLocale(enable bool, locale string) EscapeFormatterOption {
return func(f *EscapeFormatter) {
if enable {
tag := language.English
if t, err := language.Parse(locale); err == nil {
tag = t
}
f.numericLocalePrinter = message.NewPrinter(tag)
}
}
}
// deref dereferences a pointer to an interface.
func deref(v any) any {
switch z := v.(type) {
case *any:
return *z
}
val := reflect.ValueOf(v)
if val.Kind() == reflect.Ptr {
val = val.Elem()
}
return val.Interface()
}
|