Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / lib / site_perl / 5.8.0 / Pastel / Exception.pm

# $Id: Exception.pm,v 1.3 2003/04/29 18:18:05 malay Exp $\r
# Perl module for Pastel::Exception\r
# Author: Malay < curiouser@ccmp.ap.nic.in >\r
# Copyright Malay\r
# You may distribute this module under the same terms as perl itself\r
\r
# POD documentation - main docs before the code\r
\r
=head1 NAME\r
\r
Pastel::Exception - A module for easy exception handling in Pastel.\r
\r
=head1 SYNOPSIS\r
\r
#For thowing exception from any module\r
\r
use Pastel;\r
# Creating an exception object has the advantage of calling \r
# the full stack trace. If the catch() method in the Pastel::Exception\r
# class is not overridden, throwing an exception with a Exception object\r
# as parameter will call the full stack trace.\r
\r
$self->throw(Pastel::Exception("Miserable condition"));\r
\r
or,\r
\r
$self->throw("Miserable condition"); \r
# If not caught it just calls croak "Miserable condition"\r
\r
or,\r
\r
$self->throw(); \r
# If not caught it just calls croak "Unknown error";\r
\r
\r
# Catching an exception from a module\r
# You need to overide the catch() of Exception class\r
\r
$self->throw(Pastel::Exception("Some error");\r
\r
sub catch {\r
 my ($self, $exception) = @_;\r
 $exception->print_stack_trace(); # Give full stack trace\r
 print $exception->get_message(); # prints "Some error"\r
 croak "Miserable death\n";\r
} \r
\r
\r
\r
=head1 DESCRIPTION\r
\r
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 catch() method, or by simply Creating a Pastel::Exception object and using its throw method. The exception is caught automatically by the Pastel::Exception::catch().  \r
\r
=head1 CONTACT\r
\r
Malay <curiouser@ccmb.ap.nic.in>\r
\r
=cut\r
\r
# Let the code begin...\r
\r
package Pastel::Exception;\r
use Carp;\r
use strict;\r
\r
=head1 CONSTRUCTOR\r
\r
=head2 new($string)\r
\r
 Usage    :  Pastel::Exception->new("Some error");\r
             or, Pastel::Exception->new();\r
 Function :  Creates and returns a Pastel::Exception object\r
 Returns  :  Pastel::Exception object\r
 Arguments:  A string (optional);\r
\r
=cut\r
\r
sub new {\r
    my ( $class, $string ) = shift;\r
\r
    my $self = {};\r
    bless $self, ref($class) || $class;\r
    if ($string) {\r
        $self->{message} = $string;\r
    }\r
    else {\r
        $self->{message} = "Unknown error";\r
    }\r
    return $self;\r
}\r
\r
=head1 METHODS\r
\r
=head2 throw()\r
\r
 Usage:    $self->throw($e); # Inherited from Pastel::Exception class\r
           or, $self->throw();\r
           or, $self->throw($string);\r
 Function: Throws an exception.\r
 Returns:   Nothing \r
 Arguments: Either an Pastel::Exception object or a string or nothing\r
\r
=cut\r
\r
sub throw {\r
    my ( $self, $e ) = @_;\r
    if ( $self->can('catch') ) {\r
        $self->catch($e);\r
    }\r
}\r
\r
=head2 catch()\r
\r
 Usage    : Should never be directly used. To use this function, override \r
            this function after inheriting from Pastel::Exception. \r
 Function : Catches an exception\r
 Returns  : Nothing\r
 Arguments: The function is always called with the same parameter when thrown.\r
            May be a string or an Exception object or null. Should always be \r
            tested with isa() before use.\r
\r
=cut\r
\r
sub catch {\r
    my ( $self, $e ) = @_;\r
    print STDERR "\nException reached the root exception class!\n";\r
    if ( defined($e) && $e->isa('Pastel::Exception') ) {\r
        $e->print_stack_trace();\r
        croak "\n", $e->get_message(), "\n";\r
    }\r
    elsif ( defined($e) ) {\r
	$self->print_stack_trace();\r
        croak $e, "\n";\r
    }\r
    else {\r
        croak "Unknown error!\n";\r
    }\r
\r
}\r
\r
=head2 print_stack_trace()\r
\r
 Usage    : $exception_object->print_stack_trace(); \r
 Function : Prints complete stack trace of the call.\r
 Returns  : Nothing\r
 Arguments: Nothing\r
\r
=cut\r
\r
\r
sub print_stack_trace {\r
    my $self = shift;\r
\r
    #my(@a) = caller();\r
    #print "@a", "\n";\r
    print STDERR "\n--------------------------------------------\n";\r
    print STDERR "                  STACK TRACE                 \n";\r
    print STDERR "--------------------------------------------\n";\r
\r
    my $i = 0;\r
    while (1) {\r
        my (@b) = caller($i);\r
        if ( !@b ) {\r
\r
            last;\r
        }\r
        my @c = ();\r
        foreach my $element (@b) {\r
            if ($element) {\r
                $c[@c] = $element;\r
            }\r
        }\r
        print STDERR "Package  : $c[0]\n";\r
        print STDERR "File     : $c[1]\n";\r
        print STDERR "Line No  : $c[2]\n";\r
        if ( $c[3] ) {\r
            print STDERR "Function : $c[3]\n";\r
        }\r
        print STDERR "--------------------------------------------\n";\r
        $i++;\r
    }\r
\r
    #print "@b", "\n";\r
}\r
\r
\r
=head2 get_message()\r
\r
 Usage    : $exception_object->get_message() \r
 Function : Return the message stored in the exception object.\r
 Returns  : A scalar containg the massage string.\r
 Arguments: Nothing\r
\r
=cut\r
\r
\r
sub get_message {\r
    return $_[0]->{message};\r
}\r
1;\r