sc/inc/recursionhelper.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: recursionhelper.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_RECURSIONHELPER_HXX
  32 #define INCLUDED_RECURSIONHELPER_HXX
  33
  34 #include "formularesult.hxx"
  35
  36 #include <list>
  37 #include <stack>
  38 #include <tools/solar.h>
  39
  40 class ScFormulaCell;
  41
  42 struct ScFormulaRecursionEntry
  43 {
  44     ScFormulaCell*  pCell;
  45     BOOL            bOldRunning;
  46     ScFormulaResult aPreviousResult;
  47     ScFormulaRecursionEntry( ScFormulaCell* p, BOOL bR,
  48             const ScFormulaResult & rRes ) :
  49         pCell(p), bOldRunning(bR), aPreviousResult( rRes)
  50     {
  51     }
  52 };
  53
  54 typedef ::std::list< ScFormulaRecursionEntry > ScFormulaRecursionList;
  55
  56 class ScRecursionHelper
  57 {
  58     typedef ::std::stack< ScFormulaCell* >  ScRecursionInIterationStack;
  59     ScFormulaRecursionList              aRecursionFormulas;
  60     ScFormulaRecursionList::iterator    aInsertPos;
  61     ScFormulaRecursionList::iterator    aLastIterationStart;
  62     ScRecursionInIterationStack         aRecursionInIterationStack;
  63     USHORT                              nRecursionCount;
  64     USHORT                              nIteration;
  65     bool                                bInRecursionReturn;
  66     bool                                bDoingRecursion;
  67     bool                                bInIterationReturn;
  68     bool                                bConverging;
  69
  70     void    Init()
  71     {
  72         nRecursionCount    = 0;
  73         bInRecursionReturn = bDoingRecursion = bInIterationReturn = false;
  74         aInsertPos = GetEnd();
  75         ResetIteration();
  76     }
  77     void    ResetIteration()
  78     {
  79         aLastIterationStart = GetEnd();
  80         nIteration = 0;
  81         bConverging = false;
  82     }
  83
  84     public:
  85
  86     ScRecursionHelper() { Init(); }
  87     USHORT  GetRecursionCount() const       { return nRecursionCount; }
  88     void    IncRecursionCount()             { ++nRecursionCount; }
  89     void    DecRecursionCount()             { --nRecursionCount; }
  90     /// A pure recursion return, no iteration.
  91     bool    IsInRecursionReturn() const     { return bInRecursionReturn &&
  92         !bInIterationReturn; }
  93     void    SetInRecursionReturn( bool b )
  94     {
  95         // Do not use IsInRecursionReturn() here, it decouples iteration.
  96         if (b && !bInRecursionReturn)
  97             aInsertPos = aRecursionFormulas.begin();
  98         bInRecursionReturn = b;
  99     }
 100     bool    IsDoingRecursion() const        { return bDoingRecursion; }
 101     void    SetDoingRecursion( bool b )     { bDoingRecursion = b; }
 102     void    Insert( ScFormulaCell* p, BOOL bOldRunning,
 103                     const ScFormulaResult & rRes )
 104     {
 105         aRecursionFormulas.insert( aInsertPos, ScFormulaRecursionEntry( p,
 106                     bOldRunning, rRes));
 107     }
 108     ScFormulaRecursionList::iterator    GetStart()
 109     {
 110         return aRecursionFormulas.begin();
 111     }
 112     ScFormulaRecursionList::iterator    GetEnd()
 113     {
 114         return aRecursionFormulas.end();
 115     }
 116     bool    IsInIterationReturn() const     { return bInIterationReturn; }
 117     void    SetInIterationReturn( bool b )
 118     {
 119         // An iteration return is always coupled to a recursion return.
 120         SetInRecursionReturn( b);
 121         bInIterationReturn = b;
 122     }
 123     bool    IsDoingIteration() const        { return nIteration > 0; }
 124     USHORT  GetIteration() const            { return nIteration; }
 125     bool &  GetConvergingReference()        { return bConverging; }
 126     void    StartIteration()
 127     {
 128         SetInIterationReturn( false);
 129         nIteration = 1;
 130         bConverging = false;
 131         aLastIterationStart = GetIterationStart();
 132     }
 133     void    ResumeIteration()
 134     {
 135         SetInIterationReturn( false);
 136         aLastIterationStart = GetIterationStart();
 137     }
 138     void    IncIteration()                  { ++nIteration; }
 139     void    EndIteration()
 140     {
 141         aRecursionFormulas.erase( GetIterationStart(), GetIterationEnd());
 142         ResetIteration();
 143     }
 144     ScFormulaRecursionList::iterator GetLastIterationStart() { return aLastIterationStart; }
 145     ScFormulaRecursionList::iterator GetIterationStart() { return GetStart(); }
 146     ScFormulaRecursionList::iterator GetIterationEnd() { return GetEnd(); }
 147     /** Any return, recursion or iteration, iteration is always coupled with
 148         recursion. */
 149     bool    IsInReturn() const              { return bInRecursionReturn; }
 150     const ScFormulaRecursionList&   GetList() const { return aRecursionFormulas; }
 151     ScFormulaRecursionList&         GetList()       { return aRecursionFormulas; }
 152     ScRecursionInIterationStack&    GetRecursionInIterationStack()  { return aRecursionInIterationStack; }
 153     void    Clear()
 154     {
 155         aRecursionFormulas.clear();
 156         while (!aRecursionInIterationStack.empty())
 157             aRecursionInIterationStack.pop();
 158         Init();
 159     }
 160 };
 161
 162 #endif // INCLUDED_RECURSIONHELPER_HXX