include/wx/dlimpexp.h

   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$
   8  * Copyright:   (c) 2003 Vadim Zeitlin <vadim@wxwidgets.org>
   9  * Licence:     wxWindows licence
  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
  19 #if defined(HAVE_VISIBILITY)
  20 #    define WXEXPORT __attribute__ ((visibility("default")))
  21 #    define WXIMPORT __attribute__ ((visibility("default")))
  22 #elif defined(__WINDOWS__)
  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
  42 #    elif defined(__EMX__)
  43 #        define WXEXPORT
  44 #        define WXIMPORT
  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
  54 #elif defined(__CYGWIN__)
  55 #    define WXEXPORT __declspec(dllexport)
  56 #    define WXIMPORT __declspec(dllimport)
  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 /*
  66    We support building wxWidgets as a set of several libraries but we don't
  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
  70    However we have a problem because we need separate WXDLLEXPORT versions for
  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
  83 #    define WXMAKINGDLL_QA
  84 #    define WXMAKINGDLL_HTML
  85 #    define WXMAKINGDLL_GL
  86 #    define WXMAKINGDLL_XML
  87 #    define WXMAKINGDLL_XRC
  88 #    define WXMAKINGDLL_AUI
  89 #    define WXMAKINGDLL_RICHTEXT
  90 #    define WXMAKINGDLL_MEDIA
  91 #    define WXMAKINGDLL_STC
  92 #endif /* WXMAKINGDLL */
  93
  94 /*
  95    WXDLLEXPORT maps to export declaration when building the DLL, to import
  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
 101 #elif defined(WXUSINGDLL)
 102 #    define WXDLLIMPEXP_BASE WXIMPORT
 103 #    define WXDLLIMPEXP_DATA_BASE(type) WXIMPORT type
 104 #else /* not making nor using DLL */
 105 #    define WXDLLIMPEXP_BASE
 106 #    define WXDLLIMPEXP_DATA_BASE(type) type
 107 #endif
 108
 109 #ifdef WXMAKINGDLL_NET
 110 #    define WXDLLIMPEXP_NET WXEXPORT
 111 #    define WXDLLIMPEXP_DATA_NET(type) WXEXPORT type
 112 #elif defined(WXUSINGDLL)
 113 #    define WXDLLIMPEXP_NET WXIMPORT
 114 #    define WXDLLIMPEXP_DATA_NET(type) WXIMPORT type
 115 #else /* not making nor using DLL */
 116 #    define WXDLLIMPEXP_NET
 117 #    define WXDLLIMPEXP_DATA_NET(type) type
 118 #endif
 119
 120 #ifdef WXMAKINGDLL_CORE
 121 #    define WXDLLIMPEXP_CORE WXEXPORT
 122 #    define WXDLLIMPEXP_DATA_CORE(type) WXEXPORT type
 123 #elif defined(WXUSINGDLL)
 124 #    define WXDLLIMPEXP_CORE WXIMPORT
 125 #    define WXDLLIMPEXP_DATA_CORE(type) WXIMPORT type
 126 #else /* not making nor using DLL */
 127 #    define WXDLLIMPEXP_CORE
 128 #    define WXDLLIMPEXP_DATA_CORE(type) type
 129 #endif
 130
 131 #ifdef WXMAKINGDLL_ADV
 132 #    define WXDLLIMPEXP_ADV WXEXPORT
 133 #    define WXDLLIMPEXP_DATA_ADV(type) WXEXPORT type
 134 #elif defined(WXUSINGDLL)
 135 #    define WXDLLIMPEXP_ADV WXIMPORT
 136 #    define WXDLLIMPEXP_DATA_ADV(type) WXIMPORT type
 137 #else /* not making nor using DLL */
 138 #    define WXDLLIMPEXP_ADV
 139 #    define WXDLLIMPEXP_DATA_ADV(type) type
 140 #endif
 141
 142 #ifdef WXMAKINGDLL_QA
 143 #    define WXDLLIMPEXP_QA WXEXPORT
 144 #    define WXDLLIMPEXP_DATA_QA(type) WXEXPORT type
 145 #elif defined(WXUSINGDLL)
 146 #    define WXDLLIMPEXP_QA WXIMPORT
 147 #    define WXDLLIMPEXP_DATA_QA(type) WXIMPORT type
 148 #else /* not making nor using DLL */
 149 #    define WXDLLIMPEXP_QA
 150 #    define WXDLLIMPEXP_DATA_QA(type) type
 151 #endif
 152
 153 #ifdef WXMAKINGDLL_HTML
 154 #    define WXDLLIMPEXP_HTML WXEXPORT
 155 #    define WXDLLIMPEXP_DATA_HTML(type) WXEXPORT type
 156 #elif defined(WXUSINGDLL)
 157 #    define WXDLLIMPEXP_HTML WXIMPORT
 158 #    define WXDLLIMPEXP_DATA_HTML(type) WXIMPORT type
 159 #else /* not making nor using DLL */
 160 #    define WXDLLIMPEXP_HTML
 161 #    define WXDLLIMPEXP_DATA_HTML(type) type
 162 #endif
 163
 164 #ifdef WXMAKINGDLL_GL
 165 #    define WXDLLIMPEXP_GL WXEXPORT
 166 #elif defined(WXUSINGDLL)
 167 #    define WXDLLIMPEXP_GL WXIMPORT
 168 #else /* not making nor using DLL */
 169 #    define WXDLLIMPEXP_GL
 170 #endif
 171
 172 #ifdef WXMAKINGDLL_XML
 173 #    define WXDLLIMPEXP_XML WXEXPORT
 174 #elif defined(WXUSINGDLL)
 175 #    define WXDLLIMPEXP_XML WXIMPORT
 176 #else /* not making nor using DLL */
 177 #    define WXDLLIMPEXP_XML
 178 #endif
 179
 180 #ifdef WXMAKINGDLL_XRC
 181 #    define WXDLLIMPEXP_XRC WXEXPORT
 182 #elif defined(WXUSINGDLL)
 183 #    define WXDLLIMPEXP_XRC WXIMPORT
 184 #else /* not making nor using DLL */
 185 #    define WXDLLIMPEXP_XRC
 186 #endif
 187
 188 #ifdef WXMAKINGDLL_AUI
 189 #    define WXDLLIMPEXP_AUI WXEXPORT
 190 #elif defined(WXUSINGDLL)
 191 #    define WXDLLIMPEXP_AUI WXIMPORT
 192 #else /* not making nor using DLL */
 193 #    define WXDLLIMPEXP_AUI
 194 #endif
 195
 196 #ifdef WXMAKINGDLL_RICHTEXT
 197 #    define WXDLLIMPEXP_RICHTEXT WXEXPORT
 198 #elif defined(WXUSINGDLL)
 199 #    define WXDLLIMPEXP_RICHTEXT WXIMPORT
 200 #else /* not making nor using DLL */
 201 #    define WXDLLIMPEXP_RICHTEXT
 202 #endif
 203
 204 #ifdef WXMAKINGDLL_MEDIA
 205 #    define WXDLLIMPEXP_MEDIA WXEXPORT
 206 #elif defined(WXUSINGDLL)
 207 #    define WXDLLIMPEXP_MEDIA WXIMPORT
 208 #else /* not making nor using DLL */
 209 #    define WXDLLIMPEXP_MEDIA
 210 #endif
 211
 212 #ifdef WXMAKINGDLL_STC
 213     #define WXDLLIMPEXP_STC WXEXPORT
 214 #elif defined(WXUSINGDLL)
 215     #define WXDLLIMPEXP_STC WXIMPORT
 216 #else /* not making nor using DLL */
 217     #define WXDLLIMPEXP_STC
 218 #endif
 219
 220 /*
 221    GCC warns about using __attribute__ (and also __declspec in mingw32 case) on
 222    forward declarations while MSVC complains about forward declarations without
 223    __declspec for the classes later declared with it, so we need a separate set
 224    of macros for forward declarations to hide this difference:
 225  */
 226 #if defined(HAVE_VISIBILITY) || (defined(__WINDOWS__) && defined(__GNUC__))
 227     #define WXDLLIMPEXP_FWD_BASE
 228     #define WXDLLIMPEXP_FWD_NET
 229     #define WXDLLIMPEXP_FWD_CORE
 230     #define WXDLLIMPEXP_FWD_ADV
 231     #define WXDLLIMPEXP_FWD_QA
 232     #define WXDLLIMPEXP_FWD_HTML
 233     #define WXDLLIMPEXP_FWD_GL
 234     #define WXDLLIMPEXP_FWD_XML
 235     #define WXDLLIMPEXP_FWD_XRC
 236     #define WXDLLIMPEXP_FWD_AUI
 237     #define WXDLLIMPEXP_FWD_RICHTEXT
 238     #define WXDLLIMPEXP_FWD_MEDIA
 239     #define WXDLLIMPEXP_FWD_STC
 240 #else
 241     #define WXDLLIMPEXP_FWD_BASE      WXDLLIMPEXP_BASE
 242     #define WXDLLIMPEXP_FWD_NET       WXDLLIMPEXP_NET
 243     #define WXDLLIMPEXP_FWD_CORE      WXDLLIMPEXP_CORE
 244     #define WXDLLIMPEXP_FWD_ADV       WXDLLIMPEXP_ADV
 245     #define WXDLLIMPEXP_FWD_QA        WXDLLIMPEXP_QA
 246     #define WXDLLIMPEXP_FWD_HTML      WXDLLIMPEXP_HTML
 247     #define WXDLLIMPEXP_FWD_GL        WXDLLIMPEXP_GL
 248     #define WXDLLIMPEXP_FWD_XML       WXDLLIMPEXP_XML
 249     #define WXDLLIMPEXP_FWD_XRC       WXDLLIMPEXP_XRC
 250     #define WXDLLIMPEXP_FWD_AUI       WXDLLIMPEXP_AUI
 251     #define WXDLLIMPEXP_FWD_RICHTEXT  WXDLLIMPEXP_RICHTEXT
 252     #define WXDLLIMPEXP_FWD_MEDIA     WXDLLIMPEXP_MEDIA
 253     #define WXDLLIMPEXP_FWD_STC       WXDLLIMPEXP_STC
 254 #endif
 255
 256 /* for backwards compatibility, define suffix-less versions too */
 257 #define WXDLLEXPORT WXDLLIMPEXP_CORE
 258 #define WXDLLEXPORT_DATA WXDLLIMPEXP_DATA_CORE
 259
 260 /*
 261    MSVC up to 6.0 needs to be explicitly told to export template instantiations
 262    used by the DLL clients, use this macro to do it like this:
 263
 264        template <typename T> class Foo { ... };
 265        WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE( Foo<int> )
 266
 267    (notice that currently we only need this for the wxBase library)
 268  */
 269 #if defined(__VISUALC__) && (__VISUALC__ <= 1200)
 270     #ifdef WXMAKINGDLL_BASE
 271         #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl) \
 272             template class WXDLLIMPEXP_BASE decl;
 273     #else
 274         /*
 275            We need to disable this warning when using this macro, as
 276            recommended by Microsoft itself:
 277
 278            http://support.microsoft.com/default.aspx?scid=kb%3ben-us%3b168958
 279          */
 280         #pragma warning(disable:4231)
 281
 282         #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl) \
 283             extern template class WXDLLIMPEXP_BASE decl;
 284     #endif
 285 #else /* not VC <= 6 */
 286     #define WXDLLIMPEXP_TEMPLATE_INSTANCE_BASE(decl)
 287 #endif /* VC6/others */
 288
 289 #endif /* _WX_DLIMPEXP_H_ */
 290