]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/log.cpp
remove always-true test of unsigned >= 0
[wxWidgets.git] / src / common / log.cpp
index 293fcd1dc8a10a75d34121fb79f260af8a8d3142..dd0f26e1d6a55012b1c6d7e7c0bf8257206f50ce 100644 (file)
 #undef wxLOG_COMPONENT
 const char *wxLOG_COMPONENT = "";
 
-#if wxUSE_THREADS
-
-wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar;
-
-namespace
-{
-
-// contains messages logged by the other threads and waiting to be shown until
-// Flush() is called in the main one
-typedef wxVector<wxLogRecord> wxLogRecords;
-wxLogRecords gs_bufferedLogRecords;
-
 // 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
@@ -87,27 +75,41 @@ wxLogRecords gs_bufferedLogRecords;
 // 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##CS() function to
-// access the critical function without worrying about it being not initialized
+// 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_LOG_CS(name)                                                \
-    inline wxCriticalSection& Get##name##CS()                                 \
+#define WX_DEFINE_GLOBAL_VAR(type, name)                                      \
+    inline type& Get##name()                                                  \
     {                                                                         \
-        static wxCriticalSection s_cs##name;                                  \
-        return s_cs##name;                                                    \
+        static type s_##name;                                                 \
+        return s_##name;                                                      \
     }                                                                         \
                                                                               \
-    wxCriticalSection *gs_##name##CSPtr = &Get##name##CS()
+    type *gs_##name##Ptr = &Get##name()
+
+#if wxUSE_THREADS
+
+wxTLS_TYPE(wxThreadSpecificInfo) wxThreadInfoVar;
+
+namespace
+{
+
+// contains messages logged by the other threads and waiting to be shown until
+// Flush() is called in the main one
+typedef wxVector<wxLogRecord> wxLogRecords;
+wxLogRecords gs_bufferedLogRecords;
+
+#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
 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);
 
-// and this one is used for gs_componentLevels 
+// and this one is used for GetComponentLevels()
 WX_DEFINE_LOG_CS(Levels);
 
 } // anonymous namespace
@@ -161,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
-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
 
@@ -292,7 +313,7 @@ wxLog::OnLog(wxLogLevel level,
     else
 #endif // wxUSE_THREADS
     {
-        logger = ms_pLogger;
+        logger = GetMainThreadActiveTarget();
         if ( !logger )
             return;
     }
@@ -329,9 +350,7 @@ wxLog::CallDoLogNow(wxLogLevel level,
     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));
     }
@@ -360,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);
-#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
@@ -462,6 +483,12 @@ wxLog *wxLog::GetActiveTarget()
     }
 #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()
@@ -473,7 +500,7 @@ wxLog *wxLog::GetActiveTarget()
             if ( wxTheApp != NULL )
                 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
             else
-                ms_pLogger = new wxLogStderr;
+                ms_pLogger = new wxLogOutputBest;
 
             s_bInGetActiveTarget = false;
 
@@ -544,7 +571,7 @@ void wxLog::SetComponentLevel(const wxString& component, wxLogLevel level)
     {
         wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
 
-        gs_componentLevels[component] = level;
+        GetComponentLevels()[component] = level;
     }
 }
 
@@ -553,11 +580,12 @@ wxLogLevel wxLog::GetComponentLevel(wxString component)
 {
     wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
 
+    const wxStringToNumHashMap& componentLevels = GetComponentLevels();
     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('/');
@@ -570,36 +598,67 @@ wxLogLevel wxLog::GetComponentLevel(wxString component)
 // 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());
 
-    ms_aTraceMasks.push_back(str);
+    TraceMasks().push_back(str);
 }
 
 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 )
-        ms_aTraceMasks.RemoveAt((size_t)index);
+        TraceMasks().RemoveAt((size_t)index);
 }
 
 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());
 
-    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;
@@ -657,6 +716,20 @@ void wxLog::FlushThreadMessages()
     }
 }
 
+/* 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
 
 void wxLog::Flush()
@@ -779,7 +852,7 @@ wxLogChain::wxLogChain(wxLog *logger)
 
 wxLogChain::~wxLogChain()
 {
-    delete m_logOld;
+    wxLog::SetActiveTarget(m_logOld);
 
     if ( m_logNew != this )
         delete m_logNew;
@@ -812,8 +885,15 @@ void wxLogChain::DoLogRecord(wxLogLevel level,
         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__
@@ -869,8 +949,6 @@ wxString        wxLog::ms_timestamp(wxS("%X"));  // time only, no date
 wxTraceMask     wxLog::ms_ulTraceMask  = (wxTraceMask)0;
 #endif // wxDEBUG_LEVEL
 
-wxArrayString   wxLog::ms_aTraceMasks;
-
 // ----------------------------------------------------------------------------
 // stdout error logging helper
 // ----------------------------------------------------------------------------