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 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
#ifdef Q_OS_WIN32
49
#include <utils/winutils.h>
50 51
#endif

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

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 124
    Qt4ProjectManager::QtVersion *version = qtVersion();
    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 134
    Qt4ProjectManager::QtVersion *version = qtVersion();
    if (!version) {
135
        return QString();
136 137 138
    } else {
        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 183 184 185 186 187 188 189
/* QtDeclarative checks explicitly that the capitalization for any URL / path
   is exactly like the capitalization on disk. This method is uses the same
   native Windows API's to get the exact canonical path. */
QString QmlProjectRunConfiguration::canonicalCapsPath(const QString &fileName)
{
    QString canonicalPath = QFileInfo(fileName).canonicalFilePath();

#if defined(Q_OS_WIN32)
190 191 192 193 194 195 196 197
    QString error;
    // don't know whether the shortpath step is really needed,
    // but we do this in QtDeclarative too.
    QString path = Utils::getShortPathName(canonicalPath, &error);
    if (!path.isEmpty())
        path = Utils::getLongPathName(canonicalPath, &error);
    if (!path.isEmpty())
        canonicalPath = path;
198
#endif
Kai Koehne's avatar
Kai Koehne committed
199

200 201 202 203
    return canonicalPath;
}


204 205 206 207 208
Qt4ProjectManager::QtVersion *QmlProjectRunConfiguration::qtVersion() const
{
    if (m_qtVersionId == -1)
        return 0;

Kai Koehne's avatar
Kai Koehne committed
209
    QtVersionManager *versionManager = QtVersionManager::instance();
210 211 212 213 214 215
    Qt4ProjectManager::QtVersion *version = versionManager->version(m_qtVersionId);
    QTC_ASSERT(version, return 0);

    return version;
}

216
QWidget *QmlProjectRunConfiguration::createConfigurationWidget()
Kai Koehne's avatar
Kai Koehne committed
217
{
218 219 220
    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
221 222
}

223 224 225 226
ProjectExplorer::OutputFormatter *QmlProjectRunConfiguration::createOutputFormatter() const
{
    return new Qt4ProjectManager::QtOutputFormatter(qmlTarget()->qmlProject());
}
227

Kai Koehne's avatar
Kai Koehne committed
228 229 230 231 232 233 234 235 236 237 238 239 240 241
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
242 243
QString QmlProjectRunConfiguration::mainScript() const
{
Kai Koehne's avatar
Kai Koehne committed
244
    if (m_usingCurrentFile) {
245
        return m_currentFileFilename;
Kai Koehne's avatar
Kai Koehne committed
246 247 248 249 250
    }

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

Kai Koehne's avatar
Kai Koehne committed
252 253 254 255 256 257
    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
258 259
}

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

282 283 284 285 286 287 288
Utils::Environment QmlProjectRunConfiguration::environment() const
{
    Utils::Environment env = baseEnvironment();
    env.modify(userEnvironmentChanges());
    return env;
}

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

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

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

309 310

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

    return RunConfiguration::fromMap(map);
}

322 323 324 325 326 327
void QmlProjectRunConfiguration::changeCurrentFile(Core::IEditor * /*editor*/)
{
    updateEnabled();
}

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

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

            }
354
        }
355
    } else { // use default one
Kai Koehne's avatar
Kai Koehne committed
356
        qmlFileFound = !mainScript().isEmpty();
357 358
    }

359
    bool newValue = (QFileInfo(viewerPath()).exists()
Kai Koehne's avatar
Kai Koehne committed
360
                     || QFileInfo(observerPath()).exists()) && qmlFileFound;
361

362 363 364 365

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

368
void QmlProjectRunConfiguration::updateQtVersions()
369
{
Kai Koehne's avatar
Kai Koehne committed
370
    QtVersionManager *qtVersions = QtVersionManager::instance();
371 372 373 374 375 376

    //
    // update m_qtVersionId
    //
    if (!qtVersions->isValidId(m_qtVersionId)
            || !isValidVersion(qtVersions->version(m_qtVersionId))) {
377
        int newVersionId = -1;
378 379 380
        // take first one you find
        foreach (Qt4ProjectManager::QtVersion *version, qtVersions->validVersions()) {
            if (isValidVersion(version)) {
381
                newVersionId = version->uniqueId();
382 383
                break;
            }
384
        }
385
        setQtVersionId(newVersionId);
386 387
    }

388 389 390 391 392 393
    updateEnabled();
}

bool QmlProjectRunConfiguration::isValidVersion(Qt4ProjectManager::QtVersion *version)
{
    if (version
394 395
            && (version->supportsTargetId(Qt4ProjectManager::Constants::DESKTOP_TARGET_ID)
                || version->supportsTargetId(Qt4ProjectManager::Constants::QT_SIMULATOR_TARGET_ID))
396 397 398 399
            && !version->qmlviewerCommand().isEmpty()) {
        return true;
    }
    return false;
400 401
}

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