]> git.saurik.com Git - wxWidgets.git/blame - src/generic/logg.cpp
Disable wxUSE_ENH_METAFILE for wxGTK builds.
[wxWidgets.git] / src / generic / logg.cpp
CommitLineData
dd85fc6b 1/////////////////////////////////////////////////////////////////////////////
8ff41136 2// Name: src/generic/logg.cpp
dd85fc6b
VZ
3// Purpose: wxLog-derived classes which need GUI support (the rest is in
4// src/common/log.cpp)
5// Author: Vadim Zeitlin
6// Modified by:
7// Created: 20.09.99 (extracted from src/common/log.cpp)
8// RCS-ID: $Id$
9// Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr>
65571936 10// Licence: wxWindows licence
dd85fc6b
VZ
11/////////////////////////////////////////////////////////////////////////////
12
13// ============================================================================
14// declarations
15// ============================================================================
16
17// ----------------------------------------------------------------------------
18// headers
19// ----------------------------------------------------------------------------
20
dd85fc6b
VZ
21// For compilers that support precompilation, includes "wx.h".
22#include "wx/wxprec.h"
23
24#ifdef __BORLANDC__
f1e01716 25 #pragma hdrstop
dd85fc6b
VZ
26#endif
27
dd85fc6b
VZ
28#ifndef WX_PRECOMP
29 #include "wx/app.h"
f6bcfd97 30 #include "wx/button.h"
dd85fc6b
VZ
31 #include "wx/intl.h"
32 #include "wx/log.h"
33 #include "wx/menu.h"
34 #include "wx/frame.h"
35 #include "wx/filedlg.h"
8ca2f11c 36 #include "wx/msgdlg.h"
dd85fc6b 37 #include "wx/textctrl.h"
f1df0927
VZ
38 #include "wx/sizer.h"
39 #include "wx/statbmp.h"
a0145564 40 #include "wx/settings.h"
0cb7e05c 41 #include "wx/wxcrtvararg.h"
dd85fc6b
VZ
42#endif // WX_PRECOMP
43
1e6feb95
VZ
44#if wxUSE_LOGGUI || wxUSE_LOGWINDOW
45
dd85fc6b 46#include "wx/file.h"
b6d2b072 47#include "wx/clipbrd.h"
a3608593 48#include "wx/dataobj.h"
dd85fc6b 49#include "wx/textfile.h"
f6bcfd97 50#include "wx/statline.h"
389d906b 51#include "wx/artprov.h"
a14670e2 52#include "wx/collpane.h"
cd1ff792 53#include "wx/arrstr.h"
711f12ef 54#include "wx/msgout.h"
cd1ff792 55
39a7c7e1 56#ifdef __WXMSW__
f1e01716
WS
57 // for OutputDebugString()
58 #include "wx/msw/private.h"
39a7c7e1
VZ
59#endif // Windows
60
cd1ff792 61
2eb96d03 62#ifdef __WXPM__
f1e01716 63 #include <time.h>
2eb96d03
DW
64#endif
65
f1df0927 66#if wxUSE_LOG_DIALOG
f1df0927 67 #include "wx/listctrl.h"
de8e98f1 68 #include "wx/imaglist.h"
f1df0927 69 #include "wx/image.h"
f1df0927
VZ
70#endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
71
2abc54ca 72#include "wx/time.h"
1aaf88d2 73
8ff41136 74// the suffix we add to the button to show that the dialog can be expanded
9a83f860 75#define EXPAND_SUFFIX wxT(" >>")
8ff41136 76
b6d2b072
VZ
77#define CAN_SAVE_FILES (wxUSE_FILE && wxUSE_FILEDLG)
78
f1df0927
VZ
79// ----------------------------------------------------------------------------
80// private classes
81// ----------------------------------------------------------------------------
82
83#if wxUSE_LOG_DIALOG
84
f94dfb38
VS
85// this function is a wrapper around strftime(3)
86// allows to exclude the usage of wxDateTime
5a20d2ce 87static wxString TimeStamp(const wxString& format, time_t t)
f94dfb38
VS
88{
89 wxChar buf[4096];
83e8b44c
VZ
90 struct tm tm;
91 if ( !wxStrftime(buf, WXSIZEOF(buf), format, wxLocaltime_r(&t, &tm)) )
f94dfb38
VS
92 {
93 // buffer is too small?
9a83f860 94 wxFAIL_MSG(wxT("strftime() failed"));
f94dfb38
VS
95 }
96 return wxString(buf);
97}
98
99
f1df0927
VZ
100class wxLogDialog : public wxDialog
101{
102public:
103 wxLogDialog(wxWindow *parent,
104 const wxArrayString& messages,
105 const wxArrayInt& severity,
106 const wxArrayLong& timess,
107 const wxString& caption,
108 long style);
109 virtual ~wxLogDialog();
110
111 // event handlers
112 void OnOk(wxCommandEvent& event);
b6d2b072
VZ
113#if wxUSE_CLIPBOARD
114 void OnCopy(wxCommandEvent& event);
115#endif // wxUSE_CLIPBOARD
116#if CAN_SAVE_FILES
f6bcfd97 117 void OnSave(wxCommandEvent& event);
b6d2b072 118#endif // CAN_SAVE_FILES
a14670e2 119 void OnListItemActivated(wxListEvent& event);
f1df0927
VZ
120
121private:
f6bcfd97 122 // create controls needed for the details display
a14670e2
VZ
123 void CreateDetailsControls(wxWindow *);
124
125 // if necessary truncates the given string and adds an ellipsis
126 wxString EllipsizeString(const wxString &text)
127 {
128 if (ms_maxLength > 0 &&
129 text.length() > ms_maxLength)
130 {
131 wxString ret(text);
132 ret.Truncate(ms_maxLength);
133 ret << "...";
134 return ret;
135 }
136
137 return text;
138 }
f6bcfd97 139
b6d2b072
VZ
140#if CAN_SAVE_FILES || wxUSE_CLIPBOARD
141 // return the contents of the dialog as a multiline string
142 wxString GetLogMessages() const;
143#endif // CAN_SAVE_FILES || wxUSE_CLIPBOARD
144
145
f1df0927 146 // the data for the listctrl
224ff7a5
VZ
147 wxArrayString m_messages;
148 wxArrayInt m_severity;
149 wxArrayLong m_times;
f1df0927 150
f6bcfd97
BP
151 // the controls which are not shown initially (but only when details
152 // button is pressed)
f1df0927
VZ
153 wxListCtrl *m_listctrl;
154
5f170f33
VZ
155 // the translated "Details" string
156 static wxString ms_details;
157
a14670e2
VZ
158 // the maximum length of the log message
159 static size_t ms_maxLength;
160
f1df0927 161 DECLARE_EVENT_TABLE()
c0c133e1 162 wxDECLARE_NO_COPY_CLASS(wxLogDialog);
f1df0927
VZ
163};
164
165BEGIN_EVENT_TABLE(wxLogDialog, wxDialog)
eb3e6de3 166 EVT_BUTTON(wxID_OK, wxLogDialog::OnOk)
b6d2b072
VZ
167#if wxUSE_CLIPBOARD
168 EVT_BUTTON(wxID_COPY, wxLogDialog::OnCopy)
169#endif // wxUSE_CLIPBOARD
170#if CAN_SAVE_FILES
f6bcfd97 171 EVT_BUTTON(wxID_SAVE, wxLogDialog::OnSave)
b6d2b072 172#endif // CAN_SAVE_FILES
a14670e2 173 EVT_LIST_ITEM_ACTIVATED(wxID_ANY, wxLogDialog::OnListItemActivated)
f1df0927
VZ
174END_EVENT_TABLE()
175
176#endif // wxUSE_LOG_DIALOG
177
f6bcfd97
BP
178// ----------------------------------------------------------------------------
179// private functions
180// ----------------------------------------------------------------------------
181
b6d2b072 182#if CAN_SAVE_FILES
f6bcfd97
BP
183
184// pass an uninitialized file object, the function will ask the user for the
dabbc6a5
DS
185// filename and try to open it, returns true on success (file was opened),
186// false if file couldn't be opened/created and -1 if the file selection
f6bcfd97 187// dialog was cancelled
73ff84ff 188static int OpenLogFile(wxFile& file, wxString *filename = NULL, wxWindow *parent = NULL);
f6bcfd97 189
b6d2b072 190#endif // CAN_SAVE_FILES
f6bcfd97 191
dd85fc6b
VZ
192// ============================================================================
193// implementation
194// ============================================================================
195
dd85fc6b
VZ
196// ----------------------------------------------------------------------------
197// wxLogGui implementation (FIXME MT-unsafe)
198// ----------------------------------------------------------------------------
199
461dae94
VZ
200#if wxUSE_LOGGUI
201
dd85fc6b
VZ
202wxLogGui::wxLogGui()
203{
204 Clear();
205}
206
207void wxLogGui::Clear()
208{
5f170f33
VZ
209 m_bErrors =
210 m_bWarnings =
dabbc6a5 211 m_bHasMessages = false;
5f170f33 212
dd85fc6b 213 m_aMessages.Empty();
f1df0927 214 m_aSeverity.Empty();
dd85fc6b
VZ
215 m_aTimes.Empty();
216}
217
9ad2fe62
VZ
218int wxLogGui::GetSeverityIcon() const
219{
220 return m_bErrors ? wxICON_STOP
221 : m_bWarnings ? wxICON_EXCLAMATION
222 : wxICON_INFORMATION;
223}
224
225wxString wxLogGui::GetTitle() const
226{
227 wxString titleFormat;
228 switch ( GetSeverityIcon() )
229 {
230 case wxICON_STOP:
231 titleFormat = _("%s Error");
232 break;
233
234 case wxICON_EXCLAMATION:
235 titleFormat = _("%s Warning");
236 break;
237
238 default:
239 wxFAIL_MSG( "unexpected icon severity" );
240 // fall through
241
242 case wxICON_INFORMATION:
243 titleFormat = _("%s Information");
244 }
245
246 return wxString::Format(titleFormat, wxTheApp->GetAppDisplayName());
247}
248
249void
250wxLogGui::DoShowSingleLogMessage(const wxString& message,
251 const wxString& title,
252 int style)
253{
254 wxMessageBox(message, title, wxOK | style);
255}
256
257void
258wxLogGui::DoShowMultipleLogMessages(const wxArrayString& messages,
259 const wxArrayInt& severities,
260 const wxArrayLong& times,
261 const wxString& title,
262 int style)
263{
264#if wxUSE_LOG_DIALOG
265 wxLogDialog dlg(NULL,
266 messages, severities, times,
267 title, style);
268
269 // clear the message list before showing the dialog because while it's
270 // shown some new messages may appear
271 Clear();
272
273 (void)dlg.ShowModal();
274#else // !wxUSE_LOG_DIALOG
275 // start from the most recent message
276 wxString message;
f946f8bb 277 const size_t nMsgCount = messages.size();
14fd5e96 278 message.reserve(nMsgCount*100);
9ad2fe62
VZ
279 for ( size_t n = nMsgCount; n > 0; n-- ) {
280 message << m_aMessages[n - 1] << wxT("\n");
281 }
282
283 DoShowSingleLogMessage(message, title, style);
284#endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
285}
286
dd85fc6b
VZ
287void wxLogGui::Flush()
288{
232addd1
VZ
289 wxLog::Flush();
290
dd85fc6b
VZ
291 if ( !m_bHasMessages )
292 return;
293
294 // do it right now to block any new calls to Flush() while we're here
dabbc6a5 295 m_bHasMessages = false;
dd85fc6b 296
9ad2fe62
VZ
297 // note that this must be done before examining m_aMessages as it may log
298 // yet another message
dbaa16de 299 const unsigned repeatCount = LogLastRepeatIfNeeded();
f9837791 300
9ad2fe62 301 const size_t nMsgCount = m_aMessages.size();
f1df0927 302
9ad2fe62
VZ
303 if ( repeatCount > 0 )
304 {
305 m_aMessages[nMsgCount - 1] << " (" << m_aMessages[nMsgCount - 2] << ")";
f1df0927 306 }
1e6feb95 307
9ad2fe62
VZ
308 const wxString title = GetTitle();
309 const int style = GetSeverityIcon();
224ff7a5 310
69c916e9
VZ
311 // avoid showing other log dialogs until we're done with the dialog we're
312 // showing right now: nested modal dialogs make for really bad UI!
313 Suspend();
314
23f681ec
VZ
315 if ( nMsgCount == 1 )
316 {
9ad2fe62
VZ
317 // make a copy before calling Clear()
318 const wxString message(m_aMessages[0]);
319 Clear();
320
321 DoShowSingleLogMessage(message, title, style);
23f681ec
VZ
322 }
323 else // more than one message
324 {
9ad2fe62
VZ
325 wxArrayString messages;
326 wxArrayInt severities;
327 wxArrayLong times;
0250efd6 328
9ad2fe62
VZ
329 messages.swap(m_aMessages);
330 severities.swap(m_aSeverity);
331 times.swap(m_aTimes);
f1df0927 332
23f681ec
VZ
333 Clear();
334
9ad2fe62 335 DoShowMultipleLogMessages(messages, severities, times, title, style);
23f681ec 336 }
69c916e9
VZ
337
338 // allow flushing the logs again
339 Resume();
dd85fc6b
VZ
340}
341
23f681ec 342// log all kinds of messages
bc73d5ae
VZ
343void wxLogGui::DoLogRecord(wxLogLevel level,
344 const wxString& msg,
345 const wxLogRecordInfo& info)
dd85fc6b 346{
bc73d5ae
VZ
347 switch ( level )
348 {
dd85fc6b
VZ
349 case wxLOG_Info:
350 if ( GetVerbose() )
351 case wxLOG_Message:
f1df0927 352 {
bc73d5ae 353 m_aMessages.Add(msg);
a250392c 354 m_aSeverity.Add(wxLOG_Message);
bc73d5ae 355 m_aTimes.Add((long)info.timestamp);
dabbc6a5 356 m_bHasMessages = true;
f1df0927
VZ
357 }
358 break;
dd85fc6b
VZ
359
360 case wxLOG_Status:
361#if wxUSE_STATUSBAR
f1df0927 362 {
af588446
VZ
363 wxFrame *pFrame = NULL;
364
365 // check if the frame was passed to us explicitly
958f8790 366 wxUIntPtr ptr = 0;
af588446
VZ
367 if ( info.GetNumValue(wxLOG_KEY_FRAME, &ptr) )
368 {
369 pFrame = static_cast<wxFrame *>(wxUIntToPtr(ptr));
370 }
371
f1df0927 372 // find the top window and set it's status text if it has any
f1df0927
VZ
373 if ( pFrame == NULL ) {
374 wxWindow *pWin = wxTheApp->GetTopWindow();
345c78ca 375 if ( wxDynamicCast(pWin, wxFrame) ) {
f1df0927 376 pFrame = (wxFrame *)pWin;
dd85fc6b 377 }
dd85fc6b 378 }
f1df0927
VZ
379
380 if ( pFrame && pFrame->GetStatusBar() )
bc73d5ae 381 pFrame->SetStatusText(msg);
f1df0927 382 }
dd85fc6b 383#endif // wxUSE_STATUSBAR
f1df0927 384 break;
dd85fc6b 385
dd85fc6b 386 case wxLOG_Error:
f1df0927
VZ
387 if ( !m_bErrors ) {
388#if !wxUSE_LOG_DIALOG
dd85fc6b 389 // discard earlier informational messages if this is the 1st
f1df0927
VZ
390 // error because they might not make sense any more and showing
391 // them in a message box might be confusing
392 m_aMessages.Empty();
393 m_aSeverity.Empty();
394 m_aTimes.Empty();
395#endif // wxUSE_LOG_DIALOG
dabbc6a5 396 m_bErrors = true;
f1df0927
VZ
397 }
398 // fall through
dd85fc6b
VZ
399
400 case wxLOG_Warning:
f1df0927
VZ
401 if ( !m_bErrors ) {
402 // for the warning we don't discard the info messages
dabbc6a5 403 m_bWarnings = true;
f1df0927
VZ
404 }
405
bc73d5ae 406 m_aMessages.Add(msg);
06b466c7 407 m_aSeverity.Add((int)level);
bc73d5ae 408 m_aTimes.Add((long)info.timestamp);
dabbc6a5 409 m_bHasMessages = true;
f1df0927 410 break;
711f12ef 411
6900a897
VZ
412 case wxLOG_Debug:
413 case wxLOG_Trace:
414 // let the base class deal with debug/trace messages
bc73d5ae 415 wxLog::DoLogRecord(level, msg, info);
6900a897
VZ
416 break;
417
418 case wxLOG_FatalError:
419 case wxLOG_Max:
420 // fatal errors are shown immediately and terminate the program so
421 // we should never see them here
422 wxFAIL_MSG("unexpected log level");
423 break;
424
425 case wxLOG_Progress:
426 case wxLOG_User:
427 // just ignore those: passing them to the base class would result
428 // in asserts from DoLogText() because DoLogTextAtLevel() would
429 // call it as it doesn't know how to handle these levels otherwise
430 break;
dd85fc6b
VZ
431 }
432}
433
461dae94
VZ
434#endif // wxUSE_LOGGUI
435
dd85fc6b
VZ
436// ----------------------------------------------------------------------------
437// wxLogWindow and wxLogFrame implementation
438// ----------------------------------------------------------------------------
439
c54a8b64
VZ
440#if wxUSE_LOGWINDOW
441
dd85fc6b
VZ
442// log frame class
443// ---------------
444class wxLogFrame : public wxFrame
445{
446public:
447 // ctor & dtor
46ff9bd5 448 wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxString& szTitle);
dd85fc6b
VZ
449 virtual ~wxLogFrame();
450
81ec048a
VZ
451 // Don't prevent the application from exiting if just this frame remains.
452 virtual bool ShouldPreventAppExit() const { return false; }
453
dd85fc6b
VZ
454 // menu callbacks
455 void OnClose(wxCommandEvent& event);
456 void OnCloseWindow(wxCloseEvent& event);
b6d2b072
VZ
457#if CAN_SAVE_FILES
458 void OnSave(wxCommandEvent& event);
459#endif // CAN_SAVE_FILES
dd85fc6b
VZ
460 void OnClear(wxCommandEvent& event);
461
232addd1
VZ
462 // do show the message in the text control
463 void ShowLogMessage(const wxString& message)
464 {
465 m_pTextCtrl->AppendText(message + wxS('\n'));
466 }
dd85fc6b
VZ
467
468private:
857eb081 469 // use standard ids for our commands!
dd85fc6b
VZ
470 enum
471 {
857eb081
VZ
472 Menu_Close = wxID_CLOSE,
473 Menu_Save = wxID_SAVE,
474 Menu_Clear = wxID_CLEAR
dd85fc6b
VZ
475 };
476
f6bcfd97
BP
477 // common part of OnClose() and OnCloseWindow()
478 void DoClose();
dd85fc6b
VZ
479
480 wxTextCtrl *m_pTextCtrl;
481 wxLogWindow *m_log;
482
483 DECLARE_EVENT_TABLE()
c0c133e1 484 wxDECLARE_NO_COPY_CLASS(wxLogFrame);
dd85fc6b
VZ
485};
486
487BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
488 // wxLogWindow menu events
489 EVT_MENU(Menu_Close, wxLogFrame::OnClose)
b6d2b072 490#if CAN_SAVE_FILES
dd85fc6b 491 EVT_MENU(Menu_Save, wxLogFrame::OnSave)
b6d2b072 492#endif // CAN_SAVE_FILES
dd85fc6b
VZ
493 EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
494
495 EVT_CLOSE(wxLogFrame::OnCloseWindow)
496END_EVENT_TABLE()
497
46ff9bd5 498wxLogFrame::wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxString& szTitle)
dabbc6a5 499 : wxFrame(pParent, wxID_ANY, szTitle)
dd85fc6b
VZ
500{
501 m_log = log;
502
dabbc6a5 503 m_pTextCtrl = new wxTextCtrl(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
dd85fc6b
VZ
504 wxDefaultSize,
505 wxTE_MULTILINE |
506 wxHSCROLL |
46d52925
VZ
507 // needed for Win32 to avoid 65Kb limit but it doesn't work well
508 // when using RichEdit 2.0 which we always do in the Unicode build
509#if !wxUSE_UNICODE
510 wxTE_RICH |
511#endif // !wxUSE_UNICODE
dd85fc6b
VZ
512 wxTE_READONLY);
513
3a8c693a 514#if wxUSE_MENUS
dd85fc6b
VZ
515 // create menu
516 wxMenuBar *pMenuBar = new wxMenuBar;
517 wxMenu *pMenu = new wxMenu;
b6d2b072 518#if CAN_SAVE_FILES
b82f92a8 519 pMenu->Append(Menu_Save, _("Save &As..."), _("Save log contents to file"));
b6d2b072 520#endif // CAN_SAVE_FILES
dd85fc6b
VZ
521 pMenu->Append(Menu_Clear, _("C&lear"), _("Clear the log contents"));
522 pMenu->AppendSeparator();
523 pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
524 pMenuBar->Append(pMenu, _("&Log"));
525 SetMenuBar(pMenuBar);
3a8c693a 526#endif // wxUSE_MENUS
dd85fc6b
VZ
527
528#if wxUSE_STATUSBAR
529 // status bar for menu prompts
530 CreateStatusBar();
531#endif // wxUSE_STATUSBAR
dd85fc6b
VZ
532}
533
f6bcfd97
BP
534void wxLogFrame::DoClose()
535{
536 if ( m_log->OnFrameClose(this) )
537 {
538 // instead of closing just hide the window to be able to Show() it
539 // later
dabbc6a5 540 Show(false);
f6bcfd97
BP
541 }
542}
543
dd85fc6b
VZ
544void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
545{
546 DoClose();
547}
548
549void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
550{
551 DoClose();
552}
553
b6d2b072 554#if CAN_SAVE_FILES
dd85fc6b
VZ
555void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
556{
f6bcfd97
BP
557 wxString filename;
558 wxFile file;
73ff84ff 559 int rc = OpenLogFile(file, &filename, this);
f6bcfd97
BP
560 if ( rc == -1 )
561 {
dd85fc6b
VZ
562 // cancelled
563 return;
564 }
565
f6bcfd97 566 bool bOk = rc != 0;
dd85fc6b
VZ
567
568 // retrieve text and save it
569 // -------------------------
570 int nLines = m_pTextCtrl->GetNumberOfLines();
571 for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) {
572 bOk = file.Write(m_pTextCtrl->GetLineText(nLine) +
f6bcfd97 573 wxTextFile::GetEOL());
dd85fc6b
VZ
574 }
575
576 if ( bOk )
577 bOk = file.Close();
578
579 if ( !bOk ) {
580 wxLogError(_("Can't save log contents to file."));
581 }
582 else {
2523e9b7 583 wxLogStatus((wxFrame*)this, _("Log saved to the file '%s'."), filename.c_str());
dd85fc6b
VZ
584 }
585}
b6d2b072 586#endif // CAN_SAVE_FILES
dd85fc6b
VZ
587
588void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
589{
590 m_pTextCtrl->Clear();
591}
592
593wxLogFrame::~wxLogFrame()
594{
595 m_log->OnFrameDelete(this);
596}
597
598// wxLogWindow
599// -----------
03147cd0 600
55c9a186 601wxLogWindow::wxLogWindow(wxWindow *pParent,
46ff9bd5 602 const wxString& szTitle,
dd85fc6b
VZ
603 bool bShow,
604 bool bDoPass)
605{
0538419f
VZ
606 // Initialize it to NULL to ensure that we don't crash if any log messages
607 // are generated before the frame is fully created (while this doesn't
608 // happen normally, it might, in principle).
609 m_pLogFrame = NULL;
610
03147cd0 611 PassMessages(bDoPass);
dd85fc6b
VZ
612
613 m_pLogFrame = new wxLogFrame(pParent, this, szTitle);
dd85fc6b
VZ
614
615 if ( bShow )
dabbc6a5 616 m_pLogFrame->Show();
dd85fc6b
VZ
617}
618
619void wxLogWindow::Show(bool bShow)
620{
621 m_pLogFrame->Show(bShow);
622}
623
bc73d5ae 624void wxLogWindow::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
dd85fc6b 625{
bc73d5ae
VZ
626 if ( !m_pLogFrame )
627 return;
cd1ff792 628
bc73d5ae
VZ
629 // don't put trace messages in the text window for 2 reasons:
630 // 1) there are too many of them
631 // 2) they may provoke other trace messages (e.g. wxMSW code uses
632 // wxLogTrace to log Windows messages and adding text to the control
633 // sends more of them) thus sending a program into an infinite loop
634 if ( level == wxLOG_Trace )
635 return;
dd85fc6b 636
232addd1 637 m_pLogFrame->ShowLogMessage(msg);
dd85fc6b
VZ
638}
639
640wxFrame *wxLogWindow::GetFrame() const
641{
642 return m_pLogFrame;
643}
644
f6bcfd97
BP
645bool wxLogWindow::OnFrameClose(wxFrame * WXUNUSED(frame))
646{
647 // allow to close
dabbc6a5 648 return true;
f6bcfd97
BP
649}
650
dd85fc6b
VZ
651void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame))
652{
d3b9f782 653 m_pLogFrame = NULL;
dd85fc6b
VZ
654}
655
656wxLogWindow::~wxLogWindow()
657{
dd85fc6b
VZ
658 // may be NULL if log frame already auto destroyed itself
659 delete m_pLogFrame;
660}
661
c54a8b64
VZ
662#endif // wxUSE_LOGWINDOW
663
f1df0927
VZ
664// ----------------------------------------------------------------------------
665// wxLogDialog
666// ----------------------------------------------------------------------------
667
668#if wxUSE_LOG_DIALOG
669
5f170f33 670wxString wxLogDialog::ms_details;
a14670e2 671size_t wxLogDialog::ms_maxLength = 0;
5f170f33 672
f1df0927
VZ
673wxLogDialog::wxLogDialog(wxWindow *parent,
674 const wxArrayString& messages,
675 const wxArrayInt& severity,
676 const wxArrayLong& times,
677 const wxString& caption,
678 long style)
dabbc6a5 679 : wxDialog(parent, wxID_ANY, caption,
0b165ed6
VZ
680 wxDefaultPosition, wxDefaultSize,
681 wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
f1df0927 682{
a14670e2
VZ
683 // init the static variables:
684
32b13913 685 if ( ms_details.empty() )
5f170f33 686 {
f6bcfd97
BP
687 // ensure that we won't loop here if wxGetTranslation()
688 // happens to pop up a Log message while translating this :-)
689 ms_details = wxTRANSLATE("&Details");
5f170f33 690 ms_details = wxGetTranslation(ms_details);
5e63b67d
WS
691#ifdef __SMARTPHONE__
692 ms_details = wxStripMenuCodes(ms_details);
693#endif
5f170f33
VZ
694 }
695
a14670e2
VZ
696 if ( ms_maxLength == 0 )
697 {
698 ms_maxLength = (2 * wxGetDisplaySize().x/3) / GetCharWidth();
699 }
700
4aff28fc
VZ
701 size_t count = messages.GetCount();
702 m_messages.Alloc(count);
703 m_severity.Alloc(count);
704 m_times.Alloc(count);
705
706 for ( size_t n = 0; n < count; n++ )
707 {
a14670e2 708 m_messages.Add(messages[n]);
786c4e23
VZ
709 m_severity.Add(severity[n]);
710 m_times.Add(times[n]);
4aff28fc
VZ
711 }
712
b6d2b072 713 m_listctrl = NULL;
5e63b67d 714
94f53923 715 bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
5e63b67d 716
f1df0927 717 // create the controls which are always shown and layout them: we use
d13b34d3 718 // sizers even though our window is not resizable to calculate the size of
f1df0927
VZ
719 // the dialog properly
720 wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
94f53923 721 wxBoxSizer *sizerAll = new wxBoxSizer(isPda ? wxVERTICAL : wxHORIZONTAL);
f1df0927 722
1970409e 723 if (!isPda)
389d906b 724 {
1970409e
VZ
725 wxStaticBitmap *icon = new wxStaticBitmap
726 (
727 this,
728 wxID_ANY,
729 wxArtProvider::GetMessageBoxIcon(style)
730 );
b6d2b072 731 sizerAll->Add(icon, wxSizerFlags().Centre());
389d906b 732 }
5e63b67d 733
a14670e2
VZ
734 // create the text sizer with a minimal size so that we are sure it won't be too small
735 wxString message = EllipsizeString(messages.Last());
736 wxSizer *szText = CreateTextSizer(message);
737 szText->SetMinSize(wxMin(300, wxGetDisplaySize().x / 3), -1);
738
b6d2b072 739 sizerAll->Add(szText, wxSizerFlags(1).Centre().Border(wxLEFT | wxRIGHT));
a14670e2
VZ
740
741 wxButton *btnOk = new wxButton(this, wxID_OK);
b6d2b072 742 sizerAll->Add(btnOk, wxSizerFlags().Centre());
f1df0927 743
b6d2b072 744 sizerTop->Add(sizerAll, wxSizerFlags().Expand().Border());
f1df0927 745
f1df0927 746
a14670e2 747 // add the details pane
5e63b67d 748#ifndef __SMARTPHONE__
abe0903c
JS
749
750#if wxUSE_COLLPANE
b6d2b072
VZ
751 wxCollapsiblePane * const
752 collpane = new wxCollapsiblePane(this, wxID_ANY, ms_details);
753 sizerTop->Add(collpane, wxSizerFlags(1).Expand().Border());
a14670e2
VZ
754
755 wxWindow *win = collpane->GetPane();
abe0903c
JS
756#else
757 wxPanel* win = new wxPanel(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
758 wxBORDER_NONE);
759#endif
b6d2b072 760 wxSizer * const paneSz = new wxBoxSizer(wxVERTICAL);
a14670e2
VZ
761
762 CreateDetailsControls(win);
763
b6d2b072
VZ
764 paneSz->Add(m_listctrl, wxSizerFlags(1).Expand().Border(wxTOP));
765
766#if wxUSE_CLIPBOARD || CAN_SAVE_FILES
767 wxBoxSizer * const btnSizer = new wxBoxSizer(wxHORIZONTAL);
768
769 wxSizerFlags flagsBtn;
770 flagsBtn.Border(wxLEFT);
771
772#if wxUSE_CLIPBOARD
773 btnSizer->Add(new wxButton(win, wxID_COPY), flagsBtn);
774#endif // wxUSE_CLIPBOARD
a14670e2 775
b6d2b072
VZ
776#if CAN_SAVE_FILES
777 btnSizer->Add(new wxButton(win, wxID_SAVE), flagsBtn);
778#endif // CAN_SAVE_FILES
779
8b883c9d 780 paneSz->Add(btnSizer, wxSizerFlags().Right().Border(wxTOP|wxBOTTOM));
b6d2b072 781#endif // wxUSE_CLIPBOARD || CAN_SAVE_FILES
a14670e2
VZ
782
783 win->SetSizer(paneSz);
784 paneSz->SetSizeHints(win);
785#else // __SMARTPHONE__
786 SetLeftMenu(wxID_OK);
787 SetRightMenu(wxID_MORE, ms_details + EXPAND_SUFFIX);
788#endif // __SMARTPHONE__/!__SMARTPHONE__
789
790 SetSizerAndFit(sizerTop);
f1df0927
VZ
791
792 Centre();
5e63b67d 793
94f53923
JS
794 if (isPda)
795 {
796 // Move up the screen so that when we expand the dialog,
797 // there's enough space.
798 Move(wxPoint(GetPosition().x, GetPosition().y / 2));
799 }
f1df0927
VZ
800}
801
a14670e2 802void wxLogDialog::CreateDetailsControls(wxWindow *parent)
f6bcfd97 803{
4ccc2a07
FM
804 wxString fmt = wxLog::GetTimestamp();
805 bool hasTimeStamp = !fmt.IsEmpty();
806
f6bcfd97 807 // create the list ctrl now
a14670e2 808 m_listctrl = new wxListCtrl(parent, wxID_ANY,
f6bcfd97 809 wxDefaultPosition, wxDefaultSize,
3d35ec88 810 wxBORDER_SIMPLE |
f6bcfd97
BP
811 wxLC_REPORT |
812 wxLC_NO_HEADER |
813 wxLC_SINGLE_SEL);
94f53923 814#ifdef __WXWINCE__
a14670e2 815 // This makes a big aesthetic difference on WinCE but I
94f53923
JS
816 // don't want to risk problems on other platforms
817 m_listctrl->Hide();
5e63b67d 818#endif
f6bcfd97
BP
819
820 // no need to translate these strings as they're not shown to the
821 // user anyhow (we use wxLC_NO_HEADER style)
9a83f860 822 m_listctrl->InsertColumn(0, wxT("Message"));
4ccc2a07
FM
823
824 if (hasTimeStamp)
9a83f860 825 m_listctrl->InsertColumn(1, wxT("Time"));
f6bcfd97
BP
826
827 // prepare the imagelist
828 static const int ICON_SIZE = 16;
829 wxImageList *imageList = new wxImageList(ICON_SIZE, ICON_SIZE);
830
831 // order should be the same as in the switch below!
19be42b7 832 static const char* const icons[] =
f6bcfd97 833 {
389d906b
VS
834 wxART_ERROR,
835 wxART_WARNING,
836 wxART_INFORMATION
f6bcfd97
BP
837 };
838
dabbc6a5 839 bool loadedIcons = true;
f6bcfd97 840
f6bcfd97
BP
841 for ( size_t icon = 0; icon < WXSIZEOF(icons); icon++ )
842 {
389d906b
VS
843 wxBitmap bmp = wxArtProvider::GetBitmap(icons[icon], wxART_MESSAGE_BOX,
844 wxSize(ICON_SIZE, ICON_SIZE));
f6bcfd97 845
9f14a818
VZ
846 // This may very well fail if there are insufficient colours available.
847 // Degrade gracefully.
a1b806b9 848 if ( !bmp.IsOk() )
9f14a818 849 {
dabbc6a5 850 loadedIcons = false;
9f14a818
VZ
851
852 break;
853 }
854
389d906b 855 imageList->Add(bmp);
f6bcfd97
BP
856 }
857
858 m_listctrl->SetImageList(imageList, wxIMAGE_LIST_SMALL);
f6bcfd97 859
4ccc2a07 860 // fill the listctrl
f6bcfd97
BP
861 size_t count = m_messages.GetCount();
862 for ( size_t n = 0; n < count; n++ )
863 {
9f14a818
VZ
864 int image;
865
9f14a818 866 if ( loadedIcons )
f6bcfd97 867 {
9f14a818
VZ
868 switch ( m_severity[n] )
869 {
870 case wxLOG_Error:
871 image = 0;
872 break;
f6bcfd97 873
9f14a818
VZ
874 case wxLOG_Warning:
875 image = 1;
876 break;
f6bcfd97 877
9f14a818
VZ
878 default:
879 image = 2;
880 }
f6bcfd97 881 }
9f14a818 882 else // failed to load images
9f14a818 883 {
f6bcfd97 884 image = -1;
9f14a818 885 }
f6bcfd97 886
a14670e2
VZ
887 wxString msg = m_messages[n];
888 msg.Replace(wxT("\n"), wxT(" "));
889 msg = EllipsizeString(msg);
890
891 m_listctrl->InsertItem(n, msg, image);
4ccc2a07
FM
892
893 if (hasTimeStamp)
894 m_listctrl->SetItem(n, 1, TimeStamp(fmt, (time_t)m_times[n]));
f6bcfd97
BP
895 }
896
897 // let the columns size themselves
898 m_listctrl->SetColumnWidth(0, wxLIST_AUTOSIZE);
4ccc2a07
FM
899 if (hasTimeStamp)
900 m_listctrl->SetColumnWidth(1, wxLIST_AUTOSIZE);
f6bcfd97 901
9f14a818 902 // calculate an approximately nice height for the listctrl
7b82d782 903 int height = GetCharHeight()*(count + 4);
f6bcfd97 904
9f14a818
VZ
905 // but check that the dialog won't fall fown from the screen
906 //
907 // we use GetMinHeight() to get the height of the dialog part without the
908 // details and we consider that the "Save" button below and the separator
909 // line (and the margins around it) take about as much, hence double it
910 int heightMax = wxGetDisplaySize().y - GetPosition().y - 2*GetMinHeight();
4d509295 911
9f14a818
VZ
912 // we should leave a margin
913 heightMax *= 9;
914 heightMax /= 10;
4d509295 915
422d0ff0 916 m_listctrl->SetSize(wxDefaultCoord, wxMin(height, heightMax));
f6bcfd97
BP
917}
918
a14670e2
VZ
919void wxLogDialog::OnListItemActivated(wxListEvent& event)
920{
921 // show the activated item in a message box
922 // This allow the user to correctly display the logs which are longer
923 // than the listctrl and thus gets truncated or those which contains
924 // newlines.
925
926 // NB: don't do:
927 // wxString str = m_listctrl->GetItemText(event.GetIndex());
928 // as there's a 260 chars limit on the items inside a wxListCtrl in wxMSW.
929 wxString str = m_messages[event.GetIndex()];
930
cd1ff792 931 // wxMessageBox will nicely handle the '\n' in the string (if any)
a14670e2
VZ
932 // and supports long strings
933 wxMessageBox(str, wxT("Log message"), wxOK, this);
934}
935
f1df0927
VZ
936void wxLogDialog::OnOk(wxCommandEvent& WXUNUSED(event))
937{
938 EndModal(wxID_OK);
939}
940
b6d2b072 941#if CAN_SAVE_FILES || wxUSE_CLIPBOARD
f6bcfd97 942
b6d2b072 943wxString wxLogDialog::GetLogMessages() const
f6bcfd97 944{
f6bcfd97 945 wxString fmt = wxLog::GetTimestamp();
b6d2b072 946 if ( fmt.empty() )
f6bcfd97 947 {
b6d2b072
VZ
948 // use the default format
949 fmt = "%c";
f6bcfd97
BP
950 }
951
b6d2b072
VZ
952 const size_t count = m_messages.GetCount();
953
954 wxString text;
955 text.reserve(count*m_messages[0].length());
956 for ( size_t n = 0; n < count; n++ )
f6bcfd97 957 {
b6d2b072
VZ
958 text << TimeStamp(fmt, (time_t)m_times[n])
959 << ": "
f6bcfd97
BP
960 << m_messages[n]
961 << wxTextFile::GetEOL();
b6d2b072
VZ
962 }
963
964 return text;
965}
966
967#endif // CAN_SAVE_FILES || wxUSE_CLIPBOARD
f6bcfd97 968
b6d2b072
VZ
969#if wxUSE_CLIPBOARD
970
971void wxLogDialog::OnCopy(wxCommandEvent& WXUNUSED(event))
972{
973 wxClipboardLocker clip;
974 if ( !clip ||
975 !wxTheClipboard->AddData(new wxTextDataObject(GetLogMessages())) )
976 {
977 wxLogError(_("Failed to copy dialog contents to the clipboard."));
f6bcfd97 978 }
b6d2b072 979}
f6bcfd97 980
b6d2b072
VZ
981#endif // wxUSE_CLIPBOARD
982
983#if CAN_SAVE_FILES
984
985void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
986{
987 wxFile file;
988 int rc = OpenLogFile(file, NULL, this);
989 if ( rc == -1 )
990 {
991 // cancelled
992 return;
993 }
f6bcfd97 994
b6d2b072 995 if ( !rc || !file.Write(GetLogMessages()) || !file.Close() )
af588446 996 {
f6bcfd97 997 wxLogError(_("Can't save log contents to file."));
af588446 998 }
f6bcfd97
BP
999}
1000
b6d2b072 1001#endif // CAN_SAVE_FILES
f6bcfd97 1002
f1df0927
VZ
1003wxLogDialog::~wxLogDialog()
1004{
1005 if ( m_listctrl )
1006 {
1007 delete m_listctrl->GetImageList(wxIMAGE_LIST_SMALL);
1008 }
1009}
1010
1011#endif // wxUSE_LOG_DIALOG
f6bcfd97 1012
b6d2b072 1013#if CAN_SAVE_FILES
f6bcfd97
BP
1014
1015// pass an uninitialized file object, the function will ask the user for the
dabbc6a5
DS
1016// filename and try to open it, returns true on success (file was opened),
1017// false if file couldn't be opened/created and -1 if the file selection
f6bcfd97 1018// dialog was cancelled
73ff84ff 1019static int OpenLogFile(wxFile& file, wxString *pFilename, wxWindow *parent)
f6bcfd97
BP
1020{
1021 // get the file name
1022 // -----------------
73ff84ff 1023 wxString filename = wxSaveFileSelector(wxT("log"), wxT("txt"), wxT("log.txt"), parent);
f6bcfd97
BP
1024 if ( !filename ) {
1025 // cancelled
1026 return -1;
1027 }
1028
1029 // open file
1030 // ---------
c2f7cc71 1031 bool bOk = true; // suppress warning about it being possible uninitialized
f6bcfd97 1032 if ( wxFile::Exists(filename) ) {
dabbc6a5 1033 bool bAppend = false;
f6bcfd97
BP
1034 wxString strMsg;
1035 strMsg.Printf(_("Append log to file '%s' (choosing [No] will overwrite it)?"),
1036 filename.c_str());
1037 switch ( wxMessageBox(strMsg, _("Question"),
1038 wxICON_QUESTION | wxYES_NO | wxCANCEL) ) {
1039 case wxYES:
dabbc6a5 1040 bAppend = true;
f6bcfd97
BP
1041 break;
1042
1043 case wxNO:
dabbc6a5 1044 bAppend = false;
f6bcfd97
BP
1045 break;
1046
1047 case wxCANCEL:
1048 return -1;
1049
1050 default:
1051 wxFAIL_MSG(_("invalid message box return value"));
1052 }
1053
1054 if ( bAppend ) {
1055 bOk = file.Open(filename, wxFile::write_append);
1056 }
1057 else {
dabbc6a5 1058 bOk = file.Create(filename, true /* overwrite */);
f6bcfd97
BP
1059 }
1060 }
1061 else {
1062 bOk = file.Create(filename);
1063 }
1064
1065 if ( pFilename )
1066 *pFilename = filename;
1067
1068 return bOk;
1069}
1070
b6d2b072 1071#endif // CAN_SAVE_FILES
f6bcfd97 1072
1e6feb95
VZ
1073#endif // !(wxUSE_LOGGUI || wxUSE_LOGWINDOW)
1074
f561a4e0 1075#if wxUSE_LOG && wxUSE_TEXTCTRL
1e6feb95
VZ
1076
1077// ----------------------------------------------------------------------------
1078// wxLogTextCtrl implementation
1079// ----------------------------------------------------------------------------
1080
1081wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
1082{
1083 m_pTextCtrl = pTextCtrl;
1084}
1085
bc73d5ae 1086void wxLogTextCtrl::DoLogText(const wxString& msg)
1e6feb95 1087{
bc73d5ae 1088 m_pTextCtrl->AppendText(msg + wxS('\n'));
1e6feb95
VZ
1089}
1090
f561a4e0 1091#endif // wxUSE_LOG && wxUSE_TEXTCTRL