feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

QmlJSEditor: Create QuickFixes directly

Browse Source 
So far there have been factories instantiated and maintained to get
a list of 'matching' operation by iterating over the factories'
match() functions. The same effect can be achieved more directly
by calling stand-alone functions.

Change-Id: I868489d36f9d8339e0d8855d832df8400501026c
Reviewed-by: Marco Benelli <marco.benelli@qt.io>
This commit is contained in:
hjk
2017-12-18 12:23:28 +01:00
parent e4eb4c3d0f
commit b4faec80ba
9 changed files with 107 additions and 156 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/plugins/qmldesigner/designercore/model/basetexteditmodifier.cpp
View File

@@ -132,7 +132,7 @@ bool BaseTextEditModifier::moveToComponent(int nodeOffset)
if (!object)
return false;
QmlJSEditor::ComponentFromObjectDef::perform(document->filePath().toString(), object);
QmlJSEditor::performComponentFromObjectDef(document->filePath().toString(), object);
return true;
}
}

4
src/plugins/qmljseditor/qmljscomponentfromobjectdef.cpp
View File

@@ -233,7 +233,7 @@ public:
} // end of anonymous namespace
void ComponentFromObjectDef::match(const QmlJSQuickFixInterface &interface, QuickFixOperations &result)
void matchComponentFromObjectDefQuickFix(const QmlJSQuickFixInterface &interface, QuickFixOperations &result)
{
const int pos = interface->currentFile()->cursor().position();
@@ -258,7 +258,7 @@ void ComponentFromObjectDef::match(const QmlJSQuickFixInterface &interface, Quic
}
}
void ComponentFromObjectDef::perform(const QString &fileName, QmlJS::AST::UiObjectDefinition *objDef)
void performComponentFromObjectDef(const QString &fileName, QmlJS::AST::UiObjectDefinition *objDef)
{
QmlJSRefactoringChanges refactoring(QmlJS::ModelManagerInterface::instance(),
QmlJS::ModelManagerInterface::instance()->snapshot());

10
src/plugins/qmljseditor/qmljscomponentfromobjectdef.h
View File

@@ -29,12 +29,10 @@
namespace QmlJSEditor {
class QMLJSEDITOR_EXPORT ComponentFromObjectDef : public QmlJSQuickFixFactory
{
public:
void match(const QmlJSQuickFixInterface &interface, QuickFixOperations &result) override;
QMLJSEDITOR_EXPORT void matchComponentFromObjectDefQuickFix
(const QmlJSQuickFixInterface &interface, QuickFixOperations &result);
static void perform(const QString &fileName, QmlJS::AST::UiObjectDefinition *objDef);
};
QMLJSEDITOR_EXPORT void performComponentFromObjectDef
(const QString &fileName, QmlJS::AST::UiObjectDefinition *objDef);
} // namespace QmlJSEditor

4
src/plugins/qmljseditor/qmljseditorplugin.cpp
View File

@@ -78,8 +78,6 @@ enum {
namespace QmlJSEditor {
using namespace Internal;
void registerQuickFixes(ExtensionSystem::IPlugin *plugIn);
QmlJSEditorPlugin *QmlJSEditorPlugin::m_instance = 0;
QmlJSEditorPlugin::QmlJSEditorPlugin() :
@@ -193,8 +191,6 @@ bool QmlJSEditorPlugin::initialize(const QStringList & /*arguments*/, QString *e
FileIconProvider::registerIconOverlayForSuffix(ProjectExplorer::Constants::FILEOVERLAY_QML, "qml");
registerQuickFixes(this);
addAutoReleasedObject(new QmlJSOutlineWidgetFactory);
addAutoReleasedObject(new QuickToolBar);

17
src/plugins/qmljseditor/qmljsquickfix.h
View File

@@ -34,8 +34,6 @@
#include <QSharedPointer>
namespace QmlJS { class ModelManagerInterface; }
namespace QmlJSEditor {
namespace Internal { class QmlJSQuickFixAssistInterface; }
@@ -76,19 +74,6 @@ private:
QmlJSQuickFixInterface m_interface;
};
class QmlJSQuickFixFactory: public QObject
{
Q_OBJECT
public:
QmlJSQuickFixFactory();
~QmlJSQuickFixFactory();
/*!
Implement this function to match and create the appropriate
QmlJSQuickFixOperation objects.
*/
virtual void match(const QmlJSQuickFixInterface &interface, TextEditor::QuickFixOperations &result) = 0;
};
TextEditor::QuickFixOperations findQmlJSQuickFixes(const TextEditor::AssistInterface *interface);
} // namespace QmlJSEditor

26
src/plugins/qmljseditor/qmljsquickfixassist.cpp
View File

@@ -42,22 +42,6 @@ namespace QmlJSEditor {
using namespace Internal;
// -----------------------
// QmlJSQuickFixFactory
// -----------------------
static QList<QmlJSQuickFixFactory *> g_qmlJSQuickFixFactories;
QmlJSQuickFixFactory::QmlJSQuickFixFactory()
{
g_qmlJSQuickFixFactories.append(this);
}
QmlJSQuickFixFactory::~QmlJSQuickFixFactory()
{
g_qmlJSQuickFixFactories.removeOne(this);
}
// -----------------------
// QmlJSQuickFixAssistInterface
// -----------------------
@@ -89,15 +73,7 @@ class QmlJSQuickFixAssistProcessor : public IAssistProcessor
{
IAssistProposal *perform(const AssistInterface *interface) override
{
QSharedPointer<const AssistInterface> assistInterface(interface);
auto qmlJSInterface = assistInterface.staticCast<const QmlJSQuickFixAssistInterface>();
QuickFixOperations quickFixes;
for (QmlJSQuickFixFactory *factory : g_qmlJSQuickFixFactories)
factory->match(qmlJSInterface, quickFixes);
return GenericProposal::createProposal(interface, quickFixes);
return GenericProposal::createProposal(interface, findQmlJSQuickFixes(interface));
}
};

191
src/plugins/qmljseditor/qmljsquickfixes.cpp
View File

@@ -33,13 +33,14 @@
#include <extensionsystem/pluginmanager.h>
#include <qmljs/parser/qmljsast_p.h>
#include <qmljstools/qmljsrefactoringchanges.h>
#include <texteditor/codeassist/assistinterface.h>
#include <QApplication>
using namespace QmlJS;
using namespace QmlJS::AST;
using namespace QmlJSTools;
using TextEditor::RefactoringChanges;
using namespace TextEditor;
namespace QmlJSEditor {
@@ -57,125 +58,125 @@ namespace {
width: 10
}
*/
class SplitInitializerOp: public QmlJSQuickFixFactory
class SplitInitializerOperation: public QmlJSQuickFixOperation
{
void match(const QmlJSQuickFixInterface &interface, QuickFixOperations &result) override
UiObjectInitializer *_objectInitializer;
public:
SplitInitializerOperation(const QSharedPointer<const QmlJSQuickFixAssistInterface> &interface,
UiObjectInitializer *objectInitializer)
: QmlJSQuickFixOperation(interface, 0)
, _objectInitializer(objectInitializer)
{
UiObjectInitializer *objectInitializer = 0;
const int pos = interface->currentFile()->cursor().position();
if (Node *member = interface->semanticInfo().rangeAt(pos)) {
if (UiObjectBinding *b = AST::cast<UiObjectBinding *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
objectInitializer = b->initializer;
} else if (UiObjectDefinition *b = AST::cast<UiObjectDefinition *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
objectInitializer = b->initializer;
}
}
if (objectInitializer)
result << new Operation(interface, objectInitializer);
setDescription(QApplication::translate("QmlJSEditor::QuickFix",
"Split Initializer"));
}
class Operation: public QmlJSQuickFixOperation
void performChanges(QmlJSRefactoringFilePtr currentFile,
const QmlJSRefactoringChanges &)
{
UiObjectInitializer *_objectInitializer;
Q_ASSERT(_objectInitializer != 0);
public:
Operation(const QSharedPointer<const QmlJSQuickFixAssistInterface> &interface,
UiObjectInitializer *objectInitializer)
: QmlJSQuickFixOperation(interface, 0)
, _objectInitializer(objectInitializer)
{
setDescription(QApplication::translate("QmlJSEditor::QuickFix",
"Split Initializer"));
}
Utils::ChangeSet changes;
void performChanges(QmlJSRefactoringFilePtr currentFile,
const QmlJSRefactoringChanges &)
{
Q_ASSERT(_objectInitializer != 0);
for (UiObjectMemberList *it = _objectInitializer->members; it; it = it->next) {
if (UiObjectMember *member = it->member) {
const SourceLocation loc = member->firstSourceLocation();
Utils::ChangeSet changes;
for (UiObjectMemberList *it = _objectInitializer->members; it; it = it->next) {
if (UiObjectMember *member = it->member) {
const SourceLocation loc = member->firstSourceLocation();
// insert a newline at the beginning of this binding
changes.insert(currentFile->startOf(loc), QLatin1String("\n"));
}
// insert a newline at the beginning of this binding
changes.insert(currentFile->startOf(loc), QLatin1String("\n"));
}
// insert a newline before the closing brace
changes.insert(currentFile->startOf(_objectInitializer->rbraceToken),
QLatin1String("\n"));
currentFile->setChangeSet(changes);
currentFile->appendIndentRange(Range(currentFile->startOf(_objectInitializer->lbraceToken),
currentFile->startOf(_objectInitializer->rbraceToken)));
currentFile->apply();
}
};
// insert a newline before the closing brace
changes.insert(currentFile->startOf(_objectInitializer->rbraceToken),
QLatin1String("\n"));
currentFile->setChangeSet(changes);
currentFile->appendIndentRange(Range(currentFile->startOf(_objectInitializer->lbraceToken),
currentFile->startOf(_objectInitializer->rbraceToken)));
currentFile->apply();
}
};
void matchSplitInitializerQuickFix(const QmlJSQuickFixInterface &interface, QuickFixOperations &result)
{
UiObjectInitializer *objectInitializer = 0;
const int pos = interface->currentFile()->cursor().position();
if (Node *member = interface->semanticInfo().rangeAt(pos)) {
if (UiObjectBinding *b = AST::cast<UiObjectBinding *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
objectInitializer = b->initializer;
} else if (UiObjectDefinition *b = AST::cast<UiObjectDefinition *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
objectInitializer = b->initializer;
}
}
if (objectInitializer)
result << new SplitInitializerOperation(interface, objectInitializer);
}
/*
Adds a comment to suppress a static analysis message
*/
class AddAnalysisMessageSuppressionComment: public QmlJSQuickFixFactory
class AnalysizeMessageSuppressionOperation: public QmlJSQuickFixOperation
{
Q_DECLARE_TR_FUNCTIONS(QmlJSEditor::AddAnalysisMessageSuppressionComment)
public:
void match(const QmlJSQuickFixInterface &interface, QuickFixOperations &result) override
{
const QList<StaticAnalysis::Message> &messages = interface->semanticInfo().staticAnalysisMessages;
StaticAnalysis::Message _message;
foreach (const StaticAnalysis::Message &message, messages) {
if (interface->currentFile()->isCursorOn(message.location)) {
result << new Operation(interface, message);
return;
}
}
Q_DECLARE_TR_FUNCTIONS(AddAnalysisMessageSuppressionComment)
public:
AnalysizeMessageSuppressionOperation(const QSharedPointer<const QmlJSQuickFixAssistInterface> &interface,
const StaticAnalysis::Message &message)
: QmlJSQuickFixOperation(interface, 0)
, _message(message)
{
setDescription(tr("Add a Comment to Suppress This Message"));
}
private:
class Operation: public QmlJSQuickFixOperation
virtual void performChanges(QmlJSRefactoringFilePtr currentFile,
const QmlJSRefactoringChanges &)
{
StaticAnalysis::Message _message;
public:
Operation(const QSharedPointer<const QmlJSQuickFixAssistInterface> &interface,
const StaticAnalysis::Message &message)
: QmlJSQuickFixOperation(interface, 0)
, _message(message)
{
setDescription(AddAnalysisMessageSuppressionComment::tr("Add a Comment to Suppress This Message"));
}
virtual void performChanges(QmlJSRefactoringFilePtr currentFile,
const QmlJSRefactoringChanges &)
{
Utils::ChangeSet changes;
const int insertLoc = _message.location.begin() - _message.location.startColumn + 1;
changes.insert(insertLoc, QString::fromLatin1("// %1\n").arg(_message.suppressionString()));
currentFile->setChangeSet(changes);
currentFile->appendIndentRange(Range(insertLoc, insertLoc + 1));
currentFile->apply();
}
};
Utils::ChangeSet changes;
const int insertLoc = _message.location.begin() - _message.location.startColumn + 1;
changes.insert(insertLoc, QString::fromLatin1("// %1\n").arg(_message.suppressionString()));
currentFile->setChangeSet(changes);
currentFile->appendIndentRange(Range(insertLoc, insertLoc + 1));
currentFile->apply();
}
};
void matchAddAnalysisMessageSuppressionCommentQuickFix(const QmlJSQuickFixInterface &interface, QuickFixOperations &result)
{
const QList<StaticAnalysis::Message> &messages = interface->semanticInfo().staticAnalysisMessages;
foreach (const StaticAnalysis::Message &message, messages) {
if (interface->currentFile()->isCursorOn(message.location)) {
result << new AnalysizeMessageSuppressionOperation(interface, message);
return;
}
}
}
} // end of anonymous namespace
void registerQuickFixes(ExtensionSystem::IPlugin *plugIn)
QuickFixOperations findQmlJSQuickFixes(const AssistInterface *interface)
{
plugIn->addAutoReleasedObject(new SplitInitializerOp);
plugIn->addAutoReleasedObject(new ComponentFromObjectDef);
plugIn->addAutoReleasedObject(new WrapInLoader);
plugIn->addAutoReleasedObject(new AddAnalysisMessageSuppressionComment);
QSharedPointer<const AssistInterface> assistInterface(interface);
auto qmlJSInterface = assistInterface.staticCast<const QmlJSQuickFixAssistInterface>();
QuickFixOperations quickFixes;
matchSplitInitializerQuickFix(qmlJSInterface, quickFixes);
matchComponentFromObjectDefQuickFix(qmlJSInterface, quickFixes);
matchWrapInLoaderQuickFix(qmlJSInterface, quickFixes);
matchAddAnalysisMessageSuppressionCommentQuickFix(qmlJSInterface, quickFixes);
return quickFixes;
}
} // namespace QmlJSEditor

2
src/plugins/qmljseditor/qmljswrapinloader.cpp
View File

@@ -174,7 +174,7 @@ public:
} // end of anonymous namespace
void WrapInLoader::match(const QmlJSQuickFixInterface &interface, QuickFixOperations &result)
void matchWrapInLoaderQuickFix(const QmlJSQuickFixInterface &interface, QuickFixOperations &result)
{
const int pos = interface->currentFile()->cursor().position();

7
src/plugins/qmljseditor/qmljswrapinloader.h
View File

@@ -28,12 +28,7 @@
#include "qmljsquickfix.h"
namespace QmlJSEditor {
namespace Internal {
class WrapInLoader: public QmlJSQuickFixFactory
{
void match(const QmlJSQuickFixInterface &interface, QuickFixOperations &result) override;
};
void matchWrapInLoaderQuickFix(const QmlJSQuickFixInterface &interface, QuickFixOperations &result);
} // namespace Internal
} // namespace QmlJSEditor