fixing modal dialog quit after nested message box problem

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

diff --git a/src/common/log.cpp b/src/common/log.cpp
index 262477de4003838aa9cd3995f574f28f6dd39816..ce5bbd5c5ee78b972cec323c96f34813c9dce6f3 100644 (file)
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -51,16 +51,42 @@
 
 #include <stdlib.h>
 
 
 #include <stdlib.h>
 

+#ifndef __WXPALMOS5__

 #ifndef __WXWINCE__
 #include <time.h>
 #else
 #include "wx/msw/wince/time.h"
 #endif
 #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 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // non member functions
 // ----------------------------------------------------------------------------


@@ -157,7 +183,7 @@ IMPLEMENT_LOG_FUNCTION(Status)
 void wxSafeShowMessage(const wxString& title, const wxString& text)
 {
 #ifdef __WINDOWS__
 void wxSafeShowMessage(const wxString& title, const wxString& text)
 {
 #ifdef __WINDOWS__

-    ::MessageBox(NULL, text.wx_str(), title.wx_str(), MB_OK | MB_ICONSTOP);
+    ::MessageBox(NULL, text.t_str(), title.t_str(), MB_OK | MB_ICONSTOP);

 #else
     wxFprintf(stderr, wxS("%s: %s\n"), title.c_str(), text.c_str());
     fflush(stderr);
 #else
     wxFprintf(stderr, wxS("%s: %s\n"), title.c_str(), text.c_str());
     fflush(stderr);


@@ -234,47 +260,42 @@ void wxDoLogVerboseUtf8(const char *format, ...)
 }
 #endif // wxUSE_UNICODE_UTF8
 
 }
 #endif // wxUSE_UNICODE_UTF8
 

-// debug functions
-#ifdef __WXDEBUG__
+// ----------------------------------------------------------------------------
+// debug and trace functions
+// ----------------------------------------------------------------------------
+
+#if wxUSE_LOG_DEBUG
+    void wxVLogDebug(const wxString& format, va_list argptr)
+    {
+        if ( wxLog::IsEnabled() )
+        {
+            wxLog::OnLog(wxLOG_Debug,
+                         wxString::FormatV(format, argptr), time(NULL));
+        }
+    }

 
 #if !wxUSE_UTF8_LOCALE_ONLY
 
 #if !wxUSE_UTF8_LOCALE_ONLY

-    #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)                   \
-      void wxDoLog##level##Wchar(const wxChar *format, ...)             \
-      {                                                                 \
-        va_list argptr;                                                 \
-        va_start(argptr, format);                                       \
-        wxVLog##level(format, argptr);                                  \
-        va_end(argptr);                                                 \
-      }
-#else
-    #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)
-#endif
+    void wxDoLogDebugWchar(const wxChar *format, ...)
+    {
+        va_list argptr;
+        va_start(argptr, format);
+        wxVLogDebug(format, argptr);
+        va_end(argptr);
+    }
+#endif // !wxUSE_UTF8_LOCALE_ONLY

 
 #if wxUSE_UNICODE_UTF8
 
 #if wxUSE_UNICODE_UTF8

-    #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)                    \
-      void wxDoLog##level##Utf8(const char *format, ...)                \
-      {                                                                 \
-        va_list argptr;                                                 \
-        va_start(argptr, format);                                       \
-        wxVLog##level(format, argptr);                                  \
-        va_end(argptr);                                                 \
-      }
-#else
-    #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
-#endif
-
-#define IMPLEMENT_LOG_DEBUG_FUNCTION(level)                         \
-  void wxVLog##level(const wxString& format, va_list argptr)        \
-  {                                                                 \
-    if ( wxLog::IsEnabled() ) {                                     \
-      wxLog::OnLog(wxLOG_##level,                                   \
-                   wxString::FormatV(format, argptr), time(NULL));  \
-    }                                                               \
-  }                                                                 \
-  IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)                         \
-  IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
-
+    void wxDoLogDebugUtf8(const char *format, ...)
+    {
+        va_list argptr;
+        va_start(argptr, format);
+        wxVLogDebug(format, argptr);
+        va_end(argptr);
+    }
+#endif // wxUSE_UNICODE_UTF8
+#endif // wxUSE_LOG_DEBUG

 
 

+#if wxUSE_LOG_TRACE

   void wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
   {
     if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
   void wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
   {
     if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {


@@ -305,6 +326,9 @@ void wxDoLogVerboseUtf8(const char *format, ...)
   }
 #endif // wxUSE_UNICODE_UTF8
 
   }
 #endif // wxUSE_UNICODE_UTF8
 

+// deprecated (but not declared as such because we don't want to complicate
+// DECLARE_LOG_FUNCTION macros even more) overloads for wxTraceMask
+#if WXWIN_COMPATIBILITY_2_8

   void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
   {
     // we check that all of mask bits are set in the current mask, so
   void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
   {
     // we check that all of mask bits are set in the current mask, so


@@ -335,7 +359,10 @@ void wxDoLogVerboseUtf8(const char *format, ...)
   }
 #endif // wxUSE_UNICODE_UTF8
 
   }
 #endif // wxUSE_UNICODE_UTF8
 

+#endif // WXWIN_COMPATIBILITY_2_8
+

 #ifdef __WATCOMC__
 #ifdef __WATCOMC__

+#if WXWIN_COMPATIBILITY_2_8

   // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
   void wxDoLogTraceWchar(int mask, const wxChar *format, ...)
   {
   // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
   void wxDoLogTraceWchar(int mask, const wxChar *format, ...)
   {


@@ -344,6 +371,7 @@ void wxDoLogVerboseUtf8(const char *format, ...)
     wxVLogTrace(mask, format, argptr);
     va_end(argptr);
   }
     wxVLogTrace(mask, format, argptr);
     va_end(argptr);
   }

+#endif // WXWIN_COMPATIBILITY_2_8

 
   void wxDoLogTraceWchar(const char *mask, const wxChar *format, ...)
   {
 
   void wxDoLogTraceWchar(const char *mask, const wxChar *format, ...)
   {


@@ -361,20 +389,17 @@ void wxDoLogVerboseUtf8(const char *format, ...)
     va_end(argptr);
   }
 
     va_end(argptr);
   }
 

+#if WXWIN_COMPATIBILITY_2_8

   void wxVLogTrace(int mask, const wxString& format, va_list argptr)
     { wxVLogTrace((wxTraceMask)mask, format, argptr); }
   void wxVLogTrace(int mask, const wxString& format, va_list argptr)
     { wxVLogTrace((wxTraceMask)mask, format, argptr); }

+#endif // WXWIN_COMPATIBILITY_2_8

   void wxVLogTrace(const char *mask, const wxString& format, va_list argptr)
     { wxVLogTrace(wxString(mask), format, argptr); }
   void wxVLogTrace(const wchar_t *mask, const wxString& format, va_list argptr)
     { wxVLogTrace(wxString(mask), format, argptr); }
 #endif // __WATCOMC__
   void wxVLogTrace(const char *mask, const wxString& format, va_list argptr)
     { wxVLogTrace(wxString(mask), format, argptr); }
   void wxVLogTrace(const wchar_t *mask, const wxString& format, va_list argptr)
     { wxVLogTrace(wxString(mask), format, argptr); }
 #endif // __WATCOMC__

+#endif // wxUSE_LOG_TRACE

 
 

-#else // release
-  #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
-#endif
-
-IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
-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


@@ -459,7 +484,7 @@ void WXDLLIMPEXP_BASE wxVLogSysError(unsigned long err, const wxString& format,
 
 unsigned wxLog::LogLastRepeatIfNeeded()
 {
 
 unsigned wxLog::LogLastRepeatIfNeeded()
 {

-    wxCRIT_SECT_LOCKER(lock, ms_prevCS);
+    wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS());

 
     return LogLastRepeatIfNeededUnlocked();
 }
 
     return LogLastRepeatIfNeededUnlocked();
 }


@@ -513,7 +538,7 @@ void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
         {
             if ( GetRepetitionCounting() )
             {
         {
             if ( GetRepetitionCounting() )
             {

-                wxCRIT_SECT_LOCKER(lock, ms_prevCS);
+                wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS());

 
                 if ( szString == ms_prevString )
                 {
 
                 if ( szString == ms_prevString )
                 {


@@ -616,8 +641,17 @@ void wxLog::DoCreateOnDemand()
     ms_bAutoCreate = true;
 }
 
     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)
 {
 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);
     int index = ms_aTraceMasks.Index(str);
     if ( index != wxNOT_FOUND )
         ms_aTraceMasks.RemoveAt((size_t)index);


@@ -625,6 +659,8 @@ void wxLog::RemoveTraceMask(const wxString& str)
 
 void wxLog::ClearTraceMasks()
 {
 
 void wxLog::ClearTraceMasks()
 {

+    wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+

     ms_aTraceMasks.Clear();
 }
 
     ms_aTraceMasks.Clear();
 }
 


@@ -684,17 +720,32 @@ void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
                 LogString(szString, t);
             break;
 
                 LogString(szString, t);
             break;
 

+#if wxUSE_LOG_DEBUG || wxUSE_LOG_TRACE
+#if wxUSE_LOG_TRACE

         case wxLOG_Trace:
         case wxLOG_Trace:

+#endif
+#if wxUSE_LOG_DEBUG

         case wxLOG_Debug:
         case wxLOG_Debug:

-#ifdef __WXDEBUG__
+#endif

             {
             {

-                wxString msg = level == wxLOG_Trace ? wxS("Trace: ")
-                                                    : wxS("Debug: ");
-                msg << szString;
-                LogString(msg, t);
+                wxString str;
+
+                // don't prepend "debug/trace" prefix under MSW as it goes to
+                // the debug window anyhow and don't add time stamp neither as
+                // debug output viewers under Windows typically add it
+                // themselves anyhow
+                #ifndef __WXMSW__
+                    TimeStamp(&str);
+
+                    str += level == wxLOG_Trace ? wxT("Trace: ")
+                                                : wxT("Debug: ");
+                #endif // !__WXMSW__
+
+                str += szString;
+                wxMessageOutputDebug().Output(str);

             }
             }

-#endif // Debug

             break;
             break;

+#endif // wxUSE_LOG_DEBUG || wxUSE_LOG_TRACE

     }
 }
 
     }
 }
 


@@ -720,11 +771,16 @@ void wxLog::Flush()
 
 /*static*/ bool wxLog::IsAllowedTraceMask(const wxString& 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 )
     for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
                                   en = ms_aTraceMasks.end();
          it != en; ++it )

+    {

         if ( *it == mask)
             return true;
         if ( *it == mask)
             return true;

+    }
+

     return false;
 }
 
     return false;
 }
 


@@ -742,31 +798,39 @@ void wxLogBuffer::Flush()
     }
 }
 
     }
 }
 

+#if wxUSE_LOG_DEBUG || wxUSE_LOG_TRACE
+

 void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
 void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {

-    switch ( level )
-    {
-        case wxLOG_Trace:
-        case wxLOG_Debug:
-#ifdef __WXDEBUG__
-            // don't put debug messages in the buffer, we don't want to show
-            // them to the user in a msg box, log them immediately
-            {
-                wxString str;
-                TimeStamp(&str);
-                str += szString;
+    // don't put debug messages in the buffer, we don't want to show
+    // them to the user in a msg box, log them immediately
+    bool showImmediately = false;
+#if wxUSE_LOG_TRACE
+    if ( level == wxLOG_Trace )
+        showImmediately = true;
+#endif
+#if wxUSE_LOG_DEBUG
+    if ( level == wxLOG_Debug )
+        showImmediately = true;
+#endif

 
 

-                wxMessageOutputDebug dbgout;
-                dbgout.Printf(wxS("%s\n"), str.c_str());
-            }
-#endif // __WXDEBUG__
-            break;
+    if ( showImmediately )
+    {
+        wxString str;
+        TimeStamp(&str);
+        str += szString;

 
 

-        default:
-            wxLog::DoLog(level, szString, t);
+        wxMessageOutputDebug dbgout;
+        dbgout.Printf(wxS("%s\n"), str.c_str());
+    }
+    else
+    {
+        wxLog::DoLog(level, szString, t);

     }
 }
 
     }
 }
 

+#endif // wxUSE_LOG_DEBUG || wxUSE_LOG_TRACE
+

 void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
     m_str << szString << wxS("\n");
 void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
     m_str << szString << wxS("\n");


@@ -873,16 +937,11 @@ void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     // let the previous logger show it
     if ( m_logOld && IsPassingMessages() )
 {
     // let the previous logger show it
     if ( m_logOld && IsPassingMessages() )

-    {
-        // bogus cast just to access protected DoLog
-        ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
-    }
+        m_logOld->Log(level, szString, t);

 
 

+    // and also send it to the new one

     if ( m_logNew && m_logNew != this )
     if ( m_logNew && m_logNew != this )

-    {
-        // as above...
-        ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
-    }
+        m_logNew->Log(level, szString, t);

 }
 
 #ifdef __VISUALC__
 }
 
 #ifdef __VISUALC__


@@ -906,7 +965,7 @@ wxLogInterposer::wxLogInterposer()
 wxLogInterposerTemp::wxLogInterposerTemp()
                 : wxLogChain(this)
 {
 wxLogInterposerTemp::wxLogInterposerTemp()
                 : wxLogChain(this)
 {

-       DetachOldLog();
+    DetachOldLog();

 }
 
 #ifdef __VISUALC__
 }
 
 #ifdef __VISUALC__


@@ -921,16 +980,13 @@ wxLogInterposerTemp::wxLogInterposerTemp()
 // static variables
 // ----------------------------------------------------------------------------
 
 // static variables
 // ----------------------------------------------------------------------------
 

-#if wxUSE_THREADS
-wxCriticalSection wxLog::ms_prevCS;
-#endif // wxUSE_THREADS

 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;
 
 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;
+wxLog          *wxLog::ms_pLogger      = NULL;

 bool            wxLog::ms_doLog        = true;
 bool            wxLog::ms_bAutoCreate  = true;
 bool            wxLog::ms_bVerbose     = false;
 bool            wxLog::ms_doLog        = true;
 bool            wxLog::ms_bAutoCreate  = true;
 bool            wxLog::ms_bVerbose     = false;


@@ -941,7 +997,10 @@ size_t          wxLog::ms_suspendCount = 0;
 
 wxString        wxLog::ms_timestamp(wxS("%X"));  // time only, no date
 
 
 wxString        wxLog::ms_timestamp(wxS("%X"));  // time only, no date
 

+#if WXWIN_COMPATIBILITY_2_8

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

+#endif // wxDEBUG_LEVEL
+

 wxArrayString   wxLog::ms_aTraceMasks;
 
 // ----------------------------------------------------------------------------
 wxArrayString   wxLog::ms_aTraceMasks;
 
 // ----------------------------------------------------------------------------


@@ -1029,8 +1088,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 #if !defined(__SMARTPHONE__) /* of WinCE */
     if( lpMsgBuf != 0 )
     {
 #if !defined(__SMARTPHONE__) /* of WinCE */
     if( lpMsgBuf != 0 )
     {

-        wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
-        s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxS('\0');
+        wxStrlcpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf));

 
         LocalFree(lpMsgBuf);
 
 
         LocalFree(lpMsgBuf);