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
|
/* -*- 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 .
*/
#ifndef INCLUDED_FORMULA_TOKENARRAY_HXX
#define INCLUDED_FORMULA_TOKENARRAY_HXX
#include <climits>
#include <memory>
#include <type_traits>
#include <unordered_set>
#include <unordered_map>
#include <vector>
#include <com/sun/star/uno/Sequence.hxx>
#include <formula/ExternalReferenceHelper.hxx>
#include <formula/formuladllapi.h>
#include <formula/opcode.hxx>
#include <formula/token.hxx>
#include <o3tl/typed_flags_set.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
namespace com { namespace sun { namespace star {
namespace sheet { struct FormulaToken; }
} } }
namespace svl {
class SharedString;
class SharedStringPool;
}
// RecalcMode access only via TokenArray SetRecalcMode / IsRecalcMode...
// Only one of the exclusive bits can be set,
// handled by TokenArray SetRecalcMode... methods
enum class ScRecalcMode : sal_uInt8
{
NORMAL = 0x01, // exclusive
ALWAYS = 0x02, // exclusive, always
ONLOAD = 0x04, // exclusive, always after load
ONLOAD_ONCE = 0x08, // exclusive, once after load
FORCED = 0x10, // combined, also if cell isn't visible
ONREFMOVE = 0x20, // combined, if reference was moved
};
// If new bits are to be defined, AddRecalcMode has to be adjusted!
namespace o3tl
{
template<> struct typed_flags<ScRecalcMode> : is_typed_flags<ScRecalcMode, 0x3f> {};
}
#define RECALCMODE_EMASK (ScRecalcMode(ScRecalcMode::NORMAL | ScRecalcMode::ALWAYS | ScRecalcMode::ONLOAD | ScRecalcMode::ONLOAD_ONCE)) // mask of exclusive bits
namespace formula
{
class FORMULA_DLLPUBLIC MissingConvention
{
public:
enum Convention
{
FORMULA_MISSING_CONVENTION_PODF,
FORMULA_MISSING_CONVENTION_ODFF,
FORMULA_MISSING_CONVENTION_OOXML
};
explicit MissingConvention( Convention eConvention ) : meConvention(eConvention) {}
inline bool isPODF() const { return meConvention == FORMULA_MISSING_CONVENTION_PODF; }
inline bool isODFF() const { return meConvention == FORMULA_MISSING_CONVENTION_ODFF; }
inline bool isOOXML() const { return meConvention == FORMULA_MISSING_CONVENTION_OOXML; }
inline Convention getConvention() const { return meConvention; }
private:
Convention meConvention;
};
class FORMULA_DLLPUBLIC MissingConventionODF : public MissingConvention
{
public:
explicit MissingConventionODF( bool bODFF ) :
MissingConvention( bODFF ?
MissingConvention::FORMULA_MISSING_CONVENTION_ODFF :
MissingConvention::FORMULA_MISSING_CONVENTION_PODF)
{
}
// Implementation and usage only in token.cxx
inline bool isRewriteNeeded( OpCode eOp ) const;
};
class FORMULA_DLLPUBLIC MissingConventionOOXML : public MissingConvention
{
public:
explicit MissingConventionOOXML() : MissingConvention( MissingConvention::FORMULA_MISSING_CONVENTION_OOXML) {}
// Implementation and usage only in token.cxx
static inline bool isRewriteNeeded( OpCode eOp );
};
typedef std::unordered_set<OpCode, std::hash<std::underlying_type<OpCode>::type> > unordered_opcode_set;
class FORMULA_DLLPUBLIC FormulaTokenArray
{
friend class FormulaCompiler;
friend class FormulaTokenIterator;
friend class FormulaMissingContext;
protected:
FormulaToken** pCode; // Token code array
FormulaToken** pRPN; // RPN array
sal_uInt16 nLen; // Length of token array
sal_uInt16 nRPN; // Length of RPN array
sal_uInt16 nIndex; // Current step index
FormulaError nError; // Error code
ScRecalcMode nMode; // Flags to indicate when to recalc this code
bool bHyperLink; // If HYPERLINK() occurs in the formula.
bool mbFromRangeName; // If this array originates from a named expression
bool mbShareable; // Whether or not it can be shared with adjacent cells.
protected:
void Assign( const FormulaTokenArray& );
void Assign( sal_uInt16 nCode, FormulaToken **pTokens );
/// Also used by the compiler. The token MUST had been allocated with new!
FormulaToken* Add( FormulaToken* );
public:
enum ReplaceMode
{
CODE_ONLY, ///< replacement only in pCode
CODE_AND_RPN ///< replacement in pCode and pRPN
};
protected:
/** Also used by the compiler. The token MUST had been allocated with new!
@param nOffset
Absolute offset in pCode of the token to be replaced.
@param eMode
If CODE_ONLY only the token in pCode at nOffset is replaced.
If CODE_AND_RPN the token in pCode at nOffset is replaced;
if the original token was also referenced in the pRPN array
then that reference is replaced with a reference to the new
token as well.
*/
FormulaToken* ReplaceToken( sal_uInt16 nOffset, FormulaToken*, ReplaceMode eMode );
/** Remove a sequence of tokens from pCode array, and pRPN array if the
tokens are referenced there.
This' nLen and nRPN are adapted, as is nIndex if it points behind
nOffset. If nIndex points into the to be removed range
(nOffset < nIndex < nOffset+nCount) it is set to nOffset+1.
@param nOffset
Start offset into pCode.
@param nCount
Count of tokens to remove.
@return Count of tokens removed.
*/
sal_uInt16 RemoveToken( sal_uInt16 nOffset, sal_uInt16 nCount );
inline void SetCombinedBitsRecalcMode( ScRecalcMode nBits )
{ nMode |= (nBits & ~RECALCMODE_EMASK); }
inline ScRecalcMode GetCombinedBitsRecalcMode() const
{ return nMode & ~RECALCMODE_EMASK; }
/** Exclusive bits already set in nMode are
zero'ed, nBits may contain combined bits, but
only one exclusive bit may be set! */
inline void SetMaskedRecalcMode( ScRecalcMode nBits )
{ nMode = GetCombinedBitsRecalcMode() | nBits; }
public:
FormulaTokenArray();
/// Assignment with references to FormulaToken entries (not copied!)
FormulaTokenArray( const FormulaTokenArray& );
virtual ~FormulaTokenArray();
void SetFromRangeName( bool b ) { mbFromRangeName = b; }
bool IsFromRangeName() const { return mbFromRangeName; }
void SetShareable( bool b ) { mbShareable = b; }
/**
* Check if this token array is shareable between multiple adjacent
* formula cells. Certain tokens may not function correctly when shared.
*
* @return true if the token array is shareable, false otherwise.
*/
bool IsShareable() const { return mbShareable; }
void Clear();
void DelRPN();
FormulaToken* First() { nIndex = 0; return Next(); }
FormulaToken* Next();
FormulaToken* NextNoSpaces();
FormulaToken* GetNextName();
FormulaToken* GetNextReference();
FormulaToken* GetNextReferenceRPN();
FormulaToken* GetNextReferenceOrName();
FormulaToken* GetNextColRowName();
/// Peek at nIdx-1 if not out of bounds, decrements nIdx if successful. Returns NULL if not.
FormulaToken* PeekPrev( sal_uInt16 & nIdx );
FormulaToken* PeekNext();
FormulaToken* PeekPrevNoSpaces(); /// Only after Reset/First/Next/Last/Prev!
FormulaToken* PeekNextNoSpaces(); /// Only after Reset/First/Next/Last/Prev!
FormulaToken* FirstRPN() { nIndex = 0; return NextRPN(); }
FormulaToken* NextRPN();
FormulaToken* LastRPN() { nIndex = nRPN; return PrevRPN(); }
FormulaToken* PrevRPN();
bool HasReferences() const;
bool HasExternalRef() const;
bool HasOpCode( OpCode ) const;
bool HasOpCodeRPN( OpCode ) const;
/// Token of type svIndex or opcode ocColRowName
bool HasNameOrColRowName() const;
/**
* Check if the token array contains any of specified opcode tokens.
*
* @param rOpCodes collection of opcodes to check against.
*
* @return true if the token array contains at least one of the specified
* opcode tokens, false otherwise.
*/
bool HasOpCodes( const unordered_opcode_set& rOpCodes ) const;
FormulaToken** GetArray() const { return pCode; }
FormulaToken** GetCode() const { return pRPN; }
sal_uInt16 GetLen() const { return nLen; }
sal_uInt16 GetCodeLen() const { return nRPN; }
void Reset() { nIndex = 0; }
FormulaError GetCodeError() const { return nError; }
void SetCodeError( FormulaError n ) { nError = n; }
void SetHyperLink( bool bVal ) { bHyperLink = bVal; }
bool IsHyperLink() const { return bHyperLink; }
inline ScRecalcMode GetRecalcMode() const { return nMode; }
/** Bits aren't set directly but validated and
maybe handled according to priority if more
than one exclusive bit was set. */
void AddRecalcMode( ScRecalcMode nBits );
inline void ClearRecalcMode() { nMode = ScRecalcMode::NORMAL; }
inline void SetExclusiveRecalcModeNormal()
{ SetMaskedRecalcMode( ScRecalcMode::NORMAL ); }
inline void SetExclusiveRecalcModeAlways()
{ SetMaskedRecalcMode( ScRecalcMode::ALWAYS ); }
inline void SetExclusiveRecalcModeOnLoad()
{ SetMaskedRecalcMode( ScRecalcMode::ONLOAD ); }
inline void SetExclusiveRecalcModeOnLoadOnce()
{ SetMaskedRecalcMode( ScRecalcMode::ONLOAD_ONCE ); }
inline void SetRecalcModeForced()
{ nMode |= ScRecalcMode::FORCED; }
inline void SetRecalcModeOnRefMove()
{ nMode |= ScRecalcMode::ONREFMOVE; }
inline bool IsRecalcModeNormal() const
{ return bool(nMode & ScRecalcMode::NORMAL); }
inline bool IsRecalcModeAlways() const
{ return bool(nMode & ScRecalcMode::ALWAYS); }
inline bool IsRecalcModeOnLoad() const
{ return bool(nMode & ScRecalcMode::ONLOAD); }
inline bool IsRecalcModeOnLoadOnce() const
{ return bool(nMode & ScRecalcMode::ONLOAD_ONCE); }
inline bool IsRecalcModeForced() const
{ return bool(nMode & ScRecalcMode::FORCED); }
inline bool IsRecalcModeOnRefMove() const
{ return bool(nMode & ScRecalcMode::ONREFMOVE); }
/** Get OpCode of the most outer function */
inline OpCode GetOuterFuncOpCode();
/** Operators +,-,*,/,^,&,=,<>,<,>,<=,>=
with DoubleRef in Formula? */
bool HasMatrixDoubleRefOps();
virtual FormulaToken* AddOpCode(OpCode e);
/** Adds the single token to array.
Derived classes must override it when they want to support derived classes from FormulaToken.
@return true when an error occurs
*/
virtual bool AddFormulaToken(
const css::sheet::FormulaToken& rToken, svl::SharedStringPool& rSPool,
ExternalReferenceHelper* pExtRef );
/** fill the array with the tokens from the sequence.
It calls AddFormulaToken for each token in the list.
@param _aSequence the token to add
@return true when an error occurs
*/
bool Fill(
const css::uno::Sequence<css::sheet::FormulaToken>& rSequence,
svl::SharedStringPool& rSPool, ExternalReferenceHelper* pExtRef );
/**
* Do some checking based on the individual tokens. For now, we use this
* only to check whether we can vectorize the token array.
*/
virtual void CheckToken( const FormulaToken& t );
/** Clones the token and then adds the clone to the pCode array.
For just new'ed tokens use Add() instead of cloning it again.
Use this AddToken() when adding a token from another origin.
*/
FormulaToken* AddToken( const FormulaToken& );
FormulaToken* AddString( const svl::SharedString& rStr );
FormulaToken* AddDouble( double fVal );
void AddExternal( const sal_Unicode* pStr );
/** Xcl import may play dirty tricks with OpCode!=ocExternal.
Others don't use! */
FormulaToken* AddExternal( const OUString& rStr, OpCode eOp = ocExternal );
FormulaToken* AddBad( const OUString& rStr ); /// ocBad with OUString
FormulaToken* AddStringXML( const OUString& rStr ); /// ocStringXML with OUString, temporary during import
virtual FormulaToken* MergeArray( );
/// Assignment with references to FormulaToken entries (not copied!)
FormulaTokenArray& operator=( const FormulaTokenArray& );
/** Determines if this formula needs any changes to convert it to something
previous versions of OOo could consume (Plain Old Formula, pre-ODFF, or
also ODFF) */
bool NeedsPodfRewrite( const MissingConventionODF & rConv );
/** Determines if this formula needs any changes to convert it to OOXML. */
bool NeedsOoxmlRewrite();
/** Rewrites to Plain Old Formula or OOXML, substituting missing parameters. The
FormulaTokenArray* returned is new'ed. */
FormulaTokenArray* RewriteMissing( const MissingConvention & rConv );
/** Determines if this formula may be followed by a reference. */
bool MayReferenceFollow();
/** Re-intern SharedString in case the SharedStringPool differs. */
void ReinternStrings( svl::SharedStringPool& rPool );
};
inline OpCode FormulaTokenArray::GetOuterFuncOpCode()
{
if ( pRPN && nRPN )
return pRPN[nRPN-1]->GetOpCode();
return ocNone;
}
class FORMULA_DLLPUBLIC FormulaTokenIterator
{
struct Item
{
public:
const FormulaTokenArray* pArr;
short nPC;
short nStop;
Item(const FormulaTokenArray* arr, short pc, short stop);
};
std::vector<Item> maStack;
public:
FormulaTokenIterator( const FormulaTokenArray& );
~FormulaTokenIterator();
void Reset();
const FormulaToken* Next();
const FormulaToken* PeekNextOperator();
bool IsEndOfPath() const; /// if a jump or subroutine path is done
bool HasStacked() const { return maStack.size() > 1; }
short GetPC() const { return maStack.back().nPC; }
/** Jump or subroutine call.
Program counter values will be incremented before code is executed =>
positions are to be passed with -1 offset.
@param nStart
Start on code at position nStart+1 (yes, pass with offset -1)
@param nNext
After subroutine continue with instruction at position nNext+1
@param nStop
Stop before reaching code at position nStop. If not specified the
default is to either run the entire code, or to stop if an ocSep or
ocClose is encountered, which are only present in ocIf or ocChoose
jumps.
*/
void Jump( short nStart, short nNext, short nStop = SHRT_MAX );
void Push( const FormulaTokenArray* );
void Pop();
private:
const FormulaToken* GetNonEndOfPathToken( short nIdx ) const;
};
} // formula
#endif // INCLUDED_FORMULA_TOKENARRAY_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|