local-lib5/man/man3/IO::Wrap.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "IO::Wrap 3"
 132 .TH IO::Wrap 3 "2005-02-10" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 IO::Wrap \- wrap raw filehandles in IO::Handle interface
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&   use IO::Wrap;
 139 .Ve
 140 .PP
 141 .Vb 5
 142 \&   ### Do stuff with any kind of filehandle (including a bare globref), or
 143 \&   ### any kind of blessed object that responds to a print() message.
 144 \&   ###
 145 \&   sub do_stuff {
 146 \&       my $fh = shift;
 147 .Ve
 148 .PP
 149 .Vb 2
 150 \&       ### At this point, we have no idea what the user gave us...
 151 \&       ### a globref? a FileHandle? a scalar filehandle name?
 152 .Ve
 153 .PP
 154 .Vb 1
 155 \&       $fh = wraphandle($fh);
 156 .Ve
 157 .PP
 158 .Vb 1
 159 \&       ### At this point, we know we have an IO::Handle\-like object!
 160 .Ve
 161 .PP
 162 .Vb 3
 163 \&       $fh\->print("Hey there!");
 164 \&       ...
 165 \&   }
 166 .Ve
 167 .SH "DESCRIPTION"
 168 .IX Header "DESCRIPTION"
 169 Let's say you want to write some code which does I/O, but you don't
 170 want to force the caller to provide you with a FileHandle or IO::Handle
 171 object.  You want them to be able to say:
 172 .PP
 173 .Vb 4
 174 \&    do_stuff(\e*STDOUT);
 175 \&    do_stuff('STDERR');
 176 \&    do_stuff($some_FileHandle_object);
 177 \&    do_stuff($some_IO_Handle_object);
 178 .Ve
 179 .PP
 180 And even:
 181 .PP
 182 .Vb 1
 183 \&    do_stuff($any_object_with_a_print_method);
 184 .Ve
 185 .PP
 186 Sure, one way to do it is to force the caller to use \fItiehandle()\fR.
 187 But that puts the burden on them.  Another way to do it is to
 188 use \fBIO::Wrap\fR, which provides you with the following functions:
 189 .IP "wraphandle \s-1SCALAR\s0" 4
 190 .IX Item "wraphandle SCALAR"
 191 This function will take a single argument, and \*(L"wrap\*(R" it based on
 192 what it seems to be...
 193 .RS 4
 194 .IP "*" 4
 195 \&\fBA raw scalar filehandle name,\fR like \f(CW"STDOUT"\fR or \f(CW"Class::HANDLE"\fR.
 196 In this case, the filehandle name is wrapped in an IO::Wrap object,
 197 which is returned.
 198 .IP "*" 4
 199 \&\fBA raw filehandle glob,\fR like \f(CW\*(C`\e*STDOUT\*(C'\fR.
 200 In this case, the filehandle glob is wrapped in an IO::Wrap object,
 201 which is returned.
 202 .IP "*" 4
 203 \&\fBA blessed FileHandle object.\fR
 204 In this case, the FileHandle is wrapped in an IO::Wrap object if and only
 205 if your FileHandle class does not support the \f(CW\*(C`read()\*(C'\fR method.
 206 .IP "*" 4
 207 \&\fBAny other kind of blessed object,\fR which is assumed to be already
 208 conformant to the IO::Handle interface.
 209 In this case, you just get back that object.
 210 .RE
 211 .RS 4
 212 .RE
 213 .PP
 214 If you get back an IO::Wrap object, it will obey a basic subset of
 215 the \s-1IO::\s0 interface.  That is, the following methods (note: I said
 216 \&\fImethods\fR, not named operators) should work on the thing you get back:
 217 .PP
 218 .Vb 7
 219 \&    close
 220 \&    getline
 221 \&    getlines
 222 \&    print ARGS...
 223 \&    read BUFFER,NBYTES
 224 \&    seek POS,WHENCE
 225 \&    tell
 226 .Ve
 227 .SH "NOTES"
 228 .IX Header "NOTES"
 229 Clearly, when wrapping a raw external filehandle (like \e*STDOUT),
 230 I didn't want to close the file descriptor when the \*(L"wrapper\*(R" object is
 231 destroyed... since the user might not appreciate that!  Hence,
 232 there's no \s-1DESTROY\s0 method in this class.
 233 .PP
 234 When wrapping a FileHandle object, however, I believe that Perl will
 235 invoke the FileHandle::DESTROY when the last reference goes away,
 236 so in that case, the filehandle is closed if the wrapped FileHandle
 237 really was the last reference to it.
 238 .SH "WARNINGS"
 239 .IX Header "WARNINGS"
 240 This module does not allow you to wrap filehandle names which are given
 241 as strings that lack the package they were opened in. That is, if a user
 242 opens \s-1FOO\s0 in package Foo, they must pass it to you either as \f(CW\*(C`\e*FOO\*(C'\fR
 243 or as \f(CW"Foo::FOO"\fR.  However, \f(CW"STDIN"\fR and friends will work just fine.
 244 .SH "VERSION"
 245 .IX Header "VERSION"
 246 $Id: Wrap.pm,v 1.2 2005/02/10 21:21:53 dfs Exp $
 247 .SH "AUTHOR"
 248 .IX Header "AUTHOR"
 249 .RE
 250 .IP "Primary Maintainer"
 251 .IX Item "Primary Maintainer"
 252 David F. Skoll (\fIdfs@roaringpenguin.com\fR).
 253 .RE
 254 .IP "Original Author"
 255 .IX Item "Original Author"
 256 Eryq (\fIeryq@zeegee.com\fR).
 257 President, ZeeGee Software Inc (\fIhttp://www.zeegee.com\fR).