/////////////////////////////////////////////////////////////////////////////
// Name: log.h
-// Purpose: documentation for wxLogWindow class
+// Purpose: interface of wxLogWindow
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxLogWindow
@wxheader{log.h}
-
+
This class represents a background log window: to be precise, it collects all
log messages in the log frame which it manages but also passes them on to the
log target which was active at the moment of its creation. This allows, for
example, to show all the log messages in a frame but still continue to process
them normally by showing the standard log dialog.
-
+
@library{wxbase}
@category{logging}
-
- @seealso
- wxLogTextCtrl
+
+ @see wxLogTextCtrl
*/
class wxLogWindow : public wxLogInterposer
{
public:
/**
Creates the log frame window and starts collecting the messages in it.
-
- @param parent
- The parent window for the log frame, may be @NULL
-
- @param title
- The title for the log frame
-
- @param show
- @true to show the frame initially (default), otherwise
- Show() must be called later.
-
- @param passToOld
- @true to process the log messages normally in addition to
- logging them in the log frame (default), @false to only log them in the
- log frame.
- */
- wxLogWindow(wxFrame parent, const wxChar title, bool show = @true,
- bool passToOld = @true);
+
+ @param parent
+ The parent window for the log frame, may be @NULL
+ @param title
+ The title for the log frame
+ @param show
+ @true to show the frame initially (default), otherwise
+ Show() must be called later.
+ @param passToOld
+ @true to process the log messages normally in addition to
+ logging them in the log frame (default), @false to only log them in the
+ log frame.
+ */
+ wxLogWindow(wxFrame parent, const wxChar title, bool show = true,
+ bool passToOld = true);
/**
Returns the associated log frame window. This may be used to position or resize
it but use Show() to show or hide it.
*/
- wxFrame * GetFrame();
+ wxFrame* GetFrame() const;
/**
Called if the user closes the window interactively, will not be
called if it is destroyed for another reason (such as when program
exits).
-
Return @true from here to allow the frame to close, @false to
prevent this from happening.
-
- @sa OnFrameDelete()
+
+ @see OnFrameDelete()
*/
virtual bool OnFrameClose(wxFrame frame);
/**
Shows or hides the frame.
*/
- void Show(bool show = @true);
+ void Show(bool show = true);
};
+
/**
@class wxLogInterposerTemp
@wxheader{log.h}
-
+
A special version of wxLogChain which uses itself as the
new log target. It forwards log messages to the previously installed one in
addition to
processing them itself. Unlike wxLogInterposer, it doesn't
delete the old target which means it can be used to temporarily redirect log
output.
-
+
As per wxLogInterposer, this class must be derived from to implement
wxLog::DoLog
and/or wxLog::DoLogString methods.
-
+
@library{wxbase}
@category{logging}
*/
};
+
/**
@class wxLogChain
@wxheader{log.h}
-
+
This simple class allows to chain log sinks, that is to install a new sink but
keep passing log messages to the old one instead of replacing it completely as
wxLog::SetActiveTarget does.
-
+
It is especially useful when you want to divert the logs somewhere (for
example to a file or a log window) but also keep showing the error messages
using the standard dialogs as wxLogGui does by default.
-
+
Example of usage:
-
+
@code
wxLogChain *logChain = new wxLogChain(new wxLogStderr);
-
+
// all the log messages are sent to stderr and also processed as usually
...
-
+
// don't delete logChain directly as this would leave a dangling
// pointer as active log target, use SetActiveTarget() instead
delete wxLog::SetActiveTarget(...something else or @NULL...);
@endcode
-
+
@library{wxbase}
@category{logging}
*/
Sets the specified @c logger (which may be @NULL) as the default log
target but the log messages are also passed to the previous log target if any.
*/
- wxLogChain(wxLog * logger);
+ wxLogChain(wxLog* logger);
/**
Destroys the previous log target.
/**
Returns the pointer to the previously active log target (which may be @NULL).
*/
- wxLog * GetOldLog();
+ wxLog* GetOldLog() const;
/**
Returns @true if the messages are passed to the previously active log
target (default) or @false if PassMessages()
had been called.
*/
- bool IsPassingMessages();
+ bool IsPassingMessages() const;
/**
By default, the log messages are passed to the previously active log target.
Calling this function with @false parameter disables this behaviour
(presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
- it can be reenabled by calling it again with @e passMessages set to @true.
+ it can be reenabled by calling it again with @a passMessages set to @true.
*/
void PassMessages(bool passMessages);
Sets another log target to use (may be @NULL). The log target specified
in the @ref ctor() constructor or in a previous call to
this function is deleted.
-
This doesn't change the old log target value (the one the messages are
forwarded to) which still remains the same as was active when wxLogChain
object was created.
*/
- void SetLog(wxLog * logger);
+ void SetLog(wxLog* logger);
};
+
/**
@class wxLogGui
@wxheader{log.h}
-
+
This is the default log target for the GUI wxWidgets applications. It is passed
to wxLog::SetActiveTarget at the program
startup and is deleted by wxWidgets during the program shut down.
-
+
@library{wxbase}
@category{logging}
*/
};
+
/**
@class wxLogStream
@wxheader{log.h}
-
+
This class can be used to redirect the log messages to a C++ stream.
-
+
Please note that this class is only available if wxWidgets was compiled with
the standard iostream library support (@c wxUSE_STD_IOSTREAM must be on).
-
+
@library{wxbase}
@category{logging}
-
- @seealso
- wxLogStderr, wxStreamToTextRedirector
+
+ @see wxLogStderr, wxStreamToTextRedirector
*/
class wxLogStream : public wxLog
{
Constructs a log target which sends all the log messages to the given
output stream. If it is @NULL, the messages are sent to @c cerr.
*/
- wxLogStream(std::ostream ostr = @NULL);
+ wxLogStream(std::ostream ostr = NULL);
};
+
/**
@class wxLogStderr
@wxheader{log.h}
-
+
This class can be used to redirect the log messages to a C file stream (not to
be confused with C++ streams). It is the default log target for the non-GUI
wxWidgets applications which send all the output to @c stderr.
-
+
@library{wxbase}
@category{logging}
-
- @seealso
- wxLogStream
+
+ @see wxLogStream
*/
class wxLogStderr : public wxLog
{
Constructs a log target which sends all the log messages to the given
@c FILE. If it is @NULL, the messages are sent to @c stderr.
*/
- wxLogStderr(FILE fp = @NULL);
+ wxLogStderr(FILE fp = NULL);
};
+
/**
@class wxLogBuffer
@wxheader{log.h}
-
+
wxLogBuffer is a very simple implementation of log sink which simply collects
all the logged messages in a string (except the debug messages which are output
in the usual way immediately as we're presumably not interested in collecting
them for later). The messages from different log function calls are separated
by the new lines.
-
+
All the messages collected so far can be shown to the user (and the current
- buffer cleared) by calling the overloaded wxLogBuffer::Flush
+ buffer cleared) by calling the overloaded wxLogBuffer::Flush
method.
-
+
@library{wxbase}
@category{FIXME}
*/
/**
Returns the current buffer contains. Messages from different log function calls
are separated with the new lines in the buffer.
-
The buffer can be cleared by Flush() which will
also show the current contents to the user.
*/
};
+
/**
@class wxLogInterposer
@wxheader{log.h}
-
+
A special version of wxLogChain which uses itself as the
new log target. It forwards log messages to the previously installed one in
addition to
processing them itself.
-
+
Unlike wxLogChain which is usually used directly as is,
this class must be derived from to implement wxLog::DoLog
and/or wxLog::DoLogString methods.
-
+
wxLogInterposer destroys the previous log target in its destructor. If you
don't want this to happen, use wxLogInterposerTemp instead.
-
+
@library{wxbase}
@category{logging}
*/
};
+
/**
@class wxLogTextCtrl
@wxheader{log.h}
-
+
Using these target all the log messages can be redirected to a text control.
The text control must have been created with @c wxTE_MULTILINE style by the
caller previously.
-
+
@library{wxbase}
@category{logging}
-
- @seealso
- wxTextCtrl, wxStreamToTextRedirector
+
+ @see wxTextCtrl, wxStreamToTextRedirector
*/
class wxLogTextCtrl : public wxLog
{
public:
/**
Constructs a log target which sends all the log messages to the given text
- control. The @e textctrl parameter cannot be @NULL.
+ control. The @a textctrl parameter cannot be @NULL.
*/
wxLogTextCtrl(wxTextCtrl textctrl);
};
+
/**
@class wxLog
@wxheader{log.h}
-
+
wxLog class defines the interface for the @e log targets used by wxWidgets
logging functions as explained in the @ref overview_wxlogoverview "wxLog
overview".
logging classes (all of which respect the wxLog settings): for example, set
which trace messages are logged and which are not or change (or even remove
completely) the timestamp on the messages.
-
+
Otherwise, it is completely hidden behind the @e wxLogXXX() functions and
you may not even know about its existence.
-
+
See @ref overview_wxlogoverview "log overview" for the descriptions of wxWidgets
logging facilities.
-
+
@library{wxcore}
@category{logging}
-
- @seealso
- wxLog::RemoveTraceMask, wxLog::GetTraceMasks
+
+ @see wxLog::RemoveTraceMask, wxLog::GetTraceMasks
*/
-class wxLog
+class wxLog
{
public:
/**
- Add the @e mask to the list of allowed masks for
- wxLogTrace.
-
- @sa RemoveTraceMask(), GetTraceMasks()
+ Add the @a mask to the list of allowed masks for
+ wxLogTrace().
+
+ @see RemoveTraceMask(), GetTraceMasks()
*/
static void AddTraceMask(const wxString& mask);
/**
Removes all trace masks previously set with
AddTraceMask().
-
- @sa RemoveTraceMask()
+
+ @see RemoveTraceMask()
*/
static void ClearTraceMasks();
The functions below allow some limited customization of wxLog behaviour
without writing a new log target class (which, aside of being a matter of
several minutes, allows you to do anything you want).
-
The verbose messages are the trace messages which are not disabled in the
- release mode and are generated by wxLogVerbose. They
+ release mode and are generated by wxLogVerbose(). They
are not normally shown to the user because they present little interest, but
may be activated, for example, in order to help the user find some program
problem.
-
As for the (real) trace messages, their handling depends on the settings of
the (application global) @e trace mask. There are two ways to specify it:
either by using SetTraceMask() and
GetTraceMask() and using
- wxLogTrace which takes an integer mask or by using
+ wxLogTrace() which takes an integer mask or by using
AddTraceMask() for string trace masks.
-
The difference between bit-wise and string trace masks is that a message using
integer trace mask will only be logged if all bits of the mask are set in the
current mask while a message using string mask will be logged simply if the
mask had been added before to the list of allowed ones.
-
For example,
+
will do something only if the current trace mask contains both
@c wxTraceRefCount and @c wxTraceOle, but
+
will log the message if it was preceded by
+
Using string masks is simpler and allows to easily add custom ones, so this is
the preferred way of working with trace messages. The integer trace mask is
kept for compatibility and for additional (but very rarely needed) flexibility
only.
-
- The standard trace masks are given in wxLogTrace
+ The standard trace masks are given in wxLogTrace()
documentation.
-
Finally, the @e wxLog::DoLog() function automatically prepends a time stamp
to all the messages. The format of the time stamp may be changed: it can be
any string with % specifications fully described in the documentation of the
"[%d/%b/%y %H:%M:%S] " which gives something like "[17/Sep/98 22:10:16] "
(without quotes) for the current date. Setting an empty string as the time
format disables timestamping of the messages completely.
-
@b NB: Timestamping is disabled for Visual C++ users in debug builds by
default because otherwise it would be impossible to directly go to the line
from which the log message was generated by simply clicking in the debugger
window on the corresponding error message. If you wish to enable it, please use
SetTimestamp() explicitly.
-
AddTraceMask()
-
+
RemoveTraceMask()
-
+
ClearTraceMasks()
-
+
GetTraceMasks()
-
+
IsAllowedTraceMask()
-
+
SetVerbose()
-
+
GetVerbose()
-
+
SetTimestamp()
-
+
GetTimestamp()
-
+
SetTraceMask()
-
+
GetTraceMask()
-
+
SetRepetitionCounting()
-
+
GetRepetitionCounting()
*/
/**
Disables time stamping of the log messages.
-
This function is new since wxWidgets version 2.9
*/
void SetTimestamp(const wxString& format);
/**
- Called to process the message of the specified severity. @e msg is the text
+ Called to process the message of the specified severity. @a msg is the text
of the message as specified in the call of @e wxLogXXX() function which
- generated it and @e timestamp is the moment when the message was generated.
-
+ generated it and @a timestamp is the moment when the message was generated.
The base class version prepends the timestamp to the message, adds a prefix
corresponding to the log level and then calls
DoLogString() with the resulting string.
/**
Called to log the specified string. The timestamp is already included in the
string but still passed to this function.
-
A simple implementation may just send the string to @c stdout or, better,
@c stderr.
*/
Instructs wxLog to not create new log targets on the fly if there is none
currently. (Almost) for internal use only: it is supposed to be called by the
application shutdown code.
-
Note that this function also calls
ClearTraceMasks().
*/
/**
Flushes the current log target if any, does nothing if there is none.
-
- @sa Flush()
+
+ @see Flush()
*/
static void FlushActive();
/**
Returns the pointer to the active log target (may be @NULL).
*/
- static wxLog * GetActiveTarget();
+ static wxLog* GetActiveTarget();
/**
Returns the current log level limit.
/**
Returns the currently allowed list of string trace masks.
-
- @sa AddTraceMask().
+
+ @see AddTraceMask().
*/
static const wxArrayString GetTraceMasks();
automatic creation of a standard log target if none actually exists. It is
only useful when the application is terminating and shouldn't be used in other
situations because it may easily lead to a loss of messages.
-
OnLog()
-
+
GetActiveTarget()
-
+
SetActiveTarget()
-
+
DontCreateOnDemand()
-
+
Suspend()
-
+
Resume()
*/
/**
- Returns @true if the @e mask is one of allowed masks for
- wxLogTrace.
-
+ Returns @true if the @a mask is one of allowed masks for
+ wxLogTrace().
See also: AddTraceMask(),
RemoveTraceMask()
*/
screen and forward the error messages to the user's (or programmer's) cell
phone - maybe depending on whether the timestamp tells us if it is day or
night in the current time zone).
-
There also functions to support message buffering. Why are they needed?
Some of wxLog implementations, most notably the standard wxLogGui class,
buffer the messages (for example, to avoid showing the user a zillion of modal
message boxes one after another -- which would be really annoying).
Flush() shows them all and clears the buffer contents.
This function doesn't do anything if the buffer is already empty.
-
Flush()
-
+
FlushActive()
*/
static void OnLog(wxLogLevel level, const wxString& message);
/**
- Remove the @e mask from the list of allowed masks for
- wxLogTrace.
-
+ Remove the @a mask from the list of allowed masks for
+ wxLogTrace().
See also: AddTraceMask()
*/
static void RemoveTraceMask(const wxString& mask);
instance of wxLogNull not @NULL. If the active log target is set to @NULL a
new default log target will be created when logging occurs.
*/
- static wxLog * SetActiveTarget(wxLog * logtarget);
+ static wxLog* SetActiveTarget(wxLog* logtarget);
/**
Specifies that log messages with level logLevel should be ignored
/**
Enables logging mode in which a log message is logged once, and in case exactly
- the same message successively repeats one or more times, only the number of
+ the same message successively repeats one or more times, only the number of
repetitions is logged.
*/
- static void SetRepetitionCounting(bool repetCounting = @true);
+ static void SetRepetitionCounting(bool repetCounting = true);
/**
Sets the timestamp format prepended by the default log targets to all
Activates or deactivates verbose mode in which the verbose messages are
logged as the normal ones instead of being silently dropped.
*/
- static void SetVerbose(bool verbose = @true);
+ static void SetVerbose(bool verbose = true);
/**
Suspends the logging until Resume() is called. Note that
the latter must be called the same number of times as the former to undo it,
i.e. if you call Suspend() twice you must call Resume() twice as well.
-
Note that suspending the logging means that the log sink won't be be flushed
periodically, it doesn't have any effect if the current log target does the
logging immediately without waiting for Flush() to be
called (the standard GUI log target only shows the log dialog when it is
flushed, so Suspend() works as expected with it).
-
- @sa Resume(), wxLogNull
+
+ @see Resume(), wxLogNull
*/
static void Suspend();
};
+
/**
@class wxLogNull
@wxheader{log.h}
-
+
This class allows to temporarily suspend logging. All calls to the log
functions during the life time of an object of this class are just ignored.
-
+
In particular, it can be used to suppress the log messages given by wxWidgets
itself but it should be noted that it is rarely the best way to cope with this
problem as @b all log messages are suppressed, even if they indicate a
completely different error than the one the programmer wanted to suppress.
-
+
For instance, the example of the overview:
-
+
@code
wxFile file;
-
+
// wxFile.Open() normally complains if file can't be opened, we don't want it
{
wxLogNull logNo;
if ( !file.Open("bar") )
... process error ourselves ...
} // ~wxLogNull called, old log sink restored
-
+
wxLogMessage("..."); // ok
@endcode
-
+
would be better written as:
-
+
@code
wxFile file;
-
+
// don't try to open file if it doesn't exist, we are prepared to deal with
// this ourselves - but all other errors are not expected
if ( wxFile::Exists("bar") )
...
}
@endcode
-
-
+
+
@library{wxbase}
@category{logging}
*/
};
+
// ============================================================================
// Global functions/macros
// ============================================================================
call even before the application has been initialized or if it is currently in
some other strange state (for example, about to crash). Under Windows this
function shows a message box using a native dialog instead of
- wxMessageBox (which might be unsafe to call), elsewhere
+ wxMessageBox() (which might be unsafe to call), elsewhere
it simply prints the message to the standard output using the title as prefix.
-
- @param title
- The title of the message box shown to the user or the prefix
- of the message string
-
- @param text
- The text to show to the user
-
- @sa wxLogFatalError
+
+ @param title
+ The title of the message box shown to the user or the prefix
+ of the message string
+ @param text
+ The text to show to the user
+
+ @see wxLogFatalError()
*/
void wxSafeShowMessage(const wxString& title,
const wxString& text);
+
+
+//@{
+/**
+ For all normal, informational messages. They also appear in a message box by
+ default (but it can be changed).
+*/
+void wxLogMessage(const char* formatString, ... );
+void wxVLogMessage(const char* formatString, va_list argPtr);
+//@}
+
+//@{
+/**
+ For verbose output. Normally, it is suppressed, but
+ might be activated if the user wishes to know more details about the program
+ progress (another, but possibly confusing name for the same function is @b
+ wxLogInfo).
+*/
+void wxLogVerbose(const char* formatString, ... );
+void wxVLogVerbose(const char* formatString, va_list argPtr);
+//@}
+
+//@{
+/**
+ For warnings - they are also normally shown to the user, but don't interrupt
+ the program work.
+*/
+void wxLogWarning(const char* formatString, ... );
+void wxVLogWarning(const char* formatString, va_list argPtr);
+//@}
+
+//@{
+/**
+ Like wxLogError(), but also
+ terminates the program with the exit code 3. Using @e abort() standard
+ function also terminates the program with this exit code.
+*/
+void wxLogFatalError(const char* formatString, ... );
+void wxVLogFatalError(const char* formatString,
+ va_list argPtr);
+//@}
+
+//@{
+/**
+ The functions to use for error messages, i.e. the messages that must be shown
+ to the user. The default processing is to pop up a message box to inform the
+ user about it.
+*/
+void wxLogError(const char* formatString, ... );
+void wxVLogError(const char* formatString, va_list argPtr);
+//@}
+
+
+//@{
+/**
+ As @b wxLogDebug, trace functions only do something in debug build and
+ expand to nothing in the release one. The reason for making
+ it a separate function from it is that usually there are a lot of trace
+ messages, so it might make sense to separate them from other debug messages.
+ The trace messages also usually can be separated into different categories and
+ the second and third versions of this function only log the message if the
+ @a mask which it has is currently enabled in wxLog. This
+ allows to selectively trace only some operations and not others by changing
+ the value of the trace mask (possible during the run-time).
+ For the second function (taking a string mask), the message is logged only if
+ the mask has been previously enabled by the call to
+ wxLog::AddTraceMask or by setting
+ @ref overview_envvars "@c WXTRACE environment variable".
+ The predefined string trace masks
+ used by wxWidgets are:
+ wxTRACE_MemAlloc: trace memory allocation (new/delete)
+ wxTRACE_Messages: trace window messages/X callbacks
+ wxTRACE_ResAlloc: trace GDI resource allocation
+ wxTRACE_RefCount: trace various ref counting operations
+ wxTRACE_OleCalls: trace OLE method calls (Win32 only)
+ @b Caveats: since both the mask and the format string are strings,
+ this might lead to function signature confusion in some cases:
+ if you intend to call the format string only version of wxLogTrace,
+ then add a %s format string parameter and then supply a second string parameter
+ for that %s, the string mask version of wxLogTrace will erroneously get called instead, since you are supplying two string parameters to the function.
+ In this case you'll unfortunately have to avoid having two leading
+ string parameters, e.g. by adding a bogus integer (with its %d format string).
+ The third version of the function only logs the message if all the bits
+ corresponding to the @a mask are set in the wxLog trace mask which can be
+ set by wxLog::SetTraceMask. This version is less
+ flexible than the previous one because it doesn't allow defining the user
+ trace masks easily - this is why it is deprecated in favour of using string
+ trace masks.
+ wxTraceMemAlloc: trace memory allocation (new/delete)
+ wxTraceMessages: trace window messages/X callbacks
+ wxTraceResAlloc: trace GDI resource allocation
+ wxTraceRefCount: trace various ref counting operations
+ wxTraceOleCalls: trace OLE method calls (Win32 only)
+*/
+void wxLogTrace(const char* formatString, ... );
+void wxVLogTrace(const char* formatString, va_list argPtr);
+void wxLogTrace(const char* mask, const char* formatString,
+ ... );
+void wxVLogTrace(const char* mask,
+ const char* formatString,
+ va_list argPtr);
+void wxLogTrace(wxTraceMask mask, const char* formatString,
+ ... );
+void wxVLogTrace(wxTraceMask mask, const char* formatString,
+ va_list argPtr);
+//@}
+
+
+//@{
+/**
+ The right functions for debug output. They only do something in debug
+ mode (when the preprocessor symbol __WXDEBUG__ is defined) and expand to
+ nothing in release mode (otherwise).
+*/
+void wxLogDebug(const char* formatString, ... );
+void wxVLogDebug(const char* formatString, va_list argPtr);
+//@}
+
+
+//@{
+/**
+ Messages logged by these functions will appear in the statusbar of the @a frame
+ or of the top level application window by default (i.e. when using
+ the second version of the functions).
+ If the target frame doesn't have a statusbar, the message will be lost.
+*/
+void wxLogStatus(wxFrame* frame, const char* formatString,
+ ... );
+void wxVLogStatus(wxFrame* frame, const char* formatString,
+ va_list argPtr);
+void wxLogStatus(const char* formatString, ... );
+void wxVLogStatus(const char* formatString, va_list argPtr);
+//@}
+
+
+//@{
+/**
+ Mostly used by wxWidgets itself, but might be handy for logging errors after
+ system call (API function) failure. It logs the specified message text as well
+ as the last system error code (@e errno or @e ::GetLastError() depending
+ on the platform) and the corresponding error message. The second form
+ of this function takes the error code explicitly as the first argument.
+
+ @see wxSysErrorCode(), wxSysErrorMsg()
+*/
+void wxLogSysError(const char* formatString, ... );
+void wxVLogSysError(const char* formatString,
+ va_list argPtr);
+//@}
+
+
+/**
+ Returns the error code from the last system call. This function uses
+ @c errno on Unix platforms and @c GetLastError under Win32.
+
+ @see wxSysErrorMsg(), wxLogSysError()
+*/
+unsigned long wxSysErrorCode();
+
+
+/**
+ Returns the error message corresponding to the given system error code. If
+ @a errCode is 0 (default), the last error code (as returned by
+ wxSysErrorCode()) is used.
+
+ @see wxSysErrorCode(), wxLogSysError()
+*/
+const wxChar* wxSysErrorMsg(unsigned long errCode = 0);
+
+
projects / wxWidgets.git / blobdiff