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

Simplify interface of classes in ClassViewPlugin

Browse Source 
Allow for direct connections where signal emitter and
receiver live in the same thread.
Remove unneeded mutexState, as changes to state and
all queries of state are done in the same thread.
Remove some indirections by removing some signals
and by calling respective slots through
QMetaObject::invokeMethod() or directly.
Remove some unused methods.
Remove a code path of setState(false), as this was never called.
Remove an initial call to onProjectListChanged(), as initially
the state is false and a call is no-op.

This change doesn't influence the existing behavior.

Task-number: QTCREATORBUG-25317
Change-Id: I683525b49afaf04e155d1859bb85ee5dd8e26dd2
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Jarek Kobus
2021-02-08 12:22:21 +01:00
parent 33d2d736ea
commit a673fca144
6 changed files with 70 additions and 358 deletions
Download Patch File Download Diff File Expand all files Collapse all files

250
src/plugins/classview/classviewmanager.cpp
View File

@@ -72,15 +72,6 @@ static Manager *managerInstance = nullptr;
Creates a shared instance of a \a parent object.
*/
/*!
\fn void ClassView::Internal::Manager::stateChanged(bool state)
Changes the internal manager state. \a state returns true if manager is
enabled, otherwise false.
\sa setState, state
*/
/*!
\fn void ClassView::Internal::Manager::treeDataUpdate(QSharedPointer<QStandardItem> result)
@@ -88,49 +79,6 @@ static Manager *managerInstance = nullptr;
item with the current tree.
*/
/*!
\fn void ClassView::Internal::Manager::requestTreeDataUpdate()
Emits a signal that a request for sending the tree view has to be handled by
listeners (the parser).
\sa onRequestTreeDataUpdate
*/
/*!
\fn void ClassView::Internal::Manager::requestDocumentUpdated(CPlusPlus::Document::Ptr doc)
Emits a signal that \a doc was updated and has to be reparsed.
\sa onDocumentUpdated
*/
/*!
\fn void ClassView::Internal::Manager::requestResetCurrentState()
Emits a signal that the parser has to reset its internal state to the
current state from the code manager.
*/
/*!
\fn void ClassView::Internal::Manager::requestClearCache()
Requests the parser to clear a cache.
*/
/*!
\fn void ClassView::Internal::Manager::requestClearCacheAll()
Requests the parser to clear a full cache.
*/
/*!
\fn void ClassView::Internal::Manager::requestSetFlatMode(bool flat)
Requests the manager to set the flat mode without subprojects. Set \a flat
to \c true to enable flat mode and to false to disable it.
*/
/*!
\class ManagerPrivate
\internal
@@ -142,9 +90,6 @@ static Manager *managerInstance = nullptr;
class ManagerPrivate
{
public:
//! State mutex
QMutex mutexState;
//! code state/changes parser
Parser parser;
@@ -174,9 +119,6 @@ Manager::Manager(QObject *parent)
// start a separate thread for the parser
d->parser.moveToThread(&d->parserThread);
d->parserThread.start();
// initial setup
onProjectListChanged();
}
Manager::~Manager()
@@ -220,58 +162,62 @@ void Manager::initialize()
{
using ProjectExplorer::SessionManager;
// use Qt::QueuedConnection everywhere
// internal manager state is changed
connect(this, &Manager::stateChanged, this, &Manager::onStateChanged, Qt::QueuedConnection);
// connections to enable/disable navi widget factory
SessionManager *sessionManager = SessionManager::instance();
connect(sessionManager, &SessionManager::projectAdded,
this, &Manager::onProjectListChanged, Qt::QueuedConnection);
this, &Manager::onProjectListChanged);
connect(sessionManager, &SessionManager::projectRemoved,
this, &Manager::onProjectListChanged, Qt::QueuedConnection);
this, &Manager::onProjectListChanged);
// connect to the progress manager for signals about Parsing tasks
connect(ProgressManager::instance(), &ProgressManager::taskStarted,
this, &Manager::onTaskStarted, Qt::QueuedConnection);
connect(ProgressManager::instance(), &ProgressManager::allTasksFinished,
this, &Manager::onAllTasksFinished, Qt::QueuedConnection);
this, [this](Id type) {
if (type != CppTools::Constants::TASK_INDEX)
return;
// when we signals that really document is updated - sent it to the parser
connect(this, &Manager::requestDocumentUpdated,
&d->parser, &Parser::parseDocument, Qt::QueuedConnection);
// disable tree updates to speed up
d->disableCodeParser = true;
});
connect(ProgressManager::instance(), &ProgressManager::allTasksFinished,
this, [this](Id type) {
if (type != CppTools::Constants::TASK_INDEX)
return;
// parsing is finished, enable tree updates
d->disableCodeParser = false;
// do nothing if Manager is disabled
if (!state())
return;
// any document might be changed, clear parser's cache
QMetaObject::invokeMethod(&d->parser, &Parser::clearCache, Qt::QueuedConnection);
// request to update a tree to the current state
resetParser();
});
// translate data update from the parser to listeners
connect(&d->parser, &Parser::treeDataUpdate,
this, &Manager::onTreeDataUpdate, Qt::QueuedConnection);
// requet current state - immediately after a notification
connect(this, &Manager::requestTreeDataUpdate,
&d->parser, &Parser::requestCurrentState, Qt::QueuedConnection);
// full reset request to parser
connect(this, &Manager::requestResetCurrentState,
&d->parser, &Parser::resetDataToCurrentState, Qt::QueuedConnection);
// clear cache request
connect(this, &Manager::requestClearCache,
&d->parser, &Parser::clearCache, Qt::QueuedConnection);
// clear full cache request
connect(this, &Manager::requestClearCacheAll,
&d->parser, &Parser::clearCacheAll, Qt::QueuedConnection);
// flat mode request
connect(this, &Manager::requestSetFlatMode,
&d->parser, &Parser::setFlatMode, Qt::QueuedConnection);
// connect to the cpp model manager for signals about document updates
CppTools::CppModelManager *codeModelManager = CppTools::CppModelManager::instance();
// when code manager signals that document is updated - handle it by ourselves
connect(codeModelManager, &CppTools::CppModelManager::documentUpdated,
this, &Manager::onDocumentUpdated, Qt::QueuedConnection);
this, [this](CPlusPlus::Document::Ptr doc) {
// do nothing if Manager is disabled
if (!state())
return;
// do nothing if updates are disabled
if (d->disableCodeParser)
return;
QMetaObject::invokeMethod(&d->parser, [this, doc]() {
d->parser.parseDocument(doc); }, Qt::QueuedConnection);
}, Qt::QueuedConnection);
//
connect(codeModelManager, &CppTools::CppModelManager::aboutToRemoveFiles,
&d->parser, &Parser::removeFiles, Qt::QueuedConnection);
@@ -300,15 +246,18 @@ bool Manager::state() const
void Manager::setState(bool state)
{
QMutexLocker locker(&d->mutexState);
// boolean comparsion - should be done correctly by any compiler
if (state == d->state)
return;
d->state = state;
emit stateChanged(d->state);
if (state) // enabled - request a current snapshots etc?..
resetParser();
}
void Manager::resetParser()
{
QMetaObject::invokeMethod(&d->parser, &Parser::resetDataToCurrentState, Qt::QueuedConnection);
}
/*!
@@ -321,26 +270,10 @@ void Manager::setState(bool state)
void Manager::onWidgetVisibilityIsChanged(bool visibility)
{
// activate data handling - when 1st time 'Class View' will be open
if (visibility)
setState(true);
}
/*!
Reacts to the state changed signal for the current manager \a state.
For example, requests the currect code snapshot if needed.
\sa setState, state, stateChanged
*/
void Manager::onStateChanged(bool state)
{
if (state) {
// enabled - request a current snapshots etc?..
emit requestResetCurrentState();
} else {
// disabled - clean parsers internal cache
emit requestClearCacheAll();
}
if (!visibility)
return;
setState(true);
onProjectListChanged();
}
/*!
@@ -354,70 +287,7 @@ void Manager::onProjectListChanged()
if (!state())
return;
// update to the latest state
emit requestTreeDataUpdate();
}
/*!
Handles parse tasks started by the progress manager. \a type holds the
task index, which should be \c CppTools::Constants::TASK_INDEX.
\sa CppTools::Constants::TASK_INDEX
*/
void Manager::onTaskStarted(Id type)
{
if (type != CppTools::Constants::TASK_INDEX)
return;
// disable tree updates to speed up
d->disableCodeParser = true;
}
/*!
Handles parse tasks finished by the progress manager.\a type holds the
task index, which should be \c CppTools::Constants::TASK_INDEX.
\sa CppTools::Constants::TASK_INDEX
*/
void Manager::onAllTasksFinished(Id type)
{
if (type != CppTools::Constants::TASK_INDEX)
return;
// parsing is finished, enable tree updates
d->disableCodeParser = false;
// do nothing if Manager is disabled
if (!state())
return;
// any document might be changed, emit signal to clear cache
emit requestClearCache();
// request to update a tree to the current state
emit requestResetCurrentState();
}
/*!
Emits the signal \c documentUpdated when the code model manager state is
changed for \a doc.
\sa documentUpdated
*/
void Manager::onDocumentUpdated(CPlusPlus::Document::Ptr doc)
{
// do nothing if Manager is disabled
if (!state())
return;
// do nothing if updates are disabled
if (d->disableCodeParser)
return;
emit requestDocumentUpdated(doc);
QMetaObject::invokeMethod(&d->parser, &Parser::requestCurrentState, Qt::QueuedConnection);
}
/*!
@@ -471,29 +341,15 @@ void Manager::gotoLocations(const QList<QVariant> &list)
gotoLocation(loc.fileName(), loc.line(), loc.column() - 1);
}
/*!
Emits the signal \c requestTreeDataUpdate if the latest tree info is
requested and if parsing is enabled.
\sa requestTreeDataUpdate, NavigationWidget::requestDataUpdate
*/
void Manager::onRequestTreeDataUpdate()
{
// do nothing if Manager is disabled
if (!state())
return;
emit requestTreeDataUpdate();
}
/*!
Switches to flat mode (without subprojects) if \a flat is set to \c true.
*/
void Manager::setFlatMode(bool flat)
{
emit requestSetFlatMode(flat);
QMetaObject::invokeMethod(&d->parser, [this, flat]() {
d->parser.setFlatMode(flat);
}, Qt::QueuedConnection);
}
/*!

48
src/plugins/classview/classviewmanager.h
View File

@@ -41,67 +41,33 @@ class ManagerPrivate;
class Manager : public QObject
{
Q_OBJECT
public:
explicit Manager(QObject *parent = nullptr);
~Manager() override;
//! Get an instance of Manager
static Manager *instance();
bool canFetchMore(QStandardItem *item, bool skipRoot = false) const;
void fetchMore(QStandardItem *item, bool skipRoot = false);
bool hasChildren(QStandardItem *item) const;
signals:
void stateChanged(bool state);
void treeDataUpdate(QSharedPointer<QStandardItem> result);
void requestTreeDataUpdate();
void requestDocumentUpdated(CPlusPlus::Document::Ptr doc);
void requestResetCurrentState();
void requestClearCache();
void requestClearCacheAll();
void requestSetFlatMode(bool flat);
public:
void gotoLocation(const QString &fileName, int line = 0, int column = 0);
void gotoLocations(const QList<QVariant> &locations);
void onRequestTreeDataUpdate();
void setFlatMode(bool flat);
void onWidgetVisibilityIsChanged(bool visibility);
protected:
void onStateChanged(bool state);
void onProjectListChanged();
void onDocumentUpdated(CPlusPlus::Document::Ptr doc);
void onTaskStarted(Utils::Id type);
void onAllTasksFinished(Utils::Id type);
void onTreeDataUpdate(QSharedPointer<QStandardItem> result);
signals:
void treeDataUpdate(QSharedPointer<QStandardItem> result);
private:
void onProjectListChanged();
void onTreeDataUpdate(QSharedPointer<QStandardItem> result);
void resetParser();
protected:
//! Perform an initialization
void initialize();
inline bool state() const;
void setState(bool state);
private:
//! private class data pointer
ManagerPrivate *d;
};

28
src/plugins/classview/classviewnavigationwidget.cpp
View File

@@ -63,17 +63,6 @@ namespace Internal {
true if plugin becames visible, otherwise it returns false.
*/
/*!
\fn void NavigationWidget::requestGotoLocation(const QString &name,
int line,
int column)
Emits a signal that requests to open the file with \a name at \a line
and \a column.
\sa Manager::gotoLocation
*/
/*!
\fn void NavigationWidget::requestGotoLocations(const QList<QVariant> &locations)
@@ -83,14 +72,6 @@ namespace Internal {
\sa Manager::gotoLocations
*/
/*!
\fn void NavigationWidget::requestTreeDataUpdate()
Emits a signal that the widget wants to receive the latest tree info.
\sa Manager::onRequestTreeDataUpdate
*/
NavigationWidget::NavigationWidget(QWidget *parent) :
QWidget(parent)
{
@@ -124,17 +105,11 @@ NavigationWidget::NavigationWidget(QWidget *parent) :
connect(this, &NavigationWidget::visibilityChanged,
manager, &Manager::onWidgetVisibilityIsChanged);
connect(this, &NavigationWidget::requestGotoLocation,
manager, &Manager::gotoLocation);
connect(this, &NavigationWidget::requestGotoLocations,
manager, &Manager::gotoLocations);
connect(manager, &Manager::treeDataUpdate,
this, &NavigationWidget::onDataUpdate);
connect(this, &NavigationWidget::requestTreeDataUpdate,
manager, &Manager::onRequestTreeDataUpdate);
}
NavigationWidget::~NavigationWidget() = default;
@@ -149,9 +124,6 @@ void NavigationWidget::showEvent(QShowEvent *event)
{
emit visibilityChanged(true);
// request to update to the current state - to be sure
emit requestTreeDataUpdate();
QWidget::showEvent(event);
}

4
src/plugins/classview/classviewnavigationwidget.h
View File

@@ -58,12 +58,8 @@ public:
signals:
void visibilityChanged(bool visibility);
void requestGotoLocation(const QString &name, int line, int column);
void requestGotoLocations(const QList<QVariant> &locations);
void requestTreeDataUpdate();
public:
void onItemActivated(const QModelIndex &index);
void onItemDoubleClicked(const QModelIndex &index);

59
src/plugins/classview/classviewparser.cpp
View File

@@ -83,14 +83,6 @@ namespace Internal {
Emits a signal about a tree data update.
*/
/*!
\fn void Parser::resetDataDone()
Emits a signal that internal data is reset.
\sa resetData, resetDataToCurrentState
*/
class ParserPrivate
{
public:
@@ -167,12 +159,8 @@ Parser::Parser(QObject *parent)
{
d->timer.setSingleShot(true);
// connect signal/slots
// internal data reset
connect(this, &Parser::resetDataDone, this, &Parser::onResetDataDone, Qt::QueuedConnection);
// timer for emitting changes
connect(&d->timer, &QTimer::timeout, this, &Parser::requestCurrentState, Qt::QueuedConnection);
connect(&d->timer, &QTimer::timeout, this, &Parser::requestCurrentState);
}
/*!
@@ -230,7 +218,7 @@ void Parser::setFlatMode(bool flatMode)
d->flatMode = flatMode;
// regenerate and resend current tree
emitCurrentTree();
requestCurrentState();
}
/*!
@@ -548,23 +536,6 @@ void Parser::parseDocument(const CPlusPlus::Document::Ptr &doc)
return;
}
/*!
Requests to clear full internal stored data.
*/
void Parser::clearCacheAll()
{
d->docLocker.lockForWrite();
d->cachedDocTrees.clear();
d->cachedDocTreesRevision.clear();
d->documentList.clear();
d->docLocker.unlock();
clearCache();
}
/*!
Requests to clear internal stored data. The data has to be regenerated on
the next request.
@@ -612,8 +583,6 @@ void Parser::removeFiles(const QStringList &fileList)
d->cachedPrjTrees.remove(name);
d->cachedPrjFileLists.clear();
}
emit filesAreRemoved();
}
/*!
@@ -643,7 +612,7 @@ void Parser::resetData(const CPlusPlus::Snapshot &snapshot)
fileList += prj->files(Project::SourceFiles);
setFileList(Utils::transform(fileList, &FilePath::toString));
emit resetDataDone();
requestCurrentState();
}
/*!
@@ -658,34 +627,12 @@ void Parser::resetDataToCurrentState()
resetData(CppTools::CppModelManager::instance()->snapshot());
}
/*!
Regenerates the tree when internal data changes.
\sa resetDataDone
*/
void Parser::onResetDataDone()
{
// internal data is reset, update a tree and send it back
emitCurrentTree();
}
/*!
Requests to emit a signal with the current tree state.
*/
void Parser::requestCurrentState()
{
emitCurrentTree();
}
/*!
Sends the current tree to listeners.
*/
void Parser::emitCurrentTree()
{
// stop timer if it is active right now
d->timer.stop();
d->rootItemLocker.lockForWrite();

39
src/plugins/classview/classviewparser.h
View File

@@ -53,69 +53,44 @@ public:
explicit Parser(QObject *parent = nullptr);
~Parser() override;
// TODO: below three methods are called directly from different thread
bool canFetchMore(QStandardItem *item, bool skipRoot = false) const;
void fetchMore(QStandardItem *item, bool skipRoot = false) const;
bool hasChildren(QStandardItem *item) const;
signals:
//! File list is changed
void filesAreRemoved();
void treeDataUpdate(QSharedPointer<QStandardItem> result);
void resetDataDone();
public:
void clearCacheAll();
void clearCache();
void requestCurrentState();
void setFileList(const QStringList &fileList);
void removeFiles(const QStringList &fileList);
void resetData(const CPlusPlus::Snapshot &snapshot);
void resetDataToCurrentState();
void parseDocument(const CPlusPlus::Document::Ptr &doc);
void setFlatMode(bool flat);
protected:
signals:
void treeDataUpdate(QSharedPointer<QStandardItem> result);
private:
using CitCachedDocTreeRevision = QHash<QString, unsigned>::const_iterator;
using CitCachedPrjFileLists = QHash<QString, QStringList>::const_iterator;
void onResetDataDone();
void setFileList(const QStringList &fileList);
void resetData(const CPlusPlus::Snapshot &snapshot);
void addProject(const ParserTreeItem::Ptr &item, const QStringList &fileList,
const QString &projectId = QString());
void addSymbol(const ParserTreeItem::Ptr &item, const CPlusPlus::Symbol *symbol);
ParserTreeItem::ConstPtr getParseDocumentTree(const CPlusPlus::Document::Ptr &doc);
ParserTreeItem::ConstPtr getCachedOrParseDocumentTree(const CPlusPlus::Document::Ptr &doc);
ParserTreeItem::Ptr getParseProjectTree(const QStringList &fileList, const QString &projectId);
ParserTreeItem::Ptr getCachedOrParseProjectTree(const QStringList &fileList,
const QString &projectId);
void emitCurrentTree();
ParserTreeItem::ConstPtr parse();
ParserTreeItem::ConstPtr findItemByRoot(const QStandardItem *item, bool skipRoot = false) const;
QStringList addProjectTree(const ParserTreeItem::Ptr &item, const ProjectExplorer::Project *project);
QStringList getAllFiles(const ProjectExplorer::Project *project);
void addFlatTree(const ParserTreeItem::Ptr &item, const ProjectExplorer::Project *project);
private:
//! Private class data pointer
ParserPrivate *d;
};