Next: Advice Combinators, Previous: Core Advising Primitives, Up: Advising Functions [Contents][Index]
アドバイスは名前つき関数やマクロにたいして使用するのが一般的な使い方です。これは単にadd-function
を使用して以下のように行うことができます:
(add-function :around (symbol-function 'fun) #'his-tracing-function)
しかしかわりにadvice-add
とadvice-remove
を使うべきです。この異なる関数セットは名前つき関数に適用されるアドバイスを操作するためのもので、add-function
と比較して以下の追加機能があります。まずこれらはマクロとオートロードされた関数を扱う方法を知っています。次にdescribe-function
にたいして追加されたアドバイスと同様に、元のドキュメント文字列を維持します。さらに関数が定義される前でも、アドバイスの追加と削除ができます。
既存の関数全体を再定義せずに既存の呼び出しを変更するために、advice-add
が有用になります。しかしその関数の既存の呼び出し元は古い振る舞いを前提としているかもしれず、アドバイスによりその振る舞いが変更されたときに正しく機能しないかもしれないので、これはソー内スのバグにもなり得ます。アドバイスはデバッグを難しくする可能性もあります。デバッグを行う人はその関数がアドバイスにより変更されたことに気づかなかったり、失念しているかもしれません。
これらの理由により、他の方法で関数の振る舞いを変更できない場合に備えるために、アドバイスの使用は控えるべきです。フックを通じて同じことが行えるならフック(Hooksを参照)の使用が望ましい方法です。特定のキーが行う何かを変更したいだけなら、新しいコマンドを記述して、古いコマンドのキーバインドを新しいコマンドにリマップ(Remapping Commandsを参照)するのが、おそらくより優れた方法です。
他の人が使用するリリース用のコードを記述する場合には、アドバイスを含めることを避けるよう試みてください。アドバイスしたい関数にその処理を行うフックがなければ、適切なフックの追加についてEmacs開発者に相談してください。特にEmacs自身のソースファイルでは、Emacs関数にアドバイスを配置するべきではありません(現在のところこの慣習にたいするいくつかの例外があるが修正する予定)。一般的にはfoo
にアドバイスとしてbar
を配置するよりも、foo
内に新たなフックを作成してbar
にそのフックを使用させるほうが明快です。
スペシャルフォーム(Special Formsを参照)はアドバイスできませんが、マクロは関数と同じ方法でアドバイスできます。もちろんこれはすでにマクロ展開されたコードには影響しないため、マクロ展開前にアドバイスが確実にインストールされる必要があります。
プリミティブ(What Is a Functionを参照)にアドバイスするのは可能ですが、2つの理由により通常は行うべきではありません。1つ目の理由はいくつかのプリミティブがアドバイスのメカニズム内で使用されているため、それらにたいしてアドバイスを行うと無限再帰が発生するからです。2つ目の理由は多くのプリミティブがCから直接呼び出されていて、そのような呼び出しはアドバイスを無視するからです。したがってプリミティブにたいしてアドバイスの使用を控えることにより、ある呼び出しはアドバイスにしたがい(Lispコードから呼びだされたため)、他の呼び出しではアドバイスにしたがわない(Cコードから呼び出されたため)という混乱した状況を解決できます。
このマクロはアドバイスを定義してsymbolという名前の関数に追加する。nameがnil
かsymbol@name
という名前の関数ならアドバイスは無名関数。他の引数についての説明はadvice-add
を参照のこと。
名前つき関数symbolにアドバイスfunctionを追加する。whereとpropsはadd-function
(Core Advising Primitivesを参照)のときと同じ意味をもつ。
名前つき関数symbolからアドバイスfunctionを取り除く。functionにアドバイスのname
を指定することもできる。
名前つき関数symbol内にすでにアドバイスfunctionがあれば非nil
をリターンする。functionにアドバイスのname
を指定することもできる。
名前つき関数symbolにすでに追加されたすべての関数にたいしてfunctionを呼び出す。functionはアドバイス関数とそのプロパティーという2つの引数で呼び出される。