git.maemo.org Git - dh-make-perl/blob - dev/arm/libio-stringy-perl/io-stringy-2.110/docs/IO/InnerFile.pm.html

   1 <HTML>
   2 <HEAD>
   3   <TITLE>IO::InnerFile 2.102</TITLE>
   4 </HEAD>
   5 <BODY
   6        bgcolor="#FFFFFF" link="#CC3366" vlink="#993366" alink="#FF6666">
   7 <FONT FACE="sans-serif" SIZE=-1><A HREF="http://www.zeegee.com" TARGET="_top"><IMG SRC="icons/zeegee.gif" ALT="ZeeGee Software" ALIGN="RIGHT" BORDER="0"></A><A NAME="__TOP__"><H1>IO::InnerFile 2.102</H1>
   8 </A><UL>
   9 <LI> <A NAME="menu:NAME"><A HREF="#NAME">NAME</A></A>
  10 <LI> <A NAME="menu:SYNOPSIS"><A HREF="#SYNOPSIS">SYNOPSIS</A></A>
  11 <LI> <A NAME="menu:DESCRIPTION"><A HREF="#DESCRIPTION">DESCRIPTION</A></A>
  12 <LI> <A NAME="menu:PUBLIC_INTERFACE"><A HREF="#PUBLIC_INTERFACE">PUBLIC INTERFACE</A></A>
  13 <UL>
  14 <LI> <A NAME="menu:item:new_FILEHANDLE_START_LENGTH"><A HREF="#item:new_FILEHANDLE_START_LENGTH">new FILEHANDLE, [START, [LENGTH]]</A></A>
  15 <LI> <A NAME="menu:item:set_length_LENGTH"><A HREF="#item:set_length_LENGTH">set_length LENGTH</A></A>
  16 <LI> <A NAME="menu:item:get_length"><A HREF="#item:get_length">get_length </A></A>
  17 <LI> <A NAME="menu:item:add_length_NBYTES"><A HREF="#item:add_length_NBYTES">add_length NBYTES</A></A>
  18 <LI> <A NAME="menu:item:set_start_START"><A HREF="#item:set_start_START">set_start START</A></A>
  19 <LI> <A NAME="menu:item:get_start"><A HREF="#item:get_start">get_start </A></A>
  20 <LI> <A NAME="menu:item:add_start_NBYTES"><A HREF="#item:add_start_NBYTES">add_start NBYTES</A></A>
  21 <LI> <A NAME="menu:item:binmode"><A HREF="#item:binmode">binmode</A></A>
  22 <LI> <A NAME="menu:item:close"><A HREF="#item:close">close</A></A>
  23 <LI> <A NAME="menu:item:flush"><A HREF="#item:flush">flush</A></A>
  24 <LI> <A NAME="menu:item:getc"><A HREF="#item:getc">getc</A></A>
  25 <LI> <A NAME="menu:item:getline"><A HREF="#item:getline">getline</A></A>
  26 <LI> <A NAME="menu:item:print_LIST"><A HREF="#item:print_LIST">print LIST</A></A>
  27 <LI> <A NAME="menu:item:printf_LIST"><A HREF="#item:printf_LIST">printf LIST</A></A>
  28 <LI> <A NAME="menu:item:read_BUF_NBYTES"><A HREF="#item:read_BUF_NBYTES">read BUF, NBYTES</A></A>
  29 <LI> <A NAME="menu:item:readline"><A HREF="#item:readline">readline</A></A>
  30 <LI> <A NAME="menu:item:seek_OFFFSET_WHENCE"><A HREF="#item:seek_OFFFSET_WHENCE">seek OFFFSET, WHENCE</A></A>
  31 <LI> <A NAME="menu:item:tell"><A HREF="#item:tell">tell</A></A>
  32 <LI> <A NAME="menu:item:write_ARGS"><A HREF="#item:write_ARGS">write ARGS...</A></A>
  33 </UL>
  34 <LI> <A NAME="menu:VERSION"><A HREF="#VERSION">VERSION</A></A>
  35 <LI> <A NAME="menu:AUTHOR"><A HREF="#AUTHOR">AUTHOR</A></A>
  36 </UL>
  37
  38
  39 <P><HR>
  40 <A NAME="NAME"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> NAME</H2></A>
  41
  42
  43 <P>IO::InnerFile - define a file inside another file
  44
  45
  46
  47 <P><HR>
  48 <A NAME="SYNOPSIS"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> SYNOPSIS</H2></A>
  49
  50 <FONT SIZE=3 FACE="courier"><PRE>
  51     ### Read a subset of a file:
  52     $inner = IO::InnerFile-&gt;new($fh, $start, $length);
  53     while (&lt;$inner&gt;) {
  54         ...
  55     }
  56 </PRE></FONT>
  57
  58
  59 <P><HR>
  60 <A NAME="DESCRIPTION"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> DESCRIPTION</H2></A>
  61
  62
  63 <P>If you have a filehandle that can seek() and tell(), then you
  64 can open an IO::InnerFile on a range of the underlying file.
  65
  66
  67
  68 <P><HR>
  69 <A NAME="PUBLIC_INTERFACE"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> PUBLIC INTERFACE</H2></A>
  70
  71
  72
  73 <DL>
  74 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:new"><A NAME="item:new_FILEHANDLE_START_LENGTH">new FILEHANDLE, [START, [LENGTH]]</A></A></B></DT>
  75 <DD>
  76 <I>Class method, constructor.</I>
  77 Create a new inner-file opened on the given FILEHANDLE,
  78 from bytes START to START+LENGTH.  Both START and LENGTH
  79 default to 0; negative values are silently coerced to zero.
  80
  81
  82 <P>Note that FILEHANDLE must be able to seek() and tell(), in addition
  83 to whatever other methods you may desire for reading it.
  84
  85 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:set_length"><A NAME="item:set_length_LENGTH">set_length LENGTH</A></A></B></DT>
  86 <DD>
  87 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:get_length">get_length</A></B></DT>
  88 <DD>
  89 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:add_length"><A NAME="item:add_length_NBYTES">add_length NBYTES</A></A></B></DT>
  90 <DD>
  91 <I>Instance methods.</I>
  92 Get/set the virtual length of the inner file.
  93
  94 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:set_start"><A NAME="item:set_start_START">set_start START</A></A></B></DT>
  95 <DD>
  96 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:get_start">get_start</A></B></DT>
  97 <DD>
  98 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:add_start"><A NAME="item:add_start_NBYTES">add_start NBYTES</A></A></B></DT>
  99 <DD>
 100 <I>Instance methods.</I>
 101 Get/set the virtual start position of the inner file.
 102
 103 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:binmode">binmode</A></B></DT>
 104 <DD>
 105 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:close">close</A></B></DT>
 106 <DD>
 107 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:flush">flush</A></B></DT>
 108 <DD>
 109 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:getc">getc</A></B></DT>
 110 <DD>
 111 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:getline">getline</A></B></DT>
 112 <DD>
 113 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:print"><A NAME="item:print_LIST">print LIST</A></A></B></DT>
 114 <DD>
 115 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:printf"><A NAME="item:printf_LIST">printf LIST</A></A></B></DT>
 116 <DD>
 117 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:read"><A NAME="item:read_BUF_NBYTES">read BUF, NBYTES</A></A></B></DT>
 118 <DD>
 119 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:readline">readline</A></B></DT>
 120 <DD>
 121 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:seek"><A NAME="item:seek_OFFFSET_WHENCE">seek OFFFSET, WHENCE</A></A></B></DT>
 122 <DD>
 123 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:tell">tell</A></B></DT>
 124 <DD>
 125 <P><DT><B><A HREF="#__TOP__"><IMG SRC="icons/itembullet.gif" ALT="Top" BORDER="0"></A> <A NAME="item:write"><A NAME="item:write_ARGS">write ARGS...</A></A></B></DT>
 126 <DD>
 127 <I>Instance methods.</I>
 128 Standard filehandle methods.
 129
 130 </DL>
 131
 132
 133
 134 <P><HR>
 135 <A NAME="VERSION"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> VERSION</H2></A>
 136
 137
 138 <P>$Id: InnerFile.pm,v 2.102 2001/08/17 02:06:33 eryq Exp $
 139
 140
 141
 142 <P><HR>
 143 <A NAME="AUTHOR"><H2><A HREF="#__TOP__"><IMG SRC="icons/h1bullet.gif" ALT="Top" BORDER="0"></A> AUTHOR</H2></A>
 144
 145
 146 <P>Original version by Doru Petrescu (pdoru@kappa.ro).
 147
 148
 149 <P>Documentation and current maintenance by Eryq (eryq@zeegee.com).
 150
 151 <P><HR>
 152 <ADDRESS><FONT SIZE=-1>
 153 Generated Sun Dec 21 13:54:37 2003 by cvu_pod2html
 154 </FONT></ADDRESS>
 155 </FONT></BODY>
 156 </HTML>