]> git.saurik.com Git - wxWidgets.git/blob - include/wx/log.h
more extra semicolons removed (patch 1303724)
[wxWidgets.git] / include / wx / log.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/log.h
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>
9 // Licence: wxWindows licence
10 /////////////////////////////////////////////////////////////////////////////
11
12 #ifndef _WX_LOG_H_
13 #define _WX_LOG_H_
14
15 #include "wx/defs.h"
16
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
35 // ----------------------------------------------------------------------------
36 // types
37 // ----------------------------------------------------------------------------
38
39 // NB: these types are needed even if wxUSE_LOG == 0
40 typedef unsigned long wxTraceMask;
41 typedef unsigned long wxLogLevel;
42
43 // ----------------------------------------------------------------------------
44 // headers
45 // ----------------------------------------------------------------------------
46
47 #include "wx/string.h"
48
49 #if wxUSE_LOG
50
51 #include "wx/arrstr.h"
52
53 #ifndef __WXWINCE__
54 #include <time.h> // for time_t
55 #endif
56
57 #include "wx/dynarray.h"
58
59 #ifndef wxUSE_LOG_DEBUG
60 # ifdef __WXDEBUG__
61 # define wxUSE_LOG_DEBUG 1
62 # else // !__WXDEBUG__
63 # define wxUSE_LOG_DEBUG 0
64 # endif
65 #endif
66
67 // ----------------------------------------------------------------------------
68 // forward declarations
69 // ----------------------------------------------------------------------------
70
71 #if wxUSE_GUI
72 class WXDLLIMPEXP_CORE wxTextCtrl;
73 class WXDLLIMPEXP_CORE wxLogFrame;
74 class WXDLLIMPEXP_CORE wxFrame;
75 class WXDLLIMPEXP_CORE wxWindow;
76 #endif // wxUSE_GUI
77
78 // ----------------------------------------------------------------------------
79 // constants
80 // ----------------------------------------------------------------------------
81
82 // different standard log levels (you may also define your own)
83 enum
84 {
85 wxLOG_FatalError, // program can't continue, abort immediately
86 wxLOG_Error, // a serious error, user must be informed about it
87 wxLOG_Warning, // user is normally informed about it but may be ignored
88 wxLOG_Message, // normal message (i.e. normal output of a non GUI app)
89 wxLOG_Status, // informational: might go to the status line of GUI app
90 wxLOG_Info, // informational message (a.k.a. 'Verbose')
91 wxLOG_Debug, // never shown to the user, disabled in release mode
92 wxLOG_Trace, // trace messages are also only enabled in debug mode
93 wxLOG_Progress, // used for progress indicator (not yet)
94 wxLOG_User = 100, // user defined levels start here
95 wxLOG_Max = 10000
96 };
97
98 // symbolic trace masks - wxLogTrace("foo", "some trace message...") will be
99 // discarded unless the string "foo" has been added to the list of allowed
100 // ones with AddTraceMask()
101
102 #define wxTRACE_MemAlloc wxT("memalloc") // trace memory allocation (new/delete)
103 #define wxTRACE_Messages wxT("messages") // trace window messages/X callbacks
104 #define wxTRACE_ResAlloc wxT("resalloc") // trace GDI resource allocation
105 #define wxTRACE_RefCount wxT("refcount") // trace various ref counting operations
106
107 #ifdef __WXMSW__
108 #define wxTRACE_OleCalls wxT("ole") // OLE interface calls
109 #endif
110
111 #include "wx/iosfwrap.h"
112
113 // ----------------------------------------------------------------------------
114 // derive from this class to redirect (or suppress, or ...) log messages
115 // normally, only a single instance of this class exists but it's not enforced
116 // ----------------------------------------------------------------------------
117
118 class WXDLLIMPEXP_BASE wxLog
119 {
120 public:
121 // ctor
122 wxLog(){}
123
124 // Internal buffer.
125
126 // Allow replacement of the fixed size static buffer with
127 // a user allocated one. Pass in NULL to restore the
128 // built in static buffer.
129 static wxChar *SetLogBuffer( wxChar *buf, size_t size = 0 );
130
131 // these functions allow to completely disable all log messages
132
133 // is logging disabled now?
134 static bool IsEnabled() { return ms_doLog; }
135
136 // change the flag state, return the previous one
137 static bool EnableLogging(bool doIt = true)
138 { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
139
140 // static sink function - see DoLog() for function to overload in the
141 // derived classes
142 static void OnLog(wxLogLevel level, const wxChar *szString, time_t t)
143 {
144 if ( IsEnabled() && ms_logLevel >= level )
145 {
146 wxLog *pLogger = GetActiveTarget();
147 if ( pLogger )
148 pLogger->DoLog(level, szString, t);
149 }
150 }
151
152 // message buffering
153
154 // flush shows all messages if they're not logged immediately (FILE
155 // and iostream logs don't need it, but wxGuiLog does to avoid showing
156 // 17 modal dialogs one after another)
157 virtual void Flush();
158
159 // flush the active target if any
160 static void FlushActive()
161 {
162 if ( !ms_suspendCount )
163 {
164 wxLog *log = GetActiveTarget();
165 if ( log )
166 log->Flush();
167 }
168 }
169
170 // only one sink is active at each moment
171 // get current log target, will call wxApp::CreateLogTarget() to
172 // create one if none exists
173 static wxLog *GetActiveTarget();
174
175 // change log target, pLogger may be NULL
176 static wxLog *SetActiveTarget(wxLog *pLogger);
177
178 // suspend the message flushing of the main target until the next call
179 // to Resume() - this is mainly for internal use (to prevent wxYield()
180 // from flashing the messages)
181 static void Suspend() { ms_suspendCount++; }
182
183 // must be called for each Suspend()!
184 static void Resume() { ms_suspendCount--; }
185
186 // functions controlling the default wxLog behaviour
187 // verbose mode is activated by standard command-line '-verbose'
188 // option
189 static void SetVerbose(bool bVerbose = true) { ms_bVerbose = bVerbose; }
190
191 // Set log level. Log messages with level > logLevel will not be logged.
192 static void SetLogLevel(wxLogLevel logLevel) { ms_logLevel = logLevel; }
193
194 // should GetActiveTarget() try to create a new log object if the
195 // current is NULL?
196 static void DontCreateOnDemand();
197
198 // trace mask (see wxTraceXXX constants for details)
199 static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
200
201 // add string trace mask
202 static void AddTraceMask(const wxString& str)
203 { ms_aTraceMasks.push_back(str); }
204
205 // add string trace mask
206 static void RemoveTraceMask(const wxString& str);
207
208 // remove all string trace masks
209 static void ClearTraceMasks();
210
211 // get string trace masks
212 static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
213
214 // sets the timestamp string: this is used as strftime() format string
215 // for the log targets which add time stamps to the messages - set it
216 // to NULL to disable time stamping completely.
217 static void SetTimestamp(const wxChar *ts) { ms_timestamp = ts; }
218
219
220 // accessors
221
222 // gets the verbose status
223 static bool GetVerbose() { return ms_bVerbose; }
224
225 // get trace mask
226 static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
227
228 // is this trace mask in the list?
229 static bool IsAllowedTraceMask(const wxChar *mask);
230
231 // return the current loglevel limit
232 static wxLogLevel GetLogLevel() { return ms_logLevel; }
233
234 // get the current timestamp format string (may be NULL)
235 static const wxChar *GetTimestamp() { return ms_timestamp; }
236
237
238 // helpers
239
240 // put the time stamp into the string if ms_timestamp != NULL (don't
241 // change it otherwise)
242 static void TimeStamp(wxString *str);
243
244 // make dtor virtual for all derived classes
245 virtual ~wxLog() { }
246
247
248 // this method exists for backwards compatibility only, don't use
249 bool HasPendingMessages() const { return true; }
250
251 protected:
252 // the logging functions that can be overriden
253
254 // default DoLog() prepends the time stamp and a prefix corresponding
255 // to the message to szString and then passes it to DoLogString()
256 virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
257
258 // default DoLogString does nothing but is not pure virtual because if
259 // you override DoLog() you might not need it at all
260 virtual void DoLogString(const wxChar *szString, time_t t);
261
262 private:
263 // static variables
264 // ----------------
265
266 static wxLog *ms_pLogger; // currently active log sink
267 static bool ms_doLog; // false => all logging disabled
268 static bool ms_bAutoCreate; // create new log targets on demand?
269 static bool ms_bVerbose; // false => ignore LogInfo messages
270
271 static wxLogLevel ms_logLevel; // limit logging to levels <= ms_logLevel
272
273 static size_t ms_suspendCount; // if positive, logs are not flushed
274
275 // format string for strftime(), if NULL, time stamping log messages is
276 // disabled
277 static const wxChar *ms_timestamp;
278
279 static wxTraceMask ms_ulTraceMask; // controls wxLogTrace behaviour
280 static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
281 };
282
283 // ----------------------------------------------------------------------------
284 // "trivial" derivations of wxLog
285 // ----------------------------------------------------------------------------
286
287 #if wxABI_VERSION > 20601
288
289 // log everything to a buffer
290 class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
291 {
292 public:
293 wxLogBuffer() { }
294
295 // get the string contents with all messages logged
296 const wxString& GetBuffer() const { return m_str; }
297
298 // show the buffer contents to the user in the best possible way (this uses
299 // wxMessageOutputMessageBox) and clear it
300 virtual void Flush();
301
302 protected:
303 virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
304 virtual void DoLogString(const wxChar *szString, time_t t);
305
306 private:
307 wxString m_str;
308
309 DECLARE_NO_COPY_CLASS(wxLogBuffer)
310 };
311
312 #endif // wxABI_VERSION
313
314 // log everything to a "FILE *", stderr by default
315 class WXDLLIMPEXP_BASE wxLogStderr : public wxLog
316 {
317 public:
318 // redirect log output to a FILE
319 wxLogStderr(FILE *fp = (FILE *) NULL);
320
321 protected:
322 // implement sink function
323 virtual void DoLogString(const wxChar *szString, time_t t);
324
325 FILE *m_fp;
326
327 DECLARE_NO_COPY_CLASS(wxLogStderr)
328 };
329
330 #if wxUSE_STD_IOSTREAM
331
332 // log everything to an "ostream", cerr by default
333 class WXDLLIMPEXP_BASE wxLogStream : public wxLog
334 {
335 public:
336 // redirect log output to an ostream
337 wxLogStream(wxSTD ostream *ostr = (wxSTD ostream *) NULL);
338
339 protected:
340 // implement sink function
341 virtual void DoLogString(const wxChar *szString, time_t t);
342
343 // using ptr here to avoid including <iostream.h> from this file
344 wxSTD ostream *m_ostr;
345 };
346
347 #endif // wxUSE_STD_IOSTREAM
348
349 // ----------------------------------------------------------------------------
350 // /dev/null log target: suppress logging until this object goes out of scope
351 // ----------------------------------------------------------------------------
352
353 // example of usage:
354 /*
355 void Foo()
356 {
357 wxFile file;
358
359 // wxFile.Open() normally complains if file can't be opened, we don't
360 // want it
361 wxLogNull logNo;
362
363 if ( !file.Open("bar") )
364 ... process error ourselves ...
365
366 // ~wxLogNull called, old log sink restored
367 }
368 */
369 class WXDLLIMPEXP_BASE wxLogNull
370 {
371 public:
372 wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }
373 ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
374
375 private:
376 bool m_flagOld; // the previous value of the wxLog::ms_doLog
377 };
378
379 // ----------------------------------------------------------------------------
380 // chaining log target: installs itself as a log target and passes all
381 // messages to the real log target given to it in the ctor but also forwards
382 // them to the previously active one
383 //
384 // note that you don't have to call SetActiveTarget() with this class, it
385 // does it itself in its ctor
386 // ----------------------------------------------------------------------------
387
388 class WXDLLIMPEXP_BASE wxLogChain : public wxLog
389 {
390 public:
391 wxLogChain(wxLog *logger);
392 virtual ~wxLogChain();
393
394 // change the new log target
395 void SetLog(wxLog *logger);
396
397 // this can be used to temporarily disable (and then reenable) passing
398 // messages to the old logger (by default we do pass them)
399 void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
400
401 // are we passing the messages to the previous log target?
402 bool IsPassingMessages() const { return m_bPassMessages; }
403
404 // return the previous log target (may be NULL)
405 wxLog *GetOldLog() const { return m_logOld; }
406
407 // override base class version to flush the old logger as well
408 virtual void Flush();
409
410 protected:
411 // pass the chain to the old logger if needed
412 virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
413
414 private:
415 // the current log target
416 wxLog *m_logNew;
417
418 // the previous log target
419 wxLog *m_logOld;
420
421 // do we pass the messages to the old logger?
422 bool m_bPassMessages;
423
424 DECLARE_NO_COPY_CLASS(wxLogChain)
425 };
426
427 // a chain log target which uses itself as the new logger
428 class WXDLLIMPEXP_BASE wxLogPassThrough : public wxLogChain
429 {
430 public:
431 wxLogPassThrough();
432
433 private:
434 DECLARE_NO_COPY_CLASS(wxLogPassThrough)
435 };
436
437 #if wxUSE_GUI
438 // include GUI log targets:
439 #include "wx/generic/logg.h"
440 #endif // wxUSE_GUI
441
442 // ============================================================================
443 // global functions
444 // ============================================================================
445
446 // ----------------------------------------------------------------------------
447 // Log functions should be used by application instead of stdio, iostream &c
448 // for log messages for easy redirection
449 // ----------------------------------------------------------------------------
450
451 // ----------------------------------------------------------------------------
452 // get error code/error message from system in a portable way
453 // ----------------------------------------------------------------------------
454
455 // return the last system error code
456 WXDLLIMPEXP_BASE unsigned long wxSysErrorCode();
457
458 // return the error message for given (or last if 0) error code
459 WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
460
461 // ----------------------------------------------------------------------------
462 // define wxLog<level>
463 // ----------------------------------------------------------------------------
464
465 #define DECLARE_LOG_FUNCTION(level) \
466 extern void WXDLLIMPEXP_BASE wxVLog##level(const wxChar *szFormat, \
467 va_list argptr); \
468 extern void WXDLLIMPEXP_BASE wxLog##level(const wxChar *szFormat, \
469 ...) ATTRIBUTE_PRINTF_1
470 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl) \
471 extern void expdecl wxVLog##level(argclass arg, \
472 const wxChar *szFormat, \
473 va_list argptr); \
474 extern void expdecl wxLog##level(argclass arg, \
475 const wxChar *szFormat, \
476 ...) ATTRIBUTE_PRINTF_2
477 #else // !wxUSE_LOG
478
479 // log functions do nothing at all
480 #define DECLARE_LOG_FUNCTION(level) \
481 inline void wxVLog##level(const wxChar *WXUNUSED(szFormat), \
482 va_list WXUNUSED(argptr)) { } \
483 inline void wxLog##level(const wxChar *WXUNUSED(szFormat), \
484 ...) { }
485 #define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl) \
486 inline void wxVLog##level(argclass WXUNUSED(arg), \
487 const wxChar *WXUNUSED(szFormat), \
488 va_list WXUNUSED(argptr)) {} \
489 inline void wxLog##level(argclass WXUNUSED(arg), \
490 const wxChar *WXUNUSED(szFormat), \
491 ...) { }
492
493 // Empty Class to fake wxLogNull
494 class WXDLLIMPEXP_BASE wxLogNull
495 {
496 public:
497 wxLogNull() { }
498 };
499
500 // Dummy macros to replace some functions.
501 #define wxSysErrorCode() (unsigned long)0
502 #define wxSysErrorMsg( X ) (const wxChar*)NULL
503
504 // Fake symbolic trace masks... for those that are used frequently
505 #define wxTRACE_OleCalls wxEmptyString // OLE interface calls
506
507 #endif // wxUSE_LOG/!wxUSE_LOG
508 #define DECLARE_LOG_FUNCTION2(level, argclass, arg) \
509 DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
510
511
512 // a generic function for all levels (level is passes as parameter)
513 DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);
514
515 // one function per each level
516 DECLARE_LOG_FUNCTION(FatalError);
517 DECLARE_LOG_FUNCTION(Error);
518 DECLARE_LOG_FUNCTION(Warning);
519 DECLARE_LOG_FUNCTION(Message);
520 DECLARE_LOG_FUNCTION(Info);
521 DECLARE_LOG_FUNCTION(Verbose);
522
523 // this function sends the log message to the status line of the top level
524 // application frame, if any
525 DECLARE_LOG_FUNCTION(Status);
526
527 #if wxUSE_GUI
528 // this one is the same as previous except that it allows to explicitly
529 class WXDLLEXPORT wxFrame;
530 // specify the frame to which the output should go
531 DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *, pFrame, WXDLLIMPEXP_CORE);
532 #endif // wxUSE_GUI
533
534 // additional one: as wxLogError, but also logs last system call error code
535 // and the corresponding error message if available
536 DECLARE_LOG_FUNCTION(SysError);
537
538 // and another one which also takes the error code (for those broken APIs
539 // that don't set the errno (like registry APIs in Win32))
540 DECLARE_LOG_FUNCTION2(SysError, long, lErrCode);
541
542 // debug functions do nothing in release mode
543 #if wxUSE_LOG_DEBUG
544 DECLARE_LOG_FUNCTION(Debug);
545
546 // there is no more unconditional LogTrace: it is not different from
547 // LogDebug and it creates overload ambiguities
548 //DECLARE_LOG_FUNCTION(Trace);
549
550 // this version only logs the message if the mask had been added to the
551 // list of masks with AddTraceMask()
552 DECLARE_LOG_FUNCTION2(Trace, const wxChar *, mask);
553
554 // and this one does nothing if all of level bits are not set in
555 // wxLog::GetActive()->GetTraceMask() -- it's deprecated in favour of
556 // string identifiers
557 DECLARE_LOG_FUNCTION2(Trace, wxTraceMask, mask);
558 #else //!debug
559 // these functions do nothing in release builds
560
561 // note that leaving out "fmt" in the vararg functions provokes a warning
562 // from SGI CC: "the last argument of the varargs function is unnamed"
563 inline void wxVLogDebug(const wxChar *, va_list) { }
564 inline void wxLogDebug(const wxChar *fmt, ...) { wxUnusedVar(fmt); }
565 inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }
566 inline void wxLogTrace(wxTraceMask, const wxChar *fmt, ...) { wxUnusedVar(fmt); }
567 inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }
568 inline void wxLogTrace(const wxChar *, const wxChar *fmt, ...) { wxUnusedVar(fmt); }
569 #endif // debug/!debug
570
571 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
572 // i.e. without using wxMessageBox() for example because it could crash
573 void WXDLLIMPEXP_BASE
574 wxSafeShowMessage(const wxString& title, const wxString& text);
575
576 // ----------------------------------------------------------------------------
577 // debug only logging functions: use them with API name and error code
578 // ----------------------------------------------------------------------------
579
580 #ifdef __WXDEBUG__
581 // make life easier for people using VC++ IDE: clicking on the message
582 // will take us immediately to the place of the failed API
583 #ifdef __VISUALC__
584 #define wxLogApiError(api, rc) \
585 wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."), \
586 __TFILE__, __LINE__, api, \
587 (long)rc, wxSysErrorMsg(rc))
588 #else // !VC++
589 #define wxLogApiError(api, rc) \
590 wxLogDebug(wxT("In file %s at line %d: '%s' failed with ") \
591 wxT("error 0x%08lx (%s)."), \
592 __TFILE__, __LINE__, api, \
593 (long)rc, wxSysErrorMsg(rc))
594 #endif // VC++/!VC++
595
596 #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
597
598 #else //!debug
599 inline void wxLogApiError(const wxChar *, long) { }
600 inline void wxLogLastError(const wxChar *) { }
601 #endif //debug/!debug
602
603 // wxCocoa has additiional trace masks
604 #if defined(__WXCOCOA__)
605 #include "wx/cocoa/log.h"
606 #endif
607
608 #endif // _WX_LOG_H_
609