c532915cee3eb4a1e4565a98724cde762c929eb3
[gitmo/Moose.git] / lib / Moose / Error / Default.pm
1 package Moose::Error::Default;
2
3 use strict;
4 use warnings;
5
6 our $VERSION   = '1.19';
7 $VERSION = eval $VERSION;
8 our $AUTHORITY = 'cpan:STEVAN';
9
10 use Carp::Heavy;
11 use Class::MOP::MiniTrait;
12
13 use base 'Class::MOP::Object';
14
15 Class::MOP::MiniTrait::apply(__PACKAGE__, 'Moose::Meta::Object::Trait');
16
17 sub new {
18     my ( $self, @args ) = @_;
19     if (defined $ENV{MOOSE_ERROR_STYLE} && $ENV{MOOSE_ERROR_STYLE} eq 'croak') {
20         $self->create_error_croak( @args );
21     }
22     else {
23         $self->create_error_confess( @args );
24     }
25 }
26
27 sub create_error_croak {
28     my ( $self, @args ) = @_;
29     $self->_create_error_carpmess( @args );
30 }
31
32 sub create_error_confess {
33     my ( $self, @args ) = @_;
34     $self->_create_error_carpmess( @args, longmess => 1 );
35 }
36
37 sub _create_error_carpmess {
38     my ( $self, %args ) = @_;
39
40     my $carp_level = 3 + ( $args{depth} || 1 );
41     local $Carp::MaxArgNums = 20; # default is 8, usually we use named args which gets messier though
42
43     my @args = exists $args{message} ? $args{message} : ();
44
45     if ( $args{longmess} || $Carp::Verbose ) {
46         local $Carp::CarpLevel = ( $Carp::CarpLevel || 0 ) + $carp_level;
47         return Carp::longmess(@args);
48     } else {
49         return Carp::ret_summary($carp_level, @args);
50     }
51 }
52
53 __PACKAGE__
54
55 __END__
56
57 =pod
58
59 =head1 NAME
60
61 Moose::Error::Default - L<Carp> based error generation for Moose.
62
63 =head1 DESCRIPTION
64
65 This class implements L<Carp> based error generation.
66
67 The default behavior is like L<Moose::Error::Confess>. To override this to
68 default to L<Moose::Error::Croak>'s behaviour on a system wide basis, set the
69 MOOSE_ERROR_STYLE environment variable to C<croak>. The use of this
70 environment variable is considered experimental, and may change in a future
71 release.
72
73 =head1 METHODS
74
75 =over 4
76
77 =item B<< Moose::Error::Default->new(@args) >>
78
79 Create a new error. Delegates to C<create_error_confess> or
80 C<create_error_croak>.
81
82 =item B<< $error->create_error_confess(@args) >>
83
84 =item B<< $error->create_error_croak(@args) >>
85
86 Creates a new errors string of the specified style.
87
88 =back
89
90 =cut
91
92