ASCII list the possible supported ASCII key sequence
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-_", }
ErrInvalidState is returned if the state of the terminal is invalid.
Deprecated: ErrInvalidState is no longer used.
var ErrInvalidState = errors.New("Invalid terminal state")
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(in interface{}) (fd uintptr, isTerminal bool)
GetFdInfo returns the file descriptor for an os.File and indicates whether the file represents a terminal.
func IsTerminal(fd uintptr) bool
IsTerminal returns true if the given file descriptor is a terminal.
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(fd uintptr, state *State) error
RestoreTerminal restores the terminal connected to the given file descriptor to a previous state.
func SetWinsize(fd uintptr, ws *Winsize) error
SetWinsize tries to set the specified window size for the specified file descriptor. It is only implemented on Unix, and returns an error on Windows.
func StdStreams() (stdIn io.ReadCloser, stdOut, stdErr io.Writer)
StdStreams returns the standard streams (stdin, stdout, stderr).
On Windows, it attempts to turn on VT handling on all std handles if supported, or falls back to terminal emulation. On Unix, this returns the standard os.Stdin, os.Stdout and os.Stderr.
func ToBytes(keys string) ([]byte, error)
ToBytes converts a string representing a suite of key-sequence to the corresponding ASCII code.
EscapeError is special error which returned by a TTY proxy reader's Read() method in case its detach escape sequence is read.
type EscapeError struct{}
func (EscapeError) Error() string
State holds the platform-specific state / console mode for the terminal.
type State terminalState
func MakeRaw(fd uintptr) (previousState *State, err error)
MakeRaw puts the terminal (Windows Console) connected to the given file descriptor into raw mode and returns the previous state of the terminal so that it can be restored.
func SaveState(fd uintptr) (*State, error)
SaveState saves the state of the terminal connected to the given file descriptor.
func SetRawTerminal(fd uintptr) (previousState *State, err error)
SetRawTerminal puts the terminal connected to the given file descriptor into raw mode and returns the previous state. On UNIX, this is the equivalent of MakeRaw, and puts both the input and output into raw mode. On Windows, it only puts the input into raw mode.
func SetRawTerminalOutput(fd uintptr) (previousState *State, err 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.
Termios is the Unix API for terminal I/O.
Deprecated: use unix.Termios.
type Termios = unix.Termios
Winsize represents the size of the terminal window.
type Winsize struct {
Height uint16
Width uint16
// contains filtered or unexported fields
}
func GetWinsize(fd uintptr) (*Winsize, error)
GetWinsize returns the window size based on the specified file descriptor.