Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / Pastel::Exception.3
.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Pastel::Exception 3"
.TH Pastel::Exception 3 "2003-04-29" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
Pastel::Exception \- A module for easy exception handling in Pastel.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
#For thowing exception from any module
.PP
use Pastel;
# Creating an exception object has the advantage of calling
# the full stack trace. If the \fIcatch()\fR method in the Pastel::Exception
# class is not overridden, throwing an exception with a Exception object
# as parameter will call the full stack trace.
.PP
$self\->throw(Pastel::Exception(\*(L"Miserable condition\*(R"));
.PP
or,
.PP
$self\->throw(\*(L"Miserable condition\*(R");
# If not caught it just calls croak \*(L"Miserable condition\*(R"
.PP
or,
.PP
$self\->\fIthrow()\fR;
# If not caught it just calls croak \*(L"Unknown error\*(R";
.PP
# Catching an exception from a module
# You need to overide the \fIcatch()\fR of Exception class
.PP
$self\->throw(Pastel::Exception(\*(L"Some error\*(R");
.PP
sub catch {
my ($self, \f(CW$exception\fR) = \f(CW@_\fR;
\f(CW$exception\fR\->\fIprint_stack_trace()\fR; # Give full stack trace
print \f(CW$exception\fR\->\fIget_message()\fR; # prints \*(L"Some error\*(R"
croak \*(L"Miserable death\en\*(R";
}
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Pastel::Exception is the root class of handling exception in Pastel. There are two ways exception can be handled. Either inheriting from Pastel::Exception andoverriding \fIcatch()\fR method, or by simply Creating a Pastel::Exception object and using its throw method. The exception is caught automatically by the \fIPastel::Exception::catch()\fR.
.SH "CONTACT"
.IX Header "CONTACT"
Malay <curiouser@ccmb.ap.nic.in>
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.Sh "new($string)"
.IX Subsection "new($string)"
.Vb 5
\& Usage : Pastel::Exception->new("Some error");
\& or, Pastel::Exception->new();
\& Function : Creates and returns a Pastel::Exception object
\& Returns : Pastel::Exception object
\& Arguments: A string (optional);
.Ve
.SH "METHODS"
.IX Header "METHODS"
.Sh "\fIthrow()\fP"
.IX Subsection "throw()"
.Vb 6
\& Usage: $self->throw($e); # Inherited from Pastel::Exception class
\& or, $self->throw();
\& or, $self->throw($string);
\& Function: Throws an exception.
\& Returns: Nothing
\& Arguments: Either an Pastel::Exception object or a string or nothing
.Ve
.Sh "\fIcatch()\fP"
.IX Subsection "catch()"
.Vb 7
\& Usage : Should never be directly used. To use this function, override
\& this function after inheriting from Pastel::Exception.
\& Function : Catches an exception
\& Returns : Nothing
\& Arguments: The function is always called with the same parameter when thrown.
\& May be a string or an Exception object or null. Should always be
\& tested with isa() before use.
.Ve
.Sh "\fIprint_stack_trace()\fP"
.IX Subsection "print_stack_trace()"
.Vb 4
\& Usage : $exception_object->print_stack_trace();
\& Function : Prints complete stack trace of the call.
\& Returns : Nothing
\& Arguments: Nothing
.Ve
.Sh "\fIget_message()\fP"
.IX Subsection "get_message()"
.Vb 4
\& Usage : $exception_object->get_message()
\& Function : Return the message stored in the exception object.
\& Returns : A scalar containg the massage string.
\& Arguments: Nothing
.Ve