package ecaml

You can search for identifiers within the package.

in-package search v0.2.0

Library for writing Emacs plugin in OCaml

Install

Dune Dependency

github.com Readme MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

ecaml-v0.12.0.tar.gz

sha256=765b64e5767a1da79f38734b40b99c465856a236256cdd4ca706449d5fb2b05e

md5=2ddd362aec66de0a82e8aa1c05ec1fa4

doc/ecaml.ecaml_value/Ecaml_value/Form/index.html

Module `Ecaml_value.Form`

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

include Value.Subtype

type t = private 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 : Value.t -> bool

val of_value_exn : Ecaml_value__.Value0.t -> t

val to_value : t -> Ecaml_value__.Value0.t

val type_ : t Value.Type.t

val eval : t -> Value.t

(describe-function 'eval)

val eval_i : t -> unit

val read : string -> t

(describe-function 'read)

val eval_string : string -> Value.t

eval_string string = eval (read string)

val nil : t

val string : string -> t

val symbol : Symbol.t -> t

val int : int -> t

val quote : Value.t -> t

val progn : t list -> t

val let_ : (Symbol.t * t) list -> t -> t

val lambda : 
  ?docstring:string ->
  ?interactive:string ->
  ?optional_args:Symbol.t list ->
  ?rest_arg:Symbol.t ->
  Core_kernel.Source_code_position.t ->
  args:Symbol.t list ->
  body:t ->
  t

val list : t list -> t

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