elvish/pkg/edit/binding_map.go

package edit

import (
	"errors"
	"sort"

	"src.elv.sh/pkg/eval"
	"src.elv.sh/pkg/eval/vals"
	"src.elv.sh/pkg/parse"
	"src.elv.sh/pkg/ui"
)

var errValueShouldBeFn = errors.New("value should be function")

// A special Map that converts its key to ui.Key and ensures that its values
// satisfy eval.CallableValue.
type bindingsMap struct {
	vals.Map
}

var emptyBindingsMap = bindingsMap{vals.EmptyMap}

// Repr returns the representation of the binding table as if it were an
// ordinary map keyed by strings.
func (bt bindingsMap) Repr(indent int) string {
	var keys ui.Keys
	for it := bt.Map.Iterator(); it.HasElem(); it.Next() {
		k, _ := it.Elem()
		keys = append(keys, k.(ui.Key))
	}
	sort.Sort(keys)

	builder := vals.NewMapReprBuilder(indent)

	for _, k := range keys {
		v, _ := bt.Map.Index(k)
		builder.WritePair(parse.Quote(k.String()), indent+2, vals.Repr(v, indent+2))
	}

	return builder.String()
}

// Index converts the index to ui.Key and uses the Index of the inner Map.
func (bt bindingsMap) Index(index any) (any, error) {
	key, err := toKey(index)
	if err != nil {
		return nil, err
	}
	return vals.Index(bt.Map, key)
}

func (bt bindingsMap) HasKey(k any) bool {
	_, ok := bt.Map.Index(k)
	return ok
}

func (bt bindingsMap) GetKey(k ui.Key) eval.Callable {
	v, ok := bt.Map.Index(k)
	if !ok {
		panic("get called when key not present")
	}
	return v.(eval.Callable)
}

// Assoc converts the index to ui.Key, ensures that the value is CallableValue,
// uses the Assoc of the inner Map and converts the result to a BindingTable.
func (bt bindingsMap) Assoc(k, v any) (any, error) {
	key, err := toKey(k)
	if err != nil {
		return nil, err
	}
	f, ok := v.(eval.Callable)
	if !ok {
		return nil, errValueShouldBeFn
	}
	map2 := bt.Map.Assoc(key, f)
	return bindingsMap{map2}, nil
}

// Dissoc converts the key to ui.Key and calls the Dissoc method of the inner
// map.
func (bt bindingsMap) Dissoc(k any) any {
	key, err := toKey(k)
	if err != nil {
		// Key is invalid; dissoc is no-op.
		return bt
	}
	return bindingsMap{bt.Map.Dissoc(key)}
}

func makeBindingMap(raw vals.Map) (bindingsMap, error) {
	converted := vals.EmptyMap
	for it := raw.Iterator(); it.HasElem(); it.Next() {
		k, v := it.Elem()
		f, ok := v.(eval.Callable)
		if !ok {
			return emptyBindingsMap, errValueShouldBeFn
		}
		key, err := toKey(k)
		if err != nil {
			return bindingsMap{}, err
		}
		converted = converted.Assoc(key, f)
	}

	return bindingsMap{converted}, nil
}

type bindingTipEntry struct {
	text    string
	fnNames []string
}

func bindingTip(text string, fnNames ...string) bindingTipEntry {
	return bindingTipEntry{text, fnNames}
}

// Given a binding map and a list of function groups, returns a text describing
// the keys that are bound to any function in each group.
//
// This uses Elvish qnames for both the binding map and the functions because
// the place that calls bindingTips may not have direct access to them.
func bindingTips(ns *eval.Ns, binding string, entries ...bindingTipEntry) ui.Text {
	m := getVar(ns, binding).(bindingsMap)
	var t ui.Text
	for _, entry := range entries {
		values := make([]any, len(entry.fnNames))
		for i, fnName := range entry.fnNames {
			values[i] = getVar(ns, fnName+eval.FnSuffix)
		}
		keys := keysBoundTo(m, values)
		if len(keys) == 0 {
			continue
		}
		if len(t) > 0 {
			t = ui.Concat(t, ui.T(" "))
		}
		for _, k := range keys {
			t = ui.Concat(t, ui.T(k.String(), ui.Inverse), ui.T(" "))
		}
		t = ui.Concat(t, ui.T(entry.text))
	}
	return t
}

func getVar(ns *eval.Ns, qname string) any {
	segs := eval.SplitQNameSegs(qname)
	for _, seg := range segs[:len(segs)-1] {
		ns = ns.IndexString(seg).Get().(*eval.Ns)
	}
	return ns.IndexString(segs[len(segs)-1]).Get()
}

func keysBoundTo(m bindingsMap, values []any) []ui.Key {
	var keys []ui.Key
	for it := m.Iterator(); it.HasElem(); it.Next() {
		k, v := it.Elem()
		for _, value := range values {
			if v == value {
				keys = append(keys, k.(ui.Key))
				continue
			}
		}
	}
	return keys
}