use wxALIGN_LEFT/CENTRE/RIGHT instead of wxTE_XXX to avoid problems with the latter...

[wxWidgets.git] / interface / wx / log.h

diff --git a/interface/wx/log.h b/interface/wx/log.h
index 9c4b772c650ceaec4cc5f5d61898909d4378f0fc..34cbf28abbf681f38222b22859790cc058d2b4de 100644 (file)
--- a/interface/wx/log.h
+++ b/interface/wx/log.h
@@ -6,6 +6,41 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

+
+/**
+    Different standard log levels (you may also define your own) used with
+    wxLog::OnLog() by standard wxLog functions wxLogError(), wxLogWarning(),
+    etc...
+*/
+enum wxLogLevelValues
+{
+    wxLOG_FatalError, //!< program can't continue, abort immediately
+    wxLOG_Error,      //!< a serious error, user must be informed about it
+    wxLOG_Warning,    //!< user is normally informed about it but may be ignored
+    wxLOG_Message,    //!< normal message (i.e. normal output of a non GUI app)
+    wxLOG_Status,     //!< informational: might go to the status line of GUI app
+    wxLOG_Info,       //!< informational message (a.k.a. 'Verbose')
+    wxLOG_Debug,      //!< never shown to the user, disabled in release mode
+    wxLOG_Trace,      //!< trace messages are also only enabled in debug mode
+    wxLOG_Progress,   //!< used for progress indicator (not yet)
+    wxLOG_User = 100, //!< user defined levels start here
+    wxLOG_Max = 10000
+};
+
+/**
+    The type used for trace masks.
+*/
+typedef unsigned long wxTraceMask;
+
+/**
+    The type used to specify a log level.
+
+    Default values of ::wxLogLevel used by wxWidgets are contained in the
+    ::wxLogLevelValues enumeration.
+*/
+typedef unsigned long wxLogLevel;
+
+

 /**
     @class wxLogWindow
 
 /**
     @class wxLogWindow
 


@@ -26,9 +61,9 @@ public:
     /**
         Creates the log frame window and starts collecting the messages in it.
 
     /**
         Creates the log frame window and starts collecting the messages in it.
 

-        @param parent
+        @param pParent

             The parent window for the log frame, may be @NULL
             The parent window for the log frame, may be @NULL

-        @param title
+        @param szTitle

             The title for the log frame
         @param show
             @true to show the frame initially (default), otherwise
             The title for the log frame
         @param show
             @true to show the frame initially (default), otherwise


@@ -396,7 +431,7 @@ public:
         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.
     */
         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);

 };
 
 
 };
 
 


@@ -405,8 +440,10 @@ public:
     @class wxLogStderr
 
     This class can be used to redirect the log messages to a C file stream (not to
     @class wxLogStderr
 
     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.
+    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}
 
     @library{wxbase}
     @category{logging}


@@ -443,6 +480,11 @@ public:
 class wxLogBuffer : public wxLog
 {
 public:
 class wxLogBuffer : public wxLog
 {
 public:

+    /**
+        The default ctor does nothing.
+    */
+    wxLogBuffer();
+

     /**
         Shows all the messages collected so far to the user (using a message box in the
         GUI applications or by printing them out to the console in text mode) and
     /**
         Shows all the messages collected so far to the user (using a message box in the
         GUI applications or by printing them out to the console in text mode) and


@@ -527,6 +569,9 @@ public:
     Otherwise, it is completely hidden behind the @e wxLogXXX() functions and
     you may not even know about its existence.
 
     Otherwise, it is completely hidden behind the @e wxLogXXX() functions and
     you may not even know about its existence.
 

+    @note For console-mode applications, the default target is wxLogStderr, so
+          that all @e wxLogXXX() functions print on @c stderr when @c wxUSE_GUI = 0.
+

 
     @section log_derivingyours Deriving your own log target
 
 
     @section log_derivingyours Deriving your own log target
 


@@ -609,7 +654,8 @@ public:
     standard @e strftime() function. For example, the default format is
     "[%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
     standard @e strftime() function. For example, the default format is
     "[%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.
+    format or calling the shortcut wxLog::DisableTimestamp(), disables timestamping
+    of the messages completely.

 
     See also
     @li AddTraceMask()
 
     See also
     @li AddTraceMask()


@@ -626,7 +672,8 @@ public:
     @li SetRepetitionCounting()
     @li GetRepetitionCounting()
 
     @li SetRepetitionCounting()
     @li GetRepetitionCounting()
 

-    @note Timestamping is disabled for Visual C++ users in debug builds by
+    @note
+    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
     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


@@ -676,33 +723,6 @@ public:
     */
     static void ClearTraceMasks();
 
     */
     static void ClearTraceMasks();
 

-    /**
-        Disables time stamping of the log messages.
-
-        @since 2.9.0
-    */
-    static void SetTimestamp(const wxString& format);
-
-    /**
-        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 @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.
-    */
-    virtual void DoLog(wxLogLevel level, const wxString& msg, time_t timestamp);
-
-    /**
-        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.
-    */
-    virtual void DoLogString(const wxString& msg, time_t timestamp);
-

     /**
         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
     /**
         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


@@ -743,7 +763,7 @@ public:
     /**
         Returns the current timestamp format string.
     */
     /**
         Returns the current timestamp format string.
     */

-    static const wxString GetTimestamp();
+    static const wxString& GetTimestamp();

 
     /**
         Returns the current trace mask, see Customization() section for details.
 
     /**
         Returns the current trace mask, see Customization() section for details.


@@ -755,7 +775,7 @@ public:
 
         @see AddTraceMask().
     */
 
         @see AddTraceMask().
     */

-    static const wxArrayString GetTraceMasks();
+    static const wxArrayString& GetTraceMasks();

 
     /**
         Returns whether the verbose mode is currently active.
 
     /**
         Returns whether the verbose mode is currently active.


@@ -773,7 +793,7 @@ public:
         Forwards the message at specified level to the @e DoLog() function of the
         active log target if there is any, does nothing otherwise.
     */
         Forwards the message at specified level to the @e DoLog() function of the
         active log target if there is any, does nothing otherwise.
     */

-    static void OnLog(wxLogLevel level, const wxString& message);
+    static void OnLog(wxLogLevel level, const wxString& msg, time_t t);

 
     /**
         Remove the @a mask from the list of allowed masks for
 
     /**
         Remove the @a mask from the list of allowed masks for


@@ -800,8 +820,8 @@ public:
     static wxLog* SetActiveTarget(wxLog* logtarget);
 
     /**
     static wxLog* SetActiveTarget(wxLog* logtarget);
 
     /**

-        Specifies that log messages with level  logLevel should be ignored
-        and not sent to the active log target.
+        Specifies that log messages with level greater (numerically) than
+        @a logLevel should be ignored and not sent to the active log target.

     */
     static void SetLogLevel(wxLogLevel logLevel);
 
     */
     static void SetLogLevel(wxLogLevel logLevel);
 


@@ -820,6 +840,13 @@ public:
     */
     static void SetTimestamp(const wxString& format);
 
     */
     static void SetTimestamp(const wxString& format);
 

+    /**
+        Disables time stamping of the log messages.
+
+        @since 2.9.0
+    */
+    static void DisableTimestamp();
+

     /**
         Sets the trace mask, see @ref log_derivingyours section for details.
     */
     /**
         Sets the trace mask, see @ref log_derivingyours section for details.
     */


@@ -846,6 +873,56 @@ public:
         @see Resume(), wxLogNull
     */
     static void Suspend();
         @see Resume(), wxLogNull
     */
     static void Suspend();

+
+    /**
+        Log the given message.
+
+        This function should only be called from the DoLog() implementations in
+        the derived classes (which can't call wxLog::DoLog() directly as it is
+        protected), it should not be used for logging new messages which can be
+        only sent to the currently active logger using OnLog() which also
+        checks if the logging (for this level) is enabled while this method
+        just directly calls DoLog().
+
+        Example of use of this class from wxLogChain:
+        @code
+        void wxLogChain::DoLog(wxLogLevel level, const wxString& msg, time_t t)
+        {
+            // let the previous logger show it
+            if ( m_logOld && IsPassingMessages() )
+                m_logOld->Log(level, msg, t);
+
+            // and also send it to the new one
+            if ( m_logNew && m_logNew != this )
+                m_logNew->Log(level, msg, t);
+        }
+        @endcode
+
+        @since 2.9.0
+     */
+    void Log(wxLogLevel level, const wxString& msg, time_t timestamp);
+
+protected:
+
+    /**
+        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 @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.
+    */
+    virtual void DoLog(wxLogLevel level, const wxString& msg, time_t timestamp);
+
+    /**
+        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.
+    */
+    virtual void DoLogString(const wxString& msg, time_t timestamp);

 };
 
 
 };
 
 


@@ -918,7 +995,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 
 /**
 //@{
 
 /**


@@ -964,7 +1041,7 @@ const wxChar* wxSysErrorMsg(unsigned long errCode = 0);
 
 //@}
 
 
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     For all normal, informational messages. They also appear in a message box
 //@{
 /**
     For all normal, informational messages. They also appear in a message box


@@ -976,7 +1053,7 @@ void wxLogMessage(const char* formatString, ... );
 void wxVLogMessage(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogMessage(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     For verbose output. Normally, it is suppressed, but might be activated if
 //@{
 /**
     For verbose output. Normally, it is suppressed, but might be activated if


@@ -989,7 +1066,7 @@ void wxLogVerbose(const char* formatString, ... );
 void wxVLogVerbose(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogVerbose(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     For warnings - they are also normally shown to the user, but don't
 //@{
 /**
     For warnings - they are also normally shown to the user, but don't


@@ -1001,7 +1078,7 @@ void wxLogWarning(const char* formatString, ... );
 void wxVLogWarning(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogWarning(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     Like wxLogError(), but also terminates the program with the exit code 3.
 //@{
 /**
     Like wxLogError(), but also terminates the program with the exit code 3.


@@ -1014,7 +1091,7 @@ void wxLogFatalError(const char* formatString, ... );
 void wxVLogFatalError(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogFatalError(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     The functions to use for error messages, i.e. the messages that must be
 //@{
 /**
     The functions to use for error messages, i.e. the messages that must be


@@ -1027,7 +1104,7 @@ void wxLogError(const char* formatString, ... );
 void wxVLogError(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogError(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and
 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and


@@ -1046,7 +1123,7 @@ void wxLogTrace(const char* formatString, ... );
 void wxVLogTrace(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogTrace(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and
 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and


@@ -1089,7 +1166,7 @@ void wxVLogTrace(const char* mask,
                   va_list argPtr);
 //@}
 
                   va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and
 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and


@@ -1097,6 +1174,7 @@ void wxVLogTrace(const char* mask,
     function is that usually there are a lot of trace messages, so it might
     make sense to separate them from other debug messages.
 
     function is that usually there are a lot of trace messages, so it might
     make sense to separate them from other debug messages.
 

+    @deprecated

     This version of wxLogTrace() 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 calling wxLog::SetTraceMask(). This version is less flexible than
     This version of wxLogTrace() 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 calling wxLog::SetTraceMask(). This version is less flexible than


@@ -1120,7 +1198,7 @@ void wxLogTrace(wxTraceMask mask, const char* formatString, ... );
 void wxVLogTrace(wxTraceMask mask, const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogTrace(wxTraceMask mask, const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     The right functions for debug output. They only do something in debug mode
 //@{
 /**
     The right functions for debug output. They only do something in debug mode


@@ -1133,7 +1211,7 @@ void wxLogDebug(const char* formatString, ... );
 void wxVLogDebug(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogDebug(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     Messages logged by this function will appear in the statusbar of the
 //@{
 /**
     Messages logged by this function will appear in the statusbar of the


@@ -1150,7 +1228,7 @@ void wxLogStatus(const char* formatString, ... );
 void wxVLogStatus(const char* formatString, va_list argPtr);
 //@}
 
 void wxVLogStatus(const char* formatString, va_list argPtr);
 //@}
 

-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */

 //@{
 /**
     Mostly used by wxWidgets itself, but might be handy for logging errors
 //@{
 /**
     Mostly used by wxWidgets itself, but might be handy for logging errors