標準モジュールの中に Cwd.pm と言うのがあります。これを使うと cwd 関数で現在のワーキングディレクトリー名を取り出すことができます。次のテストスクリプトを test_cwd.pl という名前で作成します。
#!/usr/bin/perl use Cwd; print cwd, "\n"; # test_cwd.pl
実行すると次のようになります。
$ perl test_cwd.pl /home/hogehoge/perl/playland
つまり、use Cwd を宣言するだけで、cwd 関数を main パッケージに導入することができます。それでは、less /usr/lib/perl5/Cwd.pm で中身を覗いて見ましょう。(もちろん、wlocate Cwd.pm でも構いません。...としつこく宣伝。)
$ less /usr/lib/perl5/Cwd.pm
package Cwd;
require 5.000;
=head1 NAME
getcwd - get pathname of current working directory
=head1 SYNOPSIS
use Cwd;
$dir = cwd;
use Cwd;
$dir = getcwd;
use Cwd;
$dir = fastgetcwd;
use Cwd 'chdir';
chdir "/tmp";
print $ENV{'PWD'};
ここで、/import と入力して sub import { で始まる import メソッドを探してみましょう。2箇所ほど import という単語は見られますが、import メソッドそのものは見当たりませんその代わり次のような行があるはずです。
require Exporter; @ISA = qw(Exporter); @EXPORT = qw(cwd getcwd fastcwd fastgetcwd); @EXPORT_OK = qw(chdir abs_path fast_abs_path);
これば、Cwd クラスが Exporter クラスの派生クラスであることを示しています。したがって、Cwd クラスには import メソッドがないので、use Cwd; が実行されたときに、呼び出される import メソッドは Exporter クラスの import メソッドが継承されて呼び出されることになります。その際に @EXPORT に含まれる項目は、デフォールトで導入され、@EXPORT_OK に含まれる項目は use Cwd qw(chdir abs_path) などのように、use 関数に引数として渡されたときだけ導入(import)されます。こう書くと面倒に見えますが、要するにクラスを作成するときに main パッケージに導入したい関数(や変数)名を @EXPORT や @EXPORT_OK に入れて後のことは Export クラスに任せてしまうと考えると、その便利さが分かると思います。
前章で述べた pmnmz を利用して Exporter を利用している標準モジュールを調べると、Getopt::Std、ExtUtils::MM_Unix、CGI::Carp、POSIX 等をはじめとして非常に多くのモジュールで Exporter が利用されています。
それでは、Exporter のコードを見てみましょう。
package Exporter;
require 5.001;
#
# We go to a lot of trouble not to 'require Carp' at file scope,
# because Carp requires Exporter, and something has to give.
#
$ExportLevel = 0;
$Verbose = 0 unless $Verbose;
sub export {
# First make import warnings look like they're coming from the "use".
local $SIG{__WARN__} = sub {
my $text = shift;
if ($text =~ s/ at \S*Exporter.pm line \d+.*\n//) {
require Carp;
local $Carp::CarpLevel = 1; # ignore package calling us too.
Carp::carp($text);
}
else {
warn $text;
}
};
local $SIG{__DIE__} = sub {
require Carp;
local $Carp::CarpLevel = 1; # ignore package calling us too.
Carp::croak("$_[0]Illegal null symbol in \@${1}::EXPORT")
if $_[0] =~ /^Unable to create sub named "(.*?)::"/;
};
my($pkg, $callpkg, @imports) = @_;
my($type, $sym, $oops);
*exports = *{"${pkg}::EXPORT"};
if (@imports) {
if (!%exports) {
grep(s/^&//, @exports);
@exports{@exports} = (1) x @exports;
my $ok = \@{"${pkg}::EXPORT_OK"};
if (@$ok) {
grep(s/^&//, @$ok);
@exports{@$ok} = (1) x @$ok;
}
}
if ($imports[0] =~ m#^[/!:]#){
my $tagsref = \%{"${pkg}::EXPORT_TAGS"};
my $tagdata;
my %imports;
my($remove, $spec, @names, @allexports);
# negated first item implies starting with default set:
unshift @imports, ':DEFAULT' if $imports[0] =~ m/^!/;
foreach $spec (@imports){
$remove = $spec =~ s/^!//;
if ($spec =~ s/^://){
if ($spec eq 'DEFAULT'){
@names = @exports;
}
elsif ($tagdata = $tagsref->{$spec}) {
@names = @$tagdata;
}
else {
warn qq["$spec" is not defined in %${pkg}::EXPORT_TAGS];
++$oops;
next;
}
}
elsif ($spec =~ m:^/(.*)/$:){
my $patn = $1;
@allexports = keys %exports unless @allexports; # only do keys once
@names = grep(/$patn/, @allexports); # not anchored by default
}
else {
@names = ($spec); # is a normal symbol name
}
warn "Import ".($remove ? "del":"add").": @names "
if $Verbose;
if ($remove) {
foreach $sym (@names) { delete $imports{$sym} }
}
else {
@imports{@names} = (1) x @names;
}
}
@imports = keys %imports;
}
foreach $sym (@imports) {
if (!$exports{$sym}) {
if ($sym =~ m/^\d/) {
$pkg->require_version($sym);
# If the version number was the only thing specified
# then we should act as if nothing was specified:
if (@imports == 1) {
@imports = @exports;
last;
}
# We need a way to emulate 'use Foo ()' but still
# allow an easy version check: "use Foo 1.23, ''";
if (@imports == 2 and !$imports[1]) {
@imports = ();
last;
}
} elsif ($sym !~ s/^&// || !$exports{$sym}) {
require Carp;
Carp::carp(qq["$sym" is not exported by the $pkg module]);
$oops++;
}
}
}
if ($oops) {
require Carp;
Carp::croak("Can't continue after import errors");
}
}
else {
@imports = @exports;
}
*fail = *{"${pkg}::EXPORT_FAIL"};
if (@fail) {
if (!%fail) {
# Build cache of symbols. Optimise the lookup by adding
# barewords twice... both with and without a leading &.
# (Technique could be applied to %exports cache at cost of memory)
my @expanded = map { /^\w/ ? ($_, '&'.$_) : $_ } @fail;
warn "${pkg}::EXPORT_FAIL cached: @expanded" if $Verbose;
@fail{@expanded} = (1) x @expanded;
}
my @failed;
foreach $sym (@imports) { push(@failed, $sym) if $fail{$sym} }
if (@failed) {
@failed = $pkg->export_fail(@failed);
foreach $sym (@failed) {
require Carp;
Carp::carp(qq["$sym" is not implemented by the $pkg module ],
"on this architecture");
}
if (@failed) {
require Carp;
Carp::croak("Can't continue after import errors");
}
}
}
warn "Importing into $callpkg from $pkg: ",
join(", ",sort @imports) if $Verbose;
foreach $sym (@imports) {
# shortcut for the common case of no type character
(*{"${callpkg}::$sym"} = \&{"${pkg}::$sym"}, next)
unless $sym =~ s/^(\W)//;
$type = $1;
*{"${callpkg}::$sym"} =
$type eq '&' ? \&{"${pkg}::$sym"} :
$type eq '$' ? \${"${pkg}::$sym"} :
$type eq '@' ? \@{"${pkg}::$sym"} :
$type eq '%' ? \%{"${pkg}::$sym"} :
$type eq '*' ? *{"${pkg}::$sym"} :
do { require Carp; Carp::croak("Can't export symbol: $type$sym") };
}
}
sub export_to_level
{
my $pkg = shift;
my ($level, $junk) = (shift, shift); # need to get rid of first arg
# we know it already.
my $callpkg = caller($level);
$pkg->export($callpkg, @_);
}
sub import {
my $pkg = shift;
my $callpkg = caller($ExportLevel);
export $pkg, $callpkg, @_;
}
# Utility functions
sub _push_tags {
my($pkg, $var, $syms) = @_;
my $nontag;
*export_tags = \%{"${pkg}::EXPORT_TAGS"};
push(@{"${pkg}::$var"},
map { $export_tags{$_} ? @{$export_tags{$_}} : scalar(++$nontag,$_) }
(@$syms) ? @$syms : keys %export_tags);
if ($nontag and $^W) {
# This may change to a die one day
require Carp;
Carp::carp("Some names are not tags");
}
}
sub export_tags { _push_tags((caller)[0], "EXPORT", \@_) }
sub export_ok_tags { _push_tags((caller)[0], "EXPORT_OK", \@_) }
# Default methods
sub export_fail {
my $self = shift;
@_;
}
sub require_version {
my($self, $wanted) = @_;
my $pkg = ref $self || $self;
my $version = ${"${pkg}::VERSION"};
if (!$version or $version < $wanted) {
$version ||= "(undef)";
my $file = $INC{"$pkg.pm"};
$file &&= " ($file)";
require Carp;
Carp::croak("$pkg $wanted required--this is only version $version$file")
}
$version;
}
1;
今度はかなり手強いようです。
次章へ続く...