You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
61 lines
1.8 KiB
Go
61 lines
1.8 KiB
Go
1 year ago
|
// Copyright 2019 The Go Authors. All rights reserved.
|
||
|
|
// Use of this source code is governed by a BSD-style
|
||
|
|
// license that can be found in the LICENSE file.
|
||
|
|
|
||
|
|
// Package term provides support functions for dealing with terminals, as
|
||
|
|
// commonly found on UNIX systems.
|
||
|
|
//
|
||
|
|
// Putting a terminal into raw mode is the most common requirement:
|
||
|
|
//
|
||
|
|
// oldState, err := term.MakeRaw(int(os.Stdin.Fd()))
|
||
|
|
// if err != nil {
|
||
|
|
// panic(err)
|
||
|
|
// }
|
||
|
|
// defer term.Restore(int(os.Stdin.Fd()), oldState)
|
||
|
|
//
|
||
|
|
// Note that on non-Unix systems os.Stdin.Fd() may not be 0.
|
||
|
|
package term
|
||
|
|
|
||
|
|
// State contains the state of a terminal.
|
||
|
|
type State struct {
|
||
|
|
state
|
||
|
|
}
|
||
|
|
|
||
|
|
// IsTerminal returns whether the given file descriptor is a terminal.
|
||
|
|
func IsTerminal(fd int) bool {
|
||
|
|
return isTerminal(fd)
|
||
|
|
}
|
||
|
|
|
||
|
|
// MakeRaw puts the terminal connected to the given file descriptor into raw
|
||
|
|
// mode and returns the previous state of the terminal so that it can be
|
||
|
|
// restored.
|
||
|
|
func MakeRaw(fd int) (*State, error) {
|
||
|
|
return makeRaw(fd)
|
||
|
|
}
|
||
|
|
|
||
|
|
// GetState returns the current state of a terminal which may be useful to
|
||
|
|
// restore the terminal after a signal.
|
||
|
|
func GetState(fd int) (*State, error) {
|
||
|
|
return getState(fd)
|
||
|
|
}
|
||
|
|
|
||
|
|
// Restore restores the terminal connected to the given file descriptor to a
|
||
|
|
// previous state.
|
||
|
|
func Restore(fd int, oldState *State) error {
|
||
|
|
return restore(fd, oldState)
|
||
|
|
}
|
||
|
|
|
||
|
|
// GetSize returns the visible dimensions of the given terminal.
|
||
|
|
//
|
||
|
|
// These dimensions don't include any scrollback buffer height.
|
||
|
|
func GetSize(fd int) (width, height int, err error) {
|
||
|
|
return getSize(fd)
|
||
|
|
}
|
||
|
|
|
||
|
|
// ReadPassword reads a line of input from a terminal without local echo. This
|
||
|
|
// is commonly used for inputting passwords and other sensitive data. The slice
|
||
|
|
// returned does not include the \n.
|
||
|
|
func ReadPassword(fd int) ([]byte, error) {
|
||
|
|
return readPassword(fd)
|
||
|
|
}
|