added wxUSE_REGKEY option

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

diff --git a/include/wx/build.h b/include/wx/build.h
index 58e2a0dd8461dc12b4bf683bc891d8eca4b1eb57..5141afcbc7821748425ce10a5825b18c8061897e 100644 (file)
--- a/include/wx/build.h
+++ b/include/wx/build.h
@@ -1,12 +1,12 @@
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        wx/build.h
 ///////////////////////////////////////////////////////////////////////////////
 // Name:        wx/build.h

-// Purpose:     wxBuildOptions class declaration
-// Author:      Vadim Zeitlin
+// Purpose:     Runtime build options checking
+// Author:      Vadim Zeitlin, Vaclav Slavik

 // Modified by:
 // Created:     07.05.02
 // RCS-ID:      $Id$
 // Modified by:
 // Created:     07.05.02
 // RCS-ID:      $Id$

-// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwindows.org>
-// Licence:     wxWindows license
+// Copyright:   (c) 2002 Vadim Zeitlin <vadim@wxwidgets.org>
+// Licence:     wxWindows licence

 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_BUILD_H_
 ///////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_BUILD_H_


@@ -14,42 +14,112 @@
 
 #include "wx/version.h"
 
 
 #include "wx/version.h"
 

+// NB: This file contains macros for checking binary compatibility of libraries
+//     in multilib buildm, 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!).
+

 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------

-// wxBuildOptions
+// WX_BUILD_OPTIONS_SIGNATURE

 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 

-class wxBuildOptions
-{
-public:
-    // the ctor must be inline to get the compilation settings of the code
-    // which included this header
-    wxBuildOptions()
-    {
-        // debug/release
+#define __WX_BO_STRINGIZE(x)   __WX_BO_STRINGIZE0(x)
+#define __WX_BO_STRINGIZE0(x)  #x
+
+#if (wxMINOR_VERSION % 2) == 0
+    #define __WX_BO_VERSION(x,y,z) \
+        __WX_BO_STRINGIZE(x) "." __WX_BO_STRINGIZE(y)
+#else
+    #define __WX_BO_VERSION(x,y,z) \
+        __WX_BO_STRINGIZE(x) "." __WX_BO_STRINGIZE(y) "." __WX_BO_STRINGIZE(z)
+#endif
+

 #ifdef __WXDEBUG__
 #ifdef __WXDEBUG__

-        m_isDebug = TRUE;
+    #define __WX_BO_DEBUG "debug"

 #else
 #else

-        m_isDebug = FALSE;
+    #define __WX_BO_DEBUG "no debug"

 #endif
 
 #endif
 

-        // version: we don't test the micro version as hopefully changes
-        // between 2 micro versions don't result in fatal compatibility
-        // problems
-        m_verMaj = wxMAJOR_VERSION;
-        m_verMin = wxMINOR_VERSION;
-    }
+#if wxUSE_UNICODE
+    #define __WX_BO_UNICODE "Unicode"
+#else
+    #define __WX_BO_UNICODE "ANSI"
+#endif

 
 

-private:
-    // the version
-    int m_verMaj,
-        m_verMin;
+// 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++"
+#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

 
 

-    // compiled with __WXDEBUG__?
-    bool m_isDebug;
+// 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_STL
+    #define __WX_BO_STL ",STL containers"
+#else
+    #define __WX_BO_STL ",wx containers"
+#endif

 
 

-    // actually only CheckBuildOptions() should be our friend but well...
-    friend class wxAppBase;
-};
+// 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_STL \
+     __WX_BO_WXWIN_COMPAT_2_6 __WX_BO_WXWIN_COMPAT_2_8 \
+     ")"

 
 

-#endif // _WX_BUILD_H_

 
 

+// ----------------------------------------------------------------------------
+// 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.
+#define WX_CHECK_BUILD_OPTIONS(libName)                                 \
+    static struct wxBuildOptionsChecker                                 \
+    {                                                                   \
+        wxBuildOptionsChecker()                                         \
+        {                                                               \
+            wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
+                                            libName);                   \
+        }                                                               \
+    } gs_buildOptionsCheck;
+
+
+#endif // _WX_BUILD_H_