]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/log.h
Change a Popup menu from using a callback to using events. Can't test
[wxWidgets.git] / include / wx / log.h
index 7713ebc38220675429cb0f39dcf5cb8235a18aba..c000ac1274f64c0c2a57f0952982b2465ed462e3 100644 (file)
     #pragma interface "log.h"
 #endif
 
-#include <wx/dynarray.h>
-#include <time.h>
+#include "wx/setup.h"
+#include "wx/string.h"
+
+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
+
+class WXDLLEXPORT wxTextCtrl;
+class WXDLLEXPORT wxLogFrame;
+class WXDLLEXPORT wxFrame;
+
+// ----------------------------------------------------------------------------
+// types
+// ----------------------------------------------------------------------------
+
+typedef unsigned long wxTraceMask;
+typedef unsigned long wxLogLevel;
+
+// ----------------------------------------------------------------------------
+// headers
+// ----------------------------------------------------------------------------
+
+#if wxUSE_LOG
+
+#include <time.h>   // for time_t
+
+#include "wx/dynarray.h"
 
 // ----------------------------------------------------------------------------
 // constants
@@ -65,26 +90,7 @@ enum
     #define wxTraceOleCalls 0x0100  // OLE interface calls
 #endif
 
-typedef unsigned long wxTraceMask;
-typedef unsigned long wxLogLevel;
-
-// ----------------------------------------------------------------------------
-// forward declarations
-// ----------------------------------------------------------------------------
-
-class WXDLLEXPORT wxTextCtrl;
-class WXDLLEXPORT wxLogFrame;
-class WXDLLEXPORT wxFrame;
-
-#if wxUSE_IOSTREAMH
-// N.B. BC++ doesn't have istream.h, ostream.h
-#   include <iostream.h>
-#else
-#   include <ostream>
-#   if defined(__VISUALC__) || defined(__MWERKS__)
-        using namespace std;
-#   endif
-#endif
+#include "wx/ioswrap.h"
 
 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages
@@ -106,7 +112,7 @@ public:
 
     // static sink function - see DoLog() for function to overload in the
     // derived classes
-    static void OnLog(wxLogLevel level, const char *szString, time_t t)
+    static void OnLog(wxLogLevel level, const wxChar *szString, time_t t)
     {
         if ( IsEnabled() ) {
             wxLog *pLogger = GetActiveTarget();
@@ -126,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();
@@ -147,15 +160,28 @@ 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; }
         // get trace mask
     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
         // is this trace mask in the list?
-    static bool IsAllowedTraceMask(const char *mask)
+    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() { }
 
@@ -166,10 +192,10 @@ protected:
     // the logging functions that can be overriden
         // default DoLog() prepends the time stamp and a prefix corresponding
         // to the message to szString and then passes it to DoLogString()
-    virtual void DoLog(wxLogLevel level, const char *szString, time_t t);
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
         // default DoLogString does nothing but is not pure virtual because if
         // you override DoLog() you might not need it at all
-    virtual void DoLogString(const char *szString, time_t t);
+    virtual void DoLogString(const wxChar *szString, time_t t);
 
 private:
     // static variables
@@ -179,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
 };
@@ -196,7 +226,7 @@ public:
 
 private:
     // implement sink function
-    virtual void DoLogString(const char *szString, time_t t);
+    virtual void DoLogString(const wxChar *szString, time_t t);
 
     FILE *m_fp;
 };
@@ -211,25 +241,32 @@ public:
 
 protected:
     // implement sink function
-    virtual void DoLogString(const char *szString, time_t t);
+    virtual void DoLogString(const wxChar *szString, time_t t);
 
     // using ptr here to avoid including <iostream.h> from this file
     ostream *m_ostr;
 };
 #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
@@ -244,7 +281,7 @@ public:
     virtual void Flush();
 
 protected:
-    virtual void DoLog(wxLogLevel level, const char *szString, time_t t);
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
 
     // empty everything
     void Clear();
@@ -265,7 +302,7 @@ class WXDLLEXPORT wxLogWindow : public wxLog
 {
 public:
     wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
-            const char *szTitle,      // the title of the frame
+            const wxChar *szTitle,      // the title of the frame
             bool bShow = TRUE,        // show window immediately?
             bool bPassToOld = TRUE);  // pass log messages to the old target?
     ~wxLogWindow();
@@ -299,8 +336,8 @@ public:
     virtual void OnFrameDelete(wxFrame *frame);
 
 protected:
-    virtual void DoLog(wxLogLevel level, const char *szString, time_t t);
-    virtual void DoLogString(const char *szString, time_t t);
+    virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+    virtual void DoLogString(const wxChar *szString, time_t t);
 
 private:
     bool        m_bPassMessages;  // pass messages to m_pOldLog?
@@ -308,7 +345,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
@@ -346,42 +383,67 @@ private:
 // 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
+// ----------------------------------------------------------------------------
+
+// return the last system error code
+WXDLLEXPORT unsigned long wxSysErrorCode();
+// return the error message for given (or last if 0) error code
+WXDLLEXPORT const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
+
 // define wxLog<level>
 // -------------------
 
 #define DECLARE_LOG_FUNCTION(level)                                 \
-extern void WXDLLEXPORT wxLog##level(const char *szFormat, ...)
+extern void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...)
+#define DECLARE_LOG_FUNCTION2(level, arg1)                          \
+extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
+
+#else // !wxUSE_LOG
+
+// log functions do nothing at all
+#define DECLARE_LOG_FUNCTION(level)                                 \
+inline void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...) {}
 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
-extern void WXDLLEXPORT wxLog##level(arg1, const char *szFormat, ...)
+inline void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...) {}
+
+#endif // wxUSE_LOG/!wxUSE_LOG
 
-    // a generic function for all levels (level is passes as parameter)
-    DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
+// a generic function for all levels (level is passes as parameter)
+DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
 
-    // one function per each level
-    DECLARE_LOG_FUNCTION(FatalError);
-    DECLARE_LOG_FUNCTION(Error);
-    DECLARE_LOG_FUNCTION(Warning);
-    DECLARE_LOG_FUNCTION(Message);
-    DECLARE_LOG_FUNCTION(Info);
-    DECLARE_LOG_FUNCTION(Verbose);
+// one function per each level
+DECLARE_LOG_FUNCTION(FatalError);
+DECLARE_LOG_FUNCTION(Error);
+DECLARE_LOG_FUNCTION(Warning);
+DECLARE_LOG_FUNCTION(Message);
+DECLARE_LOG_FUNCTION(Info);
+DECLARE_LOG_FUNCTION(Verbose);
 
-    // this function sends the log message to the status line of the top level
-    // application frame, if any
-    DECLARE_LOG_FUNCTION(Status);
+// this function sends the log message to the status line of the top level
+// application frame, if any
+DECLARE_LOG_FUNCTION(Status);
 
-    // this one is the same as previous except that it allows to explicitly
-    // specify the frame to which the output should go
-    DECLARE_LOG_FUNCTION2(Status, wxFrame *pFrame);
+// this one is the same as previous except that it allows to explicitly
+// specify the frame to which the output should go
+DECLARE_LOG_FUNCTION2(Status, wxFrame *pFrame);
 
-    // additional one: as wxLogError, but also logs last system call error code
-    // and the corresponding error message if available
-    DECLARE_LOG_FUNCTION(SysError);
+// additional one: as wxLogError, but also logs last system call error code
+// and the corresponding error message if available
+DECLARE_LOG_FUNCTION(SysError);
 
-    // and another one which also takes the error code (for those broken APIs
-    // that don't set the errno (like registry APIs in Win32))
-    DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
+// and another one which also takes the error code (for those broken APIs
+// that don't set the errno (like registry APIs in Win32))
+DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 
-    // debug functions do nothing in release mode
+// debug functions do nothing in release mode
 #ifdef  __WXDEBUG__
     DECLARE_LOG_FUNCTION(Debug);
 
@@ -398,41 +460,42 @@ extern void WXDLLEXPORT wxLog##level(arg1, const char *szFormat, ...)
     DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
 #else   //!debug
     // these functions do nothing in release builds
-    inline void wxLogDebug(const char *, ...) { }
-    inline void wxLogTrace(const char *, ...) { }
-    inline void wxLogTrace(wxTraceMask, const char *, ...) { }
-    inline void wxLogTrace(const char *, const char *, ...) { }
-#endif
-
+    inline void wxLogDebug(const wxChar *, ...) { }
+    inline void wxLogTrace(const wxChar *, ...) { }
+    inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
+    inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }
+#endif // debug/!debug
 
-    // 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
-    // ----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// debug only logging functions: use them with API name and error code
+// ----------------------------------------------------------------------------
 
-    // return the last system error code
-    WXDLLEXPORT unsigned long wxSysErrorCode();
-    // return the error message for given (or last if 0) error code
-    WXDLLEXPORT const char* wxSysErrorMsg(unsigned long nErrCode = 0);
+#ifndef __TFILE__
+    #define __XFILE__(x) Tx)
+    #define __TFILE__ __XFILE__(__FILE__)
+#endif
 
-    // ----------------------------------------------------------------------------
-    // debug only logging functions: use them with API name and error code
-    // ----------------------------------------------------------------------------
+#ifdef __WXDEBUG__
+    // 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(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),          \
+                   __TFILE__, __LINE__, api,                                    \
+                   rc, wxSysErrorMsg(rc))
+#else // !VC++
+    #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++
+
+    #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 
-#ifdef  __WXDEBUG__
-#define wxLogApiError(api, rc)                                              \
-    wxLogDebug("At %s(%d) '%s' failed with error %lx (%s).",  \
-            __FILE__, __LINE__, api,                       \
-            rc, wxSysErrorMsg(rc))
-#define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
 #else   //!debug
-    inline void wxLogApiError(const char *, long) { }
-    inline void wxLogLastError(const char *) { }
+    inline void wxLogApiError(const wxChar *, long) { }
+    inline void wxLogLastError(const wxChar *) { }
 #endif  //debug/!debug
 
 #endif  // _WX_LOG_H_