added wx/msw/wince/libraries.h to workaround SDK differences problems

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

diff --git a/include/wx/log.h b/include/wx/log.h
index a2670f451d9f80f17b1a62fe35333b8614fa2887..4f68880dd3952e95b1d3cdc6e97769b0fe65a487 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -18,25 +18,11 @@
 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 

-#if wxUSE_LOG
-
-#include "wx/string.h"
-#include "wx/arrstr.h"
-
-// ----------------------------------------------------------------------------
-// forward declarations
-// ----------------------------------------------------------------------------
-
-#if wxUSE_GUI
-    class WXDLLIMPEXP_CORE wxTextCtrl;
-    class WXDLLIMPEXP_CORE wxLogFrame;
-    class WXDLLIMPEXP_CORE wxFrame;
-#endif // wxUSE_GUI
-

 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
 
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------
 

+// NB: these types are needed even if wxUSE_LOG == 0

 typedef unsigned long wxTraceMask;
 typedef unsigned long wxLogLevel;
 
 typedef unsigned long wxTraceMask;
 typedef unsigned long wxLogLevel;
 


@@ -44,8 +30,13 @@ typedef unsigned long wxLogLevel;
 // headers
 // ----------------------------------------------------------------------------
 
 // headers
 // ----------------------------------------------------------------------------
 

+#if wxUSE_LOG
+
+#include "wx/string.h"
+#include "wx/arrstr.h"
+

 #ifndef __WXWINCE__
 #ifndef __WXWINCE__

-#include <time.h>   // for time_t
+    #include <time.h>   // for time_t

 #endif
 
 #include "wx/dynarray.h"
 #endif
 
 #include "wx/dynarray.h"


@@ -58,6 +49,16 @@ typedef unsigned long wxLogLevel;
 #  endif
 #endif
 
 #  endif
 #endif
 

+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI
+    class WXDLLIMPEXP_CORE wxTextCtrl;
+    class WXDLLIMPEXP_CORE wxLogFrame;
+    class WXDLLIMPEXP_CORE wxFrame;
+#endif // wxUSE_GUI
+

 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------


@@ -119,23 +120,27 @@ public:
     wxLog();
 
     // Internal buffer.
     wxLog();
 
     // Internal buffer.

-        // Allow replacement of the fixed size static buffer with
-        // a user allocated one.  Pass in NULL to restore the
-        // built in static buffer.
+
+    // Allow replacement of the fixed size static buffer with
+    // a user allocated one.  Pass in NULL to restore the
+    // built in static buffer.

     static wxChar *SetLogBuffer( wxChar *buf, size_t size = 0 );
 
     // these functions allow to completely disable all log messages
     static wxChar *SetLogBuffer( wxChar *buf, size_t size = 0 );
 
     // these functions allow to completely disable all log messages

-        // is logging disabled now?
+
+    // is logging disabled now?

     static bool IsEnabled() { return ms_doLog; }
     static bool IsEnabled() { return ms_doLog; }

-        // change the flag state, return the previous one
-    static bool EnableLogging(bool doIt = TRUE)
-        { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }
+
+    // change the flag state, return the previous one
+    static bool EnableLogging(bool doIt = true)
+    { bool doLogOld = ms_doLog; ms_doLog = doIt; return doLogOld; }

 
     // static sink function - see DoLog() for function to overload in the
     // derived classes
     static void OnLog(wxLogLevel level, const wxChar *szString, time_t t)
     {
 
     // static sink function - see DoLog() for function to overload in the
     // derived classes
     static void OnLog(wxLogLevel level, const wxChar *szString, time_t t)
     {

-        if ( IsEnabled() && ms_logLevel >= level ) {
+        if ( IsEnabled() && ms_logLevel >= level )
+        {

             wxLog *pLogger = GetActiveTarget();
             if ( pLogger )
                 pLogger->DoLog(level, szString, t);
             wxLog *pLogger = GetActiveTarget();
             if ( pLogger )
                 pLogger->DoLog(level, szString, t);


@@ -143,12 +148,13 @@ public:
     }
 
     // message buffering
     }
 
     // message buffering

-        // flush shows all messages if they're not logged immediately (FILE
-        // and iostream logs don't need it, but wxGuiLog does to avoid showing
-        // 17 modal dialogs one after another)
+
+    // flush shows all messages if they're not logged immediately (FILE
+    // and iostream logs don't need it, but wxGuiLog does to avoid showing
+    // 17 modal dialogs one after another)

     virtual void Flush();
 
     virtual void Flush();
 

-        // flush the active target if any
+    // flush the active target if any

     static void FlushActive()
     {
         if ( !ms_suspendCount )
     static void FlushActive()
     {
         if ( !ms_suspendCount )


@@ -160,66 +166,77 @@ public:
     }
 
     // only one sink is active at each moment
     }
 
     // only one sink is active at each moment

-        // get current log target, will call wxApp::CreateLogTarget() to
-        // create one if none exists
+    // get current log target, will call wxApp::CreateLogTarget() to
+    // create one if none exists

     static wxLog *GetActiveTarget();
     static wxLog *GetActiveTarget();

-        // change log target, pLogger may be NULL
+
+    // change log target, pLogger may be NULL

     static wxLog *SetActiveTarget(wxLog *pLogger);
 
     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)
+    // 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++; }
     static void Suspend() { ms_suspendCount++; }

-        // must be called for each Suspend()!
+
+    // must be called for each Suspend()!

     static void Resume() { ms_suspendCount--; }
 
     // functions controlling the default wxLog behaviour
     static void Resume() { ms_suspendCount--; }
 
     // functions controlling the default wxLog behaviour

-        // verbose mode is activated by standard command-line '-verbose'
-        // option
-    static void SetVerbose(bool bVerbose = TRUE) { ms_bVerbose = bVerbose; }
+    // verbose mode is activated by standard command-line '-verbose'
+    // option
+    static void SetVerbose(bool bVerbose = true) { ms_bVerbose = bVerbose; }

 
 

-        // Set log level.  Log messages with level > logLevel will not be logged.
+    // Set log level.  Log messages with level > logLevel will not be logged.

     static void SetLogLevel(wxLogLevel logLevel) { ms_logLevel = logLevel; }
 
     static void SetLogLevel(wxLogLevel logLevel) { ms_logLevel = logLevel; }
 

-        // 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();
 
     static void DontCreateOnDemand();
 

-        // trace mask (see wxTraceXXX constants for details)
+    // trace mask (see wxTraceXXX constants for details)

     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
     static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }

-        // add string trace mask
+
+    // add string trace mask

     static void AddTraceMask(const wxString& str)
     static void AddTraceMask(const wxString& str)

-        { ms_aTraceMasks.push_back(str); }
-        // add string trace mask
+    { ms_aTraceMasks.push_back(str); }
+
+    // add string trace mask

     static void RemoveTraceMask(const wxString& str);
     static void RemoveTraceMask(const wxString& str);

-        // remove all string trace masks
+
+    // remove all string trace masks

     static void ClearTraceMasks();
     static void ClearTraceMasks();

-       // get string trace masks
+
+    // get string trace masks

     static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
 
     static const wxArrayString &GetTraceMasks() { return ms_aTraceMasks; }
 

-        // 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.
+    // 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
     static void SetTimestamp(const wxChar *ts) { ms_timestamp = ts; }
 
 
     // accessors

-        // gets the verbose status
+
+    // gets the verbose status

     static bool GetVerbose() { return ms_bVerbose; }
     static bool GetVerbose() { return ms_bVerbose; }

-        // get trace mask
+
+    // get trace mask

     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
     static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }

-        // is this trace mask in the list?
+
+    // is this trace mask in the list?

     static bool IsAllowedTraceMask(const wxChar *mask);
     static bool IsAllowedTraceMask(const wxChar *mask);

-        // return the current loglevel limit
+
+    // return the current loglevel limit

     static wxLogLevel GetLogLevel() { return ms_logLevel; }
 
     static wxLogLevel GetLogLevel() { return ms_logLevel; }
 

-        // get the current timestamp format string (may be NULL)
+    // get the current timestamp format string (may be NULL)

     static const wxChar *GetTimestamp() { return ms_timestamp; }
 
 
     // helpers
     static const wxChar *GetTimestamp() { return ms_timestamp; }
 
 
     // helpers

-        // put the time stamp into the string if ms_timestamp != NULL (don't
-        // change it otherwise)
+
+    // 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
     static void TimeStamp(wxString *str);
 
     // make dtor virtual for all derived classes


@@ -227,15 +244,17 @@ public:
 
 
     // this method exists for backwards compatibility only, don't use
 
 
     // this method exists for backwards compatibility only, don't use

-    bool HasPendingMessages() const { return TRUE; }
+    bool HasPendingMessages() const { return true; }

 
 protected:
     // the logging functions that can be overriden
 
 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()
+
+    // 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 wxChar *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
+
+    // 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 wxChar *szString, time_t t);
 
 private:
     virtual void DoLogString(const wxChar *szString, time_t t);
 
 private:


@@ -243,9 +262,9 @@ private:
     // ----------------
 
     static wxLog      *ms_pLogger;      // currently active log sink
     // ----------------
 
     static wxLog      *ms_pLogger;      // currently active log sink

-    static bool        ms_doLog;        // FALSE => all logging disabled
+    static bool        ms_doLog;        // false => all logging disabled

     static bool        ms_bAutoCreate;  // create new log targets on demand?
     static bool        ms_bAutoCreate;  // create new log targets on demand?

-    static bool        ms_bVerbose;     // FALSE => ignore LogInfo messages
+    static bool        ms_bVerbose;     // false => ignore LogInfo messages

 
     static wxLogLevel  ms_logLevel;     // limit logging to levels <= ms_logLevel
 
 
     static wxLogLevel  ms_logLevel;     // limit logging to levels <= ms_logLevel
 


@@ -321,7 +340,7 @@ protected:
 class WXDLLIMPEXP_BASE wxLogNull
 {
 public:
 class WXDLLIMPEXP_BASE wxLogNull
 {
 public:

-    wxLogNull() : m_flagOld(wxLog::EnableLogging(FALSE)) { }
+    wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }

     ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
 
 private:
     ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
 
 private:


@@ -488,23 +507,22 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 #if wxUSE_LOG_DEBUG
     DECLARE_LOG_FUNCTION(Debug);
 
 #if wxUSE_LOG_DEBUG
     DECLARE_LOG_FUNCTION(Debug);
 

-    // first kind of LogTrace is unconditional: it doesn't check the level,
-    DECLARE_LOG_FUNCTION(Trace);
+    // there is no more unconditional LogTrace: it is not different from
+    // LogDebug and it creates overload ambiguities
+    //DECLARE_LOG_FUNCTION(Trace);

 
 

-    // this second version will only log the message if the mask had been
-    // added to the list of masks with AddTraceMask()
+    // this version only logs the message if the mask had been added to the
+    // list of masks with AddTraceMask()

     DECLARE_LOG_FUNCTION2(Trace, const wxChar *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
+    // and this one does nothing if all of level bits are not set in
+    // wxLog::GetActive()->GetTraceMask() -- it's deprecated in favour of

     // string identifiers
     DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
 #else   //!debug
     // these functions do nothing in release builds
     inline void wxVLogDebug(const wxChar *, va_list) { }
     inline void wxLogDebug(const wxChar *, ...) { }
     // string identifiers
     DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
 #else   //!debug
     // these functions do nothing in release builds
     inline void wxVLogDebug(const wxChar *, va_list) { }
     inline void wxLogDebug(const wxChar *, ...) { }

-    inline void wxVLogTrace(const wxChar *, va_list) { }
-    inline void wxLogTrace(const wxChar *, ...) { }

     inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }
     inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
     inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }
     inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }
     inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
     inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }


@@ -543,5 +561,10 @@ wxSafeShowMessage(const wxString& title, const wxString& text);
     inline void wxLogLastError(const wxChar *) { }
 #endif  //debug/!debug
 
     inline void wxLogLastError(const wxChar *) { }
 #endif  //debug/!debug
 

+// wxCocoa has additiional trace masks
+#if defined(__WXCOCOA__)
+#include "wx/cocoa/log.h"
+#endif
+

 #endif  // _WX_LOG_H_
 
 #endif  // _WX_LOG_H_