/* -*- 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_SW_INC_UNOCHART_HXX

#define INCLUDED_SW_INC_UNOCHART_HXX

#include <map>

#include <vector>

#include <com/sun/star/chart2/data/XDataProvider.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/XLabeledDataSequence2.hpp>

#include <com/sun/star/chart2/data/XRangeXMLConversion.hpp>

#include <com/sun/star/chart2/data/DataSequenceRole.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/lang/XComponent.hpp>

#include <com/sun/star/lang/XEventListener.hpp>

#include <com/sun/star/util/XModifiable.hpp>

#include <com/sun/star/util/XModifyListener.hpp>

#include <comphelper/interfacecontainer4.hxx>

#include <cppuhelper/implbase.hxx>

#include <cppuhelper/weakref.hxx>

#include <rtl/ref.hxx>

#include <svl/listener.hxx>

#include <tools/link.hxx>

#include <vcl/timer.hxx>

#include "frmfmt.hxx"

#include "unocrsr.hxx"

class SfxItemPropertySet;

class SwDoc;

class SwTable;

class SwTableBox;

struct SwRangeDescriptor;

class SwSelBoxes;

namespace com::sun::star::table { class XCell; }

bool FillRangeDescriptor( SwRangeDescriptor &rDesc, std::u16string_view rCellRangeName );

class SwChartHelper

{

public:

    static void DoUpdateAllCharts( SwDoc* pDoc );

};

class SwChartLockController_Helper

{

    SwDoc   *m_pDoc;

    DECL_LINK( DoUnlockAllCharts, Timer *, void );

    Timer   m_aUnlockTimer;   // timer to unlock chart controllers

    bool    m_bIsLocked;

    SwChartLockController_Helper( const SwChartLockController_Helper & ) = delete;

    SwChartLockController_Helper & operator = ( const SwChartLockController_Helper & ) = delete;

    void LockUnlockAllCharts( bool bLock );

    void LockAllCharts()    { LockUnlockAllCharts( true ); };

    void UnlockAllCharts()  { LockUnlockAllCharts( false ); };

public:

    SwChartLockController_Helper( SwDoc *pDocument );

    ~SwChartLockController_Helper();

    void StartOrContinueLocking();

    void Disconnect();

};

class SwChartDataSequence;

typedef cppu::WeakImplHelper

<

    css::chart2::data::XDataProvider,

    css::chart2::data::XRangeXMLConversion,

    css::lang::XComponent,

    css::lang::XServiceInfo

>

SwChartDataProviderBaseClass;

class SwChartDataProvider final :

    public SwChartDataProviderBaseClass

{

    // used to keep weak-references to all data-sequences of a single table

    // see definition below...

    typedef std::vector< unotools::WeakReference < SwChartDataSequence > > Vec_DataSequenceRef_t;

    // map of data-sequence sets for each table

    typedef std::map< const SwTable *, Vec_DataSequenceRef_t > Map_Set_DataSequenceRef_t;

    // map of all data-sequences provided directly or indirectly (e.g. via

    // data-source) by this object. Since there is only one object of this type

    // for each document it should hold references to all used data-sequences for

    // all tables of the document.

    mutable Map_Set_DataSequenceRef_t       m_aDataSequences;

    ::comphelper::OInterfaceContainerHelper4<css::lang::XEventListener> m_aEventListeners;

    const SwDoc *                           m_pDoc;

    bool                                    m_bDisposed;

    SwChartDataProvider( const SwChartDataProvider & ) = delete;

    SwChartDataProvider & operator = ( const SwChartDataProvider & ) = delete;

    /// @throws css::lang::IllegalArgumentException

    /// @throws css::uno::RuntimeException

    css::uno::Reference< css::chart2::data::XDataSource > Impl_createDataSource( const css::uno::Sequence< css::beans::PropertyValue >& aArguments, bool bTestOnly = false );

    /// @throws css::lang::IllegalArgumentException

    /// @throws css::uno::RuntimeException

    css::uno::Reference< css::chart2::data::XDataSequence > Impl_createDataSequenceByRangeRepresentation( std::u16string_view aRangeRepresentation, bool bTestOnly = false );

    static OUString GetBrokenCellRangeForExport( std::u16string_view rCellRangeRepresentation );

public:

    SwChartDataProvider( const SwDoc& rDoc );

    virtual ~SwChartDataProvider() override;

    // XDataProvider

    virtual sal_Bool SAL_CALL createDataSourcePossible( const css::uno::Sequence< css::beans::PropertyValue >& aArguments ) override;

    virtual css::uno::Reference< css::chart2::data::XDataSource > SAL_CALL createDataSource( const css::uno::Sequence< css::beans::PropertyValue >& aArguments ) override;

    virtual css::uno::Sequence< css::beans::PropertyValue > SAL_CALL detectArguments( const css::uno::Reference< css::chart2::data::XDataSource >& xDataSource ) override;

    virtual sal_Bool SAL_CALL createDataSequenceByRangeRepresentationPossible( const OUString& aRangeRepresentation ) override;

    virtual css::uno::Reference< css::chart2::data::XDataSequence > SAL_CALL createDataSequenceByRangeRepresentation( const OUString& aRangeRepresentation ) override;

    virtual css::uno::Reference< css::sheet::XRangeSelection > SAL_CALL getRangeSelection(  ) override;

    virtual css::uno::Reference<css::chart2::data::XDataSequence>

        SAL_CALL createDataSequenceByValueArray(

            const OUString& aRole, const OUString& aRangeRepresentation, const OUString& aRoleQualifier ) override;

    // XRangeXMLConversion

    virtual OUString SAL_CALL convertRangeToXML( const OUString& aRangeRepresentation ) override;

    virtual OUString SAL_CALL convertRangeFromXML( const OUString& aXMLRange ) override;

    // XComponent

    virtual void SAL_CALL dispose(  ) override;

    virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;

    virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;

    // XServiceInfo

    virtual OUString SAL_CALL getImplementationName(  ) override;

    virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;

    virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;

    void        AddDataSequence( const SwTable &rTable, rtl::Reference< SwChartDataSequence > const &rxDataSequence );

    void        RemoveDataSequence( const SwTable &rTable, rtl::Reference< SwChartDataSequence > const &rxDataSequence );

    // will send modified events for all data-sequences of the table

    // tdf#122995 added Immediate-Mode to allow non-timer-delayed Chart invalidation

    void        InvalidateTable( const SwTable *pTable, bool bImmediate = false );

    void        DeleteBox( const SwTable *pTable, const SwTableBox &rBox );

    void        DisposeAllDataSequences( const SwTable *pTable );

    // functionality needed to get notified about new added rows/cols

    void        AddRowCols( const SwTable &rTable, const SwSelBoxes& rBoxes, sal_uInt16 nLines, bool bBehind );

};

typedef cppu::WeakImplHelper

<

    css::chart2::data::XDataSource,

    css::lang::XServiceInfo

>

SwChartDataSourceBaseClass;

class SwChartDataSource final :

    public SwChartDataSourceBaseClass

{

    css::uno::Sequence<

        css::uno::Reference< css::chart2::data::XLabeledDataSequence > > m_aLDS;

    SwChartDataSource( const SwChartDataSource & ) = delete;

    SwChartDataSource & operator = ( const SwChartDataSource & ) = delete;

public:

    SwChartDataSource( const css::uno::Sequence< css::uno::Reference< css::chart2::data::XLabeledDataSequence > > &rLDS );

    virtual ~SwChartDataSource() override;

    // XDataSource

    virtual css::uno::Sequence< css::uno::Reference< css::chart2::data::XLabeledDataSequence > > SAL_CALL getDataSequences(  ) override;

    // XServiceInfo

    virtual OUString SAL_CALL getImplementationName(  ) override;

    virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;

    virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;

};

typedef cppu::WeakImplHelper

<

    css::chart2::data::XDataSequence,

    css::chart2::data::XTextualDataSequence,

    css::chart2::data::XNumericalDataSequence,

    css::util::XCloneable,

    css::beans::XPropertySet,

    css::lang::XServiceInfo,

    css::util::XModifiable,

    css::lang::XEventListener,

    css::lang::XComponent

>

SwChartDataSequenceBaseClass;

class SwChartDataSequence final :

    public SwChartDataSequenceBaseClass,

    public SvtListener

{

    SwFrameFormat* m_pFormat;

    ::comphelper::OInterfaceContainerHelper4<css::lang::XEventListener> m_aEvtListeners;

    ::comphelper::OInterfaceContainerHelper4<css::util::XModifyListener> m_aModifyListeners;

    css::chart2::data::DataSequenceRole               m_aRole;

    OUString  m_aRowLabelText;

    OUString  m_aColLabelText;

    rtl::Reference<SwChartDataProvider>                m_xDataProvider;

    sw::UnoCursorPointer m_pTableCursor;   // cursor spanned over cells to use

    const SfxItemPropertySet*   m_pPropSet;

    bool    m_bDisposed;

    SwChartDataSequence( const SwChartDataSequence &rObj );

    SwChartDataSequence & operator = ( const SwChartDataSequence & ) = delete;

public:

    SwChartDataSequence( SwChartDataProvider &rProvider,

                         SwFrameFormat   &rTableFormat,

                         const std::shared_ptr<SwUnoCursor>& pTableCursor );

    virtual ~SwChartDataSequence() override;

    // XDataSequence

    virtual css::uno::Sequence< css::uno::Any > SAL_CALL getData() override;

    virtual OUString SAL_CALL getSourceRangeRepresentation() override;

    virtual css::uno::Sequence< OUString > SAL_CALL generateLabel( css::chart2::data::LabelOrigin eLabelOrigin ) override;

    virtual ::sal_Int32 SAL_CALL getNumberFormatKeyByIndex( ::sal_Int32 nIndex ) override;

    // XTextualDataSequence

    virtual css::uno::Sequence< OUString > SAL_CALL getTextualData() override;

    // XNumericalDataSequence

    virtual css::uno::Sequence< double > SAL_CALL getNumericalData() override;

    // XCloneable

    virtual css::uno::Reference< css::util::XCloneable > SAL_CALL createClone(  ) override;

    // XPropertySet

    virtual css::uno::Reference< css::beans::XPropertySetInfo > SAL_CALL getPropertySetInfo(  ) override;

    virtual void SAL_CALL setPropertyValue( const OUString& aPropertyName, const css::uno::Any& aValue ) override;

    virtual css::uno::Any SAL_CALL getPropertyValue( const OUString& PropertyName ) override;

    virtual void SAL_CALL addPropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& xListener ) override;

    virtual void SAL_CALL removePropertyChangeListener( const OUString& aPropertyName, const css::uno::Reference< css::beans::XPropertyChangeListener >& aListener ) override;

    virtual void SAL_CALL addVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;

    virtual void SAL_CALL removeVetoableChangeListener( const OUString& PropertyName, const css::uno::Reference< css::beans::XVetoableChangeListener >& aListener ) override;

    // XServiceInfo

    virtual OUString SAL_CALL getImplementationName(  ) override;

    virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;

    virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;

    // XModifiable

    virtual sal_Bool SAL_CALL isModified(  ) override;

    virtual void SAL_CALL setModified( sal_Bool bModified ) override;

    // XModifyBroadcaster

    virtual void SAL_CALL addModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;

    virtual void SAL_CALL removeModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;

    // XEventListener

    virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;

    // XComponent

    virtual void SAL_CALL dispose(  ) override;

    virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;

    virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;

    SwFrameFormat* GetFrameFormat() const { return m_pFormat; }

    bool DeleteBox( const SwTableBox &rBox );

    void        FillRangeDesc( SwRangeDescriptor &rRangeDesc ) const;

    void        ExtendTo( bool bExtendCol, sal_Int32 nFirstNew, sal_Int32 nCount );

    std::vector< css::uno::Reference< css::table::XCell > > GetCells();

    virtual void Notify(const SfxHint& rHint) override;

};

typedef cppu::WeakImplHelper

<

    css::chart2::data::XLabeledDataSequence2,

    css::lang::XServiceInfo,

    css::util::XModifyListener,

    css::lang::XComponent

>

SwChartLabeledDataSequenceBaseClass;

class SwChartLabeledDataSequence final :

    public SwChartLabeledDataSequenceBaseClass

{

    ::comphelper::OInterfaceContainerHelper4<css::lang::XEventListener> m_aEventListeners;

    ::comphelper::OInterfaceContainerHelper4<css::util::XModifyListener> m_aModifyListeners;

    css::uno::Reference< css::chart2::data::XDataSequence >     m_xData;

    css::uno::Reference< css::chart2::data::XDataSequence >     m_xLabels;

    bool    m_bDisposed;

    SwChartLabeledDataSequence( const SwChartLabeledDataSequence & ) = delete;

    SwChartLabeledDataSequence & operator = ( const SwChartLabeledDataSequence & ) = delete;

    void    SetDataSequence( css::uno::Reference< css::chart2::data::XDataSequence >& rxDest, const css::uno::Reference< css::chart2::data::XDataSequence >& rxSource );

public:

    SwChartLabeledDataSequence();

    virtual ~SwChartLabeledDataSequence() override;

    // XLabeledDataSequence

    virtual css::uno::Reference< css::chart2::data::XDataSequence > SAL_CALL getValues(  ) override;

    virtual void SAL_CALL setValues( const css::uno::Reference< css::chart2::data::XDataSequence >& xSequence ) override;

    virtual css::uno::Reference< css::chart2::data::XDataSequence > SAL_CALL getLabel(  ) override;

    virtual void SAL_CALL setLabel( const css::uno::Reference< css::chart2::data::XDataSequence >& xSequence ) override;

    // XCloneable

    virtual css::uno::Reference< css::util::XCloneable > SAL_CALL createClone(  ) override;

    // XServiceInfo

    virtual OUString SAL_CALL getImplementationName(  ) override;

    virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;

    virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;

    // XEventListener

    virtual void SAL_CALL disposing( const css::lang::EventObject& Source ) override;

    // XModifyListener

    virtual void SAL_CALL modified( const css::lang::EventObject& aEvent ) override;

    // XModifyBroadcaster

    virtual void SAL_CALL addModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;

    virtual void SAL_CALL removeModifyListener( const css::uno::Reference< css::util::XModifyListener >& aListener ) override;

    // XComponent

    virtual void SAL_CALL dispose(  ) override;

    virtual void SAL_CALL addEventListener( const css::uno::Reference< css::lang::XEventListener >& xListener ) override;

    virtual void SAL_CALL removeEventListener( const css::uno::Reference< css::lang::XEventListener >& aListener ) override;

};

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */