blob: 4893cda501097f343c406627912aaa06ae6df739 [file] [log] [blame]
//===-- FindAllSymbols.h - find all symbols----------------------*- C++ -*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "SymbolInfo.h"
#include "SymbolReporter.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include <string>
namespace clang {
namespace find_all_symbols {
class HeaderMapCollector;
/// FindAllSymbols collects all classes, free standing functions and
/// global variables with some extra information such as the path of the header
/// file, the namespaces they are contained in, the type of variables and the
/// parameter types of functions.
/// NOTE:
/// - Symbols declared in main files are not collected since they can not be
/// included.
/// - Member functions are not collected because accessing them must go
/// through the class. #include fixer only needs the class name to find
/// headers.
class FindAllSymbols : public ast_matchers::MatchFinder::MatchCallback {
explicit FindAllSymbols(SymbolReporter *Reporter,
HeaderMapCollector *Collector = nullptr)
: Reporter(Reporter), Collector(Collector) {}
void registerMatchers(ast_matchers::MatchFinder *MatchFinder);
void run(const ast_matchers::MatchFinder::MatchResult &result) override;
void onEndOfTranslationUnit() override;
// Current source file being processed, filled by first symbol found.
std::string Filename;
// Findings for the current source file, flushed on onEndOfTranslationUnit.
SymbolInfo::SignalMap FileSymbols;
// Reporter for SymbolInfo.
SymbolReporter *const Reporter;
// A remapping header file collector allowing clients include a different
// header.
HeaderMapCollector *const Collector;
} // namespace find_all_symbols
} // namespace clang