package IO::Uncompress::UnLzma ;
use strict ;
use warnings;
use bytes;
use IO::Compress::Base::Common 2.101 qw(:Status createSelfTiedObject);
use IO::Uncompress::Base 2.101 ;
use IO::Uncompress::Adapter::UnLzma 2.101 ;
require Exporter ;
our ($VERSION, @ISA, @EXPORT_OK, %EXPORT_TAGS, $UnLzmaError);
$VERSION = '2.101';
$UnLzmaError = '';
@ISA = qw( IO::Uncompress::Base Exporter );
@EXPORT_OK = qw( $UnLzmaError unlzma ) ;
#%EXPORT_TAGS = %IO::Uncompress::Base::EXPORT_TAGS ;
push @{ $EXPORT_TAGS{all} }, @EXPORT_OK ;
#Exporter::export_ok_tags('all');
sub new
{
my $class = shift ;
my $obj = createSelfTiedObject($class, \$UnLzmaError);
$obj->_create(undef, 0, @_);
}
sub unlzma
{
my $obj = createSelfTiedObject(undef, \$UnLzmaError);
return $obj->_inf(@_);
}
#our %PARAMS = (
#'verbosity' => [IO::Compress::Base::Common::Parse_boolean, 0],
#'small' => [IO::Compress::Base::Common::Parse_boolean, 0],
# );
sub getExtraParams
{
return ();
}
sub ckParams
{
my $self = shift ;
my $got = shift ;
return 1;
}
sub mkUncomp
{
my $self = shift ;
my $got = shift ;
#my $Small = $got->getValue('small');
#my $Verbosity = $got->getValue('verbosity');
my ($obj, $errstr, $errno) = IO::Uncompress::Adapter::UnLzma::mkUncompObject(
);
return $self->saveErrorString(undef, $errstr, $errno)
if ! defined $obj;
*$self->{Uncomp} = $obj;
*$self->{Info} = $self->ckMagic()
or return 0 ;
return 1;
}
sub ckMagic
{
my $self = shift;
my $got = $self->isLzma(@_);
if ($got) {
*$self->{Pending} = *$self->{HeaderPending} ;
}
else {
$self->pushBack(*$self->{HeaderPending});
*$self->{Uncomp}->reset();
}
*$self->{HeaderPending} = '';
return $got ;
}
sub isLzma
{
my $self = shift ;
my $magic = shift;
$magic = '' unless defined $magic ;
my $buffer = '';
$self->smartRead(\$buffer, *$self->{BlockSize}) >= 0
or return $self->saveErrorString(undef, "No data to read");
my $temp_buf = $magic . $buffer ;
*$self->{HeaderPending} = $temp_buf ;
$buffer = '';
my $status = *$self->{Uncomp}->uncompr(\$temp_buf, \$buffer, $self->smartEof()) ;
return $self->saveErrorString(undef, *$self->{Uncomp}{Error}, STATUS_ERROR)
if $status == STATUS_ERROR;
$self->pushBack($temp_buf) ;
return $self->saveErrorString(undef, "unexpected end of file", STATUS_ERROR)
if $self->smartEof() && $status != STATUS_ENDSTREAM;
#my $buf_len = *$self->{Uncomp}->uncompressedBytes();
my $buf_len = length $buffer;
if ($status == STATUS_ENDSTREAM) {
if (*$self->{MultiStream}
&& (length $temp_buf || ! $self->smartEof())){
*$self->{NewStream} = 1 ;
*$self->{EndStream} = 0 ;
}
else {
*$self->{EndStream} = 1 ;
}
}
*$self->{HeaderPending} = $buffer ;
*$self->{InflatedBytesRead} = $buf_len ;
*$self->{TotalInflatedBytesRead} += $buf_len ;
*$self->{Type} = 'lzma';
$self->saveStatus(STATUS_OK);
return {
'Type' => 'lzma',
'HeaderLength' => 0,
'TrailerLength' => 0,
'Header' => ''
};
return '';
}
sub readHeader
{
my $self = shift;
my $magic = shift ;
$self->pushBack($magic);
*$self->{HeaderPending} = '';
return {
'Type' => 'lzma',
'FingerprintLength' => 0,
'HeaderLength' => 0,
'TrailerLength' => 0,
'Header' => ''
};
}
sub chkTrailer
{
return STATUS_OK;
}
1 ;
__END__
=head1 NAME
IO::Uncompress::UnLzma - Read lzma files/buffers
=head1 SYNOPSIS
use IO::Uncompress::UnLzma qw(unlzma $UnLzmaError) ;
my $status = unlzma $input => $output [,OPTS]
or die "unlzma failed: $UnLzmaError\n";
my $z = IO::Uncompress::UnLzma->new( $input [OPTS] )
or die "unlzma failed: $UnLzmaError\n";
$status = $z->read($buffer)
$status = $z->read($buffer, $length)
$status = $z->read($buffer, $length, $offset)
$line = $z->getline()
$char = $z->getc()
$char = $z->ungetc()
$char = $z->opened()
$data = $z->trailingData()
$status = $z->nextStream()
$data = $z->getHeaderInfo()
$z->tell()
$z->seek($position, $whence)
$z->binmode()
$z->fileno()
$z->eof()
$z->close()
$UnLzmaError ;
# IO::File mode
<$z>
read($z, $buffer);
read($z, $buffer, $length);
read($z, $buffer, $length, $offset);
tell($z)
seek($z, $position, $whence)
binmode($z)
fileno($z)
eof($z)
close($z)
=head1 DESCRIPTION
This module provides a Perl interface that allows the reading of
lzma files/buffers.
For writing lzma files/buffers, see the companion module IO::Compress::Lzma.
=head1 Functional Interface
A top-level function, C, is provided to carry out
"one-shot" uncompression between buffers and/or files. For finer
control over the uncompression process, see the L
section.
use IO::Uncompress::UnLzma qw(unlzma $UnLzmaError) ;
unlzma $input_filename_or_reference => $output_filename_or_reference [,OPTS]
or die "unlzma failed: $UnLzmaError\n";
The functional interface needs Perl5.005 or better.
=head2 unlzma $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 compressed 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 uncompressed.
=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 uncompressed 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
uncompressed data will be written to it.
=item A filehandle
If the C<$output_filename_or_reference> parameter is a filehandle, the
uncompressed 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
uncompressed 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 uncompressed 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