Carp-1.26 > Carp


Carp - alternative warn and die for modules

Carp - モジュールのための warn と die の代替


    use Carp;

    # warn user (from perspective of caller)
    carp "string trimmed to 80 chars";

    # die of errors (from perspective of caller)
    croak "We're outta here!";

    # die of errors with stack backtrace
    confess "not implemented";

    # cluck not exported by default
    use Carp qw(cluck);
    cluck "This is how we got here!";


The Carp routines are useful in your own modules because they act like die() or warn(), but with a message which is more likely to be useful to a user of your module. In the case of cluck, confess, and longmess that context is a summary of every call in the call-stack. For a shorter message you can use carp or croak which report the error as being from where your module was called. There is no guarantee that that is where the error was, but it is a good educated guess.

Carpルーチンはモジュールで使う際に便利です。die()やwarn()と同じように 動きますが、モジュールのユーザーにより便利になります。cluck、confeess、longmess では、コールスタックの全ての呼び出しのサマリになります。 短いメッセージがよければ、carpcroakを使えます。 モジュールが呼ばれた場所からエラーをレポートします。エラーがどこで 起きたかは保証しませんが、良い根拠のある推測になります。

You can also alter the way the output and logic of Carp works, by changing some global variables in the Carp namespace. See the section on GLOBAL VARIABLES below.

出力とCarpの動作ロジックを変更することも出来ます。 Carpにあるグローバル変数を変更することで可能です。 後述の、GLOBAL VARIABLESのセクションを見てください。

Here is a more complete description of how carp and croak work. What they do is search the call-stack for a function call stack where they have not been told that there shouldn't be an error. If every call is marked safe, they give up and give a full stack backtrace instead. In other words they presume that the first likely looking potential suspect is guilty. Their rules for telling whether a call shouldn't generate errors work as follows:

以下は、carpcroakの動作の仕方の完全な説明です。 carpcroakがしていることは、エラーであるべきでないと教えている場所の 関数呼び出しのスタックのコールスタックの検索です。 もし、すべての呼び出しが安全とされていれば、諦めて、全てのスタックのバックトレースを 代わりに与えます。言い換えると、最初に見つかりそうな潜在的な容疑者を有罪と予想します。 呼び出しがエラーを生成すべきどうかを教えるルールは以下のように動きます:

  1. Any call from a package to itself is safe.


  2. Packages claim that there won't be errors on calls to or from packages explicitly marked as safe by inclusion in @CARP_NOT, or (if that array is empty) @ISA. The ability to override what @ISA says is new in 5.8.

    パッケージが@CARP_NOTか、(もし、配列が空の場合)@ISAに含まれていることで、 安全であると明示的にマークされたパッケージへの、または、パッケージからの呼び出しは エラーとみなさないとする。

  3. The trust in item 2 is transitive. If A trusts B, and B trusts C, then A trusts C. So if you do not override @ISA with @CARP_NOT, then this trust relationship is identical to, "inherits from".

    2により、AがBを信任するならば、BはCを信任し、AもCを信任する。 @ISA@CARP_NOTでオーバーライドしなければ、この信任の関係は、 "継承元"と同一になります。

  4. Any call from an internal Perl module is safe. (Nothing keeps user modules from marking themselves as internal to Perl, but this practice is discouraged.)

    内部のPerlモジュールからのどのような呼び出しも安全です。 (Perlの内部のものとしてユーザーのモジュールをマークすると、 ユーザーのモジュールを保持しませんが、この方法は推奨されません)

  5. Any call to Perl's warning system (eg Carp itself) is safe. (This rule is what keeps it from reporting the error at the point where you call carp or croak.)

    Perlの警告システム(例えば、Carp自身)のどのような呼び出しも安全です。 (このルールは、carpcroakを呼んだ時に、エラーのレポートから保持するものです)

  6. $Carp::CarpLevel can be set to skip a fixed number of additional call levels. Using this is not recommended because it is very difficult to get it to behave correctly.

    $Carp::CarpLevel 追加の呼び出しレベルの固定数をスキップするのに 使います。誠意角に動作させるのがとても難しいので、推奨されません。

Forcing a Stack Trace


As a debugging aid, you can force Carp to treat a croak as a confess and a carp as a cluck across all modules. In other words, force a detailed stack trace to be given. This can be very helpful when trying to understand why, or from where, a warning or error is being generated.

デバッグの助けとして、Carpにたいして、croak を confess として、 carp を cluckとして、すべてのモジュールにわたって、扱うことが出来ます。 言い換えると、詳細なスタックトレースを強制します。警告やエラーが生まれたのが どこからなのか、なぜなのかを理解しようとする際には、とても助かります。

This feature is enabled by 'importing' the non-existent symbol 'verbose'. You would typically enable it by saying

この機能は、存在しないシンボルの'verbose'を'インポート'のすることで、 有効になります。典型的に、次のようにします

    perl -MCarp=verbose

or by including the string -MCarp=verbose in the PERL5OPT environment variable.

または、文字列 -MCarp=verboseをPERL5OPT環境変数に含めておいても 同じです。

Alternately, you can set the global variable $Carp::Verbose to true. See the GLOBAL VARIABLES section below.

代わりに、グローバル変数 $Carp::Verboseを真にすることもできます。 後述のグローバル変数セクションを見てください。




This variable determines how many characters of a string-eval are to be shown in the output. Use a value of 0 to show all text.

この変数は文字列evalを出力する文字数を決めます。 0の場合、全てのテキストを表示します。

Defaults to 0.



This variable determines how many characters of each argument to a function to print. Use a value of 0 to show the full length of the argument.

この変数は出力される関数の引数の文字数を決めます。 0にすると、引数の全てを表示します。

Defaults to 64.



This variable determines how many arguments to each function to show. Use a value of 0 to show all arguments to a function call.

この変数は表示する引数の数を決めます。 0にすると、全ての引数を表示します。

Defaults to 8.



This variable makes carp and croak generate stack backtraces just like cluck and confess. This is how use Carp 'verbose' is implemented internally.

この変数はcarpcroackが、cluckconfessのように、 スタックバックトレースを出すようにします。 use Carp 'verbose'が 内部で実装されている方法です。

Defaults to 0.



This variable, in your package, says which packages are not to be considered as the location of an error. The carp() and cluck() functions will skip over callers when reporting where an error occurred.

この変数は、あなたのパッケージで、どのパッケージがエラーの場所として 考えないかを述べています。carp()cluck()関数はエラーが起きた場所を 報告する際に呼び出しをスキップします。

NB: This variable must be in the package's symbol table, thus:

要注意: この変数はパッケージのシンボルテーブルになければいけません。このように:

    # These work
    our @CARP_NOT; # file scope
    use vars qw(@CARP_NOT); # package scope
    @My::Package::CARP_NOT = ... ; # explicit package variable

    # These don't work
    sub xyz { ... @CARP_NOT = ... } # w/o declarations above
    my @CARP_NOT; # even at top-level

Example of use:


    package My::Carping::Package;
    use Carp;
    our @CARP_NOT;
    sub bar     { .... or _error('Wrong input') }
    sub _error  {
        # temporary control of where'ness, __PACKAGE__ is implicit
        local @CARP_NOT = qw(My::Friendly::Caller);

This would make Carp report the error as coming from a caller not in My::Carping::Package, nor from My::Friendly::Caller.

これにより、CarpMy::Carping::PackageでもMy::Friendly::Callerでもない 呼び出し元から来るものとしてエラーを報告します。

Also read the "DESCRIPTION" section above, about how Carp decides where the error is reported from.

上述のDESCRIPTIONセクションも呼んでください。どのようにCarpが エラーがどこから来たのかを決めているかについて書いています。

Use @CARP_NOT, instead of $Carp::CarpLevel.


Overrides Carp's use of @ISA.



This says what packages are internal to Perl. Carp will never report an error as being from a line in a package that is internal to Perl. For example:

Perlに、パッケージがPerlの内部のものだと伝えます。Carpは Perl内部のものであるパッケージの行から来るエラーを決して報告しません。 例えば:

    $Carp::Internal{ (__PACKAGE__) }++;
    # time passes...
    sub foo { ... or confess("whatever") };

would give a full stack backtrace starting from the first caller outside of __PACKAGE__. (Unless that package was also internal to Perl.)

__PACAKGE__の外の最初の呼び出しから、完全なスタックbacktraceが はじまります。(そのパッケージも同様にPerlの内部でなければ)


This says which packages are internal to Perl's warning system. For generating a full stack backtrace this is the same as being internal to Perl, the stack backtrace will not start inside packages that are listed in %Carp::CarpInternal. But it is slightly different for the summary message generated by carp or croak. There errors will not be reported on any lines that are calling packages in %Carp::CarpInternal.

この変数はPerlの警告システムにどのパッケージが内部のものであるかを教えます。 完全なスタックバックトレースを出すために、Perlに内部のものと同じであり、 %Carp::CarpInternalにリストされているパッケージの内側で、 スタックバックトレースは開始されません。ですが、carpcroakの サマリメッセージに弱化の違いがあります。%Carp::CarpInternalで 呼んでいるパッケージのどの行もエラーは報告されません。

For example Carp itself is listed in %Carp::CarpInternal. Therefore the full stack backtrace from confess will not start inside of Carp, and the short message from calling croak is not placed on the line where croak was called.

例えば、Carp自身は、%Carp::CarpInternalにリストされています。 そのため、confessの完全なスタックバックトレースには、Carpの内側で 始まることはありません。croakの呼び出しによる短いメッセージは croakが呼ばれた行にはなりません。


This variable determines how many additional call frames are to be skipped that would not otherwise be when reporting where an error occurred on a call to one of Carp's functions. It is fairly easy to count these call frames on calls that generate a full stack backtrace. However it is much harder to do this accounting for calls that generate a short message. Usually people skip too many call frames. If they are lucky they skip enough that Carp goes all of the way through the call stack, realizes that something is wrong, and then generates a full stack backtrace. If they are unlucky then the error is reported from somewhere misleading very high in the call stack.

この変数は、Carpの関数を呼び出すために、エラーが起きた場所を 報告する際に、通常スキップされない、フレームの呼び出しを何回 スキップするかを決めます。完全なバックトレースを生成する呼び出しで これらのコールフレームを数えるのは、かなり簡単です。 ですが、短いメッセージの呼び出しを計算するのは、大変です。 通常、多すぎるコールフレームはスキップしたいものです。 If they are lucky they skip enough that Carp goes all of the way through the call stack, realizes that something is wrong, and then generates a full stack backtrace. If they are unlucky then the error is reported from somewhere misleading very high in the call stack.

Therefore it is best to avoid $Carp::CarpLevel. Instead use @CARP_NOT, %Carp::Internal and %Carp::CarpInternal.

$Carp::CarpLevelは避けるのが一番良いです。代わりに @CARP_NOT%Carp::Internal%Carp::CarpInternalを使ってください。

Defaults to 0.



The Carp routines don't handle exception objects currently. If called with a first argument that is a reference, they simply call die() or warn(), as appropriate.

Carpルーチンは例外オブジェクトを現在のところ扱いません。 最初の引数がリファレンスでも、Carpのルーチンはそれに見合った、die() か warn() を 単純に呼び出します。


Carp::Always, Carp::Clan


The Carp module first appeared in Larry Wall's perl 5.000 distribution. Since then it has been modified by several of the perl 5 porters. Andrew Main (Zefram) <> divested Carp into an independent distribution.

Carpモジュールは最初に、Larry Wall の perl 5.000 ディストリビューションに登場しました。 それから、perl 5 ポーターズの数人の手で変更されています。 Andrew Main (Zefram) <>がCarpを独立したディストリビューションに しました。


Copyright (C) 1994-2012 Larry Wall

Copyright (C) 2011, 2012 Andrew Main (Zefram) <>


This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.