Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 333 insertions, 0 deletions

diff --git a/include/svl/poolitem.hxx b/include/svl/poolitem.hxx
new file mode 100644
index 000000000..10a7901b4
--- /dev/null
+++ b/include/svl/poolitem.hxx
@@ -0,0 +1,333 @@
+/* -*- 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_SVL_POOLITEM_HXX
+#define INCLUDED_SVL_POOLITEM_HXX
+
+#include <sal/config.h>
+
+#include <memory>
+#include <vector>
+
+#include <com/sun/star/uno/Any.hxx>
+#include <svl/hint.hxx>
+#include <svl/svldllapi.h>
+#include <svl/typedwhich.hxx>
+#include <tools/mapunit.hxx>
+#include <tools/long.hxx>
+#include <boost/property_tree/ptree_fwd.hpp>
+
+class IntlWrapper;
+
+enum class SfxItemKind : sal_Int8
+{
+   NONE,
+   DeleteOnIdle,
+   StaticDefault,
+   PoolDefault
+};
+
+#define SFX_ITEMS_OLD_MAXREF                0xffef
+#define SFX_ITEMS_MAXREF                    0xfffffffe
+#define SFX_ITEMS_SPECIAL                   0xffffffff
+
+#define CONVERT_TWIPS                       0x80    // Uno conversion for measurement (for MemberId)
+
+// warning, if there is no boolean inside the any this will always return the value false
+inline bool Any2Bool( const css::uno::Any&rValue )
+{
+    bool bValue = false;
+    if( !(rValue >>= bValue) )
+    {
+        sal_Int32 nNum = 0;
+        if( rValue >>= nNum )
+            bValue = nNum != 0;
+    }
+
+    return bValue;
+}
+
+/*
+ * The values of this enum describe the degree of textual
+ * representation of an item after calling the virtual
+ * method <SfxPoolItem::GetPresentation()const>.
+ */
+enum class SfxItemPresentation
+{
+    Nameless,
+    Complete
+};
+
+/**
+ * These values have to match the values in the
+ * css::frame::status::ItemState IDL
+ * to be found at offapi/com/sun/star/frame/status/ItemState.idl
+*/
+enum class SfxItemState {
+
+    /** Specifies an unknown state. */
+    UNKNOWN  = 0,
+
+    /** Specifies that the property is currently disabled. */
+    DISABLED = 0x0001,
+
+    /** Specifies that the property is currently in a don't care state.
+     * <br/>
+     * This is normally used if a selection provides more than one state
+     * for a property at the same time.
+     */
+    DONTCARE = 0x0010,
+
+    /** Specifies that the property is currently in a default state. */
+    DEFAULT  = 0x0020,
+
+    /** The property has been explicitly set to a given value hence we know
+     * we are not taking the default value.
+     * <br/>
+     * For example, you may want to get the font color and it might either
+     * be the default one or one that has been explicitly set.
+    */
+    SET      = 0x0040
+};
+
+#define INVALID_POOL_ITEM reinterpret_cast<SfxPoolItem*>(-1)
+
+class SfxItemPool;
+class SfxItemSet;
+typedef struct _xmlTextWriter* xmlTextWriterPtr;
+
+class SVL_DLLPUBLIC SfxPoolItem
+{
+friend class SfxItemPool;
+friend class SfxItemDisruptor_Impl;
+friend class SfxItemPoolCache;
+friend class SfxItemSet;
+friend class SfxVoidItem;
+
+    mutable sal_uInt32 m_nRefCount;
+    sal_uInt16  m_nWhich;
+    SfxItemKind  m_nKind;
+
+private:
+    inline void              SetRefCount(sal_uInt32 n);
+    inline void              SetKind( SfxItemKind n );
+public:
+    inline void              AddRef(sal_uInt32 n = 1) const;
+private:
+    inline sal_uInt32        ReleaseRef(sal_uInt32 n = 1) const;
+
+protected:
+                             explicit SfxPoolItem( sal_uInt16 nWhich = 0 );
+                             SfxPoolItem( const SfxPoolItem& rCopy)
+                                 : SfxPoolItem(rCopy.m_nWhich) {}
+
+public:
+    virtual                  ~SfxPoolItem();
+
+    void                     SetWhich( sal_uInt16 nId )
+                             {
+                                 // can only change the Which before we are in a set
+                                 assert(m_nRefCount==0);
+                                 m_nWhich = nId;
+                             }
+    sal_uInt16               Which() const { return m_nWhich; }
+    // StaticWhichCast asserts if the TypedWhichId is not matching its type, otherwise it returns a reference.
+    // You can use StaticWhichCast when you are sure about the type at compile time -- like a static_cast.
+    template<class T> T& StaticWhichCast(TypedWhichId<T> nId)
+    {
+        (void)nId;
+        assert(nId == m_nWhich);
+        assert(dynamic_cast<T*>(this));
+        return *static_cast<T*>(this);
+    }
+    template<class T> const T& StaticWhichCast(TypedWhichId<T> nId) const
+    {
+        (void)nId;
+        assert(nId == m_nWhich);
+        assert(dynamic_cast<const T*>(this));
+        return *static_cast<const T*>(this);
+    }
+    // DynamicWhichCast returns nullptr if the TypedWhichId is not matching its type, otherwise it returns a typed pointer.
+    // it asserts if the TypedWhichId matches its Which, but not the RTTI type.
+    // You can use DynamicWhichCast when you are not sure about the type at compile time -- like a dynamic_cast.
+    template<class T> T* DynamicWhichCast(TypedWhichId<T> nId)
+    {
+        if(m_nWhich != nId)
+            return nullptr;
+        assert(dynamic_cast<T*>(this));
+        return static_cast<T*>(this);
+    }
+    template<class T> const T* DynamicWhichCast(TypedWhichId<T> nId) const
+    {
+        if(m_nWhich != nId)
+            return nullptr;
+        assert(dynamic_cast<const T*>(this));
+        return static_cast<const T*>(this);
+    }
+    virtual bool             operator==( const SfxPoolItem& ) const = 0;
+    bool                     operator!=( const SfxPoolItem& rItem ) const
+                             { return !(*this == rItem); }
+
+    // Sorting is only used for faster searching in a pool which contains large quantities
+    // of a single kind of pool item.
+    virtual bool             operator<( const SfxPoolItem& ) const { assert(false); return false; }
+    virtual bool             IsSortable() const { return false; }
+
+    // Some item types cannot be IsSortable() (such as because they are modified while stored
+    // in a pool, which would change the ordering position, see e.g. 585e0ac43b9bd8a2f714903034).
+    // To improve performance in such cases it is possible to reimplement Lookup() to do a linear
+    // lookup optimized for the specific class (avoiding virtual functions may allow the compiler
+    // to generate better code and class-specific optimizations such as hashing or caching may
+    // be used.)
+    // If reimplemented, the Lookup() function should search [begin,end) for an item matching
+    // this object and return an iterator pointing to the item or the end iterator.
+    virtual bool             HasLookup() const { return false; }
+    typedef std::vector<SfxPoolItem*>::const_iterator lookup_iterator;
+    virtual lookup_iterator  Lookup(lookup_iterator /*begin*/, lookup_iterator end ) const
+                             { assert( false ); return end; }
+
+    /**  @return true if it has a valid string representation */
+    virtual bool             GetPresentation( SfxItemPresentation ePresentation,
+                                    MapUnit eCoreMetric,
+                                    MapUnit ePresentationMetric,
+                                    OUString &rText,
+                                    const IntlWrapper& rIntlWrapper ) const;
+
+    virtual void             ScaleMetrics( tools::Long lMult, tools::Long lDiv );
+    virtual bool             HasMetrics() const;
+
+    virtual bool             QueryValue( css::uno::Any& rVal, sal_uInt8 nMemberId = 0 ) const;
+    virtual bool             PutValue( const css::uno::Any& rVal, sal_uInt8 nMemberId );
+
+    virtual SfxPoolItem*     Clone( SfxItemPool *pPool = nullptr ) const = 0;
+    // clone and call SetWhich
+    std::unique_ptr<SfxPoolItem> CloneSetWhich( sal_uInt16 nNewWhich ) const;
+    template<class T> std::unique_ptr<T> CloneSetWhich( TypedWhichId<T> nId ) const
+    {
+        return std::unique_ptr<T>(static_cast<T*>(CloneSetWhich(sal_uInt16(nId)).release()));
+    }
+
+    sal_uInt32               GetRefCount() const { return m_nRefCount; }
+    SfxItemKind       GetKind() const { return m_nKind; }
+    virtual void dumpAsXml(xmlTextWriterPtr pWriter) const;
+    virtual boost::property_tree::ptree dumpAsJSON() const;
+
+    /** Only SfxVoidItem shall and must return true for this.
+
+        This avoids costly calls to dynamic_cast<const SfxVoidItem*>()
+        specifically in SfxItemSet::GetItemState()
+     */
+    virtual bool             IsVoidItem() const;
+
+private:
+    SfxPoolItem&             operator=( const SfxPoolItem& ) = delete;
+};
+
+inline void SfxPoolItem::SetRefCount(sal_uInt32 n)
+{
+    m_nRefCount = n;
+    m_nKind = SfxItemKind::NONE;
+}
+
+inline void SfxPoolItem::SetKind( SfxItemKind n )
+{
+    m_nRefCount = SFX_ITEMS_SPECIAL;
+    m_nKind = n;
+}
+
+inline void SfxPoolItem::AddRef(sal_uInt32 n) const
+{
+    assert(m_nRefCount <= SFX_ITEMS_MAXREF && "AddRef with non-Pool-Item");
+    assert(n <= SFX_ITEMS_MAXREF - m_nRefCount && "AddRef: refcount overflow");
+    m_nRefCount += n;
+}
+
+inline sal_uInt32 SfxPoolItem::ReleaseRef(sal_uInt32 n) const
+{
+    assert(m_nRefCount <= SFX_ITEMS_MAXREF && "ReleaseRef with non-Pool-Item");
+    assert(n <= m_nRefCount);
+    m_nRefCount -= n;
+    return m_nRefCount;
+}
+
+inline bool IsPoolDefaultItem(const SfxPoolItem *pItem )
+{
+    return pItem && pItem->GetKind() == SfxItemKind::PoolDefault;
+}
+
+inline bool IsStaticDefaultItem(const SfxPoolItem *pItem )
+{
+    return pItem && pItem->GetKind() == SfxItemKind::StaticDefault;
+}
+
+inline bool IsDefaultItem( const SfxPoolItem *pItem )
+{
+    return pItem && (pItem->GetKind() == SfxItemKind::StaticDefault || pItem->GetKind() == SfxItemKind::PoolDefault);
+}
+
+inline bool IsPooledItem( const SfxPoolItem *pItem )
+{
+    return pItem && pItem->GetRefCount() > 0 && pItem->GetRefCount() <= SFX_ITEMS_MAXREF;
+}
+
+inline bool IsInvalidItem(const SfxPoolItem *pItem)
+{
+    return pItem == INVALID_POOL_ITEM;
+}
+
+class SVL_DLLPUBLIC SfxVoidItem final: public SfxPoolItem
+{
+public:
+                            static SfxPoolItem* CreateDefault();
+                            explicit SfxVoidItem( sal_uInt16 nWhich );
+                            virtual ~SfxVoidItem() override;
+
+    SfxVoidItem(SfxVoidItem const &) = default;
+    SfxVoidItem(SfxVoidItem &&) = default;
+    SfxVoidItem & operator =(SfxVoidItem const &) = delete; // due to SfxPoolItem
+    SfxVoidItem & operator =(SfxVoidItem &&) = delete; // due to SfxPoolItem
+
+    virtual bool            operator==( const SfxPoolItem& ) const override;
+
+    virtual bool GetPresentation( SfxItemPresentation ePres,
+                                    MapUnit eCoreMetric,
+                                    MapUnit ePresMetric,
+                                    OUString &rText,
+                                    const IntlWrapper& ) const override;
+    virtual void dumpAsXml(xmlTextWriterPtr pWriter) const override;
+
+    // create a copy of itself
+    virtual SfxVoidItem*    Clone( SfxItemPool *pPool = nullptr ) const override;
+
+    /** Always returns true as this is an SfxVoidItem. */
+    virtual bool            IsVoidItem() const override;
+};
+
+
+class SVL_DLLPUBLIC SfxPoolItemHint final : public SfxHint
+{
+    SfxPoolItem* pObj;
+public:
+    explicit SfxPoolItemHint( SfxPoolItem* Object ) : pObj(Object) {}
+    SfxPoolItem* GetObject() const { return pObj; }
+};
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */