add a note about changing selection background colour

[wxWidgets.git] / src / common / log.cpp

diff --git a/src/common/log.cpp b/src/common/log.cpp
index e2113458647e9d432e419eecf2627bb0ffbf6949..0687124fe8ab11a65d9140f9316ad257e40d5e92 100644 (file)
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -37,6 +37,7 @@
 #endif //WX_PRECOMP
 
 #include "wx/apptrait.h"
 #endif //WX_PRECOMP
 
 #include "wx/apptrait.h"

+#include "wx/datetime.h"

 #include "wx/file.h"
 #include "wx/msgout.h"
 #include "wx/textfile.h"
 #include "wx/file.h"
 #include "wx/msgout.h"
 #include "wx/textfile.h"


@@ -75,27 +76,6 @@
 // implementation
 // ============================================================================
 
 // 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
-

 // ----------------------------------------------------------------------------
 // implementation of Log functions
 //
 // ----------------------------------------------------------------------------
 // implementation of Log functions
 //


@@ -103,26 +83,11 @@ static wxCriticalSection gs_csLogBuf;
 //     macros and not all compilers inline vararg functions.
 // ----------------------------------------------------------------------------
 
 //     macros and not all compilers inline vararg functions.
 // ----------------------------------------------------------------------------
 

-// wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it
-static inline void PrintfInLogBuf(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)
 {
     if ( wxLog::IsEnabled() ) {
 // generic log function
 void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr)
 {
     if ( wxLog::IsEnabled() ) {

-        wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-        PrintfInLogBuf(szFormat, argptr);
-
-        wxLog::OnLog(level, s_szBuf, time(NULL));
+        wxLog::OnLog(level, wxString::FormatV(szFormat, argptr), time(NULL));

     }
 }
 
     }
 }
 


@@ -138,11 +103,8 @@ void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
   void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
   {                                                                 \
     if ( wxLog::IsEnabled() ) {                                     \
   void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
   {                                                                 \
     if ( wxLog::IsEnabled() ) {                                     \

-      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                      \
-                                                                    \
-      PrintfInLogBuf(szFormat, argptr);                             \
-                                                                    \
-      wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));             \
+      wxLog::OnLog(wxLOG_##level,                                   \
+                   wxString::FormatV(szFormat, argptr), time(NULL));\

     }                                                               \
   }                                                                 \
                                                                     \
     }                                                               \
   }                                                                 \
                                                                     \


@@ -174,9 +136,7 @@ void wxSafeShowMessage(const wxString& title, const wxString& text)
 // always terminate the program
 void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
 {
 // always terminate the program
 void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
 {

-    wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-    wxSafeShowMessage(_T("Fatal Error"), s_szBuf);
+    wxSafeShowMessage(_T("Fatal Error"), wxString::FormatV(szFormat, argptr));

 
 #ifdef __WXWINCE__
     ExitThread(3);
 
 #ifdef __WXWINCE__
     ExitThread(3);


@@ -201,11 +161,8 @@ void wxVLogVerbose(const wxChar *szFormat, va_list argptr)
 {
     if ( wxLog::IsEnabled() ) {
         if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
 {
     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(szFormat, argptr), time(NULL));

         }
     }
 }
         }
     }
 }


@@ -224,13 +181,11 @@ void wxLogVerbose(const wxChar *szFormat, ...)
   void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
   {                                                                 \
     if ( wxLog::IsEnabled() ) {                                     \
   void wxVLog##level(const wxChar *szFormat, va_list argptr)        \
   {                                                                 \
     if ( wxLog::IsEnabled() ) {                                     \

-      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                      \
-                                                                    \
-      wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);    \
-                                                                    \
-      wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));             \
+      wxLog::OnLog(wxLOG_##level,                                   \
+                   wxString::FormatV(szFormat, argptr), time(NULL));\

     }                                                               \
   }                                                                 \
     }                                                               \
   }                                                                 \

+                                                                    \

   void wxLog##level(const wxChar *szFormat, ...)                    \
   {                                                                 \
     va_list argptr;                                                 \
   void wxLog##level(const wxChar *szFormat, ...)                    \
   {                                                                 \
     va_list argptr;                                                 \


@@ -242,25 +197,10 @@ void wxLogVerbose(const wxChar *szFormat, ...)
   void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr)
   {
     if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
   void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr)
   {
     if ( wxLog::IsEnabled() && 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));
+      wxString msg;
+      msg << _T("(") << mask << _T(") ") << wxString::FormatV(szFormat, argptr);
+          
+      wxLog::OnLog(wxLOG_Trace, msg, time(NULL));

     }
   }
 
     }
   }
 


@@ -278,11 +218,7 @@ void wxLogVerbose(const wxChar *szFormat, ...)
     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
     // if both bits are set.
     if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
     // if both bits are set.
     if ( wxLog::IsEnabled() && ((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));
+      wxLog::OnLog(wxLOG_Trace, wxString::FormatV(szFormat, argptr), time(NULL));

     }
   }
 
     }
   }
 


@@ -304,26 +240,15 @@ IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
 // wxLogSysError: one uses the last error code, for other  you must give it
 // explicitly
 
 // 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 wxChar *szFormat, va_list argptr)
 {

-    if ( wxLog::IsEnabled() ) {
-        wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-        wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-        wxLogSysErrorHelper(wxSysErrorCode());
-    }
+    wxVLogSysError(wxSysErrorCode(), szFormat, argptr);

 }
 
 void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
 }
 
 void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)


@@ -334,14 +259,12 @@ void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
     va_end(argptr);
 }
 
     va_end(argptr);
 }
 

-void WXDLLEXPORT wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr)
+void WXDLLEXPORT wxVLogSysError(long err, const wxChar *fmt, va_list argptr)

 {
     if ( wxLog::IsEnabled() ) {
 {
     if ( wxLog::IsEnabled() ) {

-        wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
-        wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
-
-        wxLogSysErrorHelper(lErrCode);
+        wxLog::OnLog(wxLOG_Error,
+                     wxString::FormatV(fmt, argptr) + wxLogSysErrorHelper(err),
+                     time(NULL));

     }
 }
 
     }
 }
 


@@ -357,24 +280,76 @@ void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
 // wxLog class implementation
 // ----------------------------------------------------------------------------
 
 // 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 ) {
 wxLog *wxLog::GetActiveTarget()
 {
     if ( ms_bAutoCreate && ms_pLogger == NULL ) {


@@ -437,16 +412,21 @@ void wxLog::ClearTraceMasks()
 
 void wxLog::TimeStamp(wxString *str)
 {
 
 void wxLog::TimeStamp(wxString *str)
 {

+#if wxUSE_DATETIME

     if ( ms_timestamp )
     {
         wxChar buf[256];
         time_t timeNow;
         (void)time(&timeNow);
     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(": ");
     }
 
         str->Empty();
         *str << buf << wxT(": ");
     }

+#endif // wxUSE_DATETIME

 }
 
 void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 }
 
 void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)


@@ -575,8 +555,8 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
     TimeStamp(&str);
     str << szString;
 
     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
     fflush(m_fp);
 
     // under GUI systems such as Windows or Mac, programs usually don't have


@@ -696,6 +676,12 @@ wxLogPassThrough::wxLogPassThrough()
 // static variables
 // ----------------------------------------------------------------------------
 
 // 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;
 wxLog          *wxLog::ms_pLogger      = (wxLog *)NULL;
 bool            wxLog::ms_doLog        = true;
 bool            wxLog::ms_bAutoCreate  = true;


@@ -768,7 +754,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
         nErrCode = wxSysErrorCode();
 
 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
         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;
 
     // get error message from system
     LPVOID lpMsgBuf;


@@ -810,21 +796,22 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
         }
     }
     else
         }
     }
     else

-#endif
+#endif // !__SMARTPHONE__

     {
         s_szBuf[0] = wxT('\0');
     }
 
     return s_szBuf;
     {
         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
 }
 
 #endif // wxUSE_LOG