Python: extract PythonRunConfiguration and PythonProject

Change-Id: I4ff0f43fdb8beb9a7f2f7816197de0c796da8d89 Reviewed-by: Christian Stenger <christian.stenger@qt.io>
2019-07-22 14:39:01 +02:00
parent 358574f44d
commit a90c9c6409
8 changed files with 958 additions and 787 deletions
--- a/src/plugins/python/pythonrunconfiguration.cpp
+++ b/src/plugins/python/pythonrunconfiguration.cpp
@@ -0,0 +1,332 @@
+/****************************************************************************
+**
+** Copyright (C) 2019 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of Qt Creator.
+**
+** 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 The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#include "pythonconstants.h"
+#include "pythonproject.h"
+#include "pythonrunconfiguration.h"
+#include "pythonsettings.h"
+
+#include <coreplugin/icore.h>
+#include <coreplugin/editormanager/editormanager.h>
+
+#include <projectexplorer/localenvironmentaspect.h>
+#include <projectexplorer/projectconfigurationaspects.h>
+#include <projectexplorer/runconfigurationaspects.h>
+#include <projectexplorer/target.h>
+#include <projectexplorer/taskhub.h>
+
+#include <utils/fileutils.h>
+#include <utils/outputformatter.h>
+#include <utils/theme/theme.h>
+
+#include <QBoxLayout>
+#include <QComboBox>
+#include <QFormLayout>
+#include <QPlainTextEdit>
+#include <QPushButton>
+
+using namespace ProjectExplorer;
+using namespace Utils;
+
+namespace Python {
+namespace Internal {
+
+static QTextCharFormat linkFormat(const QTextCharFormat &inputFormat, const QString &href)
+{
+    QTextCharFormat result = inputFormat;
+    result.setForeground(creatorTheme()->color(Theme::TextColorLink));
+    result.setUnderlineStyle(QTextCharFormat::SingleUnderline);
+    result.setAnchor(true);
+    result.setAnchorHref(href);
+    return result;
+}
+
+class PythonOutputFormatter : public OutputFormatter
+{
+public:
+    PythonOutputFormatter()
+        // Note that moc dislikes raw string literals.
+        : filePattern("^(\\s*)(File \"([^\"]+)\", line (\\d+), .*$)")
+    {
+        TaskHub::clearTasks(PythonErrorTaskCategory);
+    }
+
+private:
+    void appendMessage(const QString &text, OutputFormat format) final
+    {
+        const bool isTrace = (format == StdErrFormat
+                              || format == StdErrFormatSameLine)
+                          && (text.startsWith("Traceback (most recent call last):")
+                              || text.startsWith("\nTraceback (most recent call last):"));
+
+        if (!isTrace) {
+            OutputFormatter::appendMessage(text, format);
+            return;
+        }
+
+        const QTextCharFormat frm = charFormat(format);
+        const Core::Id id(PythonErrorTaskCategory);
+        QVector<Task> tasks;
+        const QStringList lines = text.split('\n');
+        unsigned taskId = unsigned(lines.size());
+
+        for (const QString &line : lines) {
+            const QRegularExpressionMatch match = filePattern.match(line);
+            if (match.hasMatch()) {
+                QTextCursor tc = plainTextEdit()->textCursor();
+                tc.movePosition(QTextCursor::End, QTextCursor::MoveAnchor);
+                tc.insertText('\n' + match.captured(1));
+                tc.insertText(match.captured(2), linkFormat(frm, match.captured(2)));
+
+                const auto fileName = FilePath::fromString(match.captured(3));
+                const int lineNumber = match.capturedRef(4).toInt();
+                Task task(Task::Warning,
+                                           QString(), fileName, lineNumber, id);
+                task.taskId = --taskId;
+                tasks.append(task);
+            } else {
+                if (!tasks.isEmpty()) {
+                    Task &task = tasks.back();
+                    if (!task.description.isEmpty())
+                        task.description += ' ';
+                    task.description += line.trimmed();
+                }
+                OutputFormatter::appendMessage('\n' + line, format);
+            }
+        }
+        if (!tasks.isEmpty()) {
+            tasks.back().type = Task::Error;
+            for (auto rit = tasks.crbegin(), rend = tasks.crend(); rit != rend; ++rit)
+                TaskHub::addTask(*rit);
+        }
+    }
+
+    void handleLink(const QString &href) final
+    {
+        const QRegularExpressionMatch match = filePattern.match(href);
+        if (!match.hasMatch())
+            return;
+        const QString fileName = match.captured(3);
+        const int lineNumber = match.capturedRef(4).toInt();
+        Core::EditorManager::openEditorAt(fileName, lineNumber);
+    }
+
+    const QRegularExpression filePattern;
+};
+
+////////////////////////////////////////////////////////////////
+
+class InterpreterAspect : public ProjectConfigurationAspect
+{
+    Q_OBJECT
+
+public:
+    InterpreterAspect() = default;
+
+    Interpreter currentInterpreter() const;
+    void updateInterpreters(const QList<Interpreter> &interpreters);
+    void setDefaultInterpreter(const Interpreter &interpreter) { m_defaultId = interpreter.id; }
+
+    void fromMap(const QVariantMap &) override;
+    void toMap(QVariantMap &) const override;
+    void addToConfigurationLayout(QFormLayout *layout) override;
+
+private:
+    void updateCurrentInterpreter();
+    void updateComboBox();
+    QList<Interpreter> m_interpreters;
+    QPointer<QComboBox> m_comboBox;
+    QString m_defaultId;
+    QString m_currentId;
+};
+
+Interpreter InterpreterAspect::currentInterpreter() const
+{
+    return m_comboBox ? m_interpreters.value(m_comboBox->currentIndex()) : Interpreter();
+}
+
+void InterpreterAspect::updateInterpreters(const QList<Interpreter> &interpreters)
+{
+    m_interpreters = interpreters;
+    if (m_comboBox)
+        updateComboBox();
+}
+
+void InterpreterAspect::fromMap(const QVariantMap &map)
+{
+    m_currentId = map.value(settingsKey(), m_defaultId).toString();
+}
+
+void InterpreterAspect::toMap(QVariantMap &map) const
+{
+    map.insert(settingsKey(), m_currentId);
+}
+
+void InterpreterAspect::addToConfigurationLayout(QFormLayout *layout)
+{
+    if (QTC_GUARD(m_comboBox.isNull()))
+        m_comboBox = new QComboBox;
+
+    updateComboBox();
+    connect(m_comboBox,
+            &QComboBox::currentTextChanged,
+            this,
+            &InterpreterAspect::updateCurrentInterpreter);
+
+    auto manageButton = new QPushButton(tr("Manage..."));
+    connect(manageButton, &QPushButton::clicked, []() {
+        Core::ICore::showOptionsDialog(Constants::C_PYTHONOPTIONS_PAGE_ID);
+    });
+
+    auto rowLayout = new QHBoxLayout;
+    rowLayout->addWidget(m_comboBox);
+    rowLayout->addWidget(manageButton);
+    layout->addRow(tr("Interpreter"), rowLayout);
+}
+
+void InterpreterAspect::updateCurrentInterpreter()
+{
+    m_currentId = currentInterpreter().id;
+    m_comboBox->setToolTip(currentInterpreter().command.toUserOutput());
+    emit changed();
+}
+
+void InterpreterAspect::updateComboBox()
+{
+    int currentIndex = -1;
+    int defaultIndex = -1;
+    const QString currentId = m_currentId;
+    m_comboBox->clear();
+    for (const Interpreter &interpreter : m_interpreters) {
+        int index = m_comboBox->count();
+        m_comboBox->addItem(interpreter.name);
+        m_comboBox->setItemData(index, interpreter.command.toUserOutput(), Qt::ToolTipRole);
+        if (interpreter.id == currentId)
+            currentIndex = index;
+        if (interpreter.id == m_defaultId)
+            defaultIndex = index;
+    }
+    if (currentIndex >= 0)
+        m_comboBox->setCurrentIndex(currentIndex);
+    else if (defaultIndex >= 0)
+        m_comboBox->setCurrentIndex(defaultIndex);
+    updateCurrentInterpreter();
+}
+
+class MainScriptAspect : public BaseStringAspect
+{
+    Q_OBJECT
+
+public:
+    MainScriptAspect() = default;
+};
+
+PythonRunConfiguration::PythonRunConfiguration(Target *target, Core::Id id)
+    : RunConfiguration(target, id)
+{
+    auto interpreterAspect = addAspect<InterpreterAspect>();
+    interpreterAspect->setSettingsKey("PythonEditor.RunConfiguation.Interpreter");
+
+    connect(PythonSettings::instance(), &PythonSettings::interpretersChanged,
+            interpreterAspect, &InterpreterAspect::updateInterpreters);
+
+    interpreterAspect->updateInterpreters(PythonSettings::interpreters());
+    interpreterAspect->setDefaultInterpreter(PythonSettings::defaultInterpreter());
+
+    auto scriptAspect = addAspect<MainScriptAspect>();
+    scriptAspect->setSettingsKey("PythonEditor.RunConfiguation.Script");
+    scriptAspect->setLabelText(tr("Script:"));
+    scriptAspect->setDisplayStyle(BaseStringAspect::LabelDisplay);
+
+    addAspect<LocalEnvironmentAspect>(target);
+
+    auto argumentsAspect = addAspect<ArgumentsAspect>();
+
+    addAspect<TerminalAspect>();
+
+    setCommandLineGetter([this, interpreterAspect, argumentsAspect] {
+        CommandLine cmd{interpreterAspect->currentInterpreter().command, {mainScript()}};
+        cmd.addArgs(argumentsAspect->arguments(macroExpander()), CommandLine::Raw);
+        return cmd;
+    });
+
+    connect(target, &Target::applicationTargetsChanged,
+            this, &PythonRunConfiguration::updateTargetInformation);
+    connect(target->project(), &Project::parsingFinished,
+            this, &PythonRunConfiguration::updateTargetInformation);
+}
+
+void PythonRunConfiguration::doAdditionalSetup(const RunConfigurationCreationInfo &)
+{
+    updateTargetInformation();
+}
+
+bool PythonRunConfiguration::supportsDebugger() const
+{
+    return true;
+}
+
+QString PythonRunConfiguration::mainScript() const
+{
+    return aspect<MainScriptAspect>()->value();
+}
+
+QString PythonRunConfiguration::arguments() const
+{
+    return aspect<ArgumentsAspect>()->arguments(macroExpander());
+}
+
+QString PythonRunConfiguration::interpreter() const
+{
+    return aspect<InterpreterAspect>()->currentInterpreter().command.toString();
+}
+
+void PythonRunConfiguration::updateTargetInformation()
+{
+    const BuildTargetInfo bti = buildTargetInfo();
+    const QString script = bti.targetFilePath.toString();
+    setDefaultDisplayName(tr("Run %1").arg(script));
+    aspect<MainScriptAspect>()->setValue(script);
+}
+
+PythonRunConfigurationFactory::PythonRunConfigurationFactory()
+{
+    registerRunConfiguration<PythonRunConfiguration>("PythonEditor.RunConfiguration.");
+    addSupportedProjectType(PythonProjectId);
+}
+
+PythonOutputFormatterFactory::PythonOutputFormatterFactory()
+{
+    setFormatterCreator([](Target *t) -> OutputFormatter * {
+        if (t->project()->mimeType() == Constants::C_PY_MIMETYPE)
+            return new PythonOutputFormatter;
+        return nullptr;
+    });
+}
+
+} // namespace Internal
+} // namespace Python
+
+#include "pythonrunconfiguration.moc"