edit

Documentation

Overview

Package edit implements a command line editor.

Index

• Constants
• Variables
• type BindingTable
  • func (bt BindingTable) IndexOne(idx eval.Value) eval.Value
  • func (bt BindingTable) IndexSet(idx, v eval.Value)
  • func (BindingTable) Kind() string
  • func (bt BindingTable) Repr(indent int) string
• type BuiltinFn
  • func (bf *BuiltinFn) Call(ec *eval.EvalCtx, args []eval.Value, opts map[string]eval.Value)
  • func (*BuiltinFn) Kind() string
  • func (bf *BuiltinFn) Repr(int) string
• type CursorOnModeLiner
• type Editor
  • func NewEditor(file *os.File, sigs chan os.Signal, ev *eval.Evaler, st *store.Store) *Editor
  • func (ed *Editor) Active() bool
  • func (ed *Editor) ActiveMutex() *sync.Mutex
  • func (ed *Editor) CallFn(fn eval.CallableValue, args ...eval.Value)
  • func (ed *Editor) Notify(format string, args ...interface{})
  • func (ed *Editor) ReadLine() (line string, err error)
• type Highlighter
• type History
  • func (hv History) IndexOne(idx eval.Value) eval.Value
  • func (hv History) Iterate(f func(eval.Value) bool)
  • func (hv History) Kind() string
  • func (hv History) Len() int
  • func (hv History) Repr(int) string
• type ListRenderer
• type Lister
• type Mode
• type ModeType
• type Placeholderer
• type Pos
• type Writer
• Bugs

Constants

const (
	S_IWOTH = 0x2 // Writable by other
	S_IXGRP = 0x8 // Executable by group
	S_IXOTH = 0x1 // Executable by other
)

Weirdly, permission masks for group and other are missing on platforms other than linux, darwin and netbsd. So we replicate some of them here.

const FileBufferSize = 64 * 1024

Variables

var (
	ErrCompleterMustBeFn        = errors.New("completer must be fn")
	ErrCompleterArgMustBeString = errors.New("arguments to arg completers must be string")
	ErrTooFewArguments          = errors.New("too few arguments")
)

var (
	ErrNotRegular   = errors.New("no preview for non-regular file")
	ErrNotValidUTF8 = errors.New("no preview for non-utf8 file")
)

var ErrEditorInactive = errors.New("editor inactive")

var ErrStoreOffline = errors.New("store offline")

var Logger = util.GetLogger("[edit] ")

Types

type BindingTable

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

BindingTable adapts a binding table to eval.IndexSetter, so that it can be manipulated in elvish script.

func (BindingTable) IndexOne

func (bt BindingTable) IndexOne(idx eval.Value) eval.Value

func (BindingTable) IndexSet

func (bt BindingTable) IndexSet(idx, v eval.Value)

func (BindingTable) Kind

func (BindingTable) Kind() string

func (BindingTable) Repr

func (bt BindingTable) Repr(indent int) string

type BuiltinFn

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

BuiltinFn records an editor builtin.

func (*BuiltinFn) Call

func (bf *BuiltinFn) Call(ec *eval.EvalCtx, args []eval.Value, opts map[string]eval.Value)

func (*BuiltinFn) Kind

func (*BuiltinFn) Kind() string

func (*BuiltinFn) Repr

func (bf *BuiltinFn) Repr(int) string

type CursorOnModeLiner

type CursorOnModeLiner interface {
	CursorOnModeLine() bool
}

type Editor

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

Editor keeps the status of the line editor.

func NewEditor

func NewEditor(file *os.File, sigs chan os.Signal, ev *eval.Evaler, st *store.Store) *Editor

NewEditor creates an Editor.

func (*Editor) Active

func (ed *Editor) Active() bool

func (*Editor) ActiveMutex

func (ed *Editor) ActiveMutex() *sync.Mutex

func (*Editor) CallFn

func (ed *Editor) CallFn(fn eval.CallableValue, args ...eval.Value)

CallFn calls an Fn, displaying its outputs and possible errors as editor notifications. It is the preferred way to call a Fn while the editor is active.

func (*Editor) Notify

func (ed *Editor) Notify(format string, args ...interface{})

func (*Editor) ReadLine

func (ed *Editor) ReadLine() (line string, err error)

ReadLine reads a line interactively.

type Highlighter

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

type History

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

func (History) IndexOne

func (hv History) IndexOne(idx eval.Value) eval.Value

func (History) Iterate

func (hv History) Iterate(f func(eval.Value) bool)

func (History) Kind

func (hv History) Kind() string

func (History) Len

func (hv History) Len() int

func (History) Repr

func (hv History) Repr(int) string

type ListRenderer

type ListRenderer interface {
	// ListRender renders the listing under the given constraint of width and maximum
	// height. It returns a rendered buffer.
	ListRender(width, maxHeight int) *buffer
}

ListRenderer is a mode with a listing.

type Lister

type Lister interface {
	List(maxHeight int) renderer
}

Lister is a mode with a listing.

type Mode

type Mode interface {
	Mode() ModeType
	ModeLine() renderer
}

Mode is an editor mode.

type ModeType

type ModeType int

type Placeholderer

type Placeholderer interface {
	Placeholder() string
}

type Pos

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

Pos is the position within a buffer.

type Writer

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

Writer renders the editor UI.

Notes

Bugs

• buffer.write drops ASCII control characters silently