X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dd85fc6b89333821b22ae76808914d8e1d508095..daa616fca06ce77df132d31eda6d1f829b449aad:/src/common/log.cpp?ds=sidebyside diff --git a/src/common/log.cpp b/src/common/log.cpp index f811d2b15d..ffeeef2daa 100644 --- a/src/common/log.cpp +++ b/src/common/log.cpp @@ -30,17 +30,17 @@ // wxWindows #ifndef WX_PRECOMP - #include "wx/window.h" - #ifdef __WXMSW__ - #include "wx/msw/private.h" - #endif - #include "wx/event.h" - #include "wx/app.h" - #include "wx/string.h" - #include "wx/intl.h" - #ifndef wxUSE_NOGUI - #include "wx/msgdlg.h" - #endif + #include "wx/string.h" + #include "wx/intl.h" + #include "wx/app.h" + + #if wxUSE_GUI + #include "wx/window.h" + #ifdef __WXMSW__ + #include "wx/msw/private.h" + #endif + #include "wx/msgdlg.h" + #endif #endif //WX_PRECOMP #include "wx/file.h" @@ -48,6 +48,9 @@ #include "wx/utils.h" #include "wx/wxchar.h" #include "wx/log.h" +#include "wx/thread.h" + +#if wxUSE_LOG // other standard headers #include @@ -55,9 +58,7 @@ #include #ifdef __WXMSW__ - #include - // Redefines OutputDebugString if necessary - #include "wx/msw/private.h" + #include "wx/msw/private.h" // includes windows.h for OutputDebugString #else //Unix #include #endif //Win/Unix @@ -78,43 +79,64 @@ // ============================================================================ // ---------------------------------------------------------------------------- -// 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. +// globals // ---------------------------------------------------------------------------- // 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 (FIXME MT-unsafe) +// static buffer for error messages static wxChar s_szBuf[LOG_BUFFER_SIZE]; +#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 +// +// NB: unfortunately we need all these distinct functions, we can't make them +// macros and not all compilers inline vararg functions. +// ---------------------------------------------------------------------------- + // generic log function void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...) { - if ( wxLog::GetActiveTarget() != NULL ) { - va_list argptr; - va_start(argptr, szFormat); - wxVsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + if ( IsLoggingEnabled() ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); - wxLog::OnLog(level, s_szBuf, time(NULL)); - } + va_list argptr; + va_start(argptr, szFormat); + wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); + va_end(argptr); + + wxLog::OnLog(level, s_szBuf, time(NULL)); + } } -#define IMPLEMENT_LOG_FUNCTION(level) \ - void wxLog##level(const wxChar *szFormat, ...) \ - { \ - if ( wxLog::GetActiveTarget() != NULL ) { \ - va_list argptr; \ - va_start(argptr, szFormat); \ - wxVsprintf(s_szBuf, szFormat, argptr); \ - va_end(argptr); \ - \ - wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ - } \ +#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)); \ + } \ } IMPLEMENT_LOG_FUNCTION(FatalError) @@ -127,40 +149,60 @@ IMPLEMENT_LOG_FUNCTION(Status) // same as info, but only if 'verbose' mode is on void wxLogVerbose(const wxChar *szFormat, ...) { - wxLog *pLog = wxLog::GetActiveTarget(); - if ( pLog != NULL && pLog->GetVerbose() ) { - va_list argptr; - va_start(argptr, szFormat); - wxVsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); - - wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL)); - } + 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::OnLog(wxLOG_Info, s_szBuf, time(NULL)); + } + } } // debug functions #ifdef __WXDEBUG__ -#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \ - void wxLog##level(const wxChar *szFormat, ...) \ - { \ - if ( wxLog::GetActiveTarget() != NULL ) { \ - va_list argptr; \ - va_start(argptr, szFormat); \ - wxVsprintf(s_szBuf, szFormat, argptr); \ - va_end(argptr); \ - \ - wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \ - } \ +#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, ...) { - wxLog *pLog = wxLog::GetActiveTarget(); + 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; - if ( pLog != NULL && wxLog::IsAllowedTraceMask(mask) ) { va_list argptr; va_start(argptr, szFormat); - wxVsprintf(s_szBuf, szFormat, argptr); + wxVsnprintf(p, len, szFormat, argptr); va_end(argptr); wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); @@ -169,15 +211,15 @@ void wxLogVerbose(const wxChar *szFormat, ...) void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...) { - wxLog *pLog = wxLog::GetActiveTarget(); - // 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) ) { + if ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); + va_list argptr; va_start(argptr, szFormat); - wxVsprintf(s_szBuf, szFormat, argptr); + wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); va_end(argptr); wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL)); @@ -198,7 +240,8 @@ IMPLEMENT_LOG_DEBUG_FUNCTION(Trace) void wxLogSysErrorHelper(long lErrCode) { wxChar szErrMsg[LOG_BUFFER_SIZE / 2]; - wxSprintf(szErrMsg, _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); + wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg), + _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode)); wxStrncat(s_szBuf, szErrMsg, WXSIZEOF(s_szBuf) - wxStrlen(s_szBuf)); wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL)); @@ -206,22 +249,30 @@ void wxLogSysErrorHelper(long lErrCode) void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...) { - va_list argptr; - va_start(argptr, szFormat); - wxVsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + if ( IsLoggingEnabled() ) { + wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); - wxLogSysErrorHelper(wxSysErrorCode()); + va_list argptr; + va_start(argptr, szFormat); + wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); + va_end(argptr); + + wxLogSysErrorHelper(wxSysErrorCode()); + } } void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...) { - va_list argptr; - va_start(argptr, szFormat); - wxVsprintf(s_szBuf, szFormat, argptr); - va_end(argptr); + 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); - wxLogSysErrorHelper(lErrCode); + wxLogSysErrorHelper(lErrCode); + } } // ---------------------------------------------------------------------------- @@ -231,13 +282,7 @@ void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *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 } wxLog *wxLog::GetActiveTarget() @@ -249,15 +294,11 @@ wxLog *wxLog::GetActiveTarget() if ( !s_bInGetActiveTarget ) { s_bInGetActiveTarget = TRUE; -#ifdef wxUSE_NOGUI - ms_pLogger = new wxLogStderr; -#else // GUI // ask the application to create a log target for us if ( wxTheApp != NULL ) ms_pLogger = wxTheApp->CreateLogTarget(); else ms_pLogger = new wxLogStderr; -#endif // !GUI/GUI s_bInGetActiveTarget = FALSE; @@ -282,6 +323,16 @@ wxLog *wxLog::SetActiveTarget(wxLog *pLogger) return pOldLogger; } +void wxLog::DontCreateOnDemand() +{ + 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 + // memory leak reports from wxWin memory tracking code + ClearTraceMasks(); +} + void wxLog::RemoveTraceMask(const wxString& str) { int index = ms_aTraceMasks.Index(str); @@ -289,6 +340,11 @@ void wxLog::RemoveTraceMask(const wxString& str) ms_aTraceMasks.Remove((size_t)index); } +void wxLog::ClearTraceMasks() +{ + ms_aTraceMasks.Clear(); +} + void wxLog::TimeStamp(wxString *str) { if ( ms_timestamp ) @@ -299,7 +355,7 @@ void wxLog::TimeStamp(wxString *str) wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow)); str->Empty(); - *str << buf << _T(": "); + *str << buf << wxT(": "); } } @@ -324,26 +380,28 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t) case wxLOG_Info: if ( GetVerbose() ) case wxLOG_Message: + case wxLOG_Status: default: // log unknown log levels too DoLogString(szString, t); - // fall through - - case wxLOG_Status: - // nothing to do break; case wxLOG_Trace: case wxLOG_Debug: #ifdef __WXDEBUG__ - DoLogString(szString, t); -#endif + { + wxString msg = level == wxLOG_Trace ? wxT("Trace: ") + : wxT("Debug: "); + msg << szString; + DoLogString(msg, t); + } +#endif // Debug break; } } void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t)) { - wxFAIL_MSG(_T("DoLogString must be overriden if it's called.")); + wxFAIL_MSG(wxT("DoLogString must be overriden if it's called.")); } void wxLog::Flush() @@ -363,20 +421,134 @@ wxLogStderr::wxLogStderr(FILE *fp) m_fp = fp; } +#if defined(__WXMAC__) && !defined(__UNIX__) +#define kDebuggerSignature 'MWDB' + +static Boolean FindProcessBySignature(OSType signature, ProcessInfoRec* info) +{ + OSErr err; + ProcessSerialNumber psn; + Boolean found = false; + psn.highLongOfPSN = 0; + psn.lowLongOfPSN = kNoProcess; + + if (!info) return false; + + info->processInfoLength = sizeof(ProcessInfoRec); + info->processName = NULL; + info->processAppSpec = NULL; + + err = noErr; + while (!found && err == noErr) + { + err = GetNextProcess(&psn); + if (err == noErr) + { + err = GetProcessInformation(&psn, info); + found = err == noErr && info->processSignature == signature; + } + } + return found; +} + +pascal Boolean MWDebuggerIsRunning(void) +{ + ProcessInfoRec info; + return FindProcessBySignature(kDebuggerSignature, &info); +} + +pascal OSErr AmIBeingMWDebugged(Boolean* result) +{ + 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; + + err = AECreateDesc(typeApplSignature, &sig, sizeof(sig), &addr); + if (err != noErr) goto exit; + + err = AECreateAppleEvent('MWDB', 'Dbg?', &addr, + kAutoGenerateReturnID, kAnyTransactionID, &theAE); + if (err != noErr) goto exit; + + GetCurrentProcess(&psn); + err = AEPutParamPtr(&theAE, keyDirectObject, typeProcessSerialNumber, + &psn, sizeof(psn)); + if (err != noErr) goto exit; + + err = AESend(&theAE, &theReply, kAEWaitReply, kAENormalPriority, + kAEDefaultTimeout, NULL, NULL); + if (err != noErr) goto exit; + + err = AEGetParamPtr(&theReply, keyAEResult, typeBoolean, &actualType, result, + sizeof(Boolean), &actualSize); + +exit: + if (addr.dataHandle) + AEDisposeDesc(&addr); + if (theAE.dataHandle) + AEDisposeDesc(&theAE); + if (theReply.dataHandle) + AEDisposeDesc(&theReply); + + return err; +} +#endif + void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) { wxString str; TimeStamp(&str); - str << szString << _T('\n'); + str << szString; fputs(str.mb_str(), m_fp); + fputc(_T('\n'), 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 + _T('\r')); + // 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 + str += wxT("\r\n") ; + OutputDebugString(str.c_str()); #endif // MSW +#if defined(__WXMAC__) && !defined(__WXMAC_X__) && wxUSE_GUI + Str255 pstr ; + strcpy( (char*) pstr , str.c_str() ) ; + strcat( (char*) pstr , ";g" ) ; + c2pstr( (char*) pstr ) ; +#if __WXDEBUG__ + Boolean running = false ; + +/* + if ( MWDebuggerIsRunning() ) + { + AmIBeingMWDebugged( &running ) ; + } +*/ + if (running) + { + #ifdef __powerc + DebugStr(pstr); + #else + SysBreakStr(pstr); + #endif + } + else +#endif + { + #ifdef __powerc + DebugStr(pstr); + #else + DebugStr(pstr); + #endif + } +#endif // Mac } // ---------------------------------------------------------------------------- @@ -384,17 +556,19 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) // ---------------------------------------------------------------------------- #if wxUSE_STD_IOSTREAM -wxLogStream::wxLogStream(ostream *ostr) +wxLogStream::wxLogStream(wxSTD ostream *ostr) { if ( ostr == NULL ) - m_ostr = &cerr; + m_ostr = &wxSTD cerr; else m_ostr = ostr; } void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t)) { - (*m_ostr) << wxConvCurrent->cWX2MB(szString) << endl << flush; + wxString str; + TimeStamp(&str); + (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl; } #endif // wxUSE_STD_IOSTREAM @@ -410,7 +584,13 @@ wxLog *wxLog::ms_pLogger = (wxLog *)NULL; bool wxLog::ms_doLog = TRUE; bool wxLog::ms_bAutoCreate = TRUE; -const wxChar *wxLog::ms_timestamp = _T("%X"); // time only, no date +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 wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0; wxArrayString wxLog::ms_aTraceMasks; @@ -491,7 +671,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) // copy it to our buffer and free memory wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1); - s_szBuf[WXSIZEOF(s_szBuf) - 1] = _T('\0'); + s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0'); LocalFree(lpMsgBuf); // returned string is capitalized and ended with '\r\n' - bad @@ -499,8 +679,8 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) size_t len = wxStrlen(s_szBuf); if ( len > 0 ) { // truncate string - if ( s_szBuf[len - 2] == _T('\r') ) - s_szBuf[len - 2] = _T('\0'); + if ( s_szBuf[len - 2] == wxT('\r') ) + s_szBuf[len - 2] = wxT('\0'); } return s_szBuf; @@ -514,7 +694,7 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1); return s_szBuf; #else - return strerror(nErrCode); + return strerror((int)nErrCode); #endif #endif // Win/Unix } @@ -525,8 +705,14 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode) #ifdef __WXDEBUG__ +// wxASSERT() helper +bool wxAssertIsEqual(int x, int y) +{ + return x == y; +} + // break into the debugger -void Trap() +void wxTrap() { #ifdef __WXMSW__ DebugBreak(); @@ -552,7 +738,7 @@ void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg) if ( s_bInAssert ) { // He-e-e-e-elp!! we're trapped in endless loop - Trap(); + wxTrap(); s_bInAssert = FALSE; @@ -565,47 +751,65 @@ void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg) // make life easier for people using VC++ IDE: clicking on the message // will take us immediately to the place of the failed assert + wxSnprintf(szBuf, WXSIZEOF(szBuf), #ifdef __VISUALC__ - wxSprintf(szBuf, _T("%s(%d): assert failed"), szFile, nLine); + wxT("%s(%d): assert failed"), #else // !VC++ // make the error message more clear for all the others - wxSprintf(szBuf, _T("Assert failed in file %s at line %d"), szFile, nLine); + wxT("Assert failed in file %s at line %d"), #endif // VC/!VC + szFile, nLine); if ( szMsg != NULL ) { - wxStrcat(szBuf, _T(": ")); + wxStrcat(szBuf, wxT(": ")); wxStrcat(szBuf, szMsg); } else { - wxStrcat(szBuf, _T(".")); + wxStrcat(szBuf, wxT(".")); } if ( !s_bNoAsserts ) { // send it to the normal log destination wxLogDebug(szBuf); -#if wxUSE_NOGUI - Trap(); -#else // GUI +#if (wxUSE_GUI && wxUSE_MSGDLG) || defined(__WXMSW__) // this message is intentionally not translated - it is for // developpers only - wxStrcat(szBuf, _T("\nDo you want to stop the program?" - "\nYou can also choose [Cancel] to suppress " - "further warnings.")); + wxStrcat(szBuf, wxT("\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 ) ) { + // use the native message box if available: this is more robust than + // using our own +#ifdef __WXMSW__ + switch ( ::MessageBox(NULL, szBuf, _T("Debug"), + MB_YESNOCANCEL | MB_ICONSTOP ) ) { + case IDYES: + wxTrap(); + break; + + case IDCANCEL: + s_bNoAsserts = TRUE; + break; + + //case IDNO: nothing to do + } +#else // !MSW + switch ( wxMessageBox(szBuf, wxT("Debug"), + wxYES_NO | wxCANCEL | wxICON_STOP ) ) { case wxYES: - Trap(); + wxTrap(); break; case wxCANCEL: s_bNoAsserts = TRUE; break; - //case wxNO: nothing to do + //case wxNO: nothing to do } -#endif // !GUI/GUI +#endif // GUI or MSW + +#else // !GUI + wxTrap(); +#endif // GUI/!GUI } s_bInAssert = FALSE; @@ -613,3 +817,4 @@ void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg) #endif //WXDEBUG +#endif //wxUSE_LOG