#if wxUSE_LOGGUI || wxUSE_LOGWINDOW
#include "wx/file.h"
+#include "wx/clipbrd.h"
+#include "wx/dataobj.h"
#include "wx/textfile.h"
#include "wx/statline.h"
#include "wx/artprov.h"
#include "wx/collpane.h"
+#include "wx/arrstr.h"
+
+#if wxUSE_THREADS
+ #include "wx/thread.h"
+#endif // wxUSE_THREADS
#ifdef __WXMSW__
// for OutputDebugString()
#include "wx/msw/private.h"
#endif // Windows
+
#ifdef __WXPM__
#include <time.h>
#endif
// the suffix we add to the button to show that the dialog can be expanded
#define EXPAND_SUFFIX _T(" >>")
+#define CAN_SAVE_FILES (wxUSE_FILE && wxUSE_FILEDLG)
+
// ----------------------------------------------------------------------------
// private classes
// ----------------------------------------------------------------------------
// event handlers
void OnOk(wxCommandEvent& event);
-#if wxUSE_FILE
+#if wxUSE_CLIPBOARD
+ void OnCopy(wxCommandEvent& event);
+#endif // wxUSE_CLIPBOARD
+#if CAN_SAVE_FILES
void OnSave(wxCommandEvent& event);
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
void OnListSelect(wxListEvent& event);
void OnListItemActivated(wxListEvent& event);
return text;
}
+#if CAN_SAVE_FILES || wxUSE_CLIPBOARD
+ // return the contents of the dialog as a multiline string
+ wxString GetLogMessages() const;
+#endif // CAN_SAVE_FILES || wxUSE_CLIPBOARD
+
+
// the data for the listctrl
wxArrayString m_messages;
wxArrayInt m_severity;
// the controls which are not shown initially (but only when details
// button is pressed)
wxListCtrl *m_listctrl;
-#ifndef __SMARTPHONE__
-#if wxUSE_STATLINE
- wxStaticLine *m_statline;
-#endif // wxUSE_STATLINE
-#if wxUSE_FILE
- wxButton *m_btnSave;
-#endif // wxUSE_FILE
-#endif // __SMARTPHONE__
// the translated "Details" string
static wxString ms_details;
BEGIN_EVENT_TABLE(wxLogDialog, wxDialog)
EVT_BUTTON(wxID_OK, wxLogDialog::OnOk)
-#if wxUSE_FILE
+#if wxUSE_CLIPBOARD
+ EVT_BUTTON(wxID_COPY, wxLogDialog::OnCopy)
+#endif // wxUSE_CLIPBOARD
+#if CAN_SAVE_FILES
EVT_BUTTON(wxID_SAVE, wxLogDialog::OnSave)
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
EVT_LIST_ITEM_SELECTED(wxID_ANY, wxLogDialog::OnListSelect)
EVT_LIST_ITEM_ACTIVATED(wxID_ANY, wxLogDialog::OnListItemActivated)
END_EVENT_TABLE()
// private functions
// ----------------------------------------------------------------------------
-#if wxUSE_FILE && wxUSE_FILEDLG
+#if CAN_SAVE_FILES
// 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),
// dialog was cancelled
static int OpenLogFile(wxFile& file, wxString *filename = NULL, wxWindow *parent = NULL);
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
// ----------------------------------------------------------------------------
// global variables
m_aTimes.Empty();
}
+int wxLogGui::GetSeverityIcon() const
+{
+ return m_bErrors ? wxICON_STOP
+ : m_bWarnings ? wxICON_EXCLAMATION
+ : wxICON_INFORMATION;
+}
+
+wxString wxLogGui::GetTitle() const
+{
+ wxString titleFormat;
+ switch ( GetSeverityIcon() )
+ {
+ case wxICON_STOP:
+ titleFormat = _("%s Error");
+ break;
+
+ case wxICON_EXCLAMATION:
+ titleFormat = _("%s Warning");
+ break;
+
+ default:
+ wxFAIL_MSG( "unexpected icon severity" );
+ // fall through
+
+ case wxICON_INFORMATION:
+ titleFormat = _("%s Information");
+ }
+
+ return wxString::Format(titleFormat, wxTheApp->GetAppDisplayName());
+}
+
+void
+wxLogGui::DoShowSingleLogMessage(const wxString& message,
+ const wxString& title,
+ int style)
+{
+ wxMessageBox(message, title, wxOK | style);
+}
+
+void
+wxLogGui::DoShowMultipleLogMessages(const wxArrayString& messages,
+ const wxArrayInt& severities,
+ const wxArrayLong& times,
+ const wxString& title,
+ int style)
+{
+#if wxUSE_LOG_DIALOG
+ wxLogDialog dlg(NULL,
+ messages, severities, times,
+ title, style);
+
+ // clear the message list before showing the dialog because while it's
+ // shown some new messages may appear
+ Clear();
+
+ (void)dlg.ShowModal();
+#else // !wxUSE_LOG_DIALOG
+ // start from the most recent message
+ wxString message;
+ str.reserve(nMsgCount*100);
+ for ( size_t n = nMsgCount; n > 0; n-- ) {
+ message << m_aMessages[n - 1] << wxT("\n");
+ }
+
+ DoShowSingleLogMessage(message, title, style);
+#endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
+}
+
void wxLogGui::Flush()
{
if ( !m_bHasMessages )
// do it right now to block any new calls to Flush() while we're here
m_bHasMessages = false;
- const unsigned repeatCount = LogLastRepetitionCountIfNeeded();
+ // note that this must be done before examining m_aMessages as it may log
+ // yet another message
+ const unsigned repeatCount = LogLastRepeatIfNeeded();
- wxString appName = wxTheApp->GetAppDisplayName();
+ const size_t nMsgCount = m_aMessages.size();
- long style;
- wxString titleFormat;
- if ( m_bErrors ) {
- titleFormat = _("%s Error");
- style = wxICON_STOP;
- }
- else if ( m_bWarnings ) {
- titleFormat = _("%s Warning");
- style = wxICON_EXCLAMATION;
- }
- else {
- titleFormat = _("%s Information");
- style = wxICON_INFORMATION;
+ if ( repeatCount > 0 )
+ {
+ m_aMessages[nMsgCount - 1] << " (" << m_aMessages[nMsgCount - 2] << ")";
}
- wxString title;
- title.Printf(titleFormat, appName.c_str());
-
- size_t nMsgCount = m_aMessages.GetCount();
+ const wxString title = GetTitle();
+ const int style = GetSeverityIcon();
// 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 )
{
- str = m_aMessages[0];
+ // make a copy before calling Clear()
+ const wxString message(m_aMessages[0]);
+ Clear();
+
+ DoShowSingleLogMessage(message, title, style);
}
else // more than one message
{
-#if wxUSE_LOG_DIALOG
-
- if ( repeatCount > 0 )
- {
- m_aMessages[nMsgCount - 1]
- << " (" << m_aMessages[nMsgCount - 2] << ")";
- }
+ wxArrayString messages;
+ wxArrayInt severities;
+ wxArrayLong times;
- wxLogDialog dlg(NULL,
- m_aMessages, m_aSeverity, m_aTimes,
- title, style);
+ messages.swap(m_aMessages);
+ severities.swap(m_aSeverity);
+ times.swap(m_aTimes);
- // clear the message list before showing the dialog because while it's
- // shown some new messages may appear
Clear();
- (void)dlg.ShowModal();
-#else // !wxUSE_LOG_DIALOG
- // concatenate all strings (but not too many to not overfill the msg box)
- size_t nLines = 0;
-
- // start from the most recent message
- for ( size_t n = nMsgCount; n > 0; n-- ) {
- // for Windows strings longer than this value are wrapped (NT 4.0)
- const size_t nMsgLineWidth = 156;
-
- nLines += (m_aMessages[n - 1].Len() + nMsgLineWidth - 1) / nMsgLineWidth;
-
- if ( nLines > 25 ) // don't put too many lines in message box
- break;
-
- str << m_aMessages[n - 1] << wxT("\n");
- }
-#endif // wxUSE_LOG_DIALOG/!wxUSE_LOG_DIALOG
- }
-
- // this catches both cases of 1 message with wxUSE_LOG_DIALOG and any
- // situation without it
- if ( !str.empty() )
- {
- wxMessageBox(str, title, wxOK | style);
-
- // no undisplayed messages whatsoever
- Clear();
+ DoShowMultipleLogMessages(messages, severities, times, title, style);
}
// allow flushing the logs again
// menu callbacks
void OnClose(wxCommandEvent& event);
void OnCloseWindow(wxCloseEvent& event);
-#if wxUSE_FILE
- void OnSave (wxCommandEvent& event);
-#endif // wxUSE_FILE
+#if CAN_SAVE_FILES
+ void OnSave(wxCommandEvent& event);
+#endif // CAN_SAVE_FILES
void OnClear(wxCommandEvent& event);
- // accessors
- wxTextCtrl *TextCtrl() const { return m_pTextCtrl; }
+ // this function is safe to call from any thread (notice that it should be
+ // also called from the main thread to ensure that the messages logged from
+ // it appear in correct order with the messages from the other threads)
+ void AddLogMessage(const wxString& message);
+
+ // actually append the messages logged from secondary threads to the text
+ // control during idle time in the main thread
+ virtual void OnInternalIdle();
private:
// use standard ids for our commands!
// common part of OnClose() and OnCloseWindow()
void DoClose();
+ // do show the message in the text control
+ void DoShowLogMessage(const wxString& message)
+ {
+ m_pTextCtrl->AppendText(message);
+ }
+
wxTextCtrl *m_pTextCtrl;
wxLogWindow *m_log;
+ // queue of messages logged from other threads which need to be displayed
+ wxArrayString m_pendingMessages;
+
+#if wxUSE_THREADS
+ // critical section to protect access to m_pendingMessages
+ wxCriticalSection m_critSection;
+#endif // wxUSE_THREADS
+
+
DECLARE_EVENT_TABLE()
DECLARE_NO_COPY_CLASS(wxLogFrame)
};
BEGIN_EVENT_TABLE(wxLogFrame, wxFrame)
// wxLogWindow menu events
EVT_MENU(Menu_Close, wxLogFrame::OnClose)
-#if wxUSE_FILE
+#if CAN_SAVE_FILES
EVT_MENU(Menu_Save, wxLogFrame::OnSave)
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
EVT_MENU(Menu_Clear, wxLogFrame::OnClear)
EVT_CLOSE(wxLogFrame::OnCloseWindow)
// create menu
wxMenuBar *pMenuBar = new wxMenuBar;
wxMenu *pMenu = new wxMenu;
-#if wxUSE_FILE
+#if CAN_SAVE_FILES
pMenu->Append(Menu_Save, _("&Save..."), _("Save log contents to file"));
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
pMenu->Append(Menu_Clear, _("C&lear"), _("Clear the log contents"));
pMenu->AppendSeparator();
pMenu->Append(Menu_Close, _("&Close"), _("Close this window"));
DoClose();
}
-#if wxUSE_FILE
+#if CAN_SAVE_FILES
void wxLogFrame::OnSave(wxCommandEvent& WXUNUSED(event))
{
-#if wxUSE_FILEDLG
wxString filename;
wxFile file;
int rc = OpenLogFile(file, &filename, this);
else {
wxLogStatus((wxFrame*)this, _("Log saved to the file '%s'."), filename.c_str());
}
-#endif
}
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
void wxLogFrame::OnClear(wxCommandEvent& WXUNUSED(event))
{
m_pTextCtrl->Clear();
}
+void wxLogFrame::OnInternalIdle()
+{
+ {
+ wxCRIT_SECT_LOCKER(locker, m_critSection);
+
+ const size_t count = m_pendingMessages.size();
+ for ( size_t n = 0; n < count; n++ )
+ {
+ DoShowLogMessage(m_pendingMessages[n]);
+ }
+
+ m_pendingMessages.clear();
+ } // release m_critSection
+
+ wxFrame::OnInternalIdle();
+}
+
+void wxLogFrame::AddLogMessage(const wxString& message)
+{
+ wxCRIT_SECT_LOCKER(locker, m_critSection);
+
+#if wxUSE_THREADS
+ if ( !wxThread::IsMain() || !m_pendingMessages.empty() )
+ {
+ // message needs to be queued for later showing
+ m_pendingMessages.Add(message);
+
+ wxWakeUpIdle();
+ }
+ else // we are the main thread and no messages are queued, so we can
+ // log the message directly
+#endif // wxUSE_THREADS
+ {
+ DoShowLogMessage(message);
+ }
+}
+
wxLogFrame::~wxLogFrame()
{
m_log->OnFrameDelete(this);
void wxLogWindow::DoLogString(const wxString& szString, time_t WXUNUSED(t))
{
- // put the text into our window
- wxTextCtrl *pText = m_pLogFrame->TextCtrl();
-
- // remove selection (WriteText is in fact ReplaceSelection)
-#ifdef __WXMSW__
- wxTextPos nLen = pText->GetLastPosition();
- pText->SetSelection(nLen, nLen);
-#endif // Windows
-
wxString msg;
+
TimeStamp(&msg);
msg << szString << wxT('\n');
- pText->AppendText(msg);
-
- // TODO ensure that the line can be seen
+ m_pLogFrame->AddLogMessage(msg);
}
wxFrame *wxLogWindow::GetFrame() const
#if wxUSE_LOG_DIALOG
-#ifndef __SMARTPHONE__
-static const size_t MARGIN = 10;
-#else
-static const size_t MARGIN = 0;
-#endif
-
wxString wxLogDialog::ms_details;
size_t wxLogDialog::ms_maxLength = 0;
m_times.Add(times[n]);
}
- m_listctrl = (wxListCtrl *)NULL;
-
-#ifndef __SMARTPHONE__
-
-#if wxUSE_STATLINE
- m_statline = (wxStaticLine *)NULL;
-#endif // wxUSE_STATLINE
-
-#if wxUSE_FILE
- m_btnSave = (wxButton *)NULL;
-#endif // wxUSE_FILE
-
-#endif // __SMARTPHONE__
+ m_listctrl = NULL;
bool isPda = (wxSystemSettings::GetScreenType() <= wxSYS_SCREEN_PDA);
wxID_ANY,
wxArtProvider::GetMessageBoxIcon(style)
);
- sizerAll->Add(icon, 0, wxALIGN_CENTRE_VERTICAL);
+ sizerAll->Add(icon, wxSizerFlags().Centre());
}
// create the text sizer with a minimal size so that we are sure it won't be too small
wxSizer *szText = CreateTextSizer(message);
szText->SetMinSize(wxMin(300, wxGetDisplaySize().x / 3), -1);
- sizerAll->Add(szText, 1,
- wxALIGN_CENTRE_VERTICAL | wxLEFT | wxRIGHT, MARGIN);
+ sizerAll->Add(szText, wxSizerFlags(1).Centre().Border(wxLEFT | wxRIGHT));
wxButton *btnOk = new wxButton(this, wxID_OK);
- sizerAll->Add(btnOk, 0, isPda ? wxCENTRE : wxCENTRE|wxBOTTOM, MARGIN/2);
+ sizerAll->Add(btnOk, wxSizerFlags().Centre());
- sizerTop->Add(sizerAll, 0, wxALL | wxEXPAND, MARGIN);
+ sizerTop->Add(sizerAll, wxSizerFlags().Expand().Border());
// add the details pane
-
#ifndef __SMARTPHONE__
- wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, ms_details);
- sizerTop->Add(collpane, 1, wxGROW|wxALL, MARGIN);
+ wxCollapsiblePane * const
+ collpane = new wxCollapsiblePane(this, wxID_ANY, ms_details);
+ sizerTop->Add(collpane, wxSizerFlags(1).Expand().Border());
wxWindow *win = collpane->GetPane();
- wxSizer *paneSz = new wxBoxSizer(wxVERTICAL);
+ wxSizer * const paneSz = new wxBoxSizer(wxVERTICAL);
CreateDetailsControls(win);
- paneSz->Add(m_listctrl, 1, wxEXPAND | wxTOP, MARGIN);
+ paneSz->Add(m_listctrl, wxSizerFlags(1).Expand().Border(wxTOP));
+
+#if wxUSE_CLIPBOARD || CAN_SAVE_FILES
+ wxBoxSizer * const btnSizer = new wxBoxSizer(wxHORIZONTAL);
+
+ wxSizerFlags flagsBtn;
+ flagsBtn.Border(wxLEFT);
-#if wxUSE_FILE && !defined(__SMARTPHONE__)
- paneSz->Add(m_btnSave, 0, wxALIGN_RIGHT | wxTOP, MARGIN);
-#endif // wxUSE_FILE
+#if wxUSE_CLIPBOARD
+ btnSizer->Add(new wxButton(win, wxID_COPY), flagsBtn);
+#endif // wxUSE_CLIPBOARD
+
+#if CAN_SAVE_FILES
+ btnSizer->Add(new wxButton(win, wxID_SAVE), flagsBtn);
+#endif // CAN_SAVE_FILES
+
+ paneSz->Add(btnSizer, wxSizerFlags().Right().Border(wxTOP));
+#endif // wxUSE_CLIPBOARD || CAN_SAVE_FILES
win->SetSizer(paneSz);
paneSz->SetSizeHints(win);
void wxLogDialog::CreateDetailsControls(wxWindow *parent)
{
-#ifndef __SMARTPHONE__
- // create the save button and separator line if possible
-#if wxUSE_FILE
- m_btnSave = new wxButton(parent, wxID_SAVE);
-#endif // wxUSE_FILE
-
-#endif // __SMARTPHONE__
-
// create the list ctrl now
m_listctrl = new wxListCtrl(parent, wxID_ANY,
wxDefaultPosition, wxDefaultSize,
// 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)
+ // wxMessageBox will nicely handle the '\n' in the string (if any)
// and supports long strings
wxMessageBox(str, wxT("Log message"), wxOK, this);
}
EndModal(wxID_OK);
}
-#if wxUSE_FILE
+#if CAN_SAVE_FILES || wxUSE_CLIPBOARD
-void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
+wxString wxLogDialog::GetLogMessages() const
{
-#if wxUSE_FILEDLG
- wxFile file;
- int rc = OpenLogFile(file, NULL, this);
- if ( rc == -1 )
- {
- // cancelled
- return;
- }
-
- bool ok = rc != 0;
-
wxString fmt = wxLog::GetTimestamp();
- if ( !fmt )
+ if ( fmt.empty() )
{
- // default format
- fmt = _T("%c");
+ // use the default format
+ fmt = "%c";
}
- size_t count = m_messages.GetCount();
- for ( size_t n = 0; ok && (n < count); n++ )
+ const size_t count = m_messages.GetCount();
+
+ wxString text;
+ text.reserve(count*m_messages[0].length());
+ for ( size_t n = 0; n < count; n++ )
{
- wxString line;
- line << TimeStamp(fmt, (time_t)m_times[n])
- << _T(": ")
+ text << TimeStamp(fmt, (time_t)m_times[n])
+ << ": "
<< m_messages[n]
<< wxTextFile::GetEOL();
+ }
- ok = file.Write(line);
+ return text;
+}
+
+#endif // CAN_SAVE_FILES || wxUSE_CLIPBOARD
+
+#if wxUSE_CLIPBOARD
+
+void wxLogDialog::OnCopy(wxCommandEvent& WXUNUSED(event))
+{
+ wxClipboardLocker clip;
+ if ( !clip ||
+ !wxTheClipboard->AddData(new wxTextDataObject(GetLogMessages())) )
+ {
+ wxLogError(_("Failed to copy dialog contents to the clipboard."));
}
+}
+
+#endif // wxUSE_CLIPBOARD
+
+#if CAN_SAVE_FILES
- if ( ok )
- ok = file.Close();
+void wxLogDialog::OnSave(wxCommandEvent& WXUNUSED(event))
+{
+ wxFile file;
+ int rc = OpenLogFile(file, NULL, this);
+ if ( rc == -1 )
+ {
+ // cancelled
+ return;
+ }
- if ( !ok )
+ if ( !rc || !file.Write(GetLogMessages()) || !file.Close() )
wxLogError(_("Can't save log contents to file."));
-#endif // wxUSE_FILEDLG
}
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
wxLogDialog::~wxLogDialog()
{
#endif // wxUSE_LOG_DIALOG
-#if wxUSE_FILE && wxUSE_FILEDLG
+#if CAN_SAVE_FILES
// 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),
// open file
// ---------
- bool bOk wxDUMMY_INITIALIZE(false);
+ bool bOk = false;
if ( wxFile::Exists(filename) ) {
bool bAppend = false;
wxString strMsg;
return bOk;
}
-#endif // wxUSE_FILE
+#endif // CAN_SAVE_FILES
#endif // !(wxUSE_LOGGUI || wxUSE_LOGWINDOW)
projects / wxWidgets.git / blobdiff