Array.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_ARRAY_HPP_INCLUDE_GUARD_
#define BLOCXX_ARRAY_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/ArrayFwd.hpp"
#include "blocxx/COWReference.hpp"
#include "blocxx/Types.hpp"
#include "blocxx/Exception.hpp"
#include "blocxx/vector.hpp"

namespace BLOCXX_NAMESPACE
{

// Declare the OutOfBoundsException
BLOCXX_DECLARE_APIEXCEPTION(OutOfBounds, BLOCXX_COMMON_API);

template<class T> class Array
{
   typedef std::vector<T, std::allocator<T> > V;

#ifdef BLOCXX_WIN32
#pragma warning (push)
#pragma warning (disable: 4251)
#endif

   COWReference<V> m_impl;

#ifdef BLOCXX_WIN32
#pragma warning (pop)
#endif

public:
   typedef typename V::value_type value_type;
   typedef typename V::pointer pointer;
   typedef typename V::const_pointer const_pointer;
   typedef typename V::iterator iterator;
   typedef typename V::const_iterator const_iterator;
   typedef typename V::reference reference;
   typedef typename V::const_reference const_reference;
   typedef typename V::size_type size_type;
   typedef typename V::difference_type difference_type;
   typedef typename V::reverse_iterator reverse_iterator;
   typedef typename V::const_reverse_iterator const_reverse_iterator;

   Array();
   ~Array();
   explicit Array(V* toWrap);
   Array(size_type n, const T& value);
   Array(int n, const T& value);
   Array(long n, const T& value);
   explicit Array(size_type n);
   template<class InputIterator>
   Array(InputIterator first, InputIterator last);
   iterator begin();
   const_iterator begin() const;
   iterator end();
   const_iterator end() const;
   reverse_iterator rbegin();
   const_reverse_iterator rbegin() const;
   reverse_iterator rend();
   const_reverse_iterator rend() const;
   size_type size() const;
   size_type max_size() const;
   size_type capacity() const;
   bool empty() const;
   reference operator[](size_type n);
   const_reference operator[](size_type n) const;
   Array<T>& operator+= (const T& x);
   void reserve(size_type n);
   reference front();
   const_reference front() const;
   reference back();
   const_reference back() const;
   void push_back(const T& x);
   void append(const T& x);
   void swap(Array<T>& x);
   iterator insert(iterator position, const T& x);
   void insert(size_type position, const T& x);
   void remove(size_type index);
   void remove(size_type begin, size_type end);
   template<class InputIterator>
   void insert(iterator position, InputIterator first, InputIterator last);
   void appendArray(const Array<T>& x);
   void pop_back();
   iterator erase(iterator position);
   iterator erase(iterator first, iterator last);
   void resize(size_type new_size, const T& x);
   void resize(size_type new_size);
   void clear();
   const_iterator find(const T &x, const_iterator first,
                                   const_iterator last) const;
   const_iterator find(const T &x) const;
   iterator       find(const T &x, iterator first, iterator last);
   iterator       find(const T &x);
   bool contains(const T& x, const_iterator first,
                             const_iterator last) const;
   bool contains(const T& x) const;

   friend bool operator== <>(const Array<T>& x, const Array<T>& y);

   friend bool operator< <>(const Array<T>& x, const Array<T>& y);
private:
#ifdef BLOCXX_CHECK_ARRAY_INDEXING
   void checkValidIndex(size_type index) const;
#endif
};

template <class T>
inline bool operator != (const Array<T>& x, const Array<T>& y)
{
   return !(x == y);
}

template <class T>
inline bool operator <= (const Array<T>& x, const Array<T>& y)
{
   return !(y < x);
}

template <class T>
inline bool operator >= (const Array<T>& x, const Array<T>& y)
{
   return !(x < y);
}

template <class T>
inline bool operator > (const Array<T>& x, const Array<T>& y)
{
   return y < x;
}
  
typedef Array<UInt8>      UInt8Array;
typedef Array<Int8>       Int8Array;
typedef Array<UInt16>     UInt16Array;
typedef Array<Int16>      Int16Array;
typedef Array<UInt32>     UInt32Array;
typedef Array<Int32>      Int32Array;
typedef Array<UInt64>     UInt64Array;
typedef Array<Int64>      Int64Array;
typedef Array<Real64>     Real64Array;
typedef Array<Real32>     Real32Array;

} // end namespace BLOCXX_NAMESPACE

#include "blocxx/ArrayImpl.hpp"

#endif