ext/PerlIO/Via/Via.pm

   1 package PerlIO::Via;
   2 our $VERSION = '0.01';
   3 use XSLoader ();
   4 XSLoader::load 'PerlIO::Via';
   5 1;
   6 __END__
   7
   8 =head1 NAME
   9
  10 PerlIO::Via - Helper class for PerlIO layers implemented in perl
  11
  12 =head1 SYNOPSIS
  13
  14    use Some::Package;
  15
  16    open($fh,"<:Via(Some::Package)",...);
  17
  18 =head1 DESCRIPTION
  19
  20 The package to be used as a layer should implement at least some of the
  21 following methods. In the method descriptions below I<$fh> will be
  22 a reference to a glob which can be treated as a perl file handle.
  23 It refers to the layer below. I<$fh> is not passed if the layer
  24 is at the bottom of the stack, for this reason and to maintain
  25 some level of "compatibility" with TIEHANDLE classes it is passed last.
  26
  27 As an example, in Perl release 5.8.0 the included MIME::QuotedPrint
  28 module defines the required TIEHANDLE methods so that you can say
  29
  30         use MIME::QuotedPrint;
  31         open(my $fh, ">Via(MIME::QuotedPrint)", "qp");
  32
  33 =over 4
  34
  35 =item $class->PUSHED([$mode[,$fh]])
  36
  37 Should return an object or the class, or -1 on failure.  (Compare
  38 TIEHANDLE.)  The arguments are an optional mode string ("r", "w",
  39 "w+", ...) and a filehandle for the PerlIO layer below.  Mandatory.
  40
  41 =item $obj->POPPED([$fh])
  42
  43 Optional - layer is about to be removed.
  44
  45 =item $class->OPEN($path,$mode[,$fh])
  46
  47 Not yet in use.
  48
  49 =item $class->FDOPEN($fd)
  50
  51 Not yet in use.
  52
  53 =item $class->SYSOPEN($path,$imode,$perm,$fh)
  54
  55 Not yet in use.
  56
  57 =item $obj->FILENO($fh)
  58
  59 Returns a numeric value for Unix-like file descriptor. Return -1 if
  60 there isn't one.  Optional.  Default is fileno($fh).
  61
  62 =item $obj->READ($buffer,$len,$fh)
  63
  64 Returns the number of octets placed in $buffer (must be less than or
  65 equal to $len).  Optional.  Default is to use FILL instead.
  66
  67 =item $obj->WRITE($buffer,$fh)
  68
  69 Returns the number of octets from buffer that have been sucessfully written.
  70
  71 =item $obj->FILL($fh)
  72
  73 Should return a string to be placed in the buffer.  Optional. If not
  74 provided must provide READ or reject handles open for reading in
  75 PUSHED.
  76
  77 =item $obj->CLOSE($fh)
  78
  79 Should return 0 on success, -1 on error.
  80 Optional.
  81
  82 =item $obj->SEEK($posn,$whence,$fh)
  83
  84 Should return 0 on success, -1 on error.
  85 Optional.  Default is to fail, but that is likely to be changed
  86 in future.
  87
  88 =item $obj->TELL($fh)
  89
  90 Returns file postion.
  91 Optional.  Default to be determined.
  92
  93 =item $obj->UNREAD($buffer,$fh)
  94
  95 Returns the number of octets from buffer that have been sucessfully
  96 saved to be returned on future FILL/READ calls.  Optional.  Default is
  97 to push data into a temporary layer above this one.
  98
  99 =item $obj->FLUSH($fh)
 100
 101 Flush any buffered write data.  May possibly be called on readable
 102 handles too.  Should return 0 on success, -1 on error.
 103
 104 =item $obj->SETLINEBUF($fh)
 105
 106 Optional. No return.
 107
 108 =item $obj->CLEARERR($fh)
 109
 110 Optional. No return.
 111
 112 =item $obj->ERROR($fh)
 113
 114 Optional. Returns error state. Default is no error until a mechanism
 115 to signal error (die?) is worked out.
 116
 117 =item $obj->EOF($fh)
 118
 119 Optional. Returns end-of-file state. Default is function of return
 120 value of FILL or READ.
 121
 122 =back
 123
 124 =head2 Example - a Hexadecimal Handle
 125
 126 Given the following module, Hex.pm:
 127
 128     package Hex;
 129
 130     sub PUSHED
 131     {
 132      my ($class,$mode,$fh) = @_;
 133      # When writing we buffer the data
 134      my $buf = '';
 135      return bless \$buf,$class;
 136     }
 137
 138     sub FILL
 139     {
 140      my ($obj,$fh) = @_;
 141      my $line = <$fh>;
 142      return (defined $line) ? pack("H*", $line) : undef;
 143     }
 144
 145     sub WRITE
 146     {
 147      my ($obj,$buf,$fh) = @_;
 148      $$obj .= unpack("H*", $buf);
 149      return length($buf);
 150     }
 151
 152     sub FLUSH
 153     {
 154      my ($obj,$fh) = @_;
 155      print $fh $$obj or return -1;
 156      $$obj = '';
 157      return 0;
 158     }
 159
 160     1;
 161
 162 the following code opens up an output handle that will convert any
 163 output to hexadecimal dump of the output bytes: for example "A" will
 164 be converted to "41" (on ASCII-based machines, on EBCDIC platforms
 165 the "A" will become "c1")
 166
 167     use Hex;
 168     open(my $fh, ">:Via(Hex)", "foo.hex");
 169
 170 and the following code will read the hexdump in and convert it
 171 on the fly back into bytes:
 172
 173     open(my $fh, "<:Via(Hex)", "foo.hex");
 174
 175 =cut
 176
 177