/////////////////////////////////////////////////////////////////////////////
-// Name: log.cpp
+// Name: src/common/log.cpp
// Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
// Author: Vadim Zeitlin
// Modified by:
// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "log.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
- #pragma hdrstop
+ #pragma hdrstop
#endif
-// wxWindows
+#if wxUSE_LOG
+
+// wxWidgets
#ifndef WX_PRECOMP
- #include "wx/string.h"
- #include "wx/intl.h"
+ #include "wx/log.h"
#include "wx/app.h"
-
- #if wxUSE_GUI
- #include "wx/window.h"
- #ifdef __WXMSW__
- #include "wx/msw/private.h"
- #endif
- #endif
+ #include "wx/arrstr.h"
+ #include "wx/intl.h"
+ #include "wx/string.h"
+ #include "wx/utils.h"
#endif //WX_PRECOMP
-#include "wx/file.h"
-#include "wx/textfile.h"
-#include "wx/utils.h"
-#include "wx/wxchar.h"
-#include "wx/log.h"
-#include "wx/thread.h"
-
-#if wxUSE_LOG
+#include "wx/apptrait.h"
+#include "wx/datetime.h"
+#include "wx/file.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"
// other standard headers
-#include <errno.h>
-#include <stdlib.h>
-#include <time.h>
+#ifndef __WXWINCE__
+#include <errno.h>
+#endif
+
+#include <stdlib.h>
+
+#ifndef __WXWINCE__
+#include <time.h>
+#else
+#include "wx/msw/wince/time.h"
+#endif
-#if defined(__WXMSW__)
- #include "wx/msw/private.h" // includes windows.h for OutputDebugString
+#if defined(__WINDOWS__)
+ #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
-// ============================================================================
+// ----------------------------------------------------------------------------
+// module globals
+// ----------------------------------------------------------------------------
+
+namespace
+{
+
+// 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
+{
+ PreviousLogInfo()
+ {
+ numRepeated = 0;
+ }
+
+
+ // previous message itself
+ wxString msg;
+
+ // its level
+ wxLogLevel level;
+
+ // other information about it
+ wxLogRecordInfo info;
+
+ // the number of times it was already repeated
+ unsigned numRepeated;
+};
+
+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
+WX_DEFINE_GLOBAL_VAR(wxStringToNumHashMap, ComponentLevels);
// ----------------------------------------------------------------------------
-// globals
+// wxLogOutputBest: wxLog wrapper around wxMessageOutputBest
// ----------------------------------------------------------------------------
-// log functions can't allocate memory (LogError("out of memory...") should
-// work!), so we use a static buffer for all log messages
-#define LOG_BUFFER_SIZE (4096)
+class wxLogOutputBest : public wxLog
+{
+public:
+ wxLogOutputBest() { }
-// static buffer for error messages
-static wxChar s_szBuf[LOG_BUFFER_SIZE];
+protected:
+ virtual void DoLogText(const wxString& msg)
+ {
+ wxMessageOutputBest().Output(msg);
+ }
-#if wxUSE_THREADS
+private:
+ wxDECLARE_NO_COPY_CLASS(wxLogOutputBest);
+};
-// the critical section protecting the static buffer
-static wxCriticalSection gs_csLogBuf;
+} // anonymous namespace
-#endif // wxUSE_THREADS
+// ============================================================================
+// implementation
+// ============================================================================
+
+// ----------------------------------------------------------------------------
+// helper global functions
+// ----------------------------------------------------------------------------
-// return true if we have a non NULL non disabled log target
-static inline bool IsLoggingEnabled()
+void wxSafeShowMessage(const wxString& title, const wxString& text)
{
- return wxLog::IsEnabled() && (wxLog::GetActiveTarget() != NULL);
+#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
}
// ----------------------------------------------------------------------------
-// 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.
+// wxLogFormatter class implementation
// ----------------------------------------------------------------------------
-// generic log function
-void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
+wxString
+wxLogFormatter::Format(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info) const
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ wxString prefix;
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
+ // 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);
- wxLog::OnLog(level, s_szBuf, 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__
}
+
+ return prefix + msg;
}
-#define IMPLEMENT_LOG_FUNCTION(level) \
- void wxLog##level(const wxChar *szFormat, ...) \
- { \
- if ( IsLoggingEnabled() ) { \
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
- \
- va_list argptr; \
- va_start(argptr, szFormat); \
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); \
- va_end(argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
- } \
- }
+wxString
+wxLogFormatter::FormatTime(time_t t) const
+{
+ wxString str;
+ wxLog::TimeStamp(&str, t);
-IMPLEMENT_LOG_FUNCTION(FatalError)
-IMPLEMENT_LOG_FUNCTION(Error)
-IMPLEMENT_LOG_FUNCTION(Warning)
-IMPLEMENT_LOG_FUNCTION(Message)
-IMPLEMENT_LOG_FUNCTION(Info)
-IMPLEMENT_LOG_FUNCTION(Status)
+ return str;
+}
-// same as info, but only if 'verbose' mode is on
-void wxLogVerbose(const wxChar *szFormat, ...)
-{
- if ( IsLoggingEnabled() ) {
- wxLog *pLog = wxLog::GetActiveTarget();
- if ( pLog != NULL && pLog->GetVerbose() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
+// ----------------------------------------------------------------------------
+// wxLog class implementation
+// ----------------------------------------------------------------------------
+
+unsigned wxLog::LogLastRepeatIfNeeded()
+{
+ const unsigned count = gs_prevLog.numRepeated;
- wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
+ if ( gs_prevLog.numRepeated )
+ {
+ wxString msg;
+#if wxUSE_INTL
+ 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 time(s)."),
+ gs_prevLog.numRepeated);
+#endif
+ gs_prevLog.numRepeated = 0;
+ gs_prevLog.msg.clear();
+ DoLogRecord(gs_prevLog.level, msg, gs_prevLog.info);
}
+
+ return count;
}
-// debug functions
-#ifdef __WXDEBUG__
-#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
- void wxLog##level(const wxChar *szFormat, ...) \
- { \
- if ( IsLoggingEnabled() ) { \
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
- \
- va_list argptr; \
- va_start(argptr, szFormat); \
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); \
- va_end(argptr); \
- \
- wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
- } \
- }
-
- void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
- {
- if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- wxChar *p = s_szBuf;
- size_t len = WXSIZEOF(s_szBuf);
- wxStrncpy(s_szBuf, _T("("), len);
- len -= 1; // strlen("(")
- p += 1;
- wxStrncat(p, mask, len);
- size_t lenMask = wxStrlen(mask);
- len -= lenMask;
- p += lenMask;
-
- wxStrncat(p, _T(") "), len);
- len -= 2;
- p += 2;
-
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(p, len, szFormat, argptr);
- va_end(argptr);
-
- wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
- }
- }
-
- void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
- {
- // 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 ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
-
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
-
- wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
- }
- }
-
-#else // release
- #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
+wxLog::~wxLog()
+{
+ // Flush() must be called before destroying the object as otherwise some
+ // messages could be lost
+ if ( gs_prevLog.numRepeated )
+ {
+ wxMessageOutputDebug().Printf
+ (
+#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
+ );
+ }
-IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
-IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
+ delete m_formatter;
+}
-// wxLogSysError: one uses the last error code, for other you must give it
-// explicitly
+// ----------------------------------------------------------------------------
+// wxLog logging functions
+// ----------------------------------------------------------------------------
-// common part of both wxLogSysError
-void wxLogSysErrorHelper(long lErrCode)
+/* static */
+void
+wxLog::OnLog(wxLogLevel level, const wxString& msg, time_t t)
{
- wxChar szErrMsg[LOG_BUFFER_SIZE / 2];
- wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg),
- _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
- wxStrncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - wxStrlen(s_szBuf));
+ wxLogRecordInfo info;
+ info.timestamp = t;
+#if wxUSE_THREADS
+ info.threadId = wxThread::GetCurrentId();
+#endif // wxUSE_THREADS
- wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
+ OnLog(level, msg, info);
}
-void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+/* static */
+void
+wxLog::OnLog(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ // fatal errors can't be suppressed nor handled by the custom log target
+ // and always terminate the program
+ if ( level == wxLOG_FatalError )
+ {
+ wxSafeShowMessage(wxS("Fatal Error"), msg);
+
+ wxAbort();
+ }
+
+ wxLog *logger;
+
+#if wxUSE_THREADS
+ if ( !wxThread::IsMain() )
+ {
+ 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));
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
+ // 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
- wxLogSysErrorHelper(wxSysErrorCode());
+ return;
+ }
+ //else: we have a thread-specific logger, we can send messages to it
+ // directly
+ }
+ else
+#endif // wxUSE_THREADS
+ {
+ logger = GetMainThreadActiveTarget();
+ if ( !logger )
+ return;
}
+
+ logger->CallDoLogNow(level, msg, info);
}
-void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+void
+wxLog::CallDoLogNow(wxLogLevel level,
+ const wxString& msg,
+ const wxLogRecordInfo& info)
{
- if ( IsLoggingEnabled() ) {
- wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
+ if ( GetRepetitionCounting() )
+ {
+ if ( msg == gs_prevLog.msg )
+ {
+ gs_prevLog.numRepeated++;
+
+ // nothing else to do, in particular, don't log the
+ // repeated message
+ return;
+ }
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
+ LogLastRepeatIfNeeded();
- wxLogSysErrorHelper(lErrCode);
+ // 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);
}
+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));
+}
+
+void wxLog::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
+{
+ // 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);
+ }
+}
+
+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 *szString, time_t t)
+{
+ DoLogString(szString, t);
+}
+
+void wxLog::DoLog(wxLogLevel WXUNUSED(level), const wchar_t *wzString, time_t t)
+{
+ DoLogString(wzString, t);
+}
+
+#endif // WXWIN_COMPATIBILITY_2_8
+
// ----------------------------------------------------------------------------
-// wxLog class implementation
+// wxLog active target management
// ----------------------------------------------------------------------------
-wxLog::wxLog()
+wxLog *wxLog::GetActiveTarget()
{
- m_bHasMessages = FALSE;
+#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();
}
-wxLog *wxLog::GetActiveTarget()
+/* static */
+wxLog *wxLog::GetMainThreadActiveTarget()
{
if ( ms_bAutoCreate && ms_pLogger == NULL ) {
// prevent infinite recursion if someone calls wxLogXXX() from
// wxApp::CreateLogTarget()
- static bool s_bInGetActiveTarget = FALSE;
+ static bool s_bInGetActiveTarget = false;
if ( !s_bInGetActiveTarget ) {
- s_bInGetActiveTarget = TRUE;
+ s_bInGetActiveTarget = true;
// ask the application to create a log target for us
if ( wxTheApp != NULL )
- ms_pLogger = wxTheApp->CreateLogTarget();
+ ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
else
- ms_pLogger = new wxLogStderr;
+ ms_pLogger = new wxLogOutputBest;
- s_bInGetActiveTarget = FALSE;
+ s_bInGetActiveTarget = false;
// do nothing if it fails - what can we do?
}
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 = false;
// this is usually called at the end of the program and we assume that it
// is *always* called at the end - so we free memory here to avoid false
ClearTraceMasks();
}
-void wxLog::RemoveTraceMask(const wxString& str)
+void wxLog::DoCreateOnDemand()
{
- int index = ms_aTraceMasks.Index(str);
- if ( index != wxNOT_FOUND )
- ms_aTraceMasks.Remove((size_t)index);
+ ms_bAutoCreate = true;
}
-void wxLog::ClearTraceMasks()
+// ----------------------------------------------------------------------------
+// wxLog components levels
+// ----------------------------------------------------------------------------
+
+/* static */
+void wxLog::SetComponentLevel(const wxString& component, wxLogLevel level)
{
- ms_aTraceMasks.Clear();
+ if ( component.empty() )
+ {
+ SetLogLevel(level);
+ }
+ else
+ {
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
+
+ GetComponentLevels()[component] = level;
+ }
}
-void wxLog::TimeStamp(wxString *str)
+/* static */
+wxLogLevel wxLog::GetComponentLevel(wxString component)
{
- if ( ms_timestamp )
+ wxCRIT_SECT_LOCKER(lock, GetLevelsCS());
+
+ const wxStringToNumHashMap& componentLevels = GetComponentLevels();
+ while ( !component.empty() )
{
- wxChar buf[256];
- time_t timeNow;
- (void)time(&timeNow);
- wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
+ wxStringToNumHashMap::const_iterator
+ it = componentLevels.find(component);
+ if ( it != componentLevels.end() )
+ return static_cast<wxLogLevel>(it->second);
- str->Empty();
- *str << buf << wxT(": ");
+ component = component.BeforeLast('/');
}
+
+ return GetLogLevel();
}
-void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+// ----------------------------------------------------------------------------
+// wxLog trace masks
+// ----------------------------------------------------------------------------
+
+namespace
{
- switch ( level ) {
- case wxLOG_FatalError:
- DoLogString(wxString(_("Fatal error: ")) + szString, t);
- DoLogString(_("Program aborted."), t);
- Flush();
- abort();
- break;
- case wxLOG_Error:
- DoLogString(wxString(_("Error: ")) + szString, t);
- break;
+// 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;
- case wxLOG_Warning:
- DoLogString(wxString(_("Warning: ")) + szString, t);
- break;
+ return s_traceMasks;
+}
- case wxLOG_Info:
- if ( GetVerbose() )
- case wxLOG_Message:
- case wxLOG_Status:
- default: // log unknown log levels too
- DoLogString(szString, t);
- break;
+} // anonymous namespace
- case wxLOG_Trace:
- case wxLOG_Debug:
-#ifdef __WXDEBUG__
- {
- wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
- : wxT("Debug: ");
- msg << szString;
- DoLogString(msg, t);
- }
-#endif // Debug
- break;
- }
+/* 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::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
+void wxLog::AddTraceMask(const wxString& str)
{
- wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ TraceMasks().push_back(str);
}
-void wxLog::Flush()
+void wxLog::RemoveTraceMask(const wxString& str)
+{
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ int index = TraceMasks().Index(str);
+ if ( index != wxNOT_FOUND )
+ TraceMasks().RemoveAt((size_t)index);
+}
+
+void wxLog::ClearTraceMasks()
{
- // remember that we don't have any more messages to show
- m_bHasMessages = FALSE;
+ wxCRIT_SECT_LOCKER(lock, GetTraceMaskCS());
+
+ TraceMasks().Clear();
+}
+
+/*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;
}
// ----------------------------------------------------------------------------
-// wxLogStderr class implementation
+// wxLog miscellaneous other methods
// ----------------------------------------------------------------------------
-wxLogStderr::wxLogStderr(FILE *fp)
+#if wxUSE_DATETIME
+
+void wxLog::TimeStamp(wxString *str)
{
- if ( fp == NULL )
- m_fp = stderr;
- else
- m_fp = fp;
+ if ( !ms_timestamp.empty() )
+ {
+ *str = wxDateTime::UNow().Format(ms_timestamp);
+ *str += wxS(": ");
+ }
+}
+
+void wxLog::TimeStamp(wxString *str, time_t t)
+{
+ if ( !ms_timestamp.empty() )
+ {
+ *str = wxDateTime(t).Format(ms_timestamp);
+ *str += wxS(": ");
+ }
}
-#if defined(__WXMAC__) && !defined(__DARWIN__)
-#define kDebuggerSignature 'MWDB'
+#else // !wxUSE_DATETIME
-static Boolean FindProcessBySignature(OSType signature, ProcessInfoRec* info)
+void wxLog::TimeStamp(wxString*)
{
- OSErr err;
- ProcessSerialNumber psn;
- Boolean found = false;
- psn.highLongOfPSN = 0;
- psn.lowLongOfPSN = kNoProcess;
+}
- if (!info) return false;
+void wxLog::TimeStamp(wxString*, time_t)
+{
+}
+
+#endif // wxUSE_DATETIME/!wxUSE_DATETIME
+
+#if wxUSE_THREADS
- info->processInfoLength = sizeof(ProcessInfoRec);
- info->processName = NULL;
- info->processAppSpec = NULL;
+void wxLog::FlushThreadMessages()
+{
+ // check if we have queued messages from other threads
+ wxLogRecords bufferedLogRecords;
+
+ {
+ 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
+ }
- err = noErr;
- while (!found && err == noErr)
+ if ( !bufferedLogRecords.empty() )
{
- err = GetNextProcess(&psn);
- if (err == noErr)
+ for ( wxLogRecords::const_iterator it = bufferedLogRecords.begin();
+ it != bufferedLogRecords.end();
+ ++it )
{
- err = GetProcessInformation(&psn, info);
- found = err == noErr && info->processSignature == signature;
+ CallDoLogNow(it->level, it->msg, it->info);
}
}
- return found;
}
-pascal Boolean MWDebuggerIsRunning(void)
+/* static */
+bool wxLog::IsThreadLoggingEnabled()
{
- ProcessInfoRec info;
- return FindProcessBySignature(kDebuggerSignature, &info);
+ return !wxThreadInfo.loggingDisabled;
}
-pascal OSErr AmIBeingMWDebugged(Boolean* result)
+/* static */
+bool wxLog::EnableThreadLogging(bool enable)
{
- OSErr err;
- ProcessSerialNumber psn;
- OSType sig = kDebuggerSignature;
- AppleEvent theAE = {typeNull, NULL};
- AppleEvent theReply = {typeNull, NULL};
- AEAddressDesc addr = {typeNull, NULL};
- DescType actualType;
- Size actualSize;
-
- if (!result) return paramErr;
+ const bool wasEnabled = !wxThreadInfo.loggingDisabled;
+ wxThreadInfo.loggingDisabled = !enable;
+ return wasEnabled;
+}
- err = AECreateDesc(typeApplSignature, &sig, sizeof(sig), &addr);
- if (err != noErr) goto exit;
+#endif // wxUSE_THREADS
- err = AECreateAppleEvent(kDebuggerSignature, 'Dbg?', &addr,
- kAutoGenerateReturnID, kAnyTransactionID, &theAE);
- if (err != noErr) goto exit;
+wxLogFormatter *wxLog::SetFormatter(wxLogFormatter* formatter)
+{
+ wxLogFormatter* formatterOld = m_formatter;
+ m_formatter = formatter ? formatter : new wxLogFormatter;
- GetCurrentProcess(&psn);
- err = AEPutParamPtr(&theAE, keyDirectObject, typeProcessSerialNumber,
- &psn, sizeof(psn));
- if (err != noErr) goto exit;
+ return formatterOld;
+}
- err = AESend(&theAE, &theReply, kAEWaitReply, kAENormalPriority,
- kAEDefaultTimeout, NULL, NULL);
- if (err != noErr) goto exit;
+void wxLog::Flush()
+{
+ LogLastRepeatIfNeeded();
+}
- err = AEGetParamPtr(&theReply, keyAEResult, typeBoolean, &actualType, result,
- sizeof(Boolean), &actualSize);
+/* static */
+void wxLog::FlushActive()
+{
+ if ( ms_suspendCount )
+ return;
-exit:
- if (addr.dataHandle)
- AEDisposeDesc(&addr);
- if (theAE.dataHandle)
- AEDisposeDesc(&theAE);
- if (theReply.dataHandle)
- AEDisposeDesc(&theReply);
+ wxLog * const log = GetActiveTarget();
+ if ( log )
+ {
+#if wxUSE_THREADS
+ if ( wxThread::IsMain() )
+ log->FlushThreadMessages();
+#endif // wxUSE_THREADS
- return err;
+ log->Flush();
+ }
}
-#endif
-void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
-{
- wxString str;
- TimeStamp(&str);
- str << szString;
+// ----------------------------------------------------------------------------
+// wxLogBuffer implementation
+// ----------------------------------------------------------------------------
- fputs(str.mb_str(), m_fp);
- fputc(_T('\n'), m_fp);
- fflush(m_fp);
+void wxLogBuffer::Flush()
+{
+ wxLog::Flush();
- // under Windows, programs usually don't have stderr at all, so show the
- // messages also under debugger - unless it's a console program
-#if defined(__WXMSW__) && wxUSE_GUI && !defined(__WXMICROWIN__)
- str += wxT("\r\n") ;
- OutputDebugString(str.c_str());
-#endif // MSW
-#if defined(__WXMAC__) && !defined(__DARWIN__) && wxUSE_GUI
- Str255 pstr ;
- strcpy( (char*) pstr , str.c_str() ) ;
- strcat( (char*) pstr , ";g" ) ;
- c2pstr( (char*) pstr ) ;
-#if __WXDEBUG__
- Boolean running = false ;
-
-/*
- if ( MWDebuggerIsRunning() )
+ if ( !m_str.empty() )
{
- AmIBeingMWDebugged( &running ) ;
+ wxMessageOutputBest out;
+ out.Printf(wxS("%s"), m_str.c_str());
+ m_str.clear();
}
-*/
- if (running)
+}
+
+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 )
{
-#ifdef __powerc
- DebugStr(pstr);
-#else
- SysBreakStr(pstr);
-#endif
+ case wxLOG_Debug:
+ case wxLOG_Trace:
+ wxLog::DoLogTextAtLevel(level, msg);
+ break;
+
+ default:
+ m_str << msg << wxS("\n");
}
+}
+
+// ----------------------------------------------------------------------------
+// wxLogStderr class implementation
+// ----------------------------------------------------------------------------
+
+wxLogStderr::wxLogStderr(FILE *fp)
+{
+ if ( fp == NULL )
+ m_fp = stderr;
else
-#endif
+ m_fp = fp;
+}
+
+void wxLogStderr::DoLogText(const wxString& msg)
+{
+ wxFputs(msg + '\n', m_fp);
+ fflush(m_fp);
+
+ // 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
+ // the debugger window so that they go at least somewhere instead of being
+ // simply lost
+ if ( m_fp == stderr )
{
-#ifdef __powerc
- DebugStr(pstr);
-#else
- DebugStr(pstr);
-#endif
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits && !traits->HasStderr() )
+ {
+ wxMessageOutputDebug().Output(msg + wxS('\n'));
+ }
}
-#endif // Mac
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
#if wxUSE_STD_IOSTREAM
+#include "wx/ioswrap.h"
wxLogStream::wxLogStream(wxSTD ostream *ostr)
{
if ( ostr == NULL )
m_ostr = ostr;
}
-void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogStream::DoLogText(const wxString& msg)
{
- wxString str;
- TimeStamp(&str);
- (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl;
+ (*m_ostr) << msg << wxSTD endl;
}
#endif // wxUSE_STD_IOSTREAM
wxLogChain::wxLogChain(wxLog *logger)
{
+ m_bPassMessages = true;
+
m_logNew = logger;
m_logOld = wxLog::SetActiveTarget(this);
}
-void wxLogChain::SetLog(wxLog *logger)
+wxLogChain::~wxLogChain()
{
+ wxLog::SetActiveTarget(m_logOld);
+
if ( m_logNew != this )
delete m_logNew;
+}
- wxLog::SetActiveTarget(logger);
+void wxLogChain::SetLog(wxLog *logger)
+{
+ if ( m_logNew != this )
+ delete m_logNew;
m_logNew = logger;
}
if ( m_logOld )
m_logOld->Flush();
- // be careful to avoid inifinite recursion
+ // be careful to avoid infinite recursion
if ( m_logNew && m_logNew != this )
m_logNew->Flush();
}
-void wxLogChain::DoLog(wxLogLevel level, const wxChar *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);
}
}
-// ----------------------------------------------------------------------------
-// wxLogPassThrough
-// ----------------------------------------------------------------------------
-
#ifdef __VISUALC__
// "'this' : used in base member initializer list" - so what?
#pragma warning(disable:4355)
#endif // VC++
-wxLogPassThrough::wxLogPassThrough()
+// ----------------------------------------------------------------------------
+// wxLogInterposer
+// ----------------------------------------------------------------------------
+
+wxLogInterposer::wxLogInterposer()
: wxLogChain(this)
{
}
+// ----------------------------------------------------------------------------
+// wxLogInterposerTemp
+// ----------------------------------------------------------------------------
+
+wxLogInterposerTemp::wxLogInterposerTemp()
+ : wxLogChain(this)
+{
+ DetachOldLog();
+}
+
#ifdef __VISUALC__
#pragma warning(default:4355)
#endif // VC++
// static variables
// ----------------------------------------------------------------------------
-wxLog *wxLog::ms_pLogger = (wxLog *)NULL;
-bool wxLog::ms_doLog = TRUE;
-bool wxLog::ms_bAutoCreate = TRUE;
-bool wxLog::ms_bVerbose = FALSE;
+bool wxLog::ms_bRepetCounting = false;
+
+wxLog *wxLog::ms_pLogger = NULL;
+bool wxLog::ms_doLog = true;
+bool wxLog::ms_bAutoCreate = true;
+bool wxLog::ms_bVerbose = false;
+
+wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by default
size_t wxLog::ms_suspendCount = 0;
-#if wxUSE_GUI
- const wxChar *wxLog::ms_timestamp = wxT("%X"); // time only, no date
-#else
- const wxChar *wxLog::ms_timestamp = NULL; // save space
-#endif
+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__)
-#ifdef __WIN32__
+#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
return ::GetLastError();
-#else //WIN16
- // TODO what to do on Windows 3.1?
- return 0;
-#endif //WIN16/32
#else //Unix
return errno;
#endif //Win/Unix
if ( nErrCode == 0 )
nErrCode = wxSysErrorCode();
-#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
-#ifdef __WIN32__
- static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
+#if defined(__WINDOWS__) && !defined(__WXMICROWIN__)
+ static wxChar s_szBuf[1024];
// get error message from system
LPVOID lpMsgBuf;
- FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
- NULL, nErrCode,
+ if ( ::FormatMessage
+ (
+ FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
+ NULL,
+ nErrCode,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
(LPTSTR)&lpMsgBuf,
- 0, NULL);
+ 0,
+ NULL
+ ) == 0 )
+ {
+ // if this happens, something is seriously wrong, so don't use _() here
+ // for safety
+ wxSprintf(s_szBuf, wxS("unknown error %lx"), nErrCode);
+ return s_szBuf;
+ }
+
// copy it to our buffer and free memory
+ // Crashes on SmartPhone (FIXME)
+#if !defined(__SMARTPHONE__) /* of WinCE */
if( lpMsgBuf != 0 )
- wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
- else
- s_szBuf[0] = wxT('\0');
- s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
- LocalFree(lpMsgBuf);
+ {
+ wxStrlcpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf));
+
+ LocalFree(lpMsgBuf);
- // returned string is capitalized and ended with '\r\n' - bad
- s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
- size_t len = wxStrlen(s_szBuf);
- if ( len > 0 ) {
- // truncate string
- if ( s_szBuf[len - 2] == wxT('\r') )
- s_szBuf[len - 2] = wxT('\0');
+ // returned string is capitalized and ended with '\r\n' - bad
+ s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
+ size_t len = wxStrlen(s_szBuf);
+ if ( len > 0 ) {
+ // truncate string
+ if ( s_szBuf[len - 2] == wxS('\r') )
+ s_szBuf[len - 2] = wxS('\0');
+ }
+ }
+ else
+#endif // !__SMARTPHONE__
+ {
+ s_szBuf[0] = wxS('\0');
}
return s_szBuf;
-#else //Win16
- // TODO
- return NULL;
-#endif // Win16/32
-#else // Unix
-#if wxUSE_UNICODE
- static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
- wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
- return s_szBuf;
-#else
- return strerror((int)nErrCode);
-#endif
-#endif // Win/Unix
+#else // !__WINDOWS__
+ #if wxUSE_UNICODE
+ static wchar_t s_wzBuf[1024];
+ wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
+ WXSIZEOF(s_wzBuf) - 1);
+ return s_wzBuf;
+ #else
+ return strerror((int)nErrCode);
+ #endif
+#endif // __WINDOWS__/!__WINDOWS__
}
-#endif //wxUSE_LOG
+#endif // wxUSE_LOG
projects / wxWidgets.git / blobdiff