sc/inc/formulalogger.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   6  */
   7
   8 #ifndef INCLUDED_SC_INC_FORMULALOGGER_HXX
   9 #define INCLUDED_SC_INC_FORMULALOGGER_HXX
  10
  11 #include <rtl/ustring.hxx>
  12
  13 #include <memory>
  14 #include <vector>
  15
  16 #include <config_options_calc.h>
  17
  18 class ScFormulaCell;
  19 class ScDocument;
  20 class ScAddress;
  21 struct ScFormulaCellGroup;
  22
  23 namespace formula {
  24
  25 class FormulaToken;
  26 struct VectorRefArray;
  27
  28 }
  29
  30 namespace osl { class File; }
  31
  32 namespace sc {
  33
  34 #if ENABLE_FORMULA_LOGGER
  35
  36 /**
  37  * Outputs formula calculation log outputs to specified file.
  38  */
  39 class FormulaLogger
  40 {
  41     std::unique_ptr<osl::File> mpLogFile;
  42     std::vector<OUString> maMessages;
  43
  44     sal_Int32 mnNestLevel = 0;
  45     const ScFormulaCellGroup* mpLastGroup = nullptr;
  46
  47     void writeAscii( const char* s );
  48     void writeAscii( const char* s, size_t n );
  49     void write( const OUString& ou );
  50     void write( sal_Int32 n );
  51
  52     void sync();
  53
  54     void writeNestLevel();
  55
  56 public:
  57
  58     static FormulaLogger& get();
  59
  60     /**
  61      * This class is only moveable.
  62      */
  63     class GroupScope
  64     {
  65         friend class FormulaLogger;
  66
  67         struct Impl;
  68         std::unique_ptr<Impl> mpImpl;
  69
  70     public:
  71         GroupScope() = delete;
  72         GroupScope( const GroupScope& ) = delete;
  73         GroupScope& operator= ( const GroupScope& ) = delete;
  74
  75     private:
  76         GroupScope(
  77             FormulaLogger& rLogger, const OUString& rPrefix,
  78             const ScDocument& rDoc, const ScFormulaCell& rCell,
  79             bool bOutputEnabled );
  80
  81     public:
  82         GroupScope( GroupScope&& r );
  83         ~GroupScope();
  84
  85         /**
  86          * Add an arbitrary message to dump to the log.
  87          */
  88         void addMessage( const OUString& rMsg );
  89
  90         /**
  91          * Add to the log a vector reference information for a single
  92          * reference.
  93          */
  94         void addRefMessage(
  95             const ScAddress& rCellPos, const ScAddress& rRefPos, size_t nLen,
  96             const formula::VectorRefArray& rArray );
  97
  98         /**
  99          * Add to the log a vector reference information for a range
 100          * reference.
 101          */
 102         void addRefMessage(
 103             const ScAddress& rCellPos, const ScAddress& rRefPos, size_t nLen,
 104             const std::vector<formula::VectorRefArray>& rArrays );
 105
 106         /**
 107          * Add to the log a single cell reference information.
 108          */
 109         void addRefMessage(
 110             const ScAddress& rCellPos, const ScAddress& rRefPos,
 111             const formula::FormulaToken& rToken );
 112
 113         void addGroupSizeThresholdMessage( const ScFormulaCell& rCell );
 114
 115         /**
 116          * Call this when the group calculation has finished successfully.
 117          */
 118         void setCalcComplete();
 119     };
 120
 121     FormulaLogger( const FormulaLogger& ) = delete;
 122     FormulaLogger& operator= ( const FormulaLogger& ) = delete;
 123
 124     FormulaLogger();
 125     ~FormulaLogger();
 126
 127     GroupScope enterGroup( const ScDocument& rDoc, const ScFormulaCell& rCell );
 128 };
 129
 130 #else
 131
 132 /**
 133  * Dummy class with all empty inline methods.
 134  */
 135 class FormulaLogger
 136 {
 137 public:
 138
 139     static FormulaLogger get()
 140     {
 141         return FormulaLogger();
 142     }
 143
 144     class GroupScope
 145     {
 146     public:
 147         void addMessage( const OUString& /*rMsg*/ ) { (void) this; /* loplugin:staticmethods */ }
 148
 149         void addRefMessage(
 150             const ScAddress& /*rCellPos*/, const ScAddress& /*rRefPos*/, size_t /*nLen*/,
 151             const formula::VectorRefArray& /*rArray*/ )
 152         {
 153             (void) this; /* loplugin:staticmethods */
 154         }
 155
 156         void addRefMessage(
 157             const ScAddress& /*rCellPos*/, const ScAddress& /*rRefPos*/, size_t /*nLen*/,
 158             const std::vector<formula::VectorRefArray>& /*rArrays*/ )
 159         {
 160             (void) this; /* loplugin:staticmethods */
 161         }
 162
 163         void addRefMessage(
 164             const ScAddress& /*rCellPos*/, const ScAddress& /*rRefPos*/,
 165             const formula::FormulaToken& /*rToken*/ )
 166         {
 167             (void) this; /* loplugin:staticmethods */
 168         }
 169
 170         void addGroupSizeThresholdMessage( const ScFormulaCell& /*rCell*/ )
 171         {
 172             (void) this; /* loplugin:staticmethods */
 173         }
 174
 175         void setCalcComplete() { (void) this; /* loplugin:staticmethods */ }
 176     };
 177
 178     GroupScope enterGroup( const ScDocument& /*rDoc*/, const ScFormulaCell& /*rCell*/ )
 179     {
 180         (void) this; /* loplugin:staticmethods */
 181         return GroupScope();
 182     }
 183 };
 184
 185 #endif // ENABLE_FORMULA_LOGGER
 186
 187 }
 188
 189 #endif
 190
 191 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */