Compress::Raw::Zlib, Compress::Zlib, IO::Compress::Zlib 2.000_10
[p5sagit/p5-mst-13.2.git] / ext / Compress / IO / Zlib / lib / IO / Uncompress / RawInflate.pm
1 package IO::Uncompress::RawInflate ;
2 # for RFC1951
3
4 use strict ;
5 use warnings;
6 use bytes;
7
8 use Compress::Raw::Zlib ;
9 use IO::Compress::Base::Common qw(:Status createSelfTiedObject);
10
11 use IO::Uncompress::Base ;
12 use IO::Uncompress::Adapter::Inflate ;
13
14
15
16
17 require Exporter ;
18 our ($VERSION, @ISA, @EXPORT_OK, %EXPORT_TAGS, %DEFLATE_CONSTANTS, $RawInflateError);
19
20 $VERSION = '2.000_10';
21 $RawInflateError = '';
22
23 @ISA    = qw( Exporter IO::Uncompress::Base );
24 @EXPORT_OK = qw( $RawInflateError rawinflate ) ;
25 %DEFLATE_CONSTANTS = ();
26 %EXPORT_TAGS = %IO::Uncompress::Base::EXPORT_TAGS ;
27 push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ;
28 Exporter::export_ok_tags('all');
29
30
31
32 sub new
33 {
34     my $class = shift ;
35     my $obj = createSelfTiedObject($class, \$RawInflateError);
36     $obj->_create(undef, 0, @_);
37 }
38
39 sub rawinflate
40 {
41     my $obj = createSelfTiedObject(undef, \$RawInflateError);
42     return $obj->_inf(@_);
43 }
44
45 sub getExtraParams
46 {
47     return ();
48 }
49
50 sub ckParams
51 {
52     my $self = shift ;
53     my $got = shift ;
54
55     return 1;
56 }
57
58 sub mkUncomp
59 {
60     my $self = shift ;
61     my $class = shift ;
62     my $got = shift ;
63
64     my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::Inflate::mkUncompObject(
65                                                                 $got->value('CRC32'),
66                                                                 $got->value('ADLER32'),
67                                                                 $got->value('Scan'),
68                                                             );
69
70     return $self->saveErrorString(undef, $errstr, $errno)
71         if ! defined $obj;
72
73     *$self->{Uncomp} = $obj;
74
75      my $magic = $self->ckMagic()
76         or return 0;
77
78     *$self->{Info} = $self->readHeader($magic)
79         or return undef ;
80
81     return 1;
82
83 }
84
85
86 sub ckMagic
87 {
88     my $self = shift;
89
90     return $self->_isRaw() ;
91 }
92
93 sub readHeader
94 {
95     my $self = shift;
96     my $magic = shift ;
97
98     return {
99         'Type'          => 'rfc1951',
100         'FingerprintLength'  => 0,
101         'HeaderLength'  => 0,
102         'TrailerLength' => 0,
103         'Header'        => ''
104         };
105 }
106
107 sub chkTrailer
108 {
109     return STATUS_OK ;
110 }
111
112 sub _isRaw
113 {
114     my $self   = shift ;
115
116     my $got = $self->_isRawx(@_);
117
118     if ($got) {
119         *$self->{Pending} = *$self->{HeaderPending} ;
120     }
121     else {
122         $self->pushBack(*$self->{HeaderPending});
123         *$self->{Uncomp}->reset();
124     }
125     *$self->{HeaderPending} = '';
126
127     return $got ;
128 }
129
130 sub _isRawx
131 {
132     my $self   = shift ;
133     my $magic = shift ;
134
135     $magic = '' unless defined $magic ;
136
137     my $buffer = '';
138
139     $self->smartRead(\$buffer, *$self->{BlockSize}) >= 0  
140         or return $self->saveErrorString(undef, "No data to read");
141
142     my $temp_buf = $magic . $buffer ;
143     *$self->{HeaderPending} = $temp_buf ;    
144     $buffer = '';
145     my $status = *$self->{Uncomp}->uncompr(\$temp_buf, \$buffer, $self->smartEof()) ;
146     return $self->saveErrorString(undef, *$self->{Uncomp}{Error}, STATUS_ERROR)
147         if $status == STATUS_ERROR;
148
149     my $buf_len = *$self->{Uncomp}->uncompressedBytes();
150
151     if ($status == STATUS_ENDSTREAM) {
152         if (*$self->{MultiStream} 
153                     && (length $temp_buf || ! $self->smartEof())){
154             *$self->{NewStream} = 1 ;
155             *$self->{EndStream} = 0 ;
156             $self->pushBack($temp_buf);
157         }
158         else {
159             *$self->{EndStream} = 1 ;
160             $self->pushBack($temp_buf);
161         }
162     }
163     *$self->{HeaderPending} = $buffer ;    
164     *$self->{InflatedBytesRead} = $buf_len ;    
165     *$self->{TotalInflatedBytesRead} += $buf_len ;    
166     *$self->{Type} = 'rfc1951';
167
168     $self->saveStatus(STATUS_OK);
169
170     return {
171         'Type'          => 'rfc1951',
172         'HeaderLength'  => 0,
173         'TrailerLength' => 0,
174         'Header'        => ''
175         };
176 }
177
178
179 sub inflateSync
180 {
181     my $self = shift ;
182
183     # inflateSync is a no-op in Plain mode
184     return 1
185         if *$self->{Plain} ;
186
187     return 0 if *$self->{Closed} ;
188     #return G_EOF if !length *$self->{Pending} && *$self->{EndStream} ;
189     return 0 if ! length *$self->{Pending} && *$self->{EndStream} ;
190
191     # Disable CRC check
192     *$self->{Strict} = 0 ;
193
194     my $status ;
195     while (1)
196     {
197         my $temp_buf ;
198
199         if (length *$self->{Pending} )
200         {
201             $temp_buf = *$self->{Pending} ;
202             *$self->{Pending} = '';
203         }
204         else
205         {
206             $status = $self->smartRead(\$temp_buf, *$self->{BlockSize}) ;
207             return $self->saveErrorString(0, "Error Reading Data")
208                 if $status < 0  ;
209
210             if ($status == 0 ) {
211                 *$self->{EndStream} = 1 ;
212                 return $self->saveErrorString(0, "unexpected end of file", STATUS_ERROR);
213             }
214         }
215         
216         $status = *$self->{Uncomp}->sync($temp_buf) ;
217
218         if ($status == STATUS_OK)
219         {
220             *$self->{Pending} .= $temp_buf ;
221             return 1 ;
222         }
223
224         last unless $status == STATUS_ERROR ;
225     }
226
227     return 0;
228 }
229
230 #sub performScan
231 #{
232 #    my $self = shift ;
233 #
234 #    my $status ;
235 #    my $end_offset = 0;
236 #
237 #    $status = $self->scan() 
238 #    #or return $self->saveErrorString(undef, "Error Scanning: $$error_ref", $self->errorNo) ;
239 #        or return $self->saveErrorString(G_ERR, "Error Scanning: $status")
240 #
241 #    $status = $self->zap($end_offset) 
242 #        or return $self->saveErrorString(G_ERR, "Error Zapping: $status");
243 #    #or return $self->saveErrorString(undef, "Error Zapping: $$error_ref", $self->errorNo) ;
244 #
245 #    #(*$obj->{Deflate}, $status) = $inf->createDeflate();
246 #
247 ##    *$obj->{Header} = *$inf->{Info}{Header};
248 ##    *$obj->{UnCompSize_32bit} = 
249 ##        *$obj->{BytesWritten} = *$inf->{UnCompSize_32bit} ;
250 ##    *$obj->{CompSize_32bit} = *$inf->{CompSize_32bit} ;
251 #
252 #
253 ##    if ( $outType eq 'buffer') 
254 ##      { substr( ${ *$self->{Buffer} }, $end_offset) = '' }
255 ##    elsif ($outType eq 'handle' || $outType eq 'filename') {
256 ##        *$self->{FH} = *$inf->{FH} ;
257 ##        delete *$inf->{FH};
258 ##        *$obj->{FH}->flush() ;
259 ##        *$obj->{Handle} = 1 if $outType eq 'handle';
260 ##
261 ##        #seek(*$obj->{FH}, $end_offset, SEEK_SET) 
262 ##        *$obj->{FH}->seek($end_offset, SEEK_SET) 
263 ##            or return $obj->saveErrorString(undef, $!, $!) ;
264 ##    }
265 #    
266 #}
267
268 sub scan
269 {
270     my $self = shift ;
271
272     return 1 if *$self->{Closed} ;
273     return 1 if !length *$self->{Pending} && *$self->{EndStream} ;
274
275     my $buffer = '' ;
276     my $len = 0;
277
278     $len = $self->_raw_read(\$buffer, 1) 
279         while ! *$self->{EndStream} && $len >= 0 ;
280
281     #return $len if $len < 0 ? $len : 0 ;
282     return $len < 0 ? 0 : 1 ;
283 }
284
285 sub zap
286 {
287     my $self  = shift ;
288
289     my $headerLength = *$self->{Info}{HeaderLength};
290     my $block_offset =  $headerLength + *$self->{Uncomp}->getLastBlockOffset();
291     $_[0] = $headerLength + *$self->{Uncomp}->getEndOffset();
292     #printf "# End $_[0], headerlen $headerLength \n";;
293     #printf "# block_offset $block_offset %x\n", $block_offset;
294     my $byte ;
295     ( $self->smartSeek($block_offset) &&
296       $self->smartRead(\$byte, 1) ) 
297         or return $self->saveErrorString(0, $!, $!); 
298
299     #printf "#byte is %x\n", unpack('C*',$byte);
300     *$self->{Uncomp}->resetLastBlockByte($byte);
301     #printf "#to byte is %x\n", unpack('C*',$byte);
302
303     ( $self->smartSeek($block_offset) && 
304       $self->smartWrite($byte) )
305         or return $self->saveErrorString(0, $!, $!); 
306
307     #$self->smartSeek($end_offset, 1);
308
309     return 1 ;
310 }
311
312 sub createDeflate
313 {
314     my $self  = shift ;
315     my ($def, $status) = *$self->{Uncomp}->createDeflateStream(
316                                     -AppendOutput   => 1,
317                                     -WindowBits => - MAX_WBITS,
318                                     -CRC32      => *$self->{Params}->value('CRC32'),
319                                     -ADLER32    => *$self->{Params}->value('ADLER32'),
320                                 );
321     
322     return wantarray ? ($status, $def) : $def ;                                
323 }
324
325
326 1; 
327
328 __END__
329
330
331 =head1 NAME
332
333
334
335 IO::Uncompress::RawInflate - Read RFC 1951 files/buffers
336
337
338
339 =head1 SYNOPSIS
340
341     use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
342
343     my $status = rawinflate $input => $output [,OPTS]
344         or die "rawinflate failed: $RawInflateError\n";
345
346     my $z = new IO::Uncompress::RawInflate $input [OPTS] 
347         or die "rawinflate failed: $RawInflateError\n";
348
349     $status = $z->read($buffer)
350     $status = $z->read($buffer, $length)
351     $status = $z->read($buffer, $length, $offset)
352     $line = $z->getline()
353     $char = $z->getc()
354     $char = $z->ungetc()
355     $char = $z->opened()
356
357     $status = $z->inflateSync()
358
359     $z->trailingData()
360     $data = $z->getHeaderInfo()
361     $z->tell()
362     $z->seek($position, $whence)
363     $z->binmode()
364     $z->fileno()
365     $z->eof()
366     $z->close()
367
368     $RawInflateError ;
369
370     # IO::File mode
371
372     <$z>
373     read($z, $buffer);
374     read($z, $buffer, $length);
375     read($z, $buffer, $length, $offset);
376     tell($z)
377     seek($z, $position, $whence)
378     binmode($z)
379     fileno($z)
380     eof($z)
381     close($z)
382
383
384 =head1 DESCRIPTION
385
386
387
388 B<WARNING -- This is a Beta release>. 
389
390 =over 5
391
392 =item * DO NOT use in production code.
393
394 =item * The documentation is incomplete in places.
395
396 =item * Parts of the interface defined here are tentative.
397
398 =item * Please report any problems you find.
399
400 =back
401
402
403
404
405
406 This module provides a Perl interface that allows the reading of
407 files/buffers that conform to RFC 1951.
408
409 For writing RFC 1951 files/buffers, see the companion module IO::Compress::RawDeflate.
410
411
412
413
414
415
416 =head1 Functional Interface
417
418 A top-level function, C<rawinflate>, is provided to carry out
419 "one-shot" uncompression between buffers and/or files. For finer
420 control over the uncompression process, see the L</"OO Interface">
421 section.
422
423     use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
424
425     rawinflate $input => $output [,OPTS] 
426         or die "rawinflate failed: $RawInflateError\n";
427
428
429
430 The functional interface needs Perl5.005 or better.
431
432
433 =head2 rawinflate $input => $output [, OPTS]
434
435
436 C<rawinflate> expects at least two parameters, C<$input> and C<$output>.
437
438 =head3 The C<$input> parameter
439
440 The parameter, C<$input>, is used to define the source of
441 the compressed data. 
442
443 It can take one of the following forms:
444
445 =over 5
446
447 =item A filename
448
449 If the C<$input> parameter is a simple scalar, it is assumed to be a
450 filename. This file will be opened for reading and the input data
451 will be read from it.
452
453 =item A filehandle
454
455 If the C<$input> parameter is a filehandle, the input data will be
456 read from it.
457 The string '-' can be used as an alias for standard input.
458
459 =item A scalar reference 
460
461 If C<$input> is a scalar reference, the input data will be read
462 from C<$$input>.
463
464 =item An array reference 
465
466 If C<$input> is an array reference, each element in the array must be a
467 filename.
468
469 The input data will be read from each file in turn. 
470
471 The complete array will be walked to ensure that it only
472 contains valid filenames before any data is uncompressed.
473
474
475
476 =item An Input FileGlob string
477
478 If C<$input> is a string that is delimited by the characters "<" and ">"
479 C<rawinflate> will assume that it is an I<input fileglob string>. The
480 input is the list of files that match the fileglob.
481
482 If the fileglob does not match any files ...
483
484 See L<File::GlobMapper|File::GlobMapper> for more details.
485
486
487 =back
488
489 If the C<$input> parameter is any other type, C<undef> will be returned.
490
491
492
493 =head3 The C<$output> parameter
494
495 The parameter C<$output> is used to control the destination of the
496 uncompressed data. This parameter can take one of these forms.
497
498 =over 5
499
500 =item A filename
501
502 If the C<$output> parameter is a simple scalar, it is assumed to be a
503 filename.  This file will be opened for writing and the uncompressed
504 data will be written to it.
505
506 =item A filehandle
507
508 If the C<$output> parameter is a filehandle, the uncompressed data
509 will be written to it.
510 The string '-' can be used as an alias for standard output.
511
512
513 =item A scalar reference 
514
515 If C<$output> is a scalar reference, the uncompressed data will be
516 stored in C<$$output>.
517
518
519
520 =item An Array Reference
521
522 If C<$output> is an array reference, the uncompressed data will be
523 pushed onto the array.
524
525 =item An Output FileGlob
526
527 If C<$output> is a string that is delimited by the characters "<" and ">"
528 C<rawinflate> will assume that it is an I<output fileglob string>. The
529 output is the list of files that match the fileglob.
530
531 When C<$output> is an fileglob string, C<$input> must also be a fileglob
532 string. Anything else is an error.
533
534 =back
535
536 If the C<$output> parameter is any other type, C<undef> will be returned.
537
538
539
540 =head2 Notes
541
542 When C<$input> maps to multiple files/buffers and C<$output> is a single
543 file/buffer the uncompressed input files/buffers will all be stored
544 in C<$output> as a single uncompressed stream.
545
546
547
548 =head2 Optional Parameters
549
550 Unless specified below, the optional parameters for C<rawinflate>,
551 C<OPTS>, are the same as those used with the OO interface defined in the
552 L</"Constructor Options"> section below.
553
554 =over 5
555
556 =item AutoClose =E<gt> 0|1
557
558 This option applies to any input or output data streams to 
559 C<rawinflate> that are filehandles.
560
561 If C<AutoClose> is specified, and the value is true, it will result in all
562 input and/or output filehandles being closed once C<rawinflate> has
563 completed.
564
565 This parameter defaults to 0.
566
567
568
569 =item BinModeOut =E<gt> 0|1
570
571 When writing to a file or filehandle, set C<binmode> before writing to the
572 file.
573
574 Defaults to 0.
575
576
577
578
579
580 =item -Append =E<gt> 0|1
581
582 TODO
583
584 =item -MultiStream =E<gt> 0|1
585
586 Creates a new stream after each file.
587
588 Defaults to 1.
589
590
591
592 =back
593
594
595
596
597 =head2 Examples
598
599 To read the contents of the file C<file1.txt.1951> and write the
600 compressed data to the file C<file1.txt>.
601
602     use strict ;
603     use warnings ;
604     use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
605
606     my $input = "file1.txt.1951";
607     my $output = "file1.txt";
608     rawinflate $input => $output
609         or die "rawinflate failed: $RawInflateError\n";
610
611
612 To read from an existing Perl filehandle, C<$input>, and write the
613 uncompressed data to a buffer, C<$buffer>.
614
615     use strict ;
616     use warnings ;
617     use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
618     use IO::File ;
619
620     my $input = new IO::File "<file1.txt.1951"
621         or die "Cannot open 'file1.txt.1951': $!\n" ;
622     my $buffer ;
623     rawinflate $input => \$buffer 
624         or die "rawinflate failed: $RawInflateError\n";
625
626 To uncompress all files in the directory "/my/home" that match "*.txt.1951" and store the compressed data in the same directory
627
628     use strict ;
629     use warnings ;
630     use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
631
632     rawinflate '</my/home/*.txt.1951>' => '</my/home/#1.txt>'
633         or die "rawinflate failed: $RawInflateError\n";
634
635 and if you want to compress each file one at a time, this will do the trick
636
637     use strict ;
638     use warnings ;
639     use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
640
641     for my $input ( glob "/my/home/*.txt.1951" )
642     {
643         my $output = $input;
644         $output =~ s/.1951// ;
645         rawinflate $input => $output 
646             or die "Error compressing '$input': $RawInflateError\n";
647     }
648
649 =head1 OO Interface
650
651 =head2 Constructor
652
653 The format of the constructor for IO::Uncompress::RawInflate is shown below
654
655
656     my $z = new IO::Uncompress::RawInflate $input [OPTS]
657         or die "IO::Uncompress::RawInflate failed: $RawInflateError\n";
658
659 Returns an C<IO::Uncompress::RawInflate> object on success and undef on failure.
660 The variable C<$RawInflateError> will contain an error message on failure.
661
662 If you are running Perl 5.005 or better the object, C<$z>, returned from
663 IO::Uncompress::RawInflate can be used exactly like an L<IO::File|IO::File> filehandle.
664 This means that all normal input file operations can be carried out with
665 C<$z>.  For example, to read a line from a compressed file/buffer you can
666 use either of these forms
667
668     $line = $z->getline();
669     $line = <$z>;
670
671 The mandatory parameter C<$input> is used to determine the source of the
672 compressed data. This parameter can take one of three forms.
673
674 =over 5
675
676 =item A filename
677
678 If the C<$input> parameter is a scalar, it is assumed to be a filename. This
679 file will be opened for reading and the compressed data will be read from it.
680
681 =item A filehandle
682
683 If the C<$input> parameter is a filehandle, the compressed data will be
684 read from it.
685 The string '-' can be used as an alias for standard input.
686
687
688 =item A scalar reference 
689
690 If C<$input> is a scalar reference, the compressed data will be read from
691 C<$$output>.
692
693 =back
694
695 =head2 Constructor Options
696
697
698 The option names defined below are case insensitive and can be optionally
699 prefixed by a '-'.  So all of the following are valid
700
701     -AutoClose
702     -autoclose
703     AUTOCLOSE
704     autoclose
705
706 OPTS is a combination of the following options:
707
708 =over 5
709
710 =item -AutoClose =E<gt> 0|1
711
712 This option is only valid when the C<$input> parameter is a filehandle. If
713 specified, and the value is true, it will result in the file being closed once
714 either the C<close> method is called or the IO::Uncompress::RawInflate object is
715 destroyed.
716
717 This parameter defaults to 0.
718
719 =item -MultiStream =E<gt> 0|1
720
721
722
723 This option is a no-op.
724
725
726
727 =item -Prime =E<gt> $string
728
729 This option will uncompress the contents of C<$string> before processing the
730 input file/buffer.
731
732 This option can be useful when the compressed data is embedded in another
733 file/data structure and it is not possible to work out where the compressed
734 data begins without having to read the first few bytes. If this is the
735 case, the uncompression can be I<primed> with these bytes using this
736 option.
737
738 =item -Transparent =E<gt> 0|1
739
740 If this option is set and the input file or buffer is not compressed data,
741 the module will allow reading of it anyway.
742
743 This option defaults to 1.
744
745 =item -BlockSize =E<gt> $num
746
747 When reading the compressed input data, IO::Uncompress::RawInflate will read it in
748 blocks of C<$num> bytes.
749
750 This option defaults to 4096.
751
752 =item -InputLength =E<gt> $size
753
754 When present this option will limit the number of compressed bytes read
755 from the input file/buffer to C<$size>. This option can be used in the
756 situation where there is useful data directly after the compressed data
757 stream and you know beforehand the exact length of the compressed data
758 stream. 
759
760 This option is mostly used when reading from a filehandle, in which case
761 the file pointer will be left pointing to the first byte directly after the
762 compressed data stream.
763
764
765
766 This option defaults to off.
767
768 =item -Append =E<gt> 0|1
769
770 This option controls what the C<read> method does with uncompressed data.
771
772 If set to 1, all uncompressed data will be appended to the output parameter
773 of the C<read> method.
774
775 If set to 0, the contents of the output parameter of the C<read> method
776 will be overwritten by the uncompressed data.
777
778 Defaults to 0.
779
780 =item -Strict =E<gt> 0|1
781
782
783
784 This option is a no-op.
785
786
787
788
789
790
791 =back
792
793 =head2 Examples
794
795 TODO
796
797 =head1 Methods 
798
799 =head2 read
800
801 Usage is
802
803     $status = $z->read($buffer)
804
805 Reads a block of compressed data (the size the the compressed block is
806 determined by the C<Buffer> option in the constructor), uncompresses it and
807 writes any uncompressed data into C<$buffer>. If the C<Append> parameter is
808 set in the constructor, the uncompressed data will be appended to the
809 C<$buffer> parameter. Otherwise C<$buffer> will be overwritten.
810
811 Returns the number of uncompressed bytes written to C<$buffer>, zero if eof
812 or a negative number on error.
813
814 =head2 read
815
816 Usage is
817
818     $status = $z->read($buffer, $length)
819     $status = $z->read($buffer, $length, $offset)
820
821     $status = read($z, $buffer, $length)
822     $status = read($z, $buffer, $length, $offset)
823
824 Attempt to read C<$length> bytes of uncompressed data into C<$buffer>.
825
826 The main difference between this form of the C<read> method and the
827 previous one, is that this one will attempt to return I<exactly> C<$length>
828 bytes. The only circumstances that this function will not is if end-of-file
829 or an IO error is encountered.
830
831 Returns the number of uncompressed bytes written to C<$buffer>, zero if eof
832 or a negative number on error.
833
834
835 =head2 getline
836
837 Usage is
838
839     $line = $z->getline()
840     $line = <$z>
841
842 Reads a single line. 
843
844 This method fully supports the use of of the variable C<$/>
845 (or C<$INPUT_RECORD_SEPARATOR> or C<$RS> when C<English> is in use) to
846 determine what constitutes an end of line. Both paragraph mode and file
847 slurp mode are supported. 
848
849
850 =head2 getc
851
852 Usage is 
853
854     $char = $z->getc()
855
856 Read a single character.
857
858 =head2 ungetc
859
860 Usage is
861
862     $char = $z->ungetc($string)
863
864
865
866 =head2 inflateSync
867
868 Usage is
869
870     $status = $z->inflateSync()
871
872 TODO
873
874
875 =head2 getHeaderInfo
876
877 Usage is
878
879     $hdr  = $z->getHeaderInfo();
880     @hdrs = $z->getHeaderInfo();
881
882 This method returns either a hash reference (in scalar context) or a list
883 or hash references (in array context) that contains information about each
884 of the header fields in the compressed data stream(s).
885
886
887
888
889 =head2 tell
890
891 Usage is
892
893     $z->tell()
894     tell $z
895
896 Returns the uncompressed file offset.
897
898 =head2 eof
899
900 Usage is
901
902     $z->eof();
903     eof($z);
904
905
906
907 Returns true if the end of the compressed input stream has been reached.
908
909
910
911 =head2 seek
912
913     $z->seek($position, $whence);
914     seek($z, $position, $whence);
915
916
917
918
919 Provides a sub-set of the C<seek> functionality, with the restriction
920 that it is only legal to seek forward in the input file/buffer.
921 It is a fatal error to attempt to seek backward.
922
923
924
925 The C<$whence> parameter takes one the usual values, namely SEEK_SET,
926 SEEK_CUR or SEEK_END.
927
928 Returns 1 on success, 0 on failure.
929
930 =head2 binmode
931
932 Usage is
933
934     $z->binmode
935     binmode $z ;
936
937 This is a noop provided for completeness.
938
939 =head2 opened
940
941     $z->opened()
942
943 Returns true if the object currently refers to a opened file/buffer. 
944
945 =head2 autoflush
946
947     my $prev = $z->autoflush()
948     my $prev = $z->autoflush(EXPR)
949
950 If the C<$z> object is associated with a file or a filehandle, this method
951 returns the current autoflush setting for the underlying filehandle. If
952 C<EXPR> is present, and is non-zero, it will enable flushing after every
953 write/print operation.
954
955 If C<$z> is associated with a buffer, this method has no effect and always
956 returns C<undef>.
957
958 B<Note> that the special variable C<$|> B<cannot> be used to set or
959 retrieve the autoflush setting.
960
961 =head2 input_line_number
962
963     $z->input_line_number()
964     $z->input_line_number(EXPR)
965
966
967
968 Returns the current uncompressed line number. If C<EXPR> is present it has
969 the effect of setting the line number. Note that setting the line number
970 does not change the current position within the file/buffer being read.
971
972 The contents of C<$/> are used to to determine what constitutes a line
973 terminator.
974
975
976
977 =head2 fileno
978
979     $z->fileno()
980     fileno($z)
981
982 If the C<$z> object is associated with a file or a filehandle, this method
983 will return the underlying file descriptor.
984
985 If the C<$z> object is is associated with a buffer, this method will
986 return undef.
987
988 =head2 close
989
990     $z->close() ;
991     close $z ;
992
993
994
995 Closes the output file/buffer. 
996
997
998
999 For most versions of Perl this method will be automatically invoked if
1000 the IO::Uncompress::RawInflate object is destroyed (either explicitly or by the
1001 variable with the reference to the object going out of scope). The
1002 exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In
1003 these cases, the C<close> method will be called automatically, but
1004 not until global destruction of all live objects when the program is
1005 terminating.
1006
1007 Therefore, if you want your scripts to be able to run on all versions
1008 of Perl, you should call C<close> explicitly and not rely on automatic
1009 closing.
1010
1011 Returns true on success, otherwise 0.
1012
1013 If the C<AutoClose> option has been enabled when the IO::Uncompress::RawInflate
1014 object was created, and the object is associated with a file, the
1015 underlying file will also be closed.
1016
1017
1018
1019
1020 =head1 Importing 
1021
1022 No symbolic constants are required by this IO::Uncompress::RawInflate at present. 
1023
1024 =over 5
1025
1026 =item :all
1027
1028 Imports C<rawinflate> and C<$RawInflateError>.
1029 Same as doing this
1030
1031     use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
1032
1033 =back
1034
1035 =head1 EXAMPLES
1036
1037
1038
1039
1040 =head1 SEE ALSO
1041
1042 L<Compress::Zlib>, L<IO::Compress::Gzip>, L<IO::Uncompress::Gunzip>, L<IO::Compress::Deflate>, L<IO::Uncompress::Inflate>, L<IO::Compress::RawDeflate>, L<IO::Compress::Bzip2>, L<IO::Uncompress::Bunzip2>, L<IO::Compress::Lzop>, L<IO::Uncompress::UnLzop>, L<IO::Uncompress::AnyInflate>, L<IO::Uncompress::AnyUncompress>
1043
1044 L<Compress::Zlib::FAQ|Compress::Zlib::FAQ>
1045
1046 L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>,
1047 L<Archive::Tar|Archive::Tar>,
1048 L<IO::Zlib|IO::Zlib>
1049
1050
1051 For RFC 1950, 1951 and 1952 see 
1052 F<http://www.faqs.org/rfcs/rfc1950.html>,
1053 F<http://www.faqs.org/rfcs/rfc1951.html> and
1054 F<http://www.faqs.org/rfcs/rfc1952.html>
1055
1056 The I<zlib> compression library was written by Jean-loup Gailly
1057 F<gzip@prep.ai.mit.edu> and Mark Adler F<madler@alumni.caltech.edu>.
1058
1059 The primary site for the I<zlib> compression library is
1060 F<http://www.zlib.org>.
1061
1062 The primary site for gzip is F<http://www.gzip.org>.
1063
1064
1065
1066
1067 =head1 AUTHOR
1068
1069 This module was written by Paul Marquess, F<pmqs@cpan.org>. 
1070
1071
1072
1073 =head1 MODIFICATION HISTORY
1074
1075 See the Changes file.
1076
1077 =head1 COPYRIGHT AND LICENSE
1078
1079 Copyright (c) 2005-2006 Paul Marquess. All rights reserved.
1080
1081 This program is free software; you can redistribute it and/or
1082 modify it under the same terms as Perl itself.
1083