trunk/src/qsamplerMessages.cpp

// qsamplerMessages.cpp
//
/****************************************************************************
   Copyright (C) 2004-2014, rncbc aka Rui Nuno Capela. All rights reserved.
   Copyright (C) 2007, Christian Schoenebeck

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; either version 2
   of the License, or (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License along
   with this program; if not, write to the Free Software Foundation, Inc.,
   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

*****************************************************************************/

#include "qsamplerAbout.h"
#include "qsamplerMessages.h"

#include <QSocketNotifier>

#include <QFile>
#include <QTextEdit>
#include <QTextCursor>
#include <QTextStream>
#include <QTextBlock>
#include <QScrollBar>
#include <QDateTime>
#include <QIcon>

#if !defined(WIN32)
#include <unistd.h>
#include <fcntl.h>
#endif


namespace QSampler {

// The default maximum number of message lines.
#define QSAMPLER_MESSAGES_MAXLINES  1000

// Notification pipe descriptors
#define QSAMPLER_MESSAGES_FDNIL    -1
#define QSAMPLER_MESSAGES_FDREAD    0
#define QSAMPLER_MESSAGES_FDWRITE   1


//-------------------------------------------------------------------------
// QSampler::Messages - Messages log dockable window.
//

// Constructor.
Messages::Messages ( QWidget *pParent )
        : QDockWidget(pParent)
{
        // Surely a name is crucial (e.g.for storing geometry settings)
        QDockWidget::setObjectName("qsamplerMessages");

        // Intialize stdout capture stuff.
        m_pStdoutNotifier = NULL;
        m_fdStdout[QSAMPLER_MESSAGES_FDREAD]  = QSAMPLER_MESSAGES_FDNIL;
        m_fdStdout[QSAMPLER_MESSAGES_FDWRITE] = QSAMPLER_MESSAGES_FDNIL;

        // Create local text view widget.
        m_pMessagesTextView = new QTextEdit(this);
//  QFont font(m_pMessagesTextView->font());
//  font.setFamily("Fixed");
//  m_pMessagesTextView->setFont(font);
        m_pMessagesTextView->setLineWrapMode(QTextEdit::NoWrap);
        m_pMessagesTextView->setReadOnly(true);
        m_pMessagesTextView->setUndoRedoEnabled(false);
//      m_pMessagesTextView->setTextFormat(Qt::LogText);

        // Initialize default message limit.
        m_iMessagesLines = 0;
        setMessagesLimit(QSAMPLER_MESSAGES_MAXLINES);

        m_pMessagesLog = NULL;

        // Prepare the dockable window stuff.
        QDockWidget::setWidget(m_pMessagesTextView);
        QDockWidget::setFeatures(QDockWidget::AllDockWidgetFeatures);
        QDockWidget::setAllowedAreas(
                Qt::TopDockWidgetArea | Qt::BottomDockWidgetArea);
        // Some specialties to this kind of dock window...
        QDockWidget::setMinimumHeight(120);

        // Finally set the default caption and tooltip.
        const QString& sCaption = tr("Messages");
        QDockWidget::setWindowTitle(sCaption);
//      QDockWidget::setWindowIcon(QIcon(":/icons/qsamplerMessages.png"));
        QDockWidget::setToolTip(sCaption);
}


// Destructor.
Messages::~Messages (void)
{
        // Turn off and close logging.
        setLogging(false);

        // No more notifications.
        if (m_pStdoutNotifier)
                delete m_pStdoutNotifier;

        // No need to delete child widgets, Qt does it all for us.
}


// Own stdout/stderr socket notifier slot.
void Messages::stdoutNotify ( int fd )
{
#if !defined(WIN32)
        // Set non-blocking reads, if not already...
        const int iFlags = ::fcntl(fd, F_GETFL, 0);
        int iBlock = ((iFlags & O_NONBLOCK) == 0);
        if (iBlock)
                iBlock = ::fcntl(fd, F_SETFL, iFlags | O_NONBLOCK);
        // Read as much as is available...
        QString sTemp;
        char achBuffer[1024];
        const int cchBuffer = sizeof(achBuffer) - 1;
        int cchRead = ::read(fd, achBuffer, cchBuffer);
        while (cchRead > 0) {
                achBuffer[cchRead] = (char) 0;
                sTemp.append(achBuffer);
                cchRead = (iBlock ? 0 : ::read(fd, achBuffer, cchBuffer));
        }
        // Needs to be non-empty...
        if (!sTemp.isEmpty())
                appendStdoutBuffer(sTemp);
#endif
}


// Stdout buffer handler -- now splitted by complete new-lines...
void Messages::appendStdoutBuffer ( const QString& s )
{
        m_sStdoutBuffer.append(s);

        const int iLength = m_sStdoutBuffer.lastIndexOf('\n');
        if (iLength > 0) {
                const QString& sTemp = m_sStdoutBuffer.left(iLength);
                m_sStdoutBuffer.remove(0, iLength + 1);
                QStringList list = sTemp.split('\n');
                QStringListIterator iter(list);
                while (iter.hasNext())
                        appendMessagesText(iter.next());
        }
}


// Stdout flusher -- show up any unfinished line...
void Messages::flushStdoutBuffer (void)
{
        if (!m_sStdoutBuffer.isEmpty()) {
                appendMessagesText(m_sStdoutBuffer);
                m_sStdoutBuffer.clear();
        }
}


// Stdout capture accessors.
bool Messages::isCaptureEnabled (void)
{
        return (m_pStdoutNotifier != NULL);
}

void Messages::setCaptureEnabled ( bool bCapture )
{
        // Flush current buffer.
        flushStdoutBuffer();

#if !defined(WIN32)
        // Destroy if already enabled.
        if (!bCapture && m_pStdoutNotifier) {
                delete m_pStdoutNotifier;
                m_pStdoutNotifier = NULL;
                // Close the notification pipes.
                if (m_fdStdout[QSAMPLER_MESSAGES_FDREAD] != QSAMPLER_MESSAGES_FDNIL) {
                        ::close(m_fdStdout[QSAMPLER_MESSAGES_FDREAD]);
                        m_fdStdout[QSAMPLER_MESSAGES_FDREAD]  = QSAMPLER_MESSAGES_FDNIL;
                }
        }
        // Are we going to make up the capture?
        if (bCapture && m_pStdoutNotifier == NULL && ::pipe(m_fdStdout) == 0) {
                ::dup2(m_fdStdout[QSAMPLER_MESSAGES_FDWRITE], STDOUT_FILENO);
                ::dup2(m_fdStdout[QSAMPLER_MESSAGES_FDWRITE], STDERR_FILENO);
                m_pStdoutNotifier = new QSocketNotifier(
                        m_fdStdout[QSAMPLER_MESSAGES_FDREAD], QSocketNotifier::Read, this);
                QObject::connect(m_pStdoutNotifier,
                        SIGNAL(activated(int)),
                        SLOT(stdoutNotify(int)));
        }
#endif
}


// Message font accessors.
QFont Messages::messagesFont (void)
{
        return m_pMessagesTextView->font();
}

void Messages::setMessagesFont ( const QFont& font )
{
        m_pMessagesTextView->setFont(font);
}


// Maximum number of message lines accessors.
int Messages::messagesLimit (void)
{
        return m_iMessagesLimit;
}

void Messages::setMessagesLimit ( int iMessagesLimit )
{
        m_iMessagesLimit = iMessagesLimit;
        m_iMessagesHigh  = iMessagesLimit + (iMessagesLimit / 3);
}

// Messages logging stuff.
bool Messages::isLogging (void) const
{
        return (m_pMessagesLog != NULL);
}

void Messages::setLogging ( bool bEnabled, const QString& sFilename )
{
        if (m_pMessagesLog) {
                appendMessages(tr("Logging stopped --- %1 ---")
                        .arg(QDateTime::currentDateTime().toString()));
                m_pMessagesLog->close();
                delete m_pMessagesLog;
                m_pMessagesLog = NULL;
        }

        if (bEnabled) {
                m_pMessagesLog = new QFile(sFilename);
                if (m_pMessagesLog->open(QIODevice::Text | QIODevice::Append)) {
                        appendMessages(tr("Logging started --- %1 ---")
                                .arg(QDateTime::currentDateTime().toString()));
                } else {
                        delete m_pMessagesLog;
                        m_pMessagesLog = NULL;
                }
        }
}


// Messages log output method.
void Messages::appendMessagesLog ( const QString& s )
{
        if (m_pMessagesLog) {
                QTextStream(m_pMessagesLog) << s << endl;
                m_pMessagesLog->flush();
        }
}

// Messages widget output method.
void Messages::appendMessagesLine ( const QString& s )
{
        // Check for message line limit...
        if (m_iMessagesLines > m_iMessagesHigh) {
                m_pMessagesTextView->setUpdatesEnabled(false);
                QTextCursor textCursor(m_pMessagesTextView->document()->begin());
                while (m_iMessagesLines > m_iMessagesLimit) {
                        // Move cursor extending selection
                        // from start to next line-block...
                        textCursor.movePosition(
                                QTextCursor::NextBlock, QTextCursor::KeepAnchor);
                        m_iMessagesLines--;
                }
                // Remove the excessive line-blocks...
                textCursor.removeSelectedText();
                m_pMessagesTextView->setUpdatesEnabled(true);
        }

        m_pMessagesTextView->append(s);
        m_iMessagesLines++;
}


// The main utility methods.
void Messages::appendMessages ( const QString& s )
{
        appendMessagesColor(s, "#999999");
}

void Messages::appendMessagesColor ( const QString& s, const QString &c )
{
        const QString& sText
                = QTime::currentTime().toString("hh:mm:ss.zzz") + ' ' + s;
        appendMessagesLine("<font color=\"" + c + "\">" + sText + "</font>");
        appendMessagesLog(sText);
}

void Messages::appendMessagesText ( const QString& s )
{
        appendMessagesLine(s);
        appendMessagesLog(s);
}


// History reset.
void Messages::clear (void)
{
        m_iMessagesLines = 0;
        m_pMessagesTextView->clear();
}

} // namespace QSampler


// end of qsamplerMessages.cpp
1	capela	94	// qsamplerMessages.cpp
2			//
3			/****************************************************************************
4	capela	2582	Copyright (C) 2004-2014, rncbc aka Rui Nuno Capela. All rights reserved.
5	capela	1464	Copyright (C) 2007, Christian Schoenebeck
6	capela	94
7			This program is free software; you can redistribute it and/or
8			modify it under the terms of the GNU General Public License
9			as published by the Free Software Foundation; either version 2
10			of the License, or (at your option) any later version.
11
12			This program is distributed in the hope that it will be useful,
13			but WITHOUT ANY WARRANTY; without even the implied warranty of
14			MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15			GNU General Public License for more details.
16
17	capela	920	You should have received a copy of the GNU General Public License along
18			with this program; if not, write to the Free Software Foundation, Inc.,
19			51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
20	capela	94
21			*****************************************************************************/
22
23	capela	1465	#include "qsamplerAbout.h"
24	capela	94	#include "qsamplerMessages.h"
25
26	capela	1465	#include <QSocketNotifier>
27	capela	1738
28			#include <QFile>
29	capela	1465	#include <QTextEdit>
30			#include <QTextCursor>
31	capela	1738	#include <QTextStream>
32	capela	1465	#include <QTextBlock>
33	schoenebeck	1461	#include <QScrollBar>
34	capela	1465	#include <QDateTime>
35			#include <QIcon>
36	schoenebeck	1461
37	capela	115	#if !defined(WIN32)
38			#include <unistd.h>
39	capela	2669	#include <fcntl.h>
40	capela	115	#endif
41
42	capela	1558
43			namespace QSampler {
44
45	capela	94	// The default maximum number of message lines.
46			#define QSAMPLER_MESSAGES_MAXLINES 1000
47
48			// Notification pipe descriptors
49			#define QSAMPLER_MESSAGES_FDNIL -1
50			#define QSAMPLER_MESSAGES_FDREAD 0
51			#define QSAMPLER_MESSAGES_FDWRITE 1
52
53	capela	2582
54	capela	94	//-------------------------------------------------------------------------
55	capela	1558	// QSampler::Messages - Messages log dockable window.
56	capela	94	//
57
58			// Constructor.
59	capela	1558	Messages::Messages ( QWidget *pParent )
60	capela	1739	: QDockWidget(pParent)
61	capela	94	{
62	capela	1465	// Surely a name is crucial (e.g.for storing geometry settings)
63			QDockWidget::setObjectName("qsamplerMessages");
64
65	capela	1739	// Intialize stdout capture stuff.
66			m_pStdoutNotifier = NULL;
67			m_fdStdout[QSAMPLER_MESSAGES_FDREAD] = QSAMPLER_MESSAGES_FDNIL;
68			m_fdStdout[QSAMPLER_MESSAGES_FDWRITE] = QSAMPLER_MESSAGES_FDNIL;
69	capela	94
70	capela	1465	// Create local text view widget.
71	capela	1738	m_pMessagesTextView = new QTextEdit(this);
72			// QFont font(m_pMessagesTextView->font());
73	capela	94	// font.setFamily("Fixed");
74	capela	1738	// m_pMessagesTextView->setFont(font);
75			m_pMessagesTextView->setLineWrapMode(QTextEdit::NoWrap);
76			m_pMessagesTextView->setReadOnly(true);
77			m_pMessagesTextView->setUndoRedoEnabled(false);
78			// m_pMessagesTextView->setTextFormat(Qt::LogText);
79	capela	94
80	capela	1465	// Initialize default message limit.
81			m_iMessagesLines = 0;
82			setMessagesLimit(QSAMPLER_MESSAGES_MAXLINES);
83
84	capela	1738	m_pMessagesLog = NULL;
85
86	capela	1465	// Prepare the dockable window stuff.
87	capela	1738	QDockWidget::setWidget(m_pMessagesTextView);
88	capela	1465	QDockWidget::setFeatures(QDockWidget::AllDockWidgetFeatures);
89			QDockWidget::setAllowedAreas(
90			Qt::TopDockWidgetArea \| Qt::BottomDockWidgetArea);
91	capela	772	// Some specialties to this kind of dock window...
92	capela	1465	QDockWidget::setMinimumHeight(120);
93	capela	94
94	capela	1465	// Finally set the default caption and tooltip.
95			const QString& sCaption = tr("Messages");
96			QDockWidget::setWindowTitle(sCaption);
97			// QDockWidget::setWindowIcon(QIcon(":/icons/qsamplerMessages.png"));
98			QDockWidget::setToolTip(sCaption);
99	capela	94	}
100
101
102			// Destructor.
103	capela	1558	Messages::~Messages (void)
104	capela	94	{
105	capela	1739	// Turn off and close logging.
106	capela	1738	setLogging(false);
107
108	capela	1739	// No more notifications.
109			if (m_pStdoutNotifier)
110			delete m_pStdoutNotifier;
111	capela	94
112	capela	1739	// No need to delete child widgets, Qt does it all for us.
113	capela	94	}
114
115
116			// Own stdout/stderr socket notifier slot.
117	capela	1558	void Messages::stdoutNotify ( int fd )
118	capela	94	{
119			#if !defined(WIN32)
120	capela	2669	// Set non-blocking reads, if not already...
121			const int iFlags = ::fcntl(fd, F_GETFL, 0);
122			int iBlock = ((iFlags & O_NONBLOCK) == 0);
123			if (iBlock)
124			iBlock = ::fcntl(fd, F_SETFL, iFlags \| O_NONBLOCK);
125			// Read as much as is available...
126			QString sTemp;
127	capela	1739	char achBuffer[1024];
128	capela	2669	const int cchBuffer = sizeof(achBuffer) - 1;
129			int cchRead = ::read(fd, achBuffer, cchBuffer);
130			while (cchRead > 0) {
131			achBuffer[cchRead] = (char) 0;
132			sTemp.append(achBuffer);
133			cchRead = (iBlock ? 0 : ::read(fd, achBuffer, cchBuffer));
134	capela	1739	}
135	capela	2669	// Needs to be non-empty...
136			if (!sTemp.isEmpty())
137			appendStdoutBuffer(sTemp);
138	capela	94	#endif
139			}
140
141
142			// Stdout buffer handler -- now splitted by complete new-lines...
143	capela	1558	void Messages::appendStdoutBuffer ( const QString& s )
144	capela	94	{
145	capela	1465	m_sStdoutBuffer.append(s);
146	capela	94
147	capela	2582	const int iLength = m_sStdoutBuffer.lastIndexOf('\n');
148	capela	1465	if (iLength > 0) {
149	capela	2582	const QString& sTemp = m_sStdoutBuffer.left(iLength);
150	schoenebeck	1474	m_sStdoutBuffer.remove(0, iLength + 1);
151	capela	1465	QStringList list = sTemp.split('\n');
152			QStringListIterator iter(list);
153			while (iter.hasNext())
154			appendMessagesText(iter.next());
155			}
156	capela	94	}
157
158
159			// Stdout flusher -- show up any unfinished line...
160	capela	1558	void Messages::flushStdoutBuffer (void)
161	capela	94	{
162	capela	1739	if (!m_sStdoutBuffer.isEmpty()) {
163			appendMessagesText(m_sStdoutBuffer);
164	capela	2669	m_sStdoutBuffer.clear();
165	capela	1739	}
166	capela	94	}
167
168
169			// Stdout capture accessors.
170	capela	1558	bool Messages::isCaptureEnabled (void)
171	capela	94	{
172	capela	2582	return (m_pStdoutNotifier != NULL);
173	capela	94	}
174
175	capela	1558	void Messages::setCaptureEnabled ( bool bCapture )
176	capela	94	{
177	capela	1739	// Flush current buffer.
178			flushStdoutBuffer();
179	capela	94
180			#if !defined(WIN32)
181	capela	1465	// Destroy if already enabled.
182			if (!bCapture && m_pStdoutNotifier) {
183			delete m_pStdoutNotifier;
184			m_pStdoutNotifier = NULL;
185			// Close the notification pipes.
186			if (m_fdStdout[QSAMPLER_MESSAGES_FDREAD] != QSAMPLER_MESSAGES_FDNIL) {
187			::close(m_fdStdout[QSAMPLER_MESSAGES_FDREAD]);
188			m_fdStdout[QSAMPLER_MESSAGES_FDREAD] = QSAMPLER_MESSAGES_FDNIL;
189			}
190			}
191			// Are we going to make up the capture?
192			if (bCapture && m_pStdoutNotifier == NULL && ::pipe(m_fdStdout) == 0) {
193			::dup2(m_fdStdout[QSAMPLER_MESSAGES_FDWRITE], STDOUT_FILENO);
194			::dup2(m_fdStdout[QSAMPLER_MESSAGES_FDWRITE], STDERR_FILENO);
195			m_pStdoutNotifier = new QSocketNotifier(
196			m_fdStdout[QSAMPLER_MESSAGES_FDREAD], QSocketNotifier::Read, this);
197			QObject::connect(m_pStdoutNotifier,
198			SIGNAL(activated(int)),
199			SLOT(stdoutNotify(int)));
200			}
201	capela	94	#endif
202			}
203
204
205			// Message font accessors.
206	capela	1558	QFont Messages::messagesFont (void)
207	capela	94	{
208	capela	1739	return m_pMessagesTextView->font();
209	capela	94	}
210
211	capela	1738	void Messages::setMessagesFont ( const QFont& font )
212	capela	94	{
213	capela	1739	m_pMessagesTextView->setFont(font);
214	capela	94	}
215
216
217			// Maximum number of message lines accessors.
218	capela	1558	int Messages::messagesLimit (void)
219	capela	94	{
220	capela	1739	return m_iMessagesLimit;
221	capela	94	}
222
223	capela	1558	void Messages::setMessagesLimit ( int iMessagesLimit )
224	capela	94	{
225	capela	1739	m_iMessagesLimit = iMessagesLimit;
226			m_iMessagesHigh = iMessagesLimit + (iMessagesLimit / 3);
227	capela	94	}
228
229	capela	1738	// Messages logging stuff.
230			bool Messages::isLogging (void) const
231			{
232			return (m_pMessagesLog != NULL);
233			}
234	capela	94
235	capela	1738	void Messages::setLogging ( bool bEnabled, const QString& sFilename )
236	capela	94	{
237	capela	1738	if (m_pMessagesLog) {
238			appendMessages(tr("Logging stopped --- %1 ---")
239			.arg(QDateTime::currentDateTime().toString()));
240			m_pMessagesLog->close();
241			delete m_pMessagesLog;
242			m_pMessagesLog = NULL;
243			}
244
245			if (bEnabled) {
246			m_pMessagesLog = new QFile(sFilename);
247			if (m_pMessagesLog->open(QIODevice::Text \| QIODevice::Append)) {
248			appendMessages(tr("Logging started --- %1 ---")
249			.arg(QDateTime::currentDateTime().toString()));
250			} else {
251			delete m_pMessagesLog;
252			m_pMessagesLog = NULL;
253			}
254			}
255	capela	94	}
256
257	capela	1738
258			// Messages log output method.
259			void Messages::appendMessagesLog ( const QString& s )
260	capela	94	{
261	capela	1738	if (m_pMessagesLog) {
262			QTextStream(m_pMessagesLog) << s << endl;
263			m_pMessagesLog->flush();
264			}
265	capela	94	}
266
267	capela	1738	// Messages widget output method.
268			void Messages::appendMessagesLine ( const QString& s )
269	capela	94	{
270	capela	1738	// Check for message line limit...
271			if (m_iMessagesLines > m_iMessagesHigh) {
272			m_pMessagesTextView->setUpdatesEnabled(false);
273			QTextCursor textCursor(m_pMessagesTextView->document()->begin());
274	capela	1465	while (m_iMessagesLines > m_iMessagesLimit) {
275			// Move cursor extending selection
276			// from start to next line-block...
277			textCursor.movePosition(
278			QTextCursor::NextBlock, QTextCursor::KeepAnchor);
279			m_iMessagesLines--;
280			}
281			// Remove the excessive line-blocks...
282			textCursor.removeSelectedText();
283	capela	1738	m_pMessagesTextView->setUpdatesEnabled(true);
284			}
285	capela	1465
286	capela	1738	m_pMessagesTextView->append(s);
287	capela	1465	m_iMessagesLines++;
288	capela	94	}
289
290
291	capela	1738	// The main utility methods.
292			void Messages::appendMessages ( const QString& s )
293			{
294	capela	1739	appendMessagesColor(s, "#999999");
295	capela	1738	}
296
297			void Messages::appendMessagesColor ( const QString& s, const QString &c )
298			{
299	capela	2583	const QString& sText
300			= QTime::currentTime().toString("hh:mm:ss.zzz") + ' ' + s;
301	capela	1738	appendMessagesLine("<font color=\"" + c + "\">" + sText + "</font>");
302			appendMessagesLog(sText);
303			}
304
305			void Messages::appendMessagesText ( const QString& s )
306			{
307			appendMessagesLine(s);
308			appendMessagesLog(s);
309			}
310
311
312	capela	1465	// History reset.
313	capela	1558	void Messages::clear (void)
314	capela	94	{
315	capela	1465	m_iMessagesLines = 0;
316	capela	1738	m_pMessagesTextView->clear();
317	capela	94	}
318
319	capela	1558	} // namespace QSampler
320	capela	94
321	capela	1558
322	capela	94	// end of qsamplerMessages.cpp