Описание символов для сообщений справки

Эти функции преобразуют события, последовательности клавиш или символы в текстовые описания. Эти описания полезны для включения произвольных символов или последовательностей клавиш в сообщения, потому что они преобразуют непечатаемые и пробельные символы в последовательности печатаемых символов. Описание не-пробельного печатаемого символа — это сам символ.

Функция: key-description sequence &optional prefix

Эта функция возвращает строку, содержащую стандартную нотацию Emacs для входных событий в sequence. Если prefix не nil, это последовательность входных событий, ведущих к sequence, и она включается в возвращаемое значение. Оба аргумента могут быть строками, векторами или списками. Смотрите Входные события для получения дополнительной информации о допустимых событиях.

(key-description [?\M-3 delete])
     ⇒ "M-3 <delete>"

(key-description [delete] "\M-3")
     ⇒ "M-3 <delete>"

См. также примеры для single-key-description, ниже.

Функция: single-key-description event &optional no-angles

Эта функция возвращает строку, описывающую event в стандартной нотации Emacs для ввода с клавиатуры. Обычный печатаемый символ отображается как есть, но управляющий символ преобразуется в строку, начинающуюся с «C-», символ мета — в строку, начинающуюся с «M-», а пробел, табуляция и т. д. отображаются как «SPC», «TAB» и т. д. Символ функциональной клавиши отображается внутри угловых скобок «<…>». Событие, которое является списком, отображается как имя символа в CAR списка, внутри угловых скобок.

Если необязательный аргумент no-angles не nil, угловые скобки вокруг функциональных клавиш и символов событий опускаются; это для совместимости со старыми версиями Emacs, которые не использовали скобки.

(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 'delete)
     ⇒ "<delete>"

(single-key-description 'C-mouse-1)
     ⇒ "C-<mouse-1>"

(single-key-description 'C-mouse-1 t)
     ⇒ "C-mouse-1"

Функция: text-char-description character

Эта функция возвращает строку, описывающую character в стандартной нотации Emacs для символов, которые могут появляться в тексте — аналогично single-key-description, за исключением того, что аргумент должен быть допустимым кодом символа, который проходит characterp тест (см. Коды символов). Функция генерирует описания управляющих символов с начальным символом каретки (так Emacs обычно отображает управляющие символы в буферах). Символы с модификаторами приведут к ошибке этой функции (ASCII символы с модификатором Управления — исключение, они представляются как управляющие символы).

(text-char-description ?\C-c)
     ⇒ "^C"

(text-char-description ?\M-m)
     error→ Wrong type argument: characterp, 134217837

Команда: read-kbd-macro string &optional need-vector

Эта функция используется в основном для работы с макросами клавиатуры, но также может использоваться как грубое обратное преобразование для key-description. Вы вызываете её со строкой, содержащей описания клавиш, разделённые пробелами; она возвращает строку или вектор, содержащие соответствующие события. (Это может быть или не быть одной единственной допустимой последовательностью клавиш, в зависимости от используемых событий; см. Последовательности клавиш.) Если need-vector не nil, возвращаемое значение всегда является вектором.