qmlprojectrunconfiguration.cpp 13.2 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
bool QmlProjectRunConfiguration::isEnabled() const
90
{
91
    return m_isEnabled;
92 93
}

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

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

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

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

QmlProjectRunConfiguration::~QmlProjectRunConfiguration()
{
}

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

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

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

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

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

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

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

166 167 168 169 170
int QmlProjectRunConfiguration::qtVersionId() const
{
    return m_qtVersionId;
}

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

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

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

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

192 193 194 195
    return canonicalPath;
}


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

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

    return version;
}

208
QWidget *QmlProjectRunConfiguration::createConfigurationWidget()
Kai Koehne's avatar
Kai Koehne committed
209
{
210 211 212
    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
213 214
}

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

Kai Koehne's avatar
Kai Koehne committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233
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
234 235
QString QmlProjectRunConfiguration::mainScript() const
{
Kai Koehne's avatar
Kai Koehne committed
236
    if (m_usingCurrentFile) {
237
        return m_currentFileFilename;
Kai Koehne's avatar
Kai Koehne committed
238 239 240 241 242
    }

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

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

Kai Koehne's avatar
Kai Koehne committed
255 256
void QmlProjectRunConfiguration::setScriptSource(MainScriptSource source,
                                                 const QString &settingsPath)
Kai Koehne's avatar
Kai Koehne committed
257
{
258 259
    if (source == FileInEditor) {
        m_scriptFile = M_CURRENT_FILE;
Kai Koehne's avatar
Kai Koehne committed
260
        m_mainScriptFilename.clear();
261
        m_usingCurrentFile = true;
Kai Koehne's avatar
Kai Koehne committed
262 263 264 265 266 267 268 269
    } 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);
270 271
        m_usingCurrentFile = false;
    }
Kai Koehne's avatar
Kai Koehne committed
272 273 274
    updateEnabled();
    if (m_configurationWidget)
        m_configurationWidget.data()->updateFileComboBox();
Kai Koehne's avatar
Kai Koehne committed
275 276
}

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

284 285 286 287
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
288
                                ProjectExplorer::Abi::RuntimeQmlFormat, hostAbi.wordWidth());
289 290
}

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

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

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

311 312

    updateQtVersions();
Kai Koehne's avatar
Kai Koehne committed
313 314 315 316 317 318 319
    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
320 321 322 323

    return RunConfiguration::fromMap(map);
}

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

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

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

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

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

367 368 369 370

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

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

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

393 394 395
    updateEnabled();
}

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

407 408 409
Utils::Environment QmlProjectRunConfiguration::baseEnvironment() const
{
    Utils::Environment env;
410 411
    if (qtVersion())
        env = qtVersion()->qmlToolsEnvironment();
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428
    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
429
} // namespace QmlProjectManager