/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the Collabora Office 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 <rtl/ref.hxx>
#include <svl/listener.hxx>
#include <svl/style.hxx>
#include <com/sun/star/awt/FontSlant.hpp>
#include <com/sun/star/style/XStyle.hpp>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/beans/XPropertyState.hpp>
#include <com/sun/star/beans/XMultiPropertySet.hpp>
#include <com/sun/star/beans/XMultiPropertyStates.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XUnoTunnel.hpp>
#include <cppuhelper/implbase.hxx>
#include <osl/diagnose.h>
#include "coreframestyle.hxx"
#include "unobasestyle.hxx"
#include "names.hxx"
#include <span>

class StyleFamilyEntry;
class SwStyleBase_Impl;
class SwStyleProperties_Impl;
class SvxSetItem;
struct SfxItemPropertyMapEntry;
class SwDoc;
class SfxItemPropertySet;
class SwDocShell;
class SwXNumberingRules;
class SwDocStyleSheet;

/** The names of built-in styles at the API are ProgNames which are not subject
    to i18n and must never change - these are written into ODF files.

    The names of built-in styles in the core document model are UINames which
    are subject to i18n and may change in different versions.

    Take care to use SwStyleNameMapper::GetProgName() or
    SwStyleNameMapper::GetUIName() to convert here in the UNO service.
  */
class SAL_DLLPUBLIC_RTTI SwXStyle
    : public cppu::ImplInheritanceHelper<
          SwXBaseStyle, css::beans::XMultiPropertySet, css::lang::XServiceInfo,
          css::lang::XUnoTunnel, css::beans::XPropertyState, css::beans::XMultiPropertyStates>,
      public SfxListener,
      public SvtListener
{
    SwDoc* m_pDoc;
    UIName m_sStyleUIName; ///< UIName, needs conversion to ProgName
    const StyleFamilyEntry& m_rEntry;
    bool m_bIsDescriptor;
    bool m_bIsConditional;
    UIName m_sParentStyleUIName; ///< UIName, needs conversion to ProgName
    // cache UNO stylesheets
    std::unordered_map<SfxStyleSheetBase*, rtl::Reference<SwDocStyleSheet>> maUnoStyleSheets;

protected:
    SfxStyleSheetBasePool* m_pBasePool;
    std::unique_ptr<SwStyleProperties_Impl> m_pPropertiesImpl;
    css::uno::Reference<css::container::XNameAccess> m_xStyleFamily;
    css::uno::Reference<css::beans::XPropertySet> m_xStyleData;

    template <sal_uInt16>
    void SetPropertyValue(const SfxItemPropertyMapEntry&, const SfxItemPropertySet&,
                          const cpo::uno::Any&, SwStyleBase_Impl&);
    void SetPropertyValues_Impl(std::span<const OUString> aPropertyNames,
                                std::span<const cpo::uno::Any> aValues, bool bIgnoreUnknown);
    SfxStyleSheetBase* GetStyleSheetBase();
    void PrepareStyleBase(SwStyleBase_Impl& rBase);
    template <sal_uInt16>
    cpo::uno::Any GetStyleProperty(const SfxItemPropertyMapEntry& rEntry,
                                   const SfxItemPropertySet& rPropSet, SwStyleBase_Impl& rBase);
    cpo::uno::Any GetStyleProperty_Impl(const SfxItemPropertyMapEntry& rEntry,
                                        const SfxItemPropertySet& rPropSet,
                                        SwStyleBase_Impl& rBase);
    cpo::uno::Any GetPropertyValue_Impl(const SfxItemPropertySet* pPropSet, SwStyleBase_Impl& rBase,
                                        const OUString& rPropertyName);

public:
    SwXStyle(SwDoc* pDoc, SfxStyleFamily eFam, bool bConditional = false);
    SwXStyle(SfxStyleSheetBasePool* pPool, SfxStyleFamily eFamily, SwDoc* pDoc,
             const UIName& rStyleName);
    virtual ~SwXStyle() override;

    static const cpo::uno::Sequence<sal_Int8>& getUnoTunnelId();

    //XUnoTunnel
    virtual sal_Int64 SAL_CALL
    getSomething(const cpo::uno::Sequence<sal_Int8>& aIdentifier) override;

    //XNamed
    virtual OUString SAL_CALL getName() override;
    virtual void SAL_CALL setName(const OUString& Name_) override;

    //XStyle
    virtual bool SAL_CALL isUserDefined() override;
    virtual bool SAL_CALL isInUse() override;
    virtual OUString SAL_CALL getParentStyle() override;
    virtual void SAL_CALL setParentStyle(const OUString& aParentStyle) override;

    //XPropertySet
    SW_DLLPUBLIC virtual css::uno::Reference<css::beans::XPropertySetInfo>
        SAL_CALL getPropertySetInfo() override;
    virtual void SAL_CALL setPropertyValue(const OUString& aPropertyName,
                                           const cpo::uno::Any& aValue) override;
    virtual cpo::uno::Any SAL_CALL getPropertyValue(const OUString& PropertyName) override;
    virtual void SAL_CALL addPropertyChangeListener(
        const OUString&, const css::uno::Reference<css::beans::XPropertyChangeListener>&) override
    {
        OSL_FAIL("not implemented");
    };
    virtual void SAL_CALL removePropertyChangeListener(
        const OUString&, const css::uno::Reference<css::beans::XPropertyChangeListener>&) override
    {
        OSL_FAIL("not implemented");
    };
    virtual void SAL_CALL addVetoableChangeListener(
        const OUString&, const css::uno::Reference<css::beans::XVetoableChangeListener>&) override
    {
        OSL_FAIL("not implemented");
    };
    virtual void SAL_CALL removeVetoableChangeListener(
        const OUString&, const css::uno::Reference<css::beans::XVetoableChangeListener>&) override
    {
        OSL_FAIL("not implemented");
    };

    //XMultiPropertySet
    virtual void SAL_CALL
    setPropertyValues(const cpo::uno::Sequence<OUString>& aPropertyNames,
                      const cpo::uno::Sequence<cpo::uno::Any>& aValues) override;
    virtual cpo::uno::Sequence<cpo::uno::Any>
        SAL_CALL getPropertyValues(const cpo::uno::Sequence<OUString>& aPropertyNames) override;
    virtual void SAL_CALL addPropertiesChangeListener(
        const cpo::uno::Sequence<OUString>&,
        const css::uno::Reference<css::beans::XPropertiesChangeListener>&) override{};
    virtual void SAL_CALL removePropertiesChangeListener(
        const css::uno::Reference<css::beans::XPropertiesChangeListener>&) override{};
    virtual void SAL_CALL firePropertiesChangeEvent(
        const cpo::uno::Sequence<OUString>&,
        const css::uno::Reference<css::beans::XPropertiesChangeListener>&) override{};

    //XPropertyState
    virtual css::beans::PropertyState SAL_CALL
    getPropertyState(const OUString& PropertyName) override;
    virtual cpo::uno::Sequence<css::beans::PropertyState>
        SAL_CALL getPropertyStates(const cpo::uno::Sequence<OUString>& aPropertyName) override;
    virtual void SAL_CALL setPropertyToDefault(const OUString& PropertyName) override;
    virtual cpo::uno::Any SAL_CALL getPropertyDefault(const OUString& aPropertyName) override;

    //XMultiPropertyStates
    virtual void SAL_CALL setAllPropertiesToDefault() override;
    virtual void SAL_CALL
    setPropertiesToDefault(const cpo::uno::Sequence<OUString>& aPropertyNames) override;
    virtual cpo::uno::Sequence<cpo::uno::Any>
        SAL_CALL getPropertyDefaults(const cpo::uno::Sequence<OUString>& aPropertyNames) override;

    //XServiceInfo
    virtual OUString SAL_CALL getImplementationName() override;
    virtual bool SAL_CALL supportsService(const OUString& rServiceName) override;
    virtual cpo::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override;

    //SfxListener
    virtual void Notify(SfxBroadcaster& rBC, const SfxHint& rHint) override;
    //SvtListener
    virtual void Notify(const SfxHint&) override;
    //SfxListener
    /// Used to avoid cost of dynamic_cast in SwXStyleFamily::FindStyle
    virtual bool IsSwXStyle() const override final { return true; }

    SW_DLLPUBLIC rtl::Reference<SwXNumberingRules> getNumberingRules();

    const UIName& GetStyleUIName() const { return m_sStyleUIName; }
    SfxStyleFamily GetFamily() const;

    bool IsDescriptor() const { return m_bIsDescriptor; }
    bool IsConditional() const { return m_bIsConditional; }
    const UIName& GetParentStyleUIName() const { return m_sParentStyleUIName; }
    void SetDoc(SwDoc* pDc, SfxStyleSheetBasePool* pPool)
    {
        m_bIsDescriptor = false;
        m_pDoc = pDc;
        m_pBasePool = pPool;
        SfxListener::StartListening(*m_pBasePool);
    }
    SwDoc* GetDoc() const { return m_pDoc; }
    void Invalidate();
    void ApplyDescriptorProperties();
    void SetStyleUIName(const UIName& rSet) { m_sStyleUIName = rSet; }
    /// @throws beans::PropertyVetoException
    /// @throws lang::IllegalArgumentException
    /// @throws lang::WrappedTargetException
    /// @throws uno::RuntimeException
    void SetStyleProperty(const SfxItemPropertyMapEntry& rEntry, const SfxItemPropertySet& rPropSet,
                          const cpo::uno::Any& rValue, SwStyleBase_Impl& rBase);
    void PutItemToSet(const SvxSetItem* pSetItem, const SfxItemPropertySet& rPropSet,
                      const SfxItemPropertyMapEntry& rEntry, const cpo::uno::Any& rVal,
                      SwStyleBase_Impl& rBaseImpl);
    SW_DLLPUBLIC void getToggleAttributes(
        float& rfCharStyleBold, float& rfCharStyleBoldComplex,
        css::awt::FontSlant& reCharStylePosture, css::awt::FontSlant& reCharStylePostureComplex,
        sal_Int16& rnCharStyleCaseMap, sal_Int16& rnCharStyleRelief, bool& rbCharStyleContoured,
        bool& rbCharStyleShadowed, sal_Int16& rnCharStyleStrikeThrough, bool& rbCharStyleHidden);
    // Set without throwing exceptions for unknown props, which is faster than throwing and then
    // ignoring.
    SW_DLLPUBLIC void setPropertyValueIgnoreUnknown(const OUString& aPropertyName,
                                                    const cpo::uno::Any& aValue);
    void SetPropertyValues(std::span<const OUString> aPropertyNames,
                           std::span<const cpo::uno::Any> aValues);
};

typedef cppu::ImplInheritanceHelper<SwXStyle, css::document::XEventsSupplier> SwXFrameStyle_Base;
class SwXFrameStyle final : public SwXFrameStyle_Base, public sw::ICoreFrameStyle
{
public:
    SwXFrameStyle(SfxStyleSheetBasePool& rPool, SwDoc* pDoc, const UIName& rStyleName)
        : SwXFrameStyle_Base(&rPool, SfxStyleFamily::Frame, pDoc, rStyleName)
    {
    }
    explicit SwXFrameStyle(SwDoc* pDoc);

    virtual css::uno::Reference<css::container::XNameReplace> SAL_CALL getEvents() override;

    //ICoreStyle
    virtual void SetItem(sal_uInt16 eAtr, const SfxPoolItem& rItem) override;
    virtual const SfxPoolItem* GetItem(sal_uInt16 eAtr) override;
    virtual css::document::XEventsSupplier& GetEventsSupplier() override { return *this; };
};

class SW_DLLPUBLIC SwXPageStyle final : public SwXStyle
{
protected:
    void SetPropertyValues_Impl(const cpo::uno::Sequence<OUString>& aPropertyNames,
                                const cpo::uno::Sequence<cpo::uno::Any>& aValues);
    cpo::uno::Sequence<cpo::uno::Any>
    GetPropertyValues_Impl(const cpo::uno::Sequence<OUString>& aPropertyNames);

public:
    SwXPageStyle(SfxStyleSheetBasePool& rPool, SwDocShell* pDocSh, const UIName& rStyleName);
    explicit SwXPageStyle(SwDocShell* pDocSh);

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

    virtual void SAL_CALL
    setPropertyValues(const cpo::uno::Sequence<OUString>& aPropertyNames,
                      const cpo::uno::Sequence<cpo::uno::Any>& aValues) override;
    virtual cpo::uno::Sequence<cpo::uno::Any>
        SAL_CALL getPropertyValues(const cpo::uno::Sequence<OUString>& aPropertyNames) override;
};

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