Next: , Previous: , Up: Defining Commands   [Contents][Index]


20.2.2 interactiveにたいするコード文字

ここで説明されているコード文字には、以下で定義されるいくつかのキーワードが含まれています:

Completion

補完を提供する。TABSPCRETcompleting-read (Completionを参照)を使用して引数を読み取って名前の補完を行う。?で利用可能な補完リストを表示する。

Existing

既存オブジェクトの名前を要求する。無効な名前は受け付けられない。カレント入力が有効でなければ、ミニバッファーをexitするコマンドはexitしない。

Default

ユーザーがテキストを何もエンターしなければ、ある種のデフォルト値が使用される。デフォルトはコード文字に依存する。

No I/O

このコード文字は入力を読み取らずに引数を計算する。したがってプロンプト文字列を使用せず、与えられたプロンプト文字列は無視される。

たとえそのコード文字がプロンプト文字列を使用しなくても、それが文字列内で最後のコード文字でなければ、その後に改行を付加しなければならない。

Prompt

コード文字の直後にプロンプトが続く。プロンプトの終端は文字列の終端、または改行。

Special

このコード文字はインタラクティブ文字列の先頭にあるときのみ意味があり、プロンプトと改行を要求しない。単一の独立した文字。

以下はinteractiveで使用されるコード文字です:

*

カレントバッファーが読み取り専用ならエラーをシグナルする。[Special]

@

このコマンドを呼び出したキーシーケンス内の最初のマウスイベントに関連するウィンドウを選択する。[Special]

^

シフト転換を通じてコマンドが呼び出された場合はコマンドを実行する前に、マークをセットして一時的にリージョンをアクティブにするか、すでにリージョンがアクティブならリージョンを拡張する。シフト転換を通じずにコマンドが呼び出されて、リージョンが一時的にアクティブならコマンドを実行する前にそのリージョンを非アクティブにする。[Special]

a

関数名(fboundpを満足するシンボル)。[Existing]、[Completion]、[Prompt]

b

既存バッファーの名前。デフォルトではカレントバッファー(Buffersを参照)の名前を使用する。[Existing]、[Completion]、[Default]、[Prompt]

B

バッファー名。そのバッファーが存在する必要はない。デフォルトではカレントバッファーではなくもっとも最近使用されたバッファーの名前を使用する。[Completion]、[Default]、[Prompt]

c

文字。カーソルはエコーエリアに移動しない。[Prompt]

C

コマンド名(commandpを満足するシンボル)。[Existing]、[Completion]、[Prompt]

d

ポイント位置の整数(Pointを参照)。[No I/O]

D

ディレクトリー名。デフォルトはカレントバッファーのカレントのデフォルトディレクトリーdefault-directory (File Name Expansionを参照)。[Existing]、[Completion]、[Default]、[Prompt]

e

そのコマンドを呼び出したキーシーケンス内の1つ目か2つ目の非キーボードイベント。より正確には、‘e’はリストとしてイベントを取得するので、リスト内のデータを調べることができる。Input Eventsを参照のこと。[No I/O]

e’はマウスイベント、および特別なシステムイベント(Misc Eventsを参照)にたいして使用する。コマンドが受け取るイベントリストは、そのイベントに依存する。Input Eventsではそれぞれのイベントのリスト形式を、対応するサブセクションでそれぞれ説明しているので参されたい。

1つのコマンドのinteractive仕様の中で‘e’を複数回使用できる。そのコマンドを呼び出したキーシーケンスがイベントn(リスト)をもつなら、‘e’のn番目がそのイベントを提供する。フンクションキーやASCII文字のようなリスト以外のイベントは、‘e’に関連するイベントとしてカウントされない。

f

既存ファイルのファイル名(File Namesを参照)。デフォルトのディレクトリーはdefault-directory。[Existing]、[Completion]、[Default]、[Prompt]

F

ファイル名。ファイルが存在している必要はない。[Completion]、[Default]、[Prompt]

G

ファイル名。ファイルが存在している必要はない。ユーザーがディレクトリー名だけをエンターしたら値はそのディレクトリー名となり、そのディレクトリー名にファイル名は追加されない。[Completion]、[Default]、[Prompt]

i

無関係な引数。このコード文字は引数値として常にnilを与える。[No I/O]

k

キーシーケンス(Key Sequencesを参照)。これはカレントキーマップ内でコマンド(または未定義のコマンド)が見つかるまで、イベントを読み取り続ける。キーシーケンス引数は文字列かベクターで表される。カーソルはエコーエリアに移動しない。[Prompt]

k’が(マウスの)down-eventで終わるキーシーケンスを読み取ると、後続の(マウスの)up-eventも読み取ってそれを廃棄する。コード文字‘U’によりup-eventへのアクセスを得られる。

この種の入力はdescribe-keyglobal-set-keyのようなコマンドにより使用される。

K

キーシーケンス。その定義は変更されることを意図している。これは‘k’と同じように機能するが、キーシーケンス内の最後の入力イベントにたいして、通常は(必要なら)使用される未定義キーから定義済みキーへの変換を抑制する。

m

マーク位置の整数。[No I/O]

M

任意のテキスト。ミニバッファー内でカレントバッファーの入力メソッド(Input Methods in The GNU Emacs Manualを参照)を使用して読み取りを行い、それを文字列でリターンする。[Prompt]

n

数字。ミニバッファーで読み取られる。入力が数字でなければユーザーは再試行する必要がある。‘n’は決してプレフィクス引数を使用しない。[Prompt]

N

数引数(numeric prefix argument)。ただしプレフィクス引数がなければnのように数字を読み取る。値は常に数字。Prefix Command Argumentsを参照のこと。[Prompt]

p

数引数(小文字の‘p’であることに注意)。[No I/O]

P

rawプレフィクス引数(大文字の‘P’であることに注意)。[No I/O]

r

2つの数引数(ポイントとマーク)。小さいほうが先。これは1つではなく連続する2つの引数を指定する唯一のコード文字である。コマンド呼び出し時にカレントなバッファーにマークがセットされていなければエラーをシグナルする。[No I/O]

s

任意のテキスト。ミニバッファー内で読み取りを行って文字列としてリターンする(Text from Minibufferを参照)。C-jRETで入力を終端する(これらの文字を入力に含めるためにC-qを使用できる)。[Prompt]

S

intern済みのシンボル。名前はミニバッファー内で読み取られる。C-jRETで入力を終端する。ここでは通常はシンボルを終端するその他の文字(たとえば空白文字、丸カッコ、角カッコ)では終端されない。[Prompt]

U

キーシーケンスかnil。‘k’(または‘K’)が読み取った後に、(もしあれば)捨てられる(マウスの)up-eventを取得するために、引数‘k’(または‘K’)の後で使用され得る。捨てられたup-eventが存在しなければ、‘U’は引数としてnilを提供する。[No I/O]

v

ユーザーオプションとして宣言された変数(述語custom-variable-pを満足する)。これはread-variableを使用して変数を読み取る。Definition of read-variableを参照のこと。[Existing]、[Completion]、[Prompt]

x

Lispオブジェクト。そのオブジェクトの入力構文により指定され、C-jRETで終端される。オブジェクトは評価されない。Object from Minibufferを参照のこと。[Prompt]

X

Lispフォームの値。‘X’は‘x’のように読み取りを行いフォームを評価して、その値がコマンドの引数になる。[Prompt]

z

コーディングシステム名(シンボル)。ユーザーがnull入力をエンターすると、引数値はnilになる。Coding Systemsを参照のこと。[Completion]、[Existing]、[Prompt]

Z

コマンドにプレフィクス引数があればコーディングシステム名。プレフィクス引数がなければ‘Z’は引数値としてnilを提供する。[Completion]、[Existing]、[Prompt]