Next: バッファー表示の追加オプション, Previous: バッファー表示用のアクション関数, Up: 適切なウィンドウへのバッファーの表示 [Contents][Index]
アクションalist(action
alist)とはアクション関数が認識可能な事前定義されたシンボルと、それに応じてそれらの関数が解釈することを意図した値をマップする連想リストです。各呼び出しにおいてdisplay-bufferは新たなアクションalist(空の場合もある)を作成して、呼び出すすべてのアクション関数にそのリスト全体を渡します。
仕様によりアクション関数はアクションalist全体を自由に解釈できます。実際のところallow-no-windowやprevious-windowのようないくつかのエントリーはいくつかのアクション関数にとってのみ意味があり、他のアクション関数では無視されます。それ以外のinhibit-same-windowやwindow-parametersのようなエントリーは、アプシケーションプログラムや外部パッケージから提供されるものも含めて、ほとんどのアクション関数がしたがいます。
前のサブセクションでは、個別のアクション関数がアクションエントリーを処理する方法の詳細を説明しました。ここでは既知のアクションalistエントリーに対応するすべてのシンボル、およびそれらの値とそれらを認識するアクション関数(バッファー表示用のアクション関数を参照)とともに示すリファレンスリストを提供します。このリストにおいて用語“バッファー”はdisplay-bufferが表示しようとするバッファー、“値”はそのエントリーの値を意味しています。
inhibit-same-window値が非nilなら、バッファーの表示に選択されたウィンドウを使用してはならないことを告げる。既存のウィンドウを(再)使用するすべてのアクション関数は、このエントリーにしたがう必要がある。
previous-window値には以前にバッファーを表示した可能性のあるウィンドウを指定しなければならない。そのようなウィンドウがまだ生きていて他のバッファー専用でなれば、display-buffer-in-previous-windowはそのウィンドウを優先する。
mode値はメジャーモードかメジャーモードのリスト。このエントリーが指定する値がウィンドウのバッファーのメジャーモードにマッチすれば、display-buffer-reuse-mode-windowは常にそのウィンドウを再利用する。これ以外のアクション関数はこのエントリーを無視する。
frame-predicate値はそのフレームがバッファーを表示する候補なら非nilをリターンする単一の引数(フレーム)を受け取る関数でなければならない。このエントリーはdisplay-buffer-use-some-frameが使用する。
reusable-frames値はバッファーをすでに表示していたことにより再利用可能なウィンドウを検索するためのフレームセットを指定する。以下をセット可能:
nilは選択されたフレーム(実際にはミニバッファーフレーム以外の最後に使用されたフレーム)上のウィンドウだけを考慮することを意味する。
visibleはすべての可視フレーム上のウィンドウを考慮することを意味する。
tはすべてのフレームのウィンドウを考慮することを意味する(ツールチップフレームがリターンされるかもしれないので、この値が使用に耐えることは稀であることに注意)。
nilの意味はnext-windowにたいするall-frames引数の場合の意味とは若干異なることに注意(ウィンドウのサイクル順を参照)。
これの主要クライアントはdisplay-buffer-reuse-windowだが、ウィンドウの再利用を試みる他のすべてのアクション関数も同様に影響を受ける。display-buffer-in-previous-windowはバッファーを以前に表示していたウィンドウを別フレーム上で検索する際にこれを参照する。
inhibit-switch-frame非nil値の場合には、display-bufferにより選択されたウィンドウがすでに表示されていれば別のフレームのraiseや選択を抑制する。これにより主に影響を受けるのはdisplay-buffer-use-some-frameとdisplay-buffer-reuse-window。理想的にはdisplay-buffer-pop-up-frameも同様に影響を受けるべきだが、ウィンドウマネージャーがこれに準拠する保証はない。
window-parameters値は選択したウィンドウに与えるウィンドウパラメーターのalist。ウィンドウを選択するすべてのアクション関数は、このエントリーを処理する必要がある。
window-min-width値は使用するウィンドウの最小幅をフレームの正準列で指定する。特別な値full-widthは、そのフレームにおいて左右に他のウィンドウがないウィンドウを選択することを意味する。
このエントリーに影響を受けるのは現在のところdisplay-buffer-use-some-window、およびdisplay-buffer-use-least-recent-window
(最近使用されていないウィンドウのリターンにおいてこのエントリーを満足しないようなウィンドウのリターンをより厳格に回避する)。
このようなエントリーを単独で提供しても、ウィンドウがその値で指定した幅になるとは限らないことに注意。既存ウィンドウを実際にリサイズしたり新たなウィンドウの幅を指定した値にするためには、同様にこの値を指定するwindow-widthエントリーを提供する必要がある。しかしこのようなwindow-widthエントリーでまったく異なる値を指定したり、ウィンドウ幅をバッファーにフィットするように要請することができる。そのような場合にはwindow-width使用するウィンドウの最小幅にたいする保証を与える。
window-min-height値は使用するウィンドウの最小高さをフレームの正準行で指定する。特別な値full-heightは、そのフレームにおいて上下に他のウィンドウがないウィンドウを選択することを意味する。
このエントリーは現在のところdisplay-buffer-below-selected
(このエントリーで指定された高さより低いウィンドウは使用しない)に影響を与える。更にdisplay-buffer-use-some-window、およびdisplay-buffer-use-least-recent-window
(最近使用されていないウィンドウのリターンにおいてこの制約を満足しないようなウィンドウのリターンをより厳格に回避する)にも影響を与える。
このようなエントリーを単独で提供しても、ウィンドウがその値で指定した高さになるとは限らないことに注意。既存ウィンドウを実際にリサイズしたり新たなウィンドウの高さを指定した値にするためには、同様にこの値を指定するwindow-heightエントリーを提供する必要がある。しかしこのようなwindow-heightエントリーでまったく異なる値を指定したり、ウィンドウ高さをバッファーにフィットするように要請することができる。そのような場合にはwindow-min-height使用するウィンドウの最小高さにたいする保証を与える。
window-height値は選択したウィンドウの高さを調節するかとその方法を指定する。以下のいずれか:
nilは選択したウィンドウの高さを変更しないことを意味する。
body-lines、CDRが選択されたウィンドウのボディー高さをフレーム行数で指定する整数であるようなコンスセル。
fit-window-to-bufferとshrink-window-if-larger-than-buffer。ウィンドウのリサイズを参照のこと。
慣例により選択したウィンドウの高さは、そのウィンドウが垂直コンビネーション(ウィンドウとフレームを参照)の一部であり、他の無関係のウィンドウの高さの変更を避ける場合のみ調整される。さらにこのエントリーはこのリストの後に指定する特定の条件下でのみ処理される必要がある。
window-widthこれは上述のwindow-heightと同様だが、かわりに選択したウィンドウの幅の調節に使用される。値は以下のいずれか:
nilは選択したウィンドウの幅を変更しないことを意味する。
body-columns、CDRが選択されたウィンドウのボディー幅をフレーム列数で指定する整数であるようなコンスセル。
window-sizeこれは前の2つを組み合わせたエントリーであり、選択したウィンドウの高さと幅の両方の調節に用いることができる。他のウィンドウに影響を与えずにウィンドウをリサイズできる方向は1つだけなので、window-sizeはフレーム上に単独で表示されるウィンドウのサイズのセットアップでのみ効果的である。値は以下のいずれか:
nilは選択したウィンドウのサイズを変更しないことを意味する。
body-chars、CDRが2つの整数からなるコンスセル(選択したウィンドウの望ましい幅と高さをフレームの行数と列数で指定)であるようなコンスセル。これに応じてフレームのサイズを調節する効果がある。
このエントリーはこのリストのすぐ下で指定されている特定の条件の下で処理される必要がある。
dedicatedこのようなエントリーが非nilなら、display-bufferは作成するすべてのウィンドウをそのバッファー専用であるとマークする(専用のウィンドウを参照)。これは最初の引数に選択したウィンドウ、2つ目の引数にエントリーの値を指定してset-window-dedicated-pを呼び出すことにより行われる。サイドウィンドウはデフォルトでは値sideで専用となる(サイドウィンドウのオプションと関数を参照)。
preserve-sizeこのようなエントリーが非nilなら、選択したウィンドウのサイズを維持するようにEmacsに指示する(ウィンドウサイズの保持を参照)。値は(t . nil) (ウィンドウの幅を維持)、(nil . t)
(高さを維持)、または(t . t)
(幅と高さの両方を維持)のいずれか。このエントリーはこのリストの後に指定する特定の条件下でのみ処理される必要がある。
lru-frames値はバッファーの表示に使用可能なウィンドウを検索するフレームを指定する。display-buffer-use-some-window、およびdisplay-buffer-use-least-recent-windowが最近使用されていない別のバッファーを表示中のウィンドウを探す際に参照される。値は上述のreusable-framesエントリーと同様。
lru-time値には使用時間(use time)の指定が求められる(ウィンドウの選択を参照)。このエントリーはdisplay-buffer-use-some-window、およびdisplay-buffer-use-least-recent-windowが最近使用されていない別のバッファーを表示中のウィンドウを探す際に参照される。これらの関数はバッファーの表示において、このオプションで指定された値より長い使用時間をもつウィンドウを勘定に入れない。
bump-use-timeこのエントリーが非nilなら、display-bufferが使用するウィンドウの使用時間(ウィンドウの選択を参照)を増加させる。これにより後刻display-buffer-use-some-windowやdisplay-buffer-use-least-recent-windowのようなアクション関数が別のバッファーを表示する際に、このウィンドウが使用されることが回避される筈である。
このエントリーの使用とアクション関数display-buffer-use-least-recent-windowの使用の間には僅かな違いが存在する。後者の呼び出しは、この関数がバッファーの表示に使用するウィンドウの使用時間だけを増加させることを意味する。ここで説明しているエントリーには、display-bufferがバッファーの表示に使用するすべてのウィンドウの使用時間を増加させるという意味をもつ。
pop-up-frame-parametersこの値は新たにフレームが作成された場合に与えるフレームパラメーターのalist。display-buffer-pop-up-frameがけが参照する。
pop-up-framesこの値はdisplay-bufferが新たにフレームを作成してバッファーを表示できるかどうかを制御する。pop-up-frames変数と同じ意味をもつが、指定された場合には変数よりこのエントリーが優先される。これは主に選択されたフレームにユーザーが維持したい特定のバッファーにたいして、変数の非nil値をオーバーライドすることを意図したエントリーである。
parent-frame値は子フレームにバッファーを表示時に使用する親フレームを指定する。このエントリーを使用するのはdisplay-buffer-in-child-frameのみ。
child-frame-parameters値は子フレームにバッファー表示時に使用するフレームパラメーターのalistを指定する。このエントリーを使用するのはdisplay-buffer-in-child-frameのみ。
side値はバッファーを表示する新たなウィンドウを、フレームやバッファーのどのサイドに作成するかを示す。このエントリーは新たなサイドウィンドウをフレームのどのサイドに配置するかを示すためにdisplay-buffer-in-side-windowが使用する(サイドウィンドウへのバッファーの表示を参照)。さらに新たなサイドウィンドウを既存ウィンドウのどのサイドに配置するかを示すためにdisplay-buffer-in-atom-windowにも使用される(アトミックウィンドウを参照)。
slot値が非nilならバッファーを表示するサイドウィンドウのスロットを指定する。このエントリーを使用するのはdisplay-buffer-in-side-windowのみ。
directionこの値はwindowエントリーとともに、display-buffer-in-directionがバッファーを表示するウィンドウ位置を決定するための方向を指定する。
window値はdisplay-bufferで選択されたウィンドウと何らかの関連があるウィンドウを指定する。このエントリーは現在のところ新たなウィンドウが作成されるサイドのウィンドウを示すためにdisplay-buffer-in-atom-windowが使用する。これは結果のウィンドウが出現する側の参照ウィンドウを指定するためにdisplay-buffer-in-directionも使用する。
allow-no-window値が非nilならdisplay-bufferは必ずしもバッファーを表示する必要はなく、呼び出し側はそれを受け入れる準備がある。display-bufferの任意の呼び出し手がバッファーを表示するウィンドウが存在しないケースを処理できる保証がないので、、このエントリーはユーザーのカスタマイゼーションを意図したものではない。このエントリーを考慮するアクション関数はdisplay-buffer-no-windowのみ。
some-window値がnilまたはlruなら、display-buffer-use-some-windowは幅がフルではないような選択されたウィンドウと別フレームにあるウィンドウを除外して、もっとも最近使用されていないウィンドウを優先する。値がmruなら選択されたウィンドウと選択されたフレーム以外のウィンドウを除外して、もっとも最近使用されたウィンドウを優先する。値が関数の場合にはバッファーとalistという2つの引数で呼び出されて、バッファーを表示するウィンドウをリターンすること。
body-function値は1つの引数(表示されるウィンドウ)を受け取る関数でなければならない。この関数は表示されるウィンドウのサイズに応じて、表示されるウィンドウのbodyを何らかのコンテンツで充填するために使用できるかもしれない。これはバッファー表示の後、かつ挿入したコンテンツに適合するようにリサイズを適用できるwindow-height、window-width、preserve-sizeの開始の前に呼び出される。
post-command-select-window値が非nilならフックpost-command-hook (コマンドループの概要を参照)によって実行されたカレントコマンドの後に、display-bufferが表示したバッファーを選択する。値がnilの場合にはpop-to-bufferのような関数が選択したバッファーは選択を解除、そのコマンドでその後にどのウィンドウが選択されたかとは無関係に、その関数の呼び出し前に選択されていたウィンドウが選択されたままとなる。
categorydisplay-bufferの呼び出し側がaction引数にalistのエントリーとして(category
.
symbol)を渡した場合には、display-buffer-alistエントリーのコンディション部分と同じカテゴリーを用いて表示されるバッファーをマッチできる。
慣例によりエントリーwindow-height、window-width、preserve-sizeは選択したウィンドウのバッファーのセットアップ後、かつそのウィンドウが以前に他のバッファーを表示していない場合のみ適用されます。後者はより正確にはカレントのdisplay-buffer呼び出しによりウィンドウが作成されたか、以前にそのバッファーを表示するためにdisplay-bufferによりウィンドウが作成されて、カレントのdisplay-buffer呼び出しによる再利用まで他のバッファーの表示に使用されたことがないことを意味します。
window-height、window-width、あるいはwindow-sizeのエントリーが何も指定されていない場合でも、そのバッファーが一時的なバッファーであり、かつtemp-buffer-resize-mode有効ならウィンドウは依然としてリサイズされる可能性があります。一時的な表示を参照してください。このような場合には特定のバッファーやdisplay-buffer呼び出しにたいするtemp-buffer-resize-modeのデフォルトの挙動の抑制やオーバーライドにwindow-height、window-width、あるいはwindow-sizeといったエントリーのCDRを用いることができます。
Next: バッファー表示の追加オプション, Previous: バッファー表示用のアクション関数, Up: 適切なウィンドウへのバッファーの表示 [Contents][Index]