qt-creator/src/tools/clangrefactoringbackend/source/collectsymbolsaction.h

/****************************************************************************
**
** Copyright (C) 2017 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 "clangrefactoringbackend_global.h"
#include "sourcelocationentry.h"
#include "symbolentry.h"

#include <utils/smallstring.h>

#include <stringcachefwd.h>

#include <clang/Frontend/FrontendAction.h>

#include <mutex>

namespace ClangBackEnd {

class CollectSymbolsAction
{
public:
    CollectSymbolsAction(FilePathCache<std::mutex> &filePathCache)
        : m_filePathCache(filePathCache)
    {}

    std::unique_ptr<clang::ASTConsumer> newASTConsumer();

    SymbolEntries takeSymbols()
    {
        return std::move(m_symbolEntries);
    }

    const SymbolEntries &symbols() const
    {
        return m_symbolEntries;
    }

    const SourceLocationEntries &sourceLocations() const
    {
        return m_sourceLocationEntries;
    }

private:
    SymbolEntries m_symbolEntries;
    SourceLocationEntries m_sourceLocationEntries;
    FilePathCache<std::mutex> &m_filePathCache;

};

} // namespace ClangBackEnd