24.2.1 メジャーモードの慣習

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

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を参照)。このモード名はモードラインに表示される。
• 連続してメジャーモードコマンドを直接呼び出しても失敗せずに、1回だけ呼び出されたときと同じことを行うこと。言い換えるとメジャーモードコマンドはべき等であること。
• すべてのグローバル名は同じネームスペースにあるので、モードの一部であるようなすべてのグローバルな変数、定数、関数はメジャーモード名(メジャーモード名が長いようなら短縮名)で始まる名前をもつこと。Coding Conventionsを参照されたい。
• プログラム言語のようなある種の構造型テキストを編集するためのメジャーモードでは、その構造に応じたテキストのインデントがおそらく有用であろう。したがってそのようなモードはindent-line-functionに適切な関数をセットするとともに、インデント用のその他の変数をカスタマイズするべきだろう。Auto-Indentationを参照のこと。
• メジャーモードは、通常はそのモードにあるすべてのバッファーのローカルキーマップとして使用されるモード自身のキーマップをもつこと。メジャーモードコマンドはそのローカルマップをインストールするために、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を再定義するかもしれない。メジャーモードにニーズに応じてC-M-aを構成するための推奨方法は、そのモード固有の関数を呼び出すためにbeginning-of-defun-functionをセットすること(List Motionを参照)。

  ある標準的なキーシーケンスの標準的な意味がそのモードではほとんど役に立たないような場合にも、メジャーモードが標準的なキーシーケンスをリバインドする正当性がある。たとえば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を参照されたい。
• メニューバーへのモード固有メニュー追加を検討すること。ユーザーが迅速かつ効率的に主機能を発見できるよう、もっとも重要なモード固有のセッティングとコマンドを含めることが望ましい。
• そのモードにたいして、ユーザーがcontext-menu-mode (Menu Mouse Clicks in The Emacs Manualを参照)をアクティブにした際に使用されるモード固有のコンテキストメニューの追加を検討すること。これを達成するにはバッファー内でmouse-3がクリックされた位置に応じて1つ以上のメニューを構築するモード固有関数の定義して、context-menu-functionsのバッファーローカル値にその関数を追加すればよい。
• モードは変数imenu-generic-expression、imenu-prev-index-position-functionとimenu-extract-index-name-functionの2つの変数、または変数imenu-create-index-functionにバッファーローカルな値をセットすることによってImenuがバッファー内の定義やセクションを探す方法を指定すること(Imenuを参照)。
• モードはスペシャルフックeldoc-documentation-functionsに1つ以上のバッファーローカルエントリーを追加することにより、ポイント位置にあるものにたいして異なるタイプのドキュメントを取得する方法を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、モードフック、(バッファーがファイルをvisitしていれば)関数hack-local-variables、その後にノーマルフック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を参照)。