]> git.saurik.com Git - wxWidgets.git/blame - src/common/log.cpp
use HandleWindowEvent() in ProcessCommand(); return the value this function returns...
[wxWidgets.git] / src / common / log.cpp
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
e4db172a 2// Name: src/common/log.cpp
c801d85f
KB
3// Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
4// Author: Vadim Zeitlin
5// Modified by:
6// Created: 29/01/98
7// RCS-ID: $Id$
8// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
65571936 9// Licence: wxWindows licence
c801d85f
KB
10/////////////////////////////////////////////////////////////////////////////
11
12// ============================================================================
13// declarations
14// ============================================================================
15
16// ----------------------------------------------------------------------------
17// headers
18// ----------------------------------------------------------------------------
dd85fc6b 19
c801d85f
KB
20// For compilers that support precompilation, includes "wx.h".
21#include "wx/wxprec.h"
22
23#ifdef __BORLANDC__
e2478fde 24 #pragma hdrstop
c801d85f
KB
25#endif
26
e2478fde
VZ
27#if wxUSE_LOG
28
77ffb593 29// wxWidgets
c801d85f 30#ifndef WX_PRECOMP
e4db172a 31 #include "wx/log.h"
e90c1d2a 32 #include "wx/app.h"
df5168c4 33 #include "wx/arrstr.h"
e2478fde
VZ
34 #include "wx/intl.h"
35 #include "wx/string.h"
de6185e2 36 #include "wx/utils.h"
9ef3052c 37#endif //WX_PRECOMP
c801d85f 38
e2478fde 39#include "wx/apptrait.h"
7b2d1c74 40#include "wx/datetime.h"
e2478fde 41#include "wx/file.h"
e2478fde
VZ
42#include "wx/msgout.h"
43#include "wx/textfile.h"
44#include "wx/thread.h"
3a3dde0d 45#include "wx/crt.h"
f94dfb38 46
c801d85f 47// other standard headers
1c193821 48#ifndef __WXWINCE__
e2478fde 49#include <errno.h>
1c193821
JS
50#endif
51
e2478fde 52#include <stdlib.h>
1c193821
JS
53
54#ifndef __WXWINCE__
e2478fde 55#include <time.h>
1c193821
JS
56#else
57#include "wx/msw/wince/time.h"
58#endif
31907d03 59
9cce3be7
VS
60#if defined(__WINDOWS__)
61 #include "wx/msw/private.h" // includes windows.h
62#endif
63
c801d85f
KB
64// ----------------------------------------------------------------------------
65// non member functions
66// ----------------------------------------------------------------------------
67
68// define this to enable wrapping of log messages
69//#define LOG_PRETTY_WRAP
70
9ef3052c 71#ifdef LOG_PRETTY_WRAP
c801d85f
KB
72 static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz);
73#endif
74
75// ============================================================================
76// implementation
77// ============================================================================
78
b568d04f
VZ
79// ----------------------------------------------------------------------------
80// implementation of Log functions
81//
82// NB: unfortunately we need all these distinct functions, we can't make them
83// macros and not all compilers inline vararg functions.
84// ----------------------------------------------------------------------------
85
c801d85f 86// generic log function
81727065 87void wxVLogGeneric(wxLogLevel level, const wxString& format, va_list argptr)
c801d85f 88{
d68d8590 89 if ( wxLog::IsEnabled() ) {
81727065 90 wxLog::OnLog(level, wxString::FormatV(format, argptr), time(NULL));
807a903e 91 }
c801d85f
KB
92}
93
d1f6e2cf
VS
94#if !wxUSE_UTF8_LOCALE_ONLY
95void wxDoLogGenericWchar(wxLogLevel level, const wxChar *format, ...)
ea44a631
GD
96{
97 va_list argptr;
2523e9b7
VS
98 va_start(argptr, format);
99 wxVLogGeneric(level, format, argptr);
ea44a631
GD
100 va_end(argptr);
101}
d1f6e2cf
VS
102#endif // wxUSE_UTF8_LOCALE_ONLY
103
104#if wxUSE_UNICODE_UTF8
105void wxDoLogGenericUtf8(wxLogLevel level, const char *format, ...)
106{
107 va_list argptr;
108 va_start(argptr, format);
109 wxVLogGeneric(level, format, argptr);
110 va_end(argptr);
111}
112#endif // wxUSE_UNICODE_UTF8
113
114#if !wxUSE_UTF8_LOCALE_ONLY
115 #define IMPLEMENT_LOG_FUNCTION_WCHAR(level) \
116 void wxDoLog##level##Wchar(const wxChar *format, ...) \
117 { \
118 va_list argptr; \
119 va_start(argptr, format); \
120 wxVLog##level(format, argptr); \
121 va_end(argptr); \
122 }
123#else
124 #define IMPLEMENT_LOG_FUNCTION_WCHAR(level)
125#endif
126
127#if wxUSE_UNICODE_UTF8
128 #define IMPLEMENT_LOG_FUNCTION_UTF8(level) \
129 void wxDoLog##level##Utf8(const char *format, ...) \
130 { \
131 va_list argptr; \
132 va_start(argptr, format); \
133 wxVLog##level(format, argptr); \
134 va_end(argptr); \
135 }
136#else
137 #define IMPLEMENT_LOG_FUNCTION_UTF8(level)
138#endif
ea44a631 139
807a903e 140#define IMPLEMENT_LOG_FUNCTION(level) \
81727065 141 void wxVLog##level(const wxString& format, va_list argptr) \
807a903e 142 { \
d68d8590 143 if ( wxLog::IsEnabled() ) { \
2e7f3845 144 wxLog::OnLog(wxLOG_##level, \
81727065 145 wxString::FormatV(format, argptr), time(NULL)); \
807a903e 146 } \
ea44a631 147 } \
d1f6e2cf
VS
148 IMPLEMENT_LOG_FUNCTION_WCHAR(level) \
149 IMPLEMENT_LOG_FUNCTION_UTF8(level)
c801d85f 150
c801d85f
KB
151IMPLEMENT_LOG_FUNCTION(Error)
152IMPLEMENT_LOG_FUNCTION(Warning)
153IMPLEMENT_LOG_FUNCTION(Message)
154IMPLEMENT_LOG_FUNCTION(Info)
155IMPLEMENT_LOG_FUNCTION(Status)
156
c11d62a6
VZ
157void wxSafeShowMessage(const wxString& title, const wxString& text)
158{
159#ifdef __WINDOWS__
e0a050e3 160 ::MessageBox(NULL, text.wx_str(), title.wx_str(), MB_OK | MB_ICONSTOP);
c11d62a6 161#else
a0516656 162 wxFprintf(stderr, wxS("%s: %s\n"), title.c_str(), text.c_str());
65f06384 163 fflush(stderr);
c11d62a6
VZ
164#endif
165}
166
1800689f
VZ
167// fatal errors can't be suppressed nor handled by the custom log target and
168// always terminate the program
81727065 169void wxVLogFatalError(const wxString& format, va_list argptr)
1800689f 170{
a0516656 171 wxSafeShowMessage(wxS("Fatal Error"), wxString::FormatV(format, argptr));
1800689f 172
1c193821
JS
173#ifdef __WXWINCE__
174 ExitThread(3);
175#else
1800689f 176 abort();
1c193821 177#endif
1800689f
VZ
178}
179
d1f6e2cf
VS
180#if !wxUSE_UTF8_LOCALE_ONLY
181void wxDoLogFatalErrorWchar(const wxChar *format, ...)
1800689f
VZ
182{
183 va_list argptr;
2523e9b7
VS
184 va_start(argptr, format);
185 wxVLogFatalError(format, argptr);
5e475383
VZ
186
187 // some compilers warn about unreachable code and it shouldn't matter
188 // for the others anyhow...
189 //va_end(argptr);
1800689f 190}
d1f6e2cf
VS
191#endif // wxUSE_UTF8_LOCALE_ONLY
192
193#if wxUSE_UNICODE_UTF8
194void wxDoLogFatalErrorUtf8(const char *format, ...)
195{
196 va_list argptr;
197 va_start(argptr, format);
198 wxVLogFatalError(format, argptr);
199
200 // some compilers warn about unreachable code and it shouldn't matter
201 // for the others anyhow...
202 //va_end(argptr);
203}
204#endif // wxUSE_UNICODE_UTF8
1800689f 205
9ef3052c 206// same as info, but only if 'verbose' mode is on
81727065 207void wxVLogVerbose(const wxString& format, va_list argptr)
9ef3052c 208{
d68d8590 209 if ( wxLog::IsEnabled() ) {
2a1f999f 210 if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
2e7f3845 211 wxLog::OnLog(wxLOG_Info,
81727065 212 wxString::FormatV(format, argptr), time(NULL));
807a903e
VZ
213 }
214 }
9ef3052c
VZ
215}
216
d1f6e2cf
VS
217#if !wxUSE_UTF8_LOCALE_ONLY
218void wxDoLogVerboseWchar(const wxChar *format, ...)
ea44a631
GD
219{
220 va_list argptr;
2523e9b7
VS
221 va_start(argptr, format);
222 wxVLogVerbose(format, argptr);
ea44a631
GD
223 va_end(argptr);
224}
d1f6e2cf
VS
225#endif // !wxUSE_UTF8_LOCALE_ONLY
226
227#if wxUSE_UNICODE_UTF8
228void wxDoLogVerboseUtf8(const char *format, ...)
229{
230 va_list argptr;
231 va_start(argptr, format);
232 wxVLogVerbose(format, argptr);
233 va_end(argptr);
234}
235#endif // wxUSE_UNICODE_UTF8
ea44a631 236
9ef3052c 237// debug functions
b2aef89b 238#ifdef __WXDEBUG__
d1f6e2cf
VS
239
240#if !wxUSE_UTF8_LOCALE_ONLY
241 #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level) \
242 void wxDoLog##level##Wchar(const wxChar *format, ...) \
243 { \
244 va_list argptr; \
245 va_start(argptr, format); \
246 wxVLog##level(format, argptr); \
247 va_end(argptr); \
248 }
249#else
250 #define IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level)
251#endif
252
253#if wxUSE_UNICODE_UTF8
254 #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level) \
255 void wxDoLog##level##Utf8(const char *format, ...) \
256 { \
257 va_list argptr; \
258 va_start(argptr, format); \
259 wxVLog##level(format, argptr); \
260 va_end(argptr); \
261 }
262#else
263 #define IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
264#endif
265
807a903e 266#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
2523e9b7 267 void wxVLog##level(const wxString& format, va_list argptr) \
807a903e 268 { \
d68d8590 269 if ( wxLog::IsEnabled() ) { \
2e7f3845 270 wxLog::OnLog(wxLOG_##level, \
2523e9b7 271 wxString::FormatV(format, argptr), time(NULL)); \
807a903e 272 } \
ea44a631 273 } \
d1f6e2cf
VS
274 IMPLEMENT_LOG_DEBUG_FUNCTION_WCHAR(level) \
275 IMPLEMENT_LOG_DEBUG_FUNCTION_UTF8(level)
276
c801d85f 277
81727065 278 void wxVLogTrace(const wxString& mask, const wxString& format, va_list argptr)
0fb67cd1 279 {
d68d8590 280 if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
2e7f3845 281 wxString msg;
a0516656 282 msg << wxS("(") << mask << wxS(") ") << wxString::FormatV(format, argptr);
c9f78968 283
2e7f3845 284 wxLog::OnLog(wxLOG_Trace, msg, time(NULL));
0fb67cd1
VZ
285 }
286 }
287
d1f6e2cf
VS
288#if !wxUSE_UTF8_LOCALE_ONLY
289 void wxDoLogTraceWchar(const wxString& mask, const wxChar *format, ...)
ea44a631
GD
290 {
291 va_list argptr;
2523e9b7
VS
292 va_start(argptr, format);
293 wxVLogTrace(mask, format, argptr);
ea44a631
GD
294 va_end(argptr);
295 }
d1f6e2cf
VS
296#endif // !wxUSE_UTF8_LOCALE_ONLY
297
298#if wxUSE_UNICODE_UTF8
299 void wxDoLogTraceUtf8(const wxString& mask, const char *format, ...)
300 {
301 va_list argptr;
302 va_start(argptr, format);
303 wxVLogTrace(mask, format, argptr);
304 va_end(argptr);
305 }
306#endif // wxUSE_UNICODE_UTF8
ea44a631 307
81727065 308 void wxVLogTrace(wxTraceMask mask, const wxString& format, va_list argptr)
9ef3052c 309 {
9ef3052c
VZ
310 // we check that all of mask bits are set in the current mask, so
311 // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
312 // if both bits are set.
d68d8590 313 if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
81727065 314 wxLog::OnLog(wxLOG_Trace, wxString::FormatV(format, argptr), time(NULL));
9ef3052c
VZ
315 }
316 }
317
8bd37efc 318#if !wxUSE_UTF8_LOCALE_ONLY
d1f6e2cf
VS
319 void wxDoLogTraceWchar(wxTraceMask mask, const wxChar *format, ...)
320 {
321 va_list argptr;
322 va_start(argptr, format);
323 wxVLogTrace(mask, format, argptr);
324 va_end(argptr);
325 }
8bd37efc 326#endif // !wxUSE_UTF8_LOCALE_ONLY
d1f6e2cf
VS
327
328#if wxUSE_UNICODE_UTF8
329 void wxDoLogTraceUtf8(wxTraceMask mask, const char *format, ...)
2523e9b7
VS
330 {
331 va_list argptr;
332 va_start(argptr, format);
333 wxVLogTrace(mask, format, argptr);
334 va_end(argptr);
335 }
d1f6e2cf 336#endif // wxUSE_UNICODE_UTF8
2523e9b7
VS
337
338#ifdef __WATCOMC__
339 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
59a14f69 340 void wxDoLogTraceWchar(int mask, const wxChar *format, ...)
2523e9b7
VS
341 {
342 va_list argptr;
343 va_start(argptr, format);
344 wxVLogTrace(mask, format, argptr);
345 va_end(argptr);
346 }
347
59a14f69 348 void wxDoLogTraceWchar(const char *mask, const wxChar *format, ...)
ea44a631
GD
349 {
350 va_list argptr;
2523e9b7
VS
351 va_start(argptr, format);
352 wxVLogTrace(mask, format, argptr);
ea44a631
GD
353 va_end(argptr);
354 }
355
59a14f69 356 void wxDoLogTraceWchar(const wchar_t *mask, const wxChar *format, ...)
2523e9b7
VS
357 {
358 va_list argptr;
359 va_start(argptr, format);
360 wxVLogTrace(mask, format, argptr);
361 va_end(argptr);
362 }
363
364 void wxVLogTrace(int mask, const wxString& format, va_list argptr)
365 { wxVLogTrace((wxTraceMask)mask, format, argptr); }
366 void wxVLogTrace(const char *mask, const wxString& format, va_list argptr)
367 { wxVLogTrace(wxString(mask), format, argptr); }
368 void wxVLogTrace(const wchar_t *mask, const wxString& format, va_list argptr)
369 { wxVLogTrace(wxString(mask), format, argptr); }
370#endif // __WATCOMC__
371
9ef3052c
VZ
372#else // release
373 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
374#endif
375
376IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
377IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
378
379// wxLogSysError: one uses the last error code, for other you must give it
380// explicitly
381
2e7f3845
VZ
382// return the system error message description
383static inline wxString wxLogSysErrorHelper(long err)
c801d85f 384{
2e7f3845 385 return wxString::Format(_(" (error %ld: %s)"), err, wxSysErrorMsg(err));
9ef3052c 386}
c801d85f 387
163b3ad7 388void WXDLLIMPEXP_BASE wxVLogSysError(const wxString& format, va_list argptr)
9ef3052c 389{
81727065 390 wxVLogSysError(wxSysErrorCode(), format, argptr);
c801d85f
KB
391}
392
d1f6e2cf 393#if !wxUSE_UTF8_LOCALE_ONLY
163b3ad7 394void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(const wxChar *format, ...)
ea44a631
GD
395{
396 va_list argptr;
2523e9b7
VS
397 va_start(argptr, format);
398 wxVLogSysError(format, argptr);
ea44a631
GD
399 va_end(argptr);
400}
d1f6e2cf
VS
401#endif // !wxUSE_UTF8_LOCALE_ONLY
402
403#if wxUSE_UNICODE_UTF8
163b3ad7 404void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(const char *format, ...)
d1f6e2cf
VS
405{
406 va_list argptr;
407 va_start(argptr, format);
408 wxVLogSysError(format, argptr);
409 va_end(argptr);
410}
411#endif // wxUSE_UNICODE_UTF8
ea44a631 412
163b3ad7 413void WXDLLIMPEXP_BASE wxVLogSysError(long err, const wxString& format, va_list argptr)
c801d85f 414{
d68d8590 415 if ( wxLog::IsEnabled() ) {
2e7f3845 416 wxLog::OnLog(wxLOG_Error,
81727065 417 wxString::FormatV(format, argptr) + wxLogSysErrorHelper(err),
2e7f3845 418 time(NULL));
807a903e 419 }
c801d85f
KB
420}
421
d1f6e2cf 422#if !wxUSE_UTF8_LOCALE_ONLY
163b3ad7 423void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
d1f6e2cf
VS
424{
425 va_list argptr;
426 va_start(argptr, format);
427 wxVLogSysError(lErrCode, format, argptr);
428 va_end(argptr);
429}
430#endif // !wxUSE_UTF8_LOCALE_ONLY
431
432#if wxUSE_UNICODE_UTF8
163b3ad7 433void WXDLLIMPEXP_BASE wxDoLogSysErrorUtf8(long lErrCode, const char *format, ...)
ea44a631
GD
434{
435 va_list argptr;
2523e9b7
VS
436 va_start(argptr, format);
437 wxVLogSysError(lErrCode, format, argptr);
ea44a631
GD
438 va_end(argptr);
439}
d1f6e2cf 440#endif // wxUSE_UNICODE_UTF8
ea44a631 441
2523e9b7
VS
442#ifdef __WATCOMC__
443// workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
163b3ad7 444void WXDLLIMPEXP_BASE wxDoLogSysErrorWchar(unsigned long lErrCode, const wxChar *format, ...)
2523e9b7
VS
445{
446 va_list argptr;
447 va_start(argptr, format);
448 wxVLogSysError(lErrCode, format, argptr);
449 va_end(argptr);
450}
451
163b3ad7 452void WXDLLIMPEXP_BASE wxVLogSysError(unsigned long err, const wxString& format, va_list argptr)
2523e9b7
VS
453 { wxVLogSysError((long)err, format, argptr); }
454#endif // __WATCOMC__
455
c801d85f
KB
456// ----------------------------------------------------------------------------
457// wxLog class implementation
458// ----------------------------------------------------------------------------
459
dbaa16de 460unsigned wxLog::LogLastRepeatIfNeeded()
f9837791 461{
a2d38265
VZ
462 wxCRIT_SECT_LOCKER(lock, ms_prevCS);
463
dbaa16de
VZ
464 return LogLastRepeatIfNeededUnlocked();
465}
466
467unsigned wxLog::LogLastRepeatIfNeededUnlocked()
468{
0250efd6
VZ
469 const unsigned count = ms_prevCounter;
470
c1f80bc0 471 if ( ms_prevCounter )
f9837791
VZ
472 {
473 wxString msg;
459b97df 474#if wxUSE_INTL
f9837791
VZ
475 msg.Printf(wxPLURAL("The previous message repeated once.",
476 "The previous message repeated %lu times.",
477 ms_prevCounter),
478 ms_prevCounter);
459b97df 479#else
a0516656 480 msg.Printf(wxS("The previous message was repeated %lu times."),
2064113c 481 ms_prevCounter);
459b97df 482#endif
f9837791
VZ
483 ms_prevCounter = 0;
484 ms_prevString.clear();
c1f80bc0 485 DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
f9837791 486 }
0250efd6
VZ
487
488 return count;
f9837791
VZ
489}
490
491wxLog::~wxLog()
492{
6f6b48f1
VZ
493 // Flush() must be called before destroying the object as otherwise some
494 // messages could be lost
495 if ( ms_prevCounter )
496 {
497 wxMessageOutputDebug().Printf
498 (
499 wxS("Last repeated message (\"%s\", %lu times) wasn't output"),
500 ms_prevString,
501 ms_prevCounter
502 );
503 }
f9837791
VZ
504}
505
506/* static */
5a20d2ce 507void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
f9837791
VZ
508{
509 if ( IsEnabled() && ms_logLevel >= level )
510 {
511 wxLog *pLogger = GetActiveTarget();
512 if ( pLogger )
513 {
2064113c 514 if ( GetRepetitionCounting() )
f9837791 515 {
a2d38265
VZ
516 wxCRIT_SECT_LOCKER(lock, ms_prevCS);
517
2064113c 518 if ( szString == ms_prevString )
f9837791 519 {
2064113c
VZ
520 ms_prevCounter++;
521
522 // nothing else to do, in particular, don't log the
523 // repeated message
524 return;
f9837791 525 }
2064113c 526
dbaa16de 527 pLogger->LogLastRepeatIfNeededUnlocked();
2064113c
VZ
528
529 // reset repetition counter for a new message
f9837791
VZ
530 ms_prevString = szString;
531 ms_prevLevel = level;
532 ms_prevTimeStamp = t;
f9837791 533 }
2064113c
VZ
534
535 pLogger->DoLog(level, szString, t);
f9837791
VZ
536 }
537 }
538}
539
2e7f3845 540// deprecated function
dcc40ba5
VZ
541#if WXWIN_COMPATIBILITY_2_6
542
2e7f3845 543wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
04662def 544{
2e7f3845 545 return NULL;
04662def
RL
546}
547
dcc40ba5
VZ
548#endif // WXWIN_COMPATIBILITY_2_6
549
5d88a6b5
VZ
550#if WXWIN_COMPATIBILITY_2_8
551
552void wxLog::DoLog(wxLogLevel WXUNUSED(level),
553 const char *WXUNUSED(szString),
554 time_t WXUNUSED(t))
555{
556}
557
558void wxLog::DoLog(wxLogLevel WXUNUSED(level),
559 const wchar_t *WXUNUSED(wzString),
560 time_t WXUNUSED(t))
561{
562}
563
564#endif // WXWIN_COMPATIBILITY_2_8
565
9ec05cc9
VZ
566wxLog *wxLog::GetActiveTarget()
567{
0fb67cd1
VZ
568 if ( ms_bAutoCreate && ms_pLogger == NULL ) {
569 // prevent infinite recursion if someone calls wxLogXXX() from
570 // wxApp::CreateLogTarget()
f644b28c 571 static bool s_bInGetActiveTarget = false;
0fb67cd1 572 if ( !s_bInGetActiveTarget ) {
f644b28c 573 s_bInGetActiveTarget = true;
0fb67cd1 574
0fb67cd1
VZ
575 // ask the application to create a log target for us
576 if ( wxTheApp != NULL )
dc6d5e38 577 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
0fb67cd1
VZ
578 else
579 ms_pLogger = new wxLogStderr;
0fb67cd1 580
f644b28c 581 s_bInGetActiveTarget = false;
0fb67cd1
VZ
582
583 // do nothing if it fails - what can we do?
584 }
275bf4c1 585 }
c801d85f 586
0fb67cd1 587 return ms_pLogger;
c801d85f
KB
588}
589
c085e333 590wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
9ec05cc9 591{
0fb67cd1
VZ
592 if ( ms_pLogger != NULL ) {
593 // flush the old messages before changing because otherwise they might
594 // get lost later if this target is not restored
595 ms_pLogger->Flush();
596 }
c801d85f 597
0fb67cd1
VZ
598 wxLog *pOldLogger = ms_pLogger;
599 ms_pLogger = pLogger;
c085e333 600
0fb67cd1 601 return pOldLogger;
c801d85f
KB
602}
603
36bd6902
VZ
604void wxLog::DontCreateOnDemand()
605{
f644b28c 606 ms_bAutoCreate = false;
36bd6902
VZ
607
608 // this is usually called at the end of the program and we assume that it
609 // is *always* called at the end - so we free memory here to avoid false
610 // memory leak reports from wxWin memory tracking code
611 ClearTraceMasks();
612}
613
e94cd97d
DE
614void wxLog::DoCreateOnDemand()
615{
616 ms_bAutoCreate = true;
617}
618
0fb67cd1 619void wxLog::RemoveTraceMask(const wxString& str)
c801d85f 620{
0fb67cd1
VZ
621 int index = ms_aTraceMasks.Index(str);
622 if ( index != wxNOT_FOUND )
dc6d5e38 623 ms_aTraceMasks.RemoveAt((size_t)index);
0fb67cd1 624}
c801d85f 625
36bd6902
VZ
626void wxLog::ClearTraceMasks()
627{
628 ms_aTraceMasks.Clear();
629}
630
d2e1ef19
VZ
631void wxLog::TimeStamp(wxString *str)
632{
7b2d1c74 633#if wxUSE_DATETIME
cb296f30 634 if ( !ms_timestamp.empty() )
d2e1ef19
VZ
635 {
636 wxChar buf[256];
637 time_t timeNow;
638 (void)time(&timeNow);
83e8b44c
VZ
639
640 struct tm tm;
641 wxStrftime(buf, WXSIZEOF(buf),
642 ms_timestamp, wxLocaltime_r(&timeNow, &tm));
d2e1ef19
VZ
643
644 str->Empty();
a0516656 645 *str << buf << wxS(": ");
d2e1ef19 646 }
7b2d1c74 647#endif // wxUSE_DATETIME
d2e1ef19
VZ
648}
649
5a20d2ce 650void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
0fb67cd1 651{
5a20d2ce
VS
652#if WXWIN_COMPATIBILITY_2_8
653 // DoLog() signature changed since 2.8, so we call the old versions here
654 // so that existing custom log classes still work:
655 DoLog(level, (const char*)szString.mb_str(), t);
656 DoLog(level, (const wchar_t*)szString.wc_str(), t);
657#endif
658
0fb67cd1
VZ
659 switch ( level ) {
660 case wxLOG_FatalError:
5a20d2ce
VS
661 LogString(_("Fatal error: ") + szString, t);
662 LogString(_("Program aborted."), t);
0fb67cd1 663 Flush();
1c193821
JS
664#ifdef __WXWINCE__
665 ExitThread(3);
666#else
0fb67cd1 667 abort();
1c193821 668#endif
0fb67cd1
VZ
669 break;
670
671 case wxLOG_Error:
5a20d2ce 672 LogString(_("Error: ") + szString, t);
0fb67cd1
VZ
673 break;
674
675 case wxLOG_Warning:
5a20d2ce 676 LogString(_("Warning: ") + szString, t);
0fb67cd1
VZ
677 break;
678
679 case wxLOG_Info:
0fb67cd1 680 if ( GetVerbose() )
37278984 681 case wxLOG_Message:
87a1e308 682 case wxLOG_Status:
786855a1 683 default: // log unknown log levels too
5a20d2ce 684 LogString(szString, t);
0fb67cd1
VZ
685 break;
686
687 case wxLOG_Trace:
688 case wxLOG_Debug:
689#ifdef __WXDEBUG__
0131687b 690 {
a0516656
VZ
691 wxString msg = level == wxLOG_Trace ? wxS("Trace: ")
692 : wxS("Debug: ");
0131687b 693 msg << szString;
5a20d2ce 694 LogString(msg, t);
0131687b
VZ
695 }
696#endif // Debug
0fb67cd1 697 break;
0fb67cd1 698 }
c801d85f
KB
699}
700
5a20d2ce 701void wxLog::DoLogString(const wxString& szString, time_t t)
c801d85f 702{
5a20d2ce
VS
703#if WXWIN_COMPATIBILITY_2_8
704 // DoLogString() signature changed since 2.8, so we call the old versions
705 // here so that existing custom log classes still work; unfortunately this
706 // also means that we can't have the wxFAIL_MSG below in compat mode
707 DoLogString((const char*)szString.mb_str(), t);
708 DoLogString((const wchar_t*)szString.wc_str(), t);
709#else
a0516656 710 wxFAIL_MSG(wxS("DoLogString must be overriden if it's called."));
5a20d2ce
VS
711 wxUnusedVar(szString);
712 wxUnusedVar(t);
713#endif
c801d85f
KB
714}
715
716void wxLog::Flush()
717{
6f6b48f1 718 LogLastRepeatIfNeeded();
c801d85f
KB
719}
720
5a20d2ce 721/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
df5168c4
MB
722{
723 for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
724 en = ms_aTraceMasks.end();
725 it != en; ++it )
726 if ( *it == mask)
727 return true;
728 return false;
729}
730
d3fc1755
VZ
731// ----------------------------------------------------------------------------
732// wxLogBuffer implementation
733// ----------------------------------------------------------------------------
734
735void wxLogBuffer::Flush()
736{
a23bbe93
VZ
737 if ( !m_str.empty() )
738 {
739 wxMessageOutputBest out;
a0516656 740 out.Printf(wxS("%s"), m_str.c_str());
a23bbe93
VZ
741 m_str.clear();
742 }
d3fc1755
VZ
743}
744
5a20d2ce 745void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
83250f1a
VZ
746{
747 switch ( level )
748 {
749 case wxLOG_Trace:
750 case wxLOG_Debug:
751#ifdef __WXDEBUG__
752 // don't put debug messages in the buffer, we don't want to show
753 // them to the user in a msg box, log them immediately
754 {
755 wxString str;
756 TimeStamp(&str);
757 str += szString;
758
c4b401b6 759 wxMessageOutputDebug dbgout;
a0516656 760 dbgout.Printf(wxS("%s\n"), str.c_str());
83250f1a
VZ
761 }
762#endif // __WXDEBUG__
763 break;
764
765 default:
766 wxLog::DoLog(level, szString, t);
767 }
768}
769
5a20d2ce 770void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
d3fc1755 771{
a0516656 772 m_str << szString << wxS("\n");
d3fc1755
VZ
773}
774
c801d85f
KB
775// ----------------------------------------------------------------------------
776// wxLogStderr class implementation
777// ----------------------------------------------------------------------------
778
779wxLogStderr::wxLogStderr(FILE *fp)
780{
0fb67cd1
VZ
781 if ( fp == NULL )
782 m_fp = stderr;
783 else
784 m_fp = fp;
c801d85f
KB
785}
786
5a20d2ce 787void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
c801d85f 788{
d2e1ef19
VZ
789 wxString str;
790 TimeStamp(&str);
b568d04f 791 str << szString;
1e8a4bc2 792
14ff7a59 793 wxFputs(str, m_fp);
a0516656 794 wxFputc(wxS('\n'), m_fp);
0fb67cd1 795 fflush(m_fp);
1e8a4bc2 796
e2478fde
VZ
797 // under GUI systems such as Windows or Mac, programs usually don't have
798 // stderr at all, so show the messages also somewhere else, typically in
799 // the debugger window so that they go at least somewhere instead of being
800 // simply lost
1ec5cbf3
VZ
801 if ( m_fp == stderr )
802 {
e2478fde
VZ
803 wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
804 if ( traits && !traits->HasStderr() )
805 {
254a2129 806 wxMessageOutputDebug dbgout;
a0516656 807 dbgout.Printf(wxS("%s\n"), str.c_str());
e2478fde 808 }
03147cd0 809 }
c801d85f
KB
810}
811
812// ----------------------------------------------------------------------------
813// wxLogStream implementation
814// ----------------------------------------------------------------------------
815
4bf78aae 816#if wxUSE_STD_IOSTREAM
65f19af1 817#include "wx/ioswrap.h"
dd107c50 818wxLogStream::wxLogStream(wxSTD ostream *ostr)
c801d85f 819{
0fb67cd1 820 if ( ostr == NULL )
dd107c50 821 m_ostr = &wxSTD cerr;
0fb67cd1
VZ
822 else
823 m_ostr = ostr;
c801d85f
KB
824}
825
5a20d2ce 826void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
c801d85f 827{
5a20d2ce
VS
828 wxString stamp;
829 TimeStamp(&stamp);
830 (*m_ostr) << stamp << szString << wxSTD endl;
c801d85f 831}
0fb67cd1 832#endif // wxUSE_STD_IOSTREAM
c801d85f 833
03147cd0
VZ
834// ----------------------------------------------------------------------------
835// wxLogChain
836// ----------------------------------------------------------------------------
837
838wxLogChain::wxLogChain(wxLog *logger)
839{
f644b28c 840 m_bPassMessages = true;
71debe95 841
03147cd0
VZ
842 m_logNew = logger;
843 m_logOld = wxLog::SetActiveTarget(this);
844}
845
199e91fb
VZ
846wxLogChain::~wxLogChain()
847{
e95f8fde
VZ
848 delete m_logOld;
849
850 if ( m_logNew != this )
851 delete m_logNew;
199e91fb
VZ
852}
853
03147cd0
VZ
854void wxLogChain::SetLog(wxLog *logger)
855{
856 if ( m_logNew != this )
857 delete m_logNew;
858
03147cd0
VZ
859 m_logNew = logger;
860}
861
862void wxLogChain::Flush()
863{
864 if ( m_logOld )
865 m_logOld->Flush();
866
1ec5cbf3 867 // be careful to avoid infinite recursion
03147cd0
VZ
868 if ( m_logNew && m_logNew != this )
869 m_logNew->Flush();
870}
871
5a20d2ce 872void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
03147cd0
VZ
873{
874 // let the previous logger show it
875 if ( m_logOld && IsPassingMessages() )
876 {
877 // bogus cast just to access protected DoLog
878 ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
879 }
880
881 if ( m_logNew && m_logNew != this )
882 {
883 // as above...
884 ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
885 }
886}
887
93d4c1d0
VZ
888#ifdef __VISUALC__
889 // "'this' : used in base member initializer list" - so what?
890 #pragma warning(disable:4355)
891#endif // VC++
892
47fe7ff3
JS
893// ----------------------------------------------------------------------------
894// wxLogInterposer
895// ----------------------------------------------------------------------------
896
897wxLogInterposer::wxLogInterposer()
898 : wxLogChain(this)
899{
900}
901
902// ----------------------------------------------------------------------------
903// wxLogInterposerTemp
904// ----------------------------------------------------------------------------
905
906wxLogInterposerTemp::wxLogInterposerTemp()
93d4c1d0
VZ
907 : wxLogChain(this)
908{
47fe7ff3 909 DetachOldLog();
93d4c1d0
VZ
910}
911
912#ifdef __VISUALC__
913 #pragma warning(default:4355)
914#endif // VC++
915
c801d85f
KB
916// ============================================================================
917// Global functions/variables
918// ============================================================================
919
920// ----------------------------------------------------------------------------
921// static variables
922// ----------------------------------------------------------------------------
0fb67cd1 923
0250efd6
VZ
924#if wxUSE_THREADS
925wxCriticalSection wxLog::ms_prevCS;
926#endif // wxUSE_THREADS
f9837791
VZ
927bool wxLog::ms_bRepetCounting = false;
928wxString wxLog::ms_prevString;
374b4f1c 929unsigned int wxLog::ms_prevCounter = 0;
f9837791
VZ
930time_t wxLog::ms_prevTimeStamp= 0;
931wxLogLevel wxLog::ms_prevLevel;
932
0fb67cd1 933wxLog *wxLog::ms_pLogger = (wxLog *)NULL;
f644b28c
WS
934bool wxLog::ms_doLog = true;
935bool wxLog::ms_bAutoCreate = true;
936bool wxLog::ms_bVerbose = false;
d2e1ef19 937
edc73852
RD
938wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by default
939
2ed3265e
VZ
940size_t wxLog::ms_suspendCount = 0;
941
a0516656 942wxString wxLog::ms_timestamp(wxS("%X")); // time only, no date
d2e1ef19 943
0fb67cd1
VZ
944wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
945wxArrayString wxLog::ms_aTraceMasks;
c801d85f
KB
946
947// ----------------------------------------------------------------------------
948// stdout error logging helper
949// ----------------------------------------------------------------------------
950
951// helper function: wraps the message and justifies it under given position
952// (looks more pretty on the terminal). Also adds newline at the end.
953//
0fb67cd1
VZ
954// TODO this is now disabled until I find a portable way of determining the
955// terminal window size (ok, I found it but does anybody really cares?)
956#ifdef LOG_PRETTY_WRAP
c801d85f
KB
957static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
958{
0fb67cd1
VZ
959 size_t nMax = 80; // FIXME
960 size_t nStart = strlen(pszPrefix);
961 fputs(pszPrefix, f);
962
963 size_t n;
964 while ( *psz != '\0' ) {
965 for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
966 putc(*psz++, f);
967
968 // wrapped?
969 if ( *psz != '\0' ) {
970 /*putc('\n', f);*/
971 for ( n = 0; n < nStart; n++ )
972 putc(' ', f);
973
974 // as we wrapped, squeeze all white space
975 while ( isspace(*psz) )
976 psz++;
977 }
c801d85f 978 }
c801d85f 979
0fb67cd1 980 putc('\n', f);
c801d85f
KB
981}
982#endif //LOG_PRETTY_WRAP
983
984// ----------------------------------------------------------------------------
985// error code/error message retrieval functions
986// ----------------------------------------------------------------------------
987
988// get error code from syste
989unsigned long wxSysErrorCode()
990{
8cb172b4 991#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
0fb67cd1 992 return ::GetLastError();
0fb67cd1 993#else //Unix
c801d85f 994 return errno;
0fb67cd1 995#endif //Win/Unix
c801d85f
KB
996}
997
998// get error message from system
50920146 999const wxChar *wxSysErrorMsg(unsigned long nErrCode)
c801d85f 1000{
0fb67cd1
VZ
1001 if ( nErrCode == 0 )
1002 nErrCode = wxSysErrorCode();
1003
8cb172b4 1004#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
2e7f3845 1005 static wxChar s_szBuf[1024];
0fb67cd1
VZ
1006
1007 // get error message from system
1008 LPVOID lpMsgBuf;
d0822e56
VZ
1009 if ( ::FormatMessage
1010 (
1011 FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
1012 NULL,
1013 nErrCode,
0fb67cd1
VZ
1014 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
1015 (LPTSTR)&lpMsgBuf,
d0822e56
VZ
1016 0,
1017 NULL
1018 ) == 0 )
1019 {
1020 // if this happens, something is seriously wrong, so don't use _() here
1021 // for safety
a0516656 1022 wxSprintf(s_szBuf, wxS("unknown error %lx"), nErrCode);
c4b401b6 1023 return s_szBuf;
d0822e56
VZ
1024 }
1025
0fb67cd1
VZ
1026
1027 // copy it to our buffer and free memory
d0822e56 1028 // Crashes on SmartPhone (FIXME)
0c44ec97 1029#if !defined(__SMARTPHONE__) /* of WinCE */
7448de8d
WS
1030 if( lpMsgBuf != 0 )
1031 {
8c5b1f0f 1032 wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
a0516656 1033 s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxS('\0');
251244a0
VZ
1034
1035 LocalFree(lpMsgBuf);
1036
1037 // returned string is capitalized and ended with '\r\n' - bad
1038 s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
1039 size_t len = wxStrlen(s_szBuf);
1040 if ( len > 0 ) {
1041 // truncate string
a0516656
VZ
1042 if ( s_szBuf[len - 2] == wxS('\r') )
1043 s_szBuf[len - 2] = wxS('\0');
251244a0
VZ
1044 }
1045 }
a9928e9d 1046 else
2e7f3845 1047#endif // !__SMARTPHONE__
a9928e9d 1048 {
a0516656 1049 s_szBuf[0] = wxS('\0');
0fb67cd1
VZ
1050 }
1051
1052 return s_szBuf;
2e7f3845
VZ
1053#else // !__WXMSW__
1054 #if wxUSE_UNICODE
1055 static wchar_t s_wzBuf[1024];
1056 wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
1057 WXSIZEOF(s_wzBuf) - 1);
1058 return s_wzBuf;
1059 #else
1060 return strerror((int)nErrCode);
1061 #endif
1062#endif // __WXMSW__/!__WXMSW__
c801d85f
KB
1063}
1064
e2478fde 1065#endif // wxUSE_LOG