termy

README

Termy 📺

(pronounced tˈɜːmi)

PKG Termy facilitates access to basic (terminal emulator's) functionality.

---

termy.go allows you to put your terminal in non-cooked modes.

package main

import "github.com/mec-nyan/termy"


func main() {

	t := termy.New(int(os.Stdin.Fd()), false)
	err := t.Cbreaky()
	if err != nil {
		...
	}
	defer t.Restore()

	// Your code...

}

escapy.go provides function to send in-band control sequences to your terminal.

func main() {

	// ...

	termy.SaveCurPos() // Save current cursor position.


	// Do stuff.

	termy.RestoreCurPos() // Go back to saved position.
	termy.ClearToEOS()    // Clean up.

	// ...
}

TODO: I'll soon add capabilities for styles, colours, etc.

Documentation

Overview

escapy.go These are standalone versions of the cursor manipulation functions. They write directly to os.Stdout.

Index

• func ClearScreen()
• func ClearToBOL()
• func ClearToEOL()
• func ClearToEOS()
• func CurToCol(col int)
• func CurToRow(row int)
• func Down()
• func EnterCaMode()
• func ExitCaMode()
• func HideCur()
• func Home()
• func Left()
• func MoveDown(lines int)
• func MoveLeft(lines int)
• func MoveRight(lines int)
• func MoveTo(row, col int)
• func MoveUp(lines int)
• func RestoreCurPos()
• func Right()
• func SaveCurPos()
• func ShowCur()
• func Up()
• type TermSettings
  • func New(fd int, echo bool) *TermSettings
  • func (ts *TermSettings) Cbreaky() error
  • func (ts *TermSettings) Restore() error
  • func (ts *TermSettings) Size() (rows, cols int, err error)
• type Termy
  • func NewTermy(w io.Writer) *Termy
  • func (t *Termy) ClearScreen()
  • func (t *Termy) ClearToBOL()
  • func (t *Termy) ClearToEOL()
  • func (t *Termy) ClearToEOS()
  • func (t *Termy) Code() string
  • func (t *Termy) CurToCol(col int)
  • func (t *Termy) CurToRow(row int)
  • func (t *Termy) Down()
  • func (t *Termy) EnterCaMode()
  • func (t *Termy) Escaped() string
  • func (t *Termy) ExitCaMode()
  • func (t *Termy) HideCur()
  • func (t *Termy) Home()
  • func (t *Termy) Left()
  • func (t *Termy) MoveDown(lines int)
  • func (t *Termy) MoveLeft(cols int)
  • func (t *Termy) MoveRight(cols int)
  • func (t *Termy) MoveTo(x, y int)
  • func (t *Termy) MoveUp(lines int)
  • func (t *Termy) RestoreCurPos()
  • func (t *Termy) Right()
  • func (t *Termy) SaveCurPos()
  • func (t *Termy) Send()
  • func (t *Termy) ShowCur()
  • func (t *Termy) Up()

Functions

func ClearScreen

func ClearScreen()

func ClearToBOL

func ClearToBOL()

func ClearToEOL

func ClearToEOL()

func ClearToEOS

func ClearToEOS()

func CurToCol

func CurToCol(col int)

func CurToRow

func CurToRow(row int)

func Down

func Down()

func EnterCaMode

func EnterCaMode()

func ExitCaMode

func ExitCaMode()

func HideCur

func HideCur()

func Home

func Home()

func Left

func Left()

func MoveDown

func MoveDown(lines int)

func MoveLeft

func MoveLeft(lines int)

func MoveRight

func MoveRight(lines int)

func MoveTo

func MoveTo(row, col int)

func MoveUp

func MoveUp(lines int)

func RestoreCurPos

func RestoreCurPos()

func Right

func Right()

func SaveCurPos

func SaveCurPos()

func ShowCur

func ShowCur()

func Up

func Up()

Types

type TermSettings

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

func New

func New(fd int, echo bool) *TermSettings

New creates an instance of TermSettings to handle the terminal state. fd: file descriptor (as in os.Stdout.Fd()), echo: Set to false to disable automatic echoing of user input.

func (*TermSettings) Cbreaky

func (ts *TermSettings) Cbreaky() error

Cbreaky set the terminal (actually, STDIN) in a cbreak-like mode. Accepts an optional bool to disable echo as well. On success it saves the original state so you can retore it later. Example usage:

term := termy.New(int(os.Stdin.Fd()), false) err := term.Cbreaky() if err != nil ... defer term.Restore()

func (*TermSettings) Restore

func (ts *TermSettings) Restore() error

Restore sets the terminal to its previous state. It returns an error if the previous state was not saved. Tipically you will call Restore after Cbreaky (probably with `defer`)

func (*TermSettings) Size

func (ts *TermSettings) Size() (rows, cols int, err error)

TODO: Should size be part of "Termy"? TODO: How should we handle "resize"?

type Termy

type Termy struct {
	colours.Colour
	styles.Style
	// contains filtered or unexported fields
}

Termy struct handles in-band colour and style commands for its tty. tty would normally be os.Stdout.

func NewTermy

func NewTermy(w io.Writer) *Termy

NewTermy sets up a new Termy struct to handle in-band signalling to the selected io.Writer.

func (*Termy) ClearScreen

func (t *Termy) ClearScreen()

Clear the screen and move the cursor to the upper left corner.

func (*Termy) ClearToBOL

func (t *Termy) ClearToBOL()

Clear to the beginning of line.

func (*Termy) ClearToEOL

func (t *Termy) ClearToEOL()

Clear to end of line.

func (*Termy) ClearToEOS

func (t *Termy) ClearToEOS()

Clear to end of screen.

func (*Termy) Code

func (t *Termy) Code() string

Code generates the code for the currently selected colours and/or style. It doesn't prepend the CSI.

func (*Termy) CurToCol

func (t *Termy) CurToCol(col int)

Move cursor to column "col".

func (*Termy) CurToRow

func (t *Termy) CurToRow(row int)

Move cursor to row "row".

func (*Termy) Down

func (t *Termy) Down()

Move cursor down one row.

func (*Termy) EnterCaMode

func (t *Termy) EnterCaMode()

Enter alt buffer mode.

func (*Termy) Escaped

func (t *Termy) Escaped() string

Escaped converts the colour and style sequence in an in-band command. prepending the CSI and appending a terminator string.

func (*Termy) ExitCaMode

func (t *Termy) ExitCaMode()

Exit alt buffer mode.

func (*Termy) HideCur

func (t *Termy) HideCur()

Make cursor invisible.

func (*Termy) Home

func (t *Termy) Home()

Cursor manipulation:

Home moves the cursor to the top left corner of the terminal.

func (*Termy) Left

func (t *Termy) Left()

Move cursor one column to the left.

func (*Termy) MoveDown

func (t *Termy) MoveDown(lines int)

Move cursor "lines" rows down.

func (*Termy) MoveLeft

func (t *Termy) MoveLeft(cols int)

Move cursor "cols" columns to the left.

func (*Termy) MoveRight

func (t *Termy) MoveRight(cols int)

Move cursor "cols" columns to the right.

func (*Termy) MoveTo

func (t *Termy) MoveTo(x, y int)

Move cursor to line "y" col "x"

func (*Termy) MoveUp

func (t *Termy) MoveUp(lines int)

Move cursor "lines" rows up.

func (*Termy) RestoreCurPos

func (t *Termy) RestoreCurPos()

Restore the cursor position to a previously saved one.

func (*Termy) Right

func (t *Termy) Right()

Move cursor one column to the right.

func (*Termy) SaveCurPos

func (t *Termy) SaveCurPos()

Save the current cursor position.

func (*Termy) Send

func (t *Termy) Send()

Send actually sends the in-band signal to the terminal/selected writer.

func (*Termy) ShowCur

func (t *Termy) ShowCur()

Make cursor visible.

func (*Termy) Up

func (t *Termy) Up()

Move cursor up one row.