begin_code.h 4.6 KB

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