sc/inc/formulagroup.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
  10 #ifndef INCLUDED_SC_INC_FORMULAGROUP_HXX
  11 #define INCLUDED_SC_INC_FORMULAGROUP_HXX
  12
  13 #include <config_features.h>
  14
  15 #include "address.hxx"
  16 #include "calcconfig.hxx"
  17 #include "types.hxx"
  18 #include "stlalgorithm.hxx"
  19
  20 #include <formula/opcode.hxx>
  21 #if HAVE_FEATURE_OPENCL
  22 #include <opencl/platforminfo.hxx>
  23 #endif
  24 #include <svl/sharedstringpool.hxx>
  25
  26 #include <memory>
  27 #include <set>
  28 #include <unordered_map>
  29 #include <vector>
  30
  31 class ScDocument;
  32 class ScTokenArray;
  33 class ScFormulaCell;
  34
  35 namespace sc {
  36
  37 struct FormulaGroupEntry
  38 {
  39     union
  40     {
  41         ScFormulaCell* mpCell;   // non-shared formula cell
  42         ScFormulaCell** mpCells; // pointer to the top formula cell in a shared group.
  43     };
  44
  45     size_t mnRow;
  46     size_t mnLength;
  47     bool mbShared;
  48
  49     FormulaGroupEntry( ScFormulaCell** pCells, size_t nRow, size_t nLength );
  50
  51     FormulaGroupEntry( ScFormulaCell* pCell, size_t nRow );
  52 };
  53
  54 struct FormulaGroupContext
  55 {
  56     typedef AlignedAllocator<double,256> DoubleAllocType;
  57     typedef std::vector<double, DoubleAllocType> NumArrayType;
  58     typedef std::vector<rtl_uString*> StrArrayType;
  59     typedef std::vector<std::unique_ptr<NumArrayType>> NumArrayStoreType;
  60     typedef std::vector<std::unique_ptr<StrArrayType>> StrArrayStoreType;
  61
  62     struct ColKey
  63     {
  64         SCTAB mnTab;
  65         SCCOL mnCol;
  66
  67         struct Hash
  68         {
  69             size_t operator() ( const ColKey& rKey ) const;
  70         };
  71
  72         ColKey( SCTAB nTab, SCCOL nCol );
  73
  74         bool operator== ( const ColKey& r ) const;
  75     };
  76
  77     struct ColArray
  78     {
  79         NumArrayType* mpNumArray;
  80         StrArrayType* mpStrArray;
  81         size_t mnSize;
  82
  83         ColArray( NumArrayType* pNumArray, StrArrayType* pStrArray );
  84     };
  85
  86     typedef std::unordered_map<ColKey, ColArray, ColKey::Hash> ColArraysType;
  87
  88     NumArrayStoreType m_NumArrays; /// manage life cycle of numeric arrays.
  89     StrArrayStoreType m_StrArrays; /// manage life cycle of string arrays.
  90
  91     ColArraysType maColArrays; /// keep track of longest array for each column.
  92
  93     ColArray* getCachedColArray( SCTAB nTab, SCCOL nCol, size_t nSize );
  94
  95     ColArray* setCachedColArray(
  96         SCTAB nTab, SCCOL nCol, NumArrayType* pNumArray, StrArrayType* pStrArray );
  97
  98     void ensureStrArray( ColArray& rColArray, size_t nArrayLen );
  99     void ensureNumArray( ColArray& rColArray, size_t nArrayLen );
 100
 101     FormulaGroupContext();
 102     FormulaGroupContext(const FormulaGroupContext&) = delete;
 103     const FormulaGroupContext& operator=(const FormulaGroupContext&) = delete;
 104     ~FormulaGroupContext();
 105 };
 106
 107 /**
 108  * Abstract base class for a "compiled" formula
 109  */
 110 class SC_DLLPUBLIC CompiledFormula
 111 {
 112 public:
 113     CompiledFormula();
 114     virtual ~CompiledFormula();
 115 };
 116
 117 /**
 118  * Abstract base class for vectorised formula group interpreters,
 119  * plus a global instance factory.
 120  */
 121 class SC_DLLPUBLIC FormulaGroupInterpreter
 122 {
 123     static FormulaGroupInterpreter *msInstance;
 124
 125 protected:
 126     ScCalcConfig maCalcConfig;
 127
 128     FormulaGroupInterpreter() {}
 129     virtual ~FormulaGroupInterpreter() {}
 130
 131     /// Merge global and document specific settings.
 132     void MergeCalcConfig(const ScDocument& rDoc);
 133
 134 public:
 135     static FormulaGroupInterpreter *getStatic();
 136 #if HAVE_FEATURE_OPENCL
 137     static void fillOpenCLInfo(std::vector<OpenCLPlatformInfo>& rPlatforms);
 138     static bool switchOpenCLDevice(const OUString& rDeviceId, bool bAutoSelect, bool bForceEvaluation = false);
 139     // This is intended to be called from opencl-test.cxx only
 140     static void enableOpenCL_UnitTestsOnly();
 141     static void getOpenCLDeviceInfo(sal_Int32& rDeviceId, sal_Int32& rPlatformId);
 142 #endif
 143     virtual ScMatrixRef inverseMatrix(const ScMatrix& rMat) = 0;
 144     virtual bool interpret(ScDocument& rDoc, const ScAddress& rTopPos, ScFormulaCellGroupRef& xGroup, ScTokenArray& rCode) = 0;
 145 };
 146
 147 /// Inherit from this for alternate formula group calculation approaches.
 148 class SC_DLLPUBLIC FormulaGroupInterpreterSoftware : public FormulaGroupInterpreter
 149 {
 150 public:
 151     FormulaGroupInterpreterSoftware();
 152     virtual ~FormulaGroupInterpreterSoftware() override {}
 153
 154     virtual ScMatrixRef inverseMatrix(const ScMatrix& rMat) override;
 155     virtual bool interpret(ScDocument& rDoc, const ScAddress& rTopPos, ScFormulaCellGroupRef& xGroup, ScTokenArray& rCode) override;
 156 };
 157
 158 }
 159
 160 #endif
 161
 162 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */