supporting clang memory management annotations

[wxWidgets.git] / include / wx / build.h

diff --git a/include/wx/build.h b/include/wx/build.h
index 3e7ea2219ac61b8d578e600e71ce7faa28acfba3..722f0dd031c8e52390eb16bace839102480671f9 100644 (file)
--- a/include/wx/build.h
+++ b/include/wx/build.h
@@ -5,7 +5,7 @@
 // Modified by:
 // Created:     07.05.02
 // RCS-ID:      $Id$
-// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwindows.org>
+// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwidgets.org>
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -14,6 +14,19 @@
 
 #include "wx/version.h"
 
+// NB: This file contains macros for checking binary compatibility of libraries
+//     in multilib builds, plugins and user components.
+//     The WX_BUILD_OPTIONS_SIGNATURE macro expands into string that should
+//     uniquely identify binary compatible builds: i.e. if two builds of the
+//     library are binary compatible, their signature string should be the
+//     same; if two builds are binary incompatible, their signatures should
+//     be different.
+//
+//     Therefore, wxUSE_XXX flags that affect binary compatibility (vtables,
+//     function signatures) should be accounted for here. So should compilers
+//     and compiler versions (but note that binary compatible compiler versions
+//     such as gcc-2.95.2 and gcc-2.95.3 should have same signature!).
+
 // ----------------------------------------------------------------------------
 // WX_BUILD_OPTIONS_SIGNATURE
 // ----------------------------------------------------------------------------
@@ -29,44 +42,80 @@
         __WX_BO_STRINGIZE(x) "." __WX_BO_STRINGIZE(y) "." __WX_BO_STRINGIZE(z)
 #endif
 
-#ifdef __WXDEBUG__
-    #define __WX_BO_DEBUG "debug"
-#else
-    #define __WX_BO_DEBUG "no debug"
-#endif
-
-#if wxUSE_UNICODE
-    #define __WX_BO_UNICODE "Unicode"
+#if wxUSE_UNICODE_UTF8
+    #define __WX_BO_UNICODE "UTF-8"
+#elif wxUSE_UNICODE_WCHAR
+    #define __WX_BO_UNICODE "wchar_t"
 #else
     #define __WX_BO_UNICODE "ANSI"
 #endif
 
-// GCC and Intel C++ share same C++ ABI, check if compiler versions are
-// compatible:
-#if (defined(__GNUG__) || defined(__INTEL_COMPILER) && \
-     defined(__GXX_ABI_VERSION))
+// GCC and Intel C++ share same C++ ABI (and possibly others in the future),
+// check if compiler versions are compatible:
+#if defined(__GXX_ABI_VERSION)
     #define __WX_BO_COMPILER \
             ",compiler with C++ ABI " __WX_BO_STRINGIZE(__GXX_ABI_VERSION)
+#elif defined(__INTEL_COMPILER)
+    #define __WX_BO_COMPILER ",Intel C++"
+#elif defined(__GNUG__)
+    #define __WX_BO_COMPILER ",GCC " \
+            __WX_BO_STRINGIZE(__GNUC__) "." __WX_BO_STRINGIZE(__GNUC_MINOR__)
+#elif defined(__VISUALC__)
+    #define __WX_BO_COMPILER ",Visual C++ " __WX_BO_STRINGIZE(_MSC_VER)
+#elif defined(__BORLANDC__)
+    #define __WX_BO_COMPILER ",Borland C++"
+#elif defined(__DIGITALMARS__)
+    #define __WX_BO_COMPILER ",DigitalMars"
+#elif defined(__WATCOMC__)
+    #define __WX_BO_COMPILER ",Watcom C++"
 #else
     #define __WX_BO_COMPILER
 #endif
-        
+
+// WXWIN_COMPATIBILITY macros affect presence of virtual functions
+#if WXWIN_COMPATIBILITY_2_6
+    #define __WX_BO_WXWIN_COMPAT_2_6 ",compatible with 2.6"
+#else
+    #define __WX_BO_WXWIN_COMPAT_2_6
+#endif
+#if WXWIN_COMPATIBILITY_2_8
+    #define __WX_BO_WXWIN_COMPAT_2_8 ",compatible with 2.8"
+#else
+    #define __WX_BO_WXWIN_COMPAT_2_8
+#endif
+
+// deriving wxWin containers from STL ones changes them completely:
+#if wxUSE_STD_CONTAINERS
+    #define __WX_BO_STL ",STL containers"
+#else
+    #define __WX_BO_STL ",wx containers"
+#endif
+
 // This macro is passed as argument to wxConsoleApp::CheckBuildOptions()
 #define WX_BUILD_OPTIONS_SIGNATURE \
     __WX_BO_VERSION(wxMAJOR_VERSION, wxMINOR_VERSION, wxRELEASE_NUMBER) \
-    " (" __WX_BO_DEBUG "," __WX_BO_UNICODE __WX_BO_COMPILER ")"
+    " (" __WX_BO_UNICODE \
+     __WX_BO_COMPILER \
+     __WX_BO_STL \
+     __WX_BO_WXWIN_COMPAT_2_6 __WX_BO_WXWIN_COMPAT_2_8 \
+     ")"
 
 
+// ----------------------------------------------------------------------------
+// WX_CHECK_BUILD_OPTIONS
+// ----------------------------------------------------------------------------
 
 // Use this macro to check build options. Adding it to a file in DLL will
-// ensure that the DLL checks build options in same way IMPLEMENT_APP() does.
+// ensure that the DLL checks build options in same way wxIMPLEMENT_APP() does.
 #define WX_CHECK_BUILD_OPTIONS(libName)                                 \
-    static bool wxCheckBuildOptions()                                   \
+    static struct wxBuildOptionsChecker                                 \
     {                                                                   \
-        wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE,     \
-                                        libName);                       \
-        return true;                                                    \
-    };                                                                  \
-    static bool gs_buildOptionsCheck = wxCheckBuildOptions();
+        wxBuildOptionsChecker()                                         \
+        {                                                               \
+            wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
+                                            libName);                   \
+        }                                                               \
+    } gs_buildOptionsCheck;
+
 
 #endif // _WX_BUILD_H_