Move ast dump tools from tests/manual to tests/tools.

Reviewed-by: Friedemann Kleint

tests/tools/cplusplus-dump/c++

@@ -0,0 +1,5 @@
+#!/bin/sh
+me=$(dirname $0)
+${CPP-gcc} -U__BLOCKS__ -xc++ -E -include $me/conf.c++ $* > $me/file.i
+$me/cplusplus0 $me/file.i
+

tests/tools/cplusplus-dump/conf.c++

@@ -0,0 +1,15 @@
+#define __extension__
+#define __context__
+#define __range__
+#define __asm(a...)
+#define __asm__(a...)
+#define   restrict
+#define __restrict
+#define __restrict__
+// #define __weak
+#define __builtin_va_arg(a,b) ((b)0)
+#define __stdcall
+#define __fastcall
+#define __imag__
+#define __real__
+#define __complex__

tests/tools/cplusplus-dump/cplusplus-dump.pro

@@ -0,0 +1,19 @@
+QT = core gui
+macx:CONFIG -= app_bundle
+TARGET = cplusplus0
+
+include(../../../src/libs/cplusplus/cplusplus-lib.pri)
+
+# Input
+SOURCES += main.cpp
+
+unix {
+    debug:OBJECTS_DIR = $${OUT_PWD}/.obj/debug-shared
+    release:OBJECTS_DIR = $${OUT_PWD}/.obj/release-shared
+
+    debug:MOC_DIR = $${OUT_PWD}/.moc/debug-shared
+    release:MOC_DIR = $${OUT_PWD}/.moc/release-shared
+
+    RCC_DIR = $${OUT_PWD}/.rcc/
+    UI_DIR = $${OUT_PWD}/.uic/
+}

tests/tools/cplusplus-dump/main.cpp

@@ -0,0 +1,387 @@
+/**************************************************************************
+**
+** This file is part of Qt Creator
+**
+** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
+**
+** Contact: Nokia Corporation (qt-info@nokia.com)
+**
+** Commercial Usage
+**
+** Licensees holding valid Qt Commercial licenses may use this file in
+** accordance with the Qt Commercial License Agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Nokia.
+**
+** GNU Lesser General Public License Usage
+**
+** Alternatively, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at http://qt.nokia.com/contact.
+**
+**************************************************************************/
+
+#include <AST.h>
+#include <ASTVisitor.h>
+#include <ASTPatternBuilder.h>
+#include <ASTMatcher.h>
+#include <Control.h>
+#include <Scope.h>
+#include <TranslationUnit.h>
+#include <Literals.h>
+#include <Symbols.h>
+#include <Names.h>
+#include <CoreTypes.h>
+#include <CppDocument.h>
+#include <SymbolVisitor.h>
+#include <Overview.h>
+
+#include <QFile>
+#include <QList>
+#include <QCoreApplication>
+#include <QStringList>
+#include <QFileInfo>
+#include <QTime>
+#include <QtDebug>
+
+#include <cstdio>
+#include <cstdlib>
+#include <fstream>
+#include <iostream>
+#ifdef __GNUC__
+#  include <cxxabi.h>
+#endif
+
+using namespace CPlusPlus;
+
+class ASTDump: protected ASTVisitor
+{
+public:
+    ASTDump(TranslationUnit *unit)
+        : ASTVisitor(unit) {}
+
+    void operator()(AST *ast) {
+        QByteArray basename = translationUnit()->fileName();
+        int dotIdx = basename.lastIndexOf('.');
+        if (dotIdx != -1)
+            basename.truncate(dotIdx);
+        basename.append(".ast.dot");
+        out.open(basename.constData());
+
+        out << "digraph AST { ordering=out;" << std::endl;
+        // std::cout << "rankdir = \"LR\";" << std::endl;
+
+        generateTokens();
+        accept(ast);
+
+        typedef QPair<QByteArray, QByteArray> Pair;
+
+        foreach (const Pair &conn, _connections)
+            out << conn.first.constData() << " -> " << conn.second.constData() << std::endl;
+
+        alignTerminals();
+
+        out << "}" << std::endl;
+        out.close();
+        std::cout << basename.constData() << std::endl;
+    }
+
+    // the following file can be generated by using:
+    //    generate-ast <path to cpp stuff> <path to dumpers.inc>
+#include "dumpers.inc"
+
+protected:
+    void alignTerminals() {
+        out<<"{ rank=same;" << std::endl;
+        foreach (const QByteArray &terminalShape, _terminalShapes) {
+            out << "  " << std::string(terminalShape) << ";" << std::endl;
+        }
+        out<<"}"<<std::endl;
+    }
+
+    static QByteArray name(AST *ast) {
+#ifdef __GNUC__
+        QByteArray name = abi::__cxa_demangle(typeid(*ast).name(), 0, 0, 0) + 11;
+        name.truncate(name.length() - 3);
+#else
+        QByteArray name = typeid(*ast).name();
+#endif
+        return name;
+    }
+
+    QByteArray terminalId(unsigned token)
+    { return 't' + QByteArray::number(token); }
+
+    void terminal(unsigned token, AST *node) {
+        _connections.append(qMakePair(_id[node], terminalId(token)));
+    }
+
+    void generateTokens() {
+        for (unsigned token = 1; token < translationUnit()->tokenCount(); ++token) {
+            if (translationUnit()->tokenKind(token) == T_EOF_SYMBOL)
+                break;
+
+            QByteArray t;
+
+            t.append(terminalId(token));
+            t.append(" [shape=rect label = \"");
+            t.append(spell(token));
+            t.append("\"]");
+
+            if (token > 1) {
+                t.append("; ");
+                t.append(terminalId(token - 1));
+                t.append(" -> ");
+                t.append(terminalId(token));
+                t.append(" [arrowhead=\"vee\" color=\"transparent\"]");
+            }
+
+            _terminalShapes.append(t);
+        }
+    }
+
+    virtual void nonterminal(AST *ast) {
+        accept(ast);
+    }
+
+    virtual void node(AST *ast) {
+        out << _id[ast].constData() << " [label=\"" << name(ast).constData() << "\"];" << std::endl;
+    }
+
+    virtual bool preVisit(AST *ast) {
+        static int count = 1;
+        const QByteArray id = 'n' + QByteArray::number(count++);
+        _id[ast] = id;
+
+
+        if (! _stack.isEmpty())
+            _connections.append(qMakePair(_id[_stack.last()], id));
+
+        _stack.append(ast);
+
+        node(ast);
+
+        return true;
+    }
+
+    virtual void postVisit(AST *) {
+        _stack.removeLast();
+    }
+
+private:
+    QHash<AST *, QByteArray> _id;
+    QList<QPair<QByteArray, QByteArray> > _connections;
+    QList<AST *> _stack;
+    QList<QByteArray> _terminalShapes;
+    std::ofstream out;
+};
+
+class SymbolDump: protected SymbolVisitor
+{
+public:
+    SymbolDump(TranslationUnit *unit)
+        : translationUnit(unit)
+    {
+        o.setShowArgumentNames(true);
+        o.setShowFunctionSignatures(true);
+        o.setShowReturnTypes(true);
+    }
+
+    void operator()(Symbol *s) {
+        QByteArray basename = translationUnit->fileName();
+        int dotIdx = basename.lastIndexOf('.');
+        if (dotIdx != -1)
+            basename.truncate(dotIdx);
+        basename.append(".symbols.dot");
+        out.open(basename.constData());
+
+        out << "digraph Symbols { ordering=out;" << std::endl;
+        // std::cout << "rankdir = \"LR\";" << std::endl;
+        accept(s);
+
+        for (int i = 0; i < _connections.size(); ++i) {
+            QPair<Symbol*,Symbol*> connection = _connections.at(i);
+            QByteArray from = _id.value(connection.first);
+            if (from.isEmpty())
+                from = name(connection.first);
+            QByteArray to = _id.value(connection.second);
+            if (to.isEmpty())
+                to = name(connection.second);
+            out << from.constData() << " -> " << to.constData() << ";" << std::endl;
+        }
+
+        out << "}" << std::endl;
+        out.close();
+        std::cout << basename.constData() << std::endl;
+    }
+
+protected:
+    QByteArray name(Symbol *s) {
+#ifdef __GNUC__
+        QByteArray result = abi::__cxa_demangle(typeid(*s).name(), 0, 0, 0) + 11;
+#else
+        QByteArray result = typeid(*s).name();
+#endif
+        if (s->identifier()) {
+            result.append("\\nid: ");
+            result.append(s->identifier()->chars());
+        }
+        if (s->isDeprecated())
+            result.append("\\n(deprecated)");
+
+        return result;
+    }
+
+    virtual bool preVisit(Symbol *s) {
+        static int count = 0;
+        QByteArray nodeId("s");
+        nodeId.append(QByteArray::number(++count));
+        _id[s] = nodeId;
+
+        if (!_stack.isEmpty())
+            _connections.append(qMakePair(_stack.last(), s));
+
+        _stack.append(s);
+
+        return true;
+    }
+
+    virtual void postVisit(Symbol *) {
+        _stack.removeLast();
+    }
+
+    virtual void simpleNode(Symbol *symbol) {
+        out << _id[symbol].constData() << " [label=\"" << name(symbol).constData() << "\"];" << std::endl;
+    }
+
+    virtual bool visit(Class *symbol) {
+        const char *id = _id.value(symbol).constData();
+        out << id << " [label=\"";
+        if (symbol->isClass()) {
+            out << "class";
+        } else if (symbol->isStruct()) {
+            out << "struct";
+        } else if (symbol->isUnion()) {
+            out << "union";
+        } else {
+            out << "UNKNOWN";
+        }
+
+        out << "\\nid: ";
+        if (symbol->identifier()) {
+            out << symbol->identifier()->chars();
+        } else {
+            out << "NO ID";
+        }
+        if (symbol->isDeprecated())
+            out << "\\n(deprecated)";
+        out << "\"];" << std::endl;
+
+        return true;
+    }
+
+    virtual bool visit(UsingNamespaceDirective *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(UsingDeclaration *symbol) { simpleNode(symbol); return true; }
+
+    virtual bool visit(Declaration *symbol) {
+        out << _id[symbol].constData() << " [label=\"";
+        out << "Declaration\\n";
+        out << qPrintable(o(symbol->name()));
+        out << ": ";
+        out << qPrintable(o(symbol->type()));
+        if (symbol->isDeprecated())
+            out << "\\n(deprecated)";
+        if (Function *funTy = symbol->type()->asFunctionType()) {
+            if (funTy->isPureVirtual())
+                out << "\\n(pure virtual)";
+            else if (funTy->isVirtual())
+                out << "\\n(virtual)";
+
+            if (funTy->isSignal())
+                out << "\\n(signal)";
+            if (funTy->isSlot())
+                out << "\\n(slot)";
+            if (funTy->isInvokable())
+                out << "\\n(invokable)";
+        }
+        out << "\"];" << std::endl;
+
+        return true;
+    }
+
+    virtual bool visit(Argument *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(TypenameArgument *symbol) { simpleNode(symbol); return true; }
+
+    virtual bool visit(BaseClass *symbol) {
+        out << _id[symbol].constData() << " [label=\"BaseClass\\n";
+        out << qPrintable(o(symbol->name()));
+        if (symbol->isDeprecated())
+            out << "\\n(deprecated)";
+        out << "\"];" << std::endl;
+
+        return true;
+    }
+
+    virtual bool visit(Enum *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(Function *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(Namespace *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(Block *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ForwardClassDeclaration *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCBaseClass *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCBaseProtocol *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCClass *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCForwardClassDeclaration *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCProtocol *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCForwardProtocolDeclaration *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCMethod *symbol) { simpleNode(symbol); return true; }
+    virtual bool visit(ObjCPropertyDeclaration *symbol) { simpleNode(symbol); return true; }
+
+private:
+    TranslationUnit *translationUnit;
+    QHash<Symbol *, QByteArray> _id;
+    QList<QPair<Symbol *,Symbol*> >_connections;
+    QList<Symbol *> _stack;
+    std::ofstream out;
+    Overview o;
+};
+
+int main(int argc, char *argv[])
+{
+    QCoreApplication app(argc, argv);
+
+    QStringList files = app.arguments();
+    files.removeFirst();
+
+    foreach (const QString &fileName, files) {
+        QFile file(fileName);
+        if (! file.open(QFile::ReadOnly)) {
+            std::cerr << "Cannot open \"" << qPrintable(fileName)
+                      << "\", skipping it." << std::endl;
+            continue;
+        }
+
+        const QByteArray source = file.readAll();
+        file.close();
+
+        Document::Ptr doc = Document::create(fileName);
+        doc->control()->setDiagnosticClient(0);
+        doc->setSource(source);
+        doc->parse();
+
+        doc->check();
+
+        ASTDump dump(doc->translationUnit());
+        dump(doc->translationUnit()->ast());
+
+        SymbolDump dump2(doc->translationUnit());
+        dump2(doc->globalNamespace());
+    }
+
+    return EXIT_SUCCESS;
+}

tests/tools/cplusplus-dump/tests/templ01.cpp

@@ -0,0 +1,17 @@
+
+struct QString
+{
+    void append(char ch);
+};
+
+template <typename _Tp> struct QList {
+    const _Tp &at(int index);
+};
+
+struct QStringList: public QList<QString> {};
+
+int main()
+{
+    QStringList l;
+    l.at(0).append('a'); 
+}