Buffer.h++

Go to the documentation of this file.

/* ---------------------------------------------------------------------------
   commonc++ - A C++ Common Class Library
   Copyright (C) 2005-2014  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(uint_t size);

  Buffer(T* data, size_t size, bool takeOwnership = true);

  virtual ~Buffer();

  virtual void clear();

  void flip();

  void rewind();

  void setLimit(uint_t limit);

  void setPosition(uint_t pos);

  uint_t bump(uint_t delta);

  uint_t skip(uint_t delta);

  bool put(const T& item);

  bool get(T * item);

  bool put(const T* items, uint_t count);

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

  bool get(T* items, uint_t count);

  int peek(const T& item) const;

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

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

  inline uint_t getLimit() const
  { return(_limit); }

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

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

  inline uint_t getPosition() const
  { return(_pos); }

  T& operator[](int index);

  T operator[](int index) const;

 protected:

  uint_t _limit;
  uint_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