WWWWWW

Current Directory: /usr/local/share/man/man3
Viewing File: /usr/local/share/man/man3/IO::WrapTie.3pm
.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "IO::WrapTie 3"
.TH IO::WrapTie 3 "2020-01-17" "perl v5.26.3" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
IO::WrapTie \- wrap tieable objects in IO::Handle interface
.PP
This is currently Alpha code, released for comments.
  Please give me your feedback!
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
First of all, you'll need \fBtie()\fR, so:
.PP
.Vb 1
\&   require 5.004;
.Ve
.PP
\&\fIFunction interface (experimental).\fR
Use this with any existing class...
.PP
.Vb 2
\&   use IO::WrapTie;
\&   use FooHandle;                  ### implements TIEHANDLE interface
\&
\&   ### Suppose we want a "FooHandle\->new(&FOO_RDWR, 2)".
\&   ### We can instead say...
\&
\&   $FH = wraptie(\*(AqFooHandle\*(Aq, &FOO_RDWR, 2);
\&
\&   ### Now we can use...
\&   print $FH "Hello, ";            ### traditional operator syntax...
\&   $FH\->print("world!\en");         ### ...and OO syntax as well!
.Ve
.PP
\&\fI\s-1OO\s0 interface (preferred).\fR
You can inherit from the \*(L"Slave\*(R" in IO::WrapTie mixin to get a
nifty \f(CW\*(C`new_tie()\*(C'\fR constructor...
.PP
.Vb 2
\&   #\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&   package FooHandle;                        ### a class which can TIEHANDLE
\&
\&   use IO::WrapTie;
\&   @ISA = qw(IO::WrapTie::Slave);            ### inherit new_tie()
\&   ...
\&
\&
\&   #\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
\&   package main;
\&
\&   $FH = FooHandle\->new_tie(&FOO_RDWR, 2);   ### $FH is an IO::WrapTie::Master
\&   print $FH "Hello, ";                      ### traditional operator syntax
\&   $FH\->print("world!\en");                   ### OO syntax
.Ve
.PP
See IO::Scalar as an example.  It also shows you how to create classes
which work both with and without 5.004.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Suppose you have a class \f(CW\*(C`FooHandle\*(C'\fR, where...
.IP "\(bu" 4
\&\f(CW\*(C`FooHandle\*(C'\fR does not inherit from IO::Handle. That is, it performs
file handle-like I/O, but to something other than an underlying
file descriptor. Good examples are IO::Scalar (for printing to a
string) and IO::Lines (for printing to an array of lines).
.IP "\(bu" 4
\&\f(CW\*(C`FooHandle\*(C'\fR implements the \f(CW\*(C`TIEHANDLE\*(C'\fR interface (see perltie).
That is, it provides methods \f(CW\*(C`TIEHANDLE\*(C'\fR, \f(CW\*(C`GETC\*(C'\fR, \f(CW\*(C`PRINT\*(C'\fR, \f(CW\*(C`PRINTF\*(C'\fR,
\&\f(CW\*(C`READ\*(C'\fR, and \f(CW\*(C`READLINE\*(C'\fR.
.IP "\(bu" 4
\&\f(CW\*(C`FooHandle\*(C'\fR implements the traditional \s-1OO\s0 interface of
FileHandle and IO::Handle. i.e., it contains methods like \f(CW\*(C`getline\*(C'\fR,
\&\f(CW\*(C`read\*(C'\fR, \f(CW\*(C`print\*(C'\fR, \f(CW\*(C`seek\*(C'\fR, \f(CW\*(C`tell\*(C'\fR, \f(CW\*(C`eof\*(C'\fR, etc.
.PP
Normally, users of your class would have two options:
.IP "\(bu" 4
\&\fBUse only \s-1OO\s0 syntax,\fR and forsake named I/O operators like \f(CW\*(C`print\*(C'\fR.
.IP "\(bu" 4
\&\fBUse with tie,\fR and forsake treating it as a first-class object
(i.e., class-specific methods can only be invoked through the underlying
object via \f(CW\*(C`tied\*(C'\fR... giving the object a \*(L"split personality\*(R").
.PP
But now with IO::WrapTie, you can say:
.PP
.Vb 4
\&    $WT = wraptie(\*(AqFooHandle\*(Aq, &FOO_RDWR, 2);
\&    $WT\->print("Hello, world\en");   ### OO syntax
\&    print $WT "Yes!\en";             ### Named operator syntax too!
\&    $WT\->weird_stuff;               ### Other methods!
.Ve
.PP
And if you're authoring a class like \f(CW\*(C`FooHandle\*(C'\fR, just have it inherit
from \f(CW\*(C`IO::WrapTie::Slave\*(C'\fR and that first line becomes even prettier:
.PP
.Vb 1
\&    $WT = FooHandle\->new_tie(&FOO_RDWR, 2);
.Ve
.PP
\&\fBThe bottom line:\fR now, almost any class can look and work exactly like
an IO::Handle and be used both with \s-1OO\s0 and non-OO file handle syntax.
.SH "HOW IT ALL WORKS"
.IX Header "HOW IT ALL WORKS"
.SS "The data structures"
.IX Subsection "The data structures"
Consider this example code, using classes in this distribution:
.PP
.Vb 2
\&    use IO::Scalar;
\&    use IO::WrapTie;
\&
\&    $WT = wraptie(\*(AqIO::Scalar\*(Aq,\e$s);
\&    print $WT "Hello, ";
\&    $WT\->print("world!\en");
.Ve
.PP
In it, the \f(CW\*(C`wraptie\*(C'\fR function creates a data structure as follows:
.PP
.Vb 10
\&                          * $WT is a blessed reference to a tied filehandle
\&              $WT           glob; that glob is tied to the "Slave" object.
\&               |          * You would do all your i/o with $WT directly.
\&               |
\&               |
\&               |     ,\-\-\-isa\-\-> IO::WrapTie::Master >\-\-isa\-\-> IO::Handle
\&               V    /
\&        .\-\-\-\-\-\-\-\-\-\-\-\-\-.
\&        |             |
\&        |             |   * Perl i/o operators work on the tied object,
\&        |  "Master"   |     invoking the C<TIEHANDLE> methods.
\&        |             |   * Method invocations are delegated to the tied
\&        |             |     slave.
\&        \`\-\-\-\-\-\-\-\-\-\-\-\-\-\*(Aq
\&               |
\&    tied(*$WT) |     .\-\-\-isa\-\-> IO::WrapTie::Slave
\&               V    /
\&        .\-\-\-\-\-\-\-\-\-\-\-\-\-.
\&        |             |
\&        |   "Slave"   |   * Instance of FileHandle\-like class which doesn\*(Aqt
\&        |             |     actually use file descriptors, like IO::Scalar.
\&        |  IO::Scalar |   * The slave can be any kind of object.
\&        |             |   * Must implement the C<TIEHANDLE> interface.
\&        \`\-\-\-\-\-\-\-\-\-\-\-\-\-\*(Aq
.Ve
.PP
\&\fI\s-1NOTE:\s0\fR just as an IO::Handle is really just a blessed reference to a
\&\fItraditional\fR file handle glob. So also, an \f(CW\*(C`IO::WrapTie::Master\*(C'\fR
is really just a blessed reference to a file handle
glob \fIwhich has been tied to some \*(L"slave\*(R" class.\fR
.ie n .SS "How ""wraptie"" works"
.el .SS "How \f(CWwraptie\fP works"
.IX Subsection "How wraptie works"
.IP "1." 4
The call to function \f(CW\*(C`wraptie(SLAVECLASS, TIEARGS...)\*(C'\fR is
passed onto \f(CW\*(C`IO::WrapTie::Master::new()\*(C'\fR.
Note that class \f(CW\*(C`IO::WrapTie::Master\*(C'\fR is a subclass of IO::Handle.
.IP "2." 4
The \f(CW\*(C`IO::WrapTie::Master\->new\*(C'\fR method creates a new IO::Handle object,
re-blessed into class \f(CW\*(C`IO::WrapTie::Master\*(C'\fR. This object is the \fImaster\fR,
which will be returned from the constructor. At the same time...
.IP "3." 4
The \f(CW\*(C`new\*(C'\fR method also creates the \fIslave\fR: this is an instance
of \f(CW\*(C`SLAVECLASS\*(C'\fR which is created by tying the master's IO::Handle
to \f(CW\*(C`SLAVECLASS\*(C'\fR via \f(CW\*(C`tie\*(C'\fR.
This call to \f(CW\*(C`tie\*(C'\fR creates the slave in the following manner:
.IP "4." 4
Class \f(CW\*(C`SLAVECLASS\*(C'\fR is sent the message \f(CW\*(C`TIEHANDLE\*(C'\fR; it
will usually delegate this to \f(CW\*(C`SLAVECLASS\->new(TIEARGS)\*(C'\fR, resulting
in a new instance of \f(CW\*(C`SLAVECLASS\*(C'\fR being created and returned.
.IP "5." 4
Once both master and slave have been created, the master is returned
to the caller.
.SS "How I/O operators work (on the master)"
.IX Subsection "How I/O operators work (on the master)"
Consider using an i/o operator on the master:
.PP
.Vb 1
\&    print $WT "Hello, world!\en";
.Ve
.PP
Since the master \f(CW$WT\fR is really a \f(CW\*(C`blessed\*(C'\fR reference to a glob,
the normal Perl I/O operators like \f(CW\*(C`print\*(C'\fR may be used on it.
They will just operate on the symbol part of the glob.
.PP
Since the glob is tied to the slave, the slave's \f(CW\*(C`PRINT\*(C'\fR method
(part of the \f(CW\*(C`TIEHANDLE\*(C'\fR interface) will be automatically invoked.
.PP
If the slave is an IO::Scalar, that means \*(L"\s-1PRINT\*(R"\s0 in IO::Scalar will be
invoked, and that method happens to delegate to the \f(CW\*(C`print\*(C'\fR method
of the same class.  So the \fIreal\fR work is ultimately done by
\&\*(L"print\*(R" in IO::Scalar.
.SS "How methods work (on the master)"
.IX Subsection "How methods work (on the master)"
Consider using a method on the master:
.PP
.Vb 1
\&    $WT\->print("Hello, world!\en");
.Ve
.PP
Since the master \f(CW$WT\fR is blessed into the class \f(CW\*(C`IO::WrapTie::Master\*(C'\fR,
Perl first attempts to find a \f(CW\*(C`print\*(C'\fR method there.  Failing that,
Perl next attempts to find a \f(CW\*(C`print\*(C'\fR method in the super class,
IO::Handle.  It just so happens that there \fIis\fR such a method;
that method merely invokes the \f(CW\*(C`print\*(C'\fR I/O operator on the self object...
and for that, see above!
.PP
But let's suppose we're dealing with a method which \fIisn't\fR part
of IO::Handle... for example:
.PP
.Vb 1
\&    my $sref = $WT\->sref;
.Ve
.PP
In this case, the intuitive behavior is to have the master delegate the
method invocation to the slave (now do you see where the designations
come from?).  This is indeed what happens: \f(CW\*(C`IO::WrapTie::Master\*(C'\fR contains
an \f(CW\*(C`AUTOLOAD\*(C'\fR method which performs the delegation.
.PP
So: when \f(CW\*(C`sref\*(C'\fR can't be found in IO::Handle, the \f(CW\*(C`AUTOLOAD\*(C'\fR method
of \f(CW\*(C`IO::WrapTie::Master\*(C'\fR is invoked, and the standard behavior of
delegating the method to the underlying slave (here, an IO::Scalar)
is done.
.PP
Sometimes, to get this to work properly, you may need to create
a subclass of \f(CW\*(C`IO::WrapTie::Master\*(C'\fR which is an effective master for
\&\fIyour\fR class, and do the delegation there.
.SH "NOTES"
.IX Header "NOTES"
\&\fBWhy not simply use the object's \s-1OO\s0 interface?\fR
.PP
Because that means forsaking the use of named operators
like \f(CW\*(C`print\*(C'\fR, and you may need to pass the object to a subroutine
which will attempt to use those operators:
.PP
.Vb 2
\&    $O = FooHandle\->new(&FOO_RDWR, 2);
\&    $O\->print("Hello, world\en");  ### OO syntax is okay, BUT....
\&
\&    sub nope { print $_[0] "Nope!\en" }
\& X  nope($O);                     ### ERROR!!! (not a glob ref)
.Ve
.PP
\&\fBWhy not simply use \fBtie()\fB?\fR
    Because (1) you have to use \f(CW\*(C`tied\*(C'\fR to invoke methods in the
object's public interface (yuck), and (2) you may need to pass
the tied symbol to another subroutine which will attempt to treat
it in an OO-way... and that will break it:
.PP
.Vb 2
\&    tie *T, \*(AqFooHandle\*(Aq, &FOO_RDWR, 2;
\&    print T "Hello, world\en";   ### Operator is okay, BUT...
\&
\&    tied(*T)\->other_stuff;      ### yuck! AND...
\&
\&    sub nope { shift\->print("Nope!\en") }
\& X  nope(\e*T);                  ### ERROR!!! (method "print" on unblessed ref)
.Ve
.PP
\&\fBWhy a master and slave?\fR
.PP
.Vb 6
\&    Why not simply write C<FooHandle> to inherit from L<IO::Handle?>
\&I tried this, with an implementation similar to that of L<IO::Socket>.
\&The problem is that I<the whole point is to use this with objects
\&that don\*(Aqt have an underlying file/socket descriptor.>.
\&Subclassing L<IO::Handle> will work fine for the OO stuff, and fine with
\&named operators I<if> you C<tie>... but if you just attempt to say:
\&
\&    $IO = FooHandle\->new(&FOO_RDWR, 2);
\&    print $IO "Hello!\en";
.Ve
.PP
you get a warning from Perl like:
.PP
.Vb 1
\&    Filehandle GEN001 never opened
.Ve
.PP
because it's trying to do system-level I/O on an (unopened) file
descriptor.  To avoid this, you apparently have to \f(CW\*(C`tie\*(C'\fR the handle...
which brings us right back to where we started!  At least the
IO::WrapTie mixin lets us say:
.PP
.Vb 2
\&    $IO = FooHandle\->new_tie(&FOO_RDWR, 2);
\&    print $IO "Hello!\en";
.Ve
.PP
and so is not \fItoo\fR bad.  \f(CW\*(C`:\-)\*(C'\fR
.SH "WARNINGS"
.IX Header "WARNINGS"
Remember: this stuff is for doing FileHandle\-like I/O on things
\&\fIwithout underlying file descriptors\fR.  If you have an underlying
file descriptor, you're better off just inheriting from IO::Handle.
.PP
\&\fBBe aware that \fBnew_tie()\fB always returns an instance of a
kind of IO::WrapTie::Master...\fR it does \fBnot\fR return an instance
of the I/O class you're tying to!
.PP
Invoking some methods on the master object causes \f(CW\*(C`AUTOLOAD\*(C'\fR to delegate
them to the slave object... so it \fIlooks\fR like you're manipulating a
\&\f(CW\*(C`FooHandle\*(C'\fR object directly, but you're not.
.PP
I have not explored all the ramifications of this use of \f(CW\*(C`tie\*(C'\fR.
\&\fIHere there be dragons\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Eryq (\fIeryq@zeegee.com\fR).
President, ZeeGee Software Inc (\fIhttp://www.zeegee.com\fR).
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
Dianne Skoll (\fIdfs@roaringpenguin.com\fR).
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright (c) 1997 Erik (Eryq) Dorfman, ZeeGee Software, Inc. All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
F1l3 Manager
