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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481 | /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <memory>
#include <tokenuno.hxx>
#include <sal/macros.h>
#include <sal/log.hxx>
#include <com/sun/star/sheet/ComplexReference.hpp>
#include <com/sun/star/sheet/ExternalReference.hpp>
#include <com/sun/star/sheet/ReferenceFlags.hpp>
#include <com/sun/star/sheet/AddressConvention.hpp>
#include <com/sun/star/sheet/NameToken.hpp>
#include <com/sun/star/table/CellAddress.hpp>
#include <svl/itemprop.hxx>
#include <vcl/svapp.hxx>
#include <miscuno.hxx>
#include <convuno.hxx>
#include <unonames.hxx>
#include <compiler.hxx>
#include <tokenarray.hxx>
#include <docsh.hxx>
#include <rangeseq.hxx>
#include <externalrefmgr.hxx>
using namespace ::formula;
using namespace ::com::sun::star;
static const SfxItemPropertyMapEntry* lcl_GetFormulaParserMap()
{
static const SfxItemPropertyMapEntry aFormulaParserMap_Impl[] =
{
{OUString(SC_UNO_COMPILEFAP), 0, cppu::UnoType<bool>::get(), 0, 0 },
{OUString(SC_UNO_COMPILEENGLISH), 0, cppu::UnoType<bool>::get(), 0, 0 },
{OUString(SC_UNO_IGNORELEADING), 0, cppu::UnoType<bool>::get(), 0, 0 },
{OUString(SC_UNO_FORMULACONVENTION), 0, cppu::UnoType<decltype(sheet::AddressConvention::UNSPECIFIED)>::get(), 0, 0 },
{OUString(SC_UNO_OPCODEMAP), 0, cppu::UnoType<uno::Sequence< sheet::FormulaOpCodeMapEntry >>::get(), 0, 0 },
{ OUString(), 0, css::uno::Type(), 0, 0 }
};
return aFormulaParserMap_Impl;
}
SC_SIMPLE_SERVICE_INFO( ScFormulaParserObj, "ScFormulaParserObj", SC_SERVICENAME_FORMULAPARS )<--- There is an unknown macro here somewhere. Configuration is required. If SC_SIMPLE_SERVICE_INFO is a macro then please configure it.
ScFormulaParserObj::ScFormulaParserObj(ScDocShell* pDocSh) :
mpDocShell( pDocSh ),
mnConv( sheet::AddressConvention::UNSPECIFIED ),
mbEnglish( false ),
mbIgnoreSpaces( true ),
mbCompileFAP( false )
{
mpDocShell->GetDocument().AddUnoObject(*this);
}
ScFormulaParserObj::~ScFormulaParserObj()
{
SolarMutexGuard g;
if (mpDocShell)
mpDocShell->GetDocument().RemoveUnoObject(*this);
}
void ScFormulaParserObj::Notify( SfxBroadcaster&, const SfxHint& rHint )
{
if ( rHint.GetId() == SfxHintId::Dying )
mpDocShell = nullptr;
}
// XFormulaParser
void ScFormulaParserObj::SetCompilerFlags( ScCompiler& rCompiler ) const
{
static const formula::FormulaGrammar::AddressConvention aConvMap[] = {
formula::FormulaGrammar::CONV_OOO, // <- AddressConvention::OOO
formula::FormulaGrammar::CONV_XL_A1, // <- AddressConvention::XL_A1
formula::FormulaGrammar::CONV_XL_R1C1, // <- AddressConvention::XL_R1C1
formula::FormulaGrammar::CONV_XL_OOX, // <- AddressConvention::XL_OOX
formula::FormulaGrammar::CONV_LOTUS_A1 // <- AddressConvention::LOTUS_A1
};
static const sal_Int16 nConvMapCount = SAL_N_ELEMENTS(aConvMap);
// If mxOpCodeMap is not empty it overrides mbEnglish, and vice versa. We
// don't need to initialize things twice.
if (mxOpCodeMap)
rCompiler.SetFormulaLanguage( mxOpCodeMap );
else
{
sal_Int32 nFormulaLanguage = mbEnglish ?
sheet::FormulaLanguage::ENGLISH :
sheet::FormulaLanguage::NATIVE;
ScCompiler::OpCodeMapPtr xMap = rCompiler.GetOpCodeMap( nFormulaLanguage);
rCompiler.SetFormulaLanguage( xMap);
}
formula::FormulaGrammar::AddressConvention eConv = formula::FormulaGrammar::CONV_UNSPECIFIED;
if (mnConv >= 0 && mnConv < nConvMapCount)
eConv = aConvMap[mnConv];
rCompiler.SetRefConvention( eConv );
rCompiler.EnableJumpCommandReorder(!mbCompileFAP);
rCompiler.EnableStopOnError(!mbCompileFAP);
rCompiler.SetExternalLinks( maExternalLinks);
}
uno::Sequence<sheet::FormulaToken> SAL_CALL ScFormulaParserObj::parseFormula(
const OUString& aFormula, const table::CellAddress& rReferencePos )
{
SolarMutexGuard aGuard;
uno::Sequence<sheet::FormulaToken> aRet;
if (mpDocShell)
{
ScDocument& rDoc = mpDocShell->GetDocument();
ScExternalRefManager::ApiGuard aExtRefGuard(&rDoc);
ScAddress aRefPos( ScAddress::UNINITIALIZED );
ScUnoConversion::FillScAddress( aRefPos, rReferencePos );
ScCompiler aCompiler( &rDoc, aRefPos, rDoc.GetGrammar());
SetCompilerFlags( aCompiler );
std::unique_ptr<ScTokenArray> pCode = aCompiler.CompileString( aFormula );
ScTokenConversion::ConvertToTokenSequence( rDoc, aRet, *pCode );
}
return aRet;
}
OUString SAL_CALL ScFormulaParserObj::printFormula(
const uno::Sequence<sheet::FormulaToken>& aTokens, const table::CellAddress& rReferencePos )
{
SolarMutexGuard aGuard;
OUString aRet;
if (mpDocShell)
{
ScDocument& rDoc = mpDocShell->GetDocument();
ScTokenArray aCode(&rDoc);
(void)ScTokenConversion::ConvertToTokenArray( rDoc, aCode, aTokens );
ScAddress aRefPos( ScAddress::UNINITIALIZED );
ScUnoConversion::FillScAddress( aRefPos, rReferencePos );
ScCompiler aCompiler( &rDoc, aRefPos, aCode, rDoc.GetGrammar());
SetCompilerFlags( aCompiler );
OUStringBuffer aBuffer;
aCompiler.CreateStringFromTokenArray( aBuffer );
aRet = aBuffer.makeStringAndClear();
}
return aRet;
}
// XPropertySet
uno::Reference<beans::XPropertySetInfo> SAL_CALL ScFormulaParserObj::getPropertySetInfo()
{
SolarMutexGuard aGuard;
static uno::Reference< beans::XPropertySetInfo > aRef(new SfxItemPropertySetInfo( lcl_GetFormulaParserMap() ));
return aRef;
}
void SAL_CALL ScFormulaParserObj::setPropertyValue(
const OUString& aPropertyName, const uno::Any& aValue )
{
SolarMutexGuard aGuard;
if ( aPropertyName == SC_UNO_COMPILEFAP )
{
aValue >>= mbCompileFAP;
}
else if ( aPropertyName == SC_UNO_COMPILEENGLISH )
{
bool bOldEnglish = mbEnglish;
if (!(aValue >>= mbEnglish))
throw lang::IllegalArgumentException();
// Need to recreate the symbol map to change English property
// because the map is const. So for performance reasons set
// CompileEnglish _before_ OpCodeMap!
if (mxOpCodeMap && mbEnglish != bOldEnglish)
{
ScDocument& rDoc = mpDocShell->GetDocument();
ScCompiler aCompiler( &rDoc, ScAddress(), rDoc.GetGrammar());
mxOpCodeMap = formula::FormulaCompiler::CreateOpCodeMap( maOpCodeMapping, mbEnglish);
}
}
else if ( aPropertyName == SC_UNO_FORMULACONVENTION )
{
aValue >>= mnConv;
}
else if ( aPropertyName == SC_UNO_IGNORELEADING )
{
aValue >>= mbIgnoreSpaces;
}
else if ( aPropertyName == SC_UNO_OPCODEMAP )
{
if (!(aValue >>= maOpCodeMapping))
throw lang::IllegalArgumentException();
ScDocument& rDoc = mpDocShell->GetDocument();
ScCompiler aCompiler( &rDoc, ScAddress(), rDoc.GetGrammar());
mxOpCodeMap = formula::FormulaCompiler::CreateOpCodeMap( maOpCodeMapping, mbEnglish);
}
else if ( aPropertyName == SC_UNO_EXTERNALLINKS )
{
if (!(aValue >>= maExternalLinks))
throw lang::IllegalArgumentException();
}
else
throw beans::UnknownPropertyException(aPropertyName);
}
uno::Any SAL_CALL ScFormulaParserObj::getPropertyValue( const OUString& aPropertyName )
{
SolarMutexGuard aGuard;
uno::Any aRet;
if ( aPropertyName == SC_UNO_COMPILEFAP )
{
aRet <<= mbCompileFAP;
}
else if ( aPropertyName == SC_UNO_COMPILEENGLISH )
{
aRet <<= mbEnglish;
}
else if ( aPropertyName == SC_UNO_FORMULACONVENTION )
{
aRet <<= mnConv;
}
else if ( aPropertyName == SC_UNO_IGNORELEADING )
{
aRet <<= mbIgnoreSpaces;
}
else if ( aPropertyName == SC_UNO_OPCODEMAP )
{
aRet <<= maOpCodeMapping;
}
else if ( aPropertyName == SC_UNO_EXTERNALLINKS )
{
aRet <<= maExternalLinks;
}
else
throw beans::UnknownPropertyException(aPropertyName);
return aRet;
}
SC_IMPL_DUMMY_PROPERTY_LISTENER( ScFormulaParserObj )
static void lcl_ExternalRefToApi( sheet::SingleReference& rAPI, const ScSingleRefData& rRef )
{
rAPI.Column = 0;
rAPI.Row = 0;
rAPI.Sheet = 0;
rAPI.RelativeColumn = 0;
rAPI.RelativeRow = 0;
rAPI.RelativeSheet = 0;
sal_Int32 nFlags = 0;
if ( rRef.IsColRel() )
{
nFlags |= sheet::ReferenceFlags::COLUMN_RELATIVE;
rAPI.RelativeColumn = rRef.Col();
}
else
rAPI.Column = rRef.Col();
if ( rRef.IsRowRel() )
{
nFlags |= sheet::ReferenceFlags::ROW_RELATIVE;
rAPI.RelativeRow = rRef.Row();
}
else
rAPI.Row = rRef.Row();
if ( rRef.IsColDeleted() ) nFlags |= sheet::ReferenceFlags::COLUMN_DELETED;
if ( rRef.IsRowDeleted() ) nFlags |= sheet::ReferenceFlags::ROW_DELETED;
if ( rRef.IsFlag3D() ) nFlags |= sheet::ReferenceFlags::SHEET_3D;
if ( rRef.IsRelName() ) nFlags |= sheet::ReferenceFlags::RELATIVE_NAME;
rAPI.Flags = nFlags;
}
static void lcl_SingleRefToApi( sheet::SingleReference& rAPI, const ScSingleRefData& rRef )
{
sal_Int32 nFlags = 0;
if ( rRef.IsColRel() )
{
nFlags |= sheet::ReferenceFlags::COLUMN_RELATIVE;
rAPI.RelativeColumn = rRef.Col();
rAPI.Column = 0;
}
else
{
rAPI.RelativeColumn = 0;
rAPI.Column = rRef.Col();
}
if ( rRef.IsRowRel() )
{
nFlags |= sheet::ReferenceFlags::ROW_RELATIVE;
rAPI.RelativeRow = rRef.Row();
rAPI.Row = 0;
}
else
{
rAPI.RelativeRow = 0;
rAPI.Row = rRef.Row();
}
if ( rRef.IsTabRel() )
{
nFlags |= sheet::ReferenceFlags::SHEET_RELATIVE;
rAPI.RelativeSheet = rRef.Tab();
rAPI.Sheet = 0;
}
else
{
rAPI.RelativeSheet = 0;
rAPI.Sheet = rRef.Tab();
}
if ( rRef.IsColDeleted() ) nFlags |= sheet::ReferenceFlags::COLUMN_DELETED;
if ( rRef.IsRowDeleted() ) nFlags |= sheet::ReferenceFlags::ROW_DELETED;
if ( rRef.IsTabDeleted() ) nFlags |= sheet::ReferenceFlags::SHEET_DELETED;
if ( rRef.IsFlag3D() ) nFlags |= sheet::ReferenceFlags::SHEET_3D;
if ( rRef.IsRelName() ) nFlags |= sheet::ReferenceFlags::RELATIVE_NAME;
rAPI.Flags = nFlags;
}
bool ScTokenConversion::ConvertToTokenArray( ScDocument& rDoc,
ScTokenArray& rTokenArray, const uno::Sequence<sheet::FormulaToken>& rSequence )
{
return !rTokenArray.Fill(rSequence, rDoc.GetSharedStringPool(), rDoc.GetExternalRefManager());
}
void ScTokenConversion::ConvertToTokenSequence( const ScDocument& rDoc,
uno::Sequence<sheet::FormulaToken>& rSequence, const ScTokenArray& rTokenArray )
{
sal_Int32 nLen = static_cast<sal_Int32>(rTokenArray.GetLen());
formula::FormulaToken** pTokens = rTokenArray.GetArray();
if ( pTokens )
{
rSequence.realloc(nLen);
for (sal_Int32 nPos=0; nPos<nLen; nPos++)
{
const formula::FormulaToken& rToken = *pTokens[nPos];
sheet::FormulaToken& rAPI = rSequence[nPos];
OpCode eOpCode = rToken.GetOpCode();
// eOpCode may be changed in the following switch/case
switch ( rToken.GetType() )
{
case svByte:
// Only the count of spaces is stored as "long". Parameter count is ignored.
if ( eOpCode == ocSpaces )
rAPI.Data <<= static_cast<sal_Int32>(rToken.GetByte());
else
rAPI.Data.clear(); // no data
break;
case formula::svDouble:
rAPI.Data <<= rToken.GetDouble();
break;
case formula::svString:
rAPI.Data <<= rToken.GetString().getString();
break;
case svExternal:
// Function name is stored as string.
// Byte (parameter count) is ignored.
rAPI.Data <<= rToken.GetExternal();
break;
case svSingleRef:
{
sheet::SingleReference aSingleRef;
lcl_SingleRefToApi( aSingleRef, *rToken.GetSingleRef() );
rAPI.Data <<= aSingleRef;
}
break;
case formula::svDoubleRef:
{
sheet::ComplexReference aCompRef;
lcl_SingleRefToApi( aCompRef.Reference1, *rToken.GetSingleRef() );
lcl_SingleRefToApi( aCompRef.Reference2, *rToken.GetSingleRef2() );
rAPI.Data <<= aCompRef;
}
break;
case svIndex:
{
sheet::NameToken aNameToken;
aNameToken.Index = static_cast<sal_Int32>( rToken.GetIndex() );
aNameToken.Sheet = rToken.GetSheet();
rAPI.Data <<= aNameToken;
}
break;
case svMatrix:
if (!ScRangeToSequence::FillMixedArray( rAPI.Data, rToken.GetMatrix(), true))
rAPI.Data.clear();
break;
case svExternalSingleRef:
{
sheet::SingleReference aSingleRef;
lcl_ExternalRefToApi( aSingleRef, *rToken.GetSingleRef() );
size_t nCacheId;
rDoc.GetExternalRefManager()->getCacheTable(
rToken.GetIndex(), rToken.GetString().getString(), false, &nCacheId);
aSingleRef.Sheet = static_cast< sal_Int32 >( nCacheId );
sheet::ExternalReference aExtRef;
aExtRef.Index = rToken.GetIndex();
aExtRef.Reference <<= aSingleRef;
rAPI.Data <<= aExtRef;
eOpCode = ocPush;
}
break;
case svExternalDoubleRef:
{
sheet::ComplexReference aComplRef;
lcl_ExternalRefToApi( aComplRef.Reference1, *rToken.GetSingleRef() );
lcl_ExternalRefToApi( aComplRef.Reference2, *rToken.GetSingleRef2() );
size_t nCacheId;
rDoc.GetExternalRefManager()->getCacheTable(
rToken.GetIndex(), rToken.GetString().getString(), false, &nCacheId);
aComplRef.Reference1.Sheet = static_cast< sal_Int32 >( nCacheId );
// NOTE: This assumes that cached sheets are in consecutive order!
aComplRef.Reference2.Sheet =
aComplRef.Reference1.Sheet +
(rToken.GetSingleRef2()->Tab() - rToken.GetSingleRef()->Tab());
sheet::ExternalReference aExtRef;
aExtRef.Index = rToken.GetIndex();
aExtRef.Reference <<= aComplRef;
rAPI.Data <<= aExtRef;
eOpCode = ocPush;
}
break;
case svExternalName:
{
sheet::ExternalReference aExtRef;
aExtRef.Index = rToken.GetIndex();
aExtRef.Reference <<= rToken.GetString().getString();
rAPI.Data <<= aExtRef;
eOpCode = ocPush;
}
break;
default:
SAL_WARN("sc", "ScTokenConversion::ConvertToTokenSequence: unhandled token type " << StackVarEnumToString(rToken.GetType()));
[[fallthrough]];
case svJump: // occurs with ocIf, ocChoose
case svError: // seems to be fairly common, and probably not exceptional and not worth a warning?
case svMissing: // occurs with ocMissing
case svSep: // occurs with ocSep, ocOpen, ocClose, ocArray*
rAPI.Data.clear(); // no data
}
rAPI.OpCode = static_cast<sal_Int32>(eOpCode); //! assuming equal values for the moment
}
}
else
rSequence.realloc(0);
}
ScFormulaOpCodeMapperObj::ScFormulaOpCodeMapperObj(::std::unique_ptr<formula::FormulaCompiler> && _pCompiler)
: formula::FormulaOpCodeMapperObj(std::move(_pCompiler))
{
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|