//------------------------------------------------------------------------------
// Lamp : Open source game middleware
// Copyright (C) 2004  Junpei Ohtani ( Email : junpee@users.sourceforge.jp )
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
//------------------------------------------------------------------------------

/** @file
 * 入力ストリームヘッダ
 * @author Junpee
 */

#ifndef INPUT_STREAM_H_
#define INPUT_STREAM_H_

namespace Lamp{

//------------------------------------------------------------------------------
/**
 * 入力ストリーム
 */
class InputStream{
friend class Reader;
public:
	/**
	 * コンストラクタ
	 */
	InputStream(){}

	/**
	 * デストラクタ
	 */
	virtual ~InputStream(){}

	/**
	 * 入力ストリームの複製
	 * @return 複製された入力ストリーム
	 */
	virtual InputStream* cloneInputStream() = 0;

protected:
	/**
	 * 終端かどうか
	 * @return trueなら終端
	 */
	virtual bool isEnd() = 0;

	/**
	 * バイトデータの読み込み
	 * @param data 読み出し先アドレス
	 * @param size 読み出すサイズ
	 */
	virtual void readBytes(void* data, int size) = 0;

	/**
	 * サイズの取得
	 * @return ストリーム全体のバイト数
	 */
	virtual int getSize() = 0;

	/**
	 * スキップ
	 *
	 * 指定されたバイト数、読み出しをスキップします。
	 * @param size スキップするバイト数
	 */
	virtual void skip(int size) = 0;

	/**
	 * アライメントを取る
	 *
	 * 指定されたバイト数のアライメントまで読み飛ばします。
	 * @param size アライメントをとるバイト数
	 * @return スキップしたバイト数
	 */
	virtual int align(int size) = 0;

	/**
	 * 読み込み位置の取得
	 * @return 読み込み位置
	 */
	virtual int getPosition() = 0;

	/**
	 * 読み込み位置の設定
	 *
	 * 指定された位置に読み込み位置を変更します。
	 * @param position 読み込み位置
	 */
	virtual void setPosition(int position) = 0;

private:
	// コピーコンストラクタの隠蔽
	InputStream(const InputStream& copy);

	// 代入コピーの隠蔽
	void operator =(const InputStream& copy);

};

//------------------------------------------------------------------------------
} // End of namespace Lamp
#endif // End of INPUT_STREAM_H_
//------------------------------------------------------------------------------
