summaryrefslogtreecommitdiff
path: root/vendor/github.com/vbauerster/mpb/cwriter/writer.go
blob: 638237c181da699824a1a7d04d6615f8f2c82ede (plain)
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
package cwriter

import (
	"bytes"
	"errors"
	"fmt"
	"io"
	"os"

	isatty "github.com/mattn/go-isatty"
	"golang.org/x/crypto/ssh/terminal"
)

// ESC is the ASCII code for escape character
const ESC = 27

var NotATTY = errors.New("not a terminal")

var (
	cursorUp           = fmt.Sprintf("%c[%dA", ESC, 1)
	clearLine          = fmt.Sprintf("%c[2K\r", ESC)
	clearCursorAndLine = cursorUp + clearLine
)

// Writer is a buffered the writer that updates the terminal.  The
// contents of writer will be flushed when Flush is called.
type Writer struct {
	out        io.Writer
	buf        bytes.Buffer
	isTerminal bool
	fd         int
	lineCount  int
}

// New returns a new Writer with defaults
func New(out io.Writer) *Writer {
	w := &Writer{out: out}
	if f, ok := out.(*os.File); ok {
		fd := f.Fd()
		w.isTerminal = isatty.IsTerminal(fd)
		w.fd = int(fd)
	}
	return w
}

// Flush flushes the underlying buffer
func (w *Writer) Flush(lineCount int) error {
	err := w.clearLines()
	w.lineCount = lineCount
	// WriteTo takes care of w.buf.Reset
	if _, e := w.buf.WriteTo(w.out); err == nil {
		err = e
	}
	return err
}

// Write appends the contents of p to the underlying buffer
func (w *Writer) Write(p []byte) (n int, err error) {
	return w.buf.Write(p)
}

// WriteString writes string to the underlying buffer
func (w *Writer) WriteString(s string) (n int, err error) {
	return w.buf.WriteString(s)
}

// ReadFrom reads from the provided io.Reader and writes to the
// underlying buffer.
func (w *Writer) ReadFrom(r io.Reader) (n int64, err error) {
	return w.buf.ReadFrom(r)
}

// GetWidth returns width of underlying terminal.
func (w *Writer) GetWidth() (int, error) {
	if w.isTerminal {
		tw, _, err := terminal.GetSize(w.fd)
		return tw, err
	}
	return -1, NotATTY
}