file_basic.hpp

fflib的AI开发框架

/*  Copy Left/Right : OTHER ,Amfproject                                     *
 *                                                                          *
 *     This program is free software; you can redistribute it and/or modify *
 *  it under the terms of the GNU General Public License as published by    *
 *  the Free Software Foundation; version 2 of the License.                 *
 *                                                                          *
 *  This program 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 General Public License for more details.                            *
 *                                                                          *
 *  You should have received a copy of the GNU General Public License       *
 *  along with this program; if not, write to the Free Software             *
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA*
 ****************************************************************************
 * Project:    FFLib
 * Programmer: lucy
 * Created On: Jan 9, 2009
 ****************************************************************************/

#ifndef FILE_BASIC_HPP_
#define FILE_BASIC_HPP_
/*-- Compiler Controls -----------------------------------------------------*/

/*-- Includes --------------------------------------------------------------*/
#include <boost/utility.hpp>
/*-- Namespace Controller --------------------------------------------------*/
namespace fate
{
namespace generic
{

/*-- Extern Types ----------------------------------------------------------*/

/*--------------------------------------------------------------------------*/

class file:private boost::noncopyable
{
private:

	///
	///wrapper for file Stream,controlled by file
	///
	class fileStream
	{
	public:

		fileStream(std::string const & filePath,std::ios_base openMode);


		///proxy class for fstream,open or close automatically
		~fileStream();


		///
		///returns fstream with normal
		///
		std::fstream& getStream();

		///
		///returns fstream with const property
		///
		const std::fstream& getReadOnlyStream() const;

		///
		///close the stream and save to file
		///
		void killBuffer();


	protected:

		///
		///the stream kernel
		///
		std::fstream theStream;
	};
	///
	///
	///
	std::fstream seekStream;

	///
	/// strore its file Path
	///
	std::string filePath;


	///
	///visit file in class path randomly\n
	///this will be called when no file path specified
	void visitRandom();


	///some fflib based program may use file descriptor to identify a file.\n
	///default is zero,and stands for non-descriptor was set.
	///
	unsigned int descriptor;
public:

	class stream_occupied:public std::logic_error
	{
	public:
		stream_occupied(std::string const & rfs)
		:std::logic_error(rfs)
		{   }

		virtual ~stream_occupied() throw()
		{

		}
	};



	///empty file that do not do anything\n
	///when get Output stream,will get a random access file
	///
	file();

	///visit file at filePath
	///@param filePath
	///		the filePathtoVisit
	file(std::string const & filePath);

	///get the input Stream of the file,note different file type has different implementation
	///@throws stream_occupied
	///		throw stream_occupied when the stream is already open and not closed
	virtual fileStream getInStream() throw(stream_occupied) =0;

	///get the output stream of the file,note different file type has different implementation
	///@throws stream_occupied
	///		throw this exception when the stream is already open and not closed
	virtual fileStream getOutStream() throw(stream_occupied) =0;


	///set the Descriptor of the file.
	///@param descriptor
	///		the descriptor
	void setDescriptor(unsigned int descriptor);

	///get the descriptor of the file.
	///
	///
	unsigned int getDescriptor() const;

	///
	///destructor
	///
	virtual ~file();
};











/*-- Namespace Ender -------------------------------------------------------*/

}
}
/*--------------------------------------------------------------------------*/
#endif /* FILE_BASIC_HPP_ */