Line data    Source code

       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 SC_XLTRACER_HXX
      21             : #define SC_XLTRACER_HXX
      22             : 
      23             : #include "global.hxx"
      24             : #include "xltools.hxx"
      25             : 
      26             : // As Trace features become implemented, we can safely delete the enum entry as
      27             : // we use the member mnID to keep track of the actual trace tag ID value.
      28             : enum XclTracerId
      29             : {
      30             :     eUnKnown  ,          /// unused but allows us to set the correct index
      31             :     eRowLimitExceeded ,
      32             :     eTabLimitExceeded ,
      33             :     ePassword ,
      34             :     ePrintRange ,
      35             :     eShortDate ,
      36             :     eBorderLineStyle ,
      37             :     eFillPattern ,
      38             :     eInvisibleGrid ,
      39             :     eFormattedNote ,
      40             :     eFormulaExtName ,
      41             :     eFormulaMissingArg ,
      42             :     ePivotDataSource ,
      43             :     ePivotChartExists ,
      44             :     eChartUnKnownType ,
      45             :     eChartTrendLines ,
      46             :     eChartErrorBars ,
      47             :     eChartOnlySheet ,
      48             :     eChartRange ,
      49             :     eChartDSName,
      50             :     eChartDataTable,
      51             :     eChartLegendPosition,
      52             :     eChartTextFormatting,
      53             :     eChartEmbeddedObj,
      54             :     eChartAxisAuto,
      55             :     eChartAxisManual,
      56             :     eChartInvalidXY,
      57             :     eUnsupportedObject ,
      58             :     eObjectNotPrintable ,
      59             :     eDVType,
      60             :     eTraceLength         /// this *should* always be the final entry
      61             : };
      62             : 
      63             : struct XclTracerDetails
      64             : {
      65             :     XclTracerId                 meProblemId;    /// Excel Import Trace index.
      66             :     sal_uInt32                  mnID;           /// actual ID Index trace tag Value
      67             :     const sal_Char*             mpContext;      /// Context for problem e.g. Limits
      68             :     const sal_Char*             mpDetail;       /// Context Detail e.g. SheetX
      69             :     const sal_Char*             mpProblem;      /// Description of problem
      70             : };
      71             : 
      72             : 
      73             : /** This class wraps an MSFilterTracer to create trace logs for import/export filters. */
      74             : class XclTracer
      75             : {
      76             : public:
      77             :     explicit                    XclTracer( const OUString& rDocUrl );
      78             :     virtual                     ~XclTracer();
      79             : 
      80             :     /** Returns true, if tracing is enabled. */
      81           0 :     inline bool                 IsEnabled() const { return mbEnabled; }
      82             : 
      83             :     /** Ensure that particular traces are logged once per document. */
      84             :     void                        ProcessTraceOnce(XclTracerId eProblem);
      85             : 
      86             :     void                        TraceInvalidAddress(const ScAddress& rPos, const ScAddress& rMaxPos);
      87             :     void                        TraceInvalidRow( sal_uInt32 nRow, sal_uInt32 nMaxrow );
      88             :     void                        TraceInvalidTab( SCTAB nTab, SCTAB nMaxTab);
      89             :     void                        TracePrintRange();
      90             :     void                        TraceDates(sal_uInt16 nNumFmt);
      91             :     void                        TraceBorderLineStyle(bool bBorderLineStyle);
      92             :     void                        TraceFillPattern(bool bFillPattern);
      93             :     void                        TraceFormulaMissingArg();
      94             :     void                        TracePivotDataSource(bool bExternal);
      95             :     void                        TracePivotChartExists();
      96             :     void                        TraceChartUnKnownType();
      97             :     void                        TraceChartOnlySheet();
      98             :     void                        TraceChartDataTable();
      99             :     void                        TraceChartLegendPosition();
     100             :     void                        TraceUnsupportedObjects();
     101             :     void                        TraceObjectNotPrintable();
     102             :     void                        TraceDVType(bool bType);
     103             : 
     104             : private:
     105             :     bool                        mbEnabled;
     106             :     typedef ::std::vector< bool >     BoolVec;
     107             :     /** array of flags corresponding to each entry in the XclTracerDetails table. */
     108             :     BoolVec                     maFirstTimes;
     109             : };
     110             : 
     111             : 
     112             : #endif
     113             : 
     114             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */