GNU Emacs 32.0.50 (9008bf64c3) のマニュアルを PLaMo 翻訳で機械翻訳したものです。誤訳を含むことがあります。原文: https://www.gnu.org/software/emacs/manual/html_node/elisp/Standard-Properties.html ・ emacs-doc.conao3.com

9.4.2 標準シンボルプロパティ

ここでは、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 操作がアクティブ領域に限定されなくなります。Undo を参照してください。

variable-documentation

nil 以外の場合、これは名前付き変数のドキュメント文字列を指定します。これは defvar および関連関数によって自動的に設定されます。ドキュメントの基本 を参照してください。