lib/Language/Befunge/Wrapping.pm

   1 #
   2 # This file is part of Language::Befunge.
   3 # Copyright (c) 2001-2008 Jerome Quelin, all rights reserved.
   4 #
   5 # This program is free software; you can redistribute it and/or modify
   6 # it under the same terms as Perl itself.
   7 #
   8 #
   9
  10 package Language::Befunge::Wrapping;
  11
  12 use strict;
  13 use warnings;
  14
  15 use base qw{ Class::Accessor::Fast };
  16
  17 # -- CONSTRUCTOR
  18
  19 #
  20 # provided by Class::Accessor::Fast
  21 #
  22
  23
  24 # -- PUBLIC METHODS
  25
  26 #
  27 # $wrapping->wrap( $storage, $ip );
  28 #
  29 # Wrap $ip in $storage according to this module wrapping algorithm. Note
  30 # that $ip is already out of bounds, ie, it has been moved once by LBI.
  31 # As a side effect, $ip will have its position changed.
  32 #
  33 # LBW implements a wrapping that dies. It's meant to be overridden by
  34 # other wrapping classes.
  35 #
  36 sub wrap { die 'wrapping not implemented in LBW'; }
  37
  38 1;
  39 __END__
  40
  41
  42 =head1 NAME
  43
  44 Language::Befunge::Wrapping - base wrapping class
  45
  46
  47 =head1 DESCRIPTION
  48
  49 C<LBW> implements a wrapping that dies. It's meant to be overridden by
  50 other wrapping classes.
  51
  52
  53
  54 =head1 CONSTRUCTOR
  55
  56 =head2 LBW->new;
  57
  58 Creates a new wrapping object.
  59
  60
  61 =head1 PUBLIC METHODS
  62
  63 =head2 $wrapping->wrap( $storage, $ip )
  64
  65 Wrap C<$ip> in C<$storage> according to this module wrapping algorithm.
  66 See L<DESCRIPTION> for an overview of the algorithm used.
  67
  68 Note that C<$ip> is already out of bounds, ie, it has been moved once by
  69 LBI.
  70
  71 As a side effect, $ip will have its position changed.
  72
  73
  74
  75 =head1 SEE ALSO
  76
  77 L<Language::Befunge>.
  78
  79
  80 =head1 AUTHOR
  81
  82 Jerome Quelin, C<< <jquelin@cpan.org> >>
  83
  84
  85 =head1 COPYRIGHT & LICENSE
  86
  87 Copyright (c) 2001-2008 Jerome Quelin, all rights reserved.
  88
  89 This program is free software; you can redistribute it and/or modify
  90 it under the same terms as Perl itself.
  91
  92
  93 =cut
  94