]> git.saurik.com Git - wxWidgets.git/blame - include/wx/dlimpexp.h
wxPropertyGridInterface docs cleanup and fixes, removed some rarely needed member...
[wxWidgets.git] / include / wx / dlimpexp.h
CommitLineData
0cc66b6c
VZ
1/*
2 * Name: wx/dlimpexp.h
3 * Purpose: Macros for declaring DLL-imported/exported functions
4 * Author: Vadim Zeitlin
5 * Modified by:
6 * Created: 16.10.2003 (extracted from wx/defs.h)
7 * RCS-ID: $Id$
77ffb593 8 * Copyright: (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
65571936 9 * Licence: wxWindows licence
0cc66b6c
VZ
10 */
11
12/*
13 This is a C file, not C++ one, do not use C++ comments here!
14 */
15
16#ifndef _WX_DLIMPEXP_H_
17#define _WX_DLIMPEXP_H_
18
b9d4eff6
VS
19#if defined(HAVE_VISIBILITY)
20# define WXEXPORT __attribute__ ((visibility("default")))
21# define WXIMPORT __attribute__ ((visibility("default")))
22#elif defined(__WINDOWS__)
0cc66b6c
VZ
23 /*
24 __declspec works in BC++ 5 and later, Watcom C++ 11.0 and later as well
25 as VC++ and gcc
26 */
27# if defined(__VISUALC__) || defined(__BORLANDC__) || defined(__GNUC__) || defined(__WATCOMC__)
28# define WXEXPORT __declspec(dllexport)
29# define WXIMPORT __declspec(dllimport)
30# else /* compiler doesn't support __declspec() */
31# define WXEXPORT
32# define WXIMPORT
33# endif
34#elif defined(__WXPM__)
35# if defined (__WATCOMC__)
36# define WXEXPORT __declspec(dllexport)
37 /*
38 __declspec(dllimport) prepends __imp to imported symbols. We do NOT
39 want that!
40 */
41# define WXIMPORT
fd928524
DW
42# elif defined(__EMX__)
43# define WXEXPORT
44# define WXIMPORT
0cc66b6c
VZ
45# elif (!(defined(__VISAGECPP__) && (__IBMCPP__ < 400 || __IBMC__ < 400 )))
46# define WXEXPORT _Export
47# define WXIMPORT _Export
48# endif
49#elif defined(__WXMAC__) || defined(__WXCOCOA__)
50# ifdef __MWERKS__
51# define WXEXPORT __declspec(export)
52# define WXIMPORT __declspec(import)
53# endif
7275146d
MW
54#elif defined(__CYGWIN__)
55# define WXEXPORT __declspec(dllexport)
56# define WXIMPORT __declspec(dllimport)
0cc66b6c
VZ
57#endif
58
59/* for other platforms/compilers we don't anything */
60#ifndef WXEXPORT
61# define WXEXPORT
62# define WXIMPORT
63#endif
64
65/*
77ffb593 66 We support building wxWidgets as a set of several libraries but we don't
0cc66b6c
VZ
67 support arbitrary combinations of libs/DLLs: either we build all of them as
68 DLLs (in which case WXMAKINGDLL is defined) or none (it isn't).
69
53a2db12 70 However we have a problem because we need separate WXDLLIMPEXP versions for
0cc66b6c
VZ
71 different libraries as, for example, wxString class should be dllexported
72 when compiled in wxBase and dllimported otherwise, so we do define separate
73 WXMAKING/USINGDLL_XYZ constants for each component XYZ.
74 */
75#ifdef WXMAKINGDLL
76# if wxUSE_BASE
77# define WXMAKINGDLL_BASE
78# endif
79
80# define WXMAKINGDLL_NET
81# define WXMAKINGDLL_CORE
82# define WXMAKINGDLL_ADV
f5a9eef7 83# define WXMAKINGDLL_QA
0cc66b6c 84# define WXMAKINGDLL_HTML
0ae4d121 85# define WXMAKINGDLL_GL
0cc66b6c 86# define WXMAKINGDLL_XML
c846884b 87# define WXMAKINGDLL_XRC
5e4903f5 88# define WXMAKINGDLL_AUI
3b2cb431 89# define WXMAKINGDLL_RICHTEXT
c220a8ec 90# define WXMAKINGDLL_MEDIA
c079af66 91# define WXMAKINGDLL_STC
0cc66b6c
VZ
92#endif /* WXMAKINGDLL */
93
94/*
53a2db12 95 WXDLLIMPEXP_CORE maps to export declaration when building the DLL, to import
0cc66b6c
VZ
96 declaration if using it or to nothing at all if we don't use wxWin as DLL
97 */
98#ifdef WXMAKINGDLL_BASE
99# define WXDLLIMPEXP_BASE WXEXPORT
100# define WXDLLIMPEXP_DATA_BASE(type) WXEXPORT type
5f9c3802
SC
101# if defined(HAVE_VISIBILITY)
102# define WXDLLIMPEXP_INLINE_BASE WXEXPORT
103# else
104# define WXDLLIMPEXP_INLINE_BASE
105# endif
0cc66b6c
VZ
106#elif defined(WXUSINGDLL)
107# define WXDLLIMPEXP_BASE WXIMPORT
108# define WXDLLIMPEXP_DATA_BASE(type) WXIMPORT type
5f9c3802
SC
109# if defined(HAVE_VISIBILITY)
110# define WXDLLIMPEXP_INLINE_BASE WXIMPORT
111# else
112# define WXDLLIMPEXP_INLINE_BASE
113# endif
0cc66b6c
VZ
114#else /* not making nor using DLL */
115# define WXDLLIMPEXP_BASE
116# define WXDLLIMPEXP_DATA_BASE(type) type
5f9c3802 117# define WXDLLIMPEXP_INLINE_BASE
0cc66b6c
VZ
118#endif
119
120#ifdef WXMAKINGDLL_NET
121# define WXDLLIMPEXP_NET WXEXPORT
122# define WXDLLIMPEXP_DATA_NET(type) WXEXPORT type
123#elif defined(WXUSINGDLL)
124# define WXDLLIMPEXP_NET WXIMPORT
125# define WXDLLIMPEXP_DATA_NET(type) WXIMPORT type
126#else /* not making nor using DLL */
127# define WXDLLIMPEXP_NET
128# define WXDLLIMPEXP_DATA_NET(type) type
129#endif
130
131#ifdef WXMAKINGDLL_CORE
132# define WXDLLIMPEXP_CORE WXEXPORT
133# define WXDLLIMPEXP_DATA_CORE(type) WXEXPORT type
134#elif defined(WXUSINGDLL)
135# define WXDLLIMPEXP_CORE WXIMPORT
136# define WXDLLIMPEXP_DATA_CORE(type) WXIMPORT type
137#else /* not making nor using DLL */
138# define WXDLLIMPEXP_CORE
139# define WXDLLIMPEXP_DATA_CORE(type) type
140#endif
141
142#ifdef WXMAKINGDLL_ADV
143# define WXDLLIMPEXP_ADV WXEXPORT
144# define WXDLLIMPEXP_DATA_ADV(type) WXEXPORT type
145#elif defined(WXUSINGDLL)
146# define WXDLLIMPEXP_ADV WXIMPORT
147# define WXDLLIMPEXP_DATA_ADV(type) WXIMPORT type
148#else /* not making nor using DLL */
149# define WXDLLIMPEXP_ADV
150# define WXDLLIMPEXP_DATA_ADV(type) type
151#endif
152
61639efb
VZ
153#ifdef WXMAKINGDLL_QA
154# define WXDLLIMPEXP_QA WXEXPORT
155# define WXDLLIMPEXP_DATA_QA(type) WXEXPORT type
156#elif defined(WXUSINGDLL)
157# define WXDLLIMPEXP_QA WXIMPORT
158# define WXDLLIMPEXP_DATA_QA(type) WXIMPORT type
159#else /* not making nor using DLL */
160# define WXDLLIMPEXP_QA
161# define WXDLLIMPEXP_DATA_QA(type) type
162#endif
163
0cc66b6c
VZ
164#ifdef WXMAKINGDLL_HTML
165# define WXDLLIMPEXP_HTML WXEXPORT
166# define WXDLLIMPEXP_DATA_HTML(type) WXEXPORT type
167#elif defined(WXUSINGDLL)
168# define WXDLLIMPEXP_HTML WXIMPORT
169# define WXDLLIMPEXP_DATA_HTML(type) WXIMPORT type
170#else /* not making nor using DLL */
171# define WXDLLIMPEXP_HTML
172# define WXDLLIMPEXP_DATA_HTML(type) type
173#endif
174
175#ifdef WXMAKINGDLL_GL
176# define WXDLLIMPEXP_GL WXEXPORT
177#elif defined(WXUSINGDLL)
178# define WXDLLIMPEXP_GL WXIMPORT
179#else /* not making nor using DLL */
180# define WXDLLIMPEXP_GL
181#endif
182
183#ifdef WXMAKINGDLL_XML
184# define WXDLLIMPEXP_XML WXEXPORT
185#elif defined(WXUSINGDLL)
186# define WXDLLIMPEXP_XML WXIMPORT
187#else /* not making nor using DLL */
188# define WXDLLIMPEXP_XML
189#endif
190
c846884b
RD
191#ifdef WXMAKINGDLL_XRC
192# define WXDLLIMPEXP_XRC WXEXPORT
193#elif defined(WXUSINGDLL)
194# define WXDLLIMPEXP_XRC WXIMPORT
195#else /* not making nor using DLL */
196# define WXDLLIMPEXP_XRC
197#endif
198
5e4903f5
JS
199#ifdef WXMAKINGDLL_AUI
200# define WXDLLIMPEXP_AUI WXEXPORT
201#elif defined(WXUSINGDLL)
202# define WXDLLIMPEXP_AUI WXIMPORT
203#else /* not making nor using DLL */
204# define WXDLLIMPEXP_AUI
205#endif
206
1c4293cb
VZ
207#ifdef WXMAKINGDLL_PROPGRID
208# define WXDLLIMPEXP_PROPGRID WXEXPORT
209#elif defined(WXUSINGDLL)
210# define WXDLLIMPEXP_PROPGRID WXIMPORT
211#else /* not making nor using DLL */
212# define WXDLLIMPEXP_PROPGRID
213#endif
214
3b2cb431
JS
215#ifdef WXMAKINGDLL_RICHTEXT
216# define WXDLLIMPEXP_RICHTEXT WXEXPORT
217#elif defined(WXUSINGDLL)
218# define WXDLLIMPEXP_RICHTEXT WXIMPORT
219#else /* not making nor using DLL */
220# define WXDLLIMPEXP_RICHTEXT
221#endif
222
ff2b312f
RN
223#ifdef WXMAKINGDLL_MEDIA
224# define WXDLLIMPEXP_MEDIA WXEXPORT
225#elif defined(WXUSINGDLL)
226# define WXDLLIMPEXP_MEDIA WXIMPORT
227#else /* not making nor using DLL */
228# define WXDLLIMPEXP_MEDIA
229#endif
230
c079af66
VZ
231#ifdef WXMAKINGDLL_STC
232 #define WXDLLIMPEXP_STC WXEXPORT
233#elif defined(WXUSINGDLL)
234 #define WXDLLIMPEXP_STC WXIMPORT
235#else /* not making nor using DLL */
236 #define WXDLLIMPEXP_STC
237#endif
238
8ece1737
VZ
239/*
240 GCC warns about using __attribute__ (and also __declspec in mingw32 case) on
241 forward declarations while MSVC complains about forward declarations without
242 __declspec for the classes later declared with it, so we need a separate set
243 of macros for forward declarations to hide this difference:
244 */
245#if defined(HAVE_VISIBILITY) || (defined(__WINDOWS__) && defined(__GNUC__))
0ff20b9f
VS
246 #define WXDLLIMPEXP_FWD_BASE
247 #define WXDLLIMPEXP_FWD_NET
248 #define WXDLLIMPEXP_FWD_CORE
249 #define WXDLLIMPEXP_FWD_ADV
250 #define WXDLLIMPEXP_FWD_QA
0ff20b9f
VS
251 #define WXDLLIMPEXP_FWD_HTML
252 #define WXDLLIMPEXP_FWD_GL
253 #define WXDLLIMPEXP_FWD_XML
254 #define WXDLLIMPEXP_FWD_XRC
255 #define WXDLLIMPEXP_FWD_AUI
256 #define WXDLLIMPEXP_FWD_RICHTEXT
257 #define WXDLLIMPEXP_FWD_MEDIA
258 #define WXDLLIMPEXP_FWD_STC
259#else
260 #define WXDLLIMPEXP_FWD_BASE WXDLLIMPEXP_BASE
261 #define WXDLLIMPEXP_FWD_NET WXDLLIMPEXP_NET
262 #define WXDLLIMPEXP_FWD_CORE WXDLLIMPEXP_CORE
263 #define WXDLLIMPEXP_FWD_ADV WXDLLIMPEXP_ADV
264 #define WXDLLIMPEXP_FWD_QA WXDLLIMPEXP_QA
0ff20b9f
VS
265 #define WXDLLIMPEXP_FWD_HTML WXDLLIMPEXP_HTML
266 #define WXDLLIMPEXP_FWD_GL WXDLLIMPEXP_GL
267 #define WXDLLIMPEXP_FWD_XML WXDLLIMPEXP_XML
268 #define WXDLLIMPEXP_FWD_XRC WXDLLIMPEXP_XRC
269 #define WXDLLIMPEXP_FWD_AUI WXDLLIMPEXP_AUI
270 #define WXDLLIMPEXP_FWD_RICHTEXT WXDLLIMPEXP_RICHTEXT
271 #define WXDLLIMPEXP_FWD_MEDIA WXDLLIMPEXP_MEDIA
272 #define WXDLLIMPEXP_FWD_STC WXDLLIMPEXP_STC
273#endif
b5dbe15d 274
0cc66b6c
VZ
275/* for backwards compatibility, define suffix-less versions too */
276#define WXDLLEXPORT WXDLLIMPEXP_CORE
277#define WXDLLEXPORT_DATA WXDLLIMPEXP_DATA_CORE
278
7c77f334
VZ
279/*
280 MSVC up to 6.0 needs to be explicitly told to export template instantiations
281 used by the DLL clients, use this macro to do it like this:
282
283 template <typename T> class Foo { ... };
284 WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE( Foo<int> )
285
16361ec9 286 (notice that currently we only need this for wxBase and wxCore libraries)
7c77f334
VZ
287 */
288#if defined(__VISUALC__) && (__VISUALC__ <= 1200)
289 #ifdef WXMAKINGDLL_BASE
290 #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl) \
291 template class WXDLLIMPEXP_BASE decl;
16361ec9
VS
292 #define WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE(decl) \
293 template class WXDLLIMPEXP_CORE decl;
7c77f334
VZ
294 #else
295 /*
296 We need to disable this warning when using this macro, as
53a2db12 297 recommended by Microsoft itself:
7c77f334
VZ
298
299 http://support.microsoft.com/default.aspx?scid=kb%3ben-us%3b168958
300 */
301 #pragma warning(disable:4231)
302
303 #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl) \
304 extern template class WXDLLIMPEXP_BASE decl;
16361ec9
VS
305 #define WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE(decl) \
306 extern template class WXDLLIMPEXP_CORE decl;
7c77f334
VZ
307 #endif
308#else /* not VC <= 6 */
309 #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl)
16361ec9 310 #define WXDLLIMPEXP_TEMPLATE_INSTANCE_CORE(decl)
7c77f334
VZ
311#endif /* VC6/others */
312
0cc66b6c
VZ
313#endif /* _WX_DLIMPEXP_H_ */
314