Next: Buffer Display Action Alists, Previous: Choosing Window, Up: Displaying Buffers [Contents][Index]
アクション関数(action
function)とはバッファーを表示するウィンドウを選択するためにdisplay-buffer
が呼び出す関数です。アクション関数はbuffer
(表示するバッファー)、およびalist (アクションalist、Buffer Display Action Alistsを参照)という2つの引数を受け取ります。これらの関数は成功時にはbufferを表示するウィンドウ、失敗時にはnil
をリターンします。
以下の基本的なアクション関数がEmacsで定義されています。
この関数は選択されたウィンドウ内にbufferの表示を試みる。選択されたウィンドウがミニバッファーウィンドウや他のバッファー専用(Dedicated Windowsを参照)の場合には失敗する。alistに非nil
のinhibit-same-window
エントリーがある場合にも失敗する。
この関数はすでにbufferを表示しているウィンドウを探すことによりバッファーの表示を試みる。
alistに非nil
のinhibit-same-window
エントリーがある場合には、選択されたウィンドウは再利用に適さない。bufferをすでに表示しているウィンドウを検索するフレームセットは、アクションalistのreusable-frames
エントリーで指定できる。alistにreusable-frames
エントリーが含まれる場合には、この関数は選択されたフレームだけを検索する。
この関数が他のフレーム上のウィンドウを選択した場合には、そのフレームを可視にするとともに、alistがinhibit-switch-frame
エントリーを含んでいなければ、必要ならそのフレームを最前面に移動(raise)する。
この関数は与えられたモードですでにbufferを表示しているウィンドウを探すことによりバッファーの表示を試みる。
alistがmode
エントリーを含んでいれば、その値がメジャーモード(シンボル)、またはメジャーモードのリストを指定する。alistにmode
エントリーが含まれていなければ、かわりにbufferのカレントのメジャーモードが使用される。このように指定されたモードのいずれかから継承されたモードでバッファーを表示しているウィンドウは候補となる。
display-buffer-reuse-window
のように関数の挙動はinhibit-same-window
、reusable-frames
、inhibit-switch-frame
にたいするalistエントリーによっても制御される。
この関数は、最大もしくはもっとも長い間参照されていないウィンドウ(通常は選択されたフレームに配置されている)を分割することによりbufferの表示を試みる。これは実際には、split-window-preferred-function
(Choosing Window Optionsを参照)内で指定された関数を呼び出すことにより分割を行う。
新たなウィンドウのサイズはalistにエントリーwindow-height
とwindow-width
を与えることにより調整できる。alistにpreserve-size
エントリーが含まれていれば、Emacsは将来のリサイズ操作の間に新たなウィンドウのサイズの維持も試みる(Preserving Window Sizesを参照)。
この関数は分割可能なウィンドウがなければ失敗する。これはほとんどの場合には、分割可能なほど十分に大きいウィンドウがないために発生する。この問題にたいしてsplit-height-threshold
やsplit-width-threshold
により小さい値をセットすることが助けとなるかもしれない。選択されたフレームがフレームパラメーターunsplittable
をもつ場合にも分割は失敗する。Buffer Parametersを参照のこと。
この関数はbufferを以前に表示していたウィンドウ内にbuffer表示を試みる。alistに非nil
のinhibit-same-window
エントリーがある場合には、選択されたウィンドウは再利用に適さない。alistにreusable-frames
エントリーが含まれる場合には、その値は適正なウィンドウをどのフレームから検索するかを決定する。
alistにprevious-window
エントリーがあり、そのエントリーに指定されるウィンドウが生きていて、かつ別のバッファー専用でなければ、たとえそのウィンドウがbufferを以前表示していなくても、そのウィンドウが優先される。
この関数は既存のウィンドウを選択して、そのウィンドウ内にbufferを表示することによりバッファーの表示を試みる。すべてのウィンドウが他のバッファー専用の場合には、この関数は失敗する可能性がある(Dedicated Windowsを参照)。
この関数は選択されたウィンドウの下のウィンドウ内にbufferの表示を試みる。選択されたウィンドウの下にすでにそのバッファーを表示するウィンドウがあれば、そのウィンドウを再利用する。
そのようなウィンドウが存在しなければ、この関数は選択されたウィンドウを分割することにより新たなウィンドウを作成してbufferの表示を試みる。alistに適切なwindow-height
かwindow-width
のエントリーが含まれていれば、ウィンドウのサイズ調整も試みる(上記参照)。
選択されたウィンドウの分割に失敗、かつ選択されたウィンドウの下に別のバッファーを表示中の非専用ウィンドウがある場合には、この関数はbufferの表示にそのウィンドウの使用を試みる。
この関数は選択されたフレームの最下にあるウィンドウ内にbufferの表示を試みる。
これはフレーム最下のウィンドウまたはフレームのルートウィンドウを分割、または選択されたフレーム最下の既存ウィンドウを試みる。
この関数は新たにフレームを作成して、そのフレームのウィンドウ内にバッファーを表示する。これは実際にはpop-up-frame-function
(Choosing Window Optionsを参照)内で指定された関数を呼び出すことによりフレーム作成の処理を行う。alistがpop-up-frame-parameters
エントリーを含む場合には、その連想値(associated
value)が新たに作成されたフレームのパラメーターに追加される。
この関数は選択されたフレームの既存の子フレーム、または子フレームを新たに作成してbufferの表示を試みる(Child Framesを参照)。alistに非nil
のchild-frame-parameters
エントリーがあれば、対応する値が新たなフレームのフレームパラメーターのalistとして与えられる。デフォルトとして選択されたフレームを指定するparent-frame
パラメーターが提供される。その子フレームが別のフレームの子になる場合には、対応するエントリーをalistに追加しなければならない。
子フレームの外観はalistを通じて提供されるパラメーターに大きく依存する。子フレームが可視のままでいることを保証するために、少なくとも子フレームのサイズ(Size Parametersを参照)と位置(Position Parametersを参照)を指定して比率(ratio)を使用すること、およびkeep-ratio
パラメーター(Frame Interaction Parametersを参照)の追加を推奨する。他に考慮すべきパラメーターについてはChild Framesを参照のこと。
この関数は述語を満足するフレーム(デフォルトは選択されたフレーム以外のフレーム)を探してbufferの表示を試みる。
この関数が他のフレーム上のウィンドウを選択した場合には、そのフレームを可視にするとともに、alistがinhibit-switch-frame
エントリーを含んでいなければ、必要ならそのフレームを最前面に移動(raise)する。
alistに非nil
のframe-predicate
エントリーがあれば、その値は1つの引数(フレーム)を受け取ってそのフレームが候補なら非nil
をリターンする、デフォルトの述語を置き換える関数。
alistに非nil
のinhibit-same-window
エントリーがある場合には選択されたウィンドウは使用しない。したがって選択されたフレームに単一のウィンドウしかなければ使用しない。
この関数はalistに非nil
のallow-no-window
エントリーがあればbufferを表示せずにシンボルfail
をリターンする。この構成はアクション関数がnil
かbufferを表示するウィンドウをリターンするという慣習の唯一の例外である。alistにそのようなallow-no-window
エントリーがなければ、この関数はnil
をリターンする。
この関数がfail
をリターンした場合には、display-buffer
はそれ委譲のディスプレイアクションをスキップして即座にnil
をリターンする。この関数がnil
をリターンした場合には、display-buffer
はもしあれば次のディスプレイアクションを継続する。
display-buffer
の呼び出し側が非nil
のallow-no-window
エントリーを指定した場合には、nil
のリターン値の処理も可能とみなされる。
他の2つのアクション関数display-buffer-in-side-window
とdisplay-buffer-in-atom-window
については、それぞれ適正なセクションで説明します(Displaying Buffers in Side WindowsとAtomic Windowsを参照)。