/*

Copyright (c) 2002-2005, Yauheni Akhotnikau
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.

- The name of the author may not be used to endorse or promote products derived
from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.

*/

/*!
	\since v.1.1.1
	\file
	\brief Интерфейсы для двоичных буферов-потоков.
*/

#if !defined( _OESS_1__IO__BINBUFFER_HPP_ )
#define _OESS_1__IO__BINBUFFER_HPP_

#include <oess_1/io/h/declspec.hpp>

#include <oess_1/io/h/binstream.hpp>

namespace oess_1 {

namespace io {

//
// ibinbuffer_t
//

/*!
	\since v.1.1.1
	\brief Интерфейс двоичного входного буфера-потока.

	В некоторых случаях извлечение данных происходит из
	заранее сформированного буфера. В таких случаях
	можно сообщить:
		- объем доступных данных в буфере (size);
		- текущую позицию в буфере.

	Интерфейс %ibinbuffer_t предназначен для того, чтобы
	быть базовым для всех входных буферов-потоков.
*/
class	OESS_1__IO__TYPE	ibinbuffer_t
	: public ibinstream_t
{
	public :
		virtual ~ibinbuffer_t();

		//! Объем доступных в буфере данных.
		virtual size_t
		size() const = 0;

		//! Текущая позиция в буфере.
		virtual size_t
		pos() const = 0;

		virtual bool
		eof() const = 0;

	protected :
		virtual const oess_1::char_t *
		in_reserve(
			size_t item_count,
			size_t item_size,
			size_t & item_available ) = 0;

		virtual void
		in_shift(
			size_t item_count,
			size_t item_size ) = 0;
};

//
// obinbuffer_t
//

/*!
	\since v.1.1.1
	\brief Интерфейс двоичного выходного буфера-потока.

	В некоторых случаях помещение данных происходит в
	заранее подготовленный буфер (фиксированного или
	переменного размера). В таких случаях
	можно сообщить:
		- общий объем буфера (capacity). Для буфера
	фиксированного размера определяет максимальный объем
	данных, которые можно поместить в буфер. Для буфера
	переменного размера определяет, сколько данных можно
	поместить в буфер без пересоздания буфера большего
	объема;
		- текущий размер помещенных в буфер данных (size);
		- текущую позицию в буфере.

	Интерфейс %obinbuffer_t предназначен для того, чтобы
	быть базовым для всех выходных буферов-потоков.
*/
class	OESS_1__IO__TYPE	obinbuffer_t
	:	public obinstream_t
{
	public :
		virtual ~obinbuffer_t();

		//! Общий объем буфера.
		virtual size_t
		capacity() const = 0;

		//! Объем помещенных в буфер данных.
		virtual size_t
		size() const = 0;

		//! Текущая позиция в буфере.
		virtual size_t
		pos() const = 0;

	protected :
		virtual oess_1::char_t *
		out_reserve(
			size_t item_count,
			size_t item_size,
			size_t & item_available ) = 0;

		virtual void
		out_shift(
			size_t item_count,
			size_t item_size ) = 0;
};

} /* namespace io */

} /* namespace oess_1 */

#endif
