Стандартные свойства символов

Здесь перечислены свойства символов, используемые в Emacs для специальных целей. В следующей таблице выражение «названная функция» означает функцию, имя которой совпадает с именем соответствующего символа; аналогично трактуются выражения «названная переменная» и т. д.

:advertised-binding

Это значение свойства задаёт предпочтительную привязку клавиши для названной функции при отображении документации. См. Подстановка привязок клавиш в документации.

char-table-extra-slots

Значение, отличное от nil, задаёт количество дополнительных слотов в типе таблицы символов, названном в имени свойства. См. Таблицы символов.

customized-face

face-defface-spec

saved-face

theme-face

Эти свойства используются для хранения стандартных, сохранённых, настроенных и тематических спецификаций оформления лица. Не задавайте их напрямую: ими управляет defface и связанные с ним функции. См. Определение оформления лиц.

customized-value

saved-value

standard-value

theme-value

Эти свойства используются для хранения стандартного значения настраиваемой переменной, сохранённого значения, настроенного, но не сохранённого значения и тематических значений. Не задавайте их напрямую: ими управляет defcustom и связанные с ним функции. См. Определение настраиваемых переменных.

definition-name

find-function-type-alist

Эти свойства помогают найти определение символа в исходном коде, если его трудно обнаружить текстовым поиском в исходном файле, например когда символ определён макросом. См. Поиск определений.

disabled

Если значение не равно nil, названная функция отключена как команда. См. Отключение команд.

face-documentation

В этом значении хранится строка документации названного оформления лица. Она автоматически задаётся функцией defface. См. Определение оформления лиц.

history-length

Значение, отличное от nil, задаёт максимальную длину истории минибуфера для названной переменной списка истории. См. История минибуфера.

important-return-value

Значение, отличное от nil, заставляет байт-компилятор выдавать предупреждение о коде, который вызывает названную функцию, не используя возвращённое ею значение. Это полезно для функций, вызов которых без использования результата, скорее всего, является ошибкой. Обычно это свойство добавляется функции с помощью declare (см. Форма declare).

interactive-form

Это значение представляет собой интерактивную форму для названной функции. Обычно не следует задавать его напрямую: вместо этого используйте специальную форму interactive. См. Использование interactive.

interactive-only

Если значение не равно nil, названную функцию не следует вызывать из Lisp. Значение представляет собой строку ошибки или функцию, которую следует вызвать вместо неё. См. Определение команд.

menu-alias

Если значение не равно nil, этот символ является пунктом меню-псевдонимом, и его собственную привязку клавиши не следует показывать. См. Пункты меню-псевдонимы.

menu-enable

Значение представляет собой выражение, определяющее, следует ли включить названный пункт меню в меню. См. Простые пункты меню.

mode-class

Если значение равно special, названный основной режим является специальным. См. Соглашения для основных режимов.

ignored-mouse-command

mouse-1-menu-command

Эти свойства влияют на поведение команд, привязанных к down-mouse-1. См. События сенсорного экрана.

permanent-local

Если значение не равно nil, названная переменная является локальной для буфера; её значение не следует сбрасывать при смене основных режимов. См. Создание и удаление привязок, локальных для буфера.

permanent-local-hook

Если значение не равно nil, названную функцию не следует удалять из локального значения переменной-хука при смене основных режимов. См. Настройка хуков.

pure

Если значение не равно nil, названная функция считается чистой (см. Что такое функция?). Вызовы с константными аргументами могут быть вычислены во время компиляции. Это может привести к тому, что ошибки времени выполнения будут обнаружены во время компиляции. Обычно это свойство добавляется функции с помощью declare (см. Форма declare).

risky-local-variable

Если значение не равно nil, названная переменная считается небезопасной в качестве переменной файла. См. Локальные переменные файла.

safe-function

Если значение не равно nil, названная функция считается в целом безопасной для вычисления. См. Определение безопасности вызова функции.

safe-local-eval-function

Если значение не равно nil, названную функцию безопасно вызывать в формах вычисления локальных переменных файла. См. Локальные переменные файла.

safe-local-variable

Значение задаёт функцию, определяющую безопасные локальные значения файла для названной переменной. См. Локальные переменные файла.

side-effect-free

Значение, отличное от nil, указывает, что названная функция не имеет побочных эффектов (см. Что такое функция?), поэтому байт-компилятор может игнорировать вызов, результат которого не используется. Если значение свойства равно error-free, байт-компилятор может даже удалять такие неиспользуемые вызовы. Помимо оптимизаций байт-компилятора, это свойство используется также для определения безопасности функции (см. Определение безопасности вызова функции). Обычно это свойство добавляется функции с помощью declare (см. Форма declare).

undo-inhibit-region

Если значение не равно nil, названная функция не позволяет ограничить операцию undo активной областью, если сразу после функции вызывается undo. См. Отмена изменений.

variable-documentation

Если значение не равно nil, оно задаёт строку документации названной переменной. Это значение автоматически устанавливается функцией defvar и связанными с ней функциями. См. Основы документации.