X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/83250f1a2b8c16bd69f0cdea7cf8ffe658d66b6d..6ad0a7d52fc2a0ec7a434d1c7edb6e00d09853a4:/src/common/log.cpp

diff --git a/src/common/log.cpp b/src/common/log.cpp
index e8b718f05f..e6690b652a 100644
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        log.cpp
+// Name:        src/common/log.cpp
 // Purpose:     Assorted wxLogXXX functions, and wxLog (sink for logs)
 // Author:      Vadim Zeitlin
 // Modified by:
@@ -17,10 +17,6 @@
 // headers
 // ----------------------------------------------------------------------------
 
-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma implementation "log.h"
-#endif
-
 // For compilers that support precompilation, includes "wx.h".
 #include "wx/wxprec.h"
 
@@ -32,19 +28,20 @@
 
 // wxWidgets
 #ifndef WX_PRECOMP
+    #include "wx/log.h"
     #include "wx/app.h"
     #include "wx/arrstr.h"
     #include "wx/intl.h"
     #include "wx/string.h"
+    #include "wx/utils.h"
 #endif //WX_PRECOMP
 
 #include "wx/apptrait.h"
+#include "wx/datetime.h"
 #include "wx/file.h"
-#include "wx/log.h"
 #include "wx/msgout.h"
 #include "wx/textfile.h"
 #include "wx/thread.h"
-#include "wx/utils.h"
 #include "wx/wxchar.h"
 
 // other standard headers
@@ -79,33 +76,6 @@
 // implementation
 // ============================================================================
 
-// ----------------------------------------------------------------------------
-// globals
-// ----------------------------------------------------------------------------
-
-// log functions can't allocate memory (LogError("out of memory...") should
-// work!), so we use a static buffer for all log messages
-#define LOG_BUFFER_SIZE   (4096)
-
-// static buffer for error messages
-static wxChar   s_szBufStatic[LOG_BUFFER_SIZE];
-
-static wxChar  *s_szBuf     = s_szBufStatic;
-static size_t   s_szBufSize = WXSIZEOF( s_szBufStatic );
-
-#if wxUSE_THREADS
-
-// the critical section protecting the static buffer
-static wxCriticalSection gs_csLogBuf;
-
-#endif // wxUSE_THREADS
-
-// return true if we have a non NULL non disabled log target
-static inline bool IsLoggingEnabled()
-{
-    return wxLog::IsEnabled() && (wxLog::GetActiveTarget() != NULL);
-}
-
 // ----------------------------------------------------------------------------
 // implementation of Log functions
 //
@@ -113,30 +83,15 @@ static inline bool IsLoggingEnabled()
 //     macros and not all compilers inline vararg functions.
 // ----------------------------------------------------------------------------
 
-// wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it
-static inline void PrintfInLogBug(const wxChar *szFormat, va_list argptr)
-{
-    if ( wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr) < 0 )
-    {
-        // must NUL-terminate it manually
-        s_szBuf[s_szBufSize - 1] = _T('\0');
-    }
-    //else: NUL-terminated by vsnprintf()
-}
-
 // generic log function
-void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr)
+void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr)
 {
-    if ( IsLoggingEnabled() ) {
-        wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-        PrintfInLogBug(szFormat, argptr);
-
-        wxLog::OnLog(level, s_szBuf, time(NULL));
+    if ( wxLog::IsEnabled() ) {
+        wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL));
     }
 }
 
-void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
+void wxDoLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
 {
     va_list argptr;
     va_start(argptr, szFormat);
@@ -145,18 +100,15 @@ void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
 }
 
 #define IMPLEMENT_LOG_FUNCTION(level)                               \
-  void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
+  void wxVLog##level(const wxString& format, va_list argptr)        \
   {                                                                 \
-    if ( IsLoggingEnabled() ) {                                     \
-      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                      \
-                                                                    \
-      PrintfInLogBug(szFormat, argptr);                             \
-                                                                    \
-      wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));             \
+    if ( wxLog::IsEnabled() ) {                                     \
+      wxLog::OnLog(wxLOG_##level,                                   \
+                   wxString::FormatV(format, argptr), time(NULL));  \
     }                                                               \
   }                                                                 \
                                                                     \
-  void wxLog##level(const wxChar *szFormat, ...)                    \
+  void wxDoLog##level(const wxChar *szFormat, ...)                  \
   {                                                                 \
     va_list argptr;                                                 \
     va_start(argptr, szFormat);                                     \
@@ -176,16 +128,15 @@ void wxSafeShowMessage(const wxString& title, const wxString& text)
     ::MessageBox(NULL, text, title, MB_OK | MB_ICONSTOP);
 #else
     wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str());
+    fflush(stderr);
 #endif
 }
 
 // fatal errors can't be suppressed nor handled by the custom log target and
 // always terminate the program
-void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
+void wxVLogFatalError(const wxString& format, va_list argptr)
 {
-    wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-    wxSafeShowMessage(_T("Fatal Error"), s_szBuf);
+    wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(format, argptr));
 
 #ifdef __WXWINCE__
     ExitThread(3);
@@ -194,7 +145,7 @@ void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
 #endif
 }
 
-void wxLogFatalError(const wxChar *szFormat, ...)
+void wxDoLogFatalError(const wxChar *szFormat, ...)
 {
     va_list argptr;
     va_start(argptr, szFormat);
@@ -206,20 +157,17 @@ void wxLogFatalError(const wxChar *szFormat, ...)
 }
 
 // same as info, but only if 'verbose' mode is on
-void wxVLogVerbose(const wxChar *szFormat, va_list argptr)
+void wxVLogVerbose(const wxString& format, va_list argptr)
 {
-    if ( IsLoggingEnabled() ) {
+    if ( wxLog::IsEnabled() ) {
         if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
-            wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-            wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-            wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
+            wxLog::OnLog(wxLOG_Info,
+                         wxString::FormatV(format, argptr), time(NULL));
         }
     }
 }
 
-void wxLogVerbose(const wxChar *szFormat, ...)
+void wxDoLogVerbose(const wxChar *szFormat, ...)
 {
     va_list argptr;
     va_start(argptr, szFormat);
@@ -232,15 +180,13 @@ void wxLogVerbose(const wxChar *szFormat, ...)
 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)                         \
   void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
   {                                                                 \
-    if ( IsLoggingEnabled() ) {                                     \
-      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                      \
-                                                                    \
-      wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);    \
-                                                                    \
-      wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));             \
+    if ( wxLog::IsEnabled() ) {                                     \
+      wxLog::OnLog(wxLOG_##level,                                   \
+                   wxString::FormatV(szFormat, argptr), time(NULL));\
     }                                                               \
   }                                                                 \
-  void wxLog##level(const wxChar *szFormat, ...)                    \
+                                                                    \
+  void wxDoLog##level(const wxChar *szFormat, ...)                  \
   {                                                                 \
     va_list argptr;                                                 \
     va_start(argptr, szFormat);                                     \
@@ -248,32 +194,17 @@ void wxLogVerbose(const wxChar *szFormat, ...)
     va_end(argptr);                                                 \
   }
 
-  void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr)
+  void wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
   {
-    if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
-      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-      wxChar *p = s_szBuf;
-      size_t len = s_szBufSize;
-      wxStrncpy(s_szBuf, _T("("), len);
-      len -= 1; // strlen("(")
-      p += 1;
-      wxStrncat(p, mask, len);
-      size_t lenMask = wxStrlen(mask);
-      len -= lenMask;
-      p += lenMask;
-
-      wxStrncat(p, _T(") "), len);
-      len -= 2;
-      p += 2;
-
-      wxVsnprintf(p, len, szFormat, argptr);
-
-      wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
+    if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
+      wxString msg;
+      msg << _T("(") << mask << _T(") ") << wxString::FormatV(format, argptr);
+
+      wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
     }
   }
 
-  void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
+  void wxDoLogTrace(const wxString& mask, const wxChar *szFormat, ...)
   {
     va_list argptr;
     va_start(argptr, szFormat);
@@ -281,21 +212,17 @@ void wxLogVerbose(const wxChar *szFormat, ...)
     va_end(argptr);
   }
 
-  void wxVLogTrace(wxTraceMask mask, const wxChar *szFormat, va_list argptr)
+  void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
   {
     // we check that all of mask bits are set in the current mask, so
     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
     // if both bits are set.
-    if ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
-      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-      wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-      wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
+    if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
+      wxLog::OnLog(wxLOG_Trace, wxString::FormatV(format, argptr), time(NULL));
     }
   }
 
-  void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
+  void wxDoLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
   {
     va_list argptr;
     va_start(argptr, szFormat);
@@ -313,29 +240,18 @@ IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
 // wxLogSysError: one uses the last error code, for other  you must give it
 // explicitly
 
-// common part of both wxLogSysError
-void wxLogSysErrorHelper(long lErrCode)
+// return the system error message description
+static inline wxString wxLogSysErrorHelper(long err)
 {
-    wxChar szErrMsg[LOG_BUFFER_SIZE / 2];
-    wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg),
-               _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
-    wxStrncat(s_szBuf, szErrMsg, s_szBufSize - wxStrlen(s_szBuf));
-
-    wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
+    return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
 }
 
-void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr)
+void WXDLLEXPORT wxVLogSysError(const wxString& format, va_list argptr)
 {
-    if ( IsLoggingEnabled() ) {
-        wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-        wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-        wxLogSysErrorHelper(wxSysErrorCode());
-    }
+    wxVLogSysError(wxSysErrorCode(), format, argptr);
 }
 
-void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+void WXDLLEXPORT wxDoLogSysError(const wxChar *szFormat, ...)
 {
     va_list argptr;
     va_start(argptr, szFormat);
@@ -343,18 +259,16 @@ void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
     va_end(argptr);
 }
 
-void WXDLLEXPORT wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr)
+void WXDLLEXPORT wxVLogSysError(long err, const wxString& format, va_list argptr)
 {
-    if ( IsLoggingEnabled() ) {
-        wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-        wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-        wxLogSysErrorHelper(lErrCode);
+    if ( wxLog::IsEnabled() ) {
+        wxLog::OnLog(wxLOG_Error,
+                     wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err),
+                     time(NULL));
     }
 }
 
-void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+void WXDLLEXPORT wxDoLogSysError(long lErrCode, const wxChar *szFormat, ...)
 {
     va_list argptr;
     va_start(argptr, szFormat);
@@ -366,24 +280,76 @@ void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
 // wxLog class implementation
 // ----------------------------------------------------------------------------
 
-wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size)
+/* static */
+unsigned wxLog::DoLogNumberOfRepeats()
 {
-    wxChar *oldbuf = s_szBuf;
+    long retval = ms_prevCounter;
+    wxLog *pLogger = GetActiveTarget();
+    if ( pLogger && ms_prevCounter > 0 )
+    {
+        wxString msg;
+#if wxUSE_INTL
+        msg.Printf(wxPLURAL("The previous message repeated once.",
+                            "The previous message repeated %lu times.",
+                            ms_prevCounter),
+                   ms_prevCounter);
+#else
+        msg.Printf(wxT("The previous message was repeated."));
+#endif
+        ms_prevCounter = 0;
+        ms_prevString.clear();
+        pLogger->DoLog(ms_prevLevel, msg.c_str(), ms_prevTimeStamp);
+    }
+    return retval;
+}
 
-    if( buf == 0 )
+wxLog::~wxLog()
+{
+    if ( ms_prevCounter > 0 )
     {
-        s_szBuf = s_szBufStatic;
-        s_szBufSize = WXSIZEOF( s_szBufStatic );
+        // looks like the repeat count has not been logged yet,
+        // so let's do it now
+        wxLog::DoLogNumberOfRepeats();
     }
-    else
+}
+
+/* static */
+void wxLog::OnLog(wxLogLevel level, const wxChar *szString, time_t t)
+{
+    if ( IsEnabled() && ms_logLevel >= level )
     {
-        s_szBuf = buf;
-        s_szBufSize = size;
+        wxLog *pLogger = GetActiveTarget();
+        if ( pLogger )
+        {
+            if ( GetRepetitionCounting() && ms_prevString == szString )
+            {
+                ms_prevCounter++;
+            }
+            else
+            {
+                if ( GetRepetitionCounting() )
+                {
+                    DoLogNumberOfRepeats();
+                }
+                ms_prevString = szString;
+                ms_prevLevel = level;
+                ms_prevTimeStamp = t;
+                pLogger->DoLog(level, szString, t);
+            }
+        }
     }
+}
+
+// deprecated function
+#if WXWIN_COMPATIBILITY_2_6
 
-    return (oldbuf == s_szBufStatic ) ? 0 : oldbuf;
+wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
+{
+    return NULL;
 }
 
+#endif // WXWIN_COMPATIBILITY_2_6
+
 wxLog *wxLog::GetActiveTarget()
 {
     if ( ms_bAutoCreate && ms_pLogger == NULL ) {
@@ -446,16 +412,21 @@ void wxLog::ClearTraceMasks()
 
 void wxLog::TimeStamp(wxString *str)
 {
+#if wxUSE_DATETIME
     if ( ms_timestamp )
     {
         wxChar buf[256];
         time_t timeNow;
         (void)time(&timeNow);
-        wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
+
+        struct tm tm;
+        wxStrftime(buf, WXSIZEOF(buf),
+                    ms_timestamp, wxLocaltime_r(&timeNow, &tm));
 
         str->Empty();
         *str << buf << wxT(": ");
     }
+#endif // wxUSE_DATETIME
 }
 
 void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
@@ -550,7 +521,8 @@ void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
                 TimeStamp(&str);
                 str += szString;
 
-                wxMessageOutputDebug().Printf(_T("%s\n"), str.c_str());
+                wxMessageOutputDebug dbgout;
+                dbgout.Printf(_T("%s\n"), str.c_str());
             }
 #endif // __WXDEBUG__
             break;
@@ -583,8 +555,8 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
     TimeStamp(&str);
     str << szString;
 
-    fputs(str.mb_str(), m_fp);
-    fputc(_T('\n'), m_fp);
+    wxFputs(str, m_fp);
+    wxFputc(_T('\n'), m_fp);
     fflush(m_fp);
 
     // under GUI systems such as Windows or Mac, programs usually don't have
@@ -620,7 +592,7 @@ void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 {
     wxString str;
     TimeStamp(&str);
-    (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl;
+    (*m_ostr) << wxConvertWX2MB(str) << wxConvertWX2MB(szString) << wxSTD endl;
 }
 #endif // wxUSE_STD_IOSTREAM
 
@@ -704,6 +676,12 @@ wxLogPassThrough::wxLogPassThrough()
 // static variables
 // ----------------------------------------------------------------------------
 
+bool            wxLog::ms_bRepetCounting = false;
+wxString        wxLog::ms_prevString;
+unsigned int    wxLog::ms_prevCounter = 0;
+time_t          wxLog::ms_prevTimeStamp= 0;
+wxLogLevel      wxLog::ms_prevLevel;
+
 wxLog          *wxLog::ms_pLogger      = (wxLog *)NULL;
 bool            wxLog::ms_doLog        = true;
 bool            wxLog::ms_bAutoCreate  = true;
@@ -776,7 +754,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
         nErrCode = wxSysErrorCode();
 
 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
-    static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
+    static wxChar s_szBuf[1024];
 
     // get error message from system
     LPVOID lpMsgBuf;
@@ -794,14 +772,15 @@ 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);
-		return s_szBuf;
+        return s_szBuf;
     }
 
 
     // copy it to our buffer and free memory
     // Crashes on SmartPhone (FIXME)
 #if !defined(__SMARTPHONE__) /* of WinCE */
-     if( lpMsgBuf != 0 ) {
+    if( lpMsgBuf != 0 )
+    {
         wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
         s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
 
@@ -817,22 +796,22 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
         }
     }
     else
-#endif
+#endif // !__SMARTPHONE__
     {
         s_szBuf[0] = wxT('\0');
     }
 
     return s_szBuf;
-#else   // Unix-WXMICROWIN
-#if wxUSE_UNICODE
-    static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
-    wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
-    return s_szBuf;
-#else
-    return strerror((int)nErrCode);
-#endif
-#endif  // Win/Unix-WXMICROWIN
+#else // !__WXMSW__
+    #if wxUSE_UNICODE
+        static wchar_t s_wzBuf[1024];
+        wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
+                             WXSIZEOF(s_wzBuf) - 1);
+        return s_wzBuf;
+    #else
+        return strerror((int)nErrCode);
+    #endif
+#endif  // __WXMSW__/!__WXMSW__
 }
 
 #endif // wxUSE_LOG
-