]> git.saurik.com Git - wxWidgets.git/blame - src/common/log.cpp
add wxSYS_DCLICK_TIME system metric constant; use it for the generic list control...
[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
VZ
161#else
162 wxFprintf(stderr, _T("%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{
81727065 171 wxSafeShowMessage(_T("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;
81727065 282 msg << _T("(") << mask << _T(") ") << 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
81727065 388void WXDLLEXPORT wxVLogSysError(const wxString& format, va_list argptr)
9ef3052c 389{
81727065 390 wxVLogSysError(wxSysErrorCode(), format, argptr);
c801d85f
KB
391}
392
d1f6e2cf
VS
393#if !wxUSE_UTF8_LOCALE_ONLY
394void WXDLLEXPORT 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
404void WXDLLEXPORT wxDoLogSysErrorUtf8(const char *format, ...)
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
81727065 413void WXDLLEXPORT 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
VS
422#if !wxUSE_UTF8_LOCALE_ONLY
423void WXDLLEXPORT wxDoLogSysErrorWchar(long lErrCode, const wxChar *format, ...)
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
433void WXDLLEXPORT 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
59a14f69 444void WXDLLEXPORT 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
59a14f69 452void WXDLLEXPORT 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
f9837791
VZ
460/* static */
461unsigned wxLog::DoLogNumberOfRepeats()
462{
463 long retval = ms_prevCounter;
464 wxLog *pLogger = GetActiveTarget();
465 if ( pLogger && ms_prevCounter > 0 )
466 {
467 wxString msg;
459b97df 468#if wxUSE_INTL
f9837791
VZ
469 msg.Printf(wxPLURAL("The previous message repeated once.",
470 "The previous message repeated %lu times.",
471 ms_prevCounter),
472 ms_prevCounter);
459b97df
WS
473#else
474 msg.Printf(wxT("The previous message was repeated."));
475#endif
f9837791
VZ
476 ms_prevCounter = 0;
477 ms_prevString.clear();
5a20d2ce 478 pLogger->DoLog(ms_prevLevel, msg, ms_prevTimeStamp);
f9837791
VZ
479 }
480 return retval;
481}
482
483wxLog::~wxLog()
484{
485 if ( ms_prevCounter > 0 )
486 {
487 // looks like the repeat count has not been logged yet,
488 // so let's do it now
489 wxLog::DoLogNumberOfRepeats();
490 }
491}
492
493/* static */
5a20d2ce 494void wxLog::OnLog(wxLogLevel level, const wxString& szString, time_t t)
f9837791
VZ
495{
496 if ( IsEnabled() && ms_logLevel >= level )
497 {
498 wxLog *pLogger = GetActiveTarget();
499 if ( pLogger )
500 {
501 if ( GetRepetitionCounting() && ms_prevString == szString )
502 {
503 ms_prevCounter++;
504 }
505 else
506 {
507 if ( GetRepetitionCounting() )
508 {
61d8dec7 509 DoLogNumberOfRepeats();
f9837791
VZ
510 }
511 ms_prevString = szString;
512 ms_prevLevel = level;
513 ms_prevTimeStamp = t;
514 pLogger->DoLog(level, szString, t);
515 }
516 }
517 }
518}
519
2e7f3845 520// deprecated function
dcc40ba5
VZ
521#if WXWIN_COMPATIBILITY_2_6
522
2e7f3845 523wxChar *wxLog::SetLogBuffer(wxChar * WXUNUSED(buf), size_t WXUNUSED(size))
04662def 524{
2e7f3845 525 return NULL;
04662def
RL
526}
527
dcc40ba5
VZ
528#endif // WXWIN_COMPATIBILITY_2_6
529
5d88a6b5
VZ
530#if WXWIN_COMPATIBILITY_2_8
531
532void wxLog::DoLog(wxLogLevel WXUNUSED(level),
533 const char *WXUNUSED(szString),
534 time_t WXUNUSED(t))
535{
536}
537
538void wxLog::DoLog(wxLogLevel WXUNUSED(level),
539 const wchar_t *WXUNUSED(wzString),
540 time_t WXUNUSED(t))
541{
542}
543
544#endif // WXWIN_COMPATIBILITY_2_8
545
9ec05cc9
VZ
546wxLog *wxLog::GetActiveTarget()
547{
0fb67cd1
VZ
548 if ( ms_bAutoCreate && ms_pLogger == NULL ) {
549 // prevent infinite recursion if someone calls wxLogXXX() from
550 // wxApp::CreateLogTarget()
f644b28c 551 static bool s_bInGetActiveTarget = false;
0fb67cd1 552 if ( !s_bInGetActiveTarget ) {
f644b28c 553 s_bInGetActiveTarget = true;
0fb67cd1 554
0fb67cd1
VZ
555 // ask the application to create a log target for us
556 if ( wxTheApp != NULL )
dc6d5e38 557 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
0fb67cd1
VZ
558 else
559 ms_pLogger = new wxLogStderr;
0fb67cd1 560
f644b28c 561 s_bInGetActiveTarget = false;
0fb67cd1
VZ
562
563 // do nothing if it fails - what can we do?
564 }
275bf4c1 565 }
c801d85f 566
0fb67cd1 567 return ms_pLogger;
c801d85f
KB
568}
569
c085e333 570wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
9ec05cc9 571{
0fb67cd1
VZ
572 if ( ms_pLogger != NULL ) {
573 // flush the old messages before changing because otherwise they might
574 // get lost later if this target is not restored
575 ms_pLogger->Flush();
576 }
c801d85f 577
0fb67cd1
VZ
578 wxLog *pOldLogger = ms_pLogger;
579 ms_pLogger = pLogger;
c085e333 580
0fb67cd1 581 return pOldLogger;
c801d85f
KB
582}
583
36bd6902
VZ
584void wxLog::DontCreateOnDemand()
585{
f644b28c 586 ms_bAutoCreate = false;
36bd6902
VZ
587
588 // this is usually called at the end of the program and we assume that it
589 // is *always* called at the end - so we free memory here to avoid false
590 // memory leak reports from wxWin memory tracking code
591 ClearTraceMasks();
592}
593
e94cd97d
DE
594void wxLog::DoCreateOnDemand()
595{
596 ms_bAutoCreate = true;
597}
598
0fb67cd1 599void wxLog::RemoveTraceMask(const wxString& str)
c801d85f 600{
0fb67cd1
VZ
601 int index = ms_aTraceMasks.Index(str);
602 if ( index != wxNOT_FOUND )
dc6d5e38 603 ms_aTraceMasks.RemoveAt((size_t)index);
0fb67cd1 604}
c801d85f 605
36bd6902
VZ
606void wxLog::ClearTraceMasks()
607{
608 ms_aTraceMasks.Clear();
609}
610
d2e1ef19
VZ
611void wxLog::TimeStamp(wxString *str)
612{
7b2d1c74 613#if wxUSE_DATETIME
cb296f30 614 if ( !ms_timestamp.empty() )
d2e1ef19
VZ
615 {
616 wxChar buf[256];
617 time_t timeNow;
618 (void)time(&timeNow);
83e8b44c
VZ
619
620 struct tm tm;
621 wxStrftime(buf, WXSIZEOF(buf),
622 ms_timestamp, wxLocaltime_r(&timeNow, &tm));
d2e1ef19
VZ
623
624 str->Empty();
223d09f6 625 *str << buf << wxT(": ");
d2e1ef19 626 }
7b2d1c74 627#endif // wxUSE_DATETIME
d2e1ef19
VZ
628}
629
5a20d2ce 630void wxLog::DoLog(wxLogLevel level, const wxString& szString, time_t t)
0fb67cd1 631{
5a20d2ce
VS
632#if WXWIN_COMPATIBILITY_2_8
633 // DoLog() signature changed since 2.8, so we call the old versions here
634 // so that existing custom log classes still work:
635 DoLog(level, (const char*)szString.mb_str(), t);
636 DoLog(level, (const wchar_t*)szString.wc_str(), t);
637#endif
638
0fb67cd1
VZ
639 switch ( level ) {
640 case wxLOG_FatalError:
5a20d2ce
VS
641 LogString(_("Fatal error: ") + szString, t);
642 LogString(_("Program aborted."), t);
0fb67cd1 643 Flush();
1c193821
JS
644#ifdef __WXWINCE__
645 ExitThread(3);
646#else
0fb67cd1 647 abort();
1c193821 648#endif
0fb67cd1
VZ
649 break;
650
651 case wxLOG_Error:
5a20d2ce 652 LogString(_("Error: ") + szString, t);
0fb67cd1
VZ
653 break;
654
655 case wxLOG_Warning:
5a20d2ce 656 LogString(_("Warning: ") + szString, t);
0fb67cd1
VZ
657 break;
658
659 case wxLOG_Info:
0fb67cd1 660 if ( GetVerbose() )
37278984 661 case wxLOG_Message:
87a1e308 662 case wxLOG_Status:
786855a1 663 default: // log unknown log levels too
5a20d2ce 664 LogString(szString, t);
0fb67cd1
VZ
665 break;
666
667 case wxLOG_Trace:
668 case wxLOG_Debug:
669#ifdef __WXDEBUG__
0131687b
VZ
670 {
671 wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
54a8f42b 672 : wxT("Debug: ");
0131687b 673 msg << szString;
5a20d2ce 674 LogString(msg, t);
0131687b
VZ
675 }
676#endif // Debug
0fb67cd1 677 break;
0fb67cd1 678 }
c801d85f
KB
679}
680
5a20d2ce 681void wxLog::DoLogString(const wxString& szString, time_t t)
c801d85f 682{
5a20d2ce
VS
683#if WXWIN_COMPATIBILITY_2_8
684 // DoLogString() signature changed since 2.8, so we call the old versions
685 // here so that existing custom log classes still work; unfortunately this
686 // also means that we can't have the wxFAIL_MSG below in compat mode
687 DoLogString((const char*)szString.mb_str(), t);
688 DoLogString((const wchar_t*)szString.wc_str(), t);
689#else
223d09f6 690 wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
5a20d2ce
VS
691 wxUnusedVar(szString);
692 wxUnusedVar(t);
693#endif
c801d85f
KB
694}
695
696void wxLog::Flush()
697{
1ec5cbf3 698 // nothing to do here
c801d85f
KB
699}
700
5a20d2ce 701/*static*/ bool wxLog::IsAllowedTraceMask(const wxString& mask)
df5168c4
MB
702{
703 for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
704 en = ms_aTraceMasks.end();
705 it != en; ++it )
706 if ( *it == mask)
707 return true;
708 return false;
709}
710
d3fc1755
VZ
711// ----------------------------------------------------------------------------
712// wxLogBuffer implementation
713// ----------------------------------------------------------------------------
714
715void wxLogBuffer::Flush()
716{
a23bbe93
VZ
717 if ( !m_str.empty() )
718 {
719 wxMessageOutputBest out;
720 out.Printf(_T("%s"), m_str.c_str());
721 m_str.clear();
722 }
d3fc1755
VZ
723}
724
5a20d2ce 725void wxLogBuffer::DoLog(wxLogLevel level, const wxString& szString, time_t t)
83250f1a
VZ
726{
727 switch ( level )
728 {
729 case wxLOG_Trace:
730 case wxLOG_Debug:
731#ifdef __WXDEBUG__
732 // don't put debug messages in the buffer, we don't want to show
733 // them to the user in a msg box, log them immediately
734 {
735 wxString str;
736 TimeStamp(&str);
737 str += szString;
738
c4b401b6
WS
739 wxMessageOutputDebug dbgout;
740 dbgout.Printf(_T("%s\n"), str.c_str());
83250f1a
VZ
741 }
742#endif // __WXDEBUG__
743 break;
744
745 default:
746 wxLog::DoLog(level, szString, t);
747 }
748}
749
5a20d2ce 750void wxLogBuffer::DoLogString(const wxString& szString, time_t WXUNUSED(t))
d3fc1755
VZ
751{
752 m_str << szString << _T("\n");
753}
754
c801d85f
KB
755// ----------------------------------------------------------------------------
756// wxLogStderr class implementation
757// ----------------------------------------------------------------------------
758
759wxLogStderr::wxLogStderr(FILE *fp)
760{
0fb67cd1
VZ
761 if ( fp == NULL )
762 m_fp = stderr;
763 else
764 m_fp = fp;
c801d85f
KB
765}
766
5a20d2ce 767void wxLogStderr::DoLogString(const wxString& szString, time_t WXUNUSED(t))
c801d85f 768{
d2e1ef19
VZ
769 wxString str;
770 TimeStamp(&str);
b568d04f 771 str << szString;
1e8a4bc2 772
14ff7a59
VZ
773 wxFputs(str, m_fp);
774 wxFputc(_T('\n'), m_fp);
0fb67cd1 775 fflush(m_fp);
1e8a4bc2 776
e2478fde
VZ
777 // under GUI systems such as Windows or Mac, programs usually don't have
778 // stderr at all, so show the messages also somewhere else, typically in
779 // the debugger window so that they go at least somewhere instead of being
780 // simply lost
1ec5cbf3
VZ
781 if ( m_fp == stderr )
782 {
e2478fde
VZ
783 wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
784 if ( traits && !traits->HasStderr() )
785 {
254a2129 786 wxMessageOutputDebug dbgout;
30413fd0 787 dbgout.Printf(_T("%s\n"), str.c_str());
e2478fde 788 }
03147cd0 789 }
c801d85f
KB
790}
791
792// ----------------------------------------------------------------------------
793// wxLogStream implementation
794// ----------------------------------------------------------------------------
795
4bf78aae 796#if wxUSE_STD_IOSTREAM
65f19af1 797#include "wx/ioswrap.h"
dd107c50 798wxLogStream::wxLogStream(wxSTD ostream *ostr)
c801d85f 799{
0fb67cd1 800 if ( ostr == NULL )
dd107c50 801 m_ostr = &wxSTD cerr;
0fb67cd1
VZ
802 else
803 m_ostr = ostr;
c801d85f
KB
804}
805
5a20d2ce 806void wxLogStream::DoLogString(const wxString& szString, time_t WXUNUSED(t))
c801d85f 807{
5a20d2ce
VS
808 wxString stamp;
809 TimeStamp(&stamp);
810 (*m_ostr) << stamp << szString << wxSTD endl;
c801d85f 811}
0fb67cd1 812#endif // wxUSE_STD_IOSTREAM
c801d85f 813
03147cd0
VZ
814// ----------------------------------------------------------------------------
815// wxLogChain
816// ----------------------------------------------------------------------------
817
818wxLogChain::wxLogChain(wxLog *logger)
819{
f644b28c 820 m_bPassMessages = true;
71debe95 821
03147cd0
VZ
822 m_logNew = logger;
823 m_logOld = wxLog::SetActiveTarget(this);
824}
825
199e91fb
VZ
826wxLogChain::~wxLogChain()
827{
e95f8fde
VZ
828 delete m_logOld;
829
830 if ( m_logNew != this )
831 delete m_logNew;
199e91fb
VZ
832}
833
03147cd0
VZ
834void wxLogChain::SetLog(wxLog *logger)
835{
836 if ( m_logNew != this )
837 delete m_logNew;
838
03147cd0
VZ
839 m_logNew = logger;
840}
841
842void wxLogChain::Flush()
843{
844 if ( m_logOld )
845 m_logOld->Flush();
846
1ec5cbf3 847 // be careful to avoid infinite recursion
03147cd0
VZ
848 if ( m_logNew && m_logNew != this )
849 m_logNew->Flush();
850}
851
5a20d2ce 852void wxLogChain::DoLog(wxLogLevel level, const wxString& szString, time_t t)
03147cd0
VZ
853{
854 // let the previous logger show it
855 if ( m_logOld && IsPassingMessages() )
856 {
857 // bogus cast just to access protected DoLog
858 ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
859 }
860
861 if ( m_logNew && m_logNew != this )
862 {
863 // as above...
864 ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
865 }
866}
867
93d4c1d0
VZ
868#ifdef __VISUALC__
869 // "'this' : used in base member initializer list" - so what?
870 #pragma warning(disable:4355)
871#endif // VC++
872
47fe7ff3
JS
873// ----------------------------------------------------------------------------
874// wxLogInterposer
875// ----------------------------------------------------------------------------
876
877wxLogInterposer::wxLogInterposer()
878 : wxLogChain(this)
879{
880}
881
882// ----------------------------------------------------------------------------
883// wxLogInterposerTemp
884// ----------------------------------------------------------------------------
885
886wxLogInterposerTemp::wxLogInterposerTemp()
93d4c1d0
VZ
887 : wxLogChain(this)
888{
47fe7ff3 889 DetachOldLog();
93d4c1d0
VZ
890}
891
892#ifdef __VISUALC__
893 #pragma warning(default:4355)
894#endif // VC++
895
c801d85f
KB
896// ============================================================================
897// Global functions/variables
898// ============================================================================
899
900// ----------------------------------------------------------------------------
901// static variables
902// ----------------------------------------------------------------------------
0fb67cd1 903
f9837791
VZ
904bool wxLog::ms_bRepetCounting = false;
905wxString wxLog::ms_prevString;
374b4f1c 906unsigned int wxLog::ms_prevCounter = 0;
f9837791
VZ
907time_t wxLog::ms_prevTimeStamp= 0;
908wxLogLevel wxLog::ms_prevLevel;
909
0fb67cd1 910wxLog *wxLog::ms_pLogger = (wxLog *)NULL;
f644b28c
WS
911bool wxLog::ms_doLog = true;
912bool wxLog::ms_bAutoCreate = true;
913bool wxLog::ms_bVerbose = false;
d2e1ef19 914
edc73852
RD
915wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by default
916
2ed3265e
VZ
917size_t wxLog::ms_suspendCount = 0;
918
d993e05b 919wxString wxLog::ms_timestamp(wxT("%X")); // time only, no date
d2e1ef19 920
0fb67cd1
VZ
921wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
922wxArrayString wxLog::ms_aTraceMasks;
c801d85f
KB
923
924// ----------------------------------------------------------------------------
925// stdout error logging helper
926// ----------------------------------------------------------------------------
927
928// helper function: wraps the message and justifies it under given position
929// (looks more pretty on the terminal). Also adds newline at the end.
930//
0fb67cd1
VZ
931// TODO this is now disabled until I find a portable way of determining the
932// terminal window size (ok, I found it but does anybody really cares?)
933#ifdef LOG_PRETTY_WRAP
c801d85f
KB
934static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
935{
0fb67cd1
VZ
936 size_t nMax = 80; // FIXME
937 size_t nStart = strlen(pszPrefix);
938 fputs(pszPrefix, f);
939
940 size_t n;
941 while ( *psz != '\0' ) {
942 for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
943 putc(*psz++, f);
944
945 // wrapped?
946 if ( *psz != '\0' ) {
947 /*putc('\n', f);*/
948 for ( n = 0; n < nStart; n++ )
949 putc(' ', f);
950
951 // as we wrapped, squeeze all white space
952 while ( isspace(*psz) )
953 psz++;
954 }
c801d85f 955 }
c801d85f 956
0fb67cd1 957 putc('\n', f);
c801d85f
KB
958}
959#endif //LOG_PRETTY_WRAP
960
961// ----------------------------------------------------------------------------
962// error code/error message retrieval functions
963// ----------------------------------------------------------------------------
964
965// get error code from syste
966unsigned long wxSysErrorCode()
967{
8cb172b4 968#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
0fb67cd1 969 return ::GetLastError();
0fb67cd1 970#else //Unix
c801d85f 971 return errno;
0fb67cd1 972#endif //Win/Unix
c801d85f
KB
973}
974
975// get error message from system
50920146 976const wxChar *wxSysErrorMsg(unsigned long nErrCode)
c801d85f 977{
0fb67cd1
VZ
978 if ( nErrCode == 0 )
979 nErrCode = wxSysErrorCode();
980
8cb172b4 981#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
2e7f3845 982 static wxChar s_szBuf[1024];
0fb67cd1
VZ
983
984 // get error message from system
985 LPVOID lpMsgBuf;
d0822e56
VZ
986 if ( ::FormatMessage
987 (
988 FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
989 NULL,
990 nErrCode,
0fb67cd1
VZ
991 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
992 (LPTSTR)&lpMsgBuf,
d0822e56
VZ
993 0,
994 NULL
995 ) == 0 )
996 {
997 // if this happens, something is seriously wrong, so don't use _() here
998 // for safety
999 wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode);
c4b401b6 1000 return s_szBuf;
d0822e56
VZ
1001 }
1002
0fb67cd1
VZ
1003
1004 // copy it to our buffer and free memory
d0822e56 1005 // Crashes on SmartPhone (FIXME)
0c44ec97 1006#if !defined(__SMARTPHONE__) /* of WinCE */
7448de8d
WS
1007 if( lpMsgBuf != 0 )
1008 {
8c5b1f0f 1009 wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
251244a0
VZ
1010 s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
1011
1012 LocalFree(lpMsgBuf);
1013
1014 // returned string is capitalized and ended with '\r\n' - bad
1015 s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
1016 size_t len = wxStrlen(s_szBuf);
1017 if ( len > 0 ) {
1018 // truncate string
1019 if ( s_szBuf[len - 2] == wxT('\r') )
1020 s_szBuf[len - 2] = wxT('\0');
1021 }
1022 }
a9928e9d 1023 else
2e7f3845 1024#endif // !__SMARTPHONE__
a9928e9d 1025 {
8c5b1f0f 1026 s_szBuf[0] = wxT('\0');
0fb67cd1
VZ
1027 }
1028
1029 return s_szBuf;
2e7f3845
VZ
1030#else // !__WXMSW__
1031 #if wxUSE_UNICODE
1032 static wchar_t s_wzBuf[1024];
1033 wxConvCurrent->MB2WC(s_wzBuf, strerror((int)nErrCode),
1034 WXSIZEOF(s_wzBuf) - 1);
1035 return s_wzBuf;
1036 #else
1037 return strerror((int)nErrCode);
1038 #endif
1039#endif // __WXMSW__/!__WXMSW__
c801d85f
KB
1040}
1041
e2478fde 1042#endif // wxUSE_LOG