summaryrefslogtreecommitdiff
path: root/lib/Spreadsheet/XLSX/Fmt2007.pm
blob: 4068e0f9fba6eb59763c2079ad84fc9283bd10d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
package Spreadsheet::XLSX::Fmt2007;
use strict;
use warnings;

use Spreadsheet::XLSX::Utility2007 qw(ExcelFmt);
our $VERSION = '0.18';    #

my %hFmtDefault = (
    0x00 => '@',
    0x01 => '0',
    0x02 => '0.00',
    0x03 => '#,##0',
    0x04 => '#,##0.00',
    0x05 => '($#,##0_);($#,##0)',
    0x06 => '($#,##0_);[RED]($#,##0)',
    0x07 => '($#,##0.00_);($#,##0.00_)',
    0x08 => '($#,##0.00_);[RED]($#,##0.00_)',
    0x09 => '0%',
    0x0A => '0.00%',
    0x0B => '0.00E+00',
    0x0C => '# ?/?',
    0x0D => '# ??/??',
    0x0E => 'yyyy-mm-dd',
    0x0F => 'd-mmm-yy',
    0x10 => 'd-mmm',
    0x11 => 'mmm-yy',
    0x12 => 'h:mm AM/PM',
    0x13 => 'h:mm:ss AM/PM',
    0x14 => 'h:mm',
    0x15 => 'h:mm:ss',
    0x16 => 'm-d-yy h:mm',

    #0x17-0x24 -- Differs in Natinal
    0x25 => '(#,##0_);(#,##0)',
    0x26 => '(#,##0_);[RED](#,##0)',
    0x27 => '(#,##0.00);(#,##0.00)',
    0x28 => '(#,##0.00);[RED](#,##0.00)',
    0x29 => '_(*#,##0_);_(*(#,##0);_(*"-"_);_(@_)',
    0x2A => '_($*#,##0_);_($*(#,##0);_(*"-"_);_(@_)',
    0x2B => '_(*#,##0.00_);_(*(#,##0.00);_(*"-"??_);_(@_)',
    0x2C => '_($*#,##0.00_);_($*(#,##0.00);_(*"-"??_);_(@_)',
    0x2D => 'mm:ss',
    0x2E => '[h]:mm:ss',
    0x2F => 'mm:ss.0',
    0x30 => '##0.0E+0',
    0x31 => '@',
);

#------------------------------------------------------------------------------
# new (for Spreadsheet::XLSX::Fmt2007)
#------------------------------------------------------------------------------
sub new {
    my ($sPkg, %hKey) = @_;
    my $oThis = {};
    bless $oThis;
    return $oThis;
}

#------------------------------------------------------------------------------
# TextFmt (for Spreadsheet::XLSX::Fmt2007)
#------------------------------------------------------------------------------
sub TextFmt {
    my ($oThis, $sTxt, $sCode) = @_;
    return $sTxt if ((!defined($sCode)) || ($sCode eq '_native_'));
    return pack('U*', unpack('n*', $sTxt));
}

#------------------------------------------------------------------------------
# FmtStringDef (for Spreadsheet::XLSX::Fmt2007)
#------------------------------------------------------------------------------
sub FmtStringDef {
    my ($oThis, $iFmtIdx, $oBook, $rhFmt) = @_;
    my $sFmtStr = $oBook->{FormatStr}->{$iFmtIdx};

    if (!(defined($sFmtStr)) && defined($rhFmt)) {
        $sFmtStr = $rhFmt->{$iFmtIdx};
    }
    $sFmtStr = $hFmtDefault{$iFmtIdx} unless ($sFmtStr);
    return $sFmtStr;
}

#------------------------------------------------------------------------------
# FmtString (for Spreadsheet::XLSX::Fmt2007)
#------------------------------------------------------------------------------
sub FmtString {
    my ($oThis, $oCell, $oBook) = @_;

    my $sFmtStr;    # = $oThis->FmtStringDef(

    #        $oBook->{Format}[$oCell->{FormatNo}]->{FmtIdx}, $oBook);

    # Check for formula error before evaluating format
    return '@' if ( $oCell->{Val} =~ m/^#/ );
    
    unless (defined($sFmtStr)) {
        if ($oCell->{Type} eq 'Numeric') {
            if ($oCell->{Format}) {
                $sFmtStr = $oCell->{Format};
            } elsif (int($oCell->{Val}) != $oCell->{Val}) {
                $sFmtStr = '0.00';
            } else {
                $sFmtStr = '0';
            }
        } elsif ($oCell->{Type} eq 'Date') {
            if ($oCell->{Format}) {
                $sFmtStr = $oCell->{Format};
            } elsif (int($oCell->{Val}) <= 0) {
                $sFmtStr = 'h:mm:ss';
            } else {
                $sFmtStr = 'm-d-yy';
            }
        } else {
            $sFmtStr = '@';
        }
    }
    return $sFmtStr;
}

#------------------------------------------------------------------------------
# ValFmt (for Spreadsheet::XLSX::Fmt2007)
#------------------------------------------------------------------------------
sub ValFmt {
    my ($oThis, $oCell, $oBook) = @_;

    my ($Dt, $iFmtIdx, $iNumeric, $Flg1904);

    if ($oCell->{Type} eq 'Text') {
        $Dt = ((defined $oCell->{Val}) && ($oCell->{Val} ne '')) ? $oThis->TextFmt($oCell->{Val}, $oCell->{Code}) : '';
    } else {
        $Dt = $oCell->{Val};
    }
    $Flg1904 = $oBook->{Flg1904};
    my $sFmtStr = $oThis->FmtString($oCell, $oBook);
    return ExcelFmt($sFmtStr, $Dt, $Flg1904, $oCell->{Type});
}

#------------------------------------------------------------------------------
# ChkType (for Spreadsheet::XLSX::Fmt2007)
#------------------------------------------------------------------------------
sub ChkType {
    my ($oPkg, $iNumeric, $iFmtIdx) = @_;
    if ($iNumeric) {
        if (   (($iFmtIdx >= 0x0E) && ($iFmtIdx <= 0x16))
            || (($iFmtIdx >= 0x2D) && ($iFmtIdx <= 0x2F))) {
            return "Date";
        } else {
            return "Numeric";
        }
    } else {
        return "Text";
    }
}
1;

__END__

=head1 NAME

Spreadsheet::XLSX::Fmt2007 - A class for Cell formats.

=head1 SYNOPSIS

See the documentation of L<Spreadsheet::XLSX>.

    my $cell = $myworkbook->worksheet->{Cells}[$row][$col]
    my $type       = $cell->{Type}; # Date, Text, or Numeric
    my $disp_value = $cell->Value;  # displayed (formatted) value set in XLSX by $myFmt2007->ValFmt($cell, $workbook)
    my $fund_value = $cell->{Val};  # fundemental (underlying) value
    my $formatter;
    if( $myworkbook->excel07 ) {
        $formatter = Spreadsheet::XLSX::Fmt2007->new();
    } else {
        $formatter = Spreadsheet::ParseExcel::FmtDefault->new();
    }  
    my $format_string = $formatter->FmtString($cell, $self->workbook);

=head1 DESCRIPTION

This module is used in conjunction with L<Spreadsheet::XLSX>. See the documentation for L<Spreadsheet::XLSX>.

This code is adapted for Excel 2007 from L<Spreadsheet::ParseExcel::FmtDefault> by Kawai, Takanori (Hippo2000) 2001-02-02.
This Program is ALPHA version.

=head1 AUTHOR

See the documentation for L<Spreadsheet::XLSX>.

=head1 COPYRIGHT

See the documentation for L<Spreadsheet::XLSX>.

=cut