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