X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1e8a4bc241f0031d538a3ea474211b9840ca2bd8..8b655af19d31f61990ceb794edd3df7cf41414e9:/src/common/log.cpp diff --git a/src/common/log.cpp b/src/common/log.cpp index aa30e87e1a..53de91f046 100644 --- a/src/common/log.cpp +++ b/src/common/log.cpp @@ -6,7 +6,7 @@ // Created: 29/01/98 // RCS-ID: $Id$ // Copyright: (c) 1998 Vadim Zeitlin -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// // ============================================================================ @@ -16,47 +16,40 @@ // ---------------------------------------------------------------------------- // headers // ---------------------------------------------------------------------------- + #ifdef __GNUG__ - #pragma implementation "log.h" + #pragma implementation "log.h" #endif // For compilers that support precompilation, includes "wx.h". #include "wx/wxprec.h" #ifdef __BORLANDC__ - #pragma hdrstop + #pragma hdrstop #endif +#if wxUSE_LOG + // wxWindows #ifndef WX_PRECOMP - #include - #include - #include - #include - #include - #include - #include - #include - #include + #include "wx/app.h" + #include "wx/intl.h" + #include "wx/string.h" #endif //WX_PRECOMP -#include -#include -#include -#include +#include "wx/apptrait.h" +#include "wx/file.h" +#include "wx/log.h" +#include "wx/msgout.h" +#include "wx/textfile.h" +#include "wx/thread.h" +#include "wx/utils.h" +#include "wx/wxchar.h" // other standard headers -#include -#include -#include - -#ifdef __WXMSW__ - #include - // Redefines OutputDebugString if necessary - #include "wx/msw/private.h" -#else //Unix - #include -#endif //Win/Unix +#include +#include +#include // ---------------------------------------------------------------------------- // non member functions @@ -69,17 +62,36 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz); #endif +// ============================================================================ +// implementation +// ============================================================================ + // ---------------------------------------------------------------------------- -// global variables +// globals // ---------------------------------------------------------------------------- -// we use a global variable to store the frame pointer for wxLogStatus - bad, -// but it's he easiest way -static wxFrame *gs_pFrame; +// 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) -// ============================================================================ -// implementation -// ============================================================================ +// static buffer for error messages +static wxChar s_szBufStatic[LOG_BUFFER_SIZE]; + +static wxChar *s_szBuf = s_szBufStatic; +static size_t s_szBufSize = WXSIZEOF( s_szBufStatic ); + +#if wxUSE_THREADS + +// the critical section protecting the static buffer +static wxCriticalSection gs_csLogBuf; + +#endif // wxUSE_THREADS + +// return true if we have a non NULL non disabled log target +static inline bool IsLoggingEnabled() +{ + return wxLog::IsEnabled() && (wxLog::GetActiveTarget() != NULL); +} // ---------------------------------------------------------------------------- // implementation of Log functions @@ -88,110 +100,190 @@ static wxFrame *gs_pFrame; // macros and not all compilers inline vararg functions. // ---------------------------------------------------------------------------- -// 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) - -// static buffer for error messages (@@@ MT-unsafe) -static char s_szBuf[LOG_BUFFER_SIZE]; +// wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it +static inline void PrintfInLogBug(const wxChar *szFormat, va_list argptr) +{ + if ( wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr) < 0 ) + { + // must NUL-terminate it manually + s_szBuf[s_szBufSize - 1] = _T('\0'); + } + //else: NUL-terminated by vsnprintf() +} // generic log function -void wxLogGeneric(wxLogLevel level, const char *szFormat, ...) +void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr) +{ + if ( IsLoggingEnabled() ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + + PrintfInLogBug(szFormat, argptr); + + wxLog::OnLog(level, s_szBuf, time(NULL)); + } +} + +void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...) { - if ( wxLog::GetActiveTarget() != NULL ) { va_list argptr; va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); + wxVLogGeneric(level, szFormat, argptr); va_end(argptr); - - wxLog::OnLog(level, s_szBuf); - } } -#define IMPLEMENT_LOG_FUNCTION(level) \ - void wxLog##level(const char *szFormat, ...) \ - { \ - if ( wxLog::GetActiveTarget() != NULL ) { \ - va_list argptr; \ - va_start(argptr, szFormat); \ - vsprintf(s_szBuf, szFormat, argptr); \ - va_end(argptr); \ - \ - wxLog::OnLog(wxLOG_##level, s_szBuf); \ - } \ +#define IMPLEMENT_LOG_FUNCTION(level) \ + void wxVLog##level(const wxChar *szFormat, va_list argptr) \ + { \ + if ( IsLoggingEnabled() ) { \ + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \ + \ + PrintfInLogBug(szFormat, argptr); \ + \ + wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ + } \ + } \ + \ + void wxLog##level(const wxChar *szFormat, ...) \ + { \ + va_list argptr; \ + va_start(argptr, szFormat); \ + wxVLog##level(szFormat, argptr); \ + va_end(argptr); \ } -IMPLEMENT_LOG_FUNCTION(FatalError) IMPLEMENT_LOG_FUNCTION(Error) IMPLEMENT_LOG_FUNCTION(Warning) IMPLEMENT_LOG_FUNCTION(Message) IMPLEMENT_LOG_FUNCTION(Info) IMPLEMENT_LOG_FUNCTION(Status) -// accepts an additional argument which tells to which frame the output should -// be directed -void wxLogStatus(wxFrame *pFrame, const char *szFormat, ...) +void wxSafeShowMessage(const wxString& title, const wxString& text) +{ +#ifdef __WINDOWS__ + ::MessageBox(NULL, text, title, MB_OK | MB_ICONSTOP); +#else + wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str()); +#endif +} + +// fatal errors can't be suppressed nor handled by the custom log target and +// always terminate the program +void wxVLogFatalError(const wxChar *szFormat, va_list argptr) +{ + wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); + + wxSafeShowMessage(_T("Fatal Error"), s_szBuf); + + abort(); +} + +void wxLogFatalError(const wxChar *szFormat, ...) { - wxLog *pLog = wxLog::GetActiveTarget(); - if ( pLog != NULL ) { va_list argptr; va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); + wxVLogFatalError(szFormat, argptr); va_end(argptr); - - wxASSERT( gs_pFrame == NULL ); // should be reset! - gs_pFrame = pFrame; - wxLog::OnLog(wxLOG_Status, s_szBuf); - gs_pFrame = (wxFrame *) NULL; - } } // same as info, but only if 'verbose' mode is on -void wxLogVerbose(const char *szFormat, ...) +void wxVLogVerbose(const wxChar *szFormat, va_list argptr) +{ + if ( IsLoggingEnabled() ) { + wxLog *pLog = wxLog::GetActiveTarget(); + if ( pLog != NULL && pLog->GetVerbose() ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + + wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); + + wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL)); + } + } +} + +void wxLogVerbose(const wxChar *szFormat, ...) { - wxLog *pLog = wxLog::GetActiveTarget(); - if ( pLog != NULL && pLog->GetVerbose() ) { va_list argptr; va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); + wxVLogVerbose(szFormat, argptr); va_end(argptr); - - wxLog::OnLog(wxLOG_Info, s_szBuf); - } } // debug functions #ifdef __WXDEBUG__ -#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \ - void wxLog##level(const char *szFormat, ...) \ - { \ - if ( wxLog::GetActiveTarget() != NULL ) { \ - va_list argptr; \ - va_start(argptr, szFormat); \ - vsprintf(s_szBuf, szFormat, argptr); \ - va_end(argptr); \ - \ - wxLog::OnLog(wxLOG_##level, s_szBuf); \ - } \ +#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \ + void wxVLog##level(const wxChar *szFormat, va_list argptr) \ + { \ + if ( IsLoggingEnabled() ) { \ + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \ + \ + wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); \ + \ + wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ + } \ + } \ + void wxLog##level(const wxChar *szFormat, ...) \ + { \ + va_list argptr; \ + va_start(argptr, szFormat); \ + wxVLog##level(szFormat, argptr); \ + va_end(argptr); \ + } + + void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr) + { + if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask) ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + + wxChar *p = s_szBuf; + size_t len = s_szBufSize; + 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; + + wxVsnprintf(p, len, szFormat, argptr); + + wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); + } } - void wxLogTrace(wxTraceMask mask, const char *szFormat, ...) + void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...) { - wxLog *pLog = wxLog::GetActiveTarget(); + va_list argptr; + va_start(argptr, szFormat); + wxVLogTrace(mask, szFormat, argptr); + va_end(argptr); + } + void wxVLogTrace(wxTraceMask mask, const wxChar *szFormat, 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 ( pLog != NULL && ((pLog->GetTraceMask() & mask) == mask) ) { - va_list argptr; - va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + if ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + + wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); - wxLog::OnLog(wxLOG_Trace, s_szBuf); + wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); } } + void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...) + { + va_list argptr; + va_start(argptr, szFormat); + wxVLogTrace(mask, szFormat, argptr); + va_end(argptr); + } + #else // release #define IMPLEMENT_LOG_DEBUG_FUNCTION(level) #endif @@ -205,31 +297,50 @@ IMPLEMENT_LOG_DEBUG_FUNCTION(Trace) // common part of both wxLogSysError void wxLogSysErrorHelper(long lErrCode) { - char szErrMsg[LOG_BUFFER_SIZE / 2]; - sprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); - strncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - strlen(s_szBuf)); + wxChar szErrMsg[LOG_BUFFER_SIZE / 2]; + wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg), + _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); + wxStrncat(s_szBuf, szErrMsg, s_szBufSize - wxStrlen(s_szBuf)); - wxLog::OnLog(wxLOG_Error, s_szBuf); + wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL)); } -void WXDLLEXPORT wxLogSysError(const char *szFormat, ...) +void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr) { - va_list argptr; - va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + if ( IsLoggingEnabled() ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + + wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); - wxLogSysErrorHelper(wxSysErrorCode()); + wxLogSysErrorHelper(wxSysErrorCode()); + } } -void WXDLLEXPORT wxLogSysError(long lErrCode, const char *szFormat, ...) +void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...) { - va_list argptr; - va_start(argptr, szFormat); - vsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + va_list argptr; + va_start(argptr, szFormat); + wxVLogSysError(szFormat, argptr); + va_end(argptr); +} + +void WXDLLEXPORT wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr) +{ + if ( IsLoggingEnabled() ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + + wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); - wxLogSysErrorHelper(lErrCode); + wxLogSysErrorHelper(lErrCode); + } +} + +void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...) +{ + va_list argptr; + va_start(argptr, szFormat); + wxVLogSysError(lErrCode, szFormat, argptr); + va_end(argptr); } // ---------------------------------------------------------------------------- @@ -238,611 +349,279 @@ void WXDLLEXPORT wxLogSysError(long lErrCode, const char *szFormat, ...) wxLog::wxLog() { - m_bHasMessages = FALSE; - - // enable verbose messages by default in the debug builds -#ifdef __WXDEBUG__ - m_bVerbose = TRUE; -#else // release - m_bVerbose = FALSE; -#endif // debug/release - - m_szTimeFormat = "[%d/%b/%y %H:%M:%S] "; } -wxLog *wxLog::GetActiveTarget() +wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size) { - if ( ms_bAutoCreate && ms_pLogger == NULL ) { - // prevent infinite recursion if someone calls wxLogXXX() from - // wxApp::CreateLogTarget() - static bool s_bInGetActiveTarget = FALSE; - if ( !s_bInGetActiveTarget ) { - s_bInGetActiveTarget = TRUE; - - #ifdef wxUSE_NOGUI - ms_pLogger = new wxLogStderr; - #else - // ask the application to create a log target for us - if ( wxTheApp != NULL ) - ms_pLogger = wxTheApp->CreateLogTarget(); - else - ms_pLogger = new wxLogStderr; - #endif - - s_bInGetActiveTarget = FALSE; - - // do nothing if it fails - what can we do? + wxChar *oldbuf = s_szBuf; + + if( buf == 0 ) + { + s_szBuf = s_szBufStatic; + s_szBufSize = WXSIZEOF( s_szBufStatic ); + } + else + { + s_szBuf = buf; + s_szBufSize = size; } - } - return ms_pLogger; + return (oldbuf == s_szBufStatic ) ? 0 : oldbuf; } -wxLog *wxLog::SetActiveTarget(wxLog *pLogger) +wxLog *wxLog::GetActiveTarget() { - if ( ms_pLogger != NULL ) { - // flush the old messages before changing because otherwise they might - // get lost later if this target is not restored - ms_pLogger->Flush(); - } + if ( ms_bAutoCreate && ms_pLogger == NULL ) { + // prevent infinite recursion if someone calls wxLogXXX() from + // wxApp::CreateLogTarget() + static bool s_bInGetActiveTarget = FALSE; + if ( !s_bInGetActiveTarget ) { + s_bInGetActiveTarget = TRUE; - wxLog *pOldLogger = ms_pLogger; - ms_pLogger = pLogger; + // ask the application to create a log target for us + if ( wxTheApp != NULL ) + ms_pLogger = wxTheApp->CreateLogTarget(); + else + ms_pLogger = new wxLogStderr; - return pOldLogger; -} + s_bInGetActiveTarget = FALSE; -wxString wxLog::TimeStamp() const -{ - wxString str; + // do nothing if it fails - what can we do? + } + } -/* Let's disable TimeStamp and see if anyone complains. - * If not, we'll remove it, since it's probably unlikely - * to ever be used. -- JACS 22/11/98 - if ( !IsEmpty(m_szTimeFormat) ) { - char szBuf[128]; - time_t timeNow; - struct tm *ptmNow; + return ms_pLogger; +} - time(&timeNow); - ptmNow = localtime(&timeNow); +wxLog *wxLog::SetActiveTarget(wxLog *pLogger) +{ + if ( ms_pLogger != NULL ) { + // flush the old messages before changing because otherwise they might + // get lost later if this target is not restored + ms_pLogger->Flush(); + } - strftime(szBuf, WXSIZEOF(szBuf), m_szTimeFormat, ptmNow); - str = szBuf; - } -*/ + wxLog *pOldLogger = ms_pLogger; + ms_pLogger = pLogger; - return str; + return pOldLogger; } -void wxLog::DoLog(wxLogLevel level, const char *szString) +void wxLog::DontCreateOnDemand() { - // prepend a timestamp if not disabled - wxString str = TimeStamp(); - - switch ( level ) { - case wxLOG_FatalError: - DoLogString(str << _("Fatal error: ") << szString); - DoLogString(_("Program aborted.")); - Flush(); - abort(); - break; - - case wxLOG_Error: - DoLogString(str << _("Error: ") << szString); - break; - - case wxLOG_Warning: - DoLogString(str << _("Warning: ") << szString); - break; - - case wxLOG_Info: - case wxLOG_Message: - if ( GetVerbose() ) - DoLogString(str + szString); - // fall through - - case wxLOG_Status: - // nothing to do - break; - - case wxLOG_Trace: - case wxLOG_Debug: - #ifdef __WXDEBUG__ - // DoLogString(str << (level == wxLOG_Trace ? _("Trace") : _("Debug")) - // << ": " << szString); - // JACS: we don't really want to prefix with 'Debug'. It's just extra - // verbiage. - DoLogString(szString); - #endif - - break; - - default: - wxFAIL_MSG(_("unknown log level in wxLog::DoLog")); - } -} + ms_bAutoCreate = FALSE; -void wxLog::DoLogString(const char *WXUNUSED(szString)) -{ - wxFAIL_MSG(_("DoLogString must be overrided if it's called.")); + // 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 + // memory leak reports from wxWin memory tracking code + ClearTraceMasks(); } -void wxLog::Flush() +void wxLog::RemoveTraceMask(const wxString& str) { - // do nothing + int index = ms_aTraceMasks.Index(str); + if ( index != wxNOT_FOUND ) + ms_aTraceMasks.Remove((size_t)index); } -// ---------------------------------------------------------------------------- -// wxLogStderr class implementation -// ---------------------------------------------------------------------------- - -wxLogStderr::wxLogStderr(FILE *fp) +void wxLog::ClearTraceMasks() { - if ( fp == NULL ) - m_fp = stderr; - else - m_fp = fp; + ms_aTraceMasks.Clear(); } -void wxLogStderr::DoLogString(const char *szString) +void wxLog::TimeStamp(wxString *str) { - wxString str(szString); - str << '\n'; - - fputs(str, m_fp); - fflush(m_fp); - - // under Windows, programs usually don't have stderr at all, so make show the - // messages also under debugger -#ifdef __WXMSW__ - OutputDebugString(str + '\r'); -#endif // MSW -} - -// ---------------------------------------------------------------------------- -// wxLogStream implementation -// ---------------------------------------------------------------------------- + if ( ms_timestamp ) + { + wxChar buf[256]; + time_t timeNow; + (void)time(&timeNow); + wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow)); -#if wxUSE_STD_IOSTREAM -wxLogStream::wxLogStream(ostream *ostr) -{ - if ( ostr == NULL ) - m_ostr = &cerr; - else - m_ostr = ostr; + str->Empty(); + *str << buf << wxT(": "); + } } -void wxLogStream::DoLogString(const char *szString) +void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t) { - (*m_ostr) << szString << endl << flush; + 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; + + case wxLOG_Warning: + DoLogString(wxString(_("Warning: ")) + szString, t); + break; + + case wxLOG_Info: + if ( GetVerbose() ) + case wxLOG_Message: + case wxLOG_Status: + default: // log unknown log levels too + DoLogString(szString, t); + break; + + 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; + } } -#endif - -#ifndef wxUSE_NOGUI -// ---------------------------------------------------------------------------- -// wxLogTextCtrl implementation -// ---------------------------------------------------------------------------- - -#if wxUSE_STD_IOSTREAM -wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl) -// DLL mode in wxMSW, can't use it. -#if defined(NO_TEXT_WINDOW_STREAM) -#else - : wxLogStream(new ostream(pTextCtrl)) -#endif +void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t)) { + wxFAIL_MSG(wxT("DoLogString must be overriden if it's called.")); } -wxLogTextCtrl::~wxLogTextCtrl() +void wxLog::Flush() { - delete m_ostr; + // nothing to do here } -#endif // ---------------------------------------------------------------------------- -// wxLogGui implementation +// wxLogStderr class implementation // ---------------------------------------------------------------------------- -wxLogGui::wxLogGui() -{ - m_bErrors = FALSE; -} - -void wxLogGui::Flush() +wxLogStderr::wxLogStderr(FILE *fp) { - if ( !m_bHasMessages ) - return; - - // do it right now to block any new calls to Flush() while we're here - m_bHasMessages = FALSE; - - // @@@ ugly... - - // concatenate all strings (but not too many to not overfill the msg box) - wxString str; - size_t nLines = 0, - nMsgCount = m_aMessages.Count(); - - // start from the most recent message - for ( size_t n = nMsgCount; n > 0; n-- ) { - // for Windows strings longer than this value are wrapped (NT 4.0) - const size_t nMsgLineWidth = 156; - - nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth; - - if ( nLines > 25 ) // don't put too many lines in message box - break; - - str << m_aMessages[n - 1] << "\n"; - } - - if ( m_bErrors ) { - wxMessageBox(str, _("Error"), wxOK | wxICON_EXCLAMATION); - } - else { - wxMessageBox(str, _("Information"), wxOK | wxICON_INFORMATION); - } - - // no undisplayed messages whatsoever - m_bErrors = FALSE; - m_aMessages.Empty(); + if ( fp == NULL ) + m_fp = stderr; + else + m_fp = fp; } -// the default behaviour is to discard all informational messages if there -// are any errors/warnings. -void wxLogGui::DoLog(wxLogLevel level, const char *szString) +void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) { - switch ( level ) { - case wxLOG_Info: - if ( GetVerbose() ) - case wxLOG_Message: - if ( !m_bErrors ) { - m_aMessages.Add(szString); - m_bHasMessages = TRUE; - } - break; - - case wxLOG_Status: - { - // find the top window and set it's status text if it has any - wxFrame *pFrame = gs_pFrame; - if ( pFrame == NULL ) { - wxWindow *pWin = wxTheApp->GetTopWindow(); - if ( pWin != NULL && pWin->IsKindOf(CLASSINFO(wxFrame)) ) { - pFrame = (wxFrame *)pWin; - } - } + wxString str; + TimeStamp(&str); + str << szString; - if ( pFrame != NULL ) - pFrame->SetStatusText(szString); - } - break; + fputs(str.mb_str(), m_fp); + fputc(_T('\n'), m_fp); + fflush(m_fp); - case wxLOG_Trace: - case wxLOG_Debug: - #ifdef __WXDEBUG__ + // 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 ) + { + wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL; + if ( traits && !traits->HasStderr() ) { - wxString strTime = TimeStamp(); - - #ifdef __WXMSW__ - // don't prepend debug/trace here: it goes to the debug window - // anyhow, but do put a timestamp - OutputDebugString(strTime + szString + "\n\r"); - #else - // send them to stderr - fprintf(stderr, "%s %s: %s\n", - strTime.c_str(), - level == wxLOG_Trace ? "Trace" : "Debug", - szString); - fflush(stderr); - #endif + wxMessageOutputDebug().Printf(_T("%s"), str.c_str()); } - #endif // __WXDEBUG__ - break; - - case wxLOG_FatalError: - // show this one immediately - wxMessageBox(szString, _("Fatal error"), wxICON_HAND); - break; - - case wxLOG_Error: - case wxLOG_Warning: - // discard earlier informational messages if this is the 1st error - if ( !m_bErrors ) { - m_aMessages.Empty(); - m_bHasMessages = TRUE; - m_bErrors = TRUE; - } - - m_aMessages.Add(szString); - break; - - default: - wxFAIL_MSG(_("unknown log level in wxLogGui::DoLog")); - } + } } // ---------------------------------------------------------------------------- -// wxLogWindow and wxLogFrame implementation +// wxLogStream implementation // ---------------------------------------------------------------------------- -// log frame class -// --------------- -class wxLogFrame : public wxFrame -{ -public: - // ctor & dtor - wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle); - virtual ~wxLogFrame(); - - // menu callbacks - void OnClose(wxCommandEvent& event); - void OnCloseWindow(wxCloseEvent& event); - void OnSave (wxCommandEvent& event); - void OnClear(wxCommandEvent& event); - - void OnIdle(wxIdleEvent&); - - // accessors - wxTextCtrl *TextCtrl() const { return m_pTextCtrl; } - -private: - enum - { - Menu_Close = 100, - Menu_Save, - Menu_Clear - }; - - // instead of closing just hide the window to be able to Show() it later - void DoClose() { Show(FALSE); } - - wxTextCtrl *m_pTextCtrl; - wxLogWindow *m_log; - - DECLARE_EVENT_TABLE() -}; - -BEGIN_EVENT_TABLE(wxLogFrame, wxFrame) - // wxLogWindow menu events - EVT_MENU(Menu_Close, wxLogFrame::OnClose) - EVT_MENU(Menu_Save, wxLogFrame::OnSave) - EVT_MENU(Menu_Clear, wxLogFrame::OnClear) - - EVT_CLOSE(wxLogFrame::OnCloseWindow) -END_EVENT_TABLE() - -wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const char *szTitle) - : wxFrame(pParent, -1, szTitle) +#if wxUSE_STD_IOSTREAM +#include "wx/ioswrap.h" +wxLogStream::wxLogStream(wxSTD ostream *ostr) { - m_log = log; - - // @@ kludge: wxSIMPLE_BORDER is simply to prevent wxWindows from creating - // a rich edit control instead of a normal one we want in wxMSW - m_pTextCtrl = new wxTextCtrl(this, -1, wxEmptyString, wxDefaultPosition, - wxDefaultSize, - //wxSIMPLE_BORDER | - wxTE_MULTILINE | - wxHSCROLL | - wxTE_READONLY); - - // create menu - wxMenuBar *pMenuBar = new wxMenuBar; - wxMenu *pMenu = new wxMenu; - pMenu->Append(Menu_Save, _("&Save..."), _("Save log contents to file")); - pMenu->Append(Menu_Clear, _("C&lear"), _("Clear the log contents")); - pMenu->AppendSeparator(); - pMenu->Append(Menu_Close, _("&Close"), _("Close this window")); - pMenuBar->Append(pMenu, _("&Log")); - SetMenuBar(pMenuBar); - - // status bar for menu prompts - CreateStatusBar(); - - m_log->OnFrameCreate(this); + if ( ostr == NULL ) + m_ostr = &wxSTD cerr; + else + m_ostr = ostr; } -void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event)) +void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) { - DoClose(); + wxString str; + TimeStamp(&str); + (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl; } +#endif // wxUSE_STD_IOSTREAM -void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event)) -{ - DoClose(); -} +// ---------------------------------------------------------------------------- +// wxLogChain +// ---------------------------------------------------------------------------- -void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event)) +wxLogChain::wxLogChain(wxLog *logger) { - // get the file name - // ----------------- - const char *szFileName = wxSaveFileSelector("log", "txt", "log.txt"); - if ( szFileName == NULL ) { - // cancelled - return; - } - - // open file - // --------- - wxFile file; - bool bOk = FALSE; - if ( wxFile::Exists(szFileName) ) { - bool bAppend = FALSE; - wxString strMsg; - strMsg.Printf(_("Append log to file '%s' " - "(choosing [No] will overwrite it)?"), szFileName); - switch ( wxMessageBox(strMsg, _("Question"), wxYES_NO | wxCANCEL) ) { - case wxYES: - bAppend = TRUE; - break; - - case wxNO: - bAppend = FALSE; - break; - - case wxCANCEL: - return; - - default: - wxFAIL_MSG(_("invalid message box return value")); - } + m_bPassMessages = TRUE; - if ( bAppend ) { - bOk = file.Open(szFileName, wxFile::write_append); - } - else { - bOk = file.Create(szFileName, TRUE /* overwrite */); - } - } - else { - bOk = file.Create(szFileName); - } - - // retrieve text and save it - // ------------------------- - int nLines = m_pTextCtrl->GetNumberOfLines(); - for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) { - bOk = file.Write(m_pTextCtrl->GetLineText(nLine) + -// we're not going to pull in the whole wxTextFile if all we need is this... -#if wxUSE_TEXTFILE - wxTextFile::GetEOL() -#else // !wxUSE_TEXTFILE - '\n' -#endif // wxUSE_TEXTFILE - ); - } - - if ( bOk ) - bOk = file.Close(); - - if ( !bOk ) { - wxLogError(_("Can't save log contents to file.")); - } - else { - wxLogStatus(this, _("Log saved to the file '%s'."), szFileName); - } + m_logNew = logger; + m_logOld = wxLog::SetActiveTarget(this); } -void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event)) +wxLogChain::~wxLogChain() { - m_pTextCtrl->Clear(); -} + delete m_logOld; -wxLogFrame::~wxLogFrame() -{ - m_log->OnFrameDelete(this); + if ( m_logNew != this ) + delete m_logNew; } -// wxLogWindow -// ----------- -wxLogWindow::wxLogWindow(wxFrame *pParent, - const char *szTitle, - bool bShow, - bool bDoPass) +void wxLogChain::SetLog(wxLog *logger) { - m_bPassMessages = bDoPass; + if ( m_logNew != this ) + delete m_logNew; - m_pLogFrame = new wxLogFrame(pParent, this, szTitle); - m_pOldLog = wxLog::SetActiveTarget(this); - - if ( bShow ) - m_pLogFrame->Show(TRUE); -} - -void wxLogWindow::Show(bool bShow) -{ - m_pLogFrame->Show(bShow); + m_logNew = logger; } -void wxLogWindow::Flush() +void wxLogChain::Flush() { - if ( m_pOldLog != NULL ) - m_pOldLog->Flush(); + if ( m_logOld ) + m_logOld->Flush(); - m_bHasMessages = FALSE; + // be careful to avoid infinite recursion + if ( m_logNew && m_logNew != this ) + m_logNew->Flush(); } -void wxLogWindow::DoLog(wxLogLevel level, const char *szString) +void wxLogChain::DoLog(wxLogLevel level, const wxChar *szString, time_t t) { - // first let the previous logger show it - if ( m_pOldLog != NULL && m_bPassMessages ) { - // @@@ why can't we access protected wxLog method from here (we derive - // from wxLog)? gcc gives "DoLog is protected in this context", what - // does this mean? Anyhow, the cast is harmless and let's us do what - // we want. - ((wxLogWindow *)m_pOldLog)->DoLog(level, szString); - } - - if ( m_pLogFrame ) { - switch ( level ) { - case wxLOG_Status: - // by default, these messages are ignored by wxLog, so process - // them ourselves - { - wxString str = TimeStamp(); - str << _("Status: ") << szString; - DoLogString(str); - } - break; - - // don't put trace messages in the text window for 2 reasons: - // 1) there are too many of them - // 2) they may provoke other trace messages thus sending a program - // into an infinite loop - case wxLOG_Trace: - break; - - default: - // and this will format it nicely and call our DoLogString() - wxLog::DoLog(level, szString); + // 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_bHasMessages = TRUE; -} -void wxLogWindow::DoLogString(const char *szString) -{ - // put the text into our window - wxTextCtrl *pText = m_pLogFrame->TextCtrl(); - - // remove selection (WriteText is in fact ReplaceSelection) - #ifdef __WXMSW__ - long nLen = pText->GetLastPosition(); - pText->SetSelection(nLen, nLen); - #endif // Windows - - pText->WriteText(szString); - pText->WriteText("\n"); // "\n" ok here (_not_ "\r\n") - - // TODO ensure that the line can be seen -} - -wxFrame *wxLogWindow::GetFrame() const -{ - return m_pLogFrame; + if ( m_logNew && m_logNew != this ) + { + // as above... + ((wxLogChain *)m_logNew)->DoLog(level, szString, t); + } } -void wxLogWindow::OnFrameCreate(wxFrame * WXUNUSED(frame)) -{ -} +// ---------------------------------------------------------------------------- +// wxLogPassThrough +// ---------------------------------------------------------------------------- -void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame)) -{ - m_pLogFrame = (wxLogFrame *)NULL; -} +#ifdef __VISUALC__ + // "'this' : used in base member initializer list" - so what? + #pragma warning(disable:4355) +#endif // VC++ -wxLogWindow::~wxLogWindow() +wxLogPassThrough::wxLogPassThrough() + : wxLogChain(this) { - delete m_pOldLog; - - // may be NULL if log frame already auto destroyed itself - delete m_pLogFrame; } -#endif //wxUSE_NOGUI +#ifdef __VISUALC__ + #pragma warning(default:4355) +#endif // VC++ // ============================================================================ // Global functions/variables @@ -851,10 +630,20 @@ wxLogWindow::~wxLogWindow() // ---------------------------------------------------------------------------- // static variables // ---------------------------------------------------------------------------- -wxLog *wxLog::ms_pLogger = (wxLog *) NULL; -bool wxLog::ms_doLog = TRUE; -bool wxLog::ms_bAutoCreate = TRUE; -wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; + +wxLog *wxLog::ms_pLogger = (wxLog *)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; + +const wxChar *wxLog::ms_timestamp = wxT("%X"); // time only, no date + +wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; +wxArrayString wxLog::ms_aTraceMasks; // ---------------------------------------------------------------------------- // stdout error logging helper @@ -863,33 +652,33 @@ wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; // helper function: wraps the message and justifies it under given position // (looks more pretty on the terminal). Also adds newline at the end. // -// @@ this is now disabled until I find a portable way of determining the -// terminal window size (ok, I found it but does anybody really cares?) -#ifdef LOG_PRETTY_WRAP +// TODO this is now disabled until I find a portable way of determining the +// terminal window size (ok, I found it but does anybody really cares?) +#ifdef LOG_PRETTY_WRAP static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz) { - size_t nMax = 80; // @@@@ - size_t nStart = strlen(pszPrefix); - fputs(pszPrefix, f); - - size_t n; - while ( *psz != '\0' ) { - for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ ) - putc(*psz++, f); - - // wrapped? - if ( *psz != '\0' ) { - /*putc('\n', f);*/ - for ( n = 0; n < nStart; n++ ) - putc(' ', f); - - // as we wrapped, squeeze all white space - while ( isspace(*psz) ) - psz++; + size_t nMax = 80; // FIXME + size_t nStart = strlen(pszPrefix); + fputs(pszPrefix, f); + + size_t n; + while ( *psz != '\0' ) { + for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ ) + putc(*psz++, f); + + // wrapped? + if ( *psz != '\0' ) { + /*putc('\n', f);*/ + for ( n = 0; n < nStart; n++ ) + putc(' ', f); + + // as we wrapped, squeeze all white space + while ( isspace(*psz) ) + psz++; + } } - } - putc('\n', f); + putc('\n', f); } #endif //LOG_PRETTY_WRAP @@ -900,148 +689,71 @@ static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz) // get error code from syste unsigned long wxSysErrorCode() { - #ifdef __WXMSW__ - #ifdef __WIN32__ - return ::GetLastError(); - #else //WIN16 - // @@@@ what to do on Windows 3.1? - return 0; - #endif //WIN16/32 - #else //Unix +#if defined(__WXMSW__) && !defined(__WXMICROWIN__) +#ifdef __WIN32__ + return ::GetLastError(); +#else //WIN16 + // TODO what to do on Windows 3.1? + return 0; +#endif //WIN16/32 +#else //Unix return errno; - #endif //Win/Unix +#endif //Win/Unix } // get error message from system -const char *wxSysErrorMsg(unsigned long nErrCode) -{ - if ( nErrCode == 0 ) - nErrCode = wxSysErrorCode(); - - #ifdef __WXMSW__ - #ifdef __WIN32__ - static char s_szBuf[LOG_BUFFER_SIZE / 2]; - - // get error message from system - LPVOID lpMsgBuf; - FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, - NULL, nErrCode, - MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), - (LPTSTR)&lpMsgBuf, - 0, NULL); - - // copy it to our buffer and free memory - strncpy(s_szBuf, (const char *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1); - s_szBuf[WXSIZEOF(s_szBuf) - 1] = '\0'; - LocalFree(lpMsgBuf); - - // returned string is capitalized and ended with '\r\n' - bad - s_szBuf[0] = (char)wxToLower(s_szBuf[0]); - size_t len = strlen(s_szBuf); - if ( len > 0 ) { - // truncate string - if ( s_szBuf[len - 2] == '\r' ) - s_szBuf[len - 2] = '\0'; - } - - return s_szBuf; - #else //Win16 - // TODO @@@@ - return NULL; - #endif // Win16/32 - #else // Unix - return strerror(nErrCode); - #endif // Win/Unix -} - -// ---------------------------------------------------------------------------- -// debug helper -// ---------------------------------------------------------------------------- - -#ifdef __WXDEBUG__ +const wxChar *wxSysErrorMsg(unsigned long nErrCode) +{ + if ( nErrCode == 0 ) + nErrCode = wxSysErrorCode(); + +#if defined(__WXMSW__) && !defined(__WXMICROWIN__) +#ifdef __WIN32__ + static wxChar s_szBuf[LOG_BUFFER_SIZE / 2]; + + // get error message from system + LPVOID lpMsgBuf; + FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM, + NULL, nErrCode, + MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), + (LPTSTR)&lpMsgBuf, + 0, NULL); + + // copy it to our buffer and free memory + if( lpMsgBuf != 0 ) { + wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1); + s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0'); + + 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'); + } + } + else { + s_szBuf[0] = wxT('\0'); + } -void Trap() -{ - #ifdef __WXMSW__ - DebugBreak(); - #elif defined(__WXSTUBS__) + return s_szBuf; +#else //Win16 // TODO - #elif defined(__WXMAC__) - #if __powerc - Debugger(); - #else - SysBreak(); - #endif - #else // Unix - raise(SIGTRAP); - #endif // Win/Unix -} - -// this function is called when an assert fails -void wxOnAssert(const char *szFile, int nLine, const char *szMsg) -{ - // this variable can be set to true to suppress "assert failure" messages - static bool s_bNoAsserts = FALSE; - static bool s_bInAssert = FALSE; - - if ( s_bInAssert ) { - // He-e-e-e-elp!! we're trapped in endless loop - Trap(); - - s_bInAssert = FALSE; - - return; - } - - s_bInAssert = TRUE; - - char szBuf[LOG_BUFFER_SIZE]; - - // make life easier for people using VC++ IDE: clicking on the message will - // take us immediately to the place of the failed assert -#ifdef __VISUALC__ - sprintf(szBuf, "%s(%d): assert failed", szFile, nLine); -#else // !VC++ - // make the error message more clear for all the others - sprintf(szBuf, "Assert failed in file %s at line %d", szFile, nLine); -#endif // VC/!VC - - if ( szMsg != NULL ) { - strcat(szBuf, ": "); - strcat(szBuf, szMsg); - } - else { - strcat(szBuf, "."); - } - - if ( !s_bNoAsserts ) { - // send it to the normal log destination - wxLogDebug(szBuf); - - #if wxUSE_NOGUI - Trap(); - #else - strcat(szBuf, "\nDo you want to stop the program?" - "\nYou can also choose [Cancel] to suppress " - "further warnings."); - - switch ( wxMessageBox(szBuf, _("Debug"), - wxYES_NO | wxCANCEL | wxICON_STOP ) ) { - case wxYES: - Trap(); - break; - - case wxCANCEL: - s_bNoAsserts = TRUE; - break; - - //case wxNO: nothing to do - } - #endif // USE_NOGUI - } - - s_bInAssert = FALSE; + 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 } -#endif //WXDEBUG +#endif // wxUSE_LOG