Source/WTF/wtf/ExportMacros.h

   1 /*
   2  * Copyright (C) 2011 Apple Inc.  All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  *
  25  * This file handles shared library symbol export decorations. It is recommended
  26  * that all WebKit projects use these definitions so that symbol exports work
  27  * properly on all platforms and compilers that WebKit builds under.
  28  */
  29
  30 #ifndef ExportMacros_h
  31 #define ExportMacros_h
  32
  33 #include <wtf/Platform.h>
  34
  35 // Different platforms have different defaults for symbol visibility. Usually
  36 // the compiler and the linker just take care of it. However for references to
  37 // runtime routines from JIT stubs, it matters to be able to declare a symbol as
  38 // being local to the target being generated, and thus not subject to (e.g.) ELF
  39 // symbol interposition rules.
  40
  41 #if !PLATFORM(CHROMIUM) && OS(WINDOWS)
  42 #define HAVE_INTERNAL_VISIBILITY 1
  43 #define WTF_INTERNAL
  44 #elif defined(__GNUC__) && !defined(__CC_ARM) && !defined(__ARMCC__)
  45 #define HAVE_INTERNAL_VISIBILITY 1
  46 #define WTF_INTERNAL __attribute__((visibility("hidden")))
  47 #else
  48 #define WTF_INTERNAL
  49 #endif
  50
  51 #if !PLATFORM(CHROMIUM) && OS(WINDOWS)
  52
  53 #define WTF_EXPORT_DECLARATION __declspec(dllexport)
  54 #define WTF_IMPORT_DECLARATION __declspec(dllimport)
  55 #define WTF_HIDDEN_DECLARATION
  56
  57 #elif defined(__GNUC__) && !defined(__CC_ARM) && !defined(__ARMCC__)
  58
  59 #define WTF_EXPORT_DECLARATION __attribute__((visibility("default")))
  60 #define WTF_IMPORT_DECLARATION WTF_EXPORT_DECLARATION
  61 #define WTF_HIDDEN_DECLARATION __attribute__((visibility("hidden")))
  62
  63 #else
  64
  65 #define WTF_EXPORT_DECLARATION
  66 #define WTF_IMPORT_DECLARATION
  67 #define WTF_HIDDEN_DECLARATION
  68
  69 #endif
  70
  71 #if defined(BUILDING_WTF) || defined(STATICALLY_LINKED_WITH_WTF) || (PLATFORM(WX) && defined(BUILDING_JavaScriptCore))
  72 #define WTF_IS_LINKED_IN_SAME_BINARY 1
  73 #endif
  74
  75 // See note in wtf/Platform.h for more info on EXPORT_MACROS.
  76 #if USE(EXPORT_MACROS)
  77
  78 #define WTF_EXPORT WTF_EXPORT_DECLARATION
  79 #define WTF_IMPORT WTF_IMPORT_DECLARATION
  80 #define WTF_HIDDEN WTF_IMPORT_DECLARATION
  81
  82 // FIXME: When all ports are using the export macros, we should replace
  83 // WTF_EXPORTDATA with WTF_EXPORT_PRIVATE macros.
  84 #if defined(WTF_IS_LINKED_IN_SAME_BINARY)
  85 #define WTF_EXPORTDATA WTF_EXPORT
  86 #else
  87 #define WTF_EXPORTDATA WTF_IMPORT
  88 #endif
  89
  90 #else // !USE(EXPORT_MACROS)
  91
  92 #if !PLATFORM(CHROMIUM) && OS(WINDOWS) && !COMPILER(GCC)
  93 #if defined(BUILDING_WTF) || defined(STATICALLY_LINKED_WITH_WTF)
  94 #define WTF_EXPORTDATA __declspec(dllexport)
  95 #else
  96 #define WTF_EXPORTDATA __declspec(dllimport)
  97 #endif
  98 #else // PLATFORM(CHROMIUM) || !OS(WINDOWS) || COMPILER(GCC)
  99 #define WTF_EXPORTDATA
 100 #endif // !PLATFORM(CHROMIUM)...
 101
 102 #define WTF_EXPORTCLASS WTF_EXPORTDATA
 103
 104 #define WTF_EXPORT
 105 #define WTF_IMPORT
 106 #define WTF_HIDDEN
 107
 108 #endif // USE(EXPORT_MACROS)
 109
 110 // WTF_TESTING (and WEBCORE_TESTING in PlatformExportMacros.h) is used for
 111 // exporting symbols which are referred from WebCoreTestSupport library.
 112 // Since the set of APIs is common between ports,
 113 // it is rather worth annotating inside the code than maintaining port specific export lists.
 114 #if USE(EXPORT_MACROS_FOR_TESTING)
 115
 116 #if defined(WTF_IS_LINKED_IN_SAME_BINARY)
 117 #define WTF_TESTING WTF_EXPORT_DECLARATION
 118 #else
 119 #define WTF_TESTING WTF_IMPORT_DECLARATION
 120 #endif
 121
 122 #else // USE(EXPORT_MACROS_FOR_TESTING)
 123
 124 #define WTF_TESTING
 125
 126 #endif // USE(EXPORT_MACROS_FOR_TESTING)
 127
 128 #if defined(WTF_IS_LINKED_IN_SAME_BINARY)
 129 #define WTF_EXPORT_PRIVATE WTF_EXPORT
 130 #else
 131 #define WTF_EXPORT_PRIVATE WTF_IMPORT
 132 #endif
 133
 134 // wxWebKit uses RTTI because wx itself does, so use a special macro for
 135 // extra exports it needs.
 136 #if PLATFORM(WX)
 137 #define WTF_EXPORT_PRIVATE_RTTI WTF_EXPORT_PRIVATE
 138 #define WTF_EXPORT_PRIVATE_NO_RTTI
 139 #else
 140 #define WTF_EXPORT_PRIVATE_RTTI
 141 #define WTF_EXPORT_PRIVATE_NO_RTTI WTF_EXPORT_PRIVATE
 142 #endif
 143
 144 #define WTF_EXPORT_HIDDEN WTF_HIDDEN
 145
 146 #define HIDDEN_INLINE WTF_EXPORT_HIDDEN inline
 147
 148 #endif // ExportMacros_h