poco/Foundation/include/Poco/Buffer.h

302 lines
6.9 KiB
C
Raw Normal View History

2012-04-29 20:52:25 +02:00
//
// Buffer.h
//
// $Id: //poco/1.4/Foundation/include/Poco/Buffer.h#2 $
//
// Library: Foundation
// Package: Core
// Module: Buffer
//
// Definition of the Buffer class.
//
// Copyright (c) 2012, Applied Informatics Software Engineering GmbH.
2012-04-29 20:52:25 +02:00
// and Contributors.
//
// Permission is hereby granted, free of charge, to any person or organization
// obtaining a copy of the software and accompanying documentation covered by
// this license (the "Software") to use, reproduce, display, distribute,
// execute, and transmit the Software, and to prepare derivative works of the
// Software, and to permit third-parties to whom the Software is furnished to
// do so, all subject to the following:
//
// The copyright notices in the Software and this entire statement, including
// the above license grant, this restriction and the following disclaimer,
// must be included in all copies of the Software, in whole or in part, and
// all derivative works of the Software, unless such copies or derivative
// works are solely in the form of machine-executable object code generated by
// a source language processor.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.
//
#ifndef Foundation_Buffer_INCLUDED
#define Foundation_Buffer_INCLUDED
#include "Poco/Foundation.h"
2012-06-08 04:24:36 +02:00
#include "Poco/Exception.h"
2012-05-12 23:01:05 +02:00
#include <cstring>
2012-05-13 17:34:20 +02:00
#include <cstddef>
2012-04-29 20:52:25 +02:00
namespace Poco {
template <class T>
class Buffer
/// A buffer class that allocates a buffer of a given type and size
/// in the constructor and deallocates the buffer in the destructor.
2012-05-13 17:34:20 +02:00
///
/// This class is useful everywhere where a temporary buffer
/// is needed.
2012-04-29 20:52:25 +02:00
{
public:
2012-05-13 17:34:20 +02:00
Buffer(std::size_t capacity):
_capacity(capacity),
_used(capacity),
_ptr(new T[capacity]),
_ownMem(true)
2012-05-13 17:34:20 +02:00
/// Creates and allocates the Buffer.
{
}
explicit Buffer(T* pMem, std::size_t length):
_capacity(length),
_used(length),
_ptr(pMem),
_ownMem(false)
/// Creates the Buffer. Length argument specifies the length
/// of the supplied memory pointed to by pMem in the number
/// of elements of type T. Supplied pointer is considered
/// blank and not owned by Buffer, so in this case Buffer
/// only acts as a wrapper around externally supplied
/// (and lifetime-managed) memory.
{
}
explicit Buffer(const T* pMem, std::size_t length):
_capacity(length),
_used(length),
_ptr(new T[length]),
_ownMem(true)
/// Creates and allocates the Buffer; copies the contents of
/// the supplied memory into the buffer. Length argument specifies
/// the length of the supplied memory pointed to by pMem in the
/// number of elements of type T.
{
if (_used)
std::memcpy(_ptr, pMem, _used * sizeof(T));
}
Buffer(const Buffer& other):
/// Copy constructor.
_capacity(other._used),
_used(other._used),
_ptr(new T[other._used]),
_ownMem(true)
{
if (_used)
std::memcpy(_ptr, other._ptr, _used * sizeof(T));
}
Buffer& operator =(const Buffer& other)
/// Assignment operator.
{
if (this != &other)
{
Buffer tmp(other);
swap(tmp);
}
return *this;
}
2012-05-13 17:34:20 +02:00
~Buffer()
/// Destroys the Buffer.
{
if (_ownMem) delete [] _ptr;
2012-05-13 17:34:20 +02:00
}
void resize(std::size_t newCapacity, bool preserveContent = true)
/// Resizes the buffer capacity and size. If preserveContent is true,
2012-05-13 17:34:20 +02:00
/// the content of the old buffer is copied over to the
/// new buffer. The new capacity can be larger or smaller than
/// the current one; if it is smaller, capacity will remain intact.
/// Size will always be set to the new capacity.
///
/// Buffers only wrapping externally owned storage can not be
/// resized. If resize is attempted on those, IllegalAccessException
/// is thrown.
2012-05-13 17:34:20 +02:00
{
if (!_ownMem)
2012-06-08 04:24:36 +02:00
throw Poco::InvalidAccessException("Cannot resize buffer which does not own its storage.");
2012-05-13 17:34:20 +02:00
if (newCapacity > _capacity)
{
T* ptr = new T[newCapacity];
if (preserveContent)
std::memcpy(ptr, _ptr, _capacity);
2012-05-13 17:34:20 +02:00
delete [] _ptr;
_ptr = ptr;
2012-05-13 17:34:20 +02:00
_capacity = newCapacity;
}
_used = newCapacity;
}
void assign(const T* buf, std::size_t sz)
/// Assigns the argument buffer to this buffer.
/// If necessary, resizes the buffer.
{
if (0 == sz) return;
if (sz > _capacity) resize(sz, false);
std::memcpy(_ptr, buf, sz);
_used = sz;
}
2012-05-13 19:23:57 +02:00
void append(const T* buf, std::size_t sz)
/// Resizes this buffer and appends the argument buffer.
{
if (0 == sz) return;
2012-05-13 19:23:57 +02:00
std::size_t oldSize = _used;
resize(_used + sz, true);
std::memcpy(_ptr + oldSize, buf, sz);
}
void append(const Buffer& buf)
/// Resizes this buffer and appends the argument buffer.
{
append(buf.begin(), buf.size());
}
2012-05-13 17:34:20 +02:00
std::size_t capacity() const
/// Returns the allocated memory size in elements.
2012-05-13 17:34:20 +02:00
{
return _capacity;
}
std::size_t capacityBytes() const
/// Returns the allocated memory size in bytes.
{
return _capacity * sizeof(T);
}
void swap(Buffer& other)
/// Swaps the buffer with another one.
{
using std::swap;
swap(_ptr, other._ptr);
swap(_capacity, other._capacity);
swap(_used, other._used);
}
bool operator ==(const Buffer& other) const
/// Compare operator.
{
if (this != &other)
{
if (_used == other._used)
{
if (std::memcmp(_ptr, other._ptr, _used) == 0)
{
return true;
}
}
return false;
}
return true;
}
bool operator !=(const Buffer& other) const
/// Compare operator.
{
return !(*this == other);
}
void clear()
/// Sets the contents of the bufer to zero.
{
std::memset(_ptr, 0, _used * sizeof(T));
}
2012-05-13 17:34:20 +02:00
std::size_t size() const
/// Returns the used size of the buffer in elements.
2012-05-13 17:34:20 +02:00
{
return _used;
}
std::size_t sizeBytes() const
/// Returns the used size of the buffer in bytes.
{
return _used * sizeof(T);
}
2012-05-13 17:34:20 +02:00
T* begin()
/// Returns a pointer to the beginning of the buffer.
2012-04-29 20:52:25 +02:00
{
return _ptr;
}
const T* begin() const
/// Returns a pointer to the beginning of the buffer.
{
return _ptr;
}
T* end()
/// Returns a pointer to end of the buffer.
{
2012-05-13 17:34:20 +02:00
return _ptr + _used;
2012-04-29 20:52:25 +02:00
}
const T* end() const
/// Returns a pointer to the end of the buffer.
{
2012-05-13 17:34:20 +02:00
return _ptr + _used;
}
bool empty() const
/// Return true if buffer is empty.
{
return 0 == _used;
}
2012-05-13 17:34:20 +02:00
T& operator [] (std::size_t index)
{
poco_assert (index < _used);
2012-04-29 20:52:25 +02:00
return _ptr[index];
}
const T& operator [] (std::size_t index) const
{
2012-05-13 17:34:20 +02:00
poco_assert (index < _used);
2012-04-29 20:52:25 +02:00
return _ptr[index];
2012-05-13 17:34:20 +02:00
}
2012-04-29 20:52:25 +02:00
private:
2012-05-13 17:34:20 +02:00
Buffer();
2012-04-29 20:52:25 +02:00
2012-05-13 17:34:20 +02:00
std::size_t _capacity;
std::size_t _used;
T* _ptr;
bool _ownMem;
2012-04-29 20:52:25 +02:00
};
} // namespace Poco
#endif // Foundation_Buffer_INCLUDED