nuclear@0: /*
nuclear@0: ---------------------------------------------------------------------------
nuclear@0: Open Asset Import Library (assimp)
nuclear@0: ---------------------------------------------------------------------------
nuclear@0: 
nuclear@0: Copyright (c) 2006-2018, assimp team
nuclear@0: 
nuclear@0: 
nuclear@0: 
nuclear@0: All rights reserved.
nuclear@0: 
nuclear@0: Redistribution and use of this software in source and binary forms,
nuclear@0: with or without modification, are permitted provided that the following
nuclear@0: conditions are met:
nuclear@0: 
nuclear@0: * Redistributions of source code must retain the above
nuclear@0:   copyright notice, this list of conditions and the
nuclear@0:   following disclaimer.
nuclear@0: 
nuclear@0: * Redistributions in binary form must reproduce the above
nuclear@0:   copyright notice, this list of conditions and the
nuclear@0:   following disclaimer in the documentation and/or other
nuclear@0:   materials provided with the distribution.
nuclear@0: 
nuclear@0: * Neither the name of the assimp team, nor the names of its
nuclear@0:   contributors may be used to endorse or promote products
nuclear@0:   derived from this software without specific prior
nuclear@0:   written permission of the assimp team.
nuclear@0: 
nuclear@0: THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
nuclear@0: "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
nuclear@0: LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
nuclear@0: A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
nuclear@0: OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
nuclear@0: SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
nuclear@0: LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
nuclear@0: DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
nuclear@0: THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
nuclear@0: (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
nuclear@0: OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
nuclear@0: ---------------------------------------------------------------------------
nuclear@0: */
nuclear@0: 
nuclear@0: /** @file cfileio.h
nuclear@0:  *  @brief Defines generic C routines to access memory-mapped files
nuclear@0:  */
nuclear@0: #pragma once
nuclear@0: #ifndef AI_FILEIO_H_INC
nuclear@0: #define AI_FILEIO_H_INC
nuclear@0: 
nuclear@0: #include <miniassimp/types.h>
nuclear@0: #ifdef __cplusplus
nuclear@0: extern "C" {
nuclear@0: #endif
nuclear@0: struct aiFileIO;
nuclear@0: struct aiFile;
nuclear@0: 
nuclear@0: // aiFile callbacks
nuclear@0: typedef size_t          (*aiFileWriteProc) (C_STRUCT aiFile*,   const char*, size_t, size_t);
nuclear@0: typedef size_t          (*aiFileReadProc)  (C_STRUCT aiFile*,   char*, size_t,size_t);
nuclear@0: typedef size_t          (*aiFileTellProc)  (C_STRUCT aiFile*);
nuclear@0: typedef void            (*aiFileFlushProc) (C_STRUCT aiFile*);
nuclear@0: typedef C_ENUM aiReturn (*aiFileSeek)      (C_STRUCT aiFile*, size_t, C_ENUM aiOrigin);
nuclear@0: 
nuclear@0: // aiFileIO callbacks
nuclear@0: typedef C_STRUCT aiFile* (*aiFileOpenProc)  (C_STRUCT aiFileIO*, const char*, const char*);
nuclear@0: typedef void             (*aiFileCloseProc) (C_STRUCT aiFileIO*, C_STRUCT aiFile*);
nuclear@0: 
nuclear@0: // Represents user-defined data
nuclear@0: typedef char* aiUserData;
nuclear@0: 
nuclear@0: // ----------------------------------------------------------------------------------
nuclear@0: /** @brief C-API: File system callbacks
nuclear@0:  *
nuclear@0:  *  Provided are functions to open and close files. Supply a custom structure to
nuclear@0:  *  the import function. If you don't, a default implementation is used. Use custom
nuclear@0:  *  file systems to enable reading from other sources, such as ZIPs
nuclear@0:  *  or memory locations. */
nuclear@0: struct aiFileIO
nuclear@0: {
nuclear@0:     /** Function used to open a new file
nuclear@0:      */
nuclear@0:     aiFileOpenProc OpenProc;
nuclear@0: 
nuclear@0:     /** Function used to close an existing file
nuclear@0:      */
nuclear@0:     aiFileCloseProc CloseProc;
nuclear@0: 
nuclear@0:     /** User-defined, opaque data */
nuclear@0:     aiUserData UserData;
nuclear@0: };
nuclear@0: 
nuclear@0: // ----------------------------------------------------------------------------------
nuclear@0: /** @brief C-API: File callbacks
nuclear@0:  *
nuclear@0:  *  Actually, it's a data structure to wrap a set of fXXXX (e.g fopen)
nuclear@0:  *  replacement functions.
nuclear@0:  *
nuclear@0:  *  The default implementation of the functions utilizes the fXXX functions from
nuclear@0:  *  the CRT. However, you can supply a custom implementation to Assimp by
nuclear@0:  *  delivering a custom aiFileIO. Use this to enable reading from other sources,
nuclear@0:  *  such as ZIP archives or memory locations. */
nuclear@0: struct aiFile
nuclear@0: {
nuclear@0:     /** Callback to read from a file */
nuclear@0:     aiFileReadProc ReadProc;
nuclear@0: 
nuclear@0:     /** Callback to write to a file */
nuclear@0:     aiFileWriteProc WriteProc;
nuclear@0: 
nuclear@0:     /** Callback to retrieve the current position of
nuclear@0:      *  the file cursor (ftell())
nuclear@0:      */
nuclear@0:     aiFileTellProc TellProc;
nuclear@0: 
nuclear@0:     /** Callback to retrieve the size of the file,
nuclear@0:      *  in bytes
nuclear@0:      */
nuclear@0:     aiFileTellProc FileSizeProc;
nuclear@0: 
nuclear@0:     /** Callback to set the current position
nuclear@0:      * of the file cursor (fseek())
nuclear@0:      */
nuclear@0:     aiFileSeek SeekProc;
nuclear@0: 
nuclear@0:     /** Callback to flush the file contents
nuclear@0:      */
nuclear@0:     aiFileFlushProc FlushProc;
nuclear@0: 
nuclear@0:     /** User-defined, opaque data
nuclear@0:      */
nuclear@0:     aiUserData UserData;
nuclear@0: };
nuclear@0: 
nuclear@0: #ifdef __cplusplus
nuclear@0: }
nuclear@0: #endif
nuclear@0: #endif // AI_FILEIO_H_INC