SDL 3.0
SDL_begin_code.h
Go to the documentation of this file.
1/*
2 Simple DirectMedia Layer
3 Copyright (C) 1997-2023 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 SDL_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 SDL_begin_code_h
32#error Nested inclusion of SDL_begin_code.h
33#endif
34#define SDL_begin_code_h
35
36#ifndef SDL_DEPRECATED
37# if defined(__GNUC__) && (__GNUC__ >= 4) /* technically, this arrived in gcc 3.1, but oh well. */
38# define SDL_DEPRECATED __attribute__((deprecated))
39# elif defined(_MSC_VER)
40# define SDL_DEPRECATED __declspec(deprecated)
41# else
42# define SDL_DEPRECATED
43# endif
44#endif
45
46#ifndef SDL_UNUSED
47# ifdef __GNUC__
48# define SDL_UNUSED __attribute__((unused))
49# else
50# define SDL_UNUSED
51# endif
52#endif
53
54/* Some compilers use a special export keyword */
55#ifndef DECLSPEC
56# if defined(__WIN32__) || defined(__WINRT__) || defined(__CYGWIN__) || defined(__GDK__)
57# ifdef DLL_EXPORT
58# define DECLSPEC __declspec(dllexport)
59# else
60# define DECLSPEC
61# endif
62# else
63# if defined(__GNUC__) && __GNUC__ >= 4
64# define DECLSPEC __attribute__ ((visibility("default")))
65# else
66# define DECLSPEC
67# endif
68# endif
69#endif
70
71/* By default SDL uses the C calling convention */
72#ifndef SDLCALL
73#if (defined(__WIN32__) || defined(__WINRT__) || defined(__GDK__)) && !defined(__GNUC__)
74#define SDLCALL __cdecl
75#else
76#define SDLCALL
77#endif
78#endif /* SDLCALL */
79
80/* Force structure packing at 4 byte alignment.
81 This is necessary if the header is included in code which has structure
82 packing set to an alternate value, say for loading structures from disk.
83 The packing is reset to the previous value in SDL_close_code.h
84 */
85#if defined(_MSC_VER) || defined(__MWERKS__) || defined(__BORLANDC__)
86#ifdef _MSC_VER
87#pragma warning(disable: 4103)
88#endif
89#ifdef __clang__
90#pragma clang diagnostic ignored "-Wpragma-pack"
91#endif
92#ifdef __BORLANDC__
93#pragma nopackwarning
94#endif
95#ifdef _WIN64
96/* Use 8-byte alignment on 64-bit architectures, so pointers are aligned */
97#pragma pack(push,8)
98#else
99#pragma pack(push,4)
100#endif
101#endif /* Compiler needs structure packing set */
102
103#ifndef SDL_INLINE
104#ifdef __GNUC__
105#define SDL_INLINE __inline__
106#elif defined(_MSC_VER) || defined(__BORLANDC__) || \
107 defined(__DMC__) || defined(__SC__) || \
108 defined(__WATCOMC__) || defined(__LCC__) || \
109 defined(__DECC) || defined(__CC_ARM)
110#define SDL_INLINE __inline
111#ifndef __inline__
112#define __inline__ __inline
113#endif
114#else
115#define SDL_INLINE inline
116#ifndef __inline__
117#define __inline__ inline
118#endif
119#endif
120#endif /* SDL_INLINE not defined */
121
122#ifndef SDL_FORCE_INLINE
123#ifdef _MSC_VER
124#define SDL_FORCE_INLINE __forceinline
125#elif ( (defined(__GNUC__) && (__GNUC__ >= 4)) || defined(__clang__) )
126#define SDL_FORCE_INLINE __attribute__((always_inline)) static __inline__
127#else
128#define SDL_FORCE_INLINE static SDL_INLINE
129#endif
130#endif /* SDL_FORCE_INLINE not defined */
131
132#ifndef SDL_NORETURN
133#ifdef __GNUC__
134#define SDL_NORETURN __attribute__((noreturn))
135#elif defined(_MSC_VER)
136#define SDL_NORETURN __declspec(noreturn)
137#else
138#define SDL_NORETURN
139#endif
140#endif /* SDL_NORETURN not defined */
141
142/* Apparently this is needed by several Windows compilers */
143#ifndef __MACH__
144#ifndef NULL
145#ifdef __cplusplus
146#define NULL 0
147#else
148#define NULL ((void *)0)
149#endif
150#endif /* NULL */
151#endif /* ! macOS - breaks precompiled headers */
152
153#ifndef SDL_FALLTHROUGH
154#if (defined(__cplusplus) && __cplusplus >= 201703L) || \
155 (defined(__STDC_VERSION__) && __STDC_VERSION__ >= 202000L)
156#define SDL_FALLTHROUGH [[fallthrough]]
157#else
158#ifdef __has_attribute
159#define SDL_HAS_FALLTHROUGH __has_attribute(__fallthrough__)
160#else
161#define SDL_HAS_FALLTHROUGH 0
162#endif /* __has_attribute */
163#if SDL_HAS_FALLTHROUGH && \
164 ((defined(__GNUC__) && __GNUC__ >= 7) || \
165 (defined(__clang_major__) && __clang_major__ >= 10))
166#define SDL_FALLTHROUGH __attribute__((__fallthrough__))
167#else
168#define SDL_FALLTHROUGH do {} while (0) /* fallthrough */
169#endif /* SDL_HAS_FALLTHROUGH */
170#undef SDL_HAS_FALLTHROUGH
171#endif /* C++17 or C2x */
172#endif /* SDL_FALLTHROUGH not defined */
173
174#ifndef SDL_MALLOC
175#if defined(__GNUC__) && (__GNUC__ >= 3)
176#define SDL_MALLOC __attribute__((malloc))
177/** FIXME
178#elif defined(_MSC_VER)
179#define SDL_MALLOC __declspec(allocator) __desclspec(restrict)
180**/
181#else
182#define SDL_MALLOC
183#endif
184#endif /* SDL_MALLOC not defined */
185
186#ifndef SDL_ALLOC_SIZE
187#if (defined(__clang__) && __clang_major__ >= 4) || (defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)))
188#define SDL_ALLOC_SIZE(p) __attribute__((alloc_size(p)))
189#elif defined(_MSC_VER)
190#define SDL_ALLOC_SIZE(p)
191#else
192#define SDL_ALLOC_SIZE(p)
193#endif
194#endif /* SDL_ALLOC_SIZE not defined */
195
196#ifndef SDL_ALLOC_SIZE2
197#if (defined(__clang__) && __clang_major__ >= 4) || (defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 3)))
198#define SDL_ALLOC_SIZE2(p1, p2) __attribute__((alloc_size(p1, p2)))
199#elif defined(_MSC_VER)
200#define SDL_ALLOC_SIZE2(p1, p2)
201#else
202#define SDL_ALLOC_SIZE2(p1, p2)
203#endif
204#endif /* SDL_ALLOC_SIZE2 not defined */