src/dynapi/SDL_dynapi.h
author Ryan C. Gordon <icculus@icculus.org>
Wed, 25 Mar 2015 11:18:54 -0400
changeset 9442 6073a89fc0eb
parent 9278 8900afb78a19
child 9619 b94b6d0bff0f
permissions -rw-r--r--
Make the Dynamic API master switch more clear.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2014 Sam Lantinga <slouken@libsdl.org>
     4 
     5   This software is provided 'as-is', without any express or implied
     6   warranty.  In no event will the authors be held liable for any damages
     7   arising from the use of this software.
     8 
     9   Permission is granted to anyone to use this software for any purpose,
    10   including commercial applications, and to alter it and redistribute it
    11   freely, subject to the following restrictions:
    12 
    13   1. The origin of this software must not be misrepresented; you must not
    14      claim that you wrote the original software. If you use this software
    15      in a product, an acknowledgment in the product documentation would be
    16      appreciated but is not required.
    17   2. Altered source versions must be plainly marked as such, and must not be
    18      misrepresented as being the original software.
    19   3. This notice may not be removed or altered from any source distribution.
    20 */
    21 
    22 #ifndef _SDL_dynapi_h
    23 #define _SDL_dynapi_h
    24 
    25 /* IMPORTANT:
    26    This is the master switch to disabling the dynamic API. We made it so you
    27    have to hand-edit an internal source file in SDL to turn it off; you
    28    can do it if you want it badly enough, but hopefully you won't want to.
    29    You should understand the ramifications of turning this off: it makes it
    30    hard to update your SDL in the field, and impossible if you've statically
    31    linked SDL into your app. Understand that platforms change, and if we can't
    32    drop in an updated SDL, your application can definitely break some time
    33    in the future, even if it's fine today.
    34    To be sure, as new system-level video and audio APIs are introduced, an
    35    updated SDL can transparently take advantage of them, but your program will
    36    not without this feature. Think hard before turning it off.
    37 */
    38 #ifdef SDL_DYNAMIC_API  /* Tried to force it on the command line? */
    39 #error Nope, you have to edit this file to force this off.
    40 #endif
    41 
    42 #ifdef __APPLE__
    43 #include "TargetConditionals.h"
    44 #endif
    45 
    46 #if TARGET_OS_IPHONE || __native_client__ || __EMSCRIPTEN__  /* probably not useful on iOS, NACL or Emscripten. */
    47 #define SDL_DYNAMIC_API 0
    48 #elif SDL_BUILDING_WINRT /* probaly not useful on WinRT, given current .dll loading restrictions */
    49 #define SDL_DYNAMIC_API 0
    50 #elif defined(__clang_analyzer__)
    51 #define SDL_DYNAMIC_API 0  /* Turn off for static analysis, so reports are more clear. */
    52 #endif
    53 
    54 /* everyone else. This is where we turn on the API if nothing forced it off. */
    55 #ifndef SDL_DYNAMIC_API
    56 #define SDL_DYNAMIC_API 1
    57 #endif
    58 
    59 #endif
    60 
    61 /* vi: set ts=4 sw=4 expandtab: */