#ifdef __WXMSW__
#include "wx/msw/private.h"
#endif
- #include "wx/msgdlg.h"
#endif
#endif //WX_PRECOMP
#include "wx/utils.h"
#include "wx/wxchar.h"
#include "wx/log.h"
+#include "wx/thread.h"
+
+#if wxUSE_LOG
// other standard headers
#include <errno.h>
#include <stdlib.h>
#include <time.h>
-#ifdef __WXMSW__
- #include <windows.h>
- // Redefines OutputDebugString if necessary
- #include "wx/msw/private.h"
-#else //Unix
- #include <signal.h>
-#endif //Win/Unix
+#if defined(__WXMSW__)
+ #include "wx/msw/private.h" // includes windows.h for OutputDebugString
+#endif
// ----------------------------------------------------------------------------
// non member functions
// ============================================================================
// ----------------------------------------------------------------------------
-// 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)
// 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));
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));
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));
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);
+
+ va_list argptr;
+ va_start(argptr, szFormat);
+ wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
+ va_end(argptr);
- wxLogSysErrorHelper(wxSysErrorCode());
+ 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);
+ }
}
// ----------------------------------------------------------------------------
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()
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);
ms_aTraceMasks.Remove((size_t)index);
}
+void wxLog::ClearTraceMasks()
+{
+ ms_aTraceMasks.Clear();
+}
+
void wxLog::TimeStamp(wxString *str)
{
if ( ms_timestamp )
wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
str->Empty();
- *str << buf << T(": ");
+ *str << buf << wxT(": ");
}
}
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()
{
- // do nothing
+ // remember that we don't have any more messages to show
+ m_bHasMessages = FALSE;
}
// ----------------------------------------------------------------------------
m_fp = fp;
}
+#if defined(__WXMAC__) && !defined(__DARWIN__)
+#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(kDebuggerSignature, '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 && !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() )
+ {
+ AmIBeingMWDebugged( &running ) ;
+ }
+*/
+ if (running)
+ {
+#ifdef __powerc
+ DebugStr(pstr);
+#else
+ SysBreakStr(pstr);
+#endif
+ }
+ else
+#endif
+ {
+#ifdef __powerc
+ DebugStr(pstr);
+#else
+ DebugStr(pstr);
+#endif
+ }
+#endif // Mac
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
#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) << wxConvertWX2MB(szString) << endl;
+ wxString str;
+ TimeStamp(&str);
+ (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl;
}
#endif // wxUSE_STD_IOSTREAM
+// ----------------------------------------------------------------------------
+// wxLogChain
+// ----------------------------------------------------------------------------
+
+wxLogChain::wxLogChain(wxLog *logger)
+{
+ m_logNew = logger;
+ m_logOld = wxLog::SetActiveTarget(this);
+}
+
+void wxLogChain::SetLog(wxLog *logger)
+{
+ if ( m_logNew != this )
+ delete m_logNew;
+
+ wxLog::SetActiveTarget(logger);
+
+ m_logNew = logger;
+}
+
+void wxLogChain::Flush()
+{
+ if ( m_logOld )
+ m_logOld->Flush();
+
+ // be careful to avoid inifinite recursion
+ if ( m_logNew && m_logNew != this )
+ m_logNew->Flush();
+}
+
+void wxLogChain::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+{
+ // let the previous logger show it
+ if ( m_logOld && IsPassingMessages() )
+ {
+ // bogus cast just to access protected DoLog
+ ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
+ }
+
+ if ( m_logNew && m_logNew != this )
+ {
+ // as above...
+ ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
+ }
+}
+
+// ----------------------------------------------------------------------------
+// wxLogPassThrough
+// ----------------------------------------------------------------------------
+
+#ifdef __VISUALC__
+ // "'this' : used in base member initializer list" - so what?
+ #pragma warning(disable:4355)
+#endif // VC++
+
+wxLogPassThrough::wxLogPassThrough()
+ : wxLogChain(this)
+{
+}
+
+#ifdef __VISUALC__
+ #pragma warning(default:4355)
+#endif // VC++
+
// ============================================================================
// Global functions/variables
// ============================================================================
wxLog *wxLog::ms_pLogger = (wxLog *)NULL;
bool wxLog::ms_doLog = TRUE;
bool wxLog::ms_bAutoCreate = TRUE;
+bool wxLog::ms_bVerbose = FALSE;
+
+size_t wxLog::ms_suspendCount = 0;
-const wxChar *wxLog::ms_timestamp = T("%X"); // time only, no date
+#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;
// get error code from syste
unsigned long wxSysErrorCode()
{
-#ifdef __WXMSW__
+#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
#ifdef __WIN32__
return ::GetLastError();
#else //WIN16
if ( nErrCode == 0 )
nErrCode = wxSysErrorCode();
-#ifdef __WXMSW__
+#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
#ifdef __WIN32__
static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
0, NULL);
// 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');
+ 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);
// returned string is capitalized and ended with '\r\n' - bad
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;
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
}
-// ----------------------------------------------------------------------------
-// debug helper
-// ----------------------------------------------------------------------------
-
-#ifdef __WXDEBUG__
-
-// break into the debugger
-void Trap()
-{
-#ifdef __WXMSW__
- DebugBreak();
-#elif defined(__WXMAC__)
-#if __powerc
- Debugger();
-#else
- SysBreak();
-#endif
-#elif defined(__UNIX__)
- raise(SIGTRAP);
-#else
- // TODO
-#endif // Win/Unix
-}
-
-// this function is called when an assert fails
-void wxOnAssert(const wxChar *szFile, int nLine, const wxChar *szMsg)
-{
- // this variable can be set to true to suppress "assert failure" messages
- static bool s_bNoAsserts = FALSE;
- static bool s_bInAssert = FALSE; // FIXME MT-unsafe
-
- if ( s_bInAssert ) {
- // He-e-e-e-elp!! we're trapped in endless loop
- Trap();
-
- s_bInAssert = FALSE;
-
- return;
- }
-
- s_bInAssert = TRUE;
-
- wxChar 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__
- wxSprintf(szBuf, T("%s(%d): assert failed"), szFile, nLine);
-#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);
-#endif // VC/!VC
-
- if ( szMsg != NULL ) {
- wxStrcat(szBuf, T(": "));
- wxStrcat(szBuf, szMsg);
- }
- else {
- wxStrcat(szBuf, T("."));
- }
-
- if ( !s_bNoAsserts ) {
- // send it to the normal log destination
- wxLogDebug(szBuf);
-
-#if wxUSE_GUI
- // 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."));
-
- switch ( wxMessageBox(szBuf, _("Debug"),
- wxYES_NO | wxCANCEL | wxICON_STOP ) ) {
- case wxYES:
- Trap();
- break;
-
- case wxCANCEL:
- s_bNoAsserts = TRUE;
- break;
-
- //case wxNO: nothing to do
- }
-#else // !GUI
- Trap();
-#endif // GUI/!GUI
- }
-
- s_bInAssert = FALSE;
-}
-
-#endif //WXDEBUG
-
+#endif //wxUSE_LOG