package IO::Compress::Lzma ;
use strict ;
use warnings;
use bytes;
require Exporter ;
use IO::Compress::Base 2.101 ;
use IO::Compress::Base::Common 2.101 qw(createSelfTiedObject);
use IO::Compress::Adapter::Lzma 2.101 ;
our ($VERSION, @ISA, @EXPORT_OK, %EXPORT_TAGS, $LzmaError);
$VERSION = '2.101';
$LzmaError = '';
@ISA = qw(IO::Compress::Base Exporter);
@EXPORT_OK = qw( $LzmaError lzma ) ;
%EXPORT_TAGS = %IO::Compress::Base::EXPORT_TAGS ;
push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ;
Exporter::export_ok_tags('all');
sub new
{
my $class = shift ;
my $obj = createSelfTiedObject($class, \$LzmaError);
return $obj->_create(undef, @_);
}
sub lzma
{
my $obj = createSelfTiedObject(undef, \$LzmaError);
$obj->_def(@_);
}
sub mkHeader
{
my $self = shift ;
return '';
}
our %PARAMS = ('filter' => [IO::Compress::Base::Common::Parse_any, [] ],
);
sub getExtraParams
{
return %PARAMS ;
}
sub ckParams
{
my $self = shift ;
my $got = shift;
# TODO - test that Filter ISA Lzma::Filter::Lzma1
return 1 ;
}
sub mkComp
{
my $self = shift ;
my $got = shift ;
my ($obj, $errstr, $errno) =
IO::Compress::Adapter::Lzma::mkCompObject($got->getValue('filter'));
return $self->saveErrorString(undef, $errstr, $errno)
if ! defined $obj;
return $obj;
}
sub mkTrailer
{
my $self = shift ;
return '';
}
sub mkFinalTrailer
{
return '';
}
#sub newHeader
#{
# my $self = shift ;
# return '';
#}
sub getInverseClass
{
return ('IO::Uncompress::UnLzma');
}
sub getFileInfo
{
my $self = shift ;
my $params = shift;
my $file = shift ;
}
1;
__END__
=head1 NAME
IO::Compress::Lzma - Write lzma files/buffers
=head1 SYNOPSIS
use IO::Compress::Lzma qw(lzma $LzmaError) ;
my $status = lzma $input => $output [,OPTS]
or die "lzma failed: $LzmaError\n";
my $z = IO::Compress::Lzma->new( $output [,OPTS] )
or die "lzma failed: $LzmaError\n";
$z->print($string);
$z->printf($format, $string);
$z->write($string);
$z->syswrite($string [, $length, $offset]);
$z->flush();
$z->tell();
$z->eof();
$z->seek($position, $whence);
$z->binmode();
$z->fileno();
$z->opened();
$z->autoflush();
$z->input_line_number();
$z->newStream( [OPTS] );
$z->close() ;
$LzmaError ;
# IO::File mode
print $z $string;
printf $z $format, $string;
tell $z
eof $z
seek $z, $position, $whence
binmode $z
fileno $z
close $z ;
=head1 DESCRIPTION
This module provides a Perl interface that allows writing lzma
compressed data to files or buffer.
For reading lzma files/buffers, see the companion module
L.
=head1 Functional Interface
A top-level function, C, is provided to carry out
"one-shot" compression between buffers and/or files. For finer
control over the compression process, see the L
section.
use IO::Compress::Lzma qw(lzma $LzmaError) ;
lzma $input_filename_or_reference => $output_filename_or_reference [,OPTS]
or die "lzma failed: $LzmaError\n";
The functional interface needs Perl5.005 or better.
=head2 lzma $input_filename_or_reference => $output_filename_or_reference [, OPTS]
C expects at least two parameters,
C<$input_filename_or_reference> and C<$output_filename_or_reference>
and zero or more optional parameters (see L)
=head3 The C<$input_filename_or_reference> parameter
The parameter, C<$input_filename_or_reference>, is used to define the
source of the uncompressed data.
It can take one of the following forms:
=over 5
=item A filename
If the C<$input_filename_or_reference> parameter is a simple scalar, it is
assumed to be a filename. This file will be opened for reading and the
input data will be read from it.
=item A filehandle
If the C<$input_filename_or_reference> parameter is a filehandle, the input
data will be read from it. The string '-' can be used as an alias for
standard input.
=item A scalar reference
If C<$input_filename_or_reference> is a scalar reference, the input data
will be read from C<$$input_filename_or_reference>.
=item An array reference
If C<$input_filename_or_reference> is an array reference, each element in
the array must be a filename.
The input data will be read from each file in turn.
The complete array will be walked to ensure that it only
contains valid filenames before any data is compressed.
=item An Input FileGlob string
If C<$input_filename_or_reference> is a string that is delimited by the
characters "<" and ">" C will assume that it is an
I. The input is the list of files that match the
fileglob.
See L for more details.
=back
If the C<$input_filename_or_reference> parameter is any other type,
C will be returned.
=head3 The C<$output_filename_or_reference> parameter
The parameter C<$output_filename_or_reference> is used to control the
destination of the compressed data. This parameter can take one of
these forms.
=over 5
=item A filename
If the C<$output_filename_or_reference> parameter is a simple scalar, it is
assumed to be a filename. This file will be opened for writing and the
compressed data will be written to it.
=item A filehandle
If the C<$output_filename_or_reference> parameter is a filehandle, the
compressed data will be written to it. The string '-' can be used as
an alias for standard output.
=item A scalar reference
If C<$output_filename_or_reference> is a scalar reference, the
compressed data will be stored in C<$$output_filename_or_reference>.
=item An Array Reference
If C<$output_filename_or_reference> is an array reference,
the compressed data will be pushed onto the array.
=item An Output FileGlob
If C<$output_filename_or_reference> is a string that is delimited by the
characters "<" and ">" C will assume that it is an
I