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 Changelog MIT License Edit opam file Versions (6)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

ecaml-v0.16.0.tar.gz

sha256=d9c6f98e7b0906a7e3d332d1a30fe950b59586b860e4f051348ea854c3ae3434

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

Module `Ecaml_value.Ecaml_callback`Source

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

Sourcetype 'a t

Source

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

Source

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.

Sourceval 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.

Source

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.

Sourceval 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.

package ecaml

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module Ecaml_value.Ecaml_callbackSource

Module `Ecaml_value.Ecaml_callback`Source