名前¶
AutoLoader - load subroutines only on demand
AutoLoader - 要求に応じてのみサブルーチンを読み込む
概要¶
package Foo;
use AutoLoader 'AUTOLOAD'; # import the default AUTOLOAD subroutine package Foo;
use AutoLoader 'AUTOLOAD'; # デフォルトの AUTOLOAD サブルーチンを読み込む package Bar;
use AutoLoader; # don't import AUTOLOAD, define our own
sub AUTOLOAD {
...
$AutoLoader::AUTOLOAD = "...";
goto &AutoLoader::AUTOLOAD;
} package Bar;
use AutoLoader; # AUTOLOAD をインポートせずに自身のものを定義する
sub AUTOLOAD {
...
$AutoLoader::AUTOLOAD = "...";
goto &AutoLoader::AUTOLOAD;
}説明¶
The AutoLoader module works with the AutoSplit module and the __END__ token to defer the loading of some subroutines until they are used rather than loading them all at once.
AutoLoader モジュールは、AutoSplit モジュールと __END__ トークンと ともに動作し、サブルーチンすべてを一度に読み込むのではなくて、 使われるまでサブルーチンの読み込みを延期します。
To use AutoLoader, the author of a module has to place the definitions of subroutines to be autoloaded after an __END__ token. (See perldata.) The AutoSplit module can then be run manually to extract the definitions into individual files auto/funcname.al.
AutoLoader を使うために、モジュールの作者は、自動的に読み込む サブルーチンの定義を __END__ トークンの後に置く必要があります。 (perldata を見てください。) AutoSplit モジュールを手動で走らせると、定義を個々の auto/funcname.al ファイルに抜きだします。
AutoLoader implements an AUTOLOAD subroutine. When an undefined subroutine in is called in a client module of AutoLoader, AutoLoader's AUTOLOAD subroutine attempts to locate the subroutine in a file with a name related to the location of the file from which the client module was read. As an example, if POSIX.pm is located in /usr/local/lib/perl5/POSIX.pm, AutoLoader will look for perl subroutines POSIX in /usr/local/lib/perl5/auto/POSIX/*.al, where the .al file has the same name as the subroutine, sans package. If such a file exists, AUTOLOAD will read and evaluate it, thus (presumably) defining the needed subroutine. AUTOLOAD will then goto the newly defined subroutine.
AutoLoader は、AUTOLOAD サブルーチンを実装します。 未定義のサブルーチンが、AutoLoader のクライアントモジュールで 呼び出されると、AutoLoader の AUTOLOAD サブルーチンは、 クライアントモジュールが読まれたそのファイルの位置に関係する名前で、 ファイル中のサブルーチンを見つけようとします。 例えば、POSIX.pm が /usr/local/lib/perl5/POSIX.pm にあると、 AutoLoader は perl の POSIX のサブルーチンを /usr/local/lib/perl5/auto/POSIX/*.al から探します; .al ファイルは、パッケージ名なしのサブルーチンと同じ名前です。 そのようなファイルがあれば、AUTOLOAD はそれを読んで評価します; このようにして、(おそらく)必要とされるサブルーチンを定義します。 それから、AUTOLOAD は新たに定義されたサブルーチンへ goto します。
Once this process completes for a given function, it is defined, so future calls to the subroutine will bypass the AUTOLOAD mechanism.
その関数のためにこの処理が一旦実行されると、これは定義され、 以後のサブルーチンの呼び出しは AUTOLOAD の機構を飛ばします。
サブルーチンスタブ¶
In order for object method lookup and/or prototype checking to operate correctly even when methods have not yet been defined it is necessary to "forward declare" each subroutine (as in sub NAME;). See "SYNOPSIS" in perlsub. Such forward declaration creates "subroutine stubs", which are place holders with no code.
メソッドがまだ定義されていないときにでもオブジェクトメソッドの調査や プロトタイプチェックを正確に行うために、 それぞれのサブルーチンを(sub NAME; のように)、 「前方宣言」する必要があります。 "SYNOPSIS" in pelsub を見てください。 このような前方宣言は、「サブルーチンスタブ」を作ります; これは、コード無しのプレースホルダです。
The AutoSplit and AutoLoader modules automate the creation of forward declarations. The AutoSplit module creates an 'index' file containing forward declarations of all the AutoSplit subroutines. When the AutoLoader module is 'use'd it loads these declarations into its callers package.
AutoSplit と、AutoLoader モジュールは前方宣言の作成を自動化します。 AutoSplit モジュールは、'index' ファイルを作り、そこに AutoSplit が分割したすべてのサブルーチンの前方宣言を置きます。 AutoLoader モジュールが 'use' されると、その呼び出し元パッケージに それらの定義を読み込みます。
Because of this mechanism it is important that AutoLoader is always used and not required.
この機構のため、AutoLoader は常に use され、 require されないということが重要です。
Using AutoLoader's AUTOLOAD Subroutine¶
(AutoLoader の AUTOLOAD サブルーチンを使う)
In order to use AutoLoader's AUTOLOAD subroutine you must explicitly import it:
AutoLoader の AUTOLOAD サブルーチンを使うに、 明示的にそれをインポート しなければなりません。
use AutoLoader 'AUTOLOAD';Overriding AutoLoader's AUTOLOAD Subroutine¶
(AutoLoader's AUTOLOAD サブルーチンをオーバーロードする)
Some modules, mainly extensions, provide their own AUTOLOAD subroutines. They typically need to check for some special cases (such as constants) and then fallback to AutoLoader's AUTOLOAD for the rest.
いくつかのモジュール、主にエクステンションは、自分自身の AUTOLOAD サブルーチンをもっています。 それらは典型的に、(定数のような)いくつかの特別な場合のために チェックする必要があり、 それから、残りの作業のために AutoLoader の AUTOLOAD に フォールバックする必要があります。
Such modules should not import AutoLoader's AUTOLOAD subroutine. Instead, they should define their own AUTOLOAD subroutines along these lines:
このようなモジュールは AutoLoader の AUTOLOAD サブルーチンを インポートすべきでは ありません。 そのかわりに、そのようなモジュールは、次のように、自分自身の AUTOLOAD サブルーチンを定義すべきです;
use AutoLoader;
use Carp;
sub AUTOLOAD {
my $sub = $AUTOLOAD;
(my $constname = $sub) =~ s/.*:://;
my $val = constant($constname, @_ ? $_[0] : 0);
if ($! != 0) {
if ($! =~ /Invalid/ || $!{EINVAL}) {
$AutoLoader::AUTOLOAD = $sub;
goto &AutoLoader::AUTOLOAD;
}
else {
croak "Your vendor has not defined constant $constname";
}
}
*$sub = sub { $val }; # same as: eval "sub $sub { $val }";
goto &$sub;
}If any module's own AUTOLOAD subroutine has no need to fallback to the AutoLoader's AUTOLOAD subroutine (because it doesn't have any AutoSplit subroutines), then that module should not use AutoLoader at all.
(AutoSplit するサブルーチンを全くもっていないために)、モジュールの AUTOLOAD サブルーチンが、 AutoLoader の AUTOLOAD サブルーチンにフォールバックする必要がなければ、 そのモジュールは AutoLoader を、全く使わないべきです。
パッケージレキシカル¶
Package lexicals declared with my in the main block of a package using AutoLoader will not be visible to auto-loaded subroutines, due to the fact that the given scope ends at the __END__ marker. A module using such variables as package globals will not work properly under the AutoLoader.
AutoLoader を使っているパッケージの main ブロックで、 my で宣言されたパッケージレキシカルの変数は、自動的に読み込まれた サブルーチンには見えません; これは、与えられたスコープが __END__ マーカーで終るという事実によります。 そのような変数をパッケージのグローバル変数のように使っているモジュールは、 AutoLoader のもとでは、うまく動きません。
The vars pragma (see "vars" in perlmod) may be used in such situations as an alternative to explicitly qualifying all globals with the package namespace. Variables pre-declared with this pragma will be visible to any autoloaded routines (but will not be invisible outside the package, unfortunately).
vars プラグマ("vars" in perlmod を見てください)が、こういった状況で、 パッケージの名前空間で明示的に完全修飾したグローバル変数に変わるものとして、 使えます。 このプラグマで先に宣言された変数は、どのような、自動的に 読み込まれるルーチンにも見えます (しかし、残念ながら、パッケージの外側からは見えません。)
AutoLoaderを使わない¶
You can stop using AutoLoader by simply
AutoLoader を使わなくするには、単純に次のようにします:
no AutoLoader;AutoLoader vs. SelfLoader¶
The AutoLoader is similar in purpose to SelfLoader: both delay the loading of subroutines.
AutoLoader は、SelfLoader の目的と類似性があります： 両方ともサブルーチンの読み込みを遅らせるものです。
SelfLoader uses the __DATA__ marker rather than __END__. While this avoids the use of a hierarchy of disk files and the associated open/close for each routine loaded, SelfLoader suffers a startup speed disadvantage in the one-time parsing of the lines after __DATA__, after which routines are cached. SelfLoader can also handle multiple packages in a file.
SelfLoader は、__END__ ではなくて、__DATA__ マーカーを使います。 このことにより、それぞれのルーチンを読み込むために、 ディスクファイルの階層を使い、関連する open/close を避ける一方で、 SelfLoader は、ルーチンがキャッシュされた後、__DATA__ を一度 パースするので、起動速度の不利を被ります。 また、SelfLoader は一つのファイルで複数のパッケージを取り扱えます。
AutoLoader only reads code as it is requested, and in many cases should be faster, but requires a mechanism like AutoSplit be used to create the individual files. ExtUtils::MakeMaker will invoke AutoSplit automatically if AutoLoader is used in a module source file.
AutoLoader は、要求されたときにだけコードを読みます; 多く場合、これはより高速です; しかし、独立したファイルを作成するのに使われる AutoSplit のような機構を必要とします。 AutoLoader がモジュールのソースファイルで使われると、 ExtUtils::MakeMaker は AutoSplit を自動的に呼び出します。
CAVEATS¶
AutoLoaders prior to Perl 5.002 had a slightly different interface. Any old modules which use AutoLoader should be changed to the new calling style. Typically this just means changing a require to a use, adding the explicit 'AUTOLOAD' import if needed, and removing AutoLoader from @ISA.
Perl 5.002 より前の AutoLoader は、少し違ったインターフェースでした。 AutoLoader を使っている古いモジュールは、 新しいスタイルの呼び出しに変更するべきです。 一般に、このことは、次のことを意味します; require を use に変えること、必要なら明示的な 'AUTOLOAD' のインポートを 加えること、@ISA から AutoLoader を削除することです。
On systems with restrictions on file name length, the file corresponding to a subroutine may have a shorter name that the routine itself. This can lead to conflicting file names. The AutoSplit package warns of these potential conflicts when used to split a module.
システムに、ファイル名の長さに関する制限があると、 ファイルとサブルーチンの一致のために、ルーチン自身より より短い名前になるかもしれません。 このことは、ファイル名の衝突を引き起こすかも知れません。 AutoSplit パッケージは、モジュールを分割するときに、 こういった潜在的な衝突を警告します。
AutoLoader may fail to find the autosplit files (or even find the wrong ones) in cases where @INC contains relative paths, and the program does chdir.
@INC の中に相対パスがあり、かつ＞ プログラムが chdir した場合、 AutoLoader は、自動的に分割されたファイルを見付けるのに失敗するかも知れません (または、間違ったファイルを見つけるかも知れません)。
SEE ALSO¶
SelfLoader - 外部ファイルを使わないオートローダー
作者¶
AutoLoader is maintained by the perl5-porters. Please direct any questions to the canonical mailing list. Anything that is applicable to the CPAN release can be sent to its maintainer, though.
Author and Maintainer: The Perl5-Porters <[email protected]>
Maintainer of the CPAN release: Steffen Mueller <[email protected]>
コピーライト & ライセンス¶
This package has been part of the perl core since the first release of perl5. It has been released separately to CPAN so older installations can benefit from bug fixes.
This package has the same copyright and license as the perl core:
Copyright (C) 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
by Larry Wall and others
All rights reserved.
This program is free software; you can redistribute it and/or modify
it under the terms of either:
a) the GNU General Public License as published by the Free
Software Foundation; either version 1, or (at your option) any
later version, or
b) the "Artistic License" which comes with this Kit.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See either
the GNU General Public License or the Artistic License for more details.
You should have received a copy of the Artistic License with this
Kit, in the file named "Artistic". If not, I'll be glad to provide one.
You should also have received a copy of the GNU General Public License
along with this program in the file named "Copying". If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307, USA or visit their web page on the internet at
http://www.gnu.org/copyleft/gpl.html.
For those of you that choose to use the GNU General Public License,
my interpretation of the GNU General Public License is that no Perl
script falls under the terms of the GPL unless you explicitly put
said script under the terms of the GPL yourself. Furthermore, any
object code linked with perl does not automatically fall under the
terms of the GPL, provided such object code only adds definitions
of subroutines and variables, and does not otherwise impair the
resulting interpreter from executing any standard Perl script. I
consider linking in C subroutines in this manner to be the moral
equivalent of defining subroutines in the Perl language itself. You
may sell such an object file as proprietary provided that you provide
or offer to provide the Perl source, as specified by the GNU General
Public License. (This is merely an alternate way of specifying input
to the program.) You may also sell a binary produced by the dumping of
a running Perl script that belongs to you, provided that you provide or
offer to provide the Perl source as specified by the GPL. (The
fact that a Perl interpreter and your code are in the same binary file
is, in this case, a form of mere aggregation.) This is my interpretation
of the GPL. If you still have concerns or difficulties understanding
my intent, feel free to contact me. Of course, the Artistic License
spells all this out for your protection, so you may prefer to use that.POD ERRORS¶
Hey! The above document had some coding errors, which are explained below:
- Around line 384:
-
Unterminated B<...> sequence