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
|
package tableprinter
import (
"fmt"
"strings"
"gitlab.com/gitlab-org/cli/pkg/text"
)
var tp *TablePrinter
func init() {
tp = &TablePrinter{
TotalRows: 0,
Wrap: false,
MaxColWidth: 0,
TTYSeparator: "\t",
NonTTYSeparator: "\t",
TerminalWidth: 80,
}
}
// TablePrinter represents a decorator that renders the data formatted in a tabular form.
type TablePrinter struct {
// Total number of records. Needed if AddRowFunc is used
TotalRows int
// Wrap when set to true wraps the contents of the columns when the length exceeds the MaxColWidth
Wrap bool
// MaxColWidth is the maximum allowed width for cells in the table
MaxColWidth int
// TTYSeparator is the separator for columns in the table on TTYs. Default is "\t"
TTYSeparator string
// NonTTYSeparator is the separator for columns in the table on non-TTYs. Default is "\t"
NonTTYSeparator string
// Rows is the collection of rows in the table
Rows []*TableRow
// TerminalWidth is the max width of the terminal
TerminalWidth int
// IsTTY indicates whether output is a TTY or non-TTY
IsTTY bool
}
type TableCell struct {
// Value in the cell
Value interface{}
// Width is the width of the cell
Width int
// Wrap when true wraps the contents of the cell when the length exceeds the width
Wrap bool
isaTTY bool
}
type TableRow struct {
Cells []*TableCell
// Separator is the separator for columns in the table. Default is " "
Separator string
}
func NewTablePrinter() *TablePrinter {
t := &TablePrinter{
TTYSeparator: tp.TTYSeparator,
NonTTYSeparator: tp.NonTTYSeparator,
MaxColWidth: tp.MaxColWidth,
Wrap: false,
TerminalWidth: tp.TerminalWidth,
IsTTY: tp.IsTTY,
}
return t
}
func (t *TablePrinter) Separator() string {
if t.IsTTY {
return t.TTYSeparator
}
return t.NonTTYSeparator
}
// SetTerminalWidth sets the maximum width for the terminal
func SetTerminalWidth(width int) { tp.SetTerminalWidth(width) }
func (t *TablePrinter) SetTerminalWidth(width int) {
t.TerminalWidth = width
}
// SetIsTTY sets the IsTTY variable which indicates whether terminal
// output is a TTY or nonTTY
func SetIsTTY(isTTY bool) { tp.SetIsTTY(isTTY) }
func (t *TablePrinter) SetIsTTY(isTTY bool) {
t.IsTTY = isTTY
}
// SetTTYSeparator sets the separator for the columns in the table for TTYs
func SetTTYSeparator(s string) { tp.SetTTYSeparator(s) }
func (t *TablePrinter) SetTTYSeparator(s string) {
t.TTYSeparator = s
}
// SetNonTTYSeparator sets the separator for the columns in the table for non-ttys
func SetNonTTYSeparator(s string) { tp.SetNonTTYSeparator(s) }
func (t *TablePrinter) SetNonTTYSeparator(s string) {
t.NonTTYSeparator = s
}
func (t *TablePrinter) makeRow() {
if t.Rows == nil {
t.Rows = make([]*TableRow, 1)
t.Rows[0] = &TableRow{}
}
}
func (t *TablePrinter) AddCell(s interface{}) {
t.makeRow()
rowI := len(t.Rows) - 1
row := t.Rows[rowI]
cell := &TableCell{
Value: s,
isaTTY: t.IsTTY,
}
row.Separator = t.Separator()
row.Cells = append(row.Cells, cell)
}
// AddCellf formats according to a format specifier and adds cell to row
func (t *TablePrinter) AddCellf(s string, f ...interface{}) {
t.AddCell(fmt.Sprintf(s, f...))
}
func (t *TablePrinter) AddRow(str ...interface{}) {
for _, s := range str {
t.AddCell(s)
}
t.EndRow()
}
func (t *TablePrinter) AddRowFunc(f func(int, int) string) {
for ri := 0; ri < t.TotalRows; ri++ {
row := make([]interface{}, t.TotalRows)
for ci := range row {
row[ci] = f(ri, ci)
}
t.AddRow(row)
t.EndRow()
}
}
func (t *TablePrinter) EndRow() {
t.Rows = append(t.Rows, &TableRow{Cells: make([]*TableCell, 1)})
}
// Bytes returns the []byte value of table
func (t *TablePrinter) Bytes() []byte {
return []byte(t.String())
}
// String returns the string value of table. Alternative to Render()
func (t *TablePrinter) String() string {
return t.Render()
}
// String returns the string representation of the row
func (r *TableRow) String() string {
// get the max number of lines for each cell
var lc int // line count
for _, cell := range r.Cells {
if clc := len(strings.Split(cell.String(), "\n")); clc > lc {
lc = clc
}
}
// allocate a two-dimensional array of cells for each line and add size them
cells := make([][]*TableCell, lc)
for x := 0; x < lc; x++ {
cells[x] = make([]*TableCell, len(r.Cells))
for y := 0; y < len(r.Cells); y++ {
cells[x][y] = &TableCell{Width: r.Cells[y].Width}
}
}
// insert each line in a cell as new cell in the cells array
for y, cell := range r.Cells {
lines := strings.Split(cell.String(), "\n")
for x, line := range lines {
cells[x][y].Value = line
}
}
// format each line
lines := make([]string, lc)
for x := range lines {
line := make([]string, len(cells[x]))
for y := range cells[x] {
line[y] = cells[x][y].String()
}
lines[x] = text.Join(line, r.Separator)
}
return strings.Join(lines, "\n")
}
// purgeRow removes nil cells and rows
func (t *TablePrinter) purgeRow() {
newSlice := make([]*TableRow, 0, len(t.Rows))
for _, row := range t.Rows {
var newRow *TableRow
if len(row.Cells) > 0 && row.Cells != nil {
var newCells []*TableCell
for _, cell := range row.Cells {
if cell != nil {
newCells = append(newCells, cell)
}
}
newRow = &TableRow{Cells: newCells}
}
if newRow != nil {
newSlice = append(newSlice, newRow)
}
}
t.Rows = newSlice
}
// Render builds and returns the string representation of the table
func (t *TablePrinter) Render() string {
if len(t.Rows) == 0 {
return ""
}
// remove nil cells and rows
t.purgeRow()
colWidths := t.colWidths()
var lines []string
for _, row := range t.Rows {
row.Separator = t.Separator()
for i, cell := range row.Cells {
cell.Width = colWidths[i]
cell.Wrap = t.Wrap
}
lines = append(lines, row.String())
}
return text.Join(lines, "\n")
}
// LineWidth returns the max width of all the lines in a cell
func (c *TableCell) LineWidth() int {
width := 0
for _, s := range strings.Split(c.String(), "\n") {
w := text.StringWidth(s)
if w > width {
width = w
}
}
return width
}
// String returns the string formatted representation of the cell
func (c *TableCell) String() string {
if c == nil {
return ""
}
if c.Value == nil {
return text.PadLeft(" ", c.Width, ' ')
}
// convert value to string
s := fmt.Sprintf("%v", c.Value)
// wrap or truncate the string if needed
if c.Width > 0 && c.isaTTY {
if c.Wrap && len(s) > c.Width {
return text.WrapString(s, c.Width)
} else {
return text.Truncate(s, c.Width)
}
}
return s
}
// colWidths determine the width for each column (cell in a row)
func (t *TablePrinter) colWidths() []int {
var colWidths []int
for _, row := range t.Rows {
for i, cell := range row.Cells {
// resize colwidth array
if i+1 > len(colWidths) {
colWidths = append(colWidths, 0)
}
cellwidth := cell.LineWidth()
if t.MaxColWidth != 0 && cellwidth > t.MaxColWidth {
cellwidth = t.MaxColWidth
}
if cellwidth > colWidths[i] {
colWidths[i] = cellwidth
}
}
}
numCols := len(colWidths)
separatorWidth := (numCols - 1) * len(t.Separator())
totalWidth := separatorWidth
for _, width := range colWidths {
totalWidth += width
}
if t.MaxColWidth == 0 && totalWidth > t.TerminalWidth {
availWidth := t.TerminalWidth - colWidths[0] - separatorWidth
// add extra space from columns that are already narrower than threshold
for col := 1; col < numCols; col++ {
availColWidth := availWidth / (numCols - 1)
if extra := availColWidth - colWidths[col]; extra > 0 {
availWidth += extra
}
}
// cap all but first column to fit available terminal width
for col := 1; col < numCols; col++ {
availColWidth := availWidth / (numCols - 1)
if colWidths[col] > availColWidth {
colWidths[col] = availColWidth
}
}
}
return colWidths
}
|