| 1 | //===--- AnalysisInternal.h - Analysis building blocks ------------- C++-*-===// |
|---|
| 2 | // |
|---|
| 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
|---|
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
|---|
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
|---|
| 6 | // |
|---|
| 7 | //===----------------------------------------------------------------------===// |
|---|
| 8 | // |
|---|
| 9 | // This file provides smaller, testable pieces of the used-header analysis. |
|---|
| 10 | // We find the headers by chaining together several mappings. |
|---|
| 11 | // |
|---|
| 12 | // AST => AST node => Symbol => Location => Header |
|---|
| 13 | // / |
|---|
| 14 | // Macro expansion => |
|---|
| 15 | // |
|---|
| 16 | // The individual steps are declared here. |
|---|
| 17 | // (AST => AST Node => Symbol is one API to avoid materializing DynTypedNodes). |
|---|
| 18 | // |
|---|
| 19 | //===----------------------------------------------------------------------===// |
|---|
| 20 | |
|---|
| 21 | #ifndef CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H |
|---|
| 22 | #define CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H |
|---|
| 23 | |
|---|
| 24 | #include "TypesInternal.h" |
|---|
| 25 | #include "clang-include-cleaner/Analysis.h" |
|---|
| 26 | #include "clang-include-cleaner/Record.h" |
|---|
| 27 | #include "clang-include-cleaner/Types.h" |
|---|
| 28 | #include "llvm/ADT/STLFunctionalExtras.h" |
|---|
| 29 | #include <vector> |
|---|
| 30 | |
|---|
| 31 | namespace clang { |
|---|
| 32 | class ASTContext; |
|---|
| 33 | class Decl; |
|---|
| 34 | class ; |
|---|
| 35 | class NamedDecl; |
|---|
| 36 | class SourceLocation; |
|---|
| 37 | namespace include_cleaner { |
|---|
| 38 | |
|---|
| 39 | /// Traverses part of the AST from \p Root, finding uses of symbols. |
|---|
| 40 | /// |
|---|
| 41 | /// Each use is reported to the callback: |
|---|
| 42 | /// - the SourceLocation describes where the symbol was used. This is usually |
|---|
| 43 | /// the primary location of the AST node found under Root. |
|---|
| 44 | /// - the NamedDecl is the symbol referenced. It is canonical, rather than e.g. |
|---|
| 45 | /// the redecl actually found by lookup. |
|---|
| 46 | /// - the RefType describes the relation between the SourceLocation and the |
|---|
| 47 | /// NamedDecl. |
|---|
| 48 | /// |
|---|
| 49 | /// walkAST is typically called once per top-level declaration in the file |
|---|
| 50 | /// being analyzed, in order to find all references within it. |
|---|
| 51 | void walkAST(Decl &Root, |
|---|
| 52 | llvm::function_ref<void(SourceLocation, NamedDecl &, RefType)>); |
|---|
| 53 | |
|---|
| 54 | /// Finds the headers that provide the symbol location. |
|---|
| 55 | llvm::SmallVector<Hinted<Header>> findHeaders(const SymbolLocation &Loc, |
|---|
| 56 | const SourceManager &SM, |
|---|
| 57 | const PragmaIncludes *PI); |
|---|
| 58 | |
|---|
| 59 | /// A set of locations that provides the declaration. |
|---|
| 60 | std::vector<Hinted<SymbolLocation>> locateSymbol(const Symbol &S); |
|---|
| 61 | |
|---|
| 62 | /// Write an HTML summary of the analysis to the given stream. |
|---|
| 63 | void writeHTMLReport(FileID File, const Includes &, |
|---|
| 64 | llvm::ArrayRef<Decl *> Roots, |
|---|
| 65 | llvm::ArrayRef<SymbolReference> MacroRefs, ASTContext &Ctx, |
|---|
| 66 | const HeaderSearch &HS, PragmaIncludes *PI, |
|---|
| 67 | llvm::raw_ostream &OS); |
|---|
| 68 | |
|---|
| 69 | } // namespace include_cleaner |
|---|
| 70 | } // namespace clang |
|---|
| 71 | |
|---|
| 72 | #endif |
|---|
| 73 | |
|---|
