CompilerExplorer: Enable undo/redo

Change-Id: I06bba06181784de07f89f01a3bfe586513d63c66
Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Marcus Tillmanns
2023-09-21 09:32:07 +02:00
parent 3c5de27af4
commit 4bdc023e32
6 changed files with 443 additions and 150 deletions

View File

@@ -9,6 +9,7 @@
#include <aggregation/aggregate.h>
#include <coreplugin/actionmanager/actionmanager.h>
#include <coreplugin/coreconstants.h>
#include <coreplugin/icontext.h>
#include <coreplugin/icore.h>
@@ -25,6 +26,7 @@
#include <utils/layoutbuilder.h>
#include <utils/mimetypes2/mimetype.h>
#include <utils/mimeutils.h>
#include <utils/store.h>
#include <utils/utilsicons.h>
#include <QCompleter>
@@ -37,6 +39,7 @@
#include <QTemporaryFile>
#include <QTimer>
#include <QToolButton>
#include <QUndoStack>
#include <chrono>
#include <iostream>
@@ -48,30 +51,36 @@ using namespace Utils;
namespace CompilerExplorer {
class CodeEditorWidget : public TextEditorWidget
CodeEditorWidget::CodeEditorWidget(const std::shared_ptr<SourceSettings> &settings,
QUndoStack *undoStack)
: m_settings(settings)
, m_undoStack(undoStack){};
void CodeEditorWidget::updateHighlighter()
{
public:
CodeEditorWidget(const std::shared_ptr<SourceSettings> &settings)
: m_settings(settings)
{}
const QString ext = m_settings->languageExtension();
if (ext.isEmpty())
return;
void updateHighlighter()
{
const QString ext = m_settings->languageExtension();
if (ext.isEmpty())
return;
Utils::MimeType mimeType = Utils::mimeTypeForFile("foo" + ext);
configureGenericHighlighter(mimeType);
}
std::shared_ptr<SourceSettings> m_settings;
};
Utils::MimeType mimeType = Utils::mimeTypeForFile("foo" + ext);
configureGenericHighlighter(mimeType);
}
class SourceTextDocument : public TextDocument
{
public:
SourceTextDocument(const std::shared_ptr<SourceSettings> &settings)
class OpaqueUndoCommand : public QUndoCommand
{
public:
OpaqueUndoCommand(SourceTextDocument *doc)
: m_doc(doc)
{}
void undo() override { m_doc->undo(); }
void redo() override { m_doc->redo(); }
SourceTextDocument *m_doc;
};
SourceTextDocument(const std::shared_ptr<SourceSettings> &settings, QUndoStack *undoStack)
{
setPlainText(settings->source());
@@ -83,18 +92,26 @@ public:
if (settings->source.volatileValue() != plainText())
setPlainText(settings->source.volatileValue());
});
connect(this->document(), &QTextDocument::undoCommandAdded, this, [this, undoStack] {
undoStack->push(new OpaqueUndoCommand(this));
});
}
void undo() { document()->undo(); }
void redo() { document()->redo(); }
};
JsonSettingsDocument::JsonSettingsDocument()
JsonSettingsDocument::JsonSettingsDocument(QUndoStack *undoStack)
: m_undoStack(undoStack)
{
setId(Constants::CE_EDITOR_ID);
setMimeType("application/compiler-explorer");
connect(&m_ceSettings, &CompilerExplorerSettings::changed, this, [this] { emit changed(); });
m_ceSettings.setAutoApply(true);
m_ceSettings.setUndoStack(undoStack);
}
JsonSettingsDocument::~JsonSettingsDocument() {}
Core::IDocument::OpenResult JsonSettingsDocument::open(QString *errorString,
const FilePath &filePath,
const FilePath &realFilePath)
@@ -121,23 +138,21 @@ Core::IDocument::OpenResult JsonSettingsDocument::open(QString *errorString,
return OpenResult::Success;
}
bool JsonSettingsDocument::saveImpl(QString *errorString,
const FilePath &newFilePath,
bool autoSave)
bool JsonSettingsDocument::saveImpl(QString *errorString, const FilePath &newFilePath, bool autoSave)
{
Store map;
Store store;
if (autoSave) {
if (m_windowStateCallback)
m_ceSettings.windowState.setVolatileValue(m_windowStateCallback());
m_ceSettings.volatileToMap(map);
m_ceSettings.volatileToMap(store);
} else {
if (m_windowStateCallback)
m_ceSettings.windowState.setValue(m_windowStateCallback());
m_ceSettings.apply();
m_ceSettings.toMap(map);
m_ceSettings.toMap(store);
}
Utils::FilePath path = newFilePath.isEmpty() ? filePath() : newFilePath;
@@ -145,7 +160,7 @@ bool JsonSettingsDocument::saveImpl(QString *errorString,
if (!newFilePath.isEmpty() && !autoSave)
setFilePath(newFilePath);
auto result = path.writeFileContents(jsonFromStore(map));
auto result = path.writeFileContents(jsonFromStore(store));
if (!result && errorString) {
*errorString = result.error();
return false;
@@ -170,12 +185,15 @@ bool JsonSettingsDocument::setContents(const QByteArray &contents)
return true;
}
SourceEditorWidget::SourceEditorWidget(const std::shared_ptr<SourceSettings> &settings)
SourceEditorWidget::SourceEditorWidget(const std::shared_ptr<SourceSettings> &settings,
QUndoStack *undoStack)
: m_sourceSettings(settings)
{
m_codeEditor = new CodeEditorWidget(m_sourceSettings);
m_codeEditor = new CodeEditorWidget(m_sourceSettings, undoStack);
TextDocumentPtr document = TextDocumentPtr(new SourceTextDocument(m_sourceSettings));
connect(m_codeEditor, &CodeEditorWidget::gotFocus, this, &SourceEditorWidget::gotFocus);
TextDocumentPtr document = TextDocumentPtr(new SourceTextDocument(m_sourceSettings, undoStack));
connect(document.get(),
&SourceTextDocument::changed,
@@ -187,11 +205,12 @@ SourceEditorWidget::SourceEditorWidget(const std::shared_ptr<SourceSettings> &se
auto addCompilerButton = new QPushButton;
addCompilerButton->setText(Tr::tr("Add compiler"));
connect(addCompilerButton, &QPushButton::clicked, this, [this] {
auto newCompiler = std::make_shared<CompilerSettings>(m_sourceSettings->apiConfigFunction());
newCompiler->setLanguageId(m_sourceSettings->languageId());
m_sourceSettings->compilers.addItem(newCompiler);
});
connect(addCompilerButton, &QPushButton::clicked, this, &SourceEditorWidget::addCompiler);
auto removeSourceButton = new QPushButton;
removeSourceButton->setIcon(Utils::Icons::EDIT_CLEAR.icon());
removeSourceButton->setToolTip(Tr::tr("Remove source"));
connect(removeSourceButton, &QPushButton::clicked, this, &SourceEditorWidget::remove);
// clang-format off
using namespace Layouting;
@@ -200,6 +219,7 @@ SourceEditorWidget::SourceEditorWidget(const std::shared_ptr<SourceSettings> &se
Row {
settings->languageId,
addCompilerButton,
removeSourceButton,
},
m_codeEditor,
}.attachTo(this);
@@ -208,13 +228,6 @@ SourceEditorWidget::SourceEditorWidget(const std::shared_ptr<SourceSettings> &se
setWindowTitle("Source code");
setObjectName("source_code");
Aggregate *agg = Aggregate::parentAggregate(m_codeEditor);
if (!agg) {
agg = new Aggregate;
agg->add(m_codeEditor);
}
agg->add(this);
setFocusProxy(m_codeEditor);
}
@@ -243,11 +256,14 @@ CompilerWidget::CompilerWidget(const std::shared_ptr<SourceSettings> &sourceSett
m_delayTimer,
qOverload<>(&QTimer::start));
m_asmEditor = new TextEditorWidget;
m_asmEditor = new AsmEditorWidget;
m_asmDocument = QSharedPointer<TextDocument>(new TextDocument);
m_asmDocument->setFilePath("asm.asm");
m_asmEditor->setTextDocument(m_asmDocument);
m_asmEditor->configureGenericHighlighter(Utils::mimeTypeForName("text/x-asm"));
m_asmEditor->setReadOnly(true);
connect(m_asmEditor, &AsmEditorWidget::gotFocus, this, &CompilerWidget::gotFocus);
auto advButton = new QPushButton;
QSplitter *splitter{nullptr};
@@ -268,6 +284,11 @@ CompilerWidget::CompilerWidget(const std::shared_ptr<SourceSettings> &sourceSett
connect(advButton, &QPushButton::clicked, advDlg, &QAction::trigger);
advButton->setIcon(advDlg->icon());
auto removeCompilerBtn = new QPushButton;
removeCompilerBtn->setIcon(Utils::Icons::EDIT_CLEAR.icon());
removeCompilerBtn->setToolTip(Tr::tr("Remove compiler"));
connect(removeCompilerBtn, &QPushButton::clicked, this, &CompilerWidget::remove);
compile(m_sourceSettings->source());
connect(&m_sourceSettings->source, &Utils::StringAspect::volatileValueChanged, this, [this] {
@@ -279,6 +300,7 @@ CompilerWidget::CompilerWidget(const std::shared_ptr<SourceSettings> &sourceSett
Row {
m_compilerSettings->compiler,
advButton,
removeCompilerBtn,
},
Splitter {
bindTo(&splitter),
@@ -368,84 +390,81 @@ void CompilerWidget::doCompile()
m_compileWatcher.reset(new QFutureWatcher<CompileResult>);
connect(
m_compileWatcher.get(), &QFutureWatcher<CompileResult>::finished, this, [this] {
m_spinner->setVisible(false);
m_asmEditor->setEnabled(true);
connect(m_compileWatcher.get(), &QFutureWatcher<CompileResult>::finished, this, [this] {
m_spinner->setVisible(false);
m_asmEditor->setEnabled(true);
try {
Api::CompileResult r = m_compileWatcher->result();
try {
Api::CompileResult r = m_compileWatcher->result();
m_resultTerminal->restart();
m_resultTerminal->writeToTerminal("\x1b[?25l", false);
m_resultTerminal->restart();
m_resultTerminal->writeToTerminal("\x1b[?25l", false);
for (const auto &err : r.stdErr)
for (const auto &err : r.stdErr)
m_resultTerminal->writeToTerminal((err.text + "\r\n").toUtf8(), false);
for (const auto &out : r.stdOut)
m_resultTerminal->writeToTerminal((out.text + "\r\n").toUtf8(), false);
m_resultTerminal->writeToTerminal(
QString("ASM generation compiler returned: %1\r\n\r\n").arg(r.code).toUtf8(), true);
if (r.execResult) {
for (const auto &err : r.execResult->buildResult.stdErr)
m_resultTerminal->writeToTerminal((err.text + "\r\n").toUtf8(), false);
for (const auto &out : r.stdOut)
for (const auto &out : r.execResult->buildResult.stdOut)
m_resultTerminal->writeToTerminal((out.text + "\r\n").toUtf8(), false);
m_resultTerminal->writeToTerminal(
QString("ASM generation compiler returned: %1\r\n\r\n").arg(r.code).toUtf8(),
true);
m_resultTerminal
->writeToTerminal(QString("Execution build compiler returned: %1\r\n\r\n")
.arg(r.execResult->buildResult.code)
.toUtf8(),
true);
if (r.execResult) {
for (const auto &err : r.execResult->buildResult.stdErr)
m_resultTerminal->writeToTerminal((err.text + "\r\n").toUtf8(), false);
for (const auto &out : r.execResult->buildResult.stdOut)
m_resultTerminal->writeToTerminal((out.text + "\r\n").toUtf8(), false);
if (r.execResult->didExecute) {
m_resultTerminal->writeToTerminal(QString("Program returned: %1\r\n")
.arg(r.execResult->code)
.toUtf8(),
true);
m_resultTerminal
->writeToTerminal(QString("Execution build compiler returned: %1\r\n\r\n")
.arg(r.execResult->buildResult.code)
.toUtf8(),
true);
if (r.execResult->didExecute) {
m_resultTerminal->writeToTerminal(QString("Program returned: %1\r\n")
.arg(r.execResult->code)
.toUtf8(),
true);
for (const auto &err : r.execResult->stdErrLines)
m_resultTerminal
->writeToTerminal((" \033[0;31m" + err + "\033[0m\r\n").toUtf8(),
false);
for (const auto &out : r.execResult->stdOutLines)
m_resultTerminal->writeToTerminal((" " + out + "\r\n").toUtf8(), false);
}
for (const auto &err : r.execResult->stdErrLines)
m_resultTerminal
->writeToTerminal((" \033[0;31m" + err + "\033[0m\r\n\r\n").toUtf8(),
false);
for (const auto &out : r.execResult->stdOutLines)
m_resultTerminal->writeToTerminal((out + "\r\n").toUtf8(), false);
}
for (auto mark : m_marks) {
delete mark;
}
m_marks.clear();
QString asmText;
for (auto l : r.assemblyLines)
asmText += l.text + "\n";
m_asmDocument->setPlainText(asmText);
int i = 0;
for (auto l : r.assemblyLines) {
i++;
if (l.opcodes.empty())
continue;
auto mark = new TextMark(m_asmDocument.get(),
i,
TextMarkCategory{"Bytes", "Bytes"});
mark->setLineAnnotation(l.opcodes.join(' '));
m_marks.append(mark);
}
} catch (const std::exception &e) {
qCritical() << "Exception: " << e.what();
}
});
qDeleteAll(m_marks);
m_marks.clear();
QString asmText;
for (auto l : r.assemblyLines)
asmText += l.text + "\n";
m_asmDocument->setPlainText(asmText);
int i = 0;
for (auto l : r.assemblyLines) {
i++;
if (l.opcodes.empty())
continue;
auto mark = new TextMark(m_asmDocument.get(), i, TextMarkCategory{"Bytes", "Bytes"});
mark->setLineAnnotation(l.opcodes.join(' '));
m_marks.append(mark);
}
} catch (const std::exception &e) {
qCritical() << "Exception: " << e.what();
}
});
m_compileWatcher->setFuture(f);
}
EditorWidget::EditorWidget(const QSharedPointer<JsonSettingsDocument> &document, QWidget *parent)
EditorWidget::EditorWidget(const QSharedPointer<JsonSettingsDocument> &document,
QUndoStack *undoStack,
TextEditorActionHandler &actionHandler,
QWidget *parent)
: Utils::FancyMainWindow(parent)
, m_document(document)
{
@@ -473,34 +492,55 @@ EditorWidget::EditorWidget(const QSharedPointer<JsonSettingsDocument> &document,
return result;
});
auto addCompiler = [this](const std::shared_ptr<SourceSettings> &sourceSettings,
const std::shared_ptr<CompilerSettings> &compilerSettings,
int idx) {
auto addCompiler = [this,
&actionHandler](const std::shared_ptr<SourceSettings> &sourceSettings,
const std::shared_ptr<CompilerSettings> &compilerSettings,
int idx) {
auto compiler = new CompilerWidget(sourceSettings, compilerSettings);
compiler->setWindowTitle("Compiler #" + QString::number(idx));
compiler->setObjectName("compiler_" + QString::number(idx));
QDockWidget *dockWidget = addDockForWidget(compiler);
addDockWidget(Qt::RightDockWidgetArea, dockWidget);
m_compilerWidgets.append(dockWidget);
connect(compiler,
&CompilerWidget::remove,
this,
[sourceSettings = sourceSettings.get(), compilerSettings = compilerSettings.get()] {
sourceSettings->compilers.removeItem(compilerSettings->shared_from_this());
});
connect(compiler, &CompilerWidget::gotFocus, this, [&actionHandler] {
actionHandler.updateCurrentEditor();
});
};
auto addSourceEditor = [this, document = document.get(), addCompiler](
auto addSourceEditor = [this, &actionHandler, document = document.get(), addCompiler, undoStack](
const std::shared_ptr<SourceSettings> &sourceSettings) {
auto sourceEditor = new SourceEditorWidget(sourceSettings);
auto sourceEditor = new SourceEditorWidget(sourceSettings, undoStack);
sourceEditor->setWindowTitle("Source Code #" + QString::number(m_sourceWidgets.size() + 1));
sourceEditor->setObjectName("source_code_editor_"
+ QString::number(m_sourceWidgets.size() + 1));
QDockWidget *dockWidget = addDockForWidget(sourceEditor);
connect(dockWidget,
&QDockWidget::visibilityChanged,
connect(sourceEditor,
&SourceEditorWidget::remove,
this,
[document, sourceSettings = sourceSettings.get(), dockWidget] {
if (!dockWidget->isVisible())
document->settings()->m_sources.removeItem(
sourceSettings->shared_from_this());
[document, sourceSettings = sourceSettings.get()] {
document->settings()->m_sources.removeItem(sourceSettings->shared_from_this());
});
connect(sourceEditor, &SourceEditorWidget::addCompiler, this, [sourceSettings] {
auto newCompiler = std::make_shared<CompilerSettings>(
sourceSettings->apiConfigFunction());
newCompiler->setLanguageId(sourceSettings->languageId());
sourceSettings->compilers.addItem(newCompiler);
});
connect(sourceEditor, &SourceEditorWidget::gotFocus, this, [&actionHandler] {
actionHandler.updateCurrentEditor();
});
addDockWidget(Qt::LeftDockWidgetArea, dockWidget);
sourceSettings->compilers.forEachItem<CompilerSettings>(
@@ -519,13 +559,19 @@ EditorWidget::EditorWidget(const QSharedPointer<JsonSettingsDocument> &document,
sourceSettings->compilers.setItemRemovedCallback<CompilerSettings>(
[this](const std::shared_ptr<CompilerSettings> &compilerSettings) {
m_compilerWidgets.removeIf([compilerSettings](const QDockWidget *c) {
return static_cast<CompilerWidget *>(c->widget())->m_compilerSettings
== compilerSettings;
});
auto it = std::find_if(m_compilerWidgets.begin(),
m_compilerWidgets.end(),
[compilerSettings](const QDockWidget *c) {
return static_cast<CompilerWidget *>(c->widget())
->m_compilerSettings
== compilerSettings;
});
QTC_ASSERT(it != m_compilerWidgets.end(), return);
delete *it;
m_compilerWidgets.erase(it);
});
Aggregate *agg = Aggregate::parentAggregate(sourceEditor);
/*Aggregate *agg = Aggregate::parentAggregate(sourceEditor);
if (!agg) {
agg = new Aggregate;
agg->add(sourceEditor);
@@ -533,15 +579,21 @@ EditorWidget::EditorWidget(const QSharedPointer<JsonSettingsDocument> &document,
agg->add(this);
setFocusProxy(sourceEditor);
*/
m_sourceWidgets.append(dockWidget);
};
auto removeSourceEditor = [this](const std::shared_ptr<SourceSettings> &sourceSettings) {
m_sourceWidgets.removeIf([sourceSettings = sourceSettings.get()](const QDockWidget *c) {
return static_cast<SourceEditorWidget *>(c->widget())->m_sourceSettings
== sourceSettings->shared_from_this();
});
auto it = std::find_if(m_sourceWidgets.begin(),
m_sourceWidgets.end(),
[sourceSettings](const QDockWidget *c) {
return static_cast<SourceEditorWidget *>(c->widget())
->sourceSettings()
== sourceSettings.get();
});
QTC_ASSERT(it != m_sourceWidgets.end(), return);
delete *it;
m_sourceWidgets.erase(it);
};
auto recreateEditors = [this, addSourceEditor]() {
@@ -593,21 +645,63 @@ EditorWidget::~EditorWidget()
m_sourceWidgets.clear();
}
TextEditor::TextEditorWidget *EditorWidget::focusedEditorWidget() const
{
for (const QDockWidget *sourceWidget : m_sourceWidgets) {
TextEditorWidget *textEditor
= qobject_cast<SourceEditorWidget *>(sourceWidget->widget())->textEditor();
if (textEditor->hasFocus())
return textEditor;
}
for (const QDockWidget *compilerWidget : m_compilerWidgets) {
TextEditorWidget *textEditor
= qobject_cast<CompilerWidget *>(compilerWidget->widget())->textEditor();
if (textEditor->hasFocus())
return textEditor;
}
return nullptr;
}
class Editor : public Core::IEditor
{
public:
Editor()
: m_document(new JsonSettingsDocument())
Editor(TextEditorActionHandler &actionHandler)
: m_document(new JsonSettingsDocument(&m_undoStack))
{
setWidget(new EditorWidget(m_document));
setWidget(new EditorWidget(m_document, &m_undoStack, actionHandler));
connect(&m_undoStack, &QUndoStack::canUndoChanged, this, [&actionHandler] {
actionHandler.updateActions();
});
connect(&m_undoStack, &QUndoStack::canRedoChanged, this, [&actionHandler] {
actionHandler.updateActions();
});
}
~Editor() { delete widget(); }
~Editor()
{
if (m_document->isModified()) {
auto settings = m_document->settings();
if (settings->isDirty()) {
settings->apply();
Utils::Store store;
settings->toMap(store);
QJsonDocument doc = QJsonDocument::fromVariant(Utils::mapFromStore(store));
CompilerExplorer::settings().defaultDocument.setValue(
QString::fromUtf8(doc.toJson()));
}
}
delete widget();
}
Core::IDocument *document() const override { return m_document.data(); }
QWidget *toolBar() override { return nullptr; }
QSharedPointer<JsonSettingsDocument> m_document;
QUndoStack m_undoStack;
};
EditorFactory::EditorFactory()
@@ -615,14 +709,32 @@ EditorFactory::EditorFactory()
Constants::CE_EDITOR_CONTEXT_ID,
TextEditor::TextEditorActionHandler::None,
[](Core::IEditor *editor) -> TextEditorWidget * {
return Aggregation::query<TextEditorWidget>(editor->widget());
return static_cast<EditorWidget *>(editor->widget())->focusedEditorWidget();
})
{
setId(Constants::CE_EDITOR_ID);
setDisplayName(Tr::tr("Compiler Explorer Editor"));
setMimeTypes({"application/compiler-explorer"});
setEditorCreator([]() { return new Editor(); });
auto undoStackFromEditor = [](Core::IEditor *editor) -> QUndoStack * {
if (!editor)
return nullptr;
return &static_cast<Editor *>(editor)->m_undoStack;
};
m_actionHandler.setCanUndoCallback([undoStackFromEditor](Core::IEditor *editor) {
if (auto undoStack = undoStackFromEditor(editor))
return undoStack->canUndo();
return false;
});
m_actionHandler.setCanRedoCallback([undoStackFromEditor](Core::IEditor *editor) {
if (auto undoStack = undoStackFromEditor(editor))
return undoStack->canRedo();
return false;
});
setEditorCreator([this]() { return new Editor(m_actionHandler); });
}
} // namespace CompilerExplorer