fixed a design flaw in wxFontMapper that prevented automatic creation of wxConfig...

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

diff --git a/include/wx/log.h b/include/wx/log.h
index d84f142a5437fddfd8e195de8eff4994c2f03298..db1f30d5d1217c006698bf9fb3c2f744dbb3a8e5 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -16,6 +16,30 @@
     #pragma interface "log.h"
 #endif
 
     #pragma interface "log.h"
 #endif
 

+#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"
 #include <time.h>   // for time_t
 
 #include "wx/dynarray.h"


@@ -43,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


@@ -66,26 +90,7 @@ enum
     #define wxTraceOleCalls 0x0100  // OLE interface calls
 #endif
 
     #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
 
 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages


@@ -127,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
     void SetVerbose(bool bVerbose = TRUE) { m_bVerbose = bVerbose; }
         // should GetActiveTarget() try to create a new log object if the
         // current is NULL?
     // functions controlling the default wxLog behaviour
         // verbose mode is activated by standard command-line '-verbose'
         // option
     void SetVerbose(bool bVerbose = TRUE) { m_bVerbose = bVerbose; }
         // 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; }


@@ -147,6 +169,13 @@ 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


@@ -157,6 +186,14 @@ public:
     static bool IsAllowedTraceMask(const wxChar *mask)
         { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; }
 
     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() { }
 
     // make dtor virtual for all derived classes
     virtual ~wxLog() { }
 


@@ -180,6 +217,12 @@ private:
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
 
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
 

+    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
 };


@@ -208,33 +251,47 @@ class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:
     // redirect log output to an ostream
 {
 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
 
 };
 #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_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:


@@ -250,18 +307,24 @@ 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.
 // ----------------------------------------------------------------------------

+
+#if wxUSE_LOGWINDOW
+

 class WXDLLEXPORT wxLogWindow : public wxLog
 {
 public:
 class WXDLLEXPORT wxLogWindow : public wxLog
 {
 public:


@@ -272,15 +335,15 @@ public:
     ~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;
 
     // accessors
     wxFrame *GetFrame() const;
 
     // accessors

-    // the previous log target (may be NULL)
+        // the previous log target (may be NULL)

     wxLog *GetOldLog() const { return m_pOldLog; }
     wxLog *GetOldLog() const { return m_pOldLog; }

-    // are we passing the messages to the previous log target?
+        // 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
     bool IsPassingMessages() const { return m_bPassMessages; }
 
     // we can pass the messages to the previous log target (we're in this mode by


@@ -289,14 +352,20 @@ public:
     void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 
     // base class virtuals
     void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 
     // base class virtuals

-    // we don't need it ourselves, but we pass it to the previous logger
+        // we don't need it ourselves, but we pass it to the previous logger

     virtual void Flush();
 
     // overridables
     virtual void Flush();
 
     // 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,7 +378,9 @@ private:
     wxLogFrame *m_pLogFrame;      // the log frame
 };
 
     wxLogFrame *m_pLogFrame;      // the log frame
 };
 

-#endif // wxUSE_NOGUI
+#endif // wxUSE_LOGWINDOW
+
+#endif // wxUSE_GUI

 
 // ----------------------------------------------------------------------------
 // /dev/null log target: suppress logging until this object goes out of scope
 
 // ----------------------------------------------------------------------------
 // /dev/null log target: suppress logging until this object goes out of scope


@@ -347,6 +418,21 @@ 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
+// ----------------------------------------------------------------------------
+
+// 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 wxLog<level>
 // -------------------
 


@@ -355,34 +441,44 @@ extern void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...)
 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
 extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
 
 #define DECLARE_LOG_FUNCTION2(level, arg1)                          \
 extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
 

-    // a generic function for all levels (level is passes as parameter)
-    DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
+#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)                          \
+inline void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...) {}
+
+#endif // wxUSE_LOG/!wxUSE_LOG

 
 

-    // 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);
+// a generic function for all levels (level is passes as parameter)
+DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);

 
 

-    // this function sends the log message to the status line of the top level
-    // application frame, if any
-    DECLARE_LOG_FUNCTION(Status);
+// 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 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 function sends the log message to the status line of the top level
+// application frame, if any
+DECLARE_LOG_FUNCTION(Status);

 
 

-    // additional one: as wxLogError, but also logs last system call error code
-    // and the corresponding error message if available
-    DECLARE_LOG_FUNCTION(SysError);
+// 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);

 
 

-    // 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);
+// additional one: as wxLogError, but also logs last system call error code
+// and the corresponding error message if available
+DECLARE_LOG_FUNCTION(SysError);

 
 

-    // debug functions do nothing in release mode
+// 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

 #ifdef  __WXDEBUG__
     DECLARE_LOG_FUNCTION(Debug);
 
 #ifdef  __WXDEBUG__
     DECLARE_LOG_FUNCTION(Debug);
 


@@ -391,7 +487,7 @@ extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
 
     // 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


@@ -403,46 +499,30 @@ extern void WXDLLEXPORT wxLog##level(arg1, const wxChar *szFormat, ...)
     inline void wxLogTrace(const wxChar *, ...) { }
     inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
     inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }
     inline void wxLogTrace(const wxChar *, ...) { }
     inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
     inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }

-#endif
-
-
-    // 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
-    // ----------------------------------------------------------------------------
+#endif // debug/!debug

 
 

-    // 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);
-
-    // ----------------------------------------------------------------------------
-    // debug only logging functions: use them with API name and error code
-    // ----------------------------------------------------------------------------
+// ----------------------------------------------------------------------------
+// debug only logging functions: use them with API name and error code
+// ----------------------------------------------------------------------------

 
 #ifndef __TFILE__
 
 #ifndef __TFILE__

-#define __XFILE__(x) _T(x)
-#define __TFILE__ __XFILE__(__FILE__)
+    #define __XFILE__(x) Tx)
+    #define __TFILE__ __XFILE__(__FILE__)

 #endif
 
 #endif
 

-#ifdef  __WXDEBUG__
+#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__
     // 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++