include/begin_code.h
author Ryan C. Gordon <icculus@icculus.org>
Tue, 20 Aug 2013 14:21:35 -0400
changeset 7665 4c0a6cfe27a0
parent 7657 7a8955fe2f63
child 7771 4434498bf4b9
permissions -rw-r--r--
Added SDL_DEPRECATED #define.
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2013 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 /**
    23  *  \file begin_code.h
    24  *
    25  *  This file sets things up for C dynamic library function definitions,
    26  *  static inlined functions, and structures aligned at 4-byte alignment.
    27  *  If you don't like ugly C preprocessor code, don't look at this file. :)
    28  */
    29 
    30 /* This shouldn't be nested -- included it around code only. */
    31 #ifdef _begin_code_h
    32 #error Nested inclusion of begin_code.h
    33 #endif
    34 #define _begin_code_h
    35 
    36 #ifndef SDL_DEPRECATED
    37 #  if (__GNUC__ >= 4)  /* technically, this arrived in gcc 3.1, but oh well. */
    38 #    define SDL_DEPRECATED __attribute__((deprecated))
    39 #  else
    40 #    define SDL_DEPRECATED
    41 #  endif
    42 #endif
    43 
    44 /* Some compilers use a special export keyword */
    45 #ifndef DECLSPEC
    46 # if defined(__WIN32__)
    47 #  ifdef __BORLANDC__
    48 #   ifdef BUILD_SDL
    49 #    define DECLSPEC
    50 #   else
    51 #    define DECLSPEC    __declspec(dllimport)
    52 #   endif
    53 #  else
    54 #   define DECLSPEC __declspec(dllexport)
    55 #  endif
    56 # else
    57 #  if defined(__GNUC__) && __GNUC__ >= 4
    58 #   define DECLSPEC __attribute__ ((visibility("default")))
    59 #  elif defined(__GNUC__) && __GNUC__ >= 2
    60 #   define DECLSPEC __declspec(dllexport)
    61 #  else
    62 #   define DECLSPEC
    63 #  endif
    64 # endif
    65 #endif
    66 
    67 /* By default SDL uses the C calling convention */
    68 #ifndef SDLCALL
    69 #if defined(__WIN32__) && !defined(__GNUC__)
    70 #define SDLCALL __cdecl
    71 #else
    72 #define SDLCALL
    73 #endif
    74 #endif /* SDLCALL */
    75 
    76 /* Removed DECLSPEC on Symbian OS because SDL cannot be a DLL in EPOC */
    77 #ifdef __SYMBIAN32__
    78 #undef DECLSPEC
    79 #define DECLSPEC
    80 #endif /* __SYMBIAN32__ */
    81 
    82 /* Force structure packing at 4 byte alignment.
    83    This is necessary if the header is included in code which has structure
    84    packing set to an alternate value, say for loading structures from disk.
    85    The packing is reset to the previous value in close_code.h
    86  */
    87 #if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
    88 #ifdef _MSC_VER
    89 #pragma warning(disable: 4103)
    90 #endif
    91 #ifdef __BORLANDC__
    92 #pragma nopackwarning
    93 #endif
    94 #ifdef _M_X64
    95 /* Use 8-byte alignment on 64-bit architectures, so pointers are aligned */
    96 #pragma pack(push,8)
    97 #else
    98 #pragma pack(push,4)
    99 #endif
   100 #endif /* Compiler needs structure packing set */
   101 
   102 /* Set up compiler-specific options for inlining functions */
   103 #ifndef SDL_INLINE_OKAY
   104 #ifdef __GNUC__
   105 #define SDL_INLINE_OKAY
   106 #else
   107 /* Add any special compiler-specific cases here */
   108 #if defined(_MSC_VER) || defined(__BORLANDC__) || \
   109     defined(__DMC__) || defined(__SC__) || \
   110     defined(__WATCOMC__) || defined(__LCC__) || \
   111     defined(__DECC)
   112 #ifndef __inline__
   113 #define __inline__  __inline
   114 #endif
   115 #define SDL_INLINE_OKAY
   116 #else
   117 #if !defined(__MRC__) && !defined(_SGI_SOURCE)
   118 #ifndef __inline__
   119 #define __inline__ inline
   120 #endif
   121 #define SDL_INLINE_OKAY
   122 #endif /* Not a funky compiler */
   123 #endif /* Visual C++ */
   124 #endif /* GNU C */
   125 #endif /* SDL_INLINE_OKAY */
   126 
   127 /* If inlining isn't supported, remove "__inline__", turning static
   128    inlined functions into static functions (resulting in code bloat
   129    in all files which include the offending header files)
   130 */
   131 #ifndef SDL_INLINE_OKAY
   132 #define __inline__
   133 #endif
   134 
   135 #ifndef SDL_FORCE_INLINE
   136 #if defined(_MSC_VER)
   137 #define SDL_FORCE_INLINE __forceinline
   138 #elif ( (defined(__GNUC__) && (__GNUC__ >= 4)) || defined(__clang__) )
   139 #define SDL_FORCE_INLINE __attribute__((always_inline)) static inline
   140 #else
   141 #define SDL_FORCE_INLINE static __inline__
   142 #endif
   143 #endif
   144 
   145 /* Apparently this is needed by several Windows compilers */
   146 #if !defined(__MACH__)
   147 #ifndef NULL
   148 #ifdef __cplusplus
   149 #define NULL 0
   150 #else
   151 #define NULL ((void *)0)
   152 #endif
   153 #endif /* NULL */
   154 #endif /* ! Mac OS X - breaks precompiled headers */