D.3 Emacsプログラミングのヒント

以下の慣習にしたがうことによりあなたのプログラムが実行時によりEmacsに適合するようになります。

• プログラム内でnext-lineやprevious-lineを使用してはならない。ほとんど常にforward-lineのほうがより簡便であり、より予測可能かつ堅牢である。Text Linesを参照のこと。
• あなたのプログラム内でマークのセットが意図した機能でないなら、マークをセットする関数を呼び出してはならない。マークはユーザーレベルの機能なので、ユーザーの益となる値を提供する場合を除きマークの変更は間違いである。The Markを参照のこと。

  特に以下の関数は使用しないこと:

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

  インタラクティブなユーザーを意図した別の機能がないのにポイントの移動、特定の文字列の置換、またはファイルやバッファーのコンテンツを挿入したいだけなら単純な1、2行のLispコードでそれらの関数を置き換えられる。

• ベクターを使用する特別な理由がある場合を除きベクターではなくリストを使用すること。Lispではベクターよりリストを操作する機能のほうが多く、リストを処理するほうが通常は簡便である。

  要素の挿入や削除がなく(これはリストだけで可能)、ある程度のサイズがあって、(先頭か末尾から検索しない)ランダムアクセスがあるテーブルではベクターが有利。

• エコーエリア内にメッセージを表示する推奨方法はprincではなくmessage関数。The Echo Areaを参照のこと。
• エラーコンディションに遭遇したときは関数error (またはsignal)を呼び出すこと。関数errorはリターンしない。Signaling Errorsを参照のこと。

  エラーの報告にmessage、throw、sleep-for、beepを使用しないこと。

• エラーメッセージは大文字で始まり、ピリオドや他の区切り文字で終わらないこと。

  たとえdebug-on-errorがnilであっても、ユーザーにエラーの発生元を伝えることが有用な場合もある。そのような場合には、エラーメッセージに小文字のLispシンボルを前置できる。たとえばエラーメッセージ“Invalid input”を“some-function: Invalid input”となるように拡張できる。

• ミニバッファー内でyes-or-no-pかy-or-n-pで答えを求める質問を行う場合には大文字で始めて‘?’で終わること。
• ミニバッファーのプロンプトでデフォルト値を示すときは、カッコ内に単語‘default’を配置すること。これは以下のようになる:

  Enter the answer (default 42):
  

• interactiveで引数リストを生成するLisp式を使用する場合には、リージョンやポジションの引数にたいして正しいデフォルト値を生成しようと試みではならない。それらの引数が指定されていなければかわりにnilを提供して、引数がnilのときに関数のbodyでデフォルト値を計算すること。たとえば以下のように記述する:

  (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)))
    ...)
  

  これはそのコマンドを繰り返す場合に、そのときの状況にもとづいてデフォルト値が再計算されるからである。

  interactiveの‘d’、‘m’、‘r’指定を使用する際にはコマンドを繰り返すときの引数値の再計算にたいして特別な段取りを行うので、このような注意事項を採用する必要はない。

• 実行に長時間を要する多くのコマンドは開始時に‘Operating...’、完了時に‘Operating...done’のような何らかのメッセージを表示すること。これらのメッセージのスタイルは‘...’の周囲にスペースを置かず、‘done’の後にピリオドを置かないよう一定に保ってほしい。そのようなメッセージを生成する簡便な方法はProgressを参照のこと。
• 再帰編集の使用を避けること。かわりにRmailのeコマンドが行うように、元のローカルキーマップに戻るよう定義したコマンドを含んだ新たなローカルキーマップを使用するか、単に別のバッファーにスイッチしてユーザーが自身で戻れるようにすること。Recursive Editingを参照のこと。