containerd/progress/writer.go
Phil Estes b1527e0a10
Handle progress line length properly for formatting
Two issues with a prior PR for handling line-spanning progress bars are
fixed in this PR:
 - corner case where output line len == term width: extra line was being
 added
 - line length calculation was including escape characters causing
 calculations to span lines when output was still only on one line

Signed-off-by: Phil Estes <estesp@linux.vnet.ibm.com>
2017-11-09 15:58:51 -05:00

83 lines
1.6 KiB
Go

package progress
import (
"bytes"
"fmt"
"io"
"regexp"
"strings"
"github.com/containerd/console"
)
var (
regexCleanLine = regexp.MustCompile("\x1b\\[[0-9]+m[\x1b]?")
)
// Writer buffers writes until flush, at which time the last screen is cleared
// and the current buffer contents are written. This is useful for
// implementing progress displays, such as those implemented in docker and
// git.
type Writer struct {
buf bytes.Buffer
w io.Writer
lines int
}
// NewWriter returns a writer
func NewWriter(w io.Writer) *Writer {
return &Writer{
w: w,
}
}
// Write the provided bytes
func (w *Writer) Write(p []byte) (n int, err error) {
return w.buf.Write(p)
}
// Flush should be called when refreshing the current display.
func (w *Writer) Flush() error {
if w.buf.Len() == 0 {
return nil
}
if err := w.clear(); err != nil {
return err
}
ws, err := console.Current().Size()
if err != nil {
return fmt.Errorf("failed to get terminal width: %v", err)
}
strlines := strings.Split(w.buf.String(), "\n")
w.lines = -1
for _, line := range strlines {
w.lines += (len(stripLine(line))-1)/int(ws.Width) + 1
}
if _, err := w.w.Write(w.buf.Bytes()); err != nil {
return err
}
w.buf.Reset()
return nil
}
// TODO(stevvooe): The following are system specific. Break these out if we
// decide to build this package further.
func (w *Writer) clear() error {
for i := 0; i < w.lines; i++ {
if _, err := fmt.Fprintf(w.w, "\x1b[1A\x1b[2K\r"); err != nil {
return err
}
}
return nil
}
func stripLine(line string) string {
return string(regexCleanLine.ReplaceAll([]byte(line), []byte{}))
}