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.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@6885
     3
  Copyright (C) 1997-2013 Sam Lantinga <slouken@libsdl.org>
slouken@0
     4
slouken@5535
     5
  This software is provided 'as-is', without any express or implied
slouken@5535
     6
  warranty.  In no event will the authors be held liable for any damages
slouken@5535
     7
  arising from the use of this software.
slouken@0
     8
slouken@5535
     9
  Permission is granted to anyone to use this software for any purpose,
slouken@5535
    10
  including commercial applications, and to alter it and redistribute it
slouken@5535
    11
  freely, subject to the following restrictions:
slouken@0
    12
slouken@5535
    13
  1. The origin of this software must not be misrepresented; you must not
slouken@5535
    14
     claim that you wrote the original software. If you use this software
slouken@5535
    15
     in a product, an acknowledgment in the product documentation would be
slouken@5535
    16
     appreciated but is not required.
slouken@5535
    17
  2. Altered source versions must be plainly marked as such, and must not be
slouken@5535
    18
     misrepresented as being the original software.
slouken@5535
    19
  3. This notice may not be removed or altered from any source distribution.
slouken@0
    20
*/
slouken@0
    21
slouken@3407
    22
/**
slouken@3407
    23
 *  \file begin_code.h
slouken@3407
    24
 *
slouken@3407
    25
 *  This file sets things up for C dynamic library function definitions,
slouken@3407
    26
 *  static inlined functions, and structures aligned at 4-byte alignment.
slouken@3407
    27
 *  If you don't like ugly C preprocessor code, don't look at this file. :)
slouken@3407
    28
 */
slouken@0
    29
slouken@0
    30
/* This shouldn't be nested -- included it around code only. */
slouken@0
    31
#ifdef _begin_code_h
slouken@0
    32
#error Nested inclusion of begin_code.h
slouken@0
    33
#endif
slouken@0
    34
#define _begin_code_h
slouken@0
    35
icculus@7665
    36
#ifndef SDL_DEPRECATED
icculus@7665
    37
#  if (__GNUC__ >= 4)  /* technically, this arrived in gcc 3.1, but oh well. */
icculus@7665
    38
#    define SDL_DEPRECATED __attribute__((deprecated))
icculus@7665
    39
#  else
icculus@7665
    40
#    define SDL_DEPRECATED
icculus@7665
    41
#  endif
icculus@7665
    42
#endif
icculus@7665
    43
slouken@0
    44
/* Some compilers use a special export keyword */
slouken@0
    45
#ifndef DECLSPEC
slouken@7657
    46
# if defined(__WIN32__)
slouken@274
    47
#  ifdef __BORLANDC__
slouken@274
    48
#   ifdef BUILD_SDL
slouken@1895
    49
#    define DECLSPEC
slouken@274
    50
#   else
slouken@7191
    51
#    define DECLSPEC    __declspec(dllimport)
slouken@274
    52
#   endif
slouken@274
    53
#  else
slouken@7191
    54
#   define DECLSPEC __declspec(dllexport)
slouken@274
    55
#  endif
icculus@1190
    56
# else
slouken@1595
    57
#  if defined(__GNUC__) && __GNUC__ >= 4
slouken@7191
    58
#   define DECLSPEC __attribute__ ((visibility("default")))
slouken@7657
    59
#  elif defined(__GNUC__) && __GNUC__ >= 2
slouken@7657
    60
#   define DECLSPEC __declspec(dllexport)
slouken@1574
    61
#  else
slouken@1574
    62
#   define DECLSPEC
slouken@1574
    63
#  endif
slouken@0
    64
# endif
slouken@0
    65
#endif
slouken@0
    66
slouken@337
    67
/* By default SDL uses the C calling convention */
slouken@337
    68
#ifndef SDLCALL
slouken@5086
    69
#if defined(__WIN32__) && !defined(__GNUC__)
slouken@3620
    70
#define SDLCALL __cdecl
slouken@3620
    71
#else
slouken@3620
    72
#define SDLCALL
slouken@3620
    73
#endif
slouken@337
    74
#endif /* SDLCALL */
slouken@337
    75
slouken@173
    76
/* Removed DECLSPEC on Symbian OS because SDL cannot be a DLL in EPOC */
slouken@1895
    77
#ifdef __SYMBIAN32__
slouken@173
    78
#undef DECLSPEC
slouken@173
    79
#define DECLSPEC
slouken@187
    80
#endif /* __SYMBIAN32__ */
slouken@173
    81
slouken@0
    82
/* Force structure packing at 4 byte alignment.
slouken@0
    83
   This is necessary if the header is included in code which has structure
slouken@0
    84
   packing set to an alternate value, say for loading structures from disk.
slouken@0
    85
   The packing is reset to the previous value in close_code.h
slouken@0
    86
 */
slouken@288
    87
#if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
slouken@0
    88
#ifdef _MSC_VER
slouken@0
    89
#pragma warning(disable: 4103)
slouken@0
    90
#endif
slouken@0
    91
#ifdef __BORLANDC__
slouken@0
    92
#pragma nopackwarning
slouken@0
    93
#endif
slouken@6204
    94
#ifdef _M_X64
slouken@6204
    95
/* Use 8-byte alignment on 64-bit architectures, so pointers are aligned */
slouken@6204
    96
#pragma pack(push,8)
slouken@6204
    97
#else
slouken@195
    98
#pragma pack(push,4)
slouken@6204
    99
#endif
slouken@0
   100
#endif /* Compiler needs structure packing set */
slouken@0
   101
slouken@0
   102
/* Set up compiler-specific options for inlining functions */
slouken@0
   103
#ifndef SDL_INLINE_OKAY
slouken@0
   104
#ifdef __GNUC__
slouken@0
   105
#define SDL_INLINE_OKAY
slouken@0
   106
#else
slouken@0
   107
/* Add any special compiler-specific cases here */
slouken@288
   108
#if defined(_MSC_VER) || defined(__BORLANDC__) || \
slouken@288
   109
    defined(__DMC__) || defined(__SC__) || \
slouken@1019
   110
    defined(__WATCOMC__) || defined(__LCC__) || \
slouken@1019
   111
    defined(__DECC)
slouken@288
   112
#ifndef __inline__
slouken@7191
   113
#define __inline__  __inline
slouken@288
   114
#endif
slouken@85
   115
#define SDL_INLINE_OKAY
slouken@85
   116
#else
slouken@85
   117
#if !defined(__MRC__) && !defined(_SGI_SOURCE)
icculus@2123
   118
#ifndef __inline__
slouken@0
   119
#define __inline__ inline
icculus@2123
   120
#endif
slouken@0
   121
#define SDL_INLINE_OKAY
slouken@0
   122
#endif /* Not a funky compiler */
slouken@85
   123
#endif /* Visual C++ */
slouken@0
   124
#endif /* GNU C */
slouken@0
   125
#endif /* SDL_INLINE_OKAY */
slouken@0
   126
slouken@0
   127
/* If inlining isn't supported, remove "__inline__", turning static
slouken@0
   128
   inlined functions into static functions (resulting in code bloat
slouken@0
   129
   in all files which include the offending header files)
slouken@0
   130
*/
slouken@0
   131
#ifndef SDL_INLINE_OKAY
slouken@0
   132
#define __inline__
slouken@0
   133
#endif
slouken@0
   134
icculus@7054
   135
#ifndef SDL_FORCE_INLINE
icculus@7002
   136
#if defined(_MSC_VER)
icculus@7002
   137
#define SDL_FORCE_INLINE __forceinline
icculus@7032
   138
#elif ( (defined(__GNUC__) && (__GNUC__ >= 4)) || defined(__clang__) )
icculus@7002
   139
#define SDL_FORCE_INLINE __attribute__((always_inline)) static inline
icculus@7002
   140
#else
icculus@7002
   141
#define SDL_FORCE_INLINE static __inline__
icculus@7002
   142
#endif
icculus@7054
   143
#endif
icculus@7002
   144
slouken@288
   145
/* Apparently this is needed by several Windows compilers */
slouken@346
   146
#if !defined(__MACH__)
slouken@288
   147
#ifndef NULL
slouken@288
   148
#ifdef __cplusplus
slouken@288
   149
#define NULL 0
slouken@288
   150
#else
slouken@288
   151
#define NULL ((void *)0)
slouken@288
   152
#endif
slouken@288
   153
#endif /* NULL */
slouken@1621
   154
#endif /* ! Mac OS X - breaks precompiled headers */