miniassimp

diff include/miniassimp/IOStream.hpp @ 0:879c81d94345

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