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

 */

#pragma once

#include <svtools/svtdllapi.h>

#include <com/sun/star/beans/PropertyValue.hpp>

#include <com/sun/star/frame/XStatusListener.hpp>

#include <com/sun/star/frame/XToolbarController.hpp>

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

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

#include <com/sun/star/uno/Sequence.hxx>

#include <comphelper/compbase.hxx>

#include <comphelper/propcontainerimplhelper.hxx>

#include <tools/link.hxx>

#include <utility>

#include <vcl/toolboxid.hxx>

#include <unordered_map>

namespace com::sun::star::frame { class XDispatch; }

namespace com::sun::star::frame { class XFrame; }

namespace com::sun::star::frame { class XLayoutManager; }

namespace com::sun::star::uno { class XComponentContext; }

namespace com::sun::star::util { class XURLTransformer; }

namespace weld { class Builder; }

namespace weld { class Toolbar; }

class ToolBox;

namespace svt

{

    class ToolboxController;

}

// extern template otherwise the ref-counting magic here ends up duplicated across multiple libraries

extern template class SAL_DLLPUBLIC_TEMPLATE comphelper::OPropertyArrayUsageHelper<svt::ToolboxController>;

namespace svt

{

typedef comphelper::WeakComponentImplHelper<

        css::frame::XStatusListener, css::frame::XToolbarController,

        css::lang::XInitialization, css::util::XUpdatable >

    ToolboxController_Base;

class SVT_DLLPUBLIC ToolboxController :

                          public ::comphelper::OPropertyContainerImplHelper<

                              ToolboxController_Base, ToolboxController >

{

    private:

        bool  m_bSupportVisible;

    public:

        ToolboxController( const css::uno::Reference< css::uno::XComponentContext >& rxContext,

                           const css::uno::Reference< css::frame::XFrame >& xFrame,

                           OUString aCommandURL );

        ToolboxController();

        virtual ~ToolboxController() override;

        css::uno::Reference< css::frame::XFrame > getFrameInterface() const;

        const css::uno::Reference< css::uno::XComponentContext >& getContext() const;

        css::uno::Reference< css::frame::XLayoutManager > getLayoutManager() const;

        void updateStatus( const OUString& rCommandURL );

        void updateStatus();

        // XInitialization

        virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& rArguments ) override;

        // XUpdatable

        virtual void SAL_CALL update() override;

        // XEventListener

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

        // XStatusListener

        virtual void SAL_CALL statusChanged( const css::frame::FeatureStateEvent& Event ) override = 0;

        // XToolbarController

        virtual void SAL_CALL execute( sal_Int16 KeyModifier ) override;

        virtual void SAL_CALL click() override;

        virtual void SAL_CALL doubleClick() override;

        virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createPopupWindow() override;

        virtual css::uno::Reference< css::awt::XWindow > SAL_CALL createItemWindow( const css::uno::Reference< css::awt::XWindow >& Parent ) override;

        // OPropertyArrayUsageHelper

        virtual ::cppu::IPropertyArrayHelper* createArrayHelper( ) const override;

        const OUString& getCommandURL() const { return  m_aCommandURL; }

        const OUString& getModuleName() const { return m_sModuleName; }

        void dispatchCommand( const OUString& sCommandURL, const css::uno::Sequence< css::beans::PropertyValue >& rArgs, const OUString &rTarget = OUString() );

        void enable( bool bEnable );

        bool IsInSidebar() const { return m_bSidebar; }

    protected:

        // weak component / custom disposal

        virtual void disposing(std::unique_lock<std::mutex>& rGuard) override;

        bool getToolboxId( ToolBoxItemId& rItemId, ToolBox** ppToolBox );

        struct Listener

        {

            Listener( css::util::URL _aURL, css::uno::Reference< css::frame::XDispatch > _xDispatch ) :

                aURL(std::move( _aURL )), xDispatch(std::move( _xDispatch )) {}

            css::util::URL aURL;

            css::uno::Reference< css::frame::XDispatch > xDispatch;

        };

        struct DispatchInfo

        {

            css::uno::Reference< css::frame::XDispatch > mxDispatch;

            const css::util::URL maURL;

            const css::uno::Sequence< css::beans::PropertyValue > maArgs;

            DispatchInfo( css::uno::Reference< css::frame::XDispatch > xDispatch,

                          css::util::URL aURL,

                          const css::uno::Sequence< css::beans::PropertyValue >& rArgs )

                : mxDispatch(std::move( xDispatch ))

                , maURL(std::move( aURL ))

                , maArgs( rArgs )

                {}

        };

        DECL_DLLPRIVATE_STATIC_LINK( ToolboxController, ExecuteHdl_Impl, void*, void );

        typedef std::unordered_map< OUString,

                                    css::uno::Reference< css::frame::XDispatch > > URLToDispatchMap;

        // methods to support status forwarder, known by the old sfx2 toolbox controller implementation

        void addStatusListener( const OUString& rCommandURL );

        void removeStatusListener( const OUString& rCommandURL );

        void bindListener();

        void unbindListener();

        // TODO remove

        const css::uno::Reference< css::util::XURLTransformer >& getURLTransformer() const { return m_xUrlTransformer;}

        // TODO remove

        const css::uno::Reference< css::awt::XWindow >& getParent() const { return m_xParentWindow;}

        bool                                                      m_bInitialized,

                                                                  m_bSidebar;

        ToolBoxItemId                                             m_nToolBoxId;

        css::uno::Reference< css::frame::XFrame >                 m_xFrame;

        css::uno::Reference< css::uno::XComponentContext >        m_xContext;

        OUString                                                  m_aCommandURL;

        URLToDispatchMap                                          m_aListenerMap;

        css::uno::Reference< css::awt::XWindow >                  m_xParentWindow;

        css::uno::Reference< css::util::XURLTransformer >         m_xUrlTransformer;

        OUString                                                  m_sModuleName;

        weld::Toolbar*                                            m_pToolbar;

        weld::Builder*                                            m_pBuilder;

};

}

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