package ecaml

  1. Overview
  2. Docs
Library for writing Emacs plugin in OCaml

Install 

dune-project
 Dependency

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

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

v0.17.0.tar.gz
sha256=87e76473915e12d718096100a5c4d15d98aba6f99ecbf21814b7389e8c28bb25

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

Module Ecaml_value.FormSource

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

include Value.Subtype
Sourcetype 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.

Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval 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.

Sourceval is_in_subtype : Value.t -> bool
Sourceval of_value_exn : Ecaml_value__.Value0.t -> t
Sourceval to_value : t -> Ecaml_value__.Value0.t
Sourceval type_ : t Value.Type.t
Sourceval eval : t -> Value.t Async_kernel.Deferred.t

(describe-function 'eval)

Sourceval eval_i : t -> unit Async_kernel.Deferred.t
Sourceval read : string -> t

(describe-function 'read)

Sourceval eval_string : string -> Value.t Async_kernel.Deferred.t

eval_string string = eval (read string)

Sourceval nil : t
Sourceval string : string -> t
Sourceval symbol : Symbol.t -> t
Sourceval int : int -> t
Sourceval quote : Value.t -> t
Sourceval progn : t list -> t
Sourceval let_ : (Symbol.t * t) list -> t -> t
Sourceval lambda : ?docstring:string -> ?interactive:Value.t -> ?optional_args:Symbol.t list -> ?rest_arg:Symbol.t -> Core.Source_code_position.t -> args:Symbol.t list -> body:t -> t
Sourceval list : t list -> t

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

Sourcemodule Blocking : sig ... end