1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
# ------------------------------------------------------------------------------
# Copyright (C) 2006-2021 British Crown (Met Office) & Contributors.
#
# This file is part of FCM, tools for managing and building source code.
#
# FCM is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# FCM is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with FCM. If not, see <http://www.gnu.org/licenses/>.
# ------------------------------------------------------------------------------
use strict;
use warnings;
# ------------------------------------------------------------------------------
package FCM::Exception;
use Data::Dumper qw{Dumper};
use Scalar::Util qw{blessed};
use overload (q{""} => \&Dumper);
use constant {
DEFAULT => 'DEFAULT',
};
# Returns true if $e is a blessed instance of $class.
sub caught {
my ($class, $e) = @_;
return (blessed($e) && $e->isa($class));
}
# Throws the exception.
sub throw {
my ($class, $code, $ctx, $e) = @_;
if (defined($e) && !ref($e) && $e =~ qr{\A\s*\z}msx) {
$e = undef;
}
die(bless({code => $code, ctx => $ctx, exception => $e}, $class));
}
# Attribute accessors.
for my $name (qw{code ctx exception}) {
no strict qw{refs};
*{"get_$name"} = sub {$_[0]->{$name}};
}
# ------------------------------------------------------------------------------
1;
__END__
=head1 NAME
FCM::Exception
=head1 SYNOPSIS
use FCM::Exception;
my $E = 'FCM::Exception';
eval {
# ...
if ($some_error_condition) {
return $E->throw($code, $ctx);
}
# ...
};
if (my $e = $@) {
if ($E->caught($e)) {
# ...
}
}
=head1 DESCRIPTION
Exception associated with an FCM operation.
=head1 METHODS
=over 4
=item $class->caught($e)
Returns true if $e is a blessed object of $class.
=item $class->throw($code,$ctx,$e)
Creates an instance and die() with it.
=item $e->get_code()
Returns the code associated with this exception.
=item $e->get_ctx()
Returns the context associated with this exception.
=item $e->get_exception()
Returns the exception that generates this exception.
=back
=head1 COPYRIGHT
Copyright (C) 2006-2021 British Crown (Met Office) & Contributors.
=cut
|
