r901 - in
packages/libspreadsheet-writeexcel-perl/branches/upstream/current:
. charts doc examples exe lib/Spreadsheet
lib/Spreadsheet/WriteExcel t
Gunnar Wolf
gwolf at costa.debian.org
Sun Jul 17 08:09:12 UTC 2005
Author: gwolf
Date: 2005-04-05 23:16:48 +0000 (Tue, 05 Apr 2005)
New Revision: 901
Added:
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/unicode_cyrillic.pl
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/t/01_add_worksheet.t
Modified:
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/Changes
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/MANIFEST
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/META.yml
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/chartex.pl
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.pod
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.txt
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/doc/WriteExcel.html
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/README
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/write_to_scalar.pl
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/exe/chartex
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/BIFFwriter.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Big.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Chart.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Format.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Formula.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/OLEwriter.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Utility.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Workbook.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/WorkbookBig.pm
packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Worksheet.pm
Log:
Load /tmp/tmp.186RfP/libspreadsheet-writeexcel-perl-2.12 into
packages/libspreadsheet-writeexcel-perl/branches/upstream/current.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/Changes
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/Changes 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/Changes 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,6 +1,20 @@
Revision history for Perl module Spreadsheet::WriteExcel.
+2.12 March 22 2005 - Minor
+ + Added further Unicode support. The following methods now
+ handle uft8 in perl 5.8:
+ add_worksheet()
+ set_header()
+ set_footer()
+ set_font()
+ set_num_format()
+
+ + Added unicode_cyrillic.pl example.
+
+ + Added 01_add_worksheet.t test.
+
+
2.11 September 30 2004 - Minor
- Removed undocumented date_time handling from write() to
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/MANIFEST
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/MANIFEST 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/MANIFEST 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,5 +1,5 @@
Makefile.PL
-CHANGES
+Changes
MANIFEST
README
INSTALL
@@ -19,6 +19,7 @@
lib/Spreadsheet/WriteExcel/Worksheet.pm
t/00_IEEE_double.t
+t/01_add_worksheet.t
doc/index.html
doc/WriteExcel.html
@@ -101,6 +102,7 @@
examples/unicode_cp1251.txt
examples/unicode_cp1256.pl
examples/unicode_cp1256.txt
+examples/unicode_cyrillic.pl
examples/unicode_japan.pl
examples/unicode_koi8r.pl
examples/unicode_koi8r.txt
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/META.yml
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/META.yml 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/META.yml 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,5 +1,5 @@
name: Spreadsheet-WriteExcel
-version: 2.11
+version: 2.12
version_from: lib/Spreadsheet/WriteExcel.pm
installdirs: site
requires:
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/chartex.pl
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/chartex.pl 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/chartex.pl 2005-04-05 23:16:48 UTC (rev 901)
@@ -218,7 +218,7 @@
=head1 COPYRIGHT
-© MMIV, John McNamara.
+© MMV, John McNamara.
All Rights Reserved. This program is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.pod
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.pod 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.pod 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,6 +1,6 @@
=head1 NAME
-Charts and Spreadsheet::WriteExcel - A short introduction to how to include externally generated charts into a Spreadsheet::WriteExcel file.
+Charts and Spreadsheet::WriteExcel - A short introduction on how to include externally generated charts into a Spreadsheet::WriteExcel file.
=head1 DESCRIPTION
@@ -188,7 +188,7 @@
=head1 COPYRIGHT
-© MMIV, John McNamara.
+© MMV, 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.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.txt
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.txt 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/charts/charts.txt 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,5 +1,5 @@
NAME
- Charts and Spreadsheet::WriteExcel - A short introduction to how
+ Charts and Spreadsheet::WriteExcel - A short introduction on how
to include externally generated charts into a
Spreadsheet::WriteExcel file.
@@ -184,7 +184,7 @@
John McNamara jmcnamara at cpan.org
COPYRIGHT
- © MMIV, John McNamara.
+ © MMV, John McNamara.
All Rights Reserved. This module is free software. It may be
used, redistributed and/or modified under the same terms as Perl
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/doc/WriteExcel.html
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/doc/WriteExcel.html 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/doc/WriteExcel.html 2005-04-05 23:16:48 UTC (rev 901)
@@ -69,12 +69,12 @@
<LI><A HREF="#write_blank_row_column_form">write_blank($row, $column, $format)</A></LI>
<LI><A HREF="#write_row_row_column_array_">write_row($row, $column, $array_ref, $format)</A></LI>
<LI><A HREF="#write_col_row_column_array_">write_col($row, $column, $array_ref, $format)</A></LI>
+ <LI><A HREF="#write_date_time_row_col_dat">write_date_time($row, $col, $date_string, $format)</A></LI>
<LI><A HREF="#write_url_row_col_url_str">write_url($row, $col, $url, $string, $format)</A></LI>
<LI><A HREF="#write_url_range_row1_col1_r">write_url_range($row1, $col1, $row2, $col2, $url, $string, $format)</A></LI>
<LI><A HREF="#write_formula_row_column_fo">write_formula($row, $column, $formula, $format)</A></LI>
<LI><A HREF="#store_formula_formula_">store_formula($formula)</A></LI>
<LI><A HREF="#repeat_formula_row_col_form">repeat_formula($row, $col, $formula, $format, ($pattern => $replace, ...))</A></LI>
- <LI><A HREF="#write_date_time_row_col_dat">write_date_time($row, $col, $date_string, $format)</A></LI>
<LI><A HREF="#write_comment_row_column_st">write_comment($row, $column, $string)</A></LI>
<LI><A HREF="#add_write_handler_re_code_ref">add_write_handler($re, $code_ref)</A></LI>
<LI><A HREF="#insert_bitmap_row_col_filen">insert_bitmap($row, $col, $filename, $x, $y, $scale_x, $scale_y)</A></LI>
@@ -193,9 +193,10 @@
<LI><A HREF="#THE_EXCEL_BINARY_FORMAT">THE EXCEL BINARY FORMAT</A></LI>
<LI><A HREF="#WRITING_EXCEL_FILES">WRITING EXCEL FILES</A></LI>
<LI><A HREF="#READING_EXCEL_FILES">READING EXCEL FILES</A></LI>
- <LI><A HREF="#WORKING_WITH_XML">WORKING WITH XML</A></LI>
+ <LI><A HREF="#Warning_about_XML_Parser_and_Pe">Warning about XML::Parser and Perl 5.6</A></LI>
<LI><A HREF="#BUGS">BUGS</A></LI>
<LI><A HREF="#TO_DO">TO DO</A></LI>
+ <LI><A HREF="#MAILING_LIST">MAILING LIST</A></LI>
<LI><A HREF="#SEE_ALSO">SEE ALSO</A></LI>
<LI><A HREF="#ACKNOWLEDGEMENTS">ACKNOWLEDGEMENTS</A></LI>
<LI><A HREF="#AUTHOR">AUTHOR</A></LI>
@@ -214,8 +215,8 @@
<HR>
<H1><A NAME="VERSION">VERSION</A></H1>
<P>
-This document refers to version 2.10 of Spreadsheet::WriteExcel, released
-September 23, 2004.
+This document refers to version 2.12 of Spreadsheet::WriteExcel, released
+March 22, 2005.
</P>
<P>
@@ -680,10 +681,6 @@
</P>
<P>
-The <CODE>set_tempdir()</CODE> method must be called before calling <CODE>add_worksheet()</CODE>.
-
-</P>
-<P>
<HR>
<H2><A NAME="add_worksheet_sheetname_">add_worksheet($sheetname)</A></H2>
<P>
@@ -693,10 +690,10 @@
</P>
<P>
<PRE>
- $worksheet1 = $workbook->add_worksheet(); # Sheet1
- $worksheet2 = $workbook->add_worksheet('Foglio2'); # Foglio2
- $worksheet3 = $workbook->add_worksheet('Data'); # Data
- $worksheet4 = $workbook->add_worksheet(); # Sheet4
+ $worksheet1 = $workbook->add_worksheet(); # Sheet1
+ $worksheet2 = $workbook->add_worksheet('Foglio2'); # Foglio2
+ $worksheet3 = $workbook->add_worksheet('Data'); # Data
+ $worksheet4 = $workbook->add_worksheet(); # Sheet4
</PRE>
</P>
<P>
@@ -706,11 +703,20 @@
</P>
<P>
The worksheet name must be a valid Excel worksheet name, i.e. it cannot
-contain any of the following characters, <CODE>: * ? / \</CODE> and it must be less than 32 characters. In addition, you cannot use the
+contain any of the following characters, <CODE>[ ] : * ? / \</CODE> and it must be less than 32 characters. In addition, you cannot use the
same, case insensitive, <CODE>$sheetname</CODE> for more than one worksheet.
</P>
<P>
+On systems with <CODE>perl 5.8</CODE> and later the <CODE>add_worksheet()</CODE> method will also handle strings in Perl's <CODE>utf8</CODE> format.
+
+</P>
+<P>
+<PRE>
+ $worksheet5 = $workbook->add_worksheet("\x{263a}"); # Smiley
+</PRE>
+</P>
+<P>
<HR>
<H2><A NAME="add_chart_ext_chart_data_char">add_chart_ext($chart_data, $chartname)</A></H2>
<P>
@@ -1187,7 +1193,7 @@
</P>
<P>
-On systems with <CODE>perl 5.8</CODE> and later the <CODE>write()</CODE> method will also handle strings in Perl's <CODE>utf8</CODE> format.
+On systems with <CODE>perl 5.8</CODE> and later the <CODE>write()</CODE> method will also handle Unicode strings in Perl's <CODE>utf8</CODE> format.
</P>
<P>
@@ -1584,11 +1590,10 @@
</P>
<P>
-Excel differentiates between an "Empty" cell and a
-"Blank" cell. An "Empty" cell is a cell which doesn't
-contain data whilst a "Blank" cell is a cell which doesn't
-contain data but does contain formatting. Excel stores "Blank"
-cells but ignores "Empty" cells.
+Excel differentiates between an "Empty" cell and a "Blank" cell. An "Empty"
+cell is a cell which doesn't contain data whilst a "Blank" cell is a cell
+which doesn't contain data but does contain formatting. Excel stores
+"Blank" cells but ignores "Empty" cells.
</P>
<P>
@@ -1702,8 +1707,8 @@
</P>
<P>
-To find out more about array references refer to <CODE>perlref</CODE> and <CODE>perlreftut</CODE> in the main Perl documentation. To find out more about 2D arrays or
-"lists of lists" refer to <CODE>perllol</CODE>.
+To find out more about array references refer to <CODE>perlref</CODE> and <CODE>perlreftut</CODE> in the main Perl documentation. To find out more about 2D arrays or "lists
+of lists" refer to <CODE>perllol</CODE>.
</P>
<P>
@@ -1840,8 +1845,8 @@
</PRE>
</P>
<P>
-To find out more about array references refer to <CODE>perlref</CODE> and <CODE>perlreftut</CODE> in the main Perl documentation. To find out more about 2D arrays or
-"lists of lists" refer to <CODE>perllol</CODE>.
+To find out more about array references refer to <CODE>perlref</CODE> and <CODE>perlreftut</CODE> in the main Perl documentation. To find out more about 2D arrays or "lists
+of lists" refer to <CODE>perllol</CODE>.
</P>
<P>
@@ -1856,6 +1861,70 @@
</P>
<P>
<HR>
+<H2><A NAME="write_date_time_row_col_dat">write_date_time($row, $col, $date_string, $format)</A></H2>
+<P>
+The <CODE>write_date_time()</CODE> method can be used to write a date or time to the cell specified by <CODE>$row</CODE> and <CODE>$column</CODE>:
+
+</P>
+<P>
+<PRE>
+ $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
+</PRE>
+</P>
+<P>
+The <CODE>$date_string</CODE> should be in the following format:
+
+</P>
+<P>
+<PRE>
+ yyyy-mm-ddThh:mm:ss.sss
+</PRE>
+</P>
+<P>
+This conforms to am ISO8601 date but it should be noted that the full range
+of ISO8601 formats are not supported.
+
+</P>
+<P>
+The following variations on the <CODE>$date_string</CODE> parameter are permitted:
+
+</P>
+<P>
+<PRE>
+ yyyy-mm-ddThh:mm:ss.sss # Standard format
+ yyyy-mm-ddT # No time
+ Thh:mm:ss.sss # No date
+ yyyy-mm-ddThh:mm:ss.sssZ # Additional Z (but not time zones)
+ yyyy-mm-ddThh:mm:ss # No fractional seconds
+ yyyy-mm-ddThh:mm # No seconds
+</PRE>
+</P>
+<P>
+Note that the <CODE>T</CODE> is required in all cases.
+
+</P>
+<P>
+A date should always have a <CODE>$format</CODE>, otherwise it will appear as a number, see <A HREF="#DATES_IN_EXCEL">DATES IN EXCEL</A> and <A HREF="#CELL_FORMATTING">CELL FORMATTING</A>. Here is a typical example:
+
+</P>
+<P>
+<PRE>
+ my $date_format = $workbook->add_format(num_format => 'mm/dd/yy');
+ $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
+</PRE>
+</P>
+<P>
+Valid dates should be in the range 1900-01-01 to 9999-12-31, for the 1900
+epoch and 1904-01-01 to 9999-12-31, for the 1904 epoch. As with Excel,
+dates outside these ranges will be written as a string.
+
+</P>
+<P>
+See also the date_time.pl program in the <CODE>examples</CODE> directory of the distro.
+
+</P>
+<P>
+<HR>
<H2><A NAME="write_url_row_col_url_str">write_url($row, $col, $url, $string, $format)</A></H2>
<P>
Write a hyperlink to a URL in the cell specified by <CODE>$row</CODE> and <CODE>$column</CODE>. The hyperlink is comprised of two elements: the visible label and the
@@ -2016,16 +2085,16 @@
</P>
<P>
-See also the section "Improving performance when working with
-formulas" and the <CODE>store_formula()</CODE> and <CODE>repeat_formula()</CODE> methods.
+See also the section "Improving performance when working with formulas" and
+the <CODE>store_formula()</CODE> and <CODE>repeat_formula()</CODE> methods.
</P>
<P>
<HR>
<H2><A NAME="store_formula_formula_">store_formula($formula)</A></H2>
<P>
-The <CODE>store_formula()</CODE> method is used in conjunction with <CODE>repeat_formula()</CODE> to speed up the generation of repeated formulas. See "Improving
-performance when working with formulas" in <A HREF="#FORMULAS_AND_FUNCTIONS_IN_EXCEL">FORMULAS AND FUNCTIONS IN EXCEL</A>.
+The <CODE>store_formula()</CODE> method is used in conjunction with <CODE>repeat_formula()</CODE> to speed up the generation of repeated formulas. See "Improving performance
+when working with formulas" in <A HREF="#FORMULAS_AND_FUNCTIONS_IN_EXCEL">FORMULAS AND FUNCTIONS IN EXCEL</A>.
</P>
<P>
@@ -2074,8 +2143,8 @@
<HR>
<H2><A NAME="repeat_formula_row_col_form">repeat_formula($row, $col, $formula, $format, ($pattern => $replace, ...))</A></H2>
<P>
-The <CODE>repeat_formula()</CODE> method is used in conjunction with <CODE>store_formula()</CODE> to speed up the generation of repeated formulas. See "Improving
-performance when working with formulas" in <A HREF="#FORMULAS_AND_FUNCTIONS_IN_EXCEL">FORMULAS AND FUNCTIONS IN EXCEL</A>.
+The <CODE>repeat_formula()</CODE> method is used in conjunction with <CODE>store_formula()</CODE> to speed up the generation of repeated formulas. See "Improving performance
+when working with formulas" in <A HREF="#FORMULAS_AND_FUNCTIONS_IN_EXCEL">FORMULAS AND FUNCTIONS IN EXCEL</A>.
</P>
<P>
@@ -2256,70 +2325,6 @@
</P>
<P>
<HR>
-<H2><A NAME="write_date_time_row_col_dat">write_date_time($row, $col, $date_string, $format)</A></H2>
-<P>
-The <CODE>write_date_time()</CODE> method can be used to write a date or time to the cell specified by <CODE>$row</CODE> and <CODE>$column</CODE>:
-
-</P>
-<P>
-<PRE>
- $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
-</PRE>
-</P>
-<P>
-The <CODE>$date_string</CODE> should be in the following format:
-
-</P>
-<P>
-<PRE>
- yyyy-mm-ddThh:mm:ss.sss
-</PRE>
-</P>
-<P>
-This conforms to am ISO8601 date but it should be noted that the full range
-of ISO8601 formats are not supported.
-
-</P>
-<P>
-The following variations on the <CODE>$date_string</CODE> parameter are permitted:
-
-</P>
-<P>
-<PRE>
- yyyy-mm-ddThh:mm:ss.sss # Standard format
- yyyy-mm-ddT # No time
- Thh:mm:ss.sss # No date
- yyyy-mm-ddThh:mm:ss.sssZ # Additional Z (but not time zones)
- yyyy-mm-ddThh:mm:ss # No fractional seconds
- yyyy-mm-ddThh:mm # No seconds
-</PRE>
-</P>
-<P>
-Note that the <CODE>T</CODE> is required in all cases.
-
-</P>
-<P>
-A date should always have a <CODE>$format</CODE>, otherwise it will appear as a number, see <A HREF="#DATES_IN_EXCEL">DATES IN EXCEL</A> and <A HREF="#CELL_FORMATTING">CELL FORMATTING</A>. Here is a typical example:
-
-</P>
-<P>
-<PRE>
- my $date_format = $workbook->add_format(num_format => 'mm/dd/yy');
- $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
-</PRE>
-</P>
-<P>
-Valid dates should be in the range 1900-01-01 to 9999-12-31, for the 1900
-epoch and 1904-01-01 to 9999-12-31, for the 1904 epoch. As with Excel,
-dates outside these ranges will be written as a string.
-
-</P>
-<P>
-See also the date_time.pl program in the <CODE>examples</CODE> directory of the distro.
-
-</P>
-<P>
-<HR>
<H2><A NAME="write_comment_row_column_st">write_comment($row, $column, $string)</A></H2>
<P>
<STRONG>NOTE: this method is not available in this release. Use the 1.xx versions of this module if you need this feature</STRONG>.
@@ -2688,9 +2693,9 @@
</P>
<P>
-The <CODE>protect()</CODE> method also has the effect of enabling a cell's <CODE>locked</CODE> and <CODE>hidden</CODE> properties if they have been set. A "locked" cell cannot be
-edited. A "hidden" cell will display the results of a formula but
-not the formula itself. In Excel a cell's locked property is on by default.
+The <CODE>protect()</CODE> method also has the effect of enabling a cell's <CODE>locked</CODE> and <CODE>hidden</CODE> properties if they have been set. A "locked" cell cannot be edited. A
+"hidden" cell will display the results of a formula but not the formula
+itself. In Excel a cell's locked property is on by default.
</P>
<P>
@@ -2890,9 +2895,9 @@
<P>
The width corresponds to the column width value that is specified in Excel.
It is approximately equal to the length of a string in the default font of
-Arial 10. Unfortunately, there is no way to specify "AutoFit" for
-a column in the Excel file format. This feature is only available at
-runtime from within Excel.
+Arial 10. Unfortunately, there is no way to specify "AutoFit" for a column
+in the Excel file format. This feature is only available at runtime from
+within Excel.
</P>
<P>
@@ -2984,9 +2989,8 @@
<P>
The <CODE>$visible</CODE> parameter is used to control whether or not outlines are visible. Setting
this parameter to 0 will cause all outlines on the worksheet to be hidden.
-They can be unhidden in Excel by means of the "Show Outline
-Symbols" command button. The default setting is 1 for visible
-outlines.
+They can be unhidden in Excel by means of the "Show Outline Symbols"
+command button. The default setting is 1 for visible outlines.
</P>
<P>
@@ -3010,8 +3014,7 @@
The <CODE>$auto_style</CODE> parameter is used to control whether the automatic outline generator in
Excel uses automatic styles when creating an outline. This has no effect on
a file generated by <CODE>Spreadsheet::WriteExcel</CODE> but it does have an effect on how the worksheet behaves after it is
-created. The default setting is 0 for "Automatic Styles" to be
-turned off.
+created. The default setting is 0 for "Automatic Styles" to be turned off.
</P>
<P>
@@ -3028,8 +3031,8 @@
<H2><A NAME="freeze_panes_row_col_top_ro">freeze_panes($row, $col, $top_row, $left_col)</A></H2>
<P>
This method can be used to divide a worksheet into horizontal or vertical
-regions known as panes and to also "freeze" these panes so that
-the splitter bars are not visible. This is the same as the <CODE>Window->Freeze Panes</CODE> menu command in Excel
+regions known as panes and to also "freeze" these panes so that the
+splitter bars are not visible. This is the same as the <CODE>Window->Freeze Panes</CODE> menu command in Excel
</P>
<P>
@@ -3126,7 +3129,7 @@
<H2><A NAME="merge_range_first_row_first_c">merge_range($first_row, $first_col, $last_row, $last_col, $token, $format)</A></H2>
<P>
Merging cells is generally achieved by setting the <CODE>merge</CODE> property of a Format object, see <A HREF="#CELL_FORMATTING">CELL FORMATTING</A>. However, this only allows simple Excel5 style horizontal merging which
-Excel refers to as "center across selection".
+Excel refers to as "center across selection".
</P>
<P>
@@ -3183,8 +3186,8 @@
</PRE>
</P>
<P>
-The default zoom factor is 100. You cannot zoom to "Selection"
-because it is calculated by Excel at run-time.
+The default zoom factor is 100. You cannot zoom to "Selection" because it
+is calculated by Excel at run-time.
</P>
<P>
@@ -3418,6 +3421,7 @@
&T Time
&F File name
&A Worksheet name
+ &Z Workbook path
</PRE>
</P>
<P>
@@ -3564,9 +3568,8 @@
</P>
<P>
You can specify the font of a section of the text by prefixing it with the
-control sequence <CODE>&"font,style"</CODE> where <CODE>fontname</CODE> is a font name such as "Courier New" or "Times New
-Roman" and <CODE>style</CODE> is one of the standard Windows font descriptions: "Regular",
-"Italic", "Bold" or "Bold Italic":
+control sequence <CODE>&"font,style"</CODE> where <CODE>fontname</CODE> is a font name such as "Courier New" or "Times New Roman" and <CODE>style</CODE> is one of the standard Windows font descriptions: "Regular", "Italic",
+"Bold" or "Bold Italic":
</P>
<P>
@@ -3623,6 +3626,15 @@
</P>
<P>
+On systems with <CODE>perl 5.8</CODE> and later the <CODE>set_header()</CODE> method can also handle Unicode strings in Perl's <CODE>utf8</CODE> format.
+
+</P>
+<P>
+<PRE>
+ $worksheet->set_header("&C\x{263a}")
+</PRE>
+</P>
+<P>
See, also the <CODE>headers.pl</CODE> program in the <CODE>examples</CODE> directory of the distribution.
</P>
@@ -3737,7 +3749,7 @@
</P>
<P>
<PRE>
- $worksheet->print_row_col_headers()
+ $worksheet->print_row_col_headers();
</PRE>
</P>
<P>
@@ -3856,7 +3868,7 @@
</PRE>
</P>
<P>
-Note: If you specify the "fit to page" option via the <CODE>fit_to_pages()</CODE> method it will override all manual page breaks.
+Note: If you specify the "fit to page" option via the <CODE>fit_to_pages()</CODE> method it will override all manual page breaks.
</P>
<P>
@@ -3893,7 +3905,7 @@
</PRE>
</P>
<P>
-Note: If you specify the "fit to page" option via the <CODE>fit_to_pages()</CODE> method it will override all manual page breaks.
+Note: If you specify the "fit to page" option via the <CODE>fit_to_pages()</CODE> method it will override all manual page breaks.
</P>
<P>
@@ -4111,8 +4123,8 @@
</P>
<P>
-You can also create a format "on the fly" and pass it directly to
-a write method as follows:
+You can also create a format "on the fly" and pass it directly to a write
+method as follows:
</P>
<P>
@@ -4121,8 +4133,8 @@
</PRE>
</P>
<P>
-This corresponds to an "anonymous" format in the Perl sense of
-anonymous data or subs.
+This corresponds to an "anonymous" format in the Perl sense of anonymous
+data or subs.
</P>
<P>
@@ -5291,8 +5303,8 @@
<HR>
<H1><A NAME="DATES_IN_EXCEL">DATES IN EXCEL</A></H1>
<P>
-Dates and times in Excel are represented by real numbers, for example
-"Jan 1 2001 12:30 AM" is represented by the number 36892.521.
+Dates and times in Excel are represented by real numbers, for example "Jan
+1 2001 12:30 AM" is represented by the number 36892.521.
</P>
<P>
@@ -5658,8 +5670,8 @@
<P>
The following table lists all of the core functions supported by Excel 5
and Spreadsheet::WriteExcel. Any additional functions that are available
-through the "Analysis ToolPak" or other add-ins are not
-supported. These functions have all been tested to verify that they work.
+through the "Analysis ToolPak" or other add-ins are not supported. These
+functions have all been tested to verify that they work.
</P>
<P>
@@ -6299,6 +6311,7 @@
=======
unicode.pl Simple example of using Unicode UTF16 strings.
unicode_japan.pl Write Japanese Unicode strings using UTF16.
+ unicode_cyrillic.pl Write Russian cyrillic strings using UTF8.
unicode_list.pl List the chars in a Unicode font.
unicode_2022_jp.pl Japanese: ISO-2022-JP to utf8 in perl 5.8.
unicode_8859_11.pl Thai: ISO-8859_11 to utf8 in perl 5.8.
@@ -6479,9 +6492,9 @@
<DT><A NAME="item__file_xls_">'file.xls' cannot be accessed. The file may be read-only ...</A><DD>
<P>
You may sometimes encounter the following error when trying to open a file
-in Excel: "file.xls cannot be accessed. The file may be read-only, or
-you may be trying to access a read-only location. Or, the server the
-document is stored on may not be responding."
+in Excel: "file.xls cannot be accessed. The file may be read-only, or you
+may be trying to access a read-only location. Or, the server the document
+is stored on may not be responding."
</P>
<P>
@@ -6501,19 +6514,18 @@
</P>
<P>
-Excel data is stored in the "Binary Interchange File Format"
-(BIFF) file format. Details of this format are given in the Excel SDK, the
-"Excel Developer's Kit" from Microsoft Press. It is also included
-in the MSDN CD library but is no longer available on the MSDN website.
-Versions of the BIFF documentation are available at www.wotsit.org, <A
+Excel data is stored in the "Binary Interchange File Format" (BIFF) file
+format. Details of this format are given in the Excel SDK, the "Excel
+Developer's Kit" from Microsoft Press. It is also included in the MSDN CD
+library but is no longer available on the MSDN website. Versions of the
+BIFF documentation are available at www.wotsit.org, <A
HREF="http://www.wotsit.org/search.asp?page=2&s=database">http://www.wotsit.org/search.asp?page=2&s=database</A>
</P>
<P>
Charles Wybble has collected together almost all of the available
-information about the Excel file format. See "The Chicago
-Project" at <A
+information about the Excel file format. See "The Chicago Project" at <A
HREF="http://chicago.sourceforge.net/devel/">http://chicago.sourceforge.net/devel/</A>
@@ -6630,7 +6642,7 @@
<P>
You can also access Spreadsheet::WriteExcel using the standard DBI
interface via Takanori Kawai's DBD::Excel module <A
-HREF="http://search.cpan.org/search?dist=DBD-Excel.">http://search.cpan.org/search?dist=DBD-Excel.</A>
+HREF="http://search.cpan.org/dist/DBD-Excel">http://search.cpan.org/dist/DBD-Excel</A>
</P>
@@ -6642,6 +6654,14 @@
</P>
+<LI><A NAME="item_Excel">Excel::Template</A>
+<P>
+This module allows you to create an Excel file from an XML template in a
+manner similar to HTML::Template. See <A
+HREF="http://search.cpan.org/dist/Excel-Template/">http://search.cpan.org/dist/Excel-Template/</A>
+
+
+</P>
<LI><A NAME="item_Spreadsheet">Spreadsheet::WriteExcel::FromXML</A>
<P>
This module allows you to turn a simple XML file into an Excel file using
@@ -6654,7 +6674,7 @@
<LI><A NAME="item_Spreadsheet">Spreadsheet::WriteExcel::Simple</A>
<P>
This provides an easier interface to Spreadsheet::WriteExcel: <A
-HREF="http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-Simple">http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-Simple</A>
+HREF="http://search.cpan.org/dist/Spreadsheet-WriteExcel-Simple">http://search.cpan.org/dist/Spreadsheet-WriteExcel-Simple</A>
</P>
@@ -6662,7 +6682,7 @@
<P>
This is a useful module for creating Excel files directly from a DB table:
<A
-HREF="http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-FromDB">http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-FromDB</A>
+HREF="http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromDB">http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromDB</A>
</P>
@@ -6697,7 +6717,7 @@
<P>
This uses the OLE::Storage-Lite module to extract data from an Excel file.
<A
-HREF="http://search.cpan.org/search?dist=Spreadsheet-ParseExcel">http://search.cpan.org/search?dist=Spreadsheet-ParseExcel</A>
+HREF="http://search.cpan.org/dist/Spreadsheet-ParseExcel">http://search.cpan.org/dist/Spreadsheet-ParseExcel</A>
</P>
@@ -6705,15 +6725,15 @@
<P>
This module uses Spreadsheet::ParseExcel's interface but uses xlHtml (see
below) to do the conversion: <A
-HREF="http://search.cpan.org/search?dist=Spreadsheet-ParseExcel_XLHTML">http://search.cpan.org/search?dist=Spreadsheet-ParseExcel_XLHTML</A>
+HREF="http://search.cpan.org/dist/Spreadsheet-ParseExcel_XLHTML">http://search.cpan.org/dist/Spreadsheet-ParseExcel_XLHTML</A>
Spreadsheet::ParseExcel_XLHTML
</P>
<LI><A NAME="item_xlHtml">xlHtml</A>
<P>
-This is an open source "Excel to HTML Converter" C/C++ project at
-<A HREF="http://www.xlhtml.org/">http://www.xlhtml.org/</A> See also, the
-OLE Filters Project at <A
+This is an open source "Excel to HTML Converter" C/C++ project at <A
+HREF="http://www.xlhtml.org/">http://www.xlhtml.org/</A> See also, the OLE
+Filters Project at <A
HREF="http://atena.com/libole2.php">http://atena.com/libole2.php</A>
</P>
@@ -6721,7 +6741,7 @@
<P>
You can also access Spreadsheet::ParseExcel using the standard DBI
interface via Takanori Kawai's DBD::Excel module <A
-HREF="http://search.cpan.org/search?dist=DBD-Excel.">http://search.cpan.org/search?dist=DBD-Excel.</A>
+HREF="http://search.cpan.org/dist/DBD-Excel">http://search.cpan.org/dist/DBD-Excel</A>
</P>
@@ -6734,7 +6754,7 @@
<P>
If the files are saved from Excel in a HTML format the data can be accessed
using HTML::TableExtract <A
-HREF="http://search.cpan.org/search?dist=HTML-TableExtract">http://search.cpan.org/search?dist=HTML-TableExtract</A>
+HREF="http://search.cpan.org/dist/HTML-TableExtract">http://search.cpan.org/dist/HTML-TableExtract</A>
</P>
@@ -6746,7 +6766,7 @@
<LI><A NAME="item_XML">XML::Excel</A>
<P>
Converts Excel files to XML using Spreadsheet::ParseExcel <A
-HREF="http://search.cpan.org/search?dist=XML-Excel.">http://search.cpan.org/search?dist=XML-Excel.</A>
+HREF="http://search.cpan.org/dist/XML-Excel.">http://search.cpan.org/dist/XML-Excel.</A>
</P>
@@ -6782,11 +6802,11 @@
</P>
<P>
<HR>
-<H1><A NAME="WORKING_WITH_XML">WORKING WITH XML</A></H1>
+<H1><A NAME="Warning_about_XML_Parser_and_Pe">Warning about XML::Parser and Perl 5.6</A></H1>
<P>
-You must be careful when using XML data in conjunction with
-Spreadsheet::WriteExcel due to the fact that data returned by XML parsers
-is generally in UTF8 format.
+You must be careful when using Spreadsheet::WriteExcel in conjunction with
+Perl 5.6 and XML::Parser (and other XML parsers) due to the fact that the
+data returned by the parser is generally in UTF8 format.
</P>
<P>
@@ -6795,11 +6815,17 @@
</P>
<P>
-To avoid this problems you should convert the output data to ASCII or
-ISO-8859-1 using one of the following methods:
+Note, this doesn't affect Perl 5.005 (which doesn't try to handle UTF8) or
+5.8 (which handles it correctly).
</P>
<P>
+To avoid this problem you should upgrade to Perl 5.8, if possible, or else
+you should convert the output data from XML::Parser to ASCII or ISO-8859-1
+using one of the following methods:
+
+</P>
+<P>
<PRE>
$new_str = pack 'C*', unpack 'U*', $utf8_str;
</PRE>
@@ -6811,14 +6837,6 @@
</PRE>
</P>
<P>
-If you are interested in creating an XML spreadsheet format you can use
-Spreadsheet::WriteExcelXML which uses the same interface as
-Spreadsheet::WriteExcel. See <A
-HREF="http://search.cpan.org/dist/Spreadsheet-WriteExcelXML">http://search.cpan.org/dist/Spreadsheet-WriteExcelXML</A>
-
-
-</P>
-<P>
<HR>
<H1><A NAME="BUGS">BUGS</A></H1>
<P>
@@ -6831,8 +6849,8 @@
</P>
<P>
-XML data can cause Excel files created by Spreadsheet::WriteExcel to become
-corrupt. See <A HREF="#WORKING_WITH_XML">WORKING WITH XML</A> for further details.
+XML and UTF8 data on Perl 5.6 can cause Excel files created by
+Spreadsheet::WriteExcel to become corrupt. See <A HREF="#Warning_about_XML_Parser_and_Pe">Warning about XML::Parser and Perl 5.6</A> for further details.
</P>
<P>
@@ -6860,7 +6878,7 @@
</P>
<P>
Gnumeric: Some formatting is not displayed correctly. URLs are not
-displayed as links.
+displayed as links. Page setup can cause Gnumeric to crash.
</P>
<P>
@@ -6881,21 +6899,10 @@
</P>
<UL>
-<LI><A NAME="item_Extend">Extend uft8 support to all relevant methods.</A>
<LI><A NAME="item_Add">Add write_comment().</A>
<LI><A NAME="item_Add">Add AutoFilters.</A>
</UL>
<P>
-You can keep up to date with future releases by registering as a user with
-Freshmeat <A HREF="http://freshmeat.net/">http://freshmeat.net/</A> and
-subscribing to Spreadsheet::WriteExcel at the project page <A
-HREF="http://freshmeat.net/projects/writeexcel/">http://freshmeat.net/projects/writeexcel/</A>
-You will then receive mailed updates when a new version is released.
-Alternatively you can keep an eye on <A
-HREF="news://comp.lang.perl.announce">news://comp.lang.perl.announce</A>
-
-</P>
-<P>
Also, here are some of the most requested features that probably won't get
added:
@@ -6917,10 +6924,59 @@
</P>
<P>
<HR>
+<H1><A NAME="MAILING_LIST">MAILING LIST</A></H1>
+<P>
+There is a Google group for discussing and asking questions about
+Spreadsheet::WriteExcel: <A
+HREF="http://groups-beta.google.com/group/spreadsheet-writeexcel/">http://groups-beta.google.com/group/spreadsheet-writeexcel/</A>
+<p>
+<table style="border:1px solid #aa0033; font-size:small" align=center>
+ <tr>
+ <td rowspan=3>
+ <img src="http://groups-beta.google.com/groups/img/groups_medium.gif" height=58 width=150 alt="Google Groups">
+ </td>
+ <td colspan=2 align=center><b>Subscribe to Spreadsheet::WriteExcel</b></td>
+ </tr>
+ <form action="http://groups-beta.google.com/group/spreadsheet-writeexcel/boxsubscribe">
+ <tr>
+ <td>Email: <input type=text name=email></td>
+ <td>
+ <table
+ style="background-color:#ffcc33;padding:2px;border:2px outset #ffcc33;">
+ <tr>
+ <td>
+ <input type=submit name="sub" value="Subscribe">
+ </td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ </form>
+ <tr><td colspan=2 align=center>
+ <a href="http://groups-beta.google.com/group/spreadsheet-writeexcel">Browse Archives</a> at
+ <a href="http://groups-beta.google.com/">groups-beta.google.com</a>
+ </td></tr>
+</table>
+
+
+
+
+
+
+</P>
+<P>
+Alternatively you can keep up to date with future releases by subscribing
+at: <A
+HREF="http://freshmeat.net/projects/writeexcel/">http://freshmeat.net/projects/writeexcel/</A>
+
+
+</P>
+<P>
+<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
Spreadsheet::ParseExcel: <A
-HREF="http://search.cpan.org/search?dist=Spreadsheet-ParseExcel">http://search.cpan.org/search?dist=Spreadsheet-ParseExcel</A>
+HREF="http://search.cpan.org/dist/Spreadsheet-ParseExcel">http://search.cpan.org/dist/Spreadsheet-ParseExcel</A>
</P>
@@ -6932,32 +6988,38 @@
</P>
<P>
Spreadsheet::WriteExcel::FromDB: <A
-HREF="http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-FromDB">http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-FromDB</A>
+HREF="http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromDB">http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromDB</A>
</P>
<P>
+Excel::Template: <A
+HREF="http://search.cpan.org/~rkinyon/Excel-Template/">http://search.cpan.org/~rkinyon/Excel-Template/</A>
+
+
+</P>
+<P>
DateTime::Format::Excel: <A
-HREF="http://search.cpan.org/search?dist=DateTime-Format-Excel">http://search.cpan.org/search?dist=DateTime-Format-Excel</A>
+HREF="http://search.cpan.org/dist/DateTime-Format-Excel">http://search.cpan.org/dist/DateTime-Format-Excel</A>
</P>
<P>
-"Reading and writing Excel files with Perl" by Teodor Zlatanov,
-atIBM developerWorks: <A
+"Reading and writing Excel files with Perl" by Teodor Zlatanov, atIBM
+developerWorks: <A
HREF="http://www-106.ibm.com/developerworks/library/l-pexcel/">http://www-106.ibm.com/developerworks/library/l-pexcel/</A>
</P>
<P>
-"Excel-Dateien mit Perl erstellen - Controller im Glück" by Peter
+"Excel-Dateien mit Perl erstellen - Controller im Glück" by Peter
Dintelmann and Christian Kirsch in the German Unix/web journal iX: <A
HREF="http://www.heise.de/ix/artikel/2001/06/175/">http://www.heise.de/ix/artikel/2001/06/175/</A>
</P>
<P>
-"Spreadsheet::WriteExcel" in The Perl Journal: <A
+"Spreadsheet::WriteExcel" in The Perl Journal: <A
HREF="http://www.samag.com/documents/s=1272/sam05030004/">http://www.samag.com/documents/s=1272/sam05030004/</A>
@@ -7043,26 +7105,28 @@
</P>
<P>
<PRE>
- The difference between dogs and sheds
+ Slow dulcimer, gavotte and bow, in autumn,
+ Basho and his friends go out to view the moon;
+ In summer, gasoline rainbow in the gutter,
</PRE>
</P>
<P>
<PRE>
- It's not a very good idea to give a dog
- a coat
- of creosote
+ The secret courtesy that courses like ichor
+ Through the old form of the rude, full-scale joke,
+ Impossible to tell in writing.
</PRE>
</P>
<P>
<PRE>
- -- John Hegley
+ -- Robert Pinsky
</PRE>
</P>
<P>
<HR>
<H1><A NAME="COPYRIGHT">COPYRIGHT</A></H1>
<P>
-© MM-MMIV, John McNamara.
+© MM-MMV, John McNamara.
</P>
<P>
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/README
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/README 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/README 2005-04-05 23:16:48 UTC (rev 901)
@@ -51,10 +51,12 @@
write_handler3.pl Example of extending the write() method. Step 3.
write_handler4.pl Example of extending the write() method. Step 4.
+
Unicode
=======
unicode.pl Simple example of using Unicode UTF16 strings.
unicode_japan.pl Write Japanese Unicode strings using UTF16.
+unicode_cyrillic.pl Write Russian cyrillic strings using UTF8.
unicode_list.pl List the chars in a Unicode font.
unicode_2022_jp.pl Japanese: ISO-2022-JP to utf8 in perl 5.8.
unicode_8859_11.pl Thai: ISO-8859_11 to utf8 in perl 5.8.
Added: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/unicode_cyrillic.pl
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/unicode_cyrillic.pl 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/unicode_cyrillic.pl 2005-04-05 23:16:48 UTC (rev 901)
@@ -0,0 +1,48 @@
+#!/usr/bin/perl -w
+
+##############################################################################
+#
+# A simple example of writing some Russian cyrillic text using
+# Spreadsheet::WriteExcel and perl 5.8.
+#
+# reverse('©'), March 2005, John McNamara, jmcnamara at cpan.org
+#
+
+
+
+# Perl 5.8 or later is required for proper utf8 handling. For older perl
+# versions you should use UTF16 and the write_unicode() method.
+# See the write_unicode section of the Spreadsheet::WriteExcel docs.
+#
+require 5.008;
+
+use strict;
+use Spreadsheet::WriteExcel;
+
+
+# In this example we generate utf8 strings from character data but in a
+# real application we would expect them to come from an external source.
+#
+
+
+# Create a Russian worksheet name in utf8.
+my $sheet = pack "U*", 0x0421, 0x0442, 0x0440, 0x0430, 0x043D, 0x0438,
+ 0x0446, 0x0430;
+
+
+# Create a Russian string.
+my $str = pack "U*", 0x0417, 0x0434, 0x0440, 0x0430, 0x0432, 0x0441,
+ 0x0442, 0x0432, 0x0443, 0x0439, 0x0020, 0x041C,
+ 0x0438, 0x0440, 0x0021;
+
+
+
+my $workbook = Spreadsheet::WriteExcel->new("unicode_cyrillic.xls");
+my $worksheet = $workbook->add_worksheet($sheet . '1');
+
+ $worksheet->set_column('A:A', 18);
+ $worksheet->write('A1', $str);
+
+
+__END__
+
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/write_to_scalar.pl
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/write_to_scalar.pl 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/examples/write_to_scalar.pl 2005-04-05 23:16:48 UTC (rev 901)
@@ -19,7 +19,7 @@
# Use perl 5.8's feature of using a scalar as a filehandle.
my $fh;
-my $str;
+my $str = '';
open $fh, '>', \$str or die "Failed to open filehandle: $!";;
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/exe/chartex
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/exe/chartex 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/exe/chartex 2005-04-05 23:16:48 UTC (rev 901)
@@ -218,7 +218,7 @@
=head1 COPYRIGHT
-© MMIV, John McNamara.
+© MMV, John McNamara.
All Rights Reserved. This program is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/BIFFwriter.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/BIFFwriter.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/BIFFwriter.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,275 +1,275 @@
-package Spreadsheet::WriteExcel::BIFFwriter;
-
-###############################################################################
-#
-# BIFFwriter - An abstract base class for Excel workbooks and worksheets.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-
-
-
-
-
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Exporter);
-
-$VERSION = '2.01';
-
-###############################################################################
-#
-# Class data.
-#
-my $byte_order = '';
-my $BIFF_version = 0x0600;
-
-
-###############################################################################
-#
-# new()
-#
-# Constructor
-#
-sub new {
-
- my $class = $_[0];
-
- my $self = {
- _byte_order => '',
- _data => '',
- _datasize => 0,
- _limit => 8224,
- };
-
- bless $self, $class;
- $self->_set_byte_order();
- return $self;
-}
-
-
-###############################################################################
-#
-# _set_byte_order()
-#
-# Determine the byte order and store it as class data to avoid
-# recalculating it for each call to new().
-#
-sub _set_byte_order {
-
- my $self = shift;
-
- if ($byte_order eq ''){
- # Check if "pack" gives the required IEEE 64bit float
- my $teststr = pack "d", 1.2345;
- my @hexdata =(0x8D, 0x97, 0x6E, 0x12, 0x83, 0xC0, 0xF3, 0x3F);
- my $number = pack "C8", @hexdata;
-
- if ($number eq $teststr) {
- $byte_order = 0; # Little Endian
- }
- elsif ($number eq reverse($teststr)){
- $byte_order = 1; # Big Endian
- }
- else {
- # Give up. I'll fix this in a later version.
- croak ( "Required floating point format not supported " .
- "on this platform. See the portability section " .
- "of the documentation."
- );
- }
- }
- $self->{_byte_order} = $byte_order;
-}
-
-
-###############################################################################
-#
-# _prepend($data)
-#
-# General storage function
-#
-sub _prepend {
-
- my $self = shift;
- my $data = join('', @_);
-
- $data = $self->_add_continue($data) if length($data) > $self->{_limit};
-
- $self->{_data} = $data . $self->{_data};
- $self->{_datasize} += length($data);
-}
-
-
-###############################################################################
-#
-# _append($data)
-#
-# General storage function
-#
-sub _append {
-
- my $self = shift;
- my $data = join('', @_);
-
- $data = $self->_add_continue($data) if length($data) > $self->{_limit};
-
- $self->{_data} = $self->{_data} . $data;
- $self->{_datasize} += length($data);
-}
-
-
-###############################################################################
-#
-# _store_bof($type)
-#
-# $type = 0x0005, Workbook
-# $type = 0x0010, Worksheet
-#
-# Writes Excel BOF record to indicate the beginning of a stream or
-# sub-stream in the BIFF file.
-#
-sub _store_bof {
-
- my $self = shift;
- my $record = 0x0809; # Record identifier
- my $length = 0x0010; # Number of bytes to follow
-
- my $version = $BIFF_version;
- my $type = $_[0];
-
- # According to the SDK $build and $year should be set to zero.
- # However, this throws a warning in Excel 5. So, use these
- # magic numbers.
- my $build = 0x0DBB;
- my $year = 0x07CC;
-
- my $bfh = 0x00000041;
- my $sfo = 0x00000006;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvVV", $version, $type, $build, $year, $bfh, $sfo);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_eof()
-#
-# Writes Excel EOF record to indicate the end of a BIFF stream.
-#
-sub _store_eof {
-
- my $self = shift;
- my $record = 0x000A; # Record identifier
- my $length = 0x0000; # Number of bytes to follow
-
- my $header = pack("vv", $record, $length);
-
- $self->_append($header);
-}
-
-
-###############################################################################
-#
-# _add_continue()
-#
-# Excel limits the size of BIFF records. In Excel 5 the limit is 2084 bytes. In
-# Excel 97 the limit is 8228 bytes. Records that are longer than these limits
-# must be split up into CONTINUE blocks.
-#
-# This function take a long BIFF record and inserts CONTINUE records as
-# necessary.
-#
-sub _add_continue {
-
- my $self = shift;
- my $data = $_[0];
- my $limit = $self->{_limit};
- my $record = 0x003C; # Record identifier
- my $length; # Number of bytes to follow
- my $header;
- my $tmp;
-
- # The first 2080/8224 bytes remain intact. However, we have to change
- # the length field of the record.
- #
- $tmp = substr($data, 0, $limit, "");
- substr($tmp, 2, 2, pack("v", $limit-4));
-
- # Strip out chunks of 2080/8224 bytes +4 for the header.
- while (length($data) > $limit) {
- $header = pack("vv", $record, $limit);
- $tmp .= $header;
- $tmp .= substr($data, 0, $limit, "");
- }
-
- # Mop up the last of the data
- $header = pack("vv", $record, length($data));
- $tmp .= $header;
- $tmp .= $data;
-
- return $tmp ;
-}
-
-###############################################################################
-#
-# For debugging
-#
-sub _hexout {
-
- my $self = shift;
-
- print +(caller(1))[3], "\n";
-
- my $data = join '', @_;
-
- my @bytes = unpack("H*", $data) =~ /../g;
-
- while (@bytes > 16) {
- print join " ", splice @bytes, 0, 16;
- print "\n";
- }
- print join " ", @bytes, "\n\n";
-}
-
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-BIFFwriter - An abstract base class for Excel workbooks and worksheets.
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel
-
-=head1 DESCRIPTION
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-=head1 COPYRIGHT
-
-© MM-MMIII, 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.
+package Spreadsheet::WriteExcel::BIFFwriter;
+
+###############################################################################
+#
+# BIFFwriter - An abstract base class for Excel workbooks and worksheets.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+
+
+
+
+
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Exporter);
+
+$VERSION = '2.01';
+
+###############################################################################
+#
+# Class data.
+#
+my $byte_order = '';
+my $BIFF_version = 0x0600;
+
+
+###############################################################################
+#
+# new()
+#
+# Constructor
+#
+sub new {
+
+ my $class = $_[0];
+
+ my $self = {
+ _byte_order => '',
+ _data => '',
+ _datasize => 0,
+ _limit => 8224,
+ };
+
+ bless $self, $class;
+ $self->_set_byte_order();
+ return $self;
+}
+
+
+###############################################################################
+#
+# _set_byte_order()
+#
+# Determine the byte order and store it as class data to avoid
+# recalculating it for each call to new().
+#
+sub _set_byte_order {
+
+ my $self = shift;
+
+ if ($byte_order eq ''){
+ # Check if "pack" gives the required IEEE 64bit float
+ my $teststr = pack "d", 1.2345;
+ my @hexdata =(0x8D, 0x97, 0x6E, 0x12, 0x83, 0xC0, 0xF3, 0x3F);
+ my $number = pack "C8", @hexdata;
+
+ if ($number eq $teststr) {
+ $byte_order = 0; # Little Endian
+ }
+ elsif ($number eq reverse($teststr)){
+ $byte_order = 1; # Big Endian
+ }
+ else {
+ # Give up. I'll fix this in a later version.
+ croak ( "Required floating point format not supported " .
+ "on this platform. See the portability section " .
+ "of the documentation."
+ );
+ }
+ }
+ $self->{_byte_order} = $byte_order;
+}
+
+
+###############################################################################
+#
+# _prepend($data)
+#
+# General storage function
+#
+sub _prepend {
+
+ my $self = shift;
+ my $data = join('', @_);
+
+ $data = $self->_add_continue($data) if length($data) > $self->{_limit};
+
+ $self->{_data} = $data . $self->{_data};
+ $self->{_datasize} += length($data);
+}
+
+
+###############################################################################
+#
+# _append($data)
+#
+# General storage function
+#
+sub _append {
+
+ my $self = shift;
+ my $data = join('', @_);
+
+ $data = $self->_add_continue($data) if length($data) > $self->{_limit};
+
+ $self->{_data} = $self->{_data} . $data;
+ $self->{_datasize} += length($data);
+}
+
+
+###############################################################################
+#
+# _store_bof($type)
+#
+# $type = 0x0005, Workbook
+# $type = 0x0010, Worksheet
+#
+# Writes Excel BOF record to indicate the beginning of a stream or
+# sub-stream in the BIFF file.
+#
+sub _store_bof {
+
+ my $self = shift;
+ my $record = 0x0809; # Record identifier
+ my $length = 0x0010; # Number of bytes to follow
+
+ my $version = $BIFF_version;
+ my $type = $_[0];
+
+ # According to the SDK $build and $year should be set to zero.
+ # However, this throws a warning in Excel 5. So, use these
+ # magic numbers.
+ my $build = 0x0DBB;
+ my $year = 0x07CC;
+
+ my $bfh = 0x00000041;
+ my $sfo = 0x00000006;
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvVV", $version, $type, $build, $year, $bfh, $sfo);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_eof()
+#
+# Writes Excel EOF record to indicate the end of a BIFF stream.
+#
+sub _store_eof {
+
+ my $self = shift;
+ my $record = 0x000A; # Record identifier
+ my $length = 0x0000; # Number of bytes to follow
+
+ my $header = pack("vv", $record, $length);
+
+ $self->_append($header);
+}
+
+
+###############################################################################
+#
+# _add_continue()
+#
+# Excel limits the size of BIFF records. In Excel 5 the limit is 2084 bytes. In
+# Excel 97 the limit is 8228 bytes. Records that are longer than these limits
+# must be split up into CONTINUE blocks.
+#
+# This function take a long BIFF record and inserts CONTINUE records as
+# necessary.
+#
+sub _add_continue {
+
+ my $self = shift;
+ my $data = $_[0];
+ my $limit = $self->{_limit};
+ my $record = 0x003C; # Record identifier
+ my $length; # Number of bytes to follow
+ my $header;
+ my $tmp;
+
+ # The first 2080/8224 bytes remain intact. However, we have to change
+ # the length field of the record.
+ #
+ $tmp = substr($data, 0, $limit, "");
+ substr($tmp, 2, 2, pack("v", $limit-4));
+
+ # Strip out chunks of 2080/8224 bytes +4 for the header.
+ while (length($data) > $limit) {
+ $header = pack("vv", $record, $limit);
+ $tmp .= $header;
+ $tmp .= substr($data, 0, $limit, "");
+ }
+
+ # Mop up the last of the data
+ $header = pack("vv", $record, length($data));
+ $tmp .= $header;
+ $tmp .= $data;
+
+ return $tmp ;
+}
+
+###############################################################################
+#
+# For debugging
+#
+sub _hexout {
+
+ my $self = shift;
+
+ print +(caller(1))[3], "\n";
+
+ my $data = join '', @_;
+
+ my @bytes = unpack("H*", $data) =~ /../g;
+
+ while (@bytes > 16) {
+ print join " ", splice @bytes, 0, 16;
+ print "\n";
+ }
+ print join " ", @bytes, "\n\n";
+}
+
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+BIFFwriter - An abstract base class for Excel workbooks and worksheets.
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel
+
+=head1 DESCRIPTION
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Big.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Big.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Big.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,99 +1,99 @@
-package Spreadsheet::WriteExcel::Big;
-
-###############################################################################
-#
-# WriteExcel::Big
-#
-# Spreadsheet::WriteExcel - Write formatted text and numbers to a
-# cross-platform Excel binary file.
-#
-# Copyright 2000-2004, John McNamara.
-#
-#
-
-require Exporter;
-
-use strict;
-use Spreadsheet::WriteExcel::WorkbookBig;
-
-
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Spreadsheet::WriteExcel::WorkbookBig Exporter);
-
-$VERSION = '2.01'; # May 2000
-
-###############################################################################
-#
-# new()
-#
-# Constructor. Wrapper for a Workbook object.
-# uses: Spreadsheet::WriteExcel::BIFFwriter
-# Spreadsheet::WriteExcel::OLEwriter
-# Spreadsheet::WriteExcel::WorkbookBig
-# Spreadsheet::WriteExcel::Worksheet
-# Spreadsheet::WriteExcel::Format
-#
-sub new {
-
- my $class = shift;
- my $self = Spreadsheet::WriteExcel::WorkbookBig->new($_[0]);
-
- bless $self, $class;
- return $self;
-}
-
-
-1;
-
-
-__END__
-
-
-
-=head1 NAME
-
-
-Big - A class for creating Excel files > 7MB.
-
-
-=head1 SYNOPSIS
-
-
-See the documentation for Spreadsheet::WriteExcel.
-
-
-=head1 DESCRIPTION
-
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
- use Spreadsheet::WriteExcel::Big;
-
- my $workbook = Spreadsheet::WriteExcel::Big->new("file.xls");
- my $worksheet = $workbook->add_worksheet();
-
- # Same as Spreadsheet::WriteExcel
- ...
- ...
-
-
-=head1 REQUIREMENTS
-
-IO::Stringy and OLE::Storage_Lite
-
-
-=head1 AUTHOR
-
-
-John McNamara jmcnamara at cpan.org
-
-
-=head1 COPYRIGHT
-
-
-© MM-MMIV, 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.
+package Spreadsheet::WriteExcel::Big;
+
+###############################################################################
+#
+# WriteExcel::Big
+#
+# Spreadsheet::WriteExcel - Write formatted text and numbers to a
+# cross-platform Excel binary file.
+#
+# Copyright 2000-2005, John McNamara.
+#
+#
+
+require Exporter;
+
+use strict;
+use Spreadsheet::WriteExcel::WorkbookBig;
+
+
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Spreadsheet::WriteExcel::WorkbookBig Exporter);
+
+$VERSION = '2.01'; # May 2000
+
+###############################################################################
+#
+# new()
+#
+# Constructor. Wrapper for a Workbook object.
+# uses: Spreadsheet::WriteExcel::BIFFwriter
+# Spreadsheet::WriteExcel::OLEwriter
+# Spreadsheet::WriteExcel::WorkbookBig
+# Spreadsheet::WriteExcel::Worksheet
+# Spreadsheet::WriteExcel::Format
+#
+sub new {
+
+ my $class = shift;
+ my $self = Spreadsheet::WriteExcel::WorkbookBig->new($_[0]);
+
+ bless $self, $class;
+ return $self;
+}
+
+
+1;
+
+
+__END__
+
+
+
+=head1 NAME
+
+
+Big - A class for creating Excel files > 7MB.
+
+
+=head1 SYNOPSIS
+
+
+See the documentation for Spreadsheet::WriteExcel.
+
+
+=head1 DESCRIPTION
+
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+ use Spreadsheet::WriteExcel::Big;
+
+ my $workbook = Spreadsheet::WriteExcel::Big->new("file.xls");
+ my $worksheet = $workbook->add_worksheet();
+
+ # Same as Spreadsheet::WriteExcel
+ ...
+ ...
+
+
+=head1 REQUIREMENTS
+
+IO::Stringy and OLE::Storage_Lite
+
+
+=head1 AUTHOR
+
+
+John McNamara jmcnamara at cpan.org
+
+
+=head1 COPYRIGHT
+
+
+© MM-MMV, 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.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Chart.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Chart.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Chart.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,269 +1,269 @@
-package Spreadsheet::WriteExcel::Chart;
-
-###############################################################################
-#
-# Worksheet - A writer class for Excel Charts.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-use Carp;
-use FileHandle;
-use Spreadsheet::WriteExcel::BIFFwriter;
-
-
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Spreadsheet::WriteExcel::BIFFwriter);
-
-$VERSION = '2.10';
-
-###############################################################################
-#
-# new()
-#
-# Constructor. Creates a new Chart object from a BIFFwriter object
-#
-sub new {
-
- my $class = shift;
- my $self = Spreadsheet::WriteExcel::BIFFwriter->new();
-
- $self->{_filename} = $_[0];
- $self->{_name} = $_[1];
- $self->{_index} = $_[2];
- $self->{_name_encoding} = $_[3];
- $self->{_activesheet} = $_[4];
- $self->{_firstsheet} = $_[5];
-
- $self->{_type} = 0x0200;
- $self->{_ext_sheets} = [];
- $self->{_using_tmpfile} = 1;
- $self->{_filehandle} = "";
- $self->{_fileclosed} = 0;
- $self->{_offset} = 0;
- $self->{_xls_rowmax} = 0;
- $self->{_xls_colmax} = 0;
- $self->{_xls_strmax} = 0;
- $self->{_dim_rowmin} = 0;
- $self->{_dim_rowmax} = 0;
- $self->{_dim_colmin} = 0;
- $self->{_dim_colmax} = 0;
- $self->{_dim_changed} = 0;
- $self->{_colinfo} = [];
- $self->{_selection} = [0, 0];
- $self->{_panes} = [];
- $self->{_active_pane} = 3;
- $self->{_frozen} = 0;
- $self->{_selected} = 0;
-
- $self->{_paper_size} = 0x0;
- $self->{_orientation} = 0x1;
- $self->{_header} = '';
- $self->{_footer} = '';
- $self->{_hcenter} = 0;
- $self->{_vcenter} = 0;
- $self->{_margin_head} = 0.50;
- $self->{_margin_foot} = 0.50;
- $self->{_margin_left} = 0.75;
- $self->{_margin_right} = 0.75;
- $self->{_margin_top} = 1.00;
- $self->{_margin_bottom} = 1.00;
-
- $self->{_title_rowmin} = undef;
- $self->{_title_rowmax} = undef;
- $self->{_title_colmin} = undef;
- $self->{_title_colmax} = undef;
- $self->{_print_rowmin} = undef;
- $self->{_print_rowmax} = undef;
- $self->{_print_colmin} = undef;
- $self->{_print_colmax} = undef;
-
- $self->{_print_gridlines} = 1;
- $self->{_screen_gridlines} = 1;
- $self->{_print_headers} = 0;
-
- $self->{_fit_page} = 0;
- $self->{_fit_width} = 0;
- $self->{_fit_height} = 0;
-
- $self->{_hbreaks} = [];
- $self->{_vbreaks} = [];
-
- $self->{_protect} = 0;
- $self->{_password} = undef;
-
- $self->{_col_sizes} = {};
- $self->{_row_sizes} = {};
-
- $self->{_col_formats} = {};
- $self->{_row_formats} = {};
-
- $self->{_zoom} = 100;
- $self->{_print_scale} = 100;
-
- $self->{_leading_zeros} = 0;
-
- $self->{_outline_row_level} = 0;
- $self->{_outline_style} = 0;
- $self->{_outline_below} = 1;
- $self->{_outline_right} = 1;
- $self->{_outline_on} = 1;
-
- bless $self, $class;
- $self->_initialize();
- return $self;
-}
-
-
-###############################################################################
-#
-# _initialize()
-#
-sub _initialize {
-
- my $self = shift;
- my $filename = $self->{_filename};
- my $filehandle = FileHandle->new($filename) or
- die "Couldn't open $filename in add_chart_ext(): $!.\n";
-
- binmode($filehandle);
-
- $self->{_filehandle} = $filehandle;
- $self->{_datasize} = -s $filehandle;
-
-}
-
-
-###############################################################################
-#
-# _close()
-#
-# Add data to the beginning of the workbook (note the reverse order)
-# and to the end of the workbook.
-#
-sub _close {
-
- my $self = shift;
-}
-
-
-###############################################################################
-#
-# get_name().
-#
-# Retrieve the worksheet name.
-#
-sub get_name {
-
- my $self = shift;
-
- return $self->{_name};
-}
-
-
-###############################################################################
-#
-# get_data().
-#
-# Retrieves data from memory in one chunk, or from disk in $buffer
-# sized chunks.
-#
-sub get_data {
-
- my $self = shift;
- my $buffer = 4096;
- my $tmp;
-
- return $tmp if read($self->{_filehandle}, $tmp, $buffer);
-
- # No data to return
- return undef;
-}
-
-
-###############################################################################
-#
-# select()
-#
-# Set this worksheet as a selected worksheet, i.e. the worksheet has its tab
-# highlighted.
-#
-sub select {
-
- my $self = shift;
-
- $self->{_selected} = 1;
-}
-
-
-###############################################################################
-#
-# activate()
-#
-# Set this worksheet as the active worksheet, i.e. the worksheet that is
-# displayed when the workbook is opened. Also set it as selected.
-#
-sub activate {
-
- my $self = shift;
-
- $self->{_selected} = 1;
- ${$self->{_activesheet}} = $self->{_index};
-}
-
-
-###############################################################################
-#
-# set_first_sheet()
-#
-# Set this worksheet as the first visible sheet. This is necessary
-# when there are a large number of worksheets and the activated
-# worksheet is not visible on the screen.
-#
-sub set_first_sheet {
-
- my $self = shift;
-
- ${$self->{_firstsheet}} = $self->{_index};
-}
-
-
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-Worksheet - A writer class for Excel Charts.
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel
-
-=head1 DESCRIPTION
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
-
+package Spreadsheet::WriteExcel::Chart;
+
+###############################################################################
+#
+# Worksheet - A writer class for Excel Charts.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+use Carp;
+use FileHandle;
+use Spreadsheet::WriteExcel::BIFFwriter;
+
+
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Spreadsheet::WriteExcel::BIFFwriter);
+
+$VERSION = '2.10';
+
+###############################################################################
+#
+# new()
+#
+# Constructor. Creates a new Chart object from a BIFFwriter object
+#
+sub new {
+
+ my $class = shift;
+ my $self = Spreadsheet::WriteExcel::BIFFwriter->new();
+
+ $self->{_filename} = $_[0];
+ $self->{_name} = $_[1];
+ $self->{_index} = $_[2];
+ $self->{_encoding} = $_[3];
+ $self->{_activesheet} = $_[4];
+ $self->{_firstsheet} = $_[5];
+
+ $self->{_type} = 0x0200;
+ $self->{_ext_sheets} = [];
+ $self->{_using_tmpfile} = 1;
+ $self->{_filehandle} = "";
+ $self->{_fileclosed} = 0;
+ $self->{_offset} = 0;
+ $self->{_xls_rowmax} = 0;
+ $self->{_xls_colmax} = 0;
+ $self->{_xls_strmax} = 0;
+ $self->{_dim_rowmin} = 0;
+ $self->{_dim_rowmax} = 0;
+ $self->{_dim_colmin} = 0;
+ $self->{_dim_colmax} = 0;
+ $self->{_dim_changed} = 0;
+ $self->{_colinfo} = [];
+ $self->{_selection} = [0, 0];
+ $self->{_panes} = [];
+ $self->{_active_pane} = 3;
+ $self->{_frozen} = 0;
+ $self->{_selected} = 0;
+
+ $self->{_paper_size} = 0x0;
+ $self->{_orientation} = 0x1;
+ $self->{_header} = '';
+ $self->{_footer} = '';
+ $self->{_hcenter} = 0;
+ $self->{_vcenter} = 0;
+ $self->{_margin_head} = 0.50;
+ $self->{_margin_foot} = 0.50;
+ $self->{_margin_left} = 0.75;
+ $self->{_margin_right} = 0.75;
+ $self->{_margin_top} = 1.00;
+ $self->{_margin_bottom} = 1.00;
+
+ $self->{_title_rowmin} = undef;
+ $self->{_title_rowmax} = undef;
+ $self->{_title_colmin} = undef;
+ $self->{_title_colmax} = undef;
+ $self->{_print_rowmin} = undef;
+ $self->{_print_rowmax} = undef;
+ $self->{_print_colmin} = undef;
+ $self->{_print_colmax} = undef;
+
+ $self->{_print_gridlines} = 1;
+ $self->{_screen_gridlines} = 1;
+ $self->{_print_headers} = 0;
+
+ $self->{_fit_page} = 0;
+ $self->{_fit_width} = 0;
+ $self->{_fit_height} = 0;
+
+ $self->{_hbreaks} = [];
+ $self->{_vbreaks} = [];
+
+ $self->{_protect} = 0;
+ $self->{_password} = undef;
+
+ $self->{_col_sizes} = {};
+ $self->{_row_sizes} = {};
+
+ $self->{_col_formats} = {};
+ $self->{_row_formats} = {};
+
+ $self->{_zoom} = 100;
+ $self->{_print_scale} = 100;
+
+ $self->{_leading_zeros} = 0;
+
+ $self->{_outline_row_level} = 0;
+ $self->{_outline_style} = 0;
+ $self->{_outline_below} = 1;
+ $self->{_outline_right} = 1;
+ $self->{_outline_on} = 1;
+
+ bless $self, $class;
+ $self->_initialize();
+ return $self;
+}
+
+
+###############################################################################
+#
+# _initialize()
+#
+sub _initialize {
+
+ my $self = shift;
+ my $filename = $self->{_filename};
+ my $filehandle = FileHandle->new($filename) or
+ die "Couldn't open $filename in add_chart_ext(): $!.\n";
+
+ binmode($filehandle);
+
+ $self->{_filehandle} = $filehandle;
+ $self->{_datasize} = -s $filehandle;
+
+}
+
+
+###############################################################################
+#
+# _close()
+#
+# Add data to the beginning of the workbook (note the reverse order)
+# and to the end of the workbook.
+#
+sub _close {
+
+ my $self = shift;
+}
+
+
+###############################################################################
+#
+# get_name().
+#
+# Retrieve the worksheet name.
+#
+sub get_name {
+
+ my $self = shift;
+
+ return $self->{_name};
+}
+
+
+###############################################################################
+#
+# get_data().
+#
+# Retrieves data from memory in one chunk, or from disk in $buffer
+# sized chunks.
+#
+sub get_data {
+
+ my $self = shift;
+ my $buffer = 4096;
+ my $tmp;
+
+ return $tmp if read($self->{_filehandle}, $tmp, $buffer);
+
+ # No data to return
+ return undef;
+}
+
+
+###############################################################################
+#
+# select()
+#
+# Set this worksheet as a selected worksheet, i.e. the worksheet has its tab
+# highlighted.
+#
+sub select {
+
+ my $self = shift;
+
+ $self->{_selected} = 1;
+}
+
+
+###############################################################################
+#
+# activate()
+#
+# Set this worksheet as the active worksheet, i.e. the worksheet that is
+# displayed when the workbook is opened. Also set it as selected.
+#
+sub activate {
+
+ my $self = shift;
+
+ $self->{_selected} = 1;
+ ${$self->{_activesheet}} = $self->{_index};
+}
+
+
+###############################################################################
+#
+# set_first_sheet()
+#
+# Set this worksheet as the first visible sheet. This is necessary
+# when there are a large number of worksheets and the activated
+# worksheet is not visible on the screen.
+#
+sub set_first_sheet {
+
+ my $self = shift;
+
+ ${$self->{_firstsheet}} = $self->{_index};
+}
+
+
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+Worksheet - A writer class for Excel Charts.
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel
+
+=head1 DESCRIPTION
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
+
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Format.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Format.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Format.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,759 +1,770 @@
-package Spreadsheet::WriteExcel::Format;
-
-###############################################################################
-#
-# Format - A class for defining Excel formatting.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-use Carp; # TODO required?
-
-
-
-
-
-
-use vars qw($AUTOLOAD $VERSION @ISA);
- at ISA = qw(Exporter);
-
-$VERSION = '2.04';
-
-###############################################################################
-#
-# new()
-#
-# Constructor
-#
-sub new {
-
- my $class = shift;
-
- my $self = {
- _xf_index => shift || 0,
-
- _font_index => 0,
- _font => 'Arial',
- _size => 10,
- _bold => 0x0190,
- _italic => 0,
- _color => 0x7FFF,
- _underline => 0,
- _font_strikeout => 0,
- _font_outline => 0,
- _font_shadow => 0,
- _font_script => 0,
- _font_family => 0,
- _font_charset => 0,
- _font_encoding => 0,
-
- _num_format => 0,
- _num_format_enc => 0,
-
- _hidden => 0,
- _locked => 1,
-
- _text_h_align => 0,
- _text_wrap => 0,
- _text_v_align => 2,
- _text_justlast => 0,
- _rotation => 0,
-
- _fg_color => 0x40,
- _bg_color => 0x41,
-
- _pattern => 0,
-
- _bottom => 0,
- _top => 0,
- _left => 0,
- _right => 0,
-
- _bottom_color => 0x40,
- _top_color => 0x40,
- _left_color => 0x40,
- _right_color => 0x40,
-
- _indent => 0,
- _shrink => 0,
- _merge_range => 0,
- _reading_order => 0,
-
- _diag_type => 0,
- _diag_color => 0x40,
- _diag_border => 0,
-
- };
-
- bless $self, $class;
-
- # Set properties passed to Workbook::add_format()
- $self->set_properties(@_) if @_;
-
- return $self;
-}
-
-
-###############################################################################
-#
-# copy($format)
-#
-# Copy the attributes of another Spreadsheet::WriteExcel::Format object.
-#
-sub copy {
- my $self = shift;
- my $other = $_[0];
-
- return unless defined $other;
- return unless (ref($self) eq ref($other));
-
- my $xf = $self->{_xf_index}; # Store XF index assigned by Workbook.pm
- %$self = %$other; # Copy properties
- $self->{_xf_index} = $xf; # Restore XF index
-}
-
-
-###############################################################################
-#
-# get_xf($style)
-#
-# Generate an Excel BIFF XF record.
-#
-sub get_xf {
-
- use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
-
- my $self = shift;
-
- my $record; # Record identifier
- my $length; # Number of bytes to follow
-
- my $ifnt; # Index to FONT record
- my $ifmt; # Index to FORMAT record
- my $style; # Style and other options
- my $align; # Alignment
- my $indent; #
- my $icv; # fg and bg pattern colors
- my $border1; # Border line style and color
- my $border2; # Border TODO
- my $border3; # Border TODO
-
-
- # Set the type of the XF record and some of the attributes.
- if ($_[0] eq "style") {
- $style = 0xFFF5;
- }
- else {
- $style = $self->{_locked};
- $style |= $self->{_hidden} << 1;
- }
-
-
- # Flags to indicate if attributes have been set.
- my $atr_num = ($self->{_num_format} != 0);
-
- my $atr_fnt = ($self->{_font_index} != 0);
-
- my $atr_alc = ($self->{_text_h_align} != 0 ||
- $self->{_text_v_align} != 2 ||
- $self->{_shrink} != 0 ||
- $self->{_merge_range} != 0 ||
- $self->{_text_wrap} != 0 ||
- $self->{_indent} != 0) ? 1 : 0;
-
- my $atr_bdr = ($self->{_bottom} != 0 ||
- $self->{_top} != 0 ||
- $self->{_left} != 0 ||
- $self->{_right} != 0 ||
- $self->{_diag_type} != 0) ? 1: 0;
-
- my $atr_pat = ($self->{_fg_color} != 0x40 ||
- $self->{_bg_color} != 0x41 ||
- $self->{_pattern} != 0x00) ? 1 : 0;
-
- my $atr_prot = ($self->{_hidden} != 0 ||
- $self->{_locked} != 1) ? 1 : 0;
-
- # TODO
- $self->{_diag_border} = 1 if !$self->{_diag_border} and $self->{_diag_type};
-
-
- # Reset the default colours for the non-font properties
- $self->{_fg_color} = 0x40 if $self->{_fg_color} == 0x7FFF;
- $self->{_bg_color} = 0x41 if $self->{_bg_color} == 0x7FFF;
- $self->{_bottom_color} = 0x40 if $self->{_bottom_color} == 0x7FFF;
- $self->{_top_color} = 0x40 if $self->{_top_color} == 0x7FFF;
- $self->{_left_color} = 0x40 if $self->{_left_color} == 0x7FFF;
- $self->{_right_color} = 0x40 if $self->{_right_color} == 0x7FFF;
- $self->{_diag_color} = 0x40 if $self->{_diag_color} == 0x7FFF;
-
-
- # Zero the default border colour if the border has not been set.
- $self->{_bottom_color} = 0 if $self->{_bottom} == 0;
- $self->{_top_color} = 0 if $self->{_top} == 0;
- $self->{_right_color} = 0 if $self->{_right} == 0;
- $self->{_left_color} = 0 if $self->{_left} == 0;
- $self->{_diag_color} = 0 if $self->{_diag_type} == 0;
-
-
- # The following 2 logical statements take care of special cases in relation
- # to cell colours and patterns:
- # 1. For a solid fill (_pattern == 1) Excel reverses the role of foreground
- # and background colours.
- # 2. If the user specifies a foreground or background colour without a
- # pattern they probably wanted a solid fill, so we fill in the defaults.
- #
- if ($self->{_pattern} <= 0x01 and
- $self->{_bg_color} != 0x41 and
- $self->{_fg_color} == 0x40 )
- {
- $self->{_fg_color} = $self->{_bg_color};
- $self->{_bg_color} = 0x40;
- $self->{_pattern} = 1;
- }
-
- if ($self->{_pattern} <= 0x01 and
- $self->{_bg_color} == 0x41 and
- $self->{_fg_color} != 0x40 )
- {
- $self->{_bg_color} = 0x40;
- $self->{_pattern} = 1;
- }
-
-
- # Set default alignment if indent is set.
- $self->{_text_h_align} = 1 if $self->{_indent} and
- $self->{_text_h_align} == 0;
-
-
- $record = 0x00E0;
- $length = 0x0014;
-
- $ifnt = $self->{_font_index};
- $ifmt = $self->{_num_format};
-
-
- $align = $self->{_text_h_align};
- $align |= $self->{_text_wrap} << 3;
- $align |= $self->{_text_v_align} << 4;
- $align |= $self->{_text_justlast} << 7;
- $align |= $self->{_rotation} << 8;
-
-
-
- $indent = $self->{_indent};
- $indent |= $self->{_shrink} << 4;
- $indent |= $self->{_merge_range} << 5;
- $indent |= $self->{_reading_order} << 6;
- $indent |= $atr_num << 10;
- $indent |= $atr_fnt << 11;
- $indent |= $atr_alc << 12;
- $indent |= $atr_bdr << 13;
- $indent |= $atr_pat << 14;
- $indent |= $atr_prot << 15;
-
-
- $border1 = $self->{_left};
- $border1 |= $self->{_right} << 4;
- $border1 |= $self->{_top} << 8;
- $border1 |= $self->{_bottom} << 12;
-
- $border2 = $self->{_left_color};
- $border2 |= $self->{_right_color} << 7;
- $border2 |= $self->{_diag_type} << 14;
-
-
- $border3 |= $self->{_top_color};
- $border3 |= $self->{_bottom_color} << 7;
- $border3 |= $self->{_diag_color} << 14;
- $border3 |= $self->{_diag_border} << 21;
- $border3 |= $self->{_pattern} << 26;
-
- $icv = $self->{_fg_color};
- $icv |= $self->{_bg_color} << 7;
-
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvvvvVv", $ifnt, $ifmt, $style,
- $align, $indent,
- $border1, $border2, $border3,
- $icv);
-
- return($header . $data);
-}
-
-
-###############################################################################
-#
-# Note to porters. The majority of the set_property() methods are created
-# dynamically via Perl' AUTOLOAD sub, see below. You may prefer/have to specify
-# them explicitly in other implementation languages.
-#
-
-
-###############################################################################
-#
-# get_font()
-#
-# Generate an Excel BIFF FONT record.
-#
-sub get_font {
-
- my $self = shift;
-
- my $record; # Record identifier
- my $length; # Record length
-
- my $dyHeight; # Height of font (1/20 of a point)
- my $grbit; # Font attributes
- my $icv; # Index to color palette
- my $bls; # Bold style
- my $sss; # Superscript/subscript
- my $uls; # Underline
- my $bFamily; # Font family
- my $bCharSet; # Character set
- my $reserved; # Reserved
- my $cch; # Length of font name
- my $rgch; # Font name
- my $encoding; # Font name character encoding
-
-
- $dyHeight = $self->{_size} * 20;
- $icv = $self->{_color};
- $bls = $self->{_bold};
- $sss = $self->{_font_script};
- $uls = $self->{_underline};
- $bFamily = $self->{_font_family};
- $bCharSet = $self->{_font_charset};
- $rgch = $self->{_font};
-
- $encoding = $self->{_font_encoding};
- $cch = length $rgch;
-
- # Handle Unicode font names.
- if ($encoding == 1) {
- croak "Uneven number of bytes in Unicode font name" if $cch % 2;
- $cch /= 2 if $self->{_font_encoding};
- $rgch = pack 'v*', unpack 'n*', $rgch;
- }
-
- $record = 0x31;
- $length = 0x10 + length $rgch;
- $reserved = 0x00;
-
- $grbit = 0x00;
- $grbit |= 0x02 if $self->{_italic};
- $grbit |= 0x08 if $self->{_font_strikeout};
- $grbit |= 0x10 if $self->{_font_outline};
- $grbit |= 0x20 if $self->{_font_shadow};
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvvCCCCCC", $dyHeight, $grbit, $icv, $bls,
- $sss, $uls, $bFamily,
- $bCharSet, $reserved, $cch, $encoding);
-
- return($header . $data. $self->{_font});
-}
-
-###############################################################################
-#
-# get_font_key()
-#
-# Returns a unique hash key for a font. Used by Workbook->_store_all_fonts()
-#
-sub get_font_key {
-
- my $self = shift;
-
- # The following elements are arranged to increase the probability of
- # generating a unique key. Elements that hold a large range of numbers
- # e.g. _color are placed between two binary elements such as _italic
- #
- my $key = "$self->{_font}$self->{_size}";
- $key .= "$self->{_font_script}$self->{_underline}";
- $key .= "$self->{_font_strikeout}$self->{_bold}$self->{_font_outline}";
- $key .= "$self->{_font_family}$self->{_font_charset}";
- $key .= "$self->{_font_shadow}$self->{_color}$self->{_italic}";
- $key .= "$self->{_font_encoding}";
- $key =~ s/ /_/g; # Convert the key to a single word
-
- return $key;
-}
-
-
-###############################################################################
-#
-# get_xf_index()
-#
-# Returns the used by Worksheet->_XF()
-#
-sub get_xf_index {
- my $self = shift;
-
- return $self->{_xf_index};
-}
-
-
-###############################################################################
-#
-# _get_color()
-#
-# Used in conjunction with the set_xxx_color methods to convert a color
-# string into a number. Color range is 0..63 but we will restrict it
-# to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
-#
-sub _get_color {
-
- my %colors = (
- aqua => 0x0F,
- cyan => 0x0F,
- black => 0x08,
- blue => 0x0C,
- brown => 0x10,
- magenta => 0x0E,
- fuchsia => 0x0E,
- gray => 0x17,
- grey => 0x17,
- green => 0x11,
- lime => 0x0B,
- navy => 0x12,
- orange => 0x35,
- purple => 0x14,
- red => 0x0A,
- silver => 0x16,
- white => 0x09,
- yellow => 0x0D,
- );
-
- # Return the default color, 0x7FFF, if undef,
- return 0x7FFF unless defined $_[0];
-
- # or the color string converted to an integer,
- return $colors{lc($_[0])} if exists $colors{lc($_[0])};
-
- # or the default color if string is unrecognised,
- return 0x7FFF if ($_[0] =~ m/\D/);
-
- # or an index < 8 mapped into the correct range,
- return $_[0] + 8 if $_[0] < 8;
-
- # or the default color if arg is outside range,
- return 0x7FFF if $_[0] > 63;
-
- # or an integer in the valid range
- return $_[0];
-}
-
-
-###############################################################################
-#
-# set_align()
-#
-# Set cell alignment.
-#
-sub set_align {
-
- my $self = shift;
- my $location = $_[0];
-
- return if not defined $location; # No default
- return if $location =~ m/\d/; # Ignore numbers
-
- $location = lc($location);
-
- $self->set_text_h_align(1) if ($location eq 'left');
- $self->set_text_h_align(2) if ($location eq 'centre');
- $self->set_text_h_align(2) if ($location eq 'center');
- $self->set_text_h_align(3) if ($location eq 'right');
- $self->set_text_h_align(4) if ($location eq 'fill');
- $self->set_text_h_align(5) if ($location eq 'justify');
- $self->set_text_h_align(6) if ($location eq 'center_across');
- $self->set_text_h_align(6) if ($location eq 'centre_across');
- $self->set_text_h_align(6) if ($location eq 'merge'); # S:WE name
- $self->set_text_h_align(7) if ($location eq 'distributed');
- $self->set_text_h_align(7) if ($location eq 'equal_space'); # ParseExcel
-
-
- $self->set_text_v_align(0) if ($location eq 'top');
- $self->set_text_v_align(1) if ($location eq 'vcentre');
- $self->set_text_v_align(1) if ($location eq 'vcenter');
- $self->set_text_v_align(2) if ($location eq 'bottom');
- $self->set_text_v_align(3) if ($location eq 'vjustify');
- $self->set_text_v_align(4) if ($location eq 'vdistributed');
- $self->set_text_v_align(4) if ($location eq 'vequal_space'); # ParseExcel
-}
-
-
-###############################################################################
-#
-# set_valign()
-#
-# Set vertical cell alignment. This is required by the set_properties() method
-# to differentiate between the vertical and horizontal properties.
-#
-sub set_valign {
-
- my $self = shift;
- $self->set_align(@_);
-}
-
-
-###############################################################################
-#
-# set_center_across()
-#
-# Implements the Excel5 style "merge".
-#
-sub set_center_across {
-
- my $self = shift;
-
- $self->set_text_h_align(6);
-}
-
-
-###############################################################################
-#
-# set_merge()
-#
-# This was the way to implement a merge in Excel5. However it should have been
-# called "center_across" and not "merge".
-# This is now deprecated. Use set_center_across() or better merge_range().
-#
-#
-sub set_merge {
-
- my $self = shift;
-
- $self->set_text_h_align(6);
-}
-
-
-###############################################################################
-#
-# set_bold()
-#
-# Bold has a range 0x64..0x3E8.
-# 0x190 is normal. 0x2BC is bold. So is an excessive use of AUTOLOAD.
-#
-sub set_bold {
-
- my $self = shift;
- my $weight = $_[0];
-
- $weight = 0x2BC if not defined $weight; # Bold text
- $weight = 0x2BC if $weight == 1; # Bold text
- $weight = 0x190 if $weight == 0; # Normal text
- $weight = 0x190 if $weight < 0x064; # Lower bound
- $weight = 0x190 if $weight > 0x3E8; # Upper bound
-
- $self->{_bold} = $weight;
-}
-
-
-###############################################################################
-#
-# set_border($style)
-#
-# Set cells borders to the same style
-#
-sub set_border {
-
- my $self = shift;
- my $style = $_[0];
-
- $self->set_bottom($style);
- $self->set_top($style);
- $self->set_left($style);
- $self->set_right($style);
-}
-
-
-###############################################################################
-#
-# set_border_color($color)
-#
-# Set cells border to the same color
-#
-sub set_border_color {
-
- my $self = shift;
- my $color = $_[0];
-
- $self->set_bottom_color($color);
- $self->set_top_color($color);
- $self->set_left_color($color);
- $self->set_right_color($color);
-}
-
-
-###############################################################################
-#
-# set_rotation($angle)
-#
-# Set the rotation angle of the text. An alignment property.
-#
-sub set_rotation {
-
- my $self = shift;
- my $rotation = $_[0];
-
- # Argument should be a number
- return if $rotation !~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/;
-
- # The arg type can be a double but the Excel dialog only allows integers.
- $rotation = int $rotation;
-
- if ($rotation == 270) {
- $rotation = 255;
- }
- elsif ($rotation >= -90 or $rotation <= 90) {
- $rotation = -$rotation +90 if $rotation < 0;
- }
- else {
- carp "Rotation $rotation outside range: -90 <= angle <= 90";
- $rotation = 0;
- }
-
- $self->{_rotation} = $rotation;
-}
-
-
-###############################################################################
-#
-# set_properties()
-#
-# Convert hashes of properties to method calls.
-#
-sub set_properties {
-
- my $self = shift;
-
- my %properties = @_; # Merge multiple hashes into one
-
- while (my($key, $value) = each(%properties)) {
-
- # Strip leading "-" from Tk style properties e.g. -color => 'red'.
- $key =~ s/^-//;
-
-
- # Make sure method names are alphanumeric characters only, in case
- # tainted data is passed to the eval().
- #
- die "Unknown method: \$self->set_$key\n" if $key =~ /\W/;
-
-
- # Evaling all $values as a strings gets around the problem of some
- # numerical format strings being evaluated as numbers, for example
- # "00000" for a zip code.
- #
- if (defined $value) {
- eval "\$self->set_$key('$value')";
- }
- else {
- eval "\$self->set_$key(undef)";
- }
-
- die $@ if $@; # Rethrow the eval error.
- }
-}
-
-
-###############################################################################
-#
-# AUTOLOAD. Deus ex machina.
-#
-# Dynamically create set methods that aren't already defined.
-#
-sub AUTOLOAD {
-
- my $self = shift;
-
- # Ignore calls to DESTROY
- return if $AUTOLOAD =~ /::DESTROY$/;
-
- # Check for a valid method names, i.e. "set_xxx_yyy".
- $AUTOLOAD =~ /.*::set(\w+)/ or die "Unknown method: $AUTOLOAD\n";
-
- # Match the attribute, i.e. "_xxx_yyy".
- my $attribute = $1;
-
- # Check that the attribute exists
- exists $self->{$attribute} or die "Unknown method: $AUTOLOAD\n";
-
- # The attribute value
- my $value;
-
-
- # There are two types of set methods: set_property() and
- # set_property_color(). When a method is AUTOLOADED we store a new anonymous
- # sub in the appropriate slot in the symbol table. The speeds up subsequent
- # calls to the same method.
- #
- no strict 'refs'; # To allow symbol table hackery
-
- if ($AUTOLOAD =~ /.*::set\w+color$/) {
- # For "set_property_color" methods
- $value = _get_color($_[0]);
-
- *{$AUTOLOAD} = sub {
- my $self = shift;
-
- $self->{$attribute} = _get_color($_[0]);
- };
- }
- else {
-
- $value = $_[0];
- $value = 1 if not defined $value; # The default value is always 1
-
- *{$AUTOLOAD} = sub {
- my $self = shift;
- my $value = shift;
-
- $value = 1 if not defined $value;
- $self->{$attribute} = $value;
- };
-}
-
-
- $self->{$attribute} = $value;
-}
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-Format - A class for defining Excel formatting.
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel
-
-=head1 DESCRIPTION
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
+package Spreadsheet::WriteExcel::Format;
+
+###############################################################################
+#
+# Format - A class for defining Excel formatting.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+use Carp; # TODO required?
+
+
+
+
+
+
+use vars qw($AUTOLOAD $VERSION @ISA);
+ at ISA = qw(Exporter);
+
+$VERSION = '2.04';
+
+###############################################################################
+#
+# new()
+#
+# Constructor
+#
+sub new {
+
+ my $class = shift;
+
+ my $self = {
+ _xf_index => shift || 0,
+
+ _font_index => 0,
+ _font => 'Arial',
+ _size => 10,
+ _bold => 0x0190,
+ _italic => 0,
+ _color => 0x7FFF,
+ _underline => 0,
+ _font_strikeout => 0,
+ _font_outline => 0,
+ _font_shadow => 0,
+ _font_script => 0,
+ _font_family => 0,
+ _font_charset => 0,
+ _font_encoding => 0,
+
+ _num_format => 0,
+ _num_format_enc => 0,
+
+ _hidden => 0,
+ _locked => 1,
+
+ _text_h_align => 0,
+ _text_wrap => 0,
+ _text_v_align => 2,
+ _text_justlast => 0,
+ _rotation => 0,
+
+ _fg_color => 0x40,
+ _bg_color => 0x41,
+
+ _pattern => 0,
+
+ _bottom => 0,
+ _top => 0,
+ _left => 0,
+ _right => 0,
+
+ _bottom_color => 0x40,
+ _top_color => 0x40,
+ _left_color => 0x40,
+ _right_color => 0x40,
+
+ _indent => 0,
+ _shrink => 0,
+ _merge_range => 0,
+ _reading_order => 0,
+
+ _diag_type => 0,
+ _diag_color => 0x40,
+ _diag_border => 0,
+
+ };
+
+ bless $self, $class;
+
+ # Set properties passed to Workbook::add_format()
+ $self->set_properties(@_) if @_;
+
+ return $self;
+}
+
+
+###############################################################################
+#
+# copy($format)
+#
+# Copy the attributes of another Spreadsheet::WriteExcel::Format object.
+#
+sub copy {
+ my $self = shift;
+ my $other = $_[0];
+
+ return unless defined $other;
+ return unless (ref($self) eq ref($other));
+
+ my $xf = $self->{_xf_index}; # Store XF index assigned by Workbook.pm
+ %$self = %$other; # Copy properties
+ $self->{_xf_index} = $xf; # Restore XF index
+}
+
+
+###############################################################################
+#
+# get_xf($style)
+#
+# Generate an Excel BIFF XF record.
+#
+sub get_xf {
+
+ use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
+
+ my $self = shift;
+
+ my $record; # Record identifier
+ my $length; # Number of bytes to follow
+
+ my $ifnt; # Index to FONT record
+ my $ifmt; # Index to FORMAT record
+ my $style; # Style and other options
+ my $align; # Alignment
+ my $indent; #
+ my $icv; # fg and bg pattern colors
+ my $border1; # Border line style and color
+ my $border2; # Border TODO
+ my $border3; # Border TODO
+
+
+ # Set the type of the XF record and some of the attributes.
+ if ($_[0] eq "style") {
+ $style = 0xFFF5;
+ }
+ else {
+ $style = $self->{_locked};
+ $style |= $self->{_hidden} << 1;
+ }
+
+
+ # Flags to indicate if attributes have been set.
+ my $atr_num = ($self->{_num_format} != 0);
+
+ my $atr_fnt = ($self->{_font_index} != 0);
+
+ my $atr_alc = ($self->{_text_h_align} != 0 ||
+ $self->{_text_v_align} != 2 ||
+ $self->{_shrink} != 0 ||
+ $self->{_merge_range} != 0 ||
+ $self->{_text_wrap} != 0 ||
+ $self->{_indent} != 0) ? 1 : 0;
+
+ my $atr_bdr = ($self->{_bottom} != 0 ||
+ $self->{_top} != 0 ||
+ $self->{_left} != 0 ||
+ $self->{_right} != 0 ||
+ $self->{_diag_type} != 0) ? 1: 0;
+
+ my $atr_pat = ($self->{_fg_color} != 0x40 ||
+ $self->{_bg_color} != 0x41 ||
+ $self->{_pattern} != 0x00) ? 1 : 0;
+
+ my $atr_prot = ($self->{_hidden} != 0 ||
+ $self->{_locked} != 1) ? 1 : 0;
+
+
+ # Set a default diagonal border style if none was specified.
+ $self->{_diag_border} = 1 if !$self->{_diag_border} and $self->{_diag_type};
+
+
+ # Reset the default colours for the non-font properties
+ $self->{_fg_color} = 0x40 if $self->{_fg_color} == 0x7FFF;
+ $self->{_bg_color} = 0x41 if $self->{_bg_color} == 0x7FFF;
+ $self->{_bottom_color} = 0x40 if $self->{_bottom_color} == 0x7FFF;
+ $self->{_top_color} = 0x40 if $self->{_top_color} == 0x7FFF;
+ $self->{_left_color} = 0x40 if $self->{_left_color} == 0x7FFF;
+ $self->{_right_color} = 0x40 if $self->{_right_color} == 0x7FFF;
+ $self->{_diag_color} = 0x40 if $self->{_diag_color} == 0x7FFF;
+
+
+ # Zero the default border colour if the border has not been set.
+ $self->{_bottom_color} = 0 if $self->{_bottom} == 0;
+ $self->{_top_color} = 0 if $self->{_top} == 0;
+ $self->{_right_color} = 0 if $self->{_right} == 0;
+ $self->{_left_color} = 0 if $self->{_left} == 0;
+ $self->{_diag_color} = 0 if $self->{_diag_type} == 0;
+
+
+ # The following 2 logical statements take care of special cases in relation
+ # to cell colours and patterns:
+ # 1. For a solid fill (_pattern == 1) Excel reverses the role of foreground
+ # and background colours.
+ # 2. If the user specifies a foreground or background colour without a
+ # pattern they probably wanted a solid fill, so we fill in the defaults.
+ #
+ if ($self->{_pattern} <= 0x01 and
+ $self->{_bg_color} != 0x41 and
+ $self->{_fg_color} == 0x40 )
+ {
+ $self->{_fg_color} = $self->{_bg_color};
+ $self->{_bg_color} = 0x40;
+ $self->{_pattern} = 1;
+ }
+
+ if ($self->{_pattern} <= 0x01 and
+ $self->{_bg_color} == 0x41 and
+ $self->{_fg_color} != 0x40 )
+ {
+ $self->{_bg_color} = 0x40;
+ $self->{_pattern} = 1;
+ }
+
+
+ # Set default alignment if indent is set.
+ $self->{_text_h_align} = 1 if $self->{_indent} and
+ $self->{_text_h_align} == 0;
+
+
+ $record = 0x00E0;
+ $length = 0x0014;
+
+ $ifnt = $self->{_font_index};
+ $ifmt = $self->{_num_format};
+
+
+ $align = $self->{_text_h_align};
+ $align |= $self->{_text_wrap} << 3;
+ $align |= $self->{_text_v_align} << 4;
+ $align |= $self->{_text_justlast} << 7;
+ $align |= $self->{_rotation} << 8;
+
+
+
+ $indent = $self->{_indent};
+ $indent |= $self->{_shrink} << 4;
+ $indent |= $self->{_merge_range} << 5;
+ $indent |= $self->{_reading_order} << 6;
+ $indent |= $atr_num << 10;
+ $indent |= $atr_fnt << 11;
+ $indent |= $atr_alc << 12;
+ $indent |= $atr_bdr << 13;
+ $indent |= $atr_pat << 14;
+ $indent |= $atr_prot << 15;
+
+
+ $border1 = $self->{_left};
+ $border1 |= $self->{_right} << 4;
+ $border1 |= $self->{_top} << 8;
+ $border1 |= $self->{_bottom} << 12;
+
+ $border2 = $self->{_left_color};
+ $border2 |= $self->{_right_color} << 7;
+ $border2 |= $self->{_diag_type} << 14;
+
+
+ $border3 |= $self->{_top_color};
+ $border3 |= $self->{_bottom_color} << 7;
+ $border3 |= $self->{_diag_color} << 14;
+ $border3 |= $self->{_diag_border} << 21;
+ $border3 |= $self->{_pattern} << 26;
+
+ $icv = $self->{_fg_color};
+ $icv |= $self->{_bg_color} << 7;
+
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvvvvVv", $ifnt, $ifmt, $style,
+ $align, $indent,
+ $border1, $border2, $border3,
+ $icv);
+
+ return($header . $data);
+}
+
+
+###############################################################################
+#
+# Note to porters. The majority of the set_property() methods are created
+# dynamically via Perl' AUTOLOAD sub, see below. You may prefer/have to specify
+# them explicitly in other implementation languages.
+#
+
+
+###############################################################################
+#
+# get_font()
+#
+# Generate an Excel BIFF FONT record.
+#
+sub get_font {
+
+ my $self = shift;
+
+ my $record; # Record identifier
+ my $length; # Record length
+
+ my $dyHeight; # Height of font (1/20 of a point)
+ my $grbit; # Font attributes
+ my $icv; # Index to color palette
+ my $bls; # Bold style
+ my $sss; # Superscript/subscript
+ my $uls; # Underline
+ my $bFamily; # Font family
+ my $bCharSet; # Character set
+ my $reserved; # Reserved
+ my $cch; # Length of font name
+ my $rgch; # Font name
+ my $encoding; # Font name character encoding
+
+
+ $dyHeight = $self->{_size} * 20;
+ $icv = $self->{_color};
+ $bls = $self->{_bold};
+ $sss = $self->{_font_script};
+ $uls = $self->{_underline};
+ $bFamily = $self->{_font_family};
+ $bCharSet = $self->{_font_charset};
+ $rgch = $self->{_font};
+ $encoding = $self->{_font_encoding};
+
+ # Handle utf8 strings in newer perls.
+ if ($] >= 5.008) {
+ require Encode;
+
+ if (Encode::is_utf8($rgch)) {
+ $rgch = Encode::encode("UTF-16BE", $rgch);
+ $encoding = 1;
+ }
+ }
+
+ $cch = length $rgch;
+
+ # Handle Unicode font names.
+ if ($encoding == 1) {
+ croak "Uneven number of bytes in Unicode font name" if $cch % 2;
+ $cch /= 2 if $encoding;
+ $rgch = pack 'v*', unpack 'n*', $rgch;
+ }
+
+ $record = 0x31;
+ $length = 0x10 + length $rgch;
+ $reserved = 0x00;
+
+ $grbit = 0x00;
+ $grbit |= 0x02 if $self->{_italic};
+ $grbit |= 0x08 if $self->{_font_strikeout};
+ $grbit |= 0x10 if $self->{_font_outline};
+ $grbit |= 0x20 if $self->{_font_shadow};
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvvCCCCCC", $dyHeight, $grbit, $icv, $bls,
+ $sss, $uls, $bFamily,
+ $bCharSet, $reserved, $cch, $encoding);
+
+ return($header . $data. $self->{_font});
+}
+
+###############################################################################
+#
+# get_font_key()
+#
+# Returns a unique hash key for a font. Used by Workbook->_store_all_fonts()
+#
+sub get_font_key {
+
+ my $self = shift;
+
+ # The following elements are arranged to increase the probability of
+ # generating a unique key. Elements that hold a large range of numbers
+ # e.g. _color are placed between two binary elements such as _italic
+ #
+ my $key = "$self->{_font}$self->{_size}";
+ $key .= "$self->{_font_script}$self->{_underline}";
+ $key .= "$self->{_font_strikeout}$self->{_bold}$self->{_font_outline}";
+ $key .= "$self->{_font_family}$self->{_font_charset}";
+ $key .= "$self->{_font_shadow}$self->{_color}$self->{_italic}";
+ $key .= "$self->{_font_encoding}";
+ $key =~ s/ /_/g; # Convert the key to a single word
+
+ return $key;
+}
+
+
+###############################################################################
+#
+# get_xf_index()
+#
+# Returns the used by Worksheet->_XF()
+#
+sub get_xf_index {
+ my $self = shift;
+
+ return $self->{_xf_index};
+}
+
+
+###############################################################################
+#
+# _get_color()
+#
+# Used in conjunction with the set_xxx_color methods to convert a color
+# string into a number. Color range is 0..63 but we will restrict it
+# to 8..63 to comply with Gnumeric. Colors 0..7 are repeated in 8..15.
+#
+sub _get_color {
+
+ my %colors = (
+ aqua => 0x0F,
+ cyan => 0x0F,
+ black => 0x08,
+ blue => 0x0C,
+ brown => 0x10,
+ magenta => 0x0E,
+ fuchsia => 0x0E,
+ gray => 0x17,
+ grey => 0x17,
+ green => 0x11,
+ lime => 0x0B,
+ navy => 0x12,
+ orange => 0x35,
+ purple => 0x14,
+ red => 0x0A,
+ silver => 0x16,
+ white => 0x09,
+ yellow => 0x0D,
+ );
+
+ # Return the default color, 0x7FFF, if undef,
+ return 0x7FFF unless defined $_[0];
+
+ # or the color string converted to an integer,
+ return $colors{lc($_[0])} if exists $colors{lc($_[0])};
+
+ # or the default color if string is unrecognised,
+ return 0x7FFF if ($_[0] =~ m/\D/);
+
+ # or an index < 8 mapped into the correct range,
+ return $_[0] + 8 if $_[0] < 8;
+
+ # or the default color if arg is outside range,
+ return 0x7FFF if $_[0] > 63;
+
+ # or an integer in the valid range
+ return $_[0];
+}
+
+
+###############################################################################
+#
+# set_align()
+#
+# Set cell alignment.
+#
+sub set_align {
+
+ my $self = shift;
+ my $location = $_[0];
+
+ return if not defined $location; # No default
+ return if $location =~ m/\d/; # Ignore numbers
+
+ $location = lc($location);
+
+ $self->set_text_h_align(1) if ($location eq 'left');
+ $self->set_text_h_align(2) if ($location eq 'centre');
+ $self->set_text_h_align(2) if ($location eq 'center');
+ $self->set_text_h_align(3) if ($location eq 'right');
+ $self->set_text_h_align(4) if ($location eq 'fill');
+ $self->set_text_h_align(5) if ($location eq 'justify');
+ $self->set_text_h_align(6) if ($location eq 'center_across');
+ $self->set_text_h_align(6) if ($location eq 'centre_across');
+ $self->set_text_h_align(6) if ($location eq 'merge'); # S:WE name
+ $self->set_text_h_align(7) if ($location eq 'distributed');
+ $self->set_text_h_align(7) if ($location eq 'equal_space'); # ParseExcel
+
+
+ $self->set_text_v_align(0) if ($location eq 'top');
+ $self->set_text_v_align(1) if ($location eq 'vcentre');
+ $self->set_text_v_align(1) if ($location eq 'vcenter');
+ $self->set_text_v_align(2) if ($location eq 'bottom');
+ $self->set_text_v_align(3) if ($location eq 'vjustify');
+ $self->set_text_v_align(4) if ($location eq 'vdistributed');
+ $self->set_text_v_align(4) if ($location eq 'vequal_space'); # ParseExcel
+}
+
+
+###############################################################################
+#
+# set_valign()
+#
+# Set vertical cell alignment. This is required by the set_properties() method
+# to differentiate between the vertical and horizontal properties.
+#
+sub set_valign {
+
+ my $self = shift;
+ $self->set_align(@_);
+}
+
+
+###############################################################################
+#
+# set_center_across()
+#
+# Implements the Excel5 style "merge".
+#
+sub set_center_across {
+
+ my $self = shift;
+
+ $self->set_text_h_align(6);
+}
+
+
+###############################################################################
+#
+# set_merge()
+#
+# This was the way to implement a merge in Excel5. However it should have been
+# called "center_across" and not "merge".
+# This is now deprecated. Use set_center_across() or better merge_range().
+#
+#
+sub set_merge {
+
+ my $self = shift;
+
+ $self->set_text_h_align(6);
+}
+
+
+###############################################################################
+#
+# set_bold()
+#
+# Bold has a range 0x64..0x3E8.
+# 0x190 is normal. 0x2BC is bold. So is an excessive use of AUTOLOAD.
+#
+sub set_bold {
+
+ my $self = shift;
+ my $weight = $_[0];
+
+ $weight = 0x2BC if not defined $weight; # Bold text
+ $weight = 0x2BC if $weight == 1; # Bold text
+ $weight = 0x190 if $weight == 0; # Normal text
+ $weight = 0x190 if $weight < 0x064; # Lower bound
+ $weight = 0x190 if $weight > 0x3E8; # Upper bound
+
+ $self->{_bold} = $weight;
+}
+
+
+###############################################################################
+#
+# set_border($style)
+#
+# Set cells borders to the same style
+#
+sub set_border {
+
+ my $self = shift;
+ my $style = $_[0];
+
+ $self->set_bottom($style);
+ $self->set_top($style);
+ $self->set_left($style);
+ $self->set_right($style);
+}
+
+
+###############################################################################
+#
+# set_border_color($color)
+#
+# Set cells border to the same color
+#
+sub set_border_color {
+
+ my $self = shift;
+ my $color = $_[0];
+
+ $self->set_bottom_color($color);
+ $self->set_top_color($color);
+ $self->set_left_color($color);
+ $self->set_right_color($color);
+}
+
+
+###############################################################################
+#
+# set_rotation($angle)
+#
+# Set the rotation angle of the text. An alignment property.
+#
+sub set_rotation {
+
+ my $self = shift;
+ my $rotation = $_[0];
+
+ # Argument should be a number
+ return if $rotation !~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/;
+
+ # The arg type can be a double but the Excel dialog only allows integers.
+ $rotation = int $rotation;
+
+ if ($rotation == 270) {
+ $rotation = 255;
+ }
+ elsif ($rotation >= -90 or $rotation <= 90) {
+ $rotation = -$rotation +90 if $rotation < 0;
+ }
+ else {
+ carp "Rotation $rotation outside range: -90 <= angle <= 90";
+ $rotation = 0;
+ }
+
+ $self->{_rotation} = $rotation;
+}
+
+
+###############################################################################
+#
+# set_properties()
+#
+# Convert hashes of properties to method calls.
+#
+sub set_properties {
+
+ my $self = shift;
+
+ my %properties = @_; # Merge multiple hashes into one
+
+ while (my($key, $value) = each(%properties)) {
+
+ # Strip leading "-" from Tk style properties e.g. -color => 'red'.
+ $key =~ s/^-//;
+
+
+ # Make sure method names are alphanumeric characters only, in case
+ # tainted data is passed to the eval().
+ #
+ die "Unknown method: \$self->set_$key\n" if $key =~ /\W/;
+
+
+ # Evaling all $values as a strings gets around the problem of some
+ # numerical format strings being evaluated as numbers, for example
+ # "00000" for a zip code.
+ #
+ if (defined $value) {
+ eval "\$self->set_$key('$value')";
+ }
+ else {
+ eval "\$self->set_$key(undef)";
+ }
+
+ die $@ if $@; # Rethrow the eval error.
+ }
+}
+
+
+###############################################################################
+#
+# AUTOLOAD. Deus ex machina.
+#
+# Dynamically create set methods that aren't already defined.
+#
+sub AUTOLOAD {
+
+ my $self = shift;
+
+ # Ignore calls to DESTROY
+ return if $AUTOLOAD =~ /::DESTROY$/;
+
+ # Check for a valid method names, i.e. "set_xxx_yyy".
+ $AUTOLOAD =~ /.*::set(\w+)/ or die "Unknown method: $AUTOLOAD\n";
+
+ # Match the attribute, i.e. "_xxx_yyy".
+ my $attribute = $1;
+
+ # Check that the attribute exists
+ exists $self->{$attribute} or die "Unknown method: $AUTOLOAD\n";
+
+ # The attribute value
+ my $value;
+
+
+ # There are two types of set methods: set_property() and
+ # set_property_color(). When a method is AUTOLOADED we store a new anonymous
+ # sub in the appropriate slot in the symbol table. The speeds up subsequent
+ # calls to the same method.
+ #
+ no strict 'refs'; # To allow symbol table hackery
+
+ if ($AUTOLOAD =~ /.*::set\w+color$/) {
+ # For "set_property_color" methods
+ $value = _get_color($_[0]);
+
+ *{$AUTOLOAD} = sub {
+ my $self = shift;
+
+ $self->{$attribute} = _get_color($_[0]);
+ };
+ }
+ else {
+
+ $value = $_[0];
+ $value = 1 if not defined $value; # The default value is always 1
+
+ *{$AUTOLOAD} = sub {
+ my $self = shift;
+ my $value = shift;
+
+ $value = 1 if not defined $value;
+ $self->{$attribute} = $value;
+ };
+}
+
+
+ $self->{$attribute} = $value;
+}
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+Format - A class for defining Excel formatting.
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel
+
+=head1 DESCRIPTION
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Formula.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Formula.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Formula.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,1410 +1,1410 @@
-package Spreadsheet::WriteExcel::Formula;
-
-###############################################################################
-#
-# Formula - A class for generating Excel formulas.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-use Carp;
-
-
-
-
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Exporter);
-
-$VERSION = '2.04';
-
-###############################################################################
-#
-# Class data.
-#
-my $parser;
-my %ptg;
-my %functions;
-
-
-###############################################################################
-#
-# For debugging.
-#
-my $_debug = 0;
-
-
-###############################################################################
-#
-# new()
-#
-# Constructor
-#
-sub new {
-
- my $class = $_[0];
-
- my $self = {
- _byte_order => $_[1],
- _workbook => "",
- _ext_sheets => {},
- _ext_refs => {},
- _ext_ref_count => 0,
- };
-
- bless $self, $class;
- return $self;
-}
-
-
-###############################################################################
-#
-# _init_parser()
-#
-# There is a small overhead involved in generating the parser. Therefore, the
-# initialisation is delayed until a formula is required.
-# TODO: use a pre-compiled grammar.
-#
-# Porters take note, a recursive descent parser isn't mandatory. A future
-# version of this module may use a YACC based parser instead.
-#
-sub _init_parser {
-
- my $self = shift;
-
- # Delay loading Parse::RecDescent to reduce the module dependencies.
- eval { require Parse::RecDescent };
- die "The Parse::RecDescent module must be installed in order ".
- "to write an Excel formula\n" if $@;
-
- $self->_initialize_hashes();
-
- # The parsing grammar.
- #
- # TODO: Add support for international versions of Excel
- #
- $parser = Parse::RecDescent->new(<<'EndGrammar');
-
- expr: list
-
- # Match arg lists such as SUM(1,2, 3)
- list: <leftop: addition ',' addition>
- { [ $item[1], '_arg', scalar @{$item[1]} ] }
-
- addition: <leftop: multiplication add_op multiplication>
-
- # TODO: The add_op operators don't have equal precedence.
- add_op: add | sub | concat
- | eq | ne | le | ge | lt | gt # Order is important
-
- add: '+' { 'ptgAdd' }
- sub: '-' { 'ptgSub' }
- concat: '&' { 'ptgConcat' }
- eq: '=' { 'ptgEQ' }
- ne: '<>' { 'ptgNE' }
- le: '<=' { 'ptgLE' }
- ge: '>=' { 'ptgGE' }
- lt: '<' { 'ptgLT' }
- gt: '>' { 'ptgGT' }
-
-
- multiplication: <leftop: exponention mult_op exponention>
-
- mult_op: mult | div
- mult: '*' { 'ptgMul' }
- div: '/' { 'ptgDiv' }
-
- # Left associative (apparently)
- exponention: <leftop: factor exp_op factor>
-
- exp_op: '^' { 'ptgPower' }
-
- factor: number # Order is important
- | string
- | range2d
- | range3d
- | true
- | false
- | ref2d
- | ref3d
- | function
- | '(' expr ')' { [$item[2], 'ptgParen'] }
-
- # Match a string.
- # Regex by merlyn. See http://www.perlmonks.org/index.pl?node_id=330280
- #
- string: /"([^"]|"")*"/ #" For editors
- { [ '_str', $item[1]] }
-
- # Match float or integer
- number: /([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?/
- { ['_num', $item[1]] }
-
- # Note: The highest column values is IV. The following regexes match
- # up to IZ. Out of range values are caught in the code.
- #
- # Note: sheetnames with whitespace, commas, or parentheses must be in
- # single quotes. Applies to ref3d and range3d
- #
-
- # Match A1, $A1, A$1 or $A$1.
- ref2d: /\$?[A-I]?[A-Z]\$?\d+/
- { ['_ref2d', $item[1]] }
-
- # Match an external sheet reference: Sheet1!A1 or 'Sheet (1)'!A1
- ref3d: /[^!(,]+!\$?[A-I]?[A-Z]\$?\d+/
- { ['_ref3d', $item[1]] }
- | /'[^']+'!\$?[A-I]?[A-Z]\$?\d+/
- { ['_ref3d', $item[1]] }
-
- # Match A1:C5, $A1:$C5 or A:C etc.
- range2d: /\$?[A-I]?[A-Z]\$?(\d+)?:\$?[A-I]?[A-Z]\$?(\d+)?/
- { ['_range2d', $item[1]] }
-
- # Match an external sheet range. 'Sheet 1:Sheet 2'!B2:C5
- range3d: /[^!(,]+!\$?[A-I]?[A-Z]\$?(\d+)?:\$?[A-I]?[A-Z]\$?(\d+)?/
- { ['_range3d', $item[1]] }
- | /'[^']+'!\$?[A-I]?[A-Z]\$?(\d+)?:\$?[A-I]?[A-Z]\$?(\d+)?/
- { ['_range3d', $item[1]] }
-
- # Match a function name.
- function: /[A-Z0-9À-Ü_.]+/ '()'
- { ['_func', $item[1]] }
- | /[A-Z0-9À-Ü_.]+/ '(' expr ')'
- { ['_class', $item[1], $item[3], '_func', $item[1]] }
- | /[A-Z0-9À-Ü_.]+/ '(' list ')'
- { ['_class', $item[1], $item[3], '_func', $item[1]] }
-
- # Boolean values.
- true: 'TRUE' { [ 'ptgBool', 1 ] }
-
- false: 'FALSE' { [ 'ptgBool', 0 ] }
-
-EndGrammar
-
-print "Init_parser.\n\n" if $_debug;
-}
-
-
-
-###############################################################################
-#
-# parse_formula()
-#
-# Takes a textual description of a formula and returns a RPN encoded byte
-# string.
-#
-sub parse_formula {
-
- my $self= shift;
-
- # Initialise the parser if this is the first call
- $self->_init_parser() if not defined $parser;
-
- my $formula = shift @_;
- my $tokens;
-
- print $formula, "\n" if $_debug;
-
- # Build the parse tree for the formula
- my $parsetree =$parser->expr($formula);
-
- # Check if parsing worked.
- if (defined $parsetree) {
- my @tokens = $self->_reverse_tree(@$parsetree);
-
- # Add a volatile token if the formula contains a volatile function.
- # This must be the first token in the list
- #
- unshift @tokens, '_vol' if $self->_check_volatile(@tokens);
-
- # The return value depends on which Worksheet.pm method is the caller
- if (wantarray) {
- # Parse formula to see if it throws any errors and then
- # return raw tokens to Worksheet::store_formula()
- #
- $self->parse_tokens(@tokens);
- return @tokens;
- }
- else{
- # Return byte stream to Worksheet::write_formula()
- return $self->parse_tokens(@tokens);
- }
- }
- else {
- die "Couldn't parse formula: =$formula\n";
- }
-}
-
-
-###############################################################################
-#
-# parse_tokens()
-#
-# Convert each token or token pair to its Excel 'ptg' equivalent.
-#
-sub parse_tokens {
-
- my $self = shift;
- my $parse_str = '';
- my $last_type = '';
- my $modifier = '';
- my $num_args = 0;
- my $class = 0;
- my @class = 1;
- my @tokens = @_;
-
-
- # A note about the class modifiers used below. In general the class,
- # "reference" or "value", of a function is applied to all of its operands.
- # However, in certain circumstances the operands can have mixed classes,
- # e.g. =VLOOKUP with external references. These will eventually be dealt
- # with by the parser. However, as a workaround the class type of a token
- # can be changed via the repeat_formula interface. Thus, a _ref2d token can
- # be changed by the user to _ref2dA or _ref2dR to change its token class.
- #
- while (@_) {
- my $token = shift @_;
-
- if ($token eq '_arg') {
- $num_args = shift @_;
- }
- elsif ($token eq '_class') {
- $token = shift @_;
- $class = $functions{$token}[2];
- # If $class is undef then it means that the function isn't valid.
- die "Unknown function $token() in formula\n" unless defined $class;
- push @class, $class;
- }
- elsif ($token eq '_vol') {
- $parse_str .= $self->_convert_volatile();
- }
- elsif ($token eq 'ptgBool') {
- $token = shift @_;
- $parse_str .= $self->_convert_bool($token);
- }
- elsif ($token eq '_num') {
- $token = shift @_;
- $parse_str .= $self->_convert_number($token);
- }
- elsif ($token eq '_str') {
- $token = shift @_;
- $parse_str .= $self->_convert_string($token);
- }
- elsif ($token =~ /^_ref2d/) {
- ($modifier = $token) =~ s/_ref2d//;
- $class = $class[-1];
- $class = 0 if $modifier eq 'R';
- $class = 1 if $modifier eq 'V';
- $token = shift @_;
- $parse_str .= $self->_convert_ref2d($token, $class);
- }
- elsif ($token =~ /^_ref3d/) {
- ($modifier = $token) =~ s/_ref3d//;
- $class = $class[-1];
- $class = 0 if $modifier eq 'R';
- $class = 1 if $modifier eq 'V';
- $token = shift @_;
- $parse_str .= $self->_convert_ref3d($token, $class);
- }
- elsif ($token =~ /^_range2d/) {
- ($modifier = $token) =~ s/_range2d//;
- $class = $class[-1];
- $class = 0 if $modifier eq 'R';
- $class = 1 if $modifier eq 'V';
- $token = shift @_;
- $parse_str .= $self->_convert_range2d($token, $class);
- }
- elsif ($token =~ /^_range3d/) {
- ($modifier = $token) =~ s/_range3d//;
- $class = $class[-1];
- $class = 0 if $modifier eq 'R';
- $class = 1 if $modifier eq 'V';
- $token = shift @_;
- $parse_str .= $self->_convert_range3d($token, $class);
- }
- elsif ($token eq '_func') {
- $token = shift @_;
- $parse_str .= $self->_convert_function($token, $num_args);
- pop @class;
- $num_args = 0; # Reset after use
- }
- elsif (exists $ptg{$token}) {
- $parse_str .= pack("C", $ptg{$token});
- }
- else {
- # Unrecognised token
- return undef;
- }
- }
-
-
- if ($_debug) {
- print join(" ", map { sprintf "%02X", $_ } unpack("C*",$parse_str));
- print "\n\n";
- print join(" ", @tokens), "\n\n";
- }
-
- return $parse_str;
-}
-
-
-###############################################################################
-#
-# _reverse_tree()
-#
-# This function descends recursively through the parse tree. At each level it
-# swaps the order of an operator followed by an operand.
-# For example, 1+2*3 would be converted in the following sequence:
-# 1 + 2 * 3
-# 1 + (2 * 3)
-# 1 + (2 3 *)
-# 1 (2 3 *) +
-# 1 2 3 * +
-#
-sub _reverse_tree
-{
- my $self = shift;
-
- my @tokens;
- my @expression = @_;
- my @stack;
-
- while (@expression) {
- my $token = shift @expression;
-
- # If the token is an operator swap it with the following operand
- if ( $token eq 'ptgAdd' ||
- $token eq 'ptgSub' ||
- $token eq 'ptgConcat' ||
- $token eq 'ptgMul' ||
- $token eq 'ptgDiv' ||
- $token eq 'ptgPower' ||
- $token eq 'ptgEQ' ||
- $token eq 'ptgNE' ||
- $token eq 'ptgLE' ||
- $token eq 'ptgGE' ||
- $token eq 'ptgLT' ||
- $token eq 'ptgGT')
- {
- my $operand = shift @expression;
- push @stack, $operand;
- }
-
- push @stack, $token;
- }
-
- # Recurse through the parse tree
- foreach my $token (@stack) {
- if (ref($token)) {
- push @tokens, $self->_reverse_tree(@$token);
- }
- else {
- push @tokens, $token;
- }
- }
-
- return @tokens;
-}
-
-
-###############################################################################
-#
-# _check_volatile()
-#
-# Check if the formula contains a volatile function, i.e. a function that must
-# be recalculated each time a cell is updated. These formulas require a ptgAttr
-# with the volatile flag set as the first token in the parsed expression.
-#
-# Examples of volatile functions: RAND(), NOW(), TODAY()
-#
-sub _check_volatile {
-
- my $self = shift;
- my @tokens = @_;
- my $volatile = 0;
-
- for my $i (0.. at tokens-1) {
- # If the next token is a function check if it is volatile.
- if ($tokens[$i] eq '_func' and $functions{$tokens[$i+1]}[3]) {
- $volatile = 1;
- last;
- }
- }
-
- return $volatile;
-}
-
-
-###############################################################################
-#
-# _convert_volatile()
-#
-# Convert _vol to a ptgAttr tag formatted to indicate that the formula contains
-# a volatile function. See _check_volatile()
-#
-sub _convert_volatile {
-
- my $self = shift;
-
- # Set bitFattrSemi flag to indicate volatile function, "w" is set to zero.
- return pack("CCv", $ptg{ptgAttr}, 0x1, 0x0);
-}
-
-
-###############################################################################
-#
-# _convert_bool()
-#
-# Convert a boolean token to ptgBool
-#
-sub _convert_bool {
-
- my $self = shift;
- my $bool = shift;
-
- return pack("CC", $ptg{ptgBool}, $bool);
-}
-
-
-###############################################################################
-#
-# _convert_number()
-#
-# Convert a number token to ptgInt or ptgNum
-#
-sub _convert_number {
-
- my $self = shift;
- my $num = shift;
-
- # Integer in the range 0..2**16-1
- if (($num =~ /^\d+$/) && ($num <= 65535)) {
- return pack("Cv", $ptg{ptgInt}, $num);
- }
- else { # A float
- $num = pack("d", $num);
- $num = reverse $num if $self->{_byte_order};
- return pack("C", $ptg{ptgNum}) . $num;
- }
-}
-
-
-###############################################################################
-#
-# _convert_string()
-#
-# Convert a string to a ptg Str.
-#
-sub _convert_string {
-
- my $self = shift;
- my $str = shift;
- my $encoding = 0;
-
- $str =~ s/^"//; # Remove leading "
- $str =~ s/"$//; # Remove trailing "
- $str =~ s/""/"/g; # Substitute Excel's escaped double quote "" for "
-
- my $length = length($str);
-
- # TODO string length
- die "String in formula has more than 255 chars\n" if $length > 255;
-
- return pack("CCC", $ptg{ptgStr}, $length, $encoding) . $str;
-}
-
-
-###############################################################################
-#
-# _convert_ref2d()
-#
-# Convert an Excel reference such as A1, $B2, C$3 or $D$4 to a ptgRefV.
-#
-sub _convert_ref2d {
-
- my $self = shift;
- my $cell = shift;
- my $class = shift;
- my $ptgRef;
-
- # Convert the cell reference
- my ($row, $col) = $self->_cell_to_packed_rowcol($cell);
-
- # The ptg value depends on the class of the ptg.
- if ($class == 0) {
- $ptgRef = pack("C", $ptg{ptgRef});
- }
- elsif ($class == 1) {
- $ptgRef = pack("C", $ptg{ptgRefV});
- }
- elsif ($class == 2) {
- $ptgRef = pack("C", $ptg{ptgRefA});
- }
- else{
- die "Unknown function class in formula\n";
- }
-
- return $ptgRef . $row . $col;
-}
-
-
-###############################################################################
-#
-# _convert_ref3d
-#
-# Convert an Excel 3d reference such as "Sheet1!A1" or "Sheet1:Sheet2!A1" to a
-# ptgRef3dV.
-#
-sub _convert_ref3d {
-
- my $self = shift;
- my $token = shift;
- my $class = shift;
- my $ptgRef;
-
- # Split the ref at the ! symbol
- my ($ext_ref, $cell) = split '!', $token;
-
- # Convert the external reference part
- $ext_ref = $self->_pack_ext_ref($ext_ref);
-
- # Convert the cell reference part
- my ($row, $col) = $self->_cell_to_packed_rowcol($cell);
-
- # The ptg value depends on the class of the ptg.
- if ($class == 0) {
- $ptgRef = pack("C", $ptg{ptgRef3d});
- }
- elsif ($class == 1) {
- $ptgRef = pack("C", $ptg{ptgRef3dV});
- }
- elsif ($class == 2) {
- $ptgRef = pack("C", $ptg{ptgRef3dA});
- }
- else{
- die "Unknown function class in formula\n";
- }
-
- return $ptgRef . $ext_ref. $row . $col;
-}
-
-
-###############################################################################
-#
-# _convert_range2d()
-#
-# Convert an Excel range such as A1:D4 or A:D to a ptgRefV.
-#
-sub _convert_range2d {
-
- my $self = shift;
- my $range = shift;
- my $class = shift;
- my $ptgArea;
-
- # Split the range into 2 cell refs
- my ($cell1, $cell2) = split ':', $range;
-
- # A range such as A:D is equivalent to A1:D65536, so add rows as required
- $cell1 .= '1' if $cell1 !~ /\d/;
- $cell2 .= '65536' if $cell2 !~ /\d/;
-
- # Convert the cell references
- my ($row1, $col1) = $self->_cell_to_packed_rowcol($cell1);
- my ($row2, $col2) = $self->_cell_to_packed_rowcol($cell2);
-
- # The ptg value depends on the class of the ptg.
- if ($class == 0) {
- $ptgArea = pack("C", $ptg{ptgArea});
- }
- elsif ($class == 1) {
- $ptgArea = pack("C", $ptg{ptgAreaV});
- }
- elsif ($class == 2) {
- $ptgArea = pack("C", $ptg{ptgAreaA});
- }
- else{
- die "Unknown function class in formula\n";
- }
-
- return $ptgArea . $row1 . $row2 . $col1. $col2;
-}
-
-
-###############################################################################
-#
-# _convert_range3d
-#
-# Convert an Excel 3d range such as "Sheet1!A1:D4" or "Sheet1:Sheet2!A1:D4" to
-# a ptgArea3dV.
-#
-sub _convert_range3d {
-
- my $self = shift;
- my $token = shift;
- my $class = shift;
- my $ptgArea;
-
- # Split the ref at the ! symbol
- my ($ext_ref, $range) = split '!', $token;
-
- # Convert the external reference part
- $ext_ref = $self->_pack_ext_ref($ext_ref);
-
- # Split the range into 2 cell refs
- my ($cell1, $cell2) = split ':', $range;
-
- # A range such as A:D is equivalent to A1:D65536, so add rows as required
- $cell1 .= '1' if $cell1 !~ /\d/;
- $cell2 .= '65536' if $cell2 !~ /\d/;
-
- # Convert the cell references
- my ($row1, $col1) = $self->_cell_to_packed_rowcol($cell1);
- my ($row2, $col2) = $self->_cell_to_packed_rowcol($cell2);
-
- # The ptg value depends on the class of the ptg.
- if ($class == 0) {
- $ptgArea = pack("C", $ptg{ptgArea3d});
- }
- elsif ($class == 1) {
- $ptgArea = pack("C", $ptg{ptgArea3dV});
- }
- elsif ($class == 2) {
- $ptgArea = pack("C", $ptg{ptgArea3dA});
- }
- else{
- die "Unknown function class in formula\n";
- }
-
- return $ptgArea . $ext_ref . $row1 . $row2 . $col1. $col2;
-}
-
-
-###############################################################################
-#
-# _pack_ext_ref()
-#
-# Convert the sheet name part of an external reference, for example "Sheet1" or
-# "Sheet1:Sheet2", to a packed structure.
-#
-sub _pack_ext_ref {
-
- my $self = shift;
- my $ext_ref = shift;
- my $sheet1;
- my $sheet2;
-
- $ext_ref =~ s/^'//; # Remove leading ' if any.
- $ext_ref =~ s/'$//; # Remove trailing ' if any.
-
- # Check if there is a sheet range eg., Sheet1:Sheet2.
- if ($ext_ref =~ /:/) {
- ($sheet1, $sheet2) = split ':', $ext_ref;
-
- $sheet1 = $self->_get_sheet_index($sheet1);
- $sheet2 = $self->_get_sheet_index($sheet2);
-
- # Reverse max and min sheet numbers if necessary
- if ($sheet1 > $sheet2) {
- ($sheet1, $sheet2) = ($sheet2, $sheet1);
- }
- }
- else {
- # Single sheet name only.
- ($sheet1, $sheet2) = ($ext_ref, $ext_ref);
-
- $sheet1 = $self->_get_sheet_index($sheet1);
- $sheet2 = $sheet1;
- }
-
- my $key = "$sheet1:$sheet2";
- my $index;
-
- if (exists $self->{_ext_refs}->{$key}) {
- $index = $self->{_ext_refs}->{$key};
- }
- else {
- $index = $self->{_ext_ref_count};
- $self->{_ext_refs}->{$key} = $index;
- $self->{_ext_ref_count}++;
- }
-
- return pack("v",$index);
-}
-
-
-###############################################################################
-#
-# _get_sheet_index()
-#
-# Look up the index that corresponds to an external sheet name. The hash of
-# sheet names is updated by the add_worksheet() method of the Workbook class.
-#
-sub _get_sheet_index {
-
- my $self = shift;
- my $sheet_name = shift;
-
- if (not exists $self->{_ext_sheets}->{$sheet_name}) {
- die "Unknown sheet name $sheet_name in formula\n";
- }
- else {
- return $self->{_ext_sheets}->{$sheet_name};
- }
-}
-
-
-###############################################################################
-#
-# set_ext_sheets()
-#
-# This semi-public method is used to update the hash of sheet names. It is
-# updated by the add_worksheet() method of the Workbook class.
-#
-sub set_ext_sheets {
-
- my $self = shift;
- my $worksheet = shift;
- my $index = shift;
-
- #my $ref = "$index:$index";
-
- # The _ext_sheets hash is used to translate between worksheet names
- # and their index
- $self->{_ext_sheets}->{$worksheet} = $index;
-
-
- # 2D sheet refs such as '=Sheet1:Sheet2!A1' can only be added after all
- # worksheets have been added.
- #return 0 if $index < $self->{_ext_ref_count}; TODO
-
-
- # The _ext_refs hash is used to correlate the external references used in
- # formulas with the index stored in the Workbook EXTERNSHEET record.
- #$self->{_ext_refs}->{$ref} = $index;
- #$self->{_ext_ref_count}++;
-
- # No errors
- #return 1;
-}
-
-
-###############################################################################
-#
-# get_ext_sheets()
-#
-# This semi-public method is used to update the hash of sheet names. It is
-# updated by the add_worksheet() method of the Workbook class.
-#
-# TODO
-#
-sub get_ext_sheets {
-
- my $self = shift;
-
- # TODO
- my %refs = %{$self->{_ext_refs}};
- return %refs;
-
- #my @refs = sort {$refs{$a} <=> $refs{$b}} keys %refs;
-
- #foreach my $ref (@refs) {
- # $ref = [split /:/, $ref];
- #}
-
- #return @refs;
-}
-
-
-###############################################################################
-#
-# get_ext_ref_count()
-#
-# TODO This semi-public method is used to update the hash of sheet names. It is
-# updated by the add_worksheet() method of the Workbook class.
-#
-sub get_ext_ref_count {
-
- my $self = shift;
-
- return $self->{_ext_ref_count};
-}
-
-
-###############################################################################
-#
-# _convert_function()
-#
-# Convert a function to a ptgFunc or ptgFuncVarV depending on the number of
-# args that it takes.
-#
-sub _convert_function {
-
- my $self = shift;
- my $token = shift;
- my $num_args = shift;
-
- die "Unknown function $token() in formula\n"
- unless defined $functions{$token}[0];
-
- my $args = $functions{$token}[1];
-
- # Fixed number of args eg. TIME($i,$j,$k).
- if ($args >= 0) {
- # Check that the number of args is valid.
- if ($args != $num_args) {
- die "Incorrect number of arguments for $token() in formula\n";
- }
- else {
- return pack("Cv", $ptg{ptgFuncV}, $functions{$token}[0]);
- }
- }
-
- # Variable number of args eg. SUM($i,$j,$k, ..).
- if ($args == -1) {
- return pack "CCv", $ptg{ptgFuncVarV}, $num_args, $functions{$token}[0];
- }
-}
-
-
-###############################################################################
-#
-# _cell_to_rowcol($cell_ref)
-#
-# Convert an Excel cell reference such as A1 or $B2 or C$3 or $D$4 to a zero
-# indexed row and column number. Also returns two boolean values to indicate
-# whether the row or column are relative references.
-# TODO use function in Utility.pm
-#
-sub _cell_to_rowcol {
-
- my $self = shift;
- my $cell = shift;
-
- $cell =~ /(\$?)([A-I]?[A-Z])(\$?)(\d+)/;
-
- my $col_rel = $1 eq "" ? 1 : 0;
- my $col = $2;
- my $row_rel = $3 eq "" ? 1 : 0;
- my $row = $4;
-
- # Convert base26 column string to a number.
- # All your Base are belong to us.
- my @chars = split //, $col;
- my $expn = 0;
- $col = 0;
-
- while (@chars) {
- my $char = pop(@chars); # LS char first
- $col += (ord($char) - ord('A') + 1) * (26**$expn);
- $expn++;
- }
-
- # Convert 1-index to zero-index
- $row--;
- $col--;
-
- return $row, $col, $row_rel, $col_rel;
-}
-
-
-###############################################################################
-#
-# _cell_to_packed_rowcol($row, $col, $row_rel, $col_rel)
-#
-# pack() row and column into the required 3 byte format.
-#
-sub _cell_to_packed_rowcol {
-
- use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
-
- my $self = shift;
- my $cell = shift;
-
- my ($row, $col, $row_rel, $col_rel) = $self->_cell_to_rowcol($cell);
-
- die "Column $cell greater than IV in formula\n" if $col >= 256;
- die "Row $cell greater than 65536 in formula\n" if $row >= 65536;
-
- # Set the high bits to indicate if row or col are relative.
- $col |= $col_rel << 14;
- $col |= $row_rel << 15;
-
- $row = pack('v', $row);
- $col = pack('v', $col);
-
- return ($row, $col);
-}
-
-
-###############################################################################
-#
-# _initialize_hashes()
-#
-sub _initialize_hashes {
-
- # The Excel ptg indices
- %ptg = (
- 'ptgExp' => 0x01,
- 'ptgTbl' => 0x02,
- 'ptgAdd' => 0x03,
- 'ptgSub' => 0x04,
- 'ptgMul' => 0x05,
- 'ptgDiv' => 0x06,
- 'ptgPower' => 0x07,
- 'ptgConcat' => 0x08,
- 'ptgLT' => 0x09,
- 'ptgLE' => 0x0A,
- 'ptgEQ' => 0x0B,
- 'ptgGE' => 0x0C,
- 'ptgGT' => 0x0D,
- 'ptgNE' => 0x0E,
- 'ptgIsect' => 0x0F,
- 'ptgUnion' => 0x10,
- 'ptgRange' => 0x11,
- 'ptgUplus' => 0x12,
- 'ptgUminus' => 0x13,
- 'ptgPercent' => 0x14,
- 'ptgParen' => 0x15,
- 'ptgMissArg' => 0x16,
- 'ptgStr' => 0x17,
- 'ptgAttr' => 0x19,
- 'ptgSheet' => 0x1A,
- 'ptgEndSheet' => 0x1B,
- 'ptgErr' => 0x1C,
- 'ptgBool' => 0x1D,
- 'ptgInt' => 0x1E,
- 'ptgNum' => 0x1F,
- 'ptgArray' => 0x20,
- 'ptgFunc' => 0x21,
- 'ptgFuncVar' => 0x22,
- 'ptgName' => 0x23,
- 'ptgRef' => 0x24,
- 'ptgArea' => 0x25,
- 'ptgMemArea' => 0x26,
- 'ptgMemErr' => 0x27,
- 'ptgMemNoMem' => 0x28,
- 'ptgMemFunc' => 0x29,
- 'ptgRefErr' => 0x2A,
- 'ptgAreaErr' => 0x2B,
- 'ptgRefN' => 0x2C,
- 'ptgAreaN' => 0x2D,
- 'ptgMemAreaN' => 0x2E,
- 'ptgMemNoMemN' => 0x2F,
- 'ptgNameX' => 0x39,
- 'ptgRef3d' => 0x3A,
- 'ptgArea3d' => 0x3B,
- 'ptgRefErr3d' => 0x3C,
- 'ptgAreaErr3d' => 0x3D,
- 'ptgArrayV' => 0x40,
- 'ptgFuncV' => 0x41,
- 'ptgFuncVarV' => 0x42,
- 'ptgNameV' => 0x43,
- 'ptgRefV' => 0x44,
- 'ptgAreaV' => 0x45,
- 'ptgMemAreaV' => 0x46,
- 'ptgMemErrV' => 0x47,
- 'ptgMemNoMemV' => 0x48,
- 'ptgMemFuncV' => 0x49,
- 'ptgRefErrV' => 0x4A,
- 'ptgAreaErrV' => 0x4B,
- 'ptgRefNV' => 0x4C,
- 'ptgAreaNV' => 0x4D,
- 'ptgMemAreaNV' => 0x4E,
- 'ptgMemNoMemN' => 0x4F,
- 'ptgFuncCEV' => 0x58,
- 'ptgNameXV' => 0x59,
- 'ptgRef3dV' => 0x5A,
- 'ptgArea3dV' => 0x5B,
- 'ptgRefErr3dV' => 0x5C,
- 'ptgAreaErr3d' => 0x5D,
- 'ptgArrayA' => 0x60,
- 'ptgFuncA' => 0x61,
- 'ptgFuncVarA' => 0x62,
- 'ptgNameA' => 0x63,
- 'ptgRefA' => 0x64,
- 'ptgAreaA' => 0x65,
- 'ptgMemAreaA' => 0x66,
- 'ptgMemErrA' => 0x67,
- 'ptgMemNoMemA' => 0x68,
- 'ptgMemFuncA' => 0x69,
- 'ptgRefErrA' => 0x6A,
- 'ptgAreaErrA' => 0x6B,
- 'ptgRefNA' => 0x6C,
- 'ptgAreaNA' => 0x6D,
- 'ptgMemAreaNA' => 0x6E,
- 'ptgMemNoMemN' => 0x6F,
- 'ptgFuncCEA' => 0x78,
- 'ptgNameXA' => 0x79,
- 'ptgRef3dA' => 0x7A,
- 'ptgArea3dA' => 0x7B,
- 'ptgRefErr3dA' => 0x7C,
- 'ptgAreaErr3d' => 0x7D,
- );
-
- # Thanks to Michael Meeks and Gnumeric for the initial arg values.
- #
- # The following hash was generated by "function_locale.pl" in the distro.
- # Refer to function_locale.pl for non-English function names.
- #
- # The array elements are as follow:
- # ptg: The Excel function ptg code.
- # args: The number of arguments that the function takes:
- # >=0 is a fixed number of arguments.
- # -1 is a variable number of arguments.
- # class: The reference, value or array class of the function args.
- # vol: The function is volatile.
- #
- %functions = (
- # ptg args class vol
- 'COUNT' => [ 0, -1, 0, 0 ],
- 'IF' => [ 1, -1, 1, 0 ],
- 'ISNA' => [ 2, 1, 1, 0 ],
- 'ISERROR' => [ 3, 1, 1, 0 ],
- 'SUM' => [ 4, -1, 0, 0 ],
- 'AVERAGE' => [ 5, -1, 0, 0 ],
- 'MIN' => [ 6, -1, 0, 0 ],
- 'MAX' => [ 7, -1, 0, 0 ],
- 'ROW' => [ 8, -1, 0, 0 ],
- 'COLUMN' => [ 9, -1, 0, 0 ],
- 'NA' => [ 10, 0, 0, 0 ],
- 'NPV' => [ 11, -1, 1, 0 ],
- 'STDEV' => [ 12, -1, 0, 0 ],
- 'DOLLAR' => [ 13, -1, 1, 0 ],
- 'FIXED' => [ 14, -1, 1, 0 ],
- 'SIN' => [ 15, 1, 1, 0 ],
- 'COS' => [ 16, 1, 1, 0 ],
- 'TAN' => [ 17, 1, 1, 0 ],
- 'ATAN' => [ 18, 1, 1, 0 ],
- 'PI' => [ 19, 0, 1, 0 ],
- 'SQRT' => [ 20, 1, 1, 0 ],
- 'EXP' => [ 21, 1, 1, 0 ],
- 'LN' => [ 22, 1, 1, 0 ],
- 'LOG10' => [ 23, 1, 1, 0 ],
- 'ABS' => [ 24, 1, 1, 0 ],
- 'INT' => [ 25, 1, 1, 0 ],
- 'SIGN' => [ 26, 1, 1, 0 ],
- 'ROUND' => [ 27, 2, 1, 0 ],
- 'LOOKUP' => [ 28, -1, 0, 0 ],
- 'INDEX' => [ 29, -1, 0, 1 ],
- 'REPT' => [ 30, 2, 1, 0 ],
- 'MID' => [ 31, 3, 1, 0 ],
- 'LEN' => [ 32, 1, 1, 0 ],
- 'VALUE' => [ 33, 1, 1, 0 ],
- 'TRUE' => [ 34, 0, 1, 0 ],
- 'FALSE' => [ 35, 0, 1, 0 ],
- 'AND' => [ 36, -1, 1, 0 ],
- 'OR' => [ 37, -1, 1, 0 ],
- 'NOT' => [ 38, 1, 1, 0 ],
- 'MOD' => [ 39, 2, 1, 0 ],
- 'DCOUNT' => [ 40, 3, 0, 0 ],
- 'DSUM' => [ 41, 3, 0, 0 ],
- 'DAVERAGE' => [ 42, 3, 0, 0 ],
- 'DMIN' => [ 43, 3, 0, 0 ],
- 'DMAX' => [ 44, 3, 0, 0 ],
- 'DSTDEV' => [ 45, 3, 0, 0 ],
- 'VAR' => [ 46, -1, 0, 0 ],
- 'DVAR' => [ 47, 3, 0, 0 ],
- 'TEXT' => [ 48, 2, 1, 0 ],
- 'LINEST' => [ 49, -1, 0, 0 ],
- 'TREND' => [ 50, -1, 0, 0 ],
- 'LOGEST' => [ 51, -1, 0, 0 ],
- 'GROWTH' => [ 52, -1, 0, 0 ],
- 'PV' => [ 56, -1, 1, 0 ],
- 'FV' => [ 57, -1, 1, 0 ],
- 'NPER' => [ 58, -1, 1, 0 ],
- 'PMT' => [ 59, -1, 1, 0 ],
- 'RATE' => [ 60, -1, 1, 0 ],
- 'MIRR' => [ 61, 3, 0, 0 ],
- 'IRR' => [ 62, -1, 0, 0 ],
- 'RAND' => [ 63, 0, 1, 1 ],
- 'MATCH' => [ 64, -1, 0, 0 ],
- 'DATE' => [ 65, 3, 1, 0 ],
- 'TIME' => [ 66, 3, 1, 0 ],
- 'DAY' => [ 67, 1, 1, 0 ],
- 'MONTH' => [ 68, 1, 1, 0 ],
- 'YEAR' => [ 69, 1, 1, 0 ],
- 'WEEKDAY' => [ 70, -1, 1, 0 ],
- 'HOUR' => [ 71, 1, 1, 0 ],
- 'MINUTE' => [ 72, 1, 1, 0 ],
- 'SECOND' => [ 73, 1, 1, 0 ],
- 'NOW' => [ 74, 0, 1, 1 ],
- 'AREAS' => [ 75, 1, 0, 1 ],
- 'ROWS' => [ 76, 1, 0, 1 ],
- 'COLUMNS' => [ 77, 1, 0, 1 ],
- 'OFFSET' => [ 78, -1, 0, 1 ],
- 'SEARCH' => [ 82, -1, 1, 0 ],
- 'TRANSPOSE' => [ 83, 1, 1, 0 ],
- 'TYPE' => [ 86, 1, 1, 0 ],
- 'ATAN2' => [ 97, 2, 1, 0 ],
- 'ASIN' => [ 98, 1, 1, 0 ],
- 'ACOS' => [ 99, 1, 1, 0 ],
- 'CHOOSE' => [ 100, -1, 1, 0 ],
- 'HLOOKUP' => [ 101, -1, 0, 0 ],
- 'VLOOKUP' => [ 102, -1, 0, 0 ],
- 'ISREF' => [ 105, 1, 0, 0 ],
- 'LOG' => [ 109, -1, 1, 0 ],
- 'CHAR' => [ 111, 1, 1, 0 ],
- 'LOWER' => [ 112, 1, 1, 0 ],
- 'UPPER' => [ 113, 1, 1, 0 ],
- 'PROPER' => [ 114, 1, 1, 0 ],
- 'LEFT' => [ 115, -1, 1, 0 ],
- 'RIGHT' => [ 116, -1, 1, 0 ],
- 'EXACT' => [ 117, 2, 1, 0 ],
- 'TRIM' => [ 118, 1, 1, 0 ],
- 'REPLACE' => [ 119, 4, 1, 0 ],
- 'SUBSTITUTE' => [ 120, -1, 1, 0 ],
- 'CODE' => [ 121, 1, 1, 0 ],
- 'FIND' => [ 124, -1, 1, 0 ],
- 'CELL' => [ 125, -1, 0, 1 ],
- 'ISERR' => [ 126, 1, 1, 0 ],
- 'ISTEXT' => [ 127, 1, 1, 0 ],
- 'ISNUMBER' => [ 128, 1, 1, 0 ],
- 'ISBLANK' => [ 129, 1, 1, 0 ],
- 'T' => [ 130, 1, 0, 0 ],
- 'N' => [ 131, 1, 0, 0 ],
- 'DATEVALUE' => [ 140, 1, 1, 0 ],
- 'TIMEVALUE' => [ 141, 1, 1, 0 ],
- 'SLN' => [ 142, 3, 1, 0 ],
- 'SYD' => [ 143, 4, 1, 0 ],
- 'DDB' => [ 144, -1, 1, 0 ],
- 'INDIRECT' => [ 148, -1, 1, 1 ],
- 'CALL' => [ 150, -1, 1, 0 ],
- 'CLEAN' => [ 162, 1, 1, 0 ],
- 'MDETERM' => [ 163, 1, 2, 0 ],
- 'MINVERSE' => [ 164, 1, 2, 0 ],
- 'MMULT' => [ 165, 2, 2, 0 ],
- 'IPMT' => [ 167, -1, 1, 0 ],
- 'PPMT' => [ 168, -1, 1, 0 ],
- 'COUNTA' => [ 169, -1, 0, 0 ],
- 'PRODUCT' => [ 183, -1, 0, 0 ],
- 'FACT' => [ 184, 1, 1, 0 ],
- 'DPRODUCT' => [ 189, 3, 0, 0 ],
- 'ISNONTEXT' => [ 190, 1, 1, 0 ],
- 'STDEVP' => [ 193, -1, 0, 0 ],
- 'VARP' => [ 194, -1, 0, 0 ],
- 'DSTDEVP' => [ 195, 3, 0, 0 ],
- 'DVARP' => [ 196, 3, 0, 0 ],
- 'TRUNC' => [ 197, -1, 1, 0 ],
- 'ISLOGICAL' => [ 198, 1, 1, 0 ],
- 'DCOUNTA' => [ 199, 3, 0, 0 ],
- 'ROUNDUP' => [ 212, 2, 1, 0 ],
- 'ROUNDDOWN' => [ 213, 2, 1, 0 ],
- 'RANK' => [ 216, -1, 0, 0 ],
- 'ADDRESS' => [ 219, -1, 1, 0 ],
- 'DAYS360' => [ 220, -1, 1, 0 ],
- 'TODAY' => [ 221, 0, 1, 1 ],
- 'VDB' => [ 222, -1, 1, 0 ],
- 'MEDIAN' => [ 227, -1, 0, 0 ],
- 'SUMPRODUCT' => [ 228, -1, 2, 0 ],
- 'SINH' => [ 229, 1, 1, 0 ],
- 'COSH' => [ 230, 1, 1, 0 ],
- 'TANH' => [ 231, 1, 1, 0 ],
- 'ASINH' => [ 232, 1, 1, 0 ],
- 'ACOSH' => [ 233, 1, 1, 0 ],
- 'ATANH' => [ 234, 1, 1, 0 ],
- 'DGET' => [ 235, 3, 0, 0 ],
- 'INFO' => [ 244, 1, 1, 1 ],
- 'DB' => [ 247, -1, 1, 0 ],
- 'FREQUENCY' => [ 252, 2, 0, 0 ],
- 'ERROR.TYPE' => [ 261, 1, 1, 0 ],
- 'REGISTER.ID' => [ 267, -1, 1, 0 ],
- 'AVEDEV' => [ 269, -1, 0, 0 ],
- 'BETADIST' => [ 270, -1, 1, 0 ],
- 'GAMMALN' => [ 271, 1, 1, 0 ],
- 'BETAINV' => [ 272, -1, 1, 0 ],
- 'BINOMDIST' => [ 273, 4, 1, 0 ],
- 'CHIDIST' => [ 274, 2, 1, 0 ],
- 'CHIINV' => [ 275, 2, 1, 0 ],
- 'COMBIN' => [ 276, 2, 1, 0 ],
- 'CONFIDENCE' => [ 277, 3, 1, 0 ],
- 'CRITBINOM' => [ 278, 3, 1, 0 ],
- 'EVEN' => [ 279, 1, 1, 0 ],
- 'EXPONDIST' => [ 280, 3, 1, 0 ],
- 'FDIST' => [ 281, 3, 1, 0 ],
- 'FINV' => [ 282, 3, 1, 0 ],
- 'FISHER' => [ 283, 1, 1, 0 ],
- 'FISHERINV' => [ 284, 1, 1, 0 ],
- 'FLOOR' => [ 285, 2, 1, 0 ],
- 'GAMMADIST' => [ 286, 4, 1, 0 ],
- 'GAMMAINV' => [ 287, 3, 1, 0 ],
- 'CEILING' => [ 288, 2, 1, 0 ],
- 'HYPGEOMDIST' => [ 289, 4, 1, 0 ],
- 'LOGNORMDIST' => [ 290, 3, 1, 0 ],
- 'LOGINV' => [ 291, 3, 1, 0 ],
- 'NEGBINOMDIST' => [ 292, 3, 1, 0 ],
- 'NORMDIST' => [ 293, 4, 1, 0 ],
- 'NORMSDIST' => [ 294, 1, 1, 0 ],
- 'NORMINV' => [ 295, 3, 1, 0 ],
- 'NORMSINV' => [ 296, 1, 1, 0 ],
- 'STANDARDIZE' => [ 297, 3, 1, 0 ],
- 'ODD' => [ 298, 1, 1, 0 ],
- 'PERMUT' => [ 299, 2, 1, 0 ],
- 'POISSON' => [ 300, 3, 1, 0 ],
- 'TDIST' => [ 301, 3, 1, 0 ],
- 'WEIBULL' => [ 302, 4, 1, 0 ],
- 'SUMXMY2' => [ 303, 2, 2, 0 ],
- 'SUMX2MY2' => [ 304, 2, 2, 0 ],
- 'SUMX2PY2' => [ 305, 2, 2, 0 ],
- 'CHITEST' => [ 306, 2, 2, 0 ],
- 'CORREL' => [ 307, 2, 2, 0 ],
- 'COVAR' => [ 308, 2, 2, 0 ],
- 'FORECAST' => [ 309, 3, 2, 0 ],
- 'FTEST' => [ 310, 2, 2, 0 ],
- 'INTERCEPT' => [ 311, 2, 2, 0 ],
- 'PEARSON' => [ 312, 2, 2, 0 ],
- 'RSQ' => [ 313, 2, 2, 0 ],
- 'STEYX' => [ 314, 2, 2, 0 ],
- 'SLOPE' => [ 315, 2, 2, 0 ],
- 'TTEST' => [ 316, 4, 2, 0 ],
- 'PROB' => [ 317, -1, 2, 0 ],
- 'DEVSQ' => [ 318, -1, 0, 0 ],
- 'GEOMEAN' => [ 319, -1, 0, 0 ],
- 'HARMEAN' => [ 320, -1, 0, 0 ],
- 'SUMSQ' => [ 321, -1, 0, 0 ],
- 'KURT' => [ 322, -1, 0, 0 ],
- 'SKEW' => [ 323, -1, 0, 0 ],
- 'ZTEST' => [ 324, -1, 0, 0 ],
- 'LARGE' => [ 325, 2, 0, 0 ],
- 'SMALL' => [ 326, 2, 0, 0 ],
- 'QUARTILE' => [ 327, 2, 0, 0 ],
- 'PERCENTILE' => [ 328, 2, 0, 0 ],
- 'PERCENTRANK' => [ 329, -1, 0, 0 ],
- 'MODE' => [ 330, -1, 2, 0 ],
- 'TRIMMEAN' => [ 331, 2, 0, 0 ],
- 'TINV' => [ 332, 2, 1, 0 ],
- 'CONCATENATE' => [ 336, -1, 1, 0 ],
- 'POWER' => [ 337, 2, 1, 0 ],
- 'RADIANS' => [ 342, 1, 1, 0 ],
- 'DEGREES' => [ 343, 1, 1, 0 ],
- 'SUBTOTAL' => [ 344, -1, 0, 0 ],
- 'SUMIF' => [ 345, -1, 0, 0 ],
- 'COUNTIF' => [ 346, 2, 0, 0 ],
- 'COUNTBLANK' => [ 347, 1, 0, 0 ],
- 'ROMAN' => [ 354, -1, 1, 0 ],
- );
-
-}
-
-
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-Formula - A class for generating Excel formulas
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel
-
-=head1 DESCRIPTION
-
-This module is used by Spreadsheet::WriteExcel. You do not need to use it directly.
-
-
-=head1 NOTES
-
-The following notes are to help developers and maintainers understand the sequence of operation. They are also intended as a pro-memoria for the author. ;-)
-
-Spreadsheet::WriteExcel::Formula converts a textual representation of a formula into the pre-parsed binary format that Excel uses to store formulas. For example C<1+2*3> is stored as follows: C<1E 01 00 1E 02 00 1E 03 00 05 03>.
-
-This string is comprised of operators and operands arranged in a reverse-Polish format. The meaning of the tokens in the above example is shown in the following table:
-
- Token Name Value
- 1E ptgInt 0001 (stored as 01 00)
- 1E ptgInt 0002 (stored as 02 00)
- 1E ptgInt 0003 (stored as 03 00)
- 05 ptgMul
- 03 ptgAdd
-
-The tokens and token names are defined in the "Excel Developer's Kit" from Microsoft Press. C<ptg> stands for Parse ThinG (as in "That lexer can't grok it, it's a parse thang.")
-
-In general the tokens fall into two categories: operators such as C<ptgMul> and operands such as C<ptgInt>. When the formula is evaluated by Excel the operand tokens push values onto a stack. The operator tokens then pop the required number of operands off of the stack, perform an operation and push the resulting value back onto the stack. This methodology is similar to the basic operation of a reverse-Polish (RPN) calculator.
-
-Spreadsheet::WriteExcel::Formula parses a formula using a C<Parse::RecDescent> parser (at a later stage it may use a C<Parse::Yapp> parser or C<Parse::FastDescent>).
-
-The parser converts the textual representation of a formula into a parse tree. Thus, C<1+2*3> is converted into something like the following, C<e> stands for expression:
-
- e
- / | \
- 1 + e
- / | \
- 2 * 3
-
-
-The function C<_reverse_tree()> recurses down through this structure swapping the order of operators followed by operands to produce a reverse-Polish tree. In other words the formula is converted from in-fix notation to post-fix. Following the above example the resulting tree would look like this:
-
-
- e
- / | \
- 1 e +
- / | \
- 2 3 *
-
-The result of the recursion is a single array of tokens. In our example the simplified form would look like the following:
-
- (1, 2, 3, *, +)
-
-The actual return value contains some additional information to help in the secondary parsing stage:
-
- (_num, 1, _num, 2, _num, 3, ptgMul, ptgAdd, _arg, 1)
-
-The additional tokens are:
-
- Token Meaning
- _num The next token is a number
- _str The next token is a string
- _ref2d The next token is a 2d cell reference
- _ref3d The next token is a 3d cell reference
- _range2d The next token is a 2d range
- _range3d The next token is a 3d range
- _func The next token is a function
- _arg The next token is the number of args for a function
- _class The next token is a function name
- _vol The formula contains a voltile function
-
-The C<_arg> token is generated for all lists but is only used for functions that take a variable number of arguments.
-
-The C<_class> token indicates the start of the arguments to a function. This allows the post-processor to decide the "class" of the ref and range arguments that the function takes. The class can be reference, value or array. Since function calls can be nested, the class variable is stored on a stack in the C<@class> array. The class of the ref or range is then read as the top element of the stack C<$class[-1]>. When a C<_func> is read it pops the class value.
-
-Certain Excel functions such as RAND() and NOW() are designated as volatile and must be recalculated by Excel every time that a cell is updated. Any formulas that contain one of these functions has a specially formatted C<ptgAttr> tag prepended to it to indicate that it is volatile.
-
-A secondary parsing stage is carried out by C<parse_tokens()> which converts these tokens into a binary string. For the C<1+2*3> example this would give:
-
- 1E 01 00 1E 02 00 1E 03 00 05 03
-
-This two-pass method could probably have been reduced to a single pass through the C<Parse::RecDescent> parser. However, it was easier to develop and debug this way.
-
-The token values and formula values are stored in the C<%ptg> and C<%functions> hashes. These hashes and the parser object C<$parser> are exposed as global data. This breaks the OO encapsulation, but means that they can be shared by several instances of Spreadsheet::WriteExcel called from the same program.
-
-Non-English function names can be added to the C<%functions> hash using the C<function_locale.pl> program in the C<examples> directory of the distro. The supported languages are: German, French, Spanish, Portuguese, Dutch, Finnish, Italian and Swedish. These languages are not added by default because there are conflicts between functions names in different languages.
-
-The parser is initialised by C<_init_parser()>. The initialisation is delayed until the first formula is parsed. This eliminates the overhead of generating the parser in programs that are not processing formulas. (The parser should really be pre-compiled, this is to-do when the grammar stabilises).
-
-
-
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
+package Spreadsheet::WriteExcel::Formula;
+
+###############################################################################
+#
+# Formula - A class for generating Excel formulas.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+use Carp;
+
+
+
+
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Exporter);
+
+$VERSION = '2.04';
+
+###############################################################################
+#
+# Class data.
+#
+my $parser;
+my %ptg;
+my %functions;
+
+
+###############################################################################
+#
+# For debugging.
+#
+my $_debug = 0;
+
+
+###############################################################################
+#
+# new()
+#
+# Constructor
+#
+sub new {
+
+ my $class = $_[0];
+
+ my $self = {
+ _byte_order => $_[1],
+ _workbook => "",
+ _ext_sheets => {},
+ _ext_refs => {},
+ _ext_ref_count => 0,
+ };
+
+ bless $self, $class;
+ return $self;
+}
+
+
+###############################################################################
+#
+# _init_parser()
+#
+# There is a small overhead involved in generating the parser. Therefore, the
+# initialisation is delayed until a formula is required.
+# TODO: use a pre-compiled grammar.
+#
+# Porters take note, a recursive descent parser isn't mandatory. A future
+# version of this module may use a YACC based parser instead.
+#
+sub _init_parser {
+
+ my $self = shift;
+
+ # Delay loading Parse::RecDescent to reduce the module dependencies.
+ eval { require Parse::RecDescent };
+ die "The Parse::RecDescent module must be installed in order ".
+ "to write an Excel formula\n" if $@;
+
+ $self->_initialize_hashes();
+
+ # The parsing grammar.
+ #
+ # TODO: Add support for international versions of Excel
+ #
+ $parser = Parse::RecDescent->new(<<'EndGrammar');
+
+ expr: list
+
+ # Match arg lists such as SUM(1,2, 3)
+ list: <leftop: addition ',' addition>
+ { [ $item[1], '_arg', scalar @{$item[1]} ] }
+
+ addition: <leftop: multiplication add_op multiplication>
+
+ # TODO: The add_op operators don't have equal precedence.
+ add_op: add | sub | concat
+ | eq | ne | le | ge | lt | gt # Order is important
+
+ add: '+' { 'ptgAdd' }
+ sub: '-' { 'ptgSub' }
+ concat: '&' { 'ptgConcat' }
+ eq: '=' { 'ptgEQ' }
+ ne: '<>' { 'ptgNE' }
+ le: '<=' { 'ptgLE' }
+ ge: '>=' { 'ptgGE' }
+ lt: '<' { 'ptgLT' }
+ gt: '>' { 'ptgGT' }
+
+
+ multiplication: <leftop: exponention mult_op exponention>
+
+ mult_op: mult | div
+ mult: '*' { 'ptgMul' }
+ div: '/' { 'ptgDiv' }
+
+ # Left associative (apparently)
+ exponention: <leftop: factor exp_op factor>
+
+ exp_op: '^' { 'ptgPower' }
+
+ factor: number # Order is important
+ | string
+ | range2d
+ | range3d
+ | true
+ | false
+ | ref2d
+ | ref3d
+ | function
+ | '(' expr ')' { [$item[2], 'ptgParen'] }
+
+ # Match a string.
+ # Regex by merlyn. See http://www.perlmonks.org/index.pl?node_id=330280
+ #
+ string: /"([^"]|"")*"/ #" For editors
+ { [ '_str', $item[1]] }
+
+ # Match float or integer
+ number: /([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?/
+ { ['_num', $item[1]] }
+
+ # Note: The highest column values is IV. The following regexes match
+ # up to IZ. Out of range values are caught in the code.
+ #
+ # Note: sheetnames with whitespace, commas, or parentheses must be in
+ # single quotes. Applies to ref3d and range3d
+ #
+
+ # Match A1, $A1, A$1 or $A$1.
+ ref2d: /\$?[A-I]?[A-Z]\$?\d+/
+ { ['_ref2d', $item[1]] }
+
+ # Match an external sheet reference: Sheet1!A1 or 'Sheet (1)'!A1
+ ref3d: /[^!(,]+!\$?[A-I]?[A-Z]\$?\d+/
+ { ['_ref3d', $item[1]] }
+ | /'[^']+'!\$?[A-I]?[A-Z]\$?\d+/
+ { ['_ref3d', $item[1]] }
+
+ # Match A1:C5, $A1:$C5 or A:C etc.
+ range2d: /\$?[A-I]?[A-Z]\$?(\d+)?:\$?[A-I]?[A-Z]\$?(\d+)?/
+ { ['_range2d', $item[1]] }
+
+ # Match an external sheet range. 'Sheet 1:Sheet 2'!B2:C5
+ range3d: /[^!(,]+!\$?[A-I]?[A-Z]\$?(\d+)?:\$?[A-I]?[A-Z]\$?(\d+)?/
+ { ['_range3d', $item[1]] }
+ | /'[^']+'!\$?[A-I]?[A-Z]\$?(\d+)?:\$?[A-I]?[A-Z]\$?(\d+)?/
+ { ['_range3d', $item[1]] }
+
+ # Match a function name.
+ function: /[A-Z0-9À-Ü_.]+/ '()'
+ { ['_func', $item[1]] }
+ | /[A-Z0-9À-Ü_.]+/ '(' expr ')'
+ { ['_class', $item[1], $item[3], '_func', $item[1]] }
+ | /[A-Z0-9À-Ü_.]+/ '(' list ')'
+ { ['_class', $item[1], $item[3], '_func', $item[1]] }
+
+ # Boolean values.
+ true: 'TRUE' { [ 'ptgBool', 1 ] }
+
+ false: 'FALSE' { [ 'ptgBool', 0 ] }
+
+EndGrammar
+
+print "Init_parser.\n\n" if $_debug;
+}
+
+
+
+###############################################################################
+#
+# parse_formula()
+#
+# Takes a textual description of a formula and returns a RPN encoded byte
+# string.
+#
+sub parse_formula {
+
+ my $self= shift;
+
+ # Initialise the parser if this is the first call
+ $self->_init_parser() if not defined $parser;
+
+ my $formula = shift @_;
+ my $tokens;
+
+ print $formula, "\n" if $_debug;
+
+ # Build the parse tree for the formula
+ my $parsetree =$parser->expr($formula);
+
+ # Check if parsing worked.
+ if (defined $parsetree) {
+ my @tokens = $self->_reverse_tree(@$parsetree);
+
+ # Add a volatile token if the formula contains a volatile function.
+ # This must be the first token in the list
+ #
+ unshift @tokens, '_vol' if $self->_check_volatile(@tokens);
+
+ # The return value depends on which Worksheet.pm method is the caller
+ if (wantarray) {
+ # Parse formula to see if it throws any errors and then
+ # return raw tokens to Worksheet::store_formula()
+ #
+ $self->parse_tokens(@tokens);
+ return @tokens;
+ }
+ else{
+ # Return byte stream to Worksheet::write_formula()
+ return $self->parse_tokens(@tokens);
+ }
+ }
+ else {
+ die "Couldn't parse formula: =$formula\n";
+ }
+}
+
+
+###############################################################################
+#
+# parse_tokens()
+#
+# Convert each token or token pair to its Excel 'ptg' equivalent.
+#
+sub parse_tokens {
+
+ my $self = shift;
+ my $parse_str = '';
+ my $last_type = '';
+ my $modifier = '';
+ my $num_args = 0;
+ my $class = 0;
+ my @class = 1;
+ my @tokens = @_;
+
+
+ # A note about the class modifiers used below. In general the class,
+ # "reference" or "value", of a function is applied to all of its operands.
+ # However, in certain circumstances the operands can have mixed classes,
+ # e.g. =VLOOKUP with external references. These will eventually be dealt
+ # with by the parser. However, as a workaround the class type of a token
+ # can be changed via the repeat_formula interface. Thus, a _ref2d token can
+ # be changed by the user to _ref2dA or _ref2dR to change its token class.
+ #
+ while (@_) {
+ my $token = shift @_;
+
+ if ($token eq '_arg') {
+ $num_args = shift @_;
+ }
+ elsif ($token eq '_class') {
+ $token = shift @_;
+ $class = $functions{$token}[2];
+ # If $class is undef then it means that the function isn't valid.
+ die "Unknown function $token() in formula\n" unless defined $class;
+ push @class, $class;
+ }
+ elsif ($token eq '_vol') {
+ $parse_str .= $self->_convert_volatile();
+ }
+ elsif ($token eq 'ptgBool') {
+ $token = shift @_;
+ $parse_str .= $self->_convert_bool($token);
+ }
+ elsif ($token eq '_num') {
+ $token = shift @_;
+ $parse_str .= $self->_convert_number($token);
+ }
+ elsif ($token eq '_str') {
+ $token = shift @_;
+ $parse_str .= $self->_convert_string($token);
+ }
+ elsif ($token =~ /^_ref2d/) {
+ ($modifier = $token) =~ s/_ref2d//;
+ $class = $class[-1];
+ $class = 0 if $modifier eq 'R';
+ $class = 1 if $modifier eq 'V';
+ $token = shift @_;
+ $parse_str .= $self->_convert_ref2d($token, $class);
+ }
+ elsif ($token =~ /^_ref3d/) {
+ ($modifier = $token) =~ s/_ref3d//;
+ $class = $class[-1];
+ $class = 0 if $modifier eq 'R';
+ $class = 1 if $modifier eq 'V';
+ $token = shift @_;
+ $parse_str .= $self->_convert_ref3d($token, $class);
+ }
+ elsif ($token =~ /^_range2d/) {
+ ($modifier = $token) =~ s/_range2d//;
+ $class = $class[-1];
+ $class = 0 if $modifier eq 'R';
+ $class = 1 if $modifier eq 'V';
+ $token = shift @_;
+ $parse_str .= $self->_convert_range2d($token, $class);
+ }
+ elsif ($token =~ /^_range3d/) {
+ ($modifier = $token) =~ s/_range3d//;
+ $class = $class[-1];
+ $class = 0 if $modifier eq 'R';
+ $class = 1 if $modifier eq 'V';
+ $token = shift @_;
+ $parse_str .= $self->_convert_range3d($token, $class);
+ }
+ elsif ($token eq '_func') {
+ $token = shift @_;
+ $parse_str .= $self->_convert_function($token, $num_args);
+ pop @class;
+ $num_args = 0; # Reset after use
+ }
+ elsif (exists $ptg{$token}) {
+ $parse_str .= pack("C", $ptg{$token});
+ }
+ else {
+ # Unrecognised token
+ return undef;
+ }
+ }
+
+
+ if ($_debug) {
+ print join(" ", map { sprintf "%02X", $_ } unpack("C*",$parse_str));
+ print "\n\n";
+ print join(" ", @tokens), "\n\n";
+ }
+
+ return $parse_str;
+}
+
+
+###############################################################################
+#
+# _reverse_tree()
+#
+# This function descends recursively through the parse tree. At each level it
+# swaps the order of an operator followed by an operand.
+# For example, 1+2*3 would be converted in the following sequence:
+# 1 + 2 * 3
+# 1 + (2 * 3)
+# 1 + (2 3 *)
+# 1 (2 3 *) +
+# 1 2 3 * +
+#
+sub _reverse_tree
+{
+ my $self = shift;
+
+ my @tokens;
+ my @expression = @_;
+ my @stack;
+
+ while (@expression) {
+ my $token = shift @expression;
+
+ # If the token is an operator swap it with the following operand
+ if ( $token eq 'ptgAdd' ||
+ $token eq 'ptgSub' ||
+ $token eq 'ptgConcat' ||
+ $token eq 'ptgMul' ||
+ $token eq 'ptgDiv' ||
+ $token eq 'ptgPower' ||
+ $token eq 'ptgEQ' ||
+ $token eq 'ptgNE' ||
+ $token eq 'ptgLE' ||
+ $token eq 'ptgGE' ||
+ $token eq 'ptgLT' ||
+ $token eq 'ptgGT')
+ {
+ my $operand = shift @expression;
+ push @stack, $operand;
+ }
+
+ push @stack, $token;
+ }
+
+ # Recurse through the parse tree
+ foreach my $token (@stack) {
+ if (ref($token)) {
+ push @tokens, $self->_reverse_tree(@$token);
+ }
+ else {
+ push @tokens, $token;
+ }
+ }
+
+ return @tokens;
+}
+
+
+###############################################################################
+#
+# _check_volatile()
+#
+# Check if the formula contains a volatile function, i.e. a function that must
+# be recalculated each time a cell is updated. These formulas require a ptgAttr
+# with the volatile flag set as the first token in the parsed expression.
+#
+# Examples of volatile functions: RAND(), NOW(), TODAY()
+#
+sub _check_volatile {
+
+ my $self = shift;
+ my @tokens = @_;
+ my $volatile = 0;
+
+ for my $i (0.. at tokens-1) {
+ # If the next token is a function check if it is volatile.
+ if ($tokens[$i] eq '_func' and $functions{$tokens[$i+1]}[3]) {
+ $volatile = 1;
+ last;
+ }
+ }
+
+ return $volatile;
+}
+
+
+###############################################################################
+#
+# _convert_volatile()
+#
+# Convert _vol to a ptgAttr tag formatted to indicate that the formula contains
+# a volatile function. See _check_volatile()
+#
+sub _convert_volatile {
+
+ my $self = shift;
+
+ # Set bitFattrSemi flag to indicate volatile function, "w" is set to zero.
+ return pack("CCv", $ptg{ptgAttr}, 0x1, 0x0);
+}
+
+
+###############################################################################
+#
+# _convert_bool()
+#
+# Convert a boolean token to ptgBool
+#
+sub _convert_bool {
+
+ my $self = shift;
+ my $bool = shift;
+
+ return pack("CC", $ptg{ptgBool}, $bool);
+}
+
+
+###############################################################################
+#
+# _convert_number()
+#
+# Convert a number token to ptgInt or ptgNum
+#
+sub _convert_number {
+
+ my $self = shift;
+ my $num = shift;
+
+ # Integer in the range 0..2**16-1
+ if (($num =~ /^\d+$/) && ($num <= 65535)) {
+ return pack("Cv", $ptg{ptgInt}, $num);
+ }
+ else { # A float
+ $num = pack("d", $num);
+ $num = reverse $num if $self->{_byte_order};
+ return pack("C", $ptg{ptgNum}) . $num;
+ }
+}
+
+
+###############################################################################
+#
+# _convert_string()
+#
+# Convert a string to a ptg Str.
+#
+sub _convert_string {
+
+ my $self = shift;
+ my $str = shift;
+ my $encoding = 0;
+
+ $str =~ s/^"//; # Remove leading "
+ $str =~ s/"$//; # Remove trailing "
+ $str =~ s/""/"/g; # Substitute Excel's escaped double quote "" for "
+
+ my $length = length($str);
+
+ # TODO string length
+ die "String in formula has more than 255 chars\n" if $length > 255;
+
+ return pack("CCC", $ptg{ptgStr}, $length, $encoding) . $str;
+}
+
+
+###############################################################################
+#
+# _convert_ref2d()
+#
+# Convert an Excel reference such as A1, $B2, C$3 or $D$4 to a ptgRefV.
+#
+sub _convert_ref2d {
+
+ my $self = shift;
+ my $cell = shift;
+ my $class = shift;
+ my $ptgRef;
+
+ # Convert the cell reference
+ my ($row, $col) = $self->_cell_to_packed_rowcol($cell);
+
+ # The ptg value depends on the class of the ptg.
+ if ($class == 0) {
+ $ptgRef = pack("C", $ptg{ptgRef});
+ }
+ elsif ($class == 1) {
+ $ptgRef = pack("C", $ptg{ptgRefV});
+ }
+ elsif ($class == 2) {
+ $ptgRef = pack("C", $ptg{ptgRefA});
+ }
+ else{
+ die "Unknown function class in formula\n";
+ }
+
+ return $ptgRef . $row . $col;
+}
+
+
+###############################################################################
+#
+# _convert_ref3d
+#
+# Convert an Excel 3d reference such as "Sheet1!A1" or "Sheet1:Sheet2!A1" to a
+# ptgRef3dV.
+#
+sub _convert_ref3d {
+
+ my $self = shift;
+ my $token = shift;
+ my $class = shift;
+ my $ptgRef;
+
+ # Split the ref at the ! symbol
+ my ($ext_ref, $cell) = split '!', $token;
+
+ # Convert the external reference part
+ $ext_ref = $self->_pack_ext_ref($ext_ref);
+
+ # Convert the cell reference part
+ my ($row, $col) = $self->_cell_to_packed_rowcol($cell);
+
+ # The ptg value depends on the class of the ptg.
+ if ($class == 0) {
+ $ptgRef = pack("C", $ptg{ptgRef3d});
+ }
+ elsif ($class == 1) {
+ $ptgRef = pack("C", $ptg{ptgRef3dV});
+ }
+ elsif ($class == 2) {
+ $ptgRef = pack("C", $ptg{ptgRef3dA});
+ }
+ else{
+ die "Unknown function class in formula\n";
+ }
+
+ return $ptgRef . $ext_ref. $row . $col;
+}
+
+
+###############################################################################
+#
+# _convert_range2d()
+#
+# Convert an Excel range such as A1:D4 or A:D to a ptgRefV.
+#
+sub _convert_range2d {
+
+ my $self = shift;
+ my $range = shift;
+ my $class = shift;
+ my $ptgArea;
+
+ # Split the range into 2 cell refs
+ my ($cell1, $cell2) = split ':', $range;
+
+ # A range such as A:D is equivalent to A1:D65536, so add rows as required
+ $cell1 .= '1' if $cell1 !~ /\d/;
+ $cell2 .= '65536' if $cell2 !~ /\d/;
+
+ # Convert the cell references
+ my ($row1, $col1) = $self->_cell_to_packed_rowcol($cell1);
+ my ($row2, $col2) = $self->_cell_to_packed_rowcol($cell2);
+
+ # The ptg value depends on the class of the ptg.
+ if ($class == 0) {
+ $ptgArea = pack("C", $ptg{ptgArea});
+ }
+ elsif ($class == 1) {
+ $ptgArea = pack("C", $ptg{ptgAreaV});
+ }
+ elsif ($class == 2) {
+ $ptgArea = pack("C", $ptg{ptgAreaA});
+ }
+ else{
+ die "Unknown function class in formula\n";
+ }
+
+ return $ptgArea . $row1 . $row2 . $col1. $col2;
+}
+
+
+###############################################################################
+#
+# _convert_range3d
+#
+# Convert an Excel 3d range such as "Sheet1!A1:D4" or "Sheet1:Sheet2!A1:D4" to
+# a ptgArea3dV.
+#
+sub _convert_range3d {
+
+ my $self = shift;
+ my $token = shift;
+ my $class = shift;
+ my $ptgArea;
+
+ # Split the ref at the ! symbol
+ my ($ext_ref, $range) = split '!', $token;
+
+ # Convert the external reference part
+ $ext_ref = $self->_pack_ext_ref($ext_ref);
+
+ # Split the range into 2 cell refs
+ my ($cell1, $cell2) = split ':', $range;
+
+ # A range such as A:D is equivalent to A1:D65536, so add rows as required
+ $cell1 .= '1' if $cell1 !~ /\d/;
+ $cell2 .= '65536' if $cell2 !~ /\d/;
+
+ # Convert the cell references
+ my ($row1, $col1) = $self->_cell_to_packed_rowcol($cell1);
+ my ($row2, $col2) = $self->_cell_to_packed_rowcol($cell2);
+
+ # The ptg value depends on the class of the ptg.
+ if ($class == 0) {
+ $ptgArea = pack("C", $ptg{ptgArea3d});
+ }
+ elsif ($class == 1) {
+ $ptgArea = pack("C", $ptg{ptgArea3dV});
+ }
+ elsif ($class == 2) {
+ $ptgArea = pack("C", $ptg{ptgArea3dA});
+ }
+ else{
+ die "Unknown function class in formula\n";
+ }
+
+ return $ptgArea . $ext_ref . $row1 . $row2 . $col1. $col2;
+}
+
+
+###############################################################################
+#
+# _pack_ext_ref()
+#
+# Convert the sheet name part of an external reference, for example "Sheet1" or
+# "Sheet1:Sheet2", to a packed structure.
+#
+sub _pack_ext_ref {
+
+ my $self = shift;
+ my $ext_ref = shift;
+ my $sheet1;
+ my $sheet2;
+
+ $ext_ref =~ s/^'//; # Remove leading ' if any.
+ $ext_ref =~ s/'$//; # Remove trailing ' if any.
+
+ # Check if there is a sheet range eg., Sheet1:Sheet2.
+ if ($ext_ref =~ /:/) {
+ ($sheet1, $sheet2) = split ':', $ext_ref;
+
+ $sheet1 = $self->_get_sheet_index($sheet1);
+ $sheet2 = $self->_get_sheet_index($sheet2);
+
+ # Reverse max and min sheet numbers if necessary
+ if ($sheet1 > $sheet2) {
+ ($sheet1, $sheet2) = ($sheet2, $sheet1);
+ }
+ }
+ else {
+ # Single sheet name only.
+ ($sheet1, $sheet2) = ($ext_ref, $ext_ref);
+
+ $sheet1 = $self->_get_sheet_index($sheet1);
+ $sheet2 = $sheet1;
+ }
+
+ my $key = "$sheet1:$sheet2";
+ my $index;
+
+ if (exists $self->{_ext_refs}->{$key}) {
+ $index = $self->{_ext_refs}->{$key};
+ }
+ else {
+ $index = $self->{_ext_ref_count};
+ $self->{_ext_refs}->{$key} = $index;
+ $self->{_ext_ref_count}++;
+ }
+
+ return pack("v",$index);
+}
+
+
+###############################################################################
+#
+# _get_sheet_index()
+#
+# Look up the index that corresponds to an external sheet name. The hash of
+# sheet names is updated by the add_worksheet() method of the Workbook class.
+#
+sub _get_sheet_index {
+
+ my $self = shift;
+ my $sheet_name = shift;
+
+ if (not exists $self->{_ext_sheets}->{$sheet_name}) {
+ die "Unknown sheet name $sheet_name in formula\n";
+ }
+ else {
+ return $self->{_ext_sheets}->{$sheet_name};
+ }
+}
+
+
+###############################################################################
+#
+# set_ext_sheets()
+#
+# This semi-public method is used to update the hash of sheet names. It is
+# updated by the add_worksheet() method of the Workbook class.
+#
+sub set_ext_sheets {
+
+ my $self = shift;
+ my $worksheet = shift;
+ my $index = shift;
+
+ #my $ref = "$index:$index";
+
+ # The _ext_sheets hash is used to translate between worksheet names
+ # and their index
+ $self->{_ext_sheets}->{$worksheet} = $index;
+
+
+ # 2D sheet refs such as '=Sheet1:Sheet2!A1' can only be added after all
+ # worksheets have been added.
+ #return 0 if $index < $self->{_ext_ref_count}; TODO
+
+
+ # The _ext_refs hash is used to correlate the external references used in
+ # formulas with the index stored in the Workbook EXTERNSHEET record.
+ #$self->{_ext_refs}->{$ref} = $index;
+ #$self->{_ext_ref_count}++;
+
+ # No errors
+ #return 1;
+}
+
+
+###############################################################################
+#
+# get_ext_sheets()
+#
+# This semi-public method is used to update the hash of sheet names. It is
+# updated by the add_worksheet() method of the Workbook class.
+#
+# TODO
+#
+sub get_ext_sheets {
+
+ my $self = shift;
+
+ # TODO
+ my %refs = %{$self->{_ext_refs}};
+ return %refs;
+
+ #my @refs = sort {$refs{$a} <=> $refs{$b}} keys %refs;
+
+ #foreach my $ref (@refs) {
+ # $ref = [split /:/, $ref];
+ #}
+
+ #return @refs;
+}
+
+
+###############################################################################
+#
+# get_ext_ref_count()
+#
+# TODO This semi-public method is used to update the hash of sheet names. It is
+# updated by the add_worksheet() method of the Workbook class.
+#
+sub get_ext_ref_count {
+
+ my $self = shift;
+
+ return $self->{_ext_ref_count};
+}
+
+
+###############################################################################
+#
+# _convert_function()
+#
+# Convert a function to a ptgFunc or ptgFuncVarV depending on the number of
+# args that it takes.
+#
+sub _convert_function {
+
+ my $self = shift;
+ my $token = shift;
+ my $num_args = shift;
+
+ die "Unknown function $token() in formula\n"
+ unless defined $functions{$token}[0];
+
+ my $args = $functions{$token}[1];
+
+ # Fixed number of args eg. TIME($i,$j,$k).
+ if ($args >= 0) {
+ # Check that the number of args is valid.
+ if ($args != $num_args) {
+ die "Incorrect number of arguments for $token() in formula\n";
+ }
+ else {
+ return pack("Cv", $ptg{ptgFuncV}, $functions{$token}[0]);
+ }
+ }
+
+ # Variable number of args eg. SUM($i,$j,$k, ..).
+ if ($args == -1) {
+ return pack "CCv", $ptg{ptgFuncVarV}, $num_args, $functions{$token}[0];
+ }
+}
+
+
+###############################################################################
+#
+# _cell_to_rowcol($cell_ref)
+#
+# Convert an Excel cell reference such as A1 or $B2 or C$3 or $D$4 to a zero
+# indexed row and column number. Also returns two boolean values to indicate
+# whether the row or column are relative references.
+# TODO use function in Utility.pm
+#
+sub _cell_to_rowcol {
+
+ my $self = shift;
+ my $cell = shift;
+
+ $cell =~ /(\$?)([A-I]?[A-Z])(\$?)(\d+)/;
+
+ my $col_rel = $1 eq "" ? 1 : 0;
+ my $col = $2;
+ my $row_rel = $3 eq "" ? 1 : 0;
+ my $row = $4;
+
+ # Convert base26 column string to a number.
+ # All your Base are belong to us.
+ my @chars = split //, $col;
+ my $expn = 0;
+ $col = 0;
+
+ while (@chars) {
+ my $char = pop(@chars); # LS char first
+ $col += (ord($char) - ord('A') + 1) * (26**$expn);
+ $expn++;
+ }
+
+ # Convert 1-index to zero-index
+ $row--;
+ $col--;
+
+ return $row, $col, $row_rel, $col_rel;
+}
+
+
+###############################################################################
+#
+# _cell_to_packed_rowcol($row, $col, $row_rel, $col_rel)
+#
+# pack() row and column into the required 3 byte format.
+#
+sub _cell_to_packed_rowcol {
+
+ use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
+
+ my $self = shift;
+ my $cell = shift;
+
+ my ($row, $col, $row_rel, $col_rel) = $self->_cell_to_rowcol($cell);
+
+ die "Column $cell greater than IV in formula\n" if $col >= 256;
+ die "Row $cell greater than 65536 in formula\n" if $row >= 65536;
+
+ # Set the high bits to indicate if row or col are relative.
+ $col |= $col_rel << 14;
+ $col |= $row_rel << 15;
+
+ $row = pack('v', $row);
+ $col = pack('v', $col);
+
+ return ($row, $col);
+}
+
+
+###############################################################################
+#
+# _initialize_hashes()
+#
+sub _initialize_hashes {
+
+ # The Excel ptg indices
+ %ptg = (
+ 'ptgExp' => 0x01,
+ 'ptgTbl' => 0x02,
+ 'ptgAdd' => 0x03,
+ 'ptgSub' => 0x04,
+ 'ptgMul' => 0x05,
+ 'ptgDiv' => 0x06,
+ 'ptgPower' => 0x07,
+ 'ptgConcat' => 0x08,
+ 'ptgLT' => 0x09,
+ 'ptgLE' => 0x0A,
+ 'ptgEQ' => 0x0B,
+ 'ptgGE' => 0x0C,
+ 'ptgGT' => 0x0D,
+ 'ptgNE' => 0x0E,
+ 'ptgIsect' => 0x0F,
+ 'ptgUnion' => 0x10,
+ 'ptgRange' => 0x11,
+ 'ptgUplus' => 0x12,
+ 'ptgUminus' => 0x13,
+ 'ptgPercent' => 0x14,
+ 'ptgParen' => 0x15,
+ 'ptgMissArg' => 0x16,
+ 'ptgStr' => 0x17,
+ 'ptgAttr' => 0x19,
+ 'ptgSheet' => 0x1A,
+ 'ptgEndSheet' => 0x1B,
+ 'ptgErr' => 0x1C,
+ 'ptgBool' => 0x1D,
+ 'ptgInt' => 0x1E,
+ 'ptgNum' => 0x1F,
+ 'ptgArray' => 0x20,
+ 'ptgFunc' => 0x21,
+ 'ptgFuncVar' => 0x22,
+ 'ptgName' => 0x23,
+ 'ptgRef' => 0x24,
+ 'ptgArea' => 0x25,
+ 'ptgMemArea' => 0x26,
+ 'ptgMemErr' => 0x27,
+ 'ptgMemNoMem' => 0x28,
+ 'ptgMemFunc' => 0x29,
+ 'ptgRefErr' => 0x2A,
+ 'ptgAreaErr' => 0x2B,
+ 'ptgRefN' => 0x2C,
+ 'ptgAreaN' => 0x2D,
+ 'ptgMemAreaN' => 0x2E,
+ 'ptgMemNoMemN' => 0x2F,
+ 'ptgNameX' => 0x39,
+ 'ptgRef3d' => 0x3A,
+ 'ptgArea3d' => 0x3B,
+ 'ptgRefErr3d' => 0x3C,
+ 'ptgAreaErr3d' => 0x3D,
+ 'ptgArrayV' => 0x40,
+ 'ptgFuncV' => 0x41,
+ 'ptgFuncVarV' => 0x42,
+ 'ptgNameV' => 0x43,
+ 'ptgRefV' => 0x44,
+ 'ptgAreaV' => 0x45,
+ 'ptgMemAreaV' => 0x46,
+ 'ptgMemErrV' => 0x47,
+ 'ptgMemNoMemV' => 0x48,
+ 'ptgMemFuncV' => 0x49,
+ 'ptgRefErrV' => 0x4A,
+ 'ptgAreaErrV' => 0x4B,
+ 'ptgRefNV' => 0x4C,
+ 'ptgAreaNV' => 0x4D,
+ 'ptgMemAreaNV' => 0x4E,
+ 'ptgMemNoMemN' => 0x4F,
+ 'ptgFuncCEV' => 0x58,
+ 'ptgNameXV' => 0x59,
+ 'ptgRef3dV' => 0x5A,
+ 'ptgArea3dV' => 0x5B,
+ 'ptgRefErr3dV' => 0x5C,
+ 'ptgAreaErr3d' => 0x5D,
+ 'ptgArrayA' => 0x60,
+ 'ptgFuncA' => 0x61,
+ 'ptgFuncVarA' => 0x62,
+ 'ptgNameA' => 0x63,
+ 'ptgRefA' => 0x64,
+ 'ptgAreaA' => 0x65,
+ 'ptgMemAreaA' => 0x66,
+ 'ptgMemErrA' => 0x67,
+ 'ptgMemNoMemA' => 0x68,
+ 'ptgMemFuncA' => 0x69,
+ 'ptgRefErrA' => 0x6A,
+ 'ptgAreaErrA' => 0x6B,
+ 'ptgRefNA' => 0x6C,
+ 'ptgAreaNA' => 0x6D,
+ 'ptgMemAreaNA' => 0x6E,
+ 'ptgMemNoMemN' => 0x6F,
+ 'ptgFuncCEA' => 0x78,
+ 'ptgNameXA' => 0x79,
+ 'ptgRef3dA' => 0x7A,
+ 'ptgArea3dA' => 0x7B,
+ 'ptgRefErr3dA' => 0x7C,
+ 'ptgAreaErr3d' => 0x7D,
+ );
+
+ # Thanks to Michael Meeks and Gnumeric for the initial arg values.
+ #
+ # The following hash was generated by "function_locale.pl" in the distro.
+ # Refer to function_locale.pl for non-English function names.
+ #
+ # The array elements are as follow:
+ # ptg: The Excel function ptg code.
+ # args: The number of arguments that the function takes:
+ # >=0 is a fixed number of arguments.
+ # -1 is a variable number of arguments.
+ # class: The reference, value or array class of the function args.
+ # vol: The function is volatile.
+ #
+ %functions = (
+ # ptg args class vol
+ 'COUNT' => [ 0, -1, 0, 0 ],
+ 'IF' => [ 1, -1, 1, 0 ],
+ 'ISNA' => [ 2, 1, 1, 0 ],
+ 'ISERROR' => [ 3, 1, 1, 0 ],
+ 'SUM' => [ 4, -1, 0, 0 ],
+ 'AVERAGE' => [ 5, -1, 0, 0 ],
+ 'MIN' => [ 6, -1, 0, 0 ],
+ 'MAX' => [ 7, -1, 0, 0 ],
+ 'ROW' => [ 8, -1, 0, 0 ],
+ 'COLUMN' => [ 9, -1, 0, 0 ],
+ 'NA' => [ 10, 0, 0, 0 ],
+ 'NPV' => [ 11, -1, 1, 0 ],
+ 'STDEV' => [ 12, -1, 0, 0 ],
+ 'DOLLAR' => [ 13, -1, 1, 0 ],
+ 'FIXED' => [ 14, -1, 1, 0 ],
+ 'SIN' => [ 15, 1, 1, 0 ],
+ 'COS' => [ 16, 1, 1, 0 ],
+ 'TAN' => [ 17, 1, 1, 0 ],
+ 'ATAN' => [ 18, 1, 1, 0 ],
+ 'PI' => [ 19, 0, 1, 0 ],
+ 'SQRT' => [ 20, 1, 1, 0 ],
+ 'EXP' => [ 21, 1, 1, 0 ],
+ 'LN' => [ 22, 1, 1, 0 ],
+ 'LOG10' => [ 23, 1, 1, 0 ],
+ 'ABS' => [ 24, 1, 1, 0 ],
+ 'INT' => [ 25, 1, 1, 0 ],
+ 'SIGN' => [ 26, 1, 1, 0 ],
+ 'ROUND' => [ 27, 2, 1, 0 ],
+ 'LOOKUP' => [ 28, -1, 0, 0 ],
+ 'INDEX' => [ 29, -1, 0, 1 ],
+ 'REPT' => [ 30, 2, 1, 0 ],
+ 'MID' => [ 31, 3, 1, 0 ],
+ 'LEN' => [ 32, 1, 1, 0 ],
+ 'VALUE' => [ 33, 1, 1, 0 ],
+ 'TRUE' => [ 34, 0, 1, 0 ],
+ 'FALSE' => [ 35, 0, 1, 0 ],
+ 'AND' => [ 36, -1, 1, 0 ],
+ 'OR' => [ 37, -1, 1, 0 ],
+ 'NOT' => [ 38, 1, 1, 0 ],
+ 'MOD' => [ 39, 2, 1, 0 ],
+ 'DCOUNT' => [ 40, 3, 0, 0 ],
+ 'DSUM' => [ 41, 3, 0, 0 ],
+ 'DAVERAGE' => [ 42, 3, 0, 0 ],
+ 'DMIN' => [ 43, 3, 0, 0 ],
+ 'DMAX' => [ 44, 3, 0, 0 ],
+ 'DSTDEV' => [ 45, 3, 0, 0 ],
+ 'VAR' => [ 46, -1, 0, 0 ],
+ 'DVAR' => [ 47, 3, 0, 0 ],
+ 'TEXT' => [ 48, 2, 1, 0 ],
+ 'LINEST' => [ 49, -1, 0, 0 ],
+ 'TREND' => [ 50, -1, 0, 0 ],
+ 'LOGEST' => [ 51, -1, 0, 0 ],
+ 'GROWTH' => [ 52, -1, 0, 0 ],
+ 'PV' => [ 56, -1, 1, 0 ],
+ 'FV' => [ 57, -1, 1, 0 ],
+ 'NPER' => [ 58, -1, 1, 0 ],
+ 'PMT' => [ 59, -1, 1, 0 ],
+ 'RATE' => [ 60, -1, 1, 0 ],
+ 'MIRR' => [ 61, 3, 0, 0 ],
+ 'IRR' => [ 62, -1, 0, 0 ],
+ 'RAND' => [ 63, 0, 1, 1 ],
+ 'MATCH' => [ 64, -1, 0, 0 ],
+ 'DATE' => [ 65, 3, 1, 0 ],
+ 'TIME' => [ 66, 3, 1, 0 ],
+ 'DAY' => [ 67, 1, 1, 0 ],
+ 'MONTH' => [ 68, 1, 1, 0 ],
+ 'YEAR' => [ 69, 1, 1, 0 ],
+ 'WEEKDAY' => [ 70, -1, 1, 0 ],
+ 'HOUR' => [ 71, 1, 1, 0 ],
+ 'MINUTE' => [ 72, 1, 1, 0 ],
+ 'SECOND' => [ 73, 1, 1, 0 ],
+ 'NOW' => [ 74, 0, 1, 1 ],
+ 'AREAS' => [ 75, 1, 0, 1 ],
+ 'ROWS' => [ 76, 1, 0, 1 ],
+ 'COLUMNS' => [ 77, 1, 0, 1 ],
+ 'OFFSET' => [ 78, -1, 0, 1 ],
+ 'SEARCH' => [ 82, -1, 1, 0 ],
+ 'TRANSPOSE' => [ 83, 1, 1, 0 ],
+ 'TYPE' => [ 86, 1, 1, 0 ],
+ 'ATAN2' => [ 97, 2, 1, 0 ],
+ 'ASIN' => [ 98, 1, 1, 0 ],
+ 'ACOS' => [ 99, 1, 1, 0 ],
+ 'CHOOSE' => [ 100, -1, 1, 0 ],
+ 'HLOOKUP' => [ 101, -1, 0, 0 ],
+ 'VLOOKUP' => [ 102, -1, 0, 0 ],
+ 'ISREF' => [ 105, 1, 0, 0 ],
+ 'LOG' => [ 109, -1, 1, 0 ],
+ 'CHAR' => [ 111, 1, 1, 0 ],
+ 'LOWER' => [ 112, 1, 1, 0 ],
+ 'UPPER' => [ 113, 1, 1, 0 ],
+ 'PROPER' => [ 114, 1, 1, 0 ],
+ 'LEFT' => [ 115, -1, 1, 0 ],
+ 'RIGHT' => [ 116, -1, 1, 0 ],
+ 'EXACT' => [ 117, 2, 1, 0 ],
+ 'TRIM' => [ 118, 1, 1, 0 ],
+ 'REPLACE' => [ 119, 4, 1, 0 ],
+ 'SUBSTITUTE' => [ 120, -1, 1, 0 ],
+ 'CODE' => [ 121, 1, 1, 0 ],
+ 'FIND' => [ 124, -1, 1, 0 ],
+ 'CELL' => [ 125, -1, 0, 1 ],
+ 'ISERR' => [ 126, 1, 1, 0 ],
+ 'ISTEXT' => [ 127, 1, 1, 0 ],
+ 'ISNUMBER' => [ 128, 1, 1, 0 ],
+ 'ISBLANK' => [ 129, 1, 1, 0 ],
+ 'T' => [ 130, 1, 0, 0 ],
+ 'N' => [ 131, 1, 0, 0 ],
+ 'DATEVALUE' => [ 140, 1, 1, 0 ],
+ 'TIMEVALUE' => [ 141, 1, 1, 0 ],
+ 'SLN' => [ 142, 3, 1, 0 ],
+ 'SYD' => [ 143, 4, 1, 0 ],
+ 'DDB' => [ 144, -1, 1, 0 ],
+ 'INDIRECT' => [ 148, -1, 1, 1 ],
+ 'CALL' => [ 150, -1, 1, 0 ],
+ 'CLEAN' => [ 162, 1, 1, 0 ],
+ 'MDETERM' => [ 163, 1, 2, 0 ],
+ 'MINVERSE' => [ 164, 1, 2, 0 ],
+ 'MMULT' => [ 165, 2, 2, 0 ],
+ 'IPMT' => [ 167, -1, 1, 0 ],
+ 'PPMT' => [ 168, -1, 1, 0 ],
+ 'COUNTA' => [ 169, -1, 0, 0 ],
+ 'PRODUCT' => [ 183, -1, 0, 0 ],
+ 'FACT' => [ 184, 1, 1, 0 ],
+ 'DPRODUCT' => [ 189, 3, 0, 0 ],
+ 'ISNONTEXT' => [ 190, 1, 1, 0 ],
+ 'STDEVP' => [ 193, -1, 0, 0 ],
+ 'VARP' => [ 194, -1, 0, 0 ],
+ 'DSTDEVP' => [ 195, 3, 0, 0 ],
+ 'DVARP' => [ 196, 3, 0, 0 ],
+ 'TRUNC' => [ 197, -1, 1, 0 ],
+ 'ISLOGICAL' => [ 198, 1, 1, 0 ],
+ 'DCOUNTA' => [ 199, 3, 0, 0 ],
+ 'ROUNDUP' => [ 212, 2, 1, 0 ],
+ 'ROUNDDOWN' => [ 213, 2, 1, 0 ],
+ 'RANK' => [ 216, -1, 0, 0 ],
+ 'ADDRESS' => [ 219, -1, 1, 0 ],
+ 'DAYS360' => [ 220, -1, 1, 0 ],
+ 'TODAY' => [ 221, 0, 1, 1 ],
+ 'VDB' => [ 222, -1, 1, 0 ],
+ 'MEDIAN' => [ 227, -1, 0, 0 ],
+ 'SUMPRODUCT' => [ 228, -1, 2, 0 ],
+ 'SINH' => [ 229, 1, 1, 0 ],
+ 'COSH' => [ 230, 1, 1, 0 ],
+ 'TANH' => [ 231, 1, 1, 0 ],
+ 'ASINH' => [ 232, 1, 1, 0 ],
+ 'ACOSH' => [ 233, 1, 1, 0 ],
+ 'ATANH' => [ 234, 1, 1, 0 ],
+ 'DGET' => [ 235, 3, 0, 0 ],
+ 'INFO' => [ 244, 1, 1, 1 ],
+ 'DB' => [ 247, -1, 1, 0 ],
+ 'FREQUENCY' => [ 252, 2, 0, 0 ],
+ 'ERROR.TYPE' => [ 261, 1, 1, 0 ],
+ 'REGISTER.ID' => [ 267, -1, 1, 0 ],
+ 'AVEDEV' => [ 269, -1, 0, 0 ],
+ 'BETADIST' => [ 270, -1, 1, 0 ],
+ 'GAMMALN' => [ 271, 1, 1, 0 ],
+ 'BETAINV' => [ 272, -1, 1, 0 ],
+ 'BINOMDIST' => [ 273, 4, 1, 0 ],
+ 'CHIDIST' => [ 274, 2, 1, 0 ],
+ 'CHIINV' => [ 275, 2, 1, 0 ],
+ 'COMBIN' => [ 276, 2, 1, 0 ],
+ 'CONFIDENCE' => [ 277, 3, 1, 0 ],
+ 'CRITBINOM' => [ 278, 3, 1, 0 ],
+ 'EVEN' => [ 279, 1, 1, 0 ],
+ 'EXPONDIST' => [ 280, 3, 1, 0 ],
+ 'FDIST' => [ 281, 3, 1, 0 ],
+ 'FINV' => [ 282, 3, 1, 0 ],
+ 'FISHER' => [ 283, 1, 1, 0 ],
+ 'FISHERINV' => [ 284, 1, 1, 0 ],
+ 'FLOOR' => [ 285, 2, 1, 0 ],
+ 'GAMMADIST' => [ 286, 4, 1, 0 ],
+ 'GAMMAINV' => [ 287, 3, 1, 0 ],
+ 'CEILING' => [ 288, 2, 1, 0 ],
+ 'HYPGEOMDIST' => [ 289, 4, 1, 0 ],
+ 'LOGNORMDIST' => [ 290, 3, 1, 0 ],
+ 'LOGINV' => [ 291, 3, 1, 0 ],
+ 'NEGBINOMDIST' => [ 292, 3, 1, 0 ],
+ 'NORMDIST' => [ 293, 4, 1, 0 ],
+ 'NORMSDIST' => [ 294, 1, 1, 0 ],
+ 'NORMINV' => [ 295, 3, 1, 0 ],
+ 'NORMSINV' => [ 296, 1, 1, 0 ],
+ 'STANDARDIZE' => [ 297, 3, 1, 0 ],
+ 'ODD' => [ 298, 1, 1, 0 ],
+ 'PERMUT' => [ 299, 2, 1, 0 ],
+ 'POISSON' => [ 300, 3, 1, 0 ],
+ 'TDIST' => [ 301, 3, 1, 0 ],
+ 'WEIBULL' => [ 302, 4, 1, 0 ],
+ 'SUMXMY2' => [ 303, 2, 2, 0 ],
+ 'SUMX2MY2' => [ 304, 2, 2, 0 ],
+ 'SUMX2PY2' => [ 305, 2, 2, 0 ],
+ 'CHITEST' => [ 306, 2, 2, 0 ],
+ 'CORREL' => [ 307, 2, 2, 0 ],
+ 'COVAR' => [ 308, 2, 2, 0 ],
+ 'FORECAST' => [ 309, 3, 2, 0 ],
+ 'FTEST' => [ 310, 2, 2, 0 ],
+ 'INTERCEPT' => [ 311, 2, 2, 0 ],
+ 'PEARSON' => [ 312, 2, 2, 0 ],
+ 'RSQ' => [ 313, 2, 2, 0 ],
+ 'STEYX' => [ 314, 2, 2, 0 ],
+ 'SLOPE' => [ 315, 2, 2, 0 ],
+ 'TTEST' => [ 316, 4, 2, 0 ],
+ 'PROB' => [ 317, -1, 2, 0 ],
+ 'DEVSQ' => [ 318, -1, 0, 0 ],
+ 'GEOMEAN' => [ 319, -1, 0, 0 ],
+ 'HARMEAN' => [ 320, -1, 0, 0 ],
+ 'SUMSQ' => [ 321, -1, 0, 0 ],
+ 'KURT' => [ 322, -1, 0, 0 ],
+ 'SKEW' => [ 323, -1, 0, 0 ],
+ 'ZTEST' => [ 324, -1, 0, 0 ],
+ 'LARGE' => [ 325, 2, 0, 0 ],
+ 'SMALL' => [ 326, 2, 0, 0 ],
+ 'QUARTILE' => [ 327, 2, 0, 0 ],
+ 'PERCENTILE' => [ 328, 2, 0, 0 ],
+ 'PERCENTRANK' => [ 329, -1, 0, 0 ],
+ 'MODE' => [ 330, -1, 2, 0 ],
+ 'TRIMMEAN' => [ 331, 2, 0, 0 ],
+ 'TINV' => [ 332, 2, 1, 0 ],
+ 'CONCATENATE' => [ 336, -1, 1, 0 ],
+ 'POWER' => [ 337, 2, 1, 0 ],
+ 'RADIANS' => [ 342, 1, 1, 0 ],
+ 'DEGREES' => [ 343, 1, 1, 0 ],
+ 'SUBTOTAL' => [ 344, -1, 0, 0 ],
+ 'SUMIF' => [ 345, -1, 0, 0 ],
+ 'COUNTIF' => [ 346, 2, 0, 0 ],
+ 'COUNTBLANK' => [ 347, 1, 0, 0 ],
+ 'ROMAN' => [ 354, -1, 1, 0 ],
+ );
+
+}
+
+
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+Formula - A class for generating Excel formulas
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel
+
+=head1 DESCRIPTION
+
+This module is used by Spreadsheet::WriteExcel. You do not need to use it directly.
+
+
+=head1 NOTES
+
+The following notes are to help developers and maintainers understand the sequence of operation. They are also intended as a pro-memoria for the author. ;-)
+
+Spreadsheet::WriteExcel::Formula converts a textual representation of a formula into the pre-parsed binary format that Excel uses to store formulas. For example C<1+2*3> is stored as follows: C<1E 01 00 1E 02 00 1E 03 00 05 03>.
+
+This string is comprised of operators and operands arranged in a reverse-Polish format. The meaning of the tokens in the above example is shown in the following table:
+
+ Token Name Value
+ 1E ptgInt 0001 (stored as 01 00)
+ 1E ptgInt 0002 (stored as 02 00)
+ 1E ptgInt 0003 (stored as 03 00)
+ 05 ptgMul
+ 03 ptgAdd
+
+The tokens and token names are defined in the "Excel Developer's Kit" from Microsoft Press. C<ptg> stands for Parse ThinG (as in "That lexer can't grok it, it's a parse thang.")
+
+In general the tokens fall into two categories: operators such as C<ptgMul> and operands such as C<ptgInt>. When the formula is evaluated by Excel the operand tokens push values onto a stack. The operator tokens then pop the required number of operands off of the stack, perform an operation and push the resulting value back onto the stack. This methodology is similar to the basic operation of a reverse-Polish (RPN) calculator.
+
+Spreadsheet::WriteExcel::Formula parses a formula using a C<Parse::RecDescent> parser (at a later stage it may use a C<Parse::Yapp> parser or C<Parse::FastDescent>).
+
+The parser converts the textual representation of a formula into a parse tree. Thus, C<1+2*3> is converted into something like the following, C<e> stands for expression:
+
+ e
+ / | \
+ 1 + e
+ / | \
+ 2 * 3
+
+
+The function C<_reverse_tree()> recurses down through this structure swapping the order of operators followed by operands to produce a reverse-Polish tree. In other words the formula is converted from in-fix notation to post-fix. Following the above example the resulting tree would look like this:
+
+
+ e
+ / | \
+ 1 e +
+ / | \
+ 2 3 *
+
+The result of the recursion is a single array of tokens. In our example the simplified form would look like the following:
+
+ (1, 2, 3, *, +)
+
+The actual return value contains some additional information to help in the secondary parsing stage:
+
+ (_num, 1, _num, 2, _num, 3, ptgMul, ptgAdd, _arg, 1)
+
+The additional tokens are:
+
+ Token Meaning
+ _num The next token is a number
+ _str The next token is a string
+ _ref2d The next token is a 2d cell reference
+ _ref3d The next token is a 3d cell reference
+ _range2d The next token is a 2d range
+ _range3d The next token is a 3d range
+ _func The next token is a function
+ _arg The next token is the number of args for a function
+ _class The next token is a function name
+ _vol The formula contains a voltile function
+
+The C<_arg> token is generated for all lists but is only used for functions that take a variable number of arguments.
+
+The C<_class> token indicates the start of the arguments to a function. This allows the post-processor to decide the "class" of the ref and range arguments that the function takes. The class can be reference, value or array. Since function calls can be nested, the class variable is stored on a stack in the C<@class> array. The class of the ref or range is then read as the top element of the stack C<$class[-1]>. When a C<_func> is read it pops the class value.
+
+Certain Excel functions such as RAND() and NOW() are designated as volatile and must be recalculated by Excel every time that a cell is updated. Any formulas that contain one of these functions has a specially formatted C<ptgAttr> tag prepended to it to indicate that it is volatile.
+
+A secondary parsing stage is carried out by C<parse_tokens()> which converts these tokens into a binary string. For the C<1+2*3> example this would give:
+
+ 1E 01 00 1E 02 00 1E 03 00 05 03
+
+This two-pass method could probably have been reduced to a single pass through the C<Parse::RecDescent> parser. However, it was easier to develop and debug this way.
+
+The token values and formula values are stored in the C<%ptg> and C<%functions> hashes. These hashes and the parser object C<$parser> are exposed as global data. This breaks the OO encapsulation, but means that they can be shared by several instances of Spreadsheet::WriteExcel called from the same program.
+
+Non-English function names can be added to the C<%functions> hash using the C<function_locale.pl> program in the C<examples> directory of the distro. The supported languages are: German, French, Spanish, Portuguese, Dutch, Finnish, Italian and Swedish. These languages are not added by default because there are conflicts between functions names in different languages.
+
+The parser is initialised by C<_init_parser()>. The initialisation is delayed until the first formula is parsed. This eliminates the overhead of generating the parser in programs that are not processing formulas. (The parser should really be pre-compiled, this is to-do when the grammar stabilises).
+
+
+
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/OLEwriter.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/OLEwriter.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/OLEwriter.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,447 +1,447 @@
-package Spreadsheet::WriteExcel::OLEwriter;
-
-###############################################################################
-#
-# OLEwriter - A writer class to store BIFF data in a OLE compound storage file.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-use Carp;
-use FileHandle;
-
-
-
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Exporter);
-
-$VERSION = '2.01';
-
-###############################################################################
-#
-# new()
-#
-# Constructor
-#
-sub new {
-
- my $class = shift;
- my $self = {
- _olefilename => $_[0],
- _filehandle => "",
- _fileclosed => 0,
- _internal_fh => 0,
- _biff_only => 0,
- _size_allowed => 0,
- _biffsize => 0,
- _booksize => 0,
- _big_blocks => 0,
- _list_blocks => 0,
- _root_start => 0,
- _block_count => 4,
- };
-
- bless $self, $class;
- $self->_initialize();
- return $self;
-}
-
-
-###############################################################################
-#
-# _initialize()
-#
-# Create a new filehandle or use the provided filehandle.
-#
-sub _initialize {
-
- my $self = shift;
- my $olefile = $self->{_olefilename};
- my $fh;
-
- # If the filename is a reference it is assumed that it is a valid
- # filehandle, if not we create a filehandle.
- #
- if (ref($olefile)) {
- $fh = $olefile;
- }
- else{
-
- # Create a new file, open for writing
- $fh = FileHandle->new("> $olefile");
-
- # Workbook.pm also checks this but something may have happened since
- # then.
- if (not defined $fh) {
- croak "Can't open $olefile. It may be in use or protected.\n";
- }
-
- # binmode file whether platform requires it or not
- binmode($fh);
-
- $self->{_internal_fh} = 1;
- }
-
- # Store filehandle
- $self->{_filehandle} = $fh;
-}
-
-
-###############################################################################
-#
-# set_size($biffsize)
-#
-# Set the size of the data to be written to the OLE stream
-#
-# $big_blocks = (109 depot block x (128 -1 marker word)
-# - (1 x end words)) = 13842
-# $maxsize = $big_blocks * 512 bytes = 7087104
-#
-sub set_size {
-
- my $self = shift;
- my $maxsize = 7_087_104; # Use Spreadsheet::WriteExcel::Big to exceed this
-
- if ($_[0] > $maxsize) {
- return $self->{_size_allowed} = 0;
- }
-
- $self->{_biffsize} = $_[0];
-
- # Set the min file size to 4k to avoid having to use small blocks
- if ($_[0] > 4096) {
- $self->{_booksize} = $_[0];
- }
- else {
- $self->{_booksize} = 4096;
- }
-
- return $self->{_size_allowed} = 1;
-
-}
-
-
-###############################################################################
-#
-# _calculate_sizes()
-#
-# Calculate various sizes needed for the OLE stream
-#
-sub _calculate_sizes {
-
- my $self = shift;
- my $datasize = $self->{_booksize};
-
- if ($datasize % 512 == 0) {
- $self->{_big_blocks} = $datasize/512;
- }
- else {
- $self->{_big_blocks} = int($datasize/512) +1;
- }
- # There are 127 list blocks and 1 marker blocks for each big block
- # depot + 1 end of chain block
- $self->{_list_blocks} = int(($self->{_big_blocks})/127) +1;
- $self->{_root_start} = $self->{_big_blocks};
-}
-
-
-###############################################################################
-#
-# close()
-#
-# Write root entry, big block list and close the filehandle.
-# This routine is used to explicitly close the open filehandle without
-# having to wait for DESTROY.
-#
-sub close {
-
- my $self = shift;
-
- return if not $self->{_size_allowed};
-
- $self->_write_padding() if not $self->{_biff_only};
- $self->_write_property_storage() if not $self->{_biff_only};
- $self->_write_big_block_depot() if not $self->{_biff_only};
-
- my $close;
-
- # Close the filehandle if it was created internally.
- $close = CORE::close($self->{_filehandle}) if $self->{_internal_fh};
-
- $self->{_fileclosed} = 1;
-
- return $close;
-}
-
-
-###############################################################################
-#
-# DESTROY()
-#
-# Close the filehandle if it hasn't already been explicitly closed.
-#
-sub DESTROY {
-
- my $self = shift;
-
- $self->close() unless $self->{_fileclosed};
-}
-
-
-###############################################################################
-#
-# write($data)
-#
-# Write BIFF data to OLE file.
-#
-sub write {
-
- my $self = shift;
-
- # Protect print() from -l on the command line.
- local $\ = undef;
- print {$self->{_filehandle}} $_[0];
-}
-
-
-###############################################################################
-#
-# write_header()
-#
-# Write OLE header block.
-#
-sub write_header {
-
- my $self = shift;
-
- return if $self->{_biff_only};
- $self->_calculate_sizes();
-
- my $root_start = $self->{_root_start};
- my $num_lists = $self->{_list_blocks};
-
- my $id = pack("NN", 0xD0CF11E0, 0xA1B11AE1);
- my $unknown1 = pack("VVVV", 0x00, 0x00, 0x00, 0x00);
- my $unknown2 = pack("vv", 0x3E, 0x03);
- my $unknown3 = pack("v", -2);
- my $unknown4 = pack("v", 0x09);
- my $unknown5 = pack("VVV", 0x06, 0x00, 0x00);
- my $num_bbd_blocks = pack("V", $num_lists);
- my $root_startblock = pack("V", $root_start);
- my $unknown6 = pack("VV", 0x00, 0x1000);
- my $sbd_startblock = pack("V", -2);
- my $unknown7 = pack("VVV", 0x00, -2 ,0x00);
- my $unused = pack("V", -1);
-
- # Protect print() from -l on the command line.
- local $\ = undef;
-
- print {$self->{_filehandle}} $id;
- print {$self->{_filehandle}} $unknown1;
- print {$self->{_filehandle}} $unknown2;
- print {$self->{_filehandle}} $unknown3;
- print {$self->{_filehandle}} $unknown4;
- print {$self->{_filehandle}} $unknown5;
- print {$self->{_filehandle}} $num_bbd_blocks;
- print {$self->{_filehandle}} $root_startblock;
- print {$self->{_filehandle}} $unknown6;
- print {$self->{_filehandle}} $sbd_startblock;
- print {$self->{_filehandle}} $unknown7;
-
- for (1..$num_lists) {
- $root_start++;
- print {$self->{_filehandle}} pack("V", $root_start);
- }
-
- for ($num_lists..108) {
- print {$self->{_filehandle}} $unused;
- }
-}
-
-
-###############################################################################
-#
-# _write_big_block_depot()
-#
-# Write big block depot.
-#
-sub _write_big_block_depot {
-
- my $self = shift;
- my $num_blocks = $self->{_big_blocks};
- my $num_lists = $self->{_list_blocks};
- my $total_blocks = $num_lists *128;
- my $used_blocks = $num_blocks + $num_lists +2;
-
- my $marker = pack("V", -3);
- my $end_of_chain = pack("V", -2);
- my $unused = pack("V", -1);
-
-
- # Protect print() from -l on the command line.
- local $\ = undef;
-
- for my $i (1..$num_blocks-1) {
- print {$self->{_filehandle}} pack("V",$i);
- }
-
- print {$self->{_filehandle}} $end_of_chain;
- print {$self->{_filehandle}} $end_of_chain;
-
- for (1..$num_lists) {
- print {$self->{_filehandle}} $marker;
- }
-
- for ($used_blocks..$total_blocks) {
- print {$self->{_filehandle}} $unused;
- }
-}
-
-
-###############################################################################
-#
-# _write_property_storage()
-#
-# Write property storage. TODO: add summary sheets
-#
-sub _write_property_storage {
-
- my $self = shift;
-
- my $rootsize = -2;
- my $booksize = $self->{_booksize};
-
- ################# name type dir start size
- $self->_write_pps('Root Entry', 0x05, 1, -2, 0x00);
- $self->_write_pps('Book', 0x02, -1, 0x00, $booksize);
- $self->_write_pps('', 0x00, -1, 0x00, 0x0000);
- $self->_write_pps('', 0x00, -1, 0x00, 0x0000);
-}
-
-
-###############################################################################
-#
-# _write_pps()
-#
-# Write property sheet in property storage
-#
-sub _write_pps {
-
- my $self = shift;
-
- my $name = $_[0];
- my @name = ();
- my $length = 0;
-
- if ($name ne '') {
- $name = $_[0] . "\0";
- # Simulate a Unicode string
- @name = map(ord, split('', $name));
- $length = length($name) * 2;
- }
-
- my $rawname = pack("v*", @name);
- my $zero = pack("C", 0);
-
- my $pps_sizeofname = pack("v", $length); #0x40
- my $pps_type = pack("v", $_[1]); #0x42
- my $pps_prev = pack("V", -1); #0x44
- my $pps_next = pack("V", -1); #0x48
- my $pps_dir = pack("V", $_[2]); #0x4c
-
- my $unknown1 = pack("V", 0);
-
- my $pps_ts1s = pack("V", 0); #0x64
- my $pps_ts1d = pack("V", 0); #0x68
- my $pps_ts2s = pack("V", 0); #0x6c
- my $pps_ts2d = pack("V", 0); #0x70
- my $pps_sb = pack("V", $_[3]); #0x74
- my $pps_size = pack("V", $_[4]); #0x78
-
-
- # Protect print() from -l on the command line.
- local $\ = undef;
-
- print {$self->{_filehandle}} $rawname;
- print {$self->{_filehandle}} $zero x (64 -$length);
- print {$self->{_filehandle}} $pps_sizeofname;
- print {$self->{_filehandle}} $pps_type;
- print {$self->{_filehandle}} $pps_prev;
- print {$self->{_filehandle}} $pps_next;
- print {$self->{_filehandle}} $pps_dir;
- print {$self->{_filehandle}} $unknown1 x 5;
- print {$self->{_filehandle}} $pps_ts1s;
- print {$self->{_filehandle}} $pps_ts1d;
- print {$self->{_filehandle}} $pps_ts2d;
- print {$self->{_filehandle}} $pps_ts2d;
- print {$self->{_filehandle}} $pps_sb;
- print {$self->{_filehandle}} $pps_size;
- print {$self->{_filehandle}} $unknown1;
-}
-
-
-###############################################################################
-#
-# _write_padding()
-#
-# Pad the end of the file
-#
-sub _write_padding {
-
- my $self = shift;
- my $biffsize = $self->{_biffsize};
- my $min_size;
-
- if ($biffsize < 4096) {
- $min_size = 4096;
- }
- else {
- $min_size = 512;
- }
-
- # Protect print() from -l on the command line.
- local $\ = undef;
-
- if ($biffsize % $min_size != 0) {
- my $padding = $min_size - ($biffsize % $min_size);
- print {$self->{_filehandle}} "\0" x $padding;
- }
-}
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-OLEwriter - A writer class to store BIFF data in a OLE compound storage file.
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel
-
-=head1 DESCRIPTION
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
+package Spreadsheet::WriteExcel::OLEwriter;
+
+###############################################################################
+#
+# OLEwriter - A writer class to store BIFF data in a OLE compound storage file.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+use Carp;
+use FileHandle;
+
+
+
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Exporter);
+
+$VERSION = '2.01';
+
+###############################################################################
+#
+# new()
+#
+# Constructor
+#
+sub new {
+
+ my $class = shift;
+ my $self = {
+ _olefilename => $_[0],
+ _filehandle => "",
+ _fileclosed => 0,
+ _internal_fh => 0,
+ _biff_only => 0,
+ _size_allowed => 0,
+ _biffsize => 0,
+ _booksize => 0,
+ _big_blocks => 0,
+ _list_blocks => 0,
+ _root_start => 0,
+ _block_count => 4,
+ };
+
+ bless $self, $class;
+ $self->_initialize();
+ return $self;
+}
+
+
+###############################################################################
+#
+# _initialize()
+#
+# Create a new filehandle or use the provided filehandle.
+#
+sub _initialize {
+
+ my $self = shift;
+ my $olefile = $self->{_olefilename};
+ my $fh;
+
+ # If the filename is a reference it is assumed that it is a valid
+ # filehandle, if not we create a filehandle.
+ #
+ if (ref($olefile)) {
+ $fh = $olefile;
+ }
+ else{
+
+ # Create a new file, open for writing
+ $fh = FileHandle->new("> $olefile");
+
+ # Workbook.pm also checks this but something may have happened since
+ # then.
+ if (not defined $fh) {
+ croak "Can't open $olefile. It may be in use or protected.\n";
+ }
+
+ # binmode file whether platform requires it or not
+ binmode($fh);
+
+ $self->{_internal_fh} = 1;
+ }
+
+ # Store filehandle
+ $self->{_filehandle} = $fh;
+}
+
+
+###############################################################################
+#
+# set_size($biffsize)
+#
+# Set the size of the data to be written to the OLE stream
+#
+# $big_blocks = (109 depot block x (128 -1 marker word)
+# - (1 x end words)) = 13842
+# $maxsize = $big_blocks * 512 bytes = 7087104
+#
+sub set_size {
+
+ my $self = shift;
+ my $maxsize = 7_087_104; # Use Spreadsheet::WriteExcel::Big to exceed this
+
+ if ($_[0] > $maxsize) {
+ return $self->{_size_allowed} = 0;
+ }
+
+ $self->{_biffsize} = $_[0];
+
+ # Set the min file size to 4k to avoid having to use small blocks
+ if ($_[0] > 4096) {
+ $self->{_booksize} = $_[0];
+ }
+ else {
+ $self->{_booksize} = 4096;
+ }
+
+ return $self->{_size_allowed} = 1;
+
+}
+
+
+###############################################################################
+#
+# _calculate_sizes()
+#
+# Calculate various sizes needed for the OLE stream
+#
+sub _calculate_sizes {
+
+ my $self = shift;
+ my $datasize = $self->{_booksize};
+
+ if ($datasize % 512 == 0) {
+ $self->{_big_blocks} = $datasize/512;
+ }
+ else {
+ $self->{_big_blocks} = int($datasize/512) +1;
+ }
+ # There are 127 list blocks and 1 marker blocks for each big block
+ # depot + 1 end of chain block
+ $self->{_list_blocks} = int(($self->{_big_blocks})/127) +1;
+ $self->{_root_start} = $self->{_big_blocks};
+}
+
+
+###############################################################################
+#
+# close()
+#
+# Write root entry, big block list and close the filehandle.
+# This routine is used to explicitly close the open filehandle without
+# having to wait for DESTROY.
+#
+sub close {
+
+ my $self = shift;
+
+ return if not $self->{_size_allowed};
+
+ $self->_write_padding() if not $self->{_biff_only};
+ $self->_write_property_storage() if not $self->{_biff_only};
+ $self->_write_big_block_depot() if not $self->{_biff_only};
+
+ my $close;
+
+ # Close the filehandle if it was created internally.
+ $close = CORE::close($self->{_filehandle}) if $self->{_internal_fh};
+
+ $self->{_fileclosed} = 1;
+
+ return $close;
+}
+
+
+###############################################################################
+#
+# DESTROY()
+#
+# Close the filehandle if it hasn't already been explicitly closed.
+#
+sub DESTROY {
+
+ my $self = shift;
+
+ $self->close() unless $self->{_fileclosed};
+}
+
+
+###############################################################################
+#
+# write($data)
+#
+# Write BIFF data to OLE file.
+#
+sub write {
+
+ my $self = shift;
+
+ # Protect print() from -l on the command line.
+ local $\ = undef;
+ print {$self->{_filehandle}} $_[0];
+}
+
+
+###############################################################################
+#
+# write_header()
+#
+# Write OLE header block.
+#
+sub write_header {
+
+ my $self = shift;
+
+ return if $self->{_biff_only};
+ $self->_calculate_sizes();
+
+ my $root_start = $self->{_root_start};
+ my $num_lists = $self->{_list_blocks};
+
+ my $id = pack("NN", 0xD0CF11E0, 0xA1B11AE1);
+ my $unknown1 = pack("VVVV", 0x00, 0x00, 0x00, 0x00);
+ my $unknown2 = pack("vv", 0x3E, 0x03);
+ my $unknown3 = pack("v", -2);
+ my $unknown4 = pack("v", 0x09);
+ my $unknown5 = pack("VVV", 0x06, 0x00, 0x00);
+ my $num_bbd_blocks = pack("V", $num_lists);
+ my $root_startblock = pack("V", $root_start);
+ my $unknown6 = pack("VV", 0x00, 0x1000);
+ my $sbd_startblock = pack("V", -2);
+ my $unknown7 = pack("VVV", 0x00, -2 ,0x00);
+ my $unused = pack("V", -1);
+
+ # Protect print() from -l on the command line.
+ local $\ = undef;
+
+ print {$self->{_filehandle}} $id;
+ print {$self->{_filehandle}} $unknown1;
+ print {$self->{_filehandle}} $unknown2;
+ print {$self->{_filehandle}} $unknown3;
+ print {$self->{_filehandle}} $unknown4;
+ print {$self->{_filehandle}} $unknown5;
+ print {$self->{_filehandle}} $num_bbd_blocks;
+ print {$self->{_filehandle}} $root_startblock;
+ print {$self->{_filehandle}} $unknown6;
+ print {$self->{_filehandle}} $sbd_startblock;
+ print {$self->{_filehandle}} $unknown7;
+
+ for (1..$num_lists) {
+ $root_start++;
+ print {$self->{_filehandle}} pack("V", $root_start);
+ }
+
+ for ($num_lists..108) {
+ print {$self->{_filehandle}} $unused;
+ }
+}
+
+
+###############################################################################
+#
+# _write_big_block_depot()
+#
+# Write big block depot.
+#
+sub _write_big_block_depot {
+
+ my $self = shift;
+ my $num_blocks = $self->{_big_blocks};
+ my $num_lists = $self->{_list_blocks};
+ my $total_blocks = $num_lists *128;
+ my $used_blocks = $num_blocks + $num_lists +2;
+
+ my $marker = pack("V", -3);
+ my $end_of_chain = pack("V", -2);
+ my $unused = pack("V", -1);
+
+
+ # Protect print() from -l on the command line.
+ local $\ = undef;
+
+ for my $i (1..$num_blocks-1) {
+ print {$self->{_filehandle}} pack("V",$i);
+ }
+
+ print {$self->{_filehandle}} $end_of_chain;
+ print {$self->{_filehandle}} $end_of_chain;
+
+ for (1..$num_lists) {
+ print {$self->{_filehandle}} $marker;
+ }
+
+ for ($used_blocks..$total_blocks) {
+ print {$self->{_filehandle}} $unused;
+ }
+}
+
+
+###############################################################################
+#
+# _write_property_storage()
+#
+# Write property storage. TODO: add summary sheets
+#
+sub _write_property_storage {
+
+ my $self = shift;
+
+ my $rootsize = -2;
+ my $booksize = $self->{_booksize};
+
+ ################# name type dir start size
+ $self->_write_pps('Root Entry', 0x05, 1, -2, 0x00);
+ $self->_write_pps('Book', 0x02, -1, 0x00, $booksize);
+ $self->_write_pps('', 0x00, -1, 0x00, 0x0000);
+ $self->_write_pps('', 0x00, -1, 0x00, 0x0000);
+}
+
+
+###############################################################################
+#
+# _write_pps()
+#
+# Write property sheet in property storage
+#
+sub _write_pps {
+
+ my $self = shift;
+
+ my $name = $_[0];
+ my @name = ();
+ my $length = 0;
+
+ if ($name ne '') {
+ $name = $_[0] . "\0";
+ # Simulate a Unicode string
+ @name = map(ord, split('', $name));
+ $length = length($name) * 2;
+ }
+
+ my $rawname = pack("v*", @name);
+ my $zero = pack("C", 0);
+
+ my $pps_sizeofname = pack("v", $length); #0x40
+ my $pps_type = pack("v", $_[1]); #0x42
+ my $pps_prev = pack("V", -1); #0x44
+ my $pps_next = pack("V", -1); #0x48
+ my $pps_dir = pack("V", $_[2]); #0x4c
+
+ my $unknown1 = pack("V", 0);
+
+ my $pps_ts1s = pack("V", 0); #0x64
+ my $pps_ts1d = pack("V", 0); #0x68
+ my $pps_ts2s = pack("V", 0); #0x6c
+ my $pps_ts2d = pack("V", 0); #0x70
+ my $pps_sb = pack("V", $_[3]); #0x74
+ my $pps_size = pack("V", $_[4]); #0x78
+
+
+ # Protect print() from -l on the command line.
+ local $\ = undef;
+
+ print {$self->{_filehandle}} $rawname;
+ print {$self->{_filehandle}} $zero x (64 -$length);
+ print {$self->{_filehandle}} $pps_sizeofname;
+ print {$self->{_filehandle}} $pps_type;
+ print {$self->{_filehandle}} $pps_prev;
+ print {$self->{_filehandle}} $pps_next;
+ print {$self->{_filehandle}} $pps_dir;
+ print {$self->{_filehandle}} $unknown1 x 5;
+ print {$self->{_filehandle}} $pps_ts1s;
+ print {$self->{_filehandle}} $pps_ts1d;
+ print {$self->{_filehandle}} $pps_ts2d;
+ print {$self->{_filehandle}} $pps_ts2d;
+ print {$self->{_filehandle}} $pps_sb;
+ print {$self->{_filehandle}} $pps_size;
+ print {$self->{_filehandle}} $unknown1;
+}
+
+
+###############################################################################
+#
+# _write_padding()
+#
+# Pad the end of the file
+#
+sub _write_padding {
+
+ my $self = shift;
+ my $biffsize = $self->{_biffsize};
+ my $min_size;
+
+ if ($biffsize < 4096) {
+ $min_size = 4096;
+ }
+ else {
+ $min_size = 512;
+ }
+
+ # Protect print() from -l on the command line.
+ local $\ = undef;
+
+ if ($biffsize % $min_size != 0) {
+ my $padding = $min_size - ($biffsize % $min_size);
+ print {$self->{_filehandle}} "\0" x $padding;
+ }
+}
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+OLEwriter - A writer class to store BIFF data in a OLE compound storage file.
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel
+
+=head1 DESCRIPTION
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Utility.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Utility.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Utility.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,884 +1,884 @@
-package Spreadsheet::WriteExcel::Utility;
-
-###############################################################################
-#
-# Utility - Helper functions for Spreadsheet::WriteExcel.
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-#
-
-use Exporter;
-use strict;
-use autouse 'Date::Calc' => qw(Delta_DHMS Decode_Date_EU Decode_Date_US);
-use autouse 'Date::Manip' => qw(ParseDate Date_Init);
-
-
-# Do all of the export preparation
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
-
-# Row and column functions
-my @rowcol = qw(
- xl_rowcol_to_cell
- xl_cell_to_rowcol
- xl_inc_row
- xl_dec_row
- xl_inc_col
- xl_dec_col
- );
-
-# Date and Time functions
-my @dates = qw(
- xl_date_list
- xl_date_1904
- xl_parse_time
- xl_parse_date
- xl_parse_date_init
- xl_decode_date_EU
- xl_decode_date_US
- );
-
-
- at ISA = qw(Exporter);
- at EXPORT_OK = ();
- at EXPORT = (@rowcol, @dates);
-%EXPORT_TAGS = (
- rowcol => \@rowcol,
- dates => \@dates
- );
-
-$VERSION = '2.01';
-
-
-
-
-=head1 NAME
-
-Utility - Helper functions for Spreadsheet::WriteExcel.
-
-
-
-
-=head1 VERSION
-
-This document refers to version 0.03 of Spreadsheet::WriteExcel::Utility, released March, 2002.
-
-
-
-=head1 SYNOPSIS
-
-Functions to help with some common tasks when using Spreadsheet::WriteExcel.
-
-These functions mainly relate to dealing with rows and columns in A1 notation and to handling dates and times.
-
- use Spreadsheet::WriteExcel::Utility; # Import everything
-
- ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
- $str = xl_rowcol_to_cell(1, 2); # C2
- $str = xl_inc_col('Z1' ); # AA1
- $str = xl_dec_col('AA1' ); # Z1
-
- $date = xl_date_list(2002, 1, 1); # 37257
- $date = xl_parse_date("11 July 1997"); # 35622
- $time = xl_parse_time('3:21:36 PM'); # 0.64
- $date = xl_decode_date_EU("13 May 2002"); # 37389
-
-
-
-
-=head1 DESCRIPTION
-
-This module provides a set of functions to help with some common tasks encountered when using the Spreadsheet::WriteExcel module. The two main categories of function are:
-
-Row and column functions: these are used to deal with Excel's A1 representation of cells. The functions in this category are:
-
- xl_rowcol_to_cell
- xl_cell_to_rowcol
- xl_inc_row
- xl_dec_row
- xl_inc_col
- xl_dec_col
-
-Date and Time functions: these are used to convert dates and times to the numeric format used by Excel. The functions in this category are:
-
- xl_date_list
- xl_date_1904
- xl_parse_time
- xl_parse_date
- xl_parse_date_init
- xl_decode_date_EU
- xl_decode_date_US
-
-All of these functions are exported by default. However, you can use import lists if you wish to limit the functions that are imported:
-
- use Spreadsheet::WriteExcel::Utility; # Import everything
- use Spreadsheet::WriteExcel::Utility qw(xl_date_list); # xl_date_list only
- use Spreadsheet::WriteExcel::Utility qw(:rowcol); # Row/col functions
- use Spreadsheet::WriteExcel::Utility qw(:dates); # Date functions
-
-
-
-=head1 ROW AND COLUMN FUNCTIONS
-
-
-Spreadsheet::WriteExcel supports two forms of notation to designate the position of cells: Row-column notation and A1 notation.
-
-Row-column notation uses a zero based index for both row and column while A1 notation uses the standard Excel alphanumeric sequence of column letter and 1-based row. Columns range from A to IV i.e. 0 to 255, rows range from 1 to 16384 in Excel 5 and 65536 in Excel 97. For example:
-
- (0, 0) # The top left cell in row-column notation.
- ('A1') # The top left cell in A1 notation.
-
- (1999, 29) # Row-column notation.
- ('AD2000') # The same cell in A1 notation.
-
-Row-column notation is useful if you are referring to cells programmatically:
-
- for my $i (0 .. 9) {
- $worksheet->write($i, 0, 'Hello'); # Cells A1 to A10
- }
-
-A1 notation is useful for setting up a worksheet manually and for working with formulas:
-
- $worksheet->write('H1', 200);
- $worksheet->write('H2', '=H7+1');
-
-The functions in the following sections can be used for dealing with A1 notation, for example:
-
- ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
- $str = xl_rowcol_to_cell(1, 2); # C2
-
-
-Cell references in Excel can be either relative or absolute. Absolute references are prefixed by the dollar symbol as shown below:
-
- A1 # Column and row are relative
- $A1 # Column is absolute and row is relative
- A$1 # Column is relative and row is absolute
- $A$1 # Column and row are absolute
-
-An absolute reference only has an effect if the cell is copied. Refer to the Excel documentation for further details. All of the following functions support absolute references.
-
-=cut
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_rowcol_to_cell($row, $col, $row_absolute, $col_absolute)
-
- Parameters: $row: Integer
- $col: Integer
- $row_absolute: Boolean (1/0) [optional, default is 0]
- $col_absolute: Boolean (1/0) [optional, default is 0]
-
- Returns: A string in A1 cell notation
-
-
-This function converts a zero based row and column cell reference to a A1 style string:
-
- $str = xl_rowcol_to_cell(0, 0); # A1
- $str = xl_rowcol_to_cell(0, 1); # B1
- $str = xl_rowcol_to_cell(1, 0); # A2
-
-
-The optional parameters C<$row_absolute> and C<$col_absolute> can be used to indicate if the row or column is absolute:
-
- $str = xl_rowcol_to_cell(0, 0, 0, 1); # $A1
- $str = xl_rowcol_to_cell(0, 0, 1, 0); # A$1
- $str = xl_rowcol_to_cell(0, 0, 1, 1); # $A$1
-
-See L<ROW AND COLUMN FUNCTIONS> for an explanation of absolute cell references.
-
-
-=cut
-###############################################################################
-#
-# xl_rowcol_to_cell($row, $col, $row_absolute, $col_absolute)
-#
-sub xl_rowcol_to_cell {
-
- my $row = $_[0];
- my $col = $_[1];
- my $row_abs = $_[2] ? '$' : '';
- my $col_abs = $_[3] ? '$' : '';
-
-
- my $int = int ($col / 26);
- my $frac = $col % 26;
-
- my $chr1 =''; # Most significant character in AA1
-
- if ($int > 0) {
- $chr1 = chr( ord('A') + $int -1 );
- }
-
- my $chr2 = chr( ord('A') + $frac );
-
- # Zero index to 1-index
- $row++;
-
- return $col_abs . $chr1 . $chr2 . $row_abs. $row;
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_cell_to_rowcol($string)
-
-
- Parameters: $string String in A1 format
-
- Returns: List ($row, $col)
-
-This function converts an Excel cell reference in A1 notation to a zero based row and column. The function will also handle Excel's absolute, C<$>, cell notation.
-
- my ($row, $col) = xl_cell_to_rowcol('A1'); # (0, 0)
- my ($row, $col) = xl_cell_to_rowcol('B1'); # (0, 1)
- my ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
- my ($row, $col) = xl_cell_to_rowcol('$C2' ); # (1, 2)
- my ($row, $col) = xl_cell_to_rowcol('C$2' ); # (1, 2)
- my ($row, $col) = xl_cell_to_rowcol('$C$2'); # (1, 2)
-
-=cut
-###############################################################################
-#
-# xl_cell_to_rowcol($string)
-#
-# Returns: ($row, $col, $row_absolute, $col_absolute)
-#
-# The $row_absolute and $col_absolute parameters aren't documented because they
-# mainly used internally and aren't very useful to the user.
-#
-sub xl_cell_to_rowcol {
-
- my $cell = shift;
-
- $cell =~ /(\$?)([A-I]?[A-Z])(\$?)(\d+)/;
-
- my $col_abs = $1 eq "" ? 0 : 1;
- my $col = $2;
- my $row_abs = $3 eq "" ? 0 : 1;
- my $row = $4;
-
- # Convert base26 column string to number
- # All your Base are belong to us.
- my @chars = split //, $col;
- my $expn = 0;
- $col = 0;
-
- while (@chars) {
- my $char = pop(@chars); # LS char first
- $col += (ord($char) -ord('A') +1) * (26**$expn);
- $expn++;
- }
-
- # Convert 1-index to zero-index
- $row--;
- $col--;
-
- return $row, $col, $row_abs, $col_abs;
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_inc_row($string)
-
-
- Parameters: $string, a string in A1 format
-
- Returns: Incremented string in A1 format
-
-This functions takes a cell reference string in A1 notation and increments the row. The function will also handle Excel's absolute, C<$>, cell notation:
-
- my $str = xl_inc_row('A1' ); # A2
- my $str = xl_inc_row('B$2' ); # B$3
- my $str = xl_inc_row('$C3' ); # $C4
- my $str = xl_inc_row('$D$4'); # $D$5
-
-
-=cut
-###############################################################################
-#
-# xl_inc_row($string)
-#
-sub xl_inc_row {
-
- my $cell = shift;
- my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
-
- return xl_rowcol_to_cell(++$row, $col, $row_abs, $col_abs);
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_dec_row($string)
-
-
- Parameters: $string, a string in A1 format
-
- Returns: Decremented string in A1 format
-
-This functions takes a cell reference string in A1 notation and decrements the row. The function will also handle Excel's absolute, C<$>, cell notation:
-
- my $str = xl_dec_row('A2' ); # A1
- my $str = xl_dec_row('B$3' ); # B$2
- my $str = xl_dec_row('$C4' ); # $C3
- my $str = xl_dec_row('$D$5'); # $D$4
-
-
-=cut
-###############################################################################
-#
-# xl_dec_row($string)
-#
-# Decrements the row number of an Excel cell reference in A1 notation.
-# For example C4 to C3
-#
-# Returns: a cell reference string.
-#
-sub xl_dec_row {
-
- my $cell = shift;
- my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
-
- return xl_rowcol_to_cell(--$row, $col, $row_abs, $col_abs);
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_inc_col($string)
-
-
- Parameters: $string, a string in A1 format
-
- Returns: Incremented string in A1 format
-
-This functions takes a cell reference string in A1 notation and increments the column. The function will also handle Excel's absolute, C<$>, cell notation:
-
- my $str = xl_inc_col('A1' ); # B1
- my $str = xl_inc_col('Z1' ); # AA1
- my $str = xl_inc_col('$B1' ); # $C1
- my $str = xl_inc_col('$D$5'); # $E$5
-
-
-=cut
-###############################################################################
-#
-# xl_inc_col($string)
-#
-# Increments the column number of an Excel cell reference in A1 notation.
-# For example C3 to D3
-#
-# Returns: a cell reference string.
-#
-sub xl_inc_col {
-
- my $cell = shift;
- my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
-
- return xl_rowcol_to_cell($row, ++$col, $row_abs, $col_abs);
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_dec_col($string)
-
- Parameters: $string, a string in A1 format
-
- Returns: Decremented string in A1 format
-
-This functions takes a cell reference string in A1 notation and decrements the column. The function will also handle Excel's absolute, C<$>, cell notation:
-
- my $str = xl_dec_col('B1' ); # A1
- my $str = xl_dec_col('AA1' ); # Z1
- my $str = xl_dec_col('$C1' ); # $B1
- my $str = xl_dec_col('$E$5'); # $D$5
-
-
-=cut
-###############################################################################
-#
-# xl_dec_col($string)
-#
-sub xl_dec_col {
-
- my $cell = shift;
- my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
-
- return xl_rowcol_to_cell($row, --$col, $row_abs, $col_abs);
-}
-
-
-
-
-=head1 TIME AND DATE FUNCTIONS
-
-
-Dates and times in Excel are represented by real numbers, for example "Jan 1 2001 12:30 AM" is represented by the number 36892.521.
-
-The integer part of the number stores the number of days since the epoch and the fractional part stores the percentage of the day in seconds.
-
-The epoch can be either 1900 or 1904. Excel for Windows uses 1900 and Excel for Macintosh uses 1904. The epochs are:
-
- 1900: 0 January 1900 i.e. 31 December 1899
- 1904: 1 January 1904
-
-Excel on Windows and the Macintosh will convert automatically between one system and the other. By default Spreadsheet::WriteExcel uses the 1900 format. To use the 1904 epoch you must use the C<set_1904()> workbook method, see the Spreadsheet::WriteExcel documentation.
-
-There are two things to note about the 1900 date format. The first is that the epoch starts on 0 January 1900. The second is that the year 1900 is erroneously but deliberately treated as a leap year. Therefore you must add an extra day to dates after 28 February 1900. The functions in the following section will deal with these issues automatically. The reason for this anomaly is explained at http://support.microsoft.com/support/kb/articles/Q181/3/70.asp
-
-Note, a date or time in Excel is like any other number. To display the number as a date you must apply a number format to it: Refer to the C<set_num_format()> method in the Spreadsheet::WriteExcel documentation:
-
- $date = xl_date_list(2001, 1, 1, 12, 30);
- $format->set_num_format('mmm d yyyy hh:mm AM/PM');
- $worksheet->write('A1', $date , $format); # Jan 1 2001 12:30 AM
-
-To use these functions you must install the C<Date::Manip> and C<Date::Calc> modules. See L<REQUIREMENTS> and the individual requirements of each functions.
-
-See also the DateTime::Format::Excel module,http://search.cpan.org/search?dist=DateTime-Format-Excel which is part of the DateTime project and which deals specifically with converting dates and times to and from Excel's format.
-
-
-=cut
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_date_list($years, $months, $days, $hours, $minutes, $seconds)
-
-
- Parameters: $years: Integer
- $months: Integer [optional, default is 1]
- $days: Integer [optional, default is 1]
- $hours: Integer [optional, default is 0]
- $minutes: Integer [optional, default is 0]
- $seconds: Float [optional, default is 0]
-
- Returns: A number that represents an Excel date
- or undef for an invalid date.
-
- Requires: Date::Calc
-
-This function converts an array of data into a number that represents an Excel date. All of the parameters are optional except for C<$years>.
-
- $date1 = xl_date_list(2002, 1, 2); # 2 Jan 2002
- $date2 = xl_date_list(2002, 1, 2, 12); # 2 Jan 2002 12:00 pm
- $date3 = xl_date_list(2002, 1, 2, 12, 30); # 2 Jan 2002 12:30 pm
- $date4 = xl_date_list(2002, 1, 2, 12, 30, 45); # 2 Jan 2002 12:30:45 pm
-
-This function can be used in conjunction with functions that parse date and time strings. In fact it is used in most of the following functions.
-
-
-=cut
-###############################################################################
-#
-# xl_date_list($years, $months, $days, $hours, $minutes, $seconds)
-#
-sub xl_date_list {
-
- return undef unless @_;
-
- my $years = $_[0];
- my $months = $_[1] || 1;
- my $days = $_[2] || 1;
- my $hours = $_[3] || 0;
- my $minutes = $_[4] || 0;
- my $seconds = $_[5] || 0;
-
- my @date = ($years, $months, $days, $hours, $minutes, $seconds);
- my @epoch = (1899, 12, 31, 0, 0, 0);
-
- ($days, $hours, $minutes, $seconds) = Delta_DHMS(@epoch, @date);
-
- my $date = $days + ($hours*3600 +$minutes*60 +$seconds)/(24*60*60);
-
- # Add a day for Excel's missing leap day in 1900
- $date++ if ($date > 59);
-
- return $date;
-}
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_parse_time($string)
-
-
- Parameters: $string, a textual representation of a time
-
- Returns: A number that represents an Excel time
- or undef for an invalid time.
-
-This function converts a time string into a number that represents an Excel time. The following time formats are valid:
-
- hh:mm [AM|PM]
- hh:mm [AM|PM]
- hh:mm:ss [AM|PM]
- hh:mm:ss.ss [AM|PM]
-
-
-The meridian, AM or PM, is optional and case insensitive. A 24 hour time is assumed if the meridian is omitted
-
- $time1 = xl_parse_time('12:18');
- $time2 = xl_parse_time('12:18:14');
- $time3 = xl_parse_time('12:18:14 AM');
- $time4 = xl_parse_time('1:18:14 AM');
-
-Time in Excel is expressed as a fraction of the day in seconds. Therefore you can calculate an Excel time as follows:
-
- $time = ($hours*3600 +$minutes*60 +$seconds)/(24*60*60);
-
-
-=cut
-###############################################################################
-#
-# xl_parse_time($string)
-#
-sub xl_parse_time {
-
- my $time = shift;
-
- if ($time =~ /(\d{1,2}):(\d\d):?((?:\d\d)(?:\.\d+)?)?(?:\s+)?(am|pm)?/i) {
-
- my $hours = $1;
- my $minutes = $2;
- my $seconds = $3 || 0;
- my $meridian = lc($4) || '';
-
- # Normalise midnight and midday
- $hours = 0 if ($hours == 12 && $meridian ne '');
-
- # Add 12 hours to the pm times. Note: 12.00 pm has been set to 0.00.
- $hours += 12 if $meridian eq 'pm';
-
- # Calculate the time as a fraction of 24 hours in seconds
- return ($hours*3600 +$minutes*60 +$seconds)/(24*60*60);
-
- }
- else {
- return undef; # Not a valid time string
- }
-}
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_parse_date($string)
-
-
- Parameters: $string, a textual representation of a date and time
-
- Returns: A number that represents an Excel date
- or undef for an invalid date.
-
- Requires: Date::Manip and Date::Calc
-
-This function converts a date and time string into a number that represents an Excel date.
-
-The parsing is performed using the C<ParseDate()> function of the Date::Manip module. Refer to the Date::Manip documentation for further information about the date and time formats that can be parsed. In order to use this function you will probably have to initialise some Date::Manip variables via the C<xl_parse_date_init()> function, see below.
-
- xl_parse_date_init("TZ=GMT","DateFormat=non-US");
-
- $date1 = xl_parse_date("11/7/97");
- $date2 = xl_parse_date("Friday 11 July 1997");
- $date3 = xl_parse_date("10:30 AM Friday 11 July 1997");
- $date4 = xl_parse_date("Today");
- $date5 = xl_parse_date("Yesterday");
-
-Note, if you parse a string that represents a time but not a date this function will add the current date. If you want the time without the date you can do something like the following:
-
- $time = xl_parse_date("10:30 AM");
- $time -= int($time);
-
-
-=cut
-###############################################################################
-#
-# xl_parse_date($string)
-#
-sub xl_parse_date {
-
- my $date = ParseDate($_[0]);
-
- return undef unless defined $date;
-
- # Unpack the return value from ParseDate()
- my ($years, $months, $days, $hours, undef, $minutes, undef, $seconds) =
- unpack("A4 A2 A2 A2 C A2 C A2", $date);
-
- # Convert to Excel date
- return xl_date_list($years, $months, $days, $hours, $minutes, $seconds);
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_parse_date_init("variable=value", ...)
-
-
- Parameters: A list of Date::Manip variable strings
-
- Returns: A list of all the Date::Manip strings
-
- Requires: Date::Manip
-
-This function is used to initialise variables required by the Date::Manip module. You should call this function before calling C<xl_parse_date()>. It need only be called once.
-
-This function is a thin wrapper for the C<Date::Manip::Date_Init()> function. You can use C<Date_Init()> directly if you wish. Refer to the Date::Manip documentation for further information.
-
- xl_parse_date_init("TZ=MST","DateFormat=US");
- $date1 = xl_parse_date("11/7/97"); # November 7th 1997
-
- xl_parse_date_init("TZ=GMT","DateFormat=non-US");
- $date1 = xl_parse_date("11/7/97"); # July 11th 1997
-
-
-=cut
-###############################################################################
-#
-# xl_parse_date_init("variable=value", ...)
-#
-sub xl_parse_date_init {
-
- Date_Init(@_); # How lazy is that.
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_decode_date_EU($string)
-
-
- Parameters: $string, a textual representation of a date and time
-
- Returns: A number that represents an Excel date
- or undef for an invalid date.
-
- Requires: Date::Calc
-
-This function converts a date and time string into a number that represents an Excel date.
-
-The date parsing is performed using the C<Decode_Date_EU()> function of the Date::Calc module. Refer to the Date::Calc for further information about the date formats that can be parsed. Also note the following from the Date::Calc documentation:
-
-"If the year is given as one or two digits only (i.e., if the year is less than 100), it is mapped to the window 1970 -2069 as follows":
-
- 0 E<lt>= $year E<lt> 70 ==> $year += 2000;
- 70 E<lt>= $year E<lt> 100 ==> $year += 1900;
-
-The time portion of the string is parsed using the C<xl_parse_time()> function described above.
-
-Note: the EU in the function name means that a European date format is assumed if it is not clear from the string. See the first example below.
-
- $date1 = xl_decode_date_EU("11/7/97"); #11 July 1997
- $date2 = xl_decode_date_EU("Sat 12 Sept 1998");
- $date3 = xl_decode_date_EU("4:30 AM Sat 12 Sept 1998");
-
-
-=cut
-###############################################################################
-#
-# xl_decode_date_EU($string)
-#
-sub xl_decode_date_EU {
-
- return undef unless @_;
-
- my $date = shift;
- my @date;
- my $time = 0;
-
- # Remove and decode the time portion of the string
- if ($date =~ s/(\d{1,2}:\d\d:?(\d\d(\.\d+)?)?(\s+)?(am|pm)?)//i) {
- $time = xl_parse_time($1);
- return undef unless defined $time;
- }
-
- # Return if the string is now blank, i.e. it contained a time only.
- return $time if $date =~ /^\s*$/;
-
- # Decode the date portion of the string
- @date = Decode_Date_EU($date);
- return undef unless @date;
-
- return xl_date_list(@date) + $time;
-}
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_decode_date_US($string)
-
-
- Parameters: $string, a textual representation of a date and time
-
- Returns: A number that represents an Excel date
- or undef for an invalid date.
-
- Requires: Date::Calc
-
-This function converts a date and time string into a number that represents an Excel date.
-
-The date parsing is performed using the C<Decode_Date_US()> function of the Date::Calc module. Refer to the Date::Calc for further information about the date formats that can be parsed. Also note the following from the Date::Calc documentation:
-
-"If the year is given as one or two digits only (i.e., if the year is less than 100), it is mapped to the window 1970 -2069 as follows":
-
- 0 <= $year < 70 ==> $year += 2000;
- 70 <= $year < 100 ==> $year += 1900;
-
-The time portion of the string is parsed using the C<xl_parse_time()> function described above.
-
-Note: the US in the function name means that an American date format is assumed if it is not clear from the string. See the first example below.
-
- $date1 = xl_decode_date_US("11/7/97"); # 7 November 1997
- $date2 = xl_decode_date_US("12 Sept Saturday 1998");
- $date3 = xl_decode_date_US("4:30 AM 12 Sept Sat 1998");
-
-
-=cut
-###############################################################################
-#
-# xl_decode_date_US($string)
-#
-sub xl_decode_date_US {
-
- return undef unless @_;
-
- my $date = shift;
- my @date;
- my $time = 0;
-
- # Remove and decode the time portion of the string
- if ($date =~ s/(\d{1,2}:\d\d:?(\d\d(\.\d+)?)?(\s+)?(am|pm)?)//i) {
- $time = xl_parse_time($1);
- return undef unless defined $time;
- }
-
- # Return if the string is now blank, i.e. it contained a time only.
- return $time if $date =~ /^\s*$/;
-
- # Decode the date portion of the string
- @date = Decode_Date_US($date);
- return undef unless @date;
-
- return xl_date_list(@date) + $time;
-}
-
-
-
-
-###############################################################################
-###############################################################################
-
-=head2 xl_date_1904($date)
-
-
- Parameters: $date, an Excel date with a 1900 epoch
-
- Returns: an Excel date with a 1904 epoch or zero if
- the $date is before 1904
-
-
-This function converts an Excel date based on the 1900 epoch into a date based on the 1904 epoch.
-
-
- $date1 = xl_date_list(2002, 1, 13); # 13 Jan 2002, 1900 epoch
- $date2 = xl_date_1904($date1); # 13 Jan 2002, 1904 epoch
-
-
-See also the C<set_1904()> workbook method in the Spreadsheet::WriteExcel documentation.
-
-=cut
-###############################################################################
-#
-# xl_decode_date_US($string)
-#
-sub xl_date_1904 {
-
- my $date = $_[0] || 0;
-
- if ($date < 1462) {
- # before 1904
- $date = 0;
- }
- else {
- $date -= 1462;
- }
-
- return $date;
-}
-
-
-
-
-=cut
-
-=head1 REQUIREMENTS
-
-The date and time functions require functions from the C<Date::Manip> and C<Date::Calc> modules. The required functions are "autoused" from these modules so that you do not have to install them unless you wish to use the date and time routines. Therefore it is possible to use the row and column functions without having C<Date::Manip> and C<Date::Calc> installed.
-
-For more information about "autousing" refer to the documentation on the C<autouse> pragma.
-
-
-
-=head1 BUGS
-
-When using the autoused functions from C<Date::Manip> and C<Date::Calc> on Perl 5.6.0 with C<-w> you will get a warning like this:
-
- "Subroutine xxx redefined ..."
-
-The current workaround for this is to put C<use warnings;> near the beginning of your program.
-
-
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-
-
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
-
-=cut
-
-
-
-1;
-
-
-__END__
-
+package Spreadsheet::WriteExcel::Utility;
+
+###############################################################################
+#
+# Utility - Helper functions for Spreadsheet::WriteExcel.
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+#
+
+use Exporter;
+use strict;
+use autouse 'Date::Calc' => qw(Delta_DHMS Decode_Date_EU Decode_Date_US);
+use autouse 'Date::Manip' => qw(ParseDate Date_Init);
+
+
+# Do all of the export preparation
+use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+
+# Row and column functions
+my @rowcol = qw(
+ xl_rowcol_to_cell
+ xl_cell_to_rowcol
+ xl_inc_row
+ xl_dec_row
+ xl_inc_col
+ xl_dec_col
+ );
+
+# Date and Time functions
+my @dates = qw(
+ xl_date_list
+ xl_date_1904
+ xl_parse_time
+ xl_parse_date
+ xl_parse_date_init
+ xl_decode_date_EU
+ xl_decode_date_US
+ );
+
+
+ at ISA = qw(Exporter);
+ at EXPORT_OK = ();
+ at EXPORT = (@rowcol, @dates);
+%EXPORT_TAGS = (
+ rowcol => \@rowcol,
+ dates => \@dates
+ );
+
+$VERSION = '2.01';
+
+
+
+
+=head1 NAME
+
+Utility - Helper functions for Spreadsheet::WriteExcel.
+
+
+
+
+=head1 VERSION
+
+This document refers to version 0.03 of Spreadsheet::WriteExcel::Utility, released March, 2002.
+
+
+
+=head1 SYNOPSIS
+
+Functions to help with some common tasks when using Spreadsheet::WriteExcel.
+
+These functions mainly relate to dealing with rows and columns in A1 notation and to handling dates and times.
+
+ use Spreadsheet::WriteExcel::Utility; # Import everything
+
+ ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
+ $str = xl_rowcol_to_cell(1, 2); # C2
+ $str = xl_inc_col('Z1' ); # AA1
+ $str = xl_dec_col('AA1' ); # Z1
+
+ $date = xl_date_list(2002, 1, 1); # 37257
+ $date = xl_parse_date("11 July 1997"); # 35622
+ $time = xl_parse_time('3:21:36 PM'); # 0.64
+ $date = xl_decode_date_EU("13 May 2002"); # 37389
+
+
+
+
+=head1 DESCRIPTION
+
+This module provides a set of functions to help with some common tasks encountered when using the Spreadsheet::WriteExcel module. The two main categories of function are:
+
+Row and column functions: these are used to deal with Excel's A1 representation of cells. The functions in this category are:
+
+ xl_rowcol_to_cell
+ xl_cell_to_rowcol
+ xl_inc_row
+ xl_dec_row
+ xl_inc_col
+ xl_dec_col
+
+Date and Time functions: these are used to convert dates and times to the numeric format used by Excel. The functions in this category are:
+
+ xl_date_list
+ xl_date_1904
+ xl_parse_time
+ xl_parse_date
+ xl_parse_date_init
+ xl_decode_date_EU
+ xl_decode_date_US
+
+All of these functions are exported by default. However, you can use import lists if you wish to limit the functions that are imported:
+
+ use Spreadsheet::WriteExcel::Utility; # Import everything
+ use Spreadsheet::WriteExcel::Utility qw(xl_date_list); # xl_date_list only
+ use Spreadsheet::WriteExcel::Utility qw(:rowcol); # Row/col functions
+ use Spreadsheet::WriteExcel::Utility qw(:dates); # Date functions
+
+
+
+=head1 ROW AND COLUMN FUNCTIONS
+
+
+Spreadsheet::WriteExcel supports two forms of notation to designate the position of cells: Row-column notation and A1 notation.
+
+Row-column notation uses a zero based index for both row and column while A1 notation uses the standard Excel alphanumeric sequence of column letter and 1-based row. Columns range from A to IV i.e. 0 to 255, rows range from 1 to 16384 in Excel 5 and 65536 in Excel 97. For example:
+
+ (0, 0) # The top left cell in row-column notation.
+ ('A1') # The top left cell in A1 notation.
+
+ (1999, 29) # Row-column notation.
+ ('AD2000') # The same cell in A1 notation.
+
+Row-column notation is useful if you are referring to cells programmatically:
+
+ for my $i (0 .. 9) {
+ $worksheet->write($i, 0, 'Hello'); # Cells A1 to A10
+ }
+
+A1 notation is useful for setting up a worksheet manually and for working with formulas:
+
+ $worksheet->write('H1', 200);
+ $worksheet->write('H2', '=H7+1');
+
+The functions in the following sections can be used for dealing with A1 notation, for example:
+
+ ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
+ $str = xl_rowcol_to_cell(1, 2); # C2
+
+
+Cell references in Excel can be either relative or absolute. Absolute references are prefixed by the dollar symbol as shown below:
+
+ A1 # Column and row are relative
+ $A1 # Column is absolute and row is relative
+ A$1 # Column is relative and row is absolute
+ $A$1 # Column and row are absolute
+
+An absolute reference only has an effect if the cell is copied. Refer to the Excel documentation for further details. All of the following functions support absolute references.
+
+=cut
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_rowcol_to_cell($row, $col, $row_absolute, $col_absolute)
+
+ Parameters: $row: Integer
+ $col: Integer
+ $row_absolute: Boolean (1/0) [optional, default is 0]
+ $col_absolute: Boolean (1/0) [optional, default is 0]
+
+ Returns: A string in A1 cell notation
+
+
+This function converts a zero based row and column cell reference to a A1 style string:
+
+ $str = xl_rowcol_to_cell(0, 0); # A1
+ $str = xl_rowcol_to_cell(0, 1); # B1
+ $str = xl_rowcol_to_cell(1, 0); # A2
+
+
+The optional parameters C<$row_absolute> and C<$col_absolute> can be used to indicate if the row or column is absolute:
+
+ $str = xl_rowcol_to_cell(0, 0, 0, 1); # $A1
+ $str = xl_rowcol_to_cell(0, 0, 1, 0); # A$1
+ $str = xl_rowcol_to_cell(0, 0, 1, 1); # $A$1
+
+See L<ROW AND COLUMN FUNCTIONS> for an explanation of absolute cell references.
+
+
+=cut
+###############################################################################
+#
+# xl_rowcol_to_cell($row, $col, $row_absolute, $col_absolute)
+#
+sub xl_rowcol_to_cell {
+
+ my $row = $_[0];
+ my $col = $_[1];
+ my $row_abs = $_[2] ? '$' : '';
+ my $col_abs = $_[3] ? '$' : '';
+
+
+ my $int = int ($col / 26);
+ my $frac = $col % 26;
+
+ my $chr1 =''; # Most significant character in AA1
+
+ if ($int > 0) {
+ $chr1 = chr( ord('A') + $int -1 );
+ }
+
+ my $chr2 = chr( ord('A') + $frac );
+
+ # Zero index to 1-index
+ $row++;
+
+ return $col_abs . $chr1 . $chr2 . $row_abs. $row;
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_cell_to_rowcol($string)
+
+
+ Parameters: $string String in A1 format
+
+ Returns: List ($row, $col)
+
+This function converts an Excel cell reference in A1 notation to a zero based row and column. The function will also handle Excel's absolute, C<$>, cell notation.
+
+ my ($row, $col) = xl_cell_to_rowcol('A1'); # (0, 0)
+ my ($row, $col) = xl_cell_to_rowcol('B1'); # (0, 1)
+ my ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
+ my ($row, $col) = xl_cell_to_rowcol('$C2' ); # (1, 2)
+ my ($row, $col) = xl_cell_to_rowcol('C$2' ); # (1, 2)
+ my ($row, $col) = xl_cell_to_rowcol('$C$2'); # (1, 2)
+
+=cut
+###############################################################################
+#
+# xl_cell_to_rowcol($string)
+#
+# Returns: ($row, $col, $row_absolute, $col_absolute)
+#
+# The $row_absolute and $col_absolute parameters aren't documented because they
+# mainly used internally and aren't very useful to the user.
+#
+sub xl_cell_to_rowcol {
+
+ my $cell = shift;
+
+ $cell =~ /(\$?)([A-I]?[A-Z])(\$?)(\d+)/;
+
+ my $col_abs = $1 eq "" ? 0 : 1;
+ my $col = $2;
+ my $row_abs = $3 eq "" ? 0 : 1;
+ my $row = $4;
+
+ # Convert base26 column string to number
+ # All your Base are belong to us.
+ my @chars = split //, $col;
+ my $expn = 0;
+ $col = 0;
+
+ while (@chars) {
+ my $char = pop(@chars); # LS char first
+ $col += (ord($char) -ord('A') +1) * (26**$expn);
+ $expn++;
+ }
+
+ # Convert 1-index to zero-index
+ $row--;
+ $col--;
+
+ return $row, $col, $row_abs, $col_abs;
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_inc_row($string)
+
+
+ Parameters: $string, a string in A1 format
+
+ Returns: Incremented string in A1 format
+
+This functions takes a cell reference string in A1 notation and increments the row. The function will also handle Excel's absolute, C<$>, cell notation:
+
+ my $str = xl_inc_row('A1' ); # A2
+ my $str = xl_inc_row('B$2' ); # B$3
+ my $str = xl_inc_row('$C3' ); # $C4
+ my $str = xl_inc_row('$D$4'); # $D$5
+
+
+=cut
+###############################################################################
+#
+# xl_inc_row($string)
+#
+sub xl_inc_row {
+
+ my $cell = shift;
+ my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
+
+ return xl_rowcol_to_cell(++$row, $col, $row_abs, $col_abs);
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_dec_row($string)
+
+
+ Parameters: $string, a string in A1 format
+
+ Returns: Decremented string in A1 format
+
+This functions takes a cell reference string in A1 notation and decrements the row. The function will also handle Excel's absolute, C<$>, cell notation:
+
+ my $str = xl_dec_row('A2' ); # A1
+ my $str = xl_dec_row('B$3' ); # B$2
+ my $str = xl_dec_row('$C4' ); # $C3
+ my $str = xl_dec_row('$D$5'); # $D$4
+
+
+=cut
+###############################################################################
+#
+# xl_dec_row($string)
+#
+# Decrements the row number of an Excel cell reference in A1 notation.
+# For example C4 to C3
+#
+# Returns: a cell reference string.
+#
+sub xl_dec_row {
+
+ my $cell = shift;
+ my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
+
+ return xl_rowcol_to_cell(--$row, $col, $row_abs, $col_abs);
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_inc_col($string)
+
+
+ Parameters: $string, a string in A1 format
+
+ Returns: Incremented string in A1 format
+
+This functions takes a cell reference string in A1 notation and increments the column. The function will also handle Excel's absolute, C<$>, cell notation:
+
+ my $str = xl_inc_col('A1' ); # B1
+ my $str = xl_inc_col('Z1' ); # AA1
+ my $str = xl_inc_col('$B1' ); # $C1
+ my $str = xl_inc_col('$D$5'); # $E$5
+
+
+=cut
+###############################################################################
+#
+# xl_inc_col($string)
+#
+# Increments the column number of an Excel cell reference in A1 notation.
+# For example C3 to D3
+#
+# Returns: a cell reference string.
+#
+sub xl_inc_col {
+
+ my $cell = shift;
+ my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
+
+ return xl_rowcol_to_cell($row, ++$col, $row_abs, $col_abs);
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_dec_col($string)
+
+ Parameters: $string, a string in A1 format
+
+ Returns: Decremented string in A1 format
+
+This functions takes a cell reference string in A1 notation and decrements the column. The function will also handle Excel's absolute, C<$>, cell notation:
+
+ my $str = xl_dec_col('B1' ); # A1
+ my $str = xl_dec_col('AA1' ); # Z1
+ my $str = xl_dec_col('$C1' ); # $B1
+ my $str = xl_dec_col('$E$5'); # $D$5
+
+
+=cut
+###############################################################################
+#
+# xl_dec_col($string)
+#
+sub xl_dec_col {
+
+ my $cell = shift;
+ my ($row, $col, $row_abs, $col_abs) = xl_cell_to_rowcol($cell);
+
+ return xl_rowcol_to_cell($row, --$col, $row_abs, $col_abs);
+}
+
+
+
+
+=head1 TIME AND DATE FUNCTIONS
+
+
+Dates and times in Excel are represented by real numbers, for example "Jan 1 2001 12:30 AM" is represented by the number 36892.521.
+
+The integer part of the number stores the number of days since the epoch and the fractional part stores the percentage of the day in seconds.
+
+The epoch can be either 1900 or 1904. Excel for Windows uses 1900 and Excel for Macintosh uses 1904. The epochs are:
+
+ 1900: 0 January 1900 i.e. 31 December 1899
+ 1904: 1 January 1904
+
+Excel on Windows and the Macintosh will convert automatically between one system and the other. By default Spreadsheet::WriteExcel uses the 1900 format. To use the 1904 epoch you must use the C<set_1904()> workbook method, see the Spreadsheet::WriteExcel documentation.
+
+There are two things to note about the 1900 date format. The first is that the epoch starts on 0 January 1900. The second is that the year 1900 is erroneously but deliberately treated as a leap year. Therefore you must add an extra day to dates after 28 February 1900. The functions in the following section will deal with these issues automatically. The reason for this anomaly is explained at http://support.microsoft.com/support/kb/articles/Q181/3/70.asp
+
+Note, a date or time in Excel is like any other number. To display the number as a date you must apply a number format to it: Refer to the C<set_num_format()> method in the Spreadsheet::WriteExcel documentation:
+
+ $date = xl_date_list(2001, 1, 1, 12, 30);
+ $format->set_num_format('mmm d yyyy hh:mm AM/PM');
+ $worksheet->write('A1', $date , $format); # Jan 1 2001 12:30 AM
+
+To use these functions you must install the C<Date::Manip> and C<Date::Calc> modules. See L<REQUIREMENTS> and the individual requirements of each functions.
+
+See also the DateTime::Format::Excel module,http://search.cpan.org/search?dist=DateTime-Format-Excel which is part of the DateTime project and which deals specifically with converting dates and times to and from Excel's format.
+
+
+=cut
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_date_list($years, $months, $days, $hours, $minutes, $seconds)
+
+
+ Parameters: $years: Integer
+ $months: Integer [optional, default is 1]
+ $days: Integer [optional, default is 1]
+ $hours: Integer [optional, default is 0]
+ $minutes: Integer [optional, default is 0]
+ $seconds: Float [optional, default is 0]
+
+ Returns: A number that represents an Excel date
+ or undef for an invalid date.
+
+ Requires: Date::Calc
+
+This function converts an array of data into a number that represents an Excel date. All of the parameters are optional except for C<$years>.
+
+ $date1 = xl_date_list(2002, 1, 2); # 2 Jan 2002
+ $date2 = xl_date_list(2002, 1, 2, 12); # 2 Jan 2002 12:00 pm
+ $date3 = xl_date_list(2002, 1, 2, 12, 30); # 2 Jan 2002 12:30 pm
+ $date4 = xl_date_list(2002, 1, 2, 12, 30, 45); # 2 Jan 2002 12:30:45 pm
+
+This function can be used in conjunction with functions that parse date and time strings. In fact it is used in most of the following functions.
+
+
+=cut
+###############################################################################
+#
+# xl_date_list($years, $months, $days, $hours, $minutes, $seconds)
+#
+sub xl_date_list {
+
+ return undef unless @_;
+
+ my $years = $_[0];
+ my $months = $_[1] || 1;
+ my $days = $_[2] || 1;
+ my $hours = $_[3] || 0;
+ my $minutes = $_[4] || 0;
+ my $seconds = $_[5] || 0;
+
+ my @date = ($years, $months, $days, $hours, $minutes, $seconds);
+ my @epoch = (1899, 12, 31, 0, 0, 0);
+
+ ($days, $hours, $minutes, $seconds) = Delta_DHMS(@epoch, @date);
+
+ my $date = $days + ($hours*3600 +$minutes*60 +$seconds)/(24*60*60);
+
+ # Add a day for Excel's missing leap day in 1900
+ $date++ if ($date > 59);
+
+ return $date;
+}
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_parse_time($string)
+
+
+ Parameters: $string, a textual representation of a time
+
+ Returns: A number that represents an Excel time
+ or undef for an invalid time.
+
+This function converts a time string into a number that represents an Excel time. The following time formats are valid:
+
+ hh:mm [AM|PM]
+ hh:mm [AM|PM]
+ hh:mm:ss [AM|PM]
+ hh:mm:ss.ss [AM|PM]
+
+
+The meridian, AM or PM, is optional and case insensitive. A 24 hour time is assumed if the meridian is omitted
+
+ $time1 = xl_parse_time('12:18');
+ $time2 = xl_parse_time('12:18:14');
+ $time3 = xl_parse_time('12:18:14 AM');
+ $time4 = xl_parse_time('1:18:14 AM');
+
+Time in Excel is expressed as a fraction of the day in seconds. Therefore you can calculate an Excel time as follows:
+
+ $time = ($hours*3600 +$minutes*60 +$seconds)/(24*60*60);
+
+
+=cut
+###############################################################################
+#
+# xl_parse_time($string)
+#
+sub xl_parse_time {
+
+ my $time = shift;
+
+ if ($time =~ /(\d{1,2}):(\d\d):?((?:\d\d)(?:\.\d+)?)?(?:\s+)?(am|pm)?/i) {
+
+ my $hours = $1;
+ my $minutes = $2;
+ my $seconds = $3 || 0;
+ my $meridian = lc($4) || '';
+
+ # Normalise midnight and midday
+ $hours = 0 if ($hours == 12 && $meridian ne '');
+
+ # Add 12 hours to the pm times. Note: 12.00 pm has been set to 0.00.
+ $hours += 12 if $meridian eq 'pm';
+
+ # Calculate the time as a fraction of 24 hours in seconds
+ return ($hours*3600 +$minutes*60 +$seconds)/(24*60*60);
+
+ }
+ else {
+ return undef; # Not a valid time string
+ }
+}
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_parse_date($string)
+
+
+ Parameters: $string, a textual representation of a date and time
+
+ Returns: A number that represents an Excel date
+ or undef for an invalid date.
+
+ Requires: Date::Manip and Date::Calc
+
+This function converts a date and time string into a number that represents an Excel date.
+
+The parsing is performed using the C<ParseDate()> function of the Date::Manip module. Refer to the Date::Manip documentation for further information about the date and time formats that can be parsed. In order to use this function you will probably have to initialise some Date::Manip variables via the C<xl_parse_date_init()> function, see below.
+
+ xl_parse_date_init("TZ=GMT","DateFormat=non-US");
+
+ $date1 = xl_parse_date("11/7/97");
+ $date2 = xl_parse_date("Friday 11 July 1997");
+ $date3 = xl_parse_date("10:30 AM Friday 11 July 1997");
+ $date4 = xl_parse_date("Today");
+ $date5 = xl_parse_date("Yesterday");
+
+Note, if you parse a string that represents a time but not a date this function will add the current date. If you want the time without the date you can do something like the following:
+
+ $time = xl_parse_date("10:30 AM");
+ $time -= int($time);
+
+
+=cut
+###############################################################################
+#
+# xl_parse_date($string)
+#
+sub xl_parse_date {
+
+ my $date = ParseDate($_[0]);
+
+ return undef unless defined $date;
+
+ # Unpack the return value from ParseDate()
+ my ($years, $months, $days, $hours, undef, $minutes, undef, $seconds) =
+ unpack("A4 A2 A2 A2 C A2 C A2", $date);
+
+ # Convert to Excel date
+ return xl_date_list($years, $months, $days, $hours, $minutes, $seconds);
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_parse_date_init("variable=value", ...)
+
+
+ Parameters: A list of Date::Manip variable strings
+
+ Returns: A list of all the Date::Manip strings
+
+ Requires: Date::Manip
+
+This function is used to initialise variables required by the Date::Manip module. You should call this function before calling C<xl_parse_date()>. It need only be called once.
+
+This function is a thin wrapper for the C<Date::Manip::Date_Init()> function. You can use C<Date_Init()> directly if you wish. Refer to the Date::Manip documentation for further information.
+
+ xl_parse_date_init("TZ=MST","DateFormat=US");
+ $date1 = xl_parse_date("11/7/97"); # November 7th 1997
+
+ xl_parse_date_init("TZ=GMT","DateFormat=non-US");
+ $date1 = xl_parse_date("11/7/97"); # July 11th 1997
+
+
+=cut
+###############################################################################
+#
+# xl_parse_date_init("variable=value", ...)
+#
+sub xl_parse_date_init {
+
+ Date_Init(@_); # How lazy is that.
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_decode_date_EU($string)
+
+
+ Parameters: $string, a textual representation of a date and time
+
+ Returns: A number that represents an Excel date
+ or undef for an invalid date.
+
+ Requires: Date::Calc
+
+This function converts a date and time string into a number that represents an Excel date.
+
+The date parsing is performed using the C<Decode_Date_EU()> function of the Date::Calc module. Refer to the Date::Calc for further information about the date formats that can be parsed. Also note the following from the Date::Calc documentation:
+
+"If the year is given as one or two digits only (i.e., if the year is less than 100), it is mapped to the window 1970 -2069 as follows":
+
+ 0 E<lt>= $year E<lt> 70 ==> $year += 2000;
+ 70 E<lt>= $year E<lt> 100 ==> $year += 1900;
+
+The time portion of the string is parsed using the C<xl_parse_time()> function described above.
+
+Note: the EU in the function name means that a European date format is assumed if it is not clear from the string. See the first example below.
+
+ $date1 = xl_decode_date_EU("11/7/97"); #11 July 1997
+ $date2 = xl_decode_date_EU("Sat 12 Sept 1998");
+ $date3 = xl_decode_date_EU("4:30 AM Sat 12 Sept 1998");
+
+
+=cut
+###############################################################################
+#
+# xl_decode_date_EU($string)
+#
+sub xl_decode_date_EU {
+
+ return undef unless @_;
+
+ my $date = shift;
+ my @date;
+ my $time = 0;
+
+ # Remove and decode the time portion of the string
+ if ($date =~ s/(\d{1,2}:\d\d:?(\d\d(\.\d+)?)?(\s+)?(am|pm)?)//i) {
+ $time = xl_parse_time($1);
+ return undef unless defined $time;
+ }
+
+ # Return if the string is now blank, i.e. it contained a time only.
+ return $time if $date =~ /^\s*$/;
+
+ # Decode the date portion of the string
+ @date = Decode_Date_EU($date);
+ return undef unless @date;
+
+ return xl_date_list(@date) + $time;
+}
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_decode_date_US($string)
+
+
+ Parameters: $string, a textual representation of a date and time
+
+ Returns: A number that represents an Excel date
+ or undef for an invalid date.
+
+ Requires: Date::Calc
+
+This function converts a date and time string into a number that represents an Excel date.
+
+The date parsing is performed using the C<Decode_Date_US()> function of the Date::Calc module. Refer to the Date::Calc for further information about the date formats that can be parsed. Also note the following from the Date::Calc documentation:
+
+"If the year is given as one or two digits only (i.e., if the year is less than 100), it is mapped to the window 1970 -2069 as follows":
+
+ 0 <= $year < 70 ==> $year += 2000;
+ 70 <= $year < 100 ==> $year += 1900;
+
+The time portion of the string is parsed using the C<xl_parse_time()> function described above.
+
+Note: the US in the function name means that an American date format is assumed if it is not clear from the string. See the first example below.
+
+ $date1 = xl_decode_date_US("11/7/97"); # 7 November 1997
+ $date2 = xl_decode_date_US("12 Sept Saturday 1998");
+ $date3 = xl_decode_date_US("4:30 AM 12 Sept Sat 1998");
+
+
+=cut
+###############################################################################
+#
+# xl_decode_date_US($string)
+#
+sub xl_decode_date_US {
+
+ return undef unless @_;
+
+ my $date = shift;
+ my @date;
+ my $time = 0;
+
+ # Remove and decode the time portion of the string
+ if ($date =~ s/(\d{1,2}:\d\d:?(\d\d(\.\d+)?)?(\s+)?(am|pm)?)//i) {
+ $time = xl_parse_time($1);
+ return undef unless defined $time;
+ }
+
+ # Return if the string is now blank, i.e. it contained a time only.
+ return $time if $date =~ /^\s*$/;
+
+ # Decode the date portion of the string
+ @date = Decode_Date_US($date);
+ return undef unless @date;
+
+ return xl_date_list(@date) + $time;
+}
+
+
+
+
+###############################################################################
+###############################################################################
+
+=head2 xl_date_1904($date)
+
+
+ Parameters: $date, an Excel date with a 1900 epoch
+
+ Returns: an Excel date with a 1904 epoch or zero if
+ the $date is before 1904
+
+
+This function converts an Excel date based on the 1900 epoch into a date based on the 1904 epoch.
+
+
+ $date1 = xl_date_list(2002, 1, 13); # 13 Jan 2002, 1900 epoch
+ $date2 = xl_date_1904($date1); # 13 Jan 2002, 1904 epoch
+
+
+See also the C<set_1904()> workbook method in the Spreadsheet::WriteExcel documentation.
+
+=cut
+###############################################################################
+#
+# xl_decode_date_US($string)
+#
+sub xl_date_1904 {
+
+ my $date = $_[0] || 0;
+
+ if ($date < 1462) {
+ # before 1904
+ $date = 0;
+ }
+ else {
+ $date -= 1462;
+ }
+
+ return $date;
+}
+
+
+
+
+=cut
+
+=head1 REQUIREMENTS
+
+The date and time functions require functions from the C<Date::Manip> and C<Date::Calc> modules. The required functions are "autoused" from these modules so that you do not have to install them unless you wish to use the date and time routines. Therefore it is possible to use the row and column functions without having C<Date::Manip> and C<Date::Calc> installed.
+
+For more information about "autousing" refer to the documentation on the C<autouse> pragma.
+
+
+
+=head1 BUGS
+
+When using the autoused functions from C<Date::Manip> and C<Date::Calc> on Perl 5.6.0 with C<-w> you will get a warning like this:
+
+ "Subroutine xxx redefined ..."
+
+The current workaround for this is to put C<use warnings;> near the beginning of your program.
+
+
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+
+
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
+
+=cut
+
+
+
+1;
+
+
+__END__
+
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Workbook.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Workbook.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Workbook.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,1940 +1,2026 @@
-package Spreadsheet::WriteExcel::Workbook;
-
-###############################################################################
-#
-# Workbook - A writer class for Excel Workbooks.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-use Carp;
-use Spreadsheet::WriteExcel::BIFFwriter;
-use Spreadsheet::WriteExcel::OLEwriter;
-use Spreadsheet::WriteExcel::Worksheet;
-use Spreadsheet::WriteExcel::Format;
-use Spreadsheet::WriteExcel::Chart;
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Spreadsheet::WriteExcel::BIFFwriter Exporter);
-
-$VERSION = '2.10';
-
-###############################################################################
-#
-# new()
-#
-# Constructor. Creates a new Workbook object from a BIFFwriter object.
-#
-sub new {
-
- my $class = shift;
- my $self = Spreadsheet::WriteExcel::BIFFwriter->new();
- my $tmp_format = Spreadsheet::WriteExcel::Format->new();
- my $byte_order = $self->{_byte_order};
- my $parser = Spreadsheet::WriteExcel::Formula->new($byte_order);
-
- $self->{_filename} = $_[0] || '';
- $self->{_parser} = $parser;
- $self->{_tempdir} = undef;
- $self->{_1904} = 0;
- $self->{_activesheet} = 0;
- $self->{_firstsheet} = 0;
- $self->{_selected} = 0;
- $self->{_xf_index} = 16; # 15 style XF's and 1 cell XF.
- $self->{_fileclosed} = 0;
- $self->{_biffsize} = 0;
- $self->{_sheetname} = "Sheet";
- $self->{_tmp_format} = $tmp_format;
- $self->{_url_format} = '';
- $self->{_codepage} = 0x04E4;
- $self->{_worksheets} = [];
- $self->{_sheetnames} = [];
- $self->{_formats} = [];
- $self->{_palette} = [];
-
- $self->{_using_tmpfile} = 1;
- $self->{_filehandle} = "";
- $self->{_temp_file} = "";
-
- $self->{_str_total} = 0;
- $self->{_str_unique} = 0;
- $self->{_str_table} = {};
- $self->{_str_array} = [];
- $self->{_str_block_sizes} = [];
-
- $self->{_ext_ref_count} = 0;
- $self->{_ext_refs} = {};
-
- bless $self, $class;
-
- # Add the default format for hyperlinks
- $self->{_url_format} = $self->add_format(color => 'blue', underline => 1);
-
-
- # Check for a filename unless it is an existing filehandle
- if (not ref $self->{_filename} and $self->{_filename} eq '') {
- carp 'Filename required by Spreadsheet::WriteExcel->new()';
- return undef;
- }
-
-
- # Try to open the named file and see if it throws any errors.
- # If the filename is a reference it is assumed that it is a valid
- # filehandle and ignored
- #
- if (not ref $self->{_filename}) {
- my $fh = FileHandle->new('>'. $self->{_filename});
- if (not defined $fh) {
- carp "Can't open " .
- $self->{_filename} .
- ". It may be in use or protected";
- return undef;
- }
- $fh->close;
- }
-
-
- # Set colour palette.
- $self->set_palette_xl97();
-
- $self->_initialize();
- return $self;
-}
-
-
-###############################################################################
-#
-# _initialize()
-#
-# Open a tmp file to store the majority of the Worksheet data. If this fails,
-# for example due to write permissions, store the data in memory. This can be
-# slow for large files.
-#
-# TODO: Move this and other methods shared with Worksheet up into BIFFWriter.
-#
-sub _initialize {
-
- my $self = shift;
- my $fh;
- my $tmp_dir;
-
- # The following code is complicated by Windows limitations. Porters can
- # choose a more direct method.
-
-
-
- # In the default case we use IO::File->new_tmpfile(). This may fail, in
- # particular with IIS on Windows, so we allow the user to specify a temp
- # directory via File::Temp.
- #
- if (defined $self->{_tempdir}) {
-
- # Delay loading File:Temp to reduce the module dependencies.
- eval { require File::Temp };
- die "The File::Temp module must be installed in order ".
- "to call set_tempdir().\n" if $@;
-
-
- # Trap but ignore File::Temp errors.
- eval { $fh = File::Temp::tempfile(DIR => $self->{_tempdir}) };
-
- # Store the failed tmp dir in case of errors.
- $tmp_dir = $self->{_tempdir} || File::Spec->tmpdir if not $fh;
- }
- else {
-
- $fh = IO::File->new_tmpfile();
-
- # Store the failed tmp dir in case of errors.
- $tmp_dir = "POSIX::tmpnam() directory" if not $fh;
- }
-
-
- # Check if the temp file creation was successful. Else store data in memory.
- if ($fh) {
-
- # binmode file whether platform requires it or not.
- binmode($fh);
-
- # Store filehandle
- $self->{_filehandle} = $fh;
- }
- else {
-
- # Set flag to store data in memory if XX::tempfile() failed.
- $self->{_using_tmpfile} = 0;
-
- if ($^W) {
- my $dir = $self->{_tempdir} || File::Spec->tmpdir();
-
- warn "Unable to create temp files in $tmp_dir. Data will be ".
- "stored in memory. Refer to set_tempdir() in the ".
- "Spreadsheet::WriteExcel documentation.\n" ;
- }
- }
-}
-
-
-###############################################################################
-#
-# _append(), overloaded.
-#
-# Store Worksheet data in memory using the base class _append() or to a
-# temporary file, the default.
-#
-sub _append {
-
- my $self = shift;
-
- if ($self->{_using_tmpfile}) {
- my $data = join('', @_);
-
- # Add CONTINUE records if necessary
- $data = $self->_add_continue($data) if length($data) > $self->{_limit};
-
- # Protect print() from -l on the command line.
- local $\ = undef;
-
- print {$self->{_filehandle}} $data;
- $self->{_datasize} += length($data);
- }
- else {
- $self->SUPER::_append(@_);
- }
-}
-
-
-###############################################################################
-#
-# get_data().
-#
-# Retrieves data from memory in one chunk, or from disk in $buffer
-# sized chunks.
-#
-sub get_data {
-
- my $self = shift;
- my $buffer = 4096;
- my $tmp;
-
- # Return data stored in memory
- if (defined $self->{_data}) {
- $tmp = $self->{_data};
- $self->{_data} = undef;
- my $fh = $self->{_filehandle};
- seek($fh, 0, 0) if $self->{_using_tmpfile};
- return $tmp;
- }
-
- # Return data stored on disk
- if ($self->{_using_tmpfile}) {
- return $tmp if read($self->{_filehandle}, $tmp, $buffer);
- }
-
- # No data to return
- return undef;
-}
-
-
-###############################################################################
-#
-# close()
-#
-# Calls finalization methods and explicitly close the OLEwriter file
-# handle.
-#
-sub close {
-
- my $self = shift;
-
- return if $self->{_fileclosed}; # Prevent close() from being called twice.
-
- $self->{_fileclosed} = 1;
-
- return $self->_store_workbook();
-}
-
-
-###############################################################################
-#
-# DESTROY()
-#
-# Close the workbook if it hasn't already been explicitly closed.
-#
-sub DESTROY {
-
- my $self = shift;
-
- $self->close() if not $self->{_fileclosed};
-}
-
-
-###############################################################################
-#
-# sheets(slice,...)
-#
-# An accessor for the _worksheets[] array
-#
-# Returns: an optionally sliced list of the worksheet objects in a workbook.
-#
-sub sheets {
-
- my $self = shift;
-
- if (@_) {
- # Return a slice of the array
- return @{$self->{_worksheets}}[@_];
- }
- else {
- # Return the entire list
- return @{$self->{_worksheets}};
- }
-}
-
-
-###############################################################################
-#
-# worksheets()
-#
-# An accessor for the _worksheets[] array.
-# This method is now deprecated. Use the sheets() method instead.
-#
-# Returns: an array reference
-#
-sub worksheets {
-
- my $self = shift;
-
- return $self->{_worksheets};
-}
-
-
-###############################################################################
-#
-# add_worksheet($name)
-#
-# Add a new worksheet to the Excel workbook.
-# TODO: Add accessor for $self->{_sheetname} for international Excel versions.
-#
-# Returns: reference to a worksheet object
-#
-sub add_worksheet {
-
- my $self = shift;
- my $name = $_[0] || "";
- my $encoding = $_[1] || 0;
- my $limit = $encoding ? 62 : 31;
-
-
- # Check that sheetname is <= 31 (1 or 2 byte chars). Excel limit.
- croak "Sheetname $name must be <= 31 chars" if length $name > $limit;
-
- # Check that sheetname doesn't contain any invalid characters
- croak 'Invalid Excel character [:*?/\\] in worksheet name: ' . $name
- if $encoding == 0 and $name =~ m{[:*?/\\]};
-
- # Check that Unicode sheetname has an even number of bytes
- croak 'Odd number of bytes in Unicode worksheet name:' . $name
- if $encoding == 1 and length($name) % 2;
-
-
- my $index = @{$self->{_worksheets}};
- my $sheetname = $self->{_sheetname};
-
- if ($name eq "" ) {
- $name = $sheetname . ($index+1);
- $encoding = 0;
- }
-
- # Check that the worksheet name doesn't already exist: a fatal Excel error.
- # The check must also exclude case insensitive matches.
- foreach my $tmp (@{$self->{_worksheets}}) {
- if (lc $name eq lc $tmp->get_name()) {
- croak "Worksheet name '$name', with case ignored, " .
- "is already in use";
- }
- }
-
-
- # Porters take note, the following scheme of passing references to Workbook
- # data (in the \$self->{_foo} cases) instead of a reference to the Workbook
- # itself is a workaround to avoid circular references between Workbook and
- # Worksheet objects. Feel free to implement this in any way the suits your
- # language.
- #
- my @init_data = (
- $name,
- $index,
- $encoding,
- \$self->{_activesheet},
- \$self->{_firstsheet},
- $self->{_url_format},
- $self->{_parser},
- $self->{_tempdir},
- \$self->{_str_total},
- \$self->{_str_unique},
- \$self->{_str_table},
- $self->{_1904},
- );
-
- my $worksheet = Spreadsheet::WriteExcel::Worksheet->new(@init_data);
- $self->{_worksheets}->[$index] = $worksheet; # Store ref for iterator
- $self->{_sheetnames}->[$index] = $name; # Store EXTERNSHEET names
- $self->{_parser}->set_ext_sheets($name, $index); # Store names in Formula.pm
- return $worksheet;
-}
-
-
-###############################################################################
-#
-# add_chart_ext($name, $filename)
-#
-# Add an externally created chart.
-#
-#
-sub add_chart_ext {
-
- my $self = shift;
- my $filename = $_[0];
- my $name = $_[1] || "";
-
- my $encoding = 0;
-
- my $index = @{$self->{_worksheets}};
-
- if ($name eq "" ) {
- $name = 'Chart' . ($index+1);
- }
-
- # Check that the worksheet name doesn't already exist: a fatal Excel error.
- # The check must also exclude case insensitive matches.
- foreach my $tmp (@{$self->{_worksheets}}) {
- if (lc $name eq lc $tmp->get_name()) {
- croak "Worksheet name '$name', with case ignored, " .
- "is already in use";
- }
- }
-
-
- my @init_data = (
- $filename,
- $name,
- $index,
- $encoding,
- \$self->{_activesheet},
- \$self->{_firstsheet},
- );
-
- my $worksheet = Spreadsheet::WriteExcel::Chart->new(@init_data);
- $self->{_worksheets}->[$index] = $worksheet; # Store ref for iterator
- $self->{_sheetnames}->[$index] = $name; # Store EXTERNSHEET names
- $self->{_parser}->set_ext_sheets($name, $index); # Store names in Formula.pm
- return $worksheet;
-}
-
-
-
-###############################################################################
-#
-# addworksheet($name)
-#
-# This method is now deprecated. Use the add_worksheet() method instead.
-#
-sub addworksheet {
-
- my $self = shift;
-
- $self->add_worksheet(@_);
-}
-
-
-###############################################################################
-#
-# add_format(%properties)
-#
-# Add a new format to the Excel workbook. This adds an XF record and
-# a FONT record. Also, pass any properties to the Format::new().
-#
-sub add_format {
-
- my $self = shift;
-
- my $format = Spreadsheet::WriteExcel::Format->new($self->{_xf_index}, @_);
-
- $self->{_xf_index} += 1;
- push @{$self->{_formats}}, $format; # Store format reference
-
- return $format;
-}
-
-
-###############################################################################
-#
-# addformat()
-#
-# This method is now deprecated. Use the add_format() method instead.
-#
-sub addformat {
-
- my $self = shift;
-
- $self->add_format(@_);
-}
-
-
-###############################################################################
-#
-# set_1904()
-#
-# Set the date system: 0 = 1900 (the default), 1 = 1904
-#
-sub set_1904 {
-
- my $self = shift;
-
- croak "set_1904() must be called before add_worksheet" if $self->sheets();
-
-
- if (defined($_[0])) {
- $self->{_1904} = $_[0];
- }
- else {
- $self->{_1904} = 1;
- }
-}
-
-
-###############################################################################
-#
-# get_1904()
-#
-# Return the date system: 0 = 1900, 1 = 1904
-#
-sub get_1904 {
-
- my $self = shift;
-
- return $self->{_1904};
-}
-
-
-###############################################################################
-#
-# set_custom_color()
-#
-# Change the RGB components of the elements in the colour palette.
-#
-sub set_custom_color {
-
- my $self = shift;
-
-
- # Match a HTML #xxyyzz style parameter
- if (defined $_[1] and $_[1] =~ /^#(\w\w)(\w\w)(\w\w)/ ) {
- @_ = ($_[0], hex $1, hex $2, hex $3);
- }
-
-
- my $index = $_[0] || 0;
- my $red = $_[1] || 0;
- my $green = $_[2] || 0;
- my $blue = $_[3] || 0;
-
- my $aref = $self->{_palette};
-
- # Check that the colour index is the right range
- if ($index < 8 or $index > 64) {
- carp "Color index $index outside range: 8 <= index <= 64";
- return 0;
- }
-
- # Check that the colour components are in the right range
- if ( ($red < 0 or $red > 255) ||
- ($green < 0 or $green > 255) ||
- ($blue < 0 or $blue > 255) )
- {
- carp "Color component outside range: 0 <= color <= 255";
- return 0;
- }
-
- $index -=8; # Adjust colour index (wingless dragonfly)
-
- # Set the RGB value
- $$aref[$index] = [$red, $green, $blue, 0];
-
- return $index +8;
-}
-
-
-###############################################################################
-#
-# set_palette_xl97()
-#
-# Sets the colour palette to the Excel 97+ default.
-#
-sub set_palette_xl97 {
-
- my $self = shift;
-
- $self->{_palette} = [
- [0x00, 0x00, 0x00, 0x00], # 8
- [0xff, 0xff, 0xff, 0x00], # 9
- [0xff, 0x00, 0x00, 0x00], # 10
- [0x00, 0xff, 0x00, 0x00], # 11
- [0x00, 0x00, 0xff, 0x00], # 12
- [0xff, 0xff, 0x00, 0x00], # 13
- [0xff, 0x00, 0xff, 0x00], # 14
- [0x00, 0xff, 0xff, 0x00], # 15
- [0x80, 0x00, 0x00, 0x00], # 16
- [0x00, 0x80, 0x00, 0x00], # 17
- [0x00, 0x00, 0x80, 0x00], # 18
- [0x80, 0x80, 0x00, 0x00], # 19
- [0x80, 0x00, 0x80, 0x00], # 20
- [0x00, 0x80, 0x80, 0x00], # 21
- [0xc0, 0xc0, 0xc0, 0x00], # 22
- [0x80, 0x80, 0x80, 0x00], # 23
- [0x99, 0x99, 0xff, 0x00], # 24
- [0x99, 0x33, 0x66, 0x00], # 25
- [0xff, 0xff, 0xcc, 0x00], # 26
- [0xcc, 0xff, 0xff, 0x00], # 27
- [0x66, 0x00, 0x66, 0x00], # 28
- [0xff, 0x80, 0x80, 0x00], # 29
- [0x00, 0x66, 0xcc, 0x00], # 30
- [0xcc, 0xcc, 0xff, 0x00], # 31
- [0x00, 0x00, 0x80, 0x00], # 32
- [0xff, 0x00, 0xff, 0x00], # 33
- [0xff, 0xff, 0x00, 0x00], # 34
- [0x00, 0xff, 0xff, 0x00], # 35
- [0x80, 0x00, 0x80, 0x00], # 36
- [0x80, 0x00, 0x00, 0x00], # 37
- [0x00, 0x80, 0x80, 0x00], # 38
- [0x00, 0x00, 0xff, 0x00], # 39
- [0x00, 0xcc, 0xff, 0x00], # 40
- [0xcc, 0xff, 0xff, 0x00], # 41
- [0xcc, 0xff, 0xcc, 0x00], # 42
- [0xff, 0xff, 0x99, 0x00], # 43
- [0x99, 0xcc, 0xff, 0x00], # 44
- [0xff, 0x99, 0xcc, 0x00], # 45
- [0xcc, 0x99, 0xff, 0x00], # 46
- [0xff, 0xcc, 0x99, 0x00], # 47
- [0x33, 0x66, 0xff, 0x00], # 48
- [0x33, 0xcc, 0xcc, 0x00], # 49
- [0x99, 0xcc, 0x00, 0x00], # 50
- [0xff, 0xcc, 0x00, 0x00], # 51
- [0xff, 0x99, 0x00, 0x00], # 52
- [0xff, 0x66, 0x00, 0x00], # 53
- [0x66, 0x66, 0x99, 0x00], # 54
- [0x96, 0x96, 0x96, 0x00], # 55
- [0x00, 0x33, 0x66, 0x00], # 56
- [0x33, 0x99, 0x66, 0x00], # 57
- [0x00, 0x33, 0x00, 0x00], # 58
- [0x33, 0x33, 0x00, 0x00], # 59
- [0x99, 0x33, 0x00, 0x00], # 60
- [0x99, 0x33, 0x66, 0x00], # 61
- [0x33, 0x33, 0x99, 0x00], # 62
- [0x33, 0x33, 0x33, 0x00], # 63
- ];
-
- return 0;
-}
-
-
-###############################################################################
-#
-# set_tempdir()
-#
-# Change the default temp directory used by _initialize() in Worksheet.pm.
-#
-sub set_tempdir {
-
- my $self = shift;
-
- # Windows workaround. See Worksheet::_initialize()
- my $dir = shift || '';
-
- croak "$dir is not a valid directory" if $dir ne '' and not -d $dir;
- croak "set_tempdir must be called before add_worksheet" if $self->sheets();
-
- $self->{_tempdir} = $dir ;
-}
-
-
-###############################################################################
-#
-# set_codepage()
-#
-# See also the _store_codepage method. This is used to store the code page, i.e.
-# the character set used in the workbook.
-#
-sub set_codepage {
-
- my $self = shift;
- my $codepage = $_[0] || 1;
- $codepage = 0x04E4 if $codepage == 1;
- $codepage = 0x8000 if $codepage == 2;
- $self->{_codepage} = $codepage;
-}
-
-
-###############################################################################
-#
-# _store_workbook()
-#
-# Assemble worksheets into a workbook and send the BIFF data to an OLE
-# storage.
-#
-sub _store_workbook {
-
- my $self = shift;
-
- # Ensure that at least one worksheet has been selected.
- if ($self->{_activesheet} == 0) {
- @{$self->{_worksheets}}[0]->{_selected} = 1;
- }
-
- # Calculate the number of selected worksheet tabs and call the finalization
- # methods for each worksheet
- foreach my $sheet (@{$self->{_worksheets}}) {
- $self->{_selected}++ if $sheet->{_selected};
- $sheet->_close($self->{_sheetnames});
- }
-
- # Add Workbook globals
- $self->_store_bof(0x0005);
- $self->_store_codepage();
- $self->_store_window1();
- $self->_store_1904();
- $self->_store_all_fonts();
- $self->_store_all_num_formats();
- $self->_store_all_xfs();
- $self->_store_all_styles();
- $self->_store_palette();
-
- # Calculate the offsets required by the BOUNDSHEET records
- $self->_calc_sheet_offsets();
-
- # Add BOUNDSHEET records. For BIFF 7+ TODO ....
- foreach my $sheet (@{$self->{_worksheets}}) {
- $self->_store_boundsheet($sheet->{_name},
- $sheet->{_offset},
- $sheet->{_type},
- $sheet->{_name_encoding});
- }
-
- # NOTE: If any records are added between here and EOF the
- # _calc_sheet_offsets() should be updated to include the new length.
- if ($self->{_ext_ref_count}) {
- $self->_store_supbook();
- $self->_store_externsheet();
- $self->_store_names();
- }
- $self->_store_shared_strings();
-
- # End Workbook globals
- $self->_store_eof();
-
- # Store the workbook in an OLE container
- return $self->_store_OLE_file();
-}
-
-
-###############################################################################
-#
-# _store_OLE_file()
-#
-# Store the workbook in an OLE container if the total size of the workbook data
-# is less than ~ 7MB.
-#
-sub _store_OLE_file {
-
- my $self = shift;
-
- my $OLE = Spreadsheet::WriteExcel::OLEwriter->new($self->{_filename});
-
- # Write Worksheet data if data <~ 7MB
- if ($OLE->set_size($self->{_biffsize})) {
- $OLE->write_header();
-
- while (my $tmp = $self->get_data()) {
- $OLE->write($tmp);
- }
-
- foreach my $sheet (@{$self->{_worksheets}}) {
- while (my $tmp = $sheet->get_data()) {
- $OLE->write($tmp);
- }
- }
-
- return $OLE->close();
- }
- else {
- # File in greater than limit, set $! to "File too large"
- $! = 27; # Perl error code "File too large"
- my $maxsize = 7_087_104;
-
- croak "Maximum Spreadsheet::WriteExcel filesize, $maxsize bytes, " .
- "exceeded. To create files bigger than this limit please refer ".
- "to the \"Spreadsheet::WriteExcel::Big\" documentation.\n" ;
-
- # return 0;
- }
-}
-
-
-###############################################################################
-#
-# _calc_sheet_offsets()
-#
-# Calculate Worksheet BOF offsets records for use in the BOUNDSHEET records.
-#
-sub _calc_sheet_offsets {
-
- my $self = shift;
- my $BOF = 12;
- my $EOF = 4;
- my $offset = $self->{_datasize};
-
- # Add the length of the SST and associated CONTINUEs
- $offset += $self->_calculate_shared_string_sizes();
-
- # Add the length of the SUPBOOK, EXTERNSHEET and NAME records
- $offset += $self->_calculate_extern_sizes();
-
- foreach my $sheet (@{$self->{_worksheets}}) {
- $offset += $BOF + length($sheet->{_name});
- }
-
- $offset += $EOF;
-
- foreach my $sheet (@{$self->{_worksheets}}) {
- $sheet->{_offset} = $offset;
- $offset += $sheet->{_datasize};
- }
-
- $self->{_biffsize} = $offset;
-}
-
-
-###############################################################################
-#
-# _store_all_fonts()
-#
-# Store the Excel FONT records.
-#
-sub _store_all_fonts {
-
- my $self = shift;
-
- # _tmp_format is added by new(). We use this to write the default XF's
- my $format = $self->{_tmp_format};
- my $font = $format->get_font();
-
- # Note: Fonts are 0-indexed. According to the SDK there is no index 4,
- # so the following fonts are 0, 1, 2, 3, 5
- #
- for (1..5){
- $self->_append($font);
- }
-
-
- # Iterate through the XF objects and write a FONT record if it isn't the
- # same as the default FONT and if it hasn't already been used.
- #
- my %fonts;
- my $key;
- my $index = 6; # The first user defined FONT
-
- $key = $format->get_font_key(); # The default font from _tmp_format
- $fonts{$key} = 0; # Index of the default font
-
-
- foreach $format (@{$self->{_formats}}) {
- $key = $format->get_font_key();
-
- if (exists $fonts{$key}) {
- # FONT has already been used
- $format->{_font_index} = $fonts{$key};
- }
- else {
- # Add a new FONT record
- $fonts{$key} = $index;
- $format->{_font_index} = $index;
- $index++;
- $font = $format->get_font();
- $self->_append($font);
- }
- }
-}
-
-
-###############################################################################
-#
-# _store_all_num_formats()
-#
-# Store user defined numerical formats i.e. FORMAT records
-#
-sub _store_all_num_formats {
-
- my $self = shift;
-
- # Leaning num_format syndrome
- my %num_formats;
- my @num_formats;
- my $num_format;
- my $index = 164; # User defined FORMAT records start from 0xA4
-
-
- # Iterate through the XF objects and write a FORMAT record if it isn't a
- # built-in format type and if the FORMAT string hasn't already been used.
- #
- foreach my $format (@{$self->{_formats}}) {
- my $num_format = $format->{_num_format};
- my $encoding = $format->{_num_format_enc};
-
- # Check if $num_format is an index to a built-in format.
- # Also check for a string of zeros, which is a valid format string
- # but would evaluate to zero.
- #
- if ($num_format !~ m/^0+\d/) {
- next if $num_format =~ m/^\d+$/; # built-in
- }
-
- if (exists($num_formats{$num_format})) {
- # FORMAT has already been used
- $format->{_num_format} = $num_formats{$num_format};
- }
- else{
- # Add a new FORMAT
- $num_formats{$num_format} = $index;
- $format->{_num_format} = $index;
- $self->_store_num_format($num_format, $index, $encoding);
- $index++;
- }
- }
-}
-
-
-###############################################################################
-#
-# _store_all_xfs()
-#
-# Write all XF records.
-#
-sub _store_all_xfs {
-
- my $self = shift;
-
- # _tmp_format is added by new(). We use this to write the default XF's
- # The default font index is 0
- #
- my $format = $self->{_tmp_format};
- my $xf;
-
- for (0..14) {
- $xf = $format->get_xf('style'); # Style XF
- $self->_append($xf);
- }
-
- $xf = $format->get_xf('cell'); # Cell XF
- $self->_append($xf);
-
-
- # User defined XFs
- foreach $format (@{$self->{_formats}}) {
- $xf = $format->get_xf('cell');
- $self->_append($xf);
- }
-}
-
-
-###############################################################################
-#
-# _store_all_styles()
-#
-# Write all STYLE records.
-#
-sub _store_all_styles {
-
- my $self = shift;
-
- $self->_store_style();
-}
-
-
-###############################################################################
-#
-# _store_names()
-#
-# Write the NAME record to define the print area and the repeat rows and cols.
-#
-sub _store_names {
-
- my $self = shift;
- my $index = 0;
- my %ext_refs = %{$self->{_ext_refs}};
-
- # Create the print area NAME records
- foreach my $worksheet (@{$self->{_worksheets}}) {
-
- my $key = "$index:$index";
- my $ref = $ext_refs{$key};
- $index++;
-
- # Write a Name record if the print area has been defined
- if (defined $worksheet->{_print_rowmin}) {
- $self->_store_name_short(
- $worksheet->{_index},
- 0x06, # NAME type
- $ref,
- $worksheet->{_print_rowmin},
- $worksheet->{_print_rowmax},
- $worksheet->{_print_colmin},
- $worksheet->{_print_colmax}
- );
- }
- }
-
- $index = 0;
-
- # Create the print title NAME records
- foreach my $worksheet (@{$self->{_worksheets}}) {
-
- my $rowmin = $worksheet->{_title_rowmin};
- my $rowmax = $worksheet->{_title_rowmax};
- my $colmin = $worksheet->{_title_colmin};
- my $colmax = $worksheet->{_title_colmax};
- my $key = "$index:$index";
- my $ref = $ext_refs{$key};
- $index++;
-
- # Determine if row + col, row, col or nothing has been defined
- # and write the appropriate record
- #
- if (defined $rowmin && defined $colmin) {
- # Row and column titles have been defined.
- # Row title has been defined.
- $self->_store_name_long(
- $worksheet->{_index},
- 0x07, # NAME type
- $ref,
- $rowmin,
- $rowmax,
- $colmin,
- $colmax
- );
- }
- elsif (defined $rowmin) {
- # Row title has been defined.
- $self->_store_name_short(
- $worksheet->{_index},
- 0x07, # NAME type
- $ref,
- $rowmin,
- $rowmax,
- 0x00,
- 0xff
- );
- }
- elsif (defined $colmin) {
- # Column title has been defined.
- $self->_store_name_short(
- $worksheet->{_index},
- 0x07, # NAME type
- $ref,
- 0x0000,
- 0xffff,
- $colmin,
- $colmax
- );
- }
- else {
- # Nothing left to do
- }
- }
-}
-
-
-
-
-###############################################################################
-###############################################################################
-#
-# BIFF RECORDS
-#
-
-
-###############################################################################
-#
-# _store_window1()
-#
-# Write Excel BIFF WINDOW1 record.
-#
-sub _store_window1 {
-
- my $self = shift;
-
- my $record = 0x003D; # Record identifier
- my $length = 0x0012; # Number of bytes to follow
-
- my $xWn = 0x0000; # Horizontal position of window
- my $yWn = 0x0000; # Vertical position of window
- my $dxWn = 0x25BC; # Width of window
- my $dyWn = 0x1572; # Height of window
-
- my $grbit = 0x0038; # Option flags
- my $ctabsel = $self->{_selected}; # Number of workbook tabs selected
- my $wTabRatio = 0x0258; # Tab to scrollbar ratio
-
- my $itabFirst = $self->{_firstsheet}; # 1st displayed worksheet
- my $itabCur = $self->{_activesheet}; # Active worksheet
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvvvvvv", $xWn, $yWn, $dxWn, $dyWn,
- $grbit,
- $itabCur, $itabFirst,
- $ctabsel, $wTabRatio);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_boundsheet()
-#
-# Writes Excel BIFF BOUNDSHEET record.
-#
-sub _store_boundsheet {
-
- my $self = shift;
-
- my $record = 0x0085; # Record identifier
- my $length = 0x08 + length($_[0]); # Number of bytes to follow
-
- my $sheetname = $_[0]; # Worksheet name
- my $offset = $_[1]; # Location of worksheet BOF
- my $grbit = $_[2]; # Sheet identifier
- my $encoding = $_[3]; # Sheet name encoding
- my $cch = length($sheetname); # Length of sheet name
-
-
- $cch /= 2 if $encoding;
- $sheetname = pack 'n*', unpack 'v*', $sheetname if $encoding;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("VvCC", $offset, $grbit, $cch, $encoding);
-
- $self->_append($header, $data, $sheetname);
-}
-
-
-###############################################################################
-#
-# _store_style()
-#
-# Write Excel BIFF STYLE records.
-#
-sub _store_style {
-
- my $self = shift;
-
- my $record = 0x0293; # Record identifier
- my $length = 0x0004; # Bytes to follow
-
- my $ixfe = 0x8000; # Index to style XF
- my $BuiltIn = 0x00; # Built-in style
- my $iLevel = 0xff; # Outline style level
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vCC", $ixfe, $BuiltIn, $iLevel);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_num_format()
-#
-# Writes Excel FORMAT record for non "built-in" numerical formats.
-#
-sub _store_num_format {
-
- my $self = shift;
-
- my $record = 0x041E; # Record identifier
- my $length; # Number of bytes to follow
-
- my $format = $_[0]; # Custom format string
- my $ifmt = $_[1]; # Format index code
- my $encoding = $_[2]; # Char encoding for format string
- my $cch = length $format; # Char length of format string
-
-
- # Handle Unicode format strings.
- if ($encoding == 1) {
- croak "Uneven number of bytes in Unicode font name" if $cch % 2;
- $cch /= 2 if $self->{_font_encoding};
- $format = pack 'v*', unpack 'n*', $format;
- }
-
- # Special case to handle Euro symbol, 0x80, in non-Unicode strings.
- if ($encoding == 0 and $format =~ /\x80/) {
- $format = pack 'v*', unpack 'C*', $format;
- $format =~ s/\x80\x00/\xAC\x20/g;
- $encoding = 1;
- }
-
- $length = 0x05 + length $format;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvC", $ifmt, $cch, $encoding);
-
- $self->_append($header, $data, $format);
-}
-
-
-###############################################################################
-#
-# _store_1904()
-#
-# Write Excel 1904 record to indicate the date system in use.
-#
-sub _store_1904 {
-
- my $self = shift;
-
- my $record = 0x0022; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $f1904 = $self->{_1904}; # Flag for 1904 date system
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $f1904);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_supbook()
-#
-# Write BIFF record SUPBOOK to indicate that the workbook contains external
-# references, in our case, formula, print area and print title refs.
-#
-sub _store_supbook {
-
- my $self = shift;
-
- my $record = 0x01AE; # Record identifier
- my $length = 0x0004; # Number of bytes to follow
-
- my $ctabs = @{$self->{_worksheets}}; # Number of worksheets
- my $StVirtPath = 0x0401; # Encoded workbook filename
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vv", $ctabs, $StVirtPath);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_externsheet()
-#
-#
-# Writes the Excel BIFF EXTERNSHEET record. These references are used by
-# formulas. TODO NAME record is required to define the print area and the repeat
-# rows and columns.
-#
-sub _store_externsheet {
-
- my $self = shift;
-
- my $record = 0x0017; # Record identifier
- my $length; # Number of bytes to follow
-
-
- # Get the external refs
- my %ext_refs = %{$self->{_ext_refs}};
- my @ext_refs = sort {$ext_refs{$a} <=> $ext_refs{$b}} keys %ext_refs;
-
- # Change the external refs from stringified "1:1" to [1, 1]
- foreach my $ref (@ext_refs) {
- $ref = [split /:/, $ref];
- }
-
-
- my $cxti = scalar @ext_refs; # Number of Excel XTI structures
- my $rgxti = ''; # Array of XTI structures
-
- # Write the XTI structs
- foreach my $ext_ref (@ext_refs) {
- $rgxti .= pack("vvv", 0, $ext_ref->[0], $ext_ref->[1])
- }
-
-
- my $data = pack("v", $cxti) . $rgxti;
- my $header = pack("vv", $record, length $data);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_name_short()
-#
-#
-# Store the NAME record in the short format that is used for storing the print
-# area, repeat rows only and repeat columns only.
-#
-sub _store_name_short {
-
- my $self = shift;
-
- my $record = 0x0018; # Record identifier
- my $length = 0x001b; # Number of bytes to follow
-
- my $index = shift; # Sheet index
- my $type = shift;
- my $ext_ref = shift; # TODO
-
- my $grbit = 0x0020; # Option flags
- my $chKey = 0x00; # Keyboard shortcut
- my $cch = 0x01; # Length of text name
- my $cce = 0x000b; # Length of text definition
- my $unknown01 = 0x0000; #
- my $ixals = $index +1; # Sheet index
- my $unknown02 = 0x00; #
- my $cchCustMenu = 0x00; # Length of cust menu text
- my $cchDescription = 0x00; # Length of description text
- my $cchHelptopic = 0x00; # Length of help topic text
- my $cchStatustext = 0x00; # Length of status bar text
- my $rgch = $type; # Built-in name type
- my $unknown03 = 0x3b; #
-
- my $rowmin = $_[0]; # Start row
- my $rowmax = $_[1]; # End row
- my $colmin = $_[2]; # Start column
- my $colmax = $_[3]; # end column
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $grbit);
- $data .= pack("C", $chKey);
- $data .= pack("C", $cch);
- $data .= pack("v", $cce);
- $data .= pack("v", $unknown01);
- $data .= pack("v", $ixals);
- $data .= pack("C", $unknown02);
- $data .= pack("C", $cchCustMenu);
- $data .= pack("C", $cchDescription);
- $data .= pack("C", $cchHelptopic);
- $data .= pack("C", $cchStatustext);
- $data .= pack("C", $rgch);
- $data .= pack("C", $unknown03);
- $data .= pack("v", $ext_ref);
-
- $data .= pack("v", $rowmin);
- $data .= pack("v", $rowmax);
- $data .= pack("v", $colmin);
- $data .= pack("v", $colmax);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_name_long()
-#
-#
-# Store the NAME record in the long format that is used for storing the repeat
-# rows and columns when both are specified. This share a lot of code with
-# _store_name_short() but we use a separate method to keep the code clean.
-# Code abstraction for reuse can be carried too far, and I should know. ;-)
-#
-sub _store_name_long {
-
- my $self = shift;
-
- my $record = 0x0018; # Record identifier
- my $length = 0x002a; # Number of bytes to follow
-
- my $index = shift; # Sheet index
- my $type = shift;
- my $ext_ref = shift; # TODO
-
- my $grbit = 0x0020; # Option flags
- my $chKey = 0x00; # Keyboard shortcut
- my $cch = 0x01; # Length of text name
- my $cce = 0x001a; # Length of text definition
- my $unknown01 = 0x0000; #
- my $ixals = $index +1; # Sheet index
- my $unknown02 = 0x00; #
- my $cchCustMenu = 0x00; # Length of cust menu text
- my $cchDescription = 0x00; # Length of description text
- my $cchHelptopic = 0x00; # Length of help topic text
- my $cchStatustext = 0x00; # Length of status bar text
- my $rgch = $type; # Built-in name type
-
- my $unknown03 = 0x29;
- my $unknown04 = 0x0017;
- my $unknown05 = 0x3b;
-
- my $rowmin = $_[0]; # Start row
- my $rowmax = $_[1]; # End row
- my $colmin = $_[2]; # Start column
- my $colmax = $_[3]; # end column
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $grbit);
- $data .= pack("C", $chKey);
- $data .= pack("C", $cch);
- $data .= pack("v", $cce);
- $data .= pack("v", $unknown01);
- $data .= pack("v", $ixals);
- $data .= pack("C", $unknown02);
- $data .= pack("C", $cchCustMenu);
- $data .= pack("C", $cchDescription);
- $data .= pack("C", $cchHelptopic);
- $data .= pack("C", $cchStatustext);
- $data .= pack("C", $rgch);
-
- # Column definition
- $data .= pack("C", $unknown03);
- $data .= pack("v", $unknown04);
- $data .= pack("C", $unknown05);
- $data .= pack("v", $ext_ref);
- $data .= pack("v", 0x0000);
- $data .= pack("v", 0xffff);
- $data .= pack("v", $colmin);
- $data .= pack("v", $colmax);
-
- # Row definition
- $data .= pack("C", $unknown05);
- $data .= pack("v", $ext_ref);
- $data .= pack("v", $rowmin);
- $data .= pack("v", $rowmax);
- $data .= pack("v", 0x00);
- $data .= pack("v", 0xff);
- # End of data
- $data .= pack("C", 0x10);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_palette()
-#
-# Stores the PALETTE biff record.
-#
-sub _store_palette {
-
- my $self = shift;
-
- my $aref = $self->{_palette};
-
- my $record = 0x0092; # Record identifier
- my $length = 2 + 4 * @$aref; # Number of bytes to follow
- my $ccv = @$aref; # Number of RGB values to follow
- my $data; # The RGB data
-
- # Pack the RGB data
- $data .= pack "CCCC", @$_ for @$aref;
-
- my $header = pack("vvv", $record, $length, $ccv);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_codepage()
-#
-# Stores the CODEPAGE biff record.
-#
-sub _store_codepage {
-
- my $self = shift;
-
- my $record = 0x0042; # Record identifier
- my $length = 0x0002; # Number of bytes to follow
- my $cv = $self->{_codepage}; # The code page
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $cv);
-
- $self->_append($header, $data);
-}
-
-
-
-
-###############################################################################
-###############################################################################
-###############################################################################
-
-
-
-###############################################################################
-#
-# _calculate_extern_sizes()
-#
-# We need to calculate the space required by the SUPBOOK, EXTERNSHEET and NAME
-# records so that it can be added to the BOUNDSHEET offsets.
-#
-sub _calculate_extern_sizes {
-
- my $self = shift;
-
-
- my %ext_refs = $self->{_parser}->get_ext_sheets();
- my $ext_ref_count = scalar keys %ext_refs;
- my $length = 0;
- my $index = 0;
-
- foreach my $worksheet (@{$self->{_worksheets}}) {
-
- my $rowmin = $worksheet->{_title_rowmin};
- my $colmin = $worksheet->{_title_colmin};
- my $key = "$index:$index";
- $index++;
-
-
- # Print area NAME records
- if (defined $worksheet->{_print_rowmin}) {
- $ext_refs{$key} = $ext_ref_count++ if not exists $ext_refs{$key};
-
- $length += 31 ;
- }
-
-
- # Print title NAME records
- if (defined $rowmin and defined $colmin) {
- $ext_refs{$key} = $ext_ref_count++ if not exists $ext_refs{$key};
-
- $length += 46;
- }
- elsif (defined $rowmin or defined $colmin) {
- $ext_refs{$key} = $ext_ref_count++ if not exists $ext_refs{$key};
-
- $length += 31;
- }
- else {
- # TODO
- }
-
-
- }
-
-
- # TODO
- $self->{_ext_ref_count} = $ext_ref_count;
- $self->{_ext_refs} = {%ext_refs};
-
-
-
- # If there are no external refs then we don't write, SUPBOOK, EXTERNSHEET
- # and NAME. Therefore the length is 0.
-
- return $length = 0 if $ext_ref_count == 0;
-
-
-
- # The SUPBOOK record is 8 bytes
- $length += 8;
-
- # The EXTERNSHEET record is 6 bytes + 6 bytes for each external ref
- $length += 6 * (1 + $ext_ref_count);
-
- return $length;
-}
-
-
-###############################################################################
-#
-# _calculate_shared_string_sizes()
-#
-# Handling of the SST continue blocks is complicated by the need to include an
-# additional continuation byte depending on whether the string is split between
-# blocks or whether it starts at the beginning of the block. (There are also
-# additional complications that will arise later when/if Rich Strings are
-# supported). As such we cannot use the simple CONTINUE mechanism provided by
-# the _add_continue() method in BIFFwriter.pm. Thus we have to make two passes
-# through the strings data. The first is to calculate the required block sizes
-# and the second, in _store_shared_strings(), is to write the actual strings.
-# The first pass through the data is also used to calculate the size of the SST
-# and CONTINUE records for use in setting the BOUNDSHEET record offsets. The
-# downside of this is that the same algorithm repeated in _store_shared_strings.
-#
-sub _calculate_shared_string_sizes {
-
- my $self = shift;
-
- my @strings;
- $#strings = $self->{_str_unique} -1; # Pre-extend array
-
- while (my $key = each %{$self->{_str_table}}) {
- $strings[$self->{_str_table}->{$key}] = $key;
- }
-
- # The SST data could be very large, free some memory (maybe).
- $self->{_str_table} = undef;
- $self->{_str_array} = [@strings];
-
-
- # Iterate through the strings to calculate the CONTINUE block sizes.
- #
- # The SST blocks requires a specialised CONTINUE block, so we have to
- # ensure that the maximum data block size is less than the limit used by
- # _add_continue() in BIFFwriter.pm. For simplicity we use the same size
- # for the SST and CONTINUE records:
- # 8228 : Maximum Excel97 block size
- # -4 : Length of block header
- # -8 : Length of additional SST header information
- # -8 : Arbitrary number to keep within _add_continue() limit
- # = 8208
- #
- my $continue_limit = 8208;
- my $block_length = 0;
- my $written = 0;
- my @block_sizes;
- my $continue = 0;
-
- for my $string (@strings) {
-
- my $string_length = length $string;
- my $encoding = unpack "xx C", $string;
- my $split_string = 0;
-
-
- # Block length is the total length of the strings that will be
- # written out in a single SST or CONTINUE block.
- #
- $block_length += $string_length;
-
-
- # We can write the string if it doesn't cross a CONTINUE boundary
- if ($block_length < $continue_limit) {
- $written += $string_length;
- next;
- }
-
-
- # Deal with the cases where the next string to be written will exceed
- # the CONTINUE boundary. If the string is very long it may need to be
- # written in more than one CONTINUE record.
- #
- while ($block_length >= $continue_limit) {
-
- # We need to avoid the case where a string is continued in the first
- # n bytes that contain the string header information.
- #
- my $header_length = 3; # Min string + header size -1
- my $space_remaining = $continue_limit -$written -$continue;
-
-
- # Unicode data should only be split on char (2 byte) boundaries.
- # Therefore, in some cases we need to reduce the amount of available
- # space by 1 byte to ensure the correct alignment.
- my $align = 0;
-
- # Only applies to Unicode strings
- if ($encoding == 1) {
- # Min string + header size -1
- $header_length = 4;
-
- if ($space_remaining > $header_length) {
- # String contains 3 byte header => split on odd boundary
- if (not $split_string and $space_remaining % 2 != 1) {
- $space_remaining--;
- $align = 1;
- }
- # Split section without header => split on even boundary
- elsif ($split_string and $space_remaining % 2 == 1) {
- $space_remaining--;
- $align = 1;
- }
-
- $split_string = 1;
- }
- }
-
-
- if ($space_remaining > $header_length) {
- # Write as much as possible of the string in the current block
- $written += $space_remaining;
-
- # Reduce the current block length by the amount written
- $block_length -= $continue_limit -$continue -$align;
-
- # Store the max size for this block
- push @block_sizes, $continue_limit -$align;
-
- # If the current string was split then the next CONTINUE block
- # should have the string continue flag (grbit) set unless the
- # split string fits exactly into the remaining space.
- #
- if ($block_length > 0) {
- $continue = 1;
- }
- else {
- $continue = 0;
- }
-
- }
- else {
- # Store the max size for this block
- push @block_sizes, $written +$continue;
-
- # Not enough space to start the string in the current block
- $block_length -= $continue_limit -$space_remaining -$continue;
- $continue = 0;
-
- }
-
- # If the string (or substr) is small enough we can write it in the
- # new CONTINUE block. Else, go through the loop again to write it in
- # one or more CONTINUE blocks
- #
- if ($block_length < $continue_limit) {
- $written = $block_length;
- }
- else {
- $written = 0;
- }
- }
- }
-
- # Store the max size for the last block unless it is empty
- push @block_sizes, $written +$continue if $written +$continue;
-
-
- $self->{_str_block_sizes} = [@block_sizes];
-
-
- # Calculate the total length of the SST and associated CONTINUEs (if any).
- # The SST record will have a length even if it contains no strings.
- # This length is required to set the offsets in the BOUNDSHEET records since
- # they must be written before the SST records
- #
- my $length = 12;
- $length += shift @block_sizes if @block_sizes; # SST
- $length += 4 + shift @block_sizes while @block_sizes; # CONTINUEs
-
- return $length;
-}
-
-
-###############################################################################
-#
-# _store_shared_strings()
-#
-# Write all of the workbooks strings into an indexed array.
-#
-# See the comments in _calculate_shared_string_sizes() for more information.
-#
-# The Excel documentation says that the SST record should be followed by an
-# EXTSST record. The EXTSST record is a hash table that is used to optimise
-# access to SST. However, despite the documentation it doesn't seem to be
-# required so we will ignore it.
-#
-sub _store_shared_strings {
-
- my $self = shift;
-
- my @strings = @{$self->{_str_array}};
-
-
- my $record = 0x00FC; # Record identifier
- my $length = 0x0008; # Number of bytes to follow
- my $total = 0x0000;
-
- # Iterate through the strings to calculate the CONTINUE block sizes
- my $continue_limit = 8208;
- my $block_length = 0;
- my $written = 0;
- my $continue = 0;
-
- # The SST and CONTINUE block sizes have been pre-calculated by
- # _calculate_shared_string_sizes()
- my @block_sizes = @{$self->{_str_block_sizes}};
-
-
- # The SST record is required even if it contains no strings. Thus we will
- # always have a length
- #
- if (@block_sizes) {
- $length = 8 + shift @block_sizes;
- }
- else {
- # No strings
- $length = 8;
- }
-
- # Write the SST block header information
- my $header = pack("vv", $record, $length);
- my $data = pack("VV", $self->{_str_total}, $self->{_str_unique});
- $self->_append($header, $data);
-
-
- # Iterate through the strings and write them out
- for my $string (@strings) {
-
- my $string_length = length $string;
- my $encoding = unpack "xx C", $string;
- my $split_string = 0;
-
-
- # Block length is the total length of the strings that will be
- # written out in a single SST or CONTINUE block.
- #
- $block_length += $string_length;
-
-
- # We can write the string if it doesn't cross a CONTINUE boundary
- if ($block_length < $continue_limit) {
- $self->_append($string);
- $written += $string_length;
- next;
- }
-
-
- # Deal with the cases where the next string to be written will exceed
- # the CONTINUE boundary. If the string is very long it may need to be
- # written in more than one CONTINUE record.
- #
- while ($block_length >= $continue_limit) {
-
- # We need to avoid the case where a string is continued in the first
- # n bytes that contain the string header information.
- #
- my $header_length = 3; # Min string + header size -1
- my $space_remaining = $continue_limit -$written -$continue;
-
-
- # Unicode data should only be split on char (2 byte) boundaries.
- # Therefore, in some cases we need to reduce the amount of available
- # space by 1 byte to ensure the correct alignment.
- my $align = 0;
-
- # Only applies to Unicode strings
- if ($encoding == 1) {
- # Min string + header size -1
- $header_length = 4;
-
- if ($space_remaining > $header_length) {
- # String contains 3 byte header => split on odd boundary
- if (not $split_string and $space_remaining % 2 != 1) {
- $space_remaining--;
- $align = 1;
- }
- # Split section without header => split on even boundary
- elsif ($split_string and $space_remaining % 2 == 1) {
- $space_remaining--;
- $align = 1;
- }
-
- $split_string = 1;
- }
- }
-
-
- if ($space_remaining > $header_length) {
- # Write as much as possible of the string in the current block
- my $tmp = substr $string, 0, $space_remaining;
- $self->_append($tmp);
-
- # The remainder will be written in the next block(s)
- $string = substr $string, $space_remaining;
-
- # Reduce the current block length by the amount written
- $block_length -= $continue_limit -$continue -$align;
-
- # If the current string was split then the next CONTINUE block
- # should have the string continue flag (grbit) set unless the
- # split string fits exactly into the remaining space.
- #
- if ($block_length > 0) {
- $continue = 1;
- }
- else {
- $continue = 0;
- }
- }
- else {
- # Not enough space to start the string in the current block
- $block_length -= $continue_limit -$space_remaining -$continue;
- $continue = 0;
- }
-
- # Write the CONTINUE block header
- if (@block_sizes) {
- $record = 0x003C;
- $length = shift @block_sizes;
-
- $header = pack("vv", $record, $length);
- $header .= pack("C", $encoding) if $continue;
-
- $self->_append($header);
- }
-
- # If the string (or substr) is small enough we can write it in the
- # new CONTINUE block. Else, go through the loop again to write it in
- # one or more CONTINUE blocks
- #
- if ($block_length < $continue_limit) {
- $self->_append($string);
-
- $written = $block_length;
- }
- else {
- $written = 0;
- }
- }
- }
-}
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-Workbook - A writer class for Excel Workbooks.
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel
-
-=head1 DESCRIPTION
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
+package Spreadsheet::WriteExcel::Workbook;
+
+###############################################################################
+#
+# Workbook - A writer class for Excel Workbooks.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+use Carp;
+use Spreadsheet::WriteExcel::BIFFwriter;
+use Spreadsheet::WriteExcel::OLEwriter;
+use Spreadsheet::WriteExcel::Worksheet;
+use Spreadsheet::WriteExcel::Format;
+use Spreadsheet::WriteExcel::Chart;
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Spreadsheet::WriteExcel::BIFFwriter Exporter);
+
+$VERSION = '2.10';
+
+###############################################################################
+#
+# new()
+#
+# Constructor. Creates a new Workbook object from a BIFFwriter object.
+#
+sub new {
+
+ my $class = shift;
+ my $self = Spreadsheet::WriteExcel::BIFFwriter->new();
+ my $tmp_format = Spreadsheet::WriteExcel::Format->new();
+ my $byte_order = $self->{_byte_order};
+ my $parser = Spreadsheet::WriteExcel::Formula->new($byte_order);
+
+ $self->{_filename} = $_[0] || '';
+ $self->{_parser} = $parser;
+ $self->{_tempdir} = undef;
+ $self->{_1904} = 0;
+ $self->{_activesheet} = 0;
+ $self->{_firstsheet} = 0;
+ $self->{_selected} = 0;
+ $self->{_xf_index} = 16; # 15 style XF's and 1 cell XF.
+ $self->{_fileclosed} = 0;
+ $self->{_biffsize} = 0;
+ $self->{_sheetname} = "Sheet";
+ $self->{_tmp_format} = $tmp_format;
+ $self->{_url_format} = '';
+ $self->{_codepage} = 0x04E4;
+ $self->{_worksheets} = [];
+ $self->{_sheetnames} = [];
+ $self->{_formats} = [];
+ $self->{_palette} = [];
+
+ $self->{_using_tmpfile} = 1;
+ $self->{_filehandle} = "";
+ $self->{_temp_file} = "";
+
+ $self->{_str_total} = 0;
+ $self->{_str_unique} = 0;
+ $self->{_str_table} = {};
+ $self->{_str_array} = [];
+ $self->{_str_block_sizes} = [];
+
+ $self->{_ext_ref_count} = 0;
+ $self->{_ext_refs} = {};
+
+ bless $self, $class;
+
+ # Add the default format for hyperlinks
+ $self->{_url_format} = $self->add_format(color => 'blue', underline => 1);
+
+
+ # Check for a filename unless it is an existing filehandle
+ if (not ref $self->{_filename} and $self->{_filename} eq '') {
+ carp 'Filename required by Spreadsheet::WriteExcel->new()';
+ return undef;
+ }
+
+
+ # Try to open the named file and see if it throws any errors.
+ # If the filename is a reference it is assumed that it is a valid
+ # filehandle and ignored
+ #
+ if (not ref $self->{_filename}) {
+ my $fh = FileHandle->new('>'. $self->{_filename});
+ if (not defined $fh) {
+ carp "Can't open " .
+ $self->{_filename} .
+ ". It may be in use or protected";
+ return undef;
+ }
+ $fh->close;
+ }
+
+
+ # Set colour palette.
+ $self->set_palette_xl97();
+
+ $self->_initialize();
+ return $self;
+}
+
+
+###############################################################################
+#
+# _initialize()
+#
+# Open a tmp file to store the majority of the Worksheet data. If this fails,
+# for example due to write permissions, store the data in memory. This can be
+# slow for large files.
+#
+# TODO: Move this and other methods shared with Worksheet up into BIFFWriter.
+#
+sub _initialize {
+
+ my $self = shift;
+ my $fh;
+ my $tmp_dir;
+
+ # The following code is complicated by Windows limitations. Porters can
+ # choose a more direct method.
+
+
+
+ # In the default case we use IO::File->new_tmpfile(). This may fail, in
+ # particular with IIS on Windows, so we allow the user to specify a temp
+ # directory via File::Temp.
+ #
+ if (defined $self->{_tempdir}) {
+
+ # Delay loading File:Temp to reduce the module dependencies.
+ eval { require File::Temp };
+ die "The File::Temp module must be installed in order ".
+ "to call set_tempdir().\n" if $@;
+
+
+ # Trap but ignore File::Temp errors.
+ eval { $fh = File::Temp::tempfile(DIR => $self->{_tempdir}) };
+
+ # Store the failed tmp dir in case of errors.
+ $tmp_dir = $self->{_tempdir} || File::Spec->tmpdir if not $fh;
+ }
+ else {
+
+ $fh = IO::File->new_tmpfile();
+
+ # Store the failed tmp dir in case of errors.
+ $tmp_dir = "POSIX::tmpnam() directory" if not $fh;
+ }
+
+
+ # Check if the temp file creation was successful. Else store data in memory.
+ if ($fh) {
+
+ # binmode file whether platform requires it or not.
+ binmode($fh);
+
+ # Store filehandle
+ $self->{_filehandle} = $fh;
+ }
+ else {
+
+ # Set flag to store data in memory if XX::tempfile() failed.
+ $self->{_using_tmpfile} = 0;
+
+ if ($^W) {
+ my $dir = $self->{_tempdir} || File::Spec->tmpdir();
+
+ warn "Unable to create temp files in $tmp_dir. Data will be ".
+ "stored in memory. Refer to set_tempdir() in the ".
+ "Spreadsheet::WriteExcel documentation.\n" ;
+ }
+ }
+}
+
+
+###############################################################################
+#
+# _append(), overloaded.
+#
+# Store Worksheet data in memory using the base class _append() or to a
+# temporary file, the default.
+#
+sub _append {
+
+ my $self = shift;
+
+ if ($self->{_using_tmpfile}) {
+ my $data = join('', @_);
+
+ # Add CONTINUE records if necessary
+ $data = $self->_add_continue($data) if length($data) > $self->{_limit};
+
+ # Protect print() from -l on the command line.
+ local $\ = undef;
+
+ print {$self->{_filehandle}} $data;
+ $self->{_datasize} += length($data);
+ }
+ else {
+ $self->SUPER::_append(@_);
+ }
+}
+
+
+###############################################################################
+#
+# get_data().
+#
+# Retrieves data from memory in one chunk, or from disk in $buffer
+# sized chunks.
+#
+sub get_data {
+
+ my $self = shift;
+ my $buffer = 4096;
+ my $tmp;
+
+ # Return data stored in memory
+ if (defined $self->{_data}) {
+ $tmp = $self->{_data};
+ $self->{_data} = undef;
+ my $fh = $self->{_filehandle};
+ seek($fh, 0, 0) if $self->{_using_tmpfile};
+ return $tmp;
+ }
+
+ # Return data stored on disk
+ if ($self->{_using_tmpfile}) {
+ return $tmp if read($self->{_filehandle}, $tmp, $buffer);
+ }
+
+ # No data to return
+ return undef;
+}
+
+
+###############################################################################
+#
+# close()
+#
+# Calls finalization methods and explicitly close the OLEwriter file
+# handle.
+#
+sub close {
+
+ my $self = shift;
+
+ return if $self->{_fileclosed}; # Prevent close() from being called twice.
+
+ $self->{_fileclosed} = 1;
+
+ return $self->_store_workbook();
+}
+
+
+###############################################################################
+#
+# DESTROY()
+#
+# Close the workbook if it hasn't already been explicitly closed.
+#
+sub DESTROY {
+
+ my $self = shift;
+
+ $self->close() if not $self->{_fileclosed};
+}
+
+
+###############################################################################
+#
+# sheets(slice,...)
+#
+# An accessor for the _worksheets[] array
+#
+# Returns: an optionally sliced list of the worksheet objects in a workbook.
+#
+sub sheets {
+
+ my $self = shift;
+
+ if (@_) {
+ # Return a slice of the array
+ return @{$self->{_worksheets}}[@_];
+ }
+ else {
+ # Return the entire list
+ return @{$self->{_worksheets}};
+ }
+}
+
+
+###############################################################################
+#
+# worksheets()
+#
+# An accessor for the _worksheets[] array.
+# This method is now deprecated. Use the sheets() method instead.
+#
+# Returns: an array reference
+#
+sub worksheets {
+
+ my $self = shift;
+
+ return $self->{_worksheets};
+}
+
+
+###############################################################################
+#
+# add_worksheet($name, $encoding)
+#
+# Add a new worksheet to the Excel workbook.
+#
+# Returns: reference to a worksheet object
+#
+sub add_worksheet {
+
+ my $self = shift;
+ my $index = @{$self->{_worksheets}};
+
+ my ($name, $encoding) = $self->_check_sheetname($_[0], $_[1]);
+
+
+ # Porters take note, the following scheme of passing references to Workbook
+ # data (in the \$self->{_foo} cases) instead of a reference to the Workbook
+ # itself is a workaround to avoid circular references between Workbook and
+ # Worksheet objects. Feel free to implement this in any way the suits your
+ # language.
+ #
+ my @init_data = (
+ $name,
+ $index,
+ $encoding,
+ \$self->{_activesheet},
+ \$self->{_firstsheet},
+ $self->{_url_format},
+ $self->{_parser},
+ $self->{_tempdir},
+ \$self->{_str_total},
+ \$self->{_str_unique},
+ \$self->{_str_table},
+ $self->{_1904},
+ );
+
+ my $worksheet = Spreadsheet::WriteExcel::Worksheet->new(@init_data);
+ $self->{_worksheets}->[$index] = $worksheet; # Store ref for iterator
+ $self->{_sheetnames}->[$index] = $name; # Store EXTERNSHEET names
+ $self->{_parser}->set_ext_sheets($name, $index); # Store names in Formula.pm
+ return $worksheet;
+}
+
+
+###############################################################################
+#
+# add_chart_ext($name, $filename)
+#
+# Add an externally created chart.
+#
+#
+sub add_chart_ext {
+
+ my $self = shift;
+ my $filename = $_[0];
+ my $index = @{$self->{_worksheets}};
+
+ my ($name, $encoding) = $self->_check_sheetname($_[1], $_[2]);
+
+
+ my @init_data = (
+ $filename,
+ $name,
+ $index,
+ $encoding,
+ \$self->{_activesheet},
+ \$self->{_firstsheet},
+ );
+
+ my $worksheet = Spreadsheet::WriteExcel::Chart->new(@init_data);
+ $self->{_worksheets}->[$index] = $worksheet; # Store ref for iterator
+ $self->{_sheetnames}->[$index] = $name; # Store EXTERNSHEET names
+ $self->{_parser}->set_ext_sheets($name, $index); # Store names in Formula.pm
+ return $worksheet;
+}
+
+
+###############################################################################
+#
+# _check_sheetname($name, $encoding)
+#
+# Check for valid worksheet names. We check the length, if it contains any
+# invalid characters and if the name is unique in the workbook.
+#
+sub _check_sheetname {
+
+ my $self = shift;
+ my $name = $_[0] || "";
+ my $encoding = $_[1] || 0;
+ my $limit = $encoding ? 62 : 31;
+ my $invalid_char = qr([\[\]:*?/\\]);
+
+ # Supply default "Sheet" name if none has been defined.
+ my $index = @{$self->{_worksheets}};
+ my $sheetname = $self->{_sheetname};
+
+ if ($name eq "" ) {
+ $name = $sheetname . ($index+1);
+ $encoding = 0;
+ }
+
+
+ # Check that sheetname is <= 31 (1 or 2 byte chars). Excel limit.
+ croak "Sheetname $name must be <= 31 chars" if length $name > $limit;
+
+ # Check that Unicode sheetname has an even number of bytes
+ croak 'Odd number of bytes in Unicode worksheet name:' . $name
+ if $encoding == 1 and length($name) % 2;
+
+
+ # Check that sheetname doesn't contain any invalid characters
+ if ($encoding != 1 and $name =~ $invalid_char) {
+ # Check ASCII names
+ croak 'Invalid character []:*?/\\ in worksheet name: ' . $name;
+ }
+ else {
+ # Extract any 8bit clean chars from the UTF16 name and validate them.
+ for my $wchar ($name =~ /../sg) {
+ my ($hi, $lo) = unpack "aa", $wchar;
+ if ($hi eq "\0" and $lo =~ $invalid_char) {
+ croak 'Invalid character []:*?/\\ in worksheet name: ' . $name;
+ }
+ }
+ }
+
+
+ # Handle utf8 strings in newer perls.
+ if ($] >= 5.008) {
+ require Encode;
+
+ if (Encode::is_utf8($name)) {
+ $name = Encode::encode("UTF-16BE", $name);
+ $encoding = 1;
+ }
+ }
+
+
+ # Check that the worksheet name doesn't already exist since this is a fatal
+ # error in Excel 97. The check must also exclude case insensitive matches
+ # since the names 'Sheet1' and 'sheet1' are equivalent. The tests also have
+ # to take the encoding into account.
+ #
+ foreach my $worksheet (@{$self->{_worksheets}}) {
+ my $name_a = $name;
+ my $encd_a = $encoding;
+ my $name_b = $worksheet->{_name};
+ my $encd_b = $worksheet->{_encoding};
+ my $error = 0;
+
+ if ($encd_a == 0 and $encd_b == 0) {
+ $error = 1 if lc($name_a) eq lc($name_b);
+ }
+ elsif ($encd_a == 0 and $encd_b == 1) {
+ $name_a = pack "n*", unpack "C*", $name_a;
+ $error = 1 if lc($name_a) eq lc($name_b);
+ }
+ elsif ($encd_a == 1 and $encd_b == 0) {
+ $name_b = pack "n*", unpack "C*", $name_b;
+ $error = 1 if lc($name_a) eq lc($name_b);
+ }
+ elsif ($encd_a == 1 and $encd_b == 1) {
+ # We can do a true case insensitive test with Perl 5.8 and utf8.
+ if ($] >= 5.008) {
+ $name_a = Encode::decode("UTF-16BE", $name_a);
+ $name_b = Encode::decode("UTF-16BE", $name_b);
+ $error = 1 if lc($name_a) eq lc($name_b);
+ }
+ else {
+ # We can't easily do a case insensite test of the UTF16 names.
+ # As a special case we check if all of the high bytes are nulls and
+ # then do an ASCII style case insensitive test.
+
+ # Strip out the high bytes (funkily).
+ my $hi_a = grep {ord} $name_a =~ /(.)./sg;
+ my $hi_b = grep {ord} $name_b =~ /(.)./sg;
+
+ if ($hi_a or $hi_b) {
+ $error = 1 if $name_a eq $name_b;
+ }
+ else {
+ $error = 1 if lc($name_a) eq lc($name_b);
+ }
+ }
+ }
+
+ # If any of the cases failed we throw the error here.
+ if ($error) {
+ croak "Worksheet name '$name', with case ignored, " .
+ "is already in use";
+ }
+ }
+
+ return ($name, $encoding);
+}
+
+
+###############################################################################
+#
+# addworksheet($name)
+#
+# This method is now deprecated. Use the add_worksheet() method instead.
+#
+sub addworksheet {
+
+ my $self = shift;
+
+ $self->add_worksheet(@_);
+}
+
+
+###############################################################################
+#
+# add_format(%properties)
+#
+# Add a new format to the Excel workbook. This adds an XF record and
+# a FONT record. Also, pass any properties to the Format::new().
+#
+sub add_format {
+
+ my $self = shift;
+
+ my $format = Spreadsheet::WriteExcel::Format->new($self->{_xf_index}, @_);
+
+ $self->{_xf_index} += 1;
+ push @{$self->{_formats}}, $format; # Store format reference
+
+ return $format;
+}
+
+
+###############################################################################
+#
+# addformat()
+#
+# This method is now deprecated. Use the add_format() method instead.
+#
+sub addformat {
+
+ my $self = shift;
+
+ $self->add_format(@_);
+}
+
+
+###############################################################################
+#
+# set_1904()
+#
+# Set the date system: 0 = 1900 (the default), 1 = 1904
+#
+sub set_1904 {
+
+ my $self = shift;
+
+ croak "set_1904() must be called before add_worksheet" if $self->sheets();
+
+
+ if (defined($_[0])) {
+ $self->{_1904} = $_[0];
+ }
+ else {
+ $self->{_1904} = 1;
+ }
+}
+
+
+###############################################################################
+#
+# get_1904()
+#
+# Return the date system: 0 = 1900, 1 = 1904
+#
+sub get_1904 {
+
+ my $self = shift;
+
+ return $self->{_1904};
+}
+
+
+###############################################################################
+#
+# set_custom_color()
+#
+# Change the RGB components of the elements in the colour palette.
+#
+sub set_custom_color {
+
+ my $self = shift;
+
+
+ # Match a HTML #xxyyzz style parameter
+ if (defined $_[1] and $_[1] =~ /^#(\w\w)(\w\w)(\w\w)/ ) {
+ @_ = ($_[0], hex $1, hex $2, hex $3);
+ }
+
+
+ my $index = $_[0] || 0;
+ my $red = $_[1] || 0;
+ my $green = $_[2] || 0;
+ my $blue = $_[3] || 0;
+
+ my $aref = $self->{_palette};
+
+ # Check that the colour index is the right range
+ if ($index < 8 or $index > 64) {
+ carp "Color index $index outside range: 8 <= index <= 64";
+ return 0;
+ }
+
+ # Check that the colour components are in the right range
+ if ( ($red < 0 or $red > 255) ||
+ ($green < 0 or $green > 255) ||
+ ($blue < 0 or $blue > 255) )
+ {
+ carp "Color component outside range: 0 <= color <= 255";
+ return 0;
+ }
+
+ $index -=8; # Adjust colour index (wingless dragonfly)
+
+ # Set the RGB value
+ $$aref[$index] = [$red, $green, $blue, 0];
+
+ return $index +8;
+}
+
+
+###############################################################################
+#
+# set_palette_xl97()
+#
+# Sets the colour palette to the Excel 97+ default.
+#
+sub set_palette_xl97 {
+
+ my $self = shift;
+
+ $self->{_palette} = [
+ [0x00, 0x00, 0x00, 0x00], # 8
+ [0xff, 0xff, 0xff, 0x00], # 9
+ [0xff, 0x00, 0x00, 0x00], # 10
+ [0x00, 0xff, 0x00, 0x00], # 11
+ [0x00, 0x00, 0xff, 0x00], # 12
+ [0xff, 0xff, 0x00, 0x00], # 13
+ [0xff, 0x00, 0xff, 0x00], # 14
+ [0x00, 0xff, 0xff, 0x00], # 15
+ [0x80, 0x00, 0x00, 0x00], # 16
+ [0x00, 0x80, 0x00, 0x00], # 17
+ [0x00, 0x00, 0x80, 0x00], # 18
+ [0x80, 0x80, 0x00, 0x00], # 19
+ [0x80, 0x00, 0x80, 0x00], # 20
+ [0x00, 0x80, 0x80, 0x00], # 21
+ [0xc0, 0xc0, 0xc0, 0x00], # 22
+ [0x80, 0x80, 0x80, 0x00], # 23
+ [0x99, 0x99, 0xff, 0x00], # 24
+ [0x99, 0x33, 0x66, 0x00], # 25
+ [0xff, 0xff, 0xcc, 0x00], # 26
+ [0xcc, 0xff, 0xff, 0x00], # 27
+ [0x66, 0x00, 0x66, 0x00], # 28
+ [0xff, 0x80, 0x80, 0x00], # 29
+ [0x00, 0x66, 0xcc, 0x00], # 30
+ [0xcc, 0xcc, 0xff, 0x00], # 31
+ [0x00, 0x00, 0x80, 0x00], # 32
+ [0xff, 0x00, 0xff, 0x00], # 33
+ [0xff, 0xff, 0x00, 0x00], # 34
+ [0x00, 0xff, 0xff, 0x00], # 35
+ [0x80, 0x00, 0x80, 0x00], # 36
+ [0x80, 0x00, 0x00, 0x00], # 37
+ [0x00, 0x80, 0x80, 0x00], # 38
+ [0x00, 0x00, 0xff, 0x00], # 39
+ [0x00, 0xcc, 0xff, 0x00], # 40
+ [0xcc, 0xff, 0xff, 0x00], # 41
+ [0xcc, 0xff, 0xcc, 0x00], # 42
+ [0xff, 0xff, 0x99, 0x00], # 43
+ [0x99, 0xcc, 0xff, 0x00], # 44
+ [0xff, 0x99, 0xcc, 0x00], # 45
+ [0xcc, 0x99, 0xff, 0x00], # 46
+ [0xff, 0xcc, 0x99, 0x00], # 47
+ [0x33, 0x66, 0xff, 0x00], # 48
+ [0x33, 0xcc, 0xcc, 0x00], # 49
+ [0x99, 0xcc, 0x00, 0x00], # 50
+ [0xff, 0xcc, 0x00, 0x00], # 51
+ [0xff, 0x99, 0x00, 0x00], # 52
+ [0xff, 0x66, 0x00, 0x00], # 53
+ [0x66, 0x66, 0x99, 0x00], # 54
+ [0x96, 0x96, 0x96, 0x00], # 55
+ [0x00, 0x33, 0x66, 0x00], # 56
+ [0x33, 0x99, 0x66, 0x00], # 57
+ [0x00, 0x33, 0x00, 0x00], # 58
+ [0x33, 0x33, 0x00, 0x00], # 59
+ [0x99, 0x33, 0x00, 0x00], # 60
+ [0x99, 0x33, 0x66, 0x00], # 61
+ [0x33, 0x33, 0x99, 0x00], # 62
+ [0x33, 0x33, 0x33, 0x00], # 63
+ ];
+
+ return 0;
+}
+
+
+###############################################################################
+#
+# set_tempdir()
+#
+# Change the default temp directory used by _initialize() in Worksheet.pm.
+#
+sub set_tempdir {
+
+ my $self = shift;
+
+ # Windows workaround. See Worksheet::_initialize()
+ my $dir = shift || '';
+
+ croak "$dir is not a valid directory" if $dir ne '' and not -d $dir;
+ croak "set_tempdir must be called before add_worksheet" if $self->sheets();
+
+ $self->{_tempdir} = $dir ;
+}
+
+
+###############################################################################
+#
+# set_codepage()
+#
+# See also the _store_codepage method. This is used to store the code page, i.e.
+# the character set used in the workbook.
+#
+sub set_codepage {
+
+ my $self = shift;
+ my $codepage = $_[0] || 1;
+ $codepage = 0x04E4 if $codepage == 1;
+ $codepage = 0x8000 if $codepage == 2;
+ $self->{_codepage} = $codepage;
+}
+
+
+###############################################################################
+#
+# _store_workbook()
+#
+# Assemble worksheets into a workbook and send the BIFF data to an OLE
+# storage.
+#
+sub _store_workbook {
+
+ my $self = shift;
+
+ # Ensure that at least one worksheet has been selected.
+ if ($self->{_activesheet} == 0) {
+ @{$self->{_worksheets}}[0]->{_selected} = 1;
+ }
+
+ # Calculate the number of selected worksheet tabs and call the finalization
+ # methods for each worksheet
+ foreach my $sheet (@{$self->{_worksheets}}) {
+ $self->{_selected}++ if $sheet->{_selected};
+ $sheet->_close($self->{_sheetnames});
+ }
+
+ # Add Workbook globals
+ $self->_store_bof(0x0005);
+ $self->_store_codepage();
+ $self->_store_window1();
+ $self->_store_1904();
+ $self->_store_all_fonts();
+ $self->_store_all_num_formats();
+ $self->_store_all_xfs();
+ $self->_store_all_styles();
+ $self->_store_palette();
+
+ # Calculate the offsets required by the BOUNDSHEET records
+ $self->_calc_sheet_offsets();
+
+ # Add BOUNDSHEET records. For BIFF 7+ TODO ....
+ foreach my $sheet (@{$self->{_worksheets}}) {
+ $self->_store_boundsheet($sheet->{_name},
+ $sheet->{_offset},
+ $sheet->{_type},
+ $sheet->{_encoding});
+ }
+
+ # NOTE: If any records are added between here and EOF the
+ # _calc_sheet_offsets() should be updated to include the new length.
+ if ($self->{_ext_ref_count}) {
+ $self->_store_supbook();
+ $self->_store_externsheet();
+ $self->_store_names();
+ }
+ $self->_store_shared_strings();
+
+ # End Workbook globals
+ $self->_store_eof();
+
+ # Store the workbook in an OLE container
+ return $self->_store_OLE_file();
+}
+
+
+###############################################################################
+#
+# _store_OLE_file()
+#
+# Store the workbook in an OLE container if the total size of the workbook data
+# is less than ~ 7MB.
+#
+sub _store_OLE_file {
+
+ my $self = shift;
+
+ my $OLE = Spreadsheet::WriteExcel::OLEwriter->new($self->{_filename});
+
+ # Write Worksheet data if data <~ 7MB
+ if ($OLE->set_size($self->{_biffsize})) {
+ $OLE->write_header();
+
+ while (my $tmp = $self->get_data()) {
+ $OLE->write($tmp);
+ }
+
+ foreach my $sheet (@{$self->{_worksheets}}) {
+ while (my $tmp = $sheet->get_data()) {
+ $OLE->write($tmp);
+ }
+ }
+
+ return $OLE->close();
+ }
+ else {
+ # File in greater than limit, set $! to "File too large"
+ $! = 27; # Perl error code "File too large"
+ my $maxsize = 7_087_104;
+
+ croak "Maximum Spreadsheet::WriteExcel filesize, $maxsize bytes, " .
+ "exceeded. To create files bigger than this limit please refer ".
+ "to the \"Spreadsheet::WriteExcel::Big\" documentation.\n" ;
+
+ # return 0;
+ }
+}
+
+
+###############################################################################
+#
+# _calc_sheet_offsets()
+#
+# Calculate Worksheet BOF offsets records for use in the BOUNDSHEET records.
+#
+sub _calc_sheet_offsets {
+
+ my $self = shift;
+ my $BOF = 12;
+ my $EOF = 4;
+ my $offset = $self->{_datasize};
+
+ # Add the length of the SST and associated CONTINUEs
+ $offset += $self->_calculate_shared_string_sizes();
+
+ # Add the length of the SUPBOOK, EXTERNSHEET and NAME records
+ $offset += $self->_calculate_extern_sizes();
+
+ foreach my $sheet (@{$self->{_worksheets}}) {
+ $offset += $BOF + length($sheet->{_name});
+ }
+
+ $offset += $EOF;
+
+ foreach my $sheet (@{$self->{_worksheets}}) {
+ $sheet->{_offset} = $offset;
+ $offset += $sheet->{_datasize};
+ }
+
+ $self->{_biffsize} = $offset;
+}
+
+
+###############################################################################
+#
+# _store_all_fonts()
+#
+# Store the Excel FONT records.
+#
+sub _store_all_fonts {
+
+ my $self = shift;
+
+ # _tmp_format is added by new(). We use this to write the default XF's
+ my $format = $self->{_tmp_format};
+ my $font = $format->get_font();
+
+ # Note: Fonts are 0-indexed. According to the SDK there is no index 4,
+ # so the following fonts are 0, 1, 2, 3, 5
+ #
+ for (1..5){
+ $self->_append($font);
+ }
+
+
+ # Iterate through the XF objects and write a FONT record if it isn't the
+ # same as the default FONT and if it hasn't already been used.
+ #
+ my %fonts;
+ my $key;
+ my $index = 6; # The first user defined FONT
+
+ $key = $format->get_font_key(); # The default font from _tmp_format
+ $fonts{$key} = 0; # Index of the default font
+
+
+ foreach $format (@{$self->{_formats}}) {
+ $key = $format->get_font_key();
+
+ if (exists $fonts{$key}) {
+ # FONT has already been used
+ $format->{_font_index} = $fonts{$key};
+ }
+ else {
+ # Add a new FONT record
+ $fonts{$key} = $index;
+ $format->{_font_index} = $index;
+ $index++;
+ $font = $format->get_font();
+ $self->_append($font);
+ }
+ }
+}
+
+
+###############################################################################
+#
+# _store_all_num_formats()
+#
+# Store user defined numerical formats i.e. FORMAT records
+#
+sub _store_all_num_formats {
+
+ my $self = shift;
+
+ # Leaning num_format syndrome
+ my %num_formats;
+ my @num_formats;
+ my $num_format;
+ my $index = 164; # User defined FORMAT records start from 0xA4
+
+
+ # Iterate through the XF objects and write a FORMAT record if it isn't a
+ # built-in format type and if the FORMAT string hasn't already been used.
+ #
+ foreach my $format (@{$self->{_formats}}) {
+ my $num_format = $format->{_num_format};
+ my $encoding = $format->{_num_format_enc};
+
+ # Check if $num_format is an index to a built-in format.
+ # Also check for a string of zeros, which is a valid format string
+ # but would evaluate to zero.
+ #
+ if ($num_format !~ m/^0+\d/) {
+ next if $num_format =~ m/^\d+$/; # built-in
+ }
+
+ if (exists($num_formats{$num_format})) {
+ # FORMAT has already been used
+ $format->{_num_format} = $num_formats{$num_format};
+ }
+ else{
+ # Add a new FORMAT
+ $num_formats{$num_format} = $index;
+ $format->{_num_format} = $index;
+ $self->_store_num_format($num_format, $index, $encoding);
+ $index++;
+ }
+ }
+}
+
+
+###############################################################################
+#
+# _store_all_xfs()
+#
+# Write all XF records.
+#
+sub _store_all_xfs {
+
+ my $self = shift;
+
+ # _tmp_format is added by new(). We use this to write the default XF's
+ # The default font index is 0
+ #
+ my $format = $self->{_tmp_format};
+ my $xf;
+
+ for (0..14) {
+ $xf = $format->get_xf('style'); # Style XF
+ $self->_append($xf);
+ }
+
+ $xf = $format->get_xf('cell'); # Cell XF
+ $self->_append($xf);
+
+
+ # User defined XFs
+ foreach $format (@{$self->{_formats}}) {
+ $xf = $format->get_xf('cell');
+ $self->_append($xf);
+ }
+}
+
+
+###############################################################################
+#
+# _store_all_styles()
+#
+# Write all STYLE records.
+#
+sub _store_all_styles {
+
+ my $self = shift;
+
+ $self->_store_style();
+}
+
+
+###############################################################################
+#
+# _store_names()
+#
+# Write the NAME record to define the print area and the repeat rows and cols.
+#
+sub _store_names {
+
+ my $self = shift;
+ my $index = 0;
+ my %ext_refs = %{$self->{_ext_refs}};
+
+ # Create the print area NAME records
+ foreach my $worksheet (@{$self->{_worksheets}}) {
+
+ my $key = "$index:$index";
+ my $ref = $ext_refs{$key};
+ $index++;
+
+ # Write a Name record if the print area has been defined
+ if (defined $worksheet->{_print_rowmin}) {
+ $self->_store_name_short(
+ $worksheet->{_index},
+ 0x06, # NAME type
+ $ref,
+ $worksheet->{_print_rowmin},
+ $worksheet->{_print_rowmax},
+ $worksheet->{_print_colmin},
+ $worksheet->{_print_colmax}
+ );
+ }
+ }
+
+ $index = 0;
+
+ # Create the print title NAME records
+ foreach my $worksheet (@{$self->{_worksheets}}) {
+
+ my $rowmin = $worksheet->{_title_rowmin};
+ my $rowmax = $worksheet->{_title_rowmax};
+ my $colmin = $worksheet->{_title_colmin};
+ my $colmax = $worksheet->{_title_colmax};
+ my $key = "$index:$index";
+ my $ref = $ext_refs{$key};
+ $index++;
+
+ # Determine if row + col, row, col or nothing has been defined
+ # and write the appropriate record
+ #
+ if (defined $rowmin && defined $colmin) {
+ # Row and column titles have been defined.
+ # Row title has been defined.
+ $self->_store_name_long(
+ $worksheet->{_index},
+ 0x07, # NAME type
+ $ref,
+ $rowmin,
+ $rowmax,
+ $colmin,
+ $colmax
+ );
+ }
+ elsif (defined $rowmin) {
+ # Row title has been defined.
+ $self->_store_name_short(
+ $worksheet->{_index},
+ 0x07, # NAME type
+ $ref,
+ $rowmin,
+ $rowmax,
+ 0x00,
+ 0xff
+ );
+ }
+ elsif (defined $colmin) {
+ # Column title has been defined.
+ $self->_store_name_short(
+ $worksheet->{_index},
+ 0x07, # NAME type
+ $ref,
+ 0x0000,
+ 0xffff,
+ $colmin,
+ $colmax
+ );
+ }
+ else {
+ # Nothing left to do
+ }
+ }
+}
+
+
+
+
+###############################################################################
+###############################################################################
+#
+# BIFF RECORDS
+#
+
+
+###############################################################################
+#
+# _store_window1()
+#
+# Write Excel BIFF WINDOW1 record.
+#
+sub _store_window1 {
+
+ my $self = shift;
+
+ my $record = 0x003D; # Record identifier
+ my $length = 0x0012; # Number of bytes to follow
+
+ my $xWn = 0x0000; # Horizontal position of window
+ my $yWn = 0x0000; # Vertical position of window
+ my $dxWn = 0x25BC; # Width of window
+ my $dyWn = 0x1572; # Height of window
+
+ my $grbit = 0x0038; # Option flags
+ my $ctabsel = $self->{_selected}; # Number of workbook tabs selected
+ my $wTabRatio = 0x0258; # Tab to scrollbar ratio
+
+ my $itabFirst = $self->{_firstsheet}; # 1st displayed worksheet
+ my $itabCur = $self->{_activesheet}; # Active worksheet
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvvvvvv", $xWn, $yWn, $dxWn, $dyWn,
+ $grbit,
+ $itabCur, $itabFirst,
+ $ctabsel, $wTabRatio);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_boundsheet()
+#
+# Writes Excel BIFF BOUNDSHEET record.
+#
+sub _store_boundsheet {
+
+ my $self = shift;
+
+ my $record = 0x0085; # Record identifier
+ my $length = 0x08 + length($_[0]); # Number of bytes to follow
+
+ my $sheetname = $_[0]; # Worksheet name
+ my $offset = $_[1]; # Location of worksheet BOF
+ my $grbit = $_[2]; # Sheet identifier
+ my $encoding = $_[3]; # Sheet name encoding
+ my $cch = length($sheetname); # Length of sheet name
+
+ # Character length is num of chars not num of bytes
+ $cch /= 2 if $encoding;
+
+ # Change the UTF-16 name from BE to LE
+ $sheetname = pack 'n*', unpack 'v*', $sheetname if $encoding;
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("VvCC", $offset, $grbit, $cch, $encoding);
+
+ $self->_append($header, $data, $sheetname);
+}
+
+
+###############################################################################
+#
+# _store_style()
+#
+# Write Excel BIFF STYLE records.
+#
+sub _store_style {
+
+ my $self = shift;
+
+ my $record = 0x0293; # Record identifier
+ my $length = 0x0004; # Bytes to follow
+
+ my $ixfe = 0x8000; # Index to style XF
+ my $BuiltIn = 0x00; # Built-in style
+ my $iLevel = 0xff; # Outline style level
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vCC", $ixfe, $BuiltIn, $iLevel);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_num_format()
+#
+# Writes Excel FORMAT record for non "built-in" numerical formats.
+#
+sub _store_num_format {
+
+ my $self = shift;
+
+ my $record = 0x041E; # Record identifier
+ my $length; # Number of bytes to follow
+
+ my $format = $_[0]; # Custom format string
+ my $ifmt = $_[1]; # Format index code
+ my $encoding = $_[2]; # Char encoding for format string
+
+
+ # Handle utf8 strings in newer perls.
+ if ($] >= 5.008) {
+ require Encode;
+
+ if (Encode::is_utf8($format)) {
+ $format = Encode::encode("UTF-16BE", $format);
+ $encoding = 1;
+ }
+ }
+
+
+ my $cch = length $format; # Char length of format string
+
+ # Handle Unicode format strings.
+ if ($encoding == 1) {
+ croak "Uneven number of bytes in Unicode font name" if $cch % 2;
+ $cch /= 2 if $encoding;
+ $format = pack 'v*', unpack 'n*', $format;
+ }
+
+ # Special case to handle Euro symbol, 0x80, in non-Unicode strings.
+ if ($encoding == 0 and $format =~ /\x80/) {
+ $format = pack 'v*', unpack 'C*', $format;
+ $format =~ s/\x80\x00/\xAC\x20/g;
+ $encoding = 1;
+ }
+
+ $length = 0x05 + length $format;
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvC", $ifmt, $cch, $encoding);
+
+ $self->_append($header, $data, $format);
+}
+
+
+###############################################################################
+#
+# _store_1904()
+#
+# Write Excel 1904 record to indicate the date system in use.
+#
+sub _store_1904 {
+
+ my $self = shift;
+
+ my $record = 0x0022; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $f1904 = $self->{_1904}; # Flag for 1904 date system
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $f1904);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_supbook()
+#
+# Write BIFF record SUPBOOK to indicate that the workbook contains external
+# references, in our case, formula, print area and print title refs.
+#
+sub _store_supbook {
+
+ my $self = shift;
+
+ my $record = 0x01AE; # Record identifier
+ my $length = 0x0004; # Number of bytes to follow
+
+ my $ctabs = @{$self->{_worksheets}}; # Number of worksheets
+ my $StVirtPath = 0x0401; # Encoded workbook filename
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vv", $ctabs, $StVirtPath);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_externsheet()
+#
+#
+# Writes the Excel BIFF EXTERNSHEET record. These references are used by
+# formulas. TODO NAME record is required to define the print area and the repeat
+# rows and columns.
+#
+sub _store_externsheet {
+
+ my $self = shift;
+
+ my $record = 0x0017; # Record identifier
+ my $length; # Number of bytes to follow
+
+
+ # Get the external refs
+ my %ext_refs = %{$self->{_ext_refs}};
+ my @ext_refs = sort {$ext_refs{$a} <=> $ext_refs{$b}} keys %ext_refs;
+
+ # Change the external refs from stringified "1:1" to [1, 1]
+ foreach my $ref (@ext_refs) {
+ $ref = [split /:/, $ref];
+ }
+
+
+ my $cxti = scalar @ext_refs; # Number of Excel XTI structures
+ my $rgxti = ''; # Array of XTI structures
+
+ # Write the XTI structs
+ foreach my $ext_ref (@ext_refs) {
+ $rgxti .= pack("vvv", 0, $ext_ref->[0], $ext_ref->[1])
+ }
+
+
+ my $data = pack("v", $cxti) . $rgxti;
+ my $header = pack("vv", $record, length $data);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_name_short()
+#
+#
+# Store the NAME record in the short format that is used for storing the print
+# area, repeat rows only and repeat columns only.
+#
+sub _store_name_short {
+
+ my $self = shift;
+
+ my $record = 0x0018; # Record identifier
+ my $length = 0x001b; # Number of bytes to follow
+
+ my $index = shift; # Sheet index
+ my $type = shift;
+ my $ext_ref = shift; # TODO
+
+ my $grbit = 0x0020; # Option flags
+ my $chKey = 0x00; # Keyboard shortcut
+ my $cch = 0x01; # Length of text name
+ my $cce = 0x000b; # Length of text definition
+ my $unknown01 = 0x0000; #
+ my $ixals = $index +1; # Sheet index
+ my $unknown02 = 0x00; #
+ my $cchCustMenu = 0x00; # Length of cust menu text
+ my $cchDescription = 0x00; # Length of description text
+ my $cchHelptopic = 0x00; # Length of help topic text
+ my $cchStatustext = 0x00; # Length of status bar text
+ my $rgch = $type; # Built-in name type
+ my $unknown03 = 0x3b; #
+
+ my $rowmin = $_[0]; # Start row
+ my $rowmax = $_[1]; # End row
+ my $colmin = $_[2]; # Start column
+ my $colmax = $_[3]; # end column
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $grbit);
+ $data .= pack("C", $chKey);
+ $data .= pack("C", $cch);
+ $data .= pack("v", $cce);
+ $data .= pack("v", $unknown01);
+ $data .= pack("v", $ixals);
+ $data .= pack("C", $unknown02);
+ $data .= pack("C", $cchCustMenu);
+ $data .= pack("C", $cchDescription);
+ $data .= pack("C", $cchHelptopic);
+ $data .= pack("C", $cchStatustext);
+ $data .= pack("C", $rgch);
+ $data .= pack("C", $unknown03);
+ $data .= pack("v", $ext_ref);
+
+ $data .= pack("v", $rowmin);
+ $data .= pack("v", $rowmax);
+ $data .= pack("v", $colmin);
+ $data .= pack("v", $colmax);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_name_long()
+#
+#
+# Store the NAME record in the long format that is used for storing the repeat
+# rows and columns when both are specified. This share a lot of code with
+# _store_name_short() but we use a separate method to keep the code clean.
+# Code abstraction for reuse can be carried too far, and I should know. ;-)
+#
+sub _store_name_long {
+
+ my $self = shift;
+
+ my $record = 0x0018; # Record identifier
+ my $length = 0x002a; # Number of bytes to follow
+
+ my $index = shift; # Sheet index
+ my $type = shift;
+ my $ext_ref = shift; # TODO
+
+ my $grbit = 0x0020; # Option flags
+ my $chKey = 0x00; # Keyboard shortcut
+ my $cch = 0x01; # Length of text name
+ my $cce = 0x001a; # Length of text definition
+ my $unknown01 = 0x0000; #
+ my $ixals = $index +1; # Sheet index
+ my $unknown02 = 0x00; #
+ my $cchCustMenu = 0x00; # Length of cust menu text
+ my $cchDescription = 0x00; # Length of description text
+ my $cchHelptopic = 0x00; # Length of help topic text
+ my $cchStatustext = 0x00; # Length of status bar text
+ my $rgch = $type; # Built-in name type
+
+ my $unknown03 = 0x29;
+ my $unknown04 = 0x0017;
+ my $unknown05 = 0x3b;
+
+ my $rowmin = $_[0]; # Start row
+ my $rowmax = $_[1]; # End row
+ my $colmin = $_[2]; # Start column
+ my $colmax = $_[3]; # end column
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $grbit);
+ $data .= pack("C", $chKey);
+ $data .= pack("C", $cch);
+ $data .= pack("v", $cce);
+ $data .= pack("v", $unknown01);
+ $data .= pack("v", $ixals);
+ $data .= pack("C", $unknown02);
+ $data .= pack("C", $cchCustMenu);
+ $data .= pack("C", $cchDescription);
+ $data .= pack("C", $cchHelptopic);
+ $data .= pack("C", $cchStatustext);
+ $data .= pack("C", $rgch);
+
+ # Column definition
+ $data .= pack("C", $unknown03);
+ $data .= pack("v", $unknown04);
+ $data .= pack("C", $unknown05);
+ $data .= pack("v", $ext_ref);
+ $data .= pack("v", 0x0000);
+ $data .= pack("v", 0xffff);
+ $data .= pack("v", $colmin);
+ $data .= pack("v", $colmax);
+
+ # Row definition
+ $data .= pack("C", $unknown05);
+ $data .= pack("v", $ext_ref);
+ $data .= pack("v", $rowmin);
+ $data .= pack("v", $rowmax);
+ $data .= pack("v", 0x00);
+ $data .= pack("v", 0xff);
+ # End of data
+ $data .= pack("C", 0x10);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_palette()
+#
+# Stores the PALETTE biff record.
+#
+sub _store_palette {
+
+ my $self = shift;
+
+ my $aref = $self->{_palette};
+
+ my $record = 0x0092; # Record identifier
+ my $length = 2 + 4 * @$aref; # Number of bytes to follow
+ my $ccv = @$aref; # Number of RGB values to follow
+ my $data; # The RGB data
+
+ # Pack the RGB data
+ $data .= pack "CCCC", @$_ for @$aref;
+
+ my $header = pack("vvv", $record, $length, $ccv);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_codepage()
+#
+# Stores the CODEPAGE biff record.
+#
+sub _store_codepage {
+
+ my $self = shift;
+
+ my $record = 0x0042; # Record identifier
+ my $length = 0x0002; # Number of bytes to follow
+ my $cv = $self->{_codepage}; # The code page
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $cv);
+
+ $self->_append($header, $data);
+}
+
+
+
+
+###############################################################################
+###############################################################################
+###############################################################################
+
+
+
+###############################################################################
+#
+# _calculate_extern_sizes()
+#
+# We need to calculate the space required by the SUPBOOK, EXTERNSHEET and NAME
+# records so that it can be added to the BOUNDSHEET offsets.
+#
+sub _calculate_extern_sizes {
+
+ my $self = shift;
+
+
+ my %ext_refs = $self->{_parser}->get_ext_sheets();
+ my $ext_ref_count = scalar keys %ext_refs;
+ my $length = 0;
+ my $index = 0;
+
+ foreach my $worksheet (@{$self->{_worksheets}}) {
+
+ my $rowmin = $worksheet->{_title_rowmin};
+ my $colmin = $worksheet->{_title_colmin};
+ my $key = "$index:$index";
+ $index++;
+
+
+ # Print area NAME records
+ if (defined $worksheet->{_print_rowmin}) {
+ $ext_refs{$key} = $ext_ref_count++ if not exists $ext_refs{$key};
+
+ $length += 31 ;
+ }
+
+
+ # Print title NAME records
+ if (defined $rowmin and defined $colmin) {
+ $ext_refs{$key} = $ext_ref_count++ if not exists $ext_refs{$key};
+
+ $length += 46;
+ }
+ elsif (defined $rowmin or defined $colmin) {
+ $ext_refs{$key} = $ext_ref_count++ if not exists $ext_refs{$key};
+
+ $length += 31;
+ }
+ else {
+ # TODO
+ }
+
+
+ }
+
+
+ # TODO
+ $self->{_ext_ref_count} = $ext_ref_count;
+ $self->{_ext_refs} = {%ext_refs};
+
+
+
+ # If there are no external refs then we don't write, SUPBOOK, EXTERNSHEET
+ # and NAME. Therefore the length is 0.
+
+ return $length = 0 if $ext_ref_count == 0;
+
+
+
+ # The SUPBOOK record is 8 bytes
+ $length += 8;
+
+ # The EXTERNSHEET record is 6 bytes + 6 bytes for each external ref
+ $length += 6 * (1 + $ext_ref_count);
+
+ return $length;
+}
+
+
+###############################################################################
+#
+# _calculate_shared_string_sizes()
+#
+# Handling of the SST continue blocks is complicated by the need to include an
+# additional continuation byte depending on whether the string is split between
+# blocks or whether it starts at the beginning of the block. (There are also
+# additional complications that will arise later when/if Rich Strings are
+# supported). As such we cannot use the simple CONTINUE mechanism provided by
+# the _add_continue() method in BIFFwriter.pm. Thus we have to make two passes
+# through the strings data. The first is to calculate the required block sizes
+# and the second, in _store_shared_strings(), is to write the actual strings.
+# The first pass through the data is also used to calculate the size of the SST
+# and CONTINUE records for use in setting the BOUNDSHEET record offsets. The
+# downside of this is that the same algorithm repeated in _store_shared_strings.
+#
+sub _calculate_shared_string_sizes {
+
+ my $self = shift;
+
+ my @strings;
+ $#strings = $self->{_str_unique} -1; # Pre-extend array
+
+ while (my $key = each %{$self->{_str_table}}) {
+ $strings[$self->{_str_table}->{$key}] = $key;
+ }
+
+ # The SST data could be very large, free some memory (maybe).
+ $self->{_str_table} = undef;
+ $self->{_str_array} = [@strings];
+
+
+ # Iterate through the strings to calculate the CONTINUE block sizes.
+ #
+ # The SST blocks requires a specialised CONTINUE block, so we have to
+ # ensure that the maximum data block size is less than the limit used by
+ # _add_continue() in BIFFwriter.pm. For simplicity we use the same size
+ # for the SST and CONTINUE records:
+ # 8228 : Maximum Excel97 block size
+ # -4 : Length of block header
+ # -8 : Length of additional SST header information
+ # -8 : Arbitrary number to keep within _add_continue() limit
+ # = 8208
+ #
+ my $continue_limit = 8208;
+ my $block_length = 0;
+ my $written = 0;
+ my @block_sizes;
+ my $continue = 0;
+
+ for my $string (@strings) {
+
+ my $string_length = length $string;
+ my $encoding = unpack "xx C", $string;
+ my $split_string = 0;
+
+
+ # Block length is the total length of the strings that will be
+ # written out in a single SST or CONTINUE block.
+ #
+ $block_length += $string_length;
+
+
+ # We can write the string if it doesn't cross a CONTINUE boundary
+ if ($block_length < $continue_limit) {
+ $written += $string_length;
+ next;
+ }
+
+
+ # Deal with the cases where the next string to be written will exceed
+ # the CONTINUE boundary. If the string is very long it may need to be
+ # written in more than one CONTINUE record.
+ #
+ while ($block_length >= $continue_limit) {
+
+ # We need to avoid the case where a string is continued in the first
+ # n bytes that contain the string header information.
+ #
+ my $header_length = 3; # Min string + header size -1
+ my $space_remaining = $continue_limit -$written -$continue;
+
+
+ # Unicode data should only be split on char (2 byte) boundaries.
+ # Therefore, in some cases we need to reduce the amount of available
+ # space by 1 byte to ensure the correct alignment.
+ my $align = 0;
+
+ # Only applies to Unicode strings
+ if ($encoding == 1) {
+ # Min string + header size -1
+ $header_length = 4;
+
+ if ($space_remaining > $header_length) {
+ # String contains 3 byte header => split on odd boundary
+ if (not $split_string and $space_remaining % 2 != 1) {
+ $space_remaining--;
+ $align = 1;
+ }
+ # Split section without header => split on even boundary
+ elsif ($split_string and $space_remaining % 2 == 1) {
+ $space_remaining--;
+ $align = 1;
+ }
+
+ $split_string = 1;
+ }
+ }
+
+
+ if ($space_remaining > $header_length) {
+ # Write as much as possible of the string in the current block
+ $written += $space_remaining;
+
+ # Reduce the current block length by the amount written
+ $block_length -= $continue_limit -$continue -$align;
+
+ # Store the max size for this block
+ push @block_sizes, $continue_limit -$align;
+
+ # If the current string was split then the next CONTINUE block
+ # should have the string continue flag (grbit) set unless the
+ # split string fits exactly into the remaining space.
+ #
+ if ($block_length > 0) {
+ $continue = 1;
+ }
+ else {
+ $continue = 0;
+ }
+
+ }
+ else {
+ # Store the max size for this block
+ push @block_sizes, $written +$continue;
+
+ # Not enough space to start the string in the current block
+ $block_length -= $continue_limit -$space_remaining -$continue;
+ $continue = 0;
+
+ }
+
+ # If the string (or substr) is small enough we can write it in the
+ # new CONTINUE block. Else, go through the loop again to write it in
+ # one or more CONTINUE blocks
+ #
+ if ($block_length < $continue_limit) {
+ $written = $block_length;
+ }
+ else {
+ $written = 0;
+ }
+ }
+ }
+
+ # Store the max size for the last block unless it is empty
+ push @block_sizes, $written +$continue if $written +$continue;
+
+
+ $self->{_str_block_sizes} = [@block_sizes];
+
+
+ # Calculate the total length of the SST and associated CONTINUEs (if any).
+ # The SST record will have a length even if it contains no strings.
+ # This length is required to set the offsets in the BOUNDSHEET records since
+ # they must be written before the SST records
+ #
+ my $length = 12;
+ $length += shift @block_sizes if @block_sizes; # SST
+ $length += 4 + shift @block_sizes while @block_sizes; # CONTINUEs
+
+ return $length;
+}
+
+
+###############################################################################
+#
+# _store_shared_strings()
+#
+# Write all of the workbooks strings into an indexed array.
+#
+# See the comments in _calculate_shared_string_sizes() for more information.
+#
+# The Excel documentation says that the SST record should be followed by an
+# EXTSST record. The EXTSST record is a hash table that is used to optimise
+# access to SST. However, despite the documentation it doesn't seem to be
+# required so we will ignore it.
+#
+sub _store_shared_strings {
+
+ my $self = shift;
+
+ my @strings = @{$self->{_str_array}};
+
+
+ my $record = 0x00FC; # Record identifier
+ my $length = 0x0008; # Number of bytes to follow
+ my $total = 0x0000;
+
+ # Iterate through the strings to calculate the CONTINUE block sizes
+ my $continue_limit = 8208;
+ my $block_length = 0;
+ my $written = 0;
+ my $continue = 0;
+
+ # The SST and CONTINUE block sizes have been pre-calculated by
+ # _calculate_shared_string_sizes()
+ my @block_sizes = @{$self->{_str_block_sizes}};
+
+
+ # The SST record is required even if it contains no strings. Thus we will
+ # always have a length
+ #
+ if (@block_sizes) {
+ $length = 8 + shift @block_sizes;
+ }
+ else {
+ # No strings
+ $length = 8;
+ }
+
+ # Write the SST block header information
+ my $header = pack("vv", $record, $length);
+ my $data = pack("VV", $self->{_str_total}, $self->{_str_unique});
+ $self->_append($header, $data);
+
+
+ # Iterate through the strings and write them out
+ for my $string (@strings) {
+
+ my $string_length = length $string;
+ my $encoding = unpack "xx C", $string;
+ my $split_string = 0;
+
+
+ # Block length is the total length of the strings that will be
+ # written out in a single SST or CONTINUE block.
+ #
+ $block_length += $string_length;
+
+
+ # We can write the string if it doesn't cross a CONTINUE boundary
+ if ($block_length < $continue_limit) {
+ $self->_append($string);
+ $written += $string_length;
+ next;
+ }
+
+
+ # Deal with the cases where the next string to be written will exceed
+ # the CONTINUE boundary. If the string is very long it may need to be
+ # written in more than one CONTINUE record.
+ #
+ while ($block_length >= $continue_limit) {
+
+ # We need to avoid the case where a string is continued in the first
+ # n bytes that contain the string header information.
+ #
+ my $header_length = 3; # Min string + header size -1
+ my $space_remaining = $continue_limit -$written -$continue;
+
+
+ # Unicode data should only be split on char (2 byte) boundaries.
+ # Therefore, in some cases we need to reduce the amount of available
+ # space by 1 byte to ensure the correct alignment.
+ my $align = 0;
+
+ # Only applies to Unicode strings
+ if ($encoding == 1) {
+ # Min string + header size -1
+ $header_length = 4;
+
+ if ($space_remaining > $header_length) {
+ # String contains 3 byte header => split on odd boundary
+ if (not $split_string and $space_remaining % 2 != 1) {
+ $space_remaining--;
+ $align = 1;
+ }
+ # Split section without header => split on even boundary
+ elsif ($split_string and $space_remaining % 2 == 1) {
+ $space_remaining--;
+ $align = 1;
+ }
+
+ $split_string = 1;
+ }
+ }
+
+
+ if ($space_remaining > $header_length) {
+ # Write as much as possible of the string in the current block
+ my $tmp = substr $string, 0, $space_remaining;
+ $self->_append($tmp);
+
+ # The remainder will be written in the next block(s)
+ $string = substr $string, $space_remaining;
+
+ # Reduce the current block length by the amount written
+ $block_length -= $continue_limit -$continue -$align;
+
+ # If the current string was split then the next CONTINUE block
+ # should have the string continue flag (grbit) set unless the
+ # split string fits exactly into the remaining space.
+ #
+ if ($block_length > 0) {
+ $continue = 1;
+ }
+ else {
+ $continue = 0;
+ }
+ }
+ else {
+ # Not enough space to start the string in the current block
+ $block_length -= $continue_limit -$space_remaining -$continue;
+ $continue = 0;
+ }
+
+ # Write the CONTINUE block header
+ if (@block_sizes) {
+ $record = 0x003C;
+ $length = shift @block_sizes;
+
+ $header = pack("vv", $record, $length);
+ $header .= pack("C", $encoding) if $continue;
+
+ $self->_append($header);
+ }
+
+ # If the string (or substr) is small enough we can write it in the
+ # new CONTINUE block. Else, go through the loop again to write it in
+ # one or more CONTINUE blocks
+ #
+ if ($block_length < $continue_limit) {
+ $self->_append($string);
+
+ $written = $block_length;
+ }
+ else {
+ $written = 0;
+ }
+ }
+ }
+}
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+Workbook - A writer class for Excel Workbooks.
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel
+
+=head1 DESCRIPTION
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/WorkbookBig.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/WorkbookBig.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/WorkbookBig.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,112 +1,112 @@
-package Spreadsheet::WriteExcel::WorkbookBig;
-
-###############################################################################
-#
-# WorkbookBig - A writer class for Excel Workbooks > 7MB.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara and Kawai Takanori.
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-use Carp;
-use Spreadsheet::WriteExcel::Workbook;
-use OLE::Storage_Lite;
-use Spreadsheet::WriteExcel::Worksheet;
-use Spreadsheet::WriteExcel::Format;
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Spreadsheet::WriteExcel::Workbook Exporter);
-
-$VERSION = '2.01';
-
-###############################################################################
-#
-# new()
-#
-# Constructor. Creates a new WorkbookBig object from a Workbook object.
-#
-sub new {
-
- my $class = shift;
- my $self = Spreadsheet::WriteExcel::Workbook->new(@_);
-
- bless $self, $class;
- return $self;
-}
-
-
-###############################################################################
-#
-# _store_OLE_file(). Over-ridden.
-#
-# Store the workbook in an OLE container using OLE::Storage_Lite.
-#
-sub _store_OLE_file {
-
- my $self = shift;
-
- my $tmp;
- my $OLE = OLE::Storage_Lite::PPS::File->newFile(
- OLE::Storage_Lite::Asc2Ucs('Book'));
-
-
- $OLE->append($tmp) while $tmp = $self->get_data();
-
- foreach my $worksheet (@{$self->{_worksheets}}) {
- $OLE->append($tmp) while $tmp = $worksheet->get_data();
- }
-
- my @ltime = localtime();
- splice(@ltime, 6);
- my $date = OLE::Storage_Lite::PPS::Root->new(\@ltime, \@ltime,[$OLE,]);
- $date->save($self->{_filename});
-}
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-WorkbookBig - A writer class for Excel Workbooks > 7MB.
-
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel.
-
-
-=head1 DESCRIPTION
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
-It is a sub-class of the Spreadsheet::WriteExcel::Workbook module.
-
-
-=head1 REQUIREMENTS
-
-IO::Stringy and OLE::Storage_Lite
-
-
-=head1 AUTHORS
-
-John McNamara jmcnamara at cpan.org
-
-Kawai Takanori kwitknr at cpan.org
-
-
-=head1 COPYRIGHT
-
-© MM-MMIV, John McNamara and Kawai Takanori.
-
-All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
+package Spreadsheet::WriteExcel::WorkbookBig;
+
+###############################################################################
+#
+# WorkbookBig - A writer class for Excel Workbooks > 7MB.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara and Kawai Takanori.
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+use Carp;
+use Spreadsheet::WriteExcel::Workbook;
+use OLE::Storage_Lite;
+use Spreadsheet::WriteExcel::Worksheet;
+use Spreadsheet::WriteExcel::Format;
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Spreadsheet::WriteExcel::Workbook Exporter);
+
+$VERSION = '2.01';
+
+###############################################################################
+#
+# new()
+#
+# Constructor. Creates a new WorkbookBig object from a Workbook object.
+#
+sub new {
+
+ my $class = shift;
+ my $self = Spreadsheet::WriteExcel::Workbook->new(@_);
+
+ bless $self, $class;
+ return $self;
+}
+
+
+###############################################################################
+#
+# _store_OLE_file(). Over-ridden.
+#
+# Store the workbook in an OLE container using OLE::Storage_Lite.
+#
+sub _store_OLE_file {
+
+ my $self = shift;
+
+ my $tmp;
+ my $OLE = OLE::Storage_Lite::PPS::File->newFile(
+ OLE::Storage_Lite::Asc2Ucs('Book'));
+
+
+ $OLE->append($tmp) while $tmp = $self->get_data();
+
+ foreach my $worksheet (@{$self->{_worksheets}}) {
+ $OLE->append($tmp) while $tmp = $worksheet->get_data();
+ }
+
+ my @ltime = localtime();
+ splice(@ltime, 6);
+ my $date = OLE::Storage_Lite::PPS::Root->new(\@ltime, \@ltime,[$OLE,]);
+ $date->save($self->{_filename});
+}
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+WorkbookBig - A writer class for Excel Workbooks > 7MB.
+
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel.
+
+
+=head1 DESCRIPTION
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+It is a sub-class of the Spreadsheet::WriteExcel::Workbook module.
+
+
+=head1 REQUIREMENTS
+
+IO::Stringy and OLE::Storage_Lite
+
+
+=head1 AUTHORS
+
+John McNamara jmcnamara at cpan.org
+
+Kawai Takanori kwitknr at cpan.org
+
+
+=head1 COPYRIGHT
+
+© MM-MMV, John McNamara and Kawai Takanori.
+
+All Rights Reserved. This module is free software. It may be used, redistributed and/or modified under the same terms as Perl itself.
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Worksheet.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Worksheet.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel/Worksheet.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,4190 +1,4238 @@
-package Spreadsheet::WriteExcel::Worksheet;
-
-###############################################################################
-#
-# Worksheet - A writer class for Excel Worksheets.
-#
-#
-# Used in conjunction with Spreadsheet::WriteExcel
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-use strict;
-use Carp;
-use Spreadsheet::WriteExcel::BIFFwriter;
-use Spreadsheet::WriteExcel::Format;
-use Spreadsheet::WriteExcel::Formula;
-
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Spreadsheet::WriteExcel::BIFFwriter);
-
-$VERSION = '2.11';
-
-###############################################################################
-#
-# new()
-#
-# Constructor. Creates a new Worksheet object from a BIFFwriter object
-#
-sub new {
-
- my $class = shift;
- my $self = Spreadsheet::WriteExcel::BIFFwriter->new();
- my $rowmax = 65536;
- my $colmax = 256;
- my $strmax = 0;
-
- $self->{_name} = $_[0];
- $self->{_index} = $_[1];
- $self->{_name_encoding} = $_[2];
- $self->{_activesheet} = $_[3];
- $self->{_firstsheet} = $_[4];
- $self->{_url_format} = $_[5];
- $self->{_parser} = $_[6];
- $self->{_tempdir} = $_[7];
-
- $self->{_str_total} = $_[8];
- $self->{_str_unique} = $_[9];
- $self->{_str_table} = $_[10];
- $self->{_1904} = $_[11];
-
- $self->{_type} = 0x0000;
- $self->{_ext_sheets} = [];
- $self->{_using_tmpfile} = 1;
- $self->{_filehandle} = "";
- $self->{_fileclosed} = 0;
- $self->{_offset} = 0;
- $self->{_xls_rowmax} = $rowmax;
- $self->{_xls_colmax} = $colmax;
- $self->{_xls_strmax} = $strmax;
- $self->{_dim_rowmin} = $rowmax +1;
- $self->{_dim_rowmax} = 0;
- $self->{_dim_colmin} = $colmax +1;
- $self->{_dim_colmax} = 0;
- $self->{_dim_changed} = 0;
- $self->{_colinfo} = [];
- $self->{_selection} = [0, 0];
- $self->{_panes} = [];
- $self->{_active_pane} = 3;
- $self->{_frozen} = 0;
- $self->{_selected} = 0;
-
- $self->{_paper_size} = 0x0;
- $self->{_orientation} = 0x1;
- $self->{_header} = '';
- $self->{_footer} = '';
- $self->{_hcenter} = 0;
- $self->{_vcenter} = 0;
- $self->{_margin_head} = 0.50;
- $self->{_margin_foot} = 0.50;
- $self->{_margin_left} = 0.75;
- $self->{_margin_right} = 0.75;
- $self->{_margin_top} = 1.00;
- $self->{_margin_bottom} = 1.00;
-
- $self->{_title_rowmin} = undef;
- $self->{_title_rowmax} = undef;
- $self->{_title_colmin} = undef;
- $self->{_title_colmax} = undef;
- $self->{_print_rowmin} = undef;
- $self->{_print_rowmax} = undef;
- $self->{_print_colmin} = undef;
- $self->{_print_colmax} = undef;
-
- $self->{_print_gridlines} = 1;
- $self->{_screen_gridlines} = 1;
- $self->{_print_headers} = 0;
-
- $self->{_page_order} = 0;
- $self->{_black_white} = 0;
- $self->{_draft_quality} = 0;
- $self->{_print_comments} = 0;
- $self->{_page_start} = 1;
-
- $self->{_fit_page} = 0;
- $self->{_fit_width} = 0;
- $self->{_fit_height} = 0;
-
- $self->{_hbreaks} = [];
- $self->{_vbreaks} = [];
-
- $self->{_protect} = 0;
- $self->{_password} = undef;
-
- $self->{_col_sizes} = {};
- $self->{_row_sizes} = {};
-
- $self->{_col_formats} = {};
- $self->{_row_formats} = {};
-
- $self->{_zoom} = 100;
- $self->{_print_scale} = 100;
-
- $self->{_leading_zeros} = 0;
-
- $self->{_outline_row_level} = 0;
- $self->{_outline_style} = 0;
- $self->{_outline_below} = 1;
- $self->{_outline_right} = 1;
- $self->{_outline_on} = 1;
-
- $self->{_write_match} = [];
-
-
- bless $self, $class;
- $self->_initialize();
- return $self;
-}
-
-
-###############################################################################
-#
-# _initialize()
-#
-# Open a tmp file to store the majority of the Worksheet data. If this fails,
-# for example due to write permissions, store the data in memory. This can be
-# slow for large files.
-#
-sub _initialize {
-
- my $self = shift;
- my $fh;
- my $tmp_dir;
-
- # The following code is complicated by Windows limitations. Porters can
- # choose a more direct method.
-
-
-
- # In the default case we use IO::File->new_tmpfile(). This may fail, in
- # particular with IIS on Windows, so we allow the user to specify a temp
- # directory via File::Temp.
- #
- if (defined $self->{_tempdir}) {
-
- # Delay loading File:Temp to reduce the module dependencies.
- eval { require File::Temp };
- die "The File::Temp module must be installed in order ".
- "to call set_tempdir().\n" if $@;
-
-
- # Trap but ignore File::Temp errors.
- eval { $fh = File::Temp::tempfile(DIR => $self->{_tempdir}) };
-
- # Store the failed tmp dir in case of errors.
- $tmp_dir = $self->{_tempdir} || File::Spec->tmpdir if not $fh;
- }
- else {
-
- $fh = IO::File->new_tmpfile();
-
- # Store the failed tmp dir in case of errors.
- $tmp_dir = "POSIX::tmpnam() directory" if not $fh;
- }
-
-
- # Check if the temp file creation was successful. Else store data in memory.
- if ($fh) {
-
- # binmode file whether platform requires it or not.
- binmode($fh);
-
- # Store filehandle
- $self->{_filehandle} = $fh;
- }
- else {
-
- # Set flag to store data in memory if XX::tempfile() failed.
- $self->{_using_tmpfile} = 0;
-
- if ($self->{_index} == 0 && $^W) {
- my $dir = $self->{_tempdir} || File::Spec->tmpdir();
-
- warn "Unable to create temp files in $tmp_dir. Data will be ".
- "stored in memory. Refer to set_tempdir() in the ".
- "Spreadsheet::WriteExcel documentation.\n" ;
- }
- }
-}
-
-
-###############################################################################
-#
-# _close()
-#
-# Add data to the beginning of the workbook (note the reverse order)
-# and to the end of the workbook.
-#
-sub _close {
-
- my $self = shift;
- my $sheetnames = shift;
- my $num_sheets = scalar @$sheetnames;
-
- ################################################
- # Prepend in reverse order!!
- #
-
- # Prepend the sheet dimensions
- $self->_store_dimensions();
-
- # Prepend the COLINFO records if they exist
- if (@{$self->{_colinfo}}){
- my @colinfo = @{$self->{_colinfo}};
- while (@colinfo) {
- my $arrayref = pop @colinfo;
- $self->_store_colinfo(@$arrayref);
- }
-
- # Add the DEFCOLWIDTH record
- $self->_store_defcol();
- }
-
- # Prepend the sheet password
- $self->_store_password();
-
- # Prepend the sheet protection
- $self->_store_protect();
-
- # Prepend the page setup
- $self->_store_setup();
-
- # Prepend the bottom margin
- $self->_store_margin_bottom();
-
- # Prepend the top margin
- $self->_store_margin_top();
-
- # Prepend the right margin
- $self->_store_margin_right();
-
- # Prepend the left margin
- $self->_store_margin_left();
-
- # Prepend the page vertical centering
- $self->_store_vcenter();
-
- # Prepend the page horizontal centering
- $self->_store_hcenter();
-
- # Prepend the page footer
- $self->_store_footer();
-
- # Prepend the page header
- $self->_store_header();
-
- # Prepend the vertical page breaks
- $self->_store_vbreak();
-
- # Prepend the horizontal page breaks
- $self->_store_hbreak();
-
- # Prepend WSBOOL
- $self->_store_wsbool();
-
- # Prepend GUTS
- $self->_store_guts();
-
- # Prepend GRIDSET
- $self->_store_gridset();
-
- # Prepend PRINTGRIDLINES
- $self->_store_print_gridlines();
-
- # Prepend PRINTHEADERS
- $self->_store_print_headers();
-
- # Prepend the BOF record
- $self->_store_bof(0x0010);
-
- #
- # End of prepend. Read upwards from here.
- ################################################
-
- # Append
- #$self->_dev_note(); # TODO
- $self->_store_window2();
- $self->_store_zoom();
- $self->_store_panes(@{$self->{_panes}}) if @{$self->{_panes}};
- $self->_store_selection(@{$self->{_selection}});
- $self->_store_eof();
-}
-
-
-###############################################################################
-#
-# get_name().
-#
-# Retrieve the worksheet name.
-#
-sub get_name {
-
- my $self = shift;
-
- return $self->{_name};
-}
-
-
-###############################################################################
-#
-# get_data().
-#
-# Retrieves data from memory in one chunk, or from disk in $buffer
-# sized chunks.
-#
-sub get_data {
-
- my $self = shift;
- my $buffer = 4096;
- my $tmp;
-
- # Return data stored in memory
- if (defined $self->{_data}) {
- $tmp = $self->{_data};
- $self->{_data} = undef;
- my $fh = $self->{_filehandle};
- seek($fh, 0, 0) if $self->{_using_tmpfile};
- return $tmp;
- }
-
- # Return data stored on disk
- if ($self->{_using_tmpfile}) {
- return $tmp if read($self->{_filehandle}, $tmp, $buffer);
- }
-
- # No data to return
- return undef;
-}
-
-
-###############################################################################
-#
-# select()
-#
-# Set this worksheet as a selected worksheet, i.e. the worksheet has its tab
-# highlighted.
-#
-sub select {
-
- my $self = shift;
-
- $self->{_selected} = 1;
-}
-
-
-###############################################################################
-#
-# activate()
-#
-# Set this worksheet as the active worksheet, i.e. the worksheet that is
-# displayed when the workbook is opened. Also set it as selected.
-#
-sub activate {
-
- my $self = shift;
-
- $self->{_selected} = 1;
- ${$self->{_activesheet}} = $self->{_index};
-}
-
-
-###############################################################################
-#
-# set_first_sheet()
-#
-# Set this worksheet as the first visible sheet. This is necessary
-# when there are a large number of worksheets and the activated
-# worksheet is not visible on the screen.
-#
-sub set_first_sheet {
-
- my $self = shift;
-
- ${$self->{_firstsheet}} = $self->{_index};
-}
-
-
-###############################################################################
-#
-# protect($password)
-#
-# Set the worksheet protection flag to prevent accidental modification and to
-# hide formulas if the locked and hidden format properties have been set.
-#
-sub protect {
-
- my $self = shift;
-
- $self->{_protect} = 1;
- $self->{_password} = $self->_encode_password($_[0]) if defined $_[0];
-
-}
-
-
-###############################################################################
-#
-# set_column($firstcol, $lastcol, $width, $format, $hidden, $level)
-#
-# Set the width of a single column or a range of columns.
-# See also: _store_colinfo
-#
-sub set_column {
-
- my $self = shift;
- my $cell = $_[0];
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($cell =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
-
- # Returned values $row1 and $row2 aren't required here. Remove them.
- shift @_; # $row1
- splice @_, 1, 1; # $row2
- }
-
- push @{$self->{_colinfo}}, [ @_ ];
-
-
- # Store the col sizes for use when calculating image vertices taking
- # hidden columns into account. Also store the column formats.
- #
- return if @_ < 3; # Ensure at least $firstcol, $lastcol and $width
-
- my $width = $_[4] ? 0 : $_[2]; # Set width to zero if column is hidden
- my $format = $_[3];
-
- my ($firstcol, $lastcol) = @_;
-
- foreach my $col ($firstcol .. $lastcol) {
- $self->{_col_sizes}->{$col} = $width;
- $self->{_col_formats}->{$col} = $format if defined $format;
- }
-}
-
-
-###############################################################################
-#
-# set_selection()
-#
-# Set which cell or cells are selected in a worksheet: see also the
-# sub _store_selection
-#
-sub set_selection {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- $self->{_selection} = [ @_ ];
-}
-
-
-###############################################################################
-#
-# freeze_panes()
-#
-# Set panes and mark them as frozen. See also _store_panes().
-#
-sub freeze_panes {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- $self->{_frozen} = 1;
- $self->{_panes} = [ @_ ];
-}
-
-
-###############################################################################
-#
-# thaw_panes()
-#
-# Set panes and mark them as unfrozen. See also _store_panes().
-#
-sub thaw_panes {
-
- my $self = shift;
-
- $self->{_frozen} = 0;
- $self->{_panes} = [ @_ ];
-}
-
-
-###############################################################################
-#
-# set_portrait()
-#
-# Set the page orientation as portrait.
-#
-sub set_portrait {
-
- my $self = shift;
-
- $self->{_orientation} = 1;
-}
-
-
-###############################################################################
-#
-# set_landscape()
-#
-# Set the page orientation as landscape.
-#
-sub set_landscape {
-
- my $self = shift;
-
- $self->{_orientation} = 0;
-}
-
-
-###############################################################################
-#
-# set_paper()
-#
-# Set the paper type. Ex. 1 = US Letter, 9 = A4
-#
-sub set_paper {
-
- my $self = shift;
-
- $self->{_paper_size} = $_[0] || 0;
-}
-
-
-###############################################################################
-#
-# set_header()
-#
-# Set the page header caption and optional margin.
-#
-sub set_header {
-
- my $self = shift;
- my $string = $_[0] || '';
-
- if (length $string >= 255) {
- carp 'Header string must be less than 255 characters';
- return;
- }
-
- $self->{_header} = $string;
- $self->{_margin_head} = $_[1] || 0.50;
-}
-
-
-###############################################################################
-#
-# set_footer()
-#
-# Set the page footer caption and optional margin.
-#
-sub set_footer {
-
- my $self = shift;
- my $string = $_[0] || '';
-
- if (length $string >= 255) {
- carp 'Footer string must be less than 255 characters';
- return;
- }
-
-
- $self->{_footer} = $string;
- $self->{_margin_foot} = $_[1] || 0.50;
-}
-
-
-###############################################################################
-#
-# center_horizontally()
-#
-# Center the page horizontally.
-#
-sub center_horizontally {
-
- my $self = shift;
-
- if (defined $_[0]) {
- $self->{_hcenter} = $_[0];
- }
- else {
- $self->{_hcenter} = 1;
- }
-}
-
-
-###############################################################################
-#
-# center_vertically()
-#
-# Center the page horinzontally.
-#
-sub center_vertically {
-
- my $self = shift;
-
- if (defined $_[0]) {
- $self->{_vcenter} = $_[0];
- }
- else {
- $self->{_vcenter} = 1;
- }
-}
-
-
-###############################################################################
-#
-# set_margins()
-#
-# Set all the page margins to the same value in inches.
-#
-sub set_margins {
-
- my $self = shift;
-
- $self->set_margin_left($_[0]);
- $self->set_margin_right($_[0]);
- $self->set_margin_top($_[0]);
- $self->set_margin_bottom($_[0]);
-}
-
-
-###############################################################################
-#
-# set_margins_LR()
-#
-# Set the left and right margins to the same value in inches.
-#
-sub set_margins_LR {
-
- my $self = shift;
-
- $self->set_margin_left($_[0]);
- $self->set_margin_right($_[0]);
-}
-
-
-###############################################################################
-#
-# set_margins_TB()
-#
-# Set the top and bottom margins to the same value in inches.
-#
-sub set_margins_TB {
-
- my $self = shift;
-
- $self->set_margin_top($_[0]);
- $self->set_margin_bottom($_[0]);
-}
-
-
-###############################################################################
-#
-# set_margin_left()
-#
-# Set the left margin in inches.
-#
-sub set_margin_left {
-
- my $self = shift;
-
- $self->{_margin_left} = defined $_[0] ? $_[0] : 0.75;
-}
-
-
-###############################################################################
-#
-# set_margin_right()
-#
-# Set the right margin in inches.
-#
-sub set_margin_right {
-
- my $self = shift;
-
- $self->{_margin_right} = defined $_[0] ? $_[0] : 0.75;
-}
-
-
-###############################################################################
-#
-# set_margin_top()
-#
-# Set the top margin in inches.
-#
-sub set_margin_top {
-
- my $self = shift;
-
- $self->{_margin_top} = defined $_[0] ? $_[0] : 1.00;
-}
-
-
-###############################################################################
-#
-# set_margin_bottom()
-#
-# Set the bottom margin in inches.
-#
-sub set_margin_bottom {
-
- my $self = shift;
-
- $self->{_margin_bottom} = defined $_[0] ? $_[0] : 1.00;
-}
-
-
-###############################################################################
-#
-# repeat_rows($first_row, $last_row)
-#
-# Set the rows to repeat at the top of each printed page. See also the
-# _store_name_xxxx() methods in Workbook.pm.
-#
-sub repeat_rows {
-
- my $self = shift;
-
- $self->{_title_rowmin} = $_[0];
- $self->{_title_rowmax} = $_[1] || $_[0]; # Second row is optional
-}
-
-
-###############################################################################
-#
-# repeat_columns($first_col, $last_col)
-#
-# Set the columns to repeat at the left hand side of each printed page.
-# See also the _store_names() methods in Workbook.pm.
-#
-sub repeat_columns {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
-
- # Returned values $row1 and $row2 aren't required here. Remove them.
- shift @_; # $row1
- splice @_, 1, 1; # $row2
- }
-
- $self->{_title_colmin} = $_[0];
- $self->{_title_colmax} = $_[1] || $_[0]; # Second col is optional
-}
-
-
-###############################################################################
-#
-# print_area($first_row, $first_col, $last_row, $last_col)
-#
-# Set the area of each worksheet that will be printed. See also the
-# _store_names() methods in Workbook.pm.
-#
-sub print_area {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- return if @_ != 4; # Require 4 parameters
-
- $self->{_print_rowmin} = $_[0];
- $self->{_print_colmin} = $_[1];
- $self->{_print_rowmax} = $_[2];
- $self->{_print_colmax} = $_[3];
-}
-
-
-###############################################################################
-#
-# hide_gridlines()
-#
-# Set the option to hide gridlines on the screen and the printed page.
-# There are two ways of doing this in the Excel BIFF format: The first is by
-# setting the DspGrid field of the WINDOW2 record, this turns off the screen
-# and subsequently the print gridline. The second method is to via the
-# PRINTGRIDLINES and GRIDSET records, this turns off the printed gridlines
-# only. The first method is probably sufficient for most cases. The second
-# method is supported for backwards compatibility. Porters take note.
-#
-sub hide_gridlines {
-
- my $self = shift;
- my $option = $_[0];
-
- $option = 1 unless defined $option; # Default to hiding printed gridlines
-
- if ($option == 0) {
- $self->{_print_gridlines} = 1; # 1 = display, 0 = hide
- $self->{_screen_gridlines} = 1;
- }
- elsif ($option == 1) {
- $self->{_print_gridlines} = 0;
- $self->{_screen_gridlines} = 1;
- }
- else {
- $self->{_print_gridlines} = 0;
- $self->{_screen_gridlines} = 0;
- }
-}
-
-
-###############################################################################
-#
-# print_row_col_headers()
-#
-# Set the option to print the row and column headers on the printed page.
-# See also the _store_print_headers() method below.
-#
-sub print_row_col_headers {
-
- my $self = shift;
-
- if (defined $_[0]) {
- $self->{_print_headers} = $_[0];
- }
- else {
- $self->{_print_headers} = 1;
- }
-}
-
-
-###############################################################################
-#
-# fit_to_pages($width, $height)
-#
-# Store the vertical and horizontal number of pages that will define the
-# maximum area printed. See also _store_setup() and _store_wsbool() below.
-#
-sub fit_to_pages {
-
- my $self = shift;
-
- $self->{_fit_page} = 1;
- $self->{_fit_width} = $_[0] || 0;
- $self->{_fit_height} = $_[1] || 0;
-}
-
-
-###############################################################################
-#
-# set_h_pagebreaks(@breaks)
-#
-# Store the horizontal page breaks on a worksheet.
-#
-sub set_h_pagebreaks {
-
- my $self = shift;
-
- push @{$self->{_hbreaks}}, @_;
-}
-
-
-###############################################################################
-#
-# set_v_pagebreaks(@breaks)
-#
-# Store the vertical page breaks on a worksheet.
-#
-sub set_v_pagebreaks {
-
- my $self = shift;
-
- push @{$self->{_vbreaks}}, @_;
-}
-
-
-###############################################################################
-#
-# set_zoom($scale)
-#
-# Set the worksheet zoom factor.
-#
-sub set_zoom {
-
- my $self = shift;
- my $scale = $_[0] || 100;
-
- # Confine the scale to Excel's range
- if ($scale < 10 or $scale > 400) {
- carp "Zoom factor $scale outside range: 10 <= zoom <= 400";
- $scale = 100;
- }
-
- $self->{_zoom} = int $scale;
-}
-
-
-###############################################################################
-#
-# set_print_scale($scale)
-#
-# Set the scale factor for the printed page.
-#
-sub set_print_scale {
-
- my $self = shift;
- my $scale = $_[0] || 100;
-
- # Confine the scale to Excel's range
- if ($scale < 10 or $scale > 400) {
- carp "Print scale $scale outside range: 10 <= zoom <= 400";
- $scale = 100;
- }
-
- # Turn off "fit to page" option
- $self->{_fit_page} = 0;
-
- $self->{_print_scale} = int $scale;
-}
-
-
-###############################################################################
-#
-# keep_leading_zeros()
-#
-# Causes the write() method to treat integers with a leading zero as a string.
-# This ensures that any leading zeros such, as in zip codes, are maintained.
-#
-sub keep_leading_zeros {
-
- my $self = shift;
-
- if (defined $_[0]) {
- $self->{_leading_zeros} = $_[0];
- }
- else {
- $self->{_leading_zeros} = 1;
- }
-}
-
-
-###############################################################################
-#
-# add_write_handler($re, $code_ref)
-#
-# Allow the user to add their own matches and handlers to the write() method.
-#
-sub add_write_handler {
-
- my $self = shift;
-
- return unless @_ == 2;
- return unless ref $_[1] eq 'CODE';
-
- push @{$self->{_write_match}}, [ @_ ];
+package Spreadsheet::WriteExcel::Worksheet;
+
+###############################################################################
+#
+# Worksheet - A writer class for Excel Worksheets.
+#
+#
+# Used in conjunction with Spreadsheet::WriteExcel
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+use strict;
+use Carp;
+use Spreadsheet::WriteExcel::BIFFwriter;
+use Spreadsheet::WriteExcel::Format;
+use Spreadsheet::WriteExcel::Formula;
+
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Spreadsheet::WriteExcel::BIFFwriter);
+
+$VERSION = '2.11';
+
+###############################################################################
+#
+# new()
+#
+# Constructor. Creates a new Worksheet object from a BIFFwriter object
+#
+sub new {
+
+ my $class = shift;
+ my $self = Spreadsheet::WriteExcel::BIFFwriter->new();
+ my $rowmax = 65536;
+ my $colmax = 256;
+ my $strmax = 0;
+
+ $self->{_name} = $_[0];
+ $self->{_index} = $_[1];
+ $self->{_encoding} = $_[2];
+ $self->{_activesheet} = $_[3];
+ $self->{_firstsheet} = $_[4];
+ $self->{_url_format} = $_[5];
+ $self->{_parser} = $_[6];
+ $self->{_tempdir} = $_[7];
+
+ $self->{_str_total} = $_[8];
+ $self->{_str_unique} = $_[9];
+ $self->{_str_table} = $_[10];
+ $self->{_1904} = $_[11];
+
+ $self->{_type} = 0x0000;
+ $self->{_ext_sheets} = [];
+ $self->{_using_tmpfile} = 1;
+ $self->{_filehandle} = "";
+ $self->{_fileclosed} = 0;
+ $self->{_offset} = 0;
+ $self->{_xls_rowmax} = $rowmax;
+ $self->{_xls_colmax} = $colmax;
+ $self->{_xls_strmax} = $strmax;
+ $self->{_dim_rowmin} = $rowmax +1;
+ $self->{_dim_rowmax} = 0;
+ $self->{_dim_colmin} = $colmax +1;
+ $self->{_dim_colmax} = 0;
+ $self->{_dim_changed} = 0;
+ $self->{_colinfo} = [];
+ $self->{_selection} = [0, 0];
+ $self->{_panes} = [];
+ $self->{_active_pane} = 3;
+ $self->{_frozen} = 0;
+ $self->{_selected} = 0;
+
+ $self->{_paper_size} = 0x0;
+ $self->{_orientation} = 0x1;
+ $self->{_header} = '';
+ $self->{_footer} = '';
+ $self->{_header_encoding} = 0;
+ $self->{_footer_encoding} = 0;
+ $self->{_hcenter} = 0;
+ $self->{_vcenter} = 0;
+ $self->{_margin_header} = 0.50;
+ $self->{_margin_footer} = 0.50;
+ $self->{_margin_left} = 0.75;
+ $self->{_margin_right} = 0.75;
+ $self->{_margin_top} = 1.00;
+ $self->{_margin_bottom} = 1.00;
+
+ $self->{_title_rowmin} = undef;
+ $self->{_title_rowmax} = undef;
+ $self->{_title_colmin} = undef;
+ $self->{_title_colmax} = undef;
+ $self->{_print_rowmin} = undef;
+ $self->{_print_rowmax} = undef;
+ $self->{_print_colmin} = undef;
+ $self->{_print_colmax} = undef;
+
+ $self->{_print_gridlines} = 1;
+ $self->{_screen_gridlines} = 1;
+ $self->{_print_headers} = 0;
+
+ $self->{_page_order} = 0;
+ $self->{_black_white} = 0;
+ $self->{_draft_quality} = 0;
+ $self->{_print_comments} = 0;
+ $self->{_page_start} = 1;
+
+ $self->{_fit_page} = 0;
+ $self->{_fit_width} = 0;
+ $self->{_fit_height} = 0;
+
+ $self->{_hbreaks} = [];
+ $self->{_vbreaks} = [];
+
+ $self->{_protect} = 0;
+ $self->{_password} = undef;
+
+ $self->{_col_sizes} = {};
+ $self->{_row_sizes} = {};
+
+ $self->{_col_formats} = {};
+ $self->{_row_formats} = {};
+
+ $self->{_zoom} = 100;
+ $self->{_print_scale} = 100;
+
+ $self->{_leading_zeros} = 0;
+
+ $self->{_outline_row_level} = 0;
+ $self->{_outline_style} = 0;
+ $self->{_outline_below} = 1;
+ $self->{_outline_right} = 1;
+ $self->{_outline_on} = 1;
+
+ $self->{_write_match} = [];
+
+
+ bless $self, $class;
+ $self->_initialize();
+ return $self;
}
-
-
-###############################################################################
-#
-# write($row, $col, $token, $format)
-#
-# Parse $token and call appropriate write method. $row and $column are zero
-# indexed. $format is optional.
-#
-# Returns: return value of called subroutine
-#
-sub write {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- my $token = $_[2];
-
- # Handle undefs as blanks
- $token = '' unless defined $token;
-
-
- # First try user defined matches.
- for my $aref (@{$self->{_write_match}}) {
- my $re = $aref->[0];
- my $sub = $aref->[1];
-
- if ($token =~ /$re/) {
- my $match = &$sub($self, @_);
- return $match if defined $match;
- }
- }
-
-
- # Match an array ref.
- if (ref $token eq "ARRAY") {
- return $self->write_row(@_);
- }
- # Match integer with leading zero(s)
- elsif ($self->{_leading_zeros} and $token =~ /^0\d+$/) {
- return $self->write_string(@_);
- }
- # Match number
- elsif ($token =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/) {
- return $self->write_number(@_);
- }
- # Match http, https or ftp URL
- elsif ($token =~ m|^[fh]tt?ps?://|) {
- return $self->write_url(@_);
- }
- # Match mailto:
- elsif ($token =~ m/^mailto:/) {
- return $self->write_url(@_);
- }
- # Match internal or external sheet link
- elsif ($token =~ m[^(?:in|ex)ternal:]) {
- return $self->write_url(@_);
- }
- # Match formula
- elsif ($token =~ /^=/) {
- return $self->write_formula(@_);
- }
- # Match blank
- elsif ($token eq '') {
- splice @_, 2, 1; # remove the empty string from the parameter list
- return $self->write_blank(@_);
- }
- else {
- return $self->write_string(@_);
- }
-}
-
-
-###############################################################################
-#
-# write_row($row, $col, $array_ref, $format)
-#
-# Write a row of data starting from ($row, $col). Call write_col() if any of
-# the elements of the array ref are in turn array refs. This allows the writing
-# of 1D or 2D arrays of data in one go.
-#
-# Returns: the first encountered error value or zero for no errors
-#
-sub write_row {
-
- my $self = shift;
-
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- # Catch non array refs passed by user.
- if (ref $_[2] ne 'ARRAY') {
- croak "Not an array ref in call to write_row()$!";
- }
-
- my $row = shift;
- my $col = shift;
- my $tokens = shift;
- my @options = @_;
- my $error = 0;
- my $ret;
-
- foreach my $token (@$tokens) {
-
- # Check for nested arrays
- if (ref $token eq "ARRAY") {
- $ret = $self->write_col($row, $col, $token, @options);
- } else {
- $ret = $self->write ($row, $col, $token, @options);
- }
-
- # Return only the first error encountered, if any.
- $error ||= $ret;
- $col++;
- }
-
- return $error;
-}
-
-
-###############################################################################
-#
-# write_col($row, $col, $array_ref, $format)
-#
-# Write a column of data starting from ($row, $col). Call write_row() if any of
-# the elements of the array ref are in turn array refs. This allows the writing
-# of 1D or 2D arrays of data in one go.
-#
-# Returns: the first encountered error value or zero for no errors
-#
-sub write_col {
-
- my $self = shift;
-
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- # Catch non array refs passed by user.
- if (ref $_[2] ne 'ARRAY') {
- croak "Not an array ref in call to write_row()$!";
- }
-
- my $row = shift;
- my $col = shift;
- my $tokens = shift;
- my @options = @_;
- my $error = 0;
- my $ret;
-
- foreach my $token (@$tokens) {
-
- # write() will deal with any nested arrays
- $ret = $self->write($row, $col, $token, @options);
-
- # Return only the first error encountered, if any.
- $error ||= $ret;
- $row++;
- }
-
- return $error;
-}
-
-
-###############################################################################
-#
-# write_comment($row, $col, $comment)
-#
-# Write a comment to the specified row and column (zero indexed). The maximum
-# comment size is 30831 chars. Excel5 probably accepts 32k-1 chars. However, it
-# can only display 30831 chars. Excel 7 and 2000 will crash above 32k-1.
-#
-# In Excel 5 a comment is referred to as a NOTE.
-#
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-# -3 : long comment truncated to 30831 chars
-#
-sub write_comment {
-
- # Not available in this release
- return -4;
-
-}
-
-
-###############################################################################
-#
-# _XF()
-#
-# Returns an index to the XF record in the workbook.
-#
-# Note: this is a function, not a method.
-#
-sub _XF {
-
- my $self = $_[0];
- my $row = $_[1];
- my $col = $_[2];
- my $format = $_[3];
-
- if (ref($format)) {
- return $format->get_xf_index();
- }
- elsif (exists $self->{_row_formats}->{$row}) {
- return $self->{_row_formats}->{$row}->get_xf_index();
- }
- elsif (exists $self->{_col_formats}->{$col}) {
- return $self->{_col_formats}->{$col}->get_xf_index();
- }
- else {
- return 0x0F;
- }
-}
-
-
-###############################################################################
-###############################################################################
-#
-# Internal methods
-#
-
-
-###############################################################################
-#
-# _append(), overloaded.
-#
-# Store Worksheet data in memory using the base class _append() or to a
-# temporary file, the default.
-#
-sub _append {
-
- my $self = shift;
-
- if ($self->{_using_tmpfile}) {
- my $data = join('', @_);
-
- # Add CONTINUE records if necessary
- $data = $self->_add_continue($data) if length($data) > $self->{_limit};
-
- # Protect print() from -l on the command line.
- local $\ = undef;
-
- print {$self->{_filehandle}} $data;
- $self->{_datasize} += length($data);
- }
- else {
- $self->SUPER::_append(@_);
- }
-}
-
-
-###############################################################################
-#
-# _substitute_cellref()
-#
-# Substitute an Excel cell reference in A1 notation for zero based row and
-# column values in an argument list.
-#
-# Ex: ("A4", "Hello") is converted to (3, 0, "Hello").
-#
-sub _substitute_cellref {
-
- my $self = shift;
- my $cell = uc(shift);
-
- # Convert a column range: 'A:A' or 'B:G'.
- # A range such as A:A is equivalent to A1:65536, so add rows as required
- if ($cell =~ /\$?([A-I]?[A-Z]):\$?([A-I]?[A-Z])/) {
- my ($row1, $col1) = $self->_cell_to_rowcol($1 .'1');
- my ($row2, $col2) = $self->_cell_to_rowcol($2 .'65536');
- return $row1, $col1, $row2, $col2, @_;
- }
-
- # Convert a cell range: 'A1:B7'
- if ($cell =~ /\$?([A-I]?[A-Z]\$?\d+):\$?([A-I]?[A-Z]\$?\d+)/) {
- my ($row1, $col1) = $self->_cell_to_rowcol($1);
- my ($row2, $col2) = $self->_cell_to_rowcol($2);
- return $row1, $col1, $row2, $col2, @_;
- }
-
- # Convert a cell reference: 'A1' or 'AD2000'
- if ($cell =~ /\$?([A-I]?[A-Z]\$?\d+)/) {
- my ($row1, $col1) = $self->_cell_to_rowcol($1);
- return $row1, $col1, @_;
-
- }
-
- croak("Unknown cell reference $cell");
-}
-
-
-###############################################################################
-#
-# _cell_to_rowcol($cell_ref)
-#
-# Convert an Excel cell reference in A1 notation to a zero based row and column
-# reference; converts C1 to (0, 2).
-#
-# Returns: row, column
-#
-# TODO use functions in Utility.pm
-#
-sub _cell_to_rowcol {
-
- my $self = shift;
- my $cell = shift;
-
- $cell =~ /\$?([A-I]?[A-Z])\$?(\d+)/;
-
- my $col = $1;
- my $row = $2;
-
- # Convert base26 column string to number
- # All your Base are belong to us.
- my @chars = split //, $col;
- my $expn = 0;
- $col = 0;
-
- while (@chars) {
- my $char = pop(@chars); # LS char first
- $col += (ord($char) -ord('A') +1) * (26**$expn);
- $expn++;
- }
-
- # Convert 1-index to zero-index
- $row--;
- $col--;
-
- return $row, $col;
-}
-
-
-###############################################################################
-#
-# _sort_pagebreaks()
-#
-#
-# This is an internal method that is used to filter elements of the array of
-# pagebreaks used in the _store_hbreak() and _store_vbreak() methods. It:
-# 1. Removes duplicate entries from the list.
-# 2. Sorts the list.
-# 3. Removes 0 from the list if present.
-#
-sub _sort_pagebreaks {
-
- my $self= shift;
-
- my %hash;
- my @array;
-
- @hash{@_} = undef; # Hash slice to remove duplicates
- @array = sort {$a <=> $b} keys %hash; # Numerical sort
- shift @array if $array[0] == 0; # Remove zero
-
- # 1000 vertical pagebreaks appears to be an internal Excel 5 limit.
- # It is slightly higher in Excel 97/200, approx. 1026
- splice(@array, 1000) if (@array > 1000);
-
- return @array
-}
-
-
-###############################################################################
-#
-# _encode_password($password)
-#
-# Based on the algorithm provided by Daniel Rentz of OpenOffice.
-#
-#
-sub _encode_password {
-
- use integer;
-
- my $self = shift;
- my $plaintext = $_[0];
- my $password;
- my $count;
- my @chars;
- my $i = 0;
-
- $count = @chars = split //, $plaintext;
-
- foreach my $char (@chars) {
- my $low_15;
- my $high_15;
- $char = ord($char) << ++$i;
- $low_15 = $char & 0x7fff;
- $high_15 = $char & 0x7fff << 15;
- $high_15 = $high_15 >> 15;
- $char = $low_15 | $high_15;
- }
-
- $password = 0x0000;
- $password ^= $_ for @chars;
- $password ^= $count;
- $password ^= 0xCE4B;
-
- return $password;
-}
-
-
-###############################################################################
-#
-# outline_settings($visible, $symbols_below, $symbols_right, $auto_style)
-#
-# This method sets the properties for outlining and grouping. The defaults
-# correspond to Excel's defaults.
-#
-sub outline_settings {
-
- my $self = shift;
-
- $self->{_outline_on} = defined $_[0] ? $_[0] : 1;
- $self->{_outline_below} = defined $_[1] ? $_[1] : 1;
- $self->{_outline_right} = defined $_[2] ? $_[2] : 1;
- $self->{_outline_style} = $_[3] || 0;
-
- # Ensure this is a boolean vale for Window2
- $self->{_outline_on} = 1 if $self->{_outline_on};
-}
-
-
-
-
-###############################################################################
-###############################################################################
-#
-# BIFF RECORDS
-#
-
-
-###############################################################################
-#
-# write_number($row, $col, $num, $format)
-#
-# Write a double to the specified row and column (zero indexed).
-# An integer can be written as a double. Excel will display an
-# integer. $format is optional.
-#
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-#
-sub write_number {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- if (@_ < 3) { return -1 } # Check the number of args
-
- my $record = 0x0203; # Record identifier
- my $length = 0x000E; # Number of bytes to follow
-
- my $row = $_[0]; # Zero indexed row
- my $col = $_[1]; # Zero indexed column
- my $num = $_[2];
- my $xf = _XF($self, $row, $col, $_[3]); # The cell format
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvv", $row, $col, $xf);
- my $xl_double = pack("d", $num);
-
- if ($self->{_byte_order}) { $xl_double = reverse $xl_double }
-
- $self->_append($header, $data, $xl_double);
-
- return 0;
-}
-
-
-###############################################################################
-#
-# write_string ($row, $col, $string, $format)
-#
-# Write a string to the specified row and column (zero indexed).
-# NOTE: there is an Excel 5 defined limit of 255 characters.
-# $format is optional.
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-# -3 : long string truncated to 255 chars
-#
-sub write_string {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- if (@_ < 3) { return -1 } # Check the number of args
-
- my $record = 0x00FD; # Record identifier
- my $length = 0x000A; # Bytes to follow
-
- my $row = $_[0]; # Zero indexed row
- my $col = $_[1]; # Zero indexed column
- my $strlen = length($_[2]);
- my $str = $_[2];
- my $xf = _XF($self, $row, $col, $_[3]); # The cell format
- my $encoding = 0x0;
- my $str_error = 0;
-
-
- # Handle utf8 strings in newer perls.
- if ($] >= 5.008) {
- require Encode;
-
- if (Encode::is_utf8($str)) {
- my $tmp = Encode::encode("UTF-16LE", $str);
- return $self->write_unicode_le($row, $col, $tmp, $_[3]);
- }
- }
-
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
- # TODO
- if ($strlen > 32767) {
- $str = substr($str, 0, 32767);
- $str_error = -3;
- }
-
-
- # TODO
- my $str_header = pack("vC", length($str), $encoding);
- $str = $str_header . $str;
-
-
- if (not exists ${$self->{_str_table}}->{$str}) {
- ${$self->{_str_table}}->{$str} = ${$self->{_str_unique}}++;
- }
-
-
- ${$self->{_str_total}}++;
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvV", $row, $col, $xf, ${$self->{_str_table}}->{$str});
-
- $self->_append($header, $data);
-
- return $str_error;
-}
-
-
-###############################################################################
-#
-# write_blank($row, $col, $format)
-#
-# Write a blank cell to the specified row and column (zero indexed).
-# A blank cell is used to specify formatting without adding a string
-# or a number.
-#
-# A blank cell without a format serves no purpose. Therefore, we don't write
-# a BLANK record unless a format is specified. This is mainly an optimisation
-# for the write_row() and write_col() methods.
-#
-# Returns 0 : normal termination (including no format)
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-#
-sub write_blank {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- # Check the number of args
- return -1 if @_ < 2;
-
- # Don't write a blank cell unless it has a format
- return 0 if not defined $_[2];
-
-
- my $record = 0x0201; # Record identifier
- my $length = 0x0006; # Number of bytes to follow
-
- my $row = $_[0]; # Zero indexed row
- my $col = $_[1]; # Zero indexed column
- my $xf = _XF($self, $row, $col, $_[2]); # The cell format
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvv", $row, $col, $xf);
-
- $self->_append($header, $data);
-
- return 0;
-}
-
-
-###############################################################################
-#
-# write_formula($row, $col, $formula, $format)
-#
-# Write a formula to the specified row and column (zero indexed).
-# The textual representation of the formula is passed to the parser in
-# Formula.pm which returns a packed binary string.
-#
-# $format is optional.
-#
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-#
-sub write_formula{
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- if (@_ < 3) { return -1 } # Check the number of args
-
- my $record = 0x0006; # Record identifier
- my $length; # Bytes to follow
-
- my $row = $_[0]; # Zero indexed row
- my $col = $_[1]; # Zero indexed column
- my $formula = $_[2]; # The formula text string
-
-
- # Excel normally stores the last calculated value of the formula in $num.
- # Clearly we are not in a position to calculate this a priori. Instead
- # we set $num to zero and set the option flags in $grbit to ensure
- # automatic calculation of the formula when the file is opened.
- #
- my $xf = _XF($self, $row, $col, $_[3]); # The cell format
- my $num = 0x00; # Current value of formula
- my $grbit = 0x03; # Option flags
- my $chn = 0x0000; # Must be zero
-
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
- # Strip the = sign at the beginning of the formula string
- $formula =~ s(^=)();
-
- my $tmp = $formula;
-
- # Parse the formula using the parser in Formula.pm
- my $parser = $self->{_parser};
-
- # In order to raise formula errors from the point of view of the calling
- # program we use an eval block and re-raise the error from here.
- #
- eval { $formula = $parser->parse_formula($formula) };
-
- if ($@) {
- $@ =~ s/\n$//; # Strip the \n used in the Formula.pm die()
- croak $@; # Re-raise the error
- }
-
-
- my $formlen = length($formula); # Length of the binary string
- $length = 0x16 + $formlen; # Length of the record data
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvdvVv", $row, $col, $xf, $num,
- $grbit, $chn, $formlen);
-
- $self->_append($header, $data, $formula);
-
- return 0;
-}
-
-
-###############################################################################
-#
-# store_formula($formula)
-#
-# Pre-parse a formula. This is used in conjunction with repeat_formula()
-# to repetitively rewrite a formula without re-parsing it.
-#
-sub store_formula{
-
- my $self = shift;
- my $formula = $_[0]; # The formula text string
-
- # Strip the = sign at the beginning of the formula string
- $formula =~ s(^=)();
-
- # Parse the formula using the parser in Formula.pm
- my $parser = $self->{_parser};
-
- # In order to raise formula errors from the point of view of the calling
- # program we use an eval block and re-raise the error from here.
- #
- my @tokens;
- eval { @tokens = $parser->parse_formula($formula) };
-
- if ($@) {
- $@ =~ s/\n$//; # Strip the \n used in the Formula.pm die()
- croak $@; # Re-raise the error
- }
-
-
- # Return the parsed tokens in an anonymous array
- return [@tokens];
-}
-
-
-###############################################################################
-#
-# repeat_formula($row, $col, $formula, $format, ($pattern => $replacement,...))
-#
-# Write a formula to the specified row and column (zero indexed) by
-# substituting $pattern $replacement pairs in the $formula created via
-# store_formula(). This allows the user to repetitively rewrite a formula
-# without the significant overhead of parsing.
-#
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-#
-sub repeat_formula {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- if (@_ < 2) { return -1 } # Check the number of args
-
- my $record = 0x0006; # Record identifier
- my $length; # Bytes to follow
-
- my $row = shift; # Zero indexed row
- my $col = shift; # Zero indexed column
- my $formula_ref = shift; # Array ref with formula tokens
- my $format = shift; # XF format
- my @pairs = @_; # Pattern/replacement pairs
-
-
- # Enforce an even number of arguments in the pattern/replacement list
- croak "Odd number of elements in pattern/replacement list" if @pairs %2;
-
- # Check that $formula is an array ref
- croak "Not a valid formula" if ref $formula_ref ne 'ARRAY';
-
- my @tokens = @$formula_ref;
-
- # Ensure that there are tokens to substitute
- croak "No tokens in formula" unless @tokens;
-
- while (@pairs) {
- my $pattern = shift @pairs;
- my $replace = shift @pairs;
-
- foreach my $token (@tokens) {
- last if $token =~ s/$pattern/$replace/;
- }
- }
-
-
- # Change the parameters in the formula cached by the Formula.pm object
- my $parser = $self->{_parser};
- my $formula = $parser->parse_tokens(@tokens);
-
- croak "Unrecognised token in formula" unless defined $formula;
-
-
- # Excel normally stores the last calculated value of the formula in $num.
- # Clearly we are not in a position to calculate this a priori. Instead
- # we set $num to zero and set the option flags in $grbit to ensure
- # automatic calculation of the formula when the file is opened.
- #
- my $xf = _XF($self, $row, $col, $format); # The cell format
- my $num = 0x00; # Current value of formula
- my $grbit = 0x03; # Option flags
- my $chn = 0x0000; # Must be zero
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
-
- my $formlen = length($formula); # Length of the binary string
- $length = 0x16 + $formlen; # Length of the record data
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvdvVv", $row, $col, $xf, $num,
- $grbit, $chn, $formlen);
-
- $self->_append($header, $data, $formula);
-
- return 0;
-}
-
-
-###############################################################################
-#
-# write_url($row, $col, $url, $string, $format)
-#
-# Write a hyperlink. This is comprised of two elements: the visible label and
-# the invisible link. The visible label is the same as the link unless an
-# alternative string is specified. The label is written using the
-# write_string() method. Therefore the 255 characters string limit applies.
-# $string and $format are optional and their order is interchangeable.
-#
-# The hyperlink can be to a http, ftp, mail, internal sheet, or external
-# directory url.
-#
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-# -3 : long string truncated to 255 chars
-#
-sub write_url {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- # Check the number of args
- return -1 if @_ < 3;
-
- # Add start row and col to arg list
- return $self->write_url_range($_[0], $_[1], @_);
-}
-
-
-###############################################################################
-#
-# write_url_range($row1, $col1, $row2, $col2, $url, $string, $format)
-#
-# This is the more general form of write_url(). It allows a hyperlink to be
-# written to a range of cells. This function also decides the type of hyperlink
-# to be written. These are either, Web (http, ftp, mailto), Internal
-# (Sheet1!A1) or external ('c:\temp\foo.xls#Sheet1!A1').
-#
-# See also write_url() above for a general description and return values.
-#
-sub write_url_range {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- # Check the number of args
- return -1 if @_ < 5;
-
-
- # Reverse the order of $string and $format if necessary. We work on a copy
- # in order to protect the callers args. We don't use "local @_" in case of
- # perl50005 threads.
- #
- my @args = @_;
-
- ($args[5], $args[6]) = ($args[6], $args[5]) if ref $args[5];
-
- my $url = $args[4];
-
-
- # Check for internal/external sheet links or default to web link
- return $self->_write_url_internal(@args) if $url =~ m[^internal:];
- return $self->_write_url_external(@args) if $url =~ m[^external:];
- return $self->_write_url_web(@args);
-}
-
-
-###############################################################################
-#
-# _write_url_web($row1, $col1, $row2, $col2, $url, $string, $format)
-#
-# Used to write http, ftp and mailto hyperlinks.
-# The link type ($options) is 0x03 is the same as absolute dir ref without
-# sheet. However it is differentiated by the $unknown2 data stream.
-#
-# See also write_url() above for a general description and return values.
-#
-sub _write_url_web {
-
- my $self = shift;
-
- my $record = 0x01B8; # Record identifier
- my $length = 0x00000; # Bytes to follow
-
- my $row1 = $_[0]; # Start row
- my $col1 = $_[1]; # Start column
- my $row2 = $_[2]; # End row
- my $col2 = $_[3]; # End column
- my $url = $_[4]; # URL string
- my $str = $_[5]; # Alternative label
- my $xf = $_[6] || $self->{_url_format};# The cell format
-
-
- # Write the visible label using the write_string() method.
- $str = $url unless defined $str;
- my $str_error = $self->write_string($row1, $col1, $str, $xf);
- return $str_error if $str_error == -2;
-
-
- # Pack the undocumented parts of the hyperlink stream
- my $unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000");
- my $unknown2 = pack("H*", "E0C9EA79F9BACE118C8200AA004BA90B");
-
-
- # Pack the option flags
- my $options = pack("V", 0x03);
-
- # Convert URL to a null terminated wchar string
- $url = join("\0", split('', $url));
- $url = $url . "\0\0\0";
-
-
- # Pack the length of the URL
- my $url_len = pack("V", length($url));
-
-
- # Calculate the data length
- $length = 0x34 + length($url);
-
-
- # Pack the header data
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvv", $row1, $row2, $col1, $col2);
-
-
- # Write the packed data
- $self->_append( $header,
- $data,
- $unknown1,
- $options,
- $unknown2,
- $url_len,
- $url);
-
- return $str_error;
-}
-
-
-###############################################################################
-#
-# _write_url_internal($row1, $col1, $row2, $col2, $url, $string, $format)
-#
-# Used to write internal reference hyperlinks such as "Sheet1!A1".
-#
-# See also write_url() above for a general description and return values.
-#
-sub _write_url_internal {
-
- my $self = shift;
-
- my $record = 0x01B8; # Record identifier
- my $length = 0x00000; # Bytes to follow
-
- my $row1 = $_[0]; # Start row
- my $col1 = $_[1]; # Start column
- my $row2 = $_[2]; # End row
- my $col2 = $_[3]; # End column
- my $url = $_[4]; # URL string
- my $str = $_[5]; # Alternative label
- my $xf = $_[6] || $self->{_url_format};# The cell format
-
- # Strip URL type
- $url =~ s[^internal:][];
-
-
- # Write the visible label
- $str = $url unless defined $str;
- my $str_error = $self->write_string($row1, $col1, $str, $xf);
- return $str_error if $str_error == -2;
-
-
- # Pack the undocumented parts of the hyperlink stream
- my $unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000");
-
-
- # Pack the option flags
- my $options = pack("V", 0x08);
-
-
- # Convert the URL type and to a null terminated wchar string
- $url = join("\0", split('', $url));
- $url = $url . "\0\0\0";
-
-
- # Pack the length of the URL as chars (not wchars)
- my $url_len = pack("V", int(length($url)/2));
-
-
- # Calculate the data length
- $length = 0x24 + length($url);
-
-
- # Pack the header data
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvv", $row1, $row2, $col1, $col2);
-
-
- # Write the packed data
- $self->_append( $header,
- $data,
- $unknown1,
- $options,
- $url_len,
- $url);
-
- return $str_error;
-}
-
-
-###############################################################################
-#
-# _write_url_external($row1, $col1, $row2, $col2, $url, $string, $format)
-#
-# Write links to external directory names such as 'c:\foo.xls',
-# c:\foo.xls#Sheet1!A1', '../../foo.xls'. and '../../foo.xls#Sheet1!A1'.
-#
-# Note: Excel writes some relative links with the $dir_long string. We ignore
-# these cases for the sake of simpler code.
-#
-# See also write_url() above for a general description and return values.
-#
-sub _write_url_external {
-
- my $self = shift;
-
- # Network drives are different. We will handle them separately
- # MS/Novell network drives and shares start with \\
- return $self->_write_url_external_net(@_) if $_[4] =~ m[^external:\\\\];
-
-
- my $record = 0x01B8; # Record identifier
- my $length = 0x00000; # Bytes to follow
-
- my $row1 = $_[0]; # Start row
- my $col1 = $_[1]; # Start column
- my $row2 = $_[2]; # End row
- my $col2 = $_[3]; # End column
- my $url = $_[4]; # URL string
- my $str = $_[5]; # Alternative label
- my $xf = $_[6] || $self->{_url_format};# The cell format
-
-
- # Strip URL type and change Unix dir separator to Dos style (if needed)
- #
- $url =~ s[^external:][];
- $url =~ s[/][\\]g;
-
-
- # Write the visible label
- ($str = $url) =~ s[\#][ - ] unless defined $str;
- my $str_error = $self->write_string($row1, $col1, $str, $xf);
- return $str_error if $str_error == -2;
-
-
- # Determine if the link is relative or absolute:
- # Absolute if link starts with DOS drive specifier like C:
- # Otherwise default to 0x00 for relative link.
- #
- my $absolute = 0x00;
- $absolute = 0x02 if $url =~ m/^[A-Za-z]:/;
-
-
- # Determine if the link contains a sheet reference and change some of the
- # parameters accordingly.
- # Split the dir name and sheet name (if it exists)
- #
- my ($dir_long , $sheet) = split /\#/, $url;
- my $link_type = 0x01 | $absolute;
- my $sheet_len;
-
- if (defined $sheet) {
- $link_type |= 0x08;
- $sheet_len = pack("V", length($sheet) + 0x01);
- $sheet = join("\0", split('', $sheet));
- $sheet .= "\0\0\0";
- }
- else {
- $sheet_len = '';
- $sheet = '';
- }
-
-
- # Pack the link type
- $link_type = pack("V", $link_type);
-
-
- # Calculate the up-level dir count e.g. (..\..\..\ == 3)
- my $up_count = 0;
- $up_count++ while $dir_long =~ s[^\.\.\\][];
- $up_count = pack("v", $up_count);
-
-
- # Store the short dos dir name (null terminated)
- my $dir_short = $dir_long . "\0";
-
-
- # Store the long dir name as a wchar string (non-null terminated)
- $dir_long = join("\0", split('', $dir_long));
- $dir_long = $dir_long . "\0";
-
-
- # Pack the lengths of the dir strings
- my $dir_short_len = pack("V", length $dir_short );
- my $dir_long_len = pack("V", length $dir_long );
- my $stream_len = pack("V", length($dir_long) + 0x06);
-
-
- # Pack the undocumented parts of the hyperlink stream
- my $unknown1 =pack("H*",'D0C9EA79F9BACE118C8200AA004BA90B02000000' );
- my $unknown2 =pack("H*",'0303000000000000C000000000000046' );
- my $unknown3 =pack("H*",'FFFFADDE000000000000000000000000000000000000000');
- my $unknown4 =pack("v", 0x03 );
-
-
- # Pack the main data stream
- my $data = pack("vvvv", $row1, $row2, $col1, $col2) .
- $unknown1 .
- $link_type .
- $unknown2 .
- $up_count .
- $dir_short_len.
- $dir_short .
- $unknown3 .
- $stream_len .
- $dir_long_len .
- $unknown4 .
- $dir_long .
- $sheet_len .
- $sheet ;
-
-
- # Pack the header data
- $length = length $data;
- my $header = pack("vv", $record, $length);
-
-
- # Write the packed data
- $self->_append( $header, $data);
-
- return $str_error;
-}
-
-
-
-
-###############################################################################
-#
-# _write_url_external_net($row1, $col1, $row2, $col2, $url, $string, $format)
-#
-# Write links to external MS/Novell network drives and shares such as
-# '//NETWORK/share/foo.xls' and '//NETWORK/share/foo.xls#Sheet1!A1'.
-#
-# See also write_url() above for a general description and return values.
-#
-sub _write_url_external_net {
-
- my $self = shift;
-
- my $record = 0x01B8; # Record identifier
- my $length = 0x00000; # Bytes to follow
-
- my $row1 = $_[0]; # Start row
- my $col1 = $_[1]; # Start column
- my $row2 = $_[2]; # End row
- my $col2 = $_[3]; # End column
- my $url = $_[4]; # URL string
- my $str = $_[5]; # Alternative label
- my $xf = $_[6] || $self->{_url_format};# The cell format
-
-
- # Strip URL type and change Unix dir separator to Dos style (if needed)
- #
- $url =~ s[^external:][];
- $url =~ s[/][\\]g;
-
-
- # Write the visible label
- ($str = $url) =~ s[\#][ - ] unless defined $str;
- my $str_error = $self->write_string($row1, $col1, $str, $xf);
- return $str_error if $str_error == -2;
-
-
- # Determine if the link contains a sheet reference and change some of the
- # parameters accordingly.
- # Split the dir name and sheet name (if it exists)
- #
- my ($dir_long , $sheet) = split /\#/, $url;
- my $link_type = 0x0103; # Always absolute
- my $sheet_len;
-
- if (defined $sheet) {
- $link_type |= 0x08;
- $sheet_len = pack("V", length($sheet) + 0x01);
- $sheet = join("\0", split('', $sheet));
- $sheet .= "\0\0\0";
- }
- else {
- $sheet_len = '';
- $sheet = '';
- }
-
- # Pack the link type
- $link_type = pack("V", $link_type);
-
-
- # Make the string null terminated
- $dir_long = $dir_long . "\0";
-
-
- # Pack the lengths of the dir string
- my $dir_long_len = pack("V", length $dir_long);
-
-
- # Store the long dir name as a wchar string (non-null terminated)
- $dir_long = join("\0", split('', $dir_long));
- $dir_long = $dir_long . "\0";
-
-
- # Pack the undocumented part of the hyperlink stream
- my $unknown1 = pack("H*",'D0C9EA79F9BACE118C8200AA004BA90B02000000');
-
-
- # Pack the main data stream
- my $data = pack("vvvv", $row1, $row2, $col1, $col2) .
- $unknown1 .
- $link_type .
- $dir_long_len .
- $dir_long .
- $sheet_len .
- $sheet ;
-
-
- # Pack the header data
- $length = length $data;
- my $header = pack("vv", $record, $length);
-
-
- # Write the packed data
- $self->_append( $header, $data);
-
- return $str_error;
-}
-
-
-###############################################################################
-#
-# write_date_time ($row, $col, $string, $format)
-#
-# Write a datetime string in ISO8601 "yyyy-mm-ddThh:mm:ss.ss" format as a
-# number representing an Excel date. $format is optional.
-#
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-# -3 : Invalid date_time, written as string
-#
-sub write_date_time {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- if (@_ < 3) { return -1 } # Check the number of args
-
- my $row = $_[0]; # Zero indexed row
- my $col = $_[1]; # Zero indexed column
- my $str = $_[2];
-
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
- my $error = 0;
- my $date_time = $self->convert_date_time($str);
-
- if (defined $date_time) {
- $error = $self->write_number($row, $col, $date_time, $_[3]);
- }
- else {
- # The date isn't valid so write it as a string.
- $self->write_string($row, $col, $str, $_[3]);
- $error = -3;
- }
- return $error;
-}
-
-
-
-###############################################################################
-#
-# convert_date_time($date_time_string)
-#
-# The function takes a date and time in ISO8601 "yyyy-mm-ddThh:mm:ss.ss" format
-# and converts it to a decimal number representing a valid Excel date.
-#
-# Dates and times in Excel are represented by real numbers. The integer part of
-# the number stores the number of days since the epoch and the fractional part
-# stores the percentage of the day in seconds. The epoch can be either 1900 or
-# 1904.
-#
-# Parameter: Date and time string in one of the following formats:
-# yyyy-mm-ddThh:mm:ss.ss # Standard
-# yyyy-mm-ddT # Date only
-# Thh:mm:ss.ss # Time only
-#
-# Returns:
-# A decimal number representing a valid Excel date, or
-# undef if the date is invalid.
-#
-sub convert_date_time {
-
- my $self = shift;
- my $date_time = $_[0];
-
- my $days = 0; # Number of days since epoch
- my $seconds = 0; # Time expressed as fraction of 24h hours in seconds
-
- my ($year, $month, $day);
- my ($hour, $min, $sec);
-
-
- # Strip leading and trailing whitespace.
- $date_time =~ s/^\s+//;
- $date_time =~ s/\s+$//;
-
- # Check for invalid date char.
- return if $date_time =~ /[^0-9T:\-\.Z]/;
-
- # Check for "T" after date or before time.
- return unless $date_time =~ /\dT|T\d/;
-
- # Strip trailing Z in ISO8601 date.
- $date_time =~ s/Z$//;
-
-
- # Split into date and time.
- my ($date, $time) = split /T/, $date_time;
-
-
- # We allow the time portion of the input DateTime to be optional.
- if ($time ne '') {
- # Match hh:mm:ss.sss+ where the seconds are optional
- if ($time =~ /^(\d\d):(\d\d)(:(\d\d(\.\d+)?))?/) {
- $hour = $1;
- $min = $2;
- $sec = $4 || 0;
- }
- else {
- return undef; # Not a valid time format.
- }
-
- # Some boundary checks
- return if $hour >= 24;
- return if $min >= 60;
- return if $sec >= 60;
-
- # Excel expresses seconds as a fraction of the number in 24 hours.
- $seconds = ($hour *60*60 + $min *60 + $sec) / (24 *60 *60);
- }
-
-
- # We allow the date portion of the input DateTime to be optional.
- return $seconds if $date eq '';
-
-
- # Match date as yyyy-mm-dd.
- if ($date =~ /^(\d\d\d\d)-(\d\d)-(\d\d)$/) {
- $year = $1;
- $month = $2;
- $day = $3;
- }
- else {
- return undef; # Not a valid date format.
- }
-
- # Set the epoch as 1900 or 1904. Defaults to 1900.
- my $date_1904 = $self->{_1904};
-
-
- # Special cases for Excel.
- if (not $date_1904) {
- return $seconds if $date eq '1899-12-31'; # Excel 1900 epoch
- return $seconds if $date eq '1900-01-00'; # Excel 1900 epoch
- return 60 + $seconds if $date eq '1900-02-29'; # Excel false leapday
- }
-
-
- # We calculate the date by calculating the number of days since the epoch
- # and adjust for the number of leap days. We calculate the number of leap
- # days by normalising the year in relation to the epoch. Thus the year 2000
- # becomes 100 for 4 and 100 year leapdays and 400 for 400 year leapdays.
- #
- my $epoch = $date_1904 ? 1904 : 1900;
- my $offset = $date_1904 ? 4 : 0;
- my $norm = 300;
- my $range = $year -$epoch;
-
-
- # Set month days and check for leap year.
- my @mdays = (31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31);
- my $leap = 0;
- $leap = 1 if $year % 4 == 0 and $year % 100 or $year % 400 == 0;
- $mdays[1] = 29 if $leap;
-
-
- # Some boundary checks
- return if $year < $epoch or $year > 9999;
- return if $month < 1 or $month > 12;
- return if $day < 1 or $day > $mdays[$month -1];
-
- # Accumulate the number of days since the epoch.
- $days = $day; # Add days for current month
- $days += $mdays[$_] for 0 .. $month -2; # Add days for past months
- $days += $range *365; # Add days for past years
- $days += int(($range) / 4); # Add leapdays
- $days -= int(($range +$offset) /100); # Subtract 100 year leapdays
- $days += int(($range +$offset +$norm)/400); # Add 400 year leapdays
- $days -= $leap; # Already counted above
-
-
- # Adjust for Excel erroneously treating 1900 as a leap year.
- $days++ if $date_1904 == 0 and $days > 59;
-
- return $days + $seconds;
-}
-
-
-
-
-
-###############################################################################
-#
-# set_row($row, $height, $XF, $hidden, $level)
-#
-# This method is used to set the height and XF format for a row.
-# Writes the BIFF record ROW.
-#
-sub set_row {
-
- my $self = shift;
- my $record = 0x0208; # Record identifier
- my $length = 0x0010; # Number of bytes to follow
-
- my $rw = $_[0]; # Row Number
- my $colMic = 0x0000; # First defined column
- my $colMac = 0x0000; # Last defined column
- my $miyRw; # Row height
- my $irwMac = 0x0000; # Used by Excel to optimise loading
- my $reserved = 0x0000; # Reserved
- my $grbit = 0x0000; # Option flags
- my $ixfe; # XF index
- my $height = $_[1]; # Format object
- my $format = $_[2]; # Format object
- my $hidden = $_[3] || 0; # Hidden flag
- my $level = $_[4] || 0; # Outline level
-
-
- # Check for a format object
- if (ref $format) {
- $ixfe = $format->get_xf_index();
- }
- else {
- $ixfe = 0x0F;
- }
-
-
- # Set the row height in units of 1/20 of a point. Note, some heights may
- # not be obtained exactly due to rounding in Excel.
- #
- if (defined $height) {
- $miyRw = $height *20;
- }
- else {
- $miyRw = 0xff; # The default row height
- }
-
-
- # Set the limits for the outline levels (0 <= x <= 7).
- $level = 0 if $level < 0;
- $level = 7 if $level > 7;
-
- $self->{_outline_row_level} = $level if $level >$self->{_outline_row_level};
-
-
- # Set the options flags. fUnsynced is used to show that the font and row
- # heights are not compatible. This is usually the case for WriteExcel.
- # The collapsed flag 0x10 doesn't seem to be used to indicate that a row
- # is collapsed. Instead it is used to indicate that the previous row is
- # collapsed. The zero height flag, 0x20, is used to collapse a row.
- #
- $grbit |= $level;
- $grbit |= 0x0020 if $hidden;
- $grbit |= 0x0040; # fUnsynced
- $grbit |= 0x0080 if $format;
- $grbit |= 0x0100;
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvvvvv", $rw, $colMic, $colMac, $miyRw,
- $irwMac,$reserved, $grbit, $ixfe);
-
- $self->_append($header, $data);
-
- # Store the row sizes for use when calculating image vertices.
- # Also store the column formats.
- #
- return if @_ < 2;# Ensure at least $row and $height
-
- $self->{_row_sizes}->{$_[0]} = $height;
- $self->{_row_formats}->{$_[0]} = $format if defined $format;
-}
-
-
-###############################################################################
-#
-# _check_dimensions($row, $col)
-#
-# Check that $row and $col are valid and store max and min values for use in
-# DIMENSIONS record. See, _store_dimensions().
-#
-sub _check_dimensions {
-
- my $self = shift;
- my $row = $_[0];
- my $col = $_[1];
-
- if ($row >= $self->{_xls_rowmax}) { return -2 }
- if ($col >= $self->{_xls_colmax}) { return -2 }
-
- $self->{_dim_changed} = 1;
-
- if ($row < $self->{_dim_rowmin}) { $self->{_dim_rowmin} = $row }
- if ($row > $self->{_dim_rowmax}) { $self->{_dim_rowmax} = $row }
- if ($col < $self->{_dim_colmin}) { $self->{_dim_colmin} = $col }
- if ($col > $self->{_dim_colmax}) { $self->{_dim_colmax} = $col }
-
- return 0;
-}
-
-
-###############################################################################
-#
-# _store_dimensions()
-#
-# Writes Excel DIMENSIONS to define the area in which there is data.
-#
-sub _store_dimensions {
-
- my $self = shift;
- my $record = 0x0200; # Record identifier
- my $length = 0x000E; # Number of bytes to follow
- my $row_min; # First row
- my $row_max; # Last row plus 1
- my $col_min; # First column
- my $col_max; # Last column plus 1
- my $reserved = 0x0000; # Reserved by Excel
-
-
- # Set the data range if data has been written to the worksheet
- if ($self->{_dim_changed}) {
- $row_min = $self->{_dim_rowmin};
- $row_max = $self->{_dim_rowmax} +1;
- $col_min = $self->{_dim_colmin};
- $col_max = $self->{_dim_colmax} +1;
- }
- else {
- # Special case, not data was written
- $row_min = 0;
- $row_max = 0;
- $col_min = 0;
- $col_max = 256;
-
- }
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("VVvvv", $row_min, $row_max,
- $col_min, $col_max, $reserved);
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_window2()
-#
-# Write BIFF record Window2.
-#
-sub _store_window2 {
-
- use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
-
- my $self = shift;
- my $record = 0x023E; # Record identifier
- my $length = 0x0012; # Number of bytes to follow
-
- my $grbit = 0x00B6; # Option flags
- my $rwTop = 0x0000; # Top row visible in window
- my $colLeft = 0x0000; # Leftmost column visible in window
- my $rgbHdr = 0x00000040; # Row/column heading and gridline color
-
- my $wScaleSLV = 0x0000; #
- my $wSclaeNormal = 0x0000; #
- my $reserved = 0x00000000; #
-
-
- # The options flags that comprise $grbit
- my $fDspFmla = 0; # 0 - bit
- my $fDspGrid = $self->{_screen_gridlines}; # 1
- my $fDspRwCol = 1; # 2
- my $fFrozen = $self->{_frozen}; # 3
- my $fDspZeros = 1; # 4
- my $fDefaultHdr = 1; # 5
- my $fArabic = 0; # 6
- my $fDspGuts = $self->{_outline_on}; # 7
- my $fFrozenNoSplit = 0; # 0 - bit
- my $fSelected = $self->{_selected}; # 1
- my $fPaged = 1; # 2
-
- $grbit = $fDspFmla;
- $grbit |= $fDspGrid << 1;
- $grbit |= $fDspRwCol << 2;
- $grbit |= $fFrozen << 3;
- $grbit |= $fDspZeros << 4;
- $grbit |= $fDefaultHdr << 5;
- $grbit |= $fArabic << 6;
- $grbit |= $fDspGuts << 7;
- $grbit |= $fFrozenNoSplit << 8;
- $grbit |= $fSelected << 9;
- $grbit |= $fPaged << 10;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvVvvV", $grbit, $rwTop, $colLeft, $rgbHdr,
- $wScaleSLV, $wSclaeNormal, $reserved );
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_defcol()
-#
-# Write BIFF record DEFCOLWIDTH if COLINFO records are in use.
-#
-sub _store_defcol {
-
- my $self = shift;
- my $record = 0x0055; # Record identifier
- my $length = 0x0002; # Number of bytes to follow
-
- my $colwidth = 0x0008; # Default column width
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $colwidth);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_colinfo($firstcol, $lastcol, $width, $format, $hidden)
-#
-# Write BIFF record COLINFO to define column widths
-#
-# Note: The SDK says the record length is 0x0B but Excel writes a 0x0C
-# length record.
-#
-sub _store_colinfo {
-
- my $self = shift;
- my $record = 0x007D; # Record identifier
- my $length = 0x000B; # Number of bytes to follow
-
- my $colFirst = $_[0] || 0; # First formatted column
- my $colLast = $_[1] || 0; # Last formatted column
- my $width = $_[2] || 8.43; # Col width in user units, 8.43 is default
- my $coldx; # Col width in internal units
- my $pixels; # Col width in pixels
-
- # Excel rounds the column width to the nearest pixel. Therefore we first
- # convert to pixels and then to the internal units. The pixel to users-units
- # relationship is different for values less than 1.
- #
- if ($width < 1) {
- $pixels = int($width *12);
- }
- else {
- $pixels = int($width *7 ) +5;
- }
-
- $coldx = int($pixels *256/7);
-
-
- my $ixfe; # XF index
- my $grbit = 0x0000; # Option flags
- my $reserved = 0x00; # Reserved
- my $format = $_[3]; # Format object
- my $hidden = $_[4] || 0; # Hidden flag
- my $level = $_[5] || 0; # Outline level
-
-
- # Check for a format object
- if (ref $format) {
- $ixfe = $format->get_xf_index();
- }
- else {
- $ixfe = 0x0F;
- }
-
-
- # Set the limits for the outline levels (0 <= x <= 7).
- $level = 0 if $level < 0;
- $level = 7 if $level > 7;
-
-
- # Set the options flags.
- # The collapsed flag 0x10 doesn't seem to be used to indicate that a col
- # is collapsed. Instead it is used to indicate that the previous col is
- # collapsed. The zero height flag, 0x20, is used to collapse a col.
- #
- $grbit |= 0x0001 if $hidden;
- $grbit |= $level << 8;
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvvC", $colFirst, $colLast, $coldx,
- $ixfe, $grbit, $reserved);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_selection($first_row, $first_col, $last_row, $last_col)
-#
-# Write BIFF record SELECTION.
-#
-sub _store_selection {
-
- my $self = shift;
- my $record = 0x001D; # Record identifier
- my $length = 0x000F; # Number of bytes to follow
-
- my $pnn = $self->{_active_pane}; # Pane position
- my $rwAct = $_[0]; # Active row
- my $colAct = $_[1]; # Active column
- my $irefAct = 0; # Active cell ref
- my $cref = 1; # Number of refs
-
- my $rwFirst = $_[0]; # First row in reference
- my $colFirst = $_[1]; # First col in reference
- my $rwLast = $_[2] || $rwFirst; # Last row in reference
- my $colLast = $_[3] || $colFirst; # Last col in reference
-
- # Swap last row/col for first row/col as necessary
- if ($rwFirst > $rwLast) {
- ($rwFirst, $rwLast) = ($rwLast, $rwFirst);
- }
-
- if ($colFirst > $colLast) {
- ($colFirst, $colLast) = ($colLast, $colFirst);
- }
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("CvvvvvvCC", $pnn, $rwAct, $colAct,
- $irefAct, $cref,
- $rwFirst, $rwLast,
- $colFirst, $colLast);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_externcount($count)
-#
-# Write BIFF record EXTERNCOUNT to indicate the number of external sheet
-# references in a worksheet.
-#
-# Excel only stores references to external sheets that are used in formulas.
-# For simplicity we store references to all the sheets in the workbook
-# regardless of whether they are used or not. This reduces the overall
-# complexity and eliminates the need for a two way dialogue between the formula
-# parser the worksheet objects.
-#
-sub _store_externcount {
-
- my $self = shift;
- my $record = 0x0016; # Record identifier
- my $length = 0x0002; # Number of bytes to follow
-
- my $cxals = $_[0]; # Number of external references
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $cxals);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_externsheet($sheetname)
-#
-#
-# Writes the Excel BIFF EXTERNSHEET record. These references are used by
-# formulas. A formula references a sheet name via an index. Since we store a
-# reference to all of the external worksheets the EXTERNSHEET index is the same
-# as the worksheet index.
-#
-sub _store_externsheet {
-
- my $self = shift;
-
- my $record = 0x0017; # Record identifier
- my $length; # Number of bytes to follow
-
- my $sheetname = $_[0]; # Worksheet name
- my $cch; # Length of sheet name
- my $rgch; # Filename encoding
-
- # References to the current sheet are encoded differently to references to
- # external sheets.
- #
- if ($self->{_name} eq $sheetname) {
- $sheetname = '';
- $length = 0x02; # The following 2 bytes
- $cch = 1; # The following byte
- $rgch = 0x02; # Self reference
- }
- else {
- $length = 0x02 + length($_[0]);
- $cch = length($sheetname);
- $rgch = 0x03; # Reference to a sheet in the current workbook
- }
-
- my $header = pack("vv", $record, $length);
- my $data = pack("CC", $cch, $rgch);
-
- $self->_prepend($header, $data, $sheetname);
-}
-
-
-###############################################################################
-#
-# _store_panes()
-#
-#
-# Writes the Excel BIFF PANE record.
-# The panes can either be frozen or thawed (unfrozen).
-# Frozen panes are specified in terms of a integer number of rows and columns.
-# Thawed panes are specified in terms of Excel's units for rows and columns.
-#
-sub _store_panes {
-
- my $self = shift;
- my $record = 0x0041; # Record identifier
- my $length = 0x000A; # Number of bytes to follow
-
- my $y = $_[0] || 0; # Vertical split position
- my $x = $_[1] || 0; # Horizontal split position
- my $rwTop = $_[2]; # Top row visible
- my $colLeft = $_[3]; # Leftmost column visible
- my $pnnAct = $_[4]; # Active pane
-
-
- # Code specific to frozen or thawed panes.
- if ($self->{_frozen}) {
- # Set default values for $rwTop and $colLeft
- $rwTop = $y unless defined $rwTop;
- $colLeft = $x unless defined $colLeft;
- }
- else {
- # Set default values for $rwTop and $colLeft
- $rwTop = 0 unless defined $rwTop;
- $colLeft = 0 unless defined $colLeft;
-
- # Convert Excel's row and column units to the internal units.
- # The default row height is 12.75
- # The default column width is 8.43
- # The following slope and intersection values were interpolated.
- #
- $y = 20*$y + 255;
- $x = 113.879*$x + 390;
- }
-
-
- # Determine which pane should be active. There is also the undocumented
- # option to override this should it be necessary: may be removed later.
- #
- if (not defined $pnnAct) {
- $pnnAct = 0 if ($x != 0 && $y != 0); # Bottom right
- $pnnAct = 1 if ($x != 0 && $y == 0); # Top right
- $pnnAct = 2 if ($x == 0 && $y != 0); # Bottom left
- $pnnAct = 3 if ($x == 0 && $y == 0); # Top left
- }
-
- $self->{_active_pane} = $pnnAct; # Used in _store_selection
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvv", $x, $y, $rwTop, $colLeft, $pnnAct);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_setup()
-#
-# Store the page setup SETUP BIFF record.
-#
-sub _store_setup {
-
- use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
-
- my $self = shift;
- my $record = 0x00A1; # Record identifier
- my $length = 0x0022; # Number of bytes to follow
-
-
- # TODO some of these props don't have accessors. Add then as requested.
-
- my $iPaperSize = $self->{_paper_size}; # Paper size
- my $iScale = $self->{_print_scale}; # Print scaling factor
- my $iPageStart = $self->{_page_start}; # Starting page number
- my $iFitWidth = $self->{_fit_width}; # Fit to number of pages wide
- my $iFitHeight = $self->{_fit_height}; # Fit to number of pages high
- my $grbit = 0x00; # Option flags
- my $iRes = 0x0258; # Print resolution
- my $iVRes = 0x0258; # Vertical print resolution
- my $numHdr = $self->{_margin_head}; # Header Margin
- my $numFtr = $self->{_margin_foot}; # Footer Margin
- my $iCopies = 0x01; # Number of copies
-
-
- my $fLeftToRight = $self->{_page_order}; # Print over then down
- my $fLandscape = $self->{_orientation}; # Page orientation
- my $fNoPls = 0x0; # Setup not read from printer
- my $fNoColor = $self->{_black_white}; # Print black and white
- my $fDraft = $self->{_draft_quality}; # Print draft quality
- my $fNotes = $self->{_print_comments};# Print notes
- my $fNoOrient = 0x0; # Orientation not set
- my $fUsePage = 0x0; # Use custom starting page
-
-
- $grbit = $fLeftToRight;
- $grbit |= $fLandscape << 1;
- $grbit |= $fNoPls << 2;
- $grbit |= $fNoColor << 3;
- $grbit |= $fDraft << 4;
- $grbit |= $fNotes << 5;
- $grbit |= $fNoOrient << 6;
- $grbit |= $fUsePage << 7;
-
-
- $numHdr = pack("d", $numHdr);
- $numFtr = pack("d", $numFtr);
-
- if ($self->{_byte_order}) {
- $numHdr = reverse $numHdr;
- $numFtr = reverse $numFtr;
- }
-
- my $header = pack("vv", $record, $length);
- my $data1 = pack("vvvvvvvv", $iPaperSize,
- $iScale,
- $iPageStart,
- $iFitWidth,
- $iFitHeight,
- $grbit,
- $iRes,
- $iVRes);
- my $data2 = $numHdr .$numFtr;
- my $data3 = pack("v", $iCopies);
-
- $self->_prepend($header, $data1, $data2, $data3);
-
-}
-
-###############################################################################
-#
-# _store_header()
-#
-# Store the header caption BIFF record.
-#
-sub _store_header {
-
- my $self = shift;
-
- my $record = 0x0014; # Record identifier
- my $length; # Bytes to follow
-
- my $str = $self->{_header}; # header string
- my $cch = length($str); # Length of header string
- my $encoding = 0x0;
- $length = 3 + $cch;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vC", $cch, $encoding);
-
- $self->_prepend($header, $data, $str);
-}
-
-
-###############################################################################
-#
-# _store_footer()
-#
-# Store the footer caption BIFF record.
-#
-sub _store_footer {
-
- my $self = shift;
-
- my $record = 0x0015; # Record identifier
- my $length; # Bytes to follow
-
- my $str = $self->{_footer}; # Footer string
- my $cch = length($str); # Length of footer string
- my $encoding = 0x0;
- $length = 3 + $cch;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vC", $cch, $encoding);
-
- $self->_prepend($header, $data, $str);
-}
-
-
-###############################################################################
-#
-# _store_hcenter()
-#
-# Store the horizontal centering HCENTER BIFF record.
-#
-sub _store_hcenter {
-
- my $self = shift;
-
- my $record = 0x0083; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $fHCenter = $self->{_hcenter}; # Horizontal centering
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $fHCenter);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_vcenter()
-#
-# Store the vertical centering VCENTER BIFF record.
-#
-sub _store_vcenter {
-
- my $self = shift;
-
- my $record = 0x0084; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $fVCenter = $self->{_vcenter}; # Horizontal centering
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $fVCenter);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_margin_left()
-#
-# Store the LEFTMARGIN BIFF record.
-#
-sub _store_margin_left {
-
- my $self = shift;
-
- my $record = 0x0026; # Record identifier
- my $length = 0x0008; # Bytes to follow
-
- my $margin = $self->{_margin_left}; # Margin in inches
-
- my $header = pack("vv", $record, $length);
- my $data = pack("d", $margin);
-
- if ($self->{_byte_order}) { $data = reverse $data }
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_margin_right()
-#
-# Store the RIGHTMARGIN BIFF record.
-#
-sub _store_margin_right {
-
- my $self = shift;
-
- my $record = 0x0027; # Record identifier
- my $length = 0x0008; # Bytes to follow
-
- my $margin = $self->{_margin_right}; # Margin in inches
-
- my $header = pack("vv", $record, $length);
- my $data = pack("d", $margin);
-
- if ($self->{_byte_order}) { $data = reverse $data }
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_margin_top()
-#
-# Store the TOPMARGIN BIFF record.
-#
-sub _store_margin_top {
-
- my $self = shift;
-
- my $record = 0x0028; # Record identifier
- my $length = 0x0008; # Bytes to follow
-
- my $margin = $self->{_margin_top}; # Margin in inches
-
- my $header = pack("vv", $record, $length);
- my $data = pack("d", $margin);
-
- if ($self->{_byte_order}) { $data = reverse $data }
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_margin_bottom()
-#
-# Store the BOTTOMMARGIN BIFF record.
-#
-sub _store_margin_bottom {
-
- my $self = shift;
-
- my $record = 0x0029; # Record identifier
- my $length = 0x0008; # Bytes to follow
-
- my $margin = $self->{_margin_bottom}; # Margin in inches
-
- my $header = pack("vv", $record, $length);
- my $data = pack("d", $margin);
-
- if ($self->{_byte_order}) { $data = reverse $data }
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# merge_cells($first_row, $first_col, $last_row, $last_col)
-#
-# This is an Excel97/2000 method. It is required to perform more complicated
-# merging than the normal align merge in Format.pm
-#
-sub merge_cells {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- my $record = 0x00E5; # Record identifier
- my $length = 0x000A; # Bytes to follow
-
- my $cref = 1; # Number of refs
- my $rwFirst = $_[0]; # First row in reference
- my $colFirst = $_[1]; # First col in reference
- my $rwLast = $_[2] || $rwFirst; # Last row in reference
- my $colLast = $_[3] || $colFirst; # Last col in reference
-
-
- # Excel doesn't allow a single cell to be merged
- return if $rwFirst == $rwLast and $colFirst == $colLast;
-
- # Swap last row/col with first row/col as necessary
- ($rwFirst, $rwLast ) = ($rwLast, $rwFirst ) if $rwFirst > $rwLast;
- ($colFirst, $colLast) = ($colLast, $colFirst) if $colFirst > $colLast;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvvv", $cref,
- $rwFirst, $rwLast,
- $colFirst, $colLast);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# merge_range($first_row, $first_col, $last_row, $last_col, $string, $format)
-#
-# This is a wrapper to ensure correct use of the merge_cells method, i.e., write
-# the first cell of the range, write the formatted blank cells in the range and
-# then call the merge_cells record. Failing to do the steps in this order will
-# cause Excel 97 to crash.
-#
-sub merge_range {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
- croak "Incorrect number of arguments" if @_ != 6;
- croak "Final argument must be a format object" unless ref $_[5];
-
- my $rwFirst = $_[0];
- my $colFirst = $_[1];
- my $rwLast = $_[2];
- my $colLast = $_[3];
- my $string = $_[4];
- my $format = $_[5];
-
-
- # Set the merge_range property of the format object. For BIFF8+.
- $format->set_merge_range();
-
- # Excel doesn't allow a single cell to be merged
- croak "Can't merge single cell" if $rwFirst == $rwLast and
- $colFirst == $colLast;
-
- # Swap last row/col with first row/col as necessary
- ($rwFirst, $rwLast ) = ($rwLast, $rwFirst ) if $rwFirst > $rwLast;
- ($colFirst, $colLast) = ($colLast, $colFirst) if $colFirst > $colLast;
-
- # Write the first cell
- $self->write($rwFirst, $colFirst, $string, $format);
-
- # Pad out the rest of the area with formatted blank cells.
- for my $row ($rwFirst .. $rwLast) {
- for my $col ($colFirst .. $colLast) {
- next if $row == $rwFirst and $col == $colFirst;
- $self->write_blank($row, $col, $format);
- }
- }
-
- $self->merge_cells($rwFirst, $colFirst, $rwLast, $colLast);
-}
-
-
-###############################################################################
-#
-# _store_print_headers()
-#
-# Write the PRINTHEADERS BIFF record.
-#
-sub _store_print_headers {
-
- my $self = shift;
-
- my $record = 0x002a; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $fPrintRwCol = $self->{_print_headers}; # Boolean flag
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $fPrintRwCol);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_print_gridlines()
-#
-# Write the PRINTGRIDLINES BIFF record. Must be used in conjunction with the
-# GRIDSET record.
-#
-sub _store_print_gridlines {
-
- my $self = shift;
-
- my $record = 0x002b; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $fPrintGrid = $self->{_print_gridlines}; # Boolean flag
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $fPrintGrid);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_gridset()
-#
-# Write the GRIDSET BIFF record. Must be used in conjunction with the
-# PRINTGRIDLINES record.
-#
-sub _store_gridset {
-
- my $self = shift;
-
- my $record = 0x0082; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $fGridSet = not $self->{_print_gridlines}; # Boolean flag
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $fGridSet);
-
- $self->_prepend($header, $data);
-
-}
-
-
-###############################################################################
-#
-# _store_guts()
-#
-# Write the GUTS BIFF record. This is used to configure the gutter margins
-# where Excel outline symbols are displayed. The visibility of the gutters is
-# controlled by a flag in WSBOOL. See also _store_wsbool().
-#
-# We are all in the gutter but some of us are looking at the stars.
-#
-sub _store_guts {
-
- my $self = shift;
-
- my $record = 0x0080; # Record identifier
- my $length = 0x0008; # Bytes to follow
-
- my $dxRwGut = 0x0000; # Size of row gutter
- my $dxColGut = 0x0000; # Size of col gutter
-
- my $row_level = $self->{_outline_row_level};
- my $col_level = 0;
-
-
- # Calculate the maximum column outline level. The equivalent calculation
- # for the row outline level is carried out in set_row().
- #
- foreach my $colinfo (@{$self->{_colinfo}}) {
- # Skip cols without outline level info.
- next if @{$colinfo} < 6;
- $col_level = @{$colinfo}[5] if @{$colinfo}[5] > $col_level;
- }
-
-
- # Set the limits for the outline levels (0 <= x <= 7).
- $col_level = 0 if $col_level < 0;
- $col_level = 7 if $col_level > 7;
-
-
- # The displayed level is one greater than the max outline levels
- $row_level++ if $row_level > 0;
- $col_level++ if $col_level > 0;
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvv", $dxRwGut, $dxColGut, $row_level, $col_level);
-
- $self->_prepend($header, $data);
-
-}
-
-
-###############################################################################
-#
-# _store_wsbool()
-#
-# Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction
-# with the SETUP record.
-#
-sub _store_wsbool {
-
- my $self = shift;
-
- my $record = 0x0081; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $grbit = 0x0000; # Option flags
-
- # Set the option flags
- $grbit |= 0x0001; # Auto page breaks visible
- $grbit |= 0x0020 if $self->{_outline_style}; # Auto outline styles
- $grbit |= 0x0040 if $self->{_outline_below}; # Outline summary below
- $grbit |= 0x0080 if $self->{_outline_right}; # Outline summary right
- $grbit |= 0x0100 if $self->{_fit_page}; # Page setup fit to page
- $grbit |= 0x0400 if $self->{_outline_on}; # Outline symbols displayed
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $grbit);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_hbreak()
-#
-# Write the HORIZONTALPAGEBREAKS BIFF record.
-#
-sub _store_hbreak {
-
- my $self = shift;
-
- # Return if the user hasn't specified pagebreaks
- return unless @{$self->{_hbreaks}};
-
- # Sort and filter array of page breaks
- my @breaks = $self->_sort_pagebreaks(@{$self->{_hbreaks}});
-
- my $record = 0x001b; # Record identifier
- my $cbrk = scalar @breaks; # Number of page breaks
- my $length = 2 + 6*$cbrk; # Bytes to follow
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $cbrk);
-
- # Append each page break
- foreach my $break (@breaks) {
- $data .= pack("vvv", $break, 0x0000, 0x00ff);
- }
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_vbreak()
-#
-# Write the VERTICALPAGEBREAKS BIFF record.
-#
-sub _store_vbreak {
-
- my $self = shift;
-
- # Return if the user hasn't specified pagebreaks
- return unless @{$self->{_vbreaks}};
-
- # Sort and filter array of page breaks
- my @breaks = $self->_sort_pagebreaks(@{$self->{_vbreaks}});
-
- my $record = 0x001a; # Record identifier
- my $cbrk = scalar @breaks; # Number of page breaks
- my $length = 2 + 6*$cbrk; # Bytes to follow
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $cbrk);
-
- # Append each page break
- foreach my $break (@breaks) {
- $data .= pack("vvv", $break, 0x0000, 0xffff);
- }
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_protect()
-#
-# Set the Biff PROTECT record to indicate that the worksheet is protected.
-#
-sub _store_protect {
-
- my $self = shift;
-
- # Exit unless sheet protection has been specified
- return unless $self->{_protect};
-
- my $record = 0x0012; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $fLock = $self->{_protect}; # Worksheet is protected
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $fLock);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# _store_password()
-#
-# Write the worksheet PASSWORD record.
-#
-sub _store_password {
-
- my $self = shift;
-
- # Exit unless sheet protection and password have been specified
- return unless $self->{_protect} and defined $self->{_password};
-
- my $record = 0x0013; # Record identifier
- my $length = 0x0002; # Bytes to follow
-
- my $wPassword = $self->{_password}; # Encoded password
-
- my $header = pack("vv", $record, $length);
- my $data = pack("v", $wPassword);
-
- $self->_prepend($header, $data);
-}
-
-
-###############################################################################
-#
-# insert_bitmap($row, $col, $filename, $x, $y, $scale_x, $scale_y)
-#
-# Insert a 24bit bitmap image in a worksheet. The main record required is
-# IMDATA but it must be proceeded by a OBJ record to define its position.
-#
-sub insert_bitmap {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- my $row = $_[0];
- my $col = $_[1];
- my $bitmap = $_[2];
- my $x = $_[3] || 0;
- my $y = $_[4] || 0;
- my $scale_x = $_[5] || 1;
- my $scale_y = $_[6] || 1;
-
- my ($width, $height, $size, $data) = $self-> _process_bitmap($bitmap);
-
- # Scale the frame of the image.
- $width *= $scale_x;
- $height *= $scale_y;
-
- # Calculate the vertices of the image and write the OBJ record
- $self->_position_image($col, $row, $x, $y, $width, $height);
-
-
- # Write the IMDATA record to store the bitmap data
- my $record = 0x007f;
- my $length = 8 + $size;
- my $cf = 0x09;
- my $env = 0x01;
- my $lcb = $size;
-
- my $header = pack("vvvvV", $record, $length, $cf, $env, $lcb);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _position_image()
-#
-# Calculate the vertices that define the position of the image as required by
-# the OBJ record.
-#
-# +------------+------------+
-# | A | B |
-# +-----+------------+------------+
-# | |(x1,y1) | |
-# | 1 |(A1)._______|______ |
-# | | | | |
-# | | | | |
-# +-----+----| BITMAP |-----+
-# | | | | |
-# | 2 | |______________. |
-# | | | (B2)|
-# | | | (x2,y2)|
-# +---- +------------+------------+
-#
-# Example of a bitmap that covers some of the area from cell A1 to cell B2.
-#
-# Based on the width and height of the bitmap we need to calculate 8 vars:
-# $col_start, $row_start, $col_end, $row_end, $x1, $y1, $x2, $y2.
-# The width and height of the cells are also variable and have to be taken into
-# account.
-# The values of $col_start and $row_start are passed in from the calling
-# function. The values of $col_end and $row_end are calculated by subtracting
-# the width and height of the bitmap from the width and height of the
-# underlying cells.
-# The vertices are expressed as a percentage of the underlying cell width as
-# follows (rhs values are in pixels):
-#
-# x1 = X / W *1024
-# y1 = Y / H *256
-# x2 = (X-1) / W *1024
-# y2 = (Y-1) / H *256
-#
-# Where: X is distance from the left side of the underlying cell
-# Y is distance from the top of the underlying cell
-# W is the width of the cell
-# H is the height of the cell
-#
-# Note: the SDK incorrectly states that the height should be expressed as a
-# percentage of 1024.
-#
-sub _position_image {
-
- my $self = shift;
-
- my $col_start; # Col containing upper left corner of object
- my $x1; # Distance to left side of object
-
- my $row_start; # Row containing top left corner of object
- my $y1; # Distance to top of object
-
- my $col_end; # Col containing lower right corner of object
- my $x2; # Distance to right side of object
-
- my $row_end; # Row containing bottom right corner of object
- my $y2; # Distance to bottom of object
-
- my $width; # Width of image frame
- my $height; # Height of image frame
-
- ($col_start, $row_start, $x1, $y1, $width, $height) = @_;
-
-
- # Adjust start column for offsets that are greater than the col width
- while ($x1 >= $self->_size_col($col_start)) {
- $x1 -= $self->_size_col($col_start);
- $col_start++;
- }
-
- # Adjust start row for offsets that are greater than the row height
- while ($y1 >= $self->_size_row($row_start)) {
- $y1 -= $self->_size_row($row_start);
- $row_start++;
- }
-
-
- # Initialise end cell to the same as the start cell
- $col_end = $col_start;
- $row_end = $row_start;
-
- $width = $width + $x1 -1;
- $height = $height + $y1 -1;
-
-
- # Subtract the underlying cell widths to find the end cell of the image
- while ($width >= $self->_size_col($col_end)) {
- $width -= $self->_size_col($col_end);
- $col_end++;
- }
-
- # Subtract the underlying cell heights to find the end cell of the image
- while ($height >= $self->_size_row($row_end)) {
- $height -= $self->_size_row($row_end);
- $row_end++;
- }
-
- # Bitmap isn't allowed to start or finish in a hidden cell, i.e. a cell
- # with zero eight or width.
- #
- return if $self->_size_col($col_start) == 0;
- return if $self->_size_col($col_end) == 0;
- return if $self->_size_row($row_start) == 0;
- return if $self->_size_row($row_end) == 0;
-
- # Convert the pixel values to the percentage value expected by Excel
- $x1 = $x1 / $self->_size_col($col_start) * 1024;
- $y1 = $y1 / $self->_size_row($row_start) * 256;
- $x2 = $width / $self->_size_col($col_end) * 1024;
- $y2 = $height / $self->_size_row($row_end) * 256;
-
- $self->_store_obj_picture( $col_start, $x1,
- $row_start, $y1,
- $col_end, $x2,
- $row_end, $y2
- );
-}
-
-
-###############################################################################
-#
-# _size_col($col)
-#
-# Convert the width of a cell from user's units to pixels. Excel rounds the
-# column width to the nearest pixel. If the width hasn't been set by the user
-# we use the default value. If the column is hidden we use a value of zero.
-#
-sub _size_col {
-
- my $self = shift;
- my $col = $_[0];
-
- # Look up the cell value to see if it has been changed
- if (exists $self->{_col_sizes}->{$col}) {
- my $width = $self->{_col_sizes}->{$col};
-
- # The relationship is different for user units less than 1.
- if ($width < 1) {
- return int($width *12);
- }
- else {
- return int($width *7 ) +5;
- }
- }
- else {
- return 64;
- }
-}
-
-
-###############################################################################
-#
-# _size_row($row)
-#
-# Convert the height of a cell from user's units to pixels. By interpolation
-# the relationship is: y = 4/3x. If the height hasn't been set by the user we
-# use the default value. If the row is hidden we use a value of zero. (Not
-# possible to hide row yet).
-#
-sub _size_row {
-
- my $self = shift;
- my $row = $_[0];
-
- # Look up the cell value to see if it has been changed
- if (exists $self->{_row_sizes}->{$row}) {
- if ($self->{_row_sizes}->{$row} == 0) {
- return 0;
- }
- else {
- return int (4/3 * $self->{_row_sizes}->{$row});
- }
- }
- else {
- return 17;
- }
-}
-
-
-###############################################################################
-#
-# _store_obj_picture( $col_start, $x1,
-# $row_start, $y1,
-# $col_end, $x2,
-# $row_end, $y2 )
-#
-# Store the OBJ record that precedes an IMDATA record. This could be generalise
-# to support other Excel objects.
-#
-sub _store_obj_picture {
-
- my $self = shift;
-
- my $record = 0x005d; # Record identifier
- my $length = 0x003c; # Bytes to follow
-
- my $cObj = 0x0001; # Count of objects in file (set to 1)
- my $OT = 0x0008; # Object type. 8 = Picture
- my $id = 0x0001; # Object ID
- my $grbit = 0x0614; # Option flags
-
- my $colL = $_[0]; # Col containing upper left corner of object
- my $dxL = $_[1]; # Distance from left side of cell
-
- my $rwT = $_[2]; # Row containing top left corner of object
- my $dyT = $_[3]; # Distance from top of cell
-
- my $colR = $_[4]; # Col containing lower right corner of object
- my $dxR = $_[5]; # Distance from right of cell
-
- my $rwB = $_[6]; # Row containing bottom right corner of object
- my $dyB = $_[7]; # Distance from bottom of cell
-
- my $cbMacro = 0x0000; # Length of FMLA structure
- my $Reserved1 = 0x0000; # Reserved
- my $Reserved2 = 0x0000; # Reserved
-
- my $icvBack = 0x09; # Background colour
- my $icvFore = 0x09; # Foreground colour
- my $fls = 0x00; # Fill pattern
- my $fAuto = 0x00; # Automatic fill
- my $icv = 0x08; # Line colour
- my $lns = 0xff; # Line style
- my $lnw = 0x01; # Line weight
- my $fAutoB = 0x00; # Automatic border
- my $frs = 0x0000; # Frame style
- my $cf = 0x0009; # Image format, 9 = bitmap
- my $Reserved3 = 0x0000; # Reserved
- my $cbPictFmla = 0x0000; # Length of FMLA structure
- my $Reserved4 = 0x0000; # Reserved
- my $grbit2 = 0x0001; # Option flags
- my $Reserved5 = 0x0000; # Reserved
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("V", $cObj);
- $data .= pack("v", $OT);
- $data .= pack("v", $id);
- $data .= pack("v", $grbit);
- $data .= pack("v", $colL);
- $data .= pack("v", $dxL);
- $data .= pack("v", $rwT);
- $data .= pack("v", $dyT);
- $data .= pack("v", $colR);
- $data .= pack("v", $dxR);
- $data .= pack("v", $rwB);
- $data .= pack("v", $dyB);
- $data .= pack("v", $cbMacro);
- $data .= pack("V", $Reserved1);
- $data .= pack("v", $Reserved2);
- $data .= pack("C", $icvBack);
- $data .= pack("C", $icvFore);
- $data .= pack("C", $fls);
- $data .= pack("C", $fAuto);
- $data .= pack("C", $icv);
- $data .= pack("C", $lns);
- $data .= pack("C", $lnw);
- $data .= pack("C", $fAutoB);
- $data .= pack("v", $frs);
- $data .= pack("V", $cf);
- $data .= pack("v", $Reserved3);
- $data .= pack("v", $cbPictFmla);
- $data .= pack("v", $Reserved4);
- $data .= pack("v", $grbit2);
- $data .= pack("V", $Reserved5);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# _process_bitmap()
-#
-# Convert a 24 bit bitmap into the modified internal format used by Windows.
-# This is described in BITMAPCOREHEADER and BITMAPCOREINFO structures in the
-# MSDN library.
-#
-sub _process_bitmap {
-
- my $self = shift;
- my $bitmap = shift;
-
- # Open file and binmode the data in case the platform needs it.
- my $fh = FileHandle->new($bitmap);
- croak "Couldn't import $bitmap: $!" unless defined $fh;
- binmode $fh;
-
-
- # Slurp the file into a string.
- my $data = do {local $/; <$fh>};
-
- $fh->close;
-
- # Check that the file is big enough to be a bitmap.
- if (length $data <= 0x36) {
- croak "$bitmap doesn't contain enough data.";
- }
-
-
- # The first 2 bytes are used to identify the bitmap.
- if (unpack("A2", $data) ne "BM") {
- croak "$bitmap doesn't appear to be a valid bitmap image.";
- }
-
-
- # Remove bitmap data: ID.
- $data = substr $data, 2;
-
-
- # Read and remove the bitmap size. This is more reliable than reading
- # the data size at offset 0x22.
- #
- my $size = unpack "V", substr $data, 0, 4, "";
- $size -= 0x36; # Subtract size of bitmap header.
- $size += 0x0C; # Add size of BIFF header.
-
-
- # Remove bitmap data: reserved, offset, header length.
- $data = substr $data, 12;
-
-
- # Read and remove the bitmap width and height. Verify the sizes.
- my ($width, $height) = unpack "V2", substr $data, 0, 8, "";
-
- if ($width > 0xFFFF) {
- croak "$bitmap: largest image width supported is 65k.";
- }
-
- if ($height > 0xFFFF) {
- croak "$bitmap: largest image height supported is 65k.";
- }
-
- # Read and remove the bitmap planes and bpp data. Verify them.
- my ($planes, $bitcount) = unpack "v2", substr $data, 0, 4, "";
-
- if ($bitcount != 24) {
- croak "$bitmap isn't a 24bit true color bitmap.";
- }
-
- if ($planes != 1) {
- croak "$bitmap: only 1 plane supported in bitmap image.";
- }
-
-
- # Read and remove the bitmap compression. Verify compression.
- my $compression = unpack "V", substr $data, 0, 4, "";
-
- if ($compression != 0) {
- croak "$bitmap: compression not supported in bitmap image.";
- }
-
- # Remove bitmap data: data size, hres, vres, colours, imp. colours.
- $data = substr $data, 20;
-
- # Add the BITMAPCOREHEADER data
- my $header = pack("Vvvvv", 0x000c, $width, $height, 0x01, 0x18);
- $data = $header . $data;
-
- return ($width, $height, $size, $data);
-}
-
-
-###############################################################################
-#
-# _store_zoom($zoom)
-#
-#
-# Store the window zoom factor. This should be a reduced fraction but for
-# simplicity we will store all fractions with a numerator of 100.
-#
-sub _store_zoom {
-
- my $self = shift;
-
- # If scale is 100 we don't need to write a record
- return if $self->{_zoom} == 100;
-
- my $record = 0x00A0; # Record identifier
- my $length = 0x0004; # Bytes to follow
-
- my $header = pack("vv", $record, $length );
- my $data = pack("vv", $self->{_zoom}, 100);
-
- $self->_append($header, $data);
-}
-
-
-###############################################################################
-#
-# write_unicode ($row, $col, $string, $format)
-#
-# Write a Unicode string to the specified row and column (zero indexed).
-# $format is optional.
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-# -3 : long string truncated to 255 chars
-#
-sub write_unicode {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- if (@_ < 3) { return -1 } # Check the number of args
-
- my $record = 0x00FD; # Record identifier
- my $length = 0x000A; # Bytes to follow
-
- my $row = $_[0]; # Zero indexed row
- my $col = $_[1]; # Zero indexed column
- my $strlen = length($_[2]);
- my $str = $_[2];
- my $xf = _XF($self, $row, $col, $_[3]); # The cell format
- my $encoding = 0x1;
- my $str_error = 0;
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
- # TODO This should probably be the number of chars and not bytes. check.
- if ($strlen > 32766) {
- $str = substr($str, 0, 32766);
- $str_error = -3;
- }
-
-
- my $num_bytes = length $str;
- my $num_chars = int($num_bytes / 2);
-
-
- # Check for a valid 2-byte char string.
- croak "Uneven number of bytes in Unicode string" if $num_bytes % 2;
-
-
- # Change from UTF16 big-endian to little endian
- $str = pack "v*", unpack "n*", $str;
-
-
- # Add the encoding and length header to the string.
- my $str_header = pack("vC", $num_chars, $encoding);
- $str = $str_header . $str;
-
-
- if (not exists ${$self->{_str_table}}->{$str}) {
- ${$self->{_str_table}}->{$str} = ${$self->{_str_unique}}++;
- }
-
-
- ${$self->{_str_total}}++;
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvV", $row, $col, $xf, ${$self->{_str_table}}->{$str});
-
- $self->_append($header, $data);
-
- return $str_error;
-}
-
-
-
-###############################################################################
-#
-# write_unicode_le ($row, $col, $string, $format)
-#
-# Write a Unicode string to the specified row and column (zero indexed).
-# $format is optional.
-# Returns 0 : normal termination
-# -1 : insufficient number of arguments
-# -2 : row or column out of range
-# -3 : long string truncated to 255 chars
-#
-# TODO Refactor. Too much code share with write_unicode().
-#
-sub write_unicode_le {
-
- my $self = shift;
-
- # Check for a cell reference in A1 notation and substitute row and column
- if ($_[0] =~ /^\D/) {
- @_ = $self->_substitute_cellref(@_);
- }
-
- if (@_ < 3) { return -1 } # Check the number of args
-
- my $record = 0x00FD; # Record identifier
- my $length = 0x000A; # Bytes to follow
-
- my $row = $_[0]; # Zero indexed row
- my $col = $_[1]; # Zero indexed column
- my $strlen = length($_[2]);
- my $str = $_[2];
- my $xf = _XF($self, $row, $col, $_[3]); # The cell format
- my $encoding = 0x1;
- my $str_error = 0;
-
- # Check that row and col are valid and store max and min values
- return -2 if $self->_check_dimensions($row, $col);
-
- # TODO This should probably be the number of chars and not bytes. check.
- if ($strlen > 32766) {
- $str = substr($str, 0, 32766);
- $str_error = -3;
- }
-
-
- my $num_bytes = length $str;
- my $num_chars = int($num_bytes / 2);
-
-
- # Check for a valid 2-byte char string.
- croak "Uneven number of bytes in Unicode string" if $num_bytes % 2;
-
- # Add the encoding and length header to the string.
- my $str_header = pack("vC", $num_chars, $encoding);
- $str = $str_header . $str;
-
-
- if (not exists ${$self->{_str_table}}->{$str}) {
- ${$self->{_str_table}}->{$str} = ${$self->{_str_unique}}++;
- }
-
-
- ${$self->{_str_total}}++;
-
-
- my $header = pack("vv", $record, $length);
- my $data = pack("vvvV", $row, $col, $xf, ${$self->{_str_table}}->{$str});
-
- $self->_append($header, $data);
-
- return $str_error;
-}
-
-
-1;
-
-
-__END__
-
-
-=head1 NAME
-
-Worksheet - A writer class for Excel Worksheets.
-
-=head1 SYNOPSIS
-
-See the documentation for Spreadsheet::WriteExcel
-
-=head1 DESCRIPTION
-
-This module is used in conjunction with Spreadsheet::WriteExcel.
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
-
+
+###############################################################################
+#
+# _initialize()
+#
+# Open a tmp file to store the majority of the Worksheet data. If this fails,
+# for example due to write permissions, store the data in memory. This can be
+# slow for large files.
+#
+sub _initialize {
+
+ my $self = shift;
+ my $fh;
+ my $tmp_dir;
+
+ # The following code is complicated by Windows limitations. Porters can
+ # choose a more direct method.
+
+
+
+ # In the default case we use IO::File->new_tmpfile(). This may fail, in
+ # particular with IIS on Windows, so we allow the user to specify a temp
+ # directory via File::Temp.
+ #
+ if (defined $self->{_tempdir}) {
+
+ # Delay loading File:Temp to reduce the module dependencies.
+ eval { require File::Temp };
+ die "The File::Temp module must be installed in order ".
+ "to call set_tempdir().\n" if $@;
+
+
+ # Trap but ignore File::Temp errors.
+ eval { $fh = File::Temp::tempfile(DIR => $self->{_tempdir}) };
+
+ # Store the failed tmp dir in case of errors.
+ $tmp_dir = $self->{_tempdir} || File::Spec->tmpdir if not $fh;
+ }
+ else {
+
+ $fh = IO::File->new_tmpfile();
+
+ # Store the failed tmp dir in case of errors.
+ $tmp_dir = "POSIX::tmpnam() directory" if not $fh;
+ }
+
+
+ # Check if the temp file creation was successful. Else store data in memory.
+ if ($fh) {
+
+ # binmode file whether platform requires it or not.
+ binmode($fh);
+
+ # Store filehandle
+ $self->{_filehandle} = $fh;
+ }
+ else {
+
+ # Set flag to store data in memory if XX::tempfile() failed.
+ $self->{_using_tmpfile} = 0;
+
+ if ($self->{_index} == 0 && $^W) {
+ my $dir = $self->{_tempdir} || File::Spec->tmpdir();
+
+ warn "Unable to create temp files in $tmp_dir. Data will be ".
+ "stored in memory. Refer to set_tempdir() in the ".
+ "Spreadsheet::WriteExcel documentation.\n" ;
+ }
+ }
+}
+
+
+###############################################################################
+#
+# _close()
+#
+# Add data to the beginning of the workbook (note the reverse order)
+# and to the end of the workbook.
+#
+sub _close {
+
+ my $self = shift;
+ my $sheetnames = shift;
+ my $num_sheets = scalar @$sheetnames;
+
+ ################################################
+ # Prepend in reverse order!!
+ #
+
+ # Prepend the sheet dimensions
+ $self->_store_dimensions();
+
+ # Prepend the COLINFO records if they exist
+ if (@{$self->{_colinfo}}){
+ my @colinfo = @{$self->{_colinfo}};
+ while (@colinfo) {
+ my $arrayref = pop @colinfo;
+ $self->_store_colinfo(@$arrayref);
+ }
+
+ # Add the DEFCOLWIDTH record
+ $self->_store_defcol();
+ }
+
+ # Prepend the sheet password
+ $self->_store_password();
+
+ # Prepend the sheet protection
+ $self->_store_protect();
+
+ # Prepend the page setup
+ $self->_store_setup();
+
+ # Prepend the bottom margin
+ $self->_store_margin_bottom();
+
+ # Prepend the top margin
+ $self->_store_margin_top();
+
+ # Prepend the right margin
+ $self->_store_margin_right();
+
+ # Prepend the left margin
+ $self->_store_margin_left();
+
+ # Prepend the page vertical centering
+ $self->_store_vcenter();
+
+ # Prepend the page horizontal centering
+ $self->_store_hcenter();
+
+ # Prepend the page footer
+ $self->_store_footer();
+
+ # Prepend the page header
+ $self->_store_header();
+
+ # Prepend the vertical page breaks
+ $self->_store_vbreak();
+
+ # Prepend the horizontal page breaks
+ $self->_store_hbreak();
+
+ # Prepend WSBOOL
+ $self->_store_wsbool();
+
+ # Prepend GUTS
+ $self->_store_guts();
+
+ # Prepend GRIDSET
+ $self->_store_gridset();
+
+ # Prepend PRINTGRIDLINES
+ $self->_store_print_gridlines();
+
+ # Prepend PRINTHEADERS
+ $self->_store_print_headers();
+
+ # Prepend the BOF record
+ $self->_store_bof(0x0010);
+
+ #
+ # End of prepend. Read upwards from here.
+ ################################################
+
+ # Append
+ #$self->_dev_note(); # TODO
+ $self->_store_window2();
+ $self->_store_zoom();
+ $self->_store_panes(@{$self->{_panes}}) if @{$self->{_panes}};
+ $self->_store_selection(@{$self->{_selection}});
+ $self->_store_eof();
+}
+
+
+###############################################################################
+#
+# get_name().
+#
+# Retrieve the worksheet name.
+#
+sub get_name {
+
+ my $self = shift;
+
+ return $self->{_name};
+}
+
+
+###############################################################################
+#
+# get_data().
+#
+# Retrieves data from memory in one chunk, or from disk in $buffer
+# sized chunks.
+#
+sub get_data {
+
+ my $self = shift;
+ my $buffer = 4096;
+ my $tmp;
+
+ # Return data stored in memory
+ if (defined $self->{_data}) {
+ $tmp = $self->{_data};
+ $self->{_data} = undef;
+ my $fh = $self->{_filehandle};
+ seek($fh, 0, 0) if $self->{_using_tmpfile};
+ return $tmp;
+ }
+
+ # Return data stored on disk
+ if ($self->{_using_tmpfile}) {
+ return $tmp if read($self->{_filehandle}, $tmp, $buffer);
+ }
+
+ # No data to return
+ return undef;
+}
+
+
+###############################################################################
+#
+# select()
+#
+# Set this worksheet as a selected worksheet, i.e. the worksheet has its tab
+# highlighted.
+#
+sub select {
+
+ my $self = shift;
+
+ $self->{_selected} = 1;
+}
+
+
+###############################################################################
+#
+# activate()
+#
+# Set this worksheet as the active worksheet, i.e. the worksheet that is
+# displayed when the workbook is opened. Also set it as selected.
+#
+sub activate {
+
+ my $self = shift;
+
+ $self->{_selected} = 1;
+ ${$self->{_activesheet}} = $self->{_index};
+}
+
+
+###############################################################################
+#
+# set_first_sheet()
+#
+# Set this worksheet as the first visible sheet. This is necessary
+# when there are a large number of worksheets and the activated
+# worksheet is not visible on the screen.
+#
+sub set_first_sheet {
+
+ my $self = shift;
+
+ ${$self->{_firstsheet}} = $self->{_index};
+}
+
+
+###############################################################################
+#
+# protect($password)
+#
+# Set the worksheet protection flag to prevent accidental modification and to
+# hide formulas if the locked and hidden format properties have been set.
+#
+sub protect {
+
+ my $self = shift;
+
+ $self->{_protect} = 1;
+ $self->{_password} = $self->_encode_password($_[0]) if defined $_[0];
+
+}
+
+
+###############################################################################
+#
+# set_column($firstcol, $lastcol, $width, $format, $hidden, $level)
+#
+# Set the width of a single column or a range of columns.
+# See also: _store_colinfo
+#
+sub set_column {
+
+ my $self = shift;
+ my $cell = $_[0];
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($cell =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+
+ # Returned values $row1 and $row2 aren't required here. Remove them.
+ shift @_; # $row1
+ splice @_, 1, 1; # $row2
+ }
+
+ push @{$self->{_colinfo}}, [ @_ ];
+
+
+ # Store the col sizes for use when calculating image vertices taking
+ # hidden columns into account. Also store the column formats.
+ #
+ return if @_ < 3; # Ensure at least $firstcol, $lastcol and $width
+
+ my $width = $_[4] ? 0 : $_[2]; # Set width to zero if column is hidden
+ my $format = $_[3];
+
+ my ($firstcol, $lastcol) = @_;
+
+ foreach my $col ($firstcol .. $lastcol) {
+ $self->{_col_sizes}->{$col} = $width;
+ $self->{_col_formats}->{$col} = $format if defined $format;
+ }
+}
+
+
+###############################################################################
+#
+# set_selection()
+#
+# Set which cell or cells are selected in a worksheet: see also the
+# sub _store_selection
+#
+sub set_selection {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ $self->{_selection} = [ @_ ];
+}
+
+
+###############################################################################
+#
+# freeze_panes()
+#
+# Set panes and mark them as frozen. See also _store_panes().
+#
+sub freeze_panes {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ $self->{_frozen} = 1;
+ $self->{_panes} = [ @_ ];
+}
+
+
+###############################################################################
+#
+# thaw_panes()
+#
+# Set panes and mark them as unfrozen. See also _store_panes().
+#
+sub thaw_panes {
+
+ my $self = shift;
+
+ $self->{_frozen} = 0;
+ $self->{_panes} = [ @_ ];
+}
+
+
+###############################################################################
+#
+# set_portrait()
+#
+# Set the page orientation as portrait.
+#
+sub set_portrait {
+
+ my $self = shift;
+
+ $self->{_orientation} = 1;
+}
+
+
+###############################################################################
+#
+# set_landscape()
+#
+# Set the page orientation as landscape.
+#
+sub set_landscape {
+
+ my $self = shift;
+
+ $self->{_orientation} = 0;
+}
+
+
+###############################################################################
+#
+# set_paper()
+#
+# Set the paper type. Ex. 1 = US Letter, 9 = A4
+#
+sub set_paper {
+
+ my $self = shift;
+
+ $self->{_paper_size} = $_[0] || 0;
+}
+
+
+###############################################################################
+#
+# set_header()
+#
+# Set the page header caption and optional margin.
+#
+sub set_header {
+
+ my $self = shift;
+ my $string = $_[0] || '';
+ my $margin = $_[1] || 0.50;
+ my $encoding = $_[2] || 0;
+
+ # Handle utf8 strings in newer perls.
+ if ($] >= 5.008) {
+ require Encode;
+
+ if (Encode::is_utf8($string)) {
+ $string = Encode::encode("UTF-16BE", $string);
+ $encoding = 1;
+ }
+ }
+
+ my $limit = $encoding ? 255 *2 : 255;
+
+ if (length $string >= $limit) {
+ carp 'Header string must be less than 255 characters';
+ return;
+ }
+
+ $self->{_header} = $string;
+ $self->{_margin_header} = $margin;
+ $self->{_header_encoding} = $encoding;
+}
+
+
+###############################################################################
+#
+# set_footer()
+#
+# Set the page footer caption and optional margin.
+#
+sub set_footer {
+
+ my $self = shift;
+ my $string = $_[0] || '';
+ my $margin = $_[1] || 0.50;
+ my $encoding = $_[2] || 0;
+
+ # Handle utf8 strings in newer perls.
+ if ($] >= 5.008) {
+ require Encode;
+
+ if (Encode::is_utf8($string)) {
+ $string = Encode::encode("UTF-16BE", $string);
+ $encoding = 1;
+ }
+ }
+
+ my $limit = $encoding ? 255 *2 : 255;
+
+
+ if (length $string >= $limit) {
+ carp 'Footer string must be less than 255 characters';
+ return;
+ }
+
+ $self->{_footer} = $string;
+ $self->{_margin_footer} = $margin;
+ $self->{_footer_encoding} = $encoding;
+}
+
+
+###############################################################################
+#
+# center_horizontally()
+#
+# Center the page horizontally.
+#
+sub center_horizontally {
+
+ my $self = shift;
+
+ if (defined $_[0]) {
+ $self->{_hcenter} = $_[0];
+ }
+ else {
+ $self->{_hcenter} = 1;
+ }
+}
+
+
+###############################################################################
+#
+# center_vertically()
+#
+# Center the page horinzontally.
+#
+sub center_vertically {
+
+ my $self = shift;
+
+ if (defined $_[0]) {
+ $self->{_vcenter} = $_[0];
+ }
+ else {
+ $self->{_vcenter} = 1;
+ }
+}
+
+
+###############################################################################
+#
+# set_margins()
+#
+# Set all the page margins to the same value in inches.
+#
+sub set_margins {
+
+ my $self = shift;
+
+ $self->set_margin_left($_[0]);
+ $self->set_margin_right($_[0]);
+ $self->set_margin_top($_[0]);
+ $self->set_margin_bottom($_[0]);
+}
+
+
+###############################################################################
+#
+# set_margins_LR()
+#
+# Set the left and right margins to the same value in inches.
+#
+sub set_margins_LR {
+
+ my $self = shift;
+
+ $self->set_margin_left($_[0]);
+ $self->set_margin_right($_[0]);
+}
+
+
+###############################################################################
+#
+# set_margins_TB()
+#
+# Set the top and bottom margins to the same value in inches.
+#
+sub set_margins_TB {
+
+ my $self = shift;
+
+ $self->set_margin_top($_[0]);
+ $self->set_margin_bottom($_[0]);
+}
+
+
+###############################################################################
+#
+# set_margin_left()
+#
+# Set the left margin in inches.
+#
+sub set_margin_left {
+
+ my $self = shift;
+
+ $self->{_margin_left} = defined $_[0] ? $_[0] : 0.75;
+}
+
+
+###############################################################################
+#
+# set_margin_right()
+#
+# Set the right margin in inches.
+#
+sub set_margin_right {
+
+ my $self = shift;
+
+ $self->{_margin_right} = defined $_[0] ? $_[0] : 0.75;
+}
+
+
+###############################################################################
+#
+# set_margin_top()
+#
+# Set the top margin in inches.
+#
+sub set_margin_top {
+
+ my $self = shift;
+
+ $self->{_margin_top} = defined $_[0] ? $_[0] : 1.00;
+}
+
+
+###############################################################################
+#
+# set_margin_bottom()
+#
+# Set the bottom margin in inches.
+#
+sub set_margin_bottom {
+
+ my $self = shift;
+
+ $self->{_margin_bottom} = defined $_[0] ? $_[0] : 1.00;
+}
+
+
+###############################################################################
+#
+# repeat_rows($first_row, $last_row)
+#
+# Set the rows to repeat at the top of each printed page. See also the
+# _store_name_xxxx() methods in Workbook.pm.
+#
+sub repeat_rows {
+
+ my $self = shift;
+
+ $self->{_title_rowmin} = $_[0];
+ $self->{_title_rowmax} = $_[1] || $_[0]; # Second row is optional
+}
+
+
+###############################################################################
+#
+# repeat_columns($first_col, $last_col)
+#
+# Set the columns to repeat at the left hand side of each printed page.
+# See also the _store_names() methods in Workbook.pm.
+#
+sub repeat_columns {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+
+ # Returned values $row1 and $row2 aren't required here. Remove them.
+ shift @_; # $row1
+ splice @_, 1, 1; # $row2
+ }
+
+ $self->{_title_colmin} = $_[0];
+ $self->{_title_colmax} = $_[1] || $_[0]; # Second col is optional
+}
+
+
+###############################################################################
+#
+# print_area($first_row, $first_col, $last_row, $last_col)
+#
+# Set the area of each worksheet that will be printed. See also the
+# _store_names() methods in Workbook.pm.
+#
+sub print_area {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ return if @_ != 4; # Require 4 parameters
+
+ $self->{_print_rowmin} = $_[0];
+ $self->{_print_colmin} = $_[1];
+ $self->{_print_rowmax} = $_[2];
+ $self->{_print_colmax} = $_[3];
+}
+
+
+###############################################################################
+#
+# hide_gridlines()
+#
+# Set the option to hide gridlines on the screen and the printed page.
+# There are two ways of doing this in the Excel BIFF format: The first is by
+# setting the DspGrid field of the WINDOW2 record, this turns off the screen
+# and subsequently the print gridline. The second method is to via the
+# PRINTGRIDLINES and GRIDSET records, this turns off the printed gridlines
+# only. The first method is probably sufficient for most cases. The second
+# method is supported for backwards compatibility. Porters take note.
+#
+sub hide_gridlines {
+
+ my $self = shift;
+ my $option = $_[0];
+
+ $option = 1 unless defined $option; # Default to hiding printed gridlines
+
+ if ($option == 0) {
+ $self->{_print_gridlines} = 1; # 1 = display, 0 = hide
+ $self->{_screen_gridlines} = 1;
+ }
+ elsif ($option == 1) {
+ $self->{_print_gridlines} = 0;
+ $self->{_screen_gridlines} = 1;
+ }
+ else {
+ $self->{_print_gridlines} = 0;
+ $self->{_screen_gridlines} = 0;
+ }
+}
+
+
+###############################################################################
+#
+# print_row_col_headers()
+#
+# Set the option to print the row and column headers on the printed page.
+# See also the _store_print_headers() method below.
+#
+sub print_row_col_headers {
+
+ my $self = shift;
+
+ if (defined $_[0]) {
+ $self->{_print_headers} = $_[0];
+ }
+ else {
+ $self->{_print_headers} = 1;
+ }
+}
+
+
+###############################################################################
+#
+# fit_to_pages($width, $height)
+#
+# Store the vertical and horizontal number of pages that will define the
+# maximum area printed. See also _store_setup() and _store_wsbool() below.
+#
+sub fit_to_pages {
+
+ my $self = shift;
+
+ $self->{_fit_page} = 1;
+ $self->{_fit_width} = $_[0] || 0;
+ $self->{_fit_height} = $_[1] || 0;
+}
+
+
+###############################################################################
+#
+# set_h_pagebreaks(@breaks)
+#
+# Store the horizontal page breaks on a worksheet.
+#
+sub set_h_pagebreaks {
+
+ my $self = shift;
+
+ push @{$self->{_hbreaks}}, @_;
+}
+
+
+###############################################################################
+#
+# set_v_pagebreaks(@breaks)
+#
+# Store the vertical page breaks on a worksheet.
+#
+sub set_v_pagebreaks {
+
+ my $self = shift;
+
+ push @{$self->{_vbreaks}}, @_;
+}
+
+
+###############################################################################
+#
+# set_zoom($scale)
+#
+# Set the worksheet zoom factor.
+#
+sub set_zoom {
+
+ my $self = shift;
+ my $scale = $_[0] || 100;
+
+ # Confine the scale to Excel's range
+ if ($scale < 10 or $scale > 400) {
+ carp "Zoom factor $scale outside range: 10 <= zoom <= 400";
+ $scale = 100;
+ }
+
+ $self->{_zoom} = int $scale;
+}
+
+
+###############################################################################
+#
+# set_print_scale($scale)
+#
+# Set the scale factor for the printed page.
+#
+sub set_print_scale {
+
+ my $self = shift;
+ my $scale = $_[0] || 100;
+
+ # Confine the scale to Excel's range
+ if ($scale < 10 or $scale > 400) {
+ carp "Print scale $scale outside range: 10 <= zoom <= 400";
+ $scale = 100;
+ }
+
+ # Turn off "fit to page" option
+ $self->{_fit_page} = 0;
+
+ $self->{_print_scale} = int $scale;
+}
+
+
+###############################################################################
+#
+# keep_leading_zeros()
+#
+# Causes the write() method to treat integers with a leading zero as a string.
+# This ensures that any leading zeros such, as in zip codes, are maintained.
+#
+sub keep_leading_zeros {
+
+ my $self = shift;
+
+ if (defined $_[0]) {
+ $self->{_leading_zeros} = $_[0];
+ }
+ else {
+ $self->{_leading_zeros} = 1;
+ }
+}
+
+
+###############################################################################
+#
+# add_write_handler($re, $code_ref)
+#
+# Allow the user to add their own matches and handlers to the write() method.
+#
+sub add_write_handler {
+
+ my $self = shift;
+
+ return unless @_ == 2;
+ return unless ref $_[1] eq 'CODE';
+
+ push @{$self->{_write_match}}, [ @_ ];
+}
+
+
+
+###############################################################################
+#
+# write($row, $col, $token, $format)
+#
+# Parse $token and call appropriate write method. $row and $column are zero
+# indexed. $format is optional.
+#
+# Returns: return value of called subroutine
+#
+sub write {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ my $token = $_[2];
+
+ # Handle undefs as blanks
+ $token = '' unless defined $token;
+
+
+ # First try user defined matches.
+ for my $aref (@{$self->{_write_match}}) {
+ my $re = $aref->[0];
+ my $sub = $aref->[1];
+
+ if ($token =~ /$re/) {
+ my $match = &$sub($self, @_);
+ return $match if defined $match;
+ }
+ }
+
+
+ # Match an array ref.
+ if (ref $token eq "ARRAY") {
+ return $self->write_row(@_);
+ }
+ # Match integer with leading zero(s)
+ elsif ($self->{_leading_zeros} and $token =~ /^0\d+$/) {
+ return $self->write_string(@_);
+ }
+ # Match number
+ elsif ($token =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/) {
+ return $self->write_number(@_);
+ }
+ # Match http, https or ftp URL
+ elsif ($token =~ m|^[fh]tt?ps?://|) {
+ return $self->write_url(@_);
+ }
+ # Match mailto:
+ elsif ($token =~ m/^mailto:/) {
+ return $self->write_url(@_);
+ }
+ # Match internal or external sheet link
+ elsif ($token =~ m[^(?:in|ex)ternal:]) {
+ return $self->write_url(@_);
+ }
+ # Match formula
+ elsif ($token =~ /^=/) {
+ return $self->write_formula(@_);
+ }
+ # Match blank
+ elsif ($token eq '') {
+ splice @_, 2, 1; # remove the empty string from the parameter list
+ return $self->write_blank(@_);
+ }
+ else {
+ return $self->write_string(@_);
+ }
+}
+
+
+###############################################################################
+#
+# write_row($row, $col, $array_ref, $format)
+#
+# Write a row of data starting from ($row, $col). Call write_col() if any of
+# the elements of the array ref are in turn array refs. This allows the writing
+# of 1D or 2D arrays of data in one go.
+#
+# Returns: the first encountered error value or zero for no errors
+#
+sub write_row {
+
+ my $self = shift;
+
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ # Catch non array refs passed by user.
+ if (ref $_[2] ne 'ARRAY') {
+ croak "Not an array ref in call to write_row()$!";
+ }
+
+ my $row = shift;
+ my $col = shift;
+ my $tokens = shift;
+ my @options = @_;
+ my $error = 0;
+ my $ret;
+
+ foreach my $token (@$tokens) {
+
+ # Check for nested arrays
+ if (ref $token eq "ARRAY") {
+ $ret = $self->write_col($row, $col, $token, @options);
+ } else {
+ $ret = $self->write ($row, $col, $token, @options);
+ }
+
+ # Return only the first error encountered, if any.
+ $error ||= $ret;
+ $col++;
+ }
+
+ return $error;
+}
+
+
+###############################################################################
+#
+# write_col($row, $col, $array_ref, $format)
+#
+# Write a column of data starting from ($row, $col). Call write_row() if any of
+# the elements of the array ref are in turn array refs. This allows the writing
+# of 1D or 2D arrays of data in one go.
+#
+# Returns: the first encountered error value or zero for no errors
+#
+sub write_col {
+
+ my $self = shift;
+
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ # Catch non array refs passed by user.
+ if (ref $_[2] ne 'ARRAY') {
+ croak "Not an array ref in call to write_row()$!";
+ }
+
+ my $row = shift;
+ my $col = shift;
+ my $tokens = shift;
+ my @options = @_;
+ my $error = 0;
+ my $ret;
+
+ foreach my $token (@$tokens) {
+
+ # write() will deal with any nested arrays
+ $ret = $self->write($row, $col, $token, @options);
+
+ # Return only the first error encountered, if any.
+ $error ||= $ret;
+ $row++;
+ }
+
+ return $error;
+}
+
+
+###############################################################################
+#
+# write_comment($row, $col, $comment)
+#
+# Write a comment to the specified row and column (zero indexed). The maximum
+# comment size is 30831 chars. Excel5 probably accepts 32k-1 chars. However, it
+# can only display 30831 chars. Excel 7 and 2000 will crash above 32k-1.
+#
+# In Excel 5 a comment is referred to as a NOTE.
+#
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+# -3 : long comment truncated to 30831 chars
+#
+sub write_comment {
+
+ # Not available in this release
+ return -4;
+
+}
+
+
+###############################################################################
+#
+# _XF()
+#
+# Returns an index to the XF record in the workbook.
+#
+# Note: this is a function, not a method.
+#
+sub _XF {
+
+ my $self = $_[0];
+ my $row = $_[1];
+ my $col = $_[2];
+ my $format = $_[3];
+
+ if (ref($format)) {
+ return $format->get_xf_index();
+ }
+ elsif (exists $self->{_row_formats}->{$row}) {
+ return $self->{_row_formats}->{$row}->get_xf_index();
+ }
+ elsif (exists $self->{_col_formats}->{$col}) {
+ return $self->{_col_formats}->{$col}->get_xf_index();
+ }
+ else {
+ return 0x0F;
+ }
+}
+
+
+###############################################################################
+###############################################################################
+#
+# Internal methods
+#
+
+
+###############################################################################
+#
+# _append(), overloaded.
+#
+# Store Worksheet data in memory using the base class _append() or to a
+# temporary file, the default.
+#
+sub _append {
+
+ my $self = shift;
+
+ if ($self->{_using_tmpfile}) {
+ my $data = join('', @_);
+
+ # Add CONTINUE records if necessary
+ $data = $self->_add_continue($data) if length($data) > $self->{_limit};
+
+ # Protect print() from -l on the command line.
+ local $\ = undef;
+
+ print {$self->{_filehandle}} $data;
+ $self->{_datasize} += length($data);
+ }
+ else {
+ $self->SUPER::_append(@_);
+ }
+}
+
+
+###############################################################################
+#
+# _substitute_cellref()
+#
+# Substitute an Excel cell reference in A1 notation for zero based row and
+# column values in an argument list.
+#
+# Ex: ("A4", "Hello") is converted to (3, 0, "Hello").
+#
+sub _substitute_cellref {
+
+ my $self = shift;
+ my $cell = uc(shift);
+
+ # Convert a column range: 'A:A' or 'B:G'.
+ # A range such as A:A is equivalent to A1:65536, so add rows as required
+ if ($cell =~ /\$?([A-I]?[A-Z]):\$?([A-I]?[A-Z])/) {
+ my ($row1, $col1) = $self->_cell_to_rowcol($1 .'1');
+ my ($row2, $col2) = $self->_cell_to_rowcol($2 .'65536');
+ return $row1, $col1, $row2, $col2, @_;
+ }
+
+ # Convert a cell range: 'A1:B7'
+ if ($cell =~ /\$?([A-I]?[A-Z]\$?\d+):\$?([A-I]?[A-Z]\$?\d+)/) {
+ my ($row1, $col1) = $self->_cell_to_rowcol($1);
+ my ($row2, $col2) = $self->_cell_to_rowcol($2);
+ return $row1, $col1, $row2, $col2, @_;
+ }
+
+ # Convert a cell reference: 'A1' or 'AD2000'
+ if ($cell =~ /\$?([A-I]?[A-Z]\$?\d+)/) {
+ my ($row1, $col1) = $self->_cell_to_rowcol($1);
+ return $row1, $col1, @_;
+
+ }
+
+ croak("Unknown cell reference $cell");
+}
+
+
+###############################################################################
+#
+# _cell_to_rowcol($cell_ref)
+#
+# Convert an Excel cell reference in A1 notation to a zero based row and column
+# reference; converts C1 to (0, 2).
+#
+# Returns: row, column
+#
+# TODO use functions in Utility.pm
+#
+sub _cell_to_rowcol {
+
+ my $self = shift;
+ my $cell = shift;
+
+ $cell =~ /\$?([A-I]?[A-Z])\$?(\d+)/;
+
+ my $col = $1;
+ my $row = $2;
+
+ # Convert base26 column string to number
+ # All your Base are belong to us.
+ my @chars = split //, $col;
+ my $expn = 0;
+ $col = 0;
+
+ while (@chars) {
+ my $char = pop(@chars); # LS char first
+ $col += (ord($char) -ord('A') +1) * (26**$expn);
+ $expn++;
+ }
+
+ # Convert 1-index to zero-index
+ $row--;
+ $col--;
+
+ return $row, $col;
+}
+
+
+###############################################################################
+#
+# _sort_pagebreaks()
+#
+#
+# This is an internal method that is used to filter elements of the array of
+# pagebreaks used in the _store_hbreak() and _store_vbreak() methods. It:
+# 1. Removes duplicate entries from the list.
+# 2. Sorts the list.
+# 3. Removes 0 from the list if present.
+#
+sub _sort_pagebreaks {
+
+ my $self= shift;
+
+ my %hash;
+ my @array;
+
+ @hash{@_} = undef; # Hash slice to remove duplicates
+ @array = sort {$a <=> $b} keys %hash; # Numerical sort
+ shift @array if $array[0] == 0; # Remove zero
+
+ # 1000 vertical pagebreaks appears to be an internal Excel 5 limit.
+ # It is slightly higher in Excel 97/200, approx. 1026
+ splice(@array, 1000) if (@array > 1000);
+
+ return @array
+}
+
+
+###############################################################################
+#
+# _encode_password($password)
+#
+# Based on the algorithm provided by Daniel Rentz of OpenOffice.
+#
+#
+sub _encode_password {
+
+ use integer;
+
+ my $self = shift;
+ my $plaintext = $_[0];
+ my $password;
+ my $count;
+ my @chars;
+ my $i = 0;
+
+ $count = @chars = split //, $plaintext;
+
+ foreach my $char (@chars) {
+ my $low_15;
+ my $high_15;
+ $char = ord($char) << ++$i;
+ $low_15 = $char & 0x7fff;
+ $high_15 = $char & 0x7fff << 15;
+ $high_15 = $high_15 >> 15;
+ $char = $low_15 | $high_15;
+ }
+
+ $password = 0x0000;
+ $password ^= $_ for @chars;
+ $password ^= $count;
+ $password ^= 0xCE4B;
+
+ return $password;
+}
+
+
+###############################################################################
+#
+# outline_settings($visible, $symbols_below, $symbols_right, $auto_style)
+#
+# This method sets the properties for outlining and grouping. The defaults
+# correspond to Excel's defaults.
+#
+sub outline_settings {
+
+ my $self = shift;
+
+ $self->{_outline_on} = defined $_[0] ? $_[0] : 1;
+ $self->{_outline_below} = defined $_[1] ? $_[1] : 1;
+ $self->{_outline_right} = defined $_[2] ? $_[2] : 1;
+ $self->{_outline_style} = $_[3] || 0;
+
+ # Ensure this is a boolean vale for Window2
+ $self->{_outline_on} = 1 if $self->{_outline_on};
+}
+
+
+
+
+###############################################################################
+###############################################################################
+#
+# BIFF RECORDS
+#
+
+
+###############################################################################
+#
+# write_number($row, $col, $num, $format)
+#
+# Write a double to the specified row and column (zero indexed).
+# An integer can be written as a double. Excel will display an
+# integer. $format is optional.
+#
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+#
+sub write_number {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ if (@_ < 3) { return -1 } # Check the number of args
+
+ my $record = 0x0203; # Record identifier
+ my $length = 0x000E; # Number of bytes to follow
+
+ my $row = $_[0]; # Zero indexed row
+ my $col = $_[1]; # Zero indexed column
+ my $num = $_[2];
+ my $xf = _XF($self, $row, $col, $_[3]); # The cell format
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvv", $row, $col, $xf);
+ my $xl_double = pack("d", $num);
+
+ if ($self->{_byte_order}) { $xl_double = reverse $xl_double }
+
+ $self->_append($header, $data, $xl_double);
+
+ return 0;
+}
+
+
+###############################################################################
+#
+# write_string ($row, $col, $string, $format)
+#
+# Write a string to the specified row and column (zero indexed).
+# NOTE: there is an Excel 5 defined limit of 255 characters.
+# $format is optional.
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+# -3 : long string truncated to 255 chars
+#
+sub write_string {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ if (@_ < 3) { return -1 } # Check the number of args
+
+ my $record = 0x00FD; # Record identifier
+ my $length = 0x000A; # Bytes to follow
+
+ my $row = $_[0]; # Zero indexed row
+ my $col = $_[1]; # Zero indexed column
+ my $strlen = length($_[2]);
+ my $str = $_[2];
+ my $xf = _XF($self, $row, $col, $_[3]); # The cell format
+ my $encoding = 0x0;
+ my $str_error = 0;
+
+
+ # Handle utf8 strings in newer perls.
+ if ($] >= 5.008) {
+ require Encode;
+
+ if (Encode::is_utf8($str)) {
+ my $tmp = Encode::encode("UTF-16LE", $str);
+ return $self->write_unicode_le($row, $col, $tmp, $_[3]);
+ }
+ }
+
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+ # TODO
+ if ($strlen > 32767) {
+ $str = substr($str, 0, 32767);
+ $str_error = -3;
+ }
+
+
+ # TODO
+ my $str_header = pack("vC", length($str), $encoding);
+ $str = $str_header . $str;
+
+
+ if (not exists ${$self->{_str_table}}->{$str}) {
+ ${$self->{_str_table}}->{$str} = ${$self->{_str_unique}}++;
+ }
+
+
+ ${$self->{_str_total}}++;
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvV", $row, $col, $xf, ${$self->{_str_table}}->{$str});
+
+ $self->_append($header, $data);
+
+ return $str_error;
+}
+
+
+###############################################################################
+#
+# write_blank($row, $col, $format)
+#
+# Write a blank cell to the specified row and column (zero indexed).
+# A blank cell is used to specify formatting without adding a string
+# or a number.
+#
+# A blank cell without a format serves no purpose. Therefore, we don't write
+# a BLANK record unless a format is specified. This is mainly an optimisation
+# for the write_row() and write_col() methods.
+#
+# Returns 0 : normal termination (including no format)
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+#
+sub write_blank {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ # Check the number of args
+ return -1 if @_ < 2;
+
+ # Don't write a blank cell unless it has a format
+ return 0 if not defined $_[2];
+
+
+ my $record = 0x0201; # Record identifier
+ my $length = 0x0006; # Number of bytes to follow
+
+ my $row = $_[0]; # Zero indexed row
+ my $col = $_[1]; # Zero indexed column
+ my $xf = _XF($self, $row, $col, $_[2]); # The cell format
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvv", $row, $col, $xf);
+
+ $self->_append($header, $data);
+
+ return 0;
+}
+
+
+###############################################################################
+#
+# write_formula($row, $col, $formula, $format)
+#
+# Write a formula to the specified row and column (zero indexed).
+# The textual representation of the formula is passed to the parser in
+# Formula.pm which returns a packed binary string.
+#
+# $format is optional.
+#
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+#
+sub write_formula{
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ if (@_ < 3) { return -1 } # Check the number of args
+
+ my $record = 0x0006; # Record identifier
+ my $length; # Bytes to follow
+
+ my $row = $_[0]; # Zero indexed row
+ my $col = $_[1]; # Zero indexed column
+ my $formula = $_[2]; # The formula text string
+
+
+ # Excel normally stores the last calculated value of the formula in $num.
+ # Clearly we are not in a position to calculate this a priori. Instead
+ # we set $num to zero and set the option flags in $grbit to ensure
+ # automatic calculation of the formula when the file is opened.
+ #
+ my $xf = _XF($self, $row, $col, $_[3]); # The cell format
+ my $num = 0x00; # Current value of formula
+ my $grbit = 0x03; # Option flags
+ my $chn = 0x0000; # Must be zero
+
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+ # Strip the = sign at the beginning of the formula string
+ $formula =~ s(^=)();
+
+ my $tmp = $formula;
+
+ # Parse the formula using the parser in Formula.pm
+ my $parser = $self->{_parser};
+
+ # In order to raise formula errors from the point of view of the calling
+ # program we use an eval block and re-raise the error from here.
+ #
+ eval { $formula = $parser->parse_formula($formula) };
+
+ if ($@) {
+ $@ =~ s/\n$//; # Strip the \n used in the Formula.pm die()
+ croak $@; # Re-raise the error
+ }
+
+
+ my $formlen = length($formula); # Length of the binary string
+ $length = 0x16 + $formlen; # Length of the record data
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvdvVv", $row, $col, $xf, $num,
+ $grbit, $chn, $formlen);
+
+ $self->_append($header, $data, $formula);
+
+ return 0;
+}
+
+
+###############################################################################
+#
+# store_formula($formula)
+#
+# Pre-parse a formula. This is used in conjunction with repeat_formula()
+# to repetitively rewrite a formula without re-parsing it.
+#
+sub store_formula{
+
+ my $self = shift;
+ my $formula = $_[0]; # The formula text string
+
+ # Strip the = sign at the beginning of the formula string
+ $formula =~ s(^=)();
+
+ # Parse the formula using the parser in Formula.pm
+ my $parser = $self->{_parser};
+
+ # In order to raise formula errors from the point of view of the calling
+ # program we use an eval block and re-raise the error from here.
+ #
+ my @tokens;
+ eval { @tokens = $parser->parse_formula($formula) };
+
+ if ($@) {
+ $@ =~ s/\n$//; # Strip the \n used in the Formula.pm die()
+ croak $@; # Re-raise the error
+ }
+
+
+ # Return the parsed tokens in an anonymous array
+ return [@tokens];
+}
+
+
+###############################################################################
+#
+# repeat_formula($row, $col, $formula, $format, ($pattern => $replacement,...))
+#
+# Write a formula to the specified row and column (zero indexed) by
+# substituting $pattern $replacement pairs in the $formula created via
+# store_formula(). This allows the user to repetitively rewrite a formula
+# without the significant overhead of parsing.
+#
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+#
+sub repeat_formula {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ if (@_ < 2) { return -1 } # Check the number of args
+
+ my $record = 0x0006; # Record identifier
+ my $length; # Bytes to follow
+
+ my $row = shift; # Zero indexed row
+ my $col = shift; # Zero indexed column
+ my $formula_ref = shift; # Array ref with formula tokens
+ my $format = shift; # XF format
+ my @pairs = @_; # Pattern/replacement pairs
+
+
+ # Enforce an even number of arguments in the pattern/replacement list
+ croak "Odd number of elements in pattern/replacement list" if @pairs %2;
+
+ # Check that $formula is an array ref
+ croak "Not a valid formula" if ref $formula_ref ne 'ARRAY';
+
+ my @tokens = @$formula_ref;
+
+ # Ensure that there are tokens to substitute
+ croak "No tokens in formula" unless @tokens;
+
+ while (@pairs) {
+ my $pattern = shift @pairs;
+ my $replace = shift @pairs;
+
+ foreach my $token (@tokens) {
+ last if $token =~ s/$pattern/$replace/;
+ }
+ }
+
+
+ # Change the parameters in the formula cached by the Formula.pm object
+ my $parser = $self->{_parser};
+ my $formula = $parser->parse_tokens(@tokens);
+
+ croak "Unrecognised token in formula" unless defined $formula;
+
+
+ # Excel normally stores the last calculated value of the formula in $num.
+ # Clearly we are not in a position to calculate this a priori. Instead
+ # we set $num to zero and set the option flags in $grbit to ensure
+ # automatic calculation of the formula when the file is opened.
+ #
+ my $xf = _XF($self, $row, $col, $format); # The cell format
+ my $num = 0x00; # Current value of formula
+ my $grbit = 0x03; # Option flags
+ my $chn = 0x0000; # Must be zero
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+
+ my $formlen = length($formula); # Length of the binary string
+ $length = 0x16 + $formlen; # Length of the record data
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvdvVv", $row, $col, $xf, $num,
+ $grbit, $chn, $formlen);
+
+ $self->_append($header, $data, $formula);
+
+ return 0;
+}
+
+
+###############################################################################
+#
+# write_url($row, $col, $url, $string, $format)
+#
+# Write a hyperlink. This is comprised of two elements: the visible label and
+# the invisible link. The visible label is the same as the link unless an
+# alternative string is specified. The label is written using the
+# write_string() method. Therefore the 255 characters string limit applies.
+# $string and $format are optional and their order is interchangeable.
+#
+# The hyperlink can be to a http, ftp, mail, internal sheet, or external
+# directory url.
+#
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+# -3 : long string truncated to 255 chars
+#
+sub write_url {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ # Check the number of args
+ return -1 if @_ < 3;
+
+ # Add start row and col to arg list
+ return $self->write_url_range($_[0], $_[1], @_);
+}
+
+
+###############################################################################
+#
+# write_url_range($row1, $col1, $row2, $col2, $url, $string, $format)
+#
+# This is the more general form of write_url(). It allows a hyperlink to be
+# written to a range of cells. This function also decides the type of hyperlink
+# to be written. These are either, Web (http, ftp, mailto), Internal
+# (Sheet1!A1) or external ('c:\temp\foo.xls#Sheet1!A1').
+#
+# See also write_url() above for a general description and return values.
+#
+sub write_url_range {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ # Check the number of args
+ return -1 if @_ < 5;
+
+
+ # Reverse the order of $string and $format if necessary. We work on a copy
+ # in order to protect the callers args. We don't use "local @_" in case of
+ # perl50005 threads.
+ #
+ my @args = @_;
+
+ ($args[5], $args[6]) = ($args[6], $args[5]) if ref $args[5];
+
+ my $url = $args[4];
+
+
+ # Check for internal/external sheet links or default to web link
+ return $self->_write_url_internal(@args) if $url =~ m[^internal:];
+ return $self->_write_url_external(@args) if $url =~ m[^external:];
+ return $self->_write_url_web(@args);
+}
+
+
+###############################################################################
+#
+# _write_url_web($row1, $col1, $row2, $col2, $url, $string, $format)
+#
+# Used to write http, ftp and mailto hyperlinks.
+# The link type ($options) is 0x03 is the same as absolute dir ref without
+# sheet. However it is differentiated by the $unknown2 data stream.
+#
+# See also write_url() above for a general description and return values.
+#
+sub _write_url_web {
+
+ my $self = shift;
+
+ my $record = 0x01B8; # Record identifier
+ my $length = 0x00000; # Bytes to follow
+
+ my $row1 = $_[0]; # Start row
+ my $col1 = $_[1]; # Start column
+ my $row2 = $_[2]; # End row
+ my $col2 = $_[3]; # End column
+ my $url = $_[4]; # URL string
+ my $str = $_[5]; # Alternative label
+ my $xf = $_[6] || $self->{_url_format};# The cell format
+
+
+ # Write the visible label using the write_string() method.
+ $str = $url unless defined $str;
+ my $str_error = $self->write_string($row1, $col1, $str, $xf);
+ return $str_error if $str_error == -2;
+
+
+ # Pack the undocumented parts of the hyperlink stream
+ my $unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000");
+ my $unknown2 = pack("H*", "E0C9EA79F9BACE118C8200AA004BA90B");
+
+
+ # Pack the option flags
+ my $options = pack("V", 0x03);
+
+ # Convert URL to a null terminated wchar string
+ $url = join("\0", split('', $url));
+ $url = $url . "\0\0\0";
+
+
+ # Pack the length of the URL
+ my $url_len = pack("V", length($url));
+
+
+ # Calculate the data length
+ $length = 0x34 + length($url);
+
+
+ # Pack the header data
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvv", $row1, $row2, $col1, $col2);
+
+
+ # Write the packed data
+ $self->_append( $header,
+ $data,
+ $unknown1,
+ $options,
+ $unknown2,
+ $url_len,
+ $url);
+
+ return $str_error;
+}
+
+
+###############################################################################
+#
+# _write_url_internal($row1, $col1, $row2, $col2, $url, $string, $format)
+#
+# Used to write internal reference hyperlinks such as "Sheet1!A1".
+#
+# See also write_url() above for a general description and return values.
+#
+sub _write_url_internal {
+
+ my $self = shift;
+
+ my $record = 0x01B8; # Record identifier
+ my $length = 0x00000; # Bytes to follow
+
+ my $row1 = $_[0]; # Start row
+ my $col1 = $_[1]; # Start column
+ my $row2 = $_[2]; # End row
+ my $col2 = $_[3]; # End column
+ my $url = $_[4]; # URL string
+ my $str = $_[5]; # Alternative label
+ my $xf = $_[6] || $self->{_url_format};# The cell format
+
+ # Strip URL type
+ $url =~ s[^internal:][];
+
+
+ # Write the visible label
+ $str = $url unless defined $str;
+ my $str_error = $self->write_string($row1, $col1, $str, $xf);
+ return $str_error if $str_error == -2;
+
+
+ # Pack the undocumented parts of the hyperlink stream
+ my $unknown1 = pack("H*", "D0C9EA79F9BACE118C8200AA004BA90B02000000");
+
+
+ # Pack the option flags
+ my $options = pack("V", 0x08);
+
+
+ # Convert the URL type and to a null terminated wchar string
+ $url = join("\0", split('', $url));
+ $url = $url . "\0\0\0";
+
+
+ # Pack the length of the URL as chars (not wchars)
+ my $url_len = pack("V", int(length($url)/2));
+
+
+ # Calculate the data length
+ $length = 0x24 + length($url);
+
+
+ # Pack the header data
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvv", $row1, $row2, $col1, $col2);
+
+
+ # Write the packed data
+ $self->_append( $header,
+ $data,
+ $unknown1,
+ $options,
+ $url_len,
+ $url);
+
+ return $str_error;
+}
+
+
+###############################################################################
+#
+# _write_url_external($row1, $col1, $row2, $col2, $url, $string, $format)
+#
+# Write links to external directory names such as 'c:\foo.xls',
+# c:\foo.xls#Sheet1!A1', '../../foo.xls'. and '../../foo.xls#Sheet1!A1'.
+#
+# Note: Excel writes some relative links with the $dir_long string. We ignore
+# these cases for the sake of simpler code.
+#
+# See also write_url() above for a general description and return values.
+#
+sub _write_url_external {
+
+ my $self = shift;
+
+ # Network drives are different. We will handle them separately
+ # MS/Novell network drives and shares start with \\
+ return $self->_write_url_external_net(@_) if $_[4] =~ m[^external:\\\\];
+
+
+ my $record = 0x01B8; # Record identifier
+ my $length = 0x00000; # Bytes to follow
+
+ my $row1 = $_[0]; # Start row
+ my $col1 = $_[1]; # Start column
+ my $row2 = $_[2]; # End row
+ my $col2 = $_[3]; # End column
+ my $url = $_[4]; # URL string
+ my $str = $_[5]; # Alternative label
+ my $xf = $_[6] || $self->{_url_format};# The cell format
+
+
+ # Strip URL type and change Unix dir separator to Dos style (if needed)
+ #
+ $url =~ s[^external:][];
+ $url =~ s[/][\\]g;
+
+
+ # Write the visible label
+ ($str = $url) =~ s[\#][ - ] unless defined $str;
+ my $str_error = $self->write_string($row1, $col1, $str, $xf);
+ return $str_error if $str_error == -2;
+
+
+ # Determine if the link is relative or absolute:
+ # Absolute if link starts with DOS drive specifier like C:
+ # Otherwise default to 0x00 for relative link.
+ #
+ my $absolute = 0x00;
+ $absolute = 0x02 if $url =~ m/^[A-Za-z]:/;
+
+
+ # Determine if the link contains a sheet reference and change some of the
+ # parameters accordingly.
+ # Split the dir name and sheet name (if it exists)
+ #
+ my ($dir_long , $sheet) = split /\#/, $url;
+ my $link_type = 0x01 | $absolute;
+ my $sheet_len;
+
+ if (defined $sheet) {
+ $link_type |= 0x08;
+ $sheet_len = pack("V", length($sheet) + 0x01);
+ $sheet = join("\0", split('', $sheet));
+ $sheet .= "\0\0\0";
+ }
+ else {
+ $sheet_len = '';
+ $sheet = '';
+ }
+
+
+ # Pack the link type
+ $link_type = pack("V", $link_type);
+
+
+ # Calculate the up-level dir count e.g. (..\..\..\ == 3)
+ my $up_count = 0;
+ $up_count++ while $dir_long =~ s[^\.\.\\][];
+ $up_count = pack("v", $up_count);
+
+
+ # Store the short dos dir name (null terminated)
+ my $dir_short = $dir_long . "\0";
+
+
+ # Store the long dir name as a wchar string (non-null terminated)
+ $dir_long = join("\0", split('', $dir_long));
+ $dir_long = $dir_long . "\0";
+
+
+ # Pack the lengths of the dir strings
+ my $dir_short_len = pack("V", length $dir_short );
+ my $dir_long_len = pack("V", length $dir_long );
+ my $stream_len = pack("V", length($dir_long) + 0x06);
+
+
+ # Pack the undocumented parts of the hyperlink stream
+ my $unknown1 =pack("H*",'D0C9EA79F9BACE118C8200AA004BA90B02000000' );
+ my $unknown2 =pack("H*",'0303000000000000C000000000000046' );
+ my $unknown3 =pack("H*",'FFFFADDE000000000000000000000000000000000000000');
+ my $unknown4 =pack("v", 0x03 );
+
+
+ # Pack the main data stream
+ my $data = pack("vvvv", $row1, $row2, $col1, $col2) .
+ $unknown1 .
+ $link_type .
+ $unknown2 .
+ $up_count .
+ $dir_short_len.
+ $dir_short .
+ $unknown3 .
+ $stream_len .
+ $dir_long_len .
+ $unknown4 .
+ $dir_long .
+ $sheet_len .
+ $sheet ;
+
+
+ # Pack the header data
+ $length = length $data;
+ my $header = pack("vv", $record, $length);
+
+
+ # Write the packed data
+ $self->_append( $header, $data);
+
+ return $str_error;
+}
+
+
+
+
+###############################################################################
+#
+# _write_url_external_net($row1, $col1, $row2, $col2, $url, $string, $format)
+#
+# Write links to external MS/Novell network drives and shares such as
+# '//NETWORK/share/foo.xls' and '//NETWORK/share/foo.xls#Sheet1!A1'.
+#
+# See also write_url() above for a general description and return values.
+#
+sub _write_url_external_net {
+
+ my $self = shift;
+
+ my $record = 0x01B8; # Record identifier
+ my $length = 0x00000; # Bytes to follow
+
+ my $row1 = $_[0]; # Start row
+ my $col1 = $_[1]; # Start column
+ my $row2 = $_[2]; # End row
+ my $col2 = $_[3]; # End column
+ my $url = $_[4]; # URL string
+ my $str = $_[5]; # Alternative label
+ my $xf = $_[6] || $self->{_url_format};# The cell format
+
+
+ # Strip URL type and change Unix dir separator to Dos style (if needed)
+ #
+ $url =~ s[^external:][];
+ $url =~ s[/][\\]g;
+
+
+ # Write the visible label
+ ($str = $url) =~ s[\#][ - ] unless defined $str;
+ my $str_error = $self->write_string($row1, $col1, $str, $xf);
+ return $str_error if $str_error == -2;
+
+
+ # Determine if the link contains a sheet reference and change some of the
+ # parameters accordingly.
+ # Split the dir name and sheet name (if it exists)
+ #
+ my ($dir_long , $sheet) = split /\#/, $url;
+ my $link_type = 0x0103; # Always absolute
+ my $sheet_len;
+
+ if (defined $sheet) {
+ $link_type |= 0x08;
+ $sheet_len = pack("V", length($sheet) + 0x01);
+ $sheet = join("\0", split('', $sheet));
+ $sheet .= "\0\0\0";
+ }
+ else {
+ $sheet_len = '';
+ $sheet = '';
+ }
+
+ # Pack the link type
+ $link_type = pack("V", $link_type);
+
+
+ # Make the string null terminated
+ $dir_long = $dir_long . "\0";
+
+
+ # Pack the lengths of the dir string
+ my $dir_long_len = pack("V", length $dir_long);
+
+
+ # Store the long dir name as a wchar string (non-null terminated)
+ $dir_long = join("\0", split('', $dir_long));
+ $dir_long = $dir_long . "\0";
+
+
+ # Pack the undocumented part of the hyperlink stream
+ my $unknown1 = pack("H*",'D0C9EA79F9BACE118C8200AA004BA90B02000000');
+
+
+ # Pack the main data stream
+ my $data = pack("vvvv", $row1, $row2, $col1, $col2) .
+ $unknown1 .
+ $link_type .
+ $dir_long_len .
+ $dir_long .
+ $sheet_len .
+ $sheet ;
+
+
+ # Pack the header data
+ $length = length $data;
+ my $header = pack("vv", $record, $length);
+
+
+ # Write the packed data
+ $self->_append( $header, $data);
+
+ return $str_error;
+}
+
+
+###############################################################################
+#
+# write_date_time ($row, $col, $string, $format)
+#
+# Write a datetime string in ISO8601 "yyyy-mm-ddThh:mm:ss.ss" format as a
+# number representing an Excel date. $format is optional.
+#
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+# -3 : Invalid date_time, written as string
+#
+sub write_date_time {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ if (@_ < 3) { return -1 } # Check the number of args
+
+ my $row = $_[0]; # Zero indexed row
+ my $col = $_[1]; # Zero indexed column
+ my $str = $_[2];
+
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+ my $error = 0;
+ my $date_time = $self->convert_date_time($str);
+
+ if (defined $date_time) {
+ $error = $self->write_number($row, $col, $date_time, $_[3]);
+ }
+ else {
+ # The date isn't valid so write it as a string.
+ $self->write_string($row, $col, $str, $_[3]);
+ $error = -3;
+ }
+ return $error;
+}
+
+
+
+###############################################################################
+#
+# convert_date_time($date_time_string)
+#
+# The function takes a date and time in ISO8601 "yyyy-mm-ddThh:mm:ss.ss" format
+# and converts it to a decimal number representing a valid Excel date.
+#
+# Dates and times in Excel are represented by real numbers. The integer part of
+# the number stores the number of days since the epoch and the fractional part
+# stores the percentage of the day in seconds. The epoch can be either 1900 or
+# 1904.
+#
+# Parameter: Date and time string in one of the following formats:
+# yyyy-mm-ddThh:mm:ss.ss # Standard
+# yyyy-mm-ddT # Date only
+# Thh:mm:ss.ss # Time only
+#
+# Returns:
+# A decimal number representing a valid Excel date, or
+# undef if the date is invalid.
+#
+sub convert_date_time {
+
+ my $self = shift;
+ my $date_time = $_[0];
+
+ my $days = 0; # Number of days since epoch
+ my $seconds = 0; # Time expressed as fraction of 24h hours in seconds
+
+ my ($year, $month, $day);
+ my ($hour, $min, $sec);
+
+
+ # Strip leading and trailing whitespace.
+ $date_time =~ s/^\s+//;
+ $date_time =~ s/\s+$//;
+
+ # Check for invalid date char.
+ return if $date_time =~ /[^0-9T:\-\.Z]/;
+
+ # Check for "T" after date or before time.
+ return unless $date_time =~ /\dT|T\d/;
+
+ # Strip trailing Z in ISO8601 date.
+ $date_time =~ s/Z$//;
+
+
+ # Split into date and time.
+ my ($date, $time) = split /T/, $date_time;
+
+
+ # We allow the time portion of the input DateTime to be optional.
+ if ($time ne '') {
+ # Match hh:mm:ss.sss+ where the seconds are optional
+ if ($time =~ /^(\d\d):(\d\d)(:(\d\d(\.\d+)?))?/) {
+ $hour = $1;
+ $min = $2;
+ $sec = $4 || 0;
+ }
+ else {
+ return undef; # Not a valid time format.
+ }
+
+ # Some boundary checks
+ return if $hour >= 24;
+ return if $min >= 60;
+ return if $sec >= 60;
+
+ # Excel expresses seconds as a fraction of the number in 24 hours.
+ $seconds = ($hour *60*60 + $min *60 + $sec) / (24 *60 *60);
+ }
+
+
+ # We allow the date portion of the input DateTime to be optional.
+ return $seconds if $date eq '';
+
+
+ # Match date as yyyy-mm-dd.
+ if ($date =~ /^(\d\d\d\d)-(\d\d)-(\d\d)$/) {
+ $year = $1;
+ $month = $2;
+ $day = $3;
+ }
+ else {
+ return undef; # Not a valid date format.
+ }
+
+ # Set the epoch as 1900 or 1904. Defaults to 1900.
+ my $date_1904 = $self->{_1904};
+
+
+ # Special cases for Excel.
+ if (not $date_1904) {
+ return $seconds if $date eq '1899-12-31'; # Excel 1900 epoch
+ return $seconds if $date eq '1900-01-00'; # Excel 1900 epoch
+ return 60 + $seconds if $date eq '1900-02-29'; # Excel false leapday
+ }
+
+
+ # We calculate the date by calculating the number of days since the epoch
+ # and adjust for the number of leap days. We calculate the number of leap
+ # days by normalising the year in relation to the epoch. Thus the year 2000
+ # becomes 100 for 4 and 100 year leapdays and 400 for 400 year leapdays.
+ #
+ my $epoch = $date_1904 ? 1904 : 1900;
+ my $offset = $date_1904 ? 4 : 0;
+ my $norm = 300;
+ my $range = $year -$epoch;
+
+
+ # Set month days and check for leap year.
+ my @mdays = (31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31);
+ my $leap = 0;
+ $leap = 1 if $year % 4 == 0 and $year % 100 or $year % 400 == 0;
+ $mdays[1] = 29 if $leap;
+
+
+ # Some boundary checks
+ return if $year < $epoch or $year > 9999;
+ return if $month < 1 or $month > 12;
+ return if $day < 1 or $day > $mdays[$month -1];
+
+ # Accumulate the number of days since the epoch.
+ $days = $day; # Add days for current month
+ $days += $mdays[$_] for 0 .. $month -2; # Add days for past months
+ $days += $range *365; # Add days for past years
+ $days += int(($range) / 4); # Add leapdays
+ $days -= int(($range +$offset) /100); # Subtract 100 year leapdays
+ $days += int(($range +$offset +$norm)/400); # Add 400 year leapdays
+ $days -= $leap; # Already counted above
+
+
+ # Adjust for Excel erroneously treating 1900 as a leap year.
+ $days++ if $date_1904 == 0 and $days > 59;
+
+ return $days + $seconds;
+}
+
+
+
+
+
+###############################################################################
+#
+# set_row($row, $height, $XF, $hidden, $level)
+#
+# This method is used to set the height and XF format for a row.
+# Writes the BIFF record ROW.
+#
+sub set_row {
+
+ my $self = shift;
+ my $record = 0x0208; # Record identifier
+ my $length = 0x0010; # Number of bytes to follow
+
+ my $rw = $_[0]; # Row Number
+ my $colMic = 0x0000; # First defined column
+ my $colMac = 0x0000; # Last defined column
+ my $miyRw; # Row height
+ my $irwMac = 0x0000; # Used by Excel to optimise loading
+ my $reserved = 0x0000; # Reserved
+ my $grbit = 0x0000; # Option flags
+ my $ixfe; # XF index
+ my $height = $_[1]; # Format object
+ my $format = $_[2]; # Format object
+ my $hidden = $_[3] || 0; # Hidden flag
+ my $level = $_[4] || 0; # Outline level
+
+
+ # Check for a format object
+ if (ref $format) {
+ $ixfe = $format->get_xf_index();
+ }
+ else {
+ $ixfe = 0x0F;
+ }
+
+
+ # Set the row height in units of 1/20 of a point. Note, some heights may
+ # not be obtained exactly due to rounding in Excel.
+ #
+ if (defined $height) {
+ $miyRw = $height *20;
+ }
+ else {
+ $miyRw = 0xff; # The default row height
+ }
+
+
+ # Set the limits for the outline levels (0 <= x <= 7).
+ $level = 0 if $level < 0;
+ $level = 7 if $level > 7;
+
+ $self->{_outline_row_level} = $level if $level >$self->{_outline_row_level};
+
+
+ # Set the options flags. fUnsynced is used to show that the font and row
+ # heights are not compatible. This is usually the case for WriteExcel.
+ # The collapsed flag 0x10 doesn't seem to be used to indicate that a row
+ # is collapsed. Instead it is used to indicate that the previous row is
+ # collapsed. The zero height flag, 0x20, is used to collapse a row.
+ #
+ $grbit |= $level;
+ $grbit |= 0x0020 if $hidden;
+ $grbit |= 0x0040; # fUnsynced
+ $grbit |= 0x0080 if $format;
+ $grbit |= 0x0100;
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvvvvv", $rw, $colMic, $colMac, $miyRw,
+ $irwMac,$reserved, $grbit, $ixfe);
+
+ $self->_append($header, $data);
+
+ # Store the row sizes for use when calculating image vertices.
+ # Also store the column formats.
+ #
+ return if @_ < 2;# Ensure at least $row and $height
+
+ $self->{_row_sizes}->{$_[0]} = $height;
+ $self->{_row_formats}->{$_[0]} = $format if defined $format;
+}
+
+
+###############################################################################
+#
+# _check_dimensions($row, $col)
+#
+# Check that $row and $col are valid and store max and min values for use in
+# DIMENSIONS record. See, _store_dimensions().
+#
+sub _check_dimensions {
+
+ my $self = shift;
+ my $row = $_[0];
+ my $col = $_[1];
+
+ if ($row >= $self->{_xls_rowmax}) { return -2 }
+ if ($col >= $self->{_xls_colmax}) { return -2 }
+
+ $self->{_dim_changed} = 1;
+
+ if ($row < $self->{_dim_rowmin}) { $self->{_dim_rowmin} = $row }
+ if ($row > $self->{_dim_rowmax}) { $self->{_dim_rowmax} = $row }
+ if ($col < $self->{_dim_colmin}) { $self->{_dim_colmin} = $col }
+ if ($col > $self->{_dim_colmax}) { $self->{_dim_colmax} = $col }
+
+ return 0;
+}
+
+
+###############################################################################
+#
+# _store_dimensions()
+#
+# Writes Excel DIMENSIONS to define the area in which there is data.
+#
+sub _store_dimensions {
+
+ my $self = shift;
+ my $record = 0x0200; # Record identifier
+ my $length = 0x000E; # Number of bytes to follow
+ my $row_min; # First row
+ my $row_max; # Last row plus 1
+ my $col_min; # First column
+ my $col_max; # Last column plus 1
+ my $reserved = 0x0000; # Reserved by Excel
+
+
+ # Set the data range if data has been written to the worksheet
+ if ($self->{_dim_changed}) {
+ $row_min = $self->{_dim_rowmin};
+ $row_max = $self->{_dim_rowmax} +1;
+ $col_min = $self->{_dim_colmin};
+ $col_max = $self->{_dim_colmax} +1;
+ }
+ else {
+ # Special case, not data was written
+ $row_min = 0;
+ $row_max = 0;
+ $col_min = 0;
+ $col_max = 256;
+
+ }
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("VVvvv", $row_min, $row_max,
+ $col_min, $col_max, $reserved);
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_window2()
+#
+# Write BIFF record Window2.
+#
+sub _store_window2 {
+
+ use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
+
+ my $self = shift;
+ my $record = 0x023E; # Record identifier
+ my $length = 0x0012; # Number of bytes to follow
+
+ my $grbit = 0x00B6; # Option flags
+ my $rwTop = 0x0000; # Top row visible in window
+ my $colLeft = 0x0000; # Leftmost column visible in window
+ my $rgbHdr = 0x00000040; # Row/column heading and gridline color
+
+ my $wScaleSLV = 0x0000; #
+ my $wSclaeNormal = 0x0000; #
+ my $reserved = 0x00000000; #
+
+
+ # The options flags that comprise $grbit
+ my $fDspFmla = 0; # 0 - bit
+ my $fDspGrid = $self->{_screen_gridlines}; # 1
+ my $fDspRwCol = 1; # 2
+ my $fFrozen = $self->{_frozen}; # 3
+ my $fDspZeros = 1; # 4
+ my $fDefaultHdr = 1; # 5
+ my $fArabic = 0; # 6
+ my $fDspGuts = $self->{_outline_on}; # 7
+ my $fFrozenNoSplit = 0; # 0 - bit
+ my $fSelected = $self->{_selected}; # 1
+ my $fPaged = 1; # 2
+
+ $grbit = $fDspFmla;
+ $grbit |= $fDspGrid << 1;
+ $grbit |= $fDspRwCol << 2;
+ $grbit |= $fFrozen << 3;
+ $grbit |= $fDspZeros << 4;
+ $grbit |= $fDefaultHdr << 5;
+ $grbit |= $fArabic << 6;
+ $grbit |= $fDspGuts << 7;
+ $grbit |= $fFrozenNoSplit << 8;
+ $grbit |= $fSelected << 9;
+ $grbit |= $fPaged << 10;
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvVvvV", $grbit, $rwTop, $colLeft, $rgbHdr,
+ $wScaleSLV, $wSclaeNormal, $reserved );
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_defcol()
+#
+# Write BIFF record DEFCOLWIDTH if COLINFO records are in use.
+#
+sub _store_defcol {
+
+ my $self = shift;
+ my $record = 0x0055; # Record identifier
+ my $length = 0x0002; # Number of bytes to follow
+
+ my $colwidth = 0x0008; # Default column width
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $colwidth);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_colinfo($firstcol, $lastcol, $width, $format, $hidden)
+#
+# Write BIFF record COLINFO to define column widths
+#
+# Note: The SDK says the record length is 0x0B but Excel writes a 0x0C
+# length record.
+#
+sub _store_colinfo {
+
+ my $self = shift;
+ my $record = 0x007D; # Record identifier
+ my $length = 0x000B; # Number of bytes to follow
+
+ my $colFirst = $_[0] || 0; # First formatted column
+ my $colLast = $_[1] || 0; # Last formatted column
+ my $width = $_[2] || 8.43; # Col width in user units, 8.43 is default
+ my $coldx; # Col width in internal units
+ my $pixels; # Col width in pixels
+
+ # Excel rounds the column width to the nearest pixel. Therefore we first
+ # convert to pixels and then to the internal units. The pixel to users-units
+ # relationship is different for values less than 1.
+ #
+ if ($width < 1) {
+ $pixels = int($width *12);
+ }
+ else {
+ $pixels = int($width *7 ) +5;
+ }
+
+ $coldx = int($pixels *256/7);
+
+
+ my $ixfe; # XF index
+ my $grbit = 0x0000; # Option flags
+ my $reserved = 0x00; # Reserved
+ my $format = $_[3]; # Format object
+ my $hidden = $_[4] || 0; # Hidden flag
+ my $level = $_[5] || 0; # Outline level
+
+
+ # Check for a format object
+ if (ref $format) {
+ $ixfe = $format->get_xf_index();
+ }
+ else {
+ $ixfe = 0x0F;
+ }
+
+
+ # Set the limits for the outline levels (0 <= x <= 7).
+ $level = 0 if $level < 0;
+ $level = 7 if $level > 7;
+
+
+ # Set the options flags.
+ # The collapsed flag 0x10 doesn't seem to be used to indicate that a col
+ # is collapsed. Instead it is used to indicate that the previous col is
+ # collapsed. The zero height flag, 0x20, is used to collapse a col.
+ #
+ $grbit |= 0x0001 if $hidden;
+ $grbit |= $level << 8;
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvvC", $colFirst, $colLast, $coldx,
+ $ixfe, $grbit, $reserved);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_selection($first_row, $first_col, $last_row, $last_col)
+#
+# Write BIFF record SELECTION.
+#
+sub _store_selection {
+
+ my $self = shift;
+ my $record = 0x001D; # Record identifier
+ my $length = 0x000F; # Number of bytes to follow
+
+ my $pnn = $self->{_active_pane}; # Pane position
+ my $rwAct = $_[0]; # Active row
+ my $colAct = $_[1]; # Active column
+ my $irefAct = 0; # Active cell ref
+ my $cref = 1; # Number of refs
+
+ my $rwFirst = $_[0]; # First row in reference
+ my $colFirst = $_[1]; # First col in reference
+ my $rwLast = $_[2] || $rwFirst; # Last row in reference
+ my $colLast = $_[3] || $colFirst; # Last col in reference
+
+ # Swap last row/col for first row/col as necessary
+ if ($rwFirst > $rwLast) {
+ ($rwFirst, $rwLast) = ($rwLast, $rwFirst);
+ }
+
+ if ($colFirst > $colLast) {
+ ($colFirst, $colLast) = ($colLast, $colFirst);
+ }
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("CvvvvvvCC", $pnn, $rwAct, $colAct,
+ $irefAct, $cref,
+ $rwFirst, $rwLast,
+ $colFirst, $colLast);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_externcount($count)
+#
+# Write BIFF record EXTERNCOUNT to indicate the number of external sheet
+# references in a worksheet.
+#
+# Excel only stores references to external sheets that are used in formulas.
+# For simplicity we store references to all the sheets in the workbook
+# regardless of whether they are used or not. This reduces the overall
+# complexity and eliminates the need for a two way dialogue between the formula
+# parser the worksheet objects.
+#
+sub _store_externcount {
+
+ my $self = shift;
+ my $record = 0x0016; # Record identifier
+ my $length = 0x0002; # Number of bytes to follow
+
+ my $cxals = $_[0]; # Number of external references
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $cxals);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_externsheet($sheetname)
+#
+#
+# Writes the Excel BIFF EXTERNSHEET record. These references are used by
+# formulas. A formula references a sheet name via an index. Since we store a
+# reference to all of the external worksheets the EXTERNSHEET index is the same
+# as the worksheet index.
+#
+sub _store_externsheet {
+
+ my $self = shift;
+
+ my $record = 0x0017; # Record identifier
+ my $length; # Number of bytes to follow
+
+ my $sheetname = $_[0]; # Worksheet name
+ my $cch; # Length of sheet name
+ my $rgch; # Filename encoding
+
+ # References to the current sheet are encoded differently to references to
+ # external sheets.
+ #
+ if ($self->{_name} eq $sheetname) {
+ $sheetname = '';
+ $length = 0x02; # The following 2 bytes
+ $cch = 1; # The following byte
+ $rgch = 0x02; # Self reference
+ }
+ else {
+ $length = 0x02 + length($_[0]);
+ $cch = length($sheetname);
+ $rgch = 0x03; # Reference to a sheet in the current workbook
+ }
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("CC", $cch, $rgch);
+
+ $self->_prepend($header, $data, $sheetname);
+}
+
+
+###############################################################################
+#
+# _store_panes()
+#
+#
+# Writes the Excel BIFF PANE record.
+# The panes can either be frozen or thawed (unfrozen).
+# Frozen panes are specified in terms of a integer number of rows and columns.
+# Thawed panes are specified in terms of Excel's units for rows and columns.
+#
+sub _store_panes {
+
+ my $self = shift;
+ my $record = 0x0041; # Record identifier
+ my $length = 0x000A; # Number of bytes to follow
+
+ my $y = $_[0] || 0; # Vertical split position
+ my $x = $_[1] || 0; # Horizontal split position
+ my $rwTop = $_[2]; # Top row visible
+ my $colLeft = $_[3]; # Leftmost column visible
+ my $pnnAct = $_[4]; # Active pane
+
+
+ # Code specific to frozen or thawed panes.
+ if ($self->{_frozen}) {
+ # Set default values for $rwTop and $colLeft
+ $rwTop = $y unless defined $rwTop;
+ $colLeft = $x unless defined $colLeft;
+ }
+ else {
+ # Set default values for $rwTop and $colLeft
+ $rwTop = 0 unless defined $rwTop;
+ $colLeft = 0 unless defined $colLeft;
+
+ # Convert Excel's row and column units to the internal units.
+ # The default row height is 12.75
+ # The default column width is 8.43
+ # The following slope and intersection values were interpolated.
+ #
+ $y = 20*$y + 255;
+ $x = 113.879*$x + 390;
+ }
+
+
+ # Determine which pane should be active. There is also the undocumented
+ # option to override this should it be necessary: may be removed later.
+ #
+ if (not defined $pnnAct) {
+ $pnnAct = 0 if ($x != 0 && $y != 0); # Bottom right
+ $pnnAct = 1 if ($x != 0 && $y == 0); # Top right
+ $pnnAct = 2 if ($x == 0 && $y != 0); # Bottom left
+ $pnnAct = 3 if ($x == 0 && $y == 0); # Top left
+ }
+
+ $self->{_active_pane} = $pnnAct; # Used in _store_selection
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvv", $x, $y, $rwTop, $colLeft, $pnnAct);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_setup()
+#
+# Store the page setup SETUP BIFF record.
+#
+sub _store_setup {
+
+ use integer; # Avoid << shift bug in Perl 5.6.0 on HP-UX
+
+ my $self = shift;
+ my $record = 0x00A1; # Record identifier
+ my $length = 0x0022; # Number of bytes to follow
+
+
+ # TODO some of these props don't have accessors. Add then as requested.
+
+ my $iPaperSize = $self->{_paper_size}; # Paper size
+ my $iScale = $self->{_print_scale}; # Print scaling factor
+ my $iPageStart = $self->{_page_start}; # Starting page number
+ my $iFitWidth = $self->{_fit_width}; # Fit to number of pages wide
+ my $iFitHeight = $self->{_fit_height}; # Fit to number of pages high
+ my $grbit = 0x00; # Option flags
+ my $iRes = 0x0258; # Print resolution
+ my $iVRes = 0x0258; # Vertical print resolution
+ my $numHdr = $self->{_margin_header}; # Header Margin
+ my $numFtr = $self->{_margin_footer}; # Footer Margin
+ my $iCopies = 0x01; # Number of copies
+
+
+ my $fLeftToRight = $self->{_page_order}; # Print over then down
+ my $fLandscape = $self->{_orientation}; # Page orientation
+ my $fNoPls = 0x0; # Setup not read from printer
+ my $fNoColor = $self->{_black_white}; # Print black and white
+ my $fDraft = $self->{_draft_quality}; # Print draft quality
+ my $fNotes = $self->{_print_comments};# Print notes
+ my $fNoOrient = 0x0; # Orientation not set
+ my $fUsePage = 0x0; # Use custom starting page
+
+
+ $grbit = $fLeftToRight;
+ $grbit |= $fLandscape << 1;
+ $grbit |= $fNoPls << 2;
+ $grbit |= $fNoColor << 3;
+ $grbit |= $fDraft << 4;
+ $grbit |= $fNotes << 5;
+ $grbit |= $fNoOrient << 6;
+ $grbit |= $fUsePage << 7;
+
+
+ $numHdr = pack("d", $numHdr);
+ $numFtr = pack("d", $numFtr);
+
+ if ($self->{_byte_order}) {
+ $numHdr = reverse $numHdr;
+ $numFtr = reverse $numFtr;
+ }
+
+ my $header = pack("vv", $record, $length);
+ my $data1 = pack("vvvvvvvv", $iPaperSize,
+ $iScale,
+ $iPageStart,
+ $iFitWidth,
+ $iFitHeight,
+ $grbit,
+ $iRes,
+ $iVRes);
+ my $data2 = $numHdr .$numFtr;
+ my $data3 = pack("v", $iCopies);
+
+ $self->_prepend($header, $data1, $data2, $data3);
+
+}
+
+###############################################################################
+#
+# _store_header()
+#
+# Store the header caption BIFF record.
+#
+sub _store_header {
+
+ my $self = shift;
+
+ my $record = 0x0014; # Record identifier
+ my $length; # Bytes to follow
+
+ my $str = $self->{_header}; # header string
+ my $cch = length($str); # Length of header string
+ my $encoding = $self->{_header_encoding}; # Character encoding
+
+
+ # Character length is num of chars not num of bytes
+ $cch /= 2 if $encoding;
+
+ # Change the UTF-16 name from BE to LE
+ $str = pack 'n*', unpack 'v*', $str if $encoding;
+
+ $length = 3 + length($str);
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vC", $cch, $encoding);
+
+ $self->_prepend($header, $data, $str);
+}
+
+
+###############################################################################
+#
+# _store_footer()
+#
+# Store the footer caption BIFF record.
+#
+sub _store_footer {
+
+ my $self = shift;
+
+ my $record = 0x0015; # Record identifier
+ my $length; # Bytes to follow
+
+ my $str = $self->{_footer}; # footer string
+ my $cch = length($str); # Length of footer string
+ my $encoding = $self->{_footer_encoding}; # Character encoding
+
+
+ # Character length is num of chars not num of bytes
+ $cch /= 2 if $encoding;
+
+ # Change the UTF-16 name from BE to LE
+ $str = pack 'n*', unpack 'v*', $str if $encoding;
+
+ $length = 3 + length($str);
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vC", $cch, $encoding);
+
+ $self->_prepend($header, $data, $str);
+}
+
+
+###############################################################################
+#
+# _store_hcenter()
+#
+# Store the horizontal centering HCENTER BIFF record.
+#
+sub _store_hcenter {
+
+ my $self = shift;
+
+ my $record = 0x0083; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $fHCenter = $self->{_hcenter}; # Horizontal centering
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $fHCenter);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_vcenter()
+#
+# Store the vertical centering VCENTER BIFF record.
+#
+sub _store_vcenter {
+
+ my $self = shift;
+
+ my $record = 0x0084; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $fVCenter = $self->{_vcenter}; # Horizontal centering
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $fVCenter);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_margin_left()
+#
+# Store the LEFTMARGIN BIFF record.
+#
+sub _store_margin_left {
+
+ my $self = shift;
+
+ my $record = 0x0026; # Record identifier
+ my $length = 0x0008; # Bytes to follow
+
+ my $margin = $self->{_margin_left}; # Margin in inches
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("d", $margin);
+
+ if ($self->{_byte_order}) { $data = reverse $data }
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_margin_right()
+#
+# Store the RIGHTMARGIN BIFF record.
+#
+sub _store_margin_right {
+
+ my $self = shift;
+
+ my $record = 0x0027; # Record identifier
+ my $length = 0x0008; # Bytes to follow
+
+ my $margin = $self->{_margin_right}; # Margin in inches
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("d", $margin);
+
+ if ($self->{_byte_order}) { $data = reverse $data }
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_margin_top()
+#
+# Store the TOPMARGIN BIFF record.
+#
+sub _store_margin_top {
+
+ my $self = shift;
+
+ my $record = 0x0028; # Record identifier
+ my $length = 0x0008; # Bytes to follow
+
+ my $margin = $self->{_margin_top}; # Margin in inches
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("d", $margin);
+
+ if ($self->{_byte_order}) { $data = reverse $data }
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_margin_bottom()
+#
+# Store the BOTTOMMARGIN BIFF record.
+#
+sub _store_margin_bottom {
+
+ my $self = shift;
+
+ my $record = 0x0029; # Record identifier
+ my $length = 0x0008; # Bytes to follow
+
+ my $margin = $self->{_margin_bottom}; # Margin in inches
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("d", $margin);
+
+ if ($self->{_byte_order}) { $data = reverse $data }
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# merge_cells($first_row, $first_col, $last_row, $last_col)
+#
+# This is an Excel97/2000 method. It is required to perform more complicated
+# merging than the normal align merge in Format.pm
+#
+sub merge_cells {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ my $record = 0x00E5; # Record identifier
+ my $length = 0x000A; # Bytes to follow
+
+ my $cref = 1; # Number of refs
+ my $rwFirst = $_[0]; # First row in reference
+ my $colFirst = $_[1]; # First col in reference
+ my $rwLast = $_[2] || $rwFirst; # Last row in reference
+ my $colLast = $_[3] || $colFirst; # Last col in reference
+
+
+ # Excel doesn't allow a single cell to be merged
+ return if $rwFirst == $rwLast and $colFirst == $colLast;
+
+ # Swap last row/col with first row/col as necessary
+ ($rwFirst, $rwLast ) = ($rwLast, $rwFirst ) if $rwFirst > $rwLast;
+ ($colFirst, $colLast) = ($colLast, $colFirst) if $colFirst > $colLast;
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvvv", $cref,
+ $rwFirst, $rwLast,
+ $colFirst, $colLast);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# merge_range($first_row, $first_col, $last_row, $last_col, $string, $format)
+#
+# This is a wrapper to ensure correct use of the merge_cells method, i.e., write
+# the first cell of the range, write the formatted blank cells in the range and
+# then call the merge_cells record. Failing to do the steps in this order will
+# cause Excel 97 to crash.
+#
+sub merge_range {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+ croak "Incorrect number of arguments" if @_ != 6;
+ croak "Final argument must be a format object" unless ref $_[5];
+
+ my $rwFirst = $_[0];
+ my $colFirst = $_[1];
+ my $rwLast = $_[2];
+ my $colLast = $_[3];
+ my $string = $_[4];
+ my $format = $_[5];
+
+
+ # Set the merge_range property of the format object. For BIFF8+.
+ $format->set_merge_range();
+
+ # Excel doesn't allow a single cell to be merged
+ croak "Can't merge single cell" if $rwFirst == $rwLast and
+ $colFirst == $colLast;
+
+ # Swap last row/col with first row/col as necessary
+ ($rwFirst, $rwLast ) = ($rwLast, $rwFirst ) if $rwFirst > $rwLast;
+ ($colFirst, $colLast) = ($colLast, $colFirst) if $colFirst > $colLast;
+
+ # Write the first cell
+ $self->write($rwFirst, $colFirst, $string, $format);
+
+ # Pad out the rest of the area with formatted blank cells.
+ for my $row ($rwFirst .. $rwLast) {
+ for my $col ($colFirst .. $colLast) {
+ next if $row == $rwFirst and $col == $colFirst;
+ $self->write_blank($row, $col, $format);
+ }
+ }
+
+ $self->merge_cells($rwFirst, $colFirst, $rwLast, $colLast);
+}
+
+
+###############################################################################
+#
+# _store_print_headers()
+#
+# Write the PRINTHEADERS BIFF record.
+#
+sub _store_print_headers {
+
+ my $self = shift;
+
+ my $record = 0x002a; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $fPrintRwCol = $self->{_print_headers}; # Boolean flag
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $fPrintRwCol);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_print_gridlines()
+#
+# Write the PRINTGRIDLINES BIFF record. Must be used in conjunction with the
+# GRIDSET record.
+#
+sub _store_print_gridlines {
+
+ my $self = shift;
+
+ my $record = 0x002b; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $fPrintGrid = $self->{_print_gridlines}; # Boolean flag
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $fPrintGrid);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_gridset()
+#
+# Write the GRIDSET BIFF record. Must be used in conjunction with the
+# PRINTGRIDLINES record.
+#
+sub _store_gridset {
+
+ my $self = shift;
+
+ my $record = 0x0082; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $fGridSet = not $self->{_print_gridlines}; # Boolean flag
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $fGridSet);
+
+ $self->_prepend($header, $data);
+
+}
+
+
+###############################################################################
+#
+# _store_guts()
+#
+# Write the GUTS BIFF record. This is used to configure the gutter margins
+# where Excel outline symbols are displayed. The visibility of the gutters is
+# controlled by a flag in WSBOOL. See also _store_wsbool().
+#
+# We are all in the gutter but some of us are looking at the stars.
+#
+sub _store_guts {
+
+ my $self = shift;
+
+ my $record = 0x0080; # Record identifier
+ my $length = 0x0008; # Bytes to follow
+
+ my $dxRwGut = 0x0000; # Size of row gutter
+ my $dxColGut = 0x0000; # Size of col gutter
+
+ my $row_level = $self->{_outline_row_level};
+ my $col_level = 0;
+
+
+ # Calculate the maximum column outline level. The equivalent calculation
+ # for the row outline level is carried out in set_row().
+ #
+ foreach my $colinfo (@{$self->{_colinfo}}) {
+ # Skip cols without outline level info.
+ next if @{$colinfo} < 6;
+ $col_level = @{$colinfo}[5] if @{$colinfo}[5] > $col_level;
+ }
+
+
+ # Set the limits for the outline levels (0 <= x <= 7).
+ $col_level = 0 if $col_level < 0;
+ $col_level = 7 if $col_level > 7;
+
+
+ # The displayed level is one greater than the max outline levels
+ $row_level++ if $row_level > 0;
+ $col_level++ if $col_level > 0;
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvv", $dxRwGut, $dxColGut, $row_level, $col_level);
+
+ $self->_prepend($header, $data);
+
+}
+
+
+###############################################################################
+#
+# _store_wsbool()
+#
+# Write the WSBOOL BIFF record, mainly for fit-to-page. Used in conjunction
+# with the SETUP record.
+#
+sub _store_wsbool {
+
+ my $self = shift;
+
+ my $record = 0x0081; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $grbit = 0x0000; # Option flags
+
+ # Set the option flags
+ $grbit |= 0x0001; # Auto page breaks visible
+ $grbit |= 0x0020 if $self->{_outline_style}; # Auto outline styles
+ $grbit |= 0x0040 if $self->{_outline_below}; # Outline summary below
+ $grbit |= 0x0080 if $self->{_outline_right}; # Outline summary right
+ $grbit |= 0x0100 if $self->{_fit_page}; # Page setup fit to page
+ $grbit |= 0x0400 if $self->{_outline_on}; # Outline symbols displayed
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $grbit);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_hbreak()
+#
+# Write the HORIZONTALPAGEBREAKS BIFF record.
+#
+sub _store_hbreak {
+
+ my $self = shift;
+
+ # Return if the user hasn't specified pagebreaks
+ return unless @{$self->{_hbreaks}};
+
+ # Sort and filter array of page breaks
+ my @breaks = $self->_sort_pagebreaks(@{$self->{_hbreaks}});
+
+ my $record = 0x001b; # Record identifier
+ my $cbrk = scalar @breaks; # Number of page breaks
+ my $length = 2 + 6*$cbrk; # Bytes to follow
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $cbrk);
+
+ # Append each page break
+ foreach my $break (@breaks) {
+ $data .= pack("vvv", $break, 0x0000, 0x00ff);
+ }
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_vbreak()
+#
+# Write the VERTICALPAGEBREAKS BIFF record.
+#
+sub _store_vbreak {
+
+ my $self = shift;
+
+ # Return if the user hasn't specified pagebreaks
+ return unless @{$self->{_vbreaks}};
+
+ # Sort and filter array of page breaks
+ my @breaks = $self->_sort_pagebreaks(@{$self->{_vbreaks}});
+
+ my $record = 0x001a; # Record identifier
+ my $cbrk = scalar @breaks; # Number of page breaks
+ my $length = 2 + 6*$cbrk; # Bytes to follow
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $cbrk);
+
+ # Append each page break
+ foreach my $break (@breaks) {
+ $data .= pack("vvv", $break, 0x0000, 0xffff);
+ }
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_protect()
+#
+# Set the Biff PROTECT record to indicate that the worksheet is protected.
+#
+sub _store_protect {
+
+ my $self = shift;
+
+ # Exit unless sheet protection has been specified
+ return unless $self->{_protect};
+
+ my $record = 0x0012; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $fLock = $self->{_protect}; # Worksheet is protected
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $fLock);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# _store_password()
+#
+# Write the worksheet PASSWORD record.
+#
+sub _store_password {
+
+ my $self = shift;
+
+ # Exit unless sheet protection and password have been specified
+ return unless $self->{_protect} and defined $self->{_password};
+
+ my $record = 0x0013; # Record identifier
+ my $length = 0x0002; # Bytes to follow
+
+ my $wPassword = $self->{_password}; # Encoded password
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("v", $wPassword);
+
+ $self->_prepend($header, $data);
+}
+
+
+###############################################################################
+#
+# insert_bitmap($row, $col, $filename, $x, $y, $scale_x, $scale_y)
+#
+# Insert a 24bit bitmap image in a worksheet. The main record required is
+# IMDATA but it must be proceeded by a OBJ record to define its position.
+#
+sub insert_bitmap {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ my $row = $_[0];
+ my $col = $_[1];
+ my $bitmap = $_[2];
+ my $x = $_[3] || 0;
+ my $y = $_[4] || 0;
+ my $scale_x = $_[5] || 1;
+ my $scale_y = $_[6] || 1;
+
+ my ($width, $height, $size, $data) = $self-> _process_bitmap($bitmap);
+
+ # Scale the frame of the image.
+ $width *= $scale_x;
+ $height *= $scale_y;
+
+ # Calculate the vertices of the image and write the OBJ record
+ $self->_position_image($col, $row, $x, $y, $width, $height);
+
+
+ # Write the IMDATA record to store the bitmap data
+ my $record = 0x007f;
+ my $length = 8 + $size;
+ my $cf = 0x09;
+ my $env = 0x01;
+ my $lcb = $size;
+
+ my $header = pack("vvvvV", $record, $length, $cf, $env, $lcb);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _position_image()
+#
+# Calculate the vertices that define the position of the image as required by
+# the OBJ record.
+#
+# +------------+------------+
+# | A | B |
+# +-----+------------+------------+
+# | |(x1,y1) | |
+# | 1 |(A1)._______|______ |
+# | | | | |
+# | | | | |
+# +-----+----| BITMAP |-----+
+# | | | | |
+# | 2 | |______________. |
+# | | | (B2)|
+# | | | (x2,y2)|
+# +---- +------------+------------+
+#
+# Example of a bitmap that covers some of the area from cell A1 to cell B2.
+#
+# Based on the width and height of the bitmap we need to calculate 8 vars:
+# $col_start, $row_start, $col_end, $row_end, $x1, $y1, $x2, $y2.
+# The width and height of the cells are also variable and have to be taken into
+# account.
+# The values of $col_start and $row_start are passed in from the calling
+# function. The values of $col_end and $row_end are calculated by subtracting
+# the width and height of the bitmap from the width and height of the
+# underlying cells.
+# The vertices are expressed as a percentage of the underlying cell width as
+# follows (rhs values are in pixels):
+#
+# x1 = X / W *1024
+# y1 = Y / H *256
+# x2 = (X-1) / W *1024
+# y2 = (Y-1) / H *256
+#
+# Where: X is distance from the left side of the underlying cell
+# Y is distance from the top of the underlying cell
+# W is the width of the cell
+# H is the height of the cell
+#
+# Note: the SDK incorrectly states that the height should be expressed as a
+# percentage of 1024.
+#
+sub _position_image {
+
+ my $self = shift;
+
+ my $col_start; # Col containing upper left corner of object
+ my $x1; # Distance to left side of object
+
+ my $row_start; # Row containing top left corner of object
+ my $y1; # Distance to top of object
+
+ my $col_end; # Col containing lower right corner of object
+ my $x2; # Distance to right side of object
+
+ my $row_end; # Row containing bottom right corner of object
+ my $y2; # Distance to bottom of object
+
+ my $width; # Width of image frame
+ my $height; # Height of image frame
+
+ ($col_start, $row_start, $x1, $y1, $width, $height) = @_;
+
+
+ # Adjust start column for offsets that are greater than the col width
+ while ($x1 >= $self->_size_col($col_start)) {
+ $x1 -= $self->_size_col($col_start);
+ $col_start++;
+ }
+
+ # Adjust start row for offsets that are greater than the row height
+ while ($y1 >= $self->_size_row($row_start)) {
+ $y1 -= $self->_size_row($row_start);
+ $row_start++;
+ }
+
+
+ # Initialise end cell to the same as the start cell
+ $col_end = $col_start;
+ $row_end = $row_start;
+
+ $width = $width + $x1 -1;
+ $height = $height + $y1 -1;
+
+
+ # Subtract the underlying cell widths to find the end cell of the image
+ while ($width >= $self->_size_col($col_end)) {
+ $width -= $self->_size_col($col_end);
+ $col_end++;
+ }
+
+ # Subtract the underlying cell heights to find the end cell of the image
+ while ($height >= $self->_size_row($row_end)) {
+ $height -= $self->_size_row($row_end);
+ $row_end++;
+ }
+
+ # Bitmap isn't allowed to start or finish in a hidden cell, i.e. a cell
+ # with zero eight or width.
+ #
+ return if $self->_size_col($col_start) == 0;
+ return if $self->_size_col($col_end) == 0;
+ return if $self->_size_row($row_start) == 0;
+ return if $self->_size_row($row_end) == 0;
+
+ # Convert the pixel values to the percentage value expected by Excel
+ $x1 = $x1 / $self->_size_col($col_start) * 1024;
+ $y1 = $y1 / $self->_size_row($row_start) * 256;
+ $x2 = $width / $self->_size_col($col_end) * 1024;
+ $y2 = $height / $self->_size_row($row_end) * 256;
+
+ $self->_store_obj_picture( $col_start, $x1,
+ $row_start, $y1,
+ $col_end, $x2,
+ $row_end, $y2
+ );
+}
+
+
+###############################################################################
+#
+# _size_col($col)
+#
+# Convert the width of a cell from user's units to pixels. Excel rounds the
+# column width to the nearest pixel. If the width hasn't been set by the user
+# we use the default value. If the column is hidden we use a value of zero.
+#
+sub _size_col {
+
+ my $self = shift;
+ my $col = $_[0];
+
+ # Look up the cell value to see if it has been changed
+ if (exists $self->{_col_sizes}->{$col}) {
+ my $width = $self->{_col_sizes}->{$col};
+
+ # The relationship is different for user units less than 1.
+ if ($width < 1) {
+ return int($width *12);
+ }
+ else {
+ return int($width *7 ) +5;
+ }
+ }
+ else {
+ return 64;
+ }
+}
+
+
+###############################################################################
+#
+# _size_row($row)
+#
+# Convert the height of a cell from user's units to pixels. By interpolation
+# the relationship is: y = 4/3x. If the height hasn't been set by the user we
+# use the default value. If the row is hidden we use a value of zero. (Not
+# possible to hide row yet).
+#
+sub _size_row {
+
+ my $self = shift;
+ my $row = $_[0];
+
+ # Look up the cell value to see if it has been changed
+ if (exists $self->{_row_sizes}->{$row}) {
+ if ($self->{_row_sizes}->{$row} == 0) {
+ return 0;
+ }
+ else {
+ return int (4/3 * $self->{_row_sizes}->{$row});
+ }
+ }
+ else {
+ return 17;
+ }
+}
+
+
+###############################################################################
+#
+# _store_obj_picture( $col_start, $x1,
+# $row_start, $y1,
+# $col_end, $x2,
+# $row_end, $y2 )
+#
+# Store the OBJ record that precedes an IMDATA record. This could be generalise
+# to support other Excel objects.
+#
+sub _store_obj_picture {
+
+ my $self = shift;
+
+ my $record = 0x005d; # Record identifier
+ my $length = 0x003c; # Bytes to follow
+
+ my $cObj = 0x0001; # Count of objects in file (set to 1)
+ my $OT = 0x0008; # Object type. 8 = Picture
+ my $id = 0x0001; # Object ID
+ my $grbit = 0x0614; # Option flags
+
+ my $colL = $_[0]; # Col containing upper left corner of object
+ my $dxL = $_[1]; # Distance from left side of cell
+
+ my $rwT = $_[2]; # Row containing top left corner of object
+ my $dyT = $_[3]; # Distance from top of cell
+
+ my $colR = $_[4]; # Col containing lower right corner of object
+ my $dxR = $_[5]; # Distance from right of cell
+
+ my $rwB = $_[6]; # Row containing bottom right corner of object
+ my $dyB = $_[7]; # Distance from bottom of cell
+
+ my $cbMacro = 0x0000; # Length of FMLA structure
+ my $Reserved1 = 0x0000; # Reserved
+ my $Reserved2 = 0x0000; # Reserved
+
+ my $icvBack = 0x09; # Background colour
+ my $icvFore = 0x09; # Foreground colour
+ my $fls = 0x00; # Fill pattern
+ my $fAuto = 0x00; # Automatic fill
+ my $icv = 0x08; # Line colour
+ my $lns = 0xff; # Line style
+ my $lnw = 0x01; # Line weight
+ my $fAutoB = 0x00; # Automatic border
+ my $frs = 0x0000; # Frame style
+ my $cf = 0x0009; # Image format, 9 = bitmap
+ my $Reserved3 = 0x0000; # Reserved
+ my $cbPictFmla = 0x0000; # Length of FMLA structure
+ my $Reserved4 = 0x0000; # Reserved
+ my $grbit2 = 0x0001; # Option flags
+ my $Reserved5 = 0x0000; # Reserved
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("V", $cObj);
+ $data .= pack("v", $OT);
+ $data .= pack("v", $id);
+ $data .= pack("v", $grbit);
+ $data .= pack("v", $colL);
+ $data .= pack("v", $dxL);
+ $data .= pack("v", $rwT);
+ $data .= pack("v", $dyT);
+ $data .= pack("v", $colR);
+ $data .= pack("v", $dxR);
+ $data .= pack("v", $rwB);
+ $data .= pack("v", $dyB);
+ $data .= pack("v", $cbMacro);
+ $data .= pack("V", $Reserved1);
+ $data .= pack("v", $Reserved2);
+ $data .= pack("C", $icvBack);
+ $data .= pack("C", $icvFore);
+ $data .= pack("C", $fls);
+ $data .= pack("C", $fAuto);
+ $data .= pack("C", $icv);
+ $data .= pack("C", $lns);
+ $data .= pack("C", $lnw);
+ $data .= pack("C", $fAutoB);
+ $data .= pack("v", $frs);
+ $data .= pack("V", $cf);
+ $data .= pack("v", $Reserved3);
+ $data .= pack("v", $cbPictFmla);
+ $data .= pack("v", $Reserved4);
+ $data .= pack("v", $grbit2);
+ $data .= pack("V", $Reserved5);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# _process_bitmap()
+#
+# Convert a 24 bit bitmap into the modified internal format used by Windows.
+# This is described in BITMAPCOREHEADER and BITMAPCOREINFO structures in the
+# MSDN library.
+#
+sub _process_bitmap {
+
+ my $self = shift;
+ my $bitmap = shift;
+
+ # Open file and binmode the data in case the platform needs it.
+ my $fh = FileHandle->new($bitmap);
+ croak "Couldn't import $bitmap: $!" unless defined $fh;
+ binmode $fh;
+
+
+ # Slurp the file into a string.
+ my $data = do {local $/; <$fh>};
+
+ $fh->close;
+
+ # Check that the file is big enough to be a bitmap.
+ if (length $data <= 0x36) {
+ croak "$bitmap doesn't contain enough data.";
+ }
+
+
+ # The first 2 bytes are used to identify the bitmap.
+ if (unpack("A2", $data) ne "BM") {
+ croak "$bitmap doesn't appear to be a valid bitmap image.";
+ }
+
+
+ # Remove bitmap data: ID.
+ $data = substr $data, 2;
+
+
+ # Read and remove the bitmap size. This is more reliable than reading
+ # the data size at offset 0x22.
+ #
+ my $size = unpack "V", substr $data, 0, 4, "";
+ $size -= 0x36; # Subtract size of bitmap header.
+ $size += 0x0C; # Add size of BIFF header.
+
+
+ # Remove bitmap data: reserved, offset, header length.
+ $data = substr $data, 12;
+
+
+ # Read and remove the bitmap width and height. Verify the sizes.
+ my ($width, $height) = unpack "V2", substr $data, 0, 8, "";
+
+ if ($width > 0xFFFF) {
+ croak "$bitmap: largest image width supported is 65k.";
+ }
+
+ if ($height > 0xFFFF) {
+ croak "$bitmap: largest image height supported is 65k.";
+ }
+
+ # Read and remove the bitmap planes and bpp data. Verify them.
+ my ($planes, $bitcount) = unpack "v2", substr $data, 0, 4, "";
+
+ if ($bitcount != 24) {
+ croak "$bitmap isn't a 24bit true color bitmap.";
+ }
+
+ if ($planes != 1) {
+ croak "$bitmap: only 1 plane supported in bitmap image.";
+ }
+
+
+ # Read and remove the bitmap compression. Verify compression.
+ my $compression = unpack "V", substr $data, 0, 4, "";
+
+ if ($compression != 0) {
+ croak "$bitmap: compression not supported in bitmap image.";
+ }
+
+ # Remove bitmap data: data size, hres, vres, colours, imp. colours.
+ $data = substr $data, 20;
+
+ # Add the BITMAPCOREHEADER data
+ my $header = pack("Vvvvv", 0x000c, $width, $height, 0x01, 0x18);
+ $data = $header . $data;
+
+ return ($width, $height, $size, $data);
+}
+
+
+###############################################################################
+#
+# _store_zoom($zoom)
+#
+#
+# Store the window zoom factor. This should be a reduced fraction but for
+# simplicity we will store all fractions with a numerator of 100.
+#
+sub _store_zoom {
+
+ my $self = shift;
+
+ # If scale is 100 we don't need to write a record
+ return if $self->{_zoom} == 100;
+
+ my $record = 0x00A0; # Record identifier
+ my $length = 0x0004; # Bytes to follow
+
+ my $header = pack("vv", $record, $length );
+ my $data = pack("vv", $self->{_zoom}, 100);
+
+ $self->_append($header, $data);
+}
+
+
+###############################################################################
+#
+# write_unicode ($row, $col, $string, $format)
+#
+# Write a Unicode string to the specified row and column (zero indexed).
+# $format is optional.
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+# -3 : long string truncated to 255 chars
+#
+sub write_unicode {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ if (@_ < 3) { return -1 } # Check the number of args
+
+ my $record = 0x00FD; # Record identifier
+ my $length = 0x000A; # Bytes to follow
+
+ my $row = $_[0]; # Zero indexed row
+ my $col = $_[1]; # Zero indexed column
+ my $strlen = length($_[2]);
+ my $str = $_[2];
+ my $xf = _XF($self, $row, $col, $_[3]); # The cell format
+ my $encoding = 0x1;
+ my $str_error = 0;
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+ # TODO This should probably be the number of chars and not bytes. check.
+ if ($strlen > 32766) {
+ $str = substr($str, 0, 32766);
+ $str_error = -3;
+ }
+
+
+ my $num_bytes = length $str;
+ my $num_chars = int($num_bytes / 2);
+
+
+ # Check for a valid 2-byte char string.
+ croak "Uneven number of bytes in Unicode string" if $num_bytes % 2;
+
+
+ # Change from UTF16 big-endian to little endian
+ $str = pack "v*", unpack "n*", $str;
+
+
+ # Add the encoding and length header to the string.
+ my $str_header = pack("vC", $num_chars, $encoding);
+ $str = $str_header . $str;
+
+
+ if (not exists ${$self->{_str_table}}->{$str}) {
+ ${$self->{_str_table}}->{$str} = ${$self->{_str_unique}}++;
+ }
+
+
+ ${$self->{_str_total}}++;
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvV", $row, $col, $xf, ${$self->{_str_table}}->{$str});
+
+ $self->_append($header, $data);
+
+ return $str_error;
+}
+
+
+
+###############################################################################
+#
+# write_unicode_le ($row, $col, $string, $format)
+#
+# Write a Unicode string to the specified row and column (zero indexed).
+# $format is optional.
+# Returns 0 : normal termination
+# -1 : insufficient number of arguments
+# -2 : row or column out of range
+# -3 : long string truncated to 255 chars
+#
+# TODO Refactor. Too much code share with write_unicode().
+#
+sub write_unicode_le {
+
+ my $self = shift;
+
+ # Check for a cell reference in A1 notation and substitute row and column
+ if ($_[0] =~ /^\D/) {
+ @_ = $self->_substitute_cellref(@_);
+ }
+
+ if (@_ < 3) { return -1 } # Check the number of args
+
+ my $record = 0x00FD; # Record identifier
+ my $length = 0x000A; # Bytes to follow
+
+ my $row = $_[0]; # Zero indexed row
+ my $col = $_[1]; # Zero indexed column
+ my $strlen = length($_[2]);
+ my $str = $_[2];
+ my $xf = _XF($self, $row, $col, $_[3]); # The cell format
+ my $encoding = 0x1;
+ my $str_error = 0;
+
+ # Check that row and col are valid and store max and min values
+ return -2 if $self->_check_dimensions($row, $col);
+
+ # TODO This should probably be the number of chars and not bytes. check.
+ if ($strlen > 32766) {
+ $str = substr($str, 0, 32766);
+ $str_error = -3;
+ }
+
+
+ my $num_bytes = length $str;
+ my $num_chars = int($num_bytes / 2);
+
+
+ # Check for a valid 2-byte char string.
+ croak "Uneven number of bytes in Unicode string" if $num_bytes % 2;
+
+ # Add the encoding and length header to the string.
+ my $str_header = pack("vC", $num_chars, $encoding);
+ $str = $str_header . $str;
+
+
+ if (not exists ${$self->{_str_table}}->{$str}) {
+ ${$self->{_str_table}}->{$str} = ${$self->{_str_unique}}++;
+ }
+
+
+ ${$self->{_str_total}}++;
+
+
+ my $header = pack("vv", $record, $length);
+ my $data = pack("vvvV", $row, $col, $xf, ${$self->{_str_table}}->{$str});
+
+ $self->_append($header, $data);
+
+ return $str_error;
+}
+
+
+1;
+
+
+__END__
+
+
+=head1 NAME
+
+Worksheet - A writer class for Excel Worksheets.
+
+=head1 SYNOPSIS
+
+See the documentation for Spreadsheet::WriteExcel
+
+=head1 DESCRIPTION
+
+This module is used in conjunction with Spreadsheet::WriteExcel.
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
+
Modified: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel.pm
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel.pm 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/lib/Spreadsheet/WriteExcel.pm 2005-04-05 23:16:48 UTC (rev 901)
@@ -1,4088 +1,4089 @@
-package Spreadsheet::WriteExcel;
-
-###############################################################################
-#
-# WriteExcel.
-#
-# Spreadsheet::WriteExcel - Write to a cross-platform Excel binary file.
-#
-# Copyright 2000-2004, John McNamara, jmcnamara at cpan.org
-#
-# Documentation after __END__
-#
-
-use Exporter;
-
-use strict;
-use Spreadsheet::WriteExcel::Workbook;
-
-
-
-use vars qw($VERSION @ISA);
- at ISA = qw(Spreadsheet::WriteExcel::Workbook Exporter);
-
-$VERSION = '2.11'; # Pining for the pork of the porcupine
-
-
-
-###############################################################################
-#
-# new()
-#
-# Constructor. Wrapper for a Workbook object.
-# uses: Spreadsheet::WriteExcel::BIFFwriter
-# Spreadsheet::WriteExcel::Chart
-# Spreadsheet::WriteExcel::OLEwriter
-# Spreadsheet::WriteExcel::Workbook
-# Spreadsheet::WriteExcel::Worksheet
-# Spreadsheet::WriteExcel::Format
-# Spreadsheet::WriteExcel::Formula
-#
-sub new {
-
- my $class = shift;
- my $self = Spreadsheet::WriteExcel::Workbook->new(@_);
-
- # Check for file creation failures before re-blessing
- bless $self, $class if defined $self;
-
- return $self;
-}
-
-
-1;
-
-
-__END__
-
-
-
-=head1 NAME
-
-Spreadsheet::WriteExcel - Write to a cross-platform Excel binary file.
-
-=head1 VERSION
-
-This document refers to version 2.11 of Spreadsheet::WriteExcel, released September 30, 2004.
-
-
-
-
-=head1 SYNOPSIS
-
-To write a string, a formatted string, a number and a formula to the first worksheet in an Excel workbook called perl.xls:
-
- use Spreadsheet::WriteExcel;
-
- # Create a new Excel workbook
- my $workbook = Spreadsheet::WriteExcel->new("perl.xls");
-
- # Add a worksheet
- $worksheet = $workbook->add_worksheet();
-
- # Add and define a format
- $format = $workbook->add_format(); # Add a format
- $format->set_bold();
- $format->set_color('red');
- $format->set_align('center');
-
- # Write a formatted and unformatted string, row and column notation.
- $col = $row = 0;
- $worksheet->write($row, $col, "Hi Excel!", $format);
- $worksheet->write(1, $col, "Hi Excel!");
-
- # Write a number and a formula using A1 notation
- $worksheet->write('A3', 1.2345);
- $worksheet->write('A4', '=SIN(PI()/4)');
-
-
-
-
-=head1 DESCRIPTION
-
-The Spreadsheet::WriteExcel module can be used to create a cross-platform Excel binary file. Multiple worksheets can be added to a workbook and formatting can be applied to cells. Text, numbers, formulas, hyperlinks and images can be written to the cells.
-
-The Excel file produced by this module is compatible with 97, 2000, 2002 and 2003.
-
-The module will work on the majority of Windows, UNIX and Macintosh platforms. Generated files are also compatible with the Linux/UNIX spreadsheet applications Gnumeric and OpenOffice.org.
-
-This module cannot be used to write to an existing Excel file.
-
-
-
-
-=head1 QUICK START
-
-Spreadsheet::WriteExcel tries to provide an interface to as many of Excel's features as possible. As a result there is a lot of documentation to accompany the interface and it can be difficult at first glance to see what it important and what is not. So for those of you who prefer to assemble Ikea furniture first and then read the instructions, here are three easy steps:
-
-1. Create a new Excel I<workbook> (i.e. file) using C<new()>.
-
-2. Add a I<worksheet> to the new workbook using C<add_worksheet()>.
-
-3. Write to the worksheet using C<write()>.
-
-Like this:
-
- use Spreadsheet::WriteExcel; # Step 0
-
- my $workbook = Spreadsheet::WriteExcel->new("perl.xls"); # Step 1
- $worksheet = $workbook->add_worksheet(); # Step 2
- $worksheet->write('A1', "Hi Excel!"); # Step 3
-
-This will create an Excel file called C<perl.xls> with a single worksheet and the text C<"Hi Excel!"> in the relevant cell. And that's it. Okay, so there is actually a zeroth step as well, but C<use module> goes without saying. There are also more than 40 examples that come with the distribution and which you can use to get you started. See L<EXAMPLES>.
-
-Those of you who read the instructions first and assemble the furniture afterwards will know how to proceed. ;-)
-
-
-
-
-=head1 WORKBOOK METHODS
-
-The Spreadsheet::WriteExcel module provides an object oriented interface to a new Excel workbook. The following methods are available through a new workbook.
-
- new()
- close()
- set_tempdir()
- add_worksheet()
- add_format()
- set_custom_color()
- sheets()
- set_1904()
- set_codepage()
-
-If you are unfamiliar with object oriented interfaces or the way that they are implemented in Perl have a look at C<perlobj> and C<perltoot> in the main Perl documentation.
-
-
-
-
-=head2 new()
-
-A new Excel workbook is created using the C<new()> constructor which accepts either a filename or a filehandle as a parameter. The following example creates a new Excel file based on a filename:
-
- my $workbook = Spreadsheet::WriteExcel->new('filename.xls');
- my $worksheet = $workbook->add_worksheet();
- $worksheet->write(0, 0, "Hi Excel!");
-
-Here are some other examples of using C<new()> with filenames:
-
- my $workbook1 = Spreadsheet::WriteExcel->new($filename);
- my $workbook2 = Spreadsheet::WriteExcel->new("/tmp/filename.xls");
- my $workbook3 = Spreadsheet::WriteExcel->new("c:\\tmp\\filename.xls");
- my $workbook4 = Spreadsheet::WriteExcel->new('c:\tmp\filename.xls');
-
-The last two examples demonstrates how to create a file on DOS or Windows where it is necessary to either escape the directory separator C<\> or to use single quotes to ensure that it isn't interpolated. For more information see C<perlfaq5: Why can't I use "C:\temp\foo" in DOS paths?>.
-
-The C<new()> constructor returns a Spreadsheet::WriteExcel object that you can use to add worksheets and store data. It should be noted that although C<my> is not specifically required it defines the scope of the new workbook variable and, in the majority of cases, ensures that the workbook is closed properly without explicitly calling the C<close()> method.
-
-If the file cannot be created, due to file permissions or some other reason, C<new> will return C<undef>. Therefore, it is good practice to check the return value of C<new> before proceeding. As usual the Perl variable C<$!> will be set if there is a file creation error. You will also see one of the warning messages detailed in L<DIAGNOSTICS>:
-
- my $workbook = Spreadsheet::WriteExcel->new('protected.xls');
- die "Problems creating new Excel file: $!" unless defined $workbook;
-
-You can also pass a valid filehandle to the C<new()> constructor. For example in a CGI program you could do something like this:
-
- binmode(STDOUT);
- my $workbook = Spreadsheet::WriteExcel->new(\*STDOUT);
-
-The requirement for C<binmode()> is explained below.
-
-For CGI programs you can also use the special Perl filename C<'-'> which will redirect the output to STDOUT:
-
- my $workbook = Spreadsheet::WriteExcel->new('-');
-
-See also, the C<cgi.pl> program in the C<examples> directory of the distro.
-
-However, this special case will not work in C<mod_perl> programs where you will have to do something like the following:
-
- # mod_perl 1
- ...
- tie *XLS, 'Apache';
- binmode(XLS);
- my $workbook = Spreadsheet::WriteExcel->new(\*XLS);
- ...
-
- # mod_perl 2
- ...
- tie *XLS => $r; # Tie to the Apache::RequestRec object
- binmode(*XLS);
- my $workbook = Spreadsheet::WriteExcel->new(\*XLS);
- ...
-
-See also, the C<mod_perl1.pl> and C<mod_perl2.pl> programs in the C<examples> directory of the distro.
-
-Filehandles can also be useful if you want to stream an Excel file over a socket or if you want to store an Excel file in a scalar.
-
-For example here is a way to write an Excel file to a scalar with C<perl 5.8>:
-
- #!/usr/bin/perl -w
-
- use strict;
- use Spreadsheet::WriteExcel;
-
- # Requires perl 5.8 or later
- open my $fh, '>', \my $str or die "Failed to open filehandle: $!";
-
- my $workbook = Spreadsheet::WriteExcel->new($fh);
- my $worksheet = $workbook->add_worksheet();
-
- $worksheet->write(0, 0, "Hi Excel!");
-
- $workbook->close();
-
- # The Excel file in now in $str. Remember to binmode() the output
- # filehandle before printing it.
- binmode STDOUT;
- print $str;
-
-See also the C<write_to_scalar.pl> and C<filehandle.pl> programs in the C<examples> directory of the distro.
-
-B<Note about the requirement for> C<binmode()>: An Excel file is comprised of binary data. Therefore, if you are using a filehandle you should ensure that you C<binmode()> it prior to passing it to C<new()>.You should do this regardless of whether you are on a Windows platform or not. This applies especially to users of perl 5.8 on systems where utf8 is likely to be in operation such as RedHat Linux 9. If your program, either intentionally or not, writes UTF8 data to a filehandle that is passed to C<new()> it will corrupt the Excel file that is created.
-
-You don't have to worry about C<binmode()> if you are using filenames instead of filehandles. Spreadsheet::WriteExcel performs the C<binmode()> internally when it converts the filename to a filehandle. For more information about C<binmode()> see C<perlfunc> and C<perlopentut> in the main Perl documentation.
-
-
-
-
-
-=head2 close()
-
-The C<close()> method can be used to explicitly close an Excel file.
-
- $workbook->close();
-
-An explicit C<close()> is required if the file must be closed prior to performing some external action on it such as copying it, reading its size or attaching it to an email.
-
-In addition, C<close()> may be required to prevent perl's garbage collector from disposing of the Workbook, Worksheet and Format objects in the wrong order. Situations where this can occur are:
-
-=over 4
-
-=item *
-
-If C<my()> was not used to declare the scope of a workbook variable created using C<new()>.
-
-=item *
-
-If the C<new()>, C<add_worksheet()> or C<add_format()> methods are called in subroutines.
-
-=back
-
-The reason for this is that Spreadsheet::WriteExcel relies on Perl's C<DESTROY> mechanism to trigger destructor methods in a specific sequence. This may not happen in cases where the Workbook, Worksheet and Format variables are not lexically scoped or where they have different lexical scopes.
-
-In general, if you create a file with a size of 0 bytes or you fail to create a file you need to call C<close()>.
-
-The return value of C<close()> is the same as that returned by perl when it closes the file created by C<new()>. This allows you to handle error conditions in the usual way:
-
- $workbook->close() or die "Error closing file: $!";
-
-
-
-
-=head2 set_tempdir()
-
-For speed and efficiency C<Spreadsheet::WriteExcel> stores worksheet data in temporary files prior to assembling the final workbook.
-
-If Spreadsheet::WriteExcel is unable to create these temporary files it will store the required data in memory. This can be slow for large files.
-
-The problem occurs mainly with IIS on Windows although it could feasibly occur on Unix systems as well. The problem generally occurs because the default temp file directory is defined as C<C:/> or some other directory that IIS doesn't provide write access to.
-
-To check if this might be a problem on a particular system you can run a simple test program with C<-w> or C<use warnings>. This will generate a warning if the module cannot create the required temporary files:
-
- #!/usr/bin/perl -w
-
- use Spreadsheet::WriteExcel;
-
- my $workbook = Spreadsheet::WriteExcel->new("test.xls");
- my $worksheet = $workbook->add_worksheet();
-
-To avoid this problem the C<set_tempdir()> method can be used to specify a directory that is accessible for the creation of temporary files.
-
-The C<File::Temp> module is used to create the temporary files. File::Temp uses C<File::Spec> to determine an appropriate location for these files such as C</tmp> or C<c:\windows\temp>. You can find out which directory is used on your system as follows:
-
- perl -MFile::Spec -le "print File::Spec->tmpdir"
-
-Even if the default temporary file directory is accessible you may wish to specify an alternative location for security or maintenance reasons:
-
- $workbook->set_tempdir('/tmp/writeexcel');
- $workbook->set_tempdir('c:\windows\temp\writeexcel');
-
-The directory for the temporary file must exist, C<set_tempdir()> will not create a new directory.
-
-One disadvantage of using the C<set_tempdir()> method is that on some Windows systems it will limit you to approximately 800 concurrent tempfiles. This means that a single program running on one of these systems will be limited to creating a total of 800 workbook and worksheet objects. You can run multiple, non-concurrent programs to work around this if necessary.
-
-The C<set_tempdir()> method must be called before calling C<add_worksheet()>.
-
-
-
-
-
-=head2 add_worksheet($sheetname)
-
-At least one worksheet should be added to a new workbook. A worksheet is used to write data into cells:
-
- $worksheet1 = $workbook->add_worksheet(); # Sheet1
- $worksheet2 = $workbook->add_worksheet('Foglio2'); # Foglio2
- $worksheet3 = $workbook->add_worksheet('Data'); # Data
- $worksheet4 = $workbook->add_worksheet(); # Sheet4
-
-If C<$sheetname> is not specified the default Excel convention will be followed, i.e. Sheet1, Sheet2, etc.
-
-The worksheet name must be a valid Excel worksheet name, i.e. it cannot contain any of the following characters, C<: * ? / \> and it must be less than 32 characters. In addition, you cannot use the same, case insensitive, C<$sheetname> for more than one worksheet.
-
-
-
-
-=head2 add_chart_ext($chart_data, $chartname)
-
-This method is use to include externally generated charts in a Spreadsheet::WriteExcel file.
-
- my $chart = $workbook->add_chart_ext('chart01.bin', 'Chart1');
-
-This feature is new and would be best described as experimental. Read C<charts.txt> in the charts directory of the distro for a full explanation.
-
-
-
-=head2 add_format(%properties)
-
-The C<add_format()> method can be used to create new Format objects which are used to apply formatting to a cell. You can either define the properties at creation time via a hash of property values or later via method calls.
-
- $format1 = $workbook->add_format(%props); # Set properties at creation
- $format2 = $workbook->add_format(); # Set properties later
-
-See the L<CELL FORMATTING> section for more details about Format properties and how to set them.
-
-
-
-
-=head2 set_custom_color($index, $red, $green, $blue)
-
-The C<set_custom_color()> method can be used to override one of the built-in palette values with a more suitable colour.
-
-The value for C<$index> should be in the range 8..63, see L<COLOURS IN EXCEL>.
-
-The default named colours use the following indices:
-
- 8 => black
- 9 => white
- 10 => red
- 11 => lime
- 12 => blue
- 13 => yellow
- 14 => magenta
- 15 => cyan
- 16 => brown
- 17 => green
- 18 => navy
- 20 => purple
- 22 => silver
- 23 => gray
- 53 => orange
-
-A new colour is set using its RGB (red green blue) components. The C<$red>, C<$green> and C<$blue> values must be in the range 0..255. You can determine the required values in Excel using the C<Tools-E<gt>Options-E<gt>Colors-E<gt>Modify> dialog.
-
-The C<set_custom_color()> workbook method can also be used with a HTML style C<#rrggbb> hex value:
-
- $workbook->set_custom_color(40, 255, 102, 0 ); # Orange
- $workbook->set_custom_color(40, 0xFF, 0x66, 0x00); # Same thing
- $workbook->set_custom_color(40, '#FF6600' ); # Same thing
-
- my $font = $workbook->add_format(color => 40); # Use the modified colour
-
-The return value from C<set_custom_color()> is the index of the colour that was changed:
-
- my $ferrari = $workbook->set_custom_color(40, 216, 12, 12);
-
- my $format = $workbook->add_format(
- bg_color => $ferrari,
- pattern => 1,
- border => 1
- );
-
-
-
-
-=head2 sheets(0, 1, ...)
-
-The C<sheets()> method returns a list, or a sliced list, of the worksheets in a workbook.
-
-If no arguments are passed the method returns a list of all the worksheets in the workbook. This is useful if you want to repeat an operation on each worksheet:
-
- foreach $worksheet ($workbook->sheets()) {
- print $worksheet->get_name();
- }
-
-
-You can also specify a slice list to return one or more worksheet objects:
-
- $worksheet = $workbook->sheets(0);
- $worksheet->write('A1', "Hello");
-
-
-Or since return value from C<sheets()> is a reference to a worksheet object you can write the above example as:
-
- $workbook->sheets(0)->write('A1', "Hello");
-
-
-The following example returns the first and last worksheet in a workbook:
-
- foreach $worksheet ($workbook->sheets(0, -1)) {
- # Do something
- }
-
-
-Array slices are explained in the perldata manpage.
-
-
-
-
-=head2 set_1904()
-
-Excel stores dates as real numbers where the integer part stores the number of days since the epoch and the fractional part stores the percentage of the day. The epoch can be either 1900 or 1904. Excel for Windows uses 1900 and Excel for Macintosh uses 1904. However, Excel on either platform will convert automatically between one system and the other.
-
-Spreadsheet::WriteExcel stores dates in the 1900 format by default. If you wish to change this you can call the C<set_1904()> workbook method. You can query the current value by calling the C<get_1904()> workbook method. This returns 0 for 1900 and 1 for 1904.
-
-See also L<DATES IN EXCEL> for more information about working with Excel's date system.
-
-In general you probably won't need to use C<set_1904()>.
-
-
-
-
-=head2 set_codepage($codepage)
-
-The default code page or character set used by Spreadsheet::WriteExcel is ANSI. This is also the default used by Excel for Windows. Occasionally however it may be necessary to change the code page via the C<set_codepage()> method.
-
-Changing the code page may be required if your are using Spreadsheet::WriteExcel on the Macintosh and you are using characters outside the ASCII 128 character set:
-
- $workbook->set_codepage(1); # ANSI, MS Windows
- $workbook->set_codepage(2); # Apple Macintosh
-
-The C<set_codepage()> method is rarely required.
-
-
-
-
-=head1 WORKSHEET METHODS
-
-A new worksheet is created by calling the C<add_worksheet()> method from a workbook object:
-
- $worksheet1 = $workbook->add_worksheet();
- $worksheet2 = $workbook->add_worksheet();
-
-The following methods are available through a new worksheet:
-
- write()
- write_number()
- write_string()
- write_unicode()
- write_unicode_le()
- keep_leading_zeros()
- write_blank()
- write_row()
- write_col()
- write_url()
- write_url_range()
- write_formula()
- store_formula()
- repeat_formula()
- add_write_handler()
- insert_bitmap()
- get_name()
- activate()
- select()
- set_first_sheet()
- protect()
- set_selection()
- set_row()
- set_column()
- outline_settings()
- freeze_panes()
- thaw_panes()
- merge_range()
- set_zoom()
-
-
-=head2 Cell notation
-
-Spreadsheet::WriteExcel supports two forms of notation to designate the position of cells: Row-column notation and A1 notation.
-
-Row-column notation uses a zero based index for both row and column while A1 notation uses the standard Excel alphanumeric sequence of column letter and 1-based row. For example:
-
- (0, 0) # The top left cell in row-column notation.
- ('A1') # The top left cell in A1 notation.
-
- (1999, 29) # Row-column notation.
- ('AD2000') # The same cell in A1 notation.
-
-Row-column notation is useful if you are referring to cells programmatically:
-
- for my $i (0 .. 9) {
- $worksheet->write($i, 0, 'Hello'); # Cells A1 to A10
- }
-
-A1 notation is useful for setting up a worksheet manually and for working with formulas:
-
- $worksheet->write('H1', 200);
- $worksheet->write('H2', '=H1+1');
-
-In formulas and applicable methods you can also use the C<A:A> column notation:
-
- $worksheet->write('A1', '=SUM(B:B)');
-
-The C<Spreadsheet::WriteExcel::Utility> module that is included in the distro contains helper functions for dealing with A1 notation, for example:
-
- use Spreadsheet::WriteExcel::Utility;
-
- ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
- $str = xl_rowcol_to_cell(1, 2); # C2
-
-For simplicity, the parameter lists for the worksheet method calls in the following sections are given in terms of row-column notation. In all cases it is also possible to use A1 notation.
-
-Note: in Excel it is also possible to use a R1C1 notation. This is not supported by Spreadsheet::WriteExcel.
-
-
-
-
-=head2 write($row, $column, $token, $format)
-
-Excel makes a distinction between data types such as strings, numbers, blanks, formulas and hyperlinks. To simplify the process of writing data the C<write()> method acts as a general alias for several more specific methods:
-
- write_string()
- write_number()
- write_blank()
- write_formula()
- write_url()
- write_row()
- write_col()
-
-The general rule is that if the data looks like a I<something> then a I<something> is written. Here are some examples in both row-column and A1 notation:
-
- # Same as:
- $worksheet->write(0, 0, "Hello" ); # write_string()
- $worksheet->write(1, 0, 'One' ); # write_string()
- $worksheet->write(2, 0, 2 ); # write_number()
- $worksheet->write(3, 0, 3.00001 ); # write_number()
- $worksheet->write(4, 0, "" ); # write_blank()
- $worksheet->write(5, 0, '' ); # write_blank()
- $worksheet->write(6, 0, undef ); # write_blank()
- $worksheet->write(7, 0 ); # write_blank()
- $worksheet->write(8, 0, 'http://www.perl.com/'); # write_url()
- $worksheet->write('A9', 'ftp://ftp.cpan.org/' ); # write_url()
- $worksheet->write('A10', 'internal:Sheet1!A1' ); # write_url()
- $worksheet->write('A11', 'external:c:\foo.xls' ); # write_url()
- $worksheet->write('A12', '=A3 + 3*A4' ); # write_formula()
- $worksheet->write('A13', '=SIN(PI()/4)' ); # write_formula()
- $worksheet->write('A14', \@array ); # write_row()
- $worksheet->write('A15', [\@array] ); # write_col()
-
- # And if the keep_leading_zeros property is set:
- $worksheet->write('A16, 2 ); # write_number()
- $worksheet->write('A17, 02 ); # write_string()
- $worksheet->write('A18, 00002 ); # write_string()
-
-
-The "looks like" rule is defined by regular expressions:
-
-C<write_number()> if C<$token> is a number based on the following regex: C<$token =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/>.
-
-C<write_string()> if C<keep_leading_zeros()> is set and C<$token> is an integer with leading zeros based on the following regex: C<$token =~ /^0\d+$/>.
-
-C<write_blank()> if C<$token> is undef or a blank string: C<undef>, C<""> or C<''>.
-
-C<write_url()> if C<$token> is a http, https, ftp or mailto URL based on the following regexes: C<$token =~ m|^[fh]tt?ps?://|> or C<$token =~ m|^mailto:|>.
-
-C<write_url()> if C<$token> is an internal or external sheet reference based on the following regex: C<$token =~ m[^(in|ex)ternal:]>.
-
-C<write_formula()> if the first character of C<$token> is C<"=">.
-
-C<write_row()> if C<$token> is an array ref.
-
-C<write_col()> if C<$token> is an array ref of array refs.
-
-C<write_string()> if none of the previous conditions apply.
-
-The C<$format> parameter is optional. It should be a valid Format object, see L<CELL FORMATTING>:
-
- my $format = $workbook->add_format();
- $format->set_bold();
- $format->set_color('red');
- $format->set_align('center');
-
- $worksheet->write(4, 0, "Hello", $format ); # Formatted string
-
-The write() method will ignore empty strings or C<undef> tokens unless a format is also supplied. As such you needn't worry about special handling for empty or C<undef> values in your data. See also the C<write_blank()> method.
-
-One problem with the C<write()> method is that occasionally data looks like a number but you don't want it treated as a number. For example, zip codes or ID numbers often start with a leading zero. If you write this data as a number then the leading zero(s) will be stripped. You can change this default behaviour by using the C<keep_leading_zeros()> method. While this property is in place any integers with leading zeros will be treated as strings and the zeros will be preserved. See the C<keep_leading_zeros()> section for a full discussion of this issue.
-
-You can also add your own data handlers to the C<write()> method using C<add_write_handler()>.
-
-On systems with C<perl 5.8> and later the C<write()> method will also handle strings in Perl's C<utf8> format.
-
-The C<write> methods return:
-
- 0 for success.
- -1 for insufficient number of arguments.
- -2 for row or column out of bounds.
- -3 for string too long.
-
-
-
-
-=head2 write_number($row, $column, $number, $format)
-
-Write an integer or a float to the cell specified by C<$row> and C<$column>:
-
- $worksheet->write_number(0, 0, 123456);
- $worksheet->write_number('A2', 2.3451);
-
-See the note about L<Cell notation>. The C<$format> parameter is optional.
-
-In general it is sufficient to use the C<write()> method.
-
-
-
-
-=head2 write_string($row, $column, $string, $format)
-
-Write a string to the cell specified by C<$row> and C<$column>:
-
- $worksheet->write_string(0, 0, "Your text here" );
- $worksheet->write_string('A2', "or here" );
-
-The maximum string size is 32767 characters. However the maximum string segment that Excel can display in a cell is 1000. All 32767 characters can be displayed in the formula bar.
-
-The C<$format> parameter is optional.
-
-On systems with C<perl 5.8> and later the C<write()> method will also handle strings in Perl's C<utf8> format. With older perls you can also write Unicode in C<UTF16> format via the C<write_unicode()> method. See also the C<unicode_*.pl> programs in the examples directory of the distro.
-
-In general it is sufficient to use the C<write()> method. However, you may sometimes wish to use the C<write_string()> method to write data that looks like a number but that you don't want treated as a number. For example, zip codes or phone numbers:
-
- # Write as a plain string
- $worksheet->write_string('A1', '01209');
-
-However, if the user edits this string Excel may convert it back to a number. To get around this you can use the Excel text format C<@>:
-
- # Format as a string. Doesn't change to a number when edited
- my $format1 = $workbook->add_format(num_format => '@');
- $worksheet->write_string('A2', '01209', $format1);
-
-See also the note about L<Cell notation>.
-
-
-
-
-=head2 write_unicode($row, $column, $string, $format)
-
-This method is used to write Unicode strings to a cell in Excel. It is functionally the same as the C<write_string()> method except that the string should be in UTF-16 Unicode format.
-
-B<Note>: on systems with C<perl 5.8> and later the C<write()> and C<write_string()>methods will also handle strings in Perl's C<utf8> format. With older perls you must use the C<write_unicode()> method.
-
-The Unicode format required by Excel is UTF-16. Additionally C<Spreadsheet::WriteExcel> requires that the 16-bit characters are in big-endian order. This is generally referred to as UTF-16BE. To write UTF-16 strings in little-endian format use the C<write_unicode_le()> method.
-
-
-The following is a simple example showing how to write some Unicode strings:
-
- #!/usr/bin/perl -w
-
-
- use strict;
- use Spreadsheet::WriteExcel;
- use Unicode::Map();
-
- my $workbook = Spreadsheet::WriteExcel->new('unicode.xls');
- my $worksheet = $workbook->add_worksheet();
-
- # Increase the column width for clarity
- $worksheet->set_column('A:A', 25);
-
-
- # Write a Unicode character
- #
- my $smiley = pack "n", 0x263a;
-
- # Increase the font size for legibility.
- my $big_font = $workbook->add_format(size => 72);
-
- $worksheet->write_unicode('A3', $smiley, $big_font);
-
-
-
- # Write a phrase in Cyrillic using a hex-encoded string
- #
- my $uni_str = pack "H*", "042d0442043e0020044404400430043704300020043d" .
- "043000200440044304410441043a043e043c0021";
-
- $worksheet->write_unicode('A5', $uni_str);
-
-
-
- # Map a string to UTF-16BE using an external module.
- #
- my $map = Unicode::Map->new("ISO-8859-1");
- my $utf16 = $map->to_unicode("Hello world!");
-
- $worksheet->write_unicode('A7', $utf16);
-
-
-The following is an example of creating an Excel file with some Japanese text. You will need to have a Unicode font installed, such as C<Arial Unicode MS>, to view the results:
-
-
- #!/usr/bin/perl -w
-
-
- use strict;
- use Spreadsheet::WriteExcel;
-
-
- my $workbook = Spreadsheet::WriteExcel->new('unicode.xls');
- my $worksheet = $workbook->add_worksheet();
-
-
- # It is only required to specify a Unicode font via add_format() if
- # you are using Excel 97. For Excel 2000+ the text will display
- # with the default font (if you have Unicode fonts installed).
- #
- my $uni_font = $workbook->add_format(font => 'Arial Unicode MS');
-
-
- my $kanji = pack 'n*', 0x65e5, 0x672c;
- my $katakana = pack 'n*', 0xff86, 0xff8e, 0xff9d;
- my $hiragana = pack 'n*', 0x306b, 0x307b, 0x3093;
-
-
- $worksheet->write_unicode('A1', $kanji, $uni_font);
- $worksheet->write_unicode('A2', $katakana, $uni_font);
- $worksheet->write_unicode('A3', $hiragana, $uni_font);
-
-
- $worksheet->write('B1', 'Kanji');
- $worksheet->write('B2', 'Katakana');
- $worksheet->write('B3', 'Hiragana');
-
-
-Note: You can convert ascii encodings to the required UTF-16BE format using one of the many Unicode modules on CPAN. For example C<Unicode::Map> and C<Unicode::String>: http://search.cpan.org/author/MSCHWARTZ/Unicode-Map-0.112/Map.pm and http://search.cpan.org/author/GAAS/Unicode-String-2.06/String.pm
-
-For a full list of the Perl Unicode modules see: http://search.cpan.org/search?query=unicode&mode=all
-
-See also the C<unicode_*.pl> programs in the examples directory of the distro.
-
-
-
-=head2 write_unicode_le($row, $column, $string, $format)
-
-This method is the same as C<write_unicode()> except that the string should be 16-bit characters in little-endian format. This is generally referred to as UTF-16LE.
-
-UTF-16 data can be changed from little-endian to big-endian format (and vice-versa) as follows:
-
- $utf16 = pack "n*", unpack "v*", $utf16;
-
-Note, it is slightly faster to write little-endian data via write_unicode_le() than it is to write big-endian data via write_unicode().
-
-
-
-
-=head2 keep_leading_zeros()
-
-This method changes the default handling of integers with leading zeros when using the C<write()> method.
-
-The C<write()> method uses regular expressions to determine what type of data to write to an Excel worksheet. If the data looks like a number it writes a number using C<write_number()>. One problem with this approach is that occasionally data looks like a number but you don't want it treated as a number.
-
-Zip codes and ID numbers, for example, often start with a leading zero. If you write this data as a number then the leading zero(s) will be stripped. This is the also the default behaviour when you enter data manually in Excel.
-
-To get around this you can use one of three options. Write a formatted number, write the number as a string or use the C<keep_leading_zeros()> method to change the default behaviour of C<write()>:
-
- # Implicitly write a number, the leading zero is removed: 1209
- $worksheet->write('A1', '01209');
-
- # Write a zero padded number using a format: 01209
- my $format1 = $workbook->add_format(num_format => '00000');
- $worksheet->write('A2', '01209', $format1);
-
- # Write explicitly as a string: 01209
- $worksheet->write_string('A3', '01209');
-
- # Write implicitly as a string: 01209
- $worksheet->keep_leading_zeros();
- $worksheet->write('A4', '01209');
-
-
-The above code would generate a worksheet that looked like the following:
-
- -----------------------------------------------------------
- | | A | B | C | D | ...
- -----------------------------------------------------------
- | 1 | 1209 | | | | ...
- | 2 | 01209 | | | | ...
- | 3 | 01209 | | | | ...
- | 4 | 01209 | | | | ...
-
-
-The examples are on different sides of the cells due to the fact that Excel displays strings with a left justification and numbers with a right justification by default. You can change this by using a format to justify the data, see L<CELL FORMATTING>.
-
-It should be noted that if the user edits the data in examples C<A3> and C<A4> the strings will revert back to numbers. Again this is Excel's default behaviour. To avoid this you can use the text format C<@>:
-
- # Format as a string (01209)
- my $format2 = $workbook->add_format(num_format => '@');
- $worksheet->write_string('A5', '01209', $format2);
-
-The C<keep_leading_zeros()> property is off by default. The C<keep_leading_zeros()> method takes 0 or 1 as an argument. It defaults to 1 if an argument isn't specified:
-
- $worksheet->keep_leading_zeros(); # Set on
- $worksheet->keep_leading_zeros(1); # Set on
- $worksheet->keep_leading_zeros(0); # Set off
-
-See also the C<add_write_handler()> method.
-
-
-=head2 write_blank($row, $column, $format)
-
-Write a blank cell specified by C<$row> and C<$column>:
-
- $worksheet->write_blank(0, 0, $format);
-
-This method is used to add formatting to a cell which doesn't contain a string or number value.
-
-Excel differentiates between an "Empty" cell and a "Blank" cell. An "Empty" cell is a cell which doesn't contain data whilst a "Blank" cell is a cell which doesn't contain data but does contain formatting. Excel stores "Blank" cells but ignores "Empty" cells.
-
-As such, if you write an empty cell without formatting it is ignored:
-
- $worksheet->write('A1', undef, $format); # write_blank()
- $worksheet->write('A2', undef ); # Ignored
-
-This seemingly uninteresting fact means that you can write arrays of data without special treatment for undef or empty string values.
-
-See the note about L<Cell notation>.
-
-
-
-
-=head2 write_row($row, $column, $array_ref, $format)
-
-The C<write_row()> method can be used to write a 1D or 2D array of data in one go. This is useful for converting the results of a database query into an Excel worksheet. You must pass a reference to the array of data rather than the array itself. The C<write()> method is then called for each element of the data. For example:
-
- @array = ('awk', 'gawk', 'mawk');
- $array_ref = \@array;
-
- $worksheet->write_row(0, 0, $array_ref);
-
- # The above example is equivalent to:
- $worksheet->write(0, 0, $array[0]);
- $worksheet->write(0, 1, $array[1]);
- $worksheet->write(0, 2, $array[2]);
-
-
-Note: For convenience the C<write()> method behaves in the same way as C<write_row()> if it is passed an array reference. Therefore the following two method calls are equivalent:
-
- $worksheet->write_row('A1', $array_ref); # Write a row of data
- $worksheet->write( 'A1', $array_ref); # Same thing
-
-As with all of the write methods the C<$format> parameter is optional. If a format is specified it is applied to all the elements of the data array.
-
-Array references within the data will be treated as columns. This allows you to write 2D arrays of data in one go. For example:
-
- @eec = (
- ['maggie', 'milly', 'molly', 'may' ],
- [13, 14, 15, 16 ],
- ['shell', 'star', 'crab', 'stone']
- );
-
- $worksheet->write_row('A1', \@eec);
-
-
-Would produce a worksheet as follows:
-
- -----------------------------------------------------------
- | | A | B | C | D | E | ...
- -----------------------------------------------------------
- | 1 | maggie | 13 | shell | ... | ... | ...
- | 2 | milly | 14 | star | ... | ... | ...
- | 3 | molly | 15 | crab | ... | ... | ...
- | 4 | may | 16 | stone | ... | ... | ...
- | 5 | ... | ... | ... | ... | ... | ...
- | 6 | ... | ... | ... | ... | ... | ...
-
-
-To write the data in a row-column order refer to the C<write_col()> method below.
-
-Any C<undef> values in the data will be ignored unless a format is applied to the data, in which case a formatted blank cell will be written. In either case the appropriate row or column value will still be incremented.
-
-To find out more about array references refer to C<perlref> and C<perlreftut> in the main Perl documentation. To find out more about 2D arrays or "lists of lists" refer to C<perllol>.
-
-The C<write_row()> method returns the first error encountered when writing the elements of the data or zero if no errors were encountered. See the return values described for the C<write()> method above.
-
-See also the C<write_arrays.pl> program in the C<examples> directory of the distro.
-
-The C<write_row()> method allows the following idiomatic conversion of a text file to an Excel file:
-
- #!/usr/bin/perl -w
-
- use strict;
- use Spreadsheet::WriteExcel;
-
- my $workbook = Spreadsheet::WriteExcel->new('file.xls');
- my $worksheet = $workbook->add_worksheet();
-
- open INPUT, "file.txt" or die "Couldn't open file: $!";
-
- $worksheet->write($.-1, 0, [split]) while <INPUT>;
-
-
-
-
-=head2 write_col($row, $column, $array_ref, $format)
-
-The C<write_col()> method can be used to write a 1D or 2D array of data in one go. This is useful for converting the results of a database query into an Excel worksheet. You must pass a reference to the array of data rather than the array itself. The C<write()> method is then called for each element of the data. For example:
-
- @array = ('awk', 'gawk', 'mawk');
- $array_ref = \@array;
-
- $worksheet->write_col(0, 0, $array_ref);
-
- # The above example is equivalent to:
- $worksheet->write(0, 0, $array[0]);
- $worksheet->write(1, 0, $array[1]);
- $worksheet->write(2, 0, $array[2]);
-
-As with all of the write methods the C<$format> parameter is optional. If a format is specified it is applied to all the elements of the data array.
-
-Array references within the data will be treated as rows. This allows you to write 2D arrays of data in one go. For example:
-
- @eec = (
- ['maggie', 'milly', 'molly', 'may' ],
- [13, 14, 15, 16 ],
- ['shell', 'star', 'crab', 'stone']
- );
-
- $worksheet->write_col('A1', \@eec);
-
-
-Would produce a worksheet as follows:
-
- -----------------------------------------------------------
- | | A | B | C | D | E | ...
- -----------------------------------------------------------
- | 1 | maggie | milly | molly | may | ... | ...
- | 2 | 13 | 14 | 15 | 16 | ... | ...
- | 3 | shell | star | crab | stone | ... | ...
- | 4 | ... | ... | ... | ... | ... | ...
- | 5 | ... | ... | ... | ... | ... | ...
- | 6 | ... | ... | ... | ... | ... | ...
-
-
-To write the data in a column-row order refer to the C<write_row()> method above.
-
-Any C<undef> values in the data will be ignored unless a format is applied to the data, in which case a formatted blank cell will be written. In either case the appropriate row or column value will still be incremented.
-
-As noted above the C<write()> method can be used as a synonym for C<write_row()> and C<write_row()> handles nested array refs as columns. Therefore, the following two method calls are equivalent although the more explicit call to C<write_col()> would be preferable for maintainability:
-
- $worksheet->write_col('A1', $array_ref ); # Write a column of data
- $worksheet->write( 'A1', [ $array_ref ]); # Same thing
-
-To find out more about array references refer to C<perlref> and C<perlreftut> in the main Perl documentation. To find out more about 2D arrays or "lists of lists" refer to C<perllol>.
-
-The C<write_col()> method returns the first error encountered when writing the elements of the data or zero if no errors were encountered. See the return values described for the C<write()> method above.
-
-See also the C<write_arrays.pl> program in the C<examples> directory of the distro.
-
-
-
-
-=head2 write_url($row, $col, $url, $string, $format)
-
-Write a hyperlink to a URL in the cell specified by C<$row> and C<$column>. The hyperlink is comprised of two elements: the visible label and the invisible link. The visible label is the same as the link unless an alternative string is specified. The parameters C<$string> and the C<$format> are optional and their position is interchangeable.
-
-The label is written using the C<write_string()> method. Therefore the 255 characters string limit applies to the label: the URL can be any length.
-
-There are four web style URI's supported: C<http://>, C<https://>, C<ftp://> and C<mailto:>:
-
- $worksheet->write_url(0, 0, 'ftp://www.perl.org/' );
- $worksheet->write_url(1, 0, 'http://www.perl.com/', 'Perl home' );
- $worksheet->write_url('A3', 'http://www.perl.com/', $format );
- $worksheet->write_url('A4', 'http://www.perl.com/', 'Perl', $format);
- $worksheet->write_url('A5', 'mailto:jmcnamara at cpan.org' );
-
-There are two local URIs supported: C<internal:> and C<external:>. These are used for hyperlinks to internal worksheet references or external workbook and worksheet references:
-
- $worksheet->write_url('A6', 'internal:Sheet2!A1' );
- $worksheet->write_url('A7', 'internal:Sheet2!A1', $format );
- $worksheet->write_url('A8', 'internal:Sheet2!A1:B2' );
- $worksheet->write_url('A9', q{internal:'Sales Data'!A1} );
- $worksheet->write_url('A10', 'external:c:\temp\foo.xls' );
- $worksheet->write_url('A11', 'external:c:\temp\foo.xls#Sheet2!A1' );
- $worksheet->write_url('A12', 'external:..\..\..\foo.xls' );
- $worksheet->write_url('A13', 'external:..\..\..\foo.xls#Sheet2!A1' );
- $worksheet->write_url('A13', 'external:\\\\NETWORK\share\foo.xls' );
-
-All of the these URI types are recognised by the C<write()> method, see above.
-
-Worksheet references are typically of the form C<Sheet1!A1>. You can also refer to a worksheet range using the standard Excel notation: C<Sheet1!A1:B2>.
-
-In external links the workbook and worksheet name must be separated by the C<#> character: C<external:Workbook.xls#Sheet1!A1'>.
-
-You can also link to a named range in the target worksheet. For example say you have a named range called C<my_name> in the workbook C<c:\temp\foo.xls> you could link to it as follows:
-
- $worksheet->write_url('A14', 'external:c:\temp\foo.xls#my_name');
-
-Note, you cannot currently create named ranges with C<Spreadsheet::WriteExcel>.
-
-Excel requires that worksheet names containing spaces or non alphanumeric characters are single quoted as follows C<'Sales Data'!A1>. If you need to do this in a single quoted string then you can either escape the single quotes C<\'> or use the quote operator C<q{}> as described in C<perlop> in the main Perl documentation.
-
-Links to network files are also supported. MS/Novell Network files normally begin with two back slashes as follows C<\\NETWORK\etc>. In order to generate this in a single or double quoted string you will have to escape the backslashes, C<'\\\\NETWORK\etc'>.
-
-If you are using double quote strings then you should be careful to escape anything that looks like a metacharacter. For more information see C<perlfaq5: Why can't I use "C:\temp\foo" in DOS paths?>.
-
-Finally, you can avoid most of these quoting problems by using forward slashes. These are translated internally to backslashes:
-
- $worksheet->write_url('A14', "external:c:/temp/foo.xls" );
- $worksheet->write_url('A15', 'external://NETWORK/share/foo.xls' );
-
-See also, the note about L<Cell notation>.
-
-
-
-
-=head2 write_url_range($row1, $col1, $row2, $col2, $url, $string, $format)
-
-This method is essentially the same as the C<write_url()> method described above. The main difference is that you can specify a link for a range of cells:
-
- $worksheet->write_url(0, 0, 0, 3, 'ftp://www.perl.org/' );
- $worksheet->write_url(1, 0, 0, 3, 'http://www.perl.com/', 'Perl home');
- $worksheet->write_url('A3:D3', 'internal:Sheet2!A1' );
- $worksheet->write_url('A4:D4', 'external:c:\temp\foo.xls' );
-
-
-This method is generally only required when used in conjunction with merged cells. See the C<merge_range()> method and the C<merge> property of a Format object, L<CELL FORMATTING>.
-
-There is no way to force this behaviour through the C<write()> method.
-
-The parameters C<$string> and the C<$format> are optional and their position is interchangeable. However, they are applied only to the first cell in the range.
-
-See also, the note about L<Cell notation>.
-
-
-
-
-=head2 write_formula($row, $column, $formula, $format)
-
-Write a formula or function to the cell specified by C<$row> and C<$column>:
-
- $worksheet->write_formula(0, 0, '=$B$3 + B4' );
- $worksheet->write_formula(1, 0, '=SIN(PI()/4)');
- $worksheet->write_formula(2, 0, '=SUM(B1:B5)' );
- $worksheet->write_formula('A4', '=IF(A3>1,"Yes", "No")' );
- $worksheet->write_formula('A5', '=AVERAGE(1, 2, 3, 4)' );
- $worksheet->write_formula('A6', '=DATEVALUE("1-Jan-2001")');
-
-See the note about L<Cell notation>. For more information about writing Excel formulas see L<FORMULAS AND FUNCTIONS IN EXCEL>
-
-See also the section "Improving performance when working with formulas" and the C<store_formula()> and C<repeat_formula()> methods.
-
-
-
-
-=head2 store_formula($formula)
-
-The C<store_formula()> method is used in conjunction with C<repeat_formula()> to speed up the generation of repeated formulas. See "Improving performance when working with formulas" in L<FORMULAS AND FUNCTIONS IN EXCEL>.
-
-The C<store_formula()> method pre-parses a textual representation of a formula and stores it for use at a later stage by the C<repeat_formula()> method.
-
-C<store_formula()> carries the same speed penalty as C<write_formula()>. However, in practice it will be used less frequently.
-
-The return value of this method is a scalar that can be thought of as a reference to a formula.
-
- my $sin = $worksheet->store_formula('=SIN(A1)');
- my $cos = $worksheet->store_formula('=COS(A1)');
-
- $worksheet->repeat_formula('B1', $sin, $format, 'A1', 'A2');
- $worksheet->repeat_formula('C1', $cos, $format, 'A1', 'A2');
-
-Although C<store_formula()> is a worksheet method the return value can be used in any worksheet:
-
- my $now = $worksheet->store_formula('=NOW()');
-
- $worksheet1->repeat_formula('B1', $now);
- $worksheet2->repeat_formula('B1', $now);
- $worksheet3->repeat_formula('B1', $now);
-
-
-
-=head2 repeat_formula($row, $col, $formula, $format, ($pattern => $replace, ...))
-
-
-The C<repeat_formula()> method is used in conjunction with C<store_formula()> to speed up the generation of repeated formulas. See "Improving performance when working with formulas" in L<FORMULAS AND FUNCTIONS IN EXCEL>.
-
-In many respects C<repeat_formula()> behaves like C<write_formula()> except that it is significantly faster.
-
-The C<repeat_formula()> method creates a new formula based on the pre-parsed tokens returned by C<store_formula()>. The new formula is generated by substituting C<$pattern>, C<$replace> pairs in the stored formula:
-
- my $formula = $worksheet->store_formula('=A1 * 3 + 50');
-
- for my $row (0..99) {
- $worksheet->repeat_formula($row, 1, $formula, $format, 'A1', 'A'.($row +1));
- }
-
-It should be noted that C<repeat_formula()> doesn't modify the tokens. In the above example the substitution is always made against the original token, C<A1>, which doesn't change.
-
-As usual, you can use C<undef> if you don't wish to specify a C<$format>:
-
- $worksheet->repeat_formula('B2', $formula, $format, 'A1', 'A2');
- $worksheet->repeat_formula('B3', $formula, undef, 'A1', 'A3');
-
-The substitutions are made from left to right and you can use as many C<$pattern>, C<$replace> pairs as you need. However, each substitution is made only once:
-
- my $formula = $worksheet->store_formula('=A1 + A1');
-
- # Gives '=B1 + A1'
- $worksheet->repeat_formula('B1', $formula, undef, 'A1', 'B1');
-
- # Gives '=B1 + B1'
- $worksheet->repeat_formula('B2', $formula, undef, ('A1', 'B1') x 2);
-
-Since the C<$pattern> is interpolated each time that it is used it is worth using the C<qr> operator to quote the pattern. The C<qr> operator is explained in the C<perlop> man page.
-
- $worksheet->repeat_formula('B1', $formula, $format, qr/A1/, 'A2');
-
-Care should be taken with the values that are substituted. The formula returned by C<repeat_formula()> contains several other tokens in addition to those in the formula and these might also match the pattern that you are trying to replace. In particular you should avoid substituting a single 0, 1, 2 or 3.
-
-You should also be careful to avoid false matches. For example the following snippet is meant to change the stored formula in steps from C<=A1 + SIN(A1)> to C<=A10 + SIN(A10)>.
-
- my $formula = $worksheet->store_formula('=A1 + SIN(A1)');
-
- for my $row (1 .. 10) {
- $worksheet->repeat_formula($row -1, 1, $formula, undef,
- qw/A1/, 'A' . $row, #! Bad.
- qw/A1/, 'A' . $row #! Bad.
- );
- }
-
-However it contains a bug. In the last iteration of the loop when C<$row> is 10 the following substitutions will occur:
-
- s/A1/A10/; changes =A1 + SIN(A1) to =A10 + SIN(A1)
- s/A1/A10/; changes =A10 + SIN(A1) to =A100 + SIN(A1) # !!
-
-The solution in this case is to use a more explicit match such as C<qw/^A1$/>:
-
- $worksheet->repeat_formula($row -1, 1, $formula, undef,
- qw/^A1$/, 'A' . $row,
- qw/^A1$/, 'A' . $row
- );
-
-Another similar problem occurs due to the fact that substitutions are made in order. For example the following snippet is meant to change the stored formula from C<=A10 + A11> to C<=A11 + A12>:
-
- my $formula = $worksheet->store_formula('=A10 + A11');
-
- $worksheet->repeat_formula('A1', $formula, undef,
- qw/A10/, 'A11', #! Bad.
- qw/A11/, 'A12' #! Bad.
- );
-
-However, the actual substitution yields C<=A12 + A11>:
-
- s/A10/A11/; changes =A10 + A11 to =A11 + A11
- s/A11/A12/; changes =A11 + A11 to =A12 + A11 # !!
-
-The solution here would be to reverse the order of the substitutions or to start with a stored formula that won't yield a false match such as C<=X10 + Y11>:
-
- my $formula = $worksheet->store_formula('=X10 + Y11');
-
- $worksheet->repeat_formula('A1', $formula, undef,
- qw/X10/, 'A11',
- qw/Y11/, 'A12'
- );
-
-
-If you think that you have a problem related to a false match you can check the tokens that you are substituting against as follows.
-
- my $formula = $worksheet->store_formula('=A1*5+4');
- print "@$formula\n";
-
-See also the C<repeat.pl> program in the C<examples> directory of the distro.
-
-
-
-
-=head2 write_date_time($row, $col, $date_string, $format)
-
-The C<write_date_time()> method can be used to write a date or time to the cell specified by C<$row> and C<$column>:
-
- $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
-
-The C<$date_string> should be in the following format:
-
- yyyy-mm-ddThh:mm:ss.sss
-
-This conforms to am ISO8601 date but it should be noted that the full range of ISO8601 formats are not supported.
-
-The following variations on the C<$date_string> parameter are permitted:
-
- yyyy-mm-ddThh:mm:ss.sss # Standard format
- yyyy-mm-ddT # No time
- Thh:mm:ss.sss # No date
- yyyy-mm-ddThh:mm:ss.sssZ # Additional Z (but not time zones)
- yyyy-mm-ddThh:mm:ss # No fractional seconds
- yyyy-mm-ddThh:mm # No seconds
-
-Note that the C<T> is required in all cases.
-
-A date should always have a C<$format>, otherwise it will appear as a number, see L<DATES IN EXCEL> and L<CELL FORMATTING>. Here is a typical example:
-
- my $date_format = $workbook->add_format(num_format => 'mm/dd/yy');
- $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
-
-Valid dates should be in the range 1900-01-01 to 9999-12-31, for the 1900 epoch and 1904-01-01 to 9999-12-31, for the 1904 epoch. As with Excel, dates outside these ranges will be written as a string.
-
-See also the date_time.pl program in the C<examples> directory of the distro.
-
-
-
-
-=head2 write_comment($row, $column, $string)
-
-B<NOTE: this method is not available in this release. Use the 1.xx versions of this module if you need this feature>.
-
-
-The C<write_comment()> method is used to add a comment to a cell. A cell comment is indicated in Excel by a small red triangle in the upper right-hand corner of the cell. Moving the cursor over the red triangle will cause the comment to appear.
-
-The following example shows how to add a comment to a cell:
-
- $worksheet->write("C3", "Hello");
- $worksheet->write_comment("C3", "This is a comment.");
-
-
-The cell comment can be up to 30,000 characters in length.
-
-
-
-
-=head2 add_write_handler($re, $code_ref)
-
-This method is used to extend the Spreadsheet::WriteExcel write() method to handle user defined data.
-
-If you refer to the section on C<write()> above you will see that it acts as an alias for several more specific C<write_*> methods. However, it doesn't always act in exactly the way that you would like it to.
-
-One solution is to filter the input data yourself and call the appropriate C<write_*> method. Another approach is to use the C<add_write_handler()> method to add your own automated behaviour to C<write()>.
-
-The C<add_write_handler()> method take two arguments, C<$re>, a regular expression to match incoming data and C<$code_ref> a callback function to handle the matched data:
-
- $worksheet->add_write_handler(qr/^\d\d\d\d$/, \&my_write);
-
-(In the these examples the C<qr> operator is used to quote the regular expression strings, see L<perlop> for more details).
-
-The method is use as follows. say you wished to write 7 digit ID numbers as a string so that any leading zeros were preserved*, you could do something like the following:
-
- $worksheet->add_write_handler(qr/^\d{7}$/, \&write_my_id);
-
-
- sub write_my_id {
- my $worksheet = shift;
- return $worksheet->write_string(@_);
- }
-
-* You could also use the C<keep_leading_zeros()> method for this.
-
-Then if you call C<write()> with an appropriate string it will be handled automatically:
-
- # Writes 0000000. It would normally be written as a number; 0.
- $worksheet->write('A1', '0000000');
-
-The callback function will receive a reference to the calling worksheet and all of the other arguments that were passed to C<write()>. The callback will see an C<@_> argument list that looks like the following:
-
- $_[0] A ref to the calling worksheet. *
- $_[1] Zero based row number.
- $_[2] Zero based column number.
- $_[3] A number or string or token.
- $_[4] A format ref if any.
- $_[5] Any other argruments.
- ...
-
- * It is good style to shift this off the list so the @_ is the same
- as the argument list seen by write().
-
-Your callback should C<return()> the return value of the C<write_*> method that was called or C<undef> to indicate that you rejected the match and want C<write()> to continue as normal.
-
-So for example if you wished to apply the previous filter only to ID values that occur in the first column you could modify your callback function as follows:
-
-
- sub write_my_id {
- my $worksheet = shift;
- my $col = $_[1];
-
- if ($col == 0) {
- return $worksheet->write_string(@_);
- }
- else {
- # Reject the match and return control to write()
- return undef;
- }
- }
-
-Now, you will get different behaviour for the first column and other columns:
-
- $worksheet->write('A1', '0000000'); # Writes 0000000
- $worksheet->write('B1', '0000000'); # Writes 0
-
-
-You may add more than one handler in which case they will be called in the order that they were added.
-
-Note, the C<add_write_handler()> method is particularly suited for handling dates.
-
-See the C<write_handler 1-4> programs in the C<examples> directory for further examples.
-
-
-
-
-=head2 insert_bitmap($row, $col, $filename, $x, $y, $scale_x, $scale_y)
-
-This method can be used to insert a bitmap into a worksheet. The bitmap must be a 24 bit, true colour, bitmap. No other format is supported. The C<$x>, C<$y>, C<$scale_x> and C<$scale_y> parameters are optional.
-
- $worksheet1->insert_bitmap('A1', 'perl.bmp');
- $worksheet2->insert_bitmap('A1', '../images/perl.bmp');
- $worksheet3->insert_bitmap('A1', '.c:\images\perl.bmp');
-
-Note: you must call C<set_row()> or C<set_column()> before C<insert_bitmap()> if you wish to change the default dimensions of any of the rows or columns that the images occupies. The height of a row can also change if you use a font that is larger than the default. This in turn will affect the scaling of your image. To avoid this you should explicitly set the height of the row using C<set_row()> if it contains a font size that will change the row height.
-
-The parameters C<$x> and C<$y> can be used to specify an offset from the top left hand corner of the cell specified by C<$row> and C<$col>. The offset values are in pixels.
-
- $worksheet1->insert_bitmap('A1', 'perl.bmp', 32, 10);
-
-The default width of a cell is 63 pixels. The default height of a cell is 17 pixels. The pixels offsets can be calculated using the following relationships:
-
- Wp = int(12We) if We < 1
- Wp = int(7We +5) if We >= 1
- Hp = int(4/3He)
-
- where:
- We is the cell width in Excels units
- Wp is width in pixels
- He is the cell height in Excels units
- Hp is height in pixels
-
-The offsets can be greater than the width or height of the underlying cell. This can be occasionally useful if you wish to align two or more images relative to the same cell.
-
-The parameters C<$scale_x> and C<$scale_y> can be used to scale the inserted image horizontally and vertically:
-
- # Scale the inserted image: width x 2.0, height x 0.8
- $worksheet->insert_bitmap('A1', 'perl.bmp', 0, 0, 2, 0.8);
-
-Note: although Excel allows you to import several graphics formats such as gif, jpeg, png and eps these are converted internally into a proprietary format. One of the few non-proprietary formats that Excel supports is 24 bit, true colour, bitmaps. Therefore if you wish to use images in any other format you must first use an external application such as the ImageMagick I<convert> utility to convert them to 24 bit bitmaps.
-
- convert test.png test.bmp
-
-A later release will support the use of file handles and pre-encoded bitmap strings.
-
-See also the C<images.pl> program in the C<examples> directory of the distro.
-
-
-
-
-=head2 get_name()
-
-The C<get_name()> method is used to retrieve the name of a worksheet. For example:
-
- foreach my $sheet ($workbook->sheets()) {
- print $sheet->get_name();
- }
-
-
-
-
-=head2 activate()
-
-The C<activate()> method is used to specify which worksheet is initially visible in a multi-sheet workbook:
-
- $worksheet1 = $workbook->add_worksheet('To');
- $worksheet2 = $workbook->add_worksheet('the');
- $worksheet3 = $workbook->add_worksheet('wind');
-
- $worksheet3->activate();
-
-This is similar to the Excel VBA activate method. More than one worksheet can be selected via the C<select()> method, however only one worksheet can be active. The default value is the first worksheet.
-
-
-
-
-=head2 select()
-
-The C<select()> method is used to indicate that a worksheet is selected in a multi-sheet workbook:
-
- $worksheet1->activate();
- $worksheet2->select();
- $worksheet3->select();
-
-A selected worksheet has its tab highlighted. Selecting worksheets is a way of grouping them together so that, for example, several worksheets could be printed in one go. A worksheet that has been activated via the C<activate()> method will also appear as selected. You probably won't need to use the C<select()> method very often.
-
-
-
-
-=head2 set_first_sheet()
-
-The C<activate()> method determines which worksheet is initially selected. However, if there are a large number of worksheets the selected worksheet may not appear on the screen. To avoid this you can select which is the leftmost visible worksheet using C<set_first_sheet()>:
-
- for (1..20) {
- $workbook->add_worksheet;
- }
-
- $worksheet21 = $workbook->add_worksheet();
- $worksheet22 = $workbook->add_worksheet();
-
- $worksheet21->set_first_sheet();
- $worksheet22->activate();
-
-This method is not required very often. The default value is the first worksheet.
-
-
-
-
-=head2 protect($password)
-
-The C<protect()> method is used to protect a worksheet from modification:
-
- $worksheet->protect();
-
-It can be turned off in Excel via the C<Tools-E<gt>Protection-E<gt>Unprotect Sheet> menu command.
-
-The C<protect()> method also has the effect of enabling a cell's C<locked> and C<hidden> properties if they have been set. A "locked" cell cannot be edited. A "hidden" cell will display the results of a formula but not the formula itself. In Excel a cell's locked property is on by default.
-
- # Set some format properties
- my $unlocked = $workbook->add_format(locked => 0);
- my $hidden = $workbook->add_format(hidden => 1);
-
- # Enable worksheet protection
- $worksheet->protect();
-
- # This cell cannot be edited, it is locked by default
- $worksheet->write('A1', '=1+2');
-
- # This cell can be edited
- $worksheet->write('A2', '=1+2', $unlocked);
-
- # The formula in this cell isn't visible
- $worksheet->write('A3', '=1+2', $hidden);
-
-See also the C<set_locked> and C<set_hidden> format methods in L<CELL FORMATTING>.
-
-You can optionally add a password to the worksheet protection:
-
- $worksheet->protect('drowssap');
-
-Note, the worksheet level password in Excel provides very weak protection. It does not encrypt your data in any way and it is very easy to deactivate. Therefore, do not use the above method if you wish to protect sensitive data or calculations. However, before you get worried, Excel's own workbook level password protection does provide strong encryption in Excel 97+. For technical reasons this will never be supported by C<Spreadsheet::WriteExcel>.
-
-
-
-
-=head2 set_selection($first_row, $first_col, $last_row, $last_col)
-
-This method can be used to specify which cell or cells are selected in a worksheet. The most common requirement is to select a single cell, in which case C<$last_row> and C<$last_col> can be omitted. The active cell within a selected range is determined by the order in which C<$first> and C<$last> are specified. It is also possible to specify a cell or a range using A1 notation. See the note about L<Cell notation>.
-
-Examples:
-
- $worksheet1->set_selection(3, 3); # 1. Cell D4.
- $worksheet2->set_selection(3, 3, 6, 6); # 2. Cells D4 to G7.
- $worksheet3->set_selection(6, 6, 3, 3); # 3. Cells G7 to D4.
- $worksheet4->set_selection('D4'); # Same as 1.
- $worksheet5->set_selection('D4:G7'); # Same as 2.
- $worksheet6->set_selection('G7:D4'); # Same as 3.
-
-The default cell selections is (0, 0), 'A1'.
-
-
-
-
-=head2 set_row($row, $height, $format, $hidden, $level)
-
-This method can be used to change the default properties of a row. All parameters apart from C<$row> are optional.
-
-The most common use for this method is to change the height of a row:
-
- $worksheet->set_row(0, 20); # Row 1 height set to 20
-
-If you wish to set the format without changing the height you can pass C<undef> as the height parameter:
-
- $worksheet->set_row(0, undef, $format);
-
-The C<$format> parameter will be applied to any cells in the row that don't have a format. For example
-
- $worksheet->set_row(0, undef, $format1); # Set the format for row 1
- $worksheet->write('A1', "Hello"); # Defaults to $format1
- $worksheet->write('B1', "Hello", $format2); # Keeps $format2
-
-If you wish to define a row format in this way you should call the method before any calls to C<write()>. Calling it afterwards will overwrite any format that was previously specified.
-
-The C<$hidden> parameter should be set to 1 if you wish to hide a row. This can be used, for example, to hide intermediary steps in a complicated calculation:
-
- $worksheet->set_row(0, 20, $format, 1);
- $worksheet->set_row(1, undef, undef, 1);
-
-The C<$level> parameter is used to set the outline level of the row. Outlines are described in L<OUTLINES AND GROUPING IN EXCEL>. Adjacent rows with the same outline level are grouped together into a single outline.
-
-The following example sets an outline level of 1 for rows 1 and 2 (zero-indexed):
-
- $worksheet->set_row(1, undef, undef, 0, 1);
- $worksheet->set_row(2, undef, undef, 0, 1);
-
-The C<$hidden> parameter can also be used to collapse outlined rows when used in conjunction with the C<$level> parameter.
-
- $worksheet->set_row(1, undef, undef, 1, 1);
- $worksheet->set_row(2, undef, undef, 1, 1);
-
-Excel allows up to 7 outline levels. Therefore the C<$level> parameter should be in the range C<0 E<lt>= $level E<lt>= 7>.
-
-
-
-
-=head2 set_column($first_col, $last_col, $width, $format, $hidden, $level)
-
-This method can be used to change the default properties of a single column or a range of columns. All parameters apart from C<$first_col> and C<$last_col> are optional.
-
-If C<set_column()> is applied to a single column the value of C<$first_col> and C<$last_col> should be the same. It is also possible to specify a column range using the form of A1 notation used for columns. See the note about L<Cell notation>.
-
-Examples:
-
- $worksheet->set_column(0, 0, 20); # Column A width set to 20
- $worksheet->set_column(1, 3, 30); # Columns B-D width set to 30
- $worksheet->set_column('E:E', 20); # Column E width set to 20
- $worksheet->set_column('F:H', 30); # Columns F-H width set to 30
-
-The width corresponds to the column width value that is specified in Excel. It is approximately equal to the length of a string in the default font of Arial 10. Unfortunately, there is no way to specify "AutoFit" for a column in the Excel file format. This feature is only available at runtime from within Excel.
-
-As usual the C<$format> parameter is optional, for additional information, see L<CELL FORMATTING>. If you wish to set the format without changing the width you can pass C<undef> as the width parameter:
-
- $worksheet->set_column(0, 0, undef, $format);
-
-The C<$format> parameter will be applied to any cells in the column that don't have a format. For example
-
- $worksheet->set_column('A:A', undef, $format1); # Set format for col 1
- $worksheet->write('A1', "Hello"); # Defaults to $format1
- $worksheet->write('A2', "Hello", $format2); # Keeps $format2
-
-If you wish to define a column format in this way you should call the method before any calls to C<write()>. If you call it afterwards it won't have any effect.
-
-A default row format takes precedence over a default column format
-
- $worksheet->set_row(0, undef, $format1); # Set format for row 1
- $worksheet->set_column('A:A', undef, $format2); # Set format for col 1
- $worksheet->write('A1', "Hello"); # Defaults to $format1
- $worksheet->write('A2', "Hello"); # Defaults to $format2
-
-The C<$hidden> parameter should be set to 1 if you wish to hide a column. This can be used, for example, to hide intermediary steps in a complicated calculation:
-
- $worksheet->set_column('D:D', 20, $format, 1);
- $worksheet->set_column('E:E', undef, undef, 1);
-
-The C<$level> parameter is used to set the outline level of the column. Outlines are described in L<OUTLINES AND GROUPING IN EXCEL>. Adjacent columns with the same outline level are grouped together into a single outline.
-
-The following example sets an outline level of 1 for columns B to G:
-
- $worksheet->set_column('B:G', undef, undef, 0, 1);
-
-The C<$hidden> parameter can also be used to collapse outlined columns when used in conjunction with the C<$level> parameter.
-
- $worksheet->set_column('B:G', undef, undef, 1, 1);
-
-Excel allows up to 7 outline levels. Therefore the C<$level> parameter should be in the range C<0 E<lt>= $level E<lt>= 7>.
-
-
-
-
-=head2 outline_settings($visible, $symbols_below, $symbols_right, $auto_style)
-
-The C<outline_settings()> method is used to control the appearance of outlines in Excel. Outlines are described in L<OUTLINES AND GROUPING IN EXCEL>.
-
-The C<$visible> parameter is used to control whether or not outlines are visible. Setting this parameter to 0 will cause all outlines on the worksheet to be hidden. They can be unhidden in Excel by means of the "Show Outline Symbols" command button. The default setting is 1 for visible outlines.
-
- $worksheet->outline_settings(0);
-
-The C<$symbols_below> parameter is used to control whether the row outline symbol will appear above or below the outline level bar. The default setting is 1 for symbols to appear below the outline level bar.
-
-The C<symbols_right> parameter is used to control whether the column outline symbol will appear to the left or the right of the outline level bar. The default setting is 1 for symbols to appear to the right of the outline level bar.
-
-The C<$auto_style> parameter is used to control whether the automatic outline generator in Excel uses automatic styles when creating an outline. This has no effect on a file generated by C<Spreadsheet::WriteExcel> but it does have an effect on how the worksheet behaves after it is created. The default setting is 0 for "Automatic Styles" to be turned off.
-
-The default settings for all of these parameters correspond to Excel's default parameters.
-
-
-The worksheet parameters controlled by C<outline_settings()> are rarely used.
-
-
-
-
-=head2 freeze_panes($row, $col, $top_row, $left_col)
-
-This method can be used to divide a worksheet into horizontal or vertical regions known as panes and to also "freeze" these panes so that the splitter bars are not visible. This is the same as the C<Window-E<gt>Freeze Panes> menu command in Excel
-
-The parameters C<$row> and C<$col> are used to specify the location of the split. It should be noted that the split is specified at the top or left of a cell and that the method uses zero based indexing. Therefore to freeze the first row of a worksheet it is necessary to specify the split at row 2 (which is 1 as the zero-based index). This might lead you to think that you are using a 1 based index but this is not the case.
-
-You can set one of the C<$row> and C<$col> parameters as zero if you do not want either a vertical or horizontal split.
-
-Examples:
-
- $worksheet->freeze_panes(1, 0); # Freeze the first row
- $worksheet->freeze_panes('A2'); # Same using A1 notation
- $worksheet->freeze_panes(0, 1); # Freeze the first column
- $worksheet->freeze_panes('B1'); # Same using A1 notation
- $worksheet->freeze_panes(1, 2); # Freeze first row and first 2 columns
- $worksheet->freeze_panes('C2'); # Same using A1 notation
-
-The parameters C<$top_row> and C<$left_col> are optional. They are used to specify the top-most or left-most visible row or column in the scrolling region of the panes. For example to freeze the first row and to have the scrolling region begin at row twenty:
-
- $worksheet->freeze_panes(1, 0, 20, 0);
-
-You cannot use A1 notation for the C<$top_row> and C<$left_col> parameters.
-
-
-See also the C<panes.pl> program in the C<examples> directory of the distribution.
-
-
-
-
-=head2 thaw_panes($y, $x, $top_row, $left_col)
-
-This method can be used to divide a worksheet into horizontal or vertical regions known as panes. This method is different from the C<freeze_panes()> method in that the splits between the panes will be visible to the user and each pane will have its own scroll bars.
-
-The parameters C<$y> and C<$x> are used to specify the vertical and horizontal position of the split. The units for C<$y> and C<$x> are the same as those used by Excel to specify row height and column width. However, the vertical and horizontal units are different from each other. Therefore you must specify the C<$y> and C<$x> parameters in terms of the row heights and column widths that you have set or the default values which are C<12.75> for a row and C<8.43> for a column.
-
-You can set one of the C<$y> and C<$x> parameters as zero if you do not want either a vertical or horizontal split. The parameters C<$top_row> and C<$left_col> are optional. They are used to specify the top-most or left-most visible row or column in the bottom-right pane.
-
-Example:
-
- $worksheet->thaw_panes(12.75, 0, 1, 0); # First row
- $worksheet->thaw_panes(0, 8.43, 0, 1); # First column
- $worksheet->thaw_panes(12.75, 8.43, 1, 1); # First row and column
-
-You cannot use A1 notation with this method.
-
-See also the C<freeze_panes()> method and the C<panes.pl> program in the C<examples> directory of the distribution.
-
-
-
-
-=head2 merge_range($first_row, $first_col, $last_row, $last_col, $token, $format)
-
-Merging cells is generally achieved by setting the C<merge> property of a Format object, see L<CELL FORMATTING>. However, this only allows simple Excel5 style horizontal merging which Excel refers to as "center across selection".
-
-The C<merge_range()> method allows you to do Excel97+ style formatting where the cells can contain other types of alignment in addition to the merging:
-
- my $format = $workbook->add_format(
- border => 6,
- valign => 'vcenter',
- align => 'center',
- );
-
- $worksheet->merge_range('B3:D4', 'Vertical and horizontal', $format);
-
-B<WARNING>. The format object that is used with a C<merge_range()> method call is marked internally as being associated with a merged range. As such, B<it should not be used for other formatting>. This will be fixed in a later version. See the L<BUGS> section.
-
-C<merge_range()> writes its $token argument using the worksheet C<write()> method. Therefore it will handle numbers, strings, formulas or urls as required.
-
-Setting the C<merge> property of the format isn't required when you are using C<merge_range()>. In fact using it will exclude the use of any other horizontal alignment option.
-
-The full possibilities of this method are shown in the C<merge3.pl>, C<merge4.pl> and C<merge5.pl> programs in the C<examples> directory of the distribution.
-
-
-
-
-=head2 set_zoom($scale)
-
-Set the worksheet zoom factor in the range C<10 E<lt>= $scale E<lt>= 400>:
-
- $worksheet1->set_zoom(50);
- $worksheet2->set_zoom(75);
- $worksheet3->set_zoom(300);
- $worksheet4->set_zoom(400);
-
-The default zoom factor is 100. You cannot zoom to "Selection" because it is calculated by Excel at run-time.
-
-Note, C<set_zoom()> does not affect the scale of the printed page. For that you should use C<set_print_scale()>.
-
-
-
-
-=head1 PAGE SET-UP METHODS
-
-Page set-up methods affect the way that a worksheet looks when it is printed. They control features such as page headers and footers and margins. These methods are really just standard worksheet methods. They are documented here in a separate section for the sake of clarity.
-
-The following methods are available for page set-up:
-
- set_landscape()
- set_portrait()
- set_paper()
- center_horizontally()
- center_vertically()
- set_margins()
- set_header()
- set_footer()
- repeat_rows()
- repeat_columns()
- hide_gridlines()
- print_row_col_headers()
- print_area()
- fit_to_pages()
- set_print_scale()
- set_h_pagebreaks()
- set_v_pagebreaks()
-
-
-A common requirement when working with Spreadsheet::WriteExcel is to apply the same page set-up features to all of the worksheets in a workbook. To do this you can use the C<sheets()> method of the C<workbook> class to access the array of worksheets in a workbook:
-
- foreach $worksheet ($workbook->sheets()) {
- $worksheet->set_landscape();
- }
-
-
-
-
-=head2 set_landscape()
-
-This method is used to set the orientation of a worksheet's printed page to landscape:
-
- $worksheet->set_landscape(); # Landscape mode
-
-
-
-
-=head2 set_portrait()
-
-This method is used to set the orientation of a worksheet's printed page to portrait. The default worksheet orientation is portrait, so you won't generally need to call this method.
-
- $worksheet->set_portrait(); # Portrait mode
-
-
-
-=head2 set_paper($index)
-
-This method is used to set the paper format for the printed output of a worksheet. The following paper styles are available:
-
- Index Paper format Paper size
- ===== ============ ==========
- 0 Printer default -
- 1 Letter 8 1/2 x 11 in
- 2 Letter Small 8 1/2 x 11 in
- 3 Tabloid 11 x 17 in
- 4 Ledger 17 x 11 in
- 5 Legal 8 1/2 x 14 in
- 6 Statement 5 1/2 x 8 1/2 in
- 7 Executive 7 1/4 x 10 1/2 in
- 8 A3 297 x 420 mm
- 9 A4 210 x 297 mm
- 10 A4 Small 210 x 297 mm
- 11 A5 148 x 210 mm
- 12 B4 250 x 354 mm
- 13 B5 182 x 257 mm
- 14 Folio 8 1/2 x 13 in
- 15 Quarto 215 x 275 mm
- 16 - 10x14 in
- 17 - 11x17 in
- 18 Note 8 1/2 x 11 in
- 19 Envelope 9 3 7/8 x 8 7/8
- 20 Envelope 10 4 1/8 x 9 1/2
- 21 Envelope 11 4 1/2 x 10 3/8
- 22 Envelope 12 4 3/4 x 11
- 23 Envelope 14 5 x 11 1/2
- 24 C size sheet -
- 25 D size sheet -
- 26 E size sheet -
- 27 Envelope DL 110 x 220 mm
- 28 Envelope C3 324 x 458 mm
- 29 Envelope C4 229 x 324 mm
- 30 Envelope C5 162 x 229 mm
- 31 Envelope C6 114 x 162 mm
- 32 Envelope C65 114 x 229 mm
- 33 Envelope B4 250 x 353 mm
- 34 Envelope B5 176 x 250 mm
- 35 Envelope B6 176 x 125 mm
- 36 Envelope 110 x 230 mm
- 37 Monarch 3.875 x 7.5 in
- 38 Envelope 3 5/8 x 6 1/2 in
- 39 Fanfold 14 7/8 x 11 in
- 40 German Std Fanfold 8 1/2 x 12 in
- 41 German Legal Fanfold 8 1/2 x 13 in
-
-
-Note, it is likely that not all of these paper types will be available to the end user since it will depend on the paper formats that the user's printer supports. Therefore, it is best to stick to standard paper types.
-
- $worksheet->set_paper(1); # US Letter
- $worksheet->set_paper(9); # A4
-
-If you do not specify a paper type the worksheet will print using the printer's default paper.
-
-
-
-
-=head2 center_horizontally()
-
-Center the worksheet data horizontally between the margins on the printed page:
-
- $worksheet->center_horizontally();
-
-
-
-
-=head2 center_vertically()
-
-Center the worksheet data vertically between the margins on the printed page:
-
- $worksheet->center_vertically();
-
-
-
-
-=head2 set_margins($inches)
-
-There are several methods available for setting the worksheet margins on the printed page:
-
- set_margins() # Set all margins to the same value
- set_margins_LR() # Set left and right margins to the same value
- set_margins_TB() # Set top and bottom margins to the same value
- set_margin_left(); # Set left margin
- set_margin_right(); # Set right margin
- set_margin_top(); # Set top margin
- set_margin_bottom(); # Set bottom margin
-
-All of these methods take a distance in inches as a parameter. Note: 1 inch = 25.4mm. ;-) The default left and right margin is 0.75 inch. The default top and bottom margin is 1.00 inch.
-
-
-
-=head2 set_header($string, $margin)
-
-Headers and footers are generated using a C<$string> which is a combination of plain text and control characters. The C<$margin> parameter is optional.
-
-The available control character are:
-
- Control Category Description
- ======= ======== ===========
- &L Justification Left
- &C Center
- &R Right
-
- &P Information Page number
- &N Total number of pages
- &D Date
- &T Time
- &F File name
- &A Worksheet name
-
- &fontsize Font Font size
- &"font,style" Font name and style
- &U Single underline
- &E Double underline
- &S Strikethrough
- &X Superscript
- &Y Subscript
-
- && Miscellaneous Literal ampersand &
-
-
-Text in headers and footers can be justified (aligned) to the left, center and right by prefixing the text with the control characters C<&L>, C<&C> and C<&R>.
-
-For example (with ASCII art representation of the results):
-
- $worksheet->set_header('&LHello');
-
- ---------------------------------------------------------------
- | |
- | Hello |
- | |
-
-
- $worksheet->set_header('&CHello');
-
- ---------------------------------------------------------------
- | |
- | Hello |
- | |
-
-
- $worksheet->set_header('&RHello');
-
- ---------------------------------------------------------------
- | |
- | Hello |
- | |
-
-
-For simple text, if you do not specify any justification the text will be centred. However, you must prefix the text with C<&C> if you specify a font name or any other formatting:
-
- $worksheet->set_header('Hello');
-
- ---------------------------------------------------------------
- | |
- | Hello |
- | |
-
-
-You can have text in each of the justification regions:
-
- $worksheet->set_header('&LCiao&CBello&RCielo');
-
- ---------------------------------------------------------------
- | |
- | Ciao Bello Cielo |
- | |
-
-
-The information control characters act as variables that Excel will update as the workbook or worksheet changes. Times and dates are in the users default format:
-
- $worksheet->set_header('&CPage &P of &N');
-
- ---------------------------------------------------------------
- | |
- | Page 1 of 6 |
- | |
-
-
- $worksheet->set_header('&CUpdated at &T');
-
- ---------------------------------------------------------------
- | |
- | Updated at 12:30 PM |
- | |
-
-
-
-You can specify the font size of a section of the text by prefixing it with the control character C<&n> where C<n> is the font size:
-
- $worksheet1->set_header('&C&30Hello Big' );
- $worksheet2->set_header('&C&10Hello Small');
-
-You can specify the font of a section of the text by prefixing it with the control sequence C<&"font,style"> where C<fontname> is a font name such as "Courier New" or "Times New Roman" and C<style> is one of the standard Windows font descriptions: "Regular", "Italic", "Bold" or "Bold Italic":
-
- $worksheet1->set_header('&C&"Courier New,Italic"Hello');
- $worksheet2->set_header('&C&"Courier New,Bold Italic"Hello');
- $worksheet3->set_header('&C&"Times New Roman,Regular"Hello');
-
-It is possible to combine all of these features together to create sophisticated headers and footers. As an aid to setting up complicated headers and footers you can record a page set-up as a macro in Excel and look at the format strings that VBA produces. Remember however that VBA uses two double quotes C<""> to indicate a single double quote. For the last example above the equivalent VBA code looks like this:
-
- .LeftHeader = ""
- .CenterHeader = "&""Times New Roman,Regular""Hello"
- .RightHeader = ""
-
-
-To include a single literal ampersand C<&> in a header or footer you should use a double ampersand C<&&>:
-
- $worksheet1->set_header('&CCuriouser && Curiouser - Attorneys at Law');
-
-As stated above the margin parameter is optional. As with the other margins the value should be in inches. The default header and footer margin is 0.50 inch. The header and footer margin size can be set as follows:
-
- $worksheet->set_header('&CHello', 0.75);
-
-The header and footer margins are independent of the top and bottom margins.
-
-Note, the header or footer string must be less than 255 characters. Strings longer than this will not be written and a warning will be generated.
-
-See, also the C<headers.pl> program in the C<examples> directory of the distribution.
-
-
-
-
-=head2 set_footer()
-
-The syntax of the C<set_footer()> method is the same as C<set_header()>, see above.
-
-
-
-
-=head2 repeat_rows($first_row, $last_row)
-
-Set the number of rows to repeat at the top of each printed page.
-
-For large Excel documents it is often desirable to have the first row or rows of the worksheet print out at the top of each page. This can be achieved by using the C<repeat_rows()> method. The parameters C<$first_row> and C<$last_row> are zero based. The C<$last_row> parameter is optional if you only wish to specify one row:
-
- $worksheet1->repeat_rows(0); # Repeat the first row
- $worksheet2->repeat_rows(0, 1); # Repeat the first two rows
-
-
-
-
-=head2 repeat_columns($first_col, $last_col)
-
-Set the columns to repeat at the left hand side of each printed page.
-
-For large Excel documents it is often desirable to have the first column or columns of the worksheet print out at the left hand side of each page. This can be achieved by using the C<repeat_columns()> method. The parameters C<$first_column> and C<$last_column> are zero based. The C<$last_column> parameter is optional if you only wish to specify one column. You can also specify the columns using A1 column notation, see the note about L<Cell notation>.
-
- $worksheet1->repeat_columns(0); # Repeat the first column
- $worksheet2->repeat_columns(0, 1); # Repeat the first two columns
- $worksheet3->repeat_columns('A:A'); # Repeat the first column
- $worksheet4->repeat_columns('A:B'); # Repeat the first two columns
-
-
-
-
-=head2 hide_gridlines($option)
-
-This method is used to hide the gridlines on the screen and printed page. Gridlines are the lines that divide the cells on a worksheet. Screen and printed gridlines are turned on by default in an Excel worksheet. If you have defined your own cell borders you may wish to hide the default gridlines.
-
- $worksheet->hide_gridlines();
-
-The following values of C<$option> are valid:
-
- 0 : Don't hide gridlines
- 1 : Hide printed gridlines only
- 2 : Hide screen and printed gridlines
-
-If you don't supply an argument or use C<undef> the default option is 1, i.e. only the printed gridlines are hidden.
-
-
-
-
-=head2 print_row_col_headers()
-
-Set the option to print the row and column headers on the printed page.
-
-An Excel worksheet looks something like the following;
-
- ------------------------------------------
- | | A | B | C | D | ...
- ------------------------------------------
- | 1 | | | | | ...
- | 2 | | | | | ...
- | 3 | | | | | ...
- | 4 | | | | | ...
- |...| ... | ... | ... | ... | ...
-
-The headers are the letters and numbers at the top and the left of the worksheet. Since these headers serve mainly as a indication of position on the worksheet they generally do not appear on the printed page. If you wish to have them printed you can use the C<print_row_col_headers()> method :
-
- $worksheet->print_row_col_headers()
-
-Do not confuse these headers with page headers as described in the C<set_header()> section above.
-
-
-
-
-=head2 print_area($first_row, $first_col, $last_row, $last_col)
-
-This method is used to specify the area of the worksheet that will be printed. All four parameters must be specified. You can also use A1 notation, see the note about L<Cell notation>.
-
-
- $worksheet1->print_area("A1:H20"); # Cells A1 to H20
- $worksheet2->print_area(0, 0, 19, 7); # The same
- $worksheet2->print_area('A:H'); # Columns A to H if rows have data
-
-
-
-=head2 fit_to_pages($width, $height)
-
-The C<fit_to_pages()> method is used to fit the printed area to a specific number of pages both vertically and horizontally. If the printed area exceeds the specified number of pages it will be scaled down to fit. This guarantees that the printed area will always appear on the specified number of pages even if the page size or margins change.
-
- $worksheet1->fit_to_pages(1, 1); # Fit to 1x1 pages
- $worksheet2->fit_to_pages(2, 1); # Fit to 2x1 pages
- $worksheet3->fit_to_pages(1, 2); # Fit to 1x2 pages
-
-The print area can be defined using the C<print_area()> method as described above.
-
-A common requirement is to fit the printed output to I<n> pages wide but have the height be as long as necessary. To achieve this set the C<$height> to zero or leave it blank:
-
- $worksheet1->fit_to_pages(1, 0); # 1 page wide and as long as necessary
- $worksheet2->fit_to_pages(1); # The same
-
-
-Note that although it is valid to use both C<fit_to_pages()> and C<set_print_scale()> on the same worksheet only one of these options can be active at a time. The last method call made will set the active option.
-
-Note that C<fit_to_pages()> will override any manual page breaks that are defined in the worksheet.
-
-
-
-
-=head2 set_print_scale($scale)
-
-Set the scale factor of the printed page. Scale factors in the range C<10 E<lt>= $scale E<lt>= 400> are valid:
-
- $worksheet1->set_print_scale(50);
- $worksheet2->set_print_scale(75);
- $worksheet3->set_print_scale(300);
- $worksheet4->set_print_scale(400);
-
-The default scale factor is 100. Note, C<set_print_scale()> does not affect the scale of the visible page in Excel. For that you should use C<set_zoom()>.
-
-Note also that although it is valid to use both C<fit_to_pages()> and C<set_print_scale()> on the same worksheet only one of these options can be active at a time. The last method call made will set the active option.
-
-
-
-
-=head2 set_h_pagebreaks(@breaks)
-
-Add horizontal page breaks to a worksheet. A page break causes all the data that follows it to be printed on the next page. Horizontal page breaks act between rows. To create a page break between rows 20 and 21 you must specify the break at row 21. However in zero index notation this is actually row 20. So you can pretend for a small while that you are using 1 index notation:
-
- $worksheet1->set_h_pagebreaks(20); # Break between row 20 and 21
-
-The C<set_h_pagebreaks()> method will accept a list of page breaks and you can call it more than once:
-
- $worksheet2->set_h_pagebreaks( 20, 40, 60, 80, 100); # Add breaks
- $worksheet2->set_h_pagebreaks(120, 140, 160, 180, 200); # Add some more
-
-Note: If you specify the "fit to page" option via the C<fit_to_pages()> method it will override all manual page breaks.
-
-There is a silent limitation of about 1000 horizontal page breaks per worksheet in line with an Excel internal limitation.
-
-
-
-
-=head2 set_v_pagebreaks(@breaks)
-
-Add vertical page breaks to a worksheet. A page break causes all the data that follows it to be printed on the next page. Vertical page breaks act between columns. To create a page break between columns 20 and 21 you must specify the break at column 21. However in zero index notation this is actually column 20. So you can pretend for a small while that you are using 1 index notation:
-
- $worksheet1->set_v_pagebreaks(20); # Break between column 20 and 21
-
-The C<set_v_pagebreaks()> method will accept a list of page breaks and you can call it more than once:
-
- $worksheet2->set_v_pagebreaks( 20, 40, 60, 80, 100); # Add breaks
- $worksheet2->set_v_pagebreaks(120, 140, 160, 180, 200); # Add some more
-
-Note: If you specify the "fit to page" option via the C<fit_to_pages()> method it will override all manual page breaks.
-
-
-
-
-=head1 CELL FORMATTING
-
-This section describes the methods and properties that are available for formatting cells in Excel. The properties of a cell that can be formatted include: fonts, colours, patterns, borders, alignment and number formatting.
-
-
-=head2 Creating and using a Format object
-
-Cell formatting is defined through a Format object. Format objects are created by calling the workbook C<add_format()> method as follows:
-
- my $format1 = $workbook->add_format(); # Set properties later
- my $format2 = $workbook->add_format(%props); # Set at creation
-
-The format object holds all the formatting properties that can be applied to a cell, a row or a column. The process of setting these properties is discussed in the next section.
-
-Once a Format object has been constructed and it properties have been set it can be passed as an argument to the worksheet C<write> methods as follows:
-
- $worksheet->write(0, 0, "One", $format);
- $worksheet->write_string(1, 0, "Two", $format);
- $worksheet->write_number(2, 0, 3, $format);
- $worksheet->write_blank(3, 0, $format);
-
-Formats can also be passed to the worksheet C<set_row()> and C<set_column()> methods to define the default property for a row or column.
-
- $worksheet->set_row(0, 15, $format);
- $worksheet->set_column(0, 0, 15, $format);
-
-
-
-
-=head2 Format methods and Format properties
-
-The following table shows the Excel format categories, the formatting properties that can be applied and the equivalent object method:
-
-
- Category Description Property Method Name
- -------- ----------- -------- -----------
- Font Font type font set_font()
- Font size size set_size()
- Font color color set_color()
- Bold bold set_bold()
- Italic italic set_italic()
- Underline underline set_underline()
- Strikeout font_strikeout set_font_strikeout()
- Super/Subscript font_script set_font_script()
- Outline font_outline set_font_outline()
- Shadow font_shadow set_font_shadow()
-
- Number Numeric format num_format set_num_format()
-
- Protection Lock cells locked set_locked()
- Hide formulas hidden set_hidden()
-
- Alignment Horizontal align align set_align()
- Vertical align valign set_align()
- Rotation rotation set_rotation()
- Text wrap text_wrap set_text_wrap()
- Justify last text_justlast set_text_justlast()
- Center across center_across set_center_across()
- Indentation indent set_indent()
- Shrink to fit shrink set_shrink()
-
- Pattern Cell pattern pattern set_pattern()
- Background color bg_color set_bg_color()
- Foreground color fg_color set_fg_color()
-
- Border Cell border border set_border()
- Bottom border bottom set_bottom()
- Top border top set_top()
- Left border left set_left()
- Right border right set_right()
- Border color border_color set_border_color()
- Bottom color bottom_color set_bottom_color()
- Top color top_color set_top_color()
- Left color left_color set_left_color()
- Right color right_color set_right_color()
-
-There are two ways of setting Format properties: by using the object method interface or by setting the property directly. For example, a typical use of the method interface would be as follows:
-
- my $format = $workbook->add_format();
- $format->set_bold();
- $format->set_color('red');
-
-By comparison the properties can be set directly by passing a hash of properties to the Format constructor:
-
- my $format = $workbook->add_format(bold => 1, color => 'red');
-
-or after the Format has been constructed by means of the C<set_properties()> method as follows:
-
- my $format = $workbook->add_format();
- $format->set_properties(bold => 1, color => 'red');
-
-You can also store the properties in one or more named hashes and pass them to the required method:
-
- my %font = (
- font => 'Arial',
- size => 12,
- color => 'blue',
- bold => 1,
- );
-
- my %shading = (
- bg_color => 'green',
- pattern => 1,
- );
-
-
- my $format1 = $workbook->add_format(%font); # Font only
- my $format2 = $workbook->add_format(%font, %shading); # Font and shading
-
-
-The provision of two ways of setting properties might lead you to wonder which is the best way. The answer depends on the amount of formatting that will be required in your program. Initially, Spreadsheet::WriteExcel only allowed individual Format properties to be set via the appropriate method. While this was sufficient for most circumstances it proved very cumbersome in programs that required a large amount of formatting. In addition the mechanism for reusing properties between Format objects was complicated.
-
-As a result the Perl/Tk style of adding properties was added to, hopefully, facilitate developers who need to define a lot of formatting. In fact the Tk style of defining properties is also supported:
-
- my %font = (
- -font => 'Arial',
- -size => 12,
- -color => 'blue',
- -bold => 1,
- );
-
-An additional advantage of working with hashes of properties is that it allows you to share formatting between workbook objects
-
-You can also create a format "on the fly" and pass it directly to a write method as follows:
-
- $worksheet->write('A1', "Title", $workbook->add_format(bold => 1));
-
-This corresponds to an "anonymous" format in the Perl sense of anonymous data or subs.
-
-
-
-
-=head2 Working with formats
-
-The default format is Arial 10 with all other properties off.
-
-Each unique format in Spreadsheet::WriteExcel must have a corresponding Format object. It isn't possible to use a Format with a write() method and then redefine the Format for use at a later stage. This is because a Format is applied to a cell not in its current state but in its final state. Consider the following example:
-
- my $format = $workbook->add_format();
- $format->set_bold();
- $format->set_color('red');
- $worksheet->write('A1', "Cell A1", $format);
- $format->set_color('green');
- $worksheet->write('B1', "Cell B1", $format);
-
-Cell A1 is assigned the Format C<$format> which is initially set to the colour red. However, the colour is subsequently set to green. When Excel displays Cell A1 it will display the final state of the Format which in this case will be the colour green.
-
-In general a method call without an argument will turn a property on, for example:
-
- my $format1 = $workbook->add_format();
- $format1->set_bold(); # Turns bold on
- $format1->set_bold(1); # Also turns bold on
- $format1->set_bold(0); # Turns bold off
-
-
-
-
-=head1 FORMAT METHODS
-
-The Format object methods are described in more detail in the following sections. In addition, there is a Perl program called C<formats.pl> in the C<examples> directory of the WriteExcel distribution. This program creates an Excel workbook called C<formats.xls> which contains examples of almost all the format types.
-
-The following Format methods are available:
-
- set_font()
- set_size()
- set_color()
- set_bold()
- set_italic()
- set_underline()
- set_font_strikeout()
- set_font_script()
- set_font_outline()
- set_font_shadow()
- set_num_format()
- set_locked()
- set_hidden()
- set_align()
- set_align()
- set_rotation()
- set_text_wrap()
- set_text_justlast()
- set_center_across()
- set_indent()
- set_shrink()
- set_pattern()
- set_bg_color()
- set_fg_color()
- set_border()
- set_bottom()
- set_top()
- set_left()
- set_right()
- set_border_color()
- set_bottom_color()
- set_top_color()
- set_left_color()
- set_right_color()
-
-
-The above methods can also be applied directly as properties. For example C<$worksheet-E<gt>set_bold()> is equivalent to C<set_properties(bold =E<gt> 1)>.
-
-
-=head2 set_properties(%properties)
-
-The properties of an existing Format object can be set by means of C<set_properties()>:
-
- my $format = $workbook->add_format();
- $format->set_properties(bold => 1, color => 'red');
-
-You can also store the properties in one or more named hashes and pass them to the C<set_properties()> method:
-
- my %font = (
- font => 'Arial',
- size => 12,
- color => 'blue',
- bold => 1,
- );
-
- my $format = $workbook->set_properties(%font);
-
-This method can be used as an alternative to setting the properties with C<add_format()> or the specific format methods that are detailed in the following sections.
-
-
-
-
-=head2 set_font($fontname)
-
- Default state: Font is Arial
- Default action: None
- Valid args: Any valid font name
-
-Specify the font used:
-
- $format->set_font('Times New Roman');
-
-Excel can only display fonts that are installed on the system that it is running on. Therefore it is best to use the fonts that come as standard such as 'Arial', 'Times New Roman' and 'Courier New'. See also the Fonts worksheet created by formats.pl
-
-
-
-
-=head2 set_size()
-
- Default state: Font size is 10
- Default action: Set font size to 1
- Valid args: Integer values from 1 to as big as your screen.
-
-
-Set the font size. Excel adjusts the height of a row to accommodate the largest font size in the row. You can also explicitly specify the height of a row using the set_row() worksheet method.
-
- my $format = $workbook->add_format();
- $format->set_size(30);
-
-
-
-
-
-=head2 set_color()
-
- Default state: Excels default color, usually black
- Default action: Set the default color
- Valid args: Integers from 8..63 or the following strings:
- 'black'
- 'blue'
- 'brown'
- 'cyan'
- 'gray'
- 'green'
- 'lime'
- 'magenta'
- 'navy'
- 'orange'
- 'purple'
- 'red'
- 'silver'
- 'white'
- 'yellow'
-
-Set the font colour. The C<set_color()> method is used as follows:
-
- my $format = $workbook->add_format();
- $format->set_color('red');
- $worksheet->write(0, 0, "wheelbarrow", $format);
-
-Note: The C<set_color()> method is used to set the colour of the font in a cell. To set the colour of a cell use the C<set_bg_color()> and C<set_pattern()> methods.
-
-For additional examples see the 'Named colors' and 'Standard colors' worksheets created by formats.pl in the examples directory.
-
-See also L<COLOURS IN EXCEL>.
-
-
-
-
-=head2 set_bold()
-
- Default state: bold is off
- Default action: Turn bold on
- Valid args: 0, 1 [1]
-
-Set the bold property of the font:
-
- $format->set_bold(); # Turn bold on
-
-[1] Actually, values in the range 100..1000 are also valid. 400 is normal, 700 is bold and 1000 is very bold indeed. It is probably best to set the value to 1 and use normal bold.
-
-
-
-
-=head2 set_italic()
-
- Default state: Italic is off
- Default action: Turn italic on
- Valid args: 0, 1
-
-Set the italic property of the font:
-
- $format->set_italic(); # Turn italic on
-
-
-
-
-=head2 set_underline()
-
- Default state: Underline is off
- Default action: Turn on single underline
- Valid args: 0 = No underline
- 1 = Single underline
- 2 = Double underline
- 33 = Single accounting underline
- 34 = Double accounting underline
-
-Set the underline property of the font.
-
- $format->set_underline(); # Single underline
-
-
-
-
-=head2 set_font_strikeout()
-
- Default state: Strikeout is off
- Default action: Turn strikeout on
- Valid args: 0, 1
-
-Set the strikeout property of the font.
-
-
-
-
-=head2 set_font_script()
-
- Default state: Super/Subscript is off
- Default action: Turn Superscript on
- Valid args: 0 = Normal
- 1 = Superscript
- 2 = Subscript
-
-Set the superscript/subscript property of the font. This format is currently not very useful.
-
-
-
-
-=head2 set_font_outline()
-
- Default state: Outline is off
- Default action: Turn outline on
- Valid args: 0, 1
-
-Macintosh only.
-
-
-
-
-=head2 set_font_shadow()
-
- Default state: Shadow is off
- Default action: Turn shadow on
- Valid args: 0, 1
-
-Macintosh only.
-
-
-
-
-=head2 set_num_format()
-
- Default state: General format
- Default action: Format index 1
- Valid args: See the following table
-
-This method is used to define the numerical format of a number in Excel. It controls whether a number is displayed as an integer, a floating point number, a date, a currency value or some other user defined format.
-
-The numerical format of a cell can be specified by using a format string or an index to one of Excel's built-in formats:
-
- my $format1 = $workbook->add_format();
- my $format2 = $workbook->add_format();
- $format1->set_num_format('d mmm yyyy'); # Format string
- $format2->set_num_format(0x0f); # Format index
-
- $worksheet->write(0, 0, 36892.521, $format1); # 1 Jan 2001
- $worksheet->write(0, 0, 36892.521, $format2); # 1-Jan-01
-
-
-Using format strings you can define very sophisticated formatting of numbers.
-
- $format01->set_num_format('0.000');
- $worksheet->write(0, 0, 3.1415926, $format01); # 3.142
-
- $format02->set_num_format('#,##0');
- $worksheet->write(1, 0, 1234.56, $format02); # 1,235
-
- $format03->set_num_format('#,##0.00');
- $worksheet->write(2, 0, 1234.56, $format03); # 1,234.56
-
- $format04->set_num_format('$0.00');
- $worksheet->write(3, 0, 49.99, $format04); # $49.99
-
- $format05->set_num_format('£0.00');
- $worksheet->write(4, 0, 49.99, $format05); # £49.99
-
- $format06->set_num_format('¥0.00');
- $worksheet->write(5, 0, 49.99, $format06); # ¥49.99
-
- $format07->set_num_format('mm/dd/yy');
- $worksheet->write(6, 0, 36892.521, $format07); # 01/01/01
-
- $format08->set_num_format('mmm d yyyy');
- $worksheet->write(7, 0, 36892.521, $format08); # Jan 1 2001
-
- $format09->set_num_format('d mmmm yyyy');
- $worksheet->write(8, 0, 36892.521, $format09); # 1 January 2001
-
- $format10->set_num_format('dd/mm/yyyy hh:mm AM/PM');
- $worksheet->write(9, 0, 36892.521, $format10); # 01/01/2001 12:30 AM
-
- $format11->set_num_format('0 "dollar and" .00 "cents"');
- $worksheet->write(10, 0, 1.87, $format11); # 1 dollar and .87 cents
-
- # Conditional formatting
- $format12->set_num_format('[Green]General;[Red]-General;General');
- $worksheet->write(11, 0, 123, $format12); # > 0 Green
- $worksheet->write(12, 0, -45, $format12); # < 0 Red
- $worksheet->write(13, 0, 0, $format12); # = 0 Default colour
-
- # Zip code
- $format13->set_num_format('00000');
- $worksheet->write(14, 0, '01209', $format13);
-
-
-The number system used for dates is described in L<DATES IN EXCEL>.
-
-The colour format should have one of the following values:
-
- [Black] [Blue] [Cyan] [Green] [Magenta] [Red] [White] [Yellow]
-
-Alternatively you can specify the colour based on a colour index as follows: C<[Color n]>, where n is a standard Excel colour index - 7. See the 'Standard colors' worksheet created by formats.pl.
-
-For more information refer to the documentation on formatting in the C<doc> directory of the Spreadsheet::WriteExcel distro, the Excel on-line help or to the tutorial at: http://support.microsoft.com/support/Excel/Content/Formats/default.asp and http://support.microsoft.com/support/Excel/Content/Formats/codes.asp
-
-You should ensure that the format string is valid in Excel prior to using it in WriteExcel.
-
-Excel's built-in formats are shown in the following table:
-
- Index Index Format String
- 0 0x00 General
- 1 0x01 0
- 2 0x02 0.00
- 3 0x03 #,##0
- 4 0x04 #,##0.00
- 5 0x05 ($#,##0_);($#,##0)
- 6 0x06 ($#,##0_);[Red]($#,##0)
- 7 0x07 ($#,##0.00_);($#,##0.00)
- 8 0x08 ($#,##0.00_);[Red]($#,##0.00)
- 9 0x09 0%
- 10 0x0a 0.00%
- 11 0x0b 0.00E+00
- 12 0x0c # ?/?
- 13 0x0d # ??/??
- 14 0x0e m/d/yy
- 15 0x0f d-mmm-yy
- 16 0x10 d-mmm
- 17 0x11 mmm-yy
- 18 0x12 h:mm AM/PM
- 19 0x13 h:mm:ss AM/PM
- 20 0x14 h:mm
- 21 0x15 h:mm:ss
- 22 0x16 m/d/yy h:mm
- .. .... ...........
- 37 0x25 (#,##0_);(#,##0)
- 38 0x26 (#,##0_);[Red](#,##0)
- 39 0x27 (#,##0.00_);(#,##0.00)
- 40 0x28 (#,##0.00_);[Red](#,##0.00)
- 41 0x29 _(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)
- 42 0x2a _($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)
- 43 0x2b _(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)
- 44 0x2c _($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)
- 45 0x2d mm:ss
- 46 0x2e [h]:mm:ss
- 47 0x2f mm:ss.0
- 48 0x30 ##0.0E+0
- 49 0x31 @
-
-
-For examples of these formatting codes see the 'Numerical formats' worksheet created by formats.pl. See also the number_formats1.html and the number_formats2.html documents in the C<doc> directory of the distro.
-
-Note 1. Numeric formats 23 to 36 are not documented by Microsoft and may differ in international versions.
-
-Note 2. In Excel 5 the dollar sign appears as a dollar sign. In Excel 97-2000 it appears as the defined local currency symbol.
-
-Note 3. The red negative numeric formats display slightly differently in Excel 5 and Excel 97-2000.
-
-
-
-
-=head2 set_locked()
-
- Default state: Cell locking is on
- Default action: Turn locking on
- Valid args: 0, 1
-
-This property can be used to prevent modification of a cells contents. Following Excel's convention, cell locking is turned on by default. However, it only has an effect if the worksheet has been protected, see the worksheet C<protect()> method.
-
- my $locked = $workbook->add_format();
- $locked->set_locked(1); # A non-op
-
- my $unlocked = $workbook->add_format();
- $locked->set_locked(0);
-
- # Enable worksheet protection
- $worksheet->protect();
-
- # This cell cannot be edited.
- $worksheet->write('A1', '=1+2', $locked);
-
- # This cell can be edited.
- $worksheet->write('A2', '=1+2', $unlocked);
-
-Note: This offers weak protection even with a password, see the note in relation to the C<protect()> method.
-
-
-
-
-=head2 set_hidden()
-
- Default state: Formula hiding is off
- Default action: Turn hiding on
- Valid args: 0, 1
-
-This property is used to hide a formula while still displaying its result. This is generally used to hide complex calculations from end users who are only interested in the result. It only has an effect if the worksheet has been protected, see the worksheet C<protect()> method.
-
- my $hidden = $workbook->add_format();
- $hidden->set_hidden();
-
- # Enable worksheet protection
- $worksheet->protect();
-
- # The formula in this cell isn't visible
- $worksheet->write('A1', '=1+2', $hidden);
-
-
-Note: This offers weak protection even with a password, see the note in relation to the C<protect()> method.
-
-
-
-
-=head2 set_align()
-
- Default state: Alignment is off
- Default action: Left alignment
- Valid args: 'left' Horizontal
- 'center'
- 'right'
- 'fill'
- 'justify'
- 'center_across'
-
- 'top' Vertical
- 'vcenter'
- 'bottom'
- 'vjustify'
-
-This method is used to set the horizontal and vertical text alignment within a cell. Vertical and horizontal alignments can be combined. The method is used as follows:
-
- my $format = $workbook->add_format();
- $format->set_align('center');
- $format->set_align('vcenter');
- $worksheet->set_row(0, 30);
- $worksheet->write(0, 0, "X", $format);
-
-Text can be aligned across two or more adjacent cells using the C<center_across> property. However, for genuine merged cells it is better to use the C<merge_range()> worksheet method.
-
-The C<vjustify> (vertical justify) option can be used to provide automatic text wrapping in a cell. The height of the cell will be adjusted to accommodate the wrapped text. To specify where the text wraps use the C<set_text_wrap()> method.
-
-
-For further examples see the 'Alignment' worksheet created by formats.pl.
-
-
-
-
-=head2 set_center_across()
-
- Default state: Center across selection is off
- Default action: Turn center across on
- Valid args: 1
-
-Text can be aligned across two or more adjacent cells using the C<set_center_across()> method. This is an alias for the C<set_align('center_across')> method call.
-
-Only one cell should contain the text, the other cells should be blank:
-
- my $format = $workbook->add_format();
- $format->set_center_across();
-
- $worksheet->write(1, 1, 'Center across selection', $format);
- $worksheet->write_blank(1, 2, $format);
-
-See also the C<merge1.pl> to C<merge5.pl> programs in the C<examples> directory and the C<merge_range()> method.
-
-
-
-=head2 set_text_wrap()
-
- Default state: Text wrap is off
- Default action: Turn text wrap on
- Valid args: 0, 1
-
-
-Here is an example using the text wrap property, the escape character C<\n> is used to indicate the end of line:
-
- my $format = $workbook->add_format();
- $format->set_text_wrap();
- $worksheet->write(0, 0, "It's\na bum\nwrap", $format);
-
-Excel will adjust the height of the row to accommodate the wrapped text. A similar effect can be obtained without newlines using the C<set_align('vjustify')> method. See the C<textwrap.pl> program in the C<examples> directory.
-
-
-
-
-=head2 set_rotation()
-
- Default state: Text rotation is off
- Default action: None
- Valid args: Integers in the range -90 to 90 and 270
-
-Set the rotation of the text in a cell. The rotation can be any angle in the range -90 to 90 degrees.
-
- my $format = $workbook->add_format();
- $format->set_rotation(30);
- $worksheet->write(0, 0, "This text is rotated", $format);
-
-
-The angle 270 is also supported. This indicates text where the letters run from top to bottom.
-
-
-
-=head2 set_indent()
-
-
- Default state: Text indentation is off
- Default action: Indent text 1 level
- Valid args: Positive integers
-
-
-This method can be used to indent text. The argument, which should be an integer, is taken as the level of indentation:
-
-
- my $format = $workbook->add_format();
- $format->set_indent(2);
- $worksheet->write(0, 0, "This text is indented", $format);
-
-
-Indentation is a horizontal alignment property. It will override any other horizontal properties but it can be used in conjunction with vertical properties.
-
-
-
-
-=head2 set_shrink()
-
-
- Default state: Text shrinking is off
- Default action: Turn "shrink to fit" on
- Valid args: 1
-
-
-This method can be used to shrink text so that it fits in a cell.
-
-
- my $format = $workbook->add_format();
- $format->set_shrink();
- $worksheet->write(0, 0, "Honey, I shrunk the text!", $format);
-
-
-
-
-=head2 set_text_justlast()
-
- Default state: Justify last is off
- Default action: Turn justify last on
- Valid args: 0, 1
-
-
-Only applies to Far Eastern versions of Excel.
-
-
-
-
-=head2 set_pattern()
-
- Default state: Pattern is off
- Default action: Solid fill is on
- Valid args: 0 .. 18
-
-Set the background pattern of a cell.
-
-Examples of the available patterns are shown in the 'Patterns' worksheet created by formats.pl. However, it is unlikely that you will ever need anything other than Pattern 1 which is a solid fill of the background color.
-
-
-
-
-=head2 set_bg_color()
-
- Default state: Color is off
- Default action: Solid fill.
- Valid args: See set_color()
-
-The C<set_bg_color()> method can be used to set the background colour of a pattern. Patterns are defined via the C<set_pattern()> method. If a pattern hasn't been defined then a solid fill pattern is used as the default.
-
-Here is an example of how to set up a solid fill in a cell:
-
- my $format = $workbook->add_format();
-
- $format->set_pattern(); # This is optional when using a solid fill
-
- $format->set_bg_color('green');
- $worksheet->write('A1', 'Ray', $format);
-
-For further examples see the 'Patterns' worksheet created by formats.pl.
-
-
-
-
-=head2 set_fg_color()
-
- Default state: Color is off
- Default action: Solid fill.
- Valid args: See set_color()
-
-
-The C<set_fg_color()> method can be used to set the foreground colour of a pattern.
-
-For further examples see the 'Patterns' worksheet created by formats.pl.
-
-
-
-
-=head2 set_border()
-
- Also applies to: set_bottom()
- set_top()
- set_left()
- set_right()
-
- Default state: Border is off
- Default action: Set border type 1
- Valid args: 0 No border
- 1 Thin single border
- 2 Medium single border
- 3 Dashed border
- 4 Dotted border
- 5 Thick single border
- 6 Double line border
- 7 Hair border
-
-
-A cell border is comprised of a border on the bottom, top, left and right. These can be set to the same value using C<set_border()> or individually using the relevant method calls shown above. Examples of the available border styles are shown in the 'Borders' worksheet created by formats.pl.
-
-
-
-
-=head2 set_border_color()
-
- Also applies to: set_bottom_color()
- set_top_color()
- set_left_color()
- set_right_color()
-
- Default state: Color is off
- Default action: Undefined
- Valid args: See set_color()
-
-
-Set the colour of the cell borders. A cell border is comprised of a border on the bottom, top, left and right. These can be set to the same colour using C<set_border_color()> or individually using the relevant method calls shown above. Examples of the border styles and colours are shown in the 'Borders' worksheet created by formats.pl.
-
-
-
-
-
-=head2 copy($format)
-
-
-This method is used to copy all of the properties from one Format object to another:
-
- my $lorry1 = $workbook->add_format();
- $lorry1->set_bold();
- $lorry1->set_italic();
- $lorry1->set_color('red'); # lorry1 is bold, italic and red
-
- my $lorry2 = $workbook->add_format();
- $lorry2->copy($lorry1);
- $lorry2->set_color('yellow'); # lorry2 is bold, italic and yellow
-
-The C<copy()> method is only useful if you are using the method interface to Format properties. It generally isn't required if you are setting Format properties directly using hashes.
-
-
-Note: this is not a copy constructor, both objects must exist prior to copying.
-
-
-
-
-=head1 COLOURS IN EXCEL
-
-Excel provides a colour palette of 56 colours. In Spreadsheet::WriteExcel these colours are accessed via their palette index in the range 8..63. This index is used to set the colour of fonts, cell patterns and cell borders. For example:
-
- my $format = $workbook->add_format(
- color => 12, # index for blue
- font => 'Arial',
- size => 12,
- bold => 1,
- );
-
-The most commonly used colours can also be accessed by name. The name acts as a simple alias for the colour index:
-
- black => 8
- blue => 12
- brown => 16
- cyan => 15
- gray => 23
- green => 17
- lime => 11
- magenta => 14
- navy => 18
- orange => 53
- purple => 20
- red => 10
- silver => 22
- white => 9
- yellow => 13
-
-For example:
-
- my $font = $workbook->add_format(color => 'red');
-
-Users of VBA in Excel should note that the equivalent colour indices are in the range 1..56 instead of 8..63.
-
-If the default palette does not provide a required colour you can override one of the built-in values. This is achieved by using the C<set_custom_color()> workbook method to adjust the RGB (red green blue) components of the colour:
-
- my $ferrari = $workbook->set_custom_color(40, 216, 12, 12);
-
- my $format = $workbook->add_format(
- bg_color => $ferrari,
- pattern => 1,
- border => 1
- );
-
- $worksheet->write_blank('A1', $format);
-
-The default Excel 97 colour palette is shown in C<palette.html> in the C<doc> directory of the distro. You can generate an Excel version of the palette using C<colors.pl> in the C<examples> directory.
-
-A comparison of the colour components in the Excel 5 and Excel 97+ colour palettes is shown in C<rgb5-97.txt> in the C<doc> directory.
-
-
-You may also find the following links helpful:
-
-A detailed look at Excel's colour palette: http://www.geocities.com/davemcritchie/excel/colors.htm
-
-A decimal RGB chart: http://www.hypersolutions.org/pages/rgbdec.html
-
-A hex RGB chart: : http://www.hypersolutions.org/pages/rgbhex.html
-
-
-
-=head1 DATES IN EXCEL
-
-
-Dates and times in Excel are represented by real numbers, for example "Jan 1 2001 12:30 AM" is represented by the number 36892.521.
-
-The integer part of the number stores the number of days since the epoch and the fractional part stores the percentage of the day.
-
-The epoch can be either 1900 or 1904. Excel for Windows uses 1900 and Excel for Macintosh uses 1904. The epochs are:
-
- 1900: 0 January 1900 i.e. 31 December 1899
- 1904: 1 January 1904
-
-By default Spreadsheet::WriteExcel uses the Windows/1900 format although it generally isn't an issue since Excel on Windows and the Macintosh will convert automatically between one system and the other. To use the 1904 epoch you must use the C<set_1904()> workbook method.
-
-There are two things to note about the 1900 date format. The first is that the epoch starts on 0 January 1900. The second is that the year 1900 is erroneously but deliberately treated as a leap year. Therefore you must add an extra day to dates after 28 February 1900. The reason for this anomaly is explained at http://support.microsoft.com/support/kb/articles/Q181/3/70.asp
-
-A date or time in Excel is like any other number. To display the number as a date you must apply a number format to it. Refer to the C<set_num_format()> method above:
-
- $format->set_num_format('mmm d yyyy hh:mm AM/PM');
- $worksheet->write('A1', 36892.521 , $format); # Jan 1 2001 12:30 AM
-
-You can also use the C<write_date_time()> worksheet method to write dates in ISO8601 date format.
-
- $worksheet->write_date_time('A2', '2001-01-01T12:20', format);
-
-See the C<write_date_time()> section of the documentation for more details.
-
-See also the C<Spreadsheet::WriteExcel::Utility> module that is included in the distro and which includes date handling functions and the DateTime::Format::Excel module, http://search.cpan.org/search?dist=DateTime-Format-Excel which is part of the DateTime project and which deals specifically with converting dates and times to and from Excel's format.
-
-
-
-
-=head1 OUTLINES AND GROUPING IN EXCEL
-
-
-Excel allows you to group rows or columns so that they can be hidden or displayed with a single mouse click. This feature is referred to as outlines.
-
-Outlines can reduce complex data down to a few salient sub-totals or summaries.
-
-This feature is best viewed in Excel but the following is an ASCII representation of what a worksheet with three outlines might look like. Rows 3-4 and rows 7-8 are grouped at level 2. Rows 2-9 are grouped at level 1. The lines at the left hand side are called outline level bars.
-
-
- ------------------------------------------
- 1 2 3 | | A | B | C | D | ...
- ------------------------------------------
- _ | 1 | A | | | | ...
- | _ | 2 | B | | | | ...
- | | | 3 | (C) | | | | ...
- | | | 4 | (D) | | | | ...
- | - | 5 | E | | | | ...
- | _ | 6 | F | | | | ...
- | | | 7 | (G) | | | | ...
- | | | 8 | (H) | | | | ...
- | - | 9 | I | | | | ...
- - | . | ... | ... | ... | ... | ...
-
-
-Clicking the minus sign on each of the level 2 outlines will collapse and hide the data as shown in the next figure. The minus sign changes to a plus sign to indicate that the data in the outline is hidden.
-
- ------------------------------------------
- 1 2 3 | | A | B | C | D | ...
- ------------------------------------------
- _ | 1 | A | | | | ...
- | | 2 | B | | | | ...
- | + | 5 | E | | | | ...
- | | 6 | F | | | | ...
- | + | 9 | I | | | | ...
- - | . | ... | ... | ... | ... | ...
-
-
-Clicking on the minus sign on the level 1 outline will collapse the remaining rows as follows:
-
- ------------------------------------------
- 1 2 3 | | A | B | C | D | ...
- ------------------------------------------
- | 1 | A | | | | ...
- + | . | ... | ... | ... | ... | ...
-
-
-Grouping in C<Spreadsheet::WriteExcel> is achieved by setting the outline level via the C<set_row()> and C<set_column()> worksheet methods:
-
- set_row($row, $height, $format, $hidden, $level)
- set_column($first_col, $last_col, $width, $format, $hidden, $level)
-
-The following example sets an outline level of 1 for rows 1 and 2 (zero-indexed) and columns B to G. The parameters C<$height> and C<$XF> are assigned default values since they are undefined:
-
- $worksheet->set_row(1, undef, undef, 0, 1);
- $worksheet->set_row(2, undef, undef, 0, 1);
- $worksheet->set_column('B:G', undef, undef, 0, 1);
-
-Excel allows up to 7 outline levels. Therefore the C<$level> parameter should be in the range C<0 E<lt>= $level E<lt>= 7>.
-
-Rows and columns can be collapsed by setting the C<$hidden> flag:
-
- $worksheet->set_row(1, undef, undef, 1, 1);
- $worksheet->set_row(2, undef, undef, 1, 1);
- $worksheet->set_column('B:G', undef, undef, 1, 1);
-
-For a more complete example see the C<outline.pl> program in the examples directory of the distro.
-
-Some additional outline properties can be set via the C<outline_settings()> worksheet method, see above.
-
-
-
-
-=head1 FORMULAS AND FUNCTIONS IN EXCEL
-
-
-=head2 Caveats
-
-The first thing to note is that there are still some outstanding issues with the implementation of formulas and functions:
-
- 1. Writing a formula is much slower than writing the equivalent string.
- 2. You cannot use array constants, i.e. {1;2;3}, in functions.
- 3. Unary minus isn't supported.
- 4. Whitespace is not preserved around operators.
- 5. Named ranges are not supported.
- 6. Array formulas are not supported.
-
-However, these constraints will be removed in future versions. They are here because of a trade-off between features and time. Also, it is possible to work around issue 1 using the C<store_formula()> and C<repeat_formula()> methods as described later in this section.
-
-
-
-=head2 Introduction
-
-The following is a brief introduction to formulas and functions in Excel and Spreadsheet::WriteExcel.
-
-A formula is a string that begins with an equals sign:
-
- '=A1+B1'
- '=AVERAGE(1, 2, 3)'
-
-The formula can contain numbers, strings, boolean values, cell references, cell ranges and functions. Named ranges are not supported. Formulas should be written as they appear in Excel, that is cells and functions must be in uppercase.
-
-Cells in Excel are referenced using the A1 notation system where the column is designated by a letter and the row by a number. Columns range from A to IV i.e. 0 to 255, rows range from 1 to 65536. The C<Spreadsheet::WriteExcel::Utility> module that is included in the distro contains helper functions for dealing with A1 notation, for example:
-
- use Spreadsheet::WriteExcel::Utility;
-
- ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
- $str = xl_rowcol_to_cell(1, 2); # C2
-
-The Excel C<$> notation in cell references is also supported. This allows you to specify whether a row or column is relative or absolute. This only has an effect if the cell is copied. The following examples show relative and absolute values.
-
- '=A1' # Column and row are relative
- '=$A1' # Column is absolute and row is relative
- '=A$1' # Column is relative and row is absolute
- '=$A$1' # Column and row are absolute
-
-Formulas can also refer to cells in other worksheets of the current workbook. For example:
-
- '=Sheet2!A1'
- '=Sheet2!A1:A5'
- '=Sheet2:Sheet3!A1'
- '=Sheet2:Sheet3!A1:A5'
- q{='Test Data'!A1}
- q{='Test Data1:Test Data2'!A1}
-
-The sheet reference and the cell reference are separated by C<!> the exclamation mark symbol. If worksheet names contain spaces, commas o parentheses then Excel requires that the name is enclosed in single quotes as shown in the last two examples above. In order to avoid using a lot of escape characters you can use the quote operator C<q{}> to protect the quotes. See C<perlop> in the main Perl documentation. Only valid sheet names that have been added using the C<add_worksheet()> method can be used in formulas. You cannot reference external workbooks.
-
-
-The following table lists the operators that are available in Excel's formulas. The majority of the operators are the same as Perl's, differences are indicated:
-
- Arithmetic operators:
- =====================
- Operator Meaning Example
- + Addition 1+2
- - Subtraction 2-1
- * Multiplication 2*3
- / Division 1/4
- ^ Exponentiation 2^3 # Equivalent to **
- - Unary minus -(1+2) # Not yet supported
- % Percent (Not modulus) 13% # Not supported, [1]
-
-
- Comparison operators:
- =====================
- Operator Meaning Example
- = Equal to A1 = B1 # Equivalent to ==
- <> Not equal to A1 <> B1 # Equivalent to !=
- > Greater than A1 > B1
- < Less than A1 < B1
- >= Greater than or equal to A1 >= B1
- <= Less than or equal to A1 <= B1
-
-
- String operator:
- ================
- Operator Meaning Example
- & Concatenation "Hello " & "World!" # [2]
-
-
- Reference operators:
- ====================
- Operator Meaning Example
- : Range operator A1:A4 # [3]
- , Union operator SUM(1, 2+2, B3) # [4]
-
-
- Notes:
- [1]: You can get a percentage with formatting and modulus with MOD().
- [2]: Equivalent to ("Hello " . "World!") in Perl.
- [3]: This range is equivalent to cells A1, A2, A3 and A4.
- [4]: The comma behaves like the list separator in Perl.
-
-The range and comma operators can have different symbols in non-English versions of Excel. These will be supported in a later version of Spreadsheet::WriteExcel. European users of Excel take note:
-
- $worksheet->write('A1', '=SUM(1; 2; 3)'); # Wrong!!
- $worksheet->write('A1', '=SUM(1, 2, 3)'); # Okay
-
-The following table lists all of the core functions supported by Excel 5 and Spreadsheet::WriteExcel. Any additional functions that are available through the "Analysis ToolPak" or other add-ins are not supported. These functions have all been tested to verify that they work.
-
- ABS DB INDIRECT NORMINV SLN
- ACOS DCOUNT INFO NORMSDIST SLOPE
- ACOSH DCOUNTA INT NORMSINV SMALL
- ADDRESS DDB INTERCEPT NOT SQRT
- AND DEGREES IPMT NOW STANDARDIZE
- AREAS DEVSQ IRR NPER STDEV
- ASIN DGET ISBLANK NPV STDEVP
- ASINH DMAX ISERR ODD STEYX
- ATAN DMIN ISERROR OFFSET SUBSTITUTE
- ATAN2 DOLLAR ISLOGICAL OR SUBTOTAL
- ATANH DPRODUCT ISNA PEARSON SUM
- AVEDEV DSTDEV ISNONTEXT PERCENTILE SUMIF
- AVERAGE DSTDEVP ISNUMBER PERCENTRANK SUMPRODUCT
- BETADIST DSUM ISREF PERMUT SUMSQ
- BETAINV DVAR ISTEXT PI SUMX2MY2
- BINOMDIST DVARP KURT PMT SUMX2PY2
- CALL ERROR.TYPE LARGE POISSON SUMXMY2
- CEILING EVEN LEFT POWER SYD
- CELL EXACT LEN PPMT T
- CHAR EXP LINEST PROB TAN
- CHIDIST EXPONDIST LN PRODUCT TANH
- CHIINV FACT LOG PROPER TDIST
- CHITEST FALSE LOG10 PV TEXT
- CHOOSE FDIST LOGEST QUARTILE TIME
- CLEAN FIND LOGINV RADIANS TIMEVALUE
- CODE FINV LOGNORMDIST RAND TINV
- COLUMN FISHER LOOKUP RANK TODAY
- COLUMNS FISHERINV LOWER RATE TRANSPOSE
- COMBIN FIXED MATCH REGISTER.ID TREND
- CONCATENATE FLOOR MAX REPLACE TRIM
- CONFIDENCE FORECAST MDETERM REPT TRIMMEAN
- CORREL FREQUENCY MEDIAN RIGHT TRUE
- COS FTEST MID ROMAN TRUNC
- COSH FV MIN ROUND TTEST
- COUNT GAMMADIST MINUTE ROUNDDOWN TYPE
- COUNTA GAMMAINV MINVERSE ROUNDUP UPPER
- COUNTBLANK GAMMALN MIRR ROW VALUE
- COUNTIF GEOMEAN MMULT ROWS VAR
- COVAR GROWTH MOD RSQ VARP
- CRITBINOM HARMEAN MODE SEARCH VDB
- DATE HLOOKUP MONTH SECOND VLOOKUP
- DATEVALUE HOUR N SIGN WEEKDAY
- DAVERAGE HYPGEOMDIST NA SIN WEIBULL
- DAY IF NEGBINOMDIST SINH YEAR
- DAYS360 INDEX NORMDIST SKEW ZTEST
-
-You can also modify the module to support function names in the following languages: German, French, Spanish, Portuguese, Dutch, Finnish, Italian and Swedish. See the C<function_locale.pl> program in the C<examples> directory of the distro.
-
-For a general introduction to Excel's formulas and an explanation of the syntax of the function refer to the Excel help files or the following links: http://msdn.microsoft.com/library/default.asp?URL=/library/officedev/office97/s88f2.htm and http://msdn.microsoft.com/library/default.asp?URL=/library/en-us/office97/s992f.htm
-
-
-If your formula doesn't work in Spreadsheet::WriteExcel try the following:
-
- 1. Verify that the formula works in Excel (or Gnumeric or OpenOffice.org).
- 2. Ensure that it isn't on the Caveats list shown above.
- 3. Ensure that cell references and formula names are in uppercase.
- 4. Ensure that you are using ':' as the range operator, A1:A4.
- 5. Ensure that you are using ',' as the union operator, SUM(1,2,3).
- 6. Ensure that the function is in the above table.
-
-If you go through steps 1-6 and you still have a problem, mail me.
-
-
-
-
-=head2 Improving performance when working with formulas
-
-Writing a large number of formulas with Spreadsheet::WriteExcel can be slow. This is due to the fact that each formula has to be parsed and with the current implementation this is computationally expensive.
-
-However, in a lot of cases the formulas that you write will be quite similar, for example:
-
- $worksheet->write_formula('B1', '=A1 * 3 + 50', $format);
- $worksheet->write_formula('B2', '=A2 * 3 + 50', $format);
- ...
- ...
- $worksheet->write_formula('B99', '=A999 * 3 + 50', $format);
- $worksheet->write_formula('B1000', '=A1000 * 3 + 50', $format);
-
-In this example the cell reference changes in iterations from C<A1> to C<A1000>. The parser treats this variable as a I<token> and arranges it according to predefined rules. However, since the parser is oblivious to the value of the token, it is essentially performing the same calculation 1000 times. This is inefficient.
-
-The way to avoid this inefficiency and thereby speed up the writing of formulas is to parse the formula once and then repeatedly substitute similar tokens.
-
-A formula can be parsed and stored via the C<store_formula()> worksheet method. You can then use the C<repeat_formula()> method to substitute C<$pattern>, C<$replace> pairs in the stored formula:
-
- my $formula = $worksheet->store_formula('=A1 * 3 + 50');
-
- for my $row (0..999) {
- $worksheet->repeat_formula($row, 1, $formula, $format, 'A1', 'A'.($row +1));
- }
-
-On an arbitrary test machine this method was 10 times faster than the brute force method shown above.
-
-For more information about how Spreadsheet::WriteExcel parses and stores formulas see the C<Spreadsheet::WriteExcel::Formula> man page.
-
-It should be noted however that the overall speed of direct formula parsing will be improved in a future version.
-
-
-
-
-=head1 EXAMPLES
-
-
-
-
-=head2 Example 1
-
-The following example shows some of the basic features of Spreadsheet::WriteExcel.
-
-
- #!/usr/bin/perl -w
-
- use strict;
- use Spreadsheet::WriteExcel;
-
- # Create a new workbook called simple.xls and add a worksheet
- my $workbook = Spreadsheet::WriteExcel->new("simple.xls");
- my $worksheet = $workbook->add_worksheet();
-
- # The general syntax is write($row, $column, $token). Note that row and
- # column are zero indexed
-
- # Write some text
- $worksheet->write(0, 0, "Hi Excel!");
-
-
- # Write some numbers
- $worksheet->write(2, 0, 3); # Writes 3
- $worksheet->write(3, 0, 3.00000); # Writes 3
- $worksheet->write(4, 0, 3.00001); # Writes 3.00001
- $worksheet->write(5, 0, 3.14159); # TeX revision no.?
-
-
- # Write some formulas
- $worksheet->write(7, 0, '=A3 + A6');
- $worksheet->write(8, 0, '=IF(A5>3,"Yes", "No")');
-
-
- # Write a hyperlink
- $worksheet->write(10, 0, 'http://www.perl.com/');
-
-
-
-
-=head2 Example 2
-
-The following is a general example which demonstrates some features of working with multiple worksheets.
-
- #!/usr/bin/perl -w
-
- use strict;
- use Spreadsheet::WriteExcel;
-
- # Create a new Excel workbook
- my $workbook = Spreadsheet::WriteExcel->new("regions.xls");
-
- # Add some worksheets
- my $north = $workbook->add_worksheet("North");
- my $south = $workbook->add_worksheet("South");
- my $east = $workbook->add_worksheet("East");
- my $west = $workbook->add_worksheet("West");
-
- # Add a Format
- my $format = $workbook->add_format();
- $format->set_bold();
- $format->set_color('blue');
-
- # Add a caption to each worksheet
- foreach my $worksheet ($workbook->sheets()) {
- $worksheet->write(0, 0, "Sales", $format);
- }
-
- # Write some data
- $north->write(0, 1, 200000);
- $south->write(0, 1, 100000);
- $east->write (0, 1, 150000);
- $west->write (0, 1, 100000);
-
- # Set the active worksheet
- $south->activate();
-
- # Set the width of the first column
- $south->set_column(0, 0, 20);
-
- # Set the active cell
- $south->set_selection(0, 1);
-
-
-
-
-=head2 Example 3
-
-This example shows how to use a conditional numerical format with colours to indicate if a share price has gone up or down.
-
- use strict;
- use Spreadsheet::WriteExcel;
-
- # Create a new workbook and add a worksheet
- my $workbook = Spreadsheet::WriteExcel->new("stocks.xls");
- my $worksheet = $workbook->add_worksheet();
-
- # Set the column width for columns 1, 2, 3 and 4
- $worksheet->set_column(0, 3, 15);
-
-
- # Create a format for the column headings
- my $header = $workbook->add_format();
- $header->set_bold();
- $header->set_size(12);
- $header->set_color('blue');
-
-
- # Create a format for the stock price
- my $f_price = $workbook->add_format();
- $f_price->set_align('left');
- $f_price->set_num_format('$0.00');
-
-
- # Create a format for the stock volume
- my $f_volume = $workbook->add_format();
- $f_volume->set_align('left');
- $f_volume->set_num_format('#,##0');
-
-
- # Create a format for the price change. This is an example of a
- # conditional format. The number is formatted as a percentage. If it is
- # positive it is formatted in green, if it is negative it is formatted
- # in red and if it is zero it is formatted as the default font colour
- # (in this case black). Note: the [Green] format produces an unappealing
- # lime green. Try [Color 10] instead for a dark green.
- #
- my $f_change = $workbook->add_format();
- $f_change->set_align('left');
- $f_change->set_num_format('[Green]0.0%;[Red]-0.0%;0.0%');
-
-
- # Write out the data
- $worksheet->write(0, 0, 'Company',$header);
- $worksheet->write(0, 1, 'Price', $header);
- $worksheet->write(0, 2, 'Volume', $header);
- $worksheet->write(0, 3, 'Change', $header);
-
- $worksheet->write(1, 0, 'Damage Inc.' );
- $worksheet->write(1, 1, 30.25, $f_price ); # $30.25
- $worksheet->write(1, 2, 1234567, $f_volume); # 1,234,567
- $worksheet->write(1, 3, 0.085, $f_change); # 8.5% in green
-
- $worksheet->write(2, 0, 'Dump Corp.' );
- $worksheet->write(2, 1, 1.56, $f_price ); # $1.56
- $worksheet->write(2, 2, 7564, $f_volume); # 7,564
- $worksheet->write(2, 3, -0.015, $f_change); # -1.5% in red
-
- $worksheet->write(3, 0, 'Rev Ltd.' );
- $worksheet->write(3, 1, 0.13, $f_price ); # $0.13
- $worksheet->write(3, 2, 321, $f_volume); # 321
- $worksheet->write(3, 3, 0, $f_change); # 0 in the font color (black)
-
-
-
-
-=head2 Example 4
-
-The following is a simple example of using functions.
-
- #!/usr/bin/perl -w
-
- use strict;
- use Spreadsheet::WriteExcel;
-
- # Create a new workbook and add a worksheet
- my $workbook = Spreadsheet::WriteExcel->new("stats.xls");
- my $worksheet = $workbook->add_worksheet('Test data');
-
- # Set the column width for columns 1
- $worksheet->set_column(0, 0, 20);
-
-
- # Create a format for the headings
- my $format = $workbook->add_format();
- $format->set_bold();
-
-
- # Write the sample data
- $worksheet->write(0, 0, 'Sample', $format);
- $worksheet->write(0, 1, 1);
- $worksheet->write(0, 2, 2);
- $worksheet->write(0, 3, 3);
- $worksheet->write(0, 4, 4);
- $worksheet->write(0, 5, 5);
- $worksheet->write(0, 6, 6);
- $worksheet->write(0, 7, 7);
- $worksheet->write(0, 8, 8);
-
- $worksheet->write(1, 0, 'Length', $format);
- $worksheet->write(1, 1, 25.4);
- $worksheet->write(1, 2, 25.4);
- $worksheet->write(1, 3, 24.8);
- $worksheet->write(1, 4, 25.0);
- $worksheet->write(1, 5, 25.3);
- $worksheet->write(1, 6, 24.9);
- $worksheet->write(1, 7, 25.2);
- $worksheet->write(1, 8, 24.8);
-
- # Write some statistical functions
- $worksheet->write(4, 0, 'Count', $format);
- $worksheet->write(4, 1, '=COUNT(B1:I1)');
-
- $worksheet->write(5, 0, 'Sum', $format);
- $worksheet->write(5, 1, '=SUM(B2:I2)');
-
- $worksheet->write(6, 0, 'Average', $format);
- $worksheet->write(6, 1, '=AVERAGE(B2:I2)');
-
- $worksheet->write(7, 0, 'Min', $format);
- $worksheet->write(7, 1, '=MIN(B2:I2)');
-
- $worksheet->write(8, 0, 'Max', $format);
- $worksheet->write(8, 1, '=MAX(B2:I2)');
-
- $worksheet->write(9, 0, 'Standard Deviation', $format);
- $worksheet->write(9, 1, '=STDEV(B2:I2)');
-
- $worksheet->write(10, 0, 'Kurtosis', $format);
- $worksheet->write(10, 1, '=KURT(B2:I2)');
-
-
-
-=head2 Example 5
-
-The following example converts a tab separated file called C<tab.txt> into an Excel file called C<tab.xls>.
-
- #!/usr/bin/perl -w
-
- use strict;
- use Spreadsheet::WriteExcel;
-
- open (TABFILE, "tab.txt") or die "tab.txt: $!";
-
- my $workbook = Spreadsheet::WriteExcel->new("tab.xls");
- my $worksheet = $workbook->add_worksheet();
-
- # Row and column are zero indexed
- my $row = 0;
-
- while (<TABFILE>) {
- chomp;
- # Split on single tab
- my @Fld = split('\t', $_);
-
- my $col = 0;
- foreach my $token (@Fld) {
- $worksheet->write($row, $col, $token);
- $col++;
- }
- $row++;
- }
-
-
-=head2 Additional Examples
-
-If you performed a normal installation the following examples files should have been copied to your C<~site/Spreadsheet/WriteExcel/examples> directory:
-
-The following is a description of the example files that are provided
-with Spreadsheet::WriteExcel. They are intended to demonstrate the
-different features and options of the module.
-
-
- Getting started
- ===============
- bug_report.pl A template for submitting bug reports.
- demo.pl Creates a demo of some of the features.
- formats.pl Creates a demo of the available formatting.
- regions.pl Demonstrates multiple worksheets.
- simple.pl An example of some of the basic features.
- stats.pl Basic formulas and functions.
-
- Advanced
- ========
- bigfile.pl Write past the 7MB limit with OLE::Storage_Lite.
- cgi.pl A simple CGI program.
- chess.pl An example of formatting using properties.
- colors.pl Demo of the colour palette and named colours.
- copyformat.pl Example of copying a cell format.
- diag_border.pl A simple example of diagonal cell borders.
- easter_egg.pl Expose the Excel97 flight simulator. A must see.
- filehandle.pl Examples of working with filehandles.
- headers.pl Examples of worksheet headers and footers.
- hyperlink1.pl Shows how to create web hyperlinks.
- hyperlink2.pl Examples of internal and external hyperlinks.
- images.pl Adding bitmap images to worksheets.
- indent.pl An example of cell indentation.
- merge1.pl A simple example of cell merging.
- merge2.pl A simple example of cell merging with formatting.
- merge3.pl Add hyperlinks to merged cells.
- merge4.pl An advanced example of merging with formatting.
- merge5.pl An advanced example of merging with formatting.
- mod_perl1.pl A simple mod_perl 1 program.
- mod_perl2.pl A simple mod_perl 2 program.
- outline.pl An example of outlines and grouping.
- panes.pl An examples of how to create panes.
- protection.pl Example of cell locking and formula hiding.
- repeat.pl Example of writing repeated formulas.
- sales.pl An example of a simple sales spreadsheet.
- sendmail.pl Send an Excel email attachment using Mail::Sender.
- stats_ext.pl Same as stats.pl with external references.
- stocks.pl Demonstrates conditional formatting.
- textwrap.pl Demonstrates text wrapping options.
- win32ole.pl A sample Win32::OLE example for comparison.
- write_arrays.pl Example of writing 1D or 2D arrays of data.
- write_to_scalar.pl Example of writing an Excel file to a Perl scalar.
- write_handler1.pl Example of extending the write() method. Step 1.
- write_handler2.pl Example of extending the write() method. Step 2.
- write_handler3.pl Example of extending the write() method. Step 3.
- write_handler4.pl Example of extending the write() method. Step 4.
-
- Unicode
- =======
- unicode.pl Simple example of using Unicode UTF16 strings.
- unicode_japan.pl Write Japanese Unicode strings using UTF16.
- unicode_list.pl List the chars in a Unicode font.
- unicode_2022_jp.pl Japanese: ISO-2022-JP to utf8 in perl 5.8.
- unicode_8859_11.pl Thai: ISO-8859_11 to utf8 in perl 5.8.
- unicode_8859_7.pl Greek: ISO-8859_7 to utf8 in perl 5.8.
- unicode_big5.pl Chinese: BIG5 to utf8 in perl 5.8.
- unicode_cp1251.pl Russian: CP1251 to utf8 in perl 5.8.
- unicode_cp1256.pl Arabic: CP1256 to utf8 in perl 5.8.
- unicode_koi8r.pl Russian: KOI8-R to utf8 in perl 5.8.
- unicode_polish_utf8.pl Polish : UTF8 to utf8 in perl 5.8.
- unicode_shift_jis.pl Japanese: Shift JIS to utf8 in perl 5.8.
-
-
- Utility
- =======
- csv2xls.pl Program to convert a CSV file to an Excel file.
- datecalc1.pl Convert Unix/Perl time to Excel time.
- datecalc2.pl Calculate an Excel date using Date::Calc.
- lecxe.pl Convert Excel to WriteExcel using Win32::OLE.
- tab2xls.pl Program to convert a tab separated file to xls.
-
-
- Developer
- =========
- convertA1.pl Helper functions for dealing with A1 notation.
- function_locale.pl Add non-English function names to Formula.pm.
- writeA1.pl Example of how to extend the module.
-
-
-
-
-
-=head1 LIMITATIONS
-
-The following limits are imposed by Excel:
-
- Description Limit
- ----------------------------------- ------
- Maximum number of chars in a string 32767
- Maximum number of columns 256
- Maximum number of rows 65536
- Maximum chars in a sheet name 31
- Maximum chars in a header/footer 254
-
-
-The minimum file size is 6K due to the OLE overhead. The maximum file size is approximately 7MB (7087104 bytes) of BIFF data. This can be extended by using Takanori Kawai's OLE::Storage_Lite module http://search.cpan.org/search?dist=OLE-Storage_Lite see the C<bigfile.pl> example in the C<examples> directory of the distro.
-
-
-
-
-=head1 DOWNLOADING
-
-The latest version of this module is always available at: http://search.cpan.org/search?dist=Spreadsheet-WriteExcel/
-
-
-
-
-=head1 REQUIREMENTS
-
-This module requires Perl 5.005 (or later), Parse::RecDescent and File::Temp:
-
- http://search.cpan.org/search?dist=Parse-RecDescent/
- http://search.cpan.org/search?dist=File-Temp/
-
-
-
-
-=head1 INSTALLATION
-
-See the INSTALL or install.html docs that come with the distribution or:
-
-http://search.cpan.org/doc/JMCNAMARA/Spreadsheet-WriteExcel-2.11/WriteExcel/doc/install.html
-
-
-
-
-=head1 PORTABILITY
-
-Spreadsheet::WriteExcel will work on the majority of Windows, UNIX and Macintosh platforms. Specifically, the module will work on any system where perl packs floats in the 64 bit IEEE format. The float must also be in little-endian format but it will be reversed if necessary. Thus:
-
- print join(" ", map { sprintf "%#02x", $_ } unpack("C*", pack "d", 1.2345)), "\n";
-
-should give (or in reverse order):
-
- 0x8d 0x97 0x6e 0x12 0x83 0xc0 0xf3 0x3f
-
-In general, if you don't know whether your system supports a 64 bit IEEE float or not, it probably does. If your system doesn't, WriteExcel will C<croak()> with the message given in the L<DIAGNOSTICS> section. You can check which platforms the module has been tested on at the CPAN testers site: http://testers.cpan.org/search?request=dist&dist=Spreadsheet-WriteExcel
-
-
-
-
-=head1 DIAGNOSTICS
-
-
-=over 4
-
-=item Filename required by Spreadsheet::WriteExcel->new()
-
-A filename must be given in the constructor.
-
-=item Can't open filename. It may be in use or protected.
-
-The file cannot be opened for writing. The directory that you are writing to may be protected or the file may be in use by another program.
-
-=item Unable to create tmp files via File::Temp::tempfile()...
-
-This is a C<-w> warning. You will see it if you are using Spreadsheet::WriteExcel in an environment where temporary files cannot be created, in which case all data will be stored in memory. The warning is for information only: it does not affect creation but it will affect the speed of execution for large files. See the C<set_tempdir> workbook method.
-
-
-=item Maximum file size, 7087104, exceeded.
-
-The current OLE implementation only supports a maximum BIFF file of this size. This limit can be extended, see the L<LIMITATIONS> section.
-
-=item Can't locate Parse/RecDescent.pm in @INC ...
-
-Spreadsheet::WriteExcel requires the Parse::RecDescent module. Download it from CPAN: http://search.cpan.org/search?dist=Parse-RecDescent
-
-=item Couldn't parse formula ...
-
-There are a large number of warnings which relate to badly formed formulas and functions. See the L<FORMULAS AND FUNCTIONS IN EXCEL> section for suggestions on how to avoid these errors. You should also check the formula in Excel to ensure that it is valid.
-
-=item Required floating point format not supported on this platform.
-
-Operating system doesn't support 64 bit IEEE float or it is byte-ordered in a way unknown to WriteExcel.
-
-
-=item 'file.xls' cannot be accessed. The file may be read-only ...
-
-You may sometimes encounter the following error when trying to open a file in Excel: "file.xls cannot be accessed. The file may be read-only, or you may be trying to access a read-only location. Or, the server the document is stored on may not be responding."
-
-This error generally means that the Excel file has been corrupted. There are two likely causes of this: the file was FTPed in ASCII mode instead of binary mode or else the file was created with UTF8 data returned by an XML parser. See L<WORKING WITH XML> for further details.
-
-=back
-
-
-
-
-=head1 THE EXCEL BINARY FORMAT
-
-The following is some general information about the Excel binary format for anyone who may be interested.
-
-Excel data is stored in the "Binary Interchange File Format" (BIFF) file format. Details of this format are given in the Excel SDK, the "Excel Developer's Kit" from Microsoft Press. It is also included in the MSDN CD library but is no longer available on the MSDN website. Versions of the BIFF documentation are available at www.wotsit.org, http://www.wotsit.org/search.asp?page=2&s=database
-
-Charles Wybble has collected together almost all of the available information about the Excel file format. See "The Chicago Project" at http://chicago.sourceforge.net/devel/
-
-Daniel Rentz of OpenOffice.org has also written a detailed description of the Excel workbook records, see http://sc.openoffice.org/excelfileformat.pdf
-
-The BIFF portion of the Excel file is comprised of contiguous binary records that have different functions and that hold different types of data. Each BIFF record is comprised of the following three parts:
-
- Record name; Hex identifier, length = 2 bytes
- Record length; Length of following data, length = 2 bytes
- Record data; Data, length = variable
-
-The BIFF data is stored along with other data in an OLE Compound File. This is a structured storage which acts like a file system within a file. A Compound File is comprised of storages and streams which, to follow the file system analogy, are like directories and files.
-
-The documentation for the OLE::Storage module, http://user.cs.tu-berlin.de/~schwartz/pmh/guide.html , contains one of the few descriptions of the OLE Compound File in the public domain. The Digital Imaging Group have also detailed the OLE format in the JPEG2000 specification: see Appendix A of http://www.i3a.org/pdf/wg1n1017.pdf
-
-For a open source implementation of the OLE library see the 'cole' library at http://atena.com/libole2.php
-
-The source code for the Excel plugin of the Gnumeric spreadsheet also contains information relevant to the Excel BIFF format and the OLE container, http://www.gnome.org/projects/gnumeric/ and ftp://ftp.ximian.com/pub/ximian-source/
-
-In addition the source code for OpenOffice.org is available at http://www.openoffice.org/
-
-An article describing Spreadsheet::WriteExcel and how it works appears in Issue #19 of The Perl Journal, http://www.samag.com/documents/s=1272/sam05030004/ It is reproduced, by kind permission, in the C<doc> directory of the distro.
-
-
-Please note that the provision of this information does not constitute an invitation to start hacking at the BIFF or OLE file formats. There are more interesting ways to waste your time. ;-)
-
-
-
-
-=head1 WRITING EXCEL FILES
-
-Depending on your requirements, background and general sensibilities you may prefer one of the following methods of getting data into Excel:
-
-=over 4
-
-=item * Win32::OLE module and office automation
-
-This requires a Windows platform and an installed copy of Excel. This is the most powerful and complete method for interfacing with Excel. See http://www.activestate.com/ASPN/Reference/Products/ActivePerl-5.6/faq/Windows/ActivePerl-Winfaq12.html and http://www.activestate.com/ASPN/Reference/Products/ActivePerl-5.6/site/lib/Win32/OLE.html If your main platform is UNIX but you have the resources to set up a separate Win32/MSOffice server, you can convert office documents to text, postscript or PDF using Win32::OLE. For a demonstration of how to do this using Perl see Docserver: http://search.cpan.org/search?mode=module&query=docserver
-
-=item * CSV, comma separated variables or text
-
-If the file extension is C<csv>, Excel will open and convert this format automatically. Generating a valid CSV file isn't as easy as it seems. Have a look at the DBD::RAM, DBD::CSV, Text::xSV and Text::CSV_XS modules.
-
-=item * DBI with DBD::ADO or DBD::ODBC
-
-Excel files contain an internal index table that allows them to act like a database file. Using one of the standard Perl database modules you can connect to an Excel file as a database.
-
-=item * DBD::Excel
-
-You can also access Spreadsheet::WriteExcel using the standard DBI interface via Takanori Kawai's DBD::Excel module http://search.cpan.org/search?dist=DBD-Excel.
-
-=item * Spreadsheet::WriteExcelXML
-
-This module allows you to create an Excel XML file using the same interface as Spreadsheet::WriteExcel. See: http://search.cpan.org/dist/Spreadsheet-WriteExcelXML
-
-=item * Spreadsheet::WriteExcel::FromXML
-
-This module allows you to turn a simple XML file into an Excel file using Spreadsheet::WriteExcel as a backend. The format of the XML file is defined by a supplied DTD: http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromXML
-
-=item * Spreadsheet::WriteExcel::Simple
-
-This provides an easier interface to Spreadsheet::WriteExcel: http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-Simple
-
-=item * Spreadsheet::WriteExcel::FromDB
-
-This is a useful module for creating Excel files directly from a DB table: http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-FromDB
-
-=item * HTML tables
-
-This is an easy way of adding formatting via a text based format.
-
-=item * XML or HTML
-
-The Excel XML and HTML file specification are available from http://msdn.microsoft.com/library/officedev/ofxml2k/ofxml2k.htm
-
-=back
-
-For other Perl-Excel modules try the following search: http://search.cpan.org/search?mode=module&query=excel
-
-
-
-
-=head1 READING EXCEL FILES
-
-To read data from Excel files try:
-
-=over 4
-
-=item * Spreadsheet::ParseExcel
-
-This uses the OLE::Storage-Lite module to extract data from an Excel file. http://search.cpan.org/search?dist=Spreadsheet-ParseExcel
-
-=item * Spreadsheet::ParseExcel_XLHTML
-
-This module uses Spreadsheet::ParseExcel's interface but uses xlHtml (see below) to do the conversion: http://search.cpan.org/search?dist=Spreadsheet-ParseExcel_XLHTML
-Spreadsheet::ParseExcel_XLHTML
-
-=item * xlHtml
-
-This is an open source "Excel to HTML Converter" C/C++ project at http://www.xlhtml.org/ See also, the OLE Filters Project at http://atena.com/libole2.php
-
-=item * DBD::Excel (reading)
-
-You can also access Spreadsheet::ParseExcel using the standard DBI interface via Takanori Kawai's DBD::Excel module http://search.cpan.org/search?dist=DBD-Excel.
-
-=item * Win32::OLE module and office automation (reading)
-
-See, the section L<WRITING EXCEL FILES>.
-
-=item * HTML tables (reading)
-
-If the files are saved from Excel in a HTML format the data can be accessed using HTML::TableExtract http://search.cpan.org/search?dist=HTML-TableExtract
-
-=item * DBI with DBD::ADO or DBD::ODBC.
-
-See, the section L<WRITING EXCEL FILES>.
-
-=item * XML::Excel
-
-Converts Excel files to XML using Spreadsheet::ParseExcel http://search.cpan.org/search?dist=XML-Excel.
-
-=item * OLE::Storage, aka LAOLA
-
-This is a Perl interface to OLE file formats. In particular, the distro contains an Excel to HTML converter called Herbert, http://user.cs.tu-berlin.de/~schwartz/pmh/ This has been superseded by the Spreadsheet::ParseExcel module.
-
-=back
-
-
-For other Perl-Excel modules try the following search: http://search.cpan.org/search?mode=module&query=excel
-
-If you wish to view Excel files on a UNIX/Linux platform check out the excellent Gnumeric spreadsheet application at http://www.gnome.org/projects/gnumeric/ or OpenOffice.org at http://www.openoffice.org/
-
-If you wish to view Excel files on a Windows platform which doesn't have Excel installed you can use the free Microsoft Excel Viewer http://office.microsoft.com/downloads/2000/xlviewer.aspx
-
-
-
-
-=head1 WORKING WITH XML
-
-You must be careful when using XML data in conjunction with Spreadsheet::WriteExcel due to the fact that data returned by XML parsers is generally in UTF8 format.
-
-When UTF8 strings are added to Spreadsheet::WriteExcel's internal data it causes the generated Excel file to become corrupt.
-
-To avoid this problems you should convert the output data to ASCII or ISO-8859-1 using one of the following methods:
-
- $new_str = pack 'C*', unpack 'U*', $utf8_str;
-
-
- use Unicode::MapUTF8 'from_utf8';
- $new_str = from_utf8({-str => $utf8_str, -charset => 'ISO-8859-1'});
-
-
-If you are interested in creating an XML spreadsheet format you can use Spreadsheet::WriteExcelXML which uses the same interface as Spreadsheet::WriteExcel. See http://search.cpan.org/dist/Spreadsheet-WriteExcelXML
-
-
-
-
-=head1 BUGS
-
-Formulas are formulae.
-
-This version of the module doesn't support the write_comment() method. This will be fixed soon.
-
-XML data can cause Excel files created by Spreadsheet::WriteExcel to become corrupt. See L<WORKING WITH XML> for further details.
-
-The format object that is used with a C<merge_range()> method call is marked internally as being associated with a merged range.If you use this format in a non-merged cell it will cause Excel to crash. The current workaround is to use separate formats for merged and non-merged cell. This will be fixed in a future release.
-
-Nested formulas sometimes aren't parsed correctly and give a result of "#VALUE". If you come across a formula that parses like this, let me know.
-
-Spreadsheet::ParseExcel: All formulas created by Spreadsheet::WriteExcel are read as having a value of zero. This is because Spreadsheet::WriteExcel only stores the formula and not the calculated result.
-
-OpenOffice.org: Some formatting is not displayed correctly.
-
-Gnumeric: Some formatting is not displayed correctly. URLs are not displayed as links.
-
-The lack of a portable way of writing a little-endian 64 bit IEEE float. There is beta code available to fix this. Let me know if you wish to test it on your platform.
-
-If you wish to submit a bug report run the C<bug_report.pl> program in the C<examples> directory of the distro.
-
-
-
-
-=head1 TO DO
-
-The roadmap is as follows:
-
-=over 4
-
-=item * Extend uft8 support to all relevant methods.
-
-=item * Add write_comment().
-
-=item * Add AutoFilters.
-
-
-=back
-
-You can keep up to date with future releases by registering as a user with Freshmeat http://freshmeat.net/ and subscribing to Spreadsheet::WriteExcel at the project page http://freshmeat.net/projects/writeexcel/ You will then receive mailed updates when a new version is released. Alternatively you can keep an eye on news://comp.lang.perl.announce
-
-Also, here are some of the most requested features that probably won't get added:
-
-=over 4
-
-=item * Macros.
-
-This would solve the previous problem neatly. However, the format of Excel macros isn't documented.
-
-=item * Some feature that you really need. ;-)
-
-
-=back
-
-If there is some feature of an Excel file that you really, really need then you should use Win32::OLE with Excel on Windows. If you are on Unix you could consider connecting to a Windows server via Docserver or SOAP, see L<WRITING EXCEL FILES>.
-
-
-
-
-=head1 SEE ALSO
-
-Spreadsheet::ParseExcel: http://search.cpan.org/search?dist=Spreadsheet-ParseExcel
-
-Spreadsheet-WriteExcel-FromXML: http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromXML
-
-Spreadsheet::WriteExcel::FromDB: http://search.cpan.org/search?dist=Spreadsheet-WriteExcel-FromDB
-
-DateTime::Format::Excel: http://search.cpan.org/search?dist=DateTime-Format-Excel
-
-"Reading and writing Excel files with Perl" by Teodor Zlatanov, atIBM developerWorks: http://www-106.ibm.com/developerworks/library/l-pexcel/
-
-"Excel-Dateien mit Perl erstellen - Controller im Glück" by Peter Dintelmann and Christian Kirsch in the German Unix/web journal iX: http://www.heise.de/ix/artikel/2001/06/175/
-
-"Spreadsheet::WriteExcel" in The Perl Journal: http://www.samag.com/documents/s=1272/sam05030004/
-
-Spreadsheet::WriteExcel documentation in Japanese by Takanori Kawai. http://member.nifty.ne.jp/hippo2000/perltips/Spreadsheet/WriteExcel.htm
-
-Oesterly user brushes with fame:
-http://oesterly.com/releases/12102000.html
-
-
-=head1 ACKNOWLEDGEMENTS
-
-
-The following people contributed to the debugging and testing of Spreadsheet::WriteExcel:
-
-Alexander Farber, Andre de Bruin, Arthur at ais, Artur Silveira da Cunha, Borgar Olsen, Brian White, Bob Mackay, Cedric Bouvier, Chad Johnson, CPAN testers, Daniel Berger, Daniel Gardner, Dmitry Kochurov, Eric Frazier, Ernesto Baschny, Felipe Pérez Galiana, Gordon Simpson, Hanc Pavel, Harold Bamford, James Holmes, James Wilkinson, Johan Ekenberg, Johann Hanne, Jonathan Scott Duff, J.C. Wren, Kenneth Stacey, Keith Miller, Kyle Krom, Marc Rosenthal, Markus Schmitz, Michael Braig, Michael Buschauer, Mike Blazer, Michael Erickson, Michael W J West, Ning Xie, Paul J. Falbe, Paul Medynski, Peter Dintelmann, Pierre Laplante, Praveen Kotha, Reto Badertscher, Rich Sorden, Shane Ashby, Shenyu Zheng, Stephan Loescher, Steve Sapovits, Sven Passig, Svetoslav Marinov, Tamas Gulacsi, Troy Daniels, Vahe Sarkissian.
-
-The following people contributed patches, examples or Excel information:
-
-Andrew Benham, Bill Young, Cedric Bouvier, Charles Wybble, Daniel Rentz, David Robins, Franco Venturi, Ian Penman, John Heitmann, Jon Guy, Kyle R. Burton, Pierre-Jean Vouette, Rubio, Marco Geri, Mark Fowler, Matisse Enzer, Sam Kington, Takanori Kawai, Tom O'Sullivan.
-
-Many thanks to Ron McKelvey, Ronzo Consulting for Siemens, who sponsored the development of the formula caching routines.
-
-Additional thanks to Takanori Kawai for translating the documentation into Japanese.
-
-Dirk Eddelbuettel maintains the Debian distro.
-
-Thanks to Damian Conway for the excellent Parse::RecDescent.
-
-Thanks to Tim Jenness for File::Temp.
-
-Thanks to Michael Meeks and Jody Goldberg for their work on Gnumeric.
-
-
-
-
-=head1 AUTHOR
-
-John McNamara jmcnamara at cpan.org
-
- Under blue moon I saw you
- So soon you'll take me
- Up in your arms, too late to beg you
- Or cancel it, though I know it must be
- The killing time
- Unwillingly mine
-
- Fate
- Up against your will
- Through the thick and thin
- He will wait until
- You give yourself to him
-
- In starlit nights I saw you
- So cruelly you kissed me
- Your lips a magic world
- Your sky all hung with jewels
- The killing moon
- Will come too soon
-
- Fate
- Up against your will
- Through the thick and thin
- He will wait until
- You give yourself to him
-
- -- Ian McCulloch
-
-
-
-
-=head1 COPYRIGHT
-
-© MM-MMIV, 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.
-
+package Spreadsheet::WriteExcel;
+
+###############################################################################
+#
+# WriteExcel.
+#
+# Spreadsheet::WriteExcel - Write to a cross-platform Excel binary file.
+#
+# Copyright 2000-2005, John McNamara, jmcnamara at cpan.org
+#
+# Documentation after __END__
+#
+
+use Exporter;
+
+use strict;
+use Spreadsheet::WriteExcel::Workbook;
+
+
+
+use vars qw($VERSION @ISA);
+ at ISA = qw(Spreadsheet::WriteExcel::Workbook Exporter);
+
+$VERSION = '2.12'; # Months mind
+
+
+
+###############################################################################
+#
+# new()
+#
+# Constructor. Wrapper for a Workbook object.
+# uses: Spreadsheet::WriteExcel::BIFFwriter
+# Spreadsheet::WriteExcel::Chart
+# Spreadsheet::WriteExcel::OLEwriter
+# Spreadsheet::WriteExcel::Workbook
+# Spreadsheet::WriteExcel::Worksheet
+# Spreadsheet::WriteExcel::Format
+# Spreadsheet::WriteExcel::Formula
+#
+sub new {
+
+ my $class = shift;
+ my $self = Spreadsheet::WriteExcel::Workbook->new(@_);
+
+ # Check for file creation failures before re-blessing
+ bless $self, $class if defined $self;
+
+ return $self;
+}
+
+
+1;
+
+
+__END__
+
+
+
+=head1 NAME
+
+Spreadsheet::WriteExcel - Write to a cross-platform Excel binary file.
+
+=head1 VERSION
+
+This document refers to version 2.12 of Spreadsheet::WriteExcel, released March 22, 2005.
+
+
+
+
+=head1 SYNOPSIS
+
+To write a string, a formatted string, a number and a formula to the first worksheet in an Excel workbook called perl.xls:
+
+ use Spreadsheet::WriteExcel;
+
+ # Create a new Excel workbook
+ my $workbook = Spreadsheet::WriteExcel->new("perl.xls");
+
+ # Add a worksheet
+ $worksheet = $workbook->add_worksheet();
+
+ # Add and define a format
+ $format = $workbook->add_format(); # Add a format
+ $format->set_bold();
+ $format->set_color('red');
+ $format->set_align('center');
+
+ # Write a formatted and unformatted string, row and column notation.
+ $col = $row = 0;
+ $worksheet->write($row, $col, "Hi Excel!", $format);
+ $worksheet->write(1, $col, "Hi Excel!");
+
+ # Write a number and a formula using A1 notation
+ $worksheet->write('A3', 1.2345);
+ $worksheet->write('A4', '=SIN(PI()/4)');
+
+
+
+
+=head1 DESCRIPTION
+
+The Spreadsheet::WriteExcel module can be used to create a cross-platform Excel binary file. Multiple worksheets can be added to a workbook and formatting can be applied to cells. Text, numbers, formulas, hyperlinks and images can be written to the cells.
+
+The Excel file produced by this module is compatible with 97, 2000, 2002 and 2003.
+
+The module will work on the majority of Windows, UNIX and Macintosh platforms. Generated files are also compatible with the Linux/UNIX spreadsheet applications Gnumeric and OpenOffice.org.
+
+This module cannot be used to write to an existing Excel file.
+
+
+
+
+=head1 QUICK START
+
+Spreadsheet::WriteExcel tries to provide an interface to as many of Excel's features as possible. As a result there is a lot of documentation to accompany the interface and it can be difficult at first glance to see what it important and what is not. So for those of you who prefer to assemble Ikea furniture first and then read the instructions, here are three easy steps:
+
+1. Create a new Excel I<workbook> (i.e. file) using C<new()>.
+
+2. Add a I<worksheet> to the new workbook using C<add_worksheet()>.
+
+3. Write to the worksheet using C<write()>.
+
+Like this:
+
+ use Spreadsheet::WriteExcel; # Step 0
+
+ my $workbook = Spreadsheet::WriteExcel->new("perl.xls"); # Step 1
+ $worksheet = $workbook->add_worksheet(); # Step 2
+ $worksheet->write('A1', "Hi Excel!"); # Step 3
+
+This will create an Excel file called C<perl.xls> with a single worksheet and the text C<"Hi Excel!"> in the relevant cell. And that's it. Okay, so there is actually a zeroth step as well, but C<use module> goes without saying. There are also more than 40 examples that come with the distribution and which you can use to get you started. See L<EXAMPLES>.
+
+Those of you who read the instructions first and assemble the furniture afterwards will know how to proceed. ;-)
+
+
+
+
+=head1 WORKBOOK METHODS
+
+The Spreadsheet::WriteExcel module provides an object oriented interface to a new Excel workbook. The following methods are available through a new workbook.
+
+ new()
+ close()
+ set_tempdir()
+ add_worksheet()
+ add_format()
+ set_custom_color()
+ sheets()
+ set_1904()
+ set_codepage()
+
+If you are unfamiliar with object oriented interfaces or the way that they are implemented in Perl have a look at C<perlobj> and C<perltoot> in the main Perl documentation.
+
+
+
+
+=head2 new()
+
+A new Excel workbook is created using the C<new()> constructor which accepts either a filename or a filehandle as a parameter. The following example creates a new Excel file based on a filename:
+
+ my $workbook = Spreadsheet::WriteExcel->new('filename.xls');
+ my $worksheet = $workbook->add_worksheet();
+ $worksheet->write(0, 0, "Hi Excel!");
+
+Here are some other examples of using C<new()> with filenames:
+
+ my $workbook1 = Spreadsheet::WriteExcel->new($filename);
+ my $workbook2 = Spreadsheet::WriteExcel->new("/tmp/filename.xls");
+ my $workbook3 = Spreadsheet::WriteExcel->new("c:\\tmp\\filename.xls");
+ my $workbook4 = Spreadsheet::WriteExcel->new('c:\tmp\filename.xls');
+
+The last two examples demonstrates how to create a file on DOS or Windows where it is necessary to either escape the directory separator C<\> or to use single quotes to ensure that it isn't interpolated. For more information see C<perlfaq5: Why can't I use "C:\temp\foo" in DOS paths?>.
+
+The C<new()> constructor returns a Spreadsheet::WriteExcel object that you can use to add worksheets and store data. It should be noted that although C<my> is not specifically required it defines the scope of the new workbook variable and, in the majority of cases, ensures that the workbook is closed properly without explicitly calling the C<close()> method.
+
+If the file cannot be created, due to file permissions or some other reason, C<new> will return C<undef>. Therefore, it is good practice to check the return value of C<new> before proceeding. As usual the Perl variable C<$!> will be set if there is a file creation error. You will also see one of the warning messages detailed in L<DIAGNOSTICS>:
+
+ my $workbook = Spreadsheet::WriteExcel->new('protected.xls');
+ die "Problems creating new Excel file: $!" unless defined $workbook;
+
+You can also pass a valid filehandle to the C<new()> constructor. For example in a CGI program you could do something like this:
+
+ binmode(STDOUT);
+ my $workbook = Spreadsheet::WriteExcel->new(\*STDOUT);
+
+The requirement for C<binmode()> is explained below.
+
+For CGI programs you can also use the special Perl filename C<'-'> which will redirect the output to STDOUT:
+
+ my $workbook = Spreadsheet::WriteExcel->new('-');
+
+See also, the C<cgi.pl> program in the C<examples> directory of the distro.
+
+However, this special case will not work in C<mod_perl> programs where you will have to do something like the following:
+
+ # mod_perl 1
+ ...
+ tie *XLS, 'Apache';
+ binmode(XLS);
+ my $workbook = Spreadsheet::WriteExcel->new(\*XLS);
+ ...
+
+ # mod_perl 2
+ ...
+ tie *XLS => $r; # Tie to the Apache::RequestRec object
+ binmode(*XLS);
+ my $workbook = Spreadsheet::WriteExcel->new(\*XLS);
+ ...
+
+See also, the C<mod_perl1.pl> and C<mod_perl2.pl> programs in the C<examples> directory of the distro.
+
+Filehandles can also be useful if you want to stream an Excel file over a socket or if you want to store an Excel file in a scalar.
+
+For example here is a way to write an Excel file to a scalar with C<perl 5.8>:
+
+ #!/usr/bin/perl -w
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+ # Requires perl 5.8 or later
+ open my $fh, '>', \my $str or die "Failed to open filehandle: $!";
+
+ my $workbook = Spreadsheet::WriteExcel->new($fh);
+ my $worksheet = $workbook->add_worksheet();
+
+ $worksheet->write(0, 0, "Hi Excel!");
+
+ $workbook->close();
+
+ # The Excel file in now in $str. Remember to binmode() the output
+ # filehandle before printing it.
+ binmode STDOUT;
+ print $str;
+
+See also the C<write_to_scalar.pl> and C<filehandle.pl> programs in the C<examples> directory of the distro.
+
+B<Note about the requirement for> C<binmode()>: An Excel file is comprised of binary data. Therefore, if you are using a filehandle you should ensure that you C<binmode()> it prior to passing it to C<new()>.You should do this regardless of whether you are on a Windows platform or not. This applies especially to users of perl 5.8 on systems where utf8 is likely to be in operation such as RedHat Linux 9. If your program, either intentionally or not, writes UTF8 data to a filehandle that is passed to C<new()> it will corrupt the Excel file that is created.
+
+You don't have to worry about C<binmode()> if you are using filenames instead of filehandles. Spreadsheet::WriteExcel performs the C<binmode()> internally when it converts the filename to a filehandle. For more information about C<binmode()> see C<perlfunc> and C<perlopentut> in the main Perl documentation.
+
+
+
+
+
+=head2 close()
+
+The C<close()> method can be used to explicitly close an Excel file.
+
+ $workbook->close();
+
+An explicit C<close()> is required if the file must be closed prior to performing some external action on it such as copying it, reading its size or attaching it to an email.
+
+In addition, C<close()> may be required to prevent perl's garbage collector from disposing of the Workbook, Worksheet and Format objects in the wrong order. Situations where this can occur are:
+
+=over 4
+
+=item *
+
+If C<my()> was not used to declare the scope of a workbook variable created using C<new()>.
+
+=item *
+
+If the C<new()>, C<add_worksheet()> or C<add_format()> methods are called in subroutines.
+
+=back
+
+The reason for this is that Spreadsheet::WriteExcel relies on Perl's C<DESTROY> mechanism to trigger destructor methods in a specific sequence. This may not happen in cases where the Workbook, Worksheet and Format variables are not lexically scoped or where they have different lexical scopes.
+
+In general, if you create a file with a size of 0 bytes or you fail to create a file you need to call C<close()>.
+
+The return value of C<close()> is the same as that returned by perl when it closes the file created by C<new()>. This allows you to handle error conditions in the usual way:
+
+ $workbook->close() or die "Error closing file: $!";
+
+
+
+
+=head2 set_tempdir()
+
+For speed and efficiency C<Spreadsheet::WriteExcel> stores worksheet data in temporary files prior to assembling the final workbook.
+
+If Spreadsheet::WriteExcel is unable to create these temporary files it will store the required data in memory. This can be slow for large files.
+
+The problem occurs mainly with IIS on Windows although it could feasibly occur on Unix systems as well. The problem generally occurs because the default temp file directory is defined as C<C:/> or some other directory that IIS doesn't provide write access to.
+
+To check if this might be a problem on a particular system you can run a simple test program with C<-w> or C<use warnings>. This will generate a warning if the module cannot create the required temporary files:
+
+ #!/usr/bin/perl -w
+
+ use Spreadsheet::WriteExcel;
+
+ my $workbook = Spreadsheet::WriteExcel->new("test.xls");
+ my $worksheet = $workbook->add_worksheet();
+
+To avoid this problem the C<set_tempdir()> method can be used to specify a directory that is accessible for the creation of temporary files.
+
+The C<File::Temp> module is used to create the temporary files. File::Temp uses C<File::Spec> to determine an appropriate location for these files such as C</tmp> or C<c:\windows\temp>. You can find out which directory is used on your system as follows:
+
+ perl -MFile::Spec -le "print File::Spec->tmpdir"
+
+Even if the default temporary file directory is accessible you may wish to specify an alternative location for security or maintenance reasons:
+
+ $workbook->set_tempdir('/tmp/writeexcel');
+ $workbook->set_tempdir('c:\windows\temp\writeexcel');
+
+The directory for the temporary file must exist, C<set_tempdir()> will not create a new directory.
+
+One disadvantage of using the C<set_tempdir()> method is that on some Windows systems it will limit you to approximately 800 concurrent tempfiles. This means that a single program running on one of these systems will be limited to creating a total of 800 workbook and worksheet objects. You can run multiple, non-concurrent programs to work around this if necessary.
+
+
+
+
+
+=head2 add_worksheet($sheetname)
+
+At least one worksheet should be added to a new workbook. A worksheet is used to write data into cells:
+
+ $worksheet1 = $workbook->add_worksheet(); # Sheet1
+ $worksheet2 = $workbook->add_worksheet('Foglio2'); # Foglio2
+ $worksheet3 = $workbook->add_worksheet('Data'); # Data
+ $worksheet4 = $workbook->add_worksheet(); # Sheet4
+
+If C<$sheetname> is not specified the default Excel convention will be followed, i.e. Sheet1, Sheet2, etc.
+
+The worksheet name must be a valid Excel worksheet name, i.e. it cannot contain any of the following characters, C<[ ] : * ? / \> and it must be less than 32 characters. In addition, you cannot use the same, case insensitive, C<$sheetname> for more than one worksheet.
+
+On systems with C<perl 5.8> and later the C<add_worksheet()> method will also handle strings in Perl's C<utf8> format.
+
+ $worksheet5 = $workbook->add_worksheet("\x{263a}"); # Smiley
+
+
+=head2 add_chart_ext($chart_data, $chartname)
+
+This method is use to include externally generated charts in a Spreadsheet::WriteExcel file.
+
+ my $chart = $workbook->add_chart_ext('chart01.bin', 'Chart1');
+
+This feature is new and would be best described as experimental. Read C<charts.txt> in the charts directory of the distro for a full explanation.
+
+
+
+=head2 add_format(%properties)
+
+The C<add_format()> method can be used to create new Format objects which are used to apply formatting to a cell. You can either define the properties at creation time via a hash of property values or later via method calls.
+
+ $format1 = $workbook->add_format(%props); # Set properties at creation
+ $format2 = $workbook->add_format(); # Set properties later
+
+See the L<CELL FORMATTING> section for more details about Format properties and how to set them.
+
+
+
+
+=head2 set_custom_color($index, $red, $green, $blue)
+
+The C<set_custom_color()> method can be used to override one of the built-in palette values with a more suitable colour.
+
+The value for C<$index> should be in the range 8..63, see L<COLOURS IN EXCEL>.
+
+The default named colours use the following indices:
+
+ 8 => black
+ 9 => white
+ 10 => red
+ 11 => lime
+ 12 => blue
+ 13 => yellow
+ 14 => magenta
+ 15 => cyan
+ 16 => brown
+ 17 => green
+ 18 => navy
+ 20 => purple
+ 22 => silver
+ 23 => gray
+ 53 => orange
+
+A new colour is set using its RGB (red green blue) components. The C<$red>, C<$green> and C<$blue> values must be in the range 0..255. You can determine the required values in Excel using the C<Tools-E<gt>Options-E<gt>Colors-E<gt>Modify> dialog.
+
+The C<set_custom_color()> workbook method can also be used with a HTML style C<#rrggbb> hex value:
+
+ $workbook->set_custom_color(40, 255, 102, 0 ); # Orange
+ $workbook->set_custom_color(40, 0xFF, 0x66, 0x00); # Same thing
+ $workbook->set_custom_color(40, '#FF6600' ); # Same thing
+
+ my $font = $workbook->add_format(color => 40); # Use the modified colour
+
+The return value from C<set_custom_color()> is the index of the colour that was changed:
+
+ my $ferrari = $workbook->set_custom_color(40, 216, 12, 12);
+
+ my $format = $workbook->add_format(
+ bg_color => $ferrari,
+ pattern => 1,
+ border => 1
+ );
+
+
+
+
+=head2 sheets(0, 1, ...)
+
+The C<sheets()> method returns a list, or a sliced list, of the worksheets in a workbook.
+
+If no arguments are passed the method returns a list of all the worksheets in the workbook. This is useful if you want to repeat an operation on each worksheet:
+
+ foreach $worksheet ($workbook->sheets()) {
+ print $worksheet->get_name();
+ }
+
+
+You can also specify a slice list to return one or more worksheet objects:
+
+ $worksheet = $workbook->sheets(0);
+ $worksheet->write('A1', "Hello");
+
+
+Or since return value from C<sheets()> is a reference to a worksheet object you can write the above example as:
+
+ $workbook->sheets(0)->write('A1', "Hello");
+
+
+The following example returns the first and last worksheet in a workbook:
+
+ foreach $worksheet ($workbook->sheets(0, -1)) {
+ # Do something
+ }
+
+
+Array slices are explained in the perldata manpage.
+
+
+
+
+=head2 set_1904()
+
+Excel stores dates as real numbers where the integer part stores the number of days since the epoch and the fractional part stores the percentage of the day. The epoch can be either 1900 or 1904. Excel for Windows uses 1900 and Excel for Macintosh uses 1904. However, Excel on either platform will convert automatically between one system and the other.
+
+Spreadsheet::WriteExcel stores dates in the 1900 format by default. If you wish to change this you can call the C<set_1904()> workbook method. You can query the current value by calling the C<get_1904()> workbook method. This returns 0 for 1900 and 1 for 1904.
+
+See also L<DATES IN EXCEL> for more information about working with Excel's date system.
+
+In general you probably won't need to use C<set_1904()>.
+
+
+
+
+=head2 set_codepage($codepage)
+
+The default code page or character set used by Spreadsheet::WriteExcel is ANSI. This is also the default used by Excel for Windows. Occasionally however it may be necessary to change the code page via the C<set_codepage()> method.
+
+Changing the code page may be required if your are using Spreadsheet::WriteExcel on the Macintosh and you are using characters outside the ASCII 128 character set:
+
+ $workbook->set_codepage(1); # ANSI, MS Windows
+ $workbook->set_codepage(2); # Apple Macintosh
+
+The C<set_codepage()> method is rarely required.
+
+
+
+
+=head1 WORKSHEET METHODS
+
+A new worksheet is created by calling the C<add_worksheet()> method from a workbook object:
+
+ $worksheet1 = $workbook->add_worksheet();
+ $worksheet2 = $workbook->add_worksheet();
+
+The following methods are available through a new worksheet:
+
+ write()
+ write_number()
+ write_string()
+ write_unicode()
+ write_unicode_le()
+ keep_leading_zeros()
+ write_blank()
+ write_row()
+ write_col()
+ write_url()
+ write_url_range()
+ write_formula()
+ store_formula()
+ repeat_formula()
+ add_write_handler()
+ insert_bitmap()
+ get_name()
+ activate()
+ select()
+ set_first_sheet()
+ protect()
+ set_selection()
+ set_row()
+ set_column()
+ outline_settings()
+ freeze_panes()
+ thaw_panes()
+ merge_range()
+ set_zoom()
+
+
+=head2 Cell notation
+
+Spreadsheet::WriteExcel supports two forms of notation to designate the position of cells: Row-column notation and A1 notation.
+
+Row-column notation uses a zero based index for both row and column while A1 notation uses the standard Excel alphanumeric sequence of column letter and 1-based row. For example:
+
+ (0, 0) # The top left cell in row-column notation.
+ ('A1') # The top left cell in A1 notation.
+
+ (1999, 29) # Row-column notation.
+ ('AD2000') # The same cell in A1 notation.
+
+Row-column notation is useful if you are referring to cells programmatically:
+
+ for my $i (0 .. 9) {
+ $worksheet->write($i, 0, 'Hello'); # Cells A1 to A10
+ }
+
+A1 notation is useful for setting up a worksheet manually and for working with formulas:
+
+ $worksheet->write('H1', 200);
+ $worksheet->write('H2', '=H1+1');
+
+In formulas and applicable methods you can also use the C<A:A> column notation:
+
+ $worksheet->write('A1', '=SUM(B:B)');
+
+The C<Spreadsheet::WriteExcel::Utility> module that is included in the distro contains helper functions for dealing with A1 notation, for example:
+
+ use Spreadsheet::WriteExcel::Utility;
+
+ ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
+ $str = xl_rowcol_to_cell(1, 2); # C2
+
+For simplicity, the parameter lists for the worksheet method calls in the following sections are given in terms of row-column notation. In all cases it is also possible to use A1 notation.
+
+Note: in Excel it is also possible to use a R1C1 notation. This is not supported by Spreadsheet::WriteExcel.
+
+
+
+
+=head2 write($row, $column, $token, $format)
+
+Excel makes a distinction between data types such as strings, numbers, blanks, formulas and hyperlinks. To simplify the process of writing data the C<write()> method acts as a general alias for several more specific methods:
+
+ write_string()
+ write_number()
+ write_blank()
+ write_formula()
+ write_url()
+ write_row()
+ write_col()
+
+The general rule is that if the data looks like a I<something> then a I<something> is written. Here are some examples in both row-column and A1 notation:
+
+ # Same as:
+ $worksheet->write(0, 0, "Hello" ); # write_string()
+ $worksheet->write(1, 0, 'One' ); # write_string()
+ $worksheet->write(2, 0, 2 ); # write_number()
+ $worksheet->write(3, 0, 3.00001 ); # write_number()
+ $worksheet->write(4, 0, "" ); # write_blank()
+ $worksheet->write(5, 0, '' ); # write_blank()
+ $worksheet->write(6, 0, undef ); # write_blank()
+ $worksheet->write(7, 0 ); # write_blank()
+ $worksheet->write(8, 0, 'http://www.perl.com/'); # write_url()
+ $worksheet->write('A9', 'ftp://ftp.cpan.org/' ); # write_url()
+ $worksheet->write('A10', 'internal:Sheet1!A1' ); # write_url()
+ $worksheet->write('A11', 'external:c:\foo.xls' ); # write_url()
+ $worksheet->write('A12', '=A3 + 3*A4' ); # write_formula()
+ $worksheet->write('A13', '=SIN(PI()/4)' ); # write_formula()
+ $worksheet->write('A14', \@array ); # write_row()
+ $worksheet->write('A15', [\@array] ); # write_col()
+
+ # And if the keep_leading_zeros property is set:
+ $worksheet->write('A16, 2 ); # write_number()
+ $worksheet->write('A17, 02 ); # write_string()
+ $worksheet->write('A18, 00002 ); # write_string()
+
+
+The "looks like" rule is defined by regular expressions:
+
+C<write_number()> if C<$token> is a number based on the following regex: C<$token =~ /^([+-]?)(?=\d|\.\d)\d*(\.\d*)?([Ee]([+-]?\d+))?$/>.
+
+C<write_string()> if C<keep_leading_zeros()> is set and C<$token> is an integer with leading zeros based on the following regex: C<$token =~ /^0\d+$/>.
+
+C<write_blank()> if C<$token> is undef or a blank string: C<undef>, C<""> or C<''>.
+
+C<write_url()> if C<$token> is a http, https, ftp or mailto URL based on the following regexes: C<$token =~ m|^[fh]tt?ps?://|> or C<$token =~ m|^mailto:|>.
+
+C<write_url()> if C<$token> is an internal or external sheet reference based on the following regex: C<$token =~ m[^(in|ex)ternal:]>.
+
+C<write_formula()> if the first character of C<$token> is C<"=">.
+
+C<write_row()> if C<$token> is an array ref.
+
+C<write_col()> if C<$token> is an array ref of array refs.
+
+C<write_string()> if none of the previous conditions apply.
+
+The C<$format> parameter is optional. It should be a valid Format object, see L<CELL FORMATTING>:
+
+ my $format = $workbook->add_format();
+ $format->set_bold();
+ $format->set_color('red');
+ $format->set_align('center');
+
+ $worksheet->write(4, 0, "Hello", $format ); # Formatted string
+
+The write() method will ignore empty strings or C<undef> tokens unless a format is also supplied. As such you needn't worry about special handling for empty or C<undef> values in your data. See also the C<write_blank()> method.
+
+One problem with the C<write()> method is that occasionally data looks like a number but you don't want it treated as a number. For example, zip codes or ID numbers often start with a leading zero. If you write this data as a number then the leading zero(s) will be stripped. You can change this default behaviour by using the C<keep_leading_zeros()> method. While this property is in place any integers with leading zeros will be treated as strings and the zeros will be preserved. See the C<keep_leading_zeros()> section for a full discussion of this issue.
+
+You can also add your own data handlers to the C<write()> method using C<add_write_handler()>.
+
+On systems with C<perl 5.8> and later the C<write()> method will also handle Unicode strings in Perl's C<utf8> format.
+
+The C<write> methods return:
+
+ 0 for success.
+ -1 for insufficient number of arguments.
+ -2 for row or column out of bounds.
+ -3 for string too long.
+
+
+
+
+=head2 write_number($row, $column, $number, $format)
+
+Write an integer or a float to the cell specified by C<$row> and C<$column>:
+
+ $worksheet->write_number(0, 0, 123456);
+ $worksheet->write_number('A2', 2.3451);
+
+See the note about L<Cell notation>. The C<$format> parameter is optional.
+
+In general it is sufficient to use the C<write()> method.
+
+
+
+
+=head2 write_string($row, $column, $string, $format)
+
+Write a string to the cell specified by C<$row> and C<$column>:
+
+ $worksheet->write_string(0, 0, "Your text here" );
+ $worksheet->write_string('A2', "or here" );
+
+The maximum string size is 32767 characters. However the maximum string segment that Excel can display in a cell is 1000. All 32767 characters can be displayed in the formula bar.
+
+The C<$format> parameter is optional.
+
+On systems with C<perl 5.8> and later the C<write()> method will also handle strings in Perl's C<utf8> format. With older perls you can also write Unicode in C<UTF16> format via the C<write_unicode()> method. See also the C<unicode_*.pl> programs in the examples directory of the distro.
+
+In general it is sufficient to use the C<write()> method. However, you may sometimes wish to use the C<write_string()> method to write data that looks like a number but that you don't want treated as a number. For example, zip codes or phone numbers:
+
+ # Write as a plain string
+ $worksheet->write_string('A1', '01209');
+
+However, if the user edits this string Excel may convert it back to a number. To get around this you can use the Excel text format C<@>:
+
+ # Format as a string. Doesn't change to a number when edited
+ my $format1 = $workbook->add_format(num_format => '@');
+ $worksheet->write_string('A2', '01209', $format1);
+
+See also the note about L<Cell notation>.
+
+
+
+
+=head2 write_unicode($row, $column, $string, $format)
+
+This method is used to write Unicode strings to a cell in Excel. It is functionally the same as the C<write_string()> method except that the string should be in UTF-16 Unicode format.
+
+B<Note>: on systems with C<perl 5.8> and later the C<write()> and C<write_string()>methods will also handle strings in Perl's C<utf8> format. With older perls you must use the C<write_unicode()> method.
+
+The Unicode format required by Excel is UTF-16. Additionally C<Spreadsheet::WriteExcel> requires that the 16-bit characters are in big-endian order. This is generally referred to as UTF-16BE. To write UTF-16 strings in little-endian format use the C<write_unicode_le()> method.
+
+
+The following is a simple example showing how to write some Unicode strings:
+
+ #!/usr/bin/perl -w
+
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+ use Unicode::Map();
+
+ my $workbook = Spreadsheet::WriteExcel->new('unicode.xls');
+ my $worksheet = $workbook->add_worksheet();
+
+ # Increase the column width for clarity
+ $worksheet->set_column('A:A', 25);
+
+
+ # Write a Unicode character
+ #
+ my $smiley = pack "n", 0x263a;
+
+ # Increase the font size for legibility.
+ my $big_font = $workbook->add_format(size => 72);
+
+ $worksheet->write_unicode('A3', $smiley, $big_font);
+
+
+
+ # Write a phrase in Cyrillic using a hex-encoded string
+ #
+ my $uni_str = pack "H*", "042d0442043e0020044404400430043704300020043d" .
+ "043000200440044304410441043a043e043c0021";
+
+ $worksheet->write_unicode('A5', $uni_str);
+
+
+
+ # Map a string to UTF-16BE using an external module.
+ #
+ my $map = Unicode::Map->new("ISO-8859-1");
+ my $utf16 = $map->to_unicode("Hello world!");
+
+ $worksheet->write_unicode('A7', $utf16);
+
+
+The following is an example of creating an Excel file with some Japanese text. You will need to have a Unicode font installed, such as C<Arial Unicode MS>, to view the results:
+
+
+ #!/usr/bin/perl -w
+
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+
+ my $workbook = Spreadsheet::WriteExcel->new('unicode.xls');
+ my $worksheet = $workbook->add_worksheet();
+
+
+ # It is only required to specify a Unicode font via add_format() if
+ # you are using Excel 97. For Excel 2000+ the text will display
+ # with the default font (if you have Unicode fonts installed).
+ #
+ my $uni_font = $workbook->add_format(font => 'Arial Unicode MS');
+
+
+ my $kanji = pack 'n*', 0x65e5, 0x672c;
+ my $katakana = pack 'n*', 0xff86, 0xff8e, 0xff9d;
+ my $hiragana = pack 'n*', 0x306b, 0x307b, 0x3093;
+
+
+ $worksheet->write_unicode('A1', $kanji, $uni_font);
+ $worksheet->write_unicode('A2', $katakana, $uni_font);
+ $worksheet->write_unicode('A3', $hiragana, $uni_font);
+
+
+ $worksheet->write('B1', 'Kanji');
+ $worksheet->write('B2', 'Katakana');
+ $worksheet->write('B3', 'Hiragana');
+
+
+Note: You can convert ascii encodings to the required UTF-16BE format using one of the many Unicode modules on CPAN. For example C<Unicode::Map> and C<Unicode::String>: http://search.cpan.org/author/MSCHWARTZ/Unicode-Map-0.112/Map.pm and http://search.cpan.org/author/GAAS/Unicode-String-2.06/String.pm
+
+For a full list of the Perl Unicode modules see: http://search.cpan.org/search?query=unicode&mode=all
+
+See also the C<unicode_*.pl> programs in the examples directory of the distro.
+
+
+
+=head2 write_unicode_le($row, $column, $string, $format)
+
+This method is the same as C<write_unicode()> except that the string should be 16-bit characters in little-endian format. This is generally referred to as UTF-16LE.
+
+UTF-16 data can be changed from little-endian to big-endian format (and vice-versa) as follows:
+
+ $utf16 = pack "n*", unpack "v*", $utf16;
+
+Note, it is slightly faster to write little-endian data via write_unicode_le() than it is to write big-endian data via write_unicode().
+
+
+
+
+=head2 keep_leading_zeros()
+
+This method changes the default handling of integers with leading zeros when using the C<write()> method.
+
+The C<write()> method uses regular expressions to determine what type of data to write to an Excel worksheet. If the data looks like a number it writes a number using C<write_number()>. One problem with this approach is that occasionally data looks like a number but you don't want it treated as a number.
+
+Zip codes and ID numbers, for example, often start with a leading zero. If you write this data as a number then the leading zero(s) will be stripped. This is the also the default behaviour when you enter data manually in Excel.
+
+To get around this you can use one of three options. Write a formatted number, write the number as a string or use the C<keep_leading_zeros()> method to change the default behaviour of C<write()>:
+
+ # Implicitly write a number, the leading zero is removed: 1209
+ $worksheet->write('A1', '01209');
+
+ # Write a zero padded number using a format: 01209
+ my $format1 = $workbook->add_format(num_format => '00000');
+ $worksheet->write('A2', '01209', $format1);
+
+ # Write explicitly as a string: 01209
+ $worksheet->write_string('A3', '01209');
+
+ # Write implicitly as a string: 01209
+ $worksheet->keep_leading_zeros();
+ $worksheet->write('A4', '01209');
+
+
+The above code would generate a worksheet that looked like the following:
+
+ -----------------------------------------------------------
+ | | A | B | C | D | ...
+ -----------------------------------------------------------
+ | 1 | 1209 | | | | ...
+ | 2 | 01209 | | | | ...
+ | 3 | 01209 | | | | ...
+ | 4 | 01209 | | | | ...
+
+
+The examples are on different sides of the cells due to the fact that Excel displays strings with a left justification and numbers with a right justification by default. You can change this by using a format to justify the data, see L<CELL FORMATTING>.
+
+It should be noted that if the user edits the data in examples C<A3> and C<A4> the strings will revert back to numbers. Again this is Excel's default behaviour. To avoid this you can use the text format C<@>:
+
+ # Format as a string (01209)
+ my $format2 = $workbook->add_format(num_format => '@');
+ $worksheet->write_string('A5', '01209', $format2);
+
+The C<keep_leading_zeros()> property is off by default. The C<keep_leading_zeros()> method takes 0 or 1 as an argument. It defaults to 1 if an argument isn't specified:
+
+ $worksheet->keep_leading_zeros(); # Set on
+ $worksheet->keep_leading_zeros(1); # Set on
+ $worksheet->keep_leading_zeros(0); # Set off
+
+See also the C<add_write_handler()> method.
+
+
+=head2 write_blank($row, $column, $format)
+
+Write a blank cell specified by C<$row> and C<$column>:
+
+ $worksheet->write_blank(0, 0, $format);
+
+This method is used to add formatting to a cell which doesn't contain a string or number value.
+
+Excel differentiates between an "Empty" cell and a "Blank" cell. An "Empty" cell is a cell which doesn't contain data whilst a "Blank" cell is a cell which doesn't contain data but does contain formatting. Excel stores "Blank" cells but ignores "Empty" cells.
+
+As such, if you write an empty cell without formatting it is ignored:
+
+ $worksheet->write('A1', undef, $format); # write_blank()
+ $worksheet->write('A2', undef ); # Ignored
+
+This seemingly uninteresting fact means that you can write arrays of data without special treatment for undef or empty string values.
+
+See the note about L<Cell notation>.
+
+
+
+
+=head2 write_row($row, $column, $array_ref, $format)
+
+The C<write_row()> method can be used to write a 1D or 2D array of data in one go. This is useful for converting the results of a database query into an Excel worksheet. You must pass a reference to the array of data rather than the array itself. The C<write()> method is then called for each element of the data. For example:
+
+ @array = ('awk', 'gawk', 'mawk');
+ $array_ref = \@array;
+
+ $worksheet->write_row(0, 0, $array_ref);
+
+ # The above example is equivalent to:
+ $worksheet->write(0, 0, $array[0]);
+ $worksheet->write(0, 1, $array[1]);
+ $worksheet->write(0, 2, $array[2]);
+
+
+Note: For convenience the C<write()> method behaves in the same way as C<write_row()> if it is passed an array reference. Therefore the following two method calls are equivalent:
+
+ $worksheet->write_row('A1', $array_ref); # Write a row of data
+ $worksheet->write( 'A1', $array_ref); # Same thing
+
+As with all of the write methods the C<$format> parameter is optional. If a format is specified it is applied to all the elements of the data array.
+
+Array references within the data will be treated as columns. This allows you to write 2D arrays of data in one go. For example:
+
+ @eec = (
+ ['maggie', 'milly', 'molly', 'may' ],
+ [13, 14, 15, 16 ],
+ ['shell', 'star', 'crab', 'stone']
+ );
+
+ $worksheet->write_row('A1', \@eec);
+
+
+Would produce a worksheet as follows:
+
+ -----------------------------------------------------------
+ | | A | B | C | D | E | ...
+ -----------------------------------------------------------
+ | 1 | maggie | 13 | shell | ... | ... | ...
+ | 2 | milly | 14 | star | ... | ... | ...
+ | 3 | molly | 15 | crab | ... | ... | ...
+ | 4 | may | 16 | stone | ... | ... | ...
+ | 5 | ... | ... | ... | ... | ... | ...
+ | 6 | ... | ... | ... | ... | ... | ...
+
+
+To write the data in a row-column order refer to the C<write_col()> method below.
+
+Any C<undef> values in the data will be ignored unless a format is applied to the data, in which case a formatted blank cell will be written. In either case the appropriate row or column value will still be incremented.
+
+To find out more about array references refer to C<perlref> and C<perlreftut> in the main Perl documentation. To find out more about 2D arrays or "lists of lists" refer to C<perllol>.
+
+The C<write_row()> method returns the first error encountered when writing the elements of the data or zero if no errors were encountered. See the return values described for the C<write()> method above.
+
+See also the C<write_arrays.pl> program in the C<examples> directory of the distro.
+
+The C<write_row()> method allows the following idiomatic conversion of a text file to an Excel file:
+
+ #!/usr/bin/perl -w
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+ my $workbook = Spreadsheet::WriteExcel->new('file.xls');
+ my $worksheet = $workbook->add_worksheet();
+
+ open INPUT, "file.txt" or die "Couldn't open file: $!";
+
+ $worksheet->write($.-1, 0, [split]) while <INPUT>;
+
+
+
+
+=head2 write_col($row, $column, $array_ref, $format)
+
+The C<write_col()> method can be used to write a 1D or 2D array of data in one go. This is useful for converting the results of a database query into an Excel worksheet. You must pass a reference to the array of data rather than the array itself. The C<write()> method is then called for each element of the data. For example:
+
+ @array = ('awk', 'gawk', 'mawk');
+ $array_ref = \@array;
+
+ $worksheet->write_col(0, 0, $array_ref);
+
+ # The above example is equivalent to:
+ $worksheet->write(0, 0, $array[0]);
+ $worksheet->write(1, 0, $array[1]);
+ $worksheet->write(2, 0, $array[2]);
+
+As with all of the write methods the C<$format> parameter is optional. If a format is specified it is applied to all the elements of the data array.
+
+Array references within the data will be treated as rows. This allows you to write 2D arrays of data in one go. For example:
+
+ @eec = (
+ ['maggie', 'milly', 'molly', 'may' ],
+ [13, 14, 15, 16 ],
+ ['shell', 'star', 'crab', 'stone']
+ );
+
+ $worksheet->write_col('A1', \@eec);
+
+
+Would produce a worksheet as follows:
+
+ -----------------------------------------------------------
+ | | A | B | C | D | E | ...
+ -----------------------------------------------------------
+ | 1 | maggie | milly | molly | may | ... | ...
+ | 2 | 13 | 14 | 15 | 16 | ... | ...
+ | 3 | shell | star | crab | stone | ... | ...
+ | 4 | ... | ... | ... | ... | ... | ...
+ | 5 | ... | ... | ... | ... | ... | ...
+ | 6 | ... | ... | ... | ... | ... | ...
+
+
+To write the data in a column-row order refer to the C<write_row()> method above.
+
+Any C<undef> values in the data will be ignored unless a format is applied to the data, in which case a formatted blank cell will be written. In either case the appropriate row or column value will still be incremented.
+
+As noted above the C<write()> method can be used as a synonym for C<write_row()> and C<write_row()> handles nested array refs as columns. Therefore, the following two method calls are equivalent although the more explicit call to C<write_col()> would be preferable for maintainability:
+
+ $worksheet->write_col('A1', $array_ref ); # Write a column of data
+ $worksheet->write( 'A1', [ $array_ref ]); # Same thing
+
+To find out more about array references refer to C<perlref> and C<perlreftut> in the main Perl documentation. To find out more about 2D arrays or "lists of lists" refer to C<perllol>.
+
+The C<write_col()> method returns the first error encountered when writing the elements of the data or zero if no errors were encountered. See the return values described for the C<write()> method above.
+
+See also the C<write_arrays.pl> program in the C<examples> directory of the distro.
+
+
+
+
+=head2 write_date_time($row, $col, $date_string, $format)
+
+The C<write_date_time()> method can be used to write a date or time to the cell specified by C<$row> and C<$column>:
+
+ $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
+
+The C<$date_string> should be in the following format:
+
+ yyyy-mm-ddThh:mm:ss.sss
+
+This conforms to am ISO8601 date but it should be noted that the full range of ISO8601 formats are not supported.
+
+The following variations on the C<$date_string> parameter are permitted:
+
+ yyyy-mm-ddThh:mm:ss.sss # Standard format
+ yyyy-mm-ddT # No time
+ Thh:mm:ss.sss # No date
+ yyyy-mm-ddThh:mm:ss.sssZ # Additional Z (but not time zones)
+ yyyy-mm-ddThh:mm:ss # No fractional seconds
+ yyyy-mm-ddThh:mm # No seconds
+
+Note that the C<T> is required in all cases.
+
+A date should always have a C<$format>, otherwise it will appear as a number, see L<DATES IN EXCEL> and L<CELL FORMATTING>. Here is a typical example:
+
+ my $date_format = $workbook->add_format(num_format => 'mm/dd/yy');
+ $worksheet->write_date_time('A1', '2004-05-13T23:20', $date_format);
+
+Valid dates should be in the range 1900-01-01 to 9999-12-31, for the 1900 epoch and 1904-01-01 to 9999-12-31, for the 1904 epoch. As with Excel, dates outside these ranges will be written as a string.
+
+See also the date_time.pl program in the C<examples> directory of the distro.
+
+
+
+
+=head2 write_url($row, $col, $url, $string, $format)
+
+Write a hyperlink to a URL in the cell specified by C<$row> and C<$column>. The hyperlink is comprised of two elements: the visible label and the invisible link. The visible label is the same as the link unless an alternative string is specified. The parameters C<$string> and the C<$format> are optional and their position is interchangeable.
+
+The label is written using the C<write_string()> method. Therefore the 255 characters string limit applies to the label: the URL can be any length.
+
+There are four web style URI's supported: C<http://>, C<https://>, C<ftp://> and C<mailto:>:
+
+ $worksheet->write_url(0, 0, 'ftp://www.perl.org/' );
+ $worksheet->write_url(1, 0, 'http://www.perl.com/', 'Perl home' );
+ $worksheet->write_url('A3', 'http://www.perl.com/', $format );
+ $worksheet->write_url('A4', 'http://www.perl.com/', 'Perl', $format);
+ $worksheet->write_url('A5', 'mailto:jmcnamara at cpan.org' );
+
+There are two local URIs supported: C<internal:> and C<external:>. These are used for hyperlinks to internal worksheet references or external workbook and worksheet references:
+
+ $worksheet->write_url('A6', 'internal:Sheet2!A1' );
+ $worksheet->write_url('A7', 'internal:Sheet2!A1', $format );
+ $worksheet->write_url('A8', 'internal:Sheet2!A1:B2' );
+ $worksheet->write_url('A9', q{internal:'Sales Data'!A1} );
+ $worksheet->write_url('A10', 'external:c:\temp\foo.xls' );
+ $worksheet->write_url('A11', 'external:c:\temp\foo.xls#Sheet2!A1' );
+ $worksheet->write_url('A12', 'external:..\..\..\foo.xls' );
+ $worksheet->write_url('A13', 'external:..\..\..\foo.xls#Sheet2!A1' );
+ $worksheet->write_url('A13', 'external:\\\\NETWORK\share\foo.xls' );
+
+All of the these URI types are recognised by the C<write()> method, see above.
+
+Worksheet references are typically of the form C<Sheet1!A1>. You can also refer to a worksheet range using the standard Excel notation: C<Sheet1!A1:B2>.
+
+In external links the workbook and worksheet name must be separated by the C<#> character: C<external:Workbook.xls#Sheet1!A1'>.
+
+You can also link to a named range in the target worksheet. For example say you have a named range called C<my_name> in the workbook C<c:\temp\foo.xls> you could link to it as follows:
+
+ $worksheet->write_url('A14', 'external:c:\temp\foo.xls#my_name');
+
+Note, you cannot currently create named ranges with C<Spreadsheet::WriteExcel>.
+
+Excel requires that worksheet names containing spaces or non alphanumeric characters are single quoted as follows C<'Sales Data'!A1>. If you need to do this in a single quoted string then you can either escape the single quotes C<\'> or use the quote operator C<q{}> as described in C<perlop> in the main Perl documentation.
+
+Links to network files are also supported. MS/Novell Network files normally begin with two back slashes as follows C<\\NETWORK\etc>. In order to generate this in a single or double quoted string you will have to escape the backslashes, C<'\\\\NETWORK\etc'>.
+
+If you are using double quote strings then you should be careful to escape anything that looks like a metacharacter. For more information see C<perlfaq5: Why can't I use "C:\temp\foo" in DOS paths?>.
+
+Finally, you can avoid most of these quoting problems by using forward slashes. These are translated internally to backslashes:
+
+ $worksheet->write_url('A14', "external:c:/temp/foo.xls" );
+ $worksheet->write_url('A15', 'external://NETWORK/share/foo.xls' );
+
+See also, the note about L<Cell notation>.
+
+
+
+
+=head2 write_url_range($row1, $col1, $row2, $col2, $url, $string, $format)
+
+This method is essentially the same as the C<write_url()> method described above. The main difference is that you can specify a link for a range of cells:
+
+ $worksheet->write_url(0, 0, 0, 3, 'ftp://www.perl.org/' );
+ $worksheet->write_url(1, 0, 0, 3, 'http://www.perl.com/', 'Perl home');
+ $worksheet->write_url('A3:D3', 'internal:Sheet2!A1' );
+ $worksheet->write_url('A4:D4', 'external:c:\temp\foo.xls' );
+
+
+This method is generally only required when used in conjunction with merged cells. See the C<merge_range()> method and the C<merge> property of a Format object, L<CELL FORMATTING>.
+
+There is no way to force this behaviour through the C<write()> method.
+
+The parameters C<$string> and the C<$format> are optional and their position is interchangeable. However, they are applied only to the first cell in the range.
+
+See also, the note about L<Cell notation>.
+
+
+
+
+=head2 write_formula($row, $column, $formula, $format)
+
+Write a formula or function to the cell specified by C<$row> and C<$column>:
+
+ $worksheet->write_formula(0, 0, '=$B$3 + B4' );
+ $worksheet->write_formula(1, 0, '=SIN(PI()/4)');
+ $worksheet->write_formula(2, 0, '=SUM(B1:B5)' );
+ $worksheet->write_formula('A4', '=IF(A3>1,"Yes", "No")' );
+ $worksheet->write_formula('A5', '=AVERAGE(1, 2, 3, 4)' );
+ $worksheet->write_formula('A6', '=DATEVALUE("1-Jan-2001")');
+
+See the note about L<Cell notation>. For more information about writing Excel formulas see L<FORMULAS AND FUNCTIONS IN EXCEL>
+
+See also the section "Improving performance when working with formulas" and the C<store_formula()> and C<repeat_formula()> methods.
+
+
+
+
+=head2 store_formula($formula)
+
+The C<store_formula()> method is used in conjunction with C<repeat_formula()> to speed up the generation of repeated formulas. See "Improving performance when working with formulas" in L<FORMULAS AND FUNCTIONS IN EXCEL>.
+
+The C<store_formula()> method pre-parses a textual representation of a formula and stores it for use at a later stage by the C<repeat_formula()> method.
+
+C<store_formula()> carries the same speed penalty as C<write_formula()>. However, in practice it will be used less frequently.
+
+The return value of this method is a scalar that can be thought of as a reference to a formula.
+
+ my $sin = $worksheet->store_formula('=SIN(A1)');
+ my $cos = $worksheet->store_formula('=COS(A1)');
+
+ $worksheet->repeat_formula('B1', $sin, $format, 'A1', 'A2');
+ $worksheet->repeat_formula('C1', $cos, $format, 'A1', 'A2');
+
+Although C<store_formula()> is a worksheet method the return value can be used in any worksheet:
+
+ my $now = $worksheet->store_formula('=NOW()');
+
+ $worksheet1->repeat_formula('B1', $now);
+ $worksheet2->repeat_formula('B1', $now);
+ $worksheet3->repeat_formula('B1', $now);
+
+
+
+=head2 repeat_formula($row, $col, $formula, $format, ($pattern => $replace, ...))
+
+
+The C<repeat_formula()> method is used in conjunction with C<store_formula()> to speed up the generation of repeated formulas. See "Improving performance when working with formulas" in L<FORMULAS AND FUNCTIONS IN EXCEL>.
+
+In many respects C<repeat_formula()> behaves like C<write_formula()> except that it is significantly faster.
+
+The C<repeat_formula()> method creates a new formula based on the pre-parsed tokens returned by C<store_formula()>. The new formula is generated by substituting C<$pattern>, C<$replace> pairs in the stored formula:
+
+ my $formula = $worksheet->store_formula('=A1 * 3 + 50');
+
+ for my $row (0..99) {
+ $worksheet->repeat_formula($row, 1, $formula, $format, 'A1', 'A'.($row +1));
+ }
+
+It should be noted that C<repeat_formula()> doesn't modify the tokens. In the above example the substitution is always made against the original token, C<A1>, which doesn't change.
+
+As usual, you can use C<undef> if you don't wish to specify a C<$format>:
+
+ $worksheet->repeat_formula('B2', $formula, $format, 'A1', 'A2');
+ $worksheet->repeat_formula('B3', $formula, undef, 'A1', 'A3');
+
+The substitutions are made from left to right and you can use as many C<$pattern>, C<$replace> pairs as you need. However, each substitution is made only once:
+
+ my $formula = $worksheet->store_formula('=A1 + A1');
+
+ # Gives '=B1 + A1'
+ $worksheet->repeat_formula('B1', $formula, undef, 'A1', 'B1');
+
+ # Gives '=B1 + B1'
+ $worksheet->repeat_formula('B2', $formula, undef, ('A1', 'B1') x 2);
+
+Since the C<$pattern> is interpolated each time that it is used it is worth using the C<qr> operator to quote the pattern. The C<qr> operator is explained in the C<perlop> man page.
+
+ $worksheet->repeat_formula('B1', $formula, $format, qr/A1/, 'A2');
+
+Care should be taken with the values that are substituted. The formula returned by C<repeat_formula()> contains several other tokens in addition to those in the formula and these might also match the pattern that you are trying to replace. In particular you should avoid substituting a single 0, 1, 2 or 3.
+
+You should also be careful to avoid false matches. For example the following snippet is meant to change the stored formula in steps from C<=A1 + SIN(A1)> to C<=A10 + SIN(A10)>.
+
+ my $formula = $worksheet->store_formula('=A1 + SIN(A1)');
+
+ for my $row (1 .. 10) {
+ $worksheet->repeat_formula($row -1, 1, $formula, undef,
+ qw/A1/, 'A' . $row, #! Bad.
+ qw/A1/, 'A' . $row #! Bad.
+ );
+ }
+
+However it contains a bug. In the last iteration of the loop when C<$row> is 10 the following substitutions will occur:
+
+ s/A1/A10/; changes =A1 + SIN(A1) to =A10 + SIN(A1)
+ s/A1/A10/; changes =A10 + SIN(A1) to =A100 + SIN(A1) # !!
+
+The solution in this case is to use a more explicit match such as C<qw/^A1$/>:
+
+ $worksheet->repeat_formula($row -1, 1, $formula, undef,
+ qw/^A1$/, 'A' . $row,
+ qw/^A1$/, 'A' . $row
+ );
+
+Another similar problem occurs due to the fact that substitutions are made in order. For example the following snippet is meant to change the stored formula from C<=A10 + A11> to C<=A11 + A12>:
+
+ my $formula = $worksheet->store_formula('=A10 + A11');
+
+ $worksheet->repeat_formula('A1', $formula, undef,
+ qw/A10/, 'A11', #! Bad.
+ qw/A11/, 'A12' #! Bad.
+ );
+
+However, the actual substitution yields C<=A12 + A11>:
+
+ s/A10/A11/; changes =A10 + A11 to =A11 + A11
+ s/A11/A12/; changes =A11 + A11 to =A12 + A11 # !!
+
+The solution here would be to reverse the order of the substitutions or to start with a stored formula that won't yield a false match such as C<=X10 + Y11>:
+
+ my $formula = $worksheet->store_formula('=X10 + Y11');
+
+ $worksheet->repeat_formula('A1', $formula, undef,
+ qw/X10/, 'A11',
+ qw/Y11/, 'A12'
+ );
+
+
+If you think that you have a problem related to a false match you can check the tokens that you are substituting against as follows.
+
+ my $formula = $worksheet->store_formula('=A1*5+4');
+ print "@$formula\n";
+
+See also the C<repeat.pl> program in the C<examples> directory of the distro.
+
+
+
+
+=head2 write_comment($row, $column, $string)
+
+B<NOTE: this method is not available in this release. Use the 1.xx versions of this module if you need this feature>.
+
+
+The C<write_comment()> method is used to add a comment to a cell. A cell comment is indicated in Excel by a small red triangle in the upper right-hand corner of the cell. Moving the cursor over the red triangle will cause the comment to appear.
+
+The following example shows how to add a comment to a cell:
+
+ $worksheet->write("C3", "Hello");
+ $worksheet->write_comment("C3", "This is a comment.");
+
+
+The cell comment can be up to 30,000 characters in length.
+
+
+
+
+=head2 add_write_handler($re, $code_ref)
+
+This method is used to extend the Spreadsheet::WriteExcel write() method to handle user defined data.
+
+If you refer to the section on C<write()> above you will see that it acts as an alias for several more specific C<write_*> methods. However, it doesn't always act in exactly the way that you would like it to.
+
+One solution is to filter the input data yourself and call the appropriate C<write_*> method. Another approach is to use the C<add_write_handler()> method to add your own automated behaviour to C<write()>.
+
+The C<add_write_handler()> method take two arguments, C<$re>, a regular expression to match incoming data and C<$code_ref> a callback function to handle the matched data:
+
+ $worksheet->add_write_handler(qr/^\d\d\d\d$/, \&my_write);
+
+(In the these examples the C<qr> operator is used to quote the regular expression strings, see L<perlop> for more details).
+
+The method is use as follows. say you wished to write 7 digit ID numbers as a string so that any leading zeros were preserved*, you could do something like the following:
+
+ $worksheet->add_write_handler(qr/^\d{7}$/, \&write_my_id);
+
+
+ sub write_my_id {
+ my $worksheet = shift;
+ return $worksheet->write_string(@_);
+ }
+
+* You could also use the C<keep_leading_zeros()> method for this.
+
+Then if you call C<write()> with an appropriate string it will be handled automatically:
+
+ # Writes 0000000. It would normally be written as a number; 0.
+ $worksheet->write('A1', '0000000');
+
+The callback function will receive a reference to the calling worksheet and all of the other arguments that were passed to C<write()>. The callback will see an C<@_> argument list that looks like the following:
+
+ $_[0] A ref to the calling worksheet. *
+ $_[1] Zero based row number.
+ $_[2] Zero based column number.
+ $_[3] A number or string or token.
+ $_[4] A format ref if any.
+ $_[5] Any other argruments.
+ ...
+
+ * It is good style to shift this off the list so the @_ is the same
+ as the argument list seen by write().
+
+Your callback should C<return()> the return value of the C<write_*> method that was called or C<undef> to indicate that you rejected the match and want C<write()> to continue as normal.
+
+So for example if you wished to apply the previous filter only to ID values that occur in the first column you could modify your callback function as follows:
+
+
+ sub write_my_id {
+ my $worksheet = shift;
+ my $col = $_[1];
+
+ if ($col == 0) {
+ return $worksheet->write_string(@_);
+ }
+ else {
+ # Reject the match and return control to write()
+ return undef;
+ }
+ }
+
+Now, you will get different behaviour for the first column and other columns:
+
+ $worksheet->write('A1', '0000000'); # Writes 0000000
+ $worksheet->write('B1', '0000000'); # Writes 0
+
+
+You may add more than one handler in which case they will be called in the order that they were added.
+
+Note, the C<add_write_handler()> method is particularly suited for handling dates.
+
+See the C<write_handler 1-4> programs in the C<examples> directory for further examples.
+
+
+
+
+=head2 insert_bitmap($row, $col, $filename, $x, $y, $scale_x, $scale_y)
+
+This method can be used to insert a bitmap into a worksheet. The bitmap must be a 24 bit, true colour, bitmap. No other format is supported. The C<$x>, C<$y>, C<$scale_x> and C<$scale_y> parameters are optional.
+
+ $worksheet1->insert_bitmap('A1', 'perl.bmp');
+ $worksheet2->insert_bitmap('A1', '../images/perl.bmp');
+ $worksheet3->insert_bitmap('A1', '.c:\images\perl.bmp');
+
+Note: you must call C<set_row()> or C<set_column()> before C<insert_bitmap()> if you wish to change the default dimensions of any of the rows or columns that the images occupies. The height of a row can also change if you use a font that is larger than the default. This in turn will affect the scaling of your image. To avoid this you should explicitly set the height of the row using C<set_row()> if it contains a font size that will change the row height.
+
+The parameters C<$x> and C<$y> can be used to specify an offset from the top left hand corner of the cell specified by C<$row> and C<$col>. The offset values are in pixels.
+
+ $worksheet1->insert_bitmap('A1', 'perl.bmp', 32, 10);
+
+The default width of a cell is 63 pixels. The default height of a cell is 17 pixels. The pixels offsets can be calculated using the following relationships:
+
+ Wp = int(12We) if We < 1
+ Wp = int(7We +5) if We >= 1
+ Hp = int(4/3He)
+
+ where:
+ We is the cell width in Excels units
+ Wp is width in pixels
+ He is the cell height in Excels units
+ Hp is height in pixels
+
+The offsets can be greater than the width or height of the underlying cell. This can be occasionally useful if you wish to align two or more images relative to the same cell.
+
+The parameters C<$scale_x> and C<$scale_y> can be used to scale the inserted image horizontally and vertically:
+
+ # Scale the inserted image: width x 2.0, height x 0.8
+ $worksheet->insert_bitmap('A1', 'perl.bmp', 0, 0, 2, 0.8);
+
+Note: although Excel allows you to import several graphics formats such as gif, jpeg, png and eps these are converted internally into a proprietary format. One of the few non-proprietary formats that Excel supports is 24 bit, true colour, bitmaps. Therefore if you wish to use images in any other format you must first use an external application such as the ImageMagick I<convert> utility to convert them to 24 bit bitmaps.
+
+ convert test.png test.bmp
+
+A later release will support the use of file handles and pre-encoded bitmap strings.
+
+See also the C<images.pl> program in the C<examples> directory of the distro.
+
+
+
+
+=head2 get_name()
+
+The C<get_name()> method is used to retrieve the name of a worksheet. For example:
+
+ foreach my $sheet ($workbook->sheets()) {
+ print $sheet->get_name();
+ }
+
+
+
+
+=head2 activate()
+
+The C<activate()> method is used to specify which worksheet is initially visible in a multi-sheet workbook:
+
+ $worksheet1 = $workbook->add_worksheet('To');
+ $worksheet2 = $workbook->add_worksheet('the');
+ $worksheet3 = $workbook->add_worksheet('wind');
+
+ $worksheet3->activate();
+
+This is similar to the Excel VBA activate method. More than one worksheet can be selected via the C<select()> method, however only one worksheet can be active. The default value is the first worksheet.
+
+
+
+
+=head2 select()
+
+The C<select()> method is used to indicate that a worksheet is selected in a multi-sheet workbook:
+
+ $worksheet1->activate();
+ $worksheet2->select();
+ $worksheet3->select();
+
+A selected worksheet has its tab highlighted. Selecting worksheets is a way of grouping them together so that, for example, several worksheets could be printed in one go. A worksheet that has been activated via the C<activate()> method will also appear as selected. You probably won't need to use the C<select()> method very often.
+
+
+
+
+=head2 set_first_sheet()
+
+The C<activate()> method determines which worksheet is initially selected. However, if there are a large number of worksheets the selected worksheet may not appear on the screen. To avoid this you can select which is the leftmost visible worksheet using C<set_first_sheet()>:
+
+ for (1..20) {
+ $workbook->add_worksheet;
+ }
+
+ $worksheet21 = $workbook->add_worksheet();
+ $worksheet22 = $workbook->add_worksheet();
+
+ $worksheet21->set_first_sheet();
+ $worksheet22->activate();
+
+This method is not required very often. The default value is the first worksheet.
+
+
+
+
+=head2 protect($password)
+
+The C<protect()> method is used to protect a worksheet from modification:
+
+ $worksheet->protect();
+
+It can be turned off in Excel via the C<Tools-E<gt>Protection-E<gt>Unprotect Sheet> menu command.
+
+The C<protect()> method also has the effect of enabling a cell's C<locked> and C<hidden> properties if they have been set. A "locked" cell cannot be edited. A "hidden" cell will display the results of a formula but not the formula itself. In Excel a cell's locked property is on by default.
+
+ # Set some format properties
+ my $unlocked = $workbook->add_format(locked => 0);
+ my $hidden = $workbook->add_format(hidden => 1);
+
+ # Enable worksheet protection
+ $worksheet->protect();
+
+ # This cell cannot be edited, it is locked by default
+ $worksheet->write('A1', '=1+2');
+
+ # This cell can be edited
+ $worksheet->write('A2', '=1+2', $unlocked);
+
+ # The formula in this cell isn't visible
+ $worksheet->write('A3', '=1+2', $hidden);
+
+See also the C<set_locked> and C<set_hidden> format methods in L<CELL FORMATTING>.
+
+You can optionally add a password to the worksheet protection:
+
+ $worksheet->protect('drowssap');
+
+Note, the worksheet level password in Excel provides very weak protection. It does not encrypt your data in any way and it is very easy to deactivate. Therefore, do not use the above method if you wish to protect sensitive data or calculations. However, before you get worried, Excel's own workbook level password protection does provide strong encryption in Excel 97+. For technical reasons this will never be supported by C<Spreadsheet::WriteExcel>.
+
+
+
+
+=head2 set_selection($first_row, $first_col, $last_row, $last_col)
+
+This method can be used to specify which cell or cells are selected in a worksheet. The most common requirement is to select a single cell, in which case C<$last_row> and C<$last_col> can be omitted. The active cell within a selected range is determined by the order in which C<$first> and C<$last> are specified. It is also possible to specify a cell or a range using A1 notation. See the note about L<Cell notation>.
+
+Examples:
+
+ $worksheet1->set_selection(3, 3); # 1. Cell D4.
+ $worksheet2->set_selection(3, 3, 6, 6); # 2. Cells D4 to G7.
+ $worksheet3->set_selection(6, 6, 3, 3); # 3. Cells G7 to D4.
+ $worksheet4->set_selection('D4'); # Same as 1.
+ $worksheet5->set_selection('D4:G7'); # Same as 2.
+ $worksheet6->set_selection('G7:D4'); # Same as 3.
+
+The default cell selections is (0, 0), 'A1'.
+
+
+
+
+=head2 set_row($row, $height, $format, $hidden, $level)
+
+This method can be used to change the default properties of a row. All parameters apart from C<$row> are optional.
+
+The most common use for this method is to change the height of a row:
+
+ $worksheet->set_row(0, 20); # Row 1 height set to 20
+
+If you wish to set the format without changing the height you can pass C<undef> as the height parameter:
+
+ $worksheet->set_row(0, undef, $format);
+
+The C<$format> parameter will be applied to any cells in the row that don't have a format. For example
+
+ $worksheet->set_row(0, undef, $format1); # Set the format for row 1
+ $worksheet->write('A1', "Hello"); # Defaults to $format1
+ $worksheet->write('B1', "Hello", $format2); # Keeps $format2
+
+If you wish to define a row format in this way you should call the method before any calls to C<write()>. Calling it afterwards will overwrite any format that was previously specified.
+
+The C<$hidden> parameter should be set to 1 if you wish to hide a row. This can be used, for example, to hide intermediary steps in a complicated calculation:
+
+ $worksheet->set_row(0, 20, $format, 1);
+ $worksheet->set_row(1, undef, undef, 1);
+
+The C<$level> parameter is used to set the outline level of the row. Outlines are described in L<OUTLINES AND GROUPING IN EXCEL>. Adjacent rows with the same outline level are grouped together into a single outline.
+
+The following example sets an outline level of 1 for rows 1 and 2 (zero-indexed):
+
+ $worksheet->set_row(1, undef, undef, 0, 1);
+ $worksheet->set_row(2, undef, undef, 0, 1);
+
+The C<$hidden> parameter can also be used to collapse outlined rows when used in conjunction with the C<$level> parameter.
+
+ $worksheet->set_row(1, undef, undef, 1, 1);
+ $worksheet->set_row(2, undef, undef, 1, 1);
+
+Excel allows up to 7 outline levels. Therefore the C<$level> parameter should be in the range C<0 E<lt>= $level E<lt>= 7>.
+
+
+
+
+=head2 set_column($first_col, $last_col, $width, $format, $hidden, $level)
+
+This method can be used to change the default properties of a single column or a range of columns. All parameters apart from C<$first_col> and C<$last_col> are optional.
+
+If C<set_column()> is applied to a single column the value of C<$first_col> and C<$last_col> should be the same. It is also possible to specify a column range using the form of A1 notation used for columns. See the note about L<Cell notation>.
+
+Examples:
+
+ $worksheet->set_column(0, 0, 20); # Column A width set to 20
+ $worksheet->set_column(1, 3, 30); # Columns B-D width set to 30
+ $worksheet->set_column('E:E', 20); # Column E width set to 20
+ $worksheet->set_column('F:H', 30); # Columns F-H width set to 30
+
+The width corresponds to the column width value that is specified in Excel. It is approximately equal to the length of a string in the default font of Arial 10. Unfortunately, there is no way to specify "AutoFit" for a column in the Excel file format. This feature is only available at runtime from within Excel.
+
+As usual the C<$format> parameter is optional, for additional information, see L<CELL FORMATTING>. If you wish to set the format without changing the width you can pass C<undef> as the width parameter:
+
+ $worksheet->set_column(0, 0, undef, $format);
+
+The C<$format> parameter will be applied to any cells in the column that don't have a format. For example
+
+ $worksheet->set_column('A:A', undef, $format1); # Set format for col 1
+ $worksheet->write('A1', "Hello"); # Defaults to $format1
+ $worksheet->write('A2', "Hello", $format2); # Keeps $format2
+
+If you wish to define a column format in this way you should call the method before any calls to C<write()>. If you call it afterwards it won't have any effect.
+
+A default row format takes precedence over a default column format
+
+ $worksheet->set_row(0, undef, $format1); # Set format for row 1
+ $worksheet->set_column('A:A', undef, $format2); # Set format for col 1
+ $worksheet->write('A1', "Hello"); # Defaults to $format1
+ $worksheet->write('A2', "Hello"); # Defaults to $format2
+
+The C<$hidden> parameter should be set to 1 if you wish to hide a column. This can be used, for example, to hide intermediary steps in a complicated calculation:
+
+ $worksheet->set_column('D:D', 20, $format, 1);
+ $worksheet->set_column('E:E', undef, undef, 1);
+
+The C<$level> parameter is used to set the outline level of the column. Outlines are described in L<OUTLINES AND GROUPING IN EXCEL>. Adjacent columns with the same outline level are grouped together into a single outline.
+
+The following example sets an outline level of 1 for columns B to G:
+
+ $worksheet->set_column('B:G', undef, undef, 0, 1);
+
+The C<$hidden> parameter can also be used to collapse outlined columns when used in conjunction with the C<$level> parameter.
+
+ $worksheet->set_column('B:G', undef, undef, 1, 1);
+
+Excel allows up to 7 outline levels. Therefore the C<$level> parameter should be in the range C<0 E<lt>= $level E<lt>= 7>.
+
+
+
+
+=head2 outline_settings($visible, $symbols_below, $symbols_right, $auto_style)
+
+The C<outline_settings()> method is used to control the appearance of outlines in Excel. Outlines are described in L<OUTLINES AND GROUPING IN EXCEL>.
+
+The C<$visible> parameter is used to control whether or not outlines are visible. Setting this parameter to 0 will cause all outlines on the worksheet to be hidden. They can be unhidden in Excel by means of the "Show Outline Symbols" command button. The default setting is 1 for visible outlines.
+
+ $worksheet->outline_settings(0);
+
+The C<$symbols_below> parameter is used to control whether the row outline symbol will appear above or below the outline level bar. The default setting is 1 for symbols to appear below the outline level bar.
+
+The C<symbols_right> parameter is used to control whether the column outline symbol will appear to the left or the right of the outline level bar. The default setting is 1 for symbols to appear to the right of the outline level bar.
+
+The C<$auto_style> parameter is used to control whether the automatic outline generator in Excel uses automatic styles when creating an outline. This has no effect on a file generated by C<Spreadsheet::WriteExcel> but it does have an effect on how the worksheet behaves after it is created. The default setting is 0 for "Automatic Styles" to be turned off.
+
+The default settings for all of these parameters correspond to Excel's default parameters.
+
+
+The worksheet parameters controlled by C<outline_settings()> are rarely used.
+
+
+
+
+=head2 freeze_panes($row, $col, $top_row, $left_col)
+
+This method can be used to divide a worksheet into horizontal or vertical regions known as panes and to also "freeze" these panes so that the splitter bars are not visible. This is the same as the C<Window-E<gt>Freeze Panes> menu command in Excel
+
+The parameters C<$row> and C<$col> are used to specify the location of the split. It should be noted that the split is specified at the top or left of a cell and that the method uses zero based indexing. Therefore to freeze the first row of a worksheet it is necessary to specify the split at row 2 (which is 1 as the zero-based index). This might lead you to think that you are using a 1 based index but this is not the case.
+
+You can set one of the C<$row> and C<$col> parameters as zero if you do not want either a vertical or horizontal split.
+
+Examples:
+
+ $worksheet->freeze_panes(1, 0); # Freeze the first row
+ $worksheet->freeze_panes('A2'); # Same using A1 notation
+ $worksheet->freeze_panes(0, 1); # Freeze the first column
+ $worksheet->freeze_panes('B1'); # Same using A1 notation
+ $worksheet->freeze_panes(1, 2); # Freeze first row and first 2 columns
+ $worksheet->freeze_panes('C2'); # Same using A1 notation
+
+The parameters C<$top_row> and C<$left_col> are optional. They are used to specify the top-most or left-most visible row or column in the scrolling region of the panes. For example to freeze the first row and to have the scrolling region begin at row twenty:
+
+ $worksheet->freeze_panes(1, 0, 20, 0);
+
+You cannot use A1 notation for the C<$top_row> and C<$left_col> parameters.
+
+
+See also the C<panes.pl> program in the C<examples> directory of the distribution.
+
+
+
+
+=head2 thaw_panes($y, $x, $top_row, $left_col)
+
+This method can be used to divide a worksheet into horizontal or vertical regions known as panes. This method is different from the C<freeze_panes()> method in that the splits between the panes will be visible to the user and each pane will have its own scroll bars.
+
+The parameters C<$y> and C<$x> are used to specify the vertical and horizontal position of the split. The units for C<$y> and C<$x> are the same as those used by Excel to specify row height and column width. However, the vertical and horizontal units are different from each other. Therefore you must specify the C<$y> and C<$x> parameters in terms of the row heights and column widths that you have set or the default values which are C<12.75> for a row and C<8.43> for a column.
+
+You can set one of the C<$y> and C<$x> parameters as zero if you do not want either a vertical or horizontal split. The parameters C<$top_row> and C<$left_col> are optional. They are used to specify the top-most or left-most visible row or column in the bottom-right pane.
+
+Example:
+
+ $worksheet->thaw_panes(12.75, 0, 1, 0); # First row
+ $worksheet->thaw_panes(0, 8.43, 0, 1); # First column
+ $worksheet->thaw_panes(12.75, 8.43, 1, 1); # First row and column
+
+You cannot use A1 notation with this method.
+
+See also the C<freeze_panes()> method and the C<panes.pl> program in the C<examples> directory of the distribution.
+
+
+
+
+=head2 merge_range($first_row, $first_col, $last_row, $last_col, $token, $format)
+
+Merging cells is generally achieved by setting the C<merge> property of a Format object, see L<CELL FORMATTING>. However, this only allows simple Excel5 style horizontal merging which Excel refers to as "center across selection".
+
+The C<merge_range()> method allows you to do Excel97+ style formatting where the cells can contain other types of alignment in addition to the merging:
+
+ my $format = $workbook->add_format(
+ border => 6,
+ valign => 'vcenter',
+ align => 'center',
+ );
+
+ $worksheet->merge_range('B3:D4', 'Vertical and horizontal', $format);
+
+B<WARNING>. The format object that is used with a C<merge_range()> method call is marked internally as being associated with a merged range. As such, B<it should not be used for other formatting>. This will be fixed in a later version. See the L<BUGS> section.
+
+C<merge_range()> writes its $token argument using the worksheet C<write()> method. Therefore it will handle numbers, strings, formulas or urls as required.
+
+Setting the C<merge> property of the format isn't required when you are using C<merge_range()>. In fact using it will exclude the use of any other horizontal alignment option.
+
+The full possibilities of this method are shown in the C<merge3.pl>, C<merge4.pl> and C<merge5.pl> programs in the C<examples> directory of the distribution.
+
+
+
+
+=head2 set_zoom($scale)
+
+Set the worksheet zoom factor in the range C<10 E<lt>= $scale E<lt>= 400>:
+
+ $worksheet1->set_zoom(50);
+ $worksheet2->set_zoom(75);
+ $worksheet3->set_zoom(300);
+ $worksheet4->set_zoom(400);
+
+The default zoom factor is 100. You cannot zoom to "Selection" because it is calculated by Excel at run-time.
+
+Note, C<set_zoom()> does not affect the scale of the printed page. For that you should use C<set_print_scale()>.
+
+
+
+
+=head1 PAGE SET-UP METHODS
+
+Page set-up methods affect the way that a worksheet looks when it is printed. They control features such as page headers and footers and margins. These methods are really just standard worksheet methods. They are documented here in a separate section for the sake of clarity.
+
+The following methods are available for page set-up:
+
+ set_landscape()
+ set_portrait()
+ set_paper()
+ center_horizontally()
+ center_vertically()
+ set_margins()
+ set_header()
+ set_footer()
+ repeat_rows()
+ repeat_columns()
+ hide_gridlines()
+ print_row_col_headers()
+ print_area()
+ fit_to_pages()
+ set_print_scale()
+ set_h_pagebreaks()
+ set_v_pagebreaks()
+
+
+A common requirement when working with Spreadsheet::WriteExcel is to apply the same page set-up features to all of the worksheets in a workbook. To do this you can use the C<sheets()> method of the C<workbook> class to access the array of worksheets in a workbook:
+
+ foreach $worksheet ($workbook->sheets()) {
+ $worksheet->set_landscape();
+ }
+
+
+
+
+=head2 set_landscape()
+
+This method is used to set the orientation of a worksheet's printed page to landscape:
+
+ $worksheet->set_landscape(); # Landscape mode
+
+
+
+
+=head2 set_portrait()
+
+This method is used to set the orientation of a worksheet's printed page to portrait. The default worksheet orientation is portrait, so you won't generally need to call this method.
+
+ $worksheet->set_portrait(); # Portrait mode
+
+
+
+=head2 set_paper($index)
+
+This method is used to set the paper format for the printed output of a worksheet. The following paper styles are available:
+
+ Index Paper format Paper size
+ ===== ============ ==========
+ 0 Printer default -
+ 1 Letter 8 1/2 x 11 in
+ 2 Letter Small 8 1/2 x 11 in
+ 3 Tabloid 11 x 17 in
+ 4 Ledger 17 x 11 in
+ 5 Legal 8 1/2 x 14 in
+ 6 Statement 5 1/2 x 8 1/2 in
+ 7 Executive 7 1/4 x 10 1/2 in
+ 8 A3 297 x 420 mm
+ 9 A4 210 x 297 mm
+ 10 A4 Small 210 x 297 mm
+ 11 A5 148 x 210 mm
+ 12 B4 250 x 354 mm
+ 13 B5 182 x 257 mm
+ 14 Folio 8 1/2 x 13 in
+ 15 Quarto 215 x 275 mm
+ 16 - 10x14 in
+ 17 - 11x17 in
+ 18 Note 8 1/2 x 11 in
+ 19 Envelope 9 3 7/8 x 8 7/8
+ 20 Envelope 10 4 1/8 x 9 1/2
+ 21 Envelope 11 4 1/2 x 10 3/8
+ 22 Envelope 12 4 3/4 x 11
+ 23 Envelope 14 5 x 11 1/2
+ 24 C size sheet -
+ 25 D size sheet -
+ 26 E size sheet -
+ 27 Envelope DL 110 x 220 mm
+ 28 Envelope C3 324 x 458 mm
+ 29 Envelope C4 229 x 324 mm
+ 30 Envelope C5 162 x 229 mm
+ 31 Envelope C6 114 x 162 mm
+ 32 Envelope C65 114 x 229 mm
+ 33 Envelope B4 250 x 353 mm
+ 34 Envelope B5 176 x 250 mm
+ 35 Envelope B6 176 x 125 mm
+ 36 Envelope 110 x 230 mm
+ 37 Monarch 3.875 x 7.5 in
+ 38 Envelope 3 5/8 x 6 1/2 in
+ 39 Fanfold 14 7/8 x 11 in
+ 40 German Std Fanfold 8 1/2 x 12 in
+ 41 German Legal Fanfold 8 1/2 x 13 in
+
+
+Note, it is likely that not all of these paper types will be available to the end user since it will depend on the paper formats that the user's printer supports. Therefore, it is best to stick to standard paper types.
+
+ $worksheet->set_paper(1); # US Letter
+ $worksheet->set_paper(9); # A4
+
+If you do not specify a paper type the worksheet will print using the printer's default paper.
+
+
+
+
+=head2 center_horizontally()
+
+Center the worksheet data horizontally between the margins on the printed page:
+
+ $worksheet->center_horizontally();
+
+
+
+
+=head2 center_vertically()
+
+Center the worksheet data vertically between the margins on the printed page:
+
+ $worksheet->center_vertically();
+
+
+
+
+=head2 set_margins($inches)
+
+There are several methods available for setting the worksheet margins on the printed page:
+
+ set_margins() # Set all margins to the same value
+ set_margins_LR() # Set left and right margins to the same value
+ set_margins_TB() # Set top and bottom margins to the same value
+ set_margin_left(); # Set left margin
+ set_margin_right(); # Set right margin
+ set_margin_top(); # Set top margin
+ set_margin_bottom(); # Set bottom margin
+
+All of these methods take a distance in inches as a parameter. Note: 1 inch = 25.4mm. ;-) The default left and right margin is 0.75 inch. The default top and bottom margin is 1.00 inch.
+
+
+
+=head2 set_header($string, $margin)
+
+Headers and footers are generated using a C<$string> which is a combination of plain text and control characters. The C<$margin> parameter is optional.
+
+The available control character are:
+
+ Control Category Description
+ ======= ======== ===========
+ &L Justification Left
+ &C Center
+ &R Right
+
+ &P Information Page number
+ &N Total number of pages
+ &D Date
+ &T Time
+ &F File name
+ &A Worksheet name
+ &Z Workbook path
+
+ &fontsize Font Font size
+ &"font,style" Font name and style
+ &U Single underline
+ &E Double underline
+ &S Strikethrough
+ &X Superscript
+ &Y Subscript
+
+ && Miscellaneous Literal ampersand &
+
+
+Text in headers and footers can be justified (aligned) to the left, center and right by prefixing the text with the control characters C<&L>, C<&C> and C<&R>.
+
+For example (with ASCII art representation of the results):
+
+ $worksheet->set_header('&LHello');
+
+ ---------------------------------------------------------------
+ | |
+ | Hello |
+ | |
+
+
+ $worksheet->set_header('&CHello');
+
+ ---------------------------------------------------------------
+ | |
+ | Hello |
+ | |
+
+
+ $worksheet->set_header('&RHello');
+
+ ---------------------------------------------------------------
+ | |
+ | Hello |
+ | |
+
+
+For simple text, if you do not specify any justification the text will be centred. However, you must prefix the text with C<&C> if you specify a font name or any other formatting:
+
+ $worksheet->set_header('Hello');
+
+ ---------------------------------------------------------------
+ | |
+ | Hello |
+ | |
+
+
+You can have text in each of the justification regions:
+
+ $worksheet->set_header('&LCiao&CBello&RCielo');
+
+ ---------------------------------------------------------------
+ | |
+ | Ciao Bello Cielo |
+ | |
+
+
+The information control characters act as variables that Excel will update as the workbook or worksheet changes. Times and dates are in the users default format:
+
+ $worksheet->set_header('&CPage &P of &N');
+
+ ---------------------------------------------------------------
+ | |
+ | Page 1 of 6 |
+ | |
+
+
+ $worksheet->set_header('&CUpdated at &T');
+
+ ---------------------------------------------------------------
+ | |
+ | Updated at 12:30 PM |
+ | |
+
+
+
+You can specify the font size of a section of the text by prefixing it with the control character C<&n> where C<n> is the font size:
+
+ $worksheet1->set_header('&C&30Hello Big' );
+ $worksheet2->set_header('&C&10Hello Small');
+
+You can specify the font of a section of the text by prefixing it with the control sequence C<&"font,style"> where C<fontname> is a font name such as "Courier New" or "Times New Roman" and C<style> is one of the standard Windows font descriptions: "Regular", "Italic", "Bold" or "Bold Italic":
+
+ $worksheet1->set_header('&C&"Courier New,Italic"Hello');
+ $worksheet2->set_header('&C&"Courier New,Bold Italic"Hello');
+ $worksheet3->set_header('&C&"Times New Roman,Regular"Hello');
+
+It is possible to combine all of these features together to create sophisticated headers and footers. As an aid to setting up complicated headers and footers you can record a page set-up as a macro in Excel and look at the format strings that VBA produces. Remember however that VBA uses two double quotes C<""> to indicate a single double quote. For the last example above the equivalent VBA code looks like this:
+
+ .LeftHeader = ""
+ .CenterHeader = "&""Times New Roman,Regular""Hello"
+ .RightHeader = ""
+
+
+To include a single literal ampersand C<&> in a header or footer you should use a double ampersand C<&&>:
+
+ $worksheet1->set_header('&CCuriouser && Curiouser - Attorneys at Law');
+
+As stated above the margin parameter is optional. As with the other margins the value should be in inches. The default header and footer margin is 0.50 inch. The header and footer margin size can be set as follows:
+
+ $worksheet->set_header('&CHello', 0.75);
+
+The header and footer margins are independent of the top and bottom margins.
+
+Note, the header or footer string must be less than 255 characters. Strings longer than this will not be written and a warning will be generated.
+
+On systems with C<perl 5.8> and later the C<set_header()> method can also handle Unicode strings in Perl's C<utf8> format.
+
+ $worksheet->set_header("&C\x{263a}")
+
+
+See, also the C<headers.pl> program in the C<examples> directory of the distribution.
+
+
+
+
+=head2 set_footer()
+
+The syntax of the C<set_footer()> method is the same as C<set_header()>, see above.
+
+
+
+
+=head2 repeat_rows($first_row, $last_row)
+
+Set the number of rows to repeat at the top of each printed page.
+
+For large Excel documents it is often desirable to have the first row or rows of the worksheet print out at the top of each page. This can be achieved by using the C<repeat_rows()> method. The parameters C<$first_row> and C<$last_row> are zero based. The C<$last_row> parameter is optional if you only wish to specify one row:
+
+ $worksheet1->repeat_rows(0); # Repeat the first row
+ $worksheet2->repeat_rows(0, 1); # Repeat the first two rows
+
+
+
+
+=head2 repeat_columns($first_col, $last_col)
+
+Set the columns to repeat at the left hand side of each printed page.
+
+For large Excel documents it is often desirable to have the first column or columns of the worksheet print out at the left hand side of each page. This can be achieved by using the C<repeat_columns()> method. The parameters C<$first_column> and C<$last_column> are zero based. The C<$last_column> parameter is optional if you only wish to specify one column. You can also specify the columns using A1 column notation, see the note about L<Cell notation>.
+
+ $worksheet1->repeat_columns(0); # Repeat the first column
+ $worksheet2->repeat_columns(0, 1); # Repeat the first two columns
+ $worksheet3->repeat_columns('A:A'); # Repeat the first column
+ $worksheet4->repeat_columns('A:B'); # Repeat the first two columns
+
+
+
+
+=head2 hide_gridlines($option)
+
+This method is used to hide the gridlines on the screen and printed page. Gridlines are the lines that divide the cells on a worksheet. Screen and printed gridlines are turned on by default in an Excel worksheet. If you have defined your own cell borders you may wish to hide the default gridlines.
+
+ $worksheet->hide_gridlines();
+
+The following values of C<$option> are valid:
+
+ 0 : Don't hide gridlines
+ 1 : Hide printed gridlines only
+ 2 : Hide screen and printed gridlines
+
+If you don't supply an argument or use C<undef> the default option is 1, i.e. only the printed gridlines are hidden.
+
+
+
+
+=head2 print_row_col_headers()
+
+Set the option to print the row and column headers on the printed page.
+
+An Excel worksheet looks something like the following;
+
+ ------------------------------------------
+ | | A | B | C | D | ...
+ ------------------------------------------
+ | 1 | | | | | ...
+ | 2 | | | | | ...
+ | 3 | | | | | ...
+ | 4 | | | | | ...
+ |...| ... | ... | ... | ... | ...
+
+The headers are the letters and numbers at the top and the left of the worksheet. Since these headers serve mainly as a indication of position on the worksheet they generally do not appear on the printed page. If you wish to have them printed you can use the C<print_row_col_headers()> method :
+
+ $worksheet->print_row_col_headers();
+
+Do not confuse these headers with page headers as described in the C<set_header()> section above.
+
+
+
+
+=head2 print_area($first_row, $first_col, $last_row, $last_col)
+
+This method is used to specify the area of the worksheet that will be printed. All four parameters must be specified. You can also use A1 notation, see the note about L<Cell notation>.
+
+
+ $worksheet1->print_area("A1:H20"); # Cells A1 to H20
+ $worksheet2->print_area(0, 0, 19, 7); # The same
+ $worksheet2->print_area('A:H'); # Columns A to H if rows have data
+
+
+
+=head2 fit_to_pages($width, $height)
+
+The C<fit_to_pages()> method is used to fit the printed area to a specific number of pages both vertically and horizontally. If the printed area exceeds the specified number of pages it will be scaled down to fit. This guarantees that the printed area will always appear on the specified number of pages even if the page size or margins change.
+
+ $worksheet1->fit_to_pages(1, 1); # Fit to 1x1 pages
+ $worksheet2->fit_to_pages(2, 1); # Fit to 2x1 pages
+ $worksheet3->fit_to_pages(1, 2); # Fit to 1x2 pages
+
+The print area can be defined using the C<print_area()> method as described above.
+
+A common requirement is to fit the printed output to I<n> pages wide but have the height be as long as necessary. To achieve this set the C<$height> to zero or leave it blank:
+
+ $worksheet1->fit_to_pages(1, 0); # 1 page wide and as long as necessary
+ $worksheet2->fit_to_pages(1); # The same
+
+
+Note that although it is valid to use both C<fit_to_pages()> and C<set_print_scale()> on the same worksheet only one of these options can be active at a time. The last method call made will set the active option.
+
+Note that C<fit_to_pages()> will override any manual page breaks that are defined in the worksheet.
+
+
+
+
+=head2 set_print_scale($scale)
+
+Set the scale factor of the printed page. Scale factors in the range C<10 E<lt>= $scale E<lt>= 400> are valid:
+
+ $worksheet1->set_print_scale(50);
+ $worksheet2->set_print_scale(75);
+ $worksheet3->set_print_scale(300);
+ $worksheet4->set_print_scale(400);
+
+The default scale factor is 100. Note, C<set_print_scale()> does not affect the scale of the visible page in Excel. For that you should use C<set_zoom()>.
+
+Note also that although it is valid to use both C<fit_to_pages()> and C<set_print_scale()> on the same worksheet only one of these options can be active at a time. The last method call made will set the active option.
+
+
+
+
+=head2 set_h_pagebreaks(@breaks)
+
+Add horizontal page breaks to a worksheet. A page break causes all the data that follows it to be printed on the next page. Horizontal page breaks act between rows. To create a page break between rows 20 and 21 you must specify the break at row 21. However in zero index notation this is actually row 20. So you can pretend for a small while that you are using 1 index notation:
+
+ $worksheet1->set_h_pagebreaks(20); # Break between row 20 and 21
+
+The C<set_h_pagebreaks()> method will accept a list of page breaks and you can call it more than once:
+
+ $worksheet2->set_h_pagebreaks( 20, 40, 60, 80, 100); # Add breaks
+ $worksheet2->set_h_pagebreaks(120, 140, 160, 180, 200); # Add some more
+
+Note: If you specify the "fit to page" option via the C<fit_to_pages()> method it will override all manual page breaks.
+
+There is a silent limitation of about 1000 horizontal page breaks per worksheet in line with an Excel internal limitation.
+
+
+
+
+=head2 set_v_pagebreaks(@breaks)
+
+Add vertical page breaks to a worksheet. A page break causes all the data that follows it to be printed on the next page. Vertical page breaks act between columns. To create a page break between columns 20 and 21 you must specify the break at column 21. However in zero index notation this is actually column 20. So you can pretend for a small while that you are using 1 index notation:
+
+ $worksheet1->set_v_pagebreaks(20); # Break between column 20 and 21
+
+The C<set_v_pagebreaks()> method will accept a list of page breaks and you can call it more than once:
+
+ $worksheet2->set_v_pagebreaks( 20, 40, 60, 80, 100); # Add breaks
+ $worksheet2->set_v_pagebreaks(120, 140, 160, 180, 200); # Add some more
+
+Note: If you specify the "fit to page" option via the C<fit_to_pages()> method it will override all manual page breaks.
+
+
+
+
+=head1 CELL FORMATTING
+
+This section describes the methods and properties that are available for formatting cells in Excel. The properties of a cell that can be formatted include: fonts, colours, patterns, borders, alignment and number formatting.
+
+
+=head2 Creating and using a Format object
+
+Cell formatting is defined through a Format object. Format objects are created by calling the workbook C<add_format()> method as follows:
+
+ my $format1 = $workbook->add_format(); # Set properties later
+ my $format2 = $workbook->add_format(%props); # Set at creation
+
+The format object holds all the formatting properties that can be applied to a cell, a row or a column. The process of setting these properties is discussed in the next section.
+
+Once a Format object has been constructed and it properties have been set it can be passed as an argument to the worksheet C<write> methods as follows:
+
+ $worksheet->write(0, 0, "One", $format);
+ $worksheet->write_string(1, 0, "Two", $format);
+ $worksheet->write_number(2, 0, 3, $format);
+ $worksheet->write_blank(3, 0, $format);
+
+Formats can also be passed to the worksheet C<set_row()> and C<set_column()> methods to define the default property for a row or column.
+
+ $worksheet->set_row(0, 15, $format);
+ $worksheet->set_column(0, 0, 15, $format);
+
+
+
+
+=head2 Format methods and Format properties
+
+The following table shows the Excel format categories, the formatting properties that can be applied and the equivalent object method:
+
+
+ Category Description Property Method Name
+ -------- ----------- -------- -----------
+ Font Font type font set_font()
+ Font size size set_size()
+ Font color color set_color()
+ Bold bold set_bold()
+ Italic italic set_italic()
+ Underline underline set_underline()
+ Strikeout font_strikeout set_font_strikeout()
+ Super/Subscript font_script set_font_script()
+ Outline font_outline set_font_outline()
+ Shadow font_shadow set_font_shadow()
+
+ Number Numeric format num_format set_num_format()
+
+ Protection Lock cells locked set_locked()
+ Hide formulas hidden set_hidden()
+
+ Alignment Horizontal align align set_align()
+ Vertical align valign set_align()
+ Rotation rotation set_rotation()
+ Text wrap text_wrap set_text_wrap()
+ Justify last text_justlast set_text_justlast()
+ Center across center_across set_center_across()
+ Indentation indent set_indent()
+ Shrink to fit shrink set_shrink()
+
+ Pattern Cell pattern pattern set_pattern()
+ Background color bg_color set_bg_color()
+ Foreground color fg_color set_fg_color()
+
+ Border Cell border border set_border()
+ Bottom border bottom set_bottom()
+ Top border top set_top()
+ Left border left set_left()
+ Right border right set_right()
+ Border color border_color set_border_color()
+ Bottom color bottom_color set_bottom_color()
+ Top color top_color set_top_color()
+ Left color left_color set_left_color()
+ Right color right_color set_right_color()
+
+There are two ways of setting Format properties: by using the object method interface or by setting the property directly. For example, a typical use of the method interface would be as follows:
+
+ my $format = $workbook->add_format();
+ $format->set_bold();
+ $format->set_color('red');
+
+By comparison the properties can be set directly by passing a hash of properties to the Format constructor:
+
+ my $format = $workbook->add_format(bold => 1, color => 'red');
+
+or after the Format has been constructed by means of the C<set_properties()> method as follows:
+
+ my $format = $workbook->add_format();
+ $format->set_properties(bold => 1, color => 'red');
+
+You can also store the properties in one or more named hashes and pass them to the required method:
+
+ my %font = (
+ font => 'Arial',
+ size => 12,
+ color => 'blue',
+ bold => 1,
+ );
+
+ my %shading = (
+ bg_color => 'green',
+ pattern => 1,
+ );
+
+
+ my $format1 = $workbook->add_format(%font); # Font only
+ my $format2 = $workbook->add_format(%font, %shading); # Font and shading
+
+
+The provision of two ways of setting properties might lead you to wonder which is the best way. The answer depends on the amount of formatting that will be required in your program. Initially, Spreadsheet::WriteExcel only allowed individual Format properties to be set via the appropriate method. While this was sufficient for most circumstances it proved very cumbersome in programs that required a large amount of formatting. In addition the mechanism for reusing properties between Format objects was complicated.
+
+As a result the Perl/Tk style of adding properties was added to, hopefully, facilitate developers who need to define a lot of formatting. In fact the Tk style of defining properties is also supported:
+
+ my %font = (
+ -font => 'Arial',
+ -size => 12,
+ -color => 'blue',
+ -bold => 1,
+ );
+
+An additional advantage of working with hashes of properties is that it allows you to share formatting between workbook objects
+
+You can also create a format "on the fly" and pass it directly to a write method as follows:
+
+ $worksheet->write('A1', "Title", $workbook->add_format(bold => 1));
+
+This corresponds to an "anonymous" format in the Perl sense of anonymous data or subs.
+
+
+
+
+=head2 Working with formats
+
+The default format is Arial 10 with all other properties off.
+
+Each unique format in Spreadsheet::WriteExcel must have a corresponding Format object. It isn't possible to use a Format with a write() method and then redefine the Format for use at a later stage. This is because a Format is applied to a cell not in its current state but in its final state. Consider the following example:
+
+ my $format = $workbook->add_format();
+ $format->set_bold();
+ $format->set_color('red');
+ $worksheet->write('A1', "Cell A1", $format);
+ $format->set_color('green');
+ $worksheet->write('B1', "Cell B1", $format);
+
+Cell A1 is assigned the Format C<$format> which is initially set to the colour red. However, the colour is subsequently set to green. When Excel displays Cell A1 it will display the final state of the Format which in this case will be the colour green.
+
+In general a method call without an argument will turn a property on, for example:
+
+ my $format1 = $workbook->add_format();
+ $format1->set_bold(); # Turns bold on
+ $format1->set_bold(1); # Also turns bold on
+ $format1->set_bold(0); # Turns bold off
+
+
+
+
+=head1 FORMAT METHODS
+
+The Format object methods are described in more detail in the following sections. In addition, there is a Perl program called C<formats.pl> in the C<examples> directory of the WriteExcel distribution. This program creates an Excel workbook called C<formats.xls> which contains examples of almost all the format types.
+
+The following Format methods are available:
+
+ set_font()
+ set_size()
+ set_color()
+ set_bold()
+ set_italic()
+ set_underline()
+ set_font_strikeout()
+ set_font_script()
+ set_font_outline()
+ set_font_shadow()
+ set_num_format()
+ set_locked()
+ set_hidden()
+ set_align()
+ set_align()
+ set_rotation()
+ set_text_wrap()
+ set_text_justlast()
+ set_center_across()
+ set_indent()
+ set_shrink()
+ set_pattern()
+ set_bg_color()
+ set_fg_color()
+ set_border()
+ set_bottom()
+ set_top()
+ set_left()
+ set_right()
+ set_border_color()
+ set_bottom_color()
+ set_top_color()
+ set_left_color()
+ set_right_color()
+
+
+The above methods can also be applied directly as properties. For example C<$worksheet-E<gt>set_bold()> is equivalent to C<set_properties(bold =E<gt> 1)>.
+
+
+=head2 set_properties(%properties)
+
+The properties of an existing Format object can be set by means of C<set_properties()>:
+
+ my $format = $workbook->add_format();
+ $format->set_properties(bold => 1, color => 'red');
+
+You can also store the properties in one or more named hashes and pass them to the C<set_properties()> method:
+
+ my %font = (
+ font => 'Arial',
+ size => 12,
+ color => 'blue',
+ bold => 1,
+ );
+
+ my $format = $workbook->set_properties(%font);
+
+This method can be used as an alternative to setting the properties with C<add_format()> or the specific format methods that are detailed in the following sections.
+
+
+
+
+=head2 set_font($fontname)
+
+ Default state: Font is Arial
+ Default action: None
+ Valid args: Any valid font name
+
+Specify the font used:
+
+ $format->set_font('Times New Roman');
+
+Excel can only display fonts that are installed on the system that it is running on. Therefore it is best to use the fonts that come as standard such as 'Arial', 'Times New Roman' and 'Courier New'. See also the Fonts worksheet created by formats.pl
+
+
+
+
+=head2 set_size()
+
+ Default state: Font size is 10
+ Default action: Set font size to 1
+ Valid args: Integer values from 1 to as big as your screen.
+
+
+Set the font size. Excel adjusts the height of a row to accommodate the largest font size in the row. You can also explicitly specify the height of a row using the set_row() worksheet method.
+
+ my $format = $workbook->add_format();
+ $format->set_size(30);
+
+
+
+
+
+=head2 set_color()
+
+ Default state: Excels default color, usually black
+ Default action: Set the default color
+ Valid args: Integers from 8..63 or the following strings:
+ 'black'
+ 'blue'
+ 'brown'
+ 'cyan'
+ 'gray'
+ 'green'
+ 'lime'
+ 'magenta'
+ 'navy'
+ 'orange'
+ 'purple'
+ 'red'
+ 'silver'
+ 'white'
+ 'yellow'
+
+Set the font colour. The C<set_color()> method is used as follows:
+
+ my $format = $workbook->add_format();
+ $format->set_color('red');
+ $worksheet->write(0, 0, "wheelbarrow", $format);
+
+Note: The C<set_color()> method is used to set the colour of the font in a cell. To set the colour of a cell use the C<set_bg_color()> and C<set_pattern()> methods.
+
+For additional examples see the 'Named colors' and 'Standard colors' worksheets created by formats.pl in the examples directory.
+
+See also L<COLOURS IN EXCEL>.
+
+
+
+
+=head2 set_bold()
+
+ Default state: bold is off
+ Default action: Turn bold on
+ Valid args: 0, 1 [1]
+
+Set the bold property of the font:
+
+ $format->set_bold(); # Turn bold on
+
+[1] Actually, values in the range 100..1000 are also valid. 400 is normal, 700 is bold and 1000 is very bold indeed. It is probably best to set the value to 1 and use normal bold.
+
+
+
+
+=head2 set_italic()
+
+ Default state: Italic is off
+ Default action: Turn italic on
+ Valid args: 0, 1
+
+Set the italic property of the font:
+
+ $format->set_italic(); # Turn italic on
+
+
+
+
+=head2 set_underline()
+
+ Default state: Underline is off
+ Default action: Turn on single underline
+ Valid args: 0 = No underline
+ 1 = Single underline
+ 2 = Double underline
+ 33 = Single accounting underline
+ 34 = Double accounting underline
+
+Set the underline property of the font.
+
+ $format->set_underline(); # Single underline
+
+
+
+
+=head2 set_font_strikeout()
+
+ Default state: Strikeout is off
+ Default action: Turn strikeout on
+ Valid args: 0, 1
+
+Set the strikeout property of the font.
+
+
+
+
+=head2 set_font_script()
+
+ Default state: Super/Subscript is off
+ Default action: Turn Superscript on
+ Valid args: 0 = Normal
+ 1 = Superscript
+ 2 = Subscript
+
+Set the superscript/subscript property of the font. This format is currently not very useful.
+
+
+
+
+=head2 set_font_outline()
+
+ Default state: Outline is off
+ Default action: Turn outline on
+ Valid args: 0, 1
+
+Macintosh only.
+
+
+
+
+=head2 set_font_shadow()
+
+ Default state: Shadow is off
+ Default action: Turn shadow on
+ Valid args: 0, 1
+
+Macintosh only.
+
+
+
+
+=head2 set_num_format()
+
+ Default state: General format
+ Default action: Format index 1
+ Valid args: See the following table
+
+This method is used to define the numerical format of a number in Excel. It controls whether a number is displayed as an integer, a floating point number, a date, a currency value or some other user defined format.
+
+The numerical format of a cell can be specified by using a format string or an index to one of Excel's built-in formats:
+
+ my $format1 = $workbook->add_format();
+ my $format2 = $workbook->add_format();
+ $format1->set_num_format('d mmm yyyy'); # Format string
+ $format2->set_num_format(0x0f); # Format index
+
+ $worksheet->write(0, 0, 36892.521, $format1); # 1 Jan 2001
+ $worksheet->write(0, 0, 36892.521, $format2); # 1-Jan-01
+
+
+Using format strings you can define very sophisticated formatting of numbers.
+
+ $format01->set_num_format('0.000');
+ $worksheet->write(0, 0, 3.1415926, $format01); # 3.142
+
+ $format02->set_num_format('#,##0');
+ $worksheet->write(1, 0, 1234.56, $format02); # 1,235
+
+ $format03->set_num_format('#,##0.00');
+ $worksheet->write(2, 0, 1234.56, $format03); # 1,234.56
+
+ $format04->set_num_format('$0.00');
+ $worksheet->write(3, 0, 49.99, $format04); # $49.99
+
+ $format05->set_num_format('£0.00');
+ $worksheet->write(4, 0, 49.99, $format05); # £49.99
+
+ $format06->set_num_format('¥0.00');
+ $worksheet->write(5, 0, 49.99, $format06); # ¥49.99
+
+ $format07->set_num_format('mm/dd/yy');
+ $worksheet->write(6, 0, 36892.521, $format07); # 01/01/01
+
+ $format08->set_num_format('mmm d yyyy');
+ $worksheet->write(7, 0, 36892.521, $format08); # Jan 1 2001
+
+ $format09->set_num_format('d mmmm yyyy');
+ $worksheet->write(8, 0, 36892.521, $format09); # 1 January 2001
+
+ $format10->set_num_format('dd/mm/yyyy hh:mm AM/PM');
+ $worksheet->write(9, 0, 36892.521, $format10); # 01/01/2001 12:30 AM
+
+ $format11->set_num_format('0 "dollar and" .00 "cents"');
+ $worksheet->write(10, 0, 1.87, $format11); # 1 dollar and .87 cents
+
+ # Conditional formatting
+ $format12->set_num_format('[Green]General;[Red]-General;General');
+ $worksheet->write(11, 0, 123, $format12); # > 0 Green
+ $worksheet->write(12, 0, -45, $format12); # < 0 Red
+ $worksheet->write(13, 0, 0, $format12); # = 0 Default colour
+
+ # Zip code
+ $format13->set_num_format('00000');
+ $worksheet->write(14, 0, '01209', $format13);
+
+
+The number system used for dates is described in L<DATES IN EXCEL>.
+
+The colour format should have one of the following values:
+
+ [Black] [Blue] [Cyan] [Green] [Magenta] [Red] [White] [Yellow]
+
+Alternatively you can specify the colour based on a colour index as follows: C<[Color n]>, where n is a standard Excel colour index - 7. See the 'Standard colors' worksheet created by formats.pl.
+
+For more information refer to the documentation on formatting in the C<doc> directory of the Spreadsheet::WriteExcel distro, the Excel on-line help or to the tutorial at: http://support.microsoft.com/support/Excel/Content/Formats/default.asp and http://support.microsoft.com/support/Excel/Content/Formats/codes.asp
+
+You should ensure that the format string is valid in Excel prior to using it in WriteExcel.
+
+Excel's built-in formats are shown in the following table:
+
+ Index Index Format String
+ 0 0x00 General
+ 1 0x01 0
+ 2 0x02 0.00
+ 3 0x03 #,##0
+ 4 0x04 #,##0.00
+ 5 0x05 ($#,##0_);($#,##0)
+ 6 0x06 ($#,##0_);[Red]($#,##0)
+ 7 0x07 ($#,##0.00_);($#,##0.00)
+ 8 0x08 ($#,##0.00_);[Red]($#,##0.00)
+ 9 0x09 0%
+ 10 0x0a 0.00%
+ 11 0x0b 0.00E+00
+ 12 0x0c # ?/?
+ 13 0x0d # ??/??
+ 14 0x0e m/d/yy
+ 15 0x0f d-mmm-yy
+ 16 0x10 d-mmm
+ 17 0x11 mmm-yy
+ 18 0x12 h:mm AM/PM
+ 19 0x13 h:mm:ss AM/PM
+ 20 0x14 h:mm
+ 21 0x15 h:mm:ss
+ 22 0x16 m/d/yy h:mm
+ .. .... ...........
+ 37 0x25 (#,##0_);(#,##0)
+ 38 0x26 (#,##0_);[Red](#,##0)
+ 39 0x27 (#,##0.00_);(#,##0.00)
+ 40 0x28 (#,##0.00_);[Red](#,##0.00)
+ 41 0x29 _(* #,##0_);_(* (#,##0);_(* "-"_);_(@_)
+ 42 0x2a _($* #,##0_);_($* (#,##0);_($* "-"_);_(@_)
+ 43 0x2b _(* #,##0.00_);_(* (#,##0.00);_(* "-"??_);_(@_)
+ 44 0x2c _($* #,##0.00_);_($* (#,##0.00);_($* "-"??_);_(@_)
+ 45 0x2d mm:ss
+ 46 0x2e [h]:mm:ss
+ 47 0x2f mm:ss.0
+ 48 0x30 ##0.0E+0
+ 49 0x31 @
+
+
+For examples of these formatting codes see the 'Numerical formats' worksheet created by formats.pl. See also the number_formats1.html and the number_formats2.html documents in the C<doc> directory of the distro.
+
+Note 1. Numeric formats 23 to 36 are not documented by Microsoft and may differ in international versions.
+
+Note 2. In Excel 5 the dollar sign appears as a dollar sign. In Excel 97-2000 it appears as the defined local currency symbol.
+
+Note 3. The red negative numeric formats display slightly differently in Excel 5 and Excel 97-2000.
+
+
+
+
+=head2 set_locked()
+
+ Default state: Cell locking is on
+ Default action: Turn locking on
+ Valid args: 0, 1
+
+This property can be used to prevent modification of a cells contents. Following Excel's convention, cell locking is turned on by default. However, it only has an effect if the worksheet has been protected, see the worksheet C<protect()> method.
+
+ my $locked = $workbook->add_format();
+ $locked->set_locked(1); # A non-op
+
+ my $unlocked = $workbook->add_format();
+ $locked->set_locked(0);
+
+ # Enable worksheet protection
+ $worksheet->protect();
+
+ # This cell cannot be edited.
+ $worksheet->write('A1', '=1+2', $locked);
+
+ # This cell can be edited.
+ $worksheet->write('A2', '=1+2', $unlocked);
+
+Note: This offers weak protection even with a password, see the note in relation to the C<protect()> method.
+
+
+
+
+=head2 set_hidden()
+
+ Default state: Formula hiding is off
+ Default action: Turn hiding on
+ Valid args: 0, 1
+
+This property is used to hide a formula while still displaying its result. This is generally used to hide complex calculations from end users who are only interested in the result. It only has an effect if the worksheet has been protected, see the worksheet C<protect()> method.
+
+ my $hidden = $workbook->add_format();
+ $hidden->set_hidden();
+
+ # Enable worksheet protection
+ $worksheet->protect();
+
+ # The formula in this cell isn't visible
+ $worksheet->write('A1', '=1+2', $hidden);
+
+
+Note: This offers weak protection even with a password, see the note in relation to the C<protect()> method.
+
+
+
+
+=head2 set_align()
+
+ Default state: Alignment is off
+ Default action: Left alignment
+ Valid args: 'left' Horizontal
+ 'center'
+ 'right'
+ 'fill'
+ 'justify'
+ 'center_across'
+
+ 'top' Vertical
+ 'vcenter'
+ 'bottom'
+ 'vjustify'
+
+This method is used to set the horizontal and vertical text alignment within a cell. Vertical and horizontal alignments can be combined. The method is used as follows:
+
+ my $format = $workbook->add_format();
+ $format->set_align('center');
+ $format->set_align('vcenter');
+ $worksheet->set_row(0, 30);
+ $worksheet->write(0, 0, "X", $format);
+
+Text can be aligned across two or more adjacent cells using the C<center_across> property. However, for genuine merged cells it is better to use the C<merge_range()> worksheet method.
+
+The C<vjustify> (vertical justify) option can be used to provide automatic text wrapping in a cell. The height of the cell will be adjusted to accommodate the wrapped text. To specify where the text wraps use the C<set_text_wrap()> method.
+
+
+For further examples see the 'Alignment' worksheet created by formats.pl.
+
+
+
+
+=head2 set_center_across()
+
+ Default state: Center across selection is off
+ Default action: Turn center across on
+ Valid args: 1
+
+Text can be aligned across two or more adjacent cells using the C<set_center_across()> method. This is an alias for the C<set_align('center_across')> method call.
+
+Only one cell should contain the text, the other cells should be blank:
+
+ my $format = $workbook->add_format();
+ $format->set_center_across();
+
+ $worksheet->write(1, 1, 'Center across selection', $format);
+ $worksheet->write_blank(1, 2, $format);
+
+See also the C<merge1.pl> to C<merge5.pl> programs in the C<examples> directory and the C<merge_range()> method.
+
+
+
+=head2 set_text_wrap()
+
+ Default state: Text wrap is off
+ Default action: Turn text wrap on
+ Valid args: 0, 1
+
+
+Here is an example using the text wrap property, the escape character C<\n> is used to indicate the end of line:
+
+ my $format = $workbook->add_format();
+ $format->set_text_wrap();
+ $worksheet->write(0, 0, "It's\na bum\nwrap", $format);
+
+Excel will adjust the height of the row to accommodate the wrapped text. A similar effect can be obtained without newlines using the C<set_align('vjustify')> method. See the C<textwrap.pl> program in the C<examples> directory.
+
+
+
+
+=head2 set_rotation()
+
+ Default state: Text rotation is off
+ Default action: None
+ Valid args: Integers in the range -90 to 90 and 270
+
+Set the rotation of the text in a cell. The rotation can be any angle in the range -90 to 90 degrees.
+
+ my $format = $workbook->add_format();
+ $format->set_rotation(30);
+ $worksheet->write(0, 0, "This text is rotated", $format);
+
+
+The angle 270 is also supported. This indicates text where the letters run from top to bottom.
+
+
+
+=head2 set_indent()
+
+
+ Default state: Text indentation is off
+ Default action: Indent text 1 level
+ Valid args: Positive integers
+
+
+This method can be used to indent text. The argument, which should be an integer, is taken as the level of indentation:
+
+
+ my $format = $workbook->add_format();
+ $format->set_indent(2);
+ $worksheet->write(0, 0, "This text is indented", $format);
+
+
+Indentation is a horizontal alignment property. It will override any other horizontal properties but it can be used in conjunction with vertical properties.
+
+
+
+
+=head2 set_shrink()
+
+
+ Default state: Text shrinking is off
+ Default action: Turn "shrink to fit" on
+ Valid args: 1
+
+
+This method can be used to shrink text so that it fits in a cell.
+
+
+ my $format = $workbook->add_format();
+ $format->set_shrink();
+ $worksheet->write(0, 0, "Honey, I shrunk the text!", $format);
+
+
+
+
+=head2 set_text_justlast()
+
+ Default state: Justify last is off
+ Default action: Turn justify last on
+ Valid args: 0, 1
+
+
+Only applies to Far Eastern versions of Excel.
+
+
+
+
+=head2 set_pattern()
+
+ Default state: Pattern is off
+ Default action: Solid fill is on
+ Valid args: 0 .. 18
+
+Set the background pattern of a cell.
+
+Examples of the available patterns are shown in the 'Patterns' worksheet created by formats.pl. However, it is unlikely that you will ever need anything other than Pattern 1 which is a solid fill of the background color.
+
+
+
+
+=head2 set_bg_color()
+
+ Default state: Color is off
+ Default action: Solid fill.
+ Valid args: See set_color()
+
+The C<set_bg_color()> method can be used to set the background colour of a pattern. Patterns are defined via the C<set_pattern()> method. If a pattern hasn't been defined then a solid fill pattern is used as the default.
+
+Here is an example of how to set up a solid fill in a cell:
+
+ my $format = $workbook->add_format();
+
+ $format->set_pattern(); # This is optional when using a solid fill
+
+ $format->set_bg_color('green');
+ $worksheet->write('A1', 'Ray', $format);
+
+For further examples see the 'Patterns' worksheet created by formats.pl.
+
+
+
+
+=head2 set_fg_color()
+
+ Default state: Color is off
+ Default action: Solid fill.
+ Valid args: See set_color()
+
+
+The C<set_fg_color()> method can be used to set the foreground colour of a pattern.
+
+For further examples see the 'Patterns' worksheet created by formats.pl.
+
+
+
+
+=head2 set_border()
+
+ Also applies to: set_bottom()
+ set_top()
+ set_left()
+ set_right()
+
+ Default state: Border is off
+ Default action: Set border type 1
+ Valid args: 0 No border
+ 1 Thin single border
+ 2 Medium single border
+ 3 Dashed border
+ 4 Dotted border
+ 5 Thick single border
+ 6 Double line border
+ 7 Hair border
+
+
+A cell border is comprised of a border on the bottom, top, left and right. These can be set to the same value using C<set_border()> or individually using the relevant method calls shown above. Examples of the available border styles are shown in the 'Borders' worksheet created by formats.pl.
+
+
+
+
+=head2 set_border_color()
+
+ Also applies to: set_bottom_color()
+ set_top_color()
+ set_left_color()
+ set_right_color()
+
+ Default state: Color is off
+ Default action: Undefined
+ Valid args: See set_color()
+
+
+Set the colour of the cell borders. A cell border is comprised of a border on the bottom, top, left and right. These can be set to the same colour using C<set_border_color()> or individually using the relevant method calls shown above. Examples of the border styles and colours are shown in the 'Borders' worksheet created by formats.pl.
+
+
+
+
+
+=head2 copy($format)
+
+
+This method is used to copy all of the properties from one Format object to another:
+
+ my $lorry1 = $workbook->add_format();
+ $lorry1->set_bold();
+ $lorry1->set_italic();
+ $lorry1->set_color('red'); # lorry1 is bold, italic and red
+
+ my $lorry2 = $workbook->add_format();
+ $lorry2->copy($lorry1);
+ $lorry2->set_color('yellow'); # lorry2 is bold, italic and yellow
+
+The C<copy()> method is only useful if you are using the method interface to Format properties. It generally isn't required if you are setting Format properties directly using hashes.
+
+
+Note: this is not a copy constructor, both objects must exist prior to copying.
+
+
+
+
+=head1 COLOURS IN EXCEL
+
+Excel provides a colour palette of 56 colours. In Spreadsheet::WriteExcel these colours are accessed via their palette index in the range 8..63. This index is used to set the colour of fonts, cell patterns and cell borders. For example:
+
+ my $format = $workbook->add_format(
+ color => 12, # index for blue
+ font => 'Arial',
+ size => 12,
+ bold => 1,
+ );
+
+The most commonly used colours can also be accessed by name. The name acts as a simple alias for the colour index:
+
+ black => 8
+ blue => 12
+ brown => 16
+ cyan => 15
+ gray => 23
+ green => 17
+ lime => 11
+ magenta => 14
+ navy => 18
+ orange => 53
+ purple => 20
+ red => 10
+ silver => 22
+ white => 9
+ yellow => 13
+
+For example:
+
+ my $font = $workbook->add_format(color => 'red');
+
+Users of VBA in Excel should note that the equivalent colour indices are in the range 1..56 instead of 8..63.
+
+If the default palette does not provide a required colour you can override one of the built-in values. This is achieved by using the C<set_custom_color()> workbook method to adjust the RGB (red green blue) components of the colour:
+
+ my $ferrari = $workbook->set_custom_color(40, 216, 12, 12);
+
+ my $format = $workbook->add_format(
+ bg_color => $ferrari,
+ pattern => 1,
+ border => 1
+ );
+
+ $worksheet->write_blank('A1', $format);
+
+The default Excel 97 colour palette is shown in C<palette.html> in the C<doc> directory of the distro. You can generate an Excel version of the palette using C<colors.pl> in the C<examples> directory.
+
+A comparison of the colour components in the Excel 5 and Excel 97+ colour palettes is shown in C<rgb5-97.txt> in the C<doc> directory.
+
+
+You may also find the following links helpful:
+
+A detailed look at Excel's colour palette: http://www.geocities.com/davemcritchie/excel/colors.htm
+
+A decimal RGB chart: http://www.hypersolutions.org/pages/rgbdec.html
+
+A hex RGB chart: : http://www.hypersolutions.org/pages/rgbhex.html
+
+
+
+=head1 DATES IN EXCEL
+
+
+Dates and times in Excel are represented by real numbers, for example "Jan 1 2001 12:30 AM" is represented by the number 36892.521.
+
+The integer part of the number stores the number of days since the epoch and the fractional part stores the percentage of the day.
+
+The epoch can be either 1900 or 1904. Excel for Windows uses 1900 and Excel for Macintosh uses 1904. The epochs are:
+
+ 1900: 0 January 1900 i.e. 31 December 1899
+ 1904: 1 January 1904
+
+By default Spreadsheet::WriteExcel uses the Windows/1900 format although it generally isn't an issue since Excel on Windows and the Macintosh will convert automatically between one system and the other. To use the 1904 epoch you must use the C<set_1904()> workbook method.
+
+There are two things to note about the 1900 date format. The first is that the epoch starts on 0 January 1900. The second is that the year 1900 is erroneously but deliberately treated as a leap year. Therefore you must add an extra day to dates after 28 February 1900. The reason for this anomaly is explained at http://support.microsoft.com/support/kb/articles/Q181/3/70.asp
+
+A date or time in Excel is like any other number. To display the number as a date you must apply a number format to it. Refer to the C<set_num_format()> method above:
+
+ $format->set_num_format('mmm d yyyy hh:mm AM/PM');
+ $worksheet->write('A1', 36892.521 , $format); # Jan 1 2001 12:30 AM
+
+You can also use the C<write_date_time()> worksheet method to write dates in ISO8601 date format.
+
+ $worksheet->write_date_time('A2', '2001-01-01T12:20', format);
+
+See the C<write_date_time()> section of the documentation for more details.
+
+See also the C<Spreadsheet::WriteExcel::Utility> module that is included in the distro and which includes date handling functions and the DateTime::Format::Excel module, http://search.cpan.org/search?dist=DateTime-Format-Excel which is part of the DateTime project and which deals specifically with converting dates and times to and from Excel's format.
+
+
+
+
+=head1 OUTLINES AND GROUPING IN EXCEL
+
+
+Excel allows you to group rows or columns so that they can be hidden or displayed with a single mouse click. This feature is referred to as outlines.
+
+Outlines can reduce complex data down to a few salient sub-totals or summaries.
+
+This feature is best viewed in Excel but the following is an ASCII representation of what a worksheet with three outlines might look like. Rows 3-4 and rows 7-8 are grouped at level 2. Rows 2-9 are grouped at level 1. The lines at the left hand side are called outline level bars.
+
+
+ ------------------------------------------
+ 1 2 3 | | A | B | C | D | ...
+ ------------------------------------------
+ _ | 1 | A | | | | ...
+ | _ | 2 | B | | | | ...
+ | | | 3 | (C) | | | | ...
+ | | | 4 | (D) | | | | ...
+ | - | 5 | E | | | | ...
+ | _ | 6 | F | | | | ...
+ | | | 7 | (G) | | | | ...
+ | | | 8 | (H) | | | | ...
+ | - | 9 | I | | | | ...
+ - | . | ... | ... | ... | ... | ...
+
+
+Clicking the minus sign on each of the level 2 outlines will collapse and hide the data as shown in the next figure. The minus sign changes to a plus sign to indicate that the data in the outline is hidden.
+
+ ------------------------------------------
+ 1 2 3 | | A | B | C | D | ...
+ ------------------------------------------
+ _ | 1 | A | | | | ...
+ | | 2 | B | | | | ...
+ | + | 5 | E | | | | ...
+ | | 6 | F | | | | ...
+ | + | 9 | I | | | | ...
+ - | . | ... | ... | ... | ... | ...
+
+
+Clicking on the minus sign on the level 1 outline will collapse the remaining rows as follows:
+
+ ------------------------------------------
+ 1 2 3 | | A | B | C | D | ...
+ ------------------------------------------
+ | 1 | A | | | | ...
+ + | . | ... | ... | ... | ... | ...
+
+
+Grouping in C<Spreadsheet::WriteExcel> is achieved by setting the outline level via the C<set_row()> and C<set_column()> worksheet methods:
+
+ set_row($row, $height, $format, $hidden, $level)
+ set_column($first_col, $last_col, $width, $format, $hidden, $level)
+
+The following example sets an outline level of 1 for rows 1 and 2 (zero-indexed) and columns B to G. The parameters C<$height> and C<$XF> are assigned default values since they are undefined:
+
+ $worksheet->set_row(1, undef, undef, 0, 1);
+ $worksheet->set_row(2, undef, undef, 0, 1);
+ $worksheet->set_column('B:G', undef, undef, 0, 1);
+
+Excel allows up to 7 outline levels. Therefore the C<$level> parameter should be in the range C<0 E<lt>= $level E<lt>= 7>.
+
+Rows and columns can be collapsed by setting the C<$hidden> flag:
+
+ $worksheet->set_row(1, undef, undef, 1, 1);
+ $worksheet->set_row(2, undef, undef, 1, 1);
+ $worksheet->set_column('B:G', undef, undef, 1, 1);
+
+For a more complete example see the C<outline.pl> program in the examples directory of the distro.
+
+Some additional outline properties can be set via the C<outline_settings()> worksheet method, see above.
+
+
+
+
+=head1 FORMULAS AND FUNCTIONS IN EXCEL
+
+
+=head2 Caveats
+
+The first thing to note is that there are still some outstanding issues with the implementation of formulas and functions:
+
+ 1. Writing a formula is much slower than writing the equivalent string.
+ 2. You cannot use array constants, i.e. {1;2;3}, in functions.
+ 3. Unary minus isn't supported.
+ 4. Whitespace is not preserved around operators.
+ 5. Named ranges are not supported.
+ 6. Array formulas are not supported.
+
+However, these constraints will be removed in future versions. They are here because of a trade-off between features and time. Also, it is possible to work around issue 1 using the C<store_formula()> and C<repeat_formula()> methods as described later in this section.
+
+
+
+=head2 Introduction
+
+The following is a brief introduction to formulas and functions in Excel and Spreadsheet::WriteExcel.
+
+A formula is a string that begins with an equals sign:
+
+ '=A1+B1'
+ '=AVERAGE(1, 2, 3)'
+
+The formula can contain numbers, strings, boolean values, cell references, cell ranges and functions. Named ranges are not supported. Formulas should be written as they appear in Excel, that is cells and functions must be in uppercase.
+
+Cells in Excel are referenced using the A1 notation system where the column is designated by a letter and the row by a number. Columns range from A to IV i.e. 0 to 255, rows range from 1 to 65536. The C<Spreadsheet::WriteExcel::Utility> module that is included in the distro contains helper functions for dealing with A1 notation, for example:
+
+ use Spreadsheet::WriteExcel::Utility;
+
+ ($row, $col) = xl_cell_to_rowcol('C2'); # (1, 2)
+ $str = xl_rowcol_to_cell(1, 2); # C2
+
+The Excel C<$> notation in cell references is also supported. This allows you to specify whether a row or column is relative or absolute. This only has an effect if the cell is copied. The following examples show relative and absolute values.
+
+ '=A1' # Column and row are relative
+ '=$A1' # Column is absolute and row is relative
+ '=A$1' # Column is relative and row is absolute
+ '=$A$1' # Column and row are absolute
+
+Formulas can also refer to cells in other worksheets of the current workbook. For example:
+
+ '=Sheet2!A1'
+ '=Sheet2!A1:A5'
+ '=Sheet2:Sheet3!A1'
+ '=Sheet2:Sheet3!A1:A5'
+ q{='Test Data'!A1}
+ q{='Test Data1:Test Data2'!A1}
+
+The sheet reference and the cell reference are separated by C<!> the exclamation mark symbol. If worksheet names contain spaces, commas o parentheses then Excel requires that the name is enclosed in single quotes as shown in the last two examples above. In order to avoid using a lot of escape characters you can use the quote operator C<q{}> to protect the quotes. See C<perlop> in the main Perl documentation. Only valid sheet names that have been added using the C<add_worksheet()> method can be used in formulas. You cannot reference external workbooks.
+
+
+The following table lists the operators that are available in Excel's formulas. The majority of the operators are the same as Perl's, differences are indicated:
+
+ Arithmetic operators:
+ =====================
+ Operator Meaning Example
+ + Addition 1+2
+ - Subtraction 2-1
+ * Multiplication 2*3
+ / Division 1/4
+ ^ Exponentiation 2^3 # Equivalent to **
+ - Unary minus -(1+2) # Not yet supported
+ % Percent (Not modulus) 13% # Not supported, [1]
+
+
+ Comparison operators:
+ =====================
+ Operator Meaning Example
+ = Equal to A1 = B1 # Equivalent to ==
+ <> Not equal to A1 <> B1 # Equivalent to !=
+ > Greater than A1 > B1
+ < Less than A1 < B1
+ >= Greater than or equal to A1 >= B1
+ <= Less than or equal to A1 <= B1
+
+
+ String operator:
+ ================
+ Operator Meaning Example
+ & Concatenation "Hello " & "World!" # [2]
+
+
+ Reference operators:
+ ====================
+ Operator Meaning Example
+ : Range operator A1:A4 # [3]
+ , Union operator SUM(1, 2+2, B3) # [4]
+
+
+ Notes:
+ [1]: You can get a percentage with formatting and modulus with MOD().
+ [2]: Equivalent to ("Hello " . "World!") in Perl.
+ [3]: This range is equivalent to cells A1, A2, A3 and A4.
+ [4]: The comma behaves like the list separator in Perl.
+
+The range and comma operators can have different symbols in non-English versions of Excel. These will be supported in a later version of Spreadsheet::WriteExcel. European users of Excel take note:
+
+ $worksheet->write('A1', '=SUM(1; 2; 3)'); # Wrong!!
+ $worksheet->write('A1', '=SUM(1, 2, 3)'); # Okay
+
+The following table lists all of the core functions supported by Excel 5 and Spreadsheet::WriteExcel. Any additional functions that are available through the "Analysis ToolPak" or other add-ins are not supported. These functions have all been tested to verify that they work.
+
+ ABS DB INDIRECT NORMINV SLN
+ ACOS DCOUNT INFO NORMSDIST SLOPE
+ ACOSH DCOUNTA INT NORMSINV SMALL
+ ADDRESS DDB INTERCEPT NOT SQRT
+ AND DEGREES IPMT NOW STANDARDIZE
+ AREAS DEVSQ IRR NPER STDEV
+ ASIN DGET ISBLANK NPV STDEVP
+ ASINH DMAX ISERR ODD STEYX
+ ATAN DMIN ISERROR OFFSET SUBSTITUTE
+ ATAN2 DOLLAR ISLOGICAL OR SUBTOTAL
+ ATANH DPRODUCT ISNA PEARSON SUM
+ AVEDEV DSTDEV ISNONTEXT PERCENTILE SUMIF
+ AVERAGE DSTDEVP ISNUMBER PERCENTRANK SUMPRODUCT
+ BETADIST DSUM ISREF PERMUT SUMSQ
+ BETAINV DVAR ISTEXT PI SUMX2MY2
+ BINOMDIST DVARP KURT PMT SUMX2PY2
+ CALL ERROR.TYPE LARGE POISSON SUMXMY2
+ CEILING EVEN LEFT POWER SYD
+ CELL EXACT LEN PPMT T
+ CHAR EXP LINEST PROB TAN
+ CHIDIST EXPONDIST LN PRODUCT TANH
+ CHIINV FACT LOG PROPER TDIST
+ CHITEST FALSE LOG10 PV TEXT
+ CHOOSE FDIST LOGEST QUARTILE TIME
+ CLEAN FIND LOGINV RADIANS TIMEVALUE
+ CODE FINV LOGNORMDIST RAND TINV
+ COLUMN FISHER LOOKUP RANK TODAY
+ COLUMNS FISHERINV LOWER RATE TRANSPOSE
+ COMBIN FIXED MATCH REGISTER.ID TREND
+ CONCATENATE FLOOR MAX REPLACE TRIM
+ CONFIDENCE FORECAST MDETERM REPT TRIMMEAN
+ CORREL FREQUENCY MEDIAN RIGHT TRUE
+ COS FTEST MID ROMAN TRUNC
+ COSH FV MIN ROUND TTEST
+ COUNT GAMMADIST MINUTE ROUNDDOWN TYPE
+ COUNTA GAMMAINV MINVERSE ROUNDUP UPPER
+ COUNTBLANK GAMMALN MIRR ROW VALUE
+ COUNTIF GEOMEAN MMULT ROWS VAR
+ COVAR GROWTH MOD RSQ VARP
+ CRITBINOM HARMEAN MODE SEARCH VDB
+ DATE HLOOKUP MONTH SECOND VLOOKUP
+ DATEVALUE HOUR N SIGN WEEKDAY
+ DAVERAGE HYPGEOMDIST NA SIN WEIBULL
+ DAY IF NEGBINOMDIST SINH YEAR
+ DAYS360 INDEX NORMDIST SKEW ZTEST
+
+You can also modify the module to support function names in the following languages: German, French, Spanish, Portuguese, Dutch, Finnish, Italian and Swedish. See the C<function_locale.pl> program in the C<examples> directory of the distro.
+
+For a general introduction to Excel's formulas and an explanation of the syntax of the function refer to the Excel help files or the following links: http://msdn.microsoft.com/library/default.asp?URL=/library/officedev/office97/s88f2.htm and http://msdn.microsoft.com/library/default.asp?URL=/library/en-us/office97/s992f.htm
+
+
+If your formula doesn't work in Spreadsheet::WriteExcel try the following:
+
+ 1. Verify that the formula works in Excel (or Gnumeric or OpenOffice.org).
+ 2. Ensure that it isn't on the Caveats list shown above.
+ 3. Ensure that cell references and formula names are in uppercase.
+ 4. Ensure that you are using ':' as the range operator, A1:A4.
+ 5. Ensure that you are using ',' as the union operator, SUM(1,2,3).
+ 6. Ensure that the function is in the above table.
+
+If you go through steps 1-6 and you still have a problem, mail me.
+
+
+
+
+=head2 Improving performance when working with formulas
+
+Writing a large number of formulas with Spreadsheet::WriteExcel can be slow. This is due to the fact that each formula has to be parsed and with the current implementation this is computationally expensive.
+
+However, in a lot of cases the formulas that you write will be quite similar, for example:
+
+ $worksheet->write_formula('B1', '=A1 * 3 + 50', $format);
+ $worksheet->write_formula('B2', '=A2 * 3 + 50', $format);
+ ...
+ ...
+ $worksheet->write_formula('B99', '=A999 * 3 + 50', $format);
+ $worksheet->write_formula('B1000', '=A1000 * 3 + 50', $format);
+
+In this example the cell reference changes in iterations from C<A1> to C<A1000>. The parser treats this variable as a I<token> and arranges it according to predefined rules. However, since the parser is oblivious to the value of the token, it is essentially performing the same calculation 1000 times. This is inefficient.
+
+The way to avoid this inefficiency and thereby speed up the writing of formulas is to parse the formula once and then repeatedly substitute similar tokens.
+
+A formula can be parsed and stored via the C<store_formula()> worksheet method. You can then use the C<repeat_formula()> method to substitute C<$pattern>, C<$replace> pairs in the stored formula:
+
+ my $formula = $worksheet->store_formula('=A1 * 3 + 50');
+
+ for my $row (0..999) {
+ $worksheet->repeat_formula($row, 1, $formula, $format, 'A1', 'A'.($row +1));
+ }
+
+On an arbitrary test machine this method was 10 times faster than the brute force method shown above.
+
+For more information about how Spreadsheet::WriteExcel parses and stores formulas see the C<Spreadsheet::WriteExcel::Formula> man page.
+
+It should be noted however that the overall speed of direct formula parsing will be improved in a future version.
+
+
+
+
+=head1 EXAMPLES
+
+
+
+
+=head2 Example 1
+
+The following example shows some of the basic features of Spreadsheet::WriteExcel.
+
+
+ #!/usr/bin/perl -w
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+ # Create a new workbook called simple.xls and add a worksheet
+ my $workbook = Spreadsheet::WriteExcel->new("simple.xls");
+ my $worksheet = $workbook->add_worksheet();
+
+ # The general syntax is write($row, $column, $token). Note that row and
+ # column are zero indexed
+
+ # Write some text
+ $worksheet->write(0, 0, "Hi Excel!");
+
+
+ # Write some numbers
+ $worksheet->write(2, 0, 3); # Writes 3
+ $worksheet->write(3, 0, 3.00000); # Writes 3
+ $worksheet->write(4, 0, 3.00001); # Writes 3.00001
+ $worksheet->write(5, 0, 3.14159); # TeX revision no.?
+
+
+ # Write some formulas
+ $worksheet->write(7, 0, '=A3 + A6');
+ $worksheet->write(8, 0, '=IF(A5>3,"Yes", "No")');
+
+
+ # Write a hyperlink
+ $worksheet->write(10, 0, 'http://www.perl.com/');
+
+
+
+
+=head2 Example 2
+
+The following is a general example which demonstrates some features of working with multiple worksheets.
+
+ #!/usr/bin/perl -w
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+ # Create a new Excel workbook
+ my $workbook = Spreadsheet::WriteExcel->new("regions.xls");
+
+ # Add some worksheets
+ my $north = $workbook->add_worksheet("North");
+ my $south = $workbook->add_worksheet("South");
+ my $east = $workbook->add_worksheet("East");
+ my $west = $workbook->add_worksheet("West");
+
+ # Add a Format
+ my $format = $workbook->add_format();
+ $format->set_bold();
+ $format->set_color('blue');
+
+ # Add a caption to each worksheet
+ foreach my $worksheet ($workbook->sheets()) {
+ $worksheet->write(0, 0, "Sales", $format);
+ }
+
+ # Write some data
+ $north->write(0, 1, 200000);
+ $south->write(0, 1, 100000);
+ $east->write (0, 1, 150000);
+ $west->write (0, 1, 100000);
+
+ # Set the active worksheet
+ $south->activate();
+
+ # Set the width of the first column
+ $south->set_column(0, 0, 20);
+
+ # Set the active cell
+ $south->set_selection(0, 1);
+
+
+
+
+=head2 Example 3
+
+This example shows how to use a conditional numerical format with colours to indicate if a share price has gone up or down.
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+ # Create a new workbook and add a worksheet
+ my $workbook = Spreadsheet::WriteExcel->new("stocks.xls");
+ my $worksheet = $workbook->add_worksheet();
+
+ # Set the column width for columns 1, 2, 3 and 4
+ $worksheet->set_column(0, 3, 15);
+
+
+ # Create a format for the column headings
+ my $header = $workbook->add_format();
+ $header->set_bold();
+ $header->set_size(12);
+ $header->set_color('blue');
+
+
+ # Create a format for the stock price
+ my $f_price = $workbook->add_format();
+ $f_price->set_align('left');
+ $f_price->set_num_format('$0.00');
+
+
+ # Create a format for the stock volume
+ my $f_volume = $workbook->add_format();
+ $f_volume->set_align('left');
+ $f_volume->set_num_format('#,##0');
+
+
+ # Create a format for the price change. This is an example of a
+ # conditional format. The number is formatted as a percentage. If it is
+ # positive it is formatted in green, if it is negative it is formatted
+ # in red and if it is zero it is formatted as the default font colour
+ # (in this case black). Note: the [Green] format produces an unappealing
+ # lime green. Try [Color 10] instead for a dark green.
+ #
+ my $f_change = $workbook->add_format();
+ $f_change->set_align('left');
+ $f_change->set_num_format('[Green]0.0%;[Red]-0.0%;0.0%');
+
+
+ # Write out the data
+ $worksheet->write(0, 0, 'Company',$header);
+ $worksheet->write(0, 1, 'Price', $header);
+ $worksheet->write(0, 2, 'Volume', $header);
+ $worksheet->write(0, 3, 'Change', $header);
+
+ $worksheet->write(1, 0, 'Damage Inc.' );
+ $worksheet->write(1, 1, 30.25, $f_price ); # $30.25
+ $worksheet->write(1, 2, 1234567, $f_volume); # 1,234,567
+ $worksheet->write(1, 3, 0.085, $f_change); # 8.5% in green
+
+ $worksheet->write(2, 0, 'Dump Corp.' );
+ $worksheet->write(2, 1, 1.56, $f_price ); # $1.56
+ $worksheet->write(2, 2, 7564, $f_volume); # 7,564
+ $worksheet->write(2, 3, -0.015, $f_change); # -1.5% in red
+
+ $worksheet->write(3, 0, 'Rev Ltd.' );
+ $worksheet->write(3, 1, 0.13, $f_price ); # $0.13
+ $worksheet->write(3, 2, 321, $f_volume); # 321
+ $worksheet->write(3, 3, 0, $f_change); # 0 in the font color (black)
+
+
+
+
+=head2 Example 4
+
+The following is a simple example of using functions.
+
+ #!/usr/bin/perl -w
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+ # Create a new workbook and add a worksheet
+ my $workbook = Spreadsheet::WriteExcel->new("stats.xls");
+ my $worksheet = $workbook->add_worksheet('Test data');
+
+ # Set the column width for columns 1
+ $worksheet->set_column(0, 0, 20);
+
+
+ # Create a format for the headings
+ my $format = $workbook->add_format();
+ $format->set_bold();
+
+
+ # Write the sample data
+ $worksheet->write(0, 0, 'Sample', $format);
+ $worksheet->write(0, 1, 1);
+ $worksheet->write(0, 2, 2);
+ $worksheet->write(0, 3, 3);
+ $worksheet->write(0, 4, 4);
+ $worksheet->write(0, 5, 5);
+ $worksheet->write(0, 6, 6);
+ $worksheet->write(0, 7, 7);
+ $worksheet->write(0, 8, 8);
+
+ $worksheet->write(1, 0, 'Length', $format);
+ $worksheet->write(1, 1, 25.4);
+ $worksheet->write(1, 2, 25.4);
+ $worksheet->write(1, 3, 24.8);
+ $worksheet->write(1, 4, 25.0);
+ $worksheet->write(1, 5, 25.3);
+ $worksheet->write(1, 6, 24.9);
+ $worksheet->write(1, 7, 25.2);
+ $worksheet->write(1, 8, 24.8);
+
+ # Write some statistical functions
+ $worksheet->write(4, 0, 'Count', $format);
+ $worksheet->write(4, 1, '=COUNT(B1:I1)');
+
+ $worksheet->write(5, 0, 'Sum', $format);
+ $worksheet->write(5, 1, '=SUM(B2:I2)');
+
+ $worksheet->write(6, 0, 'Average', $format);
+ $worksheet->write(6, 1, '=AVERAGE(B2:I2)');
+
+ $worksheet->write(7, 0, 'Min', $format);
+ $worksheet->write(7, 1, '=MIN(B2:I2)');
+
+ $worksheet->write(8, 0, 'Max', $format);
+ $worksheet->write(8, 1, '=MAX(B2:I2)');
+
+ $worksheet->write(9, 0, 'Standard Deviation', $format);
+ $worksheet->write(9, 1, '=STDEV(B2:I2)');
+
+ $worksheet->write(10, 0, 'Kurtosis', $format);
+ $worksheet->write(10, 1, '=KURT(B2:I2)');
+
+
+
+=head2 Example 5
+
+The following example converts a tab separated file called C<tab.txt> into an Excel file called C<tab.xls>.
+
+ #!/usr/bin/perl -w
+
+ use strict;
+ use Spreadsheet::WriteExcel;
+
+ open (TABFILE, "tab.txt") or die "tab.txt: $!";
+
+ my $workbook = Spreadsheet::WriteExcel->new("tab.xls");
+ my $worksheet = $workbook->add_worksheet();
+
+ # Row and column are zero indexed
+ my $row = 0;
+
+ while (<TABFILE>) {
+ chomp;
+ # Split on single tab
+ my @Fld = split('\t', $_);
+
+ my $col = 0;
+ foreach my $token (@Fld) {
+ $worksheet->write($row, $col, $token);
+ $col++;
+ }
+ $row++;
+ }
+
+
+=head2 Additional Examples
+
+If you performed a normal installation the following examples files should have been copied to your C<~site/Spreadsheet/WriteExcel/examples> directory:
+
+The following is a description of the example files that are provided
+with Spreadsheet::WriteExcel. They are intended to demonstrate the
+different features and options of the module.
+
+
+ Getting started
+ ===============
+ bug_report.pl A template for submitting bug reports.
+ demo.pl Creates a demo of some of the features.
+ formats.pl Creates a demo of the available formatting.
+ regions.pl Demonstrates multiple worksheets.
+ simple.pl An example of some of the basic features.
+ stats.pl Basic formulas and functions.
+
+ Advanced
+ ========
+ bigfile.pl Write past the 7MB limit with OLE::Storage_Lite.
+ cgi.pl A simple CGI program.
+ chess.pl An example of formatting using properties.
+ colors.pl Demo of the colour palette and named colours.
+ copyformat.pl Example of copying a cell format.
+ diag_border.pl A simple example of diagonal cell borders.
+ easter_egg.pl Expose the Excel97 flight simulator. A must see.
+ filehandle.pl Examples of working with filehandles.
+ headers.pl Examples of worksheet headers and footers.
+ hyperlink1.pl Shows how to create web hyperlinks.
+ hyperlink2.pl Examples of internal and external hyperlinks.
+ images.pl Adding bitmap images to worksheets.
+ indent.pl An example of cell indentation.
+ merge1.pl A simple example of cell merging.
+ merge2.pl A simple example of cell merging with formatting.
+ merge3.pl Add hyperlinks to merged cells.
+ merge4.pl An advanced example of merging with formatting.
+ merge5.pl An advanced example of merging with formatting.
+ mod_perl1.pl A simple mod_perl 1 program.
+ mod_perl2.pl A simple mod_perl 2 program.
+ outline.pl An example of outlines and grouping.
+ panes.pl An examples of how to create panes.
+ protection.pl Example of cell locking and formula hiding.
+ repeat.pl Example of writing repeated formulas.
+ sales.pl An example of a simple sales spreadsheet.
+ sendmail.pl Send an Excel email attachment using Mail::Sender.
+ stats_ext.pl Same as stats.pl with external references.
+ stocks.pl Demonstrates conditional formatting.
+ textwrap.pl Demonstrates text wrapping options.
+ win32ole.pl A sample Win32::OLE example for comparison.
+ write_arrays.pl Example of writing 1D or 2D arrays of data.
+ write_to_scalar.pl Example of writing an Excel file to a Perl scalar.
+ write_handler1.pl Example of extending the write() method. Step 1.
+ write_handler2.pl Example of extending the write() method. Step 2.
+ write_handler3.pl Example of extending the write() method. Step 3.
+ write_handler4.pl Example of extending the write() method. Step 4.
+
+
+ Unicode
+ =======
+ unicode.pl Simple example of using Unicode UTF16 strings.
+ unicode_japan.pl Write Japanese Unicode strings using UTF16.
+ unicode_cyrillic.pl Write Russian cyrillic strings using UTF8.
+ unicode_list.pl List the chars in a Unicode font.
+ unicode_2022_jp.pl Japanese: ISO-2022-JP to utf8 in perl 5.8.
+ unicode_8859_11.pl Thai: ISO-8859_11 to utf8 in perl 5.8.
+ unicode_8859_7.pl Greek: ISO-8859_7 to utf8 in perl 5.8.
+ unicode_big5.pl Chinese: BIG5 to utf8 in perl 5.8.
+ unicode_cp1251.pl Russian: CP1251 to utf8 in perl 5.8.
+ unicode_cp1256.pl Arabic: CP1256 to utf8 in perl 5.8.
+ unicode_koi8r.pl Russian: KOI8-R to utf8 in perl 5.8.
+ unicode_polish_utf8.pl Polish : UTF8 to utf8 in perl 5.8.
+ unicode_shift_jis.pl Japanese: Shift JIS to utf8 in perl 5.8.
+
+
+ Utility
+ =======
+ csv2xls.pl Program to convert a CSV file to an Excel file.
+ datecalc1.pl Convert Unix/Perl time to Excel time.
+ datecalc2.pl Calculate an Excel date using Date::Calc.
+ lecxe.pl Convert Excel to WriteExcel using Win32::OLE.
+ tab2xls.pl Program to convert a tab separated file to xls.
+
+
+ Developer
+ =========
+ convertA1.pl Helper functions for dealing with A1 notation.
+ function_locale.pl Add non-English function names to Formula.pm.
+ writeA1.pl Example of how to extend the module.
+
+
+
+
+
+=head1 LIMITATIONS
+
+The following limits are imposed by Excel:
+
+ Description Limit
+ ----------------------------------- ------
+ Maximum number of chars in a string 32767
+ Maximum number of columns 256
+ Maximum number of rows 65536
+ Maximum chars in a sheet name 31
+ Maximum chars in a header/footer 254
+
+
+The minimum file size is 6K due to the OLE overhead. The maximum file size is approximately 7MB (7087104 bytes) of BIFF data. This can be extended by using Takanori Kawai's OLE::Storage_Lite module http://search.cpan.org/search?dist=OLE-Storage_Lite see the C<bigfile.pl> example in the C<examples> directory of the distro.
+
+
+
+
+=head1 DOWNLOADING
+
+The latest version of this module is always available at: http://search.cpan.org/search?dist=Spreadsheet-WriteExcel/
+
+
+
+
+=head1 REQUIREMENTS
+
+This module requires Perl 5.005 (or later), Parse::RecDescent and File::Temp:
+
+ http://search.cpan.org/search?dist=Parse-RecDescent/
+ http://search.cpan.org/search?dist=File-Temp/
+
+
+
+
+=head1 INSTALLATION
+
+See the INSTALL or install.html docs that come with the distribution or:
+
+http://search.cpan.org/doc/JMCNAMARA/Spreadsheet-WriteExcel-2.11/WriteExcel/doc/install.html
+
+
+
+
+=head1 PORTABILITY
+
+Spreadsheet::WriteExcel will work on the majority of Windows, UNIX and Macintosh platforms. Specifically, the module will work on any system where perl packs floats in the 64 bit IEEE format. The float must also be in little-endian format but it will be reversed if necessary. Thus:
+
+ print join(" ", map { sprintf "%#02x", $_ } unpack("C*", pack "d", 1.2345)), "\n";
+
+should give (or in reverse order):
+
+ 0x8d 0x97 0x6e 0x12 0x83 0xc0 0xf3 0x3f
+
+In general, if you don't know whether your system supports a 64 bit IEEE float or not, it probably does. If your system doesn't, WriteExcel will C<croak()> with the message given in the L<DIAGNOSTICS> section. You can check which platforms the module has been tested on at the CPAN testers site: http://testers.cpan.org/search?request=dist&dist=Spreadsheet-WriteExcel
+
+
+
+
+=head1 DIAGNOSTICS
+
+
+=over 4
+
+=item Filename required by Spreadsheet::WriteExcel->new()
+
+A filename must be given in the constructor.
+
+=item Can't open filename. It may be in use or protected.
+
+The file cannot be opened for writing. The directory that you are writing to may be protected or the file may be in use by another program.
+
+=item Unable to create tmp files via File::Temp::tempfile()...
+
+This is a C<-w> warning. You will see it if you are using Spreadsheet::WriteExcel in an environment where temporary files cannot be created, in which case all data will be stored in memory. The warning is for information only: it does not affect creation but it will affect the speed of execution for large files. See the C<set_tempdir> workbook method.
+
+
+=item Maximum file size, 7087104, exceeded.
+
+The current OLE implementation only supports a maximum BIFF file of this size. This limit can be extended, see the L<LIMITATIONS> section.
+
+=item Can't locate Parse/RecDescent.pm in @INC ...
+
+Spreadsheet::WriteExcel requires the Parse::RecDescent module. Download it from CPAN: http://search.cpan.org/search?dist=Parse-RecDescent
+
+=item Couldn't parse formula ...
+
+There are a large number of warnings which relate to badly formed formulas and functions. See the L<FORMULAS AND FUNCTIONS IN EXCEL> section for suggestions on how to avoid these errors. You should also check the formula in Excel to ensure that it is valid.
+
+=item Required floating point format not supported on this platform.
+
+Operating system doesn't support 64 bit IEEE float or it is byte-ordered in a way unknown to WriteExcel.
+
+
+=item 'file.xls' cannot be accessed. The file may be read-only ...
+
+You may sometimes encounter the following error when trying to open a file in Excel: "file.xls cannot be accessed. The file may be read-only, or you may be trying to access a read-only location. Or, the server the document is stored on may not be responding."
+
+This error generally means that the Excel file has been corrupted. There are two likely causes of this: the file was FTPed in ASCII mode instead of binary mode or else the file was created with UTF8 data returned by an XML parser. See L<WORKING WITH XML> for further details.
+
+=back
+
+
+
+
+=head1 THE EXCEL BINARY FORMAT
+
+The following is some general information about the Excel binary format for anyone who may be interested.
+
+Excel data is stored in the "Binary Interchange File Format" (BIFF) file format. Details of this format are given in the Excel SDK, the "Excel Developer's Kit" from Microsoft Press. It is also included in the MSDN CD library but is no longer available on the MSDN website. Versions of the BIFF documentation are available at www.wotsit.org, http://www.wotsit.org/search.asp?page=2&s=database
+
+Charles Wybble has collected together almost all of the available information about the Excel file format. See "The Chicago Project" at http://chicago.sourceforge.net/devel/
+
+Daniel Rentz of OpenOffice.org has also written a detailed description of the Excel workbook records, see http://sc.openoffice.org/excelfileformat.pdf
+
+The BIFF portion of the Excel file is comprised of contiguous binary records that have different functions and that hold different types of data. Each BIFF record is comprised of the following three parts:
+
+ Record name; Hex identifier, length = 2 bytes
+ Record length; Length of following data, length = 2 bytes
+ Record data; Data, length = variable
+
+The BIFF data is stored along with other data in an OLE Compound File. This is a structured storage which acts like a file system within a file. A Compound File is comprised of storages and streams which, to follow the file system analogy, are like directories and files.
+
+The documentation for the OLE::Storage module, http://user.cs.tu-berlin.de/~schwartz/pmh/guide.html , contains one of the few descriptions of the OLE Compound File in the public domain. The Digital Imaging Group have also detailed the OLE format in the JPEG2000 specification: see Appendix A of http://www.i3a.org/pdf/wg1n1017.pdf
+
+For a open source implementation of the OLE library see the 'cole' library at http://atena.com/libole2.php
+
+The source code for the Excel plugin of the Gnumeric spreadsheet also contains information relevant to the Excel BIFF format and the OLE container, http://www.gnome.org/projects/gnumeric/ and ftp://ftp.ximian.com/pub/ximian-source/
+
+In addition the source code for OpenOffice.org is available at http://www.openoffice.org/
+
+An article describing Spreadsheet::WriteExcel and how it works appears in Issue #19 of The Perl Journal, http://www.samag.com/documents/s=1272/sam05030004/ It is reproduced, by kind permission, in the C<doc> directory of the distro.
+
+
+Please note that the provision of this information does not constitute an invitation to start hacking at the BIFF or OLE file formats. There are more interesting ways to waste your time. ;-)
+
+
+
+
+=head1 WRITING EXCEL FILES
+
+Depending on your requirements, background and general sensibilities you may prefer one of the following methods of getting data into Excel:
+
+=over 4
+
+=item * Win32::OLE module and office automation
+
+This requires a Windows platform and an installed copy of Excel. This is the most powerful and complete method for interfacing with Excel. See http://www.activestate.com/ASPN/Reference/Products/ActivePerl-5.6/faq/Windows/ActivePerl-Winfaq12.html and http://www.activestate.com/ASPN/Reference/Products/ActivePerl-5.6/site/lib/Win32/OLE.html If your main platform is UNIX but you have the resources to set up a separate Win32/MSOffice server, you can convert office documents to text, postscript or PDF using Win32::OLE. For a demonstration of how to do this using Perl see Docserver: http://search.cpan.org/search?mode=module&query=docserver
+
+=item * CSV, comma separated variables or text
+
+If the file extension is C<csv>, Excel will open and convert this format automatically. Generating a valid CSV file isn't as easy as it seems. Have a look at the DBD::RAM, DBD::CSV, Text::xSV and Text::CSV_XS modules.
+
+=item * DBI with DBD::ADO or DBD::ODBC
+
+Excel files contain an internal index table that allows them to act like a database file. Using one of the standard Perl database modules you can connect to an Excel file as a database.
+
+=item * DBD::Excel
+
+You can also access Spreadsheet::WriteExcel using the standard DBI interface via Takanori Kawai's DBD::Excel module http://search.cpan.org/dist/DBD-Excel
+
+=item * Spreadsheet::WriteExcelXML
+
+This module allows you to create an Excel XML file using the same interface as Spreadsheet::WriteExcel. See: http://search.cpan.org/dist/Spreadsheet-WriteExcelXML
+
+=item * Excel::Template
+
+This module allows you to create an Excel file from an XML template in a manner similar to HTML::Template. See http://search.cpan.org/dist/Excel-Template/
+
+=item * Spreadsheet::WriteExcel::FromXML
+
+This module allows you to turn a simple XML file into an Excel file using Spreadsheet::WriteExcel as a backend. The format of the XML file is defined by a supplied DTD: http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromXML
+
+=item * Spreadsheet::WriteExcel::Simple
+
+This provides an easier interface to Spreadsheet::WriteExcel: http://search.cpan.org/dist/Spreadsheet-WriteExcel-Simple
+
+=item * Spreadsheet::WriteExcel::FromDB
+
+This is a useful module for creating Excel files directly from a DB table: http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromDB
+
+=item * HTML tables
+
+This is an easy way of adding formatting via a text based format.
+
+=item * XML or HTML
+
+The Excel XML and HTML file specification are available from http://msdn.microsoft.com/library/officedev/ofxml2k/ofxml2k.htm
+
+=back
+
+For other Perl-Excel modules try the following search: http://search.cpan.org/search?mode=module&query=excel
+
+
+
+
+=head1 READING EXCEL FILES
+
+To read data from Excel files try:
+
+=over 4
+
+=item * Spreadsheet::ParseExcel
+
+This uses the OLE::Storage-Lite module to extract data from an Excel file. http://search.cpan.org/dist/Spreadsheet-ParseExcel
+
+=item * Spreadsheet::ParseExcel_XLHTML
+
+This module uses Spreadsheet::ParseExcel's interface but uses xlHtml (see below) to do the conversion: http://search.cpan.org/dist/Spreadsheet-ParseExcel_XLHTML
+Spreadsheet::ParseExcel_XLHTML
+
+=item * xlHtml
+
+This is an open source "Excel to HTML Converter" C/C++ project at http://www.xlhtml.org/ See also, the OLE Filters Project at http://atena.com/libole2.php
+
+=item * DBD::Excel (reading)
+
+You can also access Spreadsheet::ParseExcel using the standard DBI interface via Takanori Kawai's DBD::Excel module http://search.cpan.org/dist/DBD-Excel
+
+=item * Win32::OLE module and office automation (reading)
+
+See, the section L<WRITING EXCEL FILES>.
+
+=item * HTML tables (reading)
+
+If the files are saved from Excel in a HTML format the data can be accessed using HTML::TableExtract http://search.cpan.org/dist/HTML-TableExtract
+
+=item * DBI with DBD::ADO or DBD::ODBC.
+
+See, the section L<WRITING EXCEL FILES>.
+
+=item * XML::Excel
+
+Converts Excel files to XML using Spreadsheet::ParseExcel http://search.cpan.org/dist/XML-Excel.
+
+=item * OLE::Storage, aka LAOLA
+
+This is a Perl interface to OLE file formats. In particular, the distro contains an Excel to HTML converter called Herbert, http://user.cs.tu-berlin.de/~schwartz/pmh/ This has been superseded by the Spreadsheet::ParseExcel module.
+
+=back
+
+
+For other Perl-Excel modules try the following search: http://search.cpan.org/search?mode=module&query=excel
+
+If you wish to view Excel files on a UNIX/Linux platform check out the excellent Gnumeric spreadsheet application at http://www.gnome.org/projects/gnumeric/ or OpenOffice.org at http://www.openoffice.org/
+
+If you wish to view Excel files on a Windows platform which doesn't have Excel installed you can use the free Microsoft Excel Viewer http://office.microsoft.com/downloads/2000/xlviewer.aspx
+
+
+
+
+=head1 Warning about XML::Parser and Perl 5.6
+
+You must be careful when using Spreadsheet::WriteExcel in conjunction with Perl 5.6 and XML::Parser (and other XML parsers) due to the fact that the data returned by the parser is generally in UTF8 format.
+
+When UTF8 strings are added to Spreadsheet::WriteExcel's internal data it causes the generated Excel file to become corrupt.
+
+Note, this doesn't affect Perl 5.005 (which doesn't try to handle UTF8) or 5.8 (which handles it correctly).
+
+To avoid this problem you should upgrade to Perl 5.8, if possible, or else you should convert the output data from XML::Parser to ASCII or ISO-8859-1 using one of the following methods:
+
+ $new_str = pack 'C*', unpack 'U*', $utf8_str;
+
+
+ use Unicode::MapUTF8 'from_utf8';
+ $new_str = from_utf8({-str => $utf8_str, -charset => 'ISO-8859-1'});
+
+
+
+
+=head1 BUGS
+
+Formulas are formulae.
+
+This version of the module doesn't support the write_comment() method. This will be fixed soon.
+
+XML and UTF8 data on Perl 5.6 can cause Excel files created by Spreadsheet::WriteExcel to become corrupt. See L<Warning about XML::Parser and Perl 5.6> for further details.
+
+The format object that is used with a C<merge_range()> method call is marked internally as being associated with a merged range.If you use this format in a non-merged cell it will cause Excel to crash. The current workaround is to use separate formats for merged and non-merged cell. This will be fixed in a future release.
+
+Nested formulas sometimes aren't parsed correctly and give a result of "#VALUE". If you come across a formula that parses like this, let me know.
+
+Spreadsheet::ParseExcel: All formulas created by Spreadsheet::WriteExcel are read as having a value of zero. This is because Spreadsheet::WriteExcel only stores the formula and not the calculated result.
+
+OpenOffice.org: Some formatting is not displayed correctly.
+
+Gnumeric: Some formatting is not displayed correctly. URLs are not displayed as links. Page setup can cause Gnumeric to crash.
+
+The lack of a portable way of writing a little-endian 64 bit IEEE float. There is beta code available to fix this. Let me know if you wish to test it on your platform.
+
+If you wish to submit a bug report run the C<bug_report.pl> program in the C<examples> directory of the distro.
+
+
+
+
+=head1 TO DO
+
+The roadmap is as follows:
+
+=over 4
+
+=item * Add write_comment().
+
+=item * Add AutoFilters.
+
+
+=back
+
+Also, here are some of the most requested features that probably won't get added:
+
+=over 4
+
+=item * Macros.
+
+This would solve the previous problem neatly. However, the format of Excel macros isn't documented.
+
+=item * Some feature that you really need. ;-)
+
+
+=back
+
+If there is some feature of an Excel file that you really, really need then you should use Win32::OLE with Excel on Windows. If you are on Unix you could consider connecting to a Windows server via Docserver or SOAP, see L<WRITING EXCEL FILES>.
+
+
+
+
+=head1 MAILING LIST
+
+There is a Google group for discussing and asking questions about Spreadsheet::WriteExcel: http://groups-beta.google.com/group/spreadsheet-writeexcel/
+
+Alternatively you can keep up to date with future releases by subscribing at:
+http://freshmeat.net/projects/writeexcel/
+
+
+
+
+=head1 SEE ALSO
+
+Spreadsheet::ParseExcel: http://search.cpan.org/dist/Spreadsheet-ParseExcel
+
+Spreadsheet-WriteExcel-FromXML: http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromXML
+
+Spreadsheet::WriteExcel::FromDB: http://search.cpan.org/dist/Spreadsheet-WriteExcel-FromDB
+
+Excel::Template: http://search.cpan.org/~rkinyon/Excel-Template/
+
+DateTime::Format::Excel: http://search.cpan.org/dist/DateTime-Format-Excel
+
+"Reading and writing Excel files with Perl" by Teodor Zlatanov, atIBM developerWorks: http://www-106.ibm.com/developerworks/library/l-pexcel/
+
+"Excel-Dateien mit Perl erstellen - Controller im Glück" by Peter Dintelmann and Christian Kirsch in the German Unix/web journal iX: http://www.heise.de/ix/artikel/2001/06/175/
+
+"Spreadsheet::WriteExcel" in The Perl Journal: http://www.samag.com/documents/s=1272/sam05030004/
+
+Spreadsheet::WriteExcel documentation in Japanese by Takanori Kawai. http://member.nifty.ne.jp/hippo2000/perltips/Spreadsheet/WriteExcel.htm
+
+Oesterly user brushes with fame:
+http://oesterly.com/releases/12102000.html
+
+
+=head1 ACKNOWLEDGEMENTS
+
+
+The following people contributed to the debugging and testing of Spreadsheet::WriteExcel:
+
+Alexander Farber, Andre de Bruin, Arthur at ais, Artur Silveira da Cunha, Borgar Olsen, Brian White, Bob Mackay, Cedric Bouvier, Chad Johnson, CPAN testers, Daniel Berger, Daniel Gardner, Dmitry Kochurov, Eric Frazier, Ernesto Baschny, Felipe Pérez Galiana, Gordon Simpson, Hanc Pavel, Harold Bamford, James Holmes, James Wilkinson, Johan Ekenberg, Johann Hanne, Jonathan Scott Duff, J.C. Wren, Kenneth Stacey, Keith Miller, Kyle Krom, Marc Rosenthal, Markus Schmitz, Michael Braig, Michael Buschauer, Mike Blazer, Michael Erickson, Michael W J West, Ning Xie, Paul J. Falbe, Paul Medynski, Peter Dintelmann, Pierre Laplante, Praveen Kotha, Reto Badertscher, Rich Sorden, Shane Ashby, Shenyu Zheng, Stephan Loescher, Steve Sapovits, Sven Passig, Svetoslav Marinov, Tamas Gulacsi, Troy Daniels, Vahe Sarkissian.
+
+The following people contributed patches, examples or Excel information:
+
+Andrew Benham, Bill Young, Cedric Bouvier, Charles Wybble, Daniel Rentz, David Robins, Franco Venturi, Ian Penman, John Heitmann, Jon Guy, Kyle R. Burton, Pierre-Jean Vouette, Rubio, Marco Geri, Mark Fowler, Matisse Enzer, Sam Kington, Takanori Kawai, Tom O'Sullivan.
+
+Many thanks to Ron McKelvey, Ronzo Consulting for Siemens, who sponsored the development of the formula caching routines.
+
+Additional thanks to Takanori Kawai for translating the documentation into Japanese.
+
+Dirk Eddelbuettel maintains the Debian distro.
+
+Thanks to Damian Conway for the excellent Parse::RecDescent.
+
+Thanks to Tim Jenness for File::Temp.
+
+Thanks to Michael Meeks and Jody Goldberg for their work on Gnumeric.
+
+
+
+
+=head1 AUTHOR
+
+John McNamara jmcnamara at cpan.org
+
+ Slow dulcimer, gavotte and bow, in autumn,
+ Basho and his friends go out to view the moon;
+ In summer, gasoline rainbow in the gutter,
+
+ The secret courtesy that courses like ichor
+ Through the old form of the rude, full-scale joke,
+ Impossible to tell in writing.
+
+ -- Robert Pinsky
+
+
+
+
+=head1 COPYRIGHT
+
+© MM-MMV, 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.
+
Added: packages/libspreadsheet-writeexcel-perl/branches/upstream/current/t/01_add_worksheet.t
===================================================================
--- packages/libspreadsheet-writeexcel-perl/branches/upstream/current/t/01_add_worksheet.t 2005-04-05 23:16:38 UTC (rev 900)
+++ packages/libspreadsheet-writeexcel-perl/branches/upstream/current/t/01_add_worksheet.t 2005-04-05 23:16:48 UTC (rev 901)
@@ -0,0 +1,206 @@
+#!/usr/bin/perl -wl
+
+###############################################################################
+#
+# A test for Spreadsheet::WriteExcel.
+#
+# Tests for valid worksheet name handling.
+#
+# reverse('©'), March 2005, John McNamara, jmcnamara at cpan.org
+#
+
+
+use strict;
+
+use Spreadsheet::WriteExcel;
+use Test::More tests => 69;
+
+
+# Tests for valid and invalid worksheet names
+my @tests1 = (
+ # Tests for valid names
+ [ 'PASS', undef, 'No worksheet name' ],
+ [ 'PASS', '', 'Blank worksheet name' ],
+ [ 'PASS', 'Sheet10', 'Valid worksheet name' ],
+ [ 'PASS', 'a' x 31, 'Valid 31 char name' ],
+
+ # Tests for invalid names
+ [ 'FAIL', 'Sheet1', 'Caught duplicate name' ],
+ [ 'FAIL', 'Sheet2', 'Caught duplicate name' ],
+ [ 'FAIL', 'Sheet3', 'Caught duplicate name' ],
+ [ 'FAIL', 'sheet1', 'Caught case-insensitive name'],
+ [ 'FAIL', 'SHEET1', 'Caught case-insensitive name'],
+ [ 'FAIL', 'sheetz', 'Caught case-insensitive name'],
+ [ 'FAIL', 'SHEETZ', 'Caught case-insensitive name'],
+ [ 'FAIL', 'a' x 32, 'Caught long name' ],
+ [ 'FAIL', '[', 'Caught invalid char' ],
+ [ 'FAIL', ']', 'Caught invalid char' ],
+ [ 'FAIL', ':', 'Caught invalid char' ],
+ [ 'FAIL', '*', 'Caught invalid char' ],
+ [ 'FAIL', '?', 'Caught invalid char' ],
+ [ 'FAIL', '/', 'Caught invalid char' ],
+ [ 'FAIL', '\\', 'Caught invalid char' ],
+
+ );
+
+
+
+
+###############################################################################
+#
+# Tests 1. ASCII tests
+#
+my $test_file = "temp_test_file.xml";
+my $workbook = Spreadsheet::WriteExcel->new($test_file);
+my $worksheet1 = $workbook->add_worksheet(); # Implicit name 'Sheet1'
+my $worksheet2 = $workbook->add_worksheet(); # Implicit name 'Sheet2'
+my $worksheet3 = $workbook->add_worksheet('Sheet3');
+my $worksheet4 = $workbook->add_worksheet('Sheetz');
+
+for my $test_ref (@tests1) {
+
+ my $target = $test_ref->[0];
+ my $sheetname = $test_ref->[1];
+ my $caption = $test_ref->[2];
+
+ eval {$workbook->_check_sheetname($sheetname)};
+
+ my $result = $@ ? 'FAIL' : 'PASS';
+
+ $sheetname = 'undef' unless defined $sheetname;
+
+ is($result, $target, sprintf " \t%-7s %-28s: %s",
+ 'ASCII:', $caption, $sheetname);
+}
+
+$workbook->close();
+
+
+###############################################################################
+#
+# Tests 2. UTF16-BE tests
+#
+
+$workbook = Spreadsheet::WriteExcel->new($test_file);
+$worksheet1 = $workbook->add_worksheet(); # Implicit name 'Sheet1'
+$worksheet2 = $workbook->add_worksheet(); # Implicit name 'Sheet2'
+$worksheet3 = $workbook->add_worksheet('Sheet3');
+$worksheet4 = $workbook->add_worksheet("\0S\0h\0e\0e\0t\0z", 1);
+
+for my $test_ref (@tests1) {
+
+ my $target = $test_ref->[0];
+ my $sheetname = $test_ref->[1];
+ my $caption = $test_ref->[2];
+
+ # Convert ASCII to UTF16-BE if not blank or undef
+ $sheetname = pack "n*", unpack "C*", $sheetname if $sheetname;
+
+ eval {$workbook->_check_sheetname($sheetname, 1)};
+
+ my $result = $@ ? 'FAIL' : 'PASS';
+
+ $sheetname = 'undef' unless defined $sheetname;
+
+ # Change null byte to \0 for printing
+ $sheetname =~ s/\0/\\0/g;
+
+ is($result, $target, sprintf " \t%-7s %-28s: %s",
+ 'UTF-16:', $caption, $sheetname);
+}
+
+$workbook->close();
+
+
+
+###############################################################################
+#
+# Tests 3. UTF-8 tests
+#
+
+SKIP: {
+
+
+my $uni = chr 0x263A;
+my @tests2 = (
+ # Tests for valid names
+ [ 'PASS', $uni, 'Unicode char' ],
+ [ 'PASS', $uni x 31, 'Valid 31 char name' ],
+
+ # Tests for invalid names
+ [ 'FAIL', chr 0x0438, 'Caught duplicate name' ],
+ [ 'FAIL', chr 0x0418, 'Caught case-insensitive name'],
+ [ 'FAIL', $uni x 32, 'Caught long name' ],
+ [ 'FAIL', '[' . $uni, 'Caught invalid char' ],
+ [ 'FAIL', ']' . $uni, 'Caught invalid char' ],
+ [ 'FAIL', ':' . $uni, 'Caught invalid char' ],
+ [ 'FAIL', '*' . $uni, 'Caught invalid char' ],
+ [ 'FAIL', '?' . $uni, 'Caught invalid char' ],
+ [ 'FAIL', '/' . $uni, 'Caught invalid char' ],
+ [ 'FAIL', '\\'. $uni, 'Caught invalid char' ],
+
+ );
+
+skip "\tskipped tests requires Perl 5.8 Unicode support", 0 + @tests1 + @tests2 if $] < 5.008;
+
+
+$workbook = Spreadsheet::WriteExcel->new($test_file);
+$worksheet1 = $workbook->add_worksheet(); # Implicit name 'Sheet1'
+$worksheet2 = $workbook->add_worksheet(); # Implicit name 'Sheet2'
+$worksheet3 = $workbook->add_worksheet('Sheet3');
+$worksheet4 = $workbook->add_worksheet("\0S\0h\0e\0e\0t\0z", 1);
+my $worksheet5 = $workbook->add_worksheet(chr 0x0438);
+
+
+for my $test_ref (@tests1) {
+
+ my $target = $test_ref->[0];
+ my $sheetname = $test_ref->[1];
+ my $caption = $test_ref->[2];
+
+ require Encode;
+ $sheetname = Encode::encode_utf8($sheetname) if $sheetname;
+
+ eval {$workbook->_check_sheetname($sheetname)};
+
+ my $result = $@ ? 'FAIL' : 'PASS';
+
+ $sheetname = 'undef' unless defined $sheetname;
+
+ # Change null byte to \0 for printing
+ $sheetname =~ s/\0/\\0/g;
+
+ is($result, $target, sprintf " \t%-7s %-28s: %s",
+ 'UTF-8:', $caption, $sheetname);
+}
+
+
+for my $test_ref (@tests2) {
+
+ my $target = $test_ref->[0];
+ my $sheetname = $test_ref->[1];
+ my $caption = $test_ref->[2];
+
+ eval {$workbook->_check_sheetname($sheetname)};
+
+ my $result = $@ ? 'FAIL' : 'PASS';
+
+ $sheetname = 'undef' unless defined $sheetname;
+
+ is($result, $target, sprintf " \t%-7s %-28s: %s",
+ 'UTF-8:', $caption, '');
+}
+
+
+$workbook->close();
+
+
+}
+
+unlink $test_file;
+
+
+__END__
+
+
+
More information about the Pkg-perl-cvs-commits
mailing list