package ecaml

  1. Overview
  2. Docs
Legend:
Library
Module
Module type
Parameter
Class
Class type

(Info-goto-node "(elisp)Command Loop")

A Command.t is an Elisp value satsifying commandp. (describe-function 'commandp)

include Ecaml_value.Value.Subtype
type t = private Ecaml_value.Value.t

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.

val sexp_of_t : t -> Ppx_sexp_conv_lib.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.

val is_in_subtype : Ecaml_value.Value.t -> bool
val of_value_exn : Ecaml_value__.Value0.t -> t
val to_value : t -> Ecaml_value__.Value0.t
module Raw_prefix_argument : sig ... end

(Info-goto-node "(elisp)Prefix Command Arguments")

val call_interactively : Ecaml_value.Value.t -> Raw_prefix_argument.t -> unit

(describe-function 'call-interactively) (Info-goto-node "(elisp)Interactive Call")

val inhibit_quit : bool Var.t

(describe-variable 'inhibit-quit) (Info-goto-node "(elisp)Quitting")

val quit_flag : bool Var.t

(describe-variable 'quit-flag) (Info-goto-node "(elisp)Quitting")

val quit_requested : unit -> bool
val request_quit : unit -> unit