22.2.1 Major Mode Conventions

メジャーモードにたいするすべてのコードはさまざまなコーディング規約にしたがうべきであり、それらの規約にはローカルキーマップおよび構文テーブルの初期化、関数名や変数名、フックにたいする規約が含まれます。

define-derived-modeマクロを使用した場合は、これらの規約を自動的に配慮します。Derived Modesを参照してください。Fundamentalモードは、Emacsのデフォルト状態を表すモードなにで、これらの規約が当てはまらないことに注意してください。

以下の規約リストは、ほんの一部です。一般的に、すべてのメジャーモードは、Emacs全体が首尾一貫するよう、他のEmacsメジャーモードとの一貫性を目指すべきです。ここで、この問題を洗い出すすべての想定される要点をリストするのは不可能です。Emacs開発者が、自身の開発するメジャーモードが通常の規約を逸脱する領域を示す場合は、互換性を保つようにしてください。

• 名前が‘-mode’で終わるようにメジャーモードコマンドを定義する。引数なしで呼び出されたとき、このコマンドはキーマップ、構文テーブル、既存バッファーのバッファーローカル変数をセットアップして、カレントバッファーを新たなモードに切り替えるべきである。そのバッファーのコンテンツを変更するべきではない。
• そのモードで利用できる特別なコマンドを説明するドキュメント文字列を記述する。Mode Helpを参照のこと。

  そのユーザー自身のキーバインディングに自動的に適合してヘルプが表示されるように、ドキュメント文字列に特別なドキュメントサブストリング‘\[command]’、‘\{keymap}’、‘\<keymap>’を含めるとよいかもしれない。Keys in Documentationを参照のこと。

• メジャーモードコマンドは、kill-all-local-variablesを呼び出すことにより開始するべきである。これは、ノーマルフックchange-major-mode-hookを実行してから、前のメジャーモードで効力のあったバッファーローカル変数を解放する。Creating Buffer-Localを参照のこと。
• メジャーモードコマンドは、変数major-modeにメジャーモードコマンドのシンボルをセットするべきである。これは、describe-modeがプリントするドキュメントを探す手掛かりとなる。
• メジャーモードコマンドは、変数mode-nameにそのモードの“愛称(pretty name)”をセットするべきである(これは通常は文字列だが、他の利用可能な形式は、Mode Line Dataを参照のこと)。このモード名は、モードラインに表示される。
• すべてのグローバル名は同じネームスペースにあるので、モードの一部であるようなすべてのグローバルな変数、定数、関数は、メジャーモード名(メジャーモード名が長いようなら短縮名)で始まる名前をもつべきである。Coding Conventionsを参照のこと。
• プログラム言語のような、ある種の構造型テキストを編集するためのメジャーモードでは、その構造に応じたテキストのインデントはおそらく有用であろう。したがって、そのようなモードはindent-line-functionに適切な関数をセットするとともに、インデント用のその他の変数をカスタマイズすべきだろう。
• メジャーモードは通常、そのモードにあるすべてのバッファーのローカルキーマップとして使用される、自モード身のキーマップをもつべきである。メジャーモードコマンドは、そのローカルマップをインストールするために、use-local-mapを呼び出すべきである。詳細は、Active Keymapsを参照のこと。

  このキーマップは、modename-mode-mapという名前のグローバル変数に永続的に格納されるべきである。通常、そのモードを定義するライブラリーは、この変数をセットする。

  モード用のキーマップ変数をセットアップするコードの記述する方法に関するアドバイスは、Tips for Definingを参照のこと。

• メジャーモードのキーマップ内でバインドされるキーシーケンスは、通常はC-cで始まり、その後にコントロール文字、数字、{、}、<、>、:、;が続くべきである。その他の記号文字(punctuation characters)はマイナーモードに、通常のアルファベット文字はユーザーのために予約されている。

  メジャーモードはM-n、M-p、M-sなどのキーもリバインドできる。M-nとM-pにたいするバインディングは、通常は “前方あるいは後方への移動”を意味するような類のものであるべきだが、これは必ずしもカーソル移動を意味する必要はない。

  そのモードにより適した方法でテキストに“同じ処理”を行うコマンドを提供する場合に、メジャーモードが標準的なキーシーケンスをリバインドするのは正当性がある。たとえば、プログラム言語を編集するためのメジャーモードは、その言語にとって“関数の先頭に移動する”がより良く機能する方法で、C-M-aを再定義するかもしれない。

  ある標準的なキーシーケンスの標準的な意味が、そのモードではほとんど役に立たないような場合にも、メジャーモードが標準的なキーシーケンスをリバインドする正当性がある。たとえば、ミニバッファーモードは、M-rの標準的な意味はミニバッファーではほとんど使用されないので、このキーシーケンスをリバインドする。テキストの自己挿入を許さないDiredやRmailのようなメジャーモードは、アルファベット文字や、その他のプリント文字を特別なコマンドに再定義する正当性がある。

• テキストを編集するメジャーモードは、改行の挿入以外の何かにRETを定義すべきではない。しかし、ユーザーが直接テキストを編集しない、DiredやInfoのような特別なモードにたいしては、完全に異なることを行うようにRETを再定義しても構わない。
• メジャーモードは、たとえばAuto-Fillモードを有効にするか等の、主にユーザーの好みに関するオプションを変更すべきではない。それらのオプションは、ユーザーに選択に任せること。ただし、もしユーザーがAuto-Fillモードを使用すると決定した場合には、それが便利に機能するように、他の変数をカスタマイズすべきである。
• モードは自身の構文テーブルをもつかもしれず、他の関連するモードと構文テーブルを共有するかもするかもしれない。モードが自身の構文テーブルをもつ場合は、modename-mode-syntax-tableという名前の変数にそれを格納すべきである。Syntax Tablesを参照のこと。
• コメントにたいして構文をもつ言語を扱うモードは、コメント構文を定義する変数をセットすべきである。Options Controlling Comments in The GNU Emacs Manualを参照のこと。
• モードは自身のabbrevテーブルをもつかもしれず、他の関連するモードと構文テーブルを共有するかもするかもしれない。モードが自身のabbrevテーブルをもつ場合は、modename-mode-abbrev-tableという名前の変数にそれを格納すべきである。メジャーモードコマンドが自身で何らかのabbrevを定義する場合は、define-abbrevのsystem-flag引数にtを渡すべきである。Defining Abbrevsを参照のこと。
• モードは、変数font-lock-defaultsにバッファーローカルな値をセットすることにより、Font Lockモードにたいしてハイライトする方法を指定すべきである(Font Lock Modeを参照)。
• モードが定義するすべてのフェイスは、もし可能なら既存のEmacsフェイスを継承すべきである。Basic FacesとFaces for Font Lockを参照のこと。
• モードは変数imenu-generic-expression、変数imenu-prev-index-position-function and imenu-extract-index-name-function、または変数imenu-create-index-functionにバッファーローカルな値をセットすることにより、Imenuがバッファー内の定義、またはセクションを探す方法を指定すべきである(Imenuを参照)。
• モードは、eldoc-documentation-functionにローカル値を指定して、ElDocモードがそのモードを処理する方法を指定できる。
• モードは、スペシャルフックcompletion-at-point-functionsに1つ以上のバッファーローカルエントリーを追加することにより、さまざまなキーワードの補完方法を指定できる。Completion in Buffersを参照のこと。
• Emacsのカスタマイズ変数にたいしてバッファーローカルなバインディングを作成するには、make-variable-buffer-localではなく、メジャーモードコマンド内でmake-local-variableを使用すること。関数、make-variable-buffer-localは、それ以降にカスタマイズ変数をセットするすべてのバッファーにたいしてその変数をローカルにし、そのモードを使用しないバッファーにたいしても影響があるだろう。そのようなグローバルな効果は、モードにとって好ましくない。Buffer-Local Variablesを参照のこと。

  稀な例外として、Lispパッケージ内でmake-variable-buffer-localを使用する唯一の正当な方法は、そのパッケージ内でのみ使用される変数にたいして使用をする場合である。他のパッケージにより使用される変数にたいしてこの関数を使用すると、干渉が起こるだろう。

• すべてのメジャーモードは、modename-mode-hookという名前のノーマルなモードフック(mode hook)をもつべきである。メジャーモードコマンドが一番最後に行うべきことは、run-mode-hooksの呼び出しである。これは、ノーマルフックchange-major-mode-after-body-hook、モードフック、その後にafter-change-major-mode-hookを実行する。Mode Hooksを参照のこと。
• メジャーモードコマンドは、親モード(parent mode)と呼ばれる他のいくつかのメジャーモードを呼び出すことにより開始されるかもしれず、それらのセッティングのいくつかを変更するかもしれない。これを行うモードは、派生モード(derived mode)と呼ばれる。派生モードを定義する推奨方法は、define-derived-modeマクロの使用であるが、これは必須ではない。そのようなモードは、delay-mode-hooksフォーム内で親のモードコマンドを呼び出すべきである(define-derived-modeは自動的にこれを行う)。Derived Modes、およびMode Hooksを参照のこと。
• ユーザーが、そのモードのバッファーから他のモードのバッファーに切り替える際に特別な何かを行う必要がある場合、モードはchange-major-mode-hookにたいしてバッファーローカル値をセットアップできる(Creating Buffer-Localを参照)。
• そのモードが、(ユーザーがキーボードでタイプしたテキストや、外部ファイルのテキストではなく)モード自身が生成する特別に用意されたテキストにたいしてのみ適す場合、メジャーモードコマンドのシンボルは、以下のようにmode-classという名前のプロパティに値specialをputすべきである:

  (put 'funny-mode 'mode-class 'special)
  

  これはEmacsにたいして、カレントバッファーがFunnyモードのときに新たなバッファーを作成したとき、たとえmajor-modeのデフォルト値がnilであっても、そのバッファーをFunnyモードにしないよう指示する。デフォルトでは、major-modeにたいする値nilは、新たなバッファー作成時にカレントバッファーのメジャーモードを使用することを意味するが(Auto Major Modeを参照)、specialなモードにたいしてはかわりにFundamentalモードが使用される。Dired、Rmail、Buffer Listのようなモードは、この機能を使用する。

  関数view-bufferは、mode-classがspecialであるようなバッファーではViewモードを有効にしない。そのようなモードは、通常は自身でViewに相当するバインディングを提供するからである。

  define-derived-modeマクロは、親モードがspecialの場合は、自動的に派生モードをspecialにマークする。親モードでspecialモードが有用なら、それを継承したモードでもであろう。Basic Major Modesを参照のこと。

• 新たなモードを、識別可能な特定のファイルにたいするデフォルトとしたい場合は、そのようなファイル名にたいしてそのモードを選択するために、auto-mode-alistに要素を追加する。autoload用にモードコマンドを定義する場合は、autoloadを呼び出すのと同じファイル内にその要素を追加すべきである。モードコマンドにたいしてautoload cookieを使用する場合は、その要素を追加するフォームにたいしてもautoload cookieを使用できる(autoload cookieを参照)。モードコマンドをautoloadしない場合は、モード定義を含むファイル内で要素を追加すれば十分である。
• 悪影響を与えることなく1回以上評価されるように、モード定義はファイル内のトップレベルのフォームとして記述すべきである。たとえば、すでに値をもつ変数が再初期化されないように、モードに関連した変数をセットするときは、defvarかdefcustomを使用する(Defining Variablesを参照)。