added new text event macros description

[wxWidgets.git] / src / generic / logg.cpp

diff --git a/src/generic/logg.cpp b/src/generic/logg.cpp
index 1790b09bf57e6b8a366b715782329bf68935d2d6..68555e35e6fe8def4ca6bad3357ad49265b7829f 100644 (file)
--- a/src/generic/logg.cpp
+++ b/src/generic/logg.cpp
@@ -46,6 +46,8 @@
     #include "wx/button.h"
 #endif // WX_PRECOMP
 
     #include "wx/button.h"
 #endif // WX_PRECOMP
 

+#if wxUSE_LOGGUI || wxUSE_LOGWINDOW
+

 #include "wx/file.h"
 #include "wx/textfile.h"
 #include "wx/statline.h"
 #include "wx/file.h"
 #include "wx/textfile.h"
 #include "wx/statline.h"


@@ -55,16 +57,11 @@
   #include  "wx/msw/private.h"
 #endif // Windows
 
   #include  "wx/msw/private.h"
 #endif // Windows
 

-// may be defined to 0 for old behavior (using wxMessageBox) - shouldn't be
-// changed normally (that's why it's here and not in setup.h)
-#define wxUSE_LOG_DIALOG 1
-

 #if wxUSE_LOG_DIALOG
 #if wxUSE_LOG_DIALOG

-    #include "wx/datetime.h"

     #include "wx/listctrl.h"
     #include "wx/imaglist.h"
     #include "wx/image.h"
     #include "wx/listctrl.h"
     #include "wx/imaglist.h"
     #include "wx/image.h"

-#else // !wxUSE_TEXTFILE
+#else // !wxUSE_LOG_DIALOG

     #include "wx/msgdlg.h"
 #endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
 
     #include "wx/msgdlg.h"
 #endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
 


@@ -74,6 +71,20 @@
 
 #if wxUSE_LOG_DIALOG
 
 
 #if wxUSE_LOG_DIALOG
 

+// this function is a wrapper around strftime(3)
+// allows to exclude the usage of wxDateTime
+static wxString TimeStamp(const wxChar *format, time_t t)
+{
+    wxChar buf[4096];
+    if ( !wxStrftime(buf, WXSIZEOF(buf), format, localtime(&t)) )
+    {
+        // buffer is too small?
+        wxFAIL_MSG(_T("strftime() failed"));
+    }
+    return wxString(buf);
+}
+
+

 class wxLogDialog : public wxDialog
 {
 public:
 class wxLogDialog : public wxDialog
 {
 public:


@@ -137,7 +148,7 @@ END_EVENT_TABLE()
 // private functions
 // ----------------------------------------------------------------------------
 
 // private functions
 // ----------------------------------------------------------------------------
 

-#if wxUSE_FILE
+#if wxUSE_FILE && wxUSE_FILEDLG

 
 // pass an uninitialized file object, the function will ask the user for the
 // filename and try to open it, returns TRUE on success (file was opened),
 
 // pass an uninitialized file object, the function will ask the user for the
 // filename and try to open it, returns TRUE on success (file was opened),


@@ -152,8 +163,8 @@ static int OpenLogFile(wxFile& file, wxString *filename = NULL);
 // ----------------------------------------------------------------------------
 
 // we use a global variable to store the frame pointer for wxLogStatus - bad,
 // ----------------------------------------------------------------------------
 
 // we use a global variable to store the frame pointer for wxLogStatus - bad,

-// but it's he easiest way
-static wxFrame *gs_pFrame; // FIXME MT-unsafe
+// but it's the easiest way
+static wxFrame *gs_pFrame = NULL; // FIXME MT-unsafe

 
 // ============================================================================
 // implementation
 
 // ============================================================================
 // implementation


@@ -183,24 +194,6 @@ void wxLogStatus(wxFrame *pFrame, const wxChar *szFormat, ...)
   }
 }
 
   }
 }
 

-// ----------------------------------------------------------------------------
-// wxLogTextCtrl implementation
-// ----------------------------------------------------------------------------
-
-wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
-{
-    m_pTextCtrl = pTextCtrl;
-}
-
-void wxLogTextCtrl::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
-{
-    wxString msg;
-    TimeStamp(&msg);
-    msg << szString << wxT('\n');
-
-    m_pTextCtrl->AppendText(msg);
-}
-

 // ----------------------------------------------------------------------------
 // wxLogGui implementation (FIXME MT-unsafe)
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxLogGui implementation (FIXME MT-unsafe)
 // ----------------------------------------------------------------------------


@@ -247,7 +240,7 @@ void wxLogGui::Flush()
         titleFormat = _("%s Information");
         style = wxICON_INFORMATION;
     }
         titleFormat = _("%s Information");
         style = wxICON_INFORMATION;
     }

-    
+

     wxString title;
     title.Printf(titleFormat, appName.c_str());
 
     wxString title;
     title.Printf(titleFormat, appName.c_str());
 


@@ -256,6 +249,10 @@ void wxLogGui::Flush()
 
     size_t nMsgCount = m_aMessages.Count();
 
 
     size_t nMsgCount = m_aMessages.Count();
 

+    // 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!
+    Suspend();
+

     wxString str;
     if ( nMsgCount == 1 )
     {
     wxString str;
     if ( nMsgCount == 1 )
     {


@@ -264,6 +261,7 @@ void wxLogGui::Flush()
     else // more than one message
     {
 #if wxUSE_LOG_DIALOG
     else // more than one message
     {
 #if wxUSE_LOG_DIALOG

+

         wxLogDialog dlg(parent,
                         m_aMessages, m_aSeverity, m_aTimes,
                         title, style);
         wxLogDialog dlg(parent,
                         m_aMessages, m_aSeverity, m_aTimes,
                         title, style);


@@ -301,6 +299,9 @@ void wxLogGui::Flush()
         // no undisplayed messages whatsoever
         Clear();
     }
         // no undisplayed messages whatsoever
         Clear();
     }

+
+    // allow flushing the logs again
+    Resume();

 }
 
 // log all kinds of messages
 }
 
 // log all kinds of messages


@@ -342,19 +343,21 @@ void wxLogGui::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
         case wxLOG_Debug:
             #ifdef __WXDEBUG__
             {
         case wxLOG_Debug:
             #ifdef __WXDEBUG__
             {

-                #ifdef __WXMSW__
+                wxString str;
+                TimeStamp(&str);
+                str += szString;
+
+                #if defined(__WXMSW__) && !defined(__WXMICROWIN__)

                     // don't prepend debug/trace here: it goes to the
                     // don't prepend debug/trace here: it goes to the

-                    // debug window anyhow, but do put a timestamp
-                    wxString str;
-                    TimeStamp(&str);
-                    str << szString << wxT("\n\r");
+                    // debug window anyhow
+                    str += wxT("\r\n");

                     OutputDebugString(str);
                 #else
                     // send them to stderr
                     OutputDebugString(str);
                 #else
                     // send them to stderr

-                    wxFprintf(stderr, wxT("%s: %s\n"),
+                    wxFprintf(stderr, wxT("[%s] %s\n"),

                               level == wxLOG_Trace ? wxT("Trace")
                                                    : wxT("Debug"),
                               level == wxLOG_Trace ? wxT("Trace")
                                                    : wxT("Debug"),

-                              szString);
+                              str.c_str());

                     fflush(stderr);
                 #endif
             }
                     fflush(stderr);
                 #endif
             }


@@ -462,6 +465,7 @@ wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const wxChar *szTitle
             wxHSCROLL       |
             wxTE_READONLY);
 
             wxHSCROLL       |
             wxTE_READONLY);
 

+#if wxUSE_MENUS

     // create menu
     wxMenuBar *pMenuBar = new wxMenuBar;
     wxMenu *pMenu = new wxMenu;
     // create menu
     wxMenuBar *pMenuBar = new wxMenuBar;
     wxMenu *pMenu = new wxMenu;


@@ -473,6 +477,7 @@ wxLogFrame::wxLogFrame(wxFrame *pParent, wxLogWindow *log, const wxChar *szTitle
     pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
     pMenuBar->Append(pMenu, _("&Log"));
     SetMenuBar(pMenuBar);
     pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
     pMenuBar->Append(pMenu, _("&Log"));
     SetMenuBar(pMenuBar);

+#endif // wxUSE_MENUS

 
 #if wxUSE_STATUSBAR
     // status bar for menu prompts
 
 #if wxUSE_STATUSBAR
     // status bar for menu prompts


@@ -505,6 +510,7 @@ void wxLogFrame::OnCloseWindow(wxCloseEvent& WXUNUSED(event))
 #if wxUSE_FILE
 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 {
 #if wxUSE_FILE
 void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
 {

+#if wxUSE_FILEDLG

     wxString filename;
     wxFile file;
     int rc = OpenLogFile(file, &filename);
     wxString filename;
     wxFile file;
     int rc = OpenLogFile(file, &filename);


@@ -533,6 +539,7 @@ void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
     else {
         wxLogStatus(this, _("Log saved to the file '%s'."), filename.c_str());
     }
     else {
         wxLogStatus(this, _("Log saved to the file '%s'."), filename.c_str());
     }

+#endif

 }
 #endif // wxUSE_FILE
 
 }
 #endif // wxUSE_FILE
 


@@ -548,15 +555,15 @@ wxLogFrame::~wxLogFrame()
 
 // wxLogWindow
 // -----------
 
 // wxLogWindow
 // -----------

+

 wxLogWindow::wxLogWindow(wxFrame *pParent,
                          const wxChar *szTitle,
                          bool bShow,
                          bool bDoPass)
 {
 wxLogWindow::wxLogWindow(wxFrame *pParent,
                          const wxChar *szTitle,
                          bool bShow,
                          bool bDoPass)
 {

-    m_bPassMessages = bDoPass;
+    PassMessages(bDoPass);

 
     m_pLogFrame = new wxLogFrame(pParent, this, szTitle);
 
     m_pLogFrame = new wxLogFrame(pParent, this, szTitle);

-    m_pOldLog = wxLog::SetActiveTarget(this);

 
     if ( bShow )
         m_pLogFrame->Show(TRUE);
 
     if ( bShow )
         m_pLogFrame->Show(TRUE);


@@ -567,21 +574,10 @@ void wxLogWindow::Show(bool bShow)
     m_pLogFrame->Show(bShow);
 }
 
     m_pLogFrame->Show(bShow);
 }
 

-void wxLogWindow::Flush()
-{
-    if ( m_pOldLog != NULL )
-        m_pOldLog->Flush();
-
-    m_bHasMessages = FALSE;
-}
-

 void wxLogWindow::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 {
     // first let the previous logger show it
 void wxLogWindow::DoLog(wxLogLevel level, const wxChar *szString, time_t t)
 {
     // first let the previous logger show it

-    if ( m_pOldLog != NULL && m_bPassMessages ) {
-        // bogus cast just to access protected DoLog
-        ((wxLogWindow *)m_pOldLog)->DoLog(level, szString, t);
-    }
+    wxLogPassThrough::DoLog(level, szString, t);

 
     if ( m_pLogFrame ) {
         switch ( level ) {
 
     if ( m_pLogFrame ) {
         switch ( level ) {


@@ -654,8 +650,6 @@ void wxLogWindow::OnFrameDelete(wxFrame * WXUNUSED(frame))
 
 wxLogWindow::~wxLogWindow()
 {
 
 wxLogWindow::~wxLogWindow()
 {

-    delete m_pOldLog;
-

     // may be NULL if log frame already auto destroyed itself
     delete m_pLogFrame;
 }
     // may be NULL if log frame already auto destroyed itself
     delete m_pLogFrame;
 }


@@ -676,7 +670,9 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
                          const wxArrayLong& times,
                          const wxString& caption,
                          long style)
                          const wxArrayLong& times,
                          const wxString& caption,
                          long style)

-           : wxDialog(parent, -1, caption)
+           : wxDialog(parent, -1, caption,
+                      wxDefaultPosition, wxDefaultSize,
+                      wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)

 {
     if ( ms_details.IsEmpty() )
     {
 {
     if ( ms_details.IsEmpty() )
     {


@@ -727,20 +723,21 @@ wxLogDialog::wxLogDialog(wxWindow *parent,
     // to close the log dialog with <Esc> which wouldn't work otherwise (as it
     // translates into click on cancel button)
     wxButton *btnOk = new wxButton(this, wxID_CANCEL, _("OK"));
     // to close the log dialog with <Esc> which wouldn't work otherwise (as it
     // translates into click on cancel button)
     wxButton *btnOk = new wxButton(this, wxID_CANCEL, _("OK"));

-    sizerButtons->Add(btnOk, 0, wxCENTRE|wxBOTTOM, MARGIN/2);
+    sizerButtons->Add(btnOk, 0, wxCENTRE | wxBOTTOM, MARGIN/2);

     m_btnDetails = new wxButton(this, wxID_MORE, ms_details + _T(" >>"));
     m_btnDetails = new wxButton(this, wxID_MORE, ms_details + _T(" >>"));

-    sizerButtons->Add(m_btnDetails, 0, wxCENTRE|wxTOP, MARGIN/2 - 1);
+    sizerButtons->Add(m_btnDetails, 0, wxCENTRE | wxTOP, MARGIN/2 - 1);

 
 #ifndef __WIN16__
     wxIcon icon = wxTheApp->GetStdIcon((int)(style & wxICON_MASK));
 
 #ifndef __WIN16__
     wxIcon icon = wxTheApp->GetStdIcon((int)(style & wxICON_MASK));

-    sizerAll->Add(new wxStaticBitmap(this, -1, icon), 0, wxCENTRE);
+    sizerAll->Add(new wxStaticBitmap(this, -1, icon), 0);

 #endif // !Win16
 
     const wxString& message = messages.Last();
 #endif // !Win16
 
     const wxString& message = messages.Last();

-    sizerAll->Add(CreateTextSizer(message), 0, wxCENTRE|wxLEFT|wxRIGHT, MARGIN);
-    sizerAll->Add(sizerButtons, 0, wxALIGN_RIGHT|wxLEFT, MARGIN);
+    sizerAll->Add(CreateTextSizer(message), 1,
+                  wxALIGN_CENTRE_VERTICAL | wxLEFT | wxRIGHT, MARGIN);
+    sizerAll->Add(sizerButtons, 0, wxALIGN_RIGHT | wxLEFT, MARGIN);

 
 

-    sizerTop->Add(sizerAll, 0, wxCENTRE|wxALL, MARGIN);
+    sizerTop->Add(sizerAll, 0, wxALL | wxEXPAND, MARGIN);

 
     SetAutoLayout(TRUE);
     SetSizer(sizerTop);
 
     SetAutoLayout(TRUE);
     SetSizer(sizerTop);


@@ -857,7 +854,7 @@ void wxLogDialog::CreateDetailsControls()
             m_listctrl->InsertItem(n, m_messages[n]);
 
         m_listctrl->SetItem(n, 1,
             m_listctrl->InsertItem(n, m_messages[n]);
 
         m_listctrl->SetItem(n, 1,

-                            wxDateTime((time_t)m_times[n]).Format(fmt));
+                            TimeStamp(fmt, (time_t)m_times[n]));

     }
 
     // let the columns size themselves
     }
 
     // let the columns size themselves


@@ -892,6 +889,7 @@ void wxLogDialog::OnOk(wxCommandEvent& WXUNUSED(event))
 
 void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
 {
 
 void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
 {

+#if wxUSE_FILEDLG

     wxFile file;
     int rc = OpenLogFile(file);
     if ( rc == -1 )
     wxFile file;
     int rc = OpenLogFile(file);
     if ( rc == -1 )


@@ -913,7 +911,7 @@ void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
     for ( size_t n = 0; ok && (n < count); n++ )
     {
         wxString line;
     for ( size_t n = 0; ok && (n < count); n++ )
     {
         wxString line;

-        line << wxDateTime((time_t)m_times[n]).Format(fmt)
+        line << TimeStamp(fmt, (time_t)m_times[n])

              << _T(": ")
              << m_messages[n]
              << wxTextFile::GetEOL();
              << _T(": ")
              << m_messages[n]
              << wxTextFile::GetEOL();


@@ -926,6 +924,7 @@ void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
 
     if ( !ok )
         wxLogError(_("Can't save log contents to file."));
 
     if ( !ok )
         wxLogError(_("Can't save log contents to file."));

+#endif

 }
 
 #endif // wxUSE_FILE
 }
 
 #endif // wxUSE_FILE


@@ -992,7 +991,7 @@ wxLogDialog::~wxLogDialog()
 
 #endif // wxUSE_LOG_DIALOG
 
 
 #endif // wxUSE_LOG_DIALOG
 

-#if wxUSE_FILE
+#if wxUSE_FILE && wxUSE_FILEDLG

 
 // pass an uninitialized file object, the function will ask the user for the
 // filename and try to open it, returns TRUE on success (file was opened),
 
 // pass an uninitialized file object, the function will ask the user for the
 // filename and try to open it, returns TRUE on success (file was opened),


@@ -1052,3 +1051,34 @@ static int OpenLogFile(wxFile& file, wxString *pFilename)
 
 #endif // wxUSE_FILE
 
 
 #endif // wxUSE_FILE
 

+#endif // !(wxUSE_LOGGUI || wxUSE_LOGWINDOW)
+
+#if wxUSE_TEXTCTRL
+
+// ----------------------------------------------------------------------------
+// wxLogTextCtrl implementation
+// ----------------------------------------------------------------------------
+
+wxLogTextCtrl::wxLogTextCtrl(wxTextCtrl *pTextCtrl)
+{
+    m_pTextCtrl = pTextCtrl;
+}
+
+void wxLogTextCtrl::DoLogString(const wxChar *szString, time_t WXUNUSED(t))
+{
+    wxString msg;
+    TimeStamp(&msg);
+
+#ifdef __WXMAC__
+    // VZ: this is a bug in wxMac, it *must* accept '\n' as new line, the
+    //     translation must be done in wxTextCtrl, not here! (FIXME)
+    msg << szString << wxT('\r');
+#else
+    msg << szString << wxT('\n');
+#endif
+
+    m_pTextCtrl->AppendText(msg);
+}
+
+#endif // wxUSE_TEXTCTRL
+