23.2.8 ジェネリックモード

genericモード(汎用モード)とは、コメント構文にたいする基本的なサポートとFont Lockモードをもつシンプルなメジャーモードです。genericモードを定義するにはマクロdefine-generic-modeを使用します。define-generic-modeの使い方の例は、ファイルgeneric-x.elを参照してください。

Macro: define-generic-mode mode comment-list keyword-list font-lock-list auto-mode-list function-list &optional docstring

このマクロはmode (クォートされていないシンボル)という名前のgenericモードコマンドを定義する。オプション引数docstringは、そのモードコマンドにたいするドキュメント文字列。これを与えなければdefine-generic-modeがデフォルトのドキュメント文字列を生成する。

引数comment-listは要素が文字、2文字以下の文字列、またはコンスセルである。文字か文字列ならそのモードの構文テーブル内でコメント開始識別子としてセットアップされる。エントリーがコンスセルならCARはコメント開始識別子、CDRはコメント終了識別子としてセットアップされる(行末によりコメントを終端させたければ後者にnilを使用する)。構文テーブルのメカニズムには実際にコメントの開始および終了識別子に関する制限があることに注意。 Syntax Tablesを参照のこと。

引数keyword-listはfont-lock-keyword-faceでハイライトするキーワードのリストである。キーワードは文字列であること。一方、font-lock-listはハイライトするための追加の式リストである。このリストの各要素はfont-lock-keywordsの要素と同じ形式をもつこと。Search-based Fontificationを参照されたい。

引数auto-mode-listは変数auto-mode-alistに追加する正規表現のリストである。これらのは、マクロ呼び出しの展開時ではなく、define-generic-modeの実行時に追加される。

最後にfunction-listは追加セットアップのためにモードコマンドに呼び出される関数のリストである。これらの関数はモードフック変数mode-hookの実行の直前に呼び出される。