X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/886dd7d28e50c003cc88b81b968d487a3c17b0d7..67e489c5cfc536ace6b3ffa11398d2467cdcf2c2:/include/wx/log.h diff --git a/include/wx/log.h b/include/wx/log.h index 256a38ead8..4f68880dd3 100644 --- a/include/wx/log.h +++ b/include/wx/log.h @@ -12,28 +12,17 @@ #ifndef _WX_LOG_H_ #define _WX_LOG_H_ -#if defined(__GNUG__) && !defined(__APPLE__) +#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) #pragma interface "log.h" #endif -#include "wx/string.h" - -#if wxUSE_LOG - -// ---------------------------------------------------------------------------- -// forward declarations -// ---------------------------------------------------------------------------- - -#if wxUSE_GUI - class WXDLLEXPORT_CORE wxTextCtrl; - class WXDLLEXPORT_CORE wxLogFrame; - class WXDLLEXPORT_CORE wxFrame; -#endif // wxUSE_GUI +#include "wx/defs.h" // ---------------------------------------------------------------------------- // types // ---------------------------------------------------------------------------- +// NB: these types are needed even if wxUSE_LOG == 0 typedef unsigned long wxTraceMask; typedef unsigned long wxLogLevel; @@ -41,8 +30,13 @@ typedef unsigned long wxLogLevel; // headers // ---------------------------------------------------------------------------- +#if wxUSE_LOG + +#include "wx/string.h" +#include "wx/arrstr.h" + #ifndef __WXWINCE__ -#include // for time_t + #include // for time_t #endif #include "wx/dynarray.h" @@ -55,6 +49,16 @@ typedef unsigned long wxLogLevel; # endif #endif +// ---------------------------------------------------------------------------- +// forward declarations +// ---------------------------------------------------------------------------- + +#if wxUSE_GUI + class WXDLLIMPEXP_CORE wxTextCtrl; + class WXDLLIMPEXP_CORE wxLogFrame; + class WXDLLIMPEXP_CORE wxFrame; +#endif // wxUSE_GUI + // ---------------------------------------------------------------------------- // constants // ---------------------------------------------------------------------------- @@ -109,30 +113,34 @@ enum // normally, only a single instance of this class exists but it's not enforced // ---------------------------------------------------------------------------- -class WXDLLEXPORT_BASE wxLog +class WXDLLIMPEXP_BASE wxLog { 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. + + // 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); @@ -140,12 +148,13 @@ public: } // 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 ) @@ -157,66 +166,77 @@ public: } // 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 - 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 @@ -224,15 +244,17 @@ public: // 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: @@ -240,9 +262,9 @@ 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 @@ -261,7 +283,7 @@ private: // ---------------------------------------------------------------------------- // log everything to a "FILE *", stderr by default -class WXDLLEXPORT_BASE wxLogStderr : public wxLog +class WXDLLIMPEXP_BASE wxLogStderr : public wxLog { DECLARE_NO_COPY_CLASS(wxLogStderr) @@ -279,7 +301,7 @@ protected: #if wxUSE_STD_IOSTREAM // log everything to an "ostream", cerr by default -class WXDLLEXPORT_BASE wxLogStream : public wxLog +class WXDLLIMPEXP_BASE wxLogStream : public wxLog { public: // redirect log output to an ostream @@ -315,10 +337,10 @@ protected: // ~wxLogNull called, old log sink restored } */ -class WXDLLEXPORT_BASE wxLogNull +class WXDLLIMPEXP_BASE wxLogNull { public: - wxLogNull() : m_flagOld(wxLog::EnableLogging(FALSE)) { } + wxLogNull() : m_flagOld(wxLog::EnableLogging(false)) { } ~wxLogNull() { (void)wxLog::EnableLogging(m_flagOld); } private: @@ -334,7 +356,7 @@ private: // does it itself in its ctor // ---------------------------------------------------------------------------- -class WXDLLEXPORT_BASE wxLogChain : public wxLog +class WXDLLIMPEXP_BASE wxLogChain : public wxLog { public: wxLogChain(wxLog *logger); @@ -374,10 +396,13 @@ private: }; // a chain log target which uses itself as the new logger -class WXDLLEXPORT_BASE wxLogPassThrough : public wxLogChain +class WXDLLIMPEXP_BASE wxLogPassThrough : public wxLogChain { public: wxLogPassThrough(); + +private: + DECLARE_NO_COPY_CLASS(wxLogPassThrough) }; #if wxUSE_GUI @@ -399,19 +424,19 @@ public: // ---------------------------------------------------------------------------- // return the last system error code -WXDLLEXPORT_BASE unsigned long wxSysErrorCode(); +WXDLLIMPEXP_BASE unsigned long wxSysErrorCode(); // return the error message for given (or last if 0) error code -WXDLLEXPORT_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0); +WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0); // ---------------------------------------------------------------------------- // define wxLog // ---------------------------------------------------------------------------- #define DECLARE_LOG_FUNCTION(level) \ -extern void WXDLLEXPORT_BASE wxVLog##level(const wxChar *szFormat, \ +extern void WXDLLIMPEXP_BASE wxVLog##level(const wxChar *szFormat, \ va_list argptr); \ -extern void WXDLLEXPORT_BASE wxLog##level(const wxChar *szFormat, \ +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, \ @@ -419,7 +444,7 @@ extern void expdecl wxVLog##level(arg, const wxChar *szFormat, \ extern void expdecl wxLog##level(arg, const wxChar *szFormat, \ ...) ATTRIBUTE_PRINTF_2 #define DECLARE_LOG_FUNCTION2(level, arg) \ - DECLARE_LOG_FUNCTION2_EXP(level, arg, WXDLLEXPORT_BASE) + DECLARE_LOG_FUNCTION2_EXP(level, arg, WXDLLIMPEXP_BASE) #else // !wxUSE_LOG @@ -434,7 +459,7 @@ inline void wxVLog##level(arg, const wxChar *szFormat, \ inline void wxLog##level(arg, const wxChar *szFormat, ...) { } // Empty Class to fake wxLogNull -class WXDLLEXPORT_BASE wxLogNull +class WXDLLIMPEXP_BASE wxLogNull { public: wxLogNull() { } @@ -445,7 +470,7 @@ public: #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 @@ -467,7 +492,7 @@ DECLARE_LOG_FUNCTION(Status); #if wxUSE_GUI // 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_EXP(Status, wxFrame *pFrame, WXDLLEXPORT_CORE); + DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *pFrame, WXDLLIMPEXP_CORE); #endif // wxUSE_GUI // additional one: as wxLogError, but also logs last system call error code @@ -482,23 +507,22 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode); #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); - // 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 *, ...) { } - 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) { } @@ -507,7 +531,7 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode); // 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 WXDLLEXPORT_BASE +void WXDLLIMPEXP_BASE wxSafeShowMessage(const wxString& title, const wxString& text); // ---------------------------------------------------------------------------- @@ -524,8 +548,8 @@ wxSafeShowMessage(const wxString& title, const wxString& text); (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++ @@ -537,5 +561,10 @@ wxSafeShowMessage(const wxString& title, const wxString& text); 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_