documented wxVideoMode (otherwise wxDisplay docs are not very useful)

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

diff --git a/include/wx/build.h b/include/wx/build.h
index 9b0413b91c86c4273bf6a212ac54ada576d5a5a1..e660e39114000d325bb45fc1a03f1d6e94cdb675 100644 (file)
--- a/include/wx/build.h
+++ b/include/wx/build.h
@@ -14,6 +14,19 @@
 
 #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!).
+
 // ----------------------------------------------------------------------------
 // WX_BUILD_OPTIONS_SIGNATURE
 // ----------------------------------------------------------------------------
@@ -52,7 +65,7 @@
     #define __WX_BO_COMPILER ",GCC " \
             __WX_BO_STRINGIZE(__GNUC__) "." __WX_BO_STRINGIZE(__GNUC_MINOR__)
 #elif defined(__VISUALC__)
-    #define __WX_BO_COMPILER ",Visual C++"
+    #define __WX_BO_COMPILER ",Visual C++ " __WX_BO_STRINGIZE(_MSC_VER)
 #elif defined(__BORLANDC__)
     #define __WX_BO_COMPILER ",Borland C++"
 #elif defined(__DIGITALMARS__)
@@ -64,15 +77,15 @@
 #endif
 
 // WXWIN_COMPATIBILITY macros affect presence of virtual functions
-#if WXWIN_COMPATIBILITY_2_2
-    #define __WX_BO_WXWIN_COMPAT_2_2 ",compatible with 2.2"
+#if WXWIN_COMPATIBILITY_2_6
+    #define __WX_BO_WXWIN_COMPAT_2_6 ",compatible with 2.6"
 #else
-    #define __WX_BO_WXWIN_COMPAT_2_2
+    #define __WX_BO_WXWIN_COMPAT_2_6
 #endif
-#if WXWIN_COMPATIBILITY_2_4
-    #define __WX_BO_WXWIN_COMPAT_2_4 ",compatible with 2.4"
+#if WXWIN_COMPATIBILITY_2_8
+    #define __WX_BO_WXWIN_COMPAT_2_8 ",compatible with 2.8"
 #else
-    #define __WX_BO_WXWIN_COMPAT_2_4
+    #define __WX_BO_WXWIN_COMPAT_2_8
 #endif
 
 // deriving wxWin containers from STL ones changes them completely:
@@ -81,14 +94,14 @@
 #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_STL \
-     __WX_BO_WXWIN_COMPAT_2_2 __WX_BO_WXWIN_COMPAT_2_4 \
+     __WX_BO_WXWIN_COMPAT_2_6 __WX_BO_WXWIN_COMPAT_2_8 \
      ")"
 
 
@@ -99,37 +112,14 @@
 // 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 bool wxCheckBuildOptions()                                   \
+    static struct wxBuildOptionsChecker                                 \
     {                                                                   \
-        wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE,     \
-                                        libName);                       \
-        return true;                                                    \
-    };                                                                  \
-    static bool gs_buildOptionsCheck = wxCheckBuildOptions();
-
-
-#if WXWIN_COMPATIBILITY_2_4
-
-// ----------------------------------------------------------------------------
-// wxBuildOptions
-// ----------------------------------------------------------------------------
-
-// NB: Don't use this class in new code, it relies on the ctor being always
-//     inlined. WX_BUILD_OPTIONS_SIGNATURE always works.
-class wxBuildOptions
-{
-public:
-    // the ctor must be inline to get the compilation settings of the code
-    // which included this header
-    wxBuildOptions() : m_signature(WX_BUILD_OPTIONS_SIGNATURE) {}
-
-private:
-    const char *m_signature;
-
-    // actually only CheckBuildOptions() should be our friend but well...
-    friend class wxAppConsole;
-};
+        wxBuildOptionsChecker()                                         \
+        {                                                               \
+            wxAppConsole::CheckBuildOptions(WX_BUILD_OPTIONS_SIGNATURE, \
+                                            libName);                   \
+        }                                                               \
+    } gs_buildOptionsCheck;
 
-#endif // WXWIN_COMPATIBILITY_2_4
 
 #endif // _WX_BUILD_H_