qmldumptool.cpp 10.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32
/**************************************************************************
**
** 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 "qmldumptool.h"
#include "qt4project.h"
#include "qt4projectmanagerconstants.h"
33
#include "qtversionmanager.h"
34
#include <coreplugin/icore.h>
35
#include <coreplugin/progressmanager/progressmanager.h>
36 37

#include <projectexplorer/project.h>
38
#include <projectexplorer/projectexplorer.h>
39 40
#include <qtconcurrent/runextensions.h>
#include <qmljs/qmljsmodelmanagerinterface.h>
41 42 43 44
#include <QDesktopServices>
#include <QCoreApplication>
#include <QDir>
#include <QDebug>
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
#include <QHash>

namespace {
using namespace Qt4ProjectManager;

class QmlDumpBuildTask;

typedef QHash<int, QmlDumpBuildTask *> QmlDumpByVersion;
Q_GLOBAL_STATIC(QmlDumpByVersion, runningQmlDumpBuilds);

// A task suitable to be run by QtConcurrent to build qmldump.
class QmlDumpBuildTask : public QObject {
    Q_DISABLE_COPY(QmlDumpBuildTask)
    Q_OBJECT
public:
    explicit QmlDumpBuildTask(QtVersion *version)
        : m_version(*version)
    {
        runningQmlDumpBuilds()->insert(m_version.uniqueId(), this);
    }

    void run(QFutureInterface<void> &future)
    {
        future.setProgressRange(0, 5);
        future.setProgressValue(1);
        const QString output = m_version.buildDebuggingHelperLibrary(future, true);

        const QString qtInstallData = m_version.versionInfo().value("QT_INSTALL_DATA");
        QString path = QmlDumpTool::toolByInstallData(qtInstallData);
        if (path.isEmpty()) {
            qWarning() << "Could not build QML plugin dumping helper for " << m_version.displayName()
                       << "\nOutput:\n" << output;
        }

        // proceed in gui thread
        metaObject()->invokeMethod(this, "finish", Qt::QueuedConnection, Q_ARG(QString, path));
    }

    void updateProjectWhenDone(ProjectExplorer::Project *project)
    {
        m_projectsToUpdate.insert(project);
    }

public slots:
    void finish(QString qmldumpPath)
    {
        deleteLater();
        runningQmlDumpBuilds()->remove(m_version.uniqueId());

        if (qmldumpPath.isEmpty())
            return;

        // update qmldump path for all the project
        QmlJS::ModelManagerInterface *modelManager = QmlJS::ModelManagerInterface::instance();
        if (!modelManager)
            return;

        foreach (ProjectExplorer::Project *project, m_projectsToUpdate) {
            QmlJS::ModelManagerInterface::ProjectInfo projectInfo = modelManager->projectInfo(project);
            if (projectInfo.qmlDumpPath.isEmpty()) {
                projectInfo.qmlDumpPath = qmldumpPath;
                modelManager->updateProjectInfo(projectInfo);
            }
        }
    }

private:
    QSet<ProjectExplorer::Project *> m_projectsToUpdate;
    QtVersion m_version;
};
} // end of anonymous namespace

117 118 119 120 121 122 123 124 125 126 127 128

namespace Qt4ProjectManager {

static inline QStringList validBinaryFilenames()
{
    return QStringList()
            << QLatin1String("debug/qmldump.exe")
            << QLatin1String("qmldump.exe")
            << QLatin1String("qmldump")
            << QLatin1String("qmldump.app/Contents/MacOS/qmldump");
}

129
bool QmlDumpTool::canBuild(const QtVersion *qtVersion)
130
{
131 132 133
    const QString installHeaders = qtVersion->versionInfo().value("QT_INSTALL_HEADERS");
    const QString header = installHeaders + QLatin1String("/QtDeclarative/private/qdeclarativemetatype_p.h");
    return checkMinimumQtVersion(qtVersion->qtVersionString(), 4, 7, 1) || QFile::exists(header);
134 135
}

136
static QtVersion *qtVersionForProject(ProjectExplorer::Project *project)
137
{
138
    if (project && project->id() == Qt4ProjectManager::Constants::QT4PROJECT_ID) {
139 140
        Qt4Project *qt4Project = static_cast<Qt4Project*>(project);
        if (qt4Project && qt4Project->activeTarget()
141
                && qt4Project->activeTarget()->activeBuildConfiguration()) {
142
            QtVersion *version = qt4Project->activeTarget()->activeBuildConfiguration()->qtVersion();
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
            if (version->isValid())
                return version;
        }
        return 0;
    }

    // else, find any desktop Qt version that has qmldump, or - if there isn't any -
    // one that could build it
    QtVersion *desktopQt = 0;
    QtVersionManager *qtVersions = QtVersionManager::instance();
    foreach (QtVersion *version, qtVersions->validVersions()) {
        if (version->supportsTargetId(Constants::DESKTOP_TARGET_ID)) {
            const QString qtInstallData = version->versionInfo().value("QT_INSTALL_DATA");
            const QString path = QmlDumpTool::toolByInstallData(qtInstallData);
            if (!path.isEmpty())
                return version;

            if (!desktopQt && QmlDumpTool::canBuild(version)) {
                desktopQt = version;
162 163 164
            }
        }
    }
165 166 167 168 169 170 171 172 173 174 175 176 177

    return desktopQt;
}

QString QmlDumpTool::toolForProject(ProjectExplorer::Project *project)
{
    QtVersion *version = qtVersionForProject(project);
    if (version) {
        QString qtInstallData = version->versionInfo().value("QT_INSTALL_DATA");
        QString toolPath = toolByInstallData(qtInstallData);
        return toolPath;
    }

178 179 180
    return QString();
}

181
QString QmlDumpTool::toolByInstallData(const QString &qtInstallData)
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
{
    if (!Core::ICore::instance())
        return QString();

    const QString mainFilename = Core::ICore::instance()->resourcePath()
            + QLatin1String("/qml/qmldump/main.cpp");
    const QStringList directories = installDirectories(qtInstallData);
    const QStringList binFilenames = validBinaryFilenames();

    return byInstallDataHelper(mainFilename, directories, binFilenames);
}

QStringList QmlDumpTool::locationsByInstallData(const QString &qtInstallData)
{
    QStringList result;
    QFileInfo fileInfo;
    const QStringList binFilenames = validBinaryFilenames();
    foreach(const QString &directory, installDirectories(qtInstallData)) {
        if (getHelperFileInfoFor(binFilenames, directory, &fileInfo))
            result << fileInfo.filePath();
    }
    return result;
}

QString QmlDumpTool::build(const QString &directory, const QString &makeCommand,
                     const QString &qmakeCommand, const QString &mkspec,
                     const Utils::Environment &env, const QString &targetMode)
{
    return buildHelper(QCoreApplication::tr("qmldump"), QLatin1String("qmldump.pro"),
                       directory, makeCommand, qmakeCommand, mkspec, env, targetMode);
}

QString QmlDumpTool::copy(const QString &qtInstallData, QString *errorMessage)
{
    const QStringList directories = QmlDumpTool::installDirectories(qtInstallData);

    QStringList files;
    files << QLatin1String("main.cpp") << QLatin1String("qmldump.pro")
          << QLatin1String("LICENSE.LGPL") << QLatin1String("LGPL_EXCEPTION.TXT");

    QString sourcePath = Core::ICore::instance()->resourcePath() + QLatin1String("/qml/qmldump/");

    // Try to find a writeable directory.
    foreach(const QString &directory, directories)
        if (copyFiles(sourcePath, files, directory, errorMessage)) {
            errorMessage->clear();
            return directory;
        }
230 231
    *errorMessage = QCoreApplication::translate("ProjectExplorer::QmlDumpTool",
                                                "qmldump could not be built in any of the directories:\n- %1\n\nReason: %2")
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
                    .arg(directories.join(QLatin1String("\n- ")), *errorMessage);
    return QString();
}

QStringList QmlDumpTool::installDirectories(const QString &qtInstallData)
{
    const QChar slash = QLatin1Char('/');
    const uint hash = qHash(qtInstallData);
    QStringList directories;
    directories
            << (qtInstallData + QLatin1String("/qtc-qmldump/"))
            << QDir::cleanPath((QCoreApplication::applicationDirPath() + QLatin1String("/../qtc-qmldump/") + QString::number(hash))) + slash
            << (QDesktopServices::storageLocation(QDesktopServices::DataLocation) + QLatin1String("/qtc-qmldump/") + QString::number(hash)) + slash;
    return directories;
}

248
QString QmlDumpTool::qmlDumpPath(ProjectExplorer::Project *project)
249 250 251
{
    QString path;

252 253 254 255 256 257 258 259 260 261 262 263 264
    path = Qt4ProjectManager::QmlDumpTool::toolForProject(project);

    QtVersion *version = qtVersionForProject(project);
    if (version && path.isEmpty()) {
        if (runningQmlDumpBuilds()->contains(version->uniqueId())) {
            runningQmlDumpBuilds()->value(version->uniqueId())->updateProjectWhenDone(project);
        } else {
            QmlDumpBuildTask *buildTask = new QmlDumpBuildTask(version);
            buildTask->updateProjectWhenDone(project);
            QFuture<void> task = QtConcurrent::run(&QmlDumpBuildTask::run, buildTask);
            const QString taskName = QmlDumpBuildTask::tr("Building helper");
            Core::ICore::instance()->progressManager()->addTask(task, taskName,
                                                                QLatin1String("Qt4ProjectManager::BuildHelpers"));
265
        }
266
        return path;
267
    }
268 269 270 271 272 273 274 275 276 277

    if (!path.isEmpty()) {
        QFileInfo qmldumpFileInfo(path);
        if (!qmldumpFileInfo.exists()) {
            qWarning() << "QmlDumpTool::qmlDumpPath: qmldump executable does not exist at" << path;
            path.clear();
        } else if (!qmldumpFileInfo.isFile()) {
            qWarning() << "QmlDumpTool::qmlDumpPath: " << path << " is not a file";
            path.clear();
        }
278 279 280 281 282
    }

    return path;
}

283 284 285
} // namespace Qt4ProjectManager

#include "qmldumptool.moc"