interactive ¶ のコード文字以下に示すコード文字の説明には、いくつかのキーワードが含まれており、ここでの定義は以下の通りです。
補完を行います。TAB、SPC、およびRETは、引数がcompleting-readを用いて読み取られるため、名前の補完を行います(Completionを参照)。?は、補完候補の一覧を表示します。
既存のオブジェクト名を指定してください。無効な名前は受け付けられません。現在の入力が無効な場合、ミニバッファを終了するためのコマンドは機能しません。
ユーザーがミニバッファにテキストを入力しなかった場合は、何らかのデフォルト値が使用されます。このデフォルト値はコード文字によって異なります。
このコードレターは、入力を一切読み取らずに引数を計算します。そのため、プロンプト文字列は使用されず、指定したプロンプト文字列は無視されます。
コード文字にプロンプト文字列が使用されていない場合でも、それが文字列内の最後のコード文字でないときは、その後に改行を記述する必要があります。
コード文字の直後にプロンプトが続きます。プロンプトは、文字列の末尾または改行のいずれかで終わります。
このコード文字は、インタラクティブ文字列の先頭においてのみ意味を持ち、プロンプトや改行を検出することはありません。単一の独立した文字です。
interactive で使用するコード文字の説明は以下の通りです。
現在のバッファが読み取り専用である場合にエラーを発生させます。特殊。なお、多くのEmacsプリミティブでは、コマンドのインタラクティブ仕様に‘*’が含まれていなくても、コマンドが読み取り専用バッファのテキストを変更しようとした場合にエラーを発生させる点に注意してください。したがって、この文字は、コマンドの実装がバッファを変更するプリミティブを一切呼び出さない場合でも強制的にエラーを発生させたい場合や、バッファの変更によって後で失敗するコマンドの処理や副作用を避けたい場合に使用します。例えば、inhibit-read-onlyをnon-nilにバインドするコマンド(読み取り専用バッファ以外にも影響するため)や、条件によっては結果的にバッファを変更しない可能性があるものの、それでもこのエラーを発生させたいコマンドなどが挙げられます。
このコマンドを呼び出したキーシーケンスの最初のマウスイベントで言及されているウィンドウを選択します。特殊。
shift-translation 経由でコマンドが呼び出された場合は、コマンド実行前にマークを設定し、一時的にリージョンを有効にするか、すでに有効なリージョンを拡張します。shift-translation なしでコマンドが呼び出され、かつリージョンが一時的に有効な場合は、コマンド実行前にリージョンを無効にします。特殊。
関数名(すなわち、fboundpを満たすシンボル)。 Existing, Completion,
Prompt.
既存のバッファ名。デフォルトでは、現在のバッファ名が使用されます(バッファを参照)。Existing, Completion, Default, Prompt.
バッファ名。バッファが存在する必要はありません。デフォルトでは、現在のバッファ以外の、最近使用したバッファの名前が使用されます。補完、デフォルト、プロンプト。
文字。カーソルはエコーエリアに移動しない。プロンプト。
コマンド名(すなわち、commandpを満たすシンボル)。 Existing,
Completion, Prompt.
点の位置を整数として(Pointを参照)。I/Oなし。
ディレクトリ。デフォルトは現在のバッファの現在のデフォルトディレクトリ、default-directory です(ファイル名を展開する関数を参照)。既存、補完、デフォルト、プロンプト。
コマンドをトリガーしたキーシーケンスにおける、最初または次の非キーボードイベント。より正確には、‘e’はリスト形式のイベントを取得するため、リスト内のデータを確認できます。入力イベントを参照してください。I/Oはありません。
マウスイベントや特殊なシステムイベントには ‘e’ を使用します(その他のシステムイベントを参照)。コマンドが受け取るイベントリストは、イベントによって異なります。各イベントのリスト形式について対応するサブセクションで説明している 入力イベント を参照してください。
単一コマンドのインタラクティブ仕様において、‘e’を複数回使用できます。コマンドを呼び出したキーシーケンスにリスト形式のnイベントが含まれている場合、n番目の‘e’がn番目の当該イベントを提供します。ファンクションキーやASCII文字など、リスト形式ではないイベントは、‘e’に関してはカウントされません。
既存ファイルのファイル名(ファイル名を参照)。既定値の詳細については、ファイル名の読み込みを参照してください。既存、補完、既定、プロンプト。
ファイル名。ファイルが存在する必要はありません。補完、デフォルト、プロンプト。
ファイル名。ファイルが存在する必要はありません。ユーザーがディレクトリ名のみを入力した場合、値は単にそのディレクトリ名となり、ディレクトリ内のファイル名は追加されません。補完、デフォルト、プロンプト。
的外れな主張だ。このコードは常に引数の値としてnilを返す。I/Oは行われない。
キーシーケンス(キーシーケンスを参照)。これにより、現在のキーマップ内でコマンド(または未定義のコマンド)が見つかるまで、読み取りイベントが継続されます。キーシーケンスの引数は、文字列またはベクトルとして指定されます。カーソルはエコーエリアに移動しません。プロンプト。
‘k’がダウンイベントで終わるキーシーケンスを読み取った場合、後続のアップイベントも読み取って破棄します。そのアップイベントには、コード文字‘U’でアクセスできます。
この種の入力は、describe-key や keymap-global-set といったコマンドで使用されます。
keymap-set などの関数への入力として使用できる、フォーム上のキーシーケンス。これは
‘k’
と同様に動作しますが、キーシーケンスの最後の入力イベントにおいて、通常は(必要に応じて)未定義のキーを定義済みのキーに変換するために用いられる変換処理(キーシーケンス入力
を参照)を抑制します。そのため、この形式は通常、コマンドにバインドする新しいキーシーケンスの入力を求める際に使用されます。
マークの位置(整数)。入出力なし。
ミニバッファ内で現在のバッファの入力メソッドを用いて読み込まれ、文字列として返される任意のテキスト(The GNU Emacs Manualの入力メソッドを参照)。 プロンプト。
ミニバッファで読み取る数値。入力が数値でない場合、ユーザーは再入力する必要があります。‘n’はプレフィックス引数を一切使用しません。プロンプト。
数値のプレフィックス引数。ただし、プレフィックス引数がない場合は、n と同様に数値を読み込みます。値は常に数値となります。プレフィックスコマンド引数を参照してください。プロンプト。
数値プレフィックス引数。(なお、この ‘p’ は小文字であることに注意してください。) I/Oなし。
生のプレフィックス引数。(なお、この ‘P’ は大文字であることに注意してください。) I/Oなし。
ポイントとマークを2つの数値引数として指定します。小さい方を先に指定してください。これと次に続くものは、単一ではなく連続する2つの引数を指定する唯一のコード文字です。コマンド実行時にカレントとなっているバッファにマークが設定されていない場合、‘r’ はエラーを通知します。一時マークモードが有効な場合(マークを参照)――デフォルトで有効になっています――、かつユーザーオプション mark-even-if-inactive が nil
である場合、マークが設定されていても非アクティブであれば、Emacs はエラーを通知します。I/O
は行われません。
ポイントとマークを2つの数値引数として渡し、小さい方を先に指定します。ただし、リージョンがアクティブであり、かつ use-region-p の意味で操作することが適切である場合に限ります(リージョン を参照)。それ以外の場合は、連続する各引数に対して nil を2回返します。このコード文字がエラーを示すことはありません。マークが設定されていない場合、use-region-p は単に nil
を返すためです。アクティブなリージョンに対して特別な操作を行うコマンドでは、‘r’ の代わりにこのコード文字を使用してください。I/Oはありません。
ミニバッファで読み込まれ、文字列として返される任意のテキスト(ミニバッファによるテキスト文字列の読み込みを参照)。入力の終端には C-j または RET のいずれかを使用します。(C-q を使用すると、これらの文字のいずれかを入力に含めることができます。)プロンプト。
ミニバッファで名称が読み込まれる内部化されたシンボル。入力の終端には C-j または RET のいずれかを使用してください。通常であればシンボルを終端させるその他の文字(空白、括弧、ブラケットなど)は、ここでは終端として機能しません。プロンプト。
キーシーケンスまたは nil。‘k’ または ‘K’
引数の後に使用することで、‘k’ または ‘K’
がダウンイベントを読み取った後に破棄されたアップイベント(もしあれば)を取得できます。アップイベントが破棄されていない場合、‘U’ は引数として nil を提供します。I/O
は発生しません。
ユーザーオプションとして宣言された変数(すなわち、述語 custom-variable-p
を満たすもの)。これは read-variable を用いて変数を読み込みます。read-variable
の定義を参照してください。既存、Completion、Prompt。
読み取り構文で指定され、C-j または RET で終わる Lisp オブジェクト。このオブジェクトは評価されません。ミニバッファを用いた Lisp オブジェクトの読み取りを参照してください。プロンプト。
Lispフォームの値。‘X’は‘x’と同様に読み込まれ、その後フォームが評価され、その値がコマンドの引数となる。Prompt.
コーディングシステム名(シンボル)。ユーザーがヌル入力を入力した場合、引数の値は nil
となります。コーディングシステム
を参照してください。補完、既存、プロンプト。
コーディングシステム名(シンボル)—ただし、このコマンドにプレフィックス引数がある場合に限ります。プレフィックス引数がない場合は、‘Z’は引数の値としてnilを提供します。補完、既存、プロンプト。