X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d6b9496a96223cc5164e5785485d7d622fd9b5e6..c0b042fce9be0fab67f229f35ffd117f4e1e0730:/include/wx/log.h?ds=inline diff --git a/include/wx/log.h b/include/wx/log.h index a0cd25c50d..2c9e5ccb33 100644 --- a/include/wx/log.h +++ b/include/wx/log.h @@ -16,7 +16,30 @@ #pragma interface "log.h" #endif -#include +// ---------------------------------------------------------------------------- +// 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 // for time_t + +#include "wx/dynarray.h" // ---------------------------------------------------------------------------- // constants @@ -64,17 +87,6 @@ enum #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 @@ -105,7 +117,7 @@ public: // static sink function - see DoLog() for function to overload in the // derived classes - static void OnLog(wxLogLevel level, const char *szString, time_t t) + static void OnLog(wxLogLevel level, const wxChar *szString, time_t t) { if ( IsEnabled() ) { wxLog *pLogger = GetActiveTarget(); @@ -152,7 +164,7 @@ public: // get trace mask static wxTraceMask GetTraceMask() { return ms_ulTraceMask; } // is this trace mask in the list? - static bool IsAllowedTraceMask(const char *mask) + static bool IsAllowedTraceMask(const wxChar *mask) { return ms_aTraceMasks.Index(mask) != wxNOT_FOUND; } // make dtor virtual for all derived classes @@ -165,10 +177,10 @@ 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() - virtual void DoLog(wxLogLevel level, const char *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 - virtual void DoLogString(const char *szString, time_t t); + virtual void DoLogString(const wxChar *szString, time_t t); private: // static variables @@ -195,7 +207,7 @@ public: private: // implement sink function - virtual void DoLogString(const char *szString, time_t t); + virtual void DoLogString(const wxChar *szString, time_t t); FILE *m_fp; }; @@ -210,7 +222,7 @@ public: protected: // implement sink function - virtual void DoLogString(const char *szString, time_t t); + virtual void DoLogString(const wxChar *szString, time_t t); // using ptr here to avoid including from this file ostream *m_ostr; @@ -243,7 +255,7 @@ public: virtual void Flush(); protected: - virtual void DoLog(wxLogLevel level, const char *szString, time_t t); + virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t); // empty everything void Clear(); @@ -264,7 +276,7 @@ class WXDLLEXPORT wxLogWindow : public wxLog { public: wxLogWindow(wxFrame *pParent, // the parent frame (can be NULL) - const char *szTitle, // the title of the frame + const wxChar *szTitle, // the title of the frame bool bShow = TRUE, // show window immediately? bool bPassToOld = TRUE); // pass log messages to the old target? ~wxLogWindow(); @@ -298,8 +310,8 @@ public: virtual void OnFrameDelete(wxFrame *frame); protected: - virtual void DoLog(wxLogLevel level, const char *szString, time_t t); - virtual void DoLogString(const char *szString, time_t t); + virtual void DoLog(wxLogLevel level, const wxChar *szString, time_t t); + virtual void DoLogString(const wxChar *szString, time_t t); private: bool m_bPassMessages; // pass messages to m_pOldLog? @@ -345,42 +357,67 @@ private: // 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 // ------------------- #define DECLARE_LOG_FUNCTION(level) \ -extern void WXDLLEXPORT wxLog##level(const char *szFormat, ...) +extern void WXDLLEXPORT wxLog##level(const wxChar *szFormat, ...) #define DECLARE_LOG_FUNCTION2(level, arg1) \ -extern void WXDLLEXPORT wxLog##level(arg1, const char *szFormat, ...) +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 - // 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); +// 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 + +// 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); @@ -397,41 +434,42 @@ extern void WXDLLEXPORT wxLog##level(arg1, const char *szFormat, ...) DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask); #else //!debug // these functions do nothing in release builds - inline void wxLogDebug(const char *, ...) { } - inline void wxLogTrace(const char *, ...) { } - inline void wxLogTrace(wxTraceMask, const char *, ...) { } - inline void wxLogTrace(const char *, const char *, ...) { } -#endif - + inline void wxLogDebug(const wxChar *, ...) { } + inline void wxLogTrace(const wxChar *, ...) { } + inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { } + inline void wxLogTrace(const wxChar *, const wxChar *, ...) { } +#endif // debug/!debug - // 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 - // ---------------------------------------------------------------------------- +// ---------------------------------------------------------------------------- +// debug only logging functions: use them with API name and error code +// ---------------------------------------------------------------------------- - // return the last system error code - WXDLLEXPORT unsigned long wxSysErrorCode(); - // return the error message for given (or last if 0) error code - WXDLLEXPORT const char* wxSysErrorMsg(unsigned long nErrCode = 0); +#ifndef __TFILE__ + #define __XFILE__(x) _T(x) + #define __TFILE__ __XFILE__(__FILE__) +#endif - // ---------------------------------------------------------------------------- - // debug only logging functions: use them with API name and error code - // ---------------------------------------------------------------------------- +#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__ + #define wxLogApiError(api, rc) \ + wxLogDebug(_T("%s(%d): '%s' failed with error 0x%08lx (%s)."), \ + __TFILE__, __LINE__, api, \ + 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, \ + rc, wxSysErrorMsg(rc)) +#endif // VC++/!VC++ + + #define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode()) -#ifdef __WXDEBUG__ -#define wxLogApiError(api, rc) \ - wxLogDebug("At %s(%d) '%s' failed with error %lx (%s).", \ - __FILE__, __LINE__, api, \ - rc, wxSysErrorMsg(rc)) -#define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode()) #else //!debug - inline void wxLogApiError(const char *, long) { } - inline void wxLogLastError(const char *) { } + inline void wxLogApiError(const wxChar *, long) { } + inline void wxLogLastError(const wxChar *) { } #endif //debug/!debug #endif // _WX_LOG_H_