office-gobmx/sc/inc/chart2uno.hxx
Kohei Yoshida 6c4e21a234 bnc#812796: Correctly handle static value array for OOXML charts.
We need to pass the role of the data sequence in order to avoid unreliable
guess work when importing static value array.

Also, not all Excel's scatter plots have real numeric X values; some have
textural X values in which case Excel switch to generating 1, 2, 3, ... as
X values.  When importing to our chart implementation, using "categories" role
in such cases instead of "values-x" results in a more faithful chart rendering.

Change-Id: If4bc1f650bb024dcd1b1b36537f457fb38404a78
2014-07-02 20:56:31 -04:00

483 lines
21 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 .
*/
#ifndef INCLUDED_SC_INC_CHART2UNO_HXX
#define INCLUDED_SC_INC_CHART2UNO_HXX
#include "cellsuno.hxx"
#include "rangelst.hxx"
#include "externalrefmgr.hxx"
#include "types.hxx"
#include "chartlis.hxx"
#include <svl/lstner.hxx>
#include <com/sun/star/chart/ChartDataRowSource.hpp>
#include <com/sun/star/chart2/data/XDataProvider.hpp>
#include <com/sun/star/chart2/data/XSheetDataProvider.hpp>
#include <com/sun/star/chart2/data/XRangeXMLConversion.hpp>
#include <com/sun/star/chart2/data/XDataSource.hpp>
#include <com/sun/star/chart2/data/XDataSequence.hpp>
#include <com/sun/star/chart2/data/XTextualDataSequence.hpp>
#include <com/sun/star/chart2/data/XNumericalDataSequence.hpp>
#include <com/sun/star/chart2/data/XLabeledDataSequence.hpp>
#include <com/sun/star/chart2/data/DataSequenceRole.hpp>
#include <com/sun/star/chart2/XTimeBased.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/util/XCloneable.hpp>
#include <com/sun/star/util/XModifyBroadcaster.hpp>
#include <cppuhelper/implbase2.hxx>
#include <cppuhelper/implbase5.hxx>
#include <cppuhelper/implbase8.hxx>
#include <rtl/ustring.hxx>
#include <svl/itemprop.hxx>
#include <list>
#include <vector>
#include <boost/shared_ptr.hpp>
#include <boost/unordered_set.hpp>
#include <boost/noncopyable.hpp>
#include <boost/scoped_ptr.hpp>
class ScDocument;
// DataProvider
class ScChart2DataProvider : public
::cppu::WeakImplHelper5<
::com::sun::star::chart2::data::XDataProvider,
::com::sun::star::chart2::data::XSheetDataProvider,
::com::sun::star::chart2::data::XRangeXMLConversion,
::com::sun::star::beans::XPropertySet,
::com::sun::star::lang::XServiceInfo>,
SfxListener
{
public:
explicit ScChart2DataProvider( ScDocument* pDoc );
virtual ~ScChart2DataProvider();
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE;
// XDataProvider
virtual sal_Bool SAL_CALL createDataSourcePossible(
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& aArguments )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference<
::com::sun::star::chart2::data::XDataSource > SAL_CALL createDataSource(
const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& aArguments )
throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence<
::com::sun::star::beans::PropertyValue > SAL_CALL detectArguments(
const ::com::sun::star::uno::Reference< ::com::sun::star::chart2::data::XDataSource >& xDataSource )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL createDataSequenceByRangeRepresentationPossible(
const OUString& aRangeRepresentation )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference<
::com::sun::star::chart2::data::XDataSequence > SAL_CALL createDataSequenceByRangeRepresentation(
const OUString& aRangeRepresentation )
throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual css::uno::Reference<css::chart2::data::XDataSequence> SAL_CALL
createDataSequenceByValueArray( const OUString& aRole, const OUString& aRangeRepresentation )
throw (css::lang::IllegalArgumentException, css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::sheet::XRangeSelection > SAL_CALL getRangeSelection()
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XSheetDataProvider
virtual sal_Bool SAL_CALL createDataSequenceByFormulaTokensPossible(
const ::com::sun::star::uno::Sequence< ::com::sun::star::sheet::FormulaToken >& aTokens )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Reference< ::com::sun::star::chart2::data::XDataSequence >
SAL_CALL createDataSequenceByFormulaTokens(
const ::com::sun::star::uno::Sequence< ::com::sun::star::sheet::FormulaToken >& aTokens )
throw (::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XRangeXMLConversion
virtual OUString SAL_CALL convertRangeToXML( const OUString& sRangeRepresentation )
throw ( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException, std::exception ) SAL_OVERRIDE;
virtual OUString SAL_CALL convertRangeFromXML( const OUString& sXMLRange )
throw ( ::com::sun::star::uno::RuntimeException, ::com::sun::star::lang::IllegalArgumentException, std::exception ) SAL_OVERRIDE;
// XPropertySet
virtual ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySetInfo> SAL_CALL
getPropertySetInfo() throw( ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setPropertyValue(
const OUString& rPropertyName,
const ::com::sun::star::uno::Any& rValue)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::beans::PropertyVetoException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue(
const OUString& rPropertyName)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addPropertyChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertyChangeListener>& xListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removePropertyChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertyChangeListener>& rListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addVetoableChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XVetoableChangeListener>& rListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeVetoableChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XVetoableChangeListener>& rListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() throw(
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL supportsService( const OUString&
rServiceName) throw( ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL
getSupportedServiceNames() throw(
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
private:
ScDocument* m_pDocument;
SfxItemPropertySet m_aPropSet;
bool m_bIncludeHiddenCells;
};
// DataSource
class ScChart2DataSource : public
::cppu::WeakImplHelper2<
::com::sun::star::chart2::data::XDataSource,
::com::sun::star::lang::XServiceInfo>,
SfxListener
{
public:
explicit ScChart2DataSource( ScDocument* pDoc);
virtual ~ScChart2DataSource();
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE;
// XDataSource
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Reference<
::com::sun::star::chart2::data::XLabeledDataSequence > > SAL_CALL
getDataSequences() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() throw(
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL supportsService( const OUString&
rServiceName) throw( ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL
getSupportedServiceNames() throw(
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// implementation
void AddLabeledSequence(const com::sun::star::uno::Reference < com::sun::star::chart2::data::XLabeledDataSequence >& xNew);
private:
ScDocument* m_pDocument;
typedef std::list < com::sun::star::uno::Reference< com::sun::star::chart2::data::XLabeledDataSequence > > LabeledList;
LabeledList m_aLabeledSequences;
};
// DataSequence
class ScChart2DataSequence : public
::cppu::WeakImplHelper8<
::com::sun::star::chart2::data::XDataSequence,
::com::sun::star::chart2::data::XTextualDataSequence,
::com::sun::star::chart2::data::XNumericalDataSequence,
com::sun::star::chart2::XTimeBased,
::com::sun::star::util::XCloneable,
::com::sun::star::util::XModifyBroadcaster,
::com::sun::star::beans::XPropertySet,
::com::sun::star::lang::XServiceInfo>,
SfxListener,
boost::noncopyable
{
public:
explicit ScChart2DataSequence( ScDocument* pDoc,
const com::sun::star::uno::Reference< com::sun::star::chart2::data::XDataProvider >& xDP,
::std::vector<ScTokenRef>* pTokens, bool bIncludeHiddenCells );
virtual ~ScChart2DataSequence();
virtual void Notify( SfxBroadcaster& rBC, const SfxHint& rHint ) SAL_OVERRIDE;
// XDataSequence
virtual ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >
SAL_CALL getData()
throw (::com::sun::star::uno::RuntimeException,
std::exception) SAL_OVERRIDE;
virtual OUString SAL_CALL getSourceRangeRepresentation()
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence< OUString >
SAL_CALL generateLabel(::com::sun::star::chart2::data::LabelOrigin nOrigin)
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::sal_Int32 SAL_CALL getNumberFormatKeyByIndex( ::sal_Int32 nIndex )
throw (::com::sun::star::lang::IndexOutOfBoundsException,
::com::sun::star::uno::RuntimeException,
std::exception) SAL_OVERRIDE;
// XNumericalDataSequence
virtual ::com::sun::star::uno::Sequence< double >
SAL_CALL getNumericalData()
throw (::com::sun::star::uno::RuntimeException,
std::exception) SAL_OVERRIDE;
// XTextualDataSequence
virtual ::com::sun::star::uno::Sequence< OUString >
SAL_CALL getTextualData()
throw (::com::sun::star::uno::RuntimeException,
std::exception) SAL_OVERRIDE;
// XTimeBased
virtual sal_Bool SAL_CALL switchToNext(sal_Bool bWrap) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL setToPointInTime(sal_Int32 nPoint) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setRange(sal_Int32 nStart, sal_Int32 nEnd) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XPropertySet
virtual ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertySetInfo> SAL_CALL
getPropertySetInfo() throw( ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setPropertyValue(
const OUString& rPropertyName,
const ::com::sun::star::uno::Any& rValue)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::beans::PropertyVetoException,
::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Any SAL_CALL getPropertyValue(
const OUString& rPropertyName)
throw(::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException,
std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addPropertyChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertyChangeListener>& xListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removePropertyChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XPropertyChangeListener>& rListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL addVetoableChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XVetoableChangeListener>& rListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeVetoableChangeListener(
const OUString& rPropertyName,
const ::com::sun::star::uno::Reference<
::com::sun::star::beans::XVetoableChangeListener>& rListener)
throw( ::com::sun::star::beans::UnknownPropertyException,
::com::sun::star::lang::WrappedTargetException,
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XCloneable
virtual ::com::sun::star::uno::Reference< ::com::sun::star::util::XCloneable > SAL_CALL createClone()
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XModifyBroadcaster
virtual void SAL_CALL addModifyListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener )
throw (::com::sun::star::uno::RuntimeException,
std::exception) SAL_OVERRIDE;
virtual void SAL_CALL removeModifyListener(
const ::com::sun::star::uno::Reference< ::com::sun::star::util::XModifyListener >& aListener )
throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() throw(
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual sal_Bool SAL_CALL supportsService( const OUString&
rServiceName) throw( ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual ::com::sun::star::uno::Sequence< OUString> SAL_CALL
getSupportedServiceNames() throw(
::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
private:
void setDataChangedHint(bool b);
// Implementation
void RefChanged();
DECL_LINK( ValueListenerHdl, SfxHint* );
private:
ScChart2DataSequence(); // disabled
ScChart2DataSequence(const ScChart2DataSequence& r); // disabled
class ExternalRefListener : public ScExternalRefManager::LinkListener
{
public:
ExternalRefListener(ScChart2DataSequence& rParent, ScDocument* pDoc);
virtual ~ExternalRefListener();
virtual void notify(sal_uInt16 nFileId, ScExternalRefManager::LinkUpdateType eType) SAL_OVERRIDE;
void addFileId(sal_uInt16 nFileId);
void removeFileId(sal_uInt16 nFileId);
const ::boost::unordered_set<sal_uInt16>& getAllFileIds() { return maFileIds;}
private:
ExternalRefListener();
ExternalRefListener(const ExternalRefListener& r);
ScChart2DataSequence& mrParent;
::boost::unordered_set<sal_uInt16> maFileIds;
ScDocument* mpDoc;
};
/**
* Build an internal data array to cache the data ranges, and other
* information such as hidden values.
*/
void BuildDataCache();
void RebuildDataCache();
sal_Int32 FillCacheFromExternalRef(const ScTokenRef& pToken);
void UpdateTokensFromRanges(const ScRangeList& rRanges);
ExternalRefListener* GetExtRefListener();
void StopListeningToAllExternalRefs();
void CopyData(const ScChart2DataSequence& r);
private:
// data array
struct Item
{
double mfValue;
OUString maString;
bool mbIsValue;
Item();
};
class HiddenRangeListener : public ScChartHiddenRangeListener
{
public:
HiddenRangeListener(ScChart2DataSequence& rParent);
virtual ~HiddenRangeListener();
virtual void notify() SAL_OVERRIDE;
private:
ScChart2DataSequence& mrParent;
};
::std::list<Item> m_aDataArray;
/**
* Cached data for getData. We may also need to cache data for the
* numerical and textural data series if they turn out to be bottlenecks
* under certain scenarios.
*/
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any > m_aMixedDataCache;
::com::sun::star::uno::Sequence<sal_Int32> m_aHiddenValues;
// properties
::com::sun::star::chart2::data::DataSequenceRole m_aRole;
bool m_bIncludeHiddenCells;
// internals
typedef boost::scoped_ptr<std::vector<ScTokenRef> > TokenListPtr;
typedef boost::scoped_ptr<std::vector<sal_uInt32> > RangeIndexMapPtr;
typedef boost::scoped_ptr<ExternalRefListener> ExtRefListenerPtr;
sal_Int64 m_nObjectId;
ScDocument* m_pDocument;
TokenListPtr m_pTokens;
RangeIndexMapPtr m_pRangeIndices;
ExtRefListenerPtr m_pExtRefListener;
com::sun::star::uno::Reference < com::sun::star::chart2::data::XDataProvider > m_xDataProvider;
SfxItemPropertySet m_aPropSet;
boost::scoped_ptr<HiddenRangeListener> m_pHiddenListener;
ScLinkListener* m_pValueListener;
XModifyListenerArr_Impl m_aValueListeners;
bool m_bGotDataChangedHint;
bool m_bExtDataRebuildQueued;
bool mbTimeBased;
SCTAB mnTimeBasedStart;
SCTAB mnTimeBasedEnd;
SCTAB mnCurrentTab;
};
#endif // INCLUDED_SC_INC_CHART2UNO_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */