Current File : C:/xampp/perl/vendor/lib/Excel/Writer/XLSX/Package/SharedStrings.pm
package Excel::Writer::XLSX::Package::SharedStrings;
###############################################################################
#
# SharedStrings - A class for writing the Excel XLSX sharedStrings file.
#
# Used in conjunction with Excel::Writer::XLSX
#
# Copyright 2000-2019, John McNamara, jmcnamara@cpan.org
#
# Documentation after __END__
#
# perltidy with the following options: -mbl=2 -pt=0 -nola
use 5.008002;
use strict;
use warnings;
use Carp;
use Encode;
use Excel::Writer::XLSX::Package::XMLwriter;
our @ISA = qw(Excel::Writer::XLSX::Package::XMLwriter);
our $VERSION = '1.03';
###############################################################################
#
# Public and private API methods.
#
###############################################################################
###############################################################################
#
# new()
#
# Constructor.
#
sub new {
my $class = shift;
my $fh = shift;
my $self = Excel::Writer::XLSX::Package::XMLwriter->new( $fh );
$self->{_strings} = [];
$self->{_string_count} = 0;
$self->{_unique_count} = 0;
bless $self, $class;
return $self;
}
###############################################################################
#
# _assemble_xml_file()
#
# Assemble and write the XML file.
#
sub _assemble_xml_file {
my $self = shift;
$self->xml_declaration;
# Write the sst table.
$self->_write_sst( $self->{_string_count}, $self->{_unique_count} );
# Write the sst strings.
$self->_write_sst_strings();
# Close the sst tag.
$self->xml_end_tag( 'sst' );
# Close the XML writer filehandle.
$self->xml_get_fh()->close();
}
###############################################################################
#
# _set_string_count()
#
# Set the total sst string count.
#
sub _set_string_count {
my $self = shift;
$self->{_string_count} = shift;
}
###############################################################################
#
# _set_unique_count()
#
# Set the total of unique sst strings.
#
sub _set_unique_count {
my $self = shift;
$self->{_unique_count} = shift;
}
###############################################################################
#
# _add_strings()
#
# Add the array ref of strings to be written.
#
sub _add_strings {
my $self = shift;
$self->{_strings} = shift;
}
###############################################################################
#
# Internal methods.
#
###############################################################################
###############################################################################
#
# XML writing methods.
#
###############################################################################
##############################################################################
#
# _write_sst()
#
# Write the <sst> element.
#
sub _write_sst {
my $self = shift;
my $count = shift;
my $unique_count = shift;
my $schema = 'http://schemas.openxmlformats.org';
my $xmlns = $schema . '/spreadsheetml/2006/main';
my @attributes = (
'xmlns' => $xmlns,
'count' => $count,
'uniqueCount' => $unique_count,
);
$self->xml_start_tag( 'sst', @attributes );
}
###############################################################################
#
# _write_sst_strings()
#
# Write the sst string elements.
#
sub _write_sst_strings {
my $self = shift;
for my $string ( @{ $self->{_strings} } ) {
$self->_write_si( $string );
}
}
##############################################################################
#
# _write_si()
#
# Write the <si> element.
#
sub _write_si {
my $self = shift;
my $string = shift;
my @attributes = ();
# Excel escapes control characters with _xHHHH_ and also escapes any
# literal strings of that type by encoding the leading underscore. So
# "\0" -> _x0000_ and "_x0000_" -> _x005F_x0000_.
# The following substitutions deal with those cases.
# Escape the escape.
$string =~ s/(_x[0-9a-fA-F]{4}_)/_x005F$1/g;
# Convert control character to the _xHHHH_ escape.
$string =~ s/([\x00-\x08\x0B-\x1F])/sprintf "_x%04X_", ord($1)/eg;
# Add attribute to preserve leading or trailing whitespace.
if ( $string =~ /^\s/ || $string =~ /\s$/ ) {
push @attributes, ( 'xml:space' => 'preserve' );
}
# Write any rich strings without further tags.
if ( $string =~ m{^<r>} && $string =~ m{</r>$} ) {
# Prevent utf8 strings from getting double encoded.
$string = decode_utf8( $string );
$self->xml_rich_si_element( $string );
}
else {
$self->xml_si_element( $string, @attributes );
}
}
1;
__END__
=pod
=head1 NAME
SharedStrings - A class for writing the Excel XLSX sharedStrings.xml file.
=head1 SYNOPSIS
See the documentation for L<Excel::Writer::XLSX>.
=head1 DESCRIPTION
This module is used in conjunction with L<Excel::Writer::XLSX>.
=head1 AUTHOR
John McNamara jmcnamara@cpan.org
=head1 COPYRIGHT
(c) MM-MMXIX, John McNamara.
All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
=head1 LICENSE
Either the Perl Artistic Licence L<http://dev.perl.org/licenses/artistic.html> or the GPL L<http://www.opensource.org/licenses/gpl-license.php>.
=head1 DISCLAIMER OF WARRANTY
See the documentation for L<Excel::Writer::XLSX>.
=cut
Mini Shell