/*****************************************************************************
#   Copyright (C) 1994-2008 by David Gordon.
#   All rights reserved.                           
#                                                                           
#   This software is part of a beta-test version of the Consed/Autofinish
#   package.  It should not be redistributed or
#   used for any commercial purpose, including commercially funded
#   sequencing, without written permission from the author and the
#   University of Washington.
#   
#   This software is provided ``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 authors or the University of Washington 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.
#
#   Building Consed from source is error prone and not simple which is
#   why I provide executables.  Due to time limitations I cannot
#   provide any assistance in building Consed.  Even if you do not
#   modify the source, you may introduce errors due to using a
#   different version of the compiler, a different version of motif,
#   different versions of other libraries than I used, etc.  For this
#   reason, if you discover Consed bugs, I can only offer help with
#   those bugs if you first reproduce those bugs with an executable
#   provided by me--not an executable you have built.
# 
#   Modifying Consed is also difficult.  Although Consed is modular,
#   some modules are used by many other modules.  Thus making a change
#   in one place can have unforeseen effects on many other features.
#   It may takes months for you to notice these other side-effects
#   which may not seen connected at all.  It is not feasable for me to
#   provide help with modifying Consed sources because of the
#   potentially huge amount of time involved.
#
#*****************************************************************************/
#ifndef rwtptrvector_included
#define rwtptrvector_included

#include    "mbt_exception.h"
#include    "soEmptyString.h"


template <class TP>
class RWTPtrVector {
public:
   int nCurrentLength_;
   int nMaxLength_;
   TP** ppArray_;
   RWCString soName_;
public:

   RWTPtrVector( const size_t nCapacity = 0 ) :
      nCurrentLength_( nCapacity ), nMaxLength_( nCapacity)  {

      if ( nCapacity == 0 ) {
         ppArray_ = 0;
      }
      else {
         ppArray_ = (TP**) malloc( nCapacity * sizeof( TP* ) );
         if ( ! ppArray_ && nCapacity ) {
            PANIC_OST( ost ) << "In RWTPtrVector( " << nCapacity << 
               " ) but couldn't malloc enough memory" << ends;
            throw RWInternalError( ost.str() );
         }
      }
   }



   RWTPtrVector( const size_t nCapacity, TP* pInitial,
                 const RWCString& soName = soEmptyString ) :
      nCurrentLength_( nCapacity ), nMaxLength_( nCapacity),
      soName_( soName ) {

      if ( nCapacity == 0 ) {
         ppArray_ = 0;
      }
      else {
         ppArray_ = (TP**) malloc( nCapacity * sizeof( TP* ) );
         if ( ! ppArray_ ) {
            PANIC_OST( ost ) << "In RWTPtrVector( " << nCapacity <<
               ", " << pInitial << " ) but malloc failed to get enough memory"
                             << ends;
            throw RWInternalError( ost.str() );
         }

         for( register int nIndex = 0; nIndex < nCapacity; ++nIndex )
            ppArray_[ nIndex ] = pInitial;

      }
   }
      

   ~RWTPtrVector() {
      free( (void*) ppArray_ );
   }


   bool operator==( const RWTPtrVector& myRWTPtrVector ) {
      return( this == &myRWTPtrVector );
   }


   size_t length() { return( nCurrentLength_ ); }

   inline TP*& operator[]( const size_t nIndex ) {
      if ( nIndex >= nCurrentLength_ ) {
         PANIC_OST( ost ) << "In RWTPtrVector::operator[]( " << nIndex
                          << " ) out of bounds with nCurrentLength_ = " 
                          << nCurrentLength_ 
                          << " " << soName_ << ends;
         throw RWInternalError( ost.str() );
      }

      return( ppArray_[ nIndex ] );
   }

   inline TP* operator[]( const size_t nIndex ) const {
      if ( nIndex >= nCurrentLength_ ) {
         PANIC_OST( ost ) << "In RWTPtrVector::operator[]( " << nIndex
                          << " ) const out of bounds with nCurrentLength_ = " 
                          << nCurrentLength_ 
                          << " " << soName_ << ends;
         throw RWInternalError( ost.str() );
      }

      return( ppArray_[ nIndex ] );
   }

   
   void reshape( const size_t nNewSize ) {
      TP** ppTemp = (TP**) malloc( nNewSize * sizeof( TP* ) );
      if ( ! ppTemp ) {
         PANIC_OST( ost ) << "In RWTPtrVector::reshape( "
                          << nNewSize << " ) but couldn't malloc enough memory"
                          << ends;

         throw RWInternalError( ost.str() );
      }

      // what happens to the existing pointers?  They are lost, I believe.

      free( ppArray_ );
      ppArray_ = ppTemp;
      nCurrentLength_ = nNewSize;
      nMaxLength_ = nNewSize;

      for( register int nIndex = 0; nIndex < nCurrentLength_; ++nIndex )
         ppArray_[ nIndex ] = 0;

   }

   void resize( const size_t nNewSize ) {
      reshape( nNewSize );
   }

   void resizeButNotSmaller( const size_t nNewSize ) {

      if ( nNewSize <= nMaxLength_ ) {
         // note:  this will mean the buffer is larger than we need
         nCurrentLength_ = nNewSize;
      }
      else {
         reshape( nNewSize );
      }

      // clear the array
      for( int nIndex = 0; nIndex < nCurrentLength_; ++nIndex )
         ppArray_[ nIndex ] = 0;
   }

   
   void setAllValues( TP* pInitial ) {
      for( register int nIndex = 0; nIndex < nCurrentLength_; ++nIndex )
         ppArray_[ nIndex ] = pInitial;
   }


   void clear() {
      for( int nIndex = 0; nIndex < nCurrentLength_; ++nIndex ) {
         ppArray_[ nIndex ] = 0;
      }
   }

   void clearAndDestroy() {
      for( int nIndex = nCurrentLength_ - 1; nIndex >= 0; --nIndex ) {
         delete ppArray_[ nIndex ];
         ppArray_[ nIndex ] = 0;
      }
   }


};






#endif