sc/source/filter/excel/xltracer.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: xltracer.cxx,v $
  10  * $Revision: 1.10.32.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_sc.hxx"
  33
  34 // ============================================================================
  35 #include "xltracer.hxx"
  36 #include <svx/msfiltertracer.hxx>
  37 #include "address.hxx"
  38
  39 using ::rtl::OUString;
  40 using ::com::sun::star::uno::Sequence;
  41 using ::com::sun::star::beans::PropertyValue;
  42
  43 // ============================================================================
  44
  45 // Trace Table details are grouped by functionality using the context entry.
  46 // Each separate context starts at the next 1000 interval. New entries should
  47 // be added to their appropriate context. New contexts should be added onto
  48 // the end. Any gaps in the 1000 sequence or within the 1000 are the result
  49 // of trace events no longer present.
  50 static const XclTracerDetails pTracerDetails[] =
  51 {
  52     { eUnKnown,             0,     "UNKNOWN",        "UNKNOWN",         "Unknown trace property."            },
  53     { eRowLimitExceeded,    1000,  "Limits",         "Sheet",           "Row limit exceeded."                },
  54     { eTabLimitExceeded,    1001,  "Limits",         "Sheet",           "Sheet limit exceeded."              },
  55     { ePassword,            2000,  "Protection",     "Password",        "Document is password protected."    },
  56     { ePrintRange,          3000,  "Print",          "Print Range",     "Print Range present."               },
  57     { eShortDate,           4000,  "CellFormatting", "Short Dates",     "Possible Date format issue."        },
  58     { eBorderLineStyle,     4004,  "CellFormatting", "Border",          "Line style not supported.",         },
  59     { eFillPattern,         4005,  "CellFormatting", "Pattern",         "Fill Pattern not supported.",       },
  60     { eInvisibleGrid,       5000,  "Properties",     "Grid Invisible",  "Grid invisible on first sheet."      },
  61     { eFormattedNote,       6000,  "Notes",          "Formatting",      "Text may be formatted."             },
  62     { eFormulaExtName,      7000,  "Formula",        "External Name",   "External names not supported."      },
  63     { eFormulaMissingArg,   7001,  "Formula",        "Missing Argument","Parameter missing."      },
  64     { ePivotDataSource,     8000,  "Chart",          "Pivot",           "External data source not supported."},
  65     { ePivotChartExists,    8001,  "Chart",          "Pivot",           "Pivot Chart not supported."},
  66     { eChartUnKnownType,    8002,  "Chart",          "Type",            "Chart Type not supported."},
  67     { eChartTrendLines,     8003,  "Chart",          "Type",            "Chart trendlines not supported."},
  68     { eChartOnlySheet,      8004,  "Chart",          "Type",            "Chart only sheet not supported."},
  69     { eChartRange,          8005,  "Chart",          "Source Data",     "Chart source ranges too complex."},
  70     { eChartDSName,         8006,  "Chart",          "Source Data",     "Series titles not linked to cells."},
  71     { eChartDataTable,      8007,  "Chart",          "Legend",          "Data table not supported."},
  72     { eChartLegendPosition, 8008,  "Chart",          "Legend",          "Position not guaranteed."},
  73     { eChartTextFormatting, 8009,  "Chart",          "Formatting",      "Text formatting present."},
  74     { eChartEmbeddedObj,    8010,  "Chart",          "Area",            "Object inside chart."},
  75     { eChartAxisAuto,       8012,  "Chart",          "Axis",            "Axis interval is automatic."},
  76     { eChartInvalidXY,      8013,  "Chart",          "Scatter",         "Unsupported or invalid data range for XY chart."},
  77     { eChartErrorBars,      8014,  "Chart",          "Type",            "Chart error bars not supported."},
  78     { eChartAxisManual,     8015,  "Chart",          "Axis",            "Manual axis crossing point adjusted."},
  79     { eUnsupportedObject,   9000,  "Object",         "Type",            "Limited Object support."},
  80     { eObjectNotPrintable,  9001,  "Object",         "Print",           "Object not printable."},
  81     { eDVType,              10000, "DataValidation", "Type",            "Custom type present."}
  82 };
  83
  84 XclTracer::XclTracer( const String& rDocUrl, const OUString& rConfigPath ) :
  85     maFirstTimes(eTraceLength,true)
  86 {
  87     Sequence< PropertyValue > aConfigData( 1 );
  88     aConfigData[ 0 ].Name = CREATE_OUSTRING( "DocumentURL" );
  89     aConfigData[ 0 ].Value <<= OUString( rDocUrl );
  90     mpTracer.reset( new MSFilterTracer( rConfigPath, &aConfigData ) );
  91     mpTracer->StartTracing();
  92     mbEnabled = mpTracer->IsEnabled();
  93 }
  94
  95 XclTracer::~XclTracer()
  96 {
  97     mpTracer->EndTracing();
  98 }
  99
 100 void XclTracer::AddAttribute( const OUString& rName, const OUString& rValue )
 101 {
 102     if( mbEnabled )
 103         mpTracer->AddAttribute( rName, rValue );
 104 }
 105
 106 void XclTracer::Trace( const OUString& rElementID, const OUString& rMessage )
 107 {
 108     if( mbEnabled )
 109     {
 110         mpTracer->Trace( rElementID, rMessage );
 111         mpTracer->ClearAttributes();
 112     }
 113 }
 114
 115 void XclTracer::TraceLog( XclTracerId eProblem, sal_Int32 nValue )
 116 {
 117     if( mbEnabled )
 118     {
 119         OUString sID( CREATE_STRING( "SC" ) );
 120         sID += OUString::valueOf( static_cast< sal_Int32 >( pTracerDetails[ eProblem ].mnID ) );
 121         OUString sProblem = OUString::createFromAscii( pTracerDetails[ eProblem ].mpProblem );
 122
 123         switch (eProblem)
 124         {
 125            case eRowLimitExceeded:
 126                Context(eProblem,static_cast<SCTAB>(nValue));
 127                break;
 128            case eTabLimitExceeded:
 129                Context(eProblem,static_cast<SCTAB>(nValue));
 130                break;
 131            default:
 132                Context(eProblem);
 133                break;
 134         }
 135         Trace(sID, sProblem);
 136     }
 137 }
 138
 139 void XclTracer::Context( XclTracerId eProblem, SCTAB nTab )
 140 {
 141     OUString sContext = OUString::createFromAscii( pTracerDetails[ eProblem ].mpContext );
 142     OUString sDetail  = OUString::createFromAscii( pTracerDetails[ eProblem ].mpDetail );
 143
 144     switch (eProblem)
 145     {
 146         case eRowLimitExceeded:
 147         case eTabLimitExceeded:
 148             sDetail += OUString::valueOf( static_cast< sal_Int32 >( nTab + 1 ) );
 149             break;
 150         default:
 151             break;
 152     }
 153     AddAttribute(sContext, sDetail);
 154 }
 155
 156 void XclTracer::ProcessTraceOnce(XclTracerId eProblem, SCTAB nTab)
 157 {
 158     if( mbEnabled && maFirstTimes[eProblem])
 159     {
 160         TraceLog(pTracerDetails[eProblem].meProblemId, nTab);
 161         maFirstTimes[eProblem] = false;
 162     }
 163 }
 164
 165 void XclTracer::TraceInvalidAddress( const ScAddress& rPos, const ScAddress& rMaxPos )
 166 {
 167     TraceInvalidRow(rPos.Tab(), rPos.Row(), rMaxPos.Row());
 168     TraceInvalidTab(rPos.Tab(), rMaxPos.Tab());
 169 }
 170
 171 void XclTracer::TraceInvalidRow( SCTAB nTab, sal_uInt32 nRow, sal_uInt32 nMaxRow )
 172 {
 173     if(nRow > nMaxRow)
 174         ProcessTraceOnce(eRowLimitExceeded, nTab);
 175 }
 176
 177 void XclTracer::TraceInvalidTab( SCTAB nTab, SCTAB nMaxTab )
 178 {
 179     if(nTab > nMaxTab)
 180         ProcessTraceOnce(eTabLimitExceeded, nTab);
 181 }
 182
 183 void XclTracer::TracePrintRange()
 184 {
 185     ProcessTraceOnce( ePrintRange);
 186 }
 187
 188 void XclTracer::TraceDates( sal_uInt16 nNumFmt)
 189 {
 190     // Short Date = 14 and Short Date+Time = 22
 191     if(nNumFmt == 14 || nNumFmt == 22)
 192         ProcessTraceOnce(eShortDate);
 193 }
 194
 195 void XclTracer::TraceBorderLineStyle( bool bBorderLineStyle)
 196 {
 197     if(bBorderLineStyle)
 198         ProcessTraceOnce(eBorderLineStyle);
 199 }
 200
 201 void XclTracer::TraceFillPattern( bool bFillPattern)
 202 {
 203     if(bFillPattern)
 204         ProcessTraceOnce(eFillPattern);
 205 }
 206
 207 void XclTracer::TraceFormulaMissingArg()
 208 {
 209     // missing parameter in Formula record
 210     ProcessTraceOnce(eFormulaMissingArg);
 211 }
 212
 213 void XclTracer::TracePivotDataSource( bool bExternal)
 214 {
 215     if(bExternal)
 216         ProcessTraceOnce(ePivotDataSource);
 217 }
 218
 219 void XclTracer::TracePivotChartExists()
 220 {
 221     // Pivot Charts not currently displayed.
 222     ProcessTraceOnce(ePivotChartExists);
 223 }
 224
 225 void XclTracer::TraceChartUnKnownType()
 226 {
 227     ProcessTraceOnce(eChartUnKnownType);
 228 }
 229
 230 void XclTracer::TraceChartOnlySheet()
 231 {
 232     ProcessTraceOnce(eChartOnlySheet);
 233 }
 234
 235 void XclTracer::TraceChartDataTable()
 236 {
 237     // Data table is not supported.
 238     ProcessTraceOnce(eChartDataTable);
 239 }
 240
 241 void XclTracer::TraceChartLegendPosition()
 242 {
 243     // If position is set to "not docked or inside the plot area" then
 244     // we cannot guarantee the legend position.
 245     ProcessTraceOnce(eChartLegendPosition);
 246 }
 247
 248 void XclTracer::TraceChartEmbeddedObj()
 249 {
 250     // drawing objects e.g. text boxes etc not supported inside charts
 251     ProcessTraceOnce(eChartEmbeddedObj);
 252 }
 253
 254 void XclTracer::TraceUnsupportedObjects()
 255 {
 256     // Called from Excel 5.0 - limited Graphical object support.
 257     ProcessTraceOnce(eUnsupportedObject);
 258 }
 259
 260 void XclTracer::TraceObjectNotPrintable()
 261 {
 262     ProcessTraceOnce(eObjectNotPrintable);
 263 }
 264
 265 void XclTracer::TraceDVType(  bool bType)
 266 {
 267     // Custom types work if 'Data->validity dialog' is not OKed.
 268     if(bType)
 269         ProcessTraceOnce(eDVType);
 270 }
 271
 272 // ============================================================================
 273