COWReference.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, Inc. All rights reserved.
* 
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 
*     * Redistributions of source code must retain the above copyright notice,
*       this list of conditions and the following disclaimer.
*     * 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.
*     * Neither the name of 
*       Vintela, Inc., 
*       nor Novell, Inc., 
*       nor the names of its contributors or employees may be used to 
*       endorse or promote products derived from this software without 
*       specific prior written permission.
* 
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 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 THE COPYRIGHT OWNER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) 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 BLOCXX_COWREFERENCE_HPP_INCLUDE_GUARD_
#define BLOCXX_COWREFERENCE_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/COWReferenceBase.hpp"
#include "blocxx/ReferenceHelpers.hpp"
#include "blocxx/SafeBool.hpp"

namespace BLOCXX_NAMESPACE
{

template<class T>
class COWReference : private COWReferenceBase
{
public:
   typedef T element_type;

   COWReference();

   explicit COWReference(T* ptr);

   COWReference(const COWReference<T>& arg);

   template <class U>
   COWReference(const COWReference<U>& arg);

   ~COWReference();

   COWReference<T>& operator= (const COWReference<T>& arg);

   COWReference<T>& operator= (T* newObj);

   void swap(COWReference<T>& arg);

   T* operator->();
   
   const T* operator->() const;

   T& operator*();

   const T& operator*() const;

   const T* getPtr() const;
   bool isNull() const BLOCXX_DEPRECATED; // in 3.1.0

   BLOCXX_SAFE_BOOL_IMPL(COWReference, T* volatile, COWReference::m_pObj, m_pObj)

   template <class U>
   COWReference<U> cast_to() const;

   template <class U>
   void useRefCountOf(const COWReference<U>&);

#if !defined(__GNUC__) || __GNUC__ > 2 // causes gcc 2.95 to ICE
   /* This is so the templated constructor will work */
   template <class U> friend class COWReference;
private:
#endif
   T* volatile m_pObj;
   void decRef();
   void getWriteLock();
};
template<class T>
inline COWReference<T>::COWReference()
   : COWReferenceBase(), m_pObj(0)
{
}
template<class T>
inline COWReference<T>::COWReference(T* ptr)
   : COWReferenceBase(), m_pObj(ptr)
{
}
template<class T>
inline COWReference<T>::COWReference(const COWReference<T>& arg)
   : COWReferenceBase(arg), m_pObj(arg.m_pObj)
{
}
template<class T>
template<class U>
inline COWReference<T>::COWReference(const COWReference<U>& arg)
   : COWReferenceBase(arg), m_pObj(arg.m_pObj)
{
}
template<class T>
inline COWReference<T>::~COWReference()
{
   try
   {
      decRef();
   }
   catch (...)
   {
      // don't let exceptions escape
   }
}
template<class T>
inline void COWReference<T>::decRef()
{
   typedef char type_must_be_complete[sizeof(T)];
   if (COWReferenceBase::decRef())
   {
      delete m_pObj;
      m_pObj = 0;
   }
}

template<class T>
inline void COWReference<T>::getWriteLock()
{
   if (COWReferenceBase::refCountGreaterThanOne())
   {
      // this needs to happen first to avoid a race condition between 
      // another thread deleting the object and this one making a copy.
      T* tmp = COWReferenceClone(m_pObj);
      // this will decrement the count and then make a new one if we're making a copy.
      if (COWReferenceBase::getWriteLock())
      {
         delete tmp;
      }
      else
      {
         m_pObj = tmp;
      }
   }
}
template<class T>
inline COWReference<T>& COWReference<T>::operator= (const COWReference<T>& arg)
{
   COWReference<T>(arg).swap(*this);
   return *this;
}
template<class T>
inline COWReference<T>& COWReference<T>::operator= (T* newObj)
{
   COWReference<T>(newObj).swap(*this);
   return *this;
}
template <class T>
inline void COWReference<T>::swap(COWReference<T>& arg)
{
   COWReferenceBase::swap(arg);
   COWRefSwap(m_pObj, arg.m_pObj);
}
template<class T>
inline T* COWReference<T>::operator->()
{
#ifdef BLOCXX_CHECK_NULL_REFERENCES
   ReferenceHelpers::checkNull(this);
   ReferenceHelpers::checkNull(m_pObj);
#endif
   getWriteLock();
   
   return m_pObj;
}
template<class T>
inline T& COWReference<T>::operator*()
{
#ifdef BLOCXX_CHECK_NULL_REFERENCES
   ReferenceHelpers::checkNull(this);
   ReferenceHelpers::checkNull(m_pObj);
#endif
   getWriteLock();
   
   return *(m_pObj);
}
template<class T>
inline const T* COWReference<T>::operator->() const
{
#ifdef BLOCXX_CHECK_NULL_REFERENCES
   ReferenceHelpers::checkNull(this);
   ReferenceHelpers::checkNull(m_pObj);
#endif
   
   return m_pObj;
}
template<class T>
inline const T& COWReference<T>::operator*() const
{
#ifdef BLOCXX_CHECK_NULL_REFERENCES
   ReferenceHelpers::checkNull(this);
   ReferenceHelpers::checkNull(m_pObj);
#endif
   
   return *(m_pObj);
}
template<class T>
inline const T* COWReference<T>::getPtr() const
{
   return m_pObj;
}
template<class T>
inline bool COWReference<T>::isNull() const
{
   return (m_pObj == 0);
}
template <class T>
template <class U>
inline COWReference<U>
COWReference<T>::cast_to() const
{
   COWReference<U> rval;
   rval.m_pObj = dynamic_cast<U*>(m_pObj);
   if (rval.m_pObj)
   {
      rval.useRefCountOf(*this);
   }
   return rval;
}
template <class T>
template <class U>
inline void
COWReference<T>::useRefCountOf(const COWReference<U>& arg)
{
   COWReferenceBase::useRefCountOf(arg);
}
// Comparisons
template <class T, class U>
inline bool operator==(const COWReference<T>& a, const COWReference<U>& b)
{
   return a.getPtr() == b.getPtr();
}
template <class T, class U>
inline bool operator!=(const COWReference<T>& a, const COWReference<U>& b)
{
   return a.getPtr() != b.getPtr();
}
template <class T, class U>
inline bool operator<(const COWReference<T>& a, const COWReference<U>& b)
{
   return a.getPtr() < b.getPtr();
}

template <class T>
inline T* COWReferenceClone(T* obj)
{
   // default implementation.  If a certain class doesn't have clone()
   // (like std::vector), then they can overload this function
   return obj->clone();
}

} // end namespace BLOCXX_NAMESPACE

#endif   // BLOCXX_COWREFERENCE_HPP_