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
|
/* -*- 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_SC_INC_RECURSIONHELPER_HXX
#define INCLUDED_SC_INC_RECURSIONHELPER_HXX
#include "formularesult.hxx"
#include <list>
#include <vector>
#include <stack>
#include <o3tl/sorted_vector.hxx>
class ScFormulaCell;
struct ScFormulaRecursionEntry
{
ScFormulaCell* pCell;
bool bOldRunning;
ScFormulaResult aPreviousResult;
ScFormulaRecursionEntry(
ScFormulaCell* p, bool bR, const ScFormulaResult & rRes ) :
pCell(p), bOldRunning(bR), aPreviousResult( rRes)
{
}
};
typedef ::std::list< ScFormulaRecursionEntry > ScFormulaRecursionList;
class ScRecursionHelper
{
typedef ::std::stack< ScFormulaCell* > ScRecursionInIterationStack;
typedef ::std::vector< ScFormulaCell* > ScFGList;
ScFormulaRecursionList aRecursionFormulas;
ScFormulaRecursionList::iterator aInsertPos;
ScFormulaRecursionList::iterator aLastIterationStart;
ScRecursionInIterationStack aRecursionInIterationStack;
ScFGList aFGList;
// Flag list corresponding to aFGList to indicate whether each formula-group
// is in a dependency evaluation mode or not.
std::vector< bool > aInDependencyEvalMode;
sal_uInt16 nRecursionCount;
sal_uInt16 nIteration;
// Count of ScFormulaCell::CheckComputeDependencies in current call-stack.
sal_uInt16 nDependencyComputationLevel;
bool bInRecursionReturn;
bool bDoingRecursion;
bool bInIterationReturn;
bool bConverging;
bool bGroupsIndependent;
bool bAbortingDependencyComputation;
std::vector< ScFormulaCell* > aTemporaryGroupCells;
o3tl::sorted_vector< ScFormulaCellGroup* >* pFGSet;
void Init();
void ResetIteration();
public:
ScRecursionHelper();
sal_uInt16 GetRecursionCount() const { return nRecursionCount; }
void IncRecursionCount() { ++nRecursionCount; }
void DecRecursionCount() { --nRecursionCount; }
sal_uInt16 GetDepComputeLevel() const { return nDependencyComputationLevel; }
void IncDepComputeLevel();
void DecDepComputeLevel();
/// A pure recursion return, no iteration.
bool IsInRecursionReturn() const { return bInRecursionReturn &&
!bInIterationReturn; }
void SetInRecursionReturn( bool b );
bool IsDoingRecursion() const { return bDoingRecursion; }
void SetDoingRecursion( bool b ) { bDoingRecursion = b; }
void Insert( ScFormulaCell* p, bool bOldRunning, const ScFormulaResult & rRes );
bool IsInIterationReturn() const { return bInIterationReturn; }
void SetInIterationReturn( bool b );
bool IsDoingIteration() const { return nIteration > 0; }
sal_uInt16 GetIteration() const { return nIteration; }
bool & GetConvergingReference() { return bConverging; }
void StartIteration();
void ResumeIteration();
void IncIteration();
void EndIteration();
const ScFormulaRecursionList::iterator& GetLastIterationStart() const { return aLastIterationStart; }
ScFormulaRecursionList::iterator GetIterationStart();
ScFormulaRecursionList::iterator GetIterationEnd();
/** Any return, recursion or iteration, iteration is always coupled with
recursion. */
bool IsInReturn() const { return bInRecursionReturn; }
const ScFormulaRecursionList& GetList() const { return aRecursionFormulas; }
ScFormulaRecursionList& GetList() { return aRecursionFormulas; }
ScRecursionInIterationStack& GetRecursionInIterationStack() { return aRecursionInIterationStack; }
void Clear();
/** Detects a simple cycle involving formula-groups and singleton formula-cells. */
bool PushFormulaGroup(ScFormulaCell* pCell);
void PopFormulaGroup();
bool AnyCycleMemberInDependencyEvalMode(ScFormulaCell* pCell);
bool AnyParentFGInCycle();
void SetFormulaGroupDepEvalMode(bool bSet);
// When dependency computation detects a cycle, it may not compute proper cell values.
// This sets a flag that ScFormulaCell will use to avoid setting those new values
// and resetting the dirty flag, until the dependency computation bails out.
void AbortDependencyComputation();
bool IsAbortingDependencyComputation() const { return bAbortingDependencyComputation; }
void AddTemporaryGroupCell(ScFormulaCell* cell);
void CleanTemporaryGroupCells();
void SetFormulaGroupSet(o3tl::sorted_vector<ScFormulaCellGroup*>* pSet) { pFGSet = pSet; }
bool HasFormulaGroupSet() { return pFGSet != nullptr; }
bool CheckFGIndependence(ScFormulaCellGroup* pFG);
void SetGroupsIndependent(bool bSet) { bGroupsIndependent = bSet; }
bool AreGroupsIndependent() { return bGroupsIndependent; }
};
/** A class to wrap ScRecursionHelper::PushFormulaGroup(),
ScRecursionHelper::PopFormulaGroup() and make these calls
exception safe. */
class ScFormulaGroupCycleCheckGuard
{
ScRecursionHelper& mrRecHelper;
bool mbShouldPop;
public:
ScFormulaGroupCycleCheckGuard() = delete;
ScFormulaGroupCycleCheckGuard(ScRecursionHelper& rRecursionHelper, ScFormulaCell* pCell);
~ScFormulaGroupCycleCheckGuard();
};
class ScFormulaGroupDependencyComputeGuard
{
ScRecursionHelper& mrRecHelper;
public:
ScFormulaGroupDependencyComputeGuard() = delete;
ScFormulaGroupDependencyComputeGuard(ScRecursionHelper& rRecursionHelper);
~ScFormulaGroupDependencyComputeGuard();
};
class ScCheckIndependentFGGuard
{
ScRecursionHelper& mrRecHelper;
bool mbUsedFGSet;
public:
ScCheckIndependentFGGuard() = delete;
ScCheckIndependentFGGuard(ScRecursionHelper& rRecursionHelper,
o3tl::sorted_vector<ScFormulaCellGroup*>* pSet);
~ScCheckIndependentFGGuard();
bool AreGroupsIndependent();
};
#endif // INCLUDED_SC_INC_RECURSIONHELPER_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
