Add virtual keyword where applicable.

[wxWidgets.git] / include / wx / log.h

diff --git a/include/wx/log.h b/include/wx/log.h
index dcb6927b608270e8559d5d03abb0d845ff637b17..29c3464b30de6c2f2e5fd10bc93f775d7b4d736f 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -6,18 +6,32 @@
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
 // Created:     29/01/98
 // RCS-ID:      $Id$
 // Copyright:   (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>

-// Licence:     wxWidgets licence
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_LOG_H_
 #define _WX_LOG_H_
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_LOG_H_
 #define _WX_LOG_H_
 

-#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
-    #pragma interface "log.h"
-#endif
-

 #include "wx/defs.h"
 
 #include "wx/defs.h"
 

+// ----------------------------------------------------------------------------
+// common constants for use in wxUSE_LOG/!wxUSE_LOG
+// ----------------------------------------------------------------------------
+
+// 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
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // types
 // ----------------------------------------------------------------------------


@@ -58,6 +72,7 @@ typedef unsigned long wxLogLevel;
     class WXDLLIMPEXP_CORE wxTextCtrl;
     class WXDLLIMPEXP_CORE wxLogFrame;
     class WXDLLIMPEXP_CORE wxFrame;
     class WXDLLIMPEXP_CORE wxTextCtrl;
     class WXDLLIMPEXP_CORE wxLogFrame;
     class WXDLLIMPEXP_CORE wxFrame;

+    class WXDLLIMPEXP_CORE wxWindow;

 #endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------
 #endif // wxUSE_GUI
 
 // ----------------------------------------------------------------------------


@@ -93,20 +108,6 @@ enum
     #define wxTRACE_OleCalls wxT("ole")  // OLE interface calls
 #endif
 
     #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"
 
 // ----------------------------------------------------------------------------
 #include "wx/iosfwrap.h"
 
 // ----------------------------------------------------------------------------


@@ -118,7 +119,7 @@ class WXDLLIMPEXP_BASE wxLog
 {
 public:
     // ctor
 {
 public:
     // ctor

-    wxLog();
+    wxLog(){}

 
     // Internal buffer.
 
 
     // Internal buffer.
 


@@ -283,11 +284,33 @@ private:
 // "trivial" derivations of wxLog
 // ----------------------------------------------------------------------------
 
 // "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
 {
 // 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);
 public:
     // redirect log output to a FILE
     wxLogStderr(FILE *fp = (FILE *) NULL);


@@ -297,6 +320,8 @@ protected:
     virtual void DoLogString(const wxChar *szString, time_t t);
 
     FILE *m_fp;
     virtual void DoLogString(const wxChar *szString, time_t t);
 
     FILE *m_fp;

+
+    DECLARE_NO_COPY_CLASS(wxLogStderr)

 };
 
 #if wxUSE_STD_IOSTREAM
 };
 
 #if wxUSE_STD_IOSTREAM


@@ -436,28 +461,31 @@ WXDLLIMPEXP_BASE const wxChar* wxSysErrorMsg(unsigned long nErrCode = 0);
 
 #define DECLARE_LOG_FUNCTION(level)                                         \
 extern void WXDLLIMPEXP_BASE wxVLog##level(const wxChar *szFormat,          \
 
 #define DECLARE_LOG_FUNCTION(level)                                         \
 extern void WXDLLIMPEXP_BASE wxVLog##level(const wxChar *szFormat,          \

-                                      va_list argptr);                      \
+                                           va_list argptr);                 \

 extern void WXDLLIMPEXP_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,              \
-                                      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)
-
+                                          ...) ATTRIBUTE_PRINTF_1
+#define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
+extern void expdecl wxVLog##level(argclass arg,                             \
+                                  const wxChar *szFormat,                   \
+                                  va_list argptr);                          \
+extern void expdecl wxLog##level(argclass arg,                              \
+                                 const wxChar *szFormat,                    \
+                                 ...) ATTRIBUTE_PRINTF_2

 #else // !wxUSE_LOG
 
 // log functions do nothing at all
 #define DECLARE_LOG_FUNCTION(level)                                         \
 #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, ...) { }
+inline void wxVLog##level(const wxChar *WXUNUSED(szFormat),                 \
+                          va_list WXUNUSED(argptr)) { }                     \
+inline void wxLog##level(const wxChar *WXUNUSED(szFormat),                  \
+                         ...) { }
+#define DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, expdecl)            \
+inline void wxVLog##level(argclass WXUNUSED(arg),                           \
+                          const wxChar *WXUNUSED(szFormat),                 \
+                          va_list WXUNUSED(argptr)) {}                      \
+inline void wxLog##level(argclass WXUNUSED(arg),                            \
+                         const wxChar *WXUNUSED(szFormat),                  \
+                         ...) { }

 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull
 
 // Empty Class to fake wxLogNull
 class WXDLLIMPEXP_BASE wxLogNull


@@ -474,9 +502,12 @@ public:
 #define wxTRACE_OleCalls wxEmptyString // OLE interface calls
 
 #endif // wxUSE_LOG/!wxUSE_LOG
 #define wxTRACE_OleCalls wxEmptyString // OLE interface calls
 
 #endif // wxUSE_LOG/!wxUSE_LOG

+#define DECLARE_LOG_FUNCTION2(level, argclass, arg)                         \
+    DECLARE_LOG_FUNCTION2_EXP(level, argclass, arg, WXDLLIMPEXP_BASE)
+

 
 // a generic function for all levels (level is passes as parameter)
 
 // 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);
 
 // one function per each level
 DECLARE_LOG_FUNCTION(FatalError);


@@ -492,8 +523,9 @@ DECLARE_LOG_FUNCTION(Status);
 
 #if wxUSE_GUI
     // this one is the same as previous except that it allows to explicitly
 
 #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
     // specify the frame to which the output should go

-    DECLARE_LOG_FUNCTION2_EXP(Status, wxFrame *pFrame, WXDLLIMPEXP_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
 #endif // wxUSE_GUI
 
 // additional one: as wxLogError, but also logs last system call error code


@@ -502,7 +534,7 @@ DECLARE_LOG_FUNCTION(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))
 
 // 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(SysError, long, lErrCode);

 
 // debug functions do nothing in release mode
 #if wxUSE_LOG_DEBUG
 
 // debug functions do nothing in release mode
 #if wxUSE_LOG_DEBUG


@@ -514,20 +546,23 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 
     // this version only logs 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);
+    DECLARE_LOG_FUNCTION2(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
 
     // 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);
+    DECLARE_LOG_FUNCTION2(Trace, wxTraceMask, mask);

 #else   //!debug
     // these functions do nothing in release builds
 #else   //!debug
     // these functions do nothing in release builds

+
+    // note that leaving out "fmt" in the vararg functions provokes a warning
+    // from SGI CC: "the last argument of the varargs function is unnamed"

     inline void wxVLogDebug(const wxChar *, va_list) { }
     inline void wxVLogDebug(const wxChar *, va_list) { }

-    inline void wxLogDebug(const wxChar *, ...) { }
+    inline void wxLogDebug(const wxChar *fmt, ...) { wxUnusedVar(fmt); }

     inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }
     inline void wxVLogTrace(wxTraceMask, const wxChar *, va_list) { }

-    inline void wxLogTrace(wxTraceMask, const wxChar *, ...) { }
+    inline void wxLogTrace(wxTraceMask, const wxChar *fmt, ...) { wxUnusedVar(fmt); }

     inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }
     inline void wxVLogTrace(const wxChar *, const wxChar *, va_list) { }

-    inline void wxLogTrace(const wxChar *, const wxChar *, ...) { }
+    inline void wxLogTrace(const wxChar *, const wxChar *fmt, ...) { wxUnusedVar(fmt); }

 #endif // debug/!debug
 
 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,
 #endif // debug/!debug
 
 // wxLogFatalError helper: show the (fatal) error to the user in a safe way,