scoped_ptr.h

Go to the documentation of this file.

/*! \file
  \brief  A smart pointer with unique ownership -- poor man's std::unique_ptr.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
#ifndef INCLUDED_DISTI_SCOPED_PTR_H
#define INCLUDED_DISTI_SCOPED_PTR_H
 
#include "disti_assert.h"
#include "gls_cpp_lang_support.h"
 
namespace disti
{
/** The ScopedPtr class template stores a pointer to a dynamically allocated object. 
      * The object pointed to is guaranteed to be deleted, either on destruction of the
      * ScopedPtr or via an explicit Reset. 
      */
template<class T>
class ScopedPtr
{
public:
    /// Constructor
    /// \param p The pointer to wrap with this object.
    explicit ScopedPtr( T* p = NULL )
        : _p( p )
    {
    }
 
    ~ScopedPtr()
    {
        delete _p;
        _p = NULL;
    }
 
#if defined( DISTI_HAS_RVAL_REFS )
    /// Move constructor
    /// \param that The object to move from.
    ScopedPtr( ScopedPtr&& that )
    {
        *this = std::move( that );
    }
 
    /// Move assignment operator
    /// \param that The object to move from.
    /// \return The resulting object (this).
    ScopedPtr& operator=( ScopedPtr&& that )
    {
        // Pilfer that's pointer
        Reset( that._p );
        that._p = NULL;
        return *this;
    }
#endif
    /// Address operator
    /// \return The address of the underlying pointer.
    T& operator*() const
    {
        GLS_ASSERT( _p );
        return *_p;
    }
 
    /// Dereference operator
    /// \return The underlying pointer.
    T* operator->() const
    {
        GLS_ASSERT( _p );
        return _p;
    }
 
    /// Reset the object by deleting the old object, and assigning a new one.
    /// \param p The new underlying pointer to assign.
    void Reset( T* p = NULL )
    {
        delete _p;
        _p = p;
    }
 
    /// \return True if the underlying pointer isn't NULL.
    bool IsNull() const
    {
        return NULL == _p;
    }
 
    /// \return The underlying pointer.
    T* Get() const { return _p; }
 
private:
    T* _p; ///< The pointer wrapped by this object.
 
    ScopedPtr( const ScopedPtr& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    void operator=( const ScopedPtr& ) DISTI_SPECIAL_MEM_FUN_DELETE;
};
} // namespace disti
#endif