package ecaml

  1. Overview
  2. Docs
module Async_ecaml : sig ... end
module Ecaml_callback : sig ... end

This module is used to enforce the expected types of registered callbacks.

module Emacs : sig ... end

This module contains functions for low-level interaction with the Emacs user interface.

module Expression : sig ... end

An Emacs expression.

module Function : sig ... end

Functions that call from Emacs to OCaml.

module Function_id : sig ... end

A unique id for each OCaml function that can be called from Emacs.

module Import : sig ... end
module Std : sig ... end
module Symbol : sig ... end

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

module Value : sig ... end

Value.t is the OCaml type corresponding to Emacs's universal type of values. It is represented as an OCaml custom block (emacs_value_ops in ecaml_stubs.c) wrapped around the emacs_value pointer type defined by the Emacs native-code module interface, emacs-module.h, available in Emacs 25 and beyond. This module has low-level functions for working with Emacs values, OCaml wrappers that call the C functions specified in emacs-module.h. All other calls from OCaml to Emacs are built on top of this module.

module Value0 : sig ... end

This module exists to break the dependency between Value and Callback.