次へ: キーバインドの規約, 上へ: ヒントと規約   [目次][索引]

D.1 Emacs Lisp コーディング規約 ¶

広く利用されることを想定した Emacs Lisp コードを記述する際に従うべき規約を以下に示します。

• 単にパッケージをロードしただけでは、Emacsの編集動作が変わるべきではありません。この機能を有効化・無効化したり、呼び出したりするためのコマンドを1つまたは複数含めてください。

  この規約は、カスタム定義を含むすべてのファイルにおいて必須となります。このようなファイルを本規約に準拠させるために非互換な変更が必要な場合は、迷わずその変更を行ってください。先延ばしにしてはいけません。

• プログラムを他のLispプログラムと区別するために、短い単語を選ぶとよいでしょう。プログラム内のすべてのグローバルシンボル、すなわち変数、定数、関数の名前は、選んだ接頭辞で始まるようにしてください。接頭辞と名前の残りの部分は、ハイフン ‘-’ で区切ります。この手法は、Emacs Lispのすべてのグローバル変数が同一の名前空間を共有し、すべての関数が別の名前空間を共有しているため、名前の衝突を避けるのに役立ちます³⁸。シンボルが他のパッケージで使用されることを想定していない場合は、接頭辞と名前を2つのハイフンで区切ってください。

  ユーザー向けのコマンド名の場合、パッケージ名のプレフィックスよりも前にいくつかの単語を置いた方が便利なことがあります。例えば、オブジェクトを ‘list-something’ という名前で列挙するコマンドを設けるのが我々の慣習です。具体的には、‘frob’ というパッケージがあり、他のグローバルシンボルが ‘frob-’ で始まる場合、‘list-frobs’ というコマンドを設けることができます。また、関数や変数などを定義する構文も、‘define-’ で始まる方がうまく機能する場合があるため、名前のプレフィックスを後方に配置しても問題ありません。ただし、こうした確立されたケースを除き、基本的には名前のプレフィックスを先頭に付けるようにしてください。

  twiddle-files のように、ある名称で Emacs に追加すべきだと考える関数を書いたとしても、プログラム内ではその名称で呼ばないでください。プログラム内では mylib-twiddle-files と呼び、‘bug-gnu-emacs@gnu.org’ 宛てに、Emacs への追加を提案するメールを送ってください。もし実際に追加されることになれば、名称は十分簡単に変更できます。

  プレフィックスが1つでは不十分な場合、意味が通じる限り、パッケージでは2つまたは3つの代替の共通プレフィックスを使用できます。

• 新規コードでは lexical-binding を有効にし、既存の Emacs Lisp コードで lexical-binding がまだ有効になっていない場合は、それを有効にするよう変換することをお勧めします。Lisp 方言の選択 を参照してください。
• 各個別のLispファイルの末尾に provide への呼び出しを記述してください。Features を参照してください。
• ファイルの読み込みに他の特定のLispプログラムが事前に必要である場合は、ファイル冒頭のコメントにその旨を記載してください。また、それらが確実に読み込まれるよう require を使用してください。Features を参照してください。
• ファイル foo が別のファイル bar で定義されたマクロを使用し、かつ bar で定義された関数や変数を一切使用しない場合、foo には以下の式を記述する必要があります。

  (eval-when-compile (require 'bar))
  

  これにより、Emacsはfooをバイトコンパイルする直前にbarをロードし、コンパイル中にマクロ定義が利用可能になります。eval-when-compileを使用することで、fooのコンパイル済みバージョンが使用される際にbarをロードせずに済みます。これは、ファイル内でそのマクロが最初に使用される前に呼び出す必要があります。マクロとバイトコンパイルを参照してください。

• 本当に必要な場合を除き、実行時に追加のライブラリを読み込むことは避けてください。もしファイルが他のライブラリなしでは動作しないのであれば、単にトップレベルでそのライブラリをrequire指定して済ませてください。しかし、ファイルに複数の独立した機能が含まれており、そのうち1つか2つだけが追加ライブラリを必要とする場合は、トップレベルではなく、該当する関数内にrequireステートメントを配置することを検討してください。あるいは、必要に応じてautoloadステートメントを使用して追加ライブラリを読み込んでください。こうすることで、ファイルのそれらの部分を使用しない人が、追加ライブラリを読み込む必要がなくなります。
• Common Lispの拡張機能が必要な場合は、旧版のclライブラリではなく、cl-libライブラリを使用してください。後者のライブラリは非推奨となっており、今後のEmacsのバージョンで削除される予定です。
• メジャーモードを定義する際は、メジャーモードの規約に従ってください。メジャーモードの規約を参照してください。
• マイナーモードを定義する際は、マイナーモードの規約に従ってください。マイナーモード記述の規約を参照してください。
• 関数の目的が、ある条件が真か偽かを示すことである場合は、その関数に ‘p’（「述語」の略）で終わる名前を付けてください。名前が1単語の場合は ‘p’ を、複数単語の場合は ‘-p’ を付加してください。例として framep や frame-live-p が挙げられます。ブール型変数の名前にこの -p という接尾辞を使用することは、変数が述語関数にバインドされている場合を除き、避けることを推奨します。代わりに -flag という接尾辞や、is-foo のような名前を使用してください。
• 変数の目的が単一の関数を格納することである場合は、末尾に ‘-function’ を付けた名前を付けてください。変数の目的が関数のリストを格納することである場合（すなわち、その変数がフックである場合）は、フックの命名規則に従ってください。フックを参照してください。
• unload-feature を使用すると、通常フィーチャーのロード時に行われる変更（フックへの関数追加など）が取り消されます。ただし、feature のロードによって通常とは異なる複雑な処理が行われる場合は、feature-unload-function という名前の関数を定義して、そうした特殊な変更を取り消すことができます。その場合、unload-feature は当該関数が存在すれば自動的に実行します。アンローディングを参照してください。
• Emacsのプリミティブにエイリアスを定義するのは得策ではありません。通常は代わりに標準名を使用すべきです。エイリアスが有用なのは、後方互換性や移植性の確保に役立つ場合に限られます。
• パッケージが、他のバージョンのEmacsとの互換性のためにエイリアスや新しい関数を定義する必要がある場合、別のバージョンで使用されているそのままの名前ではなく、パッケージプレフィックスを付けて命名してください。以下に、こうした互換性問題の例を数多く挙げているGnusの例を示します。

  (defalias 'gnus-point-at-bol
    (if (fboundp 'point-at-bol)
        'point-at-bol
      'line-beginning-position))
  

• Emacsのプリミティブを再定義したり助言したりするのは得策ではありません。特定のプログラムでは正しく動作するかもしれませんが、その結果として他のどのようなプログラムが動作しなくなるかは分かりません。
• 同様に、あるLispパッケージが別のLispパッケージの関数にアドバイズを行うことも好ましくありません（Emacs Lisp関数へのアドバイズを参照）。
• ライブラリやパッケージ内で eval-after-load や with-eval-after-load を使用することは避けてください（読み込み用フックを参照）。この機能は個人のカスタマイズを目的としたものであり、Lispプログラム内で使用することは、別のLispファイルの動作をそのファイルからは見えない形で変更するため、不作法な手法となります。これは、別のパッケージにある関数に助言を与えるのと同様に、デバッグの妨げとなります。
• ファイルがEmacsの標準関数やライブラリプログラムのいずれかを置き換える場合は、ファイル冒頭の目立つコメントに、どの関数が置き換えられたのか、また置き換え後の動作が元の動作とどのように異なるのかを記載すべきです。
• 関数や変数を定義するコンストラクトは、関数ではなくマクロとし、その名称は ‘define-’ で始まる必要があります。マクロは、定義対象の名称を第1引数として受け取ります。これにより、さまざまなツールが定義箇所を自動的に検出できるようになります。マクロ内で名称を構築することは、これらのツールを混乱させるため避けてください。この形式で記述できない場合は、名称にプロパティ definition-name または find-function-type-alist を付与することで、これらのツールが定義箇所の呼び出しを特定できるようにできます。定義の検索を参照してください。
• 他のいくつかのシステムでは、変数名の先頭と末尾を ‘*’ とする慣習があります。Emacs Lispではこの慣習は採用していませんので、プログラム内で使用しないでください。（Emacsでは、このような名称は特殊な用途のバッファにのみ使用されます。）すべてのライブラリが同じ慣習を採用していれば、ユーザーはEmacsをより一貫性のあるものと感じるでしょう。
• Emacs Lispソースファイルのデフォルトのファイルエンコーディング方式はUTF-8です（テキスト表現を参照）。万が一、プログラムにUTF-8に含まれない文字がある場合は、ソースファイルの「-*-」行またはローカル変数リストで、適切なエンコーディング方式を指定してください。The GNU Emacs Manualのファイル内のローカル変数を参照してください。
• デフォルトのインデントパラメータを使用してファイルをインデントしてください。
• 行末に閉じ括弧を単独で置く習慣はつけないようにしましょう。Lispプログラマーはこれを違和感を覚えます。
• コピーを配布する場合は、ファイルに著作権表示と複製許諾表示を記載してください。Emacsライブラリの標準的なヘッダーを参照してください。
• ファイル名やディレクトリ名を保持する変数（またはそれらを返す関数）については、名前に path を使用することを避け、代わりに file、file-name、または directory を優先してください。これは、Emacs が GNU の慣習に従い、path という用語をディレクトリ名のリストである検索パスにのみ使用しているためです。