12.1 モジュールのインターフェースを定義する

Perl Cookbook

標準モジュールのExporterによって、自分のモジュールへの外部インタフェースを定義する。

  • YourModule.pmと言うモジュールファイルに次のコードを書く。
package YourModule;
use strict;
our (@ISA, @EXPORT, @EXPORT_OK, %EXPORT_TAGS, $VERSION);

use Exporter;
$VERSION = 1.00;
@ISA = qw(Exporter);

@EXPORT = qw(...);   # 自動エクスポートするシンボル(:DEFAULTタグ)
@EXPORT_OK = qw(...);    # 要求に応じて、エクスポートするシンボル
%EXPORT_TAGS = (    # シンボルのセットの名前を定義する
   TAG1 => [...],
   TAG2 => [...],
   ...
};

####################
# コードをここに書く
####################

1;    # 最後は必ずこの行でなければならない。
  • 別のファイルでYourModuleを使用する場合
use YourModule;   # デフォルトのシンボルをパッケージにインポートする。
use YourModule qw(...);   # 指定したシンボルをパッケージにインポートする。
use YourModule ();   # シンボルを全くインポートしない。
use YourModule qw(:TAG1);   # タグセット全体をインポートする。