open-vault/vendor/github.com/ryanuber/columnize/columnize.go

170 lines
4.2 KiB
Go
Raw Normal View History

2015-04-27 23:19:51 +00:00
package columnize
import (
2016-06-30 18:19:03 +00:00
"bytes"
2015-04-27 23:19:51 +00:00
"fmt"
"strings"
)
2016-07-23 00:11:47 +00:00
// Config can be used to tune certain parameters which affect the way
// in which Columnize will format output text.
2015-04-27 23:19:51 +00:00
type Config struct {
// The string by which the lines of input will be split.
Delim string
// The string by which columns of output will be separated.
Glue string
// The string by which columns of output will be prefixed.
Prefix string
2015-09-22 15:44:21 +00:00
// A replacement string to replace empty fields
Empty string
2015-04-27 23:19:51 +00:00
}
2016-07-23 00:11:47 +00:00
// DefaultConfig returns a *Config with default values.
2015-04-27 23:19:51 +00:00
func DefaultConfig() *Config {
return &Config{
Delim: "|",
Glue: " ",
Prefix: "",
2016-07-23 00:11:47 +00:00
Empty: "",
2015-04-27 23:19:51 +00:00
}
}
2016-07-23 00:11:47 +00:00
// MergeConfig merges two config objects together and returns the resulting
// configuration. Values from the right take precedence over the left side.
func MergeConfig(a, b *Config) *Config {
var result Config = *a
2015-04-27 23:19:51 +00:00
2016-07-23 00:11:47 +00:00
// Return quickly if either side was nil
if a == nil || b == nil {
return &result
}
2015-04-27 23:19:51 +00:00
2016-07-23 00:11:47 +00:00
if b.Delim != "" {
result.Delim = b.Delim
2015-04-27 23:19:51 +00:00
}
2016-07-23 00:11:47 +00:00
if b.Glue != "" {
result.Glue = b.Glue
}
if b.Prefix != "" {
result.Prefix = b.Prefix
}
if b.Empty != "" {
result.Empty = b.Empty
}
return &result
2015-04-27 23:19:51 +00:00
}
2016-07-23 00:11:47 +00:00
// stringFormat, given a set of column widths and the number of columns in
// the current line, returns a sprintf-style format string which can be used
// to print output aligned properly with other lines using the same widths set.
func stringFormat(c *Config, widths []int, columns int) string {
2016-06-30 18:19:03 +00:00
// Create the buffer with an estimate of the length
buf := bytes.NewBuffer(make([]byte, 0, (6+len(c.Glue))*columns))
// Start with the prefix, if any was given. The buffer will not return an
// error so it does not need to be handled
buf.WriteString(c.Prefix)
2015-04-27 23:19:51 +00:00
// Create the format string from the discovered widths
for i := 0; i < columns && i < len(widths); i++ {
if i == columns-1 {
2016-06-30 18:19:03 +00:00
buf.WriteString("%s\n")
2015-04-27 23:19:51 +00:00
} else {
2016-06-30 18:19:03 +00:00
fmt.Fprintf(buf, "%%-%ds%s", widths[i], c.Glue)
2015-04-27 23:19:51 +00:00
}
}
2016-06-30 18:19:03 +00:00
return buf.String()
2015-04-27 23:19:51 +00:00
}
2016-07-23 00:11:47 +00:00
// elementsFromLine returns a list of elements, each representing a single
// item which will belong to a column of output.
func elementsFromLine(config *Config, line string) []interface{} {
seperated := strings.Split(line, config.Delim)
elements := make([]interface{}, len(seperated))
for i, field := range seperated {
value := strings.TrimSpace(field)
2015-04-27 23:19:51 +00:00
2016-07-23 00:11:47 +00:00
// Apply the empty value, if configured.
if value == "" && config.Empty != "" {
value = config.Empty
}
elements[i] = value
2015-04-27 23:19:51 +00:00
}
2016-07-23 00:11:47 +00:00
return elements
}
2015-04-27 23:19:51 +00:00
2016-07-23 00:11:47 +00:00
// widthsFromLines examines a list of strings and determines how wide each
// column should be considering all of the elements that need to be printed
// within it.
func widthsFromLines(config *Config, lines []string) []int {
widths := make([]int, 0, 8)
2015-04-27 23:19:51 +00:00
2016-07-23 00:11:47 +00:00
for _, line := range lines {
elems := elementsFromLine(config, line)
for i := 0; i < len(elems); i++ {
l := len(elems[i].(string))
if len(widths) <= i {
widths = append(widths, l)
} else if widths[i] < l {
widths[i] = l
}
}
}
return widths
2015-04-27 23:19:51 +00:00
}
2016-07-23 00:11:47 +00:00
// Format is the public-facing interface that takes a list of strings and
// returns nicely aligned column-formatted text.
2015-04-27 23:19:51 +00:00
func Format(lines []string, config *Config) string {
conf := MergeConfig(DefaultConfig(), config)
2016-07-23 00:11:47 +00:00
widths := widthsFromLines(conf, lines)
2015-04-27 23:19:51 +00:00
2016-06-30 18:19:03 +00:00
// Estimate the buffer size
glueSize := len(conf.Glue)
var size int
for _, w := range widths {
size += w + glueSize
}
size *= len(lines)
// Create the buffer
buf := bytes.NewBuffer(make([]byte, 0, size))
// Create a cache for the string formats
fmtCache := make(map[int]string, 16)
2015-04-27 23:19:51 +00:00
// Create the formatted output using the format string
for _, line := range lines {
2016-07-23 00:11:47 +00:00
elems := elementsFromLine(conf, line)
2016-06-30 18:19:03 +00:00
// Get the string format using cache
numElems := len(elems)
stringfmt, ok := fmtCache[numElems]
if !ok {
2016-07-23 00:11:47 +00:00
stringfmt = stringFormat(conf, widths, numElems)
2016-06-30 18:19:03 +00:00
fmtCache[numElems] = stringfmt
}
fmt.Fprintf(buf, stringfmt, elems...)
2015-04-27 23:19:51 +00:00
}
2016-06-30 18:19:03 +00:00
// Get the string result
result := buf.String()
2015-04-27 23:19:51 +00:00
// Remove trailing newline without removing leading/trailing space
if n := len(result); n > 0 && result[n-1] == '\n' {
result = result[:n-1]
}
return result
}
2016-07-23 00:11:47 +00:00
// SimpleFormat is a convenience function to format text with the defaults.
2015-04-27 23:19:51 +00:00
func SimpleFormat(lines []string) string {
return Format(lines, nil)
}