[perldocjp-cvs 1902] CVS update: docs/modules/warnings-1.23

Back to archive index

argra****@users***** argra****@users*****
2014年 11月 8日 (土) 16:51:42 JST


Index: docs/modules/warnings-1.23/warnings.pod
diff -u /dev/null docs/modules/warnings-1.23/warnings.pod:1.1
--- /dev/null	Sat Nov  8 16:51:42 2014
+++ docs/modules/warnings-1.23/warnings.pod	Sat Nov  8 16:51:42 2014
@@ -0,0 +1,1369 @@
+
+=encoding euc-jp
+
+=head1 NAME
+
+=begin original
+
+warnings - Perl pragma to control optional warnings
+
+=end original
+
+warnings - 選択的な警告を調整する Perl プラグマ
+
+=head1 SYNOPSIS
+
+    use warnings;
+    no warnings;
+
+    use warnings "all";
+    no warnings "all";
+
+    use warnings::register;
+    if (warnings::enabled()) {
+        warnings::warn("some warning");
+    }
+
+    if (warnings::enabled("void")) {
+        warnings::warn("void", "some warning");
+    }
+
+    if (warnings::enabled($object)) {
+        warnings::warn($object, "some warning");
+    }
+
+    warnings::warnif("some warning");
+    warnings::warnif("void", "some warning");
+    warnings::warnif($object, "some warning");
+
+=head1 DESCRIPTION
+
+=begin original
+
+The C<warnings> pragma gives control over which warnings are enabled in
+which parts of a Perl program.  It's a more flexible alternative for
+both the command line flag B<-w> and the equivalent Perl variable,
+C<$^W>.
+
+=end original
+
+C<use warnings> プラグマは、Perl プログラムのある部分に対してどの警告を
+有効にするかを制御できるようにします。
+これはコマンドラインオプション B<-w> および等価な Perl 変数 C<$^W> よりも
+より柔軟な代替案です。
+
+=begin original
+
+This pragma works just like the C<strict> pragma.
+This means that the scope of the warning pragma is limited to the
+enclosing block.  It also means that the pragma setting will not
+leak across files (via C<use>, C<require> or C<do>).  This allows
+authors to independently define the degree of warning checks that will
+be applied to their module.
+
+=end original
+
+このプラグマはちょうど C<strict> プラグマと同様に動作します。
+つまり、警告プラグマのスコープは閉じたブロック内に限定されます。
+また、プラグマ設定は (C<use>, C<require>, C<do> を通して)ファイルを超えて
+漏洩することはありません。
+これにより、モジュール作者は警告チェックの度合いを独立に
+設定できるようになります。
+
+=begin original
+
+By default, optional warnings are disabled, so any legacy code that
+doesn't attempt to control the warnings will work unchanged.
+
+=end original
+
+デフォルトでは、オプションの警告は無効なので、警告を制御しようとしない
+レガシーコードは変更なしで動作します。
+
+=begin original
+
+All warnings are enabled in a block by either of these:
+
+=end original
+
+あるブロック内で全ての警告を有効にするには以下のどちらかのようにします:
+
+    use warnings;
+    use warnings 'all';
+
+=begin original
+
+Similarly all warnings are disabled in a block by either of these:
+
+=end original
+
+同様に、あるブロック内で全ての警告を無効にするには以下のどちらかのように
+します:
+
+    no warnings;
+    no warnings 'all';
+
+=begin original
+
+For example, consider the code below:
+
+=end original
+
+例えば、以下のコードを考えます:
+
+    use warnings;
+    my @a;
+    {
+        no warnings;
+	my $b = @a[0];
+    }
+    my $c = @a[0];
+
+=begin original
+
+The code in the enclosing block has warnings enabled, but the inner
+block has them disabled.  In this case that means the assignment to the
+scalar C<$c> will trip the C<"Scalar value @a[0] better written as $a[0]">
+warning, but the assignment to the scalar C<$b> will not.
+
+=end original
+
+外側のブロックでは警告は有効ですが、内側のブロックでは無効です。
+この場合、スカラ C<$c> への代入では
+C<"Scalar value @a[0] better written as $a[0]"> 警告が出ますが、
+スカラ C<$b> への代入では出ません。
+
+=head2 Default Warnings and Optional Warnings
+
+(デフォルトの警告とオプションの警告)
+
+=begin original
+
+Before the introduction of lexical warnings, Perl had two classes of
+warnings: mandatory and optional. 
+
+=end original
+
+レキシカル警告の説明の前に、Perl は二つの警告クラスがあります:
+強制的(mandatory)とオプション(optional)です。
+
+=begin original
+
+As its name suggests, if your code tripped a mandatory warning, you
+would get a warning whether you wanted it or not.
+For example, the code below would always produce an C<"isn't numeric">
+warning about the "2:".
+
+=end original
+
+名前が示しているように、コードが強制的な警告に引っかかると、望むと
+望まな意図にかかわらず警告を出力します。
+例えば、以下のコードは "2:" の部分に対して常に C<"isn't numeric"> 警告を
+出力します。
+
+    my $a = "2:" + 3;
+
+=begin original
+
+With the introduction of lexical warnings, mandatory warnings now become
+I<default> warnings.  The difference is that although the previously
+mandatory warnings are still enabled by default, they can then be
+subsequently enabled or disabled with the lexical warning pragma.  For
+example, in the code below, an C<"isn't numeric"> warning will only
+be reported for the C<$a> variable.
+
+=end original
+
+レキシカルな警告の導入によって、強制的な警告は I<デフォルトの> 警告と
+なりました。
+違いは、以前の強制的な警告は今でもデフォルトで有効ですが、引き続く
+レキシカルな警告プラグマで有効/無効にに出来ることです。
+例えば、以下のコードでは、C<"isn't numeric"> 警告は C<$a> 変数に対してだけ
+報告されます。
+
+    my $a = "2:" + 3;
+    no warnings;
+    my $b = "2:" + 3;
+
+=begin original
+
+Note that neither the B<-w> flag or the C<$^W> can be used to
+disable/enable default warnings.  They are still mandatory in this case.
+
+=end original
+
+B<-w> オプションや C<$^W> はデフォルトの警告を無効/有効にするのには
+使えないことに注意してください。
+この場合は強制的なままです。
+
+=head2 What's wrong with B<-w> and C<$^W>
+
+(B<-w> や C<$^W> の何が悪いの?)
+
+=begin original
+
+Although very useful, the big problem with using B<-w> on the command
+line to enable warnings is that it is all or nothing.  Take the typical
+scenario when you are writing a Perl program.  Parts of the code you
+will write yourself, but it's very likely that you will make use of
+pre-written Perl modules.  If you use the B<-w> flag in this case, you
+end up enabling warnings in pieces of code that you haven't written.
+
+=end original
+
+警告を有効にするのにコマンドラインで B<-w> を使うというのはとても
+便利ですが、オールオアナッシングであるという問題があります。
+Perl のプログラムを書いているときのよくある状況を考えます。
+コードの一部はあなた自身が書きますが、かなり確実に既に書かれている
+Perl モジュールを利用します。
+このような場合に B<-w> フラグを使うと、あなたが書いていないコードに
+対しても警告を有効にすることになります。
+
+=begin original
+
+Similarly, using C<$^W> to either disable or enable blocks of code is
+fundamentally flawed.  For a start, say you want to disable warnings in
+a block of code.  You might expect this to be enough to do the trick:
+
+=end original
+
+同様に、コードブロックで有効または無効にするために C<$^W> を使うことにも
+本質的な欠点があります。
+まず、コードブロックで警告を無効にしたいとします。
+以下のようにすれば十分だと考えるかもしれません:
+
+     {
+         local ($^W) = 0;
+	 my $a =+ 2;
+	 my $b; chop $b;
+     }
+
+=begin original
+
+When this code is run with the B<-w> flag, a warning will be produced
+for the C<$a> line:  C<"Reversed += operator">.
+
+=end original
+
+このコードが B<-w> フラグ付きで実行されると、C<$a> の行で警告が
+出ます: C<"Reversed += operator">。
+
+=begin original
+
+The problem is that Perl has both compile-time and run-time warnings.  To
+disable compile-time warnings you need to rewrite the code like this:
+
+=end original
+
+問題は、Perl にはコンパイル時警告と実行時警告があると言うことです。
+コンパイル時警告を無効にするには、以下のようにコードを書き直す必要が
+あります:
+
+     {
+         BEGIN { $^W = 0 }
+	 my $a =+ 2;
+	 my $b; chop $b;
+     }
+
+=begin original
+
+The other big problem with C<$^W> is the way you can inadvertently
+change the warning setting in unexpected places in your code.  For example,
+when the code below is run (without the B<-w> flag), the second call
+to C<doit> will trip a C<"Use of uninitialized value"> warning, whereas
+the first will not.
+
+=end original
+
+C<$^W> に関するもう一つの問題は、コード中の予想外の位置の設定で不用意に
+警告設定が変わるということです。
+例えば、以下のコードが(B<-w> フラグなしで)実行されると、C<doit> の
+2 回目の呼び出しで C<"Use of uninitialized value"> 警告が出ますが、
+1 回目では出ません。
+
+    sub doit
+    {
+        my $b; chop $b;
+    }
+
+    doit();
+
+    {
+        local ($^W) = 1;
+        doit()
+    }
+
+=begin original
+
+This is a side-effect of C<$^W> being dynamically scoped.
+
+=end original
+
+これは C<$^W> が動的スコープを持つことの副作用です。
+
+=begin original
+
+Lexical warnings get around these limitations by allowing finer control
+over where warnings can or can't be tripped.
+
+=end original
+
+レキシカルな警告は、どこで警告に引っかかるか引っかからないかに関して
+より精度の高い制御をすることで、これらの制限を回避します。
+
+=head2 Controlling Warnings from the Command Line
+
+(コマンドラインから警告を制御する)
+
+=begin original
+
+There are three Command Line flags that can be used to control when
+warnings are (or aren't) produced:
+
+=end original
+
+いつ警告が発生する(あるいは発生しない)かを制御するために使われる
+三つのコマンドラインフラグがあります:
+
+=over 5
+
+=item B<-w>
+X<-w>
+
+=begin original
+
+This is  the existing flag.  If the lexical warnings pragma is B<not>
+used in any of you code, or any of the modules that you use, this flag
+will enable warnings everywhere.  See L<Backward Compatibility> for
+details of how this flag interacts with lexical warnings.
+
+=end original
+
+これは既存のフラグです。
+レキシカル警告プラグマがあなたのコードやあなたが使っているモジュールの
+どこでも B<使われていない> なら、このフラグは全ての場所で警告を
+有効にします。
+このフラグがレキシカル警告とどのように相互作用するかに関する詳細については
+L<Backward Compatibility> を参照してください。
+
+=item B<-W>
+X<-W>
+
+=begin original
+
+If the B<-W> flag is used on the command line, it will enable all warnings
+throughout the program regardless of whether warnings were disabled
+locally using C<no warnings> or C<$^W =0>.
+This includes all files that get
+included via C<use>, C<require> or C<do>.
+Think of it as the Perl equivalent of the "lint" command.
+
+=end original
+
+コマンドラインで B<-W> フラグが使われると、プログラム中で
+C<no warnings> や C<$^W =0> を使って警告を無効にしていても無視して、全ての
+警告を有効にします。
+これは C<use>, C<require>, C<do> 経由で読み込まれる全てのファイルにも
+適用されます。
+Perl 用の "lint" コマンドの等価物と考えられます。 
+
+=item B<-X>
+X<-X>
+
+=begin original
+
+Does the exact opposite to the B<-W> flag, i.e. it disables all warnings.
+
+=end original
+
+正確に B<-W> フラグの逆を行います; つまり、全ての警告を無効にします。
+
+=back
+
+=head2 Backward Compatibility
+
+(後方互換性)
+
+=begin original
+
+If you are used to working with a version of Perl prior to the
+introduction of lexically scoped warnings, or have code that uses both
+lexical warnings and C<$^W>, this section will describe how they interact.
+
+=end original
+
+レキシカルスコープ警告が導入される前のバージョンの Perl で動作させていたり、
+レキシカル警告と C<$^W> の両方のコードがある場合、この節はこれらが
+どのように相互作用するかを記述しています。
+
+=begin original
+
+How Lexical Warnings interact with B<-w>/C<$^W>:
+
+=end original
+
+レキシカル警告と B<-w>/C<$^W> の相互作用:
+
+=over 5
+
+=item 1.
+
+=begin original
+
+If none of the three command line flags (B<-w>, B<-W> or B<-X>) that
+control warnings is used and neither C<$^W> nor the C<warnings> pragma
+are used, then default warnings will be enabled and optional warnings
+disabled.
+This means that legacy code that doesn't attempt to control the warnings
+will work unchanged.
+
+=end original
+
+警告を制御する三つのコマンドラインフラグ (B<-w>, B<-W> or B<-X>) の
+どれも使われておらず、C<$^W> や the C<warnings> プラグマも使われていない
+場合、デフォルトの警告が有効になり、オプションの警告は無効になります。
+これにより、警告を制御しようとしないレガシーコードは無変更で動作します。
+
+=item 2.
+
+=begin original
+
+The B<-w> flag just sets the global C<$^W> variable as in 5.005.  This
+means that any legacy code that currently relies on manipulating C<$^W>
+to control warning behavior will still work as is. 
+
+=end original
+
+5.005 から B<-w> フラグはグローバルな C<$^W> 変数を設定します。
+これにより、警告の振る舞いを制御するために C<$^W> を操作することに
+依存しているレガシーコードはそのままで動作します。
+
+=item 3.
+
+=begin original
+
+Apart from now being a boolean, the C<$^W> variable operates in exactly
+the same horrible uncontrolled global way, except that it cannot
+disable/enable default warnings.
+
+=end original
+
+真偽値になったことは別として、C<$^W> 変数は正確に同じ恐ろしく
+制御不能なグローバルな方法で操作しますが、デフォルトの警告を有効化/
+無効化することは出来ません。
+
+=item 4.
+
+=begin original
+
+If a piece of code is under the control of the C<warnings> pragma,
+both the C<$^W> variable and the B<-w> flag will be ignored for the
+scope of the lexical warning.
+
+=end original
+
+コード片が C<warnings> プラグマの制御下にある場合、C<$^W> 変数と
+B<-w> フラグの両方はレキシカル警告のスコープで無視されます。
+
+=item 5.
+
+=begin original
+
+The only way to override a lexical warnings setting is with the B<-W>
+or B<-X> command line flags.
+
+=end original
+
+レキシカル警告設定を上書きする唯一の方法は B<-W> または B<-X>
+コマンドラインフラグを使うことです。
+
+=back
+
+=begin original
+
+The combined effect of 3 & 4 is that it will allow code which uses
+the C<warnings> pragma to control the warning behavior of $^W-type
+code (using a C<local $^W=0>) if it really wants to, but not vice-versa.
+
+=end original
+
+3 & 4 の組み合わせの効果により、本当に警告したいときに $^W 型のコードの
+警告の振る舞いを (C<local $^W=0> を使って) 制御するために
+C<warnings> プラグマを使えますが、逆はできません。
+
+=head2 Category Hierarchy
+X<warning, categories>
+
+(カテゴリ階層)
+
+=begin original
+
+A hierarchy of "categories" have been defined to allow groups of warnings
+to be enabled/disabled in isolation.
+
+=end original
+
+「カテゴリ」の階層は、警告のグループを分離して警告を有効/無効にできるように
+するために定義されています。
+
+=begin original
+
+The current hierarchy is:
+
+=end original
+
+現在の階層は:
+
+    all -+
+         |
+         +- closure
+         |
+         +- deprecated
+         |
+         +- exiting
+         |
+         +- experimental --+
+         |                 |
+         |                 +- experimental::autoderef
+         |                 |
+         |                 +- experimental::lexical_subs
+         |                 |
+         |                 +- experimental::lexical_topic
+         |                 |
+         |                 +- experimental::postderef
+         |                 |
+         |                 +- experimental::regex_sets
+         |                 |
+         |                 +- experimental::signatures
+         |                 |
+         |                 +- experimental::smartmatch
+         |
+         +- glob
+         |
+         +- imprecision
+         |
+         +- io ------------+
+         |                 |
+         |                 +- closed
+         |                 |
+         |                 +- exec
+         |                 |
+         |                 +- layer
+         |                 |
+         |                 +- newline
+         |                 |
+         |                 +- pipe
+         |                 |
+         |                 +- syscalls
+         |                 |
+         |                 +- unopened
+         |
+         +- misc
+         |
+         +- numeric
+         |
+         +- once
+         |
+         +- overflow
+         |
+         +- pack
+         |
+         +- portable
+         |
+         +- recursion
+         |
+         +- redefine
+         |
+         +- regexp
+         |
+         +- severe --------+
+         |                 |
+         |                 +- debugging
+         |                 |
+         |                 +- inplace
+         |                 |
+         |                 +- internal
+         |                 |
+         |                 +- malloc
+         |
+         +- signal
+         |
+         +- substr
+         |
+         +- syntax --------+
+         |                 |
+         |                 +- ambiguous
+         |                 |
+         |                 +- bareword
+         |                 |
+         |                 +- digit
+         |                 |
+         |                 +- illegalproto
+         |                 |
+         |                 +- parenthesis
+         |                 |
+         |                 +- precedence
+         |                 |
+         |                 +- printf
+         |                 |
+         |                 +- prototype
+         |                 |
+         |                 +- qw
+         |                 |
+         |                 +- reserved
+         |                 |
+         |                 +- semicolon
+         |
+         +- taint
+         |
+         +- threads
+         |
+         +- uninitialized
+         |
+         +- unpack
+         |
+         +- untie
+         |
+         +- utf8 ----------+
+         |                 |
+         |                 +- non_unicode
+         |                 |
+         |                 +- nonchar
+         |                 |
+         |                 +- surrogate
+         |
+         +- void
+
+=begin original
+
+Just like the "strict" pragma any of these categories can be combined
+
+=end original
+
+"strict" プラグマと同様、これらのカテゴリは組み合わせることができます
+
+    use warnings qw(void redefine);
+    no warnings qw(io syntax untie);
+
+=begin original
+
+Also like the "strict" pragma, if there is more than one instance of the
+C<warnings> pragma in a given scope the cumulative effect is additive. 
+
+=end original
+
+これも "strict" プラグマと同様、現在のスコープに複数の
+C<warnings> プラグマの実体があるときは、効果は加算されます。
+
+    use warnings qw(void); # only "void" warnings enabled
+    ...
+    use warnings qw(io);   # only "void" & "io" warnings enabled
+    ...
+    no warnings qw(void);  # only "io" warnings enabled
+
+=begin original
+
+To determine which category a specific warning has been assigned to see
+L<perldiag>.
+
+=end original
+
+ある特定の警告がどのカテゴリに割り当てられているかを知るには
+L<perldiag> を参照してください。
+
+=begin original
+
+Note: Before Perl 5.8.0, the lexical warnings category "deprecated" was a
+sub-category of the "syntax" category.  It is now a top-level category
+in its own right.
+
+=end original
+
+注意: Perl 5.8.0 以前では、レキシカル警告カテゴリ "deprecated" は "syntax"
+カテゴリの副カテゴリでした。
+今ではそれ自体でトップレベルカテゴリです。
+
+=head2 Fatal Warnings
+X<warning, fatal>
+
+(致命的警告)
+
+=begin original
+
+The presence of the word "FATAL" in the category list will escalate any
+warnings detected from the categories specified in the lexical scope
+into fatal errors.  In the code below, the use of C<time>, C<length>
+and C<join> can all produce a C<"Useless use of xxx in void context">
+warning.
+
+=end original
+
+カテゴリ一覧中に "FATAL" の文字があると、レキシカルスコープで
+指定されたカテゴリで検出された全ての警告を致命的エラーに昇格させます。
+以下のコードでは、C<time>, C<length>, C<join> の使用は全て
+C<"Useless use of xxx in void context"> 警告を出力します。
+
+    use warnings;
+
+    time;
+
+    {
+        use warnings FATAL => qw(void);
+        length "abc";
+    }
+
+    join "", 1,2,3;
+
+    print "done\n";
+
+=begin original
+
+When run it produces this output
+
+=end original
+
+実行すると、以下の出力を生成します
+
+    Useless use of time in void context at fatal line 3.
+    Useless use of length in void context at fatal line 7.  
+
+=begin original
+
+The scope where C<length> is used has escalated the C<void> warnings
+category into a fatal error, so the program terminates immediately when it
+encounters the warning.
+
+=end original
+
+C<length> が使われているスコープでは C<void> 警告カテゴリを致命的エラーに
+昇格させるので、この警告に出会うとプログラムは直ちに終了します。
+
+=begin original
+
+To explicitly turn off a "FATAL" warning you just disable the warning
+it is associated with.  So, for example, to disable the "void" warning
+in the example above, either of these will do the trick:
+
+=end original
+
+明示的に "FATAL" 警告をオフにするには、単に関連する警告を無効にします。
+それで、例えば、上述の例で "void" 警告を無効にするには、以下の二つの
+技のどちらかを使います:
+
+    no warnings qw(void);
+    no warnings FATAL => qw(void);
+
+=begin original
+
+If you want to downgrade a warning that has been escalated into a fatal
+error back to a normal warning, you can use the "NONFATAL" keyword.  For
+example, the code below will promote all warnings into fatal errors,
+except for those in the "syntax" category.
+
+=end original
+
+致命的エラーに昇格した警告を通常の警告に降格させたい場合、
+"NONFATAL" きーわーどが使えます。
+例えば、以下のコードは "syntax" カテゴリ以外の全ての警告を致命的エラーに
+昇格させます。
+
+    use warnings FATAL => 'all', NONFATAL => 'syntax';
+
+=begin original
+
+As of Perl 5.20, instead of C<< use warnings FATAL => 'all'; >> you can
+use:
+
+=end original
+
+Perl 5.20 から、C<< use warnings FATAL => 'all'; >> の代わりに以下のものが
+使えます:
+
+   use v5.20;       # Perl 5.20 or greater is required for the following
+   use warnings 'FATAL';  # short form of "use warnings FATAL => 'all';"
+
+=begin original
+
+If you want your program to be compatible with versions of Perl before
+5.20, you must use C<< use warnings FATAL => 'all'; >> instead.  (In
+previous versions of Perl, the behavior of the statements
+C<< use warnings 'FATAL'; >>, C<< use warnings 'NONFATAL'; >> and
+C<< no warnings 'FATAL'; >> was unspecified; they did not behave as if
+they included the C<< => 'all' >> portion.  As of 5.20, they do.)
+
+=end original
+
+5.20 以前の Perl との互換性が必要なら、代わりに
+C<< use warnings FATAL => 'all'; >> を使わなければなりません。
+(以前のバージョンの Perl では C<< use warnings 'FATAL'; >>,
+C<< use warnings 'NONFATAL'; >>, C<< no warnings 'FATAL'; >> という文の
+振る舞いは未定義です; C<< => 'all' >> 部を含むようには振る舞いません。
+5.20 からはそうなります。)
+
+=begin original
+
+B<NOTE:> Users of FATAL warnings, especially
+those using C<< FATAL => 'all' >>
+should be fully aware that they are risking future portability of their
+programs by doing so.  Perl makes absolutely no commitments to not
+introduce new warnings, or warnings categories in the future, and indeed
+we explicitly reserve the right to do so.  Code that may not warn now may
+warn in a future release of Perl if the Perl5 development team deems it
+in the best interests of the community to do so.  Should code using FATAL
+warnings break due to the introduction of a new warning we will NOT
+consider it an incompatible change.  Users of FATAL warnings should take
+special caution during upgrades to check to see if their code triggers
+any new warnings and should pay particular attention to the fine print of
+the documentation of the features they use to ensure they do not exploit
+features that are documented as risky, deprecated, or unspecified, or where
+the documentation says "so don't do that", or anything with the same sense
+and spirit.  Use of such features in combination with FATAL warnings is
+ENTIRELY AT THE USER'S RISK.
+
+=end original
+
+B<注意:> FATAL 警告の使用、特に C<< FATAL => 'all' >> の使用は、
+そうすることによる将来の移植性のリスクによく注意する必要があります。
+Perl は将来新しい警告や警告カテゴリを導入しないという保証は全くなく、
+明示的にそうする権利を保留します。
+そうするのがコミュニティにとって最良であると Perl5 開発チームが判断すれば、
+現在警告されていないコードが将来警告されるかもしれません。
+新しい警告の導入によって FATAL 警告を使っているコードが壊れても、これは
+互換性のない変更とは考えません。
+FATAL 警告を使う場合は、コードが新しい警告を引き起こさないかを調べて、
+特に、文書に、リスクがある、廃止予定、未定義、「しないでください」と
+書いてある、あるいは同じような意味と精神の機能を乱用しないように、機能の文書に
+特に注意を払うべきです。
+これらの機能を FATAL 警告と組み合わせるのは自身のリスクで行ってください。
+
+=head2 Reporting Warnings from a Module
+X<warning, reporting> X<warning, registering>
+
+(モジュールから警告を報告する)
+
+=begin original
+
+The C<warnings> pragma provides a number of functions that are useful for
+module authors.  These are used when you want to report a module-specific
+warning to a calling module has enabled warnings via the C<warnings>
+pragma.
+
+=end original
+
+C<warnings> プラグマはモジュール作者にとって有用ないくつかの関数を
+提供します。
+C<warnings> プラグマ経由で有効になったモジュール固有の警告を呼び出し元に
+報告するときに使われます。
+
+=begin original
+
+Consider the module C<MyMod::Abc> below.
+
+=end original
+
+以下の C<MyMod::Abc> モジュールを考えます。
+
+    package MyMod::Abc;
+
+    use warnings::register;
+
+    sub open {
+        my $path = shift;
+        if ($path !~ m#^/#) {
+            warnings::warn("changing relative path to /var/abc")
+                if warnings::enabled();
+            $path = "/var/abc/$path";
+        }
+    }
+
+    1;
+
+=begin original
+
+The call to C<warnings::register> will create a new warnings category
+called "MyMod::Abc", i.e. the new category name matches the current
+package name.  The C<open> function in the module will display a warning
+message if it gets given a relative path as a parameter.  This warnings
+will only be displayed if the code that uses C<MyMod::Abc> has actually
+enabled them with the C<warnings> pragma like below.
+
+=end original
+
+C<warnings::register> の呼び出しにより、"MyMod::Abc" という名前の新しい
+警告カテゴリを作成します; つまり、新しいカテゴリ名は現在のパッケージ名に
+一致します。
+このモジュールの C<open> 関数は、引数として相対パスが与えられると
+警告メッセージを出力します。
+この警告は、C<MyMod::Abc> を使うコードが 以下のようにして
+C<warnings> によって有効にされた場合にのみ出力されます。
+
+    use MyMod::Abc;
+    use warnings 'MyMod::Abc';
+    ...
+    abc::open("../fred.txt");
+
+=begin original
+
+It is also possible to test whether the pre-defined warnings categories are
+set in the calling module with the C<warnings::enabled> function.  Consider
+this snippet of code:
+
+=end original
+
+また、C<warnings::enabled> 関数を使って、既に定義されているカテゴリが
+呼び出しモジュールで設定されているかどうかをテストすることも可能です。
+以下のコード片を考えます:
+
+    package MyMod::Abc;
+
+    sub open {
+        warnings::warnif("deprecated", 
+                         "open is deprecated, use new instead");
+        new(@_);
+    }
+
+    sub new
+    ...
+    1;
+
+=begin original
+
+The function C<open> has been deprecated, so code has been included to
+display a warning message whenever the calling module has (at least) the
+"deprecated" warnings category enabled.  Something like this, say.
+
+=end original
+
+C<open> 関数は非推奨なので、呼び出しモジュールで (少なくとも)
+"deprecated" 警告カテゴリが有効のとき警告を出力するコードが含まれています。
+つまりこんな感じです。
+
+    use warnings 'deprecated';
+    use MyMod::Abc;
+    ...
+    MyMod::Abc::open($filename);
+
+=begin original
+
+Either the C<warnings::warn> or C<warnings::warnif> function should be
+used to actually display the warnings message.  This is because they can
+make use of the feature that allows warnings to be escalated into fatal
+errors.  So in this case
+
+=end original
+
+実際に警告メッセージを出力するには、C<warnings::warn> 関数と
+C<warnings::warnif> 関数のどちらかを使うべきです。
+これは、警告を致命的エラーに昇格させる機能を使えるようにするためです。
+それで、このような場合:
+
+    use MyMod::Abc;
+    use warnings FATAL => 'MyMod::Abc';
+    ...
+    MyMod::Abc::open('../fred.txt');
+
+=begin original
+
+the C<warnings::warnif> function will detect this and die after
+displaying the warning message.
+
+=end original
+
+C<warnings::warnif> 関数はこれを検出して、警告を出力した後 die します。
+
+=begin original
+
+The three warnings functions, C<warnings::warn>, C<warnings::warnif>
+and C<warnings::enabled> can optionally take an object reference in place
+of a category name.  In this case the functions will use the class name
+of the object as the warnings category.
+
+=end original
+
+三つの警告関数 C<warnings::warn>, C<warnings::warnif>,
+C<warnings::enabled> は、オプションとしてカテゴリ名の代わりにオブジェクトの
+リファレンスをとることができます。
+この場合関数は警告カテゴリとしてオブジェクトのクラス名を使います。
+
+=begin original
+
+Consider this example:
+
+=end original
+
+この例を考えます:
+
+    package Original;
+
+    no warnings;
+    use warnings::register;
+
+    sub new
+    {
+        my $class = shift;
+        bless [], $class;
+    }
+
+    sub check
+    {
+        my $self = shift;
+        my $value = shift;
+
+        if ($value % 2 && warnings::enabled($self))
+          { warnings::warn($self, "Odd numbers are unsafe") }
+    }
+
+    sub doit
+    {
+        my $self = shift;
+        my $value = shift;
+        $self->check($value);
+        # ...
+    }
+
+    1;
+
+    package Derived;
+
+    use warnings::register;
+    use Original;
+    our @ISA = qw( Original );
+    sub new
+    {
+        my $class = shift;
+        bless [], $class;
+    }
+
+    1;
+
+=begin original
+
+The code below makes use of both modules, but it only enables warnings from 
+C<Derived>.
+
+=end original
+
+以下のコードは両方のモジュールを使っていますが、C<Derived> からの警告だけを
+有効にしています。
+
+    use Original;
+    use Derived;
+    use warnings 'Derived';
+    my $a = Original->new();
+    $a->doit(1);
+    my $b = Derived->new();
+    $a->doit(1);
+
+=begin original
+
+When this code is run only the C<Derived> object, C<$b>, will generate
+a warning. 
+
+=end original
+
+このコードが C<Derived> オブジェクトからのみ実行されているとき、
+C<$b> は警告を出力します。
+
+    Odd numbers are unsaf****@main***** line 7
+
+=begin original
+
+Notice also that the warning is reported at the line where the object is first
+used.
+
+=end original
+
+オブジェクトが最初に使われた行で警告が報告されることにも注意してください。
+
+=begin original
+
+When registering new categories of warning, you can supply more names to
+warnings::register like this:
+
+=end original
+
+警告の新しいカテゴリを登録するとき、以下のようにして warnings::register に
+さらなる名前を提供できます:
+
+    package MyModule;
+    use warnings::register qw(format precision);
+
+    ...
+
+    warnings::warnif('MyModule::format', '...');
+
+=head1 FUNCTIONS
+
+(関数)
+
+=over 4
+
+=item use warnings::register
+
+=begin original
+
+Creates a new warnings category with the same name as the package where
+the call to the pragma is used.
+
+=end original
+
+プラグマを呼び出したパッケージと同じ名前の新しい警告カテゴリを作成します。
+
+=item warnings::enabled()
+
+=begin original
+
+Use the warnings category with the same name as the current package.
+
+=end original
+
+現在のパッケージと同じ名前の警告カテゴリを使います。
+
+=begin original
+
+Return TRUE if that warnings category is enabled in the calling module.
+Otherwise returns FALSE.
+
+=end original
+
+呼ばれたモジュール内でその警告カテゴリが有効ならば真(TRUE)を返します。
+そうでなければ偽(FALSE)を返します。
+
+=item warnings::enabled($category)
+
+=begin original
+
+Return TRUE if the warnings category, C<$category>, is enabled in the
+calling module.
+Otherwise returns FALSE.
+
+=end original
+
+呼ばれたモジュール内で警告カテゴリ(C<$category>)が有効ならば真
+(TRUE)を返します。
+そうでなければ偽(FALSE)を返します。
+
+=item warnings::enabled($object)
+
+=begin original
+
+Use the name of the class for the object reference, C<$object>, as the
+warnings category.
+
+=end original
+
+オブジェクトリファレンス(C<$object>)のクラス名を警告カテゴリとして
+使います。
+
+=begin original
+
+Return TRUE if that warnings category is enabled in the first scope
+where the object is used.
+Otherwise returns FALSE.
+
+=end original
+
+そのオブジェクトが使われた最初のスコープ内でその警告カテゴリが有効ならば
+真(TRUE)を返します。
+そうでなければ偽(FALSE)を返します。
+
+=item warnings::fatal_enabled()
+
+=begin original
+
+Return TRUE if the warnings category with the same name as the current
+package has been set to FATAL in the calling module.
+Otherwise returns FALSE.
+
+=end original
+
+呼ばれたモジュール内で、現在のパッケージと同じ名前の警告カテゴリが FATAL に
+設定されているならば真(TRUE)を返します。
+そうでなければ偽(FALSE)を返します。
+
+=item warnings::fatal_enabled($category)
+
+=begin original
+
+Return TRUE if the warnings category C<$category> has been set to FATAL in
+the calling module.
+Otherwise returns FALSE.
+
+=end original
+
+呼ばれたモジュール内で、警告カテゴリ(C<$category>)が FATAL に
+設定されているならば真(TRUE)を返します。
+そうでなければ偽(FALSE)を返します。
+
+=item warnings::fatal_enabled($object)
+
+=begin original
+
+Use the name of the class for the object reference, C<$object>, as the
+warnings category.
+
+=end original
+
+オブジェクトリファレンス(C<$object>)のクラス名を警告カテゴリとして
+使います。
+
+=begin original
+
+Return TRUE if that warnings category has been set to FATAL in the first
+scope where the object is used.
+Otherwise returns FALSE.
+
+=end original
+
+そのオブジェクトが使われた最初のスコープ内でその警告カテゴリが FATAL に
+設定されているならば真(TRUE)を返します。
+そうでなければ偽(FALSE)を返します。
+
+=item warnings::warn($message)
+
+=begin original
+
+Print C<$message> to STDERR.
+
+=end original
+
+STDERR に C<$message> を出力します。
+
+=begin original
+
+Use the warnings category with the same name as the current package.
+
+=end original
+
+現在のパッケージと同じ名前の警告カテゴリを使います。
+
+=begin original
+
+If that warnings category has been set to "FATAL" in the calling module
+then die. Otherwise return.
+
+=end original
+
+もし、呼ばれたモジュール内でその警告カテゴリーに "FATAL" が
+設定されていたならば、終了(die)します。
+
+=item warnings::warn($category, $message)
+
+=begin original
+
+Print C<$message> to STDERR.
+
+=end original
+
+STDERR に C<$message> を出力します。
+
+=begin original
+
+If the warnings category, C<$category>, has been set to "FATAL" in the
+calling module then die. Otherwise return.
+
+=end original
+
+もし、呼ばれたモジュール内で警告カテゴリ(C<$category>)に "FATAL" が
+設定されていたならば、終了(die)します。
+
+=item warnings::warn($object, $message)
+
+=begin original
+
+Print C<$message> to STDERR.
+
+=end original
+
+STDERR に C<$message> を出力します。
+
+=begin original
+
+Use the name of the class for the object reference, C<$object>, as the
+warnings category.
+
+=end original
+
+オブジェクトリファレンス(C<$object>)のクラス名を警告カテゴリとして
+使います。
+
+=begin original
+
+If that warnings category has been set to "FATAL" in the scope where C<$object>
+is first used then die. Otherwise return.
+
+=end original
+
+もし、C<$object> が最初に使われたスコープ内でその警告カテゴリに
+"FATAL" が設定されていたならば、終了(die)します。
+
+=item warnings::warnif($message)
+
+=begin original
+
+Equivalent to:
+
+=end original
+
+以下のものと等価です:
+
+    if (warnings::enabled())
+      { warnings::warn($message) }
+
+=item warnings::warnif($category, $message)
+
+=begin original
+
+Equivalent to:
+
+=end original
+
+以下のものと等価です:
+
+    if (warnings::enabled($category))
+      { warnings::warn($category, $message) }
+
+=item warnings::warnif($object, $message)
+
+=begin original
+
+Equivalent to:
+
+=end original
+
+以下のものと等価です:
+
+    if (warnings::enabled($object))
+      { warnings::warn($object, $message) }
+
+=item warnings::register_categories(@names)
+
+=begin original
+
+This registers warning categories for the given names and is primarily for
+use by the warnings::register pragma.
+
+=end original
+
+これは指定された名前の警告カテゴリを登録します; 主に
+warnings::register プラグマで使われるものです。
+
+=back
+
+=begin original
+
+See also L<perlmodlib/Pragmatic Modules> and L<perldiag>.
+
+=end original
+
+L<perlmodlib/Pragmatic Modules> と L<perldiag> も見てください。
+
+=begin meta
+
+Translate: SHIRAKATA Kentaro <argra****@ub32*****>
+Status: completed
+
+=end meta
+
+=cut
+



perldocjp-cvs メーリングリストの案内
Back to archive index