本節では、Emacs用拡張モジュールを記述する際の一環として、EmacsモジュールのAPIとその使用方法について解説します。モジュールのAPIはC言語で定義されているため、本節の説明および例では、モジュールがC言語で記述されていることを前提としています。他のプログラミング言語を使用する場合は、Cコードを呼び出すための適切なバインディング、インターフェース、および機能を利用する必要があります。EmacsのCコードにはC99以降のコンパイラが必要となるため(C Dialectを参照)、本節のコード例もこの標準に準拠しています。
モジュールを記述し、Emacsに組み込むには、以下の作業が必要です。
以下のサブセクションでは、これらのタスクとAPI自体についてより詳しく説明します。
モジュールの記述が完了したら、基盤となるプラットフォームの規約に従ってコンパイルし、共有ライブラリを生成してください。その後、Emacsが参照できるよう、その共有ライブラリをload-pathで指定されているディレクトリ(ライブラリ検索を参照)に配置してください。
モジュールがEmacsの動的モジュールAPIに準拠しているか確認したい場合は、--module-assertionsオプションを指定してEmacsを起動してください。The GNU Emacs ManualのInitial Optionsを参照してください。