AutoPointer.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.8.5
// ----------------------------------------------------------------------------
// pcl/AutoPointer.h - Released 2024-12-28T16:53:48Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_AutoPointer_h
#define __PCL_AutoPointer_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Utility.h>
 
#ifdef __PCL_QT_INTERFACE
#  include <QtCore/QObject>
#  include <QtGui/QAction>
#endif
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
template <typename T>
class PCL_CLASS StandardDeleter
{
public:
 
   using value_type = T;
 
   using pointer = T*;
 
   void operator()( pointer p ) const
   {
      PCL_PRECONDITION( p != nullptr )
      delete p;
   }
};
 
// ----------------------------------------------------------------------------
 
template <class T, class D = StandardDeleter<T>>
class PCL_CLASS AutoPointer
{
public:
 
   using value_type = T;
 
   using pointer = T*;
 
   using const_pointer = const T*;
 
   using deleter = D;
 
   AutoPointer( bool autoDelete = true, const deleter& d = deleter() )
      : m_deleter( d )
      , m_autoDelete( autoDelete )
   {
   }
 
   AutoPointer( pointer p, bool autoDelete = true, const deleter& d = deleter() )
      : m_deleter( d )
      , m_autoDelete( autoDelete )
   {
      m_pointer = p;
   }
 
   AutoPointer( AutoPointer& x )
      : m_deleter( x.m_deleter )
      , m_autoDelete( x.m_autoDelete )
   {
      m_pointer = x.Release();
   }
 
   AutoPointer( AutoPointer&& x )
      : m_deleter( std::move( x.m_deleter ) )
      , m_autoDelete( x.m_autoDelete )
   {
      m_pointer = x.Release();
   }
 
   virtual ~AutoPointer()
   {
      Reset();
   }
 
   void SetPointer( pointer p )
   {
      if ( m_pointer != p )
      {
         if ( m_autoDelete )
            if ( m_pointer != nullptr )
               m_deleter( Release() ); // in case m_deleter throws
         m_pointer = p;
      }
   }
 
   void Reset()
   {
      if ( m_pointer != nullptr )
      {
         pointer p = Release(); // in case m_deleter throws
         if ( m_autoDelete )
            m_deleter( p );
      }
   }
 
   void Destroy()
   {
      Reset();
   }
 
   pointer Release()
   {
      pointer p = m_pointer;
      m_pointer = nullptr;
      return p;
   }
 
   const_pointer Pointer() const
   {
      return m_pointer;
   }
 
   pointer Pointer()
   {
      return m_pointer;
   }
 
   const_pointer Ptr() const
   {
      return m_pointer;
   }
 
   pointer Ptr()
   {
      return m_pointer;
   }
 
   bool IsNull() const
   {
      return m_pointer == nullptr;
   }
 
   bool IsValid() const
   {
      return !IsNull();
   }
 
   bool IsAutoDelete() const
   {
      return m_autoDelete;
   }
 
   void EnableAutoDelete( bool enable = true )
   {
      m_autoDelete = enable;
   }
 
   void DisableAutoDelete( bool disable = true )
   {
      EnableAutoDelete( !disable );
   }
 
   const deleter& Deleter() const
   {
      return m_deleter;
   }
 
   deleter& Deleter()
   {
      return m_deleter;
   }
 
   AutoPointer& operator =( AutoPointer& x )
   {
      SetPointer( x.Release() );
      m_deleter = x.m_deleter;
      m_autoDelete = x.m_autoDelete;
      return *this;
   }
 
   AutoPointer& operator =( AutoPointer&& x )
   {
      SetPointer( x.Release() );
      m_deleter = std::move( x.m_deleter );
      m_autoDelete = x.m_autoDelete;
      return *this;
   }
 
   AutoPointer& operator =( pointer p )
   {
      SetPointer( p );
      return *this;
   }
 
   operator const_pointer() const
   {
      return m_pointer;
   }
 
   operator pointer()
   {
      return m_pointer;
   }
 
   const_pointer operator ->() const
   {
      PCL_PRECONDITION( m_pointer != nullptr )
      return m_pointer;
   }
 
   pointer operator ->()
   {
      PCL_PRECONDITION( m_pointer != nullptr )
      return m_pointer;
   }
 
   const value_type& operator *() const
   {
      PCL_PRECONDITION( m_pointer != nullptr )
      return *m_pointer;
   }
 
   value_type& operator *()
   {
      PCL_PRECONDITION( m_pointer != nullptr )
      return *m_pointer;
   }
 
   operator bool() const
   {
      return !IsNull();
   }
 
   friend void Swap( AutoPointer& x1, AutoPointer& x2 )
   {
      pcl::Swap( x1.m_pointer, x2.m_pointer );
      pcl::Swap( x1.m_deleter, x2.m_deleter );
      bool b = x1.m_autoDelete; x1.m_autoDelete = x2.m_autoDelete; x2.m_autoDelete = b;
   }
 
protected:
 
   pointer m_pointer = nullptr;
   deleter m_deleter;
   bool    m_autoDelete = true;
};
 
// ----------------------------------------------------------------------------
 
#ifdef __PCL_QT_INTERFACE
 
template <class Q>
class PCL_CLASS QObjectDeferredDeleter
{
public:
 
   using value_type = Q;
 
   using pointer = Q*;
 
   void operator()( pointer p ) const
   {
      PCL_PRECONDITION( p != nullptr )
      if ( p != nullptr )
         p->deleteLater();
   }
};
 
template <class Q>
using AutoQObjectPointer = AutoPointer<Q, QObjectDeferredDeleter<Q>>;
 
using AutoQActionPointer = AutoQObjectPointer<QAction>;
 
#endif   // __PCL_QT_INTERFACE
 
// ----------------------------------------------------------------------------
 
#define ASSERT_COPIABLE_T() \
   static_assert( std::is_copy_constructible<T>::value, "AutoPointerCloner<> requires a copy-constructible type." )
 
template <class T, class D = StandardDeleter<T> >
class PCL_CLASS AutoPointerCloner : public AutoPointer<T,D>
{
public:
 
   using base_type = AutoPointer<T,D>;
 
   using value_type = typename base_type::value_type;
 
   using pointer = typename base_type::pointer;
 
   using const_pointer = typename base_type::const_pointer;
 
   using deleter = typename base_type::deleter;
 
   AutoPointerCloner( bool autoDelete = true, const deleter& d = deleter() )
      : base_type( autoDelete, d )
   {
      ASSERT_COPIABLE_T();
   }
 
   AutoPointerCloner( pointer p, bool autoDelete = true, const deleter& d = deleter() )
      : base_type( p, autoDelete, d )
   {
      ASSERT_COPIABLE_T();
   }
 
   AutoPointerCloner( const base_type& x )
      : base_type( nullptr )
   {
      ASSERT_COPIABLE_T();
      this->m_pointer = x ? new value_type( *x ) : nullptr;
      this->m_deleter = x.m_deleter;
      this->m_autoDelete = x || x.m_autoDelete;
   }
 
   AutoPointerCloner( const AutoPointerCloner& x )
      : base_type( nullptr )
   {
      ASSERT_COPIABLE_T();
      this->m_pointer = x ? new value_type( *x ) : nullptr;
      this->m_deleter = x.m_deleter;
      this->m_autoDelete = x || x.m_autoDelete;
   }
 
   AutoPointerCloner( base_type&& x )
      : base_type( std::move( x ) )
   {
   }
 
   AutoPointerCloner& operator =( const base_type& x )
   {
      this->SetPointer( x ? new value_type( *x ) : nullptr );
      this->m_deleter = x.m_deleter;
      this->m_autoDelete = x || x.m_autoDelete;
      return *this;
   }
 
   AutoPointerCloner& operator =( const AutoPointerCloner& x )
   {
      this->SetPointer( x ? new value_type( *x ) : nullptr );
      this->m_deleter = x.m_deleter;
      this->m_autoDelete = x || x.m_autoDelete;
      return *this;
   }
 
   AutoPointerCloner& operator =( base_type&& x )
   {
      (void)base_type::operator =( std::move( x ) );
      return *this;
   }
 
   AutoPointerCloner& operator =( pointer p )
   {
      this->SetPointer( p );
      return *this;
   }
};
 
#undef ASSERT_COPIABLE_T
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif  // __PCL_AutoPointer_h
 
// ----------------------------------------------------------------------------
// EOF pcl/AutoPointer.h - Released 2024-12-28T16:53:48Z