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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: tokenarray.hxx,v $
* $Revision: 1.12 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef FORMULA_TOKENARRAY_HXX
#define FORMULA_TOKENARRAY_HXX
#include "formula/token.hxx"
#include "formula/ExternalReferenceHelper.hxx"
#include <tools/solar.h>
#include <com/sun/star/sheet/FormulaToken.hpp>
#include <limits.h>
namespace formula
{
// RecalcMode access only via TokenArray SetRecalcMode / IsRecalcMode...
typedef BYTE ScRecalcMode;
// Only one of the exclusive bits can be set,
// handled by TokenArray SetRecalcMode... methods
#define RECALCMODE_NORMAL 0x01 // exclusive
#define RECALCMODE_ALWAYS 0x02 // exclusive, always
#define RECALCMODE_ONLOAD 0x04 // exclusive, always after load
#define RECALCMODE_ONLOAD_ONCE 0x08 // exclusive, once after load
#define RECALCMODE_FORCED 0x10 // combined, also if cell isn't visible
#define RECALCMODE_ONREFMOVE 0x20 // combined, if reference was moved
#define RECALCMODE_EMASK 0x0F // mask of exclusive bits
// If new bits are to be defined, AddRecalcMode has to be adjusted!
class FormulaMissingContext;
class FORMULA_DLLPUBLIC MissingConvention
{
bool mbODFF; /// TRUE: ODFF, FALSE: PODF
public:
explicit MissingConvention( bool bODFF ) : mbODFF(bODFF) {}
// Implementation and usage only in token.cxx
inline bool isRewriteNeeded( OpCode eOp ) const;
inline bool isODFF() const { return mbODFF; }
};
class FORMULA_DLLPUBLIC FormulaTokenArray
{
friend class FormulaCompiler;
friend class FormulaTokenIterator;
friend class FormulaMissingContext;
protected:
FormulaToken** pCode; // Token code array
FormulaToken** pRPN; // RPN array
USHORT nLen; // Length of token array
USHORT nRPN; // Length of RPN array
USHORT nIndex; // Current step index
USHORT nError; // Error code
short nRefs; // Count of cell references
ScRecalcMode nMode; // Flags to indicate when to recalc this code
BOOL bHyperLink; // If HYPERLINK() occurs in the formula.
protected:
void Assign( const FormulaTokenArray& );
/// Also used by the compiler. The token MUST had been allocated with new!
FormulaToken* Add( FormulaToken* );
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, nVal 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();
FormulaTokenArray* Clone() const; /// True copy!
void Clear();
void DelRPN();
FormulaToken* First() { nIndex = 0; return Next(); }
FormulaToken* Next();
FormulaToken* FirstNoSpaces() { nIndex = 0; return NextNoSpaces(); }
FormulaToken* NextNoSpaces();
FormulaToken* GetNextName();
FormulaToken* GetNextDBArea();
FormulaToken* GetNextReference();
FormulaToken* GetNextReferenceRPN();
FormulaToken* GetNextReferenceOrName();
FormulaToken* GetNextColRowName();
FormulaToken* GetNextOpCodeRPN( OpCode );
/// Peek at nIdx-1 if not out of bounds, decrements nIdx if successful. Returns NULL if not.
FormulaToken* PeekPrev( USHORT & 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 HasOpCode( OpCode ) const;
BOOL HasOpCodeRPN( OpCode ) const;
/// Token of type svIndex or opcode ocColRowName
BOOL HasNameOrColRowName() const;
FormulaToken** GetArray() const { return pCode; }
FormulaToken** GetCode() const { return pRPN; }
USHORT GetLen() const { return nLen; }
USHORT GetCodeLen() const { return nRPN; }
void Reset() { nIndex = 0; }
USHORT GetCodeError() const { return nError; }
void SetCodeError( USHORT n ) { nError = n; }
short GetRefs() const { return nRefs; }
void IncrementRefs() { ++nRefs; }
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 = RECALCMODE_NORMAL; }
inline void SetRecalcModeNormal()
{ SetMaskedRecalcMode( RECALCMODE_NORMAL ); }
inline void SetRecalcModeAlways()
{ SetMaskedRecalcMode( RECALCMODE_ALWAYS ); }
inline void SetRecalcModeOnLoad()
{ SetMaskedRecalcMode( RECALCMODE_ONLOAD ); }
inline void SetRecalcModeOnLoadOnce()
{ SetMaskedRecalcMode( RECALCMODE_ONLOAD_ONCE ); }
inline void SetRecalcModeForced()
{ nMode |= RECALCMODE_FORCED; }
inline void ClearRecalcModeForced()
{ nMode &= ~RECALCMODE_FORCED; }
inline void SetRecalcModeOnRefMove()
{ nMode |= RECALCMODE_ONREFMOVE; }
inline void ClearRecalcModeOnRefMove()
{ nMode &= ~RECALCMODE_ONREFMOVE; }
inline BOOL IsRecalcModeNormal() const
{ return (nMode & RECALCMODE_NORMAL) != 0; }
inline BOOL IsRecalcModeAlways() const
{ return (nMode & RECALCMODE_ALWAYS) != 0; }
inline BOOL IsRecalcModeOnLoad() const
{ return (nMode & RECALCMODE_ONLOAD) != 0; }
inline BOOL IsRecalcModeOnLoadOnce() const
{ return (nMode & RECALCMODE_ONLOAD_ONCE) != 0; }
inline BOOL IsRecalcModeForced() const
{ return (nMode & RECALCMODE_FORCED) != 0; }
inline BOOL IsRecalcModeOnRefMove() const
{ return (nMode & RECALCMODE_ONREFMOVE) != 0; }
/** 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 overload it when they want to support derived classes from FormulaToken.
@return true when an error occurs
*/
virtual bool AddFormulaToken(const com::sun::star::sheet::FormulaToken& _aToken, ExternalReferenceHelper* _pRef = NULL);
/** 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 com::sun::star::uno::Sequence< com::sun::star::sheet::FormulaToken >& _aSequence, ExternalReferenceHelper* _pRef = NULL);
FormulaToken* AddToken( const FormulaToken& );
FormulaToken* AddString( const sal_Unicode* pStr );
FormulaToken* AddString( const String& rStr );
FormulaToken* AddDouble( double fVal );
FormulaToken* AddName( USHORT n );
FormulaToken* AddExternal( const sal_Unicode* pStr );
/** Xcl import may play dirty tricks with OpCode!=ocExternal.
Others don't use! */
FormulaToken* AddExternal( const String& rStr, OpCode eOp = ocExternal );
FormulaToken* AddBad( const sal_Unicode* pStr ); /// ocBad with String
FormulaToken* AddBad( const String& rStr ); /// ocBad with String
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). */
bool NeedsPofRewrite(const MissingConvention & rConv);
/** Rewrites to Plain Old Formula, substituting missing parameters. The
FormulaTokenArray* returned is new'ed. */
FormulaTokenArray* RewriteMissingToPof(const MissingConvention & rConv);
/** Determines if this formula may be followed by a reference. */
bool MayReferenceFollow();
};
inline OpCode FormulaTokenArray::GetOuterFuncOpCode()
{
if ( pRPN && nRPN )
return pRPN[nRPN-1]->GetOpCode();
return ocNone;
}
struct ImpTokenIterator
{
ImpTokenIterator* pNext;
const FormulaTokenArray* pArr;
short nPC;
short nStop;
DECL_FIXEDMEMPOOL_NEWDEL( ImpTokenIterator );
};
class FORMULA_DLLPUBLIC FormulaTokenIterator
{
ImpTokenIterator* pCur;
public:
FormulaTokenIterator( const FormulaTokenArray& );
~FormulaTokenIterator();
void Reset();
const FormulaToken* First();
const FormulaToken* Next();
bool IsEndOfPath() const; /// if a jump or subroutine path is done
bool HasStacked() const { return pCur->pNext != 0; }
short GetPC() const { return pCur->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 ocChose
jumps.
*/
void Jump( short nStart, short nNext, short nStop = SHRT_MAX );
void Push( const FormulaTokenArray* );
void Pop();
};
// =============================================================================
} // formula
// =============================================================================
#endif // FORMULA_TOKENARRAY_HXX
|
