Corrected test for _vsnprintf

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

diff --git a/src/common/log.cpp b/src/common/log.cpp
index f811d2b15d124c0117a9d8289a218e61529204f5..e0bc9a779e5417ceb072a60986b3759badfb9032 100644 (file)
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -30,17 +30,17 @@
 
 // wxWindows
 #ifndef WX_PRECOMP
 
 // wxWindows
 #ifndef WX_PRECOMP

-  #include "wx/window.h"
-  #ifdef __WXMSW__
-    #include "wx/msw/private.h"
-  #endif
-  #include  "wx/event.h"
-  #include  "wx/app.h"
-  #include  "wx/string.h"
-  #include  "wx/intl.h"
-  #ifndef wxUSE_NOGUI
-    #include "wx/msgdlg.h"
-  #endif  
+    #include "wx/string.h"
+    #include "wx/intl.h"
+    #include "wx/app.h"
+
+    #if wxUSE_GUI
+        #include "wx/window.h"
+        #ifdef __WXMSW__
+            #include "wx/msw/private.h"
+        #endif
+        #include "wx/msgdlg.h"
+    #endif

 #endif //WX_PRECOMP
 
 #include  "wx/file.h"
 #endif //WX_PRECOMP
 
 #include  "wx/file.h"


@@ -48,6 +48,7 @@
 #include  "wx/utils.h"
 #include  "wx/wxchar.h"
 #include  "wx/log.h"
 #include  "wx/utils.h"
 #include  "wx/wxchar.h"
 #include  "wx/log.h"

+#include  "wx/thread.h"

 
 // other standard headers
 #include  <errno.h>
 
 // other standard headers
 #include  <errno.h>


@@ -55,9 +56,7 @@
 #include  <time.h>
 
 #ifdef  __WXMSW__
 #include  <time.h>
 
 #ifdef  __WXMSW__

-  #include  <windows.h>
-  // Redefines OutputDebugString if necessary
-  #include  "wx/msw/private.h"
+  #include  "wx/msw/private.h"      // includes windows.h for OutputDebugString

 #else   //Unix
   #include  <signal.h>
 #endif  //Win/Unix
 #else   //Unix
   #include  <signal.h>
 #endif  //Win/Unix


@@ -78,26 +77,39 @@
 // ============================================================================
 
 // ----------------------------------------------------------------------------
 // ============================================================================
 
 // ----------------------------------------------------------------------------

-// implementation of Log functions
-//
-// NB: unfortunately we need all these distinct functions, we can't make them
-//     macros and not all compilers inline vararg functions.
+// 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)
 
 // ----------------------------------------------------------------------------
 
 // 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 (FIXME MT-unsafe)
+// static buffer for error messages

 static wxChar s_szBuf[LOG_BUFFER_SIZE];
 
 static wxChar s_szBuf[LOG_BUFFER_SIZE];
 

+#if wxUSE_THREADS
+
+// the critical section protecting the static buffer
+static wxCriticalSection gs_csLogBuf;
+
+#endif // wxUSE_THREADS
+
+// ----------------------------------------------------------------------------
+// implementation of Log functions
+//
+// NB: unfortunately we need all these distinct functions, we can't make them
+//     macros and not all compilers inline vararg functions.
+// ----------------------------------------------------------------------------
+

 // generic log function
 void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
 {
   if ( wxLog::GetActiveTarget() != NULL ) {
 // generic log function
 void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
 {
   if ( wxLog::GetActiveTarget() != NULL ) {

+    wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+

     va_list argptr;
     va_start(argptr, szFormat);
     va_list argptr;
     va_start(argptr, szFormat);

-    wxVsprintf(s_szBuf, szFormat, argptr);
+    wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);

     va_end(argptr);
 
     wxLog::OnLog(level, s_szBuf, time(NULL));
     va_end(argptr);
 
     wxLog::OnLog(level, s_szBuf, time(NULL));


@@ -108,9 +120,11 @@ void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
   void wxLog##level(const wxChar *szFormat, ...)                  \
   {                                                               \
     if ( wxLog::GetActiveTarget() != NULL ) {                     \
   void wxLog##level(const wxChar *szFormat, ...)                  \
   {                                                               \
     if ( wxLog::GetActiveTarget() != NULL ) {                     \

+      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                    \
+                                                                  \

       va_list argptr;                                             \
       va_start(argptr, szFormat);                                 \
       va_list argptr;                                             \
       va_start(argptr, szFormat);                                 \

-      wxVsprintf(s_szBuf, szFormat, argptr);                      \
+      wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);  \

       va_end(argptr);                                             \
                                                                   \
       wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));           \
       va_end(argptr);                                             \
                                                                   \
       wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));           \


@@ -129,9 +143,11 @@ void wxLogVerbose(const wxChar *szFormat, ...)
 {
   wxLog *pLog = wxLog::GetActiveTarget();
   if ( pLog != NULL && pLog->GetVerbose() ) {
 {
   wxLog *pLog = wxLog::GetActiveTarget();
   if ( pLog != NULL && pLog->GetVerbose() ) {

+    wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+

     va_list argptr;
     va_start(argptr, szFormat);
     va_list argptr;
     va_start(argptr, szFormat);

-    wxVsprintf(s_szBuf, szFormat, argptr);
+    wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);

     va_end(argptr);
 
     wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
     va_end(argptr);
 
     wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));


@@ -144,9 +160,11 @@ void wxLogVerbose(const wxChar *szFormat, ...)
   void wxLog##level(const wxChar *szFormat, ...)                  \
   {                                                               \
     if ( wxLog::GetActiveTarget() != NULL ) {                     \
   void wxLog##level(const wxChar *szFormat, ...)                  \
   {                                                               \
     if ( wxLog::GetActiveTarget() != NULL ) {                     \

+      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);                    \
+                                                                  \

       va_list argptr;                                             \
       va_start(argptr, szFormat);                                 \
       va_list argptr;                                             \
       va_start(argptr, szFormat);                                 \

-      wxVsprintf(s_szBuf, szFormat, argptr);                      \
+      wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);  \

       va_end(argptr);                                             \
                                                                   \
       wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));           \
       va_end(argptr);                                             \
                                                                   \
       wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL));           \


@@ -158,9 +176,25 @@ void wxLogVerbose(const wxChar *szFormat, ...)
     wxLog *pLog = wxLog::GetActiveTarget();
 
     if ( pLog != NULL && wxLog::IsAllowedTraceMask(mask) ) {
     wxLog *pLog = wxLog::GetActiveTarget();
 
     if ( pLog != NULL && wxLog::IsAllowedTraceMask(mask) ) {

+      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+
+      wxChar *p = s_szBuf;
+      size_t len = WXSIZEOF(s_szBuf);
+      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;
+

       va_list argptr;
       va_start(argptr, szFormat);
       va_list argptr;
       va_start(argptr, szFormat);

-      wxVsprintf(s_szBuf, szFormat, argptr);
+      wxVsnprintf(p, len, szFormat, argptr);

       va_end(argptr);
 
       wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
       va_end(argptr);
 
       wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));


@@ -175,9 +209,11 @@ void wxLogVerbose(const wxChar *szFormat, ...)
     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
     // if both bits are set.
     if ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) {
     // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
     // if both bits are set.
     if ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) {

+      wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+

       va_list argptr;
       va_start(argptr, szFormat);
       va_list argptr;
       va_start(argptr, szFormat);

-      wxVsprintf(s_szBuf, szFormat, argptr);
+      wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);

       va_end(argptr);
 
       wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
       va_end(argptr);
 
       wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));


@@ -198,7 +234,8 @@ IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
 void wxLogSysErrorHelper(long lErrCode)
 {
     wxChar szErrMsg[LOG_BUFFER_SIZE / 2];
 void wxLogSysErrorHelper(long lErrCode)
 {
     wxChar szErrMsg[LOG_BUFFER_SIZE / 2];

-    wxSprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
+    wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg),
+               _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));

     wxStrncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - wxStrlen(s_szBuf));
 
     wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
     wxStrncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - wxStrlen(s_szBuf));
 
     wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));


@@ -206,9 +243,11 @@ void wxLogSysErrorHelper(long lErrCode)
 
 void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
 {
 
 void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
 {

+    wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+

     va_list argptr;
     va_start(argptr, szFormat);
     va_list argptr;
     va_start(argptr, szFormat);

-    wxVsprintf(s_szBuf, szFormat, argptr);
+    wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);

     va_end(argptr);
 
     wxLogSysErrorHelper(wxSysErrorCode());
     va_end(argptr);
 
     wxLogSysErrorHelper(wxSysErrorCode());


@@ -216,9 +255,11 @@ void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
 
 void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
 {
 
 void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
 {

+    wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+

     va_list argptr;
     va_start(argptr, szFormat);
     va_list argptr;
     va_start(argptr, szFormat);

-    wxVsprintf(s_szBuf, szFormat, argptr);
+    wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);

     va_end(argptr);
 
     wxLogSysErrorHelper(lErrCode);
     va_end(argptr);
 
     wxLogSysErrorHelper(lErrCode);


@@ -249,15 +290,11 @@ wxLog *wxLog::GetActiveTarget()
         if ( !s_bInGetActiveTarget ) {
             s_bInGetActiveTarget = TRUE;
 
         if ( !s_bInGetActiveTarget ) {
             s_bInGetActiveTarget = TRUE;
 

-#ifdef wxUSE_NOGUI
-            ms_pLogger = new wxLogStderr;
-#else // GUI

             // ask the application to create a log target for us
             if ( wxTheApp != NULL )
                 ms_pLogger = wxTheApp->CreateLogTarget();
             else
                 ms_pLogger = new wxLogStderr;
             // ask the application to create a log target for us
             if ( wxTheApp != NULL )
                 ms_pLogger = wxTheApp->CreateLogTarget();
             else
                 ms_pLogger = new wxLogStderr;

-#endif // !GUI/GUI

 
             s_bInGetActiveTarget = FALSE;
 
 
             s_bInGetActiveTarget = FALSE;
 


@@ -299,7 +336,7 @@ void wxLog::TimeStamp(wxString *str)
         wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
 
         str->Empty();
         wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
 
         str->Empty();

-        *str << buf << _T(": ");
+        *str << buf << wxT(": ");

     }
 }
 
     }
 }
 


@@ -324,26 +361,28 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
         case wxLOG_Info:
             if ( GetVerbose() )
         case wxLOG_Message:
         case wxLOG_Info:
             if ( GetVerbose() )
         case wxLOG_Message:

+        case wxLOG_Status:

         default:    // log unknown log levels too
                 DoLogString(szString, t);
         default:    // log unknown log levels too
                 DoLogString(szString, t);

-            // fall through
-
-        case wxLOG_Status:
-            // nothing to do

             break;
 
         case wxLOG_Trace:
         case wxLOG_Debug:
 #ifdef __WXDEBUG__
             break;
 
         case wxLOG_Trace:
         case wxLOG_Debug:
 #ifdef __WXDEBUG__

-            DoLogString(szString, t);
-#endif
+            {
+                wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
+                                                    : wxT("Debug: ");
+                msg << szString;
+                DoLogString(msg, t);
+            }
+#endif // Debug

             break;
     }
 }
 
 void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
 {
             break;
     }
 }
 
 void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
 {

-    wxFAIL_MSG(_T("DoLogString must be overriden if it's called."));
+    wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));

 }
 
 void wxLog::Flush()
 }
 
 void wxLog::Flush()


@@ -367,15 +406,20 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 {
     wxString str;
     TimeStamp(&str);
 {
     wxString str;
     TimeStamp(&str);

-    str << szString << _T('\n');
+    str << szString;

 
     fputs(str.mb_str(), m_fp);
 
     fputs(str.mb_str(), m_fp);

+    fputc(_T('\n'), m_fp);

     fflush(m_fp);
 
     fflush(m_fp);
 

-    // under Windows, programs usually don't have stderr at all, so make show the
-    // messages also under debugger
-#ifdef __WXMSW__
-    OutputDebugString(str + _T('\r'));
+    // under Windows, programs usually don't have stderr at all, so show the
+    // messages also under debugger - unless it's a console program
+#if defined(__WXMSW__) && wxUSE_GUI
+    str += wxT("\r\n") ;
+    OutputDebugString(str.c_str());
+#endif // MSW
+#if defined(__WXMAC__) && wxUSE_GUI
+    debugstr(str + wxT("\r\n"));

 #endif // MSW
 }
 
 #endif // MSW
 }
 


@@ -394,7 +438,7 @@ wxLogStream::wxLogStream(ostream *ostr)
 
 void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 {
 
 void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 {

-    (*m_ostr) << wxConvCurrent->cWX2MB(szString) << endl << flush;
+    (*m_ostr) << wxConvertWX2MB(szString) << endl;

 }
 #endif // wxUSE_STD_IOSTREAM
 
 }
 #endif // wxUSE_STD_IOSTREAM
 


@@ -410,7 +454,13 @@ wxLog          *wxLog::ms_pLogger      = (wxLog *)NULL;
 bool            wxLog::ms_doLog        = TRUE;
 bool            wxLog::ms_bAutoCreate  = TRUE;
 
 bool            wxLog::ms_doLog        = TRUE;
 bool            wxLog::ms_bAutoCreate  = TRUE;
 

-const wxChar   *wxLog::ms_timestamp    = _T("%X");  // time only, no date
+size_t          wxLog::ms_suspendCount = 0;
+
+#if wxUSE_GUI
+    const wxChar *wxLog::ms_timestamp  = wxT("%X");  // time only, no date
+#else
+    const wxChar *wxLog::ms_timestamp  = NULL;       // save space
+#endif

 
 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 wxArrayString   wxLog::ms_aTraceMasks;
 
 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 wxArrayString   wxLog::ms_aTraceMasks;


@@ -491,7 +541,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 
     // copy it to our buffer and free memory
     wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
 
     // copy it to our buffer and free memory
     wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);

-    s_szBuf[WXSIZEOF(s_szBuf) - 1] = _T('\0');
+    s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');

     LocalFree(lpMsgBuf);
 
     // returned string is capitalized and ended with '\r\n' - bad
     LocalFree(lpMsgBuf);
 
     // returned string is capitalized and ended with '\r\n' - bad


@@ -499,8 +549,8 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
     size_t len = wxStrlen(s_szBuf);
     if ( len > 0 ) {
         // truncate string
     size_t len = wxStrlen(s_szBuf);
     if ( len > 0 ) {
         // truncate string

-        if ( s_szBuf[len - 2] == _T('\r') )
-            s_szBuf[len - 2] = _T('\0');
+        if ( s_szBuf[len - 2] == wxT('\r') )
+            s_szBuf[len - 2] = wxT('\0');

     }
 
     return s_szBuf;
     }
 
     return s_szBuf;


@@ -514,7 +564,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
     wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
     return s_szBuf;
 #else
     wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
     return s_szBuf;
 #else

-    return strerror(nErrCode);
+    return strerror((int)nErrCode);

 #endif
 #endif  // Win/Unix
 }
 #endif
 #endif  // Win/Unix
 }


@@ -565,36 +615,35 @@ void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg)
 
     // make life easier for people using VC++ IDE: clicking on the message
     // will take us immediately to the place of the failed assert
 
     // make life easier for people using VC++ IDE: clicking on the message
     // will take us immediately to the place of the failed assert

+    wxSnprintf(szBuf, WXSIZEOF(szBuf),

 #ifdef __VISUALC__
 #ifdef __VISUALC__

-    wxSprintf(szBuf, _T("%s(%d): assert failed"), szFile, nLine);
+               wxT("%s(%d): assert failed"),

 #else  // !VC++
     // make the error message more clear for all the others
 #else  // !VC++
     // make the error message more clear for all the others

-    wxSprintf(szBuf, _T("Assert failed in file %s at line %d"), szFile, nLine);
+               wxT("Assert failed in file %s at line %d"),

 #endif // VC/!VC
 #endif // VC/!VC

+               szFile, nLine);

 
     if ( szMsg != NULL ) {
 
     if ( szMsg != NULL ) {

-        wxStrcat(szBuf, _T(": "));
+        wxStrcat(szBuf, wxT(": "));

         wxStrcat(szBuf, szMsg);
     }
     else {
         wxStrcat(szBuf, szMsg);
     }
     else {

-        wxStrcat(szBuf, _T("."));
+        wxStrcat(szBuf, wxT("."));

     }
 
     if ( !s_bNoAsserts ) {
         // send it to the normal log destination
         wxLogDebug(szBuf);
 
     }
 
     if ( !s_bNoAsserts ) {
         // send it to the normal log destination
         wxLogDebug(szBuf);
 

-#if wxUSE_NOGUI
-        Trap();
-#else // GUI
+#if wxUSE_GUI || defined(__WXMSW__)

         // this message is intentionally not translated - it is for
         // developpers only
         // this message is intentionally not translated - it is for
         // developpers only

-        wxStrcat(szBuf, _T("\nDo you want to stop the program?"
-                "\nYou can also choose [Cancel] to suppress "
-                "further warnings."));
+        wxStrcat(szBuf, wxT("\nDo you want to stop the program?\nYou can also choose [Cancel] to suppress further warnings."));

 
 

-        switch ( wxMessageBox(szBuf, _("Debug"),
-                    wxYES_NO | wxCANCEL | wxICON_STOP ) ) {
+#if wxUSE_GUI
+        switch ( wxMessageBox(szBuf, wxT("Debug"),
+                              wxYES_NO | wxCANCEL | wxICON_STOP ) ) {

             case wxYES:
                 Trap();
                 break;
             case wxYES:
                 Trap();
                 break;


@@ -603,9 +652,26 @@ void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg)
                 s_bNoAsserts = TRUE;
                 break;
 
                 s_bNoAsserts = TRUE;
                 break;
 

-                //case wxNO: nothing to do
+            //case wxNO: nothing to do
+        }
+#else // !GUI, but MSW
+        switch ( ::MessageBox(NULL, szBuf, _T("Debug"),
+                              MB_YESNOCANCEL | MB_ICONSTOP ) ) {
+            case IDYES:
+                Trap();
+                break;
+
+            case IDCANCEL:
+                s_bNoAsserts = TRUE;
+                break;
+
+            //case IDNO: nothing to do

         }
         }

-#endif // !GUI/GUI
+#endif // GUI or MSW
+
+#else // !GUI
+        Trap();
+#endif // GUI/!GUI

     }
 
     s_bInAssert = FALSE;
     }
 
     s_bInAssert = FALSE;