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_SC_INC_TOKEN_HXX
21 : #define INCLUDED_SC_INC_TOKEN_HXX
22 :
23 : #include <vector>
24 : #include <boost/intrusive_ptr.hpp>
25 :
26 : #include <formula/opcode.hxx>
27 : #include "refdata.hxx"
28 : #include <tools/mempool.hxx>
29 : #include "scdllapi.h"
30 : #include <formula/IFunctionDescription.hxx>
31 : #include <formula/token.hxx>
32 : #include "calcmacros.hxx"
33 : #include "types.hxx"
34 :
35 : // Matrix token constants.
36 : #define MATRIX_TOKEN_HAS_RANGE 1
37 :
38 : namespace sc {
39 :
40 : struct RangeMatrix;
41 :
42 : }
43 :
44 : class ScJumpMatrix;
45 : class ScMatrix;
46 :
47 : typedef ::std::vector< ScComplexRefData > ScRefList;
48 :
49 : #if DEBUG_FORMULA_COMPILER
50 : void DumpToken(formula::FormulaToken const & rToken);
51 : #endif
52 :
53 : /** If rTok1 and rTok2 both are SingleRef or DoubleRef tokens, extend/merge
54 : ranges as needed for ocRange.
55 : @param rPos
56 : The formula's position, used to calculate absolute positions from
57 : relative references.
58 : @param bReuseDoubleRef
59 : If true, a DoubleRef token is reused if passed as rTok1 or rTok2,
60 : else a new DoubleRef token is created and returned.
61 : @return
62 : A reused or new'ed ScDoubleRefToken, or a NULL TokenRef if rTok1 or
63 : rTok2 are not of sv(Single|Double)Ref
64 : */
65 : formula::FormulaTokenRef extendRangeReference( formula::FormulaToken & rTok1, formula::FormulaToken & rTok2, const ScAddress & rPos, bool bReuseDoubleRef );
66 :
67 62308 : class ScSingleRefToken : public formula::FormulaToken
68 : {
69 : private:
70 : ScSingleRefData aSingleRef;
71 : public:
72 16652 : ScSingleRefToken( const ScSingleRefData& r, OpCode e = ocPush ) :
73 16652 : FormulaToken( formula::svSingleRef, e ), aSingleRef( r ) {}
74 14665 : ScSingleRefToken( const ScSingleRefToken& r ) :
75 14665 : FormulaToken( r ), aSingleRef( r.aSingleRef ) {}
76 : virtual const ScSingleRefData* GetSingleRef() const SAL_OVERRIDE;
77 : virtual ScSingleRefData* GetSingleRef() SAL_OVERRIDE;
78 : virtual bool TextEqual( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
79 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
80 14665 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScSingleRefToken(*this); }
81 :
82 62471 : DECL_FIXEDMEMPOOL_NEWDEL( ScSingleRefToken );
83 : };
84 :
85 27270 : class ScDoubleRefToken : public formula::FormulaToken
86 : {
87 : private:
88 : ScComplexRefData aDoubleRef;
89 : public:
90 11333 : ScDoubleRefToken( const ScComplexRefData& r, OpCode e = ocPush ) :
91 11333 : FormulaToken( formula::svDoubleRef, e ), aDoubleRef( r ) {}
92 : ScDoubleRefToken( const ScSingleRefData& r, OpCode e = ocPush ) :
93 : FormulaToken( formula::svDoubleRef, e )
94 : {
95 : aDoubleRef.Ref1 = r;
96 : aDoubleRef.Ref2 = r;
97 : }
98 2470 : ScDoubleRefToken( const ScDoubleRefToken& r ) :
99 2470 : FormulaToken( r ), aDoubleRef( r.aDoubleRef ) {}
100 : virtual const ScSingleRefData* GetSingleRef() const SAL_OVERRIDE;
101 : virtual ScSingleRefData* GetSingleRef() SAL_OVERRIDE;
102 : virtual const ScComplexRefData* GetDoubleRef() const SAL_OVERRIDE;
103 : virtual ScComplexRefData* GetDoubleRef() SAL_OVERRIDE;
104 : virtual const ScSingleRefData* GetSingleRef2() const SAL_OVERRIDE;
105 : virtual ScSingleRefData* GetSingleRef2() SAL_OVERRIDE;
106 : virtual bool TextEqual( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
107 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
108 2470 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScDoubleRefToken(*this); }
109 :
110 27438 : DECL_FIXEDMEMPOOL_NEWDEL( ScDoubleRefToken );
111 : };
112 :
113 1130 : class ScMatrixToken : public formula::FormulaToken
114 : {
115 : private:
116 : ScMatrixRef pMatrix;
117 : public:
118 : ScMatrixToken( const ScMatrixRef& p );
119 : ScMatrixToken( const ScMatrixToken& r );
120 :
121 : virtual const ScMatrix* GetMatrix() const SAL_OVERRIDE;
122 : virtual ScMatrix* GetMatrix() SAL_OVERRIDE;
123 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
124 21 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScMatrixToken(*this); }
125 : };
126 :
127 : /**
128 : * Token storing matrix that represents values in sheet range. It stores
129 : * both the values in matrix form, and the range address the matrix
130 : * represents.
131 : */
132 0 : class ScMatrixRangeToken : public formula::FormulaToken
133 : {
134 : ScMatrixRef mpMatrix;
135 : ScComplexRefData maRef;
136 : public:
137 : ScMatrixRangeToken( const ScMatrixRef& p, const ScComplexRefData& rRef );
138 : ScMatrixRangeToken( const sc::RangeMatrix& rMat );
139 : ScMatrixRangeToken( const ScMatrixRangeToken& r );
140 :
141 : virtual sal_uInt8 GetByte() const SAL_OVERRIDE;
142 : virtual const ScMatrix* GetMatrix() const SAL_OVERRIDE;
143 : virtual ScMatrix* GetMatrix() SAL_OVERRIDE;
144 : virtual const ScComplexRefData* GetDoubleRef() const SAL_OVERRIDE;
145 : virtual ScComplexRefData* GetDoubleRef() SAL_OVERRIDE;
146 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
147 : virtual FormulaToken* Clone() const SAL_OVERRIDE;
148 : };
149 :
150 : class ScExternalSingleRefToken : public formula::FormulaToken
151 : {
152 : sal_uInt16 mnFileId;
153 : svl::SharedString maTabName;
154 : ScSingleRefData maSingleRef;
155 :
156 : ScExternalSingleRefToken(); // disabled
157 : public:
158 : ScExternalSingleRefToken( sal_uInt16 nFileId, const svl::SharedString& rTabName, const ScSingleRefData& r );
159 : ScExternalSingleRefToken( const ScExternalSingleRefToken& r );
160 : virtual ~ScExternalSingleRefToken();
161 :
162 : virtual sal_uInt16 GetIndex() const SAL_OVERRIDE;
163 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
164 : virtual const ScSingleRefData* GetSingleRef() const SAL_OVERRIDE;
165 : virtual ScSingleRefData* GetSingleRef() SAL_OVERRIDE;
166 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
167 103 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScExternalSingleRefToken(*this); }
168 : };
169 :
170 : class ScExternalDoubleRefToken : public formula::FormulaToken
171 : {
172 : sal_uInt16 mnFileId;
173 : svl::SharedString maTabName; // name of the first sheet
174 : ScComplexRefData maDoubleRef;
175 :
176 : ScExternalDoubleRefToken(); // disabled
177 : public:
178 : ScExternalDoubleRefToken( sal_uInt16 nFileId, const svl::SharedString& rTabName, const ScComplexRefData& r );
179 : ScExternalDoubleRefToken( const ScExternalDoubleRefToken& r );
180 : virtual ~ScExternalDoubleRefToken();
181 :
182 : virtual sal_uInt16 GetIndex() const SAL_OVERRIDE;
183 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
184 : virtual const ScSingleRefData* GetSingleRef() const SAL_OVERRIDE;
185 : virtual ScSingleRefData* GetSingleRef() SAL_OVERRIDE;
186 : virtual const ScSingleRefData* GetSingleRef2() const SAL_OVERRIDE;
187 : virtual ScSingleRefData* GetSingleRef2() SAL_OVERRIDE;
188 : virtual const ScComplexRefData* GetDoubleRef() const SAL_OVERRIDE;
189 : virtual ScComplexRefData* GetDoubleRef() SAL_OVERRIDE;
190 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
191 1 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScExternalDoubleRefToken(*this); }
192 : };
193 :
194 : class ScExternalNameToken : public formula::FormulaToken
195 : {
196 : sal_uInt16 mnFileId;
197 : svl::SharedString maName;
198 :
199 : ScExternalNameToken(); // disabled
200 : public:
201 : ScExternalNameToken( sal_uInt16 nFileId, const svl::SharedString& rName );
202 : ScExternalNameToken( const ScExternalNameToken& r );
203 : virtual ~ScExternalNameToken();
204 :
205 : virtual sal_uInt16 GetIndex() const SAL_OVERRIDE;
206 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
207 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
208 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScExternalNameToken(*this); }
209 : };
210 :
211 : /** Special token to remember details of ocTableRef "structured references". */
212 : class ScTableRefToken : public formula::FormulaToken
213 : {
214 : public:
215 :
216 : enum Item
217 : {
218 : TABLE = 0,
219 : ALL = 1,
220 : HEADERS = 2,
221 : DATA = 4,
222 : TOTALS = 8,
223 : THIS_ROW = 16,
224 : HEADERS_DATA = HEADERS | DATA,
225 : DATA_TOTALS = DATA | TOTALS
226 : };
227 :
228 : ScTableRefToken( sal_uInt16 nIndex, Item eItem );
229 : ScTableRefToken( const ScTableRefToken& r );
230 : virtual ~ScTableRefToken();
231 :
232 : virtual sal_uInt16 GetIndex() const SAL_OVERRIDE;
233 : virtual void SetIndex( sal_uInt16 n ) SAL_OVERRIDE;
234 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
235 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScTableRefToken(*this); }
236 :
237 : Item GetItem() const;
238 : void AddItem( Item );
239 : void SetAreaRefRPN( formula::FormulaToken* pToken );
240 : const formula::FormulaToken* GetAreaRefRPN() const;
241 :
242 : private:
243 :
244 : formula::FormulaTokenRef mxAreaRefRPN; ///< resulting RPN area
245 : sal_uInt16 mnIndex; ///< index into table / database range collection
246 : Item meItem;
247 :
248 : ScTableRefToken(); // disabled
249 :
250 : };
251 :
252 : // Only created from within the interpreter, no conversion from ScRawToken,
253 : // never added to ScTokenArray!
254 : class ScJumpMatrixToken : public formula::FormulaToken
255 : {
256 : private:
257 : ScJumpMatrix* pJumpMatrix;
258 : public:
259 10 : ScJumpMatrixToken( ScJumpMatrix* p ) :
260 10 : FormulaToken( formula::svJumpMatrix ), pJumpMatrix( p ) {}
261 0 : ScJumpMatrixToken( const ScJumpMatrixToken& r ) :
262 0 : FormulaToken( r ), pJumpMatrix( r.pJumpMatrix ) {}
263 : virtual ~ScJumpMatrixToken();
264 : virtual ScJumpMatrix* GetJumpMatrix() const SAL_OVERRIDE;
265 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
266 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScJumpMatrixToken(*this); }
267 : };
268 :
269 : // Only created from within the interpreter, no conversion from ScRawToken,
270 : // never added to ScTokenArray!
271 6 : class ScRefListToken : public formula::FormulaToken
272 : {
273 : private:
274 : ScRefList aRefList;
275 : public:
276 3 : ScRefListToken() :
277 3 : FormulaToken( formula::svRefList ) {}
278 0 : ScRefListToken( const ScRefListToken & r ) :
279 0 : FormulaToken( r ), aRefList( r.aRefList ) {}
280 : virtual const ScRefList* GetRefList() const SAL_OVERRIDE;
281 : virtual ScRefList* GetRefList() SAL_OVERRIDE;
282 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
283 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScRefListToken(*this); }
284 : };
285 :
286 1488 : class SC_DLLPUBLIC ScEmptyCellToken : public formula::FormulaToken
287 : {
288 : bool bInherited :1;
289 : bool bDisplayedAsString :1;
290 : public:
291 742 : explicit ScEmptyCellToken( bool bInheritedP, bool bDisplayAsString ) :
292 : FormulaToken( formula::svEmptyCell ),
293 : bInherited( bInheritedP ),
294 742 : bDisplayedAsString( bDisplayAsString ) {}
295 2 : ScEmptyCellToken( const ScEmptyCellToken& r ) :
296 : FormulaToken( r ),
297 : bInherited( r.bInherited ),
298 2 : bDisplayedAsString( r.bDisplayedAsString ) {}
299 0 : bool IsInherited() const { return bInherited; }
300 730 : bool IsDisplayedAsString() const { return bDisplayedAsString; }
301 : virtual double GetDouble() const SAL_OVERRIDE;
302 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
303 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
304 2 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScEmptyCellToken(*this); }
305 : };
306 :
307 : /** Transports the result from the interpreter to the formula cell. */
308 : class SC_DLLPUBLIC ScMatrixCellResultToken : public formula::FormulaToken
309 : {
310 : // No non-const access implemented, silence down unxsols4 complaining about
311 : // the public GetMatrix() hiding the one from FormulaToken.
312 : virtual ScMatrix* GetMatrix() SAL_OVERRIDE;
313 :
314 : protected:
315 : ScConstMatrixRef xMatrix;
316 : formula::FormulaConstTokenRef xUpperLeft;
317 : public:
318 : ScMatrixCellResultToken( const ScConstMatrixRef& pMat, formula::FormulaToken* pUL );
319 : ScMatrixCellResultToken( const ScMatrixCellResultToken& r );
320 : virtual ~ScMatrixCellResultToken();
321 : virtual double GetDouble() const SAL_OVERRIDE;
322 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
323 : virtual const ScMatrix* GetMatrix() const SAL_OVERRIDE;
324 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
325 : virtual FormulaToken* Clone() const SAL_OVERRIDE;
326 1382 : formula::StackVar GetUpperLeftType() const
327 : {
328 : return xUpperLeft ?
329 1326 : xUpperLeft->GetType() :
330 2708 : static_cast<formula::StackVar>(formula::svUnknown);
331 : }
332 431 : inline formula::FormulaConstTokenRef GetUpperLeftToken() const { return xUpperLeft; }
333 : void Assign( const ScMatrixCellResultToken & r );
334 : };
335 :
336 : /** Stores the matrix result at the formula cell, additionally the range the
337 : matrix formula occupies. */
338 : class SC_DLLPUBLIC ScMatrixFormulaCellToken : public ScMatrixCellResultToken
339 : {
340 : private:
341 : SCROW nRows;
342 : SCCOL nCols;
343 : public:
344 : ScMatrixFormulaCellToken( SCCOL nC, SCROW nR, const ScConstMatrixRef& pMat, formula::FormulaToken* pUL );
345 : ScMatrixFormulaCellToken( SCCOL nC, SCROW nR );
346 : ScMatrixFormulaCellToken( const ScMatrixFormulaCellToken& r );
347 : virtual ~ScMatrixFormulaCellToken();
348 :
349 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
350 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScMatrixFormulaCellToken(*this); }
351 0 : void SetMatColsRows( SCCOL nC, SCROW nR )
352 : {
353 0 : nRows = nR;
354 0 : nCols = nC;
355 0 : }
356 30 : void GetMatColsRows( SCCOL & nC, SCROW & nR ) const
357 : {
358 30 : nR = nRows;
359 30 : nC = nCols;
360 30 : }
361 36 : SCCOL GetMatCols() const { return nCols; }
362 36 : SCROW GetMatRows() const { return nRows; }
363 :
364 : /** Assign matrix result, keep matrix formula
365 : dimension. */
366 : void Assign( const ScMatrixCellResultToken & r );
367 :
368 : /** Assign any result, keep matrix formula
369 : dimension. If token is of type
370 : ScMatrixCellResultToken uses the
371 : appropriate Assign() call, other tokens
372 : are assigned to xUpperLeft and xMatrix will
373 : be assigned NULL. */
374 : void Assign( const formula::FormulaToken & r );
375 :
376 : /** Modify xUpperLeft if formula::svDouble, or create
377 : new formula::FormulaDoubleToken if not set yet. Does
378 : nothing if xUpperLeft is of different type! */
379 : void SetUpperLeftDouble( double f);
380 :
381 : /** Reset matrix and upper left, keep matrix
382 : formula dimension. */
383 : void ResetResult();
384 : };
385 :
386 322 : class SC_DLLPUBLIC ScHybridCellToken : public formula::FormulaToken
387 : {
388 : private:
389 : double mfDouble;
390 : svl::SharedString maString;
391 : OUString maFormula;
392 : public:
393 : ScHybridCellToken(
394 : double f, const svl::SharedString & rStr, const OUString & rFormula );
395 :
396 5 : const OUString& GetFormula() const { return maFormula; }
397 : virtual double GetDouble() const SAL_OVERRIDE;
398 :
399 : virtual svl::SharedString GetString() const SAL_OVERRIDE;
400 : virtual bool operator==( const formula::FormulaToken& rToken ) const SAL_OVERRIDE;
401 0 : virtual FormulaToken* Clone() const SAL_OVERRIDE { return new ScHybridCellToken(*this); }
402 : };
403 :
404 : // Simplify argument passing to RefUpdate methods with ScSingleRefToken or
405 : // ScDoubleRefToken
406 : class SingleDoubleRefModifier
407 : {
408 : ScComplexRefData aDub;
409 : ScSingleRefData* pS;
410 : ScComplexRefData* pD;
411 :
412 : SingleDoubleRefModifier( const SingleDoubleRefModifier& ) SAL_DELETED_FUNCTION;
413 : SingleDoubleRefModifier& operator=( const SingleDoubleRefModifier& ) SAL_DELETED_FUNCTION;
414 :
415 : public:
416 0 : SingleDoubleRefModifier( formula::FormulaToken& rT )
417 : {
418 0 : formula::StackVar eType = rT.GetType();
419 0 : if ( eType == formula::svSingleRef || eType == formula::svExternalSingleRef )
420 : {
421 0 : pS = rT.GetSingleRef();
422 0 : aDub.Ref1 = aDub.Ref2 = *pS;
423 0 : pD = &aDub;
424 : }
425 : else
426 : {
427 0 : pS = 0;
428 0 : pD = rT.GetDoubleRef();
429 : // aDub intentionally not initialized, unnecessary
430 : // because unused.
431 : }
432 0 : }
433 604 : SingleDoubleRefModifier( ScSingleRefData& rS )
434 : {
435 604 : pS = &rS;
436 604 : aDub.Ref1 = aDub.Ref2 = *pS;
437 604 : pD = &aDub;
438 604 : }
439 604 : ~SingleDoubleRefModifier()
440 : {
441 604 : if ( pS )
442 604 : *pS = (*pD).Ref1;
443 604 : }
444 604 : inline ScComplexRefData& Ref() { return *pD; }
445 : };
446 :
447 : class SingleDoubleRefProvider
448 : {
449 : public:
450 :
451 : const ScSingleRefData& Ref1;
452 : const ScSingleRefData& Ref2;
453 :
454 3062 : SingleDoubleRefProvider( const formula::FormulaToken& r )
455 3062 : : Ref1( *r.GetSingleRef() ),
456 4861 : Ref2( (r.GetType() == formula::svDoubleRef ||
457 1799 : r.GetType() == formula::svExternalDoubleRef) ?
458 7387 : r.GetDoubleRef()->Ref2 : Ref1 )
459 3062 : {}
460 : SingleDoubleRefProvider( const ScSingleRefData& r )
461 : : Ref1( r ), Ref2( r )
462 : {}
463 : SingleDoubleRefProvider( const ScComplexRefData& r )
464 : : Ref1( r.Ref1 ), Ref2( r.Ref2 )
465 : {}
466 3062 : ~SingleDoubleRefProvider()
467 3062 : {}
468 : };
469 :
470 : #endif
471 :
472 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
