1 package IO::Compress::RawDeflate ;
10 use IO::Compress::Base;
11 use IO::Compress::Base::Common qw(:Status createSelfTiedObject);
12 use IO::Compress::Adapter::Deflate ;
17 our ($VERSION, @ISA, @EXPORT_OK, %DEFLATE_CONSTANTS, %EXPORT_TAGS, $RawDeflateError);
19 $VERSION = '2.000_14';
20 $RawDeflateError = '';
22 @ISA = qw(Exporter IO::Compress::Base);
23 @EXPORT_OK = qw( $RawDeflateError rawdeflate ) ;
24 push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ;
26 %EXPORT_TAGS = ( flush => [qw{
52 foreach (keys %EXPORT_TAGS )
54 push @{$EXPORT_TAGS{constants}},
58 $EXPORT_TAGS{all} = $EXPORT_TAGS{constants} ;
61 %DEFLATE_CONSTANTS = %EXPORT_TAGS;
63 Exporter::export_ok_tags('all');
71 my $obj = createSelfTiedObject($class, \$RawDeflateError);
73 return $obj->_create(undef, @_);
78 my $obj = createSelfTiedObject(undef, \$RawDeflateError);
79 return $obj->_def(@_);
96 my ($obj, $errstr, $errno) = IO::Compress::Adapter::Deflate::mkCompObject(
98 $got->value('Adler32'),
100 $got->value('Strategy')
103 return $self->saveErrorString(undef, $errstr, $errno)
137 return $self->getZlibParams();
144 use IO::Compress::Base::Common qw(:Parse);
145 use Compress::Raw::Zlib qw(Z_DEFLATED Z_DEFAULT_COMPRESSION Z_DEFAULT_STRATEGY);
151 #'Method' => [0, 1, Parse_unsigned, Z_DEFLATED],
152 'Level' => [0, 1, Parse_signed, Z_DEFAULT_COMPRESSION],
153 'Strategy' => [0, 1, Parse_signed, Z_DEFAULT_STRATEGY],
155 'CRC32' => [0, 1, Parse_boolean, 0],
156 'ADLER32' => [0, 1, Parse_boolean, 0],
157 'Merge' => [1, 1, Parse_boolean, 0],
165 return ('IO::Uncompress::RawInflate',
166 \$IO::Uncompress::RawInflate::RawInflateError);
177 use IO::Seekable qw(SEEK_SET);
182 my $outValue = shift ;
183 my $outType = shift ;
185 my ($invClass, $error_ref) = $self->getInverseClass();
186 eval "require $invClass"
189 my $inf = $invClass->new( $outValue,
194 or return $self->saveErrorString(undef, "Cannot create InflateScan object: $$error_ref" ) ;
198 or return $self->saveErrorString(undef, "Error Scanning: $$error_ref", $inf->errorNo) ;
199 $inf->zap($end_offset)
200 or return $self->saveErrorString(undef, "Error Zapping: $$error_ref", $inf->errorNo) ;
202 my $def = *$self->{Compress} = $inf->createDeflate();
204 *$self->{Header} = *$inf->{Info}{Header};
205 *$self->{UnCompSize} = *$inf->{UnCompSize}->clone();
206 *$self->{CompSize} = *$inf->{CompSize}->clone();
208 #*$self->{CompSize} = new U64(0, *$self->{UnCompSize_32bit});
211 if ( $outType eq 'buffer')
212 { substr( ${ *$self->{Buffer} }, $end_offset) = '' }
213 elsif ($outType eq 'handle' || $outType eq 'filename') {
214 *$self->{FH} = *$inf->{FH} ;
216 *$self->{FH}->flush() ;
217 *$self->{Handle} = 1 if $outType eq 'handle';
219 #seek(*$self->{FH}, $end_offset, SEEK_SET)
220 *$self->{FH}->seek($end_offset, SEEK_SET)
221 or return $self->saveErrorString(undef, $!, $!) ;
227 #### zlib specific methods
234 my $strategy = shift ;
236 my $status = *$self->{Compress}->deflateParams(Level => $level, Strategy => $strategy) ;
237 return $self->saveErrorString(0, *$self->{Compress}{Error}, *$self->{Compress}{ErrorNo})
238 if $status == STATUS_ERROR;
254 IO::Compress::RawDeflate - Write RFC 1951 files/buffers
260 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
263 my $status = rawdeflate $input => $output [,OPTS]
264 or die "rawdeflate failed: $RawDeflateError\n";
266 my $z = new IO::Compress::RawDeflate $output [,OPTS]
267 or die "rawdeflate failed: $RawDeflateError\n";
270 $z->printf($format, $string);
272 $z->syswrite($string [, $length, $offset]);
276 $z->seek($position, $whence);
281 $z->input_line_number();
282 $z->newStream( [OPTS] );
293 printf $z $format, $string;
296 seek $z, $position, $whence
306 B<WARNING -- This is a Beta release>.
310 =item * DO NOT use in production code.
312 =item * The documentation is incomplete in places.
314 =item * Parts of the interface defined here are tentative.
316 =item * Please report any problems you find.
323 This module provides a Perl interface that allows writing compressed
324 data to files or buffer as defined in RFC 1951.
332 Note that RFC 1951 data is not a good choice of compression format
333 to use in isolation, especially if you want to auto-detect it.
339 For reading RFC 1951 files/buffers, see the companion module
340 L<IO::Uncompress::RawInflate|IO::Uncompress::RawInflate>.
343 =head1 Functional Interface
345 A top-level function, C<rawdeflate>, is provided to carry out
346 "one-shot" compression between buffers and/or files. For finer
347 control over the compression process, see the L</"OO Interface">
350 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
352 rawdeflate $input => $output [,OPTS]
353 or die "rawdeflate failed: $RawDeflateError\n";
357 The functional interface needs Perl5.005 or better.
360 =head2 rawdeflate $input => $output [, OPTS]
363 C<rawdeflate> expects at least two parameters, C<$input> and C<$output>.
365 =head3 The C<$input> parameter
367 The parameter, C<$input>, is used to define the source of
368 the uncompressed data.
370 It can take one of the following forms:
376 If the C<$input> parameter is a simple scalar, it is assumed to be a
377 filename. This file will be opened for reading and the input data
378 will be read from it.
382 If the C<$input> parameter is a filehandle, the input data will be
384 The string '-' can be used as an alias for standard input.
386 =item A scalar reference
388 If C<$input> is a scalar reference, the input data will be read
391 =item An array reference
393 If C<$input> is an array reference, each element in the array must be a
396 The input data will be read from each file in turn.
398 The complete array will be walked to ensure that it only
399 contains valid filenames before any data is compressed.
403 =item An Input FileGlob string
405 If C<$input> is a string that is delimited by the characters "<" and ">"
406 C<rawdeflate> will assume that it is an I<input fileglob string>. The
407 input is the list of files that match the fileglob.
409 If the fileglob does not match any files ...
411 See L<File::GlobMapper|File::GlobMapper> for more details.
416 If the C<$input> parameter is any other type, C<undef> will be returned.
420 =head3 The C<$output> parameter
422 The parameter C<$output> is used to control the destination of the
423 compressed data. This parameter can take one of these forms.
429 If the C<$output> parameter is a simple scalar, it is assumed to be a
430 filename. This file will be opened for writing and the compressed
431 data will be written to it.
435 If the C<$output> parameter is a filehandle, the compressed data
436 will be written to it.
437 The string '-' can be used as an alias for standard output.
440 =item A scalar reference
442 If C<$output> is a scalar reference, the compressed data will be
443 stored in C<$$output>.
447 =item An Array Reference
449 If C<$output> is an array reference, the compressed data will be
450 pushed onto the array.
452 =item An Output FileGlob
454 If C<$output> is a string that is delimited by the characters "<" and ">"
455 C<rawdeflate> will assume that it is an I<output fileglob string>. The
456 output is the list of files that match the fileglob.
458 When C<$output> is an fileglob string, C<$input> must also be a fileglob
459 string. Anything else is an error.
463 If the C<$output> parameter is any other type, C<undef> will be returned.
471 When C<$input> maps to multiple files/buffers and C<$output> is a single
472 file/buffer the input files/buffers will be stored
473 in C<$output> as a concatenated series of compressed data streams.
480 =head2 Optional Parameters
482 Unless specified below, the optional parameters for C<rawdeflate>,
483 C<OPTS>, are the same as those used with the OO interface defined in the
484 L</"Constructor Options"> section below.
488 =item C<< AutoClose => 0|1 >>
490 This option applies to any input or output data streams to
491 C<rawdeflate> that are filehandles.
493 If C<AutoClose> is specified, and the value is true, it will result in all
494 input and/or output filehandles being closed once C<rawdeflate> has
497 This parameter defaults to 0.
500 =item C<< BinModeIn => 0|1 >>
502 When reading from a file or filehandle, set C<binmode> before reading.
510 =item C<< Append => 0|1 >>
522 To read the contents of the file C<file1.txt> and write the compressed
523 data to the file C<file1.txt.1951>.
527 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
529 my $input = "file1.txt";
530 rawdeflate $input => "$input.1951"
531 or die "rawdeflate failed: $RawDeflateError\n";
534 To read from an existing Perl filehandle, C<$input>, and write the
535 compressed data to a buffer, C<$buffer>.
539 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
542 my $input = new IO::File "<file1.txt"
543 or die "Cannot open 'file1.txt': $!\n" ;
545 rawdeflate $input => \$buffer
546 or die "rawdeflate failed: $RawDeflateError\n";
548 To compress all files in the directory "/my/home" that match "*.txt"
549 and store the compressed data in the same directory
553 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
555 rawdeflate '</my/home/*.txt>' => '<*.1951>'
556 or die "rawdeflate failed: $RawDeflateError\n";
558 and if you want to compress each file one at a time, this will do the trick
562 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError) ;
564 for my $input ( glob "/my/home/*.txt" )
566 my $output = "$input.1951" ;
567 rawdeflate $input => $output
568 or die "Error compressing '$input': $RawDeflateError\n";
576 The format of the constructor for C<IO::Compress::RawDeflate> is shown below
578 my $z = new IO::Compress::RawDeflate $output [,OPTS]
579 or die "IO::Compress::RawDeflate failed: $RawDeflateError\n";
581 It returns an C<IO::Compress::RawDeflate> object on success and undef on failure.
582 The variable C<$RawDeflateError> will contain an error message on failure.
584 If you are running Perl 5.005 or better the object, C<$z>, returned from
585 IO::Compress::RawDeflate can be used exactly like an L<IO::File|IO::File> filehandle.
586 This means that all normal output file operations can be carried out
588 For example, to write to a compressed file/buffer you can use either of
591 $z->print("hello world\n");
592 print $z "hello world\n";
594 The mandatory parameter C<$output> is used to control the destination
595 of the compressed data. This parameter can take one of these forms.
601 If the C<$output> parameter is a simple scalar, it is assumed to be a
602 filename. This file will be opened for writing and the compressed data
603 will be written to it.
607 If the C<$output> parameter is a filehandle, the compressed data will be
609 The string '-' can be used as an alias for standard output.
612 =item A scalar reference
614 If C<$output> is a scalar reference, the compressed data will be stored
619 If the C<$output> parameter is any other type, C<IO::Compress::RawDeflate>::new will
622 =head2 Constructor Options
624 C<OPTS> is any combination of the following options:
628 =item C<< AutoClose => 0|1 >>
630 This option is only valid when the C<$output> parameter is a filehandle. If
631 specified, and the value is true, it will result in the C<$output> being
632 closed once either the C<close> method is called or the C<IO::Compress::RawDeflate>
635 This parameter defaults to 0.
637 =item C<< Append => 0|1 >>
639 Opens C<$output> in append mode.
641 The behaviour of this option is dependent on the type of C<$output>.
647 If C<$output> is a buffer and C<Append> is enabled, all compressed data
648 will be append to the end if C<$output>. Otherwise C<$output> will be
649 cleared before any data is written to it.
653 If C<$output> is a filename and C<Append> is enabled, the file will be
654 opened in append mode. Otherwise the contents of the file, if any, will be
655 truncated before any compressed data is written to it.
659 If C<$output> is a filehandle, the file pointer will be positioned to the
660 end of the file via a call to C<seek> before any compressed data is written
661 to it. Otherwise the file pointer will not be moved.
665 This parameter defaults to 0.
671 =item C<< Merge => 0|1 >>
673 This option is used to compress input data and append it to an existing
674 compressed data stream in C<$output>. The end result is a single compressed
675 data stream stored in C<$output>.
679 It is a fatal error to attempt to use this option when C<$output> is not an
680 RFC 1951 data stream.
684 There are a number of other limitations with the C<Merge> option:
690 This module needs to have been built with zlib 1.2.1 or better to work. A
691 fatal error will be thrown if C<Merge> is used with an older version of
696 If C<$output> is a file or a filehandle, it must be seekable.
701 This parameter defaults to 0.
707 Defines the compression level used by zlib. The value should either be
708 a number between 0 and 9 (0 means no compression and 9 is maximum
709 compression), or one of the symbolic constants defined below.
714 Z_DEFAULT_COMPRESSION
716 The default is Z_DEFAULT_COMPRESSION.
718 Note, these constants are not imported by C<IO::Compress::RawDeflate> by default.
720 use IO::Compress::RawDeflate qw(:strategy);
721 use IO::Compress::RawDeflate qw(:constants);
722 use IO::Compress::RawDeflate qw(:all);
726 Defines the strategy used to tune the compression. Use one of the symbolic
727 constants defined below.
735 The default is Z_DEFAULT_STRATEGY.
742 =item C<< Strict => 0|1 >>
746 This is a placeholder option.
765 Compresses and outputs the contents of the C<$data> parameter. This
766 has the same behaviour as the C<print> built-in.
768 Returns true if successful.
774 $z->printf($format, $data)
775 printf $z $format, $data
777 Compresses and outputs the contents of the C<$data> parameter.
779 Returns true if successful.
786 $z->syswrite $data, $length
787 $z->syswrite $data, $length, $offset
789 Compresses and outputs the contents of the C<$data> parameter.
791 Returns the number of uncompressed bytes written, or C<undef> if
799 $z->write $data, $length
800 $z->write $data, $length, $offset
802 Compresses and outputs the contents of the C<$data> parameter.
804 Returns the number of uncompressed bytes written, or C<undef> if
813 $z->flush($flush_type);
816 Flushes any pending compressed data to the output file/buffer.
819 This method takes an optional parameter, C<$flush_type>, that controls
820 how the flushing will be carried out. By default the C<$flush_type>
821 used is C<Z_FINISH>. Other valid values for C<$flush_type> are
822 C<Z_NO_FLUSH>, C<Z_SYNC_FLUSH>, C<Z_FULL_FLUSH> and C<Z_BLOCK>. It is
823 strongly recommended that you only set the C<flush_type> parameter if
824 you fully understand the implications of what it does - overuse of C<flush>
825 can seriously degrade the level of compression achieved. See the C<zlib>
826 documentation for details.
829 Returns true on success.
839 Returns the uncompressed file offset.
850 Returns true if the C<close> method has been called.
856 $z->seek($position, $whence);
857 seek($z, $position, $whence);
862 Provides a sub-set of the C<seek> functionality, with the restriction
863 that it is only legal to seek forward in the output file/buffer.
864 It is a fatal error to attempt to seek backward.
866 Empty parts of the file/buffer will have NULL (0x00) bytes written to them.
870 The C<$whence> parameter takes one the usual values, namely SEEK_SET,
871 SEEK_CUR or SEEK_END.
873 Returns 1 on success, 0 on failure.
882 This is a noop provided for completeness.
888 Returns true if the object currently refers to a opened file/buffer.
892 my $prev = $z->autoflush()
893 my $prev = $z->autoflush(EXPR)
895 If the C<$z> object is associated with a file or a filehandle, this method
896 returns the current autoflush setting for the underlying filehandle. If
897 C<EXPR> is present, and is non-zero, it will enable flushing after every
898 write/print operation.
900 If C<$z> is associated with a buffer, this method has no effect and always
903 B<Note> that the special variable C<$|> B<cannot> be used to set or
904 retrieve the autoflush setting.
906 =head2 input_line_number
908 $z->input_line_number()
909 $z->input_line_number(EXPR)
912 This method always returns C<undef> when compressing.
921 If the C<$z> object is associated with a file or a filehandle, this method
922 will return the underlying file descriptor.
924 If the C<$z> object is is associated with a buffer, this method will
934 Flushes any pending compressed data and then closes the output file/buffer.
938 For most versions of Perl this method will be automatically invoked if
939 the IO::Compress::RawDeflate object is destroyed (either explicitly or by the
940 variable with the reference to the object going out of scope). The
941 exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In
942 these cases, the C<close> method will be called automatically, but
943 not until global destruction of all live objects when the program is
946 Therefore, if you want your scripts to be able to run on all versions
947 of Perl, you should call C<close> explicitly and not rely on automatic
950 Returns true on success, otherwise 0.
952 If the C<AutoClose> option has been enabled when the IO::Compress::RawDeflate
953 object was created, and the object is associated with a file, the
954 underlying file will also be closed.
959 =head2 newStream([OPTS])
963 $z->newStream( [OPTS] )
965 Closes the current compressed data stream and starts a new one.
967 OPTS consists of any of the the options that are available when creating
970 See the L</"Constructor Options"> section for more details.
985 A number of symbolic constants are required by some methods in
986 C<IO::Compress::RawDeflate>. None are imported by default.
995 Imports C<rawdeflate>, C<$RawDeflateError> and all symbolic
996 constants that can be used by C<IO::Compress::RawDeflate>. Same as doing this
998 use IO::Compress::RawDeflate qw(rawdeflate $RawDeflateError :constants) ;
1002 Import all symbolic constants. Same as doing this
1005 use IO::Compress::RawDeflate qw(:flush :level :strategy) ;
1010 These symbolic constants are used by the C<flush> method.
1021 These symbolic constants are used by the C<Level> option in the constructor.
1026 Z_DEFAULT_COMPRESSION
1031 These symbolic constants are used by the C<Strategy> option in the constructor.
1062 L<Compress::Zlib>, L<IO::Compress::Gzip>, L<IO::Uncompress::Gunzip>, L<IO::Compress::Deflate>, L<IO::Uncompress::Inflate>, L<IO::Uncompress::RawInflate>, L<IO::Compress::Bzip2>, L<IO::Uncompress::Bunzip2>, L<IO::Compress::Lzop>, L<IO::Uncompress::UnLzop>, L<IO::Compress::Lzf>, L<IO::Uncompress::UnLzf>, L<IO::Uncompress::AnyInflate>, L<IO::Uncompress::AnyUncompress>
1064 L<Compress::Zlib::FAQ|Compress::Zlib::FAQ>
1066 L<File::GlobMapper|File::GlobMapper>, L<Archive::Zip|Archive::Zip>,
1067 L<Archive::Tar|Archive::Tar>,
1068 L<IO::Zlib|IO::Zlib>
1071 For RFC 1950, 1951 and 1952 see
1072 F<http://www.faqs.org/rfcs/rfc1950.html>,
1073 F<http://www.faqs.org/rfcs/rfc1951.html> and
1074 F<http://www.faqs.org/rfcs/rfc1952.html>
1076 The I<zlib> compression library was written by Jean-loup Gailly
1077 F<gzip@prep.ai.mit.edu> and Mark Adler F<madler@alumni.caltech.edu>.
1079 The primary site for the I<zlib> compression library is
1080 F<http://www.zlib.org>.
1082 The primary site for gzip is F<http://www.gzip.org>.
1089 This module was written by Paul Marquess, F<pmqs@cpan.org>.
1093 =head1 MODIFICATION HISTORY
1095 See the Changes file.
1097 =head1 COPYRIGHT AND LICENSE
1099 Copyright (c) 2005-2006 Paul Marquess. All rights reserved.
1101 This program is free software; you can redistribute it and/or
1102 modify it under the same terms as Perl itself.