]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/log.h
undo the last change as it results in buildbot configuration error
[wxWidgets.git] / interface / wx / log.h
index 1838d2805647d36982af6dd74f92a8834a873786..d404dafe9fb07d6492c2a158cbe68c7d3eda332a 100644 (file)
@@ -6,6 +6,36 @@
 // 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 to specify a log level.
+
+    Default values of ::wxLogLevel used by wxWidgets are contained in the
+    ::wxLogLevelValues enumeration.
+*/
+typedef unsigned long wxLogLevel;
+
+
 /**
     @class wxLogWindow
 
@@ -26,9 +56,9 @@ public:
     /**
         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
-        @param title
+        @param szTitle
             The title for the log frame
         @param show
             @true to show the frame initially (default), otherwise
@@ -38,7 +68,7 @@ public:
             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,
+    wxLogWindow(wxWindow* pParent, const wxString& szTitle, bool show = true,
                 bool passToOld = true);
 
     /**
@@ -57,19 +87,19 @@ public:
 
         @see OnFrameDelete()
     */
-    virtual bool OnFrameClose(wxFrame frame);
+    virtual bool OnFrameClose(wxFrame* frame);
 
     /**
         Called immediately after the log frame creation allowing for
         any extra initializations.
     */
-    virtual void OnFrameCreate(wxFrame frame);
+    virtual void OnFrameCreate(wxFrame* frame);
 
     /**
         Called right before the log frame is going to be deleted: will
         always be called unlike OnFrameClose().
     */
-    virtual void OnFrameDelete(wxFrame frame);
+    virtual void OnFrameDelete(wxFrame* frame);
 
     /**
         Shows or hides the frame.
@@ -396,7 +426,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.
     */
-    wxLogStream(std::ostream ostr = NULL);
+    wxLogStream(std::ostream *ostr = NULL);
 };
 
 
@@ -405,8 +435,10 @@ public:
     @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}
@@ -443,6 +475,11 @@ 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
@@ -456,7 +493,7 @@ public:
         The buffer can be cleared by Flush() which will also show the current
         contents to the user.
     */
-    const wxString GetBuffer();
+    const wxString& GetBuffer() const;
 };
 
 
@@ -527,6 +564,9 @@ public:
     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
 
@@ -568,24 +608,11 @@ public:
     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 which can either be specified using
-    SetTraceMask(), GetTraceMask() and wxLogTrace() which takes an integer mask
-    or using AddTraceMask() for string trace masks.
+    As for the (real) trace messages, their handling depends on the currently
+    enabled trace masks: if AddTraceMask() was called for the mask of the given
+    message, it will be logged, otherwise nothing happens.
 
-    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,
-
-    @code
-    wxLogTrace( wxTraceRefCount|wxTraceOleCalls, "Active object ref count: %d", nRef );
-    @endcode
-
-    will do something only if the current trace mask contains both @c wxTraceRefCount
-    and @c wxTraceOle, but:
-
     @code
     wxLogTrace( wxTRACE_OleCalls, "IFoo::Bar() called" );
     @endcode
@@ -596,11 +623,6 @@ public:
     wxLog::AddTraceMask( wxTRACE_OleCalls);
     @endcode
 
-    Using string masks is simpler and allows you 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() documentation.
 
     Finally, the @e wxLog::DoLog() function automatically prepends a time stamp
@@ -609,7 +631,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
-    format disables timestamping of the messages completely.
+    format or calling the shortcut wxLog::DisableTimestamp(), disables timestamping
+    of the messages completely.
 
     See also
     @li AddTraceMask()
@@ -626,7 +649,8 @@ public:
     @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
@@ -676,34 +700,6 @@ public:
     */
     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
@@ -744,9 +740,10 @@ public:
     /**
         Returns the current timestamp format string.
     */
-    static const wxString GetTimestamp();
+    static const wxString& GetTimestamp();
 
     /**
+        @deprecated
         Returns the current trace mask, see Customization() section for details.
     */
     static wxTraceMask GetTraceMask();
@@ -756,7 +753,7 @@ public:
 
         @see AddTraceMask().
     */
-    static const wxArrayString GetTraceMasks();
+    static const wxArrayString& GetTraceMasks();
 
     /**
         Returns whether the verbose mode is currently active.
@@ -774,7 +771,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.
     */
-    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
@@ -801,8 +798,8 @@ public:
     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);
 
@@ -822,7 +819,15 @@ public:
     static void SetTimestamp(const wxString& format);
 
     /**
-        Sets the trace mask, see @ref log_derivingyours section for details.
+        Disables time stamping of the log messages.
+
+        @since 2.9.0
+    */
+    static void DisableTimestamp();
+
+    /**
+        @deprecated
+        Sets the trace mask, see @ref log_tracemasks section for details.
     */
     static void SetTraceMask(wxTraceMask mask);
 
@@ -847,6 +852,56 @@ public:
         @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);
 };
 
 
@@ -899,7 +954,7 @@ public:
     @library{wxbase}
     @category{logging}
 */
-class wxLogNull : public wxLog
+class wxLogNull
 {
 public:
     /**
@@ -919,7 +974,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */
 //@{
 
 /**
@@ -965,7 +1020,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
@@ -977,7 +1032,7 @@ void wxLogMessage(const char* formatString, ... );
 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
@@ -990,7 +1045,7 @@ void wxLogVerbose(const char* formatString, ... );
 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
@@ -1002,7 +1057,7 @@ void wxLogWarning(const char* formatString, ... );
 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.
@@ -1015,7 +1070,7 @@ void wxLogFatalError(const char* formatString, ... );
 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
@@ -1028,7 +1083,7 @@ void wxLogError(const char* formatString, ... );
 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
@@ -1036,18 +1091,18 @@ void wxVLogError(const char* formatString, va_list argPtr);
     function is that usually there are a lot of trace messages, so it might
     make sense to separate them from other debug messages.
 
-    wxLogDebug(const char*,const char*,...) and
-    wxLogDebug(wxTraceMask,const char*,...) can be used instead if you would
-    like to be able to separate trace messages into different categories which
-    can be enabled or disabled with the static functions provided in wxLog.
+    wxLogTrace(const char*,const char*,...) and can be used instead of
+    wxLogDebug() if you would like to be able to separate trace messages into
+    different categories which can be enabled or disabled with
+    wxLog::AddTraceMask() and wxLog::RemoveTraceMask().
 
     @header{wx/log.h}
 */
-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);
 //@}
 
-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */
 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and
@@ -1090,7 +1145,7 @@ void wxVLogTrace(const char* mask,
                   va_list argPtr);
 //@}
 
-/** @ingroup group_funcmacro_log */
+/** @addtogroup group_funcmacro_log */
 //@{
 /**
     Like wxLogDebug(), trace functions only do something in debug builds and
@@ -1098,10 +1153,11 @@ 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.
 
+    @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
-    wxLogDebug(const char*,const char*,...) because it doesn't allow defining
+    wxLogTrace(const char*,const char*,...) because it doesn't allow defining
     the user trace masks easily. This is why it is deprecated in favour of
     using string trace masks.
 
@@ -1121,7 +1177,7 @@ void wxLogTrace(wxTraceMask mask, const char* formatString, ... );
 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
@@ -1134,7 +1190,7 @@ void wxLogDebug(const char* formatString, ... );
 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
@@ -1151,7 +1207,7 @@ void wxLogStatus(const char* formatString, ... );
 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