Add generator for Clang compilation database

Change-Id: Ia82e2f7bcd93afbca88e7034aeadb0ba8c336458
Reviewed-by: Jake Petroules <jake.petroules@qt.io>

3 files changed, 211 insertions, 0 deletions

diff --git a/src/lib/corelib/generators/clangcompilationdb/clangcompilationdbgenerator.cpp b/src/lib/corelib/generators/clangcompilationdb/clangcompilationdbgenerator.cpp
new file mode 100644
index 000000000..b4b249732
--- /dev/null
+++ b/src/lib/corelib/generators/clangcompilationdb/clangcompilationdbgenerator.cpp
@@ -0,0 +1,151 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Christian Gagneraud.
+** Contact: http://www.qt.io/licensing
+**
+** This file is part of Qbs.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms and
+** conditions see http://www.qt.io/terms-conditions. For further information
+** use the contact form at http://www.qt.io/contact-us.
+**
+** 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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#include "clangcompilationdbgenerator.h"
+
+#include <api/projectdata.h>
+#include <logging/logger.h>
+#include <logging/translator.h>
+#include <tools/error.h>
+#include <tools/installoptions.h>
+#include <tools/shellutils.h>
+
+#include <QDir>
+#include <QFile>
+#include <QJsonArray>
+#include <QJsonDocument>
+#include <QJsonObject>
+
+namespace qbs {
+using namespace Internal;
+
+const QString ClangCompilationDatabaseGenerator::DefaultDatabaseFileName =
+        QStringLiteral("compile_commands.json");
+
+ClangCompilationDatabaseGenerator::ClangCompilationDatabaseGenerator()
+{
+}
+
+QString ClangCompilationDatabaseGenerator::generatorName() const
+{
+    return QStringLiteral("clangdb");
+}
+
+void ClangCompilationDatabaseGenerator::generate(const InstallOptions &installOptions)
+{
+    Q_UNUSED(installOptions);
+
+    for (const Project &project : projects()) {
+        QJsonArray database;
+        const ProjectData projectData = project.projectData();
+        const QString buildDir = projectData.buildDirectory();
+
+        for (const ProductData &productData : projectData.allProducts()) {
+            for (const GroupData &groupData : productData.groups()) {
+                for (const ArtifactData &sourceArtifact : groupData.allSourceArtifacts()) {
+                    if (!hasValidInputFileTag(sourceArtifact.fileTags()))
+                        continue;
+
+                    const QString filePath = sourceArtifact.filePath();
+                    ErrorInfo errorInfo;
+                    const RuleCommandList rules = project.ruleCommands(productData, filePath,
+                                                                       QStringLiteral("obj"),
+                                                                       &errorInfo);
+
+                    if (errorInfo.hasError())
+                        throw errorInfo;
+
+                    for (const RuleCommand &rule : rules) {
+                        if (rule.type() != RuleCommand::ProcessCommandType)
+                            continue;
+                        database.append(createEntry(filePath, buildDir, rule));
+                    }
+                }
+            }
+        }
+
+        writeProjectDatabase(QDir(buildDir).filePath(DefaultDatabaseFileName), database);
+    }
+}
+
+// See http://clang.llvm.org/docs/JSONCompilationDatabase.html
+QJsonObject ClangCompilationDatabaseGenerator::createEntry(const QString &filePath,
+                                                           const QString &buildDir,
+                                                           const RuleCommand &ruleCommand)
+{
+    QString workDir = ruleCommand.workingDirectory();
+    if (workDir.isEmpty())
+        workDir = buildDir;
+
+    const QStringList arguments = QStringList() << ruleCommand.executable()
+                                                << ruleCommand.arguments();
+
+    const QJsonObject object = {
+        { QStringLiteral("directory"), QJsonValue(workDir) },
+        { QStringLiteral("arguments"), QJsonArray::fromStringList(arguments) },
+        { QStringLiteral("file"), QJsonValue(filePath) }
+    };
+    return object;
+}
+
+void ClangCompilationDatabaseGenerator::writeProjectDatabase(const QString &filePath,
+                                                             const QJsonArray &entries)
+{
+    const QJsonDocument database(entries);
+    QFile databaseFile(filePath);
+
+    if (!databaseFile.open(QFile::WriteOnly))
+        throw ErrorInfo(Tr::tr("Cannot open '%1' for writing: %2")
+                        .arg(filePath)
+                        .arg(databaseFile.errorString()));
+
+    if (databaseFile.write(database.toJson()) == -1)
+        throw ErrorInfo(Tr::tr("Error while writing '%1': %2")
+                        .arg(filePath)
+                        .arg(databaseFile.errorString()));
+}
+
+bool ClangCompilationDatabaseGenerator::hasValidInputFileTag(const QStringList &fileTags) const
+{
+    static const QStringList validFileTags = {
+        QStringLiteral("c"),
+        QStringLiteral("cpp"),
+        QStringLiteral("objc"),
+        QStringLiteral("objcpp")
+    };
+
+    for (const QString &tag : fileTags) {
+        if (validFileTags.contains(tag))
+            return true;
+    }
+    return false;
+}
+
+} // namespace qbs
diff --git a/src/lib/corelib/generators/clangcompilationdb/clangcompilationdbgenerator.h b/src/lib/corelib/generators/clangcompilationdb/clangcompilationdbgenerator.h
new file mode 100644
index 000000000..7281e4211
--- /dev/null
+++ b/src/lib/corelib/generators/clangcompilationdb/clangcompilationdbgenerator.h
@@ -0,0 +1,58 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 Christian Gagneraud.
+** Contact: http://www.qt.io/licensing
+**
+** This file is part of Qbs.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms and
+** conditions see http://www.qt.io/terms-conditions. For further information
+** use the contact form at http://www.qt.io/contact-us.
+**
+** 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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef QBS_CLANGCOMPILATIONDATABASEGENERATOR_H
+#define QBS_CLANGCOMPILATIONDATABASEGENERATOR_H
+
+#include <generators/generator.h>
+
+namespace qbs {
+
+class SourceArtifact;
+class ProjectData;
+
+class ClangCompilationDatabaseGenerator : public ProjectGenerator
+{
+public:
+    ClangCompilationDatabaseGenerator();
+
+private:
+    QString generatorName() const override;
+    void generate(const InstallOptions &installOptions) override;
+    static const QString DefaultDatabaseFileName;
+    QJsonObject createEntry(const QString &filePath, const QString &buildDir,
+                            const RuleCommand &ruleCommand);
+    void writeProjectDatabase(const QString &filePath, const QJsonArray &entries);
+    bool hasValidInputFileTag(const QStringList &fileTags) const;
+};
+
+} // namespace qbs
+
+#endif // QBS_VISUALSTUDIOGENERATOR_H
diff --git a/src/lib/corelib/generators/generators.pri b/src/lib/corelib/generators/generators.pri
index 6372e8197..fa1e26ea9 100644
--- a/src/lib/corelib/generators/generators.pri
+++ b/src/lib/corelib/generators/generators.pri
@@ -1,2 +1,4 @@
 HEADERS += \
     $$PWD/generator.h
+
+include(clangcompilationdb/clangcompilationdb.pri)