]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/log.h
don't draw borders for bitmap buttons with wxBORDER_NONE style
[wxWidgets.git] / include / wx / log.h
index 472d6776a88fb7a27bd027ba976e5008020908ae..88b6475240d41708ece92078833dca82bad2942c 100644 (file)
 #ifndef _WX_LOG_H_
 #define _WX_LOG_H_
 
 #ifndef _WX_LOG_H_
 #define _WX_LOG_H_
 
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "log.h"
-#endif
-
 #include "wx/defs.h"
 
 #include "wx/defs.h"
 
-#if wxUSE_LOG
-
-#include "wx/string.h"
-#include "wx/arrstr.h"
-
-// ----------------------------------------------------------------------------
-// forward declarations
-// ----------------------------------------------------------------------------
-
-#if wxUSE_GUI
-    class WXDLLIMPEXP_CORE wxTextCtrl;
-    class WXDLLIMPEXP_CORE wxLogFrame;
-    class WXDLLIMPEXP_CORE wxFrame;
-#endif // wxUSE_GUI
-
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
 
-typedef unsigned long wxTraceMask;
+// NB: this is needed even if wxUSE_LOG == 0
 typedef unsigned long wxLogLevel;
 
 typedef unsigned long wxLogLevel;
 
+// the trace masks have been superseded by symbolic trace constants, they're
+// for compatibility only and will be removed soon - do NOT use them
+#if WXWIN_COMPATIBILITY_2_8
+    #define wxTraceMemAlloc 0x0001  // trace memory allocation (new/delete)
+    #define wxTraceMessages 0x0002  // trace window messages/X callbacks
+    #define wxTraceResAlloc 0x0004  // trace GDI resource allocation
+    #define wxTraceRefCount 0x0008  // trace various ref counting operations
+
+    #ifdef  __WXMSW__
+        #define wxTraceOleCalls 0x0100  // OLE interface calls
+    #endif
+
+    typedef unsigned long wxTraceMask;
+#endif // WXWIN_COMPATIBILITY_2_8
+
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // headers
 // ----------------------------------------------------------------------------
 
+#include "wx/string.h"
+#include "wx/strvararg.h"
+
+#if wxUSE_LOG
+
+#include "wx/arrstr.h"
+
+#ifndef __WXPALMOS5__
 #ifndef __WXWINCE__
 #ifndef __WXWINCE__
-#include <time.h>   // for time_t
+    #include <time.h>   // for time_t
 #endif
 #endif
+#endif // ! __WXPALMOS5__
 
 #include "wx/dynarray.h"
 
 
 #include "wx/dynarray.h"
 
+// wxUSE_LOG_DEBUG enables the debug log messages
 #ifndef wxUSE_LOG_DEBUG
 #ifndef wxUSE_LOG_DEBUG
-#  ifdef __WXDEBUG__
-#    define wxUSE_LOG_DEBUG 1
-#  else // !__WXDEBUG__
-#    define wxUSE_LOG_DEBUG 0
-#  endif
+    #if wxDEBUG_LEVEL
+        #define wxUSE_LOG_DEBUG 1
+    #else // !wxDEBUG_LEVEL
+        #define wxUSE_LOG_DEBUG 0
+    #endif
 #endif
 
 #endif
 
+// wxUSE_LOG_TRACE enables the trace messages, they are disabled by default
+#ifndef wxUSE_LOG_TRACE
+    #if wxDEBUG_LEVEL
+        #define wxUSE_LOG_TRACE 1
+    #else // !wxDEBUG_LEVEL
+        #define wxUSE_LOG_TRACE 0
+    #endif
+#endif // wxUSE_LOG_TRACE
+
+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI
+    class WXDLLIMPEXP_FWD_CORE wxFrame;
+#endif // wxUSE_GUI
+
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 // different standard log levels (you may also define your own)
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 
 // 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
@@ -91,20 +114,6 @@ enum
     #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls
 #endif
 
     #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls
 #endif
 
-// the trace masks have been superceded by symbolic trace constants, they're
-// for compatibility only andwill be removed soon - do NOT use them
-
-// meaning of different bits of the trace mask (which allows selectively
-// enable/disable some trace messages)
-#define wxTraceMemAlloc 0x0001  // trace memory allocation (new/delete)
-#define wxTraceMessages 0x0002  // trace window messages/X callbacks
-#define wxTraceResAlloc 0x0004  // trace GDI resource allocation
-#define wxTraceRefCount 0x0008  // trace various ref counting operations
-
-#ifdef  __WXMSW__
-    #define wxTraceOleCalls 0x0100  // OLE interface calls
-#endif
-
 #include "wx/iosfwrap.h"
 
 // ----------------------------------------------------------------------------
 #include "wx/iosfwrap.h"
 
 // ----------------------------------------------------------------------------
@@ -116,39 +125,29 @@ class WXDLLIMPEXP_BASE wxLog
 {
 public:
     // ctor
 {
 public:
     // 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 );
+    wxLog(){}
 
     // these functions allow to completely disable all log messages
 
     // these functions allow to completely disable all log messages
-        // is logging disabled now?
+
+    // is logging disabled now?
     static bool IsEnabled() { return ms_doLog; }
     static bool IsEnabled() { return ms_doLog; }
-        // 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; }
 
     // static sink function - see DoLog() for function to overload in the
     // derived classes
         { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
 
     // 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 wxString& szString, time_t t);
 
     // message buffering
 
     // message buffering
-        // flush shows all messages if they're not logged immediately (FILE
-        // and iostream logs don't need it, but wxGuiLog does to avoid showing
-        // 17 modal dialogs one after another)
+
+    // flush shows all messages if they're not logged immediately (FILE
+    // and iostream logs don't need it, but wxGuiLog does to avoid showing
+    // 17 modal dialogs one after another)
     virtual void Flush();
 
     virtual void Flush();
 
-        // flush the active target if any
+    // flush the active target if any
     static void FlushActive()
     {
         if ( !ms_suspendCount )
     static void FlushActive()
     {
         if ( !ms_suspendCount )
@@ -160,123 +159,258 @@ public:
     }
 
     // only one sink is active at each moment
     }
 
     // only one sink is active at each moment
-        // get current log target, will call wxApp::CreateLogTarget() to
-        // create one if none exists
+    // get current log target, will call wxApp::CreateLogTarget() to
+    // create one if none exists
     static wxLog *GetActiveTarget();
     static wxLog *GetActiveTarget();
-        // change log target, pLogger may be NULL
+
+    // change log target, pLogger may be NULL
     static wxLog *SetActiveTarget(wxLog *pLogger);
 
     static wxLog *SetActiveTarget(wxLog *pLogger);
 
-        // suspend the message flushing of the main target until the next call
-        // to Resume() - this is mainly for internal use (to prevent wxYield()
-        // from flashing the messages)
+    // suspend the message flushing of the main target until the next call
+    // to Resume() - this is mainly for internal use (to prevent wxYield()
+    // from flashing the messages)
     static void Suspend() { ms_suspendCount++; }
     static void Suspend() { ms_suspendCount++; }
-        // must be called for each Suspend()!
+
+    // must be called for each Suspend()!
     static void Resume() { ms_suspendCount--; }
 
     // functions controlling the default wxLog behaviour
     static void Resume() { ms_suspendCount--; }
 
     // functions controlling the default wxLog behaviour
-        // verbose mode is activated by standard command-line '-verbose'
-        // option
-    static void SetVerbose(bool bVerbose = TRUE) { ms_bVerbose = bVerbose; }
+    // verbose mode is activated by standard command-line '-verbose'
+    // option
+    static void SetVerbose(bool bVerbose = true) { ms_bVerbose = bVerbose; }
 
 
-        // Set log level.  Log messages with level > logLevel will not be logged.
+    // Set log level.  Log messages with level > logLevel will not be logged.
     static void SetLogLevel(wxLogLevel logLevel) { ms_logLevel = logLevel; }
 
     static void SetLogLevel(wxLogLevel logLevel) { ms_logLevel = logLevel; }
 
-        // should GetActiveTarget() try to create a new log object if the
-        // current is NULL?
+    // should GetActiveTarget() try to create a new log object if the
+    // current is NULL?
     static void DontCreateOnDemand();
 
     static void DontCreateOnDemand();
 
-        // 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); }
-        // add string trace mask
+    // Make GetActiveTarget() create a new log object again.
+    static void DoCreateOnDemand();
+
+    // 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; }
+
+    // add string trace mask
+    static void AddTraceMask(const wxString& str);
+
+    // add string trace mask
     static void RemoveTraceMask(const wxString& str);
     static void RemoveTraceMask(const wxString& str);
-        // remove all string trace masks
+
+    // remove all string trace masks
     static void ClearTraceMasks();
     static void ClearTraceMasks();
-       // get string trace masks
-    static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
 
 
-        // sets the timestamp string: this is used as strftime() format string
-        // for the log targets which add time stamps to the messages - set it
-        // to NULL to disable time stamping completely.
-    static void SetTimestamp(const wxChar *ts) { ms_timestamp = ts; }
+    // get string trace masks: note that this is MT-unsafe if other threads can
+    // call AddTraceMask() concurrently
+    static const wxArrayString& GetTraceMasks() { return ms_aTraceMasks; }
+
+    // sets the time stamp string format: this is used as strftime() format
+    // string for the log targets which add time stamps to the messages; set
+    // it to empty string to disable time stamping completely.
+    static void SetTimestamp(const wxString& ts) { ms_timestamp = ts; }
+
+    // disable time stamping of log messages
+    static void DisableTimestamp() { SetTimestamp(wxEmptyString); }
 
 
     // accessors
 
 
     // accessors
-        // gets the verbose status
+
+    // gets the verbose status
     static bool GetVerbose() { return ms_bVerbose; }
     static bool GetVerbose() { return ms_bVerbose; }
-        // get trace mask
-    static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
-        // is this trace mask in the list?
-    static bool IsAllowedTraceMask(const wxChar *mask);
-        // return the current loglevel limit
+
+    // is this trace mask in the list?
+    static bool IsAllowedTraceMask(const wxString& mask);
+
+    // return the current loglevel limit
     static wxLogLevel GetLogLevel() { return ms_logLevel; }
 
     static wxLogLevel GetLogLevel() { return ms_logLevel; }
 
-        // get the current timestamp format string (may be NULL)
-    static const wxChar *GetTimestamp() { return ms_timestamp; }
+    // get the current timestamp format string (maybe empty)
+    static const wxString& GetTimestamp() { return ms_timestamp; }
 
 
     // helpers
 
 
     // helpers
-        // put the time stamp into the string if ms_timestamp != NULL (don't
-        // change it otherwise)
+
+    // put the time stamp into the string if ms_timestamp != NULL (don't
+    // change it otherwise)
     static void TimeStamp(wxString *str);
 
     static void TimeStamp(wxString *str);
 
+    // this method should only be called from derived classes DoLog()
+    // implementations and shouldn't be called directly, use logging functions
+    // instead
+    void Log(wxLogLevel level, const wxString& msg, time_t t)
+    {
+        DoLog(level, msg, t);
+    }
+
     // make dtor virtual for all derived classes
     // make dtor virtual for all derived classes
-    virtual ~wxLog() { }
+    virtual ~wxLog();
 
 
     // this method exists for backwards compatibility only, don't use
 
 
     // this method exists for backwards compatibility only, don't use
-    bool HasPendingMessages() const { return TRUE; }
+    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
+
+    // don't use integer masks any more, use string trace masks instead
+#if WXWIN_COMPATIBILITY_2_8
+    wxDEPRECATED_INLINE( static void SetTraceMask(wxTraceMask ulMask),
+        ms_ulTraceMask = ulMask; )
+    wxDEPRECATED_BUT_USED_INTERNALLY_INLINE( static wxTraceMask GetTraceMask(),
+        return ms_ulTraceMask; )
+#endif // WXWIN_COMPATIBILITY_2_8
 
 protected:
 
 protected:
-    // the logging functions that can be overriden
-        // default DoLog() prepends the time stamp and a prefix corresponding
-        // to the message to szString and then passes it to DoLogString()
-    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
-        // default DoLogString does nothing but is not pure virtual because if
-        // you override DoLog() you might not need it at all
-    virtual void DoLogString(const wxChar *szString, time_t t);
+    // the logging functions that can be overridden
+
+    // default DoLog() prepends the time stamp and a prefix corresponding
+    // to the message to szString and then passes it to DoLogString()
+    virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
+#if WXWIN_COMPATIBILITY_2_8
+    // these shouldn't be used by new code
+    wxDEPRECATED_BUT_USED_INTERNALLY(
+        virtual void DoLog(wxLogLevel level, const char *szString, time_t t)
+    );
+
+    wxDEPRECATED_BUT_USED_INTERNALLY(
+        virtual void DoLog(wxLogLevel level, const wchar_t *wzString, time_t t)
+    );
+#endif // WXWIN_COMPATIBILITY_2_8
+
+    void LogString(const wxString& szString, time_t t)
+        { DoLogString(szString, t); }
+
+    // default DoLogString does nothing but is not pure virtual because if
+    // you override DoLog() you might not need it at all
+    virtual void DoLogString(const wxString& szString, time_t t);
+#if WXWIN_COMPATIBILITY_2_8
+    // these shouldn't be used by new code
+    virtual void DoLogString(const char *WXUNUSED(szString),
+                             time_t WXUNUSED(t)) {}
+    virtual void DoLogString(const wchar_t *WXUNUSED(szString),
+                             time_t WXUNUSED(t)) {}
+#endif // WXWIN_COMPATIBILITY_2_8
+
+    // this macro should be used in the derived classes to avoid warnings about
+    // hiding the other DoLog() overloads when overriding DoLog(wxString) --
+    // but don't use it with MSVC which doesn't give this warning but does give
+    // warning when a deprecated function is overridden
+#if WXWIN_COMPATIBILITY_2_8 && !defined(__VISUALC__)
+    #define wxSUPPRESS_DOLOG_HIDE_WARNING()                                   \
+        virtual void DoLog(wxLogLevel, const char *, time_t) { }              \
+        virtual void DoLog(wxLogLevel, const wchar_t *, time_t) { }
+
+    #define wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()                             \
+        virtual void DoLogString(const char *, time_t) { }                    \
+        virtual void DoLogString(const wchar_t *, time_t) { }
+#else
+    #define wxSUPPRESS_DOLOG_HIDE_WARNING()
+    #define wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
+#endif
+
+    // log a message indicating the number of times the previous message was
+    // repeated if ms_prevCounter > 0, does nothing otherwise; return the old
+    // value of ms_prevCounter
+    unsigned LogLastRepeatIfNeeded();
 
 private:
 
 private:
+    // implement of LogLastRepeatIfNeeded(): it assumes that the
+    // caller had already locked ms_prevCS
+    unsigned LogLastRepeatIfNeededUnlocked();
+
     // static variables
     // ----------------
 
     // static variables
     // ----------------
 
+    // if true, don't log the same message multiple times, only log it once
+    // with the number of times it was repeated
+    static bool        ms_bRepetCounting;
+
+    static wxString    ms_prevString;   // previous message that was logged
+    static unsigned    ms_prevCounter;  // how many times it was repeated
+    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 wxLog      *ms_pLogger;      // currently active log sink
-    static bool        ms_doLog;        // FALSE => all logging disabled
+    static bool        ms_doLog;        // false => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
     static bool        ms_bAutoCreate;  // create new log targets on demand?
-    static bool        ms_bVerbose;     // FALSE => ignore LogInfo messages
+    static bool        ms_bVerbose;     // false => ignore LogInfo messages
 
     static wxLogLevel  ms_logLevel;     // limit logging to levels <= ms_logLevel
 
     static size_t      ms_suspendCount; // if positive, logs are not flushed
 
 
     static wxLogLevel  ms_logLevel;     // limit logging to levels <= ms_logLevel
 
     static size_t      ms_suspendCount; // if positive, logs are not flushed
 
-    // format string for strftime(), if NULL, time stamping log messages is
+    // format string for strftime(), if empty, time stamping log messages is
     // disabled
     // disabled
-    static const wxChar *ms_timestamp;
+    static wxString    ms_timestamp;
 
 
+#if WXWIN_COMPATIBILITY_2_8
     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
-    static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
+#endif // WXWIN_COMPATIBILITY_2_8
+
+    // currently enabled trace masks
+    static wxArrayString ms_aTraceMasks;
 };
 
 // ----------------------------------------------------------------------------
 // "trivial" derivations of wxLog
 // ----------------------------------------------------------------------------
 
 };
 
 // ----------------------------------------------------------------------------
 // "trivial" derivations of wxLog
 // ----------------------------------------------------------------------------
 
+// log everything except for the debug/trace messages (which are passed to
+// wxMessageOutputDebug) to a buffer
+class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
+{
+public:
+    wxLogBuffer() { }
+
+    // get the string contents with all messages logged
+    const wxString& GetBuffer() const { return m_str; }
+
+    // show the buffer contents to the user in the best possible way (this uses
+    // wxMessageOutputMessageBox) and clear it
+    virtual void Flush();
+
+protected:
+#if wxUSE_LOG_DEBUG || wxUSE_LOG_TRACE
+    virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOG_HIDE_WARNING()
+#endif // wxUSE_LOG_DEBUG || wxUSE_LOG_TRACE
+
+    virtual void DoLogString(const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
+
+private:
+    wxString m_str;
+
+    wxDECLARE_NO_COPY_CLASS(wxLogBuffer);
+};
+
+
 // 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
 {
-    DECLARE_NO_COPY_CLASS(wxLogStderr)
-
 public:
     // redirect log output to a FILE
 public:
     // redirect log output to a FILE
-    wxLogStderr(FILE *fp = (FILE *) NULL);
+    wxLogStderr(FILE *fp = NULL);
 
 protected:
     // implement sink function
 
 protected:
     // implement sink function
-    virtual void DoLogString(const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
 
     FILE *m_fp;
 
     FILE *m_fp;
+
+    wxDECLARE_NO_COPY_CLASS(wxLogStderr);
 };
 
 #if wxUSE_STD_IOSTREAM
 };
 
 #if wxUSE_STD_IOSTREAM
@@ -290,7 +424,9 @@ public:
 
 protected:
     // implement sink function
 
 protected:
     // implement sink function
-    virtual void DoLogString(const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
 
     // using ptr here to avoid including <iostream.h> from this file
     wxSTD ostream *m_ostr;
 
     // using ptr here to avoid including <iostream.h> from this file
     wxSTD ostream *m_ostr;
@@ -321,7 +457,7 @@ protected:
 class WXDLLIMPEXP_BASE wxLogNull
 {
 public:
 class WXDLLIMPEXP_BASE wxLogNull
 {
 public:
-    wxLogNull() : m_flagOld(wxLog::EnableLogging(FALSE)) { }
+    wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }
     ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
 
 private:
     ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
 
 private:
@@ -359,9 +495,14 @@ public:
     // override base class version to flush the old logger as well
     virtual void Flush();
 
     // override base class version to flush the old logger as well
     virtual void Flush();
 
+    // call to avoid destroying the old log target
+    void DetachOldLog() { m_logOld = NULL; }
+
 protected:
     // pass the chain to the old logger if needed
 protected:
     // pass the chain to the old logger if needed
-    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+    virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
+
+    wxSUPPRESS_DOLOG_HIDE_WARNING()
 
 private:
     // the current log target
 
 private:
     // the current log target
@@ -373,14 +514,32 @@ private:
     // do we pass the messages to the old logger?
     bool m_bPassMessages;
 
     // do we pass the messages to the old logger?
     bool m_bPassMessages;
 
-    DECLARE_NO_COPY_CLASS(wxLogChain)
+    wxDECLARE_NO_COPY_CLASS(wxLogChain);
 };
 
 // a chain log target which uses itself as the new logger
 };
 
 // a chain log target which uses itself as the new logger
-class WXDLLIMPEXP_BASE wxLogPassThrough : public wxLogChain
+
+#define wxLogPassThrough wxLogInterposer
+
+class WXDLLIMPEXP_BASE wxLogInterposer : public wxLogChain
 {
 public:
 {
 public:
-    wxLogPassThrough();
+    wxLogInterposer();
+
+private:
+    wxDECLARE_NO_COPY_CLASS(wxLogInterposer);
+};
+
+// a temporary interposer which doesn't destroy the old log target
+// (calls DetachOldLog)
+
+class WXDLLIMPEXP_BASE wxLogInterposerTemp : public wxLogChain
+{
+public:
+    wxLogInterposerTemp();
+
+private:
+    wxDECLARE_NO_COPY_CLASS(wxLogInterposerTemp);
 };
 
 #if wxUSE_GUI
 };
 
 #if wxUSE_GUI
@@ -412,29 +571,117 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 // ----------------------------------------------------------------------------
 
 #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
-#define DECLARE_LOG_FUNCTION2_EXP(level, arg, expdecl)                      \
-extern void expdecl wxVLog##level(arg, const wxChar *szFormat,              \
-                                      va_list argptr);                      \
-extern void expdecl wxLog##level(arg, const wxChar *szFormat,               \
-                                     ...) ATTRIBUTE_PRINTF_2
-#define DECLARE_LOG_FUNCTION2(level, arg)                                   \
-    DECLARE_LOG_FUNCTION2_EXP(level, arg, WXDLLIMPEXP_BASE)
+    extern void WXDLLIMPEXP_BASE                                            \
+    wxDoLog##level##Wchar(const wxChar *format, ...);                       \
+    extern void WXDLLIMPEXP_BASE                                            \
+    wxDoLog##level##Utf8(const char *format, ...);                          \
+    WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
+                               1, (const wxFormatString&),                  \
+                               wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
+    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_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const wxString&),                    \
+                                   (wxFormatString(f1)))                    \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const wxCStrData&),                  \
+                                   (wxFormatString(f1)))                    \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const char*),                        \
+                                   (wxFormatString(f1)))                    \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   1, (const wchar_t*),                     \
+                                   (wxFormatString(f1)))
+#else
+    #define DECLARE_LOG_FUNCTION_WATCOM(level)
+#endif
+
+
+#define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
+    extern void expdecl wxDoLog##level##Wchar(argclass arg,                 \
+                                              const wxChar *format, ...);   \
+    extern void expdecl wxDoLog##level##Utf8(argclass arg,                  \
+                                             const char *format, ...);      \
+    WX_DEFINE_VARARG_FUNC_VOID(wxLog##level,                                \
+                               2, (argclass, const wxFormatString&),        \
+                               wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
+    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_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   2, (argclass, const wxString&),          \
+                                   (f1, wxFormatString(f2)))                \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   2, (argclass, const wxCStrData&),        \
+                                   (f1, wxFormatString(f2)))                \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   2, (argclass, const char*),              \
+                                   (f1, wxFormatString(f2)))                \
+        WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level,                     \
+                                   2, (argclass, const wchar_t*),           \
+                                   (f1, wxFormatString(f2)))
+#else
+    #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)
+#endif
+
 
 #else // !wxUSE_LOG
 
 
 #else // !wxUSE_LOG
 
+#undef wxUSE_LOG_DEBUG
+#define wxUSE_LOG_DEBUG 0
+
+#undef wxUSE_LOG_TRACE
+#define wxUSE_LOG_TRACE 0
+
+#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
+
+#if defined(__WATCOMC__) || defined(__MINGW32__)
+    // Mingw has similar problem with wxLogSysError:
+    #define WX_WATCOM_OR_MINGW_ONLY_CODE( x )  x
+#else
+    #define WX_WATCOM_OR_MINGW_ONLY_CODE( x )
+#endif
+
 // log functions do nothing at all
 #define DECLARE_LOG_FUNCTION(level)                                         \
 // log functions do nothing at all
 #define DECLARE_LOG_FUNCTION(level)                                         \
-inline void wxVLog##level(const wxChar *szFormat,                           \
-                                     va_list argptr) { }                    \
-inline void wxLog##level(const wxChar *szFormat, ...) { }
-#define DECLARE_LOG_FUNCTION2(level, arg)                                   \
-inline void wxVLog##level(arg, const wxChar *szFormat,                      \
-                                     va_list argptr) {}                     \
-inline void wxLog##level(arg, const wxChar *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)            \
+    WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxString&)) \
+    WX_WATCOM_OR_MINGW_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)) {}
 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull
 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull
@@ -448,12 +695,23 @@ public:
 #define wxSysErrorMsg( X ) (const wxChar*)NULL
 
 // Fake symbolic trace masks... for those that are used frequently
 #define wxSysErrorMsg( X ) (const wxChar*)NULL
 
 // Fake symbolic trace masks... for those that are used frequently
-#define wxTRACE_OleCalls wxT("") // OLE interface calls
+#define wxTRACE_OleCalls wxEmptyString // OLE interface calls
 
 #endif // wxUSE_LOG/!wxUSE_LOG
 
 
 #endif // wxUSE_LOG/!wxUSE_LOG
 
+#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
+    #pragma warning(push)
+    // "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)
 // a generic function for all levels (level is passes as parameter)
-DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
+DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);
 
 // one function per each level
 DECLARE_LOG_FUNCTION(FatalError);
 
 // one function per each level
 DECLARE_LOG_FUNCTION(FatalError);
@@ -469,8 +727,9 @@ DECLARE_LOG_FUNCTION(Status);
 
 #if wxUSE_GUI
     // this one is the same as previous except that it allows to explicitly
 
 #if wxUSE_GUI
     // this one is the same as previous except that it allows to explicitly
+    class WXDLLIMPEXP_FWD_CORE wxFrame;
     // specify the frame to which the output should go
     // specify the frame to which the output should go
-    DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *pFrame, WXDLLIMPEXP_CORE);
+    DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *pFrame, WXDLLIMPEXP_CORE);
 #endif // wxUSE_GUI
 
 // additional one: as wxLogError, but also logs last system call error code
 #endif // wxUSE_GUI
 
 // additional one: as wxLogError, but also logs last system call error code
@@ -479,34 +738,89 @@ 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))
 
 // 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);
+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_DEBUG
-    DECLARE_LOG_FUNCTION(Debug);
 
 
-    // first kind of LogTrace is unconditional: it doesn't check the level,
-    DECLARE_LOG_FUNCTION(Trace);
+// debug functions can be completely disabled in optimized builds
+
+// if these log functions are disabled, we prefer to define them as (empty)
+// variadic macros as this completely removes them and their argument
+// evaluation from the object code but if this is not supported by compiler we
+// use empty inline functions instead (defining them as nothing would result in
+// compiler warnings)
+//
+// 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
+#ifdef __BORLANDC__
+    // but Borland gives "W8019: Code has no effect" for wxLogNop() so we need
+    // to define it differently for it to avoid these warnings (same problem as
+    // with wxUnusedVar())
+    #define wxLogNop() { }
+#else
+    inline void wxLogNop() { }
+#endif
 
 
-    // this second version will only log the message if the mask had been
-    // added to the list of masks with AddTraceMask()
-    DECLARE_LOG_FUNCTION2(Trace, const wxChar *mask);
+#if wxUSE_LOG_DEBUG
+    DECLARE_LOG_FUNCTION(Debug);
+#else // !wxUSE_LOG_DEBUG
+    #define wxVLogDebug(fmt, valist) wxLogNop()
+
+    #ifdef HAVE_VARIADIC_MACROS
+        #define wxLogDebug(fmt, ...) wxLogNop()
+    #else // !HAVE_VARIADIC_MACROS
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug, 1, (const wxString&))
+    #endif
+#endif // wxUSE_LOG_DEBUG/!wxUSE_LOG_DEBUG
+
+#if wxUSE_LOG_TRACE
+    // this version only logs the message if the mask had been added to the
+    // list of masks with AddTraceMask()
+    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
 
 
-    // the last one does nothing if all of level bits are not set
-    // in wxLog::GetActive()->GetTraceMask() - it's deprecated in favour of
+    // 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
     // string identifiers
-    DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
-#else   //!debug
-    // these functions do nothing in release builds
-    inline void wxVLogDebug(const wxChar *, va_list) { }
-    inline void wxLogDebug(const wxChar *, ...) { }
-    inline void wxVLogTrace(const wxChar *, va_list) { }
-    inline void wxLogTrace(const wxChar *, ...) { }
-    inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }
-    inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
-    inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }
-    inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }
-#endif // debug/!debug
+#if WXWIN_COMPATIBILITY_2_8
+    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
+#endif // WXWIN_COMPATIBILITY_2_8
+
+#else  // !wxUSE_LOG_TRACE
+    #define wxVLogTrace(mask, fmt, valist) wxLogNop()
+
+    #ifdef HAVE_VARIADIC_MACROS
+        #define wxLogTrace(mask, fmt, ...) wxLogNop()
+    #else // !HAVE_VARIADIC_MACROS
+        #if WXWIN_COMPATIBILITY_2_8
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (wxTraceMask, const wxString&))
+        #endif
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wxString&, const wxString&))
+        #ifdef __WATCOMC__
+        // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const char*, const char*))
+        WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wchar_t*, const wchar_t*))
+        #endif
+    #endif // HAVE_VARIADIC_MACROS/!HAVE_VARIADIC_MACROS
+#endif // wxUSE_LOG_TRACE/!wxUSE_LOG_TRACE
+
+#if defined(__VISUALC__) && __VISUALC__ < 1300
+    #pragma warning(pop)
+#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
 
 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
 // i.e. without using wxMessageBox() for example because it could crash
@@ -517,28 +831,37 @@ wxSafeShowMessage(const wxString& title, const wxString& text);
 // debug only logging functions: use them with API name and error code
 // ----------------------------------------------------------------------------
 
 // debug only logging functions: use them with API name and error code
 // ----------------------------------------------------------------------------
 
-#ifdef __WXDEBUG__
+#if wxUSE_LOG_DEBUG
     // make life easier for people using VC++ IDE: clicking on the message
     // will take us immediately to the place of the failed API
 #ifdef __VISUALC__
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
     // make life easier for people using VC++ IDE: clicking on the message
     // will take us immediately to the place of the failed API
 #ifdef __VISUALC__
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
-                   __TFILE__, __LINE__, api,                                  \
+                   __FILE__, __LINE__, api,                                   \
                    (long)rc, wxSysErrorMsg(rc))
 #else // !VC++
     #define wxLogApiError(api, rc)                                            \
                    (long)rc, wxSysErrorMsg(rc))
 #else // !VC++
     #define wxLogApiError(api, rc)                                            \
-        wxLogDebug(wxT("In file %s at line %d: '%s' failed with "             \
-                       "error 0x%08lx (%s)."),                                \
-                   __TFILE__, __LINE__, api,                                  \
+        wxLogDebug(wxT("In file %s at line %d: '%s' failed with ")            \
+                   wxT("error 0x%08lx (%s)."),                                \
+                   __FILE__, __LINE__, api,                                   \
                    (long)rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++
 
     #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 
                    (long)rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++
 
     #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 
-#else   //!debug
-    inline void wxLogApiError(const wxChar *, long) { }
-    inline void wxLogLastError(const wxChar *) { }
-#endif  //debug/!debug
+#else // !wxUSE_LOG_DEBUG
+    #define wxLogApiError(api, err) wxLogNop()
+    #define wxLogLastError(api) wxLogNop()
+#endif // wxUSE_LOG_DEBUG/!wxUSE_LOG_DEBUG
+
+// wxCocoa has additiional trace masks
+#if defined(__WXCOCOA__)
+#include "wx/cocoa/log.h"
+#endif
+
+#ifdef WX_WATCOM_ONLY_CODE
+    #undef WX_WATCOM_ONLY_CODE
+#endif
 
 #endif  // _WX_LOG_H_
 
 
 #endif  // _WX_LOG_H_