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

QmlJSEditorPlugin: Refactor

Browse Source 
This follows the recently introduced pattern for plugin setup
- Pimpl QmlJSEditorPlugin
- remove unneeded uses of global object pool
- apply "static pattern"
- simplify some constructors of data members in some cases
- use in-class initialization in some case

Change-Id: I95b42d0885f4a8d6c9bfe1e4c004d3ace0a3eba5
Reviewed-by: Marco Benelli <marco.benelli@qt.io>
Reviewed-by: David Schulz <david.schulz@qt.io>
This commit is contained in:
hjk
2018-02-15 09:50:02 +01:00
parent 4786c5928a
commit 3da9c89981
11 changed files with 120 additions and 163 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -58,12 +58,7 @@
#include <utils/qtcassert.h>
#include <utils/json.h>
#include <QtPlugin>
#include <QSettings>
#include <QDir>
#include <QCoreApplication>
#include <QTextDocument>
#include <QTimer>
#include <QMenu>
#include <QAction>
@@ -71,57 +66,88 @@ using namespace QmlJSEditor::Constants;
using namespace ProjectExplorer;
using namespace Core;
enum {
QUICKFIX_INTERVAL = 20
namespace QmlJSEditor {
namespace Internal {
class QmlJSEditorPluginPrivate : public QObject
{
public:
QmlJSEditorPluginPrivate();
void currentEditorChanged(IEditor *editor);
void runSemanticScan();
void checkCurrentEditorSemanticInfoUpToDate();
void autoFormatOnSave(IDocument *document);
Command *addToolAction(QAction *a, Context &context, Id id,
ActionContainer *c1, const QString &keySequence);
void findUsages();
void renameUsages();
void reformatFile();
void showContextPane();
QmlJSQuickFixAssistProvider m_quickFixAssistProvider;
QmlTaskManager m_qmlTaskManager;
QAction *m_reformatFileAction = nullptr;
QPointer<QmlJSEditorDocument> m_currentDocument;
Utils::JsonSchemaManager m_jsonManager{{ICore::userResourcePath() + "/json/",
ICore::resourcePath() + "/json/"}};
QmlJSEditorFactory m_qmlJSEditorFactory;
QmlJSOutlineWidgetFactory m_qmlJSOutlineWidgetFactory;
QuickToolBar m_quickToolBar;
QmlJsEditingSettingsPage m_qmJSEditingSettingsPage;
};
namespace QmlJSEditor {
using namespace Internal;
static QmlJSEditorPlugin *m_instance = nullptr;
QmlJSEditorPlugin *QmlJSEditorPlugin::m_instance = 0;
QmlJSEditorPlugin::QmlJSEditorPlugin() :
m_modelManager(0),
m_quickFixAssistProvider(0),
m_reformatFileAction(0),
m_currentDocument(0),
m_jsonManager(new Utils::JsonSchemaManager(
QStringList() << ICore::userResourcePath() + QLatin1String("/json/")
<< ICore::resourcePath() + QLatin1String("/json/")))
QmlJSEditorPlugin::QmlJSEditorPlugin()
{
m_instance = this;
}
QmlJSEditorPlugin::~QmlJSEditorPlugin()
{
m_instance = 0;
delete d;
d = nullptr;
m_instance = nullptr;
}
bool QmlJSEditorPlugin::initialize(const QStringList & /*arguments*/, QString *errorMessage)
bool QmlJSEditorPlugin::initialize(const QStringList &arguments, QString *errorMessage)
{
Q_UNUSED(arguments);
Q_UNUSED(errorMessage);
d = new QmlJSEditorPluginPrivate;
return true;
}
QmlJSEditorPluginPrivate::QmlJSEditorPluginPrivate()
{
m_modelManager = QmlJS::ModelManagerInterface::instance();
TextEditor::SnippetProvider::registerGroup(Constants::QML_SNIPPETS_GROUP_ID,
tr("QML", "SnippetProvider"),
QmlJSEditorPlugin::tr("QML", "SnippetProvider"),
&QmlJSEditorFactory::decorateEditor);
QmlJS::ModelManagerInterface *modelManager = QmlJS::ModelManagerInterface::instance();
// QML task updating manager
m_qmlTaskManager = new QmlTaskManager;
addAutoReleasedObject(m_qmlTaskManager);
connect(m_modelManager, &QmlJS::ModelManagerInterface::documentChangedOnDisk,
m_qmlTaskManager, &QmlTaskManager::updateMessages);
connect(modelManager, &QmlJS::ModelManagerInterface::documentChangedOnDisk,
&m_qmlTaskManager, &QmlTaskManager::updateMessages);
// recompute messages when information about libraries changes
connect(m_modelManager, &QmlJS::ModelManagerInterface::libraryInfoUpdated,
m_qmlTaskManager, &QmlTaskManager::updateMessages);
connect(modelManager, &QmlJS::ModelManagerInterface::libraryInfoUpdated,
&m_qmlTaskManager, &QmlTaskManager::updateMessages);
// recompute messages when project data changes (files added or removed)
connect(m_modelManager, &QmlJS::ModelManagerInterface::projectInfoUpdated,
m_qmlTaskManager, &QmlTaskManager::updateMessages);
connect(m_modelManager, &QmlJS::ModelManagerInterface::aboutToRemoveFiles,
m_qmlTaskManager, &QmlTaskManager::documentsRemoved);
connect(modelManager, &QmlJS::ModelManagerInterface::projectInfoUpdated,
&m_qmlTaskManager, &QmlTaskManager::updateMessages);
connect(modelManager, &QmlJS::ModelManagerInterface::aboutToRemoveFiles,
&m_qmlTaskManager, &QmlTaskManager::documentsRemoved);
Context context(Constants::C_QMLJSEDITOR_ID);
addAutoReleasedObject(new QmlJSEditorFactory);
ActionContainer *contextMenu = ActionManager::createMenu(Constants::M_CONTEXT);
ActionContainer *qmlToolsMenu = ActionManager::actionContainer(Id(QmlJSTools::Constants::M_TOOLS_QMLJS));
@@ -132,32 +158,32 @@ bool QmlJSEditorPlugin::initialize(const QStringList & /*arguments*/, QString *e
contextMenu->addAction(cmd);
qmlToolsMenu->addAction(cmd);
QAction *findUsagesAction = new QAction(tr("Find Usages"), this);
QAction *findUsagesAction = new QAction(QmlJSEditorPlugin::tr("Find Usages"), this);
cmd = ActionManager::registerAction(findUsagesAction, Constants::FIND_USAGES, context);
cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+U")));
connect(findUsagesAction, &QAction::triggered, this, &QmlJSEditorPlugin::findUsages);
cmd->setDefaultKeySequence(QKeySequence(QmlJSEditorPlugin::tr("Ctrl+Shift+U")));
connect(findUsagesAction, &QAction::triggered, this, &QmlJSEditorPluginPrivate::findUsages);
contextMenu->addAction(cmd);
qmlToolsMenu->addAction(cmd);
QAction *renameUsagesAction = new QAction(tr("Rename Symbol Under Cursor"), this);
QAction *renameUsagesAction = new QAction(QmlJSEditorPlugin::tr("Rename Symbol Under Cursor"), this);
cmd = ActionManager::registerAction(renameUsagesAction, Constants::RENAME_USAGES, context);
cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+R")));
connect(renameUsagesAction, &QAction::triggered, this, &QmlJSEditorPlugin::renameUsages);
cmd->setDefaultKeySequence(QKeySequence(QmlJSEditorPlugin::tr("Ctrl+Shift+R")));
connect(renameUsagesAction, &QAction::triggered, this, &QmlJSEditorPluginPrivate::renameUsages);
contextMenu->addAction(cmd);
qmlToolsMenu->addAction(cmd);
QAction *semanticScan = new QAction(tr("Run Checks"), this);
QAction *semanticScan = new QAction(QmlJSEditorPlugin::tr("Run Checks"), this);
cmd = ActionManager::registerAction(semanticScan, Id(Constants::RUN_SEMANTIC_SCAN));
cmd->setDefaultKeySequence(QKeySequence(tr("Ctrl+Shift+C")));
connect(semanticScan, &QAction::triggered, this, &QmlJSEditorPlugin::runSemanticScan);
cmd->setDefaultKeySequence(QKeySequence(QmlJSEditorPlugin::tr("Ctrl+Shift+C")));
connect(semanticScan, &QAction::triggered, this, &QmlJSEditorPluginPrivate::runSemanticScan);
qmlToolsMenu->addAction(cmd);
m_reformatFileAction = new QAction(tr("Reformat File"), this);
m_reformatFileAction = new QAction(QmlJSEditorPlugin::tr("Reformat File"), this);
cmd = ActionManager::registerAction(m_reformatFileAction, Id(Constants::REFORMAT_FILE), context);
connect(m_reformatFileAction, &QAction::triggered, this, &QmlJSEditorPlugin::reformatFile);
connect(m_reformatFileAction, &QAction::triggered, this, &QmlJSEditorPluginPrivate::reformatFile);
qmlToolsMenu->addAction(cmd);
QAction *inspectElementAction = new QAction(tr("Inspect API for Element Under Cursor"), this);
QAction *inspectElementAction = new QAction(QmlJSEditorPlugin::tr("Inspect API for Element Under Cursor"), this);
cmd = ActionManager::registerAction(inspectElementAction,
Id(Constants::INSPECT_ELEMENT_UNDER_CURSOR), context);
connect(inspectElementAction, &QAction::triggered, [] {
@@ -166,11 +192,11 @@ bool QmlJSEditorPlugin::initialize(const QStringList & /*arguments*/, QString *e
});
qmlToolsMenu->addAction(cmd);
QAction *showQuickToolbar = new QAction(tr("Show Qt Quick Toolbar"), this);
QAction *showQuickToolbar = new QAction(QmlJSEditorPlugin::tr("Show Qt Quick Toolbar"), this);
cmd = ActionManager::registerAction(showQuickToolbar, Constants::SHOW_QT_QUICK_HELPER, context);
cmd->setDefaultKeySequence(useMacShortcuts ? QKeySequence(Qt::META + Qt::ALT + Qt::Key_Space)
: QKeySequence(Qt::CTRL + Qt::ALT + Qt::Key_Space));
connect(showQuickToolbar, &QAction::triggered, this, &QmlJSEditorPlugin::showContextPane);
connect(showQuickToolbar, &QAction::triggered, this, &QmlJSEditorPluginPrivate::showContextPane);
contextMenu->addAction(cmd);
qmlToolsMenu->addAction(cmd);
@@ -185,24 +211,13 @@ bool QmlJSEditorPlugin::initialize(const QStringList & /*arguments*/, QString *e
cmd = ActionManager::command(TextEditor::Constants::UN_COMMENT_SELECTION);
contextMenu->addAction(cmd);
m_quickFixAssistProvider = new QmlJSQuickFixAssistProvider(this);
errorMessage->clear();
FileIconProvider::registerIconOverlayForSuffix(ProjectExplorer::Constants::FILEOVERLAY_QML, "qml");
addAutoReleasedObject(new QmlJSOutlineWidgetFactory);
addAutoReleasedObject(new QuickToolBar);
addAutoReleasedObject(new QmlJsEditingSettingsPage);
connect(EditorManager::instance(), &EditorManager::currentEditorChanged,
this, &QmlJSEditorPlugin::currentEditorChanged);
this, &QmlJSEditorPluginPrivate::currentEditorChanged);
connect(EditorManager::instance(), &Core::EditorManager::aboutToSave,
this, &QmlJSEditorPlugin::autoFormatOnSave);
return true;
connect(EditorManager::instance(), &EditorManager::aboutToSave,
this, &QmlJSEditorPluginPrivate::autoFormatOnSave);
}
void QmlJSEditorPlugin::extensionsInitialized()
@@ -218,24 +233,24 @@ ExtensionSystem::IPlugin::ShutdownFlag QmlJSEditorPlugin::aboutToShutdown()
return IPlugin::aboutToShutdown();
}
Utils::JsonSchemaManager *QmlJSEditorPlugin::jsonManager() const
Utils::JsonSchemaManager *QmlJSEditorPlugin::jsonManager()
{
return m_jsonManager.data();
return &m_instance->d->m_jsonManager;
}
void QmlJSEditorPlugin::findUsages()
void QmlJSEditorPluginPrivate::findUsages()
{
if (QmlJSEditorWidget *editor = qobject_cast<QmlJSEditorWidget*>(EditorManager::currentEditor()->widget()))
editor->findUsages();
}
void QmlJSEditorPlugin::renameUsages()
void QmlJSEditorPluginPrivate::renameUsages()
{
if (QmlJSEditorWidget *editor = qobject_cast<QmlJSEditorWidget*>(EditorManager::currentEditor()->widget()))
editor->renameUsages();
}
void QmlJSEditorPlugin::reformatFile()
void QmlJSEditorPluginPrivate::reformatFile()
{
if (m_currentDocument) {
QmlJS::Document::Ptr document = m_currentDocument->semanticInfo().document;
@@ -281,15 +296,15 @@ void QmlJSEditorPlugin::reformatFile()
}
}
void QmlJSEditorPlugin::showContextPane()
void QmlJSEditorPluginPrivate::showContextPane()
{
if (QmlJSEditorWidget *editor = qobject_cast<QmlJSEditorWidget*>(EditorManager::currentEditor()->widget()))
editor->showContextPane();
}
Command *QmlJSEditorPlugin::addToolAction(QAction *a,
Context &context, Id id,
ActionContainer *c1, const QString &keySequence)
Command *QmlJSEditorPluginPrivate::addToolAction(QAction *a,
Context &context, Id id,
ActionContainer *c1, const QString &keySequence)
{
Command *command = ActionManager::registerAction(a, id, context);
if (!keySequence.isEmpty())
@@ -298,14 +313,14 @@ Command *QmlJSEditorPlugin::addToolAction(QAction *a,
return command;
}
QmlJSQuickFixAssistProvider *QmlJSEditorPlugin::quickFixAssistProvider() const
QmlJSQuickFixAssistProvider *QmlJSEditorPlugin::quickFixAssistProvider()
{
return m_quickFixAssistProvider;
return &m_instance->d->m_quickFixAssistProvider;
}
void QmlJSEditorPlugin::currentEditorChanged(IEditor *editor)
void QmlJSEditorPluginPrivate::currentEditorChanged(IEditor *editor)
{
QmlJSEditorDocument *document = 0;
QmlJSEditorDocument *document = nullptr;
if (editor)
document = qobject_cast<QmlJSEditorDocument *>(editor->document());
@@ -314,26 +329,26 @@ void QmlJSEditorPlugin::currentEditorChanged(IEditor *editor)
m_currentDocument = document;
if (document) {
connect(document->document(), &QTextDocument::contentsChanged,
this, &QmlJSEditorPlugin::checkCurrentEditorSemanticInfoUpToDate);
this, &QmlJSEditorPluginPrivate::checkCurrentEditorSemanticInfoUpToDate);
connect(document, &QmlJSEditorDocument::semanticInfoUpdated,
this, &QmlJSEditorPlugin::checkCurrentEditorSemanticInfoUpToDate);
this, &QmlJSEditorPluginPrivate::checkCurrentEditorSemanticInfoUpToDate);
}
}
void QmlJSEditorPlugin::runSemanticScan()
void QmlJSEditorPluginPrivate::runSemanticScan()
{
m_qmlTaskManager->updateSemanticMessagesNow();
m_qmlTaskManager.updateSemanticMessagesNow();
TaskHub::setCategoryVisibility(Constants::TASK_CATEGORY_QML_ANALYSIS, true);
TaskHub::requestPopup();
}
void QmlJSEditorPlugin::checkCurrentEditorSemanticInfoUpToDate()
void QmlJSEditorPluginPrivate::checkCurrentEditorSemanticInfoUpToDate()
{
const bool semanticInfoUpToDate = m_currentDocument && !m_currentDocument->isSemanticInfoOutdated();
m_reformatFileAction->setEnabled(semanticInfoUpToDate);
}
void QmlJSEditorPlugin::autoFormatOnSave(Core::IDocument *document)
void QmlJSEditorPluginPrivate::autoFormatOnSave(IDocument *document)
{
if (!QmlJsEditingSettings::get().autoFormatOnSave())
return;
@@ -344,12 +359,13 @@ void QmlJSEditorPlugin::autoFormatOnSave(Core::IDocument *document)
// Check if file is contained in the current project (if wished)
if (QmlJsEditingSettings::get().autoFormatOnlyCurrentProject()) {
const ProjectExplorer::Project *pro = ProjectExplorer::ProjectTree::currentProject();
if (!pro || !pro->files(ProjectExplorer::Project::SourceFiles).contains(document->filePath()))
const Project *pro = ProjectTree::currentProject();
if (!pro || !pro->files(Project::SourceFiles).contains(document->filePath()))
return;
}
reformatFile();
}
} // namespace Internal
} // namespace QmlJSEditor