io/h/stream.hpp

/*

Copyright (c) 2002-2008, Yauheni Akhotnikau
Copyright (c) 2008-2016, The SObjectizer Project
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.

*/

/*!
	\file
	\brief Basic classes for input and output streams.
*/

#if !defined( OESS_2_IO_STREAM_HPP )
#define OESS_2_IO_STREAM_HPP

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

#include <string>

#include <oess_2/defs/h/types.hpp>
#include <oess_2/defs/h/quantity.hpp>

namespace oess_2 {

namespace io {

//
// istream_t
//

/*!
	\brief Base class for input binary stream.

	Defines read operations for basic types.

	\par v.2.1.0
	Since v2.1.0 ObjESSty supports only binary streams.
	Because of that there no any need of deep abstraction of
	stream classes. istream_t now is base class for abstract
	input binary stream.
*/
class	OESS_2_IO_TYPE	istream_t {
	public :
		istream_t( const istream_t & ) = delete;
		istream_t( istream_t && ) = delete;
		istream_t & operator=( const istream_t & ) = delete;
		istream_t & operator=( istream_t && ) = delete;

		istream_t();
		virtual ~istream_t();

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::char_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::schar_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::uchar_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::short_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::ushort_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::int_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::uint_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::long_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::ulong_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::single_t * p, size_t count );

		/*!
		 * Read \a count items and store them into \a p.
		 */
		void
		read( oess_2::double_t * p, size_t count );

		/*!
		 * Read a string from input stream and store it into \a p.
		 *
		 * Uses fixed-length representation of string size.
		 */
		void
		read_fixed_size_string( std::string & p );

		/*!
		 * \since
		 * v.2.1.0
		 *
		 * Load string from the stream into \a p.
		 *
		 * Method uses string representation with variable width
		 * dimension field.
		 */
		void
		read_variable_size_string( std::string & p );

		/*!
		 * \since
		 * v.1.4.0-b2.2
		 *
		 * \brief Load a quantity object from stream.
		 */
		void
		read( oess_2::defs::quantity_t & p );

		/*!
		 * \since
		 * v.2.2.0
		 *
		 * \brief Load a bool value from stream.
		 */
		void
		read_bool( oess_2::bool_t & p );

		/*!
		 * \since
		 * v.2.0.0
		 *
		 * \brief Read and throw away some bytes from stream.
		 *
		 * This method is useful if there is some data which must
		 * be skipped.
		 */
		void
		shift_bytes( size_t bytes_count );

		//! Is it end of stream?
		virtual bool
		eof() const = 0;

	protected :
		friend	class ibuffer_accessor_t;
		friend	class	isubstream_t;

		//! Get the pointer from which data could be read.
		/*!
		 * Should throw an exception if there is no more data available
		 * for reading.
		 */
		virtual const oess_2::char_t *
		in_reserve(
			//! Count of items for read.
			size_t item_count,
			//! Size of one item in bytes.
			size_t item_size,
			//! Receiver for count of items available for reading.
			size_t & item_available ) = 0;

		//! Complete the data read.
		/*!
		 * This method is called just after reading the data from
		 * pointer returned by in_reserve() method.
		 */
		virtual void
		in_shift(
			//! Count of items read.
			size_t item_count,
			//! Size of one item in bytes.
			size_t item_size ) = 0;

	private :
		/*!
		 * \since
		 * v.2.1.0
		 *
		 * \brief Auxiliary method to load string contents.
		 */
		void
		read_string_content( std::string & receiver, size_t length );
};

//
// ostream_t
//

//! Base class for output binary stream.
class	OESS_2_IO_TYPE	ostream_t {
	public :
		ostream_t( const ostream_t & ) = delete;
		ostream_t( ostream_t && ) = delete;
		ostream_t & operator=( const ostream_t & ) = delete;
		ostream_t & operator=( ostream_t && ) = delete;

		ostream_t();
		virtual ~ostream_t();

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::char_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::schar_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::uchar_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::short_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::ushort_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::int_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::uint_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::long_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::ulong_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::single_t * p, size_t count );

		/*!
		 * Write \a count items from \a p into stream.
		 */
		void
		write( const oess_2::double_t * p, size_t count );

		/*!
		 * \since v.2.1.0
		 * \brief Write string to the stream.
		 *
		 * String size field is writen as fixed-size 32-bit value.
		 */
		void
		write_fixed_size_string( const std::string & p );

		/*!
		 * \since v.2.1.0
		 * \brief Write string to the stream.
		 *
		 * String size field is writen as variable width value.
		 */
		void
		write_variable_size_string( const std::string & p );

		/*!
		 * \since
		 * v.1.4.0-b2.2
		 *
		 * \brief Write a quantity object into the stream.
		 */
		void
		write( const oess_2::defs::quantity_t & p );

		/*!
		 * \since
		 * v.2.2.0
		 *
		 * \brief Write a bool value into the stream.
		 */
		void
		write_bool( const oess_2::bool_t & p );

	protected :
		friend	class obuffer_accessor_t;

		//! Get the pointer to writting some data into.
		/*!
		 * If there is no room for data an exception must be thrown.
		 */
		virtual oess_2::char_t *
		out_reserve(
			//! Count of items to be written.
			size_t item_count,
			//! Size of item in bytes.
			size_t item_size,
			//! Receiver for the count of items which could be written.
			size_t & item_available ) = 0;

		//! Complete the write operation.
		/*!
		 * This method is called just after writting some data to
		 * the pointer returned by previous out_reserve() call.
		 */
		virtual void
		out_shift(
			//! Count of successfully written items.
			size_t item_count,
			//! Size of item in bytes.
			size_t item_size ) = 0;
};


//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::char_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::char_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::schar_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::schar_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::uchar_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::uchar_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::bool_t & o ) {
	s.read_bool( o );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::bool_t & o ) {
	s.write_bool( o );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::short_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::short_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::ushort_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::ushort_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::int_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::int_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::uint_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::uint_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::long_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::long_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::ulong_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::ulong_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::single_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::single_t & o ) {
	s.write( &o, 1 );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::double_t & o ) {
	s.read( &o, 1 );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::double_t & o ) {
	s.write( &o, 1 );
	return s;
}

/*!
 * \brief Read single string object from stream.
 *
 * This operator assumes that string is stored with fixed-width
 * size field. This if for compatibility reasons.
 */
inline istream_t &
operator>>( istream_t & s, std::string & o ) {
	s.read_fixed_size_string( o );
	return s;
}

/*!
 * \brief Write single string object to stream.
 *
 * This operator writes string with fixed-width size field. This if for
 * compatibility reasons.
 */
inline ostream_t &
operator<<( ostream_t & s, const std::string & o ) {
	s.write_fixed_size_string( o );
	return s;
}

//! Read single object from a stream.
inline istream_t &
operator>>( istream_t & s, oess_2::defs::quantity_t & o ) {
	s.read( o );
	return s;
}

//! Write single object to a stream.
inline ostream_t &
operator<<( ostream_t & s, const oess_2::defs::quantity_t & o ) {
	s.write( o );
	return s;
}

} /* namespace io */

} /* namespace oess_2 */

#endif