#pragma interface "log.h"
#endif
+#include "wx/intl.h"
+
// ----------------------------------------------------------------------------
// constants
// ----------------------------------------------------------------------------
// (FILE and iostream logs don't need it, but wxGuiLog does to avoid
// showing 17 modal dialogs one after another)
virtual void Flush();
- // call to Flush() may be optimized: call it only if this function
+ // call to Flush() may be optimized: call it only if this function
// returns true (although Flush() also returns immediately if there
// is no messages, this functions is more efficient because inline)
bool HasPendingMessages() const { return m_bHasMessages; }
// only one sink is active at each moment
- // get current log target
+ // get current log target, will call wxApp::CreateLogTarget() to create one
+ // if
static wxLog *GetActiveTarget();
// change log target, pLogger = NULL disables logging,
// returns the previous log target
// NB: the string is not copied, so it's lifetime must be long enough!
void SetTimeStampFormat(const char *szTF) { m_szTimeFormat = szTF; }
// trace mask (see wxTraceXXX constants for details)
- void SetTraceMask(wxTraceMask ulMask) { m_ulTraceMask = ulMask; }
+ static void SetTraceMask(wxTraceMask ulMask) { ms_ulTraceMask = ulMask; }
+ // should GetActiveTarget() try to create a new log object if the current
+ // is NULL?
+ static void DontCreateOnDemand() { ms_bAutoCreate = FALSE; }
// accessors
// gets the verbose status
// get current time format
const char *GetTimeStampFormat() const { return m_szTimeFormat; }
// get trace mask
- wxTraceMask GetTraceMask() const { return m_ulTraceMask; }
+ static wxTraceMask GetTraceMask() { return ms_ulTraceMask; }
// make dtor virtual for all derived classes
virtual ~wxLog() { }
bool m_bVerbose; // FALSE => ignore LogInfo messages
const char *m_szTimeFormat; // format for strftime()
- wxTraceMask m_ulTraceMask; // controls wxLogTrace behaviour
// the logging functions that can be overriden
// default DoLog() prepends the time stamp and a prefix corresponding
// 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);
-
+
private:
// static variables
// ----------------
- static wxLog *ms_pLogger; // currently active log sink
- static bool ms_bInitialized; // any log targets created?
+ static wxLog *ms_pLogger; // currently active log sink
+ static bool ms_bAutoCreate; // automatically create new log targets?
+ static wxTraceMask ms_ulTraceMask; // controls wxLogTrace behaviour
};
// ----------------------------------------------------------------------------
// close it, clear the log contents or save it to the file.
// ----------------------------------------------------------------------------
class wxLogFrame;
+class wxFrame;
class WXDLLEXPORT wxLogWindow : public wxLog
{
public:
- wxLogWindow(const wxTString& strTitle, bool bShow = TRUE);
+ wxLogWindow(const char *szTitle, // the title of the frame
+ bool bShow = TRUE, // show window immediately?
+ bool bPassToOld = TRUE); // pass log messages to the old target?
~wxLogWindow();
-
- // show/hide the log window
+
+ // window operations
+ // show/hide the log window
void Show(bool bShow = TRUE);
+ // get the frame pointer (you shouldn't close it!)
+ wxFrame *GetFrame() const;
// accessors
+ // the previous log target (may be NULL)
wxLog *GetOldLog() const { return m_pOldLog; }
+ // are we passing the messages to the previous log target?
+ bool IsPassingMessages() const { return m_bPassMessages; }
+
+ // we can pass the messages to the previous log target (we're in this mode by
+ // default: we collect all messages in the window, but also let the default
+ // processing take place)
+ void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
protected:
virtual void DoLog(wxLogLevel level, const char *szString);
virtual void DoLogString(const char *szString);
-
+
private:
- wxLog *m_pOldLog; // previous log target
- wxLogFrame *m_pLogFrame; // the log frame
+ bool m_bPassMessages; // pass messages to m_pOldLog?
+ wxLog *m_pOldLog; // previous log target
+ wxLogFrame *m_pLogFrame; // the log frame
};
// ----------------------------------------------------------------------------
// define wxLog<level>
// -------------------
-// NB: all these functions take `wxTString' and not
-// `const wxTString&' because according to C++ standard
-// the first argument to a vararg function can not be
-// an array, function or reference :-(
-
-// the most generic log function
-void WXDLLEXPORT wxLogGeneric(wxLogLevel level, wxTString strFormat, ...);
-
#define DECLARE_LOG_FUNCTION(level) \
- extern void WXDLLEXPORT wxLog##level(wxTString strFormat, ...)
+ extern void WXDLLEXPORT wxLog##level(const char *szFormat, ...)
+#define DECLARE_LOG_FUNCTION2(level, arg1) \
+ extern void WXDLLEXPORT wxLog##level(arg1, const char *szFormat, ...)
+
+// a generic function for all levels (level is passes as parameter)
+DECLARE_LOG_FUNCTION2(Generic, wxLogLevel level);
// one function per each level
DECLARE_LOG_FUNCTION(FatalError);
// and another one which also takes the error code (for those broken APIs
// that don't set the errno (like registry APIs in Win32))
-void WXDLLEXPORT wxLogSysError(long lErrCode, wxTString strFormat, ...);
+DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
// debug functions do nothing in release mode
#ifdef __WXDEBUG__
- // NB: debug functions don't translate their arguments
- extern void WXDLLEXPORT wxLogDebug(const char *szFormat, ...);
+ DECLARE_LOG_FUNCTION(Debug);
// first king of LogTrace is uncoditional: it doesn't check the level,
// while the second one does nothing if all of level bits are not set
// in wxLog::GetActive()->GetTraceMask().
- extern void WXDLLEXPORT wxLogTrace(const char *szFormat, ...);
- extern void WXDLLEXPORT wxLogTrace(wxTraceMask mask,
- const char *szFormat, ...);
+ DECLARE_LOG_FUNCTION(Trace);
+ DECLARE_LOG_FUNCTION2(Trace, wxTraceMask mask);
#else //!debug
- #define wxLogDebug
- #define wxLogTrace
+ // these functions do nothing
+ inline void wxLogDebug(const char *, ...) { }
+ inline void wxLogTrace(const char *, ...) { }
+ inline void wxLogTrace(wxTraceMask, const char *, ...) { }
#endif
rc, wxSysErrorMsg(rc))
#define wxLogLastError(api) wxLogApiError(api, wxSysErrorCode())
#else //!debug
- #define wxLogApiError(api, rc)
- #define wxLogLastError(api)
+ inline void wxLogApiError(const char *, long) { }
+ inline void wxLogLastError(const char *) { }
#endif //debug/!debug
#endif //__LOGH__