src/generic/logg.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/generic/logg.cpp
   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>
  10 // Licence:     wxWindows licence
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // ============================================================================
  14 // declarations
  15 // ============================================================================
  16
  17 // ----------------------------------------------------------------------------
  18 // headers
  19 // ----------------------------------------------------------------------------
  20
  21 // For compilers that support precompilation, includes "wx.h".
  22 #include "wx/wxprec.h"
  23
  24 #ifdef __BORLANDC__
  25     #pragma hdrstop
  26 #endif
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/app.h"
  30     #include "wx/button.h"
  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"
  36     #include "wx/msgdlg.h"
  37     #include "wx/textctrl.h"
  38     #include "wx/sizer.h"
  39     #include "wx/statbmp.h"
  40     #include "wx/settings.h"
  41     #include "wx/wxcrtvararg.h"
  42 #endif // WX_PRECOMP
  43
  44 #if wxUSE_LOGGUI || wxUSE_LOGWINDOW
  45
  46 #include "wx/file.h"
  47 #include "wx/clipbrd.h"
  48 #include "wx/dataobj.h"
  49 #include "wx/textfile.h"
  50 #include "wx/statline.h"
  51 #include "wx/artprov.h"
  52 #include "wx/collpane.h"
  53 #include "wx/arrstr.h"
  54 #include "wx/msgout.h"
  55
  56 #ifdef  __WXMSW__
  57     // for OutputDebugString()
  58     #include  "wx/msw/private.h"
  59 #endif // Windows
  60
  61
  62 #ifdef  __WXPM__
  63     #include <time.h>
  64 #endif
  65
  66 #if wxUSE_LOG_DIALOG
  67     #include "wx/listctrl.h"
  68     #include "wx/imaglist.h"
  69     #include "wx/image.h"
  70 #endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
  71
  72 #include "wx/time.h"
  73
  74 // the suffix we add to the button to show that the dialog can be expanded
  75 #define EXPAND_SUFFIX wxT(" >>")
  76
  77 #define CAN_SAVE_FILES (wxUSE_FILE && wxUSE_FILEDLG)
  78
  79 // ----------------------------------------------------------------------------
  80 // private classes
  81 // ----------------------------------------------------------------------------
  82
  83 #if wxUSE_LOG_DIALOG
  84
  85 // this function is a wrapper around strftime(3)
  86 // allows to exclude the usage of wxDateTime
  87 static wxString TimeStamp(const wxString& format, time_t t)
  88 {
  89     wxChar buf[4096];
  90     struct tm tm;
  91     if ( !wxStrftime(buf, WXSIZEOF(buf), format, wxLocaltime_r(&t, &tm)) )
  92     {
  93         // buffer is too small?
  94         wxFAIL_MSG(wxT("strftime() failed"));
  95     }
  96     return wxString(buf);
  97 }
  98
  99
 100 class wxLogDialog : public wxDialog
 101 {
 102 public:
 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);
 113 #if wxUSE_CLIPBOARD
 114     void OnCopy(wxCommandEvent& event);
 115 #endif // wxUSE_CLIPBOARD
 116 #if CAN_SAVE_FILES
 117     void OnSave(wxCommandEvent& event);
 118 #endif // CAN_SAVE_FILES
 119     void OnListItemActivated(wxListEvent& event);
 120
 121 private:
 122     // create controls needed for the details display
 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     }
 139
 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
 146     // the data for the listctrl
 147     wxArrayString m_messages;
 148     wxArrayInt m_severity;
 149     wxArrayLong m_times;
 150
 151     // the controls which are not shown initially (but only when details
 152     // button is pressed)
 153     wxListCtrl *m_listctrl;
 154
 155     // the translated "Details" string
 156     static wxString ms_details;
 157
 158     // the maximum length of the log message
 159     static size_t ms_maxLength;
 160
 161     DECLARE_EVENT_TABLE()
 162     wxDECLARE_NO_COPY_CLASS(wxLogDialog);
 163 };
 164
 165 BEGIN_EVENT_TABLE(wxLogDialog, wxDialog)
 166     EVT_BUTTON(wxID_OK, wxLogDialog::OnOk)
 167 #if wxUSE_CLIPBOARD
 168     EVT_BUTTON(wxID_COPY,   wxLogDialog::OnCopy)
 169 #endif // wxUSE_CLIPBOARD
 170 #if CAN_SAVE_FILES
 171     EVT_BUTTON(wxID_SAVE,   wxLogDialog::OnSave)
 172 #endif // CAN_SAVE_FILES
 173     EVT_LIST_ITEM_ACTIVATED(wxID_ANY, wxLogDialog::OnListItemActivated)
 174 END_EVENT_TABLE()
 175
 176 #endif // wxUSE_LOG_DIALOG
 177
 178 // ----------------------------------------------------------------------------
 179 // private functions
 180 // ----------------------------------------------------------------------------
 181
 182 #if CAN_SAVE_FILES
 183
 184 // pass an uninitialized file object, the function will ask the user for the
 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
 187 // dialog was cancelled
 188 static int OpenLogFile(wxFile& file, wxString *filename = NULL, wxWindow *parent = NULL);
 189
 190 #endif // CAN_SAVE_FILES
 191
 192 // ============================================================================
 193 // implementation
 194 // ============================================================================
 195
 196 // ----------------------------------------------------------------------------
 197 // wxLogGui implementation (FIXME MT-unsafe)
 198 // ----------------------------------------------------------------------------
 199
 200 #if wxUSE_LOGGUI
 201
 202 wxLogGui::wxLogGui()
 203 {
 204     Clear();
 205 }
 206
 207 void wxLogGui::Clear()
 208 {
 209     m_bErrors =
 210     m_bWarnings =
 211     m_bHasMessages = false;
 212
 213     m_aMessages.Empty();
 214     m_aSeverity.Empty();
 215     m_aTimes.Empty();
 216 }
 217
 218 int wxLogGui::GetSeverityIcon() const
 219 {
 220     return m_bErrors ? wxICON_STOP
 221                      : m_bWarnings ? wxICON_EXCLAMATION
 222                                    : wxICON_INFORMATION;
 223 }
 224
 225 wxString 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
 249 void
 250 wxLogGui::DoShowSingleLogMessage(const wxString& message,
 251                                  const wxString& title,
 252                                  int style)
 253 {
 254     wxMessageBox(message, title, wxOK | style);
 255 }
 256
 257 void
 258 wxLogGui::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;
 277     const size_t nMsgCount = messages.size();
 278     message.reserve(nMsgCount*100);
 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
 287 void wxLogGui::Flush()
 288 {
 289     wxLog::Flush();
 290
 291     if ( !m_bHasMessages )
 292         return;
 293
 294     // do it right now to block any new calls to Flush() while we're here
 295     m_bHasMessages = false;
 296
 297     // note that this must be done before examining m_aMessages as it may log
 298     // yet another message
 299     const unsigned repeatCount = LogLastRepeatIfNeeded();
 300
 301     const size_t nMsgCount = m_aMessages.size();
 302
 303     if ( repeatCount > 0 )
 304     {
 305         m_aMessages[nMsgCount - 1] << " (" << m_aMessages[nMsgCount - 2] << ")";
 306     }
 307
 308     const wxString title = GetTitle();
 309     const int style = GetSeverityIcon();
 310
 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
 315     if ( nMsgCount == 1 )
 316     {
 317         // make a copy before calling Clear()
 318         const wxString message(m_aMessages[0]);
 319         Clear();
 320
 321         DoShowSingleLogMessage(message, title, style);
 322     }
 323     else // more than one message
 324     {
 325         wxArrayString messages;
 326         wxArrayInt severities;
 327         wxArrayLong times;
 328
 329         messages.swap(m_aMessages);
 330         severities.swap(m_aSeverity);
 331         times.swap(m_aTimes);
 332
 333         Clear();
 334
 335         DoShowMultipleLogMessages(messages, severities, times, title, style);
 336     }
 337
 338     // allow flushing the logs again
 339     Resume();
 340 }
 341
 342 // log all kinds of messages
 343 void wxLogGui::DoLogRecord(wxLogLevel level,
 344                            const wxString& msg,
 345                            const wxLogRecordInfo& info)
 346 {
 347     switch ( level )
 348     {
 349         case wxLOG_Info:
 350             if ( GetVerbose() )
 351         case wxLOG_Message:
 352             {
 353                 m_aMessages.Add(msg);
 354                 m_aSeverity.Add(wxLOG_Message);
 355                 m_aTimes.Add((long)info.timestamp);
 356                 m_bHasMessages = true;
 357             }
 358             break;
 359
 360         case wxLOG_Status:
 361 #if wxUSE_STATUSBAR
 362             {
 363                 wxFrame *pFrame = NULL;
 364
 365                 // check if the frame was passed to us explicitly
 366                 wxUIntPtr ptr = 0;
 367                 if ( info.GetNumValue(wxLOG_KEY_FRAME, &ptr) )
 368                 {
 369                     pFrame = static_cast<wxFrame *>(wxUIntToPtr(ptr));
 370                 }
 371
 372                 // find the top window and set it's status text if it has any
 373                 if ( pFrame == NULL ) {
 374                     wxWindow *pWin = wxTheApp->GetTopWindow();
 375                     if ( wxDynamicCast(pWin, wxFrame) ) {
 376                         pFrame = (wxFrame *)pWin;
 377                     }
 378                 }
 379
 380                 if ( pFrame && pFrame->GetStatusBar() )
 381                     pFrame->SetStatusText(msg);
 382             }
 383 #endif // wxUSE_STATUSBAR
 384             break;
 385
 386         case wxLOG_Error:
 387             if ( !m_bErrors ) {
 388 #if !wxUSE_LOG_DIALOG
 389                 // discard earlier informational messages if this is the 1st
 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
 396                 m_bErrors = true;
 397             }
 398             // fall through
 399
 400         case wxLOG_Warning:
 401             if ( !m_bErrors ) {
 402                 // for the warning we don't discard the info messages
 403                 m_bWarnings = true;
 404             }
 405
 406             m_aMessages.Add(msg);
 407             m_aSeverity.Add((int)level);
 408             m_aTimes.Add((long)info.timestamp);
 409             m_bHasMessages = true;
 410             break;
 411
 412         case wxLOG_Debug:
 413         case wxLOG_Trace:
 414             // let the base class deal with debug/trace messages
 415             wxLog::DoLogRecord(level, msg, info);
 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;
 431     }
 432 }
 433
 434 #endif   // wxUSE_LOGGUI
 435
 436 // ----------------------------------------------------------------------------
 437 // wxLogWindow and wxLogFrame implementation
 438 // ----------------------------------------------------------------------------
 439
 440 #if wxUSE_LOGWINDOW
 441
 442 // log frame class
 443 // ---------------
 444 class wxLogFrame : public wxFrame
 445 {
 446 public:
 447     // ctor & dtor
 448     wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxString& szTitle);
 449     virtual ~wxLogFrame();
 450
 451     // Don't prevent the application from exiting if just this frame remains.
 452     virtual bool ShouldPreventAppExit() const { return false; }
 453
 454     // menu callbacks
 455     void OnClose(wxCommandEvent& event);
 456     void OnCloseWindow(wxCloseEvent& event);
 457 #if CAN_SAVE_FILES
 458     void OnSave(wxCommandEvent& event);
 459 #endif // CAN_SAVE_FILES
 460     void OnClear(wxCommandEvent& event);
 461
 462     // do show the message in the text control
 463     void ShowLogMessage(const wxString& message)
 464     {
 465         m_pTextCtrl->AppendText(message + wxS('\n'));
 466     }
 467
 468 private:
 469     // use standard ids for our commands!
 470     enum
 471     {
 472         Menu_Close = wxID_CLOSE,
 473         Menu_Save  = wxID_SAVE,
 474         Menu_Clear = wxID_CLEAR
 475     };
 476
 477     // common part of OnClose() and OnCloseWindow()
 478     void DoClose();
 479
 480     wxTextCtrl  *m_pTextCtrl;
 481     wxLogWindow *m_log;
 482
 483     DECLARE_EVENT_TABLE()
 484     wxDECLARE_NO_COPY_CLASS(wxLogFrame);
 485 };
 486
 487 BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
 488     // wxLogWindow menu events
 489     EVT_MENU(Menu_Close, wxLogFrame::OnClose)
 490 #if CAN_SAVE_FILES
 491     EVT_MENU(Menu_Save,  wxLogFrame::OnSave)
 492 #endif // CAN_SAVE_FILES
 493     EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
 494
 495     EVT_CLOSE(wxLogFrame::OnCloseWindow)
 496 END_EVENT_TABLE()
 497
 498 wxLogFrame::wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxString& szTitle)
 499           : wxFrame(pParent, wxID_ANY, szTitle)
 500 {
 501     m_log = log;
 502
 503     m_pTextCtrl = new wxTextCtrl(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
 504             wxDefaultSize,
 505             wxTE_MULTILINE  |
 506             wxHSCROLL       |
 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
 512             wxTE_READONLY);
 513
 514 #if wxUSE_MENUS
 515     // create menu
 516     wxMenuBar *pMenuBar = new wxMenuBar;
 517     wxMenu *pMenu = new wxMenu;
 518 #if CAN_SAVE_FILES
 519     pMenu->Append(Menu_Save,  _("Save &As..."), _("Save log contents to file"));
 520 #endif // CAN_SAVE_FILES
 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);
 526 #endif // wxUSE_MENUS
 527
 528 #if wxUSE_STATUSBAR
 529     // status bar for menu prompts
 530     CreateStatusBar();
 531 #endif // wxUSE_STATUSBAR
 532 }
 533
 534 void 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
 540         Show(false);
 541     }
 542 }
 543
 544 void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
 545 {
 546     DoClose();
 547 }
 548
 549 void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 550 {
 551     DoClose();
 552 }
 553
 554 #if CAN_SAVE_FILES
 555 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 556 {
 557     wxString filename;
 558     wxFile file;
 559     int rc = OpenLogFile(file, &filename, this);
 560     if ( rc == -1 )
 561     {
 562         // cancelled
 563         return;
 564     }
 565
 566     bool bOk = rc != 0;
 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) +
 573                          wxTextFile::GetEOL());
 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 {
 583         wxLogStatus((wxFrame*)this, _("Log saved to the file '%s'."), filename.c_str());
 584     }
 585 }
 586 #endif // CAN_SAVE_FILES
 587
 588 void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
 589 {
 590     m_pTextCtrl->Clear();
 591 }
 592
 593 wxLogFrame::~wxLogFrame()
 594 {
 595     m_log->OnFrameDelete(this);
 596 }
 597
 598 // wxLogWindow
 599 // -----------
 600
 601 wxLogWindow::wxLogWindow(wxWindow *pParent,
 602                          const wxString& szTitle,
 603                          bool bShow,
 604                          bool bDoPass)
 605 {
 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
 611     PassMessages(bDoPass);
 612
 613     m_pLogFrame = new wxLogFrame(pParent, this, szTitle);
 614
 615     if ( bShow )
 616         m_pLogFrame->Show();
 617 }
 618
 619 void wxLogWindow::Show(bool bShow)
 620 {
 621     m_pLogFrame->Show(bShow);
 622 }
 623
 624 void wxLogWindow::DoLogTextAtLevel(wxLogLevel level, const wxString& msg)
 625 {
 626     if ( !m_pLogFrame )
 627         return;
 628
 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;
 636
 637     m_pLogFrame->ShowLogMessage(msg);
 638 }
 639
 640 wxFrame *wxLogWindow::GetFrame() const
 641 {
 642     return m_pLogFrame;
 643 }
 644
 645 bool wxLogWindow::OnFrameClose(wxFrame * WXUNUSED(frame))
 646 {
 647     // allow to close
 648     return true;
 649 }
 650
 651 void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame))
 652 {
 653     m_pLogFrame = NULL;
 654 }
 655
 656 wxLogWindow::~wxLogWindow()
 657 {
 658     // may be NULL if log frame already auto destroyed itself
 659     delete m_pLogFrame;
 660 }
 661
 662 #endif // wxUSE_LOGWINDOW
 663
 664 // ----------------------------------------------------------------------------
 665 // wxLogDialog
 666 // ----------------------------------------------------------------------------
 667
 668 #if wxUSE_LOG_DIALOG
 669
 670 wxString wxLogDialog::ms_details;
 671 size_t wxLogDialog::ms_maxLength = 0;
 672
 673 wxLogDialog::wxLogDialog(wxWindow *parent,
 674                          const wxArrayString& messages,
 675                          const wxArrayInt& severity,
 676                          const wxArrayLong& times,
 677                          const wxString& caption,
 678                          long style)
 679            : wxDialog(parent, wxID_ANY, caption,
 680                       wxDefaultPosition, wxDefaultSize,
 681                       wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
 682 {
 683     // init the static variables:
 684
 685     if ( ms_details.empty() )
 686     {
 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");
 690         ms_details = wxGetTranslation(ms_details);
 691 #ifdef __SMARTPHONE__
 692         ms_details = wxStripMenuCodes(ms_details);
 693 #endif
 694     }
 695
 696     if ( ms_maxLength == 0 )
 697     {
 698         ms_maxLength = (2 * wxGetDisplaySize().x/3) / GetCharWidth();
 699     }
 700
 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     {
 708         m_messages.Add(messages[n]);
 709         m_severity.Add(severity[n]);
 710         m_times.Add(times[n]);
 711     }
 712
 713     m_listctrl = NULL;
 714
 715     bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
 716
 717     // create the controls which are always shown and layout them: we use
 718     // sizers even though our window is not resizable to calculate the size of
 719     // the dialog properly
 720     wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
 721     wxBoxSizer *sizerAll = new wxBoxSizer(isPda ? wxVERTICAL : wxHORIZONTAL);
 722
 723     if (!isPda)
 724     {
 725         wxStaticBitmap *icon = new wxStaticBitmap
 726                                    (
 727                                     this,
 728                                     wxID_ANY,
 729                                     wxArtProvider::GetMessageBoxIcon(style)
 730                                    );
 731         sizerAll->Add(icon, wxSizerFlags().Centre());
 732     }
 733
 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
 739     sizerAll->Add(szText, wxSizerFlags(1).Centre().Border(wxLEFT | wxRIGHT));
 740
 741     wxButton *btnOk = new wxButton(this, wxID_OK);
 742     sizerAll->Add(btnOk, wxSizerFlags().Centre());
 743
 744     sizerTop->Add(sizerAll, wxSizerFlags().Expand().Border());
 745
 746
 747     // add the details pane
 748 #ifndef __SMARTPHONE__
 749
 750 #if wxUSE_COLLPANE
 751     wxCollapsiblePane * const
 752         collpane = new wxCollapsiblePane(this, wxID_ANY, ms_details);
 753     sizerTop->Add(collpane, wxSizerFlags(1).Expand().Border());
 754
 755     wxWindow *win = collpane->GetPane();
 756 #else
 757     wxPanel* win = new wxPanel(this, wxID_ANY, wxDefaultPosition, wxDefaultSize,
 758                                wxBORDER_NONE);
 759 #endif
 760     wxSizer * const paneSz = new wxBoxSizer(wxVERTICAL);
 761
 762     CreateDetailsControls(win);
 763
 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
 775
 776 #if CAN_SAVE_FILES
 777     btnSizer->Add(new wxButton(win, wxID_SAVE), flagsBtn);
 778 #endif // CAN_SAVE_FILES
 779
 780     paneSz->Add(btnSizer, wxSizerFlags().Right().Border(wxTOP|wxBOTTOM));
 781 #endif // wxUSE_CLIPBOARD || CAN_SAVE_FILES
 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);
 791
 792     Centre();
 793
 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     }
 800 }
 801
 802 void wxLogDialog::CreateDetailsControls(wxWindow *parent)
 803 {
 804     wxString fmt = wxLog::GetTimestamp();
 805     bool hasTimeStamp = !fmt.IsEmpty();
 806
 807     // create the list ctrl now
 808     m_listctrl = new wxListCtrl(parent, wxID_ANY,
 809                                 wxDefaultPosition, wxDefaultSize,
 810                                 wxBORDER_SIMPLE |
 811                                 wxLC_REPORT |
 812                                 wxLC_NO_HEADER |
 813                                 wxLC_SINGLE_SEL);
 814 #ifdef __WXWINCE__
 815     // This makes a big aesthetic difference on WinCE but I
 816     // don't want to risk problems on other platforms
 817     m_listctrl->Hide();
 818 #endif
 819
 820     // no need to translate these strings as they're not shown to the
 821     // user anyhow (we use wxLC_NO_HEADER style)
 822     m_listctrl->InsertColumn(0, wxT("Message"));
 823
 824     if (hasTimeStamp)
 825         m_listctrl->InsertColumn(1, wxT("Time"));
 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!
 832     static const char* const icons[] =
 833     {
 834         wxART_ERROR,
 835         wxART_WARNING,
 836         wxART_INFORMATION
 837     };
 838
 839     bool loadedIcons = true;
 840
 841     for ( size_t icon = 0; icon < WXSIZEOF(icons); icon++ )
 842     {
 843         wxBitmap bmp = wxArtProvider::GetBitmap(icons[icon], wxART_MESSAGE_BOX,
 844                                                 wxSize(ICON_SIZE, ICON_SIZE));
 845
 846         // This may very well fail if there are insufficient colours available.
 847         // Degrade gracefully.
 848         if ( !bmp.IsOk() )
 849         {
 850             loadedIcons = false;
 851
 852             break;
 853         }
 854
 855         imageList->Add(bmp);
 856     }
 857
 858     m_listctrl->SetImageList(imageList, wxIMAGE_LIST_SMALL);
 859
 860     // fill the listctrl
 861     size_t count = m_messages.GetCount();
 862     for ( size_t n = 0; n < count; n++ )
 863     {
 864         int image;
 865
 866         if ( loadedIcons )
 867         {
 868             switch ( m_severity[n] )
 869             {
 870                 case wxLOG_Error:
 871                     image = 0;
 872                     break;
 873
 874                 case wxLOG_Warning:
 875                     image = 1;
 876                     break;
 877
 878                 default:
 879                     image = 2;
 880             }
 881         }
 882         else // failed to load images
 883         {
 884             image = -1;
 885         }
 886
 887         wxString msg = m_messages[n];
 888         msg.Replace(wxT("\n"), wxT(" "));
 889         msg = EllipsizeString(msg);
 890
 891         m_listctrl->InsertItem(n, msg, image);
 892
 893         if (hasTimeStamp)
 894             m_listctrl->SetItem(n, 1, TimeStamp(fmt, (time_t)m_times[n]));
 895     }
 896
 897     // let the columns size themselves
 898     m_listctrl->SetColumnWidth(0, wxLIST_AUTOSIZE);
 899     if (hasTimeStamp)
 900         m_listctrl->SetColumnWidth(1, wxLIST_AUTOSIZE);
 901
 902     // calculate an approximately nice height for the listctrl
 903     int height = GetCharHeight()*(count + 4);
 904
 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();
 911
 912     // we should leave a margin
 913     heightMax *= 9;
 914     heightMax /= 10;
 915
 916     m_listctrl->SetSize(wxDefaultCoord, wxMin(height, heightMax));
 917 }
 918
 919 void 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
 931     // wxMessageBox will nicely handle the '\n' in the string (if any)
 932     // and supports long strings
 933     wxMessageBox(str, wxT("Log message"), wxOK, this);
 934 }
 935
 936 void wxLogDialog::OnOk(wxCommandEvent& WXUNUSED(event))
 937 {
 938     EndModal(wxID_OK);
 939 }
 940
 941 #if CAN_SAVE_FILES || wxUSE_CLIPBOARD
 942
 943 wxString wxLogDialog::GetLogMessages() const
 944 {
 945     wxString fmt = wxLog::GetTimestamp();
 946     if ( fmt.empty() )
 947     {
 948         // use the default format
 949         fmt = "%c";
 950     }
 951
 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++ )
 957     {
 958         text << TimeStamp(fmt, (time_t)m_times[n])
 959              << ": "
 960              << m_messages[n]
 961              << wxTextFile::GetEOL();
 962     }
 963
 964     return text;
 965 }
 966
 967 #endif // CAN_SAVE_FILES || wxUSE_CLIPBOARD
 968
 969 #if wxUSE_CLIPBOARD
 970
 971 void 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."));
 978     }
 979 }
 980
 981 #endif // wxUSE_CLIPBOARD
 982
 983 #if CAN_SAVE_FILES
 984
 985 void 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     }
 994
 995     if ( !rc || !file.Write(GetLogMessages()) || !file.Close() )
 996     {
 997         wxLogError(_("Can't save log contents to file."));
 998     }
 999 }
1000
1001 #endif // CAN_SAVE_FILES
1002
1003 wxLogDialog::~wxLogDialog()
1004 {
1005     if ( m_listctrl )
1006     {
1007         delete m_listctrl->GetImageList(wxIMAGE_LIST_SMALL);
1008     }
1009 }
1010
1011 #endif // wxUSE_LOG_DIALOG
1012
1013 #if CAN_SAVE_FILES
1014
1015 // pass an uninitialized file object, the function will ask the user for the
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
1018 // dialog was cancelled
1019 static int OpenLogFile(wxFile& file, wxString *pFilename, wxWindow *parent)
1020 {
1021     // get the file name
1022     // -----------------
1023     wxString filename = wxSaveFileSelector(wxT("log"), wxT("txt"), wxT("log.txt"), parent);
1024     if ( !filename ) {
1025         // cancelled
1026         return -1;
1027     }
1028
1029     // open file
1030     // ---------
1031     bool bOk = true; // suppress warning about it being possible uninitialized
1032     if ( wxFile::Exists(filename) ) {
1033         bool bAppend = false;
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:
1040                 bAppend = true;
1041                 break;
1042
1043             case wxNO:
1044                 bAppend = false;
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 {
1058             bOk = file.Create(filename, true /* overwrite */);
1059         }
1060     }
1061     else {
1062         bOk = file.Create(filename);
1063     }
1064
1065     if ( pFilename )
1066         *pFilename = filename;
1067
1068     return bOk;
1069 }
1070
1071 #endif // CAN_SAVE_FILES
1072
1073 #endif // !(wxUSE_LOGGUI || wxUSE_LOGWINDOW)
1074
1075 #if wxUSE_LOG && wxUSE_TEXTCTRL
1076
1077 // ----------------------------------------------------------------------------
1078 // wxLogTextCtrl implementation
1079 // ----------------------------------------------------------------------------
1080
1081 wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
1082 {
1083     m_pTextCtrl = pTextCtrl;
1084 }
1085
1086 void wxLogTextCtrl::DoLogText(const wxString& msg)
1087 {
1088     m_pTextCtrl->AppendText(msg + wxS('\n'));
1089 }
1090
1091 #endif // wxUSE_LOG && wxUSE_TEXTCTRL