24.2.4 派生モードの定義

新しいメジャーモードを定義する推奨方法は、define-derived-modeを使用して既存のメジャーモードから派生させる方法です。それほど近いモードが存在しない場合はtext-mode、special-mode、またはprog-modeから継承するべきです。Basic Major Modesを参照してください。これらがいずれも適切でなければ、fundamental-modeから継承することができます(Major Modesを参照)。

Macro: define-derived-mode variant parent name docstring keyword-args… body…

このマクロはvariantをメジャーモードコマンドとして定義して、nameをモード名の文字列形式とする。variantとparentはクォートされていないシンボルであること。

新たなコマンドvariantは関数parentを呼び出すよう定義されて、その後その親モードの特定の性質をオーバーライドする。

• 新たなモードはvariant-mapという名前の、自身のsparseキーマップ(疎キーマップ)をもつ。define-derived-modeはvariant-mapがすでにセットされていて、かつすでに親をもつ場合を除いて親モードのキーマップを新たなマップの親キーマップにする。
• 新たなモードは自身の構文テーブル(syntax table)をもち、それは変数variant-syntax-tableに保持される。ただし:syntax-tableキーワード(以下参照)を使用してこれをオーバーライドした場合は異なる。define-derived-modeはvariant-syntax-tableがすでにセットされていて、かつ標準的な構文テーブルよ異なる親をもつ場合を除いて、親モードの構文テーブルをvariant-syntax-tableの親とする。
• 新たなモードは自身のabbrevテーブル(略語テーブル)をもち、それは変数variant-abbrev-tableに保持される。ただし:abbrev-tableキーワード(以下参照)を使用してこれをオーバーライドした場合は異なる。
• 新たなモードは自身のモードフックvariant-hookをもつ。これはフックを実行した後に:after-hookがあればそれを実行して、それとは別に最後にrun-mode-hooksによって自身の祖先のモードのフックを実行する。

これらに加えてbodyでparentのその他の性質をオーバーライドする方法を指定できます。コマンドvariantは通常のオーバーライドをセットアップした後、そのモードのフックを実行する直前にbody内のフォームを評価します。

parentが非nilのmode-classシンボルプロパティをもつ場合、define-derived-modeはvariantのmode-classプロパティに同じ値をセットします。これはたとえばparentがspecialモードならvariantもspecialモードになることを保証します(Major Mode Conventionsを参照)。

parentにたいしてnilを指定することもできます。これにより新たなモードは親をもたなくなります。その後にdefine-derived-modeは上述のように振る舞いますが、当然parentにつながるすべてのアクションは省略されます。

引数docstringは新たなモードにたいするドキュメント文字列を指定します。define-derived-modeはこのドキュメント文字列の最後にそのモードフックに関する一般的な情報と、その後にそのモードのキーマップを追加します。docstringを省略するとdefine-derived-modeがドキュメント文字列を生成します。

keyword-argsはキーワードと値のペアー。:after-hookのものを除いて値は評価される。現在のところ以下のキーワードがサポートされる:

:syntax-table

新たなモードにたいする構文テーブルを明示的に指定するためにこれを使用できる。nil値を指定すると新たなモードはparentと同じ構文テーブル、parentもnilなら標準的な構文テーブルを使用する(これはnil値の非キーワード引数は引数を指定しないのと同じという通常の慣習にはしたがわないことに注意)。

:abbrev-table

新たなモードにたいするabbrevテーブルを明示的に指定するためにこれを使用できる。nil値を指定すると新たなモードはparentと同じabbrevテーブル、parentもnilならfundamental-mode-abbrev-tableを使用する(繰り返すがnil値はこのキーワードを指定しないことではない)。

:interactive

モードはデフォルトではインタラクティブコマンド。nil値を指定すると、ここで指定したモードはインタラクティブにならない。これはユーザーが手動でアクティブにされることはないが、特別にフォーマットされたバッファーでのみ使用されることを意図したモードで有用。

:group

これが指定する場合、値はそのモードにたいするカスタマイズグループ(customization group)であること(すべてのメジャーモードがカスタマイズグループをもつ訳ではない)。customize-modeコマンドはこれを使用する。define-derived-modeは指定されたカスタマイズグループを自動的に定義しない。

:after-hook

このオプションのｋｅｙはモードフック実行後にモード関数の最後の活動として評価される単一のLispフォームを指定する。クォートしないこと。モードにが終了した後にフォーが評価されるので、モード関数のローカル状態のすべての要素にアクセスするべきではない。:after-hookフォームはモードフックで変更されているかもしれないユーザーのセッティングに依存するモードの様相をセットアップするために有用。

以下は架空の例:

(defvar hypertext-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map [down-mouse-3] 'do-hyper-link)
    map))

(define-derived-mode hypertext-mode
  text-mode "Hypertext"
  "ハイパーテキスト用のメジャーモード"
  (setq-local case-fold-search nil))

define-derived-modeが自動的に行うので、この定義内にinteractive指定を記述してはならない。

Function: derived-mode-p &rest modes

この関数はカレントメジャーモードがシンボルmodesで与えられたメジャーモードのいずれかから派生されていたら非nilをリターンする。