include/begin_code.h
author Sam Lantinga <slouken@libsdl.org>
Fri, 08 Apr 2011 13:03:26 -0700
changeset 5535 96594ac5fd1a
parent 5262 b530ef003506
child 6138 4c64952a58fb
permissions -rw-r--r--
SDL 1.3 is now under the zlib license.
slouken@0
     1
/*
slouken@5535
     2
  Simple DirectMedia Layer
slouken@5535
     3
  Copyright (C) 1997-2011 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
slouken@0
    36
/* Some compilers use a special export keyword */
slouken@0
    37
#ifndef DECLSPEC
slouken@3292
    38
# if defined(__BEOS__) || defined(__HAIKU__)
slouken@0
    39
#  if defined(__GNUC__)
slouken@0
    40
#   define DECLSPEC	__declspec(dllexport)
slouken@0
    41
#  else
slouken@0
    42
#   define DECLSPEC	__declspec(export)
slouken@0
    43
#  endif
slouken@5086
    44
# elif defined(__WIN32__)
slouken@274
    45
#  ifdef __BORLANDC__
slouken@274
    46
#   ifdef BUILD_SDL
slouken@1895
    47
#    define DECLSPEC
slouken@274
    48
#   else
slouken@1574
    49
#    define DECLSPEC	__declspec(dllimport)
slouken@274
    50
#   endif
slouken@274
    51
#  else
slouken@274
    52
#   define DECLSPEC	__declspec(dllexport)
slouken@274
    53
#  endif
icculus@1190
    54
# else
slouken@1595
    55
#  if defined(__GNUC__) && __GNUC__ >= 4
slouken@1574
    56
#   define DECLSPEC	__attribute__ ((visibility("default")))
slouken@1574
    57
#  else
slouken@1574
    58
#   define DECLSPEC
slouken@1574
    59
#  endif
slouken@0
    60
# endif
slouken@0
    61
#endif
slouken@0
    62
slouken@337
    63
/* By default SDL uses the C calling convention */
slouken@337
    64
#ifndef SDLCALL
slouken@5086
    65
#if defined(__WIN32__) && !defined(__GNUC__)
slouken@3620
    66
#define SDLCALL __cdecl
slouken@3620
    67
#else
slouken@3620
    68
#define SDLCALL
slouken@3620
    69
#endif
slouken@337
    70
#endif /* SDLCALL */
slouken@337
    71
slouken@173
    72
/* Removed DECLSPEC on Symbian OS because SDL cannot be a DLL in EPOC */
slouken@1895
    73
#ifdef __SYMBIAN32__
slouken@173
    74
#undef DECLSPEC
slouken@173
    75
#define DECLSPEC
slouken@187
    76
#endif /* __SYMBIAN32__ */
slouken@173
    77
slouken@0
    78
/* Force structure packing at 4 byte alignment.
slouken@0
    79
   This is necessary if the header is included in code which has structure
slouken@0
    80
   packing set to an alternate value, say for loading structures from disk.
slouken@0
    81
   The packing is reset to the previous value in close_code.h
slouken@0
    82
 */
slouken@288
    83
#if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
slouken@0
    84
#ifdef _MSC_VER
slouken@0
    85
#pragma warning(disable: 4103)
slouken@0
    86
#endif
slouken@0
    87
#ifdef __BORLANDC__
slouken@0
    88
#pragma nopackwarning
slouken@0
    89
#endif
slouken@195
    90
#pragma pack(push,4)
slouken@0
    91
#endif /* Compiler needs structure packing set */
slouken@0
    92
slouken@0
    93
/* Set up compiler-specific options for inlining functions */
slouken@0
    94
#ifndef SDL_INLINE_OKAY
slouken@0
    95
#ifdef __GNUC__
slouken@0
    96
#define SDL_INLINE_OKAY
slouken@0
    97
#else
slouken@0
    98
/* Add any special compiler-specific cases here */
slouken@288
    99
#if defined(_MSC_VER) || defined(__BORLANDC__) || \
slouken@288
   100
    defined(__DMC__) || defined(__SC__) || \
slouken@1019
   101
    defined(__WATCOMC__) || defined(__LCC__) || \
slouken@1019
   102
    defined(__DECC)
slouken@288
   103
#ifndef __inline__
slouken@85
   104
#define __inline__	__inline
slouken@288
   105
#endif
slouken@85
   106
#define SDL_INLINE_OKAY
slouken@85
   107
#else
slouken@85
   108
#if !defined(__MRC__) && !defined(_SGI_SOURCE)
icculus@2123
   109
#ifndef __inline__
slouken@0
   110
#define __inline__ inline
icculus@2123
   111
#endif
slouken@0
   112
#define SDL_INLINE_OKAY
slouken@0
   113
#endif /* Not a funky compiler */
slouken@85
   114
#endif /* Visual C++ */
slouken@0
   115
#endif /* GNU C */
slouken@0
   116
#endif /* SDL_INLINE_OKAY */
slouken@0
   117
slouken@0
   118
/* If inlining isn't supported, remove "__inline__", turning static
slouken@0
   119
   inlined functions into static functions (resulting in code bloat
slouken@0
   120
   in all files which include the offending header files)
slouken@0
   121
*/
slouken@0
   122
#ifndef SDL_INLINE_OKAY
slouken@0
   123
#define __inline__
slouken@0
   124
#endif
slouken@0
   125
slouken@288
   126
/* Apparently this is needed by several Windows compilers */
slouken@346
   127
#if !defined(__MACH__)
slouken@288
   128
#ifndef NULL
slouken@288
   129
#ifdef __cplusplus
slouken@288
   130
#define NULL 0
slouken@288
   131
#else
slouken@288
   132
#define NULL ((void *)0)
slouken@288
   133
#endif
slouken@288
   134
#endif /* NULL */
slouken@1621
   135
#endif /* ! Mac OS X - breaks precompiled headers */