Module Ecaml__.Keymap

The command bindings of input events are recorded in data structures called keymaps. Each entry in a keymap associates (or "binds") an individual event type, either to another keymap or to a command. When an event type is bound to a keymap, that keymap is used to look up the next input event; this continues until a command is found. The whole process is called "key lookup".

(Info-goto-node "(elisp)Keymaps")

include Ecaml.Value.Subtype
type value
type t = private value

We expose private value for free identity conversions when the value is nested in some covariant type, e.g. (symbols : Symbol.t list :> Value.t list) rather than List.map symbols ~f:Symbol.to_value.

include sig ... end
val sexp_of_t : t ‑> Base.Sexp.t
val eq : t ‑> t ‑> bool

eq t1 t2 = Value.eq (to_value t1) (to_value t2), i.e. eq checks whether the Emacs values underlying t1 and t2 are physically equal. This is different than phys_equal t1 t2, because we don't always wrap eq Emacs values in phys_equal OCaml values. I.e. phys_equal t1 t2 implies eq t1 t2, but not the converse.

include Ecaml__.Valueable0.S with type t := t
type t
type 'a type_
val of_value_exn : Ecaml__.Value0.t ‑> t
val to_value : t ‑> Ecaml__.Value0.t
val type_ : t type_
type keymap = t
include Core_kernel.Equal.S with type t := t
type t
val parent : t ‑> t option

(describe-function 'keymap-parent)(Info-goto-node "(elisp)Inheritance and Keymaps")

val set_parent : t ‑> t option ‑> unit

(describe-function 'set-keymap-parent)(Info-goto-node "(elisp)Inheritance and Keymaps")

module Kind : sig ... end
val create : ?⁠kind:Kind.t ‑> ?⁠menu_name:string ‑> unit ‑> t

(describe-function 'make-sparse-keymap)(describe-function 'make-keymap)(Info-goto-node "(elisp) Creating Keymaps")

val deep_copy : t ‑> t

(describe-function 'copy-keymap)(Info-goto-node "(elisp) Creating Keymaps")

val global : unit ‑> t

(describe-function 'current-global-map)(Info-goto-node "(elisp)Controlling Active Maps")

val set_global : t ‑> unit

(describe-function 'use-global-map)(Info-goto-node "(elisp)Controlling Active Maps")

val set_transient : t ‑> unit

(describe-function 'set-transient-map)

module Entry : sig ... end
val lookup_key_exn : ?⁠accept_defaults:bool ‑> t ‑> Ecaml.Key_sequence.t ‑> Entry.t

(describe-function 'lookup-key)(Info-goto-node "(elisp)Functions for Key Lookup")

val define_key : t ‑> Ecaml.Key_sequence.t ‑> Entry.t ‑> unit

(describe-function 'define-key)(Info-goto-node "(elisp)Functions for Key Lookup")