term

Documentation

Index

• Variables
• func DeviceMajor[T constraints.Integer](rdev T) uint64
• func DeviceMinor[T constraints.Integer](rdev T) uint64
• func ParseDims(b []byte) (uint32, uint32)
• func ParseKeyValue(b []byte) (key, value string)
• func ParseValue(b []byte) (value string)
• func SetWinSz(fd uintptr, w, h uint32) (err error)
• type TermType
  • func CharDeviceInfo(path string) (major, minor uint64, ttyType TermType, yes bool)
  • func ParseDeviceInfo[T constraints.Integer](dev T) (major, minor uint64, ttyType TermType)
  • func ResolveTTY() (ttyPath string, ttyType TermType, err error)
  • func (tt TermType) String() (name string)
  • func (tt TermType) Valid() (valid bool)

Variables

var (
	ErrUnsupportedOS = errors.New("unsupported operating system")
)

Functions

func DeviceMajor

func DeviceMajor[T constraints.Integer](rdev T) uint64

func DeviceMinor

func DeviceMinor[T constraints.Integer](rdev T) uint64

func ParseDims

func ParseDims(b []byte) (uint32, uint32)

ParseDims extracts terminal dimensions (width x height) from the provided buffer.

func ParseKeyValue

func ParseKeyValue(b []byte) (key, value string)

func ParseValue

func ParseValue(b []byte) (value string)

func SetWinSz

func SetWinSz(fd uintptr, w, h uint32) (err error)

SetWinSz sets the width and height for the given tty fd

Types

type TermType

type TermType uint8

const (
	InvalidTermType TermType = iota
	NotATTY
	ConsoleTTY
	PseudoTTY
)

func CharDeviceInfo

func CharDeviceInfo(path string) (major, minor uint64, ttyType TermType, yes bool)

CharDeviceInfo uses syscall.Stat to test if the path exists, is a character device (mode has S_IFCHR), parses the major and minor numbers out of syscall.Stat_t.Rdev and finally determines the TermType value based on the major and minor values

func ParseDeviceInfo

func ParseDeviceInfo[T constraints.Integer](dev T) (major, minor uint64, ttyType TermType)

func ResolveTTY

func ResolveTTY() (ttyPath string, ttyType TermType, err error)

func (TermType) String

func (tt TermType) String() (name string)

func (TermType) Valid

func (tt TermType) Valid() (valid bool)