IO::Compress::*
[p5sagit/p5-mst-13.2.git] / ext / Compress / IO / Zlib / lib / IO / Uncompress / RawInflate.pm
CommitLineData
642e522c 1package IO::Uncompress::RawInflate ;
2# for RFC1951
3
4use strict ;
5use warnings;
a02d0f6f 6use bytes;
1a6a8453 7
a02d0f6f 8use Compress::Raw::Zlib ;
9use IO::Compress::Base::Common qw(:Status createSelfTiedObject);
1a6a8453 10
11use IO::Uncompress::Base ;
a02d0f6f 12use IO::Uncompress::Adapter::Inflate ;
1a6a8453 13
14
15
642e522c 16
17require Exporter ;
1a6a8453 18our ($VERSION, @ISA, @EXPORT_OK, %EXPORT_TAGS, %DEFLATE_CONSTANTS, $RawInflateError);
642e522c 19
2b4e0969 20$VERSION = '2.000_11';
642e522c 21$RawInflateError = '';
22
1a6a8453 23@ISA = qw( Exporter IO::Uncompress::Base );
642e522c 24@EXPORT_OK = qw( $RawInflateError rawinflate ) ;
1a6a8453 25%DEFLATE_CONSTANTS = ();
26%EXPORT_TAGS = %IO::Uncompress::Base::EXPORT_TAGS ;
642e522c 27push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ;
28Exporter::export_ok_tags('all');
29
30
31
642e522c 32sub new
33{
1a6a8453 34 my $class = shift ;
35 my $obj = createSelfTiedObject($class, \$RawInflateError);
36 $obj->_create(undef, 0, @_);
642e522c 37}
38
39sub rawinflate
40{
1a6a8453 41 my $obj = createSelfTiedObject(undef, \$RawInflateError);
42 return $obj->_inf(@_);
43}
44
45sub getExtraParams
46{
47 return ();
48}
49
50sub ckParams
51{
52 my $self = shift ;
53 my $got = shift ;
54
55 return 1;
56}
57
58sub mkUncomp
59{
60 my $self = shift ;
61 my $class = shift ;
62 my $got = shift ;
63
a02d0f6f 64 my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::Inflate::mkUncompObject(
1a6a8453 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
86sub ckMagic
87{
88 my $self = shift;
89
90 return $self->_isRaw() ;
91}
92
93sub 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
107sub chkTrailer
108{
a02d0f6f 109 return STATUS_OK ;
1a6a8453 110}
111
112sub _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 ;
642e522c 128}
129
1a6a8453 130sub _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
a02d0f6f 149 my $buf_len = *$self->{Uncomp}->uncompressedBytes();
1a6a8453 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
179sub 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
268sub 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
285sub 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
312sub 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
642e522c 3261;
327
328__END__
329
330
331=head1 NAME
332
a02d0f6f 333
cb7abd7f 334
335IO::Uncompress::RawInflate - Read RFC 1951 files/buffers
336
642e522c 337
a02d0f6f 338
642e522c 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()
a02d0f6f 355 $char = $z->opened()
356
642e522c 357 $status = $z->inflateSync()
a02d0f6f 358
642e522c 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
388B<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
1a6a8453 406This module provides a Perl interface that allows the reading of
642e522c 407files/buffers that conform to RFC 1951.
408
1a6a8453 409For writing RFC 1951 files/buffers, see the companion module IO::Compress::RawDeflate.
642e522c 410
411
412
cb7abd7f 413
414
415
642e522c 416=head1 Functional Interface
417
1a6a8453 418A top-level function, C<rawinflate>, is provided to carry out
419"one-shot" uncompression between buffers and/or files. For finer
420control over the uncompression process, see the L</"OO Interface">
421section.
642e522c 422
423 use IO::Uncompress::RawInflate qw(rawinflate $RawInflateError) ;
424
425 rawinflate $input => $output [,OPTS]
426 or die "rawinflate failed: $RawInflateError\n";
427
1a6a8453 428
642e522c 429
430The functional interface needs Perl5.005 or better.
431
432
433=head2 rawinflate $input => $output [, OPTS]
434
1a6a8453 435
436C<rawinflate> expects at least two parameters, C<$input> and C<$output>.
642e522c 437
438=head3 The C<$input> parameter
439
440The parameter, C<$input>, is used to define the source of
441the compressed data.
442
443It can take one of the following forms:
444
445=over 5
446
447=item A filename
448
449If the C<$input> parameter is a simple scalar, it is assumed to be a
450filename. This file will be opened for reading and the input data
451will be read from it.
452
453=item A filehandle
454
455If the C<$input> parameter is a filehandle, the input data will be
456read from it.
457The string '-' can be used as an alias for standard input.
458
459=item A scalar reference
460
461If C<$input> is a scalar reference, the input data will be read
462from C<$$input>.
463
464=item An array reference
465
1a6a8453 466If C<$input> is an array reference, each element in the array must be a
467filename.
468
469The input data will be read from each file in turn.
470
642e522c 471The complete array will be walked to ensure that it only
1a6a8453 472contains valid filenames before any data is uncompressed.
473
474
642e522c 475
476=item An Input FileGlob string
477
478If C<$input> is a string that is delimited by the characters "<" and ">"
479C<rawinflate> will assume that it is an I<input fileglob string>. The
480input is the list of files that match the fileglob.
481
482If the fileglob does not match any files ...
483
484See L<File::GlobMapper|File::GlobMapper> for more details.
485
486
487=back
488
489If the C<$input> parameter is any other type, C<undef> will be returned.
490
491
492
493=head3 The C<$output> parameter
494
495The parameter C<$output> is used to control the destination of the
496uncompressed data. This parameter can take one of these forms.
497
498=over 5
499
500=item A filename
501
1a6a8453 502If the C<$output> parameter is a simple scalar, it is assumed to be a
503filename. This file will be opened for writing and the uncompressed
504data will be written to it.
642e522c 505
506=item A filehandle
507
1a6a8453 508If the C<$output> parameter is a filehandle, the uncompressed data
509will be written to it.
642e522c 510The string '-' can be used as an alias for standard output.
511
512
513=item A scalar reference
514
1a6a8453 515If C<$output> is a scalar reference, the uncompressed data will be
516stored in C<$$output>.
642e522c 517
518
642e522c 519
520=item An Array Reference
521
1a6a8453 522If C<$output> is an array reference, the uncompressed data will be
523pushed onto the array.
642e522c 524
525=item An Output FileGlob
526
527If C<$output> is a string that is delimited by the characters "<" and ">"
528C<rawinflate> will assume that it is an I<output fileglob string>. The
529output is the list of files that match the fileglob.
530
531When C<$output> is an fileglob string, C<$input> must also be a fileglob
532string. Anything else is an error.
533
534=back
535
536If the C<$output> parameter is any other type, C<undef> will be returned.
537
642e522c 538
642e522c 539
540=head2 Notes
541
542When C<$input> maps to multiple files/buffers and C<$output> is a single
1a6a8453 543file/buffer the uncompressed input files/buffers will all be stored
544in C<$output> as a single uncompressed stream.
642e522c 545
546
547
548=head2 Optional Parameters
549
550Unless specified below, the optional parameters for C<rawinflate>,
551C<OPTS>, are the same as those used with the OO interface defined in the
552L</"Constructor Options"> section below.
553
554=over 5
555
556=item AutoClose =E<gt> 0|1
557
1a6a8453 558This option applies to any input or output data streams to
559C<rawinflate> that are filehandles.
642e522c 560
561If C<AutoClose> is specified, and the value is true, it will result in all
562input and/or output filehandles being closed once C<rawinflate> has
563completed.
564
565This parameter defaults to 0.
566
567
568
1a6a8453 569=item BinModeOut =E<gt> 0|1
570
571When writing to a file or filehandle, set C<binmode> before writing to the
572file.
573
574Defaults to 0.
575
576
577
578
579
642e522c 580=item -Append =E<gt> 0|1
581
582TODO
583
1a6a8453 584=item -MultiStream =E<gt> 0|1
585
586Creates a new stream after each file.
587
588Defaults to 1.
589
642e522c 590
591
592=back
593
594
595
596
597=head2 Examples
598
599To read the contents of the file C<file1.txt.1951> and write the
600compressed 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
612To read from an existing Perl filehandle, C<$input>, and write the
613uncompressed 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
626To 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
635and 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
653The 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
659Returns an C<IO::Uncompress::RawInflate> object on success and undef on failure.
660The variable C<$RawInflateError> will contain an error message on failure.
661
1a6a8453 662If you are running Perl 5.005 or better the object, C<$z>, returned from
663IO::Uncompress::RawInflate can be used exactly like an L<IO::File|IO::File> filehandle.
664This means that all normal input file operations can be carried out with
665C<$z>. For example, to read a line from a compressed file/buffer you can
666use either of these forms
642e522c 667
668 $line = $z->getline();
669 $line = <$z>;
670
671The mandatory parameter C<$input> is used to determine the source of the
672compressed data. This parameter can take one of three forms.
673
674=over 5
675
676=item A filename
677
678If the C<$input> parameter is a scalar, it is assumed to be a filename. This
679file will be opened for reading and the compressed data will be read from it.
680
681=item A filehandle
682
683If the C<$input> parameter is a filehandle, the compressed data will be
684read from it.
685The string '-' can be used as an alias for standard input.
686
687
688=item A scalar reference
689
690If C<$input> is a scalar reference, the compressed data will be read from
691C<$$output>.
692
693=back
694
695=head2 Constructor Options
696
697
698The option names defined below are case insensitive and can be optionally
699prefixed by a '-'. So all of the following are valid
700
701 -AutoClose
702 -autoclose
703 AUTOCLOSE
704 autoclose
705
706OPTS is a combination of the following options:
707
708=over 5
709
710=item -AutoClose =E<gt> 0|1
711
712This option is only valid when the C<$input> parameter is a filehandle. If
713specified, and the value is true, it will result in the file being closed once
714either the C<close> method is called or the IO::Uncompress::RawInflate object is
715destroyed.
716
717This parameter defaults to 0.
718
719=item -MultiStream =E<gt> 0|1
720
721
722
723This option is a no-op.
724
725
726
727=item -Prime =E<gt> $string
728
729This option will uncompress the contents of C<$string> before processing the
730input file/buffer.
731
732This option can be useful when the compressed data is embedded in another
733file/data structure and it is not possible to work out where the compressed
1a6a8453 734data begins without having to read the first few bytes. If this is the
735case, the uncompression can be I<primed> with these bytes using this
736option.
642e522c 737
738=item -Transparent =E<gt> 0|1
739
740If this option is set and the input file or buffer is not compressed data,
741the module will allow reading of it anyway.
742
743This option defaults to 1.
744
745=item -BlockSize =E<gt> $num
746
1a6a8453 747When reading the compressed input data, IO::Uncompress::RawInflate will read it in
748blocks of C<$num> bytes.
642e522c 749
750This option defaults to 4096.
751
752=item -InputLength =E<gt> $size
753
1a6a8453 754When present this option will limit the number of compressed bytes read
755from the input file/buffer to C<$size>. This option can be used in the
756situation where there is useful data directly after the compressed data
757stream and you know beforehand the exact length of the compressed data
758stream.
642e522c 759
1a6a8453 760This option is mostly used when reading from a filehandle, in which case
761the file pointer will be left pointing to the first byte directly after the
642e522c 762compressed data stream.
763
764
765
766This option defaults to off.
767
768=item -Append =E<gt> 0|1
769
770This option controls what the C<read> method does with uncompressed data.
771
1a6a8453 772If set to 1, all uncompressed data will be appended to the output parameter
773of the C<read> method.
642e522c 774
1a6a8453 775If set to 0, the contents of the output parameter of the C<read> method
776will be overwritten by the uncompressed data.
642e522c 777
778Defaults to 0.
779
780=item -Strict =E<gt> 0|1
781
782
783
784This option is a no-op.
785
786
787
788
789
a02d0f6f 790
642e522c 791=back
792
793=head2 Examples
794
795TODO
796
797=head1 Methods
798
799=head2 read
800
801Usage is
802
803 $status = $z->read($buffer)
804
805Reads a block of compressed data (the size the the compressed block is
806determined by the C<Buffer> option in the constructor), uncompresses it and
1a6a8453 807writes any uncompressed data into C<$buffer>. If the C<Append> parameter is
808set in the constructor, the uncompressed data will be appended to the
809C<$buffer> parameter. Otherwise C<$buffer> will be overwritten.
642e522c 810
1a6a8453 811Returns the number of uncompressed bytes written to C<$buffer>, zero if eof
812or a negative number on error.
642e522c 813
814=head2 read
815
816Usage 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
824Attempt to read C<$length> bytes of uncompressed data into C<$buffer>.
825
1a6a8453 826The main difference between this form of the C<read> method and the
827previous one, is that this one will attempt to return I<exactly> C<$length>
828bytes. The only circumstances that this function will not is if end-of-file
829or an IO error is encountered.
642e522c 830
1a6a8453 831Returns the number of uncompressed bytes written to C<$buffer>, zero if eof
832or a negative number on error.
642e522c 833
834
835=head2 getline
836
837Usage is
838
839 $line = $z->getline()
840 $line = <$z>
841
842Reads a single line.
843
844This 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
846determine what constitutes an end of line. Both paragraph mode and file
847slurp mode are supported.
848
849
850=head2 getc
851
852Usage is
853
854 $char = $z->getc()
855
856Read a single character.
857
858=head2 ungetc
859
860Usage is
861
862 $char = $z->ungetc($string)
863
864
a02d0f6f 865
642e522c 866=head2 inflateSync
867
868Usage is
869
870 $status = $z->inflateSync()
871
872TODO
873
a02d0f6f 874
642e522c 875=head2 getHeaderInfo
876
877Usage is
878
1a6a8453 879 $hdr = $z->getHeaderInfo();
880 @hdrs = $z->getHeaderInfo();
642e522c 881
1a6a8453 882This method returns either a hash reference (in scalar context) or a list
883or hash references (in array context) that contains information about each
884of the header fields in the compressed data stream(s).
642e522c 885
886
887
888
889=head2 tell
890
891Usage is
892
893 $z->tell()
894 tell $z
895
896Returns the uncompressed file offset.
897
898=head2 eof
899
900Usage is
901
902 $z->eof();
903 eof($z);
904
905
906
907Returns 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
919Provides a sub-set of the C<seek> functionality, with the restriction
920that it is only legal to seek forward in the input file/buffer.
921It is a fatal error to attempt to seek backward.
922
923
924
925The C<$whence> parameter takes one the usual values, namely SEEK_SET,
926SEEK_CUR or SEEK_END.
927
928Returns 1 on success, 0 on failure.
929
930=head2 binmode
931
932Usage is
933
934 $z->binmode
935 binmode $z ;
936
937This is a noop provided for completeness.
938
a02d0f6f 939=head2 opened
940
941 $z->opened()
942
943Returns 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
950If the C<$z> object is associated with a file or a filehandle, this method
951returns the current autoflush setting for the underlying filehandle. If
952C<EXPR> is present, and is non-zero, it will enable flushing after every
953write/print operation.
954
955If C<$z> is associated with a buffer, this method has no effect and always
956returns C<undef>.
957
958B<Note> that the special variable C<$|> B<cannot> be used to set or
959retrieve the autoflush setting.
960
961=head2 input_line_number
962
963 $z->input_line_number()
964 $z->input_line_number(EXPR)
965
966
967
968Returns the current uncompressed line number. If C<EXPR> is present it has
969the effect of setting the line number. Note that setting the line number
970does not change the current position within the file/buffer being read.
971
972The contents of C<$/> are used to to determine what constitutes a line
973terminator.
974
975
976
642e522c 977=head2 fileno
978
979 $z->fileno()
980 fileno($z)
981
a02d0f6f 982If the C<$z> object is associated with a file or a filehandle, this method
983will return the underlying file descriptor.
642e522c 984
985If the C<$z> object is is associated with a buffer, this method will
986return undef.
987
988=head2 close
989
990 $z->close() ;
991 close $z ;
992
993
994
995Closes the output file/buffer.
996
997
998
999For most versions of Perl this method will be automatically invoked if
1000the IO::Uncompress::RawInflate object is destroyed (either explicitly or by the
1001variable with the reference to the object going out of scope). The
1002exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In
1003these cases, the C<close> method will be called automatically, but
1004not until global destruction of all live objects when the program is
1005terminating.
1006
1007Therefore, if you want your scripts to be able to run on all versions
1008of Perl, you should call C<close> explicitly and not rely on automatic
1009closing.
1010
1011Returns true on success, otherwise 0.
1012
1013If the C<AutoClose> option has been enabled when the IO::Uncompress::RawInflate
1014object was created, and the object is associated with a file, the
1015underlying file will also be closed.
1016
1017
1018
1019
1020=head1 Importing
1021
1022No symbolic constants are required by this IO::Uncompress::RawInflate at present.
1023
1024=over 5
1025
1026=item :all
1027
1028Imports C<rawinflate> and C<$RawInflateError>.
1029Same 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
a02d0f6f 1042L<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>
642e522c 1043
1044L<Compress::Zlib::FAQ|Compress::Zlib::FAQ>
1045
a02d0f6f 1046L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>,
1047L<Archive::Tar|Archive::Tar>,
642e522c 1048L<IO::Zlib|IO::Zlib>
1049
a02d0f6f 1050
642e522c 1051For RFC 1950, 1951 and 1952 see
1052F<http://www.faqs.org/rfcs/rfc1950.html>,
1053F<http://www.faqs.org/rfcs/rfc1951.html> and
1054F<http://www.faqs.org/rfcs/rfc1952.html>
1055
a02d0f6f 1056The I<zlib> compression library was written by Jean-loup Gailly
1057F<gzip@prep.ai.mit.edu> and Mark Adler F<madler@alumni.caltech.edu>.
1058
1059The primary site for the I<zlib> compression library is
1060F<http://www.zlib.org>.
1061
1062The primary site for gzip is F<http://www.gzip.org>.
1063
1064
1065
1066
642e522c 1067=head1 AUTHOR
1068
cb7abd7f 1069This module was written by Paul Marquess, F<pmqs@cpan.org>.
642e522c 1070
642e522c 1071
642e522c 1072
1073=head1 MODIFICATION HISTORY
1074
1075See the Changes file.
1076
1077=head1 COPYRIGHT AND LICENSE
642e522c 1078
1a6a8453 1079Copyright (c) 2005-2006 Paul Marquess. All rights reserved.
a02d0f6f 1080
642e522c 1081This program is free software; you can redistribute it and/or
1082modify it under the same terms as Perl itself.
1083