1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs)
4 // Author: Vadim Zeitlin
8 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
9 // Licence: wxWindows license
10 /////////////////////////////////////////////////////////////////////////////
12 // ============================================================================
14 // ============================================================================
16 // ----------------------------------------------------------------------------
18 // ----------------------------------------------------------------------------
20 #pragma implementation "log.h"
23 // For compilers that support precompilation, includes "wx.h".
24 #include "wx/wxprec.h"
33 #include <wx/string.h>
38 #include <wx/generic/msgdlgg.h>
39 #include <wx/filedlg.h>
40 #include <wx/textctrl.h>
44 #include <wx/textfile.h>
48 // other standard headers
59 // ----------------------------------------------------------------------------
60 // non member functions
61 // ----------------------------------------------------------------------------
63 // define this to enable wrapping of log messages
64 //#define LOG_PRETTY_WRAP
66 #ifdef LOG_PRETTY_WRAP
67 static void wxLogWrap(FILE *f
, const char *pszPrefix
, const char *psz
);
70 // ----------------------------------------------------------------------------
72 // ----------------------------------------------------------------------------
74 // we use a global variable to store the frame pointer for wxLogStatus - bad,
75 // but it's he easiest way
76 static wxFrame
*gs_pFrame
;
78 // ============================================================================
80 // ============================================================================
82 // ----------------------------------------------------------------------------
83 // implementation of Log functions
85 // NB: unfortunately we need all these distinct functions, we can't make them
86 // macros and not all compilers inline vararg functions.
87 // ----------------------------------------------------------------------------
89 // log functions can't allocate memory (LogError("out of memory...") should
90 // work!), so we use a static buffer for all log messages
91 #define LOG_BUFFER_SIZE (4096)
93 // static buffer for error messages (@@@ MT-unsafe)
94 static char s_szBuf
[LOG_BUFFER_SIZE
];
96 // generic log function
97 void wxLogGeneric(wxLogLevel level
, const char *szFormat
, ...)
99 if ( wxLog::GetActiveTarget() != NULL
) {
101 va_start(argptr
, szFormat
);
102 vsprintf(s_szBuf
, szFormat
, argptr
);
105 wxLog::OnLog(level
, s_szBuf
);
109 #define IMPLEMENT_LOG_FUNCTION(level) \
110 void wxLog##level(const char *szFormat, ...) \
112 if ( wxLog::GetActiveTarget() != NULL ) { \
114 va_start(argptr, szFormat); \
115 vsprintf(s_szBuf, szFormat, argptr); \
118 wxLog::OnLog(wxLOG_##level, s_szBuf); \
122 IMPLEMENT_LOG_FUNCTION(FatalError
)
123 IMPLEMENT_LOG_FUNCTION(Error
)
124 IMPLEMENT_LOG_FUNCTION(Warning
)
125 IMPLEMENT_LOG_FUNCTION(Message
)
126 IMPLEMENT_LOG_FUNCTION(Info
)
127 IMPLEMENT_LOG_FUNCTION(Status
)
129 // accepts an additional argument which tells to which frame the output should
131 void wxLogStatus(wxFrame
*pFrame
, const char *szFormat
, ...)
133 wxLog
*pLog
= wxLog::GetActiveTarget();
134 if ( pLog
!= NULL
) {
136 va_start(argptr
, szFormat
);
137 vsprintf(s_szBuf
, szFormat
, argptr
);
140 wxASSERT( gs_pFrame
== NULL
); // should be reset!
142 wxLog::OnLog(wxLOG_Status
, s_szBuf
);
143 gs_pFrame
= (wxFrame
*) NULL
;
147 // same as info, but only if 'verbose' mode is on
148 void wxLogVerbose(const char *szFormat
, ...)
150 wxLog
*pLog
= wxLog::GetActiveTarget();
151 if ( pLog
!= NULL
&& pLog
->GetVerbose() ) {
153 va_start(argptr
, szFormat
);
154 vsprintf(s_szBuf
, szFormat
, argptr
);
157 wxLog::OnLog(wxLOG_Info
, s_szBuf
);
163 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level) \
164 void wxLog##level(const char *szFormat, ...) \
166 if ( wxLog::GetActiveTarget() != NULL ) { \
168 va_start(argptr, szFormat); \
169 vsprintf(s_szBuf, szFormat, argptr); \
172 wxLog::OnLog(wxLOG_##level, s_szBuf); \
176 void wxLogTrace(wxTraceMask mask
, const char *szFormat
, ...)
178 wxLog
*pLog
= wxLog::GetActiveTarget();
180 // we check that all of mask bits are set in the current mask, so
181 // that wxLogTrace(wxTraceRefCount | wxTraceOle) will only do something
182 // if both bits are set.
183 if ( pLog
!= NULL
&& ((pLog
->GetTraceMask() & mask
) == mask
) ) {
185 va_start(argptr
, szFormat
);
186 vsprintf(s_szBuf
, szFormat
, argptr
);
189 wxLog::OnLog(wxLOG_Trace
, s_szBuf
);
194 #define IMPLEMENT_LOG_DEBUG_FUNCTION(level)
197 IMPLEMENT_LOG_DEBUG_FUNCTION(Debug
)
198 IMPLEMENT_LOG_DEBUG_FUNCTION(Trace
)
200 // wxLogSysError: one uses the last error code, for other you must give it
203 // common part of both wxLogSysError
204 void wxLogSysErrorHelper(long lErrCode
)
206 char szErrMsg
[LOG_BUFFER_SIZE
/ 2];
207 sprintf(szErrMsg
, _(" (error %ld: %s)"), lErrCode
, wxSysErrorMsg(lErrCode
));
208 strncat(s_szBuf
, szErrMsg
, WXSIZEOF(s_szBuf
) - strlen(s_szBuf
));
210 wxLog::OnLog(wxLOG_Error
, s_szBuf
);
213 void WXDLLEXPORT
wxLogSysError(const char *szFormat
, ...)
216 va_start(argptr
, szFormat
);
217 vsprintf(s_szBuf
, szFormat
, argptr
);
220 wxLogSysErrorHelper(wxSysErrorCode());
223 void WXDLLEXPORT
wxLogSysError(long lErrCode
, const char *szFormat
, ...)
226 va_start(argptr
, szFormat
);
227 vsprintf(s_szBuf
, szFormat
, argptr
);
230 wxLogSysErrorHelper(lErrCode
);
233 // ----------------------------------------------------------------------------
234 // wxLog class implementation
235 // ----------------------------------------------------------------------------
239 m_bHasMessages
= FALSE
;
241 m_szTimeFormat
= "[%d/%b/%y %H:%M:%S] ";
244 wxLog
*wxLog::GetActiveTarget()
246 if ( ms_bAutoCreate
&& ms_pLogger
== NULL
) {
247 // prevent infinite recursion if someone calls wxLogXXX() from
248 // wxApp::CreateLogTarget()
249 static bool s_bInGetActiveTarget
= FALSE
;
250 if ( !s_bInGetActiveTarget
) {
251 s_bInGetActiveTarget
= TRUE
;
254 ms_pLogger
= new wxLogStderr
;
256 // ask the application to create a log target for us
257 if ( wxTheApp
!= NULL
)
258 ms_pLogger
= wxTheApp
->CreateLogTarget();
261 s_bInGetActiveTarget
= FALSE
;
263 // do nothing if it fails - what can we do?
270 wxLog
*wxLog::SetActiveTarget(wxLog
*pLogger
)
272 if ( ms_pLogger
!= NULL
) {
273 // flush the old messages before changing because otherwise they might
274 // get lost later if this target is not restored
278 wxLog
*pOldLogger
= ms_pLogger
;
279 ms_pLogger
= pLogger
;
284 wxString
wxLog::TimeStamp() const
288 /* Let's disable TimeStamp and see if anyone complains.
289 * If not, we'll remove it, since it's probably unlikely
290 * to ever be used. -- JACS 22/11/98
291 if ( !IsEmpty(m_szTimeFormat) ) {
297 ptmNow = localtime(&timeNow);
299 strftime(szBuf, WXSIZEOF(szBuf), m_szTimeFormat, ptmNow);
307 void wxLog::DoLog(wxLogLevel level
, const char *szString
)
309 // prepend a timestamp if not disabled
310 wxString str
= TimeStamp();
313 case wxLOG_FatalError
:
314 DoLogString(str
<< _("Fatal error: ") << szString
);
315 DoLogString(_("Program aborted."));
321 DoLogString(str
<< _("Error: ") << szString
);
325 DoLogString(str
<< _("Warning: ") << szString
);
331 DoLogString(str
+ szString
);
341 DoLogString(str
<< (level
== wxLOG_Trace
? _("Trace") : _("Debug"))
342 << ": " << szString
);
348 wxFAIL_MSG(_("unknown log level in wxLog::DoLog"));
352 void wxLog::DoLogString(const char *WXUNUSED(szString
))
354 wxFAIL_MSG(_("DoLogString must be overrided if it's called."));
362 // ----------------------------------------------------------------------------
363 // wxLogStderr class implementation
364 // ----------------------------------------------------------------------------
366 wxLogStderr::wxLogStderr(FILE *fp
)
374 void wxLogStderr::DoLogString(const char *szString
)
376 fputs(szString
, m_fp
);
381 // ----------------------------------------------------------------------------
382 // wxLogStream implementation
383 // ----------------------------------------------------------------------------
385 wxLogStream::wxLogStream(ostream
*ostr
)
393 void wxLogStream::DoLogString(const char *szString
)
395 (*m_ostr
) << szString
<< endl
<< flush
;
399 // ----------------------------------------------------------------------------
400 // wxLogTextCtrl implementation
401 // ----------------------------------------------------------------------------
402 wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl
*pTextCtrl
)
403 // @@@ TODO: in wxGTK wxTextCtrl doesn't derive from streambuf
405 // Also, in DLL mode in wxMSW, can't use it.
406 #if defined(NO_TEXT_WINDOW_STREAM)
408 : wxLogStream(new ostream(pTextCtrl
))
413 wxLogTextCtrl::~wxLogTextCtrl()
418 // ----------------------------------------------------------------------------
419 // wxLogGui implementation
420 // ----------------------------------------------------------------------------
427 void wxLogGui::Flush()
429 if ( !m_bHasMessages
)
432 // do it right now to block any new calls to Flush() while we're here
433 m_bHasMessages
= FALSE
;
437 // concatenate all strings (but not too many to not overfill the msg box)
440 nMsgCount
= m_aMessages
.Count();
442 // start from the most recent message
443 for ( size_t n
= nMsgCount
; n
> 0; n
-- ) {
444 // for Windows strings longer than this value are wrapped (NT 4.0)
445 const size_t nMsgLineWidth
= 156;
447 nLines
+= (m_aMessages
[n
- 1].Len() + nMsgLineWidth
- 1) / nMsgLineWidth
;
449 if ( nLines
> 25 ) // don't put too many lines in message box
452 str
<< m_aMessages
[n
- 1] << "\n";
456 wxMessageBox(str
, _("Error"), wxOK
| wxICON_EXCLAMATION
);
459 wxMessageBox(str
, _("Information"), wxOK
| wxICON_INFORMATION
);
462 // no undisplayed messages whatsoever
467 // the default behaviour is to discard all informational messages if there
468 // are any errors/warnings.
469 void wxLogGui::DoLog(wxLogLevel level
, const char *szString
)
476 m_aMessages
.Add(szString
);
477 m_bHasMessages
= TRUE
;
483 // find the top window and set it's status text if it has any
484 wxFrame
*pFrame
= gs_pFrame
;
485 if ( pFrame
== NULL
) {
486 wxWindow
*pWin
= wxTheApp
->GetTopWindow();
487 if ( pWin
!= NULL
&& pWin
->IsKindOf(CLASSINFO(wxFrame
)) ) {
488 pFrame
= (wxFrame
*)pWin
;
492 if ( pFrame
!= NULL
)
493 pFrame
->SetStatusText(szString
);
501 wxString strTime
= TimeStamp();
504 // don't prepend debug/trace here: it goes to the debug window
505 // anyhow, but do put a timestamp
506 OutputDebugString(strTime
+ szString
+ "\n\r");
508 // send them to stderr
509 fprintf(stderr
, "%s %s: %s\n",
511 level
== wxLOG_Trace
? _("Trace") : _("Debug"),
519 case wxLOG_FatalError
:
520 // show this one immediately
521 wxMessageBox(szString
, _("Fatal error"), wxICON_HAND
);
526 // discard earlier informational messages if this is the 1st error
529 m_bHasMessages
= TRUE
;
533 m_aMessages
.Add(szString
);
537 wxFAIL_MSG(_("unknown log level in wxLogGui::DoLog"));
541 // ----------------------------------------------------------------------------
542 // wxLogWindow and wxLogFrame implementation
543 // ----------------------------------------------------------------------------
547 class wxLogFrame
: public wxFrame
551 wxLogFrame(wxFrame
*pParent
, wxLogWindow
*log
, const char *szTitle
);
552 virtual ~wxLogFrame();
555 void OnClose(wxCommandEvent
& event
);
556 void OnCloseWindow(wxCloseEvent
& event
);
557 void OnSave (wxCommandEvent
& event
);
558 void OnClear(wxCommandEvent
& event
);
560 void OnIdle(wxIdleEvent
&);
563 wxTextCtrl
*TextCtrl() const { return m_pTextCtrl
; }
573 // instead of closing just hide the window to be able to Show() it later
574 void DoClose() { Show(FALSE
); }
576 wxTextCtrl
*m_pTextCtrl
;
579 DECLARE_EVENT_TABLE()
582 BEGIN_EVENT_TABLE(wxLogFrame
, wxFrame
)
583 // wxLogWindow menu events
584 EVT_MENU(Menu_Close
, wxLogFrame::OnClose
)
585 EVT_MENU(Menu_Save
, wxLogFrame::OnSave
)
586 EVT_MENU(Menu_Clear
, wxLogFrame::OnClear
)
588 EVT_CLOSE(wxLogFrame::OnCloseWindow
)
591 wxLogFrame::wxLogFrame(wxFrame
*pParent
, wxLogWindow
*log
, const char *szTitle
)
592 : wxFrame(pParent
, -1, szTitle
)
596 // @@ kludge: wxSIMPLE_BORDER is simply to prevent wxWindows from creating
597 // a rich edit control instead of a normal one we want in wxMSW
598 m_pTextCtrl
= new wxTextCtrl(this, -1, wxEmptyString
, wxDefaultPosition
,
606 wxMenuBar
*pMenuBar
= new wxMenuBar
;
607 wxMenu
*pMenu
= new wxMenu
;
608 pMenu
->Append(Menu_Save
, _("&Save..."), _("Save log contents to file"));
609 pMenu
->Append(Menu_Clear
, _("C&lear"), _("Clear the log contents"));
610 pMenu
->AppendSeparator();
611 pMenu
->Append(Menu_Close
, _("&Close"), _("Close this window"));
612 pMenuBar
->Append(pMenu
, _("&Log"));
613 SetMenuBar(pMenuBar
);
615 // status bar for menu prompts
618 m_log
->OnFrameCreate(this);
621 void wxLogFrame::OnClose(wxCommandEvent
& WXUNUSED(event
))
626 void wxLogFrame::OnCloseWindow(wxCloseEvent
& WXUNUSED(event
))
631 void wxLogFrame::OnSave(wxCommandEvent
& WXUNUSED(event
))
635 const char *szFileName
= wxSaveFileSelector("log", "txt", "log.txt");
636 if ( szFileName
== NULL
) {
645 if ( wxFile::Exists(szFileName
) ) {
646 bool bAppend
= FALSE
;
648 strMsg
.Printf(_("Append log to file '%s' "
649 "(choosing [No] will overwrite it)?"), szFileName
);
650 switch ( wxMessageBox(strMsg
, _("Question"), wxYES_NO
| wxCANCEL
) ) {
663 wxFAIL_MSG(_("invalid message box return value"));
667 bOk
= file
.Open(szFileName
, wxFile::write_append
);
670 bOk
= file
.Create(szFileName
, TRUE
/* overwrite */);
674 bOk
= file
.Create(szFileName
);
677 // retrieve text and save it
678 // -------------------------
680 // @@@@ TODO: no GetNumberOfLines and GetLineText in wxGTK yet
681 wxLogError(_("Sorry, this function is not implemented under GTK"));
683 int nLines
= m_pTextCtrl
->GetNumberOfLines();
684 for ( int nLine
= 0; bOk
&& nLine
< nLines
; nLine
++ ) {
685 bOk
= file
.Write(m_pTextCtrl
->GetLineText(nLine
) + wxTextFile::GetEOL());
693 wxLogError(_("Can't save log contents to file."));
698 void wxLogFrame::OnClear(wxCommandEvent
& WXUNUSED(event
))
700 m_pTextCtrl
->Clear();
703 wxLogFrame::~wxLogFrame()
705 m_log
->OnFrameDelete(this);
710 wxLogWindow::wxLogWindow(wxFrame
*pParent
,
715 m_bPassMessages
= bDoPass
;
717 m_pLogFrame
= new wxLogFrame(pParent
, this, szTitle
);
718 m_pOldLog
= wxLog::SetActiveTarget(this);
721 m_pLogFrame
->Show(TRUE
);
724 void wxLogWindow::Show(bool bShow
)
726 m_pLogFrame
->Show(bShow
);
729 void wxLogWindow::Flush()
731 if ( m_pOldLog
!= NULL
)
734 m_bHasMessages
= FALSE
;
737 void wxLogWindow::DoLog(wxLogLevel level
, const char *szString
)
739 // first let the previous logger show it
740 if ( m_pOldLog
!= NULL
&& m_bPassMessages
) {
741 // @@@ why can't we access protected wxLog method from here (we derive
742 // from wxLog)? gcc gives "DoLog is protected in this context", what
743 // does this mean? Anyhow, the cast is harmless and let's us do what
745 ((wxLogWindow
*)m_pOldLog
)->DoLog(level
, szString
);
751 // by default, these messages are ignored by wxLog, so process
754 wxString str
= TimeStamp();
755 str
<< _("Status: ") << szString
;
760 // don't put trace messages in the text window for 2 reasons:
761 // 1) there are too many of them
762 // 2) they may provoke other trace messages thus sending a program
763 // into an infinite loop
768 // and this will format it nicely and call our DoLogString()
769 wxLog::DoLog(level
, szString
);
773 m_bHasMessages
= TRUE
;
776 void wxLogWindow::DoLogString(const char *szString
)
778 // put the text into our window
779 wxTextCtrl
*pText
= m_pLogFrame
->TextCtrl();
781 // remove selection (WriteText is in fact ReplaceSelection)
783 long nLen
= pText
->GetLastPosition();
784 pText
->SetSelection(nLen
, nLen
);
787 pText
->WriteText(szString
);
788 pText
->WriteText("\n"); // "\n" ok here (_not_ "\r\n")
790 // TODO ensure that the line can be seen
793 wxFrame
*wxLogWindow::GetFrame() const
798 void wxLogWindow::OnFrameCreate(wxFrame
*WXUNUSED(frame
))
802 void wxLogWindow::OnFrameDelete(wxFrame
*WXUNUSED(frame
))
804 m_pLogFrame
= (wxLogFrame
*)NULL
;
807 wxLogWindow::~wxLogWindow()
811 // may be NULL if log frame already auto destroyed itself
817 // ============================================================================
818 // Global functions/variables
819 // ============================================================================
821 // ----------------------------------------------------------------------------
823 // ----------------------------------------------------------------------------
824 wxLog
*wxLog::ms_pLogger
= (wxLog
*) NULL
;
825 bool wxLog::ms_doLog
= TRUE
;
826 bool wxLog::ms_bAutoCreate
= TRUE
;
827 wxTraceMask
wxLog::ms_ulTraceMask
= (wxTraceMask
)0;
829 // ----------------------------------------------------------------------------
830 // stdout error logging helper
831 // ----------------------------------------------------------------------------
833 // helper function: wraps the message and justifies it under given position
834 // (looks more pretty on the terminal). Also adds newline at the end.
836 // @@ this is now disabled until I find a portable way of determining the
837 // terminal window size (ok, I found it but does anybody really cares?)
838 #ifdef LOG_PRETTY_WRAP
839 static void wxLogWrap(FILE *f
, const char *pszPrefix
, const char *psz
)
841 size_t nMax
= 80; // @@@@
842 size_t nStart
= strlen(pszPrefix
);
846 while ( *psz
!= '\0' ) {
847 for ( n
= nStart
; (n
< nMax
) && (*psz
!= '\0'); n
++ )
851 if ( *psz
!= '\0' ) {
853 for ( n
= 0; n
< nStart
; n
++ )
856 // as we wrapped, squeeze all white space
857 while ( isspace(*psz
) )
864 #endif //LOG_PRETTY_WRAP
866 // ----------------------------------------------------------------------------
867 // error code/error message retrieval functions
868 // ----------------------------------------------------------------------------
870 // get error code from syste
871 unsigned long wxSysErrorCode()
875 return ::GetLastError();
877 // @@@@ what to do on Windows 3.1?
885 // get error message from system
886 const char *wxSysErrorMsg(unsigned long nErrCode
)
889 nErrCode
= wxSysErrorCode();
893 static char s_szBuf
[LOG_BUFFER_SIZE
/ 2];
895 // get error message from system
897 FormatMessage(FORMAT_MESSAGE_ALLOCATE_BUFFER
| FORMAT_MESSAGE_FROM_SYSTEM
,
899 MAKELANGID(LANG_NEUTRAL
, SUBLANG_DEFAULT
),
903 // copy it to our buffer and free memory
904 strncpy(s_szBuf
, (const char *)lpMsgBuf
, WXSIZEOF(s_szBuf
) - 1);
905 s_szBuf
[WXSIZEOF(s_szBuf
) - 1] = '\0';
908 // returned string is capitalized and ended with '\r\n' - bad
909 s_szBuf
[0] = (char)wxToLower(s_szBuf
[0]);
910 size_t len
= strlen(s_szBuf
);
913 if ( s_szBuf
[len
- 2] == '\r' )
914 s_szBuf
[len
- 2] = '\0';
923 return strerror(nErrCode
);
927 // ----------------------------------------------------------------------------
929 // ----------------------------------------------------------------------------
937 #elif defined(__WXSTUBS__)
944 // this function is called when an assert fails
945 void wxOnAssert(const char *szFile
, int nLine
, const char *szMsg
)
947 // this variable can be set to true to suppress "assert failure" messages
948 static bool s_bNoAsserts
= FALSE
;
949 static bool s_bInAssert
= FALSE
;
952 // He-e-e-e-elp!! we're trapped in endless loop
960 char szBuf
[LOG_BUFFER_SIZE
];
961 sprintf(szBuf
, _("Assert failed in file %s at line %d"), szFile
, nLine
);
962 if ( szMsg
!= NULL
) {
964 strcat(szBuf
, szMsg
);
970 if ( !s_bNoAsserts
) {
971 // send it to the normal log destination
977 strcat(szBuf
, _("\nDo you want to stop the program?"
978 "\nYou can also choose [Cancel] to suppress "
979 "further warnings."));
981 switch ( wxMessageBox(szBuf
, _("Debug"),
982 wxYES_NO
| wxCANCEL
| wxICON_STOP
) ) {
991 //case wxNO: nothing to do