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 : #ifndef INCLUDED_FORMULA_TOKEN_HXX
21 : #define INCLUDED_FORMULA_TOKEN_HXX
22 :
23 : #include <sal/config.h>
24 :
25 : #include <vector>
26 :
27 : #include <string.h>
28 : #include <formula/opcode.hxx>
29 : #include <tools/mempool.hxx>
30 : #include <formula/IFunctionDescription.hxx>
31 : #include <formula/formuladllapi.h>
32 : #include <formula/types.hxx>
33 : #include <svl/sharedstring.hxx>
34 : #include <osl/interlck.h>
35 :
36 : class ScJumpMatrix;
37 : class ScMatrix;
38 : struct ScComplexRefData;
39 : struct ScSingleRefData;
40 :
41 : namespace formula
42 : {
43 :
44 : enum StackVarEnum
45 : {
46 : svByte,
47 : svDouble,
48 : svString,
49 : svSingleRef,
50 : svDoubleRef,
51 : svMatrix,
52 : svIndex,
53 : svJump,
54 : svExternal, // Byte + String
55 : svFAP, // FormulaAutoPilot only, ever exported
56 : svJumpMatrix, // 2003-07-02
57 : svRefList, // ocUnion result
58 : svEmptyCell, // Result is an empty cell, e.g. in LOOKUP()
59 :
60 : svMatrixCell, // Result is a matrix with bells and
61 : // whistles as needed for _the_ matrix
62 : // formula result.
63 :
64 : svHybridCell, // A temporary condition of a formula
65 : // cell during import, having a double
66 : // and/or string result and a formula
67 : // string to be compiled.
68 :
69 : svHybridValueCell, // A temporary formula cell with an value
70 : // and possibily a string representation
71 :
72 : svExternalSingleRef,
73 : svExternalDoubleRef,
74 : svExternalName,
75 : svSingleVectorRef,
76 : svDoubleVectorRef,
77 : svSubroutine, // A token with a subroutine token array.
78 : svError, // error token
79 : svMissing = 0x70, // 0 or ""
80 : svSep, // separator, ocSep, ocOpen, ocClose
81 : svUnknown // unknown StackType
82 : };
83 :
84 : #ifndef DBG_UTIL
85 : // save memory since compilers tend to int an enum
86 : typedef sal_uInt8 StackVar;
87 : #else
88 : // have enum names in debugger
89 : typedef StackVarEnum StackVar;
90 : #endif
91 :
92 : class FormulaTokenArray;
93 :
94 : class FORMULA_DLLPUBLIC FormulaToken : public IFormulaToken
95 : {
96 : OpCode eOp;
97 : FormulaToken& operator=( const FormulaToken& ) SAL_DELETED_FUNCTION;
98 : protected:
99 :
100 : const StackVar eType; // type of data
101 : mutable oslInterlockedCount mnRefCnt; // reference count
102 :
103 : public:
104 : FormulaToken( StackVar eTypeP,OpCode e = ocPush );
105 : FormulaToken( const FormulaToken& r );
106 :
107 : virtual ~FormulaToken();
108 :
109 115612 : inline void Delete() { delete this; }
110 606734 : inline StackVar GetType() const { return eType; }
111 : bool IsFunction() const; // pure functions, no operators
112 :
113 : bool IsExternalRef() const;
114 : bool IsRef() const;
115 :
116 : sal_uInt8 GetParamCount() const;
117 :
118 424574 : inline void IncRef() const
119 : {
120 424574 : osl_atomic_increment(&mnRefCnt);
121 424574 : }
122 :
123 417610 : inline void DecRef() const
124 : {
125 417610 : if (!osl_atomic_decrement(&mnRefCnt))
126 115612 : const_cast<FormulaToken*>(this)->Delete();
127 417610 : }
128 :
129 17007 : inline oslInterlockedCount GetRef() const { return mnRefCnt; }
130 1684462 : inline OpCode GetOpCode() const { return eOp; }
131 :
132 : /**
133 : Dummy methods to avoid switches and casts where possible,
134 : the real token classes have to override the appropriate method[s].
135 : The only methods valid anytime if not overridden are:
136 :
137 : - GetByte() since this represents the count of parameters to a function
138 : which of course is 0 on non-functions. FormulaByteToken and ScExternal do
139 : override it.
140 :
141 : - HasForceArray() since also this is only used for operators and
142 : functions and is 0 for other tokens.
143 :
144 : Any other non-overridden method pops up an assertion.
145 : */
146 :
147 : virtual sal_uInt8 GetByte() const;
148 : virtual void SetByte( sal_uInt8 n );
149 : virtual bool HasForceArray() const;
150 : virtual void SetForceArray( bool b );
151 : virtual double GetDouble() const;
152 : virtual double& GetDoubleAsReference();
153 : virtual svl::SharedString GetString() const;
154 : virtual sal_uInt16 GetIndex() const;
155 : virtual void SetIndex( sal_uInt16 n );
156 : virtual bool IsGlobal() const;
157 : virtual void SetGlobal( bool b );
158 : virtual short* GetJump() const;
159 : virtual const OUString& GetExternal() const;
160 : virtual FormulaToken* GetFAPOrigToken() const;
161 : virtual sal_uInt16 GetError() const;
162 : virtual void SetError( sal_uInt16 );
163 :
164 : virtual const ScSingleRefData* GetSingleRef() const;
165 : virtual ScSingleRefData* GetSingleRef();
166 : virtual const ScComplexRefData* GetDoubleRef() const;
167 : virtual ScComplexRefData* GetDoubleRef();
168 : virtual const ScSingleRefData* GetSingleRef2() const;
169 : virtual ScSingleRefData* GetSingleRef2();
170 : virtual const ScMatrix* GetMatrix() const;
171 : virtual ScMatrix* GetMatrix();
172 : virtual ScJumpMatrix* GetJumpMatrix() const;
173 : virtual const std::vector<ScComplexRefData>* GetRefList() const;
174 : virtual std::vector<ScComplexRefData>* GetRefList();
175 :
176 4716 : virtual FormulaToken* Clone() const { return new FormulaToken(*this); }
177 :
178 : virtual bool TextEqual( const formula::FormulaToken& rToken ) const;
179 : virtual bool operator==( const FormulaToken& rToken ) const;
180 :
181 0 : virtual bool isFunction() const SAL_OVERRIDE
182 : {
183 0 : return IsFunction();
184 : }
185 :
186 0 : virtual sal_uInt32 getArgumentCount() const SAL_OVERRIDE
187 : {
188 0 : return GetParamCount();
189 : }
190 :
191 : /** This is dirty and only the compiler should use it! */
192 0 : struct PrivateAccess { friend class FormulaCompiler; private: PrivateAccess() { } };
193 0 : inline void NewOpCode( OpCode e, const PrivateAccess& ) { eOp = e; }
194 :
195 : static sal_Int32 GetStrLenBytes( sal_Int32 nLen )
196 : { return nLen * sizeof(sal_Unicode); }
197 : static sal_Int32 GetStrLenBytes( const OUString& rStr )
198 : { return GetStrLenBytes( rStr.getLength() ); }
199 : };
200 :
201 165502 : inline void intrusive_ptr_add_ref(const FormulaToken* p)
202 : {
203 165502 : p->IncRef();
204 165502 : }
205 :
206 165487 : inline void intrusive_ptr_release(const FormulaToken* p)
207 : {
208 165487 : p->DecRef();
209 165487 : }
210 :
211 54453 : class FORMULA_DLLPUBLIC FormulaByteToken : public FormulaToken
212 : {
213 : private:
214 : sal_uInt8 nByte;
215 : bool bHasForceArray;
216 : protected:
217 1700 : FormulaByteToken( OpCode e, sal_uInt8 n, StackVar v, bool b ) :
218 : FormulaToken( v,e ), nByte( n ),
219 1700 : bHasForceArray( b ) {}
220 : public:
221 12620 : FormulaByteToken( OpCode e, sal_uInt8 n, bool b ) :
222 : FormulaToken( svByte,e ), nByte( n ),
223 12620 : bHasForceArray( b ) {}
224 0 : FormulaByteToken( OpCode e, sal_uInt8 n ) :
225 : FormulaToken( svByte,e ), nByte( n ),
226 0 : bHasForceArray( false ) {}
227 15420 : FormulaByteToken( OpCode e ) :
228 : FormulaToken( svByte,e ), nByte( 0 ),
229 15420 : bHasForceArray( false ) {}
230 2638 : FormulaByteToken( const FormulaByteToken& r ) :
231 : FormulaToken( r ), nByte( r.nByte ),
232 2638 : bHasForceArray( r.bHasForceArray ) {}
233 :
234 2631 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaByteToken(*this); }
235 : virtual sal_uInt8 GetByte() const SAL_OVERRIDE;
236 : virtual void SetByte( sal_uInt8 n ) SAL_OVERRIDE;
237 : virtual bool HasForceArray() const SAL_OVERRIDE;
238 : virtual void SetForceArray( bool b ) SAL_OVERRIDE;
239 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
240 :
241 : DECL_FIXEDMEMPOOL_NEWDEL_DLL( FormulaByteToken )
242 : };
243 :
244 :
245 : // A special token for the FormulaAutoPilot only. Keeps a reference pointer of
246 : // the token of which it was created for comparison.
247 2 : class FORMULA_DLLPUBLIC FormulaFAPToken : public FormulaByteToken
248 : {
249 : private:
250 : FormulaTokenRef pOrigToken;
251 : public:
252 1 : FormulaFAPToken( OpCode e, sal_uInt8 n, FormulaToken* p ) :
253 : FormulaByteToken( e, n, svFAP, false ),
254 1 : pOrigToken( p ) {}
255 0 : FormulaFAPToken( const FormulaFAPToken& r ) :
256 0 : FormulaByteToken( r ), pOrigToken( r.pOrigToken ) {}
257 :
258 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaFAPToken(*this); }
259 : virtual FormulaToken* GetFAPOrigToken() const SAL_OVERRIDE;
260 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
261 : };
262 :
263 45398 : class FORMULA_DLLPUBLIC FormulaDoubleToken : public FormulaToken
264 : {
265 : private:
266 : double fDouble;
267 : public:
268 22291 : FormulaDoubleToken( double f ) :
269 22291 : FormulaToken( svDouble ), fDouble( f ) {}
270 1373 : FormulaDoubleToken( const FormulaDoubleToken& r ) :
271 1373 : FormulaToken( r ), fDouble( r.fDouble ) {}
272 :
273 1373 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaDoubleToken(*this); }
274 : virtual double GetDouble() const SAL_OVERRIDE;
275 : virtual double& GetDoubleAsReference() SAL_OVERRIDE;
276 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
277 :
278 : DECL_FIXEDMEMPOOL_NEWDEL_DLL( FormulaDoubleToken )
279 : };
280 :
281 :
282 8434 : class FORMULA_DLLPUBLIC FormulaStringToken : public FormulaToken
283 : {
284 : svl::SharedString maString;
285 : public:
286 : FormulaStringToken( const svl::SharedString& r );
287 : FormulaStringToken( const FormulaStringToken& r );
288 :
289 : virtual FormulaToken* Clone() const SAL_OVERRIDE;
290 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
291 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
292 :
293 : DECL_FIXEDMEMPOOL_NEWDEL_DLL( FormulaStringToken )
294 : };
295 :
296 :
297 : /** Identical to FormulaStringToken, but with explicit OpCode instead of implicit
298 : ocPush, and an optional sal_uInt8 for ocBad tokens. */
299 3408 : class FORMULA_DLLPUBLIC FormulaStringOpToken : public FormulaByteToken
300 : {
301 : svl::SharedString maString;
302 : public:
303 : FormulaStringOpToken( OpCode e, const svl::SharedString& r );
304 : FormulaStringOpToken( const FormulaStringOpToken& r );
305 :
306 : virtual FormulaToken* Clone() const SAL_OVERRIDE;
307 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
308 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
309 : };
310 :
311 354 : class FORMULA_DLLPUBLIC FormulaIndexToken : public FormulaToken
312 : {
313 : private:
314 : sal_uInt16 nIndex;
315 : bool mbGlobal;
316 : public:
317 133 : FormulaIndexToken( OpCode e, sal_uInt16 n, bool bGlobal = true ) :
318 133 : FormulaToken( svIndex, e ), nIndex( n ), mbGlobal( bGlobal ) {}
319 70 : FormulaIndexToken( const FormulaIndexToken& r ) :
320 70 : FormulaToken( r ), nIndex( r.nIndex ), mbGlobal( r.mbGlobal ) {}
321 :
322 70 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaIndexToken(*this); }
323 : virtual sal_uInt16 GetIndex() const SAL_OVERRIDE;
324 : virtual void SetIndex( sal_uInt16 n ) SAL_OVERRIDE;
325 : virtual bool IsGlobal() const SAL_OVERRIDE;
326 : virtual void SetGlobal( bool b ) SAL_OVERRIDE;
327 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
328 : };
329 :
330 :
331 104 : class FORMULA_DLLPUBLIC FormulaExternalToken : public FormulaToken
332 : {
333 : private:
334 : OUString aExternal;
335 : sal_uInt8 nByte;
336 : public:
337 101 : FormulaExternalToken( OpCode e, sal_uInt8 n, const OUString& r ) :
338 : FormulaToken( svExternal, e ), aExternal( r ),
339 101 : nByte( n ) {}
340 1 : FormulaExternalToken( OpCode e, const OUString& r ) :
341 : FormulaToken(svExternal, e ), aExternal( r ),
342 1 : nByte( 0 ) {}
343 0 : FormulaExternalToken( const FormulaExternalToken& r ) :
344 : FormulaToken( r ), aExternal( r.aExternal ),
345 0 : nByte( r.nByte ) {}
346 :
347 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaExternalToken(*this); }
348 : virtual const OUString& GetExternal() const SAL_OVERRIDE;
349 : virtual sal_uInt8 GetByte() const SAL_OVERRIDE;
350 : virtual void SetByte( sal_uInt8 n ) SAL_OVERRIDE;
351 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
352 : };
353 :
354 :
355 48 : class FORMULA_DLLPUBLIC FormulaMissingToken : public FormulaToken
356 : {
357 : public:
358 23 : FormulaMissingToken() :
359 23 : FormulaToken( svMissing,ocMissing ) {}
360 2 : FormulaMissingToken( const FormulaMissingToken& r ) :
361 2 : FormulaToken( r ) {}
362 :
363 2 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaMissingToken(*this); }
364 : virtual double GetDouble() const SAL_OVERRIDE;
365 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
366 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
367 : };
368 :
369 : class FORMULA_DLLPUBLIC FormulaJumpToken : public FormulaToken
370 : {
371 : private:
372 : short* pJump;
373 : bool bHasForceArray;
374 : public:
375 58 : FormulaJumpToken( OpCode e, short* p ) :
376 : FormulaToken( formula::svJump , e),
377 58 : bHasForceArray( false)
378 : {
379 58 : pJump = new short[ p[0] + 1 ];
380 58 : memcpy( pJump, p, (p[0] + 1) * sizeof(short) );
381 58 : }
382 22 : FormulaJumpToken( const FormulaJumpToken& r ) :
383 : FormulaToken( r ),
384 22 : bHasForceArray( r.bHasForceArray)
385 : {
386 22 : pJump = new short[ r.pJump[0] + 1 ];
387 22 : memcpy( pJump, r.pJump, (r.pJump[0] + 1) * sizeof(short) );
388 22 : }
389 : virtual ~FormulaJumpToken();
390 : virtual short* GetJump() const SAL_OVERRIDE;
391 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
392 22 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaJumpToken(*this); }
393 : virtual bool HasForceArray() const SAL_OVERRIDE;
394 : virtual void SetForceArray( bool b ) SAL_OVERRIDE;
395 : };
396 :
397 :
398 : class FORMULA_DLLPUBLIC FormulaSubroutineToken : public FormulaToken
399 : {
400 : public:
401 : /** Takes ownership of pArray and deletes it upon destruction! */
402 : FormulaSubroutineToken( const FormulaTokenArray* pArray ) :
403 : FormulaToken( svSubroutine, ocCall ), mpArray( pArray) {}
404 : FormulaSubroutineToken( const FormulaSubroutineToken& r );
405 : virtual ~FormulaSubroutineToken();
406 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaSubroutineToken(*this); }
407 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
408 :
409 : private:
410 : const FormulaTokenArray* mpArray;
411 : };
412 :
413 :
414 0 : class FORMULA_DLLPUBLIC FormulaUnknownToken : public FormulaToken
415 : {
416 : public:
417 0 : FormulaUnknownToken( OpCode e ) :
418 0 : FormulaToken( svUnknown, e ) {}
419 0 : FormulaUnknownToken( const FormulaUnknownToken& r ) :
420 0 : FormulaToken( r ) {}
421 :
422 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaUnknownToken(*this); }
423 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
424 : };
425 :
426 :
427 580 : class FORMULA_DLLPUBLIC FormulaErrorToken : public FormulaToken
428 : {
429 : sal_uInt16 nError;
430 : public:
431 290 : FormulaErrorToken( sal_uInt16 nErr ) :
432 290 : FormulaToken( svError ), nError( nErr) {}
433 0 : FormulaErrorToken( const FormulaErrorToken& r ) :
434 0 : FormulaToken( r ), nError( r.nError) {}
435 :
436 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new FormulaErrorToken(*this); }
437 : virtual sal_uInt16 GetError() const SAL_OVERRIDE;
438 : virtual void SetError( sal_uInt16 nErr ) SAL_OVERRIDE;
439 : virtual bool operator==( const FormulaToken& rToken ) const SAL_OVERRIDE;
440 : };
441 :
442 :
443 : } // formula
444 :
445 :
446 : #endif
447 :
448 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
