Fix memory leak in wxPanel::SetBackgroundBirmap() in wxMSW.

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

diff --git a/src/common/log.cpp b/src/common/log.cpp
index d3595d123495f3deea60905c620174c8809424a7..c30b582075f757716d1781247b24e79b9bfbc6c1 100644 (file)
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -68,10 +68,6 @@
 #undef wxLOG_COMPONENT
 const char *wxLOG_COMPONENT = "";
 
 #undef wxLOG_COMPONENT
 const char *wxLOG_COMPONENT = "";
 

-#if wxUSE_THREADS
-
-wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar;
-

 // this macro allows to define an object which will be initialized before any
 // other function in this file is called: this is necessary to allow log
 // functions to be used during static initialization (this is not advisable
 // this macro allows to define an object which will be initialized before any
 // other function in this file is called: this is necessary to allow log
 // functions to be used during static initialization (this is not advisable


@@ -92,6 +88,10 @@ wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar;
                                                                               \
     type *gs_##name##Ptr = &Get##name()
 
                                                                               \
     type *gs_##name##Ptr = &Get##name()
 

+#if wxUSE_THREADS
+
+wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar;
+

 namespace
 {
 
 namespace
 {
 


@@ -106,10 +106,10 @@ wxLogRecords gs_bufferedLogRecords;
 // than main, i.e. it protects all accesses to gs_bufferedLogRecords above
 WX_DEFINE_LOG_CS(BackgroundLog);
 
 // than main, i.e. it protects all accesses to gs_bufferedLogRecords above
 WX_DEFINE_LOG_CS(BackgroundLog);
 

-// this one is used for protecting ms_aTraceMasks from concurrent access
+// this one is used for protecting TraceMasks() from concurrent access

 WX_DEFINE_LOG_CS(TraceMask);
 
 WX_DEFINE_LOG_CS(TraceMask);
 

-// and this one is used for GetComponentLevels() 
+// and this one is used for GetComponentLevels()

 WX_DEFINE_LOG_CS(Levels);
 
 } // anonymous namespace
 WX_DEFINE_LOG_CS(Levels);
 
 } // anonymous namespace


@@ -165,6 +165,25 @@ PreviousLogInfo gs_prevLog;
 // NB: all accesses to it must be protected by GetLevelsCS() critical section
 WX_DEFINE_GLOBAL_VAR(wxStringToNumHashMap, ComponentLevels);
 
 // NB: all accesses to it must be protected by GetLevelsCS() critical section
 WX_DEFINE_GLOBAL_VAR(wxStringToNumHashMap, ComponentLevels);
 

+// ----------------------------------------------------------------------------
+// wxLogOutputBest: wxLog wrapper around wxMessageOutputBest
+// ----------------------------------------------------------------------------
+
+class wxLogOutputBest : public wxLog
+{
+public:
+    wxLogOutputBest() { }
+
+protected:
+    virtual void DoLogText(const wxString& msg)
+    {
+        wxMessageOutputBest().Output(msg);
+    }
+
+private:
+    wxDECLARE_NO_COPY_CLASS(wxLogOutputBest);
+};
+

 } // anonymous namespace
 
 // ============================================================================
 } // anonymous namespace
 
 // ============================================================================


@@ -294,7 +313,7 @@ wxLog::OnLog(wxLogLevel level,
     else
 #endif // wxUSE_THREADS
     {
     else
 #endif // wxUSE_THREADS
     {

-        logger = ms_pLogger;
+        logger = GetMainThreadActiveTarget();

         if ( !logger )
             return;
     }
         if ( !logger )
             return;
     }


@@ -331,9 +350,7 @@ wxLog::CallDoLogNow(wxLogLevel level,
     wxUIntPtr num = 0;
     if ( info.GetNumValue(wxLOG_KEY_SYS_ERROR_CODE, &num) )
     {
     wxUIntPtr num = 0;
     if ( info.GetNumValue(wxLOG_KEY_SYS_ERROR_CODE, &num) )
     {

-        long err = static_cast<long>(num);
-        if ( !err )
-            err = wxSysErrorCode();
+        const long err = static_cast<long>(num);

 
         suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
     }
 
         suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
     }


@@ -362,7 +379,9 @@ void wxLog::DoLogRecord(wxLogLevel level,
     // but to call both of them
     DoLog(level, (const char*)msg.mb_str(), info.timestamp);
     DoLog(level, (const wchar_t*)msg.wc_str(), info.timestamp);
     // but to call both of them
     DoLog(level, (const char*)msg.mb_str(), info.timestamp);
     DoLog(level, (const wchar_t*)msg.wc_str(), info.timestamp);

-#endif // WXWIN_COMPATIBILITY_2_8
+#else // !WXWIN_COMPATIBILITY_2_8
+    wxUnusedVar(info);
+#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8

 
 
     // TODO: it would be better to extract message formatting in a separate
 
 
     // TODO: it would be better to extract message formatting in a separate


@@ -464,6 +483,12 @@ wxLog *wxLog::GetActiveTarget()
     }
 #endif // wxUSE_THREADS
 
     }
 #endif // wxUSE_THREADS
 

+    return GetMainThreadActiveTarget();
+}
+
+/* static */
+wxLog *wxLog::GetMainThreadActiveTarget()
+{

     if ( ms_bAutoCreate && ms_pLogger == NULL ) {
         // prevent infinite recursion if someone calls wxLogXXX() from
         // wxApp::CreateLogTarget()
     if ( ms_bAutoCreate && ms_pLogger == NULL ) {
         // prevent infinite recursion if someone calls wxLogXXX() from
         // wxApp::CreateLogTarget()


@@ -475,7 +500,7 @@ wxLog *wxLog::GetActiveTarget()
             if ( wxTheApp != NULL )
                 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
             else
             if ( wxTheApp != NULL )
                 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
             else

-                ms_pLogger = new wxLogStderr;
+                ms_pLogger = new wxLogOutputBest;

 
             s_bInGetActiveTarget = false;
 
 
             s_bInGetActiveTarget = false;
 


@@ -573,36 +598,67 @@ wxLogLevel wxLog::GetComponentLevel(wxString component)
 // wxLog trace masks
 // ----------------------------------------------------------------------------
 
 // wxLog trace masks
 // ----------------------------------------------------------------------------
 

+namespace
+{
+
+// because IsAllowedTraceMask() may be called during static initialization
+// (this is not recommended but it may still happen, see #11592) we can't use a
+// simple static variable which might be not initialized itself just yet to
+// store the trace masks, but need this accessor function which will ensure
+// that the variable is always correctly initialized before being accessed
+//
+// notice that this doesn't make accessing it MT-safe, of course, you need to
+// serialize accesses to it using GetTraceMaskCS() for this
+wxArrayString& TraceMasks()
+{
+    static wxArrayString s_traceMasks;
+
+    return s_traceMasks;
+}
+
+} // anonymous namespace
+
+/* static */ const wxArrayString& wxLog::GetTraceMasks()
+{
+    // because of this function signature (it returns a reference, not the
+    // object), it is inherently MT-unsafe so there is no need to acquire the
+    // lock here anyhow
+
+    return TraceMasks();
+}
+

 void wxLog::AddTraceMask(const wxString& str)
 {
     wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
 
 void wxLog::AddTraceMask(const wxString& str)
 {
     wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
 

-    ms_aTraceMasks.push_back(str);
+    TraceMasks().push_back(str);

 }
 
 void wxLog::RemoveTraceMask(const wxString& str)
 {
     wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
 
 }
 
 void wxLog::RemoveTraceMask(const wxString& str)
 {
     wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
 

-    int index = ms_aTraceMasks.Index(str);
+    int index = TraceMasks().Index(str);

     if ( index != wxNOT_FOUND )
     if ( index != wxNOT_FOUND )

-        ms_aTraceMasks.RemoveAt((size_t)index);
+        TraceMasks().RemoveAt((size_t)index);

 }
 
 void wxLog::ClearTraceMasks()
 {
     wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
 
 }
 
 void wxLog::ClearTraceMasks()
 {
     wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
 

-    ms_aTraceMasks.Clear();
+    TraceMasks().Clear();

 }
 
 /*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
 {
     wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
 
 }
 
 /*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 )
+    const wxArrayString& masks = GetTraceMasks();
+    for ( wxArrayString::const_iterator it = masks.begin(),
+                                        en = masks.end();
+          it != en;
+          ++it )

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


@@ -620,16 +676,8 @@ void wxLog::TimeStamp(wxString *str)
 #if wxUSE_DATETIME
     if ( !ms_timestamp.empty() )
     {
 #if wxUSE_DATETIME
     if ( !ms_timestamp.empty() )
     {

-        wxChar buf[256];
-        time_t timeNow;
-        (void)time(&timeNow);
-
-        struct tm tm;
-        wxStrftime(buf, WXSIZEOF(buf),
-                    ms_timestamp, wxLocaltime_r(&timeNow, &tm));
-
-        str->Empty();
-        *str << buf << wxS(": ");
+        *str = wxDateTime::UNow().Format(ms_timestamp);
+        *str += wxS(": ");

     }
 #endif // wxUSE_DATETIME
 }
     }
 #endif // wxUSE_DATETIME
 }


@@ -796,7 +844,7 @@ wxLogChain::wxLogChain(wxLog *logger)
 
 wxLogChain::~wxLogChain()
 {
 
 wxLogChain::~wxLogChain()
 {

-    delete m_logOld;
+    wxLog::SetActiveTarget(m_logOld);

 
     if ( m_logNew != this )
         delete m_logNew;
 
     if ( m_logNew != this )
         delete m_logNew;


@@ -829,8 +877,15 @@ void wxLogChain::DoLogRecord(wxLogLevel level,
         m_logOld->LogRecord(level, msg, info);
 
     // and also send it to the new one
         m_logOld->LogRecord(level, msg, info);
 
     // and also send it to the new one

-    if ( m_logNew && m_logNew != this )
-        m_logNew->LogRecord(level, msg, info);
+    if ( m_logNew )
+    {
+        // don't call m_logNew->LogRecord() to avoid infinite recursion when
+        // m_logNew is this object itself
+        if ( m_logNew != this )
+            m_logNew->LogRecord(level, msg, info);
+        else
+            wxLog::DoLogRecord(level, msg, info);
+    }

 }
 
 #ifdef __VISUALC__
 }
 
 #ifdef __VISUALC__


@@ -886,8 +941,6 @@ wxString        wxLog::ms_timestamp(wxS("%X"));  // time only, no date
 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 #endif // wxDEBUG_LEVEL
 
 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 #endif // wxDEBUG_LEVEL
 

-wxArrayString   wxLog::ms_aTraceMasks;
-

 // ----------------------------------------------------------------------------
 // stdout error logging helper
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // stdout error logging helper
 // ----------------------------------------------------------------------------