Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add wxLogFormatter to allow easier wxLog output customization.

Browse Source 
Delegate the log string creation to wxLogFormatter. This allows defining a
custom object of a class derived from it to customize the log output instead
of having to override DoLogRecord() in wxLog itself.

Closes #13792.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70086 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2011-12-22 13:35:01 +00:00
parent 2cc6b51b90
commit 4ffdb64018
5 changed files with 283 additions and 74 deletions
Download Patch File Download Diff File Expand all files Collapse all files

133
src/common/log.cpp
View File

@@ -204,6 +204,61 @@ void wxSafeShowMessage(const wxString& title, const wxString& text)
#endif
}
// ----------------------------------------------------------------------------
// wxLogFormatter class implementation
// ----------------------------------------------------------------------------
wxString
wxLogFormatter::Format(wxLogLevel level,
const wxString& msg,
const wxLogRecordInfo& info) const
{
wxString prefix = FormatTime(info.timestamp);
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 __WXMSW__
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 // !__WXMSW__
}
return prefix + msg;
}
wxString
wxLogFormatter::FormatTime(time_t t) const
{
wxString str;
// don't time stamp debug messages under MSW as debug viewers usually
// already have an option to do it
#ifdef __WXMSW__
if ( level != wxLOG_Debug && level != wxLOG_Trace )
#endif // __WXMSW__
wxLog::TimeStamp(&str, t);
return str;
}
// ----------------------------------------------------------------------------
// wxLog class implementation
// ----------------------------------------------------------------------------
@@ -266,6 +321,8 @@ wxLog::~wxLog()
gs_prevLog.numRepeated
);
}
delete m_formatter;
}
// ----------------------------------------------------------------------------
@@ -404,47 +461,8 @@ void wxLog::DoLogRecord(wxLogLevel level,
wxUnusedVar(info);
#endif // WXWIN_COMPATIBILITY_2_8/!WXWIN_COMPATIBILITY_2_8
// TODO: it would be better to extract message formatting in a separate
// wxLogFormatter class but for now we hard code formatting here
wxString prefix;
// don't time stamp debug messages under MSW as debug viewers usually
// already have an option to do it
#ifdef __WXMSW__
if ( level != wxLOG_Debug && level != wxLOG_Trace )
#endif // __WXMSW__
TimeStamp(&prefix);
// TODO: use the other wxLogRecordInfo fields
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 __WXMSW__
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 // !__WXMSW__
}
DoLogTextAtLevel(level, prefix + msg);
// Use wxLogFormatter to format the message
DoLogTextAtLevel(level, m_formatter->Format (level, msg, info));
}
void wxLog::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
@@ -692,17 +710,38 @@ void wxLog::ClearTraceMasks()
// wxLog miscellaneous other methods
// ----------------------------------------------------------------------------
#if wxUSE_DATETIME
void wxLog::TimeStamp(wxString *str)
{
#if wxUSE_DATETIME
if ( !ms_timestamp.empty() )
{
*str = wxDateTime::UNow().Format(ms_timestamp);
*str += wxS(": ");
}
#endif // wxUSE_DATETIME
}
void wxLog::TimeStamp(wxString *str, time_t t)
{
if ( !ms_timestamp.empty() )
{
*str = wxDateTime(t).Format(ms_timestamp);
*str += wxS(": ");
}
}
#else // !wxUSE_DATETIME
void wxLog::TimeStamp(wxString*)
{
}
void wxLog::TimeStamp(wxString*, time_t)
{
}
#endif // wxUSE_DATETIME/!wxUSE_DATETIME
#if wxUSE_THREADS
void wxLog::FlushThreadMessages()
@@ -745,6 +784,14 @@ bool wxLog::EnableThreadLogging(bool enable)
#endif // wxUSE_THREADS
wxLogFormatter *wxLog::SetFormatter(wxLogFormatter* formatter)
{
wxLogFormatter* formatterOld = m_formatter;
m_formatter = formatter ? formatter : new wxLogFormatter;
return formatterOld;
}
void wxLog::Flush()
{
LogLastRepeatIfNeeded();