]>
git.saurik.com Git - wxWidgets.git/blob - src/generic/logg.cpp
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: wxLog-derived classes which need GUI support (the rest is in
5 // Author: Vadim Zeitlin
7 // Created: 20.09.99 (extracted from src/common/log.cpp)
9 // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
13 // ============================================================================
15 // ============================================================================
17 // ----------------------------------------------------------------------------
19 // ----------------------------------------------------------------------------
21 // no #pragma implementation "log.h" because it's already in src/common/log.cpp
23 // For compilers that support precompilation, includes "wx.h".
24 #include "wx/wxprec.h"
31 #error "This file can't be compiled without GUI!"
40 #include "wx/filedlg.h"
41 #include "wx/msgdlg.h"
42 #include "wx/textctrl.h"
44 #include "wx/statbmp.h"
48 #include "wx/textfile.h"
51 // for OutputDebugString()
52 #include "wx/msw/private.h"
55 // may be defined to 0 for old behavior (using wxMessageBox) - shouldn't be
56 // changed normally (that's why it's here and not in setup.h)
57 #define wxUSE_LOG_DIALOG 1
60 #include "wx/datetime.h"
61 #include "wx/listctrl.h"
63 #else // !wxUSE_TEXTFILE
64 #include "wx/msgdlg.h"
65 #endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
67 // ----------------------------------------------------------------------------
69 // ----------------------------------------------------------------------------
73 class wxLogDialog
: public wxDialog
76 wxLogDialog(wxWindow
*parent
,
77 const wxArrayString
& messages
,
78 const wxArrayInt
& severity
,
79 const wxArrayLong
& timess
,
80 const wxString
& caption
,
82 virtual ~wxLogDialog();
85 void OnOk(wxCommandEvent
& event
);
86 void OnDetails(wxCommandEvent
& event
);
87 void OnListSelect(wxListEvent
& event
);
90 // the data for the listctrl
91 wxArrayString m_messages
;
92 wxArrayInt m_severity
;
95 // the "toggle" button and its state
96 wxButton
*m_btnDetails
;
97 bool m_showingDetails
;
99 // the listctrl (not shown initially)
100 wxListCtrl
*m_listctrl
;
102 DECLARE_EVENT_TABLE()
105 BEGIN_EVENT_TABLE(wxLogDialog
, wxDialog
)
106 EVT_BUTTON(wxID_OK
, wxLogDialog::OnOk
)
107 EVT_BUTTON(wxID_MORE
, wxLogDialog::OnDetails
)
108 EVT_LIST_ITEM_SELECTED(-1, wxLogDialog::OnListSelect
)
111 #endif // wxUSE_LOG_DIALOG
113 // ----------------------------------------------------------------------------
115 // ----------------------------------------------------------------------------
117 // we use a global variable to store the frame pointer for wxLogStatus - bad,
118 // but it's he easiest way
119 static wxFrame
*gs_pFrame
; // FIXME MT-unsafe
121 // ============================================================================
123 // ============================================================================
125 // ----------------------------------------------------------------------------
127 // ----------------------------------------------------------------------------
129 // accepts an additional argument which tells to which frame the output should
131 void wxLogStatus(wxFrame
*pFrame
, const wxChar
*szFormat
, ...)
135 wxLog
*pLog
= wxLog::GetActiveTarget();
136 if ( pLog
!= NULL
) {
138 va_start(argptr
, szFormat
);
139 msg
.PrintfV(szFormat
, argptr
);
142 wxASSERT( gs_pFrame
== NULL
); // should be reset!
144 wxLog::OnLog(wxLOG_Status
, msg
, time(NULL
));
145 gs_pFrame
= (wxFrame
*) NULL
;
149 // ----------------------------------------------------------------------------
150 // wxLogTextCtrl implementation
151 // ----------------------------------------------------------------------------
153 wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl
*pTextCtrl
)
155 m_pTextCtrl
= pTextCtrl
;
158 void wxLogTextCtrl::DoLogString(const wxChar
*szString
, time_t WXUNUSED(t
))
162 msg
<< szString
<< wxT('\n');
164 m_pTextCtrl
->AppendText(msg
);
167 // ----------------------------------------------------------------------------
168 // wxLogGui implementation (FIXME MT-unsafe)
169 // ----------------------------------------------------------------------------
176 void wxLogGui::Clear()
178 m_bErrors
= m_bWarnings
= FALSE
;
184 void wxLogGui::Flush()
186 if ( !m_bHasMessages
)
189 // do it right now to block any new calls to Flush() while we're here
190 m_bHasMessages
= FALSE
;
192 wxString title
= wxTheApp
->GetAppName();
195 title
[0u] = wxToupper(title
[0u]);
204 else if ( m_bWarnings
) {
205 title
+= _("Warning");
206 style
= wxICON_EXCLAMATION
;
209 title
+= _("Information");
210 style
= wxICON_INFORMATION
;
214 wxLogDialog
dlg(wxTheApp
->GetTopWindow(),
215 m_aMessages
, m_aSeverity
, m_aTimes
,
218 // clear the message list before showing the dialog because while it's
219 // shown some new messages may appear
222 (void)dlg
.ShowModal();
224 #else // !wxUSE_LOG_DIALOG
225 // concatenate all strings (but not too many to not overfill the msg box)
228 nMsgCount
= m_aMessages
.Count();
230 // start from the most recent message
231 for ( size_t n
= nMsgCount
; n
> 0; n
-- ) {
232 // for Windows strings longer than this value are wrapped (NT 4.0)
233 const size_t nMsgLineWidth
= 156;
235 nLines
+= (m_aMessages
[n
- 1].Len() + nMsgLineWidth
- 1) / nMsgLineWidth
;
237 if ( nLines
> 25 ) // don't put too many lines in message box
240 str
<< m_aMessages
[n
- 1] << wxT("\n");
243 wxMessageBox(str
, title
, wxOK
| style
);
245 // no undisplayed messages whatsoever
247 #endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
250 m_bHasMessages
= FALSE
;
253 // the default behaviour is to discard all informational messages if there
254 // are any errors/warnings.
255 void wxLogGui::DoLog(wxLogLevel level
, const wxChar
*szString
, time_t t
)
263 m_aMessages
.Add(szString
);
264 m_aSeverity
.Add(wxLOG_Message
);
265 m_aTimes
.Add((long)t
);
266 m_bHasMessages
= TRUE
;
274 // find the top window and set it's status text if it has any
275 wxFrame
*pFrame
= gs_pFrame
;
276 if ( pFrame
== NULL
) {
277 wxWindow
*pWin
= wxTheApp
->GetTopWindow();
278 if ( pWin
!= NULL
&& pWin
->IsKindOf(CLASSINFO(wxFrame
)) ) {
279 pFrame
= (wxFrame
*)pWin
;
283 if ( pFrame
&& pFrame
->GetStatusBar() )
284 pFrame
->SetStatusText(szString
);
286 #endif // wxUSE_STATUSBAR
294 // don't prepend debug/trace here: it goes to the
295 // debug window anyhow, but do put a timestamp
298 str
<< szString
<< wxT("\n\r");
299 OutputDebugString(str
);
301 // send them to stderr
302 wxFprintf(stderr
, wxT("%s: %s\n"),
303 level
== wxLOG_Trace
? wxT("Trace")
309 #endif // __WXDEBUG__
313 case wxLOG_FatalError
:
314 // show this one immediately
315 wxMessageBox(szString
, _("Fatal error"), wxICON_HAND
);
321 #if !wxUSE_LOG_DIALOG
322 // discard earlier informational messages if this is the 1st
323 // error because they might not make sense any more and showing
324 // them in a message box might be confusing
328 #endif // wxUSE_LOG_DIALOG
335 // for the warning we don't discard the info messages
339 m_aMessages
.Add(szString
);
340 m_aSeverity
.Add((int)level
);
341 m_aTimes
.Add((long)t
);
342 m_bHasMessages
= TRUE
;
347 // ----------------------------------------------------------------------------
348 // wxLogWindow and wxLogFrame implementation
349 // ----------------------------------------------------------------------------
353 class wxLogFrame
: public wxFrame
357 wxLogFrame(wxFrame
*pParent
, wxLogWindow
*log
, const wxChar
*szTitle
);
358 virtual ~wxLogFrame();
361 void OnClose(wxCommandEvent
& event
);
362 void OnCloseWindow(wxCloseEvent
& event
);
364 void OnSave (wxCommandEvent
& event
);
366 void OnClear(wxCommandEvent
& event
);
368 void OnIdle(wxIdleEvent
&);
371 wxTextCtrl
*TextCtrl() const { return m_pTextCtrl
; }
381 // instead of closing just hide the window to be able to Show() it later
382 void DoClose() { Show(FALSE
); }
384 wxTextCtrl
*m_pTextCtrl
;
387 DECLARE_EVENT_TABLE()
390 BEGIN_EVENT_TABLE(wxLogFrame
, wxFrame
)
391 // wxLogWindow menu events
392 EVT_MENU(Menu_Close
, wxLogFrame::OnClose
)
394 EVT_MENU(Menu_Save
, wxLogFrame::OnSave
)
396 EVT_MENU(Menu_Clear
, wxLogFrame::OnClear
)
398 EVT_CLOSE(wxLogFrame::OnCloseWindow
)
401 wxLogFrame::wxLogFrame(wxFrame
*pParent
, wxLogWindow
*log
, const wxChar
*szTitle
)
402 : wxFrame(pParent
, -1, szTitle
)
406 m_pTextCtrl
= new wxTextCtrl(this, -1, wxEmptyString
, wxDefaultPosition
,
413 wxMenuBar
*pMenuBar
= new wxMenuBar
;
414 wxMenu
*pMenu
= new wxMenu
;
416 pMenu
->Append(Menu_Save
, _("&Save..."), _("Save log contents to file"));
418 pMenu
->Append(Menu_Clear
, _("C&lear"), _("Clear the log contents"));
419 pMenu
->AppendSeparator();
420 pMenu
->Append(Menu_Close
, _("&Close"), _("Close this window"));
421 pMenuBar
->Append(pMenu
, _("&Log"));
422 SetMenuBar(pMenuBar
);
425 // status bar for menu prompts
427 #endif // wxUSE_STATUSBAR
429 m_log
->OnFrameCreate(this);
432 void wxLogFrame::OnClose(wxCommandEvent
& WXUNUSED(event
))
437 void wxLogFrame::OnCloseWindow(wxCloseEvent
& WXUNUSED(event
))
443 void wxLogFrame::OnSave(wxCommandEvent
& WXUNUSED(event
))
447 const wxChar
*szFileName
= wxSaveFileSelector(wxT("log"), wxT("txt"), wxT("log.txt"));
448 if ( szFileName
== NULL
) {
457 if ( wxFile::Exists(szFileName
) ) {
458 bool bAppend
= FALSE
;
460 strMsg
.Printf(_("Append log to file '%s' "
461 "(choosing [No] will overwrite it)?"), szFileName
);
462 switch ( wxMessageBox(strMsg
, _("Question"), wxYES_NO
| wxCANCEL
) ) {
475 wxFAIL_MSG(_("invalid message box return value"));
479 bOk
= file
.Open(szFileName
, wxFile::write_append
);
482 bOk
= file
.Create(szFileName
, TRUE
/* overwrite */);
486 bOk
= file
.Create(szFileName
);
489 // retrieve text and save it
490 // -------------------------
491 int nLines
= m_pTextCtrl
->GetNumberOfLines();
492 for ( int nLine
= 0; bOk
&& nLine
< nLines
; nLine
++ ) {
493 bOk
= file
.Write(m_pTextCtrl
->GetLineText(nLine
) +
494 // we're not going to pull in the whole wxTextFile if all we need is this...
497 #else // !wxUSE_TEXTFILE
499 #endif // wxUSE_TEXTFILE
507 wxLogError(_("Can't save log contents to file."));
510 wxLogStatus(this, _("Log saved to the file '%s'."), szFileName
);
515 void wxLogFrame::OnClear(wxCommandEvent
& WXUNUSED(event
))
517 m_pTextCtrl
->Clear();
520 wxLogFrame::~wxLogFrame()
522 m_log
->OnFrameDelete(this);
527 wxLogWindow::wxLogWindow(wxFrame
*pParent
,
528 const wxChar
*szTitle
,
532 m_bPassMessages
= bDoPass
;
534 m_pLogFrame
= new wxLogFrame(pParent
, this, szTitle
);
535 m_pOldLog
= wxLog::SetActiveTarget(this);
538 m_pLogFrame
->Show(TRUE
);
541 void wxLogWindow::Show(bool bShow
)
543 m_pLogFrame
->Show(bShow
);
546 void wxLogWindow::Flush()
548 if ( m_pOldLog
!= NULL
)
551 m_bHasMessages
= FALSE
;
554 void wxLogWindow::DoLog(wxLogLevel level
, const wxChar
*szString
, time_t t
)
556 // first let the previous logger show it
557 if ( m_pOldLog
!= NULL
&& m_bPassMessages
) {
558 // bogus cast just to access protected DoLog
559 ((wxLogWindow
*)m_pOldLog
)->DoLog(level
, szString
, t
);
565 // by default, these messages are ignored by wxLog, so process
567 if ( !wxIsEmpty(szString
) )
570 str
<< _("Status: ") << szString
;
575 // don't put trace messages in the text window for 2 reasons:
576 // 1) there are too many of them
577 // 2) they may provoke other trace messages thus sending a program
578 // into an infinite loop
583 // and this will format it nicely and call our DoLogString()
584 wxLog::DoLog(level
, szString
, t
);
588 m_bHasMessages
= TRUE
;
591 void wxLogWindow::DoLogString(const wxChar
*szString
, time_t WXUNUSED(t
))
593 // put the text into our window
594 wxTextCtrl
*pText
= m_pLogFrame
->TextCtrl();
596 // remove selection (WriteText is in fact ReplaceSelection)
598 long nLen
= pText
->GetLastPosition();
599 pText
->SetSelection(nLen
, nLen
);
604 msg
<< szString
<< wxT('\n');
606 pText
->AppendText(msg
);
608 // TODO ensure that the line can be seen
611 wxFrame
*wxLogWindow::GetFrame() const
616 void wxLogWindow::OnFrameCreate(wxFrame
* WXUNUSED(frame
))
620 void wxLogWindow::OnFrameDelete(wxFrame
* WXUNUSED(frame
))
622 m_pLogFrame
= (wxLogFrame
*)NULL
;
625 wxLogWindow::~wxLogWindow()
629 // may be NULL if log frame already auto destroyed itself
633 // ----------------------------------------------------------------------------
635 // ----------------------------------------------------------------------------
639 static const size_t MARGIN
= 10;
641 wxLogDialog::wxLogDialog(wxWindow
*parent
,
642 const wxArrayString
& messages
,
643 const wxArrayInt
& severity
,
644 const wxArrayLong
& times
,
645 const wxString
& caption
,
647 : wxDialog(parent
, -1, caption
)
649 size_t count
= messages
.GetCount();
650 m_messages
.Alloc(count
);
651 m_severity
.Alloc(count
);
652 m_times
.Alloc(count
);
654 for ( size_t n
= 0; n
< count
; n
++ )
656 wxString msg
= messages
[n
];
659 m_messages
.Add(msg
.BeforeFirst(_T('\n')));
660 msg
= msg
.AfterFirst(_T('\n'));
662 m_severity
.Add(severity
[n
]);
663 m_times
.Add(times
[n
]);
668 m_showingDetails
= FALSE
; // not initially
669 m_listctrl
= (wxListCtrl
*)NULL
;
671 // create the controls which are always shown and layout them: we use
672 // sizers even though our window is not resizeable to calculate the size of
673 // the dialog properly
674 wxBoxSizer
*sizerTop
= new wxBoxSizer(wxVERTICAL
);
675 wxBoxSizer
*sizerButtons
= new wxBoxSizer(wxVERTICAL
);
676 wxBoxSizer
*sizerAll
= new wxBoxSizer(wxHORIZONTAL
);
678 wxButton
*btnOk
= new wxButton(this, wxID_OK
, _T("OK"));
679 sizerButtons
->Add(btnOk
, 0, wxCENTRE
|wxBOTTOM
, MARGIN
/2);
680 m_btnDetails
= new wxButton(this, wxID_MORE
, _T("&Details >>"));
681 sizerButtons
->Add(m_btnDetails
, 0, wxCENTRE
|wxTOP
, MARGIN
/2 - 1);
683 wxIcon icon
= wxTheApp
->GetStdIcon((int)(style
& wxICON_MASK
));
684 sizerAll
->Add(new wxStaticBitmap(this, -1, icon
), 0, wxCENTRE
);
685 const wxString
& message
= messages
.Last();
686 sizerAll
->Add(CreateTextSizer(message
), 0, wxCENTRE
|wxLEFT
|wxRIGHT
, MARGIN
);
687 sizerAll
->Add(sizerButtons
, 0, wxALIGN_RIGHT
|wxLEFT
, MARGIN
);
689 sizerTop
->Add(sizerAll
, 0, wxCENTRE
|wxALL
, MARGIN
);
694 sizerTop
->SetSizeHints(this);
701 // no details... it's easier to disable a button than to change the
702 // dialog layout depending on whether we have details or not
703 m_btnDetails
->Disable();
709 void wxLogDialog::OnListSelect(wxListEvent
& event
)
711 // we can't just disable the control because this looks ugly under Windows
712 // (wrong bg colour, no scrolling...), but we still want to disable
713 // selecting items - it makes no sense here
714 m_listctrl
->SetItemState(event
.GetItem(), 0, wxLIST_STATE_SELECTED
);
717 void wxLogDialog::OnOk(wxCommandEvent
& WXUNUSED(event
))
722 void wxLogDialog::OnDetails(wxCommandEvent
& WXUNUSED(event
))
724 wxSizer
*sizer
= GetSizer();
726 if ( m_showingDetails
)
728 m_btnDetails
->SetLabel(_T("&Details >>"));
730 sizer
->Remove(m_listctrl
);
732 else // show details now
734 m_btnDetails
->SetLabel(_T("<< &Details"));
739 m_listctrl
= new wxListCtrl(this, -1,
740 wxDefaultPosition
, wxDefaultSize
,
745 m_listctrl
->InsertColumn(0, _("Message"));
746 m_listctrl
->InsertColumn(1, _("Time"));
748 // prepare the imagelist
749 static const int ICON_SIZE
= 16;
750 wxImageList
*imageList
= new wxImageList(ICON_SIZE
, ICON_SIZE
);
752 // order should be the same as in the switch below!
753 static const int icons
[] =
760 for ( size_t icon
= 0; icon
< WXSIZEOF(icons
); icon
++ )
762 wxBitmap bmp
= wxTheApp
->GetStdIcon(icons
[icon
]);
763 imageList
->Add(wxImage(bmp
).
764 Rescale(ICON_SIZE
, ICON_SIZE
).
768 m_listctrl
->SetImageList(imageList
, wxIMAGE_LIST_SMALL
);
771 wxString fmt
= wxLog::GetTimestamp();
778 size_t count
= m_messages
.GetCount();
779 for ( size_t n
= 0; n
< count
; n
++ )
782 switch ( m_severity
[n
] )
796 m_listctrl
->InsertItem(n
, m_messages
[n
], image
);
797 m_listctrl
->SetItem(n
, 1,
798 wxDateTime((time_t)m_times
[n
]).Format(fmt
));
801 // let the columns size themselves
802 m_listctrl
->SetColumnWidth(0, wxLIST_AUTOSIZE
);
803 m_listctrl
->SetColumnWidth(1, wxLIST_AUTOSIZE
);
805 // get the approx height of the listctrl
806 wxFont font
= GetFont();
808 font
= *wxSWISS_FONT
;
811 GetTextExtent(_T("H"), (int*)NULL
, &y
, (int*)NULL
, (int*)NULL
, &font
);
812 int height
= wxMin(y
*(count
+ 3), 100);
813 m_listctrl
->SetSize(-1, height
);
816 sizer
->Add(m_listctrl
, 1, wxEXPAND
|(wxALL
& ~wxTOP
), MARGIN
);
819 m_showingDetails
= !m_showingDetails
;
821 // in any case, our size changed - update
822 sizer
->SetSizeHints(this);
826 wxLogDialog::~wxLogDialog()
830 delete m_listctrl
->GetImageList(wxIMAGE_LIST_SMALL
);
834 #endif // wxUSE_LOG_DIALOG