Next: , Previous: Keys in Documentation, Up: Documentation


23.4 ヘルプメッセージ用の文字変換

これらの関数は、イベント、キー列、文字をテキスト表記に変換します。 これらの表記は、メッセージに文字やキー列をテキストとして含めるのに有用です。 というのは、非印字文字や白文字を印字文字の列に変換するからです。 白文字でない印字文字は文字そのもので表記します。

— Function: key-description sequence

この関数は、sequenceの入力イベントに対する Emacsの標準表記を含んだ文字列を返す。 引数sequenceは、文字列、ベクトル、リストである。 正しいイベントについて詳しくはsee Input Events。 下記のsingle-key-descriptionの例を参照。

— Function: single-key-description event

この関数は、eventをキーボード入力向けのEmacsの標準表記で 表した文字列を返す。 普通の印字文字はそのまま現れるが、 コントロール文字は‘C-’で始まる文字列に、 メタ文字は‘M-’で始まる文字列に、 空白、タブなどは、‘SPC’、‘TAB’などとなる。 ファンクションキーのシンボルはそれ自身が現れる。 リストであるイベントはリストのcarのシンボルの名前が現れる。

          (single-key-description ?\C-x)
               ⇒ "C-x"
          (key-description "\C-x \M-y \n \t \r \f123")
               ⇒ "C-x SPC M-y SPC C-j SPC TAB SPC RET SPC C-l 1 2 3"
          (single-key-description 'C-mouse-1)
               ⇒ "C-mouse-1"
— Function: text-char-description character

この関数は、characterを テキストに現れる文字向けのEmacsの標準表記で表した文字列を返す。 single-key-descriptionに似ているが、 コントロール文字は、始めにカレットを付けて表現する点が異なる (Emacsのバッファでは、コントロールは普通このように表示される)。

          (text-char-description ?\C-c)
               ⇒ "^C"
          (text-char-description ?\M-m)
               ⇒ "M-m"
          (text-char-description ?\C-\M-m)
               ⇒ "M-^M"
— Function: read-kbd-macro string

この関数は、キーボードマクロの処理に主に使われるが、 key-descriptionに対するおおまかな逆変換にも使える。 空白で区切ったキーの表記を収めた文字列で、この関数を呼び出す。 対応するイベントを収めた文字列かベクトルを返す。 (指定したイベントに依存して、正しい単一のキー列であったりなかったりする。 see Keymap Terminology。)