]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/log.h
added dependency handling to Makefiles
[wxWidgets.git] / include / wx / log.h
index 24292ae8d4d330fd8531a4cd12eac624f66bf074..b6b3a645929c41e4e97a30439bc70b9d790d5fc7 100644 (file)
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////
-// Name:        log.h
+// Name:        wx/log.h
 // Purpose:     Assorted wxLogXXX functions, and wxLog (sink for logs)
 // Author:      Vadim Zeitlin
 // Modified by:
 // Purpose:     Assorted wxLogXXX functions, and wxLog (sink for logs)
 // Author:      Vadim Zeitlin
 // Modified by:
@@ -67,13 +67,13 @@ enum
 // discarded unless the string "foo" has been added to the list of allowed
 // ones with AddTraceMask()
 
 // discarded unless the string "foo" has been added to the list of allowed
 // ones with AddTraceMask()
 
-#define wxTRACE_MemAlloc "memalloc" // trace memory allocation (new/delete)
-#define wxTRACE_Messages "messages" // trace window messages/X callbacks
-#define wxTRACE_ResAlloc "resalloc" // trace GDI resource allocation
-#define wxTRACE_RefCount "refcount" // trace various ref counting operations
+#define wxTRACE_MemAlloc wxT("memalloc") // trace memory allocation (new/delete)
+#define wxTRACE_Messages wxT("messages") // trace window messages/X callbacks
+#define wxTRACE_ResAlloc wxT("resalloc") // trace GDI resource allocation
+#define wxTRACE_RefCount wxT("refcount") // trace various ref counting operations
 
 #ifdef  __WXMSW__
 
 #ifdef  __WXMSW__
-    #define wxTRACE_OleCalls "ole"  // OLE interface calls
+    #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls
 #endif
 
 // the trace masks have been superceded by symbolic trace constants, they're
 #endif
 
 // the trace masks have been superceded by symbolic trace constants, they're
@@ -132,19 +132,36 @@ public:
     bool HasPendingMessages() const { return m_bHasMessages; }
 
     // only one sink is active at each moment
     bool HasPendingMessages() const { return m_bHasMessages; }
 
     // only one sink is active at each moment
+        // flush the active target if any
+    static void FlushActive()
+    {
+        if ( !ms_suspendCount )
+        {
+            wxLog *log = GetActiveTarget();
+            if ( log && log->HasPendingMessages() )
+                log->Flush();
+        }
+    }
         // get current log target, will call wxApp::CreateLogTarget() to
         // create one if none exists
     static wxLog *GetActiveTarget();
         // change log target, pLogger may be NULL
     static wxLog *SetActiveTarget(wxLog *pLogger);
 
         // get current log target, will call wxApp::CreateLogTarget() to
         // create one if none exists
     static wxLog *GetActiveTarget();
         // change log target, pLogger may be NULL
     static wxLog *SetActiveTarget(wxLog *pLogger);
 
+        // suspend the message flushing of the main target until the next call
+        // to Resume() - this is mainly for internal use (to prevent wxYield()
+        // from flashing the messages)
+    static void Suspend() { ms_suspendCount++; }
+        // must be called for each Suspend()!
+    static void Resume() { ms_suspendCount--; }
+
     // functions controlling the default wxLog behaviour
         // verbose mode is activated by standard command-line '-verbose'
         // option
     // functions controlling the default wxLog behaviour
         // verbose mode is activated by standard command-line '-verbose'
         // option
-    void SetVerbose(bool bVerbose = TRUE) { m_bVerbose = bVerbose; }
+    static void SetVerbose(bool bVerbose = TRUE) { ms_bVerbose = bVerbose; }
         // should GetActiveTarget() try to create a new log object if the
         // current is NULL?
         // should GetActiveTarget() try to create a new log object if the
         // current is NULL?
-    static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
+    static void DontCreateOnDemand();
 
         // trace mask (see wxTraceXXX constants for details)
     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
 
         // trace mask (see wxTraceXXX constants for details)
     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
@@ -152,22 +169,36 @@ public:
     static void AddTraceMask(const wxString& str) { ms_aTraceMasks.Add(str); }
         // add string trace mask
     static void RemoveTraceMask(const wxString& str);
     static void AddTraceMask(const wxString& str) { ms_aTraceMasks.Add(str); }
         // add string trace mask
     static void RemoveTraceMask(const wxString& str);
+        // remove all string trace masks
+    static void ClearTraceMasks();
+
+        // sets the timestamp string: this is used as strftime() format string
+        // for the log targets which add time stamps to the messages - set it
+        // to NULL to disable time stamping completely.
+    static void SetTimestamp(const wxChar *ts) { ms_timestamp = ts; }
 
     // accessors
         // gets the verbose status
 
     // accessors
         // gets the verbose status
-    bool GetVerbose() const { return m_bVerbose; }
+    static bool GetVerbose() { return ms_bVerbose; }
         // get trace mask
     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
         // is this trace mask in the list?
     static bool IsAllowedTraceMask(const wxChar *mask)
         { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; }
 
         // get trace mask
     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
         // is this trace mask in the list?
     static bool IsAllowedTraceMask(const wxChar *mask)
         { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; }
 
+        // get the current timestamp format string (may be NULL)
+    static const wxChar *GetTimestamp() { return ms_timestamp; }
+
+    // helpers
+        // put the time stamp into the string if ms_timestamp != NULL (don't
+        // change it otherwise)
+    static void TimeStamp(wxString *str);
+
     // make dtor virtual for all derived classes
     virtual ~wxLog() { }
 
 protected:
     bool m_bHasMessages; // any messages in the queue?
     // make dtor virtual for all derived classes
     virtual ~wxLog() { }
 
 protected:
     bool m_bHasMessages; // any messages in the queue?
-    bool m_bVerbose;     // FALSE => ignore LogInfo messages
 
     // the logging functions that can be overriden
         // default DoLog() prepends the time stamp and a prefix corresponding
 
     // the logging functions that can be overriden
         // default DoLog() prepends the time stamp and a prefix corresponding
@@ -184,6 +215,13 @@ private:
     static wxLog      *ms_pLogger;      // currently active log sink
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
     static wxLog      *ms_pLogger;      // currently active log sink
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
+    static bool        ms_bVerbose;     // FALSE => ignore LogInfo messages
+
+    static size_t      ms_suspendCount; // if positive, logs are not flushed
+
+    // format string for strftime(), if NULL, time stamping log messages is
+    // disabled
+    static const wxChar *ms_timestamp;
 
     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
     static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
 
     static wxTraceMask ms_ulTraceMask;   // controls wxLogTrace behaviour
     static wxArrayString ms_aTraceMasks; // more powerful filter for wxLogTrace
@@ -200,7 +238,7 @@ public:
     // redirect log output to a FILE
     wxLogStderr(FILE *fp = (FILE *) NULL);
 
     // redirect log output to a FILE
     wxLogStderr(FILE *fp = (FILE *) NULL);
 
-private:
+protected:
     // implement sink function
     virtual void DoLogString(const wxChar *szString, time_t t);
 
     // implement sink function
     virtual void DoLogString(const wxChar *szString, time_t t);
 
@@ -208,38 +246,139 @@ private:
 };
 
 #if wxUSE_STD_IOSTREAM
 };
 
 #if wxUSE_STD_IOSTREAM
+
 // log everything to an "ostream", cerr by default
 class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:
     // redirect log output to an ostream
 // log everything to an "ostream", cerr by default
 class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:
     // redirect log output to an ostream
-    wxLogStream(ostream *ostr = (ostream *) NULL);
+    wxLogStream(wxSTD ostream *ostr = (wxSTD ostream *) NULL);
 
 protected:
     // implement sink function
     virtual void DoLogString(const wxChar *szString, time_t t);
 
     // using ptr here to avoid including <iostream.h> from this file
 
 protected:
     // implement sink function
     virtual void DoLogString(const wxChar *szString, time_t t);
 
     // using ptr here to avoid including <iostream.h> from this file
-    ostream *m_ostr;
+    wxSTD ostream *m_ostr;
 };
 };
-#endif
 
 
-#ifndef wxUSE_NOGUI
+#endif // wxUSE_STD_IOSTREAM
+
+// ----------------------------------------------------------------------------
+// /dev/null log target: suppress logging until this object goes out of scope
+// ----------------------------------------------------------------------------
+
+// example of usage:
+/*
+    void Foo()
+    {
+        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
+    }
+ */
+class WXDLLEXPORT wxLogNull
+{
+public:
+    wxLogNull() { m_flagOld = wxLog::EnableLogging(FALSE); }
+    ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld);   }
+
+private:
+    bool m_flagOld; // the previous value of the wxLog::ms_doLog
+};
+
+// ----------------------------------------------------------------------------
+// chaining log target: installs itself as a log target and passes all
+// messages to the real log target given to it in the ctor but also forwards
+// them to the previously active one
+//
+// note that you don't have to call SetActiveTarget() with this class, it
+// does it itself in its ctor
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxLogChain : public wxLog
+{
+public:
+    wxLogChain(wxLog *logger);
+    virtual ~wxLogChain() { delete m_logOld; }
+
+    // change the new log target
+    void SetLog(wxLog *logger);
+
+    // this can be used to temporarily disable (and then reenable) passing
+    // messages to the old logger (by default we do pass them)
+    void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
+
+    // are we passing the messages to the previous log target?
+    bool IsPassingMessages() const { return m_bPassMessages; }
+
+    // return the previous log target (may be NULL)
+    wxLog *GetOldLog() const { return m_logOld; }
+
+    // override base class version to flush the old logger as well
+    virtual void Flush();
+
+protected:
+    // pass the chain to the old logger if needed
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+
+private:
+    // the current log target
+    wxLog *m_logNew;
+
+    // the previous log target
+    wxLog *m_logOld;
+
+    // do we pass the messages to the old logger?
+    bool m_bPassMessages;
+};
+
+// a chain log target which uses itself as the new logger
+class WXDLLEXPORT wxLogPassThrough : public wxLogChain
+{
+public:
+    wxLogPassThrough();
+};
+
+// ----------------------------------------------------------------------------
+// the following log targets are only compiled in if the we're compiling the
+// GUI part (andnot just the base one) of the library, they're implemented in
+// src/generic/logg.cpp *and not src/common/log.cpp unlike all the rest)
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI
+
+#if wxUSE_TEXTCTRL
 
 
-#if wxUSE_STD_IOSTREAM
 // log everything to a text window (GUI only of course)
 // log everything to a text window (GUI only of course)
-class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
+class WXDLLEXPORT wxLogTextCtrl : public wxLog
 {
 public:
 {
 public:
-    // we just create an ostream from wxTextCtrl and use it in base class
     wxLogTextCtrl(wxTextCtrl *pTextCtrl);
     wxLogTextCtrl(wxTextCtrl *pTextCtrl);
-    ~wxLogTextCtrl();
+
+private:
+    // implement sink function
+    virtual void DoLogString(const wxChar *szString, time_t t);
+
+    // the control we use
+    wxTextCtrl *m_pTextCtrl;
 };
 };
-#endif
+
+#endif // wxUSE_TEXTCTRL
 
 // ----------------------------------------------------------------------------
 // GUI log target, the default one for wxWindows programs
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // GUI log target, the default one for wxWindows programs
 // ----------------------------------------------------------------------------
+
+#if wxUSE_LOGGUI
+
 class WXDLLEXPORT wxLogGui : public wxLog
 {
 public:
 class WXDLLEXPORT wxLogGui : public wxLog
 {
 public:
@@ -255,53 +394,51 @@ protected:
     // empty everything
     void Clear();
 
     // empty everything
     void Clear();
 
-    wxArrayString m_aMessages;
-    wxArrayLong   m_aTimes;
+    wxArrayString m_aMessages;      // the log message texts
+    wxArrayInt    m_aSeverity;      // one of wxLOG_XXX values
+    wxArrayLong   m_aTimes;         // the time of each message
     bool          m_bErrors,        // do we have any errors?
                   m_bWarnings;      // any warnings?
 };
 
     bool          m_bErrors,        // do we have any errors?
                   m_bWarnings;      // any warnings?
 };
 
+#endif // wxUSE_LOGGUI
+
 // ----------------------------------------------------------------------------
 // (background) log window: this class forwards all log messages to the log
 // target which was active when it was instantiated, but also collects them
 // to the log window. This window has it's own menu which allows the user to
 // close it, clear the log contents or save it to the file.
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // (background) log window: this class forwards all log messages to the log
 // target which was active when it was instantiated, but also collects them
 // to the log window. This window has it's own menu which allows the user to
 // close it, clear the log contents or save it to the file.
 // ----------------------------------------------------------------------------
-class WXDLLEXPORT wxLogWindow : public wxLog
+
+#if wxUSE_LOGWINDOW
+
+class WXDLLEXPORT wxLogWindow : public wxLogPassThrough
 {
 public:
     wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
 {
 public:
     wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
-            const wxChar *szTitle,      // the title of the frame
-            bool bShow = TRUE,        // show window immediately?
-            bool bPassToOld = TRUE);  // pass log messages to the old target?
+                const wxChar *szTitle,    // the title of the frame
+                bool bShow = TRUE,        // show window immediately?
+                bool bPassToOld = TRUE);  // pass messages to the old target?
+
     ~wxLogWindow();
 
     // window operations
     ~wxLogWindow();
 
     // window operations
-    // show/hide the log window
+        // show/hide the log window
     void Show(bool bShow = TRUE);
     void Show(bool bShow = TRUE);
-    // retrieve the pointer to the frame
+        // retrieve the pointer to the frame
     wxFrame *GetFrame() const;
 
     wxFrame *GetFrame() const;
 
-    // accessors
-    // the previous log target (may be NULL)
-    wxLog *GetOldLog() const { return m_pOldLog; }
-    // are we passing the messages to the previous log target?
-    bool IsPassingMessages() const { return m_bPassMessages; }
-
-    // we can pass the messages to the previous log target (we're in this mode by
-    // default: we collect all messages in the window, but also let the default
-    // processing take place)
-    void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
-
-    // base class virtuals
-    // we don't need it ourselves, but we pass it to the previous logger
-    virtual void Flush();
-
     // overridables
     // overridables
-    // called immediately after the log frame creation allowing for
-    // any extra initializations
+        // 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
+        // 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
+    virtual bool OnFrameClose(wxFrame *frame);
+        // called right before the log frame is going to be deleted: will
+        // always be called unlike OnFrameClose()
     virtual void OnFrameDelete(wxFrame *frame);
 
 protected:
     virtual void OnFrameDelete(wxFrame *frame);
 
 protected:
@@ -309,39 +446,12 @@ protected:
     virtual void DoLogString(const wxChar *szString, time_t t);
 
 private:
     virtual void DoLogString(const wxChar *szString, time_t t);
 
 private:
-    bool        m_bPassMessages;  // pass messages to m_pOldLog?
-    wxLog      *m_pOldLog;        // previous log target
     wxLogFrame *m_pLogFrame;      // the log frame
 };
 
     wxLogFrame *m_pLogFrame;      // the log frame
 };
 
-#endif // wxUSE_NOGUI
+#endif // wxUSE_LOGWINDOW
 
 
-// ----------------------------------------------------------------------------
-// /dev/null log target: suppress logging until this object goes out of scope
-// ----------------------------------------------------------------------------
-
-// example of usage:
-/*
-   void Foo() {
-   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
-}
- */
-class WXDLLEXPORT wxLogNull
-{
-public:
-    wxLogNull() { m_flagOld = wxLog::EnableLogging(FALSE); }
-    ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld);   }
-
-private:
-    bool m_flagOld; // the previous value of the wxLog::ms_doLog
-};
+#endif // wxUSE_GUI
 
 // ============================================================================
 // global functions
 
 // ============================================================================
 // global functions
@@ -352,12 +462,6 @@ private:
 // for log messages for easy redirection
 // ----------------------------------------------------------------------------
 
 // for log messages for easy redirection
 // ----------------------------------------------------------------------------
 
-// are we in 'verbose' mode?
-// (note that it's often handy to change this var manually from the
-//  debugger, thus enabling/disabling verbose reporting for some
-//  parts of the program only)
-WXDLLEXPORT_DATA(extern bool) g_bVerbose;
-
 // ----------------------------------------------------------------------------
 // get error code/error message from system in a portable way
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // get error code/error message from system in a portable way
 // ----------------------------------------------------------------------------
@@ -421,7 +525,7 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 
     // this second version will only log the message if the mask had been
     // added to the list of masks with AddTraceMask()
 
     // this second version will only log the message if the mask had been
     // added to the list of masks with AddTraceMask()
-    DECLARE_LOG_FUNCTION2(Trace, const char *mask);
+    DECLARE_LOG_FUNCTION2(Trace, const wxChar *mask);
 
     // the last one does nothing if all of level bits are not set
     // in wxLog::GetActive()->GetTraceMask() - it's deprecated in favour of
 
     // the last one does nothing if all of level bits are not set
     // in wxLog::GetActive()->GetTraceMask() - it's deprecated in favour of
@@ -440,7 +544,7 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 // ----------------------------------------------------------------------------
 
 #ifndef __TFILE__
 // ----------------------------------------------------------------------------
 
 #ifndef __TFILE__
-    #define __XFILE__(x) _T(x)
+    #define __XFILE__(x) Tx)
     #define __TFILE__ __XFILE__(__FILE__)
 #endif
 
     #define __TFILE__ __XFILE__(__FILE__)
 #endif
 
@@ -448,15 +552,15 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
     // make life easier for people using VC++ IDE: clicking on the message
     // will take us immediately to the place of the failed API
 #ifdef __VISUALC__
     // make life easier for people using VC++ IDE: clicking on the message
     // will take us immediately to the place of the failed API
 #ifdef __VISUALC__
-    #define wxLogApiError(api, rc)                                              \
-        wxLogDebug(_T("%s(%d): '%s' failed with error 0x%08lx (%s)."),          \
-                   __TFILE__, __LINE__, api,                                    \
+    #define wxLogApiError(api, rc)                                            \
+        wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
+                   __TFILE__, __LINE__, api,                              \
                    rc, wxSysErrorMsg(rc))
 #else // !VC++
                    rc, wxSysErrorMsg(rc))
 #else // !VC++
-    #define wxLogApiError(api, rc)                                              \
-        wxLogDebug(_T("In file %s at line %d: '%s' failed with "                \
-                      "error 0x%08lx (%s)."),                                   \
-                   __TFILE__, __LINE__, api,                                    \
+    #define wxLogApiError(api, rc)                                            \
+        wxLogDebug(wxT("In file %s at line %d: '%s' failed with "             \
+                      "error 0x%08lx (%s)."),                                 \
+                   __TFILE__, __LINE__, api,                              \
                    rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++
 
                    rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++