qmlprojectrunconfiguration.cpp 12.4 KB
Newer Older
Kai Koehne's avatar
Kai Koehne committed
1 2 3 4
/**************************************************************************
**
** This file is part of Qt Creator
**
hjk's avatar
hjk committed
5
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
Kai Koehne's avatar
Kai Koehne committed
6 7 8
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
con's avatar
con committed
9
** No Commercial Usage
Kai Koehne's avatar
Kai Koehne committed
10
**
con's avatar
con committed
11 12 13 14
** This file contains pre-release code and may not be distributed.
** You may use this file in accordance with the terms and conditions
** contained in the Technology Preview License Agreement accompanying
** this package.
Kai Koehne's avatar
Kai Koehne committed
15 16 17 18 19 20 21 22 23 24
**
** 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.
**
con's avatar
con committed
25 26 27 28 29 30
** In addition, as a special exception, Nokia gives you certain additional
** rights.  These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** If you have questions regarding the use of this file, please contact
** Nokia at qt-info@nokia.com.
Kai Koehne's avatar
Kai Koehne committed
31 32 33
**
**************************************************************************/

dt's avatar
dt committed
34
#include "qmlprojectrunconfiguration.h"
Kai Koehne's avatar
Kai Koehne committed
35 36
#include "qmlproject.h"
#include "qmlprojectmanagerconstants.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
#include <qt4projectmanager/qtversionmanager.h>
45
#include <qt4projectmanager/qtoutputformatter.h>
46
#include <qt4projectmanager/qt4projectmanagerconstants.h>
Kai Koehne's avatar
Kai Koehne committed
47 48 49 50 51 52 53

using Core::EditorManager;
using Core::ICore;
using Core::IEditor;
using Qt4ProjectManager::QtVersionManager;

using namespace QmlProjectManager::Internal;
Kai Koehne's avatar
Kai Koehne committed
54 55 56

namespace QmlProjectManager {

Kai Koehne's avatar
Kai Koehne committed
57
const char * const M_CURRENT_FILE = "CurrentFile";
Kai Koehne's avatar
Kai Koehne committed
58 59

QmlProjectRunConfiguration::QmlProjectRunConfiguration(QmlProjectTarget *parent) :
Kai Koehne's avatar
Kai Koehne committed
60
    ProjectExplorer::RunConfiguration(parent, QLatin1String(Constants::QML_RC_ID)),
61
    m_qtVersionId(-1),
62
    m_projectTarget(parent),
63
    m_usingCurrentFile(true),
64
    m_isEnabled(false)
Kai Koehne's avatar
Kai Koehne committed
65 66
{
    ctor();
67
    updateQtVersions();
Kai Koehne's avatar
Kai Koehne committed
68 69
}

Kai Koehne's avatar
Kai Koehne committed
70 71
QmlProjectRunConfiguration::QmlProjectRunConfiguration(QmlProjectTarget *parent,
                                                       QmlProjectRunConfiguration *source) :
Kai Koehne's avatar
Kai Koehne committed
72
    ProjectExplorer::RunConfiguration(parent, source),
73
    m_qtVersionId(source->m_qtVersionId),
Kai Koehne's avatar
Kai Koehne committed
74
    m_scriptFile(source->m_scriptFile),
75
    m_qmlViewerArgs(source->m_qmlViewerArgs),
76
    m_projectTarget(parent),
Kai Koehne's avatar
Kai Koehne committed
77
    m_usingCurrentFile(source->m_usingCurrentFile),
78
    m_userEnvironmentChanges(source->m_userEnvironmentChanges)
Kai Koehne's avatar
Kai Koehne committed
79
{
80
    ctor();
81
    updateQtVersions();
Kai Koehne's avatar
Kai Koehne committed
82 83
}

84 85 86 87
bool QmlProjectRunConfiguration::isEnabled(ProjectExplorer::BuildConfiguration *bc) const
{
    Q_UNUSED(bc);

88
    return m_isEnabled;
89 90
}

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

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

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

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

QmlProjectRunConfiguration::~QmlProjectRunConfiguration()
{
}

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

116
QString QmlProjectRunConfiguration::viewerPath() const
117
{
118 119
    Qt4ProjectManager::QtVersion *version = qtVersion();
    if (!version) {
120
        return QString();
121 122 123
    } else {
        return version->qmlviewerCommand();
    }
124 125
}

126
QString QmlProjectRunConfiguration::observerPath() const
Kai Koehne's avatar
Kai Koehne committed
127
{
128 129
    Qt4ProjectManager::QtVersion *version = qtVersion();
    if (!version) {
130
        return QString();
131 132 133
    } else {
        return version->qmlObserverTool();
    }
Kai Koehne's avatar
Kai Koehne committed
134 135
}

136
QString QmlProjectRunConfiguration::viewerArguments() const
Kai Koehne's avatar
Kai Koehne committed
137 138
{
    // arguments in .user file
139
    QString args = m_qmlViewerArgs;
Kai Koehne's avatar
Kai Koehne committed
140 141

    // arguments from .qmlproject file
142
    foreach (const QString &importPath, qmlTarget()->qmlProject()->importPaths()) {
143 144
        Utils::QtcProcess::addArg(&args, "-I");
        Utils::QtcProcess::addArg(&args, importPath);
Kai Koehne's avatar
Kai Koehne committed
145 146
    }

147 148 149
    const QString &s = mainScript();
    if (!s.isEmpty())
        Utils::QtcProcess::addArg(&args, s);
Kai Koehne's avatar
Kai Koehne committed
150 151 152 153 154 155 156 157 158
    return args;
}

QString QmlProjectRunConfiguration::workingDirectory() const
{
    QFileInfo projectFile(qmlTarget()->qmlProject()->file()->fileName());
    return projectFile.absolutePath();
}

159 160 161 162 163
int QmlProjectRunConfiguration::qtVersionId() const
{
    return m_qtVersionId;
}

164 165 166 167 168 169 170
void QmlProjectRunConfiguration::setQtVersionId(int id)
{
    if (m_qtVersionId == id)
        return;

    m_qtVersionId = id;
    qmlTarget()->qmlProject()->refresh(QmlProject::Configuration);
171 172
    if (m_configurationWidget)
        m_configurationWidget.data()->updateQtVersionComboBox();
173 174
}

175 176 177 178 179
Qt4ProjectManager::QtVersion *QmlProjectRunConfiguration::qtVersion() const
{
    if (m_qtVersionId == -1)
        return 0;

Kai Koehne's avatar
Kai Koehne committed
180
    QtVersionManager *versionManager = QtVersionManager::instance();
181 182 183 184 185 186
    Qt4ProjectManager::QtVersion *version = versionManager->version(m_qtVersionId);
    QTC_ASSERT(version, return 0);

    return version;
}

187
QWidget *QmlProjectRunConfiguration::createConfigurationWidget()
Kai Koehne's avatar
Kai Koehne committed
188
{
189 190 191
    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
192 193
}

194 195 196 197
ProjectExplorer::OutputFormatter *QmlProjectRunConfiguration::createOutputFormatter() const
{
    return new Qt4ProjectManager::QtOutputFormatter(qmlTarget()->qmlProject());
}
198

Kai Koehne's avatar
Kai Koehne committed
199 200 201 202 203 204 205 206 207 208 209 210 211 212
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
213 214
QString QmlProjectRunConfiguration::mainScript() const
{
Kai Koehne's avatar
Kai Koehne committed
215
    if (m_usingCurrentFile) {
216
        return m_currentFileFilename;
Kai Koehne's avatar
Kai Koehne committed
217 218 219 220 221
    }

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

Kai Koehne's avatar
Kai Koehne committed
223 224 225 226 227 228
    QString path = qmlTarget()->qmlProject()->mainFile();
    if (QFileInfo(path).isAbsolute()) {
        return path;
    } else {
        return qmlTarget()->qmlProject()->projectDir().absoluteFilePath(path);
    }
Kai Koehne's avatar
Kai Koehne committed
229 230
}

Kai Koehne's avatar
Kai Koehne committed
231 232
void QmlProjectRunConfiguration::setScriptSource(MainScriptSource source,
                                                 const QString &settingsPath)
Kai Koehne's avatar
Kai Koehne committed
233
{
234 235
    if (source == FileInEditor) {
        m_scriptFile = M_CURRENT_FILE;
Kai Koehne's avatar
Kai Koehne committed
236
        m_mainScriptFilename.clear();
237
        m_usingCurrentFile = true;
Kai Koehne's avatar
Kai Koehne committed
238 239 240 241 242 243 244 245
    } 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);
246 247
        m_usingCurrentFile = false;
    }
Kai Koehne's avatar
Kai Koehne committed
248 249 250
    updateEnabled();
    if (m_configurationWidget)
        m_configurationWidget.data()->updateFileComboBox();
Kai Koehne's avatar
Kai Koehne committed
251 252
}

253 254 255 256 257 258 259
Utils::Environment QmlProjectRunConfiguration::environment() const
{
    Utils::Environment env = baseEnvironment();
    env.modify(userEnvironmentChanges());
    return env;
}

Kai Koehne's avatar
Kai Koehne committed
260 261 262 263
QVariantMap QmlProjectRunConfiguration::toMap() const
{
    QVariantMap map(ProjectExplorer::RunConfiguration::toMap());

264
    map.insert(QLatin1String(Constants::QML_VIEWER_QT_KEY), m_qtVersionId);
Kai Koehne's avatar
Kai Koehne committed
265 266
    map.insert(QLatin1String(Constants::QML_VIEWER_ARGUMENTS_KEY), m_qmlViewerArgs);
    map.insert(QLatin1String(Constants::QML_MAINSCRIPT_KEY),  m_scriptFile);
267 268
    map.insert(QLatin1String(Constants::USER_ENVIRONMENT_CHANGES_KEY),
               Utils::EnvironmentItem::toStringList(m_userEnvironmentChanges));
Kai Koehne's avatar
Kai Koehne committed
269 270 271 272 273
    return map;
}

bool QmlProjectRunConfiguration::fromMap(const QVariantMap &map)
{
274
    setQtVersionId(map.value(QLatin1String(Constants::QML_VIEWER_QT_KEY), -1).toInt());
Kai Koehne's avatar
Kai Koehne committed
275
    m_qmlViewerArgs = map.value(QLatin1String(Constants::QML_VIEWER_ARGUMENTS_KEY)).toString();
276
    m_scriptFile = map.value(QLatin1String(Constants::QML_MAINSCRIPT_KEY), M_CURRENT_FILE).toString();
277 278 279
    m_userEnvironmentChanges = Utils::EnvironmentItem::fromStringList(
                map.value(QLatin1String(Constants::USER_ENVIRONMENT_CHANGES_KEY)).toStringList());

280 281

    updateQtVersions();
Kai Koehne's avatar
Kai Koehne committed
282 283 284 285 286 287 288
    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
289 290 291 292

    return RunConfiguration::fromMap(map);
}

293 294 295 296 297 298
void QmlProjectRunConfiguration::changeCurrentFile(Core::IEditor * /*editor*/)
{
    updateEnabled();
}

void QmlProjectRunConfiguration::updateEnabled()
299
{
300
    bool qmlFileFound = false;
301
    if (m_usingCurrentFile) {
302
        Core::IEditor *editor = Core::EditorManager::instance()->currentEditor();
Kai Koehne's avatar
Kai Koehne committed
303
        Core::MimeDatabase *db = ICore::instance()->mimeDatabase();
304 305
        if (editor) {
            m_currentFileFilename = editor->file()->fileName();
Kai Koehne's avatar
Kai Koehne committed
306
            if (db->findByFile(mainScript()).type() == QLatin1String("application/x-qml"))
307
                qmlFileFound = true;
308 309
        }
        if (!editor
Kai Koehne's avatar
Kai Koehne committed
310 311 312
            || db->findByFile(mainScript()).type() == QLatin1String("application/x-qmlproject")) {
            // find a qml file with lowercase filename. This is slow, but only done
            // in initialization/other border cases.
313
            foreach(const QString &filename, m_projectTarget->qmlProject()->files()) {
314 315 316
                const QFileInfo fi(filename);

                if (!filename.isEmpty() && fi.baseName()[0].isLower()
Kai Koehne's avatar
Kai Koehne committed
317
                    && db->findByFile(fi).type() == QLatin1String("application/x-qml"))
318 319
                {
                    m_currentFileFilename = filename;
320
                    qmlFileFound = true;
321 322 323 324
                    break;
                }

            }
325
        }
326
    } else { // use default one
Kai Koehne's avatar
Kai Koehne committed
327
        qmlFileFound = !mainScript().isEmpty();
328 329
    }

330 331
    bool newValue = (QFileInfo(viewerPath()).exists()
                    || QFileInfo(observerPath()).exists()) && qmlFileFound;
332

333 334 335 336

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

339
void QmlProjectRunConfiguration::updateQtVersions()
340
{
Kai Koehne's avatar
Kai Koehne committed
341
    QtVersionManager *qtVersions = QtVersionManager::instance();
342 343 344 345 346 347

    //
    // update m_qtVersionId
    //
    if (!qtVersions->isValidId(m_qtVersionId)
            || !isValidVersion(qtVersions->version(m_qtVersionId))) {
348
        int newVersionId = -1;
349 350 351
        // take first one you find
        foreach (Qt4ProjectManager::QtVersion *version, qtVersions->validVersions()) {
            if (isValidVersion(version)) {
352
                newVersionId = version->uniqueId();
353 354
                break;
            }
355
        }
356
        setQtVersionId(newVersionId);
357 358
    }

359 360 361 362 363 364
    updateEnabled();
}

bool QmlProjectRunConfiguration::isValidVersion(Qt4ProjectManager::QtVersion *version)
{
    if (version
365 366
            && (version->supportsTargetId(Qt4ProjectManager::Constants::DESKTOP_TARGET_ID)
                || version->supportsTargetId(Qt4ProjectManager::Constants::QT_SIMULATOR_TARGET_ID))
367 368 369 370
            && !version->qmlviewerCommand().isEmpty()) {
        return true;
    }
    return false;
371 372
}

373 374 375
Utils::Environment QmlProjectRunConfiguration::baseEnvironment() const
{
    Utils::Environment env;
376 377
    if (qtVersion())
        env = qtVersion()->qmlToolsEnvironment();
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
    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
396
} // namespace QmlProjectManager