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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  22     #pragma implementation "logg.h"
  23 #endif
  24
  25 // For compilers that support precompilation, includes "wx.h".
  26 #include "wx/wxprec.h"
  27
  28 #ifdef __BORLANDC__
  29   #pragma hdrstop
  30 #endif
  31
  32 #ifndef WX_PRECOMP
  33     #include "wx/app.h"
  34     #include "wx/button.h"
  35     #include "wx/intl.h"
  36     #include "wx/log.h"
  37     #include "wx/menu.h"
  38     #include "wx/frame.h"
  39     #include "wx/filedlg.h"
  40     #include "wx/msgdlg.h"
  41     #include "wx/textctrl.h"
  42     #include "wx/sizer.h"
  43     #include "wx/statbmp.h"
  44     #include "wx/button.h"
  45     #include "wx/settings.h"
  46 #endif // WX_PRECOMP
  47
  48 #if wxUSE_LOGGUI || wxUSE_LOGWINDOW
  49
  50 #include "wx/file.h"
  51 #include "wx/textfile.h"
  52 #include "wx/statline.h"
  53 #include "wx/artprov.h"
  54
  55 #ifdef  __WXMSW__
  56   // for OutputDebugString()
  57   #include  "wx/msw/private.h"
  58 #endif // Windows
  59
  60 #ifdef  __WXPM__
  61   #include <time.h>
  62 #endif
  63
  64 #if wxUSE_LOG_DIALOG
  65     #include "wx/listctrl.h"
  66     #include "wx/imaglist.h"
  67     #include "wx/image.h"
  68 #else // !wxUSE_LOG_DIALOG
  69     #include "wx/msgdlg.h"
  70 #endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
  71
  72 #if defined(__MWERKS__) && wxUSE_UNICODE
  73     #include <wtime.h>
  74 #endif
  75
  76 #include "wx/datetime.h"
  77
  78 // the suffix we add to the button to show that the dialog can be expanded
  79 #define EXPAND_SUFFIX _T(" >>")
  80
  81 // ----------------------------------------------------------------------------
  82 // private classes
  83 // ----------------------------------------------------------------------------
  84
  85 #if wxUSE_LOG_DIALOG
  86
  87 // this function is a wrapper around strftime(3)
  88 // allows to exclude the usage of wxDateTime
  89 static wxString TimeStamp(const wxChar *format, time_t t)
  90 {
  91 #ifdef __WXWINCE__
  92     // FIXME
  93     return wxEmptyString;
  94 #else
  95     wxChar buf[4096];
  96     if ( !wxStrftime(buf, WXSIZEOF(buf), format, localtime(&t)) )
  97     {
  98         // buffer is too small?
  99         wxFAIL_MSG(_T("strftime() failed"));
 100     }
 101     return wxString(buf);
 102 #endif
 103 }
 104
 105
 106 class wxLogDialog : public wxDialog
 107 {
 108 public:
 109     wxLogDialog(wxWindow *parent,
 110                 const wxArrayString& messages,
 111                 const wxArrayInt& severity,
 112                 const wxArrayLong& timess,
 113                 const wxString& caption,
 114                 long style);
 115     virtual ~wxLogDialog();
 116
 117     // event handlers
 118     void OnOk(wxCommandEvent& event);
 119     void OnDetails(wxCommandEvent& event);
 120 #if wxUSE_FILE
 121     void OnSave(wxCommandEvent& event);
 122 #endif // wxUSE_FILE
 123     void OnListSelect(wxListEvent& event);
 124
 125 private:
 126     // create controls needed for the details display
 127     void CreateDetailsControls();
 128
 129     // the data for the listctrl
 130     wxArrayString m_messages;
 131     wxArrayInt m_severity;
 132     wxArrayLong m_times;
 133
 134     // the "toggle" button and its state
 135 #ifndef __SMARTPHONE__
 136     wxButton *m_btnDetails;
 137 #endif
 138     bool      m_showingDetails;
 139
 140     // the controls which are not shown initially (but only when details
 141     // button is pressed)
 142     wxListCtrl *m_listctrl;
 143 #ifndef __SMARTPHONE__
 144 #if wxUSE_STATLINE
 145     wxStaticLine *m_statline;
 146 #endif // wxUSE_STATLINE
 147 #if wxUSE_FILE
 148     wxButton *m_btnSave;
 149 #endif // wxUSE_FILE
 150 #endif // __SMARTPHONE__
 151
 152     // the translated "Details" string
 153     static wxString ms_details;
 154
 155     DECLARE_EVENT_TABLE()
 156     DECLARE_NO_COPY_CLASS(wxLogDialog)
 157 };
 158
 159 BEGIN_EVENT_TABLE(wxLogDialog, wxDialog)
 160     EVT_BUTTON(wxID_OK, wxLogDialog::OnOk)
 161     EVT_BUTTON(wxID_MORE,   wxLogDialog::OnDetails)
 162 #if wxUSE_FILE
 163     EVT_BUTTON(wxID_SAVE,   wxLogDialog::OnSave)
 164 #endif // wxUSE_FILE
 165     EVT_LIST_ITEM_SELECTED(wxID_ANY, wxLogDialog::OnListSelect)
 166 END_EVENT_TABLE()
 167
 168 #endif // wxUSE_LOG_DIALOG
 169
 170 // ----------------------------------------------------------------------------
 171 // private functions
 172 // ----------------------------------------------------------------------------
 173
 174 #if wxUSE_FILE && wxUSE_FILEDLG
 175
 176 // pass an uninitialized file object, the function will ask the user for the
 177 // filename and try to open it, returns true on success (file was opened),
 178 // false if file couldn't be opened/created and -1 if the file selection
 179 // dialog was cancelled
 180 static int OpenLogFile(wxFile& file, wxString *filename = NULL, wxWindow *parent = NULL);
 181
 182 #endif // wxUSE_FILE
 183
 184 // ----------------------------------------------------------------------------
 185 // global variables
 186 // ----------------------------------------------------------------------------
 187
 188 // we use a global variable to store the frame pointer for wxLogStatus - bad,
 189 // but it's the easiest way
 190 static wxFrame *gs_pFrame = NULL; // FIXME MT-unsafe
 191
 192 // ============================================================================
 193 // implementation
 194 // ============================================================================
 195
 196 // ----------------------------------------------------------------------------
 197 // global functions
 198 // ----------------------------------------------------------------------------
 199
 200 // accepts an additional argument which tells to which frame the output should
 201 // be directed
 202 void wxVLogStatus(wxFrame *pFrame, const wxChar *szFormat, va_list argptr)
 203 {
 204   wxString msg;
 205
 206   wxLog *pLog = wxLog::GetActiveTarget();
 207   if ( pLog != NULL ) {
 208     msg.PrintfV(szFormat, argptr);
 209
 210     wxASSERT( gs_pFrame == NULL ); // should be reset!
 211     gs_pFrame = pFrame;
 212 #ifdef __WXWINCE__
 213     wxLog::OnLog(wxLOG_Status, msg, 0);
 214 #else
 215     wxLog::OnLog(wxLOG_Status, msg, time(NULL));
 216 #endif
 217     gs_pFrame = (wxFrame *) NULL;
 218   }
 219 }
 220
 221 void wxLogStatus(wxFrame *pFrame, const wxChar *szFormat, ...)
 222 {
 223     va_list argptr;
 224     va_start(argptr, szFormat);
 225     wxVLogStatus(pFrame, szFormat, argptr);
 226     va_end(argptr);
 227 }
 228
 229 // ----------------------------------------------------------------------------
 230 // wxLogGui implementation (FIXME MT-unsafe)
 231 // ----------------------------------------------------------------------------
 232
 233 #if wxUSE_LOGGUI
 234
 235 wxLogGui::wxLogGui()
 236 {
 237     Clear();
 238 }
 239
 240 void wxLogGui::Clear()
 241 {
 242     m_bErrors =
 243     m_bWarnings =
 244     m_bHasMessages = false;
 245
 246     m_aMessages.Empty();
 247     m_aSeverity.Empty();
 248     m_aTimes.Empty();
 249 }
 250
 251 void wxLogGui::Flush()
 252 {
 253     if ( !m_bHasMessages )
 254         return;
 255
 256     // do it right now to block any new calls to Flush() while we're here
 257     m_bHasMessages = false;
 258
 259     wxString appName = wxTheApp->GetAppName();
 260     if ( !appName.empty() )
 261         appName[0u] = (wxChar)wxToupper(appName[0u]);
 262
 263     long style;
 264     wxString titleFormat;
 265     if ( m_bErrors ) {
 266         titleFormat = _("%s Error");
 267         style = wxICON_STOP;
 268     }
 269     else if ( m_bWarnings ) {
 270         titleFormat = _("%s Warning");
 271         style = wxICON_EXCLAMATION;
 272     }
 273     else {
 274         titleFormat = _("%s Information");
 275         style = wxICON_INFORMATION;
 276     }
 277
 278     wxString title;
 279     title.Printf(titleFormat, appName.c_str());
 280
 281     size_t nMsgCount = m_aMessages.Count();
 282
 283     // avoid showing other log dialogs until we're done with the dialog we're
 284     // showing right now: nested modal dialogs make for really bad UI!
 285     Suspend();
 286
 287     wxString str;
 288     if ( nMsgCount == 1 )
 289     {
 290         str = m_aMessages[0];
 291     }
 292     else // more than one message
 293     {
 294 #if wxUSE_LOG_DIALOG
 295
 296         wxLogDialog dlg(NULL,
 297                         m_aMessages, m_aSeverity, m_aTimes,
 298                         title, style);
 299
 300         // clear the message list before showing the dialog because while it's
 301         // shown some new messages may appear
 302         Clear();
 303
 304         (void)dlg.ShowModal();
 305 #else // !wxUSE_LOG_DIALOG
 306         // concatenate all strings (but not too many to not overfill the msg box)
 307         size_t nLines = 0;
 308
 309         // start from the most recent message
 310         for ( size_t n = nMsgCount; n > 0; n-- ) {
 311             // for Windows strings longer than this value are wrapped (NT 4.0)
 312             const size_t nMsgLineWidth = 156;
 313
 314             nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
 315
 316             if ( nLines > 25 )  // don't put too many lines in message box
 317                 break;
 318
 319             str << m_aMessages[n - 1] << wxT("\n");
 320         }
 321 #endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
 322     }
 323
 324     // this catches both cases of 1 message with wxUSE_LOG_DIALOG and any
 325     // situation without it
 326     if ( !str.empty() )
 327     {
 328         wxMessageBox(str, title, wxOK | style);
 329
 330         // no undisplayed messages whatsoever
 331         Clear();
 332     }
 333
 334     // allow flushing the logs again
 335     Resume();
 336 }
 337
 338 // log all kinds of messages
 339 void wxLogGui::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 340 {
 341     switch ( level ) {
 342         case wxLOG_Info:
 343             if ( GetVerbose() )
 344         case wxLOG_Message:
 345             {
 346                 m_aMessages.Add(szString);
 347                 m_aSeverity.Add(wxLOG_Message);
 348                 m_aTimes.Add((long)t);
 349                 m_bHasMessages = true;
 350             }
 351             break;
 352
 353         case wxLOG_Status:
 354 #if wxUSE_STATUSBAR
 355             {
 356                 // find the top window and set it's status text if it has any
 357                 wxFrame *pFrame = gs_pFrame;
 358                 if ( pFrame == NULL ) {
 359                     wxWindow *pWin = wxTheApp->GetTopWindow();
 360                     if ( pWin != NULL && pWin->IsKindOf(CLASSINFO(wxFrame)) ) {
 361                         pFrame = (wxFrame *)pWin;
 362                     }
 363                 }
 364
 365                 if ( pFrame && pFrame->GetStatusBar() )
 366                     pFrame->SetStatusText(szString);
 367             }
 368 #endif // wxUSE_STATUSBAR
 369             break;
 370
 371         case wxLOG_Trace:
 372         case wxLOG_Debug:
 373             #ifdef __WXDEBUG__
 374             {
 375                 wxString str;
 376                 TimeStamp(&str);
 377                 str += szString;
 378
 379                 #if defined(__WXMSW__) && !defined(__WXMICROWIN__)
 380                     // don't prepend debug/trace here: it goes to the
 381                     // debug window anyhow
 382                     str += wxT("\r\n");
 383                     OutputDebugString(str);
 384                 #else
 385                     // send them to stderr
 386                     wxFprintf(stderr, wxT("[%s] %s\n"),
 387                               level == wxLOG_Trace ? wxT("Trace")
 388                                                    : wxT("Debug"),
 389                               str.c_str());
 390                     fflush(stderr);
 391                 #endif
 392             }
 393             #endif // __WXDEBUG__
 394
 395             break;
 396
 397         case wxLOG_FatalError:
 398             // show this one immediately
 399             wxMessageBox(szString, _("Fatal error"), wxICON_HAND);
 400             wxExit();
 401             break;
 402
 403         case wxLOG_Error:
 404             if ( !m_bErrors ) {
 405 #if !wxUSE_LOG_DIALOG
 406                 // discard earlier informational messages if this is the 1st
 407                 // error because they might not make sense any more and showing
 408                 // them in a message box might be confusing
 409                 m_aMessages.Empty();
 410                 m_aSeverity.Empty();
 411                 m_aTimes.Empty();
 412 #endif // wxUSE_LOG_DIALOG
 413                 m_bErrors = true;
 414             }
 415             // fall through
 416
 417         case wxLOG_Warning:
 418             if ( !m_bErrors ) {
 419                 // for the warning we don't discard the info messages
 420                 m_bWarnings = true;
 421             }
 422
 423             m_aMessages.Add(szString);
 424             m_aSeverity.Add((int)level);
 425             m_aTimes.Add((long)t);
 426             m_bHasMessages = true;
 427             break;
 428     }
 429 }
 430
 431 #endif   // wxUSE_LOGGUI
 432
 433 // ----------------------------------------------------------------------------
 434 // wxLogWindow and wxLogFrame implementation
 435 // ----------------------------------------------------------------------------
 436
 437 // log frame class
 438 // ---------------
 439 class wxLogFrame : public wxFrame
 440 {
 441 public:
 442     // ctor & dtor
 443     wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxChar *szTitle);
 444     virtual ~wxLogFrame();
 445
 446     // menu callbacks
 447     void OnClose(wxCommandEvent& event);
 448     void OnCloseWindow(wxCloseEvent& event);
 449 #if wxUSE_FILE
 450     void OnSave (wxCommandEvent& event);
 451 #endif // wxUSE_FILE
 452     void OnClear(wxCommandEvent& event);
 453
 454     // accessors
 455     wxTextCtrl *TextCtrl() const { return m_pTextCtrl; }
 456
 457 private:
 458     // use standard ids for our commands!
 459     enum
 460     {
 461         Menu_Close = wxID_CLOSE,
 462         Menu_Save  = wxID_SAVE,
 463         Menu_Clear = wxID_CLEAR
 464     };
 465
 466     // common part of OnClose() and OnCloseWindow()
 467     void DoClose();
 468
 469     wxTextCtrl  *m_pTextCtrl;
 470     wxLogWindow *m_log;
 471
 472     DECLARE_EVENT_TABLE()
 473     DECLARE_NO_COPY_CLASS(wxLogFrame)
 474 };
 475
 476 BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
 477     // wxLogWindow menu events
 478     EVT_MENU(Menu_Close, wxLogFrame::OnClose)
 479 #if wxUSE_FILE
 480     EVT_MENU(Menu_Save,  wxLogFrame::OnSave)
 481 #endif // wxUSE_FILE
 482     EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
 483
 484     EVT_CLOSE(wxLogFrame::OnCloseWindow)
 485 END_EVENT_TABLE()
 486
 487 wxLogFrame::wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxChar *szTitle)
 488           : wxFrame(pParent, wxID_ANY, szTitle)
 489 {
 490     m_log = log;
 491
 492     m_pTextCtrl = new wxTextCtrl(this, wxID_ANY, wxEmptyString, wxDefaultPosition,
 493             wxDefaultSize,
 494             wxTE_MULTILINE  |
 495             wxHSCROLL       |
 496             // needed for Win32 to avoid 65Kb limit but it doesn't work well
 497             // when using RichEdit 2.0 which we always do in the Unicode build
 498 #if !wxUSE_UNICODE
 499             wxTE_RICH       |
 500 #endif // !wxUSE_UNICODE
 501             wxTE_READONLY);
 502
 503 #if wxUSE_MENUS
 504     // create menu
 505     wxMenuBar *pMenuBar = new wxMenuBar;
 506     wxMenu *pMenu = new wxMenu;
 507 #if wxUSE_FILE
 508     pMenu->Append(Menu_Save,  _("&Save..."), _("Save log contents to file"));
 509 #endif // wxUSE_FILE
 510     pMenu->Append(Menu_Clear, _("C&lear"), _("Clear the log contents"));
 511     pMenu->AppendSeparator();
 512     pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
 513     pMenuBar->Append(pMenu, _("&Log"));
 514     SetMenuBar(pMenuBar);
 515 #endif // wxUSE_MENUS
 516
 517 #if wxUSE_STATUSBAR
 518     // status bar for menu prompts
 519     CreateStatusBar();
 520 #endif // wxUSE_STATUSBAR
 521
 522     m_log->OnFrameCreate(this);
 523 }
 524
 525 void wxLogFrame::DoClose()
 526 {
 527     if ( m_log->OnFrameClose(this) )
 528     {
 529         // instead of closing just hide the window to be able to Show() it
 530         // later
 531         Show(false);
 532     }
 533 }
 534
 535 void wxLogFrame::OnClose(wxCommandEvent& WXUNUSED(event))
 536 {
 537     DoClose();
 538 }
 539
 540 void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 541 {
 542     DoClose();
 543 }
 544
 545 #if wxUSE_FILE
 546 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 547 {
 548 #if wxUSE_FILEDLG
 549     wxString filename;
 550     wxFile file;
 551     int rc = OpenLogFile(file, &filename, this);
 552     if ( rc == -1 )
 553     {
 554         // cancelled
 555         return;
 556     }
 557
 558     bool bOk = rc != 0;
 559
 560     // retrieve text and save it
 561     // -------------------------
 562     int nLines = m_pTextCtrl->GetNumberOfLines();
 563     for ( int nLine = 0; bOk && nLine < nLines; nLine++ ) {
 564         bOk = file.Write(m_pTextCtrl->GetLineText(nLine) +
 565                          wxTextFile::GetEOL());
 566     }
 567
 568     if ( bOk )
 569         bOk = file.Close();
 570
 571     if ( !bOk ) {
 572         wxLogError(_("Can't save log contents to file."));
 573     }
 574     else {
 575         wxLogStatus(this, _("Log saved to the file '%s'."), filename.c_str());
 576     }
 577 #endif
 578 }
 579 #endif // wxUSE_FILE
 580
 581 void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
 582 {
 583     m_pTextCtrl->Clear();
 584 }
 585
 586 wxLogFrame::~wxLogFrame()
 587 {
 588     m_log->OnFrameDelete(this);
 589 }
 590
 591 // wxLogWindow
 592 // -----------
 593
 594 wxLogWindow::wxLogWindow(wxWindow *pParent,
 595                          const wxChar *szTitle,
 596                          bool bShow,
 597                          bool bDoPass)
 598 {
 599     PassMessages(bDoPass);
 600
 601     m_pLogFrame = new wxLogFrame(pParent, this, szTitle);
 602
 603     if ( bShow )
 604         m_pLogFrame->Show();
 605 }
 606
 607 void wxLogWindow::Show(bool bShow)
 608 {
 609     m_pLogFrame->Show(bShow);
 610 }
 611
 612 void wxLogWindow::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 613 {
 614     // first let the previous logger show it
 615     wxLogPassThrough::DoLog(level, szString, t);
 616
 617     if ( m_pLogFrame ) {
 618         switch ( level ) {
 619             case wxLOG_Status:
 620                 // by default, these messages are ignored by wxLog, so process
 621                 // them ourselves
 622                 if ( !wxIsEmpty(szString) )
 623                 {
 624                     wxString str;
 625                     str << _("Status: ") << szString;
 626                     DoLogString(str, t);
 627                 }
 628                 break;
 629
 630                 // don't put trace messages in the text window for 2 reasons:
 631                 // 1) there are too many of them
 632                 // 2) they may provoke other trace messages thus sending a program
 633                 //    into an infinite loop
 634             case wxLOG_Trace:
 635                 break;
 636
 637             default:
 638                 // and this will format it nicely and call our DoLogString()
 639                 wxLog::DoLog(level, szString, t);
 640         }
 641     }
 642 }
 643
 644 void wxLogWindow::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
 645 {
 646     // put the text into our window
 647     wxTextCtrl *pText = m_pLogFrame->TextCtrl();
 648
 649     // remove selection (WriteText is in fact ReplaceSelection)
 650 #ifdef __WXMSW__
 651     wxTextPos nLen = pText->GetLastPosition();
 652     pText->SetSelection(nLen, nLen);
 653 #endif // Windows
 654
 655     wxString msg;
 656     TimeStamp(&msg);
 657     msg << szString << wxT('\n');
 658
 659     pText->AppendText(msg);
 660
 661     // TODO ensure that the line can be seen
 662 }
 663
 664 wxFrame *wxLogWindow::GetFrame() const
 665 {
 666     return m_pLogFrame;
 667 }
 668
 669 void wxLogWindow::OnFrameCreate(wxFrame * WXUNUSED(frame))
 670 {
 671 }
 672
 673 bool wxLogWindow::OnFrameClose(wxFrame * WXUNUSED(frame))
 674 {
 675     // allow to close
 676     return true;
 677 }
 678
 679 void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame))
 680 {
 681     m_pLogFrame = (wxLogFrame *)NULL;
 682 }
 683
 684 wxLogWindow::~wxLogWindow()
 685 {
 686     // may be NULL if log frame already auto destroyed itself
 687     delete m_pLogFrame;
 688 }
 689
 690 // ----------------------------------------------------------------------------
 691 // wxLogDialog
 692 // ----------------------------------------------------------------------------
 693
 694 #if wxUSE_LOG_DIALOG
 695
 696 #ifndef __SMARTPHONE__
 697 static const size_t MARGIN = 10;
 698 #else
 699 static const size_t MARGIN = 0;
 700 #endif
 701
 702 wxString wxLogDialog::ms_details;
 703
 704 wxLogDialog::wxLogDialog(wxWindow *parent,
 705                          const wxArrayString& messages,
 706                          const wxArrayInt& severity,
 707                          const wxArrayLong& times,
 708                          const wxString& caption,
 709                          long style)
 710            : wxDialog(parent, wxID_ANY, caption,
 711                       wxDefaultPosition, wxDefaultSize,
 712                       wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
 713 {
 714     if ( ms_details.empty() )
 715     {
 716         // ensure that we won't loop here if wxGetTranslation()
 717         // happens to pop up a Log message while translating this :-)
 718         ms_details = wxTRANSLATE("&Details");
 719         ms_details = wxGetTranslation(ms_details);
 720 #ifdef __SMARTPHONE__
 721         ms_details = wxStripMenuCodes(ms_details);
 722 #endif
 723     }
 724
 725     size_t count = messages.GetCount();
 726     m_messages.Alloc(count);
 727     m_severity.Alloc(count);
 728     m_times.Alloc(count);
 729
 730     for ( size_t n = 0; n < count; n++ )
 731     {
 732         wxString msg = messages[n];
 733         msg.Replace(wxT("\n"), wxT(" "));
 734         m_messages.Add(msg);
 735         m_severity.Add(severity[n]);
 736         m_times.Add(times[n]);
 737     }
 738
 739     m_showingDetails = false; // not initially
 740     m_listctrl = (wxListCtrl *)NULL;
 741
 742 #ifndef __SMARTPHONE__
 743
 744 #if wxUSE_STATLINE
 745     m_statline = (wxStaticLine *)NULL;
 746 #endif // wxUSE_STATLINE
 747
 748 #if wxUSE_FILE
 749     m_btnSave = (wxButton *)NULL;
 750 #endif // wxUSE_FILE
 751
 752 #endif // __SMARTPHONE__
 753
 754     bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
 755
 756     // create the controls which are always shown and layout them: we use
 757     // sizers even though our window is not resizeable to calculate the size of
 758     // the dialog properly
 759     wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
 760 #ifndef __SMARTPHONE__
 761     wxBoxSizer *sizerButtons = new wxBoxSizer(isPda ? wxHORIZONTAL : wxVERTICAL);
 762 #endif
 763     wxBoxSizer *sizerAll = new wxBoxSizer(isPda ? wxVERTICAL : wxHORIZONTAL);
 764
 765 #ifdef __SMARTPHONE__
 766     SetLeftMenu(wxID_OK);
 767     SetRightMenu(wxID_MORE, ms_details + EXPAND_SUFFIX);
 768 #else
 769     wxButton *btnOk = new wxButton(this, wxID_OK);
 770     sizerButtons->Add(btnOk, 0, isPda ? wxCENTRE : wxCENTRE|wxBOTTOM, MARGIN/2);
 771     m_btnDetails = new wxButton(this, wxID_MORE, ms_details + EXPAND_SUFFIX);
 772     sizerButtons->Add(m_btnDetails, 0, isPda ? wxCENTRE|wxLEFT : wxCENTRE | wxTOP, MARGIN/2 - 1);
 773 #endif
 774
 775     wxBitmap bitmap;
 776     switch ( style & wxICON_MASK )
 777     {
 778         case wxICON_ERROR:
 779             bitmap = wxArtProvider::GetBitmap(wxART_ERROR, wxART_MESSAGE_BOX);
 780 #ifdef __WXPM__
 781             bitmap.SetId(wxICON_SMALL_ERROR);
 782 #endif
 783             break;
 784
 785         case wxICON_INFORMATION:
 786             bitmap = wxArtProvider::GetBitmap(wxART_INFORMATION, wxART_MESSAGE_BOX);
 787 #ifdef __WXPM__
 788             bitmap.SetId(wxICON_SMALL_INFO);
 789 #endif
 790             break;
 791
 792         case wxICON_WARNING:
 793             bitmap = wxArtProvider::GetBitmap(wxART_WARNING, wxART_MESSAGE_BOX);
 794 #ifdef __WXPM__
 795             bitmap.SetId(wxICON_SMALL_WARNING);
 796 #endif
 797             break;
 798
 799         default:
 800             wxFAIL_MSG(_T("incorrect log style"));
 801     }
 802
 803     if (!isPda)
 804         sizerAll->Add(new wxStaticBitmap(this, wxID_ANY, bitmap), 0,
 805                   wxALIGN_CENTRE_VERTICAL);
 806
 807     const wxString& message = messages.Last();
 808     sizerAll->Add(CreateTextSizer(message), 1,
 809                   wxALIGN_CENTRE_VERTICAL | wxLEFT | wxRIGHT, MARGIN);
 810 #ifndef __SMARTPHONE__
 811     sizerAll->Add(sizerButtons, 0, isPda ? wxCENTRE|wxTOP|wxBOTTOM : (wxALIGN_RIGHT | wxLEFT), MARGIN);
 812 #endif
 813
 814     sizerTop->Add(sizerAll, 0, wxALL | wxEXPAND, MARGIN);
 815
 816     SetSizer(sizerTop);
 817
 818     // see comments in OnDetails()
 819     //
 820     // Note: Doing this, this way, triggered a nasty bug in
 821     //       wxTopLevelWindowGTK::GtkOnSize which took -1 literally once
 822     //       either of maxWidth or maxHeight was set.  This symptom has been
 823     //       fixed there, but it is a problem that remains as long as we allow
 824     //       unchecked access to the internal size members.  We really need to
 825     //       encapuslate window sizes more cleanly and make it clear when -1 will
 826     //       be substituted and when it will not.
 827
 828     wxSize size = sizerTop->Fit(this);
 829     m_maxHeight = size.y;
 830     SetSizeHints(size.x, size.y, m_maxWidth, m_maxHeight);
 831
 832 #ifndef __SMARTPHONE__
 833     btnOk->SetFocus();
 834 #endif
 835
 836     Centre();
 837
 838     if (isPda)
 839     {
 840         // Move up the screen so that when we expand the dialog,
 841         // there's enough space.
 842         Move(wxPoint(GetPosition().x, GetPosition().y / 2));
 843     }
 844 }
 845
 846 void wxLogDialog::CreateDetailsControls()
 847 {
 848 #ifndef __SMARTPHONE__
 849     // create the save button and separator line if possible
 850 #if wxUSE_FILE
 851     m_btnSave = new wxButton(this, wxID_SAVE);
 852 #endif // wxUSE_FILE
 853
 854 #if wxUSE_STATLINE
 855     m_statline = new wxStaticLine(this, wxID_ANY);
 856 #endif // wxUSE_STATLINE
 857
 858 #endif // __SMARTPHONE__
 859
 860     // create the list ctrl now
 861     m_listctrl = new wxListCtrl(this, wxID_ANY,
 862                                 wxDefaultPosition, wxDefaultSize,
 863                                 wxSUNKEN_BORDER |
 864                                 wxLC_REPORT |
 865                                 wxLC_NO_HEADER |
 866                                 wxLC_SINGLE_SEL);
 867 #ifdef __WXWINCE__
 868     // This maks a big aesthetic difference on WinCE but I
 869     // don't want to risk problems on other platforms
 870     m_listctrl->Hide();
 871 #endif
 872
 873     // no need to translate these strings as they're not shown to the
 874     // user anyhow (we use wxLC_NO_HEADER style)
 875     m_listctrl->InsertColumn(0, _T("Message"));
 876     m_listctrl->InsertColumn(1, _T("Time"));
 877
 878     // prepare the imagelist
 879     static const int ICON_SIZE = 16;
 880     wxImageList *imageList = new wxImageList(ICON_SIZE, ICON_SIZE);
 881
 882     // order should be the same as in the switch below!
 883     static const wxChar* icons[] =
 884     {
 885         wxART_ERROR,
 886         wxART_WARNING,
 887         wxART_INFORMATION
 888     };
 889
 890     bool loadedIcons = true;
 891
 892     for ( size_t icon = 0; icon < WXSIZEOF(icons); icon++ )
 893     {
 894         wxBitmap bmp = wxArtProvider::GetBitmap(icons[icon], wxART_MESSAGE_BOX,
 895                                                 wxSize(ICON_SIZE, ICON_SIZE));
 896
 897         // This may very well fail if there are insufficient colours available.
 898         // Degrade gracefully.
 899         if ( !bmp.Ok() )
 900         {
 901             loadedIcons = false;
 902
 903             break;
 904         }
 905
 906         imageList->Add(bmp);
 907     }
 908
 909     m_listctrl->SetImageList(imageList, wxIMAGE_LIST_SMALL);
 910
 911     // and fill it
 912     wxString fmt = wxLog::GetTimestamp();
 913     if ( !fmt )
 914     {
 915         // default format
 916         fmt = wxDefaultDateTimeFormat;
 917     }
 918
 919     size_t count = m_messages.GetCount();
 920     for ( size_t n = 0; n < count; n++ )
 921     {
 922         int image;
 923
 924         if ( loadedIcons )
 925         {
 926             switch ( m_severity[n] )
 927             {
 928                 case wxLOG_Error:
 929                     image = 0;
 930                     break;
 931
 932                 case wxLOG_Warning:
 933                     image = 1;
 934                     break;
 935
 936                 default:
 937                     image = 2;
 938             }
 939         }
 940         else // failed to load images
 941         {
 942             image = -1;
 943         }
 944
 945         m_listctrl->InsertItem(n, m_messages[n], image);
 946         m_listctrl->SetItem(n, 1, TimeStamp(fmt, (time_t)m_times[n]));
 947     }
 948
 949     // let the columns size themselves
 950     m_listctrl->SetColumnWidth(0, wxLIST_AUTOSIZE);
 951     m_listctrl->SetColumnWidth(1, wxLIST_AUTOSIZE);
 952
 953     // calculate an approximately nice height for the listctrl
 954     int height = GetCharHeight()*(count + 4);
 955
 956     // but check that the dialog won't fall fown from the screen
 957     //
 958     // we use GetMinHeight() to get the height of the dialog part without the
 959     // details and we consider that the "Save" button below and the separator
 960     // line (and the margins around it) take about as much, hence double it
 961     int heightMax = wxGetDisplaySize().y - GetPosition().y - 2*GetMinHeight();
 962
 963     // we should leave a margin
 964     heightMax *= 9;
 965     heightMax /= 10;
 966
 967     m_listctrl->SetSize(wxDefaultCoord, wxMin(height, heightMax));
 968 }
 969
 970 void wxLogDialog::OnListSelect(wxListEvent& event)
 971 {
 972     // we can't just disable the control because this looks ugly under Windows
 973     // (wrong bg colour, no scrolling...), but we still want to disable
 974     // selecting items - it makes no sense here
 975     m_listctrl->SetItemState(event.GetIndex(), 0, wxLIST_STATE_SELECTED);
 976 }
 977
 978 void wxLogDialog::OnOk(wxCommandEvent& WXUNUSED(event))
 979 {
 980     EndModal(wxID_OK);
 981 }
 982
 983 #if wxUSE_FILE
 984
 985 void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
 986 {
 987 #if wxUSE_FILEDLG
 988     wxFile file;
 989     int rc = OpenLogFile(file, NULL, this);
 990     if ( rc == -1 )
 991     {
 992         // cancelled
 993         return;
 994     }
 995
 996     bool ok = rc != 0;
 997
 998     wxString fmt = wxLog::GetTimestamp();
 999     if ( !fmt )
1000     {
1001         // default format
1002         fmt = wxDefaultDateTimeFormat;
1003     }
1004
1005     size_t count = m_messages.GetCount();
1006     for ( size_t n = 0; ok && (n < count); n++ )
1007     {
1008         wxString line;
1009         line << TimeStamp(fmt, (time_t)m_times[n])
1010              << _T(": ")
1011              << m_messages[n]
1012              << wxTextFile::GetEOL();
1013
1014         ok = file.Write(line);
1015     }
1016
1017     if ( ok )
1018         ok = file.Close();
1019
1020     if ( !ok )
1021         wxLogError(_("Can't save log contents to file."));
1022 #endif // wxUSE_FILEDLG
1023 }
1024
1025 #endif // wxUSE_FILE
1026
1027 void wxLogDialog::OnDetails(wxCommandEvent& WXUNUSED(event))
1028 {
1029     wxSizer *sizer = GetSizer();
1030
1031     if ( m_showingDetails )
1032     {
1033 #ifdef __SMARTPHONE__
1034         SetRightMenu(wxID_MORE, ms_details + EXPAND_SUFFIX);
1035 #else
1036         m_btnDetails->SetLabel(ms_details + EXPAND_SUFFIX);
1037 #endif
1038
1039         sizer->Detach( m_listctrl );
1040
1041 #ifndef __SMARTPHONE__
1042
1043 #if wxUSE_STATLINE
1044         sizer->Detach( m_statline );
1045 #endif // wxUSE_STATLINE
1046
1047 #if wxUSE_FILE
1048         sizer->Detach( m_btnSave );
1049 #endif // wxUSE_FILE
1050
1051 #endif // __SMARTPHONE__
1052     }
1053     else // show details now
1054     {
1055 #ifdef __SMARTPHONE__
1056         SetRightMenu(wxID_MORE, wxString(_T("<< ")) + ms_details);
1057 #else
1058         m_btnDetails->SetLabel(wxString(_T("<< ")) + ms_details);
1059 #endif
1060
1061         if ( !m_listctrl )
1062         {
1063             CreateDetailsControls();
1064         }
1065
1066 #if wxUSE_STATLINE && !defined(__SMARTPHONE__)
1067         bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
1068         if (!isPda)
1069             sizer->Add(m_statline, 0, wxEXPAND | (wxALL & ~wxTOP), MARGIN);
1070 #endif // wxUSE_STATLINE
1071
1072         sizer->Add(m_listctrl, 1, wxEXPAND | (wxALL & ~wxTOP), MARGIN);
1073
1074         // VZ: this doesn't work as this becomes the initial (and not only
1075         //     minimal) listctrl height as well - why?
1076 #if 0
1077         // allow the user to make the dialog shorter than its initial height -
1078         // without this it wouldn't work as the list ctrl would have been
1079         // incompressible
1080         sizer->SetItemMinSize(m_listctrl, 100, 3*GetCharHeight());
1081 #endif // 0
1082
1083 #if wxUSE_FILE && !defined(__SMARTPHONE__)
1084         sizer->Add(m_btnSave, 0, wxALIGN_RIGHT | (wxALL & ~wxTOP), MARGIN);
1085 #endif // wxUSE_FILE
1086     }
1087
1088     m_showingDetails = !m_showingDetails;
1089
1090     // in any case, our size changed - relayout everything and set new hints
1091     // ---------------------------------------------------------------------
1092
1093     // we have to reset min size constraints or Fit() would never reduce the
1094     // dialog size when collapsing it and we have to reset max constraint
1095     // because it wouldn't expand it otherwise
1096
1097     m_minHeight =
1098     m_maxHeight = -1;
1099
1100     // wxSizer::FitSize() is private, otherwise we might use it directly...
1101     wxSize sizeTotal = GetSize(),
1102            sizeClient = GetClientSize();
1103
1104     wxSize size = sizer->GetMinSize();
1105     size.x += sizeTotal.x - sizeClient.x;
1106     size.y += sizeTotal.y - sizeClient.y;
1107
1108     // we don't want to allow expanding the dialog in vertical direction as
1109     // this would show the "hidden" details but we can resize the dialog
1110     // vertically while the details are shown
1111     if ( !m_showingDetails )
1112         m_maxHeight = size.y;
1113
1114     SetSizeHints(size.x, size.y, m_maxWidth, m_maxHeight);
1115
1116 #ifdef __WXWINCE__
1117     if (m_showingDetails)
1118         m_listctrl->Show();
1119 #endif
1120
1121     // don't change the width when expanding/collapsing
1122     SetSize(wxDefaultCoord, size.y);
1123
1124 #ifdef __WXGTK__
1125     // VS: this is necessary in order to force frame redraw under
1126     // WindowMaker or fvwm2 (and probably other broken WMs).
1127     // Otherwise, detailed list wouldn't be displayed.
1128     Show();
1129 #endif // wxGTK
1130 }
1131
1132 wxLogDialog::~wxLogDialog()
1133 {
1134     if ( m_listctrl )
1135     {
1136         delete m_listctrl->GetImageList(wxIMAGE_LIST_SMALL);
1137     }
1138 }
1139
1140 #endif // wxUSE_LOG_DIALOG
1141
1142 #if wxUSE_FILE && wxUSE_FILEDLG
1143
1144 // pass an uninitialized file object, the function will ask the user for the
1145 // filename and try to open it, returns true on success (file was opened),
1146 // false if file couldn't be opened/created and -1 if the file selection
1147 // dialog was cancelled
1148 static int OpenLogFile(wxFile& file, wxString *pFilename, wxWindow *parent)
1149 {
1150     // get the file name
1151     // -----------------
1152     wxString filename = wxSaveFileSelector(wxT("log"), wxT("txt"), wxT("log.txt"), parent);
1153     if ( !filename ) {
1154         // cancelled
1155         return -1;
1156     }
1157
1158     // open file
1159     // ---------
1160     bool bOk wxDUMMY_INITIALIZE(false);
1161     if ( wxFile::Exists(filename) ) {
1162         bool bAppend = false;
1163         wxString strMsg;
1164         strMsg.Printf(_("Append log to file '%s' (choosing [No] will overwrite it)?"),
1165                       filename.c_str());
1166         switch ( wxMessageBox(strMsg, _("Question"),
1167                               wxICON_QUESTION | wxYES_NO | wxCANCEL) ) {
1168             case wxYES:
1169                 bAppend = true;
1170                 break;
1171
1172             case wxNO:
1173                 bAppend = false;
1174                 break;
1175
1176             case wxCANCEL:
1177                 return -1;
1178
1179             default:
1180                 wxFAIL_MSG(_("invalid message box return value"));
1181         }
1182
1183         if ( bAppend ) {
1184             bOk = file.Open(filename, wxFile::write_append);
1185         }
1186         else {
1187             bOk = file.Create(filename, true /* overwrite */);
1188         }
1189     }
1190     else {
1191         bOk = file.Create(filename);
1192     }
1193
1194     if ( pFilename )
1195         *pFilename = filename;
1196
1197     return bOk;
1198 }
1199
1200 #endif // wxUSE_FILE
1201
1202 #endif // !(wxUSE_LOGGUI || wxUSE_LOGWINDOW)
1203
1204 #if wxUSE_LOG && wxUSE_TEXTCTRL
1205
1206 // ----------------------------------------------------------------------------
1207 // wxLogTextCtrl implementation
1208 // ----------------------------------------------------------------------------
1209
1210 wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
1211 {
1212     m_pTextCtrl = pTextCtrl;
1213 }
1214
1215 void wxLogTextCtrl::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
1216 {
1217     wxString msg;
1218     TimeStamp(&msg);
1219
1220     msg << szString << wxT('\n');
1221     m_pTextCtrl->AppendText(msg);
1222 }
1223
1224 #endif // wxUSE_LOG && wxUSE_TEXTCTRL
1225