X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/59a14f698460525b36e6a6e63876e1a6723865b4..0bbe61b8c18a1795189f0cf73cc61c14a0fb846d:/src/common/log.cpp

diff --git a/src/common/log.cpp b/src/common/log.cpp
index 8c477ef29c..9cdf13a271 100644
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -42,7 +42,7 @@
 #include "wx/msgout.h"
 #include "wx/textfile.h"
 #include "wx/thread.h"
-#include "wx/wxchar.h"
+#include "wx/crt.h"
 
 // other standard headers
 #ifndef __WXWINCE__
@@ -51,16 +51,42 @@
 
 #include <stdlib.h>
 
+#ifndef __WXPALMOS5__
 #ifndef __WXWINCE__
 #include <time.h>
 #else
 #include "wx/msw/wince/time.h"
 #endif
+#endif /* ! __WXPALMOS5__ */
 
 #if defined(__WINDOWS__)
     #include "wx/msw/private.h" // includes windows.h
 #endif
 
+#if wxUSE_THREADS
+
+// define static functions providing access to the critical sections we use
+// instead of just using static critical section variables as log functions may
+// be used during static initialization and while this is certainly not
+// advisable it's still better to not crash (as we'd do if we used a yet
+// uninitialized critical section) if it happens
+
+static inline wxCriticalSection& GetTraceMaskCS()
+{
+    static wxCriticalSection s_csTrace;
+
+    return s_csTrace;
+}
+
+static inline wxCriticalSection& GetPreviousLogCS()
+{
+    static wxCriticalSection s_csPrev;
+
+    return s_csPrev;
+}
+
+#endif // wxUSE_THREADS
+
 // ----------------------------------------------------------------------------
 // non member functions
 // ----------------------------------------------------------------------------
@@ -157,9 +183,9 @@ IMPLEMENT_LOG_FUNCTION(Status)
 void wxSafeShowMessage(const wxString& title, const wxString& text)
 {
 #ifdef __WINDOWS__
-    ::MessageBox(NULL, text, title, MB_OK | MB_ICONSTOP);
+    ::MessageBox(NULL, text.wx_str(), title.wx_str(), MB_OK | MB_ICONSTOP);
 #else
-    wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str());
+    wxFprintf(stderr, wxS("%s: %s\n"), title.c_str(), text.c_str());
     fflush(stderr);
 #endif
 }
@@ -168,7 +194,7 @@ void wxSafeShowMessage(const wxString& title, const wxString& text)
 // always terminate the program
 void wxVLogFatalError(const wxString& format, va_list argptr)
 {
-    wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(format, argptr));
+    wxSafeShowMessage(wxS("Fatal Error"), wxString::FormatV(format, argptr));
 
 #ifdef __WXWINCE__
     ExitThread(3);
@@ -279,7 +305,7 @@ void wxDoLogVerboseUtf8(const char *format, ...)
   {
     if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
       wxString msg;
-      msg << _T("(") << mask << _T(") ") << wxString::FormatV(format, argptr);
+      msg << wxS("(") << mask << wxS(") ") << wxString::FormatV(format, argptr);
 
       wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
     }
@@ -385,13 +411,13 @@ static inline wxString wxLogSysErrorHelper(long err)
     return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
 }
 
-void WXDLLEXPORT wxVLogSysError(const wxString& format, va_list argptr)
+void WXDLLIMPEXP_BASE wxVLogSysError(const wxString& format, va_list argptr)
 {
     wxVLogSysError(wxSysErrorCode(), format, argptr);
 }
 
 #if !wxUSE_UTF8_LOCALE_ONLY
-void WXDLLEXPORT wxDoLogSysErrorWchar(const wxChar *format, ...)
+void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(const wxChar *format, ...)
 {
     va_list argptr;
     va_start(argptr, format);
@@ -401,7 +427,7 @@ void WXDLLEXPORT wxDoLogSysErrorWchar(const wxChar *format, ...)
 #endif // !wxUSE_UTF8_LOCALE_ONLY
 
 #if wxUSE_UNICODE_UTF8
-void WXDLLEXPORT wxDoLogSysErrorUtf8(const char *format, ...)
+void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(const char *format, ...)
 {
     va_list argptr;
     va_start(argptr, format);
@@ -410,7 +436,7 @@ void WXDLLEXPORT wxDoLogSysErrorUtf8(const char *format, ...)
 }
 #endif // wxUSE_UNICODE_UTF8
 
-void WXDLLEXPORT wxVLogSysError(long err, const wxString& format, va_list argptr)
+void WXDLLIMPEXP_BASE wxVLogSysError(long err, const wxString& format, va_list argptr)
 {
     if ( wxLog::IsEnabled() ) {
         wxLog::OnLog(wxLOG_Error,
@@ -420,7 +446,7 @@ void WXDLLEXPORT wxVLogSysError(long err, const wxString& format, va_list argptr
 }
 
 #if !wxUSE_UTF8_LOCALE_ONLY
-void WXDLLEXPORT wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
+void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
 {
     va_list argptr;
     va_start(argptr, format);
@@ -430,7 +456,7 @@ void WXDLLEXPORT wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
 #endif // !wxUSE_UTF8_LOCALE_ONLY
 
 #if wxUSE_UNICODE_UTF8
-void WXDLLEXPORT wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
+void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
 {
     va_list argptr;
     va_start(argptr, format);
@@ -441,7 +467,7 @@ void WXDLLEXPORT wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
 
 #ifdef __WATCOMC__
 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
-void WXDLLEXPORT wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...)
+void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...)
 {
     va_list argptr;
     va_start(argptr, format);
@@ -449,7 +475,7 @@ void WXDLLEXPORT wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *form
     va_end(argptr);
 }
 
-void WXDLLEXPORT wxVLogSysError(unsigned long err, const wxString& format, va_list argptr)
+void WXDLLIMPEXP_BASE wxVLogSysError(unsigned long err, const wxString& format, va_list argptr)
     { wxVLogSysError((long)err, format, argptr); }
 #endif // __WATCOMC__
 
@@ -457,12 +483,18 @@ void WXDLLEXPORT wxVLogSysError(unsigned long err, const wxString& format, va_li
 // wxLog class implementation
 // ----------------------------------------------------------------------------
 
-/* static */
-unsigned wxLog::DoLogNumberOfRepeats()
+unsigned wxLog::LogLastRepeatIfNeeded()
+{
+    wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS());
+
+    return LogLastRepeatIfNeededUnlocked();
+}
+
+unsigned wxLog::LogLastRepeatIfNeededUnlocked()
 {
-    long retval = ms_prevCounter;
-    wxLog *pLogger = GetActiveTarget();
-    if ( pLogger && ms_prevCounter > 0 )
+    const unsigned count = ms_prevCounter;
+
+    if ( ms_prevCounter )
     {
         wxString msg;
 #if wxUSE_INTL
@@ -471,48 +503,62 @@ unsigned wxLog::DoLogNumberOfRepeats()
                             ms_prevCounter),
                    ms_prevCounter);
 #else
-        msg.Printf(wxT("The previous message was repeated."));
+        msg.Printf(wxS("The previous message was repeated %lu times."),
+                   ms_prevCounter);
 #endif
         ms_prevCounter = 0;
         ms_prevString.clear();
-        pLogger->DoLog(ms_prevLevel, msg.c_str(), ms_prevTimeStamp);
+        DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
     }
-    return retval;
+
+    return count;
 }
 
 wxLog::~wxLog()
 {
-    if ( ms_prevCounter > 0 )
+    // Flush() must be called before destroying the object as otherwise some
+    // messages could be lost
+    if ( ms_prevCounter )
     {
-        // looks like the repeat count has not been logged yet,
-        // so let's do it now
-        wxLog::DoLogNumberOfRepeats();
+        wxMessageOutputDebug().Printf
+        (
+            wxS("Last repeated message (\"%s\", %lu times) wasn't output"),
+            ms_prevString,
+            ms_prevCounter
+        );
     }
 }
 
 /* static */
-void wxLog::OnLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     if ( IsEnabled() && ms_logLevel >= level )
     {
         wxLog *pLogger = GetActiveTarget();
         if ( pLogger )
         {
-            if ( GetRepetitionCounting() && ms_prevString == szString )
-            {
-                ms_prevCounter++;
-            }
-            else
+            if ( GetRepetitionCounting() )
             {
-                if ( GetRepetitionCounting() )
+                wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS());
+
+                if ( szString == ms_prevString )
                 {
-                    DoLogNumberOfRepeats();
+                    ms_prevCounter++;
+
+                    // nothing else to do, in particular, don't log the
+                    // repeated message
+                    return;
                 }
+
+                pLogger->LogLastRepeatIfNeededUnlocked();
+
+                // reset repetition counter for a new message
                 ms_prevString = szString;
                 ms_prevLevel = level;
                 ms_prevTimeStamp = t;
-                pLogger->DoLog(level, szString, t);
             }
+
+            pLogger->DoLog(level, szString, t);
         }
     }
 }
@@ -527,6 +573,22 @@ wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
 
 #endif // WXWIN_COMPATIBILITY_2_6
 
+#if WXWIN_COMPATIBILITY_2_8
+
+void wxLog::DoLog(wxLogLevel WXUNUSED(level),
+                  const char *WXUNUSED(szString),
+                  time_t WXUNUSED(t))
+{
+}
+
+void wxLog::DoLog(wxLogLevel WXUNUSED(level),
+                  const wchar_t *WXUNUSED(wzString),
+                  time_t WXUNUSED(t))
+{
+}
+
+#endif // WXWIN_COMPATIBILITY_2_8
+
 wxLog *wxLog::GetActiveTarget()
 {
     if ( ms_bAutoCreate && ms_pLogger == NULL ) {
@@ -575,8 +637,22 @@ void wxLog::DontCreateOnDemand()
     ClearTraceMasks();
 }
 
+void wxLog::DoCreateOnDemand()
+{
+    ms_bAutoCreate = true;
+}
+
+void wxLog::AddTraceMask(const wxString& str)
+{
+    wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+    ms_aTraceMasks.push_back(str);
+}
+
 void wxLog::RemoveTraceMask(const wxString& str)
 {
+    wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
     int index = ms_aTraceMasks.Index(str);
     if ( index != wxNOT_FOUND )
         ms_aTraceMasks.RemoveAt((size_t)index);
@@ -584,13 +660,15 @@ void wxLog::RemoveTraceMask(const wxString& str)
 
 void wxLog::ClearTraceMasks()
 {
+    wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
     ms_aTraceMasks.Clear();
 }
 
 void wxLog::TimeStamp(wxString *str)
 {
 #if wxUSE_DATETIME
-    if ( ms_timestamp )
+    if ( !ms_timestamp.empty() )
     {
         wxChar buf[256];
         time_t timeNow;
@@ -601,17 +679,24 @@ void wxLog::TimeStamp(wxString *str)
                     ms_timestamp, wxLocaltime_r(&timeNow, &tm));
 
         str->Empty();
-        *str << buf << wxT(": ");
+        *str << buf << wxS(": ");
     }
 #endif // wxUSE_DATETIME
 }
 
-void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
+#if WXWIN_COMPATIBILITY_2_8
+    // DoLog() signature changed since 2.8, so we call the old versions here
+    // so that existing custom log classes still work:
+    DoLog(level, (const char*)szString.mb_str(), t);
+    DoLog(level, (const wchar_t*)szString.wc_str(), t);
+#endif
+
     switch ( level ) {
         case wxLOG_FatalError:
-            DoLogString(wxString(_("Fatal error: ")) + szString, t);
-            DoLogString(_("Program aborted."), t);
+            LogString(_("Fatal error: ") + szString, t);
+            LogString(_("Program aborted."), t);
             Flush();
 #ifdef __WXWINCE__
             ExitThread(3);
@@ -621,11 +706,11 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
             break;
 
         case wxLOG_Error:
-            DoLogString(wxString(_("Error: ")) + szString, t);
+            LogString(_("Error: ") + szString, t);
             break;
 
         case wxLOG_Warning:
-            DoLogString(wxString(_("Warning: ")) + szString, t);
+            LogString(_("Warning: ") + szString, t);
             break;
 
         case wxLOG_Info:
@@ -633,40 +718,55 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
         case wxLOG_Message:
         case wxLOG_Status:
         default:    // log unknown log levels too
-                DoLogString(szString, t);
+                LogString(szString, t);
             break;
 
         case wxLOG_Trace:
         case wxLOG_Debug:
 #ifdef __WXDEBUG__
             {
-                wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
-                                                    : wxT("Debug: ");
+                wxString msg = level == wxLOG_Trace ? wxS("Trace: ")
+                                                    : wxS("Debug: ");
                 msg << szString;
-                DoLogString(msg, t);
+                LogString(msg, t);
             }
 #endif // Debug
             break;
     }
 }
 
-void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
+void wxLog::DoLogString(const wxString& szString, time_t t)
 {
-    wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
+#if WXWIN_COMPATIBILITY_2_8
+    // DoLogString() signature changed since 2.8, so we call the old versions
+    // here so that existing custom log classes still work; unfortunately this
+    // also means that we can't have the wxFAIL_MSG below in compat mode
+    DoLogString((const char*)szString.mb_str(), t);
+    DoLogString((const wchar_t*)szString.wc_str(), t);
+#else
+    wxFAIL_MSG(wxS("DoLogString must be overriden if it's called."));
+    wxUnusedVar(szString);
+    wxUnusedVar(t);
+#endif
 }
 
 void wxLog::Flush()
 {
-    // nothing to do here
+    LogLastRepeatIfNeeded();
 }
 
-/*static*/ bool wxLog::IsAllowedTraceMask(const wxChar *mask)
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
 {
+    wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
     for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
                                   en = ms_aTraceMasks.end();
          it != en; ++it )
+    {
         if ( *it == mask)
             return true;
+    }
+
     return false;
 }
 
@@ -679,12 +779,12 @@ void wxLogBuffer::Flush()
     if ( !m_str.empty() )
     {
         wxMessageOutputBest out;
-        out.Printf(_T("%s"), m_str.c_str());
+        out.Printf(wxS("%s"), m_str.c_str());
         m_str.clear();
     }
 }
 
-void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     switch ( level )
     {
@@ -699,7 +799,7 @@ void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
                 str += szString;
 
                 wxMessageOutputDebug dbgout;
-                dbgout.Printf(_T("%s\n"), str.c_str());
+                dbgout.Printf(wxS("%s\n"), str.c_str());
             }
 #endif // __WXDEBUG__
             break;
@@ -709,9 +809,9 @@ void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
     }
 }
 
-void wxLogBuffer::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
-    m_str << szString << _T("\n");
+    m_str << szString << wxS("\n");
 }
 
 // ----------------------------------------------------------------------------
@@ -726,14 +826,14 @@ wxLogStderr::wxLogStderr(FILE *fp)
         m_fp = fp;
 }
 
-void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
     wxString str;
     TimeStamp(&str);
     str << szString;
 
     wxFputs(str, m_fp);
-    wxFputc(_T('\n'), m_fp);
+    wxFputc(wxS('\n'), m_fp);
     fflush(m_fp);
 
     // under GUI systems such as Windows or Mac, programs usually don't have
@@ -746,7 +846,7 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
         if ( traits && !traits->HasStderr() )
         {
             wxMessageOutputDebug dbgout;
-            dbgout.Printf(_T("%s\n"), str.c_str());
+            dbgout.Printf(wxS("%s\n"), str.c_str());
         }
     }
 }
@@ -765,11 +865,11 @@ wxLogStream::wxLogStream(wxSTD ostream *ostr)
         m_ostr = ostr;
 }
 
-void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
-    wxString str;
-    TimeStamp(&str);
-    (*m_ostr) << wxConvertWX2MB(str) << wxConvertWX2MB(szString) << wxSTD endl;
+    wxString stamp;
+    TimeStamp(&stamp);
+    (*m_ostr) << stamp << szString << wxSTD endl;
 }
 #endif // wxUSE_STD_IOSTREAM
 
@@ -811,7 +911,7 @@ void wxLogChain::Flush()
         m_logNew->Flush();
 }
 
-void wxLogChain::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     // let the previous logger show it
     if ( m_logOld && IsPassingMessages() )
@@ -827,18 +927,28 @@ void wxLogChain::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
     }
 }
 
-// ----------------------------------------------------------------------------
-// wxLogPassThrough
-// ----------------------------------------------------------------------------
-
 #ifdef __VISUALC__
     // "'this' : used in base member initializer list" - so what?
     #pragma warning(disable:4355)
 #endif // VC++
 
-wxLogPassThrough::wxLogPassThrough()
+// ----------------------------------------------------------------------------
+// wxLogInterposer
+// ----------------------------------------------------------------------------
+
+wxLogInterposer::wxLogInterposer()
+                : wxLogChain(this)
+{
+}
+
+// ----------------------------------------------------------------------------
+// wxLogInterposerTemp
+// ----------------------------------------------------------------------------
+
+wxLogInterposerTemp::wxLogInterposerTemp()
                 : wxLogChain(this)
 {
+    DetachOldLog();
 }
 
 #ifdef __VISUALC__
@@ -868,7 +978,7 @@ wxLogLevel      wxLog::ms_logLevel     = wxLOG_Max;  // log everything by defaul
 
 size_t          wxLog::ms_suspendCount = 0;
 
-const wxChar   *wxLog::ms_timestamp    = wxT("%X");  // time only, no date
+wxString        wxLog::ms_timestamp(wxS("%X"));  // time only, no date
 
 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 wxArrayString   wxLog::ms_aTraceMasks;
@@ -948,7 +1058,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
     {
         // if this happens, something is seriously wrong, so don't use _() here
         // for safety
-        wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode);
+        wxSprintf(s_szBuf, wxS("unknown error %lx"), nErrCode);
         return s_szBuf;
     }
 
@@ -959,7 +1069,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
     if( lpMsgBuf != 0 )
     {
         wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
-        s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
+        s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxS('\0');
 
         LocalFree(lpMsgBuf);
 
@@ -968,14 +1078,14 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
         size_t len = wxStrlen(s_szBuf);
         if ( len > 0 ) {
             // truncate string
-            if ( s_szBuf[len - 2] == wxT('\r') )
-                s_szBuf[len - 2] = wxT('\0');
+            if ( s_szBuf[len - 2] == wxS('\r') )
+                s_szBuf[len - 2] = wxS('\0');
         }
     }
     else
 #endif // !__SMARTPHONE__
     {
-        s_szBuf[0] = wxT('\0');
+        s_szBuf[0] = wxS('\0');
     }
 
     return s_szBuf;