]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/log.h
added copy ctor to wxCStrData to fix crashes when passing to vararg functions
[wxWidgets.git] / include / wx / log.h
index 0e548d2bbe13d8553eedf34a46a5620457bd8689..0ed1ddbc629d3d4cd537f79a71e85584971bb38f 100644 (file)
@@ -45,6 +45,7 @@ typedef unsigned long wxLogLevel;
 // ----------------------------------------------------------------------------
 
 #include "wx/string.h"
+#include "wx/strvararg.h"
 
 #if wxUSE_LOG
 
@@ -80,7 +81,7 @@ typedef unsigned long wxLogLevel;
 // ----------------------------------------------------------------------------
 
 // different standard log levels (you may also define your own)
-enum
+enum wxLogLevelValues
 {
     wxLOG_FatalError, // program can't continue, abort immediately
     wxLOG_Error,      // a serious error, user must be informed about it
@@ -470,33 +471,93 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 // define wxLog<level>
 // ----------------------------------------------------------------------------
 
+#ifdef __WATCOMC__
+    // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+    #define WX_WATCOM_ONLY_CODE( x )  x
+#else
+    #define WX_WATCOM_ONLY_CODE( x )
+#endif
+
 #define DECLARE_LOG_FUNCTION(level)                                         \
-extern void WXDLLIMPEXP_BASE wxVLog##level(const wxChar *szFormat,          \
-                                           va_list argptr);                 \
-extern void WXDLLIMPEXP_BASE wxLog##level(const wxChar *szFormat,           \
-                                          ...) ATTRIBUTE_PRINTF_1
+    extern void WXDLLIMPEXP_BASE                                            \
+    wxDoLog##level(const wxString& format, ...);                            \
+    WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
+                               1, (const wxString&), wxDoLog##level)        \
+    DECLARE_LOG_FUNCTION_WATCOM(level)                                      \
+    extern void WXDLLIMPEXP_BASE wxVLog##level(const wxString& format,      \
+                                               va_list argptr)
+
+#ifdef __WATCOMC__
+    // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
+    // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
+    // something too big for Borland C++ to handle
+    #define DECLARE_LOG_FUNCTION_WATCOM(level)                              \
+        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   1, (const char*), wxDoLog##level)        \
+        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   1, (const wchar_t*), wxDoLog##level)     \
+        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   1, (const wxCStrData&), wxDoLog##level)
+#else
+    #define DECLARE_LOG_FUNCTION_WATCOM(level)
+#endif
+
+
 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
-extern void expdecl wxVLog##level(argclass arg,                             \
-                                  const wxChar *szFormat,                   \
-                                  va_list argptr);                          \
-extern void expdecl wxLog##level(argclass arg,                              \
-                                 const wxChar *szFormat,                    \
-                                 ...) ATTRIBUTE_PRINTF_2
+    extern void expdecl wxDoLog##level(argclass arg,                        \
+                                       const wxString& format, ...);        \
+    WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
+                               2, (argclass, const wxString&),              \
+                               wxDoLog##level)                              \
+    DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)         \
+    extern void expdecl wxVLog##level(argclass arg,                         \
+                                      const wxString& format,               \
+                                      va_list argptr)
+
+#ifdef __WATCOMC__
+    // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
+    // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
+    // something too big for Borland C++ to handle
+    #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl) \
+        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   2, (argclass, const char*),              \
+                                   wxDoLog##level)                          \
+        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   2, (argclass, const wchar_t*),           \
+                                   wxDoLog##level)                          \
+        WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                            \
+                                   2, (argclass, const wxCStrData&),        \
+                                   wxDoLog##level)
+#else
+    #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)
+#endif
+
+
 #else // !wxUSE_LOG
 
 // log functions do nothing at all
 #define DECLARE_LOG_FUNCTION(level)                                         \
-inline void wxVLog##level(const wxChar *WXUNUSED(szFormat),                 \
-                          va_list WXUNUSED(argptr)) { }                     \
-inline void wxLog##level(const wxChar *WXUNUSED(szFormat),                  \
-                         ...) { }
+    WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxString&))           \
+    WX_WATCOM_ONLY_CODE(                                                    \
+        WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const char*))           \
+        WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wchar_t*))        \
+        WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxCStrData&))     \
+    )                                                                       \
+    inline void wxVLog##level(const wxString& WXUNUSED(format),             \
+                               va_list WXUNUSED(argptr)) { }                \
+
 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
-inline void wxVLog##level(argclass WXUNUSED(arg),                           \
-                          const wxChar *WXUNUSED(szFormat),                 \
-                          va_list WXUNUSED(argptr)) {}                      \
-inline void wxLog##level(argclass WXUNUSED(arg),                            \
-                         const wxChar *WXUNUSED(szFormat),                  \
-                         ...) { }
+    WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxString&)) \
+    WX_WATCOM_ONLY_CODE(                                                    \
+        WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const char*)) \
+        WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wchar_t*)) \
+        WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxCStrData&)) \
+    )                                                                       \
+    inline void wxVLog##level(argclass WXUNUSED(arg),                       \
+                               const wxString& WXUNUSED(format),            \
+                               va_list WXUNUSED(argptr)) {}
+
+#undef WX_WATCOM_ONLY_CODE
 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull
@@ -517,6 +578,12 @@ public:
 #define DECLARE_LOG_FUNCTION2(level, argclass, arg)                         \
     DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
 
+// VC6 produces a warning if we a macro expanding to nothing to
+// DECLARE_LOG_FUNCTION2:
+#if defined(__VISUALC__) && __VISUALC__ < 1300
+    // "not enough actual parameters for macro 'DECLARE_LOG_FUNCTION2_EXP'"
+    #pragma warning(disable:4003)
+#endif
 
 // a generic function for all levels (level is passes as parameter)
 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);
@@ -547,6 +614,10 @@ DECLARE_LOG_FUNCTION(SysError);
 // and another one which also takes the error code (for those broken APIs
 // that don't set the errno (like registry APIs in Win32))
 DECLARE_LOG_FUNCTION2(SysError, long, lErrCode);
+#ifdef __WATCOMC__
+// workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+DECLARE_LOG_FUNCTION2(SysError, unsigned long, lErrCode);
+#endif
 
 // debug functions do nothing in release mode
 #if wxUSE_LOG && wxUSE_LOG_DEBUG
@@ -558,25 +629,55 @@ DECLARE_LOG_FUNCTION2(SysError, long, lErrCode);
 
     // this version only logs the message if the mask had been added to the
     // list of masks with AddTraceMask()
-    DECLARE_LOG_FUNCTION2(Trace, const wxChar *, mask);
+    DECLARE_LOG_FUNCTION2(Trace, const wxString&, mask);
+#ifdef __WATCOMC__
+    // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+    DECLARE_LOG_FUNCTION2(Trace, const char*, mask);
+    DECLARE_LOG_FUNCTION2(Trace, const wchar_t*, mask);
+#endif
 
     // and this one does nothing if all of level bits are not set in
     // wxLog::GetActive()->GetTraceMask() -- it's deprecated in favour of
     // string identifiers
     DECLARE_LOG_FUNCTION2(Trace, wxTraceMask, mask);
+#ifdef __WATCOMC__
+    // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+    DECLARE_LOG_FUNCTION2(Trace, int, mask);
+#endif
 #else   //!debug || !wxUSE_LOG
-    // these functions do nothing in release builds
-
-    // note that leaving out "fmt" in the vararg functions provokes a warning
-    // from SGI CC: "the last argument of the varargs function is unnamed"
-    inline void wxVLogDebug(const wxChar *, va_list) { }
-    inline void wxLogDebug(const wxChar *fmt, ...) { wxUnusedVar(fmt); }
-    inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }
-    inline void wxLogTrace(wxTraceMask, const wxChar *fmt, ...) { wxUnusedVar(fmt); }
-    inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }
-    inline void wxLogTrace(const wxChar *, const wxChar *fmt, ...) { wxUnusedVar(fmt); }
+    // these functions do nothing in release builds, but don't define them as
+    // nothing as it could result in different code structure in debug and
+    // release and this could result in trouble when these macros are used
+    // inside if/else
+    //
+    // note that making wxVLogDebug/Trace() themselves (empty inline) functions
+    // is a bad idea as some compilers are stupid enough to not inline even
+    // empty functions if their parameters are complicated enough, but by
+    // defining them as an empty inline function we ensure that even dumbest
+    // compilers optimise them away
+    inline void wxLogNop() { }
+
+    #define wxVLogDebug(fmt, valist) wxLogNop()
+    #define wxVLogTrace(mask, fmt, valist) wxLogNop()
+
+    #ifdef HAVE_VARIADIC_MACROS
+        // unlike the inline functions below, this completely removes the
+        // wxLogXXX calls from the object file:
+        #define wxLogDebug(fmt, ...) wxLogNop()
+        #define wxLogTrace(mask, fmt, ...) wxLogNop()
+    #else // !HAVE_VARIADIC_MACROS
+        //inline void wxLogDebug(const wxString& fmt, ...) {}
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug)
+        //inline void wxLogTrace(wxTraceMask, const wxString& fmt, ...) {}
+        //inline void wxLogTrace(const wxString&, const wxString& fmt, ...) {}
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace)
+    #endif // HAVE_VARIADIC_MACROS/!HAVE_VARIADIC_MACROS
 #endif // debug/!debug
 
+#if defined(__VISUALC__) && __VISUALC__ < 1300
+    #pragma warning(default:4003)
+#endif
+
 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
 // i.e. without using wxMessageBox() for example because it could crash
 void WXDLLIMPEXP_BASE
@@ -605,8 +706,8 @@ wxSafeShowMessage(const wxString& title, const wxString& text);
     #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 
 #else   //!debug
-    inline void wxLogApiError(const wxChar *, long) { }
-    inline void wxLogLastError(const wxChar *) { }
+    #define wxLogApiError(api, err) wxLogNop()
+    #define wxLogLastError(api) wxLogNop()
 #endif  //debug/!debug
 
 // wxCocoa has additiional trace masks