Module Ecaml__.Form

An Emacs "form", which is a Lisp object that is intended to be evaluated. (Info-goto-node "(elisp)Forms").

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_
val eval : t ‑> Ecaml.Value.t

(describe-function 'eval)

val eval_i : t ‑> unit
val read : string ‑> t

(describe-function 'read)

val eval_string : string ‑> Ecaml.Value.t

eval_string string = eval (read string)

val nil : t
val string : string ‑> t
val symbol : Ecaml.Symbol.t ‑> t
val int : int ‑> t
val quote : Ecaml.Value.t ‑> t
val progn : t list ‑> t
val let_ : (Ecaml.Symbol.t * t) list ‑> t ‑> t
val lambda : ?⁠docstring:string ‑> ?⁠interactive:string ‑> ?⁠optional_args:Ecaml.Symbol.t list ‑> ?⁠rest_arg:Ecaml.Symbol.t ‑> Core_kernel.Source_code_position.t ‑> args:Ecaml.Symbol.t list ‑> body:t ‑> t
val defvar : Core_kernel.Source_code_position.t ‑> Ecaml.Symbol.t ‑> Ecaml.Value.t ‑> docstring:string ‑> unit

(describe-function 'defvar)(Info-goto-node "(elisp)Defining Variables")

val list : t list ‑> t

A function call, macro application, or special form. (Info-goto-node "(elisp)Classifying Lists").