// Author: Vadim Zeitlin
// Modified by:
// Created: 29/01/98
-// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#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"
// other standard headers
#ifndef __WXWINCE__
#include "wx/msw/private.h" // includes windows.h
#endif
+#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
+
+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 TraceMasks() from concurrent access
+WX_DEFINE_LOG_CS(TraceMask);
+
+// and this one is used for GetComponentLevels()
+WX_DEFINE_LOG_CS(Levels);
+
+} // anonymous namespace
+
+#endif // wxUSE_THREADS
+
// ----------------------------------------------------------------------------
// non member functions
// ----------------------------------------------------------------------------
static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz);
#endif
-// ============================================================================
-// implementation
-// ============================================================================
-
// ----------------------------------------------------------------------------
-// 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.
+// module globals
// ----------------------------------------------------------------------------
-// generic log function
-void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr)
-{
- if ( wxLog::IsEnabled() ) {
- wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL));
- }
-}
-
-#if !wxUSE_UTF8_LOCALE_ONLY
-void wxDoLogGenericWchar(wxLogLevel level, const wxChar *format, ...)
+namespace
{
- va_list argptr;
- va_start(argptr, format);
- wxVLogGeneric(level, format, argptr);
- va_end(argptr);
-}
-#endif // wxUSE_UTF8_LOCALE_ONLY
-#if wxUSE_UNICODE_UTF8
-void wxDoLogGenericUtf8(wxLogLevel level, const char *format, ...)
+// this struct is used to store information about the previous log message used
+// by OnLog() to (optionally) avoid logging multiple copies of the same message
+struct PreviousLogInfo
{
- va_list argptr;
- va_start(argptr, format);
- wxVLogGeneric(level, format, argptr);
- va_end(argptr);
-}
-#endif // wxUSE_UNICODE_UTF8
-
-#if !wxUSE_UTF8_LOCALE_ONLY
- #define IMPLEMENT_LOG_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_FUNCTION_WCHAR(level)
-#endif
-
-#if wxUSE_UNICODE_UTF8
- #define IMPLEMENT_LOG_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_FUNCTION_UTF8(level)
-#endif
+ PreviousLogInfo()
+ {
+ numRepeated = 0;
+ }
-#define IMPLEMENT_LOG_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_FUNCTION_WCHAR(level) \
- IMPLEMENT_LOG_FUNCTION_UTF8(level)
-
-IMPLEMENT_LOG_FUNCTION(Error)
-IMPLEMENT_LOG_FUNCTION(Warning)
-IMPLEMENT_LOG_FUNCTION(Message)
-IMPLEMENT_LOG_FUNCTION(Info)
-IMPLEMENT_LOG_FUNCTION(Status)
-void wxSafeShowMessage(const wxString& title, const wxString& text)
-{
-#ifdef __WINDOWS__
- ::MessageBox(NULL, text.wx_str(), title.wx_str(), MB_OK | MB_ICONSTOP);
-#else
- wxFprintf(stderr, wxS("%s: %s\n"), title.c_str(), text.c_str());
- fflush(stderr);
-#endif
-}
+ // previous message itself
+ wxString msg;
-// fatal errors can't be suppressed nor handled by the custom log target and
-// always terminate the program
-void wxVLogFatalError(const wxString& format, va_list argptr)
-{
- wxSafeShowMessage(wxS("Fatal Error"), wxString::FormatV(format, argptr));
+ // its level
+ wxLogLevel level;
-#ifdef __WXWINCE__
- ExitThread(3);
-#else
- abort();
-#endif
-}
+ // other information about it
+ wxLogRecordInfo info;
-#if !wxUSE_UTF8_LOCALE_ONLY
-void wxDoLogFatalErrorWchar(const wxChar *format, ...)
-{
- va_list argptr;
- va_start(argptr, format);
- wxVLogFatalError(format, argptr);
+ // the number of times it was already repeated
+ unsigned numRepeated;
+};
- // some compilers warn about unreachable code and it shouldn't matter
- // for the others anyhow...
- //va_end(argptr);
-}
-#endif // wxUSE_UTF8_LOCALE_ONLY
+PreviousLogInfo gs_prevLog;
-#if wxUSE_UNICODE_UTF8
-void wxDoLogFatalErrorUtf8(const char *format, ...)
-{
- va_list argptr;
- va_start(argptr, format);
- wxVLogFatalError(format, argptr);
- // some compilers warn about unreachable code and it shouldn't matter
- // for the others anyhow...
- //va_end(argptr);
-}
-#endif // wxUSE_UNICODE_UTF8
+// map containing all components for which log level was explicitly set
+//
+// NB: all accesses to it must be protected by GetLevelsCS() critical section
+WX_DEFINE_GLOBAL_VAR(wxStringToNumHashMap, ComponentLevels);
-// same as info, but only if 'verbose' mode is on
-void wxVLogVerbose(const wxString& format, va_list argptr)
-{
- if ( wxLog::IsEnabled() ) {
- if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
- wxLog::OnLog(wxLOG_Info,
- wxString::FormatV(format, argptr), time(NULL));
- }
- }
-}
+// ----------------------------------------------------------------------------
+// wxLogOutputBest: wxLog wrapper around wxMessageOutputBest
+// ----------------------------------------------------------------------------
-#if !wxUSE_UTF8_LOCALE_ONLY
-void wxDoLogVerboseWchar(const wxChar *format, ...)
+class wxLogOutputBest : public wxLog
{
- va_list argptr;
- va_start(argptr, format);
- wxVLogVerbose(format, argptr);
- va_end(argptr);
-}
-#endif // !wxUSE_UTF8_LOCALE_ONLY
+public:
+ wxLogOutputBest() { }
-#if wxUSE_UNICODE_UTF8
-void wxDoLogVerboseUtf8(const char *format, ...)
-{
- va_list argptr;
- va_start(argptr, format);
- wxVLogVerbose(format, argptr);
- va_end(argptr);
-}
-#endif // wxUSE_UNICODE_UTF8
-
-// debug functions
-#ifdef __WXDEBUG__
-
-#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
+protected:
+ virtual void DoLogText(const wxString& msg)
+ {
+ wxMessageOutputBest().Output(msg);
+ }
-#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
+private:
+ wxDECLARE_NO_COPY_CLASS(wxLogOutputBest);
+};
-#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 wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
- {
- if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
- wxString msg;
- msg << wxS("(") << mask << wxS(") ") << wxString::FormatV(format, argptr);
-
- wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
- }
- }
-
-#if !wxUSE_UTF8_LOCALE_ONLY
- void wxDoLogTraceWchar(const wxString& mask, const wxChar *format, ...)
- {
- va_list argptr;
- va_start(argptr, format);
- wxVLogTrace(mask, format, argptr);
- va_end(argptr);
- }
-#endif // !wxUSE_UTF8_LOCALE_ONLY
-
-#if wxUSE_UNICODE_UTF8
- void wxDoLogTraceUtf8(const wxString& mask, const char *format, ...)
- {
- va_list argptr;
- va_start(argptr, format);
- wxVLogTrace(mask, format, argptr);
- va_end(argptr);
- }
-#endif // wxUSE_UNICODE_UTF8
-
- void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
- {
- // we check that all of mask bits are set in the current mask, so
- // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
- // if both bits are set.
- if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
- wxLog::OnLog(wxLOG_Trace, wxString::FormatV(format, argptr), time(NULL));
- }
- }
-
-#if !wxUSE_UTF8_LOCALE_ONLY
- void wxDoLogTraceWchar(wxTraceMask mask, const wxChar *format, ...)
- {
- va_list argptr;
- va_start(argptr, format);
- wxVLogTrace(mask, format, argptr);
- va_end(argptr);
- }
-#endif // !wxUSE_UTF8_LOCALE_ONLY
-
-#if wxUSE_UNICODE_UTF8
- void wxDoLogTraceUtf8(wxTraceMask mask, const char *format, ...)
- {
- va_list argptr;
- va_start(argptr, format);
- wxVLogTrace(mask, format, argptr);
- va_end(argptr);
- }
-#endif // wxUSE_UNICODE_UTF8
-
-#ifdef __WATCOMC__
- // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
- void wxDoLogTraceWchar(int mask, const wxChar *format, ...)
- {
- va_list argptr;
- va_start(argptr, format);
- wxVLogTrace(mask, format, argptr);
- va_end(argptr);
- }
-
- void wxDoLogTraceWchar(const char *mask, const wxChar *format, ...)
- {
- va_list argptr;
- va_start(argptr, format);
- wxVLogTrace(mask, format, argptr);
- va_end(argptr);
- }
-
- void wxDoLogTraceWchar(const wchar_t *mask, const wxChar *format, ...)
- {
- va_list argptr;
- va_start(argptr, format);
- wxVLogTrace(mask, format, argptr);
- va_end(argptr);
- }
-
- void wxVLogTrace(int mask, const wxString& format, va_list argptr)
- { wxVLogTrace((wxTraceMask)mask, format, argptr); }
- 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__
-
-#else // release
- #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
-#endif
+} // anonymous namespace
-IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
-IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
+// ============================================================================
+// implementation
+// ============================================================================
-// wxLogSysError: one uses the last error code, for other you must give it
-// explicitly
+// ----------------------------------------------------------------------------
+// helper global functions
+// ----------------------------------------------------------------------------
-// return the system error message description
-static inline wxString wxLogSysErrorHelper(long err)
+void wxSafeShowMessage(const wxString& title, const wxString& text)
{
- return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
+#ifdef __WINDOWS__
+ ::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);
+#endif
}
-void WXDLLIMPEXP_BASE wxVLogSysError(const wxString& format, va_list argptr)
-{
- wxVLogSysError(wxSysErrorCode(), format, argptr);
-}
+// ----------------------------------------------------------------------------
+// wxLogFormatter class implementation
+// ----------------------------------------------------------------------------
-#if !wxUSE_UTF8_LOCALE_ONLY
-void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(const wxChar *format, ...)
+wxString
+wxLogFormatter::Format(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info) const
{
- va_list argptr;
- va_start(argptr, format);
- wxVLogSysError(format, argptr);
- va_end(argptr);
-}
-#endif // !wxUSE_UTF8_LOCALE_ONLY
+ wxString prefix;
-#if wxUSE_UNICODE_UTF8
-void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(const char *format, ...)
-{
- va_list argptr;
- va_start(argptr, format);
- wxVLogSysError(format, argptr);
- va_end(argptr);
-}
-#endif // wxUSE_UNICODE_UTF8
+ // don't time stamp debug messages under MSW as debug viewers usually
+ // already have an option to do it
+#ifdef __WINDOWS__
+ if ( level != wxLOG_Debug && level != wxLOG_Trace )
+#endif // __WINDOWS__
+ prefix = FormatTime(info.timestamp);
-void WXDLLIMPEXP_BASE wxVLogSysError(long err, const wxString& format, va_list argptr)
-{
- if ( wxLog::IsEnabled() ) {
- wxLog::OnLog(wxLOG_Error,
- wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err),
- time(NULL));
+ switch ( level )
+ {
+ case wxLOG_Error:
+ prefix += _("Error: ");
+ break;
+
+ case wxLOG_Warning:
+ prefix += _("Warning: ");
+ break;
+
+ // don't prepend "debug/trace" prefix under MSW as it goes to the debug
+ // window anyhow and so can't be confused with something else
+#ifndef __WINDOWS__
+ case wxLOG_Debug:
+ // this prefix (as well as the one below) is intentionally not
+ // translated as nobody translates debug messages anyhow
+ prefix += "Debug: ";
+ break;
+
+ case wxLOG_Trace:
+ prefix += "Trace: ";
+ break;
+#endif // !__WINDOWS__
}
-}
-#if !wxUSE_UTF8_LOCALE_ONLY
-void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
-{
- va_list argptr;
- va_start(argptr, format);
- wxVLogSysError(lErrCode, format, argptr);
- va_end(argptr);
+ return prefix + msg;
}
-#endif // !wxUSE_UTF8_LOCALE_ONLY
-#if wxUSE_UNICODE_UTF8
-void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
+wxString
+wxLogFormatter::FormatTime(time_t t) const
{
- va_list argptr;
- va_start(argptr, format);
- wxVLogSysError(lErrCode, format, argptr);
- va_end(argptr);
-}
-#endif // wxUSE_UNICODE_UTF8
+ wxString str;
+ wxLog::TimeStamp(&str, t);
-#ifdef __WATCOMC__
-// workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
-void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...)
-{
- va_list argptr;
- va_start(argptr, format);
- wxVLogSysError(lErrCode, format, argptr);
- va_end(argptr);
+ return str;
}
-void WXDLLIMPEXP_BASE wxVLogSysError(unsigned long err, const wxString& format, va_list argptr)
- { wxVLogSysError((long)err, format, argptr); }
-#endif // __WATCOMC__
// ----------------------------------------------------------------------------
// wxLog class implementation
unsigned wxLog::LogLastRepeatIfNeeded()
{
- wxCRIT_SECT_LOCKER(lock, ms_prevCS);
-
- return LogLastRepeatIfNeededUnlocked();
-}
-
-unsigned wxLog::LogLastRepeatIfNeededUnlocked()
-{
- const unsigned count = ms_prevCounter;
+ const unsigned count = gs_prevLog.numRepeated;
- if ( ms_prevCounter )
+ if ( gs_prevLog.numRepeated )
{
wxString msg;
#if wxUSE_INTL
- msg.Printf(wxPLURAL("The previous message repeated once.",
- "The previous message repeated %lu times.",
- ms_prevCounter),
- ms_prevCounter);
+ if ( gs_prevLog.numRepeated == 1 )
+ {
+ // We use a separate message for this case as "repeated 1 time"
+ // looks somewhat strange.
+ msg = _("The previous message repeated once.");
+ }
+ else
+ {
+ // Notice that we still use wxPLURAL() to ensure that multiple
+ // numbers of times are correctly formatted, even though we never
+ // actually use the singular string.
+ msg.Printf(wxPLURAL("The previous message repeated %lu time.",
+ "The previous message repeated %lu times.",
+ gs_prevLog.numRepeated),
+ gs_prevLog.numRepeated);
+ }
#else
- msg.Printf(wxS("The previous message was repeated %lu times."),
- ms_prevCounter);
+ msg.Printf(wxS("The previous message was repeated %lu time(s)."),
+ gs_prevLog.numRepeated);
#endif
- ms_prevCounter = 0;
- ms_prevString.clear();
- DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
+ gs_prevLog.numRepeated = 0;
+ gs_prevLog.msg.clear();
+ DoLogRecord(gs_prevLog.level, msg, gs_prevLog.info);
}
return count;
{
// Flush() must be called before destroying the object as otherwise some
// messages could be lost
- if ( ms_prevCounter )
+ if ( gs_prevLog.numRepeated )
{
wxMessageOutputDebug().Printf
(
- wxS("Last repeated message (\"%s\", %lu times) wasn't output"),
- ms_prevString,
- ms_prevCounter
+#if wxUSE_INTL
+ wxPLURAL
+ (
+ "Last repeated message (\"%s\", %lu time) wasn't output",
+ "Last repeated message (\"%s\", %lu times) wasn't output",
+ gs_prevLog.numRepeated
+ ),
+#else
+ wxS("Last repeated message (\"%s\", %lu time(s)) wasn't output"),
+#endif
+ gs_prevLog.msg,
+ gs_prevLog.numRepeated
);
}
+
+ delete m_formatter;
+}
+
+// ----------------------------------------------------------------------------
+// wxLog logging functions
+// ----------------------------------------------------------------------------
+
+/* static */
+void
+wxLog::OnLog(wxLogLevel level, const wxString& msg, time_t t)
+{
+ wxLogRecordInfo info;
+ info.timestamp = t;
+#if wxUSE_THREADS
+ info.threadId = wxThread::GetCurrentId();
+#endif // wxUSE_THREADS
+
+ OnLog(level, msg, info);
}
/* static */
-void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
+void
+wxLog::OnLog(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- if ( IsEnabled() && ms_logLevel >= level )
+ // fatal errors can't be suppressed nor handled by the custom log target
+ // and always terminate the program
+ if ( level == wxLOG_FatalError )
{
- wxLog *pLogger = GetActiveTarget();
- if ( pLogger )
+ wxSafeShowMessage(wxS("Fatal Error"), msg);
+
+ wxAbort();
+ }
+
+ wxLog *logger;
+
+#if wxUSE_THREADS
+ if ( !wxThread::IsMain() )
+ {
+ logger = wxThreadInfo.logger;
+ if ( !logger )
{
- if ( GetRepetitionCounting() )
+ if ( ms_pLogger )
{
- wxCRIT_SECT_LOCKER(lock, ms_prevCS);
+ // buffer the messages until they can be shown from the main
+ // thread
+ wxCriticalSectionLocker lock(GetBackgroundLogCS());
- if ( szString == ms_prevString )
- {
- ms_prevCounter++;
+ gs_bufferedLogRecords.push_back(wxLogRecord(level, msg, info));
- // nothing else to do, in particular, don't log the
- // repeated message
- return;
- }
+ // 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;
+ }
+ //else: we have a thread-specific logger, we can send messages to it
+ // directly
+ }
+ else
+#endif // wxUSE_THREADS
+ {
+ logger = GetMainThreadActiveTarget();
+ if ( !logger )
+ return;
+ }
- pLogger->LogLastRepeatIfNeededUnlocked();
+ logger->CallDoLogNow(level, msg, info);
+}
- // reset repetition counter for a new message
- ms_prevString = szString;
- ms_prevLevel = level;
- ms_prevTimeStamp = t;
- }
+void
+wxLog::CallDoLogNow(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
+{
+ if ( GetRepetitionCounting() )
+ {
+ if ( msg == gs_prevLog.msg )
+ {
+ gs_prevLog.numRepeated++;
- pLogger->DoLog(level, szString, t);
+ // nothing else to do, in particular, don't log the
+ // repeated message
+ return;
}
+
+ LogLastRepeatIfNeeded();
+
+ // reset repetition counter for a new message
+ gs_prevLog.msg = msg;
+ gs_prevLog.level = level;
+ gs_prevLog.info = info;
}
+
+ // handle extra data which may be passed to us by wxLogXXX()
+ wxString prefix, suffix;
+ wxUIntPtr num = 0;
+ if ( info.GetNumValue(wxLOG_KEY_SYS_ERROR_CODE, &num) )
+ {
+ const long err = static_cast<long>(num);
+
+ suffix.Printf(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
+ }
+
+#if wxUSE_LOG_TRACE
+ wxString str;
+ if ( level == wxLOG_Trace && info.GetStrValue(wxLOG_KEY_TRACE_MASK, &str) )
+ {
+ prefix = "(" + str + ") ";
+ }
+#endif // wxUSE_LOG_TRACE
+
+ DoLogRecord(level, prefix + msg + suffix, info);
}
-// deprecated function
-#if WXWIN_COMPATIBILITY_2_6
+void wxLog::DoLogRecord(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
+{
+#if WXWIN_COMPATIBILITY_2_8
+ // call the old DoLog() to ensure that existing custom log classes still
+ // work
+ //
+ // as the user code could have defined it as either taking "const char *"
+ // (in ANSI build) or "const wxChar *" (in ANSI/Unicode), we have no choice
+ // 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);
+#else // !WXWIN_COMPATIBILITY_2_8
+ wxUnusedVar(info);
+#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8
+
+ // Use wxLogFormatter to format the message
+ DoLogTextAtLevel(level, m_formatter->Format (level, msg, info));
+}
-wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
+void wxLog::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
{
- return NULL;
+ // we know about debug messages (because using wxMessageOutputDebug is the
+ // right thing to do in 99% of all cases and also for compatibility) but
+ // anything else needs to be handled in the derived class
+ if ( level == wxLOG_Debug || level == wxLOG_Trace )
+ {
+ wxMessageOutputDebug().Output(msg + wxS('\n'));
+ }
+ else
+ {
+ DoLogText(msg);
+ }
}
-#endif // WXWIN_COMPATIBILITY_2_6
+void wxLog::DoLogText(const wxString& WXUNUSED(msg))
+{
+ // in 2.8-compatible build the derived class might override DoLog() or
+ // DoLogString() instead so we can't have this assert there
+#if !WXWIN_COMPATIBILITY_2_8
+ wxFAIL_MSG( "must be overridden if it is called" );
+#endif // WXWIN_COMPATIBILITY_2_8
+}
#if WXWIN_COMPATIBILITY_2_8
-void wxLog::DoLog(wxLogLevel WXUNUSED(level),
- const char *WXUNUSED(szString),
- time_t WXUNUSED(t))
+void wxLog::DoLog(wxLogLevel WXUNUSED(level), const char *szString, time_t t)
{
+ DoLogString(szString, t);
}
-void wxLog::DoLog(wxLogLevel WXUNUSED(level),
- const wchar_t *WXUNUSED(wzString),
- time_t WXUNUSED(t))
+void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t)
{
+ DoLogString(wzString, t);
}
#endif // WXWIN_COMPATIBILITY_2_8
+// ----------------------------------------------------------------------------
+// wxLog active target management
+// ----------------------------------------------------------------------------
+
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 ( wxTheApp != NULL )
ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
else
- ms_pLogger = new wxLogStderr;
+ ms_pLogger = new wxLogOutputBest;
s_bInGetActiveTarget = false;
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;
ms_bAutoCreate = true;
}
+// ----------------------------------------------------------------------------
+// wxLog components levels
+// ----------------------------------------------------------------------------
+
+/* static */
+void wxLog::SetComponentLevel(const wxString& component, wxLogLevel level)
+{
+ if ( component.empty() )
+ {
+ SetLogLevel(level);
+ }
+ else
+ {
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
+
+ GetComponentLevels()[component] = level;
+ }
+}
+
+/* static */
+wxLogLevel wxLog::GetComponentLevel(wxString component)
+{
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
+
+ const wxStringToNumHashMap& componentLevels = GetComponentLevels();
+ while ( !component.empty() )
+ {
+ wxStringToNumHashMap::const_iterator
+ it = componentLevels.find(component);
+ if ( it != componentLevels.end() )
+ return static_cast<wxLogLevel>(it->second);
+
+ component = component.BeforeLast('/');
+ }
+
+ return GetLogLevel();
+}
+
+// ----------------------------------------------------------------------------
+// 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());
+
+ TraceMasks().push_back(str);
+}
+
void wxLog::RemoveTraceMask(const wxString& str)
{
- int index = ms_aTraceMasks.Index(str);
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ int index = TraceMasks().Index(str);
if ( index != wxNOT_FOUND )
- ms_aTraceMasks.RemoveAt((size_t)index);
+ TraceMasks().RemoveAt((size_t)index);
}
void wxLog::ClearTraceMasks()
{
- ms_aTraceMasks.Clear();
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ TraceMasks().Clear();
}
-void wxLog::TimeStamp(wxString *str)
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ const wxArrayString& masks = GetTraceMasks();
+ for ( wxArrayString::const_iterator it = masks.begin(),
+ en = masks.end();
+ it != en;
+ ++it )
+ {
+ if ( *it == mask)
+ return true;
+ }
+
+ return false;
+}
+
+// ----------------------------------------------------------------------------
+// wxLog miscellaneous other methods
+// ----------------------------------------------------------------------------
+
#if wxUSE_DATETIME
+
+void wxLog::TimeStamp(wxString *str)
+{
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 = wxDateTime::UNow().Format(ms_timestamp);
+ *str += wxS(": ");
+ }
+}
- str->Empty();
- *str << buf << wxS(": ");
+void wxLog::TimeStamp(wxString *str, time_t t)
+{
+ if ( !ms_timestamp.empty() )
+ {
+ *str = wxDateTime(t).Format(ms_timestamp);
+ *str += wxS(": ");
}
-#endif // wxUSE_DATETIME
}
-void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
+#else // !wxUSE_DATETIME
+
+void wxLog::TimeStamp(wxString*)
{
-#if WXWIN_COMPATIBILITY_2_8
- // DoLog() signature changed since 2.8, so we call the old versions here
- // so that existing custom log classes still work:
- DoLog(level, (const char*)szString.mb_str(), t);
- DoLog(level, (const wchar_t*)szString.wc_str(), t);
-#endif
+}
- switch ( level ) {
- case wxLOG_FatalError:
- LogString(_("Fatal error: ") + szString, t);
- LogString(_("Program aborted."), t);
- Flush();
-#ifdef __WXWINCE__
- ExitThread(3);
-#else
- abort();
-#endif
- break;
+void wxLog::TimeStamp(wxString*, time_t)
+{
+}
- case wxLOG_Error:
- LogString(_("Error: ") + szString, t);
- break;
+#endif // wxUSE_DATETIME/!wxUSE_DATETIME
- case wxLOG_Warning:
- LogString(_("Warning: ") + szString, t);
- break;
+#if wxUSE_THREADS
- case wxLOG_Info:
- if ( GetVerbose() )
- case wxLOG_Message:
- case wxLOG_Status:
- default: // log unknown log levels too
- LogString(szString, t);
- break;
+void wxLog::FlushThreadMessages()
+{
+ // check if we have queued messages from other threads
+ wxLogRecords bufferedLogRecords;
- case wxLOG_Trace:
- case wxLOG_Debug:
-#ifdef __WXDEBUG__
- {
- wxString msg = level == wxLOG_Trace ? wxS("Trace: ")
- : wxS("Debug: ");
- msg << szString;
- LogString(msg, t);
- }
-#endif // Debug
- break;
+ {
+ wxCriticalSectionLocker lock(GetBackgroundLogCS());
+ bufferedLogRecords.swap(gs_bufferedLogRecords);
+
+ // release the lock now to not keep it while we are logging the
+ // messages below, allowing background threads to run
+ }
+
+ if ( !bufferedLogRecords.empty() )
+ {
+ for ( wxLogRecords::const_iterator it = bufferedLogRecords.begin();
+ it != bufferedLogRecords.end();
+ ++it )
+ {
+ CallDoLogNow(it->level, it->msg, it->info);
+ }
}
}
-void wxLog::DoLogString(const wxString& szString, time_t t)
+/* static */
+bool wxLog::IsThreadLoggingEnabled()
{
-#if WXWIN_COMPATIBILITY_2_8
- // DoLogString() signature changed since 2.8, so we call the old versions
- // here so that existing custom log classes still work; unfortunately this
- // also means that we can't have the wxFAIL_MSG below in compat mode
- DoLogString((const char*)szString.mb_str(), t);
- DoLogString((const wchar_t*)szString.wc_str(), t);
-#else
- wxFAIL_MSG(wxS("DoLogString must be overriden if it's called."));
- wxUnusedVar(szString);
- wxUnusedVar(t);
-#endif
+ return !wxThreadInfo.loggingDisabled;
+}
+
+/* static */
+bool wxLog::EnableThreadLogging(bool enable)
+{
+ const bool wasEnabled = !wxThreadInfo.loggingDisabled;
+ wxThreadInfo.loggingDisabled = !enable;
+ return wasEnabled;
+}
+
+#endif // wxUSE_THREADS
+
+wxLogFormatter *wxLog::SetFormatter(wxLogFormatter* formatter)
+{
+ wxLogFormatter* formatterOld = m_formatter;
+ m_formatter = formatter ? formatter : new wxLogFormatter;
+
+ return formatterOld;
}
void wxLog::Flush()
LogLastRepeatIfNeeded();
}
-/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
+/* static */
+void wxLog::FlushActive()
{
- for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
- en = ms_aTraceMasks.end();
- it != en; ++it )
- if ( *it == mask)
- return true;
- return false;
+ if ( ms_suspendCount )
+ return;
+
+ wxLog * const log = GetActiveTarget();
+ if ( log )
+ {
+#if wxUSE_THREADS
+ if ( wxThread::IsMain() )
+ log->FlushThreadMessages();
+#endif // wxUSE_THREADS
+
+ log->Flush();
+ }
}
// ----------------------------------------------------------------------------
void wxLogBuffer::Flush()
{
+ wxLog::Flush();
+
if ( !m_str.empty() )
{
wxMessageOutputBest out;
}
}
-void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
+void wxLogBuffer::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
{
+ // 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
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;
-
- wxMessageOutputDebug dbgout;
- dbgout.Printf(wxS("%s\n"), str.c_str());
- }
-#endif // __WXDEBUG__
+ case wxLOG_Trace:
+ wxLog::DoLogTextAtLevel(level, msg);
break;
default:
- wxLog::DoLog(level, szString, t);
+ m_str << msg << wxS("\n");
}
}
-void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
-{
- m_str << szString << wxS("\n");
-}
-
// ----------------------------------------------------------------------------
// wxLogStderr class implementation
// ----------------------------------------------------------------------------
m_fp = fp;
}
-void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
+void wxLogStderr::DoLogText(const wxString& msg)
{
- wxString str;
- TimeStamp(&str);
- str << szString;
-
- wxFputs(str, m_fp);
- wxFputc(wxS('\n'), m_fp);
- fflush(m_fp);
+ // First send it to stderr, even if we don't have it (e.g. in a Windows GUI
+ // application under) it's not a problem to try to use it and it's easier
+ // than determining whether we do have it or not.
+ wxMessageOutputStderr(m_fp).Output(msg);
// under GUI systems such as Windows or Mac, programs usually don't have
// stderr at all, so show the messages also somewhere else, typically in
wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
if ( traits && !traits->HasStderr() )
{
- wxMessageOutputDebug dbgout;
- dbgout.Printf(wxS("%s\n"), str.c_str());
+ wxMessageOutputDebug().Output(msg + wxS('\n'));
}
}
}
m_ostr = ostr;
}
-void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
+void wxLogStream::DoLogText(const wxString& msg)
{
- wxString stamp;
- TimeStamp(&stamp);
- (*m_ostr) << stamp << szString << wxSTD endl;
+ (*m_ostr) << msg << wxSTD endl;
}
#endif // wxUSE_STD_IOSTREAM
m_bPassMessages = true;
m_logNew = logger;
- m_logOld = wxLog::SetActiveTarget(this);
+
+ // Notice that we use GetActiveTarget() here instead of directly calling
+ // SetActiveTarget() to trigger wxLog auto-creation: if we're created as
+ // the first logger, we should still chain with the standard, implicit and
+ // possibly still not created standard logger instead of disabling normal
+ // logging entirely.
+ m_logOld = wxLog::GetActiveTarget();
+ wxLog::SetActiveTarget(this);
}
wxLogChain::~wxLogChain()
{
- delete m_logOld;
+ wxLog::SetActiveTarget(m_logOld);
if ( m_logNew != this )
delete m_logNew;
m_logNew->Flush();
}
-void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
+void wxLogChain::DoLogRecord(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
// 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->LogRecord(level, msg, info);
- if ( m_logNew && m_logNew != this )
+ // and also send it to the new one
+ if ( m_logNew )
{
- // as above...
- ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
+ // 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);
}
}
wxLogInterposerTemp::wxLogInterposerTemp()
: wxLogChain(this)
{
- DetachOldLog();
+ DetachOldLog();
}
#ifdef __VISUALC__
// 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;
-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;
wxString wxLog::ms_timestamp(wxS("%X")); // time only, no date
+#if WXWIN_COMPATIBILITY_2_8
wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
-wxArrayString wxLog::ms_aTraceMasks;
+#endif // wxDEBUG_LEVEL
// ----------------------------------------------------------------------------
// stdout error logging helper
// get error code from syste
unsigned long wxSysErrorCode()
{
-#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
+#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
return ::GetLastError();
#else //Unix
return errno;
if ( nErrCode == 0 )
nErrCode = wxSysErrorCode();
-#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
+#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
static wxChar s_szBuf[1024];
// get error message from system
#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);
}
return s_szBuf;
-#else // !__WXMSW__
+#else // !__WINDOWS__
#if wxUSE_UNICODE
static wchar_t s_wzBuf[1024];
wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
#else
return strerror((int)nErrCode);
#endif
-#endif // __WXMSW__/!__WXMSW__
+#endif // __WINDOWS__/!__WINDOWS__
}
#endif // wxUSE_LOG
projects / wxWidgets.git / blobdiff