]> git.saurik.com Git - wxWidgets.git/blame - interface/log.h
add default parameters for width and style parameters of FindOrCreatePen() for consis...
[wxWidgets.git] / interface / log.h
CommitLineData
23324ae1
FM
1/////////////////////////////////////////////////////////////////////////////
2// Name: log.h
e54c96f1 3// Purpose: interface of wxLogWindow
23324ae1
FM
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
9/**
10 @class wxLogWindow
11 @wxheader{log.h}
7c913512 12
23324ae1
FM
13 This class represents a background log window: to be precise, it collects all
14 log messages in the log frame which it manages but also passes them on to the
15 log target which was active at the moment of its creation. This allows, for
16 example, to show all the log messages in a frame but still continue to process
17 them normally by showing the standard log dialog.
7c913512 18
23324ae1
FM
19 @library{wxbase}
20 @category{logging}
7c913512 21
e54c96f1 22 @see wxLogTextCtrl
23324ae1
FM
23*/
24class wxLogWindow : public wxLogInterposer
25{
26public:
27 /**
28 Creates the log frame window and starts collecting the messages in it.
3c4f71cc 29
7c913512 30 @param parent
4cc4bfaf 31 The parent window for the log frame, may be @NULL
7c913512 32 @param title
4cc4bfaf 33 The title for the log frame
7c913512 34 @param show
4cc4bfaf
FM
35 @true to show the frame initially (default), otherwise
36 Show() must be called later.
7c913512 37 @param passToOld
4cc4bfaf
FM
38 @true to process the log messages normally in addition to
39 logging them in the log frame (default), @false to only log them in the
40 log frame.
23324ae1 41 */
4cc4bfaf
FM
42 wxLogWindow(wxFrame parent, const wxChar title, bool show = true,
43 bool passToOld = true);
23324ae1
FM
44
45 /**
46 Returns the associated log frame window. This may be used to position or resize
47 it but use Show() to show or hide it.
48 */
328f5751 49 wxFrame* GetFrame() const;
23324ae1
FM
50
51 /**
52 Called if the user closes the window interactively, will not be
53 called if it is destroyed for another reason (such as when program
54 exits).
23324ae1
FM
55 Return @true from here to allow the frame to close, @false to
56 prevent this from happening.
3c4f71cc 57
4cc4bfaf 58 @see OnFrameDelete()
23324ae1
FM
59 */
60 virtual bool OnFrameClose(wxFrame frame);
61
62 /**
63 Called immediately after the log frame creation allowing for
64 any extra initializations.
65 */
66 virtual void OnFrameCreate(wxFrame frame);
67
68 /**
69 Called right before the log frame is going to be deleted: will
70 always be called unlike OnFrameClose().
71 */
72 virtual void OnFrameDelete(wxFrame frame);
73
74 /**
75 Shows or hides the frame.
76 */
4cc4bfaf 77 void Show(bool show = true);
23324ae1
FM
78};
79
80
e54c96f1 81
23324ae1
FM
82/**
83 @class wxLogInterposerTemp
84 @wxheader{log.h}
7c913512 85
23324ae1
FM
86 A special version of wxLogChain which uses itself as the
87 new log target. It forwards log messages to the previously installed one in
88 addition to
89 processing them itself. Unlike wxLogInterposer, it doesn't
90 delete the old target which means it can be used to temporarily redirect log
91 output.
7c913512 92
23324ae1
FM
93 As per wxLogInterposer, this class must be derived from to implement
94 wxLog::DoLog
95 and/or wxLog::DoLogString methods.
7c913512 96
23324ae1
FM
97 @library{wxbase}
98 @category{logging}
99*/
100class wxLogInterposerTemp : public wxLogChain
101{
102public:
103 /**
104 The default constructor installs this object as the current active log target.
105 */
106};
107
108
e54c96f1 109
23324ae1
FM
110/**
111 @class wxLogChain
112 @wxheader{log.h}
7c913512 113
23324ae1
FM
114 This simple class allows to chain log sinks, that is to install a new sink but
115 keep passing log messages to the old one instead of replacing it completely as
116 wxLog::SetActiveTarget does.
7c913512 117
23324ae1
FM
118 It is especially useful when you want to divert the logs somewhere (for
119 example to a file or a log window) but also keep showing the error messages
120 using the standard dialogs as wxLogGui does by default.
7c913512 121
23324ae1 122 Example of usage:
7c913512 123
23324ae1
FM
124 @code
125 wxLogChain *logChain = new wxLogChain(new wxLogStderr);
7c913512 126
23324ae1
FM
127 // all the log messages are sent to stderr and also processed as usually
128 ...
7c913512 129
23324ae1
FM
130 // don't delete logChain directly as this would leave a dangling
131 // pointer as active log target, use SetActiveTarget() instead
132 delete wxLog::SetActiveTarget(...something else or @NULL...);
133 @endcode
7c913512 134
23324ae1
FM
135 @library{wxbase}
136 @category{logging}
137*/
138class wxLogChain : public wxLog
139{
140public:
141 /**
142 Sets the specified @c logger (which may be @NULL) as the default log
143 target but the log messages are also passed to the previous log target if any.
144 */
4cc4bfaf 145 wxLogChain(wxLog* logger);
23324ae1
FM
146
147 /**
148 Destroys the previous log target.
149 */
150 ~wxLogChain();
151
152 /**
153 Detaches the old log target so it won't be destroyed when the wxLogChain object
154 is destroyed.
155 */
156 void DetachOldLog();
157
158 /**
159 Returns the pointer to the previously active log target (which may be @NULL).
160 */
328f5751 161 wxLog* GetOldLog() const;
23324ae1
FM
162
163 /**
164 Returns @true if the messages are passed to the previously active log
165 target (default) or @false if PassMessages()
166 had been called.
167 */
328f5751 168 bool IsPassingMessages() const;
23324ae1
FM
169
170 /**
171 By default, the log messages are passed to the previously active log target.
172 Calling this function with @false parameter disables this behaviour
173 (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
4cc4bfaf 174 it can be reenabled by calling it again with @a passMessages set to @true.
23324ae1
FM
175 */
176 void PassMessages(bool passMessages);
177
178 /**
179 Sets another log target to use (may be @NULL). The log target specified
180 in the @ref ctor() constructor or in a previous call to
181 this function is deleted.
23324ae1
FM
182 This doesn't change the old log target value (the one the messages are
183 forwarded to) which still remains the same as was active when wxLogChain
184 object was created.
185 */
4cc4bfaf 186 void SetLog(wxLog* logger);
23324ae1
FM
187};
188
189
e54c96f1 190
23324ae1
FM
191/**
192 @class wxLogGui
193 @wxheader{log.h}
7c913512 194
23324ae1
FM
195 This is the default log target for the GUI wxWidgets applications. It is passed
196 to wxLog::SetActiveTarget at the program
197 startup and is deleted by wxWidgets during the program shut down.
7c913512 198
23324ae1
FM
199 @library{wxbase}
200 @category{logging}
201*/
202class wxLogGui : public wxLog
203{
204public:
205 /**
206 Default constructor.
207 */
208 wxLogGui();
209};
210
211
e54c96f1 212
23324ae1
FM
213/**
214 @class wxLogStream
215 @wxheader{log.h}
7c913512 216
23324ae1 217 This class can be used to redirect the log messages to a C++ stream.
7c913512 218
23324ae1
FM
219 Please note that this class is only available if wxWidgets was compiled with
220 the standard iostream library support (@c wxUSE_STD_IOSTREAM must be on).
7c913512 221
23324ae1
FM
222 @library{wxbase}
223 @category{logging}
7c913512 224
e54c96f1 225 @see wxLogStderr, wxStreamToTextRedirector
23324ae1
FM
226*/
227class wxLogStream : public wxLog
228{
229public:
230 /**
231 Constructs a log target which sends all the log messages to the given
232 output stream. If it is @NULL, the messages are sent to @c cerr.
233 */
4cc4bfaf 234 wxLogStream(std::ostream ostr = NULL);
23324ae1
FM
235};
236
237
e54c96f1 238
23324ae1
FM
239/**
240 @class wxLogStderr
241 @wxheader{log.h}
7c913512 242
23324ae1
FM
243 This class can be used to redirect the log messages to a C file stream (not to
244 be confused with C++ streams). It is the default log target for the non-GUI
245 wxWidgets applications which send all the output to @c stderr.
7c913512 246
23324ae1
FM
247 @library{wxbase}
248 @category{logging}
7c913512 249
e54c96f1 250 @see wxLogStream
23324ae1
FM
251*/
252class wxLogStderr : public wxLog
253{
254public:
255 /**
256 Constructs a log target which sends all the log messages to the given
257 @c FILE. If it is @NULL, the messages are sent to @c stderr.
258 */
4cc4bfaf 259 wxLogStderr(FILE fp = NULL);
23324ae1
FM
260};
261
262
e54c96f1 263
23324ae1
FM
264/**
265 @class wxLogBuffer
266 @wxheader{log.h}
7c913512 267
23324ae1
FM
268 wxLogBuffer is a very simple implementation of log sink which simply collects
269 all the logged messages in a string (except the debug messages which are output
270 in the usual way immediately as we're presumably not interested in collecting
271 them for later). The messages from different log function calls are separated
272 by the new lines.
7c913512 273
23324ae1 274 All the messages collected so far can be shown to the user (and the current
7c913512 275 buffer cleared) by calling the overloaded wxLogBuffer::Flush
23324ae1 276 method.
7c913512 277
23324ae1
FM
278 @library{wxbase}
279 @category{FIXME}
280*/
281class wxLogBuffer : public wxLog
282{
283public:
284 /**
285 Shows all the messages collected so far to the user (using a message box in the
286 GUI applications or by printing them out to the console in text mode) and
287 clears the internal buffer.
288 */
289 virtual void Flush();
290
291 /**
292 Returns the current buffer contains. Messages from different log function calls
293 are separated with the new lines in the buffer.
23324ae1
FM
294 The buffer can be cleared by Flush() which will
295 also show the current contents to the user.
296 */
297 const wxString GetBuffer();
298};
299
300
e54c96f1 301
23324ae1
FM
302/**
303 @class wxLogInterposer
304 @wxheader{log.h}
7c913512 305
23324ae1
FM
306 A special version of wxLogChain which uses itself as the
307 new log target. It forwards log messages to the previously installed one in
308 addition to
309 processing them itself.
7c913512 310
23324ae1
FM
311 Unlike wxLogChain which is usually used directly as is,
312 this class must be derived from to implement wxLog::DoLog
313 and/or wxLog::DoLogString methods.
7c913512 314
23324ae1
FM
315 wxLogInterposer destroys the previous log target in its destructor. If you
316 don't want this to happen, use wxLogInterposerTemp instead.
7c913512 317
23324ae1
FM
318 @library{wxbase}
319 @category{logging}
320*/
321class wxLogInterposer : public wxLogChain
322{
323public:
324 /**
325 The default constructor installs this object as the current active log target.
326 */
327};
328
329
e54c96f1 330
23324ae1
FM
331/**
332 @class wxLogTextCtrl
333 @wxheader{log.h}
7c913512 334
23324ae1
FM
335 Using these target all the log messages can be redirected to a text control.
336 The text control must have been created with @c wxTE_MULTILINE style by the
337 caller previously.
7c913512 338
23324ae1
FM
339 @library{wxbase}
340 @category{logging}
7c913512 341
e54c96f1 342 @see wxTextCtrl, wxStreamToTextRedirector
23324ae1
FM
343*/
344class wxLogTextCtrl : public wxLog
345{
346public:
347 /**
348 Constructs a log target which sends all the log messages to the given text
4cc4bfaf 349 control. The @a textctrl parameter cannot be @NULL.
23324ae1
FM
350 */
351 wxLogTextCtrl(wxTextCtrl textctrl);
352};
353
354
e54c96f1 355
23324ae1
FM
356/**
357 @class wxLog
358 @wxheader{log.h}
7c913512 359
23324ae1
FM
360 wxLog class defines the interface for the @e log targets used by wxWidgets
361 logging functions as explained in the @ref overview_wxlogoverview "wxLog
362 overview".
363 The only situations when you need to directly use this class is when you want
364 to derive your own log target because the existing ones don't satisfy your
365 needs. Another case is if you wish to customize the behaviour of the standard
366 logging classes (all of which respect the wxLog settings): for example, set
367 which trace messages are logged and which are not or change (or even remove
368 completely) the timestamp on the messages.
7c913512 369
23324ae1
FM
370 Otherwise, it is completely hidden behind the @e wxLogXXX() functions and
371 you may not even know about its existence.
7c913512 372
23324ae1
FM
373 See @ref overview_wxlogoverview "log overview" for the descriptions of wxWidgets
374 logging facilities.
7c913512 375
23324ae1
FM
376 @library{wxcore}
377 @category{logging}
7c913512 378
e54c96f1 379 @see wxLog::RemoveTraceMask, wxLog::GetTraceMasks
23324ae1 380*/
7c913512 381class wxLog
23324ae1
FM
382{
383public:
384 /**
4cc4bfaf 385 Add the @a mask to the list of allowed masks for
e54c96f1 386 wxLogTrace().
3c4f71cc 387
4cc4bfaf 388 @see RemoveTraceMask(), GetTraceMasks()
23324ae1
FM
389 */
390 static void AddTraceMask(const wxString& mask);
391
392 /**
393 Removes all trace masks previously set with
394 AddTraceMask().
3c4f71cc 395
4cc4bfaf 396 @see RemoveTraceMask()
23324ae1
FM
397 */
398 static void ClearTraceMasks();
399
400 /**
401 The functions below allow some limited customization of wxLog behaviour
402 without writing a new log target class (which, aside of being a matter of
403 several minutes, allows you to do anything you want).
23324ae1 404 The verbose messages are the trace messages which are not disabled in the
e54c96f1 405 release mode and are generated by wxLogVerbose(). They
23324ae1
FM
406 are not normally shown to the user because they present little interest, but
407 may be activated, for example, in order to help the user find some program
408 problem.
23324ae1
FM
409 As for the (real) trace messages, their handling depends on the settings of
410 the (application global) @e trace mask. There are two ways to specify it:
411 either by using SetTraceMask() and
412 GetTraceMask() and using
e54c96f1 413 wxLogTrace() which takes an integer mask or by using
23324ae1 414 AddTraceMask() for string trace masks.
23324ae1
FM
415 The difference between bit-wise and string trace masks is that a message using
416 integer trace mask will only be logged if all bits of the mask are set in the
417 current mask while a message using string mask will be logged simply if the
418 mask had been added before to the list of allowed ones.
23324ae1 419 For example,
3c4f71cc 420
23324ae1
FM
421 will do something only if the current trace mask contains both
422 @c wxTraceRefCount and @c wxTraceOle, but
3c4f71cc 423
23324ae1 424 will log the message if it was preceded by
3c4f71cc 425
23324ae1
FM
426 Using string masks is simpler and allows to easily add custom ones, so this is
427 the preferred way of working with trace messages. The integer trace mask is
428 kept for compatibility and for additional (but very rarely needed) flexibility
429 only.
e54c96f1 430 The standard trace masks are given in wxLogTrace()
23324ae1 431 documentation.
23324ae1
FM
432 Finally, the @e wxLog::DoLog() function automatically prepends a time stamp
433 to all the messages. The format of the time stamp may be changed: it can be
434 any string with % specifications fully described in the documentation of the
435 standard @e strftime() function. For example, the default format is
436 "[%d/%b/%y %H:%M:%S] " which gives something like "[17/Sep/98 22:10:16] "
437 (without quotes) for the current date. Setting an empty string as the time
438 format disables timestamping of the messages completely.
23324ae1
FM
439 @b NB: Timestamping is disabled for Visual C++ users in debug builds by
440 default because otherwise it would be impossible to directly go to the line
441 from which the log message was generated by simply clicking in the debugger
442 window on the corresponding error message. If you wish to enable it, please use
443 SetTimestamp() explicitly.
23324ae1 444 AddTraceMask()
3c4f71cc 445
23324ae1 446 RemoveTraceMask()
3c4f71cc 447
23324ae1 448 ClearTraceMasks()
3c4f71cc 449
23324ae1 450 GetTraceMasks()
3c4f71cc 451
23324ae1 452 IsAllowedTraceMask()
3c4f71cc 453
23324ae1 454 SetVerbose()
3c4f71cc 455
23324ae1 456 GetVerbose()
3c4f71cc 457
23324ae1 458 SetTimestamp()
3c4f71cc 459
23324ae1 460 GetTimestamp()
3c4f71cc 461
23324ae1 462 SetTraceMask()
3c4f71cc 463
23324ae1 464 GetTraceMask()
3c4f71cc 465
23324ae1 466 SetRepetitionCounting()
3c4f71cc 467
23324ae1
FM
468 GetRepetitionCounting()
469 */
470
471
472 /**
473 Disables time stamping of the log messages.
23324ae1
FM
474 This function is new since wxWidgets version 2.9
475 */
476 void SetTimestamp(const wxString& format);
477
478 /**
4cc4bfaf 479 Called to process the message of the specified severity. @a msg is the text
23324ae1 480 of the message as specified in the call of @e wxLogXXX() function which
4cc4bfaf 481 generated it and @a timestamp is the moment when the message was generated.
23324ae1
FM
482 The base class version prepends the timestamp to the message, adds a prefix
483 corresponding to the log level and then calls
484 DoLogString() with the resulting string.
485 */
486 virtual void DoLog(wxLogLevel level, const wxString& msg,
487 time_t timestamp);
488
489 /**
490 Called to log the specified string. The timestamp is already included in the
491 string but still passed to this function.
23324ae1
FM
492 A simple implementation may just send the string to @c stdout or, better,
493 @c stderr.
494 */
495 virtual void DoLogString(const wxString& msg, time_t timestamp);
496
497 /**
498 Instructs wxLog to not create new log targets on the fly if there is none
499 currently. (Almost) for internal use only: it is supposed to be called by the
500 application shutdown code.
23324ae1
FM
501 Note that this function also calls
502 ClearTraceMasks().
503 */
504 static void DontCreateOnDemand();
505
506 /**
507 Shows all the messages currently in buffer and clears it. If the buffer
508 is already empty, nothing happens.
509 */
510 virtual void Flush();
511
512 /**
513 Flushes the current log target if any, does nothing if there is none.
3c4f71cc 514
4cc4bfaf 515 @see Flush()
23324ae1
FM
516 */
517 static void FlushActive();
518
519 /**
520 Returns the pointer to the active log target (may be @NULL).
521 */
4cc4bfaf 522 static wxLog* GetActiveTarget();
23324ae1
FM
523
524 /**
525 Returns the current log level limit.
526 */
527 static wxLogLevel GetLogLevel();
528
529 /**
530 Returns whether the repetition counting mode is enabled.
531 */
532 static bool GetRepetitionCounting();
533
534 /**
535 Returns the current timestamp format string.
536 */
537 static const wxString GetTimestamp();
538
539 /**
540 Returns the current trace mask, see Customization() section
541 for details.
542 */
543 static wxTraceMask GetTraceMask();
544
545 /**
546 Returns the currently allowed list of string trace masks.
3c4f71cc 547
4cc4bfaf 548 @see AddTraceMask().
23324ae1
FM
549 */
550 static const wxArrayString GetTraceMasks();
551
552 /**
553 Returns whether the verbose mode is currently active.
554 */
555 static bool GetVerbose();
556
557 /**
558 The functions in this section work with and manipulate the active log target.
559 The OnLog() is called by the @e wxLogXXX() functions
560 and invokes the DoLog() of the active log target if any.
561 Get/Set methods are used to install/query the current active target and,
562 finally, DontCreateOnDemand() disables the
563 automatic creation of a standard log target if none actually exists. It is
564 only useful when the application is terminating and shouldn't be used in other
565 situations because it may easily lead to a loss of messages.
23324ae1 566 OnLog()
3c4f71cc 567
23324ae1 568 GetActiveTarget()
3c4f71cc 569
23324ae1 570 SetActiveTarget()
3c4f71cc 571
23324ae1 572 DontCreateOnDemand()
3c4f71cc 573
23324ae1 574 Suspend()
3c4f71cc 575
23324ae1
FM
576 Resume()
577 */
578
579
580 /**
4cc4bfaf 581 Returns @true if the @a mask is one of allowed masks for
e54c96f1 582 wxLogTrace().
23324ae1
FM
583 See also: AddTraceMask(),
584 RemoveTraceMask()
585 */
586 static bool IsAllowedTraceMask(const wxString& mask);
587
588 /**
589 There are two functions which must be implemented by any derived class to
590 actually process the log messages: DoLog() and
591 DoLogString(). The second function receives a string
592 which just has to be output in some way and the easiest way to write a new log
593 target is to override just this function in the derived class. If more control
594 over the output format is needed, then the first function must be overridden
595 which allows to construct custom messages depending on the log level or even
596 do completely different things depending on the message severity (for example,
597 throw away all messages except warnings and errors, show warnings on the
598 screen and forward the error messages to the user's (or programmer's) cell
599 phone - maybe depending on whether the timestamp tells us if it is day or
600 night in the current time zone).
23324ae1
FM
601 There also functions to support message buffering. Why are they needed?
602 Some of wxLog implementations, most notably the standard wxLogGui class,
603 buffer the messages (for example, to avoid showing the user a zillion of modal
604 message boxes one after another -- which would be really annoying).
605 Flush() shows them all and clears the buffer contents.
606 This function doesn't do anything if the buffer is already empty.
23324ae1 607 Flush()
3c4f71cc 608
23324ae1
FM
609 FlushActive()
610 */
611
612
613 /**
614 Forwards the message at specified level to the @e DoLog() function of the
615 active log target if there is any, does nothing otherwise.
616 */
617 static void OnLog(wxLogLevel level, const wxString& message);
618
619 /**
4cc4bfaf 620 Remove the @a mask from the list of allowed masks for
e54c96f1 621 wxLogTrace().
23324ae1
FM
622 See also: AddTraceMask()
623 */
624 static void RemoveTraceMask(const wxString& mask);
625
626 /**
627 Resumes logging previously suspended by a call to
628 Suspend(). All messages logged in the meanwhile will be
629 flushed soon.
630 */
631 static void Resume();
632
633 /**
634 Sets the specified log target as the active one. Returns the pointer to the
635 previous active log target (may be @NULL). To suppress logging use a new
636 instance of wxLogNull not @NULL. If the active log target is set to @NULL a
637 new default log target will be created when logging occurs.
638 */
4cc4bfaf 639 static wxLog* SetActiveTarget(wxLog* logtarget);
23324ae1
FM
640
641 /**
642 Specifies that log messages with level logLevel should be ignored
643 and not sent to the active log target.
644 */
645 static void SetLogLevel(wxLogLevel logLevel);
646
647 /**
648 Enables logging mode in which a log message is logged once, and in case exactly
7c913512 649 the same message successively repeats one or more times, only the number of
23324ae1
FM
650 repetitions is logged.
651 */
4cc4bfaf 652 static void SetRepetitionCounting(bool repetCounting = true);
23324ae1
FM
653
654 /**
655 Sets the timestamp format prepended by the default log targets to all
656 messages. The string may contain any normal characters as well as %
657 prefixed format specificators, see @e strftime() manual for details.
658 Passing an empty string to this function disables message time stamping.
659 */
660 static void SetTimestamp(const wxString& format);
661
662 /**
663 Sets the trace mask, see Customization()
664 section for details.
665 */
666 static void SetTraceMask(wxTraceMask mask);
667
668 /**
669 Activates or deactivates verbose mode in which the verbose messages are
670 logged as the normal ones instead of being silently dropped.
671 */
4cc4bfaf 672 static void SetVerbose(bool verbose = true);
23324ae1
FM
673
674 /**
675 Suspends the logging until Resume() is called. Note that
676 the latter must be called the same number of times as the former to undo it,
677 i.e. if you call Suspend() twice you must call Resume() twice as well.
23324ae1
FM
678 Note that suspending the logging means that the log sink won't be be flushed
679 periodically, it doesn't have any effect if the current log target does the
680 logging immediately without waiting for Flush() to be
681 called (the standard GUI log target only shows the log dialog when it is
682 flushed, so Suspend() works as expected with it).
3c4f71cc 683
4cc4bfaf 684 @see Resume(), wxLogNull
23324ae1
FM
685 */
686 static void Suspend();
687};
688
689
e54c96f1 690
23324ae1
FM
691/**
692 @class wxLogNull
693 @wxheader{log.h}
7c913512 694
23324ae1
FM
695 This class allows to temporarily suspend logging. All calls to the log
696 functions during the life time of an object of this class are just ignored.
7c913512 697
23324ae1
FM
698 In particular, it can be used to suppress the log messages given by wxWidgets
699 itself but it should be noted that it is rarely the best way to cope with this
700 problem as @b all log messages are suppressed, even if they indicate a
701 completely different error than the one the programmer wanted to suppress.
7c913512 702
23324ae1 703 For instance, the example of the overview:
7c913512 704
23324ae1
FM
705 @code
706 wxFile file;
7c913512 707
23324ae1
FM
708 // wxFile.Open() normally complains if file can't be opened, we don't want it
709 {
710 wxLogNull logNo;
711 if ( !file.Open("bar") )
712 ... process error ourselves ...
713 } // ~wxLogNull called, old log sink restored
7c913512 714
23324ae1
FM
715 wxLogMessage("..."); // ok
716 @endcode
7c913512 717
23324ae1 718 would be better written as:
7c913512 719
23324ae1
FM
720 @code
721 wxFile file;
7c913512 722
23324ae1
FM
723 // don't try to open file if it doesn't exist, we are prepared to deal with
724 // this ourselves - but all other errors are not expected
725 if ( wxFile::Exists("bar") )
726 {
727 // gives an error message if the file couldn't be opened
728 file.Open("bar");
729 }
730 else
731 {
732 ...
733 }
734 @endcode
7c913512
FM
735
736
23324ae1
FM
737 @library{wxbase}
738 @category{logging}
739*/
740class wxLogNull : public wxLog
741{
742public:
743 /**
744 Suspends logging.
745 */
746 wxLogNull();
747
748 /**
749 Resumes logging.
750 */
751};
752
753
e54c96f1 754
23324ae1
FM
755// ============================================================================
756// Global functions/macros
757// ============================================================================
758
759/**
760 This function shows a message to the user in a safe way and should be safe to
761 call even before the application has been initialized or if it is currently in
762 some other strange state (for example, about to crash). Under Windows this
763 function shows a message box using a native dialog instead of
e54c96f1 764 wxMessageBox() (which might be unsafe to call), elsewhere
23324ae1 765 it simply prints the message to the standard output using the title as prefix.
7c913512
FM
766
767 @param title
4cc4bfaf
FM
768 The title of the message box shown to the user or the prefix
769 of the message string
7c913512 770 @param text
4cc4bfaf 771 The text to show to the user
7c913512 772
e54c96f1 773 @see wxLogFatalError()
23324ae1
FM
774*/
775void wxSafeShowMessage(const wxString& title,
776 const wxString& text);
777
96d7cc9b
FM
778
779
780//@{
781/**
782 For all normal, informational messages. They also appear in a message box by
783 default (but it can be changed).
784*/
785void wxLogMessage(const char* formatString, ... );
786void wxVLogMessage(const char* formatString, va_list argPtr);
787//@}
788
789//@{
790/**
791 For verbose output. Normally, it is suppressed, but
792 might be activated if the user wishes to know more details about the program
793 progress (another, but possibly confusing name for the same function is @b
794 wxLogInfo).
795*/
796void wxLogVerbose(const char* formatString, ... );
797void wxVLogVerbose(const char* formatString, va_list argPtr);
798//@}
799
800//@{
801/**
802 For warnings - they are also normally shown to the user, but don't interrupt
803 the program work.
804*/
805void wxLogWarning(const char* formatString, ... );
806void wxVLogWarning(const char* formatString, va_list argPtr);
807//@}
808
809//@{
810/**
811 Like wxLogError(), but also
812 terminates the program with the exit code 3. Using @e abort() standard
813 function also terminates the program with this exit code.
814*/
815void wxLogFatalError(const char* formatString, ... );
816void wxVLogFatalError(const char* formatString,
817 va_list argPtr);
818//@}
819
820//@{
821/**
822 The functions to use for error messages, i.e. the messages that must be shown
823 to the user. The default processing is to pop up a message box to inform the
824 user about it.
825*/
826void wxLogError(const char* formatString, ... );
827void wxVLogError(const char* formatString, va_list argPtr);
828//@}
829
830
831//@{
832/**
833 As @b wxLogDebug, trace functions only do something in debug build and
834 expand to nothing in the release one. The reason for making
835 it a separate function from it is that usually there are a lot of trace
836 messages, so it might make sense to separate them from other debug messages.
837 The trace messages also usually can be separated into different categories and
838 the second and third versions of this function only log the message if the
839 @a mask which it has is currently enabled in wxLog. This
840 allows to selectively trace only some operations and not others by changing
841 the value of the trace mask (possible during the run-time).
842 For the second function (taking a string mask), the message is logged only if
843 the mask has been previously enabled by the call to
844 wxLog::AddTraceMask or by setting
845 @ref overview_envvars "@c WXTRACE environment variable".
846 The predefined string trace masks
847 used by wxWidgets are:
848 wxTRACE_MemAlloc: trace memory allocation (new/delete)
849 wxTRACE_Messages: trace window messages/X callbacks
850 wxTRACE_ResAlloc: trace GDI resource allocation
851 wxTRACE_RefCount: trace various ref counting operations
852 wxTRACE_OleCalls: trace OLE method calls (Win32 only)
853 @b Caveats: since both the mask and the format string are strings,
854 this might lead to function signature confusion in some cases:
855 if you intend to call the format string only version of wxLogTrace,
856 then add a %s format string parameter and then supply a second string parameter
857 for that %s, the string mask version of wxLogTrace will erroneously get called instead, since you are supplying two string parameters to the function.
858 In this case you'll unfortunately have to avoid having two leading
859 string parameters, e.g. by adding a bogus integer (with its %d format string).
860 The third version of the function only logs the message if all the bits
861 corresponding to the @a mask are set in the wxLog trace mask which can be
862 set by wxLog::SetTraceMask. This version is less
863 flexible than the previous one because it doesn't allow defining the user
864 trace masks easily - this is why it is deprecated in favour of using string
865 trace masks.
866 wxTraceMemAlloc: trace memory allocation (new/delete)
867 wxTraceMessages: trace window messages/X callbacks
868 wxTraceResAlloc: trace GDI resource allocation
869 wxTraceRefCount: trace various ref counting operations
870 wxTraceOleCalls: trace OLE method calls (Win32 only)
871*/
872void wxLogTrace(const char* formatString, ... );
873void wxVLogTrace(const char* formatString, va_list argPtr);
874void wxLogTrace(const char* mask, const char* formatString,
875 ... );
876void wxVLogTrace(const char* mask,
877 const char* formatString,
878 va_list argPtr);
879void wxLogTrace(wxTraceMask mask, const char* formatString,
880 ... );
881void wxVLogTrace(wxTraceMask mask, const char* formatString,
882 va_list argPtr);
883//@}
884
885
886//@{
887/**
888 The right functions for debug output. They only do something in debug
889 mode (when the preprocessor symbol __WXDEBUG__ is defined) and expand to
890 nothing in release mode (otherwise).
891*/
892void wxLogDebug(const char* formatString, ... );
893void wxVLogDebug(const char* formatString, va_list argPtr);
894//@}
895
896
897//@{
898/**
899 Messages logged by these functions will appear in the statusbar of the @a frame
900 or of the top level application window by default (i.e. when using
901 the second version of the functions).
902 If the target frame doesn't have a statusbar, the message will be lost.
903*/
904void wxLogStatus(wxFrame* frame, const char* formatString,
905 ... );
906void wxVLogStatus(wxFrame* frame, const char* formatString,
907 va_list argPtr);
908void wxLogStatus(const char* formatString, ... );
909void wxVLogStatus(const char* formatString, va_list argPtr);
910//@}
911
912
913//@{
914/**
915 Mostly used by wxWidgets itself, but might be handy for logging errors after
916 system call (API function) failure. It logs the specified message text as well
917 as the last system error code (@e errno or @e ::GetLastError() depending
918 on the platform) and the corresponding error message. The second form
919 of this function takes the error code explicitly as the first argument.
920
921 @see wxSysErrorCode(), wxSysErrorMsg()
922*/
923void wxLogSysError(const char* formatString, ... );
924void wxVLogSysError(const char* formatString,
925 va_list argPtr);
39fb8056
FM
926//@}
927
928
929/**
930 Returns the error code from the last system call. This function uses
931 @c errno on Unix platforms and @c GetLastError under Win32.
932
933 @see wxSysErrorMsg(), wxLogSysError()
934*/
935unsigned long wxSysErrorCode();
936
937
938/**
939 Returns the error message corresponding to the given system error code. If
940 @a errCode is 0 (default), the last error code (as returned by
941 wxSysErrorCode()) is used.
942
943 @see wxSysErrorCode(), wxLogSysError()
944*/
945const wxChar* wxSysErrorMsg(unsigned long errCode = 0);
946
947