変数定義(variable
definition)とは、そのシンボルをグローバル変数として使用する意図を表明する構文です。これには以下で説明するスペシャルフォームdefvarやdefconstが使用されます。
変数宣言は3つの目的をもちます。1番目はコードを読む人にたいして、そのシンボルが特定の方法(変数として)使用されることを意図したものだと知らせることです。2番目はLispシステムにたいしてオプションで初期値とドキュメント文字列を与えて、これを知らせることです。3番目はetagsのようなプログラミングツールにたいして、その変数が定義されている場所を見つけられるように情報を提供することです。
defconstとdefvarの主な違いは、人間の読み手に値が変更されるかどうかを知らせることにあります。Emacs
Lispは実際に、defconstで定義された変数の値の変更を妨げません。この2つのフォームの特筆すべき違いは、defconstは無条件で変数を初期化して、defvarは変数が元々voidのときだけ初期化することです。
カスタマイズ可能な変数を定義する場合は、defcustomを使用するべきです(これはサブルーチンとしてdefvarを呼び出す)。カスタマイゼーション変数の定義を参照してください。
This special form defines symbol as a variable and optionally
initializes and documents it. Note that it doesn’t evaluate symbol;
the symbol to be defined should appear explicitly in the defvar
form. defvar also marks symbol as special, meaning that
its bindings should always be dynamic (see 変数のバインディングのスコーピングルール).
If value is specified, and symbol is void (i.e., it has no
dynamically bound value; see 変数がvoidのとき), then defvar
evaluates value, and initializes symbol by setting it to the
result of the evaluation. But if symbol is not void, defvar
does not evaluate value, and leaves symbol’s value unchanged.
If value is omitted, defvar doesn’t change the value of
symbol in any case.
Note that specifying a value, even nil, marks the variable as special
permanently. Whereas if value is omitted, then defvar marks
the variable special only locally (i.e. within the current lexical scope,
or within the current file, if defvar is at the top-level). This can
be useful for suppressing byte compilation warnings, see コンパイラーのエラー.
If symbol has a buffer-local binding in the current buffer, and
value is specified, defvar modifies the default value of
symbol, which is buffer-independent, rather than the buffer-local
binding. It sets the default value if the default value is void.
See バッファーローカル変数.
If symbol is already let bound (e.g., if the defvar form occurs
in a let form), then defvar sets the toplevel default value of
symbol, like set-default-toplevel-value. The let binding
remains in effect until its binding construct exits. See 変数のバインディングのスコーピングルール.
C-M-x (eval-defun)、またはEmacs LispモードでC-x C-e
(eval-last-sexp)によりトップレベルのdefvarを評価する際には、これら2つのコマンドの特別な機能はその値がvoidであるかテストすることなく、その変数を無条件にセットする。
引数doc-stringが与えられたら、それは変数にたいするドキュメント文字列を指定する(そのシンボルのvariable-documentationプロパティに格納される)。ドキュメントを参照のこと。
以下にいくつか例を示す。これはfooを定義するが初期化は行わない:
(defvar foo)
⇒ foo
以下の例はbarの値を23に初期化してドキュメント文字列を与える:
(defvar bar 23
"The normal weight of a bar.")
⇒ bar
defvarフォームはsymbolをリターンするが、これは通常は値が問題にならないファイル内のトップレベルで使用される。
値をもたないdefvarのより詳細な使用例はLocal defvar exampleを参照のこと。
このスペシャルフォームはある値でsymbolを定義して、それを初期化する。これはコードを読む人に、symbolがここで設定される標準的なグローバル値をもち、ユーザーや他のプログラムがそれを変更すべきではないことを知らせる。symbolが評価されないことに注意。定義されるシンボルはdefconst内に明示的に記されなければならない。
defvarと同様、defconstは変数を特別 —
この変数が常にダイナミックにバインドされているという意味 — であるとマークする(変数のバインディングのスコーピングルールを参照)。加えてこれはその変数を危険であるとマークする(ファイルローカル変数を参照)。
defconstは常にvalueを評価して、その結果をsymbolの値にセットする。カレントバッファー内でsymbolがバッファーローカルなバインディングをもつなら、defconstはデフォルト値ではなくバッファーローカルな値をセットする(しかしdefconstで定義されたシンボルにたいしてバッファーローカルなバインディングを作らないこと)。
defconstの使い方の例は、Emacsのfloat-pi —
(たとえインディアナ州議会が何を試みようと)何者かにより変更されるべきではない数学定数piにたいする定義である。しかし2番目のdefconstの例のように、これは単にアドバイス的なものである。
(defconst float-pi 3.141592653589793 "The value of Pi.")
⇒ float-pi
(setq float-pi 3)
⇒ float-pi
float-pi
⇒ 3
警告:
変数がローカルバインディングをもつとき(letにより作成された、または関数の引数の場合)に、スペシャルフォームdefconstまたはdefvarを使用すると、これらのフォームはグローバルバインディングではなく、ローカルバインディングをセットします。これは通常は、あなたが望むことではないはずです。これを防ぐには、これらのスペシャルフォームをファイル内のトップレベルで使用します。この場所は通常、何のローカルバインディングも効果をもたないので、その変数にたいするローカルバインディングが作成される前にファイルがロードされることが確実だからです。