CppTools: Make FollowSymbol respect projects

Finding the class definition for a forward declaration or finding the
function definition from its declaration is mostly determined by the
file iteration order. Documents with the most common path prefix are
checked first.

This works fine as long as the files of your project have a common
ancestor. If that's not the case, FollowSymbol might take you to the
definition within another project.

Fix that issue by considering the project part id when constructing the
file iteration order. Since the cached file iteration order now depends
on the projects, ensure to clear it if projects are added, changed or
removed.

Task-number: QTCREATORBUG-15116
Change-Id: I529166bac363959c9fee0b946747fd0370a88809
Reviewed-by: Marco Bubke <marco.bubke@theqtcompany.com>

1 files changed, 84 insertions, 0 deletions

diff --git a/src/plugins/cpptools/cppfileiterationorder.h b/src/plugins/cpptools/cppfileiterationorder.h
new file mode 100644
index 0000000000..aecd17d036
--- /dev/null
+++ b/src/plugins/cpptools/cppfileiterationorder.h
@@ -0,0 +1,84 @@
+/****************************************************************************
+**
+** Copyright (C) 2015 The Qt Company Ltd.
+** Contact: http://www.qt.io/licensing
+**
+** 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 The Qt Company.  For licensing terms and
+** conditions see http://www.qt.io/terms-conditions.  For further information
+** use the contact form at http://www.qt.io/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 or version 3 as published by the Free
+** Software Foundation and appearing in the file LICENSE.LGPLv21 and
+** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
+** following information to ensure the GNU Lesser General Public License
+** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, The Qt Company gives you certain additional
+** rights.  These rights are described in The Qt Company LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+****************************************************************************/
+
+#ifndef FILEITERATIONORDER_H
+#define FILEITERATIONORDER_H
+
+#include "cpptools_global.h"
+
+#include <QStringList>
+
+#include <set>
+
+namespace CppTools {
+
+class CPPTOOLS_EXPORT FileIterationOrder {
+public:
+    struct Entry {
+        Entry(const QString &filePath,
+              const QString &projectPartId = QString(),
+              int commonFilePathPrefixLength = 0,
+              int commonProjectPartPrefixLength = 0);
+
+        friend CPPTOOLS_EXPORT bool operator<(const Entry &first, const Entry &second);
+
+        const QString filePath;
+        const QString projectPartId;
+        int commonFilePathPrefixLength = 0;
+        int commonProjectPartPrefixLength = 0;
+    };
+
+    FileIterationOrder();
+    FileIterationOrder(const QString &referenceFilePath,
+                       const QString &referenceProjectPartId);
+
+    void setReference(const QString &filePath, const QString &projectPartId);
+    bool isValid() const;
+
+    void insert(const QString &filePath, const QString &projectPartId = QString());
+    void remove(const QString &filePath, const QString &projectPartId);
+    QStringList toStringList() const;
+
+private:
+    Entry createEntryFromFilePath(const QString &filePath,
+                                  const QString &projectPartId) const;
+
+private:
+    QString m_referenceFilePath;
+    QString m_referenceProjectPartId;
+    std::multiset<Entry> m_set;
+};
+
+CPPTOOLS_EXPORT bool operator<(const FileIterationOrder::Entry &first,
+                               const FileIterationOrder::Entry &second);
+
+} // namespace CppTools
+
+#endif // FILEITERATIONORDER_H