1. Introduction

XEmacs is a powerful, extensible editor. The traditional way of extending the functionality of XEmacs is to use its built-in Lisp language (called Emacs Lisp, or Elisp for short). However, while Elisp is a full programming language and capable of extending XEmacs in more ways than you can imagine, it does have its short-comings.

Firstly, Elisp is an interpreted language, and this has serious speed implications. Like all other interpreted languages (like Java), Elisp is often suitable only for certain types of application or extension. So although Elisp is a general purpose language, and very high level, there are times when it is desirable to descend to a lower level compiled language for speed purposes.

Secondly, Elisp (or Lisp in general) is not a very common language any more, except for certain circles in the computer industry. C is a far more commonly known language, and because it is compiled, more suited to a wider range of applications, especially those that require low level access to a system or need to be as quick as possible.

This manual describes a new way of extending XEmacs, by using dynamically loadable modules (also known as dynamically loadable libraries (DLLs), dynamic shared objects (DSOs) or just simply shared objects), which can be written in C or C++ and loaded into XEmacs at any time. I sometimes refer to this technology as CEmacs, which is short for C Extensible Emacs.

XEmacs modules are configured into and installed with XEmacs by default on all systems that support loading of shared objects. From a users perspective, the internals of XEmacs modules are irrelevant. All a user will ever need to know about shared objects is the name of the shared object when they want to load a given module. From a developers perspective though, a lot more is provided.

• Of primary interest is the ellcc program. This program is created during compile time, and is intended to abstract compiler specific characteristics from the developer. This program is called to compile and link all objects that will make up the final shared object, and accepts all common C compiler flags. ellcc also sets up the correct environment for compiling modules by enabling any special compiler modes (such as PIC mode), setting the correct include paths for the location of XEmacs internal header files etc. The program will also invoke the linker correctly to created the final shared object which is loaded into XEmacs.
• CEmacs also makes all of the relevant XEmacs internal header files available for module authors to use. This is often required to get data structure definitions and external variable declarations. The header files installed include the module specific header file ‘emodules.h’. Due to the nature of dynamic modules, most of the internals of XEmacs are exposed. See (internals)Top section ‘Top’ in XEmacs Internals Manual, for a more complete discussion on how to extend and understand XEmacs. All of the rules for C modules are discussed there.
• Part of the XEmacs distribution is a set of sample modules. These are not installed when XEmacs is, but remain in the XEmacs source tree. These modules live in the directory ‘modules’, which is a sub-directory of the main XEmacs source code directory. Please look at the samples carefully, and maybe even use them as a basis for making your own modules. Most of the concepts required for writing extension modules are covered in the samples.
• Last, but not least is this manual. This can be viewed from within XEmacs, and it can be printed out as well. It is the intention of this document that it will describe everything you need to know about extending XEmacs in C. If you do not find this to be the case, please contact the author(s).

The rest of this document will discuss the actual mechanics of XEmacs modules and work through several of the samples. Please be sure that you have read the XEmacs Internals Manual and understand everything in it. The concepts there apply to all modules. This document may have some overlap, but it is the internals manual which should be considered the final authority. It will also help a great deal to look at the actual XEmacs source code to see how things are done.

This document was generated by Aidan Kehoe on December 27, 2016 using texi2html 1.82.