1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
21 #pragma implementation "log.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
36 #include "wx/arrstr.h"
38 #include "wx/string.h"
41 #include "wx/apptrait.h"
44 #include "wx/msgout.h"
45 #include "wx/textfile.h"
46 #include "wx/thread.h"
48 #include "wx/wxchar.h"
50 // other standard headers
60 #include "wx/msw/wince/time.h"
63 #if defined(__WINDOWS__)
64 #include "wx/msw/private.h" // includes windows.h
67 // ----------------------------------------------------------------------------
68 // non member functions
69 // ----------------------------------------------------------------------------
71 // define this to enable wrapping of log messages
72 //#define LOG_PRETTY_WRAP
74 #ifdef LOG_PRETTY_WRAP
75 static void wxLogWrap(FILE *f
, const char *pszPrefix
, const char *psz
);
78 // ============================================================================
80 // ============================================================================
82 // ----------------------------------------------------------------------------
84 // ----------------------------------------------------------------------------
86 // log functions can't allocate memory (LogError("out of memory...") should
87 // work!), so we use a static buffer for all log messages
88 #define LOG_BUFFER_SIZE (4096)
90 // static buffer for error messages
91 static wxChar s_szBufStatic
[LOG_BUFFER_SIZE
];
93 static wxChar
*s_szBuf
= s_szBufStatic
;
94 static size_t s_szBufSize
= WXSIZEOF( s_szBufStatic
);
98 // the critical section protecting the static buffer
99 static wxCriticalSection gs_csLogBuf
;
101 #endif // wxUSE_THREADS
103 // return true if we have a non NULL non disabled log target
104 static inline bool IsLoggingEnabled()
106 return wxLog::IsEnabled() && (wxLog::GetActiveTarget() != NULL
);
109 // ----------------------------------------------------------------------------
110 // implementation of Log functions
112 // NB: unfortunately we need all these distinct functions, we can't make them
113 // macros and not all compilers inline vararg functions.
114 // ----------------------------------------------------------------------------
116 // wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it
117 static inline void PrintfInLogBug(const wxChar
*szFormat
, va_list argptr
)
119 if ( wxVsnprintf(s_szBuf
, s_szBufSize
, szFormat
, argptr
) < 0 )
121 // must NUL-terminate it manually
122 s_szBuf
[s_szBufSize
- 1] = _T('\0');
124 //else: NUL-terminated by vsnprintf()
127 // generic log function
128 void wxVLogGeneric(wxLogLevel level
, const wxChar
*szFormat
, va_list argptr
)
130 if ( IsLoggingEnabled() ) {
131 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
133 PrintfInLogBug(szFormat
, argptr
);
135 wxLog::OnLog(level
, s_szBuf
, time(NULL
));
139 void wxLogGeneric(wxLogLevel level
, const wxChar
*szFormat
, ...)
142 va_start(argptr
, szFormat
);
143 wxVLogGeneric(level
, szFormat
, argptr
);
147 #define IMPLEMENT_LOG_FUNCTION(level) \
148 void wxVLog##level(const wxChar *szFormat, va_list argptr) \
150 if ( IsLoggingEnabled() ) { \
151 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
153 PrintfInLogBug(szFormat, argptr); \
155 wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
159 void wxLog##level(const wxChar *szFormat, ...) \
162 va_start(argptr, szFormat); \
163 wxVLog##level(szFormat, argptr); \
167 IMPLEMENT_LOG_FUNCTION(Error
)
168 IMPLEMENT_LOG_FUNCTION(Warning
)
169 IMPLEMENT_LOG_FUNCTION(Message
)
170 IMPLEMENT_LOG_FUNCTION(Info
)
171 IMPLEMENT_LOG_FUNCTION(Status
)
173 void wxSafeShowMessage(const wxString
& title
, const wxString
& text
)
176 ::MessageBox(NULL
, text
, title
, MB_OK
| MB_ICONSTOP
);
178 wxFprintf(stderr
, _T("%s: %s\n"), title
.c_str(), text
.c_str());
182 // fatal errors can't be suppressed nor handled by the custom log target and
183 // always terminate the program
184 void wxVLogFatalError(const wxChar
*szFormat
, va_list argptr
)
186 wxVsnprintf(s_szBuf
, s_szBufSize
, szFormat
, argptr
);
188 wxSafeShowMessage(_T("Fatal Error"), s_szBuf
);
197 void wxLogFatalError(const wxChar
*szFormat
, ...)
200 va_start(argptr
, szFormat
);
201 wxVLogFatalError(szFormat
, argptr
);
203 // some compilers warn about unreachable code and it shouldn't matter
204 // for the others anyhow...
208 // same as info, but only if 'verbose' mode is on
209 void wxVLogVerbose(const wxChar
*szFormat
, va_list argptr
)
211 if ( IsLoggingEnabled() ) {
212 wxLog
*pLog
= wxLog::GetActiveTarget();
213 if ( pLog
!= NULL
&& pLog
->GetVerbose() ) {
214 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
216 wxVsnprintf(s_szBuf
, s_szBufSize
, szFormat
, argptr
);
218 wxLog::OnLog(wxLOG_Info
, s_szBuf
, time(NULL
));
223 void wxLogVerbose(const wxChar
*szFormat
, ...)
226 va_start(argptr
, szFormat
);
227 wxVLogVerbose(szFormat
, argptr
);
233 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
234 void wxVLog##level(const wxChar *szFormat, va_list argptr) \
236 if ( IsLoggingEnabled() ) { \
237 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
239 wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); \
241 wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
244 void wxLog##level(const wxChar *szFormat, ...) \
247 va_start(argptr, szFormat); \
248 wxVLog##level(szFormat, argptr); \
252 void wxVLogTrace(const wxChar
*mask
, const wxChar
*szFormat
, va_list argptr
)
254 if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask
) ) {
255 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
258 size_t len
= s_szBufSize
;
259 wxStrncpy(s_szBuf
, _T("("), len
);
260 len
-= 1; // strlen("(")
262 wxStrncat(p
, mask
, len
);
263 size_t lenMask
= wxStrlen(mask
);
267 wxStrncat(p
, _T(") "), len
);
271 wxVsnprintf(p
, len
, szFormat
, argptr
);
273 wxLog::OnLog(wxLOG_Trace
, s_szBuf
, time(NULL
));
277 void wxLogTrace(const wxChar
*mask
, const wxChar
*szFormat
, ...)
280 va_start(argptr
, szFormat
);
281 wxVLogTrace(mask
, szFormat
, argptr
);
285 void wxVLogTrace(wxTraceMask mask
, const wxChar
*szFormat
, va_list argptr
)
287 // we check that all of mask bits are set in the current mask, so
288 // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
289 // if both bits are set.
290 if ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask
) == mask
) ) {
291 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
293 wxVsnprintf(s_szBuf
, s_szBufSize
, szFormat
, argptr
);
295 wxLog::OnLog(wxLOG_Trace
, s_szBuf
, time(NULL
));
299 void wxLogTrace(wxTraceMask mask
, const wxChar
*szFormat
, ...)
302 va_start(argptr
, szFormat
);
303 wxVLogTrace(mask
, szFormat
, argptr
);
308 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
311 IMPLEMENT_LOG_DEBUG_FUNCTION(Debug
)
312 IMPLEMENT_LOG_DEBUG_FUNCTION(Trace
)
314 // wxLogSysError: one uses the last error code, for other you must give it
317 // common part of both wxLogSysError
318 void wxLogSysErrorHelper(long lErrCode
)
320 wxChar szErrMsg
[LOG_BUFFER_SIZE
/ 2];
321 wxSnprintf(szErrMsg
, WXSIZEOF(szErrMsg
),
322 _(" (error %ld: %s)"), lErrCode
, wxSysErrorMsg(lErrCode
));
323 wxStrncat(s_szBuf
, szErrMsg
, s_szBufSize
- wxStrlen(s_szBuf
));
325 wxLog::OnLog(wxLOG_Error
, s_szBuf
, time(NULL
));
328 void WXDLLEXPORT
wxVLogSysError(const wxChar
*szFormat
, va_list argptr
)
330 if ( IsLoggingEnabled() ) {
331 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
333 wxVsnprintf(s_szBuf
, s_szBufSize
, szFormat
, argptr
);
335 wxLogSysErrorHelper(wxSysErrorCode());
339 void WXDLLEXPORT
wxLogSysError(const wxChar
*szFormat
, ...)
342 va_start(argptr
, szFormat
);
343 wxVLogSysError(szFormat
, argptr
);
347 void WXDLLEXPORT
wxVLogSysError(long lErrCode
, const wxChar
*szFormat
, va_list argptr
)
349 if ( IsLoggingEnabled() ) {
350 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
352 wxVsnprintf(s_szBuf
, s_szBufSize
, szFormat
, argptr
);
354 wxLogSysErrorHelper(lErrCode
);
358 void WXDLLEXPORT
wxLogSysError(long lErrCode
, const wxChar
*szFormat
, ...)
361 va_start(argptr
, szFormat
);
362 wxVLogSysError(lErrCode
, szFormat
, argptr
);
366 // ----------------------------------------------------------------------------
367 // wxLog class implementation
368 // ----------------------------------------------------------------------------
374 wxChar
*wxLog::SetLogBuffer( wxChar
*buf
, size_t size
)
376 wxChar
*oldbuf
= s_szBuf
;
380 s_szBuf
= s_szBufStatic
;
381 s_szBufSize
= WXSIZEOF( s_szBufStatic
);
389 return (oldbuf
== s_szBufStatic
) ? 0 : oldbuf
;
392 wxLog
*wxLog::GetActiveTarget()
394 if ( ms_bAutoCreate
&& ms_pLogger
== NULL
) {
395 // prevent infinite recursion if someone calls wxLogXXX() from
396 // wxApp::CreateLogTarget()
397 static bool s_bInGetActiveTarget
= false;
398 if ( !s_bInGetActiveTarget
) {
399 s_bInGetActiveTarget
= true;
401 // ask the application to create a log target for us
402 if ( wxTheApp
!= NULL
)
403 ms_pLogger
= wxTheApp
->GetTraits()->CreateLogTarget();
405 ms_pLogger
= new wxLogStderr
;
407 s_bInGetActiveTarget
= false;
409 // do nothing if it fails - what can we do?
416 wxLog
*wxLog::SetActiveTarget(wxLog
*pLogger
)
418 if ( ms_pLogger
!= NULL
) {
419 // flush the old messages before changing because otherwise they might
420 // get lost later if this target is not restored
424 wxLog
*pOldLogger
= ms_pLogger
;
425 ms_pLogger
= pLogger
;
430 void wxLog::DontCreateOnDemand()
432 ms_bAutoCreate
= false;
434 // this is usually called at the end of the program and we assume that it
435 // is *always* called at the end - so we free memory here to avoid false
436 // memory leak reports from wxWin memory tracking code
440 void wxLog::RemoveTraceMask(const wxString
& str
)
442 int index
= ms_aTraceMasks
.Index(str
);
443 if ( index
!= wxNOT_FOUND
)
444 ms_aTraceMasks
.RemoveAt((size_t)index
);
447 void wxLog::ClearTraceMasks()
449 ms_aTraceMasks
.Clear();
452 void wxLog::TimeStamp(wxString
*str
)
458 (void)time(&timeNow
);
459 wxStrftime(buf
, WXSIZEOF(buf
), ms_timestamp
, localtime(&timeNow
));
462 *str
<< buf
<< wxT(": ");
466 void wxLog::DoLog(wxLogLevel level
, const wxChar
*szString
, time_t t
)
469 case wxLOG_FatalError
:
470 DoLogString(wxString(_("Fatal error: ")) + szString
, t
);
471 DoLogString(_("Program aborted."), t
);
481 DoLogString(wxString(_("Error: ")) + szString
, t
);
485 DoLogString(wxString(_("Warning: ")) + szString
, t
);
492 default: // log unknown log levels too
493 DoLogString(szString
, t
);
500 wxString msg
= level
== wxLOG_Trace
? wxT("Trace: ")
510 void wxLog::DoLogString(const wxChar
*WXUNUSED(szString
), time_t WXUNUSED(t
))
512 wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
517 // nothing to do here
520 /*static*/ bool wxLog::IsAllowedTraceMask(const wxChar
*mask
)
522 for ( wxArrayString::iterator it
= ms_aTraceMasks
.begin(),
523 en
= ms_aTraceMasks
.end();
530 // ----------------------------------------------------------------------------
531 // wxLogStderr class implementation
532 // ----------------------------------------------------------------------------
534 wxLogStderr::wxLogStderr(FILE *fp
)
542 void wxLogStderr::DoLogString(const wxChar
*szString
, time_t WXUNUSED(t
))
548 fputs(str
.mb_str(), m_fp
);
549 fputc(_T('\n'), m_fp
);
552 // under GUI systems such as Windows or Mac, programs usually don't have
553 // stderr at all, so show the messages also somewhere else, typically in
554 // the debugger window so that they go at least somewhere instead of being
556 if ( m_fp
== stderr
)
558 wxAppTraits
*traits
= wxTheApp
? wxTheApp
->GetTraits() : NULL
;
559 if ( traits
&& !traits
->HasStderr() )
561 wxMessageOutputDebug dbgout
;
562 dbgout
.Printf(_T("%s"), str
.c_str());
567 // ----------------------------------------------------------------------------
568 // wxLogStream implementation
569 // ----------------------------------------------------------------------------
571 #if wxUSE_STD_IOSTREAM
572 #include "wx/ioswrap.h"
573 wxLogStream::wxLogStream(wxSTD ostream
*ostr
)
576 m_ostr
= &wxSTD cerr
;
581 void wxLogStream::DoLogString(const wxChar
*szString
, time_t WXUNUSED(t
))
585 (*m_ostr
) << str
<< wxConvertWX2MB(szString
) << wxSTD endl
;
587 #endif // wxUSE_STD_IOSTREAM
589 // ----------------------------------------------------------------------------
591 // ----------------------------------------------------------------------------
593 wxLogChain::wxLogChain(wxLog
*logger
)
595 m_bPassMessages
= true;
598 m_logOld
= wxLog::SetActiveTarget(this);
601 wxLogChain::~wxLogChain()
605 if ( m_logNew
!= this )
609 void wxLogChain::SetLog(wxLog
*logger
)
611 if ( m_logNew
!= this )
617 void wxLogChain::Flush()
622 // be careful to avoid infinite recursion
623 if ( m_logNew
&& m_logNew
!= this )
627 void wxLogChain::DoLog(wxLogLevel level
, const wxChar
*szString
, time_t t
)
629 // let the previous logger show it
630 if ( m_logOld
&& IsPassingMessages() )
632 // bogus cast just to access protected DoLog
633 ((wxLogChain
*)m_logOld
)->DoLog(level
, szString
, t
);
636 if ( m_logNew
&& m_logNew
!= this )
639 ((wxLogChain
*)m_logNew
)->DoLog(level
, szString
, t
);
643 // ----------------------------------------------------------------------------
645 // ----------------------------------------------------------------------------
648 // "'this' : used in base member initializer list" - so what?
649 #pragma warning(disable:4355)
652 wxLogPassThrough::wxLogPassThrough()
658 #pragma warning(default:4355)
661 // ============================================================================
662 // Global functions/variables
663 // ============================================================================
665 // ----------------------------------------------------------------------------
667 // ----------------------------------------------------------------------------
669 wxLog
*wxLog::ms_pLogger
= (wxLog
*)NULL
;
670 bool wxLog::ms_doLog
= true;
671 bool wxLog::ms_bAutoCreate
= true;
672 bool wxLog::ms_bVerbose
= false;
674 wxLogLevel
wxLog::ms_logLevel
= wxLOG_Max
; // log everything by default
676 size_t wxLog::ms_suspendCount
= 0;
678 const wxChar
*wxLog::ms_timestamp
= wxT("%X"); // time only, no date
680 wxTraceMask
wxLog::ms_ulTraceMask
= (wxTraceMask
)0;
681 wxArrayString
wxLog::ms_aTraceMasks
;
683 // ----------------------------------------------------------------------------
684 // stdout error logging helper
685 // ----------------------------------------------------------------------------
687 // helper function: wraps the message and justifies it under given position
688 // (looks more pretty on the terminal). Also adds newline at the end.
690 // TODO this is now disabled until I find a portable way of determining the
691 // terminal window size (ok, I found it but does anybody really cares?)
692 #ifdef LOG_PRETTY_WRAP
693 static void wxLogWrap(FILE *f
, const char *pszPrefix
, const char *psz
)
695 size_t nMax
= 80; // FIXME
696 size_t nStart
= strlen(pszPrefix
);
700 while ( *psz
!= '\0' ) {
701 for ( n
= nStart
; (n
< nMax
) && (*psz
!= '\0'); n
++ )
705 if ( *psz
!= '\0' ) {
707 for ( n
= 0; n
< nStart
; n
++ )
710 // as we wrapped, squeeze all white space
711 while ( isspace(*psz
) )
718 #endif //LOG_PRETTY_WRAP
720 // ----------------------------------------------------------------------------
721 // error code/error message retrieval functions
722 // ----------------------------------------------------------------------------
724 // get error code from syste
725 unsigned long wxSysErrorCode()
727 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
728 return ::GetLastError();
734 // get error message from system
735 const wxChar
*wxSysErrorMsg(unsigned long nErrCode
)
738 nErrCode
= wxSysErrorCode();
740 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
741 static wxChar s_szBuf
[LOG_BUFFER_SIZE
/ 2];
743 // get error message from system
745 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
| FORMAT_MESSAGE_FROM_SYSTEM
,
747 MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
751 // copy it to our buffer and free memory
752 // Crashes on SmartPhone
753 #if !defined(__SMARTPHONE__) /* of WinCE */
754 if( lpMsgBuf
!= 0 ) {
755 wxStrncpy(s_szBuf
, (const wxChar
*)lpMsgBuf
, WXSIZEOF(s_szBuf
) - 1);
756 s_szBuf
[WXSIZEOF(s_szBuf
) - 1] = wxT('\0');
760 // returned string is capitalized and ended with '\r\n' - bad
761 s_szBuf
[0] = (wxChar
)wxTolower(s_szBuf
[0]);
762 size_t len
= wxStrlen(s_szBuf
);
765 if ( s_szBuf
[len
- 2] == wxT('\r') )
766 s_szBuf
[len
- 2] = wxT('\0');
772 s_szBuf
[0] = wxT('\0');
776 #else // Unix-WXMICROWIN
778 static wxChar s_szBuf
[LOG_BUFFER_SIZE
/ 2];
779 wxConvCurrent
->MB2WC(s_szBuf
, strerror(nErrCode
), WXSIZEOF(s_szBuf
) -1);
782 return strerror((int)nErrCode
);
784 #endif // Win/Unix-WXMICROWIN