]> git.saurik.com Git - wxWidgets.git/blame - include/wx/log.h
blind fix for wxMac
[wxWidgets.git] / include / wx / log.h
CommitLineData
c801d85f 1/////////////////////////////////////////////////////////////////////////////
8ca28fb7 2// Name: wx/log.h
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
886dd7d2
VZ
12#ifndef _WX_LOG_H_
13#define _WX_LOG_H_
c801d85f 14
df5168c4 15#include "wx/defs.h"
38830220 16
0b4f47a3
DS
17// ----------------------------------------------------------------------------
18// common constants for use in wxUSE_LOG/!wxUSE_LOG
19// ----------------------------------------------------------------------------
20
21// the trace masks have been superceded by symbolic trace constants, they're
22// for compatibility only andwill be removed soon - do NOT use them
23
24// meaning of different bits of the trace mask (which allows selectively
25// enable/disable some trace messages)
26#define wxTraceMemAlloc 0x0001 // trace memory allocation (new/delete)
27#define wxTraceMessages 0x0002 // trace window messages/X callbacks
28#define wxTraceResAlloc 0x0004 // trace GDI resource allocation
29#define wxTraceRefCount 0x0008 // trace various ref counting operations
30
31#ifdef __WXMSW__
32 #define wxTraceOleCalls 0x0100 // OLE interface calls
33#endif
34
546db2a8
VZ
35// ----------------------------------------------------------------------------
36// types
37// ----------------------------------------------------------------------------
38
1782be31 39// NB: these types are needed even if wxUSE_LOG == 0
546db2a8
VZ
40typedef unsigned long wxTraceMask;
41typedef unsigned long wxLogLevel;
42
43// ----------------------------------------------------------------------------
44// headers
45// ----------------------------------------------------------------------------
46
b6e4e44a 47#include "wx/string.h"
c9f78968 48#include "wx/strvararg.h"
b6e4e44a 49
1782be31
VZ
50#if wxUSE_LOG
51
1782be31
VZ
52#include "wx/arrstr.h"
53
9b4da627 54#ifndef __WXPALMOS5__
0e0126c2 55#ifndef __WXWINCE__
1782be31 56 #include <time.h> // for time_t
0e0126c2 57#endif
9b4da627 58#endif // ! __WXPALMOS5__
c30aaf75
VZ
59
60#include "wx/dynarray.h"
d6b9496a 61
edc73852
RD
62#ifndef wxUSE_LOG_DEBUG
63# ifdef __WXDEBUG__
64# define wxUSE_LOG_DEBUG 1
65# else // !__WXDEBUG__
66# define wxUSE_LOG_DEBUG 0
67# endif
68#endif
69
1782be31
VZ
70// ----------------------------------------------------------------------------
71// forward declarations
72// ----------------------------------------------------------------------------
73
74#if wxUSE_GUI
b5dbe15d
VS
75 class WXDLLIMPEXP_FWD_CORE wxTextCtrl;
76 class WXDLLIMPEXP_FWD_CORE wxLogFrame;
77 class WXDLLIMPEXP_FWD_CORE wxFrame;
78 class WXDLLIMPEXP_FWD_CORE wxWindow;
1782be31
VZ
79#endif // wxUSE_GUI
80
9ef3052c
VZ
81// ----------------------------------------------------------------------------
82// constants
83// ----------------------------------------------------------------------------
84
85// different standard log levels (you may also define your own)
90adbcca 86enum wxLogLevelValues
9ef3052c 87{
d6b9496a
VZ
88 wxLOG_FatalError, // program can't continue, abort immediately
89 wxLOG_Error, // a serious error, user must be informed about it
90 wxLOG_Warning, // user is normally informed about it but may be ignored
91 wxLOG_Message, // normal message (i.e. normal output of a non GUI app)
d6b9496a 92 wxLOG_Status, // informational: might go to the status line of GUI app
edc73852 93 wxLOG_Info, // informational message (a.k.a. 'Verbose')
d6b9496a
VZ
94 wxLOG_Debug, // never shown to the user, disabled in release mode
95 wxLOG_Trace, // trace messages are also only enabled in debug mode
96 wxLOG_Progress, // used for progress indicator (not yet)
edc73852 97 wxLOG_User = 100, // user defined levels start here
65ca8c0b 98 wxLOG_Max = 10000
9ef3052c
VZ
99};
100
d6b9496a
VZ
101// symbolic trace masks - wxLogTrace("foo", "some trace message...") will be
102// discarded unless the string "foo" has been added to the list of allowed
103// ones with AddTraceMask()
104
08298395
OK
105#define wxTRACE_MemAlloc wxT("memalloc") // trace memory allocation (new/delete)
106#define wxTRACE_Messages wxT("messages") // trace window messages/X callbacks
107#define wxTRACE_ResAlloc wxT("resalloc") // trace GDI resource allocation
108#define wxTRACE_RefCount wxT("refcount") // trace various ref counting operations
d6b9496a
VZ
109
110#ifdef __WXMSW__
08298395 111 #define wxTRACE_OleCalls wxT("ole") // OLE interface calls
d6b9496a
VZ
112#endif
113
65f19af1 114#include "wx/iosfwrap.h"
470b7da3 115
c801d85f
KB
116// ----------------------------------------------------------------------------
117// derive from this class to redirect (or suppress, or ...) log messages
118// normally, only a single instance of this class exists but it's not enforced
c801d85f 119// ----------------------------------------------------------------------------
d6b9496a 120
bddd7a8d 121class WXDLLIMPEXP_BASE wxLog
c801d85f
KB
122{
123public:
d6b9496a 124 // ctor
6fb99eb3 125 wxLog(){}
d6b9496a
VZ
126
127 // these functions allow to completely disable all log messages
d1b20379
DS
128
129 // is logging disabled now?
d6b9496a 130 static bool IsEnabled() { return ms_doLog; }
d1b20379
DS
131
132 // change the flag state, return the previous one
133 static bool EnableLogging(bool doIt = true)
2e7f3845 134 { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
d6b9496a
VZ
135
136 // static sink function - see DoLog() for function to overload in the
137 // derived classes
5a20d2ce 138 static void OnLog(wxLogLevel level, const wxString& szString, time_t t);
d6b9496a
VZ
139
140 // message buffering
d1b20379
DS
141
142 // flush shows all messages if they're not logged immediately (FILE
143 // and iostream logs don't need it, but wxGuiLog does to avoid showing
144 // 17 modal dialogs one after another)
d6b9496a 145 virtual void Flush();
d6b9496a 146
d1b20379 147 // flush the active target if any
bbfa0322
VZ
148 static void FlushActive()
149 {
2ed3265e
VZ
150 if ( !ms_suspendCount )
151 {
152 wxLog *log = GetActiveTarget();
1ec5cbf3 153 if ( log )
2ed3265e
VZ
154 log->Flush();
155 }
bbfa0322 156 }
1ec5cbf3
VZ
157
158 // only one sink is active at each moment
d1b20379
DS
159 // get current log target, will call wxApp::CreateLogTarget() to
160 // create one if none exists
d6b9496a 161 static wxLog *GetActiveTarget();
d1b20379
DS
162
163 // change log target, pLogger may be NULL
d6b9496a
VZ
164 static wxLog *SetActiveTarget(wxLog *pLogger);
165
d1b20379
DS
166 // suspend the message flushing of the main target until the next call
167 // to Resume() - this is mainly for internal use (to prevent wxYield()
168 // from flashing the messages)
2ed3265e 169 static void Suspend() { ms_suspendCount++; }
d1b20379
DS
170
171 // must be called for each Suspend()!
2ed3265e
VZ
172 static void Resume() { ms_suspendCount--; }
173
d6b9496a 174 // functions controlling the default wxLog behaviour
d1b20379
DS
175 // verbose mode is activated by standard command-line '-verbose'
176 // option
177 static void SetVerbose(bool bVerbose = true) { ms_bVerbose = bVerbose; }
edc73852 178
d1b20379 179 // Set log level. Log messages with level > logLevel will not be logged.
edc73852
RD
180 static void SetLogLevel(wxLogLevel logLevel) { ms_logLevel = logLevel; }
181
d1b20379
DS
182 // should GetActiveTarget() try to create a new log object if the
183 // current is NULL?
36bd6902 184 static void DontCreateOnDemand();
d6b9496a 185
e94cd97d
DE
186 // Make GetActiveTarget() create a new log object again.
187 static void DoCreateOnDemand();
188
f9837791
VZ
189 // log the count of repeating messages instead of logging the messages
190 // multiple times
191 static void SetRepetitionCounting(bool bRepetCounting = true)
2e7f3845 192 { ms_bRepetCounting = bRepetCounting; }
f9837791
VZ
193
194 // gets duplicate counting status
195 static bool GetRepetitionCounting() { return ms_bRepetCounting; }
196
d1b20379 197 // trace mask (see wxTraceXXX constants for details)
d6b9496a 198 static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
d1b20379
DS
199
200 // add string trace mask
f96233d5 201 static void AddTraceMask(const wxString& str);
d1b20379
DS
202
203 // add string trace mask
d6b9496a 204 static void RemoveTraceMask(const wxString& str);
d1b20379
DS
205
206 // remove all string trace masks
36bd6902 207 static void ClearTraceMasks();
d1b20379 208
f96233d5
VZ
209 // get string trace masks: note that this is MT-unsafe if other threads can
210 // call AddTraceMask() concurrently
211 static const wxArrayString& GetTraceMasks() { return ms_aTraceMasks; }
d6b9496a 212
7b1bf3ad
VZ
213 // sets the time stamp string format: this is used as strftime() format
214 // string for the log targets which add time stamps to the messages; set
215 // it to empty string to disable time stamping completely.
d993e05b 216 static void SetTimestamp(const wxString& ts) { ms_timestamp = ts; }
d2e1ef19 217
7b1bf3ad
VZ
218 // disable time stamping of log messages
219 static void DisableTimestamp() { SetTimestamp(wxEmptyString); }
220
edc73852 221
d6b9496a 222 // accessors
d1b20379
DS
223
224 // gets the verbose status
fd7718b2 225 static bool GetVerbose() { return ms_bVerbose; }
d1b20379
DS
226
227 // get trace mask
d6b9496a 228 static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
d1b20379
DS
229
230 // is this trace mask in the list?
5a20d2ce 231 static bool IsAllowedTraceMask(const wxString& mask);
d1b20379
DS
232
233 // return the current loglevel limit
edc73852 234 static wxLogLevel GetLogLevel() { return ms_logLevel; }
d6b9496a 235
d1b20379 236 // get the current timestamp format string (may be NULL)
d993e05b 237 static const wxString& GetTimestamp() { return ms_timestamp; }
d2e1ef19 238
edc73852 239
d2e1ef19 240 // helpers
d1b20379
DS
241
242 // put the time stamp into the string if ms_timestamp != NULL (don't
243 // change it otherwise)
d2e1ef19
VZ
244 static void TimeStamp(wxString *str);
245
d6b9496a 246 // make dtor virtual for all derived classes
f9837791 247 virtual ~wxLog();
c801d85f 248
c801d85f 249
1ec5cbf3 250 // this method exists for backwards compatibility only, don't use
d1b20379 251 bool HasPendingMessages() const { return true; }
1ec5cbf3 252
2e7f3845
VZ
253#if WXWIN_COMPATIBILITY_2_6
254 // this function doesn't do anything any more, don't call it
255 wxDEPRECATED( static wxChar *SetLogBuffer(wxChar *buf, size_t size = 0) );
256#endif
257
1ec5cbf3 258protected:
d6b9496a 259 // the logging functions that can be overriden
d1b20379
DS
260
261 // default DoLog() prepends the time stamp and a prefix corresponding
262 // to the message to szString and then passes it to DoLogString()
5a20d2ce
VS
263 virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
264#if WXWIN_COMPATIBILITY_2_8
265 // these shouldn't be used by new code
5d88a6b5
VZ
266 wxDEPRECATED_BUT_USED_INTERNALLY(
267 virtual void DoLog(wxLogLevel level, const char *szString, time_t t)
268 );
269
270 wxDEPRECATED_BUT_USED_INTERNALLY(
271 virtual void DoLog(wxLogLevel level, const wchar_t *wzString, time_t t)
272 );
273#endif // WXWIN_COMPATIBILITY_2_8
5a20d2ce
VS
274
275 void LogString(const wxString& szString, time_t t)
276 { DoLogString(szString, t); }
d1b20379
DS
277
278 // default DoLogString does nothing but is not pure virtual because if
279 // you override DoLog() you might not need it at all
5a20d2ce
VS
280 virtual void DoLogString(const wxString& szString, time_t t);
281#if WXWIN_COMPATIBILITY_2_8
282 // these shouldn't be used by new code
283 virtual void DoLogString(const char *WXUNUSED(szString),
284 time_t WXUNUSED(t)) {}
285 virtual void DoLogString(const wchar_t *WXUNUSED(szString),
286 time_t WXUNUSED(t)) {}
b99891b0
VZ
287#endif // WXWIN_COMPATIBILITY_2_8
288
289 // this macro should be used in the derived classes to avoid warnings about
290 // hiding the other DoLog() overloads when overriding DoLog(wxString) --
291 // but don't use it with MSVC which doesn't give this warning but does give
292 // warning when a deprecated function is overridden
293#if WXWIN_COMPATIBILITY_2_8 && !defined(__VISUALC__)
294 #define wxSUPPRESS_DOLOG_HIDE_WARNING() \
295 virtual void DoLog(wxLogLevel, const char *, time_t) { } \
296 virtual void DoLog(wxLogLevel, const wchar_t *, time_t) { }
297
298 #define wxSUPPRESS_DOLOGSTRING_HIDE_WARNING() \
299 virtual void DoLogString(const char *, time_t) { } \
300 virtual void DoLogString(const wchar_t *, time_t) { }
301#else
302 #define wxSUPPRESS_DOLOG_HIDE_WARNING()
303 #define wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
5a20d2ce 304#endif
c801d85f 305
2064113c 306 // log a message indicating the number of times the previous message was
0250efd6
VZ
307 // repeated if ms_prevCounter > 0, does nothing otherwise; return the old
308 // value of ms_prevCounter
dbaa16de 309 unsigned LogLastRepeatIfNeeded();
f9837791 310
d6b9496a 311private:
dbaa16de
VZ
312 // implement of LogLastRepeatIfNeeded(): it assumes that the
313 // caller had already locked ms_prevCS
314 unsigned LogLastRepeatIfNeededUnlocked();
315
d6b9496a
VZ
316 // static variables
317 // ----------------
06db8ebd 318
2064113c
VZ
319 // if true, don't log the same message multiple times, only log it once
320 // with the number of times it was repeated
f9837791 321 static bool ms_bRepetCounting;
2064113c 322
f9837791 323 static wxString ms_prevString; // previous message that was logged
2064113c 324 static unsigned ms_prevCounter; // how many times it was repeated
f9837791
VZ
325 static time_t ms_prevTimeStamp;// timestamp of the previous message
326 static wxLogLevel ms_prevLevel; // level of the previous message
327
d6b9496a 328 static wxLog *ms_pLogger; // currently active log sink
d1b20379 329 static bool ms_doLog; // false => all logging disabled
d6b9496a 330 static bool ms_bAutoCreate; // create new log targets on demand?
d1b20379 331 static bool ms_bVerbose; // false => ignore LogInfo messages
fe7b1156 332
edc73852
RD
333 static wxLogLevel ms_logLevel; // limit logging to levels <= ms_logLevel
334
2ed3265e
VZ
335 static size_t ms_suspendCount; // if positive, logs are not flushed
336
d2e1ef19
VZ
337 // format string for strftime(), if NULL, time stamping log messages is
338 // disabled
d993e05b 339 static wxString ms_timestamp;
d2e1ef19 340
d6b9496a
VZ
341 static wxTraceMask ms_ulTraceMask; // controls wxLogTrace behaviour
342 static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
c801d85f
KB
343};
344
345// ----------------------------------------------------------------------------
346// "trivial" derivations of wxLog
347// ----------------------------------------------------------------------------
348
d3fc1755
VZ
349// log everything to a buffer
350class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
351{
352public:
353 wxLogBuffer() { }
354
355 // get the string contents with all messages logged
356 const wxString& GetBuffer() const { return m_str; }
357
358 // show the buffer contents to the user in the best possible way (this uses
359 // wxMessageOutputMessageBox) and clear it
360 virtual void Flush();
361
362protected:
5a20d2ce
VS
363 virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
364 virtual void DoLogString(const wxString& szString, time_t t);
d3fc1755 365
b99891b0
VZ
366 wxSUPPRESS_DOLOG_HIDE_WARNING()
367 wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
368
d3fc1755
VZ
369private:
370 wxString m_str;
371
372 DECLARE_NO_COPY_CLASS(wxLogBuffer)
373};
374
0f8218d7 375
c801d85f 376// log everything to a "FILE *", stderr by default
bddd7a8d 377class WXDLLIMPEXP_BASE wxLogStderr : public wxLog
c801d85f
KB
378{
379public:
d6b9496a 380 // redirect log output to a FILE
d3b9f782 381 wxLogStderr(FILE *fp = NULL);
c801d85f 382
03147cd0 383protected:
d6b9496a 384 // implement sink function
5a20d2ce 385 virtual void DoLogString(const wxString& szString, time_t t);
c801d85f 386
b99891b0
VZ
387 wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
388
d6b9496a 389 FILE *m_fp;
d3fc1755
VZ
390
391 DECLARE_NO_COPY_CLASS(wxLogStderr)
c801d85f
KB
392};
393
4bf78aae 394#if wxUSE_STD_IOSTREAM
03147cd0 395
c801d85f 396// log everything to an "ostream", cerr by default
bddd7a8d 397class WXDLLIMPEXP_BASE wxLogStream : public wxLog
c801d85f
KB
398{
399public:
d6b9496a 400 // redirect log output to an ostream
dd107c50 401 wxLogStream(wxSTD ostream *ostr = (wxSTD ostream *) NULL);
c801d85f
KB
402
403protected:
d6b9496a 404 // implement sink function
5a20d2ce 405 virtual void DoLogString(const wxString& szString, time_t t);
c801d85f 406
b99891b0
VZ
407 wxSUPPRESS_DOLOGSTRING_HIDE_WARNING()
408
d6b9496a 409 // using ptr here to avoid including <iostream.h> from this file
dd107c50 410 wxSTD ostream *m_ostr;
c801d85f 411};
03147cd0
VZ
412
413#endif // wxUSE_STD_IOSTREAM
c801d85f 414
03147cd0
VZ
415// ----------------------------------------------------------------------------
416// /dev/null log target: suppress logging until this object goes out of scope
417// ----------------------------------------------------------------------------
418
419// example of usage:
420/*
421 void Foo()
422 {
423 wxFile file;
424
425 // wxFile.Open() normally complains if file can't be opened, we don't
426 // want it
427 wxLogNull logNo;
428
429 if ( !file.Open("bar") )
430 ... process error ourselves ...
431
432 // ~wxLogNull called, old log sink restored
433 }
434 */
bddd7a8d 435class WXDLLIMPEXP_BASE wxLogNull
03147cd0
VZ
436{
437public:
d1b20379 438 wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }
be52b341 439 ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
03147cd0
VZ
440
441private:
442 bool m_flagOld; // the previous value of the wxLog::ms_doLog
443};
444
445// ----------------------------------------------------------------------------
446// chaining log target: installs itself as a log target and passes all
447// messages to the real log target given to it in the ctor but also forwards
448// them to the previously active one
449//
450// note that you don't have to call SetActiveTarget() with this class, it
451// does it itself in its ctor
452// ----------------------------------------------------------------------------
453
bddd7a8d 454class WXDLLIMPEXP_BASE wxLogChain : public wxLog
03147cd0
VZ
455{
456public:
457 wxLogChain(wxLog *logger);
8b30a4e4 458 virtual ~wxLogChain();
03147cd0
VZ
459
460 // change the new log target
461 void SetLog(wxLog *logger);
462
463 // this can be used to temporarily disable (and then reenable) passing
464 // messages to the old logger (by default we do pass them)
465 void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
466
467 // are we passing the messages to the previous log target?
468 bool IsPassingMessages() const { return m_bPassMessages; }
469
470 // return the previous log target (may be NULL)
471 wxLog *GetOldLog() const { return m_logOld; }
472
473 // override base class version to flush the old logger as well
474 virtual void Flush();
475
47fe7ff3
JS
476 // call to avoid destroying the old log target
477 void DetachOldLog() { m_logOld = NULL; }
478
03147cd0
VZ
479protected:
480 // pass the chain to the old logger if needed
5a20d2ce 481 virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t);
03147cd0 482
b99891b0
VZ
483 wxSUPPRESS_DOLOG_HIDE_WARNING()
484
03147cd0
VZ
485private:
486 // the current log target
487 wxLog *m_logNew;
488
489 // the previous log target
490 wxLog *m_logOld;
491
492 // do we pass the messages to the old logger?
493 bool m_bPassMessages;
22f3361e
VZ
494
495 DECLARE_NO_COPY_CLASS(wxLogChain)
03147cd0
VZ
496};
497
498// a chain log target which uses itself as the new logger
47fe7ff3
JS
499
500#define wxLogPassThrough wxLogInterposer
501
502class WXDLLIMPEXP_BASE wxLogInterposer : public wxLogChain
503{
504public:
505 wxLogInterposer();
506
507private:
508 DECLARE_NO_COPY_CLASS(wxLogInterposer)
509};
510
511// a temporary interposer which doesn't destroy the old log target
512// (calls DetachOldLog)
513
514class WXDLLIMPEXP_BASE wxLogInterposerTemp : public wxLogChain
03147cd0
VZ
515{
516public:
47fe7ff3 517 wxLogInterposerTemp();
fc7a2a60
VZ
518
519private:
47fe7ff3 520 DECLARE_NO_COPY_CLASS(wxLogInterposerTemp)
03147cd0
VZ
521};
522
8ca28fb7 523#if wxUSE_GUI
7e8c564c
VS
524 // include GUI log targets:
525 #include "wx/generic/logg.h"
e90c1d2a 526#endif // wxUSE_GUI
03f38c58 527
c801d85f
KB
528// ============================================================================
529// global functions
530// ============================================================================
531
532// ----------------------------------------------------------------------------
533// Log functions should be used by application instead of stdio, iostream &c
534// for log messages for easy redirection
535// ----------------------------------------------------------------------------
536
88ac883a
VZ
537// ----------------------------------------------------------------------------
538// get error code/error message from system in a portable way
539// ----------------------------------------------------------------------------
540
541// return the last system error code
bddd7a8d 542WXDLLIMPEXP_BASE unsigned long wxSysErrorCode();
c11d62a6 543
88ac883a 544// return the error message for given (or last if 0) error code
bddd7a8d 545WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
88ac883a 546
c11d62a6 547// ----------------------------------------------------------------------------
c801d85f 548// define wxLog<level>
c11d62a6 549// ----------------------------------------------------------------------------
c801d85f 550
2523e9b7 551#define DECLARE_LOG_FUNCTION(level) \
81727065 552 extern void WXDLLIMPEXP_BASE \
d1f6e2cf
VS
553 wxDoLog##level##Wchar(const wxChar *format, ...); \
554 extern void WXDLLIMPEXP_BASE \
555 wxDoLog##level##Utf8(const char *format, ...); \
2523e9b7 556 WX_DEFINE_VARARG_FUNC_VOID(wxLog##level, \
1528e0b8 557 1, (const wxFormatString&), \
d1f6e2cf 558 wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
2523e9b7
VS
559 DECLARE_LOG_FUNCTION_WATCOM(level) \
560 extern void WXDLLIMPEXP_BASE wxVLog##level(const wxString& format, \
561 va_list argptr)
562
563#ifdef __WATCOMC__
564 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
565 // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
566 // something too big for Borland C++ to handle
567 #define DECLARE_LOG_FUNCTION_WATCOM(level) \
59a14f69
VS
568 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
569 1, (const wxString&), \
570 (wxFormatString(f1))) \
571 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
572 1, (const wxCStrData&), \
573 (wxFormatString(f1))) \
574 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
d1f6e2cf 575 1, (const char*), \
59a14f69
VS
576 (wxFormatString(f1))) \
577 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
d1f6e2cf 578 1, (const wchar_t*), \
59a14f69 579 (wxFormatString(f1)))
2523e9b7
VS
580#else
581 #define DECLARE_LOG_FUNCTION_WATCOM(level)
582#endif
583
c9f78968 584
2523e9b7 585#define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl) \
d1f6e2cf
VS
586 extern void expdecl wxDoLog##level##Wchar(argclass arg, \
587 const wxChar *format, ...); \
588 extern void expdecl wxDoLog##level##Utf8(argclass arg, \
589 const char *format, ...); \
2523e9b7 590 WX_DEFINE_VARARG_FUNC_VOID(wxLog##level, \
1528e0b8 591 2, (argclass, const wxFormatString&), \
d1f6e2cf 592 wxDoLog##level##Wchar, wxDoLog##level##Utf8) \
2523e9b7 593 DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl) \
c9f78968 594 extern void expdecl wxVLog##level(argclass arg, \
81727065 595 const wxString& format, \
2523e9b7
VS
596 va_list argptr)
597
598#ifdef __WATCOMC__
599 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351;
600 // can't use WX_WATCOM_ONLY_CODE here because the macro would expand to
601 // something too big for Borland C++ to handle
602 #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl) \
59a14f69
VS
603 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
604 2, (argclass, const wxString&), \
605 (f1, wxFormatString(f2))) \
606 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
607 2, (argclass, const wxCStrData&), \
608 (f1, wxFormatString(f2))) \
609 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
2523e9b7 610 2, (argclass, const char*), \
59a14f69
VS
611 (f1, wxFormatString(f2))) \
612 WX_VARARG_WATCOM_WORKAROUND(void, wxLog##level, \
2523e9b7 613 2, (argclass, const wchar_t*), \
59a14f69 614 (f1, wxFormatString(f2)))
2523e9b7
VS
615#else
616 #define DECLARE_LOG_FUNCTION2_EXP_WATCOM(level, argclass, arg, expdecl)
617#endif
618
c9f78968 619
88ac883a
VZ
620#else // !wxUSE_LOG
621
82e77a80
VS
622#ifdef __WATCOMC__
623 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
624 #define WX_WATCOM_ONLY_CODE( x ) x
625#else
626 #define WX_WATCOM_ONLY_CODE( x )
627#endif
628
99fda03a
VS
629#if defined(__WATCOMC__) || defined(__MINGW32__)
630 // Mingw has similar problem with wxLogSysError:
631 #define WX_WATCOM_OR_MINGW_ONLY_CODE( x ) x
632#else
633 #define WX_WATCOM_OR_MINGW_ONLY_CODE( x )
634#endif
635
88ac883a 636// log functions do nothing at all
2523e9b7
VS
637#define DECLARE_LOG_FUNCTION(level) \
638 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxString&)) \
639 WX_WATCOM_ONLY_CODE( \
640 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const char*)) \
641 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wchar_t*)) \
642 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 1, (const wxCStrData&)) \
643 ) \
81727065 644 inline void wxVLog##level(const wxString& WXUNUSED(format), \
59a14f69 645 va_list WXUNUSED(argptr)) { } \
c9f78968 646
2523e9b7
VS
647#define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl) \
648 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxString&)) \
99fda03a 649 WX_WATCOM_OR_MINGW_ONLY_CODE( \
2523e9b7
VS
650 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const char*)) \
651 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wchar_t*)) \
652 WX_DEFINE_VARARG_FUNC_NOP(wxLog##level, 2, (argclass, const wxCStrData&)) \
653 ) \
c9f78968 654 inline void wxVLog##level(argclass WXUNUSED(arg), \
59a14f69
VS
655 const wxString& WXUNUSED(format), \
656 va_list WXUNUSED(argptr)) {}
2523e9b7 657
e30285ab 658// Empty Class to fake wxLogNull
bddd7a8d 659class WXDLLIMPEXP_BASE wxLogNull
e30285ab
VZ
660{
661public:
886dd7d2 662 wxLogNull() { }
e30285ab
VZ
663};
664
665// Dummy macros to replace some functions.
666#define wxSysErrorCode() (unsigned long)0
667#define wxSysErrorMsg( X ) (const wxChar*)NULL
668
669// Fake symbolic trace masks... for those that are used frequently
fda7962d 670#define wxTRACE_OleCalls wxEmptyString // OLE interface calls
e30285ab 671
88ac883a 672#endif // wxUSE_LOG/!wxUSE_LOG
bdeb1f0d 673
33936026
WS
674#define DECLARE_LOG_FUNCTION2(level, argclass, arg) \
675 DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
0b4f47a3 676
463c2e5b 677// VC6 produces a warning if we a macro expanding to nothing to
2523e9b7 678// DECLARE_LOG_FUNCTION2:
463c2e5b 679#if defined(__VISUALC__) && __VISUALC__ < 1300
2523e9b7 680 // "not enough actual parameters for macro 'DECLARE_LOG_FUNCTION2_EXP'"
463c2e5b
VS
681 #pragma warning(disable:4003)
682#endif
c801d85f 683
88ac883a 684// a generic function for all levels (level is passes as parameter)
33936026 685DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);
c801d85f 686
88ac883a
VZ
687// one function per each level
688DECLARE_LOG_FUNCTION(FatalError);
689DECLARE_LOG_FUNCTION(Error);
690DECLARE_LOG_FUNCTION(Warning);
691DECLARE_LOG_FUNCTION(Message);
692DECLARE_LOG_FUNCTION(Info);
693DECLARE_LOG_FUNCTION(Verbose);
470b7da3 694
88ac883a
VZ
695// this function sends the log message to the status line of the top level
696// application frame, if any
2523e9b7 697DECLARE_LOG_FUNCTION(Status);
470b7da3 698
886dd7d2
VZ
699#if wxUSE_GUI
700 // this one is the same as previous except that it allows to explicitly
b5dbe15d 701 class WXDLLIMPEXP_FWD_CORE wxFrame;
886dd7d2 702 // specify the frame to which the output should go
2523e9b7 703 DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *, pFrame, WXDLLIMPEXP_CORE);
886dd7d2 704#endif // wxUSE_GUI
c801d85f 705
88ac883a
VZ
706// additional one: as wxLogError, but also logs last system call error code
707// and the corresponding error message if available
2523e9b7 708DECLARE_LOG_FUNCTION(SysError);
c801d85f 709
88ac883a
VZ
710// and another one which also takes the error code (for those broken APIs
711// that don't set the errno (like registry APIs in Win32))
2523e9b7
VS
712DECLARE_LOG_FUNCTION2(SysError, long, lErrCode);
713#ifdef __WATCOMC__
714// workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
715DECLARE_LOG_FUNCTION2(SysError, unsigned long, lErrCode);
716#endif
88ac883a
VZ
717
718// debug functions do nothing in release mode
bdeb1f0d 719#if wxUSE_LOG && wxUSE_LOG_DEBUG
d6b9496a
VZ
720 DECLARE_LOG_FUNCTION(Debug);
721
b103e4f3
VZ
722 // there is no more unconditional LogTrace: it is not different from
723 // LogDebug and it creates overload ambiguities
724 //DECLARE_LOG_FUNCTION(Trace);
d6b9496a 725
b103e4f3
VZ
726 // this version only logs the message if the mask had been added to the
727 // list of masks with AddTraceMask()
2523e9b7
VS
728 DECLARE_LOG_FUNCTION2(Trace, const wxString&, mask);
729#ifdef __WATCOMC__
730 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
731 DECLARE_LOG_FUNCTION2(Trace, const char*, mask);
732 DECLARE_LOG_FUNCTION2(Trace, const wchar_t*, mask);
733#endif
734
b103e4f3
VZ
735 // and this one does nothing if all of level bits are not set in
736 // wxLog::GetActive()->GetTraceMask() -- it's deprecated in favour of
d6b9496a 737 // string identifiers
2523e9b7
VS
738 DECLARE_LOG_FUNCTION2(Trace, wxTraceMask, mask);
739#ifdef __WATCOMC__
740 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
741 DECLARE_LOG_FUNCTION2(Trace, int, mask);
742#endif
bdeb1f0d 743#else //!debug || !wxUSE_LOG
388a1f66
VZ
744 // these functions do nothing in release builds, but don't define them as
745 // nothing as it could result in different code structure in debug and
746 // release and this could result in trouble when these macros are used
747 // inside if/else
748 //
749 // note that making wxVLogDebug/Trace() themselves (empty inline) functions
750 // is a bad idea as some compilers are stupid enough to not inline even
751 // empty functions if their parameters are complicated enough, but by
752 // defining them as an empty inline function we ensure that even dumbest
753 // compilers optimise them away
dd639a4f
VZ
754#ifdef __BORLANDC__
755 // but Borland gives "W8019: Code has no effect" for wxLogNop() so we need
756 // to define it differently for it to avoid these warnings (same problem as
757 // with wxUnusedVar())
758 #define wxLogNop() { }
759#else
388a1f66 760 inline void wxLogNop() { }
dd639a4f 761#endif
388a1f66
VZ
762
763 #define wxVLogDebug(fmt, valist) wxLogNop()
764 #define wxVLogTrace(mask, fmt, valist) wxLogNop()
ca766534
VS
765
766 #ifdef HAVE_VARIADIC_MACROS
388a1f66
VZ
767 // unlike the inline functions below, this completely removes the
768 // wxLogXXX calls from the object file:
769 #define wxLogDebug(fmt, ...) wxLogNop()
770 #define wxLogTrace(mask, fmt, ...) wxLogNop()
ca766534 771 #else // !HAVE_VARIADIC_MACROS
c9f78968 772 //inline void wxLogDebug(const wxString& fmt, ...) {}
44be939a 773 WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug, 1, (const wxString&))
c9f78968
VS
774 //inline void wxLogTrace(wxTraceMask, const wxString& fmt, ...) {}
775 //inline void wxLogTrace(const wxString&, const wxString& fmt, ...) {}
44be939a
VS
776 WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (wxTraceMask, const wxString&))
777 WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wxString&, const wxString&))
778 #ifdef __WATCOMC__
779 // workaround for http://bugzilla.openwatcom.org/show_bug.cgi?id=351
780 WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const char*, const char*))
781 WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace, 2, (const wchar_t*, const wchar_t*))
782 #endif
ca766534 783 #endif // HAVE_VARIADIC_MACROS/!HAVE_VARIADIC_MACROS
88ac883a 784#endif // debug/!debug
c801d85f 785
463c2e5b
VS
786#if defined(__VISUALC__) && __VISUALC__ < 1300
787 #pragma warning(default:4003)
788#endif
789
c11d62a6
VZ
790// wxLogFatalError helper: show the (fatal) error to the user in a safe way,
791// i.e. without using wxMessageBox() for example because it could crash
bddd7a8d 792void WXDLLIMPEXP_BASE
886dd7d2 793wxSafeShowMessage(const wxString& title, const wxString& text);
c11d62a6 794
88ac883a
VZ
795// ----------------------------------------------------------------------------
796// debug only logging functions: use them with API name and error code
797// ----------------------------------------------------------------------------
c801d85f 798
e90babdf 799#ifdef __WXDEBUG__
42e69d6b
VZ
800 // make life easier for people using VC++ IDE: clicking on the message
801 // will take us immediately to the place of the failed API
802#ifdef __VISUALC__
4b7f2165
VZ
803 #define wxLogApiError(api, rc) \
804 wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."), \
0accd1cf 805 __FILE__, __LINE__, api, \
8b94d999 806 (long)rc, wxSysErrorMsg(rc))
42e69d6b 807#else // !VC++
4b7f2165 808 #define wxLogApiError(api, rc) \
18da7cf2
VZ
809 wxLogDebug(wxT("In file %s at line %d: '%s' failed with ") \
810 wxT("error 0x%08lx (%s)."), \
0accd1cf 811 __FILE__, __LINE__, api, \
8b94d999 812 (long)rc, wxSysErrorMsg(rc))
42e69d6b
VZ
813#endif // VC++/!VC++
814
815 #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
816
c801d85f 817#else //!debug
388a1f66
VZ
818 #define wxLogApiError(api, err) wxLogNop()
819 #define wxLogLastError(api) wxLogNop()
c801d85f
KB
820#endif //debug/!debug
821
a619fa3f
DE
822// wxCocoa has additiional trace masks
823#if defined(__WXCOCOA__)
824#include "wx/cocoa/log.h"
825#endif
826
82e77a80
VS
827#ifdef WX_WATCOM_ONLY_CODE
828 #undef WX_WATCOM_ONLY_CODE
829#endif
830
34138703 831#endif // _WX_LOG_H_
04662def 832