#ifndef _WX_LOG_H_
#define _WX_LOG_H_
-#if defined(__GNUG__) && !defined(__APPLE__)
- #pragma interface "log.h"
-#endif
-
-#include "wx/string.h"
-
-#if wxUSE_LOG
+#include "wx/defs.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"
+#include "wx/strvararg.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
// ----------------------------------------------------------------------------
// different standard log levels (you may also define your own)
-enum
+enum wxLogLevelValues
{
wxLOG_FatalError, // program can't continue, abort immediately
wxLOG_Error, // a serious error, user must be informed about it
#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"
// ----------------------------------------------------------------------------
{
public:
// ctor
- 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.
- static wxChar *SetLogBuffer( wxChar *buf, size_t size = 0 );
+ wxLog(){}
// 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)
+
+ // 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 ) {
- wxLog *pLogger = GetActiveTarget();
- if ( pLogger )
- pLogger->DoLog(level, szString, t);
- }
- }
+ static void OnLog(wxLogLevel level, const wxChar *szString, time_t 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)
+ // log the count of repeating messages instead of logging the messages
+ // multiple times
+ static void SetRepetitionCounting(bool bRepetCounting = true)
+ { ms_bRepetCounting = bRepetCounting; }
+
+ // gets duplicate counting status
+ static bool GetRepetitionCounting() { return ms_bRepetCounting; }
+
+ // trace mask (see wxTraceXXX constants for details)
static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
- // add string trace mask
- static void AddTraceMask(const wxString& str) { ms_aTraceMasks.Add(str); }
- // add string trace mask
+
+ // add string trace mask
+ static void AddTraceMask(const wxString& str)
+ { 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?
- static bool IsAllowedTraceMask(const wxChar *mask)
- { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; }
- // return the current loglevel limit
+
+ // is this trace mask in the list?
+ static bool IsAllowedTraceMask(const wxChar *mask);
+
+ // 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
- virtual ~wxLog() { }
+ virtual ~wxLog();
// this method exists for backwards compatibility only, don't use
- bool HasPendingMessages() const { return TRUE; }
+ bool HasPendingMessages() const { return true; }
+
+#if WXWIN_COMPATIBILITY_2_6
+ // this function doesn't do anything any more, don't call it
+ wxDEPRECATED( static wxChar *SetLogBuffer(wxChar *buf, size_t size = 0) );
+#endif
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);
+ // log a line containing the number of times the previous message was
+ // repeated
+ // returns: the number
+ static unsigned DoLogNumberOfRepeats();
+
private:
// static variables
// ----------------
+ // traditional behaviour or counting repetitions
+ static bool ms_bRepetCounting;
+ static wxString ms_prevString; // previous message that was logged
+ // how many times the previous message was logged
+ static unsigned ms_prevCounter;
+ static time_t ms_prevTimeStamp;// timestamp of the previous message
+ static wxLogLevel ms_prevLevel; // level of the previous message
+
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
// "trivial" derivations of wxLog
// ----------------------------------------------------------------------------
+// log everything to a buffer
+class WXDLLIMPEXP_BASE wxLogBuffer : public wxLog
+{
+public:
+ wxLogBuffer() { }
+
+ // get the string contents with all messages logged
+ const wxString& GetBuffer() const { return m_str; }
+
+ // show the buffer contents to the user in the best possible way (this uses
+ // wxMessageOutputMessageBox) and clear it
+ virtual void Flush();
+
+protected:
+ virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t);
+ virtual void DoLogString(const wxChar *szString, time_t t);
+
+private:
+ wxString m_str;
+
+ DECLARE_NO_COPY_CLASS(wxLogBuffer)
+};
+
+
// log everything to a "FILE *", stderr by default
class WXDLLIMPEXP_BASE wxLogStderr : public wxLog
{
- DECLARE_NO_COPY_CLASS(wxLogStderr)
-
public:
// redirect log output to a FILE
wxLogStderr(FILE *fp = (FILE *) NULL);
virtual void DoLogString(const wxChar *szString, time_t t);
FILE *m_fp;
+
+ DECLARE_NO_COPY_CLASS(wxLogStderr)
};
#if wxUSE_STD_IOSTREAM
class WXDLLIMPEXP_BASE wxLogNull
{
public:
- wxLogNull() : m_flagOld(wxLog::EnableLogging(FALSE)) { }
+ wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { }
~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); }
private:
{
public:
wxLogPassThrough();
+
+private:
+ DECLARE_NO_COPY_CLASS(wxLogPassThrough)
};
#if wxUSE_GUI
// define wxLog<level>
// ----------------------------------------------------------------------------
-#define DECLARE_LOG_FUNCTION(level) \
-extern void WXDLLIMPEXP_BASE wxVLog##level(const wxChar *szFormat, \
- va_list argptr); \
-extern void WXDLLIMPEXP_BASE wxLog##level(const wxChar *szFormat, \
- ...) ATTRIBUTE_PRINTF_1
-#define DECLARE_LOG_FUNCTION2_EXP(level, arg, expdecl) \
-extern void expdecl wxVLog##level(arg, const wxChar *szFormat, \
+#define DECLARE_LOG_FUNCTION_PUBLIC(level) \
+ /* void wxLog##level(const wxChar *szFormat, ...); */ \
+ WX_DEFINE_VARARG_FUNC_VOID(wxLog##level, wxDoLog##level)
+
+#define DECLARE_LOG_FUNCTION_IMPL(level) \
+ extern void WXDLLIMPEXP_BASE wxVLog##level(const wxChar *szFormat, \
+ va_list argptr); \
+ extern void WXDLLIMPEXP_BASE wxDoLog##level(const wxChar *szFormat, \
+ ...) ATTRIBUTE_PRINTF_1
+
+#define DECLARE_LOG_FUNCTION2_EXP_IMPL(level, argclass, arg, expdecl) \
+ extern void expdecl wxVLog##level(argclass arg, \
+ const wxChar *szFormat, \
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)
+ extern void expdecl wxDoLog##level(argclass arg, \
+ const wxChar *szFormat, \
+ ...) ATTRIBUTE_PRINTF_2
#else // !wxUSE_LOG
// log functions do nothing at all
-#define DECLARE_LOG_FUNCTION(level) \
-inline void wxVLog##level(const wxChar *szFormat, \
- va_list argptr) { } \
-inline void wxLog##level(const wxChar *szFormat, ...) { }
-#define DECLARE_LOG_FUNCTION2(level, arg) \
-inline void wxVLog##level(arg, const wxChar *szFormat, \
- va_list argptr) {} \
-inline void wxLog##level(arg, const wxChar *szFormat, ...) { }
+#define DECLARE_LOG_FUNCTION_PUBLIC(level) \
+ /* void wxLog##level(const wxChar *szFormat, ...) {} */ \
+ WX_DEFINE_VARARG_FUNC_NOP(wxLog##level)
+
+#define DECLARE_LOG_FUNCTION_IMPL(level) \
+ inline void wxVLog##level(const wxChar *WXUNUSED(szFormat), \
+ va_list WXUNUSED(argptr)) { } \
+
+#define DECLARE_LOG_FUNCTION2_EXP_IMPL(level, argclass, arg, expdecl) \
+ inline void wxVLog##level(argclass WXUNUSED(arg), \
+ const wxChar *WXUNUSED(szFormat), \
+ va_list WXUNUSED(argptr)) {}
// Empty Class to fake wxLogNull
class WXDLLIMPEXP_BASE wxLogNull
#define wxSysErrorMsg( X ) (const wxChar*)NULL
// Fake symbolic trace masks... for those that are used frequently
-#define wxTRACE_OleCalls wxT("") // OLE interface calls
+#define wxTRACE_OleCalls wxEmptyString // OLE interface calls
#endif // wxUSE_LOG/!wxUSE_LOG
+#define DECLARE_LOG_FUNCTION(level) \
+ DECLARE_LOG_FUNCTION_PUBLIC(level) \
+ DECLARE_LOG_FUNCTION_IMPL(level)
+
+#define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl) \
+ DECLARE_LOG_FUNCTION_PUBLIC(level) \
+ DECLARE_LOG_FUNCTION2_EXP_IMPL(level, argclass, arg, expdecl)
+
+#define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl) \
+ DECLARE_LOG_FUNCTION_PUBLIC(level) \
+ DECLARE_LOG_FUNCTION2_EXP_IMPL(level, argclass, arg, expdecl)
+
+#define DECLARE_LOG_FUNCTION2_IMPL(level, argclass, arg) \
+ DECLARE_LOG_FUNCTION2_EXP_IMPL(level, argclass, arg, WXDLLIMPEXP_BASE)
+
+#define DECLARE_LOG_FUNCTION2(level, argclass, arg) \
+ DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
+
+// VC6 produces a warning if we a macro expanding to nothing to
+// DECLARE_LOG_FUNCTION2_IMPL:
+#if defined(__VISUALC__) && __VISUALC__ < 1300
+ // "not enough actual parameters for macro 'DECLARE_LOG_FUNCTION2_EXP_IMPL'"
+ #pragma warning(disable:4003)
+#endif
+
// a generic function for all levels (level is passes as parameter)
-DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
+DECLARE_LOG_FUNCTION2(Generic, wxLogLevel, level);
// one function per each level
DECLARE_LOG_FUNCTION(FatalError);
// this function sends the log message to the status line of the top level
// application frame, if any
-DECLARE_LOG_FUNCTION(Status);
+DECLARE_LOG_FUNCTION_IMPL(Status);
#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);
+ DECLARE_LOG_FUNCTION2_EXP_IMPL(Status, wxFrame *, pFrame, WXDLLIMPEXP_CORE);
#endif // wxUSE_GUI
+DECLARE_LOG_FUNCTION_PUBLIC(Status)
+
// additional one: as wxLogError, but also logs last system call error code
// and the corresponding error message if available
-DECLARE_LOG_FUNCTION(SysError);
+DECLARE_LOG_FUNCTION_IMPL(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);
+DECLARE_LOG_FUNCTION2_IMPL(SysError, long, lErrCode);
+
+DECLARE_LOG_FUNCTION_PUBLIC(SysError)
// debug functions do nothing in release mode
-#if wxUSE_LOG_DEBUG
+#if wxUSE_LOG && wxUSE_LOG_DEBUG
DECLARE_LOG_FUNCTION(Debug);
- // first kind of LogTrace is unconditional: it doesn't check the level,
- 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()
- DECLARE_LOG_FUNCTION2(Trace, const wxChar *mask);
+ // there is no more unconditional LogTrace: it is not different from
+ // LogDebug and it creates overload ambiguities
+ //DECLARE_LOG_FUNCTION(Trace);
- // the last one does nothing if all of level bits are not set
- // in wxLog::GetActive()->GetTraceMask() - it's deprecated in favour of
+ // this version only logs the message if the mask had been added to the
+ // list of masks with AddTraceMask()
+ DECLARE_LOG_FUNCTION2_IMPL(Trace, const wxChar*, mask);
+ // 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 *, ...) { }
- 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 wxLogTrace(const wxChar *, const wxChar *, ...) { }
+ DECLARE_LOG_FUNCTION2_IMPL(Trace, wxTraceMask, mask);
+ DECLARE_LOG_FUNCTION_PUBLIC(Trace)
+#else //!debug || !wxUSE_LOG
+ // these functions do nothing in release builds, but don't define them as
+ // nothing as it could result in different code structure in debug and
+ // release and this could result in trouble when these macros are used
+ // inside if/else
+ //
+ // note that making wxVLogDebug/Trace() themselves (empty inline) functions
+ // is a bad idea as some compilers are stupid enough to not inline even
+ // empty functions if their parameters are complicated enough, but by
+ // defining them as an empty inline function we ensure that even dumbest
+ // compilers optimise them away
+ inline void wxLogNop() { }
+
+ #define wxVLogDebug(fmt, valist) wxLogNop()
+ #define wxVLogTrace(mask, fmt, valist) wxLogNop()
+
+ #ifdef HAVE_VARIADIC_MACROS
+ // unlike the inline functions below, this completely removes the
+ // wxLogXXX calls from the object file:
+ #define wxLogDebug(fmt, ...) wxLogNop()
+ #define wxLogTrace(mask, fmt, ...) wxLogNop()
+ #else // !HAVE_VARIADIC_MACROS
+ //inline void wxLogDebug(const wxString& fmt, ...) {}
+ WX_DEFINE_VARARG_FUNC_NOP(wxLogDebug)
+ //inline void wxLogTrace(wxTraceMask, const wxString& fmt, ...) {}
+ //inline void wxLogTrace(const wxString&, const wxString& fmt, ...) {}
+ WX_DEFINE_VARARG_FUNC_NOP(wxLogTrace)
+ #endif // HAVE_VARIADIC_MACROS/!HAVE_VARIADIC_MACROS
#endif // debug/!debug
+#if defined(__VISUALC__) && __VISUALC__ < 1300
+ #pragma warning(default:4003)
+#endif
+
// wxLogFatalError helper: show the (fatal) error to the user in a safe way,
// i.e. without using wxMessageBox() for example because it could crash
void WXDLLIMPEXP_BASE
(long)rc, wxSysErrorMsg(rc))
#else // !VC++
#define wxLogApiError(api, rc) \
- wxLogDebug(wxT("In file %s at line %d: '%s' failed with " \
- "error 0x%08lx (%s)."), \
+ wxLogDebug(wxT("In file %s at line %d: '%s' failed with ") \
+ wxT("error 0x%08lx (%s)."), \
__TFILE__, __LINE__, api, \
(long)rc, wxSysErrorMsg(rc))
#endif // VC++/!VC++
#define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
#else //!debug
- inline void wxLogApiError(const wxChar *, long) { }
- inline void wxLogLastError(const wxChar *) { }
+ #define wxLogApiError(api, err) wxLogNop()
+ #define wxLogLastError(api) wxLogNop()
#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