sw/inc/cellfml.hxx

   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_SW_INC_CELLFML_HXX
  21 #define INCLUDED_SW_INC_CELLFML_HXX
  22
  23 #include <memory>
  24 #include <rtl/ustring.hxx>
  25
  26 class SwTable;
  27 class SwNode;
  28 class SwTableSortBoxes;
  29 class SwSelBoxes;
  30 class SwCalc;
  31 class SwTableBox;
  32 class SwTableFormulaUpdate;
  33 class SwDoc;
  34
  35 class SwTableCalcPara
  36 {
  37     const SwTableBox* pLastTableBox;
  38     sal_uInt16 nStackCnt, nMaxSize;
  39
  40 public:
  41     std::unique_ptr<SwTableSortBoxes> pBoxStack;  ///< stack for recognizing recursion
  42     SwCalc& rCalc;              ///< current Calculator
  43     const SwTable* pTable;        ///< current table
  44
  45     SwTableCalcPara( SwCalc& rCalculator, const SwTable& rTable );
  46     ~SwTableCalcPara();
  47
  48     bool CalcWithStackOverflow();
  49     bool IsStackOverflow() const        { return nMaxSize == nStackCnt; }
  50     bool IncStackCnt()                  { return nMaxSize == ++nStackCnt; }
  51     void DecStackCnt()                  { if( nStackCnt ) --nStackCnt; }
  52     void SetLastTableBox( const SwTableBox* pBox )    { pLastTableBox = pBox; }
  53 };
  54
  55 class SwTableFormula
  56 {
  57 typedef void (SwTableFormula:: *FnScanFormula)( const SwTable&, OUString&,
  58                                                 OUString&, OUString*, void* ) const;
  59
  60     void BoxNmsToPtr( const SwTable&, OUString&, OUString&, OUString*,
  61                         void* pPara = nullptr ) const;
  62     void PtrToBoxNms( const SwTable&, OUString&, OUString&, OUString*,
  63                         void* pPara = nullptr ) const;
  64     void RelNmsToBoxNms( const SwTable&, OUString&, OUString&, OUString*,
  65                         void* pPara = nullptr ) const;
  66     void RelBoxNmsToPtr( const SwTable&, OUString&, OUString&, OUString*,
  67                         void* pPara = nullptr ) const;
  68     void BoxNmsToRelNm( const SwTable&, OUString&, OUString&, OUString*,
  69                         void* pPara = nullptr ) const;
  70     void MakeFormula_( const SwTable&, OUString&, OUString&, OUString*,
  71                         void* pPara = nullptr ) const;
  72     void GetFormulaBoxes( const SwTable&, OUString&, OUString&, OUString*,
  73                         void* pPara = nullptr ) const;
  74     void HasValidBoxes_( const SwTable&, OUString&, OUString&, OUString*,
  75                         void* pPara = nullptr ) const;
  76     void SplitMergeBoxNm_( const SwTable&, OUString&, OUString&, OUString*,
  77                         void* pPara = nullptr ) const;
  78
  79     static void GetBoxes( const SwTableBox& rStt, const SwTableBox& rEnd,
  80                     SwSelBoxes& rBoxes );
  81     OUString ScanString( FnScanFormula fnFormula, const SwTable& rTable,
  82                         void*) const;
  83
  84     static const SwTable* FindTable( SwDoc& rDoc, const OUString& rNm );
  85
  86 protected:
  87     enum NameType { EXTRNL_NAME, INTRNL_NAME, REL_NAME };
  88
  89     OUString    m_sFormula;         ///< current formula
  90     NameType    m_eNmType;          ///< current display method
  91     bool        m_bValidValue;      ///< true: recalculate formula
  92
  93     // find the node in which the formula is located
  94     //  TextFeld    -> TextNode,
  95     //  BoxAttribut -> BoxStartNode
  96     // !!! every derived class must override this !!!
  97     virtual const SwNode* GetNodeOfFormula() const = 0;
  98
  99     SwTableFormula( const OUString& rFormula );
 100
 101     OUString MakeFormula( SwTableCalcPara& rCalcPara ) const
 102     {
 103         return ScanString( &SwTableFormula::MakeFormula_,
 104                             *rCalcPara.pTable, &rCalcPara );
 105     }
 106
 107     static sal_uInt16 GetLnPosInTable( const SwTable& rTable, const SwTableBox* pBox );
 108
 109 public:
 110
 111     SwTableFormula( const SwTableFormula& rCpy )    { *this = rCpy; }
 112     virtual ~SwTableFormula();
 113     SwTableFormula& operator=( const SwTableFormula& rCpy )
 114     {
 115         m_sFormula = rCpy.m_sFormula;
 116         m_eNmType = rCpy.m_eNmType;
 117         m_bValidValue = rCpy.m_bValidValue;
 118         return *this;
 119     }
 120
 121     /// create from the internal formula (for CORE) the external formula (for UI)
 122     void PtrToBoxNm( const SwTable* pTable );
 123     /// create from the external formula the internal
 124     void BoxNmToPtr( const SwTable* pTable );
 125     /// create from the external/internal formula the relative formula
 126     void ToRelBoxNm( const SwTable* pTable );
 127     /// gets called before/after merging/splitting of tables
 128     void ToSplitMergeBoxNm( SwTableFormulaUpdate& rTableUpd );
 129
 130     bool IsIntrnlName() const               { return m_eNmType == INTRNL_NAME; }
 131     NameType GetNameType() const            { return m_eNmType; }
 132
 133     bool IsValid() const                    { return m_bValidValue; }
 134     void ChgValid( bool bNew )              { m_bValidValue = bNew; }
 135
 136     const OUString& GetFormula() const             { return m_sFormula; }
 137     void SetFormula( const OUString& rNew )
 138     {
 139         m_sFormula = rNew;
 140         m_eNmType = EXTRNL_NAME;
 141         m_bValidValue = false;
 142     }
 143
 144     void GetBoxesOfFormula(const SwTable& rTable, SwSelBoxes& rBoxes);
 145     // are all boxes valid which this formula relies on?
 146     bool HasValidBoxes() const;
 147 };
 148
 149 #endif
 150
 151 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */