vrshoot

diff libs/assimp/assimp/IOStream.hpp @ 0:b2f14e535253

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Sat, 01 Feb 2014 19:58:19 +0200
parents
children
line diff
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/libs/assimp/assimp/IOStream.hpp	Sat Feb 01 19:58:19 2014 +0200
     1.3 @@ -0,0 +1,135 @@
     1.4 +/*
     1.5 +---------------------------------------------------------------------------
     1.6 +Open Asset Import Library (assimp)
     1.7 +---------------------------------------------------------------------------
     1.8 +
     1.9 +Copyright (c) 2006-2012, assimp team
    1.10 +
    1.11 +All rights reserved.
    1.12 +
    1.13 +Redistribution and use of this software in source and binary forms, 
    1.14 +with or without modification, are permitted provided that the following 
    1.15 +conditions are met:
    1.16 +
    1.17 +* Redistributions of source code must retain the above
    1.18 +  copyright notice, this list of conditions and the
    1.19 +  following disclaimer.
    1.20 +
    1.21 +* Redistributions in binary form must reproduce the above
    1.22 +  copyright notice, this list of conditions and the
    1.23 +  following disclaimer in the documentation and/or other
    1.24 +  materials provided with the distribution.
    1.25 +
    1.26 +* Neither the name of the assimp team, nor the names of its
    1.27 +  contributors may be used to endorse or promote products
    1.28 +  derived from this software without specific prior
    1.29 +  written permission of the assimp team.
    1.30 +
    1.31 +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
    1.32 +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
    1.33 +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
    1.34 +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
    1.35 +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
    1.36 +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
    1.37 +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    1.38 +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
    1.39 +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
    1.40 +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
    1.41 +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    1.42 +---------------------------------------------------------------------------
    1.43 +*/
    1.44 +/** @file IOStream.h
    1.45 + *  @brief File I/O wrappers for C++. 
    1.46 + */
    1.47 +
    1.48 +#ifndef AI_IOSTREAM_H_INC
    1.49 +#define AI_IOSTREAM_H_INC
    1.50 +
    1.51 +#include "types.h"
    1.52 +
    1.53 +#ifndef __cplusplus
    1.54 +#	error This header requires C++ to be used. aiFileIO.h is the \
    1.55 +	corresponding C interface.
    1.56 +#endif
    1.57 +
    1.58 +namespace Assimp	{
    1.59 +
    1.60 +// ----------------------------------------------------------------------------------
    1.61 +/** @brief CPP-API: Class to handle file I/O for C++
    1.62 + *
    1.63 + *  Derive an own implementation from this interface to provide custom IO handling
    1.64 + *  to the Importer. If you implement this interface, be sure to also provide an
    1.65 + *  implementation for IOSystem that creates instances of your custom IO class.
    1.66 +*/
    1.67 +class ASSIMP_API IOStream : public Intern::AllocateFromAssimpHeap
    1.68 +{
    1.69 +protected:
    1.70 +	/** Constructor protected, use IOSystem::Open() to create an instance. */
    1.71 +	IOStream(void);
    1.72 +
    1.73 +public:
    1.74 +	// -------------------------------------------------------------------
    1.75 +	/** @brief Destructor. Deleting the object closes the underlying file, 
    1.76 +	 * alternatively you may use IOSystem::Close() to release the file. 
    1.77 +	 */
    1.78 +	virtual ~IOStream();
    1.79 +
    1.80 +	// -------------------------------------------------------------------
    1.81 +	/** @brief Read from the file
    1.82 +	 *
    1.83 +	 * See fread() for more details
    1.84 +	 * This fails for write-only files */
    1.85 +    virtual size_t Read(void* pvBuffer, 
    1.86 +		size_t pSize, 
    1.87 +		size_t pCount) = 0;
    1.88 +
    1.89 +	// -------------------------------------------------------------------
    1.90 +	/** @brief Write to the file
    1.91 +	*
    1.92 +	* See fwrite() for more details
    1.93 +	* This fails for read-only files */
    1.94 +    virtual size_t Write(const void* pvBuffer, 
    1.95 +		size_t pSize,
    1.96 +		size_t pCount) = 0;
    1.97 +
    1.98 +	// -------------------------------------------------------------------
    1.99 +	/** @brief Set the read/write cursor of the file
   1.100 +	 *
   1.101 +	 * Note that the offset is _negative_ for aiOrigin_END.
   1.102 +	 * See fseek() for more details */
   1.103 +	virtual aiReturn Seek(size_t pOffset,
   1.104 +		aiOrigin pOrigin) = 0;
   1.105 +
   1.106 +	// -------------------------------------------------------------------
   1.107 +	/** @brief Get the current position of the read/write cursor
   1.108 +	 *
   1.109 +	 * See ftell() for more details */
   1.110 +    virtual size_t Tell() const = 0;
   1.111 +
   1.112 +	// -------------------------------------------------------------------
   1.113 +	/**	@brief Returns filesize
   1.114 +	 *	Returns the filesize. */
   1.115 +	virtual size_t FileSize() const = 0;
   1.116 +
   1.117 +	// -------------------------------------------------------------------
   1.118 +	/**	@brief Flush the contents of the file buffer (for writers) 
   1.119 +	 *	See fflush() for more details.
   1.120 +	 */
   1.121 +	virtual void Flush() = 0;
   1.122 +}; //! class IOStream
   1.123 +
   1.124 +// ----------------------------------------------------------------------------------
   1.125 +inline IOStream::IOStream()
   1.126 +{
   1.127 +	// empty
   1.128 +}
   1.129 +
   1.130 +// ----------------------------------------------------------------------------------
   1.131 +inline IOStream::~IOStream()
   1.132 +{
   1.133 +	// empty
   1.134 +}
   1.135 +// ----------------------------------------------------------------------------------
   1.136 +} //!namespace Assimp
   1.137 +
   1.138 +#endif //!!AI_IOSTREAM_H_INC