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.15.0.tar.gz

sha256=89f2806dd37012b07ddbaf40c2d9cfb9de29289944d921d23f4fd9b93d5c7cba

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

Module `Ecaml_value.Ecaml_callback`

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

type 'a t

val register : 
  'a t ->
  Core.Source_code_position.t ->
  f:'a ->
  should_run_holding_async_lock:bool ->
  unit

val dispatch_function : 
  (Ecaml_value__.Caml_embedded_id.t -> Value.t array -> Value.t) t

dispatch_function is how Emacs calls from C to OCaml.

val end_of_module_initialization : (unit -> unit) t

The C code arranges to call end_of_module_initialization at the end of emacs_module_init, which is what Emacs calls to initialize an Ecaml plugin. This is after all the other top-level OCaml code has run.

val free_embedded_caml_values : 
  (Ecaml_value__.Caml_embedded_id.t array -> unit) t

free_embedded_caml_values removes entries for any embeded ocaml values that are not longer used in emacs and are scheduled to be removed. The function runs whenever we enter OCaml from emacs, provided of course that there are values to collect.

val report_exn_when_calling_callback : exn -> unit

report_exn_when_calling_callback is called when the infrastructure that calls a callbacks raises. This is a rare situation, e.g. Out_of_memory.