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 "clang/Basic/LangOptions.h" 29 #include "clang/Lex/Preprocessor.h" 30 #include "llvm/ADT/STLFunctionalExtras.h" 31 #include <vector> 32 33 namespace clang { 34 class ASTContext; 35 class Decl; 36 class HeaderSearch; 37 class NamedDecl; 38 class SourceLocation; 39 namespace include_cleaner { 40 41 /// Traverses part of the AST from \p Root, finding uses of symbols. 42 /// 43 /// Each use is reported to the callback: 44 /// - the SourceLocation describes where the symbol was used. This is usually 45 /// the primary location of the AST node found under Root. 46 /// - the NamedDecl is the symbol referenced. It is canonical, rather than e.g. 47 /// the redecl actually found by lookup. 48 /// - the RefType describes the relation between the SourceLocation and the 49 /// NamedDecl. 50 /// 51 /// walkAST is typically called once per top-level declaration in the file 52 /// being analyzed, in order to find all references within it. 53 void walkAST(Decl &Root, 54 llvm::function_ref<void(SourceLocation, NamedDecl &, RefType)>); 55 56 /// Finds the headers that provide the symbol location. 57 llvm::SmallVector<Hinted<Header>> findHeaders(const SymbolLocation &Loc, 58 const SourceManager &SM, 59 const PragmaIncludes *PI); 60 61 /// A set of locations that provides the declaration. 62 std::vector<Hinted<SymbolLocation>> locateSymbol(const Symbol &S, 63 const LangOptions &LO); 64 65 /// Write an HTML summary of the analysis to the given stream. 66 void writeHTMLReport(FileID File, const Includes &, 67 llvm::ArrayRef<Decl *> Roots, 68 llvm::ArrayRef<SymbolReference> MacroRefs, ASTContext &Ctx, 69 const Preprocessor &PP, PragmaIncludes *PI, 70 llvm::raw_ostream &OS); 71 72 } // namespace include_cleaner 73 } // namespace clang 74 75 #endif 76