fd04320593a2bd65f3a8b187aba5b77eea1d96bb
[occt.git] / src / Standard / Standard_Macro.hxx
1 // Copyright (c) 1998-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 // Purpose:   This file is intended to be the first file #included to any
16 //            Open CASCADE source. It defines platform-specific pre-processor 
17 //            macros necessary for correct compilation of Open CASCADE code
18
19 #ifndef _Standard_Macro_HeaderFile
20 # define _Standard_Macro_HeaderFile
21
22 #if defined(__cplusplus) && (__cplusplus >= 201100L)
23   // part of C++11 standard
24   #define Standard_OVERRIDE override
25 #elif defined(_MSC_VER) && (_MSC_VER >= 1700)
26   // MSVC extension since VS2012
27   #define Standard_OVERRIDE override
28 #else
29   #define Standard_OVERRIDE
30 #endif
31
32 // Macro for marking variables / functions as possibly unused
33 // so that compiler will not emit redundant "unused" warnings.
34 #if defined(__GNUC__) || defined(__clang__)
35   #define Standard_UNUSED __attribute__((unused))
36 #else
37   #define Standard_UNUSED
38 #endif
39
40 // Macro Standard_DEPRECATED("message") can be used to declare a method deprecated.
41 // If OCCT_NO_DEPRECATED is defined, Standard_DEPRECATED is defined empty.
42 #ifdef OCCT_NO_DEPRECATED
43   #define Standard_DEPRECATED(theMsg)
44 #else
45 #if defined(_MSC_VER)
46   #define Standard_DEPRECATED(theMsg) __declspec(deprecated(theMsg))
47 #elif defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__))
48   #define Standard_DEPRECATED(theMsg) __attribute__((deprecated(theMsg)))
49 #elif defined(__GNUC__) && (__GNUC__ > 3 || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))
50   #define Standard_DEPRECATED(theMsg) __attribute__((deprecated))
51 #else
52   #define Standard_DEPRECATED(theMsg)
53 #endif
54 #endif
55
56 // Disable warnings about deprecated features.
57 // This is useful for sections of code kept for backward compatibility and scheduled for removal.
58
59 #if defined(__ICL) || defined (__INTEL_COMPILER)
60   #define Standard_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:1478))
61   #define Standard_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
62 #elif defined(_MSC_VER)
63   #define Standard_DISABLE_DEPRECATION_WARNINGS __pragma(warning(push)) __pragma(warning(disable:4996))
64   #define Standard_ENABLE_DEPRECATION_WARNINGS  __pragma(warning(pop))
65 #elif (defined(__GNUC__) && __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)) || defined(__clang__)
66   // available since at least gcc 4.2 (maybe earlier), however only gcc 4.6+ supports this pragma inside the function body
67   // CLang also supports this gcc syntax (in addition to "clang diagnostic ignored")
68   #define Standard_DISABLE_DEPRECATION_WARNINGS _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"")
69   #define Standard_ENABLE_DEPRECATION_WARNINGS  _Pragma("GCC diagnostic warning \"-Wdeprecated-declarations\"")
70 #else
71   #define Standard_DISABLE_DEPRECATION_WARNINGS
72   #define Standard_ENABLE_DEPRECATION_WARNINGS
73 #endif
74
75 # ifdef _WIN32
76
77 // We must be careful including windows.h: it is really poisonous stuff!
78 // The most annoying are #defines of many identifiers that you could use in 
79 // normal code without knowing that Windows has its own knowledge of them...
80 // So lets protect ourselves by switching OFF as much as possible of this in advance.
81 // If someone needs more from windows.h, he is encouraged to #undef these symbols
82 // or include windows.h prior to any OCCT stuff.
83 // Note that we define each symbol to itself, so that it still can be used
84 // e.g. as name of variable, method etc.
85 #ifndef WIN32_LEAN_AND_MEAN
86 #define WIN32_LEAN_AND_MEAN   /* exclude extra Windows stuff */
87 #endif
88 #ifndef NOMINMAX
89 #define NOMINMAX NOMINMAX     /* avoid #define min() and max() */
90 #endif
91 #ifndef NOMSG
92 #define NOMSG NOMSG           /* avoid #define SendMessage etc. */
93 #endif
94 #ifndef NODRAWTEXT
95 #define NODRAWTEXT NODRAWTEXT /* avoid #define DrawText etc. */
96 #endif
97 #ifndef NONLS
98 #define NONLS NONLS           /* avoid #define CompareString etc. */
99 #endif
100 #ifndef NOGDI
101 #define NOGDI NOGDI           /* avoid #define SetPrinter (winspool.h) etc. */
102 #endif
103 #ifndef NOSERVICE
104 #define NOSERVICE NOSERVICE   
105 #endif
106 #ifndef NOKERNEL
107 #define NOKERNEL NOKERNEL
108 #endif
109 #ifndef NOUSER
110 #define NOUSER NOUSER
111 #endif
112 #ifndef NOMCX
113 #define NOMCX NOMCX
114 #endif
115 #ifndef NOIME
116 #define NOIME NOIME
117 #endif
118
119 #endif
120
121 # if defined(_WIN32) && !defined(HAVE_NO_DLL)
122
123 //======================================================
124 // Windows-specific definitions
125 //======================================================
126
127 #  ifndef Standard_EXPORT
128 #   define Standard_EXPORT __declspec( dllexport )
129 // For global variables :
130 #   define Standard_EXPORTEXTERN __declspec( dllexport ) extern
131 #   define Standard_EXPORTEXTERNC extern "C" __declspec( dllexport )
132 #  endif  /* Standard_EXPORT */
133
134 #  ifndef Standard_IMPORT
135 #   define Standard_IMPORT __declspec( dllimport ) extern
136 #   define Standard_IMPORTC extern "C" __declspec( dllimport )
137 #  endif  /* Standard_IMPORT */
138
139 # else  /* UNIX */
140
141 //======================================================
142 // UNIX / static library definitions
143 //======================================================
144
145 #  ifndef Standard_EXPORT
146 #   define Standard_EXPORT
147 // For global variables :
148 #   define Standard_EXPORTEXTERN extern
149 #   define Standard_EXPORTEXTERNC extern "C"
150 #  endif  /* Standard_EXPORT */
151
152 #  ifndef Standard_IMPORT
153 #   define Standard_IMPORT extern
154 #   define Standard_IMPORTC extern "C"
155 #  endif  /* Standard_IMPORT */
156
157 // Compatibility with old SUN compilers
158
159 // This preprocessor directive is a kludge to get around
160 // a bug in the Sun Workshop 5.0 compiler, it keeps the
161 // /usr/include/memory.h file from being #included
162 // with an incompatible extern "C" definition of memchr
163 // October 18, 2000  <rboehne@ricardo-us.com>
164 #if __SUNPRO_CC_COMPAT == 5
165 #define _MEMORY_H
166 #endif
167
168 # endif  /* _WIN32 */
169
170 //======================================================
171 // Other
172 //======================================================
173
174 # ifndef __Standard_API
175 #   if !defined(_WIN32) || defined(__Standard_DLL) || defined(__FSD_DLL) || defined(__MMgt_DLL) || defined(__OSD_DLL) || defined(__Plugin_DLL) || defined(__Quantity_DLL) || defined(__Resource_DLL) || defined(__SortTools_DLL) || defined(__StdFail_DLL) || defined(__Storage_DLL) || defined(__TColStd_DLL) || defined(__TCollection_DLL) || defined(__TShort_DLL) || defined(__Units_DLL) || defined(__UnitsAPI_DLL) || defined(__Dico_DLL)
176 #    define __Standard_API Standard_EXPORT
177 #    define __Standard_APIEXTERN Standard_EXPORTEXTERN
178 #   else
179 #    define __Standard_API Standard_IMPORT
180 #    define __Standard_APIEXTERN Standard_IMPORT
181 #   endif  // __Standard_DLL
182 # endif  // __Standard_API
183
184 // Support of Universal Windows Platform
185 #if defined(WINAPI_FAMILY) && WINAPI_FAMILY == WINAPI_FAMILY_APP
186  #define OCCT_UWP
187 #else
188  #ifdef OCCT_UWP
189    #undef OCCT_UWP
190  #endif
191 #endif
192
193 #endif