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

#include <memory>

#include <vector>

#include <set>

#include <sfx2/dllapi.h>

#include <rtl/ustring.hxx>

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

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

namespace com::sun::star::uno { template <class interface_type> class Reference; }

namespace sfx2::sidebar { class DeckDescriptor; }

namespace sfx2::sidebar { class PanelDescriptor; }

namespace utl { class OConfigurationNode; }

namespace utl { class OConfigurationTreeRoot; }

namespace sfx2::sidebar {

class Context;

class ContextList;

/** Read the content of the Sidebar.xcu file and provide access

    methods so that the sidebar can easily decide which content panels

    to display for a certain context.

*/

class SFX2_DLLPUBLIC ResourceManager

{

public:

     ResourceManager();

    ~ResourceManager();

    std::shared_ptr<DeckDescriptor> GetDeckDescriptor(std::u16string_view rsDeckId) const;

    std::shared_ptr<PanelDescriptor> GetPanelDescriptor(std::u16string_view rsPanelId) const;

    void UpdateModel(const css::uno::Reference<css::frame::XModel>& xModel);

    void InitDeckContext(const Context& rContex);

    void SaveDecksSettings(const Context& rContext);

    void SaveDeckSettings(const DeckDescriptor* pDeckDesc);

    void SaveLastActiveDeck(const Context& rContext, const OUString& rActiveDeck);

    void disposeDecks();

    class DeckContextDescriptor

    {

    public:

        OUString msId;

        bool mbIsEnabled;

    };

    typedef std::vector<DeckContextDescriptor> DeckContextDescriptorContainer;

    class PanelContextDescriptor

    {

    public:

        OUString msId;

        OUString msMenuCommand;

        bool mbIsInitiallyVisible;

        bool mbShowForReadOnlyDocuments;

    };

    typedef std::vector<PanelContextDescriptor> PanelContextDescriptorContainer;

    const DeckContextDescriptorContainer& GetMatchingDecks(

                                            DeckContextDescriptorContainer& rDeckDescriptors,

                                            const Context& rContext,

                                            const bool bIsDocumentReadOnly,

                                            const css::uno::Reference<css::frame::XController>& rxController);

    const PanelContextDescriptorContainer& GetMatchingPanels(

                                            PanelContextDescriptorContainer& rPanelDescriptors,

                                            const Context& rContext,

                                            std::u16string_view rsDeckId,

                                            const css::uno::Reference<css::frame::XController>& rxController);

    const OUString& GetLastActiveDeck( const Context& rContext );

    const std::map<OUString, OUString>& GetDeckOverrides() {

        if (maApplicationDeckOverrides.empty())

            SetupOverrides();

        return maApplicationDeckOverrides;

    }

    void SetLastActiveDeck( const Context& rContext, const OUString& rsDeckId );

    /** Remember the expansions state per panel and context.

    */

    void StorePanelExpansionState(std::u16string_view rsPanelId,

                                  const bool bExpansionState,

                                  const Context& rContext);

private:

    typedef std::vector<std::shared_ptr<DeckDescriptor>> DeckContainer;

    DeckContainer maDecks;

    typedef std::vector<std::shared_ptr<PanelDescriptor>> PanelContainer;

    PanelContainer maPanels;

    mutable std::set<OUString> maProcessedApplications;

    std::map<OUString, OUString> maLastActiveDecks;

    // always jump to Deck on Application type, override last used

    std::map<OUString, OUString> maApplicationDeckOverrides;

    void ReadDeckList();

    void ReadPanelList();

    void ReadLastActive();

    void SetupOverrides();

    static void ReadContextList(const utl::OConfigurationNode& rNode,

                         ContextList& rContextList,

                         const OUString& rsDefaultMenuCommand);

    void ReadLegacyAddons(const css::uno::Reference<css::frame::XController>& rxController);

    static utl::OConfigurationTreeRoot GetLegacyAddonRootNode(const OUString& rsModuleName);

    static void GetToolPanelNodeNames(std::vector<OUString>& rMatchingNames,

                               const utl::OConfigurationTreeRoot& aRoot);

    bool IsDeckEnabled(std::u16string_view rsDeckId,

                       const Context& rContext,

                       const css::uno::Reference<css::frame::XController>& rxController);

    std::shared_ptr<DeckDescriptor> ImplGetDeckDescriptor(std::u16string_view rsDeckId) const;

    std::shared_ptr<PanelDescriptor> ImplGetPanelDescriptor(std::u16string_view rsPanelId) const;

};

} // end of namespace sfx2::sidebar

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