Reworked the QuickFix infrastructure.

This commit is contained in:
Erik Verbruggen
2010-07-26 13:06:33 +02:00
parent 5bf0ba0b85
commit d980e37e24
16 changed files with 2412 additions and 2148 deletions

View File

@@ -40,11 +40,10 @@
#include <QtCore/QFileInfo>
using namespace QmlJS::AST;
using namespace QmlJSEditor;
using namespace QmlJSEditor::Internal;
ComponentFromObjectDef::ComponentFromObjectDef(TextEditor::BaseTextEditor *editor)
: QmlJSQuickFixOperation(editor), _objDef(0)
{}
namespace {
static QString getId(UiObjectDefinition *def)
{
@@ -74,60 +73,71 @@ static QString getId(UiObjectDefinition *def)
return QString();
}
QString ComponentFromObjectDef::description() const
class Operation: public QmlJSQuickFixOperation
{
return QCoreApplication::translate("QmlJSEditor::ComponentFromObjectDef",
"Extract Component");
}
UiObjectDefinition *_objDef;
void ComponentFromObjectDef::createChanges()
{
Q_ASSERT(_objDef != 0);
QString componentName = getId(_objDef);
componentName[0] = componentName.at(0).toUpper();
const QString path = editor()->file()->fileName();
const QString newFileName = QFileInfo(path).path() + QDir::separator() + componentName + QLatin1String(".qml");
QString imports;
UiProgram *prog = semanticInfo().document->qmlProgram();
if (prog && prog->imports) {
const int start = startPosition(prog->imports->firstSourceLocation());
const int end = startPosition(prog->members->member->firstSourceLocation());
imports = textOf(start, end);
public:
Operation(const QmlJSQuickFixState &state, UiObjectDefinition *objDef)
: QmlJSQuickFixOperation(state, 0)
, _objDef(objDef)
{
setDescription(QCoreApplication::translate("QmlJSEditor::ComponentFromObjectDef",
"Extract Component"));
}
const int start = startPosition(_objDef->firstSourceLocation());
const int end = startPosition(_objDef->lastSourceLocation());
const QString txt = imports + textOf(start, end) + QLatin1String("}\n");
virtual void createChanges()
{
Q_ASSERT(_objDef != 0);
Utils::ChangeSet changes;
changes.replace(start, end, componentName + QLatin1String(" {\n"));
qmljsRefactoringChanges()->changeFile(fileName(), changes);
qmljsRefactoringChanges()->reindent(fileName(), range(start, end + 1));
QString componentName = getId(_objDef);
componentName[0] = componentName.at(0).toUpper();
qmljsRefactoringChanges()->createFile(newFileName, txt);
qmljsRefactoringChanges()->reindent(newFileName, range(0, txt.length() - 1));
}
const QString path = fileName();
const QString newFileName = QFileInfo(path).path() + QDir::separator() + componentName + QLatin1String(".qml");
int ComponentFromObjectDef::check()
QString imports;
UiProgram *prog = state().semanticInfo().document->qmlProgram();
if (prog && prog->imports) {
const int start = startPosition(prog->imports->firstSourceLocation());
const int end = startPosition(prog->members->member->firstSourceLocation());
imports = state().textOf(start, end);
}
const int start = startPosition(_objDef->firstSourceLocation());
const int end = startPosition(_objDef->lastSourceLocation());
const QString txt = imports + state().textOf(start, end)
+ QLatin1String("}\n");
Utils::ChangeSet changes;
changes.replace(start, end, componentName + QLatin1String(" {\n"));
refactoringChanges()->changeFile(fileName(), changes);
refactoringChanges()->reindent(fileName(), range(start, end + 1));
refactoringChanges()->createFile(newFileName, txt);
refactoringChanges()->reindent(newFileName, range(0, txt.length() - 1));
}
};
} // end of anonymous namespace
QList<QmlJSQuickFixOperation::Ptr> ComponentFromObjectDef::match(const QmlJSQuickFixState &state)
{
_objDef = 0;
const int pos = textCursor().position();
QList<QmlJSQuickFixOperation::Ptr> result;
const int pos = state.textCursor().position();
QList<Node *> path = semanticInfo().astPath(pos);
QList<Node *> path = state.semanticInfo().astPath(pos);
for (int i = path.size() - 1; i >= 0; --i) {
Node *node = path.at(i);
if (UiObjectDefinition *objDef = cast<UiObjectDefinition *>(node)) {
if (i > 0 && !cast<UiProgram*>(path.at(i - 1))) { // node is not the root node
if (!getId(objDef).isEmpty()) {
_objDef = objDef;
return 0;
result.append(QmlJSQuickFixOperation::Ptr(new Operation(state, objDef)));
return result;
}
}
}
}
return -1;
return result;
}

View File

@@ -35,17 +35,10 @@
namespace QmlJSEditor {
namespace Internal {
class ComponentFromObjectDef: public QmlJSQuickFixOperation
class ComponentFromObjectDef: public QmlJSQuickFixFactory
{
public:
ComponentFromObjectDef(TextEditor::BaseTextEditor *editor);
virtual QString description() const;
virtual void createChanges();
virtual int check();
private:
QmlJS::AST::UiObjectDefinition *_objDef;
virtual QList<QmlJSQuickFixOperation::Ptr> match(const QmlJSQuickFixState &state);
};
} // namespace Internal

View File

@@ -179,6 +179,7 @@ bool QmlJSEditorPlugin::initialize(const QStringList & /*arguments*/, QString *e
m_quickFixCollector = new QmlJSQuickFixCollector;
addAutoReleasedObject(m_quickFixCollector);
QmlJSQuickFixCollector::registerQuickFixes(this);
addAutoReleasedObject(new QmlJSOutlineWidgetFactory);

View File

@@ -33,6 +33,7 @@
#include "qmljsrefactoringchanges.h"
#include "qmljs/parser/qmljsast_p.h"
#include <extensionsystem/iplugin.h>
#include <extensionsystem/pluginmanager.h>
#include <qmljs/qmljsmodelmanagerinterface.h>
@@ -40,146 +41,157 @@
#include <QtGui/QApplication>
#include <QtCore/QDebug>
using namespace QmlJS;
using namespace QmlJS::AST;
using namespace QmlJSEditor;
using namespace QmlJSEditor::Internal;
using namespace TextEditor;
using TextEditor::RefactoringChanges;
class QmlJSQuickFixState: public TextEditor::QuickFixState
{
public:
SemanticInfo semanticInfo;
};
namespace {
class SplitInitializerOp: public QmlJSQuickFixOperation {
class SplitInitializerOp: public QmlJSQuickFixFactory
{
public:
SplitInitializerOp(TextEditor::BaseTextEditor *editor)
: QmlJSQuickFixOperation(editor), _objectInitializer(0)
{}
virtual QList<QmlJSQuickFixOperation::Ptr> match(const QmlJSQuickFixState &state)
{
QList<QmlJSQuickFixOperation::Ptr> result;
UiObjectInitializer *objectInitializer = 0;
const int pos = state.textCursor().position();
if (QmlJS::AST::Node *member = state.semanticInfo().declaringMember(pos)) {
if (QmlJS::AST::UiObjectBinding *b = QmlJS::AST::cast<QmlJS::AST::UiObjectBinding *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
objectInitializer = b->initializer;
} else if (QmlJS::AST::UiObjectDefinition *b = QmlJS::AST::cast<QmlJS::AST::UiObjectDefinition *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
objectInitializer = b->initializer;
}
}
if (objectInitializer)
result.append(QSharedPointer<QmlJSQuickFixOperation>(new Operation(state, objectInitializer)));
return result;
}
virtual QString description() const
{
return QApplication::translate("QmlJSEditor::QuickFix", "Split initializer");
}
virtual void createChanges()
{
Q_ASSERT(_objectInitializer != 0);
Utils::ChangeSet changes;
for (QmlJS::AST::UiObjectMemberList *it = _objectInitializer->members; it; it = it->next) {
if (QmlJS::AST::UiObjectMember *member = it->member) {
const QmlJS::AST::SourceLocation loc = member->firstSourceLocation();
// insert a newline at the beginning of this binding
changes.insert(startPosition(loc), QLatin1String("\n"));
}
}
// insert a newline before the closing brace
changes.insert(startPosition(_objectInitializer->rbraceToken),
QLatin1String("\n"));
refactoringChanges()->changeFile(fileName(), changes);
refactoringChanges()->reindent(fileName(),
range(startPosition(_objectInitializer->lbraceToken),
startPosition(_objectInitializer->rbraceToken)));
}
virtual int check()
{
_objectInitializer = 0;
const int pos = textCursor().position();
if (QmlJS::AST::Node *member = semanticInfo().declaringMember(pos)) {
if (QmlJS::AST::UiObjectBinding *b = QmlJS::AST::cast<QmlJS::AST::UiObjectBinding *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
_objectInitializer = b->initializer;
} else if (QmlJS::AST::UiObjectDefinition *b = QmlJS::AST::cast<QmlJS::AST::UiObjectDefinition *>(member)) {
if (b->initializer->lbraceToken.startLine == b->initializer->rbraceToken.startLine)
_objectInitializer = b->initializer;
}
}
if (! _objectInitializer)
return -1;
return 0; // very high priority
}
private:
QmlJS::AST::UiObjectInitializer *_objectInitializer;
};
class Operation: public QmlJSQuickFixOperation
{
UiObjectInitializer *_objectInitializer;
public:
Operation(const QmlJSQuickFixState &state, UiObjectInitializer *objectInitializer)
: QmlJSQuickFixOperation(state, 0)
, _objectInitializer(objectInitializer)
{}
virtual void createChanges()
{
Q_ASSERT(_objectInitializer != 0);
Utils::ChangeSet changes;
for (QmlJS::AST::UiObjectMemberList *it = _objectInitializer->members; it; it = it->next) {
if (QmlJS::AST::UiObjectMember *member = it->member) {
const QmlJS::AST::SourceLocation loc = member->firstSourceLocation();
// insert a newline at the beginning of this binding
changes.insert(startPosition(loc), QLatin1String("\n"));
}
}
// insert a newline before the closing brace
changes.insert(startPosition(_objectInitializer->rbraceToken),
QLatin1String("\n"));
refactoringChanges()->changeFile(fileName(), changes);
refactoringChanges()->reindent(fileName(),
range(startPosition(_objectInitializer->lbraceToken),
startPosition(_objectInitializer->rbraceToken)));
}
};
};
} // end of anonymous namespace
QmlJSQuickFixState::QmlJSQuickFixState(TextEditor::BaseTextEditor *editor)
: QuickFixState(editor)
{
}
QmlJSQuickFixOperation::QmlJSQuickFixOperation(TextEditor::BaseTextEditor *editor)
: TextEditor::QuickFixOperation(editor)
, _refactoringChanges(0)
SemanticInfo QmlJSQuickFixState::semanticInfo() const
{
return _semanticInfo;
}
Snapshot QmlJSQuickFixState::snapshot() const
{
return _semanticInfo.snapshot;
}
Document::Ptr QmlJSQuickFixState::document() const
{
return _semanticInfo.document;
}
unsigned QmlJSQuickFixState::startPosition(const QmlJS::AST::SourceLocation &loc) const
{
return position(loc.startLine, loc.startColumn);
}
QmlJSQuickFixOperation::QmlJSQuickFixOperation(const QmlJSQuickFixState &state, int priority)
: QuickFixOperation(priority)
, _state(state)
, _refactoringChanges(new QmlJSRefactoringChanges(ExtensionSystem::PluginManager::instance()->getObject<QmlJS::ModelManagerInterface>(),
state.snapshot()))
{
}
QmlJSQuickFixOperation::~QmlJSQuickFixOperation()
{
if (_refactoringChanges)
delete _refactoringChanges;
}
QmlJS::Document::Ptr QmlJSQuickFixOperation::document() const
const QmlJSQuickFixState &QmlJSQuickFixOperation::state() const
{
return _semanticInfo.document;
}
const QmlJS::Snapshot &QmlJSQuickFixOperation::snapshot() const
{
return _semanticInfo.snapshot;
}
const SemanticInfo &QmlJSQuickFixOperation::semanticInfo() const
{
return _semanticInfo;
}
int QmlJSQuickFixOperation::match(TextEditor::QuickFixState *state)
{
QmlJS::ModelManagerInterface *modelManager = ExtensionSystem::PluginManager::instance()->getObject<QmlJS::ModelManagerInterface>();
QmlJSQuickFixState *s = static_cast<QmlJSQuickFixState *>(state);
_semanticInfo = s->semanticInfo;
if (_refactoringChanges) {
delete _refactoringChanges;
}
_refactoringChanges = new QmlJSRefactoringChanges(modelManager, _semanticInfo.snapshot);
return check();
return _state;
}
QString QmlJSQuickFixOperation::fileName() const
{
return document()->fileName();
return state().document()->fileName();
}
void QmlJSQuickFixOperation::apply()
QmlJSRefactoringChanges *QmlJSQuickFixOperation::refactoringChanges() const
{
_refactoringChanges->apply();
return _refactoringChanges.data();
}
QmlJSRefactoringChanges *QmlJSQuickFixOperation::qmljsRefactoringChanges() const
{ return _refactoringChanges; }
RefactoringChanges *QmlJSQuickFixOperation::refactoringChanges() const
{ return qmljsRefactoringChanges(); }
unsigned QmlJSQuickFixOperation::startPosition(const QmlJS::AST::SourceLocation &loc) const
QmlJSQuickFixFactory::QmlJSQuickFixFactory()
{
return position(loc.startLine, loc.startColumn);
}
QmlJSQuickFixFactory::~QmlJSQuickFixFactory()
{
}
QList<QuickFixOperation::Ptr> QmlJSQuickFixFactory::matchingOperations(QuickFixState *state)
{
if (QmlJSQuickFixState *qmljsState = static_cast<QmlJSQuickFixState *>(state))
return match(*qmljsState);
else
return QList<TextEditor::QuickFixOperation::Ptr>();
}
QmlJSQuickFixCollector::QmlJSQuickFixCollector()
{
}
@@ -190,35 +202,39 @@ QmlJSQuickFixCollector::~QmlJSQuickFixCollector()
bool QmlJSQuickFixCollector::supportsEditor(TextEditor::ITextEditable *editable)
{
if (qobject_cast<QmlJSTextEditor *>(editable->widget()) != 0)
return true;
return false;
return qobject_cast<QmlJSTextEditor *>(editable->widget()) != 0;
}
TextEditor::QuickFixState *QmlJSQuickFixCollector::initializeCompletion(TextEditor::ITextEditable *editable)
TextEditor::QuickFixState *QmlJSQuickFixCollector::initializeCompletion(TextEditor::BaseTextEditor *editor)
{
if (QmlJSTextEditor *editor = qobject_cast<QmlJSTextEditor *>(editable->widget())) {
const SemanticInfo info = editor->semanticInfo();
if (QmlJSTextEditor *qmljsEditor = qobject_cast<QmlJSTextEditor *>(editor)) {
const SemanticInfo info = qmljsEditor->semanticInfo();
if (editor->isOutdated()) {
if (qmljsEditor->isOutdated()) {
// outdated
qWarning() << "TODO: outdated semantic info, force a reparse.";
return 0;
}
QmlJSQuickFixState *state = new QmlJSQuickFixState;
state->semanticInfo = info;
QmlJSQuickFixState *state = new QmlJSQuickFixState(editor);
state->_semanticInfo = info;
return state;
}
return 0;
}
QList<TextEditor::QuickFixOperation::Ptr> QmlJSQuickFixCollector::quickFixOperations(TextEditor::BaseTextEditor *editor) const
QList<TextEditor::QuickFixFactory *> QmlJSQuickFixCollector::quickFixFactories() const
{
QList<TextEditor::QuickFixOperation::Ptr> quickFixOperations;
quickFixOperations.append(TextEditor::QuickFixOperation::Ptr(new SplitInitializerOp(editor)));
quickFixOperations.append(TextEditor::QuickFixOperation::Ptr(new ComponentFromObjectDef(editor)));
return quickFixOperations;
QList<TextEditor::QuickFixFactory *> results;
ExtensionSystem::PluginManager *pm = ExtensionSystem::PluginManager::instance();
foreach (QmlJSQuickFixFactory *f, pm->getObjects<QmlJSEditor::QmlJSQuickFixFactory>())
results.append(f);
return results;
}
void QmlJSQuickFixCollector::registerQuickFixes(ExtensionSystem::IPlugin *plugIn)
{
plugIn->addAutoReleasedObject(new SplitInitializerOp);
plugIn->addAutoReleasedObject(new ComponentFromObjectDef);
}

View File

@@ -31,49 +31,85 @@
#define QMLJSQUICKFIX_H
#include "qmljseditor.h"
#include "qmljsrefactoringchanges.h"
#include <texteditor/quickfix.h>
#include <qmljs/parser/qmljsastfwd_p.h>
#include <qmljs/qmljsdocument.h>
namespace ExtensionSystem {
class IPlugin;
}
namespace QmlJS {
class ModelManagerInterface;
}
namespace QmlJSEditor {
class QmlJSRefactoringChanges;
namespace Internal {
class QmlJSQuickFixCollector;
} // end of namespace Internal
class QmlJSQuickFixOperation: public TextEditor::QuickFixOperation
class QMLJS_EXPORT QmlJSQuickFixState: public TextEditor::QuickFixState
{
Q_DISABLE_COPY(QmlJSQuickFixOperation)
friend class Internal::QmlJSQuickFixCollector;
public:
QmlJSQuickFixOperation(TextEditor::BaseTextEditor *editor);
virtual ~QmlJSQuickFixOperation();
QmlJSQuickFixState(TextEditor::BaseTextEditor *editor);
typedef Utils::ChangeSet::Range Range;
Internal::SemanticInfo semanticInfo() const;
QmlJS::Snapshot snapshot() const;
QmlJS::Document::Ptr document() const;
const QmlJS::Snapshot &snapshot() const;
const SemanticInfo &semanticInfo() const;
virtual int check() = 0;
virtual int match(TextEditor::QuickFixState *state);
protected:
QString fileName() const;
virtual void apply();
QmlJSRefactoringChanges *qmljsRefactoringChanges() const;
virtual TextEditor::RefactoringChanges *refactoringChanges() const;
unsigned startPosition(const QmlJS::AST::SourceLocation &loc) const;
private:
SemanticInfo _semanticInfo;
QmlJSRefactoringChanges *_refactoringChanges;
Internal::SemanticInfo _semanticInfo;
};
class QMLJS_EXPORT QmlJSQuickFixOperation: public TextEditor::QuickFixOperation
{
Q_DISABLE_COPY(QmlJSQuickFixOperation)
public:
QmlJSQuickFixOperation(const QmlJSQuickFixState &state, int priority = -1);
virtual ~QmlJSQuickFixOperation();
const QmlJSQuickFixState &state() const;
protected:
QString fileName() const;
QmlJSRefactoringChanges *refactoringChanges() const;
protected: // Utility functions forwarding to QmlJSQuickFixState
unsigned startPosition(const QmlJS::AST::SourceLocation &loc) const
{ return state().startPosition(loc); }
static QmlJSQuickFixState::Range range(int start, int end)
{ return QmlJSQuickFixState::range(start, end); }
private:
QmlJSQuickFixState _state;
QScopedPointer<QmlJSRefactoringChanges> _refactoringChanges;
};
class QMLJS_EXPORT QmlJSQuickFixFactory: public TextEditor::QuickFixFactory
{
Q_OBJECT
public:
QmlJSQuickFixFactory();
virtual ~QmlJSQuickFixFactory();
virtual QList<TextEditor::QuickFixOperation::Ptr> matchingOperations(TextEditor::QuickFixState *state);
virtual QList<QmlJSQuickFixOperation::Ptr> match(const QmlJSQuickFixState &state) = 0;
};
namespace Internal {
class QmlJSQuickFixCollector: public TextEditor::QuickFixCollector
{
Q_OBJECT
@@ -83,8 +119,11 @@ public:
virtual ~QmlJSQuickFixCollector();
virtual bool supportsEditor(TextEditor::ITextEditable *editor);
virtual TextEditor::QuickFixState *initializeCompletion(TextEditor::ITextEditable *editable);
virtual QList<TextEditor::QuickFixOperation::Ptr> quickFixOperations(TextEditor::BaseTextEditor *editor) const;
virtual TextEditor::QuickFixState *initializeCompletion(TextEditor::BaseTextEditor *editor);
virtual QList<TextEditor::QuickFixFactory *> quickFixFactories() const;
static void registerQuickFixes(ExtensionSystem::IPlugin *plugIn);
};
} // end of namespace Internal

View File

@@ -40,7 +40,7 @@ class ModelManagerInterface;
namespace QmlJSEditor {
class QmlJSRefactoringChanges: public TextEditor::RefactoringChanges
class QMLJS_EXPORT QmlJSRefactoringChanges: public TextEditor::RefactoringChanges
{
public:
QmlJSRefactoringChanges(QmlJS::ModelManagerInterface *modelManager,