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