Plugins: Code cosmetics

Get closer to a uniform pattern of code layout (public/private,
pimpl naming...)

Change-Id: If2bc6dcee3df9127274f479b4ebc270d283dcb65
Reviewed-by: Xing Xiong
Reviewed-by: Christian Stenger <christian.stenger@qt.io>
This commit is contained in:
hjk
2019-02-21 14:59:57 +01:00
parent 095df95bfa
commit b5c3ce57ca
12 changed files with 29 additions and 60 deletions

View File

@@ -29,16 +29,12 @@
namespace Android { namespace Android {
namespace Internal { namespace Internal {
class AndroidPluginPrivate;
class AndroidPlugin : public ExtensionSystem::IPlugin class AndroidPlugin : public ExtensionSystem::IPlugin
{ {
Q_OBJECT Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "Android.json") Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "Android.json")
public:
AndroidPlugin() = default;
private:
~AndroidPlugin() final; ~AndroidPlugin() final;
bool initialize(const QStringList &arguments, QString *errorMessage) final; bool initialize(const QStringList &arguments, QString *errorMessage) final;
@@ -46,7 +42,7 @@ private:
void kitsRestored(); void kitsRestored();
AndroidPluginPrivate *d = nullptr; class AndroidPluginPrivate *d = nullptr;
}; };
} // namespace Internal } // namespace Internal

View File

@@ -39,7 +39,7 @@
namespace AutotoolsProjectManager { namespace AutotoolsProjectManager {
namespace Internal { namespace Internal {
class AutotoolsProjectPluginRunData class AutotoolsProjectPluginPrivate
{ {
public: public:
AutotoolsBuildConfigurationFactory buildConfigurationFactory; AutotoolsBuildConfigurationFactory buildConfigurationFactory;
@@ -51,7 +51,7 @@ public:
AutotoolsProjectPlugin::~AutotoolsProjectPlugin() AutotoolsProjectPlugin::~AutotoolsProjectPlugin()
{ {
delete m_runData; delete d;
} }
void AutotoolsProjectPlugin::extensionsInitialized() void AutotoolsProjectPlugin::extensionsInitialized()
@@ -63,7 +63,7 @@ bool AutotoolsProjectPlugin::initialize(const QStringList &arguments,
Q_UNUSED(arguments) Q_UNUSED(arguments)
Q_UNUSED(errorString) Q_UNUSED(errorString)
m_runData = new AutotoolsProjectPluginRunData; d = new AutotoolsProjectPluginPrivate;
ProjectExplorer::ProjectManager::registerProjectType<AutotoolsProject>(Constants::MAKEFILE_MIMETYPE); ProjectExplorer::ProjectManager::registerProjectType<AutotoolsProject>(Constants::MAKEFILE_MIMETYPE);
return true; return true;

View File

@@ -60,8 +60,6 @@ namespace Internal {
* be executed in the build process) * be executed in the build process)
*/ */
class AutotoolsProjectPluginRunData;
class AutotoolsProjectPlugin : public ExtensionSystem::IPlugin class AutotoolsProjectPlugin : public ExtensionSystem::IPlugin
{ {
Q_OBJECT Q_OBJECT
@@ -72,7 +70,7 @@ class AutotoolsProjectPlugin : public ExtensionSystem::IPlugin
void extensionsInitialized() final; void extensionsInitialized() final;
bool initialize(const QStringList &arguments, QString *errorString) final; bool initialize(const QStringList &arguments, QString *errorString) final;
AutotoolsProjectPluginRunData *m_runData; class AutotoolsProjectPluginPrivate *d;
}; };
} // namespace Internal } // namespace Internal

View File

@@ -46,7 +46,7 @@ using namespace ProjectExplorer;
namespace BareMetal { namespace BareMetal {
namespace Internal { namespace Internal {
class BareMetalPluginRunData class BareMetalPluginPrivate
{ {
public: public:
BareMetalDeviceFactory deviceFactory; BareMetalDeviceFactory deviceFactory;
@@ -56,14 +56,9 @@ public:
GdbServerProviderManager gdbServerProviderManager; GdbServerProviderManager gdbServerProviderManager;
}; };
BareMetalPlugin::BareMetalPlugin()
{
setObjectName(QLatin1String("BareMetalPlugin"));
}
BareMetalPlugin::~BareMetalPlugin() BareMetalPlugin::~BareMetalPlugin()
{ {
delete m_runData; delete d;
} }
bool BareMetalPlugin::initialize(const QStringList &arguments, QString *errorString) bool BareMetalPlugin::initialize(const QStringList &arguments, QString *errorString)
@@ -71,7 +66,7 @@ bool BareMetalPlugin::initialize(const QStringList &arguments, QString *errorStr
Q_UNUSED(arguments) Q_UNUSED(arguments)
Q_UNUSED(errorString) Q_UNUSED(errorString)
m_runData = new BareMetalPluginRunData; d = new BareMetalPluginPrivate;
auto constraint = [](RunConfiguration *runConfig) { auto constraint = [](RunConfiguration *runConfig) {
const QByteArray idStr = runConfig->id().name(); const QByteArray idStr = runConfig->id().name();

View File

@@ -31,23 +31,17 @@
namespace BareMetal { namespace BareMetal {
namespace Internal { namespace Internal {
class BareMetalPluginRunData;
class BareMetalPlugin : public ExtensionSystem::IPlugin class BareMetalPlugin : public ExtensionSystem::IPlugin
{ {
Q_OBJECT Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "BareMetal.json") Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "BareMetal.json")
public:
BareMetalPlugin();
private:
~BareMetalPlugin() final; ~BareMetalPlugin() final;
bool initialize(const QStringList &arguments, QString *errorString) final; bool initialize(const QStringList &arguments, QString *errorString) final;
void extensionsInitialized() final; void extensionsInitialized() final;
BareMetalPluginRunData *m_runData; class BareMetalPluginPrivate *d;
}; };
} // namespace Internal } // namespace Internal

View File

@@ -36,7 +36,7 @@ namespace BareMetal {
namespace Internal { namespace Internal {
class BareMetalPlugin; class BareMetalPlugin;
class BareMetalPluginRunData; class BareMetalPluginPrivate;
class GdbServerProvider; class GdbServerProvider;
class GdbServerProviderFactory; class GdbServerProviderFactory;
@@ -75,7 +75,7 @@ private:
const QList<GdbServerProviderFactory *> m_factories; const QList<GdbServerProviderFactory *> m_factories;
friend class BareMetalPlugin; // for restoreProviders friend class BareMetalPlugin; // for restoreProviders
friend class BareMetalPluginRunData; // for constructor friend class BareMetalPluginPrivate; // for constructor
friend class GdbServerProvider; friend class GdbServerProvider;
}; };

View File

@@ -38,8 +38,6 @@ class BinEditorPlugin : public ExtensionSystem::IPlugin
Q_OBJECT Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "BinEditor.json") Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "BinEditor.json")
public:
BinEditorPlugin() = default;
~BinEditorPlugin() override; ~BinEditorPlugin() override;
bool initialize(const QStringList &arguments, QString *errorMessage) final; bool initialize(const QStringList &arguments, QString *errorMessage) final;

View File

@@ -54,10 +54,10 @@ using namespace Bookmarks::Constants;
namespace Bookmarks { namespace Bookmarks {
namespace Internal { namespace Internal {
class BookmarksPluginRunData : public QObject class BookmarksPluginPrivate : public QObject
{ {
public: public:
BookmarksPluginRunData(); BookmarksPluginPrivate();
void updateActions(bool enableToggle, int stateMask); void updateActions(bool enableToggle, int stateMask);
void editorOpened(Core::IEditor *editor); void editorOpened(Core::IEditor *editor);
@@ -84,16 +84,16 @@ public:
BookmarksPlugin::~BookmarksPlugin() BookmarksPlugin::~BookmarksPlugin()
{ {
delete m_runData; delete d;
} }
bool BookmarksPlugin::initialize(const QStringList &, QString *) bool BookmarksPlugin::initialize(const QStringList &, QString *)
{ {
m_runData = new BookmarksPluginRunData; d = new BookmarksPluginPrivate;
return true; return true;
} }
BookmarksPluginRunData::BookmarksPluginRunData() BookmarksPluginPrivate::BookmarksPluginPrivate()
: m_bookmarkFilter(&m_bookmarkManager) : m_bookmarkFilter(&m_bookmarkManager)
, m_bookmarkViewFactory(&m_bookmarkManager) , m_bookmarkViewFactory(&m_bookmarkManager)
{ {
@@ -162,7 +162,7 @@ BookmarksPluginRunData::BookmarksPluginRunData()
}); });
connect(&m_bookmarkManager, &BookmarkManager::updateActions, connect(&m_bookmarkManager, &BookmarkManager::updateActions,
this, &BookmarksPluginRunData::updateActions); this, &BookmarksPluginPrivate::updateActions);
updateActions(false, m_bookmarkManager.state()); updateActions(false, m_bookmarkManager.state());
connect(&m_bookmarkMarginAction, &QAction::triggered, this, [this] { connect(&m_bookmarkMarginAction, &QAction::triggered, this, [this] {
@@ -171,12 +171,12 @@ BookmarksPluginRunData::BookmarksPluginRunData()
// EditorManager // EditorManager
connect(EditorManager::instance(), &EditorManager::editorAboutToClose, connect(EditorManager::instance(), &EditorManager::editorAboutToClose,
this, &BookmarksPluginRunData::editorAboutToClose); this, &BookmarksPluginPrivate::editorAboutToClose);
connect(EditorManager::instance(), &EditorManager::editorOpened, connect(EditorManager::instance(), &EditorManager::editorOpened,
this, &BookmarksPluginRunData::editorOpened); this, &BookmarksPluginPrivate::editorOpened);
} }
void BookmarksPluginRunData::updateActions(bool enableToggle, int state) void BookmarksPluginPrivate::updateActions(bool enableToggle, int state)
{ {
const bool hasbm = state >= BookmarkManager::HasBookMarks; const bool hasbm = state >= BookmarkManager::HasBookMarks;
const bool hasdocbm = state == BookmarkManager::HasBookmarksInDocument; const bool hasdocbm = state == BookmarkManager::HasBookmarksInDocument;
@@ -188,7 +188,7 @@ void BookmarksPluginRunData::updateActions(bool enableToggle, int state)
m_docNextAction.setEnabled(hasdocbm); m_docNextAction.setEnabled(hasdocbm);
} }
void BookmarksPluginRunData::editorOpened(IEditor *editor) void BookmarksPluginPrivate::editorOpened(IEditor *editor)
{ {
if (auto widget = qobject_cast<TextEditorWidget *>(editor->widget())) { if (auto widget = qobject_cast<TextEditorWidget *>(editor->widget())) {
connect(widget, &TextEditorWidget::markRequested, connect(widget, &TextEditorWidget::markRequested,
@@ -198,19 +198,19 @@ void BookmarksPluginRunData::editorOpened(IEditor *editor)
}); });
connect(widget, &TextEditorWidget::markContextMenuRequested, connect(widget, &TextEditorWidget::markContextMenuRequested,
this, &BookmarksPluginRunData::requestContextMenu); this, &BookmarksPluginPrivate::requestContextMenu);
} }
} }
void BookmarksPluginRunData::editorAboutToClose(IEditor *editor) void BookmarksPluginPrivate::editorAboutToClose(IEditor *editor)
{ {
if (auto widget = qobject_cast<TextEditorWidget *>(editor->widget())) { if (auto widget = qobject_cast<TextEditorWidget *>(editor->widget())) {
disconnect(widget, &TextEditorWidget::markContextMenuRequested, disconnect(widget, &TextEditorWidget::markContextMenuRequested,
this, &BookmarksPluginRunData::requestContextMenu); this, &BookmarksPluginPrivate::requestContextMenu);
} }
} }
void BookmarksPluginRunData::requestContextMenu(TextEditorWidget *widget, void BookmarksPluginPrivate::requestContextMenu(TextEditorWidget *widget,
int lineNumber, QMenu *menu) int lineNumber, QMenu *menu)
{ {
if (widget->textDocument()->isTemporary()) if (widget->textDocument()->isTemporary())

View File

@@ -30,22 +30,17 @@
namespace Bookmarks { namespace Bookmarks {
namespace Internal { namespace Internal {
class BookmarksPluginRunData;
class BookmarksPlugin : public ExtensionSystem::IPlugin class BookmarksPlugin : public ExtensionSystem::IPlugin
{ {
Q_OBJECT Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "Bookmarks.json") Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "Bookmarks.json")
public:
BookmarksPlugin() = default;
~BookmarksPlugin() final; ~BookmarksPlugin() final;
private:
bool initialize(const QStringList &arguments, QString *errorMessage) final; bool initialize(const QStringList &arguments, QString *errorMessage) final;
void extensionsInitialized() final {} void extensionsInitialized() final {}
BookmarksPluginRunData *m_runData = nullptr; class BookmarksPluginPrivate *d = nullptr;
}; };
} // namespace Internal } // namespace Internal

View File

@@ -65,9 +65,6 @@ using namespace ProjectExplorer;
namespace ClangFormat { namespace ClangFormat {
ClangFormatPlugin::ClangFormatPlugin() = default;
ClangFormatPlugin::~ClangFormatPlugin() = default;
#ifdef KEEP_LINE_BREAKS_FOR_NON_EMPTY_LINES_BACKPORTED #ifdef KEEP_LINE_BREAKS_FOR_NON_EMPTY_LINES_BACKPORTED
class ClangFormatStyleFactory : public CppTools::CppCodeStylePreferencesFactory class ClangFormatStyleFactory : public CppTools::CppCodeStylePreferencesFactory
{ {

View File

@@ -34,11 +34,6 @@ class ClangFormatPlugin : public ExtensionSystem::IPlugin
Q_OBJECT Q_OBJECT
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "ClangFormat.json") Q_PLUGIN_METADATA(IID "org.qt-project.Qt.QtCreatorPlugin" FILE "ClangFormat.json")
public:
ClangFormatPlugin();
~ClangFormatPlugin();
private:
bool initialize(const QStringList &arguments, QString *errorString) final; bool initialize(const QStringList &arguments, QString *errorString) final;
void extensionsInitialized() final {} void extensionsInitialized() final {}
}; };

View File

@@ -26,8 +26,9 @@
#pragma once #pragma once
#include "cmakespecificsettingspage.h" #include "cmakespecificsettingspage.h"
#include <extensionsystem/iplugin.h> #include <extensionsystem/iplugin.h>
#include <memory>
namespace CMakeProjectManager { namespace CMakeProjectManager {
namespace Internal { namespace Internal {