引数リスト (Common Lisp拡張)

Emacs Lispの関数の引数リストの表記法はCommon Lisp表記法のサブセットである。よく知られた&optionalと&restマーカと同様に、Common Lispは付加引数に既定値を指定でき、追加のマーカ&keyと&aux を提供する。

引数の構文解析はEmacsに組み込まれているため、このパッケージがCommon Lispの引数リストをシームレスに実装する方法はない。その代わりに、このパッケージはCommon Lisp引数リストが必要なら使わなければならないいくつかのLispフォームの代替を定義する。

また、arglistをその文法に含むこのパッケージで定義された (defsetfやfletのような)すべてのフォームは完全なCommon Lisp引数リストを許す。

あなたの関数から多くのCL機能にアクセスするためにdefun*を使う必要はないことに注意せよ。これらの機能は常に存在する; defun*とdefunの相違は単により柔軟な引数リストとその暗黙のブロックである。

(var...
 &optional (var initform svar)...
 &rest var
 &key ((keyword var) initform svar)...
 &aux (var initform)...)

5つの引数リスト節はそれぞれ付加的である。svar、initform、そしてkeyword部分は付加的である; 省略するなら、 ‘(var)’は単に‘var’と書いてもよい。

第1節は0個かそれ以上の必須引数から成る。これらの引数は関数呼び出し時には常に指定しなければならない; 必須引数に関する限り、Emacs LispとCommon Lispに相違はない。

第2節は付加引数から成る。これらの引数は関数呼び出し時に指定してもよい; 指定されない場合、initformは引数として使われる既定値を指定する。(initformがない場合は既定値としてnilを使うことを意味する) initformは先立つ引数がすでに確立した束縛とともに評価される; (a &optional (b (1+ a)))は1個または 2個の引数とマッチし、2番目の引数は1番目の引数に1を加えた値を既定値とする。svarが指定されると、付加引数が指定された場合は tに、引数が省略された場合はnilに束縛される補助変数になる。svarを使わない場合、引数なしで呼び出されたのか、引数として既定値を明示的に渡されたのかを知る方法はない。

第3節は1個のrest引数から成る。必須引数と付加引数が占めるより多くの引数が関数へ渡された場合、それらの余分な引数は1個のリストに集積され“rest”引数変数に束縛される。Common Lispの&restは Emacs Lispのそれと同等である。Common Lispはマクロコンテキストで &restの同義語として&bodyを受け入れる; このパッケージはいつでもそれを受け入れる。

第4節はキーワード引数から成る。これらは引数リスト中の位置ではなく名前で指定される付加引数である。たとえば、

(defun* foo (a &optional b &key c d (e 17)))

は1個、2個、またはそれ以上の引数で呼び出してもよい関数を定義する。最初の2個の引数は通常の方法でaとbに束縛される。残りの引数は:c、:d、または:eに続いてその対応する引数変数に束縛される値であるようなフォームの対でなければならない。 (その名前がコロンで始まるシンボルはキーワードと呼ばれ、 nilやt同様に自己引用的である)

たとえば、呼び出し(foo 1 2 :d 3 :c 4)は5個の引数をそれぞれ1、 2、4、3、そして17にセットする。同じキーワードが1度以上関数呼び出しに現れる場合、第1の出現が後の出現より優先する。付加引数bを指定することなくキーワード引数を指定することはできないことに注意せよ、なぜなら(foo 1 :c 2)はbをキーワード:cに束縛し、 2は有効なキーワードではないためエラーを通知するからである。

keywordシンボルが上のように引数リストに明示的に指定される場合、そのキーワードは1個のコロンを接頭辞とする単なる変数名の代わりに使われる。まったくコロンで始まらないkeywordシンボルを指定できるが、そのようなシンボルは自己引用的ではない; 関数呼び出し中で明示的にアポストロフィで引用しなければいけない。

通常、たとえば(foo 1 2 :c 3 :goober 4)のように、認められていないキーワードを関数に渡すことはエラーである。引数リストのキーワード節の後にマーカ&allow-other-keysを加えるか、呼び出し時にnilではない値の:allow-other-keys引数を指定することで、認められていないキーワードを無視するようLispに求めることができる。関数が&restと&keyを同時に両方使うと、“rest”引数は呼び出し時に現れるキーワードリストに束縛される。たとえば:

(defun* find-thing (thing &rest rest &key need &allow-other-keys)
  (or (apply 'member* thing thing-list :allow-other-keys t rest)
      (if need (error "Thing not found"))))

この関数はキーワード引数:needをとるが、関数member*へ渡される他のキーワード引数も受け入れる。allow-other-keysは find-thingとmember*が互いのキーワード引数に不平を言わないようにするのに使われる。

(かなりの)性能最適化のために、このパッケージは“rest”引数中のキーワード検索にmemqを呼び出すことでキーワード引数の走査を実装する。技術的には、memqは奇数個の値を偶数個のキーワードと同様に見るのでこれは正しくない。キーワードシンボルが同じ関数の有効なキーワード引数の名前と偶然同じ場合、キーワードシンボルを別のキーワード引数の値として偶然渡すと、キーワード構文解析部は混乱することになる。このあまり重要でないバグは、プログラム中でキーワードシンボルを一般用途のデータとして使うときにのみ影響がある場合がある; この習慣はEmacs Lispでは強く反対される。

引数リストの第5節は補助変数から成る。これらは実際にはまったく引数ではなく、関数実行時nilまたは指定されたinitformsに束縛される単なる変数である。スタイル上の好みの問題を除いて、下記の 2個の関数間に相違はない:

(defun* foo (a b &aux (c (+ a b)) d)
  body)

(defun* foo (a b)
  (let ((c (+ a b)) d)
    body))

引数リストは分配をサポートする。Common Lispでは、分配は defmacroでのみ許される;このパッケージはdefun*や他の引数リストでも同様に許す。分配では、全引数変数(上のvar)は変数のリストか、より一般的には再帰引数リストで置き換えることができる。対応する引数値は、その要素が再帰引数リストにマッチするリストでなければならない。たとえば:

(defmacro* dolist ((var listform &optional resultform)
                   &rest body)
  ...)

これは、dolistの第1引数は2個または3個の項目のリストでなければならないことを示す。このリスト同様に他の引数があれば、 body に格納される。正規の引数リストで許されるすべての機能はこれらの再帰引数リストで許される。さらに、 ‘&whole var’節は再帰引数リストの先頭で許される。それは varをマッチしたリスト全体に束縛する; したがって、 (&whole all a b)は2つのもののリストにマッチし、aは 1番目のものに束縛され、bは2番目のものに束縛され、all はそのリスト自身に束縛される。(Common Lispはトップレベルの defmacro引数リストでも同様に&wholeを許すが、Emacs Lisp はこの使用法をサポートしない)

分配の最後の機能は、引数リストはドットでもよいということである、だから引数リスト(a b . c)は機能的には(a b &rest c)と同等である。

最適化品質safetyに0が設定されると(see 宣言)、不正な引数の数や無効なキーワード引数のエラーチェックは無効である。既定では、引数リストは厳しくチェックされる。

2.1 引数リスト