package history

var defaultSourceName = "default history"

// Source is an interface to allow you to write your own history logging tools.
// By default readline will just use the dummyLineHistory interface which only
// logs the history to memory ([]string to be precise).
type Source interface {
	// Append takes the line and returns an updated number of lines or an error
	Write(line string) (int, error)

	// GetLine takes the historic line number and returns the line or an error
	GetLine(pos int) (string, error)

	// Len returns the number of history lines
	Len() int

	// Dump returns everything in readline. The return is an interface{} because
	// not all LineHistory implementations will want to structure the history in
	// the same way. And since Dump() is not actually used by the readline API
	// internally, this methods return can be structured in whichever way is most
	// convenient for your own applications (or even just create an empty
	// function which returns `nil` if you don't require Dump() either)
	Dump() interface{}
}

// memory is an in memory history.
// One such history is bound to the readline shell by default.
type memory struct {
	items []string
}

// NewInMemoryHistory creates a new in-memory command history source.
//
//nolint:ireturn // Returns the Source interface by design: the concrete type is unexported.
func NewInMemoryHistory() Source {
	return new(memory)
}

// Write to history.
func (h *memory) Write(s string) (int, error) {
	h.items = append(h.items, s)
	return len(h.items), nil
}

// GetLine returns a line from history.
func (h *memory) GetLine(i int) (string, error) {
	if i < 0 {
		return "", errNegativeIndex
	}

	if i >= len(h.items) {
		return "", errOutOfRangeIndex
	}

	return h.items[i], nil
}

// Len returns the number of lines in history.
func (h *memory) Len() int {
	return len(h.items)
}

// Dump returns the entire history.
func (h *memory) Dump() interface{} {
	return h.items
}