Writing Emacs plugin in OCaml
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bench v0.11.120.00+105 Sep 7, 2018
example v0.11.117.19+55 Aug 10, 2018
gen v0.11.120.00+105 Sep 7, 2018
src v0.11.120.00+105 Sep 7, 2018
test v0.11.120.00+105 Sep 7, 2018
.gitignore 114.35+03 Mar 7, 2017
CONTRIBUTING.md v0.11.117.08+54 May 23, 2018
LICENSE.md v0.11.117.08+54 May 23, 2018
Makefile v0.11.117.08+54 May 23, 2018
README.md v0.11.117.19+55 Aug 10, 2018
ecaml.opam v0.11.117.19+55 Aug 10, 2018

README.md

Emacs plugin in OCaml

Ecaml is a library for writing Emacs plugins in OCaml. It uses Emacs 25 support for plugins to load native OCaml code into Emacs.

Building a plugin

Using Dune

Compile your plugin using (modes (native shared_object)) in the executable stanza of your dune file. See example/dune for an example.

Using Jane Street jenga rules

Simply add (only_shared_object true) to the executables stanza in your jbuild. For instance:

(executables
 ((names (my_plugin))
  (libraries (ecaml))
  (only_shared_object true)))

Then build my_plugin.so with jenga. This has been tested in opam using jane-build.

Using other build systems

You need to use the -output-complete-obj option of ocamlopt to produce a self-contained shared object file. For instance to build the plugin in the example/ directory:

$ ocamlfind ocamlopt -linkpkg -package ecaml -thread -output-complete-obj \
    -runtime-variant _pic -pp ppx-jane example_plugin.ml -o example_plugin.so

Links

As of Emacs version 25, Emacs supports plugins. Here is the API:

http://git.savannah.gnu.org/cgit/emacs.git/tree/src/emacs-module.h?id=e18ee60b02d08b2f075903005798d3d6064dc013

Here's a tutorial:

http://diobla.info/blog-archive/modules-tut.html

Here's an example plugin:

http://git.savannah.gnu.org/cgit/emacs.git/tree/modules/mod-test/mod-test.c?id=e18ee60b02d08b2f075903005798d3d6064dc013

Licensing

Note that Emacs modules must be GPL compatible, so you must make sure that your work based on Ecaml is released under a GPL compatible license.

Ecaml itself is released under the Apache 2.0 license which is GPL compatible.