Line data Source code
1 : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 : /*
3 : * This file is part of the LibreOffice project.
4 : *
5 : * This Source Code Form is subject to the terms of the Mozilla Public
6 : * License, v. 2.0. If a copy of the MPL was not distributed with this
7 : * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 : *
9 : * This file incorporates work covered by the following license notice:
10 : *
11 : * Licensed to the Apache Software Foundation (ASF) under one or more
12 : * contributor license agreements. See the NOTICE file distributed
13 : * with this work for additional information regarding copyright
14 : * ownership. The ASF licenses this file to you under the Apache
15 : * License, Version 2.0 (the "License"); you may not use this file
16 : * except in compliance with the License. You may obtain a copy of
17 : * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 : */
19 :
20 : #include "formulabase.hxx"
21 :
22 : #include <map>
23 : #include <com/sun/star/lang/XMultiServiceFactory.hpp>
24 : #include <com/sun/star/table/XCellRange.hpp>
25 : #include <com/sun/star/sheet/AddressConvention.hpp>
26 : #include <com/sun/star/sheet/ReferenceFlags.hpp>
27 : #include <com/sun/star/sheet/SingleReference.hpp>
28 : #include <com/sun/star/sheet/ComplexReference.hpp>
29 : #include <com/sun/star/sheet/FormulaLanguage.hpp>
30 : #include <com/sun/star/sheet/FormulaMapGroup.hpp>
31 : #include <com/sun/star/sheet/FormulaMapGroupSpecialOffset.hpp>
32 : #include <com/sun/star/sheet/XFormulaOpCodeMapper.hpp>
33 : #include <com/sun/star/sheet/XFormulaParser.hpp>
34 : #include <rtl/strbuf.hxx>
35 : #include <rtl/ustrbuf.hxx>
36 : #include "oox/core/filterbase.hxx"
37 : #include "oox/helper/containerhelper.hxx"
38 : #include "oox/token/properties.hxx"
39 : #include "biffinputstream.hxx"
40 :
41 : namespace oox {
42 : namespace xls {
43 :
44 : // ============================================================================
45 :
46 : using namespace ::com::sun::star::lang;
47 : using namespace ::com::sun::star::sheet;
48 : using namespace ::com::sun::star::table;
49 : using namespace ::com::sun::star::uno;
50 :
51 : using ::rtl::OString;
52 : using ::rtl::OStringBuffer;
53 : using ::rtl::OStringToOUString;
54 : using ::rtl::OUString;
55 : using ::rtl::OUStringBuffer;
56 : using ::rtl::OUStringToOString;
57 :
58 : // reference helpers ==========================================================
59 :
60 0 : BinSingleRef2d::BinSingleRef2d() :
61 : mnCol( 0 ),
62 : mnRow( 0 ),
63 : mbColRel( false ),
64 0 : mbRowRel( false )
65 : {
66 0 : }
67 :
68 0 : void BinSingleRef2d::setBiff12Data( sal_uInt16 nCol, sal_Int32 nRow, bool bRelativeAsOffset )
69 : {
70 0 : mnCol = nCol & BIFF12_TOK_REF_COLMASK;
71 0 : mnRow = nRow & BIFF12_TOK_REF_ROWMASK;
72 0 : mbColRel = getFlag( nCol, BIFF12_TOK_REF_COLREL );
73 0 : mbRowRel = getFlag( nCol, BIFF12_TOK_REF_ROWREL );
74 0 : if( bRelativeAsOffset && mbColRel && (mnCol > (BIFF12_TOK_REF_COLMASK >> 1)) )
75 0 : mnCol -= (BIFF12_TOK_REF_COLMASK + 1);
76 0 : if( bRelativeAsOffset && mbRowRel && (mnRow > (BIFF12_TOK_REF_ROWMASK >> 1)) )
77 0 : mnRow -= (BIFF12_TOK_REF_ROWMASK + 1);
78 0 : }
79 :
80 0 : void BinSingleRef2d::setBiff2Data( sal_uInt8 nCol, sal_uInt16 nRow, bool bRelativeAsOffset )
81 : {
82 0 : mnCol = nCol;
83 0 : mnRow = nRow & BIFF_TOK_REF_ROWMASK;
84 0 : mbColRel = getFlag( nRow, BIFF_TOK_REF_COLREL );
85 0 : mbRowRel = getFlag( nRow, BIFF_TOK_REF_ROWREL );
86 0 : if( bRelativeAsOffset && mbColRel && (mnCol >= 0x80) )
87 0 : mnCol -= 0x100;
88 0 : if( bRelativeAsOffset && mbRowRel && (mnRow > (BIFF_TOK_REF_ROWMASK >> 1)) )
89 0 : mnRow -= (BIFF_TOK_REF_ROWMASK + 1);
90 0 : }
91 :
92 0 : void BinSingleRef2d::setBiff8Data( sal_uInt16 nCol, sal_uInt16 nRow, bool bRelativeAsOffset )
93 : {
94 0 : mnCol = nCol & BIFF_TOK_REF_COLMASK;
95 0 : mnRow = nRow;
96 0 : mbColRel = getFlag( nCol, BIFF_TOK_REF_COLREL );
97 0 : mbRowRel = getFlag( nCol, BIFF_TOK_REF_ROWREL );
98 0 : if( bRelativeAsOffset && mbColRel && (mnCol > (BIFF_TOK_REF_COLMASK >> 1)) )
99 0 : mnCol -= (BIFF_TOK_REF_COLMASK + 1);
100 0 : if( bRelativeAsOffset && mbRowRel && (mnRow >= 0x8000) )
101 0 : mnRow -= 0x10000;
102 0 : }
103 :
104 0 : void BinSingleRef2d::readBiff12Data( SequenceInputStream& rStrm, bool bRelativeAsOffset )
105 : {
106 : sal_Int32 nRow;
107 : sal_uInt16 nCol;
108 0 : rStrm >> nRow >> nCol;
109 0 : setBiff12Data( nCol, nRow, bRelativeAsOffset );
110 0 : }
111 :
112 0 : void BinSingleRef2d::readBiff2Data( BiffInputStream& rStrm, bool bRelativeAsOffset )
113 : {
114 : sal_uInt16 nRow;
115 : sal_uInt8 nCol;
116 0 : rStrm >> nRow >> nCol;
117 0 : setBiff2Data( nCol, nRow, bRelativeAsOffset );
118 0 : }
119 :
120 0 : void BinSingleRef2d::readBiff8Data( BiffInputStream& rStrm, bool bRelativeAsOffset )
121 : {
122 : sal_uInt16 nRow, nCol;
123 0 : rStrm >> nRow >> nCol;
124 0 : setBiff8Data( nCol, nRow, bRelativeAsOffset );
125 0 : }
126 :
127 : // ----------------------------------------------------------------------------
128 :
129 0 : void BinComplexRef2d::readBiff12Data( SequenceInputStream& rStrm, bool bRelativeAsOffset )
130 : {
131 : sal_Int32 nRow1, nRow2;
132 : sal_uInt16 nCol1, nCol2;
133 0 : rStrm >> nRow1 >> nRow2 >> nCol1 >> nCol2;
134 0 : maRef1.setBiff12Data( nCol1, nRow1, bRelativeAsOffset );
135 0 : maRef2.setBiff12Data( nCol2, nRow2, bRelativeAsOffset );
136 0 : }
137 :
138 0 : void BinComplexRef2d::readBiff2Data( BiffInputStream& rStrm, bool bRelativeAsOffset )
139 : {
140 : sal_uInt16 nRow1, nRow2;
141 : sal_uInt8 nCol1, nCol2;
142 0 : rStrm >> nRow1 >> nRow2 >> nCol1 >> nCol2;
143 0 : maRef1.setBiff2Data( nCol1, nRow1, bRelativeAsOffset );
144 0 : maRef2.setBiff2Data( nCol2, nRow2, bRelativeAsOffset );
145 0 : }
146 :
147 0 : void BinComplexRef2d::readBiff8Data( BiffInputStream& rStrm, bool bRelativeAsOffset )
148 : {
149 : sal_uInt16 nRow1, nRow2, nCol1, nCol2;
150 0 : rStrm >> nRow1 >> nRow2 >> nCol1 >> nCol2;
151 0 : maRef1.setBiff8Data( nCol1, nRow1, bRelativeAsOffset );
152 0 : maRef2.setBiff8Data( nCol2, nRow2, bRelativeAsOffset );
153 0 : }
154 :
155 : // token vector, sequence =====================================================
156 :
157 22 : ApiTokenVector::ApiTokenVector()
158 : {
159 22 : }
160 :
161 36 : Any& ApiTokenVector::append( sal_Int32 nOpCode )
162 : {
163 36 : resize( size() + 1 );
164 36 : back().OpCode = nOpCode;
165 36 : return back().Data;
166 : }
167 :
168 : // token sequence iterator ====================================================
169 :
170 1 : ApiTokenIterator::ApiTokenIterator( const ApiTokenSequence& rTokens, sal_Int32 nSpacesOpCode, bool bSkipSpaces ) :
171 1 : mpToken( rTokens.getConstArray() ),
172 1 : mpTokenEnd( rTokens.getConstArray() + rTokens.getLength() ),
173 : mnSpacesOpCode( nSpacesOpCode ),
174 2 : mbSkipSpaces( bSkipSpaces )
175 : {
176 1 : skipSpaces();
177 1 : }
178 :
179 1 : ApiTokenIterator& ApiTokenIterator::operator++()
180 : {
181 1 : if( is() )
182 : {
183 1 : ++mpToken;
184 1 : skipSpaces();
185 : }
186 1 : return *this;
187 : }
188 :
189 2 : void ApiTokenIterator::skipSpaces()
190 : {
191 2 : if( mbSkipSpaces )
192 4 : while( is() && (mpToken->OpCode == mnSpacesOpCode) )
193 0 : ++mpToken;
194 2 : }
195 :
196 : // function data ==============================================================
197 :
198 : namespace {
199 :
200 : const size_t FUNCINFO_PARAMINFOCOUNT = 5; /// Number of parameter type entries.
201 :
202 : const sal_uInt16 FUNCFLAG_VOLATILE = 0x0001; /// Result is volatile (e.g. NOW() function).
203 : const sal_uInt16 FUNCFLAG_IMPORTONLY = 0x0002; /// Only used in import filter.
204 : const sal_uInt16 FUNCFLAG_EXPORTONLY = 0x0004; /// Only used in export filter.
205 : const sal_uInt16 FUNCFLAG_MACROCALL = 0x0008; /// Function is stored as macro call in Excel (_xlfn. prefix). OOXML name MUST exist.
206 : const sal_uInt16 FUNCFLAG_MACROCALLODF = 0x0010; /// ODF-only function stored as macro call in Excel (_xlfnodf. prefix). ODF name MUST exist.
207 : const sal_uInt16 FUNCFLAG_EXTERNAL = 0x0020; /// Function is external in Calc.
208 : const sal_uInt16 FUNCFLAG_MACROFUNC = 0x0040; /// Function is a macro-sheet function.
209 : const sal_uInt16 FUNCFLAG_MACROCMD = 0x0080; /// Function is a macro-sheet command.
210 : const sal_uInt16 FUNCFLAG_ALWAYSVAR = 0x0100; /// Function is always represented by a tFuncVar token.
211 : const sal_uInt16 FUNCFLAG_PARAMPAIRS = 0x0200; /// Optional parameters are expected to appear in pairs.
212 :
213 : /// Converts a function library index (value of enum FunctionLibraryType) to function flags.
214 : #define FUNCLIB_TO_FUNCFLAGS( funclib_index ) static_cast< sal_uInt16 >( static_cast< sal_uInt8 >( funclib_index ) << 12 )
215 : /// Extracts a function library index (value of enum FunctionLibraryType) from function flags.
216 : #define FUNCFLAGS_TO_FUNCLIB( func_flags ) extractValue< FunctionLibraryType >( func_flags, 12, 4 )
217 :
218 : typedef ::boost::shared_ptr< FunctionInfo > FunctionInfoRef;
219 :
220 : struct FunctionData
221 : {
222 : const sal_Char* mpcOdfFuncName; /// ODF function name.
223 : const sal_Char* mpcOoxFuncName; /// OOXML function name.
224 : sal_uInt16 mnBiff12FuncId; /// BIFF12 function identifier.
225 : sal_uInt16 mnBiffFuncId; /// BIFF2-BIFF8 function identifier.
226 : sal_uInt8 mnMinParamCount; /// Minimum number of parameters.
227 : sal_uInt8 mnMaxParamCount; /// Maximum number of parameters.
228 : sal_uInt8 mnRetClass; /// BIFF token class of the return value.
229 : FunctionParamInfo mpParamInfos[ FUNCINFO_PARAMINFOCOUNT ]; /// Information about all parameters.
230 : sal_uInt16 mnFlags; /// Additional flags.
231 :
232 : inline bool isSupported( bool bImportFilter ) const;
233 : };
234 :
235 4829 : inline bool FunctionData::isSupported( bool bImportFilter ) const
236 : {
237 : /* For import filters: the FUNCFLAG_EXPORTONLY flag must not be set,
238 : for export filters: the FUNCFLAG_IMPORTONLY flag must not be set. */
239 4829 : return !getFlag( mnFlags, bImportFilter ? FUNCFLAG_EXPORTONLY : FUNCFLAG_IMPORTONLY );
240 : }
241 :
242 : const sal_uInt16 NOID = SAL_MAX_UINT16; /// No BIFF function identifier available.
243 : const sal_uInt8 MX = SAL_MAX_UINT8; /// Maximum parameter count.
244 :
245 : // abbreviations for function return token class
246 : const sal_uInt8 R = BIFF_TOKCLASS_REF;
247 : const sal_uInt8 V = BIFF_TOKCLASS_VAL;
248 : const sal_uInt8 A = BIFF_TOKCLASS_ARR;
249 :
250 : // abbreviations for parameter infos
251 : #define RO { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_ORG, false }
252 : #define RV { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_VAL, false }
253 : #define RA { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_ARR, false }
254 : #define RR { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_RPT, false }
255 : #define RX { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_RPX, false }
256 : #define VO { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_ORG, true }
257 : #define VV { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_VAL, true }
258 : #define VA { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_ARR, true }
259 : #define VR { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_RPT, true }
260 : #define VX { FUNC_PARAM_REGULAR, FUNC_PARAMCONV_RPX, true }
261 : #define RO_E { FUNC_PARAM_EXCELONLY, FUNC_PARAMCONV_ORG, false }
262 : #define VR_E { FUNC_PARAM_EXCELONLY, FUNC_PARAMCONV_RPT, true }
263 : #define C { FUNC_PARAM_CALCONLY, FUNC_PARAMCONV_ORG, false }
264 :
265 : // Note: parameter types of all macro sheet functions (FUNCFLAG_MACROFUNC/FUNCFLAG_MACROCMD) untested!
266 :
267 : /** Functions new in BIFF2. */
268 : static const FunctionData saFuncTableBiff2[] =
269 : {
270 : { "COUNT", "COUNT", 0, 0, 0, MX, V, { RX }, 0 },
271 : { "IF", "IF", 1, 1, 2, 3, R, { VO, RO }, 0 },
272 : { "ISNA", "ISNA", 2, 2, 1, 1, V, { VR }, 0 },
273 : { "ISERROR", "ISERROR", 3, 3, 1, 1, V, { VR }, 0 },
274 : { "SUM", "SUM", 4, 4, 0, MX, V, { RX }, 0 },
275 : { "AVERAGE", "AVERAGE", 5, 5, 1, MX, V, { RX }, 0 },
276 : { "MIN", "MIN", 6, 6, 1, MX, V, { RX }, 0 },
277 : { "MAX", "MAX", 7, 7, 1, MX, V, { RX }, 0 },
278 : { "ROW", "ROW", 8, 8, 0, 1, V, { RO }, 0 },
279 : { "COLUMN", "COLUMN", 9, 9, 0, 1, V, { RO }, 0 },
280 : { "NA", "NA", 10, 10, 0, 0, V, {}, 0 },
281 : { "NPV", "NPV", 11, 11, 2, MX, V, { VR, RX }, 0 },
282 : { "STDEV", "STDEV", 12, 12, 1, MX, V, { RX }, 0 },
283 : { "DOLLAR", "DOLLAR", 13, 13, 1, 2, V, { VR }, 0 },
284 : { "FIXED", "FIXED", 14, 14, 1, 2, V, { VR, VR, C }, 0 },
285 : { "SIN", "SIN", 15, 15, 1, 1, V, { VR }, 0 },
286 : { "CSC", "SIN", 15, 15, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
287 : { "COS", "COS", 16, 16, 1, 1, V, { VR }, 0 },
288 : { "SEC", "COS", 16, 16, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
289 : { "TAN", "TAN", 17, 17, 1, 1, V, { VR }, 0 },
290 : { "COT", "TAN", 17, 17, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
291 : { "ATAN", "ATAN", 18, 18, 1, 1, V, { VR }, 0 },
292 : { "ACOT", "ATAN", 18, 18, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
293 : { "PI", "PI", 19, 19, 0, 0, V, {}, 0 },
294 : { "SQRT", "SQRT", 20, 20, 1, 1, V, { VR }, 0 },
295 : { "EXP", "EXP", 21, 21, 1, 1, V, { VR }, 0 },
296 : { "LN", "LN", 22, 22, 1, 1, V, { VR }, 0 },
297 : { "LOG10", "LOG10", 23, 23, 1, 1, V, { VR }, 0 },
298 : { "ABS", "ABS", 24, 24, 1, 1, V, { VR }, 0 },
299 : { "INT", "INT", 25, 25, 1, 1, V, { VR }, 0 },
300 : { "SIGN", "SIGN", 26, 26, 1, 1, V, { VR }, 0 },
301 : { "ROUND", "ROUND", 27, 27, 2, 2, V, { VR }, 0 },
302 : { "LOOKUP", "LOOKUP", 28, 28, 2, 3, V, { VR, RA }, 0 },
303 : { "INDEX", "INDEX", 29, 29, 2, 4, R, { RA, VV }, 0 },
304 : { "REPT", "REPT", 30, 30, 2, 2, V, { VR }, 0 },
305 : { "MID", "MID", 31, 31, 3, 3, V, { VR }, 0 },
306 : { "LEN", "LEN", 32, 32, 1, 1, V, { VR }, 0 },
307 : { "VALUE", "VALUE", 33, 33, 1, 1, V, { VR }, 0 },
308 : { "TRUE", "TRUE", 34, 34, 0, 0, V, {}, 0 },
309 : { "FALSE", "FALSE", 35, 35, 0, 0, V, {}, 0 },
310 : { "AND", "AND", 36, 36, 1, MX, V, { RX }, 0 },
311 : { "OR", "OR", 37, 37, 1, MX, V, { RX }, 0 },
312 : { "NOT", "NOT", 38, 38, 1, 1, V, { VR }, 0 },
313 : { "MOD", "MOD", 39, 39, 2, 2, V, { VR }, 0 },
314 : { "DCOUNT", "DCOUNT", 40, 40, 3, 3, V, { RO, RR }, 0 },
315 : { "DSUM", "DSUM", 41, 41, 3, 3, V, { RO, RR }, 0 },
316 : { "DAVERAGE", "DAVERAGE", 42, 42, 3, 3, V, { RO, RR }, 0 },
317 : { "DMIN", "DMIN", 43, 43, 3, 3, V, { RO, RR }, 0 },
318 : { "DMAX", "DMAX", 44, 44, 3, 3, V, { RO, RR }, 0 },
319 : { "DSTDEV", "DSTDEV", 45, 45, 3, 3, V, { RO, RR }, 0 },
320 : { "VAR", "VAR", 46, 46, 1, MX, V, { RX }, 0 },
321 : { "DVAR", "DVAR", 47, 47, 3, 3, V, { RO, RR }, 0 },
322 : { "TEXT", "TEXT", 48, 48, 2, 2, V, { VR }, 0 },
323 : { "LINEST", "LINEST", 49, 49, 1, 2, A, { RA, RA, C, C }, 0 },
324 : { "TREND", "TREND", 50, 50, 1, 3, A, { RA, RA, RA, C }, 0 },
325 : { "LOGEST", "LOGEST", 51, 51, 1, 2, A, { RA, RA, C, C }, 0 },
326 : { "GROWTH", "GROWTH", 52, 52, 1, 3, A, { RA, RA, RA, C }, 0 },
327 : { "PV", "PV", 56, 56, 3, 5, V, { VR }, 0 },
328 : { "FV", "FV", 57, 57, 3, 5, V, { VR }, 0 },
329 : { "NPER", "NPER", 58, 58, 3, 5, V, { VR }, 0 },
330 : { "PMT", "PMT", 59, 59, 3, 5, V, { VR }, 0 },
331 : { "RATE", "RATE", 60, 60, 3, 6, V, { VR }, 0 },
332 : { "MIRR", "MIRR", 61, 61, 3, 3, V, { RA, VR }, 0 },
333 : { "IRR", "IRR", 62, 62, 1, 2, V, { RA, VR }, 0 },
334 : { "RAND", "RAND", 63, 63, 0, 0, V, {}, FUNCFLAG_VOLATILE },
335 : { "MATCH", "MATCH", 64, 64, 2, 3, V, { VR, RX, RR }, 0 },
336 : { "DATE", "DATE", 65, 65, 3, 3, V, { VR }, 0 },
337 : { "TIME", "TIME", 66, 66, 3, 3, V, { VR }, 0 },
338 : { "DAY", "DAY", 67, 67, 1, 1, V, { VR }, 0 },
339 : { "MONTH", "MONTH", 68, 68, 1, 1, V, { VR }, 0 },
340 : { "YEAR", "YEAR", 69, 69, 1, 1, V, { VR }, 0 },
341 : { "WEEKDAY", "WEEKDAY", 70, 70, 1, 1, V, { VR, C }, 0 },
342 : { "HOUR", "HOUR", 71, 71, 1, 1, V, { VR }, 0 },
343 : { "MINUTE", "MINUTE", 72, 72, 1, 1, V, { VR }, 0 },
344 : { "SECOND", "SECOND", 73, 73, 1, 1, V, { VR }, 0 },
345 : { "NOW", "NOW", 74, 74, 0, 0, V, {}, FUNCFLAG_VOLATILE },
346 : { "AREAS", "AREAS", 75, 75, 1, 1, V, { RO }, 0 },
347 : { "ROWS", "ROWS", 76, 76, 1, 1, V, { RO }, 0 },
348 : { "COLUMNS", "COLUMNS", 77, 77, 1, 1, V, { RO }, 0 },
349 : { "OFFSET", "OFFSET", 78, 78, 3, 5, R, { RO, VR }, FUNCFLAG_VOLATILE },
350 : { "SEARCH", "SEARCH", 82, 82, 2, 3, V, { VR }, 0 },
351 : { "TRANSPOSE", "TRANSPOSE", 83, 83, 1, 1, A, { VO }, 0 },
352 : { "TYPE", "TYPE", 86, 86, 1, 1, V, { VX }, 0 },
353 : { "ATAN2", "ATAN2", 97, 97, 2, 2, V, { VR }, 0 },
354 : { "ASIN", "ASIN", 98, 98, 1, 1, V, { VR }, 0 },
355 : { "ACOS", "ACOS", 99, 99, 1, 1, V, { VR }, 0 },
356 : { "CHOOSE", "CHOOSE", 100, 100, 2, MX, R, { VO, RO }, 0 },
357 : { "HLOOKUP", "HLOOKUP", 101, 101, 3, 3, V, { VV, RO, RO, C }, 0 },
358 : { "VLOOKUP", "VLOOKUP", 102, 102, 3, 3, V, { VV, RO, RO, C }, 0 },
359 : { "ISREF", "ISREF", 105, 105, 1, 1, V, { RX }, 0 },
360 : { "LOG", "LOG", 109, 109, 1, 2, V, { VR }, 0 },
361 : { "CHAR", "CHAR", 111, 111, 1, 1, V, { VR }, 0 },
362 : { "LOWER", "LOWER", 112, 112, 1, 1, V, { VR }, 0 },
363 : { "UPPER", "UPPER", 113, 113, 1, 1, V, { VR }, 0 },
364 : { "PROPER", "PROPER", 114, 114, 1, 1, V, { VR }, 0 },
365 : { "LEFT", "LEFT", 115, 115, 1, 2, V, { VR }, 0 },
366 : { "RIGHT", "RIGHT", 116, 116, 1, 2, V, { VR }, 0 },
367 : { "EXACT", "EXACT", 117, 117, 2, 2, V, { VR }, 0 },
368 : { "TRIM", "TRIM", 118, 118, 1, 1, V, { VR }, 0 },
369 : { "REPLACE", "REPLACE", 119, 119, 4, 4, V, { VR }, 0 },
370 : { "SUBSTITUTE", "SUBSTITUTE", 120, 120, 3, 4, V, { VR }, 0 },
371 : { "CODE", "CODE", 121, 121, 1, 1, V, { VR }, 0 },
372 : { "FIND", "FIND", 124, 124, 2, 3, V, { VR }, 0 },
373 : { "CELL", "CELL", 125, 125, 1, 2, V, { VV, RO }, FUNCFLAG_VOLATILE },
374 : { "ISERR", "ISERR", 126, 126, 1, 1, V, { VR }, 0 },
375 : { "ISTEXT", "ISTEXT", 127, 127, 1, 1, V, { VR }, 0 },
376 : { "ISNUMBER", "ISNUMBER", 128, 128, 1, 1, V, { VR }, 0 },
377 : { "ISBLANK", "ISBLANK", 129, 129, 1, 1, V, { VR }, 0 },
378 : { "T", "T", 130, 130, 1, 1, V, { RO }, 0 },
379 : { "N", "N", 131, 131, 1, 1, V, { RO }, 0 },
380 : { "DATEVALUE", "DATEVALUE", 140, 140, 1, 1, V, { VR }, 0 },
381 : { "TIMEVALUE", "TIMEVALUE", 141, 141, 1, 1, V, { VR }, 0 },
382 : { "SLN", "SLN", 142, 142, 3, 3, V, { VR }, 0 },
383 : { "SYD", "SYD", 143, 143, 4, 4, V, { VR }, 0 },
384 : { "DDB", "DDB", 144, 144, 4, 5, V, { VR }, 0 },
385 : { "INDIRECT", "INDIRECT", 148, 148, 1, 2, R, { VR }, FUNCFLAG_VOLATILE },
386 : { "CLEAN", "CLEAN", 162, 162, 1, 1, V, { VR }, 0 },
387 : { "MDETERM", "MDETERM", 163, 163, 1, 1, V, { VA }, 0 },
388 : { "MINVERSE", "MINVERSE", 164, 164, 1, 1, A, { VA }, 0 },
389 : { "MMULT", "MMULT", 165, 165, 2, 2, A, { VA }, 0 },
390 : { "IPMT", "IPMT", 167, 167, 4, 6, V, { VR }, 0 },
391 : { "PPMT", "PPMT", 168, 168, 4, 6, V, { VR }, 0 },
392 : { "COUNTA", "COUNTA", 169, 169, 0, MX, V, { RX }, 0 },
393 : { "PRODUCT", "PRODUCT", 183, 183, 0, MX, V, { RX }, 0 },
394 : { "FACT", "FACT", 184, 184, 1, 1, V, { VR }, 0 },
395 : { "DPRODUCT", "DPRODUCT", 189, 189, 3, 3, V, { RO, RR }, 0 },
396 : { "ISNONTEXT", "ISNONTEXT", 190, 190, 1, 1, V, { VR }, 0 },
397 : { "STDEVP", "STDEVP", 193, 193, 1, MX, V, { RX }, 0 },
398 : { "VARP", "VARP", 194, 194, 1, MX, V, { RX }, 0 },
399 : { "DSTDEVP", "DSTDEVP", 195, 195, 3, 3, V, { RO, RR }, 0 },
400 : { "DVARP", "DVARP", 196, 196, 3, 3, V, { RO, RR }, 0 },
401 : { "TRUNC", "TRUNC", 197, 197, 1, 1, V, { VR, C }, 0 },
402 : { "ISLOGICAL", "ISLOGICAL", 198, 198, 1, 1, V, { VR }, 0 },
403 : { "DCOUNTA", "DCOUNTA", 199, 199, 3, 3, V, { RO, RR }, 0 },
404 : { 0, "EXTERN.CALL", 255, 255, 1, MX, R, { RO_E, RO }, FUNCFLAG_IMPORTONLY },
405 :
406 : // *** macro sheet commands ***
407 :
408 : { 0, "A1.R1C1", 30, 30, 0, 1, V, { VR }, FUNCFLAG_MACROCMD },
409 : { 0, "RETURN", 55, 55, 0, 1, R, { RO }, FUNCFLAG_MACROFUNC },
410 : { 0, "ABSREF", 79, 79, 2, 2, R, { VR, RO }, FUNCFLAG_MACROFUNC },
411 : { 0, "ADD.ARROW", 81, 81, 0, 0, V, {}, FUNCFLAG_MACROCMD },
412 : { 0, "ACTIVE.CELL", 94, 94, 0, 0, R, {}, FUNCFLAG_MACROFUNC },
413 : { 0, "ACTIVATE", 103, 103, 0, 2, V, { VR }, FUNCFLAG_MACROCMD },
414 : { 0, "ACTIVATE.NEXT", 104, 104, 0, 0, V, {}, FUNCFLAG_MACROCMD },
415 : { 0, "ACTIVATE.PREV", 105, 105, 0, 0, V, {}, FUNCFLAG_MACROCMD },
416 : { 0, "ADD.BAR", 151, 151, 0, 0, V, {}, FUNCFLAG_MACROFUNC | FUNCFLAG_ALWAYSVAR },
417 : { 0, "ADD.MENU", 152, 152, 2, 2, V, { VR, RO }, FUNCFLAG_MACROFUNC | FUNCFLAG_ALWAYSVAR },
418 : { 0, "ADD.COMMAND", 153, 153, 3, 3, V, { VR, RO }, FUNCFLAG_MACROFUNC | FUNCFLAG_ALWAYSVAR }
419 : };
420 :
421 : /** Functions new in BIFF3. */
422 : static const FunctionData saFuncTableBiff3[] =
423 : {
424 : { "LINEST", "LINEST", 49, 49, 1, 4, A, { RA, RA, VV }, 0 }, // BIFF2: 1-2, BIFF3: 1-4
425 : { "TREND", "TREND", 50, 50, 1, 4, A, { RA, RA, RA, VV }, 0 }, // BIFF2: 1-3, BIFF3: 1-4
426 : { "LOGEST", "LOGEST", 51, 51, 1, 4, A, { RA, RA, VV }, 0 }, // BIFF2: 1-2, BIFF3: 1-4
427 : { "GROWTH", "GROWTH", 52, 52, 1, 4, A, { RA, RA, RA, VV }, 0 }, // BIFF2: 1-3, BIFF3: 1-4
428 : { "TRUNC", "TRUNC", 197, 197, 1, 2, V, { VR }, 0 }, // BIFF2: 1, BIFF3: 1-2
429 : { "DOLLAR", "USDOLLAR", 204, 204, 1, 2, V, { VR }, FUNCFLAG_IMPORTONLY },
430 : { 0/*"FIND"*/, "FINDB", 205, 205, 2, 3, V, { VR }, 0 },
431 : { 0/*"SEARCH"*/, "SEARCHB", 206, 206, 2, 3, V, { VR }, 0 },
432 : { 0/*"REPLACE"*/, "REPLACEB", 207, 207, 4, 4, V, { VR }, 0 },
433 : { 0/*"LEFT"*/, "LEFTB", 208, 208, 1, 2, V, { VR }, 0 },
434 : { 0/*"RIGHT"*/, "RIGHTB", 209, 209, 1, 2, V, { VR }, 0 },
435 : { 0/*"MID"*/, "MIDB", 210, 210, 3, 3, V, { VR }, 0 },
436 : { 0/*"LEN"*/, "LENB", 211, 211, 1, 1, V, { VR }, 0 },
437 : { "ROUNDUP", "ROUNDUP", 212, 212, 2, 2, V, { VR }, 0 },
438 : { "ROUNDDOWN", "ROUNDDOWN", 213, 213, 2, 2, V, { VR }, 0 },
439 : { "ASC", "ASC", 214, 214, 1, 1, V, { VR }, 0 },
440 : { "JIS", "DBCS", 215, 215, 1, 1, V, { VR }, 0 },
441 : { "ADDRESS", "ADDRESS", 219, 219, 2, 5, V, { VR }, 0 },
442 : { "DAYS360", "DAYS360", 220, 220, 2, 2, V, { VR, VR, C }, 0 },
443 : { "TODAY", "TODAY", 221, 221, 0, 0, V, {}, FUNCFLAG_VOLATILE },
444 : { "VDB", "VDB", 222, 222, 5, 7, V, { VR }, 0 },
445 : { "MEDIAN", "MEDIAN", 227, 227, 1, MX, V, { RX }, 0 },
446 : { "SUMPRODUCT", "SUMPRODUCT", 228, 228, 1, MX, V, { VA }, 0 },
447 : { "SINH", "SINH", 229, 229, 1, 1, V, { VR }, 0 },
448 : { "CSCH", "SINH", 229, 229, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
449 : { "COSH", "COSH", 230, 230, 1, 1, V, { VR }, 0 },
450 : { "SECH", "COSH", 230, 230, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
451 : { "TANH", "TANH", 231, 231, 1, 1, V, { VR }, 0 },
452 : { "COTH", "TANH", 231, 231, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
453 : { "ASINH", "ASINH", 232, 232, 1, 1, V, { VR }, 0 },
454 : { "ACOSH", "ACOSH", 233, 233, 1, 1, V, { VR }, 0 },
455 : { "ATANH", "ATANH", 234, 234, 1, 1, V, { VR }, 0 },
456 : { "ACOTH", "ATANH", 234, 234, 1, 1, V, { VR }, FUNCFLAG_EXPORTONLY },
457 : { "DGET", "DGET", 235, 235, 3, 3, V, { RO, RR }, 0 },
458 : { "INFO", "INFO", 244, 244, 1, 1, V, { VR }, FUNCFLAG_VOLATILE },
459 :
460 : // *** macro sheet commands ***
461 :
462 : { 0, "ADD.BAR", 151, 151, 0, 1, V, { VR }, FUNCFLAG_MACROFUNC }, // BIFF2: 0, BIFF3: 0-1
463 : { 0, "ADD.MENU", 152, 152, 2, 3, V, { VR, RO }, FUNCFLAG_MACROFUNC }, // BIFF2: 2, BIFF3: 2-3
464 : { 0, "ADD.COMMAND", 153, 153, 3, 4, V, { VR, RO }, FUNCFLAG_MACROFUNC } // BIFF2: 3, BIFF3: 3-4
465 : };
466 :
467 : /** Functions new in BIFF4. */
468 : static const FunctionData saFuncTableBiff4[] =
469 : {
470 : { "FIXED", "FIXED", 14, 14, 1, 3, V, { VR }, 0 }, // BIFF2-3: 1-2, BIFF4: 1-3
471 : { "RANK", "RANK", 216, 216, 2, 3, V, { VR, RO, VR }, 0 },
472 : { "DB", "DB", 247, 247, 4, 5, V, { VR }, 0 },
473 : { "FREQUENCY", "FREQUENCY", 252, 252, 2, 2, A, { RA }, 0 },
474 : { "ORG.OPENOFFICE.ERRORTYPE","ERROR.TYPE", 261, 261, 1, 1, V, { VR }, 0 },
475 : { "AVEDEV", "AVEDEV", 269, 269, 1, MX, V, { RX }, 0 },
476 : { "BETADIST", "BETADIST", 270, 270, 3, 5, V, { VR }, 0 },
477 : { "GAMMALN", "GAMMALN", 271, 271, 1, 1, V, { VR }, 0 },
478 : { "BETAINV", "BETAINV", 272, 272, 3, 5, V, { VR }, 0 },
479 : { "BINOMDIST", "BINOMDIST", 273, 273, 4, 4, V, { VR }, 0 },
480 : { "LEGACY.CHIDIST", "CHIDIST", 274, 274, 2, 2, V, { VR }, 0 },
481 : { "LEGACY.CHIINV", "CHIINV", 275, 275, 2, 2, V, { VR }, 0 },
482 : { "COMBIN", "COMBIN", 276, 276, 2, 2, V, { VR }, 0 },
483 : { "CONFIDENCE", "CONFIDENCE", 277, 277, 3, 3, V, { VR }, 0 },
484 : { "CRITBINOM", "CRITBINOM", 278, 278, 3, 3, V, { VR }, 0 },
485 : { "EVEN", "EVEN", 279, 279, 1, 1, V, { VR }, 0 },
486 : { "EXPONDIST", "EXPONDIST", 280, 280, 3, 3, V, { VR }, 0 },
487 : { "LEGACY.FDIST", "FDIST", 281, 281, 3, 3, V, { VR }, 0 },
488 : { "LEGACY.FINV", "FINV", 282, 282, 3, 3, V, { VR }, 0 },
489 : { "FISHER", "FISHER", 283, 283, 1, 1, V, { VR }, 0 },
490 : { "FISHERINV", "FISHERINV", 284, 284, 1, 1, V, { VR }, 0 },
491 : { "FLOOR", "FLOOR", 285, 285, 2, 2, V, { VR, VR, C }, 0 },
492 : { "GAMMADIST", "GAMMADIST", 286, 286, 4, 4, V, { VR }, 0 },
493 : { "GAMMAINV", "GAMMAINV", 287, 287, 3, 3, V, { VR }, 0 },
494 : { "CEILING", "CEILING", 288, 288, 2, 2, V, { VR, VR, C }, 0 },
495 : { "HYPGEOMDIST", "HYPGEOMDIST", 289, 289, 4, 4, V, { VR }, 0 },
496 : { "LOGNORMDIST", "LOGNORMDIST", 290, 290, 3, 3, V, { VR }, 0 },
497 : { "LOGINV", "LOGINV", 291, 291, 3, 3, V, { VR }, 0 },
498 : { "NEGBINOMDIST", "NEGBINOMDIST", 292, 292, 3, 3, V, { VR }, 0 },
499 : { "NORMDIST", "NORMDIST", 293, 293, 4, 4, V, { VR }, 0 },
500 : { "LEGACY.NORMSDIST", "NORMSDIST", 294, 294, 1, 1, V, { VR }, 0 },
501 : { "NORMINV", "NORMINV", 295, 295, 3, 3, V, { VR }, 0 },
502 : { "LEGACY.NORMSINV", "NORMSINV", 296, 296, 1, 1, V, { VR }, 0 },
503 : { "STANDARDIZE", "STANDARDIZE", 297, 297, 3, 3, V, { VR }, 0 },
504 : { "ODD", "ODD", 298, 298, 1, 1, V, { VR }, 0 },
505 : { "PERMUT", "PERMUT", 299, 299, 2, 2, V, { VR }, 0 },
506 : { "POISSON", "POISSON", 300, 300, 3, 3, V, { VR }, 0 },
507 : { "TDIST", "TDIST", 301, 301, 3, 3, V, { VR }, 0 },
508 : { "WEIBULL", "WEIBULL", 302, 302, 4, 4, V, { VR }, 0 },
509 : { "SUMXMY2", "SUMXMY2", 303, 303, 2, 2, V, { VA }, 0 },
510 : { "SUMX2MY2", "SUMX2MY2", 304, 304, 2, 2, V, { VA }, 0 },
511 : { "SUMX2PY2", "SUMX2PY2", 305, 305, 2, 2, V, { VA }, 0 },
512 : { "LEGACY.CHITEST", "CHITEST", 306, 306, 2, 2, V, { VA }, 0 },
513 : { "CORREL", "CORREL", 307, 307, 2, 2, V, { VA }, 0 },
514 : { "COVAR", "COVAR", 308, 308, 2, 2, V, { VA }, 0 },
515 : { "FORECAST", "FORECAST", 309, 309, 3, 3, V, { VR, VA }, 0 },
516 : { "FTEST", "FTEST", 310, 310, 2, 2, V, { VA }, 0 },
517 : { "INTERCEPT", "INTERCEPT", 311, 311, 2, 2, V, { VA }, 0 },
518 : { "PEARSON", "PEARSON", 312, 312, 2, 2, V, { VA }, 0 },
519 : { "RSQ", "RSQ", 313, 313, 2, 2, V, { VA }, 0 },
520 : { "STEYX", "STEYX", 314, 314, 2, 2, V, { VA }, 0 },
521 : { "SLOPE", "SLOPE", 315, 315, 2, 2, V, { VA }, 0 },
522 : { "TTEST", "TTEST", 316, 316, 4, 4, V, { VA, VA, VR }, 0 },
523 : { "PROB", "PROB", 317, 317, 3, 4, V, { VA, VA, VR }, 0 },
524 : { "DEVSQ", "DEVSQ", 318, 318, 1, MX, V, { RX }, 0 },
525 : { "GEOMEAN", "GEOMEAN", 319, 319, 1, MX, V, { RX }, 0 },
526 : { "HARMEAN", "HARMEAN", 320, 320, 1, MX, V, { RX }, 0 },
527 : { "SUMSQ", "SUMSQ", 321, 321, 0, MX, V, { RX }, 0 },
528 : { "KURT", "KURT", 322, 322, 1, MX, V, { RX }, 0 },
529 : { "SKEW", "SKEW", 323, 323, 1, MX, V, { RX }, 0 },
530 : { "ZTEST", "ZTEST", 324, 324, 2, 3, V, { RX, VR }, 0 },
531 : { "LARGE", "LARGE", 325, 325, 2, 2, V, { RX, VR }, 0 },
532 : { "SMALL", "SMALL", 326, 326, 2, 2, V, { RX, VR }, 0 },
533 : { "QUARTILE", "QUARTILE", 327, 327, 2, 2, V, { RX, VR }, 0 },
534 : { "PERCENTILE", "PERCENTILE", 328, 328, 2, 2, V, { RX, VR }, 0 },
535 : { "PERCENTRANK", "PERCENTRANK", 329, 329, 2, 3, V, { RX, VR, VR_E }, 0 },
536 : { "MODE", "MODE", 330, 330, 1, MX, V, { VA }, 0 },
537 : { "TRIMMEAN", "TRIMMEAN", 331, 331, 2, 2, V, { RX, VR }, 0 },
538 : { "TINV", "TINV", 332, 332, 2, 2, V, { VR }, 0 },
539 :
540 : // *** Analysis add-in ***
541 :
542 : { "HEX2BIN", "HEX2BIN", 384, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
543 : { "HEX2DEC", "HEX2DEC", 385, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
544 : { "HEX2OCT", "HEX2OCT", 386, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
545 : { "DEC2BIN", "DEC2BIN", 387, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
546 : { "DEC2HEX", "DEC2HEX", 388, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
547 : { "DEC2OCT", "DEC2OCT", 389, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
548 : { "OCT2BIN", "OCT2BIN", 390, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
549 : { "OCT2HEX", "OCT2HEX", 391, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
550 : { "OCT2DEC", "OCT2DEC", 392, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
551 : { "BIN2DEC", "BIN2DEC", 393, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
552 : { "BIN2OCT", "BIN2OCT", 394, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
553 : { "BIN2HEX", "BIN2HEX", 395, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
554 : { "IMSUB", "IMSUB", 396, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
555 : { "IMDIV", "IMDIV", 397, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
556 : { "IMPOWER", "IMPOWER", 398, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
557 : { "IMABS", "IMABS", 399, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
558 : { "IMSQRT", "IMSQRT", 400, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
559 : { "IMLN", "IMLN", 401, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
560 : { "IMLOG2", "IMLOG2", 402, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
561 : { "IMLOG10", "IMLOG10", 403, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
562 : { "IMSIN", "IMSIN", 404, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
563 : { "IMCOS", "IMCOS", 405, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
564 : { "IMEXP", "IMEXP", 406, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
565 : { "IMARGUMENT", "IMARGUMENT", 407, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
566 : { "IMCONJUGATE", "IMCONJUGATE", 408, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
567 : { "IMAGINARY", "IMAGINARY", 409, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
568 : { "IMREAL", "IMREAL", 410, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
569 : { "COMPLEX", "COMPLEX", 411, NOID, 2, 3, V, { RR }, FUNCFLAG_EXTERNAL },
570 : { "IMSUM", "IMSUM", 412, NOID, 1, MX, V, { RX }, FUNCFLAG_EXTERNAL },
571 : { "IMPRODUCT", "IMPRODUCT", 413, NOID, 1, MX, V, { RX }, FUNCFLAG_EXTERNAL },
572 : { "SERIESSUM", "SERIESSUM", 414, NOID, 4, 4, V, { RR, RR, RR, RX }, FUNCFLAG_EXTERNAL },
573 : { "FACTDOUBLE", "FACTDOUBLE", 415, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
574 : { "SQRTPI", "SQRTPI", 416, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
575 : { "QUOTIENT", "QUOTIENT", 417, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
576 : { "DELTA", "DELTA", 418, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
577 : { "GESTEP", "GESTEP", 419, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
578 : { "ISEVEN", "ISEVEN", 420, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
579 : { "ISODD", "ISODD", 421, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
580 : { "MROUND", "MROUND", 422, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
581 : { "ERF", "ERF", 423, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
582 : { "ERFC", "ERFC", 424, NOID, 1, 1, V, { RR }, FUNCFLAG_EXTERNAL },
583 : { "BESSELJ", "BESSELJ", 425, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
584 : { "BESSELK", "BESSELK", 426, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
585 : { "BESSELY", "BESSELY", 427, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
586 : { "BESSELI", "BESSELI", 428, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
587 : { "XIRR", "XIRR", 429, NOID, 2, 3, V, { RX, RX, RR }, FUNCFLAG_EXTERNAL },
588 : { "XNPV", "XNPV", 430, NOID, 3, 3, V, { RR, RX, RX }, FUNCFLAG_EXTERNAL },
589 : { "PRICEMAT", "PRICEMAT", 431, NOID, 5, 6, V, { RR }, FUNCFLAG_EXTERNAL },
590 : { "YIELDMAT", "YIELDMAT", 432, NOID, 5, 6, V, { RR }, FUNCFLAG_EXTERNAL },
591 : { "INTRATE", "INTRATE", 433, NOID, 4, 5, V, { RR }, FUNCFLAG_EXTERNAL },
592 : { "RECEIVED", "RECEIVED", 434, NOID, 4, 5, V, { RR }, FUNCFLAG_EXTERNAL },
593 : { "DISC", "DISC", 435, NOID, 4, 5, V, { RR }, FUNCFLAG_EXTERNAL },
594 : { "PRICEDISC", "PRICEDISC", 436, NOID, 4, 5, V, { RR }, FUNCFLAG_EXTERNAL },
595 : { "YIELDDISC", "YIELDDISC", 437, NOID, 4, 5, V, { RR }, FUNCFLAG_EXTERNAL },
596 : { "TBILLEQ", "TBILLEQ", 438, NOID, 3, 3, V, { RR }, FUNCFLAG_EXTERNAL },
597 : { "TBILLPRICE", "TBILLPRICE", 439, NOID, 3, 3, V, { RR }, FUNCFLAG_EXTERNAL },
598 : { "TBILLYIELD", "TBILLYIELD", 440, NOID, 3, 3, V, { RR }, FUNCFLAG_EXTERNAL },
599 : { "PRICE", "PRICE", 441, NOID, 6, 7, V, { RR }, FUNCFLAG_EXTERNAL },
600 : { "YIELD", "YIELD", 442, NOID, 6, 7, V, { RR }, FUNCFLAG_EXTERNAL },
601 : { "DOLLARDE", "DOLLARDE", 443, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
602 : { "DOLLARFR", "DOLLARFR", 444, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
603 : { "NOMINAL", "NOMINAL", 445, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
604 : { "EFFECT", "EFFECT", 446, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
605 : { "CUMPRINC", "CUMPRINC", 447, NOID, 6, 6, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
606 : { "CUMIPMT", "CUMIPMT", 448, NOID, 6, 6, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
607 : { "EDATE", "EDATE", 449, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
608 : { "EOMONTH", "EOMONTH", 450, NOID, 2, 2, V, { RR }, FUNCFLAG_EXTERNAL },
609 : { "YEARFRAC", "YEARFRAC", 451, NOID, 2, 3, V, { RR }, FUNCFLAG_EXTERNAL },
610 : { "COUPDAYBS", "COUPDAYBS", 452, NOID, 3, 4, V, { RR }, FUNCFLAG_EXTERNAL },
611 : { "COUPDAYS", "COUPDAYS", 453, NOID, 3, 4, V, { RR }, FUNCFLAG_EXTERNAL },
612 : { "COUPDAYSNC", "COUPDAYSNC", 454, NOID, 3, 4, V, { RR }, FUNCFLAG_EXTERNAL },
613 : { "COUPNCD", "COUPNCD", 455, NOID, 3, 4, V, { RR }, FUNCFLAG_EXTERNAL },
614 : { "COUPNUM", "COUPNUM", 456, NOID, 3, 4, V, { RR }, FUNCFLAG_EXTERNAL },
615 : { "COUPPCD", "COUPPCD", 457, NOID, 3, 4, V, { RR }, FUNCFLAG_EXTERNAL },
616 : { "DURATION", "DURATION", 458, NOID, 5, 6, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
617 : { "MDURATION", "MDURATION", 459, NOID, 5, 6, V, { RR }, FUNCFLAG_EXTERNAL },
618 : { "ODDLPRICE", "ODDLPRICE", 460, NOID, 7, 8, V, { RR }, FUNCFLAG_EXTERNAL },
619 : { "ODDLYIELD", "ODDLYIELD", 461, NOID, 8, 9, V, { RR }, FUNCFLAG_EXTERNAL },
620 : { "ODDFPRICE", "ODDFPRICE", 462, NOID, 8, 9, V, { RR }, FUNCFLAG_EXTERNAL },
621 : { "ODDFYIELD", "ODDFYIELD", 463, NOID, 8, 9, V, { RR }, FUNCFLAG_EXTERNAL },
622 : { "RANDBETWEEN", "RANDBETWEEN", 464, NOID, 2, 2, V, { RR }, FUNCFLAG_VOLATILE | FUNCFLAG_EXTERNAL },
623 : { "WEEKNUM", "WEEKNUM", 465, NOID, 1, 2, V, { RR }, FUNCFLAG_EXTERNAL },
624 : { "AMORDEGRC", "AMORDEGRC", 466, NOID, 6, 7, V, { RR }, FUNCFLAG_EXTERNAL },
625 : { "AMORLINC", "AMORLINC", 467, NOID, 6, 7, V, { RR }, FUNCFLAG_EXTERNAL },
626 : { "CONVERT", "CONVERT", 468, NOID, 3, 3, V, { RR }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
627 : { "ACCRINT", "ACCRINT", 469, NOID, 6, 7, V, { RR }, FUNCFLAG_EXTERNAL },
628 : { "ACCRINTM", "ACCRINTM", 470, NOID, 4, 5, V, { RR }, FUNCFLAG_EXTERNAL },
629 : { "WORKDAY", "WORKDAY", 471, NOID, 2, 3, V, { RR, RR, RX, C }, FUNCFLAG_EXTERNAL },
630 : { "NETWORKDAYS", "NETWORKDAYS", 472, NOID, 2, 3, V, { RR, RR, RX, C }, FUNCFLAG_EXTERNAL },
631 : { "GCD", "GCD", 473, NOID, 1, MX, V, { RX }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
632 : { "MULTINOMIAL", "MULTINOMIAL", 474, NOID, 1, MX, V, { RX }, FUNCFLAG_EXTERNAL },
633 : { "LCM", "LCM", 475, NOID, 1, MX, V, { RX }, FUNCFLAG_EXTERNAL }, // Calc: builtin and add-in
634 : { "FVSCHEDULE", "FVSCHEDULE", 476, NOID, 2, 2, V, { RR, RX }, FUNCFLAG_EXTERNAL },
635 :
636 : // *** macro sheet commands ***
637 :
638 : { 0, "ACTIVATE.NEXT", 104, 104, 0, 1, V, { VR }, FUNCFLAG_MACROCMD }, // BIFF2-3: 0, BIFF4: 0-1
639 : { 0, "ACTIVATE.PREV", 105, 105, 0, 1, V, { VR }, FUNCFLAG_MACROCMD } // BIFF2-3: 0, BIFF4: 0-1
640 : };
641 :
642 : /** Functions new in BIFF5/BIFF7. */
643 : static const FunctionData saFuncTableBiff5[] =
644 : {
645 : { "WEEKDAY", "WEEKDAY", 70, 70, 1, 2, V, { VR }, 0 }, // BIFF2-4: 1, BIFF5: 1-2
646 : { "HLOOKUP", "HLOOKUP", 101, 101, 3, 4, V, { VV, RO, RO, VV }, 0 }, // BIFF2-4: 3, BIFF5: 3-4
647 : { "VLOOKUP", "VLOOKUP", 102, 102, 3, 4, V, { VV, RO, RO, VV }, 0 }, // BIFF2-4: 3, BIFF5: 3-4
648 : { "DAYS360", "DAYS360", 220, 220, 2, 3, V, { VR }, 0 }, // BIFF3-4: 2, BIFF5: 2-3
649 : { 0, "EXTERN.CALL", 255, 255, 1, MX, R, { RO_E, RO }, FUNCFLAG_EXPORTONLY }, // MACRO or EXTERNAL
650 : { "CONCATENATE", "CONCATENATE", 336, 336, 0, MX, V, { VR }, 0 },
651 : { "POWER", "POWER", 337, 337, 2, 2, V, { VR }, 0 },
652 : { "RADIANS", "RADIANS", 342, 342, 1, 1, V, { VR }, 0 },
653 : { "DEGREES", "DEGREES", 343, 343, 1, 1, V, { VR }, 0 },
654 : { "SUBTOTAL", "SUBTOTAL", 344, 344, 2, MX, V, { VR, RO }, 0 },
655 : { "SUMIF", "SUMIF", 345, 345, 2, 3, V, { RO, VR, RO }, 0 },
656 : { "COUNTIF", "COUNTIF", 346, 346, 2, 2, V, { RO, VR }, 0 },
657 : { "COUNTBLANK", "COUNTBLANK", 347, 347, 1, 1, V, { RO }, 0 },
658 : { "ISPMT", "ISPMT", 350, 350, 4, 4, V, { VR }, 0 },
659 : { "DATEDIF", "DATEDIF", 351, 351, 3, 3, V, { VR }, 0 },
660 : { 0, "DATESTRING", 352, 352, 1, 1, V, { VR }, FUNCFLAG_IMPORTONLY }, // not supported in Calc, missing in OOXML spec
661 : { 0, "NUMBERSTRING", 353, 353, 2, 2, V, { VR }, FUNCFLAG_IMPORTONLY }, // not supported in Calc, missing in OOXML spec
662 : { "ROMAN", "ROMAN", 354, 354, 1, 2, V, { VR }, 0 },
663 :
664 : // *** EuroTool add-in ***
665 :
666 : { "EUROCONVERT", "EUROCONVERT", NOID, NOID, 3, 5, V, { VR }, FUNCLIB_TO_FUNCFLAGS( FUNCLIB_EUROTOOL ) },
667 :
668 : // *** macro sheet commands ***
669 :
670 : { 0, "ADD.MENU", 152, 152, 2, 4, V, { VR, RO, RO, VR }, FUNCFLAG_MACROFUNC }, // BIFF3-4: 2-3, BIFF5: 2-4
671 : { 0, "ADD.COMMAND", 153, 153, 3, 5, V, { VR, RO, RO, RO, VR }, FUNCFLAG_MACROFUNC }, // BIFF3-4: 3-4, BIFF5: 3-5
672 : { 0, "ADD.CHART.AUTOFORMAT", 390, 390, 0, 2, V, { VR }, FUNCFLAG_MACROCMD },
673 : { 0, "ADD.LIST.ITEM", 451, 451, 0, 2, V, { VR }, FUNCFLAG_MACROCMD },
674 : { 0, "ACTIVE.CELL.FONT", 476, 476, 0, 14, V, { VR }, FUNCFLAG_MACROCMD }
675 : };
676 :
677 : /** Functions new in BIFF8. */
678 : static const FunctionData saFuncTableBiff8[] =
679 : {
680 : { "GETPIVOTDATA", "GETPIVOTDATA", 358, 358, 2, MX, V, { RR, RR, VR, VR }, FUNCFLAG_IMPORTONLY | FUNCFLAG_PARAMPAIRS },
681 : { "HYPERLINK", "HYPERLINK", 359, 359, 1, 2, V, { VV, VO }, 0 },
682 : { 0, "PHONETIC", 360, 360, 1, 1, V, { RO }, FUNCFLAG_IMPORTONLY },
683 : { "AVERAGEA", "AVERAGEA", 361, 361, 1, MX, V, { RX }, 0 },
684 : { "MAXA", "MAXA", 362, 362, 1, MX, V, { RX }, 0 },
685 : { "MINA", "MINA", 363, 363, 1, MX, V, { RX }, 0 },
686 : { "STDEVPA", "STDEVPA", 364, 364, 1, MX, V, { RX }, 0 },
687 : { "VARPA", "VARPA", 365, 365, 1, MX, V, { RX }, 0 },
688 : { "STDEVA", "STDEVA", 366, 366, 1, MX, V, { RX }, 0 },
689 : { "VARA", "VARA", 367, 367, 1, MX, V, { RX }, 0 },
690 : { "COM.MICROSOFT.BAHTTEXT", "BAHTTEXT", 368, 368, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
691 : { 0, "THAIDAYOFWEEK", 369, 369, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
692 : { 0, "THAIDIGIT", 370, 370, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
693 : { 0, "THAIMONTHOFYEAR", 371, 371, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
694 : { 0, "THAINUMSOUND", 372, 372, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
695 : { 0, "THAINUMSTRING", 373, 373, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
696 : { 0, "THAISTRINGLENGTH", 374, 374, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
697 : { 0, "ISTHAIDIGIT", 375, 375, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
698 : { 0, "ROUNDBAHTDOWN", 376, 376, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
699 : { 0, "ROUNDBAHTUP", 377, 377, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
700 : { 0, "THAIYEAR", 378, 378, 1, 1, V, { VR }, FUNCFLAG_MACROCALL },
701 : { 0, "RTD", 379, 379, 3, 3, A, { VR, VR, RO }, 0 }
702 : };
703 :
704 : /** Functions new in OOXML. */
705 : static const FunctionData saFuncTableOox[] =
706 : {
707 : { 0, "CUBEVALUE", 380, NOID, 1, MX, V, { VR, RX }, 0 },
708 : { 0, "CUBEMEMBER", 381, NOID, 2, 3, V, { VR, RX, VR }, 0 },
709 : { 0, "CUBEMEMBERPROPERTY", 382, NOID, 3, 3, V, { VR }, 0 },
710 : { 0, "CUBERANKEDMEMBER", 383, NOID, 3, 4, V, { VR }, 0 },
711 : { 0, "CUBEKPIMEMBER", 477, NOID, 3, 4, V, { VR }, 0 },
712 : { 0, "CUBESET", 478, NOID, 2, 5, V, { VR, RX, VR }, 0 },
713 : { 0, "CUBESETCOUNT", 479, NOID, 1, 1, V, { VR }, 0 },
714 : { 0, "IFERROR", 480, NOID, 2, 2, V, { VO, RO }, 0 },
715 : { "COUNTIFS", "COUNTIFS", 481, NOID, 2, MX, V, { RO, VR }, FUNCFLAG_MACROCALL | FUNCFLAG_PARAMPAIRS },
716 : { "SUMIFS", "SUMIFS", 482, NOID, 3, MX, V, { RO, RO, VR }, FUNCFLAG_MACROCALL | FUNCFLAG_PARAMPAIRS },
717 : { "AVERAGEIF", "AVERAGEIF", 483, NOID, 2, 3, V, { RO, VR, RO }, FUNCFLAG_MACROCALL },
718 : { "AVERAGEIFS", "AVERAGEIFS", 484, NOID, 3, MX, V, { RO, RO, VR }, FUNCFLAG_MACROCALL | FUNCFLAG_PARAMPAIRS }
719 : };
720 :
721 : /** Functions defined by OpenFormula, but not supported by Calc or by Excel. */
722 : static const FunctionData saFuncTableOdf[] =
723 : {
724 : { "ARABIC", 0, NOID, NOID, 1, 1, V, { VR }, FUNCFLAG_MACROCALLODF },
725 : { "B", 0, NOID, NOID, 3, 4, V, { VR }, FUNCFLAG_MACROCALLODF },
726 : { "BASE", 0, NOID, NOID, 2, 3, V, { VR }, FUNCFLAG_MACROCALLODF },
727 : { "BITAND", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
728 : { "BITLSHIFT", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
729 : { "BITOR", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
730 : { "BITRSHIFT", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
731 : { "BITXOR", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
732 : { "CHISQDIST", 0, NOID, NOID, 2, 3, V, { VR }, FUNCFLAG_MACROCALLODF },
733 : { "CHISQINV", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
734 : { "COMBINA", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
735 : { "DAYS", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
736 : { "DECIMAL", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
737 : { "FDIST", 0, NOID, NOID, 3, 4, V, { VR }, FUNCFLAG_MACROCALLODF },
738 : { "FINV", 0, NOID, NOID, 3, 3, V, { VR }, FUNCFLAG_MACROCALLODF },
739 : { "FORMULA", 0, NOID, NOID, 1, 1, V, { RO }, FUNCFLAG_MACROCALLODF },
740 : { "GAMMA", 0, NOID, NOID, 1, 1, V, { VR }, FUNCFLAG_MACROCALLODF },
741 : { "GAUSS", 0, NOID, NOID, 1, 1, V, { VR }, FUNCFLAG_MACROCALLODF },
742 : { "IFNA", 0, NOID, NOID, 2, 2, V, { VR, RO }, FUNCFLAG_MACROCALLODF },
743 : { "ISFORMULA", 0, NOID, NOID, 1, 1, V, { RO }, FUNCFLAG_MACROCALLODF },
744 : { "ISOWEEKNUM", 0, NOID, NOID, 1, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
745 : { "MUNIT", 0, NOID, NOID, 1, 1, A, { VR }, FUNCFLAG_MACROCALLODF },
746 : { "NUMBERVALUE", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
747 : { "PDURATION", 0, NOID, NOID, 3, 3, V, { VR }, FUNCFLAG_MACROCALLODF },
748 : { "PERMUTATIONA", 0, NOID, NOID, 2, 2, V, { VR }, FUNCFLAG_MACROCALLODF },
749 : { "PHI", 0, NOID, NOID, 1, 1, V, { VR }, FUNCFLAG_MACROCALLODF },
750 : { "RRI", 0, NOID, NOID, 3, 3, V, { VR }, FUNCFLAG_MACROCALLODF },
751 : { "SHEET", 0, NOID, NOID, 0, 1, V, { RO }, FUNCFLAG_MACROCALLODF },
752 : { "SHEETS", 0, NOID, NOID, 0, 1, V, { RO }, FUNCFLAG_MACROCALLODF },
753 : { "SKEWP", 0, NOID, NOID, 1, MX, V, { RX }, FUNCFLAG_MACROCALLODF },
754 : { "UNICHAR", 0, NOID, NOID, 1, 1, V, { VR }, FUNCFLAG_MACROCALLODF },
755 : { "UNICODE", 0, NOID, NOID, 1, 1, V, { VR }, FUNCFLAG_MACROCALLODF },
756 : { "XOR", 0, NOID, NOID, 1, MX, V, { RX }, FUNCFLAG_MACROCALLODF }
757 : };
758 :
759 : // ----------------------------------------------------------------------------
760 :
761 : const sal_Unicode API_TOKEN_OPEN = '(';
762 : const sal_Unicode API_TOKEN_CLOSE = ')';
763 : const sal_Unicode API_TOKEN_SEP = ';';
764 :
765 : const sal_Unicode API_TOKEN_ARRAY_OPEN = '{';
766 : const sal_Unicode API_TOKEN_ARRAY_CLOSE = '}';
767 : const sal_Unicode API_TOKEN_ARRAY_ROWSEP = '|';
768 : const sal_Unicode API_TOKEN_ARRAY_COLSEP = ';';
769 :
770 : } // namespace
771 :
772 : // function info parameter class iterator =====================================
773 :
774 8 : FunctionParamInfoIterator::FunctionParamInfoIterator( const FunctionInfo& rFuncInfo ) :
775 : mpParamInfo( rFuncInfo.mpParamInfos ),
776 8 : mpParamInfoEnd( rFuncInfo.mpParamInfos + FUNCINFO_PARAMINFOCOUNT ),
777 16 : mbParamPairs( rFuncInfo.mbParamPairs )
778 : {
779 8 : }
780 :
781 35 : bool FunctionParamInfoIterator::isCalcOnlyParam() const
782 : {
783 35 : return mpParamInfo && (mpParamInfo->meValid == FUNC_PARAM_CALCONLY);
784 : }
785 :
786 27 : bool FunctionParamInfoIterator::isExcelOnlyParam() const
787 : {
788 27 : return mpParamInfo && (mpParamInfo->meValid == FUNC_PARAM_EXCELONLY);
789 : }
790 :
791 16 : FunctionParamInfoIterator& FunctionParamInfoIterator::operator++()
792 : {
793 16 : if( mpParamInfo )
794 : {
795 : // move pointer to next entry, if something explicit follows
796 16 : if( (mpParamInfo + 1 < mpParamInfoEnd) && (mpParamInfo[ 1 ].meValid != FUNC_PARAM_NONE) )
797 5 : ++mpParamInfo;
798 : // if last parameter type is 'Excel-only' or 'Calc-only', do not repeat it
799 11 : else if( isExcelOnlyParam() || isCalcOnlyParam() )
800 0 : mpParamInfo = 0;
801 : // points to last info, but parameter pairs expected, move to previous info
802 11 : else if( mbParamPairs )
803 0 : --mpParamInfo;
804 : // otherwise: repeat last parameter class
805 : }
806 16 : return *this;
807 : }
808 :
809 : // function provider ==========================================================
810 :
811 11 : struct FunctionProviderImpl
812 : {
813 : typedef RefMap< OUString, FunctionInfo > FuncNameMap;
814 : typedef RefMap< sal_uInt16, FunctionInfo > FuncIdMap;
815 :
816 : FunctionInfoVector maFuncs; /// All function infos in one list.
817 : FuncNameMap maOoxFuncs; /// Maps OOXML function names to function data.
818 : FuncIdMap maBiff12Funcs; /// Maps BIFF12 function indexes to function data.
819 : FuncIdMap maBiffFuncs; /// Maps BIFF2-BIFF8 function indexes to function data.
820 : FuncNameMap maMacroFuncs; /// Maps macro function names to function data.
821 :
822 : explicit FunctionProviderImpl( FilterType eFilter, BiffType eBiff, bool bImportFilter );
823 :
824 : private:
825 : /** Creates and inserts a function info struct from the passed function data. */
826 : void initFunc( const FunctionData& rFuncData, sal_uInt8 nMaxParam );
827 :
828 : /** Initializes the members from the passed function data list. */
829 : void initFuncs(
830 : const FunctionData* pBeg, const FunctionData* pEnd,
831 : sal_uInt8 nMaxParam, bool bImportFilter );
832 : };
833 :
834 : // ----------------------------------------------------------------------------
835 :
836 11 : FunctionProviderImpl::FunctionProviderImpl( FilterType eFilter, BiffType eBiff, bool bImportFilter )
837 : {
838 : OSL_ENSURE( bImportFilter, "FunctionProviderImpl::FunctionProviderImpl - need special handling for macro call functions" );
839 11 : sal_uInt8 nMaxParam = 0;
840 11 : switch( eFilter )
841 : {
842 : case FILTER_OOXML:
843 11 : nMaxParam = OOX_MAX_PARAMCOUNT;
844 11 : eBiff = BIFF8; // insert all BIFF function tables, then the OOXML table
845 11 : break;
846 : case FILTER_BIFF:
847 0 : nMaxParam = BIFF_MAX_PARAMCOUNT;
848 0 : break;
849 : case FILTER_UNKNOWN:
850 : OSL_FAIL( "FunctionProviderImpl::FunctionProviderImpl - invalid filter type" );
851 0 : break;
852 : }
853 : OSL_ENSURE( eBiff != BIFF_UNKNOWN, "FunctionProviderImpl::FunctionProviderImpl - invalid BIFF type" );
854 :
855 : /* Add functions supported in the current BIFF version only. Function
856 : tables from later BIFF versions may overwrite single functions from
857 : earlier tables. */
858 11 : if( eBiff >= BIFF2 )
859 11 : initFuncs( saFuncTableBiff2, STATIC_ARRAY_END( saFuncTableBiff2 ), nMaxParam, bImportFilter );
860 11 : if( eBiff >= BIFF3 )
861 11 : initFuncs( saFuncTableBiff3, STATIC_ARRAY_END( saFuncTableBiff3 ), nMaxParam, bImportFilter );
862 11 : if( eBiff >= BIFF4 )
863 11 : initFuncs( saFuncTableBiff4, STATIC_ARRAY_END( saFuncTableBiff4 ), nMaxParam, bImportFilter );
864 11 : if( eBiff >= BIFF5 )
865 11 : initFuncs( saFuncTableBiff5, STATIC_ARRAY_END( saFuncTableBiff5 ), nMaxParam, bImportFilter );
866 11 : if( eBiff >= BIFF8 )
867 11 : initFuncs( saFuncTableBiff8, STATIC_ARRAY_END( saFuncTableBiff8 ), nMaxParam, bImportFilter );
868 11 : initFuncs( saFuncTableOox, STATIC_ARRAY_END( saFuncTableOox ), nMaxParam, bImportFilter );
869 11 : initFuncs( saFuncTableOdf, STATIC_ARRAY_END( saFuncTableOdf ), nMaxParam, bImportFilter );
870 11 : }
871 :
872 4730 : void FunctionProviderImpl::initFunc( const FunctionData& rFuncData, sal_uInt8 nMaxParam )
873 : {
874 : // create a function info object
875 4730 : FunctionInfoRef xFuncInfo( new FunctionInfo );
876 4730 : if( rFuncData.mpcOdfFuncName )
877 4169 : xFuncInfo->maOdfFuncName = OUString::createFromAscii( rFuncData.mpcOdfFuncName );
878 4730 : if( rFuncData.mpcOoxFuncName )
879 4367 : xFuncInfo->maOoxFuncName = OUString::createFromAscii( rFuncData.mpcOoxFuncName );
880 :
881 4730 : if( getFlag( rFuncData.mnFlags, FUNCFLAG_MACROCALL ) )
882 : {
883 : OSL_ENSURE( !xFuncInfo->maOoxFuncName.isEmpty(), "FunctionProviderImpl::initFunc - missing OOXML function name" );
884 : OSL_ENSURE( !getFlag( rFuncData.mnFlags, FUNCFLAG_MACROCALLODF ), "FunctionProviderImpl::initFunc - unexpected flag FUNCFLAG_MACROCALLODF" );
885 165 : xFuncInfo->maBiffMacroName = "_xlfn." + xFuncInfo->maOoxFuncName;
886 : }
887 4565 : else if( getFlag( rFuncData.mnFlags, FUNCFLAG_MACROCALLODF ) )
888 : {
889 : OSL_ENSURE( !xFuncInfo->maOdfFuncName.isEmpty(), "FunctionProviderImpl::initFunc - missing ODF function name" );
890 363 : xFuncInfo->maBiffMacroName = "_xlfnodf." + xFuncInfo->maOdfFuncName;
891 : }
892 :
893 4730 : xFuncInfo->meFuncLibType = FUNCFLAGS_TO_FUNCLIB( rFuncData.mnFlags );
894 4730 : xFuncInfo->mnApiOpCode = -1;
895 4730 : xFuncInfo->mnBiff12FuncId = rFuncData.mnBiff12FuncId;
896 4730 : xFuncInfo->mnBiffFuncId = rFuncData.mnBiffFuncId;
897 4730 : xFuncInfo->mnMinParamCount = rFuncData.mnMinParamCount;
898 4730 : xFuncInfo->mnMaxParamCount = (rFuncData.mnMaxParamCount == MX) ? nMaxParam : rFuncData.mnMaxParamCount;
899 4730 : xFuncInfo->mnRetClass = rFuncData.mnRetClass;
900 4730 : xFuncInfo->mpParamInfos = rFuncData.mpParamInfos;
901 4730 : xFuncInfo->mbParamPairs = getFlag( rFuncData.mnFlags, FUNCFLAG_PARAMPAIRS );
902 4730 : xFuncInfo->mbVolatile = getFlag( rFuncData.mnFlags, FUNCFLAG_VOLATILE );
903 4730 : xFuncInfo->mbExternal = getFlag( rFuncData.mnFlags, FUNCFLAG_EXTERNAL );
904 4730 : bool bMacroCmd = getFlag( rFuncData.mnFlags, FUNCFLAG_MACROCMD );
905 4730 : xFuncInfo->mbMacroFunc = bMacroCmd || getFlag( rFuncData.mnFlags, FUNCFLAG_MACROFUNC );
906 4730 : xFuncInfo->mbVarParam = bMacroCmd || (rFuncData.mnMinParamCount != rFuncData.mnMaxParamCount) || getFlag( rFuncData.mnFlags, FUNCFLAG_ALWAYSVAR );
907 :
908 4730 : setFlag( xFuncInfo->mnBiff12FuncId, BIFF_TOK_FUNCVAR_CMD, bMacroCmd );
909 4730 : setFlag( xFuncInfo->mnBiffFuncId, BIFF_TOK_FUNCVAR_CMD, bMacroCmd );
910 :
911 : // insert the function info into the member maps
912 4730 : maFuncs.push_back( xFuncInfo );
913 4730 : if( !xFuncInfo->maOoxFuncName.isEmpty() )
914 4367 : maOoxFuncs[ xFuncInfo->maOoxFuncName ] = xFuncInfo;
915 4730 : if( xFuncInfo->mnBiff12FuncId != NOID )
916 4730 : maBiff12Funcs[ xFuncInfo->mnBiff12FuncId ] = xFuncInfo;
917 4730 : if( xFuncInfo->mnBiffFuncId != NOID )
918 4730 : maBiffFuncs[ xFuncInfo->mnBiffFuncId ] = xFuncInfo;
919 4730 : if( !xFuncInfo->maBiffMacroName.isEmpty() )
920 528 : maMacroFuncs[ xFuncInfo->maBiffMacroName ] = xFuncInfo;
921 4730 : }
922 :
923 77 : void FunctionProviderImpl::initFuncs( const FunctionData* pBeg, const FunctionData* pEnd, sal_uInt8 nMaxParam, bool bImportFilter )
924 : {
925 4906 : for( const FunctionData* pIt = pBeg; pIt != pEnd; ++pIt )
926 4829 : if( pIt->isSupported( bImportFilter ) )
927 4730 : initFunc( *pIt, nMaxParam );
928 77 : }
929 :
930 : // ----------------------------------------------------------------------------
931 :
932 11 : FunctionProvider::FunctionProvider( FilterType eFilter, BiffType eBiff, bool bImportFilter ) :
933 11 : mxFuncImpl( new FunctionProviderImpl( eFilter, eBiff, bImportFilter ) )
934 : {
935 11 : }
936 :
937 33 : FunctionProvider::~FunctionProvider()
938 : {
939 33 : }
940 :
941 2 : const FunctionInfo* FunctionProvider::getFuncInfoFromOoxFuncName( const OUString& rFuncName ) const
942 : {
943 2 : return mxFuncImpl->maOoxFuncs.get( rFuncName ).get();
944 : }
945 :
946 0 : const FunctionInfo* FunctionProvider::getFuncInfoFromBiff12FuncId( sal_uInt16 nFuncId ) const
947 : {
948 0 : return mxFuncImpl->maBiff12Funcs.get( nFuncId ).get();
949 : }
950 :
951 0 : const FunctionInfo* FunctionProvider::getFuncInfoFromBiffFuncId( sal_uInt16 nFuncId ) const
952 : {
953 0 : return mxFuncImpl->maBiffFuncs.get( nFuncId ).get();
954 : }
955 :
956 0 : const FunctionInfo* FunctionProvider::getFuncInfoFromMacroName( const OUString& rFuncName ) const
957 : {
958 0 : return mxFuncImpl->maMacroFuncs.get( rFuncName ).get();
959 : }
960 :
961 0 : FunctionLibraryType FunctionProvider::getFuncLibTypeFromLibraryName( const OUString& rLibraryName ) const
962 : {
963 : #define OOX_XLS_IS_LIBNAME( libname, basename ) (libname.equalsIgnoreAsciiCaseAscii( basename ".XLA" ) || libname.equalsIgnoreAsciiCaseAscii( basename ".XLAM" ))
964 :
965 : // the EUROTOOL add-in containing the EUROCONVERT function
966 0 : if( OOX_XLS_IS_LIBNAME( rLibraryName, "EUROTOOL" ) )
967 0 : return FUNCLIB_EUROTOOL;
968 :
969 : #undef OOX_XLS_IS_LIBNAME
970 :
971 : // default: unknown library
972 0 : return FUNCLIB_UNKNOWN;
973 : }
974 :
975 11 : const FunctionInfoVector& FunctionProvider::getFuncs() const
976 : {
977 11 : return mxFuncImpl->maFuncs;
978 : }
979 :
980 : // op-code and function provider ==============================================
981 :
982 11 : struct OpCodeProviderImpl : public ApiOpCodes
983 : {
984 : typedef RefMap< sal_Int32, FunctionInfo > OpCodeFuncMap;
985 : typedef RefMap< OUString, FunctionInfo > FuncNameMap;
986 : typedef ::std::vector< FormulaOpCodeMapEntry > OpCodeEntryVector;
987 :
988 : OpCodeFuncMap maOpCodeFuncs; /// Maps API function op-codes to function data.
989 : FuncNameMap maExtProgFuncs; /// Maps programmatical API function names to function data.
990 : OpCodeEntryVector maParserMap; /// OOXML token mapping for formula parser service.
991 :
992 : explicit OpCodeProviderImpl(
993 : const FunctionInfoVector& rFuncInfos,
994 : const Reference< XMultiServiceFactory >& rxModelFactory );
995 :
996 : private:
997 : typedef ::std::map< OUString, ApiToken > ApiTokenMap;
998 : typedef Sequence< FormulaOpCodeMapEntry > OpCodeEntrySequence;
999 :
1000 : static bool fillEntrySeq( OpCodeEntrySequence& orEntrySeq, const Reference< XFormulaOpCodeMapper >& rxMapper, sal_Int32 nMapGroup );
1001 : static bool fillTokenMap( ApiTokenMap& orTokenMap, OpCodeEntrySequence& orEntrySeq, const Reference< XFormulaOpCodeMapper >& rxMapper, sal_Int32 nMapGroup );
1002 : bool fillFuncTokenMaps( ApiTokenMap& orIntFuncTokenMap, ApiTokenMap& orExtFuncTokenMap, OpCodeEntrySequence& orEntrySeq, const Reference< XFormulaOpCodeMapper >& rxMapper ) const;
1003 :
1004 : static bool initOpCode( sal_Int32& ornOpCode, const OpCodeEntrySequence& rEntrySeq, sal_Int32 nSpecialId );
1005 : bool initOpCode( sal_Int32& ornOpCode, const ApiTokenMap& rTokenMap, const OUString& rOdfName, const OUString& rOoxName );
1006 : bool initOpCode( sal_Int32& ornOpCode, const ApiTokenMap& rTokenMap, const sal_Char* pcOdfName, const sal_Char* pcOoxName );
1007 : bool initOpCode( sal_Int32& ornOpCode, const ApiTokenMap& rTokenMap, sal_Unicode cOdfName, sal_Unicode cOoxName );
1008 :
1009 : bool initFuncOpCode( FunctionInfo& orFuncInfo, const ApiTokenMap& rFuncTokenMap );
1010 : bool initFuncOpCodes( const ApiTokenMap& rIntFuncTokenMap, const ApiTokenMap& rExtFuncTokenMap, const FunctionInfoVector& rFuncInfos );
1011 : };
1012 :
1013 : // ----------------------------------------------------------------------------
1014 :
1015 11 : OpCodeProviderImpl::OpCodeProviderImpl( const FunctionInfoVector& rFuncInfos,
1016 11 : const Reference< XMultiServiceFactory >& rxModelFactory )
1017 : {
1018 11 : if( rxModelFactory.is() ) try
1019 : {
1020 11 : Reference< XFormulaOpCodeMapper > xMapper( rxModelFactory->createInstance(
1021 11 : "com.sun.star.sheet.FormulaOpCodeMapper" ), UNO_QUERY_THROW );
1022 :
1023 : // op-codes provided as attributes
1024 11 : OPCODE_UNKNOWN = xMapper->getOpCodeUnknown();
1025 11 : OPCODE_EXTERNAL = xMapper->getOpCodeExternal();
1026 :
1027 : using namespace ::com::sun::star::sheet::FormulaMapGroup;
1028 : using namespace ::com::sun::star::sheet::FormulaMapGroupSpecialOffset;
1029 :
1030 11 : OpCodeEntrySequence aEntrySeq;
1031 11 : ApiTokenMap aTokenMap, aExtFuncTokenMap;
1032 : bool bIsValid =
1033 : // special
1034 11 : fillEntrySeq( aEntrySeq, xMapper, SPECIAL ) &&
1035 11 : initOpCode( OPCODE_PUSH, aEntrySeq, PUSH ) &&
1036 11 : initOpCode( OPCODE_MISSING, aEntrySeq, MISSING ) &&
1037 11 : initOpCode( OPCODE_SPACES, aEntrySeq, SPACES ) &&
1038 11 : initOpCode( OPCODE_NAME, aEntrySeq, NAME ) &&
1039 11 : initOpCode( OPCODE_DBAREA, aEntrySeq, DB_AREA ) &&
1040 11 : initOpCode( OPCODE_NLR, aEntrySeq, COL_ROW_NAME ) &&
1041 11 : initOpCode( OPCODE_MACRO, aEntrySeq, MACRO ) &&
1042 11 : initOpCode( OPCODE_BAD, aEntrySeq, BAD ) &&
1043 11 : initOpCode( OPCODE_NONAME, aEntrySeq, NO_NAME ) &&
1044 : // separators
1045 11 : fillTokenMap( aTokenMap, aEntrySeq, xMapper, SEPARATORS ) &&
1046 11 : initOpCode( OPCODE_OPEN, aTokenMap, API_TOKEN_OPEN, '(' ) &&
1047 11 : initOpCode( OPCODE_CLOSE, aTokenMap, API_TOKEN_CLOSE, ')' ) &&
1048 11 : initOpCode( OPCODE_SEP, aTokenMap, API_TOKEN_SEP, ',' ) &&
1049 : // array separators
1050 11 : fillTokenMap( aTokenMap, aEntrySeq, xMapper, ARRAY_SEPARATORS ) &&
1051 11 : initOpCode( OPCODE_ARRAY_OPEN, aTokenMap, API_TOKEN_ARRAY_OPEN, '{' ) &&
1052 11 : initOpCode( OPCODE_ARRAY_CLOSE, aTokenMap, API_TOKEN_ARRAY_CLOSE, '}' ) &&
1053 11 : initOpCode( OPCODE_ARRAY_ROWSEP, aTokenMap, API_TOKEN_ARRAY_ROWSEP, ';' ) &&
1054 11 : initOpCode( OPCODE_ARRAY_COLSEP, aTokenMap, API_TOKEN_ARRAY_COLSEP, ',' ) &&
1055 : // unary operators
1056 11 : fillTokenMap( aTokenMap, aEntrySeq, xMapper, UNARY_OPERATORS ) &&
1057 11 : initOpCode( OPCODE_PLUS_SIGN, aTokenMap, '+', '\0' ) && // same op-code as OPCODE_ADD
1058 11 : initOpCode( OPCODE_MINUS_SIGN, aTokenMap, '-', '-' ) &&
1059 11 : initOpCode( OPCODE_PERCENT, aTokenMap, '%', '%' ) &&
1060 : // binary operators
1061 11 : fillTokenMap( aTokenMap, aEntrySeq, xMapper, BINARY_OPERATORS ) &&
1062 11 : initOpCode( OPCODE_ADD, aTokenMap, '+', '+' ) &&
1063 11 : initOpCode( OPCODE_SUB, aTokenMap, '-', '-' ) &&
1064 11 : initOpCode( OPCODE_MULT, aTokenMap, '*', '*' ) &&
1065 11 : initOpCode( OPCODE_DIV, aTokenMap, '/', '/' ) &&
1066 11 : initOpCode( OPCODE_POWER, aTokenMap, '^', '^' ) &&
1067 11 : initOpCode( OPCODE_CONCAT, aTokenMap, '&', '&' ) &&
1068 11 : initOpCode( OPCODE_EQUAL, aTokenMap, '=', '=' ) &&
1069 11 : initOpCode( OPCODE_NOT_EQUAL, aTokenMap, "<>", "<>" ) &&
1070 11 : initOpCode( OPCODE_LESS, aTokenMap, '<', '<' ) &&
1071 11 : initOpCode( OPCODE_LESS_EQUAL, aTokenMap, "<=", "<=" ) &&
1072 11 : initOpCode( OPCODE_GREATER, aTokenMap, '>', '>' ) &&
1073 11 : initOpCode( OPCODE_GREATER_EQUAL, aTokenMap, ">=", ">=" ) &&
1074 11 : initOpCode( OPCODE_INTERSECT, aTokenMap, '!', ' ' ) &&
1075 11 : initOpCode( OPCODE_LIST, aTokenMap, '~', ',' ) &&
1076 11 : initOpCode( OPCODE_RANGE, aTokenMap, ':', ':' ) &&
1077 : // functions
1078 11 : fillFuncTokenMaps( aTokenMap, aExtFuncTokenMap, aEntrySeq, xMapper ) &&
1079 11 : initFuncOpCodes( aTokenMap, aExtFuncTokenMap, rFuncInfos ) &&
1080 451 : initOpCode( OPCODE_DDE, aTokenMap, "DDE", 0 );
1081 :
1082 : OSL_ENSURE( bIsValid, "OpCodeProviderImpl::OpCodeProviderImpl - opcodes not initialized" );
1083 : (void)bIsValid;
1084 :
1085 : // OPCODE_PLUS_SIGN and OPCODE_ADD should be equal, otherwise "+" has to be passed above
1086 11 : OSL_ENSURE( OPCODE_PLUS_SIGN == OPCODE_ADD, "OpCodeProviderImpl::OpCodeProviderImpl - need opcode mapping for OPCODE_PLUS_SIGN" );
1087 : }
1088 0 : catch( Exception& )
1089 : {
1090 : OSL_FAIL( "OpCodeProviderImpl::OpCodeProviderImpl - cannot receive formula opcode mapper" );
1091 : }
1092 11 : }
1093 :
1094 66 : bool OpCodeProviderImpl::fillEntrySeq( OpCodeEntrySequence& orEntrySeq,
1095 : const Reference< XFormulaOpCodeMapper >& rxMapper, sal_Int32 nMapGroup )
1096 : {
1097 : try
1098 : {
1099 66 : orEntrySeq = rxMapper->getAvailableMappings( ::com::sun::star::sheet::FormulaLanguage::ODFF, nMapGroup );
1100 66 : return orEntrySeq.hasElements();
1101 : }
1102 0 : catch( Exception& )
1103 : {
1104 : }
1105 0 : return false;
1106 : }
1107 :
1108 44 : bool OpCodeProviderImpl::fillTokenMap( ApiTokenMap& orTokenMap, OpCodeEntrySequence& orEntrySeq,
1109 : const Reference< XFormulaOpCodeMapper >& rxMapper, sal_Int32 nMapGroup )
1110 : {
1111 44 : orTokenMap.clear();
1112 44 : if( fillEntrySeq( orEntrySeq, rxMapper, nMapGroup ) )
1113 : {
1114 44 : const FormulaOpCodeMapEntry* pEntry = orEntrySeq.getConstArray();
1115 44 : const FormulaOpCodeMapEntry* pEntryEnd = pEntry + orEntrySeq.getLength();
1116 319 : for( ; pEntry != pEntryEnd; ++pEntry )
1117 275 : orTokenMap[ pEntry->Name ] = pEntry->Token;
1118 : }
1119 44 : return orEntrySeq.hasElements();
1120 : }
1121 :
1122 11 : bool OpCodeProviderImpl::fillFuncTokenMaps( ApiTokenMap& orIntFuncTokenMap, ApiTokenMap& orExtFuncTokenMap, OpCodeEntrySequence& orEntrySeq, const Reference< XFormulaOpCodeMapper >& rxMapper ) const
1123 : {
1124 11 : orIntFuncTokenMap.clear();
1125 11 : orExtFuncTokenMap.clear();
1126 11 : if( fillEntrySeq( orEntrySeq, rxMapper, ::com::sun::star::sheet::FormulaMapGroup::FUNCTIONS ) )
1127 : {
1128 11 : const FormulaOpCodeMapEntry* pEntry = orEntrySeq.getConstArray();
1129 11 : const FormulaOpCodeMapEntry* pEntryEnd = pEntry + orEntrySeq.getLength();
1130 4510 : for( ; pEntry != pEntryEnd; ++pEntry )
1131 4499 : ((pEntry->Token.OpCode == OPCODE_EXTERNAL) ? orExtFuncTokenMap : orIntFuncTokenMap)[ pEntry->Name ] = pEntry->Token;
1132 : }
1133 11 : return orEntrySeq.hasElements();
1134 : }
1135 :
1136 99 : bool OpCodeProviderImpl::initOpCode( sal_Int32& ornOpCode, const OpCodeEntrySequence& rEntrySeq, sal_Int32 nSpecialId )
1137 : {
1138 99 : if( (0 <= nSpecialId) && (nSpecialId < rEntrySeq.getLength()) )
1139 : {
1140 99 : ornOpCode = rEntrySeq[ nSpecialId ].Token.OpCode;
1141 99 : return true;
1142 : }
1143 : OSL_FAIL( OStringBuffer( "OpCodeProviderImpl::initOpCode - opcode for special offset " ).
1144 : append( nSpecialId ).append( " not found" ).getStr() );
1145 0 : return false;
1146 : }
1147 :
1148 275 : bool OpCodeProviderImpl::initOpCode( sal_Int32& ornOpCode, const ApiTokenMap& rTokenMap, const OUString& rOdfName, const OUString& rOoxName )
1149 : {
1150 275 : ApiTokenMap::const_iterator aIt = rTokenMap.find( rOdfName );
1151 275 : if( aIt != rTokenMap.end() )
1152 : {
1153 275 : ornOpCode = aIt->second.OpCode;
1154 275 : if( !rOoxName.isEmpty() )
1155 : {
1156 264 : FormulaOpCodeMapEntry aEntry;
1157 264 : aEntry.Name = rOoxName;
1158 264 : aEntry.Token.OpCode = ornOpCode;
1159 264 : maParserMap.push_back( aEntry );
1160 : }
1161 275 : return true;
1162 : }
1163 : OSL_FAIL( OStringBuffer( "OpCodeProviderImpl::initOpCode - opcode for \"" ).
1164 : append( OUStringToOString( rOdfName, RTL_TEXTENCODING_ASCII_US ) ).
1165 : append( "\" not found" ).getStr() );
1166 0 : return false;
1167 : }
1168 :
1169 33 : bool OpCodeProviderImpl::initOpCode( sal_Int32& ornOpCode, const ApiTokenMap& rTokenMap, const sal_Char* pcOdfName, const sal_Char* pcOoxName )
1170 : {
1171 33 : OUString aOoxName;
1172 33 : if( pcOoxName ) aOoxName = OUString::createFromAscii( pcOoxName );
1173 33 : return initOpCode( ornOpCode, rTokenMap, OUString::createFromAscii( pcOdfName ), aOoxName );
1174 : }
1175 :
1176 242 : bool OpCodeProviderImpl::initOpCode( sal_Int32& ornOpCode, const ApiTokenMap& rTokenMap, sal_Unicode cOdfName, sal_Unicode cOoxName )
1177 : {
1178 242 : OUString aOoxName;
1179 242 : if( cOoxName ) aOoxName = OUString( cOoxName );
1180 242 : return initOpCode( ornOpCode, rTokenMap, OUString( cOdfName ), aOoxName );
1181 : }
1182 :
1183 4730 : bool OpCodeProviderImpl::initFuncOpCode( FunctionInfo& orFuncInfo, const ApiTokenMap& rFuncTokenMap )
1184 : {
1185 4730 : bool bIsValid = false;
1186 4730 : if( !orFuncInfo.maOdfFuncName.isEmpty() )
1187 : {
1188 4169 : ApiTokenMap::const_iterator aIt = rFuncTokenMap.find( orFuncInfo.maOdfFuncName );
1189 4169 : if( aIt != rFuncTokenMap.end() )
1190 : {
1191 4092 : orFuncInfo.mnApiOpCode = aIt->second.OpCode;
1192 : bIsValid =
1193 : (orFuncInfo.mnApiOpCode >= 0) &&
1194 : (orFuncInfo.mnApiOpCode != OPCODE_UNKNOWN) &&
1195 4092 : (orFuncInfo.mnApiOpCode != OPCODE_NONAME);
1196 : OSL_ENSURE( bIsValid,
1197 : OStringBuffer( "OpCodeProviderImpl::initFuncOpCode - no valid opcode for ODF function \"" ).
1198 : append( OUStringToOString( orFuncInfo.maOdfFuncName, RTL_TEXTENCODING_ASCII_US ) ).
1199 : append( '"' ).getStr() );
1200 :
1201 4092 : if( bIsValid && (orFuncInfo.mnApiOpCode == OPCODE_EXTERNAL) )
1202 : {
1203 1023 : bIsValid = (aIt->second.Data >>= orFuncInfo.maExtProgName) && !orFuncInfo.maExtProgName.isEmpty();
1204 : OSL_ENSURE( bIsValid,
1205 : OStringBuffer( "OpCodeProviderImpl::initFuncOpCode - no programmatical name for external function \"" ).
1206 : append( OUStringToOString( orFuncInfo.maOdfFuncName, RTL_TEXTENCODING_ASCII_US ) ).
1207 : append( '"' ).getStr() );
1208 : }
1209 :
1210 : // add to parser map, if OOXML function name exists
1211 4092 : if( bIsValid && !orFuncInfo.maOoxFuncName.isEmpty() )
1212 : {
1213 : // create the parser map entry
1214 3795 : FormulaOpCodeMapEntry aEntry;
1215 3795 : aEntry.Name = orFuncInfo.maOoxFuncName;
1216 3795 : aEntry.Token = aIt->second;
1217 3795 : maParserMap.push_back( aEntry );
1218 : }
1219 : }
1220 : else
1221 : {
1222 : // ignore entries for functions unknown by Calc *and* by Excel
1223 77 : bIsValid = orFuncInfo.maOoxFuncName.isEmpty();
1224 : }
1225 : }
1226 561 : else if( orFuncInfo.mnBiffFuncId == BIFF_FUNC_EXTERNCALL )
1227 : {
1228 11 : orFuncInfo.mnApiOpCode = OPCODE_EXTERNAL;
1229 11 : bIsValid = true;
1230 : }
1231 550 : else if( !orFuncInfo.maOoxFuncName.isEmpty() )
1232 : {
1233 550 : orFuncInfo.mnApiOpCode = OPCODE_BAD;
1234 550 : bIsValid = true;
1235 : }
1236 :
1237 4730 : if( !bIsValid || (orFuncInfo.mnApiOpCode == OPCODE_UNKNOWN) || (orFuncInfo.mnApiOpCode < 0) )
1238 77 : orFuncInfo.mnApiOpCode = OPCODE_NONAME;
1239 4730 : return bIsValid;
1240 : }
1241 :
1242 11 : bool OpCodeProviderImpl::initFuncOpCodes( const ApiTokenMap& rIntFuncTokenMap, const ApiTokenMap& rExtFuncTokenMap, const FunctionInfoVector& rFuncInfos )
1243 : {
1244 11 : bool bIsValid = true;
1245 4741 : for( FunctionInfoVector::const_iterator aIt = rFuncInfos.begin(), aEnd = rFuncInfos.end(); aIt != aEnd; ++aIt )
1246 : {
1247 4730 : FunctionInfoRef xFuncInfo = *aIt;
1248 : // set API opcode from ODF function name
1249 4730 : bIsValid &= initFuncOpCode( *xFuncInfo, xFuncInfo->mbExternal ? rExtFuncTokenMap : rIntFuncTokenMap );
1250 : // insert the function info into the maps
1251 4730 : if( (xFuncInfo->mnApiOpCode != OPCODE_NONAME) && (xFuncInfo->mnApiOpCode != OPCODE_BAD) )
1252 : {
1253 4103 : if( (xFuncInfo->mnApiOpCode == OPCODE_EXTERNAL) && !xFuncInfo->maExtProgName.isEmpty() )
1254 1023 : maExtProgFuncs[ xFuncInfo->maExtProgName ] = xFuncInfo;
1255 : else
1256 3080 : maOpCodeFuncs[ xFuncInfo->mnApiOpCode ] = xFuncInfo;
1257 : }
1258 4730 : }
1259 11 : return bIsValid;
1260 : }
1261 :
1262 : // ----------------------------------------------------------------------------
1263 :
1264 11 : OpCodeProvider::OpCodeProvider( const Reference< XMultiServiceFactory >& rxModelFactory,
1265 : FilterType eFilter, BiffType eBiff, bool bImportFilter ) :
1266 : FunctionProvider( eFilter, eBiff, bImportFilter ),
1267 11 : mxOpCodeImpl( new OpCodeProviderImpl( getFuncs(), rxModelFactory ) )
1268 : {
1269 11 : }
1270 :
1271 33 : OpCodeProvider::~OpCodeProvider()
1272 : {
1273 33 : }
1274 :
1275 22 : const ApiOpCodes& OpCodeProvider::getOpCodes() const
1276 : {
1277 22 : return *mxOpCodeImpl;
1278 : }
1279 :
1280 90 : const FunctionInfo* OpCodeProvider::getFuncInfoFromApiToken( const ApiToken& rToken ) const
1281 : {
1282 90 : const FunctionInfo* pFuncInfo = 0;
1283 90 : if( (rToken.OpCode == mxOpCodeImpl->OPCODE_EXTERNAL) && rToken.Data.has< OUString >() )
1284 0 : pFuncInfo = mxOpCodeImpl->maExtProgFuncs.get( rToken.Data.get< OUString >() ).get();
1285 90 : else if( (rToken.OpCode == mxOpCodeImpl->OPCODE_MACRO) && rToken.Data.has< OUString >() )
1286 0 : pFuncInfo = getFuncInfoFromMacroName( rToken.Data.get< OUString >() );
1287 90 : else if( (rToken.OpCode == mxOpCodeImpl->OPCODE_BAD) && rToken.Data.has< OUString >() )
1288 2 : pFuncInfo = getFuncInfoFromOoxFuncName( rToken.Data.get< OUString >() );
1289 : else
1290 88 : pFuncInfo = mxOpCodeImpl->maOpCodeFuncs.get( rToken.OpCode ).get();
1291 90 : return pFuncInfo;
1292 : }
1293 :
1294 11 : Sequence< FormulaOpCodeMapEntry > OpCodeProvider::getOoxParserMap() const
1295 : {
1296 11 : return ContainerHelper::vectorToSequence( mxOpCodeImpl->maParserMap );
1297 : }
1298 :
1299 : // API formula parser wrapper =================================================
1300 :
1301 11 : ApiParserWrapper::ApiParserWrapper(
1302 : const Reference< XMultiServiceFactory >& rxModelFactory, const OpCodeProvider& rOpCodeProv ) :
1303 11 : OpCodeProvider( rOpCodeProv )
1304 : {
1305 11 : if( rxModelFactory.is() ) try
1306 : {
1307 11 : mxParser.set( rxModelFactory->createInstance( "com.sun.star.sheet.FormulaParser" ), UNO_QUERY_THROW );
1308 : }
1309 0 : catch( Exception& )
1310 : {
1311 : }
1312 : OSL_ENSURE( mxParser.is(), "ApiParserWrapper::ApiParserWrapper - cannot create API formula parser object" );
1313 11 : maParserProps.set( mxParser );
1314 11 : maParserProps.setProperty( PROP_CompileEnglish, true );
1315 11 : maParserProps.setProperty( PROP_FormulaConvention, ::com::sun::star::sheet::AddressConvention::XL_OOX );
1316 11 : maParserProps.setProperty( PROP_IgnoreLeadingSpaces, false );
1317 11 : maParserProps.setProperty( PROP_OpCodeMap, getOoxParserMap() );
1318 11 : }
1319 :
1320 58 : ApiTokenSequence ApiParserWrapper::parseFormula( const OUString& rFormula, const CellAddress& rRefPos )
1321 : {
1322 58 : ApiTokenSequence aTokenSeq;
1323 58 : if( mxParser.is() ) try
1324 : {
1325 58 : aTokenSeq = mxParser->parseFormula( rFormula, rRefPos );
1326 : }
1327 0 : catch( Exception& )
1328 : {
1329 : }
1330 58 : return aTokenSeq;
1331 : }
1332 :
1333 : // formula parser/printer base class for filters ==============================
1334 :
1335 : namespace {
1336 :
1337 0 : bool lclConvertToCellAddress( CellAddress& orAddress, const SingleReference& rSingleRef, sal_Int32 nForbiddenFlags, sal_Int32 nFilterBySheet )
1338 : {
1339 : orAddress = CellAddress( static_cast< sal_Int16 >( rSingleRef.Sheet ),
1340 0 : rSingleRef.Column, rSingleRef.Row );
1341 : return
1342 0 : !getFlag( rSingleRef.Flags, nForbiddenFlags ) &&
1343 0 : ((nFilterBySheet < 0) || (nFilterBySheet == rSingleRef.Sheet));
1344 : }
1345 :
1346 1 : bool lclConvertToCellRange( CellRangeAddress& orRange, const ComplexReference& rComplexRef, sal_Int32 nForbiddenFlags, sal_Int32 nFilterBySheet )
1347 : {
1348 : orRange = CellRangeAddress( static_cast< sal_Int16 >( rComplexRef.Reference1.Sheet ),
1349 : rComplexRef.Reference1.Column, rComplexRef.Reference1.Row,
1350 1 : rComplexRef.Reference2.Column, rComplexRef.Reference2.Row );
1351 : return
1352 1 : !getFlag( rComplexRef.Reference1.Flags, nForbiddenFlags ) &&
1353 1 : !getFlag( rComplexRef.Reference2.Flags, nForbiddenFlags ) &&
1354 : (rComplexRef.Reference1.Sheet == rComplexRef.Reference2.Sheet) &&
1355 2 : ((nFilterBySheet < 0) || (nFilterBySheet == rComplexRef.Reference1.Sheet));
1356 : }
1357 :
1358 : enum TokenToRangeListState { STATE_REF, STATE_SEP, STATE_OPEN, STATE_CLOSE, STATE_ERROR };
1359 :
1360 1 : TokenToRangeListState lclProcessRef( ApiCellRangeList& orRanges, const Any& rData, bool bAllowRelative, sal_Int32 nFilterBySheet )
1361 : {
1362 : using namespace ::com::sun::star::sheet::ReferenceFlags;
1363 1 : const sal_Int32 FORBIDDEN_FLAGS_DEL = COLUMN_DELETED | ROW_DELETED | SHEET_DELETED;
1364 1 : const sal_Int32 FORBIDDEN_FLAGS_REL = FORBIDDEN_FLAGS_DEL | COLUMN_RELATIVE | ROW_RELATIVE | SHEET_RELATIVE | RELATIVE_NAME;
1365 :
1366 1 : sal_Int32 nForbiddenFlags = bAllowRelative ? FORBIDDEN_FLAGS_DEL : FORBIDDEN_FLAGS_REL;
1367 1 : SingleReference aSingleRef;
1368 1 : if( rData >>= aSingleRef )
1369 : {
1370 0 : CellAddress aAddress;
1371 : // ignore invalid addresses (with #REF! errors), but do not stop parsing
1372 0 : if( lclConvertToCellAddress( aAddress, aSingleRef, nForbiddenFlags, nFilterBySheet ) )
1373 0 : orRanges.push_back( CellRangeAddress( aAddress.Sheet, aAddress.Column, aAddress.Row, aAddress.Column, aAddress.Row ) );
1374 0 : return STATE_REF;
1375 : }
1376 1 : ComplexReference aComplexRef;
1377 1 : if( rData >>= aComplexRef )
1378 : {
1379 1 : CellRangeAddress aRange;
1380 : // ignore invalid ranges (with #REF! errors), but do not stop parsing
1381 1 : if( lclConvertToCellRange( aRange, aComplexRef, nForbiddenFlags, nFilterBySheet ) )
1382 1 : orRanges.push_back( aRange );
1383 1 : return STATE_REF;
1384 : }
1385 0 : return STATE_ERROR;
1386 : }
1387 :
1388 0 : TokenToRangeListState lclProcessOpen( sal_Int32& ornParenLevel )
1389 : {
1390 0 : ++ornParenLevel;
1391 0 : return STATE_OPEN;
1392 : }
1393 :
1394 0 : TokenToRangeListState lclProcessClose( sal_Int32& ornParenLevel )
1395 : {
1396 0 : --ornParenLevel;
1397 0 : return (ornParenLevel >= 0) ? STATE_CLOSE : STATE_ERROR;
1398 : }
1399 :
1400 : } // namespace
1401 :
1402 : // ----------------------------------------------------------------------------
1403 :
1404 11 : FormulaProcessorBase::FormulaProcessorBase( const WorkbookHelper& rHelper ) :
1405 22 : OpCodeProvider( rHelper.getBaseFilter().getModelFactory(), rHelper.getFilterType(), rHelper.getBiff(), rHelper.getBaseFilter().isImportFilter() ),
1406 11 : ApiOpCodes( getOpCodes() ),
1407 33 : WorkbookHelper( rHelper )
1408 : {
1409 11 : }
1410 :
1411 : // ----------------------------------------------------------------------------
1412 :
1413 0 : OUString FormulaProcessorBase::generateAddress2dString( const CellAddress& rAddress, bool bAbsolute )
1414 : {
1415 0 : return generateAddress2dString( BinAddress( rAddress ), bAbsolute );
1416 : }
1417 :
1418 0 : OUString FormulaProcessorBase::generateAddress2dString( const BinAddress& rAddress, bool bAbsolute )
1419 : {
1420 0 : OUStringBuffer aBuffer;
1421 : // column
1422 0 : for( sal_Int32 nTemp = rAddress.mnCol; nTemp >= 0; (nTemp /= 26) -= 1 )
1423 0 : aBuffer.insert( 0, sal_Unicode( 'A' + (nTemp % 26) ) );
1424 0 : if( bAbsolute )
1425 0 : aBuffer.insert( 0, sal_Unicode( '$' ) );
1426 : // row
1427 0 : if( bAbsolute )
1428 0 : aBuffer.append( sal_Unicode( '$' ) );
1429 0 : aBuffer.append( static_cast< sal_Int32 >( rAddress.mnRow + 1 ) );
1430 0 : return aBuffer.makeStringAndClear();
1431 : }
1432 :
1433 : // ----------------------------------------------------------------------------
1434 :
1435 0 : OUString FormulaProcessorBase::generateApiString( const OUString& rString )
1436 : {
1437 0 : OUString aRetString = rString;
1438 0 : sal_Int32 nQuotePos = aRetString.getLength();
1439 0 : while( (nQuotePos = aRetString.lastIndexOf( '"', nQuotePos )) >= 0 )
1440 0 : aRetString = aRetString.replaceAt( nQuotePos, 1, OUString( "\"\"" ) );
1441 0 : return OUStringBuffer().append( sal_Unicode( '"' ) ).append( aRetString ).append( sal_Unicode( '"' ) ).makeStringAndClear();
1442 : }
1443 :
1444 0 : OUString FormulaProcessorBase::generateApiArray( const Matrix< Any >& rMatrix )
1445 : {
1446 : OSL_ENSURE( !rMatrix.empty(), "FormulaProcessorBase::generateApiArray - missing matrix values" );
1447 0 : OUStringBuffer aBuffer;
1448 0 : aBuffer.append( API_TOKEN_ARRAY_OPEN );
1449 0 : for( size_t nRow = 0, nHeight = rMatrix.height(); nRow < nHeight; ++nRow )
1450 : {
1451 0 : if( nRow > 0 )
1452 0 : aBuffer.append( API_TOKEN_ARRAY_ROWSEP );
1453 0 : for( Matrix< Any >::const_iterator aBeg = rMatrix.row_begin( nRow ), aIt = aBeg, aEnd = rMatrix.row_end( nRow ); aIt != aEnd; ++aIt )
1454 : {
1455 0 : double fValue = 0.0;
1456 0 : OUString aString;
1457 0 : if( aIt != aBeg )
1458 0 : aBuffer.append( API_TOKEN_ARRAY_COLSEP );
1459 0 : if( *aIt >>= fValue )
1460 0 : aBuffer.append( fValue );
1461 0 : else if( *aIt >>= aString )
1462 0 : aBuffer.append( generateApiString( aString ) );
1463 : else
1464 0 : aBuffer.appendAscii( "\"\"" );
1465 0 : }
1466 : }
1467 0 : aBuffer.append( API_TOKEN_ARRAY_CLOSE );
1468 0 : return aBuffer.makeStringAndClear();
1469 : }
1470 :
1471 : // ----------------------------------------------------------------------------
1472 :
1473 1 : Any FormulaProcessorBase::extractReference( const ApiTokenSequence& rTokens ) const
1474 : {
1475 1 : ApiTokenIterator aTokenIt( rTokens, OPCODE_SPACES, true );
1476 1 : if( aTokenIt.is() && (aTokenIt->OpCode == OPCODE_PUSH) )
1477 : {
1478 1 : Any aRefAny = aTokenIt->Data;
1479 1 : if( !(++aTokenIt).is() && (aRefAny.has< SingleReference >() || aRefAny.has< ComplexReference >()) )
1480 1 : return aRefAny;
1481 : }
1482 0 : return Any();
1483 : }
1484 :
1485 1 : bool FormulaProcessorBase::extractCellRange( CellRangeAddress& orRange,
1486 : const ApiTokenSequence& rTokens, bool bAllowRelative ) const
1487 : {
1488 1 : ApiCellRangeList aRanges;
1489 1 : lclProcessRef( aRanges, extractReference( rTokens ), bAllowRelative, -1 );
1490 1 : if( !aRanges.empty() )
1491 : {
1492 1 : orRange = aRanges.front();
1493 1 : return true;
1494 : }
1495 0 : return false;
1496 : }
1497 :
1498 0 : void FormulaProcessorBase::extractCellRangeList( ApiCellRangeList& orRanges,
1499 : const ApiTokenSequence& rTokens, bool bAllowRelative, sal_Int32 nFilterBySheet ) const
1500 : {
1501 0 : orRanges.clear();
1502 0 : TokenToRangeListState eState = STATE_OPEN;
1503 0 : sal_Int32 nParenLevel = 0;
1504 0 : for( ApiTokenIterator aIt( rTokens, OPCODE_SPACES, true ); aIt.is() && (eState != STATE_ERROR); ++aIt )
1505 : {
1506 0 : sal_Int32 nOpCode = aIt->OpCode;
1507 0 : switch( eState )
1508 : {
1509 : // #i107275# accept OPCODE_SEP and OPCODE_LIST as separator token
1510 : case STATE_REF:
1511 0 : if( nOpCode == OPCODE_SEP ) eState = STATE_SEP;
1512 0 : else if( nOpCode == OPCODE_LIST ) eState = STATE_SEP;
1513 0 : else if( nOpCode == OPCODE_CLOSE ) eState = lclProcessClose( nParenLevel );
1514 0 : else eState = STATE_ERROR;
1515 0 : break;
1516 : case STATE_SEP:
1517 0 : if( nOpCode == OPCODE_PUSH ) eState = lclProcessRef( orRanges, aIt->Data, bAllowRelative, nFilterBySheet );
1518 0 : else if( nOpCode == OPCODE_SEP ) eState = STATE_SEP;
1519 0 : else if( nOpCode == OPCODE_LIST ) eState = STATE_SEP;
1520 0 : else if( nOpCode == OPCODE_OPEN ) eState = lclProcessOpen( nParenLevel );
1521 0 : else if( nOpCode == OPCODE_CLOSE ) eState = lclProcessClose( nParenLevel );
1522 0 : else eState = STATE_ERROR;
1523 0 : break;
1524 : case STATE_OPEN:
1525 0 : if( nOpCode == OPCODE_PUSH ) eState = lclProcessRef( orRanges, aIt->Data, bAllowRelative, nFilterBySheet );
1526 0 : else if( nOpCode == OPCODE_SEP ) eState = STATE_SEP;
1527 0 : else if( nOpCode == OPCODE_LIST ) eState = STATE_SEP;
1528 0 : else if( nOpCode == OPCODE_OPEN ) eState = lclProcessOpen( nParenLevel );
1529 0 : else if( nOpCode == OPCODE_CLOSE ) eState = lclProcessClose( nParenLevel );
1530 0 : else eState = STATE_ERROR;
1531 0 : break;
1532 : case STATE_CLOSE:
1533 0 : if( nOpCode == OPCODE_SEP ) eState = STATE_SEP;
1534 0 : else if( nOpCode == OPCODE_LIST ) eState = STATE_SEP;
1535 0 : else if( nOpCode == OPCODE_CLOSE ) eState = lclProcessClose( nParenLevel );
1536 0 : else eState = STATE_ERROR;
1537 0 : break;
1538 : default:;
1539 : }
1540 : }
1541 :
1542 0 : if( eState == STATE_ERROR )
1543 0 : orRanges.clear();
1544 : else
1545 0 : getAddressConverter().validateCellRangeList( orRanges, false );
1546 0 : }
1547 :
1548 0 : bool FormulaProcessorBase::extractString( OUString& orString, const ApiTokenSequence& rTokens ) const
1549 : {
1550 0 : ApiTokenIterator aTokenIt( rTokens, OPCODE_SPACES, true );
1551 0 : return aTokenIt.is() && (aTokenIt->OpCode == OPCODE_PUSH) && (aTokenIt->Data >>= orString) && !(++aTokenIt).is();
1552 : }
1553 :
1554 0 : bool FormulaProcessorBase::extractSpecialTokenInfo( ApiSpecialTokenInfo& orTokenInfo, const ApiTokenSequence& rTokens ) const
1555 : {
1556 0 : ApiTokenIterator aTokenIt( rTokens, OPCODE_SPACES, true );
1557 0 : return aTokenIt.is() && (aTokenIt->OpCode == OPCODE_BAD) && (aTokenIt->Data >>= orTokenInfo);
1558 : }
1559 :
1560 0 : void FormulaProcessorBase::convertStringToStringList(
1561 : ApiTokenSequence& orTokens, sal_Unicode cStringSep, bool bTrimLeadingSpaces ) const
1562 : {
1563 0 : OUString aString;
1564 0 : if( extractString( aString, orTokens ) && !aString.isEmpty() )
1565 : {
1566 0 : ::std::vector< ApiToken > aNewTokens;
1567 0 : sal_Int32 nPos = 0;
1568 0 : sal_Int32 nLen = aString.getLength();
1569 0 : while( (0 <= nPos) && (nPos < nLen) )
1570 : {
1571 0 : OUString aEntry = aString.getToken( 0, cStringSep, nPos );
1572 0 : if( bTrimLeadingSpaces )
1573 : {
1574 0 : sal_Int32 nStart = 0;
1575 0 : while( (nStart < aEntry.getLength()) && (aEntry[ nStart ] == ' ') ) ++nStart;
1576 0 : aEntry = aEntry.copy( nStart );
1577 : }
1578 0 : if( !aNewTokens.empty() )
1579 0 : aNewTokens.push_back( ApiToken( OPCODE_SEP, Any() ) );
1580 0 : aNewTokens.push_back( ApiToken( OPCODE_PUSH, Any( aEntry ) ) );
1581 0 : }
1582 0 : orTokens = ContainerHelper::vectorToSequence( aNewTokens );
1583 0 : }
1584 0 : }
1585 :
1586 : // ============================================================================
1587 :
1588 : } // namespace xls
1589 9 : } // namespace oox
1590 :
1591 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
