term

README

term package

term.go and its sub-sequences (term_unix...) are copied from golang.org/x/term, and:

• disable err returned by readPassword when unsupported (and plan9, maybe nacl)

Documentation

Overview

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.

Index

• func DisableColors() bool
• func GetFdSize(fd uintptr) (cols, rows int, err error)
• func GetSize(fd int) (width, height int, err error)
• func GetState(fd int) (*term.State, error)
• func GetTtySize() (cols, rows int)
• func GetTtySizeByFd(fd uintptr) (cols, rows int, err error)
• func GetTtySizeByFile(outf *os.File) (cols, rows int, err error)
• func GetTtySizeByName(fn string) (cols, rows int, err error)
• func IsAnsiEscaped(s string) bool
• func IsCharDevice(f *os.File) bool
• func IsColored(w io.Writer) bool
• func IsColorful(w io.Writer) (colorful bool)
• func IsCygwinTerminal(fd uintptr) bool
• func IsENOTTY(err error) bool
• func IsRoot() bool
• func IsStartupByDoubleClick() bool
• func IsTerminal(fd int) bool
• func IsTty(w io.Writer) bool
• func MakeNewTerm(ctx context.Context, config *PromptModeConfig) (deferFunc func(), err error)
• func MakeRaw(fd int) (*term.State, error)
• func MakeRawWrapped() (deferFunc func(), err error)
• func ReadPassword(fd int) ([]byte, error)
• func ReadTill(fd int, delim byte) (string, bool, error)
• func Restore(fd int, oldState *term.State) error
• func SetDisableColors(b bool)
• func StatStdout() (normalFile, redirected, piped, term bool)
• func StatStdoutString() (status string)
• func StdoutIsPiped() (b bool)
• func StringToBool(val string, defaultVal ...bool) (ret bool)
• func StripEscapes(str string) (strCleaned string)
• func ToBool(val any, defaultVal ...bool) (ret bool)
• type LooperFunc
• type PromptModeConfig
• type SmallTerm

Functions

func DisableColors

func DisableColors() bool

DisableColors return a state which identify wherher needs disable colorful console output always.

func GetFdSize

func GetFdSize(fd uintptr) (cols, rows int, err error)

func GetSize

func GetSize(fd int) (width, height int, err error)

GetSize returns the visible dimensions of the given terminal.

These dimensions don't include any scrollback buffer height.

func GetState

func GetState(fd int) (*term.State, error)

GetState returns the current state of a terminal which may be useful to restore the terminal after a signal.

func GetTtySize

func GetTtySize() (cols, rows int)

GetTtySize returns the window size in columns and rows in the active console window. The return value of this function is in the order of cols, rows.

func GetTtySizeByFd

func GetTtySizeByFd(fd uintptr) (cols, rows int, err error)

func GetTtySizeByFile

func GetTtySizeByFile(outf *os.File) (cols, rows int, err error)

func GetTtySizeByName

func GetTtySizeByName(fn string) (cols, rows int, err error)

func IsAnsiEscaped

func IsAnsiEscaped(s string) bool

IsAnsiEscaped detects a string if it contains ansi color escaped sequences

func IsCharDevice

func IsCharDevice(f *os.File) bool

IsCharDevice detect a file if it's a character device, for unix. Specially used for test if terminal under darwin, since new macOS has a different os.Stdout.

func IsColored

func IsColored(w io.Writer) bool

IsColored detects a writer if it is a colorful tty device.

A colorful tty device can receive ANSI escaped sequences and draw its.

func IsColorful

func IsColorful(w io.Writer) (colorful bool)

IsColorful detects a writer if it is a colorful tty device.

A colorful tty device can receive ANSI escaped sequences and draw its.

func IsCygwinTerminal

func IsCygwinTerminal(fd uintptr) bool

IsCygwinTerminal return true if the file descriptor is a cygwin or msys2 terminal. This is also always false on this environment.

func IsENOTTY

func IsENOTTY(err error) bool

func IsRoot

func IsRoot() bool

func IsStartupByDoubleClick

func IsStartupByDoubleClick() bool

IsStartupByDoubleClick detects if windows golang executable file is running via double click or from cmd/shell terminator

func IsTerminal

func IsTerminal(fd int) bool

IsTerminal returns whether the given file descriptor is a terminal.

func IsTty

func IsTty(w io.Writer) bool

IsTty detects a writer if it is abstracting from a tty (console, terminal) device.

func MakeNewTerm

func MakeNewTerm(ctx context.Context, config *PromptModeConfig) (deferFunc func(), err error)

func MakeRaw

func MakeRaw(fd int) (*term.State, error)

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 MakeRawWrapped

func MakeRawWrapped() (deferFunc func(), err error)

func ReadPassword

func ReadPassword(fd int) ([]byte, error)

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 ReadTill

func ReadTill(fd int, delim byte) (string, bool, error)

ReadTill reads a line or a string ending with delim of input from a terminal without local echo.

func Restore

func Restore(fd int, oldState *term.State) error

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

func SetDisableColors

func SetDisableColors(b bool)

func StatStdout

func StatStdout() (normalFile, redirected, piped, term bool)

func StatStdoutString

func StatStdoutString() (status string)

func StdoutIsPiped

func StdoutIsPiped() (b bool)

func StringToBool

func StringToBool(val string, defaultVal ...bool) (ret bool)

func StripEscapes

func StripEscapes(str string) (strCleaned string)

StripEscapes removes any ansi color escaped sequences from a string

func ToBool

func ToBool(val any, defaultVal ...bool) (ret bool)

ToBool translate a value (int, bool, string) to boolean

Types

type LooperFunc

type LooperFunc func(ctx context.Context, tty SmallTerm, replyPrefix string, exitChan <-chan struct{}, closer func()) (err error)

type PromptModeConfig

type PromptModeConfig struct {
	Name              string // used for binding history records
	WelcomeText       string
	PromptText        string
	ReplyText         string
	MainLooperHandler LooperFunc
	PostInitTerminal  func(t *term.Terminal)
	MaxHistoryEntries int
}

type SmallTerm

type SmallTerm interface {
	io.Writer
	ReadLine() (string, error)
}