ext/Parrot-Embed/lib/Parrot/Embed.pm

   1 package Parrot::Embed;
   2
   3 # $Id$
   4
   5 use strict;
   6 use warnings;
   7
   8 our $VERSION = '0.02';
   9
  10 use base qw(DynaLoader Exporter);
  11
  12 our @EXPORT_OK = qw(Parrot_revision);
  13
  14 Parrot::Embed->bootstrap($VERSION);
  15
  16 1;
  17
  18 __END__
  19
  20 =head1 NAME
  21
  22 Parrot::Embed - use Parrot from Perl 5
  23
  24 =head1 VERSION
  25
  26 Version 0.02
  27
  28 =head1 SYNOPSIS
  29
  30   use Parrot::Embed qw(Parrot_revision);
  31
  32 =head1 DESCRIPTION
  33
  34 This module embeds libparrot in Perl 5 programs.  You can load Parrot bytecode,
  35 compile your own code, and call Parrot subroutines and send and receive values
  36 to them.
  37
  38 It provides the core implementation used by the L<Parrot::Interpreter> module.
  39 Do consider using L<Parrot::Interpreter> first however.  See also
  40 L<Parrot::PMC>.
  41
  42 The only useful interface provided by this module is Parrot_revision().
  43
  44 =head2 Parrot_revision()
  45
  46 Returns the integer revision number of the embedded libparrot.
  47
  48 =head1 AUTHOR
  49
  50 chromatic, C<< <chromatic at wgz.org> >>
  51
  52 =head1 BUGS
  53
  54 Please report any bugs or feature requests to the Parrot Porters mailing list.
  55 Someday there may be a CPAN version of this code.  Who knows?
  56
  57 =head1 COPYRIGHT & LICENSE
  58
  59 Copyright (C) 2006-2007 The Perl Foundation / chromatic.
  60
  61 This program is free software; you can redistribute it and/or modify it
  62 under the same terms as Parrot itself.
  63
  64 =cut
  65
  66 # Local Variables:
  67 #   mode: cperl
  68 #   cperl-indent-level: 4
  69 #   fill-column: 100
  70 # End:
  71 # vim: expandtab shiftwidth=4: