Disable symbols visibility support for the Clang compiler.

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

diff --git a/src/common/log.cpp b/src/common/log.cpp
index f72beb9af9e4d5005594d5faa034f7519abcbb53..c30b582075f757716d1781247b24e79b9bfbc6c1 100644 (file)
--- a/src/common/log.cpp
+++ b/src/common/log.cpp
@@ -42,6 +42,7 @@
 #include "wx/msgout.h"
 #include "wx/textfile.h"
 #include "wx/thread.h"
 #include "wx/msgout.h"
 #include "wx/textfile.h"
 #include "wx/thread.h"

+#include "wx/private/threadinfo.h"

 #include "wx/crt.h"
 #include "wx/vector.h"
 
 #include "wx/crt.h"
 #include "wx/vector.h"
 


@@ -67,8 +68,30 @@
 #undef wxLOG_COMPONENT
 const char *wxLOG_COMPONENT = "";
 
 #undef wxLOG_COMPONENT
 const char *wxLOG_COMPONENT = "";
 

+// 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
+// anyhow but we should at least try to not crash) and to also ensure that they
+// are initialized by the time static initialization is done, i.e. before any
+// threads are created hopefully
+//
+// the net effect of all this is that you can use Get##name() function to
+// access the object without worrying about it being not initialized
+//
+// see also WX_DEFINE_GLOBAL_CONV2() in src/common/strconv.cpp
+#define WX_DEFINE_GLOBAL_VAR(type, name)                                      \
+    inline type& Get##name()                                                  \
+    {                                                                         \
+        static type s_##name;                                                 \
+        return s_##name;                                                      \
+    }                                                                         \
+                                                                              \
+    type *gs_##name##Ptr = &Get##name()
+

 #if wxUSE_THREADS
 
 #if wxUSE_THREADS
 

+wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar;
+

 namespace
 {
 
 namespace
 {
 


@@ -77,42 +100,17 @@ namespace
 typedef wxVector<wxLogRecord> wxLogRecords;
 wxLogRecords gs_bufferedLogRecords;
 
 typedef wxVector<wxLogRecord> wxLogRecords;
 wxLogRecords gs_bufferedLogRecords;
 

-
-// 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
+#define WX_DEFINE_LOG_CS(name) WX_DEFINE_GLOBAL_VAR(wxCriticalSection, name##CS)

 
 // this critical section is used for buffering the messages from threads other
 // than main, i.e. it protects all accesses to gs_bufferedLogRecords above
 
 // this critical section is used for buffering the messages from threads other
 // than main, i.e. it protects all accesses to gs_bufferedLogRecords above

-inline wxCriticalSection& GetBackgroundLogCS()
-{
-    static wxCriticalSection s_csBackground;
-
-    return s_csBackground;
-}
-
-inline wxCriticalSection& GetTraceMaskCS()
-{
-    static wxCriticalSection s_csTrace;
+WX_DEFINE_LOG_CS(BackgroundLog);

 
 

-    return s_csTrace;
-}
+// this one is used for protecting TraceMasks() from concurrent access
+WX_DEFINE_LOG_CS(TraceMask);

 
 

-inline wxCriticalSection& GetPreviousLogCS()
-{
-    static wxCriticalSection s_csPrev;
-
-    return s_csPrev;
-}
-
-inline wxCriticalSection& GetLevelsCS()
-{
-    static wxCriticalSection s_csLevels;
-
-    return s_csLevels;
-}
+// and this one is used for GetComponentLevels()
+WX_DEFINE_LOG_CS(Levels);

 
 } // anonymous namespace
 
 
 } // anonymous namespace
 


@@ -165,7 +163,26 @@ PreviousLogInfo gs_prevLog;
 // map containing all components for which log level was explicitly set
 //
 // NB: all accesses to it must be protected by GetLevelsCS() critical section
 // map containing all components for which log level was explicitly set
 //
 // NB: all accesses to it must be protected by GetLevelsCS() critical section

-wxStringToNumHashMap gs_componentLevels;
+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
 


@@ -266,36 +283,51 @@ wxLog::OnLog(wxLogLevel level,
 #endif
     }
 
 #endif
     }
 

-    wxLog *pLogger = GetActiveTarget();
-    if ( !pLogger )
-        return;
+    wxLog *logger;

 
 #if wxUSE_THREADS
     if ( !wxThread::IsMain() )
     {
 
 #if wxUSE_THREADS
     if ( !wxThread::IsMain() )
     {

-        wxCriticalSectionLocker lock(GetBackgroundLogCS());
+        logger = wxThreadInfo.logger;
+        if ( !logger )
+        {
+            if ( ms_pLogger )
+            {
+                // buffer the messages until they can be shown from the main
+                // thread
+                wxCriticalSectionLocker lock(GetBackgroundLogCS());

 
 

-        gs_bufferedLogRecords.push_back(wxLogRecord(level, msg, info));
+                gs_bufferedLogRecords.push_back(wxLogRecord(level, msg, info));

 
 

-        // ensure that our Flush() will be called soon
-        wxWakeUpIdle();
+                // ensure that our Flush() will be called soon
+                wxWakeUpIdle();
+            }
+            //else: we don't have any logger at all, there is no need to log
+            //      anything

 
 

-        return;
+            return;
+        }
+        //else: we have a thread-specific logger, we can send messages to it
+        //      directly

     }
     }

+    else

 #endif // wxUSE_THREADS
 #endif // wxUSE_THREADS

+    {
+        logger = GetMainThreadActiveTarget();
+        if ( !logger )
+            return;
+    }

 
 

-    pLogger->OnLogInMainThread(level, msg, info);
+    logger->CallDoLogNow(level, msg, info);

 }
 
 void
 }
 
 void

-wxLog::OnLogInMainThread(wxLogLevel level,
-                         const wxString& msg,
-                         const wxLogRecordInfo& info)
+wxLog::CallDoLogNow(wxLogLevel level,
+                    const wxString& msg,
+                    const wxLogRecordInfo& info)

 {
     if ( GetRepetitionCounting() )
     {
 {
     if ( GetRepetitionCounting() )
     {

-        wxCRIT_SECT_LOCKER(lock, GetPreviousLogCS());
-

         if ( msg == gs_prevLog.msg )
         {
             gs_prevLog.numRepeated++;
         if ( msg == gs_prevLog.msg )
         {
             gs_prevLog.numRepeated++;


@@ -318,9 +350,7 @@ wxLog::OnLogInMainThread(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));
     }


@@ -349,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


@@ -437,6 +469,25 @@ void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t)
 // ----------------------------------------------------------------------------
 
 wxLog *wxLog::GetActiveTarget()
 // ----------------------------------------------------------------------------
 
 wxLog *wxLog::GetActiveTarget()

+{
+#if wxUSE_THREADS
+    if ( !wxThread::IsMain() )
+    {
+        // check if we have a thread-specific log target
+        wxLog * const logger = wxThreadInfo.logger;
+
+        // the code below should be only executed for the main thread as
+        // CreateLogTarget() is not meant for auto-creating log targets for
+        // worker threads so skip it in any case
+        return logger ? logger : ms_pLogger;
+    }
+#endif // wxUSE_THREADS
+
+    return GetMainThreadActiveTarget();
+}
+
+/* static */
+wxLog *wxLog::GetMainThreadActiveTarget()

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


@@ -449,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;
 


@@ -474,6 +525,22 @@ wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
     return pOldLogger;
 }
 
     return pOldLogger;
 }
 

+#if wxUSE_THREADS
+/* static */
+wxLog *wxLog::SetThreadActiveTarget(wxLog *logger)
+{
+    wxASSERT_MSG( !wxThread::IsMain(), "use SetActiveTarget() for main thread" );
+
+    wxLog * const oldLogger = wxThreadInfo.logger;
+    if ( oldLogger )
+        oldLogger->Flush();
+
+    wxThreadInfo.logger = logger;
+
+    return oldLogger;
+}
+#endif // wxUSE_THREADS
+

 void wxLog::DontCreateOnDemand()
 {
     ms_bAutoCreate = false;
 void wxLog::DontCreateOnDemand()
 {
     ms_bAutoCreate = false;


@@ -504,7 +571,7 @@ void wxLog::SetComponentLevel(const wxString& component, wxLogLevel level)
     {
         wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
 
     {
         wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
 

-        gs_componentLevels[component] = level;
+        GetComponentLevels()[component] = level;

     }
 }
 
     }
 }
 


@@ -513,11 +580,12 @@ wxLogLevel wxLog::GetComponentLevel(wxString component)
 {
     wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
 
 {
     wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
 

+    const wxStringToNumHashMap& componentLevels = GetComponentLevels();

     while ( !component.empty() )
     {
         wxStringToNumHashMap::const_iterator
     while ( !component.empty() )
     {
         wxStringToNumHashMap::const_iterator

-            it = gs_componentLevels.find(component);
-        if ( it != gs_componentLevels.end() )
+            it = componentLevels.find(component);
+        if ( it != componentLevels.end() )

             return static_cast<wxLogLevel>(it->second);
 
         component = component.BeforeLast('/');
             return static_cast<wxLogLevel>(it->second);
 
         component = component.BeforeLast('/');


@@ -530,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;


@@ -577,26 +676,16 @@ 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
 }
 

-void wxLog::Flush()
-{

 #if wxUSE_THREADS
 #if wxUSE_THREADS

-    wxASSERT_MSG( wxThread::IsMain(),
-                  "should be called from the main thread only" );

 
 

+void wxLog::FlushThreadMessages()
+{

     // check if we have queued messages from other threads
     wxLogRecords bufferedLogRecords;
 
     // check if we have queued messages from other threads
     wxLogRecords bufferedLogRecords;
 


@@ -614,14 +703,50 @@ void wxLog::Flush()
               it != bufferedLogRecords.end();
               ++it )
         {
               it != bufferedLogRecords.end();
               ++it )
         {

-            OnLogInMainThread(it->level, it->msg, it->info);
+            CallDoLogNow(it->level, it->msg, it->info);

         }
     }
         }
     }

+}
+
+/* static */
+bool wxLog::IsThreadLoggingEnabled()
+{
+    return !wxThreadInfo.loggingDisabled;
+}
+
+/* static */
+bool wxLog::EnableThreadLogging(bool enable)
+{
+    const bool wasEnabled = !wxThreadInfo.loggingDisabled;
+    wxThreadInfo.loggingDisabled = !enable;
+    return wasEnabled;
+}
+

 #endif // wxUSE_THREADS
 
 #endif // wxUSE_THREADS
 

+void wxLog::Flush()
+{

     LogLastRepeatIfNeeded();
 }
 
     LogLastRepeatIfNeeded();
 }
 

+/* static */
+void wxLog::FlushActive()
+{
+    if ( ms_suspendCount )
+        return;
+
+    wxLog * const log = GetActiveTarget();
+    if ( log )
+    {
+#if wxUSE_THREADS
+        if ( wxThread::IsMain() )
+            log->FlushThreadMessages();
+#endif // wxUSE_THREADS
+
+        log->Flush();
+    }
+}
+

 // ----------------------------------------------------------------------------
 // wxLogBuffer implementation
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxLogBuffer implementation
 // ----------------------------------------------------------------------------


@@ -719,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;


@@ -752,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__


@@ -809,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
 // ----------------------------------------------------------------------------