qtcassert: move actual printing to separate function and enforce style

This also allows simple setting of breakpoints on failed asserts.

Change-Id: I6dd84cbfaf659d57e39f3447386cebc0221b2b84
Reviewed-by: Daniel Teske <daniel.teske@nokia.com>

doc/api/examples/webpagewizard/webpagewizard.cpp

@@ -84,12 +84,11 @@ QWizard *WebPageWizard::createWizardDialog(QWidget *parent,
 }
 
 Core::GeneratedFiles
-    WebPageWizard::generateFiles(const QWizard *w,
-                                     QString *) const
+    WebPageWizard::generateFiles(const QWizard *w, QString *) const
 {
     Core::GeneratedFiles files;
     const WebContentWizardDialog *dialog = qobject_cast<const WebContentWizardDialog*>(w);
-    QTC_ASSERT(dialog, return files; )
+    QTC_ASSERT(dialog, return files);
 
     const QString fileName = Core::BaseFileWizard::buildFileName(dialog->path(), dialog->fileName(), QLatin1String("html"));
 

src/libs/utils/fileinprojectfinder.cpp

@@ -33,6 +33,7 @@
 #include "fileinprojectfinder.h"
 #include <utils/qtcassert.h>
 
+#include <QDebug>
 #include <QFileInfo>
 #include <QUrl>
 

src/libs/utils/fileutils.cpp

@@ -36,6 +36,7 @@
 #include "qtcassert.h"
 
 #include <QDir>
+#include <QDebug>
 #include <QFileInfo>
 #include <QTemporaryFile>
 #include <QDateTime>
@@ -208,19 +209,18 @@ QString FileUtils::resolveSymlinks(const QString &path)
     return f.filePath();
 }
 
-
 QByteArray FileReader::fetchQrc(const QString &fileName)
 {
-    QTC_ASSERT(fileName.startsWith(QLatin1Char(':')), return QByteArray())
+    QTC_ASSERT(fileName.startsWith(QLatin1Char(':')), return QByteArray());
     QFile file(fileName);
     bool ok = file.open(QIODevice::ReadOnly);
-    QTC_ASSERT(ok, qWarning() << fileName << "not there!"; return QByteArray())
+    QTC_ASSERT(ok, qWarning() << fileName << "not there!"; return QByteArray());
     return file.readAll();
 }
 
 bool FileReader::fetch(const QString &fileName, QIODevice::OpenMode mode)
 {
-    QTC_ASSERT(!(mode & ~(QIODevice::ReadOnly | QIODevice::Text)), return false)
+    QTC_ASSERT(!(mode & ~(QIODevice::ReadOnly | QIODevice::Text)), return false);
 
     QFile file(fileName);
     if (!file.open(QIODevice::ReadOnly | mode)) {

src/libs/utils/pathchooser.cpp

@@ -131,7 +131,7 @@ bool BinaryVersionToolTipEventFilter::eventFilter(QObject *o, QEvent *e)
     if (e->type() != QEvent::ToolTip)
         return false;
     QLineEdit *le = qobject_cast<QLineEdit *>(o);
-    QTC_ASSERT(le, return false; )
+    QTC_ASSERT(le, return false);
 
     const QString binary = le->text();
     if (!binary.isEmpty()) {

src/libs/utils/persistentsettings.cpp

@@ -130,7 +130,7 @@ struct ParseValueStackEntry
 ParseValueStackEntry::ParseValueStackEntry(const QVariant &aSimpleValue, const QString &k) :
     type(aSimpleValue.type()), key(k), simpleValue(aSimpleValue)
 {
-    QTC_ASSERT(simpleValue.isValid(), return ; )
+    QTC_ASSERT(simpleValue.isValid(), return);
 }
 
 QVariant ParseValueStackEntry::value() const
@@ -250,10 +250,10 @@ bool ParseContext::handleEndElement(const QStringRef &name)
 {
     const Element e = element(name);
     if (ParseContext::isValueElement(e)) {
-        QTC_ASSERT(!m_valueStack.isEmpty(), return true; )
+        QTC_ASSERT(!m_valueStack.isEmpty(), return true);
         const ParseValueStackEntry top = m_valueStack.pop();
         if (m_valueStack.isEmpty()) { // Last element? -> Done with that variable.
-            QTC_ASSERT(!m_currentVariableName.isEmpty(), return true; )
+            QTC_ASSERT(!m_currentVariableName.isEmpty(), return true);
             m_result.insert(m_currentVariableName, top.value());
             m_currentVariableName.clear();
             return false;
@@ -286,7 +286,7 @@ QVariant ParseContext::readSimpleValue(QXmlStreamReader &r, const QXmlStreamAttr
     const QString type = attributes.value(typeAttribute).toString();
     const QString text = r.readElementText();
     if (type == QLatin1String("QChar")) { // Workaround: QTBUG-12345
-        QTC_ASSERT(text.size() == 1, return QVariant(); )
+        QTC_ASSERT(text.size() == 1, return QVariant());
         return QVariant(QChar(text.at(0)));
     }
     QVariant value;

src/libs/utils/qtcassert.cpp

+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+**
+** GNU Lesser General Public License Usage
+**
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this file.
+** Please review the following information to ensure the GNU Lesser General
+** Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** Other Usage
+**
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+** If you have questions regarding the use of this file, please contact
+** Nokia at qt-info@nokia.com.
+**
+**************************************************************************/
+
+#include "qtcassert.h"
+
+namespace Utils {
+
+void writeAssertLocation(const char *msg)
+{
+    qDebug("SOFT ASSERT: %s", msg);
+}
+
+} // namespace Utils

src/libs/utils/qtcassert.h

@@ -33,19 +33,20 @@
 #ifndef QTC_ASSERT_H
 #define QTC_ASSERT_H
 
-#include <QDebug>
+#include "utils_global.h"
 
-#define QTC_ASSERT_STRINGIFY_INTERNAL(x) #x
-#define QTC_ASSERT_STRINGIFY(x) QTC_ASSERT_STRINGIFY_INTERNAL(x)
+namespace Utils { QTCREATOR_UTILS_EXPORT void writeAssertLocation(const char *msg); }
 
-// we do not use the  'do {...} while (0)' idiom here to be able to use
-// 'break' and 'continue' as 'actions'.
+#define QTC_ASSERT_STRINGIFY_HELPER(x) #x
+#define QTC_ASSERT_STRINGIFY(x) QTC_ASSERT_STRINGIFY_HELPER(x)
+#define QTC_ASSERT_STRING(cond) ::Utils::writeAssertLocation(\
+    "\"" cond"\" in file " __FILE__ ", line " QTC_ASSERT_STRINGIFY(__LINE__))
 
-#define QTC_ASSERT(cond, action) \
-    if(cond){}else{qDebug()<<"SOFT ASSERT: \""#cond"\" in file " __FILE__ ", line " QTC_ASSERT_STRINGIFY(__LINE__);action;}
+// The 'do {...} while (0)' idiom is not used for the main block here to be
+// able to use 'break' and 'continue' as 'actions'.
 
-#define QTC_CHECK(cond) \
-    if(cond){}else{qDebug()<<"SOFT ASSERT: \""#cond"\" in file " __FILE__ ", line " QTC_ASSERT_STRINGIFY(__LINE__);}
+#define QTC_ASSERT(cond, action) if (cond) {} else { QTC_ASSERT_STRING(#cond); action; } do {} while (0)
+#define QTC_CHECK(cond) if (cond) {} else { QTC_ASSERT_STRING(#cond); } do {} while (0)
 
 #endif // QTC_ASSERT_H
 

src/libs/utils/synchronousprocess.cpp

@@ -553,7 +553,7 @@ bool SynchronousProcess::readDataFromProcess(QProcess &p, int timeOutMS,
         return false;
     }
 
-    QTC_ASSERT(p.readChannel() == QProcess::StandardOutput, return false)
+    QTC_ASSERT(p.readChannel() == QProcess::StandardOutput, return false);
 
     // Keep the process running until it has no longer has data
     bool finished = false;

src/libs/utils/tcpportsgatherer.cpp

@@ -32,9 +32,11 @@
 
 #include "tcpportsgatherer.h"
 #include "qtcassert.h"
+
+#include <QDebug>
 #include <QFile>
-#include <QStringList>
 #include <QProcess>
+#include <QStringList>
 
 #ifdef Q_OS_WIN
 #include <QLibrary>

src/libs/utils/textfileformat.cpp

@@ -150,7 +150,7 @@ bool decodeTextFileContent(const QByteArray &dataBA,
                            Target *target,
                            void (Target::*appendFunction)(const QString &))
 {
-    QTC_ASSERT(format.codec, return  false; )
+    QTC_ASSERT(format.codec, return false);
 
     QTextCodec::ConverterState state;
     bool hasDecodingError = false;
@@ -283,7 +283,7 @@ TextFileFormat::ReadResult
 
 bool TextFileFormat::writeFile(const QString &fileName, QString plainText, QString *errorString) const
 {
-    QTC_ASSERT(codec, return false;)
+    QTC_ASSERT(codec, return false);
 
     // Does the user want CRLF? If that is native,
     // let QFile do the work, else manually add.

src/libs/utils/utils-lib.pri

@@ -98,7 +98,8 @@ SOURCES += $$PWD/environment.cpp \
     $$PWD/portlist.cpp \
     $$PWD/tcpportsgatherer.cpp \
     $$PWD/appmainwindow.cpp \
-    $$PWD/basetreeview.cpp
+    $$PWD/basetreeview.cpp \
+    $$PWD/qtcassert.cpp
 
 win32 {
     SOURCES += \

src/libs/utils/utils.qbs

@@ -107,6 +107,7 @@ QtcLibrary {
         "projectnamevalidatinglineedit.h",
         "proxyaction.h",
         "qtcassert.h",
+        "qtcassert.cpp",
         "qtcolorbutton.cpp",
         "qtcolorbutton.h",
         "qtcprocess.h",

src/libs/utils/winutils.cpp

@@ -195,7 +195,7 @@ QTCREATOR_UTILS_EXPORT bool winIs64BitSystem()
 
 QTCREATOR_UTILS_EXPORT bool winIs64BitBinary(const QString &binaryIn)
 {
-       QTC_ASSERT(!binaryIn.isEmpty(), return false; )
+       QTC_ASSERT(!binaryIn.isEmpty(), return false);
 #ifdef Q_OS_WIN32
 #  ifdef __GNUC__   // MinGW lacking some definitions/winbase.h
 #    define SCS_64BIT_BINARY 6

src/plugins/analyzerbase/analyzerutils.cpp

@@ -99,7 +99,7 @@ CPlusPlus::Symbol *AnalyzerUtils::findSymbolUnderCursor()
 
     const CPlusPlus::Snapshot &snapshot = CPlusPlus::CppModelManagerInterface::instance()->snapshot();
     CPlusPlus::Document::Ptr doc = snapshot.document(editor->document()->fileName());
-    QTC_ASSERT(doc, return 0)
+    QTC_ASSERT(doc, return 0);
 
     // fetch the expression's code
     CPlusPlus::ExpressionUnderCursor expressionUnderCursor;

src/plugins/bineditor/bineditor.cpp

@@ -1586,7 +1586,7 @@ void BinEditor::asFloat(int offset, float &value, bool old) const
 {
     value = 0;
     const QByteArray data = dataMid(offset, sizeof(float), old);
-    QTC_ASSERT(data.size() ==  sizeof(float), return )
+    QTC_ASSERT(data.size() ==  sizeof(float), return);
     const float *f = reinterpret_cast<const float *>(data.constData());
     value = *f;
 }
@@ -1595,7 +1595,7 @@ void BinEditor::asDouble(int offset, double &value, bool old) const
 {
     value = 0;
     const QByteArray data = dataMid(offset, sizeof(double), old);
-    QTC_ASSERT(data.size() ==  sizeof(double), return )
+    QTC_ASSERT(data.size() ==  sizeof(double), return);
     const double *f = reinterpret_cast<const double *>(data.constData());
     value = *f;
 }

src/plugins/cmakeprojectmanager/cmakeproject.cpp

@@ -87,7 +87,7 @@ static inline bool isFormWindowEditor(const QObject *o)
 static inline QString formWindowEditorContents(const QObject *editor)
 {
     const QVariant contentV = editor->property("contents");
-    QTC_ASSERT(contentV.isValid(), return QString(); )
+    QTC_ASSERT(contentV.isValid(), return QString());
     return contentV.toString();
 }
 

src/plugins/coreplugin/actionmanager/commandsfile.cpp

@@ -110,7 +110,7 @@ QMap<QString, QKeySequence> CommandsFile::importCommands() const
             if (name == ctx.shortCutElement) {
                 currentId = r.attributes().value(ctx.idAttribute).toString();
             } else if (name == ctx.keyElement) {
-                QTC_ASSERT(!currentId.isEmpty(), return result; )
+                QTC_ASSERT(!currentId.isEmpty(), return result);
                 const QXmlStreamAttributes attributes = r.attributes();
                 if (attributes.hasAttribute(ctx.valueAttribute)) {
                     const QString keyString = attributes.value(ctx.valueAttribute).toString();

src/plugins/coreplugin/basefilewizard.cpp

@@ -742,7 +742,7 @@ BaseFileWizard::OverwriteResult BaseFileWizard::promptOverwrite(GeneratedFiles *
     // Set 'keep' attribute in files
     foreach (const QString &keepFile, existingFilesToKeep) {
         const int i = indexOfFile(*files, keepFile);
-        QTC_ASSERT(i != -1, return OverwriteCanceled; )
+        QTC_ASSERT(i != -1, return OverwriteCanceled);
         GeneratedFile &file = (*files)[i];
         file.setAttributes(file.attributes() | GeneratedFile::KeepExistingFileAttribute);
     }

src/plugins/coreplugin/editormanager/openeditorswindow.cpp

@@ -208,7 +208,7 @@ void OpenEditorsWindow::setEditors(EditorView *mainView, EditorView *view, OpenE
         if (hi.document.isNull() || documentsDone.contains(hi.document))
             continue;
         QString title = model->displayNameForDocument(hi.document);
-        QTC_ASSERT(!title.isEmpty(), continue;)
+        QTC_ASSERT(!title.isEmpty(), continue);
         documentsDone.insert(hi.document.data());
         QTreeWidgetItem *item = new QTreeWidgetItem();
         if (hi.document->isModified())

src/plugins/coreplugin/editortoolbar.cpp

@@ -218,7 +218,7 @@ EditorToolBar::~EditorToolBar()
 
 void EditorToolBar::removeToolbarForEditor(IEditor *editor)
 {
-    QTC_ASSERT(editor, return)
+    QTC_ASSERT(editor, return);
     disconnect(editor, SIGNAL(changed()), this, SLOT(checkEditorStatus()));
 
     QWidget *toolBar = editor->toolBar();
@@ -259,7 +259,7 @@ void EditorToolBar::closeEditor()
 
 void EditorToolBar::addEditor(IEditor *editor)
 {
-    QTC_ASSERT(editor, return)
+    QTC_ASSERT(editor, return);
     connect(editor, SIGNAL(changed()), this, SLOT(checkEditorStatus()));
     QWidget *toolBar = editor->toolBar();
 
@@ -271,7 +271,7 @@ void EditorToolBar::addEditor(IEditor *editor)
 
 void EditorToolBar::addCenterToolBar(QWidget *toolBar)
 {
-    QTC_ASSERT(toolBar, return)
+    QTC_ASSERT(toolBar, return);
     toolBar->setVisible(false); // will be made visible in setCurrentEditor
     d->m_toolBarPlaceholder->layout()->addWidget(toolBar);
 
@@ -305,7 +305,7 @@ void EditorToolBar::setToolbarCreationFlags(ToolbarCreationFlags flags)
 
 void EditorToolBar::setCurrentEditor(IEditor *editor)
 {
-    QTC_ASSERT(editor, return)
+    QTC_ASSERT(editor, return);
     d->m_editorList->setCurrentIndex(d->m_editorsListModel->indexOf(editor).row());
 
     // If we never added the toolbar from the editor,  we will never change