sc/source/core/tool/formulalogger.cxx

   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 #include <formulalogger.hxx>
   9 #include <formulacell.hxx>
  10 #include <tokenarray.hxx>
  11 #include <document.hxx>
  12 #include <docsh.hxx>
  13 #include <tokenstringcontext.hxx>
  14 #include <address.hxx>
  15 #include <interpre.hxx>
  16
  17 #include <osl/file.hxx>
  18 #include <sfx2/objsh.hxx>
  19 #include <sfx2/docfile.hxx>
  20 #include <tools/urlobj.hxx>
  21 #include <formula/vectortoken.hxx>
  22 #include <rtl/ustrbuf.hxx>
  23
  24 #include <cstdlib>
  25 #include <utility>
  26
  27 namespace sc {
  28
  29 namespace {
  30
  31 std::unique_ptr<osl::File> initFile()
  32 {
  33     const char* pPath = std::getenv("LIBO_FORMULA_LOG_FILE");
  34     if (!pPath)
  35         return nullptr;
  36
  37     // Support both file:///... and system file path notations.
  38     OUString aPath = OUString::createFromAscii(pPath);
  39     INetURLObject aURL;
  40     aURL.SetSmartURL(aPath);
  41     aPath = aURL.GetMainURL(INetURLObject::DecodeMechanism::NONE);
  42
  43     return std::make_unique<osl::File>(aPath);
  44 }
  45
  46 ScRefFlags getRefFlags( const ScAddress& rCellPos, const ScAddress& rRefPos )
  47 {
  48     ScRefFlags eFlags = ScRefFlags::VALID;
  49     if (rCellPos.Tab() != rRefPos.Tab())
  50         eFlags |= ScRefFlags::TAB_3D;
  51     return eFlags;
  52 }
  53
  54 }
  55
  56 FormulaLogger& FormulaLogger::get()
  57 {
  58     static FormulaLogger aLogger;
  59     return aLogger;
  60 }
  61
  62 struct FormulaLogger::GroupScope::Impl
  63 {
  64     FormulaLogger& mrLogger;
  65     const ScDocument& mrDoc;
  66
  67     OUString maPrefix;
  68     std::vector<OUString> maMessages;
  69
  70     bool mbCalcComplete;
  71     bool mbOutputEnabled;
  72
  73     Impl( FormulaLogger& rLogger, OUString aPrefix, const ScDocument& rDoc,
  74         const ScFormulaCell& rCell, bool bOutputEnabled ) :
  75         mrLogger(rLogger), mrDoc(rDoc), maPrefix(std::move(aPrefix)),
  76         mbCalcComplete(false), mbOutputEnabled(bOutputEnabled)
  77     {
  78         ++mrLogger.mnNestLevel;
  79
  80         if (!mbOutputEnabled)
  81             return;
  82
  83         sc::TokenStringContext aCxt(rDoc, rDoc.GetGrammar());
  84         OUString aFormula = rCell.GetCode()->CreateString(aCxt, rCell.aPos);
  85
  86         mrLogger.write(maPrefix);
  87         mrLogger.writeNestLevel();
  88
  89         mrLogger.writeAscii("-- enter (formula='");
  90         mrLogger.write(aFormula);
  91         mrLogger.writeAscii("', size=");
  92         mrLogger.write(rCell.GetSharedLength());
  93         mrLogger.writeAscii(")\n");
  94     }
  95
  96     ~Impl()
  97     {
  98         if (mbOutputEnabled)
  99         {
 100             for (const OUString& rMsg : maMessages)
 101             {
 102                 mrLogger.write(maPrefix);
 103                 mrLogger.writeNestLevel();
 104                 mrLogger.writeAscii("   * ");
 105                 mrLogger.write(rMsg);
 106                 mrLogger.writeAscii("\n");
 107             }
 108
 109             mrLogger.write(maPrefix);
 110             mrLogger.writeNestLevel();
 111             mrLogger.writeAscii("-- exit (");
 112             if (mbCalcComplete)
 113                 mrLogger.writeAscii("calculation complete");
 114             else
 115                 mrLogger.writeAscii("without calculation");
 116
 117             mrLogger.writeAscii(")\n");
 118
 119             mrLogger.sync();
 120         }
 121
 122         --mrLogger.mnNestLevel;
 123     }
 124 };
 125
 126 FormulaLogger::GroupScope::GroupScope(
 127     FormulaLogger& rLogger, const OUString& rPrefix, const ScDocument& rDoc,
 128     const ScFormulaCell& rCell, bool bOutputEnabled ) :
 129     mpImpl(std::make_unique<Impl>(rLogger, rPrefix, rDoc, rCell, bOutputEnabled)) {}
 130
 131 FormulaLogger::GroupScope::GroupScope(GroupScope&& r) noexcept : mpImpl(std::move(r.mpImpl)) {}
 132
 133 FormulaLogger::GroupScope::~GroupScope() {}
 134
 135 void FormulaLogger::GroupScope::addMessage( const OUString& rMsg )
 136 {
 137     mpImpl->maMessages.push_back(rMsg);
 138 }
 139
 140 void FormulaLogger::GroupScope::addRefMessage(
 141     const ScAddress& rCellPos, const ScAddress& rRefPos, size_t nLen,
 142     const formula::VectorRefArray& rArray )
 143 {
 144     ScRange aRefRange(rRefPos);
 145     aRefRange.aEnd.IncRow(nLen-1);
 146     OUString aRangeStr = aRefRange.Format(mpImpl->mrDoc, getRefFlags(rCellPos, rRefPos));
 147
 148     std::u16string_view aMsg;
 149     if (rArray.mpNumericArray)
 150     {
 151         if (rArray.mpStringArray)
 152         {
 153             // mixture of numeric and string cells.
 154             aMsg = u"numeric and string";
 155         }
 156         else
 157         {
 158             // numeric cells only.
 159             aMsg = u"numeric only";
 160         }
 161     }
 162     else
 163     {
 164         if (rArray.mpStringArray)
 165         {
 166             // string cells only.
 167             aMsg = u"string only";
 168         }
 169         else
 170         {
 171             // empty cells.
 172             aMsg = u"empty";
 173         }
 174     }
 175
 176     mpImpl->maMessages.push_back(aRangeStr + ": " + aMsg);
 177 }
 178
 179 void FormulaLogger::GroupScope::addRefMessage(
 180     const ScAddress& rCellPos, const ScAddress& rRefPos, size_t nLen,
 181     const std::vector<formula::VectorRefArray>& rArrays )
 182 {
 183     ScAddress aPos(rRefPos); // copy
 184     for (const formula::VectorRefArray& rArray : rArrays)
 185     {
 186         addRefMessage(rCellPos, aPos, nLen, rArray);
 187         aPos.IncCol();
 188     }
 189 }
 190
 191 void FormulaLogger::GroupScope::addRefMessage(
 192     const ScAddress& rCellPos, const ScAddress& rRefPos,
 193     const formula::FormulaToken& rToken )
 194 {
 195     OUString aPosStr = rRefPos.Format(getRefFlags(rCellPos, rRefPos), &mpImpl->mrDoc);
 196     std::u16string_view aMsg;
 197     switch (rToken.GetType())
 198     {
 199         case formula::svDouble:
 200             aMsg = u"numeric value";
 201             break;
 202         case formula::svString:
 203             aMsg = u"string value";
 204             break;
 205         default:
 206             aMsg = u"unknown value";
 207     }
 208
 209     mpImpl->maMessages.push_back(aPosStr + ": " + aMsg);
 210 }
 211
 212 void FormulaLogger::GroupScope::addGroupSizeThresholdMessage( const ScFormulaCell& rCell )
 213 {
 214     OUString aBuf = "group length below minimum threshold ("
 215         + OUString::number(rCell.GetWeight())
 216         + " < "
 217         + OUString::number(ScInterpreter::GetGlobalConfig().mnOpenCLMinimumFormulaGroupSize)
 218         + ")";
 219     mpImpl->maMessages.push_back(aBuf);
 220 }
 221
 222 void FormulaLogger::GroupScope::setCalcComplete()
 223 {
 224     mpImpl->mbCalcComplete = true;
 225     addMessage(u"calculation performed"_ustr);
 226 }
 227
 228 FormulaLogger::FormulaLogger()
 229 {
 230     mpLogFile = initFile();
 231
 232     if (!mpLogFile)
 233         return;
 234
 235     osl::FileBase::RC eRC = mpLogFile->open(osl_File_OpenFlag_Write | osl_File_OpenFlag_Create);
 236
 237     if (eRC == osl::FileBase::E_EXIST)
 238     {
 239         eRC = mpLogFile->open(osl_File_OpenFlag_Write);
 240
 241         if (eRC != osl::FileBase::E_None)
 242         {
 243             // Failed to open an existing log file.
 244             mpLogFile.reset();
 245             return;
 246         }
 247
 248         if (mpLogFile->setPos(osl_Pos_End, 0) != osl::FileBase::E_None)
 249         {
 250             // Failed to set the position to the end of the file.
 251             mpLogFile.reset();
 252             return;
 253         }
 254     }
 255     else if (eRC != osl::FileBase::E_None)
 256     {
 257         // Failed to create a new file.
 258         mpLogFile.reset();
 259         return;
 260     }
 261
 262     // Output the header information.
 263     writeAscii("---\n");
 264     writeAscii("OpenCL: ");
 265     writeAscii(ScCalcConfig::isOpenCLEnabled() ? "enabled\n" : "disabled\n");
 266     writeAscii("---\n");
 267
 268     sync();
 269 }
 270
 271 FormulaLogger::~FormulaLogger()
 272 {
 273     if (mpLogFile)
 274         mpLogFile->close();
 275 }
 276
 277 void FormulaLogger::writeAscii( const char* s )
 278 {
 279     if (!mpLogFile)
 280         return;
 281
 282     sal_uInt64 nBytes;
 283     mpLogFile->write(s, strlen(s), nBytes);
 284 }
 285
 286 void FormulaLogger::writeAscii( const char* s, size_t n )
 287 {
 288     if (!mpLogFile)
 289         return;
 290
 291     sal_uInt64 nBytes;
 292     mpLogFile->write(s, n, nBytes);
 293 }
 294
 295 void FormulaLogger::write( std::u16string_view ou )
 296 {
 297     OString s = OUStringToOString(ou, RTL_TEXTENCODING_UTF8);
 298     writeAscii(s.getStr(), s.getLength());
 299 }
 300
 301 void FormulaLogger::write( sal_Int32 n )
 302 {
 303     OString s = OString::number(n);
 304     writeAscii(s.getStr(), s.getLength());
 305 }
 306
 307 void FormulaLogger::sync()
 308 {
 309     if (!mpLogFile)
 310         return;
 311
 312     mpLogFile->sync();
 313 }
 314
 315 void FormulaLogger::writeNestLevel()
 316 {
 317     // Write the nest level, but keep it only 1-character length to avoid
 318     // messing up the spacing.
 319     if (mnNestLevel < 10)
 320         write(mnNestLevel);
 321     else
 322         writeAscii("!");
 323
 324     writeAscii(": ");
 325     for (sal_Int32 i = 1; i < mnNestLevel; ++i)
 326         writeAscii("   ");
 327 }
 328
 329 FormulaLogger::GroupScope FormulaLogger::enterGroup(
 330     const ScDocument& rDoc, const ScFormulaCell& rCell )
 331 {
 332     // Get the file name if available.
 333     const ScDocShell* pShell = rDoc.GetDocumentShell();
 334     const SfxMedium* pMedium = pShell ? pShell->GetMedium() : nullptr;
 335     OUString aName;
 336     if (pMedium)
 337         aName = pMedium->GetURLObject().GetLastName();
 338     if (aName.isEmpty())
 339         aName = "-"; // unsaved document.
 340
 341     OUString aGroupPrefix = aName + ": formula-group: " +
 342         rCell.aPos.Format(ScRefFlags::VALID | ScRefFlags::TAB_3D, &rDoc, rDoc.GetAddressConvention()) + ": ";
 343
 344     bool bOutputEnabled = mpLastGroup != rCell.GetCellGroup().get();
 345     mpLastGroup = rCell.GetCellGroup().get();
 346
 347     return GroupScope(*this, aGroupPrefix, rDoc, rCell, bOutputEnabled);
 348 }
 349
 350 }
 351
 352 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */