qmlprojectrunconfiguration.cpp 13.3 KB
Newer Older
Kai Koehne's avatar
Kai Koehne committed
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
con's avatar
con committed
5
** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
Kai Koehne's avatar
Kai Koehne committed
6
**
hjk's avatar
hjk committed
7
** Contact: Nokia Corporation (info@qt.nokia.com)
Kai Koehne's avatar
Kai Koehne committed
8 9 10 11
**
**
** GNU Lesser General Public License Usage
**
hjk's avatar
hjk committed
12 13 14 15 16 17
** 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.
Kai Koehne's avatar
Kai Koehne committed
18
**
con's avatar
con committed
19
** In addition, as a special exception, Nokia gives you certain additional
hjk's avatar
hjk committed
20
** rights. These rights are described in the Nokia Qt LGPL Exception
con's avatar
con committed
21 22
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
23 24 25 26 27
** 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.
**
con's avatar
con committed
28
** If you have questions regarding the use of this file, please contact
Tobias Hunger's avatar
Tobias Hunger committed
29
** Nokia at info@qt.nokia.com.
Kai Koehne's avatar
Kai Koehne committed
30 31 32
**
**************************************************************************/

dt's avatar
dt committed
33
#include "qmlprojectrunconfiguration.h"
Kai Koehne's avatar
Kai Koehne committed
34 35
#include "qmlproject.h"
#include "qmlprojectmanagerconstants.h"
Friedemann Kleint's avatar
Friedemann Kleint committed
36
#include "qmlprojecttarget.h"
37
#include "qmlprojectrunconfigurationwidget.h"
38
#include <coreplugin/mimedatabase.h>
Kai Koehne's avatar
Kai Koehne committed
39 40 41
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/icore.h>
42
#include <utils/qtcassert.h>
43
#include <utils/qtcprocess.h>
44 45 46
#include <qtsupport/qtversionmanager.h>
#include <qtsupport/qtoutputformatter.h>
#include <qtsupport/qtsupportconstants.h>
Kai Koehne's avatar
Kai Koehne committed
47

48
#ifdef Q_OS_WIN
49
#include <utils/winutils.h>
50 51
#endif

Kai Koehne's avatar
Kai Koehne committed
52 53 54
using Core::EditorManager;
using Core::ICore;
using Core::IEditor;
55
using QtSupport::QtVersionManager;
Kai Koehne's avatar
Kai Koehne committed
56 57

using namespace QmlProjectManager::Internal;
Kai Koehne's avatar
Kai Koehne committed
58 59 60

namespace QmlProjectManager {

Kai Koehne's avatar
Kai Koehne committed
61
const char * const M_CURRENT_FILE = "CurrentFile";
Kai Koehne's avatar
Kai Koehne committed
62 63

QmlProjectRunConfiguration::QmlProjectRunConfiguration(QmlProjectTarget *parent) :
Kai Koehne's avatar
Kai Koehne committed
64
    ProjectExplorer::RunConfiguration(parent, QLatin1String(Constants::QML_RC_ID)),
65
    m_qtVersionId(-1),
66
    m_scriptFile(M_CURRENT_FILE),
67
    m_projectTarget(parent),
68
    m_usingCurrentFile(true),
69
    m_isEnabled(false)
Kai Koehne's avatar
Kai Koehne committed
70 71
{
    ctor();
72
    updateQtVersions();
Kai Koehne's avatar
Kai Koehne committed
73
}
Kai Koehne's avatar
Kai Koehne committed
74

Kai Koehne's avatar
Kai Koehne committed
75 76
QmlProjectRunConfiguration::QmlProjectRunConfiguration(QmlProjectTarget *parent,
                                                       QmlProjectRunConfiguration *source) :
Kai Koehne's avatar
Kai Koehne committed
77
    ProjectExplorer::RunConfiguration(parent, source),
78
    m_qtVersionId(source->m_qtVersionId),
Kai Koehne's avatar
Kai Koehne committed
79
    m_scriptFile(source->m_scriptFile),
80
    m_qmlViewerArgs(source->m_qmlViewerArgs),
81
    m_projectTarget(parent),
Kai Koehne's avatar
Kai Koehne committed
82
    m_usingCurrentFile(source->m_usingCurrentFile),
83
    m_userEnvironmentChanges(source->m_userEnvironmentChanges)
Kai Koehne's avatar
Kai Koehne committed
84
{
85
    ctor();
86
    updateQtVersions();
Kai Koehne's avatar
Kai Koehne committed
87 88
}

89 90 91 92
bool QmlProjectRunConfiguration::isEnabled(ProjectExplorer::BuildConfiguration *bc) const
{
    Q_UNUSED(bc);

93
    return m_isEnabled;
94 95
}

Kai Koehne's avatar
Kai Koehne committed
96 97
void QmlProjectRunConfiguration::ctor()
{
98 99 100 101
    // reset default settings in constructor
    setUseCppDebugger(false);
    setUseQmlDebugger(true);

Kai Koehne's avatar
Kai Koehne committed
102
    EditorManager *em = Core::EditorManager::instance();
103 104 105
    connect(em, SIGNAL(currentEditorChanged(Core::IEditor*)),
            this, SLOT(changeCurrentFile(Core::IEditor*)));

Kai Koehne's avatar
Kai Koehne committed
106
    QtVersionManager *qtVersions = QtVersionManager::instance();
107
    connect(qtVersions, SIGNAL(qtVersionsChanged(QList<int>)), this, SLOT(updateQtVersions()));
108

109
    setDisplayName(tr("QML Viewer", "QMLRunConfiguration display name."));
Kai Koehne's avatar
Kai Koehne committed
110 111 112 113 114 115
}

QmlProjectRunConfiguration::~QmlProjectRunConfiguration()
{
}

Kai Koehne's avatar
Kai Koehne committed
116
QmlProjectTarget *QmlProjectRunConfiguration::qmlTarget() const
Kai Koehne's avatar
Kai Koehne committed
117
{
Kai Koehne's avatar
Kai Koehne committed
118
    return static_cast<QmlProjectTarget *>(target());
Kai Koehne's avatar
Kai Koehne committed
119 120
}

121
QString QmlProjectRunConfiguration::viewerPath() const
122
{
123
    QtSupport::BaseQtVersion *version = qtVersion();
124
    if (!version) {
125
        return QString();
126 127 128
    } else {
        return version->qmlviewerCommand();
    }
129 130
}

131
QString QmlProjectRunConfiguration::observerPath() const
Kai Koehne's avatar
Kai Koehne committed
132
{
133
    QtSupport::BaseQtVersion *version = qtVersion();
134
    if (!version) {
135
        return QString();
136
    } else {
137 138
        if (!version->needsQmlDebuggingLibrary())
            return version->qmlviewerCommand();
139 140
        return version->qmlObserverTool();
    }
Kai Koehne's avatar
Kai Koehne committed
141 142
}

143
QString QmlProjectRunConfiguration::viewerArguments() const
Kai Koehne's avatar
Kai Koehne committed
144 145
{
    // arguments in .user file
146
    QString args = m_qmlViewerArgs;
Kai Koehne's avatar
Kai Koehne committed
147 148

    // arguments from .qmlproject file
149
    foreach (const QString &importPath, qmlTarget()->qmlProject()->importPaths()) {
150 151
        Utils::QtcProcess::addArg(&args, "-I");
        Utils::QtcProcess::addArg(&args, importPath);
Kai Koehne's avatar
Kai Koehne committed
152 153
    }

154 155 156
    QString s = mainScript();
    if (!s.isEmpty()) {
        s = canonicalCapsPath(s);
157
        Utils::QtcProcess::addArg(&args, s);
158
    }
Kai Koehne's avatar
Kai Koehne committed
159 160 161 162 163 164
    return args;
}

QString QmlProjectRunConfiguration::workingDirectory() const
{
    QFileInfo projectFile(qmlTarget()->qmlProject()->file()->fileName());
165
    return canonicalCapsPath(projectFile.absolutePath());
Kai Koehne's avatar
Kai Koehne committed
166 167
}

168 169 170 171 172
int QmlProjectRunConfiguration::qtVersionId() const
{
    return m_qtVersionId;
}

173 174 175 176 177 178 179
void QmlProjectRunConfiguration::setQtVersionId(int id)
{
    if (m_qtVersionId == id)
        return;

    m_qtVersionId = id;
    qmlTarget()->qmlProject()->refresh(QmlProject::Configuration);
180 181
    if (m_configurationWidget)
        m_configurationWidget.data()->updateQtVersionComboBox();
182 183
}

184
/* QtDeclarative checks explicitly that the capitalization for any URL / path
185
   is exactly like the capitalization on disk.*/
186 187 188 189
QString QmlProjectRunConfiguration::canonicalCapsPath(const QString &fileName)
{
    QString canonicalPath = QFileInfo(fileName).canonicalFilePath();

190 191
#if defined(Q_OS_WIN)
    canonicalPath = Utils::normalizePathName(canonicalPath);
192
#endif
Kai Koehne's avatar
Kai Koehne committed
193

194 195 196 197
    return canonicalPath;
}


198
QtSupport::BaseQtVersion *QmlProjectRunConfiguration::qtVersion() const
199 200 201 202
{
    if (m_qtVersionId == -1)
        return 0;

203 204
    QtSupport::QtVersionManager *versionManager = QtSupport::QtVersionManager::instance();
    QtSupport::BaseQtVersion *version = versionManager->version(m_qtVersionId);
205 206 207 208 209
    QTC_ASSERT(version, return 0);

    return version;
}

210
QWidget *QmlProjectRunConfiguration::createConfigurationWidget()
Kai Koehne's avatar
Kai Koehne committed
211
{
212 213 214
    QTC_ASSERT(m_configurationWidget.isNull(), return m_configurationWidget.data());
    m_configurationWidget = new QmlProjectRunConfigurationWidget(this);
    return m_configurationWidget.data();
Kai Koehne's avatar
Kai Koehne committed
215 216
}

con's avatar
con committed
217
Utils::OutputFormatter *QmlProjectRunConfiguration::createOutputFormatter() const
218
{
219
    return new QtSupport::QtOutputFormatter(qmlTarget()->qmlProject());
220
}
221

Kai Koehne's avatar
Kai Koehne committed
222 223 224 225 226 227 228 229 230 231 232 233 234 235
QmlProjectRunConfiguration::MainScriptSource QmlProjectRunConfiguration::mainScriptSource() const
{
    if (m_usingCurrentFile) {
        return FileInEditor;
    }
    if (!m_mainScriptFilename.isEmpty()) {
        return FileInSettings;
    }
    return FileInProjectFile;
}

/**
  Returns absolute path to main script file.
  */
Kai Koehne's avatar
Kai Koehne committed
236 237
QString QmlProjectRunConfiguration::mainScript() const
{
Kai Koehne's avatar
Kai Koehne committed
238
    if (m_usingCurrentFile) {
239
        return m_currentFileFilename;
Kai Koehne's avatar
Kai Koehne committed
240 241 242 243 244
    }

    if (!m_mainScriptFilename.isEmpty()) {
        return m_mainScriptFilename;
    }
Kai Koehne's avatar
Kai Koehne committed
245

246 247 248 249
    const QString path = qmlTarget()->qmlProject()->mainFile();
    if (path.isEmpty()) {
        return m_currentFileFilename;
    }
Kai Koehne's avatar
Kai Koehne committed
250 251 252 253 254
    if (QFileInfo(path).isAbsolute()) {
        return path;
    } else {
        return qmlTarget()->qmlProject()->projectDir().absoluteFilePath(path);
    }
Kai Koehne's avatar
Kai Koehne committed
255 256
}

Kai Koehne's avatar
Kai Koehne committed
257 258
void QmlProjectRunConfiguration::setScriptSource(MainScriptSource source,
                                                 const QString &settingsPath)
Kai Koehne's avatar
Kai Koehne committed
259
{
260 261
    if (source == FileInEditor) {
        m_scriptFile = M_CURRENT_FILE;
Kai Koehne's avatar
Kai Koehne committed
262
        m_mainScriptFilename.clear();
263
        m_usingCurrentFile = true;
Kai Koehne's avatar
Kai Koehne committed
264 265 266 267 268 269 270 271
    } else if (source == FileInProjectFile) {
        m_scriptFile.clear();
        m_mainScriptFilename.clear();
        m_usingCurrentFile = false;
    } else { // FileInSettings
        m_scriptFile = settingsPath;
        m_mainScriptFilename
                = qmlTarget()->qmlProject()->projectDir().absoluteFilePath(m_scriptFile);
272 273
        m_usingCurrentFile = false;
    }
Kai Koehne's avatar
Kai Koehne committed
274 275 276
    updateEnabled();
    if (m_configurationWidget)
        m_configurationWidget.data()->updateFileComboBox();
Kai Koehne's avatar
Kai Koehne committed
277 278
}

279 280 281 282 283 284 285
Utils::Environment QmlProjectRunConfiguration::environment() const
{
    Utils::Environment env = baseEnvironment();
    env.modify(userEnvironmentChanges());
    return env;
}

286 287 288 289
ProjectExplorer::Abi QmlProjectRunConfiguration::abi() const
{
    ProjectExplorer::Abi hostAbi = ProjectExplorer::Abi::hostAbi();
    return ProjectExplorer::Abi(hostAbi.architecture(), hostAbi.os(), hostAbi.osFlavor(),
hjk's avatar
hjk committed
290
                                ProjectExplorer::Abi::RuntimeQmlFormat, hostAbi.wordWidth());
291 292
}

Kai Koehne's avatar
Kai Koehne committed
293 294 295 296
QVariantMap QmlProjectRunConfiguration::toMap() const
{
    QVariantMap map(ProjectExplorer::RunConfiguration::toMap());

297
    map.insert(QLatin1String(Constants::QML_VIEWER_QT_KEY), m_qtVersionId);
Kai Koehne's avatar
Kai Koehne committed
298 299
    map.insert(QLatin1String(Constants::QML_VIEWER_ARGUMENTS_KEY), m_qmlViewerArgs);
    map.insert(QLatin1String(Constants::QML_MAINSCRIPT_KEY),  m_scriptFile);
300 301
    map.insert(QLatin1String(Constants::USER_ENVIRONMENT_CHANGES_KEY),
               Utils::EnvironmentItem::toStringList(m_userEnvironmentChanges));
Kai Koehne's avatar
Kai Koehne committed
302 303 304 305 306
    return map;
}

bool QmlProjectRunConfiguration::fromMap(const QVariantMap &map)
{
307
    setQtVersionId(map.value(QLatin1String(Constants::QML_VIEWER_QT_KEY), -1).toInt());
Kai Koehne's avatar
Kai Koehne committed
308
    m_qmlViewerArgs = map.value(QLatin1String(Constants::QML_VIEWER_ARGUMENTS_KEY)).toString();
309
    m_scriptFile = map.value(QLatin1String(Constants::QML_MAINSCRIPT_KEY), M_CURRENT_FILE).toString();
310 311 312
    m_userEnvironmentChanges = Utils::EnvironmentItem::fromStringList(
                map.value(QLatin1String(Constants::USER_ENVIRONMENT_CHANGES_KEY)).toStringList());

313 314

    updateQtVersions();
Kai Koehne's avatar
Kai Koehne committed
315 316 317 318 319 320 321
    if (m_scriptFile == M_CURRENT_FILE) {
        setScriptSource(FileInEditor);
    } else if (m_scriptFile.isEmpty()) {
        setScriptSource(FileInProjectFile);
    } else {
        setScriptSource(FileInSettings, m_scriptFile);
    }
Kai Koehne's avatar
Kai Koehne committed
322 323 324 325

    return RunConfiguration::fromMap(map);
}

326
void QmlProjectRunConfiguration::changeCurrentFile(Core::IEditor *editor)
327
{
328 329 330
    if (editor) {
        m_currentFileFilename = editor->file()->fileName();
    }
331 332 333 334
    updateEnabled();
}

void QmlProjectRunConfiguration::updateEnabled()
335
{
336
    bool qmlFileFound = false;
337
    if (m_usingCurrentFile) {
338
        Core::IEditor *editor = Core::EditorManager::instance()->currentEditor();
Kai Koehne's avatar
Kai Koehne committed
339
        Core::MimeDatabase *db = ICore::instance()->mimeDatabase();
340 341
        if (editor) {
            m_currentFileFilename = editor->file()->fileName();
Kai Koehne's avatar
Kai Koehne committed
342
            if (db->findByFile(mainScript()).type() == QLatin1String("application/x-qml"))
343
                qmlFileFound = true;
344 345
        }
        if (!editor
Kai Koehne's avatar
Kai Koehne committed
346
                || db->findByFile(mainScript()).type() == QLatin1String("application/x-qmlproject")) {
Kai Koehne's avatar
Kai Koehne committed
347 348
            // find a qml file with lowercase filename. This is slow, but only done
            // in initialization/other border cases.
349
            foreach(const QString &filename, m_projectTarget->qmlProject()->files()) {
350 351 352
                const QFileInfo fi(filename);

                if (!filename.isEmpty() && fi.baseName()[0].isLower()
Kai Koehne's avatar
Kai Koehne committed
353
                        && db->findByFile(fi).type() == QLatin1String("application/x-qml"))
354 355
                {
                    m_currentFileFilename = filename;
356
                    qmlFileFound = true;
357 358 359 360
                    break;
                }

            }
361
        }
362
    } else { // use default one
Kai Koehne's avatar
Kai Koehne committed
363
        qmlFileFound = !mainScript().isEmpty();
364 365
    }

366
    bool newValue = (QFileInfo(viewerPath()).exists()
Kai Koehne's avatar
Kai Koehne committed
367
                     || QFileInfo(observerPath()).exists()) && qmlFileFound;
368

369 370 371 372

    // Always emit change signal to force reevaluation of run/debug buttons
    m_isEnabled = newValue;
    emit isEnabledChanged(m_isEnabled);
373 374
}

375
void QmlProjectRunConfiguration::updateQtVersions()
376
{
Kai Koehne's avatar
Kai Koehne committed
377
    QtVersionManager *qtVersions = QtVersionManager::instance();
378 379 380 381 382 383

    //
    // update m_qtVersionId
    //
    if (!qtVersions->isValidId(m_qtVersionId)
            || !isValidVersion(qtVersions->version(m_qtVersionId))) {
384
        int newVersionId = -1;
385
        // take first one you find
386
        foreach (QtSupport::BaseQtVersion *version, qtVersions->validVersions()) {
387
            if (isValidVersion(version)) {
388
                newVersionId = version->uniqueId();
389 390
                break;
            }
391
        }
392
        setQtVersionId(newVersionId);
393 394
    }

395 396 397
    updateEnabled();
}

398
bool QmlProjectRunConfiguration::isValidVersion(QtSupport::BaseQtVersion *version)
399 400
{
    if (version
401 402
            && (version->type() == QtSupport::Constants::DESKTOPQT
                || version->type() == QtSupport::Constants::SIMULATORQT)
403 404 405 406
            && !version->qmlviewerCommand().isEmpty()) {
        return true;
    }
    return false;
407 408
}

409 410 411
Utils::Environment QmlProjectRunConfiguration::baseEnvironment() const
{
    Utils::Environment env;
412 413
    if (qtVersion())
        env = qtVersion()->qmlToolsEnvironment();
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    return env;
}

void QmlProjectRunConfiguration::setUserEnvironmentChanges(const QList<Utils::EnvironmentItem> &diff)
{
    if (m_userEnvironmentChanges != diff) {
        m_userEnvironmentChanges = diff;
        if (m_configurationWidget)
            m_configurationWidget.data()->userEnvironmentChangesChanged();
    }
}

QList<Utils::EnvironmentItem> QmlProjectRunConfiguration::userEnvironmentChanges() const
{
    return m_userEnvironmentChanges;
}

Kai Koehne's avatar
Kai Koehne committed
431
} // namespace QmlProjectManager