---

D.3 Советы по программированию на Emacs

Соблюдение этих соглашений поможет вашей программе лучше вписаться в Emacs при запуске.

• Не используйте next-line или previous-line в программах; почти всегда forward-line более удобен, а также более предсказуем и надежен. См. Перемещение по строкам текста.
• Не вызывайте функции, устанавливающие маркер, если установка маркера не является одной из предполагаемых функций вашей программы. Маркер — это функция на уровне пользователя, поэтому неправильно изменять маркер, кроме как для предоставления значения на пользу пользователю. См. Маркер.

  В частности, не используйте ни одну из этих функций:

  • beginning-of-buffer, end-of-buffer
  • replace-string, replace-regexp
  • insert-file, insert-buffer

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

• Используйте списки вместо векторов, если только нет особой причины использовать вектор. Lisp имеет больше возможностей для манипулирования списками, чем для векторами, и работа со списками обычно более удобна.

  Векторы полезны для таблиц значительного размера, которые обращаются в произвольном порядке (а не ищутся от начала до конца), при условии, что нет необходимости в вставке или удалении элементов (только списки это позволяют).

• Рекомендуемый способ отображения сообщения в области эхо — использование функции message, а не princ. См. Область эхо.
• При возникновении ошибки вызовите функцию error (или signal). Функция error не возвращает значение. См. Как сигнализировать об ошибке.

  Не используйте message, throw, sleep-for или beep для сообщения об ошибках.

• Сообщение об ошибке должно начинаться с заглавной буквы, но не должно заканчиваться точкой или другой пунктуацией.

  Иногда полезно сообщить пользователю, откуда возникла ошибка, даже если debug-on-error равен nil. В таких случаях к сообщению об ошибке можно добавить строчную символьную константу Lisp. Например, сообщение об ошибке «Invalid input» можно расширить до «some-function: Invalid input».

• Вопрос, заданный в minibuffer с помощью yes-or-no-p или y-or-n-p, должен начинаться с заглавной буквы и заканчиваться знаком «?».
• Когда вы указываете значение по умолчанию в подсказке minibuffer, поместите его и слово «default» в скобки. Это должно выглядеть так:

  Enter the answer (default 42):
  

• В interactive, если вы используете выражение Lisp для создания списка аргументов, не пытайтесь предоставить правильные значения по умолчанию для аргументов области или позиции. Вместо этого предоставьте nil для этих аргументов, если они не были указаны, и пусть тело функции вычислит значение по умолчанию, когда аргумент равен nil. Например, напишите это:

  (defun foo (pos)
    (interactive
     (list (if specified specified-pos)))
    (unless pos (setq pos default-pos))
    ...)
  

  вместо этого:

  (defun foo (pos)
    (interactive
     (list (if specified specified-pos
               default-pos)))
    ...)
  

  Это нужно для того, чтобы повторное выполнение команды пересчитывало эти значения по умолчанию на основе текущих обстоятельств.

  Вам не нужно принимать такие меры предосторожности, когда вы используете интерактивные спецификации «d», «m» и «r», потому что они делают специальные приготовления для пересчета значений аргументов при повторном выполнении команды.

• Многие команды, выполнение которых занимает много времени, отображают сообщение, гласящее что-то вроде «Operating...» при начале, и меняют его на «Operating...done» по завершении. Пожалуйста, сохраняйте единообразие стиля этих сообщений: без пробела вокруг многоточия и без точки после «done». См. Сообщение о ходе выполнения операции, для простого способа генерации таких сообщений.
• Постарайтесь избегать рекурсивного редактирования. Вместо этого сделайте то, что делает команда Rmail e: используйте новую локальную карту клавиш, содержащую команду, определенную для возврата к старой локальной карте клавиш. Или просто переключитесь на другой буфер и позвольте пользователю переключиться обратно по желанию. См. Рекурсивное редактирование.