C++: Rename ModelItemInfo to IndexInfo.

And move it into its own header and source files.

Change-Id: I37401badd819e028e1d767425759dc0ff27afe31
Reviewed-by: Nikolai Kosjar <nikolai.kosjar@digia.com>

src/plugins/clangcodemodel/clangsymbolsearcher.cpp

@@ -88,12 +88,12 @@ void ClangSymbolSearcher::search(const QLinkedList<Symbol> &allSymbols)
         }
         ++symbolNr;
 
-        CppTools::ModelItemInfo info;
+        CppTools::IndexItem info;
 
         switch (s.m_kind) {
         case Symbol::Enum:
             if (m_parameters.types & SymbolSearcher::Enums) {
-                info.type = CppTools::ModelItemInfo::Enum;
+                info.type = CppTools::IndexItem::Enum;
                 info.symbolType = QLatin1String("enum");
                 break;
             } else {
@@ -101,7 +101,7 @@ void ClangSymbolSearcher::search(const QLinkedList<Symbol> &allSymbols)
             }
         case Symbol::Class:
             if (m_parameters.types & SymbolSearcher::Classes) {
-                info.type = CppTools::ModelItemInfo::Class;
+                info.type = CppTools::IndexItem::Class;
                 info.symbolType = QLatin1String("class");
                 break;
             } else {
@@ -112,14 +112,14 @@ void ClangSymbolSearcher::search(const QLinkedList<Symbol> &allSymbols)
         case Symbol::Constructor:
         case Symbol::Destructor:
             if (m_parameters.types & SymbolSearcher::Functions) {
-                info.type = CppTools::ModelItemInfo::Function;
+                info.type = CppTools::IndexItem::Function;
                 break;
             } else {
                 continue;
             }
         case Symbol::Declaration:
             if (m_parameters.types & SymbolSearcher::Declarations) {
-                info.type = CppTools::ModelItemInfo::Declaration;
+                info.type = CppTools::IndexItem::Declaration;
                 break;
             } else {
                 continue;

src/plugins/cppeditor/cppquickfixes.cpp

@@ -1920,7 +1920,7 @@ void AddIncludeForUndefinedIdentifier::match(const CppQuickFixInterface &interfa
     QList<Core::LocatorFilterEntry> matches = classesFilter->matchesFor(dummyInterface, className);
     bool classExists = false;
     foreach (const Core::LocatorFilterEntry &entry, matches) {
-        ModelItemInfo::Ptr info = entry.internalData.value<ModelItemInfo::Ptr>();
+        IndexItem::Ptr info = entry.internalData.value<IndexItem::Ptr>();
         if (info->symbolName() != className)
             continue;
         classExists = true;

src/plugins/cpptools/builtinindexingsupport.cpp

@@ -125,16 +125,16 @@ public:
                 break;
             if (m_fileNames.isEmpty() || m_fileNames.contains(it.value()->fileName())) {
                 QVector<Core::SearchResultItem> resultItems;
-                search(it.value())->visitAllChildren([&](const ModelItemInfo::Ptr &info) {
+                search(it.value())->visitAllChildren([&](const IndexItem::Ptr &info) {
                     if (matcher.indexIn(info->symbolName()) != -1) {
                         QString text = info->symbolName();
                         QString scope = info->symbolScope();
-                        if (info->type() == ModelItemInfo::Function) {
+                        if (info->type() == IndexItem::Function) {
                             QString name;
                             info->unqualifiedNameAndScope(info->symbolName(), &name, &scope);
                             text = name + info->symbolType();
-                        } else if (info->type() == ModelItemInfo::Declaration){
-                            text = ModelItemInfo::representDeclaration(info->symbolName(),
+                        } else if (info->type() == IndexItem::Declaration){
+                            text = IndexItem::representDeclaration(info->symbolName(),
                                                                        info->symbolType());
                         }
 

src/plugins/cpptools/cppclassesfilter.cpp

@@ -45,12 +45,12 @@ CppClassesFilter::~CppClassesFilter()
 {
 }
 
-QList<QList<ModelItemInfo::Ptr> > CppClassesFilter::itemsToMatchUserInputAgainst() const
+QList<QList<IndexItem::Ptr> > CppClassesFilter::itemsToMatchUserInputAgainst() const
 {
-    return QList<QList<CppTools::ModelItemInfo::Ptr> >() << m_data->classes();
+    return QList<QList<CppTools::IndexItem::Ptr> >() << m_data->classes();
 }
 
-Core::LocatorFilterEntry CppClassesFilter::filterEntryFromModelItemInfo(ModelItemInfo::Ptr info)
+Core::LocatorFilterEntry CppClassesFilter::filterEntryFromIndexItem(IndexItem::Ptr info)
 {
     const QVariant id = qVariantFromValue(info);
     Core::LocatorFilterEntry filterEntry(this, info->symbolName(), id, info->icon());

src/plugins/cpptools/cppclassesfilter.h

@@ -45,8 +45,8 @@ public:
     ~CppClassesFilter();
 
 private:
-    QList<QList<CppTools::ModelItemInfo::Ptr> > itemsToMatchUserInputAgainst() const;
-    Core::LocatorFilterEntry filterEntryFromModelItemInfo(ModelItemInfo::Ptr info);
+    QList<QList<CppTools::IndexItem::Ptr> > itemsToMatchUserInputAgainst() const;
+    Core::LocatorFilterEntry filterEntryFromIndexItem(IndexItem::Ptr info);
 };
 
 } // namespace CppTools

src/plugins/cpptools/cppcurrentdocumentfilter.cpp

@@ -79,22 +79,22 @@ QList<Core::LocatorFilterEntry> CppCurrentDocumentFilter::matchesFor(
         Snapshot snapshot = m_modelManager->snapshot();
         Document::Ptr thisDocument = snapshot.document(m_currentFileName);
         if (thisDocument)
-            search(thisDocument)->visitAllChildren([&](const ModelItemInfo::Ptr &info){
+            search(thisDocument)->visitAllChildren([&](const IndexItem::Ptr &info){
                 m_itemsOfCurrentDoc.append(info);
             });
     }
 
     const Qt::CaseSensitivity caseSensitivityForPrefix = caseSensitivity(entry);
 
-    foreach (ModelItemInfo::Ptr info, m_itemsOfCurrentDoc) {
+    foreach (IndexItem::Ptr info, m_itemsOfCurrentDoc) {
         if (future.isCanceled())
             break;
 
         QString matchString = info->symbolName();
-        if (info->type() == ModelItemInfo::Declaration)
-            matchString = ModelItemInfo::representDeclaration(info->symbolName(),
+        if (info->type() == IndexItem::Declaration)
+            matchString = IndexItem::representDeclaration(info->symbolName(),
                                                           info->symbolType());
-        else if (info->type() == ModelItemInfo::Function)
+        else if (info->type() == IndexItem::Function)
             matchString += info->symbolType();
 
         if ((hasWildcard && regexp.exactMatch(matchString))
@@ -103,7 +103,7 @@ QList<Core::LocatorFilterEntry> CppCurrentDocumentFilter::matchesFor(
             QVariant id = qVariantFromValue(info);
             QString name = matchString;
             QString extraInfo = info->symbolScope();
-            if (info->type() == ModelItemInfo::Function) {
+            if (info->type() == IndexItem::Function) {
                 if (info->unqualifiedNameAndScope(matchString, &name, &extraInfo))
                     name += info->symbolType();
             }
@@ -125,7 +125,7 @@ QList<Core::LocatorFilterEntry> CppCurrentDocumentFilter::matchesFor(
 
 void CppCurrentDocumentFilter::accept(Core::LocatorFilterEntry selection) const
 {
-    ModelItemInfo::Ptr info = qvariant_cast<CppTools::ModelItemInfo::Ptr>(selection.internalData);
+    IndexItem::Ptr info = qvariant_cast<CppTools::IndexItem::Ptr>(selection.internalData);
     Core::EditorManager::openEditorAt(info->fileName(), info->line(), info->column());
 }
 

src/plugins/cpptools/cppcurrentdocumentfilter.h

@@ -61,7 +61,7 @@ private slots:
 private:
     CppModelManager * m_modelManager;
     QString m_currentFileName;
-    QList<ModelItemInfo::Ptr> m_itemsOfCurrentDoc;
+    QList<IndexItem::Ptr> m_itemsOfCurrentDoc;
     SearchSymbols search;
 };
 

src/plugins/cpptools/cppfunctionsfilter.cpp

@@ -45,12 +45,12 @@ CppFunctionsFilter::~CppFunctionsFilter()
 {
 }
 
-QList<QList<CppTools::ModelItemInfo::Ptr> > CppFunctionsFilter::itemsToMatchUserInputAgainst() const
+QList<QList<CppTools::IndexItem::Ptr> > CppFunctionsFilter::itemsToMatchUserInputAgainst() const
 {
-    return QList<QList<CppTools::ModelItemInfo::Ptr> >() << m_data->functions();
+    return QList<QList<CppTools::IndexItem::Ptr> >() << m_data->functions();
 }
 
-Core::LocatorFilterEntry CppFunctionsFilter::filterEntryFromModelItemInfo(ModelItemInfo::Ptr info)
+Core::LocatorFilterEntry CppFunctionsFilter::filterEntryFromIndexItem(IndexItem::Ptr info)
 {
     const QVariant id = qVariantFromValue(info);
 

src/plugins/cpptools/cppfunctionsfilter.h

@@ -45,8 +45,8 @@ public:
     ~CppFunctionsFilter();
 
 private:
-    QList<QList<ModelItemInfo::Ptr> > itemsToMatchUserInputAgainst() const;
-    Core::LocatorFilterEntry filterEntryFromModelItemInfo(ModelItemInfo::Ptr info);
+    QList<QList<IndexItem::Ptr> > itemsToMatchUserInputAgainst() const;
+    Core::LocatorFilterEntry filterEntryFromIndexItem(IndexItem::Ptr info);
 };
 
 } // namespace Internal

src/plugins/cpptools/cpplocatordata.cpp

@@ -53,22 +53,22 @@ CppLocatorData::CppLocatorData(CppModelManager *modelManager)
             this, SLOT(onAboutToRemoveFiles(QStringList)));
 }
 
-QList<ModelItemInfo::Ptr> CppLocatorData::enums()
+QList<IndexItem::Ptr> CppLocatorData::enums()
 {
     flushPendingDocument(true);
-    return allModelItemInfos(m_allEnums);
+    return allIndexItems(m_allEnums);
 }
 
-QList<ModelItemInfo::Ptr> CppLocatorData::classes()
+QList<IndexItem::Ptr> CppLocatorData::classes()
 {
     flushPendingDocument(true);
-    return allModelItemInfos(m_allClasses);
+    return allIndexItems(m_allClasses);
 }
 
-QList<ModelItemInfo::Ptr> CppLocatorData::functions()
+QList<IndexItem::Ptr> CppLocatorData::functions()
 {
     flushPendingDocument(true);
-    return allModelItemInfos(m_allFunctions);
+    return allIndexItems(m_allFunctions);
 }
 
 void CppLocatorData::onDocumentUpdated(const CPlusPlus::Document::Ptr &document)
@@ -120,21 +120,19 @@ void CppLocatorData::flushPendingDocument(bool force)
     foreach (CPlusPlus::Document::Ptr doc, m_pendingDocuments) {
         const QString fileName = findOrInsertFilePath(doc->fileName());
 
-        QList<ModelItemInfo::Ptr> resultsEnums;
-        QList<ModelItemInfo::Ptr> resultsClasses;
-        QList<ModelItemInfo::Ptr> resultsFunctions;
+        QList<IndexItem::Ptr> resultsEnums;
+        QList<IndexItem::Ptr> resultsClasses;
+        QList<IndexItem::Ptr> resultsFunctions;
 
-        const int sizeHint = m_allEnums[fileName].size() + m_allClasses[fileName].size()
-                + m_allFunctions[fileName].size() + 10;
-        m_search(doc, sizeHint)->visitAllChildren([&](const ModelItemInfo::Ptr &info) {
+        m_search(doc)->visitAllChildren([&](const IndexItem::Ptr &info) {
             switch (info->type()) {
-            case ModelItemInfo::Enum:
+            case IndexItem::Enum:
                 resultsEnums.append(info);
                 break;
-            case ModelItemInfo::Class:
+            case IndexItem::Class:
                 resultsClasses.append(info);
                 break;
-            case ModelItemInfo::Function:
+            case IndexItem::Function:
                 resultsFunctions.append(info);
                 break;
             default:
@@ -151,11 +149,11 @@ void CppLocatorData::flushPendingDocument(bool force)
     m_pendingDocuments.reserve(MaxPendingDocuments);
 }
 
-QList<ModelItemInfo::Ptr> CppLocatorData::allModelItemInfos(const QHash<QString,
-                                                            QList<ModelItemInfo::Ptr>> &items) const
+QList<IndexItem::Ptr> CppLocatorData::allIndexItems(
+        const QHash<QString, QList<IndexItem::Ptr>> &items) const
 {
-    QList<ModelItemInfo::Ptr> result;
-    QHashIterator<QString, QList<ModelItemInfo::Ptr> > it(items);
+    QList<IndexItem::Ptr> result;
+    QHashIterator<QString, QList<IndexItem::Ptr> > it(items);
     while (it.hasNext()) {
         it.next();
         result.append(it.value());

src/plugins/cpptools/cpplocatordata.h

@@ -49,9 +49,9 @@ class CppLocatorData : public QObject
 public:
     explicit CppLocatorData(CppModelManager *modelManager);
 
-    QList<ModelItemInfo::Ptr> enums();
-    QList<ModelItemInfo::Ptr> classes();
-    QList<ModelItemInfo::Ptr> functions();
+    QList<IndexItem::Ptr> enums();
+    QList<IndexItem::Ptr> classes();
+    QList<IndexItem::Ptr> functions();
 
 private slots:
     void onDocumentUpdated(const CPlusPlus::Document::Ptr &document);
@@ -59,8 +59,7 @@ private slots:
 
 private:
     void flushPendingDocument(bool force);
-    QList<ModelItemInfo::Ptr> allModelItemInfos(
-            const QHash<QString, QList<ModelItemInfo::Ptr>> &items) const;
+    QList<IndexItem::Ptr> allIndexItems(const QHash<QString, QList<IndexItem::Ptr>> &items) const;
 
     QString findOrInsertFilePath(const QString &path)
     { return m_strings.insert(path); }
@@ -71,9 +70,9 @@ private:
     StringTable &m_strings; // Used to avoid QString duplication
 
     SearchSymbols m_search;
-    QHash<QString, QList<ModelItemInfo::Ptr> > m_allEnums;
-    QHash<QString, QList<ModelItemInfo::Ptr> > m_allClasses;
-    QHash<QString, QList<ModelItemInfo::Ptr> > m_allFunctions;
+    QHash<QString, QList<IndexItem::Ptr> > m_allEnums;
+    QHash<QString, QList<IndexItem::Ptr> > m_allClasses;
+    QHash<QString, QList<IndexItem::Ptr> > m_allFunctions;
 
     mutable QMutex m_pendingDocumentsMutex;
     QVector<CPlusPlus::Document::Ptr> m_pendingDocuments;

src/plugins/cpptools/cpplocatorfilter.cpp

@@ -48,11 +48,11 @@ CppLocatorFilter::~CppLocatorFilter()
 {
 }
 
-Core::LocatorFilterEntry CppLocatorFilter::filterEntryFromModelItemInfo(ModelItemInfo::Ptr info)
+Core::LocatorFilterEntry CppLocatorFilter::filterEntryFromIndexItem(IndexItem::Ptr info)
 {
     const QVariant id = qVariantFromValue(info);
     Core::LocatorFilterEntry filterEntry(this, info->scopedSymbolName(), id, info->icon());
-    if (info->type() == ModelItemInfo::Class || info->type() == ModelItemInfo::Enum)
+    if (info->type() == IndexItem::Class || info->type() == IndexItem::Enum)
         filterEntry.extraInfo = info->shortNativeFilePath();
     else
         filterEntry.extraInfo = info->symbolType();
@@ -65,9 +65,9 @@ void CppLocatorFilter::refresh(QFutureInterface<void> &future)
     Q_UNUSED(future)
 }
 
-QList<QList<CppTools::ModelItemInfo::Ptr> > CppLocatorFilter::itemsToMatchUserInputAgainst() const
+QList<QList<CppTools::IndexItem::Ptr> > CppLocatorFilter::itemsToMatchUserInputAgainst() const
 {
-    return QList<QList<CppTools::ModelItemInfo::Ptr> >()
+    return QList<QList<CppTools::IndexItem::Ptr> >()
         << m_data->classes()
         << m_data->functions()
         << m_data->enums();
@@ -94,16 +94,16 @@ QList<Core::LocatorFilterEntry> CppLocatorFilter::matchesFor(
     bool hasColonColon = entry.contains(QLatin1String("::"));
     const Qt::CaseSensitivity caseSensitivityForPrefix = caseSensitivity(entry);
 
-    const QList<QList<CppTools::ModelItemInfo::Ptr> > itemLists = itemsToMatchUserInputAgainst();
-    foreach (const QList<CppTools::ModelItemInfo::Ptr> &items, itemLists) {
-        foreach (ModelItemInfo::Ptr info, items) {
+    const QList<QList<CppTools::IndexItem::Ptr> > itemLists = itemsToMatchUserInputAgainst();
+    foreach (const QList<CppTools::IndexItem::Ptr> &items, itemLists) {
+        foreach (IndexItem::Ptr info, items) {
             if (future.isCanceled())
                 break;
             const QString matchString = hasColonColon ? info->scopedSymbolName()
                                                       : info->symbolName();
             if ((hasWildcard && regexp.exactMatch(matchString))
                 || (!hasWildcard && matcher.indexIn(matchString) != -1)) {
-                const Core::LocatorFilterEntry filterEntry = filterEntryFromModelItemInfo(info);
+                const Core::LocatorFilterEntry filterEntry = filterEntryFromIndexItem(info);
                 if (matchString.startsWith(entry, caseSensitivityForPrefix))
                     betterEntries.append(filterEntry);
                 else
@@ -123,6 +123,6 @@ QList<Core::LocatorFilterEntry> CppLocatorFilter::matchesFor(
 
 void CppLocatorFilter::accept(Core::LocatorFilterEntry selection) const
 {
-    ModelItemInfo::Ptr info = qvariant_cast<CppTools::ModelItemInfo::Ptr>(selection.internalData);
+    IndexItem::Ptr info = qvariant_cast<CppTools::IndexItem::Ptr>(selection.internalData);
     Core::EditorManager::openEditorAt(info->fileName(), info->line(), info->column());
 }

src/plugins/cpptools/cpplocatorfilter.h

@@ -54,8 +54,8 @@ public:
     void refresh(QFutureInterface<void> &future);
 
 protected:
-    virtual QList<QList<ModelItemInfo::Ptr> > itemsToMatchUserInputAgainst() const;
-    virtual Core::LocatorFilterEntry filterEntryFromModelItemInfo(ModelItemInfo::Ptr info);
+    virtual QList<QList<IndexItem::Ptr> > itemsToMatchUserInputAgainst() const;
+    virtual Core::LocatorFilterEntry filterEntryFromIndexItem(IndexItem::Ptr info);
 
 protected:
     CppLocatorData *m_data;

src/plugins/cpptools/cpptools.pro

@@ -50,6 +50,7 @@ HEADERS += \
     doxygengenerator.h \
     functionutils.h \
     includeutils.h \
+    indexitem.h \
     insertionpointlocator.h \
     searchsymbols.h \
     stringtable.h \
@@ -103,6 +104,7 @@ SOURCES += \
     doxygengenerator.cpp \
     functionutils.cpp \
     includeutils.cpp \
+    indexitem.cpp \
     insertionpointlocator.cpp \
     searchsymbols.cpp \
     stringtable.cpp \

src/plugins/cpptools/cpptools.qbs

@@ -71,6 +71,7 @@ QtcPlugin {
         "doxygengenerator.cpp", "doxygengenerator.h",
         "functionutils.cpp", "functionutils.h",
         "includeutils.cpp", "includeutils.h",
+        "indexitem.cpp", "indexitem.h",
         "insertionpointlocator.cpp", "insertionpointlocator.h",
         "searchsymbols.cpp", "searchsymbols.h",
         "stringtable.cpp", "stringtable.h",

src/plugins/cpptools/indexitem.cpp

+/****************************************************************************
+**
+** Copyright (C) 2014 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 "indexitem.h"
+
+#include <utils/fileutils.h>
+
+using namespace CppTools;
+
+QString IndexItem::shortNativeFilePath() const
+{
+    return Utils::FileUtils::shortNativePath(Utils::FileName::fromString(m_fileName));
+}
+
+void IndexItem::squeeze()
+{
+    m_children.squeeze();
+    for (int i = 0, ei = m_children.size(); i != ei; ++i)
+        m_children[i]->squeeze();
+}
+
+void IndexItem::visitAllChildren(std::function<void (const IndexItem::Ptr &)> f) const
+{
+    foreach (const IndexItem::Ptr &child, m_children) {
+        f(child);
+        if (!child->m_children.isEmpty())
+            child->visitAllChildren(f);
+    }
+}

src/plugins/cpptools/indexitem.h

+/****************************************************************************
+**
+** Copyright (C) 2014 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.
+**
+****************************************************************************/
+
+#ifndef CPPTOOLS_INDEXITEM_H
+#define CPPTOOLS_INDEXITEM_H
+
+#include "cpptools_global.h"
+
+#include <utils/function.h>
+
+#include <QIcon>
+#include <QSharedPointer>
+#include <QMetaType>
+
+namespace CppTools {
+
+class CPPTOOLS_EXPORT IndexItem
+{
+    Q_DISABLE_COPY(IndexItem)
+
+public:
+    enum ItemType { Enum, Class, Function, Declaration };
+
+private:
+    IndexItem(const QString &symbolName,
+                  const QString &symbolType,
+                  const QString &symbolScope,
+                  ItemType type,
+                  const QString &fileName,
+                  int line,
+                  int column,
+                  const QIcon &icon)
+        : m_symbolName(symbolName),
+          m_symbolType(symbolType),
+          m_symbolScope(symbolScope),
+          m_fileName(fileName),
+          m_icon(icon),
+          m_type(type),
+          m_line(line),
+          m_column(column)
+    {}
+
+    IndexItem(const QString &fileName, int sizeHint)
+        : m_fileName(fileName)
+        , m_type(Declaration)
+        , m_line(0)
+        , m_column(0)
+    { m_children.reserve(sizeHint); }
+
+public:
+    typedef QSharedPointer<IndexItem> Ptr;
+    static Ptr create(const QString &symbolName,
+                      const QString &symbolType,
+                      const QString &symbolScope,
+                      ItemType type,
+                      const QString &fileName,
+                      int line,
+                      int column,
+                      const QIcon &icon)
+    {
+        return Ptr(new IndexItem(
+                       symbolName, symbolType, symbolScope, type, fileName, line, column, icon));
+    }
+
+    static Ptr create(const QString &fileName, int sizeHint)
+    {
+        return Ptr(new IndexItem(fileName, sizeHint));
+    }
+
+    QString scopedSymbolName() const
+    {
+        return m_symbolScope.isEmpty()
+                ? m_symbolName
+                : m_symbolScope +  QLatin1String("::") + m_symbolName;
+    }
+
+    bool unqualifiedNameAndScope(const QString &defaultName, QString *name, QString *scope) const
+    {
+        *name = defaultName;
+        *scope = m_symbolScope;
+        const QString qualifiedName = scopedSymbolName();
+        const int colonColonPosition = qualifiedName.lastIndexOf(QLatin1String("::"));
+        if (colonColonPosition != -1) {
+            *name = qualifiedName.mid(colonColonPosition + 2);
+            *scope = qualifiedName.left(colonColonPosition);
+            return true;
+        }
+        return false;
+    }
+
+    static QString representDeclaration(const QString &name, const QString &type)
+    {
+        if (type.isEmpty())
+            return QString();
+
+        const QString padding = type.endsWith(QLatin1Char('*'))
+            ? QString()
+            : QString(QLatin1Char(' '));
+        return type + padding + name;
+    }
+
+    QString shortNativeFilePath() const;
+
+    QString symbolName() const { return m_symbolName; }
+    QString symbolType() const { return m_symbolType; }
+    QString symbolScope() const { return m_symbolScope; }
+    QString fileName() const { return m_fileName; }
+    QIcon icon() const { return m_icon; }
+    ItemType type() const { return m_type; }
+    int line() const { return m_line; }
+    int column() const { return m_column; }
+
+    void addChild(IndexItem::Ptr childItem) { m_children.append(childItem); }
+    void squeeze();