/*
**  ClanLib SDK
**  Copyright (c) 1997-2015 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/


#pragma once

#include <memory>

namespace clan
{
/// \addtogroup clanCore_System clanCore System
/// \{

class DataBuffer_Impl;

/// \brief General purpose data buffer.
class DataBuffer
{
/// \name Construction
/// \{
public:
	/// \brief Constructs a data buffer of 0 size.
	DataBuffer();
	DataBuffer(unsigned int size);
	DataBuffer(const void *data, unsigned int size);
	DataBuffer(const DataBuffer &data, unsigned int pos, unsigned int size);
	~DataBuffer();
/// \}

/// \name Attributes
/// \{
public:
	/// \brief Returns a pointer to the data.
	char *get_data();

	const char *get_data() const;

	template<typename Type>
	Type *get_data() { return reinterpret_cast<Type*>(get_data()); }

	template<typename Type>
	const Type *get_data() const { return reinterpret_cast<const Type*>(get_data()); }

	/// \brief Returns the size of the data.
	unsigned int get_size() const;

	/// \brief Returns the capacity of the data buffer object.
	unsigned int get_capacity() const;

	/// \brief Returns a char in the buffer.
	char &operator[](int i);
	const char &operator[](int i) const;
	char &operator[](unsigned int i);
	const char &operator[](unsigned int i) const;

	/// \brief Returns true if the buffer is 0 in size.
	bool is_null() const;
/// \}

/// \name Operations
/// \{
public:
	DataBuffer &operator =(const DataBuffer &copy);

	/// \brief Resize the buffer.
	void set_size(unsigned int size);

	/// \brief Preallocate enough memory.
	void set_capacity(unsigned int capacity);
/// \}

/// \name Implementation
/// \{
private:
	std::shared_ptr<DataBuffer_Impl> impl;
/// \}
};

}

/// \}
