Next: Loading Non-ASCII, Previous: Load Suffixes, Up: Loading [Contents][Index]
EmacsがLispライブラリーをロードするときは、変数load-pathにより指定されるディレクトリー内のライブラリーを検索します。
この変数の値はloadでファイルをロードするとき検索するディレクトリーのリスト。リストの各要素は文字列(ディレクトリーでなければならない)、またはnil
(カレントワーキングディレクトリーを意味する)。
Emacsは起動時にいくつかのステップによりload-pathの値をセットアップする。最初にEmacsがコンパイルされたときのデフォルトロケーションセット(default
locations set)を使用して、load-pathを初期化する。通常これは以下のようなディレクトリーである
"/usr/local/share/emacs/version/lisp"
(以降の例ではあなたがインストールしたEmacsのインストールプレフィクスに合うように/usr/localを置き換えること。) これらのディレクトリーには、Emacsとともにインストールされた標準的なLispファイルが含まれる。Emacsがこれらを見つけられなければ正常に起動しないだろう。
Emacsをビルドしたディレクトリーから起動した場合 −−− つまり正式にインストールされた実行形式ではないEmacsを起動した場合
— 、Emacsはビルドされたディレクトリーのソースのlispディレクトリーを使用してload-pathを初期化する。ソースとは別のディレクトリーでEmacsをビルドした場合は、ビルドしたディレクトリーのlispディレクトリーも追加する(いずれも要素は絶対ファイル名になる)。
--no-site-lispオプションでEmacsを起動した場合を除き、load-pathの先頭にさらに2つのsite-lispを追加する。これらはローカルにインストールされたLispファイルで、通常は:
"/usr/local/share/emacs/version/site-lisp"
および
"/usr/local/share/emacs/site-lisp"
の形式である。1つ目は特定のバージョンのEmacsにたいしてローカルにインストールされたものである。2つ目はインストールされたすべてのバージョンのEmacsが使用することを意図してローカルにインストールされたものである(インストールされたものでないEmacsが実行されると、もし存在すればソースディレクトリーとビルドディレクトリーのsite-lispディレクトリーも追加される。これらのディレクトリーは通常はsite-lispディレクトリーを含まない)。
環境変数EMACSLOADPATHがセットされていたら、上述の初期化プロセスが変更される。Emacsはこの環境変数の値にもとづいてload-pathを初期化する。
EMACSLOADPATHの構文はPATHで使用される構文と同様。ディレクトリーは‘:’
(オペレーティングシステムによっては‘;’)で区切られる。
以下は(shスタイルのシェルから)EMACSLOADPATH変数をセットする例である:
export EMACSLOADPATH=/home/foo/.emacs.d/lisp:
環境変数の値内の空の要素は、(上記例のような)末尾、先頭、中間のいずれにあるかに関わらず、標準の初期化処理により決定されるload-pathのデフォルト値に置き換えられる。そのような空要素が存在しなければEMACSLOADPATHによりload-path全体が指定される。空要素、または標準のLispファイルを含むディレクトリーへの明示的なパスのいずれかを含めなければならない。さもないとEmacsが関数を見つけられなくなる(load-pathを変更する他の方法は、Emacs起動時にコマンドラインオプション-Lを使用する方法である。以下参照)。
load-path内の各ディレクトリーにたいして、Emacsはそのディレクトリーがファイルsubdirs.elを含むか確認して、もしあればそれをロードする。subdirs.elファイルは、load-pathのディレクトリーにたいして任意のサブディレクトリーを追加するためのコードが含まれており、Emacsがビルド/インストールされたときに作成される。サブディレクトリーと複数階層下のレベルのサブディレクトリーの両方が直接追加される。ただし名前の最初が英数字でないディレクトリー、名前がRCSまたはCVSのディレクトリー、名前が.nosearchというファイルを含むディレクトリーは除外される。
次にEmacsはコマンドラインオプション-L(Action Arguments in The GNU Emacs Manualを参照)で指定したロードディレクトリーを追加する。もしあればオプションパッケージ(Packaging Basicsを参照)がインストールされた場所も追加する。
initファイル(Init Fileを参照)でload-pathに1つ以上のディレクトリーを追加するコードを記述するのは一般的に行なわれている。たとえば:
(push "~/.emacs.d/lisp" load-path)
Emacsのダンプにはload-pathの特別な値を使用する。ダンプされたEmacsをカスタマイズするためにsite-load.elかsite-init.elを使用する場合、これらのファイルが行ったload-pathにたいする変更はすべてダンプ後に失われる。
このコマンドはライブラリーlibraryの正確なファイル名を探す。loadと同じ方法でライブラリーを検索を行い、引数nosuffixもloadの場合と同じ意味をもつ。libraryに指定する名前にはサフィックス‘.elc’または‘.el’を追加しないこと。
pathが非nilならload-pathのかわりにそのディレクトリーのリストが使用される。
locate-libraryがプログラムから呼び出されたときはファイル名を文字列としてリターンする。ユーザーがインタラクティブにlocate-libraryを実行したときは、引数interactive-callがtとなり、これはlocate-libraryにたいしてファイル名をエコーエリアに表示するよう指示する。
このコマンドはシャドー(shadowed)されたEmacs
Lispファイルを表示する。シャドーされたファイルとは、load-pathのディレクトリーに存在するにも関わらず、load-pathのディレクトリーリスト内で前の位置にある他のディレクトリーに同じ名前のファイルが存在するため、通常はロードされないファイルのことである。
たとえば以下のようにload-pathがセットされていたとする
("/opt/emacs/site-lisp" "/usr/share/emacs/23.3/lisp")
そして両方のディレクトリーにfoo.elという名前のファイルがあるとする。この場合、(require
'foo)は決して2つ目のディレクトリーのファイルをロードしない。このような状況はEmacsがインストールされた方法に問題があることを示唆する。
Lispから呼び出されたると、この関数はシャドーされたファイルリストをバッファー内に表示するかわりに、それのメッセージをプリントする。オプション引数stringpが非nilなら、かわりにシャドーされたファイルを文字列としてリターンする。