office-gobmx/oox/source/drawingml/chart/datasourcecontext.cxx
Dennis Francis f547cf17a1 [API CHANGE] oox: fix import of chart date categories
Before this fix, date categories imported in oox's DataSourceContext were
stored as formatted strings according to number format code in <c:formatCode>
under the <c:cat> tree. As a result chart2 could not recognize them
as dates. This causes problems like:

* The axis that is linked to date categories cannot use the
  scaling/range-selection(min/max)/increments specs mentioned as axis
  properties. This results in distorted/unreadable chart renders w.r.t
  the date axis.

* No re-formatting is attempted as per the number format provided for axis.

This patch introduces a role qualifer argument to the XDataProvider
interface method createDataSequenceByValueArray to support categories of
date type via this method.

When exporting to oox, write date categories and format code under
<c:cat>
  <c:numRef>
    <c:numCache>

This patch also fixes some discrepancies in date axis interval
computation (auto mode) found by already existing unit tests.

Change-Id: Ibc53b0a56fdddba80ba452d5567ce98d80460ea7
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/121525
Tested-by: Jenkins
Reviewed-by: Miklos Vajna <vmiklos@collabora.com>
2021-09-06 08:47:50 +02:00

335 lines
11 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <drawingml/chart/datasourcecontext.hxx>
#include <oox/drawingml/chart/datasourcemodel.hxx>
#include <oox/core/xmlfilterbase.hxx>
#include <oox/helper/attributelist.hxx>
#include <oox/token/namespaces.hxx>
#include <oox/token/tokens.hxx>
#include <svl/numformat.hxx>
#include <svl/zforlist.hxx>
#include <osl/diagnose.h>
namespace oox::drawingml::chart {
using ::oox::core::ContextHandler2Helper;
using ::oox::core::ContextHandlerRef;
using namespace ::com::sun::star;
DoubleSequenceContext::DoubleSequenceContext( ContextHandler2Helper& rParent, DataSequenceModel& rModel ) :
DataSequenceContextBase( rParent, rModel ),
mnPtIndex( -1 )
{
}
DoubleSequenceContext::~DoubleSequenceContext()
{
}
ContextHandlerRef DoubleSequenceContext::onCreateContext( sal_Int32 nElement, const AttributeList& rAttribs )
{
switch( getCurrentElement() )
{
case C_TOKEN( numRef ):
switch( nElement )
{
case C_TOKEN( f ):
case C_TOKEN( numCache ):
return this;
}
break;
case C_TOKEN( numCache ):
case C_TOKEN( numLit ):
switch( nElement )
{
case C_TOKEN( formatCode ):
return this;
case C_TOKEN( ptCount ):
mrModel.mnPointCount = rAttribs.getInteger( XML_val, -1 );
return nullptr;
case C_TOKEN( pt ):
mnPtIndex = rAttribs.getInteger( XML_idx, -1 );
return this;
}
break;
case C_TOKEN( pt ):
switch( nElement )
{
case C_TOKEN( v ):
return this;
}
break;
}
return nullptr;
}
void DoubleSequenceContext::onCharacters( const OUString& rChars )
{
switch( getCurrentElement() )
{
case C_TOKEN( f ):
mrModel.maFormula = rChars;
break;
case C_TOKEN( formatCode ):
mrModel.maFormatCode = rChars;
break;
case C_TOKEN( v ):
if( mnPtIndex >= 0 )
{
/* Import categories as String even though it could
* be values except when the format code indicates that they are dates.
* n#810508: xVal needs to be imported as double
* TODO: NumberFormat conversion, remove the check then.
*/
if( isParentElement( C_TOKEN( cat ), 4 ) )
{
// workaround for bug n#889755
SvNumberFormatter* pNumFrmt = getNumberFormatter();
if( pNumFrmt )
{
sal_uInt32 nKey = pNumFrmt->GetEntryKey( mrModel.maFormatCode );
bool bNoKey = ( nKey == NUMBERFORMAT_ENTRY_NOT_FOUND );
if( bNoKey )
{
OUString aFormatCode = mrModel.maFormatCode;
sal_Int32 nCheckPos = 0;
SvNumFormatType nType;
pNumFrmt->PutEntry( aFormatCode, nCheckPos, nType, nKey );
bNoKey = (nCheckPos != 0);
if (!bNoKey)
mrModel.meFormatType = nType;
}
if( bNoKey )
{
mrModel.maData[ mnPtIndex ] <<= rChars;
}
else
{
double fValue = rChars.toDouble();
if (mrModel.meFormatType == SvNumFormatType::DATE)
mrModel.maData[ mnPtIndex ] <<= fValue;
else
{
const ::Color* pColor = nullptr;
OUString aFormattedValue;
// tdf#91250: use UNLIMITED_PRECISION in case of GENERAL Number Format of category axis labels
if( pNumFrmt->GetStandardPrec() != SvNumberFormatter::UNLIMITED_PRECISION )
pNumFrmt->ChangeStandardPrec(SvNumberFormatter::UNLIMITED_PRECISION);
pNumFrmt->GetOutputString( fValue, nKey, aFormattedValue, &pColor );
mrModel.maData[ mnPtIndex ] <<= aFormattedValue;
}
}
}
else
{
mrModel.maData[ mnPtIndex ] <<= rChars;
}
}
else
{
mrModel.maData[ mnPtIndex ] <<= rChars.toDouble();
}
}
break;
}
}
SvNumberFormatter* DoubleSequenceContext::getNumberFormatter()
{
if( mpNumberFormatter == nullptr )
{
uno::Reference<uno::XComponentContext> rContext =
getFilter().getComponentContext();
mpNumberFormatter.reset(
new SvNumberFormatter(rContext, LANGUAGE_SYSTEM) );
}
return mpNumberFormatter.get();
}
StringSequenceContext::StringSequenceContext( ContextHandler2Helper& rParent, DataSequenceModel& rModel )
: DataSequenceContextBase( rParent, rModel )
, mnPtIndex(-1)
, mbReadC15(false)
{
}
StringSequenceContext::~StringSequenceContext()
{
}
ContextHandlerRef StringSequenceContext::onCreateContext( sal_Int32 nElement, const AttributeList& rAttribs )
{
switch( getCurrentElement() )
{
case C_TOKEN( multiLvlStrRef ):
switch( nElement )
{
case C_TOKEN( f ):
case C_TOKEN( multiLvlStrCache ):
return this;
}
break;
case C15_TOKEN( datalabelsRange ):
mbReadC15 = true;
switch( nElement )
{
case C15_TOKEN( f ):
case C15_TOKEN( dlblRangeCache ):
return this;
}
break;
case C_TOKEN( strRef ):
switch( nElement )
{
case C_TOKEN( f ):
case C_TOKEN( strCache ):
return this;
}
break;
case C_TOKEN( strCache ):
case C_TOKEN( strLit ):
case C15_TOKEN( dlblRangeCache ):
if (nElement == C15_TOKEN( dlblRangeCache ) && !mbReadC15)
break;
switch( nElement )
{
case C_TOKEN( ptCount ):
mrModel.mnPointCount = rAttribs.getInteger( XML_val, -1 );
return nullptr;
case C_TOKEN( pt ):
mnPtIndex = rAttribs.getInteger( XML_idx, -1 );
return this;
}
break;
case C_TOKEN( multiLvlStrCache ):
switch (nElement)
{
case C_TOKEN( ptCount ):
mrModel.mnPointCount = rAttribs.getInteger(XML_val, -1);
mrModel.mnLevelCount--; // normalize level count
return nullptr;
case C_TOKEN( lvl ):
mrModel.mnLevelCount++;
return this;
}
break;
case C_TOKEN( lvl ):
switch (nElement)
{
case C_TOKEN(pt):
mnPtIndex = rAttribs.getInteger(XML_idx, -1);
return this;
}
break;
case C_TOKEN( pt ):
switch( nElement )
{
case C_TOKEN( v ):
return this;
}
break;
}
return nullptr;
}
void StringSequenceContext::onCharacters( const OUString& rChars )
{
switch( getCurrentElement() )
{
case C_TOKEN( f ):
mrModel.maFormula = rChars;
break;
case C15_TOKEN( f ):
if (mbReadC15)
mrModel.maFormula = rChars;
break;
case C_TOKEN( v ):
if( mnPtIndex >= 0 )
mrModel.maData[ (mrModel.mnLevelCount-1) * mrModel.mnPointCount + mnPtIndex ] <<= rChars;
break;
}
}
DataSourceContext::DataSourceContext( ContextHandler2Helper& rParent, DataSourceModel& rModel ) :
ContextBase< DataSourceModel >( rParent, rModel )
{
}
DataSourceContext::~DataSourceContext()
{
}
ContextHandlerRef DataSourceContext::onCreateContext( sal_Int32 nElement, const AttributeList& )
{
switch( getCurrentElement() )
{
case C_TOKEN( cat ):
case C_TOKEN( xVal ):
case C_TOKEN( ext ):
switch( nElement )
{
case C_TOKEN( multiLvlStrRef ):
case C_TOKEN( strLit ):
case C_TOKEN( strRef ):
case C15_TOKEN( datalabelsRange ):
OSL_ENSURE( !mrModel.mxDataSeq, "DataSourceContext::onCreateContext - multiple data sequences" );
return new StringSequenceContext( *this, mrModel.mxDataSeq.create() );
case C_TOKEN( numLit ):
case C_TOKEN( numRef ):
OSL_ENSURE( !mrModel.mxDataSeq, "DataSourceContext::onCreateContext - multiple data sequences" );
return new DoubleSequenceContext( *this, mrModel.mxDataSeq.create() );
}
break;
case C_TOKEN( plus ):
case C_TOKEN( minus ):
case C_TOKEN( val ):
case C_TOKEN( yVal ):
case C_TOKEN( bubbleSize ):
switch( nElement )
{
case C_TOKEN( numLit ):
case C_TOKEN( numRef ):
OSL_ENSURE( !mrModel.mxDataSeq, "DataSourceContext::onCreateContext - multiple data sequences" );
return new DoubleSequenceContext( *this, mrModel.mxDataSeq.create() );
}
break;
}
return nullptr;
}
} // namespace oox::drawingml::chart
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */