lua

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

type Options struct {
	// Registry receives commands defined with nem.command. Required.
	Registry *command.Registry

	// Keymap receives bindings made with nem.bind. Required.
	Keymap *keymap.Map

	// ModeKeymaps are the keymaps of the editor's modes, by name, for
	// nem.bind's optional third argument: nem.bind("k", "dired-do-delete",
	// "dired"). Optional; a mode not listed here is an error to bind in.
	ModeKeymaps map[string]*keymap.Map

	// ConfigPath is the script to load. Injectable so tests never touch a real
	// ~/.config.
	ConfigPath string

	// Timeout bounds a single entry into Lua. Zero means unlimited.
	//
	// It defaults to unlimited because a legitimate hook may be slow, and an
	// editor that abandons a user's formatting hook halfway is worse than one
	// that waits. Set it if you run scripts you do not trust: without it, a
	// `while true do end` in a config hangs the editor, which the protected
	// call cannot help with because a spin is not an error.
	Timeout time.Duration
}

type ScriptError struct {
	// Msg is the Lua error message.
	Msg string

	// Traceback is the Lua stack at the point of failure, empty if unavailable.
	Traceback string

	// Kind names the failure class gopher-lua reported, such as a syntax error
	// or a runtime panic, for callers that want to distinguish them.
	Kind string
}

type Settings struct {
	// TabWidth is the display width of a tab stop.
	TabWidth int

	// ScrollMargin is how many lines of context to keep above and below point.
	ScrollMargin int

	// UndoStyle selects the undo model. Only "linear" exists; the field is here
	// because the setting is documented, so an unknown value must be rejected
	// with a useful message rather than silently accepted.
	UndoStyle string

	// CompletionStyle is "bottom" (the prompt at the foot of the screen with
	// its candidates below it, as emacs and Vertico draw it) or "popup" (a
	// centred panel). Same prompt state either way; only the renderer differs.
	CompletionStyle string

	// CompletionRows is how many candidates a completion panel shows at once.
	CompletionRows int

	// WhichKeyDelay is how long a prefix must stay pending before the
	// continuation panel appears, in milliseconds. Zero disables it.
	WhichKeyDelay int

	// AutosaveIdle is how many seconds of idleness trigger an autosave of every
	// modified buffer. Zero disables it.
	AutosaveIdle int

	// Backup says whether to keep a copy of a file's previous contents the first
	// time it is saved in a session.
	Backup bool

	// Clipboard is "osc52" or "off". When on, kills also reach the system
	// clipboard.
	Clipboard string

	// LineNumbers says whether each window shows a line-number gutter.
	LineNumbers bool

	// DeleteSelection makes typing or deleting replace an active region, as
	// every modern editor does. Emacs ships this off; nem ships it on.
	DeleteSelection bool

	// Syntax says whether code is coloured.
	Syntax bool

	// Theme picks the syntax palette: "dark", "light", or "auto" to guess from
	// the terminal. One palette cannot serve both grounds - colours with enough
	// contrast on black wash out on white - so nem carries two.
	Theme string

	// OpenBinary decides what opening a file that is not text does: "ask"
	// each time, hand it to the "system" app, or open it as "text" anyway.
	OpenBinary string

	// FillColumn is the width M-q fills paragraphs to.
	FillColumn int

	// AutoPair makes an opening bracket or quote insert its partner too.
	AutoPair bool

	// Icons is "on", "off" or "auto": whether file icons show in dired and the
	// file and buffer prompts. They need a Nerd Font, or a terminal that ships
	// its symbols, and "auto" turns them on only where that looks likely. A
	// script sets it with true, false or "auto".
	Icons string

	// Shell is the program M-!, M-| and compile run commands with, given the
	// command after -c. Empty means /bin/sh, as Makefiles use.
	Shell string

	// AutoRevert reads a buffer without edits again when its file changes on
	// disk.
	AutoRevert bool

	// HighlightLine lays a faint band under the line point is on.
	HighlightLine bool

	// LineWrap folds a line wider than its window into rows, rather than
	// cutting it off at the edge.
	LineWrap bool

	// Bidi is "on", "off" or "auto": whether nem lays out right-to-left
	// text itself. "auto" does unless the terminal does it; a script sets it
	// with true, false or "auto".
	Bidi string

	// KeyboardLayout is "auto", "arabic" or "off": whether keys typed with
	// another keyboard layout - C-ط for C-x on a Persian one - are read as
	// the keys they sit on. "arabic" follows the Arabic keyboard for the
	// letters it puts elsewhere than the Persian one does. A script sets it
	// with "auto", "arabic" or false.
	KeyboardLayout string
}