41ac245c10
Include-cleaner is a library that uses the clang AST and preprocessor to determine which headers are used. It will be used in clang-tidy, in clangd, in a standalone tool at least for testing, and in out-of-tree tools. Roughly, it walks the AST, finds referenced decls, maps these to used sourcelocations, then to FileEntrys, then matching these against #includes. However there are many wrinkles: dealing with macros, standard library symbols, umbrella headers, IWYU directives etc. It is not built on the C++20 modules concept of usage, to allow: - use with existing non-modules codebases - a flexible API embeddable in clang-tidy, clangd, and other tools - avoiding a chicken-and-egg problem where include cleanups are needed before modules can be adopted This library is based on existing functionality in clangd that provides an unused-include warning. However it has design changes: - it accommodates diagnosing missing includes too (this means tracking where references come from, not just the set of targets) - it more clearly separates the different mappings (symbol => location => header => include) for better testing - it handles special cases like standard library symbols and IWYU directives more elegantly by adding unified Location and Header types instead of side-tables - it will support some customization of policy where necessary (e.g. for style questions of what constitutes a use, or to allow both missing-include and unused-include modes to be conservative) This patch adds the basic directory structure under clang-tools-extra and a skeleton version of the AST traversal, which will be the central piece. A more end-to-end prototype is in https://reviews.llvm.org/D122677 RFC: https://discourse.llvm.org/t/rfc-lifting-include-cleaner-missing-unused-include-detection-out-of-clangd/61228 Differential Revision: https://reviews.llvm.org/D124164
48 lines
1.7 KiB
C++
48 lines
1.7 KiB
C++
//===--- AnalysisInternal.h - Analysis building blocks ------------- C++-*-===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file provides smaller, testable pieces of the used-header analysis.
|
|
// We find the headers by chaining together several mappings.
|
|
//
|
|
// AST => AST node => Symbol => Location => Header
|
|
// /
|
|
// Macro expansion =>
|
|
//
|
|
// The individual steps are declared here.
|
|
// (AST => AST Node => Symbol is one API to avoid materializing DynTypedNodes).
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H
|
|
#define CLANG_INCLUDE_CLEANER_ANALYSISINTERNAL_H
|
|
|
|
#include "clang/Basic/SourceLocation.h"
|
|
#include "llvm/ADT/STLFunctionalExtras.h"
|
|
|
|
namespace clang {
|
|
class Decl;
|
|
class NamedDecl;
|
|
namespace include_cleaner {
|
|
|
|
/// Traverses part of the AST from \p Root, finding uses of symbols.
|
|
///
|
|
/// Each use is reported to the callback:
|
|
/// - the SourceLocation describes where the symbol was used. This is usually
|
|
/// the primary location of the AST node found under Root.
|
|
/// - the NamedDecl is the symbol referenced. It is canonical, rather than e.g.
|
|
/// the redecl actually found by lookup.
|
|
///
|
|
/// walkAST is typically called once per top-level declaration in the file
|
|
/// being analyzed, in order to find all references within it.
|
|
void walkAST(Decl &Root, llvm::function_ref<void(SourceLocation, NamedDecl &)>);
|
|
|
|
} // namespace include_cleaner
|
|
} // namespace clang
|
|
|
|
#endif
|