]> git.saurik.com Git - wxWidgets.git/blobdiff - src/common/log.cpp
make construct simpler
[wxWidgets.git] / src / common / log.cpp
index afcc832ec275d69017f5c616d41c39a04eb8add8..4da49d8fe959ee21f37fecf98ac655c5bba88c75 100644 (file)
@@ -6,7 +6,7 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // ============================================================================
 // headers
 // ----------------------------------------------------------------------------
 
-#ifdef __GNUG__
-  #pragma implementation "log.h"
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
+    #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/arrstr.h"
+    #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>
+#ifndef __WXWINCE__
+#include <errno.h>
+#endif
+
+#include <stdlib.h>
+
+#ifndef __WXWINCE__
+#include <time.h>
+#else
+#include "wx/msw/wince/time.h"
+#endif
 
-#if defined(__WXMSW__)
-  #include  "wx/msw/private.h"      // includes windows.h for OutputDebugString
+#if defined(__WINDOWS__)
+    #include "wx/msw/private.h" // includes windows.h
 #endif
 
 // ----------------------------------------------------------------------------
 #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
 
@@ -106,85 +113,146 @@ static inline bool IsLoggingEnabled()
 //     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);
+
+#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);
+}
+
 // 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;
@@ -197,16 +265,21 @@ void wxLogVerbose(const wxChar *szFormat, ...)
       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
@@ -214,15 +287,20 @@ void wxLogVerbose(const wxChar *szFormat, ...)
     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
@@ -239,46 +317,73 @@ void wxLogSysErrorHelper(long lErrCode)
     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()
@@ -292,7 +397,7 @@ wxLog *wxLog::GetActiveTarget()
 
             // 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;
 
@@ -333,7 +438,7 @@ void wxLog::RemoveTraceMask(const wxString& str)
 {
     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()
@@ -362,7 +467,11 @@ void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
             DoLogString(wxString(_("Fatal error: ")) + szString, t);
             DoLogString(_("Program aborted."), t);
             Flush();
+#ifdef __WXWINCE__
+            ExitThread(3);
+#else
             abort();
+#endif
             break;
 
         case wxLOG_Error:
@@ -402,8 +511,17 @@ void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
 
 void wxLog::Flush()
 {
-    // remember that we don't have any more messages to show
-    m_bHasMessages = FALSE;
+    // nothing to do here
+}
+
+/*static*/ bool wxLog::IsAllowedTraceMask(const wxChar *mask)
+{
+    for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
+                                  en = ms_aTraceMasks.end();
+         it != en; ++it )
+        if ( *it == mask)
+            return true;
+    return false;
 }
 
 // ----------------------------------------------------------------------------
@@ -418,86 +536,6 @@ wxLogStderr::wxLogStderr(FILE *fp)
         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;
@@ -508,44 +546,18 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
     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 ) ;
-#if __WXDEBUG__
-    Boolean running = false ;
-
-/*
-    if ( MWDebuggerIsRunning() )
-    {
-        AmIBeingMWDebugged( &running ) ;
-    }
-*/
-    if (running)
-    {
-#ifdef __powerc
-        DebugStr(pstr);
-#else
-        SysBreakStr(pstr);
-#endif
-    }
-    else
-#endif
+    // 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 )
     {
-#ifdef __powerc
-        DebugStr(pstr);
-#else
-        DebugStr(pstr);
-#endif
+        wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
+        if ( traits && !traits->HasStderr() )
+        {
+            wxMessageOutputDebug().Printf(_T("%s"), str.c_str());
+        }
     }
-#endif // Mac
 }
 
 // ----------------------------------------------------------------------------
@@ -553,6 +565,7 @@ void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 // ----------------------------------------------------------------------------
 
 #if wxUSE_STD_IOSTREAM
+#include "wx/ioswrap.h"
 wxLogStream::wxLogStream(wxSTD ostream *ostr)
 {
     if ( ostr == NULL )
@@ -575,16 +588,24 @@ void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 
 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;
 }
@@ -594,7 +615,7 @@ void wxLogChain::Flush()
     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();
 }
@@ -646,13 +667,11 @@ 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;
@@ -767,4 +786,5 @@ const wxChar *wxSysErrorMsg(unsigned long nErrCode)
 #endif  // Win/Unix
 }
 
-#endif //wxUSE_LOG
+#endif // wxUSE_LOG
+