CppTools: Introduce LocatorData

Until now the locator filters CppLocatorFilter, CppClassesFilter and
CppFunctionsFilter used unnecessarily their own SearchSymbols instance.
The results were also saved separately, which was unfavorable since e.g.
the functions and classes data could be shared.

Starting with this patch an instance of LocatorData will serve all
mentioned filters.

This saves about 20MB of memory after indexing the Qt Creator project.

Change-Id: I8a34b67eb9fe0e5c68ba6e7c8f576389c78efc6f
Reviewed-by: Thomas Hartmann <Thomas.Hartmann@digia.com>
Reviewed-by: Erik Verbruggen <erik.verbruggen@digia.com>

1 files changed, 162 insertions, 0 deletions

diff --git a/src/plugins/cpptools/cpplocatordata.cpp b/src/plugins/cpptools/cpplocatordata.cpp
new file mode 100644
index 00000000000..14fcd9df2c6
--- /dev/null
+++ b/src/plugins/cpptools/cpplocatordata.cpp
@@ -0,0 +1,162 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of Qt Creator.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+
+#include "cpplocatordata.h"
+
+using namespace CppTools;
+using namespace CppTools::Internal;
+
+static const int MaxPendingDocuments = 10;
+
+CppLocatorData::CppLocatorData(CppModelManager *modelManager)
+    : m_modelManager(modelManager)
+    , m_pendingDocumentsMutex(QMutex::Recursive)
+{
+    m_search.setSymbolsToSearchFor(SymbolSearcher::Enums
+                                 | SymbolSearcher::Classes
+                                 | SymbolSearcher::Functions);
+    m_pendingDocuments.reserve(MaxPendingDocuments);
+
+    connect(m_modelManager, SIGNAL(documentUpdated(CPlusPlus::Document::Ptr)),
+            this, SLOT(onDocumentUpdated(CPlusPlus::Document::Ptr)));
+
+    connect(m_modelManager, SIGNAL(aboutToRemoveFiles(QStringList)),
+            this, SLOT(onAboutToRemoveFiles(QStringList)));
+}
+
+QList<ModelItemInfo> CppLocatorData::enums()
+{
+    flushPendingDocument(true);
+    return allModelItemInfos(m_allEnums);
+}
+
+QList<ModelItemInfo> CppLocatorData::classes()
+{
+    flushPendingDocument(true);
+    return allModelItemInfos(m_allClasses);
+}
+
+QList<ModelItemInfo> CppLocatorData::functions()
+{
+    flushPendingDocument(true);
+    return allModelItemInfos(m_allFunctions);
+}
+
+void CppLocatorData::onDocumentUpdated(const CPlusPlus::Document::Ptr &document)
+{
+    QMutexLocker locker(&m_pendingDocumentsMutex);
+
+    int i = 0, ei = m_pendingDocuments.size();
+    for (; i < ei; ++i) {
+        const CPlusPlus::Document::Ptr &doc = m_pendingDocuments.at(i);
+        if (doc->fileName() == document->fileName()
+                && doc->revision() < document->revision()) {
+            m_pendingDocuments[i] = document;
+            break;
+        }
+    }
+
+    if (i == ei)
+        m_pendingDocuments.append(document);
+
+    flushPendingDocument(false);
+}
+
+void CppLocatorData::onAboutToRemoveFiles(const QStringList &files)
+{
+    QMutexLocker locker(&m_pendingDocumentsMutex);
+
+    for (int i = 0; i < m_pendingDocuments.size(); ) {
+        if (files.contains(m_pendingDocuments.at(i)->fileName()))
+            m_pendingDocuments.remove(i);
+        else
+            ++i;
+    }
+
+    foreach (const QString &file, files) {
+        m_allEnums.remove(file);
+        m_allClasses.remove(file);
+        m_allFunctions.remove(file);
+        removeFilePath(file);
+    }
+}
+
+void CppLocatorData::flushPendingDocument(bool force)
+{
+    QMutexLocker locker(&m_pendingDocumentsMutex);
+    if (!force && m_pendingDocuments.size() < MaxPendingDocuments)
+        return;
+
+    foreach (CPlusPlus::Document::Ptr doc, m_pendingDocuments) {
+        const QString fileName = findOrInsertFilePath(doc->fileName());
+
+        QList<ModelItemInfo> resultsEnums;
+        QList<ModelItemInfo> resultsClasses;
+        QList<ModelItemInfo> resultsFunctions;
+
+        const int sizeHint = m_allEnums[fileName].size() + m_allClasses[fileName].size()
+                + m_allFunctions[fileName].size() + 10;
+        const QList<ModelItemInfo> results = m_search(doc, sizeHint);
+        foreach (const ModelItemInfo &info, results) {
+            switch (info.type) {
+            case ModelItemInfo::Enum:
+                resultsEnums.append(info);
+                break;
+            case ModelItemInfo::Class:
+                resultsClasses.append(info);
+                break;
+            case ModelItemInfo::Method:
+                resultsFunctions.append(info);
+                break;
+            default:
+                break;
+            }
+        }
+
+        m_allEnums[fileName] = resultsEnums;
+        m_allClasses[fileName] = resultsClasses;
+        m_allFunctions[fileName] = resultsFunctions;
+    }
+
+    m_pendingDocuments.clear();
+    m_pendingDocuments.reserve(MaxPendingDocuments);
+}
+
+QList<ModelItemInfo> CppLocatorData::allModelItemInfos(const QHash<QString,
+                                                       QList<ModelItemInfo> > &items) const
+{
+    QList<ModelItemInfo> result;
+    QHashIterator<QString, QList<ModelItemInfo> > it(items);
+    while (it.hasNext()) {
+        it.next();
+        result.append(it.value());
+    }
+    return result;
+}