]> git.saurik.com Git - wxWidgets.git/blobdiff - src/generic/logg.cpp
forward port from 2.8
[wxWidgets.git] / src / generic / logg.cpp
index 02e9c0275c9d857fbb2c29f605231c85bd4f485e..235e067769a58e04b624eaa762ce6664726827bd 100644 (file)
@@ -38,6 +38,7 @@
     #include "wx/sizer.h"
     #include "wx/statbmp.h"
     #include "wx/settings.h"
+    #include "wx/wxcrtvararg.h"
 #endif // WX_PRECOMP
 
 #if wxUSE_LOGGUI || wxUSE_LOGWINDOW
@@ -46,6 +47,7 @@
 #include "wx/textfile.h"
 #include "wx/statline.h"
 #include "wx/artprov.h"
+#include "wx/collpane.h"
 
 #ifdef  __WXMSW__
     // for OutputDebugString()
 
 // this function is a wrapper around strftime(3)
 // allows to exclude the usage of wxDateTime
-static wxString TimeStamp(const wxChar *format, time_t t)
+static wxString TimeStamp(const wxString& format, time_t t)
 {
+#if wxUSE_DATETIME
     wxChar buf[4096];
-    if ( !wxStrftime(buf, WXSIZEOF(buf), format, localtime(&t)) )
+    struct tm tm;
+    if ( !wxStrftime(buf, WXSIZEOF(buf), format, wxLocaltime_r(&t, &tm)) )
     {
         // buffer is too small?
         wxFAIL_MSG(_T("strftime() failed"));
     }
     return wxString(buf);
+#else // !wxUSE_DATETIME
+    return wxEmptyString;
+#endif // wxUSE_DATETIME/!wxUSE_DATETIME
 }
 
 
@@ -104,27 +111,36 @@ public:
 
     // event handlers
     void OnOk(wxCommandEvent& event);
-    void OnDetails(wxCommandEvent& event);
 #if wxUSE_FILE
     void OnSave(wxCommandEvent& event);
 #endif // wxUSE_FILE
     void OnListSelect(wxListEvent& event);
+    void OnListItemActivated(wxListEvent& event);
 
 private:
     // create controls needed for the details display
-    void CreateDetailsControls();
+    void CreateDetailsControls(wxWindow *);
+
+    // if necessary truncates the given string and adds an ellipsis
+    wxString EllipsizeString(const wxString &text)
+    {
+        if (ms_maxLength > 0 &&
+            text.length() > ms_maxLength)
+        {
+            wxString ret(text);
+            ret.Truncate(ms_maxLength);
+            ret << "...";
+            return ret;
+        }
+
+        return text;
+    }
 
     // the data for the listctrl
     wxArrayString m_messages;
     wxArrayInt m_severity;
     wxArrayLong m_times;
 
-    // the "toggle" button and its state
-#ifndef __SMARTPHONE__
-    wxButton *m_btnDetails;
-#endif
-    bool      m_showingDetails;
-
     // the controls which are not shown initially (but only when details
     // button is pressed)
     wxListCtrl *m_listctrl;
@@ -140,17 +156,20 @@ private:
     // the translated "Details" string
     static wxString ms_details;
 
+    // the maximum length of the log message
+    static size_t ms_maxLength;
+
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxLogDialog)
 };
 
 BEGIN_EVENT_TABLE(wxLogDialog, wxDialog)
     EVT_BUTTON(wxID_OK, wxLogDialog::OnOk)
-    EVT_BUTTON(wxID_MORE,   wxLogDialog::OnDetails)
 #if wxUSE_FILE
     EVT_BUTTON(wxID_SAVE,   wxLogDialog::OnSave)
 #endif // wxUSE_FILE
     EVT_LIST_ITEM_SELECTED(wxID_ANY, wxLogDialog::OnListSelect)
+    EVT_LIST_ITEM_ACTIVATED(wxID_ANY, wxLogDialog::OnListItemActivated)
 END_EVENT_TABLE()
 
 #endif // wxUSE_LOG_DIALOG
@@ -187,13 +206,13 @@ static wxFrame *gs_pFrame = NULL; // FIXME MT-unsafe
 
 // accepts an additional argument which tells to which frame the output should
 // be directed
-void wxVLogStatus(wxFrame *pFrame, const wxChar *szFormat, va_list argptr)
+void wxVLogStatus(wxFrame *pFrame, const wxString& format, va_list argptr)
 {
   wxString msg;
 
   wxLog *pLog = wxLog::GetActiveTarget();
   if ( pLog != NULL ) {
-    msg.PrintfV(szFormat, argptr);
+    msg.PrintfV(format, argptr);
 
     wxASSERT( gs_pFrame == NULL ); // should be reset!
     gs_pFrame = pFrame;
@@ -206,13 +225,25 @@ void wxVLogStatus(wxFrame *pFrame, const wxChar *szFormat, va_list argptr)
   }
 }
 
-void wxLogStatus(wxFrame *pFrame, const wxChar *szFormat, ...)
+#if !wxUSE_UTF8_LOCALE_ONLY
+void wxDoLogStatusWchar(wxFrame *pFrame, const wxChar *format, ...)
 {
     va_list argptr;
-    va_start(argptr, szFormat);
-    wxVLogStatus(pFrame, szFormat, argptr);
+    va_start(argptr, format);
+    wxVLogStatus(pFrame, format, argptr);
     va_end(argptr);
 }
+#endif // !wxUSE_UTF8_LOCALE_ONLY
+
+#if wxUSE_UNICODE_UTF8
+void wxDoLogStatusUtf8(wxFrame *pFrame, const char *format, ...)
+{
+    va_list argptr;
+    va_start(argptr, format);
+    wxVLogStatus(pFrame, format, argptr);
+    va_end(argptr);
+}
+#endif // wxUSE_UNICODE_UTF8
 
 // ----------------------------------------------------------------------------
 // wxLogGui implementation (FIXME MT-unsafe)
@@ -244,9 +275,9 @@ void wxLogGui::Flush()
     // do it right now to block any new calls to Flush() while we're here
     m_bHasMessages = false;
 
-    wxString appName = wxTheApp->GetAppName();
-    if ( !appName.empty() )
-        appName[0u] = (wxChar)wxToupper(appName[0u]);
+    const unsigned repeatCount = LogLastRepetitionCountIfNeeded();
+
+    wxString appName = wxTheApp->GetAppDisplayName();
 
     long style;
     wxString titleFormat;
@@ -266,7 +297,7 @@ void wxLogGui::Flush()
     wxString title;
     title.Printf(titleFormat, appName.c_str());
 
-    size_t nMsgCount = m_aMessages.Count();
+    size_t nMsgCount = m_aMessages.GetCount();
 
     // avoid showing other log dialogs until we're done with the dialog we're
     // showing right now: nested modal dialogs make for really bad UI!
@@ -281,6 +312,12 @@ void wxLogGui::Flush()
     {
 #if wxUSE_LOG_DIALOG
 
+        if ( repeatCount > 0 )
+        {
+            m_aMessages[nMsgCount - 1]
+                << " (" << m_aMessages[nMsgCount - 2] << ")";
+        }
+
         wxLogDialog dlg(NULL,
                         m_aMessages, m_aSeverity, m_aTimes,
                         title, style);
@@ -324,7 +361,7 @@ void wxLogGui::Flush()
 }
 
 // log all kinds of messages
-void wxLogGui::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLogGui::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     switch ( level ) {
         case wxLOG_Info:
@@ -368,7 +405,7 @@ void wxLogGui::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
                     // don't prepend debug/trace here: it goes to the
                     // debug window anyhow
                     str += wxT("\r\n");
-                    OutputDebugString(str);
+                    OutputDebugString(str.wx_str());
                 #else
                     // send them to stderr
                     wxFprintf(stderr, wxT("[%s] %s\n"),
@@ -430,7 +467,7 @@ class wxLogFrame : public wxFrame
 {
 public:
     // ctor & dtor
-    wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxChar *szTitle);
+    wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxString& szTitle);
     virtual ~wxLogFrame();
 
     // menu callbacks
@@ -474,7 +511,7 @@ BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
     EVT_CLOSE(wxLogFrame::OnCloseWindow)
 END_EVENT_TABLE()
 
-wxLogFrame::wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxChar *szTitle)
+wxLogFrame::wxLogFrame(wxWindow *pParent, wxLogWindow *log, const wxString& szTitle)
           : wxFrame(pParent, wxID_ANY, szTitle)
 {
     m_log = log;
@@ -562,7 +599,7 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
         wxLogError(_("Can't save log contents to file."));
     }
     else {
-        wxLogStatus(this, _("Log saved to the file '%s'."), filename.c_str());
+        wxLogStatus((wxFrame*)this, _("Log saved to the file '%s'."), filename.c_str());
     }
 #endif
 }
@@ -582,7 +619,7 @@ wxLogFrame::~wxLogFrame()
 // -----------
 
 wxLogWindow::wxLogWindow(wxWindow *pParent,
-                         const wxChar *szTitle,
+                         const wxString& szTitle,
                          bool bShow,
                          bool bDoPass)
 {
@@ -599,7 +636,7 @@ void wxLogWindow::Show(bool bShow)
     m_pLogFrame->Show(bShow);
 }
 
-void wxLogWindow::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
+void wxLogWindow::DoLog(wxLogLevel level, const wxString& szString, time_t t)
 {
     // first let the previous logger show it
     wxLogPassThrough::DoLog(level, szString, t);
@@ -609,11 +646,11 @@ void wxLogWindow::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
             case wxLOG_Status:
                 // by default, these messages are ignored by wxLog, so process
                 // them ourselves
-                if ( !wxIsEmpty(szString) )
+                if ( !szString.empty() )
                 {
                     wxString str;
                     str << _("Status: ") << szString;
-                    DoLogString(str, t);
+                    LogString(str, t);
                 }
                 break;
 
@@ -631,7 +668,7 @@ void wxLogWindow::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
     }
 }
 
-void wxLogWindow::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogWindow::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
     // put the text into our window
     wxTextCtrl *pText = m_pLogFrame->TextCtrl();
@@ -692,6 +729,7 @@ static const size_t MARGIN = 0;
 #endif
 
 wxString wxLogDialog::ms_details;
+size_t wxLogDialog::ms_maxLength = 0;
 
 wxLogDialog::wxLogDialog(wxWindow *parent,
                          const wxArrayString& messages,
@@ -703,6 +741,8 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
                       wxDefaultPosition, wxDefaultSize,
                       wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
 {
+    // init the static variables:
+
     if ( ms_details.empty() )
     {
         // ensure that we won't loop here if wxGetTranslation()
@@ -714,6 +754,11 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
 #endif
     }
 
+    if ( ms_maxLength == 0 )
+    {
+        ms_maxLength = (2 * wxGetDisplaySize().x/3) / GetCharWidth();
+    }
+
     size_t count = messages.GetCount();
     m_messages.Alloc(count);
     m_severity.Alloc(count);
@@ -721,14 +766,11 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
 
     for ( size_t n = 0; n < count; n++ )
     {
-        wxString msg = messages[n];
-        msg.Replace(wxT("\n"), wxT(" "));
-        m_messages.Add(msg);
+        m_messages.Add(messages[n]);
         m_severity.Add(severity[n]);
         m_times.Add(times[n]);
     }
 
-    m_showingDetails = false; // not initially
     m_listctrl = (wxListCtrl *)NULL;
 
 #ifndef __SMARTPHONE__
@@ -749,21 +791,8 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
     // sizers even though our window is not resizeable to calculate the size of
     // the dialog properly
     wxBoxSizer *sizerTop = new wxBoxSizer(wxVERTICAL);
-#ifndef __SMARTPHONE__
-    wxBoxSizer *sizerButtons = new wxBoxSizer(isPda ? wxHORIZONTAL : wxVERTICAL);
-#endif
     wxBoxSizer *sizerAll = new wxBoxSizer(isPda ? wxVERTICAL : wxHORIZONTAL);
 
-#ifdef __SMARTPHONE__
-    SetLeftMenu(wxID_OK);
-    SetRightMenu(wxID_MORE, ms_details + EXPAND_SUFFIX);
-#else
-    wxButton *btnOk = new wxButton(this, wxID_OK);
-    sizerButtons->Add(btnOk, 0, isPda ? wxCENTRE : wxCENTRE|wxBOTTOM, MARGIN/2);
-    m_btnDetails = new wxButton(this, wxID_MORE, ms_details + EXPAND_SUFFIX);
-    sizerButtons->Add(m_btnDetails, 0, isPda ? wxCENTRE|wxLEFT : wxCENTRE | wxTOP, MARGIN/2 - 1);
-#endif
-
     wxBitmap bitmap;
     switch ( style & wxICON_MASK )
     {
@@ -796,34 +825,45 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
         sizerAll->Add(new wxStaticBitmap(this, wxID_ANY, bitmap), 0,
                   wxALIGN_CENTRE_VERTICAL);
 
-    const wxString& message = messages.Last();
-    sizerAll->Add(CreateTextSizer(message), 1,
+    // create the text sizer with a minimal size so that we are sure it won't be too small
+    wxString message = EllipsizeString(messages.Last());
+    wxSizer *szText = CreateTextSizer(message);
+    szText->SetMinSize(wxMin(300, wxGetDisplaySize().x / 3), -1);
+
+    sizerAll->Add(szText, 1,
                   wxALIGN_CENTRE_VERTICAL | wxLEFT | wxRIGHT, MARGIN);
-#ifndef __SMARTPHONE__
-    sizerAll->Add(sizerButtons, 0, isPda ? wxCENTRE|wxTOP|wxBOTTOM : (wxALIGN_RIGHT | wxLEFT), MARGIN);
-#endif
+
+    wxButton *btnOk = new wxButton(this, wxID_OK);
+    sizerAll->Add(btnOk, 0, isPda ? wxCENTRE : wxCENTRE|wxBOTTOM, MARGIN/2);
 
     sizerTop->Add(sizerAll, 0, wxALL | wxEXPAND, MARGIN);
 
-    SetSizer(sizerTop);
 
-    // see comments in OnDetails()
-    //
-    // Note: Doing this, this way, triggered a nasty bug in
-    //       wxTopLevelWindowGTK::GtkOnSize which took -1 literally once
-    //       either of maxWidth or maxHeight was set.  This symptom has been
-    //       fixed there, but it is a problem that remains as long as we allow
-    //       unchecked access to the internal size members.  We really need to
-    //       encapuslate window sizes more cleanly and make it clear when -1 will
-    //       be substituted and when it will not.
-
-    wxSize size = sizerTop->Fit(this);
-    m_maxHeight = size.y;
-    SetSizeHints(size.x, size.y, m_maxWidth, m_maxHeight);
+    // add the details pane
 
 #ifndef __SMARTPHONE__
-    btnOk->SetFocus();
-#endif
+    wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, ms_details);
+    sizerTop->Add(collpane, 1, wxGROW|wxALL, MARGIN);
+
+    wxWindow *win = collpane->GetPane();
+    wxSizer *paneSz = new wxBoxSizer(wxVERTICAL);
+
+    CreateDetailsControls(win);
+
+    paneSz->Add(m_listctrl, 1, wxEXPAND | wxTOP, MARGIN);
+
+#if wxUSE_FILE && !defined(__SMARTPHONE__)
+    paneSz->Add(m_btnSave, 0, wxALIGN_RIGHT | wxTOP, MARGIN);
+#endif // wxUSE_FILE
+
+    win->SetSizer(paneSz);
+    paneSz->SetSizeHints(win);
+#else // __SMARTPHONE__
+    SetLeftMenu(wxID_OK);
+    SetRightMenu(wxID_MORE, ms_details + EXPAND_SUFFIX);
+#endif // __SMARTPHONE__/!__SMARTPHONE__
+
+    SetSizerAndFit(sizerTop);
 
     Centre();
 
@@ -835,29 +875,25 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
     }
 }
 
-void wxLogDialog::CreateDetailsControls()
+void wxLogDialog::CreateDetailsControls(wxWindow *parent)
 {
 #ifndef __SMARTPHONE__
     // create the save button and separator line if possible
 #if wxUSE_FILE
-    m_btnSave = new wxButton(this, wxID_SAVE);
+    m_btnSave = new wxButton(parent, wxID_SAVE);
 #endif // wxUSE_FILE
 
-#if wxUSE_STATLINE
-    m_statline = new wxStaticLine(this, wxID_ANY);
-#endif // wxUSE_STATLINE
-
 #endif // __SMARTPHONE__
 
     // create the list ctrl now
-    m_listctrl = new wxListCtrl(this, wxID_ANY,
+    m_listctrl = new wxListCtrl(parent, wxID_ANY,
                                 wxDefaultPosition, wxDefaultSize,
                                 wxSUNKEN_BORDER |
                                 wxLC_REPORT |
                                 wxLC_NO_HEADER |
                                 wxLC_SINGLE_SEL);
 #ifdef __WXWINCE__
-    // This maks a big aesthetic difference on WinCE but I
+    // This makes a big aesthetic difference on WinCE but I
     // don't want to risk problems on other platforms
     m_listctrl->Hide();
 #endif
@@ -934,7 +970,11 @@ void wxLogDialog::CreateDetailsControls()
             image = -1;
         }
 
-        m_listctrl->InsertItem(n, m_messages[n], image);
+        wxString msg = m_messages[n];
+        msg.Replace(wxT("\n"), wxT(" "));
+        msg = EllipsizeString(msg);
+
+        m_listctrl->InsertItem(n, msg, image);
         m_listctrl->SetItem(n, 1, TimeStamp(fmt, (time_t)m_times[n]));
     }
 
@@ -967,6 +1007,23 @@ void wxLogDialog::OnListSelect(wxListEvent& event)
     m_listctrl->SetItemState(event.GetIndex(), 0, wxLIST_STATE_SELECTED);
 }
 
+void wxLogDialog::OnListItemActivated(wxListEvent& event)
+{
+    // show the activated item in a message box
+    // This allow the user to correctly display the logs which are longer
+    // than the listctrl and thus gets truncated or those which contains
+    // newlines.
+
+    // NB: don't do:
+    //    wxString str = m_listctrl->GetItemText(event.GetIndex());
+    // as there's a 260 chars limit on the items inside a wxListCtrl in wxMSW.
+    wxString str = m_messages[event.GetIndex()];
+
+    // wxMessageBox will nicely handle the '\n' in the string (if any) 
+    // and supports long strings
+    wxMessageBox(str, wxT("Log message"), wxOK, this);
+}
+
 void wxLogDialog::OnOk(wxCommandEvent& WXUNUSED(event))
 {
     EndModal(wxID_OK);
@@ -1016,111 +1073,6 @@ void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
 
 #endif // wxUSE_FILE
 
-void wxLogDialog::OnDetails(wxCommandEvent& WXUNUSED(event))
-{
-    wxSizer *sizer = GetSizer();
-
-    if ( m_showingDetails )
-    {
-#ifdef __SMARTPHONE__
-        SetRightMenu(wxID_MORE, ms_details + EXPAND_SUFFIX);
-#else
-        m_btnDetails->SetLabel(ms_details + EXPAND_SUFFIX);
-#endif
-
-        sizer->Detach( m_listctrl );
-
-#ifndef __SMARTPHONE__
-
-#if wxUSE_STATLINE
-        sizer->Detach( m_statline );
-#endif // wxUSE_STATLINE
-
-#if wxUSE_FILE
-        sizer->Detach( m_btnSave );
-#endif // wxUSE_FILE
-
-#endif // __SMARTPHONE__
-    }
-    else // show details now
-    {
-#ifdef __SMARTPHONE__
-        SetRightMenu(wxID_MORE, wxString(_T("<< ")) + ms_details);
-#else
-        m_btnDetails->SetLabel(wxString(_T("<< ")) + ms_details);
-#endif
-
-        if ( !m_listctrl )
-        {
-            CreateDetailsControls();
-        }
-
-#if wxUSE_STATLINE && !defined(__SMARTPHONE__)
-        bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
-        if (!isPda)
-            sizer->Add(m_statline, 0, wxEXPAND | (wxALL & ~wxTOP), MARGIN);
-#endif // wxUSE_STATLINE
-
-        sizer->Add(m_listctrl, 1, wxEXPAND | (wxALL & ~wxTOP), MARGIN);
-
-        // VZ: this doesn't work as this becomes the initial (and not only
-        //     minimal) listctrl height as well - why?
-#if 0
-        // allow the user to make the dialog shorter than its initial height -
-        // without this it wouldn't work as the list ctrl would have been
-        // incompressible
-        sizer->SetItemMinSize(m_listctrl, 100, 3*GetCharHeight());
-#endif // 0
-
-#if wxUSE_FILE && !defined(__SMARTPHONE__)
-        sizer->Add(m_btnSave, 0, wxALIGN_RIGHT | (wxALL & ~wxTOP), MARGIN);
-#endif // wxUSE_FILE
-    }
-
-    m_showingDetails = !m_showingDetails;
-
-    // in any case, our size changed - relayout everything and set new hints
-    // ---------------------------------------------------------------------
-
-    // we have to reset min size constraints or Fit() would never reduce the
-    // dialog size when collapsing it and we have to reset max constraint
-    // because it wouldn't expand it otherwise
-
-    m_minHeight =
-    m_maxHeight = -1;
-
-    // wxSizer::FitSize() is private, otherwise we might use it directly...
-    wxSize sizeTotal = GetSize(),
-           sizeClient = GetClientSize();
-
-    wxSize size = sizer->GetMinSize();
-    size.x += sizeTotal.x - sizeClient.x;
-    size.y += sizeTotal.y - sizeClient.y;
-
-    // we don't want to allow expanding the dialog in vertical direction as
-    // this would show the "hidden" details but we can resize the dialog
-    // vertically while the details are shown
-    if ( !m_showingDetails )
-        m_maxHeight = size.y;
-
-    SetSizeHints(size.x, size.y, m_maxWidth, m_maxHeight);
-
-#ifdef __WXWINCE__
-    if (m_showingDetails)
-        m_listctrl->Show();
-#endif
-
-    // don't change the width when expanding/collapsing
-    SetSize(wxDefaultCoord, size.y);
-
-#ifdef __WXGTK__
-    // VS: this is necessary in order to force frame redraw under
-    // WindowMaker or fvwm2 (and probably other broken WMs).
-    // Otherwise, detailed list wouldn't be displayed.
-    Show();
-#endif // wxGTK
-}
-
 wxLogDialog::~wxLogDialog()
 {
     if ( m_listctrl )
@@ -1204,7 +1156,7 @@ wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
     m_pTextCtrl = pTextCtrl;
 }
 
-void wxLogTextCtrl::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+void wxLogTextCtrl::DoLogString(const wxString& szString, time_t WXUNUSED(t))
 {
     wxString msg;
     TimeStamp(&msg);