From 6776b6108a545ba3fa020bffc6a32cabeb963950 Mon Sep 17 00:00:00 2001 From: "Ryan C. Gordon" Date: Thu, 14 Mar 2024 23:14:46 -0400 Subject: [PATCH] iostream: "free*" params should be "closeio". --- include/SDL3/SDL_audio.h | 4 ++-- include/SDL3/SDL_gamepad.h | 4 ++-- include/SDL3/SDL_rwops.h | 12 ++++++------ include/SDL3/SDL_surface.h | 8 ++++---- src/audio/SDL_wave.c | 6 +++--- src/file/SDL_rwops.c | 4 ++-- src/joystick/SDL_gamepad.c | 4 ++-- src/video/SDL_bmp.c | 8 ++++---- 8 files changed, 25 insertions(+), 25 deletions(-) diff --git a/include/SDL3/SDL_audio.h b/include/SDL3/SDL_audio.h index fca0b32052..ba24bef9e8 100644 --- a/include/SDL3/SDL_audio.h +++ b/include/SDL3/SDL_audio.h @@ -1317,7 +1317,7 @@ extern DECLSPEC int SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID devid, * ``` * * \param src The data source for the WAVE data - * \param freesrc If SDL_TRUE, calls SDL_CloseIO() on `src` before returning, + * \param closeio If SDL_TRUE, calls SDL_CloseIO() on `src` before returning, * even in the case of an error * \param spec A pointer to an SDL_AudioSpec that will be set to the WAVE * data's format details on successful return @@ -1344,7 +1344,7 @@ extern DECLSPEC int SDLCALL SDL_SetAudioPostmixCallback(SDL_AudioDeviceID devid, * \sa SDL_free * \sa SDL_LoadWAV */ -extern DECLSPEC int SDLCALL SDL_LoadWAV_IO(SDL_IOStream * src, SDL_bool freesrc, +extern DECLSPEC int SDLCALL SDL_LoadWAV_IO(SDL_IOStream * src, SDL_bool closeio, SDL_AudioSpec * spec, Uint8 ** audio_buf, Uint32 * audio_len); diff --git a/include/SDL3/SDL_gamepad.h b/include/SDL3/SDL_gamepad.h index 2f348acd12..f09b03d41b 100644 --- a/include/SDL3/SDL_gamepad.h +++ b/include/SDL3/SDL_gamepad.h @@ -268,7 +268,7 @@ extern DECLSPEC int SDLCALL SDL_AddGamepadMapping(const char *mapping); * constrained environment. * * \param src the data stream for the mappings to be added - * \param freesrc if SDL_TRUE, calls SDL_CloseIO() on `src` before returning, + * \param closeio if SDL_TRUE, calls SDL_CloseIO() on `src` before returning, * even in the case of an error * \returns the number of mappings added or -1 on error; call SDL_GetError() * for more information. @@ -279,7 +279,7 @@ extern DECLSPEC int SDLCALL SDL_AddGamepadMapping(const char *mapping); * \sa SDL_AddGamepadMappingsFromFile * \sa SDL_GetGamepadMappingForGUID */ -extern DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, SDL_bool freesrc); +extern DECLSPEC int SDLCALL SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, SDL_bool closeio); /** * Load a set of gamepad mappings from a file. diff --git a/include/SDL3/SDL_rwops.h b/include/SDL3/SDL_rwops.h index bfd5b2cc9b..e79d2d8447 100644 --- a/include/SDL3/SDL_rwops.h +++ b/include/SDL3/SDL_rwops.h @@ -290,10 +290,10 @@ extern DECLSPEC SDL_IOStream *SDLCALL SDL_OpenIO(const SDL_IOStreamInterface *if /** * 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 with - * SDL_CloseIO(). This returns 0 on success, or -1 if the stream failed to - * flush to its output (e.g. to disk). + * 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 0 on success, or -1 if the stream failed to flush to its output + * (e.g. to disk). * * Note that if this fails to flush the stream to disk, this function reports * an error, but the SDL_IOStream is still invalid once this function returns. @@ -542,13 +542,13 @@ extern DECLSPEC size_t SDLCALL SDL_IOvprintf(SDL_IOStream *context, SDL_PRINTF_F * * \param src the SDL_IOStream to read all available data from * \param datasize if not NULL, will store the number of bytes read - * \param freesrc if SDL_TRUE, calls SDL_CloseIO() on `src` before returning, + * \param closeio if SDL_TRUE, calls SDL_CloseIO() on `src` before returning, * even in the case of an error * \returns the data, or NULL if there was an error. * * \since This function is available since SDL 3.0.0. */ -extern DECLSPEC void *SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasize, SDL_bool freesrc); +extern DECLSPEC void *SDLCALL SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasize, SDL_bool closeio); /** * Load all the data from a file path. diff --git a/include/SDL3/SDL_surface.h b/include/SDL3/SDL_surface.h index b722036843..84a93dbad5 100644 --- a/include/SDL3/SDL_surface.h +++ b/include/SDL3/SDL_surface.h @@ -328,7 +328,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface *surface); * will result in a memory leak. * * \param src the data stream for the surface - * \param freesrc if SDL_TRUE, calls SDL_CloseIO() on `src` before returning, + * \param closeio if SDL_TRUE, calls SDL_CloseIO() on `src` before returning, * even in the case of an error * \returns a pointer to a new SDL_Surface structure or NULL if there was an * error; call SDL_GetError() for more information. @@ -339,7 +339,7 @@ extern DECLSPEC void SDLCALL SDL_UnlockSurface(SDL_Surface *surface); * \sa SDL_LoadBMP * \sa SDL_SaveBMP_IO */ -extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_IO(SDL_IOStream *src, SDL_bool freesrc); +extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP_IO(SDL_IOStream *src, SDL_bool closeio); /** * Load a BMP image from a file. @@ -370,7 +370,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP(const char *file); * * \param surface the SDL_Surface structure containing the image to be saved * \param dst a data stream to save to - * \param freedst if SDL_TRUE, calls SDL_CloseIO() on `dst` before returning, + * \param closeio if SDL_TRUE, calls SDL_CloseIO() on `dst` before returning, * even in the case of an error * \returns 0 on success or a negative error code on failure; call * SDL_GetError() for more information. @@ -380,7 +380,7 @@ extern DECLSPEC SDL_Surface *SDLCALL SDL_LoadBMP(const char *file); * \sa SDL_LoadBMP_IO * \sa SDL_SaveBMP */ -extern DECLSPEC int SDLCALL SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStream *dst, SDL_bool freedst); +extern DECLSPEC int SDLCALL SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStream *dst, SDL_bool closeio); /** * Save a surface to a file. diff --git a/src/audio/SDL_wave.c b/src/audio/SDL_wave.c index 8fe3e78787..280bd9a9b6 100644 --- a/src/audio/SDL_wave.c +++ b/src/audio/SDL_wave.c @@ -2075,7 +2075,7 @@ static int WaveLoad(SDL_IOStream *src, WaveFile *file, SDL_AudioSpec *spec, Uint return 0; } -int SDL_LoadWAV_IO(SDL_IOStream *src, SDL_bool freesrc, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len) +int SDL_LoadWAV_IO(SDL_IOStream *src, SDL_bool closeio, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len) { int result = -1; WaveFile file; @@ -2110,13 +2110,13 @@ int SDL_LoadWAV_IO(SDL_IOStream *src, SDL_bool freesrc, SDL_AudioSpec *spec, Uin } /* Cleanup */ - if (!freesrc) { + if (!closeio) { SDL_SeekIO(src, file.chunk.position, SDL_IO_SEEK_SET); } WaveFreeChunkData(&file.chunk); SDL_free(file.decoderdata); done: - if (freesrc && src) { + if (closeio && src) { SDL_CloseIO(src); } return result; diff --git a/src/file/SDL_rwops.c b/src/file/SDL_rwops.c index a3cfec774b..5ebebf1735 100644 --- a/src/file/SDL_rwops.c +++ b/src/file/SDL_rwops.c @@ -763,7 +763,7 @@ int SDL_CloseIO(SDL_IOStream *iostr) } /* Load all the data from an SDL data stream */ -void *SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasize, SDL_bool freesrc) +void *SDL_LoadFile_IO(SDL_IOStream *src, size_t *datasize, SDL_bool closeio) { const int FILE_CHUNK_SIZE = 1024; Sint64 size, size_total = 0; @@ -824,7 +824,7 @@ done: if (datasize) { *datasize = (size_t)size_total; } - if (freesrc && src) { + if (closeio && src) { SDL_CloseIO(src); } return data; diff --git a/src/joystick/SDL_gamepad.c b/src/joystick/SDL_gamepad.c index c2b6315fce..13d2a4d229 100644 --- a/src/joystick/SDL_gamepad.c +++ b/src/joystick/SDL_gamepad.c @@ -1789,7 +1789,7 @@ static GamepadMapping_t *SDL_PrivateGetGamepadMapping(SDL_JoystickID instance_id /* * Add or update an entry into the Mappings Database */ -int SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, SDL_bool freesrc) +int SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, SDL_bool closeio) { const char *platform = SDL_GetPlatform(); int gamepads = 0; @@ -1797,7 +1797,7 @@ int SDL_AddGamepadMappingsFromIO(SDL_IOStream *src, SDL_bool freesrc) size_t db_size; size_t platform_len; - buf = (char *)SDL_LoadFile_IO(src, &db_size, freesrc); + buf = (char *)SDL_LoadFile_IO(src, &db_size, closeio); if (!buf) { return SDL_SetError("Could not allocate space to read DB into memory"); } diff --git a/src/video/SDL_bmp.c b/src/video/SDL_bmp.c index 41cd3dbab5..8a1d39d3bb 100644 --- a/src/video/SDL_bmp.c +++ b/src/video/SDL_bmp.c @@ -193,7 +193,7 @@ static void CorrectAlphaChannel(SDL_Surface *surface) } } -SDL_Surface *SDL_LoadBMP_IO(SDL_IOStream *src, SDL_bool freesrc) +SDL_Surface *SDL_LoadBMP_IO(SDL_IOStream *src, SDL_bool closeio) { SDL_bool was_error = SDL_TRUE; Sint64 fp_offset = 0; @@ -577,7 +577,7 @@ done: SDL_DestroySurface(surface); surface = NULL; } - if (freesrc && src) { + if (closeio && src) { SDL_CloseIO(src); } return surface; @@ -588,7 +588,7 @@ SDL_Surface *SDL_LoadBMP(const char *file) return SDL_LoadBMP_IO(SDL_IOFromFile(file, "rb"), 1); } -int SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStream *dst, SDL_bool freedst) +int SDL_SaveBMP_IO(SDL_Surface *surface, SDL_IOStream *dst, SDL_bool closeio) { SDL_bool was_error = SDL_TRUE; Sint64 fp_offset, new_offset; @@ -856,7 +856,7 @@ done: if (intermediate_surface && intermediate_surface != surface) { SDL_DestroySurface(intermediate_surface); } - if (freedst && dst) { + if (closeio && dst) { if (SDL_CloseIO(dst) < 0) { was_error = SDL_TRUE; }