qmlprojectrunconfiguration.cpp 11.1 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 "qmlprojectenvironmentaspect.h"
35
#include <coreplugin/mimedatabase.h>
Kai Koehne's avatar
Kai Koehne committed
36 37 38
#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>
#include <coreplugin/icore.h>
Tobias Hunger's avatar
Tobias Hunger committed
39
#include <projectexplorer/target.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
    m_isEnabled(source->m_isEnabled)
Kai Koehne's avatar
Kai Koehne committed
74
{
75
    ctor();
Kai Koehne's avatar
Kai Koehne committed
76 77
}

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

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

Kai Koehne's avatar
Kai Koehne committed
90 91
void QmlProjectRunConfiguration::ctor()
{
92
    // reset default settings in constructor
Kai Koehne's avatar
Kai Koehne committed
93
    EditorManager *em = Core::EditorManager::instance();
94 95 96
    connect(em, SIGNAL(currentEditorChanged(Core::IEditor*)),
            this, SLOT(changeCurrentFile(Core::IEditor*)));

Tobias Hunger's avatar
Tobias Hunger committed
97
    connect(target(), SIGNAL(kitChanged()),
Tobias Hunger's avatar
Tobias Hunger committed
98
            this, SLOT(updateEnabled()));
99

100 101 102 103
    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
104

105
    addExtraAspect(new QmlProjectEnvironmentAspect(this));
Kai Koehne's avatar
Kai Koehne committed
106 107
}

108
QString QmlProjectRunConfiguration::viewerPath() const
109
{
110
    QtSupport::BaseQtVersion *version = qtVersion();
Tobias Hunger's avatar
Tobias Hunger committed
111
    if (!version)
112
        return QString();
113 114 115

    if (id() == Constants::QML_SCENE_RC_ID)
        return version->qmlsceneCommand();
Tobias Hunger's avatar
Tobias Hunger committed
116
    else
117
        return version->qmlviewerCommand();
118 119
}

120
QString QmlProjectRunConfiguration::observerPath() const
Kai Koehne's avatar
Kai Koehne committed
121
{
122
    QtSupport::BaseQtVersion *version = qtVersion();
123
    if (!version) {
124
        return QString();
125
    } else {
126 127
        if (id() == Constants::QML_SCENE_RC_ID)
            return version->qmlsceneCommand();
128 129
        if (!version->needsQmlDebuggingLibrary())
            return version->qmlviewerCommand();
130 131
        return version->qmlObserverTool();
    }
Kai Koehne's avatar
Kai Koehne committed
132 133
}

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

    // arguments from .qmlproject file
140
    QmlProject *project = static_cast<QmlProject *>(target()->project());
141
    foreach (const QString &importPath, project->customImportPaths()) {
142
        Utils::QtcProcess::addArg(&args, QLatin1String("-I"));
143
        Utils::QtcProcess::addArg(&args, importPath);
Kai Koehne's avatar
Kai Koehne committed
144 145
    }

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

QString QmlProjectRunConfiguration::workingDirectory() const
{
156
    QFileInfo projectFile(target()->project()->document()->filePath());
157
    return canonicalCapsPath(projectFile.absolutePath());
Kai Koehne's avatar
Kai Koehne committed
158 159
}

160
/* QtDeclarative checks explicitly that the capitalization for any URL / path
161
   is exactly like the capitalization on disk.*/
162 163 164 165
QString QmlProjectRunConfiguration::canonicalCapsPath(const QString &fileName)
{
    QString canonicalPath = QFileInfo(fileName).canonicalFilePath();

166 167
#if defined(Q_OS_WIN)
    canonicalPath = Utils::normalizePathName(canonicalPath);
168
#endif
Kai Koehne's avatar
Kai Koehne committed
169

170 171 172 173
    return canonicalPath;
}


174
QtSupport::BaseQtVersion *QmlProjectRunConfiguration::qtVersion() const
175
{
Tobias Hunger's avatar
Tobias Hunger committed
176
    return QtSupport::QtKitInformation::qtVersion(target()->kit());
177 178
}

179
QWidget *QmlProjectRunConfiguration::createConfigurationWidget()
Kai Koehne's avatar
Kai Koehne committed
180
{
181 182 183
    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
184 185
}

con's avatar
con committed
186
Utils::OutputFormatter *QmlProjectRunConfiguration::createOutputFormatter() const
187
{
Tobias Hunger's avatar
Tobias Hunger committed
188
    return new QtSupport::QtOutputFormatter(target()->project());
189
}
190

Kai Koehne's avatar
Kai Koehne committed
191 192
QmlProjectRunConfiguration::MainScriptSource QmlProjectRunConfiguration::mainScriptSource() const
{
193
    QmlProject *project = static_cast<QmlProject *>(target()->project());
Tobias Hunger's avatar
Tobias Hunger committed
194
    if (!project->mainFile().isEmpty())
195
        return FileInProjectFile;
Tobias Hunger's avatar
Tobias Hunger committed
196
    if (!m_mainScriptFilename.isEmpty())
Kai Koehne's avatar
Kai Koehne committed
197
        return FileInSettings;
198
    return FileInEditor;
Kai Koehne's avatar
Kai Koehne committed
199 200 201 202 203
}

/**
  Returns absolute path to main script file.
  */
Kai Koehne's avatar
Kai Koehne committed
204 205
QString QmlProjectRunConfiguration::mainScript() const
{
Tobias Hunger's avatar
Tobias Hunger committed
206 207 208 209 210
    QmlProject *project = qobject_cast<QmlProject *>(target()->project());
    if (!project)
        return m_currentFileFilename;
    if (!project->mainFile().isEmpty()) {
        const QString pathInProject = project->mainFile();
211 212 213
        if (QFileInfo(pathInProject).isAbsolute())
            return pathInProject;
        else
Tobias Hunger's avatar
Tobias Hunger committed
214
            return project->projectDir().absoluteFilePath(pathInProject);
Kai Koehne's avatar
Kai Koehne committed
215 216
    }

217
    if (!m_mainScriptFilename.isEmpty())
Kai Koehne's avatar
Kai Koehne committed
218
        return m_mainScriptFilename;
Kai Koehne's avatar
Kai Koehne committed
219

220
    return m_currentFileFilename;
Kai Koehne's avatar
Kai Koehne committed
221 222
}

Kai Koehne's avatar
Kai Koehne committed
223 224
void QmlProjectRunConfiguration::setScriptSource(MainScriptSource source,
                                                 const QString &settingsPath)
Kai Koehne's avatar
Kai Koehne committed
225
{
226
    if (source == FileInEditor) {
227
        m_scriptFile = QLatin1String(M_CURRENT_FILE);
Kai Koehne's avatar
Kai Koehne committed
228 229 230 231 232 233 234
        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
235
                = target()->project()->projectDirectory() + QLatin1Char('/') + m_scriptFile;
236
    }
Kai Koehne's avatar
Kai Koehne committed
237 238 239
    updateEnabled();
    if (m_configurationWidget)
        m_configurationWidget.data()->updateFileComboBox();
Kai Koehne's avatar
Kai Koehne committed
240 241
}

242 243 244 245
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
246
                                ProjectExplorer::Abi::RuntimeQmlFormat, hostAbi.wordWidth());
247 248
}

Kai Koehne's avatar
Kai Koehne committed
249 250 251 252 253 254 255 256 257 258 259 260
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);
    return map;
}

bool QmlProjectRunConfiguration::fromMap(const QVariantMap &map)
{
    m_qmlViewerArgs = map.value(QLatin1String(Constants::QML_VIEWER_ARGUMENTS_KEY)).toString();
261
    m_scriptFile = map.value(QLatin1String(Constants::QML_MAINSCRIPT_KEY), QLatin1String(M_CURRENT_FILE)).toString();
262

263
    if (m_scriptFile == QLatin1String(M_CURRENT_FILE))
Kai Koehne's avatar
Kai Koehne committed
264
        setScriptSource(FileInEditor);
Tobias Hunger's avatar
Tobias Hunger committed
265
    else if (m_scriptFile.isEmpty())
Kai Koehne's avatar
Kai Koehne committed
266
        setScriptSource(FileInProjectFile);
Tobias Hunger's avatar
Tobias Hunger committed
267
    else
Kai Koehne's avatar
Kai Koehne committed
268
        setScriptSource(FileInSettings, m_scriptFile);
Kai Koehne's avatar
Kai Koehne committed
269 270 271 272

    return RunConfiguration::fromMap(map);
}

273
void QmlProjectRunConfiguration::changeCurrentFile(Core::IEditor *editor)
274
{
Tobias Hunger's avatar
Tobias Hunger committed
275
    if (editor)
276
        m_currentFileFilename = editor->document()->filePath();
277 278 279 280
    updateEnabled();
}

void QmlProjectRunConfiguration::updateEnabled()
281
{
282
    bool qmlFileFound = false;
283
    if (mainScriptSource() == FileInEditor) {
284
        Core::IDocument *document= Core::EditorManager::currentDocument();
hjk's avatar
hjk committed
285
        Core::MimeDatabase *db = ICore::mimeDatabase();
286 287
        if (document) {
            m_currentFileFilename = document->filePath();
Kai Koehne's avatar
Kai Koehne committed
288
            if (db->findByFile(mainScript()).type() == QLatin1String("application/x-qml"))
289
                qmlFileFound = true;
290
        }
291
        if (!document
Kai Koehne's avatar
Kai Koehne committed
292
                || db->findByFile(mainScript()).type() == QLatin1String("application/x-qmlproject")) {
Kai Koehne's avatar
Kai Koehne committed
293 294
            // 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
295
            foreach (const QString &filename, target()->project()->files(ProjectExplorer::Project::AllFiles)) {
296 297 298
                const QFileInfo fi(filename);

                if (!filename.isEmpty() && fi.baseName()[0].isLower()
Kai Koehne's avatar
Kai Koehne committed
299
                        && db->findByFile(fi).type() == QLatin1String("application/x-qml"))
300 301
                {
                    m_currentFileFilename = filename;
302
                    qmlFileFound = true;
303 304 305 306
                    break;
                }

            }
307
        }
308
    } else { // use default one
Kai Koehne's avatar
Kai Koehne committed
309
        qmlFileFound = !mainScript().isEmpty();
310 311
    }

312
    bool newValue = (QFileInfo(viewerPath()).exists()
Kai Koehne's avatar
Kai Koehne committed
313
                     || QFileInfo(observerPath()).exists()) && qmlFileFound;
314

315 316 317

    // Always emit change signal to force reevaluation of run/debug buttons
    m_isEnabled = newValue;
318
    emit enabledChanged();
319 320
}

321
bool QmlProjectRunConfiguration::isValidVersion(QtSupport::BaseQtVersion *version)
322 323
{
    if (version
324 325
            && (version->type() == QLatin1String(QtSupport::Constants::DESKTOPQT)
                || version->type() == QLatin1String(QtSupport::Constants::SIMULATORQT))
326 327 328 329
            && !version->qmlviewerCommand().isEmpty()) {
        return true;
    }
    return false;
330 331
}

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