package term

import "github.com/ory/dockertest/v3/docker/pkg/term"

Package term provides structures and helper functions to work with terminal (state, sizes).

Index ¶

• Variables
• func DisableEcho(fd uintptr, state *State) error
• func GetFdInfo(in interface{}) (uintptr, bool)
• func IsTerminal(fd uintptr) bool
• func NewEscapeProxy(r io.Reader, escapeKeys []byte) io.Reader
• func RestoreTerminal(fd uintptr, state *State) error
• func SetWinsize(fd uintptr, ws *Winsize) error
• func StdStreams() (stdIn io.ReadCloser, stdOut, stdErr io.Writer)
• func ToBytes(keys string) ([]byte, error)
• type EscapeError
• func (EscapeError) Error() string
• type State
• func SaveState(fd uintptr) (*State, error)
• func SetRawTerminal(fd uintptr) (*State, error)
• func SetRawTerminalOutput(fd uintptr) (*State, error)
• type Winsize
• func GetWinsize(fd uintptr) (*Winsize, error)

Variables ¶

var ASCII = []string{
	"ctrl-@",
	"ctrl-a",
	"ctrl-b",
	"ctrl-c",
	"ctrl-d",
	"ctrl-e",
	"ctrl-f",
	"ctrl-g",
	"ctrl-h",
	"ctrl-i",
	"ctrl-j",
	"ctrl-k",
	"ctrl-l",
	"ctrl-m",
	"ctrl-n",
	"ctrl-o",
	"ctrl-p",
	"ctrl-q",
	"ctrl-r",
	"ctrl-s",
	"ctrl-t",
	"ctrl-u",
	"ctrl-v",
	"ctrl-w",
	"ctrl-x",
	"ctrl-y",
	"ctrl-z",
	"ctrl-[",
	"ctrl-\\",
	"ctrl-]",
	"ctrl-^",
	"ctrl-_",
}

ASCII list the possible supported ASCII key sequence

var (
	// ErrInvalidState is returned if the state of the terminal is invalid.
	ErrInvalidState = errors.New("Invalid terminal state")
)

Functions ¶

func DisableEcho ¶

func DisableEcho(fd uintptr, state *State) error

DisableEcho applies the specified state to the terminal connected to the file descriptor, with echo disabled.

func GetFdInfo ¶

func GetFdInfo(in interface{}) (uintptr, bool)

GetFdInfo returns the file descriptor for an os.File and indicates whether the file represents a terminal.

func IsTerminal ¶

func IsTerminal(fd uintptr) bool

IsTerminal returns true if the given file descriptor is a terminal.

func NewEscapeProxy ¶

func NewEscapeProxy(r io.Reader, escapeKeys []byte) io.Reader

NewEscapeProxy returns a new TTY proxy reader which wraps the given reader and detects when the specified escape keys are read, in which case the Read method will return an error of type EscapeError.

func RestoreTerminal ¶

func RestoreTerminal(fd uintptr, state *State) error

RestoreTerminal restores the terminal connected to the given file descriptor to a previous state.

func SetWinsize ¶

func SetWinsize(fd uintptr, ws *Winsize) error

SetWinsize tries to set the specified window size for the specified file descriptor.

func StdStreams ¶

func StdStreams() (stdIn io.ReadCloser, stdOut, stdErr io.Writer)

StdStreams returns the standard streams (stdin, stdout, stderr).

func ToBytes ¶

func ToBytes(keys string) ([]byte, error)

ToBytes converts a string representing a suite of key-sequence to the corresponding ASCII code.

Types ¶

type EscapeError ¶

type EscapeError struct{}

EscapeError is special error which returned by a TTY proxy reader's Read() method in case its detach escape sequence is read.

func (EscapeError) Error ¶

func (EscapeError) Error() string

type State ¶

type State struct {
	// contains filtered or unexported fields
}

State represents the state of the terminal.

func SaveState ¶

func SaveState(fd uintptr) (*State, error)

SaveState saves the state of the terminal connected to the given file descriptor.

func SetRawTerminal ¶

func SetRawTerminal(fd uintptr) (*State, error)

SetRawTerminal puts the terminal connected to the given file descriptor into raw mode and returns the previous state. On UNIX, this puts both the input and output into raw mode. On Windows, it only puts the input into raw mode.

func SetRawTerminalOutput ¶

func SetRawTerminalOutput(fd uintptr) (*State, error)

SetRawTerminalOutput puts the output of terminal connected to the given file descriptor into raw mode. On UNIX, this does nothing and returns nil for the state. On Windows, it disables LF -> CRLF translation.

type Winsize ¶

type Winsize struct {
	Height uint16
	Width  uint16
	// contains filtered or unexported fields
}

Winsize represents the size of the terminal window.

func GetWinsize ¶

func GetWinsize(fd uintptr) (*Winsize, error)

GetWinsize returns the window size based on the specified file descriptor.

Source Files ¶

ascii.go proxy.go tc.go term.go winsize.go

Directories ¶