C++: Add dumpers for common datatypes to simplify debugging.

Change-Id: I03f907dd0e8d9d63f0dfd38499c98296b5c7871a
Reviewed-by: Christian Kamm <christian.d.kamm@nokia.com>

4 files changed, 208 insertions, 2 deletions

diff --git a/src/libs/cplusplus/CppDocument.h b/src/libs/cplusplus/CppDocument.h
index 258d86138b..40d3ef80a4 100644
--- a/src/libs/cplusplus/CppDocument.h
+++ b/src/libs/cplusplus/CppDocument.h
@@ -42,6 +42,11 @@
 #include <QFileInfo>
 #include <QAtomicInt>
 
+// in debug mode: make dumpers widely available without an extra include
+#ifdef QT_DEBUG
+#include "Dumpers.h"
+#endif
+
 namespace CPlusPlus {
 
 class Macro;
diff --git a/src/libs/cplusplus/Dumpers.cpp b/src/libs/cplusplus/Dumpers.cpp
new file mode 100644
index 0000000000..941f6d0900
--- /dev/null
+++ b/src/libs/cplusplus/Dumpers.cpp
@@ -0,0 +1,140 @@
+/**************************************************************************
+**
+** 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 "Dumpers.h"
+
+#include <Overview.h>
+#include <Literals.h>
+#include <Scope.h>
+#include <LookupContext.h>
+#include <QDebug>
+
+#include <typeinfo>
+
+static QString indent(QString s, int level = 2)
+{
+    QString indentString(level, QLatin1Char(' '));
+    QString result;
+    int last = 0;
+    for (int i = 0; i < s.length(); ++i) {
+        if (s.at(i) == QLatin1Char('\n') || i == s.length() - 1) {
+            result.append(indentString);
+            result.append(s.midRef(last, i + 1));
+            last = i + 1;
+        }
+    }
+    return result;
+}
+
+QString CPlusPlus::toString(const Name *name, QString id)
+{
+    Overview oo;
+    return QString("%0: %1").arg(id, name ? oo(name) : QLatin1String("(null)"));
+}
+
+QString CPlusPlus::toString(FullySpecifiedType ty, QString id)
+{
+    Overview oo;
+    return QString("%0: %1 (a %2)").arg(id, oo(ty), ty.type() ? typeid(*ty.type()).name() : "(null)");
+}
+
+QString CPlusPlus::toString(const Symbol *s, QString id)
+{
+    if (!s)
+        return QString("%0: (null)").arg(id);
+
+    return QString("%0: %1 (%2) at %3:%4:%5\n%6").arg(
+                id,
+                QString::fromLatin1(typeid(*s).name()),
+                QString::fromUtf8(s->identifier()->chars()),
+                QString::fromLatin1(s->fileName()),
+                QString::number(s->line()),
+                QString::number(s->column()),
+                indent(toString(s->type())));
+}
+
+QString CPlusPlus::toString(LookupItem it, QString id)
+{
+    QString result = QString("%1:").arg(id);
+    if (it.declaration()) {
+        result.append(QString("\n%1").arg(indent(toString(it.declaration(), QLatin1String("Decl")))));
+    }
+    if (it.type().isValid()) {
+        result.append(QString("\n%1").arg(indent(toString(it.type()))));
+    }
+    if (it.scope()) {
+        result.append(QString("\n%1").arg(indent(toString(it.scope(), QLatin1String("Scope")))));
+    }
+    if (it.binding()) {
+        result.append(QString("\n%1").arg(indent(toString(it.binding(), QLatin1String("Binding")))));
+    }
+    return result;
+}
+
+QString CPlusPlus::toString(const ClassOrNamespace *binding, QString id)
+{
+    if (!binding)
+        return QString("%0: (null)").arg(id);
+
+    QString result = QString("%0: %1 symbols").arg(
+                id,
+                QString::number(binding->symbols().length()));
+    if (binding->templateId()) {
+        result.append(QString("\n%1").arg(indent(toString(binding->templateId(), QLatin1String("Template")))));
+    }
+    return result;
+}
+
+void CPlusPlus::dump(const Name *name)
+{
+    qDebug() << qPrintable(toString(name));
+}
+
+void CPlusPlus::dump(FullySpecifiedType ty)
+{
+    qDebug() << qPrintable(toString(ty));
+}
+
+void CPlusPlus::dump(const Symbol *s)
+{
+    qDebug() << qPrintable(toString(s));
+}
+
+void CPlusPlus::dump(LookupItem it)
+{
+    qDebug() << qPrintable(toString(it));
+}
+
+void CPlusPlus::dump(const ClassOrNamespace *binding)
+{
+    qDebug() << qPrintable(toString(binding));
+}
diff --git a/src/libs/cplusplus/Dumpers.h b/src/libs/cplusplus/Dumpers.h
new file mode 100644
index 0000000000..8d838d7f1d
--- /dev/null
+++ b/src/libs/cplusplus/Dumpers.h
@@ -0,0 +1,59 @@
+/**************************************************************************
+**
+** 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.
+**
+**************************************************************************/
+
+#ifndef CPLUSPLUS_DUMPERS_H
+#define CPLUSPLUS_DUMPERS_H
+
+#include <CPlusPlusForwardDeclarations.h>
+#include <FullySpecifiedType.h>
+#include <Symbol.h>
+#include <LookupItem.h>
+
+#include <QString>
+
+namespace CPlusPlus {
+
+QString CPLUSPLUS_EXPORT toString(const Name *name, QString id = QLatin1String("Name"));
+QString CPLUSPLUS_EXPORT toString(FullySpecifiedType ty, QString id = QLatin1String("Type"));
+QString CPLUSPLUS_EXPORT toString(const Symbol *s, QString id = QLatin1String("Symbol"));
+QString CPLUSPLUS_EXPORT toString(LookupItem it, QString id = QLatin1String("LookupItem"));
+QString CPLUSPLUS_EXPORT toString(const ClassOrNamespace *binding, QString id = QLatin1String("ClassOrNamespace"));
+
+void CPLUSPLUS_EXPORT dump(const Name *name);
+void CPLUSPLUS_EXPORT dump(FullySpecifiedType ty);
+void CPLUSPLUS_EXPORT dump(const Symbol *s);
+void CPLUSPLUS_EXPORT dump(LookupItem it);
+void CPLUSPLUS_EXPORT dump(const ClassOrNamespace *binding);
+
+} // namespace CPlusPlus
+
+#endif
diff --git a/src/libs/cplusplus/cplusplus-lib.pri b/src/libs/cplusplus/cplusplus-lib.pri
index 57b2e2ffdf..02ee0f1ee3 100644
--- a/src/libs/cplusplus/cplusplus-lib.pri
+++ b/src/libs/cplusplus/cplusplus-lib.pri
@@ -55,7 +55,8 @@ HEADERS += \
     $$PWD/pp-scanner.h \
     $$PWD/ModelManagerInterface.h \
     $$PWD/findcdbbreakpoint.h \
-    $$PWD/TypeHierarchyBuilder.h
+    $$PWD/TypeHierarchyBuilder.h \
+    $$PWD/Dumpers.h
 
 SOURCES += \
     $$PWD/SimpleLexer.cpp \
@@ -84,6 +85,7 @@ SOURCES += \
     $$PWD/pp-scanner.cpp \
     $$PWD/ModelManagerInterface.cpp \
     $$PWD/findcdbbreakpoint.cpp \
-    $$PWD/TypeHierarchyBuilder.cpp
+    $$PWD/TypeHierarchyBuilder.cpp \
+    $$PWD/Dumpers.cpp
 
 RESOURCES += $$PWD/cplusplus.qrc