collectincludestoolaction.h 3.74 KB
Newer Older
Marco Bubke's avatar
Marco Bubke committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/****************************************************************************
**
** Copyright (C) 2016 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 "stringcache.h"

#include "collectincludesaction.h"

#include <clang/Tooling/Tooling.h>

namespace ClangBackEnd {

class CollectIncludesToolAction final : public clang::tooling::FrontendActionFactory
{
public:
Marco Bubke's avatar
Marco Bubke committed
39 40
    CollectIncludesToolAction(std::vector<FilePathIndex> &includeIds,
                              FilePathCache<> &filePathCache,
Marco Bubke's avatar
Marco Bubke committed
41
                              const Utils::PathStringVector &excludedIncludes)
Marco Bubke's avatar
Marco Bubke committed
42 43
        : m_includeIds(includeIds),
          m_filePathCache(filePathCache),
Marco Bubke's avatar
Marco Bubke committed
44
          m_excludedIncludes(excludedIncludes)
Marco Bubke's avatar
Marco Bubke committed
45 46
    {}

47 48 49 50 51 52 53

    bool runInvocation(
#if LLVM_VERSION_MAJOR >= 4
                       std::shared_ptr<clang::CompilerInvocation> invocation,
#else
                       clang::CompilerInvocation *invocation,
#endif
Marco Bubke's avatar
Marco Bubke committed
54 55 56 57 58 59 60 61 62 63 64 65 66
                       clang::FileManager *fileManager,
                       std::shared_ptr<clang::PCHContainerOperations> pchContainerOperations,
                       clang::DiagnosticConsumer *diagnosticConsumer) override
    {
        if (m_excludedIncludeUIDs.empty())
            m_excludedIncludeUIDs = generateExcludedIncludeFileUIDs(*fileManager);

        return clang::tooling::FrontendActionFactory::runInvocation(invocation,
                                                                    fileManager,
                                                                    pchContainerOperations,
                                                                    diagnosticConsumer);
    }

67
    clang::FrontendAction *create() override
Marco Bubke's avatar
Marco Bubke committed
68 69 70 71 72 73 74
    {
        return new CollectIncludesAction(m_includeIds,
                                         m_filePathCache,
                                         m_excludedIncludeUIDs,
                                         m_alreadyIncludedFileUIDs);
    }

Marco Bubke's avatar
Marco Bubke committed
75
    std::vector<FilePathIndex> generateExcludedIncludeFileUIDs(clang::FileManager &fileManager) const
Marco Bubke's avatar
Marco Bubke committed
76
    {
Marco Bubke's avatar
Marco Bubke committed
77
        std::vector<FilePathIndex> fileUIDs;
Marco Bubke's avatar
Marco Bubke committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91
        fileUIDs.reserve(m_excludedIncludes.size());

        for (const Utils::PathString &filePath : m_excludedIncludes) {
            const clang::FileEntry *file = fileManager.getFile({filePath.data(), filePath.size()});

            if (file)
                fileUIDs.push_back(file->getUID());
        }

        std::sort(fileUIDs.begin(), fileUIDs.end());

        return fileUIDs;
    }

Marco Bubke's avatar
Marco Bubke committed
92
private:
Marco Bubke's avatar
Marco Bubke committed
93 94 95 96
    std::vector<FilePathIndex> m_alreadyIncludedFileUIDs;
    std::vector<FilePathIndex> m_excludedIncludeUIDs;
    std::vector<FilePathIndex> &m_includeIds;
    FilePathCache<> &m_filePathCache;
Marco Bubke's avatar
Marco Bubke committed
97
    const Utils::PathStringVector &m_excludedIncludes;
Marco Bubke's avatar
Marco Bubke committed
98 99 100
};

} // namespace ClangBackEnd