runtime/parrot/library/Parrot/Exception.pir

   1 =head1 TITLE
   2
   3 Parrot::Exception - Auxiliary methods for Exceptions
   4
   5 =head1 VERSION
   6
   7  $Id$
   8
   9 =head1 SYNOPSIS
  10
  11         load_bytecode 'Parrot/Exception.pbc'
  12         # ...
  13         $S0 = 'XYZ'
  14         $P0 = get_class 'Exception'
  15         $P1 = $P0.'new'('Error in "', $S0, '" module')
  16         throw $P1
  17
  18 =head1 DESCRIPTION
  19
  20 This module provides some additional support for using Parrot's
  21 built-in Exception class.  The principal method is C<new>, which
  22 simplifies the task of building and populating Exception objects.
  23
  24 =head2 Methods
  25
  26 =over 4
  27
  28 =item new([arg, ...])
  29
  30 Build an C<Exception> object, initializing its message component
  31 to be the concatenation of any arguments supplied.  Returns the
  32 newly created C<Exception>.
  33
  34 =cut
  35
  36 .namespace [ 'Exception' ]
  37
  38 .sub 'new' :method
  39     .param pmc args            :slurpy
  40     .local pmc ex
  41     .local string message
  42     ex = new 'Exception'
  43     if null args goto end
  44     message = join '', args
  45     ex['_message'] = message
  46   end:
  47     .return (ex)
  48 .end
  49
  50 =back
  51
  52 =head1 AUTHOR
  53
  54 Patrick R. Michaud <pmichaud@pobox.com>
  55
  56 =head1 COPYRIGHT
  57
  58 Copyright (C) 2007-2008, The Perl Foundation.
  59
  60 =cut
  61
  62 # Local Variables:
  63 #   mode: pir
  64 #   fill-column: 100
  65 # End:
  66 # vim: expandtab shiftwidth=4 ft=pir: