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, 316 insertions, 0 deletions

diff --git a/include/rtl/ref.hxx b/include/rtl/ref.hxx
new file mode 100644
index 000000000..38dfe3769
--- /dev/null
+++ b/include/rtl/ref.hxx
@@ -0,0 +1,316 @@
+/* -*- 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 .
+ */
+
+/*
+ * This file is part of LibreOffice published API.
+ */
+
+#ifndef INCLUDED_RTL_REF_HXX
+#define INCLUDED_RTL_REF_HXX
+
+#include "sal/config.h"
+
+#include <cassert>
+#include <cstddef>
+#include <functional>
+#ifdef LIBO_INTERNAL_ONLY
+#include <type_traits>
+#include "com/sun/star/uno/Reference.h"
+#endif
+
+#include "sal/types.h"
+
+namespace rtl
+{
+
+/** Template reference class for reference type.
+*/
+template <class reference_type>
+class Reference
+{
+    /** The <b>reference_type</b> body pointer.
+     */
+    reference_type * m_pBody;
+
+
+public:
+    /** Constructor...
+     */
+    Reference()
+        : m_pBody (NULL)
+    {}
+
+
+    /** Constructor...
+     */
+    Reference (reference_type * pBody, __sal_NoAcquire)
+        : m_pBody (pBody)
+    {
+    }
+
+    /** Constructor...
+     */
+    Reference (reference_type * pBody)
+        : m_pBody (pBody)
+    {
+        if (m_pBody)
+            m_pBody->acquire();
+    }
+
+    /** Copy constructor...
+     */
+    Reference (const Reference<reference_type> & handle)
+        : m_pBody (handle.m_pBody)
+    {
+        if (m_pBody)
+            m_pBody->acquire();
+    }
+
+#ifdef LIBO_INTERNAL_ONLY
+    /** Move constructor...
+     */
+    Reference (Reference<reference_type> && handle) noexcept
+        : m_pBody (handle.m_pBody)
+    {
+        handle.m_pBody = nullptr;
+    }
+#endif
+
+#if defined LIBO_INTERNAL_ONLY
+    /** Up-casting conversion constructor: Copies interface reference.
+
+        Does not work for up-casts to ambiguous bases.
+
+        @param rRef another reference
+    */
+    template< class derived_type >
+    inline Reference(
+        const Reference< derived_type > & rRef,
+        std::enable_if_t<std::is_base_of_v<reference_type, derived_type>, int> = 0 )
+        : m_pBody (rRef.get())
+    {
+        if (m_pBody)
+            m_pBody->acquire();
+    }
+
+    /** Up-casting conversion operator to convert to css::uno::Interface
+
+        Does not work for up-casts to ambiguous bases.
+    */
+    template< class super_type,
+        std::enable_if_t<std::is_base_of_v<super_type, reference_type>, int> = 0 >
+    inline operator css::uno::Reference<super_type>() const
+    {
+        return css::uno::Reference<super_type>(m_pBody);
+    }
+#endif
+
+    /** Destructor...
+     */
+    ~Reference() COVERITY_NOEXCEPT_FALSE
+    {
+        if (m_pBody)
+            m_pBody->release();
+    }
+
+    /** Set...
+         Similar to assignment.
+     */
+    Reference<reference_type> &
+    SAL_CALL set (reference_type * pBody)
+    {
+        if (pBody)
+            pBody->acquire();
+        reference_type * const pOld = m_pBody;
+        m_pBody = pBody;
+        if (pOld)
+            pOld->release();
+        return *this;
+    }
+
+    /** Assignment.
+         Unbinds this instance from its body (if bound) and
+         bind it to the body represented by the handle.
+     */
+    Reference<reference_type> &
+    SAL_CALL operator= (const Reference<reference_type> & handle)
+    {
+        return set( handle.m_pBody );
+    }
+
+#ifdef LIBO_INTERNAL_ONLY
+    /** Assignment.
+     *   Unbinds this instance from its body (if bound),
+     *   bind it to the body represented by the handle, and
+     *   set the body represented by the handle to nullptr.
+     */
+    Reference<reference_type> &
+    operator= (Reference<reference_type> && handle)
+    {
+        // self-movement guts ourself
+        if (m_pBody)
+            m_pBody->release();
+        m_pBody = handle.m_pBody;
+        handle.m_pBody = nullptr;
+        return *this;
+    }
+#endif
+
+    /** Assignment...
+     */
+    Reference<reference_type> &
+    SAL_CALL operator= (reference_type * pBody)
+    {
+        return set( pBody );
+    }
+
+    /** Unbind the body from this handle.
+         Note that for a handle representing a large body,
+         "handle.clear().set(new body());" _might_
+         perform a little bit better than "handle.set(new body());",
+         since in the second case two large objects exist in memory
+         (the old body and the new body).
+     */
+    Reference<reference_type> & SAL_CALL clear()
+    {
+        if (m_pBody)
+        {
+            reference_type * const pOld = m_pBody;
+            m_pBody = NULL;
+            pOld->release();
+        }
+        return *this;
+    }
+
+
+    /** Get the body. Can be used instead of operator->().
+         I.e. handle->someBodyOp() and handle.get()->someBodyOp()
+         are the same.
+     */
+    reference_type * SAL_CALL get() const
+    {
+        return m_pBody;
+    }
+
+
+    /** Probably most common used: handle->someBodyOp().
+     */
+    reference_type * SAL_CALL operator->() const
+    {
+        assert(m_pBody != NULL);
+        return m_pBody;
+    }
+
+
+    /** Allows (*handle).someBodyOp().
+    */
+    reference_type & SAL_CALL operator*() const
+    {
+        assert(m_pBody != NULL);
+        return *m_pBody;
+    }
+
+
+    /** Returns True if the handle does point to a valid body.
+     */
+    bool SAL_CALL is() const
+    {
+        return (m_pBody != NULL);
+    }
+
+#if defined LIBO_INTERNAL_ONLY
+    /** Returns True if the handle does point to a valid body.
+     */
+    explicit operator bool() const
+    {
+        return is();
+    }
+#endif
+
+    /** Returns True if this points to pBody.
+     */
+    bool SAL_CALL operator== (const reference_type * pBody) const
+    {
+        return (m_pBody == pBody);
+    }
+
+
+    /** Returns True if handle points to the same body.
+     */
+    bool
+    SAL_CALL operator== (const Reference<reference_type> & handle) const
+    {
+        return (m_pBody == handle.m_pBody);
+    }
+
+
+    /** Needed to place References into STL collection.
+     */
+    bool
+    SAL_CALL operator!= (const Reference<reference_type> & handle) const
+    {
+        return (m_pBody != handle.m_pBody);
+    }
+
+
+    /** Needed to place References into STL collection.
+     */
+    bool
+    SAL_CALL operator< (const Reference<reference_type> & handle) const
+    {
+        return (m_pBody < handle.m_pBody);
+    }
+
+
+    /** Needed to place References into STL collection.
+     */
+    bool
+    SAL_CALL operator> (const Reference<reference_type> & handle) const
+    {
+        return (m_pBody > handle.m_pBody);
+    }
+};
+
+} // namespace rtl
+
+#if defined LIBO_INTERNAL_ONLY
+namespace std
+{
+
+/// @cond INTERNAL
+/**
+  Make rtl::Reference hashable by default for use in STL containers.
+
+  @since LibreOffice 6.3
+*/
+template<typename T>
+struct hash<::rtl::Reference<T>>
+{
+    std::size_t operator()(::rtl::Reference<T> const & s) const
+    { return std::size_t(s.get()); }
+};
+/// @endcond
+
+}
+
+#endif
+
+#endif /* ! INCLUDED_RTL_REF_HXX */
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */