package inputrc

Import Path
	github.com/reeflective/readline/inputrc (on go.dev)

Dependency Relation
	imports 13 packages, and imported by 11 packages

Involved Source Files

	    bind.go
	    config.go
	    constants.go
	  d inputrc.go
		Package inputrc parses readline inputrc files.

	    parse.go
Code Examples

	
		package main
		
		import (
			"os/user"
		
			"github.com/reeflective/readline/inputrc"
		)
		
		func main() {
			u, err := user.Current()
			if err != nil {
				panic(err)
			}
		
			cfg := inputrc.NewDefaultConfig()
			if err := inputrc.UserDefault(u, cfg, inputrc.WithApp("bash")); err != nil {
				panic(err)
			}
		}

	Parse
		package main
		
		import (
			"fmt"
			"strings"
		
			"github.com/reeflective/readline/inputrc"
		)
		
		func main() {
			const example = `
		set editing-mode vi
		$if Usql
		  set keymap vi-insert
		  "\r": a-usql-action
		  "\d": 'echo test\n'
		$endif
		
		`
		
			cfg := inputrc.NewDefaultConfig()
			if err := inputrc.Parse(strings.NewReader(example), cfg, inputrc.WithApp("usql")); err != nil {
				panic(err)
			}
		
			fmt.Println("editing mode:", cfg.GetString("editing-mode"))
			fmt.Println("vi-insert:")
			fmt.Printf("  %s: %s\n", inputrc.Escape(string(inputrc.Return)), cfg.Binds["vi-insert"][string(inputrc.Return)].Action)
			fmt.Printf("  %s: '%s'\n", inputrc.Escape(string(inputrc.Delete)), inputrc.EscapeMacro(cfg.Binds["vi-insert"][string(inputrc.Delete)].Action))
		}


Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Bind (struct)
		Bind represents a key binding.

		Fields (total 2)
			Action string
			Macro bool
		As Outputs Of (at least 5)
			func DefaultBinds() map[string]map[string]Bind
			func github.com/reeflective/readline/internal/history.(*Sources).Last() Bind
			func github.com/reeflective/readline/internal/keymap.MatchLocal(eng *keymap.Engine) (bind Bind, command func(), prefix bool)
			func github.com/reeflective/readline/internal/keymap.MatchMain(eng *keymap.Engine) (bind Bind, command func(), prefix bool)
			func github.com/reeflective/readline/internal/keymap.(*Engine).ActiveCommand() Bind
		As Inputs Of (at least one exported)
			func github.com/reeflective/readline/internal/history.(*Sources).SaveWithCommand(bind Bind)

	 type Config (struct)
		Config is a inputrc config handler.

		Fields (total 4)
			Binds map[string]map[string]Bind
			Funcs map[string]func(string, string) error
			ReadFileFunc func(string) ([]byte, error)
			Vars map[string]interface{}
		Methods (total 8)
			(*Config) Bind(keymap, sequence, action string, macro bool) error
				Bind satisfies the Handler interface.

			(*Config) Do(name, value string) error
				Do satisfies the Handler interface.

			(*Config) Get(name string) interface{}
				Get satisfies the Handler interface.

			(*Config) GetBool(name string) bool
				GetBool returns the var name as a bool.

			(*Config) GetInt(name string) int
				GetInt returns the var name as a int.

			(*Config) GetString(name string) string
				GetString returns the var name as a string.

			(*Config) ReadFile(name string) ([]byte, error)
				ReadFile satisfies the Handler interface.

			(*Config) Set(name string, value interface{}) error
				Set satisfies the Handler interface.

		Implements (at least one exported)
			*Config : Handler
		As Outputs Of (at least 3)
			func NewConfig() *Config
			func NewDefaultConfig(opts ...ConfigOption) *Config
			func github.com/reeflective/readline/internal/keymap.NewEngine(keys *core.Keys, i *core.Iterations, opts ...Option) (*keymap.Engine, *Config)
		As Inputs Of (at least 6)
			func UserDefault(u *user.User, cfg *Config, opts ...Option) error
			func github.com/reeflective/readline/internal/completion.NewEngine(h *ui.Hint, km *keymap.Engine, o *Config) *completion.Engine
			func github.com/reeflective/readline/internal/core.WaitAvailableKeys(keys *core.Keys, cfg *Config)
			func github.com/reeflective/readline/internal/display.NewEngine(k *core.Keys, s *core.Selection, h *history.Sources, p *ui.Prompt, i *ui.Hint, c *completion.Engine, opts *Config) *display.Engine
			func github.com/reeflective/readline/internal/history.NewSources(line *core.Line, cur *core.Cursor, hint *ui.Hint, opts *Config) *history.Sources
			func github.com/reeflective/readline/internal/ui.NewPrompt(line *core.Line, cursor *core.Cursor, keymaps *keymap.Engine, opts *Config) *ui.Prompt

	 type ConfigOption (func)
		ConfigOption is a inputrc config handler option.

		As Outputs Of (at least one exported)
			func WithConfigReadFileFunc(readFileFunc func(string) ([]byte, error)) ConfigOption
		As Inputs Of (at least one exported)
			func NewDefaultConfig(opts ...ConfigOption) *Config

	 type Error string (basic type)
		Error is a error.

		Methods (only one)
			( Error) Error() string
				Error satisfies the error interface.

		Implements (at least one exported)
			 Error : error
		As Types Of (total 8)
			const ErrBindMissingClosingQuote
			const ErrElseWithoutMatchingIf
			const ErrEndifWithoutMatchingIf
			const ErrInvalidEditingMode
			const ErrInvalidKeymap
			const ErrMacroMissingClosingQuote
			const ErrMissingColon
			const ErrUnknownModifier

	 type Handler (interface)
		Handler is the handler interface.

		Methods (total 5)
			( Handler) Bind(keymap, sequence, action string, macro bool) error
				Bind binds a key sequence to an action for the current keymap.

			( Handler) Do(typ string, param string) error
				Do handles $constructs.

			( Handler) Get(name string) interface{}
				Get gets the value.

			( Handler) ReadFile(name string) ([]byte, error)
				ReadFile reads a file.

			( Handler) Set(name string, value interface{}) error
				Set sets the value.

		Implemented By (at least one exported)
			*Config
		As Inputs Of (at least 4)
			func Parse(r io.Reader, h Handler, opts ...Option) error
			func ParseBytes(buf []byte, h Handler, opts ...Option) error
			func ParseFile(name string, h Handler, opts ...Option) error
			func (*Parser).Parse(stream io.Reader, handler Handler) error

	 type Option (func)
		Option is a parser option.

		As Outputs Of (at least 6)
			func WithApp(app string) Option
			func WithHaltOnErr(haltOnErr bool) Option
			func WithMode(mode string) Option
			func WithName(name string) Option
			func WithStrict(strict bool) Option
			func WithTerm(term string) Option
		As Inputs Of (at least 8)
			func New(opts ...Option) *Parser
			func Parse(r io.Reader, h Handler, opts ...Option) error
			func ParseBytes(buf []byte, h Handler, opts ...Option) error
			func ParseFile(name string, h Handler, opts ...Option) error
			func UserDefault(u *user.User, cfg *Config, opts ...Option) error
			func github.com/reeflective/readline.NewShell(opts ...Option) *readline.Shell
			func github.com/reeflective/readline/internal/keymap.NewEngine(keys *core.Keys, i *core.Iterations, opts ...Option) (*keymap.Engine, *Config)
			func github.com/reeflective/readline/internal/keymap.(*Engine).ReloadConfig(opts ...Option) (err error)

	 type ParseError (struct)
		ParseError is a parse error.

		Fields (total 4)
			Err error
			Line int
			Name string
			Text string
		Methods (total 2)
			(*ParseError) Error() string
				Error satisfies the error interface.

			(*ParseError) Unwrap() error
				Unwrap satisfies the errors.Unwrap call.

		Implements (at least 2)
			*ParseError : error
			*ParseError : golang.org/x/xerrors.Wrapper

	 type Parser (struct)
		Parser is a inputrc parser.

		Methods (total 2)
			(*Parser) Errs() []error
				Errs returns the parse errors encountered.

			(*Parser) Parse(stream io.Reader, handler Handler) error
				Parse parses inputrc data from the reader, passing sets and binding keys to
				h based on the configured options.

		As Outputs Of (at least one exported)
			func New(opts ...Option) *Parser


Package-Level Functions (total 25)

	 func Decontrol(c rune) rune
		Decontrol decodes a Control-c code.

	 func DefaultBinds() map[string]map[string]Bind
		DefaultBinds are the default readline bind keymaps.
		
		see: INPUTRC=/dev/null bash -c 'bind -pm <keymap>'

	 func DefaultVars() map[string]interface{}
		DefaultVars are the default readline vars.
		
		see: INPUTRC=/dev/null bash -c 'bind -v'

	 func Demeta(c rune) rune
		Demeta decodes a Meta-c code.

	 func Encontrol(c rune) rune
		Encontrol encodes a Control-c code.

	 func Enmeta(c rune) rune
		Enmeta encodes a Meta-c code.

	 func Escape(s string) string
		Escape escapes a inputrc string.

	 func EscapeMacro(s string) string
		EscapeMacro escapes a inputrc macro.

	 func IsControl(c rune) bool
		IsControl returns true when c is a Control-c code.

	 func IsMeta(c rune) bool
		IsMeta returns true when c is a Meta-c code.

	 func New(opts ...Option) *Parser
		New creates a new inputrc parser.

	 func NewConfig() *Config
		NewConfig creates a new inputrc config.

	 func NewDefaultConfig(opts ...ConfigOption) *Config
		NewDefaultConfig creates a new inputrc config with default values.

	 func Parse(r io.Reader, h Handler, opts ...Option) error
		Parse parses inputrc data from r.

	 func ParseBytes(buf []byte, h Handler, opts ...Option) error
		ParseBytes parses inputrc data from buf.

	 func ParseFile(name string, h Handler, opts ...Option) error
		ParseFile parses inputrc data from a file name.

	 func Unescape(s string) string
		Unescape unescapes a inputrc string.

	 func UserDefault(u *user.User, cfg *Config, opts ...Option) error
		UserDefault loads default inputrc settings for the user.

	 func WithApp(app string) Option
		WithApp is a parser option to set the app name.

	 func WithConfigReadFileFunc(readFileFunc func(string) ([]byte, error)) ConfigOption
		WithConfigReadFileFunc is a inputrc config option to set the func used
		for ReadFile operations.

	 func WithHaltOnErr(haltOnErr bool) Option
		WithHaltOnErr is a parser option to set halt on every encountered error.

	 func WithMode(mode string) Option
		WithMode is a parser option to set the mode name.

	 func WithName(name string) Option
		WithName is a parser option to set the file name.

	 func WithStrict(strict bool) Option
		WithStrict is a parser option to set strict keymap parsing.

	 func WithTerm(term string) Option
		WithTerm is a parser option to set the term name.


Package-Level Constants (total 20)

	const Alert rune = 7
		Keys.

	const Backspace rune = 8
		Keys.

	const Control rune = 31
		Keys.

	const Delete rune = 127
		Keys.

	const ErrBindMissingClosingQuote Error = "bind missing closing quote"
		ErrBindMissingClosingQuote is the bind missing closing quote error.

	const ErrElseWithoutMatchingIf Error = "$else without matching $if"
		ErrElseWithoutMatchingIf is the $else without matching $if error.

	const ErrEndifWithoutMatchingIf Error = "$endif without matching $if"
		ErrEndifWithoutMatchingIf is the $endif without matching $if error.

	const ErrInvalidEditingMode Error = "invalid editing mode"
		ErrInvalidEditingMode is the invalid editing mode error.

	const ErrInvalidKeymap Error = "invalid keymap"
		ErrInvalidKeymap is the invalid keymap error.

	const ErrMacroMissingClosingQuote Error = "macro missing closing quote"
		ErrMacroMissingClosingQuote is the macro missing closing quote error.

	const ErrMissingColon Error = "missing :"
		ErrMissingColon is the missing : error.

	const ErrUnknownModifier Error = "unknown modifier"
		ErrUnknownModifier is the unknown modifier error.

	const Esc rune = 27
		Keys.

	const Formfeed rune = 12
		Keys.

	const Meta rune = 128
		Keys.

	const Newline rune = 10
		Keys.

	const Return rune = 13
		Keys.

	const Space rune = 32
		Keys.

	const Tab rune = 9
		Keys.

	const Vertical rune = 11
		Keys.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.