22.1.1 Running Hooks

このセクションでは、ノーマルフックを実行するために使用される、run-hooksについて説明します。また、さまざまな種類のアブノーマルフックを実行する関数についても説明します。

Function: run-hooks &rest hookvars

この関数は、引数として1つ以上のノーマルフック変数名をとり、各フックを順に実行する。引数はそれぞれ、ノーマルフック変数であるようなシンボルであること。これらの引数は、指定された順に処理される。

フック変数の値が非nilの場合、その値は関数のリストであること。run-hooksは、すべての関数を引数なしで1つずつ呼び出す。

フック変数の値には、単一の関数(ラムダ式、またはシンボルの関数定義)も指定でき、その場合run-hooksはそれを喚び出す。しかし、この使い方は時代遅れである。

フック変数がバッファーローカルな場合、グローバル変数のかわりにそのバッファーローカル変数が使用される。しかし、そのバッファーローカル変数が要素tを含む場合は、そのグローバルフック変数も同様に実行されるだろう。

Function: run-hook-with-args hook &rest args

この関数は、hook内のすべての関数に、1つの引数argsを渡して喚び出すことにより、アブノーマルフックを実行する。

Function: run-hook-with-args-until-failure hook &rest args

この関数は、各フック関数を順に呼び出すことによりアブノーマルフック関数を実行し、それらのうち1つがnilをリターンして“失敗”したときは停止する。それぞれのフック関数は、引数にargsを渡される。この関数は、フック関数の1つが失敗して停止した場合はnil、それ以外は非nil値をリターンする。

Function: run-hook-with-args-until-success hook &rest args

この関数は、各フック関数を順に呼び出すことによりアブノーマルフック関数を実行し、それらのうち1つが非nil値をリターンして“成功”したときは停止する。それぞれのフック関数は、引数にargsを渡される。この関数は、フック関数の1つが失敗して停止した場合はその値を、それ以外はnilをリターンする。