include/begin_code.h
author Ryan C. Gordon <icculus@icculus.org>
Mon, 08 Sep 2014 01:36:22 -0400
changeset 9126 08f3b56969b1
parent 8879 f6e4f24df1ac
child 9619 b94b6d0bff0f
permissions -rw-r--r--
Deal with various .bmp file format variants in SDL_LoadBMP_RW().

This helps when modern versions of The Gimp (and lots of other things)
produces a 32-bit bitmap with an alpha channel, or anything with "BI_BITFIELDS"
format, since that data is now embedded in the bitmap info header instead of
directly following it and we would accidentally skip over embedded versions of
it.

Fixes Bugzilla #2714.
     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 /**
    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 #  elif defined(__GNUC__) && __GNUC__ >= 2
    68 #   define DECLSPEC __declspec(dllexport)
    69 #  else
    70 #   define DECLSPEC
    71 #  endif
    72 # endif
    73 #endif
    74 
    75 /* By default SDL uses the C calling convention */
    76 #ifndef SDLCALL
    77 #if (defined(__WIN32__) || defined(__WINRT__)) && !defined(__GNUC__)
    78 #define SDLCALL __cdecl
    79 #else
    80 #define SDLCALL
    81 #endif
    82 #endif /* SDLCALL */
    83 
    84 /* Removed DECLSPEC on Symbian OS because SDL cannot be a DLL in EPOC */
    85 #ifdef __SYMBIAN32__
    86 #undef DECLSPEC
    87 #define DECLSPEC
    88 #endif /* __SYMBIAN32__ */
    89 
    90 /* Force structure packing at 4 byte alignment.
    91    This is necessary if the header is included in code which has structure
    92    packing set to an alternate value, say for loading structures from disk.
    93    The packing is reset to the previous value in close_code.h
    94  */
    95 #if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
    96 #ifdef _MSC_VER
    97 #pragma warning(disable: 4103)
    98 #endif
    99 #ifdef __BORLANDC__
   100 #pragma nopackwarning
   101 #endif
   102 #ifdef _M_X64
   103 /* Use 8-byte alignment on 64-bit architectures, so pointers are aligned */
   104 #pragma pack(push,8)
   105 #else
   106 #pragma pack(push,4)
   107 #endif
   108 #endif /* Compiler needs structure packing set */
   109 
   110 #ifndef SDL_INLINE
   111 #if defined(__GNUC__)
   112 #define SDL_INLINE __inline__
   113 #elif defined(_MSC_VER) || defined(__BORLANDC__) || \
   114       defined(__DMC__) || defined(__SC__) || \
   115       defined(__WATCOMC__) || defined(__LCC__) || \
   116       defined(__DECC)
   117 #define SDL_INLINE __inline
   118 #ifndef __inline__
   119 #define __inline__ __inline
   120 #endif
   121 #else
   122 #define SDL_INLINE inline
   123 #ifndef __inline__
   124 #define __inline__ inline
   125 #endif
   126 #endif
   127 #endif /* SDL_INLINE not defined */
   128 
   129 #ifndef SDL_FORCE_INLINE
   130 #if defined(_MSC_VER)
   131 #define SDL_FORCE_INLINE __forceinline
   132 #elif ( (defined(__GNUC__) && (__GNUC__ >= 4)) || defined(__clang__) )
   133 #define SDL_FORCE_INLINE __attribute__((always_inline)) static __inline__
   134 #else
   135 #define SDL_FORCE_INLINE static SDL_INLINE
   136 #endif
   137 #endif /* SDL_FORCE_INLINE not defined */
   138 
   139 /* Apparently this is needed by several Windows compilers */
   140 #if !defined(__MACH__)
   141 #ifndef NULL
   142 #ifdef __cplusplus
   143 #define NULL 0
   144 #else
   145 #define NULL ((void *)0)
   146 #endif
   147 #endif /* NULL */
   148 #endif /* ! Mac OS X - breaks precompiled headers */