Config.hpp
1 //
3 // SFML - Simple and Fast Multimedia Library
4 // Copyright (C) 2007-2016 Laurent Gomila (laurent@sfml-dev.org)
5 //
6 // This software is provided 'as-is', without any express or implied warranty.
7 // In no event will the authors be held liable for any damages 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 freely,
11 // subject to the following restrictions:
12 //
13 // 1. The origin of this software must not be misrepresented;
14 // you must not claim that you wrote the original software.
15 // If you use this software in a product, an acknowledgment
16 // in the product documentation would be appreciated but is not required.
17 //
18 // 2. Altered source versions must be plainly marked as such,
19 // and must not be misrepresented as being the original software.
20 //
21 // 3. This notice may not be removed or altered from any source distribution.
22 //
24 
25 #ifndef SFML_CONFIG_HPP
26 #define SFML_CONFIG_HPP
27 
28 
30 // Define the SFML version
32 #define SFML_VERSION_MAJOR 2
33 #define SFML_VERSION_MINOR 4
34 #define SFML_VERSION_PATCH 0
35 
36 
38 // Identify the operating system
39 // see http://nadeausoftware.com/articles/2012/01/c_c_tip_how_use_compiler_predefined_macros_detect_operating_system
41 #if defined(_WIN32)
42 
43  // Windows
44  #define SFML_SYSTEM_WINDOWS
45  #ifndef NOMINMAX
46  #define NOMINMAX
47  #endif
48 
49 #elif defined(__APPLE__) && defined(__MACH__)
50 
51  // Apple platform, see which one it is
52  #include "TargetConditionals.h"
53 
54  #if TARGET_OS_IPHONE || TARGET_IPHONE_SIMULATOR
55 
56  // iOS
57  #define SFML_SYSTEM_IOS
58 
59  #elif TARGET_OS_MAC
60 
61  // MacOS
62  #define SFML_SYSTEM_MACOS
63 
64  #else
65 
66  // Unsupported Apple system
67  #error This Apple operating system is not supported by SFML library
68 
69  #endif
70 
71 #elif defined(__unix__)
72 
73  // UNIX system, see which one it is
74  #if defined(__ANDROID__)
75 
76  // Android
77  #define SFML_SYSTEM_ANDROID
78 
79  #elif defined(__linux__)
80 
81  // Linux
82  #define SFML_SYSTEM_LINUX
83 
84  #elif defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
85 
86  // FreeBSD
87  #define SFML_SYSTEM_FREEBSD
88 
89  #elif defined(__GNU__)
90 
91  // GNU Hurd - pretend to be linux (with one exception)
92  #define SFML_SYSTEM_LINUX
93  #define SFML_SYSTEM_HURD
94 
95  #else
96 
97  // Unsupported UNIX system
98  #error This UNIX operating system is not supported by SFML library
99 
100  #endif
101 
102 #else
103 
104  // Unsupported system
105  #error This operating system is not supported by SFML library
106 
107 #endif
108 
109 
111 // Define a portable debug macro
113 #if !defined(NDEBUG)
114 
115  #define SFML_DEBUG
116 
117 #endif
118 
119 
121 // Define helpers to create portable import / export macros for each module
123 #if !defined(SFML_STATIC)
124 
125  #if defined(SFML_SYSTEM_WINDOWS)
126 
127  // Windows compilers need specific (and different) keywords for export and import
128  #define SFML_API_EXPORT __declspec(dllexport)
129  #define SFML_API_IMPORT __declspec(dllimport)
130 
131  // For Visual C++ compilers, we also need to turn off this annoying C4251 warning
132  #ifdef _MSC_VER
133 
134  #pragma warning(disable: 4251)
135 
136  #endif
137 
138  #else // Linux, FreeBSD, Mac OS X
139 
140  #if __GNUC__ >= 4
141 
142  // GCC 4 has special keywords for showing/hidding symbols,
143  // the same keyword is used for both importing and exporting
144  #define SFML_API_EXPORT __attribute__ ((__visibility__ ("default")))
145  #define SFML_API_IMPORT __attribute__ ((__visibility__ ("default")))
146 
147  #else
148 
149  // GCC < 4 has no mechanism to explicitely hide symbols, everything's exported
150  #define SFML_API_EXPORT
151  #define SFML_API_IMPORT
152 
153  #endif
154 
155  #endif
156 
157 #else
158 
159  // Static build doesn't need import/export macros
160  #define SFML_API_EXPORT
161  #define SFML_API_IMPORT
162 
163 #endif
164 
165 
167 // Cross-platform warning for deprecated functions and classes
168 //
169 // Usage:
170 // class SFML_DEPRECATED MyClass
171 // {
172 // SFML_DEPRECATED void memberFunc();
173 // };
174 //
175 // SFML_DEPRECATED void globalFunc();
177 #if defined(SFML_NO_DEPRECATED_WARNINGS)
178 
179  // User explicitly requests to disable deprecation warnings
180  #define SFML_DEPRECATED
181 
182 #elif defined(_MSC_VER)
183 
184  // Microsoft C++ compiler
185  // Note: On newer MSVC versions, using deprecated functions causes a compiler error. In order to
186  // trigger a warning instead of an error, the compiler flag /sdl- (instead of /sdl) must be specified.
187  #define SFML_DEPRECATED __declspec(deprecated)
188 
189 #elif defined(__GNUC__)
190 
191  // g++ and Clang
192  #define SFML_DEPRECATED __attribute__ ((deprecated))
193 
194 #else
195 
196  // Other compilers are not supported, leave class or function as-is.
197  // With a bit of luck, the #pragma directive works, otherwise users get a warning (no error!) for unrecognized #pragma.
198  #pragma message("SFML_DEPRECATED is not supported for your compiler, please contact the SFML team")
199  #define SFML_DEPRECATED
200 
201 #endif
202 
203 
205 // Define portable fixed-size types
207 namespace sf
208 {
209  // All "common" platforms use the same size for char, short and int
210  // (basically there are 3 types for 3 sizes, so no other match is possible),
211  // we can use them without doing any kind of check
212 
213  // 8 bits integer types
214  typedef signed char Int8;
215  typedef unsigned char Uint8;
216 
217  // 16 bits integer types
218  typedef signed short Int16;
219  typedef unsigned short Uint16;
220 
221  // 32 bits integer types
222  typedef signed int Int32;
223  typedef unsigned int Uint32;
224 
225  // 64 bits integer types
226  #if defined(_MSC_VER)
227  typedef signed __int64 Int64;
228  typedef unsigned __int64 Uint64;
229  #else
230  typedef signed long long Int64;
231  typedef unsigned long long Uint64;
232  #endif
233 
234 } // namespace sf
235 
236 
237 #endif // SFML_CONFIG_HPP