added copy ctor to wxCStrData to fix crashes when passing to vararg functions

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

diff --git a/include/wx/log.h b/include/wx/log.h
index 78c614424532faaf093faeef633d7e94c43dc8fb..0ed1ddbc629d3d4cd537f79a71e85584971bb38f 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -45,6 +45,7 @@ typedef unsigned long wxLogLevel;
 // ----------------------------------------------------------------------------
 
 #include "wx/string.h"
 // ----------------------------------------------------------------------------
 
 #include "wx/string.h"

+#include "wx/strvararg.h"

 
 #if wxUSE_LOG
 
 
 #if wxUSE_LOG
 


@@ -80,7 +81,7 @@ typedef unsigned long wxLogLevel;
 // ----------------------------------------------------------------------------
 
 // different standard log levels (you may also define your own)
 // ----------------------------------------------------------------------------
 
 // 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
 {
     wxLOG_FatalError, // program can't continue, abort immediately
     wxLOG_Error,      // a serious error, user must be informed about it


@@ -121,13 +122,6 @@ public:
     // ctor
     wxLog(){}
 
     // ctor
     wxLog(){}
 

-    // Internal buffer.
-
-    // Allow replacement of the fixed size static buffer with
-    // a user allocated one.  Pass in NULL to restore the
-    // built in static buffer.
-    static wxChar *SetLogBuffer( wxChar *buf, size_t size = 0 );
-

     // these functions allow to completely disable all log messages
 
     // is logging disabled now?
     // these functions allow to completely disable all log messages
 
     // is logging disabled now?


@@ -135,19 +129,11 @@ public:
 
     // change the flag state, return the previous one
     static bool EnableLogging(bool doIt = true)
 
     // change the flag state, return the previous one
     static bool EnableLogging(bool doIt = true)

-    { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
+        { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }

 
     // static sink function - see DoLog() for function to overload in the
     // derived classes
 
     // static sink function - see DoLog() for function to overload in the
     // derived classes

-    static void OnLog(wxLogLevel level, const wxChar *szString, time_t t)
-    {
-        if ( IsEnabled() && ms_logLevel >= level )
-        {
-            wxLog *pLogger = GetActiveTarget();
-            if ( pLogger )
-                pLogger->DoLog(level, szString, t);
-        }
-    }
+    static void OnLog(wxLogLevel level, const wxChar *szString, time_t t);

 
     // message buffering
 
 
     // message buffering
 


@@ -195,12 +181,20 @@ public:
     // current is NULL?
     static void DontCreateOnDemand();
 
     // current is NULL?
     static void DontCreateOnDemand();
 

+    // log the count of repeating messages instead of logging the messages
+    // multiple times
+    static void SetRepetitionCounting(bool bRepetCounting = true)
+        { ms_bRepetCounting = bRepetCounting; }
+
+    // gets duplicate counting status
+    static bool GetRepetitionCounting() { return ms_bRepetCounting; }
+

     // trace mask (see wxTraceXXX constants for details)
     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
 
     // add string trace mask
     static void AddTraceMask(const wxString& str)
     // trace mask (see wxTraceXXX constants for details)
     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
 
     // add string trace mask
     static void AddTraceMask(const wxString& str)

-    { ms_aTraceMasks.push_back(str); }
+        { ms_aTraceMasks.push_back(str); }

 
     // add string trace mask
     static void RemoveTraceMask(const wxString& str);
 
     // add string trace mask
     static void RemoveTraceMask(const wxString& str);


@@ -242,12 +236,17 @@ public:
     static void TimeStamp(wxString *str);
 
     // make dtor virtual for all derived classes
     static void TimeStamp(wxString *str);
 
     // make dtor virtual for all derived classes

-    virtual ~wxLog() { }
+    virtual ~wxLog();

 
 
     // this method exists for backwards compatibility only, don't use
     bool HasPendingMessages() const { return true; }
 
 
 
     // this method exists for backwards compatibility only, don't use
     bool HasPendingMessages() const { return true; }
 

+#if WXWIN_COMPATIBILITY_2_6
+    // this function doesn't do anything any more, don't call it
+    wxDEPRECATED( static wxChar *SetLogBuffer(wxChar *buf, size_t size = 0) );
+#endif
+

 protected:
     // the logging functions that can be overriden
 
 protected:
     // the logging functions that can be overriden
 


@@ -259,10 +258,23 @@ protected:
     // you override DoLog() you might not need it at all
     virtual void DoLogString(const wxChar *szString, time_t t);
 
     // you override DoLog() you might not need it at all
     virtual void DoLogString(const wxChar *szString, time_t t);
 

+    // log a line containing the number of times the previous message was
+    // repeated
+    // returns: the number
+    static unsigned DoLogNumberOfRepeats();
+

 private:
     // static variables
     // ----------------
 
 private:
     // static variables
     // ----------------
 

+    // traditional behaviour or counting repetitions
+    static bool        ms_bRepetCounting;
+    static wxString    ms_prevString;   // previous message that was logged
+    // how many times the previous message was logged
+    static unsigned    ms_prevCounter;
+    static time_t      ms_prevTimeStamp;// timestamp of the previous message
+    static wxLogLevel  ms_prevLevel;    // level of the previous message
+

     static wxLog      *ms_pLogger;      // currently active log sink
     static bool        ms_doLog;        // false => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
     static wxLog      *ms_pLogger;      // currently active log sink
     static bool        ms_doLog;        // false => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?


@@ -284,8 +296,6 @@ private:
 // "trivial" derivations of wxLog
 // ----------------------------------------------------------------------------
 
 // "trivial" derivations of wxLog
 // ----------------------------------------------------------------------------
 

-#if wxABI_VERSION > 20601
-

 // log everything to a buffer
 class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
 {
 // log everything to a buffer
 class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
 {


@@ -309,7 +319,6 @@ private:
     DECLARE_NO_COPY_CLASS(wxLogBuffer)
 };
 
     DECLARE_NO_COPY_CLASS(wxLogBuffer)
 };
 

-#endif // wxABI_VERSION

 
 // log everything to a "FILE *", stderr by default
 class WXDLLIMPEXP_BASE wxLogStderr : public wxLog
 
 // log everything to a "FILE *", stderr by default
 class WXDLLIMPEXP_BASE wxLogStderr : public wxLog


@@ -462,33 +471,93 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 // define wxLog<level>
 // ----------------------------------------------------------------------------
 
 // 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)                                         \
 #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)            \
 #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)                                         \
 #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)            \
 #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
 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull


@@ -505,9 +574,16 @@ public:
 #define wxTRACE_OleCalls wxEmptyString // OLE interface calls
 
 #endif // wxUSE_LOG/!wxUSE_LOG
 #define wxTRACE_OleCalls wxEmptyString // OLE interface calls
 
 #endif // wxUSE_LOG/!wxUSE_LOG

+

 #define DECLARE_LOG_FUNCTION2(level, argclass, arg)                         \
     DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
 
 #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);
 
 // a generic function for all levels (level is passes as parameter)
 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);


@@ -538,9 +614,13 @@ 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);
 // 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
 
 // debug functions do nothing in release mode

-#if wxUSE_LOG_DEBUG
+#if wxUSE_LOG && wxUSE_LOG_DEBUG

     DECLARE_LOG_FUNCTION(Debug);
 
     // there is no more unconditional LogTrace: it is not different from
     DECLARE_LOG_FUNCTION(Debug);
 
     // there is no more unconditional LogTrace: it is not different from


@@ -549,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()
 
     // 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);
 
     // 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);

-#else   //!debug
-    // 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); }
+#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, 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
 
 #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
 // 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


@@ -596,8 +706,8 @@ wxSafeShowMessage(const wxString& title, const wxString& text);
     #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 
 #else   //!debug
     #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
 #endif  //debug/!debug
 
 // wxCocoa has additiional trace masks