/////////////////////////////////////////////////////////////////////////////
-// Name: log.cpp
+// Name: src/common/log.cpp
// Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
// Author: Vadim Zeitlin
// Modified by:
// headers
// ----------------------------------------------------------------------------
-#ifdef __GNUG__
- #pragma implementation "log.h"
-#endif
-
// For compilers that support precompilation, includes "wx.h".
#include "wx/wxprec.h"
#ifdef __BORLANDC__
- #pragma hdrstop
+ #pragma hdrstop
#endif
-// wxWindows
+#if wxUSE_LOG
+
+// wxWidgets
#ifndef WX_PRECOMP
- #include "wx/string.h"
- #include "wx/intl.h"
+ #include "wx/log.h"
#include "wx/app.h"
-
- #if wxUSE_GUI
- #include "wx/window.h"
- #include "wx/msgdlg.h"
- #ifdef __WXMSW__
- #include "wx/msw/private.h"
- #endif
- #endif
+ #include "wx/arrstr.h"
+ #include "wx/intl.h"
+ #include "wx/string.h"
+ #include "wx/utils.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/msgout.h"
+#include "wx/textfile.h"
+#include "wx/thread.h"
+#include "wx/wxchar.h"
// other standard headers
-#include <errno.h>
-#include <stdlib.h>
-#include <time.h>
+#ifndef __WXWINCE__
+#include <errno.h>
+#endif
+
+#include <stdlib.h>
-#if defined(__WXMSW__)
- #include "wx/msw/private.h" // includes windows.h for OutputDebugString
+#ifndef __WXWINCE__
+#include <time.h>
+#else
+#include "wx/msw/wince/time.h"
#endif
-#if defined(__WXMAC__)
- #include "wx/mac/private.h" // includes mac headers
+#if defined(__WINDOWS__)
+ #include "wx/msw/private.h" // includes windows.h
#endif
// ----------------------------------------------------------------------------
#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
//
// macros and not all compilers inline vararg functions.
// ----------------------------------------------------------------------------
+// wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it
+static inline void PrintfInLogBuf(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 wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
+ if ( wxLog::IsEnabled() ) {
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
+ PrintfInLogBuf(szFormat, argptr);
wxLog::OnLog(level, s_szBuf, time(NULL));
}
#define IMPLEMENT_LOG_FUNCTION(level) \
void wxVLog##level(const wxChar *szFormat, va_list argptr) \
{ \
- if ( IsLoggingEnabled() ) { \
+ if ( wxLog::IsEnabled() ) { \
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
\
- wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); \
+ PrintfInLogBuf(szFormat, argptr); \
\
wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
} \
} \
+ \
void wxLog##level(const wxChar *szFormat, ...) \
{ \
va_list argptr; \
wxSafeShowMessage(_T("Fatal Error"), s_szBuf);
+#ifdef __WXWINCE__
+ ExitThread(3);
+#else
abort();
+#endif
}
void wxLogFatalError(const wxChar *szFormat, ...)
va_list argptr;
va_start(argptr, szFormat);
wxVLogFatalError(szFormat, argptr);
- va_end(argptr);
+
+ // some compilers warn about unreachable code and it shouldn't matter
+ // for the others anyhow...
+ //va_end(argptr);
}
// same as info, but only if 'verbose' mode is on
void wxVLogVerbose(const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
- wxLog *pLog = wxLog::GetActiveTarget();
- if ( pLog != NULL && pLog->GetVerbose() ) {
+ if ( wxLog::IsEnabled() ) {
+ if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
void wxVLog##level(const wxChar *szFormat, va_list argptr) \
{ \
- if ( IsLoggingEnabled() ) { \
+ if ( wxLog::IsEnabled() ) { \
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
\
wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); \
void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
+ if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
wxChar *p = s_szBuf;
// 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 ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
+ if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
+ if ( wxLog::IsEnabled() ) {
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
void WXDLLEXPORT wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr)
{
- if ( IsLoggingEnabled() ) {
+ if ( wxLog::IsEnabled() ) {
wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
// wxLog class implementation
// ----------------------------------------------------------------------------
-wxLog::wxLog()
-{
-}
-
wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size)
{
wxChar *oldbuf = s_szBuf;
if ( ms_bAutoCreate && ms_pLogger == NULL ) {
// prevent infinite recursion if someone calls wxLogXXX() from
// wxApp::CreateLogTarget()
- static bool s_bInGetActiveTarget = FALSE;
+ static bool s_bInGetActiveTarget = false;
if ( !s_bInGetActiveTarget ) {
- s_bInGetActiveTarget = TRUE;
+ s_bInGetActiveTarget = true;
// ask the application to create a log target for us
if ( wxTheApp != NULL )
- ms_pLogger = wxTheApp->CreateLogTarget();
+ ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
else
ms_pLogger = new wxLogStderr;
- s_bInGetActiveTarget = FALSE;
+ s_bInGetActiveTarget = false;
// do nothing if it fails - what can we do?
}
void wxLog::DontCreateOnDemand()
{
- ms_bAutoCreate = FALSE;
+ 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
{
int index = ms_aTraceMasks.Index(str);
if ( index != wxNOT_FOUND )
- ms_aTraceMasks.Remove((size_t)index);
+ ms_aTraceMasks.RemoveAt((size_t)index);
}
void wxLog::ClearTraceMasks()
DoLogString(wxString(_("Fatal error: ")) + szString, t);
DoLogString(_("Program aborted."), t);
Flush();
+#ifdef __WXWINCE__
+ ExitThread(3);
+#else
abort();
+#endif
break;
case wxLOG_Error:
// nothing to do here
}
-// ----------------------------------------------------------------------------
-// wxLogStderr class implementation
-// ----------------------------------------------------------------------------
-
-wxLogStderr::wxLogStderr(FILE *fp)
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxChar *mask)
{
- if ( fp == NULL )
- m_fp = stderr;
- else
- m_fp = fp;
+ for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
+ en = ms_aTraceMasks.end();
+ it != en; ++it )
+ if ( *it == mask)
+ return true;
+ return false;
}
-#if defined(__WXMAC__) && !defined(__DARWIN__) && defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
-
-// 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
- --------------------------------------------------------------------------- */
+// ----------------------------------------------------------------------------
+// wxLogBuffer implementation
+// ----------------------------------------------------------------------------
-Boolean IsCompatibleVersion(short inVersion)
+void wxLogBuffer::Flush()
{
- Boolean result = false;
-
- if (fRunOnce)
+ if ( !m_str.empty() )
{
- MetroNubUserEntryBlock* block = (MetroNubUserEntryBlock *)result;
-
- result = (inVersion <= block->apiHiVersion);
+ wxMessageOutputBest out;
+ out.Printf(_T("%s"), m_str.c_str());
+ m_str.clear();
}
-
- return result;
}
-/* ---------------------------------------------------------------------------
- IsMetroNubInstalled
- --------------------------------------------------------------------------- */
-
-Boolean IsMetroNubInstalled()
+void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
{
- if (!fRunOnce)
+ switch ( level )
{
- 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)
+ case wxLOG_Trace:
+ case wxLOG_Debug:
+#ifdef __WXDEBUG__
+ // don't put debug messages in the buffer, we don't want to show
+ // them to the user in a msg box, log them immediately
{
+ wxString str;
+ TimeStamp(&str);
+ str += szString;
- #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! */
- }
-
+ wxMessageOutputDebug dbgout;
+ dbgout.Printf(_T("%s\n"), str.c_str());
}
- }
- }
-
-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]
- --------------------------------------------------------------------------- */
+#endif // __WXDEBUG__
+ break;
-Boolean AmIBeingMWDebugged()
-{
- if (IsMetroNubInstalled())
- return CallAmIBeingDebuggedProc(gMetroNubEntry->amIBeingDebugged);
- else
- return false;
+ default:
+ wxLog::DoLog(level, szString, t);
+ }
}
-/* ---------------------------------------------------------------------------
- UserSetWatchPoint [v2 API]
- --------------------------------------------------------------------------- */
-
-OSErr UserSetWatchPoint (Ptr address, long length, WatchPointIDT* watchPointID)
+void wxLogBuffer::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
{
- if (IsMetroNubInstalled() && IsCompatibleVersion(kMetroNubUserAPIVersion))
- return CallUserSetWatchPointProc(gMetroNubEntry->userSetWatchPoint,
- address, length, watchPointID);
- else
- return errProcessIsNotClient;
+ m_str << szString << _T("\n");
}
-/* ---------------------------------------------------------------------------
- ClearWatchPoint [v2 API]
- --------------------------------------------------------------------------- */
+// ----------------------------------------------------------------------------
+// wxLogStderr class implementation
+// ----------------------------------------------------------------------------
-OSErr ClearWatchPoint (WatchPointIDT watchPointID)
+wxLogStderr::wxLogStderr(FILE *fp)
{
- if (IsMetroNubInstalled() && IsCompatibleVersion(kMetroNubUserAPIVersion))
- return CallClearWatchPointProc(gMetroNubEntry->clearWatchPoint, watchPointID);
+ if ( fp == NULL )
+ m_fp = stderr;
else
- return errProcessIsNotClient;
+ m_fp = fp;
}
-#ifdef __cplusplus
- }
-#endif
-
-#endif // defined(__WXMAC__) && !defined(__DARWIN__) && (__MWERKS__ >= 0x2400)
-
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 which does
- // have stderr or unless this is a file logger which doesn't use stderr at
- // all)
-#if defined(__WXMSW__) && wxUSE_GUI && !defined(__WXMICROWIN__)
+ // 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 )
{
- 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 defined(__MWERKS__) && (__MWERKS__ >= 0x2400)
-
- if ( IsMWDebuggerRunning() && AmIBeingMWDebugged() )
- {
- running = true ;
- }
-
-#endif
-
- if (running)
- {
-#ifdef __powerc
- DebugStr(pstr);
-#else
- SysBreakStr(pstr);
-#endif
+ wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+ if ( traits && !traits->HasStderr() )
+ {
+ wxMessageOutputDebug dbgout;
+ dbgout.Printf(_T("%s\n"), str.c_str());
+ }
}
-#endif // Mac
}
// ----------------------------------------------------------------------------
{
wxString str;
TimeStamp(&str);
- (*m_ostr) << str << wxConvertWX2MB(szString) << wxSTD endl;
+ (*m_ostr) << wxConvertWX2MB(str) << wxConvertWX2MB(szString) << wxSTD endl;
}
#endif // wxUSE_STD_IOSTREAM
wxLogChain::wxLogChain(wxLog *logger)
{
- m_bPassMessages = TRUE;
+ m_bPassMessages = true;
m_logNew = logger;
m_logOld = wxLog::SetActiveTarget(this);
// ----------------------------------------------------------------------------
wxLog *wxLog::ms_pLogger = (wxLog *)NULL;
-bool wxLog::ms_doLog = TRUE;
-bool wxLog::ms_bAutoCreate = TRUE;
-bool wxLog::ms_bVerbose = FALSE;
+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;
-#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;
unsigned long wxSysErrorCode()
{
#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
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,
+ if ( ::FormatMessage
+ (
+ FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
+ NULL,
+ nErrCode,
MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
(LPTSTR)&lpMsgBuf,
- 0, NULL);
+ 0,
+ NULL
+ ) == 0 )
+ {
+ // if this happens, something is seriously wrong, so don't use _() here
+ // for safety
+ wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode);
+ return s_szBuf;
+ }
+
// copy it to our buffer and free memory
- if( lpMsgBuf != 0 ) {
+ // Crashes on SmartPhone (FIXME)
+#if !defined(__SMARTPHONE__) /* of WinCE */
+ if( lpMsgBuf != 0 )
+ {
wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
s_szBuf[len - 2] = wxT('\0');
}
}
- else {
+ else
+#endif
+ {
s_szBuf[0] = wxT('\0');
}
return s_szBuf;
-#else //Win16
- // TODO
- return NULL;
-#endif // Win16/32
-#else // Unix
+#else // Unix-WXMICROWIN
#if wxUSE_UNICODE
static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
#else
return strerror((int)nErrCode);
#endif
-#endif // Win/Unix
+#endif // Win/Unix-WXMICROWIN
}
-#endif //wxUSE_LOG
-
-// vi:sts=4:sw=4:et
+#endif // wxUSE_LOG