Buffer.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2012  Mark A Lindner

   This file is part of commonc++.

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
   ---------------------------------------------------------------------------
*/

#ifndef __ccxx_Buffer_hxx
#define __ccxx_Buffer_hxx

#include <commonc++/Common.h++>
#include <commonc++/AbstractBuffer.h++>
#include <commonc++/OutOfBoundsException.h++>

#include <cstring>
#include <algorithm>

namespace ccxx {

template <typename T> class Buffer : public AbstractBuffer<T>
{
  public:

  Buffer(size_t size);

  virtual ~Buffer() throw();

  virtual void clear() throw();

  void flip() throw();

  void rewind() throw();

  void setLimit(size_t limit) throw();

  void setPosition(size_t pos) throw();

  size_t bump(size_t delta) throw();

  size_t skip(size_t delta) throw();

  bool put(const T& item) throw();

  bool get(T * item) throw();

  bool put(const T * items, size_t count) throw();

  void fill(const T& item, size_t count = 0) throw();

  bool get(T * items, size_t count) throw();

  int peek(const T& item) const throw();

  inline T *getPointer() throw()
  { return(this->_data + this->_pos); }

  inline const T *getPointer() const throw()
  { return(this->_data + this->_pos); }

  inline size_t getLimit() const throw()
  { return(_limit); }

  inline size_t getRemaining() const throw()
  { return(_limit - _pos); }

  inline bool hasRemaining() const throw()
  { return(_limit > _pos); }

  inline size_t getPosition() const throw()
  { return(_pos); }

  T& operator[](int index) throw(OutOfBoundsException);

  T operator[](int index) const throw(OutOfBoundsException);

  protected:

  size_t _limit;
  size_t _pos;

  private:

  CCXX_COPY_DECLS(Buffer);
};

#include <commonc++/BufferImpl.h++>

typedef Buffer<byte_t> ByteBuffer;
typedef Buffer<char> CharBuffer;

}; // namespace ccxx

#endif // __ccxx_Buffer_hxx

/* end of header file */