trunk/src/qsamplerMessages.cpp

// qsamplerMessages.cpp
//
/****************************************************************************
   Copyright (C) 2004-2020, 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 <QTextBrowser>
#include <QTextCursor>
#include <QTextStream>
#include <QTextBlock>
#include <QDateTime>
#include <QIcon>

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


// Deprecated QTextStreamFunctions/Qt namespaces workaround.
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
#define endl    Qt::endl
#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 = nullptr;
        m_fdStdout[QSAMPLER_MESSAGES_FDREAD]  = QSAMPLER_MESSAGES_FDNIL;
        m_fdStdout[QSAMPLER_MESSAGES_FDWRITE] = QSAMPLER_MESSAGES_FDNIL;

        // Create local text view widget.
        m_pMessagesTextView = new QTextBrowser(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 = nullptr;

        // 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.
}


// Set stdout/stderr blocking mode.
bool Messages::stdoutBlock ( int fd, bool bBlock ) const
{
#if !defined(__WIN32__) && !defined(_WIN32) && !defined(WIN32)
        const int iFlags = ::fcntl(fd, F_GETFL, 0);
        const bool bNonBlock = bool(iFlags & O_NONBLOCK);
        if (bBlock && bNonBlock)
                bBlock = (::fcntl(fd, F_SETFL, iFlags & ~O_NONBLOCK) == 0);
        else
        if (!bBlock && !bNonBlock)
                bBlock = (::fcntl(fd, F_SETFL, iFlags |  O_NONBLOCK) != 0);
#endif
        return bBlock;
}


// Own stdout/stderr socket notifier slot.
void Messages::stdoutNotify ( int fd )
{
#if !defined(__WIN32__) && !defined(_WIN32) && !defined(WIN32)
        // Set non-blocking reads, if not already...
        const bool bBlock = stdoutBlock(fd, false);
        // 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 = (bBlock ? 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);

        processStdoutBuffer();
}

void Messages::processStdoutBuffer (void)
{
        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()) {
                processStdoutBuffer();
                m_sStdoutBuffer.clear();
        }
}


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

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

#if !defined(__WIN32__) && !defined(_WIN32) && !defined(WIN32)
        // Destroy if already enabled.
        if (!bCapture && m_pStdoutNotifier) {
                delete m_pStdoutNotifier;
                m_pStdoutNotifier = nullptr;
                // 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 == nullptr && ::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 != nullptr);
}

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 = nullptr;
        }

        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 = nullptr;
                }
        }
}


// Messages log output method.
void Messages::appendMessagesLog ( const QString& s )
{
        if (m_pMessagesLog) {
                QTextStream(m_pMessagesLog)
                        << QTime::currentTime().toString("hh:mm:ss.zzz")
                        << ' ' << 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, Qt::gray);
}

void Messages::appendMessagesColor ( const QString& s, const QColor& rgb )
{
        appendMessagesLine("<font color=\"" + rgb.name() + "\">" + s + "</font>");
        appendMessagesLog(s);
}

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