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