gitea/SDL3_fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added infrastructure for renaming API functions

Browse Source 
You can rename APIs using rename.py and all the code and documentation will be updated, and entries will be added to WhatsNew.txt and docs/README-migration.md.
e.g.
rename.py SDL_foo.h function SDL_CreateFoo SDL_FooCreate

SDL_oldnames.h is included in the SDL header, and if you define SDL_ENABLE_OLD_NAMES, will redefine the old API functions to call the new ones, and if not, will define them as a symbol letting you what the new API function is.
This commit is contained in:
Sam Lantinga
2022-12-22 16:45:43 -08:00
parent 08c45eb37e
commit b5a92406eb
3 changed files with 279 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
include/SDL3/SDL.h
View File

@@ -46,6 +46,7 @@
#include <SDL3/SDL_haptic.h>
#include <SDL3/SDL_hidapi.h>
#include <SDL3/SDL_hints.h>
#include <SDL3/SDL_init.h>
#include <SDL3/SDL_joystick.h>
#include <SDL3/SDL_keyboard.h>
#include <SDL3/SDL_keycode.h>
@@ -75,7 +76,7 @@
#include <SDL3/SDL_touch.h>
#include <SDL3/SDL_version.h>
#include <SDL3/SDL_video.h>
#include <SDL3/SDL_init.h>
#include <SDL3/SDL_oldnames.h>
#endif /* SDL_h_ */

43
include/SDL3/SDL_oldnames.h Normal file
View File

@@ -0,0 +1,43 @@
/*
Simple DirectMedia Layer
Copyright (C) 1997-2022 Sam Lantinga <slouken@libsdl.org>
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.
*/
/**
* \file SDL_oldnames.h
*
* Definitions to ease transition from SDL2 code
*/
#ifndef SDL_oldnames_h_
#define SDL_oldnames_h_
/* The new function names are recommended, but if you want to have the
* old names available while you are in the process of migrating code
* to SDL3, you can define `SDL_ENABLE_OLD_NAMES` in your project.
*/
#ifdef SDL_ENABLE_OLD_NAMES
#else /* !SDL_ENABLE_OLD_NAMES */
#endif /* SDL_ENABLE_OLD_NAMES */
#endif /* SDL_oldnames_h_ */
/* vi: set ts=4 sw=4 expandtab: */