CppTools: Introduce HeaderPathFilter

We went the filtering of the header path outside of the compiler options
builder so merge the PCHs.

Task-number: QTCREATORBUG-21693
Change-Id: Ia1126813a5049e39d7c6e7d60bf449aa17012d02
Reviewed-by: Ivan Donchevskii <ivan.donchevskii@qt.io>

src/plugins/cpptools/cpptools.pro

@@ -101,7 +101,8 @@ HEADERS += \
     usages.h \
     cpptools_clangtidychecks.h \
     cppmodelmanagerinterface.h \
-    cppbuiltinmodelmanagersupport.h
+    cppbuiltinmodelmanagersupport.h \
+    headerpathfilter.h
 
 SOURCES += \
     abstracteditorsupport.cpp \
@@ -187,7 +188,8 @@ SOURCES += \
     cppprojectfilecategorizer.cpp \
     cppprojectpartchooser.cpp \
     wrappablelineedit.cpp \
-    cppbuiltinmodelmanagersupport.cpp
+    cppbuiltinmodelmanagersupport.cpp \
+    headerpathfilter.cpp
 
 FORMS += \
     clangdiagnosticconfigswidget.ui \

src/plugins/cpptools/cpptoolsunittestfiles.pri

@@ -13,6 +13,7 @@ HEADERS += \
     $$PWD/projectinfo.h \
     $$PWD/cppprojectinfogenerator.cpp \
     $$PWD/cppprojectpartchooser.h \
+    $$PWD/headerpathfilter.h
 
 SOURCES += \
     $$PWD/cppprojectfile.cpp \
@@ -23,3 +24,4 @@ SOURCES += \
     $$PWD/projectinfo.cpp \
     $$PWD/cppprojectinfogenerator.cpp \
     $$PWD/cppprojectpartchooser.cpp \
+    $$PWD/headerpathfilter.cpp

src/plugins/cpptools/headerpathfilter.cpp

@@ -0,0 +1,132 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#include "headerpathfilter.h"
+
+#include <QRegularExpression>
+
+namespace CppTools {
+
+using ProjectExplorer::HeaderPath;
+using ProjectExplorer::HeaderPaths;
+using ProjectExplorer::HeaderPathType;
+
+void HeaderPathFilter::process()
+{
+    const HeaderPaths &headerPaths = projectPart.headerPaths;
+
+    for (const HeaderPath &headerPath : headerPaths)
+        filterHeaderPath(headerPath);
+
+    if (useTweakedHeaderPaths == UseTweakedHeaderPaths::Yes)
+        tweakHeaderPaths();
+}
+
+void HeaderPathFilter::filterHeaderPath(const ProjectExplorer::HeaderPath &headerPath)
+{
+    if (headerPath.path.isEmpty())
+        return;
+
+    switch (headerPath.type) {
+    case HeaderPathType::BuiltIn:
+        builtInHeaderPaths.push_back(headerPath);
+        break;
+    case HeaderPathType::System:
+    case HeaderPathType::Framework:
+        systemHeaderPaths.push_back(headerPath);
+        break;
+    case HeaderPathType::User:
+        userHeaderPaths.push_back(headerPath);
+        break;
+    }
+}
+
+namespace {
+
+QString clangIncludeDirectory(const QString &clangVersion, const QString &clangResourceDirectory)
+{
+#ifndef UNIT_TESTS
+    return Core::ICore::clangIncludeDirectory(clangVersion, clangResourceDirectory);
+#else
+    Q_UNUSED(clangVersion);
+    Q_UNUSED(clangResourceDirectory);
+    return CLANG_RESOURCE_DIR;
+#endif
+}
+
+HeaderPaths::iterator resourceIterator(HeaderPaths &headerPaths, bool isMacOs)
+{
+    // include/c++, include/g++, libc++\include and libc++abi\include
+    static const QString cppIncludes = R"((.*\/include\/.*(g\+\+|c\+\+).*))"
+                                       R"(|(.*libc\+\+\/include))"
+                                       R"(|(.*libc\+\+abi\/include))";
+    static const QRegularExpression includeRegExp("\\A(" + cppIncludes + ")\\z");
+
+    // The same as includeRegExp but also matches /usr/local/include
+    static const QRegularExpression includeRegExpMac("\\A(" + cppIncludes
+                                                     + R"(|(\/usr\/local\/include))" + ")\\z");
+
+    const QRegularExpression &includePathRegEx = isMacOs ? includeRegExpMac : includeRegExp;
+
+    return std::stable_partition(headerPaths.begin(),
+                                 headerPaths.end(),
+                                 [&](const HeaderPath &headerPath) {
+                                     return includePathRegEx.match(headerPath.path).hasMatch();
+                                 });
+}
+
+bool isClangSystemHeaderPath(const HeaderPath &headerPath)
+{
+    // Always exclude clang system includes (including intrinsics) which do not come with libclang
+    // that Qt Creator uses for code model.
+    // For example GCC on macOS uses system clang include path which makes clang code model
+    // include incorrect system headers.
+    static const QRegularExpression clangIncludeDir(
+        R"(\A.*\/lib\d*\/clang\/\d+\.\d+(\.\d+)?\/include\z)");
+    return clangIncludeDir.match(headerPath.path).hasMatch();
+}
+
+void removeClangSystemHeaderPaths(HeaderPaths &headerPaths)
+{
+    auto newEnd = std::remove_if(headerPaths.begin(), headerPaths.end(), isClangSystemHeaderPath);
+    headerPaths.erase(newEnd, headerPaths.end());
+}
+
+} // namespace
+
+void HeaderPathFilter::tweakHeaderPaths()
+{
+    removeClangSystemHeaderPaths(builtInHeaderPaths);
+
+    auto split = resourceIterator(builtInHeaderPaths,
+                                  projectPart.toolChainTargetTriple.contains("darwin"));
+
+    if (!clangVersion.isEmpty()) {
+        const QString clangIncludePath = clangIncludeDirectory(clangVersion, clangResourceDirectory);
+        builtInHeaderPaths.insert(split, HeaderPath{clangIncludePath, HeaderPathType::BuiltIn});
+    }
+}
+
+} // namespace CppTools

src/plugins/cpptools/headerpathfilter.h

@@ -0,0 +1,63 @@
+/****************************************************************************
+**
+** Copyright (C) 2018 The Qt Company Ltd.
+** Contact: https://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 https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3 as published by the Free Software
+** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-3.0.html.
+**
+****************************************************************************/
+
+#pragma once
+
+#include "projectpart.h"
+
+namespace CppTools {
+
+enum class UseTweakedHeaderPaths : char { Yes, No };
+
+class HeaderPathFilter
+{
+public:
+    HeaderPathFilter(const ProjectPart &projectPart,
+                     UseTweakedHeaderPaths useTweakedHeaderPaths = UseTweakedHeaderPaths::Yes,
+                     const QString &clangVersion = QString(),
+                     const QString &clangResourceDirectory = QString())
+        : projectPart{projectPart}
+        , clangVersion{clangVersion}
+        , clangResourceDirectory{clangResourceDirectory}
+        , useTweakedHeaderPaths{useTweakedHeaderPaths}
+    {}
+
+    void process();
+
+    void filterHeaderPath(const ProjectExplorer::HeaderPath &headerPath);
+
+    void tweakHeaderPaths();
+
+public:
+    ProjectExplorer::HeaderPaths builtInHeaderPaths;
+    ProjectExplorer::HeaderPaths systemHeaderPaths;
+    ProjectExplorer::HeaderPaths userHeaderPaths;
+    const ProjectPart &projectPart;
+    const QString clangVersion;
+    const QString clangResourceDirectory;
+    const UseTweakedHeaderPaths useTweakedHeaderPaths;
+};
+
+} // namespace CppTools