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
|
/* -*- 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 SC_FORMULARESULT_HXX
#define SC_FORMULARESULT_HXX
#include "token.hxx"
#include "scdllapi.h"
#include <sal/log.hxx>
/** Store a variable formula cell result, balancing between runtime performance
and memory consumption. */
class ScFormulaResult
{
typedef unsigned char Multiline;
static const Multiline MULTILINE_UNKNOWN = 0;
static const Multiline MULTILINE_FALSE = 1;
static const Multiline MULTILINE_TRUE = 2;
// Clone token if the 16-bit only reference counter is nearing it's
// capacity during fill or copy&paste, leaving 4k for temporary passing
// around. (That should be enough for all times (TM) ;-)
static const sal_uInt16 MAX_TOKENREF_COUNT = 0xf000;
static void IncrementTokenRef( const formula::FormulaToken* & rp )
{
if (rp)
{
if (rp->GetRef() >= MAX_TOKENREF_COUNT)
rp = rp->Clone();
rp->IncRef();
}
}
union
{
double mfValue; // double result direct for performance and memory consumption
const formula::FormulaToken* mpToken; // if not, result token obtained from interpreter
};
sal_uInt16 mnError; // error code
bool mbToken :1; // whether content of union is a token
bool mbEmpty :1; // empty cell result
bool mbEmptyDisplayedAsString :1; // only if mbEmpty
Multiline meMultiline :2; // result is multiline
/** Reset mnError, mbEmpty and mbEmptyDisplayedAsString to their defaults
prior to assigning other types */
void ResetToDefaults();
/** If token is of formula::svError set error code and decrement RefCount.
If token is of formula::svEmptyCell set mbEmpty and mbEmptyAsString and
decrement RefCount.
If token is of formula::svDouble set mfValue and decrement RefCount.
Else assign token to mpToken. NULL is valid => svUnknown.
Other member variables are set accordingly.
@precondition: Token MUST had been IncRef'ed prior to this call!
@precondition: An already existing different mpToken MUST had been
DecRef'ed prior to this call, p will be assigned to mpToken if not
resolved.
ATTENTION! Token may get deleted in this call! */
void ResolveToken( const formula::FormulaToken * p );
public:
/** Effectively type svUnknown. */
ScFormulaResult();
ScFormulaResult( const ScFormulaResult & r );
/** Same comments as for SetToken() apply! */
explicit ScFormulaResult( const formula::FormulaToken* p );
~ScFormulaResult();
/** Well, guess what ... */
ScFormulaResult& operator=( const ScFormulaResult & r );
/** Assignment as in operator=() but without return */
void Assign( const ScFormulaResult & r );
/** Sets a direct double if token type is formula::svDouble, or mbEmpty if
formula::svEmptyCell, else token. If p is NULL, that is set as well, effectively
resulting in GetType()==svUnknown. If the already existing result is
ScMatrixFormulaCellToken, the upper left ist set to token.
ATTENTION! formula::FormulaToken had to be allocated using 'new' and if of type
formula::svDouble and no RefCount was set may not be used after this call
because it was deleted after decrement! */
void SetToken( const formula::FormulaToken* p );
/** May be NULL if SetToken() did so, also if type formula::svDouble or formula::svError! */
formula::FormulaConstTokenRef GetToken() const;
/** Return upper left token if formula::svMatrixCell, else return GetToken().
May be NULL if SetToken() did so, also if type formula::svDouble or formula::svError! */
formula::FormulaConstTokenRef GetCellResultToken() const;
/** Return type of result, including formula::svError, formula::svEmptyCell, formula::svDouble and
formula::svMatrixCell. */
formula::StackVar GetType() const;
/** If type is formula::svMatrixCell return the type of upper left element, else
GetType() */
formula::StackVar GetCellResultType() const;
/** If type is formula::svEmptyCell (including matrix upper left) and should be
displayed as empty string */
bool IsEmptyDisplayedAsString() const;
/** Test for cell result type formula::svDouble, including upper left if
formula::svMatrixCell. Also included is formula::svError for legacy, because previously
an error result was treated like a numeric value at some places in
ScFormulaCell. Also included is formula::svEmptyCell as a reference to an empty
cell usually is treated as numeric 0. Use GetCellResultType() for
details instead. */
bool IsValue() const;
/** Determines whether or not the result is a string containing more than
one paragraph */
bool IsMultiline() const;
/** Get error code if set or GetCellResultType() is formula::svError or svUnknown,
else 0. */
sal_uInt16 GetResultError() const;
/** Set error code, don't touch token or double. */
void SetResultError( sal_uInt16 nErr );
/** Set direct double. Shouldn't be used externally except in
ScFormulaCell for rounded CalcAsShown or SetErrCode() or
SetResultDouble(), see there for condition. If
ScMatrixFormulaCellToken the token isn't replaced but upper
left result is modified instead, but only if it was of type
formula::svDouble before or not set at all.
*/
SC_DLLPUBLIC void SetDouble( double f );
/** Return value if type formula::svDouble or formula::svHybridCell or formula::svMatrixCell and upper
left formula::svDouble, else 0.0 */
double GetDouble() const;
/** Return string if type formula::svString or formula::svHybridCell or formula::svMatrixCell and
upper left formula::svString, else empty string. */
const String& GetString() const;
/** Return matrix if type formula::svMatrixCell and ScMatrix present, else NULL. */
ScConstMatrixRef GetMatrix() const;
/** Return formula string if type formula::svHybridCell, else empty string. */
const String& GetHybridFormula() const;
/** Should only be used by import filters, best in the order
SetHybridDouble(), SetHybridString(), or only SetHybridString() for
formula string to be compiled later. */
SC_DLLPUBLIC void SetHybridDouble( double f );
/** Should only be used by import filters, best in the order
SetHybridDouble(), SetHybridString()/SetHybridFormula(), or only
SetHybridFormula() for formula string to be compiled later. */
SC_DLLPUBLIC void SetHybridString( const rtl::OUString & rStr );
/** Should only be used by import filters, best in the order
SetHybridDouble(), SetHybridString()/SetHybridFormula(), or only
SetHybridFormula() for formula string to be compiled later. */
SC_DLLPUBLIC void SetHybridFormula( const String & rFormula );
SC_DLLPUBLIC void SetMatrix( SCCOL nCols, SCROW nRows, const ScConstMatrixRef& pMat, formula::FormulaToken* pUL );
/** Get the const ScMatrixFormulaCellToken* if token is of that type, else
NULL. */
const ScMatrixFormulaCellToken* GetMatrixFormulaCellToken() const;
/** Get the ScMatrixFormulaCellToken* if token is of that type, else NULL.
Shouldn't be used externally except by ScFormulaCell::SetMatColsRows(). */
ScMatrixFormulaCellToken* GetMatrixFormulaCellTokenNonConst();
};
#endif // SC_FORMULARESULT_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
