9a47dd9085f0ae4dcac515c6f14820fa74112998
[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 // Standard OCC macros: Handle(), STANDARD_TYPE()
23 # define   Handle(ClassName)      Handle_##ClassName
24 # define   STANDARD_TYPE(aType)   aType##_Type_()
25
26 #if defined(__cplusplus) && (__cplusplus >= 201100L)
27   // part of C++11 standard
28   #define Standard_OVERRIDE override
29 #elif defined(_MSC_VER) && (_MSC_VER >= 1700)
30   // MSVC extension since VS2005
31   #define Standard_OVERRIDE override
32 #else
33   #define Standard_OVERRIDE
34 #endif
35
36 //======================================================
37 // Windows-specific definitions
38 //======================================================
39
40 // check if WNT macro is not defined but compiler is MSVC
41 #if defined(_MSC_VER) && !defined(WNT)
42 #error "Wrong compiler options has been detected. Add /DWNT option for proper compilation!!!!!"
43 #endif
44
45 # if defined(_WIN32) && !defined(HAVE_NO_DLL)
46
47 #  ifndef Standard_EXPORT
48 #   define Standard_EXPORT __declspec( dllexport )
49 // For global variables :
50 #   define Standard_EXPORTEXTERN __declspec( dllexport ) extern
51 #   define Standard_EXPORTEXTERNC extern "C" __declspec( dllexport )
52 #  endif  /* Standard_EXPORT */
53
54 #  ifndef Standard_IMPORT
55 #   define Standard_IMPORT __declspec( dllimport ) extern
56 #   define Standard_IMPORTC extern "C" __declspec( dllimport )
57 #  endif  /* Standard_IMPORT */
58
59 // We must be careful including windows.h: it is really poisonous stuff!
60 // The most annoying are #defines of many identifiers that you could use in 
61 // normal code without knowing that Windows has its own knowledge of them...
62 // So lets protect ourselves by switching OFF as much as possible of this in advance.
63 // If someone needs more from windows.h, he is encouraged to #undef these symbols
64 // or include windows.h prior to any OCCT stuff.
65 // Note that we define each symbol to itself, so that it still can be used
66 // e.g. as name of variable, method etc.
67 #ifndef WIN32_LEAN_AND_MEAN
68 #define WIN32_LEAN_AND_MEAN   /* exclude extra Windows stuff */
69 #endif
70 #ifndef NOMINMAX
71 #define NOMINMAX NOMINMAX     /* avoid #define min() and max() */
72 #endif
73 #ifndef NOMSG
74 #define NOMSG NOMSG           /* avoid #define SendMessage etc. */
75 #endif
76 #ifndef NODRAWTEXT
77 #define NODRAWTEXT NODRAWTEXT /* avoid #define DrawText etc. */
78 #endif
79 #ifndef NONLS
80 #define NONLS NONLS           /* avoid #define CompareString etc. */
81 #endif
82 #ifndef NOGDI
83 #define NOGDI NOGDI           /* avoid #define SetPrinter (winspool.h) etc. */
84 #endif
85 #ifndef NOSERVICE
86 #define NOSERVICE NOSERVICE   
87 #endif
88 #ifndef NOKERNEL
89 #define NOKERNEL NOKERNEL
90 #endif
91 #ifndef NOUSER
92 #define NOUSER NOUSER
93 #endif
94 #ifndef NOMCX
95 #define NOMCX NOMCX
96 #endif
97 #ifndef NOIME
98 #define NOIME NOIME
99 #endif
100
101 # else  /* WNT */
102
103 //======================================================
104 // UNIX definitions
105 //======================================================
106
107 #  ifndef Standard_EXPORT
108 #   define Standard_EXPORT
109 // For global variables :
110 #   define Standard_EXPORTEXTERN extern
111 #   define Standard_EXPORTEXTERNC extern "C"
112 #  endif  /* Standard_EXPORT */
113
114 #  ifndef Standard_IMPORT
115 #   define Standard_IMPORT extern
116 #   define Standard_IMPORTC extern "C"
117 #  endif  /* Standard_IMPORT */
118
119 // Compatibility with old SUN compilers
120
121 // This preprocessor directive is a kludge to get around
122 // a bug in the Sun Workshop 5.0 compiler, it keeps the
123 // /usr/include/memory.h file from being #included
124 // with an incompatible extern "C" definition of memchr
125 // October 18, 2000  <rboehne@ricardo-us.com>
126 #if __SUNPRO_CC_COMPAT == 5
127 #define _MEMORY_H
128 #endif
129
130 # endif  /* WNT */
131
132 //======================================================
133 // Other
134 //======================================================
135
136 # ifndef __Standard_API
137 //#  ifdef WNT
138 #   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)
139 #    define __Standard_API Standard_EXPORT
140 #    define __Standard_APIEXTERN Standard_EXPORTEXTERN
141 #   else
142 #    define __Standard_API Standard_IMPORT
143 #    define __Standard_APIEXTERN Standard_IMPORT
144 #   endif  // __Standard_DLL
145 //#  else
146 //#   define __Standard_API
147 //#  endif  // WNT
148 # endif  // __Standard_API
149
150 #endif