- Touch-up GoDoc to better document each method, adding punctuation, and
use doc-links where applicable.
- SetRawTerminal(): change the order in which we check if a terminal is
connected; check the local boolean first before checking if the NORAW
env-var is set.
- NewOut() / NewIn(); remove intermediate variables
- Remove explicit use of the embedded "commonStream" to make the code
slightly less verbose, and more "to the point".
- Document the intended purpose of SetIsTerminal(), which was added in
b2551c619d
to be used in unit-tests.
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
36 lines
815 B
Go
36 lines
815 B
Go
package streams
|
|
|
|
import (
|
|
"github.com/moby/term"
|
|
)
|
|
|
|
type commonStream struct {
|
|
fd uintptr
|
|
isTerminal bool
|
|
state *term.State
|
|
}
|
|
|
|
// FD returns the file descriptor number for this stream.
|
|
func (s *commonStream) FD() uintptr {
|
|
return s.fd
|
|
}
|
|
|
|
// IsTerminal returns true if this stream is connected to a terminal.
|
|
func (s *commonStream) IsTerminal() bool {
|
|
return s.isTerminal
|
|
}
|
|
|
|
// RestoreTerminal restores normal mode to the terminal.
|
|
func (s *commonStream) RestoreTerminal() {
|
|
if s.state != nil {
|
|
_ = term.RestoreTerminal(s.fd, s.state)
|
|
}
|
|
}
|
|
|
|
// SetIsTerminal overrides whether a terminal is connected. It is used to
|
|
// override this property in unit-tests, and should not be depended on for
|
|
// other purposes.
|
|
func (s *commonStream) SetIsTerminal(isTerminal bool) {
|
|
s.isTerminal = isTerminal
|
|
}
|