QmlProjectManager: Aspect-ify runconfiguration

Split the remaining manually managed data into a standard ArgumentsAspect and a new MainQmlFileAspect. Change-Id: I8a8fe3f4a08d602a7b6e9c9463d3d7de257b6e6c Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
2018-09-07 08:27:44 +02:00
parent 53f0e6c0ee
commit 097de6c5d0
6 changed files with 265 additions and 366 deletions
--- a/src/plugins/qmlprojectmanager/qmlprojectrunconfiguration.cpp
+++ b/src/plugins/qmlprojectmanager/qmlprojectrunconfiguration.cpp
@@ -26,13 +26,16 @@
 #include "qmlprojectrunconfiguration.h"
 #include "qmlproject.h"
 #include "qmlprojectmanagerconstants.h"
-#include "qmlprojectrunconfigurationwidget.h"
 #include "qmlprojectenvironmentaspect.h"
+
 #include <coreplugin/editormanager/editormanager.h>
 #include <coreplugin/editormanager/ieditor.h>
 #include <coreplugin/icore.h>
 #include <coreplugin/idocument.h>
+
+#include <projectexplorer/projectexplorer.h>
 #include <projectexplorer/target.h>
+
 #include <qtsupport/qtkitinformation.h>
 #include <qtsupport/qtoutputformatter.h>
 #include <qtsupport/qtsupportconstants.h>
@@ -44,6 +47,11 @@
 #include <utils/winutils.h>
 #include <qmljstools/qmljstoolsconstants.h>

+#include <QComboBox>
+#include <QCoreApplication>
+#include <QFormLayout>
+#include <QStandardItem>
+
 using namespace Core;
 using namespace ProjectExplorer;
 using namespace QtSupport;
@@ -51,6 +59,225 @@ using namespace QtSupport;
 namespace QmlProjectManager {

 const char M_CURRENT_FILE[] = "CurrentFile";
+const char CURRENT_FILE[]  = QT_TRANSLATE_NOOP("QmlManager", "<Current File>");
+
+static bool caseInsensitiveLessThan(const QString &s1, const QString &s2)
+{
+    return s1.toLower() < s2.toLower();
+}
+
+// MainQmlFileAspect
+
+class MainQmlFileAspect : public IRunConfigurationAspect
+{
+public:
+    MainQmlFileAspect(RunConfiguration *rc);
+    ~MainQmlFileAspect() { delete m_fileListCombo; }
+
+    enum MainScriptSource {
+        FileInEditor,
+        FileInProjectFile,
+        FileInSettings
+    };
+
+    void addToConfigurationLayout(QFormLayout *layout) final;
+    void toMap(QVariantMap &map) const final;
+    void fromMap(const QVariantMap &map) final;
+
+    void updateFileComboBox();
+    MainScriptSource mainScriptSource() const;
+    void setMainScript(int index);
+
+    void setScriptSource(MainScriptSource source, const QString &settingsPath = QString());
+
+    QString mainScript() const;
+    void changeCurrentFile(IEditor *editor = nullptr);
+    bool isQmlFilePresent();
+
+public:
+    QPointer<QComboBox> m_fileListCombo;
+    QStandardItemModel m_fileListModel;
+    QString m_scriptFile;
+    // absolute path to current file (if being used)
+    QString m_currentFileFilename;
+    // absolute path to selected main script (if being used)
+    QString m_mainScriptFilename;
+};
+
+MainQmlFileAspect::MainQmlFileAspect(RunConfiguration *rc)
+    : IRunConfigurationAspect(rc)
+{
+    m_scriptFile = M_CURRENT_FILE;
+
+    connect(EditorManager::instance(), &EditorManager::currentEditorChanged,
+            this, &MainQmlFileAspect::changeCurrentFile);
+    connect(EditorManager::instance(), &EditorManager::currentDocumentStateChanged,
+            this, [this] { changeCurrentFile(); });
+}
+
+void MainQmlFileAspect::addToConfigurationLayout(QFormLayout *layout)
+{
+    QTC_ASSERT(!m_fileListCombo, delete m_fileListCombo);
+    m_fileListCombo = new QComboBox;
+    m_fileListCombo->setModel(&m_fileListModel);
+
+    updateFileComboBox();
+
+    connect(ProjectExplorerPlugin::instance(), &ProjectExplorerPlugin::fileListChanged,
+            this, &MainQmlFileAspect::updateFileComboBox);
+    connect(m_fileListCombo, static_cast<void (QComboBox::*)(int)>(&QComboBox::activated),
+            this, &MainQmlFileAspect::setMainScript);
+
+    layout->addRow(QmlProjectRunConfiguration::tr("Main QML file:"), m_fileListCombo);
+}
+
+void MainQmlFileAspect::toMap(QVariantMap &map) const
+{
+    map.insert(QLatin1String(Constants::QML_MAINSCRIPT_KEY), m_scriptFile);
+}
+
+void MainQmlFileAspect::fromMap(const QVariantMap &map)
+{
+    m_scriptFile = map.value(QLatin1String(Constants::QML_MAINSCRIPT_KEY),
+                             QLatin1String(M_CURRENT_FILE)).toString();
+
+    if (m_scriptFile == QLatin1String(M_CURRENT_FILE))
+        setScriptSource(FileInEditor);
+    else if (m_scriptFile.isEmpty())
+        setScriptSource(FileInProjectFile);
+    else
+        setScriptSource(FileInSettings, m_scriptFile);
+}
+
+void MainQmlFileAspect::updateFileComboBox()
+{
+    Project *project = runConfiguration()->target()->project();
+    QDir projectDir(project->projectDirectory().toString());
+
+    if (mainScriptSource() == FileInProjectFile) {
+        const QString mainScriptInFilePath = projectDir.relativeFilePath(mainScript());
+        m_fileListModel.clear();
+        m_fileListModel.appendRow(new QStandardItem(mainScriptInFilePath));
+        if (m_fileListCombo)
+            m_fileListCombo->setEnabled(false);
+        return;
+    }
+
+    if (m_fileListCombo)
+        m_fileListCombo->setEnabled(true);
+    m_fileListModel.clear();
+    m_fileListModel.appendRow(new QStandardItem(QLatin1String(CURRENT_FILE)));
+    QModelIndex currentIndex;
+
+    QStringList sortedFiles = Utils::transform(project->files(Project::AllFiles),
+                                               &Utils::FileName::toString);
+
+    // make paths relative to project directory
+    QStringList relativeFiles;
+    for (const QString &fn : qAsConst(sortedFiles))
+        relativeFiles += projectDir.relativeFilePath(fn);
+    sortedFiles = relativeFiles;
+
+    std::stable_sort(sortedFiles.begin(), sortedFiles.end(), caseInsensitiveLessThan);
+
+    QString mainScriptPath;
+    if (mainScriptSource() != FileInEditor)
+        mainScriptPath = projectDir.relativeFilePath(mainScript());
+
+    for (const QString &fn : qAsConst(sortedFiles)) {
+        QFileInfo fileInfo(fn);
+        if (fileInfo.suffix() != QLatin1String("qml"))
+            continue;
+
+        QStandardItem *item = new QStandardItem(fn);
+        m_fileListModel.appendRow(item);
+
+        if (mainScriptPath == fn)
+            currentIndex = item->index();
+    }
+
+    if (m_fileListCombo) {
+        if (currentIndex.isValid())
+            m_fileListCombo->setCurrentIndex(currentIndex.row());
+        else
+            m_fileListCombo->setCurrentIndex(0);
+    }
+}
+
+MainQmlFileAspect::MainScriptSource MainQmlFileAspect::mainScriptSource() const
+{
+    QmlProject *project = static_cast<QmlProject *>(runConfiguration()->target()->project());
+    if (!project->mainFile().isEmpty())
+        return FileInProjectFile;
+    if (!m_mainScriptFilename.isEmpty())
+        return FileInSettings;
+    return FileInEditor;
+}
+
+void MainQmlFileAspect::setMainScript(int index)
+{
+    if (index == 0) {
+        setScriptSource(FileInEditor);
+    } else {
+        const QString path = m_fileListModel.data(m_fileListModel.index(index, 0)).toString();
+        setScriptSource(FileInSettings, path);
+    }
+}
+
+void MainQmlFileAspect::setScriptSource(MainScriptSource source, const QString &settingsPath)
+{
+    if (source == FileInEditor) {
+        m_scriptFile = QLatin1String(M_CURRENT_FILE);
+        m_mainScriptFilename.clear();
+    } else if (source == FileInProjectFile) {
+        m_scriptFile.clear();
+        m_mainScriptFilename.clear();
+    } else { // FileInSettings
+        m_scriptFile = settingsPath;
+        Project *project = runConfiguration()->target()->project();
+        m_mainScriptFilename = project->projectDirectory().toString() + '/' + m_scriptFile;
+    }
+
+    qobject_cast<QmlProjectRunConfiguration *>(runConfiguration())->updateEnabledState();
+
+    updateFileComboBox();
+}
+
+/**
+  Returns absolute path to main script file.
+  */
+QString MainQmlFileAspect::mainScript() const
+{
+    QmlProject *project = qobject_cast<QmlProject *>(runConfiguration()->target()->project());
+    if (!project)
+        return m_currentFileFilename;
+    if (!project->mainFile().isEmpty()) {
+        const QString pathInProject = project->mainFile();
+        if (QFileInfo(pathInProject).isAbsolute())
+            return pathInProject;
+        else
+            return QDir(project->canonicalProjectDir().toString()).absoluteFilePath(pathInProject);
+    }
+
+    if (!m_mainScriptFilename.isEmpty())
+        return m_mainScriptFilename;
+
+    return m_currentFileFilename;
+}
+
+void MainQmlFileAspect::changeCurrentFile(IEditor *editor)
+{
+    if (!editor)
+        editor = EditorManager::currentEditor();
+
+    if (editor)
+        m_currentFileFilename = editor->document()->filePath().toString();
+
+    qobject_cast<QmlProjectRunConfiguration *>(runConfiguration())->updateEnabledState();
+}
+
+
+// QmlProjectRunConfiguration

 QmlProjectRunConfiguration::QmlProjectRunConfiguration(Target *target, Id id)
    : RunConfiguration(target, id)
@@ -61,17 +288,15 @@ QmlProjectRunConfiguration::QmlProjectRunConfiguration(Target *target, Id id)
    m_qmlViewerAspect->setPlaceHolderText(executable());
    m_qmlViewerAspect->setDisplayStyle(BaseStringAspect::LineEditDisplay);

-    setOutputFormatter<QtSupport::QtOutputFormatter>();
+    auto argumentAspect = addAspect<ArgumentsAspect>();
+    argumentAspect->setSettingsKey(Constants::QML_VIEWER_ARGUMENTS_KEY);

-    // reset default settings in constructor
-    connect(EditorManager::instance(), &EditorManager::currentEditorChanged,
-            this, &QmlProjectRunConfiguration::changeCurrentFile);
-    connect(EditorManager::instance(), &EditorManager::currentDocumentStateChanged,
-            this, [this] { changeCurrentFile(); });
+    m_mainQmlFileAspect = addAspect<MainQmlFileAspect>();
+
+    setOutputFormatter<QtSupport::QtOutputFormatter>();

    connect(target, &Target::kitChanged,
            this, &QmlProjectRunConfiguration::updateEnabledState);
-    m_scriptFile = M_CURRENT_FILE;

    setDisplayName(tr("QML Scene", "QMLRunConfiguration display name."));
    updateEnabledState();
@@ -131,7 +356,7 @@ QString QmlProjectRunConfiguration::executable() const
 QString QmlProjectRunConfiguration::commandLineArguments() const
 {
    // arguments in .user file
-    QString args = m_qmlViewerArgs;
+    QString args = extraAspect<ArgumentsAspect>()->arguments();
    const Target *currentTarget = target();
    const IDevice::ConstPtr device = DeviceKitInformation::device(currentTarget->kit());
    const Utils::OsType osType = device ? device->osType() : Utils::HostOsInfo::hostOs();
@@ -151,62 +376,6 @@ QString QmlProjectRunConfiguration::commandLineArguments() const
    return args;
 }

-QWidget *QmlProjectRunConfiguration::createConfigurationWidget()
-{
-    return wrapWidget(new Internal::QmlProjectRunConfigurationWidget(this));
-}
-
-QmlProjectRunConfiguration::MainScriptSource QmlProjectRunConfiguration::mainScriptSource() const
-{
-    QmlProject *project = static_cast<QmlProject *>(target()->project());
-    if (!project->mainFile().isEmpty())
-        return FileInProjectFile;
-    if (!m_mainScriptFilename.isEmpty())
-        return FileInSettings;
-    return FileInEditor;
-}
-
-/**
-  Returns absolute path to main script file.
-  */
-QString QmlProjectRunConfiguration::mainScript() const
-{
-    QmlProject *project = qobject_cast<QmlProject *>(target()->project());
-    if (!project)
-        return m_currentFileFilename;
-    if (!project->mainFile().isEmpty()) {
-        const QString pathInProject = project->mainFile();
-        if (QFileInfo(pathInProject).isAbsolute())
-            return pathInProject;
-        else
-            return QDir(project->canonicalProjectDir().toString()).absoluteFilePath(pathInProject);
-    }
-
-    if (!m_mainScriptFilename.isEmpty())
-        return m_mainScriptFilename;
-
-    return m_currentFileFilename;
-}
-
-void QmlProjectRunConfiguration::setScriptSource(MainScriptSource source,
-                                                 const QString &settingsPath)
-{
-    if (source == FileInEditor) {
-        m_scriptFile = QLatin1String(M_CURRENT_FILE);
-        m_mainScriptFilename.clear();
-    } else if (source == FileInProjectFile) {
-        m_scriptFile.clear();
-        m_mainScriptFilename.clear();
-    } else { // FileInSettings
-        m_scriptFile = settingsPath;
-        m_mainScriptFilename
-                = target()->project()->projectDirectory().toString() + QLatin1Char('/') + m_scriptFile;
-    }
-    updateEnabledState();
-
-    emit scriptSourceChanged();
-}
-
 Abi QmlProjectRunConfiguration::abi() const
 {
    Abi hostAbi = Abi::hostAbi();
@@ -214,41 +383,21 @@ Abi QmlProjectRunConfiguration::abi() const
               Abi::RuntimeQmlFormat, hostAbi.wordWidth());
 }

-QVariantMap QmlProjectRunConfiguration::toMap() const
-{
-    QVariantMap map(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();
-    m_scriptFile = map.value(QLatin1String(Constants::QML_MAINSCRIPT_KEY), QLatin1String(M_CURRENT_FILE)).toString();
-
-    if (m_scriptFile == QLatin1String(M_CURRENT_FILE))
-        setScriptSource(FileInEditor);
-    else if (m_scriptFile.isEmpty())
-        setScriptSource(FileInProjectFile);
-    else
-        setScriptSource(FileInSettings, m_scriptFile);
-
-    return RunConfiguration::fromMap(map);
-}
-
-void QmlProjectRunConfiguration::changeCurrentFile(IEditor *editor)
-{
-    if (!editor)
-        editor = EditorManager::currentEditor();
-
-    if (editor)
-        m_currentFileFilename = editor->document()->filePath().toString();
-    updateEnabledState();
-}
-
 void QmlProjectRunConfiguration::updateEnabledState()
+{
+    bool qmlFileFound = m_mainQmlFileAspect->isQmlFilePresent();
+    if (!qmlFileFound) {
+        setEnabled(false);
+    } else {
+        const QString exe = executable();
+        if (exe.isEmpty())
+            setEnabled(false);
+        else
+            RunConfiguration::updateEnabledState();
+    }
+}
+
+bool MainQmlFileAspect::isQmlFilePresent()
 {
    bool qmlFileFound = false;
    if (mainScriptSource() == FileInEditor) {
@@ -267,7 +416,8 @@ void QmlProjectRunConfiguration::updateEnabledState()
                || mainScriptMimeType.matchesName(QLatin1String(QmlJSTools::Constants::QMLPROJECT_MIMETYPE))) {
            // find a qml file with lowercase filename. This is slow, but only done
            // in initialization/other border cases.
-            foreach (const Utils::FileName &filename, target()->project()->files(Project::AllFiles)) {
+            const auto files = runConfiguration()->target()->project()->files(Project::AllFiles);
+            for (const Utils::FileName &filename : files) {
                const QFileInfo fi = filename.toFileInfo();

                if (!filename.isEmpty() && fi.baseName()[0].isLower()) {
@@ -280,23 +430,17 @@ void QmlProjectRunConfiguration::updateEnabledState()
                        break;
                    }
                }
-
            }
        }
    } else { // use default one
        qmlFileFound = !mainScript().isEmpty();
    }
+    return qmlFileFound;
+}

-    if (!qmlFileFound) {
-        setEnabled(false);
-    } else {
-        const QString exe = executable();
-        if (exe.isEmpty()) {
-            setEnabled(false);
-        } else {
-            RunConfiguration::updateEnabledState();
-        }
-    }
+QString QmlProjectRunConfiguration::mainScript() const
+{
+    return m_mainQmlFileAspect->mainScript();
 }

 namespace Internal {