From 30f41c02aec763d32e62351452da9ef582bc3472 Mon Sep 17 00:00:00 2001 From: 3gg <3gg@shellblade.net> Date: Fri, 6 Mar 2026 13:30:59 -0800 Subject: Move contrib libraries to contrib repo --- contrib/SDL-3.2.8/include/SDL3/SDL_iostream.h | 1354 ------------------------- 1 file changed, 1354 deletions(-) delete mode 100644 contrib/SDL-3.2.8/include/SDL3/SDL_iostream.h (limited to 'contrib/SDL-3.2.8/include/SDL3/SDL_iostream.h') diff --git a/contrib/SDL-3.2.8/include/SDL3/SDL_iostream.h b/contrib/SDL-3.2.8/include/SDL3/SDL_iostream.h deleted file mode 100644 index 4ca1609..0000000 --- a/contrib/SDL-3.2.8/include/SDL3/SDL_iostream.h +++ /dev/null @@ -1,1354 +0,0 @@ -/* - Simple DirectMedia Layer - Copyright (C) 1997-2025 Sam Lantinga - - This software is provided 'as-is', without any express or implied - warranty. In no event will the authors be held liable for any damages - arising from the use of this software. - - Permission is granted to anyone to use this software for any purpose, - including commercial applications, and to alter it and redistribute it - freely, subject to the following restrictions: - - 1. The origin of this software must not be misrepresented; you must not - claim that you wrote the original software. If you use this software - in a product, an acknowledgment in the product documentation would be - appreciated but is not required. - 2. Altered source versions must be plainly marked as such, and must not be - misrepresented as being the original software. - 3. This notice may not be removed or altered from any source distribution. -*/ - -/* WIKI CATEGORY: IOStream */ - -/** - * # CategoryIOStream - * - * SDL provides an abstract interface for reading and writing data streams. It - * offers implementations for files, memory, etc, and the app can provide - * their own implementations, too. - * - * SDL_IOStream is not related to the standard C++ iostream class, other than - * both are abstract interfaces to read/write data. - */ - -#ifndef SDL_iostream_h_ -#define SDL_iostream_h_ - -#include -#include -#include - -#include -/* Set up for C function definitions, even when using C++ */ -#ifdef __cplusplus -extern "C" { -#endif - -/** - * SDL_IOStream status, set by a read or write operation. - * - * \since This enum is available since SDL 3.2.0. - */ -typedef enum SDL_IOStatus -{ - SDL_IO_STATUS_READY, /**< Everything is ready (no errors and not EOF). */ - SDL_IO_STATUS_ERROR, /**< Read or write I/O error */ - SDL_IO_STATUS_EOF, /**< End of file */ - SDL_IO_STATUS_NOT_READY, /**< Non blocking I/O, not ready */ - SDL_IO_STATUS_READONLY, /**< Tried to write a read-only buffer */ - SDL_IO_STATUS_WRITEONLY /**< Tried to read a write-only buffer */ -} SDL_IOStatus; - -/** - * Possible `whence` values for SDL_IOStream seeking. - * - * These map to the same "whence" concept that `fseek` or `lseek` use in the - * standard C runtime. - * - * \since This enum is available since SDL 3.2.0. - */ -typedef enum SDL_IOWhence -{ - SDL_IO_SEEK_SET, /**< Seek from the beginning of data */ - SDL_IO_SEEK_CUR, /**< Seek relative to current read point */ - SDL_IO_SEEK_END /**< Seek relative to the end of data */ -} SDL_IOWhence; - -/** - * The function pointers that drive an SDL_IOStream. - * - * Applications can provide this struct to SDL_OpenIO() to create their own - * implementation of SDL_IOStream. This is not necessarily required, as SDL - * already offers several common types of I/O streams, via functions like - * SDL_IOFromFile() and SDL_IOFromMem(). - * - * This structure should be initialized using SDL_INIT_INTERFACE() - * - * \since This struct is available since SDL 3.2.0. - * - * \sa SDL_INIT_INTERFACE - */ -typedef struct SDL_IOStreamInterface -{ - /* The version of this interface */ - Uint32 version; - - /** - * Return the number of bytes in this SDL_IOStream - * - * \return the total size of the data stream, or -1 on error. - */ - Sint64 (SDLCALL *size)(void *userdata); - - /** - * Seek to `offset` relative to `whence`, one of stdio's whence values: - * SDL_IO_SEEK_SET, SDL_IO_SEEK_CUR, SDL_IO_SEEK_END - * - * \return the final offset in the data stream, or -1 on error. - */ - Sint64 (SDLCALL *seek)(void *userdata, Sint64 offset, SDL_IOWhence whence); - - /** - * Read up to `size` bytes from the data stream to the area pointed - * at by `ptr`. - * - * On an incomplete read, you should set `*status` to a value from the - * SDL_IOStatus enum. You do not have to explicitly set this on - * a complete, successful read. - * - * \return the number of bytes read - */ - size_t (SDLCALL *read)(void *userdata, void *ptr, size_t size, SDL_IOStatus *status); - - /** - * Write exactly `size` bytes from the area pointed at by `ptr` - * to data stream. - * - * On an incomplete write, you should set `*status` to a value from the - * SDL_IOStatus enum. You do not have to explicitly set this on - * a complete, successful write. - * - * \return the number of bytes written - */ - size_t (SDLCALL *write)(void *userdata, const void *ptr, size_t size, SDL_IOStatus *status); - - /** - * If the stream is buffering, make sure the data is written out. - * - * On failure, you should set `*status` to a value from the - * SDL_IOStatus enum. You do not have to explicitly set this on - * a successful flush. - * - * \return true if successful or false on write error when flushing data. - */ - bool (SDLCALL *flush)(void *userdata, SDL_IOStatus *status); - - /** - * Close and free any allocated resources. - * - * This does not guarantee file writes will sync to physical media; they - * can be in the system's file cache, waiting to go to disk. - * - * The SDL_IOStream is still destroyed even if this fails, so clean up anything - * even if flushing buffers, etc, returns an error. - * - * \return true if successful or false on write error when flushing data. - */ - bool (SDLCALL *close)(void *userdata); - -} SDL_IOStreamInterface; - -/* Check the size of SDL_IOStreamInterface - * - * If this assert fails, either the compiler is padding to an unexpected size, - * or the interface has been updated and this should be updated to match and - * the code using this interface should be updated to handle the old version. - */ -SDL_COMPILE_TIME_ASSERT(SDL_IOStreamInterface_SIZE, - (sizeof(void *) == 4 && sizeof(SDL_IOStreamInterface) == 28) || - (sizeof(void *) == 8 && sizeof(SDL_IOStreamInterface) == 56)); - -/** - * The read/write operation structure. - * - * This operates as an opaque handle. There are several APIs to create various - * types of I/O streams, or an app can supply an SDL_IOStreamInterface to - * SDL_OpenIO() to provide their own stream implementation behind this - * struct's abstract interface. - * - * \since This struct is available since SDL 3.2.0. - */ -typedef struct SDL_IOStream SDL_IOStream; - - -/** - * \name IOFrom functions - * - * Functions to create SDL_IOStream structures from various data streams. - */ -/* @{ */ - -/** - * Use this function to create a new SDL_IOStream structure for reading from - * and/or writing to a named file. - * - * The `mode` string is treated roughly the same as in a call to the C - * library's fopen(), even if SDL doesn't happen to use fopen() behind the - * scenes. - * - * Available `mode` strings: - * - * - "r": Open a file for reading. The file must exist. - * - "w": Create an empty file for writing. If a file with the same name - * already exists its content is erased and the file is treated as a new - * empty file. - * - "a": Append to a file. Writing operations append data at the end of the - * file. The file is created if it does not exist. - * - "r+": Open a file for update both reading and writing. The file must - * exist. - * - "w+": Create an empty file for both reading and writing. If a file with - * the same name already exists its content is erased and the file is - * treated as a new empty file. - * - "a+": Open a file for reading and appending. All writing operations are - * performed at the end of the file, protecting the previous content to be - * overwritten. You can reposition (fseek, rewind) the internal pointer to - * anywhere in the file for reading, but writing operations will move it - * back to the end of file. The file is created if it does not exist. - * - * **NOTE**: In order to open a file as a binary file, a "b" character has to - * be included in the `mode` string. This additional "b" character can either - * be appended at the end of the string (thus making the following compound - * modes: "rb", "wb", "ab", "r+b", "w+b", "a+b") or be inserted between the - * letter and the "+" sign for the mixed modes ("rb+", "wb+", "ab+"). - * Additional characters may follow the sequence, although they should have no - * effect. For example, "t" is sometimes appended to make explicit the file is - * a text file. - * - * This function supports Unicode filenames, but they must be encoded in UTF-8 - * format, regardless of the underlying operating system. - * - * In Android, SDL_IOFromFile() can be used to open content:// URIs. As a - * fallback, SDL_IOFromFile() will transparently open a matching filename in - * the app's `assets`. - * - * Closing the SDL_IOStream will close SDL's internal file handle. - * - * The following properties may be set at creation time by SDL: - * - * - `SDL_PROP_IOSTREAM_WINDOWS_HANDLE_POINTER`: a pointer, that can be cast - * to a win32 `HANDLE`, that this SDL_IOStream is using to access the - * filesystem. If the program isn't running on Windows, or SDL used some - * other method to access the filesystem, this property will not be set. - * - `SDL_PROP_IOSTREAM_STDIO_FILE_POINTER`: a pointer, that can be cast to a - * stdio `FILE *`, that this SDL_IOStream is using to access the filesystem. - * If SDL used some other method to access the filesystem, this property - * will not be set. PLEASE NOTE that if SDL is using a different C runtime - * than your app, trying to use this pointer will almost certainly result in - * a crash! This is mostly a problem on Windows; make sure you build SDL and - * your app with the same compiler and settings to avoid it. - * - `SDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER`: a file descriptor that this - * SDL_IOStream is using to access the filesystem. - * - `SDL_PROP_IOSTREAM_ANDROID_AASSET_POINTER`: a pointer, that can be cast - * to an Android NDK `AAsset *`, that this SDL_IOStream is using to access - * the filesystem. If SDL used some other method to access the filesystem, - * this property will not be set. - * - * \param file a UTF-8 string representing the filename to open. - * \param mode an ASCII string representing the mode to be used for opening - * the file. - * \returns a pointer to the SDL_IOStream structure that is created or NULL on - * failure; call SDL_GetError() for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_CloseIO - * \sa SDL_FlushIO - * \sa SDL_ReadIO - * \sa SDL_SeekIO - * \sa SDL_TellIO - * \sa SDL_WriteIO - */ -extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromFile(const char *file, const char *mode); - -#define SDL_PROP_IOSTREAM_WINDOWS_HANDLE_POINTER "SDL.iostream.windows.handle" -#define SDL_PROP_IOSTREAM_STDIO_FILE_POINTER "SDL.iostream.stdio.file" -#define SDL_PROP_IOSTREAM_FILE_DESCRIPTOR_NUMBER "SDL.iostream.file_descriptor" -#define SDL_PROP_IOSTREAM_ANDROID_AASSET_POINTER "SDL.iostream.android.aasset" - -/** - * Use this function to prepare a read-write memory buffer for use with - * SDL_IOStream. - * - * This function sets up an SDL_IOStream struct based on a memory area of a - * certain size, for both read and write access. - * - * This memory buffer is not copied by the SDL_IOStream; the pointer you - * provide must remain valid until you close the stream. Closing the stream - * will not free the original buffer. - * - * If you need to make sure the SDL_IOStream never writes to the memory - * buffer, you should use SDL_IOFromConstMem() with a read-only buffer of - * memory instead. - * - * The following properties will be set at creation time by SDL: - * - * - `SDL_PROP_IOSTREAM_MEMORY_POINTER`: this will be the `mem` parameter that - * was passed to this function. - * - `SDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER`: this will be the `size` parameter - * that was passed to this function. - * - * \param mem a pointer to a buffer to feed an SDL_IOStream stream. - * \param size the buffer size, in bytes. - * \returns a pointer to a new SDL_IOStream structure or NULL on failure; call - * SDL_GetError() for more information. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_IOFromConstMem - * \sa SDL_CloseIO - * \sa SDL_FlushIO - * \sa SDL_ReadIO - * \sa SDL_SeekIO - * \sa SDL_TellIO - * \sa SDL_WriteIO - */ -extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromMem(void *mem, size_t size); - -#define SDL_PROP_IOSTREAM_MEMORY_POINTER "SDL.iostream.memory.base" -#define SDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER "SDL.iostream.memory.size" - -/** - * Use this function to prepare a read-only memory buffer for use with - * SDL_IOStream. - * - * This function sets up an SDL_IOStream struct based on a memory area of a - * certain size. It assumes the memory area is not writable. - * - * Attempting to write to this SDL_IOStream stream will report an error - * without writing to the memory buffer. - * - * This memory buffer is not copied by the SDL_IOStream; the pointer you - * provide must remain valid until you close the stream. Closing the stream - * will not free the original buffer. - * - * If you need to write to a memory buffer, you should use SDL_IOFromMem() - * with a writable buffer of memory instead. - * - * The following properties will be set at creation time by SDL: - * - * - `SDL_PROP_IOSTREAM_MEMORY_POINTER`: this will be the `mem` parameter that - * was passed to this function. - * - `SDL_PROP_IOSTREAM_MEMORY_SIZE_NUMBER`: this will be the `size` parameter - * that was passed to this function. - * - * \param mem a pointer to a read-only buffer to feed an SDL_IOStream stream. - * \param size the buffer size, in bytes. - * \returns a pointer to a new SDL_IOStream structure or NULL on failure; call - * SDL_GetError() for more information. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_IOFromMem - * \sa SDL_CloseIO - * \sa SDL_ReadIO - * \sa SDL_SeekIO - * \sa SDL_TellIO - */ -extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromConstMem(const void *mem, size_t size); - -/** - * Use this function to create an SDL_IOStream that is backed by dynamically - * allocated memory. - * - * This supports the following properties to provide access to the memory and - * control over allocations: - * - * - `SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER`: a pointer to the internal - * memory of the stream. This can be set to NULL to transfer ownership of - * the memory to the application, which should free the memory with - * SDL_free(). If this is done, the next operation on the stream must be - * SDL_CloseIO(). - * - `SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER`: memory will be allocated in - * multiples of this size, defaulting to 1024. - * - * \returns a pointer to a new SDL_IOStream structure or NULL on failure; call - * SDL_GetError() for more information. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_CloseIO - * \sa SDL_ReadIO - * \sa SDL_SeekIO - * \sa SDL_TellIO - * \sa SDL_WriteIO - */ -extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_IOFromDynamicMem(void); - -#define SDL_PROP_IOSTREAM_DYNAMIC_MEMORY_POINTER "SDL.iostream.dynamic.memory" -#define SDL_PROP_IOSTREAM_DYNAMIC_CHUNKSIZE_NUMBER "SDL.iostream.dynamic.chunksize" - -/* @} *//* IOFrom functions */ - - -/** - * Create a custom SDL_IOStream. - * - * Applications do not need to use this function unless they are providing - * their own SDL_IOStream implementation. If you just need an SDL_IOStream to - * read/write a common data source, you should use the built-in - * implementations in SDL, like SDL_IOFromFile() or SDL_IOFromMem(), etc. - * - * This function makes a copy of `iface` and the caller does not need to keep - * it around after this call. - * - * \param iface the interface that implements this SDL_IOStream, initialized - * using SDL_INIT_INTERFACE(). - * \param userdata the pointer that will be passed to the interface functions. - * \returns a pointer to the allocated memory on success or NULL on failure; - * call SDL_GetError() for more information. - * - * \threadsafety It is safe to call this function from any thread. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_CloseIO - * \sa SDL_INIT_INTERFACE - * \sa SDL_IOFromConstMem - * \sa SDL_IOFromFile - * \sa SDL_IOFromMem - */ -extern SDL_DECLSPEC SDL_IOStream * SDLCALL SDL_OpenIO(const SDL_IOStreamInterface *iface, void *userdata); - -/** - * Close and free an allocated SDL_IOStream structure. - * - * SDL_CloseIO() closes and cleans up the SDL_IOStream stream. It releases any - * resources used by the stream and frees the SDL_IOStream itself. This - * returns true on success, or false if the stream failed to flush to its - * output (e.g. to disk). - * - * Note that if this fails to flush the stream for any reason, this function - * reports an error, but the SDL_IOStream is still invalid once this function - * returns. - * - * This call flushes any buffered writes to the operating system, but there - * are no guarantees that those writes have gone to physical media; they might - * be in the OS's file cache, waiting to go to disk later. If it's absolutely - * crucial that writes go to disk immediately, so they are definitely stored - * even if the power fails before the file cache would have caught up, one - * should call SDL_FlushIO() before closing. Note that flushing takes time and - * makes the system and your app operate less efficiently, so do so sparingly. - * - * \param context SDL_IOStream structure to close. - * \returns true on success or false on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_OpenIO - */ -extern SDL_DECLSPEC bool SDLCALL SDL_CloseIO(SDL_IOStream *context); - -/** - * Get the properties associated with an SDL_IOStream. - * - * \param context a pointer to an SDL_IOStream structure. - * \returns a valid property ID on success or 0 on failure; call - * SDL_GetError() for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC SDL_PropertiesID SDLCALL SDL_GetIOProperties(SDL_IOStream *context); - -/** - * Query the stream status of an SDL_IOStream. - * - * This information can be useful to decide if a short read or write was due - * to an error, an EOF, or a non-blocking operation that isn't yet ready to - * complete. - * - * An SDL_IOStream's status is only expected to change after a SDL_ReadIO or - * SDL_WriteIO call; don't expect it to change if you just call this query - * function in a tight loop. - * - * \param context the SDL_IOStream to query. - * \returns an SDL_IOStatus enum with the current state. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC SDL_IOStatus SDLCALL SDL_GetIOStatus(SDL_IOStream *context); - -/** - * Use this function to get the size of the data stream in an SDL_IOStream. - * - * \param context the SDL_IOStream to get the size of the data stream from. - * \returns the size of the data stream in the SDL_IOStream on success or a - * negative error code on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC Sint64 SDLCALL SDL_GetIOSize(SDL_IOStream *context); - -/** - * Seek within an SDL_IOStream data stream. - * - * This function seeks to byte `offset`, relative to `whence`. - * - * `whence` may be any of the following values: - * - * - `SDL_IO_SEEK_SET`: seek from the beginning of data - * - `SDL_IO_SEEK_CUR`: seek relative to current read point - * - `SDL_IO_SEEK_END`: seek relative to the end of data - * - * If this stream can not seek, it will return -1. - * - * \param context a pointer to an SDL_IOStream structure. - * \param offset an offset in bytes, relative to `whence` location; can be - * negative. - * \param whence any of `SDL_IO_SEEK_SET`, `SDL_IO_SEEK_CUR`, - * `SDL_IO_SEEK_END`. - * \returns the final offset in the data stream after the seek or -1 on - * failure; call SDL_GetError() for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_TellIO - */ -extern SDL_DECLSPEC Sint64 SDLCALL SDL_SeekIO(SDL_IOStream *context, Sint64 offset, SDL_IOWhence whence); - -/** - * Determine the current read/write offset in an SDL_IOStream data stream. - * - * SDL_TellIO is actually a wrapper function that calls the SDL_IOStream's - * `seek` method, with an offset of 0 bytes from `SDL_IO_SEEK_CUR`, to - * simplify application development. - * - * \param context an SDL_IOStream data stream object from which to get the - * current offset. - * \returns the current offset in the stream, or -1 if the information can not - * be determined. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_SeekIO - */ -extern SDL_DECLSPEC Sint64 SDLCALL SDL_TellIO(SDL_IOStream *context); - -/** - * Read from a data source. - * - * This function reads up `size` bytes from the data source to the area - * pointed at by `ptr`. This function may read less bytes than requested. - * - * This function will return zero when the data stream is completely read, and - * SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If zero is returned and - * the stream is not at EOF, SDL_GetIOStatus() will return a different error - * value and SDL_GetError() will offer a human-readable message. - * - * \param context a pointer to an SDL_IOStream structure. - * \param ptr a pointer to a buffer to read data into. - * \param size the number of bytes to read from the data source. - * \returns the number of bytes read, or 0 on end of file or other failure; - * call SDL_GetError() for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_WriteIO - * \sa SDL_GetIOStatus - */ -extern SDL_DECLSPEC size_t SDLCALL SDL_ReadIO(SDL_IOStream *context, void *ptr, size_t size); - -/** - * Write to an SDL_IOStream data stream. - * - * This function writes exactly `size` bytes from the area pointed at by `ptr` - * to the stream. If this fails for any reason, it'll return less than `size` - * to demonstrate how far the write progressed. On success, it returns `size`. - * - * On error, this function still attempts to write as much as possible, so it - * might return a positive value less than the requested write size. - * - * The caller can use SDL_GetIOStatus() to determine if the problem is - * recoverable, such as a non-blocking write that can simply be retried later, - * or a fatal error. - * - * \param context a pointer to an SDL_IOStream structure. - * \param ptr a pointer to a buffer containing data to write. - * \param size the number of bytes to write. - * \returns the number of bytes written, which will be less than `size` on - * failure; call SDL_GetError() for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_IOprintf - * \sa SDL_ReadIO - * \sa SDL_SeekIO - * \sa SDL_FlushIO - * \sa SDL_GetIOStatus - */ -extern SDL_DECLSPEC size_t SDLCALL SDL_WriteIO(SDL_IOStream *context, const void *ptr, size_t size); - -/** - * Print to an SDL_IOStream data stream. - * - * This function does formatted printing to the stream. - * - * \param context a pointer to an SDL_IOStream structure. - * \param fmt a printf() style format string. - * \param ... additional parameters matching % tokens in the `fmt` string, if - * any. - * \returns the number of bytes written or 0 on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_IOvprintf - * \sa SDL_WriteIO - */ -extern SDL_DECLSPEC size_t SDLCALL SDL_IOprintf(SDL_IOStream *context, SDL_PRINTF_FORMAT_STRING const char *fmt, ...) SDL_PRINTF_VARARG_FUNC(2); - -/** - * Print to an SDL_IOStream data stream. - * - * This function does formatted printing to the stream. - * - * \param context a pointer to an SDL_IOStream structure. - * \param fmt a printf() style format string. - * \param ap a variable argument list. - * \returns the number of bytes written or 0 on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_IOprintf - * \sa SDL_WriteIO - */ -extern SDL_DECLSPEC size_t SDLCALL SDL_IOvprintf(SDL_IOStream *context, SDL_PRINTF_FORMAT_STRING const char *fmt, va_list ap) SDL_PRINTF_VARARG_FUNCV(2); - -/** - * Flush any buffered data in the stream. - * - * This function makes sure that any buffered data is written to the stream. - * Normally this isn't necessary but if the stream is a pipe or socket it - * guarantees that any pending data is sent. - * - * \param context SDL_IOStream structure to flush. - * \returns true on success or false on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_OpenIO - * \sa SDL_WriteIO - */ -extern SDL_DECLSPEC bool SDLCALL SDL_FlushIO(SDL_IOStream *context); - -/** - * Load all the data from an SDL data stream. - * - * The data is allocated with a zero byte at the end (null terminated) for - * convenience. This extra byte is not included in the value reported via - * `datasize`. - * - * The data should be freed with SDL_free(). - * - * \param src the SDL_IOStream to read all available data from. - * \param datasize a pointer filled in with the number of bytes read, may be - * NULL. - * \param closeio if true, calls SDL_CloseIO() on `src` before returning, even - * in the case of an error. - * \returns the data or NULL on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_LoadFile - * \sa SDL_SaveFile_IO - */ -extern SDL_DECLSPEC void * SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasize, bool closeio); - -/** - * Load all the data from a file path. - * - * The data is allocated with a zero byte at the end (null terminated) for - * convenience. This extra byte is not included in the value reported via - * `datasize`. - * - * The data should be freed with SDL_free(). - * - * \param file the path to read all available data from. - * \param datasize if not NULL, will store the number of bytes read. - * \returns the data or NULL on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_LoadFile_IO - * \sa SDL_SaveFile - */ -extern SDL_DECLSPEC void * SDLCALL SDL_LoadFile(const char *file, size_t *datasize); - -/** - * Save all the data into an SDL data stream. - * - * \param src the SDL_IOStream to write all data to. - * \param data the data to be written. If datasize is 0, may be NULL or a - * invalid pointer. - * \param datasize the number of bytes to be written. - * \param closeio if true, calls SDL_CloseIO() on `src` before returning, even - * in the case of an error. - * \returns true on success or false on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_SaveFile - * \sa SDL_LoadFile_IO - */ -extern SDL_DECLSPEC bool SDLCALL SDL_SaveFile_IO(SDL_IOStream *src, const void *data, size_t datasize, bool closeio); - -/** - * Save all the data into a file path. - * - * \param file the path to write all available data into. - * \param data the data to be written. If datasize is 0, may be NULL or a - * invalid pointer. - * \param datasize the number of bytes to be written. - * \returns true on success or false on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - * - * \sa SDL_SaveFile_IO - * \sa SDL_LoadFile - */ -extern SDL_DECLSPEC bool SDLCALL SDL_SaveFile(const char *file, const void *data, size_t datasize); - -/** - * \name Read endian functions - * - * Read an item of the specified endianness and return in native format. - */ -/* @{ */ - -/** - * Use this function to read a byte from an SDL_IOStream. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the SDL_IOStream to read from. - * \param value a pointer filled in with the data read. - * \returns true on success or false on failure or EOF; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadU8(SDL_IOStream *src, Uint8 *value); - -/** - * Use this function to read a signed byte from an SDL_IOStream. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the SDL_IOStream to read from. - * \param value a pointer filled in with the data read. - * \returns true on success or false on failure; call SDL_GetError() for more - * information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadS8(SDL_IOStream *src, Sint8 *value); - -/** - * Use this function to read 16 bits of little-endian data from an - * SDL_IOStream and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16LE(SDL_IOStream *src, Uint16 *value); - -/** - * Use this function to read 16 bits of little-endian data from an - * SDL_IOStream and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16LE(SDL_IOStream *src, Sint16 *value); - -/** - * Use this function to read 16 bits of big-endian data from an SDL_IOStream - * and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadU16BE(SDL_IOStream *src, Uint16 *value); - -/** - * Use this function to read 16 bits of big-endian data from an SDL_IOStream - * and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadS16BE(SDL_IOStream *src, Sint16 *value); - -/** - * Use this function to read 32 bits of little-endian data from an - * SDL_IOStream and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32LE(SDL_IOStream *src, Uint32 *value); - -/** - * Use this function to read 32 bits of little-endian data from an - * SDL_IOStream and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32LE(SDL_IOStream *src, Sint32 *value); - -/** - * Use this function to read 32 bits of big-endian data from an SDL_IOStream - * and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadU32BE(SDL_IOStream *src, Uint32 *value); - -/** - * Use this function to read 32 bits of big-endian data from an SDL_IOStream - * and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadS32BE(SDL_IOStream *src, Sint32 *value); - -/** - * Use this function to read 64 bits of little-endian data from an - * SDL_IOStream and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64LE(SDL_IOStream *src, Uint64 *value); - -/** - * Use this function to read 64 bits of little-endian data from an - * SDL_IOStream and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64LE(SDL_IOStream *src, Sint64 *value); - -/** - * Use this function to read 64 bits of big-endian data from an SDL_IOStream - * and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadU64BE(SDL_IOStream *src, Uint64 *value); - -/** - * Use this function to read 64 bits of big-endian data from an SDL_IOStream - * and return in native format. - * - * SDL byteswaps the data only if necessary, so the data returned will be in - * the native byte order. - * - * This function will return false when the data stream is completely read, - * and SDL_GetIOStatus() will return SDL_IO_STATUS_EOF. If false is returned - * and the stream is not at EOF, SDL_GetIOStatus() will return a different - * error value and SDL_GetError() will offer a human-readable message. - * - * \param src the stream from which to read data. - * \param value a pointer filled in with the data read. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_ReadS64BE(SDL_IOStream *src, Sint64 *value); -/* @} *//* Read endian functions */ - -/** - * \name Write endian functions - * - * Write an item of native format to the specified endianness. - */ -/* @{ */ - -/** - * Use this function to write a byte to an SDL_IOStream. - * - * \param dst the SDL_IOStream to write to. - * \param value the byte value to write. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteU8(SDL_IOStream *dst, Uint8 value); - -/** - * Use this function to write a signed byte to an SDL_IOStream. - * - * \param dst the SDL_IOStream to write to. - * \param value the byte value to write. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteS8(SDL_IOStream *dst, Sint8 value); - -/** - * Use this function to write 16 bits in native format to an SDL_IOStream as - * little-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in little-endian - * format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16LE(SDL_IOStream *dst, Uint16 value); - -/** - * Use this function to write 16 bits in native format to an SDL_IOStream as - * little-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in little-endian - * format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16LE(SDL_IOStream *dst, Sint16 value); - -/** - * Use this function to write 16 bits in native format to an SDL_IOStream as - * big-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in big-endian format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteU16BE(SDL_IOStream *dst, Uint16 value); - -/** - * Use this function to write 16 bits in native format to an SDL_IOStream as - * big-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in big-endian format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteS16BE(SDL_IOStream *dst, Sint16 value); - -/** - * Use this function to write 32 bits in native format to an SDL_IOStream as - * little-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in little-endian - * format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32LE(SDL_IOStream *dst, Uint32 value); - -/** - * Use this function to write 32 bits in native format to an SDL_IOStream as - * little-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in little-endian - * format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32LE(SDL_IOStream *dst, Sint32 value); - -/** - * Use this function to write 32 bits in native format to an SDL_IOStream as - * big-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in big-endian format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteU32BE(SDL_IOStream *dst, Uint32 value); - -/** - * Use this function to write 32 bits in native format to an SDL_IOStream as - * big-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in big-endian format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteS32BE(SDL_IOStream *dst, Sint32 value); - -/** - * Use this function to write 64 bits in native format to an SDL_IOStream as - * little-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in little-endian - * format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64LE(SDL_IOStream *dst, Uint64 value); - -/** - * Use this function to write 64 bits in native format to an SDL_IOStream as - * little-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in little-endian - * format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64LE(SDL_IOStream *dst, Sint64 value); - -/** - * Use this function to write 64 bits in native format to an SDL_IOStream as - * big-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in big-endian format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteU64BE(SDL_IOStream *dst, Uint64 value); - -/** - * Use this function to write 64 bits in native format to an SDL_IOStream as - * big-endian data. - * - * SDL byteswaps the data only if necessary, so the application always - * specifies native format, and the data written will be in big-endian format. - * - * \param dst the stream to which data will be written. - * \param value the data to be written, in native format. - * \returns true on successful write or false on failure; call SDL_GetError() - * for more information. - * - * \threadsafety This function is not thread safe. - * - * \since This function is available since SDL 3.2.0. - */ -extern SDL_DECLSPEC bool SDLCALL SDL_WriteS64BE(SDL_IOStream *dst, Sint64 value); - -/* @} *//* Write endian functions */ - -/* Ends C function definitions when using C++ */ -#ifdef __cplusplus -} -#endif -#include - -#endif /* SDL_iostream_h_ */ -- cgit v1.2.3