Module Ecaml.Symbol

An Emacs symbol, i.e., an Emacs value that satisfies Value.is_symbol.

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

include Ecaml__.Symbol0_intf.Symbol0 with type t = Ecaml__.Symbol0.t
include 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_
include Core_kernel.Equal.S with type t := t
type t
include Value.Funcall with type t := t
type t
type value
val funcall0 : t ‑> value
val funcall1 : t ‑> value ‑> value
val funcall2 : t ‑> value ‑> value ‑> value
val funcall3 : t ‑> value ‑> value ‑> value ‑> value
val funcall4 : t ‑> value ‑> value ‑> value ‑> value ‑> value
val funcall5 : t ‑> value ‑> value ‑> value ‑> value ‑> value ‑> value
val funcallN : t ‑> value list ‑> value
val funcallN_array : t ‑> value array ‑> value
val funcall0_i : t ‑> unit
val funcall1_i : t ‑> value ‑> unit
val funcall2_i : t ‑> value ‑> value ‑> unit
val funcall3_i : t ‑> value ‑> value ‑> value ‑> unit
val funcall4_i : t ‑> value ‑> value ‑> value ‑> value ‑> unit
val funcall5_i : t ‑> value ‑> value ‑> value ‑> value ‑> value ‑> unit
val funcallN_i : t ‑> value list ‑> unit
val funcallN_array_i : t ‑> value array ‑> unit
val funcall_int_int_value_value_unit : t ‑> int ‑> int ‑> value ‑> value ‑> unit
val funcall_int_int_value_unit : t ‑> int ‑> int ‑> value ‑> unit
val intern : string ‑> t
val name : t ‑> string

Accessors

(describe-function 'symbol-name)

val function_exn : t ‑> Value.t

(describe-function 'symbol-name)

(describe-function 'symbol-function)

val compare_name : t ‑> t ‑> int
val create : name:string ‑> t

(describe-function 'make-symbol).

val gensym : ?⁠prefix:string ‑> unit ‑> t

(describe-function 'gensym).

val set_function : t ‑> Value.t ‑> unit

(describe-function 'fset).

type symbol = t
module type Subtype : sig ... end
module Make_subtype : functor (Arg : sig ... end) -> Subtype with type t := Arg.t