package ecaml

  1. Overview
  2. Docs
package ecaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'a t
val sexp_of_t : ('a -> Sexplib0.Sexp.t) -> 'a t -> Sexplib0.Sexp.t
val symbol : _ t -> Symbol.t
val var : 'a t -> 'a Var.t
val defvar : Symbol.t -> Core.Source_code_position.t -> ?docstring:string -> type_:'a Ecaml_value.Value.Type.t -> default_value:'a -> unit -> 'a t

defvar defines a buffer-local variable using Defvar.defvar, and calls Var.make_buffer_local_always.

val wrap_existing : ?make_buffer_local_always:bool -> Symbol.t -> 'a Ecaml_value.Value.Type.t -> 'a t

wrap_existing var takes a variable defined in Elisp and makes it available as a Buffer_local.t. If make_buffer_local_always = false, then wrap_existing raises if Var.is_buffer_local_always var = false. If make_buffer_local_always = true, then wrap_existing calls Var.make_buffer_local_always var.

module Wrap : sig ... end

Idiomatic usage of Wrap looks like:

val defvar_embedded : Symbol.t -> Core.Source_code_position.t -> ?docstring:string -> (module Ecaml__.Buffer_local_intf.Defvar_embedded_arg with type t = 'a) -> 'a option t

defvar_embedded defines a buffer-local variable whose Elisp representation is an opaque pointer to an OCaml value, via Caml_embed.create_type. This allows one to store an arbitrary OCaml value in a buffer local, without any conversions between OCaml and Elisp.

val get : 'a t -> Buffer.t -> 'a
val get_exn : 'a option t -> Buffer.t -> 'a
val set : 'a t -> 'a -> Buffer.t -> unit
val update_exn : 'a option t -> Buffer.t -> f:('a -> 'a) -> unit
val set_permanent : _ t -> bool -> unit

A permanent buffer-local variable is unaffected by kill-all-local-variables, and so it is not cleared by changing major modes. See (Info-goto-node "(elisp)Creating Buffer-Local").

val is_permanent : _ t -> bool
module Private : sig ... end
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct