1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_RECURSIONHELPER_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_RECURSIONHELPER_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include "formularesult.hxx" 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include <list> 30*b1cdbd2cSJim Jagielski #include <stack> 31*b1cdbd2cSJim Jagielski #include <tools/solar.h> 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski class ScFormulaCell; 34*b1cdbd2cSJim Jagielski 35*b1cdbd2cSJim Jagielski struct ScFormulaRecursionEntry 36*b1cdbd2cSJim Jagielski { 37*b1cdbd2cSJim Jagielski ScFormulaCell* pCell; 38*b1cdbd2cSJim Jagielski sal_Bool bOldRunning; 39*b1cdbd2cSJim Jagielski ScFormulaResult aPreviousResult; ScFormulaRecursionEntryScFormulaRecursionEntry40*b1cdbd2cSJim Jagielski ScFormulaRecursionEntry( ScFormulaCell* p, sal_Bool bR, 41*b1cdbd2cSJim Jagielski const ScFormulaResult & rRes ) : 42*b1cdbd2cSJim Jagielski pCell(p), bOldRunning(bR), aPreviousResult( rRes) 43*b1cdbd2cSJim Jagielski { 44*b1cdbd2cSJim Jagielski } 45*b1cdbd2cSJim Jagielski }; 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski typedef ::std::list< ScFormulaRecursionEntry > ScFormulaRecursionList; 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski class ScRecursionHelper 50*b1cdbd2cSJim Jagielski { 51*b1cdbd2cSJim Jagielski typedef ::std::stack< ScFormulaCell* > ScRecursionInIterationStack; 52*b1cdbd2cSJim Jagielski ScFormulaRecursionList aRecursionFormulas; 53*b1cdbd2cSJim Jagielski ScFormulaRecursionList::iterator aInsertPos; 54*b1cdbd2cSJim Jagielski ScFormulaRecursionList::iterator aLastIterationStart; 55*b1cdbd2cSJim Jagielski ScRecursionInIterationStack aRecursionInIterationStack; 56*b1cdbd2cSJim Jagielski sal_uInt16 nRecursionCount; 57*b1cdbd2cSJim Jagielski sal_uInt16 nIteration; 58*b1cdbd2cSJim Jagielski bool bInRecursionReturn; 59*b1cdbd2cSJim Jagielski bool bDoingRecursion; 60*b1cdbd2cSJim Jagielski bool bInIterationReturn; 61*b1cdbd2cSJim Jagielski bool bConverging; 62*b1cdbd2cSJim Jagielski Init()63*b1cdbd2cSJim Jagielski void Init() 64*b1cdbd2cSJim Jagielski { 65*b1cdbd2cSJim Jagielski nRecursionCount = 0; 66*b1cdbd2cSJim Jagielski bInRecursionReturn = bDoingRecursion = bInIterationReturn = false; 67*b1cdbd2cSJim Jagielski aInsertPos = GetEnd(); 68*b1cdbd2cSJim Jagielski ResetIteration(); 69*b1cdbd2cSJim Jagielski } ResetIteration()70*b1cdbd2cSJim Jagielski void ResetIteration() 71*b1cdbd2cSJim Jagielski { 72*b1cdbd2cSJim Jagielski aLastIterationStart = GetEnd(); 73*b1cdbd2cSJim Jagielski nIteration = 0; 74*b1cdbd2cSJim Jagielski bConverging = false; 75*b1cdbd2cSJim Jagielski } 76*b1cdbd2cSJim Jagielski 77*b1cdbd2cSJim Jagielski public: 78*b1cdbd2cSJim Jagielski ScRecursionHelper()79*b1cdbd2cSJim Jagielski ScRecursionHelper() { Init(); } GetRecursionCount() const80*b1cdbd2cSJim Jagielski sal_uInt16 GetRecursionCount() const { return nRecursionCount; } IncRecursionCount()81*b1cdbd2cSJim Jagielski void IncRecursionCount() { ++nRecursionCount; } DecRecursionCount()82*b1cdbd2cSJim Jagielski void DecRecursionCount() { --nRecursionCount; } 83*b1cdbd2cSJim Jagielski /// A pure recursion return, no iteration. IsInRecursionReturn() const84*b1cdbd2cSJim Jagielski bool IsInRecursionReturn() const { return bInRecursionReturn && 85*b1cdbd2cSJim Jagielski !bInIterationReturn; } SetInRecursionReturn(bool b)86*b1cdbd2cSJim Jagielski void SetInRecursionReturn( bool b ) 87*b1cdbd2cSJim Jagielski { 88*b1cdbd2cSJim Jagielski // Do not use IsInRecursionReturn() here, it decouples iteration. 89*b1cdbd2cSJim Jagielski if (b && !bInRecursionReturn) 90*b1cdbd2cSJim Jagielski aInsertPos = aRecursionFormulas.begin(); 91*b1cdbd2cSJim Jagielski bInRecursionReturn = b; 92*b1cdbd2cSJim Jagielski } IsDoingRecursion() const93*b1cdbd2cSJim Jagielski bool IsDoingRecursion() const { return bDoingRecursion; } SetDoingRecursion(bool b)94*b1cdbd2cSJim Jagielski void SetDoingRecursion( bool b ) { bDoingRecursion = b; } Insert(ScFormulaCell * p,sal_Bool bOldRunning,const ScFormulaResult & rRes)95*b1cdbd2cSJim Jagielski void Insert( ScFormulaCell* p, sal_Bool bOldRunning, 96*b1cdbd2cSJim Jagielski const ScFormulaResult & rRes ) 97*b1cdbd2cSJim Jagielski { 98*b1cdbd2cSJim Jagielski aRecursionFormulas.insert( aInsertPos, ScFormulaRecursionEntry( p, 99*b1cdbd2cSJim Jagielski bOldRunning, rRes)); 100*b1cdbd2cSJim Jagielski } GetStart()101*b1cdbd2cSJim Jagielski ScFormulaRecursionList::iterator GetStart() 102*b1cdbd2cSJim Jagielski { 103*b1cdbd2cSJim Jagielski return aRecursionFormulas.begin(); 104*b1cdbd2cSJim Jagielski } GetEnd()105*b1cdbd2cSJim Jagielski ScFormulaRecursionList::iterator GetEnd() 106*b1cdbd2cSJim Jagielski { 107*b1cdbd2cSJim Jagielski return aRecursionFormulas.end(); 108*b1cdbd2cSJim Jagielski } IsInIterationReturn() const109*b1cdbd2cSJim Jagielski bool IsInIterationReturn() const { return bInIterationReturn; } SetInIterationReturn(bool b)110*b1cdbd2cSJim Jagielski void SetInIterationReturn( bool b ) 111*b1cdbd2cSJim Jagielski { 112*b1cdbd2cSJim Jagielski // An iteration return is always coupled to a recursion return. 113*b1cdbd2cSJim Jagielski SetInRecursionReturn( b); 114*b1cdbd2cSJim Jagielski bInIterationReturn = b; 115*b1cdbd2cSJim Jagielski } IsDoingIteration() const116*b1cdbd2cSJim Jagielski bool IsDoingIteration() const { return nIteration > 0; } GetIteration() const117*b1cdbd2cSJim Jagielski sal_uInt16 GetIteration() const { return nIteration; } GetConvergingReference()118*b1cdbd2cSJim Jagielski bool & GetConvergingReference() { return bConverging; } StartIteration()119*b1cdbd2cSJim Jagielski void StartIteration() 120*b1cdbd2cSJim Jagielski { 121*b1cdbd2cSJim Jagielski SetInIterationReturn( false); 122*b1cdbd2cSJim Jagielski nIteration = 1; 123*b1cdbd2cSJim Jagielski bConverging = false; 124*b1cdbd2cSJim Jagielski aLastIterationStart = GetIterationStart(); 125*b1cdbd2cSJim Jagielski } ResumeIteration()126*b1cdbd2cSJim Jagielski void ResumeIteration() 127*b1cdbd2cSJim Jagielski { 128*b1cdbd2cSJim Jagielski SetInIterationReturn( false); 129*b1cdbd2cSJim Jagielski aLastIterationStart = GetIterationStart(); 130*b1cdbd2cSJim Jagielski } IncIteration()131*b1cdbd2cSJim Jagielski void IncIteration() { ++nIteration; } EndIteration()132*b1cdbd2cSJim Jagielski void EndIteration() 133*b1cdbd2cSJim Jagielski { 134*b1cdbd2cSJim Jagielski aRecursionFormulas.erase( GetIterationStart(), GetIterationEnd()); 135*b1cdbd2cSJim Jagielski ResetIteration(); 136*b1cdbd2cSJim Jagielski } GetLastIterationStart()137*b1cdbd2cSJim Jagielski ScFormulaRecursionList::iterator GetLastIterationStart() { return aLastIterationStart; } GetIterationStart()138*b1cdbd2cSJim Jagielski ScFormulaRecursionList::iterator GetIterationStart() { return GetStart(); } GetIterationEnd()139*b1cdbd2cSJim Jagielski ScFormulaRecursionList::iterator GetIterationEnd() { return GetEnd(); } 140*b1cdbd2cSJim Jagielski /** Any return, recursion or iteration, iteration is always coupled with 141*b1cdbd2cSJim Jagielski recursion. */ IsInReturn() const142*b1cdbd2cSJim Jagielski bool IsInReturn() const { return bInRecursionReturn; } GetList() const143*b1cdbd2cSJim Jagielski const ScFormulaRecursionList& GetList() const { return aRecursionFormulas; } GetList()144*b1cdbd2cSJim Jagielski ScFormulaRecursionList& GetList() { return aRecursionFormulas; } GetRecursionInIterationStack()145*b1cdbd2cSJim Jagielski ScRecursionInIterationStack& GetRecursionInIterationStack() { return aRecursionInIterationStack; } Clear()146*b1cdbd2cSJim Jagielski void Clear() 147*b1cdbd2cSJim Jagielski { 148*b1cdbd2cSJim Jagielski aRecursionFormulas.clear(); 149*b1cdbd2cSJim Jagielski while (!aRecursionInIterationStack.empty()) 150*b1cdbd2cSJim Jagielski aRecursionInIterationStack.pop(); 151*b1cdbd2cSJim Jagielski Init(); 152*b1cdbd2cSJim Jagielski } 153*b1cdbd2cSJim Jagielski }; 154*b1cdbd2cSJim Jagielski 155*b1cdbd2cSJim Jagielski #endif // INCLUDED_RECURSIONHELPER_HXX 156