Module Ecaml.Buffer_local
val sexp_of_t : ('a -> Ppx_sexp_conv_lib.Sexp.t) -> 'a t -> Ppx_sexp_conv_lib.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__.Import.Value.Type.t -> default_value:'a -> unit -> 'a t
defvar
defines a buffer-local variable usingDefvar.defvar
, and callsVar.make_buffer_local_always
.
val wrap_existing : ?make_buffer_local_always:bool -> Symbol.t -> 'a Ecaml__.Import.Value.Type.t -> 'a t
wrap_existing var
takes a variable defined in Elisp and makes it available as aBuffer_local.t
. Ifmake_buffer_local_always = false
, thenwrap_existing
raises ifVar.is_buffer_local_always var = false
. Ifmake_buffer_local_always = true
, thenwrap_existing
callsVar.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, viaCaml_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 -> Ecaml__.Import.Buffer.t -> 'a
val get_exn : 'a option t -> Ecaml__.Import.Buffer.t -> 'a
val set : 'a t -> 'a -> Ecaml__.Import.Buffer.t -> unit
val update_exn : 'a option t -> Ecaml__.Import.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