#include "wx/defs.h"
-#if wxUSE_LOG
-
-#include "wx/string.h"
-#include "wx/arrstr.h"
-
// ----------------------------------------------------------------------------
-// forward declarations
+// common constants for use in wxUSE_LOG/!wxUSE_LOG
// ----------------------------------------------------------------------------
-#if wxUSE_GUI
- class WXDLLIMPEXP_CORE wxTextCtrl;
- class WXDLLIMPEXP_CORE wxLogFrame;
- class WXDLLIMPEXP_CORE wxFrame;
-#endif // wxUSE_GUI
+// the trace masks have been superceded by symbolic trace constants, they're
+// for compatibility only andwill be removed soon - do NOT use them
+
+// meaning of different bits of the trace mask (which allows selectively
+// enable/disable some trace messages)
+#define wxTraceMemAlloc 0x0001 // trace memory allocation (new/delete)
+#define wxTraceMessages 0x0002 // trace window messages/X callbacks
+#define wxTraceResAlloc 0x0004 // trace GDI resource allocation
+#define wxTraceRefCount 0x0008 // trace various ref counting operations
+
+#ifdef __WXMSW__
+ #define wxTraceOleCalls 0x0100 // OLE interface calls
+#endif
// ----------------------------------------------------------------------------
// types
// ----------------------------------------------------------------------------
+// NB: these types are needed even if wxUSE_LOG == 0
typedef unsigned long wxTraceMask;
typedef unsigned long wxLogLevel;
// headers
// ----------------------------------------------------------------------------
+#include "wx/string.h"
+
+#if wxUSE_LOG
+
+#include "wx/arrstr.h"
+
#ifndef __WXWINCE__
-#include <time.h> // for time_t
+ #include <time.h> // for time_t
#endif
#include "wx/dynarray.h"
# endif
#endif
+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
+
+#if wxUSE_GUI
+ class WXDLLIMPEXP_CORE wxTextCtrl;
+ class WXDLLIMPEXP_CORE wxLogFrame;
+ class WXDLLIMPEXP_CORE wxFrame;
+ class WXDLLIMPEXP_CORE wxWindow;
+#endif // wxUSE_GUI
+
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
#define wxTRACE_OleCalls wxT("ole") // OLE interface calls
#endif
-// the trace masks have been superceded by symbolic trace constants, they're
-// for compatibility only andwill be removed soon - do NOT use them
-
-// meaning of different bits of the trace mask (which allows selectively
-// enable/disable some trace messages)
-#define wxTraceMemAlloc 0x0001 // trace memory allocation (new/delete)
-#define wxTraceMessages 0x0002 // trace window messages/X callbacks
-#define wxTraceResAlloc 0x0004 // trace GDI resource allocation
-#define wxTraceRefCount 0x0008 // trace various ref counting operations
-
-#ifdef __WXMSW__
- #define wxTraceOleCalls 0x0100 // OLE interface calls
-#endif
-
#include "wx/iosfwrap.h"
// ----------------------------------------------------------------------------
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
- // is logging disabled now?
+
+ // is logging disabled now?
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)
{
- if ( IsEnabled() && ms_logLevel >= level ) {
+ if ( IsEnabled() && ms_logLevel >= level )
+ {
wxLog *pLogger = GetActiveTarget();
if ( pLogger )
pLogger->DoLog(level, szString, t);
}
// 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();
- // flush the active target if any
+ // flush the active target if any
static void FlushActive()
{
if ( !ms_suspendCount )
}
// 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();
- // change log target, pLogger may be NULL
+
+ // 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)
+ // 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()!
+
+ // 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
- 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; }
- // 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();
- // trace mask (see wxTraceXXX constants for details)
+ // trace mask (see wxTraceXXX constants for details)
static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
- // add string trace mask
+
+ // add string trace mask
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);
- // remove all string trace masks
+
+ // remove all string trace masks
static void ClearTraceMasks();
- // get string trace masks
+
+ // get string trace masks
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
- // gets the verbose status
+
+ // gets the verbose status
static bool GetVerbose() { return ms_bVerbose; }
- // get trace mask
+
+ // get trace mask
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);
- // return the current loglevel limit
+
+ // return the current loglevel limit
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
- // 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
// 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
- // 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);
- // 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:
// ----------------
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_bVerbose; // FALSE => ignore LogInfo messages
+ static bool ms_bVerbose; // false => ignore LogInfo messages
static wxLogLevel ms_logLevel; // limit logging to levels <= ms_logLevel
class WXDLLIMPEXP_BASE wxLogNull
{
public:
- wxLogNull() : m_flagOld(wxLog::EnableLogging(FALSE)) { }
+ wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }
~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
private:
va_list argptr); \
extern void expdecl wxLog##level(arg, const wxChar *szFormat, \
...) ATTRIBUTE_PRINTF_2
-#define DECLARE_LOG_FUNCTION2(level, arg) \
- DECLARE_LOG_FUNCTION2_EXP(level, arg, WXDLLIMPEXP_BASE)
-
#else // !wxUSE_LOG
// log functions do nothing at all
inline void wxVLog##level(const wxChar *szFormat, \
va_list argptr) { } \
inline void wxLog##level(const wxChar *szFormat, ...) { }
-#define DECLARE_LOG_FUNCTION2(level, arg) \
+#define DECLARE_LOG_FUNCTION2_EXP(level, arg, expdecl) \
inline void wxVLog##level(arg, const wxChar *szFormat, \
va_list argptr) {} \
inline void wxLog##level(arg, const wxChar *szFormat, ...) { }
#define wxTRACE_OleCalls wxEmptyString // OLE interface calls
#endif // wxUSE_LOG/!wxUSE_LOG
+#define DECLARE_LOG_FUNCTION2(level, arg) \
+ DECLARE_LOG_FUNCTION2_EXP(level, arg, WXDLLIMPEXP_BASE)
+
// a generic function for all levels (level is passes as parameter)
DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
#if wxUSE_GUI
// this one is the same as previous except that it allows to explicitly
+ class WXDLLEXPORT wxFrame;
// specify the frame to which the output should go
DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *pFrame, WXDLLIMPEXP_CORE);
#endif // wxUSE_GUI
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_
projects / wxWidgets.git / blobdiff