Next: Reading File Names, Previous: Completion Commands, Up: Completion [Contents][Index]
このセクションでは、特定の種類の名前を補完つきで読み取る便利な高レベル関数を説明します。
ほとんどの場合、Lisp関数の中盤でこれらの関数を呼び出すべきではありません。可能なときは、interactive指定の内部で呼び出し、ミニバッファーのすべての入力をコマンドの引数読み取りの一部にします。Defining Commandsを参照してください。
この関数はバッファーの名前を読み取り、それを文字列でリターンする。引数defaultは、ミニバッファーが空の状態でユーザーがexitした場合にリターンされるデフォルト名として使用される。非nilの場合は文字列、文字列リスト、またはバッファーを指定する。リストの場合は、リストの先頭の要素がデフォルト値になる。デフォルト値はプロンプトに示されるが、初期入力としてミニバッファーには挿入されない。
引数promptは、コロンかスペースで終わる文字列である。defaultが非nilの場合、この関数はデフォルト値つきでミニバッファーから読み取る際の慣習にしたがい、コロンの前のpromptの中にこれを挿入する。
オプション引数require-matchは、completing-readのときと同じ。Minibuffer Completionを参照のこと。
以下の例で、ユーザーが‘minibuffer.t’とエンターしてから、RETをタイプする。引数require-matchはtであり、与えられた入力で始まるバッファー名は‘minibuffer.texi’だけなので、その名前が値となる。
(read-buffer "Buffer name: " "foo" t)
;; 前の式を評価した後、 ;; 空のミニバッファーに ;; 以下のプロンプトが表示される:
---------- Buffer: Minibuffer ---------- Buffer name (default foo): ∗ ---------- Buffer: Minibuffer ----------
;; ユーザーがminibuffer.t RETとタイプする。
⇒ "minibuffer.texi"
この変数が非nilの場合は、バッファー名を読み取る関数である。read-bufferは通常行うことを行うかわりに、read-bufferと同じ引数でその関数を呼び出す。
この変数が非non-nilの場合は、補完の処理においてread-bufferは大文字小文字を無視する。
この関数はコマンドの名前を読み取り、Lispシンボルとしてそれをリターンする。引数promptは、read-from-minibufferで使用される場合と同じ。それが何であれcommandpがtをリターンすればコマンドであり、コマンド名とはcommandpがtをリターンするシンボルだということを思い出してほしい。Interactive Callを参照のこと。
引数defaultは、ユーザーがnull入力をエンターした場合に何をリターンするか指定する。シンボル、文字列、文字列リストを指定できる。文字列の場合、read-commandはリターンする前にそれをinternする。リストの場合、read-commandはリストの最初の要素をinternする。defaultがnilの場合は、デフォルトが指定されなかったことを意味する。その場合もしユーザーがnull入力をエンターすると、リターン値は(intern
"")、つまり名前が空文字列のシンボルとなる。
(read-command "Command name? ")
;; 前の式を評価した後に、 ;; 空のミニバッファーに以下のプロンプトが表示される:
---------- Buffer: Minibuffer ---------- Command name? ---------- Buffer: Minibuffer ----------
ユーザーがforward-c RETとタイプした場合、この関数はforward-charをリターンする。
read-command関数は、completing-readの簡略化されたインターフェイスである。実在するLisp変数のセットを補完するために変数obarrayを、コマンド名だけを受け入れるために述語commandpを使用する。
(read-command prompt)
≡
(intern (completing-read prompt obarray
'commandp t nil))
この変数はカスタマイズ可能な変数の名前を読み取り、それをシンボルとしてリターンする。引数の形式はread-commandの引数と同じ。この関数は、commandpのかわりにcustom-variable-pを述語に使用する点を除き、read-commandと同様に振る舞う。
この関数はカラー指定(カラー名、または#RRRGGGBBBのような形式のRGB16進値)の文字列を読み取る。これはプロンプトにprompt(デフォルトは"Color
(name or #RGB
triplet):")を表示して、カラー名にたいする補完を提供する(16進RGB値は補完しない)。標準的なカラー名に加えて、補完候補にはポイント位置のフォアグラウンドカラーとバックグラウンドカラーが含まれる。
Valid RGB values are described in Color Names.
この関数のリターン値は、ミニバッファー内でユーザーがタイプした文字列である。しかし、インタラクティブに呼び出されたとき、またはオプション引数convertが非nilの場合は、入力されたカラー名のかわりに、それに対応するRGB値文字列をリターンする。この関数は、入力に有効なカラー指定を求める。allow-emptyが非nilでユーザーがnull入力をエンターした場合は、空のカラー名が許される。
インタラクティブに呼び出されたとき、またはdisplayが非nilの場合には、エコーエリアにもリターン値が表示される。
User-Chosen Coding Systemsの関数read-coding-systemとread-non-nil-coding-system、およびInput Methodsのread-input-method-nameも参照のこと。