miniassimp

annotate include/miniassimp/DefaultIOStream.h @ 0:879c81d94345

initial commit
author John Tsiombikas <nuclear@member.fsf.org>
date Mon, 28 Jan 2019 18:19:26 +0200
parents
children
rev   line source
nuclear@0 1 /*
nuclear@0 2 Open Asset Import Library (assimp)
nuclear@0 3 ----------------------------------------------------------------------
nuclear@0 4
nuclear@0 5 Copyright (c) 2006-2018, assimp team
nuclear@0 6
nuclear@0 7
nuclear@0 8 All rights reserved.
nuclear@0 9
nuclear@0 10 Redistribution and use of this software in source and binary forms,
nuclear@0 11 with or without modification, are permitted provided that the
nuclear@0 12 following conditions are met:
nuclear@0 13
nuclear@0 14 * Redistributions of source code must retain the above
nuclear@0 15 copyright notice, this list of conditions and the
nuclear@0 16 following disclaimer.
nuclear@0 17
nuclear@0 18 * Redistributions in binary form must reproduce the above
nuclear@0 19 copyright notice, this list of conditions and the
nuclear@0 20 following disclaimer in the documentation and/or other
nuclear@0 21 materials provided with the distribution.
nuclear@0 22
nuclear@0 23 * Neither the name of the assimp team, nor the names of its
nuclear@0 24 contributors may be used to endorse or promote products
nuclear@0 25 derived from this software without specific prior
nuclear@0 26 written permission of the assimp team.
nuclear@0 27
nuclear@0 28 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0 29 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0 30 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0 31 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0 32 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0 33 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0 34 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0 35 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0 36 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0 37 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0 38 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0 39
nuclear@0 40 ----------------------------------------------------------------------
nuclear@0 41 */
nuclear@0 42
nuclear@0 43 /** @file Default file I/O using fXXX()-family of functions */
nuclear@0 44 #ifndef AI_DEFAULTIOSTREAM_H_INC
nuclear@0 45 #define AI_DEFAULTIOSTREAM_H_INC
nuclear@0 46
nuclear@0 47 #include <stdio.h>
nuclear@0 48 #include <miniassimp/IOStream.hpp>
nuclear@0 49 #include <miniassimp/importerdesc.h>
nuclear@0 50 #include <miniassimp/Defines.h>
nuclear@0 51
nuclear@0 52 namespace Assimp {
nuclear@0 53
nuclear@0 54 // ----------------------------------------------------------------------------------
nuclear@0 55 //! @class DefaultIOStream
nuclear@0 56 //! @brief Default IO implementation, use standard IO operations
nuclear@0 57 //! @note An instance of this class can exist without a valid file handle
nuclear@0 58 //! attached to it. All calls fail, but the instance can nevertheless be
nuclear@0 59 //! used with no restrictions.
nuclear@0 60 class ASSIMP_API DefaultIOStream : public IOStream
nuclear@0 61 {
nuclear@0 62 friend class DefaultIOSystem;
nuclear@0 63 #if __ANDROID__
nuclear@0 64 # if __ANDROID_API__ > 9
nuclear@0 65 # if defined(AI_CONFIG_ANDROID_JNI_ASSIMP_MANAGER_SUPPORT)
nuclear@0 66 friend class AndroidJNIIOSystem;
nuclear@0 67 # endif // defined(AI_CONFIG_ANDROID_JNI_ASSIMP_MANAGER_SUPPORT)
nuclear@0 68 # endif // __ANDROID_API__ > 9
nuclear@0 69 #endif // __ANDROID__
nuclear@0 70
nuclear@0 71 protected:
nuclear@0 72 DefaultIOStream() AI_NO_EXCEPT;
nuclear@0 73 DefaultIOStream(FILE* pFile, const std::string &strFilename);
nuclear@0 74
nuclear@0 75 public:
nuclear@0 76 /** Destructor public to allow simple deletion to close the file. */
nuclear@0 77 ~DefaultIOStream ();
nuclear@0 78
nuclear@0 79 // -------------------------------------------------------------------
nuclear@0 80 /// Read from stream
nuclear@0 81 size_t Read(void* pvBuffer,
nuclear@0 82 size_t pSize,
nuclear@0 83 size_t pCount);
nuclear@0 84
nuclear@0 85
nuclear@0 86 // -------------------------------------------------------------------
nuclear@0 87 /// Write to stream
nuclear@0 88 size_t Write(const void* pvBuffer,
nuclear@0 89 size_t pSize,
nuclear@0 90 size_t pCount);
nuclear@0 91
nuclear@0 92 // -------------------------------------------------------------------
nuclear@0 93 /// Seek specific position
nuclear@0 94 aiReturn Seek(size_t pOffset,
nuclear@0 95 aiOrigin pOrigin);
nuclear@0 96
nuclear@0 97 // -------------------------------------------------------------------
nuclear@0 98 /// Get current seek position
nuclear@0 99 size_t Tell() const;
nuclear@0 100
nuclear@0 101 // -------------------------------------------------------------------
nuclear@0 102 /// Get size of file
nuclear@0 103 size_t FileSize() const;
nuclear@0 104
nuclear@0 105 // -------------------------------------------------------------------
nuclear@0 106 /// Flush file contents
nuclear@0 107 void Flush();
nuclear@0 108
nuclear@0 109 private:
nuclear@0 110 // File data-structure, using clib
nuclear@0 111 FILE* mFile;
nuclear@0 112 // Filename
nuclear@0 113 std::string mFilename;
nuclear@0 114 // Cached file size
nuclear@0 115 mutable size_t mCachedSize;
nuclear@0 116 };
nuclear@0 117
nuclear@0 118 // ----------------------------------------------------------------------------------
nuclear@0 119 inline
nuclear@0 120 DefaultIOStream::DefaultIOStream() AI_NO_EXCEPT
nuclear@0 121 : mFile(0)
nuclear@0 122 , mFilename("")
nuclear@0 123 , mCachedSize(SIZE_MAX) {
nuclear@0 124 // empty
nuclear@0 125 }
nuclear@0 126
nuclear@0 127 // ----------------------------------------------------------------------------------
nuclear@0 128 inline
nuclear@0 129 DefaultIOStream::DefaultIOStream (FILE* pFile, const std::string &strFilename)
nuclear@0 130 : mFile(pFile)
nuclear@0 131 , mFilename(strFilename)
nuclear@0 132 , mCachedSize(SIZE_MAX) {
nuclear@0 133 // empty
nuclear@0 134 }
nuclear@0 135 // ----------------------------------------------------------------------------------
nuclear@0 136
nuclear@0 137 } // ns assimp
nuclear@0 138
nuclear@0 139 #endif //!!AI_DEFAULTIOSTREAM_H_INC
nuclear@0 140