termite

type AutoFlushingWriter struct {
	Writer *bufio.Writer
}

type Cursor interface {
	Position(row, col int)
	Up(l int)
	Down(l int)
	Forward(cols int)
	Backward(cols int)
	SavePosition()
	RestorePosition()
	Hide()
	Show()
}

type Matrix interface {
	// Start starts to update this matrix in the background
	Start() context.CancelFunc

	// NewRow allocates and returns a MatrixRow
	NewRow() MatrixRow

	// NewRange allocates and returns the specified n umber of rows
	NewRange(int) []MatrixRow

	// RefreshInterval returns the refresh interval of this matrix
	RefreshInterval() time.Duration

	// GetRow looks up a row by index. Returns an error if none exists
	GetRow(int) (MatrixRow, error)

	// GetRowByID looks up a row an ID. Returns an error if none exists
	GetRowByID(MatrixCellID) (MatrixRow, error)

	// UpdateTerminal updates the terminal immediately.
	//
	// This function can be used as a manual alternative to Start(), which updates the terminal
	// in the background based on the interval specified in the constructor. Combining Start with
	// manual updates can yield unwanted results though.
	UpdateTerminal(resetCursorPosition bool)
}

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

type MatrixRow interface {
	io.StringWriter
	io.Writer
	ID() MatrixCellID
	Update(string)
}

type ProgressBar interface {
	Tick() bool
	TickMessage(message string) bool
	IsDone() bool
	Start() (TickMessageFn, context.CancelFunc, error)
}

type ProgressBarFormatter interface {
	// FormatLeftBorder returns a string that contains one visible character and optionally
	// additional styling charatcers such as color codes, background and other effects.
	FormatLeftBorder() string

	// FormatRightBorder returns a string that contains one visible character and optionally
	// additional styling charatcers such as color codes, background and other effects.
	FormatRightBorder() string

	// FormatFill returns a string that contains one visible character and optionally
	// additional styling charatcers such as color codes, background and other effects.
	FormatFill() string

	// FormatBlank returns a string that contains one visible character and optionally
	// additional styling charatcers such as color codes, background and other effects.
	FormatBlank() string

	// MessageAreaWidth return the number of character used for the message area.
	MessageAreaWidth() int
}

type SimpleProgressBarFormatter struct {
	LeftBorderChar  rune
	RightBorderChar rune
	FillChar        rune
	BlankChar       rune
	MessageWidth    int
}

type SimpleSpinnerFormatter struct{}

type Spinner interface {
	Start() (context.CancelFunc, error)
	Stop(string) error
	SetTitle(title string) error
}

type SpinnerFormatter interface {
	// FormatTitle returns the input string with optional styling codes or anything else.
	FormatTitle(s string) string

	// FormatIndicator returns a string that contains one visible character - the one passed as input -
	// and optionally additional styling charatcers such as color codes, background and other effects.
	FormatIndicator(char string) string

	// CharSeq the character sequence to use as indicators.
	CharSeq() []string
}

type TickMessageFn = func(string) bool