13.12.2 名前つき関数にたいするアドバイス

アドバイスは名前つき関数やマクロにたいして使用するのが一般的な使い方です。これは単にadd-functionを使用して以下のように行うことができます:

(add-function :around (symbol-function 'fun) #'his-tracing-function)

しかしかわりにadvice-addとadvice-removeを使うべきです。この異なる関数セットは名前つき関数に適用されるアドバイスを操作するためのもので、add-functionと比較して以下の追加機能があります。まずこれらはマクロとオートロードされた関数を扱う方法を知っています。次にdescribe-functionにたいして追加されたアドバイスと同様に、元のドキュメント文字列を維持します。さらに関数が定義される前でも、アドバイスの追加と削除ができます。

既存の関数全体を再定義せずに既存の呼び出しを変更するために、advice-addが有用になります。しかしその関数の既存の呼び出し元は古い振る舞いを前提としているかもしれず、アドバイスによりその振る舞いが変更されたときに正しく機能しないかもしれないので、バグの原因になり得ます。デバッグを行う人はその関数がアドバイスにより変更されたことに気づかなかったり失念していたりすると、アドバイスはデバッグでの混乱の原因になる可能性もあります。

Note that the problems are not due to advice per se, but to the act of modifying a named function. It is even more problematic to modify a named function via lower-level primitives like fset, defalias, or cl-letf. From that point of view, advice is the better way to modify a named function because it keeps track of the modifications, so they can be listed and undone.

Modifying a named function should be reserved for the cases where you cannot modify Emacs’ behavior in any other way. If it is possible to do the same thing via a hook, that is preferable (see フック). If you simply want to change what a particular key does, it may be better to write a new command, and remap the old command’s key bindings to the new one (see コマンドのリマップ).

他の人が使用するリリース用のコードを記述する場合には、アドバイスを含めることを避けるよう試みてください。アドバイスしたい関数にその処理を行うフックがなければ、適切なフックの追加についてEmacs開発者に相談してください。特にEmacs自身のソースファイルでは、Emacs関数にアドバイスを配置するべきではありません(現在のところこの慣習にたいするいくつかの例外があるが修正する予定)。一般的にはfooにアドバイスとしてbarを配置するよりも、foo内に新たなフックを作成してbarにそのフックを使用させるほうが明快です。

スペシャルフォーム(スペシャルフォームを参照)はアドバイスできませんが、マクロは関数と同じ方法でアドバイスできます。もちろんこれはすでにマクロ展開されたコードには影響しないため、マクロ展開前にアドバイスが確実にインストールされる必要があります。

プリミティブ(関数とは?を参照)にアドバイスするのは可能ですが、2つの理由により通常は行うべきではありません。1つ目の理由はいくつかのプリミティブがアドバイスのメカニズム内で使用されているため、それらにたいしてアドバイスを行うと無限再帰が発生するからです。2つ目の理由は多くのプリミティブがCから直接呼び出されていて、そのような呼び出しはアドバイスを無視するからです。したがってプリミティブにたいしてアドバイスの使用を控えることにより、ある呼び出しはアドバイスにしたがい(Lispコードから呼びだされたため)、他の呼び出しではアドバイスにしたがわない(Cコードから呼び出されたため)という混乱した状況を解決できます。

Macro: define-advice symbol (where lambda-list &optional name depth) &rest body ¶

このマクロはアドバイスを定義してsymbolという名前の関数に追加する。nameがnilかsymbol@nameという名前の関数ならアドバイスは無名関数。他の引数についての説明はadvice-addを参照のこと。

Function: advice-add symbol where function &optional props ¶

名前つき関数symbolにアドバイスfunctionを追加する。whereとpropsはadd-function(アドバイスを操作するためのプリミティブを参照)のときと同じ意味をもつ。

Function: advice-remove symbol function ¶

名前つき関数symbolからアドバイスfunctionを取り除く。functionにアドバイスのnameを指定することもできる。

Function: advice-member-p function symbol ¶

名前つき関数symbol内にすでにアドバイスfunctionがあれば非nilをリターンする。functionにアドバイスのnameを指定することもできる。

Function: advice-mapc function symbol ¶

名前つき関数symbolにすでに追加されたすべての関数にたいしてfunctionを呼び出す。functionはアドバイス関数とそのプロパティという2つの引数で呼び出される。