termdash/terminal/termbox/termbox.go

// Package termbox implements terminal using the nsf/termbox-go library.
package termbox

import (
	"context"
	"image"

	"github.com/mum4k/termdash/cell"
	"github.com/mum4k/termdash/terminalapi"
	termbox "github.com/nsf/termbox-go"
)

// Option is used to provide options.
type Option interface {
	// set sets the provided option.
	set(*Terminal)
}

// option implements Option.
type option func(*Terminal)

// set implements Option.set.
func (o option) set(t *Terminal) {
	o(t)
}

// ColorMode sets the terminal color mode.
func ColorMode(cm terminalapi.ColorMode) Option {
	return option(func(t *Terminal) {
		t.colorMode = cm
	})
}

// Terminal provides input and output to a real terminal.
// Wraps the nsf/termbox-go terminal implementation.
// This isn't thread-safe, because termbox isn't and only one instance is ever
// supported, because termbox uses global state.
// Implements terminalapi.Terminal.
type Terminal struct {
	colorMode terminalapi.ColorMode
}

// New returns a new termbox based Terminal.
// Call Close() when the terminal isn't required anymore.
func New(opts ...Option) (*Terminal, error) {
	if err := termbox.Init(); err != nil {
		return nil, err
	}

	t := &Terminal{}
	for _, opt := range opts {
		opt.set(t)
	}

	om, err := colorMode(t.colorMode)
	if err != nil {
		return nil, err
	}
	termbox.SetOutputMode(om)
	return t, nil
}

// Implements terminalapi.Terminal.Size.
func (t *Terminal) Size() image.Point {
	w, h := termbox.Size()
	return image.Point{w, h}
}

// Implements terminalapi.Terminal.Clear.
func (t *Terminal) Clear(opts ...cell.Option) error {
	o := cell.NewOptions(opts...)
	fg, err := cellOptsToFg(o)
	if err != nil {
		return err
	}

	bg, err := cellOptsToBg(o)
	if err != nil {
		return err
	}
	return termbox.Clear(fg, bg)
}

// Implements terminalapi.Terminal.Flush.
func (t *Terminal) Flush() error {
	return termbox.Flush()
}

// Implements terminalapi.Terminal.SetCursor.
func (t *Terminal) SetCursor(p image.Point) {
	termbox.SetCursor(p.X, p.Y)
}

// Implements terminalapi.Terminal.HideCursor.
func (t *Terminal) HideCursor() {
	termbox.HideCursor()
}

// Implements terminalapi.Terminal.SetCell.
func (t *Terminal) SetCell(p image.Point, r rune, opts ...cell.Option) error {
	o := cell.NewOptions(opts...)
	fg, err := cellOptsToFg(o)
	if err != nil {
		return err
	}

	bg, err := cellOptsToBg(o)
	if err != nil {
		return err
	}
	termbox.SetCell(p.X, p.Y, r, fg, bg)
	return nil
}

// Implements terminalapi.Terminal.Event.
func (t *Terminal) Event(ctx context.Context) terminalapi.Event {
	return nil
}

// Closes the terminal, should be called when the terminal isn't required
// anymore to return the screen to a sane state.
func (t *Terminal) Close() {
	termbox.Close()
}