Vim Hack: 組み込み関数の追加手順

Vimスクリプトの組み込み関数を追加する手順は次の通り:

1. src/eval.cに組み込み関数に対応するCの関数を追加する。なお、Vimレベルでの名前がgettabvar()ならばCレベルでの名前はf_gettabvar()とすることが望ましい。
2. src/eval.cのfunctions[]に追加したい関数のエントリー(Vimレベルでの関数名、引数の最小個数、引数の最大個数、Cレベルでの関数へのポインタ)を追加する。なお、エントリーは関数名についての辞書式順で適切な位置に記述しなければならない。
3. src/eval.cのfunctions[]より前に、追加したCレベルの関数のプロトタイプ宣言を追加する。
4. runtime/doc/eval.txtの内容を適宜追加する。

なお、ファイル内の各内容は基本的に辞書式順に並べられているため、適切な位置に記述することが望ましい。

組み込み関数を追加する上での注意点:

• Cレベルでの関数のプロトタイプ宣言はどれも同じ。
• 引数はargvarsとrettvの2つ。前者はVimレベルでの関数の引数の配列への参照。後者はVimレベルでの関数の戻り値を格納する場所へのポインタ。
• 引数の個数が可変である場合、実際に与えられた引数の個数をnとするとargvars[n].v_type == VAR_UNKNOWNであるため、これで判定する。
• 何らかの変更を加える関数の場合、'secure'やrestricted modeでは動作しないよう、チェックを行う。これはif (check_restricted() || check_secure()) return;のように簡単にできる。