added wxSYS_COLOUR_LISTBOX

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

diff --git a/include/wx/log.h b/include/wx/log.h
index 72f8d774fb020e1ce411b344f37922d174eb33d9..94d0beb5b6aef4d2216cd34f054900efdbe3e571 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -17,6 +17,7 @@
 #endif
 
 #include "wx/setup.h"
+#include "wx/string.h"
 
 // ----------------------------------------------------------------------------
 // forward declarations
@@ -66,13 +67,13 @@ enum
 // 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__
-    #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
@@ -131,6 +132,13 @@ public:
     bool HasPendingMessages() const { return m_bHasMessages; }
 
     // only one sink is active at each moment
+        // flush the active target if any
+    static void FlushActive()
+    {
+        wxLog *log = GetActiveTarget();
+        if ( log )
+            log->Flush();
+    }
         // get current log target, will call wxApp::CreateLogTarget() to
         // create one if none exists
     static wxLog *GetActiveTarget();
@@ -152,6 +160,11 @@ public:
         // add string trace mask
     static void RemoveTraceMask(const wxString& str);
 
+        // 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
     bool GetVerbose() const { return m_bVerbose; }
@@ -161,6 +174,14 @@ public:
     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() { }
 
@@ -184,6 +205,10 @@ private:
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
 
+    // 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
 };
@@ -223,18 +248,25 @@ protected:
 };
 #endif
 
-#ifndef wxUSE_NOGUI
+// 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_STD_IOSTREAM
 // log everything to a text window (GUI only of course)
-class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
+class WXDLLEXPORT wxLogTextCtrl : public wxLog
 {
 public:
-    // we just create an ostream from wxTextCtrl and use it in base class
     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
 
 // ----------------------------------------------------------------------------
 // GUI log target, the default one for wxWindows programs
@@ -254,8 +286,9 @@ protected:
     // 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?
 };
@@ -313,7 +346,7 @@ private:
     wxLogFrame *m_pLogFrame;      // the log frame
 };
 
-#endif // wxUSE_NOGUI
+#endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------
 // /dev/null log target: suppress logging until this object goes out of scope
@@ -439,7 +472,7 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 // ----------------------------------------------------------------------------
 
 #ifndef __TFILE__
-    #define __XFILE__(x) _T(x)
+    #define __XFILE__(x) Tx)
     #define __TFILE__ __XFILE__(__FILE__)
 #endif
 
@@ -447,15 +480,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__
-    #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__, _T(api),                              \
                    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__, _T(api),                              \
                    rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++