include/begin_code.h
author Sam Lantinga <slouken@libsdl.org>
Sat, 02 Jan 2016 10:10:34 -0800
changeset 9998 f67cf37e9cd4
parent 9634 7e843b8b8301
child 10616 d17dd08640a4
permissions -rw-r--r--
Updated copyright to 2016
     1 /*
     2   Simple DirectMedia Layer
     3   Copyright (C) 1997-2016 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 #ifndef SDL_UNUSED
    45 #  ifdef __GNUC__
    46 #    define SDL_UNUSED __attribute__((unused))
    47 #  else
    48 #    define SDL_UNUSED
    49 #  endif
    50 #endif
    51 
    52 /* Some compilers use a special export keyword */
    53 #ifndef DECLSPEC
    54 # if defined(__WIN32__) || defined(__WINRT__)
    55 #  ifdef __BORLANDC__
    56 #   ifdef BUILD_SDL
    57 #    define DECLSPEC
    58 #   else
    59 #    define DECLSPEC    __declspec(dllimport)
    60 #   endif
    61 #  else
    62 #   define DECLSPEC __declspec(dllexport)
    63 #  endif
    64 # else
    65 #  if defined(__GNUC__) && __GNUC__ >= 4
    66 #   define DECLSPEC __attribute__ ((visibility("default")))
    67 #  else
    68 #   define DECLSPEC
    69 #  endif
    70 # endif
    71 #endif
    72 
    73 /* By default SDL uses the C calling convention */
    74 #ifndef SDLCALL
    75 #if (defined(__WIN32__) || defined(__WINRT__)) && !defined(__GNUC__)
    76 #define SDLCALL __cdecl
    77 #else
    78 #define SDLCALL
    79 #endif
    80 #endif /* SDLCALL */
    81 
    82 /* Removed DECLSPEC on Symbian OS because SDL cannot be a DLL in EPOC */
    83 #ifdef __SYMBIAN32__
    84 #undef DECLSPEC
    85 #define DECLSPEC
    86 #endif /* __SYMBIAN32__ */
    87 
    88 /* Force structure packing at 4 byte alignment.
    89    This is necessary if the header is included in code which has structure
    90    packing set to an alternate value, say for loading structures from disk.
    91    The packing is reset to the previous value in close_code.h
    92  */
    93 #if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
    94 #ifdef _MSC_VER
    95 #pragma warning(disable: 4103)
    96 #endif
    97 #ifdef __BORLANDC__
    98 #pragma nopackwarning
    99 #endif
   100 #ifdef _M_X64
   101 /* Use 8-byte alignment on 64-bit architectures, so pointers are aligned */
   102 #pragma pack(push,8)
   103 #else
   104 #pragma pack(push,4)
   105 #endif
   106 #endif /* Compiler needs structure packing set */
   107 
   108 #ifndef SDL_INLINE
   109 #if defined(__GNUC__)
   110 #define SDL_INLINE __inline__
   111 #elif defined(_MSC_VER) || defined(__BORLANDC__) || \
   112       defined(__DMC__) || defined(__SC__) || \
   113       defined(__WATCOMC__) || defined(__LCC__) || \
   114       defined(__DECC)
   115 #define SDL_INLINE __inline
   116 #ifndef __inline__
   117 #define __inline__ __inline
   118 #endif
   119 #else
   120 #define SDL_INLINE inline
   121 #ifndef __inline__
   122 #define __inline__ inline
   123 #endif
   124 #endif
   125 #endif /* SDL_INLINE not defined */
   126 
   127 #ifndef SDL_FORCE_INLINE
   128 #if defined(_MSC_VER)
   129 #define SDL_FORCE_INLINE __forceinline
   130 #elif ( (defined(__GNUC__) && (__GNUC__ >= 4)) || defined(__clang__) )
   131 #define SDL_FORCE_INLINE __attribute__((always_inline)) static __inline__
   132 #else
   133 #define SDL_FORCE_INLINE static SDL_INLINE
   134 #endif
   135 #endif /* SDL_FORCE_INLINE not defined */
   136 
   137 /* Apparently this is needed by several Windows compilers */
   138 #if !defined(__MACH__)
   139 #ifndef NULL
   140 #ifdef __cplusplus
   141 #define NULL 0
   142 #else
   143 #define NULL ((void *)0)
   144 #endif
   145 #endif /* NULL */
   146 #endif /* ! Mac OS X - breaks precompiled headers */