// Created: 29/01/98
// RCS-ID: $Id$
// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
// ============================================================================
// ----------------------------------------------------------------------------
#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 "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
- #endif
+ #include "wx/intl.h"
+ #include "wx/string.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/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 <errno.h>
-#include <stdlib.h>
-#include <time.h>
-
-#if defined(__WXMSW__)
- #include "wx/msw/private.h" // includes windows.h for OutputDebugString
-#endif
-
-#if defined(__WXMAC__)
- #include "wx/mac/private.h" // includes mac headers
-#endif
+#include <errno.h>
+#include <stdlib.h>
+#include <time.h>
// ----------------------------------------------------------------------------
// non member functions
#define LOG_BUFFER_SIZE (4096)
// static buffer for error messages
-static wxChar s_szBuf[LOG_BUFFER_SIZE];
+static wxChar s_szBufStatic[LOG_BUFFER_SIZE];
+
+static wxChar *s_szBuf = s_szBufStatic;
+static size_t s_szBufSize = WXSIZEOF( s_szBufStatic );
#if wxUSE_THREADS
// macros and not all compilers inline vararg functions.
// ----------------------------------------------------------------------------
+// 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 wxChar *szFormat, ...)
+void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list 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);
+ PrintfInLogBug(szFormat, argptr);
wxLog::OnLog(level, s_szBuf, time(NULL));
}
}
+void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
+{
+ va_list argptr;
+ va_start(argptr, szFormat);
+ wxVLogGeneric(level, szFormat, argptr);
+ va_end(argptr);
+}
+
#define IMPLEMENT_LOG_FUNCTION(level) \
- void wxLog##level(const wxChar *szFormat, ...) \
+ void wxVLog##level(const wxChar *szFormat, va_list 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); \
+ 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)
+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, ...)
+{
+ va_list argptr;
+ va_start(argptr, szFormat);
+ wxVLogFatalError(szFormat, argptr);
+ va_end(argptr);
+}
+
// same as info, but only if 'verbose' mode is on
-void wxLogVerbose(const wxChar *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);
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
+ wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
}
}
}
+void wxLogVerbose(const wxChar *szFormat, ...)
+{
+ va_list argptr;
+ va_start(argptr, szFormat);
+ wxVLogVerbose(szFormat, argptr);
+ va_end(argptr);
+}
+
// debug functions
#ifdef __WXDEBUG__
#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
- void wxLog##level(const wxChar *szFormat, ...) \
+ void wxVLog##level(const wxChar *szFormat, va_list 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); \
+ 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 wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
+ 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 = WXSIZEOF(s_szBuf);
+ size_t len = s_szBufSize;
wxStrncpy(s_szBuf, _T("("), len);
len -= 1; // strlen("(")
p += 1;
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, ...)
+ void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
+ {
+ 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 ( 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);
+ wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
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
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));
+ wxStrncat(s_szBuf, szErrMsg, s_szBufSize - wxStrlen(s_szBuf));
wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
}
-void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list 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);
+ wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
wxLogSysErrorHelper(wxSysErrorCode());
}
}
-void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
+{
+ 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);
- va_list argptr;
- va_start(argptr, szFormat);
- wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr);
- va_end(argptr);
+ wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
wxLogSysErrorHelper(lErrCode);
}
}
+void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
+{
+ va_list argptr;
+ va_start(argptr, szFormat);
+ wxVLogSysError(lErrCode, szFormat, argptr);
+ va_end(argptr);
+}
+
// ----------------------------------------------------------------------------
// wxLog class implementation
// ----------------------------------------------------------------------------
wxLog::wxLog()
{
- m_bHasMessages = FALSE;
+}
+
+wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size)
+{
+ wxChar *oldbuf = s_szBuf;
+
+ if( buf == 0 )
+ {
+ s_szBuf = s_szBufStatic;
+ s_szBufSize = WXSIZEOF( s_szBufStatic );
+ }
+ else
+ {
+ s_szBuf = buf;
+ s_szBufSize = size;
+ }
+
+ return (oldbuf == s_szBufStatic ) ? 0 : oldbuf;
}
wxLog *wxLog::GetActiveTarget()
void wxLog::Flush()
{
- // remember that we don't have any more messages to show
- m_bHasMessages = FALSE;
+ // nothing to do here
}
// ----------------------------------------------------------------------------
m_fp = fp;
}
-#if defined(__WXMAC__) && !defined(__DARWIN__)
-
-#if !TARGET_API_MAC_CARBON || (__MSL_CPP__ > 0x5300)
-// MetroNub stuff doesn't seem to work in CodeWarrior 5.3 Carbon builds...
-
-#ifndef __MetroNubUtils__
-#include "MetroNubUtils.h"
-#endif
-
-#ifdef __cplusplus
- extern "C" {
-#endif
-
-#ifndef __GESTALT__
-#include <Gestalt.h>
-#endif
-
-#ifndef true
-#define true 1
-#endif
-
-#ifndef false
-#define false 0
-#endif
-
-#if TARGET_API_MAC_CARBON
-
- #include <CodeFragments.h>
-
- EXTERN_API_C( long )
- CallUniversalProc(UniversalProcPtr theProcPtr, ProcInfoType procInfo, ...);
-
- ProcPtr gCallUniversalProc_Proc = NULL;
-
-#endif
-
-static MetroNubUserEntryBlock* gMetroNubEntry = NULL;
-
-static long fRunOnce = false;
-
-Boolean IsCompatibleVersion(short inVersion);
-
-/* ---------------------------------------------------------------------------
- IsCompatibleVersion
- --------------------------------------------------------------------------- */
-
-Boolean IsCompatibleVersion(short inVersion)
-{
- Boolean result = false;
-
- if (fRunOnce)
- {
- MetroNubUserEntryBlock* block = (MetroNubUserEntryBlock *)result;
-
- result = (inVersion <= block->apiHiVersion);
- }
-
- return result;
-}
-
-/* ---------------------------------------------------------------------------
- IsMetroNubInstalled
- --------------------------------------------------------------------------- */
-
-Boolean IsMetroNubInstalled()
-{
- if (!fRunOnce)
- {
- long result, value;
-
- fRunOnce = true;
- gMetroNubEntry = NULL;
-
- if (Gestalt(gestaltSystemVersion, &value) == noErr && value < 0x1000)
- {
- /* look for MetroNub's Gestalt selector */
- if (Gestalt(kMetroNubUserSignature, &result) == noErr)
- {
-
- #if TARGET_API_MAC_CARBON
- if (gCallUniversalProc_Proc == NULL)
- {
- CFragConnectionID connectionID;
- Ptr mainAddress;
- Str255 errorString;
- ProcPtr symbolAddress;
- OSErr err;
- CFragSymbolClass symbolClass;
-
- symbolAddress = NULL;
- err = GetSharedLibrary("\pInterfaceLib", kPowerPCCFragArch, kFindCFrag,
- &connectionID, &mainAddress, errorString);
-
- if (err != noErr)
- {
- gCallUniversalProc_Proc = NULL;
- goto end;
- }
-
- err = FindSymbol(connectionID, "\pCallUniversalProc",
- (Ptr *) &gCallUniversalProc_Proc, &symbolClass);
-
- if (err != noErr)
- {
- gCallUniversalProc_Proc = NULL;
- goto end;
- }
- }
- #endif
-
- {
- MetroNubUserEntryBlock* block = (MetroNubUserEntryBlock *)result;
-
- /* make sure the version of the API is compatible */
- if (block->apiLowVersion <= kMetroNubUserAPIVersion &&
- kMetroNubUserAPIVersion <= block->apiHiVersion)
- gMetroNubEntry = block; /* success! */
- }
-
- }
- }
- }
-
-end:
-
-#if TARGET_API_MAC_CARBON
- return (gMetroNubEntry != NULL && gCallUniversalProc_Proc != NULL);
-#else
- return (gMetroNubEntry != NULL);
-#endif
-}
-
-/* ---------------------------------------------------------------------------
- IsMWDebuggerRunning [v1 API]
- --------------------------------------------------------------------------- */
-
-Boolean IsMWDebuggerRunning()
-{
- if (IsMetroNubInstalled())
- return CallIsDebuggerRunningProc(gMetroNubEntry->isDebuggerRunning);
- else
- return false;
-}
-
-/* ---------------------------------------------------------------------------
- AmIBeingMWDebugged [v1 API]
- --------------------------------------------------------------------------- */
-
-Boolean AmIBeingMWDebugged()
-{
- if (IsMetroNubInstalled())
- return CallAmIBeingDebuggedProc(gMetroNubEntry->amIBeingDebugged);
- else
- return false;
-}
-
-/* ---------------------------------------------------------------------------
- UserSetWatchPoint [v2 API]
- --------------------------------------------------------------------------- */
-
-OSErr UserSetWatchPoint (Ptr address, long length, WatchPointIDT* watchPointID)
-{
- if (IsMetroNubInstalled() && IsCompatibleVersion(kMetroNubUserAPIVersion))
- return CallUserSetWatchPointProc(gMetroNubEntry->userSetWatchPoint,
- address, length, watchPointID);
- else
- return errProcessIsNotClient;
-}
-
-/* ---------------------------------------------------------------------------
- ClearWatchPoint [v2 API]
- --------------------------------------------------------------------------- */
-
-OSErr ClearWatchPoint (WatchPointIDT watchPointID)
-{
- if (IsMetroNubInstalled() && IsCompatibleVersion(kMetroNubUserAPIVersion))
- return CallClearWatchPointProc(gMetroNubEntry->clearWatchPoint,
- watchPointID);
- else
- return errProcessIsNotClient;
-}
-
-#ifdef __cplusplus
- }
-#endif
-
-#endif // !TARGET_API_MAC_CARBON || (__MSL_CPP__ > 0x5300)
-
-#endif // defined(__WXMAC__) && !defined(__DARWIN__)
-
void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
{
wxString str;
fputc(_T('\n'), m_fp);
fflush(m_fp);
- // 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 ) ;
-
- Boolean running = false ;
-
-#if !TARGET_API_MAC_CARBON || (__MSL_CPP__ > 0x5300)
-
- if ( IsMWDebuggerRunning() && AmIBeingMWDebugged() )
+ // 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 )
{
- running = true ;
- }
-
-#endif
-
- if (running)
- {
-#ifdef __powerc
- DebugStr(pstr);
-#else
- SysBreakStr(pstr);
-#endif
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits && !traits->HasStderr() )
+ {
+ wxMessageOutputDebug().Printf(_T("%s"), str.c_str());
+ }
}
-#endif // Mac
}
// ----------------------------------------------------------------------------
// ----------------------------------------------------------------------------
#if wxUSE_STD_IOSTREAM
+#include "wx/ioswrap.h"
wxLogStream::wxLogStream(wxSTD ostream *ostr)
{
if ( ostr == NULL )
wxLogChain::wxLogChain(wxLog *logger)
{
+ m_bPassMessages = TRUE;
+
m_logNew = logger;
m_logOld = wxLog::SetActiveTarget(this);
}
-void wxLogChain::SetLog(wxLog *logger)
+wxLogChain::~wxLogChain()
{
+ delete 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();
}
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
+const wxChar *wxLog::ms_timestamp = wxT("%X"); // time only, no date
wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
wxArrayString wxLog::ms_aTraceMasks;
#endif // Win/Unix
}
-#endif //wxUSE_LOG
+#endif // wxUSE_LOG
+