]> git.saurik.com Git - wxWidgets.git/blame - src/common/log.cpp
Fixed typos in comments (patch #1515724)
[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
VZ
39#include "wx/apptrait.h"
40#include "wx/file.h"
e2478fde
VZ
41#include "wx/msgout.h"
42#include "wx/textfile.h"
43#include "wx/thread.h"
e2478fde 44#include "wx/wxchar.h"
f94dfb38 45
c801d85f 46// other standard headers
1c193821 47#ifndef __WXWINCE__
e2478fde 48#include <errno.h>
1c193821
JS
49#endif
50
e2478fde 51#include <stdlib.h>
1c193821
JS
52
53#ifndef __WXWINCE__
e2478fde 54#include <time.h>
1c193821
JS
55#else
56#include "wx/msw/wince/time.h"
57#endif
31907d03 58
9cce3be7
VS
59#if defined(__WINDOWS__)
60 #include "wx/msw/private.h" // includes windows.h
61#endif
62
c801d85f
KB
63// ----------------------------------------------------------------------------
64// non member functions
65// ----------------------------------------------------------------------------
66
67// define this to enable wrapping of log messages
68//#define LOG_PRETTY_WRAP
69
9ef3052c 70#ifdef LOG_PRETTY_WRAP
c801d85f
KB
71 static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz);
72#endif
73
74// ============================================================================
75// implementation
76// ============================================================================
77
78// ----------------------------------------------------------------------------
b568d04f 79// globals
c801d85f
KB
80// ----------------------------------------------------------------------------
81
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)
85
b568d04f 86// static buffer for error messages
04662def
RL
87static wxChar s_szBufStatic[LOG_BUFFER_SIZE];
88
89static wxChar *s_szBuf = s_szBufStatic;
90static size_t s_szBufSize = WXSIZEOF( s_szBufStatic );
c801d85f 91
b568d04f
VZ
92#if wxUSE_THREADS
93
94// the critical section protecting the static buffer
95static wxCriticalSection gs_csLogBuf;
96
97#endif // wxUSE_THREADS
98
99// ----------------------------------------------------------------------------
100// implementation of Log functions
101//
102// NB: unfortunately we need all these distinct functions, we can't make them
103// macros and not all compilers inline vararg functions.
104// ----------------------------------------------------------------------------
105
ef0dd8e5 106// wrapper for wxVsnprintf(s_szBuf) which always NULL-terminates it
41f44cca 107static inline void PrintfInLogBuf(const wxChar *szFormat, va_list argptr)
ef0dd8e5
VZ
108{
109 if ( wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr) < 0 )
110 {
111 // must NUL-terminate it manually
112 s_szBuf[s_szBufSize - 1] = _T('\0');
113 }
114 //else: NUL-terminated by vsnprintf()
115}
116
c801d85f 117// generic log function
1d63fd6b 118void wxVLogGeneric(wxLogLevel level, const wxChar *szFormat, va_list argptr)
c801d85f 119{
d68d8590 120 if ( wxLog::IsEnabled() ) {
807a903e 121 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
9ef3052c 122
41f44cca 123 PrintfInLogBuf(szFormat, argptr);
807a903e
VZ
124
125 wxLog::OnLog(level, s_szBuf, time(NULL));
126 }
c801d85f
KB
127}
128
ea44a631
GD
129void wxLogGeneric(wxLogLevel level, const wxChar *szFormat, ...)
130{
131 va_list argptr;
132 va_start(argptr, szFormat);
1d63fd6b 133 wxVLogGeneric(level, szFormat, argptr);
ea44a631
GD
134 va_end(argptr);
135}
136
807a903e 137#define IMPLEMENT_LOG_FUNCTION(level) \
1d63fd6b 138 void wxVLog##level(const wxChar *szFormat, va_list argptr) \
807a903e 139 { \
d68d8590 140 if ( wxLog::IsEnabled() ) { \
807a903e
VZ
141 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
142 \
41f44cca 143 PrintfInLogBuf(szFormat, argptr); \
807a903e
VZ
144 \
145 wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
146 } \
ea44a631 147 } \
ef0dd8e5 148 \
ea44a631
GD
149 void wxLog##level(const wxChar *szFormat, ...) \
150 { \
151 va_list argptr; \
152 va_start(argptr, szFormat); \
1800689f 153 wxVLog##level(szFormat, argptr); \
ea44a631 154 va_end(argptr); \
c801d85f
KB
155 }
156
c801d85f
KB
157IMPLEMENT_LOG_FUNCTION(Error)
158IMPLEMENT_LOG_FUNCTION(Warning)
159IMPLEMENT_LOG_FUNCTION(Message)
160IMPLEMENT_LOG_FUNCTION(Info)
161IMPLEMENT_LOG_FUNCTION(Status)
162
c11d62a6
VZ
163void wxSafeShowMessage(const wxString& title, const wxString& text)
164{
165#ifdef __WINDOWS__
166 ::MessageBox(NULL, text, title, MB_OK | MB_ICONSTOP);
167#else
168 wxFprintf(stderr, _T("%s: %s\n"), title.c_str(), text.c_str());
65f06384 169 fflush(stderr);
c11d62a6
VZ
170#endif
171}
172
1800689f
VZ
173// fatal errors can't be suppressed nor handled by the custom log target and
174// always terminate the program
175void wxVLogFatalError(const wxChar *szFormat, va_list argptr)
176{
04662def 177 wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
1800689f 178
c11d62a6 179 wxSafeShowMessage(_T("Fatal Error"), s_szBuf);
1800689f 180
1c193821
JS
181#ifdef __WXWINCE__
182 ExitThread(3);
183#else
1800689f 184 abort();
1c193821 185#endif
1800689f
VZ
186}
187
188void wxLogFatalError(const wxChar *szFormat, ...)
189{
190 va_list argptr;
191 va_start(argptr, szFormat);
192 wxVLogFatalError(szFormat, argptr);
5e475383
VZ
193
194 // some compilers warn about unreachable code and it shouldn't matter
195 // for the others anyhow...
196 //va_end(argptr);
1800689f
VZ
197}
198
9ef3052c 199// same as info, but only if 'verbose' mode is on
1d63fd6b 200void wxVLogVerbose(const wxChar *szFormat, va_list argptr)
9ef3052c 201{
d68d8590 202 if ( wxLog::IsEnabled() ) {
2a1f999f 203 if ( wxLog::GetActiveTarget() != NULL && wxLog::GetVerbose() ) {
807a903e
VZ
204 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
205
04662def 206 wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
807a903e
VZ
207
208 wxLog::OnLog(wxLOG_Info, s_szBuf, time(NULL));
209 }
210 }
9ef3052c
VZ
211}
212
ea44a631
GD
213void wxLogVerbose(const wxChar *szFormat, ...)
214{
215 va_list argptr;
216 va_start(argptr, szFormat);
1d63fd6b 217 wxVLogVerbose(szFormat, argptr);
ea44a631
GD
218 va_end(argptr);
219}
220
9ef3052c 221// debug functions
b2aef89b 222#ifdef __WXDEBUG__
807a903e 223#define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
1d63fd6b 224 void wxVLog##level(const wxChar *szFormat, va_list argptr) \
807a903e 225 { \
d68d8590 226 if ( wxLog::IsEnabled() ) { \
807a903e
VZ
227 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf); \
228 \
04662def 229 wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr); \
807a903e
VZ
230 \
231 wxLog::OnLog(wxLOG_##level, s_szBuf, time(NULL)); \
232 } \
ea44a631
GD
233 } \
234 void wxLog##level(const wxChar *szFormat, ...) \
235 { \
236 va_list argptr; \
237 va_start(argptr, szFormat); \
1d63fd6b 238 wxVLog##level(szFormat, argptr); \
ea44a631 239 va_end(argptr); \
c801d85f
KB
240 }
241
1d63fd6b 242 void wxVLogTrace(const wxChar *mask, const wxChar *szFormat, va_list argptr)
0fb67cd1 243 {
d68d8590 244 if ( wxLog::IsEnabled() && wxLog::IsAllowedTraceMask(mask) ) {
b568d04f
VZ
245 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
246
00c4e897 247 wxChar *p = s_szBuf;
04662def 248 size_t len = s_szBufSize;
f6bcfd97 249 wxStrncpy(s_szBuf, _T("("), len);
829f0541
VZ
250 len -= 1; // strlen("(")
251 p += 1;
f6bcfd97 252 wxStrncat(p, mask, len);
00c4e897
VZ
253 size_t lenMask = wxStrlen(mask);
254 len -= lenMask;
255 p += lenMask;
256
f6bcfd97 257 wxStrncat(p, _T(") "), len);
829f0541
VZ
258 len -= 2;
259 p += 2;
00c4e897 260
00c4e897 261 wxVsnprintf(p, len, szFormat, argptr);
d91535c4 262
0fb67cd1
VZ
263 wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
264 }
265 }
266
ea44a631
GD
267 void wxLogTrace(const wxChar *mask, const wxChar *szFormat, ...)
268 {
269 va_list argptr;
270 va_start(argptr, szFormat);
1d63fd6b 271 wxVLogTrace(mask, szFormat, argptr);
ea44a631
GD
272 va_end(argptr);
273 }
274
1d63fd6b 275 void wxVLogTrace(wxTraceMask mask, const wxChar *szFormat, va_list argptr)
9ef3052c 276 {
9ef3052c
VZ
277 // we check that all of mask bits are set in the current mask, so
278 // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
279 // if both bits are set.
d68d8590 280 if ( wxLog::IsEnabled() && ((wxLog::GetTraceMask() & mask) == mask) ) {
b568d04f
VZ
281 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
282
04662def 283 wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
9ef3052c 284
0fb67cd1 285 wxLog::OnLog(wxLOG_Trace, s_szBuf, time(NULL));
9ef3052c
VZ
286 }
287 }
288
ea44a631
GD
289 void wxLogTrace(wxTraceMask mask, const wxChar *szFormat, ...)
290 {
291 va_list argptr;
292 va_start(argptr, szFormat);
1d63fd6b 293 wxVLogTrace(mask, szFormat, argptr);
ea44a631
GD
294 va_end(argptr);
295 }
296
9ef3052c
VZ
297#else // release
298 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
299#endif
300
301IMPLEMENT_LOG_DEBUG_FUNCTION(Debug)
302IMPLEMENT_LOG_DEBUG_FUNCTION(Trace)
303
304// wxLogSysError: one uses the last error code, for other you must give it
305// explicitly
306
307// common part of both wxLogSysError
308void wxLogSysErrorHelper(long lErrCode)
c801d85f 309{
50920146 310 wxChar szErrMsg[LOG_BUFFER_SIZE / 2];
378b05f7
VZ
311 wxSnprintf(szErrMsg, WXSIZEOF(szErrMsg),
312 _(" (error %ld: %s)"), lErrCode, wxSysErrorMsg(lErrCode));
04662def 313 wxStrncat(s_szBuf, szErrMsg, s_szBufSize - wxStrlen(s_szBuf));
c801d85f 314
0fb67cd1 315 wxLog::OnLog(wxLOG_Error, s_szBuf, time(NULL));
9ef3052c 316}
c801d85f 317
1d63fd6b 318void WXDLLEXPORT wxVLogSysError(const wxChar *szFormat, va_list argptr)
9ef3052c 319{
d68d8590 320 if ( wxLog::IsEnabled() ) {
807a903e 321 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
b568d04f 322
04662def 323 wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
9ef3052c 324
807a903e
VZ
325 wxLogSysErrorHelper(wxSysErrorCode());
326 }
c801d85f
KB
327}
328
ea44a631
GD
329void WXDLLEXPORT wxLogSysError(const wxChar *szFormat, ...)
330{
331 va_list argptr;
332 va_start(argptr, szFormat);
1d63fd6b 333 wxVLogSysError(szFormat, argptr);
ea44a631
GD
334 va_end(argptr);
335}
336
1d63fd6b 337void WXDLLEXPORT wxVLogSysError(long lErrCode, const wxChar *szFormat, va_list argptr)
c801d85f 338{
d68d8590 339 if ( wxLog::IsEnabled() ) {
807a903e 340 wxCRIT_SECT_LOCKER(locker, gs_csLogBuf);
b568d04f 341
04662def 342 wxVsnprintf(s_szBuf, s_szBufSize, szFormat, argptr);
c801d85f 343
807a903e
VZ
344 wxLogSysErrorHelper(lErrCode);
345 }
c801d85f
KB
346}
347
ea44a631
GD
348void WXDLLEXPORT wxLogSysError(long lErrCode, const wxChar *szFormat, ...)
349{
350 va_list argptr;
351 va_start(argptr, szFormat);
1d63fd6b 352 wxVLogSysError(lErrCode, szFormat, argptr);
ea44a631
GD
353 va_end(argptr);
354}
355
c801d85f
KB
356// ----------------------------------------------------------------------------
357// wxLog class implementation
358// ----------------------------------------------------------------------------
359
d91535c4 360wxChar *wxLog::SetLogBuffer( wxChar *buf, size_t size)
04662def
RL
361{
362 wxChar *oldbuf = s_szBuf;
363
364 if( buf == 0 )
365 {
366 s_szBuf = s_szBufStatic;
367 s_szBufSize = WXSIZEOF( s_szBufStatic );
368 }
369 else
370 {
371 s_szBuf = buf;
372 s_szBufSize = size;
373 }
374
375 return (oldbuf == s_szBufStatic ) ? 0 : oldbuf;
376}
377
9ec05cc9
VZ
378wxLog *wxLog::GetActiveTarget()
379{
0fb67cd1
VZ
380 if ( ms_bAutoCreate && ms_pLogger == NULL ) {
381 // prevent infinite recursion if someone calls wxLogXXX() from
382 // wxApp::CreateLogTarget()
f644b28c 383 static bool s_bInGetActiveTarget = false;
0fb67cd1 384 if ( !s_bInGetActiveTarget ) {
f644b28c 385 s_bInGetActiveTarget = true;
0fb67cd1 386
0fb67cd1
VZ
387 // ask the application to create a log target for us
388 if ( wxTheApp != NULL )
dc6d5e38 389 ms_pLogger = wxTheApp->GetTraits()->CreateLogTarget();
0fb67cd1
VZ
390 else
391 ms_pLogger = new wxLogStderr;
0fb67cd1 392
f644b28c 393 s_bInGetActiveTarget = false;
0fb67cd1
VZ
394
395 // do nothing if it fails - what can we do?
396 }
275bf4c1 397 }
c801d85f 398
0fb67cd1 399 return ms_pLogger;
c801d85f
KB
400}
401
c085e333 402wxLog *wxLog::SetActiveTarget(wxLog *pLogger)
9ec05cc9 403{
0fb67cd1
VZ
404 if ( ms_pLogger != NULL ) {
405 // flush the old messages before changing because otherwise they might
406 // get lost later if this target is not restored
407 ms_pLogger->Flush();
408 }
c801d85f 409
0fb67cd1
VZ
410 wxLog *pOldLogger = ms_pLogger;
411 ms_pLogger = pLogger;
c085e333 412
0fb67cd1 413 return pOldLogger;
c801d85f
KB
414}
415
36bd6902
VZ
416void wxLog::DontCreateOnDemand()
417{
f644b28c 418 ms_bAutoCreate = false;
36bd6902
VZ
419
420 // this is usually called at the end of the program and we assume that it
421 // is *always* called at the end - so we free memory here to avoid false
422 // memory leak reports from wxWin memory tracking code
423 ClearTraceMasks();
424}
425
0fb67cd1 426void wxLog::RemoveTraceMask(const wxString& str)
c801d85f 427{
0fb67cd1
VZ
428 int index = ms_aTraceMasks.Index(str);
429 if ( index != wxNOT_FOUND )
dc6d5e38 430 ms_aTraceMasks.RemoveAt((size_t)index);
0fb67cd1 431}
c801d85f 432
36bd6902
VZ
433void wxLog::ClearTraceMasks()
434{
435 ms_aTraceMasks.Clear();
436}
437
d2e1ef19
VZ
438void wxLog::TimeStamp(wxString *str)
439{
440 if ( ms_timestamp )
441 {
442 wxChar buf[256];
443 time_t timeNow;
444 (void)time(&timeNow);
c49245f8 445 wxStrftime(buf, WXSIZEOF(buf), ms_timestamp, localtime(&timeNow));
d2e1ef19
VZ
446
447 str->Empty();
223d09f6 448 *str << buf << wxT(": ");
d2e1ef19
VZ
449 }
450}
451
50920146 452void wxLog::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
0fb67cd1 453{
0fb67cd1
VZ
454 switch ( level ) {
455 case wxLOG_FatalError:
786855a1 456 DoLogString(wxString(_("Fatal error: ")) + szString, t);
0fb67cd1
VZ
457 DoLogString(_("Program aborted."), t);
458 Flush();
1c193821
JS
459#ifdef __WXWINCE__
460 ExitThread(3);
461#else
0fb67cd1 462 abort();
1c193821 463#endif
0fb67cd1
VZ
464 break;
465
466 case wxLOG_Error:
786855a1 467 DoLogString(wxString(_("Error: ")) + szString, t);
0fb67cd1
VZ
468 break;
469
470 case wxLOG_Warning:
786855a1 471 DoLogString(wxString(_("Warning: ")) + szString, t);
0fb67cd1
VZ
472 break;
473
474 case wxLOG_Info:
0fb67cd1 475 if ( GetVerbose() )
37278984 476 case wxLOG_Message:
87a1e308 477 case wxLOG_Status:
786855a1
VZ
478 default: // log unknown log levels too
479 DoLogString(szString, t);
0fb67cd1
VZ
480 break;
481
482 case wxLOG_Trace:
483 case wxLOG_Debug:
484#ifdef __WXDEBUG__
0131687b
VZ
485 {
486 wxString msg = level == wxLOG_Trace ? wxT("Trace: ")
54a8f42b 487 : wxT("Debug: ");
0131687b
VZ
488 msg << szString;
489 DoLogString(msg, t);
490 }
491#endif // Debug
0fb67cd1 492 break;
0fb67cd1 493 }
c801d85f
KB
494}
495
74e3313b 496void wxLog::DoLogString(const wxChar *WXUNUSED(szString), time_t WXUNUSED(t))
c801d85f 497{
223d09f6 498 wxFAIL_MSG(wxT("DoLogString must be overriden if it's called."));
c801d85f
KB
499}
500
501void wxLog::Flush()
502{
1ec5cbf3 503 // nothing to do here
c801d85f
KB
504}
505
df5168c4
MB
506/*static*/ bool wxLog::IsAllowedTraceMask(const wxChar *mask)
507{
508 for ( wxArrayString::iterator it = ms_aTraceMasks.begin(),
509 en = ms_aTraceMasks.end();
510 it != en; ++it )
511 if ( *it == mask)
512 return true;
513 return false;
514}
515
d3fc1755
VZ
516// ----------------------------------------------------------------------------
517// wxLogBuffer implementation
518// ----------------------------------------------------------------------------
519
520void wxLogBuffer::Flush()
521{
a23bbe93
VZ
522 if ( !m_str.empty() )
523 {
524 wxMessageOutputBest out;
525 out.Printf(_T("%s"), m_str.c_str());
526 m_str.clear();
527 }
d3fc1755
VZ
528}
529
83250f1a
VZ
530void wxLogBuffer::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
531{
532 switch ( level )
533 {
534 case wxLOG_Trace:
535 case wxLOG_Debug:
536#ifdef __WXDEBUG__
537 // don't put debug messages in the buffer, we don't want to show
538 // them to the user in a msg box, log them immediately
539 {
540 wxString str;
541 TimeStamp(&str);
542 str += szString;
543
c4b401b6
WS
544 wxMessageOutputDebug dbgout;
545 dbgout.Printf(_T("%s\n"), str.c_str());
83250f1a
VZ
546 }
547#endif // __WXDEBUG__
548 break;
549
550 default:
551 wxLog::DoLog(level, szString, t);
552 }
553}
554
d3fc1755
VZ
555void wxLogBuffer::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
556{
557 m_str << szString << _T("\n");
558}
559
c801d85f
KB
560// ----------------------------------------------------------------------------
561// wxLogStderr class implementation
562// ----------------------------------------------------------------------------
563
564wxLogStderr::wxLogStderr(FILE *fp)
565{
0fb67cd1
VZ
566 if ( fp == NULL )
567 m_fp = stderr;
568 else
569 m_fp = fp;
c801d85f
KB
570}
571
74e3313b 572void wxLogStderr::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
c801d85f 573{
d2e1ef19
VZ
574 wxString str;
575 TimeStamp(&str);
b568d04f 576 str << szString;
1e8a4bc2 577
50920146 578 fputs(str.mb_str(), m_fp);
b568d04f 579 fputc(_T('\n'), m_fp);
0fb67cd1 580 fflush(m_fp);
1e8a4bc2 581
e2478fde
VZ
582 // under GUI systems such as Windows or Mac, programs usually don't have
583 // stderr at all, so show the messages also somewhere else, typically in
584 // the debugger window so that they go at least somewhere instead of being
585 // simply lost
1ec5cbf3
VZ
586 if ( m_fp == stderr )
587 {
e2478fde
VZ
588 wxAppTraits *traits = wxTheApp ? wxTheApp->GetTraits() : NULL;
589 if ( traits && !traits->HasStderr() )
590 {
254a2129 591 wxMessageOutputDebug dbgout;
30413fd0 592 dbgout.Printf(_T("%s\n"), str.c_str());
e2478fde 593 }
03147cd0 594 }
c801d85f
KB
595}
596
597// ----------------------------------------------------------------------------
598// wxLogStream implementation
599// ----------------------------------------------------------------------------
600
4bf78aae 601#if wxUSE_STD_IOSTREAM
65f19af1 602#include "wx/ioswrap.h"
dd107c50 603wxLogStream::wxLogStream(wxSTD ostream *ostr)
c801d85f 604{
0fb67cd1 605 if ( ostr == NULL )
dd107c50 606 m_ostr = &wxSTD cerr;
0fb67cd1
VZ
607 else
608 m_ostr = ostr;
c801d85f
KB
609}
610
74e3313b 611void wxLogStream::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
c801d85f 612{
29fd317b
VZ
613 wxString str;
614 TimeStamp(&str);
416f9764 615 (*m_ostr) << wxConvertWX2MB(str) << wxConvertWX2MB(szString) << wxSTD endl;
c801d85f 616}
0fb67cd1 617#endif // wxUSE_STD_IOSTREAM
c801d85f 618
03147cd0
VZ
619// ----------------------------------------------------------------------------
620// wxLogChain
621// ----------------------------------------------------------------------------
622
623wxLogChain::wxLogChain(wxLog *logger)
624{
f644b28c 625 m_bPassMessages = true;
71debe95 626
03147cd0
VZ
627 m_logNew = logger;
628 m_logOld = wxLog::SetActiveTarget(this);
629}
630
199e91fb
VZ
631wxLogChain::~wxLogChain()
632{
e95f8fde
VZ
633 delete m_logOld;
634
635 if ( m_logNew != this )
636 delete m_logNew;
199e91fb
VZ
637}
638
03147cd0
VZ
639void wxLogChain::SetLog(wxLog *logger)
640{
641 if ( m_logNew != this )
642 delete m_logNew;
643
03147cd0
VZ
644 m_logNew = logger;
645}
646
647void wxLogChain::Flush()
648{
649 if ( m_logOld )
650 m_logOld->Flush();
651
1ec5cbf3 652 // be careful to avoid infinite recursion
03147cd0
VZ
653 if ( m_logNew && m_logNew != this )
654 m_logNew->Flush();
655}
656
657void wxLogChain::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
658{
659 // let the previous logger show it
660 if ( m_logOld && IsPassingMessages() )
661 {
662 // bogus cast just to access protected DoLog
663 ((wxLogChain *)m_logOld)->DoLog(level, szString, t);
664 }
665
666 if ( m_logNew && m_logNew != this )
667 {
668 // as above...
669 ((wxLogChain *)m_logNew)->DoLog(level, szString, t);
670 }
671}
672
93d4c1d0
VZ
673// ----------------------------------------------------------------------------
674// wxLogPassThrough
675// ----------------------------------------------------------------------------
676
677#ifdef __VISUALC__
678 // "'this' : used in base member initializer list" - so what?
679 #pragma warning(disable:4355)
680#endif // VC++
681
682wxLogPassThrough::wxLogPassThrough()
683 : wxLogChain(this)
684{
685}
686
687#ifdef __VISUALC__
688 #pragma warning(default:4355)
689#endif // VC++
690
c801d85f
KB
691// ============================================================================
692// Global functions/variables
693// ============================================================================
694
695// ----------------------------------------------------------------------------
696// static variables
697// ----------------------------------------------------------------------------
0fb67cd1
VZ
698
699wxLog *wxLog::ms_pLogger = (wxLog *)NULL;
f644b28c
WS
700bool wxLog::ms_doLog = true;
701bool wxLog::ms_bAutoCreate = true;
702bool wxLog::ms_bVerbose = false;
d2e1ef19 703
edc73852
RD
704wxLogLevel wxLog::ms_logLevel = wxLOG_Max; // log everything by default
705
2ed3265e
VZ
706size_t wxLog::ms_suspendCount = 0;
707
e2478fde 708const wxChar *wxLog::ms_timestamp = wxT("%X"); // time only, no date
d2e1ef19 709
0fb67cd1
VZ
710wxTraceMask wxLog::ms_ulTraceMask = (wxTraceMask)0;
711wxArrayString wxLog::ms_aTraceMasks;
c801d85f
KB
712
713// ----------------------------------------------------------------------------
714// stdout error logging helper
715// ----------------------------------------------------------------------------
716
717// helper function: wraps the message and justifies it under given position
718// (looks more pretty on the terminal). Also adds newline at the end.
719//
0fb67cd1
VZ
720// TODO this is now disabled until I find a portable way of determining the
721// terminal window size (ok, I found it but does anybody really cares?)
722#ifdef LOG_PRETTY_WRAP
c801d85f
KB
723static void wxLogWrap(FILE *f, const char *pszPrefix, const char *psz)
724{
0fb67cd1
VZ
725 size_t nMax = 80; // FIXME
726 size_t nStart = strlen(pszPrefix);
727 fputs(pszPrefix, f);
728
729 size_t n;
730 while ( *psz != '\0' ) {
731 for ( n = nStart; (n < nMax) && (*psz != '\0'); n++ )
732 putc(*psz++, f);
733
734 // wrapped?
735 if ( *psz != '\0' ) {
736 /*putc('\n', f);*/
737 for ( n = 0; n < nStart; n++ )
738 putc(' ', f);
739
740 // as we wrapped, squeeze all white space
741 while ( isspace(*psz) )
742 psz++;
743 }
c801d85f 744 }
c801d85f 745
0fb67cd1 746 putc('\n', f);
c801d85f
KB
747}
748#endif //LOG_PRETTY_WRAP
749
750// ----------------------------------------------------------------------------
751// error code/error message retrieval functions
752// ----------------------------------------------------------------------------
753
754// get error code from syste
755unsigned long wxSysErrorCode()
756{
8cb172b4 757#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
0fb67cd1 758 return ::GetLastError();
0fb67cd1 759#else //Unix
c801d85f 760 return errno;
0fb67cd1 761#endif //Win/Unix
c801d85f
KB
762}
763
764// get error message from system
50920146 765const wxChar *wxSysErrorMsg(unsigned long nErrCode)
c801d85f 766{
0fb67cd1
VZ
767 if ( nErrCode == 0 )
768 nErrCode = wxSysErrorCode();
769
8cb172b4 770#if defined(__WXMSW__) && !defined(__WXMICROWIN__)
50920146 771 static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
0fb67cd1
VZ
772
773 // get error message from system
774 LPVOID lpMsgBuf;
d0822e56
VZ
775 if ( ::FormatMessage
776 (
777 FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM,
778 NULL,
779 nErrCode,
0fb67cd1
VZ
780 MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT),
781 (LPTSTR)&lpMsgBuf,
d0822e56
VZ
782 0,
783 NULL
784 ) == 0 )
785 {
786 // if this happens, something is seriously wrong, so don't use _() here
787 // for safety
788 wxSprintf(s_szBuf, _T("unknown error %lx"), nErrCode);
c4b401b6 789 return s_szBuf;
d0822e56
VZ
790 }
791
0fb67cd1
VZ
792
793 // copy it to our buffer and free memory
d0822e56 794 // Crashes on SmartPhone (FIXME)
0c44ec97 795#if !defined(__SMARTPHONE__) /* of WinCE */
7448de8d
WS
796 if( lpMsgBuf != 0 )
797 {
8c5b1f0f 798 wxStrncpy(s_szBuf, (const wxChar *)lpMsgBuf, WXSIZEOF(s_szBuf) - 1);
251244a0
VZ
799 s_szBuf[WXSIZEOF(s_szBuf) - 1] = wxT('\0');
800
801 LocalFree(lpMsgBuf);
802
803 // returned string is capitalized and ended with '\r\n' - bad
804 s_szBuf[0] = (wxChar)wxTolower(s_szBuf[0]);
805 size_t len = wxStrlen(s_szBuf);
806 if ( len > 0 ) {
807 // truncate string
808 if ( s_szBuf[len - 2] == wxT('\r') )
809 s_szBuf[len - 2] = wxT('\0');
810 }
811 }
a9928e9d
JS
812 else
813#endif
814 {
8c5b1f0f 815 s_szBuf[0] = wxT('\0');
0fb67cd1
VZ
816 }
817
818 return s_szBuf;
3a5bcc4d 819#else // Unix-WXMICROWIN
50920146
OK
820#if wxUSE_UNICODE
821 static wxChar s_szBuf[LOG_BUFFER_SIZE / 2];
dcf924a3 822 wxConvCurrent->MB2WC(s_szBuf, strerror(nErrCode), WXSIZEOF(s_szBuf) -1);
50920146
OK
823 return s_szBuf;
824#else
13111b2a 825 return strerror((int)nErrCode);
50920146 826#endif
3a5bcc4d 827#endif // Win/Unix-WXMICROWIN
c801d85f
KB
828}
829
e2478fde 830#endif // wxUSE_LOG