.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "IO::Stringy 3"
.TH IO::Stringy 3 "2015-04-23" "perl v5.16.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\-stringy \- I/O on in\-core objects like strings and arrays
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&    IO::
\&    ::AtomicFile   adpO  Write a file which is updated atomically     ERYQ
\&    ::Lines        bdpO  I/O handle to read/write to array of lines   ERYQ
\&    ::Scalar       RdpO  I/O handle to read/write to a string         ERYQ
\&    ::ScalarArray  RdpO  I/O handle to read/write to array of scalars ERYQ
\&    ::Wrap         RdpO  Wrap old\-style FHs in standard OO interface  ERYQ
\&    ::WrapTie      adpO  Tie your handles & retain full OO interface  ERYQ
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This toolkit primarily provides modules for performing both traditional
and object-oriented i/o) on things \fIother\fR than normal filehandles;
in particular, IO::Scalar, IO::ScalarArray,
and IO::Lines.
.PP
In the more-traditional IO::Handle front, we
have IO::AtomicFile
which may be used to painlessly create files which are updated
atomically.
.PP
And in the \*(L"this-may-prove-useful\*(R" corner, we have IO::Wrap,
whose exported \fIwraphandle()\fR function will clothe anything that's not
a blessed object in an IO::Handle\-like wrapper... so you can just
use \s-1OO\s0 syntax and stop worrying about whether your function's caller
handed you a string, a globref, or a FileHandle.
.SH "WARNINGS"
.IX Header "WARNINGS"
Perl's \s-1TIEHANDLE\s0 spec was incomplete prior to 5.005_57;
it was missing support for \f(CW\*(C`seek()\*(C'\fR, \f(CW\*(C`tell()\*(C'\fR, and \f(CW\*(C`eof()\*(C'\fR.
Attempting to use these functions with an IO::Scalar, IO::ScalarArray,
IO::Lines, etc. \fBwill not work\fR prior to 5.005_57.
None of the relevant methods will be invoked by Perl;
and even worse, this kind of bug can lie dormant for a while.
If you turn warnings on (via \f(CW$^W\fR or \f(CW\*(C`perl \-w\*(C'\fR), and you see
something like this...
.PP
.Vb 1
\&    seek() on unopened file
.Ve
.PP
\&...then you are probably trying to use one of these functions
on one of our \s-1IO::\s0 classes with an old Perl.  The remedy is to simply
use the \s-1OO\s0 version; e.g.:
.PP
.Vb 2
\&    $SH\->seek(0,0);    ### GOOD: will work on any 5.005
\&    seek($SH,0,0);     ### WARNING: will only work on 5.005_57 and beyond
.Ve
.SH "INSTALLATION"
.IX Header "INSTALLATION"
.SS "Requirements"
.IX Subsection "Requirements"
As of version 2.x, this toolkit requires Perl 5.005 for
the IO::Handle subclasses, and 5.005_57 or better is
\&\fBstrongly\fR recommended.  See \*(L"\s-1WARNINGS\*(R"\s0 for details.
.SS "Directions"
.IX Subsection "Directions"
Most of you already know the drill...
.PP
.Vb 4
\&    perl Makefile.PL
\&    make
\&    make test
\&    make install
.Ve
.PP
For everyone else out there...
if you've never installed Perl code before, or you're trying to use
this in an environment where your sysadmin or \s-1ISP\s0 won't let you do
interesting things, \fBrelax:\fR since this module contains no binary
extensions, you can cheat.  That means copying the directory tree
under my \*(L"./lib\*(R" directory into someplace where your script can \*(L"see\*(R"
it.  For example, under Linux:
.PP
.Vb 1
\&    cp \-r IO\-stringy\-1.234/lib/* /path/to/my/perl/
.Ve
.PP
Now, in your Perl code, do this:
.PP
.Vb 2
\&    use lib "/path/to/my/perl";
\&    use IO::Scalar;                   ### or whatever
.Ve
.PP
Ok, now you've been told.  At this point, anyone who whines about
not being given enough information gets an unflattering haiku
written about them in the next change log.  I'll do it.
Don't think I won't.
.SH "VERSION"
.IX Header "VERSION"
\&\f(CW$Id:\fR Stringy.pm,v 1.3 2005/02/10 21:24:05 dfs Exp $
.SH "TO DO"
.IX Header "TO DO"
.IP "(2000/08/02)  Finalize $/ support" 4
.IX Item "(2000/08/02) Finalize $/ support"
Graham Barr submitted this patch half a \fIyear\fR ago;
Like a moron, I lost his message under a ton of others,
and only now have the experimental implementation done.
.Sp
Will the sudden sensitivity to $/ hose anyone out there?
I'm worried, so you have to enable it explicitly in 1.x.
It will be on by default in 2.x, though only IO::Scalar
has been implemented.
.IP "(2001/08/08)  Remove IO::WrapTie from new \s-1IO::\s0 classes" 4
.IX Item "(2001/08/08) Remove IO::WrapTie from new IO:: classes"
It's not needed.  Backwards compatibility could be maintained
by having \fInew_tie()\fR be identical to \fInew()\fR.  Heck, I'll bet
that IO::WrapTie should be reimplemented so the returned
object is just like an IO::Scalar in its use of globrefs.
.SH "CHANGE LOG"
.IX Header "CHANGE LOG"
.IP "Version 2.110   (2005/02/10)" 4
.IX Item "Version 2.110 (2005/02/10)"
Maintainership taken over by \s-1DSKOLL\s0 <dfs@roaringpenguin.com>
.Sp
Closed the following bugs at
https://rt.cpan.org/NoAuth/Bugs.html?Dist=IO\-stringy:
.IP "" 4
2208 IO::ScalarArray\->getline does not return undef for \s-1EOF\s0 if undef($/)
.IP "" 4
7132 IO\-stringy/Makefile.PL bug \- name should be module name
.IP "" 4
11249 IO::Scalar flush shouldn't return undef
.IP "" 4
2172 $\e (output record separator) not respected
.IP "" 4
8605 \fIIO::InnerFile::seek()\fR should return 1 on success
.IP "" 4
4798 *.html in lib/
.IP "" 4
4369 Improvement: handling of fixed-size reads in IO::Scalar
.Sp
(Actually, bug 4369 was closed in Version 2.109)
.IP "Version 2.109   (2003/12/21)" 4
.IX Item "Version 2.109 (2003/12/21)"
IO::Scalar::getline now works with ref to int.
\&\fIThanks to Dominique Quatravaux for this patch.\fR
.IP "Version 2.108   (2001/08/20)" 4
.IX Item "Version 2.108 (2001/08/20)"
The terms-of-use have been placed in the distribution file \*(L"\s-1COPYING\*(R".\s0
Also, small documentation tweaks were made.
.IP "Version 2.105   (2001/08/09)" 4
.IX Item "Version 2.105 (2001/08/09)"
Added support for various \fIseek()\fR whences to IO::ScalarArray.
.Sp
Added support for consulting $/ in IO::Scalar and IO::ScalarArray.
The old \f(CW\*(C`use_RS()\*(C'\fR is not even an option.
Unsupported record separators will cause a \fIcroak()\fR.
.Sp
Added a lot of regression tests to supoprt the above.
.Sp
Better on-line docs (hyperlinks to individual functions).
.IP "Version 2.103   (2001/08/08)" 4
.IX Item "Version 2.103 (2001/08/08)"
After sober consideration I have reimplemented \fIIO::Scalar::print()\fR
so that it once again always seeks to the end of the string.
Benchmarks show the new implementation to be just as fast as
Juergen's contributed patch; until someone can convince me otherwise,
the current, safer implementation stays.
.Sp
I thought more about giving IO::Scalar two separate handles,
one for reading and one for writing, as suggested by Binkley.
His points about what \fItell()\fR and \fIeof()\fR return are, I think,
show-stoppers for this feature.  Even the manpages for stdio's \fIfseek()\fR
seem to imply a \fIsingle\fR file position indicator, not two.
So I think I will take this off the \s-1TO DO\s0 list.
\&\fBRemedy:\fR you can always have two handles open on the same
scalar, one which you only write to, and one which you only read from.
That should give the same effect.
.IP "Version 2.101   (2001/08/07)" 4
.IX Item "Version 2.101 (2001/08/07)"
\&\fBAlpha release.\fR
This is the initial release of the \*(L"IO::Scalar and friends are
now subclasses of IO::Handle\*(R".  I'm flinging it against the wall.
Please tell me if the banana sticks.  When it does, the banana
will be called 2.2x.
.Sp
First off, \fImany many thanks to Doug Wilson\fR, who
has provided an \fIinvaluable\fR service by patching IO::Scalar
and friends so that they (1) inherit from IO::Handle, (2) automatically
tie themselves so that the \f(CW\*(C`new()\*(C'\fR objects can be used in native i/o
constructs, and (3) doing it so that the whole damn thing passes
its regression tests.  As Doug knows, my globref Kung-Fu was not
up to the task; he graciously provided the patches.  This has earned
him a seat at the Co-Authors table, and the
right to have me address him as \fIsensei\fR.
.Sp
Performance of \fIIO::Scalar::print()\fR has been improved by as much as 2x
for lots of little prints, with the cost of forcing those
who print-then-seek-then-print to explicitly seek to end-of-string
before printing again.
\&\fIThanks to Juergen Zeller for this patch.\fR
.Sp
Added the \s-1COPYING\s0 file, which had been missing from prior versions.
\&\fIThanks to Albert Chin-A-Young for pointing this out.\fR
.Sp
IO::Scalar consults $/ by default (1.x ignored it by default).
Yes, I still need to support IO::ScalarArray.
.IP "Version 1.221   (2001/08/07)" 4
.IX Item "Version 1.221 (2001/08/07)"
I threatened in \*(L"\s-1INSTALLATION\*(R"\s0 to write an unflattering haiku
about anyone who whined that I gave them insufficient information...
but it turns out that I left out a crucial direction.  D'\s-1OH\s0!
\&\fIThanks to David Beroff for the \*(L"patch\*(R" and the haiku...\fR
.Sp
.Vb 3
\&       Enough info there?
\&         Here\*(Aqs unflattering haiku:
\&       Forgot the line, "make"!  ;\-)
.Ve
.IP "Version 1.220   (2001/04/03)" 4
.IX Item "Version 1.220 (2001/04/03)"
Added untested \s-1SEEK, TELL,\s0 and \s-1EOF\s0 methods to IO::Scalar
and IO::ScalarArray to support corresponding functions for
tied filehandles: untested, because I'm still running 5.00556
and Perl is complaining about \*(L"\fItell()\fR on unopened file\*(R".
\&\fIThanks to Graham Barr for the suggestion.\fR
.Sp
Removed not-fully-blank lines from modules; these were causing
lots of POD-related warnings.
\&\fIThanks to Nicolas Joly for the suggestion.\fR
.IP "Version 1.219   (2001/02/23)" 4
.IX Item "Version 1.219 (2001/02/23)"
IO::Scalar objects can now be made sensitive to $/ .
Pains were taken to keep the fast code fast while adding this feature.
\&\fICheers to Graham Barr for submitting his patch;
jeers to me for losing his email for 6 months.\fR
.IP "Version 1.218   (2001/02/23)" 4
.IX Item "Version 1.218 (2001/02/23)"
IO::Scalar has a new \fIsysseek()\fR method.
\&\fIThanks again to Richard Jones.\fR
.Sp
New \*(L"\s-1TO DO\*(R"\s0 section, because people who submit patches/ideas should
at least know that they're in the system... and that I won't lose
their stuff.  Please read it.
.Sp
New entries in \*(L"\s-1AUTHOR\*(R"\s0.
Please read those too.
.IP "Version 1.216   (2000/09/28)" 4
.IX Item "Version 1.216 (2000/09/28)"
\&\fBIO::Scalar and IO::ScalarArray now inherit from IO::Handle.\fR
I thought I'd remembered a problem with this ages ago, related to
the fact that these \s-1IO::\s0 modules don't have \*(L"real\*(R" filehandles,
but the problem apparently isn't surfacing now.
If you suddenly encounter Perl warnings during global destruction
(especially if you're using tied filehandles), then please let me know!
\&\fIThanks to B. K. Oxley (binkley) for this.\fR
.Sp
\&\fBNasty bug fixed in \f(BIIO::Scalar::write()\fB.\fR
Apparently, the offset and the number-of-bytes arguments were,
for all practical purposes, \fIreversed.\fR  You were okay if
you did all your writing with \fIprint()\fR, but boy was \fIthis\fR a stupid bug!
\&\fIThanks to Richard Jones for finding this one.
For you, Rich, a double-length haiku:\fR
.Sp
.Vb 3
\&       Newspaper headline
\&          typeset by dyslexic man
\&       loses urgency
\&
\&       BABY EATS FISH is
\&          simply not equivalent
\&       to FISH EATS BABY
.Ve
.Sp
\&\fBNew sysread and syswrite methods for IO::Scalar.\fR
\&\fIThanks again to Richard Jones for this.\fR
.IP "Version 1.215   (2000/09/05)" 4
.IX Item "Version 1.215 (2000/09/05)"
Added 'bool' overload to '""' overload, so object always evaluates
to true.  (Whew.  Glad I caught this before it went to \s-1CPAN.\s0)
.IP "Version 1.214   (2000/09/03)" 4
.IX Item "Version 1.214 (2000/09/03)"
Evaluating an IO::Scalar in a string context now yields
the underlying string.
\&\fIThanks to B. K. Oxley (binkley) for this.\fR
.IP "Version 1.213   (2000/08/16)" 4
.IX Item "Version 1.213 (2000/08/16)"
Minor documentation fixes.
.IP "Version 1.212   (2000/06/02)" 4
.IX Item "Version 1.212 (2000/06/02)"
Fixed IO::InnerFile incompatibility with Perl5.004.
\&\fIThanks to many folks for reporting this.\fR
.IP "Version 1.210   (2000/04/17)" 4
.IX Item "Version 1.210 (2000/04/17)"
Added \fIflush()\fR and other no-op methods.
\&\fIThanks to Doru Petrescu for suggesting this.\fR
.IP "Version 1.209   (2000/03/17)" 4
.IX Item "Version 1.209 (2000/03/17)"
Small bug fixes.
.IP "Version 1.208   (2000/03/14)" 4
.IX Item "Version 1.208 (2000/03/14)"
Incorporated a number of contributed patches and extensions,
mostly related to speed hacks, support for \*(L"offset\*(R", and
\&\s-1WRITE/CLOSE\s0 methods.
\&\fIThanks to Richard Jones, Doru Petrescu, and many others.\fR
.IP "Version 1.206   (1999/04/18)" 4
.IX Item "Version 1.206 (1999/04/18)"
Added creation of ./testout when Makefile.PL is run.
.IP "Version 1.205   (1999/01/15)" 4
.IX Item "Version 1.205 (1999/01/15)"
Verified for Perl5.005.
.IP "Version 1.202   (1998/04/18)" 4
.IX Item "Version 1.202 (1998/04/18)"
New IO::WrapTie and IO::AtomicFile added.
.IP "Version 1.110" 4
.IX Item "Version 1.110"
Added IO::WrapTie.
.IP "Version 1.107" 4
.IX Item "Version 1.107"
Added IO::Lines, and made some bug fixes to IO::ScalarArray.
Also, added \fIgetc()\fR.
.IP "Version 1.105" 4
.IX Item "Version 1.105"
No real changes; just upgraded IO::Wrap to have a \f(CW$VERSION\fR string.
.SH "AUTHOR"
.IX Header "AUTHOR"
.IP "Primary Maintainer" 4
.IX Item "Primary Maintainer"
Dianne Skoll (\fIdfs@roaringpenguin.com\fR).
.IP "Original Author" 4
.IX Item "Original Author"
Eryq (\fIeryq@zeegee.com\fR).
President, ZeeGee Software Inc (\fIhttp://www.zeegee.com\fR).
.IP "Co-Authors" 4
.IX Item "Co-Authors"
For all their bug reports and patch submissions, the following
are officially recognized:
.Sp
.Vb 4
\&     Richard Jones
\&     B. K. Oxley (binkley)
\&     Doru Petrescu
\&     Doug Wilson (for picking up the ball I dropped, and doing tie() right)
.Ve
.PP
Go to \fIhttp://www.zeegee.com\fR for the latest downloads
and on-line documentation for this module.
.PP
Enjoy.  Yell if it breaks.
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 153:" 4
.IX Item "Around line 153:"
Expected text after =item, not a bullet
.IP "Around line 157:" 4
.IX Item "Around line 157:"
Expected text after =item, not a bullet
.IP "Around line 161:" 4
.IX Item "Around line 161:"
Expected text after =item, not a bullet
.IP "Around line 165:" 4
.IX Item "Around line 165:"
Expected text after =item, not a bullet
.IP "Around line 169:" 4
.IX Item "Around line 169:"
Expected text after =item, not a bullet
.IP "Around line 173:" 4
.IX Item "Around line 173:"
Expected text after =item, not a bullet
.IP "Around line 177:" 4
.IX Item "Around line 177:"
Expected text after =item, not a bullet