qmlprojectrunconfiguration.cpp 12.4 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Kai Koehne's avatar
Kai Koehne committed
2
**
3
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
Kai Koehne's avatar
Kai Koehne committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
Kai Koehne's avatar
Kai Koehne committed
7
**
hjk's avatar
hjk committed
8 9 10 11 12 13 14
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
Kai Koehne's avatar
Kai Koehne committed
15 16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17 18 19 20 21 22 23 24 25
** 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.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
con's avatar
con committed
26 27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
Kai Koehne's avatar
Kai Koehne committed
29

dt's avatar
dt committed
30
#include "qmlprojectrunconfiguration.h"
Kai Koehne's avatar
Kai Koehne committed
31 32
#include "qmlproject.h"
#include "qmlprojectmanagerconstants.h"
33
#include "qmlprojectrunconfigurationwidget.h"
34
#include <coreplugin/mimedatabase.h>
Kai Koehne's avatar
Kai Koehne committed
35 36 37
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/icore.h>
Tobias Hunger's avatar
Tobias Hunger committed
38
#include <projectexplorer/target.h>
39
#include <utils/qtcassert.h>
40
#include <utils/qtcprocess.h>
Tobias Hunger's avatar
Tobias Hunger committed
41
#include <qtsupport/qtkitinformation.h>
42 43
#include <qtsupport/qtoutputformatter.h>
#include <qtsupport/qtsupportconstants.h>
Kai Koehne's avatar
Kai Koehne committed
44

45
#ifdef Q_OS_WIN
46
#include <utils/winutils.h>
47 48
#endif

Kai Koehne's avatar
Kai Koehne committed
49 50 51 52 53
using Core::EditorManager;
using Core::ICore;
using Core::IEditor;

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 60 61
QmlProjectRunConfiguration::QmlProjectRunConfiguration(ProjectExplorer::Target *parent,
                                                       Core::Id id) :
    ProjectExplorer::RunConfiguration(parent, id),
62
    m_scriptFile(QLatin1String(M_CURRENT_FILE)),
63
    m_isEnabled(false)
Kai Koehne's avatar
Kai Koehne committed
64 65
{
    ctor();
Kai Koehne's avatar
Kai Koehne committed
66
}
Kai Koehne's avatar
Kai Koehne committed
67

Tobias Hunger's avatar
Tobias Hunger committed
68
QmlProjectRunConfiguration::QmlProjectRunConfiguration(ProjectExplorer::Target *parent,
Kai Koehne's avatar
Kai Koehne committed
69
                                                       QmlProjectRunConfiguration *source) :
Kai Koehne's avatar
Kai Koehne committed
70
    ProjectExplorer::RunConfiguration(parent, source),
Kai Koehne's avatar
Kai Koehne committed
71
    m_scriptFile(source->m_scriptFile),
72
    m_qmlViewerArgs(source->m_qmlViewerArgs),
73 74
    m_isEnabled(source->m_isEnabled),
    m_userEnvironmentChanges(source->m_userEnvironmentChanges)
Kai Koehne's avatar
Kai Koehne committed
75
{
76
    ctor();
Kai Koehne's avatar
Kai Koehne committed
77 78
}

79
bool QmlProjectRunConfiguration::isEnabled() const
80
{
81
    return m_isEnabled;
82 83
}

dt_'s avatar
dt_ committed
84 85 86
QString QmlProjectRunConfiguration::disabledReason() const
{
    if (!m_isEnabled)
87
        return tr("No qmlviewer or qmlscene found.");
dt_'s avatar
dt_ committed
88 89 90
    return QString();
}

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

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

Tobias Hunger's avatar
Tobias Hunger committed
102
    connect(target(), SIGNAL(kitChanged()),
Tobias Hunger's avatar
Tobias Hunger committed
103
            this, SLOT(updateEnabled()));
104

105 106 107 108
    if (id() == Constants::QML_SCENE_RC_ID)
        setDisplayName(tr("QML Scene", "QMLRunConfiguration display name."));
    else
        setDisplayName(tr("QML Viewer", "QMLRunConfiguration display name."));
Kai Koehne's avatar
Kai Koehne committed
109 110 111 112 113 114
}

QmlProjectRunConfiguration::~QmlProjectRunConfiguration()
{
}

115
QString QmlProjectRunConfiguration::viewerPath() const
116
{
117
    QtSupport::BaseQtVersion *version = qtVersion();
Tobias Hunger's avatar
Tobias Hunger committed
118
    if (!version)
119
        return QString();
120 121 122

    if (id() == Constants::QML_SCENE_RC_ID)
        return version->qmlsceneCommand();
Tobias Hunger's avatar
Tobias Hunger committed
123
    else
124
        return version->qmlviewerCommand();
125 126
}

127
QString QmlProjectRunConfiguration::observerPath() const
Kai Koehne's avatar
Kai Koehne committed
128
{
129
    QtSupport::BaseQtVersion *version = qtVersion();
130
    if (!version) {
131
        return QString();
132
    } else {
133 134
        if (id() == Constants::QML_SCENE_RC_ID)
            return version->qmlsceneCommand();
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
    QmlProject *project = static_cast<QmlProject *>(target()->project());
148
    foreach (const QString &importPath, project->customImportPaths()) {
149
        Utils::QtcProcess::addArg(&args, QLatin1String("-I"));
150
        Utils::QtcProcess::addArg(&args, importPath);
Kai Koehne's avatar
Kai Koehne committed
151 152
    }

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

QString QmlProjectRunConfiguration::workingDirectory() const
{
Tobias Hunger's avatar
Tobias Hunger committed
163
    QFileInfo projectFile(target()->project()->document()->fileName());
164
    return canonicalCapsPath(projectFile.absolutePath());
Kai Koehne's avatar
Kai Koehne committed
165 166
}

167
/* QtDeclarative checks explicitly that the capitalization for any URL / path
168
   is exactly like the capitalization on disk.*/
169 170 171 172
QString QmlProjectRunConfiguration::canonicalCapsPath(const QString &fileName)
{
    QString canonicalPath = QFileInfo(fileName).canonicalFilePath();

173 174
#if defined(Q_OS_WIN)
    canonicalPath = Utils::normalizePathName(canonicalPath);
175
#endif
Kai Koehne's avatar
Kai Koehne committed
176

177 178 179 180
    return canonicalPath;
}


181
QtSupport::BaseQtVersion *QmlProjectRunConfiguration::qtVersion() const
182
{
Tobias Hunger's avatar
Tobias Hunger committed
183
    return QtSupport::QtKitInformation::qtVersion(target()->kit());
184 185
}

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

con's avatar
con committed
193
Utils::OutputFormatter *QmlProjectRunConfiguration::createOutputFormatter() const
194
{
Tobias Hunger's avatar
Tobias Hunger committed
195
    return new QtSupport::QtOutputFormatter(target()->project());
196
}
197

Kai Koehne's avatar
Kai Koehne committed
198 199
QmlProjectRunConfiguration::MainScriptSource QmlProjectRunConfiguration::mainScriptSource() const
{
200
    QmlProject *project = static_cast<QmlProject *>(target()->project());
Tobias Hunger's avatar
Tobias Hunger committed
201
    if (!project->mainFile().isEmpty())
202
        return FileInProjectFile;
Tobias Hunger's avatar
Tobias Hunger committed
203
    if (!m_mainScriptFilename.isEmpty())
Kai Koehne's avatar
Kai Koehne committed
204
        return FileInSettings;
205
    return FileInEditor;
Kai Koehne's avatar
Kai Koehne committed
206 207 208 209 210
}

/**
  Returns absolute path to main script file.
  */
Kai Koehne's avatar
Kai Koehne committed
211 212
QString QmlProjectRunConfiguration::mainScript() const
{
Tobias Hunger's avatar
Tobias Hunger committed
213 214 215 216 217
    QmlProject *project = qobject_cast<QmlProject *>(target()->project());
    if (!project)
        return m_currentFileFilename;
    if (!project->mainFile().isEmpty()) {
        const QString pathInProject = project->mainFile();
218 219 220
        if (QFileInfo(pathInProject).isAbsolute())
            return pathInProject;
        else
Tobias Hunger's avatar
Tobias Hunger committed
221
            return project->projectDir().absoluteFilePath(pathInProject);
Kai Koehne's avatar
Kai Koehne committed
222 223
    }

224
    if (!m_mainScriptFilename.isEmpty())
Kai Koehne's avatar
Kai Koehne committed
225
        return m_mainScriptFilename;
Kai Koehne's avatar
Kai Koehne committed
226

227
    return m_currentFileFilename;
Kai Koehne's avatar
Kai Koehne committed
228 229
}

Kai Koehne's avatar
Kai Koehne committed
230 231
void QmlProjectRunConfiguration::setScriptSource(MainScriptSource source,
                                                 const QString &settingsPath)
Kai Koehne's avatar
Kai Koehne committed
232
{
233
    if (source == FileInEditor) {
234
        m_scriptFile = QLatin1String(M_CURRENT_FILE);
Kai Koehne's avatar
Kai Koehne committed
235 236 237 238 239 240 241
        m_mainScriptFilename.clear();
    } else if (source == FileInProjectFile) {
        m_scriptFile.clear();
        m_mainScriptFilename.clear();
    } else { // FileInSettings
        m_scriptFile = settingsPath;
        m_mainScriptFilename
Tobias Hunger's avatar
Tobias Hunger committed
242
                = target()->project()->projectDirectory() + QLatin1Char('/') + m_scriptFile;
243
    }
Kai Koehne's avatar
Kai Koehne committed
244 245 246
    updateEnabled();
    if (m_configurationWidget)
        m_configurationWidget.data()->updateFileComboBox();
Kai Koehne's avatar
Kai Koehne committed
247 248
}

249 250 251 252 253 254 255
Utils::Environment QmlProjectRunConfiguration::environment() const
{
    Utils::Environment env = baseEnvironment();
    env.modify(userEnvironmentChanges());
    return env;
}

256 257 258 259
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
260
                                ProjectExplorer::Abi::RuntimeQmlFormat, hostAbi.wordWidth());
261 262
}

Kai Koehne's avatar
Kai Koehne committed
263 264 265 266 267 268
QVariantMap QmlProjectRunConfiguration::toMap() const
{
    QVariantMap map(ProjectExplorer::RunConfiguration::toMap());

    map.insert(QLatin1String(Constants::QML_VIEWER_ARGUMENTS_KEY), m_qmlViewerArgs);
    map.insert(QLatin1String(Constants::QML_MAINSCRIPT_KEY),  m_scriptFile);
269 270
    map.insert(QLatin1String(Constants::USER_ENVIRONMENT_CHANGES_KEY),
               Utils::EnvironmentItem::toStringList(m_userEnvironmentChanges));
Kai Koehne's avatar
Kai Koehne committed
271 272 273 274 275 276
    return map;
}

bool QmlProjectRunConfiguration::fromMap(const QVariantMap &map)
{
    m_qmlViewerArgs = map.value(QLatin1String(Constants::QML_VIEWER_ARGUMENTS_KEY)).toString();
277
    m_scriptFile = map.value(QLatin1String(Constants::QML_MAINSCRIPT_KEY), QLatin1String(M_CURRENT_FILE)).toString();
278 279 280
    m_userEnvironmentChanges = Utils::EnvironmentItem::fromStringList(
                map.value(QLatin1String(Constants::USER_ENVIRONMENT_CHANGES_KEY)).toStringList());

281
    if (m_scriptFile == QLatin1String(M_CURRENT_FILE))
Kai Koehne's avatar
Kai Koehne committed
282
        setScriptSource(FileInEditor);
Tobias Hunger's avatar
Tobias Hunger committed
283
    else if (m_scriptFile.isEmpty())
Kai Koehne's avatar
Kai Koehne committed
284
        setScriptSource(FileInProjectFile);
Tobias Hunger's avatar
Tobias Hunger committed
285
    else
Kai Koehne's avatar
Kai Koehne committed
286
        setScriptSource(FileInSettings, m_scriptFile);
Kai Koehne's avatar
Kai Koehne committed
287 288 289 290

    return RunConfiguration::fromMap(map);
}

291
void QmlProjectRunConfiguration::changeCurrentFile(Core::IEditor *editor)
292
{
Tobias Hunger's avatar
Tobias Hunger committed
293
    if (editor)
294
        m_currentFileFilename = editor->document()->fileName();
295 296 297 298
    updateEnabled();
}

void QmlProjectRunConfiguration::updateEnabled()
299
{
300
    bool qmlFileFound = false;
301
    if (mainScriptSource() == FileInEditor) {
hjk's avatar
hjk committed
302
        Core::IEditor *editor = Core::EditorManager::currentEditor();
hjk's avatar
hjk committed
303
        Core::MimeDatabase *db = ICore::mimeDatabase();
304
        if (editor) {
305
            m_currentFileFilename = editor->document()->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
                || db->findByFile(mainScript()).type() == QLatin1String("application/x-qmlproject")) {
Kai Koehne's avatar
Kai Koehne committed
311 312
            // find a qml file with lowercase filename. This is slow, but only done
            // in initialization/other border cases.
Tobias Hunger's avatar
Tobias Hunger committed
313
            foreach (const QString &filename, target()->project()->files(ProjectExplorer::Project::AllFiles)) {
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
    bool newValue = (QFileInfo(viewerPath()).exists()
Kai Koehne's avatar
Kai Koehne committed
331
                     || QFileInfo(observerPath()).exists()) && qmlFileFound;
332

333 334 335

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

339
bool QmlProjectRunConfiguration::isValidVersion(QtSupport::BaseQtVersion *version)
340 341
{
    if (version
342 343
            && (version->type() == QLatin1String(QtSupport::Constants::DESKTOPQT)
                || version->type() == QLatin1String(QtSupport::Constants::SIMULATORQT))
344 345 346 347
            && !version->qmlviewerCommand().isEmpty()) {
        return true;
    }
    return false;
348 349
}

350 351 352
Utils::Environment QmlProjectRunConfiguration::baseEnvironment() const
{
    Utils::Environment env;
353 354
    if (qtVersion())
        env = qtVersion()->qmlToolsEnvironment();
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371
    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
372
} // namespace QmlProjectManager