ArrayPtr.hpp

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2011 by Benjamin Hadorn (b_hadorn@bluewin.ch)
 *****************************************************************************
 * Project    : Zeus Base Library
 * Module     : ArrayPtr
 * Package    : Zeus.ZeusBase.System
 * Author     : Benjamin Hadorn
 * Date       : 27.12.2011
 * System     : Zeus-Framework
 *****************************************************************************
 * Licence:                                                                  *
 *   This library is free software; you can redistribute it and/or modify    *
 *   it under the terms of the GNU Lesser General Public License as          *
 *   published by the Free Software Foundation; either version               *
 *   2.1 of the License, or (at your option) any later version.              *
 *                                                                           *
 *   This library is distributed in the hope that it will be useful,         *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of          *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the            *
 *   GNU Lesser General Public License for more details.                     *
 *                                                                           *
 *   You should have received a copy of the GNU Lesser General Public        *
 *   License along with this library; if not, write to the Free Software     *
 *   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA    *
 *****************************************************************************/

/*****************************************************************************
 * Changes:
 *  27.12.2011 bha: created zeus 2.0
 *****************************************************************************/

#ifndef ArrayPtrHPP
#define ArrayPtrHPP

#include <zeusbase/System/Interfaces/IZUnknown.hpp>
#include <string.h>


BEGIN_NAMESPACE_Zeus


/**************************************************************************/
/**************************************************************************/
template <class T> class TArrayPtr
{
  public:

    /***********************************************************************/
    /***********************************************************************/
    inline TArrayPtr()
    {
      m_paPtr = NULL;
      m_pReferenceCounter = NULL;
      m_iSize = 0;
    }

    /***********************************************************************/
    /***********************************************************************/
    inline TArrayPtr(Int iSize)
    {
      m_paPtr = NULL;
      m_pReferenceCounter = NULL;
      m_iSize = 0;
      if (iSize > 0)
      {
        this->assign(new T[iSize], iSize);
      }
    }

    /***********************************************************************/
    /***********************************************************************/
    TArrayPtr(const T* pPtr, Int iSize = -1)
    {
      m_pReferenceCounter = NULL;
      m_paPtr = NULL;
      m_iSize = 0;

      this->assign(pPtr, iSize);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline TArrayPtr(const TArrayPtr<T>& rWrapper)
    {
      m_iSize = 0;
      m_paPtr = NULL;
      m_pReferenceCounter = NULL;
      assignWrapper(rWrapper);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline virtual ~TArrayPtr()
    {
      release();
    }

    /***********************************************************************/
    /***********************************************************************/
    void assignWrapper(const TArrayPtr& rWrapper)
    {
      release();
      m_iSize = rWrapper.m_iSize;
      m_paPtr = rWrapper.m_paPtr;
      m_pReferenceCounter = rWrapper.m_pReferenceCounter;
      if (m_paPtr != NULL && m_pReferenceCounter != NULL && *m_pReferenceCounter > 0)
      {
        (*m_pReferenceCounter)++;
      }
      else
      {
        m_paPtr = NULL;
        m_pReferenceCounter = NULL;
      }
    }

    /***********************************************************************/
    /***********************************************************************/
    void assign(const T* pInterface, Int iSize = -1)
    {
      release();
      m_iSize = iSize;
      m_paPtr = (T*)pInterface;
      if (m_paPtr != NULL)
      {
        m_pReferenceCounter = new Int();
        *m_pReferenceCounter = 1;
      }
    }

    /***********************************************************************/
    /***********************************************************************/
    inline void clean()
    {
      if (m_iSize > 0 && m_paPtr != NULL)
      {
        ::memset(m_paPtr, 0x00, sizeof(T)*m_iSize);
      }
    }

    /***********************************************************************/
    /***********************************************************************/
    inline void memset(Int iValue)
    {
      if (m_iSize > 0 && m_paPtr != NULL)
      {
        ::memset(m_paPtr, iValue, sizeof(T)*m_iSize);
      }
    }

    /***********************************************************************/
    /***********************************************************************/
    inline bool equals(const T* pPtr) const
    {
      return (m_paPtr == pPtr);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline T* getPointer()
    {
      return m_paPtr;
    }

    /***********************************************************************/
    /***********************************************************************/
    inline const T* getConstPointer() const
    {
      return m_paPtr;
    }

    /***********************************************************************/
    /***********************************************************************/
    inline Int getSize() const
    {
      return m_iSize;
    }


    /***********************************************************************/
    /***********************************************************************/
    inline void release()
    {
      release_internal(true);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline T* detach()
    {
      T* paPtr = this->m_paPtr;
      release_internal(false);
      return paPtr;
    }

    /***********************************************************************/
    /***********************************************************************/
    inline TArrayPtr<T>& operator=(const TArrayPtr<T>& rWrapper)
    {
      assignWrapper(rWrapper);
      return *this;
    }

    /***********************************************************************/
    /***********************************************************************/
    inline TArrayPtr<T>& operator=(const T* pPtr)
    {
      assign(pPtr);
      return *this;
    }

    /***********************************************************************/
    /***********************************************************************/
    inline bool operator==(const TArrayPtr<T>& rWrapper) const
    {
      return equals(rWrapper.m_paPtr);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline bool operator!=(const TArrayPtr<T>& rWrapper) const
    {
      return !equals(rWrapper.m_paPtr);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline bool operator==(const T* pPtr) const
    {
      return equals(pPtr);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline bool operator!=(const T* pPtr) const
    {
      return !equals(pPtr);
    }

    /***********************************************************************/
    /***********************************************************************/
    inline operator T*() const {return m_paPtr; }

#if !defined(_MSC_VER) || _MSC_VER > 1200
    /***********************************************************************/
    /***********************************************************************/
    inline T& operator[](Int iIndex) { return m_paPtr[iIndex]; }

    /***********************************************************************/
    /***********************************************************************/
    inline const T& operator[](Int iIndex) const { return m_paPtr[iIndex]; }
#endif

    /***********************************************************************/
    /***********************************************************************/
    inline T& getItem(Int iIndex) { return m_paPtr[iIndex]; }

    /***********************************************************************/
    /***********************************************************************/
    inline const T& getItemConst(Int iIndex) const { return m_paPtr[iIndex]; }

  protected:
    T* m_paPtr;
    Int* m_pReferenceCounter;
    Int m_iSize;

    /***********************************************************************/
    /***********************************************************************/
    void release_internal(bool bDeletePointer)
    {
      if (this->m_paPtr != NULL)
      {
        (*m_pReferenceCounter)--;
        if (*m_pReferenceCounter <= 0)
        {
          delete this->m_pReferenceCounter;
          if (bDeletePointer)
          {
            delete [] this->m_paPtr;
          }
        } //(*m_pReferenceCounter <= 0)
        this->m_paPtr = NULL;
        this->m_pReferenceCounter = NULL;
        this->m_iSize = 0;
      } //(this->m_paPtr != NULL)
    }
};

END_NAMESPACE_Zeus

#endif