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