mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-29 22:48:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Introduce formal policy for APIs that return strings.

Browse Source 
This declares that any `const char *` returned from SDL is owned by SDL, and
promises to be valid _at least_ until the next time the event queue runs, or
SDL_Quit() is called, even if the thing that owns the string gets destroyed
or changed before then.

This is noted in the headers as "the SDL_GetStringRule", so this will both be
greppable to find a detailed explaination in docs/README-strings.md and
wikiheaders will automatically turn it into a link we can point at the
appropriate documentation.

Fixes #9902.

(and several FIXMEs, both known and yet-undocumented.)
This commit is contained in:
Ryan C. Gordon
2024-06-01 22:05:21 -04:00
parent b1f3682216
commit e23257307e
51 changed files with 262 additions and 123 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
src/SDL.c
View File

@@ -573,10 +573,11 @@ int SDL_GetVersion(void)
/* Get the library source revision */
const char *SDL_GetRevision(void)
{
return SDL_REVISION;
return SDL_REVISION; // a string literal, no need to SDL_FreeLater it.
}
/* Get the name of the platform */
// Get the name of the platform
// (a string literal, no need to SDL_FreeLater it.)
const char *SDL_GetPlatform(void)
{
#if defined(SDL_PLATFORM_AIX)