bubbletea/tea.go

package tea

import (
	"io"
	"os"
	"strings"
	"sync"

	"github.com/muesli/termenv"
)

// Msg represents an action and is usually the result of an IO operation. It's
// triggers the  Update function, and henceforth, the UI.
type Msg interface{}

// Model contains the program's state.
type Model interface{}

// Cmd is an IO operation. If it's nil it's considered a no-op.
type Cmd func() Msg

// Batch peforms a bunch of commands concurrently with no ordering guarantees
// about the results.
func Batch(cmds ...Cmd) Cmd {
	if len(cmds) == 0 {
		return nil
	}
	return func() Msg {
		return batchMsg(cmds)
	}
}

// Init is the first function that will be called. It returns your initial
// model and runs an optional command.
type Init func() (Model, Cmd)

// Update is called when a message is received. It may update the model and/or
// send a command.
type Update func(Msg, Model) (Model, Cmd)

// View produces a string which will be rendered to the terminal.
type View func(Model) string

// Program is a terminal user interface.
type Program struct {
	init   Init
	update Update
	view   View

	mutex         sync.Mutex
	currentRender string
}

// Quit is a command that tells the program to exit.
func Quit() Msg {
	return quitMsg{}
}

// Signals that the program should quit.
type quitMsg struct{}

// batchMsg is used to perform a bunch of commands.
type batchMsg []Cmd

// NewProgram creates a new Program.
func NewProgram(init Init, update Update, view View) *Program {
	return &Program{
		init:   init,
		update: update,
		view:   view,

		mutex: sync.Mutex{},
	}
}

// Start initializes the program.
func (p *Program) Start() error {
	var (
		model Model
		cmd   Cmd
		cmds  = make(chan Cmd)
		msgs  = make(chan Msg)
		errs  = make(chan error)
		done  = make(chan struct{})
	)

	err := initTerminal()
	if err != nil {
		return err
	}
	defer restoreTerminal()

	// Initialize program
	model, cmd = p.init()
	if cmd != nil {
		go func() {
			cmds <- cmd
		}()
	}

	// Render initial view
	p.render(model)

	// Subscribe to user input
	go func() {
		for {
			msg, err := ReadKey(os.Stdin)
			if err != nil {
				errs <- err
			}
			msgs <- KeyMsg(msg)
		}
	}()

	// Process commands
	go func() {
		for {
			select {
			case <-done:
				return
			case cmd := <-cmds:
				if cmd != nil {
					go func() {
						msgs <- cmd()
					}()
				}
			}
		}
	}()

	// Handle updates and draw
	for {
		select {
		case err := <-errs:
			close(done)
			return err
		case msg := <-msgs:

			// Handle quit message
			if _, ok := msg.(quitMsg); ok {
				close(done)
				return nil
			}

			// Process batch commands
			if batchedCmds, ok := msg.(batchMsg); ok {
				for _, cmd := range batchedCmds {
					cmds <- cmd
				}
				continue
			}

			model, cmd = p.update(msg, model) // run update
			cmds <- cmd                       // process command (if any)
			p.render(model)                   // render to terminal
		}
	}
}

// Render a view to the terminal. Returns the number of lines rendered.
func (p *Program) render(model Model) {
	view := p.view(model)

	// The view hasn't changed; no need to render
	if view == p.currentRender {
		return
	}

	p.currentRender = view
	linesRendered := strings.Count(p.currentRender, "\r\n")

	// Add carriage returns to ensure that the cursor travels to the start of a
	// column after a newline. Keep in mind that this means that in the rest
	// of the Tea program newlines should be a normal unix newline (\n).
	view = strings.Replace(view, "\n", "\r\n", -1)

	p.mutex.Lock()
	if linesRendered > 0 {
		termenv.ClearLines(linesRendered)
	}
	_, _ = io.WriteString(os.Stdout, view)
	p.mutex.Unlock()
}

// AltScreen exits the altscreen. This is just a wrapper around the termenv
// function.
func AltScreen() {
	termenv.AltScreen()
}

// ExitAltScreen exits the altscreen. This is just a wrapper around the termenv
// function.
func ExitAltScreen() {
	termenv.ExitAltScreen()
}