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 license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
21 #pragma implementation "log.h"
24 // For compilers that support precompilation, includes "wx.h".
25 #include "wx/wxprec.h"
33 #include "wx/string.h"
38 #include "wx/window.h"
40 #include "wx/msw/private.h"
46 #include "wx/textfile.h"
48 #include "wx/wxchar.h"
50 #include "wx/thread.h"
54 // other standard headers
59 #if defined(__WXMSW__)
60 #include "wx/msw/private.h" // includes windows.h for OutputDebugString
63 // ----------------------------------------------------------------------------
64 // non member functions
65 // ----------------------------------------------------------------------------
67 // define this to enable wrapping of log messages
68 //#define LOG_PRETTY_WRAP
70 #ifdef LOG_PRETTY_WRAP
71 static void wxLogWrap(FILE *f
, const char *pszPrefix
, const char *psz
);
74 // ============================================================================
76 // ============================================================================
78 // ----------------------------------------------------------------------------
80 // ----------------------------------------------------------------------------
82 // log functions can't allocate memory (LogError("out of memory...") should
83 // work!), so we use a static buffer for all log messages
84 #define LOG_BUFFER_SIZE (4096)
86 // static buffer for error messages
87 static wxChar s_szBuf
[LOG_BUFFER_SIZE
];
91 // the critical section protecting the static buffer
92 static wxCriticalSection gs_csLogBuf
;
94 #endif // wxUSE_THREADS
96 // return true if we have a non NULL non disabled log target
97 static inline bool IsLoggingEnabled()
99 return wxLog::IsEnabled() && (wxLog::GetActiveTarget() != NULL
);
102 // ----------------------------------------------------------------------------
103 // implementation of Log functions
105 // NB: unfortunately we need all these distinct functions, we can't make them
106 // macros and not all compilers inline vararg functions.
107 // ----------------------------------------------------------------------------
109 // generic log function
110 void wxLogGeneric(wxLogLevel level
, const wxChar
*szFormat
, ...)
112 if ( IsLoggingEnabled() ) {
113 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
116 va_start(argptr
, szFormat
);
117 wxVsnprintf(s_szBuf
, WXSIZEOF(s_szBuf
), szFormat
, argptr
);
120 wxLog::OnLog(level
, s_szBuf
, time(NULL
));
124 #define IMPLEMENT_LOG_FUNCTION(level) \
125 void wxLog##level(const wxChar *szFormat, ...) \
127 if ( IsLoggingEnabled() ) { \
128 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
131 va_start(argptr, szFormat); \
132 wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); \
135 wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
139 IMPLEMENT_LOG_FUNCTION(FatalError
)
140 IMPLEMENT_LOG_FUNCTION(Error
)
141 IMPLEMENT_LOG_FUNCTION(Warning
)
142 IMPLEMENT_LOG_FUNCTION(Message
)
143 IMPLEMENT_LOG_FUNCTION(Info
)
144 IMPLEMENT_LOG_FUNCTION(Status
)
146 // same as info, but only if 'verbose' mode is on
147 void wxLogVerbose(const wxChar
*szFormat
, ...)
149 if ( IsLoggingEnabled() ) {
150 wxLog
*pLog
= wxLog::GetActiveTarget();
151 if ( pLog
!= NULL
&& pLog
->GetVerbose() ) {
152 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
155 va_start(argptr
, szFormat
);
156 wxVsnprintf(s_szBuf
, WXSIZEOF(s_szBuf
), szFormat
, argptr
);
159 wxLog::OnLog(wxLOG_Info
, s_szBuf
, time(NULL
));
166 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
167 void wxLog##level(const wxChar *szFormat, ...) \
169 if ( IsLoggingEnabled() ) { \
170 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
173 va_start(argptr, szFormat); \
174 wxVsnprintf(s_szBuf, WXSIZEOF(s_szBuf), szFormat, argptr); \
177 wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
181 void wxLogTrace(const wxChar
*mask
, const wxChar
*szFormat
, ...)
183 if ( IsLoggingEnabled() && wxLog::IsAllowedTraceMask(mask
) ) {
184 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
187 size_t len
= WXSIZEOF(s_szBuf
);
188 wxStrncpy(s_szBuf
, _T("("), len
);
189 len
-= 1; // strlen("(")
191 wxStrncat(p
, mask
, len
);
192 size_t lenMask
= wxStrlen(mask
);
196 wxStrncat(p
, _T(") "), len
);
201 va_start(argptr
, szFormat
);
202 wxVsnprintf(p
, len
, szFormat
, argptr
);
205 wxLog::OnLog(wxLOG_Trace
, s_szBuf
, time(NULL
));
209 void wxLogTrace(wxTraceMask mask
, const wxChar
*szFormat
, ...)
211 // we check that all of mask bits are set in the current mask, so
212 // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
213 // if both bits are set.
214 if ( IsLoggingEnabled() && ((wxLog::GetTraceMask() & mask
) == mask
) ) {
215 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
218 va_start(argptr
, szFormat
);
219 wxVsnprintf(s_szBuf
, WXSIZEOF(s_szBuf
), szFormat
, argptr
);
222 wxLog::OnLog(wxLOG_Trace
, s_szBuf
, time(NULL
));
227 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
230 IMPLEMENT_LOG_DEBUG_FUNCTION(Debug
)
231 IMPLEMENT_LOG_DEBUG_FUNCTION(Trace
)
233 // wxLogSysError: one uses the last error code, for other you must give it
236 // common part of both wxLogSysError
237 void wxLogSysErrorHelper(long lErrCode
)
239 wxChar szErrMsg
[LOG_BUFFER_SIZE
/ 2];
240 wxSnprintf(szErrMsg
, WXSIZEOF(szErrMsg
),
241 _(" (error %ld: %s)"), lErrCode
, wxSysErrorMsg(lErrCode
));
242 wxStrncat(s_szBuf
, szErrMsg
, WXSIZEOF(s_szBuf
) - wxStrlen(s_szBuf
));
244 wxLog::OnLog(wxLOG_Error
, s_szBuf
, time(NULL
));
247 void WXDLLEXPORT
wxLogSysError(const wxChar
*szFormat
, ...)
249 if ( IsLoggingEnabled() ) {
250 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
253 va_start(argptr
, szFormat
);
254 wxVsnprintf(s_szBuf
, WXSIZEOF(s_szBuf
), szFormat
, argptr
);
257 wxLogSysErrorHelper(wxSysErrorCode());
261 void WXDLLEXPORT
wxLogSysError(long lErrCode
, const wxChar
*szFormat
, ...)
263 if ( IsLoggingEnabled() ) {
264 wxCRIT_SECT_LOCKER(locker
, gs_csLogBuf
);
267 va_start(argptr
, szFormat
);
268 wxVsnprintf(s_szBuf
, WXSIZEOF(s_szBuf
), szFormat
, argptr
);
271 wxLogSysErrorHelper(lErrCode
);
275 // ----------------------------------------------------------------------------
276 // wxLog class implementation
277 // ----------------------------------------------------------------------------
281 m_bHasMessages
= FALSE
;
284 wxLog
*wxLog::GetActiveTarget()
286 if ( ms_bAutoCreate
&& ms_pLogger
== NULL
) {
287 // prevent infinite recursion if someone calls wxLogXXX() from
288 // wxApp::CreateLogTarget()
289 static bool s_bInGetActiveTarget
= FALSE
;
290 if ( !s_bInGetActiveTarget
) {
291 s_bInGetActiveTarget
= TRUE
;
293 // ask the application to create a log target for us
294 if ( wxTheApp
!= NULL
)
295 ms_pLogger
= wxTheApp
->CreateLogTarget();
297 ms_pLogger
= new wxLogStderr
;
299 s_bInGetActiveTarget
= FALSE
;
301 // do nothing if it fails - what can we do?
308 wxLog
*wxLog::SetActiveTarget(wxLog
*pLogger
)
310 if ( ms_pLogger
!= NULL
) {
311 // flush the old messages before changing because otherwise they might
312 // get lost later if this target is not restored
316 wxLog
*pOldLogger
= ms_pLogger
;
317 ms_pLogger
= pLogger
;
322 void wxLog::DontCreateOnDemand()
324 ms_bAutoCreate
= FALSE
;
326 // this is usually called at the end of the program and we assume that it
327 // is *always* called at the end - so we free memory here to avoid false
328 // memory leak reports from wxWin memory tracking code
332 void wxLog::RemoveTraceMask(const wxString
& str
)
334 int index
= ms_aTraceMasks
.Index(str
);
335 if ( index
!= wxNOT_FOUND
)
336 ms_aTraceMasks
.Remove((size_t)index
);
339 void wxLog::ClearTraceMasks()
341 ms_aTraceMasks
.Clear();
344 void wxLog::TimeStamp(wxString
*str
)
350 (void)time(&timeNow
);
351 wxStrftime(buf
, WXSIZEOF(buf
), ms_timestamp
, localtime(&timeNow
));
354 *str
<< buf
<< wxT(": ");
358 void wxLog::DoLog(wxLogLevel level
, const wxChar
*szString
, time_t t
)
361 case wxLOG_FatalError
:
362 DoLogString(wxString(_("Fatal error: ")) + szString
, t
);
363 DoLogString(_("Program aborted."), t
);
369 DoLogString(wxString(_("Error: ")) + szString
, t
);
373 DoLogString(wxString(_("Warning: ")) + szString
, t
);
380 default: // log unknown log levels too
381 DoLogString(szString
, t
);
388 wxString msg
= level
== wxLOG_Trace
? wxT("Trace: ")
398 void wxLog::DoLogString(const wxChar
*WXUNUSED(szString
), time_t WXUNUSED(t
))
400 wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
405 // remember that we don't have any more messages to show
406 m_bHasMessages
= FALSE
;
409 // ----------------------------------------------------------------------------
410 // wxLogStderr class implementation
411 // ----------------------------------------------------------------------------
413 wxLogStderr::wxLogStderr(FILE *fp
)
421 #if defined(__WXMAC__) && !defined(__DARWIN__)
422 #define kDebuggerSignature 'MWDB'
424 static Boolean
FindProcessBySignature(OSType signature
, ProcessInfoRec
* info
)
427 ProcessSerialNumber psn
;
428 Boolean found
= false;
429 psn
.highLongOfPSN
= 0;
430 psn
.lowLongOfPSN
= kNoProcess
;
432 if (!info
) return false;
434 info
->processInfoLength
= sizeof(ProcessInfoRec
);
435 info
->processName
= NULL
;
436 info
->processAppSpec
= NULL
;
439 while (!found
&& err
== noErr
)
441 err
= GetNextProcess(&psn
);
444 err
= GetProcessInformation(&psn
, info
);
445 found
= err
== noErr
&& info
->processSignature
== signature
;
451 pascal Boolean
MWDebuggerIsRunning(void)
454 return FindProcessBySignature(kDebuggerSignature
, &info
);
457 pascal OSErr
AmIBeingMWDebugged(Boolean
* result
)
460 ProcessSerialNumber psn
;
461 OSType sig
= kDebuggerSignature
;
462 AppleEvent theAE
= {typeNull
, NULL
};
463 AppleEvent theReply
= {typeNull
, NULL
};
464 AEAddressDesc addr
= {typeNull
, NULL
};
468 if (!result
) return paramErr
;
470 err
= AECreateDesc(typeApplSignature
, &sig
, sizeof(sig
), &addr
);
471 if (err
!= noErr
) goto exit
;
473 err
= AECreateAppleEvent(kDebuggerSignature
, 'Dbg?', &addr
,
474 kAutoGenerateReturnID
, kAnyTransactionID
, &theAE
);
475 if (err
!= noErr
) goto exit
;
477 GetCurrentProcess(&psn
);
478 err
= AEPutParamPtr(&theAE
, keyDirectObject
, typeProcessSerialNumber
,
480 if (err
!= noErr
) goto exit
;
482 err
= AESend(&theAE
, &theReply
, kAEWaitReply
, kAENormalPriority
,
483 kAEDefaultTimeout
, NULL
, NULL
);
484 if (err
!= noErr
) goto exit
;
486 err
= AEGetParamPtr(&theReply
, keyAEResult
, typeBoolean
, &actualType
, result
,
487 sizeof(Boolean
), &actualSize
);
491 AEDisposeDesc(&addr
);
492 if (theAE
.dataHandle
)
493 AEDisposeDesc(&theAE
);
494 if (theReply
.dataHandle
)
495 AEDisposeDesc(&theReply
);
501 void wxLogStderr::DoLogString(const wxChar
*szString
, time_t WXUNUSED(t
))
507 fputs(str
.mb_str(), m_fp
);
508 fputc(_T('\n'), m_fp
);
511 // under Windows, programs usually don't have stderr at all, so show the
512 // messages also under debugger - unless it's a console program
513 #if defined(__WXMSW__) && wxUSE_GUI && !defined(__WXMICROWIN__)
515 OutputDebugString(str
.c_str());
517 #if defined(__WXMAC__) && !defined(__DARWIN__) && wxUSE_GUI
519 strcpy( (char*) pstr
, str
.c_str() ) ;
520 strcat( (char*) pstr
, ";g" ) ;
521 c2pstr( (char*) pstr
) ;
523 Boolean running
= false ;
526 if ( MWDebuggerIsRunning() )
528 AmIBeingMWDebugged( &running ) ;
551 // ----------------------------------------------------------------------------
552 // wxLogStream implementation
553 // ----------------------------------------------------------------------------
555 #if wxUSE_STD_IOSTREAM
556 wxLogStream::wxLogStream(wxSTD ostream
*ostr
)
559 m_ostr
= &wxSTD cerr
;
564 void wxLogStream::DoLogString(const wxChar
*szString
, time_t WXUNUSED(t
))
568 (*m_ostr
) << str
<< wxConvertWX2MB(szString
) << wxSTD endl
;
570 #endif // wxUSE_STD_IOSTREAM
572 // ----------------------------------------------------------------------------
574 // ----------------------------------------------------------------------------
576 wxLogChain::wxLogChain(wxLog
*logger
)
579 m_logOld
= wxLog::SetActiveTarget(this);
582 void wxLogChain::SetLog(wxLog
*logger
)
584 if ( m_logNew
!= this )
587 wxLog::SetActiveTarget(logger
);
592 void wxLogChain::Flush()
597 // be careful to avoid inifinite recursion
598 if ( m_logNew
&& m_logNew
!= this )
602 void wxLogChain::DoLog(wxLogLevel level
, const wxChar
*szString
, time_t t
)
604 // let the previous logger show it
605 if ( m_logOld
&& IsPassingMessages() )
607 // bogus cast just to access protected DoLog
608 ((wxLogChain
*)m_logOld
)->DoLog(level
, szString
, t
);
611 if ( m_logNew
&& m_logNew
!= this )
614 ((wxLogChain
*)m_logNew
)->DoLog(level
, szString
, t
);
618 // ----------------------------------------------------------------------------
620 // ----------------------------------------------------------------------------
623 // "'this' : used in base member initializer list" - so what?
624 #pragma warning(disable:4355)
627 wxLogPassThrough::wxLogPassThrough()
633 #pragma warning(default:4355)
636 // ============================================================================
637 // Global functions/variables
638 // ============================================================================
640 // ----------------------------------------------------------------------------
642 // ----------------------------------------------------------------------------
644 wxLog
*wxLog::ms_pLogger
= (wxLog
*)NULL
;
645 bool wxLog::ms_doLog
= TRUE
;
646 bool wxLog::ms_bAutoCreate
= TRUE
;
647 bool wxLog::ms_bVerbose
= FALSE
;
649 size_t wxLog::ms_suspendCount
= 0;
652 const wxChar
*wxLog::ms_timestamp
= wxT("%X"); // time only, no date
654 const wxChar
*wxLog::ms_timestamp
= NULL
; // save space
657 wxTraceMask
wxLog::ms_ulTraceMask
= (wxTraceMask
)0;
658 wxArrayString
wxLog::ms_aTraceMasks
;
660 // ----------------------------------------------------------------------------
661 // stdout error logging helper
662 // ----------------------------------------------------------------------------
664 // helper function: wraps the message and justifies it under given position
665 // (looks more pretty on the terminal). Also adds newline at the end.
667 // TODO this is now disabled until I find a portable way of determining the
668 // terminal window size (ok, I found it but does anybody really cares?)
669 #ifdef LOG_PRETTY_WRAP
670 static void wxLogWrap(FILE *f
, const char *pszPrefix
, const char *psz
)
672 size_t nMax
= 80; // FIXME
673 size_t nStart
= strlen(pszPrefix
);
677 while ( *psz
!= '\0' ) {
678 for ( n
= nStart
; (n
< nMax
) && (*psz
!= '\0'); n
++ )
682 if ( *psz
!= '\0' ) {
684 for ( n
= 0; n
< nStart
; n
++ )
687 // as we wrapped, squeeze all white space
688 while ( isspace(*psz
) )
695 #endif //LOG_PRETTY_WRAP
697 // ----------------------------------------------------------------------------
698 // error code/error message retrieval functions
699 // ----------------------------------------------------------------------------
701 // get error code from syste
702 unsigned long wxSysErrorCode()
704 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
706 return ::GetLastError();
708 // TODO what to do on Windows 3.1?
716 // get error message from system
717 const wxChar
*wxSysErrorMsg(unsigned long nErrCode
)
720 nErrCode
= wxSysErrorCode();
722 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
724 static wxChar s_szBuf
[LOG_BUFFER_SIZE
/ 2];
726 // get error message from system
728 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
| FORMAT_MESSAGE_FROM_SYSTEM
,
730 MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
734 // copy it to our buffer and free memory
735 wxStrncpy(s_szBuf
, (const wxChar
*)lpMsgBuf
, WXSIZEOF(s_szBuf
) - 1);
736 s_szBuf
[WXSIZEOF(s_szBuf
) - 1] = wxT('\0');
739 // returned string is capitalized and ended with '\r\n' - bad
740 s_szBuf
[0] = (wxChar
)wxTolower(s_szBuf
[0]);
741 size_t len
= wxStrlen(s_szBuf
);
744 if ( s_szBuf
[len
- 2] == wxT('\r') )
745 s_szBuf
[len
- 2] = wxT('\0');
755 static wxChar s_szBuf
[LOG_BUFFER_SIZE
/ 2];
756 wxConvCurrent
->MB2WC(s_szBuf
, strerror(nErrCode
), WXSIZEOF(s_szBuf
) -1);
759 return strerror((int)nErrCode
);