package ecaml

  1. Overview
  2. Docs
Library for writing Emacs plugin in OCaml

Install 

dune-project
 Dependency

github.com Readme MIT License Edit opam file Versions (6)

Authors

  1. J
    Jane Street Group, LLC

Maintainers

  1. J
    Jane Street developers

Sources

ecaml-v0.14.0.tar.gz
sha256=ca97b30782e1b9fc42ccd54ba6afd60a7eb1087b56f3e21076ae33abfa638dfa
md5=ecae1a972130cd93c64eecc1ed71cad1

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

Module Ecaml_value.FuncallSource

A typeful interface for calling Elisp, as external does for C. E.g., 


let not : bool -> bool = "not" <: bool @-> return bool

let about_emacs : unit -> unit = "about-emacs" <: nullary @-> return nil
Sourcetype 'a t
Sourceval return : 'a Value.Type.t -> 'a t
Sourceval nil : unit Value.Type.t
Sourceval nullary : unit Value.Type.t
Sourceval (<:) : string -> 'a t -> 'a

"foo" <: ty imports Elisp function whose name is "foo" and whose type is ty, like how foo :> ty types an OCaml value.

Sourceval (@->) : 'a Value.Type.t -> 'b t -> ('a -> 'b) t
include Value.Type.S
Sourceval create : Core_kernel.Sexp.t -> ('a -> Core_kernel.Sexp.t) -> (Value.t -> 'a) -> ('a -> Value.t) -> 'a Value.Type.t
Sourceval with_of_value_exn : 'a Value.Type.t -> (Value.t -> 'a) -> 'a Value.Type.t
Sourceval to_sexp : 'a Value.Type.t -> 'a -> Core_kernel.Sexp.t
Sourceval bool : bool Value.Type.t
Sourceval float : float Value.Type.t
Sourceval ignored : unit Value.Type.t
Sourceval int : int Value.Type.t
Sourceval string : string Value.Type.t
Sourceval string_cached : string Value.Type.t

string_cached is like string, except it uses of_utf8_bytes_cached.

Sourceval unit : unit Value.Type.t
Sourceval list : 'a Value.Type.t -> 'a list Value.Type.t
Sourceval vector : 'a Value.Type.t -> 'a array Value.Type.t
Sourceval array_as_list : 'a Value.Type.t -> 'a array Value.Type.t

Represent an ocaml array as an elisp list, without creating an intermediate ocaml list.

Sourceval option : 'a Value.Type.t -> 'a option Value.Type.t

option represents None as nil and Some a as cons v nil, where v is the representation of a.

Sourceval nil_or : 'a Value.Type.t -> 'a option Value.Type.t

nil_or t_ represents None as nil and Some a as v, where v is the representation of a. This is a common representation used by Elisp functions. But it is only correct if nil is not a representation of any value in t; in that situation use Type.option_.

Sourceval alist : 'a Value.Type.t -> 'b Value.Type.t -> ('a * 'b) list Value.Type.t
Sourceval tuple : 'a Value.Type.t -> 'b Value.Type.t -> ('a * 'b) Value.Type.t

Represent a tuple (a,b) as the elisp cons cell (a . b)

Sourceval tuple2_as_list : 'a Value.Type.t -> 'b Value.Type.t -> ('a * 'b) Value.Type.t

Represent a tuple (a,b) as the elisp list '(a b)

Sourceval sexpable : (module Core_kernel.Sexpable with type t = 'a) -> name:Core_kernel.Sexp.t -> 'a Value.Type.t

Embed a sexpable ocaml type, so we can save values of the type in emacs, e.g. as buffer local variables

Sourceval path_list : string list Value.Type.t

A list of directories. Each element is a string (directory name) or nil (try default directory). nil values are converted to ".", which has the same meaning.

Sourcemodule Private : sig ... end